Amazon IVS Broadcast Web Demo
A demo web application intended as an educational tool to demonstrate how you can build a browser-based streaming tool with the Amazon IVS Web Broadcast SDK.
Demo: Visit https://stream.ivs.rocks/ and add your channel's ingest endpoint and stream key on the settings screen.
This project is intended for education purposes only and not for production usage.
Prerequisites
- NodeJS
- Yarn package manager
- Your IVS Channel details. A guide is available here: Getting started with Amazon IVS.
Running the demo
Follow these instructions to run the demo:
- Run:
yarn install - Run:
yarn run dev
Customizing the demo
To customize this demo, fork it and modify the source code to suit your needs.
Change color theme
To modify the colors used in the application UI, modify the colors defined in tailwind.config.js.
Change layouts
To modify the available layouts or add your own, modify the contents of BroadcastLayoutTemplates.js. Math expressions within strings are supported and include the following variables:
Known issues and limitations
- The application is meant for demonstration purposes and not for production use.
- This application is only tested and supported on the latest Desktop versions of Chrome and Firefox. Other browsers and devices, including mobile browsers and smartphones, may work with this tool, but are not officially supported at this time.
About Amazon IVS
Amazon Interactive Video Service (Amazon IVS) is a managed live streaming and stream chat solution that is quick and easy to set up, and ideal for creating interactive video experiences. Learn more.
- Amazon IVS docs
- User Guide
- API Reference
- Setting Up for Streaming with Amazon Interactive Video Service
- Learn more about Amazon IVS on IVS.rocks
- View more demos like this
Security
See CONTRIBUTING for more information.
License
This library is licensed under the MIT-0 License.
