Various diagnostics functions to help analyze connections to Twilio
This SDK requires the use of Twilio NTS or your own STUN/TURN servers to perform the network tests. Using Twilio NTS will mirror how Twilio uses STUN/TURN in Programmable Video when connecting to a Twilio Video Room and will incur charges as per NTS pricing.
``bashClone repository
git clone git@github.com:twilio/rtc-diagnostics.git
cd rtc-diagnostics
In order to run integration tests, you'll need to copy over the
file
to credentials.json in the same folder, and replace the empty fields with valid values.$3
You can install directly from npm.
`
npm install @twilio/rtc-diagnostics --save
Or install from a local directory.
npm install /local-path-to-repo/rtc-diagnostics
Using this method, you can import
like so:
`ts
import { testMediaConnectionBitrate } from '@twilio/rtc-diagnostics';
`$3
You can also include directly in your web app using a Using this method,
will set a browser global:
`ts
const { testMediaConnectionBitrate } = Twilio.Diagnostics;
`Usage
The following are examples for running tests. For more information, please refer to the API Docs$3
ts
import { testMediaConnectionBitrate } from '@twilio/rtc-diagnostics';const mediaConnectionBitrateTest = testMediaConnectionBitrate({
iceServers: [{
credential: 'bar',
username: 'foo',
urls: 'turn:global.turn.twilio.com:3478?transport=udp',
}],
});
mediaConnectionBitrateTest.on('bitrate', (bitrate) => {
console.log(bitrate);
});
mediaConnectionBitrateTest.on('error', (error) => {
console.log(error);
});
mediaConnectionBitrateTest.on('end', (report) => {
console.log(report);
});
setTimeout(() => {
mediaConnectionBitrateTest.stop();
}, 10000);
`
See for more information for how to obtain the urls values$3
ts
import { testAudioInputDevice, AudioInputTest } from '@twilio/rtc-diagnostics';const audioInputDeviceTest = testAudioInputDevice({
deviceId: ...,
});
audioInputDeviceTest.on(AudioInputTest.Events.Volume, (volume) => {
console.log(volume);
});
audioInputDeviceTest.on(AudioInputTest.Events.Error, (error) => {
console.error(error);
});
audioInputDeviceTest.on(AudioInputTest.Events.End, (report) => {
console.log(report);
});
setTimeout(() => {
audioInputDeviceTest.stop();
}, 10000);
`$3
ts
import { testVideoInputDevice, VideoInputTest } from '@twilio/rtc-diagnostics';const videoInputDeviceTest = testVideoInputDevice({ element: videoElement });
videoInputDeviceTest.on(VideoInputTest.Events.Error, (error) => {
console.error(error);
});
videoInputDeviceTest.on(VideoInputTest.Events.End, (report) => {
console.log(report);
});
setTimeout(() => {
videoInputDeviceTest.stop();
}, 10000);
`$3
ts
import { testAudioOutputDevice, AudioOutputTest } from '@twilio/rtc-diagnostics';const audioOutputDeviceTest = testAudioOutputDevice({
deviceId: ...,
});
audioOutputDeviceTest.on(AudioOutputTest.Events.Volume, (volume) => {
console.log(volume);
});
audioOutputDeviceTest.on(AudioOutputTest.Events.Error, (error) => {
console.error(error);
});
audioOutputDeviceTest.on(AudioOutputTest.Events.End, (report) => {
console.log(report);
});
setTimeout(() => {
audioOutputDeviceTest.stop();
}, 10000);
``