Camera Control
Actions to set and control PTZ/ normal cameras. Note: Which camera types are supported always depends on model and manufacturer! This applies to all listed actions!

Action name: PanRight (PTZ head, speed)
Action category: command
The camera pans to the right.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
speed |
Speed |
Pan speed. |

Action name: PanLeft (PTZ head, speed)
Action category: command
The camera pans to the left.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
speed |
Speed |
Pan speed. |

Action name: PanStop (PTZ head)
Action category: command
The camera stops pan movement.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: TiltUp (PTZ head, speed)
Action category: command
The camera tilts up.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
speed |
Speed |
Tilt speed. |

Action name: TiltDown (PTZ head, speed)
Action category: command
The camera tilts down.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
speed |
Speed |
Tilt speed. |

Action name: TiltStop (PTZ head)
Action category: command
The camera stops the tilt movement.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: ZoomIn (PTZ head, speed)
Action category: command
The Camera zooms in (tele range).
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
speed |
Speed |
Zoom speed. |

Action name: ZoomOut (PTZ head, speed)
Action category: command
The camera zooms out (wide-angle range).
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
speed |
Speed |
Zoom speed. |

Action name: ZoomStop (PTZ head)
Action category: command
The camera stops zooming process.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: FocusNear (PTZ head, speed)
Action category: command
The camera focus adjusts on near.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
speed |
Speed |
Focus speed. |

Action name: FocusFar (PTZ head, speed)
Action category: command
The camera focus adjusts on far.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
speed |
Speed |
Focus speed. |

Action name: FocusStop (PTZ head)
Action category: command
The camera stops the focusing process.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: IrisOpen (PTZ head)
Action category: command
The camera opens the aperture.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: IrisClose (PTZ head)
Action category: command
The camera closes the aperture.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: IrisStop (PTZ head)
Action category: command
The camera stops closing/opening aperture.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: PrePosCallUp (PTZ head, position)
Action category: command
The camera moves to a preset position determined in advance through the action "SavePresetPosition".
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
position |
Position |
Preset position. |

Action name: DefaultPosCallUp (PTZ head)
Action category: command
The PTZ camera moves back to the home position (usually position 1). Therefor the home position has to be set and saved in advance by the action "SaveDefaultPosition".
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraTourStart (PTZ head, tour ID, tour name)
Action category: command
This action starts a pre-defined tour.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
tour ID |
TourID |
Tour ID. |
tour name |
TourName |
Tour name. |

Action name: CameraTourStop (PTZ head)
Action category: command
This action stops a running tour.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraLightOn (PTZ head)
Action category: command
This action turns the camera light on.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraLightOff (PTZ head)
Action category: command
This action turns the camera light off.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraOn (PTZ head)
Action category: command
This action turns on the camera.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraOff (PTZ head)
Action category: command
This action turns off the camera.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraPumpOn (PTZ head)
Action category: command
Turn camera pump on.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraPumpOff (PTZ head)
Action category: command
This action disables the pump of the camera.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: FastSpeedOn (PTZ head)
Action category: command
This action switches from normal speed of the camera to high-speed of the camera.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: FastSpeedOff (PTZ head)
Action category: command
This action switches from high-speed of the camera to normal speed of the camera.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraWashOn (PTZ head)
Action category: command
This action enables the functions "wash" and "wipe".
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraWashOff (PTZ head)
Action category: command
This action disables the functions "wash" and "wipe".
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraSpecFuncUOn (PTZ head)
Action category: command
Special functions are mapped to this action. (MBeg functions X, Y, U and V).
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraSpecFuncUOff (PTZ head)
Action category: command
Special functions are mapped to this action. (MBeg functions X, Y, U and V).
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraSpecFuncVOn (PTZ head)
Action category: command
Special functions are mapped to this action. (MBeg functions X, Y, U and V).
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraSpecFuncVOff (PTZ head)
Action category: command
Special functions are mapped to this action. (MBeg functions X, Y, U and V).
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraSpecFuncXOn (PTZ head)
Action category: command
Special functions are mapped to this action. (MBeg functions X, Y, U and V).
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraSpecFuncXOff (PTZ head)
Action category: command
Special functions are mapped to this action. (MBeg functions X, Y, U and V).
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraSpecFuncYOn (PTZ head)
Action category: command
Special functions are mapped to this action. (MBeg functions X, Y, U and V).
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraSpecFuncYOff (PTZ head)
Action category: command
Special functions are mapped to this action. (MBeg functions X, Y, U and V).
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraStopAll (PTZ head)
Action category: command
This action stops all movements of the camera.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: PrePosSave (PTZ head, position)
Action category: command
Saves current position of the PTZ camera as a preset position.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
position |
Position |
Preset position. |

Action name: DefaultPosSave (PTZ head)
Action category: command
This action saves the current position of the camera as default position.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: PrePosClear (PTZ head, position)
Action category: command
This action deletes a position previously saved by the action "SavePresetPosition".
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
position |
Position |
Preset position. |

Action name: DefaultPosClear (PTZ head)
Action category: command
This action deletes the currently defined default position.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: SetCameraText (PTZ head, text)
Action category: command
This action saves the camera description in accordance with the parameter "text".
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
text |
Text |
Text to superimpose. |

Action name: CameraSelectCharMode (PTZ head, mode)
Action category: command
"For internal use only"
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
mode |
Mode |
Character mode. |

Action name: CameraClearPrePosText (PTZ head, position)
Action category: command
This action clears the text that was previously defined and assigned to a particular camera position by the action "CameraSetPresetText" and displayed when the camera moves to this position.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
position |
Position |
Preset position. |

Action name: CameraSetPrePosText (PTZ head, position)
Action category: command
With this action, one defines the text that is associated with a particular camera position and displayed when the camera moves to this position.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
position |
Position |
Preset position. |

Action name: CameraRAWOutput (PTZ head, output)
Action category: command
This action sends a raw string (parameter output) to the camera.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
output |
Output |
RAW command to output. |

Action name: CameraApplyProfile (PTZ head, profile)
Action category: command
Apply a predefined profile settings to the camera.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
profile |
Profile |
Profile name. |

Action name: CameraVersionOn (PTZ head)
Action category: command
With this action the firmware version of the camera will be shown as OSD.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraVersionOff (PTZ head)
Action category: command
With this action the firmware version of the camera will be hidden.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: PanAuto (PTZ head, modus)
Action category: command
Cameras without automatic end stop turn on and on until this function is stopped through the action "PanStop". Cameras with automatic end stop do stop automatically after a 360 turn. It depends on the camera type if this function is even available and in case how it is going to be accomplished.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
modus |
Modus |
Pan modus. |

Action name: AutoFocusOn (PTZ head)
Action category: command
This action enables the auto-focus function of the camera.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: AutoFocusOff (PTZ head)
Action category: command
This action disables the auto-focus function of the camera.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraManualIrisOn (PTZ head)
Action category: command
This action enables the option to adjust the camera iris manually.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraManualIrisOff (PTZ head)
Action category: command
This action disables the option to adjust the camera iris manually.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraTextOn (PTZ head)
Action category: command
This action turns on the text display of the camera.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraTextOff (PTZ head)
Action category: command
This action turns off the text display of the camera.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraDayNightMode (PTZ head, mode)
Action category: command
This action changes the day/ night mode of the camera.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
mode |
Mode |
Day/night mode. |

Action name: CameraBacklightCompensationMode (PTZ head, mode)
Action category: command
This action changes the backlight compensation of the camera.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
mode |
Mode |
Backlight compensation mode. |

Action name: MoveToAbsolutePosition (PTZ head, alpha, beta, zoom, focus, alpha speed, beta speed)
Action category: command
"For internal use only"
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
alpha |
Alpha |
Alpha angle (-180°/+180°). |
beta |
Beta |
Beta angle (-90°/+90°). |
zoom |
Zoom |
Zoom value. |
focus |
Focus |
Focus value. |
alpha speed |
SpeedAlpha |
Speed in alpha direction (0/100 %). |
beta speed |
SpeedBeta |
Speed in beta direction (0/100 %). |

Action name: MoveToRelativePosition (PTZ head, alpha, beta, zoom, focus, alpha speed, beta speed)
Action category: command
"For internal use only"
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
alpha |
Alpha |
Alpha angle (-180°/+180°). |
beta |
Beta |
Beta angle (-90°/+90°). |
zoom |
Zoom |
Zoom value. |
focus |
Focus |
Focus value. |
alpha speed |
SpeedAlpha |
Speed in alpha direction (0/100 %). |
beta speed |
SpeedBeta |
Speed in beta direction (0/100 %). |

Action name: MoveToBySpeed (PTZ head, alpha speed, beta speed)
Action category: command
"For internal use only"
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
alpha speed |
SpeedAlpha |
Speed in alpha (pan) direction (0/100 %). |
beta speed |
SpeedBeta |
Speed in beta (tilt) direction (0/100 %). |

Action name: CameraAbsolutePosition (PTZ head, updated, alpha, beta, zoom, focus)
Action category: command
"For internal use only"
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
updated |
Updated |
Updated. |
alpha |
Alpha |
Alpha angle. |
beta |
Beta |
Beta angle. |
zoom |
Zoom |
Zoom value. |
focus |
Focus |
Focus value. |

Action name: CameraPushAF (PTZ head)
Action category: command
This action triggers the auto-focus function of the camera.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraAreaZoom (PTZ head, X-Coordinate, Y-Coordinate, zoom direction, rectangle width, rectangle height, width, height)
Action category: command
Camera area zoom.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
X-Coordinate |
X |
X-Coordinate of position to center. |
Y-Coordinate |
Y |
Y-Coordinate of position to center. |
zoom direction |
ZoomDirection |
Zoom direction |
rectangle width |
RectangleWidth |
Rectangle Width. |
rectangle height |
RectangleHeight |
Height of zoom rectangle. |
width |
Width |
Actual number of Pixels shown. |
height |
Height |
Actual number of Pixels shown. |

Action name: PrePosCallUpOnvif (PTZ head, position)
Action category: command
The camera moves to a preset position string defined on a custom button.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
position |
Position |
Preset position. |

Action name: GeoMove (PTZ head, latitude, longitude, elevation, speed, optional rectangle width, optional rectangle height)
Action category: command
The camera moves to a preset position string defined on a custom button.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |
latitude |
Latitude |
Latitude of geographic coordinates. |
longitude |
Longitude |
Longitude of geographic coordinates. |
elevation |
Elevation |
Elevation of geographic coordinates. |
speed |
Speed |
Pan speed. |
optional rectangle width |
RectangleWidth |
Optional Rectangle Width. |
optional rectangle height |
RectangleHeight |
Optional Height of zoom rectangle. |

Action name: CameraTourPause (PTZ head)
Action category: command
This action interrupts a running tour.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraTourResume (PTZ head)
Action category: command
This action resumes an interrupted tour.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraTourPrev (PTZ head)
Action category: command
This action selects the previous position in a running tour.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |

Action name: CameraTourNext (PTZ head)
Action category: command
This action selects the next position in a running tour.
Parameter |
Function |
|
---|---|---|
PTZ head |
Camera |
PTZ head. |