Video.CreateRoomObjectOptions

️ Deprecated

Usage of this object is deprecated. See RoomSession instead.

Properties

applyLocalVideoOverlay

Optional applyLocalVideoOverlay: boolean

Whether to apply the local-overlay on top of your video. Default: true.


audio

Optional audio: boolean | MediaTrackConstraints

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


autoJoin

Optional autoJoin: boolean

Whether to automatically join the room session.


iceServers

Optional iceServers: RTCIceServer[]

List of ICE servers.


logLevel

Optional logLevel: "trace" | "debug" | "info" | "warn" | "error" | "silent"

logging level


project

Optional project: string

SignalWire project id, e.g. a10d8a9f-2166-4e82-56ff-118bc3a4840f


rootElementId

Optional rootElementId: string

Id of the HTML element in which to display the video stream


speakerId

Optional speakerId: string

Id of the speaker device to use for audio output. If undefined, picks a default speaker.


stopCameraWhileMuted

Optional stopCameraWhileMuted: boolean

Whether to stop the camera when the member is muted. Default: true.


stopMicrophoneWhileMuted

Optional stopMicrophoneWhileMuted: boolean

Whether to stop the microphone when the member is muted. Default: true.


token

token: string

SignalWire project token, e.g. PT9e5660c101cd140a1c93a0197640a369cf5f16975a0079c9


video

Optional video: boolean | MediaTrackConstraints

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