README.md

live-stream-radio

formerly known as piStreamRadio.

CLI Usage Screenshot 🖼️

Documentation 📚

live-stream-radio is a 24/7 live stream video radio station 📹 📻 CLI built with Node.js and powered by FFmpeg. Meaning, This will allow for live streaming a video of music, playing over a video/gif, with the music information, and other overlay items 🖼️. Music and video are chosen from their respective folders in a defined config.json that can be generated using the CLI. Generated projects come included with some songs and videos to get up and running quickly! Also, this project has a REST HTTP JSON Api, to allow for interfacing with your stream using a frontend 👩‍💻.

Table of Contents

• Getting Started
• API Frontends
• Compatibility
• Example Assets from the --generate template
• Contributing
• License

Getting Started

Please see the Documentation 📚 for how to get started using live-stream-radio. In particular, the Installation Guide and CLI Usage will be the most useful to new users. 😄

API Frontends

For building your own API frontend, please see the API Documentation 📚 on API Endpoints.

Currently, there are no supported API frontends. However, Contributions are welcome! If you make a live-stream-radio frontend, please open an issue and so we can add the project here 😄!

Other Notable Projects

• live-stream-radio control - Web control for live-stream-radio for streams on Twitch.
• lsr-wrapper - A Promise based wrapper around the live-stream-radio api.
• live-stream-radio-cp - Simple web control panel for live-stream-radio.

Radios built with live-stream-radio

Please feel free to share your radio if you are using live-stream-radio. Just open an issue, and we can add it to the README. 😄

Compatibility

Currently, this should work under any OS with support for Node and FFMPEG. Specifically in the tradition of this project being developed for Raspberry Pi, formerly as piStreamRadio , this also supports Raspbian as well.

Example Assets from the --generate template

Music is by Aviscerall, and Marquice Turner. Which is actually me (@torch2424), but I have a musical identitiy problem 😛 . The .mp4 and .webm of the rotating earth, is a public domain video I found on Youtube. The image overlay uses images from EmojiOne, in particular, their video camera emoji, and their radio emoji.

Contributing

Feel free to fork the project, open up a PR, and give any contributions! I'd suggest opening an issue first however, just so everyone is aware and can discuss the proposed changes. 👍

License

LICENSE under Apache 2.0. 🐦

This software uses code of FFmpeg licensed under the LGPLv2.1 and it's source can be downloaded here.

As such, this software tries to respect the LGPLv2 License as close as possible to respect FFmpeg and it's authors. Huge shoutout to them for building such an awesome and crazy tool!