ScreenCapturePause

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

Pauses a running screen capturing session immediately.

During pause, the recorded screen is blank. This is useful for e.g. making sure that credit card numbers are not stored on screen recordings.

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

Positive result:

  • 'OK'
    • only two letters are returned
    • OK is returned even if screen capturing was already enabled

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:

  • 'NOON' - no ongoing call found

  • 'AUTH' - request authentication error

  • 'WRST' - capturing has been paused already

Â