Methods
(static) addIceCandidate(targetMid, candidateId, candidateType, nativeCandidate, roomState)
Function that adds the ICE candidate to Peer connection.
Parameters:
| Name | Type | Description |
|---|---|---|
targetMid |
String |
The mid of the target peer |
candidateId |
String |
The id of the ICE Candidate |
candidateType |
String |
Type of the ICE Candidate |
nativeCandidate |
RTCIceCandidate |
An RTCIceCandidate Object | https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidate |
roomState |
SkylinkState |
Skylink State |
- Source:
Fires:
- event:candidateProcessingState
(static) addIceCandidateFromQueue(targetMid, room)
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.
Parameters:
| Name | Type | Description |
|---|---|---|
targetMid |
String |
The mid of the target peer |
room |
SkylinkRoom |
Current Room |
- Source:
(static) onIceCandidate(targetMid, rtcIceConnectionEvent, room) → {null}
Parameters:
| Name | Type | Description |
|---|---|---|
targetMid |
The mid of the target peer |
|
rtcIceConnectionEvent |
RTCPeerConnectionIceEvent |
https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnectionIceEvent |
room |
SkylinkRoom |
Current room |
- Source:
Fires:
- event:candidateGenerationState
(static) setIceServers(iceServers) → {filteredIceServers}
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.
Parameters:
| Name | Type | Description |
|---|---|---|
iceServers |
Array.<RTCIceServer> |
The list of IceServers passed | https://developer.mozilla.org/en-US/docs/Web/API/RTCIceServer |
- Source: