PeerConnection

PeerConnection

Class that represents a PeerConnection

Constructor

(private) new PeerConnection()

Source:

Namespaces

PeerConnectionHelpers

Methods

(static) addPeer(params, receiveOnly, hasScreenshare)

Parameters:
Name Type Description
params object

options required to create a PeerConnection

Properties
Name Type Description
currentRoom SkylinkRoom

The currrent state
targetMid String

Peer's id
peerBrowser Object

Peer's user agent object
cert RTCCertificate

Represents a certificate that an RTCPeerConnection uses to authenticate.
receiveOnly boolean
hasScreenshare boolean

Is screenshare enabled
Source:

(static) createAnswer(…args)

Parameters:
Name Type Attributes Description
args <repeatable>
Source:

(static) createDataChannel(…args)

Parameters:
Name Type Attributes Description
args <repeatable>
Source:

(static) createOffer(…args)

Parameters:
Name Type Attributes Description
args <repeatable>
Source:

(static) getConnectionStatus(roomState, peerId) → {Promise.<statistics>}

Get RTCPeerConnection status

Parameters:
Name Type Description
roomState SkylinkState
peerId String | Array
Source:

(static) getDataChannelBuffer(channel) → {Object}

Get RTCDataChannel buffer thresholds

Parameters:
Name Type Description
channel RTCDataChannel.channel
Source:

(static) getPeersInRoom(…args)

Parameters:
Name Type Attributes Description
args <repeatable>
Source:

(static) refreshConnection(roomState, targetPeerId, iceRestart, options) → {Promise}

Function that refreshes Peer connections to update with the current streaming.

Parameters:
Name Type Description
roomState SkylinkState
targetPeerId String
iceRestart boolean
options Object
Properties
Name Type Description
andwidth Object
googleXBandwidth Object
Source:

(static) refreshDataChannel(state, peerId)

Function that refreshes the main messaging Datachannel.

Parameters:
Name Type Description
state SkylinkState
peerId String
Source:

(static) retrieveStatistics(roomKey, peerId, beSilentOnLogs, isAutoBwStats) → {Promise}

Get webRTC statistics via the getStats() method of RTCPeerConnection inside a Room

Parameters:
Name Type Description
roomKey SkylinkRoom.id
peerId String
beSilentOnLogs boolean
isAutoBwStats boolean

The flag if retrieveStatistics is called from BandwidthAdjuster
Source:

(private, static) sendMessageToDataChannel()

Function that sends data over the DataChannel connection.

Since:
  • 2.0.0
Source:
Fires:
  • event:onDataChannelStateChanged

(static) sendP2PMessage(…args)

Parameters:
Name Type Attributes Description
args <repeatable>
Source:

(static) signalingEndOfCandidates(…args)

Parameters:
Name Type Attributes Description
args <repeatable>
Source: