Vacron HttpAPI_VIT_SDK manual

HTTP API
Vacron VIT 6Series
1
Content
Video Stream and Syntax .................................................................................................................. 3
Network ............................................................................................................................................ 5
Video ................................................................................................................................................ 6
Camera ........................................................................................................................................... 10
Audio .............................................................................................................................................. 11
Date Time ....................................................................................................................................... 12
Network Protocol ............................................................................................................................ 13
Account .......................................................................................................................................... 13
Restart ............................................................................................................................................ 13
PTZ ................................................................................................................................................ 14
Alarm ............................................................................................................................................. 15
Motion Detection ............................................................................................................................ 16
Revision Record
Date
Revision
Version
2013-25-Sept.
1.5
Session Number
Change Description
Add event notification over HTTP including
motion detection and wire input alarm.
For VIT v2.1.6 or later.
2013-18-Oct.
1.6
Add RTSP Port
For VIT v2.1.10 or later.
2013-25-Oct.
1.7
Add Alarm Parameter
For VIT v2.1.10 or later.
2
Video Stream and Syntax

HTTP authentication method
Digest or Basic.

Video Stream:

HTTP mainstream http://<ipcam:http_port>/video0.m4v
Response: HTTP multipart video frames
Example: http://192.168.1.221/video0.m4v

HTTP substream http://<ipcam:http_port>/video1.m4v
Example: http://192.168.1.221/video1.m4v

RTSP mainstream rtsp://<ipcam>/video0.sdp
Example: rtsp://192.168.1.221/video0.sdp

RTSP substream rtsp://<ipcam>/video1.sdp
Example: rtsp://192.168.1.221/video1.sdp

Get snapshot:

Snapshot of mainstream:
Syntax:
http://<ipcam:http_port>/ipcam/jpeg
Response: JPEG
Example: http://192.168.1.221/ipcam/jpeg

Snapshot of substream:
Syntax:
http://<ipcam:http_port>/ipcam/jpegcif
Response: JPEG
Example: http://192.168.1.221/ipcam/jpegcif
Note: To get substream snapshot, please set [Video->Stream Type] to “Dual” and
[Video-> Codec] to “Dual H.264”
3

Set Parameter
Syntax:
http://<ipcam:http_port>/vb.htm?parameter=value
Response: OK parameter
Example: http://192.168.1.221/vb.htm?wantype=1
OK wantype

Get Parameter value
Syntax: http://<ipcam:http_port>/vb.htm?parameter
Response: OK parameter=value
Example: http://192.168.1.221/vb.htm?wantype
OK wantype=1

Set multi-parameters in a single request
Syntax:
http://<ipcam:http_port>/vb.htm?prmt=value1&prmt=value2&prmt=value3...
Response: OK prmt1 OK prmt2 OK prmt3
Example:
http://192.168.1.221/vb.htm?wantype=1&netip=10.10.10.1&netmask=255.255.0.0&gateway=10.10.1.254
OK wantype OK netip OK netmask OK gateway

Get multi-parameters value in a single request
Syntax:
http://<ipcam:http_port>/vb.htm?prmt1&prmt2&prmt3...
Response: OK prmt1=value1 OK prmt2=value2 OK prmt3=value3
Example: http://192.168.1.221/vb.htm?videocodec&videocodeccombo&videocodecres
OK videocodec=0 OK videocodeccombo=0 OK videocodecres=3

Event notification over HTTP including motion detection and wire input alarm.
Syntax:
http://<ipcam:http_port>/event.cgi
Response: IPCam keeps sending continous HTTP multipart contents every 2 seconds.
Name
Value
Description
md
0: off
Event motion detection is triggered or not.
1: on
input1
0: off
Event input 1 is triggered or not.
1: on
input2
0: off
Event input 2 is triggered or not.
1: on
Example: http://192.168.1.221/event.cgi
4
Network
GUI Item
SDK Parameter
Value
Remark
WAN Type
wantype
1: Static IP
2: DHCP
Hostname
dhcphostname
MTU (DHCP)
mtu2
IP Address
netip
Subnet Mask
netmask
Default gateway IP
gateway
MTU (Static IP)
mtu1
Primary DNS
dnsip
Server
Secondary DNS
dnsip2
Server
5
Video
GUI Item
SDK Parameter
Value
Remark
Camera
title
Upto 11 characters
Stream Type
videocodec
0: Single
Refer to Resolution
1: Dual
Combo table
2: Tri_Stream
Codec
videocodeccombo
Refer to Resolution Combo table
Resolution
videocodecres
Refer to Resolution Combo table
framerate1
1-30
Stream 1
Framerate
If the value exceed
the capacity of
assigned resolution,
that IPcam will set it
to be “1”.
Bit Rate
bitrate1
Unit: Kbps
Max Bit Rate
maxbitrate1
Unit: Kbps
Rate Control
ratecontrol1
1: VBR
2: CBR
Date
datestampenable1
0: Disable
1: Enable
Position
dateposition
0: Bottom Left
1: Bottom Right
Format
dateformat
0: YYYY/MM/DD
1: MM/DD/YYYY
2: DD/MM/YYYY
Time
timestampenable1
0: Disable
1: Enable
Position
timeposition
0: Bottom Left
1: Bottom Right
Format
timeformat
0: 12Hrs
1: 24Hrs
Text
textenable1
0: Bottom Left
1: Bottom Right
Position
textposition1
0: Top-Left
1: Top-Right
Text Content
overlaytext1
Upto 20 characters
6
Stream2
Framerate
framerate2
1-30
Bit Rate
bitrate2
Unit: Kbps
Max Bit Rate
maxbitrate2
Unit: Kbps
Rate Control
ratecontrol2
1: VBR
2: CBR
Quality Factor
livequality
3-99
Date
datestampenable2
0: Disable
1: Enable
Time
timestampenable2
0: Disable
1: Enable
Text
textenable2
0: Disable
1: Enable
Position
textposition2
0: Top-Left
1: Top-Right
Text Content
overlaytext2
Upto 20 characters
Framerate
framerate3
1-30
Bit Rate
bitrate3
Unit: Kbps
Max Bit Rate
maxbitrate3
Unit: Kbps
Rate Control
ratecontrol3
1: VBR
Stream3
2: CBR
Date
datestampenable3
0: Disable
1: Enable
Time
timestampenable3
0: Disable
1: Enable
Text
textenable3
0: Disable
1: Enable
Position
textposition3
0: Top-Left
1: Top-Right
Text Content
overlaytext3
Upto 20 characters
Local Display
localdisplay
0: OFF
Video
1: NTSC
2: PAL
Mirror
mirctrl
0: OFF
1: HORIZONTAL
2: VERTICAL
3: ALL
7
Resolution Combo:
1) Single Stream mode: [videocodec=0]
Codec
Selectable resolution
H.264
H264:720 -
[videocodecres=0]
[videocodeccombo=0]
H264:D1 -
[videocodecres=1]
H264:SXVGA -
[videocodecres=2]
*H264:1080 -
[videocodecres=3]
H264:720MAX60 -
[videocodecres=4]
MPEG4
MPEG4:720 -
[videocodecres=0]
[videocodeccombo=1]
MPEG4:D1 -
[videocodecres=1]
MPEG4:SXVGA -
[videocodecres=2]
MPEG4:1080 -
[videocodecres=3]
MPEG4:720MAX60-
[videocodecres=4]
MegaPixel
H264:2MP -
[videocodecres=0]
[videocodeccombo=2]
JPG:2MP -
[videocodecres=1]
H264:3MP -
[videocodecres=2]
JPG:3MP -
[videocodecres=3]
H264:5MP -
[videocodecres=4]
JPG:5MP -
[videocodecres=5]
Example: Set IPCam to be H264@1080P single stream –
[http://192.168.1.221/vb.htm?videocodec=0&videocodeccombo=0&videocodecres=3]
2)Dual Streams mode: [videocodec=1]
Selectable resolution
Codec
H.264+JPEG
H264:720 +JPEG:VGA -
[videocodecres=0]
[videocodeccombo=0]
H264:D1+JPEG:D1 -
[videocodecres=1]
H264:720+JPEG:720 -
[videocodecres=2]
MPEG4+JPEG
MPEG4:720 +JPEG:VGA -
[videocodecres=0]
[videocodeccombo=1]
MPEG4:D1+JPEG:D1 -
[videocodecres=1]
MPEG4:720+JPEG:720 -
[videocodecres=2]
H264:720+H264:QVGA -
[videocodecres=0]
H264:720+ H264:CIF -
[videocodecres=1]
H264:D1+H264:QVGA -
[videocodecres=2]
Dual H.264
[videocodeccombo=2]
*H264:1080+H264:QVGA - [videocodecres=3]
H264:1080 + H264 CIF -
[videocodecres=4]
H264:1080 + H264:VGA -
[videocodecres=5]
8
Dual MPEG4
MPEG4:720+MPEG4:QVGA -
[videocodeccombo=3]
MPEG4:D1+MPEG4:D1 -
[videocodecres=0]
[videocodecres=1]
MPEG4:D1+MPEG4:QVGA - [videocodecres=2]
MPEG4:1080+MPEG4:QVGA - [videocodecres=3]
H.264+MPEG4
H264:D1+MPEG4:D1 -
[videocodecres=0]
[videocodeccombo=4]
Example: Set IPCam to be H264@ H264:1080+H264:QVGA Dual stream –
[http://192.168.1.221/vb.htm?videocodec=1&videocodeccombo=2&videocodecres=3]
3)Triple Streams mode: [videocodec=2]
Codec
Selectable resolution
Dual H264+JPEG
*H264:720+JPEG:VGA+H264:QVGA
[videocodeccombo=0]
[videocodecres=0]
Dual MPEG4+JPEG
MPEG4:720+JPEG:VGA+MPEG4:QVGA
[videocodeccombo=1]
[videocodecres=0]
Example: Set IPCam to be H264:720+JPEG:VGA+H264:QVGA Tri- stream –
[http://192.168.1.221/vb.htm?videocodec=3&videocodeccombo=0&videocodecres=0]
9
Camera
GUI Item
SDK Parameter
Value
Brightness
brightness
0-255
Contrast
contrast
0-255
Saturation
saturation
0-255
Sharpness
sharpness
0-255
Back Light
blc
0: OFF
Compensation
Backlight
Remark
1: ON
backlight
0: Min
1: Mid
Dynamic Range
dynrange
Enhancement
Flicker Control
flickerctrl
Color Mode
colormode
2: Max
0: None
1: Low Global
2: Medium Global
3: High Global
4: Low Local
5: Medium Local
6: High Local
0: 60Hz
1: 50Hz
0: Day
1: Auto
2: Night
Video
videostb
0: OFF
1: ON
lensdictcorrect
0: OFF
1: ON
imgsensormode
0: BINNING
1: SKIPPING
2: WINDOW
0: NONE
1: APPRO
2: TI
0: OFF
1: Auto Exposure
2: Auto White Balance
3: Auto Exposure + Auto Wite Balance
Stabilization
Lens Distortion
Correction
Image Sensor
Mode
2A Engine
img2a
2A Mode
img2atype
Spatial Filter
snfmode
0: OFF
1: ON
tnfmode
0: OFF
1: ON
(SNF)
Temporal Filter
(TNF)
10
Audio
GUI Item
SDK Parameter
Value
Remark
Enable Audio
audioenable
0: Disable
1: Enable
Audio Mode
audiomode
0: Only Mic(IPCam to PC/NVR)
1: Only Speaker
2: Both Mic & Speaker
Input Gain
audioinvolume
0-100
Encoding
audioencoding
0: G.711
1: AAC-LC
Sample Rate
audiosamplerate
0: 8KHz
1: 16KHz
Alarm Level
audioalarmlevel
0-100
Output Level
audiooutvolume
0-100
11
Date Time
GUI Item
SDK Parameter
Value
Synchroize with
ntpenable
0: Disable
Time Servers
Remark
1: Enable
SNTP Server
sntpip
FQDN or IP of NTP Server
Time Zone
timezone
0:
+0
-60:
-1
60:
+1
-120:
-2
120:
+2
-180:
-3
180:
+3
-240:
-4
240:
+4
-300:
-5
300:
+5
-360:
-6
360:
+6
-420:
-7
420:
+7
-480:
-8
480:
+8
-540:
-9
540:
+9
-600:
-10
600:
+10
-660:
-11
660:
+11
-720:
-12
720:
+12
newdate
newtime
+
yyyy/mm/dd
Set Date/Time with
Example: 2012/07/04
assigned value to
hh:mm:ss
IPCam
Example: 13:10:30
12
Network Protocol
GUI Item
SDK Parameter
Value
Remark
HTTP Port
httpport
1-65535
RTSP Port
rtspport
1-65535
Sync With NVR
SyncWithNvr
0: Disable
If this option is set
1: Enable
to be “0” that the
IP Camera will not
accept other HTTP
API command
anymore until you
enable this option
from web GUI.
Account
GUI Item
SDK Parameter
Value
Admin Username
adminid
Upto 30 characters
Password
adminpwd
Upto 16 characters
Operator
operatorid
Upto 30 characters
Password
operatorpwd
Upto 16 characters
Viewer Username
viewerid
Upto 30 characters
Password
viewerpwd
Upto 16 characters
Remark
username
Restart
GUI Item
SDK Parameter
Restart
ipcamrestartcmd
Remark
Restart IPCam
Please send this command later than 20 seconds after you
send the last setting command.
13
PTZ
GUI Item
SDK Parameter
Value
Protocol
ptzprotocol
0: OFF
Remark
1: PelcoP
2: PelcoD
Device ID
ptzaddr
0-3
Baud Rate
ptzbaud
0: 1200
1: 2400
2: 4800
3: 9600
4: 19200
PTZ Speed
ptzspeed
0-23
ptzpreset=#
# >= 1 (Location #)
Assign PTZ preset
location
# >= 1 (Location #)
Locate to a preset
location.
# >= 1 (Location #)
Clear a PTZ preset
location
ipncptz
16
Clear all preset
location
ipncptz
0:
1:
2:
3:
4:
5:
6:
7:
8:
9:
10:
21:
22:
23:
24:
ipncptz=14
ptzpreset=#
ipncptz=17
ptzpreset=#
ipncptz=15
STOP
LEFT
RIGHT
UP
DOWN
IRISDEC
IRISINC
ZOOMDEC
ZOOMINC
FOCUSDEC
FOCUSINC
LEFT UP
LEFT DOWN
RIGHT UP
RIGHT DOWN
Example:
Preset location #1 - http://192.168.1.221/vb.htm?ptzpreset=1&ipncptz=14
Locate to location #1 - http://192.168.1.221/vb.htm?ptzpreset=1&ipncptz=17
Clear preset location #1 - http://192.168.1.221/vb.htm?ptzpreset=1&ipncptz=15
14
Move PTZ
Alarm
GUI Item
SDK Parameter
Value
Remark
Enable Alarm
alarmenable
0: Disable
1: Enable
Alarm Duration
alarmduration
0: 10
1: 30
2: 60
3: 300
4: 600
Ethernet Lost
lostalarm
0: Disable
1: Enable
Audio Alarm
audioalarm
0: Disable
1: Enable
External Triggers
extalarm
0: Disable
1: Enable
Input1
exttrigger1input
0: Disable
1: Enable
Input2
exttrigger2input
0: Disable
1: Enable
Output1
exttrigger1output
0: Disable
1: Enable
Output2
exttrigger2output
0: Disable
1: Enable
15
Motion Detection
GUI Item
SDK Parameter
Value
Remark
Enable Alarm
alarmenable
0: Disable
1: Enable
Motion Detection
(Sensitivity
motionenable
motioncenable
Mode – Radio
0: Disable
Enable Alarm is
1: Enable
required.
0: Drop Down Menu
1: Customized Threshold
Button)
Sensitivity
motionsensitivity
0: Low
1: Medium
2: High
Customized
motioncvalue
0-100
motionblock
It described in 3-digit Hex. The first
Threshold
(Detecting Block)
digit is for first row of detecting area,
and so on.
0:
1:
2:
3:
4:
5:
6:
7:
8:
9:
A:
B:
C:
D:
E:
F:
□□□□
■□□□
□■□□
■■□□
□□■□
■□■□
□■■□
■■■□
□□□■
■□□■
□■□■
■■□■
□□■■
■□■■
□■■■
■■■■
Example:
Detecting Block
0
6
E
Value: 06E
16