Twilio Video Quickstart for Android

Use this project to get started with Twilio Video's Android SDK currently in Preview. Here are the docs.

Up and Running

Create a Twilio Video Configuration Profile. If you haven't used Twilio before, welcome! You'll need to Sign up for a Twilio account.
Download this project and open it in Android Studio.
Get an access token Generate an Access Token. Pick your identity (such as Bob).
Paste the access token into VideoActivity.java
Run your app on an Android device or the Android emulator
Tap the button at the bottom right portion of the screen and enter the room you would like to connect to. When ready, click connect.
On another device, use an additional access token with a different identity to connect to the same room.

What is this project?

This quick start will help you get video chat integrated directly into your Android applications using Twilio's Video SDK.

Inside this quick start project, you will find an Activity that contains all of the functionality necessary to show two video streams on one screen - one video stream for your phone's video camera, and one for a remote video stream.

You'll see how to set up key classes like AccessManager, VideoClient, LocalMedia, Room, and CameraCapturer. All of these Twilio classes have related listeners with implementations in VideoActivity.java.

You can also see how Android's runtime permissions are implemented for access to the camera and the microphone on Android devices running version 6.0 (Marshmallow) or higher inside the onCreate() method in the VideoActivity class.

Additional Examples

You will also find additional examples that provide more advanced use cases of the Video SDK. The currently included examples are as follows:

Custom Video Capturer - Shows how a custom VideoCapturer can be implemented to capture the contents of a View.
Custom Video Renderer - Demonstrates how to implement a custom VideoRenderer that captures a Bitmap of the last renderered frame.

Access Tokens and Servers

Using Twilio's Video client within your applications requires an access token. These access tokens can come from one of two places:

You can create a one-time use access token for testing on Twilio.com. This access token can be hard-coded directly into your mobile app, and you won't need to run your own server.
You can run your own server that provides access tokens, based on your Twilio credentials. This server can either run locally on your development machine, or it can be installed on a server. If you run the server on your local machine, you should use the ngrok utility to give the server an externally accessible web address. That way, you can run the quick start app on an Android device.

Generating an Access Token

The first step is to Generate an Access Token from the Twilio developer console. Use whatever clever username you would like for the identity. You will get an access token that you can copy and paste into VideoActivity.java

Once you have that access token in place, scroll down to the bottom of the page and you will get a web-based video chat window in the Twilio developer console that you can use to communicate with your Android app! Just join the room specified above!

Setting up a Video Chat Web Server

If you want to be a little closer to a real environment, you can download one of the video quickstart applications - for instance, Video Quickstart: PHP and either run it locally, or install it on a server.

You'll need to gather a couple of configuration options from your Twilio developer console before running it, so read the directions on the quickstart. You'll copy the config.example.php file to a config.php file, and then add in these credentials:

Credential	Description
Twilio Account SID	Your main Twilio account identifier - find it on your dashboard.
Twilio Video Configuration SID	Adds video capability to the access token - generate one here
API Key	Used to authenticate - generate one here.
API Secret	Used to authenticate - just like the above, you'll get one here.

A Note on API Keys

When you generate an API key pair at the URLs above, your API Secret will only be shown once - make sure to save this in a secure location.

Running the Video Quickstart with ngrok

If you run your video chat application on an Android device, you'll need to provide an externally accessible URL for the app. The ngrok tool creates a publicly accessible URL that you can use to send HTTP/HTTPS traffic to a server running on your localhost. Use HTTPS to make web connections that retrieve a Twilio access token.

When you get a URL from ngrok, go ahead and update VideoActivity.java with the new URL. At the very bottom is the retrieveAccessTokenfromServer() method. If you go down this path, be sure to follow the directions in the comments in the initializeTwilioSdk() method at the top of the source file - you will need to comment out everything under "OPTION 1" and uncomment the one line under "OPTION 2". You will also need to update the code if your ngrok URL changes.

Have fun!

This is an introduction to Twilio's Video SDK on Android. From here, you can start building applications that use video chat across the web, iOS, and Android platforms.

License

MIT

chungh17/video-quickstart-android