IceConnectionHelpers

IceConnectionHelpers

All helper and utility functions for IceConnection class are listed here.

Source:

Methods

(private, static) addIceCandidate(targetMid, candidateId, candidateType, nativeCandidate, roomState)

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
roomState SkylinkState

Skylink State
Source:
Fires:
  • event:candidateProcessingState

(private, static) addIceCandidateFailure(room, targetMid, candidateId, candidateType, candidate, error)

Failure callback for adding an IceCandidate

Parameters:
Name Type Description
room SkylinkRoom

The current room
targetMid String

The mid of the target peer
candidateId String

The id of the ICE Candidate
candidateType String

Type of the ICE Candidate
candidate RTCIceCandidate

An RTCIceCandidate Object
error Error

Error
Source:
Fires:
  • event:candidateProcessingState

(private, static) addIceCandidateFromQueue(targetMid, room)

Parameters:
Name Type Description
targetMid String
room SkylinkRoom
Source:

(private, static) addIceCandidateSuccess(room, targetMid, candidateId, candidateType, candidate)

Success callback for adding an IceCandidate

Parameters:
Name Type Description
room SkylinkRoom

The current room
targetMid String

The mid of the target peer
candidateId String

The id of the ICE Candidate
candidateType String

Type of the ICE Candidate
candidate RTCIceCandidate

An RTCIceCandidate Object
Source:
Fires:
  • event:candidateProcessingState

(private, static) addIceCandidateToQueue(targetMid, candidateId, candidateType, nativeCandidate, state)

Method that buffers candidates

Parameters:
Name Type Description
targetMid String
candidateId String
candidateType String
nativeCandidate RTCIceCandidate
state SkylinkState
Source:

(private, static) onIceCandidate(targetMid, candidate, currentRoom) → {null}

Parameters:
Name Type Description
targetMid

The mid of the target peer
candidate RTCIceCandidate

https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidate
currentRoom SkylinkRoom

Current room
Source:
Fires:
  • event:candidateGenerationState

(private, static) setIceServers(servers) → {filteredIceServers}

Parameters:
Name Type Description
servers Array.<RTCIceServer>

The list of IceServers passed | https://developer.mozilla.org/en-US/docs/Web/API/RTCIceServer
Source: