SystemSettingsStates interface
A readonly representation of the current user's system settings.
Signature:
export interface SystemSettingsStates
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
AudioEnabled | readonly | boolean | If false all audio played via the platform will be automatically muted. |
CameraEnabled | readonly | boolean | Indicates whether the module has access to the camera. |
MicEnabled | readonly | boolean | Indicates 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:
- All video recorders (FullScreenRecorder and MediaSourceRecorder) will not record microphone audio.
- MicrophoneRecorder and MicrophoneAudioNode cannot be used.
- If the camera is also disabled, all CameraMediaSources will render a static avatar image without an audio visualization.
If the microphone permission is required for your module then MicrophoneEnabled will never be false.
Updated 8 months ago