Skip to content
This repository has been archived by the owner on May 27, 2023. It is now read-only.

A demo web application intended as an educational tool for demonstrating how to load and play Amazon IVS streams alongside the Amazon Chime SDK.

License

Notifications You must be signed in to change notification settings

aws-samples/amazon-ivs-chime-web-demo

⚠️ IMPORTANT ⚠️ This repository is no longer actively maintained and will be archived at the end of 2022

Amazon IVS + Chime demo

A demo web application intended as an educational tool for demonstrating how to load and play Amazon IVS streams alongside the Amazon Chime SDK.

Amazon IVS Chime demo screenshot

This project is intended for education purposes only and not for production usage.

This is a serverless web application, leveraging Amazon IVS, AWS Lambda, API Gateway and ChimeSDK. The web user interface is a single page application built using responsive web design frameworks and techniques, producing a native app-like experience tailored to the user's device. The demo showcase how customers can use Chime SDK to implement a real-time room with audio and video capabilities where users can watch IVS Stream and chat. Users can enter their name, a room name, and a Playback URL to create a room. Once in the room, they can share room's unique URL, which can be used by others to join said room. Settings modal shows user their Playback URL, they can change their active audio input/output device and video input device. There are controls to manage audio, video, a row of cams, a chat, and an option to leave the room.

Getting Started

IMPORTANT NOTE: Deploying this demo application in your AWS account will create and consume AWS resources, which will cost money.

To get the demo running in your own AWS account, follow these instructions.

  1. If you do not have an AWS account, please see How do I create and activate a new Amazon Web Services account?
  2. Log into the AWS console if you are not already. Note: If you are logged in as an IAM user, ensure your account has permissions to create and manage the necessary resources and components for this application.
  3. Complete the instructions for deploying for demo or learning below.

Deploying for Demo or Learning

If you are interested in running IVS + Chime demo services locally as part of learning, we have detailed instructions on how to get up and going quickly.

Documentation

Known Issues

  • The application was written for demonstration purposes and not for production use.
  • The application was only tested on desktop browsers, and may not work on mobile.
  • The settings window throws an error on the following browers: Firefox, Safari
  • Currently only tested in the us-west-2 (Oregon) region. Additional regions may be supported depending on service availability.

License

This sample code is made available under a modified MIT license. See the LICENSE file.