1
Content
1 IP Camera CGI Introduction. ...................................................................................................... 3
1.1 Main CGI Introduction ................................................................................................... 3
1.2 IP Camera CGI User Authentication............................................................................... 3
1.3 IP Camera CGI Access methods ..................................................................................... 4
1.3.1 Form accessible for CGI programs ..................................................................... 4
1.3.2 Direct URL access the CGI programs ................................................................. 4
1.4 IP Camera CGI Return .................................................................................................... 4
1.4.1 Including device status or parameters .............................................................. 5
1.4.2 Text string including equipment operation result ............................................. 5
1.4.3 Text String including device operation result .................................................... 5
1.4.4 Image Data volume ........................................................................................... 5
1.4.5 URLString return ................................................................................................ 6
1.4.6 MJPEG Stream Data ........................................................................................... 6
1.4.7 Alarm Data......................................................................................................... 6
2 IP Camera CGI Command .......................................................................................................... 7
2.1 Realtime Video .............................................................................................................. 7
2.1.1 H.264 Real-time video (video.cgi) ..................................................................... 7
2.1.2 Motion JPEG Stream CGI(mjpeg.cgi&mjpeg2.cgi) ....................................... 9
2.2 Snap shot(image.cgi) ............................................................................................. 11
2.2.1.2 Input paramaters ............................................................................................. 11
2.3 Alarm Information(alarm.cgi) ................................................................................ 11
2.3.1 Input Parameters ............................................................................................. 11
2.3.2 Alarm(alarmStatus) .................................................................................... 12
2.4 PTZ(ptz.cgi) ............................................................................................................ 14
2.4.1 PTZPTZ Enter Common parameters ................................................................ 14
2.4.2 PTZ Commands stop,zoomIn,zoomOut,FocusFar,FocusNear,irisIncrease,
irisDecrease,setNorthPosition ...................................................................................... 17
2.4.3 PTZ Commands rotateUp, rotateDown, rotateLeft, rotateRight, rotateLeftUp,
rotateLeftDown, rotateRightUp, rotateRightDown ......................................................... 17
2.4.4 PTZ preset point(Preset) ............................................................................ 18
2.4.5 PTZ(Track) .................................................................................................. 21
2.4.6 PTZ scan(Scan) ........................................................................................... 23
2
2.4.7 PTZ Patrol(Tour) ......................................................................................... 26
2.4.8 PTZ guard(keeper)...................................................................................... 30
2.4.9 PTZ position(Position) ................................................................................ 31
2.5 Device Configuration(param.cgi) ........................................................................... 32
2.5.1 Common parameters....................................................................................... 32
2.5.2 Device Configuration ....................................................................................... 36
2.5.3 Stream Configuration ...................................................................................... 57
2.5.4 Network Services Configuration ...................................................................... 61
2.5.5 Video configuration ......................................................................................... 61
2.5.6 Alarm Configuration ........................................................................................ 70
2.5.7 External Device Configration ........................................................................... 94
2.5.8 Service Center Configration............................................................................. 99
2.5.9 Protocol ......................................................................................................... 104
2.6 Device Operation(operate.cgi) ............................................................................. 106
2.6.1 Input Common parameter ............................................................................ 106
2.6.2 Device Reset .................................................................................................. 106
2.6.3 Device Restart................................................................................................ 106
2.7 Sensor Configuration(sensor.cgi) ......................................................................... 107
2.7.1 Input common parameters ........................................................................... 107
2.7.2 Brightness ...................................................................................................... 108
2.7.3 Contrast ......................................................................................................... 109
2.7.4 Hue ................................................................................................................ 111
2.7.5 Saturation ...................................................................................................... 112
2.7.6 Sharpness ...................................................................................................... 114
3 IP Camera CGI response text, group text rules, common error description ......................... 116
3.4.1 Network Error ................................................................................................ 119
3.4.2 Database Error ............................................................................................... 120
3.4.3 Command Error ............................................................................................. 121
3.4.4 Business Application Error ............................................................................. 122
3
1 IP Camera CGI Introduction.
IP Camera CGI (Common Gateway Interface) is to provide a set of IP Camera http protocol-based interface
commands, allowing device settings and features over standard http port. The following table shows the CGI
command and which functions they control.
1.1 Main CGI Introduction
IP Camera CGI, main CGI modular listed as below:
CGI Modular:
Application
Type
Explanation Data
Type
Instance Remarks
param.cgi Configuration
Information
CGI param.cgi Information access
and device
configure
parameters
video.cgi H264 Video CGI video.cgi H264 Video
mjpeg.cgi Motion
JpegVideo
CGI mjpeg.cgi Motion Jpeg Video
image.cgi snapshot CGI image.cgi Snapshot
operate.cgi Maintain CGI operate.cgi Equipment
operation CGI, such
as restart, reset,
etc.
ptz.cgi PTZ operation CGI ptz.cgi PTZ operation CGI
sensor.cgi Sensor
Configuration
CGI sensor.cgi Sensor
Configuration CGI
alarm.cgi Alarm CGI alarm.cgi Get Alarm
Information
1.2 IP Camera CGI User Authentication
From a security perspective for IP Camera CGI access account and password is required for
verification.
Specific security authentication mechanism is required for operation, there are two: http
4
protocols set forth in the Basic security authentication mechanism, for CGI the parameters of the
program and the additional user name and passwords are passed as part of the parameter.
1.3 IP Camera CGI Access methods
CGI program supports URL access and forms to access the user specific access to the URL is different,
the corresponding CGI program different users through the form using CGI programs, you should
ensure that access to a URL with CGI programs CGI program that need access to the corresponding
parameters using correct method.
Note: In the document examples of CGI programs access. Document gives examples with IP:
192.168.10.54
With as username / password combination of admin / 123456789 as can be seen throughtout the
documents
1.3.1 Form accessible for CGI programs
Forms CGI programs access sample code form:
<form action=” http://<servername>/cgi-bin/param.cgi”>
<input name=”userName”>
<input name=”password”>
<input name=”operate”>
<input name=”type”>
<input type=submit value=”ok”>
</form>
1.3.2 Direct URL access the CGI programs
URL:
http://<servername>/cgi-bin/param.cgi?userName=<username>&password=<password>&
action=get&type= AVStream
1.4 IP Camera CGI Return
According to different operation types, IP Camera CGI return information is listed as below:
Device state and parameters of plain file、text string with device operation result、image data
&URL file、MJPEG data stream、alarm data.
5
1.4.1 Including device status or parameters
This document is composed of a specific format for the HTTP protocol version, the return text
type, body length, and body content.
Example:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body>
<parameter>=<value>
<parameter>=<value>
...
Note: If the operation fails, the document Body to return an error number, specific meaning can
refer to 3.3 Error constant for loop part, using the Count - Flag - End components. PresetCount
example above indicates the number of parameters; next_presetURL expressed long ago
argument ends after a period parameter starts; presetEnd parameter represents the total end.
1.4.2 Text string including equipment operation result
1.4.3 Text String including device operation result
This document is composed of a specific format for the HTTP protocol version, the return text
type, body length, and body content.
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: < body size>
< message>
1.4.4 Image Data volume
Body composition data specific format of the HTTP protocol version, the return data type picture,
pictures, and data volume data body length
Example:
HTTP Code: 200 OK
Content-Type: image/jpeg
Content-Length: <image size>
< image data>
6
1.4.5 URLString return
The format string is composed of the protocol type, IP port, the relevant code
Example:
rtsp://192.168.250.27:554/snl/live/1/1/Ux/sido=-Ux/sido=
1.4.6 MJPEG Stream Data
Body composition data specific format of the HTTP protocol version, connecttype,the return data type picture,
pictures, and data volume data body length
Example:
HTTP Code: 200 OK
Date: <Date>
Pragma: no-cache
Cache-Control: no-cache
Content-Type: multipart/x-mixed-replace; boundary=mjpegboundary
--mjpegboundary
HTTP Code: 200 OK
Content-Type: image/jpeg
Content-Length: <image size>
< image data>
……
--mjpegboundary
HTTP Code: 200 OK
Content-Type: image/jpeg
Content-Length: <image size>
< image data>
1.4.7 Alarm Data
Alarm data is composed of HTTP protocol version、connection method、plain type、Alarm data
volume.
Example:
HTTP Code: 200 OK
7
Date: <Date>
Pragma: no-cache
Cache-Control: no-cache
Content-Type: multipart/x-mixed-replace; boundary=myboundary
--myboundary
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body data>
……
--myboundary
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body data>
2 IP Camera CGI Command
2.1 Realtime Video
Real-time video support RTSP protocol and HTTP protocol, protocol compliant to [RFC 2326]
2.1.1 H.264 Real-time video (video.cgi)
2.1.1.1 Input Common Parameters
To configure video.cgi,at least 5 parameters。Including userName, password, type, cameraID,
ID streamID.
Video.cgi Table:
Parameter Explanation Data Type Example Remarks
userName User name string userName =admin Login account name
8
password password string password =admin Login password for the
machine
type Protocol type string type= RTSP RTSP: RTSP video stream
HTTP:HTTP video stream
cameraID Channel int cameraID=1 cameraID,default 1
streamID Stream ID int streamID=1 1=Stream1 2=Stream2
Not required for
mjpeg.cgi
2.1.1.2 Get URL for MJPEG stream over HTTP from device
Request URL:
http://<servername>/cgi-bin/video.cgi?userName=<username>&password=<password>&
type=RTSP & cameraID=< cameraID >&streamID=< streamID >
Return:
Returned response text string URL:
rtsp://192.168.10.54:554/snl/live/1/1/Ux/sido=-Ux/sido=
2.1.1.3 Get HTTP Stream URL(HTTP H.264VideoStreamURL)
Input URL:
http://<servername>/cgi-bin/video.cgi?userName=<username>&password=<password>&ty
pe=HTTP& cameraID=< cameraID >&streamID=< streamID >
Return:
If successful,return URL:
http://192.168.10.54:554/snl/live/1/1/Ux/sido=-Ux/sido=
9
2.1.2 Motion JPEG Stream CGI(mjpeg.cgi&mjpeg2.cgi)
2.1.2.1 Input common parameters
For mjpeg.cgi program, at least output 4 parameters. userName, password, protocol
type,channel cameraID.
Mjpeg.cgi specs information :
Mjpeg specs Table:
Parameter Explanation Data Type Example Remarks
userName User name string userName =admin Login account name
password password string password =admin Password
type Protocol Type string type= RTSP RTSP: RTSP video
HTTP:HTTP video stream
cameraID Channel int cameraID=1 cameraID,default 1
frame Frame Rate int frame=100 Frame No.
2.1.2.2 Get RTSP video stream URL(RTSP Motion JPEG VideoStreamURL)
Input URL:
http://<servername>/cgi-bin/mjpeg.cgi?userName=<username>&password=<password>&
type=RTSP & cameraID=< cameraID >&streamID=< streamID >
Return :
If successful ,Return URL:
rtsp://192.168.10.54:554/snl/live/1/3/Ux/sido=-Ux/sido=
2.1.2.3 Get HTTP video stream URL(HTTP Motion JPEG VideoStreamURL)
Input URL:
http://<servername>/cgi-bin/mjpeg.cgi?userName=<username>&password=<password>&ty
10
pe=HTTP& cameraID=< cameraID >&streamID=< streamID >
Return :
If success,return URL:
http://192.168.10.54:554/snl/live/1/3/Ux/sido=-Ux/sido=
2.1.2.4 Get HTTP MJPEG video stream(HTTP Motion JPEG VideoStream)
Input URL:
http://<servername>/cgi-bin/mjpeg2.cgi?userName=<username>&password=<password>&
cameraID=< cameraID >&frame=<totol frame>
Return:
If successful,return mjpeg video stream data:
HTTP Code: 200 OK
Date: <Date>
Pragma: no-cache
Cache-Control: no-cache
Content-Type: multipart/x-mixed-replace; boundary=mjpegboundary
--mjpegboundary
HTTP Code: 200 OK
Content-Type: image/jpeg
Content-Length: <image size>
< image data>
……
--mjpegboundary
HTTP Code: 200 OK
Content-Type: image/jpeg
Content-Length: <image size>
< image data>
11
2.2 Snap shot(image.cgi)
2.2.1.1 Snap shot specs
2.2.1.2 Input paramaters:
Parameter Explanation Data Type Example Remarks
cameraID cameraID int cameraID=1 Default 1
quality Image
Quality
int quality=5 Range:1-9, 9=Highest
2.2.1.3 Get Snap Shot Image
Input URL:
http://<servername>/cgi-bin/image.cgi?userName=<username>&password=<password>&ca
meraID=< cameraID >&quality =< quality >
Return:
If successful, return image data volume:
HTTP Code: 200 OK
Content-Type: image/jpeg
Content-Length: <image size>
< image data>
2.3 Alarm Information(alarm.cgi)
2.3.1 Input Parameters
For alarm.cgi program, at least input 3 parameters. userName,password,action type.
Table 3.7.1(1)
specs Parameter Data Type Example Remarks
12
userName userName string userName =admin Login account name
password password string password =admin Login password for the
machine
action Operation
Type
string action=get Get
attach: connect
type Program Type string type=currentAlarm
Status
When Action choose
attach , Type is not
necessary .
Type item pls check 3.7.1
(2)
Table 3.7.1(2)
Alarm.cgi sub type Remarks
currentAlarmStatus Current Alarm Status
2.3.2 Alarm(alarmStatus)
2.3.2.1 Get Current Alarm Status
Input URL:
http://<servername>/cgi-bin/alarm.cgi?userName=<username>&password=<password>&
action=get&type=currentAlarmStatus
Return plain Text:
If successful ,Return plain Text :
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
alarmInfoCount=< alarmInfoCount >
alarmInfoBegin
13
alarmFlag=<flag>
alarmType=< alarmType >
sourceID=< sourceID >
alarmTime=< alarmTime >
alarmInfoEnd
Remarks: alarmInfoCount:Amount of Alarm information
alarmInfoBegin:Mark of Alarm Start
alarmFlag:Alarm Flag
alarmType:Alarm Type
sourceID:Source ID(If IO Alarm, this will be Alarm Input ID,Ohters will represent
cameraID)
alarmTime:Alarm Time
alarmInfoEnd:Mark for Alarm
Or,Return
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
Not Find AlarmInfo
2.3.2.2 Attach mode to get Alarm Information(attach)
Input URL:
http://<servername>/cgi-bin/alarm.cgi?userName=<username>&password=<password>&
action=attach
Return plain Text :
Return plain text file:
Once got alarm information,Return plain file, as below
HTTP Code: 200 OK
Date: <Date>
14
Pragma: no-cache
Cache-Control: no-cache
Content-Type: multipart/x-mixed-replace; boundary=myboundary
-- myboundary
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: < Body size>
< Body data>
……
-- myboundary
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <Body size>
<Body data>
Or it will indicate connecting
Remark:Specs explanation
alarmFlag:Alarm Flag
alarmType:Alarm Type
sourceID:Source ID((If IO Alarm, this will be Alarm Input ID,Ohters will represent
cameraID)
alarmTime:Alarm Time
2.4 云台(ptz.cgi)
2.4.1 PTZPTZ Enter Common parameters
In ptz.cgi procedure, carrying at least four parameters that the user name userName, password password, and
operating action.
Input URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&actio
n=<action> [&<argument>=<value>...]
15
Ptz.cgi specs Table:
Ptz.cgi specs Table
Parameter Explanation Data Type Example Remarks
username userName string userName =admin Login account name
password password string password =admin Device Password Login
camera cameraID int camera=1 Channel number, the
default one
action action string action =stop Commands as table
below
Action Table
Ptz.cgi Action Name Function
stop Stop
rotateUp Up
rotateDown Down
rotateLeft To the left
rotateRight Right
rotateLeftUp Left-up
rotateLeftDown Left-down
rotateRightUp Right-up
rotateRightDown Right-down
zoomIn Zoom In
zoomOut Zoom Out
FocusFar Far Focus
FocusNear Near Focus
irisIncrease Larger aperture
16
irisDecrease Smaller aperture
presetAdd Add preset point
presetInvoke Preset point call
presetDelete Preset Delete
listPrest Get preset
trackAddBegin Add track starts
trackAddEnd Add track ends
trackInvoke Track calls
trackDelete Delete track
listTrack Get Track
scanAddBegin Add Start Scan
scanAddEnd Scan Add End
scanInvoke Scan to call
scanDelete Scan Delete
listScan Get Scanning
tourAddBegin Add parade begins
tourAddPreset Parade Add Preset
tourAddEnd Add parade ends
tourRun Parade call
tourStop Parade stops
tourDelete Remove Parade
listTour Get Parade
keeperSet Guard bit is set
keeperRun Guard position call
getPosition Get directions
17
setPosition Set orientation
setNorthPosition Set position north
stop,zoomIn,zoomOut,FocusFar,FocusNear,irisIncrease,irisDecrease,
setNorthPositioncommand parameters do not carry back
2.4.2 PTZ Commands stop,zoomIn,zoomOut,FocusFar,FocusNear,
irisIncrease,irisDecrease,setNorthPosition
Command parameters do not carry back to stop (stop) command as an example, EnterURL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>& camera
=1&action=stop
2.4.3 PTZ Commands rotateUp, rotateDown, rotateLeft, rotateRight,
rotateLeftUp, rotateLeftDown, rotateRightUp, rotateRightDown
2.4.3.1 PTZ orientation order parameter Meaning
PTZ preset parameters have the meaning Table:
Argument Explanatio
n
Data Type Example Remarks
panSpeed Horizonta
l velocity
int panSpeed =60 Range :1 -63, 1: Slowest, 63:
fastest
tiltSpeed Vertical
speed
int tiltSpeed =60 Range :1 -63, 1: Slowest, 63:
fastest
Right rotateUp, rotateDown command, only tiltSpeed effective;
On rotateLeft and rotateRight, only panSpeed effective;
Right rotateLeftUp, rotateLeftDown, rotateRightUp, rotateRightDown, panSpeed and tiltSpeed
are valid.
18
Following command for doing command and left:
2.4.3.2 PTZ commands left (rotateLeft)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>& camera
=1&action=rotateLeft&panSpeed =60
2.4.3.3 PTZ commands left-up(rotateLeftUp)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&camera=1
&action=rotateLeftUp&panSpeed=60& tiltSpeed =60
2.4.4 PTZ preset point(Preset)
2.4.4.1 PTZ preset Parameter Meaning
Specs Explanation Data
Type
Example Remarks
presetCount Preset loop start flag int presetCount=1 Table shows the preset
number has been set
presetID Preset ID int presetID=1 Preset-number, range :1-255
19
2.4.4.2 PTZ(presetAdd)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&camera=1
&action=presetAdd&presetID=<preset ID >&presetName=<preset Name>
2.4.4.3 PTZ(presetInvoke)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&camera=1
&action= presetInvoke &presetID=<preset ID>
Returned response result text string:
Response codes Universal Response
2.4.4.4 PTZ(presetDelete)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&camera=1
&action= presetDelete &presetID=<preset ID >
Returned response result text string:
presetName Preset name string presetName=admi
n
Preset Name
presetBegin Preset point marks
the begin of the loop
body
presetBegin
next_preset
URL
Under a preset URL int next_presetURL=1
presetEnd Preset point marks
the end of the loop
body
presetEnd
20
Response codes Universal Response
2.4.4.5 PTZ(listPreset)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&camera=1
&action=listPreset
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
presetCount=<count>
presetBegin
presetID=< presetID (1)>
presetName=< presetName(1)>
next_presetURL = 1
…
next_presetURL = n
presetID=< presetID (n+1)>
presetName=< presetName (n+1)>
presetEnd
Preset: Count: presetCount
21
Begin: presetBegin
Flag: next_presetURL
End: presetEnd
Response codes Universal Response
2.4.5 PTZ(Track)
2.4.5.1 PTZ Track specs
PTZ track specs Table:
Specs Explanation Data Type Example Remarks
trackCount PTZ track
number
int trackCount=1 PTZ parameters of the
loop start.
trackID Track ID int trackID=1 Track Number
trackName Track Name string trackName=track1 Track name
trackBegin Track marks
the begin of
the loop body
trackBegin
next_trackURL Under a track
URL
int next_trackURL=1
trackEnd Completion
of Track
trackEnd
2.4.5.2 Add PTZ track(trackAdd)
Add a track starting point:
RequestURL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action=trackAddBegin&trackID=<trackID>
Add track end point:
Request URL:
22
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action=trackAddEnd&trackID=<trackID>&trackName=<trackName>
Returned success response result text string:
Response codes Universal Response
2.4.5.3 Call PTZ Track(trackInvoke)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action= trackInvoke &trackID=< trackID >
Response codes Universal Response
2.4.5.4 Remove Track(trackDelete)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action= trackDelete &trackID=< trackID >
Response codes Universal Response
2.4.5.5 Get PTZ track(listTrack)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=admin&password=<password>&camera=
23
1&action= listTrack
Returned success response result text string::
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
trackCount =<count>
trackBegin
trackID =< trackID (1)>
trackName =< trackName (1)>
next_trackURL = 1
…
next_trackURL = n
trackID =< trackID (n+1)>
trackName =< trackName (n+1)>
trackEnd
Circulate Part:
Track: Count: trackCount
Begin: trackBegin
Flag: next_trackURL
End: trackEnd
Response codes Universal Response
2.4.6 PTZ scan(Scan)
2.4.6.1 PTZ scan Specs meaning
Specs Explanation Data Type Example Remarks
24
scanCount PTZ scan
number
int scanCount=1 PTZ scanning loop
parameters start flag
scanID Scan ID int scanID=1
scanName Scan name string scanName=admin
scanaBegin Marks the
end of the
loop body
scan
scanBegin
next_scanURL Next scanning
URL
int next_scanURL=1
scanEnd Marks the
end of the
loop body
scan
scanEnd
2.4.6.2 Add a PTZ scan(scanAdd)
Add a scan starting point:
RequestURL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action= scanAddBegin & scanID =<scanID>
Add scan end point:
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action=scanAddEnd& scanID =<scanID>& scanName =<scanName>
Returned success response result text string:
Response codes Universal Response
25
2.4.6.3 Call PTZ scan(scanInvoke)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action= scanInvoke & scanID =< scanID >
Response codes Universal Response
2.4.6.4 Delete pan scan(scanDelete)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action= scanDelete & scanID =< scanID >
Response codes Universal Response
2.4.6.5 Get PTZ scan(listScan)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&camera=1
&action=listScan
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
26
Content-Length: <body size>
< body >
scanCount =<count>
scanBegin
scanID =< scanID (1)>
scanName =< scanName (1)>
next_scanURL = 1
…
next_trackURL = n
scanID =< scanID (n+1)>
scanName =< scanName (n+1)>
scanEnd
Circulate Parts:
Scan: Count: scanCount
Begin: scanBegin
Flag: next_scanURL
End: scanEnd
Response codes Universal Response
2.4.7 PTZ Patrol(Tour)
Argument Explanation Data Type Example Remarks
tourCount Number of PTZ
Patrol
int tourCount=1 Head start flag Patrol
loop parameters
tourID Patrol ID int tourID=1 Patrol No
tourName Patrol name string tourName=admin Patrol name
tourBegin Patrol marks
the begin of
the loop body
tourBegin Begin
next_tourURL Under a int next_tourURL=1 The next Patrol
27
Patrol URL
tourEnd Patrol marks
the end of the
loop body
tourEnd
presetID Preset point
number
int presetID =1 Preset point number
speed Speed int speed = 60 Speed,range:1-63
time Residence
time
int time=10 Time, range :1-255
seconds
presetBegin Patrol marks
the begin of
the loop body
tourBegin
next_presetU
RL
Under a
Patrol URL
int next_tourURL=1 The next Patrol
presetEnd Patrol marks
the end of the
loop body
tourEnd
2.4.7.1 Add PTZ Tour(tourAdd)
Add patrol starting point:
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action= tourAddBegin & tourID =< tourID >
Add preset point as part of the tour:
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action= tourAddPreset & tourID =< tourID >& presetID =< presetID >& speed=<
speed>& time=< time >
Set tour end:
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action= tourAddEnd& tourID =< tourID >& tourName =< tourName >
28
Returned success response result text string:
Response codes Universal Response
2.4.7.2 Call PTZ Tour(tourRun)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action= tourRun & tourID =< tourID >
Response codes Universal Response
2.4.7.3 Stop PTZ Tour(tourStop)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action= tourStop & tourID =< tourID >
Response codes Universal Response
2.4.7.4 Remove Tour(tourDelete)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action= tourDelete & tourID =< tourID >
Response codes Universal Response
2.4.7.5 Get PTZ Tour(listTour)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1& action = listTour
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
tourCount=%d
29
tourID=%d
tourName=%s
tourEnd=%d
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
tourCount =<count>
tourBegin
tourID=< tourID (1)>
tourName =< tourName (1)>
prestCount =<count>
prestBegin
prestID=< prestID (1)>
prestName =< prestName (1)>
next_prestURL = 1
…
next_prestURL = n
prestID =< prestID (n+1)>
prestName =< prestName (n+1)>
prestEnd
next_tourURL = 1
…
next_tourURL = n
tourID =< tourID (n+1)>
tourName =< tourName (n+1)>
prestCount =<count>
prestBegin
prestID=< prestID (1)>
prestName =< prestName (1)>
next_prestURL = 1
…
30
next_prestURL = n
prestID =< prestID (n+1)>
prestName =< prestName (n+1)>
prestEnd
tourEnd
Back to acknowledge plain text:
For success, returns plain text:
Repeared string listing results.:
cameraID =% d
Cycle parts:
Count: tourCount
Begin: tourBegin
Flag: next_tourURL
End: tourEnd
Preset: Count: presetCount
Begin: presetBegin
Flag: next_presetURL
End: presetEnd
Response codes Universal Response
2.4.8 PTZ guard(keeper)
Argument Explanation Data Type Example Remarks
keeperType Type of guard
Type of guard
int keeperType =1 1: preset position,
2: Scanning,
3: self-learning,
4: Patrol/Tour
keeperID Guard-bit ID int keeperID =1 keeperType
corresponding number
time Residence
time
int time=10 Guard-bit execution
time, range :1-240
31
minutes
2.4.8.1 Setting PTZ guard(keeperSet)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action= keeperSet & keeperType =< keeperType >& keeperID =< keeperID >& time =<
time >
Response codes Universal Response
2.4.8.2 Activate Guard(keeperRun)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action= keeperRun
Response codes Universal Response
2.4.9 PTZ position(Position)
Argument Explanation Data Type Example Remarks
pan Horizontal
angle
float pan =45.5 Range:0-360
tilt Vertical speed float tilt =30.1 Range:0-90
zoom Zoom float zoom =10 Relative the the camera
max zoom
2.4.9.1 Read PTZ postion(getPosition)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
32
era=1&action= getPosition
Response codes Universal Response
2.4.9.2 Setting PTZ postion(setPosition)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action= setPosition& pan =< pan >& tilt =< tilt >& zoom =< zoom >
Response codes Universal Response
Return position information:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
pan =%d
tilt =%d
zoom =%d
Response codes Universal Response
2.4.9.3 Setting PTZ True North(setNorthPosition)
Request URL:
http://<servername>/cgi-bin/ptz.cgi?userName=<username>&password=<password>&cam
era=1&action= setNorthPosition
Response codes Universal Response
2.5 Device Configuration(param.cgi)
2.5.1 Common parameters
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<username>&password=<password>&a
ction=<action>&type=<type>[&<argument>=<value>...]
In param.cgi procedure, carrying at least four parameters that the user name userName,
33
password, then operating action and program sub-type type.
Response have two kinds:
One is to set parameters result response, this response using a common response plain text :
HTTP Code: 200 OK
Content-Type: text/plain
< message>
Another is to get the parameters, as follows:
HTTP Code: 200 OK
Content-Type: text/plain
<parameter>=<value>
<parameter>=<value>
...
Table(1)
Parameter Description Data Type Example Notes
userName User name string userName =admin Landing machine
account
password Password string password =admin Login password for the
machine
action Type of
operation
string action=set get:
set:
type Configuration
Type
string type= AVStream See Table(2) below
cameraID ID int cameraID=1 Device supports camera
ID, associated with the
device capabilities
streamID Stream ID int streamID=1 Device supports stream
ID, associated with the
device capabilities
cover Cover the
loop data
string scheduleTimeActio
n=cover
Cover the original loop
data
alarmInID Alarm inpu int alarmInID=1 AlarmID is decided by
34
device information ,
accumulate from 1
alarmOutID Alarm output int alarmOutID=1 AlarmID is decided by
device information ,
accumulate from 1
enableFlag Flag is on or
off
unsigned
char
enableFlag=0 0:Off
Not 0:On
IPProtover Protocol
version
int IPProtoVer=1 1:IPV4
2:IPV6
Only support IPV4
comID Serial port ID int comID=1 Device supports serial
port ID, associated with
the device capabilities
next_paramU
RL
Next
parameter
information
int next_paramURL=2 Starting from 2
Table(2)
param.cgi Remarks
Details
deviceName Device name
deviceID Device ID
deviceInfo Device information
localNetwork Local network
devicePort Device port
cameraInfo Camera information
dateTime Data & time
OSD OSD
microphone Microphone
35
protocolSecurity Protocol security
alarmParam Alarm Parameter
ADSLNetwork ADSL network
protocolInfo Protocol information
deviceDiskInfo Disk information
PTZTimer PTZ timer
sourceResolution Source resolution
IPDomePTZID High speed dome ID
Stream Configuration
streamAbility Stream ability
AVStream Stream
Network Service Configuration
PPPoE PPPoE
DDNS DDNS
Record Configuration
recordPolicy Record Policy
recordDirInfo Record Path
Alarm Configuration
alarmIn Alarm input
alarmOut Alarm output
motionAlarm Motion detection alarm
IOalarmLinkage IO linkage
diskAlarm Disk alarm
blindArea Alarm area
External device configuration
36
PTZKeyboard PTZ keyboard
PTZ PTZ
RS485Device RS485 device
Service Center
SMTP SMTP Service
alarmCenter Alarm Center
NTP NTP Service
2.5.2 Device Configuration
2.5.2.1 Device Information
2.5.2.1.1 Common Parameters
See the table below:
Device Common parameters
Parameters Description Data Type Example Notes
deviceID Device ID string deviceID=0447 Device-unique identifier
deviceName Device Name string deviceName=came
ra Name
deviceType Device Tpey int deviceType=1 1:IPCamera
productMode
l
Equipment
Type
string productModel=IPC
54/11
MACAddress MAC address string MACAddress=00:1C
:27:00:00:29
hardwareVer Hardware
Version
string hardwareVer=V080
_2
softwareVer Software
Version
string softwareVer=v1.6_
build044014_032
37
cameraNum Number of
cameras
int cameraNum=1
alarmInNum Alarm Input
Numbers
int alarmInNum=1
alarmOutNu
m
Alarm Output
Numbers
int alarmOutNum=1
RS485Num RS485 serial
Numbers
int RS485Num=1
2.5.2.1.2 Get Device Information(getDeviceInfo)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action= get &type=deviceInfo
Input parameters description:
See the Device Common parameters
Returns the response:
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
deviceID=< deviceID >
deviceName=< deviceName >
deviceType=< deviceType >
productModel =< productModel >
MACAddress=< MACAddress >
hardwareVer=< hardwareVer >
softwareVer=< softwareVer >
cameraNum=< cameraNum >
alarmInNum=< alarmInNum >
alarmOutNum=< alarmOutNum >
RS485Num=< RS485Num >
38
Others response codes Universal Response
Returns the text string parameters description:
See the Device Common parameters
2.5.2.1.3 Set the Dvice name(setDeviceName)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user name>&password=<password>&
action =set&type= deviceName &deviceName=< deviceName >
Input parameters description:
deviceName:Device aliases
Response codes Universal Response
2.5.2.1.4 Set Device ID(setDeviceID)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user name>&password=<password>&
action =set&type= deviceID &deviceID=< deviceID>
Input parameters description::
deviceID:Device number
Response codes Universal Response
2.5.2.2 Local Network(localNetwork)
2.5.2.2.1 Local network parameters description
See table below:
Network parameters information
Paramater Description Data Type Example Notes
IPProtoVer IP version int IPProtoVer=1 1:IP V4
2:IP V6
IP Local IP string localIP=192.168.10.
54
Device IP
subnetMask Local subnet
mask
string localSubnetMask=2
55.255.255.0
Subnet Mask
gateway Gateway string gateway=192.168.1 Device Gateway
39
0.1
preferredDNS Primary DNS string preferredDNS=202.
96.128.86
Primary DNS
alternateDNS Secondary
DNS
string alternateDNS=202.
96.128.86
Secondary DNS
autoGetIPFla
g
Set DHCP to
Auto or
Manual
int autoGetIPFlag=0 0:Manual
1:Automatic
2.5.2.2.2 Get Loacal Network Parameters(getNetwork)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type= localNetwork&IPProtoVer=1
Notes:
As there are 2 different IP version,IPProtoVer parameters is needed in URL.
Returns the response:
Returned success response result text string::
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
IP=< IP >
subnetMask =< subnetMask >
gateway =< gateway >
preferredDNS =< preferredDNS >
alternateDNS =< alternateDNS >
autoGetIPFlag =< autoGetIPFlag >
Others response codes Universal Response
Returns the text string parameters description:
See the Network parameters information table
2.5.2.2.3 Set the Local network parameters(setNetwork)
Input URL:
40
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type= localNetwork [&<argument>=<value>...]
Input parameters description:
See the network parameters information table & Configuartion Comon parameters
table (1)
Return the reply:
Response codes Universal Response
2.5.2.3 ADSL Network(ADSLNetwork)
2.5.2.3.1 ADSL Network Parameters Description
ADSL Network Parameters
Parameters Description Data Type Example Notes
AdslIP Machine IP string localIP=192.168.10.
54
IPProtoVer IP Version int IPProtoVer=1 1:IP V4
2:IP V6
2.5.2.3.2 Get ADSL Network Parameters(getADSLNetwork)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type= ADSLNetwork &IPProtoVer=1
Input parameters description:
See the ADSL Network Parameters& Configuartion Comon parameters table (1)
Returns the response:
Returned success response result text string::
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
IPProtoVer =< IPProtoVer >
AdslIP =< AdslIP >
Return the reply:
Others response codes Universal Response
41
Returns the text string parameters description:
See the ADSL network parameter list.
2.5.2.4 Device Port(devicePort)
2.5.2.4.1 Description
See the table below:
Device Port Parameters
Paramater Description Data Type Example Notes
controlPort Control port unsigned
short
controlPort=3000
1
Signaling
control,audio&video
port
httpPort HTTP port unsigned
short
httpPort=80 Web port
rtspPort RTSP port unsigned
short
rtspPort=554 RTSP port (Streaming
video)
rtmpPort RTMP port unsigned
short
rtspPort=8080 RTMP connection port
(Flash)
2.5.2.4.2 Get Device Port Parameters(getDevicePort)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=devicePort
Input parameters description:
See the Configuartion Comon parameters table (1)
Returns the response:
Returned success response result text string::
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
controlPort =< controlPort >
42
httpPort =< httpPort >
rtspPort =< rtspPort >
rtmpPort =< rtmpPort >
Others response codes Universal Response
Returns the text string parameters description:
See the Device port parameter.
2.5.2.4.3 Set the Device port parameters(setDevicePort)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type= devicePort[&<argument>=<value>...]
Input parameters description:
See the Device Port Parameters& Configuartion Comon parameters table (1)
Others response codes Universal Response
Returns the text string parameters description:
See the Device port parameter.
2.5.2.5 Camera Information(cameraInfo)
2.5.2.5.1 Camera parameters:
See the table below:
Camera information parameters
Paramater Description Data Type Example Notes
cameraID Channel
number
int cameraID=1 Channel number
cameraName Camera name string cameraName=n
ame
Camera name
2.5.2.5.2 Get camera name(getCameraName)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<username>&password=<password>&
action=get&type=cameraInfo& cameraID =<cameraID>
Input parameters description:
43
See the Camera information parameters
Returns the response:
Returned success response result text string::
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
cameraName =< cameraName >
Others response codes Universal Response
Returns the text string parameters description:
See Camera information parameters
2.5.2.5.3 Set camera name(setCameraName)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<username>&password=<password>&
action=get&type=cameraInfo& cameraID =<cameraID>& cameraName =<cameraName>
Input parameters description:
See the Camera information parameters& Configuartion Comon parameters table (1)
Return the reply:
Response codes Universal Response
2.5.2.6 Device Date&Time(dateTime)
2.5.2.6.1 Description
See the table below:
Device Date&Time Parameters
Paramater Description Data Type Example Notes
year year unsigned
short
year=2013
month month unsigned
short
month=01
day Day unsigned
short
day=27
hour Hour unsigned hour=2
44
short
minute Minute unsigned
short
minute=36
second Second unsigned
short
second=36
2.5.2.6.2 Get device Date&Time parameters(getDateTime)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=dateTime
Input parameters description:
See the Device Date&Time Parameters
Returns the response:
Returned success response result text string::
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
year =< year >
month =< month >
day =< day >
hour =< hour >
minute =< minute >
second =< second >
Others response codes Universal Response
Returns the text string parameters description:
See Device Date&Time Parameters
2.5.2.6.3 Set device Date&Time parameters(setDateTime)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=dateTime [&<argument>=<value>...]
Input parameters description:
See the Device Date&Time Parameters& Configuartion Comon parameters table (1)
45
Return the reply:
Response codes Universal Response
2.5.2.7 Watermark(OSD)
2.5.2.7.1 OSD description
See the table below:
OSD Parameters
Paramater Description Data Type Example Notes
cameraID Camera ID int cameraID=1
OSDInfoCoun
t
OSD info
count
int OSDInfoCount =5
OSDAction OSD Loop
operation
string OSDAction=cover When the configuration behavior is
set, if there is no sign to carry this
behavior, the default for the Loop is
added.
OSDBegin OSD
information
starting mark
int OSDBegin/OSDBe
gin=1
When the configuration behavior is
set, must carry this flag, no specific
requirements for value
OSDEnd OSD
information
ends mark
int OSDEnd/OSDEnd=
3
When the configuration behavior is
set, must carry this flag, no specific
requirements for value
next_OSDUR
L
The next OSD
information
starting mark
int
next_OSDURL=2
Start from .If value is 2,parameters
connected behind is 2. When the
configuration behavior is set, and the
time of greater than 1 must carry this
flag, when no specific requirements
for value
OSDType OSD type int OSDType=1 1: Device Name
2: The camera number
3: Camera name
4: Time Watermark
5: Text Watermark
OSDEnableFl Watermark
information
unsigned OSDEnableFlag=1 0: Do not display
46
ag display flag char 1: Display
topX x- coordinate int topX=0 Watermark information in the lower
left corner of the work area
coordinates x, refers to the first few
columns
topY y- coordinate int topY=0 Watermark information in the work
area y coordinates of the lower left
corner, referring to the first few lines
info Watermark
information
string Info=
MM/DD/YYYY
hh:mm:ss ww
Type associated with the OSD.
When OSDType = 1,2,3 when, info is
invalid
When OSDType = 4 info format is the
following categories::
1:YYYY-MM-DD hh:mm:ss ww
2:hh:mm:ss YYYY-MM-DD ww
3:MM/DD/YYYY hh:mm:ss ww
4:hh:mm:ss MM/DD/YYYY ww
5:DD/MM/YYYY hh:mm:ss ww
6:hh:mm:ss DD/MM/YYYY ww
OSDType=5 info is text.
2.5.2.7.2 Get OSD Parameters (getOSD)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=OSD& cameraID =< cameraID >
Input parameters description:
See the OSD Parameters
Returns the response:
Returned success response result text string::
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
47
OSDInfoCount =<count>
OSDBegin
OSDType =< OSDType( 1)>
OSDEnableFlag =< OSDEnableFlag (1)>
topX =< topX (1)>
topY =< topY (1)>
info =< info(1)>
next_OSDURL=2
…
next_OSDURL=n
OSDType =< OSDType (n+1)>
OSDEnableFlag =< OSDEnableFlag (n+1)>
topX =< topX (n+1)>
topY =< topY (n+1)>
info =< info(n+1)>
OSDEnd
Loop part:
OSD: Count: OSDInfoCount
Begin: OSDBegin
Flag: next_OSDURL
End: OSDEnd
Notes:
According OSDInfoCount value, repeat the string
OSDType =< OSDType>
OSDEnableFlag =< OSDEnableFlag>
topX =< topX)>
topY =< topY>
info =< info>
Repeat output string through next_ OSDURL =%d to separate.
Others response codes Universal Response
Returns the text string parameters description:
See the OSD Parameters
48
2.5.2.7.3 Set OSD Parameters(setOSD)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=dateTime&cameraID=<cameraID>[&<argume
nt>=<value>...]
Wherein, argument as shown below:
OSDAction=<action>&OSDBegin=&OSDType=<OSDType(1)>&OSDEnableFlag=<OSDEnableFlag
(1)>1&topX=< topX (1)>&topY=< topY (1)>&info=< info (1)>&
next_OSDURL =2&
…
& next_OSDURL =n&
OSDType=<OSDType(n+1)>&OSDEnableFlag=<OSDEnableFlag(n+1)>1&topX=<topX
(n+1)>&topY=< topY (n+1)>&info=< info (n+1)>&OSDEnd=n
Input parameters description:
See the OSD Parameters& Device Date&Time Parameters& Configuartion Common
parameters table (1)
Notes:
OSDInfoNum value watermark appears to be based on the actual number of OK. As an example, if
the command, there are two watermarking parameters and OSDInfoNum is 1, then the device
will be set before a watermark, need special attention.
Set when the operation type is when, OSDType 4 (time watermark) when, info should be one of
the following five formats to correctly display the time:
YYYY-MM-DD hh:mm:ss ww
hh:mm:ss YYYY-MM-DD ww
MM/DD/YYYY hh:mm:ss ww
hh:mm:ss MM/DD/YYYY ww
DD/MM/YYYY hh:mm:ss ww
hh:mm:ss DD/MM/YYYY ww
Return the reply:
Response codes Universal Response
49
2.5.2.8 Source Resolution(sourceResolution)
2.5.2.8.1 Description
Source resolution parameters
Paramater Description Data Type Example Notes
videoResoluti
on
Resolution string videoResolution=1
080*1920
Height*width
resolutionNa
me
Resolution
name
string resolutionName=1
920
height Height int height=1080 Be used to Set
width width int width=1920 Be used to Set
2.5.2.8.2 Get Source Resolution(getSourceResolution)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=sourceResolution&cameraID=1
Input parameters description:
See the Source resolution parameters & Configuartion Common parameters table (1)
Returns the response:
Returned success response result text string::
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
cameraID =< cameraID >
videoResolution =< hight * width >
resolutionName = <resolutionName>
Others response codes Universal Response
Returns the text string parameters description:
See the Source resolution parameters
50
2.5.2.8.3 Set Source Resolution(setSourceResolution)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=sourceResolution&cameraID=<cameraID >[&<
argument>=<value>...]
Input parameters description:
See the Source resolution parameters
Return the reply:
Response codes Universal Response
2.5.2.9 Microphone(microphone)
2.5.2.9.1 Description
See the table below:
Microphone parameters
Paramater Description Data Type Example Notes
cameraID Channel
name
int cameraID=1 Channel nuber
microphoneE
nableFlag
Open/shutd
own
Microphone
unsigned
char
microphoneEnable
Flag =1
0:Shutdown
1:Open
microphoneT
ype
Microphone
type
int microphoneType
=1
1:built-in
2:External
3:Line In
4:The differential input
line
5:Dual input
(Different devices may
support different types)
volume volume int volume=3 Range:
(0-100)
51
2.5.2.9.2 Get Microphone Parameters(getMicrophone)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type= microphone &cameraID=< cameraID >
Input parameters description:
See the Microphone parameters
Returns the response:
Returned success response result text string::
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
microphoneEnableFlag =< microphoneEnableFlag >
microphoneType=< microphoneType >
volume=< volume >
Notes:
Others response codes Universal Response
Returns the text string parameters description:
See the Microphone parameters
2.5.2.9.3 Set Microphone Parameters(setMicrophone)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=microphone&cameraID=<cameraID >[&<argu
ment>=<value>...]
Input parameters description:
See the Microphone parameters
Return the reply:
Response codes Universal Response
2.5.2.10 IP Dome PTZ ID(IPdomePTZID)
2.5.2.10.1 Description
See the table belwo:
52
IP domePTZ ID parameters
Paramater Description Data Type Example Notes
domeID IP Dome ID Int domeID=1
2.5.2.10.2 Get IP Dome PTZ ID(getIPDomePTZID)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type= IPDomePTZID
Input parameters description:
See the IP domePTZ ID parameters & Configuartion Common parameters table (1)
Returns the response:
Returned success response result text string::
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
domeID=<domeID>
Others response codes Universal Response
Returns the text string parameters description:
See the IP domePTZ ID parameters
2.5.2.10.3 Set IP Dome PTZ ID(setIPDomePTZID)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type= IPDomePTZID [&<argument>=<value>...]
Input parameters description:
See the IP domePTZ ID parameters & Configuartion Common parameters table (1)
Return the reply:
Response codes Universal Response
53
2.5.2.11 Device Disk Inforamtion(deviceDiskInfo)
2.5.2.11.1 Description
See the table below:
Device disk parameters
Paramater Description Data Type Example Notes
diskInfoCoun
t
diskInfoCount int diskInfoCount=1
diskInfoBegin diskInfoBegin int diskInfoBegin
diskInfoEnd diskInfoEnd int diskInfoEnd
next_diskInfo
URL
next_diskInfo
URL
int next_diskInfoURL=
2
Start from 2
diskID diskID int diskID=1
diskTotalSize diskTotalSize int diskTotalSize=0
diskFreeSize diskFreeSize int diskFreeSize=0
diskStatus diskStatus int diskStatus=1 1: Normal
2: abnormal
3: No disk
4: Disk write protected
5: Disk not formatted
6: Being formatted
2.5.2.11.2 Get Device Disk Information(getDeviceDiskInfo)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=deviceDiskInfo
Input parameters description:
See the Device disk parameters & Configuartion Comon parameters table (1)
Returns the response:
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
54
Content-Length: <body size>
< body >
diskInfoCount=< diskInfoCount >
diskInfoBegin
diskID = <diskID>
diskTotalSize=<diskTotalSize>
diskFreeSize=<diskFreeSize>
diskStatus=<diskStatus>
next_diskInfoURL = 2
…
next_diskInfoURL =n
diskID = <diskID>
diskTotalSize=<diskTotalSize>
diskFreeSize=<diskFreeSize>
diskStatus=<diskStatus>
diskInfoEnd
Others response codes Universal Response
Returns the text string parameters description:
See the Device disk parameters
2.5.2.12 PTZ Timer(PTZTimer)
2.5.2.12.1 Description
See the table below:
PTZ Timer parameters
Paramater Description Data Type Example Notes
PTZTimerEna
bleFlag
Open/Close
PTZ Timer
unsigned
char
PTZTimerEnableFla
g=0
0:Close
1:Open
timerMode Timer mode int timerMode=2 1:Once
2:Loop everyday
year Year unsigned year=2013
55
short
month Month unsigned
short
month=01
day Day unsigned
short
day=27
hour Hour unsigned
short
hour=2
minute Minute unsigned
short
minute=36
second Second unsigned
short
second=36
PTZTimerTim
eSegmentCou
nt
PTZTimerTim
eSegmentCou
nt
int PTZTimerTimeSeg
mentCount=5
PTZTimerActi
on
PTZTimerActi
on
string PTZTimerAction=co
ver
When the configuration
behavior is set, if there is
no sign to carry this
behavior, the default for
the loop is added.
PTZTimerTim
eSegmentBeg
in
PTZTimerTim
eSegmentBeg
in
int PTZTimerTimeSeg
mentBegin/
PTZTimerTimeSeg
mentBegin=1
When the configuration
behavior is set, must
carry this flag, no specific
requirements for value.
next_PTZTim
erTimeSegme
ntURL
next_PTZTim
erTimeSegme
ntURL
int next_PTZTimerTim
eSegmentURL=2
Starting from 2.If the
value is 2, It means that
the later parameters is
2.When the
configuration behavior is
set, and the time of
greater than 1 must carry
this flag, no specific
requirements for value
PTZTimerTim
eSegmentEnd
PTZTimerTim
eSegmentEnd
int PTZTimerTimeSeg
mentEnd/
PTZTimerTimeSeg
mentEnd=3
When the configuration
behavior is set, and the
time of greater than 1
must carry this flag, no
specific requirements for
56
value
beginTime Start time int beginTime=60300 Range:0-86400
endTime Ends time int endTime=60600 Range:0-86400
PTZOperation
Type
PTZ
Operation
type
int PTZOperationType
=16
16: Preset Call
19: Trace Call
PTZOperation
Value
PTZ
Operation
Value
int PTZOperationValue
=1
2.5.2.12.2 Get PTZ Timer Parameters(getPTZTimer)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type= PTZTimer&cameraID=1
Input parameters description:
See the PTZ Timer parameters& Configuartion Common parameters table (1)
Returns the response:
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
cameraID=< cameraID>
timerMode = <timerMode>
year=<year>
month=<month>
day=<day>
hour=<hour>
minute=<minute>
second=<second>
PTZTimerTimeSegmentCount=<PTZTimerTimeSegmentCount>
PTZTimerTimeSegmentBegin
beginTime=<beginTime>
57
endTime=<endTime>
PTZOperationType=<PTZOperationType>
PTZOperationValue=<PTZOperationValue>
next_PTZTimerTimeSegmentURL=2
….
Next_PTZTimerTimeSegmentURL=n
beginTime=<beginTime>
endTime=<endTime>
PTZOperationType=<PTZOperationType>
PTZOperationValue=<PTZOperationValue>
PTZTimerTimeSegmentEnd
Others response codes Universal Response
Returns the text string parameters description:
See the PTZ Timer parameters
2.5.2.12.3 Set PTZ Timer Parameters(setPTZTimer)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=PTZTimer&cameraID=1[&<argument>=<value
>...]
Input parameters description:
See the PTZ Timer parameters& Configuartion Common parameters table (1)
Return the reply:
Response codes Universal Response
2.5.3 Stream Configuration
2.5.3.1 Description
See the table below:
Audio and video stream parameter
Paramater Description Data Type Example Notes
streamName Stream Name string streamName=strea
m1
58
videoEncode
Type
Video Encode
Type
int encodeType=1 1:H264 base profile
2:MJPEG
4:H264 main profile
5:H264 high profile
audioEncode
Type
Audio Encode
Type
int audioEncodeType=
1
102:G711_Alaw
103:G711_Ulaw
107:ARM
108:PCM
resolution Resolution int resolution=1 704*576
640*480
640*368
1280*720
1920*1080
1600*1200
The resolution of the
different equipment
support is not the same
frameRate Frame
rate(fps)
int frameRate=25 Range:(1-25)
iFrameInterv
al
iFrame
Interval
int iFrameInterval=2 Unit:Second
bitRateType Bitrate Type int bitRateType=1 1:CBR
2:VBR
bitRate BitRate(kbps) int bitRate=6000 Rate associated with
resolution. When the
resolution is less than
704 × 576, bit rate range:
(100-6000) kbps
When the resolution is
1280 * 720, the bit rate
range: (200-8000) kbps
When the resolution is
1920 * 1080, the rate
range: (500-12000) kbps
59
quality Quality int quality=5 范围:1-9
2.5.3.2 Get the current video stream parameters(getAVStream)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=AVStream&cameraID=<cameraID>&strea
mID=<streamID>
Input parameters description:
See the Audio and video stream parameter& Configuartion Common parameters table (1)
Returns the response:
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
streamName =< streamName >
videoEncodeType =< videoEncodeType >
audioEncodeType =< audioEncodeType >
resolution =< resolution >
frameRate =< frameRate >
iFrameInterval =< iFrameInterval >
bitRateType =< bitRateType >
bitRate =< bitRate >
quality =< quality >
Others response codes Universal Response
Returns the text string parameters description:
See the Audio and video stream parameter
2.5.3.3 Set the current video stream parameters(setAVStream)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=AVStream&cameraID=<cameraID>&streamID
=<streamID>[&<argument>=<value>...]
60
Input parameters description:
See the Audio and video stream parameter& Configuartion Common parameters table (1)
Return the reply:
Response codes Universal Response
2.5.3.4 Get the current video streaming capabilities(getAVStreamAbility)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=streamAbility
Input parameters description:
See the Audio and video stream parameter& Configuartion Common parameters table (1)
Returns the response:
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
AVStreamCount=<AVStream Number>
AVStreamAbilityBegin
streamID=<streamID>
streamName =< streamName >
resolution=< resolution >
next_AVStreamURL=<next AVStream >
……
AVStreamAbilityEnd
Others response codes Universal Response
Returns the text string parameters description:
See the Audio and video stream parameter
61
2.5.4 Network Services Configuration
2.5.5 Video configuration
2.5.5.1 Record Policy(recordPolicy)
2.5.5.1.1 Description
See the table below:
Record policy parameter correspond table
Paramater Description Data Type Example Notes
isOpenSched
uleRecordPol
icy
Flage of
Schedule to
open a
Videorecordi
ng
unsigned
char
isOpenScheduleRec
ordPolicy =1
0: Disabled
Non-0: Enabled
scheduleReco
rdType
Schedual
videorecordin
g type
int scheduleRecordTyp
e=0
0: No recording
1:Always Recording
2:Schedule recording
3:Alarm ecording
Schedule
time
behavior
weekDayCou
nt
Arming Days int weekDayCount =1 Maximum 7
scheduleTime
Action
Schedule time
behavior
string scheduleTimeActio
n=cover
When configured acts as
a set, if not carry this
behavior flag, the default
is to add the loop
weekDayBegi
n
Arming days
the loop start
flag
int weekDayBegin=1 When configured acts as
a set, must carry this
flag, No specific
requirements for value
weekDay weekday int weekday=5 0-6, 0 is Sunday
62
scheduleTime
Num
Arming time
Noubers
int scheduleTimeNum
=1
startTime(1..
3)
Arming start
time
long startTime1 = 1000 Range:0-86400
endTime(1..3
)
Arming ends
time
long endTime1= 2000 Range:0-86400
next_weekDa
yURL
Next
Schedule
time , the
start flag URL
int next_weekDayURL
=2
Starting from 2.If the
value is 2, It means that
the later parameters is
2.When the
configuration behavior is
set, and the time of
greater than 1 must
carry this flag, no specific
requirements for value
weekDayEnd Arming
days,the flag
of loop ends
int weekDayEnd=1 When the configuration
behavior is set, must
carry this flag, no specific
requirements for value.
Alarm
recording
isOpenAlarm
Record
Whether to
open the
alarm
recording
unsigned
char
isOpenAlarmRecor
d =0
0: Disabled
Non-0: Enabled
isAlarmRecor
dFileLocked
Wether to
lock Alarm
recording files
unsigned
char
isAlarmRecordFileL
ocked=0
0: Disabled
Non-0: Enabled
alarmPreRec
ordTime
Alarm
pre-record
time
int alarmPreRecordTi
me=10
How many seconds of
pre-recorded
alarmDelayR
ecordTime
Alarm delay
recording
time
int alarmDelayRecordT
ime=30
How many seconds delay
recording
alarmEventC
ount
The number
of alarm
int alarmEventCount=
1
The number of alarm
events
63
events
alarmEventA
ction
Alarm Event
Behavior
string alarmEventAction=
cover
When configured acts as
a set, if not carry this
behavior flag, the default
is to add the loop.
alarmEventB
egin
Alarm events
start flag
int alarmEventBegin=1
/ alarmEventBegin
When the configuration
behavior is set, must
carry this flag, no specific
requirements for value.
next_alarmEv
entURL
Next
Schedule
time , the
start flag
URL
int next_alarmEventU
RL=2
Starting from 2.If the
value is 2, It means that
the later parameters is
2.When the
configuration behavior is
set, and the time of
greater than 1 must
carry this flag, no specific
requirements for value
alarmEventE
nd
End flag of
alarm events
int alarmEventEnd=3/
alarmEventEnd
When the configuration
behavior is set, must
carry this flag, no specific
requirements for value.
alarmID Alram ID int alarmID=1 Alarm ID
alarmType Alarm type int alarmType=1 1: I/O Alarm
2 : Motion detection
Alarm
Recording
parameters
isRecordAudi
oOpened
Is audio
recording
Opened
unsigned
char
isRecordAudioOpe
ned=0
0: Disabled
Non-0: Enabled
cycleWriteFla
g
Cycle Write
Flag
unsigned
char
cycleWriteFlag
=0
0: Disabled
Non-0: Enabled
isRedundancy
Whether
redundancy unsigned
char
isRedundancy
=0 0: Disabled
Non-0: Enabled
64
saveDays saveDays int
saveDays=15
diskGroupID
diskGroupID
int
diskGroupID
=1
2.5.5.1.2 Get recording policy parameter(getRecordPolicy)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=recordPolicy&cameraID=<cameraID>[&<argu
ment>=<value>...]
Input parameters description:
See the Record policy parameter correspond table & Configuartion Common parameters
table (1)
Returns the response:
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
isOpenScheduleRecordPolicy =< Flag >
scheduleRecordType = < scheduleRecordType >
weekDayCount =< weekDayCount >
weekDayBegin
weekDay =< weekDay ( 1)>
startTime1 =< startTime 1>
endTime1 =< endTime1>
…
startTime3 =< startTime3>
endTime 3 =< endTime3>
next_weekDayURL =2
…
next_weekDayURL =6
weekDay =< weekDay (7)>
startTime1 =< startTime 1>
65
endTime1 =< endTime1>
…
startTime3 =< startTime3>
endTime 3 =< endTime3>
weekDayEnd
isOpenAlarmRecord = < Flag>
isAlarmRecordFileLocked= < Flag >
alarmPreRecordTime=< alarmPreRecordTime >
alarmDelayRecordTime= < alarmDelayRecordTime >
alarmEventCount=< alarmEventCount >
alarmEventBegin
alarmID = <alarmID>
alarmType = <alarmType>
next_alarmEventURL = 2
…
alarmID = <alarmID>
alarmType = <alarmType>
alarmEventEnd
isRecordAudioOpened= <Flag>
cycleWriteFlag= < cycleWriteFlag >
isRedundancy=< isRedundancy >
saveDays=< saveDays >
diskGroupID=< diskGroupID >
streamID=< streamID >
Others response codes Universal Response
Notes:
After the determination of the value (ID&weekday) of a camera, value of the
scheduleTimeNum determine the number of the Returns schedule time parameters. When the
value is 3, there are 6 parameters, namely: startTime1, endTime1, startTime2, endTime2,
startTime3, endTime3. When the value is 2, the parameters are the front four. When the value is
1, the parameters are the front two. When the value is 0, this parameter is not considered.
When no schedule time from Monday to Sunday, there is no schedule time loop.
alarmEventCount = 0,no Alarm events loop.
The red part above is the part of loop.
Returns the text string parameters description:
See the Record policy parameter correspond table
66
2.5.5.1.3 Set Record Policy Parameters(setRecordPolicy)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=recordPolicy&cameraID=<cameraID>[&<
argument>=<value>...]
Input parameters description:
See the Record policy parameter correspond table& Configuartion Common parameters
table (1)
Return the reply:
Response codes Universal Response
2.5.5.2 Recording Directories(recordDirInfo)
2.5.5.2.1 Recording directories description
See the table below:
Recording directories parameters correspond table
Paramater Description Data Type Example Notes
recordDirInfo
Count
Total
Recording
directories
int recordDirInfoCount
=3
recordDirInfo
Begin
Recording
directories
loop starts
flag
int recordDirInfoBegin
=1
When the configuration
behavior is set, must
carry this flag, no specific
requirements for value.
next_recordD
irInfoURL
Next
Recording
directories,
URL start flag
int next_recordDirInfo
URL=2
Starting from 2.If the
value is 2, It means that
the later parameters is
2.When the
configuration behavior is
set, and the time of
greater than 1 must carry
this flag, no specific
requirements for value
recordDirInfo Recording
directories
int recordDirInfoEnd=3 When the configuration
behavior is set, must
67
End loop ends flag carry this flag, no specific
requirements for value.
diskName Disk Name string diskName=SD1 Disk Name
diskPath Disk Path string diskPath=SD1 Disk Path
diskWholePat
h
Disk Whole
Path string
diskWholePath=SD
1
Disk Path
alarmThresho
ld
Alarm
Threshold int
alarmThreshold=0
attribute Users
available
disk
properties
int attribute=0 Network share disk:
0, Read-only;2,
Redundancy.
SD:
1, Normal recording
(read-write);2, Network
drive connection failed,
temporary
storage(Redundant).
Local disk:
(1) read-write
(0)read-only
(2)redundancy
diskType Dsk Type int
diskType=2 Local disk (1), SD (2), FTP
plate (3), network
sharing plate (4)
freeSpace freeSpace int
freeSpace=0
Free disk space, in
unit:M
groupID
groupID
int
groupID=1 Current directory disk
group number
status status int
status=0 Network share disk:
Normal (0), the
connection fails (1)
FTP disk:
Normal (0), the
connection fails (1)
SD:
Unformatted (2), normal
(0), read-only (3),
68
abnormal (4), not the
card (5)
Local disk:
Unformatted (2), normal
(0), abnormal (4), sleep
(6)
usableSpace usableSpace int
usableSpace=0 Disk space used
fileSystemFor
mat
fileSystemFor
mat int
SD Card:
1: Customize the SDCard
file system
2: Fat32 file system
3: Ext2
4: Ext3
Network disk:
5: CIFS file system
0: Unknown file system
Local disk:
2: Fat32 file system
account User name string account=guest
password Password string password=11111
serverAddres
s Service
Address
string serverAddress=192.
168.250.170
2.5.5.2.2 Get Recording directory parameter (getRecordDirInfo)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=recordDirInfo[&<argument>=<value>...]
Input parameters description:
See the Recording directories parameters correspond table& Configuartion Common
parameters table (1)
Returns the response:
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
recordDirInfoCount=<recordDirInfoCount>
69
recordDirInfoBegin
diskName=<diskName>
diskPath=<diskPath>
diskWholePath=<diskWholePath>
enableFlag=<enableFlag> alarmThreshold=< alarmThreshold >
attribute=<attribute>
diskType=<diskType>
freeSpace=<freeSpace>
groupID=<groupID>
status=<status>
usableSpace=<usableSpace>
fileSystemFormat=<fileSystemFormat>
next_recordDirInfoURL=2
…
next_recordDirInfoURL=n
diskName=<diskName>
diskPath=<diskPath>
diskWholePath=<diskWholePath>
enableFlag=<enableFlag> alarmThreshold=< alarmThreshold >
attribute=<attribute>
diskType=<diskType>
freeSpace=<freeSpace>
groupID=<groupID>
status=<status>
usableSpace=<usableSpace>
recordDirInfoEnd
Others response codes Universal Response
Returns the text string parameters description:
See the Recording directories parameters correspond table
2.5.5.2.3 Recording directory parameter settings (setRecordDirInfo)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
70
name>&password=<password>&action=set&type=recordDirInfo [&<argument>=<value>...]
Input parameters description:
See the Recording directories parameters correspond table& Configuartion Common
parameters table (1)
Return the reply:
Response codes Universal Response
2.5.6 Alarm Configuration
2.5.6.1 Alarm parameters(alarmParam)
2.5.6.1.1 Description
See the table below:
Alarm parameters
Paramater Description Data Type Example Notes
alarmInterval Alarm interval int alarmInterval=10 Unit:Seconds
2.5.6.1.2 Get Alarm parameters(getAlarmParam)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type= alarmParam
Input parameters description:
See the Alarm parameters& Configuartion Common parameters table (1)
Return the reply:
Response codes Universal Response
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
alarmInterval=< alarmInterval >
Others response codes Universal Response
Returns the text string parameters description:
71
See the Alarm parameters
2.5.6.1.3 Set the Alarm Parameters(setAlarmParam)
Input URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type= alarmParam[&<argument>=<value>...]
Input parameters description:
See the Alarm parameters& Configuartion Common parameters table (1)
Return the reply:
Response codes Universal Response
2.5.6.2 Alarm In(alarmIn)
2.5.6.2.1 Alarm In Device Specs
\
Alarm In Device Specs Table
Specs Explanation Data Type Example Remarks
alarmInName Alarm In port
Name
String alarmInputName=I
OAlarm
alarmInValidL
evel
Effective
Current of
Alarm In
Int alarmInValidLevel=0 0:Electric Relay Closed
1:Electric Relay Open
2.5.6.2.2 Get Alarm In Specs (getAlarmIn)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=alarmIn [&<argument>=<value>...]
Return:
If successful, return below texts:
HTTP Code: 200 OK
Content-Type: text/plain
72
Content-Length: <body size>
< body >
alarmInID =< alarmInID( 1)>
alarmInName =< alarmInName( 1)>
alarmInValidLevel =< alarmInValidLevel (1)>
Response codes Universal Response
2.5.6.2.3 Set Alarm In Device specs (setAlarmIn)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=alarmIn [&<argument>=<value>...]
Response codes Universal Response
2.5.6.3 Alarm Out(alarmOut)
2.5.6.3.1 Alarm Out Device Specs
Alarm Out Device Specs Table
Specs Explanation Data Type Instance Remarks
alarmOutName Alarm Out
Name
String alarmOutputName=IO
Alarm
alarmValidSigna
l
Alarm Valid
Signal
Int alarmValidSignal=0
alarmMode Alarm
Mode
Int alarmMode=1 1:Button Mode
2:Square Wave Mode
alarmOutFrequ
ency
Alarm Out
Frequency
Float alarmOutFrequency=0.
000000
73
alarmTime Alarm Time Int alarmTime=0 Unit is ms
2.5.6.3.2 Get Device Alarm out specs (getAlarmOut)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=alarmOut
Return:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
alarmOutID =< alarmOutID ( 1)>
alarmOutName =< alarmOutName ( 1)>
alarmValidSignal =< alarmValidSignal (1)>
alarmMode =< alarmMode (1)>
alarmOutFrequency =< alarmOutFrequency (1)>
alarmTime =< alarmTime (1)>
2.5.6.3.3 Set Alarm IN Parameter(setAlarmOut)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=alarmOut [&<argument>=<value>...]
Response codes Universal Response
74
2.5.6.4 Alarm Center(alarmCenter)
2.5.6.4.1 Alarm Center Specs
Alarm Center Specs Table
Specs Explanation Data Type Instance Remarks
serverIP Alarm Center
IP
string
serverPort Alarm Center
Port
int
2.5.6.4.2 Get Alarm Center Specs(getAlarmCenter)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=alarmCenter&IPProtoVer=< IPProtoVer >
Return:
If successful,Return String:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
IPProtoVer =< IPProtoVer >
serverIP =< serverIP >
serverPort =< serverPort >
2.5.6.4.3 Set Alarm Center Specs (setAlarmCenter)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=alarmCenter&IPProtoVer=<IPProtoVer>
75
[&<argument>=<value>...]
Response codes Universal Response
2.5.6.5 Motion Detection Alarm(motionAlarm)
2.5.6.5.1 Motion Detection Alarm specs
Motion Detection Alarm Linkage
Parameters Explanation Data Type Instance Remarks
motionDetect
ionEnableFlag
Motion
Detection on
Flag
unsigned char motionDetectionEnabl
eFlag=1
0:Off
1:On
sensitivity Sensitivity int sensitivity=4
areaMaskFlag Mask Flag unsigned char areaMaskFlag=1 0:Off
1:On
frameInterval I Frame Interval int frameInterval=5
Motion
Detection
Area
motionDetect
ionAreaCount
Motion Area,
motion
detection
circulate body
start flag
int motionDetectionAreaC
ount=3
Range :0-8
motionDetect
ionAction
motion
detection
circulate body
operation
int motionDetectionAction
=cover
Once Configuration is Set
mode, if not carrying this
mark, default is Loop body
Add mode.
motionDetect
ionAreaBegin
Motion area
start flag
int motionDetectionAreaB
egin
When the configuration is set,
must carry the logo, no
specific requirements for
value
topX X Location int topX=9 The coordinates of the upper
left corner of the X detection
76
area
topY Y Location int topY=68 The coordinates of the upper
left corner of the Y detection
width Width int width=23 Detection area width
height Height int height=13 Detection area height
next_motion
DetectionAre
aURL
Mark for next
motion
detection area
int next_motionDetection
URL=2
From 2. If the value is 2,
means the following
parameters is 2. When the
configuration is set, and the
body of the loop number is
greater than 1 must carry this
flag, no specific requirements
for value
motionDetect
ionAreaEnd
Motion
detection loop
end mark
int motionDetectionAreaE
nd=3
When the configuration is set,
must carry the logo, no
specific requirements for
value
Schedule Time
weekDayCou
nt
days int weekDayCount =1 Max 7
weekDayBegi
n
Start Label for
Count
protection time
Loop body
int weekDayBegin When the configuration is set,
must carry the logo, no
specific requirements for
value
scheduleTime
Action
Schedule Time
Loop body
operation
int scheduleTimeAction=c
over
Once Configuration is Set
mode, if not carrying this
mark, default is Loop body
Add mode.
weekDay Weekday int weekday=5 0-6,0 is Sunday
scheduleTime
Num
A number of
deployment
time
int scheduleTimeNum=1 Max 3。
startTime(1..3
)
Alarm Start
time
long startTime1 = 1000 Range:0-86400
77
endTime(1..3) Alarm over time long endTime1= 2000 Range:0-86400
next_weekDa
yURL
Next Schedule
time URL
int next_weekDayURL =2 From 2. If the value is 2,
means the following
parameters is 2. When the
configuration is set, and the
body of the loop number is
greater than 1 must carry this
flag, no specific requirements
for value
weekDayEnd Alarm days Loop
body over Label
int weekDayEnd=3 When the configuration is set,
must carry the logo, no
specific requirements for
value
Alarm Out
alarmOutActi
onCount
Alarm output
event number
int alarmOutActionCount=
1
Number of Alarm out
alarmOutActi
onBegin
Alarm out event
Loop body Start
label
int alarmOutActionBegin=
1
When the configuration is set,
must carry the logo, no
specific requirements for
value
alarmOutActi
on
Alarm out event
Loop body
Operation
string alarmOutAction=cover Once Configuration is Set
mode, if not carrying this
mark, default is Loop body
Add mode.
alarmOutID Alarm Out ID int alarmOutID=1
alarmOutFlag Alarm Out Label int alarmOutFlag=0
next_alarmO
utAcitonURL
Next Alarm Out
event Label
int next_alarmOutAcitonU
RL=2
From 2. If the value is 2,
means the following
parameters is 2. When the
configuration is set, and the
body of the loop number is
greater than 1 must carry this
flag, no specific requirements
for value
alarmOutActi
onEnd
Alarm out Loop
body over Label
int alarmOutActionEnd=1 When the configuration is set,
must carry the logo, no
specific requirements for
78
value
PTZ Alarm
event
alarmPTZActi
onCount
Number of PTZ
Alarm event
int alarmPTZActionCount=
0
Different device, number of
alarm out event will be
different
alarmPTZActi
onBegin
PTZ Alarm out
Loop body over
Label
int alarmPTZActionBegin=
1
When the configuration is set,
must carry the logo, no
specific requirements for
value
alarmPTZActi
on
PTZ Alarm event
Loop body
operation
string alarmPTZAction=cover From 2. If the value is 2,
means the following
parameters is 2. When the
configuration is set, and the
body of the loop number is
greater than 1 must carry this
flag, no specific requirements
for value
cameraID Camera ID int cameraID=1
ptzOperateTy
pe
PTZ operation
type
int ptzOperateType=1
ptzOperateVa
lue
PTZ operation
value
int ptzOperateValue=16
next_PTZAcit
onURL
The next alarm
platform event
identification
int next_ptzAcitonURL=2 From 2. If the value is 2,
means the following
parameters is 2. When the
configuration is set, and the
body of the loop number is
greater than 1 must carry this
flag, no specific requirements
for value
alarmPTZActi
onEnd
PTZ Loop bocy
end
int alarmPTZActionEnd=3 When the configuration is set,
must carry the logo, no
specific requirements for
value
79
2.5.6.5.2 Get Motion detection Alarm Linkage specs(getMotionAlarm)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=motionAlarm&cameraID
=1[&<argument>=<value>...]
Return :
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
motionDetectionEnableFlag =< motionDetectionEnableFlag >
sensitivity =< sensitivity >
areaMaskFlag =< areaMaskFlag >
frameInterval =< frameInterval >
motionDetectionAreaCount =< motionDetectionAreaCount >
motionDetectionAreaBegin
topX =< topX (1)>
topY=< topY (1)>
width =< width (1)>
height=< height (1)>
next_motionDetectionAreaURL =2
…
next_motionDetectionAreaURL=n
topX =< topX (n+1)>
topY=< topY (n+1)>
width =< width (n+1)>
height=< height (n+1)>
motionDetectionAreaEnd
weekDayCount =< weekDayCount >
80
weekDayBegin
weekDay =< weekDay ( 1)>
startTime1 =< startTime 1>
endTime1 =< endTime1>
…
startTime3 =< startTime3>
endTime 3 =< endTime3>
next_weekDayURL =2
…
next_weekDayURL =7
weekDay =< weekDay (7)>
startTime1 =< startTime 1>
endTime1 =< endTime1>
…
startTime3 =< startTime3>
endTime 3 =< endTime3>
weekDayEnd
alarmOutActionCount =< alarmOutActionCount >
alarmOutActionBegin
alarmOutID =< alarmOutID (1)>
alarmOutFlag =< alarmOutFlag (1)>
next_alarmOutAcitonURL =2
…
next_alarmOutAcitonURL =n
alarmOutID =< alarmOutID (n+1)>
alarmOutFlag =< alarmOutFlag (n+1)>
alarmOutActionEnd
alarmPTZActionCount =< alarmPTZActionCount >
alarmPTZActionBegin
cameraID =< cameraID (1)>
ptzOperateType =< ptzOperateType (1)>
81
ptzOperateValue=< ptzOperateValue (1)>
next_PTZAcitonURL=2
…
next_PTZAcitonURL =n
cameraID =< cameraID (n+1)>
ptzOperateType =< ptzOperateType (n+1)>
ptzOperateValue=< ptzOperateValue (n+1)>
alarmPTZActionEnd
Remarks:
For a camera ID, weekDay value determined, scheduleTimeNum planning time decided to return the value of the
number of parameters. When the value is 3, the parameter is 6, that startTime1, endTime1, startTime2,
endTime2, startTime3, endTime3. When the value is 2, the parameters of the front four. When the value is 1, the
parameter is the former two. When the value is 0, this parameter is not taken into account.
When no plans Monday to Sunday time period, unplanned time parameters of the loop body
When motionDetectionEnableFlag = 0 when no motion detection loop.
When the alarm output event is 0, no alarm output loop
When the alarm PTZ event is 0, no alarm PTZ loop body.
Repeated:
cameraID=<cameraID>
motionDetectionEnableFlag=<motionDetectionEnableFlag>
sensitivity=<sensitivity>
areaMaskFlag=<areaMaskFlag>
frameInterval=<frameInterval>
Loop part:
Scheduled time:
Count: weekDayCount
Begin: weekDayBegin
Flag: next_weekDayURL
End: weekDayEnd
Motion Detection:
Count: motionDetectionAreaCount
Begin: motionDetectionAreaBegin
82
Flag: next_motionDetectionURL
End: motionDetectionAreaEnd
Alarm output event:
Count: alarmOutActionCount
Begin: alarmOutActionBegin
Flag: next_alarmOutActionURL
End: alarmOutActionEnd
Alarm PTZ event:
Count: alarmPTZActionCount
Begin: alarmPTZActionBegin
Flag: next_PTZAcitonURL
End: alarmPTZActionEnd
Response codes Universal Response
Returned text string parameters description:
Refer to above MotionAlarmParametersTable.
2.5.6.5.3 Set motion alarm linkage paramaters(setMotionAlarm)
Request URL format:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=motionAlarm&cameraID
=1[&<argument>=<value>...]
Wherein, argument as shown below:
motionDetectionAction=<action>&motionDetectionAreaBegin=1&topX=<topX(1)>&topY=<topY(
1)>&width=<width(1)>&height=<height(1)>&next_motionDetectionAreaURL=2&…&next_motio
nDetectionAreaURL=n&topX=<topX(n+1)>&topY=topY(n+1)>&width =<width (n+1)>&height=<
height (n+1)>&motionDetectionAreaEnd=n
&scheduleTimeAction=<action>&weekDayBegin=1&weekDay=1&startTime1=<startTime1>&en
dTime1=<endTime1>&…&startTime3=<startTime3>&endTime3=<endTime3>&next_weekDayUR
L=1&…next_weekDayURL=6&weekDay=7&startTime1=<startTime1>&endTime1=<endTime1>&
…& startTime3=<startTime3>&endTime3=<endTime3>&weekDayEnd=n
&alarmOutAction=<action>&alarmOutActionBegin=1&alarmOutID=<alarmOutID(1)>&alarmOutF
lag=<alarmOutFlag(1)>&next_alarmOutAcitonURL=2&…next_alarmOutAcitonURL=n&
83
&alarmOutID=<alarmOutID(n+1)>&alarmOutFlag=<alarmOutFlag(n+1)>&alarmOutActionEnd=n
&alarmPTZAction=<action>&alarmPTZActionBegin=1&cameraID=<cameraID(1)>&ptzOperateTyp
e=<ptzOperateType(1)>&ptzOperateValue=<ptzOperateValue(1)>&next_PTZAcitonURL=2…next_
PTZAcitonURL=n&cameraID=<cameraID(n+1)>&ptzOperateType=<ptzOperateType(n+1)>&ptzOp
erateValue=<ptzOperateValue (n+1)&alarmPTZActionEnd=n
Note:
For a camera ID, weekDay value determined, scheduleTimeNum planning time decided to return
the value of the number of parameters. When the value is 3, the parameter is 6, that startTime1,
endTime1, startTime2, endTime2, startTime3, endTime3. When the value is 2, the parameters of
the front four. When the value is 1, the parameter is the former two. When the value is 0, this
parameter is not taken into account.
Refer to above MotionAlarmParametersTable.
Returned response:
Return Universal Response
2.5.6.6 IO Alarm(IOAlarm)
2.5.6.6.1 I/O alarm linkage parameters meaning
I/O alarm linkage parameters meaning, refer to below table
I/O Alarm Linkage Parameters Table
Paramater Description Data Type Example Notes
alarmInID Alarm Input ID int alarmInID=0
alarmIOEnabl
eFlag
Whether to
activate alarm
IO
unsigned char alarmIOEnableFlag=1 0:Disabled
1:Enabled
Schedule
weekDayCou
nt
Arming days int weekDayCount =1 Up to 7
weekDayBegi
n
Schedule time
loop body start
flag
int weekDayBegin=1 When configuration action is
“set”, the flag must be taken,
no specific requirement to
the value.
scheduleTime
Action
Schedule time
loop body
int scheduleTimeAction=c
over
When configuration action is
“set”, if the flag not be
84
operation token,,default to add into
loop body.
cover: cover
weekDay Of the int weekday=5 1-7,0 a Sunday
scheduleTime
Num
Arming Time
Number
int scheduleTimeNum=1 Up to 3.
startTime(1..
3)
Arming Start
Time
long startTime1 = 1000 Range:0-86400
endTime(1..3) Arming End
Time
long endTime1= 2000 Range:0-86400
next_weekDa
yURL
URL under a
scheduled time
int next_weekDayURL =2 Starting with 2. If the value is
2, it indicates that the
connection parameters are
two behind the first. When
configuration action is “set”
and loop body number large
than 1, the flag must be
token, no specific
requirement to the value.
weekDayEnd Arming days
marks the end
of the loop body
int weekDayEnd When configuration action is
“set”, the flag must be taken,
no specific requirement to
the value.
Alarm
alarmOutActi
onCount
Alarm output
number of
events
int alarmOutActionCount=
1
Depending on the device,
allowing different numbers of
alarm output
alarmOutActi
onBegin
Alarm output
events loop
body begin flag
int alarmOutActionBegin=
1
When configuration action is
“set”, the flag must be taken,
no specific requirement to
the value.
alarmOutActi
on
Alarm output
events loop
body operation
string alarmOutAction=cover When configuration action is
“set”, if the flag not be
token,,default to add into
loop body.
cover:cover
85
alarmOutID Alarm output ID int alarmOutID=1
alarmOutFlag Alarm output
flag
int alarmOutFlag=0
next_alarmO
utActionURL
Under an alarm
output event
logo
int next_alarmOutAcitonU
RL=2
Starting with 2. If the value is
2, it indicates that the
connection parameters are
two behind the first. When
configuration action is “set”
and loop body number large
than 1, the flag must be
token, no specific
requirement to the value
alarmOutActi
onEnd
Alarm output
end of the loop
body
int alarmOutActionEnd=3 When configuration action is
“set”, the flag must be taken,
no specific requirement to
the value.
Alarm PTZ
alarmPTZActi
onCount
Alarm PTZ
number of
events
int alarmPTZActionCount=
0
Depending on the device,
allowing the number of
alarms is different PTZ
alarmPTZActi
onBegin
Alarm PTZ
events loop
body begin flag
int alarmPTZActionBegin=
1
When configuration action is
“set”, the flag must be taken,
no specific requirement to
the value.
alarmPTZActi
on
Alarm PTZ
events loop
body operation
string alarmPTZAction=cover When configuration action is
“set”, if the flag not be
token,,default to add into
loop body.
cover:cover
cameraID Camera ID int cameraID=1
ptzOperateTy
pe
PTZ operation
type
int ptzOperateType=1
ptzOperateVa
lue
PTZ operating
values
int ptzOperateValue=16
next_PTZAcit Under an alarm int next_ptzAcitonURL=2 Starting with 2. If the value is
2, it indicates that the
86
onURL PTZ event logo connection parameters are
two behind the first. When
configuration action is “set”
and loop body number large
than 1, the flag must be
token, no specific
requirement to the value
alarmPTZActi
onEnd
PTZ loop end int alarmPTZActionEnd=1 When configuration action is
“set”, the flag must be taken,
no specific requirement to
the value.
2.5.6.6.2 Get I/O alarm link parameters(get IOalarmLinkage)
Request URL format:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=IOalarmLinkage&alarmInID=1[&<argument>=
<value>...]
Requested parameters description:
Refer to above I/O Alarm Linkage Parameters Table
Returned response:
Access successfully,return text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
alarmIOEnableFlag=< alarmIOEnableFlag >
weekDayCount =< weekDayCount >
weekDayBegin
weekDay =< weekDay ( 1)>
startTime1 =< startTime 1>
endTime1 =< endTime1>
…
startTime3 =< startTime3>
endTime 3 =< endTime3>
87
next_weekDayURL =2
…
next_weekDayURL =6
weekDay =< weekDay (7)>
startTime1 =< startTime 1>
endTime1 =< endTime1>
…
startTime3 =< startTime3>
endTime 3 =< endTime3>
weekDayEnd
alarmOutActionCount =< alarmOutActionCount >
alarmOutActionBegin
alarmOutID =< alarmOutID (1)>
alarmOutFlag =< alarmOutFlag (1)>
next_alarmOutAcitonURL =2
…
next_alarmOutAcitonURL =n
alarmOutID =< alarmOutID (n+1)>
alarmOutFlag =< alarmOutFlag (n+1)>
alarmOutActionEnd
alarmPTZActionCount =< alarmPTZActionCount >
alarmPTZActionBegin
cameraID =< cameraID (1)>
ptzOperateType =< ptzOperateType (1)>
ptzOperateValue=< ptzOperateValue (1)>
next_PTZAcitonURL=2
…
next_PTZAcitonURL =n
cameraID =< cameraID (n+1)>
ptzOperateType =< ptzOperateType (n+1)>
ptzOperateValue=< ptzOperateValue (n+1)>
alarmPTZActionEnd=1
88
Notes:
ScheduleTimeNum values behind the decision startTime and endTime numbers and number of
starts. From 0 to scheduleTimeNum-1.
When no plans Monday to Sunday time period, unplanned time parameters of the loop body
When alarmIOEnableFlag = 0 when no motion detection loop.
When the alarm output event is 0, no alarm output loop
When the alarm PTZ event is 0, no alarm PTZ loop body.
Repeated part:
alarmInID=< alarmInID >
alarmIOEnableFlag=< alarmIOEnableFlag >
Loop part:
Schedule time:
Count: weekDayCount
Begin: weekDayBegin
Flag: next_weekDayURL
End weekDayEnd
Alarm output event:
Count: alarmOutActionCount
Begin: alarmOutActionBegin
Flag: next_alarmOutAcitonURL
End: alarmOutActionEnd
Alarm PTZ event:
Count: alarmPTZActionCount
Begin: alarmPTZActionBegin
Flag: next_PTZAcitonURL
End: alarmPTZActionEnd
Response codes Universal Response
Returned text string parameters description:
Refer to above I/O Alarm Linkage Parameters Table
89
2.5.6.6.3 Setting I/O alarm parameters(set IOalarmLinkage)
Request URL format:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=IOalarmLinkage
&alarmInID=1[&<argument>=<value>...]
Wherein, argument as shown below:
&scheduleTimeAction=<action>&weekDayBegin=1&weekDay=1&startTime1=<startTime1>&en
dTime1=<endTime1>&…&startTime3=<startTime3>&endTime3=<endTime3>&next_weekDayUR
L=1&…next_weekDayURL=6&weekDay=7&startTime1=<startTime1>&endTime1=<endTime1>&
…& startTime3=<startTime3>&endTime3=<endTime3>&weekDayEnd=n
&alarmOutAction=<action>&alarmOutActionBegin=1&alarmOutID=<alarmOutID(1)>&alarmOutF
lag=<alarmOutFlag(1)>&next_alarmOutAcitonURL=2&…next_alarmOutAcitonURL=n&
&alarmOutID=<alarmOutID(n+1)>&alarmOutFlag=<alarmOutFlag(n+1)>&alarmOutActionEnd=n
&alarmPTZAction=<action>&alarmPTZActionBegin=1&cameraID=<cameraID(1)>&ptzOperateTyp
e=<ptzOperateType(1)>&ptzOperateValue=<ptzOperateValue(1)>&next_PTZAcitonURL=2…next_
PTZAcitonURL=n&cameraID=<cameraID(n+1)>&ptzOperateType=<ptzOperateType(n+1)>&ptzOp
erateValue=<ptzOperateValue (n+1)&alarmPTZActionEnd=n
Repeated part:
alarmInID=< alarmInID >&alarmIOEnableFlag=< alarmIOEnableFlag >
Loop part:
Schedule time:
Action: scheduleTimeAction
Begin: weekDayBegin
Flag: next_weekDayURL
End weekDayEnd
Alarm output events:
Action: alarmOutAction
Begin: alarmOutActionBegin
Flag: next_alarmOutAcitonURL
End: alarmOutActionEnd
90
Alarm PTZ event:
Action: alarmPTZAction
Begin: alarmPTZActionBegin
Flag: next_PTZAcitonURL
End: alarmPTZActionEnd
Notes:
scheduleTimeNum values behind the decision startTime and endTime numbers and number
of starts. From 0 to scheduleTimeNum-1.
Refer to I/O Alarm Linkage Parameters Table,configration common parameters table(1)
Returned response:
Response codes Universal Response
2.5.6.7 Disk Alarm(diskAlarm)
2.5.6.7.1 Disk alarm parameters meaning
Disk alarm parameters meaning , refer to below table:
Disk Alarm Parameters Table
Paramater Description Data Type Example Notes
diskFullAlarm
CheckFlag
Disk full alarm
check flag
unsigned
char
diskFullAlarmCheck
Flag=0
0:Disable
Non-0:Enable
diskErrorAlar
mCheckFlag
Disk error
alarm check
flag
unsigned
char
diskErrorAlarmChec
kFlag=0
0:Disable
Non-0:Enable
minDiskPerce
nt
Minimum disk
percent
int minDiskPercent=30
maxDiskPerce
nt
Maximum
disk percent
int maxDiskPercent=60
2.5.6.7.2 Get disk alarm parameters(getDiskAlarmParam)
Request URL format:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=diskAlarm&alarmInID=1
91
Requested parameters description:
Refer to above Disk Alarm Parameters Table, configration common parameters table(1)
Returned response text string:
Access successfully,return text string
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
diskFullAlarmCheckFlag=<diskFullAlarmCheckFlag>
diskErrorAlarmCheckFlag=<diskErrorAlarmCheckFlag>
minDiskPercent=<minDiskPercent>
maxDiskPercent=<maxDiskPercent>
The rest response codes Universal Response
Returned text string parameters description:
Refer to above Disk Alarm Parameters Table
2.5.6.7.3 Set Disk Alarm Param (setDiskAlarmParam)
Request URL format:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=diskAlarm&alarmInID=1
[&<argument>=<value>...]
Requested parameters description:
Refer to above Disk Alarm Parameters Table, configration common parameters table(1)
Returned response:
Response codes Universal Response
2.5.6.8 Privacy Mask Alarm(blindAreaAlarm)
2.5.6.8.1 Privacy mask parameters meaning
Privacy mask parameters meaning, refer to below table:
Privacy Mask Parameters
Paramater Description Data Type Example Notes
red Red value int red=0 Range:(0-255)
92
green Green value int green=0 Range:(0-255)
blue Blue value int blue=255 Range:(0-255)
alpha Alpha value int alpha=50 Range:(0-100)
areaParamCo
unt
Mask area
number
int areaParamCount=2
areaParamAct
ion
Mask area loop
body action
string areaParamAction=cove
r
When configuration action is
“set”, if the flag not be token,
default to add into loop body.
areaParamBe
gin
Mask area begin
flag
int areaParamBegin=1 When configuration action is
“set”, the flag must be taken,
no specific requirement to the
value.
next_areaPar
amURL
Next mask area
URL begin flag
int next_areaParamURL=2 Starting with 2. If the value is
2, it indicates that the
connection parameters are
two behind the first. When
configuration action is “set”
and loop body number large
than 1, the flag must be
token, no specific requirement
to the value
areaParamEn
d
Mask area end
flag
int areaParamEnd=3 When configuration action is
“set”, the flag must be taken,
no specific requirement to the
value.
topX X-coordinate int topX=9 Area top left x-coordinate
topY Y-coordinate int topY=68 Area top left y-coordinate
width Width int width=23 Area width
height Height int height=13 Area height
2.5.6.8.2 Get Blind Area Parameters(getBlindArea)
Request URL format:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=blindArea&cameraID=1
93
Requested parameters description:
Refer to above privacy mask parameters,configration common parameters table(1)
Returned response text string:
Access successfully,return text string
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
cameraID=<cameraID>
enableFlag=<enableFlag>
red=<red value>
green = <green value>
blue = <blue value>
alpha = <alpha value>
areaParamCount = <areaParamCount>
areaParamBegin
topX=<topX>
topY = <topY>
width = <width>
height = <height>
next_areaParamURL = 2
…
next_areaParamURL = n
topX=<topX>
topY = <topY>
width = <width>
height = <height>
areaParamEnd
The rest response codes Universal Response
Returned text string parameters description:
Refer to above privacy mask parameters
94
2.5.6.8.3 Set Blind Area Parameters(setBlindArea)
Request URL format:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=blindArea&cameraID=1
[&<argument>=<value>...]
Requested parameters description:
Refer to above privacy mask parameters,configration common parameters table(1)
Returned response:
Response codes Universal Response
2.5.7 External Device Configration
2.5.7.1 External PTZ(PTZ)
2.5.7.1.1 External PTZ parameters meaning
External PTZ Parameters Table
Paramater Description Data Type Example Notes
PTZEnableFla
g
PTZ enable flag unsigned char PTZEnableFlag=1 0:Disable
1:Enable
cameraID PTZ camera
number
int cameraID=1 Channal No
PTZDeviceID PTZ device
address
int PTZDeviceID=1 PTZ ID
PTZProtocol PTZ protocol
int PTZProtocol=1 0:PELCO_D protocol
1:PELCO_P protocol
comID Serial
connection ID
int comID=1 Serial Number
baudRate Bit Rate int baudRate=9600 Range:(300-115200)
dataBits Data bits int dataBits=8 Range:(4-8)
stopBits
Stop Bit
int stopBits=1 0:1
1:1.5
95
2:2
parity
Parity
int parity=0 0: No parity ;
1: Odd parity
2: Even parity ;
3: Mark parity
4: Space parity
2.5.7.1.2 Get external PTZ parameters(getPTZParam)
Request URL format:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type= PTZ
&cameraID=< cameraID >
Requested parameters description:
Refer to above External PTZ Parameters Table
Returned response text string:
Access successfully,return text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
PTZEnableFlag =< PTZEnableFlag >
PTZDeviceID =< PTZDeviceID >
PTZProtocol =< PTZProtocol >
comID =< comID >
baudRate =< baudRate >
dataBits =< dataBits >
stopBits =< stopBits >
parity =< parity >
Notes:
96
The rest response codes Universal Response
Returned text string parameters description:
Refer to above External PTZ Parameters Table
2.5.7.1.3 Set external PTZ parameters(setPTZParam)
Request URL format:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type= PTZ [&<argument>=<value>...]
Requested parameters description:
Refer to above External PTZ Parameters Table,configration common parameters table(1)
Returned response text string:
response codes Universal Response
2.5.7.2 PTZ Keyboard(PTZKeyboard)
2.5.7.2.1 PTZ keyboard meaning
PTZ keyboard meaning, refer to below table:
PTZ Keyboard Parameters Table
Paramater Description Data Type Example Notes
interfaceType Interface type int interfaceType=1 1:RS485 serial type
2:232 serial type
3:USB interface type
4:Network interface type
baudRate Baudrate int baudRate=9600 Range:(300-115200)
dataBits Databits int dataBits=8 Range:(4-8)
parity Parity int parity=0 0: No parity ;
1: Odd parity
2: Even parity ;
3: Mark parity
4: Space parity
97
2.5.7.2.2 Get PTZ keyboard parameters(getPTZKeyboardParam)
Request URL format:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=PTZKeyboard
Requested parameters description:
Refer to above PTZ Keyboard Parameters Table,configration common parameters table(1)
Returned response text string:
Access successfully,return text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
enableFlag =<Flag>
interfaceType = <interfaceType>
comID = <comID>
baudRate = <baudRate>
dataBits = <dataBits>
parity = <parity>
The rest response codes Universal Response
Returned text string parameters description:
Refer to above PTZ Keyboard Parameters Table,configration common parameters table(1)
2.5.7.2.3 Set PTZ keyboard parameters(setPTZKeyboardParam)
Request URL format:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=PTZKeyboard[&<argument>=<value>...]
Requested parameters description:
Refer to PTZ Keyboard Parameters Table,configration common parameters table(1)
Returned response:
Response codes Universal Response
98
2.5.7.3 RS485 Device(RS485Device)
2.5.7.3.1 RS485 parameters meaning
RS485 parameters meaning, refer to below table
RS485 Parameters Table
Paramater Description Data Type Example Notes
baudRate Baudrate int baudRate=9600 Range:(300-115200)
dataBits Databits int dataBits=8 Range:(4-8)
stopBits Stopbits int stopBits=1 0:1
1:1.5
2:2
parity Parity int parity=0 0: No parity ;
1: Odd parity
2: Even parity ;
3: Mark parity
4: Space parity
2.5.7.3.2 Get RS485 device parameters(getRS485Device)
Request URL format:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=RS485Device&comID=1
Requested parameters description:
Refer to RS485 Parameters Table,configration common parameters table(1)
Returned response text string:
Access successfully,return text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
comID = <comID>
baudRate =< baudRate >
99
dataBits =< dataBits >
stopBits =< stopBits >
parity =< parity >
The rest response codes Universal Response
Returned text string parameters description:
Refer to above RS485 Parameters Table,configration common parameters table(1)
2.5.7.3.3 Set RS485 device parameters(setRS485Device)
Request URL format:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=RS485Device&comID=1[&<argument>=<
value>...]
Requested parameters description:
Refer to RS485 Parameters Table,表 2.4.1(1)
Returned response:
Response codes Universal Response
2.5.8 Service Center Configration
2.5.8.1 SMTP service
2.5.8.1.1 SMTP service parameters meaning
SMTP service parameters meaning, refer to below table
SMTP Service Parameters Table
Paramater Description Data Type Example Notes
serverAddr SMTP server
address
string serverAddr
=192.168.10.140
serverPort SMTP server
port
unsigned
short
serverPort =30004
userName User name string userName =admin
password Password string password =admin
100
senderEmailA
ddress
Sender email
address
string senderEmailAddress
mailLanguage Message
content
language
int mailLanguage=2 1:chinese
2:english
transportMod
e
Mail Transfer
Mode
int transportMode=0 0: No Encryption
1: SSL secure connection
2: Starttls command transfer
attachmentI
mageQuality
The image
quality of e-mail
attachments
int attachmentImageQuali
ty=1
1: High
2: Medium
3: Low
recipientEmai
lAddress1
Recipient
Address 1
string recipientEmailAddress
recipientEmai
lAddress2
Recipient
Address 2
string recipientEmailAddress
recipientEmai
lAddress3
Recipient
Address 3
string recipientEmailAddress
recipientEmai
lAddress4
Recipient
Address 4
string recipientEmailAddress
recipientEmai
lAddress5
Recipient
Address 5
string recipientEmailAddress
2.5.8.1.2 Gets SMTP Service Parameters(getSMTPParam)
Request URL format:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=SMTP
Requested parameters description:
Refer to above SMTP Service Parameters Table.
Returned response text string:
Access successfully,return text string:
HTTP Code: 200 OK
Content-Type: text/plain
101
Content-Length: <body size>
< body >
enableFlag =< enableFlag >
serverAddr =< serverAddr >
serverPort =< serverPort >
userName =< userName >
password =< password >
senderEmailAddress =< senderEmailAddress >
mailLanguage =< mailLanguage >
transportMode =< transportMode >
attachmentImageQuality =< attachmentImageQuality >
recipientEmailAddress1=< recipientEmailAddress1>
recipientEmailAddress2=< recipientEmailAddress2>
recipientEmailAddress3=< recipientEmailAddress3>
recipientEmailAddress4=< recipientEmailAddress4>
recipientEmailAddress5=< recipientEmailAddress5>
The rest response codes Universal Response
Returned text string parameters description:
Refer to above SMTP Service Parameters Table.
2.5.8.2 NTP Parameters(NTPParam)
2.5.8.2.1 NTP parameters meaning
NTP parameters table
Parameter Discretion Data Type Example Notes
NTPIP NTP Server IP address string NTPIP=192.168.250.17
0
NTPPort NTP Server Port int NTPPort=30002
2.5.8.2.2 Get NTP Parameters(getNTPParam)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
102
name>&password=<password>&action=get&type=NTP&IPProtoVer=< IPProtoVer >
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
enableFlag = <Flag>
NTPIP = <NTPIP>
NTPPort = <NTPPort>
IPProtoVer =< IPProtoVer >
Response codes Universal Response
2.5.8.2.3 Set NTP Parameter(setNTPParam)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=NTP&IPProtoVer=<IPProtoVer>
[&<argument>=<value>...]
Response codes Universal Response
2.5.8.3 DDNS Service(DDNS)
2.5.8.3.1 DDNS Service Parameter Meaning
DDNS Service parameter meaning as bellow:
DDNS Service Parameter table
Parameter Description Data Type Example Notes
providerID Provider ID int providerID=3 1:3322
2:dyndns
domainName DDNS domain name string domainName
=admin
accounts DDNS account string accounts=adm
in
password DDNS password string password=ad
min
103
2.5.8.3.2 Get DDNS service parameter(getDDNS)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=DDNS
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
enableFlag=< enableFlag >
providerID=< providerID >
domainName =< domainName >
accounts=< accounts >
password =< password >
Response codes Universal Response
2.5.8.3.3 Set DDNS Service Parameter(SetDDNS)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=DDNS [&<argument>=<value>...]
Response codes Universal Response
2.5.8.4 PPPoE Service(PPPoE)
2.5.8.4.1 PPPoE Service Parameter Meaning
PPPoE Service parameter meaning as below
PPPoE Service Parameter table
Parameter Description Data Type Example Notes
userName PPPoE user name string userName =admin
password PPPoE password string password =admin
104
2.5.8.4.2 Get PPPOE service parameters(getPPPoE)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type=PPPoE
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
enableFlag =< enableFlag >
userName =< userName >
password =< password >
Response codes Universal Response
2.5.8.4.3 Setting PPPoE Service Parameters (PPPoE)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type=PPPoE[&<argument>=<value>...]
Response codes Universal Response
2.5.9 Protocol
2.5.9.1 Protocol information(protocolInfo)
2.5.9.1.1 Protocol parameters meaning
2.5.9.1.2 Protocol parameters meaning as bellow
Protocol parameters table
Parameter Description Data Type Example Notes
protocolNam
e
Name of Agreement string
protocolVersi
on
Protocol Version string
105
protocolSoft
wareVersion
Protocol software version string
2.5.9.1.3 Get protocol information parameter(getProtocolInfo)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type= protocolInfo
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
protocolName =< protocolName >
protocolVersion =< protocolVersion >
protocolSoftwareVersion =< protocolSoftwareVersion >
Response codes Universal Response
2.5.9.2 Protocol Security
2.5.9.2.1 Protocol security parameter
Protocol security parameter as below
Protocol security parameter table
Parameter Description Data Type Example Notes
userVerificationFla
g
Protocol Security unsigned char userVerificationFlag=1 0:Disabled
1:Enables
2.5.9.2.2 Get protocol security parameters(getProtocolSecurity)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=get&type= protocolSecurity
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
106
Content-Length: <body size>
< body >
userVerificationFlag =< userVerificationFlag >
Response codes Universal Response.
2.5.9.2.3 Set protocol security parameters(setProtocolSecurity)
Request URL:
http://<servername>/cgi-bin/param.cgi?userName=<user
name>&password=<password>&action=set&type= protocolSecurity [&<argument>=<value>...]
Response codes Universal Response.
2.6 Device Operation(operate.cgi)
2.6.1 Input Common parameter
In operate.cgi procedure, carrying only three parameters that the user name userName,
password, and then operating action.
Operation parameter table(1)
Parameter Description Data Type Example Notes
userName User name string userName =admin Admin level username
password Password string password =admin User password
action Type of
operation
int type=reset restart reset
2.6.2 Device Reset
Request URL:
http://<servername>/cgi-bin/operate.cgi?userName=<username>&password=<password>&actio
n=reset
Response codes Universal Response
2.6.3 Device Restart
Request URL:
http://<servername>/cgi-bin/operate.cgi?userName=<username>&password=<password>&actio
107
n=restart
Response codes Universal Response
2.7 Sensor Configuration(sensor.cgi)
2.7.1 Input common parameters
In sensor.cgi procedure, carrying at least four parameters that the user name userame,
password, then operating action and program sub-type type.
Sensor configuration common parameters table(1)
Parameter Description Data Type Example Notes
userName useName string userName =admin Landing machine account
password password string password =admin Login password for the
machine
action Type of
operation
string action=get get
set
type sensor Type string type= brightness See Table Sensor
configuration common
parameters(2) below
Sensor configuration common parameters table (2)
sensor.cgi type Details
brightness Brightness
brightnessRange Brightness Range
contrast Contrast
contrastRange Contrast Range
hue Hue
hueRange Hue Range
saturation Saturation
saturationRange Saturation Range
108
sharpness Sharpness
sharpnessRange Sharpness Range
2.7.2 Brightness
2.7.2.1 Get Brightness
Request URL:
http://<servername>/cgi-bin/sensor.cgi?userName=<username>&password=<password>&
action=get&type=brightness
Returned success response result text string:
HTTP Code: 200 OK
Content-Type: text/plain
Content-Length: <body size>
< body >
value=%d
Remark:value:Brightness value
Return to plain text parameters:
See generic front-end configuration parameters (1), set the text rules
2.7.2.2 Get Brightness Range
Enter the URL:
http:// <servername> / cgi-bin/sensor.cgi? userName = <username> & password = <password>
& action = get & type = brightnessRange
Input parameters:
See generic front-end configuration parameters (1)
Return to answer plain text:
When you get successful, returns plain text:
HTTP Code: 200 OK
Content-Type: text / plain
109
Content-Length: <body size>
<Body>
minValue =% d
maxValue =% d
Note: minValue: Min
maxValue: max.
Return the remaining cases generic plain text response
Return to plain text parameters:
See generic front-end configuration parameters (1), set the text rules
2.7.2.3 Set Brightness
Enter the URL:
http:// <servername> / cgi-bin/sensor.cgi? userName = <username> & password = <password> & action = set &
type = brightness & value =% d
Input parameters:
See generic front-end configuration parameters (1)
Return to answer plain text:
Return generic plain text response
Return to plain text parameters:
See generic front-end configuration parameters (1), set the text rules
2.7.3 Contrast
2.7.3.1 Get the contrast value (get Contrast)
Enter the URL:
http:// <servername> / cgi-bin/sensor.cgi? userName = <username> & password = <password>
& action = get & type = contrast
Input parameters:
See generic front-end configuration parameters (1)
Return to answer plain text:
When you get successful, returns plain text:
110
HTTP Code: 200 OK
Content-Type: text / plain
Content-Length: <body size>
<Body>
value =% d
Note: value: the contrast value
Return the remaining cases generic plain text response
Return to plain text parameters:
See generic front-end configuration parameters (1), set the text rules
2.7.3.2 Get Contrast Range
Enter the URL:
http:// <servername> / cgi-bin/sensor.cgi? userName = <username> & password = <password>
& action = get & type = contrastRange
Input parameters:
See generic front-end configuration parameters (1)
Return to answer plain text:
When you get successful, returns plain text:
HTTP Code: 200 OK
Content-Type: text / plain
Content-Length: <body size>
<Body>
minValue =% d
maxValue =% d
Note: minValue: Min
maxValue: max.
Return the remaining cases generic plain text response
Return to plain text parameters:
See generic front-end configuration parameters (1), set the text rules
2.7.3.3 Set Contrast
Enter the URL:
111
http://<servername>/cgi-bin/sensor.cgi?userName=<username>&password=<password>&acti
on=set&type=contrast&value=%d
Input parameters:
See generic front-end configuration parameters (1)
Return to answer plain text:
Return generic plain text response
Return to plain text parameters:
See generic front-end configuration parameters (1), set the text rules
2.7.4 Hue
2.7.4.1 Gets tone value (get Hue)
Enter the URL:
http:// <servername> / cgi-bin/sensor.cgi? userName = <username> & password = <password>
& action = get & type = hue
Input parameters:
See generic front-end configuration parameters (1)
Return to answer plain text:
When you get successful, returns plain text:
HTTP Code: 200 OK
Content-Type: text / plain
Content-Length: <body size>
<Body>
value =% d
Note: value: tonal values
Return the remaining cases generic plain text response
Return to plain text parameters:
See generic front-end configuration parameters (1), set the text rules
2.7.4.2 Get tone value range (get HueRange)
Enter the URL:
http://<servername>/cgi-bin/sensor.cgi?userName=<username>&password = <password> &
action = get & type = hueRange
112
Input parameters:
See generic front-end configuration parameters (1)
Return to answer plain text:
When you get successful, returns plain text:
HTTP Code: 200 OK
Content-Type: text / plain
Content-Length: <body size>
<Body>
minValue =% d
maxValue =% d
Note: minValue: Min
maxValue: max.
Return the remaining cases generic plain text response
Return to plain text parameters:
See generic front-end configuration parameters (1), set the text rules
2.7.4.3 Set Hue
Enter the URL:
http://<servername>/cgi-bin/sensor.cgi?userName=<username>&password = <password> &
action = set & type = hue & value =%d
Input parameters:
See generic front-end configuration parameters (1)
Return to answer plain text:
Return generic plain text response
Return to plain text parameters:
See generic front-end configuration parameters (1), set the text rules
2.7.5 Saturation
2.7.5.1 Get saturation value (getSaturation)
Enter the URL:
http:// <servername> / cgi-bin/sensor.cgi? userName = <username> & password = <password>
& action = get & type = saturation
113
Input parameters:
See generic front-end configuration parameters (1)
Return to answer plain text:
When you get successful, returns plain text:
HTTP Code: 200 OK
Content-Type: text / plain
Content-Length: <body size>
<Body>
value =% d
Note: value: saturation value
Return the remaining cases generic plain text response
Return to plain text parameters:
See generic front-end configuration parameters (1), set the text rules
2.7.5.2 Get Saturation Range
Enter the URL:
http:// <servername> / cgi-bin/sensor.cgi? userName = <username> & password = <password>
& action = get & type = saturationRange
Input parameters:
See generic front-end configuration parameters (1)
Return to answer plain text:
When you get successful, returns plain text:
HTTP Code: 200 OK
Content-Type: text / plain
Content-Length: <body size>
<Body>
minValue =% d
maxValue =% d
Note: minValue: Min
maxValue: max.
Return the remaining cases generic plain text response
Return to plain text parameters:
See generic front-end configuration parameters (1), set the text rules
114
2.7.5.3 Set Saturation
Enter the URL:
http://<servername>/cgi-bin/sensor.cgi?userName=<username>&password=<password>&acti
on=set&type=saturation&value=%d
Input parameters:
See generic front-end configuration parameters (1)
Return to answer plain text:
Return generic plain text response
Return to plain text parameters:
See generic front-end configuration parameters (1), set the text rules
2.7.6 Sharpness
2.7.6.1 get Sharpness
Enter the URL:
http://<servername>/cgi-bin/sensor.cgi?userName=<username>&password=<password>&acti
on=get&type= sharpness
Input parameters:
See generic front-end configuration parameters (1)
Return to answer plain text:
When you get successful, returns plain text:
HTTP Code: 200 OK
Content-Type: text / plain
Content-Length: <body size>
<Body>
value =% d
Note: value: Sharpness value
Return the remaining cases generic plain text response
Return to plain text parameters:
See generic front-end configuration parameters (1), set the text rules
2.7.6.2 get Sharpness Range
Enter the URL:
115
http://<servername>/cgi-bin/sensor.cgi?userName=<username>&password=<password>&acti
on=get&type= sharpnessRange
Input parameters:
See generic front-end configuration parameters (1)
Return to answer plain text:
When you get successful, returns plain text:
HTTP Code: 200 OK
Content-Type: text / plain
Content-Length: <body size>
<Body>
minValue =% d
maxValue =% d
Note: minValue: Min
maxValue: max.
Return the remaining cases generic plain text response
Return to plain text parameters:
See generic front-end configuration parameters (1), set the text rules
2.7.6.3 set Sharpness
Enter the URL:
http://<servername>/cgi-bin/sensor.cgi?userName=<username>&password=<password>&acti
on=set&type=sharpness&value=%d
Input parameters:
See generic front-end configuration parameters (1)
Return to answer plain text:
Return generic plain text response
Return to plain text parameters:
See generic front-end configuration parameters (1), set the text rules
116
3 IP Camera CGI response text, group text rules,
common error description
3.1 Common responses text:
Success:
HTTP Code: 200 OK
Content-Type: text / plain
OK
Failure:
HTTP Code: 200 OK
Content-Type: text / plain
<error message>
<error message> error message is usually "error, return =% d" returns the string% d indicates the error
number. Please refer to the specific meaning of the error number error constant 3.3
3.2 Group Text rules:
Specific return plain text, image data volume and URL address access requests by different
decision:
1. Some operations need to return to image data request body. For example
snapshot http agreements, Video streaming and so on.
2. Device Configuration Related requests and other general equipment operation
returns plain text.
3. Under the RTSP protocol, related commands requests are returned URL address
4. Command on plain body composition rules: For non-cyclic portions are positioned in
front of the body part of the command, if the loop portion, the body is placed in the latter
part of the command, using the get command Count --- Begin - --- Flag ------- End group
code. For the set command takes Action - Begin - F lag - End group code.
5. For each loop, has a Count or Action for the beginning of the loop, Count describe
the loop body cycles , Action describes the operational behavior of the loop body, such as
the cover, add the like. Flag from begin to the first set of parameters for the first loop
command, the last one Flag to End of the loop the last set of parameters.
6. Alarm information and other related requests generally return plain text,
with attach mode when requested, will be plain loop
117
3.3 Error constant
General Error
Error number Description
-2 There is not enough memory available
-3 Using an invalid handle
-4 Use empty (NULL) pointer
-5 Function call is invalid.
-6 Error system environment.
-7 When the loader is malformed.
-8 When the loader, parameter error.
-9 Device or data is not ready.
-10 Data length error.
-11 The thread has to run.
-12 Thread failed to start
-13 Queue is full.
-14 The queue is empty
-15 System timed out
-16 Not Found
-17 SSL encryption is not required
-18 The need for SSL encryption
-19 ssl accpect overtime
-20 ssl connect timeout
-21 Cgi main name wrong
118
-22 Cgi second type does not exist
-23 Cgi parameter error
3.4 I / O error
This class defines a major mistake when performing disk operations, disk access occurred, file path
does not exist, serial access, access to audio devices such as an error.
Error
number
Description
-101 File does not exist
-102 File path does not exist
-103 An error occurred while opening the disk
-104 An error occurred while reading disk
-105 An error occurred while writing to disk
-106 When positioning (seek) file location errors
-107 Disk read and write to the end
-108 Lack of disk space or disk space is full
-109 Disk does not exist
-110 Disk Write Protect
-112 Disk not formatted
-113 Disk Error
-150 An error occurred while opening the serial port.
-151 An error occurred while reading the serial (com)
data
-152 An error occurred while writing data to the serial
port.
119
3.4.1 Network Error
Mainly for network error occurred during network transmission errors were defined, including
the Socket transmission errors, group packages unpack error.
Error
numbe
r
Description
-201 Network Socket not created
-202 Network Socket can not be created
-203 Unable to bind (BIND) to the specified IP address
and port, bound to fail
-204 You can not link to the specified IP address and port
links (CONNECT) server fails
-205 Linked server timeout
-206 Could not listen (listen) to the specified IP address
and port, monitor failure
-207 Not accept (accept) the connection request from
the client to accept the link failure
-208 Acceptance (accept) the client's connection request
timeout
-209 Network link has been disconnected
-210 Failed to send network SOCKET
-211 Send (send) data timeout
-212 An error occurred while receiving (receive) data
-213 When receiving (receive) data timeout
-214 Get socketaddr address error
-215 An error occurred Options (option) parameters
120
obtained when the network socket
-216 Get network configuration failed SOCKET options
-217 Network protocol is not supported
-218 Port has been occupied
-230 Can not create a packet, create a packet fails
-231 Analysis of the data header when an error occurs,
the packet header error
-232 Unable to create packet header, header failed to
create data
-233 Errors, load data error occurred when analyzing the
data packet payload
-234 Unable to create a packet payload data, create a
packet payload data errors
-235 Error An error occurred while RTP header extension
field analysis RPT package,
-236 Communication compression failure
3.4.2 Database Error
This class defines a major mistake when performing database operations occurred
database open, close, things operate, add, delete, modify, etc. error.
Error
numbe
r
Description
-301 Open a database error occurs, access to the
database failed.
-302 Error closing the database (Database) occurs
121
-303 Started a database transaction error occurs
-304 An error occurred when performing a database
transaction rollback, the database transaction
operation fails.
-305 An error occurred while submitting the operation
to perform database transactions, database
transaction operation fails
-306 An error occurred while performing database
insert (insert) operation, data insertion fails.
-307 Perform a database error occurred deleting
(delete) operation, data deletion failed.
-308 An error occurred while (update) operations to
perform database updates, data update fails
-309 Error occurred while performing a database query
(select) operation, data query fails
-310 Database query error
-311 Query result is empty.
3.4.3 Command Error
This class defines a major error during a session with the network video equipment,
communication commands that appear, such as: command parsing fails, the
command load error, the wrong version of the command and so on.
Error
number
Description
-401 Unknown command
-402 Command header parsing error.
-403 Create a command header error.
-404 Load command parsing errors.
-405 Load command creates an error
122
-406 Command wrong version number.
3.4.4 Business Application Error
This class defines a major mistake in the wrong application and network video
equipment business interactions that may occur, such as: wrong username, login
password errors.
Error
numbe
r
Description
-501 Response is not received the expected response
-502 Remote device handles data errors
-503 The device is not open
-504 Device open failed
-505 Equipment is occupied
-506 Device is not supported
-507 Login Username errors.
-508 Login password error.
-509 ADSL Internet dial-up fails.
-510 Serial is exclusively
-511 The maximum number of connections has been
reached
-512 Insufficient permissions
-513 The device is not configured
-550 Video session has been closed
-551 Video conversation thread has been closed
123
-552 Create a Directshow video component failure.
-553 Create a Directshow video component failure.
-601 Audio session has been closed.
-602 Audio conversation thread has been closed.
-603 Creating Directshow audio component failure.
-604 Operating Directshow audio component failure.
-605 Initialize DirectDraw component fails.
-606 Failed to initialize the decoder.
-607 Decoding failure.