SHARX SECURITY HTNC Series User manual

Sharx Security
HTNC Series PoE IP Camera
API Reference Manual
2018 Version

-2-
Introduction
This reference guide is for programmers wishing to send commands directly to a Sharx Security
HTNC series PoE IP camera.
Some commands also return detailed status information from the camera.
To use this reference guide you’d need to have administrator login access to an HTNC series camera
that is already set up for your network (or accessible to you remotely). It is also assumed that you
know the basics of writing a program or a script to send commands via HTTP.
Many commands can be tested easily by copying and pasting the example into a brower, while of
course substituting your own camera’s IP address for the parameter shown as ”camera ipaddress”
For example, let’s assume your camera is set up on 192.168.0.54, and you wish to obtain the current
settings for the camera’s time, then change the time zone, and then verify that the change took effect.
Then, according to the section on setting time parameters on page 158 of this user’s guide, you
would construct the query string as follows, and you could test it by pasting into your browser:
http://192.168.0.54/system/time.php?app=get
Then once you provide the proper login credentials to the camera, you’d get a long result string
starting with the following:
res=200&tsyncmode=2&dt=2018-07-29&tm=10:03:40&tzone=13&dst_enable=1
The res=200 means you got a valid result, and the rest of the response is explained on page 158
Should you wish to change a setting, such as setting time zone to Pacific Time, you’ll find in the
table that Pacific Time has the time zone code 4, and you’d set that with a command such as the
following:
http://192.168.0.54/system/time.php?app=set&tzone=4
Again you’d be looking for a valid response as designated with the result code 200, and you can
then double check that it took effect by issuing the query again:
http://192.168.0.54/system/time.php?app=get
And now the result is:
res=200&tsyncmode=2&dt=2018-07-29&tm=07:11:05&tzone=4&dst_enable=1
At times this manual refers to the Sony chipset name that is used in our cameras.
Xarina, also known as X2, is the chipset used in our HTNC4400 series of full HD 60 fps cameras
while Xarina Pro, also known as X4, is used in our HTNC4500 series of 5 MP cameras.

-3-
Stream path summary
Quite often the most important piece of information that a programmer is looking for is the spelling
of the camera’s stream paths, so we summarized it up front.
Primary H264 RTSP stream: /1/stream1
MJPEG RTSP stream: /1/stream2
Third stream (H264 RTSP): /1/stream3
JPEG snapshot: /snapshot/1/snapshot.jpg
MJPEG HTTP stream: /jpeg/1/jpeg.php
You can test the RTSP paths by entering rtsp:// followed by the IP address of the camera and the path
above into the VLC media player from www.videolan.org, as in the example below:
You can test the snapshot by adding http:// and the IP address and the JPEG path above into any
browser. For testing the HTTP MJPEG path you need a browser that supports MJPEG, such as
Chrome. Or you can also use VLC for this. Internet Explorer does not support MJPEG.

-4-
Table of Contents
Stream path summary...................................................................................................................... 3
Table of Contents.............................................................................................................................. 4
Audio................................................................................................................................................ 27
Revision History......................................................................................................................... 27
Introduction ................................................................................................................................ 27
Audio URI .................................................................................................................................. 27
Back Channel Audio URI........................................................................................................... 27
Audio Parameter......................................................................................................................... 27
Back Channel Audio Parameter.................................................................................................. 28
Examples .................................................................................................................................... 28
1) get the current setting......................................................................................................... 28
2) Audio Enable setup............................................................................................................. 28
3) Audio Codec setup ............................................................................................................. 28
4) Audio Bitrate setup............................................................................................................. 28
5) Audio Sampling Rate setup................................................................................................ 28
6) Audio Input setup............................................................................................................... 28
7) Audio Input Volume setup ................................................................................................. 28
8) Audio Input Mute setup...................................................................................................... 29
9) Back Channel Audio Enable setup..................................................................................... 29
10) Back Channel Audio Volume setup ................................................................................. 29
11) Back Channel Audio Mute setup...................................................................................... 29
12) Audio Input Auto Enable setup........................................................................................ 29
Caution........................................................................................................................................ 29
Config.txt......................................................................................................................................... 31
Revision History......................................................................................................................... 31
Introduction ................................................................................................................................ 31
Config.txt URI............................................................................................................................ 31
Config.txt Parameters................................................................................................................. 31
1) Parameters.......................................................................................................................... 31
2) Motorized options............................................................................................................... 33
3) RS-485 options................................................................................................................... 33
4) PTZ options........................................................................................................................ 33
5) VCA options....................................................................................................................... 34
6) Options ............................................................................................................................... 34
Example...................................................................................................................................... 36
1) get the current setting......................................................................................................... 36
Dome Configuration....................................................................................................................... 37
Dome – Home Function:.............................................................................................................. 37
Revision History......................................................................................................................... 37
Introduction ................................................................................................................................ 37
Home Function URI ................................................................................................................... 37
Home Function Parameter.......................................................................................................... 37
Examples .................................................................................................................................... 38
1) get the current setting......................................................................................................... 38
2) Home Function setup.......................................................................................................... 38
3) Home Function Waiting Time setup .................................................................................. 38

-5-
4) Home Function Type setup............................................................................................................. 38
5) Home Function number setup......................................................................................................... 38
6) Home Function number set setup....................................................................................... 38
Caution........................................................................................................................................ 38
Dome – Motor Setup:................................................................................................................... 40
Revision History......................................................................................................................... 40
Introduction ................................................................................................................................ 40
Motor Setup URI........................................................................................................................ 40
Motor Setup Parameter............................................................................................................... 40
Examples .................................................................................................................................... 40
1) get the current setting......................................................................................................... 40
2) Motor Setup Propotional setup........................................................................................... 40
3) Motor Setup Max Pan Speed setup..................................................................................... 40
4) Motor Setup Max Tilt Speed setup..................................................................................... 41
Caution........................................................................................................................................ 41
Dome – Preset:............................................................................................................................. 42
Revision History......................................................................................................................... 42
Introduction ................................................................................................................................ 42
Preset URI................................................................................................................................... 42
Preset Parameter......................................................................................................................... 42
Examples .................................................................................................................................... 43
1) get configurable Preset value.............................................................................................. 43
2) get the current setting......................................................................................................... 43
3) Preset creation .................................................................................................................... 43
4) Preset deletion .................................................................................................................... 43
5) Preset modification............................................................................................................. 43
6) Preset movement ................................................................................................................ 44
Caution........................................................................................................................................ 44
Dome – Privacy Zone:.................................................................................................................. 45
Revision History......................................................................................................................... 45
Introduction ................................................................................................................................ 45
Privacy Zone URI....................................................................................................................... 45
Privacy Zone Parameter.............................................................................................................. 45
Examples .................................................................................................................................... 45
1) get configurable privacy Zone List..................................................................................... 45
2) Privacy Zone creation......................................................................................................... 46
3) Privacy Zone modification................................................................................................. 46
4) Privacy Zone deletion......................................................................................................... 46
5) PTZ movement................................................................................................................... 46
Caution........................................................................................................................................ 46
Dome – RS485:............................................................................................................................ 47
Revision History......................................................................................................................... 47
Introduction ................................................................................................................................ 47
RS485 URI ................................................................................................................................. 47
RS485 Parameter........................................................................................................................ 47
Examples .................................................................................................................................... 47
1) get the current setting......................................................................................................... 47
2) DOME ID setup.................................................................................................................. 47
3) Protocol setup..................................................................................................................... 47
4) Baudrate setup.................................................................................................................... 47
5) Parity setup......................................................................................................................... 48

-6-
6) Dome Answer setup........................................................................................................................48
Caution................................................................................................................................................48
Dome – System Menu:................................................................................................................. 49
Revision History......................................................................................................................... 49
Introduction ................................................................................................................................ 49
System Menu URI...................................................................................................................... 49
System Menu Parameter............................................................................................................. 49
Examples .................................................................................................................................... 50
1) Get the current PTZ Camera information and settings....................................................... 50
2) Check current Origin Check function status....................................................................... 50
3) Calibration setup................................................................................................................. 50
4) Origin Check start............................................................................................................... 50
5) Enable Schedule Origin Check setup................................................................................. 50
6) Schedule Origin Check setup ............................................................................................. 50
7) FA Module F/W Upgrade................................................................................................... 51
F/W Upload ................................................................................................................................ 51
Caution........................................................................................................................................ 52
Dome – Tour:............................................................................................................................... 53
Revision History......................................................................................................................... 53
Introduction ................................................................................................................................ 53
Tour URI..................................................................................................................................... 53
Tour Parameter........................................................................................................................... 53
Examples .................................................................................................................................... 54
1) get configurable Tour value................................................................................................ 54
2) get configured Preset List................................................................................................... 54
3) get configured Tour List..................................................................................................... 54
4) get specific configured Tour List ....................................................................................... 54
5) Tour creation ...................................................................................................................... 54
6) Tour deletion ...................................................................................................................... 56
7) Tour modification............................................................................................................... 56
8) Tour movement .................................................................................................................. 56
Caution........................................................................................................................................ 56
Dome – View Angle: ................................................................................................................... 57
Revision History......................................................................................................................... 57
Introduction ................................................................................................................................ 57
View Angle URI......................................................................................................................... 57
View Angle Parameter................................................................................................................ 57
Examples .................................................................................................................................... 58
1) get the current setting......................................................................................................... 58
2) Tilt Angle Limit setup........................................................................................................ 58
3) Flip setup............................................................................................................................ 58
Caution........................................................................................................................................ 58
Event................................................................................................................................................ 59
Event – AIHM:............................................................................................................................. 59
Revision History......................................................................................................................... 59
Introduction ................................................................................................................................ 59
AIHM URI.................................................................................................................................. 59
AIHM Parameter ........................................................................................................................ 59
Examples .................................................................................................................................... 59
1) get the current setting......................................................................................................... 59

-7-
2) AIHM setup.................................................................................................................................... 59
3) AIHM record status check setup.....................................................................................................59
4) AIHM format event setup................................................................................................... 59
5) AIHM server setup............................................................................................................. 59
6) AIHM dwell time setup...................................................................................................... 60
Caution........................................................................................................................................ 60
Event – Alarm In:......................................................................................................................... 61
Revision History......................................................................................................................... 61
Introduction ................................................................................................................................ 61
Alarm In URI.............................................................................................................................. 61
Alarm In Parameter .................................................................................................................... 61
Examples .................................................................................................................................... 61
1) get the current setting......................................................................................................... 61
2) Alarm In setup.................................................................................................................... 61
3) Alarm In type setup............................................................................................................ 61
4) Alarm In dwell time setup.................................................................................................. 61
Caution........................................................................................................................................ 61
Event – Alarm Out:...................................................................................................................... 62
Revision History......................................................................................................................... 62
Introduction ................................................................................................................................ 62
Alarm Out URI........................................................................................................................... 62
Alarm Out Parameter.................................................................................................................. 62
Examples .................................................................................................................................... 62
1) get the current setting......................................................................................................... 62
2) Alarm Out setup ................................................................................................................. 62
3) Alarm Out type setup.......................................................................................................... 62
Caution........................................................................................................................................ 62
Event – Audio Alert:.................................................................................................................... 63
Revision History......................................................................................................................... 63
Introduction ................................................................................................................................ 63
Audio Alert URI......................................................................................................................... 63
Audio Alert Parameter................................................................................................................ 63
Examples .................................................................................................................................... 63
1) get the current setting......................................................................................................... 63
2) Audio Alert setup ............................................................................................................... 63
3) Audio file remove............................................................................................................... 63
4) Audio Alert Test method.................................................................................................... 63
Caution........................................................................................................................................ 63
1) Reminder for the Audio Alert file upload .......................................................................... 64
Event – Audio detection:.............................................................................................................. 65
Revision History......................................................................................................................... 65
Introduction ................................................................................................................................ 65
Audio detection URI................................................................................................................... 65
Audio detection Parameter ......................................................................................................... 65
Examples .................................................................................................................................... 65
1) get the current setting......................................................................................................... 65
2) Audio detection setup......................................................................................................... 65
3) Audio detection level setup................................................................................................ 65
4) Audio detection Dwell time setup...................................................................................... 65
Caution........................................................................................................................................ 65
Event – Boost:.............................................................................................................................. 67

-8-
Revision History................................................................................................................................. 67
Introduction.........................................................................................................................................67
Boost URI................................................................................................................................... 67
Boost Parameter.......................................................................................................................... 67
Examples .................................................................................................................................... 67
1) get the current setting......................................................................................................... 67
2) Boost setup......................................................................................................................... 67
3) Boost stream setup.............................................................................................................. 67
4) Boost stream1 Normal Condition setup.............................................................................. 67
5) Boost stream2 Normal Condition setup.............................................................................. 68
6) Boost stream3 Normal Condition setup.............................................................................. 68
7) Boost Condition setup ........................................................................................................ 69
Caution........................................................................................................................................ 69
1) You must check the following values in the response to http://”camera
ipaddress”/config.txt.......................................................................................................... 69
2) Explanation on “ch#¹_strm#²_○○○” ................................................................................ 70
3) When you setup Boost stream Normal Condition, boost_enable value must be equal to 1.
........................................................................................................................................... 70
Event – Map:................................................................................................................................ 71
Revision History......................................................................................................................... 71
Introduction ................................................................................................................................ 71
Event – Map................................................................................................................................ 71
Video & Image – Image Parameter............................................................................................ 71
Event In ID ................................................................................................................................. 72
Examples .................................................................................................................................... 73
1) get the current setting......................................................................................................... 73
2) Method setup...................................................................................................................... 73
3) Event name setup................................................................................................................ 73
4) Event out SMTP setup........................................................................................................ 73
5) Event out alarm setup......................................................................................................... 73
6) Event out FTP setup ........................................................................................................... 74
7) Event out FTP Server setup................................................................................................ 74
8) Event out HTTP notification setup..................................................................................... 74
9) Event out audio alert setup................................................................................................. 74
10) Event out preset setup....................................................................................................... 75
11) Event out record setup...................................................................................................... 75
12) Event out event push setup............................................................................................... 75
13) Event out light setup......................................................................................................... 75
14) Event out event notification setup.................................................................................... 75
15) Event out boost setup........................................................................................................ 75
16) setup all Maps at once (in case of Error on individual Map setup).................................. 75
Caution........................................................................................................................................ 76
Event – Event Push: ..................................................................................................................... 77
Revision History......................................................................................................................... 77
Introduction ................................................................................................................................ 77
Event Push URI.......................................................................................................................... 77
Event Push Parameter................................................................................................................. 77
Examples .................................................................................................................................... 77
1) Get the current setting ........................................................................................................ 77
2) Event Push setup ................................................................................................................ 77
3) Event Push Stream Type setup........................................................................................... 77

-9-
4) Event Push Pre-event setup ............................................................................................................78
5) Event Push Post-event setup...........................................................................................................78
6) Event Push URL setup........................................................................................................ 78
7) Event Push Port setup......................................................................................................... 78
8) Event Push User name setup .............................................................................................. 78
9) Event Push Password setup................................................................................................ 78
Caution........................................................................................................................................ 78
Event – Face Detector:................................................................................................................. 79
Revision History......................................................................................................................... 79
Introduction ................................................................................................................................ 79
Face Detector URI...................................................................................................................... 79
Face Detector Parameter............................................................................................................. 79
Examples .................................................................................................................................... 79
1) get the current setting......................................................................................................... 79
2) face detector enable setup................................................................................................... 79
3) threshold setup.................................................................................................................... 79
4) setup face detector at once.................................................................................................. 79
Event – FTP & JPEG: .................................................................................................................. 80
Revision History......................................................................................................................... 80
Introduction ................................................................................................................................ 80
FTP & JPEG URI....................................................................................................................... 80
FTP & JPEG Parameter.............................................................................................................. 80
Examples .................................................................................................................................... 81
1) Get the current setting ........................................................................................................ 81
2) FTP & JPEG setup ............................................................................................................. 81
3) FTP Server usage setup...................................................................................................... 81
4) FTP & JPEG Server address setup..................................................................................... 81
5) FTP & JPEG Port setup...................................................................................................... 82
6) FTP & JPEG Passive mode setup....................................................................................... 82
7) FTP & JPEG User name setup ........................................................................................... 82
8) FTP & JPEG Password setup............................................................................................. 82
9) FTP & JPEG Anonymous login setup................................................................................ 82
10) FTP & JPEG Remote directory setup............................................................................... 82
11) FTP & JPEG Time folder setup........................................................................................ 83
12) FTP & JPEG JPEG Time folder type setup...................................................................... 83
13) FTP & JPEG JPEG Pre-event time setup......................................................................... 83
14) FTP & JPEG JPEG Pre-event FPS setup.......................................................................... 83
15) FTP & JPEG JPEG Event FPS setup ............................................................................... 83
16) FTP & JPEG JPEG Post-event time setup........................................................................ 84
17) FTP & JPEG JPEG Post-event FPS setup........................................................................ 84
18) FTP & JPEG JPEG Prefix file name setup....................................................................... 84
19) FTP & JPEG JPEG Additional suffix setup..................................................................... 84
Caution........................................................................................................................................ 84
Event – Light:............................................................................................................................... 85
Revision History......................................................................................................................... 85
Introduction ................................................................................................................................ 85
Light URI.................................................................................................................................... 85
Light Parameter .......................................................................................................................... 85
Examples .................................................................................................................................... 85
1) get the current setting......................................................................................................... 85
2) Light setup.......................................................................................................................... 85

-10-
3) Light brightness setup..................................................................................................................... 85
4) Light mode & Light time setup ...................................................................................................... 85
5) Operates only at night mode setup ..................................................................................... 86
6) Inactivate setup................................................................................................................... 86
Caution........................................................................................................................................ 86
Event – Manual Trigger:.............................................................................................................. 87
Revision History......................................................................................................................... 87
Introduction ................................................................................................................................ 87
Manual Trigger Setup & Operation URI.................................................................................... 87
Manual Trigger Setup Parameter................................................................................................ 87
Manual Trigger Operation Parameter......................................................................................... 87
Example...................................................................................................................................... 87
1) Manual Trigger setup ......................................................................................................... 87
Caution........................................................................................................................................ 87
Event – Motion:............................................................................................................................ 89
Revision History......................................................................................................................... 89
Introduction ................................................................................................................................ 89
Event – Motion URI ................................................................................................................... 89
Event – Motion Parameter.......................................................................................................... 89
Examples (latest F/W)................................................................................................................ 90
1) get the current setting......................................................................................................... 90
2) Motion setup....................................................................................................................... 90
3) Motion Day & Night setup................................................................................................. 90
4) Motion Region create......................................................................................................... 90
5) Motion Region Parameter modify...................................................................................... 91
6) Motion Region remove....................................................................................................... 93
Examples (old F/W).................................................................................................................... 94
1) get the current setting......................................................................................................... 94
2) Motion setup....................................................................................................................... 94
3) Motion Day & Night setup................................................................................................. 94
4) Motion Region create......................................................................................................... 94
5) Motion Region modify....................................................................................................... 94
6) Motion Region remove....................................................................................................... 94
7) Motion modify all............................................................................................................... 94
Event – Network Loss:................................................................................................................. 96
Revision History......................................................................................................................... 96
Introduction ................................................................................................................................ 96
Network Loss URI...................................................................................................................... 96
Network Loss Parameter............................................................................................................. 96
Examples .................................................................................................................................... 96
1) Get the current setting ........................................................................................................ 96
2) Network Loss setup............................................................................................................ 96
3) Network Loss dwell time setup.......................................................................................... 96
Caution........................................................................................................................................ 96
Event –Notification Server:.......................................................................................................... 97
Revision History......................................................................................................................... 97
Introduction ................................................................................................................................ 97
Notification Server Parameter .................................................................................................... 97
Examples .................................................................................................................................... 97
1) get the current setting......................................................................................................... 97
2) Notification Server setup.................................................................................................... 97

-11-
3) Notification Server Type setup.......................................................................................................97
4) Notification Server Method setup...................................................................................................98
5) Notification Server URL setup........................................................................................... 98
6) Notification Server Port setup............................................................................................ 98
7) Notification Server user setup............................................................................................ 98
8) Notification Server password setup.................................................................................... 98
7) Notification Server Test ..................................................................................................... 98
Caution........................................................................................................................................ 98
Event – On Boot:.......................................................................................................................... 99
Revision History......................................................................................................................... 99
Introduction ................................................................................................................................ 99
On Boot URI............................................................................................................................... 99
On Boot Parameter ..................................................................................................................... 99
Examples .................................................................................................................................... 99
1) get the current setting......................................................................................................... 99
2) On Boot setup..................................................................................................................... 99
3) On Boot dwell time setup................................................................................................... 99
Caution........................................................................................................................................ 99
Event – PIR: ............................................................................................................................... 100
Revision History....................................................................................................................... 100
Introduction .............................................................................................................................. 100
PIR URI.................................................................................................................................... 100
PIR Parameter........................................................................................................................... 100
Examples .................................................................................................................................. 100
1) Get the current setting ...................................................................................................... 100
2) PIR setup .......................................................................................................................... 100
3) PIR sensitivity level setup................................................................................................ 100
4) PIR dwell time setup ........................................................................................................ 100
Caution...................................................................................................................................... 100
Event – PTZ Preset: ................................................................................................................... 101
Revision History....................................................................................................................... 101
Introduction .............................................................................................................................. 101
PTZ Preset URI ........................................................................................................................ 101
PTZ Preset Parameter............................................................................................................... 101
Examples .................................................................................................................................. 101
1) get the current setting....................................................................................................... 101
2) PTZ Preset setup............................................................................................................... 101
3) PTZ Preset Home position setup...................................................................................... 101
Caution...................................................................................................................................... 101
Event – Record:.......................................................................................................................... 102
Revision History....................................................................................................................... 102
Introduction .............................................................................................................................. 102
Record URI............................................................................................................................... 102
Record Parameter ..................................................................................................................... 102
Examples .................................................................................................................................. 103
1) get the current setting....................................................................................................... 103
2) record enable setup........................................................................................................... 103
3) record overwrite setup...................................................................................................... 103
4) record stream setup........................................................................................................... 104
5) record pre time setup........................................................................................................ 104
6) record post time setup....................................................................................................... 104

