SkylinkConstants

Value "max-compat" The value of the bundle policy to generate ICE candidates for each media type so each media type flows through different transports.

Value "max-bundle" The value of the bundle policy to generate ICE candidates for one media type so all media type flows through a single transport.

Value "balanced" The value of the bundle policy to use MAX_BUNDLE if Peer supports it, else fallback to MAX_COMPAT.

Value "none" The value of the bundle policy to not use any media bundle. This removes the a=group:BUNDLE line from session descriptions.

Value "gathering" The value of the state when Peer connection is gathering ICE candidates. These ICE candidates are sent to Peer for its connection to check for a suitable matching pair of ICE candidates to establish an ICE connection for stream audio, video and data. See ICE_CONNECTION_STATE for ICE connection status. This state cannot happen until Peer connection remote "offer" / "answer" session description is set. See PEER_CONNECTION_STATE for session description exchanging status.

Value "completed" The value of the state when Peer connection gathering of ICE candidates has completed.

Value "received" The value of the state when the remote ICE candidate was received.

Value "received" The value of the state when the remote ICE candidate is dropped.

Value "buffered" The value of the state when the remote ICE candidate is buffered.

Value "processing" The value of the state when the remote ICE candidate is being processed.

Value "processSuccess" The value of the state when the remote ICE candidate has been processed successfully. The ICE candidate that is processed will be used to check against the list of locally generated ICE candidate to start matching for the suitable pair for the best ICE connection.

Value "processError" The value of the state when the remote ICE candidate has failed to be processed.

Value "message" The value of the Datachannel sending message error type when encountered during sending P2P message from sendP2PMessage.

Value "transfer" The value of the Datachannel sending message error type when encountered during data transfers from sendURLData or sendBlobData.

Value "connecting" The value of the state when Datachannel is attempting to establish a connection.

Value "open" The value of the state when Datachannel has established a connection.

Value "closing" The value of the state when Datachannel connection is closing.

Value "closed" The value of the state when Datachannel connection has closed.

Value "error" The value of the state when Datachannel has encountered an exception during connection.

Value "createError" The value of the state when Datachannel has failed to establish a connection.

Value "bufferedAmountLow" The value of the state when Datachannel when the amount of data buffered to be sent falls below the Datachannel threshold. This state should occur only during after sendBlobData or sendURLData or sendP2PMessage.

Value "sendMessageError" The value of the state when Datachannel when data transfer packets or P2P message fails to send. This state should occur only during after sendBlobData or sendURLData or sendP2PMessage.

Value "messaging" The value of the Datachannel type that is used only for messaging in sendP2PMessage. However for Peers that do not support simultaneous data transfers, this Datachannel type will be used to do data transfers (1 at a time). Each Peer connections will only have one of this Datachannel type and the connection will only close when the Peer connection is closed (happens when PEER CONNECTION STATE event triggers parameter payload state as CLOSED for Peer).

[UNAVAILABLE] Value "data" The value of the Datachannel type that is used only for a data transfer in sendURLData and sendBlobData. The connection will close after the data transfer has been completed or terminated (happens when DATA TRANSFER STATE triggers parameter payload state as DOWNLOAD_COMPLETED, UPLOAD_COMPLETED, REJECTED, CANCEL or ERROR for Peer).

Value "binaryString" The value of data transfer data type when Blob binary data chunks encoded to Base64 encoded string are sent or received over the Datachannel connection for the data transfer session. Used only in sendBlobData when parameter sendChunksAsBinary value is false.

Value "arrayBuffer" The value of data transfer data type when ArrayBuffer binary data chunks are sent or received over the Datachannel connection for the data transfer session. Used only in sendBlobData when parameter sendChunksAsBinary value is true.

Value "blob" The value of data transfer data type when Blob binary data chunks are sent or received over the Datachannel connection for the data transfer session. Used only in sendBlobData when parameter sendChunksAsBinary value is true.

Value "string" The value of data transfer data type when only string data chunks are sent or received over the Datachannel connection for the data transfer session. Used only in sendURLData.

Value "upload" The value of the data transfer direction when User is uploading data to Peer.

Value "download" The value of the data transfer direction when User is downloading data from Peer.

Value "blob" The value of the session type for sendBlobData data transfer.

Value "dataURL" sendURLData data transfer. The value of the session type for

Value "request" The value of the state when receiving an upload data transfer request from Peer to User. At this stage, the upload data transfer request from Peer may be accepted or rejected with the Skylink#acceptDataTransfer invoked by User.

Value "uploadStarted" The value of the state when the data transfer request has been accepted and data transfer will start uploading data to Peer. At this stage, the data transfer may be terminated with the Skylink#cancelDataTransfer.

Value "downloadStarted" The value of the state when the data transfer request has been accepted and data transfer will start downloading data from Peer. At this stage, the data transfer may be terminated with the Skylink#cancelDataTransfer.

Value "rejected" The value of the state when upload data transfer request to Peer has been rejected and terminated.

Value "userRejected" The value of the state when User rejected and terminated upload data transfer request from Peer.

Value "uploading" The value of the state when data transfer is uploading data to Peer.

Value "downloading" The value of the state when data transfer is downloading data from Peer.

Value "uploadCompleted" The value of the state when data transfer has uploaded successfully to Peer.

Value "downloadCompleted" The value of the state when data transfer has downloaded successfully from Peer.

Value "cancel" The value of the state when data transfer has been terminated from / to Peer.

Value "error" The value of the state when data transfer has errors and has been terminated from / to Peer.

Value 0 The value of the state when getConnectionStatus is retrieving the Peer connection stats.

Value 1 The value of the state when getConnectionStatus has retrieved the Peer connection stats successfully.

Value -1 The value of the state when getConnectionStatus has failed retrieving the Peer connection stats.

Value "enquired" The value of the state when getPeers is retrieving the list of Peer IDs from Rooms within the same App space from the Signaling server.

Value "received" The value of the state when getPeers has retrieved the list of Peer IDs from Rooms within the same App space from the Signaling server successfully.

Value "enter" The value of the connection state when Peer has just entered the Room. At this stage, PEER_JOINED is triggered.

Value "welcome" The value of the connection state when Peer is aware that User has entered the Room. At this stage, PEER_JOINED is triggered and Peer connection may commence.

Value "offer" The value of the connection state when Peer connection has set the local / remote "offer" session description to start streaming connection.

Value "answer" The value of the connection state when Peer connection has set the local / remote "answer" session description to establish streaming connection.

Value "answerAck" The value of the connection state when Peer connection is aware that the user has received the answer and the handshake is complete.

Value "error" The value of the connection state when Peer connection has failed to establish streaming connection. This happens when there are errors that occurs in creating local "offer" / "answer", or when setting remote / local "offer" / "answer".

Value "checking" The value of the state when Peer connection is checking for a suitable matching pair of ICE candidates to establish ICE connection. Exchanging of ICE candidates happens during CANDIDATE GENERATION STATE event.

Value "connected" The value of the state when Peer connection has found a suitable matching pair of ICE candidates to establish ICE connection but is still checking for a better suitable matching pair of ICE candidates for the best ICE connectivity. At this state, ICE connection is already established and audio, video and data streaming has already started.

Value "completed" The value of the state when Peer connection has found the best suitable matching pair of ICE candidates to establish ICE connection and checking has stopped. At this state, ICE connection is already established and audio, video and data streaming has already started. This may happen after CONNECTED.

Value "failed" The value of the state when Peer connection ICE connection has failed.

Value "disconnected" The value of the state when Peer connection ICE connection is disconnected. At this state, the Peer connection may attempt to revive the ICE connection. This may happen due to flaky network conditions.

Value "closed" The value of the state when Peer connection ICE connection has closed. This happens when Peer connection is closed and no streaming can occur at this stage.

