Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
    • Browse by device type
    • Device capabilities
      • Common methods
      • Detection and alarms
        • Arming
        • Attention zone
        • People counting
        • Cry detection
        • Absence from post
        • Face recognition
        • Fall detection
        • Gesture call
        • Intrusion
        • Loitering
        • Minor detection
        • Person and vehicle mix
        • Motion detection
        • Video occlusion
        • Illegal parking
        • Person detection
        • Pet detection
        • PIR
        • License plate recognition
        • Vehicle guard
        • Siren
          • detection.siren.enabled (Read siren switch)
          • detection.siren.linkage (Read alarm-linked siren)
          • detection.siren.linkage (Set alarm-linked siren)
          • detection.siren.linkageEvents (Read siren linkage events)
          • detection.siren.linkageEvents (Set siren linkage events)
          • detection.siren.plan (Read siren arming time periods)
          • detection.siren.plan (Set siren arming time periods)
          • detection.siren.state (Read siren state)
          • detection.siren.start (Start siren)
          • detection.siren.stop (Stop siren)
          • detection.siren.countdown (Get siren countdown)
          • detection.siren.duration (Set siren duration)
          • detection.siren.activated (Siren activated)
          • detection.siren.holdDuration (Read siren hold duration)
          • detection.siren.holdDuration (Set siren hold duration)
        • Voice SOS
        • Abnormal sound
        • Tripwire
        • Unoccupied detection
        • Vehicle
        • Door contact
        • Tamper
        • Gate accessory
        • Environment sensing
        • Target detection frame
      • Image
      • PTZ
      • Light
      • Recording
      • Audio
      • Media
      • Network
      • Power
      • Privacy
      • Call
      • Storage
      • System
      • Algorithm
      • Maintenance
      • Control
    • Events overview
    • Permission codes
    • Capability error codes
    • Alarm and capability messages
    • Capability FAQ
    • Legacy ability and push types
  • API reference
  • SDK and tools
  • Solutions
  • Platform and support
On this page
Scope
Reader notes
Index in this folder

Siren

Siren

Scope

Permission Config. Device and channel. detection.siren has scope = all: omit channelId for the whole device; pass channelId for that channel. Device-level stop and channel-level invoke share this capability; other leaves follow their point and channelId semantics.

Reader notes

Start with Using capabilities. Call device.capability.list before you use IDs on this page. See Permission codes and Capability errors.

Index in this folder

OperationID
Read siren switchdetection.siren.enabled
Read alarm-linked sirendetection.siren.linkage
Set alarm-linked sirendetection.siren.linkage
Read siren linkage eventsdetection.siren.linkageEvents
Set siren linkage eventsdetection.siren.linkageEvents
Read siren arming time periodsdetection.siren.plan
Set siren arming time periodsdetection.siren.plan
Read siren statedetection.siren.state
Start sirendetection.siren.start
Stop sirendetection.siren.stop
Get siren countdowndetection.siren.countdown
Set siren durationdetection.siren.duration
Siren activateddetection.siren.activated
Read siren hold durationdetection.siren.holdDuration
Set siren hold durationdetection.siren.holdDuration