diff --git a/dist/docs/AccessTokenExpiredError.html b/dist/docs/AccessTokenExpiredError.html new file mode 100644 index 000000000..c58bb83e7 --- /dev/null +++ b/dist/docs/AccessTokenExpiredError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: AccessTokenExpiredError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: AccessTokenExpiredError

+
+ +
+ +

+ AccessTokenExpiredError +

+ +

Raised whenever the AccessToken used for connecting, or reconnecting to a Room has expired.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

20104

message + + +string + + + + +

'Access Token expired or expiration date invalid'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/AccessTokenGrantsInvalidError.html b/dist/docs/AccessTokenGrantsInvalidError.html new file mode 100644 index 000000000..4d80d958a --- /dev/null +++ b/dist/docs/AccessTokenGrantsInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: AccessTokenGrantsInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: AccessTokenGrantsInvalidError

+
+ +
+ +

+ AccessTokenGrantsInvalidError +

+ +

Raised whenever the AccessToken used for connecting to a Room has invalid grants.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

20106

message + + +string + + + + +

'Invalid Access Token grants'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/AccessTokenHeaderInvalidError.html b/dist/docs/AccessTokenHeaderInvalidError.html new file mode 100644 index 000000000..317d7cada --- /dev/null +++ b/dist/docs/AccessTokenHeaderInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: AccessTokenHeaderInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: AccessTokenHeaderInvalidError

+
+ +
+ +

+ AccessTokenHeaderInvalidError +

+ +

Raised whenever the AccessToken used for connecting to a Room has an invalid header.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

20102

message + + +string + + + + +

'Invalid Access Token header'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/AccessTokenInvalidError.html b/dist/docs/AccessTokenInvalidError.html new file mode 100644 index 000000000..17bf617a4 --- /dev/null +++ b/dist/docs/AccessTokenInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: AccessTokenInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: AccessTokenInvalidError

+
+ +
+ +

+ AccessTokenInvalidError +

+ +

Raised whenever the AccessToken used for connecting to a Room is invalid.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

20101

message + + +string + + + + +

'Invalid Access Token'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/AccessTokenIssuerInvalidError.html b/dist/docs/AccessTokenIssuerInvalidError.html new file mode 100644 index 000000000..9247717c2 --- /dev/null +++ b/dist/docs/AccessTokenIssuerInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: AccessTokenIssuerInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: AccessTokenIssuerInvalidError

+
+ +
+ +

+ AccessTokenIssuerInvalidError +

+ +

Raised whenever the AccessToken used for connecting to a Room contains an invalid issuer or subject.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

20103

message + + +string + + + + +

'Invalid Access Token issuer/subject'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/AccessTokenNotYetValidError.html b/dist/docs/AccessTokenNotYetValidError.html new file mode 100644 index 000000000..49343c30f --- /dev/null +++ b/dist/docs/AccessTokenNotYetValidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: AccessTokenNotYetValidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: AccessTokenNotYetValidError

+
+ +
+ +

+ AccessTokenNotYetValidError +

+ +

Raised whenever the AccessToken used for connecting to a Room is not yet valid.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

20105

message + + +string + + + + +

'Access Token not yet valid'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/AccessTokenSignatureInvalidError.html b/dist/docs/AccessTokenSignatureInvalidError.html new file mode 100644 index 000000000..82dd932c3 --- /dev/null +++ b/dist/docs/AccessTokenSignatureInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: AccessTokenSignatureInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: AccessTokenSignatureInvalidError

+
+ +
+ +

+ AccessTokenSignatureInvalidError +

+ +

Raised whenever the AccessToken used for connecting to a Room has an invalid signature.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

20107

message + + +string + + + + +

'Invalid Access Token signature'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/AudioTrack.html b/dist/docs/AudioTrack.html new file mode 100644 index 000000000..c3b67cf33 --- /dev/null +++ b/dist/docs/AudioTrack.html @@ -0,0 +1,1845 @@ + + + + + + + Documentation Class: AudioTrack + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: AudioTrack

+
+ +
+ +

+ AudioTrack +

+ +

An AudioTrack is a Track representing audio.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
isStarted + + +boolean + + + + + + + + +

Whether or not the AudioTrack has +started; if the AudioTrack started, there is enough audio data to +begin playback

isEnabled + + +boolean + + + + + + + + +

Whether or not the AudioTrack is +enabled; if the AudioTrack is not enabled, it is "muted"

kind + + +Track.Kind + + + + + + + + +

"audio"

mediaStreamTrack + + +MediaStreamTrack + + + + + + + + +

An audio MediaStreamTrack

processedTrack + + +MediaStreamTrack + + + + + + + + + <nullable>
+ +

The source of processed audio samples. +It is always null as audio processing is not currently supported.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

attach()

+ + +
+
+ + +
+

Create an HTMLAudioElement and attach the AudioTrack to it.

+

The HTMLAudioElement's srcObject will be set to a new +MediaStream containing the AudioTrack's MediaStreamTrack.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

audioElement

+
+ + + +
+
+ Type +
+
+ +HTMLAudioElement + + + +
+
+ + + + + +
Example
+ + 
const Video = require('twilio-video');
+
+Video.createLocalAudioTrack().then(function(audioTrack) {
+  const audioElement = audioTrack.attach();
+  document.body.appendChild(audioElement);
+});
+
+ + + +
+ + + +
+
+

attach(mediaElement)

+ + +
+
+ + +
+

Attach the AudioTrack to an existing HTMLMediaElement. The +HTMLMediaElement could be an HTMLAudioElement or an HTMLVideoElement.

+

If the HTMLMediaElement's srcObject is not set to a MediaStream, +this method sets it to a new MediaStream containing the AudioTrack's +MediaStreamTrack; otherwise, it adds the MediaTrack's +MediaStreamTrack to the existing MediaStream. Finally, if there are any other +MediaStreamTracks of the same kind on the MediaStream, this method removes +them.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
mediaElement + + +HTMLMediaElement + + + + +

The HTMLMediaElement to attach to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

mediaElement

+
+ + + +
+
+ Type +
+
+ +HTMLMediaElement + + + +
+
+ + + + + +
Example
+ + 
const Video = require('twilio-video');
+
+const videoElement = document.createElement('video');
+document.body.appendChild(videoElement);
+
+Video.createLocalAudioTrack().then(function(audioTrack) {
+  audioTrack.attach(videoElement);
+});
+
+ + + +
+ + + +
+
+

attach(selector)

+ + +
+
+ + +
+

Attach the AudioTrack to an HTMLMediaElement selected by +document.querySelector. The HTMLMediaElement could be an +HTMLAudioElement or an HTMLVideoElement.

+

If the HTMLMediaElement's srcObject is not set to a MediaStream, +this method sets it to a new MediaStream containing the AudioTrack's +MediaStreamTrack; otherwise, it adds the AudioTrack's +MediaStreamTrack to the existing MediaStream. Finally, if there are any other +MediaStreamTracks of the same kind on the MediaStream, this method removes +them.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
selector + + +string + + + + +

A query selector for the HTMLMediaElement to +attach to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

mediaElement

+
+ + + +
+
+ Type +
+
+ +HTMLMediaElement + + + +
+
+ + + + + +
Example
+ + 
const Video = require('twilio-video');
+
+const videoElement = document.createElement('video');
+videoElement.id = 'my-video-element';
+document.body.appendChild(videoElement);
+
+Video.createLocalAudioTrack().then(function(track) {
+  track.attach('#my-video-element');
+});
+ + + +
+ + + +
+
+

detach()

+ + +
+
+ + +
+

Detach the AudioTrack from all previously attached HTMLMediaElements.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

mediaElements

+
+ + + +
+
+ Type +
+
+ +Array.<HTMLMediaElement> + + + +
+
+ + + + + +
Example
+ + 
const mediaElements = audioTrack.detach();
+mediaElements.forEach(mediaElement => mediaElement.remove());
+
+ + + +
+ + + +
+
+

detach(mediaElement)

+ + +
+
+ + +
+

Detach the AudioTrack from a previously attached HTMLMediaElement.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
mediaElement + + +HTMLMediaElement + + + + +

One of the HTMLMediaElements to +which the AudioTrack is attached

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

mediaElement

+
+ + + +
+
+ Type +
+
+ +HTMLMediaElement + + + +
+
+ + + + + +
Example
+ + 
const videoElement = document.getElementById('my-video-element');
+audioTrack.detach(videoElement).remove();
+
+ + + +
+ + + +
+
+

detach(selector)

+ + +
+
+ + +
+

Detach the AudioTrack from a previously attached HTMLMediaElement +specified by document.querySelector.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
selector + + +string + + + + +

The query selector of HTMLMediaElement to which +the AudioTrack is attached

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

mediaElement

+
+ + + +
+
+ Type +
+
+ +HTMLMediaElement + + + +
+
+ + + + + +
Example
+ + 
audioTrack.detach('#my-video-element').remove();
+ + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

disabled

+ + +
+
+ + +
+

The AudioTrack was disabled, i.e. "muted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +AudioTrack + + + + +

The AudioTrack that was disabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The AudioTrack was enabled, i.e. "unmuted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +AudioTrack + + + + +

The AudioTrack that was enabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The AudioTrack started. This means there is enough audio data to +begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +AudioTrack + + + + +

The AudioTrack that started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/ConfigurationAcquireFailedError.html b/dist/docs/ConfigurationAcquireFailedError.html new file mode 100644 index 000000000..0908044e2 --- /dev/null +++ b/dist/docs/ConfigurationAcquireFailedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: ConfigurationAcquireFailedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: ConfigurationAcquireFailedError

+
+ +
+ +

+ ConfigurationAcquireFailedError +

+ +

Raised whenever the Client is unable to acquire configuration information from the Server.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53500

message + + +string + + + + +

'Unable to acquire configuration'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/ConfigurationAcquireTurnFailedError.html b/dist/docs/ConfigurationAcquireTurnFailedError.html new file mode 100644 index 000000000..cead82780 --- /dev/null +++ b/dist/docs/ConfigurationAcquireTurnFailedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: ConfigurationAcquireTurnFailedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: ConfigurationAcquireTurnFailedError

+
+ +
+ +

+ ConfigurationAcquireTurnFailedError +

+ +

Raised whenever the Server is unable to return TURN credentials to the Client

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53501

message + + +string + + + + +

'Unable to acquire TURN credentials'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/LocalAudioTrack.html b/dist/docs/LocalAudioTrack.html new file mode 100644 index 000000000..dd88da327 --- /dev/null +++ b/dist/docs/LocalAudioTrack.html @@ -0,0 +1,2364 @@ + + + + + + + Documentation Class: LocalAudioTrack + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: LocalAudioTrack

+
+ +
+ +

+ LocalAudioTrack +

+ +

A LocalAudioTrack is an AudioTrack representing audio that +your LocalParticipant can publish to a Room. It can be +enabled and disabled with LocalAudioTrack#enable and +LocalAudioTrack#disable or stopped completely with +LocalAudioTrack#stop.

+ + +
+ + +
+
+ + +
+
+

new Twilio.Video.LocalAudioTrack(mediaStreamTrack [, options])

+ + +
+
+ + +
+

Construct a LocalAudioTrack from a MediaStreamTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
mediaStreamTrack + + +MediaStreamTrack + + + + + + + + + + +

An audio MediaStreamTrack

options + + +LocalTrackOptions + + + + + + + <optional>
+ + + + + +

LocalTrack options

+ + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
id + + +Track.ID + + + + + + + + +

The LocalAudioTrack's ID

isMuted + + +boolean + + + + + + + + +

Whether or not the audio source has stopped sending samples to the +LocalAudioTrack; This can happen when the microphone is taken over by another application, +mainly on mobile devices; When this property toggles, then muted and unmuted +events are fired appropriately

isStopped + + +boolean + + + + + + + + +

Whether or not the LocalAudioTrack is +stopped

noiseCancellation + + +NoiseCancellation + + + + + + + + + <nullable>
+ +

When a LocalAudioTrack is created +with NoiseCancellationOptions, this property provides interface +to enable or disable the noise cancellation at runtime.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

attach()

+ + +
+
+ + +
+

Create an HTMLAudioElement and attach the AudioTrack to it.

+

The HTMLAudioElement's srcObject will be set to a new +MediaStream containing the AudioTrack's MediaStreamTrack.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

audioElement

+
+ + + +
+
+ Type +
+
+ +HTMLAudioElement + + + +
+
+ + + + + +
Example
+ + 
const Video = require('twilio-video');
+
+Video.createLocalAudioTrack().then(function(audioTrack) {
+  const audioElement = audioTrack.attach();
+  document.body.appendChild(audioElement);
+});
+
+ + + +
+ + + +
+
+

detach()

+ + +
+
+ + +
+

Detach the AudioTrack from all previously attached HTMLMediaElements.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

mediaElements

+
+ + + +
+
+ Type +
+
+ +Array.<HTMLMediaElement> + + + +
+
+ + + + + +
Example
+ + 
const mediaElements = audioTrack.detach();
+mediaElements.forEach(mediaElement => mediaElement.remove());
+
+ + + +
+ + + +
+
+

disable()

+ + +
+
+ + +
+

Disable the LocalAudioTrack. This is equivalent to muting the audio source.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ + + +
+
+

enable()

+ + +
+
+ + +
+

Enable the LocalAudioTrack. This is equivalent to unmuting the audio source.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ + + +
+
+

enable( [enabled])

+ + +
+
+ + +
+

Enable or disable the LocalAudioTrack. This is equivalent to unmuting or muting +the audio source respectively.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
enabled + + +boolean + + + + + + + <optional>
+ + + + + +

Specify false to disable the +LocalAudioTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ + + +
+
+

restart( [constraints])

+ + +
+
+ + +
+

Restart the LocalAudioTrack. This stops the existing MediaStreamTrack +and creates a new MediaStreamTrack. If the LocalAudioTrack is being published +to a Room, then all the RemoteParticipants will start receiving media +from the newly created MediaStreamTrack. You can access the new MediaStreamTrack via +the mediaStreamTrack property. If you want to listen to events on +the MediaStreamTrack directly, please do so in the "started" event handler. Also, +the LocalAudioTrack's ID is no longer guaranteed to be the same as the +underlying MediaStreamTrack's ID.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
constraints + + +MediaTrackConstraints + + + + + + + <optional>
+ + + + + +

The optional MediaTrackConstraints +for restarting the LocalAudioTrack; If not specified, then the current MediaTrackConstraints +will be used; If {} (empty object) is specified, then the default MediaTrackConstraints +will be used

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + +
Returns:
+ + +
+

Rejects with a TypeError if the LocalAudioTrack was not created +using an one of createLocalAudioTrack, createLocalTracks or connect; +Also rejects with the DOMException +raised by getUserMedia when it fails

+
+ + + +
+
+ Type +
+
+ +Promise.<void> + + + +
+
+ + + + + +
Example
+ + 
const { connect, createLocalAudioTrack } = require('twilio-video');
+
+// Create a LocalAudioTrack that captures audio from a USB microphone.
+createLocalAudioTrack({ deviceId: 'usb-mic-id' }).then(function(localAudioTrack) {
+  return connect('token', {
+    name: 'my-cool-room',
+    tracks: [localAudioTrack]
+  });
+}).then(function(room) {
+  // Restart the LocalAudioTrack to capture audio from the default microphone.
+  const localAudioTrack = Array.from(room.localParticipant.audioTracks.values())[0].track;
+  return localAudioTrack.restart({ deviceId: 'default-mic-id' });
+});
+ + + +
+ + + +
+
+

stop()

+ + +
+
+ + +
+

Calls stop on the underlying MediaStreamTrack. If you choose to stop a +LocalAudioTrack, you should unpublish it after stopping.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

disabled

+ + +
+
+ + +
+

The LocalAudioTrack was disabled, i.e. the audio source was muted by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The LocalAudioTrack was enabled, i.e. the audio source was unmuted by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

muted

+ + +
+
+ + +
+

The LocalAudioTrack was muted because the audio source stopped sending samples, most +likely due to another application taking said audio source, especially on mobile devices.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was muted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The LocalAudioTrack started. This means there is enough audio data to +begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

stopped

+ + +
+
+ + +
+

The LocalAudioTrack stopped, either because LocalAudioTrack#stop +or LocalAudioTrack#restart was called or because the underlying +MediaStreamTrack ended.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that stopped

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unmuted

+ + +
+
+ + +
+

The LocalAudioTrack was unmuted because the audio source resumed sending samples, +most likely due to the application that took over the said audio source has released it +back to the application, especially on mobile devices. This event is also fired when +LocalAudioTrack#restart is called on a muted LocalAudioTrack with a +new audio source.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was unmuted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/LocalAudioTrackPublication.html b/dist/docs/LocalAudioTrackPublication.html new file mode 100644 index 000000000..3f0f55898 --- /dev/null +++ b/dist/docs/LocalAudioTrackPublication.html @@ -0,0 +1,1159 @@ + + + + + + + Documentation Class: LocalAudioTrackPublication + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: LocalAudioTrackPublication

+
+ +
+ +

+ LocalAudioTrackPublication +

+ +

A LocalAudioTrackPublication is a LocalAudioTrack that has +been published to a Room.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
kind + + +Track.Kind + + + + +

"audio"

track + + +LocalAudioTrack + + + + +

the LocalAudioTrack

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

setPriority(priority)

+ + +
+
+ + +
+

Update the Track.Priority of the published LocalTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the new Track.priority

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Throws:
+ + + +
+ + +RangeError + + + + +
+ + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ + + +
+
+

unpublish()

+ + +
+
+ + +
+

Unpublish a LocalTrackPublication. This means that the media +from this LocalTrackPublication is no longer available to the +Room's RemoteParticipants.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/LocalAudioTrackStats.html b/dist/docs/LocalAudioTrackStats.html new file mode 100644 index 000000000..56dd5cece --- /dev/null +++ b/dist/docs/LocalAudioTrackStats.html @@ -0,0 +1,454 @@ + + + + + + + Documentation Class: LocalAudioTrackStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: LocalAudioTrackStats

+
+ +
+ +

+ LocalAudioTrackStats +

+ +

Statistics for a LocalAudioTrack.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
audioLevel + + +AudioLevel + + + + + + + + + <nullable>
+ +

Input AudioLevel

jitter + + +number + + + + + + + + + <nullable>
+ +

Audio jitter in milliseconds

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/LocalDataTrack.html b/dist/docs/LocalDataTrack.html new file mode 100644 index 000000000..7f02cdc40 --- /dev/null +++ b/dist/docs/LocalDataTrack.html @@ -0,0 +1,837 @@ + + + + + + + Documentation Class: LocalDataTrack + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: LocalDataTrack

+
+ +
+ +

+ LocalDataTrack +

+ +

A LocalDataTrack is a Track representing data that your +LocalParticipant can publish to a Room.

+ + +
+ + +
+
+ + +
+
+

new Twilio.Video.LocalDataTrack( [options])

+ + +
+
+ + +
+

Construct a LocalDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
options + + +LocalDataTrackOptions + + + + + + + <optional>
+ + + + + +

LocalDataTrack options

+ + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
id + + +Track.ID + + + + + + + + +

The LocalDataTrack's ID

kind + + +Track.Kind + + + + + + + + +

"data"

maxPacketLifeTime + + +number + + + + + + + + + <nullable>
+ +

If non-null, this represents a time +limit (in milliseconds) during which the LocalDataTrack will send +or re-send data if not acknowledged on the underlying RTCDataChannel(s).

maxRetransmits + + +number + + + + + + + + + <nullable>
+ +

If non-null, this represents the number +of times the LocalDataTrack will resend data if not successfully +delivered on the underlying RTCDataChannel(s).

ordered + + +boolean + + + + + + + + +

true if data on the LocalDataTrack is +guaranteed to be sent in order.

reliable + + +boolean + + + + + + + + +

This is true if both +maxPacketLifeTime and maxRetransmits are set to +null. In other words, if this is true, there is no bound on packet lifetime +or the number of times the LocalDataTrack will attempt to send +data, ensuring "reliable" transmission.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
var Video = require('twilio-video');
+
+var localDataTrack = new Video.LocalDataTrack();
+window.addEventListener('mousemove', function(event) {
+  localDataTrack.send(JSON.stringify({
+    x: e.clientX,
+    y: e.clientY
+  }));
+});
+
+var token1 = getAccessToken();
+Video.connect(token1, {
+  name: 'my-cool-room',
+  tracks: [localDataTrack]
+});
+
+var token2 = getAccessToken();
+Video.connect(token2, {
+  name: 'my-cool-room',
+  tracks: []
+}).then(function(room) {
+  room.on('trackSubscribed', function(track) {
+    track.on('message', function(message) {
+      console.log(JSON.parse(message)); // { x: <number>, y: <number> }
+    });
+  });
+});
+ + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

send(data)

+ + +
+
+ + +
+

Send a message over the LocalDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +string +| + +Blob +| + +ArrayBuffer +| + +ArrayBufferView + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/LocalDataTrackPublication.html b/dist/docs/LocalDataTrackPublication.html new file mode 100644 index 000000000..cbc0951e9 --- /dev/null +++ b/dist/docs/LocalDataTrackPublication.html @@ -0,0 +1,1159 @@ + + + + + + + Documentation Class: LocalDataTrackPublication + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: LocalDataTrackPublication

+
+ +
+ +

+ LocalDataTrackPublication +

+ +

A LocalDataTrackPublication is a LocalDataTrack that has been +published to a Room.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
kind + + +Track.Kind + + + + +

"data"

track + + +LocalDataTrack + + + + +

the LocalDataTrack

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

setPriority(priority)

+ + +
+
+ + +
+

Update the Track.Priority of the published LocalTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the new Track.priority

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Throws:
+ + + +
+ + +RangeError + + + + +
+ + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ + + +
+
+

unpublish()

+ + +
+
+ + +
+

Unpublish a LocalTrackPublication. This means that the media +from this LocalTrackPublication is no longer available to the +Room's RemoteParticipants.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/LocalParticipant.html b/dist/docs/LocalParticipant.html new file mode 100644 index 000000000..612266f83 --- /dev/null +++ b/dist/docs/LocalParticipant.html @@ -0,0 +1,3664 @@ + + + + + + + Documentation Class: LocalParticipant + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: LocalParticipant

+
+ +
+ +

+ LocalParticipant +

+ +

A LocalParticipant represents the local Participant in a +Room.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
audioTracks + + +Map.<Track.SID, LocalAudioTrackPublication> + + + + +

The LocalParticipant's LocalAudioTrackPublications

dataTracks + + +Map.<Track.SID, LocalDataTrackPublication> + + + + +

The LocalParticipant's LocalDataTrackPublications

tracks + + +Map.<Track.SID, LocalTrackPublication> + + + + +

The LocalParticipant's LocalTrackPublications

videoTracks + + +Map.<Track.SID, LocalVideoTrackPublication> + + + + +

The LocalParticipant's LocalVideoTrackPublications

signalingRegion + + +string + + + + +

The geographical region of the +signaling edge the LocalParticipant is connected to.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

publishTrack(localTrack [, options])

+ + +
+
+ + +
+

Publishes a LocalTrack to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
localTrack + + +LocalTrack + + + + + + + + + + +

The LocalTrack to publish

options + + +LocalTrackPublishOptions + + + + + + + <optional>
+ + + + + +

The LocalTrackPublishOptions +for publishing the LocalTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Throws:
+
    +
  • + +
    + + +TypeError + + + + +
    + +
    • + +
  • + +
    + + +RangeError + + + + +
    + +
    • +
+ + +
Returns:
+ + +
+ +
+ + + +
+
+ Type +
+
+ +Promise.<LocalTrackPublication> + + + +
+
+ + + + + +
Example
+ + 
var Video = require('twilio-video');
+
+Video.connect(token, {
+  name: 'my-cool-room',
+  audio: true
+}).then(function(room) {
+  return Video.createLocalVideoTrack({
+    name: 'camera'
+  }).then(function(localVideoTrack) {
+    return room.localParticipant.publishTrack(localVideoTrack, {
+      priority: 'high'
+    });
+  });
+}).then(function(publication) {
+  console.log('The LocalTrack "' + publication.trackName
+    + '" was successfully published with priority "'
+    * publication.priority + '"');
+});
+
+ + + +
+ + + +
+
+

publishTrack(mediaStreamTrack [, options])

+ + +
+
+ + +
+

Publishes a MediaStreamTrack to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
mediaStreamTrack + + +MediaStreamTrack + + + + + + + + + + +

The MediaStreamTrack +to publish; if a corresponding LocalAudioTrack or +LocalVideoTrack has not yet been published, this method will +construct one

options + + +MediaStreamTrackPublishOptions + + + + + + + <optional>
+ + + + + +

The options for publishing +the MediaStreamTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Throws:
+
    +
  • + +
    + + +TypeError + + + + +
    + +
    • + +
  • + +
    + + +RangeError + + + + +
    + +
    • +
+ + +
Returns:
+ + +
+ +
+ + + +
+
+ Type +
+
+ +Promise.<LocalTrackPublication> + + + +
+
+ + + + + +
Example
+ + 
var Video = require('twilio-video');
+
+Video.connect(token, {
+  name: 'my-cool-room',
+  audio: true
+}).then(function(room) {
+  return navigator.mediaDevices.getUserMedia({
+    video: true
+  }).then(function(mediaStream) {
+    var mediaStreamTrack = mediaStream.getTracks()[0];
+    return room.localParticipant.publishTrack(mediaStreamTrack, {
+      name: 'camera',
+      priority: 'high'
+    });
+  });
+}).then(function(publication) {
+  console.log('The LocalTrack "' + publication.trackName
+    + '" was successfully published with priority "'
+    * publication.priority + '"');
+});
+ + + +
+ + + +
+
+

publishTracks(tracks)

+ + +
+
+ + +
+

Publishes multiple LocalTracks to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
tracks + + +Array.<(LocalTrack|MediaStreamTrack)> + + + + +

The LocalTracks +to publish; for any MediaStreamTracks provided, if a corresponding +LocalAudioTrack or LocalVideoTrack has not yet been +published, this method will construct one

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Throws:
+ + + +
+ + +TypeError + + + + +
+ + + + + +
Returns:
+ + +
+ +
+ + + +
+
+ Type +
+
+ +Promise.<Array.<LocalTrackPublication>> + + + +
+
+ + + + + +
+ + + +
+
+

setNetworkQualityConfiguration(networkQualityConfiguration)

+ + +
+
+ + +
+

Sets the NetworkQualityVerbosity for the LocalParticipant and +RemoteParticipants. It does nothing if Network Quality is not enabled +while calling connect.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
networkQualityConfiguration + + +NetworkQualityConfiguration + + + + +

The new +NetworkQualityConfiguration; If either or both of the local and +remote NetworkQualityVerbosity values are absent, then the corresponding +existing values are retained

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
Examples
+ + 
// Update verbosity levels for both LocalParticipant and RemoteParticipants
+localParticipant.setNetworkQualityConfiguration({
+  local: 1,
+  remote: 2
+});
+ + 
// Update verbosity level for only the LocalParticipant
+localParticipant.setNetworkQualityConfiguration({
+  local: 1
+});
+
+ + 
// Update verbosity level for only the RemoteParticipants
+localParticipant.setNetworkQualityConfiguration({
+  remote: 2
+});
+ + + +
+ + + +
+
+

setParameters( [encodingParameters])

+ + +
+
+ + +
+

Set the LocalParticipant's EncodingParameters.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
encodingParameters + + +EncodingParameters + + + + + + + <optional>
+ + + + <nullable>
+ + + +

The new +EncodingParameters; If null, then the bitrate limits are removed; +If not specified, then the existing bitrate limits are preserved

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Throws:
+ + + +
+ + +TypeError + + + + +
+ + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ + + +
+
+

unpublishTrack(track)

+ + +
+
+ + +
+

Stops publishing a LocalTrack to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack +| + +MediaStreamTrack + + + + +

The LocalTrack +to stop publishing; if a MediaStreamTrack is provided, this method +looks up the corresponding LocalAudioTrack or +LocalVideoTrack to stop publishing

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Throws:
+ + + +
+ + +TypeError + + + + +
+ + + + + +
Returns:
+ + +
+ +
+ + + +
+
+ Type +
+
+ +LocalTrackPublication + + + +
+
+ + + + + +
+ + + +
+
+

unpublishTracks(tracks)

+ + +
+
+ + +
+

Stops publishing multiple LocalTracks to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
tracks + + +Array.<(LocalTrack|MediaStreamTrack)> + + + + +

The LocalTracks +to stop publishing; for any MediaStreamTracks provided, this method looks +up the corresponding LocalAudioTrack or LocalVideoTrack to +stop publishing

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Throws:
+ + + +
+ + +TypeError + + + + +
+ + + + + +
Returns:
+ + +
+ +
+ + + +
+
+ Type +
+
+ +Array.<LocalTrackPublication> + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

disconnected

+ + +
+
+ + +
+

The Participant has disconnected.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +Participant + + + + +

The Participant that disconnected.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

networkQualityLevelChanged

+ + +
+
+ + +
+

The Participant's NetworkQualityLevel changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
networkQualityLevel + + +NetworkQualityLevel + + + + + + + + + + +

The new +NetworkQualityLevel

networkQualityStats + + +NetworkQualityStats + + + + + + + + + <nullable>
+ + + +

The NetworkQualityStats +based on which NetworkQualityLevel is calculated, if any

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

The LocalParticipant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

The LocalParticipant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the LocalParticipant's LocalVideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

A LocalTrack was disabled by the LocalParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that was disabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

A LocalTrack was enabled by the LocalParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that was enabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublicationFailed

+ + +
+
+ + +
+

A LocalTrack failed to publish. Check the error message for more +information. In a Large Group Room (Maximum Participants greater than 50), +this event is raised with a ParticipantMaxTracksExceededError either +when attempting to publish the LocalTrack will exceed the Maximum Published +Tracks limit of 16, or the LocalTrack is part of a set of LocalTracks +which along with the published Tracks exceeds 16.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

A TwilioError explaining why publication +failed

localTrack + + +LocalTrack + + + + +

The LocalTrack that failed to +publish

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublished

+ + +
+
+ + +
+

A LocalTrack was successfully published.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +LocalTrackPublication + + + + +

The resulting +LocalTrackPublication for the published LocalTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTracks started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStopped

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTracks stopped, either +because LocalTrack#stop was called or because the underlying +MediaStreamTrack ended).

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that stopped

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackWarning

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that encountered the warning.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackWarningsCleared

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that cleared all warnings.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/LocalTrackPublication.html b/dist/docs/LocalTrackPublication.html new file mode 100644 index 000000000..c2ee72582 --- /dev/null +++ b/dist/docs/LocalTrackPublication.html @@ -0,0 +1,1159 @@ + + + + + + + Documentation Class: LocalTrackPublication + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: LocalTrackPublication

+
+ +
+ +

+ LocalTrackPublication +

+ +

A LocalTrackPublication is a LocalTrack that has been +published to a Room.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
isTrackEnabled + + +boolean + + + + +

whether the published LocalTrack +is enabled

kind + + +Track.Kind + + + + +

kind of the published LocalTrack

priority + + +Track.Priority + + + + +

the publish priority of the LocalTrack

track + + +LocalTrack + + + + +

the LocalTrack

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

setPriority(priority)

+ + +
+
+ + +
+

Update the Track.Priority of the published LocalTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the new Track.priority

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Throws:
+ + + +
+ + +RangeError + + + + +
+ + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ + + +
+
+

unpublish()

+ + +
+
+ + +
+

Unpublish a LocalTrackPublication. This means that the media +from this LocalTrackPublication is no longer available to the +Room's RemoteParticipants.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/LocalTrackStats.html b/dist/docs/LocalTrackStats.html new file mode 100644 index 000000000..dae5aa90a --- /dev/null +++ b/dist/docs/LocalTrackStats.html @@ -0,0 +1,486 @@ + + + + + + + Documentation Class: LocalTrackStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: LocalTrackStats

+
+ +
+ +

+ LocalTrackStats +

+ +

Statistics for a LocalTrack.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
bytesSent + + +number + + + + + + + + + <nullable>
+ +

Number of bytes sent

packetsSent + + +number + + + + + + + + + <nullable>
+ +

Number of packets sent

roundTripTime + + +number + + + + + + + + + <nullable>
+ +

Round trip time in milliseconds

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/LocalVideoTrack.html b/dist/docs/LocalVideoTrack.html new file mode 100644 index 000000000..2e09da74b --- /dev/null +++ b/dist/docs/LocalVideoTrack.html @@ -0,0 +1,2852 @@ + + + + + + + Documentation Class: LocalVideoTrack + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: LocalVideoTrack

+
+ +
+ +

+ LocalVideoTrack +

+ +

A LocalVideoTrack is a VideoTrack representing video that +your LocalParticipant can publish to a Room. It can be +enabled and disabled with LocalVideoTrack#enable and +LocalVideoTrack#disable or stopped completely with +LocalVideoTrack#stop.

+ + +
+ + +
+
+ + +
+
+

new Twilio.Video.LocalVideoTrack(mediaStreamTrack [, options])

+ + +
+
+ + +
+

Construct a LocalVideoTrack from a MediaStreamTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
mediaStreamTrack + + +MediaStreamTrack + + + + + + + + + + +

The underlying MediaStreamTrack

options + + +LocalTrackOptions + + + + + + + <optional>
+ + + + + +

LocalTrack options

+ + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
id + + +Track.ID + + + + +

The LocalVideoTrack's ID

isMuted + + +boolean + + + + +

Whether or not the video source has stopped sending frames to the +LocalVideoTrack; This can happen when the camera is taken over by another application, +mainly on mobile devices; When this property toggles, then muted and unmuted +events are fired appropriately

isStopped + + +boolean + + + + +

Whether or not the LocalVideoTrack is +stopped

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

addProcessor(processor [, options])

+ + +
+
+ + +
+

Add a VideoProcessor to allow for custom processing of video frames belonging to a VideoTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
processor + + +VideoProcessor + + + + + + + + + + +

The VideoProcessor to use.

options + + +AddProcessorOptions + + + + + + + <optional>
+ + + + + +

AddProcessorOptions to provide.

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
Example
+ + 
class GrayScaleProcessor {
+  constructor(percentage) {
+    this.percentage = percentage;
+  }
+  processFrame(inputFrameBuffer, outputFrameBuffer) {
+    const context = outputFrameBuffer.getContext('2d');
+    context.filter = `grayscale(${this.percentage}%)`;
+    context.drawImage(inputFrameBuffer, 0, 0, inputFrameBuffer.width, inputFrameBuffer.height);
+  }
+}
+
+const localVideoTrack = Array.from(room.localParticipant.videoTracks.values())[0].track;
+localVideoTrack.addProcessor(new GrayScaleProcessor(100));
+ + + +
+ + + +
+
+

attach()

+ + +
+
+ + +
+

Create an HTMLVideoElement and attach the VideoTrack to it.

+

The HTMLVideoElement's srcObject will be set to a new +MediaStream containing the VideoTrack's MediaStreamTrack.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

videoElement

+
+ + + +
+
+ Type +
+
+ +HTMLVideoElement + + + +
+
+ + + + + +
Example
+ + 
const Video = require('twilio-video');
+
+Video.createLocalVideoTrack().then(function(videoTrack) {
+  const videoElement = videoTrack.attach();
+  document.body.appendChild(videoElement);
+});
+
+ + + +
+ + + +
+
+

detach()

+ + +
+
+ + +
+

Detach the VideoTrack from all previously attached HTMLMediaElements.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

mediaElements

+
+ + + +
+
+ Type +
+
+ +Array.<HTMLMediaElement> + + + +
+
+ + + + + +
Example
+ + 
const mediaElements = videoTrack.detach();
+mediaElements.forEach(mediaElement => mediaElement.remove());
+
+ + + +
+ + + +
+
+

disable()

+ + +
+
+ + +
+

Disable the LocalVideoTrack. This is equivalent to pausing a video source. +If a VideoProcessor is added, then processedTrack is also disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ + + +
+
+

enable()

+ + +
+
+ + +
+

Enable the LocalVideoTrack. This is equivalent to unpausing the video source. +If a VideoProcessor is added, then processedTrack is also enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ + + +
+
+

enable( [enabled])

+ + +
+
+ + +
+

Enable or disable the LocalVideoTrack. This is equivalent to unpausing or pausing +the video source respectively. If a VideoProcessor is added, then processedTrack +is also enabled or disabled.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
enabled + + +boolean + + + + + + + <optional>
+ + + + + + 		+ + true + +

Specify false to disable the +LocalVideoTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ + + +
+
+

removeProcessor(processor)

+ + +
+
+ + +
+

Remove the previously added VideoProcessor using addProcessor API.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
processor + + +VideoProcessor + + + + +

The VideoProcessor to remove.

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
Example
+ + 
class GrayScaleProcessor {
+  constructor(percentage) {
+    this.percentage = percentage;
+  }
+  processFrame(inputFrameBuffer, outputFrameBuffer) {
+    const context = outputFrameBuffer.getContext('2d');
+    context.filter = `grayscale(${this.percentage}%)`;
+    context.drawImage(inputFrameBuffer, 0, 0, inputFrameBuffer.width, inputFrameBuffer.height);
+  }
+}
+
+const localVideoTrack = Array.from(room.localParticipant.videoTracks.values())[0].track;
+const grayScaleProcessor = new GrayScaleProcessor(100);
+localVideoTrack.addProcessor(grayScaleProcessor);
+
+document.getElementById('remove-button').onclick = () => localVideoTrack.removeProcessor(grayScaleProcessor);
+ + + +
+ + + +
+
+

restart( [constraints])

+ + +
+
+ + +
+

Restart the LocalVideoTrack. This stops the existing MediaStreamTrack +and creates a new MediaStreamTrack. If the LocalVideoTrack is being published +to a Room, then all the RemoteParticipants will start receiving media +from the newly created MediaStreamTrack. You can access the new MediaStreamTrack via +the mediaStreamTrack property. If you want to listen to events on +the MediaStreamTrack directly, please do so in the "started" event handler. Also, +the LocalVideoTrack's ID is no longer guaranteed to be the same as the +underlying MediaStreamTrack's ID.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
constraints + + +MediaTrackConstraints + + + + + + + <optional>
+ + + + + +

The optional MediaTrackConstraints +for restarting the LocalVideoTrack; If not specified, then the current MediaTrackConstraints +will be used; If {} (empty object) is specified, then the default MediaTrackConstraints +will be used

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + +
Returns:
+ + +
+

Rejects with a TypeError if the LocalVideoTrack was not created +using an one of createLocalVideoTrack, createLocalTracks or connect; +Also rejects with the DOMException +raised by getUserMedia when it fails

+
+ + + +
+
+ Type +
+
+ +Promise.<void> + + + +
+
+ + + + + +
Example
+ + 
const { connect, createLocalVideoTrack } = require('twilio-video');
+
+// Create a LocalVideoTrack that captures video from the front-facing camera.
+createLocalVideoTrack({ facingMode: 'user' }).then(function(localVideoTrack) {
+  return connect('token', {
+    name: 'my-cool-room',
+    tracks: [localVideoTrack]
+  });
+}).then(function(room) {
+  // Restart the LocalVideoTrack to capture video from the back-facing camera.
+  const localVideoTrack = Array.from(room.localParticipant.videoTracks.values())[0].track;
+  return localVideoTrack.restart({ facingMode: 'environment' });
+});
+ + + +
+ + + +
+
+

stop()

+ + +
+
+ + +
+

Calls stop on the underlying MediaStreamTrack. If you choose to stop a +LocalVideoTrack, you should unpublish it after stopping.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

dimensionsChanged

+ + +
+
+ + +
+

The VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack whose dimensions changed

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The LocalVideoTrack was disabled, i.e. the video source was paused by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The LocalVideoTrack was enabled, i.e. the video source was unpaused by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

muted

+ + +
+
+ + +
+

The LocalVideoTrack was muted because the video source stopped sending frames, most +likely due to another application taking said video source, especially on mobile devices.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was muted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The LocalVideoTrack started. This means there is enough video data +to begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

stopped

+ + +
+
+ + +
+

The LocalVideoTrack stopped, either because LocalVideoTrack#stop +or LocalVideoTrack#restart was called or because the underlying +MediaStreamTrack ended.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that stopped

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unmuted

+ + +
+
+ + +
+

The LocalVideoTrack was unmuted because the video source resumed sending frames, +most likely due to the application that took over the said video source has released it +back to the application, especially on mobile devices. This event is also fired when +LocalVideoTrack#restart is called on a muted LocalVideoTrack with a +new video source.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was unmuted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/LocalVideoTrackPublication.html b/dist/docs/LocalVideoTrackPublication.html new file mode 100644 index 000000000..d3afc0a21 --- /dev/null +++ b/dist/docs/LocalVideoTrackPublication.html @@ -0,0 +1,1159 @@ + + + + + + + Documentation Class: LocalVideoTrackPublication + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: LocalVideoTrackPublication

+
+ +
+ +

+ LocalVideoTrackPublication +

+ +

A LocalVideoTrackPublication is a LocalVideoTrack that has +been published to a Room.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
kind + + +Track.Kind + + + + +

"video"

track + + +LocalVideoTrack + + + + +

the LocalVideoTrack

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

setPriority(priority)

+ + +
+
+ + +
+

Update the Track.Priority of the published LocalTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the new Track.priority

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Throws:
+ + + +
+ + +RangeError + + + + +
+ + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ + + +
+
+

unpublish()

+ + +
+
+ + +
+

Unpublish a LocalTrackPublication. This means that the media +from this LocalTrackPublication is no longer available to the +Room's RemoteParticipants.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/LocalVideoTrackStats.html b/dist/docs/LocalVideoTrackStats.html new file mode 100644 index 000000000..ad9f37149 --- /dev/null +++ b/dist/docs/LocalVideoTrackStats.html @@ -0,0 +1,518 @@ + + + + + + + Documentation Class: LocalVideoTrackStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: LocalVideoTrackStats

+
+ +
+ +

+ LocalVideoTrackStats +

+ +

Statistics for a LocalVideoTrack.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
captureDimensions + + +VideoTrack#Dimensions + + + + + + + + + <nullable>
+ +

Video capture resolution

dimensions + + +VideoTrack#Dimensions + + + + + + + + + <nullable>
+ +

Video encoding resolution

captureFrameRate + + +number + + + + + + + + + <nullable>
+ +

Video capture frame rate

frameRate + + +number + + + + + + + + + <nullable>
+ +

Video encoding frame rate

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/MediaClientLocalDescFailedError.html b/dist/docs/MediaClientLocalDescFailedError.html new file mode 100644 index 000000000..42885bc96 --- /dev/null +++ b/dist/docs/MediaClientLocalDescFailedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: MediaClientLocalDescFailedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: MediaClientLocalDescFailedError

+
+ +
+ +

+ MediaClientLocalDescFailedError +

+ +

Raised whenever a Client is unable to create or apply a local media description.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53400

message + + +string + + + + +

'Client is unable to create or apply a local media description'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/MediaClientRemoteDescFailedError.html b/dist/docs/MediaClientRemoteDescFailedError.html new file mode 100644 index 000000000..aa53a1686 --- /dev/null +++ b/dist/docs/MediaClientRemoteDescFailedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: MediaClientRemoteDescFailedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: MediaClientRemoteDescFailedError

+
+ +
+ +

+ MediaClientRemoteDescFailedError +

+ +

Raised whenever the Client receives a remote media description but is unable to apply it.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53402

message + + +string + + + + +

'Client is unable to apply a remote media description'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/MediaConnectionError.html b/dist/docs/MediaConnectionError.html new file mode 100644 index 000000000..91214d372 --- /dev/null +++ b/dist/docs/MediaConnectionError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: MediaConnectionError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: MediaConnectionError

+
+ +
+ +

+ MediaConnectionError +

+ +

Raised by the Client or Server whenever a media connection fails or raised by the Client whenever it detects that media has stopped flowing.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53405

message + + +string + + + + +

'Media connection failed or Media activity ceased'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/MediaDTLSTransportFailedError.html b/dist/docs/MediaDTLSTransportFailedError.html new file mode 100644 index 000000000..d7856e66f --- /dev/null +++ b/dist/docs/MediaDTLSTransportFailedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: MediaDTLSTransportFailedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: MediaDTLSTransportFailedError

+
+ +
+ +

+ MediaDTLSTransportFailedError +

+ +

There was a problem while negotiating with the remote DTLS peer. Therefore the Participant will not be able to publish or subscribe to Tracks.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53407

message + + +string + + + + +

'Media connection failed due to DTLS handshake failure'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/MediaNoSupportedCodecError.html b/dist/docs/MediaNoSupportedCodecError.html new file mode 100644 index 000000000..50136b690 --- /dev/null +++ b/dist/docs/MediaNoSupportedCodecError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: MediaNoSupportedCodecError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: MediaNoSupportedCodecError

+
+ +
+ +

+ MediaNoSupportedCodecError +

+ +

Raised whenever the intersection of codecs supported by the Client and the Server (or, in peer-to-peer, the Client and another Participant) is empty.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53404

message + + +string + + + + +

'No supported codec'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/MediaServerLocalDescFailedError.html b/dist/docs/MediaServerLocalDescFailedError.html new file mode 100644 index 000000000..bf6c94607 --- /dev/null +++ b/dist/docs/MediaServerLocalDescFailedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: MediaServerLocalDescFailedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: MediaServerLocalDescFailedError

+
+ +
+ +

+ MediaServerLocalDescFailedError +

+ +

Raised whenever the Server is unable to create or apply a local media description.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53401

message + + +string + + + + +

'Server is unable to create or apply a local media description'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/MediaServerRemoteDescFailedError.html b/dist/docs/MediaServerRemoteDescFailedError.html new file mode 100644 index 000000000..7964b1a6e --- /dev/null +++ b/dist/docs/MediaServerRemoteDescFailedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: MediaServerRemoteDescFailedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: MediaServerRemoteDescFailedError

+
+ +
+ +

+ MediaServerRemoteDescFailedError +

+ +

Raised whenever the Server receives a remote media description but is unable to apply it.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53403

message + + +string + + + + +

'Server is unable to apply a remote media description'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/NetworkQualityAudioStats.html b/dist/docs/NetworkQualityAudioStats.html new file mode 100644 index 000000000..20331a9ff --- /dev/null +++ b/dist/docs/NetworkQualityAudioStats.html @@ -0,0 +1,350 @@ + + + + + + + Documentation Class: NetworkQualityAudioStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: NetworkQualityAudioStats

+
+ +
+ +

+ NetworkQualityAudioStats +

+ +

NetworkQualityMediaStats for a Participant's audio.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/NetworkQualityBandwidthStats.html b/dist/docs/NetworkQualityBandwidthStats.html new file mode 100644 index 000000000..ddb9557a0 --- /dev/null +++ b/dist/docs/NetworkQualityBandwidthStats.html @@ -0,0 +1,477 @@ + + + + + + + Documentation Class: NetworkQualityBandwidthStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: NetworkQualityBandwidthStats

+
+ +
+ +

+ NetworkQualityBandwidthStats +

+ +

Bandwidth network quality statistics.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
actual + + +number + + + + + + + + + <nullable>
+ +

the actual bandwidth used, in bits per second

available + + +number + + + + + + + + + <nullable>
+ +

an estimate of available useable bandwidth, in bits per second

level + + +NetworkQualityLevel + + + + + + + + + <nullable>
+ +

NetworkQualityLevel for bandwidth

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/NetworkQualityFractionLostStats.html b/dist/docs/NetworkQualityFractionLostStats.html new file mode 100644 index 000000000..4f3b6c982 --- /dev/null +++ b/dist/docs/NetworkQualityFractionLostStats.html @@ -0,0 +1,445 @@ + + + + + + + Documentation Class: NetworkQualityFractionLostStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: NetworkQualityFractionLostStats

+
+ +
+ +

+ NetworkQualityFractionLostStats +

+ +

Fraction lost network quality statistics.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
fractionLost + + +number + + + + + + + + + <nullable>
+ +

packets lost

level + + +NetworkQualityLevel + + + + + + + + + <nullable>
+ +

NetworkQualityLevel for fraction lost

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/NetworkQualityLatencyStats.html b/dist/docs/NetworkQualityLatencyStats.html new file mode 100644 index 000000000..cfc6fae33 --- /dev/null +++ b/dist/docs/NetworkQualityLatencyStats.html @@ -0,0 +1,477 @@ + + + + + + + Documentation Class: NetworkQualityLatencyStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: NetworkQualityLatencyStats

+
+ +
+ +

+ NetworkQualityLatencyStats +

+ +

Latency network quality statistics.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
jitter + + +number + + + + + + + + + <nullable>
+ +

media jitter in seconds

rtt + + +number + + + + + + + + + <nullable>
+ +

round trip time in seconds

level + + +NetworkQualityLevel + + + + + + + + + <nullable>
+ +

NetworkQualityLevel for latency

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/NetworkQualityMediaStats.html b/dist/docs/NetworkQualityMediaStats.html new file mode 100644 index 000000000..835bc5873 --- /dev/null +++ b/dist/docs/NetworkQualityMediaStats.html @@ -0,0 +1,511 @@ + + + + + + + Documentation Class: NetworkQualityMediaStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: NetworkQualityMediaStats

+
+ +
+ +

+ NetworkQualityMediaStats +

+ +

Network quality statistics shared between a Participant's audio or video.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
send + + +NetworkQualityLevel + + + + + + + + +

NetworkQualityLevel of the +Participant's published audio or video

recv + + +number + + + + + + + + +

NetworkQualityLevel of the +Participant's subscribed audio or video

sendStats + + +NetworkQualitySendOrRecvStats + + + + + + + + + <nullable>
+ +

NetworkQualitySendOrRecvStats +based on which NetworkQualityMediaStats#send +is calculated

recvStats + + +NetworkQualitySendOrRecvStats + + + + + + + + + <nullable>
+ +

NetworkQualitySendOrRecvStats +based on which NetworkQualityMediaStats#recv +is calculated

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/NetworkQualityRecvStats.html b/dist/docs/NetworkQualityRecvStats.html new file mode 100644 index 000000000..43bfc58ff --- /dev/null +++ b/dist/docs/NetworkQualityRecvStats.html @@ -0,0 +1,351 @@ + + + + + + + Documentation Class: NetworkQualityRecvStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: NetworkQualityRecvStats

+
+ +
+ +

+ NetworkQualityRecvStats +

+ +

NetworkQualitySendOrRecvStats based on which a Participant's +NetworkQualityMediaStats#recv is calculated.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/NetworkQualitySendOrRecvStats.html b/dist/docs/NetworkQualitySendOrRecvStats.html new file mode 100644 index 000000000..86ab1bc9a --- /dev/null +++ b/dist/docs/NetworkQualitySendOrRecvStats.html @@ -0,0 +1,480 @@ + + + + + + + Documentation Class: NetworkQualitySendOrRecvStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: NetworkQualitySendOrRecvStats

+
+ +
+ +

+ NetworkQualitySendOrRecvStats +

+ +

Network quality statistics shared between NetworkQualitySendStats and +NetworkQualityRecvStats based on which a Participant's +NetworkQualityMediaStats#send or +NetworkQualityMediaStats#recv is calculated.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
bandwidth + + +NetworkQualityBandwidthStats + + + + + + + + + <nullable>
+ +

bandwidth statistics

latency + + +NetworkQualityLatencyStats + + + + + + + + + <nullable>
+ +

latency statistics

fractionLost + + +NetworkQualityFractionLostStats + + + + + + + + + <nullable>
+ +

fraction lost statistics

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/NetworkQualitySendStats.html b/dist/docs/NetworkQualitySendStats.html new file mode 100644 index 000000000..ef78bdbee --- /dev/null +++ b/dist/docs/NetworkQualitySendStats.html @@ -0,0 +1,351 @@ + + + + + + + Documentation Class: NetworkQualitySendStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: NetworkQualitySendStats

+
+ +
+ +

+ NetworkQualitySendStats +

+ +

NetworkQualitySendOrRecvStats based on which a Participant's +NetworkQualityMediaStats#send is calculated.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/NetworkQualityStats.html b/dist/docs/NetworkQualityStats.html new file mode 100644 index 000000000..60733a1c2 --- /dev/null +++ b/dist/docs/NetworkQualityStats.html @@ -0,0 +1,479 @@ + + + + + + + Documentation Class: NetworkQualityStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: NetworkQualityStats

+
+ +
+ +

+ NetworkQualityStats +

+ +

Network quality statistics for a Participant.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
level + + +NetworkQualityLevel + + + + + + + + +

NetworkQualityLevel of the Participant

audio + + +NetworkQualityAudioStats + + + + + + + + + <nullable>
+ +

NetworkQualityMediaStats +for audio; null if NetworkQualityVerbosity is NetworkQualityVerbosity#minimal +or below

video + + +NetworkQualityVideoStats + + + + + + + + + <nullable>
+ +

NetworkQualityMediaStats +for video; null if NetworkQualityVerbosity is NetworkQualityVerbosity#minimal +or below

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/NetworkQualityVideoStats.html b/dist/docs/NetworkQualityVideoStats.html new file mode 100644 index 000000000..6fba46e1a --- /dev/null +++ b/dist/docs/NetworkQualityVideoStats.html @@ -0,0 +1,350 @@ + + + + + + + Documentation Class: NetworkQualityVideoStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: NetworkQualityVideoStats

+
+ +
+ +

+ NetworkQualityVideoStats +

+ +

NetworkQualityMediaStats for a Participant's video.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/NoiseCancellation.html b/dist/docs/NoiseCancellation.html new file mode 100644 index 000000000..045863f44 --- /dev/null +++ b/dist/docs/NoiseCancellation.html @@ -0,0 +1,820 @@ + + + + + + + Documentation Interface: NoiseCancellation + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Interface: NoiseCancellation

+
+ +
+ +

+ NoiseCancellation +

+ +

NoiseCancellation interface provides methods to control noise cancellation at runtime. This interface is exposed +on LocalAudioTrack property noiseCancellation. It is available only when NoiseCancellationOptions are +specified when creating a LocalAudioTrack, and the plugin is successfully loaded.

+ + +
+ + +
+
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +

Example

+ + 
const { connect, createLocalAudioTrack } = require('twilio-video');
+
+// Create a LocalAudioTrack with Krisp noise cancellation enabled.
+const localAudioTrack = await createLocalAudioTrack({
+  noiseCancellationOptions: {
+    sdkAssetsPath: 'path/to/hosted/twilio/krisp/audio/plugin/1.0.0/dist',
+    vendor: 'krisp'
+  }
+});
+
+if (!localAudioTrack.noiseCancellation) {
+  // If the Krisp audio plugin fails to load, then a warning message will be logged
+  // in the browser console, and the "noiseCancellation" property will be set to null.
+  // You can still use the LocalAudioTrack to join a Room. However, it will use the
+  // browser's noise suppression instead of the Krisp noise cancellation. Make sure
+  // the "sdkAssetsPath" provided in "noiseCancellationOptions" points to the correct
+  // hosted path of the plugin assets.
+} else {
+  // Join a Room with the LocalAudioTrack.
+  const room = await connect('token', {
+    name: 'my-cool-room',
+    tracks: [localAudioTrack]
+  });
+
+  if (!localAudioTrack.noiseCancellation.isEnabled) {
+    // Krisp noise cancellation is permanently disabled in Peer-to-Peer and Go Rooms.
+  }
+}
+
+//
+// Enable/disable noise cancellation.
+// @param {boolean} enable - whether noise cancellation should be enabled
+//
+function setNoiseCancellation(enable) {
+  const { noiseCancellation } = localAudioTrack;
+  if (noiseCancellation) {
+    if (enable) {
+      // If enabled, then the LocalAudioTrack will use the Krisp noise
+      // cancellation instead of the browser's noise suppression.
+      noiseCancellation.enable();
+    } else {
+      // If disabled, then the LocalAudioTrack will use the browser's
+      // noise suppression instead of the Krisp noise cancellation.
+      noiseCancellation.disable();
+    }
+  }
+}
+ + + + +
+ + + + + + + + + + + + +

Members

+ +
+ +
+
+

isEnabled :boolean

+ + +
+
+ +
+

Whether noise cancellation is enabled.

+
+ + + +
Type:
+
    +
  • + +boolean + + + +
    • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

sourceTrack :MediaStreamTrack

+ + +
+
+ +
+

The underlying MediaStreamTrack of the LocalAudioTrack.

+
+ + + +
Type:
+
    +
  • + +MediaStreamTrack + + + +
    • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

vendor :NoiseCancellationVendor

+ + +
+
+ +
+

Name of the noise cancellation vendor.

+
+ + + +
Type:
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ +
+ + + +

Methods

+ +
+ +
+
+

disable()

+ + +
+
+ + +
+

Disable noise cancellation.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Promise that resolves when the operation is complete

+
+ + + +
+
+ Type +
+
+ +Promise.<void> + + + +
+
+ + + + + +
+ + + +
+
+

enable()

+ + +
+
+ + +
+

Enable noise cancellation.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Throws:
+ + + +
+
+
+

Throws an error if noise cancellation is disabled permanently +for the LocalAudioTrack

+
+
+
+
+
+ Type +
+
+ +Error + + + +
+
+
+
+ + + + + +
Returns:
+ + +
+

Promise that resolves when the operation is complete

+
+ + + +
+
+ Type +
+
+ +Promise.<void> + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/Participant.html b/dist/docs/Participant.html new file mode 100644 index 000000000..43cc022f3 --- /dev/null +++ b/dist/docs/Participant.html @@ -0,0 +1,1547 @@ + + + + + + + Documentation Class: Participant + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: Participant

+
+ +
+ +

+ Participant +

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
audioTracks + + +Map.<Track.SID, AudioTrackPublication> + + + + + + + + +

The Participant's AudioTrackPublications

dataTracks + + +Map.<Track.SID, DataTrackPublication> + + + + + + + + +

The Participant's DataTrackPublications.

identity + + +Participant.Identity + + + + + + + + +

The identity of the Participant

networkQualityLevel + + +NetworkQualityLevel + + + + + + + + + <nullable>
+ +

The +Participant's current NetworkQualityLevel, if any

networkQualityStats + + +NetworkQualityStats + + + + + + + + + <nullable>
+ +

The +Participant's current NetworkQualityStats, if any

sid + + +Participant.SID + + + + + + + + +

The Participant's SID

state + + +string + + + + + + + + +

"connected", "disconnected" or "reconnecting"

tracks + + +Map.<Track.SID, TrackPublication> + + + + + + + + +

The Participant's TrackPublications

videoTracks + + +Map.<Track.SID, VideoTrackPublication> + + + + + + + + +

The Participant's VideoTrackPublications

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + +
    +
  • EventEmitter
    • +
+ + + + + + + + + + + + + + + + + +

Type Definitions

+ +
+ +
+
+

Identity

+ + +
+
+ +
+

A Participant.Identity is a string that identifies a +Participant. You can think of it like a name.

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

SID

+ + +
+
+ +
+

A Participant.SID is a 34-character string starting with "PA" +that uniquely identifies a Participant.

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ +
+ + + +

Events

+ +
+ +
+
+

disconnected

+ + +
+
+ + +
+

The Participant has disconnected.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +Participant + + + + +

The Participant that disconnected.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

networkQualityLevelChanged

+ + +
+
+ + +
+

The Participant's NetworkQualityLevel changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
networkQualityLevel + + +NetworkQualityLevel + + + + + + + + + + +

The new +NetworkQualityLevel

networkQualityStats + + +NetworkQualityStats + + + + + + + + + <nullable>
+ + + +

The NetworkQualityStats +based on which NetworkQualityLevel is calculated, if any

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

The Participant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

The Participant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the Participant's VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of the Participant's Tracks started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +Track + + + + +

The Track that started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/ParticipantDuplicateIdentityError.html b/dist/docs/ParticipantDuplicateIdentityError.html new file mode 100644 index 000000000..35b3368d4 --- /dev/null +++ b/dist/docs/ParticipantDuplicateIdentityError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: ParticipantDuplicateIdentityError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: ParticipantDuplicateIdentityError

+
+ +
+ +

+ ParticipantDuplicateIdentityError +

+ +

Raised by the server to the existing Participant when a new Participant joins a Room with the same identity as the existing Participant.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53205

message + + +string + + + + +

'Participant disconnected because of duplicate identity'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/ParticipantIdentityCharsInvalidError.html b/dist/docs/ParticipantIdentityCharsInvalidError.html new file mode 100644 index 000000000..6b893ee60 --- /dev/null +++ b/dist/docs/ParticipantIdentityCharsInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: ParticipantIdentityCharsInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: ParticipantIdentityCharsInvalidError

+
+ +
+ +

+ ParticipantIdentityCharsInvalidError +

+ +

Raised whenever a Participant identity contains invalid characters.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53202

message + + +string + + + + +

'Participant identity contains invalid characters'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/ParticipantIdentityInvalidError.html b/dist/docs/ParticipantIdentityInvalidError.html new file mode 100644 index 000000000..39f756c0c --- /dev/null +++ b/dist/docs/ParticipantIdentityInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: ParticipantIdentityInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: ParticipantIdentityInvalidError

+
+ +
+ +

+ ParticipantIdentityInvalidError +

+ +

Raised whenever a Participant identity is invalid, and the scenario is not covered by a more specific error code.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53200

message + + +string + + + + +

'Participant identity is invalid'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/ParticipantIdentityTooLongError.html b/dist/docs/ParticipantIdentityTooLongError.html new file mode 100644 index 000000000..cafc4a2bc --- /dev/null +++ b/dist/docs/ParticipantIdentityTooLongError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: ParticipantIdentityTooLongError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: ParticipantIdentityTooLongError

+
+ +
+ +

+ ParticipantIdentityTooLongError +

+ +

Raised whenever a Participant identity is too long.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53201

message + + +string + + + + +

'Participant identity is too long'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/ParticipantMaxTracksExceededError.html b/dist/docs/ParticipantMaxTracksExceededError.html new file mode 100644 index 000000000..6b1739ebf --- /dev/null +++ b/dist/docs/ParticipantMaxTracksExceededError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: ParticipantMaxTracksExceededError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: ParticipantMaxTracksExceededError

+
+ +
+ +

+ ParticipantMaxTracksExceededError +

+ +

Raised whenever a Participant tries to publish a Track and the maximum number of published tracks allowed in the Room at the same time has been reached

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53203

