Media Context

MediaContext provides capabilities for device control.

enableMediaEncryption

enableMediaEncryption(enabled: boolean, config: any): number;

Since v1.1.5.

Enables media stream encryption.

getAudioRecordingVolume

getAudioRecordingVolume: () => number;

Since v1.1.5.

Gets the volume of the audio collected by the microphone.

getAudioPlaybackVolume

getAudioPlaybackVolume: () => number;ng) => Promise<void>;

Since v1.1.5.

Get the volume of the audio played by the speaker.

isNative

isNative: boolean,

Whether the local client is a Windows or macOS application.

cpuUsage

cpuUsage: number,

Deprecated as of v1.1.5. Use cpuUsage in ClassroomStatsContext instead.

The CPU usage.

networkQuality

networkQuality: string,

Deprecated as of v1.1.5. Use networkQuality in ClassroomStatsContext instead.

Network quality types.

networkLatency

networkLatency: number,

Deprecated as of v1.1.5. Use networkLatency in ClassroomStatsContext instead.

Network delay (ms).

packetLostRate

packetLostRate: number,

Deprecated as of v1.1.5. Use packetLostRate in ClassroomStatsContext instead.

Packet loss rate (%).

cameraList

cameraList: any[],

The camera list.

microphoneList

microphoneList: any[],

The microphone list.

speakerList

speakerList: any[],

The speaker list.

cameraId

cameraId: string,

The ID of the selected ID.

microphoneId

microphoneId: string,

The ID of the selected microphone.

speakerId

speakerId: string,

The ID of the selected speaker.

changeDevice

changeDevice: (deviceType: string, value: any) => Promise<void>,

Switches the media device (camera, microphone, or speaker).

Parameter	Description
deviceType	The device type. You can set the parameter as camera, microphone or speaker.
value	The device ID.

changeAudioVolume

changeAudioVolume: (deviceType: string, value: any) => Promise<void>,

Adjusts the device volume.

Parameter	Description
deviceType	The device type. You can set the parameter as microphone or speaker.
value	The volume.

changeCamera

changeCamera: (deviceId: string) => Promise<void>

Since v1.1.5.

Switches the camera.

Parameter	Description
deviceId	The device ID.

changeMicrophone

changeMicrophone: (deviceId: string) => Promise<void>

Since v1.1.5.

Switches the microphone.

Parameter	Description
deviceId	The device ID.

changeSpeakerVolume

changeSpeakerVolume: (v: number) => Promise<void>

Since v1.1.5.

Adjusts the volume of the speaker.

changeMicrophoneVolume

changeMicrophoneVolume: (v: number) => Promise<void>

Since v1.1.5.

Adjusts the volume of the microphone.