VAPIX , Parameter Specification - Axis Communications , Parameter Specification Revision: 2.16 Date:...

VAPIX®, Parameter Specification

Revision: 2.16 Date: 2007-October-17

TABLE OF CONTENTS

DOCUMENT HISTORY

1 OVERVIEW

1.1 Product and firmware versions

1.2 Security levels

1.3 Valid values

2 PARAMETER GROUPS

2.1 General

o 2.1.1 Bandwidth

o 2.1.2 Brand

o 2.1.3 Log.Access

o 2.1.4 Log.System

o 2.1.5 LogLevels

o 2.1.6 MailLogd

o 2.1.7 Network

o 2.1.8 Network.ARPPingIPAddress

o 2.1.9 Network.AxisNS

o 2.1.10 Network.Bonjour

o 2.1.11 Network.DNSUpdate

o 2.1.12 Network.eth0

o 2.1.13 Network.eth0.IPv6

o 2.1.14 Network.Filter

o 2.1.15 Network.Filter.Input

o 2.1.16 Network.FTP

o 2.1.17 Network.Interface.I#

o 2.1.18 Network.Interface.I#.Active

o 2.1.19 Network.Interface.I#.Link

o 2.1.20 Network.Interface.I#.Manual

o 2.1.21 Network.Interface.I#.ZeroConf

o 2.1.22 Network.IPv6

o 2.1.23 Network.QoS

o 2.1.24 Network.Resolver

o 2.1.25 Network.Routing

o 2.1.26 Network.Routing.IPv6

o 2.1.27 Network.RTP

o 2.1.28 Network.RTP.R#

o 2.1.29 Network.RTSP

o 2.1.30 Network.UPnP

o 2.1.31 Network.UPnP.NATTraversal

o 2.1.32 Network.VolatileHostName

o 2.1.33 Network.ZeroConf

o 2.1.34 NetworkLED

o 2.1.35 SMTP

o 2.1.36 SMTP.Authentication.A#

o 2.1.37 SOCKS

o 2.1.38 StatusLED

o 2.1.39 System

o 2.1.40 System.BoaGroupPolicy

o 2.1.41 Time

o 2.1.42 Time.DST

o 2.1.43 Time.NTP

2.2 JPEG/MJPEG/MPEG

o 2.2.1 Image

o 2.2.2 Image.I#

o 2.2.3 Image.I#.Appearance

o 2.2.4 Image.I#.MPEG

o 2.2.5 Image.I#.Overlay

o 2.2.6 Image.I#.Overlay.MaskWindows

o 2.2.7 Image.I#.Overlay.MaskWindows.M#

o 2.2.8 Image.I#.RateControl

o 2.2.9 Image.I#.Stream

o 2.2.10 Image.I#.Text

o 2.2.11 Image.I#.TriggerData

o 2.2.12 ImageSource

o 2.2.13 ImageSource.I#

o 2.2.14 ImageSource.I#.DayNight

o 2.2.15 ImageSource.I0.DCIris

o 2.2.16 ImageSource.I0.Sensor

o 2.2.17 ImageSource.I#.Video

2.3 Sequence

o 2.3.1 Sequence

o 2.3.2 Sequence.S#.Source.S#

2.4 Guard Tour

http://www.axis.com/techsup/cam_servers/dev/cam_param_2.php#parameter_blocks_general_network_rtsp

o 2.4.1 GuardTour.G#

o 2.4.2 GuardTour.G#.Tour.T#

2.5 PTZ

o 2.5.1 PTZ

o 2.5.2 PTZ.PTZDrivers

o 2.5.3 PTZ.PTZDriverFirmwares

o 2.5.4 PTZ.TargetFirmwares

o 2.5.5 PTZ.PTZDriverVersions

o 2.5.6 PTZ.SerDrivers

o 2.5.7 PTZ.SerDriverVersions

o 2.5.8 PTZ.SerDriverStatuses

o 2.5.9 PTZ.CamPorts

o 2.5.10 PTZ.Driver#

2.5.10.1 Per serial port

2.5.10.2 Per camera

o 2.5.11 Camera parameter groups

o 2.5.12 PTZ.PresetPos

o 2.5.13 PTZ.Preset.P#

o 2.5.14 PTZ.Preset.P#.Position.P#

o 2.5.15 PTZ.UserCtlQueue.U#

2.6 Motion Detection

o 2.6.1 Motion.M#

2.7 Camera Tampering

o 2.7.1 Tampering.T#

2.8 I/O

o 2.8.1 Input

o 2.8.2 Input.I#

o 2.8.3 Output

o 2.8.4 Output.O#

2.9 Serial port

o 2.9.1 Serial

o 2.9.2 Serial.Ser#

o 2.9.3 Serial.RS485

2.10 Serial server

o 2.10.1 Sersrvd

2.11 Events

o 2.11.1 Event.E#

o 2.11.2 Event FTP Actions

o 2.11.3 Event HTTP Actions

o 2.11.4 Event HW Actions

o 2.11.5 Event SMTP Actions

o 2.11.6 Event TCP Actions

o 2.11.7 Event PTZ Actions

o 2.11.8 Event Guard Tour Actions

2.12 Event servers

o 2.12.1 EventServers.FTP.F#

o 2.12.2 EventServers.HTTP.H#

o 2.12.3 EventServers.TCP.T#

2.13 Notification

o 2.13.1 Notify

o 2.13.2 Notify.FTP

o 2.13.3 Notify.HTTP

o 2.13.4 Notify.SMTP

2.14 HTTPS

o 2.14.1 HTTPS

2.15 SNMP

o 2.15.1 SNMP

2.16 Properties

o 2.16.1 Properties.API

o 2.16.2 Properties.Audio

o 2.16.3 Properties.Firmware

o 2.16.4 Properties.GuardTour

o 2.16.5 Properties.HTTPS

o 2.16.6 Properties.Image

o 2.16.7 Properties.ImageSource

o 2.16.8 Properties.Motion

o 2.16.9 Properties.PTZ

o 2.16.10 Properties.Recorder

o 2.16.11 Properties.System

o 2.16.12 Properties.Tampering

o 2.16.13 Properties.TemperatureSensor

2.17 Web interface

o 2.17.1 ExternalVideo

o 2.17.2 Layout

o 2.17.3 Layout.Banner

o 2.17.4 Layout.BGPicture

o 2.17.5 Layout.CustomLink.C#

o 2.17.6 Layout.Description

o 2.17.7 Layout.Logo

o 2.17.8 Layout.Title

o 2.17.9 Layout.Trigger.T#

2.18 Wireless

o 2.18.1 Network.Wireless

o 2.18.2 Network.Wireless.W0

o 2.18.2 Network.Wireless.WEP

2.19 Audio

o 2.19.1 Audio

o 2.19.2 Audio.A#

o 2.19.3 AudioSource

o 2.19.4 AudioSource.A#

2.20 Recorder

o 2.20.1 Recorder

o 2.20.2 Recorder.Source.S#

o 2.20.3 Recorder.Source.S#.AlarmChannel

o 2.20.4 Recorder.Source.S#.ScheduleChannel

o 2.20.5 Recorder.QuadPattern.Q#

2.21 AXIS 292 Network Video Decoder

o 2.21.1 Alarm

o 2.21.2 Buttons

o 2.21.3 Encoder.E#

o 2.21.4 Encoder.E#.Info

o 2.21.5 Decoder

o 2.21.6 Decoder.Info

o 2.21.7 Network.Info.DHCP

o 2.21.8 System

DOCUMENT HISTORY

Version Date Comment

2.00 2003-Sep-22

Initial version.

2.01 2003-Oct-01

Added ImageSource.IO.Sensor.Sharpness.

2.02 2004-Feb-16

Added parameters for AXIS 241Q/S.

2.03 2004-May-27

Added more valid values to Image.I#.Appearance.Resolution. Added new parameters to the ImageSource.I0.Sensor parameter group. Added new parameters to the Layout parameter group.

Added new parameter group; ImageSource.I0.DCIris. Added Properties.Image.Format. Added Properties.ImageSource.DCIris. Removed Image.StreamMode. Removed Properties.Bitmap.

2.04 2004-July-09

Added new parameter groups; Network.Wireless and Network.Wireless.WEP

2.05 2004-July-23

Added new parameters to the Layout and the Image parameter groups. Added new parametergroups; Image.I#.MPEG, Image.I#.TriggerData, Network.RTP.R#, Encoder, Encoder.Info, Encoder.Info.MJPEG, Decoder, Decoder.Picture, Decoder.CropTopBottom, Decoder.Info and Network.lnfo.DHCP.

2.06 2004-Sept-21

Added new parameters to the Layout, ImageSource.I0.Sensor, PTZ.TargetFirmwares, PTZ.Driver#.Support.S# and PTZ.Driver#.Various.V0 groups. Added new parameter groups; Audiod and Properties.Audio

2.07 2005-Feb-24

Added the parameters Image.I#.MPEG.VideoObjectType, Layout.LiveViewVideo, Layout.MPEGInstallationEnabled. Removed the parameter Network.RTP.R#.MulticastAlways and added the parameter Network.RTP.R#.AlwaysMulticast. Added the parameter groups; Network.RTP, Network.RTSP, SMTP.Authentication.A#, Image.I#.RateControl. Added supported VOTs and added the Simple profiles to the description of the Image.I#.MPEG.ProfileLevel parameter.

2.08 2005-Mar-30

Added the parameter groups Audio, Audio.A#, AudioSource, and AudioSource.A#. Added Properties.Audio.Audio and Properties.Audio.Format. The parameter group Audiod and the parameter Properties.Audio.Audiod are deprecated.

2.09 2005-Apr-08

Added the parameter group Network.UPnP.NATTraversal and the parameter System.AlternateBoaPort.

2.10 2005-Apr-21

Changed the default value for the parameter Image.I#.Stream.FPS from 0 to product dependent and added a note to the description.

2.11 2005-May-26

Added the parameter Network.Filter.Input.Policy. Added the parameter Image.I#.MPEG.UserDataEnabled. Added new parameters for the AXIS 292 Network Video Decoder and removed most of the old, due to a lot of new functionality.

2.12 2005-Aug-17

Added new parameters to the ImageSource.I0.Sensor group. Added new parameters to the Network.RTP group. Added new valid value for AudioSource.A#.AudioEncoding. Added a new parameter, Image.I#.MPEG.CyclicBlockRefresh. Default value for Time.SyncSource is now product dependent. Changed values for Audio.MaxListeners. Default value for Image.I#.Appearance.Compression changed from 50 to 30. Default value for Image.I#.MPEG.PCount now product dependent. Default value for Image.I#.RateControl.MaxBitrate now product dependent. Added the parameter ImageSource.I0.Sensor.ExposurePriority. Added the parameter Network.AxisNS.ServerLink. Added the parameters Time.ObtainFromDHCP and Time.NTP.VolatileServer. Added new parameters for the AXIS 262.

2.13 2005-Oct-26

Added SNMP parameters. Updated examples with new valid values for Event.E#.HWInputs. Added the parameter HTTPS.Port. Added the parameter Image.PrivacyMaskType. Added Image.I#.Overlay.MaskWindows parmeters. Added ImageSource.I#.Video.DetectedType, ImageSource.I#.DeinterlaceMode, ImageSource.I#.DayNight.IrCutFilter and ImageSource.I#.Sensor.BacklightCompensation. Added Network.Bonjour parameters. Added Properties.GuardTour.GuardTour parameter. PTZ.Various.V#.CtlDuration is deprecated. Added PTZ.Various.V#.CtlQueuePollTime. Added PTZ.UserCtlQueue.U# parameters.

Added Serial.RS485 parameters.

2.14 2005-Dec-12

Added new triggers and examples for Event.E#.SWInput. Added information about dynamic event notification to Event HTTP Actions, Event SMTP Actions and Event TCP Actions.

2.15 2007-Jan-12

Added Guard Tour parameters and Event Guard Tour Actions. Added PTZ.Various.V#.PanEnabled and PTZ.Various.V#.TiltEnabled. Added PTZ.Support.S0.ActionNotification, PTZ.Support.S0.ProportionalSpeed, PTZ.Support.S0.GenericHTTP PTZ.Support.S0.LensOffset. Added PTZ.Various.V0.ActionNotificationEnabled, PTZ.Various.V0.ProportionalSpeedEnabled, PTZ.Various.V0.MaxProportionalSpeed, PTZ.Various.V0.LensOffsetX and PTZ.Various.V0.LensOffsetY. Added PTZ.Preset.P# parameter groups. Added ImageSource.I#.Video.Connector and ImageSource.I0.Sensor.BlacklevelCorrection. Added NetworkLED.Usage. Added Layout.AACIntallationEnabled. Added Network.Enabled, Network.InterfaceSelectMode, Network.tcpECN, Network.ARPPingIPAddress.Enabled, Network.FTP, Network.Resolver.NameServerList, Network.Wireless.Mode, Network.Wireless.W0, Network.Wireless.WEP.Authentication. Added Network.Interface.I# parameter groups. Added Network.QoS, Network.RTP.VideoDSCP, Network.RTP.AudioDSCP, SNMP.DSCP, System.BoaDSCP, Audio.DSCP, Added Network.eth0.IPv6, Network.IPv6, Network.Routing.IPv6. Added Audio.ConnectedClients, Audio.ConnectedPostClients, Audio.ReceiverBuffer, AudioSource.A#.BitRate, AudioSource.A#.SampleRate. Audio.DuplexMode=off no longer supported. Added EventServers.FTP.F#.UseTempFile. Added Event.E#.MinimumTriggerInterval. Added Event.E#.CreateFolder. Added ImageSource.I0.Sensor.WidescreenEnabled and added new valid values to Image.I#.Appearance.Resolution. Added ExternalVideo.E#.VideoFormat. Added Image.I#.MPEG.Optimization. Added Camera Tampering parameters. Added Audio alarm parameters. Removed deprecated parameters.

2.16 2007-Oct-17

Added Log.Access and Log.System parameters.

1 OVERVIEW

This document specifies the parameters and configuration files for Axis camera and video servers using firmware version 4.00 and above.

DISCLAIMER OF WARRANTY AND LIMITATION OF LIABILITY

THESE PARAMETERS ARE PROVIDED "AS IS", WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY FOR MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, ACCURACY OF INFORMATION OR NON-INFRINGEMENT OF INTELLECTUAL PROPERTY.

AXIS COMMUNICATIONS AB SHALL IN NO EVENT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING WITHOUT LIMITATION THOSE RESULTING FROM LOST PROFIT, DATA OR BUSINESS INTERRUPTION) ARISING OUT OF THE USE, INABILITY TO USE OR THE RESULTS OF THE USE OF THE PARAMETERS, WHETHER BASED ON WARRANTY, CONTRACT, TORT OR ANY OTHER LEGAL THEORY.

Axis Communications AB reserves the right to alter this document and the parameters contained herein at any time without prior notice.

Please note that altering these parameters can seriously damage the product.

Please note that the flash chip manufacturer estimates the number of writes to the flash chips to about 100,000. Writing

large numbers of temporary files to the flash memory should thus be avoided.

1.1 Product and firmware versions The support for the parameters specified in this document is highly product and release dependent. Please refer to the parameter list for the actual product.

1.2 Security levels The security levels column in each parameter table shows the required security level to operate parameters. The numbers represent security levels on the form create/delete for groups and get/set for parameters. To be able to perform an action on a parameter the user needs to have a security level equal to or higher than the corresponding security level of the parameter.

Security level

Description

0 Unprotected, but it is not possible to access the camera from outside without at least view rights.

1 View access right needed to access the parameter.

4 Operator access right needed to access the parameter.

6 Administrator access right needed to access the parameter.

7 Internal parameters that can only be changed by firmware applications or by root, editing the configuration files directly.

1.3 Valid values The following valid values are used in this document:

Valid values Description

An integer Any number between -2147483647 (-2^31-1) and 2147483647 (2^31-1).

An unsigned integer Any number between 0 and 4294967295 (2^32-1).

<m> Any number starting from number m.

<m> ... <n> Any number between number m and number n.

A string Any string (valid characters: ISO 8859-1).

A domain name A string limited to contain a domain name.

A host name A string limited to contain a host name.

An IP address A string limited to contain an IP address of the format xxx.xxx.xxx.xxx, where xxx is a number between 0 to 255. Example: 192.168.0.90

A MAC Address A string limited to contain a MAC address of the format xx:xx:xx:xx:xx:xx, where xx is a hexadecimal value. Example: 00:40:8c:cd:00:00

An e-mail address A string limited to contain an e-mail address.

A URL/URI A sting limited to contain a URL/URI.

A path A string limited to contain a path.

A time A string limited to contain a time of the format hh:mm:ss. Example: 23:01:14

A date A string limited to contain a date of the format yyyy-mm-dd. Example: 2004-02-16

<value 1> <value 2> <value 3> ...

Enumeration, only the given values are valid. Example: yes no

<m><value> ... <n><value>

<value><m> ... <value><n>

Any number between m and n together with value. Example: 1Mbit ... 100Mbit

Read only Only the default value is valid as value.

Auto generated Automatically generated value, should not be changed manually.

Hardware dependent The hardware decides the default value/the valid values.

Everything inside brackets Description.

2 PARAMETER GROUPS

2.1 General

2.1.1 Bandwidth Description: To minimize the impact on other services running on the network, it is possible to configure the maximum network bandwidth the camera or video server will be allowed to use.

Configuration file: /etc/conf.d/bandwidth

Security level (create/delete): 7/7

[Bandwidth]

Parameter name

Default value

Valid values Security level (get/set)

Description

Limit 0 0, 1Kbit ... 1024Kbit 1Mbit ... 100Mbit

6/6 Limits the maximum network bandwidth usage for the product. 0 = unlimited.

2.1.2 Brand Description: Contains information about the brand, name and type of the product.

Configuration file: /etc/sysconfig/brand.conf

[Brand]

Parameter name

Default value Valid values Security level (get/set)

Description

Brand AXIS A string (Auto generated)

0/7 The brand of the product.

ProdFullName * A string (Auto generated)

0/7 The full name of the product.

ProdNbr * A string (Auto generated)

0/7 The product number.

ProdShortName * A string (Auto generated)

0/7 The short name of the product.

ProdType * Video Server, Network Camera, Network Video Recorder (Auto generated)

0/7 The product type.

WebURL http://www.axis.com A string (Auto generated)

0/7 The URL to visit for support and information about the product.

* The default value for these parameters is product specific.

2.1.3 Log.Access Description: Parameters for controlling inclusion of information in the client access log.

Configuration file: /etc/sysconfig/log.conf


[Log.Access]

Parameter name

Default value

Valid values

Security level (get/set)

Description

MaxSize 40000 1000 ... 100000

6/6 The maximum size of the access log.

Critical detailed off, on, detailed

6/6 Set the level of critical messages that should be shown in the access log. Note: This level is not yet implemented

Warning detailed off, on, detailed

6/6 Set the level of warning messages that should be shown in the access log. off = No warning messages will be shown. on = All suspected intrusions are shown. detailed = All suspected intrusions and access denied events are shown.

Informational off off, on, detailed

6/6 Set the level of informational messages that should be shown in the access log. off = No informational messages will be shown. on = Most access information will be shown, but some similar and trivial messages are filtered out. detailed = All information will be shown.

2.1.4 Log.System Description: Parameters for controlling inclusion of information in the system log.



[Log.System]

Parameter name

Default value

Valid values


Description

MaxSize 40000 1000 ... 100000

6/6 The maximum size of the system log.

Critical on off, on, detailed

6/6 Set the level of critical messages that should be shown in the system log. off = No critical messages will be shown. on = All critical messages will be shown. detailed = All critical messages will be shown. Note: Today there is no difference setting the level to on or detailed.

Warning on off, on, detailed

6/6 Set the level of warning messages that should be shown in the system log. off = No warning messages will be shown. on = All warning messages will be shown. detailed = All warning messages will be shown. Note: Today there is no difference setting the level to on or detailed.

Informational on off, on, detailed

6/6 Set the level of informational messages that should be shown in the system log. off = No informational messages will be shown. on = All informational messages will be shown. detailed = All informational messages will be shown. Note: Today there is no difference setting the level to on or detailed.

2.1.5 LogLevels Description: Parameters for selecting log levels for the product.



[LogLevels]

Parameter name Default value

Valid values


Description

CritLogEnabled yes yes, no

6/6 Enable/disable logging of critical messages.

InfoLogEnabled yes yes, no

6/6 Enable/disable logging of info messages.

WarningLogEnabled yes yes, 6/6 Enable/disable logging of warning

no messages.

2.1.6 MailLogd Description: Parameters for log levels to send as e-mail.

Configuration file: /etc/sysconfig/maillogd.conf


[MailLogd]

Parameter name

Default value


Description

LogSendLevel 0 0 ... 3 6/6 Which messages that are sent with e-mail: 0 = None. 1 = Critical. 2 = Critical and Warning. 3 = Critical, Warning and Information.

ToEmail An e-mail address

6/6 The e-mail address to which log messages are sent.

2.1.7 Network Description: Network interface settings. The parameters in this group (as opposed to the subgroups of this group) are static network settings. If the Network.BootProto parameter is "dhcp" these parameters may not be in use so always use the read-only parameters in the subgroups to retrieve actual network settings in use by the operating system.

Configuration files: /etc/conf.d/net.eth0, /etc/conf.d/hostname, /etc/resolv.conf.def


[Network]

Parameter name Default value Valid values


Description

BootProto dhcp dhcp, none

6/6 Enable/disable dynamic IP address assignment to the Axis device.

Broadcast 192.168.0.255 An IP address

6/6 Broadcast address. Used to disseminate information to several recipients simultaneously.

DefaultRouter 192.168.0.1 An IP address

6/6 Default router/gateway used for connecting devices attached to different networks and network segments.

DNSServer1 0.0.0.0 An IP address

6/6 Primary Domain Name System server.

DNSServer2 0.0.0.0 An IP address

6/6 Secondary Domain Name System server.

DomainName A domain name

6/6 The name of the domain to which the Axis device belongs.

Enabled1 yes yes, 6/6 Enable/disable IPv4. Only applicable for products

no with IPv6 support.

HostName axis-<serial number>

A host name

6/6 The name of the Axis device on the network, usually the same as the DNS name.

InterfaceSelectMode1 auto auto, wired

6/6 Interface select mode. Defines how the Axis device chooses which network interface to use. In auto mode the wireless interface will be used when a wired network connection cannot be detected. In wired mode only the wired interface will be used, regardless of its' status.

IPAddress 192.168.0.90 An IP address

6/6 IP Address. The physical address of the Axis device on the network.

Media auto auto, 10baseT-HD, 10baseT-FD, 100baseTX-HD, 100baseTX-FD1

6/6 Media type on the network.

SubnetMask 255.255.255.0 An IP address

6/6 Subnet mask. Divides the network.

tcpECN 1 0, 1

6/6 Enable TCP Explicit Congestion Notification.

1 Product dependent

2.1.8 Network.ARPPingIPAddress Description: Enable/disable whether it is possible to set the IP address of the unit with ARP/Ping..

Configuration file: /etc/conf.d/ipsetd


[Network.ARPPingIPAddress]

Parameter name

Default value

Valid values


Description

Enabled yes yes, no

6/6 Enable/disable ARP/Ping IP address setting.

2.1.9 Network.AxisNS Description: Enable/disable one click installation, which makes it possible to access the device on the local network and the Internet using a predetermined name.

Configuration file: /etc/sysconfig/axisns.conf


[Network.AxisNS]

Parameter name

Default value Valid values


Description

Enabled no yes, no

6/6 Enable/disable Axis Internet dynamic DNS service. This value is set to "yes" by the axisns application when a registration is performed, and it is set to "no" when it is un-registered.

When set to "yes" the registration automatic updates of the registration is enabled. When set to "no" the registration will not be automatically updated

LockButton no yes, no

6/6 Specifies that the button is disabled. No registration will occur when the button is pressed.

UpdatePeriod 0 0 ... 24 6/6 Specifies the period in hours between periodic updated of the registration. Set to '0' to disable periodic registration.

ServerLink www.axiscam.net A string 6/6 An HTTP URL to the Axis DDNS server. The user shall go to this URL to finalize the registration.

ServerList www0.axiscam.net, www1.axiscam.net, 212.209.10.252, 193.13.178.252

A string 6/6 Specifies a comma separated list of addresses of AIDDS servers. This value may be set at registration. The value to use is then returned from the AIDDS server in the response of the registration request.

ServerPath reg_cam.php A string 6/6 Specifies the path to the registration script on the AIDDS server. This value may be set at registration. The value to use is then returned from the AIDDS server in the response of the registration request.

CheckPeriod 10 0 ... 6/6 Specifies the period in seconds between periodic checks of the registered IP address (used behind a NAT). Set to '0' to disable periodic registration checks.

CheckIPAddress 0.0.0.0 An IP address

6/6 Specifies the registered IP address. This value is set by the axisns application and shall not be configured by the user.

CheckTTL 0 1 ... 255 6/6 Specifies the TTL value to use when polling the registered IP address. This value is set by the axisns application and shall not be configured by the user.

2.1.10 Network.Bonjour Description: Enable/disable Bonjour and set the name to be displayed in Bonjour-clients.

Configuration file: /etc/conf.d/rendezvous


[Network.Bonjour]

Parameter name



Description

Enabled yes yes, no

6/6 Enable/disable Bonjour.

FriendlyName <product name> - <serial number>

A string 6/6 The name of the Bonjour device.

2.1.11 Network.DNSUpdate Description: Dynamic Updates in the Domain Name System (RFC 2136).

Configuration file: /etc/sysconfig/dnsupdate.conf


[Network.DNSUpdate]

Parameter name

Default value


Description

DNSName <absolute domain name> or <domain name relative to root>

6/6 The name entered here will be associated with the product's IP address in the DNS server. An example of a DNS name is Axisproduct.example.com.

Enabled no yes, no

6/6 Enable/disable dynamic DNS service.

TTL 30 0 ... <2^32-1> 6/6 This value determines how long (in seconds) the reply from the DNS server should be remembered when checking that the domain name for the registered IP address is still valid. This will reduce the amount of network traffic necessary for the unit's operation.

2.1.12 Network.eth0 Description: Network settings of the first ethernet interface. Use these parameters to retrieve the network settings actually in use by the operating system.

Configuration file: There is no configuration file for these parameters. They are retrieved directly from the interface.


[Network.eth0]

Parameter name


Description

Broadcast An IP address (Auto generated)

6/7 Broadcast address. Used to disseminate information to several recipients simultaneously. This parameter is read only.

IPAddress An IP address (Auto generated)

6/7 IP Address. The physical address of the Axis device on the network.

http://www.faqs.org/rfcs/rfc2136.html

This parameter is read only.

MACAddress 00:40:8c:xx:xx:xx* A MAC address (Auto generated)

6/7 MAC address. The unique identity of the Axis device. This parameter is read only.

SubnetMask An IP address (Auto generated)

6/7 Subnet mask. Divides the network. This parameter is read only.

* The MAC address of the Axis device is unique for every single product. The first part of the address is however always the same; 00:40:8c. The MAC address is the same as the serial number, which can be found on the product's label.

2.1.13 Network.eth0.IPv6 Description: Network settings of IPv6 on the first Ethernet interface. Use these parameters to retrieve the network settings actually in use by the operating system.



[Network.eth0.IPv6]

Parameter name

Default value

Valid values


Description

IPAddresses Auto generated

6/7 The physical addresses of the Axis device on the network. A list of IPv6 addresses, separated by a space. This parameter is read only.

2.1.14 Network.Filter Description: IP address filtering. These parameters are used to only accept connections from certain IP addresses or networks.

Configuration file: /etc/conf.d/iptables


[Network.Filter]

Parameter name Default value Valid values Security level (get/set) Description

Enabled no yes, no

6/6 Enable/disable IP address filtering.

2.1.15 Network.Filter.Input Description: IP addresses filtering for incoming packets.

Configuration file: /etc/conf.d/iptables


[Network.Filter.Input]

Parameter name

Default value


Description

AcceptAddresses A string (a space separated list of IP addresses and network addresses in the CIDR notation (IP address/netmask bits))

6/6 Addresses allowed to pass through the filter. Example: 192.168.0/24 will add all the addresses in the range 192.168.1.1 to 192.168.1.254. Note: If accessing the Axis device via a proxy server, the proxy server's IP address must be added to the list of allowed addresses.

Policy allow allow, deny

6/6 Allow or deny the addresses access to the device.

2.1.16 Network.FTP Description: Enable/disable FTP Server in the product.

Configuration file: /etc/conf.d/ftpd


[Network.FTP]

Parameter name

Default value

Valid values


Description

Enabled yes yes, no

6/6 Enable/disable the FTP server running in the product.

2.1.17 Network.Interface.I# Description: Configuration and status information for one network interface on an Axis device.

Configuration file: /etc/conf.d/net.<network device name>


