ScreenCaptureEnable

Description

Enables screen capturing in the upcoming recordings.
Both call audio and screen video will be stored in the call.

Recording will automatically start when the next phone call starts.

Screen capturing will not start immediately, only when the next recorded phone call starts.

This has effect only on the next recorded phone call,
it has no effect on the ongoing recorded call.

To start screen capturing immediately/adhoc without a phone call use ScreenCaptureStart call.

Syntaxhttp://<host>:<apiport>/ScreenCaptureEnable
Parameterspass = API passcode (optional)
Examplehttp://localhost:10100/ScreenCaptureEnable
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:

  • 'AUTH' - request authentication error