RoomSession

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

Example

1
const video = new Video.Client({
2
  project: "<project-id>",
3
  token: "<project-token>",
4
});
5
6
video.on("room.started", async (roomSession) => {
7
  console.log("This is my RoomSession object:", roomSession);
8
});

Properties

displayName

• displayName: string

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

hideVideoMuted

• hideVideoMuted: boolean

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

id

• id: string

Unique id for this room session

layoutName

• layoutName: string

Current layout name used in the room.

meta

• meta: Record``<string, unknown>

Metadata associated to this room session.

name

• name: string

Name of this room

previewUrl

• Optional previewUrl: string

URL to the room preview.

layoutName

• Optional layoutName: string

Current layout name used in the room.

recording

• recording: boolean

Whether recording is active

recordings

• Optional recordings: any[]

List of active recordings in the room

roomId

• roomId: string

Id of the room associated to this room session