Pan/tilt/zoom API

Each functionality (for example pan) uses Support parameters (see ) to check if the functionality is supported, uses Various parameters (see ) to check if functionality is enabled and to disable functionality, and use CGIs (see ) to control the functionality.

There are two types of PTZ, mechanical PTZ and digital PTZ. Mechanical PTZ is driven by motors. The motors could either be integrated in the Axis product or the Axis product could be mounted on a external mechanical PT (PanTilt) device. It could also be an external PTZ camera connected to an encoder. For Axis products with digital PTZ it is possible to select only a part of the image by zooming in. The zoomed area can then be moved around using pan/tilt commands. Digital PTZ uses the same HTTP API as Axis products with mechanical PTZ, with some limitations.

The PTZ Control API consists of the following CGIs:

Identification

PTZ

PTZ.ImageSource

PTZ.PTZDriverStatuses

PTZ.Support

PTZ.Limit

PTZ.Various

PTZ.UserBasic

PTZ.UserAdv

PTZ.Preset

PTZ.Preset.P.Position

Control the pan, tilt and zoom behavior of a PTZ unit.

The PTZ control is device-dependent. For information about supported parameters and actual parameter values, check the specification of the Axis PTZ driver used. The following table is only an overview.

Access control

Viewer with access to PTZ controls.

Method

GET/POST

http://<servername>/axis-cgi/com/ptz.cgi?<argument>=<value>[<argument>=<value>...]

With the following arguments and values:

1. Product/release dependent. Check the product's release notes.
2. Driver-specific.
3. Products with Panopsis technology: If the product moves to a position where the Panopsis (fisheye) lens is visible, the product will go to Overview mode.
4. Float input will be handled as int. No assumptions can be made on the correct rounding.
5. If Support.S#.DigitalZoom is true, zoom ranges are 1 ... 19999 for zoom and -19999 ... 19999 for rzoom.
6. Products with Panopsis technology: Does not have any effect in Overview mode.
7. This option only affects proportional speed for individual commands and is only supported on mechanical PTZ domes when both Properties.PTZ.DigitalPTZ=no and Properties.PTZ.DriverManagement=no have been chosen ( API-version 1.1).
8. Preset positions are configured using ptzconfig.cgi, see .
9. Character encoding for plain-text responses defined by the PTZ.ResponseEncoding parameter.

Example: Request information about available PTZ commands on video channel 3

http://myserver/axis-cgi/com/ptz.cgi?info=1&camera=3

If PTZ is available the response may look like this:

Available commands
:
{camera=[n]}
whoami=yes
center=[x],[y]
  imagewidth=[n]
  imageheight=[n]
areazoom=[x],[y],[z]
  imagewidth=[n]
  imageheight=[n]
move={ home | up | down | left | right | upleft | upright | downleft | downright | stop }
pan=[abspos]
tilt=[abspos]
zoom=[n]
rpan=[offset]
rtilt=[offset]
rzoom=[offset]
continuouspantiltmove=[x-speed],[y-speed]
  proportionalspeed={ disabled }
continuouszoommove=[speed]
setserverpresetname=[name]
setserverpresetno=[n]
removeserverpresetname=[name]
removeserverpresetno=[n]
gotoserverpresetname=[name]
gotoserverpresetno=[n]
query={ position | limits | presetposcam | presetposall | status }
  format={ json }

Query=attributes response

Attributes for camera [n]
<attribute a>=<array entry1>, <array entry2>,...
<attribute b>=<array entry1>, <array entry2>,...
<attribute c>=<single value>
Attributes for camera [m]
...

<key 1>=<value 1>|<key 2>=<value 2>|...|<key N>=<value N>

Attributes for camera 1
speeds=value=1|speed=0.05,value=9|speed=0.16,value=14|speed=2,value=24|speed=2.1,value=40|speed=9,value=58|speed=28,value=80|speed=74,value=100|speed=150
maxOpticalZoomMag=30

