# setReplaceBackground

Version: 4.2.0+

Description: set the status of the background replacement feature.

Request example:

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

Response example:

{
    "method": "setReplaceBackground",
    "requestId" : "1",
    "result": true
}

Parameter description:

  • enabled - the state of the background replacement feature that needs to be set

  • fileId - an optional parameter that signifies the identifier of a file on the built-in HTTP server which was previously uploaded and is used for background replacement. If this parameter is not provided, the default background is used.

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

See also: