README.md

Amazon IVS Chat for Android Demo

A demo Android phone application intended for use as an educational tool to demonstrate how a simple live video and chat application can be built with Amazon IVS video and chat.

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

The demo showcases how you can implement a simple live streaming application with video and chat using Amazon IVS. Viewers are asked to enter their name the first time they begin chatting. Chat users can send plain text messages, emojis, and stickers. Chat moderators can delete messages and kick users.

Prerequisites

• The ApiUrl from a deployed Amazon IVS Chat Demo Backend.

Setup

To open the demo Android app, follow these instructions:

1. Clone this repository to your local machine
2. Open app/build.gradle file and set constants for:
   • Amazon IVS Playback URL STREAM_URL
     • A sample playback url for a 24/7 livestream is pre-filled. You may add a playback url to use a custom livestream in this demo.
   • Amazon IVS Chat Demo backend endpoint API_URL
     • You must deploy the Amazon IVS Chat Demo Backend to get this value.
     • The Api URL must end with a trailing slash "/". For example, "https://1234567890.execute-api.REGION.amazonaws.com/Prod/".
   • Chat room id CHAT_ROOM_ID
     • The ID (or ARN) of the Amazon IVS Chat Room that the app should use.
     • You must create an Amazon IVS Chat Room to get a chat room ID/ARN. Refer to Getting Started with Amazon IVS Chat for a detailed guide.
3. Open the constants file at app/java/com/amazon/ivs/chatdemo/common/Constants.kt and set constants for:
   • The AWS region of your chat room REGION_URL
     • This is set to us-west-2 by default.
4. Build and install the .apk on your device / emulator

Known issues and limitations

• The application is meant for demonstration purposes and not for production use.
• This application is only tested in the us-west-2 (Oregon) region. Additional regions may be supported depending on service availability.

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. See the LICENSE file.