From Bright Pattern Documentation
Jump to: navigation, search
• 5.19


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
< Previous | Next >