Skip to main content

Interface: CreateRoomPayload

Video.CreateRoomPayload

Create Room

Hierarchy​

Properties​

createRoom​

• Optional createRoom: boolean

Automatically Create a New Video Room on Connect

Default

true

customParameters​

• Optional customParameters: Record<string, string | number | boolean>

A collection of custom key-value pairs for additional configuration. Can be used to pass extra metadata or settings relevant to the video session.

Example

customParameters: {
  appointmentTime: 2025-02-05T13:52:00Z,
  awesome: true
  luckyNumber: 7,
}

facingMode​

• Optional facingMode: VideoFacingModeEnum

Facing Mode for Camera (Device Dependent)

Inherited from​

LocalTrackOptions.facingMode

isSupervisor​

• Optional isSupervisor: boolean

Is the Connection a Supervisor Connection (No Local Media is Published)

Default

false

localMediaContainer​

• Optional localMediaContainer: string | HTMLDivElement

The HTML Container or Container Id for auto mounting of the Local Video Stream

noiseCancellation​

• Optional noiseCancellation: boolean

Activate Noise Cancellation

Default

true

Inherited from​

LocalTrackOptions.noiseCancellation

remoteMediaContainer​

• Optional remoteMediaContainer: string | HTMLDivElement

The HTML Container or Container Id for auto mounting of the Remote Video Streams

roomName​

• Optional roomName: string

Room Name

targetSid​

• Optional targetSid: string

Target Sid to route to a specific Worker or Task Queue This can be a Twilio Task Router Worker Sid or Task Queue Sid

virtualBackgroundProcessor​

• Optional virtualBackgroundProcessor: VirtualBackgroundProcessor

The Video Background Processor. This can be created using

    await processorClient.loadVirtualBackground({ imgUrl: "https://example.com/myimg.png "});

See

Video Processor Class

waitUrl​

• Optional waitUrl: string

The Wait Url To be played while waiting for another participant

Currently only audio playback is supported.