RoomSessionDevice

View as Markdown

A RoomSessionDevice represents a device (such as a microphone or a camera) that is at some point in its lifetime part of a RoomSession. You can obtain a RoomSessionDevice from the RoomSession methods addCamera, addMicrophone, and addDevice.

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