[Network.Interface.I#]*

Parameter name

Default value

Valid values


Description

SystemDevice Product dependent

A string 6/7 The system name of the device for the network interface. This value is read-only.

Type Product dependent

802.3, 802.11

6/7 The type of the network interface as expressed by the IEEE 802 protocol. This value is read-only.

* Note: The # is replaced with a group number starting from zero, e.g. Network.Interface.I0.

2.1.18 Network.Interface.I#.Active Description: Settings of this network interface. Use these parameters to retrieve the network settings actually in use by the operating system.



[Network.Interface.I#.Active]*

Parameter name



Description

MACAddress 00:40:8c:xx:xx:xx1 A MAC address

6/7 The MAC address of the device.

Active yes, no

6/7 The in use status of the network interface. yes = the network is currently in use.

IPAddress An IP address

6/7 The network address of this network interface on the Axis device.

SubnetMask An IP address

6/7 The subnet mask.

Broadcast An IP address

6/7 The broadcast address. Used to disseminate information to several recipients simultaneously.

* Note: The # is replaced with a group number starting from zero, e.g. Network.Interface.I0. 1 The MAC address of the Axis device is unique for every single product. The first part of the address is however always the same; 00:40:8c. The Mac address of the Axis device is the same as the serial number and can be found at a label on the product.

2.1.19 Network.Interface.I#.Link Description: The low-level configuration of a network interface.



[Network.Interface.I#.Link]*

Parameter name

Default value

Valid values


Description

BootProto dhcp dhcp, none

6/6 Enable/disable dynamic IP assignment to this network interface on the Axis device.

Media auto auto, 10baseT-HD, 10baseT-FD, 100baseTX-HD, 100baseTX-FD

6/6 Media type on the network interface. Only available on Ethernet interfaces, i.e. if Network.Interface.I#.Type=802.3.


2.1.20 Network.Interface.I#.Manual Description: The manual configuration of a network interface.



[Network.Interface.I#.Manual]*

Parameter name

Default value

Valid values


Description

IPAddress 192.168.0.90 An IP address

6/6 The network address of this network interface on the Axis device.

SubnetMask 255.255.255.0 An IP address

6/6 Subnet mask for the network interface. Divides the network.

Broadcast 192.168.0.255 An IP address

6/6 Broadcast address. Used to disseminate information to several recipients simultaneously.

DefaultRouter 192.168.0.1 An IP address

6/6 Default router/gateway used for connecting devices attached to different networks and networks segment.


2.1.21 Network.Interface.I#.ZeroConf Description: Enable/disable automatic configuration of link local IP address. The negotiated network settings are located in this group, and are used in parallel with the settings of the Network.Interface.I#.Active group. I.e. both addresses can be used simultaneously.

Configuration file: /etc/conf.d/net.<network device name>_0


[Network.Interface.I#.ZeroConf]*

Parameter name

Default value


Description

Enabled yes yes, no

6/6 Enable/disable zero configuration.

IPAddress An IP address (Auto generated)

6/7 These values shall not be configured. They are retrieved directly from the interface.

SubnetMask An IP address (Auto generated)

6/7 These values shall not be configured. They are retrieved directly from the interface.


2.1.22 Network.IPv6 Description: Network interface settings for IPv6. The parameters in this group are static network settings. Use of RA and/or DHCPv6 will probably result in additional configuration, so use the read-only parameters in the other subgroups to retrieve actual network settings in use by the operation system.

Configuration file: /etc/conf.d/net.eth0


[Network.IPv6]

Parameter name

Default value


Description

Enabled yes yes, 6/6 Enable/disable IPv6 in the Axis device.

no

AcceptRA yes yes, no

6/6 Enable/disable IPv6 to accept router advertisements.

DHCPv6 auto auto, stateful, stateless, off

6/6 Setting for support of DHCPv6. auto = Enable DHCPv6 according to the router advertisements. stateful =Enable DHCPv6 to set IPv6 configuration as well as DNS servers etc. stateless=_ Enable DHCPv6 only to set DNS servers etc. off = Disable DHCPv6

IPAddress One or more IPv6 addresses

6/6 A list of manually configured IPv6 addresses, separated by a space. (If no prefix length is included in an IPv6 address, the default value 64 is used)

DefaultRouter An IPv6 address

6/6 A manually configured IPv6 address of a default router.

2.1.23 Network.QoS Description: Quality of Service classification. These parameters holds the DSCP value common for the members of a QoS class.

Configuration file: /etc/qos/qos.conf


[Network.QoS.Class#]

Parameter name



Description

Desc Description string

A string 6/7 The description of the QoS class.

DSCP 0 allow, deny

6/6 The Differentiated Services Codepoint value for the QoS class.

2.1.24 Network.Resolver Description: Enable /disable retrieval of Domain Name System settings from DHCP server. The actual DNS settings in use by the operating system are located in this group.

Configuration file: /etc/sysconfig/resolver.conf


[Network.Resolver]

Parameter name

Default value


Description

NameServer1 Auto generated

6/7 This parameter is read only.

NameServer2 Auto generated


NameServerList1 Auto generated

6/7 A list of IP addresses (both IPv4 and IPv6), separated by a space.

ObtainFromDHCP yes yes, no 1

6/6 Specifies if the DNS server should be obtained from a DHCP server.

Search Auto generated


1 Product dependent.

2.1.25 Network.Routing Description: Routing table actually in use by the operating system.

Configuration file: There is no configuration file for this parameter. It is retrieved directly from the routing table.


[Network.Routing]


DefaultRouter Auto generated 6/7 This parameter is read only.

2.1.26 Network.Routing.IPv6 Description: Routing table for IPv6 actually in use by the operating system.

Configuration file: There is no configuration file for this parameter. It is retrieved directly from the routing table.


[Network.Routing.IPv6]

Parameter name

Default value


Description

DefaultRouter Auto generated

6/7 A list of default routers for IPv6. This parameter is read only.

2.1.27 Network.RTP Description: Parameters related to multicast RTP.

Configuration file: /etc/sysconfig/rtp.conf


[Network.RTP]

Parameter name

Default value

Valid values


Description

NbrOfRTPGroups Hardware dependent

1 ... 4/7 The number of RTP groups. One group for each possible multicast presentation (i.e. video source).

StartPort 50000 1024 ... 65532

6/6 The RTP port range defines the range of ports from which the video/audio ports are automatically selected. This

feature is useful if the product is connected to a NAT router with manually configured port mapping. Note: Each RTP session needs 4 ports, which means 4 ports for each unicast session (audio and video) or 4 ports for the multicast session in total.

EndPort 50999 1025 ... 65535

6/6 The RTP port range defines the range of ports from which the video/audio ports are automatically selected. This feature is useful if the product is connected to a NAT router with manually configured port mapping. Note: Each RTP session needs 4 ports, which means 4 ports for each unicast session (audio and video) or 4 ports for the multicast session in total.

VideoDSCP 0 0 ... 63 6/6 The Differentiated Services Codepoint for video QoS.

AudioDSCP 0 0 ... 63 6/6 The Differentiated Services Codepoint for audio QoS.

2.1.28 Network.RTP.R# Description: Parameters related to multicast RTP. One group for each possible multicast presentation (i.e., video source).

Configuration file: /etc/sysconfig/rtp.conf


[Network.RTP.R#] *

Parameter name

Default value

Valid values


Description

AlwaysMulticast no yes, no

4/4 Whether multicast RTP should be running all the time when MPEG mode is active. Read only for products that only support multicast.

VideoAddress Generated An IP address

4/4 The IP address to which the multicast RTP video stream is transmitted. The default value is generated based on the serial number of the product to make sure that two servers connected to the same network will not interfere with each other.

VideoPort 0 0, 1024 ... 65535

4/4 The port number for the RTP video stream. 0 indicates that the port number is dynamically assigned.

AudioAddress Generated An IP address

4/4 The IP address to which the multicast RTP audio stream is transmitted. The default value is generated based on the serial number of the product to make sure that two servers connected to the same network will not interfere with each other. The value 0.0.0.0 indicates that the audio stream is disabled. Read only in products without audio support.

AudioPort 0 0, 1024 ... 65535

4/4 The port number for the RTP audio stream. 0 indicates that the port number is dynamically assigned. Read only in products without audio support.

TTL 5 1 ... 4/4 The Time To Live for each UDP packet. This indicates the number of routers/switches that the packet may traverse before being discarded.

* Note: The # is replaced with a group number starting from zero, e.g. Network.RTP.R0.

2.1.29 Network.RTSP Description: Parameters needed by the RTSP daemon.

Configuration file: /etc/rtspd/rtspd.conf


[Network.RTSP]

Parameter name

Default value

Valid values


Description

Enabled yes yes, no

4/4 Enable/disable RTSP support. If disabled, only multicast RTP is available for MPEG delivery.

Port 554 554, 1024 ... 65535

4/4 The port number for the RTSP daemon.

Timeout 60 0 ... 4/4 The keep-alive timeout for the RTSP session specified in seconds. 0 = Disable the keep-alive timeout.

ProtViewer password password, anonymous

4/4 Anonymous viewer access.

2.1.30 Network.UPnP Description: Enable/disable Universal Plug and Play and set the name to be displayed in UPnP-clients.

Configuration file: /etc/conf/libupnp.conf


[Network.UPnP]

Parameter name



Description

Enabled yes yes, no

6/6 Enables Universal Plug and Play.

FriendlyName <product name> - <serial number>

A string 6/6 The name of the UPnP device.

2.1.31 Network.UPnP.NATTraversal Description: These parameters control NAT traversal functionality. NAT traversal is a technique that can be used to open up routers and firewalls to make devices on a LAN accessible from the Internet.

Configuration file: /etc/sysconfig/nat_traversal.conf


[Network.UPnP.NATTraversal]

Parameter name

Default value

Valid values

Security level

Description

(get/set)

Enabled no yes, no

6/6 Enables/disables NAT traversal.

Router An IP address

6/6 If an IP address is entered NAT traversal will be attempted with that router. If none is entered, the server will automatically try to discover a router.

ExternalIPAddress An IP address

6/7 The external IP address of the NAT router. This value shall not be configured, it is set by the system itself.

Active no yes, no

6/7 This parameter is set to yes if NAT traversal was successful. This value shall not be configured, it is set by the system itself.

MinPort 32768 1 ... 65535

6/6 The first time NAT traversal is enabled, a random port between MinPort and MaxPort will be selected as the TCP port to map in the router. If port mapping is successful, that port will be used thereafter. You can limit the random range by setting MinPort and MaxPort.

MaxPort 65535 1 ... 65535

6/6 The first time NAT traversal is enabled, a random port between MinPort and MaxPort will be selected as the TCP port to map in the router. If port mapping is successful, that port will be used thereafter. You can limit the random range by setting MinPort and MaxPort.

2.1.32 Network.VolatileHostName Description: Enable/disable retrieval of host name from DHCP-server. The host name, actually in use by the operating system, is located in this group.

Configuration file: /etc/sysconfig/hostname.conf


[Network.VolatileHostName]

Parameter name

Default value

Valid values


Description

HostName Auto generated


ObtainFromDHCP yes yes, no 1

6/6 Specifies if the host name should be obtained from a DHCP server.


2.1.33 Network.ZeroConf Description: Enable /disable automatic configuration of link local IP address. The negotiated network settings are located in this group, and are used in parallel with the setting of the Network.eth0 group. I.e. both addresses can be used simultaneously.

Configuration file: /etc/conf.d/net.eth0_0


[Network.ZeroConf]


Enabled yes yes, no

6/6 Enable/disable zero configuration.

IPAddress Auto generated 6/7 This parameter is read only.

SubnetMask Auto generated 6/7 This parameter is read only.

2.1.34 NetworkLED Description: This parameter group controls the behavior of the network LED.

Configuration file: /usr/etc/param/par_networkled.conf


[NetworkLED]


Usage on on, off

6/6 Network LED behavior. on = LED is allowed to lit. off = LED is not allowed to lit.

2.1.35 SMTP Description: Parameters for the Simple Mail Transfer Protocol, for sending e-mail messages between mail servers.

Configuration file: /etc/sysconfig/smtp.conf


[SMTP]

Parameter name

Default value


Description

FromEmail An e-mail address 6/6 E-mail address of the individual or Axis device from which the e-mail is sent.

MailServer1 An IP address or a host name

6/6 Primary mail server.

MailServer2 An IP address or a host name

6/6 Secondary mail server.

2.1.36 SMTP.Authentication.A# Description: Parameters for SMTP authentication.

Configuration file: /etc/sysconfig/smtp_auth.conf


[SMTP.Authentication.A#] *

Parameter name

Default value


Description

Enabled no yes, no

6/6 Enable/disable authentication.

UserName A string 6/6 The user name for the mail server or the POP server.

Password A string 6/6 The password for the mail server or the POP server.

WeakestMethod Login Login, Plain, CRAM-MD5, DIGEST-MD5

6/6 The weakest method allowed for mail server login.

UsePOP no yes, no 1

6/6 Login to a POP server.

POPServer An IP address or a host name

6/6 The IP address or host name of the POP server.

* Note: The # is replaced with a group number 1 or 2. The number is representing mail server 1 and mail server 2. 1 Product dependent.

2.1.37 SOCKS Description: SOCKS is a protocol to provide access through firewalls, these parameters configures what server to use and when to use it etc.

Configuration file: /etc/sysconfig/socksparams.conf


[SOCKS]

Parameter name

Default value


Description

Enabled no yes, no

6/6 Enables the SOCKS protocol.

LocalNetworks 10.0.0.0/ 255.0.0.0, 172.16.0.0/ 255.240.0.0, 192.168.0.0/ 255.255.255.0

IP address/Subnet mask

6/6 The networks entered here are those that are not required to go via the SOCKS server. The default values are the standard local IP address series.

Password A string 6/6 The password associated to SOCKS.UserName.

Server socks An IP address or a host name

6/6 Host name or IP address of the server providing the SOCKS service. If using a host name, a DNS server must be specified in the TCP/IP network settings.

ServerPort 1080 An unsigned integer

6/6 The TCP port number used by the SOCKS server.

ServerType 4 4, 6/6 The version number of the SOCKS server.

5

UserName A string 6/6 If using authentication on a SOCKS5 server, enter the user name here.

2.1.38 StatusLED Description: This group controls the behavior of the status LED.

Configuration file: /etc/sysconfig/statusled.conf


[StatusLED]

Parameter name

Default value

Valid values


Description

FlashInterval 4 1 ... 30 6/6 The flash interval when StatusLED.Usage is flash.

Usage on off, on, flash

6/6 Status LED behavior during normal operation. off = off. on = green. flash = flashes when image is displayed.

2.1.39 System Description: Parameters for HTTP access to the device.

Configuration file: /etc/httpd/conf/boa.conf, /etc/sysconfig/rootpassword.conf


[System]

Parameter name

Default value

Valid values


Description

BoaPort 80 1 ... 65535 6/6 HTTP port number.

AlternateBoaPort 0 0 ... 65535 6/6 Secondary HTTP port number. Disable by setting it to zero. This parameter is set automatically when NAT traversal is enabled.

BoaProtViewer password password, anonymous

6/6 password = Password is required to access the view pages. anonymous = Anybody on the network can access the product's view pages (but not the Admin tools) in a browser, and without having to log in.

HTTPPort 80 80 6/7 HTTP port number.

HTTPViewerPort 2000 2000 6/7 HTTP port number for viewer/recorder API.

BoaDSCP 0 0 ... 63 6/6 The Differentiated Services Codepoint for Boa QoS.

RootPwdSet Product dependent

yes, no 1

6/6 Set to yes if root password has been changed.


2.1.40 System.BoaGroupPolicy Description: Parameters for HTTP/HTTPS access to the device. Setting the parameter values to "https" or "both", assume the HTTPS.HTTPS.Enabled parameter is enabled.

Configuration file: /etc/httpd/conf/boa.conf


[System.BoaGroupPolicy]


axadmin http http, https, both

6/6 Policy for Admin group.

axoper http http, https, both

6/6 Policy for Operator group.

axview http http, https, both

6/6 Policy for View group.

2.1.41 Time Description: Common time information which tell the time zone, how date and time is synchronized and the offset related to the chosen time zone and Coordinated Universal Time, UTC.

Configuration file: /etc/sysconfig/time_handler.conf, /etc/sysconfig/systime.conf


[Time]

Parameter name

Default value

Valid values


Description

ObtainFromDHCP yes yes, no

6/6 DHCP servers may provide names/IP addresses for local/remote NTP servers. Enable this feature by setting this parameter to yes.

ServerDate A date 6/6 The date (yyyy-mm-dd) when the Axis device's time was set manually or synchronized with the computer.

ServerTime A time 6/6 The time (hh:mm:ss) when the Axis device's time was set manually or synchronized with the computer.

SyncSource Product dependent

PC, NTP, None1

6/6 The source to synchronize the time with; PC, NTP or None (manually).

TimeZone GMT GMT-12, ...

6/6 Time zone.

GMT-1, GMT, GMT+1, ... GMT+12

UTCOffset 00:00:00 A time 6/6 Time difference (hh:mm:ss) between the time zone and Coordinated Universal Time (UTC). -01:00:00 = -1 hour, i.e. 1 hour after UTC. 00:00:00 = 0 hour, 01:00:00 = 1 hour, i.e. before UTC.


2.1.42 Time.DST Description: Contain parameters required to manage Daylight Saving Time, DST.

Configuration file: /etc/sysconfig/time_handler.conf


[Time.DST]

Parameter name

Default value

Valid values


Description

Enabled no yes, no

6/6 Enable/disable DST (Daylight Saving Time)

Offset 01:00:00 A time 6/6 The amount of time the clock should be turned back/forward (hh:mm:ss), due to DST.

StartDay 0 1 ... 31 0 ... 6

6/6 The meaning of StartDay depends on StartTypeOfDate. If StartTypeOfDate is 0 (exact date) the StartDay should be interpreted as the day of the month. Otherwise StartDay indicates the number of days since Sunday in the range 0 to 6.

StartMonth 0 0 ... 11 6/6 The number of months since January in the range 0 to 11.

StartTime 00:00:00 A time 6/6 Indicates the time (hh:mm:ss) when DST should be enabled. StartTime = 02:00:00 means that DST should be enabled two hours after midnight.

StartTypeOfDate 0 -1, 0, 1 ... 31

6/6 DST can either start on an exact date, or a specific weekday of the month. StartTypeOfDate indicates how to interpret StartDay. If 0, then StartDay is an exact date, otherwise it is a weekday. 0 = StartDay is an exact date (1-31). -1 = The weekday specified by StartDay is the last in the month. 1 to 31 = The first weekday specified by StartDay that has a date larger than or equal to this.

Example: StartTypeOfDate = 0 StartDay = 12 The 12th of the month

Example2: StartTypeOfDate = -1 StartDay = 0 The last Sunday of the month

Example 3: StartTypeOfDate = 1 StartDay = 5

The first Friday of the month

Example 4: StartTypeOfDate = 15 StartDay = 0 The third Sunday of the month

StopDay 0 1 ... 31 0 ... 6

6/6 The meaning of StopDay depends on StopTypeOfDate. If StopTypeOfDate is 0 (exact date) then StopDay should be interpreted as the day of the month. Otherwise StopDay indicates the number of days since Sunday in the range 0 to 6.

StopMonth 0 0 ... 11 6/6 The number of months since January in the range 0 to 11.

StopTime 00:00:00 A time 6/6 Indicates the time (hh:mm:ss) when DST should be disabled. StopTime = 02:00:00 means that DST should be disabled two hours after midnight.

StopTypeOfDate 0 -1 0 1 ... 31

6/6 DST can either end on an exact date, or a specific weekday of the month. See the description of StartTypeOfDate above.

2.1.43 Time.NTP Description: Contain parameters required when setting time and date with the NTP protocol.

Configuration file: /etc/sysconfig/time_handler.conf


[Time.NTP]

Parameter name

Default value

Valid values


Description

Server 0.0.0.0 An IP address or a host name

6/6 The NTP server to connect to when synchronizing the time in the Axis device.

Update 01:00:00 A time 6/6 Time interval (hh:mm:ss) between connections to the NTP server.

VolatileServer An IP address or a host name

6/7 The name/IP address of the NTP server, received from the DHCP server. Only one NTP server is currently supported. The NTP server name/IP address will be valid only until the next DHCP renewal or reboot.

2.2 JPEG/MJPEG/MPEG

2.2.1 Image Description: Common image parameters used for all image configurations.

Configuration files: /etc/sysconfig/image_global.conf, /etc/sysconfig/image_text.conf, /etc/sysconfig/image_overlay.conf, /etc/sysconfig/image_stream_mode.conf


[Image]


Valid values Security level (get /set)

Description

DateFormat * YYYY.MM.DD Www, Www.Mmm DD, YYYY, Www.DD.MM.YYYY, YYYY-MM-DD, Www Mmm D YYYY, MM/DD/YYYY1

4/6 Date format used in text overlay.

MaxViewers 20 1 ... 20 4/4 Max number of simultaneous viewers (does not affect multicast delivery).

NbrOfConfigs 1 in one-input products 5 in four-input products (4 inputs + Quad)

An unsigned integer (Read only)

4/7 Number of image configurations.

OverlayPath A path 4/4 The path to the overlay image.

OwnDateFormat %F A string 4/6 A string specifying an own date format used in the text overlay. Wildcard patterns, e.g. %H, %M, %S, etc, may be used in the string. See the product's on-line help pages for more info on wildcard patterns.

OwnDateFormat Enabled

no yes, no

4/6 Enable/disable an own date format in the text overlay.

OwnTimeFormat %T A string 4/6 A string specifying an own time format used in the text overlay. Wildcard patterns, e.g. %H, %M, %S, etc, may be used in the string. See the product's on-line help pages for more info on wildcard patterns.

OwnTimeFormat Enabled

no yes, no

4/6 Enable/disable an own time format used in the text overlay.

PrivacyMaskType none none, mask_windows

4/4 Must be mask_windows in order to enable privacy mask windows. If set to none normal overlay can be used.

Referrers A URI 4/4 The referrers allowed access to the image stream. URI's separated by ;

ReferrersEnabled no yes, no

4/4 If set to yes, Referrers are used.

TimeAccuracy no yes, no

4/4 Time accuracy used in the time in the text overlay. no = Time accuracy in seconds. yes = Time accuracy in 1/100 seconds. Product dependent parameter.

TimeFormat 24 12, 24

4/6 Time format used in text overlay.

TimeResolution 1 1, 100

4/4 The resolution of the time used in the text overlay. 1 = 1 second. 100 = 1/100 second.

TriggerDataEnabled no yes, no

6/6 Enable/disable the triggerd daemon which is responsible for including trigger data in the video stream. You must set this parameter to "yes" in order to make the Image.I#.TriggerData parameters work.

* The default value for this parameter is product specific. 1 Product-dependent. Check the product specification.

2.2.2 Image.I# Description: Image configuration. Contains the name of the image configuration and which image source it is connected to.

Configuration file: /etc/sysconfig/image_global.conf


[Image.I#] *

Parameter name

Default value


Description

Name A string 4/4 Name of the configuration.

Source 0 in one-input products # in four-input products

0 ... (in products with 1 ImageSource), 0 ... 4 (in products with 4 ImageSource (4 inputs + Quad))

4/4 The ImageSource.I# this Image.I# configuration is connected to.

* Note: The # is replaced with a group number starting from zero, e.g. Image.I0.

2.2.3 Image.I#.Appearance Description: Image appearance parameters (resolution, compression, rotation) for each image configuration.

Configuration file: /etc/sysconfig/image_appearance.conf


[Image.I#.Appearance] *



Description

ColorEnabled yes yes, no

4/4 yes = The image is coded with color information. no = The image is coded without color information, i.e. a black and white image.

Compression 30 0 ... 100 4/4 The level of image compression. High compression reduces the file size. Low compression produces optimum picture quality, but larger file sizes. MPEG-4: The compression setting maps to the qscale used when quantizing the video stream. This mapping has been made in such a way as to give as similar

result as using the same setting for M-JPEG.

Resolution Product dependent

1600x1200, 1280x1024, 1024x768, 800x600, 4CIF, 768x576, 704x576, 704x480, CIF, 384x288, 352x288, 352x240, QCIF, 192x144, 176x144, 176x120, 2CIF, 704x288, 704x240, 2CIFEXP, 704x288x2, 704x240x2, VGA, 640x480, 480x360, 320x240, 240x180 160x1201 Widescreen resolutions: 1600x900, 1280x720, 1024x576, 800x450, 640x360, 480x270, 320x180, 240x135, 160x901

4/4 The image resolution. Note: Available resolutions are product dependent. The parameter Properties.Image.Resolution shows which resolutions are supported by the product. Please also note that Properties.Image.Resolution in products with widescreen support will only show the resolutions currently available, according to which resolution mode is used (ImageSource.I0. Sensor.WidescreenEnabled).

Rotation 0 0, 90, 180, 2701

4/4 Rotates the image clockwise. 0 = Normal. 180 = Shows the image upside-down.

SquarePixelEnabled no yes, no

4/4 Enable/disable square pixel (aspect ratio) correction. Applies only to video servers.

* Note: The # is replaced with a group number starting from zero, e.g. Image.I0.Appearance. 1 Product-dependent. Check the corresponding Property parameter.

2.2.4 Image.I#.MPEG Description: Parameters related to the generation and format of the MPEG stream.

Configuration file: /etc/sysconfig/image_mpeg.conf


[Image.I#.MPEG] *



Description

ProfileLevel 245 1 ... 253 4/4 The MPEG-4 Profile and Level to use. The profile determines the tools available when generating the stream (e.g., interlace, B frames), and the level limits the resource usage (e.g., max bit rate). The specified value should correspond to the available profiles and levels according to Annex G of ISO/IEC 14496-2:2003. Suggested profile and level combinations and their corresponding parameter values can be found in the table below.

VideoObjectType advanced_ simple

advanced_simple, simple, core, main

4/4 The Video Object Type (VOT) to use for the MPEG-4 stream. The specified VOT must be supported by the specified Profile & Level (see the description for the ProfileLevel parameter above).

ConfigHeaderInterval 5 An integer 4/4 The interval at which configuration headers are inserted into the MPEG stream before a GOV, i.e., a value of five would insert configuration headers before every fifth GOV. A configuration header is always inserted at the start of the stream. The value 0 indicates that no extra configuration headers are inserted.

ICount1 1 1 ... 4/4 The number of I frames per GOV.

PCount1 Product dependent

0 ... 4/4 The number of P frames per I frame.

BCount1 0 0 ... 10 4/4 The number of B frames per I frame and P frame. Only available in products that support B frames.

ResyncMarkerEnabled yes yes, no

4/4 If set to yes, Video Packet Headers with resynchronization information are inserted after each row of macroblocks.

UserDataEnabled no yes, no

4/4 Enable/disable insertion of user data in the MPEG GOV header such as product information, time stamps and trigger data. Note: This parameter will be introduced and set to no by default in firmware versions higher than 4.20. The user data is included by default in earlier firmware versions.

CyclicIBlockRefresh no yes, no

4/4 Instead of using I- and P-frames (which are frames consisting of just I- or just P-blocks) you can use frames with mixed I- and P-blocks. There is a cyclic rotation of which blocks in the frame are I- respectively P-blocks so that after n frames all blocks have been updated with an I-block. Cyclic refresh gives a smoother bit rate and can be useful if there is limited bandwidth available.

Optimization Product dependent

yes, no

4/4 When using full resolutions (VGA/4CIF) resolutions, this parameter can be set to yes to increase the frame rate. Note however that, depending on the amount of motion, this will increase the required bandwidth for each frame. Thus it is not recommended to combine optimization with bit rate limitation settings.

* Note: The # is replaced with a group number starting from zero, e.g., Image.I0.MPEG. 1 The GOV length can be calculated as: GOV length = ICount * (1 + PCount + (1 + PCount) * BCount)

Suggested profile and level combinations and their corresponding parameter values:

Param value Profile and Level Supported tools Max bit rate (kbit/s) Supported VOTs

8 Simple Profile @ Level 0 64 simple




33 Core Profile @ Level 1 B frames 384 simple, core

34 Core Profile @ Level 2 B frames 2000 simple, core

50 Main Profile @ Level 2 Interlace, B frames 2000 simple, main



240 Advanced Simple Profile @ Level 0 B frames 128 simple, advanced_simple




247 Advanced Simple Profile @ Level 3B B frames 1500 simple, advanced_simple

244 Advanced Simple Profile @ Level 4 Interlace, B frames 3000 simple, advanced_simple

245 Advanced Simple Profile @ Level 5 Interlace, B frames 8000 simple, advanced_simple

2.2.5 Image.I#.Overlay Description: Image overlay parameters for each image configuration.

Configuration file: /etc/sysconfig/image_overlay.conf


[Image.I#.Overlay] *

Parameter name

Default value


Description

Enabled no yes, no

4/4 Whether to show the overlay image or not. The overlay image is stored in a file given by the parameter Image.OverlayPath.

XPos 0 An unsigned integer

4/4 The overlays upper left corner is positioned at this horizontal position (0 = to the left).

YPos 0 An unsigned integer

4/4 The overlays upper left corner is positioned at this horizontal position (0 = to the top).

* Note: The # is replaced with a group number starting from zero, e.g. Image.I0.Overlay.

2.2.6 Image.I#.Overlay.MaskWindows Description: Privacy mask parameters for each image configuration.

Configuration file: /etc/sysconfig/image_privacy_mask.conf


[Image.I#.Overlay.MaskWindows] *


Color black black, grey, white,

4/4 The privacy mask color.

red

* Note: The # is replaced with a group number starting from zero, e.g. Image.I0.Overlay.MaskWindows

2.2.7 Image.I#.Overlay.MaskWindows.M# Description: Privacy mask parameters for each image configuration.

Configuration file: /etc/sysconfig/image_privacy_mask.conf


[Image.I#.Overlay.MaskWindows.M#] *

Parameter name

Default value


Description

Enabled no yes, no

4/4 Enable/disable privacy mask.

XPos 0 An unsigned integer

4/4 The overlays upper left corner is positioned at this horizontal position (0=to the left).

YPos 0 An unsigned integer

4/4 The overlays upper left corner is positioned at this vertical position (0=to the top).

Width 0 An unsigned integer

4/4 Width of the specified mask.

Height 0 An unsigned integer

4/4 Height of the specified mask.

* Note: The # is replaced with a group number starting from zero, e.g. Image.I0.Overlay.MaskWindows.M0

2.2.8 Image.I#.RateControl Description: Parameters to control the bit rate (bandwidth) from the server.

Configuration file: /etc/sysconfig/image_ratecontrol.conf


[Image.I#.RateControl] *

Parameter name

Default value

Valid values


Description

Mode vbr vbr, cbr

4/4 Specifies whether the rate controller operates in Variable Bit Rate (VBR) or constant bit rate (CBR) mode.

Priority framerate none, quality, framerate

4/4 Whether the rate controller should prioritize frame rate or quality. Not setting a priority means the frame rate and image quality will be affected approximately equally.

TargetBitrate 0 0 ... 10000

4/4 The target bit rate, in kbit/s, for CBR mode.

MaxFPS 30 1 ... 240 4/4 The rate controller will not produce streams with a frame rate higher than this value.

Note 1: The parameter Image.I#.RateControl.Mode must be set to cbr for this parameter to take effect.

Note 2: If also setting the parameter Image.I#.Stream.FPS to a value, the lowest value will apply for the MPEG-4 stream.

MinFPS 1 1 ... 240 4/4 The rate controller will try not to produce streams with a frame rate lower than this value.

MaxCompression 100 0 ... 100 4/4 The rate controller will not produce streams with compression higher than this value.

MinCompression 0 0 ... 100 4/4 The rate controller will not produce streams with compression lower than this value. Note: Image.I#.Appearance.Compression overrides this value.

MaxBitrate Product dependent

0 ... 10000

4/4 The maximum allowed bit rate for the stream, in kbit/s. Note: This value may be overridden if the maximum bit rate is set higher than allowed by the ProfileLevel parameter (see the description for the Image.I#.MPEG.ProfileLevel parameter).

* Note: The # is replaced with a group number starting from zero, e.g. Image.I0.Stream.

2.2.9 Image.I#.Stream Description: Image streaming parameters for each image configuration.

Configuration file: /etc/sysconfig/image_stream.conf


[Image.I#.Stream] *

Parameter name

Default value

Valid values


Description

Duration 0 An unsigned integer

4/4 The number of seconds the image stream is streamed for, before being terminated. The default stream time is unlimited.

FPS Product dependent

An unsigned integer

4/4 Limits the frame rate available to each viewer. 0 = unlimited frame rate.

Note 1: That the viewer will actually get the configured frame rate cannot be guaranteed. Not exceeding the configured frame rate, however, is guaranteed.

Note 2: When enabling Constant Bit Rate (the parameter Image.I#.RateControl.Mode is set to cbr) and setting the parameter Image.I#.RateControl.MaxFPS to a value, the

lowest fps value will apply for the MPEG-4 stream.

NbrOfFrames 0 An unsigned integer

4/4 The number of frames transmitted to each viewer. The maximum frame rate is hardware dependent. 0 = The maximum possible frame rate.

Note: The viewer is not guaranteed the configured frame rate. It is however, guaranteed that it will not exceed the configured fps.

* Note: The # is replaced with a group number starting from zero, e.g. Image.I0.Stream.

2.2.10 Image.I#.Text Description: Image text overlay parameters for each image configuration.

Configuration file: /etc/sysconfig/image_text.conf


[Image.I#.Text] *

Parameter name

Default value


Description

BGColor black white, black, transparent, semitransparent

4/4 Text background color.

ClockEnabled no yes, no

4/4 Shows the time at the Position in the image.

Color white white, black

4/4 Text color.

DateEnabled no yes, no

4/4 Shows the date at the Position in the image.

Position top top, bottom

4/4 Positions text at top or bottom of the image.

String A string 4/4 The text to show at the Position in the image.

TextEnabled no yes, no

4/4 Shows the String at the Position in the image.

* Note: The # is replaced with a group number starting from zero, e.g. Image.I0.Text.

2.2.11 Image.I#.TriggerData Description: The following parameters controls inclusion of trigger data in the video stream.

Configuration file: /etc/sysconfig/image_trigger_data.conf


[Image.I#.TriggerData] *

Valid values


Description

AudioEnabled yes yes, no

4/4 Enable inclusion of audio trigger states for image configuration #. Setting it to "yes" will include the states of all audio triggers in the trigger data for this image configuration. If you just want to include some audio triggers you should set it to "no" and use the UserTriggers parameter instead.

IOEnabled yes yes, no

4/4 Enable inclusion of digital input states for image configuration #. Setting this parameter to "yes" will include the states of all digital inputs in the trigger data for this image configuration. If you just want to include some digital inputs you should set it to "no" and use the UserTriggers parameter instead.

MotionDetectionEnabled yes yes, no

4/4 Enable inclusion of motion detection states for image configuration #. Setting this parameter to "yes" will include the motion detection states of the windows that belong to this image configuration in the trigger data. If you just want to include some window states or window states belonging to other image configurations you should set it to "no" and use the UserTriggers parameter instead.

MotionLevelEnabled no yes, no

4/4 Enable inclusion of motion detection levels for image configuration #. Setting this parameter to "yes" will include the motion detection levels of the windows that belong to this image configuration in the trigger data. If you just want to include some window levels or window levels belonging to other image configurations you should set it to "no" and use the UserTriggers parameter instead.

TamperingEnabled yes yes, no

4/4 Enable inclusion of camera tampering trigger states for image configuration #. Setting it to "yes" will include the camera tampering state of the image configuration in the trigger data. If you want to include camera tampering states for other image configurations you should use the UserTriggers parameter.

VideoLossEnabled yes yes, no

4/4 Enable inclusion of video loss status for image configuration #. Setting this parameter to "yes" will include the video loss status of the image configuration in the trigger data. If you want to include video loss states for other image configurations you should use the UserTriggers parameter.

UserTriggers A string 4/4 This string enables inclusion of user defined triggers for image configuration #. The string should be in the format "<trigger1>; <trigger2>; <trigger3>;...". Example: Image.I0. TriggerData. UserTriggers= "M0;M1;M2;M3; ML0;ML1;ML2; ML3;V0;V1;V2;V3"

* Note: The # is replaced with a group number starting from zero, e.g. Image.I0.TriggerData. * Note: The camera must be restarted for these parameters to take effect.

2.2.12 ImageSource Description: The number of image sources (video inputs/chips or CCD/CMOS chips).

Configuration file: /etc/sysconfig/image_source_global.conf


[ImageSource]

Parameter name


Description

NbrOfSources 1 in one-input products 4 in four-input products


0/7 Number of image sources/inputs.

2.2.13 ImageSource.I# Description: The name of the image source.

Configuration file: /etc/sysconfig/image_source.conf


[ImageSource.I#] *

Parameter name



Description

Name Video in one-input video products. Video #+1 in four-input video products. Camera in sensor products.

A string 4/4 Name of the image source/input.

* Note: The # is replaced with a group number starting from zero, e.g. ImageSource.I0.Name.

2.2.14 ImageSource.I#.DayNight Description: Parameters related to the behaviour of the IR cut filter. This parameter group is product dependent and only available in some network cameras.

Configuration file: /etc/sysconfig/imagesource_daynight.conf


[ImageSource.I#.DayNight] *

Parameter name

Default value

Valid values


Description

IrCutFilter auto yes, no, auto

4/4 The behaviour of the IR cut filter. yes = IR filter always enabled. no = IR filter always disabled. auto = IR filter removed in low light environments.

* Note: The # is replaced with a group number starting from zero, e.g. ImageSource.I0.Video.

2.2.15 ImageSource.I0.DCIris

Description: DC iris parameters for each image source. This parameter group is product dependent and only available in network cameras. Check the product specification for supported parameters, default values and valid values.

Configuration file: /etc/sysconfig/imagesource_dcirirs.conf


[ImageSource.I0.DCIris]

Parameter name

Default value

Valid values


Description

Enabled yes yes, no

4/4 Enable/disable DC Iris. If set to "yes" the DC Iris will be used to control exposure in situations with very high levels of light. If set to "no" the exposure control will be done entirely using gain and exposure time.

2.2.16 ImageSource.I0.Sensor Description: Parameters for each CCD/CMOS image source. This parameter group is product dependent and only available in network cameras. Check the product specification for supported parameters, default values and valid values.



[ImageSource.I0.Sensor]



Description

AFLowSensitivity off on, off

4/4 Improves auto focus stability in low lightning.

AutoSlowShutter on on, off

4/4 This setting only apply when Exposure is set to auto. on = allows camera to use slower shutter in low light environments. off = keep a fixed shutter speed.

BackLight off on, off

4/4 Will make darker objects in the foreground appear clearer if the background is very bright.

BacklightCompensation no yes, no

4/4 Will make darker objects in the foreground appear clearer if the background is very bright.

BlacklevelCorrection 0 0, 1

4/4 Reduces the impact of diffuse light in the scene the camera is looking at, improving the image contrast. 0 = Disabled 1 = Enabled

Brightness 50 0 ... 100 4/4 The image brightness.

ColorLevel 50 0 ... 100 4/4 The image color level.

Contrast 50 0 ... 100 4/4 The image contrast.

Exposure auto auto, hold, flickerfree50, flickerfree60, manual

4/4 The image exposure. Note: Valid values are product dependant.

ExposurePriority 50 50, 100, 0

4/4 The balance between image quality and the frame rate. Higher image quality may reduce frame rate and increase motion blur. A prioritized frame rate may instead increase the image noise. 50 = None. 100 = Prioritize frame rate. 0 = Prioritize image quality.

ExposureWindow center full, center, upper, lower, left, right

4/4 Define which part of the image that should influence the auto exposure the most.

GainThreshold Hardware dependent

0 ... 100 4/4 Decides how much gain the exposure control algorithm may use to avoid lowering the framerate. The values are defined the same way as for MaxGain. If MaxGain < GainThreshold then GainThreshold is effectively set to MaxGain.

MaxExposureTime 1000000 -60 ... 20000001

4/4 If the value is negative it represents a number of frames of the framerate the hardware generates. E.g. if the hardware generates 30 fps then -5 gives a maximum exposure time of 5/30s = 167ms. If the value is positive then it represents a number of micro seconds. E.g. the value 1000000 represents 1s.

MaxGain 100 0 ... 100 4/4 Decides how much gain the exposure control algorithm is allowed to use. 0 = the algorithm will never use more than the minimum allowed by the hardware. 100 = the algorithm can use any gain setting the hardware supports. The scale is linear in dB. If the hardware requires 10 dB gain min but allows 20 dB max then setting MaxGain to 50 will allow gain between 10 dB and 15 dB.

NightVision auto auto, on, off

4/4 Will increase sensitivity in low light environments when on.

NoiseReduction off off, low, high

4/4 The level of noise reduction in image.

Sharpness Product dependent

Product dependent

4/4 The image sharpening.

Shutter Hardware Dependent

Hardware Dependent

4/4 The time an image is exposed. Image.I0. Sensor.Exposure must be set to "manual" in order for this parameter to take effect.

Stabilizer off on, off

4/4 Stabilizes vibrations.

WhiteBalance auto auto, hold, fixed_outdoor, fixed_outdoor1, fixed_outdoor2, fixed_indoor, fixed_fluor, fixed_fluor1, fixed_fluor21

4/4 The image white balance.

WidescreenEnabled no yes, no

4/4 Enable/disable widescreen (16:9) resolutions. Note: While widescreen is enabled, no normal (4:3) resolutions are available. The Properties.Image. Resolution will show currently available resolutions. All open video streams will be closed when changing this parameter.

1Product-dependent. Check the product specification.

2.2.17 ImageSource.I#.Video Description: Parameters for each video image source. This parameter group is product dependent. Check the product specification for supported parameters, default values and valid values.



[ImageSource.I#.Video] *

Parameter name

Default value

Valid values


Description

XOffset 0 An unsigned integer

4/4 Entering a value for this parameter changes the horizontal synchronization for the image. This can be used to eliminate any black border surrounding the image. Be careful to only use low values, no more than 1 ... 3, as higher values may put the image out of sync.

YOffset 0 An unsigned integer

4/4 Entering a value for this parameter changes the vertical synchronization for the image. This can be used to eliminate any black border surrounding the image. Be careful to only use low values, no more than 1 ... 3, as higher values may put the image out of sync.

Connector bnc bnc, yc

4/4 If bnc connector used or yc. Note that if yc is used it is used via a converter cable which connects to video in and video out. It is only possible to do this on a single port video server.

DetectedType none none, pal, ntsc

4/7 Which type of video source that is connected.

DeinterlaceMode none none, field_blend

4/4 Enable/disable de-interlacing on video.

* Note: The # is replaced with a group number starting from zero, e.g. ImageSource.I0.Video.

2.3 Sequence

2.3.1 Sequence Description: Contains parameters that determine which video sources that are to be used in sequence mode and how they are used.

Configuration file: /etc/dynamic/sequence.conf

Template: sequence


[Sequence.S#] *

Parameter name

Default value


Description

Name A string 4/4 The name of the sequence.

NbrOfSources 0 An unsigned integer

4/4 The number of configured sources for this sequence.

RandomEnabled no yes, no

4/4 The sources/inputs used in sequence mode should be shown in random order.

* Note: The # is replaced with a group number starting from zero, e.g. Sequence.S0.

2.3.2 Sequence.S#.Source.S# Description: Properties for a video source, internal or external, that are used in sequence mode.

Configuration file: /etc/dynamic/sequence.conf

Template: source


[Sequence.S#.Source.S#] *

Parameter name

Default value


Description

Number An unsigned integer

4/4 A number that combined with Sequense.S#.Type uniquely identifies the source to be used.

Time 10 1 ... 3600 4/4 The time to show this Image source/input in sequence mode. Value in seconds.

Type Video Ext, Quad, Preset

4/4 The type of source to use.

* Note: The # is replaced with a group number starting from zero, e.g. Sequence.S0.Source.S0.

2.4 Guard Tour

2.4.1 GuardTour.G# Description: Contains parameters to create PTZ guard tours.

Configuration file: /etc/dynamic/guardtour.conf

Template: guardtour


[GuardTour.G#] *

Parameter name


Description

Running no yes, no

4/4 Enable/disable the guard tour.

Name GuardtourName A string 4/4 The name of the guard tour.

CamNbr 1 An unsigned integer

4/4 The camera number.

RandomEnabled no yes, no

4/4 Enable/disable to display the preset positions in random order.

* Note: The # is replaced with a group number starting from zero, e.g. GuardTour.G0.

2.4.2 GuardTour.T#.Tour.T# Description: The PTZ preset positions that are included in the guard tour.

Configuration file: /etc/dynamic/guardtour.conf

Template: tour


[GuardTour.G#.Tour.T#] *



Description

PresetNbr 0 An unsigned integer

4/4 The number of the PTZ preset position.

Position 1 An unsigned integer

4/4 In which order to view this preset position.

Movespeed 70 An unsigned integer

4/4 The speed at which to move the camera to this preset position.

WaitTime 10 An unsigned integer

4/4 The view time for this preset position in seconds or minutes.

WaitTimeViewType Seconds Seconds, Minutes

4/4 The time unit for the WaitTime.

* Note: The # is replaced with a group number starting from zero, e.g. GuardTour.G0.Tour.T0.

2.5 PTZ Note! Unless otherwise noted, write able parameters may not be directly modified by for instance CGI calls to param.cgi. Instead parameter modification is achieved implicitly by various PTZ CGI calls. For instance, PTZ.PTZDrivers.Driver# is set by the PTZ framework when a driver is installed. Setting it directly however, will cause inconsistencies.

2.5.1 PTZ

Description: Various Pan Tilt Zoom parameters. All write able parameters may be directly modified.

Configuration file: /etc/ptz/ptz.conf


[PTZ]



Description

BoaProtPTZOperator anonymous password, anonymous

6/6 password = password is required to control PTZ units and to use control queue. anonymous = anybody on the network have access to above in a browser, and without having to log in.

CameraDefault 1 1 ... n (n = number of cameras)

6/6 The camera number used if camera parameter is omitted in HTTP requests.

NbrOfCameras Hardware specific

1 ... (Read only) 6/7 Number of camera ports.

NbrOfSerPorts Hardware specific

1 ... (Read only) 6/7 Number of serial ports.

Warning A string 0/7 Holds the latest warning issued by the PTZ framework. Only used by web pages, e.g. when a parameter value was truncated due to limit restrictions. Shall be reset to an empty string when the warning has been alerted to the user.

2.5.2 PTZ.PTZDrivers Description: List of installed PTZ drivers.



[PTZ.PTZDrivers]

Parameter name

Default value

Valid values


Description

Driver# none A string 6/7 The name of the driver currently installed on index#.

DriverNone none none (Read only)

6/7 To facilitate web page implementation using auto generation of HTML forms.

2.5.3 PTZ.PTZDriverFirmwares Description: Specifies the hardware/firmware the driver is built for. Used internally to detect incompatibilities between driver and platform.



[PTZ.PTZDriverFirmwares]

Parameter name

Default value


Description

Driver#Major none A string (Auto generated). (The string is currently generated from build type, uClibc version and PTZ library version)

6/7 Handles firmware compatibility.

Driver#Minor none A string (Auto generated). (The string is currently generated from build type, uClibc version and PTZ library version)


2.5.4 PTZ.TargetFirmwares Description: Specifies the hardware/firmware the PTZ driver is installed on. Used internally to detect incompatibilities between driver and platform.



[PTZ.TargetFirmwares]

Parameter name

Default value


Description

Driver#Major none A string (auto generated)


Driver#Minor none A string (auto generated)


2.5.5 PTZ.PTZDriverVersions Description: List of versions for installed PTZ drivers.



[PTZ.PTZDriverVersions]

Parameter name

Default value

Valid values


Description

Driver#Version none A string 6/7 The version number of the driver installed on index#.

2.5.6 PTZ.SerDrivers Description: List of PTZ drivers associated with serial ports.



[PTZ.SerDrivers]

Parameter name

Default value

Valid values


Description

Ser#Driver none A string 6/7 The name of the driver currently associated with serial port #.

SerNoneDriver none none (Read only)

6/7 To facilitate web page implementation using auto generation of HTML forms.

2.5.7 PTZ.SerDriverVersions Description: List of versions for PTZ drivers associated with serial ports.



[PTZ.SerDriverVersions]

Parameter name

Default value

Valid values


Description

Ser#Version none A string 6/7 The version number of the driver currently associated with serial port #.

2.5.8 PTZ.SerDriverStatuses Description: List of statuses for PTZ drivers associated with serial ports.



[PTZ.SerDriverStatuses]

Parameter name

Default value

Valid values


Description

Ser#Status 0 0 ... 3 6/7 The status of the driver installed on serial port #. To be translated into current language according to:

0 - no driver installed.

1 - installation file invalid or incompatible.

2 - driver malfunction.

3 - driver installed.

2.5.9 PTZ.CamPorts Description: Mapping from camera numbers to serial ports.


[PTZ.CamPorts]

Parameter name

Default value

Valid values


Description

Cam#Port -1 -1, 1 ...

6/7 Maps camera to serial port, -1 means unmapped.

2.5.10 PTZ.Driver# Description: These groups are created dynamically when a driver is installed, based on the configuration file of the driver. '#' denotes the index for the driver when installed. The parameters here are only used as default values for other parameter groups.

2.5.10.1 Per serial port

When a driver installed on index is associated with serial port <j>, parameter values from group PTZ.Driver.Serial.S0 are copied into group Serial.Ser<j>. The construction with S0 merely reflects internal implementation of dynamic parameter group handling and has no significance.

For valid values and description of each parameter, see Serial Port where the same parameters are listed in the group Serial.Ser#.

Configuration file: /etc/dynamic/ptz.conf


[PTZ.Driver#.Serial.S0]

Parameter name Default value Valid values Valid value (get/set) Description

PortMode see Serial Port 6/6 see Serial Port

see Serial Port 6/6

2.5.10.2 Per camera

An absolute operation means moving to a certain position, relative operation means moving relative to the current position. Below the value is true if the operation is supported by the driver installed on index #. CGI parameters referred to apply to the PTZ control section in Axis Video HTTP API.



[PTZ.Driver#.Support.S0]

Parameter name

Default value

Valid values


Description

AbsolutePan false true, false

0/6 true if absolute pan is supported.

RelativePan false true, false

0/6 true if relative pan is supported.

AbsoluteTilt false true, false

0/6 true if absolute tilt is supported.

RelativeTilt false true, false

0/6 true if relative tilt is supported.

AbsoluteZoom false true, false

0/6 true if absolute zoom is supported.

RelativeZoom false true, false

0/6 true if relative zoom is supported.

DigitalZoom false true, false

0/6 true if digital zoom is supported.

AbsoluteFocus false true, false

0/6 true if absolute focus is supported.

RelativeFocus false true, false

0/6 true if relative focus is supported.

AutoFocus false true, false

0/6 true if autofocus is supported.

AbsoluteIris false true, false

0/6 true if absolute iris is supported.

RelativeIris false true, false

0/6 true if relative iris is supported.

AutoIris false true, false

0/6 true if autoiris is supported.

ContinuousPan false true, false

0/6 true if continuous pan is supported.

ContinuousTilt false true, false

0/6 true if continuous tilt is supported.

ContinuousZoom false true, false

0/6 true if continuous zoom is supported.

ContinuousFocus false true, false

0/6 true if continuous focus is supported.

ContinuousIris false true, false

0/6 true if continuous iris is supported.

Auxiliary false true, false

0/6 true if the CGI parameter "auxiliary=<string>" is supported.

ServerPreset false true, false

0/6 true if the "serverpreset" CGI parameters are supported.

DevicePreset false true, false

0/6 true if the "devicepreset" CGI parameters are supported.

SpeedCtl false true, false

0/6 true if the CGI parameter speed=<int> is supported.

JoyStickEmulation false true, false

0/6 true if it is possible to emulate joy-stick behavior.

IrCutFilter false true, false

0/6 true if the CGI parameter ircutfilter=<string> is supported (see valid values for PTZ.Driver #.Various.V0.IrCutFilter).

AutoIrCutFilter false true, false

0/6 true if infrared cut filter can be inserted/removed automatically.

Backlight false true, false

0/6 true if the CGI parameter backlight=<string> is supported (see valid values for PTZ.Driver #.Various.V0.Backlight).

OSDMenu false true, false

0/6 true if OSD menu is supported

ActionNotification Hardware dependent

true, false

0/7 true if the PTZ driver can send messages to other internal applications when it starts and stops movements. Makes it possible to trigger events on arrival to a preset position.

ProportionalSpeed Hardware dependent

true, false

0/7 true if the product support proportional speed when using the command continuouspantiltmove, i.e. adjusting the movement speed in the image proportional to the zoom level used.

GenericHTTP false true, false

0/6 true if the product support generic HTTP, i.e. support direct communication with the PTZ unit using serial.cgi.

LensOffset false true, false

0/6 true if the lens offset parameters are supported.

When it is possible to obtain the current position from the driver, e.g. the current pan position, it is also possible to apply limit restrictions to the requested operation. For instance, if an absolute pan to position 150 is requested, but the upper limit is set to 140, the new pan position will be 140. This is the purpose of all but the last two parameters here, whose purpose is to calibrate image centering.



[PTZ.Driver#.Limit.L0]

Parameter name

Default value

Valid values1


Description

MinPan -180 -180 ... 180

0/6 Lower limit for pan position.

MaxPan -180 -180 ... 180

0/6 Upper limit for pan position.

MinTilt -180 -180 ... 180

0/6 Lower limit for tilt position.

MaxTilt -180 -180 ... 180

0/6 Upper limit for tilt position.

MinZoom 1 1 ... 9999 0/6 Lower limit for zoom position.

MaxZoom 9999 1 ... 9999 0/6 Upper limit for zoom position.

MinFocus 1 1 ... 9999 0/6 Lower limit for focus position.

MaxFocus 9999 1 ... 9999 0/6 Upper limit for focus position.

MinIris 1 1 ... 9999 0/6 Lower limit for iris position.

MaxIris 9999 1 ... 9999 0/6 Upper limit for iris position.

MinFieldAngle 1 1 ... 1000 0/6 Minimal field angle for the (zoom) lens, used to calibrate image centering.

MaxFieldAngle 30 1 ... 1000 0/6 Maximal field angle for the (zoom) lens, used to calibrate image centering.

1 May be overridden by configuration file for driver. Maximal value must be >= minimal value.



[PTZ.Driver#.Various.V0]


Valid values1


Description

CtlQueueing false true, false

0/4 true if control queuing is enabled. If enabled, access to controlling the PTZ unit is limited to the client currently possessing the control.

CtlQueueLimit 20 1 ... 100 0/4 Maximal number of clients in control queue.

CtlQueuePollTime 20 5 ... 3600

0/4 The maximum time in seconds between poll-requests, which an existing client in the control queue must send, to stay active in the queue.

CamId -1 An integer

0/6 Identifies a PTZ unit (camera) on a serial port, often set by a dip switch on the unit.

DeviceType A string 0/6 Used by the driver to handle minor differences for the same device.

PanEnabled true true, false

0/6 true if pan is enabled.

TiltEnabled true true, false

0/6 true if tilt is enabled.

ZoomEnabled true true, false

0/6 true if zoom is enabled.

FocusEnabled false true, false

0/6 true if focus is enabled.

AutoFocus false true, false

0/6 true if autofocus is enabled.

AutoIris false true, false

0/6 true if autoiris is enabled

HomePresetSet true true, 0/6 true if there is any home preset position available,

false should not be directly modified.

IrCutFilterEnabled false true, false

0/6 true if there is a possibility to remove/insert the infrared cut off filter.

IrCutFilter on on, off, auto2

0/6 on if infrared cut filter is enabled.

BackLightEnabled false true, false

0/6 true if there is possibility to use backlight compensation.

BackLight false true, false

0/6 true if backlight compensation is used.

ProportionalSpeedEnabled * true, false

0/6 true if the product support proportional speed when using the command continouspantiltmove, i.e. adjusting the movement speed in the image proportional to the zoom level used.

MaxProportionalSpeed 200 1 ... 1000

0/6 The maximum continuous movement speed in 1/100 of fields of view per second. Example: 200 = max 2.00 fields of view per second.

LensOffsetX 0 -9999 ... 9999

0/6 x coordinate of sensor center to lens center vector; unit is 1/10000 of the sensor width. Used by the areazoom CGI parameter. Only applicable if the driver support lens offset.

LensOffsetY 0 -9999 ... 9999

0/6 y coordinate of sensor center to lens center vector; unit is 1/10000 of the sensor height. Used by the areazoom CGI parameter. Only applicable if the driver support lens offset.

1 Integer ranges may be overridden by configuration file for driver. 2 Only valid if PTZ.Driver#.Support.S0.AutoIrCutFilter is true. * Product dependent.

In addition to above groups Support, Limit and Various, there are 2 driver-specific groups, UserBasic and UserAdv. The parameters in these groups are determined by the configuration file of the driver and are hence not known in advance. They are instead described on the help pages that come with the driver installation.

2.5.11 Camera parameter groups When a camera is mapped to a serial port with a driver associated, dynamic parameter groups corresponding to 2.5.10.2 are created and initiated with values from the driver groups. E.g. when camera is mapped to a serial port associated with driver <j>, groups PTZ.Support.S, PTZ.Limit.L, etc, are created and initiated with values from PTZ.Driver<j>.Support.S0 PTZ.Driver<j>.Limit.L0, etc.

All these parameters may be directly modified.

2.5.12 PTZ.PresetPos A dynamic parameter group PTZ.PresetPos.P# is created for each new preset position. # merely denotes the number of the dynamic parameter group and has no connection to any preset position numbers mentioned below.

Description: Dynamic parameter groups, each representing a preset position.

[PTZ.PresetPos.P#]

Parameter name

Default value


Description

Pos None A : 2 delimited string with the following content: <Name>: A valid preset position name according to the PTZ control section in Axis Video HTTP API. <Type>: server, device <No>: 1, ... for <Type> = server, -1 for <Type> = device <DevicePresetNo>: An integer <DriverNo>: 1, ... <CamNo>:1, ... <Pan>: -180 ... 1801, 10000 <Tilt>: -180 ... 1801, 10000 <Zoom>: 1 ... 99991, 10000 <Focus>: 1 ... 99991, 10000 <Iris>: 1 ... 99991, 10000 <Home>: true, false

1/7 Holds all necessary information about the preset position. <Name>: The name of the preset position. <Type>: The type of preset position, "server" for server preset positions, "device" for device preset positions. <No>: The number of the server preset position, -1 for device preset positions. <DevicePresetNo>: The number of the device preset position, not significant if <Type> = "server" and the position is not emulated by a driver preset position. <DriverNo>: The number (index) of the concerned driver. <CamNo>: The number of the concerned camera. <Pan>: The pan position if known, else 10000. <Tilt>: The tilt position if known, else 10000. <Zoom>: The zoom position if known, else 10000. <Focus>: The focus position if known, else 10000. <Iris>: The iris position if known, else 10000. <Home>: true if the preset position is the home position for the camera, else false.

Example of a server preset position (number 3) emulated by a device preset position (number 12): Entrance~server:3:12:1: 2:45:-10:10000:10000: 10000:false

Label None Same as <Name> above. 1/7 Exists merely to facilitate web page implementation. Only exists if <Type> above is set to "server".

1 May be overridden by configuration file for driver. 2 Except for Name, delimited by ~.

2.5.13 PTZ.Preset.P# Description: Preset PTZ position configuration.

Configuration file: /etc/sysconfig/digital_ptz.conf


[PTZ.Preset.P#]*

Parameter name

Default value


Description

http://www.axis.com/techsup/cam_servers/dev/cam_http_api_2.htm

http://www.axis.com/techsup/cam_servers/dev/cam_http_api_2.htm

Name Hardware dependent

A string 1/6 The name of the preset configuration.

ImageSource Hardware dependent

0 (in products with 1 ImageSource), 0 ... 4 (in products with 4 ImageSource (4 inputs + Quad)

1/6 The ImageSource.I# this Preset.P# configuration is connected to.

HomePosition 0 An unsigned integer 1/6 The Position.P# group number of the home position.

* Note: The # is replaced with a group number starting from zero, e.g. PTZ.Preset.P0

2.5.14 PTZ.Preset.P#.Position.P# Description: Position and zoom parameters for each preset PTZ position configuration.


Template: position


[PTZ.Preset.P#.Position.P#]*

Parameter name



Description

Name Hardware dependent

A string 1/6 The name of the position.

Data Hardware dependent

A string 1/6 The pan, tilt and zoom values of the position. A ":" delimited string with zero or more of the following "<parameter>=<value>" pairs: pan=<min pan> ... <max pan>1 tilt=<min tilt> ... <max tilt>2 zoom=<min zoom> ... <max zoom>3

* Note: The # is replaced with a group number starting from zero, e.g. PTZ.Preset.P0.Position.P0 1 <min pan> and <max pan> is equal to the values of the parameters PTZ.Limit.L#.MinPan and PTZ.Limit.L#.MaxPan. 2 <min tilt> and <max tilt> is equal to the values of the parameters PTZ.Limit.L#.MinTilt and PTZ.Limit.L#.MaxTilt. 3 <min zoom> and <max zoom> is equal to the values of the parameters PTZ.Limit.L#.MinZoom and PTZ.Limit.L#.MaxZoom.

2.5.15 PTZ.UserCtlQueue.U# Description: Parameters for the different users in the control queue.

Configuration file: /etc/ptz/ptz_user/ctlqueue.conf


[PTZ.UserCtlQueue.U0]

Parameter name

Default value


Description

UserGroup Administrator Administrator (read only)

6/7 Name of the user group.

UseCookie yes yes, 6/6 If users from this user group shall be

no separated by using a cookie or by the user name.

Priority 10 1 ... 100 6/6 The priority value. 1 is the highest value.

TimeoutType activity timespan, activity, infinity

6/6 The timeout type to use.

TimeoutTime 60 1 ... 3600 6/6 The time used for each TimeoutType. The value is ignored when TimeoutType is "infinity".


Parameter name

Default value


Description

UserGroup Operator Operator (read only)


UseCookie yes yes, no

6/6 If users from this user group shall be separated by using a cookie or by the user name.






Parameter name

Default value


Description

UserGroup Viewer Viewer (read only)


UseCookie yes yes, no



TimeoutType timespan timespan, activity, infinity




Parameter name

Default value


Description

UserGroup Event Event (read only)


UseCookie no yes, no







Parameter name

Default value


Description

UserGroup Guardtour Guardtour (read only)





TimeoutType infinity timespan, activity, infinity



PTZ.UserCtlQueue.U# (5 ...)

Configuration file: /etc/dynamic/user_ctlqueue.conf

Template: user_ctlqueue


[PTZ.UserCtlQueue.U#] *

Parameter name

Default value

Valid values


Description

UserGroup Usergroup A string 4/4 Name of the user group.




TimeoutType timespan timespan, activity, infinity



* Note: The # is replaced with a group number starting from five, e.g. PTZ.UserCtlQueue.U5.UserGroup.

2.6 Motion Detection

2.6.1 Motion.M# Description: Contain dynamic parameters, which define the properties of a Motion Detection window.

Configuration file: /etc/dynamic/motion.conf

Template: motion


[Motion.M#] *

Parameter name



Description

Name DefaultWindow A string 4/4 A user's window identification, e.g. "Door" or "Window".

ImageSource 0 0 ... 3 4/4 In Which image source the motion detection window is located.

Left 200 0 ... 9999

4/4 The coordinate for the left boundary of the rectangular motion detection window. The full value range is related to the full image width and 0 is counted from the left hand side of the image.

Right 4000 0 ... 9999

4/4 The coordinate for the right boundary of the rectangular motion detection window. The full value range is related to the full image width and 0 is counted from the left hand side of the image.

Top 200 0 ... 9999

4/4 The coordinate for the upper boundary of the rectangular motion detection window. The full value range is related to the full image height and 0 is counted from the upper side of the image.

Bottom 4000 0 ... 9999

4/4 The coordinate for the bottom boundary of the rectangular motion detection window. The full value range is related to the full image height and 0 is counted from the upper side of the image.

WindowType include exclude, include

4/4 Describes the type of the motion detection window. An exclude window, i.e. do not perform motion detection in the window. An include window, i.e. perform motion detection in the window area.

Sensitivity 90 0 ... 100 4/4 This tunes the "object difference from the background"-sensitivity, i.e. difference in terms of color and/or structure. A high value detects even very small changes and can e.g. trigger on image noise if set too high. A very low value requires on the other hand a very dramatic change with e.g. a dark object appearing in an almost white scene (or vice versa).

History 90 0 ... 100 4/4 This adjusts the motion detection to be more or less sensitive for very fast motion. With a very low value the motion is detected only when a scene has changed but adapts to this changed scene as the new normal scene rapidly. A large value is more conservative and will detect the motion for a larger number of pictures before it consider this as being a normal object in the scene.

ObjectSize 15 0 ... 100 4/4 Defines the size in percent of the object to result in detection. For a small value, even very small changes trigger the detection while a very large value requires a very large object to trigger the detection.

* Note: The # is replaced with a group number starting from zero, e.g. Motion.M0.

2.7 Camera Tampering

2.7.1 Tampering.T# Description: Contain parameters which define the properties of the camera tampering application.

Configuration file: /etc/tampering.conf


[Tampering.T#] *


Valid values


Description

DarkDetectionEnabled yes, no

4/4 Indicates whether dark images should be considered as camera tampering.

MinDuration 20 10 ... 3600

4/4 Sets the minimum consecutive camera tampering time frame (in seconds) before an alarm is raised.

* Note: The # is replaced with a group number starting from zero, e.g. Tampering.T0.

2.8 I/O

2.8.1 Input Description: Parameters for hardware input(s).

Configuration file: /etc/sysconfig/inputs.conf


[Input]

Parameter name


Description

NbrOfInputs Hardware specific


0/7 Number of inputs.

2.8.2 Input.I# Description: Parameters for hardware input(s).

Configuration file: /etc/sysconfig/inputs.conf


[Input.I#] *


Name Input #+1 A string 4/6 The name of the input.

Trig closed open, closed

4/6 Determines when to trig.

* Note: The # is replaced with a group number starting from zero, e.g. Input.I0.

2.8.3 Output Description: Parameters for hardware output(s).

Configuration file: /etc/sysconfig/outputs.conf


[Output]

Parameter name


Description

NbrOfOutputs Hardware specific


0/7 Number of outputs.

2.8.4 Output.O# Description: Parameters for hardware output(s).

Configuration file: /etc/sysconfig/outputs.conf


[Output.O#] *

Parameter name

Default value

Valid values


Description

Name Output #+1 A string 4/6 The name of the output.

Active closed open, closed

4/6 The active state of the output.

Button none none, pulse, actinact

4/6 The button type associated with this output.

PulseTime 0 An integer 4/6 The pulsetime for the pulse button connected to this output, if any.

* Note: The # is replaced with a group number starting from zero, e.g. Output.I0.

2.9 Serial port Description: Controls the functionality/purpose of the serial ports and some configuration that is shared by various applications. Note that some applications have their own settings for baudrate, parity etc.

2.9.1 Serial Configuration file: /etc/sysconfig/serial.conf


[Serial]

Parameter name

Default value


Description

NbrOfPorts Hardware specific


0/7 Number of serial ports.

PurposePort# OFF OFF, TCPIP, PTZ, Generic

6/6 The current usage of the serial port. OFF = Unused.

TCPIP = Serial server.

PTZ = Pan Tilt Zoom. Supports PTZ control and serial port control according to Axis Video HTTP API. Requires an installed PTZ driver.

Generic = Supports serial port control according to Axis Video HTTP API. Works with or without installed PTZ driver.

2.9.2 Serial.Ser# Configuration file: /etc/sysconfig/serial.conf


[Serial.Ser#] *

Parameter name

Default value


Description

PortMode Hardware specific

RS232, RS4851

6/6 Serial port protocol. May be read-only depending on hardware.

BaudRate 9600 300, 600, 1200, 2400, 2400, 4800, 9600, 19200, 38400, 57600, 115200, (for RS485 also 230400 and 460800)

6/6 The baudrate used in the serial communication.

DataBits 8 7, 8

6/6 The number of data bits.

StopBits 1 1, 2

6/6 The number of stop bits.

Parity None None, Even,

6/6 The parity.

Odd

* Note: The # is replaced with a number, e.g. Serial.Ser1. 1Product-dependent. Check the product specification.

2.9.3 Serial.RS485 Configuration file: /etc/conf.d/rs485


[Serial.RS485]


Termination no yes, no

6/6 Enable/disable RS485 termination

Bias no yes, no

6/6 Enable/disable RS485 bias

2.10 Serial server

2.10.1 Sersrvd Description: Contains the settings for the serial server, enabled with Serial.PurposePort#=TCPIP. The serial server allows access to the serial ports using TCP/IP connections, either "raw" TCP/IP or with support for telnet options.

Configuration file: /etc/sersrvd.conf


[Sersrvd.COM#] *

Parameter name Default value Valid values Security level (get/set)

Description

Baudrate 115200 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 Some hardware supports higher baudrates, especially RS485 ports.

6/6 The baudrate used.

DataBits 8 7, 8

6/6 The number of data bits.

Device /dev/ttyS (#-1) (hardware specific)

/dev/ttyS0, /dev/ttyS1, /dev/ttyS2, /dev/ttyS3 (hardware specific)

6/7 The serial device to use.

Mode OFF OFF, AUTO_CONNECT

6/6 The current usage of the serial port determined by the Serial. PurposePort# parameter.

StopBits 1 1, 2

6/6 The number of stop bits.

Parity None None, Even, Odd

6/6 The parity.

FlowControlXONXOFF NO NO, YES

6/6 YES means XON/XOFF flow control is enabled.

FlowControlRTSCTS NO NO, YES

6/6 YES means RTS/CTS flow control is enabled. Not available for 2-wire RS-485 ports. Should be NO if RS485Mode=YES.

RS485Mode Depending on hardware: YES for RS-485 ports, NO for RS-232 and RS-422 ports.

NO, YES

6/6 Normally only to be changed if RS-422 (4-wire) is supported by hardware, or possibly on RS-232 ports with some external RS-232 to RS-485 converter. YES (checked) to enable 2-wire, half duplex mode.

ConnectTo A string of the format <host>:<TCP port number>

6/6 The IP address and port number to use if the serial server should act as a client and connect to another host when data is received through the serial port. E.g. www.site.org: 12345. If no port number is specified, the Listener Port (see below) is used.

ListenerPort 0, 1024 ... 65535

6/6 The TCP Server port to listen on. If 0 or empty, server functionality is disabled for the port.

Timeout 0 0, 1... 99

6/6 If there is no activity on the connection for this time (in seconds), it will be closed. 0 = no timeout/wait forever.

TelnetOptions NO NO, YES

6/6 Set to YES if you want to be able to use telnet options according to RFC2217 in the TCP data stream for controlling settings and pin status.

AllowedUsers A string, a comma separated list of users: <user 1>, <user 2>, ...

6/6 Used to only allow certain users.

AllowedIPAddresses A comma separated list of IP addresses, ranges may be specified. E.g. 1.2.3.4, 2.3.4.5-9, 3.4.5.*

6/6 Used to only allow certain IP addresses to connect to the Listener.

* Note: The # is replaced with a number, e.g. Sersrvd.COM1.

2.11 Events

2.11.1 Event.E# Description: This group defines an event, which is a set of parameters describing how and when the product performs certain actions.

Configuration file: /etc/dynamic/event.conf

Template: event


[Event.E#] *


Valid values


Description

Name NewEvent A string 4/4 The name of the event.

Type T S, T

4/4 Scheduled or Triggered event.

Enabled yes yes, no

4/4 Event enabled (disabled events are never triggered).

Active no yes, no

4/4 If the event is currently triggered.

Priority 1 0, 1, 2

4/4 Execution priority: 0=low. 1=normal. 2=high.

HWInputs xxxx nnnn, where n = {x,0,1,2}

4/4 Hardware input trigger pattern.

x = do not trigger. 0 = trigger on inactivation. 1 = trigger on activation. 2 = trigger on activation change.

Example 1: "1xxx" means trigger when digital input 1 is activated. Example 2: "xx0x" means trigger when digital input 3 is inactivated. Example 3: "x2xx" means trigger when digital input 2 state is changed. Example 4: "1xx1" means trigger when digital input 1 and 4 are activated. Example 5: "xxxx" means don't trigger on hardware inputs. Note: Cannot be combined with SWInputs, use either SWInput or HWInputs.

SWInput A string 4/4 Software input trigger pattern. Virtual Input (manual): IO<no>:<trigger> where the number can be an integer starting from

5, and the trigger can be "/" or "H" for activated and "\" or "L" for inactivated. Example 1: "IO5:H" means trigger when virtual input 5 is active. Example 2: "IO6:L" means trigger when virtual input 6 is inactive.

BOOT:/ means trigger on boot.

Video loss: V<channel no>:\ where channel number can be: 0 ... 3 = trigger when video is lost on the numbered video channel (counted from 0) x = trigger when video is lost on any video channel. Example 1: "V0:\" means trigger when video is lost on video channel 1. Example 2: "Vx:\" means trigger when video is lost on any video channel.

Motion detection: M<motion window no>:<trigger> where trigger can be: / = when motion starts. \ = when motion stops. x = when motion starts or stops. Example 1: "M1:/" means trigger when motion is detected for motion window 1. Example 2: "M1:x" means trigger when motion starts or stops for motion window 1.

PTZ preset position: P<PTZ preset param>:<state> where PTZ preset parameter is the last part of the name of the preset position parameter, PTZ.PresetPos.P#. And where state can be either "/" for when at the PTZ preset position and "\" for when leaving the PTZ preset position, Example 1: "PP1:/" means trigger when at PTZ preset position stored in the parameter PTZ.PresetPos.P1. Example 2: "PP2:\" means trigger when leaving the PTZ preset position stored in the parameter PTZ.PresetPos.P2.

IR cut filter: IR0:<state> where state can be either "\" for when the IR cut filter is turned on and "/" for when the IR cut filter is turned off. Example 1: "IR0:\" means trigger when the IR cut filter is turned on. Example 2: "IR0:/" means trigger when the IR cut filter is turned off.

Tampering: T<no>:/ Example 1: "T0:/" means trigger when camera tampering is detected for camera 1.

Audio: A0:<state> Example 1: "A0:/" means trigger when audio rises above the level specified in Audio.A0.AlarmLevel.

Example 2: "A0:\" means trigger when audio falls below the level specified in Audio.A0.AlarmLevel. Example 1: "A0:x" means trigger when audio passes the level specified in Audio.A0.AlarmLevel.

Temperature: TEMP0:/ Example 1: "TEMP0:/" means trigger when the temperature rises or falls outside of the operating range of the product.

"" means never trigger on software inputs.

Note: Cannot be combined with HWInputs, use either SWInput or HWInputs.

Weekdays 1111111 A string 4/4 Pattern of weekdays when the event should trigger. Example 1: "0111110" means trigger on Monday ... Friday. Example 2: "1000000" means trigger on Sunday.

Starttime 00:00 A time 4/4 Time when the event should start to trigger in format "hh:mm". Example 1: "07:30" means trigger at 7:30 am. Example 2: "19:30" means trigger at 7.30 pm.

Duration 0 A time 4/4 How long the event should trigger in format "hours:minute". Max 168:00 hours.

MinimumTriggerInterval 00:00:00 A string 4/4 Time interval between triggers in format "hours:minutes:seconds", any triggers that occur during the interval are ignored. Max interval is 23:59:59. Example 1: "00:01:30" means the interval between an event trigger and the next trigger for this event will be at least 1 minute and 30 seconds. Example 2: "00:00:00" means the interval is disabled.

Image 0 An unsigned integer

4/4 Image configuration to grab video from.

ImageURLSettingsEnabled no yes, no

4/4 Use specific image settings for this event.

ImageURLSettings A string 4/4 If ImageSettings=yes, this URL contains the image settings to be used.

IncludePreTrigger no yes, no

4/4 Use pre-trigger buffer.

PreTriggerSize 0 An unsigned integer

4/4 Size of the pre-trigger buffer (in number of frames).

PreTriggerUnit** s s, m, h

4/4 Unit for the PretriggerSize parameter in the web interface. s = second.

m = minute. h = hour.

PreTriggerInterval 0 An unsigned integer

4/4 Time interval between frames in the pre-trigger buffer (in milliseconds).

PreTriggerIntervalUnit*** s s, m, h

4/4 Unit for the PretriggerInterval parameter in the web interface. s = second. m = minute. h = hour.

IncludePostTrigger no yes, no

4/4 Use post-trigger buffer.

PostTriggerSize 0 An unsigned integer

4/4 Size of the post-trigger buffer (in number of frames).

PostTriggerUnit** s s, m, h

4/4 Unit for the PosttriggerSize parameter in the web interface. s = second. m = minute. h = hour.

PostTriggerInterval 0 An unsigned integer

4/4 Time interval between frames in the post-trigger buffer (in milliseconds).

PostTriggerIntervalUnit*** s s, m, h

4/4 Unit for the PosttriggerInterval parameter in the web interface. s = second. m = minute. h = hour.

IncludeBestEffort no yes, no

4/4 Use best effort duration.

BestEffortDuration 0 An unsigned integer

4/4 Best effort duration (in number of seconds). If IncludeBestEffort =yes and BestEffortDuration =0, the duration will be as long as the event is triggered.

BestEffortDurationUnit** s s, m, h

4/4 Unit for the BestEffortDuration parameter. s = second. m = minute. h = hour.

Note: this parameter only changes how the value is presented in the web interface: seconds, minutes or hours. The actual parameter value is always in the same unit, seconds.

BestEffortInterval 0 An unsigned integer

4/4 Time interval between frames during best effort (in milliseconds).

BestEffortIntervalUnit*** s s, m, h

4/4 Unit for the BestEffortInterval parameter in the web interface. s = second. m = minute. h = hour.

CreateFolder A string 4/4 Upload path for the event. May contain format fields which will be expanded at the moment the event triggers. Example: "My_Folder_%F_%H_%M_%S" will create a folder named according to the date and time each time the event is triggered.

FileName image.jpg A string 4/4 Base file name for uploaded files.

Suffix %y-%m- %d_%H- %M-%S- %f

A string 4/4 Suffix to base name for uploaded files. Wildcard patterns, e.g. %H, %M, %S, etc, may be used in the suffix. See the product's on-line help pages for more info on wildcard patterns.

MaxSequenceNumber 0 An unsigned integer

4/4 The maximum value of when using a sequence number as file suffix. At this value the counter will wrap to 0.

* Note: the # is replaced with a group number, e.g. Event.E0 ** Note: this parameter only changes how the value is presented in the web interface: seconds, minutes or hours. The actual parameter value is always in the same unit, number of frames. *** Note: these parameters only change how the value is presented in the web interface: seconds, minutes or hours. The actual parameter value is always in the same unit, milliseconds.

2.11.2 Event FTP Actions Description: This group defines an action that uploads files to an FTP server.


Template: ftpaction


[Event.E#.Actions.A#] *

Parameter name

Default value

Valid values


Description

Type U U 4/4 Type of action. U = Upload.

Protocol FTP FTP 4/4 Protocol.

Order 1 0 ... 2 4/4 Execution order. If this event has multiple actions, this parameter determines when this action should be executed. Actions with Order=0 will be executed in parallel (asynchronously). Other actions will be executed synchronously, i.e. one action must finish before next action is executed, in rising order, i.e. first Order=1, then Order=2.

Server blank, F0 ... Fn (n = number

4/4 Primary FTP server ID. Refers to a parameter group under root.EventServers.FTP. Example: "F0" refers to the parameter group

of FTP event servers - 1)

root.EventServers.FTP.F0.

Server2 blank, F0 ... Fn (n = number of FTP event servers - 1)

4/4 Secondary FTP server ID.

* Note: the # is replaced with a group number, e.g. Event.E0.Actions.A0.

2.11.3 Event HTTP Actions Description: This group defines an action that uploads files to an HTTP server, or sends notifications to an HTTP server.


Template: httpaction



Parameter name

Default value

Valid values


Description

Type N N, U

4/4 Type of action. N = Notification. U = Upload.

Protocol HTTP HTTP 4/4 Protocol.


Server H0 ... Hn (n = number of HTTP event servers -1)

4/4 HTTP server ID. Refers to a parameter group under root.EventServers.HTTP. Example: "H0" refers to the parameter group root.EventServers.HTTP.H0.

Message A string 4/4 Message to send. Possible to use dynamic event notification: #e = The event name. #E = The event description. Specified in the file /etc/event_desc.list located in the product's file system. #w = The motion detection window. #t = The trigger type and value. Also other format codes such as file naming and date/time formats can be used.

CustomParams A string 4/4 Custom parameters to add to URL. Example: "foo=bar". Spaces are not allowed in this field and all text must be URI-encoded (RFC2396). Example: to set the CGI parameter 'example' to 'Y & Z' enter example=Y+%26+Z in this field.



2.11.4 Event HW Actions Description: This group defines an action that controls a digital output.


Template: hwaction



Parameter name

Default value

Valid values


Description

Type N N 4/4 Type of action. N = Notification.

Protocol HW HW 4/4 Protocol.


Output 1 1 ... 4 4/4 Output number to activate.

Duration 0 An unsigned integer

4/4 How long the output should be active in seconds, 0 means that the output should be active for as long as the event is triggered.

Unit** s s, m, h

4/4 Unit for the Duration parameter in the web interface.

* Note: the # is replaced with a group number, e.g. Event.E0.Actions.A0. ** Note: this parameter only changes how the value is presented in the web interface: seconds, minutes or hours. The actual parameter value is always in the same unit, seconds.

2.11.5 Event SMTP Actions Description: This group defines an action that sends mail to a mail server.


Template: smtpaction



Parameter name

Default value

Valid values


Description

Type N N, U

4/4 Type of action. N = Notification. U = Upload.

Protocol SMTP SMTP 4/4 Protocol.


EmailTo

A string 4/4 E-mail address.

Subject A string 4/4 Subject line. Possible to use dynamic event notification: #e = The event name. #E = The event description. Specified in the file /etc/event_desc.list located in the product's file system. #w = The motion detection window. #t = The trigger type and value. Also other format codes such as file naming and date/time formats can be used.

Message A string 4/4 Message body. Possible to use dynamic event notification: #e = The event name. #E = The event description. Specified in the file /etc/event_desc.list located in the product's file system. #w = The motion detection window. #t = The trigger type and value. Also other format codes such as file naming and date/time formats can be used.

ImagesPerMail 10 An unsigned integer

4/4 Max number of images to upload in one e-mail.


2.11.6 Event TCP Actions Description: This group defines an action that sends notifications to a TCP/IP server.


Template: tcpaction



Parameter name

Default value

Valid values


Description


Protocol TCP TCP 4/4 Protocol.

Order 1 0 ... 2 4/4 Execution order. If this event has multiple actions, this parameter determines when this action should be executed. Actions with Order=0 will be executed in parallel (asynchronously). Other actions will be executed synchronously, i.e. one action must finish before next action is executed, in

rising order, i.e. first Order=1, then Order=2.

Server T0 ... Tn (n = number of TCP event servers -1)

4/4 TCP server ID. Refers to a parameter group under root.EventServers.TCP. Example: "T0" refers to the parameter group root.EventServers.TCP.T0.

Message A string 4/4 Message to send. Possible to use dynamic event notification: #e = The event name. #E = The event description. Specified in the file /etc/event_desc.list located in the product's file system. #w = The motion detection window. #t = The trigger type and value. Also other format codes such as file naming and date/time formats can be used.


2.11.7 Event PTZ Actions Description: This group defines an action that makes a camera go to a preset PTZ position.


Template: ptzaction



Parameter name

Default value


Description


Protocol PTZ PTZ 4/4 Protocol.


Preset P0 ... Pn (n = max number of preset positions - 1)

4/4 Which PTZ.PresetPos.P# to move to.

Home no yes, no

4/4 Whether to return to the home position after the event.


2.11.8 Event Guard Tour Actions Description: This group defines an action that runs a Guard Tour.


Template: guardtouraction



Parameter name

Default value

Valid values


Description


Protocol GUARDTOUR GUARDTOUR 4/4 Protocol.


Name A string 4/4 Name of the guard tour to run.

Home yes, no

4/4 Whether to return to the home position after the event.


2.12 Event servers

2.12.1 EventServers.FTP.F# Description: This group defines an FTP server that can be used by an event to upload files to.

Configuration file: /etc/dynamic/eventservers.conf

Template: ftp_config


[EventServers.FTP.F#] *

Parameter name

Default value

Valid values


Description

Name NewFTPServer A string 4/4 A descriptive name.

Address An IP address or a host name

4/4 IP address or host name of the server

Login A string 4/4 FTP user name

Password A string 4/4 FTP password.

UploadPath A string 4/4 Directory where uploaded files go.

Port 21 0 ... 65535 4/4 FTP port.

Passive no yes, no

4/4 Use passive FTP.

UseTempFile no yes, no

4/4 Some FTP servers do not allow an existing file to be overwritten by a new file with the same name. When this option is enabled, the new file will be uploaded with a temporary name. The original file is then deleted and the new file is given the original file name.

* Note: the # is replaced with a group number starting from zero, e.g. EventServers.FTP.F0.

2.12.2 EventServers.HTTP.H# Description: This group defines an HTTP server that can be used by an event to upload files to or send notification messages to.


Template: http_config


[EventServers.HTTP.H#] *

Parameter name



Description

Name NewHTTPServer A string 4/4 A descriptive name.

Address A string 4/4 URL to the server, including name of CGI script to handle the request. Example: "http://192.168. 254.10/cgi-bin/ upload.cgi".

Login A string 4/4 HTTP user name

Password A string 4/4 HTTP password.

Proxy An IP address

4/4 Proxy address.

ProxyPort 0 ... 65535 4/4 Proxy port number.

ProxyLogin A string 4/4 Proxy user name.

ProxyPassword A string 4/4 Proxy password.

* Note: the # is replaced with a group number starting from zero, e.g. EventServers.HTTP.H0.

2.12.3 EventServers.TCP.T# Description: This group defines a server that can be used by an event to send TCP/IP notification messages to.


Template: tcp_config


[EventServers.TCP.T#] *

Parameter name

Default value


Description

Name NewTCPServer A string 4/4 A descriptive name.

Address An IP address or a host name

4/4 IP address or host name of the server.

Port 0 ... 65535 4/4 TCP port number to use.

* Note: the # is replaced with a group number starting from zero, e.g. EventServers.TCP.T0.

2.13 Notification

2.13.1 Notify Description: Parameters for sending notification when the IP address is changed.

Configuration file: /etc/sysconfig/notify.conf


[Notify]

Parameter name

Default value

Valid values


Description

AtBoot no yes, no

6/6 no = Do not notify of IP address changes at boot.

KnownIP An IP address

6/6 The IP address known by the id_uploader. When a new IP address is set it is compared to this parameter and notification is made if they differ.

TextField Your text here

A string 6/6 The text to include in the notification.

TextType simple simple, adv, html

6/6 The file can be sent in three different types via FTP: simple = One line containing only the IP address. adv = Multi-line text file containing more information. html = Multi-line text file containing more information with HTML tags added.

2.13.2 Notify.FTP Description: Parameters for notification by FTP.



[Notify.FTP]

Parameter name

Default value

Valid values


Description

Enabled no yes, no

6/6 Enable sending of notifications by FTP.

HostName A hostname 6/6 The IP address or hostname of the FTP server.

PassiveMode no yes, no

6/6 Establish a passive FTP connection.

Password A string 6/6 The password for logging on to the FTP server.

Port 21 0 ... 65535 6/6 FTP port.

UploadPath A string 6/6 The path to where the notification file will be saved on the FTP server.

UserName A string 6/6 The username for logging on to the FTP server.

2.13.3 Notify.HTTP Description: Parameters for notification by HTTP.



[Notify.HTTP]

Parameter name

Default value


Description

Custom A string (URL-encoded string with a leading & sign)

6/6 Additional parameters to Id.HTTPUrl.

Enabled no yes, no

6/6 Enable sending of HTTP GET request to a URL.

Password A string 6/6 The password to Id.HTTPUrl .

Proxy A string 6/6 The proxy server to pass when connecting to Id.HTTPUrl.

ProxyPass A string 6/6 The password for Id.HTTPProxy.

ProxyPort A string 6/6 The port the Id.HTTPProxy listens to.

ProxyUser A string 6/6 The username for Id.HTTPProxy.

Url http:// A URL 6/6 The URL to the cgi-script that will handle the information.

UserName A string 6/6 The username for the Id.HTTPUrl.

2.13.4 Notify.SMTP Description: Parameters for notifications by e-mail.



[Notify.SMTP]

Parameter name

Default value


Description

Enabled no yes, no

6/6 Enable sending notifications by e-mail.

FromEmail An e-mail address 6/6 The e-mail address to include in the "From" field in the e-mail notification.

Subject A string 6/6 The message to include in the "Subject" field in the e-mail notification.

ToEmail An e-mail address or a list of e-mail addresses separated by ;

6/6 The recipient(s) for the e-mail.

2.14 HTTPS

2.14.1 HTTPS Description: Enable/disable HTTPS (Hypertext Transfer Protocol over Secure Socket Layer, or HTTP over SSL). HTTPS is a web protocol that provides encryption for page requests from users and for the pages returned by the web server. The encrypted exchange of information between server and client is governed by the use of an HTTPS certificate, which guarantees the authenticity of the server.

Configuration file: /etc/conf.d/stunnel


[HTTPS]

Parameter name

Default value

Valid values


Description

Enabled no yes, no

6/6 Enable/disable HTTPS.

Port 443 1 ... 65535 6/6 Which port number the HTTPS server shall be listening on.

2.15 SNMP

2.15.1 SNMP Description: SNMP (Simple Network Management Protocol) configuration.

Configuration file: /etc/snmp/snmpd.conf, /etc/conf.d/snmpd, /tmp/snmpv3_initial_user_pw_tmp


[SNMP]


Valid values


Description

Enabled no yes, no

6/6 Enable/disable SNMP.

V1 no yes, 6/6 Enable/disable SNMP V1

no

V1ReadCommunity public A string 6/6 The community name used for SNMP V1/V2c read operations.

V1WriteCommunity write A string 6/6 The community name used for SNMP V1/V2c write operations.

V2c no yes, no

6/6 Enable/disable SNMP V2c.

V3 no yes, no

6/6 Enable/disable SNMP V3.

InitialUserPasswd SNMP V3 initial user password.

InitialUserPasswdSet no yes, no

6/6 Set to yes if initial user password is set.

DSCP 0 0 ... 63 6/6 The Differentiated Services Codepoint for SNMP QoS.

2.16 Properties Description: Contains information about the firmware and system of the product. It also contains information about product dependent functionality and functionality that have no ordinary parameters. All user levels should be able to access the property parameters.

Note: The Properties parameters are product dependent. If a parameter does not exist, the functionality is not supported.

2.16.1 Properties.API Configuration file: /usr/etc/param/par_prop_api_http.conf


[Properties.API.HTTP]

Parameter name

Default value


Description

Version An unsigned integer

0/7 The supported HTTP API version (only the first digit).

2.16.2 Properties.Audio Configuration file: /usr/etc/param/par_prop_audio.conf


[Properties.Audio]

Parameter name

Default value

Valid values


Description

Audio yes, no

0/7 The product has audio support.

Format A string 0/7 The supported formats separated by commas, e.g. g711,g721,g723.

2.16.3 Properties.Firmware Configuration file: /usr/etc/param/par_prop_firm.conf


[Properties.Firmware]

Parameter name

Default value


Description

BuildDate A string 0/7 The build date for the current firmware in use.

BuildNumber An unsigned integer

0/7 The build number for the current firmware in use.

Version A string 0/7 The firmware version in use.

2.16.4 Properties.GuardTour Configuration file: /usr/etc/param/par_prop_guardtour.conf


[Properties.GuardTour]


GuardTour1 yes, no

0/7 The product has Guard Tour support.

1 Product dependent. If the parameter does not exist, the functionality is not supported.

2.16.5 Properties.HTTPS Configuration file: /usr/etc/param/par_prop_https.conf


[Properties.HTTPS]


HTTPS1 yes, no

0/7 The product has HTTPS support.


2.16.6 Properties.Image Configuration file: /usr/etc/param/par_prop_image.conf


[Properties.Image]

Parameter name

Default value

Valid values

Security level

Description

(get/set)

Format A string 0/7 The supported formats separated by commas. E.g. jpg,mjpeg,mpeg4,bitmap.

Resolution A string 0/7 The supported resolutions separated by commas. E.g. 4CIF,CIF,QCIF. Note: In products with widescreen support, only the currently available resolutions will be shown, i.e. enabling/disabling widescreen mode will affect the value of this parameter.

Rotation A string 0/7 The supported image rotations separated by commas. E.g. 0,90,180,270. For products not supporting image rotation the value is 0.

2.16.7 Properties.ImageSource Configuration file: /usr/etc/param/par_prop_image.conf


[Properties.ImageSource]


DCIris1 A string 0/7 The product has DC Iris support.


2.16.8 Properties.Motion Configuration file: /usr/etc/param/par_prop_motion.conf


[Properties.Motion]

Parameter name

Default value

Valid values


Description

Motion1 yes, no

0/7 The product has Motion Detection support.


2.16.9 Properties.PTZ Configuration file: /usr/etc/param/par_prop_ptz.conf


[Properties.PTZ]

Parameter name

Default value

Valid values


Description

PTZ1 yes, no

0/7 The product has Pan Tilt Zoom support.

DigitalPTZ1 yes, no

0/7 The product has digital Pan Tilt Zoom support.


2.16.10 Properties.Recorder Security level (create/delete): 7/7

[Properties.Recorder]


Recorder1 yes, no

0/7 The product has recorder support.


2.16.11 Properties.System Configuration file: /usr/etc/param/par_prop_sys.conf


[Properties.System]


HardwareID A string 0/7 The hardware ID for the product.

Language A string 0/7 The current language in use.

SerialNumber A string 0/7 The unit's serial number.

2.16.12 Properties.Tampering Configuration file: /usr/etc/param/par_prop_tampering.conf


[Properties.Tampering]

Parameter name

Default value

Valid values


Description

Tampering yes yes, no

0/7 The product has camera tampering support.

2.16.13 Properties.TemperatureSensor Configuration file: /usr/etc/param/par_prop_temperaturesensor.conf


[Properties.TemperatureSensor]


Valid values


Description

TemperatureSensor yes, no

0/7 The product has a temperature sensor.

2.17 Web interface

2.17.1 ExternalVideo Description: Parameters that define the properties of an external video source.

Configuration file: /etc/dynamic/externalvideo.conf

Template: external_video


[ExternalVideo.E#] *

Parameter name



Description

ImagePath http:// A string 4/4 The path to the image stream. Example: http://10.13.10.56/axis-cgi/mjpg/video.cgi

Name "New video source"

A string 4/4 The name on the external video source.

Password A string 4/4 The password on the external server.

UserName

A string 4/4 The username on the external server.

VideoFormat mjpeg mjpeg, mpeg4

4/4 The video format to be shown.

* Note: the # is replaced with a group number starting from zero, e.g. ExternalVideo.E0.

2.17.2 Layout Description: Parameters that define how the live view page looks and works.

Configuration file: /etc/sysconfig/layout.conf


[Layout]



Description

AACIntallationEnabled yes yes, no

4/4 Decides whether a client is allowed to install the AAC decoder by downloading it from the server.

AMCRecordMedia 0 0 ... 3 4/4 Show AMC record button. Media is recorded as follows: 0 = Disabled

1 = Video 2 = Audio 3 = Audio and Video (2 and 3 are only valid for products with audio support)

Axis yes yes, no

4/4 Use Axis layout.

DefaultVideoFormat mjpeg mjpeg, mpeg4

4/4 The default video format to be shown.

DefaultViewerMode mjpeg mjpeg 4/4 Specify default viewer mode.

LiveViewVideo 1 or quad

1 (in products with 1 ImageSource) 1 ... 4, quad (in products with 4 ImageSources)

4/4 The image configuration to display on the Live View page by default.

MPEGInstallationEnabled yes yes, no

4/4 Decides whether a client is allowed to install the MPEG-4 decoder by downloading it from the server.

OwnBGColor white A string 4/4 Selected background color. A string describing a color, readable by the browser or an RGB value, e.g. #6699CC.

OwnBGColorEnabled no yes, no

4/4 Use own background color.

OwnHomePageEnabled no yes, no

4/4 Use own uploaded home page.

OwnHomePagePath dummy A path 4/4 Selectlist. Shows uploaded html pages. The path from /usr/html/local to the html pages

OwnTextColor black A string 4/4 Selected text color. A string describing a color, readable by the browser or an RGB value, e.g. #1199AA.

OwnTextColorEnabled no yes, no

4/4 Use own text color.

PlainConfigEnabled no yes, no

4/4 Enable Plain Config as default setup pages.

SetupLinkEnabled yes yes, no

4/4 Show setup link.

ShowAMCToolbar yes yes, no

4/4 Show AMC toolbar.

ShowBackLightButton no yes, no

4/4 Show backlight button.

ShowIRFilterButton no yes, no

4/4 Show IR filter button.

ShowIRLightButton no yes, 4/4 Show IR light button.

no

ShowVideoFormatDropDown yes yes, no

4/4 Show video format drop down.

ShowVideoFormatSelection yes yes, no

4/4 Show video format selection list on Live View page.

SnapshotEnabled yes yes, no

4/4 Show snapshot button.

ViewerIE activex activex, java, still

4/4 Method to view video stream in Internet Explorer.

ViewerOther spush spush, java, still

4/4 Method to view video stream in browser other than IE.

2.17.3 Layout.Banner Description: Parameters that define the properties of the banner (if any) at the top of the live view page.



[Layout.Banner]

Parameter name

Default value

Valid values


Description

Address http:// A URL 4/4 If Layout.Banner.Source = external, get the image from this address.

Link none none, own

4/4 Use the banner as a link.

LinkURL http:// A URL 4/4 URL to where the banner leads if Layout.Banner.Link = own.

Path dummy A path 4/4 Selectlist. Shows uploaded images. The path from /usr/html/local to the uploaded images.

Source none none, own, external

4/4 Show banner. none = no banner. own = banner from Layout.BannerSelect. external = banner from Layout.BannerAddress.

2.17.4 Layout.BGPicture Description: Parameters for the background picture on the live view page.



[Layout.BGPicture]

Parameter name

Default value

Valid values


Description

Address http:// A URL 4/4 If BGPicture.Source = external, get the image from this address.


Source none none, own, external

4/4 Show background picture. none = no background picture. own = background picture from Layout.BGPictureSelect external = background picture from Layout.BGPictureAddress.

2.17.5 Layout.CustomLink Description: The properties for custom links at the bottom of the live view page.



[Layout.CustomLink.C#] *

Parameter name

Default value

Valid values


Description *

Enabled no yes, no

4/4 Use custom link #.

Name Custom link #+1

A string 4/4 Name on custom link #.

URL http:// A URL 4/4 Links to e.g. cgi-scripts for PTZ, external web pages etc. NOTE: Not for opening external web pages. (Leads to a hidden frame)

Usage cgi cgi, web

4/4 Specifies if the custom link is a link to a cgi-script (answer will be sent to a hidden frame) or to a web page (opens in a new window).

* Note: the # is replaced with a group number starting from zero, e.g. Layout.CustomLink.C0.

2.17.6 Layout.Description Description: Descriptive text under the video image.



[Layout.Description]

Parameter name



Description

Source default none, default, own

4/4 Show description text below image. none = no description. default = use the default description. own = description from Layout.OwnDescription.

String Description text below image

A string 4/4 Description text below image.

2.17.7 Layout.Logo Description: The properties of the logo (if any) at the top left on the live view page.



[Layout.Logo]

Parameter name

Default value

Valid values


Description

Address http:// A URL 4/4 If Layout.Logo.Source = external, get image from this address.

Link default none, default, own

4/4 Use the logo as a link. none = no logo link. default = use the default link. own = logo link from Layout.Logo.LinkURL.

LinkURL http:// A URL 4/4 URL to where the logo leads if Layout.LogoLink = own.


Source none none, default, own, external

4/4 Show logo. none = no logo. default = default logo. own = logo from Layout.LogoSelect. external = logo from Layout.LogoAddress.

2.17.8 Layout.Title Description: Title text above video image.



[Layout.Title]

Parameter name



Description

Source default none, default,

4/4 Show title. none = no title.

own default = use the default title. own = title from Layout.Title.String.

String Title text above image

A string 4/4 Title text above image.

2.17.9 Layout.Trigger Description: Properties for the trigger buttons.



[Layout.Trigger.T#] *


Enabled no yes, no

4/4 Show trigger button.

* Note: the # is replaced with a group number starting from zero, e.g. Layout.Trigger.T0.

2.18 Wireless

2.18.1 Network.Wireless Description: Parameters for wlan (802.11b) settings. To setup these parameters, check your wireless access point and use same settings in your Axis device. These parameters are also in a text file, CONFIG.TXT, accessible over USB.

Configuration file: /etc/conf.d/wlan.eth0


[Network.Wireless]

Parameter name

Default value


Description

ESSID A string, up to 32 alphanumeric characters are accepted, but no space characters.

6/6 The name of the wireless network the Axis device is configured for. The name must be exactly the same as used in the wireless access point, or the connection will not be established. ESSID is called SSID by some vendors. Note: Leaving this parameter blank means that the Axis device will attempt to access the nearest open network.

Mode auto managed, ad-hoc, auto

6/6 The type of wireless network to associate with, managed (using an access point), ad-hoc (not using an access point) or auto. Auto should only be used in factory default situations.

2.18.2 Network.Wireless.W0 Description: Parameters for wlan (802.11b) settings. To setup these parameters, check your wireless access point and use same settings in your Axis device. These parameters are also in a text file, CONFIG.TXT, accessible over USB.



[Network.Wireless.W0]

Parameter name

Default value

Valid values


Description

Method WPA-PSK WPA-PSK 6/6 Security method.

Enabled no yes, no

6/6 Enable/disable WPA-PSK security.

GenerationMethod psk-phrase

psk-phrase, psk-hex

6/6 Defines which of the parameters below that is used as pre-shared key.

Passphrase A string, 8 - 63 ascii chars

6/6 The passphrase must match the passphrase in the wireless access point. When passphrase is used, the parameter GenerationMethod must be set to "psk-phrase".

Key 64 Hex chars

6/6 The key must match the key in the wireless access point. When key is used, the parameter GenerationMethod must be set to "psk-hex".

2.18.3 Network.Wireless.WEP Description: Parameters for WEP encryption of wlan (802.11b). To setup these parameters, check your wireless access point and use same settings in your Axis device. These parameters are also in a text file, CONFIG.TXT, accessible over USB.



[Network.Wireless.WEP]

Parameter name

Default value


Description

Authentication open open, shared

6/6 The WEP authentication method.

Enabled no yes, no

6/6 Enable/disable WEP encryption over the wireless link.

KeyLength 128 64, 128

6/6 Set the strength of the wireless encryption.

GenerationMethod manual manual, ASCII, passphrase

6/6 This parameter must tell which of the parameters below that is used and how to interpret them. Manual hex always works, while ASCII and passphrase are easier to remember.

Passphrase A string of 31 characters

6/6 The passphrase must match the passphrase in the wireless access point. When passphrase is used, parameter

GenerationMethod must be set to "passphrase"

Key1 A string 6/6 The keys must match the keys in the wireless access point. They could either be in hex format or in ASCII and must match parameter GenerationMethod, see above. Hex (manual) - the string must be exactly 10 hex characters for 64-bit WEP and 26 hex characters for 128-bit WEP. (Hex chars are 0123456789ABCDEF)

ASCII - The string must be exactly 5 characters for 64-bit WEP and 13 characters for 128-bit WEP.

Key2 A string 6/6

Key3 A string 6/6

Key4 A string 6/6

ActiveKey 1 1 ... 4 6/6 Which key to use when transmitting. The key should be changed every now and then, to increase the security of the wireless connection.

2.19 Audio

2.19.1 Audio Description: Common audio parameters used for all audio configurations.

Configuration file: /etc/sysconfig/audio.conf


[Audio]



Description

ConnectedClients 0 0 ... value of the parameter MaxListeners (Auto generated)

1/4 Number of clients receiving audio (regardless type of transport protocol).

ConnectedPostClients 0 0, 1 (Auto generated)

1/4 Number of clients transmitting audio.

DSCP 0 0 ... 63 6/6 The Differentiated Services Codepoint for audio QoS.

DuplexMode full full, half, post, get

1/4 How the audio should be transferred. full = Full duplex - simultaneous two-way audio. Transmit and receive audio at the same time. half = Half duplex - non simultaneous two-way audio. Audio only allowed in one direction at a time. post = Simplex. Audio to the server. get = Simplex. Audio from the server.

ForwardOnPost no yes, no

4/4 The audio transferred from a client to the server, is also transferred to the other clients, i.e. the server is relaying audio.

Note: This only works in half-duplex mode.

MaxListeners Product dependent

0 ... 10 or 0 ... 20 (product dependent)

1/4 Max number of simultaneous clients (does not affect multicast delivery).

NbrOfConfigs Product dependent

An unsigned integer

4/7 Number of audio configurations. The default value is product dependent. 1 for products with one image source and 5 for products using four image sources (4 inputs + Quad).

ReceiverBuffer 120 0 ... 9999 4/4 The receiving audio buffer size in milliseconds (ms).

2.19.2 Audio.A# Description: Audio configuration. The name of the audio configuration, which audio source it is connected to and whether it should be enabled or not.

Configuration file: /etc/sysconfig/audio.conf


[Audio.A#] *

Parameter name

Default value

Valid values


Description

Enabled no yes, no

1/4 Enable/disable this audio configuration.

HTTPMessageType singlepart singlepart, multipart

1/4 How the audio should be streamed. Some proxies require multipart streaming.

Name A string 4/4 The name of the configuration.

Source 0 An integer 4/4 Which AudioSource.A# this Audio.A# configuration is connected to.

AlarmLevel 50 0 ... 100 4/4 The audio intensity level that triggers an audio alarm, defined in percent. Audio alarms can be used as a trigger to start image upload, different types of notifications, PTZ movement etc.

AlarmResolution 50 0 ... 100 4/4 The length of the sample that the audio alarm calculation is based on. For each sample, the mean level is calculated. If the mean exceeds the AlarmLevel, an alarm is generated. This parameter is expressed as a percentage of a block of 1024 samples, i.e. 50% corresponds to 512 samples. The actual sample time depends on the sample rate. For 8 khz, 512 samples corresponds to 64 ms. A shorter AlarmResolution makes the alarm calculation more sensitive.

AlarmLowLimit 10 0 ... 10000

4/4 Defines the lowest audio intensity level used for audio alarms.

AlarmHighLimit 6500 0 ... 10000

4/4 Defines the highest audio intensity level used for audio alarms.

* Note: the # is replaced with a group number starting from zero, e.g. Audio.A0.

2.19.3 AudioSource Description: The number of audio sources (audio inputs/chips).

Configuration file: /etc/sysconfig/audio_source.conf


[AudioSource]

Parameter name

Default value


Description

NbrOfSources 1 An unsigned integer

0/7 Number of audio sources (audio input/chips).

2.19.4 AudioSource.A# Description: Parameters for each audio source (audio input/chip).

Configuration file: /etc/sysconfig/audio_source.conf


[AudioSource.A#] *



Description

AcousticEchoCancellingEnabled yes yes, no

4/4 Suppress audio from speakers that go to the microphone. This parameter works on outgoing sound from the server.

AudioEncoding Hardware dependent

g711, g721, g723 aac1

1/4 The audio codec to use.

BitRate Encoder dependent

G711: 64000 G726: 24000, 32000 AAC (8 khz): 8000, 16000, 24000, 32000 AAC (16 khz): 16000, 24000, 32000, 48000, 64000

4/4 The output bit rate (bits per second) from the encoder.

InputGain 0 mute, -60, -57, -54 ... -3, 0, 3,

4/4 Gain settings in dB for sound received from client.

6 ... 21, 24, 27, 30

InputPreGain high low, high

4/4 Pre amplifier. Ability to compensate for different signal levels.

InputType Hardware dependent

internal, mic, line2

4/4 Where the audio shall be captured from and on which level.

LineEchoCancellingEnabled no yes, no

4/4 Suppress audio from speakers go to the microphone. This parameter works on incoming sound from the client.

MicrophonePower off on, off

4/4 Enable/disable power on audio input connector.

Name Audio A string 4/4 Name of the audio source (audio input/chip).

NoiseCancellingAttenuation 0 0, 8, 13, 17

4/4 Set the level of noise reduction.

NoiseCancellingIOGain 18 0, 6, 12, 18

4/4 Set the noise threshold value.

OutputGain 0 mute, -60, -57, -54 ... -3, 0, 3, 6 ... 21, 24, 27, 30

4/4 Gain setting in dB for sound transmitted to client(s).

SampleRate Hardware dependent

80002 160002

4/4 The clock rate for the audio sampling.

SlopeFilterEnabled yes yes, no

4/4 If yes a filter reduces noise by filtering out all frequencies below 100 Hz and all above 3500 Hz.

* Note: the # is replaced with a group number starting from zero, e.g. AudioSource.A0 1 Product-dependent. Check the corresponding Property parameter. 2 Product-dependent.

2.20 Recorder

2.20.1 Recorder Description: Common recorder parameters used for all recorder configurations.


[Recorder]


DateFormat YYYY-MM-DD YYYY-MM-DD, DD-MM-YYYY

6/6 Date format used in text overlay.

2.20.2 Recorder.Source.S#

Description: Configuration of each video source to record video from. The name of the video source, the IP address, login parameters, frame rate for live view and configuration of the recording channels.


[Recorder.Source.S#] *


Valid values


Description

IPAddress An IP address

6/6 The network address of the camera.

Name A string 6/6 The friendly name of the camera.

MultiportSourceNbr none 1 ... 4, quad, none

6/6 Port number for multi-port video servers.

FramerateLive 30 30, 15, 10, 6, 5, 3, 2, 1, 1/2, 1/3, 1/5, 1/10, 1/15, 1/20, 1/30, 1/60

6/6 Frame rate to use for live view.

UserName A string 6/6 The user name for accessing the camera.

Password A string 6/6 The password for accessing the camera.

Description A string 6/6 A description of the camera.

* Note: the # is replaced with a group number, e.g. Recorder.Source.S0

2.20.3 Recorder.Source.S#.AlarmChannel Description: Configuration of the channel for alarm recordings for a specific video source. Recording settings such as frame rates, recording time and the type of alarm trigger, the maximum disk quota to use and if overwrite of recordings shall be enabled when the disk quota limit is reached.


[Recorder.Source.S#.AlarmChannel] *

Parameter name Default value Valid values


Description

ChannelNbr 0 ... 15 6/6 The number of this channel.

Overwrite yes yes, 6/6 Enable/disable overwrite of

no recordings on this channel.

DiskQuota <available total recording size>/<total number of channels>

11 ... 6/6 Max disk usage for this channel. Unit: MB.

FramerateCamera 30 30, 15, 10, 6, 5, 3, 2, 1, 1/2, 1/3, 1/5, 1/10, 1/15, 1/20, 1/30, 1/60

6/6 Frame rate to use for recordings triggered by the camera.

FramerateLocal 30 30, 15, 10, 6, 5, 3, 2, 1, 1/2, 1/3, 1/5, 1/10, 1/15, 1/20, 1/30, 1/60

6/6 Frame rate to use for recordings triggered by local trigger, e.g. I/O input.

TriggerType none camera, local, none

6/6 Type of alarm trigger.

MaxRecordingTime 1 ... 1440 6/6 Max recording time for alarm recordings triggered by camera. Unit: minutes


2.20.4 Recorder.Source.S#.ScheduleChannel Description: Configuration of the channel for manual and scheduled recordings for a specific video source. Frame rate, the maximum disk quota to use and if overwrite of recordings shall be enabled when the disk quota limit is reached.


[Recorder.Source.S#.ScheduleChannel] *

Parameter name



Description

ChannelNbr 0 ... 15 6/6 The number of this channel.

Overwrite yes yes, 6/6 Enable/disable overwrite of

no recordings on this channel.

DiskQuota <available total recording size>/<total number of channels>

11 ... 6/6 Max disk usage for this channel. Unit: MB.

FramerateManual 30 30, 15, 10, 6, 5, 3, 2, 1, 1/2, 1/3, 1/5, 1/10, 1/15, 1/20, 1/30, 1/60

6/6 Frame rate to use for manual recordings.


2.20.5 Recorder.QuadPattern.Q# Description: Quad pattern configuration. Configuration of which video source to view in the quad patterns.


[Recorder.QuadPattern.Q#] *


Valid values


Description

Name A string 6/6 A friendly name of the pattern.

LeftTopSource 1 ... 8 6/6 Source number for the camera in the left top corner.

LeftBottomSource 1 ... 8 6/6 Source number for the camera in the left bottom corner.

RightTopSource 1 ... 8 6/6 Source number for the camera in the right top corner.

RightBottomSource 1 ... 8 6/6 Source number for the camera in the right bottom corner.

* Note: the # is replaced with a group number, e.g. Recorder.QuadPattern.Q0

2.21 AXIS 292 Network Video Decoder Description: The parameters in this section are specific for the AXIS 292 Network Video Decoder. The parameter configuration files differ from other Axis products. All parameters for permanent storage are stored in /etc/axisconf.d/parameters.dat. All parameters stored temporarily in RAM can be found in the file /var/tmp/parameters.dat. These parameters can be synced to the permanent parameter file. All temporary status parameters are in the file /var/tmp/status.dat.

2.21.1 Alarm Description: Contains parameters for the Alarm events in the Network Video Decoder.

Configuration file: /etc/axisconf.d/parameters.dat(FLASH), /var/tmp/parameters.dat (RAM)


[Alarm]

Parameter name

Default value

Valid values


Description

DisplayTime 30 1 ... 3600 6/6 The time in seconds that an incoming alarm will be showed.

Enabled yes yes, no

6/6 Enable/disable to show incoming alarms.

Port 2048 1 ... 65535 6/6 The port used for incoming alarms.

2.21.2 Buttons Description: Contains parameters for the video select button on the Network Video Decoder.

Configuration file: /etc/axisconf.d/parameters.dat(FLASH), /var/tmp/parameters.dat (RAM)


[Buttons]


Valid values


Description

VideoSelectEnabled yes yes, no

6/6 Enable/disable the video select button on the front panel.

2.21.3 Encoder.E# Description: Parameters for an encoder, i.e. a camera/streamer on the network.

Configuration file: /etc/axisconf.d/parameters.dat (FLASH), /var/tmp/parameters.dat (RAM)

Template: encoder


[Encoder.E#] *



Description

Address An IP address or a DNS address

6/6 The address of the camera/streamer to connect to.

AutoEnabled yes yes, no

6/6 Enable this source in auto mode.

Compression default default, 0 ... 100

6/6 This is valid for MJPEG streams only. Specifies the image compression that this

configuration will use. The decoder will fetch the stream with this compression, the settings on the video encoder will not be changed.

DisplayTime 15 1 ... 3600 6/6 The display time in seconds when connected as Auto.

InterlaceMode auto auto, interlaced, progressive

6/6 Controls if the encoded images are exposed progressive or interlaced. auto = Automatically tries to determine if the source is interlaced or progressive. interlaced = The source is interlaced. progressive = The source is progressive.

ManualEnabled yes yes, no

6/6 Enable in manual mode.

Name A string 6/6 The name of the video source. This parameter should always be set.

PTZ A string 6/6 The name of the PTZ position that is used for this configuration, e.g. pos1. If no PTZ position is needed this parameter should not be set.

Password A string 6/6 The password to use if authentication is required.

Resolution default default, For other valid values, please check the parameter Image.I# .Apperance.Resolution in the video source

6/6 This is only valid for MJPEG streams. Specifies the image resolution that this configuration will use. The decoder will fetch the stream with this resolution, the settings on the video encoder will not be changed.

UserName A string 6/6 The user name to use if authentication is required.

VideoSourceType auto auto, rtsp_mc, rtsp, rtsp_interleaved, http_rtsp_interleaved, mjpeg, mpeg2, mpeg2mc

6/6 The type of the video source connecting to. auto = The decoder tries to autodetect the source. rtsp_mc = MPEG-4 RTSP Multicast. rtsp = MPEG-4 Unicast UDP. rtsp_interleaved = MPEG-4 Unicast TCP. http_rtsp_interleaved = MPEG-4 Unicast TCP over HTTP. mjpeg = Motion JPEG. mpeg2 = MPEG2 unicast. mpeg2mc = MPEG2 Multicast over RTP.

If using auto the decoder will first try to connect in this order: 1. MPEG-4 multicast 2. MPEG-4 unicast UDP 3. MPEG-4 unicast TCP 4. MPEG-4 unicast TCP over HTTP 5. MPEG-4 unicast TCP over HTTPS 6. MPEG-2 multicast 7. MPEG-2 unicast 8. MJPEG.

VideoSourceNumber 1 1 ... 4, quad

6/6 The video source index to connect to if multiple sources are available. 1, 2, 3, 4 = Connects to a specific numbered view.

quad = Connects to the quad view.

* Note: the # is replaced with a group number, e.g. Encoder.E0

2.21.4 Encoder.E#.Info Description: Information about the camera/streamer connected to the decoder. These parameters are read-only, generated by the system.

Configuration file: /var/tmp/status.dat


[Encoder.E#.Info]


Valid values


Description

APIVersion An integer 6/7 The API version of this source.

Audio yes, no

6/7 The encoded stream has audio support.

AudioFormat mp2, g711, g721, g723

6/7 Encoded audio format.

BitRate An integer 6/7 The current actually decoded bit rate in kbit/s.

ConnectMode none, plain, basic_auth, secure

6/7 The connection mode to the video source. none = HTTP not applicable connection. plain = normal HTTP connection without authorization. basic_auth = HTTP connection with authorization. secure = HTTPS connection.

ErrorCode An integer 6/7 If a connection to a video source failed, this parameter shows the error code.

FrameRate

An integer 6/7 The current actually displayed frame rate.

ImageRotation An integer 6/7 The rotation of the video source image.

Model A string 6/7 The model of the connected video source if available. Actually a copy of the Brand.ProdFullName parameter in the connected source.

NumberOfVideoSources A string 6/7 The number of views in the connected video source if available. Either blank or a copy of the ImageSource.NbrOfSources parameter in the connected source.

Resolution A string 6/7 The current resolution of the input stream if available (<width>x<height>).

VideoSourceType A string 6/7 The video type of the connected video source if available. See Encoder.E#.VideoSourceType.

* Note: the # is replaced with a group number, e.g. Encoder.E0.Info

2.21.5 Decoder Description: Parameters for the decoder.



[Decoder]



Description

AutoConnect yes yes, no

6/6 Determines whether the decoder should auto connect to a video source upon boot. yes = Perform auto connect. no = Do not perform auto connect.

AutoDetectTimeout 10 An integer 6/6 The time in seconds that the autodetect tries to connect before trying another mode.

BootImage yes yes, no

6/6 Sets if a boot splash screen will be displayed during boot up.

Connected yes, no

6/6 The requested state of the decoder. Set this to yes to connect and to no if to disconnect.

CropTopBottom.PAL 3,5 <top>,<bottom> Valid values for <top> is 0 ... 575 Valid values for <bottom> is 0 ... 575 <top>+<bottom> may not exceed 575

6/6 Number of lines to crop top and bottom from the source image. Only used in MJPEG/MPEG-4 4CIF interlaced.

CropTopBottom.NTSC 3,0 <top>,<bottom> Valid values for <top> is 0 ... 479 Valid values for <bottom> is 0 ... 479 <top>+<bottom> may not exceed 479

6/6 Number of lines to crop top and bottom from the source image. Only used in MJPEG/MPEG-4 4CIF interlaced.

Picture.PAL 36,29,648,518 <x>,<y>, <width>,<height> <x>+<width> 1 ... 720

6/6 Defines the visible rectangle.

<y>+<height> 1 ... 576

Picture.NTSC 36,24,648,432 <x>,<y>, <width>,<height> <x>+<width> 1 ... 720 <y>+<height> 1 ... 480

6/6 Defines the visible rectangle.

PanPosition 50,50 <width>,<height> <width> 0 ... 99 <heigth> 0 ... 99

6/6 The percentage of the image to be panned, seen from the top left corner when using MJPEG.

VideoMode pal pal, ntsc

6/6 The current video mode. pal = Sets the decoder to PAL 720x576 50Hz mode. ntsc = Sets the decoder to NTSC 720x480 60Hz mode.

Volume 50 0 ... 100 6/6 Sets the decoder audio output volume.

2.21.6 Decoder.Info Description: Information about the decoder. These parameters are read-only, generated by the system.



[Decoder.Info]

Parameter name

Default value

Valid values


Description

Connected yes, no

6/7 This parameter is set to yes if the unit is currently connected.

CurrentSource An integer 6/7 The number of the current playing source in the video source list.

2.21.7 Network.Info.DHCP Description: DHCP information. These parameters are read-only, generated by the system.



[Network.Info.DHCP]

Parameter name

Default value

Valid values


Description

IP yes, no

6/7 Shows if the IP address was obtained by DHCP

HostName yes, no

6/7 Shows if the hostname was obtained by DHCP

DNS yes, no

6/7 Shows if the DNS was obtained by DHCP

2.21.8 System Description: Parameters for HTTP/HTTPS access to the device.



[System]


BoaGroupPolicy http both, http, https

6/7 Policy for Administrator.

VAPIX , Parameter Specification - Axis Communications , Parameter Specification Revision: 2.16 Date:...

Documents

Transcript of VAPIX , Parameter Specification - Axis Communications , Parameter Specification Revision: 2.16 Date:...