https://github.com/aws-samples/amazon-ivs-chat-for-android-demo
A demo Android app built with Kotlin that shows how to implement a basic video + chat application using Amazon IVS and the AWS serverless application model (SAM).
https://github.com/aws-samples/amazon-ivs-chat-for-android-demo
amazon-ivs android aws chat ivs-chat kotlin live-chat live-streams live-video lvl-200 video websockets
Last synced: 6 months ago
JSON representation
A demo Android app built with Kotlin that shows how to implement a basic video + chat application using Amazon IVS and the AWS serverless application model (SAM).
- Host: GitHub
- URL: https://github.com/aws-samples/amazon-ivs-chat-for-android-demo
- Owner: aws-samples
- License: mit-0
- Created: 2022-04-20T22:17:47.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-11-12T21:25:11.000Z (8 months ago)
- Last Synced: 2025-11-12T23:25:39.845Z (8 months ago)
- Topics: amazon-ivs, android, aws, chat, ivs-chat, kotlin, live-chat, live-streams, live-video, lvl-200, video, websockets
- Language: Kotlin
- Homepage:
- Size: 300 KB
- Stars: 12
- Watchers: 11
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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](https://github.com/aws-samples/amazon-ivs-chat-web-demo/tree/main/serverless).
## 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](https://github.com/aws-samples/amazon-ivs-chat-web-demo/tree/main/serverless) 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](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html) 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](https://aws.amazon.com/ivs/).
* [Amazon IVS docs](https://docs.aws.amazon.com/ivs/)
* [User Guide](https://docs.aws.amazon.com/ivs/latest/userguide/)
* [API Reference](https://docs.aws.amazon.com/ivs/latest/APIReference/)
* [Setting Up for Streaming with Amazon Interactive Video Service](https://aws.amazon.com/blogs/media/setting-up-for-streaming-with-amazon-ivs/)
* [Learn more about Amazon IVS on IVS.rocks](https://ivs.rocks/)
* [View more demos like this](https://ivs.rocks/examples)
## Security
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
## License
This library is licensed under the MIT-0 License. See the LICENSE file.