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
      • Image
      • PTZ
        • PTZ movement
        • Cruise
          • ptz.cruise.mode (Read cruise mode)
          • ptz.cruise.mode (Set cruise mode)
          • ptz.cruise.smart (Read smart cruise)
          • ptz.cruise.smart (Set smart cruise)
          • ptz.cruise.interval (Read cruise interval)
          • ptz.cruise.interval (Set cruise interval)
          • ptz.cruise.minPresets (Read minimum cruise presets)
          • ptz.cruise.plan (Read cruise schedule)
          • ptz.cruise.plan (Set cruise schedule)
          • ptz.cruise.get (Get cruise info)
          • ptz.cruise.set (Set cruise info)
        • Gun-ball linkage
        • Presets
        • Zoom
      • 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

Cruise

Cruise

Scope

Properties such as mode/smart/interval/plan use get/set; the full cruise list uses invoke Get/Set cruise info. ptz.cruise.plan composes schedules (for example merging cruisePeriod with mode) and depends on capabilities such as TimedCruise/RegularCruise. minPresets is get-only (read-only leaf). Legacy HTTP: getCruiseConfig. Channel scope; permission is usually Config.

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 cruise modeptz.cruise.mode
Set cruise modeptz.cruise.mode
Read smart cruiseptz.cruise.smart
Set smart cruiseptz.cruise.smart
Read cruise intervalptz.cruise.interval
Set cruise intervalptz.cruise.interval
Read minimum cruise presets (read-only)ptz.cruise.minPresets
Read cruise scheduleptz.cruise.plan
Set cruise scheduleptz.cruise.plan
Get cruise infoptz.cruise.get
Set cruise infoptz.cruise.set