Versions Compared

Old Version 7

changes.mady.by.user Sofya Uyutova

Saved on

compared with

New Version Current

changes.mady.by.user Roman Nazarov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Section
Column
width50%
Panel
borderColor#CCCCCC
bgColor#FFFFFF
titleBGColor#F0F0F0
borderStylesolid
titleIn the section:
Table of Contents
Column Note
titleImportant!

Disable the Use device settings checkbox in order to change the manage parameters by the below commands – see The Settings panel of the Video Capture Device capture device object.

A camera must support the same commands for features management as the given ECHD commands (both when connected via ONVIF and via the corresponding driver).

Discrete motion

General request format:

GET https://example.com:[port]IP-address:port/?cameraID={1}&ip={2}&loqin={3}&pass={4}&action={5}&x={6}&y={7}&z={8}&modelName={9}

Atomic shift of video surveillance device in the specified direction. 

Request parameters:

...

ParameterIs requiredDescription
1Yes
ID of video surveillance device.
2No

...

IP addressof video surveillance device.
3No

...

account of video surveillance device.
4No

...

access password to video surveillance device.

action - command name [degreesmove].

x - PAN rotation [-180 ..0.. 180].

y - TILt rotation [-180 ..0.. 180].

z - zoom in/out [0.. 100].

5Yes

Command name:

degreesmove – discrete motion. Atomic shift

...

of video surveillance device in the specified direction. 

Relative motion

...

degreesmove2 – relative motion. 

Rotation of video surveillance device compared with current position. Viewing area of video surveillance device is divided by a grid where central point’s coordinates are (x:0, y:0), top left (x:-7, y:7), bottom right (x:7, y:-7). Video surveillance device must be rotated in a way that object appears in the center of the grid.

‘Optical’ error caused by the distance to the visible object is allowed.

Error caused by sphere-to-plane projection must be compensated.

cameraID - ID of video surveillance device.

...

login - account of video surveillance device.

pass - access password to video surveillance device.

...

Depending on camera, registry keys may have to be set for correct operation:

  1. Thecamera does not support Point&Click but supports absolute PTZ. Set the ReplacePointAndClick registry key to 1 (see Registry keys reference guide)

...

  1. .
  2. Thecamera supports Point&Click. Set the ReplacePointAndClick registry key to 0 and TelemetryCommandMoveTimeout to delay in milliseconds between panning/tilting and zooming (see Registry keys reference guide).

setposition – setting

x - PAN rotation [-7..0..7].

y - tilt rotation [-7..0..7].

Z – deprecated parameter. The value is ignored; may be excluded from the request.

modelName - model of video surveillance device.

Setting position of video surveillance device

https://example.com:[port]/?cameralD={1}&ip={2}&login={3}&pass={4}&action={5}&x={6}&y={7}&z={8}&modelName={9}

...

position of video surveillance device in degrees compared with ‘0’ position.

cameraID - ID of video surveillance device.

...

login - account of video surveillance device.

pass - access password to video surveillance device.

action - command name (setposition).

x - PAN setting [-180 ..0.. 180].

y - TILt setting [-180 ..0..180].

Z – zoom value [0.. 100].

modelName - model of video surveillance device.

Getting position of video surveillance device

https://example.com:[port]/?cameralD={1}&ip={2}&login={3}&pass={4}&action={5}&modelName={6}

...

{"y":56, "x":105, "z":0}

cameraID - ID of video surveillance device.

...

login - account of video surveillance device.

pass - access password to video surveillance device.

action - command name (getposition).

modelNate - model of video surveillance device.

Focusing

https://example.com:[port]/?cameralD={1}&ip={2}&login={3}&pass={4}&action={5}&x={6}&y={7}&z={8}&modelName={9}

...

getposition – getting position of video surveillance device inpAN and TILt in degrees as well as current zoom values.

...

focus – video surveillance device’s focus control command where z parameter controls over focus:

1: Focus in

-1 : Focus out

0: Auto

cameralD - ID of video surveillance device.

...

login - account of video surveillance device.

pass - access password to video surveillance device.

action - command name (focus).

...

z – focus control [-1..0..1].

modelNate - model of video surveillance device.

...

https://example.com:[port]/?cameralD={1}&ip={2}&login={3}&pass={4}&action={5}&x={6}&y={7}&z={8}&modelName={9}

...

iris – video surveillance device’s iris control command where z parameter controls over iris:

1: Open iris

-1: Close iris

0: Auto

cameralD - ID of video surveillance device.

...

login - account of video surveillance device.

pass - access password to video surveillance device.

action - command name (iris).

...

switch_day_night – switch day/night mode where z parameter enables one of the following modes:

1: Day mode

-1 : Night mode

backlight – switch backlight on/off where z parameter controls over the mode:

1: Enable

-1: Disable

switch_color – the

modelNate - model of video surveillance device.

...

https://example.com:[port]/?cameralD={1}&ip={2}&login={3}&pass={4}&action={5}&x={6}&y={7}&z={8}&modelName={9}

...

following operation modes of video surveillance device are

...

set by z parameter:

1:

...

Enable

-1:

...

cameraID – ID of video surveillance device.

...

login - account of video surveillance device.

pass – access password to video surveillance device.

action – command name (switch_day_night).

...

z – mode control [-1..0..1].

modelNate - model of video surveillance device.

Backlight

https://example.com:[port]/?cameralD={1}&ip={2}&login={3}&pass={4}&action={5}&x={6}&y={7}&z={8}&modelName={9}

The following backlight operation modes are available:

1: Enable

-1: Disable

cameraID - ID of video surveillance device.

...

login - account of video surveillance device.

pass - access password to video surveillance device.

action - command name (backlight).

...

z - mode control[-1..0..1].

modelNate - model of video surveillance device.

...

Disable

6No

In degreesmove, setposition commands: PAN rotation [-180 ..0.. 180].

In degreesmove2: PAN rotation [-7..0..7].

In getposition: not in use.

In commands focus, iris, switch_day_night, backlight, switch_color: set value 0 to the parameter.

7No

In degreesmove, setposition commands: TILT rotation [-180 ..0.. 180].

In degreesmove2: TILT rotation [-7..0..7].

In getposition: not in use.

In commands focus, iris, switch_day_night, backlight, switch_color: set value 0 to the parameter.

8No

In degreesmove, degreesmove2, setposition commands: zoom in/out [0.. 100].

In getposition: not in use.

In commands focus, iris, switch_day_night, backlight, switch_color: set device mode, see description of the corresponding command above.

9NoModel of video surveillance device.

Request example:

GET http://127.0.0.1:80/execute?cameraID=7&action=getposition

Response example:

Response comes on getposition command only. Example inJSON format:

{"y":56, "x":105, "z":0}

Response parameters:

ParameterDescription
xPAN coordinate
yTILT coordinate
zZoom value

https://example.com:[port]/?cameralD={1}&ip={2}&login={3}&pass={4}&action={5}&x={6}&y={7}&z={8}&modelName={9}

The following operation modes of video surveillance device are available:

1: Enable

-1: Disable

cameraID - ID of video surveillance device.

...

login - account of video surveillance device.

pass - access password to video surveillance device.

action - command name (switch_color).

...

z - mode control[-1..0..1].

...