API Docs for:
Show:

rtc.Room Class

Defined in: src/room.coffee:13
Module: rtc

A virtual room which connects multiple Peers

Constructor

rtc.Room

(
  • name
  • signaling
  • [options]
)

Defined in src/room.coffee:13

Parameters:

  • name String

    The name of the room. Will be passed on to signaling

  • signaling rtc.Signaling | String

    The signaling to be used. If you pass a string it will be interpreted as a websocket address and a palava signaling connection will be established with it.

  • [options] Object optional

    Various options to be used in connections created by this room

    • [auto_connect=true] Boolean optional

      Whether remote peers are connected automatically or an explicit RemotePeer.connect() call is needed

    • [stun] String optional

      The URI of the STUN server to use

    • [local] rtc.LocalPeer optional

      The local user

Methods

create_peer

(
  • pc
  • signaling_peer
)
private

Defined in src/room.coffee:125

Creates a remote peer. Overwrite to use your own class for peers.

Parameters:

  • pc rtc.PeerConnection

    The PeerConnection to the peer

  • signaling_peer rtc.SignalingPeer

    The signaling connection to the peer

join

() Promise

Defined in src/room.coffee:96

Joins the room. Initiates connection to signaling server if not done before.

Returns:

Promise:

A promise which will be resolved once the room was joined

leave

()

Defined in src/room.coffee:108

Leaves the room and closes all established peer connections

leave

()

Defined in src/room.coffee:116

Cleans up all resources used by the room.

Properties

local

rtc.LocalPeer

Defined in src/room.coffee:57

The local peer

signaling

rtc.signaling.Signaling

Defined in src/room.coffee:51

The underlying signaling implementation as provided in constructor

Events

closed

()

Defined in src/room.coffee:46

The connection to the room was closed

peer_jopined

(
  • peer
)

Defined in src/room.coffee:27

A new peer is encountered in the room. Fires on new remote peers after joining and for all peers in the room when joining.

Parameters:

peer_left

(
  • peer
)

Defined in src/room.coffee:33

A peer left the room.

Parameters:

peer_status_changed

(
  • peer
  • status
)

Defined in src/room.coffee:39

A peer changed its status.

Parameters:

  • peer rtc.RemotePeer

    The peer which changed its status

  • status Object

    The new status