Members
AdapterJS
AdapterJS provides polyfills and cross-browser mediaStreamHelpers for WebRTC.
- Source:
- See:
io
Socket.IO enables real-time, bidirectional and event-based communication. It works on every platform, browser or device, focusing equally on reliability and speed.
- Source:
- See:
Type Definitions
audioStats :Object
The Peer connection audio streaming statistics.
Properties:
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
audioStats.sending |
JSON |
The Peer connection sending audio streaming statistics. Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
audioStats.receiving |
JSON |
The Peer connection receiving audio streaming statistics. Properties
|
codecParams :Object
Note that some of these parameters are mainly used for experimental or debugging purposes. Toggling any of these feature may result in disruptions in connectivity.
Properties:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
video |
JSON |
<optional> |
The video codecs parameters to configure. Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
audio |
JSON |
<optional> |
The audio codecs parameters to configure. Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
minptime |
number |
<optional> |
Note that this parameter should only be used for debugging purposes only.The OPUS audio codec receiving audio data decoder minimum length of time in milleseconds should be encapsulated in a single received encoded audio data packet. This value must be between 3 to 120
When not provided, the default browser configuration is used.
|
- Source:
customSettings :Object
Properties:
Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
settings |
Object |
The peer stream and data settings. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mediaStatus |
Object |
The peer streaming media status. Properties
|
- Source:
dataChannelInfo :Object
Properties:
Name | Type | Description |
---|---|---|
channelName |
String |
The data channel id. |
channelProp |
String |
The data channel property. |
channelType |
String |
The data channel type. |
currentTransferId |
String |
The data channel connection
current progressing transfer session. Defined as |
currentStreamId |
String |
The data channel connection
current data streaming session id. Defined as |
readyState |
String |
The data channel connection readyState. |
bufferedAmountLow |
String |
The data channel buffered amount. |
bufferedAmountLowThreshold |
String |
The data channel buffered amount threshold. |
- Source:
GetUserMediaOptions :Object
The camera Stream configuration options.
Properties:
Name | Type | Attributes | Default | Description | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options.useExactConstraints |
boolean |
<optional> |
false |
Note that by enabling this flag, exact values will be requested when retrieving camera Stream,
but it does not prevent constraints related errors. By default when not enabled,
expected mandatory maximum values (or optional values for source ID) will requested to prevent constraints related
errors, with an exception for |
|||||||||||||||||||||||||||||||||||||||||||||||
options.audio |
boolean | JSON |
<optional> |
false |
Note that the current Edge browser implementation does not support the Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||
options.video |
boolean | JSON |
<optional> |
false |
Note that the current Edge browser implementation does not support the Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||
callback |
function |
<optional> |
The callback function fired when request has completed.
Function parameters signature is Properties
|
- Source:
initOptions :Object
When provided as a string, it's configured as appKey
.
Properties:
Name | Type | Attributes | Default | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
appKey |
String |
The App Key. By default, |
||||||||||||||||||||||||
defaultRoom |
String |
<optional> |
appKey |
The default Room to connect to when no |
||||||||||||||||||||||
roomServer |
String |
<optional> |
The Auth server for debugging purposes to use. Note that this is a debugging feature and is only used when instructed for debugging purposes. |
|||||||||||||||||||||||
enableStatsGathering |
boolean |
<optional> |
true |
Configure the anonymous performance and connectivity statistic collection function. Temasys collects encrypted, anonymous performance and connectivity statistics to allow us to improve performance for our customers and identify regional or ISP specific connectivity issues. This data does not contain any personal information or session content. To enable the configuration of this option, you need to "Collect Quality Statistics" option on the Temasys console Website under App key settings section. |
||||||||||||||||||||||
enableDataChannel |
boolean |
<optional> |
true |
The flag if Datachannel connections should be enabled. Note that for Edge browsers, this value is overriden as |
||||||||||||||||||||||
enableTURNServer |
boolean |
<optional> |
true |
The flag if TURN ICE servers should be used when constructing Peer connections to allow TURN connections when required and enabled for the App Key. |
||||||||||||||||||||||
enableSTUNServer |
boolean |
<optional> |
true |
The flag if STUN ICE servers should be used when constructing Peer connections to allow TURN connections when required. |
||||||||||||||||||||||
forceTURN |
boolean |
<optional> |
false |
The flag if Peer connections should enforce connections over the TURN server. This overrides |
||||||||||||||||||||||
TURNServerTransport |
boolean |
<optional> |
Note that configuring the protocol may not necessarily result in the desired network transports protocol
used in the actual TURN network traffic as it depends which protocol the browser selects and connects with.
This simply configures the TURN ICE server urls <code?transport=(protocol) query option when constructing
the Peer connection. When all protocols are selected, the ICE servers urls are duplicated with all protocols.
Note that for Edge browsers, this value is overriden as The option to configure the ?transport=
query parameter in TURN ICE servers when constructing a Peer connections. When not provided, its value is ANY .
Skylink.TURN_TRANSPORT
|
|||||||||||||||||||||||
disableVideoFecCodecs |
boolean |
<optional> |
false |
Note that this is an experimental flag and may cause disruptions in connections or connectivity issues when toggled, and to prevent connectivity issues, these codecs will not be removed for MCU enabled Peer connections.The flag if video FEC (Forward Error Correction) codecs like ulpfec and red should be removed in sending session descriptions. This can be useful for debugging purposes to prevent redundancy and overheads in RTP encoding. |
||||||||||||||||||||||
disableComfortNoiseCodec |
boolean |
<optional> |
false |
Note that this is an experimental flag and may cause disruptions in connections or connectivity issues when toggled.The flag if audio Comfort Noise (CN) codec should be removed in sending session descriptions. This can be useful for debugging purposes to test preferred audio quality and feedback. |
||||||||||||||||||||||
disableREMB |
boolean |
<optional> |
false |
Note that this is mainly used for debugging purposes and that it is an experimental flag, so it may cause disruptions in connections or connectivity issues when toggled.The flag if video REMB feedback packets should be disabled in sending session descriptions. |
||||||||||||||||||||||
credentials |
JSON |
<optional> |
Note that we strongly recommend developers to return theThe credentials used for authenticating App Key with credentials to retrieve the Room session token used for connection in Skylink#joinRoom .
Note that switching of Rooms is not allowed when using credentials based authentication, unless
init() is invoked again with a different set of credentials followed by invoking
the Skylink#joinRoom .
Properties
|
|||||||||||||||||||||||
audioFallback |
boolean |
<optional> |
false |
The flag if |
||||||||||||||||||||||
forceSSL |
boolean |
<optional> |
true |
The flag if HTTPS connections should be enforced
during request to Auth server and socket connections to Signaling server
when accessing |
||||||||||||||||||||||
audioCodec |
String | JSON |
<optional> |
Note that if the audio codec is not supported, the SDK will not configure the localThe option to configure the preferred audio codec to use to encode sending audio data when available for Peer connection.
Properties
|
|||||||||||||||||||||||
videoCodec |
String | JSON |
<optional> |
Note that if the video codec is not supported, the SDK will not configure the localThe option to configure the preferred video codec to use to encode sending video data when available for Peer connection.
Properties
|
|||||||||||||||||||||||
socketTimeout |
number |
<optional> |
7000 |
The timeout for each attempts for socket connection
with the Signaling server to indicate that connection has timed out and has failed to establish.
Note that the minimum timeout value is |
||||||||||||||||||||||
apiTimeout |
number |
<optional> |
4000 |
The timeout to wait for response from Auth server. |
||||||||||||||||||||||
forceTURNSSL |
boolean |
<optional> |
false |
Note that currently Firefox does not support the TURNS protocol, and that if TURNS is required, TURN ICE servers using portThe flag if TURNS protocol should be used when enableTURNServer is enabled.
|
||||||||||||||||||||||
filterCandidatesType |
JSON |
<optional> |
Note that this a debugging feature and there might be connectivity issues when toggling these flags.The configuration options to filter the type of ICE candidates sent and received. Properties
|
|||||||||||||||||||||||
throttleIntervals |
JSON |
<optional> |
The configuration options to configure the throttling method timeouts. Properties
|
|||||||||||||||||||||||
throttleShouldThrowError |
boolean |
<optional> |
false |
The flag if throttled methods should throw errors when
method is invoked less than the interval timeout value configured in |
||||||||||||||||||||||
iceServer |
String | Array |
<optional> |
The ICE servers for debugging purposes to use.
Properties
|
|||||||||||||||||||||||
socketServer |
String | JSON |
<optional> |
The Signaling server for debugging purposes to use.
Properties
|
|||||||||||||||||||||||
codecParams |
codecParams |
<optional> |
The audio and video codecs parameters to configure. |
|||||||||||||||||||||||
beSilentOnStatsLogs |
boolean |
<optional> |
false |
The flag if error logs triggered by the statistics module should be silent. |
- Source:
joinRoomOptions :Object
The Room session configuration options.
Properties:
Name | Type | Attributes | Default | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
roomName |
String |
<optional> |
The Room name. When not provided or is provided as an empty string, its value is the |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
userData |
JSON | String |
<optional> |
The User custom data.
This can be set after Room session has started using the
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
useExactConstraints |
boolean |
<optional> |
The |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
audio |
boolean | JSON |
<optional> |
The |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
video |
boolean | JSON |
<optional> |
The |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
voiceActivityDetection |
boolean |
<optional> |
true |
The flag if voice activity detection should be enabled.
This can only be toggled if User is and for the offerer, which is determined if User's
This works hand-in-hand with the |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bandwidth |
JSON |
<optional> |
Note that this is currently not supported with Firefox browsers versions 48 and below as noted in an existing bugzilla ticket here.The configuration to set the maximum streaming bandwidth to send to Peers. You can also use the preconfigured constant VIDEO_QUALITY for recommended values.
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
googleXBandwidth |
JSON |
<optional> |
Note that this is an experimental configuration and may cause disruptions in connections or connectivity issues when toggled, or may not work depending on browser supports. Currently, this only toggles the video codec bandwidth configuration.The configuration to set the experimental google video streaming bandwidth sent to Peers. Note that Peers may override the "receive from" streaming bandwidth depending on the Peers configuration. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
manualGetUserMedia |
boolean |
<optional> |
The flag if |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sdpSettings |
JSON |
<optional> |
Note that this is mainly used for debugging purposes and that it is an experimental flag, so it may cause disruptions in connections or connectivity issues when toggled. Note that it might not work with MCU enabled Peer connections or break MCU enabled Peer connections.The configuration to set the session description settings. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
publishOnly |
JSON | Boolean |
<optional> |
For MCU enabled Peer connections, defining this flag would make Peer not know other Peers presence in the Room. For non-MCU enable Peer connections, defining this flag would cause other Peers in the Room to not to send Stream to Peer, and overrides the configThe config if Peer would publish only. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parentId |
String |
<optional> |
The parent Peer ID to match to when Peer is connected.
Note that configuring this value overrides the |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
peerConnection |
JSON |
<optional> |
Note that this is mainly used for debugging purposes, so it may cause disruptions in connections or connectivity issues when configured.The Peer connection constraints settings. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
autoBandwidthAdjustment |
boolean | JSON |
<optional> |
false |
Note that this is an experimental feature which may be removed or changed in the future releases. This feature is also only available for non-MCU enabled Peer connections and Edge Peer connections.The flag if Peer connections uploading and downloading bandwidth should be automatically adjusted each time based on a specified interval. Note this would cause the peer connection to restart. Properties
|
- Source:
logItems :Array
Properties:
Name | Type | Description |
---|---|---|
logItems.0 |
Date |
The DateTime of when the log was stored |
logItems.1 |
String |
The log level |
logItems.2 |
String |
The log message |
logItems.3 |
Object |
The debug object |
- Source:
mediaInfo :Object
An object that represents a media.
Properties:
Name | Type | Description |
---|---|---|
mediaInfo.publisherId |
String | |
mediaInfo.mediaId |
String | |
mediaInfo.mediaType |
String | |
mediaInfo.mediaState |
String | |
mediaInfo.transceiverMid |
String | |
mediaInfo.mediaMetaData |
String | JSON | |
mediaInfo.simulcast |
JSON | |
streamId |
String |
The stream id associated with the media. |
- Source:
MediaStreams :Array
Properties:
Name | Type | Description |
---|---|---|
MediaStreams.0 |
MediaStream |
Audio stream |
MediaStreams.1 |
MediaStream |
Video stream |
- Source:
peerInfo :Object
The Peer session information.
Properties:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
userData |
JSON | String |
The Peer current custom data. |
|||||||||||||||||||||||||||||
settings |
customSettings |
The Peer sending Stream settings. |
|||||||||||||||||||||||||||||
agent |
JSON |
The Peer agent information. Properties
|
|||||||||||||||||||||||||||||
room |
String |
The Room Peer is from. |
|||||||||||||||||||||||||||||
config |
JSON |
The Peer connection configuration. Properties
|
|||||||||||||||||||||||||||||
connected |
boolean |
<optional> |
The flag if Peer ICE connection has been established successfully.
Defined only when |
||||||||||||||||||||||||||||
init |
boolean |
<optional> |
The flag if Peer connection has been created successfully.
Defined only when |
- Source:
peerListMessage
Properties:
Name | Type | Description |
---|---|---|
type |
SkylinkConstants.SIG_MESSAGE_TYPE.GET_PEERS | |
showAll |
boolean |
- Source:
peersStreamsInfo :Object.<String, Object>
Method that returns the list of connected peers streams in the room both user media streams and screen share streams.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
roomName |
String |
The room name. |
||
includeSelf |
Boolean |
<optional> |
true |
The flag if self streams are included. |
Properties:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
#peerId |
Object.<String, Object> |
Peer streams info keyed by peer id. Properties
|
- Since:
-
- 0.6.16
- Source:
Example
Example 1: Get the list of current peers streams in the same room
const streams = skylink.getPeersStreams("Room_1");
recordingSessions :Object
Properties:
Name | Type | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
#recordingId |
Object.<string, Object> |
The recording session keyed by recording id. Properties
|
- Source:
refreshConnectionResolve :Object
Properties:
Name | Type | Description |
---|---|---|
failedRefresh |
Object.<string, Array.<String>> |
Array of refresh errors keyed by peer Id. |
successfulRefresh |
Object.<string, {'customSettings': customSettings, iceRestart: boolean}> |
List of successfull refreshes keyed by peer Id. |
- Source:
screenSources :Object
The list of screensharing media sources and screen sources.
Properties:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
mediaSource |
Array.<String> |
The screensharing media source item. |
||||||||||||
mediaSourceInput |
Array.<Object> |
The list of specific media source screen inputs. Properties
|
- Source:
socketSession :Object
The socket connection session information.
Properties:
Name | Type | Description |
---|---|---|
socketSession.serverUrl |
String |
The socket connection Signaling url used. |
socketSession.transportType |
String |
The socket connection transport type used. |
socketSession.socketOptions |
JSON |
The socket connection options. |
socketSession.attempts |
Number |
The socket connection current reconnection attempts. |
socketSession.finalAttempts |
Number |
The socket connection current last attempts for the last available transports and port. |
- Source:
statistics :Object
The Peer connection current statistics.
Defined only when state
payload is RETRIEVE_SUCCESS
.
Properties:
Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
peerId |
String |
The peer to which the statistics belong to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statistics.raw |
JSON |
The Peer connection raw statistics.before parsing. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statistics.audio |
audioStats |
The Peer connection audio streaming statistics. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statistics.video |
videoStats |
The Peer connection video streaming statistics. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statistics.selectedCandidatePair |
JSON |
The Peer connection selected ICE candidate pair statistics. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statistics.certificate |
JSON |
The Peer connection DTLS/SRTP exchanged certificates information. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statistics.connection |
JSON |
The Peer connection object statistics. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
error |
Error |
The error object received.
Defined only when |
- Source:
streamList :Object
Properties:
Name | Type | Description |
---|---|---|
userMedia |
Object.<string, MediaStream> | null |
The user media streams keyed by stream id. |
screenshare |
MediaStream | null |
The screenshare stream. |
- Source:
streamSources :Object
Properties:
Name | Type | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
audio |
Object |
The list of audio input (microphone) and output (speakers) sources. Properties
|
|||||||||||||||||||||||||
video |
Object |
The list of video input (camera) sources. Properties
|
- Source:
userDataMessage
Properties:
Name | Type | Description |
---|---|---|
type |
SkylinkConstants.SIG_MESSAGE_TYPE.UPDATE_USER | |
mid |
SkylinkUser.sid | |
rid |
SkylinkRoom.id | |
userData |
SkylinkUser.userData | |
state |
Number |
- Source:
videoStats
Properties:
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
videoStats.sending |
JSON |
The Peer connection sending video streaming statistics. Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
videoStats.receiving |
JSON |
The Peer connection receiving video streaming statistics. Properties
|