{
  "Camera <n>": {
    "<attribute a>": [<arrary entry 1>, <array entry 2>],
    "<attribute b>": [<arrary entry 1>, <array entry 2>],
    "<attribute c>": "<single value>"
  },
  "Camera <m>": {
    ...
  }
}

{
  "<key 1>": "<value 1>",
  "<key 2>": "<value 2>",
  ...,
  "<key N>": "<value N>"
}

{
  "Camera 1": {
    "maxOpticalZoomMag": "30",
    "zoomSteps": [
      {
        "value": "1",
        "zoom": "1"
      },
      {
        "value": "3868",
        "zoom": "2"
      },
      {
        "value": "7736",
        "zoom": "3"
      },
      {
        "value": "9999",
        "zoom": "3.584961"
      }
    ]
  }
}

Set and configure PTZ preset positions and On screen display (OSD) control.

A server preset saved with name will also get a number and vice versa. You can use both setserverpresetname/removeserverpresetname and setserverpresetno/removeserverpresetno commands on the same preset.

Access control

admin

Method

GET/POST

http://<servername>/axis-cgi/com/ptzconfig.cgi?<argument>=<value>[&<argument>=<value>...]

With the following arguments and values:

1. <preset name> is a string with a maximum of 31 characters. The following five characters are not allowed: "<>~:
2. When a home preset is removed a new default home preset will be created before the request can be answered.

Success for ptz.cgi

Error for ptz.cgi

Error:
[message]

Success for info=1

Available commands
:
{camera=[n]}
whoami=yes
center=[x],[y]
  imagewidth=[n]
  imageheight=[n]
areazoom=[x],[y],[z]
  imagewidth=[n]
  imageheight=[n]
move={ home | up | down | left | right | upleft | upright | downleft |
downright | stop }
pan=[abspos]
tilt=[abspos]
zoom=[n]
focus=[n]
iris=[n]
brightness=[offset]
rpan=[offset]
rtilt=[offset]
rzoom=[offset]
rfocus=[offset]
riris=[offset]
rbrightness=[offset]
autofocus={ on | off }
autoiris={ on | off }
ircutfilter={ on | off | auto }
backlight={ on | off }
continuouspantiltmove=[x-speed],[y-speed]
continuouszoommove=[speed]
continuousfocusmove=[speed]
continuousirismove=[speed]
continuousbrightnessmove=[speed]
auxiliary=[function]
setserverpresetname=[name]
setserverpresetno=[n]
removeserverpresetname=[name]
removeserverpresetno=[n]
gotoserverpresetname=[name]
gotoserverpresetno=[n]
gotodevicepreset=[n]
speed=[n]
osdmenu=[cmd]
query={ speed | position | limits | presetposcam | presetposall }

Success for query=speed

speed=[speed]

Success for query=position

pan=[abspos]
tilt=[abspos]
zoom=[n]
autofocus={ on | off }
autoiris={ on | off }

Success for query=limits

MinPan=[abspos]
MaxPan=[abspos]
MinTilt=[abspos]
MaxTilt=[abspos]
MinZoom=[n]
MaxZoom=[n]
MinIris=[n]
MaxIris=[n]
MinFocus=[n]
MaxFocus=[n]
MinFieldAngle=[n]
MaxFieldAngle=[n]
MinBrightness=[offset]
MaxBrightness=[offset]

Success for query=presetposcam

Preset Positions for camera [n]
presetposno[n]=p[n]
presetposno1=Home

Success for query=presetposall

Preset Positions for camera 1
presetposno[n]=p[n]
presetposno1=Home
 
Preset Positions for camera 2
presetposno[n]=p[n]
presetposno1=Home
...

Error for query=[invalid value]

Error:
query: unknown value: [invalid value]

Success for whoami=1

[Driver name]

Success for ptzconfig.cgi

Error for ptzconfig.cgi

Error:
[message]

Only one external PTZ device driver can be active at any given time. In addition, there can be zero or more static drivers active. The static drivers are always active and controls the internal hardware. Static drivers also operate in parallel with the external PTZ device driver and cannot be listed or manipulated using any Driver Management CGI.

All compatible external PTZ device drivers are included on the AXIS product’s firmware as of API version 1.1. Please note that when using firmware of earlier API versions that some drivers may be included in the AXIS product's firmware, but most drivers must be retrieved from Axis support and uploaded to the camera by the user before they can be activated.

The PTZ driver management API consists of the following CGIs:

For information about serial ports, see .

Identification

Obsoletes

List all PTZ drivers

http://<servername>/axis-cgi/ptz/ptzuploader.cgi?list=yes

<?xml version="1.0"?>
  <driverentry>
    <id>1</id>
    <driver>Pelco</driver>
    <driverversion>4.17</driverversion>
    <installed>
      <ch>3</ch>
      <ch>4</ch>
    </installed>
    <deviceTypes>
      <deviceType>Generic</deviceType>
      <deviceType>DD5-C</deviceType>
      <deviceType>Esprit ES30C/ES31C</deviceType>
      <deviceType>LRD41C21</deviceType>
      <deviceType>LRD41C22</deviceType>
      <deviceType>Spectra III</deviceType>
      <deviceType>Spectra IV</deviceType>
      <deviceType>Spectra Mini</deviceType>
      <deviceType>Videotec DTRX3/PTH310P</deviceType>
      <deviceType>Videotec ULISSE</deviceType>
      <deviceType>PTK AMB</deviceType>
      <deviceType>YP3040</deviceType>
      <deviceType>XP40</deviceType>
    </deviceTypes>
    <deviceIdRange>
      <min>1</min>
      <max>255</max>
    </deviceIdRange>
  </driverentry>
  <driverentry>
    <id>2</id>
    <driver>Visca/EVI</driver>
    <driverversion>4.11</driverversion>
    <installed></installed>
    <deviceTypes>
      <deviceType>EVI-G20/G21</deviceType>
      <deviceType>EVI-D30/D31</deviceType>
      <deviceType>EVI-D100/D100P</deviceType>
      <deviceType>EVI-D70/D70P</deviceType>
      <deviceType>EVI-D70F/D70PF</deviceType>
      <deviceType>DCP-27</deviceType>
    </deviceTypes>
    <deviceIdRange>
      <min>1</min>
      <max>7</max>
    </deviceIdRange>
  </driverentry>
  <driverentry>
    <id>3</id>
    <driver>ARTP</driver>
    <driverversion>1.1.0</driverversion>
    <installed></installed>
  </driverentry>
  ...
</root>

http://<servername>/axis-cgi/ptz/ptzuploader.cgi?list=yes&status=yes

<?xml version="1.0"?>
  <driverentry>
    <id>1</id>
    <driver>Pelco</driver>
    <driverversion>4.17</driverversion>
    <installed>
      <ch>1</ch>
    </installed>
    <deviceTypes>
      <deviceType>Generic</deviceType>
      <deviceType>DD5-C</deviceType>
      <deviceType>Esprit ES30C/ES31C</deviceType>
      <deviceType>LRD41C21</deviceType>
      <deviceType>LRD41C22</deviceType>
      <deviceType>Spectra III</deviceType>
      <deviceType>Spectra IV</deviceType>
      <deviceType>Spectra Mini</deviceType>
      <deviceType>Videotec DTRX3/PTH310P</deviceType>
      <deviceType>Videotec ULISSE</deviceType>
      <deviceType>PTK AMB</deviceType>
      <deviceType>YP3040</deviceType>
      <deviceType>XP40</deviceType>
    </deviceTypes>
    <deviceIdRange>
      <min>1</min>
      <max>255</max>
    </deviceIdRange>
  </driverentry>
  ...
  <status>
    <channel id="1">
      <activeDriver>
        <driverStatus>2</driverStatus>
        <driverId>1</driverId>
        <driverDeviceType>Generic</driverDeviceType>
        <driverDeviceId>1</driverDeviceId>
      </activeDriver>
    </channel>
    <channel id="2"></channel>
    <channel id="3"></channel>
    <channel id="4"></channel>
  <status>
</root>

HTTP/1.1 200 OK

HTTP/1.1 409

HTTP/1.1 400

Install a PTZ driver

http://<servername>/axis-cgi/ptz/ptzupgrader.cgi?driverid=2

http://<servername>/axis-cgi/ptz/ptzupgrader.cgi?driverid=2&channel=1

http://<servername>/axis-cgi/ptz/ptzupgrader.cgi?driverid=2&channel=1&deviceType=Generic&deviceId=1

HTTP/1.1 200 OK

HTTP/1.1 400

HTTP/1.1 409

HTTP/1.1 500

HTTP/1.1 501

Change device type or device ID settings

http://<servername>/axis-cgi/ptz/ptzupgrader.cgi?driverId=1&channel=1&deviceId=2

http://<servername>/axis-cgi/ptz/ptzupgrader.cgi?driverId=1&channel=1&deviceType=Spectra%20IV

Uninstall a PTZ driver

http://<servername>/axis-cgi/ptz/ptzupgrader.cgi?driverid=0&channel=1

HTTP/1.1 200 OK

HTTP/1.1 500

HTTP/1.1 409

HTTP/1.1 400

Check if a PTZ driver is active

http://<servername>/axis-cgi/ptz/ptzuploader.cgi?status=yes

<?xml version="1.0"?>
<root>
  <status>
    <channel id="1">
      <activeDriver>
        <driverStatus>2</driverStatus>
        <driverId>1</driverId>
        <driverDeviceType>Generic</driverDeviceType>
        <driverDeviceId>1</driverDeviceId>
      </activeDriver>
    </channel>
    <channel id="2"></channel>
    <channel id="3"></channel>
    <channel id="4"></channel>
  <status>
</root>

HTTP/1.1 200 OK

HTTP/1.1 409

HTTP/1.1 400

List PTZ drivers

http://<servername>/axis-cgi/ptz/ptzuploader.cgi?<argument>=<value>[<argument>=<value>]

<?xml version=1.0"?>
<root>
  <driverentry>
    <id>driverid</id>
    <driver>drivername</driver>
    <driverversion>driverversion</driverversion>
    <installed>
      <ch>1</ch>
      <ch>2</ch>
      ...
      <ch>n</ch>
    </installed>
    <deviceTypes>
      <deviceType>deviceType_1</deviceType>
      ...
      <deviceType>deviceType_N</deviceType>
    </deviceTypes>
    <deviceId>
      <min>min_device_id</min>
      <max>max_device_id</max>
    </deviceId>
  </driverentry>
  ...
</root>

Install and unistall PTZ driver

http://<servername>/axis-cgi/ptz/ptzupgrader.cgi?<argument>=<value>[&<argument>=<value>...]

<?xml version="1.0"?>
<root>
  <status>
    <channel id="1">
      <activeDriver>
        <driverStatus>driverstatus</driverStatus>
        <driverId>driverid</driverId>
        <driverDeviceType>devicetype</driverDeviceType>
        <driverDeviceId>deviceid<driverDeviceId>
      </activeDriver>
    </channel>
    ...
    <channel id="n"></channel>
  </status>
</root>

Driver management parameters

PTZ.PTZDriverStatuses.Driver[video_channel]Status

The control queue is used to administrate the PTZ control in an environment where several users have PTZ control. A control blocking function lets one user at the time have PTZ control. The other users are put in the control queue. Once a user gained PTZ control PTZ requests can be sent as usual. The rules of the queue are based on what type of access control the user has. For example a user with admin access control will be prioritized over a user with viewer access control. To distinguish individuals using the same user account a cookie is sent the first time the user sends a PTZ request.

Identification

PTZ.Various

1. Integer ranges may be overridden by configuration file for driver.

PTZ.UserCtlQueue.U#

Parameters for the different users in the control queue. These parameters only have effect if the control queue is enabled (PTZ.Various.V#.CtlQueuing=true). In that case, cookies will be required for all calls to ptz.cgi.

1. The # is replaced with a group number starting from 0, for example PTZ.UserCtlQueue.U5.UserGroup.

This CGI handles requests concerning the control queue. If the PTZ control queuing mechanism is enabled (PTZ.Various.V1.CtlQueueing=true) for a video channel, control of PTZ units is limited to the client currently possessing it.

Cookies are enabled by default when enabling PTZ control queue.

Access control

viewer with access to PTZ controls

Method

GET/POST

http://<servername>/axis-cgi/com/ptzqueue.cgi?<argument>=<value>[&<argument>=<value>...]

With the following arguments and values:

1. Product-dependent. Check the product's Release notes.

http://myserver/axis-cgi/com/ptzqueue.cgi?control=request&camera=2

PTZ control queue response

The 200 OK response on success for request and query has a format that enables simple JavaScript parsing.

Success

HTTP code

200 OK

<a name="<pos>"</a><a name="<seconds>"</a><a name="<period>"></a>

• <pos> can have a value from 0 to the maximum value of how many clients are allowed in the queue. This value is the given position in the queue. 0 means that the client is not in the queue, 1 means control is possessed. If the value is 0 the other values are undefined.

• <seconds> is the estimated number of seconds remaining, that is for position 1 the remaining control time and for other positions, the time until position 1 is reached. If the value is -1 the time remaining to get control cannot be estimated. This means that a client in the queue has the TimeoutType set to infinity.

• <period> is the recommended time in seconds when the client should send a new control=query requests. To stay active in the queue the client must regularly send the request control=query to the Axis product. An inactive client will automatically be removed from the queue.

<a name="3"></a><a name="410"></a><a name="5"></a>

Failure

On failure no anchor elements are provided but simply the error message in plain text.

HTTP code

200 OK

Content-type

text/plain

Error:
<error information>

The VAPIX® Focus recall API gives instant focus even in challenging light conditions when used for management of camera settings in PTZ zones. Focus recall uses memory zones which consist of a pan, tilt and/or zoom range where the specified camera settings should be applied. Zones can be added, listed and removed. Each zone is identified by a unique index. The settings in a zone is applied when the center coordinate of the camera is inside the PTZ area that is defined by the zone.

Identification

Use memoryzones/add.cgi to add a memory zone.

Request

Access control

admin, operator, viewer with PTZ control

Method

GET

http://<servername>/axis-cgi/memoryzones/add.cgi?<argument>=<value>

with the following arguments and values:

Response

Responses from memoryzones/add.cgi

Success

HTTP code: 200 OK
Content-Type: application/json

{"name" : "name",  "index" : index}

HTTP Code: GeneralSuccess response is returned. See .

Error

HTTP code: 200 OK
Content-Type: application/json

{"error": { "id":<error code>, "message":"<optional error message in English>" }}

HTTP Code: GeneralError response is returned. See .

Use memoryzones/remove.cgi to delete a memory zone.

Request

Access control

admin, operator, viewer with PTZ control

Method

GET

http://<servername>/axis-cgi/memoryzones/remove.cgi?<argument>=<value>

with the following arguments and values:

Response

Responses from memoryzones/remove.cgi

Success

HTTP code: 200 OK
Content-Type: application/json

Empty

HTTP code: GeneralSuccess response is returned. See .

Error

HTTP code: 200 OK
Content-Type: application/json

{"error": { "id":<error code>, "message":"<optional error message in English>"}}

HTTP code: GeneralErrorresponse is returned. See .

Use memoryzones/list.cgi to list the memory zones.

Request

Access control

admin, operator, viewer with PTZ control

Method

GET

http://<servername>/axis-cgi/memoryzones/list.cgi?<argument>=<data>[&<argument>=<data>[&...]]

with the following arguments and values:

Response

Responses from memoryzones/list.cgi

Success

HTTP code: 200 OK
Content-Type: application/json

Response for query=list if at least one zone has been added:

[{ "name" : "name", "index" : index, "ptpolygon" : "0.0,0.0:0.0,0.0:0.0,0.0:0.0,0.0", "zoomrange" : "0:0", "focus" : position},...]

Response for query=list if there are no zones:

[]

Response for query=current if there is a zone at the current coordinates:

{ "name" : "name", "index" : index }

Response for query=current if there is no zone at the current coordinates:

{"name" : "", "index" : -1}

Response for query=view if there is one or more zone within the current view:

[{ "name" : "name", "index" : index, "polygon" : "0,0:0,0:0,0:0,0", "ptpolygon" : "0.0,0.0:0.0,0.0:0.0,0.0:0.0,0.0", "zoomrange" : "0:0", "focus" : position}, ...]

Response for query=view if there are no zones in the current view:

[]

HTTP code: GeneralSuccess response is returned. See .

Error

HTTP code: 200 OK
Content-Type: application/json

{ "error": { "id":<error code>, "message":"<optional error message in English>" }}

HTTP code: GeneralError response is returned. See .

Use memoryzones/goto.cgi to go to and focus on memory zone coordinates.

Request

Access control

admin, operator, viewer with PTZ control

Method

GET

http://<servername>/axis-cgi/memoryzones/goto.cgi?<argument>=<data>[&<argument>=<data>[&...]]

with the following arguments and values:

Response

Responses from memoryzones/goto.cgi

Success

HTTP code: 204 OK
Content-Type: application/json

Empty

HTTP code: GeneralSuccess response is returned. See .

Error

HTTP code: 200 OK
Content-Type: application/json

{ "error": { "id":<error code>, "message":"<optional error message in English>" }}

HTTP code: GeneralError response is returned. See .

General success response from Focus recall API.

HTTP code

: 200 OK

Content-type

: application/json

{
  "name" : "name",
  "index" : index
}

General error response from Focus recall API.

HTTP code

: 200 OK

Content-type

: application/json

<?xml version="1.0" encoding="utf-8"?>
<memoryzonesResponse SchemaVersion="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/memoryzones.xsd">
  <GeneralError>
    <ErrorCode>[error code]</ErrorCode>
    <ErrorDescription>[description]</ErrorDescription>
  </GeneralError>
</memoryzonesResponse>

Supported elements, attributes and values:

The PTZ preset reached event is true when the camera stops at a preset position. Preset positions are defined for each video channel or view area. There is one event for each preset position. The Any event is true if the camera stops at any of the preset positions defined on that channel or view area.

Note that Nice name can be changed.

Topic

Name

tns1:PTZController/tnsaxis:PTZPresets/tnsaxis:Channel_X

Type

Stateful

Nice name

PTZ preset reached on channel X

Source instance

Nice name

Preset token

Type

integer

Name

PresetToken

Data instance

Nice name

Preset reached

Type

boolean

Name

on_preset

isPropertyState

true

The PTZ movement event is true when the camera is moving due to a PTZ operation.

The event can for example be used to prevent motion detection from being triggered while the camera moves due to a PTZ operation.

Topic

Name

tns1:PTZController/tnsaxis:Move/tnsaxis:Channel_X

Type

Stateful

Nice name

PTZ movement on channel X

Source instance

Nice name

PTZ channel

Type

integer

Name

PTZConfigurationToken

Data instance

Nice name

Moving

Type

boolean

Name

is_moving

isPropertyState

true

The PTZ ready event is true when the PTZ functionality is ready to be used. The event can for example be used to detect that PTZ is ready to use after restart or after a PTZ driver has been installed.

For products with multiple view areas or multiple video channels, there is one event for each view area or video channel. The channel element in SourceInstance specifies the view area or video channel.

Topic

Name

tns1:PTZController/tnsaxis:PTZReady

Type

Stateful

Nice name

PTZ ready

Source instance

Nice name

Channel

Type

integer

Name

channel

Data instance

Nice name

Ready

Type

boolean

Name

ready

isPropertyState

true

The PTZ control queue event shows the user who is controlling the PTZ functionality.

Topic

Name

tns1:PTZController/tnsaxis:ControlQueue

Type

Stateful

Nice name

PTZ control queue

Source instance

Nice name

PTZ channel

Type

integer

Name

PTZConfigurationToken

Data instance

Nice name

Queue owner

Type

string

Name

queue_owner

isPropertyState

true

These events have been deprecated as of firmware version 10.12 and will no longer receive updates. The methods found in should be used instead.

The Autotracking event is true when autotracking is active.

Topic

Name

tns1:PTZController/tnsaxis:AutoTracking

Type

Stateful

Nice name

Autotracking

Source instance

Nice name

Channel

Type

integer

Name

channel

The table below is valid for multichannel products. For single channel products, the channel is always 0.

Data instance

Nice name

Tracking motion

Type

boolean

Name

tracking

isPropertyState

true

A PTZ error event tns1:PTZController/tnsaxis:PTZError is emitted if the PTZ functionality is malfunctioning.

To retrieve the event declaration, use aev:GetEventInstances.

<tns1:PTZController aev:NiceName="PTZController">
  <tnsaxis:PTZError wstop:topic="true" aev:NiceName="PTZ error">
    <aev:MessageInstance>
      <aev:SourceInstance>
        <aev:SimpleItemInstance aev:NiceName="Channel" Type="xsd:int" Name="channel">
        </aev:SimpleItemInstance>
      </aev:SourceInstance>
      <aev:DataInstance>
        <aev:SimpleItemInstance Type="xsd:string" Name="ptz_error">
        </aev:SimpleItemInstance>
      </aev:DataInstance>
    </aev:MessageInstance>
  </tnsaxis:PTZError>
</tns1:PTZController>

Use the Go to PTZ preset action to steer the camera view to a PTZ preset position. When the action is completed, the camera view will return to the home position.

This action can be run as:

• fixed action — stay at the preset position for a predefined time (defined by parameter home_timeout)

• unlimited action — stay at the preset position as long as all event conditions are fulfilled.

Action ID

com.axis.action.fixed.goto.preset

Action ID

com.axis.action.unlimited.goto.preset

These actions have been deprecated as of firmware version 10.12 and will no longer receive updates. The methods found in should be used instead.

Use the autotracking action to start autotracking from a preset position. When the action is triggered, the camera moves to the preset position preset_name and starts autotracking from that position.

The action can be run as

The action can be run as

• fixed action — continue autotracking until there are no moving objects

• unlimited action — continue autotracking as long as all conditions are fulfilled

Action ID

com.axis.action.fixed.motiontracking

Action ID

com.axis.action.unlimited.motiontracking

The VAPIX® Speed dry API function enables the camera to shake so that water moves over the dome enabling the water to dry faster, thus clearing the camera’s view faster. Water drops from rain or washing equipment may prevent a clear camera view.

Identification

Use ptz.cgi\auxiliary=speeddry executes a one-shot speed dry operation. After the operation has finished the server has an idle time of ~20 seconds, during which other speed dry requests are discarded.

Request

Access control

admin, operator, viewer with PTZ control

Method

GET

http://<servername>/axis-cgi/com/ptz.cgi?auxiliary=speeddry

Response

Responses from ptz.cgi?auxiliary=speeddry

General success response from the Speed dry API.

HTTP code

: 200 OK

Content-type

: application/json

HTTP code

: 204 No content

Content-type

: N/A

General error response from the Speed dry API.

HTTP code

: 200 OK

Content-type

: application/json

HTTP code

: 204 No content

Content-type

: N/A

<?xml version="1.0" encoding="utf-8"?>
<speeddryResponse SchemaVersion="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.axis.com/vapix/http_cgi/speeddry.xsd">
  <GeneralError>
    <ErrorCode>[error code]</ErrorCode>
    <ErrorDescription>[description]</ErrorDescription>
  </GeneralError>
</speeddryResponse>

Supported elements, attributes and values: