Actions27
- Set Detect
- Set Recordings
- Set Snapshots
- Set Audio Detection
- Set Motion Detection
- Set Improve Contrast
- Set Camera Enabled
- Set Motion Threshold
- Set Motion Contour Area
- Set Birdseye (Camera)
- Set Birdseye Mode
- PTZ Command
- Set PTZ Autotracker
- Set Global Notifications
- Set Per-Camera Notifications
- Suspend Per-Camera Notifications
- Set Audio Transcription
- Set Review Alerts
- Set Review Detections
- Set Object Descriptions
- Set Review Descriptions
- Set Motion Mask
- Set Object Mask
- Set Zone
- Restart
- Publish to Custom Topic
- Wait for Next Topic Value
Set Object Descriptions
AI-generatedSummary
Set object description description state for a Frigate camera
Inputs
- camera (required) — The camera name as configured in Frigate
- value (required) — Whether to turn the object description feature on or off
- awaitState — Whether to keep the socket open and wait for the matching /state read-back to confirm the new value
- awaitTimeoutMs — How long to wait for the /state read-back before giving up (0-600000 ms)
Output shape
an object containing operation, topic, payload, published; optionally confirmed, stateTopic, stateValue when awaitState is true
published is always true; if awaitState is enabled the response includes confirmation details, otherwise only operation, topic, payload, published
Examples
Example 1: Enable object descriptions for the front_door camera and wait for confirmation
operation=setObjectDescriptions, camera=front_door, value=ON, awaitState=true, awaitTimeoutMs=5000