Media Server 25.3
Media Server Help

# BackgroundImage

An image of the intended scene. The engine compares the input against this image and determines whether the camera is recording the same scene.

Specify one of the following:

- An absolute path to an image file.
- A relative path to an image file. Relative paths are relative to the UserDataDirectory.
- A string that matches one of your `AdditionalDataLabels`, if you use the `AdditionalData` and `AdditionalDataLabels` action parameters to upload the image file as part of the Process action.

To strengthen security, Media Server can be configured to read files only from specified directories. For information about the directories that Media Server is permitted to read from, see the parameter AllowedInputDirectories.

Type: | String
Default: | The engine uses the first video frame that is ingested during the processing session
Required: | No
Configuration Section: | TaskName
Example: | `BackgroundImage=\\server.example.com\ptz-images\camera01.png`
See Also: |

Copyright 2025 Open Text
Version 25.3 | Last updated July 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Media Server 25.3

Topic Title: BackgroundImage