ScreenCaptureIsEnabled

Owned by Kiss, Mate
May 24, 2022
1 min read

 

Description

Tells if capturing is enabled or not for upcoming recordings.

Does not have any effect on the screen capturing mode.

Syntaxhttp://<host>:<apiport>/ScreenCaptureIsEnabled
Parameterspass = API passcode (optional)
Examplehttp://localhost:2222/ScreenCaptureIsEnabled
Return value

Positive results:

  • 'YES' - if screen capturing is enabled
    • only three letters are returned
  • 'NO' - if screen capturing is disabled
    • only two letters are returned

Failure result:

  • 'ERROR:<code>:<description>'
    • the first 5 characters of the response are 'ERROR'
    • followed by a ':' (colon)
    • <code> is a 4 character error code
    • followed by a ':' (colon)
    • <description> textual description of the error

Defined error codes:

  • 'AUTH' - request authentication error