message + + +string + + + + +

'The maximum number of published tracks allowed in the Room at the same time has been reached'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/ParticipantNotFoundError.html b/dist/docs/ParticipantNotFoundError.html new file mode 100644 index 000000000..06febeee9 --- /dev/null +++ b/dist/docs/ParticipantNotFoundError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: ParticipantNotFoundError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: ParticipantNotFoundError

+
+ +
+ +

+ ParticipantNotFoundError +

+ +

Raised whenever attempting an operation on a non-existent Participant.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53204

message + + +string + + + + +

'Participant not found'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/PreflightTest.html b/dist/docs/PreflightTest.html new file mode 100644 index 000000000..764a26d78 --- /dev/null +++ b/dist/docs/PreflightTest.html @@ -0,0 +1,871 @@ + + + + + + + Documentation Class: PreflightTest + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: PreflightTest

+
+ +
+ +

+ PreflightTest +

+ +

A PreflightTest monitors progress of an ongoing preflight test. +

+Instance of PreflightTest is returned by calling module:twilio-video.runPreflight

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + +
    +
  • EventEmitter
    • +
+ + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

stop()

+ + +
+
+ + +
+

stops ongoing tests and emits error

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

completed

+ + +
+
+ + +
+

Preflight test has completed successfully.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
report + + +PreflightTestReport + + + + +

Results of the test.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

failed

+ + +
+
+ + +
+

Preflight test has encountered a failure and is now stopped.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError +| + +Error + + + + +

A TwilioError or a DOMException. +Possible TwilioErrors include Signaling and Media related errors which can be found +here.

report + + +PreflightTestReport + + + + +

Partial results gathered during the test. Use this information to help determine the cause of failure.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

progress

+ + +
+
+ + +
+

Emitted to indicate progress of the test

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
progress + + +PreflightProgress + + + + +

Indicates the status completed.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RemoteAudioTrack.html b/dist/docs/RemoteAudioTrack.html new file mode 100644 index 000000000..799c18e1b --- /dev/null +++ b/dist/docs/RemoteAudioTrack.html @@ -0,0 +1,1627 @@ + + + + + + + Documentation Class: RemoteAudioTrack + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RemoteAudioTrack

+
+ +
+ +

+ RemoteAudioTrack +

+ +

A RemoteAudioTrack represents an AudioTrack published to a +Room by a RemoteParticipant.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
isEnabled + + +boolean + + + + + + + + +

Whether the RemoteAudioTrack is enabled

isSwitchedOff + + +boolean + + + + + + + + +

Whether the RemoteAudioTrack is switched off

sid + + +Track.SID + + + + + + + + +

The RemoteAudioTrack's SID

priority + + +Track.Priority + + + + + + + + + <nullable>
+ +

The subscribe priority of the RemoteAudioTrack

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

attach()

+ + +
+
+ + +
+

Create an HTMLAudioElement and attach the AudioTrack to it.

+

The HTMLAudioElement's srcObject will be set to a new +MediaStream containing the AudioTrack's MediaStreamTrack.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

audioElement

+
+ + + +
+
+ Type +
+
+ +HTMLAudioElement + + + +
+
+ + + + + +
Example
+ + 
const Video = require('twilio-video');
+
+Video.createLocalAudioTrack().then(function(audioTrack) {
+  const audioElement = audioTrack.attach();
+  document.body.appendChild(audioElement);
+});
+
+ + + +
+ + + +
+
+

detach()

+ + +
+
+ + +
+

Detach the AudioTrack from all previously attached HTMLMediaElements.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

mediaElements

+
+ + + +
+
+ Type +
+
+ +Array.<HTMLMediaElement> + + + +
+
+ + + + + +
Example
+ + 
const mediaElements = audioTrack.detach();
+mediaElements.forEach(mediaElement => mediaElement.remove());
+
+ + + +
+ + + +
+
+

setPriority(priority)

+ + +
+
+ + +
+

Update the subscribe Track.Priority of the RemoteAudioTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
priority + + +Track.Priority + + + + + + + + + <nullable>
+ + + +

the new subscribe Track.Priority; +Currently setPriority has no effect on audio tracks.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Throws:
+ + + +
+ + +RangeError + + + + +
+ + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

disabled

+ + +
+
+ + +
+

The RemoteAudioTrack was disabled, i.e. "muted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The RemoteAudioTrack was enabled, i.e. "unmuted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The RemoteAudioTrack started. This means there is enough audio data +to begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOff

+ + +
+
+ + +
+

A RemoteAudioTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOn

+ + +
+
+ + +
+

A RemoteAudioTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RemoteAudioTrackPublication.html b/dist/docs/RemoteAudioTrackPublication.html new file mode 100644 index 000000000..a9cc1d3e0 --- /dev/null +++ b/dist/docs/RemoteAudioTrackPublication.html @@ -0,0 +1,1003 @@ + + + + + + + Documentation Class: RemoteAudioTrackPublication + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RemoteAudioTrackPublication

+
+ +
+ +

+ RemoteAudioTrackPublication +

+ +

A RemoteAudioTrackPublication represents a RemoteAudioTrack +that has been published to a Room.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
kind + + +Track.Kind + + + + + + + + +

"audio"

track + + +RemoteAudioTrack + + + + + + + + + <nullable>
+ +

unless you have subscribed to the +RemoteAudioTrack, this property is null

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +

Events

+ +
+ +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteAudioTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

the RemoteAudioTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteAudioTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteAudioTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The RemoteAudioTrack was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The RemoteAudioTrack was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteAudioTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

the RemoteAudioTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RemoteAudioTrackStats.html b/dist/docs/RemoteAudioTrackStats.html new file mode 100644 index 000000000..95db58157 --- /dev/null +++ b/dist/docs/RemoteAudioTrackStats.html @@ -0,0 +1,454 @@ + + + + + + + Documentation Class: RemoteAudioTrackStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RemoteAudioTrackStats

+
+ +
+ +

+ RemoteAudioTrackStats +

+ +

Statistics for an AudioTrack.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
audioLevel + + +AudioLevel + + + + + + + + + <nullable>
+ +

Output AudioLevel

jitter + + +number + + + + + + + + + <nullable>
+ +

Audio jitter in milliseconds

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RemoteDataTrack.html b/dist/docs/RemoteDataTrack.html new file mode 100644 index 000000000..195e7463c --- /dev/null +++ b/dist/docs/RemoteDataTrack.html @@ -0,0 +1,1318 @@ + + + + + + + Documentation Class: RemoteDataTrack + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RemoteDataTrack

+
+ +
+ +

+ RemoteDataTrack +

+ +

A RemoteDataTrack represents data published to a Room by a +RemoteParticipant.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
isEnabled + + +boolean + + + + + + + + +

true

isSubscribed + + +boolean + + + + + + + + +

Whether the RemoteDataTrack is +subscribed to

isSwitchedOff + + +boolean + + + + + + + + +

Whether the RemoteDataTrack is +switched off

kind + + +Track.Kind + + + + + + + + +

"data"

maxPacketLifeTime + + +number + + + + + + + + + <nullable>
+ +

If non-null, this represents a time +limit (in milliseconds) during which data will be transmitted or +retransmitted if not acknowledged on the underlying RTCDataChannel.

maxRetransmits + + +number + + + + + + + + + <nullable>
+ +

If non-null, this represents the number +of times the data will be retransmitted if not successfully received on the +underlying RTCDataChannel.

ordered + + +boolean + + + + + + + + +

true if data on the RemoteDataTrack can +be received out-of-order.

priority + + +Track.Priority + + + + + + + + + <nullable>
+ +

The subscribe priority of the RemoteDataTrack

reliable + + +boolean + + + + + + + + +

This is true if both +maxPacketLifeTime and maxRetransmits are set to +null. In other words, if this is true, there is no bound on packet lifetime +or the number of retransmits that will be attempted, ensuring "reliable" +transmission.

sid + + +Track.SID + + + + + + + + +

The SID assigned to the RemoteDataTrack

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

setPriority(priority)

+ + +
+
+ + +
+

Update the subscriber Track.Priority of the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
priority + + +Track.Priority + + + + + + + + + <nullable>
+ + + +

the new Track.priority; +Currently setPriority has no effect on data tracks.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Throws:
+ + + +
+ + +RangeError + + + + +
+ + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

message

+ + +
+
+ + +
+

A message was received over the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +string +| + +ArrayBuffer + + + + +
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack that received +the message

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOff

+ + +
+
+ + +
+

A RemoteDataTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack that was +switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOn

+ + +
+
+ + +
+

A RemoteDataTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack that was +switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RemoteDataTrackPublication.html b/dist/docs/RemoteDataTrackPublication.html new file mode 100644 index 000000000..0817df965 --- /dev/null +++ b/dist/docs/RemoteDataTrackPublication.html @@ -0,0 +1,843 @@ + + + + + + + Documentation Class: RemoteDataTrackPublication + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RemoteDataTrackPublication

+
+ +
+ +

+ RemoteDataTrackPublication +

+ +

A RemoteDataTrackPublication represents a RemoteDataTrack +that has been published to a Room.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
kind + + +Track.Kind + + + + + + + + +

"data"

track + + +RemoteDataTrack + + + + + + + + + <nullable>
+ +

unless you have subscribed to the +RemoteDataTrack, this property is null

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +

Events

+ +
+ +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

the RemoteDataTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteDataTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

the RemoteDataTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RemoteParticipant.html b/dist/docs/RemoteParticipant.html new file mode 100644 index 000000000..8b3efc77e --- /dev/null +++ b/dist/docs/RemoteParticipant.html @@ -0,0 +1,2898 @@ + + + + + + + Documentation Class: RemoteParticipant + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RemoteParticipant

+
+ +
+ +

+ RemoteParticipant +

+ +

A RemoteParticipant represents a remote Participant in a +Room.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
audioTracks + + +Map.<Track.SID, RemoteAudioTrackPublication> + + + + +

The Participant's RemoteAudioTrackPublications

dataTracks + + +Map.<Track.SID, RemoteDataTrackPublication> + + + + +

The Participant's RemoteDataTrackPublications

tracks + + +Map.<Track.SID, RemoteTrackPublication> + + + + +

The Participant's RemoteTrackPublications

videoTracks + + +Map.<Track.SID, RemoteVideoTrackPublication> + + + + +

The Participant's RemoteVideoTrackPublications

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + + + + + +

Events

+ +
+ +
+
+

disconnected

+ + +
+
+ + +
+

The Participant has disconnected.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +Participant + + + + +

The Participant that disconnected.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

networkQualityLevelChanged

+ + +
+
+ + +
+

The Participant's NetworkQualityLevel changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
networkQualityLevel + + +NetworkQualityLevel + + + + + + + + + + +

The new +NetworkQualityLevel

networkQualityStats + + +NetworkQualityStats + + + + + + + + + <nullable>
+ + + +

The NetworkQualityStats +based on which NetworkQualityLevel is calculated, if any

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

The RemoteParticipant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

The RemoteParticipant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the RemoteParticipant's RemoteVideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

A RemoteTrack was disabled by the RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication associated with the disabled RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

A RemoteTrack was enabled by the RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication associated with the enabled RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackMessage

+ + +
+
+ + +
+

A message was received over one of the RemoteParticipant's +RemoteDataTracks.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +string +| + +ArrayBuffer + + + + +
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack over which the +message was received

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublished

+ + +
+
+ + +
+

A RemoteTrack was published by the RemoteParticipant after +connecting to the Room. This event is not emitted for +RemoteTracks that were published while the RemoteParticipant +was connecting to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the published RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
function trackPublished(publication) {
+  console.log(`Track ${publication.trackSid} was published`);
+}
+
+room.on('participantConnected', participant => {
+  // Handle RemoteTracks published while connecting to the Room.
+  participant.trackPublications.forEach(trackPublished);
+
+  // Handle RemoteTracks published after connecting to the Room.
+  participant.on('trackPublished', trackPublished);
+});
+ + + +
+ + + +
+
+

trackPublishPriorityChanged

+ + +
+
+ + +
+

The RemoteTrackPublication's publish Track.Priority was changed by the +RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the RemoteTrack's new publish +Track.Priority;

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that changed priority

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of the RemoteParticipant's RemoteTracks started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was subscribed to

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSubscriptionFailed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack could not be subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

The reason the RemoteTrack could not be +subscribed to

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that could not +be subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOff

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched off

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOn

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched on.

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnpublished

+ + +
+
+ + +
+

A RemoteTrack was unpublished by the RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the unpublished RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnsubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was unsubscribed from.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was unsubscribed from

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RemoteTrackPublication.html b/dist/docs/RemoteTrackPublication.html new file mode 100644 index 000000000..6240bd128 --- /dev/null +++ b/dist/docs/RemoteTrackPublication.html @@ -0,0 +1,1510 @@ + + + + + + + Documentation Class: RemoteTrackPublication + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RemoteTrackPublication

+
+ +
+ +

+ RemoteTrackPublication +

+ +

A RemoteTrackPublication represents a RemoteTrack that has +been published to a Room.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
isSubscribed + + +boolean + + + + + + + + +

whether the published RemoteTrack +is subscribed to

isTrackEnabled + + +boolean + + + + + + + + +

whether the published +RemoteTrack is enabled

kind + + +Track.Kind + + + + + + + + +

kind of the published RemoteTrack

publishPriority + + +Track.Priority + + + + + + + + +

the Track.Priority of the published +RemoteTrack set by the RemoteParticipant

track + + +RemoteTrack + + + + + + + + + <nullable>
+ +

Unless you have subscribed to the +RemoteTrack, this property is null

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + + + + + +

Events

+ +
+ +
+
+

publishPriorityChanged

+ + +
+
+ + +
+

The RemoteTrack's publish Track.Priority was changed by the +RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the RemoteTrack's new publish +Track.Priority; RemoteTrackPublication#publishPriority is also +updated accordingly

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The RemoteTrack was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The RemoteTrack was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOff

+ + +
+
+ + +
+

The RemoteTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOn

+ + +
+
+ + +
+

The RemoteTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RemoteTrackStats.html b/dist/docs/RemoteTrackStats.html new file mode 100644 index 000000000..a6a8fa51a --- /dev/null +++ b/dist/docs/RemoteTrackStats.html @@ -0,0 +1,448 @@ + + + + + + + Documentation Class: RemoteTrackStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RemoteTrackStats

+
+ +
+ +

+ RemoteTrackStats +

+ +

Statistics for a remote Track.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
bytesReceived + + +number + + + + + + + + + <nullable>
+ +

Number of bytes received

packetsReceived + + +number + + + + + + + + + <nullable>
+ +

Number of packets received

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RemoteVideoTrack.html b/dist/docs/RemoteVideoTrack.html new file mode 100644 index 000000000..6e93fe205 --- /dev/null +++ b/dist/docs/RemoteVideoTrack.html @@ -0,0 +1,2514 @@ + + + + + + + Documentation Class: RemoteVideoTrack + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RemoteVideoTrack

+
+ +
+ +

+ RemoteVideoTrack +

+ +

A RemoteVideoTrack represents a VideoTrack published to a +Room by a RemoteParticipant.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
isEnabled + + +boolean + + + + + + + + +

Whether the RemoteVideoTrack is enabled

isSwitchedOff + + +boolean + + + + + + + + +

Whether the RemoteVideoTrack is switched off

sid + + +Track.SID + + + + + + + + +

The RemoteVideoTrack's SID

priority + + +Track.Priority + + + + + + + + + <nullable>
+ +

The subscribe priority of the RemoteVideoTrack

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

addProcessor(processor [, options])

+ + +
+
+ + +
+

Add a VideoProcessor to allow for custom processing of video frames belonging to a VideoTrack. +When a Participant un-publishes and re-publishes a VideoTrack, a new RemoteVideoTrack is created and +any VideoProcessors attached to the previous RemoteVideoTrack would have to be re-added again.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
processor + + +VideoProcessor + + + + + + + + + + +

The VideoProcessor to use.

options + + +AddProcessorOptions + + + + + + + <optional>
+ + + + + +

AddProcessorOptions to provide.

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
Example
+ + 
class GrayScaleProcessor {
+  constructor(percentage) {
+    this.percentage = percentage;
+  }
+  processFrame(inputFrameBuffer, outputFrameBuffer) {
+    const context = outputFrameBuffer.getContext('2d');
+    context.filter = `grayscale(${this.percentage}%)`;
+    context.drawImage(inputFrameBuffer, 0, 0, inputFrameBuffer.width, inputFrameBuffer.height);
+  }
+}
+
+const grayscaleProcessor = new GrayScaleProcessor(100);
+
+Array.from(room.participants.values()).forEach(participant => {
+  const remoteVideoTrack = Array.from(participant.videoTracks.values())[0].track;
+  remoteVideoTrack.addProcessor(grayscaleProcessor);
+});
+ + + +
+ + + +
+
+

attach()

+ + +
+
+ + +
+

Create an HTMLVideoElement and attach the VideoTrack to it.

+

The HTMLVideoElement's srcObject will be set to a new +MediaStream containing the VideoTrack's MediaStreamTrack.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

videoElement

+
+ + + +
+
+ Type +
+
+ +HTMLVideoElement + + + +
+
+ + + + + +
Example
+ + 
const Video = require('twilio-video');
+
+Video.createLocalVideoTrack().then(function(videoTrack) {
+  const videoElement = videoTrack.attach();
+  document.body.appendChild(videoElement);
+});
+
+ + + +
+ + + +
+
+

detach()

+ + +
+
+ + +
+

Detach the VideoTrack from all previously attached HTMLMediaElements.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

mediaElements

+
+ + + +
+
+ Type +
+
+ +Array.<HTMLMediaElement> + + + +
+
+ + + + + +
Example
+ + 
const mediaElements = videoTrack.detach();
+mediaElements.forEach(mediaElement => mediaElement.remove());
+
+ + + +
+ + + +
+
+

removeProcessor(processor)

+ + +
+
+ + +
+

Remove the previously added VideoProcessor using addProcessor API.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
processor + + +VideoProcessor + + + + +

The VideoProcessor to remove.

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
Example
+ + 
class GrayScaleProcessor {
+  constructor(percentage) {
+    this.percentage = percentage;
+  }
+  processFrame(inputFrameBuffer, outputFrameBuffer) {
+    const context = outputFrameBuffer.getContext('2d');
+    context.filter = `grayscale(${this.percentage}%)`;
+    context.drawImage(inputFrameBuffer, 0, 0, inputFrameBuffer.width, inputFrameBuffer.height);
+  }
+}
+
+const grayscaleProcessor = new GrayScaleProcessor(100);
+
+Array.from(room.participants.values()).forEach(participant => {
+  const remoteVideoTrack = Array.from(participant.videoTracks.values())[0].track;
+  remoteVideoTrack.addProcessor(grayscaleProcessor);
+});
+
+document.getElementById('remove-button').onclick = () => {
+  Array.from(room.participants.values()).forEach(participant => {
+    const remoteVideoTrack = Array.from(participant.videoTracks.values())[0].track;
+    remoteVideoTrack.removeProcessor(grayscaleProcessor);
+  });
+}
+ + + +
+ + + +
+
+

setContentPreferences(contentPreferences)

+ + +
+
+ + +
+

Set the RemoteVideoTrack's content preferences. This method is applicable only for the group rooms and only when connected with +videoContentPreferencesMode in video bandwidth profile options set to 'manual'

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
contentPreferences + + +VideoContentPreferences + + + + +

requested preferences.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ + + +
+
+

setPriority(priority)

+ + +
+
+ + +
+

Update the subscribe Track.Priority of the RemoteVideoTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
priority + + +Track.Priority + + + + + + + + + <nullable>
+ + + +

the new subscribe Track.Priority; +If null, then the subscribe Track.Priority is cleared, which +means the Track.Priority set by the publisher is now the effective priority.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Throws:
+ + + +
+ + +RangeError + + + + +
+ + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ + + +
+
+

switchOff()

+ + +
+
+ + +
+

Request to switch off a RemoteVideoTrack, This method is applicable only for the group rooms and only when connected with +clientTrackSwitchOffControl in video bandwidth profile options set to 'manual'

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ + + +
+
+

switchOn()

+ + +
+
+ + +
+

Request to switch on a RemoteVideoTrack, This method is applicable only for the group rooms and only when connected with +clientTrackSwitchOffControl in video bandwidth profile options set to 'manual'

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

dimensionsChanged

+ + +
+
+ + +
+

The RemoteVideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack whose +dimensions changed

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The RemoteVideoTrack was disabled, i.e. "paused".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The RemoteVideoTrack was enabled, i.e. "resumed".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The RemoteVideoTrack started. This means there is enough video data +to begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOff

+ + +
+
+ + +
+

A RemoteVideoTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOn

+ + +
+
+ + +
+

A RemoteVideoTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RemoteVideoTrackPublication.html b/dist/docs/RemoteVideoTrackPublication.html new file mode 100644 index 000000000..83792322f --- /dev/null +++ b/dist/docs/RemoteVideoTrackPublication.html @@ -0,0 +1,1003 @@ + + + + + + + Documentation Class: RemoteVideoTrackPublication + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RemoteVideoTrackPublication

+
+ +
+ +

+ RemoteVideoTrackPublication +

+ +

A RemoteVideoTrackPublication represents a RemoteVideoTrack +that has been published to a Room.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
kind + + +Track.Kind + + + + + + + + +

"video"

track + + +RemoteVideoTrack + + + + + + + + + <nullable>
+ +

unless you have subscribed to the +RemoteVideoTrack, this property is null

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +

Events

+ +
+ +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteVideoTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

the RemoteVideoTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteVideoTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteVideoTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The RemoteVideoTrack was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The RemoteVideoTrack was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteVideoTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

the RemoteVideoTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RemoteVideoTrackStats.html b/dist/docs/RemoteVideoTrackStats.html new file mode 100644 index 000000000..ea24dd82c --- /dev/null +++ b/dist/docs/RemoteVideoTrackStats.html @@ -0,0 +1,454 @@ + + + + + + + Documentation Class: RemoteVideoTrackStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RemoteVideoTrackStats

+
+ +
+ +

+ RemoteVideoTrackStats +

+ +

Statistics for a VideoTrack.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
dimensions + + +VideoTrack#Dimensions + + + + + + + + + <nullable>
+ +

Received video resolution

frameRate + + +number + + + + + + + + + <nullable>
+ +

Received video frame rate

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/Room.html b/dist/docs/Room.html new file mode 100644 index 000000000..69f3d40f7 --- /dev/null +++ b/dist/docs/Room.html @@ -0,0 +1,4932 @@ + + + + + + + Documentation Class: Room + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: Room

+
+ +
+ +

+ Room +

+ +

A Room represents communication between you and one or more +RemoteParticipants sharing AudioTracks and +VideoTracks. +

+You can connect to a Room by calling module:twilio-video.connect.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
dominantSpeaker + + +RemoteParticipant + + + + + + + + + <nullable>
+ +

The Dominant Speaker in the +Room, if any

isRecording + + +boolean + + + + + + + + +

Whether or not the Room is being +recorded

localParticipant + + +LocalParticipant + + + + + + + + +

Your LocalParticipant +in the Room

mediaRegion + + +string + + + + + + + + +

String indicating geographical region +where media is processed for the Room.

name + + +string + + + + + + + + +

The Room's name

participants + + +Map.<Participant.SID, RemoteParticipant> + + + + + + + + +

The RemoteParticipants participating in this Room

sid + + +Room.SID + + + + + + + + +

The Room's SID

state + + +string + + + + + + + + +

"connected", "reconnecting", or "disconnected"

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + +
Throws:
+ + + +
+ + +SignalingConnectionDisconnectedError + + + + +
+ + + + + + + +
+ + +
+ + +

Extends

+ + + + +
    +
  • EventEmitter
    • +
+ + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

disconnect()

+ + +
+
+ + +
+

Disconnect from the Room.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ + + +
+
+

getStats()

+ + +
+
+ + +
+

Get the Room's media statistics. This is not supported in Safari 12.0 or below +due to this bug : https://bugs.webkit.org/show_bug.cgi?id=192601

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Promise.<Array.<StatsReport>> + + + +
+
+ + + + + +
+ + + +
+
+

refreshInactiveMedia()

+ + +
+
+ + +
+

Restart the muted local media Tracks and play inadvertently paused HTMLMediaElements +that are attached to local and remote media Tracks. This method is useful mainly on +mobile browsers (Safari and Chrome on iOS), where there is a possibility that the muted local +media Tracks are never unmuted and inadvertently paused HTMLMediaElements are never +played again, especially after handling an incoming phone call.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
+ +
+ + + +

Type Definitions

+ +
+ +
+
+

SID

+ + +
+
+ +
+

A Room.SID is a 34-character string starting with "RM" +that uniquely identifies a Room.

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ +
+ + + +

Events

+ +
+ +
+
+

disconnected

+ + +
+
+ + +
+

Your LocalParticipant was disconnected from the Room and all +other RemoteParticipants.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
room + + +Room + + + + + + + + + + +

The Room your +LocalParticipant was disconnected from

error + + +TwilioError + + + + + + + + + <nullable>
+ + + +

Present when the LocalParticipant got +disconnected from the Room unexpectedly

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('disconnected', function(room, error) {
+  if (error) {
+    console.log('Unexpectedly disconnected:', error);
+  }
+  myRoom.localParticipant.tracks.forEach(function(track) {
+    track.stop();
+    track.detach();
+  });
+});
+ + + +
+ + + +
+
+

dominantSpeakerChanged

+ + +
+
+ + +
+

The Dominant Speaker in the Room changed. Either the Dominant Speaker +is a new RemoteParticipant or the Dominant Speaker has been reset and +is now null.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
dominantSpeaker + + +RemoteParticipant + + + + + + + + + <nullable>
+ + + +

The Dominant Speaker in the +Room, if any

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

participantConnected

+ + +
+
+ + +
+

A RemoteParticipant joined the Room. In Large Group Rooms (Maximum +Participants greater than 50), this event is raised only when a RemoteParticipant +publishes at least one LocalTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant who joined

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantConnected', function(participant) {
+  console.log(participant.identity + ' joined the Room');
+});
+ + + +
+ + + +
+
+

participantDisconnected

+ + +
+
+ + +
+

A RemoteParticipant left the Room. In Large Group Rooms (Maximum +Participants greater than 50), this event is raised only when a RemoteParticipant +unpublishes all its LocalTracks.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant who left

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantDisconnected', function(participant) {
+  console.log(participant.identity + ' left the Room');
+  participant.tracks.forEach(function(track) {
+    track.detach().forEach(function(mediaElement) {
+      mediaElement.remove();
+    });
+  });
+});
+ + + +
+ + + +
+
+

participantReconnected

+ + +
+
+ + +
+

A RemoteParticipant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant that has reconnected.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantReconnected', participant => {
+  console.log(participant.identity + ' reconnected to the Room');
+});
+ + + +
+ + + +
+
+

participantReconnecting

+ + +
+
+ + +
+

A RemoteParticipant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant that is reconnecting.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantReconnecting', participant => {
+  console.log(participant.identity + ' is reconnecting to the Room');
+});
+ + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

Your application successfully reconnected to the Room. When this +event is emitted, the Room is in state "connected".

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('reconnected', () => {
+  console.log('Reconnected!');
+});
+ + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

Your application is reconnecting to the Room. This happens when there +is a disruption in your signaling connection and/or your media connection. When +this event is emitted, the Room is in state "reconnecting". If reconnecting +succeeds, the Room will emit a "reconnected" event.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +MediaConnectionError +| + +SignalingConnectionDisconnectedError + + + + +

A +MediaConnectionError if your application is reconnecting due to a +disruption in your media connection, or a SignalingConnectionDisconnectedError +if your application is reconnecting due to a disruption in your signaling connection

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('reconnecting', error => {
+  if (error.code === 53001) {
+    console.log('Reconnecting your signaling connection!', error.message);
+  } else if (error.code === 53405) {
+    console.log('Reconnecting your media connection!', error.message);
+  }
+});
+ + + +
+ + + +
+
+

recordingStarted

+ + +
+
+ + +
+

The Room is now being recorded

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

recordingStopped

+ + +
+
+ + +
+

The Room is no longer being recorded

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the RemoteParticipant's VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack whose dimensions changed

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteVideoTrack's dimensions changed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

A RemoteTrack was disabled by a RemoteParticipant in the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication that represents disabled RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +disabled the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

A RemoteTrack was enabled by a RemoteParticipant in the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication that represents enabled RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +enabled the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackMessage

+ + +
+
+ + +
+

A message was received over one of the RemoteParticipant's +RemoteDataTrack's.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +string +| + +ArrayBuffer + + + + +
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack over which the +message was received

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteDataTrack received the message

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublished

+ + +
+
+ + +
+

A RemoteTrack was published by a RemoteParticipant after +connecting to the Room. This event is not emitted for +RemoteTracks that were published while the RemoteParticipant +was connecting to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the published RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +published the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
function trackPublished(publication, participant) {
+  console.log(`RemoteParticipant ${participant.sid} published Track ${publication.trackSid}`);
+}
+
+// Handle RemoteTracks published after connecting to the Room.
+room.on('trackPublished', trackPublished);
+
+room.on('participantConnected', participant => {
+  // Handle RemoteTracks published while connecting to the Room.
+  participant.trackPublications.forEach(publication => trackPublished(publication, participant));
+});
+ + + +
+ + + +
+
+

trackPublishPriorityChanged

+ + +
+
+ + +
+

The RemoteTrack's publish Track.Priority was changed by the +RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the RemoteTrack's new publish +Track.Priority;

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that changed priority

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack changed priority

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of a RemoteParticipant's RemoteTracks in the Room started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that started

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was subscribed

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was subscribed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
room.on('trackSubscribed', function(track, publication, participant) {
+  var participantView = document.getElementById('participant-view-' + participant.identity);
+  participantView.appendChild(track.attach());
+});
+ + + +
+ + + +
+
+

trackSubscriptionFailed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack could not be subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

The reason the RemoteTrack could not be +subscribed to

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that could not +be subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack could not be subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOff

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched off

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOn

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched on

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnpublished

+ + +
+
+ + +
+

A RemoteTrack was unpublished by a RemoteParticipant to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the unpublished RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +unpublished the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnsubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was unsubscribed from.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was unsubscribed

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was unsubscribed from

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was unsubscribed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
room.on('trackUnsubscribed', function(track, publication, participant) {
+  track.detach().forEach(function(mediaElement) {
+    mediaElement.remove();
+  });
+});
+ + + +
+ + + +
+
+

trackWarning

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications in the Room encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that encountered the warning.

participant + + +LocalParticipant + + + + +

The LocalParticipant

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
room.on('trackWarning', (name, publication, participant) => {
+  if (name === 'recording-media-lost') {
+    log(`LocalTrack ${publication.track.name} is not recording media.`,
+      name, publication, participant);
+
+    // Wait a reasonable amount of time to clear the warning.
+    const timer = setTimeout(() => {
+      // If the warning is not cleared, you can manually
+      // reconnect to the room, or show a dialog to the user
+    }, 5000);
+
+    room.once('trackWarningsCleared', (publication, participant) => {
+      log('LocalTrack warnings have cleared!',
+        publication, participant);
+      clearTimeout(timer);
+    });
+  }
+});
+ + + +
+ + + +
+
+

trackWarningsCleared

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications in the Room cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that cleared all warnings.

participant + + +LocalParticipant + + + + +

The LocalParticipant

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomAudioOnlyFlagNotSupportedError.html b/dist/docs/RoomAudioOnlyFlagNotSupportedError.html new file mode 100644 index 000000000..cfd86aa5b --- /dev/null +++ b/dist/docs/RoomAudioOnlyFlagNotSupportedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomAudioOnlyFlagNotSupportedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomAudioOnlyFlagNotSupportedError

+
+ +
+ +

+ RoomAudioOnlyFlagNotSupportedError +

+ +

Raised whenever a participant tries to set the AudioOnly flag for a Room type other than Group Rooms.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53124

message + + +string + + + + +

'The AudioOnly flag is not supported for the Room type'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomCompletedError.html b/dist/docs/RoomCompletedError.html new file mode 100644 index 000000000..cb71c4f6e --- /dev/null +++ b/dist/docs/RoomCompletedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomCompletedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomCompletedError

+
+ +
+ +

+ RoomCompletedError +

+ +

Raised whenever a Room is completed via the REST API.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53118

message + + +string + + + + +

'Room completed'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomConnectFailedError.html b/dist/docs/RoomConnectFailedError.html new file mode 100644 index 000000000..b1c044f4c --- /dev/null +++ b/dist/docs/RoomConnectFailedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomConnectFailedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomConnectFailedError

+
+ +
+ +

+ RoomConnectFailedError +

+ +

Raised whenever a Client is unable to connect to a Room, and the scenario is not covered by a more specific error code.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53104

message + + +string + + + + +

'Unable to connect to Room'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomCreateFailedError.html b/dist/docs/RoomCreateFailedError.html new file mode 100644 index 000000000..cfab910ef --- /dev/null +++ b/dist/docs/RoomCreateFailedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomCreateFailedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomCreateFailedError

+
+ +
+ +

+ RoomCreateFailedError +

+ +

Raised whenever the Server is unable to create a Room.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53103

message + + +string + + + + +

'Unable to create Room'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomInvalidParametersError.html b/dist/docs/RoomInvalidParametersError.html new file mode 100644 index 000000000..fceb244dd --- /dev/null +++ b/dist/docs/RoomInvalidParametersError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomInvalidParametersError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomInvalidParametersError

+
+ +
+ +

+ RoomInvalidParametersError +

+ +

Raised in the REST API when one or more Room creation parameter is incompatible with the Room type.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53114

message + + +string + + + + +

'Room creation parameter(s) incompatible with the Room type'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomMaxParticipantsExceededError.html b/dist/docs/RoomMaxParticipantsExceededError.html new file mode 100644 index 000000000..198483653 --- /dev/null +++ b/dist/docs/RoomMaxParticipantsExceededError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomMaxParticipantsExceededError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomMaxParticipantsExceededError

+
+ +
+ +

+ RoomMaxParticipantsExceededError +

+ +

Raised whenever a Client is unable to connect to a Room because the Room contains too many Participants.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53105

message + + +string + + + + +

'Room contains too many Participants'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomMaxParticipantsOutOfRangeError.html b/dist/docs/RoomMaxParticipantsOutOfRangeError.html new file mode 100644 index 000000000..02098169f --- /dev/null +++ b/dist/docs/RoomMaxParticipantsOutOfRangeError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomMaxParticipantsOutOfRangeError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomMaxParticipantsOutOfRangeError

+
+ +
+ +

+ RoomMaxParticipantsOutOfRangeError +

+ +

Raised in the REST API when MaxParticipants is set out of range.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53107

message + + +string + + + + +

'MaxParticipants is out of range'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomMediaRegionInvalidError.html b/dist/docs/RoomMediaRegionInvalidError.html new file mode 100644 index 000000000..326a3dc54 --- /dev/null +++ b/dist/docs/RoomMediaRegionInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomMediaRegionInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomMediaRegionInvalidError

+
+ +
+ +

+ RoomMediaRegionInvalidError +

+ +

Raised in the REST API when MediaRegion is set to an invalid value.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53115

message + + +string + + + + +

'MediaRegion is invalid'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomMediaRegionUnavailableError.html b/dist/docs/RoomMediaRegionUnavailableError.html new file mode 100644 index 000000000..f7f902f0e --- /dev/null +++ b/dist/docs/RoomMediaRegionUnavailableError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomMediaRegionUnavailableError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomMediaRegionUnavailableError

+
+ +
+ +

+ RoomMediaRegionUnavailableError +

+ +

Raised in the REST API when MediaRegion is set to a valid value but no media servers are available.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53116

message + + +string + + + + +

'There are no media servers available in the MediaRegion'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomNameCharsInvalidError.html b/dist/docs/RoomNameCharsInvalidError.html new file mode 100644 index 000000000..d578834f1 --- /dev/null +++ b/dist/docs/RoomNameCharsInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomNameCharsInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomNameCharsInvalidError

+
+ +
+ +

+ RoomNameCharsInvalidError +

+ +

Raised whenever a Room name contains invalid characters.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53102

message + + +string + + + + +

'Room name contains invalid characters'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomNameInvalidError.html b/dist/docs/RoomNameInvalidError.html new file mode 100644 index 000000000..b7f253487 --- /dev/null +++ b/dist/docs/RoomNameInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomNameInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomNameInvalidError

+
+ +
+ +

+ RoomNameInvalidError +

+ +

Raised whenever a Room name is invalid, and the scenario is not covered by a more specific error code.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53100

message + + +string + + + + +

'Room name is invalid'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomNameTooLongError.html b/dist/docs/RoomNameTooLongError.html new file mode 100644 index 000000000..0663e4de0 --- /dev/null +++ b/dist/docs/RoomNameTooLongError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomNameTooLongError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomNameTooLongError

+
+ +
+ +

+ RoomNameTooLongError +

+ +

Raised whenever a Room name is too long.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53101

message + + +string + + + + +

'Room name is too long'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomNotFoundError.html b/dist/docs/RoomNotFoundError.html new file mode 100644 index 000000000..013b3cc01 --- /dev/null +++ b/dist/docs/RoomNotFoundError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomNotFoundError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomNotFoundError

+
+ +
+ +

+ RoomNotFoundError +

+ +

Raised whenever attempting operation on a non-existent Room.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53106

message + + +string + + + + +

'Room not found'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomRoomExistsError.html b/dist/docs/RoomRoomExistsError.html new file mode 100644 index 000000000..e9796da68 --- /dev/null +++ b/dist/docs/RoomRoomExistsError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomRoomExistsError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomRoomExistsError

+
+ +
+ +

+ RoomRoomExistsError +

+ +

Raised in the REST API when the Room creation fails because a Room exists with the same name.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53113

message + + +string + + + + +

'Room exists'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomStatusCallbackInvalidError.html b/dist/docs/RoomStatusCallbackInvalidError.html new file mode 100644 index 000000000..5d8459ed9 --- /dev/null +++ b/dist/docs/RoomStatusCallbackInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomStatusCallbackInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomStatusCallbackInvalidError

+
+ +
+ +

+ RoomStatusCallbackInvalidError +

+ +

Raised in the REST API when StatusCallback is not a valid URL or the url is too long.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53111

message + + +string + + + + +

'StatusCallback is invalid'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomStatusCallbackMethodInvalidError.html b/dist/docs/RoomStatusCallbackMethodInvalidError.html new file mode 100644 index 000000000..af9bb0c7e --- /dev/null +++ b/dist/docs/RoomStatusCallbackMethodInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomStatusCallbackMethodInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomStatusCallbackMethodInvalidError

+
+ +
+ +

+ RoomStatusCallbackMethodInvalidError +

+ +

Raised in the REST API when StatusCallbackMethod is set to an invalid value.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53110

message + + +string + + + + +

'StatusCallbackMethod is invalid'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomStatusInvalidError.html b/dist/docs/RoomStatusInvalidError.html new file mode 100644 index 000000000..d18f253bf --- /dev/null +++ b/dist/docs/RoomStatusInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomStatusInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomStatusInvalidError

+
+ +
+ +

+ RoomStatusInvalidError +

+ +

Raised in the REST API when Status is not valid or the Room is not in-progress.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53112

message + + +string + + + + +

'Status is invalid'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomSubscriptionOperationNotSupportedError.html b/dist/docs/RoomSubscriptionOperationNotSupportedError.html new file mode 100644 index 000000000..3cb3a95d4 --- /dev/null +++ b/dist/docs/RoomSubscriptionOperationNotSupportedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomSubscriptionOperationNotSupportedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomSubscriptionOperationNotSupportedError

+
+ +
+ +

+ RoomSubscriptionOperationNotSupportedError +

+ +

Raised whenever the subscription operation requested is not supported for the Room type.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53117

message + + +string + + + + +

'The subscription operation requested is not supported for the Room type'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomTimeoutOutOfRangeError.html b/dist/docs/RoomTimeoutOutOfRangeError.html new file mode 100644 index 000000000..8adc143e8 --- /dev/null +++ b/dist/docs/RoomTimeoutOutOfRangeError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomTimeoutOutOfRangeError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomTimeoutOutOfRangeError

+
+ +
+ +

+ RoomTimeoutOutOfRangeError +

+ +

Raised in the REST API when Timeout is set out of range.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53109

message + + +string + + + + +

'Timeout is out of range'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomTrackKindNotSupportedError.html b/dist/docs/RoomTrackKindNotSupportedError.html new file mode 100644 index 000000000..fb85d6bd2 --- /dev/null +++ b/dist/docs/RoomTrackKindNotSupportedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomTrackKindNotSupportedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomTrackKindNotSupportedError

+
+ +
+ +

+ RoomTrackKindNotSupportedError +

+ +

Raised whenever a participant tries to publish a track or connects with a track that is not supported by the group room.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53125

message + + +string + + + + +

'The track kind is not supported by the Room'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/RoomTypeInvalidError.html b/dist/docs/RoomTypeInvalidError.html new file mode 100644 index 000000000..6f86d1da9 --- /dev/null +++ b/dist/docs/RoomTypeInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: RoomTypeInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: RoomTypeInvalidError

+
+ +
+ +

+ RoomTypeInvalidError +

+ +

Raised in the REST API when the user attempts to create a Room with an invalid RoomType

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53108

message + + +string + + + + +

'RoomType is not valid'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/SignalingConnectionDisconnectedError.html b/dist/docs/SignalingConnectionDisconnectedError.html new file mode 100644 index 000000000..79f6713ef --- /dev/null +++ b/dist/docs/SignalingConnectionDisconnectedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: SignalingConnectionDisconnectedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: SignalingConnectionDisconnectedError

+
+ +
+ +

+ SignalingConnectionDisconnectedError +

+ +

Raised whenever the signaling connection is unexpectedly disconnected.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53001

message + + +string + + + + +

'Signaling connection disconnected'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/SignalingConnectionError.html b/dist/docs/SignalingConnectionError.html new file mode 100644 index 000000000..44c17accd --- /dev/null +++ b/dist/docs/SignalingConnectionError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: SignalingConnectionError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: SignalingConnectionError

+
+ +
+ +

+ SignalingConnectionError +

+ +

Raised whenever a signaling connection error occurs that is not covered by a more specific error code.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53000

message + + +string + + + + +

'Signaling connection error'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/SignalingConnectionTimeoutError.html b/dist/docs/SignalingConnectionTimeoutError.html new file mode 100644 index 000000000..69f360d63 --- /dev/null +++ b/dist/docs/SignalingConnectionTimeoutError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: SignalingConnectionTimeoutError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: SignalingConnectionTimeoutError

+
+ +
+ +

+ SignalingConnectionTimeoutError +

+ +

Raised when connection liveliness checks fail, or when the signaling session expires.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53002

message + + +string + + + + +

'Signaling connection timed out'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/SignalingIncomingMessageInvalidError.html b/dist/docs/SignalingIncomingMessageInvalidError.html new file mode 100644 index 000000000..8ebbcefa2 --- /dev/null +++ b/dist/docs/SignalingIncomingMessageInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: SignalingIncomingMessageInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: SignalingIncomingMessageInvalidError

+
+ +
+ +

+ SignalingIncomingMessageInvalidError +

+ +

Raised whenever the Client receives a message from the Server that the Client cannot handle.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53003

message + + +string + + + + +

'Client received an invalid signaling message'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/SignalingOutgoingMessageInvalidError.html b/dist/docs/SignalingOutgoingMessageInvalidError.html new file mode 100644 index 000000000..cd5887f50 --- /dev/null +++ b/dist/docs/SignalingOutgoingMessageInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: SignalingOutgoingMessageInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: SignalingOutgoingMessageInvalidError

+
+ +
+ +

+ SignalingOutgoingMessageInvalidError +

+ +

Raised whenever the Client sends a message to the Server that the Server cannot handle.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53004

message + + +string + + + + +

'Client sent an invalid signaling message'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/SignalingServerBusyError.html b/dist/docs/SignalingServerBusyError.html new file mode 100644 index 000000000..8db84f8b1 --- /dev/null +++ b/dist/docs/SignalingServerBusyError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: SignalingServerBusyError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: SignalingServerBusyError

+
+ +
+ +

+ SignalingServerBusyError +

+ +

Raised when the server is too busy to accept new clients.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53006

message + + +string + + + + +

'Video server is busy'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/StatsReport.html b/dist/docs/StatsReport.html new file mode 100644 index 000000000..f6d4c87a4 --- /dev/null +++ b/dist/docs/StatsReport.html @@ -0,0 +1,497 @@ + + + + + + + Documentation Class: StatsReport + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: StatsReport

+
+ +
+ +

+ StatsReport +

+ +

Statistics report for an RTCPeerConnection.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
peerConnectionId + + +string + + + + +

ID of the RTCPeerConnection

localAudioTrackStats + + +Array.<LocalAudioTrackStats> + + + + +

List of LocalAudioTrackStats

localVideoTrackStats + + +Array.<LocalVideoTrackStats> + + + + +

List of LocalVideoTrackStats

remoteAudioTrackStats + + +Array.<RemoteAudioTrackStats> + + + + +

List of RemoteAudioTrackStats

remoteVideoTrackStats + + +Array.<RemoteVideoTrackStats> + + + + +

List of RemoteVideoTrackStats

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/Track.html b/dist/docs/Track.html new file mode 100644 index 000000000..88b6c3708 --- /dev/null +++ b/dist/docs/Track.html @@ -0,0 +1,727 @@ + + + + + + + Documentation Class: Track + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: Track

+
+ +
+ +

+ Track +

+ +

A Track represents a stream of audio, video, or data.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
kind + + +Track.Kind + + + + +

The Track's kind

name + + +string + + + + +

The Track's name

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + +
    +
  • EventEmitter
    • +
+ + + + + + + + + + + + + + + + + +

Type Definitions

+ +
+ +
+
+

ID

+ + +
+
+ +
+

The Track ID is a string identifier for the Track.

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

Kind

+ + +
+
+ +
+

The Track kind is either "audio", "video", or "data".

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

Priority

+ + +
+
+ +
+

The Track's priority can be "low", "standard", or "high".

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

SID

+ + +
+
+ +
+

The Track SID is a unique string identifier for the Track +that is published to a Room.

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ +
+ + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/TrackInvalidError.html b/dist/docs/TrackInvalidError.html new file mode 100644 index 000000000..d055573b9 --- /dev/null +++ b/dist/docs/TrackInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: TrackInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: TrackInvalidError

+
+ +
+ +

+ TrackInvalidError +

+ +

Raised whenever a Track is invalid, and the scenario is not covered by a more specific error code.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53300

message + + +string + + + + +

'Track is invalid'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/TrackNameCharsInvalidError.html b/dist/docs/TrackNameCharsInvalidError.html new file mode 100644 index 000000000..5706523ee --- /dev/null +++ b/dist/docs/TrackNameCharsInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: TrackNameCharsInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: TrackNameCharsInvalidError

+
+ +
+ +

+ TrackNameCharsInvalidError +

+ +

Raised whenever a Track name contains invalid characters.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53303

message + + +string + + + + +

'Track name contains invalid characters'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/TrackNameInvalidError.html b/dist/docs/TrackNameInvalidError.html new file mode 100644 index 000000000..b8564e1b2 --- /dev/null +++ b/dist/docs/TrackNameInvalidError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: TrackNameInvalidError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: TrackNameInvalidError

+
+ +
+ +

+ TrackNameInvalidError +

+ +

Raised whenever a Track name is invalid, and the scenario is not covered by a more specific error code.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53301

message + + +string + + + + +

'Track name is invalid'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/TrackNameIsDuplicatedError.html b/dist/docs/TrackNameIsDuplicatedError.html new file mode 100644 index 000000000..d28dc92b3 --- /dev/null +++ b/dist/docs/TrackNameIsDuplicatedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: TrackNameIsDuplicatedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: TrackNameIsDuplicatedError

+
+ +
+ +

+ TrackNameIsDuplicatedError +

+ +

Raised whenever a Participant is currently publishing a Track with the same name.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53304

message + + +string + + + + +

'Track name is duplicated'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/TrackNameTooLongError.html b/dist/docs/TrackNameTooLongError.html new file mode 100644 index 000000000..7a51d15fa --- /dev/null +++ b/dist/docs/TrackNameTooLongError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: TrackNameTooLongError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: TrackNameTooLongError

+
+ +
+ +

+ TrackNameTooLongError +

+ +

Raised whenever a Track name is too long.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53302

message + + +string + + + + +

'Track name is too long'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/TrackPublication.html b/dist/docs/TrackPublication.html new file mode 100644 index 000000000..f7772e232 --- /dev/null +++ b/dist/docs/TrackPublication.html @@ -0,0 +1,595 @@ + + + + + + + Documentation Class: TrackPublication + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: TrackPublication

+
+ +
+ +

+ TrackPublication +

+ +

A TrackPublication represents a Track that +has been published to a Room.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
trackName + + +string + + + + +

the published Track's name

trackSid + + +Track.SID + + + + +

SID assigned to the published Track

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +

Events

+ +
+ +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/TrackServerTrackCapacityReachedError.html b/dist/docs/TrackServerTrackCapacityReachedError.html new file mode 100644 index 000000000..55fcbd58a --- /dev/null +++ b/dist/docs/TrackServerTrackCapacityReachedError.html @@ -0,0 +1,541 @@ + + + + + + + Documentation Class: TrackServerTrackCapacityReachedError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: TrackServerTrackCapacityReachedError

+
+ +
+ +

+ TrackServerTrackCapacityReachedError +

+ +

The server does not have enough resources available to create a new Track.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

53305

message + + +string + + + + +

'The server has reached capacity and cannot fulfill this request'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/TrackStats.html b/dist/docs/TrackStats.html new file mode 100644 index 000000000..76b81ede6 --- /dev/null +++ b/dist/docs/TrackStats.html @@ -0,0 +1,567 @@ + + + + + + + Documentation Class: TrackStats + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: TrackStats

+
+ +
+ +

+ TrackStats +

+ +

Statistics for a Track.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
trackId + + +Track.ID + + + + + + + + +

The Track ID

trackSid + + +Track.SID + + + + + + + + +

The Track's SID when published in +in a Room

timestamp + + +number + + + + + + + + +

A Unix timestamp in milliseconds indicating +when the TrackStats were gathered

ssrc + + +string + + + + + + + + +

The Track's SSRC when transmitted over the +RTCPeerConnection

packetsLost + + +number + + + + + + + + + <nullable>
+ +

The number of packets lost

codec + + +string + + + + + + + + + <nullable>
+ +

The name of the codec used to encode the +Track's media

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/TwilioError.html b/dist/docs/TwilioError.html new file mode 100644 index 000000000..519c86f33 --- /dev/null +++ b/dist/docs/TwilioError.html @@ -0,0 +1,514 @@ + + + + + + + Documentation Class: TwilioError + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: TwilioError

+
+ +
+ +

+ TwilioError +

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
code + + +number + + + + +

Error code

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + +
    +
  • Error
    • +
+ + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

toString()

+ + +
+
+ + +
+

Returns human readable string describing the error.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +string + + + +
+
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/VideoTrack.html b/dist/docs/VideoTrack.html new file mode 100644 index 000000000..de8c8b36f --- /dev/null +++ b/dist/docs/VideoTrack.html @@ -0,0 +1,2591 @@ + + + + + + + Documentation Class: VideoTrack + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Class: VideoTrack

+
+ +
+ +

+ VideoTrack +

+ +

A VideoTrack is a Track representing video.

+ + +
+ + +
+
+ + +
+
+ + + +
+
+ + + + + + + + + + + + + + + + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
isStarted + + +boolean + + + + + + + + +

Whether or not the VideoTrack has +started; if the VideoTrack started, there is enough video data to +begin playback

isEnabled + + +boolean + + + + + + + + +

Whether or not the VideoTrack is +enabled; if the VideoTrack is not enabled, it is "paused"

dimensions + + +VideoTrack.Dimensions + + + + + + + + +

The VideoTrack's +VideoTrack.Dimensions

kind + + +Track.Kind + + + + + + + + +

"video"

mediaStreamTrack + + +MediaStreamTrack + + + + + + + + +

A video MediaStreamTrack

processedTrack + + +MediaStreamTrack + + + + + + + + + <nullable>
+ +

The source of processed video frames. +It is null if no VideoProcessor has been added.

processor + + +VideoProcessor + + + + + + + + + <nullable>
+ +

A VideoProcessor that is currently +processing video frames. It is null if video frames are not being processed.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
Fires:
+ + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

addProcessor(processor [, options])

+ + +
+
+ + +
+

Add a VideoProcessor to allow for custom processing of video frames belonging to a VideoTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
processor + + +VideoProcessor + + + + + + + + + + +

The VideoProcessor to use.

options + + +AddProcessorOptions + + + + + + + <optional>
+ + + + + +

AddProcessorOptions to provide.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
Example
+ + 
class GrayScaleProcessor {
+  constructor(percentage) {
+    this.percentage = percentage;
+  }
+  processFrame(inputFrameBuffer, outputFrameBuffer) {
+    const context = outputFrameBuffer.getContext('2d');
+    context.filter = `grayscale(${this.percentage}%)`;
+    context.drawImage(inputFrameBuffer, 0, 0, inputFrameBuffer.width, inputFrameBuffer.height);
+  }
+}
+
+Video.createLocalVideoTrack().then(function(videoTrack) {
+  videoTrack.addProcessor(new GrayScaleProcessor(100));
+});
+ + + +
+ + + +
+
+

attach()

+ + +
+
+ + +
+

Create an HTMLVideoElement and attach the VideoTrack to it.

+

The HTMLVideoElement's srcObject will be set to a new +MediaStream containing the VideoTrack's MediaStreamTrack.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

videoElement

+
+ + + +
+
+ Type +
+
+ +HTMLVideoElement + + + +
+
+ + + + + +
Example
+ + 
const Video = require('twilio-video');
+
+Video.createLocalVideoTrack().then(function(videoTrack) {
+  const videoElement = videoTrack.attach();
+  document.body.appendChild(videoElement);
+});
+
+ + + +
+ + + +
+
+

attach(mediaElement)

+ + +
+
+ + +
+

Attach the VideoTrack to an existing HTMLMediaElement. The +HTMLMediaElement could be an HTMLAudioElement or an HTMLVideoElement.

+

If the HTMLMediaElement's srcObject is not set to a MediaStream, +this method sets it to a new MediaStream containing the VideoTrack's +MediaStreamTrack; otherwise, it adds the MediaTrack's +MediaStreamTrack to the existing MediaStream. Finally, if there are any other +MediaStreamTracks of the same kind on the MediaStream, this method removes +them.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
mediaElement + + +HTMLMediaElement + + + + +

The HTMLMediaElement to attach to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

mediaElement

+
+ + + +
+
+ Type +
+
+ +HTMLMediaElement + + + +
+
+ + + + + +
Example
+ + 
const Video = require('twilio-video');
+
+const videoElement = document.createElement('video');
+document.body.appendChild(videoElement);
+
+Video.createLocalVideoTrack().then(function(videoTrack) {
+  videoTrack.attach(videoElement);
+});
+
+ + + +
+ + + +
+
+

attach(selector)

+ + +
+
+ + +
+

Attach the VideoTrack to an HTMLMediaElement selected by +document.querySelector. The HTMLMediaElement could be an +HTMLAudioElement or an HTMLVideoElement.

+

If the HTMLMediaElement's srcObject is not set to a MediaStream, +this method sets it to a new MediaStream containing the VideoTrack's +MediaStreamTrack; otherwise, it adds the VideoTrack's +MediaStreamTrack to the existing MediaStream. Finally, if there are any other +MediaStreamTracks of the same kind on the MediaStream, this method removes +them.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
selector + + +string + + + + +

A query selector for the HTMLMediaElement to +attach to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

mediaElement

+
+ + + +
+
+ Type +
+
+ +HTMLMediaElement + + + +
+
+ + + + + +
Example
+ + 
const Video = require('twilio-video');
+
+const videoElement = document.createElement('video');
+videoElement.id = 'my-video-element';
+document.body.appendChild(videoElement);
+
+Video.createLocalVideoTrack().then(function(track) {
+  track.attach('#my-video-element');
+});
+ + + +
+ + + +
+
+

detach()

+ + +
+
+ + +
+

Detach the VideoTrack from all previously attached HTMLMediaElements.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

mediaElements

+
+ + + +
+
+ Type +
+
+ +Array.<HTMLMediaElement> + + + +
+
+ + + + + +
Example
+ + 
const mediaElements = videoTrack.detach();
+mediaElements.forEach(mediaElement => mediaElement.remove());
+
+ + + +
+ + + +
+
+

detach(mediaElement)

+ + +
+
+ + +
+

Detach the VideoTrack from a previously attached HTMLMediaElement.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
mediaElement + + +HTMLMediaElement + + + + +

One of the HTMLMediaElements to +which the VideoTrack is attached

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

mediaElement

+
+ + + +
+
+ Type +
+
+ +HTMLMediaElement + + + +
+
+ + + + + +
Example
+ + 
const videoElement = document.getElementById('my-video-element');
+videoTrack.detach(videoElement).remove();
+
+ + + +
+ + + +
+
+

detach(selector)

+ + +
+
+ + +
+

Detach the VideoTrack from a previously attached HTMLMediaElement +specified by document.querySelector.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
selector + + +string + + + + +

The query selector of HTMLMediaElement to which +the VideoTrack is attached

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

mediaElement

+
+ + + +
+
+ Type +
+
+ +HTMLMediaElement + + + +
+
+ + + + + +
Example
+ + 
videoTrack.detach('#my-video-element').remove();
+ + + +
+ + + +
+
+

removeProcessor(processor)

+ + +
+
+ + +
+

Remove the previously added VideoProcessor using addProcessor API.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
processor + + +VideoProcessor + + + + +

The VideoProcessor to remove.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +this + + + +
+
+ + + + + +
Example
+ + 
class GrayScaleProcessor {
+  constructor(percentage) {
+    this.percentage = percentage;
+  }
+  processFrame(inputFrameBuffer, outputFrameBuffer) {
+    const context = outputFrameBuffer.getContext('2d');
+    context.filter = `grayscale(${this.percentage}%)`;
+    context.drawImage(inputFrameBuffer, 0, 0, inputFrameBuffer.width, inputFrameBuffer.height);
+  }
+}
+
+Video.createLocalVideoTrack().then(function(videoTrack) {
+  const grayScaleProcessor = new GrayScaleProcessor(100);
+  videoTrack.addProcessor(grayScaleProcessor);
+  document.getElementById('remove-button').onclick = () => videoTrack.removeProcessor(grayScaleProcessor);
+});
+ + + +
+ +
+ + + +

Type Definitions

+ +
+ +
+
+

Dimensions

+ + +
+
+ +
+

A VideoTrack's width and height.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
width + + +number + + + + + + + + + <nullable>
+ +

The VideoTrack's width or null if the +VideoTrack has not yet started

height + + +number + + + + + + + + + <nullable>
+ +

The VideoTrack's height or null if the +VideoTrack has not yet started

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ +
+ + + +

Events

+ +
+ +
+
+

dimensionsChanged

+ + +
+
+ + +
+

The VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The VideoTrack was disabled, i.e. "paused".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack that was disabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The VideoTrack was enabled, i.e. "unpaused".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack that was enabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The VideoTrack started. This means there is enough video data to +begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack that started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/classes.list.html b/dist/docs/classes.list.html new file mode 100644 index 000000000..3f009a63c --- /dev/null +++ b/dist/docs/classes.list.html @@ -0,0 +1,18511 @@ + + + + + + + Documentation Classes + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Classes

+
+ +
+ +

+ +

+ + +
+ + +
+
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +

Classes

+ +
+
AccessTokenExpiredError
+
+ +
AccessTokenGrantsInvalidError
+
+ +
AccessTokenHeaderInvalidError
+
+ +
AccessTokenInvalidError
+
+ +
AccessTokenIssuerInvalidError
+
+ +
AccessTokenNotYetValidError
+
+ +
AccessTokenSignatureInvalidError
+
+ +
AudioTrack
+
+ +
ConfigurationAcquireFailedError
+
+ +
ConfigurationAcquireTurnFailedError
+
+ +
LocalAudioTrack
+
+ +
LocalAudioTrackPublication
+
+ +
LocalAudioTrackStats
+
+ +
LocalDataTrack
+
+ +
LocalDataTrackPublication
+
+ +
LocalParticipant
+
+ +
LocalTrackPublication
+
+ +
LocalTrackStats
+
+ +
LocalVideoTrack
+
+ +
LocalVideoTrackPublication
+
+ +
LocalVideoTrackStats
+
+ +
MediaClientLocalDescFailedError
+
+ +
MediaClientRemoteDescFailedError
+
+ +
MediaConnectionError
+
+ +
MediaDTLSTransportFailedError
+
+ +
MediaNoSupportedCodecError
+
+ +
MediaServerLocalDescFailedError
+
+ +
MediaServerRemoteDescFailedError
+
+ +
NetworkQualityAudioStats
+
+ +
NetworkQualityBandwidthStats
+
+ +
NetworkQualityFractionLostStats
+
+ +
NetworkQualityLatencyStats
+
+ +
NetworkQualityMediaStats
+
+ +
NetworkQualityRecvStats
+
+ +
NetworkQualitySendOrRecvStats
+
+ +
NetworkQualitySendStats
+
+ +
NetworkQualityStats
+
+ +
NetworkQualityVideoStats
+
+ +
Participant
+
+ +
ParticipantDuplicateIdentityError
+
+ +
ParticipantIdentityCharsInvalidError
+
+ +
ParticipantIdentityInvalidError
+
+ +
ParticipantIdentityTooLongError
+
+ +
ParticipantMaxTracksExceededError
+
+ +
ParticipantNotFoundError
+
+ +
PreflightTest
+
+ +
RemoteAudioTrack
+
+ +
RemoteAudioTrackPublication
+
+ +
RemoteAudioTrackStats
+
+ +
RemoteDataTrack
+
+ +
RemoteDataTrackPublication
+
+ +
RemoteParticipant
+
+ +
RemoteTrackPublication
+
+ +
RemoteTrackStats
+
+ +
RemoteVideoTrack
+
+ +
RemoteVideoTrackPublication
+
+ +
RemoteVideoTrackStats
+
+ +
Room
+
+ +
RoomAudioOnlyFlagNotSupportedError
+
+ +
RoomCompletedError
+
+ +
RoomConnectFailedError
+
+ +
RoomCreateFailedError
+
+ +
RoomInvalidParametersError
+
+ +
RoomMaxParticipantsExceededError
+
+ +
RoomMaxParticipantsOutOfRangeError
+
+ +
RoomMediaRegionInvalidError
+
+ +
RoomMediaRegionUnavailableError
+
+ +
RoomNameCharsInvalidError
+
+ +
RoomNameInvalidError
+
+ +
RoomNameTooLongError
+
+ +
RoomNotFoundError
+
+ +
RoomRoomExistsError
+
+ +
RoomStatusCallbackInvalidError
+
+ +
RoomStatusCallbackMethodInvalidError
+
+ +
RoomStatusInvalidError
+
+ +
RoomSubscriptionOperationNotSupportedError
+
+ +
RoomTimeoutOutOfRangeError
+
+ +
RoomTrackKindNotSupportedError
+
+ +
RoomTypeInvalidError
+
+ +
SignalingConnectionDisconnectedError
+
+ +
SignalingConnectionError
+
+ +
SignalingConnectionTimeoutError
+
+ +
SignalingIncomingMessageInvalidError
+
+ +
SignalingOutgoingMessageInvalidError
+
+ +
SignalingServerBusyError
+
+ +
StatsReport
+
+ +
Track
+
+ +
TrackInvalidError
+
+ +
TrackNameCharsInvalidError
+
+ +
TrackNameInvalidError
+
+ +
TrackNameIsDuplicatedError
+
+ +
TrackNameTooLongError
+
+ +
TrackPublication
+
+ +
TrackServerTrackCapacityReachedError
+
+ +
TrackStats
+
+ +
TwilioError
+
+ +
VideoTrack
+
+
+ + + + + + + + + + + + + +

Events

+ +
+ +
+
+

disabled

+ + +
+
+ + +
+

The AudioTrack was disabled, i.e. "muted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +AudioTrack + + + + +

The AudioTrack that was disabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The AudioTrack was enabled, i.e. "unmuted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +AudioTrack + + + + +

The AudioTrack that was enabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The AudioTrack started. This means there is enough audio data to +begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +AudioTrack + + + + +

The AudioTrack that started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

event

+ + +
+
+ + +
+

The SDK raised an EventListenerEvent.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
event + + +EventListenerEvent + + + + +

Context about the event raised by the SDK. +This can be one of the following:

+
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The LocalAudioTrack was disabled, i.e. the audio source was muted by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The LocalAudioTrack was enabled, i.e. the audio source was unmuted by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

muted

+ + +
+
+ + +
+

The LocalAudioTrack was muted because the audio source stopped sending samples, most +likely due to another application taking said audio source, especially on mobile devices.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was muted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The LocalAudioTrack started. This means there is enough audio data to +begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

stopped

+ + +
+
+ + +
+

The LocalAudioTrack stopped, either because LocalAudioTrack#stop +or LocalAudioTrack#restart was called or because the underlying +MediaStreamTrack ended.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that stopped

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unmuted

+ + +
+
+ + +
+

The LocalAudioTrack was unmuted because the audio source resumed sending samples, +most likely due to the application that took over the said audio source has released it +back to the application, especially on mobile devices. This event is also fired when +LocalAudioTrack#restart is called on a muted LocalAudioTrack with a +new audio source.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was unmuted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disconnected

+ + +
+
+ + +
+

The Participant has disconnected.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +Participant + + + + +

The Participant that disconnected.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

networkQualityLevelChanged

+ + +
+
+ + +
+

The Participant's NetworkQualityLevel changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
networkQualityLevel + + +NetworkQualityLevel + + + + + + + + + + +

The new +NetworkQualityLevel

networkQualityStats + + +NetworkQualityStats + + + + + + + + + <nullable>
+ + + +

The NetworkQualityStats +based on which NetworkQualityLevel is calculated, if any

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

The LocalParticipant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

The LocalParticipant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the LocalParticipant's LocalVideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

A LocalTrack was disabled by the LocalParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that was disabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

A LocalTrack was enabled by the LocalParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that was enabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublicationFailed

+ + +
+
+ + +
+

A LocalTrack failed to publish. Check the error message for more +information. In a Large Group Room (Maximum Participants greater than 50), +this event is raised with a ParticipantMaxTracksExceededError either +when attempting to publish the LocalTrack will exceed the Maximum Published +Tracks limit of 16, or the LocalTrack is part of a set of LocalTracks +which along with the published Tracks exceeds 16.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

A TwilioError explaining why publication +failed

localTrack + + +LocalTrack + + + + +

The LocalTrack that failed to +publish

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublished

+ + +
+
+ + +
+

A LocalTrack was successfully published.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +LocalTrackPublication + + + + +

The resulting +LocalTrackPublication for the published LocalTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTracks started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStopped

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTracks stopped, either +because LocalTrack#stop was called or because the underlying +MediaStreamTrack ended).

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that stopped

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackWarning

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that encountered the warning.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackWarningsCleared

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that cleared all warnings.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

dimensionsChanged

+ + +
+
+ + +
+

The VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack whose dimensions changed

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The LocalVideoTrack was disabled, i.e. the video source was paused by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The LocalVideoTrack was enabled, i.e. the video source was unpaused by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

muted

+ + +
+
+ + +
+

The LocalVideoTrack was muted because the video source stopped sending frames, most +likely due to another application taking said video source, especially on mobile devices.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was muted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The LocalVideoTrack started. This means there is enough video data +to begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

stopped

+ + +
+
+ + +
+

The LocalVideoTrack stopped, either because LocalVideoTrack#stop +or LocalVideoTrack#restart was called or because the underlying +MediaStreamTrack ended.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that stopped

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unmuted

+ + +
+
+ + +
+

The LocalVideoTrack was unmuted because the video source resumed sending frames, +most likely due to the application that took over the said video source has released it +back to the application, especially on mobile devices. This event is also fired when +LocalVideoTrack#restart is called on a muted LocalVideoTrack with a +new video source.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was unmuted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disconnected

+ + +
+
+ + +
+

The Participant has disconnected.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +Participant + + + + +

The Participant that disconnected.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

networkQualityLevelChanged

+ + +
+
+ + +
+

The Participant's NetworkQualityLevel changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
networkQualityLevel + + +NetworkQualityLevel + + + + + + + + + + +

The new +NetworkQualityLevel

networkQualityStats + + +NetworkQualityStats + + + + + + + + + <nullable>
+ + + +

The NetworkQualityStats +based on which NetworkQualityLevel is calculated, if any

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

The Participant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

The Participant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the Participant's VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of the Participant's Tracks started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +Track + + + + +

The Track that started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

completed

+ + +
+
+ + +
+

Preflight test has completed successfully.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
report + + +PreflightTestReport + + + + +

Results of the test.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

failed

+ + +
+
+ + +
+

Preflight test has encountered a failure and is now stopped.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError +| + +Error + + + + +

A TwilioError or a DOMException. +Possible TwilioErrors include Signaling and Media related errors which can be found +here.

report + + +PreflightTestReport + + + + +

Partial results gathered during the test. Use this information to help determine the cause of failure.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

progress

+ + +
+
+ + +
+

Emitted to indicate progress of the test

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
progress + + +PreflightProgress + + + + +

Indicates the status completed.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The RemoteAudioTrack was disabled, i.e. "muted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The RemoteAudioTrack was enabled, i.e. "unmuted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The RemoteAudioTrack started. This means there is enough audio data +to begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOff

+ + +
+
+ + +
+

A RemoteAudioTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOn

+ + +
+
+ + +
+

A RemoteAudioTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteAudioTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

the RemoteAudioTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteAudioTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteAudioTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The RemoteAudioTrack was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The RemoteAudioTrack was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteAudioTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

the RemoteAudioTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

message

+ + +
+
+ + +
+

A message was received over the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +string +| + +ArrayBuffer + + + + +
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack that received +the message

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOff

+ + +
+
+ + +
+

A RemoteDataTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack that was +switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOn

+ + +
+
+ + +
+

A RemoteDataTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack that was +switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

the RemoteDataTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteDataTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

the RemoteDataTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disconnected

+ + +
+
+ + +
+

The Participant has disconnected.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +Participant + + + + +

The Participant that disconnected.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

networkQualityLevelChanged

+ + +
+
+ + +
+

The Participant's NetworkQualityLevel changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
networkQualityLevel + + +NetworkQualityLevel + + + + + + + + + + +

The new +NetworkQualityLevel

networkQualityStats + + +NetworkQualityStats + + + + + + + + + <nullable>
+ + + +

The NetworkQualityStats +based on which NetworkQualityLevel is calculated, if any

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

The RemoteParticipant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

The RemoteParticipant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the RemoteParticipant's RemoteVideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

A RemoteTrack was disabled by the RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication associated with the disabled RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

A RemoteTrack was enabled by the RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication associated with the enabled RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackMessage

+ + +
+
+ + +
+

A message was received over one of the RemoteParticipant's +RemoteDataTracks.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +string +| + +ArrayBuffer + + + + +
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack over which the +message was received

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublished

+ + +
+
+ + +
+

A RemoteTrack was published by the RemoteParticipant after +connecting to the Room. This event is not emitted for +RemoteTracks that were published while the RemoteParticipant +was connecting to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the published RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
function trackPublished(publication) {
+  console.log(`Track ${publication.trackSid} was published`);
+}
+
+room.on('participantConnected', participant => {
+  // Handle RemoteTracks published while connecting to the Room.
+  participant.trackPublications.forEach(trackPublished);
+
+  // Handle RemoteTracks published after connecting to the Room.
+  participant.on('trackPublished', trackPublished);
+});
+ + + +
+ + + +
+
+

trackPublishPriorityChanged

+ + +
+
+ + +
+

The RemoteTrackPublication's publish Track.Priority was changed by the +RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the RemoteTrack's new publish +Track.Priority;

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that changed priority

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of the RemoteParticipant's RemoteTracks started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was subscribed to

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSubscriptionFailed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack could not be subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

The reason the RemoteTrack could not be +subscribed to

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that could not +be subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOff

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched off

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOn

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched on.

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnpublished

+ + +
+
+ + +
+

A RemoteTrack was unpublished by the RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the unpublished RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnsubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was unsubscribed from.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was unsubscribed from

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

publishPriorityChanged

+ + +
+
+ + +
+

The RemoteTrack's publish Track.Priority was changed by the +RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the RemoteTrack's new publish +Track.Priority; RemoteTrackPublication#publishPriority is also +updated accordingly

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The RemoteTrack was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The RemoteTrack was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOff

+ + +
+
+ + +
+

The RemoteTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOn

+ + +
+
+ + +
+

The RemoteTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

dimensionsChanged

+ + +
+
+ + +
+

The RemoteVideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack whose +dimensions changed

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The RemoteVideoTrack was disabled, i.e. "paused".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The RemoteVideoTrack was enabled, i.e. "resumed".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The RemoteVideoTrack started. This means there is enough video data +to begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOff

+ + +
+
+ + +
+

A RemoteVideoTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOn

+ + +
+
+ + +
+

A RemoteVideoTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteVideoTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

the RemoteVideoTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteVideoTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteVideoTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The RemoteVideoTrack was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The RemoteVideoTrack was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteVideoTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

the RemoteVideoTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disconnected

+ + +
+
+ + +
+

Your LocalParticipant was disconnected from the Room and all +other RemoteParticipants.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
room + + +Room + + + + + + + + + + +

The Room your +LocalParticipant was disconnected from

error + + +TwilioError + + + + + + + + + <nullable>
+ + + +

Present when the LocalParticipant got +disconnected from the Room unexpectedly

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('disconnected', function(room, error) {
+  if (error) {
+    console.log('Unexpectedly disconnected:', error);
+  }
+  myRoom.localParticipant.tracks.forEach(function(track) {
+    track.stop();
+    track.detach();
+  });
+});
+ + + +
+ + + +
+
+

dominantSpeakerChanged

+ + +
+
+ + +
+

The Dominant Speaker in the Room changed. Either the Dominant Speaker +is a new RemoteParticipant or the Dominant Speaker has been reset and +is now null.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
dominantSpeaker + + +RemoteParticipant + + + + + + + + + <nullable>
+ + + +

The Dominant Speaker in the +Room, if any

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

participantConnected

+ + +
+
+ + +
+

A RemoteParticipant joined the Room. In Large Group Rooms (Maximum +Participants greater than 50), this event is raised only when a RemoteParticipant +publishes at least one LocalTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant who joined

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantConnected', function(participant) {
+  console.log(participant.identity + ' joined the Room');
+});
+ + + +
+ + + +
+
+

participantDisconnected

+ + +
+
+ + +
+

A RemoteParticipant left the Room. In Large Group Rooms (Maximum +Participants greater than 50), this event is raised only when a RemoteParticipant +unpublishes all its LocalTracks.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant who left

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantDisconnected', function(participant) {
+  console.log(participant.identity + ' left the Room');
+  participant.tracks.forEach(function(track) {
+    track.detach().forEach(function(mediaElement) {
+      mediaElement.remove();
+    });
+  });
+});
+ + + +
+ + + +
+
+

participantReconnected

+ + +
+
+ + +
+

A RemoteParticipant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant that has reconnected.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantReconnected', participant => {
+  console.log(participant.identity + ' reconnected to the Room');
+});
+ + + +
+ + + +
+
+

participantReconnecting

+ + +
+
+ + +
+

A RemoteParticipant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant that is reconnecting.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantReconnecting', participant => {
+  console.log(participant.identity + ' is reconnecting to the Room');
+});
+ + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

Your application successfully reconnected to the Room. When this +event is emitted, the Room is in state "connected".

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('reconnected', () => {
+  console.log('Reconnected!');
+});
+ + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

Your application is reconnecting to the Room. This happens when there +is a disruption in your signaling connection and/or your media connection. When +this event is emitted, the Room is in state "reconnecting". If reconnecting +succeeds, the Room will emit a "reconnected" event.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +MediaConnectionError +| + +SignalingConnectionDisconnectedError + + + + +

A +MediaConnectionError if your application is reconnecting due to a +disruption in your media connection, or a SignalingConnectionDisconnectedError +if your application is reconnecting due to a disruption in your signaling connection

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('reconnecting', error => {
+  if (error.code === 53001) {
+    console.log('Reconnecting your signaling connection!', error.message);
+  } else if (error.code === 53405) {
+    console.log('Reconnecting your media connection!', error.message);
+  }
+});
+ + + +
+ + + +
+
+

recordingStarted

+ + +
+
+ + +
+

The Room is now being recorded

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

recordingStopped

+ + +
+
+ + +
+

The Room is no longer being recorded

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the RemoteParticipant's VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack whose dimensions changed

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteVideoTrack's dimensions changed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

A RemoteTrack was disabled by a RemoteParticipant in the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication that represents disabled RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +disabled the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

A RemoteTrack was enabled by a RemoteParticipant in the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication that represents enabled RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +enabled the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackMessage

+ + +
+
+ + +
+

A message was received over one of the RemoteParticipant's +RemoteDataTrack's.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +string +| + +ArrayBuffer + + + + +
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack over which the +message was received

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteDataTrack received the message

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublished

+ + +
+
+ + +
+

A RemoteTrack was published by a RemoteParticipant after +connecting to the Room. This event is not emitted for +RemoteTracks that were published while the RemoteParticipant +was connecting to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the published RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +published the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
function trackPublished(publication, participant) {
+  console.log(`RemoteParticipant ${participant.sid} published Track ${publication.trackSid}`);
+}
+
+// Handle RemoteTracks published after connecting to the Room.
+room.on('trackPublished', trackPublished);
+
+room.on('participantConnected', participant => {
+  // Handle RemoteTracks published while connecting to the Room.
+  participant.trackPublications.forEach(publication => trackPublished(publication, participant));
+});
+ + + +
+ + + +
+
+

trackPublishPriorityChanged

+ + +
+
+ + +
+

The RemoteTrack's publish Track.Priority was changed by the +RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the RemoteTrack's new publish +Track.Priority;

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that changed priority

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack changed priority

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of a RemoteParticipant's RemoteTracks in the Room started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that started

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was subscribed

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was subscribed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
room.on('trackSubscribed', function(track, publication, participant) {
+  var participantView = document.getElementById('participant-view-' + participant.identity);
+  participantView.appendChild(track.attach());
+});
+ + + +
+ + + +
+
+

trackSubscriptionFailed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack could not be subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

The reason the RemoteTrack could not be +subscribed to

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that could not +be subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack could not be subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOff

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched off

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOn

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched on

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnpublished

+ + +
+
+ + +
+

A RemoteTrack was unpublished by a RemoteParticipant to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the unpublished RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +unpublished the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnsubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was unsubscribed from.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was unsubscribed

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was unsubscribed from

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was unsubscribed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
room.on('trackUnsubscribed', function(track, publication, participant) {
+  track.detach().forEach(function(mediaElement) {
+    mediaElement.remove();
+  });
+});
+ + + +
+ + + +
+
+

trackWarning

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications in the Room encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that encountered the warning.

participant + + +LocalParticipant + + + + +

The LocalParticipant

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
room.on('trackWarning', (name, publication, participant) => {
+  if (name === 'recording-media-lost') {
+    log(`LocalTrack ${publication.track.name} is not recording media.`,
+      name, publication, participant);
+
+    // Wait a reasonable amount of time to clear the warning.
+    const timer = setTimeout(() => {
+      // If the warning is not cleared, you can manually
+      // reconnect to the room, or show a dialog to the user
+    }, 5000);
+
+    room.once('trackWarningsCleared', (publication, participant) => {
+      log('LocalTrack warnings have cleared!',
+        publication, participant);
+      clearTimeout(timer);
+    });
+  }
+});
+ + + +
+ + + +
+
+

trackWarningsCleared

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications in the Room cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that cleared all warnings.

participant + + +LocalParticipant + + + + +

The LocalParticipant

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

dimensionsChanged

+ + +
+
+ + +
+

The VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The VideoTrack was disabled, i.e. "paused".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack that was disabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The VideoTrack was enabled, i.e. "unpaused".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack that was enabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The VideoTrack started. This means there is enough video data to +begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack that started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/fonts/glyphicons-halflings-regular.eot b/dist/docs/fonts/glyphicons-halflings-regular.eot new file mode 100644 index 000000000..b93a4953f Binary files /dev/null and b/dist/docs/fonts/glyphicons-halflings-regular.eot differ diff --git a/dist/docs/fonts/glyphicons-halflings-regular.svg b/dist/docs/fonts/glyphicons-halflings-regular.svg new file mode 100644 index 000000000..94fb5490a --- /dev/null +++ b/dist/docs/fonts/glyphicons-halflings-regular.svg @@ -0,0 +1,288 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/fonts/glyphicons-halflings-regular.ttf b/dist/docs/fonts/glyphicons-halflings-regular.ttf new file mode 100644 index 000000000..1413fc609 Binary files /dev/null and b/dist/docs/fonts/glyphicons-halflings-regular.ttf differ diff --git a/dist/docs/fonts/glyphicons-halflings-regular.woff b/dist/docs/fonts/glyphicons-halflings-regular.woff new file mode 100644 index 000000000..9e612858f Binary files /dev/null and b/dist/docs/fonts/glyphicons-halflings-regular.woff differ diff --git a/dist/docs/fonts/glyphicons-halflings-regular.woff2 b/dist/docs/fonts/glyphicons-halflings-regular.woff2 new file mode 100644 index 000000000..64539b54c Binary files /dev/null and b/dist/docs/fonts/glyphicons-halflings-regular.woff2 differ diff --git a/dist/docs/global.html b/dist/docs/global.html new file mode 100644 index 000000000..1f9ba5996 --- /dev/null +++ b/dist/docs/global.html @@ -0,0 +1,11621 @@ + + + + + + + Documentation Global + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Global

+
+ +
+ +

+ +

+ + +
+ + +
+
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + +

Members

+ +
+ +
+
+

<constant> AudioCodec :string

+ + +
+
+ +
+

Names of the supported audio codecs.

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
isac + + +string + + + + + + + isac + +
opus + + +string + + + + + + + opus + +
PCMA + + +string + + + + + + + PCMA + +
PCMU + + +string + + + + + + + PCMU + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

<constant> BandwidthProfileMode :string

+ + +
+
+ +
+

BandwidthProfileMode specifies how RemoteVideoTracks' Track.Priority values +are mapped to bandwidth allocation in Group Rooms.

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
grid + + +string + + + + + + + grid + +

This mode is for use cases where all the subscribed RemoteVideoTracks are +equally important. The bandwidth allocation algorithm will share the available +downlink bandwidth equally among the subscribed RemoteVideoTracks, irrespective +of their Track.Priority. In case of insufficient downlink bandwidth, the lower +priority RemoteVideoTracks are switched off.

collaboration + + +string + + + + + + + collaboration + +

This mode is for use cases where some RemoteVideoTracks are prioritized more than +others. However, the lower priority RemoteVideoTracks still need to be visible. +The bandwidth allocation algorithm will share the available downlink bandwidth proportional +to the requested VideoRenderDimensions corresponding to their Track.Priority. +In case of insufficient downlink bandwidth, the quality of higher priority RemoteVideoTracks +may be degraded to avoid switching off lower priority RemoteVideoTracks.

presentation + + +string + + + + + + + presentation + +

This mode is for use cases where some RemoteVideoTracks are deemed critical and must +be preserved at any cost over the other RemoteVideoTracks. The bandwidth allocation +algorithm will allocate as big a share of the available downlink bandwidth as it possibly +can to the higher priority RemoteVideoTracks, and only then consider the lower priority +RemoteVideoTracks. In case of insufficient downlink bandwidth, the lower priority +RemoteVideoTracks are switched off in order to preserve the quality of the higher +priority RemoteVideoTracks.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

<constant> ClientTrackSwitchOffControl :string

+ + +
+
+ +
+

ClientTrackSwitchOffControl specifies how RemoteVideoTracks' turned on and off

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
auto + + +string + + + + + + + auto + +

when set to auto, SDK uses the visibility of the video elements attached to the to the RemoteVideoTrack to decide. +on turning tracks on or off. The track that are not attached to any video elements or not visible on the screen will be turned +off automatically.

manual + + +string + + + + + + + manual + +

When set to manual, application can use RemoteVideoTracks switchOff and switchOn apis to control turn the track on or off.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

<constant> EventListenerGroup :string

+ + +
+
+ +
+

Names of the supported groups for EventListenerEvents.

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
signaling + + +string + + + + + + + signaling + +

Events associated with the connection to Twilio's signaling server

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

<constant> EventListenerLevel :string

+ + +
+
+ +
+

Names of the supported levels for EventListenerEvents.

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
debug + + +string + + + + + + + debug + +
error + + +string + + + + + + + error + +
info + + +string + + + + + + + info + +
warning + + +string + + + + + + + warning + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

<constant> LogLevel :string

+ + +
+
+ +
+

Levels for logging verbosity.

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
debug + + +string + + + + + + + debug + +
info + + +string + + + + + + + info + +
warn + + +string + + + + + + + warn + +
error + + +string + + + + + + + error + +
off + + +string + + + + + + + off + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

<constant> NetworkQualityVerbosity :number

+ + +
+
+ +
+

The verbosity level of network quality information of a Participant.

+
+ + + +
Type:
+
    +
  • + +number + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
none + + +number + + + + + + + 0 + +

Nothing is reported for the Participant. This has no effect and +defaults to NetworkQualityVerbosity#minimal +for the LocalParticipant.

minimal + + +number + + + + + + + 1 + +

Reports NetworkQualityLevel for the Participant.

moderate + + +number + + + + + + + 2 + +

Reports NetworkQualityLevel and NetworkQualityStats for the Participant. +NetworkQualityStats is populated with audio and video NetworkQualityLevels +based on which the Participant's NetworkQualityLevel is calculated.

detailed + + +number + + + + + + + 3 + +

Reports NetworkQualityLevel and NetworkQualityStats for the Participant. +NetworkQualityStats is populated with audio and Video NetworkQualityLevels +and their corresponding NetworkQualityMediaStats based on which the +Participant's NetworkQualityLevel is calculated.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

<constant> NoiseCancellationVendor :string

+ + +
+
+ +
+

NoiseCancellationVendor specifies the 3rd party plugin to use for noise cancellation.

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
krisp + + +string + + + + + + + krisp + +

This plugin can be found by requesting access with this form https://forms.gle/eeFyoGJj1mgMrxN88

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

<constant> PreflightProgress :string

+ + +
+
+ +
+

progress values that are sent by PreflightTest#event:progress

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
mediaAcquired + + +string + + + + + + + mediaAcquired + +

PreflightTest has successfully generated synthetic tracks

connected + + +string + + + + + + + connected + +

PreflightTest has successfully connected to twilio server and obtained turn credentials

mediaSubscribed + + +string + + + + + + + mediaSubscribed + +

SubscriberParticipant successfully subscribed to media tracks.

mediaStarted + + +string + + + + + + + mediaStarted + +

Media flow was detected.

dtlsConnected + + +string + + + + + + + dtlsConnected + +

Established DTLS connection. This is measured from RTCDtlsTransport connecting to connected state. +On Safari, Support for measuring this is missing, this event will be not be emitted on Safari.

peerConnectionConnected + + +string + + + + + + + peerConnectionConnected + +

Established a PeerConnection, This is measured from PeerConnection connecting to connected state. +On Firefox, Support for measuring this is missing, this event will be not be emitted on Firefox.

iceConnected + + +string + + + + + + + iceConnected + +

Established ICE connection. This is measured from ICE connection checking to connected state.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

<constant> TrackSwitchOffMode :string

+ + +
+
+ +
+

TrackSwitchOffMode specifies when RemoteVideoTracks' are switched off.

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
detected + + +string + + + + + + + detected + +

In this mode, RemoteVideoTracks are switched off only when network congestion +is detected.

predicted + + +string + + + + + + + predicted + +

In this mode, RemoteVideoTracks are pro-actively switched off when network +congestion is predicted by the bandwidth estimation mechanism.

disabled + + +string + + + + + + + disabled + +

In this mode, RemoteVideoTracks are not switched off. Instead in response to network +congestion, tracks will be adjusted to lower quality.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

<constant> VideoCodec :string

+ + +
+
+ +
+

Names of the supported video codecs.

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
H264 + + +string + + + + + + + H264 + +
VP8 + + +string + + + + + + + VP8 + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

<constant> VideoContentPreferencesMode :string

+ + +
+
+ +
+

VideoContentPreferencesMode specifies how RemoteVideoTracks' render dimensions are +decided by the SDK.

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
auto + + +string + + + + + + + auto + +

when set to auto, SDK uses the sizes of the video elements attached to the to the RemoteVideoTrack dynamically to +decide the render dimensions. RemoteVideoTracks rendered in smaller video elements will be given smaller bandwidth allocation +compared to the tracks rendered in large video elements.

manual + + +string + + + + + + + manual + +

When set to manual, application can use RemoteVideoTrack#setContentPreference to set the +desired render dimensions for the RemoteVideoTrack.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

<constant> VideoEncodingMode :string

+ + +
+
+ +
+

Names of the supported VideoEncodingMode.

+
+ + + +
Type:
+
    +
  • + +string + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
Auto + + +string + + + + + + + auto + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ +
+ + + + + +

Type Definitions

+ +
+ +
+
+

AddProcessorOptions

+ + +
+
+ +
+

Possible options to provide to LocalVideoTrack#addProcessor and RemoteVideoTrack#addProcessor.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
inputFrameBufferType + + +string + + + + + + + <optional>
+ + + + 		+ + "offscreencanvas" + +

This option allows you to specify what kind of input you want to receive in your +Video Processor. The default is offscreencanvas and will fallback to a regular canvas if the browser does not support it. +Possible values include the following. +
+
+offscreencanvas - Your Video Processor will receive an OffscreenCanvas +which is good for canvas-related processing that can be rendered off screen. +
+
+canvas - Your Video Processor will receive an HTMLCanvasElement. +This is recommended on browsers that doesn't support OffscreenCanvas, or if you need to render the frame on the screen. +
+
+video - Your Video Processor will receive an HTMLVideoElement. +Use this option if you are processing the frame using WebGL or if you only need to draw +the frame directly to your output canvas.

outputFrameBufferContextType + + +string + + + + + + + <optional>
+ + + + 		+ + "2d" + +

The SDK needs the context type +that your Video Processor uses in order to properly generate the processed track. For example, if your Video Processor uses WebGL2 (canvas.getContext('webgl2')), +you should set outputFrameBufferContextType to webgl2. Or if you're using Canvas 2D processing (canvas.getContext('2d')), +you should set outputFrameBufferContextType to 2d.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

AudioCodecSettings

+ + +
+
+ +
+

Audio codec settings.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
codec + + +AudioCodec + + + + +

Audio codec name

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

AudioLevel

+ + +
+
+ +
+

The maximum absolute amplitude of a set of audio samples in the +range of 0 to 32767 inclusive.

+
+ + + +
Type:
+
    +
  • + +number + + + +
    • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

AudioTrackPublication

+ + +
+
+ +
+

A LocalAudioTrackPublication or a RemoteAudioTrackPublication.

+
+ + + +
Type:
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

BandwidthProfileOptions

+ + +
+
+ +
+

BandwidthProfileOptions allows you to configure how your available downlink +bandwidth is shared among the RemoteTracks you have subscribed to in a Group Room.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
video + + +VideoBandwidthProfileOptions + + + + + + + <optional>
+ + + +

Optional parameter to configure +how your available downlink bandwidth is shared among the RemoteVideoTracks you +have subscribed to in a Group Room.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

ConnectOptions

+ + +
+
+ +
+

You may pass these options to connect in order to override the +default behavior.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
audio + + +boolean +| + +CreateLocalTracksOptions +| + +CreateLocalAudioTrackOptions + + + + + + + <optional>
+ + + + 		+ + true + +

Whether or not to +get local audio with getUserMedia when tracks +are not provided.

automaticSubscription + + +boolean + + + + + + + <optional>
+ + + + 		+ + true + +

By default, you will subscribe +to all RemoteTracks shared by other Participants in a Room. You can now override this +behavior by setting this flag to false. It will make sure that you will +not subscribe to any RemoteTrack in a Group or Small Group Room. Setting it to +true, or not setting it at all preserves the default behavior. This +flag does not have any effect in a Peer-to-Peer Room.

bandwidthProfile + + +BandwidthProfileOptions + + + + + + + <optional>
+ + + + 		+ +

You can optionally configure +how your available downlink bandwidth is shared among the RemoteTracks you have subscribed +to in a Group Room. By default, bandwidth is shared equally among the RemoteTracks. +This has no effect in Peer-to-Peer Rooms.

dominantSpeaker + + +boolean + + + + + + + <optional>
+ + + + 		+ + false + +

Whether to enable the Dominant +Speaker API or not. This only takes effect in Group Rooms.

dscpTagging + + +boolean + + + + + + + <optional>
+ + + + 		+ + false + +

(deprecated: use "enableDscp" instead) +DSCP tagging allows you to request enhanced QoS treatment for RTP media packets from any +firewall that the client may be behind. Setting this option to true will +request DSCP tagging for media packets on supported browsers (only Chrome supports this +as of now). Audio packets will be sent with DSCP header value set to 0xb8 which corresponds +to Expedited Forwarding (EF). Video packets will be sent with DSCP header value set to 0x88 +which corresponds to Assured Forwarding (AF41).

enableDscp + + +boolean + + + + + + + <optional>
+ + + + 		+ + false + +

DSCP tagging allows you to request enhanced +QoS treatment for RTP media packets from any firewall that the client may be behind. +Setting this option to true will request DSCP tagging for media packets +on supported browsers (only Chrome supports this as of now). Audio packets will be +sent with DSCP header value set to 0xb8 which corresponds to Expedited Forwarding (EF). +Video packets will be sent with DSCP header value set to 0x88 which corresponds to +Assured Forwarding (AF41).

eventListener + + +EventListener + + + + + + + <optional>
+ + + + 		+ +

(deprecated: use Video.Logger +you can listen to fine-grained events related to signaling and media that are +not available in the public APIs. These events might be useful for your own reporting +and diagnostics.

iceServers + + +Array.<RTCIceServer> + + + + + + + + + + +

Override the STUN and TURN +servers used when connecting to Rooms

iceTransportPolicy + + +RTCIceTransportPolicy + + + + + + + <optional>
+ + + + 		+ + "all" + +

Override the +ICE transport policy to be one of "relay" or "all"

insights + + +boolean + + + + + + + <optional>
+ + + + 		+ + true + +

Whether publishing events +to the Insights gateway is enabled or not

maxAudioBitrate + + +number + + + + + + + <optional>
+ + + + <nullable>
+ + 		+ + null + +

Max outgoing audio bitrate (bps); +A null or a 0 value does not set any bitrate limit; +This value is set as a hint for variable bitrate codecs, but will not take +effect for fixed bitrate codecs; Based on our tests, Chrome, Firefox and Safari +support a bitrate range of 12000 bps to 256000 bps for Opus codec; This parameter +has no effect on iSAC, PCMU and PCMA codecs

maxVideoBitrate + + +number + + + + + + + <optional>
+ + + + <nullable>
+ + 		+ + null + +

Max outgoing video bitrate (bps); +A null or 0 value does not set any bitrate limit; +This value is set as a hint for variable bitrate codecs, but will not take +effect for fixed bitrate codecs; Based on our tests, Chrome, Firefox and Safari +all seem to support an average bitrate range of 20000 bps (20 kbps) to +8000000 bps (8 mbps) for a 720p VideoTrack +This parameter must not be set when when preferredVideoCodecs is set to auto.

name + + +string + + + + + + + <optional>
+ + + + <nullable>
+ + 		+ + null + +

Set to connect to a Room by name

networkQuality + + +boolean +| + +NetworkQualityConfiguration + + + + + + + <optional>
+ + + + 		+ + false + +

Whether to enable the Network +Quality API or not. This only takes effect in Group Rooms. Pass a NetworkQualityConfiguration +to configure verbosity levels for network quality information for LocalParticipant +and RemoteParticipants. A true value will set the NetworkQualityVerbosity +for the LocalParticipant to NetworkQualityVerbosity#minimal +and the NetworkQualityVerbosity for RemoteParticipants to +NetworkQualityVerbosity#none.

notifyWarnings + + +Array.<string> + + + + + + + <optional>
+ + + + 		+ + [] + +

The SDK raises warning events when it +detects certain conditions. You can implement callbacks on these events to act on them, or to alert +the user of an issue. Subsequently, "warningsCleared" event is raised when conditions have returned +to normal. You can listen to these events by specifying an array of warning. By default, +this array is empty and no warning events will be raised. +Possible values include recording-media-lost, which is 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. +This warning is raised by LocalTrackPublication, LocalParticipant, and Room object.

region + + +string + + + + + + + <optional>
+ + + + 		+ + 'gll' + +

Preferred signaling region; By default, you will be connected to the +nearest signaling server determined by latency based routing. Setting a value other +than gll bypasses routing and guarantees that signaling traffic will be +terminated in the region that you prefer. Please refer to this table +for the list of supported signaling regions.

preferredAudioCodecs + + +Array.<(AudioCodec|AudioCodecSettings)> + + + + + + + <optional>
+ + + + 		+ + [] + +

Preferred audio codecs; +An empty array preserves the current audio codec preference order.

preferredVideoCodecs + + +Array.<(VideoCodec|VideoCodecSettings)> +| + +VideoEncodingMode + + + + + + + <optional>
+ + + + 		+ + [] + +

Preferred video codecs; when set to 'VideoEncodingMode.Auto', SDK manages the video codec, +by preferring VP8 simulcast in group rooms. It also enables adaptive simulcast, which allows SDK +to turn off simulcast layers that are not needed for efficient bandwidth and CPU usage. +An empty array preserves the current video codec. +preference order. If you want to set a preferred video codec on a Group Room, +you will need to create the Room using the REST API and set the +VideoCodecs property. +See +here for more information.

logLevel + + +LogLevel +| + +LogLevels + + + + + + + <optional>
+ + + + 		+ + 'warn' + +

(deprecated: use Video.Logger instead. +See examples for details) +Set the default log verbosity +of logging. Passing a LogLevel string will use the same +level for all components. Pass a LogLevels to set specific log +levels.

loggerName + + +string + + + + + + + <optional>
+ + + + 		+ + 'twilio-video' + +

The name of the logger. Use this name when accessing the logger used by the SDK. +See examples for details.

tracks + + +Array.<(LocalTrack|MediaStreamTrack)> + + + + + + + <optional>
+ + + + 		+ +

The +LocalTracks or MediaStreamTracks with which to join the +Room. These tracks can be obtained either by calling +createLocalTracks, or by constructing them from the MediaStream +obtained by calling getUserMedia().

video + + +boolean +| + +CreateLocalTrackOptions + + + + + + + <optional>
+ + + + 		+ + true + +

Whether or not to +get local video with getUserMedia when tracks +are not provided.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

CreateLocalAudioTrackOptions

+ + +
+
+ +
+

Create LocalAudioTrack options.

+
+ + + +
Type:
+ + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
workaroundWebKitBug180748 + + +boolean + + + + + + + <optional>
+ + + + 		+ + false + +

setting this +attempts to workaround WebKit Bug 180748, where, in Safari, getUserMedia may return a silent audio +MediaStreamTrack.

defaultDeviceCaptureMode + + +DefaultDeviceCaptureMode + + + + + + + <optional>
+ + + + 		+ + "auto" + +

This optional property only applies if the +LocalAudioTrack is capturing from the default audio input device connected to a desktop or laptop. When the +property is set to "auto", the LocalAudioTrack restarts whenever the default audio input device changes, in order to +capture audio from the new default audio input device. For example, when a bluetooth audio headset is connected to a +Macbook, the LocalAudioTrack will start capturing audio from the headset microphone. When the headset is disconnected, +the LocalAudioTrack will start capturing audio from the Macbook microphone. When the property is set to "manual", the +LocalAudioTrack continues to capture from the same audio input device even after the default audio input device changes. +When the property is not specified, it defaults to "auto".

noiseCancellationOptions + + +NoiseCancellationOptions + + + + + + + <optional>
+ + + + 		+ +

This optional property enables using 3rd party plugins +for noise cancellation.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

CreateLocalTrackOptions

+ + +
+
+ +
+

Create LocalTrack options. Apart from the properties listed here, you can +also specify any of the MediaTrackConstraints +properties.

+
+ + + +
Type:
+
    +
  • + +MediaTrackConstraints + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
logLevel + + +LogLevel +| + +LogLevels + + + + + + + <optional>
+ + + + 		+ + 'warn' + +

(deprecated: use Video.Logger instead. +See examples for details) +Set the default log verbosity +of logging. Passing a LogLevel string will use the same +level for all components. Pass a LogLevels to set specific log +levels.

loggerName + + +string + + + + + + + <optional>
+ + + + 		+ + 'twilio-video' + +

The name of the logger. Use this name when accessing the logger used by the SDK. +See examples for details.

name + + +string + + + + + + + <optional>
+ + + + 		+ +

The LocalTrack's name; by default, +it is set to the LocalTrack's ID.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

CreateLocalTracksOptions

+ + +
+
+ +
+

createLocalTracks options

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
audio + + +boolean +| + +CreateLocalTrackOptions +| + +CreateLocalAudioTrackOptions + + + + + + + <optional>
+ + + + 		+ + true + +

Whether or not to +get local audio with getUserMedia when tracks +are not provided.

logLevel + + +LogLevel +| + +LogLevels + + + + + + + <optional>
+ + + + 		+ + 'warn' + +

(deprecated: use Video.Logger instead. +See examples for details) +Set the default log verbosity +of logging. Passing a LogLevel string will use the same +level for all components. Pass a LogLevels to set specific log +levels.

loggerName + + +string + + + + + + + <optional>
+ + + + 		+ + 'twilio-video' + +

The name of the logger. Use this name when accessing the logger used by the SDK. +See examples for details.

video + + +boolean +| + +CreateLocalTrackOptions + + + + + + + <optional>
+ + + + 		+ + true + +

Whether or not to +get local video with getUserMedia when tracks +are not provided.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

DataTrack

+ + +
+
+ +
+

A DataTrack is a LocalDataTrack or RemoteDataTrack.

+
+ + + +
Type:
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

DataTrackPublication

+ + +
+
+ +
+

A LocalDataTrackPublication or a RemoteDataTrackPublication.

+
+ + + +
Type:
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

EncodingParameters

+ + +
+
+ +
+

Outgoing media encoding parameters.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
maxAudioBitrate + + +number + + + + + + + <optional>
+ + + + <nullable>
+ +

Max outgoing audio bitrate (bps); +If not specified, retains the existing bitrate limit; A null or a +0 value removes any previously set bitrate limit; This value is set +as a hint for variable bitrate codecs, but will not take effect for fixed bitrate +codecs; Based on our tests, Chrome, Firefox and Safari support a bitrate range of +12000 bps to 256000 bps for Opus codec; This parameter has no effect on iSAC, PCMU +and PCMA codecs

maxVideoBitrate + + +number + + + + + + + <optional>
+ + + + <nullable>
+ +

Max outgoing video bitrate (bps); +If not specified, retains the existing bitrate limit; A null or +a 0 value removes any previously set bitrate limit; This value is +set as a hint for variable bitrate codecs, but will not take effect for fixed +bitrate codecs; Based on our tests, Chrome, Firefox and Safari all seem to support +an average bitrate range of 20000 bps (20 kbps) to 8000000 bps (8 mbps) for a +720p VideoTrack. +Note: this limit is not applied for screen share tracks published on Chrome.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

EventListener

+ + +
+
+ +
+

An EventListener allows you to listen to fine-grained EventListenerEvents related +to signaling and media that are not available in the public APIs, which might be useful for your own +reporting and diagnostics.

+
+ + + +
Type:
+
    +
  • + +EventEmitter + + + +
    • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Example
+ + 
const { EventEmitter } = require('events');
+const { connect } = require('twilio-video');
+
+const eventListener = new EventEmitter();
+eventListener.on('event', function(event) {
+  console.log('The SDK raised an event:', event);
+});
+
+connect('token', {
+  eventListener: eventListener
+});
+ + + +
+ + + +
+
+

EventListenerClosedEvent

+ + +
+
+ +
+

The connection to Twilio's signaling server was closed.

+
+ + + +
Type:
+ + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
group + + +EventListenerGroup + + + + + + + 'signaling' + +
level + + +EventListenerLevel + + + + + + +

'info' if the connection was closed by the client, 'error' otherwise

name + + +string + + + + + + + 'closed' + +
payload + + +Object + + + + + + +

Reason for the connection being closed. It can be one of +'busy', 'failed', 'local', 'remote' or 'timeout'

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

EventListenerConnectingEvent

+ + +
+
+ +
+

The SDK is connecting to Twilio's signaling server.

+
+ + + +
Type:
+ + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
group + + +EventListenerGroup + + + + + + + 'signaling' + +
level + + +EventListenerLevel + + + + + + + 'info' + +
name + + +string + + + + + + + 'connecting' + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

EventListenerEarlyEvent

+ + +
+
+ +
+

The SDK is about to connect to Twilio's signaling server.

+
+ + + +
Type:
+ + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
group + + +EventListenerGroup + + + + + + + 'signaling' + +
level + + +EventListenerLevel + + + + + + + 'info' + +
name + + +string + + + + + + + 'early' + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

EventListenerEvent

+ + +
+
+ +
+

An EventListenerEvent provides context about an event raised by the SDK on the +EventListener. Apart from the properties listed here, it may also include some +event-specific data within an optional "payload" property. The different types of +EventListenerEvents are listed below:

+ +
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
elapsedTime + + +number + + + + + + + + +

The time elapsed in milliseconds since connect() was called

group + + +EventListenerGroup + + + + + + + + +

The group under which the event is classified

level + + +EventListenerLevel + + + + + + + + +

The verbosity level of the event, which can be one of "debug", "error", "info", "warning"

name + + +string + + + + + + + + +

The name of the event

payload + + +* + + + + + + + <optional>
+ + + +

Optional event-specific data

timestamp + + +number + + + + + + + + +

The time in milliseconds relative to the Unix Epoch when the event was raised

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

EventListenerOpenEvent

+ + +
+
+ +
+

The SDK has established a signaling connection to Twilio's signaling server.

+
+ + + +
Type:
+ + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
group + + +EventListenerGroup + + + + + + + 'signaling' + +
level + + +EventListenerLevel + + + + + + + 'info' + +
name + + +string + + + + + + + 'open' + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

EventListenerWaitingEvent

+ + +
+
+ +
+

The SDK is waiting to retry connecting th Twilio's signaling server. This can +happen if the server is busy with too many connection requests.

+
+ + + +
Type:
+ + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
group + + +EventListenerGroup + + + + + + + 'signaling' + +
level + + +EventListenerLevel + + + + + + + 'warning' + +
name + + +string + + + + + + + 'waiting' + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

LocalDataTrackOptions

+ + +
+
+ +
+

LocalDataTrack options

+
+ + + +
Type:
+ + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
maxPacketLifeTime + + +number + + + + + + + <optional>
+ + + + <nullable>
+ + 		+ + null + +

Set this to limit the time +(in milliseconds) during which the LocalDataTrack will send or re-send data +if not successfully delivered on the underlying RTCDataChannel(s). It is an +error to specify both this and maxRetransmits.

maxRetransmits + + +number + + + + + + + <optional>
+ + + + <nullable>
+ + 		+ + null + +

Set this to limit the number of +times the LocalDataTrack will send or re-send data if not +acknowledged on the underlying RTCDataChannel(s). It is an error to specify +both this and maxPacketLifeTime.

ordered + + +boolean + + + + + + + <optional>
+ + + + 		+ + true + +

Set this to false to allow data on the +LocalDataTrack to be sent out-of-order.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

LocalTrack

+ + +
+
+ +
+

A LocalTrack is a LocalAudioTrack, LocalVideoTrack, +or LocalDataTrack.

+
+ + + +
Type:
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

LocalTrackOptions

+ + +
+
+ +
+

LocalTrack options

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
logLevel + + +LogLevel +| + +LogLevels + + + + + + + + +

Log level for 'media' modules

name + + +string + + + + + + + <optional>
+ + + +

The LocalTrack's name; by default, +it is set to the LocalTrack's ID.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

LocalTrackPublishOptions

+ + +
+
+ +
+

Options for publishing a LocalTrack.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
priority + + +Track.Priority + + + + + + + <optional>
+ + + + 		+ + 'standard' + +

The priority with which the LocalTrack +is to be published; In Group or Small Group Rooms, the appropriate bandwidth is +allocated to the LocalTrack based on its Track.Priority; It has no +effect in Peer-to-Peer Rooms; It defaults to "standard" when not provided

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

LogLevels

+ + +
+
+ +
+

You may pass these levels to ConnectOptions to override +log levels for individual components.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
default + + +LogLevel + + + + + + + <optional>
+ + + + 		+ + 'warn' + +

Log level for 'default' modules.

media + + +LogLevel + + + + + + + <optional>
+ + + + 		+ + 'warn' + +

Log level for 'media' modules.

signaling + + +LogLevel + + + + + + + <optional>
+ + + + 		+ + 'warn' + +

Log level for 'signaling' modules.

webrtc + + +LogLevel + + + + + + + <optional>
+ + + + 		+ + 'warn' + +

Log level for 'webrtc' modules.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

MediaStreamTrackPublishOptions

+ + +
+
+ +
+

Options for publishing a MediaStreamTrack.

+
+ + + +
Type:
+ + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
priority + + +Track.Priority + + + + + + + <optional>
+ + + + 		+ + 'standard' + +

The priority with which the LocalTrack +is to be published; In Group or Small Group Rooms, the appropriate bandwidth is +allocated to the LocalTrack based on its Track.Priority; It has no +effect in Peer-to-Peer Rooms; It defaults to "standard" when not provided

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

NetworkQualityConfiguration

+ + +
+
+ +
+

Configure verbosity levels for network quality information for +LocalParticipant and RemoteParticipants.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
local + + +NetworkQualityVerbosity + + + + + + + <optional>
+ + + + 		+ + 1 + +

Verbosity level for LocalParticipant

remote + + +NetworkQualityVerbosity + + + + + + + <optional>
+ + + + 		+ + 0 + +

Verbosity level for RemoteParticipants

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

NetworkQualityLevel

+ + +
+
+ +
+

NetworkQualityLevel is a value from 0–5, inclusive, representing the +quality of a network connection.

+
+ + + +
Type:
+
    +
  • + +number + + + +
    • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

NetworkTiming

+ + +
+
+ +
+

Represents network timing measurements captured during preflight test

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
connect + + +TimeMeasurement + + + + + + + <optional>
+ + + +

Time to establish signaling connection and acquire turn credentials

media + + +TimeMeasurement + + + + + + + <optional>
+ + + +

Time to start media. This is measured from calling connect to remote media getting started.

dtls + + +TimeMeasurement + + + + + + + <optional>
+ + + +

Time to establish dtls connection. This is measured from RTCDtlsTransport connecting to connected state. (Not available on Safari)

ice + + +TimeMeasurement + + + + + + + <optional>
+ + + +

Time to establish ice connectivity. This is measured from ICE connection checking to connected state.

peerConnection + + +TimeMeasurement + + + + + + + <optional>
+ + + +

Time to establish peer connectivity. This is measured from PeerConnection connecting to connected state. (Not available on Firefox)

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

NoiseCancellationOptions

+ + +
+
+ +
+

You can use 3rd party noise cancellation plugin when creating LocalAudioTrack +By specifying these options. This is a beta feature.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
vendor + + +NoiseCancellationVendor + + + + +

Specifies the vendor library to use +You need to obtain and host the library files on your web server.

sdkAssetsPath + + +string + + + + +

Specifies path where vendor library files are +hosted on your web server.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

OpusCodecSettings

+ + +
+
+ +
+

Opus codec settings.

+
+ + + +
Type:
+ + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
name + + +AudioCodec + + + + + + + + + + +

"opus"

dtx + + +boolean + + + + + + + <optional>
+ + + + 		+ + true + +

Enable/disable discontinuous transmission (DTX); +If enabled all published LocalAudioTracks will reduce the outgoing bitrate +to near-zero whenever speech is not detected, resulting in bandwidth and CPU savings; +It defaults to true.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

PreflightOptions

+ + +
+
+ +
+

You may pass these options to module:twilio-video.testPreflight in order to override the +default behavior.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
region + + +string + + + + + + + <optional>
+ + + + 		+ + 'gll' + +

Preferred signaling region; By default, you will be connected to the +nearest signaling server determined by latency based routing. Setting a value other +than gll bypasses routing and guarantees that signaling traffic will be +terminated in the region that you prefer. Please refer to this table +for the list of supported signaling regions.

duration + + +number + + + + + + + <optional>
+ + + + 		+ + 10000 + +

number of milliseconds to run test for. +once connected test will run for this duration before generating the stats report.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

PreflightReportStats

+ + +
+
+ +
+

Represents RTC related stats that were observed during preflight test

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
jitter + + +Stats + + + + + + + <optional>
+ + + +

Packet delay variation in seconds

rtt + + +Stats + + + + + + + <optional>
+ + + +

Round trip time, to the server back to the client in milliseconds.

packetLoss + + +Stats + + + + + + + <optional>
+ + + +

Packet loss as a percent of total packets sent.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

PreflightTestReport

+ + +
+
+ +
+

Represents report generated by PreflightTest.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
testTiming + + +TimeMeasurement + + + + + + + <optional>
+ + + +

Time measurements of test run time.

networkTiming + + +NetworkTiming + + + + + + + <optional>
+ + + +

Network related time measurements.

stats + + +PreflightReportStats + + + + + + + <optional>
+ + + +

RTC related stats captured during the test.

iceCandidateStats + + +Array.<RTCIceCandidateStats> + + + + + + + <optional>
+ + + +

List of gathered ice candidates.

selectedIceCandidatePairStats + + +SelectedIceCandidatePairStats + + + + + + + + +

Stats for the ice candidates that were used for the connection.

progressEvents + + +Array.<ProgressEvent> + + + + + + + <optional>
+ + + +

ProgressEvent events detected during the test. +Use this information to determine which steps were completed and which ones were not.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

ProgressEvent

+ + +
+
+ +
+

A PreflightProgress event with timing information.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
duration + + +number + + + + + + + <optional>
+ + + +

The duration of the event, measured from the start of the test.

name + + +string + + + + + + + <optional>
+ + + +

The PreflightProgress event name.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

RemoteTrack

+ + +
+
+ +
+

A RemoteTrack is a RemoteAudioTrack, +RemoteVideoTrack, or RemoteDataTrack.

+
+ + + +
Type:
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

RemoteTrackPublicationOptions

+ + +
+
+ +
+

RemoteTrackPublication options

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
logLevel + + +LogLevel +| + +LogLevels + + + + +

Log level for 'media' modules

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

SelectedIceCandidatePairStats

+ + +
+
+ +
+

Represents stats for a numerical metric.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
localCandidate + + +RTCIceCandidateStats + + + + + + + <optional>
+ + + +

Selected local ice candidate

remoteCandidate + + +RTCIceCandidateStats + + + + + + + <optional>
+ + + +

Selected local ice candidate

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

Stats

+ + +
+
+ +
+

Represents stats for a numerical metric.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
average + + +number + + + + + + + <optional>
+ + + +

Average value observed.

max + + +number + + + + + + + <optional>
+ + + +

Max value observed.

min + + +number + + + + + + + <optional>
+ + + +

Min value observed.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

TrackPublicationOptions

+ + +
+
+ +
+

TrackPublication options

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
logLevel + + +LogLevel +| + +LogLevels + + + + +

Log level for 'media' modules

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

VideoBandwidthProfileOptions

+ + +
+
+ +
+

VideoBandwidthProfileOptions allows you to configure how your available downlink +bandwidth is shared among the RemoteVideoTracks you have subscribed to in a Group Room.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
dominantSpeakerPriority + + +Track.Priority + + + + + + + <optional>
+ + + + 		+ + "standard" + +

Optional parameter to +specify the minimum subscribe Track.Priority of the Dominant Speaker's RemoteVideoTracks. +This means that the Dominant Speaker's RemoteVideoTracks that are published with +lower Track.Priority will be subscribed to with the Track.Priority specified here. +This has no effect on RemoteVideoTracks published with higher Track.Priority, which will +still be subscribed to with with the same Track.Priority. If not specified, this defaults to "standard". +This parameter only applies to a Group Room Participant when ConnectOptions.dominantSpeaker is set to true.

maxSubscriptionBitrate + + +number + + + + + + + <optional>
+ + + + 		+ +

Optional parameter to specify the maximum +downlink video bandwidth in bits per second (bps). By default, there are no limits on +the downlink video bandwidth.

clientTrackSwitchOffControl + + +ClientTrackSwitchOffControl + + + + + + + <optional>
+ + + + 		+ + "auto" + +

Optional parameter that determines +when to turn the RemoteVideoTrack on or off. When set to "auto", SDK will use the visibility of the +attached elements to determine if the RemoteVideoTrack should be turned off or on. When the attached video elements become invisible the RemoteVideoTrack will +be turned off, and when elements become visible they will be turned on. When set to "manual" you can turn the RemoteVideoTrack +on and off using the api RemoteVideoTrack#switchOn and RemoteVideoTrack#switchOff respectively.

contentPreferencesMode + + +VideoContentPreferencesMode + + + + + + + <optional>
+ + + + 		+ + "auto" + +

This Optional parameter configures +the mode for specifying content preferences for the RemoteVideoTrack. When set to "auto" the +SDK determines the render dimensions by inspecting the attached video elements. RemoteVideoTracks rendered in smaller video elements +will receive a lower resolution stream compared to the video rendered in larger video elements. When set to "manual" you can set +the dimensions programmatically by calling RemoteVideoTrack#setContentPreferences.

maxTracks + + +number + + + + + + + <optional>
+ + + + 		+ +

(deprecated: use "clientTrackSwitchOffControl" instead). Optional +parameter to specify the maximum number of visible RemoteVideoTracks, which will be selected based on +Track.Priority and an N-Loudest policy. By default there are no limits on the number of visible RemoteVideoTracks. +0 or a negative value will remove any limit on the maximum number of visible RemoteVideoTracks.

mode + + +BandwidthProfileMode + + + + + + + <optional>
+ + + + 		+ + "grid" + +

Optional parameter to specify how the RemoteVideoTracks' +TrackPriority values are mapped to bandwidth allocation in Group Rooms. This defaults to "grid", +which results in equal bandwidth share allocation to all RemoteVideoTracks.

renderDimensions + + +VideoRenderDimensions + + + + + + + <optional>
+ + + + 		+ +

(deprecated: use "contentPreferencesMode" instead). Optional +parameter to specify the desired render dimensions of RemoteVideoTracks.

trackSwitchOffMode + + +TrackSwitchOffMode + + + + + + + <optional>
+ + + + 		+ + "predicted" + +

Optional parameter to configure +how RemoteVideoTracks are switched off in response to bandwidth pressure. Defaults to "predicted".

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

VideoCodecSettings

+ + +
+
+ +
+

Video codec settings.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
codec + + +VideoCodec + + + + +

Video codec name

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

VideoContentPreferences

+ + +
+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
renderDimensions + + +VideoTrack.Dimensions + + + + + + + <optional>
+ + + +

Render Dimensions to request for the RemoteVideoTrack.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

VideoProcessor

+ + +
+
+ +
+

A VideoProcessor, when added via VideoTrack#addProcessor, +is used to process incoming video frames before +sending to the encoder or renderer.

+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
processFrame + + +function + + + + +

A callback to receive input and output frame buffers for processing. +The input frame buffer contains the original video frame which can be used for additional processing +such as applying filters to it. The output frame buffer is used to receive the processed video frame +before sending to the encoder or renderer.

+

Any exception raised (either synchronously or asynchronously) in processFrame will result in the frame being dropped. +This callback has the following signature:

+processFrame(
+  inputFrameBuffer: OffscreenCanvas | HTMLCanvasElement | HTMLVideoElement,
+  outputFrameBuffer: HTMLCanvasElement
+): Promise<void> | void;

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
Example
+ + 
class GrayScaleProcessor {
+  constructor(percentage) {
+    this.percentage = percentage;
+  }
+  processFrame(inputFrameBuffer, outputFrameBuffer) {
+    const context = outputFrameBuffer.getContext('2d');
+    context.filter = `grayscale(${this.percentage}%)`;
+    context.drawImage(inputFrameBuffer, 0, 0, inputFrameBuffer.width, inputFrameBuffer.height);
+  }
+}
+ + + +
+ + + +
+
+

VideoRenderDimensions

+ + +
+
+ + + +
Type:
+
    +
  • + +object + + + +
    • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
high + + +VideoTrack.Dimensions + + + + + + + <optional>
+ + + +

Optional parameter to specify the desired rendering dimensions of +RemoteVideoTrack whose Track.Priority is "high". 0 or a negative value will result in the lowest +possible resolution. This defaults to 1280 x 720 (HD).

low + + +VideoTrack.Dimensions + + + + + + + <optional>
+ + + +

Optional parameter to specify the desired rendering dimensions of +RemoteVideoTrack whose Track.Priority is "low". 0 or a negative value will result in the lowest +possible resolution. This defaults to 176 x 144 (QCIF).

standard + + +VideoTrack.Dimensions + + + + + + + <optional>
+ + + +

Optional parameter to specify the desired rendering dimensions of +RemoteVideoTrack whose Track.Priority is "standard". 0 or a negative value will result in the lowest +possible resolution. This defaults to 640 x 480 (VGA).

+
+ + + + + + + + + + + + + + + + + + +
Deprecated:
+ +
+
    +
  • VideoRenderDimensions allows you to specify the desired render dimensions of RemoteVideoTracks. +You can specify 'auto' for this field - which is also default value - based on Track.Priority. The bandwidth allocation algorithm will distribute the available downlink bandwidth +proportional to the requested render dimensions. This is just an input for calculating the bandwidth to be allocated +and does not affect the actual resolution of the RemoteVideoTracks.
    • +
+
+ + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

VideoTrackPublication

+ + +
+
+ +
+

A LocalVideoTrackPublication or a RemoteVideoTrackPublication.

+
+ + + +
Type:
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ + + +
+
+

VP8CodecSettings

+ + +
+
+ +
+

VP8 codec settings.

+
+ + + +
Type:
+ + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
name + + +VideoCodec + + + + + + + + + + +

"VP8"

simulcast + + +boolean + + + + + + + <optional>
+ + + + 		+ + false + +

Enable/disable VP8 simulcast; If +enabled, Twilio's Video SDK will send three video streams of different +qualities

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+ +
+ + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/img/glyphicons-halflings-white.png b/dist/docs/img/glyphicons-halflings-white.png new file mode 100644 index 000000000..3bf6484a2 Binary files /dev/null and b/dist/docs/img/glyphicons-halflings-white.png differ diff --git a/dist/docs/img/glyphicons-halflings.png b/dist/docs/img/glyphicons-halflings.png new file mode 100644 index 000000000..a99699932 Binary files /dev/null and b/dist/docs/img/glyphicons-halflings.png differ diff --git a/dist/docs/index.html b/dist/docs/index.html new file mode 100644 index 000000000..e276c4fce --- /dev/null +++ b/dist/docs/index.html @@ -0,0 +1,471 @@ + + + + + + + Documentation Index + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + +
+

twilio-video.js

+

NPM CircleCI

+

twilio-video.js allows you to add real-time voice and video to your web apps.

+ +

We want your feedback! Please feel free to open a GitHub issue for suggested improvements or feature requests. If you need technical support, contact help@twilio.com.

+

Changelog

+

View CHANGELOG.md for details about our releases.

+

Browser Support

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ChromeEdge (Chromium)FirefoxSafariWebView
Android✓-✓--
iOS✓-*✓✓
Linux✓-✓--
macOS✓✓ **✓✓-
Windows✓✓ **✓--
+

** twilio-video.js supports the Chromium-based Edge browser.

+

Installation

+

NPM

+
npm install twilio-video --save
+
+

Using this method, you can require twilio-video.js like so:

+
const Video = require('twilio-video');
+
+

TypeScript definitions can now be imported using this method.

+
import * as Video from 'twilio-video';
+
+function participantDisconnected(participant: Video.RemoteParticipant) {
+  console.log('Participant "%s" disconnected', participant.identity);
+  document.getElementById(participant.sid).remove();
+}
+
+

Alternatively, you can import just the definitions you need like so:

+
import { RemoteParticiant } from 'twilio-video';
+
+function participantDisconnected(participant: RemoteParticipant) {
+  console.log('Participant "%s" disconnected', participant.identity);
+  document.getElementById(participant.sid).remove();
+}
+
+

CDN

+

Releases of twilio-video.js are hosted on a CDN, and you can include these +directly in your web app using a <script> tag.

+
<script src="//sdk.twilio.com/js/video/releases/2.26.2/twilio-video.min.js"></script>
+
+

Using this method, twilio-video.js will set a browser global:

+
const Video = Twilio.Video;
+
+

Usage

+

The following is a simple example for connecting to a Room. For more information, refer to the +API Docs.

+
const Video = require('twilio-video');
+
+Video.connect('$TOKEN', { name: 'room-name' }).then(room => {
+  console.log('Connected to Room "%s"', room.name);
+
+  room.participants.forEach(participantConnected);
+  room.on('participantConnected', participantConnected);
+
+  room.on('participantDisconnected', participantDisconnected);
+  room.once('disconnected', error => room.participants.forEach(participantDisconnected));
+});
+
+function participantConnected(participant) {
+  console.log('Participant "%s" connected', participant.identity);
+
+  const div = document.createElement('div');
+  div.id = participant.sid;
+  div.innerText = participant.identity;
+
+  participant.on('trackSubscribed', track => trackSubscribed(div, track));
+  participant.on('trackUnsubscribed', trackUnsubscribed);
+
+  participant.tracks.forEach(publication => {
+    if (publication.isSubscribed) {
+      trackSubscribed(div, publication.track);
+    }
+  });
+
+  document.body.appendChild(div);
+}
+
+function participantDisconnected(participant) {
+  console.log('Participant "%s" disconnected', participant.identity);
+  document.getElementById(participant.sid).remove();
+}
+
+function trackSubscribed(div, track) {
+  div.appendChild(track.attach());
+}
+
+function trackUnsubscribed(track) {
+  track.detach().forEach(element => element.remove());
+}
+
+

Content Security Policy (CSP)

+

Want to enable CSP in a +way that's compatible with twilio-video.js? Use the following policy directives:

+
connect-src wss://global.vss.twilio.com wss://sdkgw.us1.twilio.com
+media-src mediastream:
+
+

If you're loading twilio-video.js from sdk.twilio.com, +you should also include the following script-src directive:

+
script-src https://sdk.twilio.com
+
+

If you are enabling Krisp Noise Cancellation for +your local audio, and you are using the following default-src self directive, you should also add the +unsafe-eval directive:

+
default-src self unsafe-eval
+
+

Keep in mind, you may need to merge these policy directives with your own if +you're using other services.

+

Building

+

Fork and clone the repository. Then, install dependencies with

+
npm install
+
+

Then run the build script:

+
npm run build
+
+

The builds and docs will be placed in the dist/ directory.

+

Testing

+

Run unit tests with

+
npm run test:unit
+
+

Run integration tests with

+
ACCOUNT_SID=<Your account sid> \
+API_KEY_SID=<Your api key sid> \
+API_KEY_SECRET=<Your api key secret> \
+BROWSER=<Browser you'd like to use> \
+npm run test:integration
+
+

You can add these optional variables to control the integration test execution :

+
    +
  • Topology : Decides which type of rooms to test against.
    • +
  • Debug : To get better source mapping, and the browser does not close after tests are run which allows you to easily step through code to debug.
    • +
  • Test Files : Allows you to limit the test to just one file.
    • +
+
TOPOLOGY=<peer-to-peer|group>
+DEBUG=1
+TEST_FILES=<path_ to_the_file>
+
+

Tips

+
    +
  • Use Pre-commit hook: We have some useful pre-commit hook that would help identify common mistakes before commit. Use them by executing
    • +
+
ln -s ../../pre-commit.sh .git/hooks/pre-commit
+
+

Related

+

Applications using twilio-video.js

+ +

Developer tools

+ +

Contributing

+

Bug fixes welcome! If you're not familiar with the GitHub pull +request/contribution process, +this is a nice tutorial.

+

License

+

See LICENSE.md.

+
+ + + + + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/interfaces.list.html b/dist/docs/interfaces.list.html new file mode 100644 index 000000000..3f6c0ad95 --- /dev/null +++ b/dist/docs/interfaces.list.html @@ -0,0 +1,18511 @@ + + + + + + + Documentation Interfaces + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Interfaces

+
+ +
+ +

+ +

+ + +
+ + +
+
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +

Classes

+ +
+
AccessTokenExpiredError
+
+ +
AccessTokenGrantsInvalidError
+
+ +
AccessTokenHeaderInvalidError
+
+ +
AccessTokenInvalidError
+
+ +
AccessTokenIssuerInvalidError
+
+ +
AccessTokenNotYetValidError
+
+ +
AccessTokenSignatureInvalidError
+
+ +
AudioTrack
+
+ +
ConfigurationAcquireFailedError
+
+ +
ConfigurationAcquireTurnFailedError
+
+ +
LocalAudioTrack
+
+ +
LocalAudioTrackPublication
+
+ +
LocalAudioTrackStats
+
+ +
LocalDataTrack
+
+ +
LocalDataTrackPublication
+
+ +
LocalParticipant
+
+ +
LocalTrackPublication
+
+ +
LocalTrackStats
+
+ +
LocalVideoTrack
+
+ +
LocalVideoTrackPublication
+
+ +
LocalVideoTrackStats
+
+ +
MediaClientLocalDescFailedError
+
+ +
MediaClientRemoteDescFailedError
+
+ +
MediaConnectionError
+
+ +
MediaDTLSTransportFailedError
+
+ +
MediaNoSupportedCodecError
+
+ +
MediaServerLocalDescFailedError
+
+ +
MediaServerRemoteDescFailedError
+
+ +
NetworkQualityAudioStats
+
+ +
NetworkQualityBandwidthStats
+
+ +
NetworkQualityFractionLostStats
+
+ +
NetworkQualityLatencyStats
+
+ +
NetworkQualityMediaStats
+
+ +
NetworkQualityRecvStats
+
+ +
NetworkQualitySendOrRecvStats
+
+ +
NetworkQualitySendStats
+
+ +
NetworkQualityStats
+
+ +
NetworkQualityVideoStats
+
+ +
Participant
+
+ +
ParticipantDuplicateIdentityError
+
+ +
ParticipantIdentityCharsInvalidError
+
+ +
ParticipantIdentityInvalidError
+
+ +
ParticipantIdentityTooLongError
+
+ +
ParticipantMaxTracksExceededError
+
+ +
ParticipantNotFoundError
+
+ +
PreflightTest
+
+ +
RemoteAudioTrack
+
+ +
RemoteAudioTrackPublication
+
+ +
RemoteAudioTrackStats
+
+ +
RemoteDataTrack
+
+ +
RemoteDataTrackPublication
+
+ +
RemoteParticipant
+
+ +
RemoteTrackPublication
+
+ +
RemoteTrackStats
+
+ +
RemoteVideoTrack
+
+ +
RemoteVideoTrackPublication
+
+ +
RemoteVideoTrackStats
+
+ +
Room
+
+ +
RoomAudioOnlyFlagNotSupportedError
+
+ +
RoomCompletedError
+
+ +
RoomConnectFailedError
+
+ +
RoomCreateFailedError
+
+ +
RoomInvalidParametersError
+
+ +
RoomMaxParticipantsExceededError
+
+ +
RoomMaxParticipantsOutOfRangeError
+
+ +
RoomMediaRegionInvalidError
+
+ +
RoomMediaRegionUnavailableError
+
+ +
RoomNameCharsInvalidError
+
+ +
RoomNameInvalidError
+
+ +
RoomNameTooLongError
+
+ +
RoomNotFoundError
+
+ +
RoomRoomExistsError
+
+ +
RoomStatusCallbackInvalidError
+
+ +
RoomStatusCallbackMethodInvalidError
+
+ +
RoomStatusInvalidError
+
+ +
RoomSubscriptionOperationNotSupportedError
+
+ +
RoomTimeoutOutOfRangeError
+
+ +
RoomTrackKindNotSupportedError
+
+ +
RoomTypeInvalidError
+
+ +
SignalingConnectionDisconnectedError
+
+ +
SignalingConnectionError
+
+ +
SignalingConnectionTimeoutError
+
+ +
SignalingIncomingMessageInvalidError
+
+ +
SignalingOutgoingMessageInvalidError
+
+ +
SignalingServerBusyError
+
+ +
StatsReport
+
+ +
Track
+
+ +
TrackInvalidError
+
+ +
TrackNameCharsInvalidError
+
+ +
TrackNameInvalidError
+
+ +
TrackNameIsDuplicatedError
+
+ +
TrackNameTooLongError
+
+ +
TrackPublication
+
+ +
TrackServerTrackCapacityReachedError
+
+ +
TrackStats
+
+ +
TwilioError
+
+ +
VideoTrack
+
+
+ + + + + + + + + + + + + +

Events

+ +
+ +
+
+

disabled

+ + +
+
+ + +
+

The AudioTrack was disabled, i.e. "muted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +AudioTrack + + + + +

The AudioTrack that was disabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The AudioTrack was enabled, i.e. "unmuted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +AudioTrack + + + + +

The AudioTrack that was enabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The AudioTrack started. This means there is enough audio data to +begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +AudioTrack + + + + +

The AudioTrack that started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

event

+ + +
+
+ + +
+

The SDK raised an EventListenerEvent.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
event + + +EventListenerEvent + + + + +

Context about the event raised by the SDK. +This can be one of the following:

+
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The LocalAudioTrack was disabled, i.e. the audio source was muted by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The LocalAudioTrack was enabled, i.e. the audio source was unmuted by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

muted

+ + +
+
+ + +
+

The LocalAudioTrack was muted because the audio source stopped sending samples, most +likely due to another application taking said audio source, especially on mobile devices.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was muted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The LocalAudioTrack started. This means there is enough audio data to +begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

stopped

+ + +
+
+ + +
+

The LocalAudioTrack stopped, either because LocalAudioTrack#stop +or LocalAudioTrack#restart was called or because the underlying +MediaStreamTrack ended.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that stopped

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unmuted

+ + +
+
+ + +
+

The LocalAudioTrack was unmuted because the audio source resumed sending samples, +most likely due to the application that took over the said audio source has released it +back to the application, especially on mobile devices. This event is also fired when +LocalAudioTrack#restart is called on a muted LocalAudioTrack with a +new audio source.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was unmuted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disconnected

+ + +
+
+ + +
+

The Participant has disconnected.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +Participant + + + + +

The Participant that disconnected.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

networkQualityLevelChanged

+ + +
+
+ + +
+

The Participant's NetworkQualityLevel changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
networkQualityLevel + + +NetworkQualityLevel + + + + + + + + + + +

The new +NetworkQualityLevel

networkQualityStats + + +NetworkQualityStats + + + + + + + + + <nullable>
+ + + +

The NetworkQualityStats +based on which NetworkQualityLevel is calculated, if any

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

The LocalParticipant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

The LocalParticipant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the LocalParticipant's LocalVideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

A LocalTrack was disabled by the LocalParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that was disabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

A LocalTrack was enabled by the LocalParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that was enabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublicationFailed

+ + +
+
+ + +
+

A LocalTrack failed to publish. Check the error message for more +information. In a Large Group Room (Maximum Participants greater than 50), +this event is raised with a ParticipantMaxTracksExceededError either +when attempting to publish the LocalTrack will exceed the Maximum Published +Tracks limit of 16, or the LocalTrack is part of a set of LocalTracks +which along with the published Tracks exceeds 16.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

A TwilioError explaining why publication +failed

localTrack + + +LocalTrack + + + + +

The LocalTrack that failed to +publish

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublished

+ + +
+
+ + +
+

A LocalTrack was successfully published.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +LocalTrackPublication + + + + +

The resulting +LocalTrackPublication for the published LocalTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTracks started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStopped

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTracks stopped, either +because LocalTrack#stop was called or because the underlying +MediaStreamTrack ended).

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that stopped

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackWarning

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that encountered the warning.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackWarningsCleared

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that cleared all warnings.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

dimensionsChanged

+ + +
+
+ + +
+

The VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack whose dimensions changed

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The LocalVideoTrack was disabled, i.e. the video source was paused by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The LocalVideoTrack was enabled, i.e. the video source was unpaused by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

muted

+ + +
+
+ + +
+

The LocalVideoTrack was muted because the video source stopped sending frames, most +likely due to another application taking said video source, especially on mobile devices.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was muted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The LocalVideoTrack started. This means there is enough video data +to begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

stopped

+ + +
+
+ + +
+

The LocalVideoTrack stopped, either because LocalVideoTrack#stop +or LocalVideoTrack#restart was called or because the underlying +MediaStreamTrack ended.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that stopped

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unmuted

+ + +
+
+ + +
+

The LocalVideoTrack was unmuted because the video source resumed sending frames, +most likely due to the application that took over the said video source has released it +back to the application, especially on mobile devices. This event is also fired when +LocalVideoTrack#restart is called on a muted LocalVideoTrack with a +new video source.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was unmuted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disconnected

+ + +
+
+ + +
+

The Participant has disconnected.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +Participant + + + + +

The Participant that disconnected.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

networkQualityLevelChanged

+ + +
+
+ + +
+

The Participant's NetworkQualityLevel changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
networkQualityLevel + + +NetworkQualityLevel + + + + + + + + + + +

The new +NetworkQualityLevel

networkQualityStats + + +NetworkQualityStats + + + + + + + + + <nullable>
+ + + +

The NetworkQualityStats +based on which NetworkQualityLevel is calculated, if any

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

The Participant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

The Participant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the Participant's VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of the Participant's Tracks started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +Track + + + + +

The Track that started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

completed

+ + +
+
+ + +
+

Preflight test has completed successfully.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
report + + +PreflightTestReport + + + + +

Results of the test.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

failed

+ + +
+
+ + +
+

Preflight test has encountered a failure and is now stopped.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError +| + +Error + + + + +

A TwilioError or a DOMException. +Possible TwilioErrors include Signaling and Media related errors which can be found +here.

report + + +PreflightTestReport + + + + +

Partial results gathered during the test. Use this information to help determine the cause of failure.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

progress

+ + +
+
+ + +
+

Emitted to indicate progress of the test

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
progress + + +PreflightProgress + + + + +

Indicates the status completed.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The RemoteAudioTrack was disabled, i.e. "muted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The RemoteAudioTrack was enabled, i.e. "unmuted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The RemoteAudioTrack started. This means there is enough audio data +to begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOff

+ + +
+
+ + +
+

A RemoteAudioTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOn

+ + +
+
+ + +
+

A RemoteAudioTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteAudioTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

the RemoteAudioTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteAudioTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteAudioTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The RemoteAudioTrack was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The RemoteAudioTrack was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteAudioTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

the RemoteAudioTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

message

+ + +
+
+ + +
+

A message was received over the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +string +| + +ArrayBuffer + + + + +
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack that received +the message

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOff

+ + +
+
+ + +
+

A RemoteDataTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack that was +switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOn

+ + +
+
+ + +
+

A RemoteDataTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack that was +switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

the RemoteDataTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteDataTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

the RemoteDataTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disconnected

+ + +
+
+ + +
+

The Participant has disconnected.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +Participant + + + + +

The Participant that disconnected.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

networkQualityLevelChanged

+ + +
+
+ + +
+

The Participant's NetworkQualityLevel changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
networkQualityLevel + + +NetworkQualityLevel + + + + + + + + + + +

The new +NetworkQualityLevel

networkQualityStats + + +NetworkQualityStats + + + + + + + + + <nullable>
+ + + +

The NetworkQualityStats +based on which NetworkQualityLevel is calculated, if any

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

The RemoteParticipant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

The RemoteParticipant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the RemoteParticipant's RemoteVideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

A RemoteTrack was disabled by the RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication associated with the disabled RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

A RemoteTrack was enabled by the RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication associated with the enabled RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackMessage

+ + +
+
+ + +
+

A message was received over one of the RemoteParticipant's +RemoteDataTracks.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +string +| + +ArrayBuffer + + + + +
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack over which the +message was received

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublished

+ + +
+
+ + +
+

A RemoteTrack was published by the RemoteParticipant after +connecting to the Room. This event is not emitted for +RemoteTracks that were published while the RemoteParticipant +was connecting to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the published RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
function trackPublished(publication) {
+  console.log(`Track ${publication.trackSid} was published`);
+}
+
+room.on('participantConnected', participant => {
+  // Handle RemoteTracks published while connecting to the Room.
+  participant.trackPublications.forEach(trackPublished);
+
+  // Handle RemoteTracks published after connecting to the Room.
+  participant.on('trackPublished', trackPublished);
+});
+ + + +
+ + + +
+
+

trackPublishPriorityChanged

+ + +
+
+ + +
+

The RemoteTrackPublication's publish Track.Priority was changed by the +RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the RemoteTrack's new publish +Track.Priority;

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that changed priority

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of the RemoteParticipant's RemoteTracks started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was subscribed to

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSubscriptionFailed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack could not be subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

The reason the RemoteTrack could not be +subscribed to

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that could not +be subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOff

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched off

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOn

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched on.

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnpublished

+ + +
+
+ + +
+

A RemoteTrack was unpublished by the RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the unpublished RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnsubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was unsubscribed from.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was unsubscribed from

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

publishPriorityChanged

+ + +
+
+ + +
+

The RemoteTrack's publish Track.Priority was changed by the +RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the RemoteTrack's new publish +Track.Priority; RemoteTrackPublication#publishPriority is also +updated accordingly

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The RemoteTrack was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The RemoteTrack was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOff

+ + +
+
+ + +
+

The RemoteTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOn

+ + +
+
+ + +
+

The RemoteTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

dimensionsChanged

+ + +
+
+ + +
+

The RemoteVideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack whose +dimensions changed

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The RemoteVideoTrack was disabled, i.e. "paused".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The RemoteVideoTrack was enabled, i.e. "resumed".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The RemoteVideoTrack started. This means there is enough video data +to begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOff

+ + +
+
+ + +
+

A RemoteVideoTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOn

+ + +
+
+ + +
+

A RemoteVideoTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteVideoTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

the RemoteVideoTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteVideoTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteVideoTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The RemoteVideoTrack was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The RemoteVideoTrack was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteVideoTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

the RemoteVideoTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disconnected

+ + +
+
+ + +
+

Your LocalParticipant was disconnected from the Room and all +other RemoteParticipants.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
room + + +Room + + + + + + + + + + +

The Room your +LocalParticipant was disconnected from

error + + +TwilioError + + + + + + + + + <nullable>
+ + + +

Present when the LocalParticipant got +disconnected from the Room unexpectedly

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('disconnected', function(room, error) {
+  if (error) {
+    console.log('Unexpectedly disconnected:', error);
+  }
+  myRoom.localParticipant.tracks.forEach(function(track) {
+    track.stop();
+    track.detach();
+  });
+});
+ + + +
+ + + +
+
+

dominantSpeakerChanged

+ + +
+
+ + +
+

The Dominant Speaker in the Room changed. Either the Dominant Speaker +is a new RemoteParticipant or the Dominant Speaker has been reset and +is now null.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
dominantSpeaker + + +RemoteParticipant + + + + + + + + + <nullable>
+ + + +

The Dominant Speaker in the +Room, if any

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

participantConnected

+ + +
+
+ + +
+

A RemoteParticipant joined the Room. In Large Group Rooms (Maximum +Participants greater than 50), this event is raised only when a RemoteParticipant +publishes at least one LocalTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant who joined

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantConnected', function(participant) {
+  console.log(participant.identity + ' joined the Room');
+});
+ + + +
+ + + +
+
+

