# getReplaceBackground

Version: 4.2.0+

Description: get the status of the background replacement functionality.

Request example:

    "method" : "getReplaceBackground",
    "requestId" : "1",
    "enabled" : true

Response example:

    "method": "getReplaceBackground",
    "requestId" : "1",
    "fileId" : 346234218,
    "result": true

Parameter description:

  • requestId - unique request identifier. More details can be found here

  • enabled - the state of the background replacement function

  • fileId is an optional return parameter that indicates the identifier of the file on the built-in http server that is used to replace the background. If the parameter is absent, the default background is used.

See also: