Deleted: URL Command Document

URL Command Document for SC8131 for IB8381

Version 1.0c Deleted: b

2016/04/28
Deleted: 4

Deleted: 9

Deleted: 16

www.vivotek.com
URL Command Document for All Series

© 2016 VIVOTEK INC. All Right Reserved Deleted: 2016

Deleted: 2014
VIVOTEK may make changes to specifications and product descriptions at any time, without notice.

The following is trademarks of VIVOTEK INC., and may be used to identify VIVOTEK products only: VIVOTEK. Other

product and company names contained herein may be trademarks of their respective owners.

No part of this publication may be reproduced or utilized in any form or by any means, electronic or mechanical,

including photocopying and microfilm, without permission in writing from VIVOTEK INC.

Revision History

Version Issue date Editor Comment

1.0a 2016/02/20 Evan Chen 1. Initial draft Deleted: 4

2. Sync URL command document from IB8381
Deleted: 8

Deleted: 15
1.0b 2016/03/21 Evan Chen 1. Fixed typo

2. Modify security level and value range Formatted Table

3. Add new parameter of SC8131 Deleted: walter.lin

1.0c 2016/04/28 Evan Chen, 1. Add setting WebSocket port number Deleted: 1.
Eric Fang 2. Modify contents Formatted: List Paragraph,
Numbered + Level: 1 + Numbering
Style: 1, 2, 3, … + Start at: 1 +
Alignment: Left + Aligned at: 0 cm
+ Indent at: 0.63 cm

Deleted: 2.

Deleted: FD8171

Deleted: 3. Remove¶

(1) mpeg4¶

4. Modify ¶

(1) maxexposure = 30¶

(2) maxframerate = 25, 30

(5M, 2M)¶

(3) resolution = 2560x1920

1920x1080 (5M, 2M)

Formatted: List Paragraph,

Numbered + Level: 1 + Numbering
Style: 1, 2, 3, … + Start at: 1 +
Alignment: Left + Aligned at: 0 cm
+ Indent at: 0.63 cm
Formatted: Numbered + Level: 1 +
Numbering Style: 1, 2, 3, … + Start
at: 1 + Alignment: Left + Aligned at:
0 cm + Indent at: 0.63 cm
1. Overview
For some customers who already have their own web site or web control application, a Network Camera/Video

server can be easily integrated through URLs. This document provides the supersets of URL commands for

VIVOTEK products.

This section specifies the external HTTP-based application programming interface. The HTTP-based camera

interface provides the functionality to request a single image, to control camera functions (PTZ, output relay etc.),

and to get and set internal parameter values. The image and CGI-requests are handled by the built-in Web server.
2. Style Convention
In URL syntax and in descriptions of CGI parameters, a text within angle brackets denotes a content that is to be

replaced with either a value or a string. When replacing the text string, the angle brackets shall also be replaced.

An example of this is the description of the name for the server, denoted with <servername> in the URL syntax

description below, which is replaced with the string myserver in the URL syntax example, also below.

URL syntax is written with the word “Syntax:" written in bold face followed by a box with the reference syntax as

seen below. The name of the server is written as <servername>. This is intended to be replaced with the name of

the actual server. This can either be a name, e.g., "mywebcam" or "thecam.adomain.net" or the associated IP

number for the server, e.g., 192.168.0.220.

Special notes will be marked in RED.

Syntax:

http://<servername>/cgi-bin/viewer/video.jpg

Description of returned data is written with "Return:" in bold face followed by the returned data shown in a box.

All data is returned as HTTP formatted, i.e., starting with the string HTTP and line separated with a Carriage Return

and Line Feed (CRLF) printed as \r\n.

Return:

HTTP/1.0 <HTTP code> <HTTP text>\r\n

URL syntax examples are written with "Example:" in bold face followed by a short description and a light grey box

with the example.

Example: Request a single snapshot image

http://mywebserver/cgi-bin/viewer/video.jpg

3. General CGI URL Syntax and Parameters

CGI parameters are written in lower-case and as one word without any underscores or other separators. When the

CGI request includes internal camera parameters, these parameters must be written exactly as they are named in

the camera or video server. The CGIs are organized in functionally-related directories under the cgi-bin directory.

The file extension .cgi is required.

Syntax:

http://<servername>/cgi-bin/<subdir>[/<subdir>...]/<cgi>.<ext>

[?<parameter>=<value>[&<parameter>=<value>...]]

Example: Set digital output #1 to active

http://mywebserver/cgi-bin/dido/setdo.cgi?do1=1

4. Security Level

SECURITY LEVEL SUB-DIRECTORY DESCRIPTION

0 anonymous Unprotected.

1 [view] anonymous, viewer, 1. Can view, listen, talk to camera.

dido, videoin 2. Can control DI/DO, PTZ of the camera. Deleted: camctrl
4 [operator] anonymous, viewer, Operator access rights can modify most of the camera’s

dido, camctrl, operator parameters except some privileges and network options.

6 [admin] anonymous, viewer, Administrator access rights can fully control the camera’s

dido, camctrl, operator, operations.

admin

7 N/A Internal parameters. Unable to be changed by any external

interfaces.

5. Get Server Parameter Values

Note: The access right depends on the URL directory.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/anonymous/getparam.cgi?[<parameter>]

[&<parameter>…]

http://<servername>/cgi-bin/viewer/getparam.cgi?[<parameter>]

[&<parameter>…]

http://<servername>/cgi-bin/operator/getparam.cgi?[<parameter>]

[&<parameter>…]

http://<servername>/cgi-bin/admin/getparam.cgi?[<parameter>]

[&<parameter>…]

Where the <parameter> should be <group>[_<name>] or <group>[.<name>]. If you do not specify any

parameters, all the parameters on the server will be returned. If you specify only <group>, the parameters of the

related group will be returned.

When querying parameter values, the current parameter values are returned.
A successful control request returns parameter pairs as follows:

Return:

HTTP/1.0 200 OK\r\n

Content-Type: text/html\r\n

Context-Length: <length>\r\n

\r\n

<parameter pair>

where <parameter pair> is

<parameter>=<value>\r\n

[<parameter pair>]

<length> is the actual length of content.

Example: Request IP address and its response

Request:

http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress

Response:

HTTP/1.0 200 OK\r\n

Content-Type: text/html\r\n

Context-Length: 33\r\n

\r\n

network.ipaddress=192.168.0.123\r\n

6. Set Server Parameter Values

Note: The access right depends on the URL directory.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/anonymous/setparam.cgi? <parameter>=<value>

[&<parameter>=<value>…][&update=<value>][&return=<return page>]

http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value>

[&<parameter>=<value>…][&update=<value>] [&return=<return page>]

http://<servername>/cgi-bin/operator/setparam.cgi? <parameter>=<value>

[&<parameter>=<value>…][&update=<value>] [&return=<return page>]

http://<servername>/cgi-bin/admin/setparam.cgi? <parameter>=<value>

[&<parameter>=<value>…][&update=<value>] [&return=<return page>]

PARAMETER VALUE DESCRIPTION

<group>_<name> value to assigned Assign <value> to the parameter <group>_<name>.
update <boolean> Set to 1 to update all fields (no need to update parameter in

each group).
return <return page> Redirect to the page <return page> after the parameter is

assigned. The <return page> can be a full URL path or relative

path according to the current path. If you omit this parameter, it

will redirect to an empty page.

(Note: The return page can be a general HTML file (.htm, .html)

or a VIVOTEK server script executable (.vspx) file. It cannot be

a CGI command or have any extra parameters. This parameter

must be placed at the end of the parameter list

Return:

HTTP/1.0 200 OK\r\n

Content-Type: text/html\r\n

Context-Length: <length>\r\n

\r\n

<parameter pair>

where <parameter pair> is

<parameter>=<value>\r\n

[<parameter pair>]
Only the parameters that you set and are readable will be returned.

Example: Set the IP address of server to 192.168.0.123:

Request:

http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123

Response:

HTTP/1.0 200 OK\r\n

Content-Type: text/html\r\n

Context-Length: 33\r\n

\r\n

network.ipaddress=192.168.0.123\r\n
7. Available parameters on the server

Valid values:

VALID VALUES DESCRIPTION

string[<n>] Text strings shorter than ‘n’ characters. The characters “,’, <,>,& are invalid.

string[n~m] Text strings longer than `n’ characters and shorter than `m’ characters. The

characters “,’, <,>,& are invalid.

password[<n>] The same as string but displays ‘*’ instead.

integer Any number between (-231 – 1) and (231 – 1).

positive integer Any number between 0 and (232 – 1).

<m> ~ <n> Any number between ‘m’ and ‘n’.

domain name[<n>] A string limited to a domain name shorter than ‘n’ characters (eg.

www.ibm.com).

email address [<n>] A string limited to an email address shorter than ‘n’ characters (eg.

[email protected]).

ip address A string limited to an IP address (eg. 192.168.1.1).

mac address A string limited to contain a MAC address without hyphens or colons.

boolean A boolean value of 1 or 0 represents [Yes or No], [True or False], [Enable or

Disable].

<value1>, Enumeration. Only given values are valid.

<value2>,

<value3>,

blank A blank string.

everything inside <> A description

integer primary key SQLite data type. A 32-bit signed integer. The value is assigned a unique

integer by the server.

text SQLite data type. The value is a text string, stored using the database

encoding (UTF-8, UTF-16BE or UTF-16-LE).

coordinate x, y coordinate (eg. 0,0)

window size window width and height (eg. 800x600)

NOTE: The camera should not be restarted when parameters are changed.
7.1 system
Group: system

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

hostname string[64] SC8131 1/6 Host name of server Deleted: Mega-Pixel Network
(Network Camera, Camera
Wireless Network Camera,

Video Server,

Wireless Video Server).

ledoff <boolean> 0 6/6 Turn on (0) or turn off (1) all

led indicators.

date <YYYY/MM/ <current 6/6 Current date of system. Set to

DD>, date> ‘keep’ to keep date

keep, unchanged. Set to ‘auto’ to

auto use NTP to synchronize date.

time <hh:mm:s <current 6/6 Current time of the system.

s>, time> Set to ‘keep’ to keep time

keep, unchanged. Set to ‘auto’ to

auto use NTP to synchronize time.

datetime <MMDDhh <blank> 7/6 Another current time format

mmYYYY.ss of the system.

>

ntp string[40] au.pool.ntp 6/6 NTP server. Deleted: <domain name>,¶

.org *Do not use “skip to invoke <ip address>,¶
default server” for default <blank>
value.
Deleted: <blank>
timezoneindex -489 ~ 529 320 6/6 Indicate timezone and area.

-480: GMT-12:00 Eniwetok,

Kwajalein

-440: GMT-11:00 Midway

Island, Samoa

-400: GMT-10:00 Hawaii

-360: GMT-09:00 Alaska

-320: GMT-08:00 Las Vegas,

San_Francisco,

Vancouver

-280: GMT-07:00 Mountain

Time, Denver
-281: GMT-07:00 Arizona

-240: GMT-06:00 Central

America, Central Time,

Mexico City, Saskatchewan

-200: GMT-05:00 Eastern

Time, New York, Toronto

-201: GMT-05:00 Bogota,

Lima, Quito, Indiana

-180: GMT-04:30 Caracas

-160: GMT-04:00 Atlantic

Time, Canada, La Paz,

Santiago

-140: GMT-03:30

Newfoundland

-120: GMT-03:00 Brasilia,

Buenos Aires,

Georgetown, Greenland

-80: GMT-02:00 Mid-Atlantic

-40: GMT-01:00 Azores,

Cape_Verde_IS.

0: GMT Casablanca,

Greenwich Mean Time:

Dublin,

Edinburgh, Lisbon, London

40: GMT 01:00 Amsterdam,

Berlin, Rome, Stockholm,

Vienna, Madrid, Paris

41: GMT 01:00 Warsaw,

Budapest, Bern

80: GMT 02:00 Athens,

Helsinki, Istanbul, Riga

81: GMT 02:00 Cairo

82: GMT 02:00 Lebanon,

Minsk

83: GMT 02:00 Israel

120: GMT 03:00 Baghdad,

Kuwait, Riyadh, Moscow, St.

Petersburg, Nairobi

121: GMT 03:00 Iraq

140: GMT 03:30 Tehran

 160: GMT 04:00 Abu Dhabi,

Muscat, Baku,

Tbilisi, Yerevan

180: GMT 04:30 Kabul

200: GMT 05:00

Ekaterinburg, Islamabad,

Karachi, Tashkent

220: GMT 05:30 Calcutta,

Chennai, Mumbai, New Delhi

230: GMT 05:45 Kathmandu

240: GMT 06:00 Almaty,

Novosibirsk, Astana, Dhaka,

Sri Jayawardenepura

260: GMT 06:30 Rangoon

280: GMT 07:00 Bangkok,

Hanoi, Jakarta, Krasnoyarsk

320: GMT 08:00 Beijing,

Chongging, Hong Kong, Kuala

Lumpur, Singapore, Taipei

360: GMT 09:00 Osaka,

Sapporo, Tokyo, Seoul,

Yakutsk

380: GMT 09:30 Adelaide,

Darwin

400: GMT 10:00 Brisbane,

Canberra, Melbourne,

Sydney, Guam, Vladivostok

440: GMT 11:00 Magadan,

Solomon Is., New Caledonia

480: GMT 12:00 Aucklan,

Wellington, Fiji, Kamchatka,

Marshall Is.

520: GMT 13:00 Nuku'Alofa

daylight_enable <boolean> 0 6/6 Enable automatic daylight

saving time in time zone.

daylight_dstactualmode 1~4 1 6/7 Check if current time is under

<positive daylight saving time.

integer> (Used internally)

daylight_auto_begintime string[19] NONE 6/7 Display the current daylight

saving start time.

daylight_auto_endtime string[19] NONE 6/7 Display the current daylight

saving end time.

daylight_timezones string ,-360,-320, 6/6 List time zone index which

-280,-240, support daylight saving time.

-241,-200,

-201,-160,

-140,-120,

-80,-40,0,

40,41,80,

81,82,83,

120,140,

380,400,48

updateinterval 0, 86400 6/6 0 to Disable automatic time Deleted: 0

3600, adjustment, otherwise, it

86400, indicates the seconds

604800, between NTP automatic

2592000 update intervals.

restore 0, N/A 7/6 Restore the system

<positive parameters to default values

integer> after <value> seconds.

reset 0, N/A 7/6 Restart the server after

<positive <value> seconds if <value>

integer> is non-negative.

restoreexceptnet <Any N/A 7/6 Restore the system

value> parameters to default values

except (ipaddress, subnet,

router, dns1, dns2, pppoe).

This command can cooperate

with other

“restoreexceptXYZ”

commands. When

cooperating with others, the

system parameters will be

restored to the default value

except for a union of the

combined results.

restoreexceptdst <Any N/A 7/6 Restore the system

value> parameters to default values

except all daylight saving time

 settings.

This command can cooperate

with other

“restoreexceptXYZ”

commands. When

cooperating with others, the

system parameters will be

restored to default values

except for a union of

combined results.

restoreexceptlang <Any N/A 7/6 Restore the system

Value> parameters to default values

except the custom language

file the user has uploaded.

This command can cooperate

with other

“restoreexceptXYZ”

commands. When

cooperating with others, the

system parameters will be

restored to the default value

except for a union of the

combined results.

restoreexceptvadp <Any N/A 7/6 Restore the system

Value> parameters to default values

except the custom language

file the user has uploaded.

This command can cooperate

with other

“restoreexceptXYZ”

commands. When

cooperating with others, the

system parameters will be

restored to the default value

except for a union of the

combined results.

7.1.1 system.info
Subgroup of system: info (The fields in this group are unchangeable.)
 NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

modelname string[40] SC8131 0/7 Internal model name of the Deleted: IB8381
server (eg. IP7139)

extendedmodelname string[40] SC8131 0/7 ODM specific model name of Deleted: IB8381
server (eg. DCS-5610). If it

is not an ODM model, this

field will be equal to

“modelname”

serialnumber <mac <product 0/7 12 characters MAC address

address> mac (without hyphens).

address>

firmwareversion string[40] <product 0/7 Firmware version, including

dependent model, company, and

> version number in the

format:

<MODEL-BRAND-VERSION>

language_count <integer> 9 0/7 Number of webpage

languages available on the

server.

language_i<0~(count-1)> string[16] <product 0/7 Available language lists.

dependent

>

customlanguage_maxcoun <integer> 1 0/6 Maximum number of custom

t languages supported on the

server.

customlanguage_count <integer> 0 0/6 Number of custom

languages which have been

uploaded to the server.

customlanguage_i<0~(ma string <blank> 0/6 Custom language name.

xcount-1)>

7.1.2 system.location
Subgroup of system: location

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

groupid string[256] 0 1/6 Location information: Group

id of this camera
 deviceid string[256] 0 1/6 Location information: Device

id of this camera

Formatted: Normal

7.1.3 system.mvaas
Subgroup of system: mvaas Formatted: Normal

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

registerserver_address string[256] 127.0.0.1 1/6 Remote management Formatted: Font: 9 pt

register server address Formatted: Default

Formatted: Default
registerserver_port 443,1025~ 443 1/6 Remote management
Formatted: Font: 9 pt
65535 register server port
Formatted: Default
logserver_address string[256] 127.0.0.1 1/6 Remote management log
Formatted: Default
server address Formatted: Font: 9 pt
logserver_port 443,1025~ 8833 1/6 Remote management log Formatted: Font: 9 pt
65535 server port
Formatted: Normal

7.2 status
Group: status

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

di_i<0~(ndi-1)> <boolean> 0 1/7 0 => Inactive, normal

<product dependent> 1 => Active, triggered

(capability.ndi > 0)

do_i<0~(ndo-1)> <boolean> 0 1/7 0 => Inactive, normal

<product dependent> 1 => Active, triggered

(capability.ndo > 0)

onlinenum_rtsp integer 0 6/7 Current number of RTSP

connections.

onlinenum_httppush integer 0 6/7 Current number of HTTP

push server

connections.

eth_i0 <string> <product 1/7 Get network information

dependent> from mii-tool.

vi_i<0~(nvi-1)> <boolean> 0 1/7 Virtual input

<product dependent> 0 => Inactive

1 => Active
 (capability.nvi > 0)

7.3 digital input behavior define

Group: di_i<0~(ndi-1)> (capability.ndi > 0)

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

normalstate high, high 1/1 Indicates open circuit or

low closed circuit (inactive

status)

7.4 digital output behavior define

Group: do_i<0~(ndo-1)> (capability.ndo > 0)

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

normalstate open, open 1/1 Indicate open circuit or

grounded closed circuit (inactive

status)

7.5 security
Group: security

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

privilege_do view, operator, operator 1/6 Indicate which privileges

<product dependent> admin and above can control

digital output

(capability.ndo > 0)

privilege_camctrl view, operator, view 1/6 Indicate which privileges

<product dependent> admin and above can control PTZ

(capability.ptzenabled > 0

or capability.eptz > 0)

user_i0_name string[64] root 6/7 User name of root

user_i1_name string[64] vivotekmvaas 6/7 User name of remote

management server

user_i<2~20>_name string[64] <blank> 6/7 User name Deleted: 1

user_i0_pass password[64] <blank> 6/6 Root password

user_i1_pass password[64] <blank> 6/6 Remote management

server password
user_i<2~20>_pass password[64] <blank> 7/6 User password Deleted: 1
user_i0_privilege view, admin 6/7 Root privilege

operator,

admin

user_i1_privilege view, admin 6/7 Remote management

operator, server privilege

admin

user_i<2~20>_ privilege view, <blank> 6/6 User privilege Deleted: 1

operator,

admin

7.6 network
Group: network

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

preproces <positive <blank> 6/6 An 32-bit integer, each bit can be set separately as

s integer> follows:

Bit 0 => HTTP service;

Bit 1=> HTTPS service;

Bit 2=> FTP service;

Bit 3 => Two way audio and RTSP Streaming

service;

To stop service before changing its port settings.

It’s recommended to set this parameter when

change a service port to the port occupied by

another service currently. Otherwise, the service

may fail.

Stopped service will auto-start after changing port

settings.

Ex:

Change HTTP port from 80 to 5556, and change

RTP port for video from 5556 to 20480.

Then, set preprocess=9 to stop both service first.

”/cgi-bin/admin/setparam.cgi?

network_preprocess=9&network_http_port=555

6& network_rtp_videoport=20480”

type lan, lan 6/6 Network connection type.

pppoe
 <product

dependent>

resetip <boolean> 1 6/6 1 => Get ipaddress, subnet, router, dns1, dns2

from DHCP server at next reboot.

0 => Use preset ipaddress, subnet, rounter, dns1,

and dns2.

ipaddress <ip <product 6/6 IP address of server.

address> dependent>

subnet <ip <blank> 6/6 Subnet mask.

address>

router <ip <blank> 6/6 Default gateway.

address>

dns1 <ip <blank> 6/6 Primary DNS server.

address>

dns2 <ip <blank> 6/6 Secondary DNS server.

address>

wins1 <ip <blank> 6/6 Primary WINS server.

address>

wins2 <ip <blank> 6/6 Secondary WINS server.

address>

7.6.1 802.1x
Subgroup of network: ieee8021x (capability.protocol.ieee8021x > 0)

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

enable <boolean> 0 6/6 Enable/disable IEEE 802.1x

eapmethod eap-peap, eap-peap 6/6 Selected EAP method

eap-tls

identity_peap String[64] <blank> 6/6 PEAP identity

identity_tls String[64] <blank> 6/6 TLS identity

password String[253] <blank> 6/6 Password for TLS

privatekeypassword String[253] <blank> 6/6 Password for PEAP

ca_exist <boolean> 0 6/6 CA installed flag

ca_time String[20] 0 6/7 CA installed time. Deleted: 0~20

Represented in EPOCH

ca_size String[20] 0 6/7 CA file size (in bytes) Deleted: 0~20

certificate_exist <boolean> 0 6/6 Certificate installed flag (for

TLS)
 certificate_time String[20] 0 6/7 Certificate installed time. Deleted: 0~20
Represented in EPOCH

certificate_size String[20] 0 6/7 Certificate file size (in bytes) Deleted: 0~20
privatekey_exist <boolean> 0 6/6 Private key installed flag (for

TLS)

privatekey_time 0~20 0 6/7 Private key installed time.

Represented in EPOCH

privatekey_size 0~20 0 6/7 Private key file size (in bytes)

7.6.2 QOS
Subgroup of network: qos_cos (capability.protocol.qos.cos > 0)

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

enable <boolean> 0 6/6 Enable/disable CoS (IEEE 802.1p)

vlanid 1~4095 1 6/6 VLAN ID

video 0~7 0 6/6 Video channel for CoS

audio 0~7 0 6/6 Audio channel for CoS

<product (capability.naudio > 0)

dependent>

eventalarm 0~7 0 6/6 Event/alarm channel for CoS

management 0~7 0 6/6 Management channel for CoS

eventtunnel 0~7 0 6/6 Event/Control channel for CoS

Subgroup of network: qos_dscp (capability.protocol.qos.dscp > 0)

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

enable <boolean> 0 6/6 Enable/disable DSCP

video 0~63 0 6/6 Video channel for DSCP

audio 0~63 0 6/6 Audio channel for DSCP

(capability.naudio > 0)

eventalarm 0~63 0 6/6 Event/alarm channel for DSCP

management 0~63 0 6/6 Management channel for DSCP

eventtunnel 0~63 0 6/6 Event/Control channel for DSCP

7.6.3 IPV6
Subgroup of network: ipv6 (capability.protocol.ipv6 > 0)

NAME VALUE DEFAULT SECURITY DESCRIPTION

 (get/set)

enable <boolean> 0 6/6 Enable IPv6.

addonipaddress <ip address> <blank> 6/6 IPv6 IP address.

addonprefixlen 0~128 64 6/6 IPv6 prefix length.

addonrouter <ip address> <blank> 6/6 IPv6 router address.

addondns <ip address> <blank> 6/6 IPv6 DNS address.

allowoptional <boolean> 0 6/6 Allow manually setup of IP

address setting.

7.6.4 FTP
Subgroup of network: ftp

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

port 21, 1025~65535 21 6/6 Local ftp server port.

7.6.5 HTTP
Subgroup of network: http

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

port 80, 1025 ~ 80 1/6 HTTP port.

65535

alternateport 1025~65535 8080 6/6 Alternate HTTP port.

authmode basic, basic 1/6 HTTP authentication mode.

digest

s0_accessname string[32] video.mjpg 1/6 HTTP server push access name for

stream 1.

(capability.protocol.spush_mjpeg

=1 and capability.nmediastream >

0)

s1_accessname string[32] video2.mjpg 1/6 HTTP server push access name for

<product stream 2.

dependent> (capability.protocol.spush_mjpeg

=1 and capability.nmediastream >

1)

s2_accessname string[32] video3.mjpg 1/6 Http server push access name for

<product stream 3

dependent> (capability.protocol.spush_mjpeg
 =1 and capability.nmediastream >

2)

anonymousviewing <boolean> 0 1/6 Enable anonymous streaming

viewing.

7.6.6 HTTPS
Subgroup of network: https (capability.protocol.https > 0)

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

port 443, 1025 ~ 443 1/6 HTTPS port.

65535

7.6.7 RTSP
Subgroup of network: rtsp (capability.protocol.rtsp > 0)

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

port 554, 1025 ~ 554 1/6 RTSP port.

65535 (capability.protocol.rtsp=1)

anonymousviewing <boolean> 0 1/6 Enable anoymous streaming

viewing.

authmode disable, disable 1/6 RTSP authentication mode.

basic, (capability.protocol.rtsp=1)

digest

s0_accessname string[32] live.sdp 1/6 RTSP access name for

stream1.

(capability.protocol.rtsp=1

and capability.nmediastream

> 0)

s1_accessname string[32] live2.sdp 1/6 RTSP access name for

stream2.

(capability.protocol.rtsp=1

and capability.nmediastream

> 1)

s2_accessname string[32] live3.sdp 1/6 RTSP access name for

stream3

(capability.protocol.rtsp=1

and capability.nmediastream

> 2)
7.6.7.1 RTSP multicast

Subgroup of network_rtsp_s<0~(n-1)>: multicast, n is stream count (capability.protocol.rtp.multicast > 0)

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

alwaysmulticast <boolean> 0 4/4 Enable always multicast.

ipaddress <ip address> For n=0, 4/4 Multicast IP address.

239.128.1.99

For n=1,

239.128.1.100,

and so on.

videoport 1025 ~ 65535 s0:5560 4/4 Multicast video port.

s1:5564

s2:5568

audioport 1025 ~ 65535 S0:5562 4/4 Multicast audio port.

<product S1:5566 (capability.naudio > 0)

dependent> S2:5570

ttl 1 ~ 255 15 4/4 Mutlicast time to live value.

7.6.8 SIP port

Subgroup of network: sip (capability.protocol.sip> 0)

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

port 1025 ~ 65535 5060 1/6 SIP port.

7.6.9 RTP port

Subgroup of network: rtp

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

videoport 1025 ~ 65535 5556 6/6 Video channel port for RTP.

(capability.protocol.rtp_unicast=1)

audioport 1025 ~ 65535 5558 6/6 Audio channel port for RTP.

(capability.protocol.rtp_unicast=1)
7.6.10 PPPoE
Subgroup of network: pppoe (capability.protocol.pppoe > 0)

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

user string[128] <blank> 6/6 PPPoE account user name.

pass password[64] <blank> 6/6 PPPoE account password.

7.6.11 WebSocket port

Subgroup of network: websocket

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

port 1025 ~ 65534 777 1/6 Server port for WebSocket.

(capability.protocol.websocket =1)
Formatted: Normal

7.7 IP Filter
Group: ipfilter

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

enable <boolean> 0 6/6 Enable access list filtering.

admin_enable <boolean> 0 6/6 Enable administrator IP

address.

admin_ip String[43] <blank> 6/6 Administrator IP address.

maxconnection 1~10 10 6/6 Maximum number of

concurrent streaming

connection(s).

type 0, 1 1 6/6 Ipfilter policy :

0 => allow

1 => deny

ipv4list_i<0~9> 0~31 <blank> 6/6 IPv4 address list.

(Single address:

<ip address>

Network address:

<ip address /

network mask>

Range

address:<start ip

address - end ip
 address>)

ipv6list_i<0~9> String[43] <blank> 6/6 IPv6 address list.

7.8 Video input

Group: videoin

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

cmosfreq 50, 60 60 4/4 CMOS frequency.

(capability.videoin.type=2)

whitebalance auto, manual, auto 1/4 “auto” indicates auto white

rbgain <product balance.

dependent> “manual” indicates keep current

value.

“rbgain” indicates using rgain

and gbain.

exposurelevel 0~12 6 4/4 Exposure level

autoiris <boolean> 1 1/4 Enable auto Iris.

enableblc <boolean> 0 1/4 Enable backlight compensation.

color 0, 1 1 1/4 0 =>monochrome

1 => color

flip <boolean> 0 1/4 Flip the image.

mirror <boolean> 0 1/4 Mirror the image.

ptzstatus <integer> 0 1/7 A 32-bit integer, each bit can be

set separately as follows:

Bit 0 => Support camera control

function; 0(not support),

1(support)

Bit 1 => Built-in or external

camera; 0 (external), 1(built-in)

Bit 2 => Support pan operation;

0(not support), 1(support)

Bit 3 => Support tilt operation;

0(not support), 1(support)

Bit 4 => Support zoom

operation; 0(not support),

1(support)

Bit 5 => Support focus

 operation; 0(not support),

1(support)

text string[64] <blank> 4/4 Enclose caption.

imprinttimestamp <boolean> 0 1/4 Overlay time stamp on video.

maxexposure 1, 15, 30, 30 1/4 Maximum exposure time.

60, 120, 240,

480

<product

dependent>

7.8.1 Video input setting per channel

Group: videoin_c<0~(n-1)> for n channel products, and m is stream number

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

mode 0 0 1/4 Set video mode. Deleted: ~ 1

cmosfreq 50, 60 60 1/4 CMOS frequency.

(capability.videoin.type=2)

whitebalance auto, manual, auto 1/4 “auto” indicates auto white

rbgain balance.

<product “manual” indicates keep

dependent> current value.

“rbgain” indicates using

rgain and gbain.

rgain 0~100 30 1/4 Manual set rgain value of

gain control setting.

bgain 0~100 30 1/4 Manual set bgain value of

gain control setting.

exposurelevel 0~12 6 1/4 Exposure level

autoiris 0~1 1 1/4 set 1 to enable auto iris, set

0 to disable auto iris.

piris_mode manual, indoor, manual 1/4 PIris mode Deleted: outdoor

outdoor manual = 0

indoor=1

outdoor=2
piris_position 1~100 1 1/4 Position of piris

enableblc 0~1 0 1/4 Enable backlight

compensation

maxgain 0~100 100 1/4 Manual set maximum gain

value.

color 0, 1 1 1/4 0 =>monochrome

1 => color

flip <boolean> 0 1/4 Flip the image.

mirror <boolean> 0 1/4 Mirror the image.

ptzstatus <integer> 0 1/7 A 32-bit integer, each bit can

be set separately as follows:

Bit 0 => Support camera

control function; 0(not

support), 1(support)

Bit 1 => Built-in or

external camera; 0

(external), 1(built-in)

Bit 2 => Support pan

operation; 0(not support),

1(support)

Bit 3 => Support tilt

operation; 0(not support),

1(support)

Bit 4 => Support zoom

operation; 0(not support),

1(support)

Bit 5 => Support focus

operation; 0(not support),

1(support)

text string[64] <blank> 1/4 Enclose caption.

imprinttimestamp <boolean> 0 1/4 Overlay time stamp on

video.

textonvideo_position top, bottom top 1/4 Text on video string position

textonvideo_size 15, 25, 30 15 1/4 Text on video font size

exposuremode auto,fixed auto 1/4 Exposure mode

maxexposure 50~32000 60 1/4 Maximum exposure time. Deleted: 1

minexposure 1~32000 32000 1/4 Minimum exposure time.
Deleted: 3
enablepreview <boolean> 0 1/4 Usage for UI of exposure

settings. Preview settings of

 video profile.

s<0~(m-1)>_codectype mjpeg, h264 h264 1/4 Video codec type.

<product

dependent>

s<0~(m-1)>_streamtype 0~3 2 1/4 Video stream type.

0: rectified

1: side by side

2: single eye

3: depth

s<0~(m-1)>_resolution Reference s0: 1/4 Video resolution in pixels.

capability_vide 1280x784 Deleted: 2560x1920

oin_resolution s1:

1280x784 Deleted: 2560x1920

s2:

640x392 Deleted: 2560x1920

s<0~(m-1)>_h264_intraperi 250, 500, 1000 1/4 Intra frame period in

od 1000, 2000, milliseconds.

3000, 4000

s<0~(m-1)>_h264_ratecont cbr, vbr cbr 1/4 cbr, constant bitrate Deleted: s0:
rolmode vbr, fix quality
Deleted: , smart¶
smart , smart stream
s1: cbr, vbr, smart¶
s<0~(m-1)>_h264_quant 1~5, 3 1/4 Quality of video when
s2: cbr, vbr
99, 100 choosing vbr in

“ratecontrolmode”.

99 is the customized manual

input setting.

1 = worst quality, 5 = best

quality.

100 is percentage mode.

s<0~(m-1)>_h264_qvalue 0~51 30 1/4 Manual video quality level

input.

(s<0~(m-1)>_h264_quant

= 99)

s<0~(m-1)>_h264_qpercen 1~100 50 1/4 Manual video quality level Deleted: 45

t input.

(s<0~(m-1)>_h264_quant

= 100)

s<0~(m-1)>_h264_bitrate 20000~40000 s0: 1/4 Set bit rate in bps when

 000 2000000 choosing cbr in Deleted: 8000000
s1: “ratecontrolmode”.

2000000 Deleted: 512000

s2:

512000 Deleted: 8000000

s<0~(m-1)>_h264_maxvbr 20000~40000 40000000 1/4 Set bit rate in bps when
Deleted: 1
bitrate 000 choosing vbr in

“ratecontrolmode”.

s<0~(m-1)>_h264_maxfra 1~15 s0:10 1/4 Set maximum frame rate in Deleted: 30

me s1:15 fps (for h264).
Deleted: 25
s2:10
Deleted: ¶
s<0~(m-1)>_h264_profile 0~2 1 1/4 Indicate H264 profiles
5M : 1~25fps¶
<product dependent> 0: baseline
2M : 1~30fps
1: main profile

2: high profile Deleted: 25

s<0~(m-1)>_h264_priorityp framerate,imag framerate 1/4 Set prioritypolicy

Deleted: 2
olicy equality

s<0~(m-2)>_h264_smartstr autotracking,m autotrackin 7/7 Set Smart stream mode Deleted: 1

eam_mode anual,hybrid g autotracking:Auto (Motion
Deleted: 4
detection for ROI)
Deleted: 0~2
manual:Manual (set manual

window for ROI) Deleted: 0

hybrid:Auto and Manual
Deleted: 0
(mix both motion detection
Deleted: 1
and Manual window for ROI)

s<0~(m-2)>_h264_smartstr 0~51 20 7/7 Manual video quality level Deleted: 2

eam_foreground_qvalue input. Deleted: 1/4

(s<0~(m-1)>_h264_smarts

tream_foreground_quant =

99)

s<0~(m-2)>_h264_smartstr 0~5, 3 7/7 Quality of foreground quality Deleted: 1

eam_foreground_quant 99, 100 1 = worst quality, 5 = best
Deleted: 1/4
quality.

s<0~(m-2)>_h264_smartstr 0~51 40 7/7 Manual video quality level Deleted: 1/4

eam_background_qvalue input.

(s<0~(m-1)>_h264_smarts

tream_background_quant =

99)

s<0~(m-2)>_h264_smartstr 0~5, 1 7/7 Quality of background Deleted: 1

eam_background_quant 99, 100 quality Deleted: 1/4

 1 = worst quality, 5 = best

quality.

s<0~(m-2)>_h264_smartstr 20000~40000 40000000 7/7 Maximum bitrate Deleted: 1/4

eam_maxbitrate 000
Deleted: 1000~40000000
s<0~(m-2)>_h264_smartstr 0~1 0 7/7 Enable or disable the
Deleted: 1/4
eam_win_i<0~2>_enable window.

s<0~(m-2)>_h264_smartstr 0~368, 0~288 (150,110) 7/7 Left-top corner coordinate of Deleted: 1/4
eam_win_i<0~2>_home the window.

s<0~(m-2)>_h264_smartstr 0~400, 0~320 (100x75) 7/7 Width and height of the Deleted: 1/4
eam_win_i<0~2>_size window.

s<0~(m-1)>_mjpeg_ratecon cbr, vbr vbr 1/4 cbr, constant bitrate

trolmode vbr, fix quality

<product dependent>

s<0~(m-1)>_mjpeg_quant 1~5, 3 1/4 Quality of JPEG video.

99, 100 99 is the customized manual

input setting.

1 = worst quality, 5 = best

quality.

100 is percentage mode.

s<0~(m-1)>_mjpeg_qvalue 2~97 50 1/4 Manual video quality level

input.

(s<0~(m-1)>_mjpeg_quan

t = 99)

s<0~(m-1)>_mjpeg_qperce 1~100 50 1/4 Manual video quality level Deleted: 49

nt input.

(s<0~(m-1)>_mjpeg_quan

t = 100)

s<0~(m-1)>_mjpeg_bitrate 20000~40000 s0: 1/4 Set bit rate in bps when Deleted: 1
000 20000000 choosing cbr in

s1: “ratecontrolmode”.

1000000 Deleted: 512000

s2:

20000000 Deleted: 1

s<0~(m-1)>_mjpeg_maxvb 20000~40000 40000000 1/4 Set bit rate in bps when

Deleted: 3
rbitrate 000 choosing vbr in
Deleted: 0
“ratecontrolmode”.

s<0~(m-1)>_mjpeg_maxfra 1~15 s0:10 1/4 Set maximum frame rate in Deleted: 5

me s1:15 fps (for JPEG). Deleted: ¶

s2:10 5M : 1~25fps¶
s<0~(m-1)>_mjpeg_priority framerate,imag s0: 1/4 Set priority policy 2M : 1~30fps
 policy equality framerate

s1:

framerate

s2:

imagequali

ty Deleted: framerate
wdrc_mode 0~3 0 0/7 WDR enhanced.
Deleted: 1
0: off
Deleted: 4
1: auto

2: always on

3: keep current value

wdrc_strength 0~2 1 0/7 WDR enhanced. Deleted: 1

0: low
Deleted: 4
1: medium

2: high

Deleted: ¶
7.8.1.1 Alternative video input profiles per channel ...

In addition to the primary setting of video input, there can be alternative profile video input setting for each

channel which might be for different scene of light (daytime or nighttime).

Group: videoin_c0_profile_i<0~(m-1)> (capability. nvideoinprofile > 0)

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

enable <boolean> 0 1/4 Enable/disable this profile setting

policy schedule schedule 1/4 The mode which the profile is Deleted: day,¶
applied to. night,¶
begintime hh:mm 18:00 1/4 Begin time of schedule mode.
Deleted: night
endtime hh:mm 06:00 1/4 End time of schedule mode.

exposuremode auto,fixed auto 1/4 Exposure Mode

maxexposure 1~32000 30 1/4 Maximum exposure time. Deleted: 30

minexposure 1~32000 32000 1/4 Minimum exposure time.

enableblc <boolean> 0 1/4 Enable backlight compensation.

exposurelevel 0~12 6 1/4 Exposure level

maxgain 0~100 100 1/4 Manual set maximum gain value.

mingain 0~100 0 1/4 Manual set minimum gain value.

autoiris <boolean> 0 1/4 Enable auto Iris.

 whitebalance auto, manual, auto 1/4 “auto” indicates auto white

rbgain balance.

“manual” indicates keep current

value.

rgain 0~100 30 1/4 Manual set rgain value of gain

control setting.

bgain 0~100 30 1/4 Manual set bgain value of gain

control setting.

irismode fixed, indoor, outdoor 1/4 Video Iris mode.

outdoor

wdrc_mode 0~3 0 0/7 WDR enhanced. Deleted: 1

0: off
Deleted: 4
1: auto

2: always on

3: keep current value

wdrc_strength 0~2 1 0/7 WDR enhanced. Deleted: 1

0: low
Deleted: 4
1: medium

2: high

7.9 Video input preview

The temporary settings for video preview

Group: videoinpreview

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

exposuremode auto,fixed auto 4/4 Exposure Mode

maxexposure 1~32000 30 4/4 Maximum exposure time.

minexposure 1~32000 32000 1/4 Minimum exposure time.

exposurelevel 0~12 6 4/4 Exposure level

enableblc <boolean> 0 4/4 Enable backlight compensation.

irismode fixed, indoor, outdoor 4/4 Video Iris mode.

outdoor

wdrc_mode 0~3 0 0/7 WDR enhanced. Deleted: 4

0: off
Deleted: 4
1: auto
 2: always on

3: keep current value

wdrc_strength 0~2 0 0/7 WDR enhanced. Deleted: 4

0: low
Deleted: 4
1: medium

2: high

maxgain 0~100 100 4/4 Manual set maximum gain value.

autoiris <boolean> 0 4/4 Enable auto Iris.

Deleted: 7.10 IR cut control¶

Group: ircutcontrol
7.10 Image setting per channel (capability.nvideoinprofile > 0)¶
Group: image_c<0~(n-1)> for n channel products NAME
...
NAME VALUE DEFAULT SECURITY DESCRIPTION
Deleted: 1
(get/set)
Formatted Table
brightnesspercent 0~100 0 4/4 Adjust brightnesspercent of

image

saturationpercent 0~100 50 4/4 Adjust saturation value of

percentage when

saturation=100

contrastpercent 0~100 50 4/4 Adjust contrastpercent of image

sharpnesspercent 0~100 50 4/4 Adjust sharpness value of

percentage when

sharpness=100

dnr_mode 0~1 0 4/4 0:disable

1:enable

dnr_strength 1~100 50 4/4 Strength of DNR

profile_i0_enable <boolean> 0 4/4 Enable/disable this profile

setting

profile_i0_policy schedule schedule 4/4 The mode which the profile is Deleted: day,¶
applied to. night,¶
profile_i0_begintime hh:mm 18:00 4/4 Begin time of schedule mode.
Deleted: night
profile_i0_endtime hh:mm 06:00 4/4 End time of schedule mode.

profile_i0_brightnesspercent 0~100 0 4/4 Adjust brightnesspercent of

image

profile_i0_contrastpercent 0~100 50 4/4 Adjust contrastpercent of image

profile_i0_saturationpercent 0~100 50 4/4 Adjust saturationpercent of

 image

profile_i0_sharpnesspercent 0~100 50 4/4 Adjust sharpnesspercent value

of image

profile_i0_dnr_mode 0~1 0 4/4 0:disable

1:enable

profile_i0_dnr_strength 1~100 50 4/4 Strength of DNR

Deleted: profile_i0_wdrcstrengt

h
...
 Deleted: 2
7.11 Image setting for preview
Group: imagepreview_c<0~(n-1)> for n channel products

NAME VALUE DEFAULT SECURITY DESCRIPTION Formatted Table

(get/set)

brightness -5~5,100 100 4/4 Adjust brightness of image according to

mode settings.

saturation -5~5,100 100 4/4 Adjust saturation of image according to

mode settings.

100 for saturation percentage mode.

saturationpercent 0~100 50 4/4 Adjust saturation value of percentage

when saturation=100

contrast -5 ~ 5,100 100 4/4 Adjust contrast of image according to

mode settings.

sharpness -5~5,100 100 4/4 Adjust sharpness of image according to

mode settings.

sharpnesspercent 0~100 50 4/4 Adjust sharpness value of percentage

when sharpness=100

dnr_mode 0~1 0 4/4 0:disable

1:enable

dnr_strength 1~100 50 4/4 Strength of DNR

Group: imagepreview

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

videoin_whitebalance auto, auto 4/4 Preview of adjusting white balance of

manual, image according to mode settings

rbgain

videoin_restoreatwb 1~ 0 4/4 Restore of adjusting white balance of

image according to mode settings

videoin_rgain 0~100 0 4/4 Manual set rgain value of gain control

setting.

videoin_bgain 0~100 0 4/4 Manual set bgain value of gain control

setting.
 Deleted: 3
7.12 Exposure window setting per channel
Group: exposurewin_c<0~(n-1)> for n channel products

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

mode auto, custom, blc auto 4/4 The mode indicates how to decide

the exposure.

auto: Use full view as the only

one exposure window.

custom: Use inclusive and

exclusive window.

blc: Use BLC.

win_i<0~9>_enable <boolean> 0 4/4 Enable or disable the window.

win_i<0~9>_policy 0~1 0 4/4 0: Indicate exclusive.

1: Indicate inclusive.

win_i<0~9>_home (0~368, 0~288) (150,110) 4/4 Left-top corner coordinate of the

window.

win_i<0~9>_size (0~400, 0~320) (100x75) 4/4 Width and height of the window.

Group: exposurewin_c<0~(n-1)>_profile for m profile and n channel product

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

The mode indicates how to

decide the exposure.

auto: Use full view as the

i<0~(m-1)>_mode auto, custom, blc auto 4/4 only one exposure window.

custom: Use inclusive and

exclusive window.

blc: Use BLC.

Enable or disable the

i<0~(m-1)>_win_i<0~9>_enable <boolean> 0 4/4
window.

0: Indicate exclusive.
i<0~(m-1)>_win_i<0~9>_policy 0~1 0 4/4
1: Indicate inclusive.

Left-top corner coordinate of

i<0~(m-1)>_win_i<0~9>_home (0~368, 0~288) (150,110) 4/4
the window.

Width and height of the

i<0~(m-1)>_win_i<0~9>_size (0~400, 0~320) (100x75) 4/4
window.
 Deleted: 7.14 Audio input per
7.13 DDNS channel¶
Group: ddns (capability.ddns > 0) Group: audioin_c<0~(n-1)> for n
NAME VALUE DEFAULT SECURITY DESCRIPTION channel products
(get/set) (capability.audioin>0)¶
enable <boolean> 0 6/6 Enable or disable the dynamic DNS. NAME
...
provider CustomSafe100, DyndnsDyn 6/6 Safe100 => safe100.net
Deleted: 7
DyndnsDynamic, amic DyndnsDynamic => dyndns.org

DyndnsCustom, (dynamic)

Safe100, DyndnsCustom => dyndns.org

CustomSafe100 =>

Custom server using safe100 method

PeanutHull => PeanutHull

<provider>_ho string[128] <blank> 6/6 Your DDNS hostname.

stname

<provider>_us string[64] <blank> 6/6 Your user name or email to login to

ernameemail the DDNS service provider

<provider>_pa string[64] <blank> 6/6 Your password or key to login to the

sswordkey DDNS service provider.

<provider>_se string[128] <blank> 6/6 The server name for safe100.

rvername (This field only exists if the provider is

customsafe100)

Deleted: 8
7.14 Express link
Group: expresslink

PARAMETER VALUE Default SECURITY DESCRIPTION

(get/set)

enable <boolean> 0 6/6 Enable or disable express link.

state onlycheck, badnetwork 6/6 Camera will check the status of network

onlyoffline, environment and express link URL

checkonline,

badnetwork

url string[64] NULL 6/6 The url user define to link to camera Deleted: 3

Deleted: 9
7.15 UPnP presentation
Group: upnppresentation
 NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

enable <boolean> 1 6/6 Enable or disable the UPnP

presentation service.

Deleted: 20
7.16 UPnP port forwarding
Group: upnpportforwarding

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

enable <boolean> 0 6/6 Enable or disable the UPnP port

forwarding service.

upnpnatstatus 0~3 0 6/7 The status of UPnP port forwarding,

used internally.

0 = OK, 1 = FAIL, 2 = no IGD router,

3 = no need for port forwarding

Deleted: 21
7.17 System log
Group: syslog

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

enableremotelog <boolean> 0 6/6 Enable remote log.

serverip <IP address> <blank> 6/6 Log server IP address.

serverport 514, 514 6/6 Server port used for log.

1025~65535

level 0~7 6 6/6 Levels used to distinguish the

importance of the

information:

0: LOG_EMERG

1: LOG_ALERT

2: LOG_CRIT

3: LOG_ERR

4: LOG_WARNING

5: LOG_NOTICE

6: LOG_INFO

7: LOG_DEBUG

setparamlevel 0~2 0 6/6 Show log of parameter

setting.

0: disable
 1: Show log of parameter

setting set from external.

2. Show log of parameter

setting set from external and

internal.

Deleted: 22
7.18 SNMP
Group: snmp (capability.snmp > 0)

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

v2 0~1 0 6/6 SNMP v2 enabled. 0 for disable, 1

for enable

v3 0~1 0 6/6 SNMP v3 enabled. 0 for disable, 1

for enable

secnamerw string[31] Private 6/6 Read/write security name

secnamero string[31] Public 6/6 Read only security name

authpwrw string[8~128] <blank> 6/6 Read/write authentication

password

authpwro string[8~128] <blank> 6/6 Read only authentication password

authtyperw MD5,SHA MD5 6/6 Read/write authentication type

authtypero MD5,SHA MD5 6/6 Read only authentication type

encryptpwrw string[8~128] <blank> 6/6 Read/write passwrd

encryptpwro string[8~128] <blank> 6/6 Read only password

encrypttyperw DES DES 6/6 Read/write encryption type

encrypttypero DES DES 6/6 Read only encryption type

rwcommunity string[31] Private 6/6 Read/write community

rocommunity string[31] Public 6/6 Read only community

syslocation string[128] <blank> 6/6 System location

syscontact string[128] <blank> 6/6 System contact

Deleted: 23
7.19 Layout configuration
Group: layout (New version)

NAME VALUE DEFAULT SECURITY DESCRIPTION

 (get/set)

logo_default <boolean> 1 1/6 0 => Custom logo

1 => Default logo

logo_link string[128] http://ww 1/6 Hyperlink of the logo Deleted: 64

w.vivotek.c

om

logo_powerbyvvtk_hidden <boolean> 0 1/6 0 => display the power by

vivotek logo

1 => hide the power by vivotek

logo

custombutton_manualtrigger_s <boolean> 1 1/6 Show or hide manual trigger

how (VI) button in homepage

<product dependent> 0 -> Hidden

1 -> Visible

theme_option 1~4 1 1/6 1~3: One of the default

themes.

4: Custom definition.

theme_color_font string[7] #ffffff 1/6 Font color

theme_color_configfont string[7] #ffffff 1/6 Font color of configuration area.

theme_color_titlefont string[7] #098bd6 1/6 Font color of video title.

theme_color_controlbackgroun string[7] #565656 1/6 Background color of control

d area.

theme_color_configbackground string[7] #323232 1/6 Background color of

configuration area.

theme_color_videobackground string[7] #565656 1/6 Background color of video area.

theme_color_case string[7] #323232 1/6 Frame color

Deleted: 4
7.20 Privacy mask
Group: privacymask_c<0~(n-1)> for n channel product

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

enable <boolean> 0 7/7 Enable privacy mask. Deleted: 4

win_i<0~4>_enable <boolean> 0 7/7 Enable privacy mask Deleted: 4

window.
Deleted: 4/4
win_i<0~4>_name string[40] <blank> 7/7 Name of the privacy mask
Deleted: 4/4
window.
win_i<0~4>_left 0 ~ 320 0 7/7 Left coordinate of window Deleted: 4/4
position.

win_i<0~4>_top 0 ~ 240 0 7/7 Top coordinate of window Deleted: 4/4

position.

win_i<0~4>_width 0 ~ 320 0 7/7 Width of privacy mask Deleted: 4/4

window.

win_i<0~4>_height 0 ~ 240 0 7/7 Height of privacy mask Deleted: 4/4

window.
 Deleted: 5
7.21 Capability
Group: capability

NAME VALUE DEFAULT SECURITY DESCRIPTION Formatted Table

(get/set)

api_httpversion <string> 0300a 0/7 The HTTP API version.

bootuptime <positive 60 0/7 Server bootup time.

integer>

nir 0, 1 0/7 Number of IR interfaces.

<positive

integer>

ir <boolean> 1 0/7 Indicate whether to support built-in IR led

extir <boolean> 0 0/7 Indicate whether to support external IR led

npir 0, Outdoor:0 0/7 Number of PIRs.

<positive Indoor:1 Deleted: 0

integer>

ndi 0, 1 0/7 Number of digital inputs.

<positive

integer>

nvi 0, 3 0/7 Number of virtual inputs (manual trigger)

<positive

integer>

ndo 0, 1 0/7 Number of digital outputs.

<positive

integer>

naudioin 0, 0 0/7 Number of audio inputs. Deleted: 1

<positive

integer>

naudioout 0, 0 0/7 Number of audio outputs. Deleted: 1

<positive

integer>

nvideoin <positive 1 0/7 Number of video inputs.

integer>

nvideoinprofile 0, 1 0/7 Number of video input profiles.

<positive

integer>

nmediastream <positive 3 0/7 Number of media stream per channels. Deleted: nvideoout
...
integer>

nmotion <positive 0 0/7 Number of motions Deleted: 3

 integer>

nvideosetting <positive 3 0/7 Number of video settings per channel.

integer>

naudiosetting <positive 0 0/7 Number of audio settings per channel. Deleted: 1

integer>

nuart 0, 0 0/7 Number of UART interfaces.

<positive

integer>

nvideoinprofile <positive 1 0/7 Number of video input profiles.

integer>

nmotionprofile 0, <positive 0 0/7 Number of motion profiles. Deleted: 1

integer>

ptzenabled 0, <positive 0 0/7 An 32-bit integer, each bit can be set

integer> separately as follows:

Bit 0 => Support camera control function;

0(not support), 1(support)

Bit 1 => Built-in or external camera;

0(external), 1(built-in)

Bit 2 => Support pan operation, 0(not

support), 1(support)

Bit 3 => Support tilt operation; 0(not

support), 1(support)

Bit 4 => Support zoom operation;

0(not support), 1(support)

Bit 5 => Support focus operation;

0(not support), 1(support)

Bit 6 => Support iris operation;

0(not support), 1(support)

Bit 7 => External or built-in PT; 0(built-in),

1(external)

Bit 8 => Invalidate bit 1 ~ 7;

0(bit 1 ~ 7 are valid),

1(bit 1 ~ 7 are invalid)

Bit 9 => Reserved bit; Invalidate lens_pan,

Lens_tilt, lens_zoon, lens_focus, len_iris.

0(fields are valid),

1(fields are invalid)

evctrlchannel <boolean> 1 0/7 Indicate whether to support HTTP tunnel for

event/control transfer.
joystick <boolean> 0 0/7 Indicate whether to support joystick control. Deleted: 1

remotefocus <boolean> 0 0/7 Indicate whether to support Deleted: 1

remote focus function.

storage_dbenabled <boolean> 1 0/7 Media files are indexed in database.

protocol_https < boolean > 1 0/7 Indicate whether to support HTTP over SSL.

protocol_rtsp < boolean > 1 0/7 Indicate whether to support RTSP.

protocol_sip <boolean> 1 0/7 Indicate whether to support SIP.

protocol_maxconnectio <positive 10 0/7 The maximum allowed simultaneous

n integer> connections.

protocol_maxgenconne <positive 10 0/7 The maximum general streaming

ction integer> connections .

protocol_rtp_multicast <boolean> 1 0/7 Indicate whether to support scalable

_ multicast.

scalable

protocol_rtp_multicast <boolean> 0 0/7 Indicate whether to support backchannel

_ multicast.

backchannel

protocol_rtp_tcp <boolean> 1 0/7 Indicate whether to support RTP over TCP.

protocol_rtp_http <boolean> 1 0/7 Indicate whether to support RTP over HTTP.

protocol_spush_mjpeg <boolean> 1 0/7 Indicate whether to support server push

MJPEG.

protocol_snmp <boolean> 1 0/7 Indicate whether to support SNMP.

protocol_ipv6 <boolean> 1 0/7 Indicate whether to support IPv6.

protocol_pppoe <boolean> 1 0/7 Indicate whether to support PPPoE.

protocol_ieee8021x <boolean> 1 0/7 Indicate whether to support IEEE802.1x.

protocol_qos_cos <boolean> 1 0/7 Indicate whether to support CoS.

protocol_qos_dscp <boolean> 1 0/7 Indicate whether to support QoS/DSCP.

protocol_ddns <boolean> 1 0/7 Indicate whether to support DDNS.

videoin_type 0, 1, 2 2 0/7 0 => Interlaced CCD

1 => Progressive CCD

2 => CMOS

videoin_c0_nmode <Integer> 1 0/7 Indicate how many video modes supported Deleted: 2
by this channel.

videoin_c0_mode <Integer> 0 0/7 Indicate current video mode.

videoin_c0_streamcod <A list of 6,6,6 0/7 Represent supported codec types of each

ec positive stream.

integer This contains a list of positive integers, split

separated by by comma. Each one stands for a stream,

commas> and the definition is as following:

Bit 0: Support MPEG4.

Bit 1: Support MJPEG

Bit 2: Support H.264

videoin_c0_lens_type motor motor 0/7 The lens type of this channel.

fisheye: Fisheye lens

fixed: Build-in lens. The lens may be fixed

focal, vari-focal, etc, but not be changeable.

changeable: changeable lens. Like box-type

camera, users can install any C-Mount or

CS-Mount lens as they wish.

motor: Lens with motor to support zoom,

focus, etc.

-: N/A

videoin_c0_lens_model - - 0/7 Optional model name for lens.

name

videoin_c0_mode<0~1 0 0 0/7 Indicate binning is used or not in this video

>_binning mode.

0: No binning

1: 2x2 binning

3: 3x3 binning Deleted: 5-Megapixel (4:3)

videoin_c0_mode<0~1 <string> Mode0: 0/7 Description about this mode. (MAX 25fps)¶
>_description 960P (4:3) Mode1:¶
(MAX 30fps) 1080P (16:9) (MAX 30fps)
videoin_c0_mode<0~1 <WxH> Mode0: 0/7 The visible area of full scene in this video
Deleted: 2560x1920¶
>_ effectivepixel 2560x960 mode.
Mode1:1920x1080
The unit is pixel.
Deleted: 2560x1920¶
videoin_c0_mode<0~1 <WxH> Mode0: 0/7 The output size of source, equal to the
Mode1:1920x1080
>_outputsize 2560x960 captured size by device, in this video mode.

The unit is pixel. Deleted: 25

videoin_c0_mode<0~1 <A list of Mode0: 0/7 Indicate maximum frame rate available for
Deleted: 25
>_maxframerate positive 30,30,15 the corresponding resolution. Those values
Deleted: 25
integer are one-to-one mapping to the "resolution"

separated by parameter in this video mode. Deleted: ,25,25,25,25

commas> Deleted: Mode1:¶

videoin_codec <string> mjpeg,h264 0/7 Available codec list. 30,30,30,30,30
videoin_c0_nresolution <positive 3 0/7 Number of videoin resolution. Deleted: 7
integer>

videoin_c0_resolution <a list of 640x240 0/7 Available resolutions list.

available 1280x480

resolution 2560x960 Deleted: 176x144,¶

separated by 320x240,¶
commas> 640x400,¶
<product 800x600,¶
dependent> 1920x1080¶
Videoin_c0_maxsize <WxH> 2560x960 0/7 The maximum resolution of this channel, the 2048x1536,¶

unit is pixel. 2560x1920

Deleted: 1920
videoin_c0_mode0_nre <positive 3 0/7 Available resolutions list.
Deleted: 7
solution integer>

videoin_c0_mode0_res <a list of 640x240 0/7 Available resolutions list.

olution available 1280x480

resolution 2560x960 Deleted: 176x144,¶

separated by 320x240,¶
commas> 640x400,¶
<product 800x600,¶
dependent> 1920x1080¶
videoin_c0_mode0_ma <Integer> 30,30,15 0/7 Maximum fps that the device can encode 2048x1536,¶
xfps_mjpeg 2560x1920
videoin_c0_mode0_ma <Integer> 30,30,15 0/7 Maximum fps that the device can encode
Deleted: 25,25,25,25,25,25,25
xfps_h264
Deleted: 25,25,25,25,25,25,25
videoin_flexiblebitrate <boolean> 1 0/7 Indicate whether to support

flexible bit rate control. Deleted: videoin_c0_mode1_nr

videoout_codec <a list of the ntsc 0/7 Available codec list. esolution
...
available codec

types

separated by

commas)

<product

dependent>

videoin_flexiblebitrate <boolean> 1 0/7 Indicate whether to support flexible bitrate.

audio_aec <boolean> 0 0/7 Indicate whether to support acoustic echo

cancellation.

audio_mic <boolean> 0 0/7 Indicate whether to support built-in

microphone input.
audio_extmic <boolean> 1 0/7 Indicate whether to support external

microphone input.

audio_linein <boolean> 1 0/7 Indicate whether to support external line

input.

(It will be replaced by audio_mic and

audio_extmic.)

audio_lineout <boolean> 1 0/7 Indicate whether to support line output.

audio_headphoneout <boolean> 0 0/7 Indicate whether to support headphone

output.

audioin_codec aac4, g711, aac4, g711, 0/7 Available codec list for audio input.

g726 g726

<product

dependent>

audioout_codec g711 <blank> 0/7 Available codec list for SIP.

<product

dependent>

camctrl_privilege <boolean> 1 0/7 Indicate whether to support “Manage

Privilege” of PTZ control in the Security page.

1: support both /cgi-bin/camctrl/camctrl.cgi

and /cgi-bin/viewer/camctrl.cgi

0: support only /cgi-bin/viewer/camctrl.cgi

uart_httptunnel <boolean> 0 0/7 Indicate whether to support HTTP tunnel for

