• Stars
    star
    210
  • Rank 187,585 (Top 4 %)
  • Language
    Java
  • License
    MIT License
  • Created over 8 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Twilio Video Quickstart for Android

Javadoc

Tip: Please check out the open-sourced video collaboration app built with the Android Video SDK.

NOTE: These sample applications use the Twilio Video 7.x APIs. For examples using previous releases please see the following branches:

Twilio Video Quickstart for Android

Get started with Video on Android:

Quickstart

To get started with the Quickstart application follow these steps:

  1. Open this project in Android Studio and select the quickstart or quickstartKotlin app module.

  1. Generate an Access Token

    View instructions here for how to generate an Access Token using the Twilio CLI. Generating Access Tokens with the Twilio CLI is a quick way to get an Access Token for testing and development purposes.

  2. Add the access token string copied from the console to a variable named TWILIO_ACCESS_TOKEN in your local.properties file.

TWILIO_ACCESS_TOKEN=abcdef0123456789
  1. Run the quickstart app on an Android device or Android emulator.

  2. Press the video call button at the bottom right portion of the screen and type a room name to connect to a Room.

  1. On another device, use an additional access token with a different identity to connect to the same room.

Examples

In addition to the quickstart we've also added a few examples of use cases that show you how to create and customize your media as follows:

  • Custom Video Capturer - Demonstrates how a custom VideoCapturer can be implemented to capture the contents of a View.
  • Custom Video Sink - Demonstrates how to implement a custom tvi.webrtc.VideoSink that captures a Bitmap of the last rendered frame.
  • Screen Capturer - Demonstrates how to use the screen capturer.
  • Advanced Camera Capturer - Demonstrates advanced use cases of CameraCapturer like injecting custom camera parameters and taking a picture.
  • Video Invite - Demonstrates how to use Twilio Notify to invite other participants to a room.
  • Data Tracks - Demonstrates how to use DataTracks to write a simple collaborative drawing app.
  • Audio Sink - Demonstrates writing raw PCM audio to a .wav file from a RemoteAudioTrack using AudioSink.
  • Collaboration App - A collaboration app that demonstrates how to use the Room API for multiparty conferencing.

Using an Emulator

This guide will walk you through setting up an emulator that is compatible with the Video SDK.

Requirements

  1. Android Studio 2.0+

Guide

  1. Open Android Studio and navigate to Tools → Android → AVD Manager.

2. Create a virtual device.

3. Select your desired device.

4. Select a system image. We recommend either x86 or x86_64 images.

5. Click “Show Advanced Settings” and we recommend setting both cameras as “Emulated”. Note that other camera configurations will work with the exception of setting both cameras as “webcam()”.

6. Configure the rest of your device accordingly and click “Finish”.

Reducing APK Size

Our library is built using native libriares. As a result, if you use the default gradle build you will generate an APK with all four architectures(armeabi-v7a, arm64-v8a, x86, x86_64) in your APK.

APK splits allow developers to build multiple APKs for different screen sizes and ABIs. Enabling APK splits ensures that the minimum amount of files required to support a particular device are packaged into an APK.

The following snippet shows an example build.gradle with APK splits enabled.

apply plugin: 'com.android.application'

android {
    compileSdkVersion 30
    buildToolsVersion "30.0.2"

    defaultConfig {
        applicationId "com.twilio.video.quickstart"
        minSdkVersion 21
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"
    }

    // Specify that we want to split up the APK based on ABI
    splits {
        abi {
            // Enable ABI split
            enable true

            // Clear list of ABIs
            reset()

            // Specify each architecture currently supported by the Video SDK
            include "armeabi-v7a", "arm64-v8a", "x86", "x86_64"

            // Specify that we do not want an additional universal SDK
            universalApk false
        }
    }
}

dependencies {
    compile "com.twilio:video-android:7.6.1"
}

The adoption of APK splits requires developers to submit multiple APKs to the Play Store. Refer to Google’s documentation for how to support this in your application.

Troubleshooting Audio

The following sections provide guidance on how to ensure optimal audio quality in your applications. Results may vary when using APIs within the org.webrtc package. While we expose these APIs we do not actively test their usage.

Managing Audio Devices with AudioSwitch

