Skip to content

CameraInterfaceMovePtzMessage

HTTP API schema

Start turning the camera left, right, up or down in an active camera session and keep it turning until stop-ptz, another move-ptz on the same axis, a step-ptz on that axis, or the end of the camera's range. With seconds the provider stops the camera after that time and answers once it has stopped. Without seconds the provider answers as soon as the camera turns, and stops it once it has had time to reach the end of its range. A pan move and a tilt move can run at the same time. The provider answers with a ptz-position message estimated from how long and how fast the camera turned. The session must belong to the same authorized caller and endpoint.

CameraInterfaceMovePtzMessage fields

sessionIdstringRequired

ID of the caller's active RTC session on this endpoint.

minLength: 1

maxLength: 256

directionstringRequired

Allowed values

  • LEFT
  • RIGHT
  • UP
  • DOWN
speednumber

Fraction of the camera's top turning speed. Without it the camera turns at full speed.

minimum: 0.1

maximum: 1

secondsnumber

How long to turn before the provider stops the camera. The camera stops earlier at the end of its range.

minimum: 0.1

maximum: 60

View source specification ↗