UART transfer.

nprivacymask <positive 0 0/7 Number of privacy masks. Deleted: 5

integer>

transmission_mode Tx, Tx 0/7 Indicate transmission mode of the machine:

Rx, TX = server, Rx = receiver box, Both = DVR.

Both

network_wire <boolean> 1 0/7 Indicate whether to support Ethernet.

network_wireless <boolean> 0 0/7 Indicate whether to support wireless.

wireless_s802dot11b <boolean> 0 0/7 Indicate whether to support wireless

802.11b+.
wireless_s802dot11g <boolean> 0 0/7 Indicate whether to support wireless

802.11g.

wireless_s802dot11n <boolean> 0 0/7 Indicate whether to support wireless

802.11n.

wireless_beginchannel 1 ~ 14 N/A 0/7 Indicate the begin channel of wireless

network

wireless_endchannel 1 ~ 14 N/A 0/7 Indicate the end channel of wireless network

wireless_encrypt_wep <boolean> 0 0/7 Indicate whether to support wireless WEP.

wireless_encrypt_wpa <boolean> 0 0/7 Indicate whether to support wireless WPA.

wireless_encrypt_wpa2 <boolean> 0 0/7 Indicate whether to support wireless WPA2.

localstorage_managea <boolean> 1 0/7 Indicate whether manageable local storage is

ble supported.

localstorage_seamless <boolean> 1 0/7 Indicate whether seamless recording is

supported.

localstorage_modnum 0, 4 0/7 The maximum MOD connection numbers.

<positive

integer>

localstorage_slconnum 0, 1 0/7 The maximum seamless connection number.

<positive

integer>

localstorage_modversi <string> 1.0.3.3 0/7 Indicate MOD daemon version Deleted: 1

on
Deleted: 18
adaptiverecording <boolean> 1 0/7 Indicate whether to support adaptive

recording.

adaptivestreaming <boolean> 1 0/7 Indicate whether to support adaptive

recording.

derivative_brand <boolean> 1 0/7 Indicate whether to support the upgrade

function for the derivative brand. For

example, if the value is true, the VVTK

product can be upgraded to VVXX.

(TCVV<->TCXX is excepted)

npreset 0, <positive 20 0/7 Number of preset locations

integer>

eptz 0, <positive 0 0/7 A 32-bit integer, each bit can be set Deleted: 3
integer> separately as follows:

Bit 0 => stream 1 supports ePTZ or not.

Bit 1 => stream 2 supports ePTZ or not.

The rest may be deduced by analogy

nanystream 0, <positive 0 0/7 number of any media stream per channel

integer>

iva <boolean> 0 0/7 Indicate whether to support Intelligent Video

analysis

tampering <boolean> 0 0/7 Indicate whether to support tampering Deleted: 1

detection.

test_ac <boolean> 1 0/7 Indicate whether to support test ac key.

windowless <boolean> 1 0/7 Indicate whether to support windowless Deleted: image_wdrc

...
plug-in.

supportsd <boolean> 1 0/7 Indicate whether to support local storage.

timeshift <boolean> 1 0/7 Indicate whether to support time shift

caching stream.

whitelight <boolean> 0 0/7 Indicate whether to support white light led.

iris <boolean> 0 0/7 Indicate whether to support iris control. Deleted: 1

temperature <boolean> 0 0/7 Indicate whether to support temperature

detection.

fisheye <boolean> 0 0/7 Indicate where fisheye camera.

vadp <positive 0 0/7 An 32-bit integer, each bit can be set

integer> separately as follows:

Bit 0 => VADP interface

Bit 1 => Capture video raw data

Bit 2 => Support encode jpeg

Bit 3 => Capture audio raw data

Bit 4 => Support event trigger

Bit 5 => Support license registration

Bit 6 => Support shared memory API

remotecamctrl_master 0, <positive 0 0/7 Indicate whether to support remote auxiliary

integer> camera (master side), this value means

supporting max number of auxiliary camera.

remotecamctrl_slave <boolean> 0 0/7 Indicate whether to support remote camera

control (slave side).

media_totalspace <positive 35000 0/7 Available memory space (KB) for media.

integer>

media_snapshot_sizep <positive 1250 0/7 Maximum size (KB) of one snapshot image.

ersecond integer>

media_snapshot_maxp <positive 7 0/7 Maximum snapshot number before event

reevent integer> occurred.

media_snapshot_maxp <positive 7 0/7 Maximum snapshot number after event

 ostevent integer> occurred.

media_videoclip_maxsi <positive 8192 0/7 Maximum size (KB) of a videoclip.

ze integer>

media_videoclip_maxle <positive 20 0/7 Maximum length (second) of a videoclip.

ngth integer>

media_videoclip_maxp <positive 9 0/7 Maximum duration (second) after event

reevent integer> occurred in a videoclip.

version_genetec <string> 1.0.2.7 0/7 Indicate Genetec daemon version Deleted: 5

version_onvifdaemon <string> 1.12.0.2 0/7 Indicate ONVIF daemon version Deleted: 8

Deleted: 9
image_ c0_wdrc <boolean> 1 0/7 Indicate whether to support WDR enhanced.

image_c0_dnr <boolean> 1 0/7 Indicate whether to support digital noise Deleted: 7

reduction.

image_ c0_iristype <string> piris 0/7 Indicate iris type.

image_ c0_backfocus <boolean> 0 0/7 Indicate whether to support back focus.

image_ c0_focusassist <boolean> 0 0/7 Indicate whether to support focus assist.

image_ <boolean> 1 0/7 Indicate whether to support remote focus.

c0_remotefocus

Deleted: ¶

7.22 Customized event script Deleted: 6

Group: event_customtaskfile_i<0~2>

PARAMETER VALUE Default SECURITY DESCRIPTION

(get/set)

name string[40] <blank> 6/6 Custom script identification of this

entry.

date string[4~20] <blank> 6/6 Date of custom script.

time string[4~20] <blank> 6/6 Time of custom script.

Deleted: 7
7.23 Event setting
Group: event_i<0~2>

PARAMETER VALUE Default SECURITY DESCRIPTION

(get/set)

name string[40] <blank> 6/6 Identification of this entry.

enable 0, 1 0 6/6 Enable or disable this event.

priority 0, 1, 2 1 6/6 Indicate the priority of this event:

“0” = low priority

“1” = normal priority

“2” = high priority

delay 1~999 10 6/6 Delay in seconds before detecting the Deleted: 20

next event.

trigger boot, boot 6/6 Indicate the trigger condition:

di, “boot” = System boot

seq, “di”= Digital input Deleted: motion,¶

recnotify, “seq” = Periodic condition
Deleted: ¶
vi, “recnotify” = Recording notification.
“motion” = Video motion
vadp “vi”= Virtual input (Manual trigger)
detection
“vadp”=VADP event
Deleted: ¶

tampering,
triggerstatus String[40] trigger 6/6 The status for event trigger.

Deleted: ¶

exttriggerstatus String[40] <blank> 6/6 The status for event trigger. “tampering” = Tamper

detection.

exttriggerstatus1 String[40] <blank> 6/6 The status for event trigger.

Deleted: volalarm,¶
exttriggerstatus2 String[40] <blank> 6/6 The status for event trigger. pir (capability.npir>0)

exttriggerstatus3 String[40] <blank> 6/6 The status for event trigger. Deleted: ¶
di 0~3 1 6/6 Indicate the source id of di trigger.
Deleted: "volalarm" = Audio
This field is required when trigger
detection¶
condition is “di”.
"pir" = Passive infrared sensor
One bit represents one digital input.
trigger¶
The LSB indicates DI 0.
(capability.npir>0)
mdwin 0~7 0 6/6 Indicate the source window id of

motion detection.

This field is required when trigger

condition is “md”.

One bit represents one window.

The LSB indicates the 1st window.

For example, to detect the 1st and 3rd

windows, set mdwin as 5.

mdwin0 0~7 0 6/6 Similar to mdwin. The parameter

takes effect when profile 1 of motion

detection is enabled.
vi 0~7 0 6/6 Indicate the source id of vi trigger.

This field is required when trigger

condition is “vi”.

One bit represents one digital input.

The LSB indicates VI 0.

valevel 0,1 0 6/6 Select audio detection event.

0: not select

1: select

valevel0 0,1 0 6/6 Select audio detection profile event.

0: not select

1: select

inter 1~999 1 6/6 Interval of snapshots in minutes.

This field is used when trigger

condition is “seq”.

weekday 0~127 127 6/6 Indicate which weekday is scheduled.

One bit represents one weekday.

bit0 (LSB) = Saturday

bit1 = Friday

bit2 = Thursday

bit3 = Wednesday

bit4 = Tuesday

bit5 = Monday

bit6 = Sunday

For example, to detect events on

Friday and Sunday, set weekday as

66.

begintime hh:mm 00:00 6/6 Begin time of the weekly schedule.

endtime hh:mm 24:00 6/6 End time of the weekly schedule.

(00:00 ~ 24:00 sets schedule as

always on)

lowlightcondition 0, 1 1 6/6 Switch on white light LED in low light

<product dependent> condition

0 => Do action at all times

1 => Do action in low-light conditions

action_do_i<0~(ndo-1) 0, 1 0 6/6 Enable or disable trigger digital

>_enable output.

action_do_i<0~(ndo-1) 1~999 1 6/6 Duration of the digital output trigger

>_duration in seconds.
action_goto_enable <Boolean> 0 6/6 Enable/disable ptz goto preset

<product dependent> position on event triggered.

action_goto_name string[40] <blank> 6/6 Specify the preset name that ptz goto

<product dependent> on event triggered.

action_cf_enable <Boolean> 0 6/6 Enable or disable sending media to

SD card.

action_cf_folder string[128] <blank> 6/6 Path to store media.

action_cf_media 0~4,101 <blank> 6/6 Index of the attached media.

action_cf_datefolder <boolean> 0 6/6 Enable this to create folders by date,

time, and hour automatically.

action_cf_backup <Boolean> 0 6/6 Enable or disable the function that

send media to SD card for backup if

network is disconnected.

action_server_i<0~4>_e 0, 1 0 6/6 Enable or disable this server action.

nable

action_server_i<0~4>_ 0~4,101 <blank> 6/6 Index of the attached media.

media 101 means “Recording Notify”

action_server_i<0~4>_ <boolean> 0 6/6 Enable this to create folders by date,

datefolder time, and hour automatically.

Deleted: 8
7.24 Server setting for event action
Group: server_i<0~4>

PARAMETER VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

name string[40] NULL 6/6 Identification of this entry

type email, email 6/6 Indicate the server type:

ftp, “email” = email server

http, “ftp” = FTP server

ns “http” = HTTP server

“ns” = network storage

http_url string[128] http:// 6/6 URL of the HTTP server to upload.

http_username string[64] NULL 6/6 Username to log in to the server.

http_passwd string[64] NULL 6/6 Password of the user.

ftp_address string[128] NULL 6/6 FTP server address.

ftp_username string[64] NULL 6/6 Username to log in to the server.

ftp_passwd string[64] NULL 6/6 Password of the user.

ftp_port 0~65535 21 6/6 Port to connect to the server.

ftp_location string[128] NULL 6/6 Location to upload or store the media.

ftp_passive 0, 1 1 6/6 Enable or disable passive mode.

0 = disable passive mode

1 = enable passive mode

email_address string[128] NULL 6/6 Email server address.

email_sslmode 0, 1 0 6/6 Enable support SSL.

email_port 0~65535 25 6/6 Port to connect to the server.

email_username string[64] NULL 6/6 Username to log in to the server.

email_passwd string[64] NULL 6/6 Password of the user.

email_senderemail string[128] NULL 6/6 Email address of the sender.

email_recipientemail string[640] NULL 6/6 Email address of the recipient.

ns_location string[128] NULL 6/6 Location to upload or store the media.

ns_username string[64] NULL 6/6 Username to log in to the server.

ns_passwd string[64] NULL 6/6 Password of the user.

ns_workgroup string[64] NULL 6/6 Workgroup for network storage.

Deleted: 9
7.25 Media setting for event action
Group: media_i<0~4> (media_freespace is used internally.)

PARAMETER VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

name string[40] NULL 6/6 Identification of this entry

type snapshot, systemlog 6/6 Media type to send to the server or

systemlog, store on the server.

videoclip,

recordmsg

snapshot_source 0~3 0 6/6 Indicate the source of media stream.

0 means the first stream.

1 means the second stream and etc.

2 means the third stream and etc.

3 means the fourth stream and etc.

snapshot_prefix string[16] Snapshot[n]_ 6/6 Indicate the prefix of the filename.

media_i0=> Snapshot1_

media_i1=> Snapshot2_

media_i2=> Snapshot3_

media_i3=> Snapshot4_

media_i4=> Snapshot5_

snapshot_datesuffix 0, 1 0 6/6 Add date and time suffix to filename:

1 = Add date and time suffix.

0 = Do not add.

snapshot_preevent 0~7 1 6/6 Indicates the number of pre-event

images.

snapshot_postevent 0~7 1 6/6 The number of post-event images.

videoclip_source 0~3 0 6/6 Indicate the source of media stream.

0 means the first stream.

1 means the second stream and etc.

2 means the third stream and etc.

3 means the fourth stream and etc.

videoclip_prefix string[16] VideoClip[n]_ 6/6 Indicate the prefix of the filename.

videoclip_preevent 0~9 0 6/6 Indicates the time for pre-event

recording in seconds.

videoclip_maxduration 1 ~ 20 5 6/6 Maximum duration of one video clip in

seconds.

videoclip_maxsize 50 ~ 8192 500 6/6 Maximum size of one video clip file in

Kbytes.

Deleted: 30
7.26 Recording
Group: recording_i<0~1>

PARAMETER VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

name string[40] NULL 6/6 Identification of this entry.

trigger schedule, schedule 6/6 The event trigger type

networkfail schedule: The event is triggered by

schedule

networkfail: The event is triggered by

the failure of network connection.

enable 0, 1 0 6/6 Enable or disable this recording.

priority 0, 1, 2 1 6/6 Indicate the priority of this recording:

“0” indicates low priority.

“1” indicates normal priority.

“2” indicates high priority.

source 0~3 0 6/6 Indicate the source of media stream.

0 means the first stream.

1 means the second stream and so

on.

limitsize 0,1 0 6/6 0: Entire free space mechanism

1: Limit recording size mechanism

cyclic 0,1 0 6/6 0: Disable cyclic recording

1: Enable cyclic recording

notify 0,1 1 6/6 0: Disable recording notification

1: Enable recording notification

notifyserver 0~31 0 6/6 Indicate which notification server is

scheduled.

One bit represents one application

server (server_i0~i4).

bit0 (LSB) = server_i0.

bit1 = server_i1.

bit2 = server_i2.

bit3 = server_i3.

bit4 = server_i4.

For example, enable server_i0,

server_i2, and server_i4 as

notification servers; the notifyserver

value is 21.

weekday 0~127 127 6/6 Indicate which weekday is scheduled.

One bit represents one weekday.

bit0 (LSB) = Saturday

bit1 = Friday

bit2 = Thursday

bit3 = Wednesday

bit4 = Tuesday

bit5 = Monday

bit6 = Sunday

For example, to detect events on

Friday and Sunday, set weekday as

66.

begintime hh:mm 00:00 6/6 Start time of the weekly schedule.

endtime hh:mm 24:00 6/6 End time of the weekly schedule.

(00:00~24:00 indicates schedule

always on)

prefix string[16] <blank> 6/6 Indicate the prefix of the filename.

cyclesize 200~ 100 6/6 The maximum size for cycle recording

in Kbytes when choosing to limit

recording size.

reserveamount 0~ 100 6/6 The reserved amount in Mbytes when

choosing cyclic recording mechanism.

dest cf, cf 6/6 The destination to store the recorded

0~4 data.

“cf” means local storage (CF or SD

card).

“0” means the index of the network

storage.

cffolder string[128] NULL 6/6 Folder name.

maxsize 100~2000 100 6/6 Unit: Mega bytes.

<product dependent> <product <product When this condition is reached,

dependent> dependent> recording file is truncated.

maxduration 60~3600 60 6/6 Uuit: Second

<product dependent> <product <product When this condition is reached,

dependent> dependent> recording file is truncated.

adaptive_enable 0,1 0 6/6 Indicate whether the adaptive

<product dependent> recording is enabled

adaptive_preevent 0~9 1 6/6 Indicate when is the adaptive

<product dependent> recording started before the event

trigger point (seconds)

adaptive_postevent 0~10 1 6/6 Indicate when is the adaptive

<product dependent> recording stopped after the event

trigger point (seconds)

Deleted: 31
7.27 HTTPS
Group: https (capability.protocol.https > 0)

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

enable <boolean> 0 6/6 To enable or disable secure

HTTP.
 policy <Boolean> 0 6/6 If the value is 1, it will force

HTTP connection redirect to

HTTPS connection

method auto, auto 6/6 auto => Create self-signed

manual, certificate automatically.

install manual => Create self-signed

certificate manually.

install => Create certificate

request and install.

status -3 ~ 1 0 6/6 Specify the https status.

-3 = Certificate not installed

-2 = Invalid public key

-1 = Waiting for certificate

0 = Not installed

1 = Active

countryname string[2] TW 6/6 Country name in the certificate

information.

stateorprovincename string[128] Asia 6/6 State or province name in the

certificate information.

localityname string[128] Asia 6/6 The locality name in the

certificate information.

organizationname string[64] VIVOTEK Inc. 6/6 Organization name in the Deleted: Vivotek.Inc
certificate information.

unit string[64] VIVOTEK Inc. 6/6 Organizational unit name in the Deleted: Vivotek.Inc
certificate information.

commonname string[64] www.vivotek. 6/6 Common name in the certificate

com information.

validdays 0 ~ 3650 3650 6/6 Valid period for the certification.

Deleted: 32
7.28 Storage management setting
Currently it’s for local storage (SD, CF card)

Group: disk_i<0~(n-1)> n is the total number of storage devices. (capability.storage.dbenabled > 0)

PARAMETER VALUE Default SECURITY DESCRIPTION

(get/set)

cyclic_enabled <boolean> 0 6/6 Enable cyclic storage method.

autocleanup_enabled <boolean> 0 6/6 Enable automatic clean up method.

Expired and not locked media files will

be deleted.
autocleanup_maxage 1~ 7 6/6 To specify the expired days for Deleted: <positive integer>
automatic clean up.

Deleted: 33
7.29 Region of interest
Group: roi_c<0~(n-1)> for n channel product, and m is the number of streams which support ROI.

(capability.eptz > 0)

PARAMETER VALUE Default SECURITY DESCRIPTION

(get/set)

s<0~(m-1)>_home (0~1744,0~93 (0,0) 7/7 ROI left-top corner coordinate. Deleted: 1

6)
Deleted: 6
s<0~(m-1)>_size 176~ x 144~ 2560x1920 7/7 ROI width and height. The width
Deleted: 1
value must be multiples of 16 and the

height value must be multiples of 8 Deleted: 6

Deleted: 4
7.30 ePTZ setting
Group: eptz_c<0~(n-1)> for n channel product. (capability.eptz > 0)

PARAMETER VALUE Default SECURITY DESCRIPTION

(get/set)

osdzoom <boolean> 1 7/7 Indicates multiple of zoom in is Deleted: 1

“on-screen display” or not
Deleted: 4
smooth <boolean> 1 7/7 Enable the ePTZ "move smoothly"
Deleted: 1/4
feature

tiltspeed -5 ~ 5 0 7/7 Tilt speed Deleted: 1/7

(It should be set by eCamCtrl.cgi

rather than by setparam.cgi.)

panspeed -5 ~ 5 0 7/7 Pan speed Deleted: 1/7

(It should be set by eCamCtrl.cgi

rather than by setparam.cgi.)

zoomspeed -5 ~ 5 0 7/7 Zoom speed Deleted: 1/7

(It should be set by eCamCtrl.cgi

rather than by setparam.cgi.)

autospeed 1~5 1 7/7 Auto pan/patrol speed Deleted: 1/7

(It should be set by eCamCtrl.cgi

rather than by setparam.cgi.)

Group: eptz_c<0~(n-1)>_s<0~(m-2)> for n channel product and m is the number of streams which support

ePTZ. (capability.eptz > 0)

PARAMETER VALUE Default SECURITY DESCRIPTION

 (get/set)

patrolseq string[120] <blank> 1/4 The patrol sequence of ePTZ. All the

patrol position indexes will be

separated by ","

patroldwelling string[160] <blank> 1/4 The dwelling time (unit: second) of

each patrol point, separated by “,”.

preset_i<0~19>_name string[40] <blank> 1/7 Name of ePTZ preset.

(It should be set by ePreset.cgi rather

than by setparam.cgi.)

preset_i<0~19>_pos <coordinate> <blank> 1/7 Left-top corner coordinate of the

preset.

(It should be set by ePreset.cgi rather

than by setparam.cgi.)

preset_i<0~19>_size <window size> <blank> 1/7 Width and height of the preset.

(It should be set by ePreset.cgi rather

than by setparam.cgi.)

Deleted: 7.35 Focus Window setting¶

7.31 VIVOTEK Application Development Platform setting Group:
Group: vadp focuswindow_c<0~(n-1)>
NAME VALUE DEFAULT SECURITY DESCRIPTION for n channel product.¶
(get/set) PARAMETER
...
version 0~.0~.0~.0~.0~ 1.3.1.0 6/7 Indicate the VADP
Deleted: 6
version.
Formatted Table
resource_total_memory 0~ 134996 6/7 Indicate total available
Deleted: 1
memory size for VADP

modules. Deleted: 0

resource_total_storage 0~ 155284 6/7 Indicate total size of the Deleted: resource_total_video

...
internal storage space
Deleted: 24576
for storing VADP
Deleted: 10240
modules.

resource_free_memory 0~ 24576 6/7 Indicate free memory Deleted: resource_free_video

...
size for VADP modules.

resource_free_storage 0~ 10240 6/7 Indicate current free

storage size for

uploading VADP

modules.

module_number 0~ 1 6/7 Record the total module Deleted: 0

number that already

stored in the system.

 module_order string[40] 0 6/6 The execution order of Deleted: <blank>
the enabled modules.

module_save2sd <boolean> 0 6/6 Indicate if the module

should be saved to SD

card when user want to

upload it.

If the value is false, save

module to the internal

storage space and it will

occupy storage size.

Group: vadp_module_i<0~(n-1)>

NAME VALUE DEFAULT SECURITY DESCRIPTION Formatted Table

(get/set)

enable <boolean> module_i0: 1 6/6 Indicate if the module Deleted: 0

module_i1~9: 0 is enabled or not.

If yes, also add the

index of this module

to the module_order.

name string[40] module_i0: Stereo Counting 6/6 Module name

module_i1~9: <blank>

url string[120] module_i0: 6/6 Define the URL string

Stereo-Counting/www/index.html after the IP address if

module_i1~9: <blank> the module provides it Deleted: <blank>

own web page.

vender string[40] module_i0: VIVOTEK 6/6 The provider of the

module_i1~9: <blank> module. Deleted: <blank>

vendorurl string[120] module_i0: 6/6 URL of the vendor.

http://www.vivotek.com

module_i1~9: <blank> Deleted: <blank>

version string[40] module_i0: 1.0 6/6 Version of the module.

module_i1~9: <blank> Deleted: <blank>

license string[40] module_i0: N/A 6/6 Indicate the license

module_i1~9: <blank> status of the module. Deleted: <blank>

path string[40] module_i0: 6/6 Record the storage

/mnt/flash2/vadp-preload/0 path of the module.

module_i1~9: <blank> Deleted: <blank>

initscr string[40] module_i0: main.sh 6/6 The script that will

module_i1~9: <blank> handle operation Deleted: <blank>

commands from the
 system.

status string[40] module_i0: on 6/6 Indicate the running

module_i1~9: off status of the module. Deleted: off

Deleted: 7
7.32 Seamless recording setting
Group: seamlessrecording (capability.localstorage.seamless > 0)

PARAMETER VALUE Default SECURITY DESCRIPTION

(get/set)

diskmode seamless, seamless 1/6 “seamless” indicates

manageable enable seamless

recording.

“manageable” indicates

disable seamless

recording.

maxconnection 3 3 1/6 Maximum number of

connected seamless

streaming.

stream 1~3 1 7/7 (Internal used, read only)

output 0~2 2 7/7 (Internal used, read only)

enable <boolean> 0 1/6 Indicate whether

seamless recording is

recording to local storage

or not at present.

(Read only)

guid<0~2>_id string[127] <blank> 1/6 The connected seamless

streaming ID.

(Read only)

guid<0~2>_number 0~3 0 1/6 Number of connected

seamless streaming with

guid<0~2>_id.

(Read only)

Deleted: 8
7.33 Genetec info
Group: genetec

NAME VALUE DEFAULT SECURITY DESCRIPTION

(get/set)

image_ contrast <integer> 50 7/7 Only for genetec

 omnicast

image_ brightness <integer> 0 7/7 Only for genetec

omnicast

motion_ i<0~4> <integer> 0,0,0,0 7/7 Only for genetec

omnicast

Deleted: 7.39 PIR setting¶

Group: pir (capability.npir > 0)¶

NAME
...
8. Useful Functions
Drive the Digital Output (capability.ndo > 0)
Note: This request requires Viewer privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/dido/setdo.cgi?do1=<state>[&do2=<state>]

[&do3=<state>][&do4=<state>]

Where state is 0 or 1; “0” means inactive or normal state, while “1” means active or triggered state.

PARAMETER VALUE DESCRIPTION

do<num> 0, 1 0 – Inactive, normal state

1 – Active, triggered state

Example: Drive the digital output 1 to triggered state and redirect to an empty page.

http://myserver/cgi-bin/dido/setdo.cgi?do1=1

Query Status of the Digital Input (capability.ndi > 0)

Note: This request requires Viewer privileges

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/dido/getdi.cgi?[di0][&di1][&di2][&di3]

If no parameter is specified, all of the digital input statuses will be returned.

Return:

HTTP/1.0 200 OK\r\n

Content-Type: text/plain\r\n

Content-Length: <length>\r\n

\r\n

[di0=<state>]\r\n

[di1=<state>]\r\n

[di2=<state>]\r\n

[di3=<state>]\r\n

where <state> can be 0 or 1.

Example: Query the status of digital input 1 .

Request:

http://myserver/cgi-bin/dido/getdi.cgi?di1

Response:

HTTP/1.0 200 OK\r\n

Content-Type: text/plain\r\n

Content-Length: 7\r\n

\r\n

di1=1\r\n

Query Status of the Digital Output (capability.ndo > 0)

Note: This request requires Viewer privileges

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/dido/getdo.cgi?[do0][&do1][&do2][&do3]

If no parameter is specified, all the digital output statuses will be returned.

Return:

HTTP/1.0 200 OK\r\n

Content-Type: text/plain\r\n

Content-Length: <length>\r\n

\r\n

[do0=<state>]\r\n

[do1=<state>]\r\n

[do2=<state>]\r\n

[do3=<state>]\r\n

where <state> can be 0 or 1.

Example: Query the status of digital output 1.

Request:

http://myserver/cgi-bin/dido/getdo.cgi?do1

Response:

HTTP/1.0 200 OK\r\n

Content-Type: text/plain\r\n

Content-Length: 7\r\n
\r\n

do1=1\r\n

Capture Single Snapshot

Note: This request requires Normal User privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/viewer/video.jpg?[channel=<value>][&resolution=<value>]

[&quality=<value>][&streamid=<value>]

If the user requests a size larger than all stream settings on the server, this request will fail.

PARAMETER VALUE DEFAULT DESCRIPTION

channel 0~(n-1) 0 The channel number of the video source.

resolution <available 0 The resolution of the image.

resolution>

quality 1~5 3 The quality of the image.

streamid 0~(m-1) <product The stream number.

dependent>

The server will return the most up-to-date snapshot of the selected channel and stream in JPEG format. The size

and quality of the image will be set according to the video settings on the server.

Return:

HTTP/1.0 200 OK\r\n

Content-Type: image/jpeg\r\n

[Content-Length: <image size>\r\n]

<binary JPEG image data>

Account Management
Note: This request requires Administrator privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/admin/editaccount.cgi?

method=<value>&username=<name>[&userpass=<value>][&privilege=<value>]
[&privilege=<value>][…][&return=<return page>]

PARAMETER VALUE DESCRIPTION

method Add Add an account to the server. When using this method, the

“username” field is necessary. It will use the default value of

other fields if not specified.

Delete Remove an account from the server. When using this method,

the “username” field is necessary, and others are ignored.

edit Modify the account password and privilege. When using this

method, the “username” field is necessary, and other fields are

optional. If not specified, it will keep the original settings.

username <name> The name of the user to add, delete, or edit.

userpass <value> The password of the new user to add or that of the old user to

modify. The default value is an empty string.

Privilege <value> The privilege of the user to add or to modify.

viewer Viewer privilege.

operator Operator privilege.

admin Administrator privilege.

Return <return page> Redirect to the page <return page> after the parameter is

assigned. The <return page> can be a full URL path or relative

path according to the current path. If you omit this parameter, it

will redirect to an empty page.

System Logs
Note: This request require Administrator privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/admin/syslog.cgi

Server will return the most up-to-date system log.

Return:

HTTP/1.0 200 OK\r\n

Content-Type: text/plain\r\n

Content-Length: <syslog length>\r\n

\r\n
<system log information>\r\n

Upgrade Firmware
Note: This request requires Administrator privileges.

Method: POST

Syntax:

http://<servername>/cgi-bin/admin/upgrade.cgi

Post data:

fimage=<file name>[&return=<return page>]\r\n

\r\n

<multipart encoded form data>

Server will accept the file named <file name> to upgrade the firmware and return with <return page> if indicated.

ePTZ Camera Control (capability.eptz > 0)

Note: This request requires camctrl privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/camctrl/eCamCtrl.cgi?channel=<value>&stream=<value>

[&move=<value>] – Move home, up, down, left, right

[&auto=<value>] – Auto pan, patrol

[&zoom=<value>] – Zoom in, out

[&zooming=<value>&zs=<value>] – Zoom without stopping, used for joystick

[&vx=<value>&vy=<value>&vs=<value>] – Shift without stopping, used for joystick

[&x=<value>&y=<value>&videosize=<value>&resolution=<value>&stretch=<value>] – Click on image

(Move the center of image to the coordination (x,y) based on resolution or videosize.)

[ [&speedpan=<value>][&speedtilt=<value>][&speedzoom=<value>][&speedapp=<value>] ] – Set

speeds

[&return=<return page>]

Example:

http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=0&move=right

http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=1&vx=2&vy=2&vz=2

http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=1&x=100&y=100&

videosize=640x400&resolution=640x400&stretch=0
PARAMETER VALUE DESCRIPTION

channel <0~(n-1)> Channel of video source.

stream <0~(m-1)> Stream.

move home Move to home ROI.

up Move up.

down Move down.

left Move left.

right Move right.

auto pan Auto pan.

patrol Auto patrol.

stop Stop auto pan/patrol.

zoom wide Zoom larger view with current speed.

tele Zoom further with current speed.

zooming wide or tele Zoom without stopping for larger view or further view with zs

speed, used for joystick control.

zs 0~6 Set the speed of zooming, “0” means stop.

vx <integer> The direction of movement, used for joystick control.

vy <integer>

vs 0~7 Set the speed of movement, “0” means stop.

x <integer> x-coordinate clicked by user.

It will be the x-coordinate of center after movement.

y <integer> y-coordinate clicked by user.

It will be the y-coordinate of center after movement.

videosize <window size> The size of plug-in (ActiveX) window in web page

resolution <window size> The resolution of streaming.

stretch <boolean> 0 indicates that it uses resolution (streaming size) as the range

of the coordinate system.

1 indicates that it uses videosize (plug-in size) as the range of

the coordinate system.

speedpan -5 ~ 5 Set the pan speed.

speedtilt -5 ~ 5 Set the tilt speed.

speedzoom -5 ~ 5 Set the zoom speed.

speedapp 1~5 Set the auto pan/patrol speed.

return <return page> Redirect to the page <return page> after the parameter is

assigned. The <return page> can be a full URL path or relative

path according to the current path.

ePTZ Recall (capability.eptz > 0)

Note: This request requires camctrl privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/camctrl/eRecall.cgi?channel=<value>&stream=<value>&

recall=<value>[&return=<return page>]

PARAMETER VALUE DESCRIPTION

channel <0~(n-1)> Channel of the video source.

stream <0~(m-1)> Stream.

recall Text string less than 40 One of the present positions to recall.

characters

return <return page> Redirect to the page <return page> after the parameter is

assigned. The <return page> can be a full URL path or relative

path according to the current path.

ePTZ Preset Locations (capability.eptz > 0)

Note: This request requires Operator privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/operator/ePreset.cgi?channel=<value>&stream=<value>

[&addpos=<value>][&delpos=<value>][&return=<return page>]

PARAMETER VALUE DESCRIPTION

channel <0~(n-1)> Channel of the video source.

stream <0~(m-1)> Stream.

addpos <Text string less than Add one preset location to the preset list.

40 characters>

delpos <Text string less than Delete preset location from the preset list.

40 characters>

return <return page> Redirect to the page <return page> after the parameter is

assigned. The <return page> can be a full URL path or relative

path according to the current path.

IP Filtering
Note: This request requires Administrator access privileges.

Method: GET/POST

Syntax: <product dependent>

http://<servername>/cgi-bin/admin/ipfilter.cgi?type[=<value>]

http://<servername>/cgi-bin/admin/ipfilter.cgi?method=add<v4/v6>&ip=<ipaddress>[&index=<value>]

[&return=<return page>]

http://<servername>/cgi-bin/admin/ipfilter.cgi?method=del<v4/v6>&index=<value>[&return=<return

page>]

PARAMETER VALUE DESCRIPTION

type NULL Get IP filter type

allow, deny Set IP filter type

method addv4 Add IPv4 address into access list.

addv6 Add IPv6 address into access list.

delv4 Delete IPv4 address from access list.

delv6 Delete IPv6 address from access list.

ip <IP address> Single address: <IP address>

Network address: <IP address / network mask>

Range address:<start IP address - end IP address>

index <value> The start position to add or to delete.

return <return page> Redirect to the page <return page> after the parameter is

assigned. The <return page> can be a full URL path or relative

path according to the current path. If you omit this parameter, it

will redirect to an empty page.

IP Filtering for ONVIF

Syntax: <product dependent>

http://<servername>/cgi-bin/admin/ipfilter.cgi?type[=<value>]

http://<servername>/cgi-bin/admin/ipfilter.cgi?method=add<v4/v6>&ip=<ipaddress>[&index=<value>]

[&return=<return page>]

http://<servername>/cgi-bin/admin/ipfilter.cgi?method=del<v4/v6>&index=<value>[&return=<return

page>]

PARAMETER VALUE DESCRIPTION

type NULL Get IP filter type

allow, deny Set IP filter type

method addv4 Add IPv4 address into access list.

