RoomSessionScreenShare

Represents a screen share. This object is returned by the startScreenShare method in a RoomSession, and can be used to control the screen share.

Properties

active

boolean

Whether the connection is currently active.

cameraId

string | null

The id of the video device, or null if not available.

cameraLabel

string | null

The label of the video device, or null if not available.

localAudioTrack

MediaStreamTrack | null

Provides access to the local audio MediaStreamTrack.

localStream

MediaStream | undefined

Provides access to the local MediaStream.

localVideoTrack

MediaStreamTrack | null

Provides access to the local video MediaStreamTrack.

memberId

string

The id of the current member within the room.

microphoneId

string | null

The id of the audio input device, or null if not available.

microphoneLabel

string | null

The label of the audio input device, or null if not available.

remoteStream

MediaStream | undefined

Provides access to the remote MediaStream.

roomId

string

The unique identifier for the room.

roomSessionId

string

The unique identifier for the room session.

Methods

join

Join the room session

leave

Leave the room session

audioMute

Mute the microphone

audioUnmute

Unmute the microphone

videoMute

Mute the video

videoUnmute

Unmute the video

updateCamera

Switch to a different camera

updateMicrophone

Switch to a different microphone

setInputVolume

Set the input volume level

setInputSensitivity

Set the input sensitivity level

~~setMicrophoneVolume~~

Set microphone volume (deprecated)