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
|
customSettings :Object
The peer stream and data settings.
Properties:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data |
Boolean | JSON |
The flag if peer has any data channel connections enabled.
If |
|||||||||||||||||
audio |
Boolean | JSON |
The peer stream audio settings keyed by stream id.
When defined as |
|||||||||||||||||
audio[streamId].stereo |
Boolean |
The flag if stereo band is configured
when encoding audio codec is |
|||||||||||||||||
audio[streamId].echoCancellation |
Boolean |
The flag if echo cancellation is enabled for audio tracks. |
|||||||||||||||||
audio[streamId].deviceId |
String |
<optional> |
The peer stream audio track source id of the device used. |
||||||||||||||||
audio[streamId].exactConstraints |
Boolean |
The flag if peer stream audio track is sending exact
requested values of |
|||||||||||||||||
video |
Boolean | JSON |
The peer stream video settings keyed by stream id.
When defined as |
|||||||||||||||||
video[streamId].resolution |
JSON |
<optional> |
The peer stream video resolution.
[Rel: Properties
|
||||||||||||||||
video[streamId].frameRate |
Number | JSON |
<optional> |
The peer stream video
frameRate per second (fps) or video frameRate settings.
When defined as a JSON Object, it is the user set frameRate settings with ( |
||||||||||||||||
video[streamId].screenshare |
Boolean |
The flag if peer stream is a screensharing stream. |
|||||||||||||||||
video[streamId].deviceId |
String |
<optional> |
The peer stream video track source id of the device used. |
||||||||||||||||
video[streamId].exactConstraints |
Boolean |
The flag if peer stream video track is sending exact
requested values of |
|||||||||||||||||
video[streamId].facingMode |
String | JSON |
<optional> |
The peer stream video camera facing mode.
When defined as a JSON Object, it is the user set facingMode settings with ( |
||||||||||||||||
maxBandwidth |
Object |
The maximum streaming bandwidth sent from peer. 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 | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 |
||||||||||||||||||||||||||||||||||||||||||
audio |
boolean | JSON |
<optional> |
false |
The audio configuration options. Properties
|
||||||||||||||||||||||||||||||||||||||||||
video |
boolean | JSON |
<optional> |
false |
The video configuration options. 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. |
||||||||||||||||||||||
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 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
|
|||||||||||||||||||||||
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 |
||||||||||||||||||||||
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 |
||||||||||||||||||||||
forceTURNSSL |
boolean |
<optional> |
false |
The flag if TURNS protocol should be used when
Note that currently Firefox does not support the TURNS protocol, and that if TURNS is required,
TURN ICE servers using port |
||||||||||||||||||||||
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
|
|||||||||||||||||||||||
beSilentOnStatsLogs |
boolean |
<optional> |
false |
The flag if all logs triggered by the statistics module should be silent. |
||||||||||||||||||||||
beSilentOnParseLogs |
boolean |
<optional> |
false |
The flag if media and codec parsing logs 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
|
||||||||||||||||||||
bandwidth |
JSON |
<optional> |
The configuration to set the maximum streaming bandwidth to send to Peers. You can also use the preconfigured
constant Note that this is currently not supported
with Firefox browsers versions 48 and below as noted in an existing
bugzilla ticket here. This option will override the
Properties
|
|||||||||||||||||||||
autoBandwidthAdjustment |
boolean | JSON |
<optional> |
false |
The flag if Peer connections uploading and downloading bandwidth should be automatically adjusted each time based on a specified interval.
This feature is also only available for non-MCU enabled Peer connections. Note this will cause the peer connection to restart. If
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:
MediaStream :Object
- Source:
MediaStreams :Array
Properties:
Name | Type | Description |
---|---|---|
MediaStreams.0 |
MediaStream |
Audio stream |
MediaStreams.1 |
MediaStream |
Video stream |
- Source:
peerInfo
Properties:
Name | Type | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
userData |
JSON | String |
The Peer current custom data. |
||||||||||||||||||||||||||||
settings |
customSettings |
The Peer sending stream settings. |
||||||||||||||||||||||||||||
agent |
JSON |
The Peer agent information. Properties
|
||||||||||||||||||||||||||||
room |
roomInfo |
The Room Peer is from. |
||||||||||||||||||||||||||||
config |
JSON |
The Peer connection configuration. Properties
|
- Source:
peerListMessage
Properties:
Name | Type | Description |
---|---|---|
type |
SkylinkConstants.SIG_MESSAGE_TYPE.GET_PEERS | |
showAll |
boolean |
- Source:
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:
roomInfo
Properties:
Name | Type | Description |
---|---|---|
roomName |
String |
The room name |
duration |
Number |
The maximum allowed room duration |
id |
String |
The room id |
inRoom |
Boolean |
The flag if the peer is in the room |
- 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:
streamsList :Object.<String, Object>
Properties:
Name | Type | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
#peerId |
Object.<String, Object> |
Peer streams info keyed by peer id. Properties
|
- 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
|