join

View as Markdown

join

  • join(): Promise<RoomSession>

Joins the room session.

Depending on the token you passed to the constructor, the room could be joined as a member or as an audience participant.

Parameters

params
object

Object containing the parameters of the method.

audio
MediaStreamConstraints['audio']

Audio constraints to use when joining the room. Default: true.

video
MediaStreamConstraints['video']

Video constraints to use when joining the room. Default: true.

receiveAudio
boolean

Whether to receive audio. Default: true.

receiveVideo
boolean

Whether to receive video. Default: true.

sendAudio
boolean

Whether to send audio. This is ignored if the token belongs to an audience member, since they cannot send audio. Default: true.

sendVideo
boolean

Whether to send video. This is ignored if the token belongs to an audience member, since they cannot send video. Default: true.

Returns

Promise<RoomSession>