Skip to content

Latest commit

 

History

History
112 lines (70 loc) · 5.17 KB

README.md

File metadata and controls

112 lines (70 loc) · 5.17 KB
Raw

Twilio Video Android App

To make sure your app is ready for Android 11 please visit this page.

CircleCI

This application demonstrates multi-party voice and video built with Twilio’s Programmable Video Android SDK.

App Preview

Features

Requirements

Android Studio Version Android API Version Min
3.5+ 21

Getting Started

In order to run this application on an Android device or emulator, complete the following steps.

Deploy Twilio Access Token Server

NOTE: The Twilio Function that provides access tokens via a passcode should NOT be used in a production environment. This token server supports seamlessly getting started with the collaboration app, and while convenient, the passcode is not secure enough for production environments. You should use an authentication provider to securely provide access tokens to your client applications. You can find more information about Programmable Video access tokens in this tutorial.

The app requires a back-end to generate Twilio access tokens. Follow the instructions below to deploy a serverless back-end using Twilio Functions.

  1. Install Twilio CLI.
  2. Run twilio login and follow prompts to login to your Twilio account.
  3. Run twilio plugins:install @twilio-labs/plugin-rtc.
  4. Run twilio rtc:apps:video:deploy --authentication passcode.
  5. The passcode that is output will be used later to sign in to the app.

The passcode will expire after one week. To generate a new passcode, run twilio rtc:apps:video:deploy --authentication passcode --override.

Troubleshooting The Twilio CLI

If any errors occur after running a Twilio CLI RTC Plugin command, then try the following steps.

  1. Run twilio plugins:update to update the rtc plugin to the latest version.
  2. Run twilio rtc:apps:video:delete to delete any existing authentication servers.
  3. Run twilio rtc:apps:video:deploy --authentication passcode to deploy a new authentication server.

Build

There are different product flavors for the application:

  1. Internal - The application intended for internal testing and QA at Twilio. This variant can only be built by Twilions.
  2. Community - The application intended for developers interested in using Programmable Video. This variant can be built by all developers.
    1. debug and release build types are supported.

Building the Community Flavor

The community flavor of the application is meant for developers who would like to work with the Video Android SDK in the context of a full-fledged application.

To get started with the community flavor follow these steps:

  1. Select the communityDebug Build Variant.
  2. Run the application.

Start Video Call

For each device:

  1. Run the app.
  2. Enter any unique name in the Your name field.
  3. Enter the passcode from Deploy Twilio Access Token Server in the Passcode field.
  4. Tap Log in.
  5. Enter a room name.
  6. Tap Join.

The passcode will expire after one week. Follow the steps below to sign in with a new passcode.

  1. Generate a new passcode.
  2. In the app tap Settings > Sign Out.
  3. Repeat the steps above.

NOTE: Usage charges will apply for video calls. See pricing for more information.

Tests

Unit Tests

  • Android Studio - Right click and run unit tests on package app/src/main/java/com/twilio/video/app
  • Terminal - ./gradlew app:testInternalDebugUnitTest

UI Tests

UI tests require credentials that are only available to Twilio employees.

Related

For Twilions

Twilio employees should follow these instructions for internal testing.

License

Apache 2.0 license. See LICENSE.txt for details.