From Bright Pattern Documentation
Created page with "<translate> =getScreenRecordingState= Returns the current state of the screen recording. ==Request== ''Syntax'' {| class="wikitable" |getScreenRecordingState(): Promise<Ope..." |
Updated via BpDeleteTranslateTags script |
||
| Line 1: | Line 1: | ||
=getScreenRecordingState= | =getScreenRecordingState= | ||
| Line 69: | Line 69: | ||
|Returns ''true'' if the screen recording is currently muted; returns ''false'' if the recording is not currently muted | |Returns ''true'' if the screen recording is currently muted; returns ''false'' if the recording is not currently muted | ||
|} | |} | ||
Latest revision as of 04:01, 29 May 2024
getScreenRecordingState
Returns the current state of the screen recording.
Request
Syntax
| getScreenRecordingState(): Promise<OperationResult<ScreenRecordingState>> |
Where:
| type ScreenRecordingState = {
allowed: boolean active: boolean muted: boolean } |
Parameters
(None)
Example Request
getScreenRecordingStateButton.onclick = () => {
adApi.getScreenRecordingState()
}
Return Value
| Object | Object Values | Data Type | Optional?
(Y/N) |
Value Description |
| ScreenRecordingState | ||||
| allowed | Boolean | N | Returns true if the screen recording is allowed for the current user; returns false if not allowed | |
| active | Boolean | N | Returns true if the screen recording is active now; returns false if not active now | |
| muted | Boolean | N | Returns true if the screen recording is currently muted; returns false if the recording is not currently muted |