API Docs for:
Show:

rtc.signaling.SignalingPeer Class

Extends events.EventEmitter
Defined in: src/signaling/signaling.coffee:49
Module: rtc.signaling

Concept of a class implementing a signaling connection to a peer.

You do not have to extend this class, just implement the functionality.

Item Index

Methods

Properties

Events

Methods

send

(
  • event
  • data
)
Promise

Defined in src/signaling/signaling.coffee:91

Sends the event with the given payload to the remote peer

Parameters:

  • event String

    The id of the event

  • data Object

    The payload of the event

Returns:

Promise:

Promise which will be resolved once the message is sent

Properties

first

Boolean

Defined in src/signaling/signaling.coffee:84

Whether the local user was in the room before the remote user (used to determine which peer will initiate the connection)

status

Object

Defined in src/signaling/signaling.coffee:77

The status object of the remote peer

Events

left

()

Defined in src/signaling/signaling.coffee:59

The remote peer left the room

message

(
  • event
  • data
)

Defined in src/signaling/signaling.coffee:64

Received a message from the remote peer

Parameters:

  • event String

    ID of the event

  • data Obejct

    Payload of the event

status_changed

(
  • status
)

Defined in src/signaling/signaling.coffee:71

The status object of the remote peer was updated

Parameters:

  • status Object

    The new status