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:

  • the absolute path to an image file.
  • the path to an image file, relative to the ConfigDirectory.
  • 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.

If you do not set this parameter, the engine uses the first video frame that is ingested during the processing session.

Type: String
Default:  
Required: No
Configuration Section: TaskName
Example: BackgroundImage=\\server.example.com\ptz-images\camera01.png
See Also: