getReplaceBackground

TrueConfLess than 1 minute

getReplaceBackground

Description: Retrieve the status of the background replacement feature. v4.2.0+

Request example:

{
    "method" : "getReplaceBackground",
    "requestId" : "1"
}

Response example:

{
    "method": "getReplaceBackground",
    "requestId" : "1",
    "enabled" : true,
    "fileId" : 346234218,
    "result": true
}

Parameter description:

  • requestId - a unique request identifier. You can find more details about it here.

  • enabled - status of the background replacement feature

  • fileId is an optional return parameter that indicates the file ID on the built-in HTTP server, used for background replacement. If the parameter is not specified, the default background is used.

See also: