# getBackground

Description: get information about the background used for the VideoSDK/Room start window.

Example:

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

Answer examples:

{
    "method": "getBackground",
    "requestId" : "1",
    "isCustomImage": true,
    "fileId": 84427739,
    "result": true
}

Parameter description:

  • isCustomImage — the flag indicating if the custom background is used

  • fileId - the identifier of the file on the built-in HTTP server that is used as a background. This field is present only when a custom background is set.

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

See also: