Skip to main content

Video

The Video namespace contains the classes and functions that you need to create a video conferencing application.

Classes

Functions

Deprecated

Functions directly on the Video namespace have been deprecated. Please use the RoomSession object to access constructors, properties, methods, and events.

createRoomObject

Const createRoomObject(roomOptions): Promise<Room>

⚠️ Deprecated

Use RoomSession instead.

Using Video.createRoomObject() you can create a RoomObject to join a room.

Parameters

NameTypeDescription
applyLocalVideoOverlay?booleanWhether to apply the local-overlay on top of your video. Default: true.
audio?boolean | MediaTrackConstraintsAudio constraints to use when joining the room. Default: true.
autoJoin?booleanWhether to automatically join the room session.
iceServers?RTCIceServer[]List of ICE servers.
logLevel?"trace" | "debug" | "info" | "warn" | "error" | "silent"Logging level.
projectstringSignalWire project id, e.g. a10d8a9f-2166-4e82-56ff-118bc3a4840f.
rootElementId?stringId of the HTML element in which to display the video stream.
speakerId?stringId of the speaker device to use for audio output. If undefined, picks a default speaker.
stopCameraWhileMuted?booleanWhether to stop the camera when the member is muted. Default: true.
stopMicrophoneWhileMuted?booleanWhether to stop the microphone when the member is muted. Default: true.
tokenstringSignalWire project token, e.g. PT9e5660c101cd140a1c93a0197640a369cf5f16975a0079c9.
video?boolean | MediaTrackConstraintsVideo constraints to use when joining the room. Default: true.

Returns

Promise<Room>

Example

With an HTMLDivElement with id="root" in the DOM.

// <div id="root"></div>

try {
const roomObj = await Video.createRoomObject({
token: "<YourJWT>",
rootElementId: "root",
});

roomObj.join();
} catch (error) {
console.error("Error", error);
}

joinRoom

Const joinRoom(roomOptions): Promise<Room>

⚠️ Deprecated.

Use RoomSession instead.

Using Video.joinRoom() you can automatically join a room.

Parameters

NameTypeDescription
applyLocalVideoOverlay?booleanWhether to apply the local-overlay on top of your video. Default: true.
audio?boolean | MediaTrackConstraintsAudio constraints to use when joining the room. Default: true.
autoJoin?booleanWhether to automatically join the room session.
iceServers?RTCIceServer[]List of ICE servers.
logLevel?"trace" | "debug" | "info" | "warn" | "error" | "silent"Logging level.
projectstringSignalWire project id, e.g. a10d8a9f-2166-4e82-56ff-118bc3a4840f.
rootElementId?stringId of the HTML element in which to display the video stream.
speakerId?stringId of the speaker device to use for audio output. If undefined, picks a default speaker.
stopCameraWhileMuted?booleanWhether to stop the camera when the member is muted. Default: true.
stopMicrophoneWhileMuted?booleanWhether to stop the microphone when the member is muted. Default: true.
tokenstringSignalWire project token, e.g. PT9e5660c101cd140a1c93a0197640a369cf5f16975a0079c9.
video?boolean | MediaTrackConstraintsVideo constraints to use when joining the room. Default: true.

Returns

Promise<Room>

Example

With an HTMLDivElement with id="root" in the DOM.

// <div id="root"></div>

try {
const roomObj = await Video.joinRoom({
token: "<YourJWT>",
rootElementId: "root",
});

// You have joined the room..
} catch (error) {
console.error("Error", error);
}