API Docs for:
Show:

rtc.signaling.MucSignalingPeer Class

Extends rtc.signaling.SignalingPeer
Defined in: src/signaling/muc_signaling.coffee:9
Module: rtc.signaling

Signaling peer for multi user chats.

For a detailed description of the signaling protocol see rtc.signaling.MucSignaling

Constructor

rtc.signaling.MucSignalingPeer

(
  • channel
  • peer_id
  • status
  • first
)

Defined in src/signaling/muc_signaling.coffee:9

Parameters:

  • channel rtc.signaling.Channel

    The channel to the siganling server

  • peer_id String

    The id of the remote peer

  • status Object

    The status of the remote peer

  • first Boolean

    Whether the local peer was in the room before the remote peer

Item Index

Methods

Properties

Events

Methods

send

(
  • event
  • data
)
Promise

Inherited from rtc.signaling.SignalingPeer: 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

Inherited from rtc.signaling.SignalingPeer: 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)

id

String

Defined in src/signaling/muc_signaling.coffee:25

The id of the remote peer

status

Object

Inherited from rtc.signaling.SignalingPeer: src/signaling/signaling.coffee:77

The status object of the remote peer

Events

left

()

Inherited from rtc.signaling.SignalingPeer: src/signaling/signaling.coffee:59

The remote peer left the room

message

(
  • event
  • data
)

Inherited from rtc.signaling.SignalingPeer: 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
)

Inherited from rtc.signaling.SignalingPeer: src/signaling/signaling.coffee:71

The status object of the remote peer was updated

Parameters:

  • status Object
    The new status