Twilio Video (WebRTC) for React Native

Platforms:

• iOS
• Android

People using a version < 1.0.1 please move to 1.0.1 since the project changed a lot internally to support the stable TwilioVideo version.

Installation

• react-native >= 0.40.0: install react-native-twilio-video-webrtc@1.0.1
• react-native < 0.40.0: install react-native-twilio-video-webrtc@1.0.0

Install Node Package

Option A: yarn

1yarn add https://github.com/blackuy/react-native-twilio-video-webrtc

Option B: npm

1npm install https://github.com/blackuy/react-native-twilio-video-webrtc --save

iOS

Option A: Install with CocoaPods (recommended)

1. Add this package to your Podfile

1pod 'react-native-twilio-video-webrtc', path: '../node_modules/react-native-twilio-video-webrtc'

Note that this will automatically pull in the appropriate version of the underlying TwilioVideo pod.

2. Install Pods with

1pod install

Option B: Install without CocoaPods (manual approach)

1. Add the Twilio dependency to your Podfile

1pod 'TwilioVideo'

2. Install Pods with

1pod install

3. Add the XCode project to your own XCode project's Libraries directory from

node_modules/react-native-twilio-video-webrtc/ios/RNTwilioVideoWebRTC.xcodeproj

4. Add libRNTwilioVideoWebRTC.a to your XCode project target's Linked Frameworks and Libraries

5. Update Build Settings

Find Search Paths and add $(SRCROOT)/../node_modules/react-native-twilio-video-webrtc/ios with recursive to Framework Search Paths and Library Search Paths

Post install

Be sure to increment your iOS Deployment Target to at least iOS 11 through XCode and your Podfile contains

platform :ios, '11.0'

Permissions

To enable camera usage and microphone usage you will need to add the following entries to your Info.plist file:

<key>NSCameraUsageDescription</key>
<string>Your message to user when the camera is accessed for the first time</string>
<key>NSMicrophoneUsageDescription</key>
<string>Your message to user when the microphone is accessed for the first time</string>

Known Issues

TwilioVideo version 1.3.8 (latest) has the following know issues.

• Participant disconnect event can take up to 120 seconds to occur. Issue 99
• AVPlayer audio content does not mix properly with Room audio. Issue 62

Android

As with iOS, make sure the package is installed:

1yarn add https://github.com/blackuy/react-native-twilio-video-webrtc

Then add the library to your settings.gradle file:

include ':react-native-twilio-video-webrtc'
project(':react-native-twilio-video-webrtc').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-twilio-video-webrtc/android')

And include the library in your dependencies in android/app/build.gradle:

dependencies {
    .....
    .....
    .....
    compile project(':react-native-twilio-video-webrtc')
}

You will also need to update this file so that you compile with java 8 features:

android {
    compileOptions {
        sourceCompatibility 1.8
        targetCompatibility 1.8
    }
}

Now you're ready to load the package in MainApplication.java. In the imports section, add this:

1import com.twiliorn.library.TwilioPackage;

Then update the getPackages() method:

1    protected List<ReactPackage> getPackages() {
2        return Arrays.<ReactPackage>asList(
3            ...
4            new TwilioPackage()
5        );
6    }

Permissions

For most applications, you'll want to add camera and audio permissions to your AndroidManifest.xml file:

1    <uses-permission android:name="android.permission.CAMERA" />
2    <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
3    <uses-permission android:name="android.permission.RECORD_AUDIO" />
4    <uses-feature android:name="android.hardware.camera" android:required="false" />
5    <uses-feature android:name="android.hardware.camera.autofocus" android:required="false" />
6    <uses-feature android:name="android.hardware.microphone" android:required="false" />

Newer versions of Android have a different permissions model. You will need to use the PermissionsAndroid class in react-native in order to request the CAMERA and RECORD_AUDIO permissions.

Additional Tips

Under default settings, the Android build will fail if the total number of symbols exceeds a certain threshold. If you should encounter this issue when adding this library (e.g., if your build fails with com.android.dex.DexIndexOverflowException), you can turn on jumbo mode by editing your app/build.gradle:

android {
  ...
  dexOptions {
    jumboMode true
  }
}

If you are using proguard (very likely), you will also need to ensure that the symbols needed by this library are not stripped. To do that, add these two lines to proguard-rules.pro:

  -keep class org.webrtc.** { *; }
  -keep class com.twilio.** { *; }
  -keep class tvi.webrtc.** { *; }

Docs

You can see the documentation here.

Usage

We have three important components to understand:

1import {
2  TwilioVideo,
3  TwilioVideoLocalView,
4  TwilioVideoParticipantView
5} from 'react-native-twilio-video-webrtc'

• TwilioVideo / is responsible for connecting to rooms, events delivery and camera/audio.
• TwilioVideoLocalView / is responsible local camera feed view
• TwilioVideoParticipantView / is responsible remote peer's camera feed view

Here you can see a complete example of a simple application that uses almost all the apis:

1import React, { Component } from 'react';
2import {
3  TwilioVideoLocalView,
4  TwilioVideoParticipantView,
5  TwilioVideo
6} from 'react-native-twilio-video-webrtc'
7
8export default class Example extends Component {
9  state = {
10    isAudioEnabled: true,
11    isVideoEnabled: true,
12    status: 'disconnected',
13    participants: new Map(),
14    videoTracks: new Map(),
15    token: ''
16  }
17
18  _onConnectButtonPress = () => {
19    this.refs.twilioVideo.connect({ accessToken: this.state.token })
20    this.setState({status: 'connecting'})
21  }
22
23  _onEndButtonPress = () => {
24    this.refs.twilioVideo.disconnect()
25  }
26
27  _onMuteButtonPress = () => {
28    this.refs.twilioVideo.setLocalAudioEnabled(!this.state.isAudioEnabled)
29      .then(isEnabled => this.setState({isAudioEnabled: isEnabled}))
30  }
31
32  _onFlipButtonPress = () => {
33    this.refs.twilioVideo.flipCamera()
34  }
35
36  _onRoomDidConnect = ({ roomName, error }) => {
37    console.log('onRoomDidConnect: ', roomName);
38
39    this.setState({ status: 'connected' });
40  };
41
42  _onRoomDidDisconnect = ({roomName, error}) => {
43    console.log("ERROR: ", error)
44
45    this.setState({status: 'disconnected'})
46  }
47
48  _onRoomDidFailToConnect = (error) => {
49    console.log("ERROR: ", error)
50
51    this.setState({status: 'disconnected'})
52  }
53
54  _onParticipantAddedVideoTrack = ({participant, track}) => {
55    console.log("onParticipantAddedVideoTrack: ", participant, track)
56
57    this.setState({
58      videoTracks: new Map([
59        ...this.state.videoTracks,
60        [track.trackSid, { participantSid: participant.sid, videoTrackSid: track.trackSid }]
61      ]),
62    });
63  }
64
65  _onParticipantRemovedVideoTrack = ({participant, track}) => {
66    console.log("onParticipantRemovedVideoTrack: ", participant, track)
67
68    const videoTracks = this.state.videoTracks
69    videoTracks.delete(track.trackSid)
70
71    this.setState({videoTracks: { ...videoTracks }})
72  }
73
74  render() {
75    return (
76      <View style={styles.container}>
77        {
78          this.state.status === 'disconnected' &&
79          <View>
80            <Text style={styles.welcome}>
81              React Native Twilio Video
82            </Text>
83            <TextInput
84              style={styles.input}
85              autoCapitalize='none'
86              value={this.state.token}
87              onChangeText={(text) => this.setState({token: text})}>
88            </TextInput>
89            <Button
90              title="Connect"
91              style={styles.button}
92              onPress={this._onConnectButtonPress}>
93            </Button>
94          </View>
95        }
96
97        {
98          (this.state.status === 'connected' || this.state.status === 'connecting') &&
99            <View style={styles.callContainer}>
100            {
101              this.state.status === 'connected' &&
102              <View style={styles.remoteGrid}>
103                {
104                  Array.from(this.state.videoTracks, ([trackSid, trackIdentifier]) => {
105                    return (
106                      <TwilioVideoParticipantView
107                        style={styles.remoteVideo}
108                        key={trackSid}
109                        trackIdentifier={trackIdentifier}
110                      />
111                    )
112                  })
113                }
114              </View>
115            }
116            <View
117              style={styles.optionsContainer}>
118              <TouchableOpacity
119                style={styles.optionButton}
120                onPress={this._onEndButtonPress}>
121                <Text style={{fontSize: 12}}>End</Text>
122              </TouchableOpacity>
123              <TouchableOpacity
124                style={styles.optionButton}
125                onPress={this._onMuteButtonPress}>
126                <Text style={{fontSize: 12}}>{ this.state.isAudioEnabled ? "Mute" : "Unmute" }</Text>
127              </TouchableOpacity>
128              <TouchableOpacity
129                style={styles.optionButton}
130                onPress={this._onFlipButtonPress}>
131                <Text style={{fontSize: 12}}>Flip</Text>
132              </TouchableOpacity>
133              <TwilioVideoLocalView
134                enabled={true}
135                style={styles.localVideo}
136              />
137            </View>
138          </View>
139        }
140
141        <TwilioVideo
142          ref="twilioVideo"
143          onRoomDidConnect={ this._onRoomDidConnect }
144          onRoomDidDisconnect={ this._onRoomDidDisconnect }
145          onRoomDidFailToConnect= { this._onRoomDidFailToConnect }
146          onParticipantAddedVideoTrack={ this._onParticipantAddedVideoTrack }
147          onParticipantRemovedVideoTrack= { this._onParticipantRemovedVideoTrack }
148        />
149      </View>
150    );
151  }
152}
153
154AppRegistry.registerComponent('Example', () => Example);

Run the Example Application

To run the example application:

• Move to the Example directory: cd Example
• Install node dependencies: yarn install
• Install objective-c dependencies: cd ios && pod install
• Open the xcworkspace and run the app: open Example.xcworkspace

Migrating from 1.x to 2.x

• Make sure your pod dependencies are updated. If you manually specified a pod version, you'll want to update it as follows:

  s.dependency 'TwilioVideo', '~> 2.2.0'

• Both participants and tracks are uniquely identified by their sid/trackSid field. The trackId field no longer exists and should be replaced by trackSid. Commensurate with this change, participant views now expect participantSid and videoTrackSid keys in the trackIdentity prop (instead of identity and trackId).

• Make sure you're listening to participant events via onParticipant{Added/Removed}VideoTrack rather than onParticipant{Enabled/Disabled}Track.

Contact

• Martín Fernández fmartin91@gmail.com
• Gaston Morixe gaston@gastonmorixe.com