VAPIX® version 3

Capture Mode
This document is copyright protected and is the property of Axis Communications AB and may not be copied, reproduced or
distributed in any way without the prior written consent of Axis Communications AB.

Copyright Notice
This document is copyright protected and is the property of Axis Communications AB and
may not be copied, reproduced or distributed in any way without the prior written
consent of Axis Communications AB.
©2009 Axis Communications AB. AXIS COMMUNICATIONS, AXIS, ETRAX, ARTPEC and
VAPIX are registered trademarks or trademark applications of Axis AB in various
jurisdictions. All other company names and products are trademarks or registered
trademarks of their respective companies. We reserve the right to introduce modifications
without notice.
Terms of Use
The use of the AXIS VAPIX application programming interface (hereinafter referred to as
"the INTERFACE" as further specified below, is subject to the terms and conditions of the
License Agreement below. By using the INTERFACE and the written specification of the
INTERFACE (hereinafter referred to as “the INTERFACE DESCRIPTION"), whether in whole
or in part, you agree to be bound by the terms of the License Agreement.

VAPIX LICENSE AGREEMENT

This is a legal agreement (the “License Agreement”) between you (either individual or an
entity) and Axis Communications AB (hereinafter referred to as “Axis”).
1. GRANT OF LICENSE

Axis hereby grants to you the right to use the INTERFACE and the INTERFACE
DESCRIPTION for the sole and limited purpose of creating, manufacturing and
developing a solution that integrates any unit or portion included in the product range
of Axis network cameras, Axis video servers, Axis video encoders and Axis video
decoders (as defined by Axis at its discretion) and to market, sell and distribute any
such solution.
2. COPYRIGHT

The INTERFACE and the INTERFACE DESCRIPTION are owned by Axis and are
protected by copyright laws and international treaty provisions. Any use of the
INTERFACE and/or the INTERFACE DESCRIPTION outside the limited purpose set forth
in Section 1 above is strictly prohibited.
3. NO REVERSE ENGINEERING

You may not reverse engineer, decompile, or disassemble the INTERFACE except to
the extent required to obtain interoperability with other independently created
computer programs as permitted by mandatory law.
4. TERMINATION

This License is effective until terminated. Your rights under this License will terminate
automatically without notice from Axis if you fail to comply with any term(s) of this
License. Upon the termination of this License, you shall cease all use and disposition of
VAPIX® Capture Mode 2
This document is copyright protected and is the property of Axis Communications AB and may not be copied, reproduced or
distributed in any way without the prior written consent of Axis Communications AB.

the INTERFACE and/or THE INTERFACE DESCRIPTION whether for the purpose set
forth in Section 1 above or not.
5. GOVERNING LAW

This agreement shall be deemed performed in and shall be construed by the laws of
Sweden. All disputes in connection with this agreement shall be finally settled by
arbitration in accordance with the Rules of the Arbitration Institute of the Stockholm
Chamber of Commerce. The place of arbitration shall be Malmö, Sweden. The
language of the proceedings, documentation and the award shall be English
6. DISCLAIMER
6.1. THE INTERFACE AND THE INTERFACE DESCRIPTION ARE DELIVERED FREE OF
CHARGE AND “AS IS” WITHOUT WARRANTY OF ANY KIND. THE ENTIRE RISK AS
TO THE USE, RESULTS AND PERFORMANCE OF THE INTERFACE AND THE
INTERFACE DESCRIPTION IS ASSUMED BY THE USER/YOU. AXIS DISCLAIMS
ALL WARRANTIES, WHETHER EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, TITLE, NON-INFRINGEMENT AND PRODUCT LIABILITY,
OR ANY WARRANTY ARISING OUT OF ANY PROPOSAL, SPECIFICATION OR
SAMPLE WITH RESPECT TO THE INTERFACE AND THE INTERFACE
DESCRIPTION.
6.2. YOU ARE YOURSELF RESPONSIBLE FOR EXAMINING WHETHER THE INTERFACE
AND THE INTERFACE DESCRIPTION ARE ENCUMBERED BY OR INFRINGES UPON
A RIGHT HELD BY A THIRD PARTY. AXIS, WHO HAS NOT UNDERTAKEN ANY
SUCH INVESTIGATIONS, HAS NO KNOWLEDGE OF NOR DOES AXIS ACCEPT
ANY LIABILITY FOR ANY SUCH ENCUMBRANCES OR INFRINGEMENTS.
6.3. YOU UNDERTAKE NOT TO PURSUE ANY CLAIMS WHATSOEVER AGAINST AXIS
OR ITS AFFILIATES RELATING TO OR EMANATING FROM THE INTERFACE AND
THE INTERFACE DESCRIPTION.
6.4. AXIS SHALL NOT BE LIABLE FOR LOSS OF DATA, LOSS OF PRODUCTION, LOSS
OF PROFIT, LOSS OF USE, LOSS OF CONTRACTS OR FOR ANY OTHER
CONSEQUENTIAL, ECONOMIC OR INDIRECT LOSS WHATSOEVER IN RESPECT
OF USE OR DISPOSITION OF THE INTERFACE AND THE INTERFACE
DESCRIPTION.
6.5. AXIS TOTAL LIABILITY FOR ALL CLAIMS IN ACCORDANCE WITH THE USE OF
THE INTERFACE AND THE INTERFACE DESCRIPTION SHALL NOT EXCEED THE
PRICE PAID FOR THE INTERFACE AND THE INTERFACE DESCRIPTION.
6.6. YOU SHALL INDEMNIFY AND HOLD AXIS AND ITS AFFILIATES HARMLESS FROM
ANY CLAIMS WHATSOEVER FROM ANY THIRD PARTY AGAINST AXIS OR ITS
AFFILIATES RELATING TO OR EMANATING FROM YOUR USE OF THE INTERFACE
AND THE INTERFACE DESCRIPTION UNDER THIS LICENSE AGREEMENT. THE
FOREGOING INDEMNIFICATION INCLUDES BUT IS NOT LIMITED TO ANY AND
ALL DAMAGES, COSTS AND EXPENSES (INCLUDING REASONABLE ATTORNEYS’
FEES).

VAPIX® Capture Mode 3

 Table of Contents
1  Overview .......................................................................................................5 
1.1  Description .............................................................................................5 
1.1.1  Sensor Capture Mode .........................................................................5 
1.1.2  Video Capture Mode (AXIS Q1755) .......................................................5 
1.2  History ...................................................................................................5 
2  Prerequisites ..................................................................................................6 
2.1  Identification ...........................................................................................6 
3  Examples ......................................................................................................6 
4  Parameters ....................................................................................................8 
4.1  ImageSource.I0.Sensor ............................................................................8 
4.2  ImageSource.I0.Video (AXIS Q1755) ..........................................................8 
5  References ....................................................................................................8 
This document is copyright protected and is the property of Axis Communications AB and may not be copied, reproduced or
distributed in any way without the prior written consent of Axis Communications AB.

1 Overview
1.1 Description
1.1.1 Sensor Capture Mode
Some Axis cameras have the sensor capture mode functionality that allows you to
optimize a camera’s sensor for your needs. For example, you can set the sensor capture
mode of your Axis camera’s sensor to achieve a higher resolution if that is more
important than frame rate and vice versa.
By changing the sensor capture mode you change the:
• Frame rate
• Aspect ratio
• Available camera resolutions
In these products, the CaptureMode parameter shows which capture mode is currently
being used. The available modes will be product dependent.
Please note that CaptureMode is generally set for a camera’s sensor during installation
since when you change the CaptureMode of your Axis camera, certain settings are
restarted, removed or reset:
• Motion, tampering and digital PTZ will be restarted
• All events will be removed
• All motion detection windows are removed
• All streamprofiles are reset
• Imageoverlays, maskwindows, and virtual image sources are disabled
• All guardtours are removed
• All PTZ presets are removed
Since video streams that are not in the same aspect ratio as the maximum resolution will
be cropped, the AspectRatio parameter shows the aspect ratio.

1.1.2 Video Capture Mode (AXIS Q1755)

The Video Capture mode of the AXIS Q1755 allows you to define the size and scan mode
of the sensor. HDTV format 720p (progressive scan) or 1080i (interlaced) with the option
of de-interlacing.
720p provides a better quality video stream especially when capturing motion. 720p is
recommended for all resolutions except 1920x1080 which would result in an upscaled
image of lesser quality.
1080i provides a larger image, but also may contain motion artifacts which may degrade
the image and should only be used with a resolution of 1920x1080.

1.2 History
Version Date Comment

1.00 2009-12-04 Initial version

VAPIX® Capture Mode 5

This document is copyright protected and is the property of Axis Communications AB and may not be copied, reproduced or
distributed in any way without the prior written consent of Axis Communications AB.

2 Prerequisites
2.1 Identification
Product category: Capture mode is only available for specific Axis products. Check the
product’s parameters to see if it is possible to change CaptureMode.

3 Examples
Example: Read the sensor capture mode.
http://<servername>/axis-cgi/param.cgi?action=list
&group=ImageSource.I0.Sensor.CaptureMode

Response example:
ImageSource.I0.Sensor.CaptureMode=1

Example: List the available sensor capture modes.

http://<servername>/axis-cgi/param.cgi?action=listdefinitions
&listformat=xmlschema&group=ImageSource.I0.Sensor.CaptureMode

Response example for an AXIS P1346:

<?xml version="1.0" encoding="iso-8859-1" ?>
<parameterDefinitions
xmlns="http://www.axis.com/ParameterDefinitionsSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.axis.com/ParameterDefinitionsSchema
http://10.94.127.176/pub/parameterdefinitions.xsd"
version="1.0">
<model>AXIS P1346</model>
<firmwareVersion>5.05beta39_lpr2</firmwareVersion>
<group name="ImageSource">
<group name="I0">
<group name="Sensor">
<parameter name="CaptureMode" value="1" securityLevel="7744"
niceName="Capture mode">
<type>
<enum>
<entry value="1" niceValue="3 MP 2048x1536 (4:3) @ 20fps" />
<entry value="2" niceValue="HDTV 1080p 1920x1080 (16:9) @ 30fps" />
<entry value="3" niceValue="2 MP 1600x1200 (4:3) @ 30fps" />
</enum>
</type>
</parameter>
</group>
</group>
</group>
</parameterDefinitions>

Example: Set the capture mode to 2 for an AXIS P1346.

http://<servername>/axis-cgi/param.cgi?action=update
&ImageSource.I0.Sensor.CaptureMode=2

Example: Read the aspect ratio.

http://<servername>/axis-cgi/param.cgi?action=list
&ImageSource.I0.Sensor.AspectRatio 

Response example for an AXIS P1346:

root.ImageSource.I0.Sensor.AspectRatio=16:10

VAPIX® Capture Mode 6

This document is copyright protected and is the property of Axis Communications AB and may not be copied, reproduced or
distributed in any way without the prior written consent of Axis Communications AB.

Example: Read the video capture mode for an AXIS Q1755.

http://<servername>/axis-cgi/param.cgi?action=list
&group=ImageSource.I0.Video.CaptureMode

Response example:
root.ImageSource.I0.Video.CaptureMode=720p25

Example: List the available video capture modes for an AXIS Q1755.
http://<servername>/axis-cgi/param.cgi?action=listdefinitions
&listformat=xmlschema&group=ImageSource.I0.Video.CaptureMode

Response example:
<?xml version="1.0" encoding="iso-8859-1" ?>
<parameterDefinitions
xmlns="http://www.axis.com/ParameterDefinitionsSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.axis.com/ParameterDefinitionsSchema
http://10.13.24.133/pub/parameterdefinitions.xsd"
version="1.0">
<model>AXIS Q1755</model>
<firmwareVersion>5.02</firmwareVersion>
<group name="ImageSource">
<group name="I0">
<group name="Video">
<parameter name="CaptureMode" value="720p25" securityLevel="7744"
niceName="Capture mode">
<type>
<enum>
<entry value="PAL" />
<entry value="NTSC" />
<entry value="720p25" />
<entry value="720p30" />
<entry value="1080i50" />
<entry value="1080i60" />
</enum>
</type>
</parameter>
</group>
</group>
</group>
</parameterDefinitions>

Example: Set the video capture mode to 720p25 for an AXIS Q1755.
http://<servername>/axis-cgi/param.cgi?action=update
&ImageSource.I0.Video.CaptureMode=720p25

VAPIX® Capture Mode 7

This document is copyright protected and is the property of Axis Communications AB and may not be copied, reproduced or
distributed in any way without the prior written consent of Axis Communications AB.

4 Parameters
4.1 ImageSource.I0.Sensor
Read the aspect ratio. Read and set the capture mode.
To see a list of all available aspect ratios for your Axis camera see:
http://www.axis.com/files/tech_notes/vapix_resolutions_3_01.pdf.
[ImageSource.I0.Sensor]

Parameter Default Valid values Access Description

value Control
AspectRatio Product A string Read: Contains the aspect ratio
dependent admin used for the maximum
operator resolution in the camera.
This should be the aspect
ratio to use if you want to
see as much of the image
as possible. This parameter
will only be updated if
CaptureMode is changed.
CaptureMode1 Product Depends on the Read: Specifies which sensor
dependent values in admin setting should be used. The
(usually 1) RESOLUTIONSET operator meanings of the values are
bootblock product dependent.
Write2:
admin
operator
1.
Product dependent. If the parameter does not exist, the functionality is not
supported.
2.
When CaptureMode is changed in the camera, the following things happen:
• Motion, tampering and digital PTZ will be restarted All events will be removed
• All motion detection windows are removed
• All streamprofiles are reset
• Imageoverlays, maskwindows, and virtual image sources are disabled
• All guardtours are removed
• All PTZ presets are removed

4.2 ImageSource.I0.Video (AXIS Q1755)

Read and set the capture mode.
[ImageSource.I0.Video]

Parameter Default Valid values Access Description

value Control
CaptureMode 720p30 or NTSC Read: This defines the size and
720p25 PAL admin scan mode of the sensor.
720p30, operator 720p is progressive scan
720p25 and 1080i is interlaced1.
1080i60 Write:
1080i50 admin
operator
1.
Setting NTSC/PAL will disable image streaming; only analog video output is
enabled.

VAPIX® Capture Mode 8

This document is copyright protected and is the property of Axis Communications AB and may not be copied, reproduced or
distributed in any way without the prior written consent of Axis Communications AB.

5 References
HTTP Protocol
See the section Parameter management in:
http://www.axis.com/files/manuals/VAPIX_3_HTTP_API_3_00.pdf
Supported image resolutions
http://www.axis.com/files/tech_notes/vapix_resolutions_3_01.pdf

VAPIX® Capture Mode 9