Skylink Class
Defined in: source/template/header.js:49
Available since 0.5.0
Prerequisites on using Skylink
Before using any Skylink functionalities, you will need to authenticate your App Key using theinit() method.
To manage or create App Keys, you may access the Skylink Developer Portal here.
To view the list of supported browsers, visit the list here.
Here are some articles to help you get started:
Here are some demos you may use to aid your development:
- Getaroom.io [Demo / Source code]
- Creating a component [Link]
You may see the example below in the Constructor tab to have a general idea how event subscription
and the ordering of init() and
joinRoom() methods should be called.
If you have any issues, you may find answers to your questions in the FAQ section on our support portal, asks questions, request features or raise bug tickets as well.
If you would like to contribute to our Temasys Web SDK codebase, see the contributing README.
Skylink
()
Example:
// Here's a simple example on how you can start using Skylink.
var skylinkDemo = new Skylink();
// Subscribe all events first as a general guideline
skylinkDemo.on("incomingStream", function (peerId, stream, peerInfo, isSelf) {
if (isSelf) {
attachMediaStream(document.getElementById("selfVideo"), stream);
} else {
var peerVideo = document.createElement("video");
peerVideo.id = peerId;
peerVideo.autoplay = "autoplay";
document.getElementById("peersVideo").appendChild(peerVideo);
attachMediaStream(peerVideo, stream);
}
});
skylinkDemo.on("peerLeft", function (peerId, peerInfo, isSelf) {
if (!isSelf) {
var peerVideo = document.getElementById(peerId);
// do a check if peerVideo exists first
if (peerVideo) {
document.getElementById("peersVideo").removeChild(peerVideo);
} else {
console.error("Peer video for " + peerId + " is not found.");
}
}
});
// init() should always be called first before other methods other than event methods like on() or off().
skylinkDemo.init("YOUR_APP_KEY_HERE", function (error, success) {
if (success) {
skylinkDemo.joinRoom("my_room", {
userData: "My Username",
audio: true,
video: true
});
}
});
Events Sequence:
There is no event sequence for this method._ACKProtocolHandler
()
Function that handles the "ACK" data transfer protocol.
Events Sequence:
There is no event sequence for this method._addIceCandidate
()
Function that adds the ICE candidate to Peer connection.
Events Sequence:
There is no event sequence for this method._addIceCandidateFromQueue
()
Function that adds all the Peer connection buffered ICE candidates received. This should be called only after the remote session description is received and set.
Events Sequence:
There is no event sequence for this method._addIceCandidateToQueue
()
Function that buffers the Peer connection ICE candidate when received before remote session description is received and set.
Events Sequence:
There is no event sequence for this method._addLocalMediaStreams
()
Function that sets User's Stream to send to Peer connection.
Priority for shareScreen() Stream over getUserMedia() Stream.
Events Sequence:
There is no event sequence for this method._addPeer
()
Function that starts the Peer connection session. Remember to remove previous method of reconnection (re-creating the Peer connection - destroy and create connection).
Events Sequence:
There is no event sequence for this method._addSDPMediaStreamTrackIDs
()
Function that modifies the session description to append the MediaStream and MediaStreamTrack IDs that seems to be missing from Firefox answer session description to Chrome connection causing freezes in re-negotiation.
Events Sequence:
There is no event sequence for this method._answerHandler
()
Function that handles the "answer" socket message received.
See confluence docs for the "answer" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._approachEventHandler
()
Function that handles the "approach" socket message received.
See confluence docs for the "approach" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._base64ToBlob
()
Function that converts Base64 string into Blob object. This is referenced from devnull69@stackoverflow.com #6850276.
Events Sequence:
There is no event sequence for this method._blobToArrayBuffer
()
Function that converts a Blob object into ArrayBuffer object.
Events Sequence:
There is no event sequence for this method._blobToBase64
()
Function that converts a Blob object into Base64 string.
Events Sequence:
There is no event sequence for this method._byeHandler
()
Function that handles the "bye" socket message received.
See confluence docs for the "bye" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._CANCELProtocolHandler
()
Function that handles the "CANCEL" data transfer protocol.
Events Sequence:
There is no event sequence for this method._candidateHandler
()
Function that handles the "candidate" socket message received.
See confluence docs for the "candidate" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._chunkBlobData
()
Function that chunks Blob object based on the data chunk size provided.
If provided Blob object size is lesser than or equals to the chunk size, it should return an array
of length of 1.
Events Sequence:
There is no event sequence for this method._chunkDataURL
()
Function that chunks large string into string chunks based on the data chunk size provided.
If provided string length is lesser than or equals to the chunk size, it should return an array
of length of 1.
Events Sequence:
There is no event sequence for this method._clearAllStoredLogsFn
()
Function that clears the stored logs.
Events Sequence:
There is no event sequence for this method._closeChannel
()
Function that stops the socket connection to the Signaling.
Events Sequence:
There is no event sequence for this method._closeDataChannel
()
Function that stops the Datachannel connection and removes object references.
Events Sequence:
There is no event sequence for this method._condition
()
Function that checks if the current state condition is met before subscribing event handler to wait for condition to be fulfilled.
Events Sequence:
There is no event sequence for this method._createDataChannel
()
Function that starts a Datachannel connection with Peer.
Events Sequence:
There is no event sequence for this method._createPeerConnection
()
Function that creates the Peer connection.
Events Sequence:
There is no event sequence for this method._createSocket
()
Function that creates and opens a socket connection to the Signaling.
Events Sequence:
There is no event sequence for this method._DATAProtocolHandler
()
Function that handles the data transfer chunk received.
Events Sequence:
There is no event sequence for this method._doAnswer
()
Function that creates the Peer connection answer session description. This comes after receiving and setting the offer session description.
Events Sequence:
There is no event sequence for this method._doOffer
()
Function that creates the Peer connection offer session description.
Events Sequence:
There is no event sequence for this method._endOfCandidatesHandler
()
Function that handles the "endOfCandidates" socket message received.
See confluence docs for the "endOfCandidates" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._enterHandler
()
Function that handles the "enter" socket message received.
See confluence docs for the "enter" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._ERRORProtocolHandler
()
Function that handles the "ERROR" data transfer protocol.
Events Sequence:
There is no event sequence for this method._getCodecsSupport
()
Function that retrieves the current list of support codecs.
Events Sequence:
There is no event sequence for this method._getDataChannelBuffer
()
Function that returns the Datachannel buffer threshold and amount.
Events Sequence:
There is no event sequence for this method.Returns:
The buffered amount information.
_getSDPFingerprint
()
Function that parses and retrieves the session description fingerprint.
Events Sequence:
There is no event sequence for this method._getSDPSelectedCodec
()
Function that retrieves the session description selected codec.
Events Sequence:
There is no event sequence for this method._getStoredLogsFn
()
Function that gets the stored logs.
Events Sequence:
There is no event sequence for this method._getTransferData
()
Function that returns the compiled data transfer data.
Events Sequence:
There is no event sequence for this method._getTransferInfo
()
Function that returns the data transfer session.
Events Sequence:
There is no event sequence for this method._getUserInfo
()
Function that returns the User session information to be sent to Peers.
Events Sequence:
There is no event sequence for this method._handleDataTransferTimeoutForPeer
()
Function that handles the data transfers sessions timeouts.
Events Sequence:
There is no event sequence for this method._handleEndedStreams
()
Function that handles ended streams.
Events Sequence:
There is no event sequence for this method._handleSDPConnectionSettings
()
Function that modifies the session description to handle the connection settings. This is experimental and never recommended to end-users.
Events Sequence:
There is no event sequence for this method._initSelectedRoom
()
Starts initialising for Room credentials for room name provided in joinRoom() method.
Events Sequence:
There is no event sequence for this method._inRoomHandler
()
Function that handles the "inRoom" socket message received.
See confluence docs for the "inRoom" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._introduceErrorEventHandler
()
Function that handles the "introduceError" socket message received.
See confluence docs for the "introduceError" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._isLowerThanVersion
()
Function that compares the SM / DT protocol versions to see if it in the version.
Events Sequence:
There is no event sequence for this method._loadInfo
()
Loads and checks the dependencies if they are loaded correctly.
Events Sequence:
There is no event sequence for this method._logFn
()
Function that handles the logs received and prints in the Web Console interface according to the log level set.
Events Sequence:
There is no event sequence for this method._MESSAGEProtocolHandler
()
Function that handles the "MESSAGE" data transfer protocol.
Events Sequence:
There is no event sequence for this method._muteAudioEventHandler
()
Function that handles the "muteAudioEvent" socket message received.
See confluence docs for the "muteAudioEvent" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._muteStreams
()
Function that handles the muting of Stream audio and video tracks.
Events Sequence:
There is no event sequence for this method._muteVideoEventHandler
()
Function that handles the "muteVideoEvent" socket message received.
See confluence docs for the "muteVideoEvent" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._offerHandler
()
Function that handles the "offer" socket message received.
See confluence docs for the "offer" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._onIceCandidate
()
Function that handles the Peer connection gathered ICE candidate to be sent.
Events Sequence:
There is no event sequence for this method._onRemoteStreamAdded
()
Function that handles the RTCPeerConnection.onaddstream remote MediaStream received.
Events Sequence:
There is no event sequence for this method._onStreamAccessError
()
Function that handles the native navigator.getUserMedia() API failure callback result.
Events Sequence:
There is no event sequence for this method._onStreamAccessSuccess
()
Function that handles the native navigator.getUserMedia() API success callback result.
Events Sequence:
There is no event sequence for this method._openChannel
()
Function that starts the socket connection to the Signaling. This starts creating the socket connection and called at first not when requiring to fallback.
Events Sequence:
There is no event sequence for this method._parseConnectionStats
()
Function that handles the stats tabulation.
Events Sequence:
There is no event sequence for this method._parseInfo
()
Parses the Room credentials information retrieved from API server.
Events Sequence:
There is no event sequence for this method._parseStreamSettings
()
Function that parses the getUserMedia() settings provided.
Events Sequence:
There is no event sequence for this method._peerListEventHandler
()
Function that handles the "peerList" socket message received.
See confluence docs for the "peerList" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._printAllStoredLogsFn
()
Function that prints in the Web Console interface the stored logs.
Events Sequence:
There is no event sequence for this method._privateMessageHandler
()
Function that handles the "private" socket message received.
See confluence docs for the "private" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._processDataChannelData
()
Function that handles the data received from Datachannel and routes to the relevant data transfer protocol handler.
Events Sequence:
There is no event sequence for this method._processSigMessage
()
Function that handles and processes the socket message received.
Events Sequence:
There is no event sequence for this method._publicMessageHandler
()
Function that handles the "public" socket message received.
See confluence docs for the "public" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._recordingEventHandler
message
,
)
Handles the RECORDING Protocol message event received from the platform signaling.
Events Sequence:
There is no event sequence for this method.Parameters:
-
message{JSON}The message object received from platform signaling. This should contain the
RECORDINGpayload.-
url{String}The recording URL if mixing has completed.
-
action{String}The recording action received.
-
error{String}The recording error exception received.
-
_redirectHandler
()
Function that handles the "redirect" socket message received.
See confluence docs for the "redirect" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._refreshPeerConnection
()
Function that refresh connections.
Events Sequence:
There is no event sequence for this method._removePeer
()
Function that ends the Peer connection session.
Events Sequence:
There is no event sequence for this method._removeSDPCodecs
()
Function that modifies the session description to remove codecs.
Events Sequence:
There is no event sequence for this method._removeSDPFilteredCandidates
()
Function that modifies the session description to remove non-relay ICE candidates.
Events Sequence:
There is no event sequence for this method._removeSDPFirefoxH264Pref
()
Function that modifies the session description to remove the previous experimental H264 codec that is apparently breaking connections. NOTE: We should perhaps not remove it since H264 is supported?
Events Sequence:
There is no event sequence for this method._removeSDPREMBPackets
()
Function that modifies the session description to remove REMB packets fb.
Events Sequence:
There is no event sequence for this method._removeSDPUnknownAptRtx
()
Function that modifies the session description to remove apt/rtx lines that does exists.
Events Sequence:
There is no event sequence for this method._requestServerInfo
()
Starts retrieving Room credentials information from API server.
Events Sequence:
There is no event sequence for this method._restartHandler
()
Function that handles the "restart" socket message received.
See confluence docs for the "restart" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._restartMCUConnection
()
Function that handles the _restartPeerConnection scenario
for MCU enabled Peer connections.
This is implemented currently by making the user leave and join the Room again.
The Peer ID will not stay the same though.
Events Sequence:
There is no event sequence for this method._restartPeerConnection
()
Function that re-negotiates a Peer connection. Remember to remove previous method of reconnection (re-creating the Peer connection - destroy and create connection).
Events Sequence:
There is no event sequence for this method._retrieveStats
()
Function that retrieves Peer connection stats.
Events Sequence:
There is no event sequence for this method._roomLockEventHandler
()
Function that handles the "roomLockEvent" socket message received.
See confluence docs for the "roomLockEvent" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._sendChannelMessage
()
Function that sends a socket message over the socket connection to the Signaling.
Events Sequence:
There is no event sequence for this method._sendMessageToDataChannel
()
Function that sends data over the Datachannel connection.
Events Sequence:
There is no event sequence for this method._setIceServers
()
Function that filters and configures the ICE servers received from Signaling
based on the init() configuration and returns the updated
list of ICE servers to be used when constructing Peer connection.
Events Sequence:
There is no event sequence for this method._setLocalAndSendMessage
()
Function that sets the local session description and sends to Peer. If trickle ICE is disabled, the local session description will be sent after ICE gathering has been completed.
Events Sequence:
There is no event sequence for this method._setSDPBitrate
()
Function that modifies the session description to limit the maximum sending bandwidth. Setting this may not necessarily work in Firefox.
Events Sequence:
There is no event sequence for this method._setSDPCodec
()
Function that modifies the session description to set the preferred audio/video codec.
Events Sequence:
There is no event sequence for this method._setSDPCodecParams
()
Function that modifies the session description to configure settings for OPUS audio codec.
Events Sequence:
There is no event sequence for this method._signalingEndOfCandidates
()
Function that signals the end-of-candidates flag.
Events Sequence:
There is no event sequence for this method._startDataTransfer
()
Function that starts the data transfer to Peers.
Events Sequence:
There is no event sequence for this method._startDataTransferToPeer
()
Function that starts or listens the data transfer status to Peer. This reacts differently during MCU environment.
Events Sequence:
There is no event sequence for this method.Returns:
Returns a Boolean only during MCU environment which flag indicates if Peer requires interop (Use messaging Datachannel connection instead).
_stopStreams
()
Function that handles stopping the Stream streaming.
Events Sequence:
There is no event sequence for this method._streamEventHandler
()
Function that handles the "stream" socket message received.
See confluence docs for the "stream" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._throttle
()
Function that throttles a method function to prevent multiple invokes over a specified amount of time.
Returns a function to be invoked ._throttle(fn, 1000)() to make throttling functionality work.
Events Sequence:
There is no event sequence for this method._trigger
()
Function that triggers an event.
The rest of the parameters after the eventName parameter is considered as the event parameter payloads.
Events Sequence:
There is no event sequence for this method._updateUserEventHandler
()
Function that handles the "updateUserEvent" socket message received.
See confluence docs for the "updateUserEvent" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._wait
()
Function that starts an interval check to wait for a condition to be resolved.
Events Sequence:
There is no event sequence for this method._waitForOpenChannel
()
Function that waits for Socket connection to Signaling to be opened.
Events Sequence:
There is no event sequence for this method._welcomeHandler
()
Function that handles the "welcome" socket message received.
See confluence docs for the "welcome" expected properties to be received
based on the current SM_PROTOCOL_VERSION.
Events Sequence:
There is no event sequence for this method._WRQProtocolHandler
()
Function that handles the "WRQ" data transfer protocol.
Events Sequence:
There is no event sequence for this method.acceptDataTransfer
peerId
,
transferId
,
[accept=false]
,
)
Function that accepts or rejects an upload data transfer request from Peer to User.
Example:
// Example 1: Accept Peer upload data transfer request
skylinkDemo.on("incomingDataRequest", function (transferId, peerId, transferInfo, isSelf) {
if (!isSelf) {
skylinkDemo.acceptDataTransfer(peerId, transferId, true);
}
});
// Example 2: Reject Peer upload data transfer request
skylinkDemo.on("incomingDataRequest", function (transferId, peerId, transferInfo, isSelf) {
if (!isSelf) {
skylinkDemo.acceptDataTransfer(peerId, transferId, false);
}
});
Events Sequence:
Event sequence followssendBlobData() method after acceptDataTransfer() method is invoked.
Parameters:
-
peerId{String}The Peer ID.
-
transferId{String}The data transfer ID.
-
accept{Boolean} OptionalDEFAULT:falseThe flag if User accepts the upload data transfer request from Peer.
cancelDataTransfer
peerId
,
transferId
,
)
For MCU enabled Peer connections, the cancel data transfer functionality may differ, as it will result in all Peers related to the data transfer ID to be terminated.Function that terminates a currently uploading / downloading data transfer from / to Peer.
Example:
// Example 1: Cancel Peer data transfer
var transferSessions = {};
skylinkDemo.on("dataTransferState", function (state, transferId, peerId) {
if ([skylinkDemo.DATA_TRANSFER_STATE.DOWNLOAD_STARTED,
skylinkDemo.DATA_TRANSFER_STATE.UPLOAD_STARTED].indexOf(state) > -1) {
if (!Array.isArray(transferSessions[transferId])) {
transferSessions[transferId] = [];
}
transferSessions[transferId].push(peerId);
} else {
transferSessions[transferId].splice(transferSessions[transferId].indexOf(peerId), 1);
}
});
function cancelTransfer (peerId, transferId) {
skylinkDemo.cancelDataTransfer(peerId, transferId);
}
Events Sequence:
Event sequence followssendBlobData() method after cancelDataTransfer() method is invoked.
Parameters:
-
peerId{String}The Peer ID.
-
transferId{String}The data transfer ID.
disableAudio
()
Deprecation Warning!
This method has been deprecated. Use muteStream() method instead.
Function that mutes both getUserMedia() Stream and
shareScreen() Stream audio tracks.
Example:
function muteAudio () {
skylinkDemo.disableAudio();
}
Events Sequence:
- Invokes
muteStream()method withoptions.audioMutedvalue astrueandoptions.videoMutedvalue with currentpeerInfo.mediaStatus.videoMutedvalue. SeegetPeerInfo()method for more information.
disableVideo
()
Deprecation Warning!
This method has been deprecated. Use muteStream() method instead.
Function that mutes both getUserMedia() Stream and
shareScreen() Stream video tracks.
Example:
function muteVideo () {
skylinkDemo.disableVideo();
}
Events Sequence:
- Invokes
muteStream()method withoptions.videoMutedvalue astrueandoptions.audioMutedvalue with currentpeerInfo.mediaStatus.audioMutedvalue. SeegetPeerInfo()method for more information.
enableAudio
()
Deprecation Warning!
This method has been deprecated. Use muteStream() method instead.
Function that unmutes both getUserMedia() Stream and
shareScreen() Stream audio tracks.
Example:
function unmuteAudio () {
skylinkDemo.enableAudio();
}
Events Sequence:
- Invokes
muteStream()method withoptions.audioMutedvalue asfalseandoptions.videoMutedvalue with currentpeerInfo.mediaStatus.videoMutedvalue. SeegetPeerInfo()method for more information.
enableVideo
()
Deprecation Warning!
This method has been deprecated. Use muteStream() method instead.
Function that unmutes both getUserMedia() Stream and
shareScreen() Stream video tracks.
Example:
function unmuteVideo () {
skylinkDemo.enableVideo();
}
Events Sequence:
- Invokes
muteStream()method withoptions.videoMutedvalue asfalseandoptions.audioMutedvalue with currentpeerInfo.mediaStatus.audioMutedvalue. SeegetPeerInfo()method for more information.
generateUUID
()
Function that generates an UUID (Unique ID).
Events Sequence:
There is no event sequence for this method.Returns:
Returns a generated UUID (Unique ID).
getConnectionStatus
[targetPeerId]
,
[callback] The callback function fired when request has completed.
<small>Function parameters signature is <code>function (error, success)</code></small>
<small>Function request completion is determined by the <a href="#event_getConnectionStatusStateChange">
<code>getConnectionStatusStateChange</code> event</a> triggering <code>state</code> parameter payload
value as <code>RETRIEVE_SUCCESS</code> for all Peers targeted for request success.</small>
[Rel: Skylink.GET_CONNECTION_STATUS_STATE]
,
callback.error
,
callback.error.listOfPeers
,
callback.error.retrievalErrors
,
callback.error.retrievalErrors.#peerId
,
callback.error.connectionStats
,
callback.error.connectionStats.#peerId
,
callback.success
,
callback.success.listOfPeers
,
callback.success.connectionStats
,
callback.success.connectionStats.#peerId
,
)
Note that this is not well supported in the Edge browser.Function that retrieves Peer connection bandwidth and ICE connection stats.
Example:
// Example 1: Retrieve a Peer connection stats
function startBWStatsInterval (peerId) {
setInterval(function () {
skylinkDemo.getConnectionStatus(peerId, function (error, success) {
if (error) return;
var sendVideoBytes = success.connectionStats[peerId].video.sending.bytes;
var sendAudioBytes = success.connectionStats[peerId].audio.sending.bytes;
var recvVideoBytes = success.connectionStats[peerId].video.receiving.bytes;
var recvAudioBytes = success.connectionStats[peerId].audio.receiving.bytes;
var localCandidate = success.connectionStats[peerId].selectedCandidate.local;
var remoteCandidate = success.connectionStats[peerId].selectedCandidate.remote;
console.log("Sending audio (" + sendAudioBytes + "bps) video (" + sendVideoBytes + ")");
console.log("Receiving audio (" + recvAudioBytes + "bps) video (" + recvVideoBytes + ")");
console.log("Local candidate: " + localCandidate.ipAddress + ":" + localCandidate.portNumber +
"?transport=" + localCandidate.transport + " (type: " + localCandidate.candidateType + ")");
console.log("Remote candidate: " + remoteCandidate.ipAddress + ":" + remoteCandidate.portNumber +
"?transport=" + remoteCandidate.transport + " (type: " + remoteCandidate.candidateType + ")");
});
}, 1000);
}
// Example 2: Retrieve a list of Peer connection stats
function printConnStats (peerId, data) {
if (!data.connectionStats[peerId]) return;
var sendVideoBytes = data.connectionStats[peerId].video.sending.bytes;
var sendAudioBytes = data.connectionStats[peerId].audio.sending.bytes;
var recvVideoBytes = data.connectionStats[peerId].video.receiving.bytes;
var recvAudioBytes = data.connectionStats[peerId].audio.receiving.bytes;
var localCandidate = data.connectionStats[peerId].selectedCandidate.local;
var remoteCandidate = data.connectionStats[peerId].selectedCandidate.remote;
console.log(peerId + " - Sending audio (" + sendAudioBytes + "bps) video (" + sendVideoBytes + ")");
console.log(peerId + " - Receiving audio (" + recvAudioBytes + "bps) video (" + recvVideoBytes + ")");
console.log(peerId + " - Local candidate: " + localCandidate.ipAddress + ":" + localCandidate.portNumber +
"?transport=" + localCandidate.transport + " (type: " + localCandidate.candidateType + ")");
console.log(peerId + " - Remote candidate: " + remoteCandidate.ipAddress + ":" + remoteCandidate.portNumber +
"?transport=" + remoteCandidate.transport + " (type: " + remoteCandidate.candidateType + ")");
}
function startBWStatsInterval (peerIdA, peerIdB) {
setInterval(function () {
skylinkDemo.getConnectionStatus([peerIdA, peerIdB], function (error, success) {
if (error) {
printConnStats(peerIdA, error.connectionStats);
printConnStats(peerIdB, error.connectionStats);
} else {
printConnStats(peerIdA, success.connectionStats);
printConnStats(peerIdB, success.connectionStats);
}
});
}, 1000);
}
// Example 3: Retrieve all Peer connection stats
function printConnStats (listOfPeers, data) {
listOfPeers.forEach(function (peerId) {
if (!data.connectionStats[peerId]) return;
var sendVideoBytes = data.connectionStats[peerId].video.sending.bytes;
var sendAudioBytes = data.connectionStats[peerId].audio.sending.bytes;
var recvVideoBytes = data.connectionStats[peerId].video.receiving.bytes;
var recvAudioBytes = data.connectionStats[peerId].audio.receiving.bytes;
var localCandidate = data.connectionStats[peerId].selectedCandidate.local;
var remoteCandidate = data.connectionStats[peerId].selectedCandidate.remote;
console.log(peerId + " - Sending audio (" + sendAudioBytes + "bps) video (" + sendVideoBytes + ")");
console.log(peerId + " - Receiving audio (" + recvAudioBytes + "bps) video (" + recvVideoBytes + ")");
console.log(peerId + " - Local candidate: " + localCandidate.ipAddress + ":" + localCandidate.portNumber +
"?transport=" + localCandidate.transport + " (type: " + localCandidate.candidateType + ")");
console.log(peerId + " - Remote candidate: " + remoteCandidate.ipAddress + ":" + remoteCandidate.portNumber +
"?transport=" + remoteCandidate.transport + " (type: " + remoteCandidate.candidateType + ")");
});
}
function startBWStatsInterval (peerIdA, peerIdB) {
setInterval(function () {
skylinkDemo.getConnectionStatus(function (error, success) {
if (error) {
printConnStats(error.listOfPeers, error.connectionStats);
} else {
printConnStats(success.listOfPeers, success.connectionStats);
}
});
}, 1000);
}
Events Sequence:
- Retrieves Peer connection stats for all targeted Peers.
- If Peer connection has closed or does not exists: This can be checked with
peerConnectionStateevent triggering parameter payloadstateasCLOSEDfor Peer.-
getConnectionStatusStateChangeevent triggers parameter payloadstateasRETRIEVE_ERROR. - ABORT and return error.
-
getConnectionStatusStateChangeevent triggers parameter payloadstateasRETRIEVING.- Received response from retrieval.
- If retrieval was successful:
getConnectionStatusStateChangeevent triggers parameter payloadstateasRETRIEVE_SUCCESS.
- Else:
-
getConnectionStatusStateChangeevent triggers parameter payloadstateasRETRIEVE_ERROR.
-
- If retrieval was successful:
- If Peer connection has closed or does not exists: This can be checked with
Parameters:
-
targetPeerId{String | Array} OptionalThe target Peer ID to retrieve connection stats from.
- When provided as an Array, it will retrieve all connection stats from all the Peer IDs provided.
- When not provided, it will retrieve all connection stats from the currently connected Peers in the Room.
-
[callback] The callback function fired when request has completed. <small>Function parameters signature is <code>function (error, success)</code></small> <small>Function request completion is determined by the <a href="#event_getConnectionStatusStateChange"> <code>getConnectionStatusStateChange</code> event</a> triggering <code>state</code> parameter payload value as <code>RETRIEVE_SUCCESS</code> for all Peers targeted for request success.</small> [Rel: Skylink.GET_CONNECTION_STATUS_STATE]{Function} -
callback.error{JSON}The error result in request. Defined as
nullwhen there are no errors in request -
callback.error.listOfPeers{Array}The list of Peer IDs targeted.
-
callback.error.retrievalErrors{JSON}The list of Peer connection stats retrieval errors.
-
callback.error.retrievalErrors.#peerId{Error | String}The Peer connection stats retrieval error associated with the Peer ID defined in
#peerIdproperty. If#peerIdvalue is"self", it means that it is the error when there are no Peer connections to refresh with. -
callback.error.connectionStats{JSON}The list of Peer connection stats. These are the Peer connection stats that has been managed to be successfully retrieved.
-
callback.error.connectionStats.#peerId{JSON}The Peer connection stats associated with the Peer ID defined in
#peerIdproperty. Object signature matches thestatsparameter payload received in thegetConnectionStatusStateChangeevent. -
callback.success{JSON}The success result in request. Defined as
nullwhen there are errors in request -
callback.success.listOfPeers{Array}The list of Peer IDs targeted.
-
callback.success.connectionStats{JSON}The list of Peer connection stats.
-
callback.success.connectionStats.#peerId{JSON}The Peer connection stats associated with the Peer ID defined in
#peerIdproperty. Object signature matches thestatsparameter payload received in thegetConnectionStatusStateChangeevent.
getCurrentDataStreamsSession
()
Function that gets the list of current data streaming sessions.
Example:
// Example 1: Get the list of current data streaming sessions in the same Room
var currentDataStreams = skylinkDemo.getCurrentDataStreamsSession();
Events Sequence:
There is no event sequence for this method.Returns:
The list of Peers Stream.
#streamId{JSON}The data streaming session.
streamInfo{JSON}The data streaming information. Object signature matches the
streamInfoparameter payload received in thedataStreamStateevent except without thechunkamdchunkSizeproperty.peerId{String}The sender Peer ID.
isSelf{Boolean}The flag if Peer is User.
getCurrentDataTransfers
()
Function that gets the list of current data transfers.
Example:
// Example 1: Get the list of current data transfers in the same Room
var currentTransfers = skylinkDemo.getCurrentDataTransfers();
Events Sequence:
There is no event sequence for this method.Returns:
The list of Peers Stream.
#transferId{JSON}The data transfer session.
transferInfo{JSON}The data transfer information. Object signature matches the
transferInfoparameter payload received in thedataTransferStateevent except without thedataproperty.peerId{String}The sender Peer ID.
isSelf{Boolean}The flag if Peer is User.
getPeerCustomSettings
()
Function that gets the list of current custom Peer settings sent and set.
Example:
// Example 1: Get the list of current Peer custom settings
var currentPeerSettings = skylinkDemo.getPeersCustomSettings();
Events Sequence:
There is no event sequence for this method.Returns:
The list of Peers custom settings sent and set.
#peerId{JSON}The Peer settings sent and set.
settings{JSON}The custom Peer settings. Object signature matches the
peerInfo.settingsparameter payload received in thepeerJoinedevent.mediaStatus{JSON}The custom Peer Stream muted settings. Object signature matches the
peerInfo.mediaStatusparameter payload received in thepeerJoinedevent.
getPeerInfo
[peerId]
,
)
Function that returns the User / Peer current session information.
Example:
// Example 1: Get Peer current session information
var peerPeerInfo = skylinkDemo.getPeerInfo(peerId);
// Example 2: Get User current session information
var userPeerInfo = skylinkDemo.getPeerInfo();
Events Sequence:
There is no event sequence for this method.Parameters:
-
peerId{String} OptionalThe Peer ID to return the current session information from.
- When not provided or that the Peer ID is does not exists, it will return the User current session information.
Returns:
The User / Peer current session information.
Object signature matches the peerInfo parameter payload received in the
peerJoined event.
getPeers
[showAll=false]
,
[callback] The callback function fired when request has completed.
<small>Function parameters signature is <code>function (error, success)</code></small>
<small>Function request completion is determined by the <a href="#event_getPeersStateChange">
<code>getPeersStateChange</code> event</a> triggering <code>state</code> parameter payload value as
<code>RECEIVED</code> for request success.</small>
[Rel: Skylink.GET_PEERS_STATE]
,
callback.error
,
callback.success
,
)
Note that this feature requiresFunction that retrieves the list of Peer IDs from Rooms within the same App space."isPrivileged"flag to be enabled for the App Key provided in theinit()method, as only Users connecting using the App Key with this flag enabled (which we call privileged Users / Peers) can retrieve the list of Peer IDs from Rooms within the same App space. Read more about privileged App Key feature here.
Example:
// Example 1: Retrieving the un-privileged Peers
skylinkDemo.joinRoom(function (jRError, jRSuccess) {
if (jRError) return;
skylinkDemo.getPeers(function (error, success) {
if (error) return;
console.log("The list of only un-privileged Peers in the same App space ->", success);
});
});
// Example 2: Retrieving the all Peers (privileged or un-privileged)
skylinkDemo.joinRoom(function (jRError, jRSuccess) {
if (jRError) return;
skylinkDemo.getPeers(true, function (error, success) {
if (error) return;
console.log("The list of all Peers in the same App space ->", success);
});
});
Events Sequence:
- If App Key provided in the
init()method is not a Privileged enabled Key:- ABORT and return error.
- Retrieves the list of Peer IDs from Rooms within the same App space.
getPeersStateChangeevent triggers parameter payloadstatevalue asENQUIRED.- If received list from Signaling server successfully:
getPeersStateChangeevent triggers parameter payloadstatevalue asRECEIVED.
Parameters:
-
showAll{Boolean} OptionalDEFAULT:falseThe flag if Signaling server should also return the list of privileged Peer IDs. By default, the Signaling server does not include the list of privileged Peer IDs in the return result.
-
[callback] The callback function fired when request has completed. <small>Function parameters signature is <code>function (error, success)</code></small> <small>Function request completion is determined by the <a href="#event_getPeersStateChange"> <code>getPeersStateChange</code> event</a> triggering <code>state</code> parameter payload value as <code>RECEIVED</code> for request success.</small> [Rel: Skylink.GET_PEERS_STATE]{Function} -
callback.error{Error | String}The error result in request. Defined as
nullwhen there are no errors in request Object signature is thegetPeers()error when retrieving list of Peer IDs from Rooms within the same App space. -
callback.success{JSON}The success result in request. Defined as
nullwhen there are errors in request Object signature matches thepeerListparameter payload received in thegetPeersStateChangeevent.
getPeersDatachannels
()
Function that gets the current list of connected Peers Datachannel connections in the Room.
Example:
// Example 1: Get the list of current Peers Datachannels in the same Room
var channels = skylinkDemo.getPeersDatachannels();
Events Sequence:
There is no event sequence for this method.Returns:
The list of Peers Stream.
#peerId{JSON}The Peer Datachannels information.
#channelName{JSON}The Datachannel information.
channelName{String}The Datachannel ID..
channelType{String}The Datachannel type. [Rel: Skylink.DATA_CHANNEL_TYPE]
channelProp{String}The Datachannel property.
currentTransferId{String}The Datachannel connection current progressing transfer session. Defined as
nullwhen there is currently no transfer session progressing on the Datachannel connection.currentStreamId{String}The Datachannel connection current data streaming session ID. Defined as
nullwhen there is currently no data streaming session on the Datachannel connection.readyState{String}The Datachannel connection readyState. [Rel: Skylink.DATA_CHANNEL_STATE]
bufferedAmountLow{Number}The Datachannel buffered amount.
bufferedAmountLowThreshold{Number}The Datachannel buffered amount threshold.
getPeersInRoom
()
Function that gets the list of connected Peers in the Room.
Example:
// Example 1: Get the list of currently connected Peers in the same Room
var peers = skylinkDemo.getPeersInRoom();
Events Sequence:
There is no event sequence for this method.Returns:
The list of connected Peers.
#peerId{JSON}The Peer information. Object signature matches the
peerInfoparameter payload received in thepeerJoinedevent except there is theisSelfflag that determines if Peer is User or not.
getPeersStream
()
Function that gets the list of connected Peers Streams in the Room.
Example:
// Example 1: Get the list of current Peers Streams in the same Room
var streams = skylinkDemo.getPeersStream();
Events Sequence:
There is no event sequence for this method.Returns:
The list of Peers Stream.
#peerId{JSON}The Peer Stream.
stream{MediaStream}The Stream object.
streamId{String}The Stream ID.
isSelf{Boolean}The flag if Peer is User.
getRecordings
()
Note that this feature requires MCU and recording to be enabled for the App Key provided in the
init() method. If recording feature is not available to
be enabled in the Developer Console, please
contact us on our support portal.
Gets the list of current recording sessions since User has connected to the Room.
Example:
// Example 1: Get recording sessions
skylinkDemo.getRecordings();
Events Sequence:
There is no event sequence for this method.Returns:
The list of recording sessions.
#recordingId{JSON}The recording session.
active{Boolean}The flag that indicates if the recording session is currently active.
state{Number}The current recording state. [Rel: Skylink.RECORDING_STATE]
startedDateTime{String}The recording session started DateTime in ISO 8601 format.Note that this value may not be very accurate as this value is recorded when the start event is received.
endedDateTime{String}The recording session ended DateTime in ISO 8601 format.Note that this value may not be very accurate as this value is recorded when the stop event is received. Defined only after
statehas triggeredSTOP.mixingDateTime{String}The recording session mixing completed DateTime in ISO 8601 format.Note that this value may not be very accurate as this value is recorded when the mixing completed event is received. Defined only when
stateisLINK.links{JSON}The recording session links. Object signature matches the
linkparameter payload received in therecordingStateevent. Defined only whenstateisLINK.error{Error}The recording session error. Defined only when
stateisERROR.
getUserData
[peerId]
,
)
Function that returns the User / Peer current custom data.
Example:
// Example 1: Get Peer current custom data
var peerUserData = skylinkDemo.getUserData(peerId);
// Example 2: Get User current custom data
var userUserData = skylinkDemo.getUserData();
Events Sequence:
There is no event sequence for this method.Parameters:
-
peerId{String} OptionalThe Peer ID to return the current custom data from.
- When not provided or that the Peer ID is does not exists, it will return the User current custom data.
Returns:
The User / Peer current custom data.
getUserMedia
[options]
,
[options.audio.optional] <blockquote class="info">
Note that this may result in constraints related error when <code>options.useExactConstraints</code> value is
<code>true</code>. If you are looking to set the requested source ID of the audio track,
use <code>options.audio.deviceId</code> instead.</blockquote>
The <code>navigator.getUserMedia()</code> API <code>audio: { optional [..]
,
[options.video.resolution] The video resolution.
<small>By default, <a href="#attr_VIDEO_RESOLUTION"><code>VGA</code></a> resolution option
is selected when not provided.</small>
[Rel: Skylink.VIDEO_RESOLUTION]
,
[options.video.optional] <blockquote class="info">
Note that this may result in constraints related error when <code>options.useExactConstraints</code> value is
<code>true</code>. If you are looking to set the requested source ID of the video track,
use <code>options.video.deviceId</code> instead.</blockquote>
The <code>navigator.getUserMedia()</code> API <code>video: { optional [..]
,
[callback]
,
)
For a better user experience, the functionality is throttled when invoked many times in less
than the milliseconds interval configured in the init() method.
Function that retrieves camera Stream.
Example:
// Example 1: Get both audio and video.
skylinkDemo.getUserMedia(function (error, success) {
if (error) return;
attachMediaStream(document.getElementById("my-video"), success);
});
// Example 2: Get only audio.
skylinkDemo.getUserMedia({
audio: true
}, function (error, success) {
if (error) return;
attachMediaStream(document.getElementById("my-audio"), success);
});
// Example 3: Configure resolution for video
skylinkDemo.getUserMedia({
audio: true,
video: {
resolution: skylinkDemo.VIDEO_RESOLUTION.HD
}
}, function (error, success) {
if (error) return;
attachMediaStream(document.getElementById("my-video"), success);
});
// Example 4: Configure stereo flag for OPUS codec audio (OPUS is always used by default)
skylinkDemo.init({
appKey: "xxxxxx",
audioCodec: skylinkDemo.AUDIO_CODEC.OPUS
}, function (initErr, initSuccess) {
skylinkDemo.getUserMedia({
audio: {
stereo: true
},
video: true
}, function (error, success) {
if (error) return;
attachMediaStream(document.getElementById("my-video"), success);
});
});
// Example 5: Configure frameRate for video
skylinkDemo.getUserMedia({
audio: true,
video: {
frameRate: 50
}
}, function (error, success) {
if (error) return;
attachMediaStream(document.getElementById("my-video"), success);
});
// Example 6: Configure video and audio based on selected sources. Does not work for Firefox currently.
var sources = { audio: [], video: [] };
function selectStream (audioSourceId, videoSourceId) {
if (window.webrtcDetectedBrowser === 'firefox') {
console.warn("Currently this feature is not supported by Firefox browsers!");
return;
}
skylinkDemo.getUserMedia({
audio: {
optional: [{ sourceId: audioSourceId }]
},
video: {
optional: [{ sourceId: videoSourceId }]
}
}, function (error, success) {
if (error) return;
attachMediaStream(document.getElementById("my-video"), success);
});
}
navigator.mediaDevices.enumerateDevices().then(function(devices) {
var selectedAudioSourceId = "";
var selectedVideoSourceId = "";
devices.forEach(function(device) {
console.log(device.kind + ": " + device.label + " source ID = " + device.deviceId);
if (device.kind === "audio") {
selectedAudioSourceId = device.deviceId;
} else {
selectedVideoSourceId = device.deviceId;
}
});
selectStream(selectedAudioSourceId, selectedVideoSourceId);
}).catch(function (error) {
console.error("Failed", error);
});
Events Sequence:
- If
options.audiovalue isfalseandoptions.videovalue isfalse:- ABORT and return error.
- Retrieve camera Stream.
- If retrieval was succesful:
- If there is any previous
getUserMedia()Stream:- Invokes
stopStream()method.
- Invokes
- If there are missing audio or video tracks requested:
mediaAccessFallbackevent triggers parameter payloadstateasFALLBACKED,isScreensharingvalue asfalseandisAudioFallbackvalue asfalse.
- Mutes / Unmutes audio and video tracks based on current muted settings in
peerInfo.mediaStatus. This can be retrieved withgetPeerInfo()method. mediaAccessSuccessevent triggers parameter payloadisScreensharingvalue asfalseandisAudioFallbackvalue asfalse.
- If there is any previous
- Else:
- If
options.audioFallbackis enabled in theinit()method,options.audiovalue istrueandoptions.videovalue istrue:mediaAccessFallbackevent event triggers parameter payloadstateasFALLBACKING,isScreensharingvalue asfalseandisAudioFallbackvalue astrue.- Retrieve camera Stream with audio tracks only.
- If retrieval was successful:
- If there is any previous
getUserMedia()Stream:- Invokes
stopStream()method.
- Invokes
mediaAccessFallbackevent event triggers parameter payloadstateasFALLBACKED,isScreensharingvalue asfalseandisAudioFallbackvalue astrue.- Mutes / Unmutes audio and video tracks based on current muted settings in
peerInfo.mediaStatus. This can be retrieved withgetPeerInfo()method. mediaAccessSuccessevent triggers parameter payloadisScreensharingvalue asfalseandisAudioFallbackvalue astrue.
- If there is any previous
- Else:
mediaAccessErrorevent triggers parameter payloadisScreensharingvalue asfalseandisAudioFallbackErrorvalue astrue.mediaAccessFallbackevent event triggers parameter payloadstateasERROR,isScreensharingvalue asfalseandisAudioFallbackvalue astrue.- ABORT and return error.
- If retrieval was successful:
- Else:
mediaAccessErrorevent triggers parameter payloadisScreensharingvalue asfalseandisAudioFallbackErrorvalue asfalse.- ABORT and return error.
- If
- If retrieval was succesful:
Parameters:
-
options{JSON} OptionalThe camera Stream configuration options.
- When not provided, the value is set to
{ audio: true, video: true }. To fallback to retrieve audio track only when retrieving of audio and video tracks failed, enable theaudioFallbackflag in theinit()method.
-
useExactConstraints{Boolean} OptionalDEFAULT:falseNote 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
The flag ifoptions.video.frameRateoption in Safari and IE (any plugin-enabled) browsers, where the expected maximum value will not be requested due to the lack of support.getUserMedia()should request for camera Stream to match exact requested values ofoptions.audio.deviceIdandoptions.video.deviceId,options.video.resolutionandoptions.video.frameRatewhen provided. -
audio{Boolean | JSON} OptionalDEFAULT:falseNote that the current Edge browser implementation does not support the
The audio configuration options.options.audio.optional,options.audio.deviceId,options.audio.echoCancellation.-
stereo{Boolean} OptionalDEFAULT:falseDeprecation Warning! This property has been deprecated. Configure this with the
The flag if OPUS audio codec stereo band should be configured for sending encoded audio data. When not provided, the default browser configuration is used.options.codecParams.audio.opus.stereoparameter in theinit()method instead. If theoptions.codecParams.audio.opus.stereois configured, this overrides theoptions.audio.stereosetting. -
usedtx{Boolean} OptionalDeprecation Warning! This property has been deprecated. Configure this with the
The flag if OPUS audio codec should enable DTX (Discontinuous Transmission) for sending encoded audio data. This might help to reduce bandwidth as it reduces the bitrate during silence or background noise, and goes hand-in-hand with theoptions.codecParams.audio.opus.stereoparameter in theinit()method instead. If theoptions.codecParams.audio.opus.stereois configured, this overrides theoptions.audio.stereosetting. Note that this feature might not work depending on the browser support and implementation.options.voiceActivityDetectionflag injoinRoom()method. When not provided, the default browser configuration is used. -
useinbandfec{Boolean} OptionalDeprecation Warning! This property has been deprecated. Configure this with the
The flag if OPUS audio codec has the capability to take advantage of the in-band FEC (Forward Error Correction) when sending encoded audio data. This helps to reduce the harm of packet loss by encoding information about the previous packet loss. When not provided, the default browser configuration is used.options.codecParams.audio.opus.useinbandfecparameter in theinit()method instead. If theoptions.codecParams.audio.opus.useinbandfecis configured, this overrides theoptions.audio.useinbandfecsetting. Note that this parameter should only be used for debugging purposes only. -
maxplaybackrate{Number} OptionalDeprecation Warning! This property has been deprecated. Configure this with the
The OPUS audio codec maximum output sampling rate in Hz (hertz) that is is capable of receiving decoded audio data, to adjust to the hardware limitations and ensure that any sending audio data would not encode at a higher sampling rate specified by this. This value must be betweenoptions.codecParams.audio.opus.maxplaybackrateparameter in theinit()method instead. If theoptions.codecParams.audio.opus.maxplaybackrateis configured, this overrides theoptions.audio.maxplaybackratesetting. Note that this feature might not work depending on the browser support and implementation. Note that this parameter should only be used for debugging purposes only.8000to48000. When not provided, the default browser configuration is used. -
mute{Boolean} OptionalDEFAULT:falseThe flag if audio tracks should be muted upon receiving them. Providing the value asfalsedoes nothing topeerInfo.mediaStatus.audioMuted, but when provided astrue, this sets thepeerInfo.mediaStatus.audioMutedvalue totrueand mutes any existingshareScreen()Stream audio tracks as well. -
deviceId{String} OptionalNote this is currently not supported in Firefox browsers.
The audio track source ID of the device to use. The list of available audio source ID can be retrieved by thenavigator.mediaDevices.enumerateDevicesAPI. -
echoCancellation{Boolean} OptionalDEFAULT:trueFor Chrome/Opera/IE/Safari/Bowser, the echo cancellation functionality may not work and may produce a terrible feedback. It is recommended to use headphones or other microphone devices rather than the device in-built microphones.
The flag to enable echo cancellation for audio track.
-
-
video{Boolean | JSON} OptionalDEFAULT:falseNote that the current Edge browser implementation does not support the
The video configuration options.options.video.optional,options.video.deviceId,options.video.resolutionandoptions.video.frameRate,options.video.facingMode.-
mute{Boolean} OptionalDEFAULT:falseThe flag if video tracks should be muted upon receiving them. Providing the value asfalsedoes nothing topeerInfo.mediaStatus.videoMuted, but when provided astrue, this sets thepeerInfo.mediaStatus.videoMutedvalue totrueand mutes any existingshareScreen()Stream video tracks as well. -
resolution.width{Number | JSON} OptionalThe video resolution width. - When provided as a number, it is the video resolution width. - When provided as a JSON, it is thenavigator.mediaDevices.getUserMedia().widthsettings. Parameters are"ideal"for ideal resolution width,"exact"for exact video resolution width,"min"for min video resolution width and"max"for max video resolution width. Note that this may result in constraints related errors depending on the browser/hardware supports. -
resolution.height{Number | JSON} OptionalThe video resolution height. - When provided as a number, it is the video resolution height. - When provided as a JSON, it is thenavigator.mediaDevices.getUserMedia().heightsettings. Parameters are"ideal"for ideal video resolution height,"exact"for exact video resolution height,"min"for min video resolution height and"max"for max video resolution height. Note that this may result in constraints related errors depending on the browser/hardware supports. -
frameRate{Number | JSON} OptionalThe video frameRate per second (fps). - When provided as a number, it is the video framerate. - When provided as a JSON, it is thenavigator.mediaDevices.getUserMedia().frameRatesettings. Parameters are"ideal"for ideal video framerate,"exact"for exact video framerate,"min"for min video framerate and"max"for max video framerate. Note that this may result in constraints related errors depending on the browser/hardware supports. -
deviceId{String} OptionalNote this is currently not supported in Firefox browsers.
The video track source ID of the device to use. The list of available video source ID can be retrieved by thenavigator.mediaDevices.enumerateDevicesAPI. -
facingMode{String | JSON} OptionalThe video camera facing mode. The list of available video source ID can be retrieved by the MediaTrackConstraintsfacingModeAPI.
-
- When not provided, the value is set to
-
[options.audio.optional] <blockquote class="info"> Note that this may result in constraints related error when <code>options.useExactConstraints</code> value is <code>true</code>. If you are looking to set the requested source ID of the audio track, use <code>options.audio.deviceId</code> instead.</blockquote> The <code>navigator.getUserMedia()</code> API <code>audio: { optional [..]{Array}} property.
-
[options.video.resolution] The video resolution. <small>By default, <a href="#attr_VIDEO_RESOLUTION"><code>VGA</code></a> resolution option is selected when not provided.</small> [Rel: Skylink.VIDEO_RESOLUTION]{JSON} -
[options.video.optional] <blockquote class="info"> Note that this may result in constraints related error when <code>options.useExactConstraints</code> value is <code>true</code>. If you are looking to set the requested source ID of the video track, use <code>options.video.deviceId</code> instead.</blockquote> The <code>navigator.getUserMedia()</code> API <code>video: { optional [..]{Array}} property.
-
callback{Function} OptionalThe callback function fired when request has completed. Function parameters signature is
function (error, success)Function request completion is determined by themediaAccessSuccessevent triggeringisScreensharingparameter payload value asfalsefor request success.-
error{Error | String}The error result in request. Defined as
nullwhen there are no errors in request Object signature is thegetUserMedia()error when retrieving camera Stream. -
success{MediaStream}The success result in request. Defined as
nullwhen there are errors in request Object signature is the camera Stream object.
-
init
options
,
[options.TURNServerTransport] <blockquote class="info">
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)</code> query option when constructing
the Peer connection. When all protocols are selected, the ICE servers urls are duplicated with all protocols.<br>
Note that for Edge browsers, this value is overriden as <code>UDP</code> due to its supports.
</blockquote> The option to configure the <code>?transport=</code>
query parameter in TURN ICE servers when constructing a Peer connections.
- When not provided, its value is <code>ANY</code>.
[Rel: Skylink.TURN_TRANSPORT]
,
[options.audioCodec] <blockquote class="info">
Note that if the audio codec is not supported, the SDK will not configure the local <code>"offer"</code> or
<code>"answer"</code> session description to prefer the codec.<br>
Note that for Edge browsers, this value is set as <code>OPUS</code> due to its supports.</blockquote>
The option to configure the preferred audio codec to use to encode sending audio data when available for Peer connection.
- When not provided, its value is <code>AUTO</code>.
[Rel: Skylink.AUDIO_CODEC]
,
[options.videoCodec] <blockquote class="info">
Note that if the video codec is not supported, the SDK will not configure the local <code>"offer"</code> or
<code>"answer"</code> session description to prefer the codec.<br>
Note that for Edge browsers, this value is set as <code>H264</code> due to its supports.</blockquote>
The option to configure the preferred video codec to use to encode sending video data when available for Peer connection.
- When not provided, its value is <code>AUTO</code>.
[Rel: Skylink.VIDEO_CODEC]
,
[options.iceServer] The ICE servers for debugging purposes to use.
- When defined as string, the value is considered as <code>[options.iceServer]
,
[options.priorityWeightScheme] <blockquote class="info">
Note that this parameter should only be used for debugging purposes only and may not work when
internals change.</blockquote> The User's priority weight to enforce User as offerer or answerer.
- When not provided, its value is <code>AUTO</code>.
[Rel: Skylink.PRIORITY_WEIGHT_SCHEME]
,
[callback] The callback function fired when request has completed.
<small>Function parameters signature is <code>function (error, success)</code></small>
<small>Function request completion is determined by the <a href="#event_readyStateChange">
<code>readyStateChange</code> event</a> <code>state</code> parameter payload value
as <code>COMPLETED</code> for request success.</small>
[Rel: Skylink.READY_STATE_CHANGE]
,
callback.error
,
callback.error.errorCode
,
callback.error.error
,
callback.error.status
,
callback.success
,
callback.success.serverUrl
,
callback.success.readyState
,
callback.success.selectedRoom
,
callback.success.appKey
,
callback.success.defaultRoom
,
callback.success.roomServer
,
callback.success.enableIceTrickle
,
callback.success.enableDataChannel
,
callback.success.enableTURNServer
,
callback.success.enableSTUNServer
,
callback.success.TURNTransport
,
callback.success.audioFallback
,
callback.success.forceSSL
,
callback.success.audioCodec
,
callback.success.videoCodec
,
callback.success.socketTimeout
,
callback.success.forceTURNSSL
,
callback.success.forceTURN
,
callback.success.usePublicSTUN
,
callback.success.disableVideoFecCodecs
,
callback.success.disableComfortNoiseCodec
,
callback.success.disableREMB
,
callback.success.filterCandidatesType
,
callback.success.throttleIntervals
,
callback.success.throttleShouldThrowError
,
callback.success.mcuUseRenegoRestart
,
callback.success.iceServer
,
callback.success.socketServer
,
)
Function that authenticates and initialises App Key used for Room connections.
Example:
// Example 1: Using CORS authentication and connection to default Room
skylinkDemo(appKey, function (error, success) {
if (error) return;
skylinkDemo.joinRoom(); // Goes to default Room
});
// Example 2: Using CORS authentication and connection to a different Room
skylinkDemo(appKey, function (error, success) {
skylinkDemo.joinRoom("testxx"); // Goes to "testxx" Room
});
// Example 3: Using credentials authentication and connection to only default Room
var defaultRoom = "test",
startDateTime = (new Date()).toISOString(),
duration = 1, // Allows only User session to stay for 1 hour
appKeySecret = "xxxxxxx",
hash = CryptoJS.HmacSHA1(defaultRoom + "" + duration + "" + startDateTime, appKeySecret);
credentials = encodeURIComponent(hash.toString(CryptoJS.enc.Base64));
skylinkDemo({
defaultRoom: defaultRoom,
appKey: appKey,
credentials: {
duration: duration,
startDateTime: startDateTime,
credentials: credentials
}
}, function (error, success) {
if (error) return;
skylinkDemo.joinRoom(); // Goes to default Room (switching to different Room is not allowed for credentials authentication)
});
Events Sequence:
- If parameter
optionsis not provided:- ABORT and return error.
- Checks if dependecies and browser APIs are available.
- If AdapterJS is not loaded:
readyStateChangeevent triggers parameter payloadstateasERRORanderror.errorCodeasADAPTER_NO_LOADED.- ABORT and return error.
- If socket.io-client is not loaded:
-
readyStateChangeevent triggers parameter payloadstateasERRORanderror.errorCodeasNO_SOCKET_IO. - ABORT and return error.
-
- If XMLHttpRequest API is not available:
-
readyStateChangeevent triggers parameter payloadstateasERRORanderror.errorCodeasNO_XMLHTTPREQUEST_SUPPORT. - ABORT and return error.
-
- If WebRTC is not supported by device:
readyStateChangeevent triggers parameter payloadstateasERRORanderror.errorCodeasNO_WEBRTC_SUPPORT.- ABORT and return error.
- If AdapterJS is not loaded:
- Retrieves Room session token from Auth server.
readyStateChangeevent triggers parameter payloadstateasLOADING.- If retrieval was successful:
readyStateChangeevent triggers parameter payloadstateasCOMPLETED.
- Else:
readyStateChangeevent triggers parameter payloadstateasERROR.- ABORT and return error.
Parameters:
-
options{JSON | String}The configuration options.
- When provided as a string, it's configured as
options.appKey.
-
appKey{String}The App Key. By default,
init()uses HTTP CORS authentication. For credentials based authentication, see theoptions.credentialsconfiguration below. You can know more about the in the authentication methods article here for more details on the various authentication methods. If you are using the Persistent Room feature for scheduled meetings, you will require to use the credential based authentication. See the Persistent Room article here for more information. -
defaultRoom{String} OptionalThe default Room to connect to when no
roomparameter is provided injoinRoom()method.- When not provided or is provided as an empty string, its value is
options.appKey. Note that switching Rooms is not available when usingoptions.credentialsbased authentication. The Room that User will be connected to is thedefaultRoomprovided.
- When not provided or is provided as an empty string, its value is
-
roomServer{String} OptionalThe Auth server for debugging purposes to use. Note that this is a debugging feature and is only used when instructed for debugging purposes.
-
enableIceTrickle{Boolean} OptionalDEFAULT:trueThe flag if Peer connections should trickle ICE for faster connectivity.
-
enableDataChannel{Boolean} OptionalDEFAULT:trueNote that for Edge browsers, this value is overriden as
The flag if Datachannel connections should be enabled. This is required to be enabled forfalsedue to its supports.sendBlobData()method,sendURLData()method andsendP2PMessage()method. -
enableTURNServer{Boolean} OptionalDEFAULT:trueThe 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} OptionalDEFAULT:trueThe flag if STUN ICE servers should be used when constructing Peer connections to allow TURN connections when required.
-
forceTURN{Boolean} OptionalDEFAULT:falseThe flag if Peer connections should enforce connections over the TURN server. This overrides
options.enableTURNServervalue totrueandoptions.enableSTUNServervalue tofalse,options.filterCandidatesType.hostvalue totrue,options.filterCandidatesType.srflxvalue totrueandoptions.filterCandidatesType.relayvalue tofalse. Note that currently for MCU enabled Peer connections, theoptions.filterCandidatesTypeconfiguration is not honoured as Peers connected with MCU is similar as a forced TURN connection. The flags will act as if the value isfalseand ICE candidates will never be filtered regardless of theoptions.filterCandidatesTypeconfiguration. -
usePublicSTUN{Boolean} OptionalDEFAULT:trueThe flag if publicly available STUN ICE servers should be used if
options.enableSTUNServeris enabled. -
disableVideoFecCodecs{Boolean} OptionalDEFAULT:falseNote 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} OptionalDEFAULT:falseNote 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} OptionalDEFAULT:falseNote 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} OptionalThe credentials used for authenticating App Key with credentials to retrieve the Room session token used for connection in
joinRoom()method. Note that switching of Rooms is not allowed when using credentials based authentication, unlessinit()is invoked again with a different set of credentials followed by invoking thejoinRoom()method.-
startDateTime{String}The credentials User session in Room starting DateTime in ISO 8601 format. -
duration{Number}The credentials User session in Room duration in hours. -
credentials{String}The generated credentials used to authenticate the provided App Key with its"secret"property.To generate the credentials:
- Concatenate a string that consists of the Room name you provide in the
options.defaultRoom, theoptions.credentials.durationand theoptions.credentials.startDateTime. Example:var concatStr = defaultRoom + "_" + duration + "_" + startDateTime; - Hash the concatenated string with the App Key
"secret"property using SHA-1. Example:var hash = CryptoJS.HmacSHA1(concatStr, appKeySecret);See theCryptoJS.HmacSHA1library. - Encode the hashed string using base64
Example:
var b64Str = hash.toString(CryptoJS.enc.Base64);See the CryptoJS.enc.Base64 library. - Encode the base64 encoded string to replace special characters using UTF-8 encoding.
Example:
var credentials = encodeURIComponent(base64String);See encodeURIComponent() API.
- Concatenate a string that consists of the Room name you provide in the
-
-
audioFallback{Boolean} OptionalDEFAULT:falseThe flag if
getUserMedia()method should fallback to retrieve only audio Stream when retrieving audio and video Stream fails. -
forceSSL{Boolean} OptionalDEFAULT:falseThe flag if HTTPS connections should be enforced during request to Auth server and socket connections to Signaling server when accessing
window.location.protocolvalue is"http:". By default,"https:"protocol connections uses HTTPS connections. -
audioCodec.codec{String}The audio codec to prefer to encode sending audio data when available. The value must not be
AUTO. [Rel: Skylink.AUDIO_CODEC] -
audioCodec.samplingRate{Number} OptionalThe audio codec sampling to prefer to encode sending audio data when available.
-
audioCodec.channels{Number} OptionalThe audio codec channels to prefer to encode sending audio data when available.
-
videoCodec.codec{String}The video codec to prefer to encode sending audio data when available. The value must not be
AUTO. [Rel: Skylink.VIDEO_CODEC] -
videoCodec.samplingRate{Number} OptionalThe video codec sampling to prefer to encode sending video data when available.
-
socketTimeout{Number} OptionalDEFAULT:20000The 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 mininum timeout value is
5000. If less, this value will be5000. Note that it is recommended to use12000as the lowest timeout value if Peers are connecting using Polling transports to prevent connection errors. -
forceTURNSSL{Boolean} OptionalDEFAULT:falseNote that currently Firefox does not support the TURNS protocol, and that if TURNS is required, TURN ICE servers using port
The flag if TURNS protocol should be used when443will be used instead.
Note that for Edge browsers, this value is overriden asfalsedue to its supports and only port3478is used.options.enableTURNServeris enabled. -
filterCandidatesType{JSON} OptionalNote 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.-
host{Boolean} OptionalDEFAULT:falseThe flag if local network ICE candidates should be filtered out. -
srflx{Boolean} OptionalDEFAULT:falseThe flag if STUN ICE candidates should be filtered out. -
relay{Boolean} OptionalDEFAULT:falseThe flag if TURN ICE candidates should be filtered out.
-
-
throttleIntervals{JSON} OptionalThe configuration options to configure the throttling method timeouts.
-
shareScreen{Number} Optional -
getUserMedia{Number} Optional -
refreshConnection{Number} OptionalDEFAULT:5000Note that this throttling is only done for MCU enabled Peer connections with the
The interval timeout foroptions.mcuUseRenegoRestartbeing set tofalse.refreshConnection()method throttling in milliseconds. Note that there will be no throttling whenrefreshConnection()method is called internally.
-
-
throttleShouldThrowError{Boolean} OptionalDEFAULT:falseThe flag if throttled methods should throw errors when method is invoked less than the interval timeout value configured in
options.throttleIntervals. -
mcuUseRenegoRestart{Boolean} OptionalDEFAULT:falseNote that this feature is currently is beta and for any enquiries on enabling and its support, please contact our support portal.
The flag ifrefreshConnection()method should renegotiate like non-MCU enabled Peer connection for MCU enabled Peer connections instead of invokingjoinRoom()method again. -
iceServer.#index{String} OptionalThe ICE server url for debugging purposes to use.
-
socketServer{String | JSON} OptionalThe Signaling server for debugging purposes to use.
- When defined as string, the value is considered as
{ url: options.socketServer }. Note that this is a debugging feature and is only used when instructed for debugging purposes.
-
url{String}The Signaling server URL for debugging purposes to use. -
ports{Array} OptionalThe list of Signaling server ports for debugging purposes to use. If not defined, it will use the default list of ports specified. -
ports.#index{Number}The Signaling server port to fallback and use for debugging purposes. -
protocol{String} OptionalThe Signaling server protocol for debugging purposes to use. If not defined, it will use the default protocol specified.
- When defined as string, the value is considered as
-
codecParams{JSON} OptionalNote that some of these parameters are mainly used for experimental or debugging purposes. Toggling any of these feature may result in disruptions in connectivity.
The audio and video codecs parameters to configure.-
video{JSON} OptionalThe video codecs parameters to configure. -
video.h264{JSON} OptionalThe H264 video codec parameters to configure. -
video.h264.profileLevelId{String} OptionalNote that this parameter should only be used for debugging purposes only.
The H264 video codec base16 encoded string which indicates the H264 baseline, main, or the extended profiles. When not provided, the default browser configuration is used. -
video.h264.levelAsymmetryAllowed{Boolean} OptionalNote that this is an experimental parameter which may result in connectivity issues when toggled.
The flag if streaming H264 sending video data should be encoded at a different level from receiving video data from Peer encoding to User when Peer is the offerer. If Peer is the offerer instead of the User, the Peer'speerInfo.config.priorityWeightwill be higher than User'speerInfo.config.priorityWeight. When not provided, the default browser configuration is used. -
video.h264.packetizationMode{Boolean} OptionalNote that this is an experimental parameter which may result in connectivity issues when enabled. It is advisable to turn off this feature off when receiving H264 decoders do not support the packetization mode, which may result in a blank receiving video stream.
The flag to enable H264 video codec packetization mode, which splits video frames that are larger for a RTP packet into RTP packet chunks. When not provided, the default browser configuration is used. -
video.vp8{JSON} OptionalThe VP8 video codec parameters to configure. -
video.vp8.maxFr{Number} OptionalNote that this parameter should only be used for debugging purposes only. Do not toggle this otherwise.
The maximum number of fps (frames per second) that the VP8 video codec decoder is capable of decoding when receiving encoded video data packets. When not provided, the default browser configuration is used. -
video.vp8.maxFs{Number} OptionalNote that this parameter should only be used for debugging purposes only. Do not toggle this otherwise.
The maximum number of frame size macroblocks that the VP8 video codec decoder is capable of decoding when receiving encoded video data packets. The value has to have the width and height of the frame in macroblocks less than the value ofparseInt(Math.sqrt(maxFs * 8)). E.g. If the value is1200, it is capable of support640x480frame width and height, which heights up to1552px(97macroblocks value. When not provided, the default browser configuration is used. -
video.vp9{JSON} OptionalThe VP9 video codec parameters to configure. -
video.vp9.maxFr{Number} OptionalNote that this parameter should only be used for debugging purposes only. Do not toggle this otherwise.
The maximum number of fps (frames per second) that the VP9 video codec decoder is capable of decoding when receiving encoded video data packets. When not provided, the default browser configuration is used. -
video.vp9.maxFs{Number} OptionalNote that this parameter should only be used for debugging purposes only. Do not toggle this otherwise.
The maximum number of frame size macroblocks that the VP9 video codec decoder is capable of decoding when receiving encoded video data packets. The value has to have the width and height of the frame in macroblocks less than the value ofparseInt(Math.sqrt(maxFs * 8)). E.g. If the value is1200, it is capable of support640x480frame width and height, which heights up to1552px(97macroblocks value. When not provided, the default browser configuration is used. -
audio{JSON} OptionalThe audio codecs parameters to configure. -
audio.opus{JSON} OptionalNote that this is only applicable to OPUS audio codecs with a sampling rate of
The OPUS audio codec parameters to configure.48000Hz (hertz). -
audio.opus.stereo{Boolean} OptionalThe flag if OPUS audio codec stereo band should be configured for sending encoded audio data. When not provided, the default browser configuration is used. -
audio.opus.usedtx{Boolean} OptionalNote that this feature might not work depending on the browser support and implementation.
The flag if OPUS audio codec should enable DTX (Discontinuous Transmission) for sending encoded audio data. This might help to reduce bandwidth as it reduces the bitrate during silence or background noise, and goes hand-in-hand with theoptions.voiceActivityDetectionflag injoinRoom()method. When not provided, the default browser configuration is used. -
audio.opus.useinbandfec{Boolean} OptionalNote that this parameter should only be used for debugging purposes only.
The flag if OPUS audio codec has the capability to take advantage of the in-band FEC (Forward Error Correction) when sending encoded audio data. This helps to reduce the harm of packet loss by encoding information about the previous packet loss. When not provided, the default browser configuration is used. -
audio.opus.maxplaybackrate{Number} OptionalNote that this parameter should only be used for debugging purposes only.
The OPUS audio codec maximum output sampling rate in Hz (hertz) that is is capable of receiving decoded audio data, to adjust to the hardware limitations and ensure that any sending audio data would not encode at a higher sampling rate specified by this. This value must be between8000to48000. When not provided, the default browser configuration is used. -
minptime{Number} OptionalNote 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 between3to120When not provided, the default browser configuration is used.
-
- When provided as a string, it's configured as
-
[options.TURNServerTransport] <blockquote class="info"> 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)</code> query option when constructing the Peer connection. When all protocols are selected, the ICE servers urls are duplicated with all protocols.<br> Note that for Edge browsers, this value is overriden as <code>UDP</code> due to its supports. </blockquote> The option to configure the <code>?transport=</code> query parameter in TURN ICE servers when constructing a Peer connections. - When not provided, its value is <code>ANY</code>. [Rel: Skylink.TURN_TRANSPORT]{Boolean} -
[options.audioCodec] <blockquote class="info"> Note that if the audio codec is not supported, the SDK will not configure the local <code>"offer"</code> or <code>"answer"</code> session description to prefer the codec.<br> Note that for Edge browsers, this value is set as <code>OPUS</code> due to its supports.</blockquote> The option to configure the preferred audio codec to use to encode sending audio data when available for Peer connection. - When not provided, its value is <code>AUTO</code>. [Rel: Skylink.AUDIO_CODEC]{String | JSON} -
[options.videoCodec] <blockquote class="info"> Note that if the video codec is not supported, the SDK will not configure the local <code>"offer"</code> or <code>"answer"</code> session description to prefer the codec.<br> Note that for Edge browsers, this value is set as <code>H264</code> due to its supports.</blockquote> The option to configure the preferred video codec to use to encode sending video data when available for Peer connection. - When not provided, its value is <code>AUTO</code>. [Rel: Skylink.VIDEO_CODEC]{String | JSON} -
[options.iceServer] The ICE servers for debugging purposes to use. - When defined as string, the value is considered as <code>[options.iceServer]{String | Array}. Note that this is a debugging feature and is only used when instructed for debugging purposes.
-
[options.priorityWeightScheme] <blockquote class="info"> Note that this parameter should only be used for debugging purposes only and may not work when internals change.</blockquote> The User's priority weight to enforce User as offerer or answerer. - When not provided, its value is <code>AUTO</code>. [Rel: Skylink.PRIORITY_WEIGHT_SCHEME]{String} -
[callback] The callback function fired when request has completed. <small>Function parameters signature is <code>function (error, success)</code></small> <small>Function request completion is determined by the <a href="#event_readyStateChange"> <code>readyStateChange</code> event</a> <code>state</code> parameter payload value as <code>COMPLETED</code> for request success.</small> [Rel: Skylink.READY_STATE_CHANGE]{Function} -
callback.error{JSON | String}The error result in request.
- When defined as string, it's the error when required App Key is not provided.
Defined as
nullwhen there are no errors in request
- When defined as string, it's the error when required App Key is not provided.
Defined as
-
callback.error.errorCode{Number}The
readyStateChangeeventerror.errorCodeparameter payload value. [Rel: Skylink.READY_STATE_CHANGE_ERROR] -
callback.error.error{Error | String}The
readyStateChangeeventerror.contentparameter payload value. -
callback.error.status{Number}The
readyStateChangeeventerror.statusparameter payload value. -
callback.success{JSON}The success result in request. Defined as
nullwhen there are errors in request -
callback.success.serverUrl{String}The constructed REST URL requested to Auth server.
-
callback.success.readyState{Number}The current ready state. [Rel: Skylink.READY_STATE_CHANGE]
-
callback.success.selectedRoom{String}The Room based on the current Room session token retrieved for.
-
callback.success.appKey{String}The configured value of the
options.appKey. -
callback.success.defaultRoom{String}The configured value of the
options.defaultRoom. -
callback.success.roomServer{String}The configured value of the
options.roomServer. -
callback.success.enableIceTrickle{Boolean}The configured value of the
options.enableIceTrickle. -
callback.success.enableDataChannel{Boolean}The configured value of the
options.enableDataChannel. -
callback.success.enableTURNServer{Boolean}The configured value of the
options.enableTURNServer. -
callback.success.enableSTUNServer{Boolean}The configured value of the
options.enableSTUNServer. -
callback.success.TURNTransport{Boolean}The configured value of the
options.TURNServerTransport. -
callback.success.audioFallback{Boolean}The configured value of the
options.audioFallback. -
callback.success.forceSSL{Boolean}The configured value of the
options.forceSSL. -
callback.success.audioCodec{String | JSON}The configured value of the
options.audioCodec. -
callback.success.videoCodec{String | JSON}The configured value of the
options.videoCodec. -
callback.success.socketTimeout{Number}The configured value of the
options.socketTimeout. -
callback.success.forceTURNSSL{Boolean}The configured value of the
options.forceTURNSSL. -
callback.success.forceTURN{Boolean}The configured value of the
options.forceTURN. -
callback.success.usePublicSTUN{Boolean}The configured value of the
options.usePublicSTUN. -
callback.success.disableVideoFecCodecs{Boolean}The configured value of the
options.disableVideoFecCodecs. -
callback.success.disableComfortNoiseCodec{Boolean}The configured value of the
options.disableComfortNoiseCodec. -
callback.success.disableREMB{Boolean}The configured value of the
options.disableREMB. -
callback.success.filterCandidatesType{JSON}The configured value of the
options.filterCandidatesType. -
callback.success.throttleIntervals{JSON}The configured value of the
options.throttleIntervals. -
callback.success.throttleShouldThrowError{Boolean}The configured value of the
options.throttleShouldThrowError. -
callback.success.mcuUseRenegoRestart{JSON}The configured value of the
options.mcuUseRenegoRestart. -
callback.success.iceServer{JSON}The configured value of the
options.iceServer. See the.urlsproperty in this object for configured value if defined. -
callback.success.socketServer{JSON | String}The configured value of the
options.socketServer.
introducePeer
sendingPeerId
,
receivingPeerId
,
)
Note that this feature requiresFunction that selects and introduces a pair of Peers to start connection with each other."isPrivileged"flag to be enabled and"autoIntroduce"flag to be disabled for the App Key provided in theinit()method, as only Users connecting using the App Key with this flag enabled (which we call privileged Users / Peers) can retrieve the list of Peer IDs from Rooms within the same App space. Read more about privileged App Key feature here.
Example:
// Example 1: Introduce a pair of Peers
skylinkDemo.on("introduceStateChange", function (state, privilegedPeerId, sendingPeerId, receivingPeerId) {
if (state === skylinkDemo.INTRODUCE_STATE.INTRODUCING) {
console.log("Peer '" + sendingPeerId + "' has been introduced to '" + receivingPeerId + "'");
}
});
skylinkDemo.joinRoom(function (jRError, jRSuccess) {
if (jRError) return;
skylinkDemo.getPeers(function (gPError, gPSuccess) {
if (gPError) return;
skylinkDemo.introducePeer(gPSuccess.roomName[0], gPSuccess.roomName[1]);
});
});
Events Sequence:
- If App Key provided in the
init()method is not a Privileged enabled Key:- ABORT and return error.
- Starts sending introduction request for the selected pair of Peers to the Signaling server.
introduceStateChangeevent triggers parameter payloadstatevalue asINTRODUCING.- If received errors from Signaling server:
introduceStateChangeevent triggers parameter payloadstatevalue asERROR.
Parameters:
-
sendingPeerId{String}The Peer ID to be connected with
receivingPeerId. -
receivingPeerId{String}The Peer ID to be connected with
sendingPeerId.
joinRoom
[room]
,
[options]
,
[options.peerConnection.bundlePolicy] The Peer connection media bundle policy.
- When not provided, its value is <code>BALANCED</code>.
[Rel: Skylink.BUNDLE_POLICY]
,
[options.peerConnection.rtcpMuxPolicy] The Peer connection RTP and RTCP ICE candidates mux policy.
- When not provided, its value is <code>REQUIRE</code>.
[Rel: Skylink.RTCP_MUX_POLICY]
,
[options.peerConnection.certificate] The type of certificate that Peer connection should
generate and use when available.
- When not provided, its value is <code>AUTO</code>.
[Rel: Skylink.PEER_CERTIFICATE]
,
[callback]
,
[callback.error.errorCode] The current <a href="#method_init"><code>init()</code> method</a> ready state.
<small>Defined as <code>null</code> when no <a href="#method_init"><code>init()</code> method</a>
has not been called due to invalid configuration.</small>
[Rel: Skylink.READY_STATE_CHANGE]
,
)
Function that starts the Room session.
Example:
// Example 1: Connecting to the default Room without Stream
skylinkDemo.joinRoom(function (error, success) {
if (error) return;
console.log("User connected.");
});
// Example 2: Connecting to Room "testxx" with Stream
skylinkDemo.joinRoom("testxx", {
audio: true,
video: true
}, function (error, success) {
if (error) return;
console.log("User connected with getUserMedia() Stream.")
});
// Example 3: Connecting to default Room with Stream retrieved earlier
skylinkDemo.getUserMedia(function (gUMError, gUMSuccess) {
if (gUMError) return;
skylinkDemo.joinRoom(function (error, success) {
if (error) return;
console.log("User connected with getUserMedia() Stream.");
});
});
// Example 4: Connecting to "testxx" Room with shareScreen() Stream retrieved manually
skylinkDemo.on("mediaAccessRequired", function () {
skylinkDemo.shareScreen(function (sSError, sSSuccess) {
if (sSError) return;
});
});
skylinkDemo.joinRoom("testxx", {
manualGetUserMedia: true
}, function (error, success) {
if (error) return;
console.log("User connected with shareScreen() Stream.");
});
// Example 5: Connecting to "testxx" Room with User custom data
var data = { username: "myusername" };
skylinkDemo.joinRoom("testxx", {
userData: data
}, function (error, success) {
if (error) return;
console.log("User connected with correct user data?", success.peerInfo.userData.username === data.username);
});
Events Sequence:
- If User is in a Room:
- Invoke
leaveRoom()method to end current Room connection. InvokedleaveRoom()methodstopMediaOptionsparameter value will befalse. Regardless of request errors,joinRoom()will still proceed.
- Invoke
- Check if Room name provided matches the Room name of the currently retrieved Room session token.
- If Room name does not matches:
- Invoke
init()method to retrieve new Room session token.- If request has errors:
- ABORT and return error.
- If request has errors:
- Invoke
- If Room name does not matches:
- Open a new socket connection to Signaling server.
- If Socket connection fails:
socketErrorevent triggers parameter payloaderrorCodeasCONNECTION_FAILED.- Checks if there are fallback ports and transports to use.
- If there are still fallback ports and transports:
- Attempts to retry socket connection to Signaling server.
channelRetryevent triggers.socketErrorevent triggers parameter payloaderrorCodeasRECONNECTION_ATTEMPT.- If attempt to retry socket connection to Signaling server has failed:
socketErrorevent triggers parameter payloaderrorCodeasRECONNECTION_FAILED.- Checks if there are still any more fallback ports and transports to use.
- If there are is no more fallback ports and transports to use:
socketErrorevent triggers parameter payloaderrorCodeasRECONNECTION_ABORTED.- ABORT and return error.
- Else:
- REPEAT attempt to retry socket connection to Signaling server step.
- If there are is no more fallback ports and transports to use:
- Attempts to retry socket connection to Signaling server.
- Else:
socketErrorevent triggers parameter payloaderrorCodeasCONNECTION_ABORTED.- ABORT and return error.
- If there are still fallback ports and transports:
- Checks if there are fallback ports and transports to use.
- If socket connection to Signaling server has opened:
channelOpenevent triggers.
- If Socket connection fails:
- Checks if there is
options.manualGetUserMediarequested- If it is requested:
mediaAccessRequiredevent triggers.- If more than 30 seconds has passed and no
getUserMedia()Stream orshareScreen()Stream has been retrieved:- ABORT and return error.
- Else:
- If there is
options.audiooroptions.videorequested:- Invoke
getUserMedia()method.- If request has errors:
- ABORT and return error.
- If request has errors:
- Invoke
- If there is
- If it is requested:
- Starts the Room session
- If Room session has started successfully:
peerJoinedevent triggers parameter payloadisSelfvalue astrue.- If MCU is enabled for the App Key provided in
init()method and connected:serverPeerJoinedevent triggersserverPeerTypeasMCU. MCU has to be present in the Room in order for Peer connections to commence.- Checks for any available Stream
- If
shareScreen()Stream is available:incomingStreamevent triggers parameter payloadisSelfvalue astrueandstreamasshareScreen()Stream. User will be sendingshareScreen()Stream to Peers.
- Else if
getUserMedia()Stream is available:incomingStreamevent triggers parameter payloadisSelfvalue astrueandstreamasgetUserMedia()Stream. User will be sendinggetUserMedia()Stream to Peers.
- Else:
- No Stream will be sent.
- If
- Else:
systemActionevent triggers parameter payloadactionasREJECT.- ABORT and return error.
- If Room session has started successfully:
Parameters:
-
room{String} OptionalThe Room name.
- When not provided or is provided as an empty string, its value is the
options.defaultRoomprovided in theinit()method. Note that if you are using credentials based authentication, you cannot switch the Room that is not the same as theoptions.defaultRoomdefined in theinit()method.
- When not provided or is provided as an empty string, its value is the
-
options{JSON} OptionalThe Room session configuration options.
-
userData{JSON | String} OptionalThe User custom data. This can be set after Room session has started using the
setUserData()method. -
useExactConstraints{Boolean} OptionalThe
getUserMedia()methodoptions.useExactConstraintsparameter settings. See theoptions.useExactConstraintsparameter in thegetUserMedia()method for more information. -
audio{Boolean | JSON} OptionalThe
getUserMedia()methodoptions.audioparameter settings. When value is defined astrueor an object,getUserMedia()method to be invoked to retrieve new Stream. Ifoptions.videois not defined, it will be defined asfalse. Object signature matches theoptions.audioparameter in thegetUserMedia()method. -
video{Boolean | JSON} OptionalThe
getUserMedia()methodoptions.videoparameter settings. When value is defined astrueor an object,getUserMedia()method to be invoked to retrieve new Stream. Ifoptions.audiois not defined, it will be defined asfalse. Object signature matches theoptions.videoparameter in thegetUserMedia()method. -
voiceActivityDetection{Boolean} OptionalDEFAULT:trueThe 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
peerInfo.config.priorityWeightis higher than Peer's.This works hand-in-hand with the
options.disableComfortNoiseCodecflag in theinit()method and theoptions.audio.usedtxsetting ingetUserMedia()method. VAD (voice activity detection) detects if there is an active voice in the Stream, and if there is no active voice in the Stream, theoptions.audio.usedtx(if enabled) would prevent sending these empty bits. To prevent huge differences when there is a silence and an active voice later, the CN codec would produce an empty voice to make it sound better. -
bandwidth{JSON} OptionalNote 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.-
audio{Number} OptionalThe maximum audio streaming bandwidth sent to Peers in kbps. Recommended values are50to200.50is sufficient enough for an audio call. The higher you go if you want clearer audio and to be able to hear music streaming. -
video{Number} OptionalThe maximum video streaming bandwidth sent to Peers. Recommended values are256-500for 180p quality,500-1024for 360p quality,1024-2048for 720p quality and2048-4096for 1080p quality. -
data{Number} OptionalThe maximum data streaming bandwidth sent to Peers. This affects the P2P messaging insendP2PMessage()method, and data transfers insendBlobData()method andsendURLData()method.
-
-
googleXBandwidth{JSON} OptionalNote 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.-
min{Number} OptionalThe minimum experimental google video streaming bandwidth sent to Peers. This toggles the"x-google-min-bitrate"flag in the session description. -
max{Number} OptionalThe maximum experimental google video streaming bandwidth sent to Peers. This toggles the"x-google-max-bitrate"flag in the session description.
-
-
manualGetUserMedia{Boolean} OptionalThe flag if
joinRoom()should triggermediaAccessRequiredevent in which thegetUserMedia()Stream orshareScreen()Stream must be retrieved as a requirement before Room session may begin. This ignores theoptions.audioandoptions.videoconfiguration. After 30 seconds without any Stream retrieved, this results in thecallback(error, ..)result. -
sdpSettings{JSON} OptionalNote 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.-
connection{JSON} OptionalThe configuration to set the session description connection settings. Note that this configuration may disable the media streaming and these settings will be enabled for MCU server Peer connection regardless of the flags configured. -
connection.audio{Boolean} OptionalDEFAULT:trueThe configuration to enable audio session description connection. -
connection.video{Boolean} OptionalDEFAULT:trueThe configuration to enable video session description connection. -
connection.data{Boolean} OptionalDEFAULT:trueThe configuration to enable Datachannel session description connection. -
direction{JSON} OptionalThe configuration to set the session description connection direction to enable or disable uploading and downloading audio or video media streaming. Note that this configuration does not prevent RTCP packets from being sent and received. -
direction.audio{JSON} OptionalThe configuration to set the session description connection direction for audio streaming. -
direction.audio.send{Boolean} OptionalDEFAULT:trueThe flag if uploading audio streaming should be enabled when available. -
direction.audio.receive{Boolean} OptionalDEFAULT:trueThe flag if downloading audio streaming should be enabled when available. -
direction.video{JSON} OptionalThe configuration to set the session description connection direction for video streaming. -
direction.video.send{Boolean} OptionalDEFAULT:trueThe flag if uploading video streaming should be enabled when available. -
direction.video.receive{Boolean} OptionalDEFAULT:trueThe flag if downloading video streaming should be enabled when available.
-
-
publishOnly{JSON | Boolean} OptionalFor MCU enabled Peer connections, defining this flag would make Peer not know other Peers presence in the Room.
The config if Peer would publish only.
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 configoptions.sdpSettings.direction.audio.receivevalue tofalse,options.sdpSettings.direction.video.receivevalue tofalse,options.sdpSettings.direction.video.sendvalue totrueandoptions.sdpSettings.direction.audio.sendvalue totrue.
Note that this feature is currently is beta, and for any enquiries on enabling and its support for MCU enabled Peer connections, please contact our support portal.-
parentId{String} OptionalDeprecation Warning! This property has been deprecated. Use
The parent Peer ID to match to when Peer is connected. This is useful for identification for users connecting the Room twice simultaneously for multi-streaming. If User Peer ID matches the parent Peer ID provided from Peer, User will not be connected to Peer.options.parentIdinstead.
-
-
parentId{String} OptionalThe parent Peer ID to match to when Peer is connected. Note that configuring this value overrides the
options.publishOnly.parentIdvalue. This is useful for identification for users connecting the Room twice simultaneously for multi-streaming. If User Peer ID matches the parent Peer ID provided from Peer, User will not be connected to Peer. -
peerConnection{JSON} OptionalNote 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.-
iceCandidatePoolSize{Number} OptionalDEFAULT:0The number of ICE candidates to gather before gathering it when setting local offer / answer session description.
-
-
autoBandwidthAdjustment{Boolean | JSON} OptionalDEFAULT:falseNote 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 causepeerRestartevent to be triggered for each specified interval.-
interval{Number} OptionalDEFAULT:10The interval each time to adjust bandwidth connections in seconds. Note that the minimum value is10. -
limitAtPercentage{Number} OptionalDEFAULT:100The percentage of the average bandwidth to adjust to. E.g.avgBandwidth * (limitPercentage / 100). -
useUploadBwOnly{Boolean} OptionalDEFAULT:falseThe flag if average bandwidth computation should only consist of the upload bandwidth.
-
-
-
[options.peerConnection.bundlePolicy] The Peer connection media bundle policy. - When not provided, its value is <code>BALANCED</code>. [Rel: Skylink.BUNDLE_POLICY]{String} -
[options.peerConnection.rtcpMuxPolicy] The Peer connection RTP and RTCP ICE candidates mux policy. - When not provided, its value is <code>REQUIRE</code>. [Rel: Skylink.RTCP_MUX_POLICY]{String} -
[options.peerConnection.certificate] The type of certificate that Peer connection should generate and use when available. - When not provided, its value is <code>AUTO</code>. [Rel: Skylink.PEER_CERTIFICATE]{String} -
callback{Function} OptionalThe callback function fired when request has completed. Function parameters signature is
function (error, success)Function request completion is determined by thepeerJoinedevent triggeringisSelfparameter payload value astruefor request success.-
error{JSON}The error result in request. Defined as
nullwhen there are no errors in request-
error{Error | String}The error received when starting Room session has failed. -
room{String}The Room name.
-
-
success{JSON}The success result in request. Defined as
nullwhen there are errors in request-
room{String}The Room name. -
peerId{String}The User's Room session Peer ID. -
peerInfo{JSON}The User's current Room session information. Object signature matches thepeerInfoparameter payload received in thepeerJoinedevent.
-
-
-
[callback.error.errorCode] The current <a href="#method_init"><code>init()</code> method</a> ready state. <small>Defined as <code>null</code> when no <a href="#method_init"><code>init()</code> method</a> has not been called due to invalid configuration.</small> [Rel: Skylink.READY_STATE_CHANGE]{Number}
leaveRoom
[stopMediaOptions=true]
,
[callback]
,
)
Note that this method will close any existing socket channel connection despite not being in the Room.Function that stops Room session.
Events Sequence:
- If Socket connection is opened:
channelCloseevent triggers.
- Checks if User is in Room.
- If User is not in a Room:
- ABORT and return error.
- Else:
- If parameter
stopMediaOptions.userMediavalue istrue:- Invoke
stopStream()method. Regardless of request errors,leaveRoom()will still proceed.
- Invoke
- If parameter
stopMediaOptions.screensharevalue istrue:- Invoke
stopScreen()method. Regardless of request errors,leaveRoom()will still proceed.
- Invoke
peerLeftevent triggers for User and all connected Peers in Room.- If MCU is enabled for the App Key provided in
init()method and connected:serverPeerLeftevent triggers parameter payloadserverPeerTypeasMCU.
- If parameter
- If User is not in a Room:
Parameters:
-
stopMediaOptions{Boolean | JSON} OptionalDEFAULT:trueThe flag if
leaveRoom()should stop bothshareScreen()Stream andgetUserMedia()Stream.- When provided as a boolean, this sets both
stopMediaOptions.userMediaandstopMediaOptions.screenshareto its boolean value.
-
userMedia{Boolean} OptionalDEFAULT:trueThe flag if
leaveRoom()should stopgetUserMedia()Stream. This invokesstopStream()method. -
screenshare{Boolean} OptionalDEFAULT:trueThe flag if
leaveRoom()should stopshareScreen()Stream. This invokesstopScreen()method.
- When provided as a boolean, this sets both
-
callback{Function} OptionalThe callback function fired when request has completed. Function parameters signature is
function (error, success)Function request completion is determined by thepeerLeftevent triggeringisSelfparameter payload value astruefor request success.-
error{Error | String}The error result in request. Defined as
nullwhen there are no errors in request Object signature is theleaveRoom()error when stopping Room session. -
success{JSON}The success result in request. Defined as
nullwhen there are errors in request-
peerId{String}The User's Room session Peer ID. -
previousRoom{String}The Room name.
-
-
lockRoom
()
Note that broadcasted events fromFunction that locks the current Room when in session to prevent other Peers from joining the Room.muteStream()method,stopStream()method,stopScreen()method,sendMessage()method,unlockRoom()method andlockRoom()method may be queued when sent within less than an interval.
Events Sequence:
- Requests to Signaling server to lock Room
roomLockevent triggers parameter payloadisLockedvalue astrue.
muteStream
options
,
)
Note that broadcasted events fromFunction that mutes bothmuteStream()method,stopStream()method,stopScreen()method,sendMessage()method,unlockRoom()method andlockRoom()method may be queued when sent within less than an interval.
getUserMedia() Stream and
shareScreen() Stream audio or video tracks.
Example:
// Example 1: Mute both audio and video tracks in all Streams
skylinkDemo.muteStream({
audioMuted: true,
videoMuted: true
});
// Example 2: Mute only audio tracks in all Streams
skylinkDemo.muteStream({
audioMuted: true,
videoMuted: false
});
// Example 3: Mute only video tracks in all Streams
skylinkDemo.muteStream({
audioMuted: false,
videoMuted: true
});
Events Sequence:
- If provided parameter
optionsis invalid:- ABORT and return error.
- Checks if there is any available Streams:
- If there is no available Streams:
- ABORT and return error.
- If User is in Room:
- Checks if there is audio tracks to mute / unmute:
- If there is audio tracks to mute / unmute:
- If
options.audioMutedvalue is not the same as the currentpeerInfo.mediaStatus.audioMuted: This can be retrieved withgetPeerInfo()method.- For Peer only
peerUpdatedevent triggers with parameter payloadisSelfvalue asfalse. - For Peer only
streamMutedevent triggers with parameter payloadisSelfvalue asfalse.
- For Peer only
- If
- If there is audio tracks to mute / unmute:
- Checks if there is video tracks to mute / unmute:
- If there is video tracks to mute / unmute:
- If
options.videoMutedvalue is not the same as the currentpeerInfo.mediaStatus.videoMuted: This can be retrieved withgetPeerInfo()method.- For Peer only
peerUpdatedevent triggers with parameter payloadisSelfvalue asfalse. - For Peer only
streamMutedevent triggers with parameter payloadisSelfvalue asfalse.
- For Peer only
- If
- If there is video tracks to mute / unmute:
- Checks if there is audio tracks to mute / unmute:
- If
options.audioMutedvalue is not the same as the currentpeerInfo.mediaStatus.audioMutedoroptions.videoMutedvalue is not the same as the currentpeerInfo.mediaStatus.videoMuted:localMediaMutedevent triggers.- If User is in Room:
streamMutedevent triggers with parameter payloadisSelfvalue astrue.peerUpdatedevent triggers with parameter payloadisSelfvalue astrue.
- If there is no available Streams:
Parameters:
-
options{JSON}The Streams muting options.
-
audioMuted{Boolean} OptionalDEFAULT:trueThe flag if all Streams audio tracks should be muted or not.
-
videoMuted{Boolean} OptionalDEFAULT:trueThe flag if all Streams video tracks should be muted or not.
-
off
[eventName]
,
[callback]
,
)
Function that unsubscribes listeners from an event.
Example:
// Example 1: Unsubscribe all "peerJoined" event
skylinkDemo.off("peerJoined");
// Example 2: Unsubscribe only one listener from "peerJoined event"
var pJListener = function (peerId, peerInfo, isSelf) {
console.info("peerJoined event has been triggered with:", peerId, peerInfo, isSelf);
};
skylinkDemo.off("peerJoined", pJListener);
Events Sequence:
There is no event sequence for this method.Parameters:
-
eventName{String} OptionalThe event.
- When not provided, all listeners to all events will be unsubscribed.
-
callback{Function} OptionalThe listener to unsubscribe.
- When not provided, all listeners associated to the event will be unsubscribed.
on
eventName
,
callback
,
)
Function that subscribes a listener to an event.
Example:
// Example 1: Subscribing to "peerJoined" event
skylinkDemo.on("peerJoined", function (peerId, peerInfo, isSelf) {
console.info("peerJoined event has been triggered with:", peerId, peerInfo, isSelf);
});
Events Sequence:
There is no event sequence for this method.Parameters:
-
eventName{String}The event.
-
callback{Function}The listener. This will be invoked when event is triggered.
once
eventName
,
callback
,
[condition]
,
[fireAlways=false]
,
)
Function that subscribes a listener to an event once.
Example:
// Example 1: Subscribing to "peerJoined" event that triggers without condition
skylinkDemo.once("peerJoined", function (peerId, peerInfo, isSelf) {
console.info("peerJoined event has been triggered once with:", peerId, peerInfo, isSelf);
});
// Example 2: Subscribing to "incomingStream" event that triggers with condition
skylinkDemo.once("incomingStream", function (peerId, stream, isSelf, peerInfo) {
console.info("incomingStream event has been triggered with User stream:", stream);
}, function (peerId, peerInfo, isSelf) {
return isSelf;
});
// Example 3: Subscribing to "dataTransferState" event that triggers always only when condition is satisfied
skylinkDemo.once("dataTransferState", function (state, transferId, peerId, transferInfo) {
console.info("Received data transfer from Peer:", transferInfo.data);
}, function (state, transferId, peerId) {
if (state === skylinkDemo.DATA_TRANSFER_STATE.UPLOAD_REQUEST) {
skylinkDemo.acceptDataTransfer(peerId, transferId);
}
return state === skylinkDemo.DATA_TRANSFER_STATE.DOWNLOAD_COMPLETED;
}, true);
Events Sequence:
There is no event sequence for this method.Parameters:
-
eventName{String}The event.
-
callback{Function}The listener. This will be invoked once when event is triggered and conditional function is satisfied.
-
condition{Function} OptionalThe conditional function that will be invoked when event is triggered. Return
truewhen invoked to satisfy condition. When not provided, the conditional function will always returntrue. -
fireAlways{Boolean} OptionalDEFAULT:falseThe flag that indicates if
once()should act likeon()but only invoke listener only when conditional function is satisfied.
refreshConnection
[targetPeerId]
,
[iceRestart=false]
,
[options]
,
[callback]
,
)
Note that Edge browser does not support renegotiation. For MCU enabled Peer connections withFunction that refreshes Peer connections to update with the current streaming.options.mcuUseRenegoRestartset tofalsein theinit()method, the restart functionality may differ, you may learn more about how to workaround it in this article here. For restarts with Peers connecting from Android, iOS or C++ SDKs, restarts might not work as written in in this article here. Note that this functionality should be used when Peer connection stream freezes during a connection. For a better user experience for only MCU enabled Peer connections, the functionality is throttled when invoked many times in less than the milliseconds interval configured in theinit()method.
Example:
// Example 1: Refreshing a Peer connection
function refreshFrozenVideoStream (peerId) {
skylinkDemo.refreshConnection(peerId, function (error, success) {
if (error) return;
console.log("Refreshing connection for '" + peerId + "'");
});
}
// Example 2: Refreshing a list of Peer connections
function refreshFrozenVideoStreamGroup (peerIdA, peerIdB) {
skylinkDemo.refreshConnection([peerIdA, peerIdB], function (error, success) {
if (error) {
if (error.transferErrors[peerIdA]) {
console.error("Failed refreshing connection for '" + peerIdA + "'");
} else {
console.log("Refreshing connection for '" + peerIdA + "'");
}
if (error.transferErrors[peerIdB]) {
console.error("Failed refreshing connection for '" + peerIdB + "'");
} else {
console.log("Refreshing connection for '" + peerIdB + "'");
}
} else {
console.log("Refreshing connection for '" + peerIdA + "' and '" + peerIdB + "'");
}
});
}
// Example 3: Refreshing all Peer connections
function refreshFrozenVideoStreamAll () {
skylinkDemo.refreshConnection(function (error, success) {
if (error) {
for (var i = 0; i < error.listOfPeers.length; i++) {
if (error.refreshErrors[error.listOfPeers[i]]) {
console.error("Failed refreshing connection for '" + error.listOfPeers[i] + "'");
} else {
console.info("Refreshing connection for '" + error.listOfPeers[i] + "'");
}
}
} else {
console.log("Refreshing connection for all Peers", success.listOfPeers);
}
});
}
// Example 4: Refresh Peer connection when ICE connection has failed or disconnected
// and do a ICE connection refresh (only for non-MCU case)
skylinkDemo.on("iceConnectionState", function (state, peerId) {
if (!usesMCUKey && [skylinkDemo.ICE_CONNECTION_STATE.FAILED,
skylinkDemo.ICE_CONNECTION_STATE.DISCONNECTED].indexOf(state) > -1) {
skylinkDemo.refreshConnection(peerId, true);
}
});
Events Sequence:
- Checks if MCU is enabled for App Key provided in
init()method- If MCU is enabled:
- If there are connected Peers in the Room:
peerRestartevent triggers parameter payloadisSelfInitiateRestartvalue astruefor all connected Peer connections.serverPeerRestartevent triggers for connected MCU server Peer connection.
- If
options.mcuUseRenegoRestartvalue isfalseset in theinit()method:-
Invokes
joinRoom()methodrefreshConnection()will retain the User session information except the Peer ID will be a different assigned ID due to restarting the Room session.- If request has errors
- ABORT and return error.
- If request has errors
-
Invokes
- If there are connected Peers in the Room:
- Else:
- If there are connected Peers in the Room:
- Refresh connections for all targeted Peers.
- If Peer connection exists:
peerRestartevent triggers parameter payloadisSelfInitiateRestartvalue astruefor all targeted Peer connections.
- Else:
- ABORT and return error.
- If Peer connection exists:
- Refresh connections for all targeted Peers.
- If there are connected Peers in the Room:
- If MCU is enabled:
Parameters:
-
targetPeerId{String | Array} OptionalNote that this is ignored if MCU is enabled for the App Key provided in
The target Peer ID to refresh connection with. - When provided as an Array, it will refresh all connections with all the Peer IDs provided. - When not provided, it will refresh all the currently connected Peers in the Room.init()method.refreshConnection()will "refresh" all Peer connections. See the Event Sequence for more information. -
iceRestart{Boolean} OptionalDEFAULT:falseNote that this flag will not be honoured for MCU enabled Peer connections where
The flag if ICE connections should restart when refreshing Peer connections. This is used when ICE connection state isoptions.mcuUseRenegoRestartflag is set tofalseas it is not necessary since for MCU "restart" case is to invokejoinRoom()method again, or that it is not supported by the MCU.FAILEDorDISCONNECTED, which state can be retrieved with theiceConnectionStateevent. -
options{JSON} OptionalNote that for MCU connections, the
The custom Peer configuration settings.bandwidthorgoogleXBandwidthsettings will override for all Peers or the current Room connection session settings.-
bandwidth{JSON} OptionalThe configuration to set the maximum streaming bandwidth to send to Peers. Object signature follows
joinRoom()methodoptions.bandwidthsettings. -
googleXBandwidth{JSON} OptionalThe configuration to set the experimental google video streaming bandwidth sent to Peers. Object signature follows
joinRoom()methodoptions.googleXBandwidthsettings.
-
-
callback{Function} OptionalThe callback function fired when request has completed. Function parameters signature is
function (error, success)Function request completion is determined by thepeerRestartevent triggeringisSelfInitiateRestartparameter payload value astruefor all Peers targeted for request success.-
error{JSON}The error result in request. Defined as
nullwhen there are no errors in request-
listOfPeers{Array}The list of Peer IDs targeted. -
refreshErrors{JSON}The list of Peer connection refresh errors. -
refreshErrors.#peerId{Error | String}The Peer connection refresh error associated with the Peer ID defined in#peerIdproperty. If#peerIdvalue is"self", it means that it is the error when there is no Peer connections to refresh with. -
refreshSettings{JSON}The list of Peer connection refresh settings. -
refreshSettings.#peerId{JSON}The Peer connection refresh settings associated with the Peer ID defined in#peerIdproperty. -
refreshSettings.#peerId.iceRestart{Boolean}The flag if ICE restart is enabled for this Peer connection refresh session. -
refreshSettings.#peerId.customSettings{JSON}The Peer connection custom settings. Object signature followsgetPeersCustomSettingsmethod returned per#peerIdobject.
-
-
success{JSON}The success result in request. Defined as
nullwhen there are errors in request-
listOfPeers{Array}The list of Peer IDs targeted. -
refreshSettings{JSON}The list of Peer connection refresh settings. -
refreshSettings.#peerId{JSON}The Peer connection refresh settings associated with the Peer ID defined in#peerIdproperty. -
refreshSettings.#peerId.iceRestart{Boolean}The flag if ICE restart is enabled for this Peer connection refresh session. -
refreshSettings.#peerId.customSettings{JSON}The Peer connection custom settings. Object signature followsgetPeersCustomSettingsmethod returned per#peerIdobject.
-
-
sendBlobData
data
,
[timeout=60]
,
[targetPeerId]
,
[sendChunksAsBinary=false]
,
[callback]
,
)
Function that starts an uploading data transfer from User to Peers.
Example:
<body>
<input type="radio" name="timeout" onchange="setTransferTimeout(0)"> 1s timeout (Default)
<input type="radio" name="timeout" onchange="setTransferTimeout(120)"> 2s timeout
<input type="radio" name="timeout" onchange="setTransferTimeout(300)"> 5s timeout
<hr>
<input type="file" onchange="uploadFile(this.files[0], this.getAttribute('data'))" data="peerId">
<input type="file" onchange="uploadFileGroup(this.files[0], this.getAttribute('data').split(',')))" data="peerIdA,peerIdB">
<input type="file" onchange="uploadFileAll(this.files[0])" data="">
<script>
var transferTimeout = 0;
function setTransferTimeout (timeout) {
transferTimeout = timeout;
}
// Example 1: Upload data to a Peer
function uploadFile (file, peerId) {
var cb = function (error, success) {
if (error) return;
console.info("File has been transferred to '" + peerId + "' successfully");
};
if (transferTimeout > 0) {
skylinkDemo.sendBlobData(file, peerId, transferTimeout, cb);
} else {
skylinkDemo.sendBlobData(file, peerId, cb);
}
}
// Example 2: Upload data to a list of Peers
function uploadFileGroup (file, peerIds) {
var cb = function (error, success) {
var listOfPeers = error ? error.listOfPeers : success.listOfPeers;
var listOfPeersErrors = error ? error.transferErrors : {};
for (var i = 0; i < listOfPeers.length; i++) {
if (listOfPeersErrors[listOfPeers[i]]) {
console.error("Failed file transfer to '" + listOfPeers[i] + "'");
} else {
console.info("File has been transferred to '" + listOfPeers[i] + "' successfully");
}
}
};
if (transferTimeout > 0) {
skylinkDemo.sendBlobData(file, peerIds, transferTimeout, cb);
} else {
skylinkDemo.sendBlobData(file, peerIds, cb);
}
}
// Example 2: Upload data to a list of Peers
function uploadFileAll (file) {
var cb = function (error, success) {
var listOfPeers = error ? error.listOfPeers : success.listOfPeers;
var listOfPeersErrors = error ? error.transferErrors : {};
for (var i = 0; i < listOfPeers.length; i++) {
if (listOfPeersErrors[listOfPeers[i]]) {
console.error("Failed file transfer to '" + listOfPeers[i] + "'");
} else {
console.info("File has been transferred to '" + listOfPeers[i] + "' successfully");
}
}
};
if (transferTimeout > 0) {
skylinkDemo.sendBlobData(file, transferTimeout, cb);
} else {
skylinkDemo.sendBlobData(file, cb);
}
}
</script>
</body>
Events Sequence:
- Checks if User is in Room.
- If User is not in Room:
-
dataTransferStateevent triggers parameter payloadstateasSTART_ERROR. - ABORT step and return error.
-
- If User is not in Room:
- Checks if there is any available Datachannel connections.
- If User is not in Room:
-
dataTransferStateevent triggers parameter payloadstateasSTART_ERROR. - ABORT step and return error.
-
- If User is not in Room:
- Checks if provided
dataparameter is valid.- If it is invalid:
-
dataTransferStateevent triggers parameter payloadstateasSTART_ERROR. - ABORT step and return error.
-
- If it is invalid:
- Checks if Peer connection and Datachannel connection are in correct states.
- If Peer connection or session does not exists:
-
dataTransferStateevent triggers parameter payloadstateasERROR. - ABORT step and return error.
-
- If Peer connection is not stable: The stable state can be checked with
peerConnectionStateevent triggering parameter payloadstateasSTABLEfor Peer.dataTransferStateevent triggers parameter payloadstateasERROR.- ABORT step and return error.
- If Peer connection messaging Datachannel has not been opened: This can be checked with
dataChannelStateevent triggering parameter payloadstateasOPENandchannelTypeasMESSAGINGfor Peer.-
dataTransferStateevent triggers parameter payloadstateasERROR. - ABORT step and return error.
-
- If MCU is enabled for the App Key provided in
init()method and connected:- If MCU Peer connection is not stable: The stable state can be checked with
peerConnectionStateevent triggering parameter payloadstateasSTABLEandpeerIdvalue as"MCU"for MCU Peer.dataTransferStateevent triggers parameter payloadstateasERROR.- ABORT step and return error.
- If MCU Peer connection messaging Datachannel has not been opened: This can be checked with
dataChannelStateevent triggering parameter payloadstateasOPEN,peerIdvalue as"MCU"andchannelTypeasMESSAGINGfor MCU Peer.dataTransferStateevent triggers parameter payloadstateasERROR.- ABORT step and return error.
- If MCU Peer connection is not stable: The stable state can be checked with
- Checks if should open a new data Datachannel.
- If Peer supports simultaneous data transfer, open new data Datachannel: If MCU is connected,
this opens a new data Datachannel with MCU Peer with all the Peers IDs information that supports
simultaneous data transfers targeted for the data transfer session instead of opening new data Datachannel
with all Peers targeted for the data transfer session.
dataChannelStateevent triggers parameter payloadstateasCONNECTINGandchannelTypeasDATA. Note that there is no timeout to wait for parameter payloadstateto beOPEN.- If Datachannel has been created and opened successfully:
dataChannelStateevent triggers parameter payloadstateasOPENandchannelTypeasDATA.
- Else:
dataChannelStateevent triggers parameter payloadstateasCREATE_ERRORandchannelTypeasDATA.dataTransferStateevent triggers parameter payloadstateasERROR.- ABORT step and return error.
- Else: If MCU is connected,
this uses the messaging Datachannel with MCU Peer with all the Peers IDs information that supports
simultaneous data transfers targeted for the data transfer session instead of using the messaging Datachannels
with all Peers targeted for the data transfer session.
- If messaging Datachannel connection has a
data transfer in-progress:
dataTransferStateevent triggers parameter payloadstateasERROR.- ABORT step and return error.
- If there is any conflicting
streamData()method data streaming session: IfsendChunksAsBinaryis provided astrue, it cannot start if existing data streaming session is expected binary data chunks, and if provided asfalse, or method invoked issendURLData()method, or Peer is using string data chunks fallback due to its support despite provided astrue, it cannot start if existing data streaming session is expected string data chunks.dataTransferStateevent triggers parameter payloadstateasERROR.- ABORT step and return error.
- If messaging Datachannel connection has a
data transfer in-progress:
- If Peer supports simultaneous data transfer, open new data Datachannel: If MCU is connected,
this opens a new data Datachannel with MCU Peer with all the Peers IDs information that supports
simultaneous data transfers targeted for the data transfer session instead of opening new data Datachannel
with all Peers targeted for the data transfer session.
- If Peer connection or session does not exists:
incomingDataRequestevent triggers.- For User only
dataTransferStateevent triggers parameter payloadstateasUSER_UPLOAD_REQUEST. - For Peer only
dataTransferStateevent triggers parameter payloadstateasUPLOAD_REQUEST. - Peer invokes
acceptDataTransfer()method.- If parameter
acceptvalue istrue:- User starts upload data transfer to Peer.
- For User only
dataTransferStateevent triggers parameter payloadstateasUPLOAD_STARTED. - For Peer only
dataTransferStateevent triggers parameter payloadstateasDOWNLOAD_STARTED.
- For User only
- If Peer / User invokes
cancelDataTransfer()method:dataTransferStateevent triggers parameterstateasCANCEL.- ABORT step and return error.
- If data transfer has timeout errors:
dataTransferStateevent triggers parameterstateasERROR.- ABORT step and return error.
- Checks for Peer connection and Datachannel connection during data transfer:
- If MCU is enabled for the App Key provided in
init()method and connected:- If MCU Datachannel has closed abruptly during data transfer:
-
This can be checked with
dataTransferStateevent triggers parameterstateasERROR.- ABORT step and return error.
dataChannelStateevent triggering parameter payloadstateasCLOSED,peerIdvalue as"MCU"andchannelTypeasDATAfor targeted Peers that supports simultaneous data transfer orMESSAGINGfor targeted Peers that do not support it.
- If MCU Datachannel has closed abruptly during data transfer:
- If MCU Peer connection has changed from not being stable:
-
This can be checked with
dataTransferStateevent triggers parameterstateasERROR.- ABORT step and return error.
peerConnectionevent triggering parameter payloadstateas notSTABLE,peerIdvalue as"MCU".
- If MCU is enabled for the App Key provided in
- If Peer connection has changed from not being stable:
-
This can be checked with
dataTransferStateevent triggers parameterstateasERROR.- ABORT step and return error.
peerConnectionevent triggering parameter payloadstateas notSTABLE.
- User starts upload data transfer to Peer.
- If parameter
- Else:
- If Datachannel has closed abruptly during data transfer:
This can be checked with
dataChannelStateevent triggering parameter payloadstateasCLOSEDandchannelTypeasDATAfor Peer that supports simultaneous data transfer orMESSAGINGfor Peer that do not support it.dataTransferStateevent triggers parameterstateasERROR.- ABORT step and return error.
- If Datachannel has closed abruptly during data transfer:
This can be checked with
- For User only
dataTransferStateevent triggers parameter payloadstateasUPLOADING. - For Peer only
dataTransferStateevent triggers parameter payloadstateasDOWNLOADING.
incomingDataevent triggers.- For User only
dataTransferStateevent triggers parameter payloadstateasUPLOAD_COMPLETED. - For Peer only
dataTransferStateevent triggers parameter payloadstateasDOWNLOAD_COMPLETED.
accept value is false: - For User only
dataTransferStateevent triggers parameter payloadstateasREJECTED. - For Peer only
dataTransferStateevent triggers parameter payloadstateasUSER_REJECTED. - ABORT step and return error.
Parameters:
-
data{Blob}The Blob object.
-
timeout{Number} OptionalDEFAULT:60The timeout to wait for response from Peer.
-
targetPeerId{String | Array} OptionalThe target Peer ID to start data transfer with.
- When provided as an Array, it will start uploading data transfers with all connections with all the Peer IDs provided.
- When not provided, it will start uploading data transfers with all the currently connected Peers in the Room.
-
sendChunksAsBinary{Boolean} OptionalDEFAULT:falseNote that this is currently not supported for MCU enabled Peer connections or Peer connections connecting from Android, iOS and Linux SDKs. This would fallback to
The flag if data transfer binary data chunks should not be encoded as Base64 string during data transfers.transferInfo.chunkTypetoBINARY_STRINGwhen MCU is connected. -
callback{Function} OptionalThe callback function fired when request has completed. Function parameters signature is
function (error, success)Function request completion is determined by thedataTransferStateevent triggeringstateparameter payload asUPLOAD_COMPLETEDfor all Peers targeted for request success.-
error{JSON}The error result in request. Defined as
nullwhen there are no errors in request-
transferId{String}The data transfer ID. Defined asnullwhensendBlobData()fails to start data transfer. -
listOfPeers{Array}The list Peer IDs targeted for the data transfer. -
transferErrors{JSON}The list of data transfer errors. -
transferErrors.#peerId{Error | String}The data transfer error associated with the Peer ID defined in#peerIdproperty. If#peerIdvalue is"self", it means that it is the error when there are no Peer connections to start data transfer with. -
transferInfo{JSON}The data transfer information. Object signature matches thetransferInfoparameter payload received in thedataTransferStateevent except without thepercentageanddataproperty.
-
-
success{JSON}The success result in request. Defined as
nullwhen there are errors in request-
transferId{String}The data transfer ID. -
listOfPeers{Array}The list Peer IDs targeted for the data transfer. -
transferInfo{JSON}The data transfer information. Object signature matches thetransferInfoparameter payload received in thedataTransferStateevent except without thepercentageproperty anddata.
-
-
sendMessage
message
,
[targetPeerId]
,
)
Note that broadcasted events fromFunction that sends a message to Peers via the Signaling socket connection.muteStream()method,stopStream()method,stopScreen()method,sendMessage()method,unlockRoom()method andlockRoom()method may be queued when sent within less than an interval.
Example:
// Example 1: Broadcasting to all Peers
skylinkDemo.sendMessage("Hi all!");
// Example 2: Sending to specific Peers
var peersInExclusiveParty = [];
skylinkDemo.on("peerJoined", function (peerId, peerInfo, isSelf) {
if (isSelf) return;
if (peerInfo.userData.exclusive) {
peersInExclusiveParty.push(peerId);
}
});
function updateExclusivePartyStatus (message) {
skylinkDemo.sendMessage(message, peersInExclusiveParty);
}
Events Sequence:
- Sends socket connection message to all targeted Peers via Signaling server.
incomingMessageevent triggers parameter payloadmessage.isDataChannelvalue asfalse.
Parameters:
-
message{String | JSON}The message.
-
targetPeerId{String | Array} OptionalThe target Peer ID to send message to.
- When provided as an Array, it will send the message to only Peers which IDs are in the list.
- When not provided, it will broadcast the message to all connected Peers in the Room.
sendP2PMessage
message
,
[targetPeerId]
,
)
Function that sends a message to Peers via the Datachannel connection.
Consider using sendURLData() method if you are
sending large strings to Peers.
Example:
// Example 1: Broadcasting to all Peers
skylinkDemo.on("dataChannelState", function (state, peerId, error, channelName, channelType) {
if (state === skylinkDemo.DATA_CHANNEL_STATE.OPEN &&
channelType === skylinkDemo.DATA_CHANNEL_TYPE.MESSAGING) {
skylinkDemo.sendP2PMessage("Hi all!");
}
});
// Example 2: Sending to specific Peers
var peersInExclusiveParty = [];
skylinkDemo.on("peerJoined", function (peerId, peerInfo, isSelf) {
if (isSelf) return;
if (peerInfo.userData.exclusive) {
peersInExclusiveParty[peerId] = false;
}
});
skylinkDemo.on("dataChannelState", function (state, peerId, error, channelName, channelType) {
if (state === skylinkDemo.DATA_CHANNEL_STATE.OPEN &&
channelType === skylinkDemo.DATA_CHANNEL_TYPE.MESSAGING) {
peersInExclusiveParty[peerId] = true;
}
});
function updateExclusivePartyStatus (message) {
var readyToSend = [];
for (var p in peersInExclusiveParty) {
if (peersInExclusiveParty.hasOwnProperty(p)) {
readyToSend.push(p);
}
}
skylinkDemo.sendP2PMessage(message, readyToSend);
}
Events Sequence:
- Sends P2P message to all targeted Peers.
- If Peer connection Datachannel has not been opened: This can be checked with
dataChannelStateevent triggering parameter payloadstateasOPENandchannelTypeasMESSAGINGfor Peer.dataChannelStateevent triggers parameter payloadstateasSEND_MESSAGE_ERROR.- ABORT step and return error.
incomingMessageevent triggers parameter payloadmessage.isDataChannelvalue astrueandisSelfvalue astrue.
- If Peer connection Datachannel has not been opened: This can be checked with
Parameters:
-
message{String | JSON}The message.
-
targetPeerId{String | Array} OptionalThe target Peer ID to send message to.
- When provided as an Array, it will send the message to only Peers which IDs are in the list.
- When not provided, it will broadcast the message to all connected Peers with Datachannel connection in the Room.
sendStream
options
,
[callback]
,
)
Note that ifFunction that sends a newshareScreen()Stream is available despite havinggetUserMedia()Stream available, theshareScreen()Stream is sent instead of thegetUserMedia()Stream to Peers.
getUserMedia() Stream
to all connected Peers in the Room.
Example:
// Example 1: Send MediaStream object
function retrieveStreamBySourceForFirefox (sourceId) {
navigator.mediaDevices.getUserMedia({
audio: true,
video: {
sourceId: { exact: sourceId }
}
}).then(function (stream) {
skylinkDemo.sendStream(stream, function (error, success) {
if (err) return;
if (stream === success) {
console.info("Same MediaStream has been sent");
}
console.log("Stream is now being sent to Peers");
attachMediaStream(document.getElementById("my-video"), success);
});
});
}
// Example 2: Send video later
var inRoom = false;
function sendVideo () {
if (!inRoom) return;
skylinkDemo.sendStream({
audio: true,
video: true
}, function (error, success) {
if (error) return;
console.log("getUserMedia() Stream with video is now being sent to Peers");
attachMediaStream(document.getElementById("my-video"), success);
});
}
skylinkDemo.joinRoom({
audio: true
}, function (jRError, jRSuccess) {
if (jRError) return;
inRoom = true;
});
Events Sequence:
- If User is not in Room:
- ABORT and return error.
- Checks
optionsprovided.- If provided parameter
optionsis not valid:- ABORT and return error.
- Else if provided parameter
optionsis a Stream object:- Checks if there is any audio or video tracks.
- If there is no tracks:
- ABORT and return error.
- Else:
- Set
options.audiovalue astrueif Stream has audio tracks. - Set
options.videovalue asfalseif Stream has video tracks. - Mutes / Unmutes audio and video tracks based on current muted settings in
peerInfo.mediaStatus. This can be retrieved withgetPeerInfo()method. - If there is any previous
getUserMedia()Stream:- Invokes
stopStream()method to stop previous Stream.
- Invokes
mediaAccessSuccessevent triggers parameter payloadisScreensharingvalue asfalseandisAudioFallbackvalue asfalse.
- Set
- If there is no tracks:
- Checks if there is any audio or video tracks.
- Else:
- Invoke
getUserMedia()method withoptionsprovided insendStream().- If request has errors:
- ABORT and return error.
- If request has errors:
- Invoke
- If provided parameter
- If there is currently no
shareScreen()Stream:incomingStreamevent triggers parameter payloadisSelfvalue astrueandstreamasgetUserMedia()Stream.peerUpdatedevent triggers parameter payloadisSelfvalue astrue.- Checks if MCU is enabled for App Key provided in
init()method.- If MCU is enabled:
- Invoke
refreshConnection()method.- If request has errors:
- ABORT and return error.
- If request has errors:
- Invoke
- Else:
- If there are connected Peers in the Room:
- Invoke
refreshConnection()method.- If request has errors:
- ABORT and return error.
- If request has errors:
- Invoke
- If there are connected Peers in the Room:
- If MCU is enabled:
Parameters:
-
options{JSON | MediaStream}The
getUserMedia()methodoptionsparameter settings.- When provided as a
MediaStreamobject, this configures theoptions.audioandoptions.videobased on the tracks available in theMediaStreamobject, and configures theoptions.audio.muteandoptions.video.mutebased on the tracks.enabledflags in the tracks provided in theMediaStreamobject without invokinggetUserMedia()method. Object signature matches theoptionsparameter in thegetUserMedia()method.
- When provided as a
-
callback{Function} OptionalThe callback function fired when request has completed. Function parameters signature is
function (error, success)Function request completion is determined by themediaAccessSuccessevent triggeringisScreensharingparameter payload value asfalsefor request success when User is in Room without Peers, or by thepeerRestartevent triggeringisSelfInitiateRestartparameter payload value astruefor all connected Peers for request success when User is in Room with Peers.-
error{Error | String}The error result in request. Defined as
nullwhen there are no errors in request Object signature is thegetUserMedia()method error or when invalidoptionsis provided. -
success{MediaStream}The success result in request. Defined as
nullwhen there are errors in request Object signature is thegetUserMedia()method Stream object.
-
sendURLData
data
,
[timeout=60]
,
[targetPeerId]
,
[callback]
,
)
Function that starts an uploading string data transfer from User to Peers.
Example:
<body>
<input type="radio" name="timeout" onchange="setTransferTimeout(0)"> 1s timeout (Default)
<input type="radio" name="timeout" onchange="setTransferTimeout(120)"> 2s timeout
<input type="radio" name="timeout" onchange="setTransferTimeout(300)"> 5s timeout
<hr>
<input type="file" onchange="showImage(this.files[0], this.getAttribute('data'))" data="peerId">
<input type="file" onchange="showImageGroup(this.files[0], this.getAttribute('data').split(',')))" data="peerIdA,peerIdB">
<input type="file" onchange="showImageAll(this.files[0])" data="">
<image id="target-1" src="">
<image id="target-2" src="">
<image id="target-3" src="">
<script>
var transferTimeout = 0;
function setTransferTimeout (timeout) {
transferTimeout = timeout;
}
function retrieveImageDataURL(file, cb) {
var fr = new FileReader();
fr.onload = function () {
cb(fr.result);
};
fr.readAsDataURL(files[0]);
}
// Example 1: Send image data URL to a Peer
function showImage (file, peerId) {
var cb = function (error, success) {
if (error) return;
console.info("Image has been transferred to '" + peerId + "' successfully");
};
retrieveImageDataURL(file, function (str) {
if (transferTimeout > 0) {
skylinkDemo.sendURLData(str, peerId, transferTimeout, cb);
} else {
skylinkDemo.sendURLData(str, peerId, cb);
}
document.getElementById("target-1").src = str;
});
}
// Example 2: Send image data URL to a list of Peers
function showImageGroup (file, peerIds) {
var cb = function (error, success) {
var listOfPeers = error ? error.listOfPeers : success.listOfPeers;
var listOfPeersErrors = error ? error.transferErrors : {};
for (var i = 0; i < listOfPeers.length; i++) {
if (listOfPeersErrors[listOfPeers[i]]) {
console.error("Failed image transfer to '" + listOfPeers[i] + "'");
} else {
console.info("Image has been transferred to '" + listOfPeers[i] + "' successfully");
}
}
};
retrieveImageDataURL(file, function (str) {
if (transferTimeout > 0) {
skylinkDemo.sendURLData(str, peerIds, transferTimeout, cb);
} else {
skylinkDemo.sendURLData(str, peerIds, cb);
}
document.getElementById("target-2").src = str;
});
}
// Example 2: Send image data URL to a list of Peers
function uploadFileAll (file) {
var cb = function (error, success) {
var listOfPeers = error ? error.listOfPeers : success.listOfPeers;
var listOfPeersErrors = error ? error.transferErrors : {};
for (var i = 0; i < listOfPeers.length; i++) {
if (listOfPeersErrors[listOfPeers[i]]) {
console.error("Failed image transfer to '" + listOfPeers[i] + "'");
} else {
console.info("Image has been transferred to '" + listOfPeers[i] + "' successfully");
}
}
};
retrieveImageDataURL(file, function (str) {
if (transferTimeout > 0) {
skylinkDemo.sendURLData(str, transferTimeout, cb);
} else {
skylinkDemo.sendURLData(str, cb);
}
document.getElementById("target-3").src = str;
});
}
</script>
</body>
Events Sequence:
Event sequence followssendBlobData() method.
Parameters:
-
data{String}The data string to transfer to Peer.
-
timeout{Number} OptionalDEFAULT:60The timeout to wait for response from Peer.
-
targetPeerId{String | Array} OptionalThe target Peer ID to start data transfer with.
- When provided as an Array, it will start uploading data transfers with all connections with all the Peer IDs provided.
- When not provided, it will start uploading data transfers with all the currently connected Peers in the Room.
-
callback{Function} OptionalThe callback function fired when request has completed. Function parameters signature is
function (error, success)Function request completion is determined by thedataTransferStateevent triggeringstateparameter payload asUPLOAD_COMPLETEDfor all Peers targeted for request success.-
error{JSON}The error result in request. Defined as
nullwhen there are no errors in request-
transferId{String}The data transfer ID. Defined asnullwhensendURLData()fails to start data transfer. -
listOfPeers{Array}The list Peer IDs targeted for the data transfer. -
transferErrors{JSON}The list of data transfer errors. -
transferErrors.#peerId{Error | String}The data transfer error associated with the Peer ID defined in#peerIdproperty. If#peerIdvalue is"self", it means that it is the error when there are no Peer connections to start data transfer with. -
transferInfo{JSON}The data transfer information. Object signature matches thetransferInfoparameter payload received in thedataTransferStateevent except without thepercentageproperty anddata.
-
-
success{JSON}The success result in request. Defined as
nullwhen there are errors in request-
transferId{String}The data transfer ID. -
listOfPeers{Array}The list Peer IDs targeted for the data transfer. -
transferInfo{JSON}The data transfer information. Object signature matches thetransferInfoparameter payload received in thedataTransferStateevent except without thepercentageproperty anddata.
-
-