addv6 Add IPv6 address into access list.

delv4 Delete IPv4 address from access list.

delv6 Delete IPv6 address from access list.

ip <IP address> Single address: <IP address>

Network address: <IP address / network mask>

Range address:<start IP address - end IP address>

index <value> The start position to add or to delete.

return <return page> Redirect to the page <return page> after the parameter is

assigned. The <return page> can be a full URL path or relative

path according to the current path. If you omit this parameter, it

will redirect to an empty page.

Get SDP of Streams
Note: This request requires Viewer access privileges.

Method: GET/POST

Syntax:

http://<servername>/<network_rtsp_s<0~m-1>_accessname>

“m” is the stream number.

“network_accessname_<0~(m-1)>” is the accessname for stream “1” to stream “m”. Please refer to the

“subgroup of network: rtsp” for setting the accessname of SDP.

You can get the SDP by HTTP GET.

When using scalable multicast, Get SDP file which contains the multicast information via HTTP.

Open the Network Stream

Note: This request requires Viewer access privileges.

Syntax:

For HTTP push server (MJPEG):

http://<servername>/<network_http_s<0~m-1>_accessname>

For RTSP (MP4), the user needs to input the URL below into an RTSP compatible player.

rtsp://<servername>/<network_rtsp_s<0~m-1>_accessname>

“m” is the stream number.

For details on streaming protocol, please refer to the “control signaling” and “data format” documents.

Senddata (capability.nuart > 0)

Note: This request requires Viewer privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/viewer/senddata.cgi?

[com=<value>][&data=<value>][&flush=<value>] [&wait=<value>] [&read=<value>]

PARAMETER VALUE DESCRIPTION

com 1 ~ <max. com port The target COM/RS485 port number.

number>

data <hex decimal The <hex decimal data> is a series of digits from 0 ~ 9, A ~ F.

data>[,<hex decimal Each comma separates the commands by 200 milliseconds.

data>]

flush yes,no yes: Receive data buffer of the COM port will be cleared before

read.

no: Do not clear the receive data buffer.

wait 1 ~ 65535 Wait time in milliseconds before read data.

read 1 ~ 128 The data length in bytes to read. The read data will be in the

return page.

Return:

HTTP/1.0 200 OK\r\n

Content-Type: text/plain\r\n

Content-Length: <system information length>\r\n

\r\n

<hex decimal data>\r\n

Where hexadecimal data is digits from 0 ~ 9, A ~ F.

Storage managements (capability.storage.dbenabled > 0)

Note: This request requires administrator privileges.

Method: GET and POST

Syntax:

http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=<cmd_type>[&<parameter>=<value>…]

The commands usage and their input arguments are as follows.

PARAMETER VALUE DESCRIPTION

cmd_type <string> Required.

Command to be executed, including search, insert, delete,

update, and queryStatus.

Command: search

PARAMETER VALUE DESCRIPTION

label <integer primary key> Optional.

The integer primary key column will automatically be assigned

 a unique integer.

triggerType <text> Optional.

Indicate the event trigger type.

Please embrace your input value with single quotes.

Ex. mediaType=’motion’

Support trigger types are product dependent.

mediaType <text> Optional.

Indicate the file media type.

Please embrace your input value with single quotes.

Ex. mediaType=’videoclip’

Support trigger types are product dependent.

destPath <text> Optional.

Indicate the file location in camera.

Please embrace your input value with single quotes.

Ex. destPath =’/mnt/auto/CF/NCMF/abc.mp4’

resolution <text> Optional.

Indicate the media file resolution.

Please embrace your input value with single quotes.

Ex. resolution=’800x600’

isLocked <boolean> Optional.

Indicate if the file is locked or not.

0: file is not locked.

1: file is locked.

A locked file would not be removed from UI or cyclic storage.

triggerTime <text> Optional.

Indicate the event trigger time. (not the file created time)

Format is “YYYY-MM-DD HH:MM:SS”

Please embrace your input value with single quotes.

Ex. triggerTime=’2008-01-01 00:00:00’

If you want to search for a time period, please apply “TO”

operation.

Ex. triggerTime=’2008-01-01 00:00:00’+TO+’2008-01-01

23:59:59’ is to search for records from the start of Jan 1st 2008

to the end of Jan 1st 2008.

limit <positive integer> Optional.

Limit the maximum number of returned search records.

offset <positive integer> Optional.

Specifies how many rows to skip at the beginning of the

matched records.

Note that the offset keyword is used after limit keyword.

To increase the flexibility of search command, you may use “OR” connectors for logical “OR” search operations.

Moreover, to search for a specific time period, you can use “TO” connector.

Ex. To search records triggered by motion or di or sequential and also triggered between 2008-01-01 00:00:00 and

2008-01-01 23:59:59.

http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=search&triggerType=’motion’+OR+’di’+OR+’seq’&trigge

rTime=’2008-01-01 00:00:00’+TO+’2008-01-01 23:59:59’

Command: delete

PARAMETER VALUE DESCRIPTION

label <integer primary key> Required.

Identify the designated record.

Ex. label=1

Ex. Delete records whose key numbers are 1, 4, and 8.

http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=delete&label=1&label=4&label=8

Command: update

PARAMETER VALUE DESCRIPTION

label <integer primary key> Required.

Identify the designated record.

Ex. label=1

isLocked <boolean> Required.

Indicate if the file is locked or not.

Ex. Update records whose key numbers are 1 and 5 to be locked status.

http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=update&isLocked=1&label=1&label=5

Ex. Update records whose key numbers are 2 and 3 to be unlocked status.

http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=update&isLocked=0&label=2&label=3

Command: queryStatus

PARAMETER VALUE DESCRIPTION

retType xml or javascript Optional.

Ex. retype=javascript

The default return message is in XML format.

Ex. Query local storage status and call for javascript format return message.
http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=queryStatus&retType=javascript

Virtual input (capability.nvi > 0)

Note: Change virtual input (manual trigger) status.

Method: GET

Syntax:

http://<servername>/cgi-bin/admin/setvi.cgi?vi0=<value>[&vi1=<value>][&vi2=<value>]

[&return=<return page>]

PARAMETER VALUE DESCRIPTION

vi<num> state[(duration)nstate] Ex: vi0=1

Setting virtual input 0 to trigger state

Where "state" is 0, 1. “0”

means inactive or normal Ex: vi0=0(200)1

state while “1” means Setting virtual input 0 to normal state, waiting 200
active or triggered state. milliseconds, setting it to trigger state.
Where "nstate" is next Note that when the virtual input is waiting for next state,
state after duration. it cannot accept new requests.

return <return page> Redirect to the page <return page> after the request is

completely assigned. The <return page> can be a full

URL path or relative path according the current path. If

you omit this parameter, it will redirect to an empty

page.

Return Code Description

200 The request is successfully executed.

400 The request cannot be assigned, ex. incorrect parameters.

Examples:

setvi.cgi?vi0=0(10000)1(15000)0(20000)1

No multiple duration.

setvi.cgi?vi3=0

VI index is out of range.

setvi.cgi?vi=1

No VI index is specified.

503 The resource is unavailable, ex. Virtual input is waiting for next state.

Examples:

setvi.cgi?vi0=0(15000)1
 setvi.cgi?vi0=1

Request 2 will not be accepted during the execution time(15 seconds).

Open Timeshift Stream (capability.timeshift > 0,

timeshift_enable=1, timeshift_c<n>_s<m>_allow=1)
Note: This request requires Viewer access privileges.

Syntax:

For HTTP push server (MJPEG):

http://<servername>/<network_http_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&reftime

=<value>&forcechk&minsft=<value>]

For RTSP (MP4 and H264), the user needs to input the URL below into an RTSP compatible player.

rtsp://<servername>/<network_rtsp_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&reftime

=<value>&forcechk&minsft=<value>]

“n” is the channel index.

“m” is the timeshift stream index.

For details on timeshift stream, please refer to the “TimeshiftCaching” documents.

PARAMETER VALUE DEFAULT DESCRIPTION

maxsft <positive 0 Request cached stream at most how many seconds ago.

integer>

tsmode normal, normal Streaming mode:

adaptive normal => Full FPS all the time.

adaptive => Default send only I-frame for MP4 and

H.264, and send 1 FPS for MJPEG. If DI or motion window

are triggered, the streaming is changed to send full FPS

for 10 seconds.

(*Note: this parameter also works on non-timeshift

streams.)

reftime mm:ss The time Reference time for maxsft and minsft.

camera receives (This provides more precise time control to eliminate the

the request. inaccuracy due to network latency.)

Ex: Request the streaming from 12:20

rtsp://10.0.0.1/live.sdp?maxsft=10&reftime=12:30

forcechk N/A N/A Check if the requested stream enables timeshift, feature

and if minsft is achievable.

 If false, return “415 Unsupported Media Type”.

minsft <positive 0 How many seconds of cached stream client can accept at

integer> least.

(Used by forcechk)

Return Code Description

400 Bad Request Request is rejected because some parameter values are illegal.

415 Unsupported Media Type Returned, if forcechk appears, when minsft is not achievable or the

timeshift feature of the target stream is not enabled.

Open Anystream (capability.nanystream > 0)

Note: This request requires Viewer access privileges.

Syntax:

For HTTP push server (MJPEG):

http://<servername>/videoany.mjpg?codectype=mjpeg[&resolution=<value>&mjpeg_quant=<value>&

mjpeg_qvalue=<value>&mjpeg_maxframe=<value>]

For RTSP (H264), the user needs to input the URL below into an RTSP compatible player.

rtsp://<servername>/liveany.sdp?codectype=h264[&resolution=<value>&h264_intraperiod=<value>&

h264_ratecontrolmode=<value>& h264_quant=<value>& h264_qvalue=<value>&

h264_bitrate=<value>& h264_maxframe=<value>]

<product dependent>

PARAMETER VALUE DEFAULT DESCRIPTION

codectype mjpeg, h264 N/A Set codec type for Anystream.

solution capability_videoin_resolution <product Video resolution in pixels.

dependent>

mjpeg_quant 99, 1~5 3 Quality of JPEG video.

0,99 is the customized manual input

setting.

1 = worst quality, 5 = best quality.

mjpeg_qvalue 2~97 50 Manual video quality level input.

(This must be present if mjpeg_quant

is equal to 0, 99)
mjpeg_maxframe 1~25 (5M mode) 30 Set maximum frame rate in fps (for

1~30 (2M mode) JPEG).

h264_intraperiod 250, 500, 1000, 2000, 3000, 1000 Intra frame period in milliseconds.

4000

h264_ratecontrolmode cbr, vbr vbr cbr: constant bitrate

vbr: fix quality

h264_quant 99, 1~5 3 Quality of video when choosing vbr in

“h264_ratecontrolmode”.

0,99 is the customized manual input

setting.

1 = worst quality, 5 = best quality.

h264_qvalue 0~51 30 Manual video quality level input.

(This must be present if h264_quant is

equal to 0, 99)

h264_bitrate 20~40000000 8000000 Set bit rate in bps when choosing cbr

in “h264_ratecontrolmode”.

h264_maxframe 1~25 (5M mode) 25 Set maximum frame rate in fps (for

1~30 (2M mode) 30 H264).

Remote Focus
Note: This request requires Administrator privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/admin/remotefocus.cgi?function=<value>[&direction=<value>]

[&position=<value>][&steps=<value>][&iris]

PARAMETER VALUE DESCRIPTION

function zoom, Function type

focus, zoom – Move zoom motor

auto, focus – Move focus motor

scan, auto – Perform auto focus

stop, scan – Perform focus scan

positioning stop – Stop current operation

getstatus positioning – Position the motors

getstatus – Information of motors, return value as below:

remote_focus_focus_motor_max: Maximum steps of focus

motor

remote_focus_zoom_motor_max: Maximum steps of zoom

motor

remote_focus_focus_motor_start: Start point of effective

focal length

remote_focus_focus_motor_end: End point of effective focal

length

remote_focus_focus_motor: Current position of focus motor

remote_focus_zoom_motor: Current position of zoom motor

remote_focus_focus_enable: Current function of focus motor

remote_focus_zoom_enable: Current function of zoom motor

remote_focus_value_mode: Source of focus value. 0: ISP, 1:

Edge.

direction direct, Motor’s moving direction.

forward, It works only if function=zoom | focus.

backward

position 0 ~ <motor_max> Motor’s position.

It works only if function=zoom | focus and direction=direct.

<motor_max> is refer to remote_focus_focus_motor_max or

remote_focus_zoom_motor_max which replied from

"function=getstatus"

steps 1 ~ <motor_max> Motor’s moving steps.

It works only if function=zoom | focus and direction=forward |

backward.

<motor_max> is refer to remote_focus_focus_motor_max or

remote_focus_zoom_motor_max which replied from

"function=getstatus"

iris N/A Open iris or not.

It works only if function=auto | scan.

Export Files
Note: This request requires Administrator privileges.

Method: GET

Syntax:

For daylight saving time configuration file:

http://<servername>/cgi-bin/admin/exportDst.cgi

For language file:

http://<servername>/cgi-bin/admin/export_language.cgi?currentlanguage=<value>

PARAMETER VALUE DESCRIPTION

currentlanguage 0~20 Available language lists.

Please refer to:

system_info_language_i0 ~ system_info_language_i19.

For setting backup file:

http://<servername>/cgi-bin/admin/export_backup.cgi?backup

Upload Files
Note: This request requires Administrator privileges.

Method: POST

Syntax:

For daylight saving time configuration file:

http://<servername>/cgi-bin/admin/upload_dst.cgi

Post data:

filename =<file name>\r\n

\r\n

<multipart encoded form data>

For language file:

http://<servername>/cgi-bin/admin/upload_lan.cgi

Post data:

filename =<file name>\r\n

\r\n
<multipart encoded form data>

For setting backup file:

http://<servername>/cgi-bin/admin/upload_backup.cgi

Post data:

filename =<file name>\r\n

\r\n

<multipart encoded form data>

Server will accept the file named <file name> to upload this one to camera.