Skip to main content

PtzGetCaps

Application Guide

For a complete walkthrough of PTZ camera control with code examples, see the PTZ Camera Control application guide.

Retrieves the PTZ capabilities of a camera, including speed ranges, preset count, and cruise tour limits. Use this endpoint to discover the valid parameter ranges for other PTZ commands before sending control requests.

FieldValue
Endpoint/PtzGetCaps[/channelId]
MethodPOST or GET
ProductsIPC, NVR
Channel IDOptional (default 1)

Response Example

<?xml version="1.0" encoding="UTF-8"?>
<config version="2.0.0" xmlns="http://www.ipc.com/ver10">
<caps>
<controlMinSpeed type="uint32">1</controlMinSpeed>
<controlMaxSpeed type="uint32">8</controlMaxSpeed>
<presetMaxCount type="uint32">255</presetMaxCount>
<cruiseMaxCount type="uint32">8</cruiseMaxCount>
<cruisePresetMinSpeed type="uint32">1</cruisePresetMinSpeed>
<cruisePresetMaxSpeed type="uint32">8</cruisePresetMaxSpeed>
<cruisePresetMaxHoldTime type="uint32">240</cruisePresetMaxHoldTime>
<cruisePresetMaxCount type="uint32">16</cruisePresetMaxCount>
</caps>
</config>

Parameters

ParameterTypeDescription
controlMinSpeeduint32Minimum speed value for PtzControl movement commands
controlMaxSpeeduint32Maximum speed value for PtzControl movement commands
presetMaxCountuint32Maximum number of saved preset positions
cruiseMaxCountuint32Maximum number of cruise tours that can be configured
cruisePresetMinSpeeduint32Minimum speed for cruise tour preset transitions
cruisePresetMaxSpeeduint32Maximum speed for cruise tour preset transitions
cruisePresetMaxHoldTimeuint32Maximum dwell time (seconds) at each preset in a cruise tour
cruisePresetMaxCountuint32Maximum number of presets per cruise tour

Notes

  • Always query capabilities before building PTZ control logic. The speed range and preset limits may vary by camera model and firmware version.
  • On NVR systems, include the channelId to query capabilities for a specific camera channel.