Monitor Configuration (cam.yaml)

💡 Tip While manage.yaml and http.yaml are required filenames, monitor configuration files can be named anything (e.g., front_door.yaml, garage.yaml).

Each monitor (camera) has its own configuration file defining its source and specific detection behaviors.

❗ Important: Source Required You must provide either a filename or a url for each monitor. One of these two fields is required to provide a video source for Scout to process.

Field Type Req. Default Description
filename string No* - Path to a local video file (for testing/simulated feeds).
url string No* - RTSP/HTTP URL for an IP camera stream.
maxSourceFps int No 0 Limit the frame rate coming from the source.
maxOutputFps int No 0 Limit the frame rate processed by detection.
quality int No 0 JPEG quality (1-100) for snapshots and live view.
captureTimeoutMilliSeconds int No 3000 Timeout in milliseconds for frame capture (defaults to 3000 ms if unset or <= 0).
captureOptions string No - Pipe-delimited FFmpeg capture options passed to OpenCV (e.g. rtsp_transport;tcp\|err_detect;explode).
captureMaxFailureTolerance int No 10 Number of consecutive failed frame reads before disconnecting the stream.
staleTimeout int No 20 Seconds before camera is considered “stale”.
staleMaxRetry int No 10 Max restart attempts for a stale camera.
bufferSeconds int No 0 Seconds of frame buffering between processing stages to smooth out spikes and prevent processing bottlenecks.
delayBufferMilliSeconds int No 0 Delay processing by this amount.
motion string No - Path to Motion Config (Recommended: motion.yaml).
tensor string No - Path to Object Detection Config (Recommended: tensor.yaml).
face string No - Path to Face Detection Config (Recommended: face.yaml).
notifyRx string No - Path to Notification Settings (Recommended: notify-rx.yaml).
alert string No - Path to Alert Rules Config (Recommended: alert.yaml).
record string No - Path to Event Recording Config (Recommended: record.yaml).
continuous string No - Path to Continuous Recording Config (Recommended: continuous.yaml).

This site uses Just the Docs, a documentation theme for Jekyll.