Value 4 The value of the log level that displays console debug, log, info, warn and error logs.

Value 3 The value of the log level that displays only console log, info, warn and error logs.

Value 2 The value of the log level that displays only console info, warn and error logs.

Value 1 The value of the log level that displays only console warn and error logs.

Value 0 The value of the log level that displays only console error logs.

Value -1 The value of the log level that displays no logs.

Value 0 The value of the state when getUserMedia method will retrieve audio track only when retrieving audio and video tracks failed. This can be configured by Skylink initOptions audioFallback option.

Value 1 The value of the state when getUserMedia or shareScreen method retrieves camera / screensharing Stream successfully but with missing originally required audio or video tracks.

Value -1 The value of the state when getUserMedia method failed to retrieve audio track only after retrieving audio and video tracks failed.

Value "screen" The value of the option to share entire screen.

Value "window" The value of the option to share application windows.

Value "tab" The value of the option to share browser tab. Note that this is only supported by from Chrome 52+ and Opera 39+.

Value "audio" The value of the option to share browser tab audio. Note that this is only supported by Chrome 52+ and Opera 39+. options.audio has to be enabled with TAB also requested to enable sharing of tab audio.

Value "application" The value of the option to share applications. Note that this is only supported by Firefox currently.

Value "browser" The value of the option to share browser. Note that this is only supported by Firefox currently, and requires toggling the media.getUserMedia.browser.enabled in about:config.

Value "camera" The value of the option to share camera. Note that this is only supported by Firefox currently.

The state when the MediaTrack enabled flag is set to false. The MediaTrack is sending black frames.

The state when the MediaTrack enabled flag and active flag is set to true. The MediaTrack is sending frames with content.

The state when the MediaTrack active flag is false. The MediaTrack is not sending any frames.

The state when the MediaTrack is no longer available or has been disposed.

Value 0 The media is present in the stream and muted

Value 1 The media is present in the stream and active

Value -1 The media is not present in the stream

Audio from a microphone.

Video from a Camera of any type.

Video of the Screen captured for screen sharing.

Video from source other than Camera.

Audio from an unspecified MediaType.

Video from an unspecified MediaType.

Value "RSA" The value of the Peer connection certificate algorithm to use RSA-1024.

Value "ECDSA" The value of the Peer connection certificate algorithm to use ECDSA.

Value "AUTO" The value of the Peer connection to use the default certificate generated.

Value "stable" The value of the state when there is no session description being exchanged between Peer connection.

Value "have-local-offer" The value of the state when local "offer" session description is set. This should transition to STABLE state after remote "answer" session description is set. See HANDSHAKE_PROGRESS for a more detailed exchanging of session description states.

Value "have-remote-offer" The value of the state when remote "offer" session description is set. This should transition to STABLE state after local "answer" session description is set. See HANDSHAKE_PROGRESS for a more detailed exchanging of session description states.

Value "closed" The value of the state when Peer connection is closed and no session description can be exchanged and set.

Value "connecting" The value of the state when Peer connection is trying to establish a connection and negotiation has started.

Value "connected" The value of the state when Peer connection is connected after successful negotiation.

Value "failed" The value of the state when Peer connection has failed. A renegotiation is required to re-establish the connection.

Value "disconnected" The value of the state when Peer connection is disconnected. State may change to "connected" or "failed".

Value 0 The value of the state when init() has just started.

Value 1 The value of the state when init() is authenticating App Key provided (and with credentials if provided as well) with the Auth server.

Value 2 The value of the state when init() has successfully authenticated with the Auth server. Room session token is generated for joining the <codRoom provided in init(). Room session token has to be generated each time User switches to a different Room in joinRoom method.

Value -1 The value of the state when init() has failed authenticating with the Auth server.

Value 4001 The value of the failure code when provided App Key in init() does not exists. To resolve this, check that the provided App Key exists in the Temasys Console.