-12-
7) record audio setup.........................................................................................................................104
8) record schedule setup....................................................................................................................104
9) record device type setup................................................................................................... 105
10) record address setup ....................................................................................................... 105
11) record remote directory setup......................................................................................... 105
12) record capacity setup...................................................................................................... 105
13) record ID setup............................................................................................................... 105
13) record password setup .................................................................................................... 105
14) record device remove setup............................................................................................ 105
15) record device check setup............................................................................................... 105
16) How to setup record at once........................................................................................... 105
Event – SMTP:........................................................................................................................... 106
Revision History....................................................................................................................... 106
Introduction .............................................................................................................................. 106
SMTP URI................................................................................................................................ 106
SMTP Parameter....................................................................................................................... 106
Examples .................................................................................................................................. 107
1) Get the current setting ...................................................................................................... 107
2) SMTP setup...................................................................................................................... 107
3) Sender’s Mail address setup............................................................................................. 107
4) Interval setup.................................................................................................................... 107
5) Aggregate events setup..................................................................................................... 107
6) Image attachment setup.................................................................................................... 107
7) Mail server usage setup.................................................................................................... 107
8) Mail server address setup ................................................................................................. 107
9) Mail server Port setup....................................................................................................... 107
10) Connection security setup............................................................................................... 107
11) Mail server’s User name setup....................................................................................... 107
12) Mail server’s Password setup......................................................................................... 107
13) Mail server’s Login method setup.................................................................................. 107
14) Receiver address setup ................................................................................................... 108
15) SMTP Test method......................................................................................................... 108
Caution...................................................................................................................................... 108
Event – Tampering:.................................................................................................................... 109
Revision History....................................................................................................................... 109
Introduction .............................................................................................................................. 109
Tampering URI......................................................................................................................... 109
Tampering Parameter ............................................................................................................... 109
Examples .................................................................................................................................. 109
1) Get the current setting ...................................................................................................... 109
2) Tampering enable setup.................................................................................................... 109
3) Dwell time setup............................................................................................................... 109
4) Area rate setup.................................................................................................................. 110
5) Setup tampering at once ................................................................................................... 110
Event – Time Trigger:................................................................................................................ 111
Revision History....................................................................................................................... 111
Introduction .............................................................................................................................. 111
Time Trigger URI..................................................................................................................... 111
Time Trigger Parameter............................................................................................................ 111
Examples .................................................................................................................................. 112
1) get the current setting....................................................................................................... 112

-13-
2) Time Trigger usage setup.............................................................................................................112
3) Time Trigger # usage setup..........................................................................................................112
4) Time Trigger # Specific Time usage setup....................................................................... 112
5) Time Trigger # Day usage setup ...................................................................................... 112
6) Time Trigger # Day Of Week usage setup....................................................................... 112
7) Time Trigger # Month usage setup................................................................................... 112
8) setup Date in Time Trigger # Specific Time.................................................................... 112
9) setup Time in Time Trigger # Specific Time................................................................... 113
10) setup Time in Time Trigger # Day................................................................................. 113
11) setup Day in Time Trigger # Day Of Week ................................................................... 113
12) setup Date in Time Trigger # Day Of Week .................................................................. 113
13) setup Date in Time Trigger # Month.............................................................................. 113
14) setup Time in Time Trigger # Month............................................................................. 113
Caution...................................................................................................................................... 113
Event – VCA:............................................................................................................................. 114
Revision History....................................................................................................................... 114
VCA URI.................................................................................................................................. 114
VCA Parameter......................................................................................................................... 114
Examples .................................................................................................................................. 115
1) get the current setting of Fixed camera ............................................................................ 115
2) get the current setting of PTZ camera .............................................................................. 115
3) set Fixed camera rule number 1 to line detector............................................................... 116
4) set PTZ camera “PRESET-1” rule number 1 to line detector .......................................... 116
5) set Fixed camera rule number 2 to field detector ............................................................. 116
6) set PTZ camera “PRSET-1’ rule number 2 to field detector............................................ 116
7) set Fixed camera rule number 3 to absent ........................................................................ 117
8) set PTZ camera “PRESET-1” rule number 3 to absent.................................................... 117
9) reset counter of line detector rule number 1..................................................................... 117
10) reset counter of line detector rule number 2................................................................... 117
Caution...................................................................................................................................... 117
Event – Video Loss:................................................................................................................... 119
Revision History....................................................................................................................... 119
Introduction .............................................................................................................................. 119
Video Loss URI........................................................................................................................ 119
Video Loss Parameters............................................................................................................. 119
Examples .................................................................................................................................. 119
1) get the current setting....................................................................................................... 119
2) Video Loss setup .............................................................................................................. 119
3) Video Loss dwell time setup ............................................................................................ 119
Caution...................................................................................................................................... 119
Event – XML Notification: .......................................................................................................... 120
Revision History....................................................................................................................... 120
Introduction .............................................................................................................................. 120
XML Notification URI............................................................................................................. 120
XML Notification Parameter.................................................................................................... 120
Examples .................................................................................................................................. 120
1) Get the current setting ...................................................................................................... 120
2) XML Notification setup ................................................................................................... 120
3) XML Notification server URL setup................................................................................ 120
4) XML Notification Port setup............................................................................................ 120
Caution...................................................................................................................................... 120

