SystemSettingsStates interface

A readonly representation of the current user's system settings.

Signature:

export interface SystemSettingsStates 

Properties

PropertyModifiersTypeDescription
AudioEnabledreadonlybooleanIf false all audio played via the platform will be automatically muted.
CameraEnabledreadonlybooleanIndicates whether the module has access to the camera.
MicEnabledreadonlybooleanIndicates whether the module has access to the microphone.

SystemSettingsStates.AudioEnabled property

If false all audio played via the platform will be automatically muted.

Signature:

readonly AudioEnabled: boolean;

SystemSettingsStates.CameraEnabled property

Indicates whether the module has access to the camera.

Signature:

readonly CameraEnabled: boolean;

Remarks

If the module does not have camera access all CameraMediaSources will render the user's avatar (with an audio visualization if the microphone is enabled) instead of the actual camera feed.

If the camera permission is required for your module then CameraEnabled will never be false.

SystemSettingsStates.MicEnabled property

Indicates whether the module has access to the microphone.

Signature:

readonly MicEnabled: boolean;

Remarks

If the module does not have microphone access:

If the microphone permission is required for your module then MicrophoneEnabled will never be false.