Namespace: Room

roomApi.Room

Room
Source:

Namespaces

Participant

Methods

(inner) getParticipants() → {roomApi.Room.Participant}

Get participants
Source:
Returns:
Type
roomApi.Room.Participant

(inner) leave() → {Promise.<room>}

Leave room
Source:
Returns:
Type
Promise.<room>

(inner) name() → {String}

Get room name
Source:
Returns:
Room name
Type
String

(inner) on(event, callback) → {roomApi.Room}

Add room event callback.
Parameters:
Name Type Description
event string One of roomApi.events events
callback roomApi.Room~eventCallback Callback function
Source:
Throws:
  • Error if event is not specified
    Type
    TypeError
  • Error if callback is not a valid function
    Type
    Error
Returns:
room
Type
roomApi.Room

(inner) publish(options) → {Stream}

Publish stream inside room
Parameters:
Name Type Description
options Object Stream options
Properties
Name Type Attributes Description
name string <optional>
 Stream name
constraints Object <optional>
 Stream constraints
record Boolean <optional>
 Enable stream recording
cacheLocalResources Boolean <optional>
 Display will contain local video after stream release
display HTMLElement Div element stream should be displayed in
Source:
Returns:
Type
Stream