Video

RoomSession

View as Markdown

Represents a room session.You can obtain instances of this class by subscribing to the appropriate events from Video.Client.

Example

1import { SignalWire } from "@signalwire/realtime-api";
2
3const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
4
5const videoClient = client.video;
6
7await videoClient.listen({
8  onRoomStarted: (roomsession) => {
9    console.log(roomsession);
10  }
11})

Properties

displayName
string

Display name for this room. Defaults to the value of name.

hideVideoMuted
boolean

Whether muted videos are shown in the room layout. See setHideVideoMuted.

id
string

Unique id for this room session.

layoutName
string

Current layout name used in the room.

meta
Record<string, unknown>

Metadata associated to this room session.

name
string

Name of this room.

previewUrl
string

URL to the room preview.

roomId
string

ID of the room associated to this room session.

recording
boolean

Whether the room is currently being recorded.

streaming
boolean

Whether the room is currently being streamed.

locked
boolean

Whether the room is currently locked.

prioritizeHandraise
boolean

Whether raised hands are prioritized in the layout.

updated
string[]

Array of property names that were updated. Only present in event payloads.