participantDisconnected

+ + +
+
+ + +
+

A RemoteParticipant left the Room. In Large Group Rooms (Maximum +Participants greater than 50), this event is raised only when a RemoteParticipant +unpublishes all its LocalTracks.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant who left

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantDisconnected', function(participant) {
+  console.log(participant.identity + ' left the Room');
+  participant.tracks.forEach(function(track) {
+    track.detach().forEach(function(mediaElement) {
+      mediaElement.remove();
+    });
+  });
+});
+ + + +
+ + + +
+
+

participantReconnected

+ + +
+
+ + +
+

A RemoteParticipant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant that has reconnected.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantReconnected', participant => {
+  console.log(participant.identity + ' reconnected to the Room');
+});
+ + + +
+ + + +
+
+

participantReconnecting

+ + +
+
+ + +
+

A RemoteParticipant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant that is reconnecting.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantReconnecting', participant => {
+  console.log(participant.identity + ' is reconnecting to the Room');
+});
+ + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

Your application successfully reconnected to the Room. When this +event is emitted, the Room is in state "connected".

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('reconnected', () => {
+  console.log('Reconnected!');
+});
+ + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

Your application is reconnecting to the Room. This happens when there +is a disruption in your signaling connection and/or your media connection. When +this event is emitted, the Room is in state "reconnecting". If reconnecting +succeeds, the Room will emit a "reconnected" event.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +MediaConnectionError +| + +SignalingConnectionDisconnectedError + + + + +

A +MediaConnectionError if your application is reconnecting due to a +disruption in your media connection, or a SignalingConnectionDisconnectedError +if your application is reconnecting due to a disruption in your signaling connection

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('reconnecting', error => {
+  if (error.code === 53001) {
+    console.log('Reconnecting your signaling connection!', error.message);
+  } else if (error.code === 53405) {
+    console.log('Reconnecting your media connection!', error.message);
+  }
+});
+ + + +
+ + + +
+
+

recordingStarted

+ + +
+
+ + +
+

The Room is now being recorded

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

recordingStopped

+ + +
+
+ + +
+

The Room is no longer being recorded

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the RemoteParticipant's VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack whose dimensions changed

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteVideoTrack's dimensions changed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

A RemoteTrack was disabled by a RemoteParticipant in the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication that represents disabled RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +disabled the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

A RemoteTrack was enabled by a RemoteParticipant in the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication that represents enabled RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +enabled the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackMessage

+ + +
+
+ + +
+

A message was received over one of the RemoteParticipant's +RemoteDataTrack's.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +string +| + +ArrayBuffer + + + + +
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack over which the +message was received

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteDataTrack received the message

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublished

+ + +
+
+ + +
+

A RemoteTrack was published by a RemoteParticipant after +connecting to the Room. This event is not emitted for +RemoteTracks that were published while the RemoteParticipant +was connecting to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the published RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +published the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
function trackPublished(publication, participant) {
+  console.log(`RemoteParticipant ${participant.sid} published Track ${publication.trackSid}`);
+}
+
+// Handle RemoteTracks published after connecting to the Room.
+room.on('trackPublished', trackPublished);
+
+room.on('participantConnected', participant => {
+  // Handle RemoteTracks published while connecting to the Room.
+  participant.trackPublications.forEach(publication => trackPublished(publication, participant));
+});
+ + + +
+ + + +
+
+

trackPublishPriorityChanged

+ + +
+
+ + +
+

The RemoteTrack's publish Track.Priority was changed by the +RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the RemoteTrack's new publish +Track.Priority;

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that changed priority

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack changed priority

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of a RemoteParticipant's RemoteTracks in the Room started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that started

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was subscribed

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was subscribed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
room.on('trackSubscribed', function(track, publication, participant) {
+  var participantView = document.getElementById('participant-view-' + participant.identity);
+  participantView.appendChild(track.attach());
+});
+ + + +
+ + + +
+
+

trackSubscriptionFailed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack could not be subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

The reason the RemoteTrack could not be +subscribed to

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that could not +be subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack could not be subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOff

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched off

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOn

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched on

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnpublished

+ + +
+
+ + +
+

A RemoteTrack was unpublished by a RemoteParticipant to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the unpublished RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +unpublished the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnsubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was unsubscribed from.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was unsubscribed

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was unsubscribed from

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was unsubscribed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
room.on('trackUnsubscribed', function(track, publication, participant) {
+  track.detach().forEach(function(mediaElement) {
+    mediaElement.remove();
+  });
+});
+ + + +
+ + + +
+
+

trackWarning

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications in the Room encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that encountered the warning.

participant + + +LocalParticipant + + + + +

The LocalParticipant

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
room.on('trackWarning', (name, publication, participant) => {
+  if (name === 'recording-media-lost') {
+    log(`LocalTrack ${publication.track.name} is not recording media.`,
+      name, publication, participant);
+
+    // Wait a reasonable amount of time to clear the warning.
+    const timer = setTimeout(() => {
+      // If the warning is not cleared, you can manually
+      // reconnect to the room, or show a dialog to the user
+    }, 5000);
+
+    room.once('trackWarningsCleared', (publication, participant) => {
+      log('LocalTrack warnings have cleared!',
+        publication, participant);
+      clearTimeout(timer);
+    });
+  }
+});
+ + + +
+ + + +
+
+

trackWarningsCleared

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications in the Room cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that cleared all warnings.

participant + + +LocalParticipant + + + + +

The LocalParticipant

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

dimensionsChanged

+ + +
+
+ + +
+

The VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The VideoTrack was disabled, i.e. "paused".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack that was disabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The VideoTrack was enabled, i.e. "unpaused".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack that was enabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The VideoTrack started. This means there is enough video data to +begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack that started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/module-twilio-video.html b/dist/docs/module-twilio-video.html new file mode 100644 index 000000000..fb020b18b --- /dev/null +++ b/dist/docs/module-twilio-video.html @@ -0,0 +1,1557 @@ + + + + + + + Documentation Module: twilio-video + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Module: twilio-video

+
+ +
+ +
+ + +
+
+ + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
isSupported + + +boolean + + + + +

true if the current browser is officially +supported by twilio-video.js; In this context, "supported" means that +twilio-video.js has been extensively tested with this browser; This +table +specifies the list of officially supported browsers.

Logger + + +object + + + + +

The loglevel +module used by the SDK. Use this object to access the internal loggers and perform actions as defined by the +loglevel APIs. +See connect for examples.

version + + +string + + + + +

current version of twilio-video.js.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

<static> connect(token [, options])

+ + +
+
+ + +
+

Connect to a Room. +

+By default, this will automatically acquire an array containing a +LocalAudioTrack and LocalVideoTrack before connecting to +the Room. These will be stopped when you disconnect from the +Room. +

+You can override the default behavior by specifying +options. For example, rather than acquiring a +LocalAudioTrack and LocalVideoTrack automatically, you can +pass your own array which you can stop yourself. See ConnectOptions +for more information.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
token + + +string + + + + + + + + + + +

The Access Token string

options + + +ConnectOptions + + + + + + + <optional>
+ + + + + +

Options to override the default behavior, invalid options are ignored.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Throws:
+
    +
  • + +
    + + +RangeError + + + + +
    + +
    • + +
  • + +
    + + +TwilioError + + + + +
    + +
    • + +
  • + +
    + + +TypeError + + + + +
    + +
    • +
+ + +
Returns:
+ + + + +
+
+ Type +
+
+ +CancelablePromise.<Room> + + + +
+
+ + + + + +
Examples
+ + 
var Video = require('twilio-video');
+var token = getAccessToken();
+Video.connect(token, {
+  name: 'my-cool-room'
+}).then(function(room) {
+  room.on('participantConnected', function(participant) {
+    console.log(participant.identity + ' has connected');
+  });
+  room.once('disconnected', function() {
+    console.log('You left the Room:', room.name);
+  });
+}).catch(error => {
+  console.log('Could not connect to the Room:', error.message);
+});
+ + 
var Video = require('twilio-video');
+var token = getAccessToken();
+
+// Connect with audio-only
+Video.connect(token, {
+  name: 'my-cool-room',
+  audio: true
+}).then(function(room) {
+  room.on('participantConnected', function(participant) {
+    console.log(participant.identity + ' has connected');
+  });
+
+  room.once('disconnected', function() {
+    console.log('You left the Room:', room.name);
+  });
+}).catch(error => {
+  console.log('Could not connect to the Room:', error.message);
+});
+ + 
var Video = require('twilio-video');
+var token = getAccessToken();
+
+// Connect with media acquired using getUserMedia()
+navigator.mediaDevices.getUserMedia({
+  audio: true,
+  video: true
+}).then(function(mediaStream) {
+  return Video.connect(token, {
+    name: 'my-cool-room',
+    tracks: mediaStream.getTracks()
+  });
+}).then(function(room) {
+  room.on('participantConnected', function(participant) {
+    console.log(participant.identity + ' has connected');
+  });
+
+  room.once('disconnected', function() {
+    console.log('You left the Room:', room.name);
+  });
+}).catch(error => {
+  console.log('Could not connect to the Room:', error.message);
+});
+ + 
var Video = require('twilio-video');
+var token = getAccessToken();
+
+// Connect with custom names for LocalAudioTrack and LocalVideoTrack
+Video.connect(token, {
+  name: 'my-cool-room'
+  audio: { name: 'microphone' },
+  video: { name: 'camera' }
+}).then(function(room) {
+  room.localParticipants.trackPublications.forEach(function(publication) {
+    console.log('The LocalTrack "' + publication.trackName + '" was successfully published');
+  });
+}).catch(error => {
+  console.log('Could not connect to the Room:', error.message);
+});
+ + 
// Accessing the SDK logger
+var { Logger, connect } = require('twilio-video');
+var token = getAccessToken();
+
+var logger = Logger.getLogger('twilio-video');
+
+// Listen for logs
+var originalFactory = logger.methodFactory;
+logger.methodFactory = function (methodName, logLevel, loggerName) {
+  var method = originalFactory(methodName, logLevel, loggerName);
+
+  return function (datetime, logLevel, component, message, data) {
+    method(datetime, logLevel, component, message, data);
+    // Send to your own server
+    postDataToServer(arguments);
+  };
+};
+logger.setLevel('debug');
+
+connect(token, {
+  name: 'my-cool-room'
+}).then(function(room) {
+  room.on('participantConnected', function(participant) {
+    console.log(participant.identity + ' has connected');
+  });
+}).catch(error => {
+  console.log('Could not connect to the Room:', error.message);
+});
+ + + +
+ + + +
+
+

<static> createLocalAudioTrack( [options])

+ + +
+
+ + +
+

Request a LocalAudioTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
options + + +CreateLocalTracksOptions +| + +CreateLocalAudioTrackOptions + + + + + + + <optional>
+ + + + + +

Options for requesting a LocalAudioTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Promise.<LocalAudioTrack> + + + +
+
+ + + + + +
Examples
+ + 
var Video = require('twilio-video');
+
+// Connect to the Room with just video
+Video.connect('my-token', {
+  name: 'my-cool-room',
+  video: true
+}).then(function(room) {
+  // Add audio after connecting to the Room
+  Video.createLocalAudioTrack().then(function(localTrack) {
+    room.localParticipant.publishTrack(localTrack);
+  });
+});
+ + 
var Video = require('twilio-video');
+
+// Request the LocalAudioTrack with a custom name
+// and krisp noise cancellation
+Video.createLocalAudioTrack({
+  name: 'microphone',
+  noiseCancellationOptions: {
+     vendor: 'krisp',
+     sdkAssetsPath: '/twilio-krisp-audio-plugin/1.0.0/dist'
+  }
+});
+ + + +
+ + + +
+
+

<async, static> createLocalTracks( [options])

+ + +
+
+ + +
+

Request LocalTracks. By default, it requests a +LocalAudioTrack and a LocalVideoTrack. +Note that on 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.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
options + + +CreateLocalTracksOptions + + + + + + + <optional>
+ + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Promise.<Array.<LocalTrack>> + + + +
+
+ + + + + +
Examples
+ + 
var Video = require('twilio-video');
+// Request audio and video tracks
+Video.createLocalTracks().then(function(localTracks) {
+  var localMediaContainer = document.getElementById('local-media-container-id');
+  localTracks.forEach(function(track) {
+    localMediaContainer.appendChild(track.attach());
+  });
+});
+ + 
var Video = require('twilio-video');
+// Request just the default audio track
+Video.createLocalTracks({ audio: true }).then(function(localTracks) {
+  return Video.connect('my-token', {
+    name: 'my-cool-room',
+    tracks: localTracks
+  });
+});
+ + 
var Video = require('twilio-video');
+// Request the audio and video tracks with custom names
+Video.createLocalTracks({
+  audio: { name: 'microphone' },
+  video: { name: 'camera' }
+}).then(function(localTracks) {
+  localTracks.forEach(function(localTrack) {
+    console.log(localTrack.name);
+  });
+});
+ + 
var Video = require('twilio-video');
+var localTracks;
+
+// Pre-acquire tracks to display camera preview.
+Video.createLocalTracks().then(function(tracks) {
+ localTracks = tracks;
+ var localVideoTrack = localTracks.find(track => track.kind === 'video');
+ divContainer.appendChild(localVideoTrack.attach());
+})
+
+// Later, join the Room with the pre-acquired LocalTracks.
+Video.connect('token', {
+  name: 'my-cool-room',
+  tracks: localTracks
+});
+ + + +
+ + + +
+
+

<static> createLocalVideoTrack( [options])

+ + +
+
+ + +
+

Request a LocalVideoTrack. Note that on 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.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
options + + +CreateLocalTrackOptions + + + + + + + <optional>
+ + + + + +

Options for requesting a LocalVideoTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Promise.<LocalVideoTrack> + + + +
+
+ + + + + +
Examples
+ + 
var Video = require('twilio-video');
+
+// Connect to the Room with just audio
+Video.connect('my-token', {
+  name: 'my-cool-room',
+  audio: true
+}).then(function(room) {
+  // Add video after connecting to the Room
+  Video.createLocalVideoTrack().then(function(localTrack) {
+    room.localParticipant.publishTrack(localTrack);
+  });
+});
+ + 
var Video = require('twilio-video');
+
+// Request the default LocalVideoTrack with a custom name
+Video.createLocalVideoTrack({ name: 'camera' }).then(function(localTrack) {
+  console.log(localTrack.name); // 'camera'
+});
+ + + +
+ + + +
+
+

<static> runPreflight(token, options)

+ + +
+
+ + +
+

Run a preflight test. This method will start a test to check the quality of network connection.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
token + + +string + + + + +

The Access Token string

options + + +PreflightOptions + + + + +

Options for the test

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

preflightTest - An instance to be used to monitor progress of the test.

+
+ + + +
+
+ Type +
+
+ +PreflightTest + + + +
+
+ + + + + +
Example
+ + 
var { runPreflight } = require('twilio-video');
+var preflight = runPreflight(token, preflightOptions);
+preflightTest.on('progress', progress => {
+  console.log('preflight progress:', progress);
+});
+
+preflightTest.on('failed', (error, report) => {
+  console.error('preflight error:', error, report);
+});
+
+preflightTest.on('completed', report => {
+  console.log('preflight completed:', report));
+});
+ + + +
+ +
+ + + + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/modules.list.html b/dist/docs/modules.list.html new file mode 100644 index 000000000..6a48a4c4f --- /dev/null +++ b/dist/docs/modules.list.html @@ -0,0 +1,18511 @@ + + + + + + + Documentation Modules + + + + + + + + + + +
+
+
+ Documentation + +
+ + +
+
+ + +
+
+ + +
+ +
+ + +

Modules

+
+ +
+ +

+ +

+ + +
+ + +
+
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +

Classes

+ +
+
AccessTokenExpiredError
+
+ +
AccessTokenGrantsInvalidError
+
+ +
AccessTokenHeaderInvalidError
+
+ +
AccessTokenInvalidError
+
+ +
AccessTokenIssuerInvalidError
+
+ +
AccessTokenNotYetValidError
+
+ +
AccessTokenSignatureInvalidError
+
+ +
AudioTrack
+
+ +
ConfigurationAcquireFailedError
+
+ +
ConfigurationAcquireTurnFailedError
+
+ +
LocalAudioTrack
+
+ +
LocalAudioTrackPublication
+
+ +
LocalAudioTrackStats
+
+ +
LocalDataTrack
+
+ +
LocalDataTrackPublication
+
+ +
LocalParticipant
+
+ +
LocalTrackPublication
+
+ +
LocalTrackStats
+
+ +
LocalVideoTrack
+
+ +
LocalVideoTrackPublication
+
+ +
LocalVideoTrackStats
+
+ +
MediaClientLocalDescFailedError
+
+ +
MediaClientRemoteDescFailedError
+
+ +
MediaConnectionError
+
+ +
MediaDTLSTransportFailedError
+
+ +
MediaNoSupportedCodecError
+
+ +
MediaServerLocalDescFailedError
+
+ +
MediaServerRemoteDescFailedError
+
+ +
NetworkQualityAudioStats
+
+ +
NetworkQualityBandwidthStats
+
+ +
NetworkQualityFractionLostStats
+
+ +
NetworkQualityLatencyStats
+
+ +
NetworkQualityMediaStats
+
+ +
NetworkQualityRecvStats
+
+ +
NetworkQualitySendOrRecvStats
+
+ +
NetworkQualitySendStats
+
+ +
NetworkQualityStats
+
+ +
NetworkQualityVideoStats
+
+ +
Participant
+
+ +
ParticipantDuplicateIdentityError
+
+ +
ParticipantIdentityCharsInvalidError
+
+ +
ParticipantIdentityInvalidError
+
+ +
ParticipantIdentityTooLongError
+
+ +
ParticipantMaxTracksExceededError
+
+ +
ParticipantNotFoundError
+
+ +
PreflightTest
+
+ +
RemoteAudioTrack
+
+ +
RemoteAudioTrackPublication
+
+ +
RemoteAudioTrackStats
+
+ +
RemoteDataTrack
+
+ +
RemoteDataTrackPublication
+
+ +
RemoteParticipant
+
+ +
RemoteTrackPublication
+
+ +
RemoteTrackStats
+
+ +
RemoteVideoTrack
+
+ +
RemoteVideoTrackPublication
+
+ +
RemoteVideoTrackStats
+
+ +
Room
+
+ +
RoomAudioOnlyFlagNotSupportedError
+
+ +
RoomCompletedError
+
+ +
RoomConnectFailedError
+
+ +
RoomCreateFailedError
+
+ +
RoomInvalidParametersError
+
+ +
RoomMaxParticipantsExceededError
+
+ +
RoomMaxParticipantsOutOfRangeError
+
+ +
RoomMediaRegionInvalidError
+
+ +
RoomMediaRegionUnavailableError
+
+ +
RoomNameCharsInvalidError
+
+ +
RoomNameInvalidError
+
+ +
RoomNameTooLongError
+
+ +
RoomNotFoundError
+
+ +
RoomRoomExistsError
+
+ +
RoomStatusCallbackInvalidError
+
+ +
RoomStatusCallbackMethodInvalidError
+
+ +
RoomStatusInvalidError
+
+ +
RoomSubscriptionOperationNotSupportedError
+
+ +
RoomTimeoutOutOfRangeError
+
+ +
RoomTrackKindNotSupportedError
+
+ +
RoomTypeInvalidError
+
+ +
SignalingConnectionDisconnectedError
+
+ +
SignalingConnectionError
+
+ +
SignalingConnectionTimeoutError
+
+ +
SignalingIncomingMessageInvalidError
+
+ +
SignalingOutgoingMessageInvalidError
+
+ +
SignalingServerBusyError
+
+ +
StatsReport
+
+ +
Track
+
+ +
TrackInvalidError
+
+ +
TrackNameCharsInvalidError
+
+ +
TrackNameInvalidError
+
+ +
TrackNameIsDuplicatedError
+
+ +
TrackNameTooLongError
+
+ +
TrackPublication
+
+ +
TrackServerTrackCapacityReachedError
+
+ +
TrackStats
+
+ +
TwilioError
+
+ +
VideoTrack
+
+
+ + + + + + + + + + + + + +

Events

+ +
+ +
+
+

disabled

+ + +
+
+ + +
+

The AudioTrack was disabled, i.e. "muted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +AudioTrack + + + + +

The AudioTrack that was disabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The AudioTrack was enabled, i.e. "unmuted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +AudioTrack + + + + +

The AudioTrack that was enabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The AudioTrack started. This means there is enough audio data to +begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +AudioTrack + + + + +

The AudioTrack that started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

event

+ + +
+
+ + +
+

The SDK raised an EventListenerEvent.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
event + + +EventListenerEvent + + + + +

Context about the event raised by the SDK. +This can be one of the following:

+
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The LocalAudioTrack was disabled, i.e. the audio source was muted by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The LocalAudioTrack was enabled, i.e. the audio source was unmuted by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

muted

+ + +
+
+ + +
+

The LocalAudioTrack was muted because the audio source stopped sending samples, most +likely due to another application taking said audio source, especially on mobile devices.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was muted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The LocalAudioTrack started. This means there is enough audio data to +begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

stopped

+ + +
+
+ + +
+

The LocalAudioTrack stopped, either because LocalAudioTrack#stop +or LocalAudioTrack#restart was called or because the underlying +MediaStreamTrack ended.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that stopped

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unmuted

+ + +
+
+ + +
+

The LocalAudioTrack was unmuted because the audio source resumed sending samples, +most likely due to the application that took over the said audio source has released it +back to the application, especially on mobile devices. This event is also fired when +LocalAudioTrack#restart is called on a muted LocalAudioTrack with a +new audio source.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalAudioTrack + + + + +

The LocalAudioTrack that was unmuted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disconnected

+ + +
+
+ + +
+

The Participant has disconnected.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +Participant + + + + +

The Participant that disconnected.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

networkQualityLevelChanged

+ + +
+
+ + +
+

The Participant's NetworkQualityLevel changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
networkQualityLevel + + +NetworkQualityLevel + + + + + + + + + + +

The new +NetworkQualityLevel

networkQualityStats + + +NetworkQualityStats + + + + + + + + + <nullable>
+ + + +

The NetworkQualityStats +based on which NetworkQualityLevel is calculated, if any

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

The LocalParticipant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

The LocalParticipant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the LocalParticipant's LocalVideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

A LocalTrack was disabled by the LocalParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that was disabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

A LocalTrack was enabled by the LocalParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that was enabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublicationFailed

+ + +
+
+ + +
+

A LocalTrack failed to publish. Check the error message for more +information. In a Large Group Room (Maximum Participants greater than 50), +this event is raised with a ParticipantMaxTracksExceededError either +when attempting to publish the LocalTrack will exceed the Maximum Published +Tracks limit of 16, or the LocalTrack is part of a set of LocalTracks +which along with the published Tracks exceeds 16.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

A TwilioError explaining why publication +failed

localTrack + + +LocalTrack + + + + +

The LocalTrack that failed to +publish

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublished

+ + +
+
+ + +
+

A LocalTrack was successfully published.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +LocalTrackPublication + + + + +

The resulting +LocalTrackPublication for the published LocalTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTracks started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStopped

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTracks stopped, either +because LocalTrack#stop was called or because the underlying +MediaStreamTrack ended).

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalTrack + + + + +

The LocalTrack that stopped

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackWarning

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that encountered the warning.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackWarningsCleared

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that cleared all warnings.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

dimensionsChanged

+ + +
+
+ + +
+

The VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack whose dimensions changed

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The LocalVideoTrack was disabled, i.e. the video source was paused by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The LocalVideoTrack was enabled, i.e. the video source was unpaused by the user.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

muted

+ + +
+
+ + +
+

The LocalVideoTrack was muted because the video source stopped sending frames, most +likely due to another application taking said video source, especially on mobile devices.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was muted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The LocalVideoTrack started. This means there is enough video data +to begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

stopped

+ + +
+
+ + +
+

The LocalVideoTrack stopped, either because LocalVideoTrack#stop +or LocalVideoTrack#restart was called or because the underlying +MediaStreamTrack ended.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that stopped

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unmuted

+ + +
+
+ + +
+

The LocalVideoTrack was unmuted because the video source resumed sending frames, +most likely due to the application that took over the said video source has released it +back to the application, especially on mobile devices. This event is also fired when +LocalVideoTrack#restart is called on a muted LocalVideoTrack with a +new video source.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +LocalVideoTrack + + + + +

The LocalVideoTrack that was unmuted

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warning

+ + +
+
+ + +
+

The published LocalTrack encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

warningsCleared

+ + +
+
+ + +
+

The published LocalTrack cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disconnected

+ + +
+
+ + +
+

The Participant has disconnected.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +Participant + + + + +

The Participant that disconnected.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

networkQualityLevelChanged

+ + +
+
+ + +
+

The Participant's NetworkQualityLevel changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
networkQualityLevel + + +NetworkQualityLevel + + + + + + + + + + +

The new +NetworkQualityLevel

networkQualityStats + + +NetworkQualityStats + + + + + + + + + <nullable>
+ + + +

The NetworkQualityStats +based on which NetworkQualityLevel is calculated, if any

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

The Participant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

The Participant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the Participant's VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of the Participant's Tracks started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +Track + + + + +

The Track that started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

completed

+ + +
+
+ + +
+

Preflight test has completed successfully.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
report + + +PreflightTestReport + + + + +

Results of the test.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

failed

+ + +
+
+ + +
+

Preflight test has encountered a failure and is now stopped.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError +| + +Error + + + + +

A TwilioError or a DOMException. +Possible TwilioErrors include Signaling and Media related errors which can be found +here.

report + + +PreflightTestReport + + + + +

Partial results gathered during the test. Use this information to help determine the cause of failure.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

progress

+ + +
+
+ + +
+

Emitted to indicate progress of the test

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
progress + + +PreflightProgress + + + + +

Indicates the status completed.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The RemoteAudioTrack was disabled, i.e. "muted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The RemoteAudioTrack was enabled, i.e. "unmuted".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The RemoteAudioTrack started. This means there is enough audio data +to begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOff

+ + +
+
+ + +
+

A RemoteAudioTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOn

+ + +
+
+ + +
+

A RemoteAudioTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

The RemoteAudioTrack that was +switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteAudioTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

the RemoteAudioTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteAudioTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteAudioTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The RemoteAudioTrack was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The RemoteAudioTrack was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteAudioTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteAudioTrack + + + + +

the RemoteAudioTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

message

+ + +
+
+ + +
+

A message was received over the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +string +| + +ArrayBuffer + + + + +
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack that received +the message

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOff

+ + +
+
+ + +
+

A RemoteDataTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack that was +switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOn

+ + +
+
+ + +
+

A RemoteDataTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack that was +switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

the RemoteDataTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteDataTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteDataTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteDataTrack + + + + +

the RemoteDataTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disconnected

+ + +
+
+ + +
+

The Participant has disconnected.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +Participant + + + + +

The Participant that disconnected.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

networkQualityLevelChanged

+ + +
+
+ + +
+

The Participant's NetworkQualityLevel changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
networkQualityLevel + + +NetworkQualityLevel + + + + + + + + + + +

The new +NetworkQualityLevel

networkQualityStats + + +NetworkQualityStats + + + + + + + + + <nullable>
+ + + +

The NetworkQualityStats +based on which NetworkQualityLevel is calculated, if any

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

The RemoteParticipant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

The RemoteParticipant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the RemoteParticipant's RemoteVideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

A RemoteTrack was disabled by the RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication associated with the disabled RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

A RemoteTrack was enabled by the RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication associated with the enabled RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackMessage

+ + +
+
+ + +
+

A message was received over one of the RemoteParticipant's +RemoteDataTracks.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +string +| + +ArrayBuffer + + + + +
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack over which the +message was received

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublished

+ + +
+
+ + +
+

A RemoteTrack was published by the RemoteParticipant after +connecting to the Room. This event is not emitted for +RemoteTracks that were published while the RemoteParticipant +was connecting to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the published RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
function trackPublished(publication) {
+  console.log(`Track ${publication.trackSid} was published`);
+}
+
+room.on('participantConnected', participant => {
+  // Handle RemoteTracks published while connecting to the Room.
+  participant.trackPublications.forEach(trackPublished);
+
+  // Handle RemoteTracks published after connecting to the Room.
+  participant.on('trackPublished', trackPublished);
+});
+ + + +
+ + + +
+
+

trackPublishPriorityChanged

+ + +
+
+ + +
+

The RemoteTrackPublication's publish Track.Priority was changed by the +RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the RemoteTrack's new publish +Track.Priority;

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that changed priority

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of the RemoteParticipant's RemoteTracks started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was subscribed to

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSubscriptionFailed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack could not be subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

The reason the RemoteTrack could not be +subscribed to

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that could not +be subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOff

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched off

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOn

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched on.

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnpublished

+ + +
+
+ + +
+

A RemoteTrack was unpublished by the RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the unpublished RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnsubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was unsubscribed from.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was unsubscribed from

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

publishPriorityChanged

+ + +
+
+ + +
+

The RemoteTrack's publish Track.Priority was changed by the +RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the RemoteTrack's new publish +Track.Priority; RemoteTrackPublication#publishPriority is also +updated accordingly

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The RemoteTrack was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The RemoteTrack was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOff

+ + +
+
+ + +
+

The RemoteTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOn

+ + +
+
+ + +
+

The RemoteTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

the RemoteTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

dimensionsChanged

+ + +
+
+ + +
+

The RemoteVideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack whose +dimensions changed

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The RemoteVideoTrack was disabled, i.e. "paused".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +disabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The RemoteVideoTrack was enabled, i.e. "resumed".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +enabled

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The RemoteVideoTrack started. This means there is enough video data +to begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that started

+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOff

+ + +
+
+ + +
+

A RemoteVideoTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

switchedOn

+ + +
+
+ + +
+

A RemoteVideoTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack that was +switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscribed

+ + +
+
+ + +
+

Your LocalParticipant subscribed to the RemoteVideoTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

the RemoteVideoTrack that was subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

subscriptionFailed

+ + +
+
+ + +
+

Your LocalParticipant failed to subscribe to the RemoteVideoTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

the reason the RemoteVideoTrack could not be +subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The RemoteVideoTrack was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The RemoteVideoTrack was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

unsubscribed

+ + +
+
+ + +
+

Your LocalParticipant unsubscribed from the RemoteVideoTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

the RemoteVideoTrack that was unsubscribed from

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disconnected

+ + +
+
+ + +
+

Your LocalParticipant was disconnected from the Room and all +other RemoteParticipants.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
room + + +Room + + + + + + + + + + +

The Room your +LocalParticipant was disconnected from

error + + +TwilioError + + + + + + + + + <nullable>
+ + + +

Present when the LocalParticipant got +disconnected from the Room unexpectedly

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('disconnected', function(room, error) {
+  if (error) {
+    console.log('Unexpectedly disconnected:', error);
+  }
+  myRoom.localParticipant.tracks.forEach(function(track) {
+    track.stop();
+    track.detach();
+  });
+});
+ + + +
+ + + +
+
+

dominantSpeakerChanged

+ + +
+
+ + +
+

The Dominant Speaker in the Room changed. Either the Dominant Speaker +is a new RemoteParticipant or the Dominant Speaker has been reset and +is now null.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
dominantSpeaker + + +RemoteParticipant + + + + + + + + + <nullable>
+ + + +

The Dominant Speaker in the +Room, if any

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

participantConnected

+ + +
+
+ + +
+

A RemoteParticipant joined the Room. In Large Group Rooms (Maximum +Participants greater than 50), this event is raised only when a RemoteParticipant +publishes at least one LocalTrack.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant who joined

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantConnected', function(participant) {
+  console.log(participant.identity + ' joined the Room');
+});
+ + + +
+ + + +
+
+

participantDisconnected

+ + +
+
+ + +
+

A RemoteParticipant left the Room. In Large Group Rooms (Maximum +Participants greater than 50), this event is raised only when a RemoteParticipant +unpublishes all its LocalTracks.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant who left

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantDisconnected', function(participant) {
+  console.log(participant.identity + ' left the Room');
+  participant.tracks.forEach(function(track) {
+    track.detach().forEach(function(mediaElement) {
+      mediaElement.remove();
+    });
+  });
+});
+ + + +
+ + + +
+
+

participantReconnected

+ + +
+
+ + +
+

A RemoteParticipant has reconnected to the Room after a signaling connection disruption.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant that has reconnected.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantReconnected', participant => {
+  console.log(participant.identity + ' reconnected to the Room');
+});
+ + + +
+ + + +
+
+

participantReconnecting

+ + +
+
+ + +
+

A RemoteParticipant is reconnecting to the Room after a signaling connection disruption.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
participant + + +RemoteParticipant + + + + +

The RemoteParticipant that is reconnecting.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('participantReconnecting', participant => {
+  console.log(participant.identity + ' is reconnecting to the Room');
+});
+ + + +
+ + + +
+
+

reconnected

+ + +
+
+ + +
+

Your application successfully reconnected to the Room. When this +event is emitted, the Room is in state "connected".

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('reconnected', () => {
+  console.log('Reconnected!');
+});
+ + + +
+ + + +
+
+

reconnecting

+ + +
+
+ + +
+

Your application is reconnecting to the Room. This happens when there +is a disruption in your signaling connection and/or your media connection. When +this event is emitted, the Room is in state "reconnecting". If reconnecting +succeeds, the Room will emit a "reconnected" event.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +MediaConnectionError +| + +SignalingConnectionDisconnectedError + + + + +

A +MediaConnectionError if your application is reconnecting due to a +disruption in your media connection, or a SignalingConnectionDisconnectedError +if your application is reconnecting due to a disruption in your signaling connection

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
myRoom.on('reconnecting', error => {
+  if (error.code === 53001) {
+    console.log('Reconnecting your signaling connection!', error.message);
+  } else if (error.code === 53405) {
+    console.log('Reconnecting your media connection!', error.message);
+  }
+});
+ + + +
+ + + +
+
+

recordingStarted

+ + +
+
+ + +
+

The Room is now being recorded

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

recordingStopped

+ + +
+
+ + +
+

The Room is no longer being recorded

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDimensionsChanged

+ + +
+
+ + +
+

One of the RemoteParticipant's VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteVideoTrack + + + + +

The RemoteVideoTrack whose dimensions changed

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteVideoTrack's dimensions changed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

A RemoteTrack was disabled by a RemoteParticipant in the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication that represents disabled RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +disabled the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

A RemoteTrack was enabled by a RemoteParticipant in the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication that represents enabled RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +enabled the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackMessage

+ + +
+
+ + +
+

A message was received over one of the RemoteParticipant's +RemoteDataTrack's.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + + +string +| + +ArrayBuffer + + + + +
track + + +RemoteDataTrack + + + + +

The RemoteDataTrack over which the +message was received

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteDataTrack received the message

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackPublished

+ + +
+
+ + +
+

A RemoteTrack was published by a RemoteParticipant after +connecting to the Room. This event is not emitted for +RemoteTracks that were published while the RemoteParticipant +was connecting to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the published RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +published the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
function trackPublished(publication, participant) {
+  console.log(`RemoteParticipant ${participant.sid} published Track ${publication.trackSid}`);
+}
+
+// Handle RemoteTracks published after connecting to the Room.
+room.on('trackPublished', trackPublished);
+
+room.on('participantConnected', participant => {
+  // Handle RemoteTracks published while connecting to the Room.
+  participant.trackPublications.forEach(publication => trackPublished(publication, participant));
+});
+ + + +
+ + + +
+
+

trackPublishPriorityChanged

+ + +
+
+ + +
+

The RemoteTrack's publish Track.Priority was changed by the +RemoteParticipant.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
priority + + +Track.Priority + + + + +

the RemoteTrack's new publish +Track.Priority;

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that changed priority

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack changed priority

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackStarted

+ + +
+
+ + +
+

One of a RemoteParticipant's RemoteTracks in the Room started.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that started

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was subscribed

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was subscribed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
room.on('trackSubscribed', function(track, publication, participant) {
+  var participantView = document.getElementById('participant-view-' + participant.identity);
+  participantView.appendChild(track.attach());
+});
+ + + +
+ + + +
+
+

trackSubscriptionFailed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack could not be subscribed to.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
error + + +TwilioError + + + + +

The reason the RemoteTrack could not be +subscribed to

publication + + +RemoteTrackPublication + + + + +

The +RemoteTrackPublication for the RemoteTrack that could not +be subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack could not be subscribed to

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOff

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was switched off.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched off

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was switched off

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackSwitchedOn

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was switched on.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was switched on

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was subscribed to

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was switched on

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnpublished

+ + +
+
+ + +
+

A RemoteTrack was unpublished by a RemoteParticipant to the Room.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +which represents the unpublished RemoteTrack

participant + + +RemoteParticipant + + + + +

The RemoteParticipant who +unpublished the RemoteTrack

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackUnsubscribed

+ + +
+
+ + +
+

A RemoteParticipant's RemoteTrack was unsubscribed from.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +RemoteTrack + + + + +

The RemoteTrack that was unsubscribed

publication + + +RemoteTrackPublication + + + + +

The RemoteTrackPublication +for the RemoteTrack that was unsubscribed from

participant + + +RemoteParticipant + + + + +

The RemoteParticipant whose +RemoteTrack was unsubscribed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
room.on('trackUnsubscribed', function(track, publication, participant) {
+  track.detach().forEach(function(mediaElement) {
+    mediaElement.remove();
+  });
+});
+ + + +
+ + + +
+
+

trackWarning

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications in the Room encountered a warning. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

The warning that was raised.

publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that encountered the warning.

participant + + +LocalParticipant + + + + +

The LocalParticipant

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
Example
+ + 
room.on('trackWarning', (name, publication, participant) => {
+  if (name === 'recording-media-lost') {
+    log(`LocalTrack ${publication.track.name} is not recording media.`,
+      name, publication, participant);
+
+    // Wait a reasonable amount of time to clear the warning.
+    const timer = setTimeout(() => {
+      // If the warning is not cleared, you can manually
+      // reconnect to the room, or show a dialog to the user
+    }, 5000);
+
+    room.once('trackWarningsCleared', (publication, participant) => {
+      log('LocalTrack warnings have cleared!',
+        publication, participant);
+      clearTimeout(timer);
+    });
+  }
+});
+ + + +
+ + + +
+
+

trackWarningsCleared

+ + +
+
+ + +
+

One of the LocalParticipant's LocalTrackPublications in the Room cleared all warnings. +This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
publication + + +LocalTrackPublication + + + + +

The LocalTrackPublication that cleared all warnings.

participant + + +LocalParticipant + + + + +

The LocalParticipant

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackDisabled

+ + +
+
+ + +
+

The published Track was disabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

trackEnabled

+ + +
+
+ + +
+

The published Track was enabled.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

dimensionsChanged

+ + +
+
+ + +
+

The VideoTrack's dimensions changed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack whose dimensions changed

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

disabled

+ + +
+
+ + +
+

The VideoTrack was disabled, i.e. "paused".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack that was disabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

enabled

+ + +
+
+ + +
+

The VideoTrack was enabled, i.e. "unpaused".

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack that was enabled

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

started

+ + +
+
+ + +
+

The VideoTrack started. This means there is enough video data to +begin playback.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
track + + +VideoTrack + + + + +

The VideoTrack that started

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/dist/docs/quicksearch.html b/dist/docs/quicksearch.html new file mode 100644 index 000000000..24dbf7fa1 --- /dev/null +++ b/dist/docs/quicksearch.html @@ -0,0 +1,31 @@ + + + + + + + + + + + + + diff --git a/dist/docs/scripts/docstrap.lib.js b/dist/docs/scripts/docstrap.lib.js new file mode 100644 index 000000000..09d9272a0 --- /dev/null +++ b/dist/docs/scripts/docstrap.lib.js @@ -0,0 +1,11 @@ +if(!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){function c(a){var b="length"in a&&a.length,c=_.type(a);return"function"!==c&&!_.isWindow(a)&&(!(1!==a.nodeType||!b)||("array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a))}function d(a,b,c){if(_.isFunction(b))return _.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return _.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(ha.test(b))return _.filter(b,a,c);b=_.filter(b,a)}return _.grep(a,function(a){return U.call(b,a)>=0!==c})}function e(a,b){for(;(a=a[b])&&1!==a.nodeType;);return a}function f(a){var b=oa[a]={};return _.each(a.match(na)||[],function(a,c){b[c]=!0}),b}function g(){Z.removeEventListener("DOMContentLoaded",g,!1),a.removeEventListener("load",g,!1),_.ready()}function h(){Object.defineProperty(this.cache={},0,{get:function(){return{}}}),this.expando=_.expando+h.uid++}function i(a,b,c){var d;if(void 0===c&&1===a.nodeType)if(d="data-"+b.replace(ua,"-$1").toLowerCase(),c=a.getAttribute(d),"string"==typeof c){try{c="true"===c||"false"!==c&&("null"===c?null:+c+""===c?+c:ta.test(c)?_.parseJSON(c):c)}catch(a){}sa.set(a,b,c)}else c=void 0;return c}function j(){return!0}function k(){return!1}function l(){try{return Z.activeElement}catch(a){}}function m(a,b){return _.nodeName(a,"table")&&_.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function n(a){return a.type=(null!==a.getAttribute("type"))+"/"+a.type,a}function o(a){var b=Ka.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function p(a,b){for(var c=0,d=a.length;d>c;c++)ra.set(a[c],"globalEval",!b||ra.get(b[c],"globalEval"))}function q(a,b){var c,d,e,f,g,h,i,j;if(1===b.nodeType){if(ra.hasData(a)&&(f=ra.access(a),g=ra.set(b,f),j=f.events)){delete g.handle,g.events={};for(e in j)for(c=0,d=j[e].length;d>c;c++)_.event.add(b,e,j[e][c])}sa.hasData(a)&&(h=sa.access(a),i=_.extend({},h),sa.set(b,i))}}function r(a,b){var c=a.getElementsByTagName?a.getElementsByTagName(b||"*"):a.querySelectorAll?a.querySelectorAll(b||"*"):[];return void 0===b||b&&_.nodeName(a,b)?_.merge([a],c):c}function s(a,b){var c=b.nodeName.toLowerCase();"input"===c&&ya.test(a.type)?b.checked=a.checked:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}function t(b,c){var d,e=_(c.createElement(b)).appendTo(c.body),f=a.getDefaultComputedStyle&&(d=a.getDefaultComputedStyle(e[0]))?d.display:_.css(e[0],"display");return e.detach(),f}function u(a){var b=Z,c=Oa[a];return c||(c=t(a,b),"none"!==c&&c||(Na=(Na||_("