Skip to content

This project demonstrates a video collaboration application for Android phones and tablets powered by Amazon IVS Real-time, serving as a reference for building compelling social video experiences.

License

Notifications You must be signed in to change notification settings

aws-samples/sample-amazon-ivs-real-time-collaboration-for-android-demo

Amazon IVS Real-time Collaboration for Android Demo

A demo Android application intended as an educational tool to demonstrate how you can build a compelling video collaboration experience powered by Amazon IVS Real-time.

Screenshot of the application running on an Android device

Warning

This demo requires Android API level 29 (Android 10) or later.

Caution

Use at Your Own Risk: This is a code sample designed to help developers get started with Amazon IVS. It is not production-ready and will require additional development work to be suitable for production use. It is not intended for production use as-is. Its primary goal is to help developers understand the concepts and capabilities of Amazon IVS. By using this solution, you understand and accept its risks and limitations.

This project is intended to demonstrate Amazon IVS capabilities and should be adapted and optimized for your specific production requirements. Use this code as a foundation for learning and initial development only.

Setup

Prerequisites

You must deploy the backend stack for the Amazon IVS Real-time Collaboration Web Demo and retrieve the following stack outputs:

  • apiRegion
  • cognitoExports
  • apiUrl

Run the app

  1. Clone the repository to your local machine.
  2. Open the project in Android Studio.
  3. Add your amplify_outputs.json file to app/src/main/res/raw/ (more details). Following is an example of the format of the amplify_outputs.json file:
{ "version": "2", "auth": { "aws_region": "<apiRegion>", "user_pool_id": "<cognitoExports.userPoolId>", "user_pool_client_id": "<cognitoExports.userPoolClientId>", "password_policy": { "min_length": 8, "require_lowercase": true, "require_uppercase": true, "require_numbers": true, "require_symbols": true } } }
  1. Add your API URL in the local.properties file
AUTH_URL=<apiUrl>
  1. You can now build and run the project on a device or emulator.

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.

Security

See CONTRIBUTING for more information.

License

This library is licensed under the MIT-0 License. See the LICENSE file.

About

This project demonstrates a video collaboration application for Android phones and tablets powered by Amazon IVS Real-time, serving as a reference for building compelling social video experiences.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Languages