Value 4002 The value of the failure code when "domainName" property in the App Key does not match the accessing server IP address. To resolve this, contact our support portal.

Value 4003 The value of the failure code when "corsurl" property in the App Key does not match accessing CORS. To resolve this, configure the App Key CORS in the Temasys Console.

Value 4004 The value of the failure code when there is no CORS present in the HTTP headers during the request to the Auth server present nor options.credentials.credentials configuration provided in the init(). To resolve this, ensure that CORS are present in the HTTP headers during the request to the Auth server.

Value 4005 The value of the failure code when the options.credentials.credentials configuration provided in the init() does not match up with the options.credentials.startDateTime, options.credentials.duration or that the "secret" used to generate options.credentials.credentials does not match the App Key's "secret property provided. To resolve this, check that the options.credentials.credentials is generated correctly and that the "secret" used to generate it is from the App Key provided in the init().

Value 4006 The value of the failure code when the App Key provided does not belong to any existing App. To resolve this, check that the provided App Key exists in the Developer Console.

Value 4010 The value of the failure code when provided options.credentials does not match any scheduled meetings available for the "Persistent Room" enabled App Key provided. See the Persistent Room article to learn more.

Value 4020 The value of the failure code when App Key has reached its current concurrent users limit.

Value 4021 The value of the failure code when App Key retrieval of authentication token fails. If this happens frequently, contact our support portal.

Value 5005 The value of the failure code when App Key makes request to the incorrect Auth server. To resolve this, ensure that the roomServer is not configured. If this persists even without roomServer configuration, contact our support portal.

Value -1 The value of the failure code when requesting to Auth server has timed out.

Value -2 The value of the failure code when response from Auth server is empty or timed out.

Value 1 The value of the failure code when dependency Socket.IO client is not loaded. To resolve this, ensure that the Socket.IO client dependency is loaded before the Skylink SDK. You may use the provided Socket.IO client CDN here.

Value 2 The value of the failure code when XMLHttpRequest API required to make request to Auth server is not supported. To resolve this, display in the Web UI to ask clients to switch to the list of supported browser as listed in here.

Value 3 The value of the failure code when RTCPeerConnection API required for Peer connections is not supported. To resolve this, display in the Web UI to ask clients to switch to the list of supported browser as listed in here. For plugin supported browsers, if the clients does not have the plugin installed, there will be an installation toolbar that will prompt for installation to support the RTCPeerConnection API.

Value 4 The value of the failure code when provided init() configuration has errors.

Value 7 The value of the failure code when dependency AdapterJS is not loaded. To resolve this, ensure that the AdapterJS dependency is loaded before the Skylink dependency. You may use the provided AdapterJS CDN here.

Value 8 The value of the failure code when codecs support cannot be parsed and retrieved.

Value 0 The value of the state when recording session has started.

Value 1 The value of the state when recording session has stopped.
At this stage, the recorded videos will go through the mixin server to compile the videos.

Value 2 The value of the state when recording session mixin request has been completed.

Value -1 The value of the state state when recording session has errors. This can happen during recording session or during mixin of recording videos, and at this stage, any current recording session or mixin is aborted.

Value "require" The value of the RTCP mux policy to generate ICE candidates for RTP only and RTCP shares the same ICE candidates.

Value "negotiate" The value of the RTCP mux policy to generate ICE candidates for both RTP and RTCP each.

Value 0 The value of the state when live streaming session has started.

Value 1 The value of the state when live streaming session has stopped.
At this stage, the recorded videos will go through the mixin server to compile the videos.

Value -1 The value of the state state when live streaming session has errors.

The value of option to prefer plan-b sdp.

The value of option to prefer unified-plan sdp.

Value 0 The value of the failure state when joinRoom socket connection failed to establish with the Signaling server at the first attempt.

Value -1 The value of the failure state when joinRoom socket connection failed to establish the Signaling server after the first attempt.

Value -2 The value of the failure state when joinRoom socket connection will not attempt to reconnect after the failure of the first attempt in CONNECTION_FAILED as there are no more ports or transports to attempt for reconnection.

Value -3 The value of the failure state when joinRoom socket connection will not attempt to reconnect after the failure of several attempts in RECONNECTION_FAILED as there are no more ports or transports to attempt for reconnection.

Value -4 The value of the failure state when joinRoom socket connection is attempting to reconnect with a new port or transport after the failure of attempts in CONNECTION_FAILED or RECONNECTED_FAILED.

Value "nonfallback" The value of the reconnection state when joinRoom socket connection is at its initial state without transitioning to any new socket port or transports yet.

Value "fallbackPortNonSSL" The value of the reconnection state when joinRoom socket connection is reconnecting with another new HTTP port using WebSocket transports to attempt to establish connection with Signaling server.

Value "fallbackPortSSL" The value of the reconnection state when joinRoom socket connection is reconnecting with another new HTTPS port using WebSocket transports to attempt to establish connection with Signaling server.

Value "fallbackLongPollingNonSSL" The value of the reconnection state when joinRoom socket connection is reconnecting with another new HTTP port using Polling transports to attempt to establish connection with Signaling server.

Value "fallbackLongPollingSSL" The value of the reconnection state when joinRoom socket connection is reconnecting with another new HTTPS port using Polling transports to attempt to establish connection with Signaling server.

Value "warning" The value of the state when Room session is about to end.

Value "reject" The value of the state when Room session has failed to start or has ended.

Value "locked" The value of the state when Room sis locked.

Value "oldTimeStamp" The value of the reason code when Room session token has expired. Happens during joinRoom request. Results with: REJECT

Value "credentialError" The value of the reason code when Room session token provided is invalid. Happens during joinRoom request.

Value "duplicatedLogin" The value of the reason code when Room session token has been used already. Happens during joinRoom request. Results with: REJECT

Value "notStart" The value of the reason code when Room session has not started. Happens during joinRoom request. Results with: REJECT

Value "expired" The value of the reason code when Room session has ended already. Happens during joinRoom request. Results with: REJECT

Value "locked" The value of the reason code when Room is locked. Happens during joinRoom request. Results with: REJECT

Value "fastmsg" The value of the reason code when User is flooding socket messages to the Signaling server that is sent too quickly within less than a second interval. Happens after Room session has started. This can be caused by various methods like sendMessage, muteStreams Results with: WARNING

Value "toClose" The value of the reason code when Room session is ending. Happens after Room session has started. This serves as a prerequisite warning before ROOM_CLOSED occurs. Results with: WARNING

Value "roomclose" The value of the reason code when Room session has just ended. Happens after Room session has started. Results with: REJECT

Value "serverError" The value of the reason code when Room session fails to start due to some technical errors. Happens during joinRoom request. Results with: REJECT

Value "keyFailed" The value of the reason code when Room session fails to start due to some technical error pertaining to App Key initialization. Happens during joinRoom request. Results with: REJECT

Value "tcp" The value of the option to configure using only TCP network transport protocol. Example .urls output: ["turn:server.com?transport=tcp", "turn:server1.com:3478?transport=tcp"]

Value "udp" The value of the option to configure using only UDP network transport protocol. Example .urls output: ["turn:server.com?transport=udp", "turn:server1.com:3478?transport=udp"]

Value "any" The value of the option to configure using any network transport protocols configured from the Signaling server. Example .urls output: ["turn:server.com?transport=tcp", "turn:server1.com:3478", "turn:server.com?transport=udp"]

Value "none" The value of the option to not configure using any network transport protocols. Example .urls output: ["turn:server.com", "turn:server1.com:3478"] Configuring this does not mean that no protocols will be used, but rather removing ?transport=(protocol) query option in the TURN ICE server .urls when constructing the Peer connection.

Value "all" The value of the option to configure using both TCP and UDP network transport protocols. Example .urls output: ["turn:server.com?transport=tcp", "turn:server.com?transport=udp", "turn:server1.com:3478?transport=tcp", "turn:server1.com:3478?transport=udp"]

Value { video: 3200, audio: 80 } The value of option to prefer high definition video and audio bitrates.

Value { video: 1200, audio: 50 } The value of option to prefer high quality video and audio bitrates.

Value { video: 800, audio: 30 } The value of option to prefer standard quality video and audio bitrates.

Value { video: 500, audio: 20 } The value of option to prefer low quality video and audio bitrates.

Value { width: 160, height: 120 } The value of the option to configure QQVGA resolution. Aspect ratio: 4:3 Note that configurating this resolution may not be supported depending on browser and device supports.

Value { width: 240, height: 160 } The value of the option to configure HQVGA resolution. Aspect ratio: 3:2 Note that configurating this resolution may not be supported depending on browser and device supports.

Value { width: 320, height: 240 } The value of the option to configure QVGA resolution. Aspect ratio: 4:3

Value { width: 384, height: 240 } The value of the option to configure WQVGA resolution. Aspect ratio: 16:10 Note that configurating this resolution may not be supported depending on browser and device supports.

Value { width: 480, height: 320 } The value of the option to configure HVGA resolution. Aspect ratio: 3:2 Note that configurating this resolution may not be supported depending on browser and device supports.

Value { width: 640, height: 480 } The value of the option to configure VGA resolution. Aspect ratio: 4:3

Value { width: 768, height: 480 } The value of the option to configure WVGA resolution. Aspect ratio: 16:10 Note that configurating this resolution may not be supported depending on browser and device supports.

Value { width: 854, height: 480 } The value of the option to configure FWVGA resolution. Aspect ratio: 16:9 Note that configurating this resolution may not be supported depending on browser and device supports.

Value { width: 800, height: 600 } The value of the option to configure SVGA resolution. Aspect ratio: 4:3 Note that configurating this resolution may not be supported depending on browser and device supports.

Value { width: 960, height: 640 } The value of the option to configure DVGA resolution. Aspect ratio: 3:2 Note that configurating this resolution may not be supported depending on browser and device supports.

Value { width: 1024, height: 576 } The value of the option to configure WSVGA resolution. Aspect ratio: 16:9

Value { width: 1280, height: 720 } The value of the option to configure HD resolution. Aspect ratio: 16:9 Note that configurating this resolution may not be supported depending on device supports.

Value { width: 1600, height: 900 } The value of the option to configure HDPLUS resolution. Aspect ratio: 16:9 Note that configurating this resolution may not be supported depending on browser and device supports.

Value { width: 1920, height: 1080 } The value of the option to configure FHD resolution. Aspect ratio: 16:9 Note that configurating this resolution may not be supported depending on device supports.

Value { width: 2560, height: 1440 } The value of the option to configure QHD resolution. Aspect ratio: 16:9 Note that configurating this resolution may not be supported depending on browser and device supports.

Value { width: 3200, height: 1800 } The value of the option to configure WQXGAPLUS resolution. Aspect ratio: 16:9 Note that configurating this resolution may not be supported depending on browser and device supports.

Value { width: 3840, height: 2160 } The value of the option to configure UHD resolution. Aspect ratio: 16:9 Note that configurating this resolution may not be supported depending on browser and device supports.

Value { width: 5120, height: 2880 } The value of the option to configure UHDPLUS resolution. Aspect ratio: 16:9 Note that configurating this resolution may not be supported depending on browser and device supports.

Value { width: 7680, height: 4320 } The value of the option to configure FUHD resolution. Aspect ratio: 16:9 Note that configurating this resolution may not be supported depending on browser and device supports.

Value { width: 15360, height: 8640 } The value of the option to configure QUHD resolution. Aspect ratio: 16:9 Note that configurating this resolution may not be supported depending on browser and device supports.