-14-
Event Stream...................................................................................................................................121
Revision History............................................................................................................................... 121
Introduction .............................................................................................................................. 121
Event Stream URI..................................................................................................................... 121
Event Stream Format................................................................................................................ 121
1) HTTP GET REQUEST .................................................................................................... 121
2) HTTP POST REQUEST .................................................................................................. 121
3) HTTP CONTINUES RESPONSE ................................................................................... 122
Event Stream Request Parameter.............................................................................................. 122
Table 1. REQUEST PARAMETER..................................................................................... 122
Event Stream Response Parameter........................................................................................... 123
Table 2. BASIC RESPONSE PARAMETER ...................................................................... 123
Table 3. NORMAL FULLTEXT RESPONSE PARAMTER.............................................. 123
Table 4. MOTION FULLTEXT RESPONSE PARAMETER............................................. 123
Table 5. VIDEO LOSS FULLTEXT RESPONSE PARAMETER...................................... 124
Table 6. RECORD FULLTEXT RESPONSE PARAMETER............................................. 124
Table 7. VCA EVENT FULLTEXT RESPONSE PARAMETER....................................... 124
Table 8. VCA OBJECT FULLTEXT RESPONSE PARAMETER..................................... 125
Table 9. VCA RULE FULLTEXT RESPONSE PARAMETER......................................... 125
Examples .................................................................................................................................. 126
1) BASIC EVENT STREAM REQUEST............................................................................ 126
2) BASIC EVENT STREAM RESPONSE.......................................................................... 126
3) BASIC EVENT STREAM REQUEST WITH ALARMIN FILTER............................... 127
4). BASIC EVENT STREAM RESPONSE WITH ALARMIN FILTER............................ 127
5) EVENT STREAM REQUEST WITH MOTION FILTER.............................................. 127
6) EVENT STREAM RESPONSE WITH MOTION FILTER............................................ 127
7) EVENT STREAM REQUEST WITH VCA FILTER ..................................................... 128
8) EVENT STREAM RESPONSE WITH VCA FILTER.................................................... 128
JPEG Push..................................................................................................................................... 131
Revision History....................................................................................................................... 131
Introduction .............................................................................................................................. 131
JPEG Push URI ........................................................................................................................ 131
JPEG Push Parameter............................................................................................................... 131
Example.................................................................................................................................... 131
1) View JPEG Push .............................................................................................................. 131
Caution...................................................................................................................................... 131
Live................................................................................................................................................. 132
Live – Motor, Smart Focus Control API.................................................................................... 132
Revision History....................................................................................................................... 132
Motor Control: ........................................................................................................................... 132
Introduction .............................................................................................................................. 132
Motor Control URI................................................................................................................... 132
Motor Control Parameter.......................................................................................................... 132
Examples .................................................................................................................................. 132
1) zoom Control :.................................................................................................................. 132
2) focus Control :.................................................................................................................. 132
3) move Control :.................................................................................................................. 132
Caution...................................................................................................................................... 132
Live – Smart Focus:................................................................................................................... 134
Revision History....................................................................................................................... 134

-15-
Introduction.......................................................................................................................................134
Smart Focus URI ..............................................................................................................................134
Smart Focus Parameter............................................................................................................. 134
Example.................................................................................................................................... 134
Caution...................................................................................................................................... 134
Live – Light Control: ................................................................................................................. 135
Revision History....................................................................................................................... 135
Introduction .............................................................................................................................. 135
Light Control URI .................................................................................................................... 135
Light Control Parameter........................................................................................................... 135
Examples .................................................................................................................................. 135
1) get the current setting....................................................................................................... 135
2) Light Control setup........................................................................................................... 135
3) Light Level setup.............................................................................................................. 135
Caution...................................................................................................................................... 135
Live – PTZ Control:................................................................................................................... 136
Revision History....................................................................................................................... 136
Introduction .............................................................................................................................. 136
PTZ Control URI...................................................................................................................... 136
1) PTZ Control UI Open....................................................................................................... 136
2) PTZ Control API URL ..................................................................................................... 136
PTZ Control Parameter............................................................................................................. 136
Example.................................................................................................................................... 137
1) PTZ Control UI load......................................................................................................... 137
2) Pan, Tilt Control............................................................................................................... 137
3) Pan, Tilt Speed Control .................................................................................................... 137
4) IRIS Control ..................................................................................................................... 137
5) ZOOM Control................................................................................................................. 137
6) ZOOM Speed Control ...................................................................................................... 137
7) FOCUS Control................................................................................................................ 137
8) Preset Save ....................................................................................................................... 138
9) Preset Control................................................................................................................... 138
10) Tour Control................................................................................................................... 138
11) Pattern Control ............................................................................................................... 138
12) Position Control.............................................................................................................. 138
13) Position Speed Control................................................................................................... 138
14) Device menu................................................................................................................... 138
15) Preset menu .................................................................................................................... 138
16) Scan menu ...................................................................................................................... 138
17) Tour menu ...................................................................................................................... 138
18) Pattern menu................................................................................................................... 138
19) Esc menu ........................................................................................................................ 139
20) Stop menu....................................................................................................................... 139
21) Up menu......................................................................................................................... 139
22) Down menu .................................................................................................................... 139
23) Left menu ....................................................................................................................... 139
24) Right menu..................................................................................................................... 139
25) Enter menu ..................................................................................................................... 139
26) Ctrl control ..................................................................................................................... 139
27) shortcut on control.......................................................................................................... 139
28) shortcut off control......................................................................................................... 139

-16-
Caution..............................................................................................................................................139
Live – X1 Dome Configuration – Position:...................................................................................... 140
Revision History....................................................................................................................... 140
Introduction .............................................................................................................................. 140
PTZ Position URI..................................................................................................................... 140
PTZ Position Parameter............................................................................................................ 140
Examples .................................................................................................................................. 140
1) Get the current setting ...................................................................................................... 140
2) PTZ Position setup ........................................................................................................... 140
3) PTZ Position setup (Degree)............................................................................................ 141
4) Check whether the current PTZ Position is a Preset position or not................................ 141
Live View....................................................................................................................................... 142
Revision History....................................................................................................................... 142
Introduction .............................................................................................................................. 142
Live View URI ......................................................................................................................... 142
LIVE View Parameter.............................................................................................................. 142
Example.................................................................................................................................... 142
1) get the current setting....................................................................................................... 142
2) Video mode setup............................................................................................................. 142
3) Check response value after setup ..................................................................................... 142
Caution...................................................................................................................................... 142
Playback ........................................................................................................................................ 143
Revision History....................................................................................................................... 143
Introduction .............................................................................................................................. 143
Playback Parameter .................................................................................................................. 143
Examples .................................................................................................................................. 145
1) get entire calendar information......................................................................................... 145
2) get month information...................................................................................................... 145
3) get day information........................................................................................................... 145
4) get hour information......................................................................................................... 145
5) get minute information.................................................................................................... 146
6) get the first information of recording data........................................................................ 146
7) get the last information of recording data......................................................................... 146
8) get event list...................................................................................................................... 146
9) get event information........................................................................................................ 146
10) get clipcopy .................................................................................................................... 146
11) Number of connected Client........................................................................................... 146
Playback-Replay Control(RTSP).............................................................................................. 146
1) Forward Step Play ............................................................................................................ 147
2) Forward Step Forward...................................................................................................... 147
3) Forward Normal Play....................................................................................................... 147
4) Forward Double Speed Play............................................................................................. 148
5) Forward Triple Speed Play............................................................................................... 148
6) Forward Quadruple Speed Play........................................................................................ 148
7) Forward play stop............................................................................................................. 149
8) Backward Step Play.......................................................................................................... 149
9) Backward Step Backward................................................................................................. 149
10) Backward Normal Play................................................................................................... 149
11) Backward Double Speed Play........................................................................................ 150
12) Backward Triple Speed Play.......................................................................................... 150

-17-
13) Backward Quadruple Speed Play...............................................................................................150
14) Backward play stop .................................................................................................................... 150
15) Clipcopy ......................................................................................................................... 151
16) Only I Frame with interval 1 Sec(record time line)........................................................ 151
Caution...................................................................................................................................... 151
Snapshot ........................................................................................................................................ 152
Revision History....................................................................................................................... 152
Introduction .............................................................................................................................. 152
Snapshot URI............................................................................................................................ 152
Snapshot Parameter .................................................................................................................. 152
Example................................................................................................................................ 152
1) View Snapshot.................................................................................................................. 152
System............................................................................................................................................ 153
System – Bonjour:...................................................................................................................... 153
Revision History....................................................................................................................... 153
Introduction .............................................................................................................................. 153
Bonjour URI ............................................................................................................................. 153
Bonjour Parameter.................................................................................................................... 153
Example.................................................................................................................................... 153
1) get the current setting....................................................................................................... 153
2) Bonjour setup ................................................................................................................... 153
3) Friendly name setup ......................................................................................................... 153
Caution...................................................................................................................................... 153
System – Date&Time:................................................................................................................ 154
Revision History....................................................................................................................... 154
Introduction .............................................................................................................................. 154
Date&Time URI....................................................................................................................... 154
Date&Time Parameter.............................................................................................................. 154
Example.................................................................................................................................... 155
1) get the current setting....................................................................................................... 155
2) datetime mode setup......................................................................................................... 155
3) timezone setup.................................................................................................................. 155
4) timezone daylight saving setup ........................................................................................ 155
5) timezone daylight saving user setup................................................................................. 155
6) timezone daylight saving start month setup ..................................................................... 155
7) timezone daylight saving start week setup....................................................................... 155
8) timezone daylight saving start dayofweek setup.............................................................. 155
9) timezonedaylight saving start time setup.......................................................................... 155
10) timezone daylight saving end month setup..................................................................... 155
11) timezone daylight saving end week setup...................................................................... 156
12) timezone daylight saving end dayofweek setup............................................................. 156
13) timezone daylight saving end time setup........................................................................ 156
14) timezone daylight saving time gap setup........................................................................ 156
15) Date&Time setup............................................................................................................ 156
16) ntp server setup............................................................................................................... 156
17) ntp interval setup ............................................................................................................ 156
18) date format setup ............................................................................................................ 156
19) time format setup............................................................................................................ 156
20) How to setup date&time at once .................................................................................... 156
Caution...................................................................................................................................... 157

-18-
System – DDNS:...............................................................................................................................160
Revision History............................................................................................................................... 160
Introduction .............................................................................................................................. 160
DDNS URI ............................................................................................................................... 160
DDNS Parameter...................................................................................................................... 160
Examples .................................................................................................................................. 160
1) get the current setting....................................................................................................... 160
2) DDNS setup...................................................................................................................... 160
3) DDNS server URL setup.................................................................................................. 160
4) DDNS Host name setup.................................................................................................... 160
5) DDNS User name setup.................................................................................................... 160
6) DDNS Password setup ..................................................................................................... 161
7) DDNS Confirm Password setup....................................................................................... 161
8) DDNS Interval setup ........................................................................................................ 161
9) DDNS Local setup............................................................................................................ 161
Caution...................................................................................................................................... 161
System – H/W check:................................................................................................................. 162
Revision History....................................................................................................................... 162
Introduction .............................................................................................................................. 162
Hardware Check URI ............................................................................................................... 162
Hardware Check Parameter...................................................................................................... 162
Examples .................................................................................................................................. 162
1) get the current setting....................................................................................................... 162
2) LED light Test.................................................................................................................. 162
3) PIR Sensor Test................................................................................................................ 162
4) Speaker Test..................................................................................................................... 162
Caution...................................................................................................................................... 162
1) Speaker Test..................................................................................................................... 162
System – HTTPS:....................................................................................................................... 163
Revision History....................................................................................................................... 163
Introduction .............................................................................................................................. 163
HTTPS URI.............................................................................................................................. 163
HTTPS Parameter..................................................................................................................... 163
Authentication key Upload....................................................................................................... 163
Examples .................................................................................................................................. 163
1) get the current setting....................................................................................................... 163
2) HTTPS Mode setup.......................................................................................................... 163
Caution...................................................................................................................................... 164
System – Information:................................................................................................................ 165
Revision History....................................................................................................................... 165
Introduction .............................................................................................................................. 165
Information URI....................................................................................................................... 165
Information Parameter.............................................................................................................. 165
Examples .................................................................................................................................. 165
1) get the current setting....................................................................................................... 165
2) Device name setup............................................................................................................ 165
3) Location setup .................................................................................................................. 165
System – IP Filtering:................................................................................................................. 166
Revision History....................................................................................................................... 166
Introduction .............................................................................................................................. 166
IP Filtering URI........................................................................................................................ 166

-19-
IP Filtering Parameter....................................................................................................................... 166
Examples...........................................................................................................................................166
1) get the current setting....................................................................................................... 166
2) IP Filtering setup.............................................................................................................. 166
3) IP Filtering Priority 1........................................................................................................ 166
4) IP Filtering Priority 2........................................................................................................ 167
5) IP Filtering Priority 3........................................................................................................ 167
6) IP Filtering Priority 4........................................................................................................ 167
7) IP Filtering Priority 5........................................................................................................ 167
Caution...................................................................................................................................... 168
System – Language:................................................................................................................... 169
Revision History....................................................................................................................... 169
Introduction .............................................................................................................................. 169
Language URI........................................................................................................................... 169
Language Parameter................................................................................................................. 169
Examples .................................................................................................................................. 169
1) get the current setting....................................................................................................... 169
2) Language setup................................................................................................................. 169
System – Live Push:................................................................................................................... 170
Revision History....................................................................................................................... 170
Introduction .............................................................................................................................. 170
Live Push URI.......................................................................................................................... 170
Live Push Parameter................................................................................................................. 170
Examples .................................................................................................................................. 170
1) get the current setting....................................................................................................... 170
2) Live Push 1....................................................................................................................... 170
3) Live Push 2....................................................................................................................... 170
4) Live Push 3....................................................................................................................... 171
Caution...................................................................................................................................... 171
System – Log: ............................................................................................................................ 172
Revision History....................................................................................................................... 172
Introduction .............................................................................................................................. 172
Log URI.................................................................................................................................... 172
Log Parameter........................................................................................................................... 172
Examples .................................................................................................................................. 172
1) Type.................................................................................................................................. 172
2) Start time .......................................................................................................................... 172
3) End time ........................................................................................................................... 173
4) Start time, End time.......................................................................................................... 173
5) Start date........................................................................................................................... 173
6) End date............................................................................................................................ 173
7) Start date, End date........................................................................................................... 173
8) Start date, Start time, End date, End time......................................................................... 173
9) Type, Start date, Start time, End date, End time .............................................................. 173
Caution...................................................................................................................................... 173
System – Maintenance:.............................................................................................................. 174
Revision History....................................................................................................................... 174
Introduction .............................................................................................................................. 174
Maintenance URI...................................................................................................................... 174
1) Restart............................................................................................................................... 174
2) Reset................................................................................................................................. 174

-20-
3) Default.......................................................................................................................................... 174
4) Upgrade ........................................................................................................................................174
5) VCA Upgrade................................................................................................................... 174
6) Backup.............................................................................................................................. 174
7) Restore.............................................................................................................................. 174
8) Calibrate ........................................................................................................................... 174
Examples .................................................................................................................................. 174
1) Restart............................................................................................................................... 174
2) Reset................................................................................................................................. 174
3) Default.............................................................................................................................. 175
4) Upgrade............................................................................................................................ 175
5) VCA Upgrade................................................................................................................... 175
6) Backup.............................................................................................................................. 175
7) Restore.............................................................................................................................. 175
8) Calibrate ........................................................................................................................... 175
Caution...................................................................................................................................... 175
System – Media check: .............................................................................................................. 177
Revision History....................................................................................................................... 177
Introduction .............................................................................................................................. 177
Media Check URI..................................................................................................................... 177
Media Check Parameter............................................................................................................ 177
Caution...................................................................................................................................... 177
1) Parameter - “media_a_snd#³_enable” .............................................................................. 177
2) Parameter - “media_a_snd#³_in_gain”............................................................................. 177
System – NAT:........................................................................................................................... 178
Revision History....................................................................................................................... 178
Introduction .............................................................................................................................. 178
NAT URI.................................................................................................................................. 178
NAT Parameter......................................................................................................................... 178
Examples .................................................................................................................................. 178
1) get the current setting....................................................................................................... 178
2) Wire NAT traversal setup................................................................................................. 178
3) External wire HTTP port setup......................................................................................... 178
4) External wire RTSP port setup......................................................................................... 178
5) Wireless NAT traversal setup........................................................................................... 178
6) External wireless HTTP port setup................................................................................... 178
7) External wireless RTSP port setup................................................................................... 179
8) Response wire HTTP&RTSP URL.................................................................................. 179
9) Response wireless HTTP&RTSP URL............................................................................ 179
10) Response Error Code...................................................................................................... 179
Caution...................................................................................................................................... 179
System – Network:..................................................................................................................... 180
Revision History....................................................................................................................... 180
Introduction .............................................................................................................................. 180
System – Network URI............................................................................................................. 180
System – Network Parameter ................................................................................................... 180
Examples .................................................................................................................................. 181
1) get the current information............................................................................................... 181
2) IP address assign method setup........................................................................................ 181
3) fixed IP address setup....................................................................................................... 181
4) fixed Subnet Mask setup .................................................................................................. 181