Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- {
- "title": "FrigateConfig",
- "type": "object",
- "properties": {
- "mqtt": {
- "title": "MQTT Configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/MqttConfig"
- }
- ]
- },
- "database": {
- "title": "Database configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/DatabaseConfig"
- }
- ]
- },
- "environment_vars": {
- "title": "Frigate environment variables.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "ui": {
- "title": "UI configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/UIConfig"
- }
- ]
- },
- "telemetry": {
- "title": "Telemetry configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/TelemetryConfig"
- }
- ]
- },
- "model": {
- "title": "Detection model configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/ModelConfig"
- }
- ]
- },
- "detectors": {
- "title": "Detector hardware configuration.",
- "default": {
- "cpu": {
- "type": "cpu"
- }
- },
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/BaseDetectorConfig"
- }
- },
- "logger": {
- "title": "Logging configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/LoggerConfig"
- }
- ]
- },
- "record": {
- "title": "Global record configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/RecordConfig"
- }
- ]
- },
- "snapshots": {
- "title": "Global snapshots configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/SnapshotsConfig"
- }
- ]
- },
- "rtmp": {
- "title": "Global RTMP restreaming configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/RtmpConfig"
- }
- ]
- },
- "live": {
- "title": "Live playback settings.",
- "allOf": [
- {
- "$ref": "#/definitions/CameraLiveConfig"
- }
- ]
- },
- "go2rtc": {
- "title": "Global restream configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/RestreamConfig"
- }
- ]
- },
- "birdseye": {
- "title": "Birdseye configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/BirdseyeConfig"
- }
- ]
- },
- "ffmpeg": {
- "title": "Global FFmpeg configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/FfmpegConfig"
- }
- ]
- },
- "objects": {
- "title": "Global object configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/ObjectConfig"
- }
- ]
- },
- "audio": {
- "title": "Global Audio events configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/AudioConfig"
- }
- ]
- },
- "motion": {
- "title": "Global motion detection configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/MotionConfig"
- }
- ]
- },
- "detect": {
- "title": "Global object tracking configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/DetectConfig"
- }
- ]
- },
- "cameras": {
- "title": "Camera configuration.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/CameraConfig"
- }
- },
- "timestamp_style": {
- "title": "Global timestamp style configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/TimestampStyleConfig"
- }
- ]
- }
- },
- "required": [
- "mqtt",
- "cameras"
- ],
- "additionalProperties": false,
- "definitions": {
- "MqttConfig": {
- "title": "MqttConfig",
- "type": "object",
- "properties": {
- "enabled": {
- "title": "Enable MQTT Communication.",
- "default": true,
- "type": "boolean"
- },
- "host": {
- "title": "MQTT Host",
- "default": "",
- "type": "string"
- },
- "port": {
- "title": "MQTT Port",
- "default": 1883,
- "type": "integer"
- },
- "topic_prefix": {
- "title": "MQTT Topic Prefix",
- "default": "frigate",
- "type": "string"
- },
- "client_id": {
- "title": "MQTT Client ID",
- "default": "frigate",
- "type": "string"
- },
- "stats_interval": {
- "title": "MQTT Camera Stats Interval",
- "default": 60,
- "type": "integer"
- },
- "user": {
- "title": "MQTT Username",
- "type": "string"
- },
- "password": {
- "title": "MQTT Password",
- "type": "string"
- },
- "tls_ca_certs": {
- "title": "MQTT TLS CA Certificates",
- "type": "string"
- },
- "tls_client_cert": {
- "title": "MQTT TLS Client Certificate",
- "type": "string"
- },
- "tls_client_key": {
- "title": "MQTT TLS Client Key",
- "type": "string"
- },
- "tls_insecure": {
- "title": "MQTT TLS Insecure",
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "DatabaseConfig": {
- "title": "DatabaseConfig",
- "type": "object",
- "properties": {
- "path": {
- "title": "Database path.",
- "default": "/config/frigate.db",
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "LiveModeEnum": {
- "title": "LiveModeEnum",
- "description": "An enumeration.",
- "enum": [
- "jsmpeg",
- "mse",
- "webrtc"
- ],
- "type": "string"
- },
- "TimeFormatEnum": {
- "title": "TimeFormatEnum",
- "description": "An enumeration.",
- "enum": [
- "browser",
- "12hour",
- "24hour"
- ],
- "type": "string"
- },
- "DateTimeStyleEnum": {
- "title": "DateTimeStyleEnum",
- "description": "An enumeration.",
- "enum": [
- "full",
- "long",
- "medium",
- "short"
- ],
- "type": "string"
- },
- "UIConfig": {
- "title": "UIConfig",
- "type": "object",
- "properties": {
- "live_mode": {
- "title": "Default Live Mode.",
- "default": "mse",
- "allOf": [
- {
- "$ref": "#/definitions/LiveModeEnum"
- }
- ]
- },
- "timezone": {
- "title": "Override UI timezone.",
- "type": "string"
- },
- "use_experimental": {
- "title": "Experimental UI",
- "default": false,
- "type": "boolean"
- },
- "time_format": {
- "title": "Override UI time format.",
- "default": "browser",
- "allOf": [
- {
- "$ref": "#/definitions/TimeFormatEnum"
- }
- ]
- },
- "date_style": {
- "title": "Override UI dateStyle.",
- "default": "short",
- "allOf": [
- {
- "$ref": "#/definitions/DateTimeStyleEnum"
- }
- ]
- },
- "time_style": {
- "title": "Override UI timeStyle.",
- "default": "medium",
- "allOf": [
- {
- "$ref": "#/definitions/DateTimeStyleEnum"
- }
- ]
- },
- "strftime_fmt": {
- "title": "Override date and time format using strftime syntax.",
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "StatsConfig": {
- "title": "StatsConfig",
- "type": "object",
- "properties": {
- "amd_gpu_stats": {
- "title": "Enable AMD GPU stats.",
- "default": true,
- "type": "boolean"
- },
- "intel_gpu_stats": {
- "title": "Enable Intel GPU stats.",
- "default": true,
- "type": "boolean"
- },
- "network_bandwidth": {
- "title": "Enable network bandwidth for ffmpeg processes.",
- "default": false,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "TelemetryConfig": {
- "title": "TelemetryConfig",
- "type": "object",
- "properties": {
- "network_interfaces": {
- "title": "Enabled network interfaces for bandwidth calculation.",
- "default": [
- "eth",
- "enp",
- "eno",
- "ens",
- "wl",
- "lo"
- ],
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "stats": {
- "title": "System Stats Configuration",
- "allOf": [
- {
- "$ref": "#/definitions/StatsConfig"
- }
- ]
- },
- "version_check": {
- "title": "Enable latest version check.",
- "default": true,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "InputTensorEnum": {
- "title": "InputTensorEnum",
- "description": "An enumeration.",
- "enum": [
- "nchw",
- "nhwc"
- ],
- "type": "string"
- },
- "PixelFormatEnum": {
- "title": "PixelFormatEnum",
- "description": "An enumeration.",
- "enum": [
- "rgb",
- "bgr",
- "yuv"
- ],
- "type": "string"
- },
- "ModelTypeEnum": {
- "title": "ModelTypeEnum",
- "description": "An enumeration.",
- "enum": [
- "ssd",
- "yolox",
- "yolov5",
- "yolov8"
- ],
- "type": "string"
- },
- "ModelConfig": {
- "title": "ModelConfig",
- "type": "object",
- "properties": {
- "path": {
- "title": "Custom Object detection model path.",
- "type": "string"
- },
- "labelmap_path": {
- "title": "Label map for custom object detector.",
- "type": "string"
- },
- "width": {
- "title": "Object detection model input width.",
- "default": 320,
- "type": "integer"
- },
- "height": {
- "title": "Object detection model input height.",
- "default": 320,
- "type": "integer"
- },
- "labelmap": {
- "title": "Labelmap customization.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "input_tensor": {
- "title": "Model Input Tensor Shape",
- "default": "nhwc",
- "allOf": [
- {
- "$ref": "#/definitions/InputTensorEnum"
- }
- ]
- },
- "input_pixel_format": {
- "title": "Model Input Pixel Color Format",
- "default": "rgb",
- "allOf": [
- {
- "$ref": "#/definitions/PixelFormatEnum"
- }
- ]
- },
- "model_type": {
- "title": "Object Detection Model Type",
- "default": "ssd",
- "allOf": [
- {
- "$ref": "#/definitions/ModelTypeEnum"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "BaseDetectorConfig": {
- "title": "BaseDetectorConfig",
- "type": "object",
- "properties": {
- "type": {
- "title": "Detector Type",
- "default": "cpu",
- "type": "string"
- },
- "model": {
- "title": "Detector specific model configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/ModelConfig"
- }
- ]
- }
- }
- },
- "LogLevelEnum": {
- "title": "LogLevelEnum",
- "description": "An enumeration.",
- "enum": [
- "debug",
- "info",
- "warning",
- "error",
- "critical"
- ],
- "type": "string"
- },
- "LoggerConfig": {
- "title": "LoggerConfig",
- "type": "object",
- "properties": {
- "default": {
- "title": "Default logging level.",
- "default": "info",
- "allOf": [
- {
- "$ref": "#/definitions/LogLevelEnum"
- }
- ]
- },
- "logs": {
- "title": "Log level for specified processes.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/LogLevelEnum"
- }
- }
- },
- "additionalProperties": false
- },
- "RetainModeEnum": {
- "title": "RetainModeEnum",
- "description": "An enumeration.",
- "enum": [
- "all",
- "motion",
- "active_objects"
- ],
- "type": "string"
- },
- "RecordRetainConfig": {
- "title": "RecordRetainConfig",
- "type": "object",
- "properties": {
- "days": {
- "title": "Default retention period.",
- "default": 0,
- "type": "number"
- },
- "mode": {
- "title": "Retain mode.",
- "default": "all",
- "allOf": [
- {
- "$ref": "#/definitions/RetainModeEnum"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "RetainConfig": {
- "title": "RetainConfig",
- "type": "object",
- "properties": {
- "default": {
- "title": "Default retention period.",
- "default": 10,
- "type": "number"
- },
- "mode": {
- "title": "Retain mode.",
- "default": "motion",
- "allOf": [
- {
- "$ref": "#/definitions/RetainModeEnum"
- }
- ]
- },
- "objects": {
- "title": "Object retention period.",
- "type": "object",
- "additionalProperties": {
- "type": "number"
- }
- }
- },
- "additionalProperties": false
- },
- "EventsConfig": {
- "title": "EventsConfig",
- "type": "object",
- "properties": {
- "pre_capture": {
- "title": "Seconds to retain before event starts.",
- "default": 5,
- "type": "integer"
- },
- "post_capture": {
- "title": "Seconds to retain after event ends.",
- "default": 5,
- "type": "integer"
- },
- "required_zones": {
- "title": "List of required zones to be entered in order to save the event.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "objects": {
- "title": "List of objects to be detected in order to save the event.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "retain": {
- "title": "Event retention settings.",
- "allOf": [
- {
- "$ref": "#/definitions/RetainConfig"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "RecordConfig": {
- "title": "RecordConfig",
- "type": "object",
- "properties": {
- "enabled": {
- "title": "Enable record on all cameras.",
- "default": false,
- "type": "boolean"
- },
- "expire_interval": {
- "title": "Number of minutes to wait between cleanup runs.",
- "default": 60,
- "type": "integer"
- },
- "retain": {
- "title": "Record retention settings.",
- "allOf": [
- {
- "$ref": "#/definitions/RecordRetainConfig"
- }
- ]
- },
- "events": {
- "title": "Event specific settings.",
- "allOf": [
- {
- "$ref": "#/definitions/EventsConfig"
- }
- ]
- },
- "enabled_in_config": {
- "title": "Keep track of original state of recording.",
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "SnapshotsConfig": {
- "title": "SnapshotsConfig",
- "type": "object",
- "properties": {
- "enabled": {
- "title": "Snapshots enabled.",
- "default": false,
- "type": "boolean"
- },
- "clean_copy": {
- "title": "Create a clean copy of the snapshot image.",
- "default": true,
- "type": "boolean"
- },
- "timestamp": {
- "title": "Add a timestamp overlay on the snapshot.",
- "default": false,
- "type": "boolean"
- },
- "bounding_box": {
- "title": "Add a bounding box overlay on the snapshot.",
- "default": true,
- "type": "boolean"
- },
- "crop": {
- "title": "Crop the snapshot to the detected object.",
- "default": false,
- "type": "boolean"
- },
- "required_zones": {
- "title": "List of required zones to be entered in order to save a snapshot.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "height": {
- "title": "Snapshot image height.",
- "type": "integer"
- },
- "retain": {
- "title": "Snapshot retention.",
- "allOf": [
- {
- "$ref": "#/definitions/RetainConfig"
- }
- ]
- },
- "quality": {
- "title": "Quality of the encoded jpeg (0-100).",
- "default": 70,
- "minimum": 0,
- "maximum": 100,
- "type": "integer"
- }
- },
- "additionalProperties": false
- },
- "RtmpConfig": {
- "title": "RtmpConfig",
- "type": "object",
- "properties": {
- "enabled": {
- "title": "RTMP restreaming enabled.",
- "default": false,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "CameraLiveConfig": {
- "title": "CameraLiveConfig",
- "type": "object",
- "properties": {
- "stream_name": {
- "title": "Name of restream to use as live view.",
- "default": "",
- "type": "string"
- },
- "height": {
- "title": "Live camera view height",
- "default": 720,
- "type": "integer"
- },
- "quality": {
- "title": "Live camera view quality",
- "default": 8,
- "minimum": 1,
- "maximum": 31,
- "type": "integer"
- }
- },
- "additionalProperties": false
- },
- "RestreamConfig": {
- "title": "RestreamConfig",
- "type": "object",
- "properties": {}
- },
- "BirdseyeModeEnum": {
- "title": "BirdseyeModeEnum",
- "description": "An enumeration.",
- "enum": [
- "objects",
- "motion",
- "continuous"
- ],
- "type": "string"
- },
- "BirdseyeConfig": {
- "title": "BirdseyeConfig",
- "type": "object",
- "properties": {
- "enabled": {
- "title": "Enable birdseye view.",
- "default": true,
- "type": "boolean"
- },
- "restream": {
- "title": "Restream birdseye via RTSP.",
- "default": false,
- "type": "boolean"
- },
- "width": {
- "title": "Birdseye width.",
- "default": 1280,
- "type": "integer"
- },
- "height": {
- "title": "Birdseye height.",
- "default": 720,
- "type": "integer"
- },
- "quality": {
- "title": "Encoding quality.",
- "default": 8,
- "minimum": 1,
- "maximum": 31,
- "type": "integer"
- },
- "mode": {
- "title": "Tracking mode.",
- "default": "objects",
- "allOf": [
- {
- "$ref": "#/definitions/BirdseyeModeEnum"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "FfmpegOutputArgsConfig": {
- "title": "FfmpegOutputArgsConfig",
- "type": "object",
- "properties": {
- "detect": {
- "title": "Detect role FFmpeg output arguments.",
- "default": [
- "-threads",
- "2",
- "-f",
- "rawvideo",
- "-pix_fmt",
- "yuv420p"
- ],
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- },
- "record": {
- "title": "Record role FFmpeg output arguments.",
- "default": "preset-record-generic",
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- },
- "rtmp": {
- "title": "RTMP role FFmpeg output arguments.",
- "default": "preset-rtmp-generic",
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "FfmpegConfig": {
- "title": "FfmpegConfig",
- "type": "object",
- "properties": {
- "global_args": {
- "title": "Global FFmpeg arguments.",
- "default": [
- "-hide_banner",
- "-loglevel",
- "warning",
- "-threads",
- "2"
- ],
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- },
- "hwaccel_args": {
- "title": "FFmpeg hardware acceleration arguments.",
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- },
- "input_args": {
- "title": "FFmpeg input arguments.",
- "default": "preset-rtsp-generic",
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- },
- "output_args": {
- "title": "FFmpeg output arguments per role.",
- "allOf": [
- {
- "$ref": "#/definitions/FfmpegOutputArgsConfig"
- }
- ]
- },
- "retry_interval": {
- "title": "Time in seconds to wait before FFmpeg retries connecting to the camera.",
- "default": 10,
- "type": "number"
- }
- },
- "additionalProperties": false
- },
- "FilterConfig": {
- "title": "FilterConfig",
- "type": "object",
- "properties": {
- "min_area": {
- "title": "Minimum area of bounding box for object to be counted.",
- "default": 0,
- "type": "integer"
- },
- "max_area": {
- "title": "Maximum area of bounding box for object to be counted.",
- "default": 24000000,
- "type": "integer"
- },
- "min_ratio": {
- "title": "Minimum ratio of bounding box's width/height for object to be counted.",
- "default": 0,
- "type": "number"
- },
- "max_ratio": {
- "title": "Maximum ratio of bounding box's width/height for object to be counted.",
- "default": 24000000,
- "type": "number"
- },
- "threshold": {
- "title": "Average detection confidence threshold for object to be counted.",
- "default": 0.7,
- "type": "number"
- },
- "min_score": {
- "title": "Minimum detection confidence for object to be counted.",
- "default": 0.5,
- "type": "number"
- },
- "mask": {
- "title": "Detection area polygon mask for this filter configuration.",
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "ObjectConfig": {
- "title": "ObjectConfig",
- "type": "object",
- "properties": {
- "track": {
- "title": "Objects to track.",
- "default": [
- "person"
- ],
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "filters": {
- "title": "Object filters.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/FilterConfig"
- }
- },
- "mask": {
- "title": "Object mask.",
- "default": "",
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "AudioConfig": {
- "title": "AudioConfig",
- "type": "object",
- "properties": {
- "enabled": {
- "title": "Enable audio events.",
- "default": false,
- "type": "boolean"
- },
- "max_not_heard": {
- "title": "Seconds of not hearing the type of audio to end the event.",
- "default": 30,
- "type": "integer"
- },
- "listen": {
- "title": "Audio to listen for.",
- "default": [
- "bark",
- "speech",
- "yell",
- "scream"
- ],
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "enabled_in_config": {
- "title": "Keep track of original state of audio detection.",
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "MotionConfig": {
- "title": "MotionConfig",
- "type": "object",
- "properties": {
- "threshold": {
- "title": "Motion detection threshold (1-255).",
- "default": 30,
- "minimum": 1,
- "maximum": 255,
- "type": "integer"
- },
- "lightning_threshold": {
- "title": "Lightning detection threshold (0.3-1.0).",
- "default": 0.8,
- "minimum": 0.3,
- "maximum": 1,
- "type": "number"
- },
- "improve_contrast": {
- "title": "Improve Contrast",
- "default": true,
- "type": "boolean"
- },
- "contour_area": {
- "title": "Contour Area",
- "default": 10,
- "type": "integer"
- },
- "delta_alpha": {
- "title": "Delta Alpha",
- "default": 0.2,
- "type": "number"
- },
- "frame_alpha": {
- "title": "Frame Alpha",
- "default": 0.01,
- "type": "number"
- },
- "frame_height": {
- "title": "Frame Height",
- "default": 100,
- "type": "integer"
- },
- "mask": {
- "title": "Coordinates polygon for the motion mask.",
- "default": "",
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- },
- "mqtt_off_delay": {
- "title": "Delay for updating MQTT with no motion detected.",
- "default": 30,
- "type": "integer"
- }
- },
- "additionalProperties": false
- },
- "StationaryMaxFramesConfig": {
- "title": "StationaryMaxFramesConfig",
- "type": "object",
- "properties": {
- "default": {
- "title": "Default max frames.",
- "minimum": 1,
- "type": "integer"
- },
- "objects": {
- "title": "Object specific max frames.",
- "type": "object",
- "additionalProperties": {
- "type": "integer"
- }
- }
- },
- "additionalProperties": false
- },
- "StationaryConfig": {
- "title": "StationaryConfig",
- "type": "object",
- "properties": {
- "interval": {
- "title": "Frame interval for checking stationary objects.",
- "exclusiveMinimum": 0,
- "type": "integer"
- },
- "threshold": {
- "title": "Number of frames without a position change for an object to be considered stationary",
- "minimum": 1,
- "type": "integer"
- },
- "max_frames": {
- "title": "Max frames for stationary objects.",
- "allOf": [
- {
- "$ref": "#/definitions/StationaryMaxFramesConfig"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "DetectConfig": {
- "title": "DetectConfig",
- "type": "object",
- "properties": {
- "height": {
- "title": "Height of the stream for the detect role.",
- "default": 720,
- "type": "integer"
- },
- "width": {
- "title": "Width of the stream for the detect role.",
- "default": 1280,
- "type": "integer"
- },
- "fps": {
- "title": "Number of frames per second to process through detection.",
- "default": 5,
- "type": "integer"
- },
- "enabled": {
- "title": "Detection Enabled.",
- "default": true,
- "type": "boolean"
- },
- "max_disappeared": {
- "title": "Maximum number of frames the object can dissapear before detection ends.",
- "type": "integer"
- },
- "stationary": {
- "title": "Stationary objects config.",
- "allOf": [
- {
- "$ref": "#/definitions/StationaryConfig"
- }
- ]
- },
- "annotation_offset": {
- "title": "Milliseconds to offset detect annotations by.",
- "default": 0,
- "type": "integer"
- }
- },
- "additionalProperties": false
- },
- "CameraRoleEnum": {
- "title": "CameraRoleEnum",
- "description": "An enumeration.",
- "enum": [
- "audio",
- "record",
- "rtmp",
- "detect"
- ],
- "type": "string"
- },
- "CameraInput": {
- "title": "CameraInput",
- "type": "object",
- "properties": {
- "path": {
- "title": "Camera input path.",
- "type": "string"
- },
- "roles": {
- "title": "Roles assigned to this input.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/CameraRoleEnum"
- }
- },
- "global_args": {
- "title": "FFmpeg global arguments.",
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- },
- "hwaccel_args": {
- "title": "FFmpeg hardware acceleration arguments.",
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- },
- "input_args": {
- "title": "FFmpeg input arguments.",
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- }
- },
- "required": [
- "path",
- "roles"
- ],
- "additionalProperties": false
- },
- "CameraFfmpegConfig": {
- "title": "CameraFfmpegConfig",
- "type": "object",
- "properties": {
- "global_args": {
- "title": "Global FFmpeg arguments.",
- "default": [
- "-hide_banner",
- "-loglevel",
- "warning",
- "-threads",
- "2"
- ],
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- },
- "hwaccel_args": {
- "title": "FFmpeg hardware acceleration arguments.",
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- },
- "input_args": {
- "title": "FFmpeg input arguments.",
- "default": "preset-rtsp-generic",
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- },
- "output_args": {
- "title": "FFmpeg output arguments per role.",
- "allOf": [
- {
- "$ref": "#/definitions/FfmpegOutputArgsConfig"
- }
- ]
- },
- "retry_interval": {
- "title": "Time in seconds to wait before FFmpeg retries connecting to the camera.",
- "default": 10,
- "type": "number"
- },
- "inputs": {
- "title": "Camera inputs.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/CameraInput"
- }
- }
- },
- "required": [
- "inputs"
- ],
- "additionalProperties": false
- },
- "ZoneConfig": {
- "title": "ZoneConfig",
- "type": "object",
- "properties": {
- "filters": {
- "title": "Zone filters.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/FilterConfig"
- }
- },
- "coordinates": {
- "title": "Coordinates polygon for the defined zone.",
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- },
- "inertia": {
- "title": "Number of consecutive frames required for object to be considered present in the zone.",
- "default": 3,
- "exclusiveMinimum": 0,
- "maximum": 10,
- "type": "integer"
- },
- "objects": {
- "title": "List of objects that can trigger the zone.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "coordinates"
- ]
- },
- "CameraMqttConfig": {
- "title": "CameraMqttConfig",
- "type": "object",
- "properties": {
- "enabled": {
- "title": "Send image over MQTT.",
- "default": true,
- "type": "boolean"
- },
- "timestamp": {
- "title": "Add timestamp to MQTT image.",
- "default": true,
- "type": "boolean"
- },
- "bounding_box": {
- "title": "Add bounding box to MQTT image.",
- "default": true,
- "type": "boolean"
- },
- "crop": {
- "title": "Crop MQTT image to detected object.",
- "default": true,
- "type": "boolean"
- },
- "height": {
- "title": "MQTT image height.",
- "default": 270,
- "type": "integer"
- },
- "required_zones": {
- "title": "List of required zones to be entered in order to send the image.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "quality": {
- "title": "Quality of the encoded jpeg (0-100).",
- "default": 70,
- "minimum": 0,
- "maximum": 100,
- "type": "integer"
- }
- },
- "additionalProperties": false
- },
- "OnvifConfig": {
- "title": "OnvifConfig",
- "type": "object",
- "properties": {
- "host": {
- "title": "Onvif Host",
- "default": "",
- "type": "string"
- },
- "port": {
- "title": "Onvif Port",
- "default": 8000,
- "type": "integer"
- },
- "user": {
- "title": "Onvif Username",
- "type": "string"
- },
- "password": {
- "title": "Onvif Password",
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "CameraUiConfig": {
- "title": "CameraUiConfig",
- "type": "object",
- "properties": {
- "order": {
- "title": "Order of camera in UI.",
- "default": 0,
- "type": "integer"
- },
- "dashboard": {
- "title": "Show this camera in Frigate dashboard UI.",
- "default": true,
- "type": "boolean"
- }
- },
- "additionalProperties": false
- },
- "BirdseyeCameraConfig": {
- "title": "BirdseyeCameraConfig",
- "type": "object",
- "properties": {
- "enabled": {
- "title": "Enable birdseye view for camera.",
- "default": true,
- "type": "boolean"
- },
- "order": {
- "title": "Position of the camera in the birdseye view.",
- "default": 0,
- "type": "integer"
- },
- "mode": {
- "title": "Tracking mode for camera.",
- "default": "objects",
- "allOf": [
- {
- "$ref": "#/definitions/BirdseyeModeEnum"
- }
- ]
- }
- }
- },
- "TimestampPositionEnum": {
- "title": "TimestampPositionEnum",
- "description": "An enumeration.",
- "enum": [
- "tl",
- "tr",
- "bl",
- "br"
- ],
- "type": "string"
- },
- "ColorConfig": {
- "title": "ColorConfig",
- "type": "object",
- "properties": {
- "red": {
- "title": "Red",
- "default": 255,
- "minimum": 0,
- "maximum": 255,
- "type": "integer"
- },
- "green": {
- "title": "Green",
- "default": 255,
- "minimum": 0,
- "maximum": 255,
- "type": "integer"
- },
- "blue": {
- "title": "Blue",
- "default": 255,
- "minimum": 0,
- "maximum": 255,
- "type": "integer"
- }
- },
- "additionalProperties": false
- },
- "TimestampEffectEnum": {
- "title": "TimestampEffectEnum",
- "description": "An enumeration.",
- "enum": [
- "solid",
- "shadow"
- ],
- "type": "string"
- },
- "TimestampStyleConfig": {
- "title": "TimestampStyleConfig",
- "type": "object",
- "properties": {
- "position": {
- "title": "Timestamp position.",
- "default": "tl",
- "allOf": [
- {
- "$ref": "#/definitions/TimestampPositionEnum"
- }
- ]
- },
- "format": {
- "title": "Timestamp format.",
- "default": "%m/%d/%Y %H:%M:%S",
- "type": "string"
- },
- "color": {
- "title": "Timestamp color.",
- "allOf": [
- {
- "$ref": "#/definitions/ColorConfig"
- }
- ]
- },
- "thickness": {
- "title": "Timestamp thickness.",
- "default": 2,
- "type": "integer"
- },
- "effect": {
- "title": "Timestamp effect.",
- "allOf": [
- {
- "$ref": "#/definitions/TimestampEffectEnum"
- }
- ]
- }
- },
- "additionalProperties": false
- },
- "CameraConfig": {
- "title": "CameraConfig",
- "type": "object",
- "properties": {
- "name": {
- "title": "Camera name.",
- "pattern": "^[a-zA-Z0-9_-]+$",
- "type": "string"
- },
- "enabled": {
- "title": "Enable camera.",
- "default": true,
- "type": "boolean"
- },
- "ffmpeg": {
- "title": "FFmpeg configuration for the camera.",
- "allOf": [
- {
- "$ref": "#/definitions/CameraFfmpegConfig"
- }
- ]
- },
- "best_image_timeout": {
- "title": "How long to wait for the image with the highest confidence score.",
- "default": 60,
- "type": "integer"
- },
- "zones": {
- "title": "Zone configuration.",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/ZoneConfig"
- }
- },
- "record": {
- "title": "Record configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/RecordConfig"
- }
- ]
- },
- "rtmp": {
- "title": "RTMP restreaming configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/RtmpConfig"
- }
- ]
- },
- "live": {
- "title": "Live playback settings.",
- "allOf": [
- {
- "$ref": "#/definitions/CameraLiveConfig"
- }
- ]
- },
- "snapshots": {
- "title": "Snapshot configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/SnapshotsConfig"
- }
- ]
- },
- "mqtt": {
- "title": "MQTT configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/CameraMqttConfig"
- }
- ]
- },
- "objects": {
- "title": "Object configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/ObjectConfig"
- }
- ]
- },
- "audio": {
- "title": "Audio events configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/AudioConfig"
- }
- ]
- },
- "motion": {
- "title": "Motion detection configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/MotionConfig"
- }
- ]
- },
- "detect": {
- "title": "Object detection configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/DetectConfig"
- }
- ]
- },
- "onvif": {
- "title": "Camera Onvif Configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/OnvifConfig"
- }
- ]
- },
- "ui": {
- "title": "Camera UI Modifications.",
- "allOf": [
- {
- "$ref": "#/definitions/CameraUiConfig"
- }
- ]
- },
- "birdseye": {
- "title": "Birdseye camera configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/BirdseyeCameraConfig"
- }
- ]
- },
- "timestamp_style": {
- "title": "Timestamp style configuration.",
- "allOf": [
- {
- "$ref": "#/definitions/TimestampStyleConfig"
- }
- ]
- }
- },
- "required": [
- "ffmpeg"
- ],
- "additionalProperties": false
- }
- }
- }
Advertisement
Add Comment
Please, Sign In to add comment