The Java and Kotlin quickstarts use AudioSwitch to control audio focus and manage audio devices within the application. If you have an issue or question related to audio management, please open an issue in the AudioSwitch project.

Configuring Hardware Audio Effects

Our library performs acoustic echo cancellation (AEC), noise suppression (NS), and auto gain control (AGC) using device hardware by default. Using device hardware is more efficient, but some devices do not implement these audio effects well. If you are experiencing echo, background noise, or unexpected volume levels on certain devices reference the following snippet for enabling software implementations of AEC, NS, and AGC.

/*
 * Execute any time before creating a LocalAudioTrack and connecting
 * to a Room.
 */

// Use software AEC
WebRtcAudioUtils.setWebRtcBasedAcousticEchoCanceler(true);

// Use sofware NS
WebRtcAudioUtils.setWebRtcBasedNoiseSuppressor(true);

// Use software AGC
WebRtcAudioUtils.setWebRtcBasedAutomaticGainControl(true);

Configuring OpenSL ES

Our library does not use OpenSL ES for audio playback by default. Some prior versions starting with Video Android SDK 5.5.1 did use OpenSL ES by default. Using OpenSL ES is more efficient, but can cause problems with other audio effects. For example, we found on the Nexus 6P that OpenSL ES affected the device's hardware echo canceller so we blacklisted the Nexus 6P from using OpenSL ES. If you are experiencing audio problems with a device that cannot be resolved using software audio effects, reference the following snippet for enabling OpenSL ES:

/*
 * Execute any time before creating a LocalAudioTrack and connecting
 * to a Room.
 */

// Enable OpenSL ES
tvi.webrtc.voiceengine.WebRtcAudioManager.setBlacklistDeviceForOpenSLESUsage(false);

// Check if OpenSL ES is disabled
tvi.webrtc.voiceengine.WebRtcAudioUtils.deviceIsBlacklistedForOpenSLESUsage();

Managing Device Specific Configurations

The Video Android SDK does not maintain a list of devices for which hardware effects or OpenSL ES are disabled. We recommend maintaining a list in your own application and disabling these effects as needed. The Signal App provides a great example of how to maintain a list and disable the effects as needed.

Known Issues

  • Using the following WebRTC based acoustic echo canceler on the Pixel 3 XL will disable the microphone system wide.
    Usage: WebRtcAudioUtils.setWebRtcBasedAcousticEchoCanceler(true);
    A bug has been filed with WebRTC and can be found here.

Rendering Video

A VideoTrack can be rendered in your application using addRenderer which takes an implementation of VideoRenderer. A VideoRenderer is most commonly used to render video to a UI, but could be used for other scenarios such as rendering to a file. The following section provides guidance on how to render video in your application.

Working with VideoView

For simply rendering video to your application's UI, we recommend using VideoView. VideoView extends SurfaceView and can be added to your view hierarchy in a layout file or programmatically. To render a VideoTrack to a VideoView simply call videoTrack.addRenderer(videoView). The following snippets demonstrate how to setup the a thumbnail video overlayed on a primary video as seen in the screenshot below.

VideoView in a Layout File

<?xml version="1.0" encoding="utf-8"?>
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
             xmlns:app="http://schemas.android.com/apk/res-auto"
             android:id="@+id/video_container"
             android:layout_width="match_parent"
             android:layout_height="match_parent"
             android:keepScreenOn="true">

    <com.twilio.video.VideoView
        android:id="@+id/thumbnail_video_view"
        app:overlaySurface="true"
        app:mirror="true"
        android:layout_width="96dp"
        android:layout_height="146dp"
        android:layout_margin="16dp"
        android:layout_gravity="bottom|start"/>

    <com.twilio.video.VideoView
        android:id="@+id/primary_video_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />

</FrameLayout>

Adding VideoView Programmatically

/*
 * Get videoContainer
 */
FrameLayout videoContainer = findViewById(R.id.video_container);

/*
 * Create thumbnail video view
 */
VideoView thumbnailVideoView = new VideoView(context);

/*
 * Mirror the video. Set to true when rendering video from a local video track using the
 * front facing camera. Set to false otherwise.
 */
thumbnailVideoView.setMirror(true);

/*
 * Overlays the thumbnail video view on top of the primary video view
 */
thumbnailVideoView.applyZOrder(true);

/*
 * Create primary video view
 */
VideoView primaryVideoView = new VideoView(context);

/*
 * Add video views to container
 */
videoContainer.addView(thumbnailVideoView);
videoContainer.addView(primaryVideoView);

Custom Renderers and I420Frame

For advanced use cases you can provide a custom VideoRenderer where your custom renderer will be provided with an I420Frame to render. An I420Frame can be represented with a ByteBuffer array of Y, U, and V pixel data with an array of strides for each plane or as a texture. When a frame is represented as a texture, I420Frame#textureId will be set to a positive non zero value with I420Frame#yuvPlanes and I420Frame#yuvStrides set to null. The YUV data can be extracted from the texture using an instance of org.webrtc.YuvConverter and the I420Frame#samplingMatrix. When a frame is represented as an array of ByteBuffer, I420Frame#textureId will be 0, I420Frame#yuvPlanes contains the YUV pixel data, and I420Frame#yuvStrides contains each plane's stride. For an example of implementing a custom VideoRenderer we recommend referencing the Custom Video Renderer module.

Setup an Access Token Server

Using Twilio's Video client within your applications requires an access token.

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 quickstart app on an Android device.

Configuring the Access Token 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: Node 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 .env.example file to a .env file, and then add in these credentials:

Credential Description
Twilio Account SID Your main Twilio account identifier - find it on your dashboard.
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 local.properties. Reference the following snippet.

# Insert the URL from ngrok
TWILIO_ACCESS_TOKEN_SERVER=http://localhost:3000

# Inform quickstart you want to use a token server
USE_TOKEN_SERVER=true

More Documentation

You can find more documentation on getting started as well as our latest Javadoc below:

Issues and Support

Please file any issues you find here on Github. Please ensure that you are not sharing any Personally Identifiable Information(PII) or sensitive account information (API keys, credentials, etc.) when reporting an issue.

For general inquiries related to the Video SDK you can file a support ticket

More Repositories

1

twilio-video-app-react

A collaboration application built with the twilio-video.js SDK and React.js
TypeScript
1,808
star
2

twilio-python

A Python module for communicating with the Twilio API and generating TwiML.
Python
1,707
star
3

stashboard

An open-source status dashboard running on App Engine
Python
1,594
star
4

twilio-php

A PHP library for communicating with the Twilio REST API and generating TwiML.
PHP
1,447
star
5

twilio-ruby

A Ruby gem for communicating with the Twilio API and generating TwiML
Ruby
1,335
star
6

twilio-node

Node.js helper library
TypeScript
1,304
star
7

OpenVBX

OpenVBX is a web-based open source phone system for business.
PHP
699
star
8

twilio-csharp

Twilio C#/.NET Helper Library for .NET Framework 3.5+ and supported .NET Core versions
C#
636
star
9

BankersBox

redis-like wrapper for javascript storage
CoffeeScript
571
star
10

twilio-video.js

Twilio’s Programmable Video JavaScript SDK
JavaScript
569
star
11

video-quickstart-ios

Twilio Video Quickstart for iOS
Swift
458
star
12

twilio-java

A Java library for communicating with the Twilio REST API and generating TwiML.
Java
440
star
13

video-quickstart-js

A quickstart and code samples for Twilio Video JavaScript SDK. https://www.twilio.com/docs/video
JavaScript
390
star
14

shadow

A HTTP debugging proxy that helps you with your continuous deployments
JavaScript
330
star
15

twilio-go

A Go package for communicating with the Twilio API.
Go
278
star
16

twilio-sans-mono

Twilio Sans Mono is a beautiful and extensive open source programming font
Shell
255
star
17

twilio-video-app-ios

A collaboration application built with the Twilio Video iOS SDK
Swift
246
star
18

authy-php

A PHP client for Authy
PHP
245
star
19

twilio-video-app-android

A collaboration application built with the Twilio Video Android SDK
Kotlin
240
star
20

authy-devise

Authy Devise plugin to add Two-Factor Authentication
Ruby
201
star
21

authy-python

Authy API Client for Python
Python
189
star
22

twilio-salesforce

A Salesforce/Force.com library for communicating with the Twilio REST API and generating TwiML. Need help? Post your questions to http://getsatisfaction.com/twilio or email us at [email protected]
Apex
186
star
23

voice-quickstart-android

Quickstart app for the Voice Android SDK
Java
184
star
24

voice-quickstart-ios

Twilio Voice Quickstart for iOS with Swift
Objective-C
179
star
25

twilio-cli

Unleash the power of Twilio from your command prompt
JavaScript
160
star
26

audioswitch

An Android audio management library for real-time communication apps.
Kotlin
159
star
27

authy-ruby

**Deprecated** Ruby library to access the authy API
Ruby
156
star
28

authy-openvpn

Authy Open VPN Two-Factor Authentication
C
152
star
29

gameday

A collection of Twilio SRE's Gameday Templates
140
star
30

twilio-oai

The Twilio OpenAPI Specification
Makefile
122
star
31

TwilioChatJsReactNative

ReactNative app example for Twilio Programmable Chat with working iOS and Android push messages https://www.twilio.com/chat
JavaScript
114
star
32

chessms

Play Chess over SMS!
Erlang
112
star
33

media-streams

Quick start guides for configuring and consuming Twilio Media Streams
Ruby
102
star
34

twilio-conversations-demo-react

Twilio Conversations Demo Web Application
TypeScript
97
star
35

apkscale

A Gradle plugin to measure the app size impact of Android libraries
Kotlin
93
star
36

OpenVBX-iPhone

OpenVBX for iPhone
Objective-C
92
star
37

twilio-chat-demo-js

Programmable Chat API Demo Application for JavaScript
JavaScript
92
star
38

starter-node

A starter app for node.js developers embarking on their first Twilio quest!
JavaScript
84
star
39

authy-form-helpers

Authy javascripts and css file to help create quick forms for the authy api
CoffeeScript
83
star
40

flex-plugin-builder

Packages related to building a Twilio Flex Plugin
TypeScript
83
star
41

starter-python

A starter app for Python developers embarking on their first Twilio quest!
CSS
76
star
42

sourd.io

sourd.io: temperature, humidity, and rise monitoring for your sourdough starter
C++
73
star
43

twilio-voice-react-native

TypeScript
67
star
44

twilio-client.js

Twilio’s Programmable Voice JavaScript SDK
TypeScript
67
star
45

authy-java

Java Client for Twilio Authy Two-Factor Authentication (2FA) API
Java
65
star
46

twilio-video-ios

Programmable Video SDK by Twilio
Swift
64
star
47

twilio-chat-demo-android

Chat API Demo Application for Android
Kotlin
63
star
48

twilio-webchat-react-app

Twilio Webchat React App is an application that demonstrates a website chat widget built with Twilio's Conversations JS SDK, Twilio Paste Design library and Create React App.
TypeScript
63
star
49

terraform-provider-twilio

Terraform Twilio provider
Go
62
star
50

twilio-voice.js

Twilio's JavaScript Voice SDK
TypeScript
50
star
51

twilio-webrtc.js

WebRTC-related APIs and shims used by twilio-video.js
JavaScript
49
star
52

rtc-diagnostics

TypeScript
44
star
53

flex-ui-sample

Twilio Flex UI Sample
JavaScript
44
star
54

twilio-video-diagnostics-react-app

A diagnostics tool that tests a participant's ability to have a quality video call. Built with the twilio-video.js SDK, RTC Diagnostics SDK, and React.js.
TypeScript
41
star
55

wiztowar

Build WARs from your Dropwizard apps
Java
40
star
56

hackathons

A collection of tips and tricks for using Twilio at hackathons
40
star
57

twilio-voice-ios

Programmable Voice SDK by Twilio
Swift
39
star
58

voice-quickstart-objc

Twilio Voice Quickstart for iOS with Objective-C
Objective-C
38
star
59

twilio-voice-notification-app

Reference app built in ReactJS that demonstrates how to leverage Twilio Programmable Voice and Twilio SDKs to create a voice notification system.
TypeScript
36
star
60

sample-code

Auto-generated code samples for the Twilio REST API
Java
35
star
61

draw-with-twilio

Draw with Twilio
JavaScript
35
star
62

video-quickstart-objc

Twilio Video Quickstart for iOS with Objective-C
Objective-C
33
star
63

twilio-video-processors.js

Twilio Video Processors is a collection of video processing tools which can be used with Twilio Video JavaScript SDK to apply transformations and filters to a video track.
TypeScript
33
star
64

twilio-voice-react-native-app

TypeScript
32
star
65

TwilioChatXamarinBindings

Twilio Chat Bindings for Xamarin (Android and iOS) and Sample app with working FCM and APN pushes using those bindings.
C#
32
star
66

flex-webchat-ui-sample

Twilio Flex Web Chat UI Sample
JavaScript
31
star
67

twilio-live-interactive-video

An interactive live video app built with Twilio Live and Twilio Video
TypeScript
31
star
68

twilio-video.js-recording-bot

JavaScript
30
star
69

twilio-chat-demo-ios

Twilio Programmable Chat Demo Application for iOS
Objective-C
28
star
70

calcite-kudu

Apache Calcite Adapter for Apache Kudu
Java
28
star
71

ortc-adapter

ORTC to WebRTC Adapter
JavaScript
28
star
72

cloudsec

27
star
73

starter-ruby

A starter app for Ruby developers embarking on their first Twilio quest!
JavaScript
27
star
74

twilio-oai-generator

Twilio OpenAPI client generator
Java
26
star
75

autopilot-cli

The Twilio Autopilot CLI is now deprecated. Please use the Autopilot Plugin for the Twilio CLI here https://www.twilio.com/docs/autopilot/twilio-autopilot-cli
JavaScript
26
star
76

voice-quickstart-server-python

Python
25
star
77

twilio-taskrouter.js

JS SDK v2 for Twilio's TaskRouter skills based routing system.
JavaScript
24
star
78

twilio-boost-build

Build tool for boost libraries on android, ios, linux and osx
Shell
24
star
79

wireless-security-camera

Create a Twilio-powered device that keeps watch over dangerous and remote locations and alerts stakeholders of intrusions or safety concerns.
CSS
24
star
80

twilio-video-room-monitor.js

A browser-based tool that displays information and metrics about Twilio Video JavaScript applications
TypeScript
24
star
81

video-shared-arkit-sample

ARKit + Twilio Video Data Tracks demo
Swift
24
star
82

voice-quickstart-server-node

voice quickstart server example in node
JavaScript
24
star
83

starter-java

A starter app for Java developers embarking on their first Twilio quest!
CSS
22
star
84

wireless-fleet-tracker

Create a Twilio-powered Fleet Tracker that uses off-the-shelf components to track and log: miles driven, hours of uptime and downtime, locations, average speed, and fuel consumption.
CSS
22
star
85

voices

Twilio Voices - Contribute programming tutorials to the Twilio blog. Get paid for each post you publish.
20
star
86

rtc-diagnostics-react-app

TypeScript
20
star
87

autopilot-templates

JavaScript
19
star
88

client-js-1.4-examples

Examples for using the new Client JS 1.4 Audio functionality
JavaScript
19
star
89

wp-click2call

Wordpress Plugin for Click2Call
PHP
19
star
90

authy.net

.NET Library to access the Authy API
C#
19
star
91

starter-php

A starter app for PHP developers embarking on their first Twilio quest!
PHP
19
star
92

Breakout_Arduino_Library

C
18
star
93

howtos

Sample applications that cover common use cases in a variety of languages.
Python
18
star
94

twilio-conversations-demo-android-kotlin

An application demonstrating use of Twilio Conversations on Android - this is a full working Kotlin application
Kotlin
18
star
95

cerebro

Python
17
star
96

linkit-one-sensor-samples

Samples for the LinkIt ONE Starter Kit
C++
17
star
97

twilio-flex-token-validator

Flex JWE Token Validator
TypeScript
17
star
98

wireless-postman-collection

This repository includes a group of Programmable Wireless HTTP requests for your convenience. You can learn more about Programmable Wireless HTTP request formats in the Programmable Wireless Documentation.
17
star
99

twilio-verify-ios

Twilio Verify Push SDK helps you verify users by adding a low-friction, secure, cost-effective, "push verification" factor into your own apps. This project provides an SDK to implement Verify Push for your iOS app.
Swift
17
star
100

twilio-conversations-demo-ios-swift

Twilio Conversations for iOS Demo application in Swift
Swift
17
star