API Docs for:
Show:

rtc.signaling.Signaling Class

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

Concept of a class implementing signaling. Might use a rtc.signaling.Channel to abstract the connection to the server.

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

Item Index

Methods

Events

Methods

close

()

Defined in src/signaling/signaling.coffee:35

Closes the connection to the signaling server

connect

() Promise

Defined in src/signaling/signaling.coffee:28

Establishes the connection with the signaling server

Returns:

Promise:

Promise which is resolved when the connection is established

setStatus

(
  • obj
)

Defined in src/signaling/signaling.coffee:41

Sets the local status object and broadcasts the change to the peers

Parameters:

  • obj Object

    New status object

Events

closed

()

Defined in src/signaling/signaling.coffee:23

The connection to the signaling server was closed

peer_joined

(
  • peer
)

Defined in src/signaling/signaling.coffee:17

A new peer joined the room

Parameters: