This page 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, 2024.
We recommend migrating your application to the API provided by our preferred video partner, Zoom. We've prepared this migration guide to assist you in minimizing any service disruption.
In this guide, we will show you how to use the DataTrack API to send messages between Participants connected to a Room. With the DataTrack API you will be able to build powerful collaboration features such as whiteboarding, screen annotations, shared augmented reality apps and more. Use this guide along with our example app Quick Draw With Twilio to learn about the DataTrack API.
The DataTrack API lets you create a DataTrack which can be used to send low latency messages to zero or more subscribers to the track. DataTracks have the following properties:
In the next section, we will show you how to use the DataTrack API with the JavaScript SDK.
The LocalDataTrack is a Track that represents data that can be published to a Room by the LocalParticipant.
_10const { LocalDataTrack } = require(`twilio-video`);_10const dataTrack = new LocalDataTrack();
Next, we want to publish the LocalDataTrack we created earlier to the Room we connect to:
_10const { connect } = require('twilio-video');_10_10const room = await connect('$TOKEN', {_10 name: 'my-chat-room',_10 tracks: [dataTrack]_10});
You can use send to send data to the Room. DataTracks behave similarly to audio and video Tracks in the sense that, Participants will only receive data that was sent after:
For example, if Alice starts sending a stream of consecutive natural numbers (one number per second), and Bob joins the Room and subscribes to Alice's DataTrack after 5 seconds while Charlie joins the Room and subscribes to Alice's DataTrack after 10 seconds, then Bob will receive all the numbers starting from 6, and Charlie will receive all the numbers starting from 11.
Continuing with the example from above:
_22const dataTrackPublished = {};_22_22dataTrackPublished.promise = new Promise((resolve, reject) => {_22 dataTrackPublished.resolve = resolve;_22 dataTrackPublished.reject = reject;_22});_22_22room.localParticipant.on('trackPublished', publication => {_22 if (publication.track === dataTrack) {_22 dataTrackPublished.resolve();_22 }_22});_22_22room.localParticipant.on('trackPublicationFailed', (error, track) => {_22 if (track === dataTrack) {_22 dataTrackPublished.reject(error);_22 }_22});_22_22function sendMessage(message) {_22 dataTrackPublished.promise.then(() => dataTrack.send(message));_22}
Now that we are sending messages over the LocalDataTrack, we want our Participants to subscribe to the published DataTrack and receive those messages.
In the "trackSubscribed" event listener, you want to look for the subscribed DataTrack by checking the kind
property. Once you have the DataTrack, you can extract the message payload.
_10participant.on('trackSubscribed', track => {_10 console.log(`Participant "${participant.identity}" added ${track.kind} Track ${track.sid}`);_10 if (track.kind === 'data') {_10 track.on('message', data => {_10 console.log(data);_10 });_10 }_10});
DataTracks are intended for low-latency communication between Participants. Importantly, to optimize for lowest latency possible, delivery of DataTrack messages is not guaranteed. You can think of them more like UDP messages, rather than TCP.
You can configure the retry parameters for your DataTrack with the following options:
In Group Rooms, DataTrack connections are established between Participants via the media server. Under the hood, there is one connection between a LocalParticipant to the media server and a second connection from the media server to the RemoteParticipant. Twilio's media server configures the same maxPacketLifeTime value on each remote Participant's connection. Therefore, you should set the maxPacketLifetime to half the acceptable max lifetime for each message you send.