PeerDataHelpers

PeerDataHelpers

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

Source:

Methods

(private, static) getCurrentSessionInfo(room) → {peerInfo}

Function that returns the current session peerInfo is peer isSelf.

Parameters:
Name Type Description
room SkylinkRoom
Source:

(private, static) getPeerCustomSettings(state, peerId) → {Object}

Function that gets a current custom Peer settings.

Parameters:
Name Type Description
state SkylinkState
peerId String
Source:

(private, static) getPeerInfo(peerId, room) → {peerInfo}

Function that returns the User / Peer current session information.

Parameters:
Name Type Description
peerId String
room SkylinkRoom
Source:

(static) getPeersCustomSettings(roomState) → {Object}

Function that gets the list of current custom Peer settings sent and set.

Parameters:
Name Type Description
roomState SkylinkState
Source:

(private, static) getPeersDataChannels(roomState) → {Object}

Function that gets the current list of connected Peers Datachannel connections in the Room.

Parameters:
Name Type Description
roomState SkylinkState
Source:

(static) getPeersStreams(roomState, includeSelfopt) → {Object}

Function that gets the list of connected Peers Streams in the Room.

Parameters:
Name Type Attributes Default Description
roomState SkylinkState
includeSelf boolean <optional>
 true

The flag if self streams are included.
Source:

(private, static) getUserData(roomState, peerId) → {roomState.userData}

Function that returns the User / Peer current custom data.

Parameters:
Name Type Description
roomState Skylink
peerId String
Source:

(private, static) getUserInfo(room) → {Object}

Function that returns the userInfo to be sent to Signaling.

Parameters:
Name Type Description
room SkylinkRoom
Source:

(private, static) setUserData(room, userData)

Function that overwrites the User current custom data.

Parameters:
Name Type Description
room SkylinkRoom
userData String | Object
Source:
Fires:
  • event:peerUpdated