Skip to contentSkip to navigationSkip to topbar
On this page

Building a JS Video App: Recommendations and Best Practices


(warning)

Warning

This documentation is for reference only. We are no longer onboarding new customers to Programmable Video. Existing customers can continue to use the product until December 5, 2026(link takes you to an external page).

We recommend migrating your application to the API provided by our preferred video partner, Zoom. We've prepared this migration guide(link takes you to an external page) to assist you in minimizing any service disruption.


Overview

overview page anchor

This guide provides recommendations and best practices for building a Video Application using twilio-video.js.



This table shows the browsers and platforms that are supported by twilio-video.js. Please use the isSupported(link takes you to an external page) flag to find out if twilio-video.js supports the browser in which your application is running.

1
const { isSupported } = require('twilio-video');
2
if (isSupported) {
3
// Set up your video app.
4
} else {
5
console.error('This browser is not supported by twilio-video.js.');
6
}

Please take a look at this guide to choose the right ConnectOptions(link takes you to an external page) values for your use case.


Application Domain

application-domain page anchor

twilio-video.js relies on getUserMedia(link takes you to an external page) to acquire local media. In order for this API to be available, please ensure that your application is running either on localhost or an https domain.

The autoplay policy does not allow you to autoplay audio using unmuted <audio> or <video> elements unless the user has interacted with your application (clicking on a button, for example), especially if your application's media engagement score is not high enough. Please refer to "Working around the browsers' autoplay policy" in the JavaScript SDK's COMMON_ISSUES.md(link takes you to an external page) to work around different browsers' autoplay policies.

Acquiring Camera in Mobile Browsers

acquiring-camera-in-mobile-browsers page anchor

In mobile browsers, the camera can be reserved by only one LocalVideoTrack at any given time. If you attempt to create a second LocalVideoTrack, video frames will no longer be supplied to the first LocalVideoTrack. So, we recommend that:

If you want to display your camera preview, pre-acquire media using createLocalTracks(link takes you to an external page). You can then pass these LocalTracks to connect(link takes you to an external page).

1
const { createLocalTracks, connect } = require('twilio-video');
2
3
const tracks = await createLocalTracks();
4
5
// Display camera preview.
6
const localVideoTrack = tracks.find(track => track.kind === 'video');
7
divContainer.appendChild(localVideoTrack.attach());
8
9
// Join the Room with the pre-acquired LocalTracks.
10
const room = await connect('token', {
11
name: 'my-cool-room',
12
tracks
13
});

If you want to switch between the front and back facing cameras, starting from SDK version 2.7.0(link takes you to an external page), you can restart(link takes you to an external page) the existing LocalVideoTrack.

1
const { createLocalTracks, connect } = require('twilio-video');
2
3
const tracks = await createLocalTracks({
4
audio: true,
5
video: { facingMode: 'user' }
6
});
7
8
// Join the Room with the pre-acquired LocalTracks.
9
const room = await connect('token', {
10
name: 'my-cool-room',
11
tracks
12
});
13
14
const cameraTrack = tracks.find(track => track.kind === 'video');
15
16
// Switch to the back facing camera.
17
cameraTrack.restart({ facingMode: 'environment' });

In SDK versions 2.6.0 and below, you can stop and unpublish the existing LocalVideoTrack, use createLocalVideoTrack(link takes you to an external page) to create a new LocalVideoTrack and publish it to the Room.

1
const { createLocalTracks, createLocalVideoTrack, connect } = require('twilio-video');
2
3
const tracks = await createLocalTracks({
4
audio: true,
5
video: { facingMode: 'user' }
6
});
7
8
// Join the Room with the pre-acquired LocalTracks.
9
const room = await connect('token', {
10
name: 'my-cool-room',
11
tracks
12
});
13
14
// Capture the back facing camera.
15
const backFacingTrack = await createLocalVideoTrack({ facingMode: 'environment' });
16
17
// Switch to the back facing camera.
18
const frontFacingTrack = tracks.find(track => track.kind === 'video');
19
frontFacingTrack.stop();
20
room.localParticipant.unpublishTrack(frontFacingTrack);
21
room.localParticipant.publishTrack(backFacingTrack);

Testing the Microphone and Camera

testing-the-microphone-and-camera page anchor

In mobile browsers, getUserMedia(link takes you to an external page) is successful even when your microphone and/or camera are reserved by another tab or application. This can result in mobile Participants not being seen and/or heard by others in a Room. In order to work around this, we recommend that your application prompt users to test their microphone and camera before joining a Room. You can use createLocalAudioTrack(link takes you to an external page) to acquire the microphone, and use the Web Audio API(link takes you to an external page) to calculate its level. If the level is 0 even when the user is talking, then most likely the microphone is reserved by either another tab or application. You can then recommend that the user close all the other applications and reload your application, or worst case, restart the browser.

testmic.js

1
const { createLocalAudioTrack } = require('twilio-video');
2
const pollAudioLevel = require('./pollaudiolevel');
3
4
const audioTrack = await createLocalAudioTrack();
5
6
// Display the audio level.
7
pollAudioLevel(audioTrack, level => {
8
/* Update audio level indicator. */
9
});

pollaudiolevel.js

1
const AudioContext = window.AudioContext || window.webkitAudioContext;
2
const audioContext = AudioContext ? new AudioContext() : null;
3
4
function rootMeanSquare(samples) {
5
const sumSq = samples.reduce((sumSq, sample) => sumSq + sample * sample, 0);
6
return Math.sqrt(sumSq / samples.length);
7
}
8
9
async function pollAudioLevel(track, onLevelChanged) {
10
if (!audioContext) {
11
return;
12
}
13
14
// Due to browsers' autoplay policy, the AudioContext is only active after
15
// the user has interacted with your app, after which the Promise returned
16
// here is resolved.
17
await audioContext.resume();
18
19
// Create an analyser to access the raw audio samples from the microphone.
20
const analyser = audioContext.createAnalyser();
21
analyser.fftSize = 1024;
22
analyser.smoothingTimeConstant = 0.5;
23
24
// Connect the LocalAudioTrack's media source to the analyser.
25
const stream = new MediaStream([track.mediaStreamTrack]);
26
const source = audioContext.createMediaStreamSource(stream);
27
source.connect(analyser);
28
29
const samples = new Uint8Array(analyser.frequencyBinCount);
30
let level = null;
31
32
// Periodically calculate the audio level from the captured samples,
33
// and if changed, call the callback with the new audio level.
34
requestAnimationFrame(function checkLevel() {
35
analyser.getByteFrequencyData(samples);
36
const rms = rootMeanSquare(samples);
37
const log2Rms = rms && Math.log2(rms);
38
39
// Audio level ranges from 0 (silence) to 10 (loudest).
40
const newLevel = Math.ceil(10 * log2Rms / 8);
41
if (level !== newLevel) {
42
level = newLevel;
43
onLevelChanged(level);
44
}
45
46
// Continue calculating the level only if the audio track is live.
47
if (track.mediaStreamTrack.readyState === 'live') {
48
requestAnimationFrame(checkLevel);
49
} else {
50
requestAnimationFrame(() => onLevelChanged(0));
51
}
52
});
53
}
54
55
module.exports = pollAudioLevel;

You can use createLocalVideoTrack(link takes you to an external page) to acquire the camera, and attach its corresponding <video> element to the DOM. If there are no video frames, then most likely the camera is reserved by either another tab or application. Your can then recommend that the user close all the other applications and reload your application, or worst case, restart the browser.

testcamera.js

1
const { createLocalVideoTrack } = require('twilio-video');
2
3
const videoTrack = await createLocalVideoTrack();
4
5
// Display the video preview.
6
const divContainer = document.getElementById('local-video');
7
const videoElement = videoTrack.attach();
8
divContainer.appendChild(videoElement);

NOTE: In iOS Safari, because of this WebKit bug(link takes you to an external page), calling getUserMedia(link takes you to an external page) again will mute previously acquired LocalTracks. So, please make sure that the LocalTracks that you pass in ConnectOptions are neither muted nor stopped.


Application Backgrounding in Mobile Browsers

application-backgrounding-in-mobile-browsers page anchor

When an application that is running on a mobile browser is backgrounded, it will not have access to the video feed from the camera until it is foregrounded. So, we recommend that you stop and unpublish the camera's LocalVideoTrack, and publish a new LocalVideoTrack once your application is foregrounded. On the remote side, you can listen to the unsubscribed(link takes you to an external page) and subscribed(link takes you to an external page) events on the corresponding RemoteVideoTrackPublication in order to notify the user accordingly. You can use the Page Visibility API(link takes you to an external page) to detect backgrounding and foregrounding.

mobileuser.js

1
const { connect, createLocalTracks, createLocalVideoTrack } = require('twilio-video');
2
3
const tracks = await createLocalTracks();
4
5
let videoTrack = tracks.find(track => track.kind === 'video');
6
7
const room = await connect('token1', {
8
name: 'my-cool-room',
9
tracks
10
});
11
12
if (/* isMobile */) {
13
document.addEventListener('visibilitychange', async () => {
14
if (document.visibilityState === 'hidden') {
15
// The app has been backgrounded. So, stop and unpublish your LocalVideoTrack.
16
videoTrack.stop();
17
room.localParticipant.unpublishTrack(videoTrack);
18
} else {
19
// The app has been foregrounded, So, create and publish a new LocalVideoTrack.
20
videoTrack = await createLocalVideoTrack();
21
await room.localParticipant.publishTrack(videoTrack);
22
}
23
});
24
}

remoteuser.js

1
const { connect } = require('twilio-video');
2
3
function setupRemoteVideoNotifications(publication) {
4
if (publication.isSubscribed) {
5
// Indicate to the user that the mobile user has added video.
6
}
7
8
publication.on('subscribed', track => {
9
// Indicate to the user that the mobile user has added video.
10
});
11
12
publication.on('unsubscribed', track => {
13
// Indicate to the user that the mobile user has removed video.
14
});
15
}
16
17
function setupRemoteVideoNotificationsForParticipant(participant) {
18
// Set up remote video notifications for the VideoTracks that are
19
// already published.
20
participant.videoTracks.forEach(setupRemoteVideoNotifications);
21
22
// Set up remote video notifications for the VideoTracks that will be
23
// published later.
24
participant.on('trackPublished', setupRemoteVideoNotifications);
25
}
26
27
const room = await connect('token2', { name: 'my-cool-room' });
28
29
// Set up remote video notifications for the VideoTracks of RemoteParticipants
30
// already in the Room.
31
room.participants.forEach(setupRemoteVideoNotificationsForParticipant);
32
33
// Set up remote video notifications for the VideoTracks of RemoteParticipants
34
// that will join the Room later.
35
room.on('participantConnected', setupRemoteVideoNotificationsForParticipant);

When the user closes the tab/browser or navigates to another web page, we recommend that you disconnect from the Room so that other Participants are immediately notified.

1
const { createLocalTracks, connect } = require('twilio-video');
2
3
const tracks = await createLocalTracks();
4
5
const room = await connect('token', {
6
name: 'my-cool-room',
7
tracks
8
});
9
10
// Listen to the "beforeunload" event on window to leave the Room
11
// when the tab/browser is being closed.
12
window.addEventListener('beforeunload', () => room.disconnect());
13
14
// iOS Safari does not emit the "beforeunload" event on window.
15
// Use "pagehide" instead.
16
window.addEventListener('pagehide', () => room.disconnect());

This section lists some of the important errors raised by twilio-video.js and provides recommendations on how best to handle them.

These errors are raised when twilio-video.js fails to acquire the user's local media (camera and/or microphone). Your app can catch these errors as shown below:

1
const { connect, createLocalAudioTrack, createLocalTracks, createLocalVideoTrack } = require('twilio-video');
2
3
function handleMediaError(error) {
4
console.error('Failed to acquire media:', error.name, error.message);
5
}
6
7
// Handle media error raised by createLocalAudioTrack.
8
createLocalAudioTrack().catch(handleMediaError);
9
10
// Handle media error raised by createLocalVideoTrack.
11
createLocalVideoTrack().catch(handleMediaError);
12
13
// Handle media error raised by createLocalTracks.
14
createLocalTracks().catch(handleMediaError);
15
16
const mediaErrors = [
17
'NotAllowedError',
18
'NotFoundError',
19
'NotReadableError',
20
'OverconstrainedError',
21
'TypeError'
22
];
23
24
// Since connect() will acquire media for the application if tracks are not provided in ConnectOptions,
25
// it can raise media errors.
26
connect(token, { name: 'my-cool-room' }).catch(error => {
27
if (mediaErrors.includes(error.name)) {
28
// Handle media error here.
29
handleMediaError(error);
30
}
31
});

The following table describes the possible media errors and proposes ways for the application to handle them:

NameMessageCauseSolution
NotFoundError1. Permission denied by system 2. The object cannot be found here 3. Requested device not found1. User has disabled the input device for the browser in the system settings 2. User's machine does not have any such input device connected to it1. User should enable the input device for the browser in the system settings 2. User should have at lease one input device connected
NotAllowedError1. Permission denied 2. Permission dismissed 3. The request is not allowed by the user agent or the platform in the current context 4. The request is not allowed by the user agent or the platform in the current context, possibly because the user denied permission1. User has denied permission for your app to access the input device, either by clicking the "deny" button on the permission dialog, or by going to the browser settings 2. User has denied permission for your app by dismissing the permission dialog1. User should allow your app to access the input device in the browser settings and then reload 2. User should reload your app and grant permission to access the input device
TypeError1. Cannot read property 'getUserMedia' of undefined 2. navigator.mediaDevices is undefinedYour app is being served from a non-localhost non-secure contextYour app should be served from a secure context (localhost or https)
NotReadableError1. Failed starting capture of a audio track 2. Failed starting capture of a video track 3. Could not start audio source 4. Could not start video source 5. The I/O read operation failedThe browser could not start media capture with the input device even after the user gave permission, probably because another app or tab has reserved the input deviceUser should close all other apps and tabs that have reserved the input device and reload your app, or worst case, restart the browser
OverconstrainedErrorN/AThe input device could not satisfy the requested media constraintsIf this exception was raised due to your app requesting a specific device ID, then most likely the input device is no longer connected to the machine, so your app should request the default input device

NOTE: Each error can log a different message depending on the browser and OS. This table lists all possible messages associated with each error.

These errors are raised by twilio-video.js when it fails to join a Room. Your app can catch these errors as shown below:

1
const { connect } = require('twilio-video');
2
3
connect(token, { name: 'my-cool-room' }).catch(error => {
4
if ('code' in error) {
5
// Handle connection error here.
6
console.error('Failed to join Room:', error.code, error.message);
7
}
8
});

The following table describes the most common connection errors and proposes ways for the application to handle them:

ErrorCodeCauseSolution
SignalingConnectionError53000The client could not establish a connection to Twilio's signaling serverUser should make sure to have a stable internet connection
SignalingServerBusyError53006Twilio's signaling server is too busy to accept new clientsUser should try joining the Room again after some time
RoomMaxParticipantsExceededError53105The Room cannot allow in any more Participants to joinYour app should notify the user that the Room is full
RoomNotFoundError53106The client attempted to connect to a Room that does not existIf ad-hoc Room creation is disabled, then your app should make sure that the Room is created using the REST API before clients attempt to join
MediaConnectionError53405The client failed to establish a media connection with the Room1. User should make sure to have a stable internet connection 2. If the user is behind a firewall, then it should allow media traffic to and from Twilio to go through

These errors are raised by twilio-video.js when it is inadvertently disconnected from the Room. Your app can catch these errors as shown below:

1
const { connect } = require('twilio-video');
2
3
connect(token, { name: 'my-cool-room' }).then(room => {
4
room.once('disconnected', (room, error) => {
5
if (error) {
6
console.log('You were disconnected from the Room:', error.code, error.message);
7
}
8
});
9
});

The following table describes the most common disconnection errors and proposes ways for the application to handle them:

ErrorCodeCauseSolution
SignalingConnectionDisconnectedError53001The client failed to reconnect to Twilio's signaling server after a network disruption or handoffUser should make sure to have a stable internet connection
SignalingConnectionTimeoutError53002The liveliness checks for the connection to Twilio's signaling server failed, or the current session expiredUser should rejoin the Room
ParticipantDuplicateIdentityError53205Another client joined the Room with the same identityYour app should make sure each client creates an AccessToken with a unique identity string
MediaConnectionError53405The client failed to re-establish its media connection with the Room after a network disruption or handoff1. User should make sure to have a stable internet connection 2. If the user is behind a firewall, then it should allow media traffic to and from Twilio to go through

This section lists some of the important warnings raised by twilio-video.js and provides recommendations on how best to handle them.

(information)

Info

The JavaScript SDK raises Media Warnings whenever the Twilio media server is not able to detect media from a published audio or video track. You can enable Media Warnings starting from version 2.22.0 of the Twilio Video JavaScript SDK(link takes you to an external page).

Enable Media Warnings

enable-media-warnings page anchor

You can enable Media Warnings with the notifyWarnings option in the SDK's ConnectOptions object(link takes you to an external page) when connecting to a Twilio Room:

1
// Enable Media Warnings
2
const room = await connect('token', {
3
notifyWarnings: [ 'recording-media-lost' ]
4
// Other connect options
5
});

notifyWarnings takes an array of warnings to listen for. By default, this array is empty and no warning events will be raised.

Possible values to provide in the notifyWarnings array are:

  • recording-media-lost - Raised when the media server has not detected any media on the published track that is being recorded in the past 30 seconds. This usually happens when there are network interruptions or when the track has stopped.

Listen for Media Warning events

listen-for-media-warning-events page anchor

The SDK raises Media Warning events when it detects the conditions specified in the notifyWarnings options above. You can implement callbacks on these events to act on them when they happen, or to alert the user of an issue.

The warningsCleared event is raised when conditions have returned to normal.

1
// Catch Media Warnings
2
Array.from(room.localParticipant.tracks.values()).forEach(publication => {
3
publication.on('warning', name => {
4
if (name === 'recording-media-lost') {
5
console.log(`LocalTrack ${publication.track.name} is not recording media.`);
6
7
// Wait a reasonable amount of time to clear the warning.
8
const timer = setTimeout(() => {
9
// If the warning is not cleared, you can manually
10
// reconnect to the room, or show a dialog to the user
11
}, 5000);
12
13
publication.once('warningsCleared', () => {
14
console.log(`LocalTrack ${publication.track.name} warnings have cleared!`);
15
clearTimeout(timer);
16
});
17
}
18
});
19
});
Media Warning events
media-warning-events page anchor
  • LocalTrackPublication.on('warning', callback(name)) - Raised when the published Track encounters a warning.
  • LocalTrackPublication.on('warningsCleared', callback()) - Raised when the published Track cleared all warning.
  • LocalParticipant.on('trackWarning', callback(name, publication)) - Raised when one of the LocalParticipant's published tracks encounters a warning.
  • LocalParticipant.on('trackWarningsCleared', callback(publication)) - Raised when one of the LocalParticipant's published tracks cleared all warning.
  • Room.on('trackWarning', callback(name, publication, participant)) - Raised when one of the LocalParticipant's published tracks in the Room encounters a warning.
  • Room.on('trackWarningsCleared', callback(publication, participant)) - Raised when one of the LocalParticipant's published tracks in the Room clears all warnings.

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.