Class TelnyxRTC

true if the client is connected to the Telnyx RTC server

Example

const client = new TelnyxRTC(options);
console.log(client.connected); // => false
Copy

Gets the local html element.

Example

const client = new TelnyxRTC(options);

console.log(client.localElement);
// => HTMLMediaElement
Copy

Sets the local html element that will receive the local stream.

Example

const client = new TelnyxRTC(options);
client.localElement = 'localElementMediaId';
Copy

Audio and video constraints currently used by the client.

Examples

const client = new TelnyxRTC(options);

console.log(client.mediaConstraints);
// => { audio: true, video: false }
Copy

Gets the remote html element.

Example

const client = new TelnyxRTC(options);

console.log(client.remoteElement);
// => HTMLMediaElement
Copy

Sets the remote html element that will receive the remote stream.

Example

const client = new TelnyxRTC(options);
client.remoteElement = 'remoteElementMediaId';
Copy

Default audio output device, if set by client.

Example

const client = new TelnyxRTC(options);

console.log(client.speaker);
// => "abc123xyz"
Copy

Sets the default audio output device for subsequent calls.

Example

let result = await client.getAudioOutDevices();

if (result.length) {
  client.speaker = result[1].deviceId;
}
Copy

Checks if the browser has the permission to access mic and/or webcam

Examples

Checking for audio and video permissions:

const client = new TelnyxRTC(options);

client.checkPermissions();
Copy

Checking only for audio permissions:

const client = new TelnyxRTC(options);

client.checkPermissions(true, false);
Copy

Checking only for video permissions:

const client = new TelnyxRTC(options);

client.checkPermissions(false, true);
Copy

Creates a new connection for exchanging data with the WebRTC server

Examples

const client = new TelnyxRTC(options);

client.connect();
Copy

Disables use of the microphone in subsequent calls.

Note: This setting will be ignored if audio: true is specified when creating a new call.

Examples

const client = new TelnyxRTC(options);

client.disableMicrophone();
Copy

Keep in mind that new calls will fail if both the microphone and webcam is disabled. Make sure that the webcam is manually enabled, or video: true is specified before disabling the microphone.

const client = new TelnyxRTC({
  ...options,
  video: true
});

client.disableMicrophone();
Copy

Disconnect all active calls

Examples

const client = new TelnyxRTC(options);

client.disconnect();
Copy

Enables use of the microphone in subsequent calls.

Note: This setting will be ignored if audio: false is specified when creating a new call.

Examples

const client = new TelnyxRTC(options);

client.enableMicrophone();
Copy

Returns the audio input devices supported by the browser.

Examples

Using async/await:

async function() {
  const client = new TelnyxRTC(options);

  let result = await client.getAudioInDevices();

  console.log(result);
}
Copy

Using ES6 Promises:

client.getAudioInDevices().then((result) => {
  console.log(result);
});
Copy

Returns the audio output devices supported by the browser.

Browser Compatibility Note: Firefox has yet to fully implement audio output devices. As of v63, this feature is behind the user preference media.setsinkid.enabled. See: https://bugzilla.mozilla.org/show_bug.cgi?id=1152401#c98

Examples

Using async/await:

async function() {
  const client = new TelnyxRTC(options);

  let result = await client.getAudioOutDevices();

  console.log(result);
}
Copy

Using ES6 Promises:

client.getAudioOutDevices().then((result) => {
  console.log(result);
});
Copy

Returns supported resolution for the given webcam.

Examples

If deviceId is null

1. if deviceId is null and you don't have a webcam connected to your computer, it will throw an error with the message "Requested device not found".

2. if deviceId is null and you have one or more webcam connected to your computer, it will return a list of resolutions from the default device set up in your operating system.

Using async/await:

async function() {
  const client = new TelnyxRTC(options);
  let result = await client.getDeviceResolutions();
  console.log(result);
}
Copy

Using ES6 Promises:

client.getDeviceResolutions().then((result) => {
  console.log(result);
});
Copy

If deviceId is not null

it will return a list of resolutions from the deviceId sent.

Using async/await:

async function() {
  const client = new TelnyxRTC(options);
  let result = await client.getDeviceResolutions(deviceId);
  console.log(result);
}
Copy

Using ES6 Promises:

client.getDeviceResolutions(deviceId).then((result) => {
  console.log(result);
});
Copy

Deprecated

Returns a list of devices supported by the browser

Examples

Using async/await:

async function() {
  const client = new TelnyxRTC(options);
  let result = await client.getDevices();
  console.log(result);
}
Copy

Using ES6 Promises:

client.getDevices().then((result) => {
  console.log(result);
});
Copy

Returns a list of video devices supported by the browser (i.e. webcam).

Examples

Using async/await:

async function() {
  const client = new TelnyxRTC(options);
  let result = await client.getVideoDevices();
  console.log(result);
}
Copy

Using ES6 Promises:

client.getVideoDevices().then((result) => {
  console.log(result);
});
Copy

Deprecated

Alias for .disconnect()

Deprecated

Removes an event handler that were attached with .on(). If no handler parameter is passed, all listeners for that event will be removed.

Examples

Subscribe to the telnyx.error and then, remove the event handler.

const errorHandler = (error) => {
 // Log the error..
}

const client = new TelnyxRTC(options);

client.on('telnyx.error', errorHandler)

 // .. later
client.off('telnyx.error', errorHandler)
Copy

Attaches an event handler for a specific type of event.

Events

Examples

Subscribe to the telnyx.ready and telnyx.error events.

const client = new TelnyxRTC(options);

client.on('telnyx.ready', (client) => {
  // Your client is ready!
}).on('telnyx.error', (error) => {
  // Got an error...
})
Copy

Sets the default audio constraints for your client. See here for further details.

Note: It's a common behaviour, in WebRTC applications, to persist devices user's selection to then reuse them across visits. Due to a Webkit’s security protocols, Safari generates random deviceId on each page load. To avoid this issue you can specify two additional properties micId and micLabel in the constraints input parameter. The client will use these values to assure the microphone you want to use is available by matching both id and label with the device list retrieved from the browser.

Examples

Set microphone by id and label with the echoCancellation flag turned off:

// within an async function
const constraints = await client.setAudioSettings({
 micId: '772e94959e12e589b1cc71133d32edf543d3315cfd1d0a4076a60601d4ff4df8',
 micLabel: 'Internal Microphone (Built-in)',
 echoCancellation: false
})
Copy