| GeViScope SDK > Action documentation > Camera control

Camera control

Actions to set and control PTZ/normal cameras.

Note: Which camera types are supported always depends on model and manufacturer!

 

Auto focus off

Action name: AutoFocusOff(PTZ Head)

Action category: command

This action disables the auto-focus function of the camera.

Parameter Function
PTZ head Camera Global camera number

 

Auto focus on

Action name:AutoFocusOn(PTZ Head)

Action category: command

This action enables the auto-focus function of the camera.

Parameter Function
PTZ head Camera Global camera number

 

Camera backlight compensation mode

Action name: CameraBacklightCompensationMode(PTZ Head, mode)

Category: command

This action changes the backlight compensation of the camera.

Parameter Function
PTZ head Camera Global camera number
mode Mode off=backlight compensation is turned off
on=backlight compensation is turned on

 

Camera clear preset text

Action name: CameraClearPresetText(PTZ Head, position)

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 Global camera number
position Position Number of the camera position for which the previously defined text (by the action “CameraSetPresetText”) has to be cleared.

 

Camera day/night mode

Action name: CameraDayNightMode(PTZ Head, mode)

Category: command

This action changes the day/night mode of the camera.

Parameter Function
PTZ head Camera Global camera number
mode Mode day=day mode is activated
night=night mode is activated
auto=the camera changes automatically between day and night mode

 

Camera light off

Action name: CameraLightOff(PTZ Head)

Category: command

This action turns the camera light off.

Parameter Function
PTZ head Camera Global camera number

 

Camera light on

Action name: CameraLightOn(PTZ Head)

Category: command

This action turns the camera light on.

Parameter Function
PTZ head Camera Global camera number

 

Camera manual iris off

Action name: CameraManualIrisOff(PTZ Head)

Category: command

This action disables the option to adjust the camera iris manually.

Parameter Function
PTZ head Camera Global camera number

 

Camera manual iris on

Action name: CameraManualIrisOn(PTZ Head)

Category: command

This action enables the option to adjust the camera iris manually.

Parameter Function
PTZ head Camera Global camera number

 

Camera off

Action name: CameraOff(PTZ Head)

Category: command

This action turns off the camera.

Parameter Function
PTZ head Camera Global camera number

 

Camera on

Action name: CameraOn(PTZ Head)

Category: command

This action turns on the camera.

Parameter Function
PTZ head Camera Global camera number

 

Camera pump off

Action name: CameraPumpOff(PTZ Head)

Category: command

This action disables the pump of the camera.

Parameter Function
PTZ head Camera Global camera number

 

Camera pump on

Action name: CameraPumpOn(PTZ Head)

Category: command

This action enables the pump of the camera.

Parameter Function
PTZ head Camera Global camera number

 

Camera RAW output

Action name: CameraRAWOutput(PTZ Head, output)

Category: command

This action sends a raw string (parameter output) to the camera.

Parameter Function
PTZ head Camera Global camera number
output Output raw string
The following escape sequences are supported:
\\a, b, f, n, r, t, v => \ a, b, f, n, r, t, v
\\\=> \\
\\‘ => \‘
\“ => \“
\Xhh or \xhh => ASCII-character

 

Camera select char mode

For internal use only

 

Camera set preset text

Action name: CameraSetPresetText(PTZ Head, position)

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 Global camera number
position Position Number of the camera for which the text is defined.

 

Camera spec func U off

Action name: CameraSpecFuncUOff(PTZ Head)

Category: command

Special functions are mapped to this action.

(MBeg functions X, Y, U and V).

Parameter Function
PTZ head Camera Global camera number

 

Camera spec func U on

Action name: CameraSpecFuncUOn(PTZ Head)

Category: command

Special functions are mapped to this action.

(MBeg functions X, Y, U and V).

Parameter Function
PTZ head Camera Global camera number

 

Camera spec func V off

Action name: CameraSpecFuncVOff(PTZ Head)

Category: command

Special functions are mapped to this action.

(MBeg functions X, Y, U and V).

Parameter Function
PTZ head Camera Global camera number

 

Camera spec func V on

Action name: CameraSpecFuncVOn(PTZ Head)

Category: command

Special functions are mapped to this action.

(MBeg functions X, Y, U and V).

Parameter Function
PTZ head Camera Global camera number

 

Camera spec func X off

Action name: CameraSpecFuncXOff(PTZ Head)

Category: command

Special functions are mapped to this action.

(MBeg functions X, Y, U and V).

Parameter Function
PTZ head Camera Global camera number

 

Camera spec func X on

Action name: CameraSpecFuncXOn(PTZ Head)

Category: command

Special functions are mapped to this action.

(MBeg functions X, Y, U and V).

Parameter Function
PTZ head Camera Global camera number

 

Camera spec func Y off

Action name: CameraSpecFuncYOff(PTZ Head)

Category: command

Special functions are mapped to this action.

(MBeg functions X, Y, U and V).

Parameter Function
PTZ head Camera Global camera number

 

Camera spec func Y on

Action name: CameraSpecFuncYOn(PTZ Head)

Category: command

Special functions are mapped to this action.

(MBeg functions X, Y, U and V).

Parameter Function
PTZ head Camera Global camera number

 

Camera stop all

Action name: CameraStopAll(PTZ Head)

Category: command

This action stops all movements of the camera.

Parameter Function
PTZ head Camera Global camera number

 

Camera text off

Action name: CameraTextOff(PTZ Head)

Category: command

This action turns off the text display of the camera.

Parameter Function
PTZ head Camera Global camera number

 

Camera text on

Action name: CameraTextOn(PTZ Head)

Category: command

This action turns on the text display of the camera.

Parameter Function
PTZ head Camera Global camera number

 

Camera tour start

Action name: CameraTourStart(PTZ Head, tour ID, tour name)

Category: command

This action starts a pre-defined tour.

Parameter Function
PTZ head Camera Global camera number
tour id TourID Tour id.
tour name TourName Tour name.

 

Camera tour stop

Action name: CameraTourStop(PTZ Head)

Category: command

This action stops a running tour.

Parameter Function
PTZ head Camera Global camera number

 

Camera version off

Action name: CameraVersionOff(PTZ Head)

Category: command

With this action the firmware version of the camera will be hidden.

Parameter Function
PTZ head Camera Global camera number

 

Camera version on

Action name: CameraVersionOn(PTZ Head)

Category: command

With this action the firmware version of the camera will be shown as OSD.

Parameter Function
PTZ head Camera Global camera number

 

Camera wash-wipe off

Action name: CameraWashOff(PTZ Head)

Category: command

This action disables the functions “wash” and “wipe”.

Parameter Function
PTZ head Camera Global camera number

 

Camera wash-wipe on

CameraWashWhipeOn

Action name: CameraWashOn(PTZ Head)

Category: command

This action enables the functions “wash” and “wipe”.

Parameter Function
PTZ head Camera Global camera number

 

Move to default position

Action name:DefaultPosCallUp(Camera)

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 Global camera number

 

Clear default position

Action name: ClearDefaultPosition(PTZ Head)

Category: command

This action deletes the currently defined default position.

Parameter Function
PTZ head Camera Global camera number

 

Clear preset position

Action name: CameraPresetPosition(PTZ Head, position)

Category: command

This action deletes a position previously saved by the action “SavePresetPosition”.

Parameter Function
PTZ head Camera Global camera number
position   Number of camera position to be deleted.

 

Save default position

Action name: SaveDefaultPosition(PTZ Head)

Category: command

This action saves the current position of the camera as default position.

Parameter Function
PTZ head Camera Global camera number

 

Fast speed off

Action name: FastSpeedOff(PTZ Head)

Category: command

This action switches from high-speed of the camera to normal speed of the camera.

Parameter Function
PTZ head Camera Global camera number

 

Fast speed on

Action name: FastSpeedOn(PTZ Head)

Category: command

This action switches from normal speed of the camera to high-speed of the camera.

Parameter Function
PTZ head Camera Global camera number

 

Focus far

Action name:FocusFar(Camera, Speed)

Action category: command

The camera focus adjusts on far.

Parameter Function
PTZ head Camera Global camera number
speed Speed Depending on the protocol of camera manufacturer velocities between 1 and 255 are being adjusted to the velocity range of the camera.

 

Focus near

Action name:FocusNear(Camera, Speed)

Action category: command

The camera focus adjusts on near.

Parameter Function
PTZ head Camera Global camera number
speed Speed Depending on the protocol of camera manufacturer velocities between 1 and 255 are being adjusted to the velocity range of the camera.

 

Focus stop

Action name:FocusStop(Camera)

Action category: command

The camera stops the focusing process.

Parameter Function
PTZ head Camera Global camera number

 

Iris close

Action name:IrisClose(Camera)

Action category: command

The camera closes the aperture.

Parameter Function
PTZ head Camera The camera closes the aperture

 

Iris open

Action name:IrisOpen(Camera)

Action category: command

The camera opens the aperture.

Parameter Function
PTZ head Camera The camera opens the aperture

 

Iris stop

Action name:IrisStop(Camera)

Action category: command

The camera stops closing/opening aperture.

Parameter Function
PTZ head Camera The camera stops closing/opening aperture

 

Move to absolute position

For internal use only

Move to by speed

For internal use only

Move to relative position

For internal use only

Pan auto

Action name:PanAuto(Camera, 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 Global camera number
modus Modus Depends on camera type (model and manufacturer)

 

Pan left

Action name:PanLeft(Camera, Speed)

Action category: command

The camera pans to the left.

Parameter Function
PTZ head Camera Global camera number
modus Speed Depending on the protocol of camera manufacturer velocities between 1 and 255 are being adjusted to the velocity range of the camera.

 

Pan right

Action name:PanRight(Camera, Speed)

Action category: command

The camera pans to the right.

Parameter Function
PTZ head Camera Global camera number
modus Speed Pan speed.

 

Pan stop

Action name:PanStop(Camera)

Action category: command

The camera stops pan movement.

Parameter Function
PTZ head Camera Global camera number

 

Move to preset position

Action name:PrePosCallUp(Camera, Position)

Action category: command

The camera moves to a preset position determined in advance through the action "SavePresetPosition".

Parameter Function
PTZ head Camera Global camera number
position Position Number of selected preset position.
The amount of positions to save depends on the camera type (model and manufacturer).

 

Clear preset position

Action name:PrePosClear(Camera, Position)

Action category: command

Clear camera preset position.

Parameter Function
PTZ head Camera Global camera number
position Position Preset position.

 

Save preset position

Action name:PrePosSave(Camera, Position)

Action category: command

Saves current position of the PTZ camera as a preset position.

Parameter Function
PTZ head Camera Global camera number
position Position Number of preset position on which the current position of the camera should be saved.
The amount of positions to save depends on the camera type (model and manufacturer).

 

Set camera text

Action name: SaveCameraText(PTZ Head, text)

Category: command

This action saves the camera description in accordance with the parameter “text”.

Parameter Function
PTZ head Camera Global camera number
text Text Text to be displayed on the camera as OSD.

 

Tilt down

Action name:TiltDown(Camera, Speed)

Action category: command

The camera tilts down.

Parameter Function
PTZ head Camera Global camera number
speed Speed Depending on the protocol of camera manufacturer velocities between 1 and 255 are being adjusted to the velocity range of the camera.

 

Tilt stop

Action name:TiltStop(Camera)

Action category: command

The camera stops the tilt movement.

Parameter Function
PTZ head Camera Global camera number

 

Tilt up

Action name:TiltUp(Camera, Speed)

Action category: command

The camera tilts up.

Parameter Function
PTZ head Camera Global camera number
speed Speed Depending on the protocol of camera manufacturer velocities between 1 and 255 are being adjusted to the velocity range of the camera.

 

Zoom in

Action name:ZoomIn(Camera, Speed)

Action category: command

The Camera zooms in (tele range).

Parameter Function
PTZ head Camera Global camera number
speed Speed Depending on the protocol of camera manufacturer velocities between 1 and 255 are being adjusted to the velocity range of the camera.

 

Zoom out

Action name:ZoomOut(Camera, Speed)

Action category: command

The camera zooms out (wide-angle range).

Parameter Function
PTZ head Camera Global camera number
speed Speed Depending on the protocol of camera manufacturer velocities between 1 and 255 are being adjusted to the velocity range of the camera.

 

Zoom stop

Action name:ZoomStop(Camera)

Action category: command

The camera stops zooming process.

Parameter Function
PTZ head Camera Global camera number