Skip to content

CameraInterfacePtzPositionMessage

HTTP API schema

Where a pan-tilt camera points after a step-ptz, move-ptz or stop-ptz request, estimated from the steps the provider has sent and how long and how fast the camera has turned in this camera session. Pan counts degrees to the right of panReference and tilt counts degrees up from tiltReference. A reference is the end of the range once the camera has been turned to that end in this session, and the session start before that.

CameraInterfacePtzPositionMessage fields

movedDegreesnumberRequired

How far this request turned the camera, in degrees, after stopping at the end of the range. It is 0 for a move-ptz without seconds, which answers as soon as the camera starts turning.

minimum: 0

panDegreesnumberRequired

Degrees to the right of panReference. Negative means left of the session start.

panReferencestringRequired

LEFT_END once the camera has been turned to its left or right end in this session, so panDegrees runs from 0 to panRangeDegrees.

Allowed values

  • LEFT_END
  • SESSION_START
panRangeDegreesnumberRequired

How far the camera can pan from its left end to its right end.

minimum: 0

panMovingbooleanRequired

Whether the camera is still turning on the pan axis after a move-ptz without seconds.

tiltDegreesnumberRequired

Degrees up from tiltReference. Negative means below the session start.

tiltReferencestringRequired

BOTTOM_END once the camera has been turned to its top or bottom end in this session, so tiltDegrees runs from 0 to tiltRangeDegrees.

Allowed values

  • BOTTOM_END
  • SESSION_START
tiltRangeDegreesnumberRequired

How far the camera can tilt from its bottom end to its top end.

minimum: 0

tiltMovingbooleanRequired

Whether the camera is still turning on the tilt axis after a move-ptz without seconds.

View source specification ↗