Class: palava.Room

Defined in: coffee/room.coffee
Inherits: EventEmitter

Overview

A room connecting multiple participants

Instance Method Summary

Constructor Details

# (void) constructor(roomId, channel, userMedia, options = {})

Parameters:

  • roomId (String) ID of the room
  • channel (palava.Channel) Channel used for communication
  • userMedia (UserMedia) UserMedia used for local user
  • options (Object) Further objects for the room

Options Hash: (options):

  • joinTimeout (Integer) Timeout for joining
  • ownStatus (Object) The status of the local user

Instance Method Details

# (void) join(status = {}) Bound

Join the room

Parameters:

  • status (Object) Status of the local user

# (void) leave() Bound

Leave the room

# (palava.Peer) getPeerById(id) Bound

Find peer with the given id

Parameters:

  • id (String) id of the searched peer

Returns:

  • (palava.Peer) — The peer with the given id or undefined

# (palava.Peer) getLocalPeer() Bound

Get local peer

Returns:

  • (palava.Peer) — The local peer

# (Array) getRemotePeers() Bound

Get remote peers

Returns:

  • (Array) — All peers except the local peer

# (Array) getAllPeers(allowLocal = true) Bound

Get all peers

Returns:

  • (Array) — All peers including the local peer

    Quickly fuzzy find classes, mixins, methods, file:

    Control the navigation frame:

    You can focus and blur the search input: