eVideo Product SDK Developer’s Manual (ver 1cgv_systeme/pub/CGV/IP/DMEIP30IR/SDK/e... · Web view2012/06/19 · MUST This word or the adjective “REQUIRED” means that the item

eVideo Product SDK Developer’s Manual

(ver. 1.09)

Date: 2012.06.19


1. Overview..............................................................................................................141.1 Abstract.......................................................................................................141-2. Revision History..........................................................................................141-3. Terminology................................................................................................17

2. Syntax and Resources..........................................................................................192-1. General syntax...........................................................................................192-2. Resources...................................................................................................202-3. Return Value...............................................................................................24

3. Resources and Requests......................................................................................263-1. Video & Image............................................................................................26

3-1-1. Video.................................................................................................263-1-2. ROI (Region Of Interest)....................................................................363-1-3. Image................................................................................................393-1-4. AE & AWB..........................................................................................443-1-5. Privacy Masking................................................................................513-1-6. Day & Night.......................................................................................563-1-7. WDR & 3D-DNR.................................................................................603-1-8. IR Control..........................................................................................63

3-2. Audio..........................................................................................................643-3. Event..........................................................................................................67

3-3-1. Event In – On Boot.............................................................................683-3-2. Event In – Alarm In............................................................................683-3-3. Event In – Manual Trigger..................................................................693-3-4. Event In – Motion...............................................................................713-3-5. Event In - Video Loss.........................................................................753-3-6. Event In – Network Loss....................................................................753-3-6. Event Out – SMTP (E-Mail).................................................................763-3-7. Event Out – FTP & JPEG.....................................................................803-3-8. Event Out – HTTP Server...................................................................863-3-9. Event Out – Alarm Out.......................................................................883-3-10. Event Out – Audio Alert...................................................................893-3-11. Event Out – Record..........................................................................913-3-12. Event Out – PTZ Preset....................................................................953-3-13. Event Map.......................................................................................963-3-14. Event In - PIR.................................................................................103

- 1 -


3-3-15. Event In – Audio Detection............................................................1043-3-16. Event Out – Light...........................................................................1053-3-17. Event Out – Event Push.................................................................105

3-4. Device......................................................................................................1063-4-1. Device – PTZ...................................................................................1073-4-2. Device - RS485................................................................................1083-4-3. Device – LED...................................................................................110

3-5. System.....................................................................................................1103-5-1. Security – Users..............................................................................1103-5-2. Security – HTTPS.............................................................................1133-5-3. Security – IP Filtering.......................................................................1163-5-4. Date & Time....................................................................................1173-5-5. Network – Basic...............................................................................1233-5-6. Network – DDNS..............................................................................1273-5-7. Network – RTP.................................................................................1293-5-8. Network – UPnP...............................................................................1323-5-9. Network – QoS.................................................................................1333-5-10. Network - NAT Traversal................................................................1363-5-11. Maintenance.................................................................................1373-5-12. Language......................................................................................1393-5-13. Information...................................................................................1403-5-14. Network - Zeroconf........................................................................1403-5-15. Network - Bonjour.........................................................................1413-5-16. Network – Live Push......................................................................1423-5-17. Network – Hole Punching...............................................................1433-5-18. Network – Wireless........................................................................144

3-6. Live View..................................................................................................1463-6-1. Live View for HEV0118H..................................................................1463-6-2. Live View for Model_B.....................................................................147

4. Configurations (config.txt).................................................................................1505. PTZ Control via HTTP.........................................................................................1596. Event Stream via HTTP......................................................................................1637. Video/Audio Stream...........................................................................................1668. JPEG Snapshot URL............................................................................................1689. Replaying...........................................................................................................169

9-1. Timelaps Searching..................................................................................169

- 2 -


9-1-1. Get Recording Information of the Current Date and Time (get_calendar)...........................................................................................1699-1-2. Get Recording Information of the Specified Month (get_month)......1709-1-3. Get Recording Information of the Specified Date (get_month with date).........................................................................................................1719-1-4. Get Recording Information of the Specified Hour (get_hour)...........1729-1-5. Get Recording Information of the Specified Minute (get_hour)........173

9-2. Event Searching.......................................................................................1749-2-1. Get Event Recording Information of the Specified Date and Time (get_event)................................................................................................1749-2-2. Get Event Information of the Specified Record Index (get_index). . .175

9-3. Replaying Connection Status (get_clients)................................................1769-4. Get Olddest and Latest Recorded Data (gotofirst/gotolast)......................1779-5. Replaying Controls (RTSP)........................................................................179

9-5-1. Initiating Playback...........................................................................1799-5-2. Range header field..........................................................................1809-5-3. Rate-Control header field................................................................1809-5-4. Frames header field........................................................................1819-5-5. Scale header field...........................................................................1819-5-6. RTSP describe..................................................................................185

9-6. Replaying Stream (RTP)............................................................................1869-6-1. RTP..................................................................................................186

10. Back-Channel Audio Transmission....................................................................18811. JPEG Push.........................................................................................................18812. Smart Focus.....................................................................................................18913. Dome configurations for HDS-A411, HDS-S422W.............................................189

13-1. Auto scan...............................................................................................18913-2. Preset.....................................................................................................193

13-2-1. HDS-A411 Series...........................................................................19313-2-2. HDS-S422W Series........................................................................197

13-3. Tour........................................................................................................20213-4. Pattern....................................................................................................20513-5. OSD........................................................................................................20613-6. Home......................................................................................................20713-7. Motor Setup............................................................................................20913-8. View Angle..............................................................................................210

- 3 -


13-9. System Menu..........................................................................................21213-10. RS-485..................................................................................................213

14. Image configurations for HDS-A411.................................................................21514-1. Image.....................................................................................................21514-2. AE...........................................................................................................21714-3. Auto Focus..............................................................................................22214-4. White Balance........................................................................................223

15. Image configurations for HDZ-A411, HDA-A411F.............................................22415-1. Image.....................................................................................................22515-2. AE & AWB...............................................................................................228

16. Image configurations for HDS-S422W..............................................................23416-1. Image.....................................................................................................23416-2. AE...........................................................................................................23716-3. Auto Focus..............................................................................................24116-4. White Balance........................................................................................24216-5. Privacy Masking......................................................................................243

17. Image configurations for HDZ-P622, HDA-S422F, HDG-M220F.........................24517-1. Image.....................................................................................................24517-2. AE & AWB...............................................................................................251

18. Configurations for HNS-S113J...........................................................................25818-1. Auto Exposure........................................................................................25818-2. Auto Focus..............................................................................................26618-3. White Balance........................................................................................26718-4. Digital Image Stabilization......................................................................26818-5. Camera Setup.........................................................................................26918-6. Event In - Analytic..................................................................................27718-7. Preset.....................................................................................................28218-8. Auto Scan...............................................................................................29018-9. Tour........................................................................................................29318-10. Pattern..................................................................................................29518-11. OSD......................................................................................................29718-12. Home Function.....................................................................................29918-13. Motor Setup..........................................................................................30118-14. RS-485..................................................................................................30418-15. View Angle............................................................................................30518-16. System Menu........................................................................................307

- 4 -


18-17. Privacy Zone.........................................................................................30819. HTTP Event Stream for Fastrax 4.....................................................................30920. Discovery.........................................................................................................315

20-1. Communication Channel........................................................................31520-2. Message.................................................................................................31620-3. Example Code........................................................................................318

21. Light Control via HTTP......................................................................................320

- 5 -


[Table List][Table 1] Model_A Resources...................................................................................................................20

[Table 2] Model_B Resources...................................................................................................................21

[Table 3] Model_C Resources...................................................................................................................22

[Table 4] Parameters of video.php...........................................................................................................28

[Table 5] Model_A Resolution...................................................................................................................31

[Table 6] Model_B Resolution...................................................................................................................31

[Table 7] Model_C Resolution..................................................................................................................32

[Table 8] Structure of GOV (Example, GOV size = 5, Framerate =10 fps)..........................................32

[Table 9] Video Stream Quality Value Range in Model_B.....................................................................32

[Table 10] Parameters of roictrl.php........................................................................................................37

[Table 11] ROI Move Commands and Descriptions (roi_move)...........................................................39

[Table 12] Parameters of image.php........................................................................................................39

[Table 13] Range of Image Appearance Values.......................................................................................40

[Table 14] Flipping and Mirroring Images..............................................................................................42

[Table 15] Parameters of ae_awb.php in MODE_B...............................................................................44

[Table 16] Exposure Mode (ae_mode)......................................................................................................45

[Table 17] Manual Exposure Shutter Speed............................................................................................46

[Table 18] Parameters of ae_awb.php in Model_C.................................................................................46

[Table 19] White Balance Control............................................................................................................46

[Table 20] Parameters of masking.php in Model_A/C...........................................................................51

[Table 21] Parameters of masking.php in the HDB-M120, HDG-M120 series in Model_B...............55

[Table 22] Parameters of day_night.php.................................................................................................56

[Table 23] Transition Level of Day & Night Control Mode...................................................................58

[Table 24] Parameters of day_night.php in HDB-M120, HDG-M120 series (Model_B)....................59

[Table 25] Parameters of blc_wdr.php in HDB-M120, HDG-M120 series (Model_B)........................60

[Table 26] Shutter Speed...........................................................................................................................62

[Table 27] Parameters of ir_control.php in Model_C............................................................................63

[Table 28] Parameters of audio.php.........................................................................................................64

[Table 29] Audio Input/Output Volume Gain Level...............................................................................65

[Table 30] Parameters of onboot.php.......................................................................................................68

[Table 31] Parameters of alaram_in.php.................................................................................................69

[Table 32] Parameters of trigger.php.......................................................................................................70

[Table 33] Parameters of motion.php.......................................................................................................73

[Table 34] Parameters of loss.php............................................................................................................75

[Table 35] Parameters of netloss.php.......................................................................................................76

- 6 -


[Table 36] Parameters of smtp.php..........................................................................................................77

[Table 37] Parameters of ftp.php..............................................................................................................80

[Table 38] Parameters of http_server.php...............................................................................................86

[Table 39] Parameters of alarm_out.php.................................................................................................88

[Table 40] Parameters of audio_alert.php...............................................................................................89

[Table 41] Parameters of record.php.......................................................................................................91

[Table 42] Status of Recording Device.....................................................................................................92

[Table 43] Parameters of ptz_preset.php.................................................................................................95

[Table 44] Parameters of map.php...........................................................................................................96

[Table 45] Event ID in Event Map............................................................................................................97

[Table 46] Parameters of event_pop.php.................................................................................................99

[Table 47] Parameters of pir.php............................................................................................................103

[Table 48] Parameters of pir.php............................................................................................................104

[Table 49] Parameters of light.php.........................................................................................................105

[Table 50] Parameters of event_push.php.............................................................................................105

[Table 51] Parameters of ptz.php...........................................................................................................107

[Table 52] PTZ Protocols and Values.....................................................................................................107

[Table 53] Parameters of rs485.php.......................................................................................................109

[Table 54] Parameters of ptz.php...........................................................................................................110

[Table 55] Parameters of user.php..........................................................................................................111

[Table 56] List of registered users...........................................................................................................111

[Table 57] Parameters of user.php..........................................................................................................114

[Table 58] Parameters of filering.php....................................................................................................116

[Table 59] Parameters of time.php.........................................................................................................117

[Table 60] Time Synchronization Value.................................................................................................118

[Table 61] Time Zone Value and Property.............................................................................................119

[Table 62] Date & Time Format Parameters and Values.....................................................................123

[Table 63] Parameters of network.php..................................................................................................124

[Table 64] Parameters of ddns.php........................................................................................................128

[Table 65] Parameters of rtp.php...........................................................................................................130

[Table 66] RTP Port Ranges....................................................................................................................131

[Table 67] Parameters of upnp.php........................................................................................................133

[Table 68] Parameters of qos.php...........................................................................................................134

[Table 69] Automatic Network Traffic Control Method......................................................................135

[Table 70] Parameters of nat.php...........................................................................................................136

[Table 71] Return value of NAT traversal.............................................................................................137

- 7 -


[Table 72] Default Network Parameters................................................................................................138

[Table 73] Parameters of language.php.................................................................................................139

[Table 74] Parameters of information.php in Model_A.......................................................................140

[Table 75] Parameters of zeroconf.php..................................................................................................141

[Table 76] Parameters of bonjour.php...................................................................................................141

[Table 77] Parameters of live_push.php................................................................................................142

[Table 78] Parameters of hole_punching.php.......................................................................................143

[Table 79] Parameters of wireless.php...................................................................................................144

[Table 80]Parameters of wireless_setup.php.........................................................................................145

[Table 81] Parameters of source.php in HEV0118H.............................................................................146

[Table 82] Parameters of source.php in Model_B.................................................................................147

[Table 83] TV Out Source and Value (tv_source).................................................................................147

[Table 84] TV Out Sequence Parameter and Value (tv_seq_source)..................................................148

[Table 85] Parameters of config.txt........................................................................................................156

[Table 86] Device options.........................................................................................................................158

[Table 87] Parameters of /ptz/control.php , /menu/control.php and /mptz/control.php...................159

[Table 88] PTZ Command Strings.........................................................................................................160

[Table 89] Parameters of /stream/event_strm.php for request............................................................163

[Table 90] Parameters of /stream/event_strm.php for reply................................................................164

[Table 91] URLs of the streams..............................................................................................................166

[Table 92] URL of the snapshot image...................................................................................................168

[Table 93] Recording Information of get_calendar command (Calendar).........................................169

[Table 94] Recording Information of get_month command (Month).................................................170

[Table 95] Recording Information of get_month with date command (Date)....................................171

[Table 96] Recording Information of get_hour command (Hour)......................................................172

[Table 97] Recording Information of get_hour command (Hour)......................................................173

[Table 98] Event type for searching........................................................................................................174

[Table 99] Event-recording Searching Information of get_event command......................................175

[Table 100] Event-recording Searching Information of get_event command....................................176

[Table 101] Parameters of getting client connections status................................................................176

[Table 102] Parameters of playback.php...............................................................................................177

[Table 103] URI Field in Replaying RTSP.............................................................................................179

[Table 104] RTSP Header Fields for Replaying....................................................................................180

[Table 105] URL of the Jpeg Push..........................................................................................................188

[Table 106] URL of the Smart Focus......................................................................................................189

[Table 107] Parameters of autoscan.php...............................................................................................189

- 8 -


[Table 108] Parameters of preset.php....................................................................................................193

[Table 109] Preset Focus Mode...............................................................................................................194

[Table 110] Preset Exposure Mode.........................................................................................................195

[Table 111] Preset AGC Gain..................................................................................................................195

[Table 112] Preset Shutter Speed............................................................................................................196

[Table 113] Preset Exposure....................................................................................................................196

[Table 114] BLC Level.............................................................................................................................197

[Table 115] Day & Night Mode...............................................................................................................197

[Table 116] Parameters of preset.php....................................................................................................198

[Table 117] Focus Mode...........................................................................................................................199

[Table 118] Preset Exposure Mode.........................................................................................................200

[Table 119] Preset Gain Value.................................................................................................................200

[Table 120] Preset Shutter Speed............................................................................................................200

[Table 121] Preset Exposure Value.........................................................................................................201

[Table 122] Preset Day&Night Mode.....................................................................................................202

[Table 123] Parameters of tour.php........................................................................................................203

[Table 124] Parameters of pattern.php..................................................................................................205

[Table 125] Parameters of osd.php.........................................................................................................206

[Table 126] Parameters of home.php.....................................................................................................207

[Table 127] Parameters of motor.php....................................................................................................209

[Table 128] Parameters of view_angle.php............................................................................................211

[Table 129] Parameters of system_menu.php.......................................................................................213

[Table 130] Parameters of comm.php....................................................................................................214

[Table 131] Parameters of image.php....................................................................................................216

[Table 132] FNR Value.............................................................................................................................216

[Table 133] Flipping and Mirroring Images..........................................................................................217

[Table 134] Max Frame Rate..................................................................................................................217

[Table 135] Parameters of ae_awb.php..................................................................................................218

[Table 136] Exposure Mode....................................................................................................................218

[Table 137] DSS Limit List......................................................................................................................219

[Table 138] AGC Gain Value...................................................................................................................220

[Table 139] Shutter Speed.......................................................................................................................220

[Table 140] Exposure Value.....................................................................................................................221

[Table 141] Day&Night Mode.................................................................................................................221

[Table 142] BLC/WDR Mode.................................................................................................................222

[Table 143] BLC Level.............................................................................................................................222

- 9 -


[Table 144] Parameters of auto_focus.php............................................................................................222

[Table 145] Focus Mode...........................................................................................................................223

[Table 146] Focus Limit...........................................................................................................................223

[Table 147] Parameters of white_balance.php......................................................................................223



[Table 150] FNR.......................................................................................................................................227


[Table 152] Max Frame Rate..................................................................................................................227



[Table 155] DSS Limit List......................................................................................................................229

[Table 156] AGC Gain Value...................................................................................................................230




[Table 160] IR Status...............................................................................................................................232

[Table 161] Day&Night Sensitivity.........................................................................................................232

[Table 162] BLC Mode............................................................................................................................233

[Table 163] BLC Level.............................................................................................................................233

[Table 164] Day&Night and WDR function by Exposure Mode.........................................................233


[Table 166] Gain Limit............................................................................................................................235

[Table 167] Custom Gamma...................................................................................................................236

[Table 168] Chroma.................................................................................................................................236






[Table 174] Gain Value............................................................................................................................240


[Table 176] Parameters of auto_focus.php............................................................................................241

[Table 177] Focus Mode...........................................................................................................................242


[Table 179] Parameters of white_balance.php......................................................................................243

- 10 -


[Table 180] White Balance......................................................................................................................243

[Table 181] Parameters of masking.php................................................................................................244


[Table 183] Custom Color Gain..............................................................................................................247

[Table 184] Custom Gamma...................................................................................................................248

[Table 185] Chroma.................................................................................................................................248

[Table 186] Focus Mode...........................................................................................................................249





[Table 191] Gain Limit............................................................................................................................254



[Table 194] Gain Value............................................................................................................................255

[Table 195] Max Bright Value with Gain Limit....................................................................................256

[Table 196] Day & Night Mode...............................................................................................................256

[Table 197] WDR & BLC Mode.............................................................................................................257

[Table 198] White Balance......................................................................................................................257

[Table 199] Parameters of ae.php in Model_C......................................................................................258

[Table 200] Parameters of auto_focus.php in Model_C.......................................................................266

[Table 201] Parameters of white_balance.php in Model_C.................................................................267

[Table 202] Parameters of dis.php in Model_C.....................................................................................268

[Table 203] Parameters of camera_setup.php in Model_C..................................................................269

[Table 204] Parameters of analytic.php.................................................................................................277

[Table 205] Parameters of preset.php in Model_C...............................................................................282

[Table 206] Parameters of auto_scan.php in Model_C........................................................................290

[Table 207] Parameters of tour.php in Model_C..................................................................................294

[Table 208] Parameters of pattern.php in Model_C.............................................................................296

[Table 209] Parameters of osd.php in Model_C....................................................................................297

[Table 210] Parameters of home_function.php in Model_C................................................................300

[Table 211] Parameters of home_function.php in Model_C................................................................301

[Table 212] Slow Pan, Tilt Value.............................................................................................................302

[Table 213] Normal Pan Value................................................................................................................302

[Table 214] Normal Tilt Value.................................................................................................................303

[Table 215] Turbo Pan Value...................................................................................................................303

- 11 -


[Table 216] Turbo Tilt Value...................................................................................................................303

[Table 217] Parameters of comm.php in Model_C...............................................................................304

[Table 218] RS485 Protocol.....................................................................................................................304

[Table 219] Parameters of pattern.php in Model_C.............................................................................305

[Table 220] Parameters of system_menu.php in Model_C..................................................................307

[Table 221] Parameters of privacy_zone.php in Model_C...................................................................308

[Table 222] Parameters of /stream/event_strm.php for request..........................................................310

[Table 223] Parameters of /stream/event_strm.php for reply..............................................................311

[Table 224] Server/Client communication channel...............................................................................316

[Table 225] Message structure................................................................................................................316

[Table 226] Command List......................................................................................................................317

[Table 227] Mode List..............................................................................................................................317

[Table 228] Parameters of /lige/light_control............................................................................................320

- 12 -


[Figure List][Figure 1] Motion Regions in Model_A and C........................................................................................71

[Figure 2] RTP Packet Layout for Replaying............................................................................................178

- 13 -


1. Overview

1.1 Abstract

This document specifies the external HTTP-based application programming interface of the HiTRON cameras and video encoders with firmware version 1.00 and above.

This HTTP-based application programming interface provides the functionality for requesting single and multi-part images and for getting and setting internal parameter values. The image and requests are handled by the built-in web server.

1-2. Revision History

Version Date Comment1.00 2009-Aug-30 Initial version1.01 2009-Oct-10 Modify HTTPS Certification

File Upload1.01 2009-Oct-10 Append Language 1.01 2009-Oct-10 Append NAT Traversal1.01 2009-Oct-10 Append Privacy Masking1.01 2009-Oct-10 Modify Audio Alert1.01 2009-Oct-13 Fix Resolution1.02 2010-Jan-06 Date&Time Format1.02 2010-Jan-06 Snapshot URL1.03 2010-Jan-28 Append PTZ Protocols and

Values1.03 2010-Jan-28 Append ROI Preset/Save1.04 2010-Mar-16 Video Input1.04 2010-Mar-16 Day & Night Mode1.04 2010-Mar-16 Device Information1.04 2010-Mar-16 Network Hostname1.04 2010-Mar-16 Remove video out quad

mode1.05 2010-Dec-01 Append Model C1.06 2011-Mar-29 Model B Firmware Revision

- 14 -


1.06 2011-Mar-29 Append Model A/C (HDU-Txx Series)Append Model B (HDB-M120, HDG-M120 series)

1.07 2011-Mar-31 Errata Fix1.08 2012-Jan-09 Append Model A/B/C

Errata Fix1.09 2012-Jun-19 Add HDZ-A411, HDA-

A411F, HDS-A411, HDZ-P622, HDA-S422F, HDS-S422W, HDG-M220F.Add HNS-S113J.Add Discovery Protocol.

Applicable Product ModelsProduct F/W Version Description Notice

HEV0118H 2.4.8 H.264 Encoder 1CH

Model_A

HPCB-E5WNH9 2.4.8 H.264 BOX (NTSC, HWAK)HPCB-F5WNH9 2.4.8 H.264 BOX (PAL, HWAK)

HPCG-E5WNW5S7H8

2.4.8 H.264 DOME (NTSC)

HPCG- F5WNW5S7H8

2.4.8 H.264 DOME (PAL)

HNV3H22D1NSH1

2.4.8 H.264 DOME (NTSC, PTZ-3)

HNV3H22D1PSH1 2.4.8 H.264 DOME (PAL, PTZ-3)HNS-P183 2.4.8 H.264 Fastrax 3HEB2MPN 2.2.96 H.264 BOX (NTSC, 2M Pixel) Model_BHEB2MPP 2.2.96 H.264 BOX (PAL, 2M Pixel)HEV2MPN 2.2.96 H.264 DOME (NTSC, 2M Pixel)HEV2MPP 2.2.96 H.264 DOME (PAL, 2M Pixel)

HEB2MPN1 2.2.96H.264 BOX (NTSC, 2M Pixel, Day & Night, SD)

HEB2MPP1 2.2.96 H.264 BOX (PAL, 2M Pixel, Day & Night, SD)

- 15 -


HEV2MPN1 2.2.96H.264 DOME (NTSC, 2M Pixel, Day & Night, SD)

HEV2MPP1 2.2.96H.264 DOME (PAL, 2M Pixel, Day & Night, SD)

HEB1MPN 2.2.96 H.264 BOX (NTSC, 1M Pixel)HEB1MPP 2.2.96 H.264 BOX (PAL, 1M Pixel)HEV1MPN 2.2.96 H.264 DOME (NTSC, 1M Pixel)HEV1MPP 2.2.96 H.264 DOME (PAL, 1M Pixel)

HEB1MPN1 2.2.96H.264 BOX (NTSC, 1M Pixel, Day & Night, SD)

HEB1MPP1 2.2.96H.264 BOX (PAL, 1M Pixel, Day & Night, SD)

HEV1MPN1 2.2.96H.264 DOME (NTSC, 1M Pixel, Day & Night, SD)

HEV1MPP1 2.2.96H.264 DOME (PAL, 1M Pixel, Day & Night, SD)

HEB2MPN2 2.2.96H.264 BOX (NTSC, 2M Pixel, RS-485)

HEB2MPP2 2.2.96 H.264 BOX (PAL, 2M Pixel, RS-485)

HEB1MPN2 2.2.96H.264 BOX (NTSC, 1M Pixel, RS-485)

HEB1MPP2 2.2.96 H.264 BOX (PAL, 1M Pixel, RS-485)HDB-

M120(NEAB5)2.2.96

H.264 Full HD BOX (NTSC, Day & Night, SD, BLC)

HDB-M120(PEAB5)

2.2.96H.264 Full HD BOX (PAL, Day & Night, SD, BLC)

HDG-M120(NERS7)

2.2.96H.264 Full HD DOME (NTSC, Day & Night, microSD, BLC)

HDG-M120(PFRS7)

2.2.96H.264 Full HD DOME (PAL, Day & Night, microSD, BLC)

HDZ-A411 2.2.96 H.264 Full HD BoxHDA-A411F 2.2.96 H.264 Full HD AIOHDS-A411 2.2.96 H.264 Full HD FastraxHDZ-P622 2.2.96 H264 Full HD BoxHDA-S422F 2.2.96 H.264 Full HD AIO

- 16 -


HDG-M220F 2.2.96 H.264 Full HD Dome

HPCB-C1AAH3S 1.0.2H.264 VGA BOX(NTSC, Record, audio)

Model_C

HPCB-D1AAH3S 1.0.2H.264 VGA BOX(PAL, Record, audio))

HPCG-C1AAW4AN1H0S

1.0.2H.264 VGA Plastic DOME(NTSC, Record, No audio)

HPCG-D1AAW4AN1H0S

1.0.2H.264 VGA Plastic DOME(PAL, Record, No audio)

HDB-T320 1.0.0H.264 Full HD Box (1080P, RS-485, Record, Day & Night, audio)

HNG-D312S 2.0.0H.264 D1 Plastic DOME (Record, No audio)

HNS-S113J 2.0.0 H.264 D1 Fastrax (VA)HNF-D241R 2.0.0 H.264 D1 Prison (Record, audio)

HDB-T320 1.6.0H.264 Full HD Box (1080P, RS-485, Record, Day & Night, audio)

HDG-T320 1.6.0H.264 Full HD DOME (1080P, Record, Day & Night, audio)

HDB-T300 1.6.0H.264 Megapixel Box (720P, RS-485, Record, Day & Night, audio)

HDG-T300 1.6.0H.264 Megapixel DOME (720P, Record, Day & Night, audio)

HDG-T302 1.6.0 H.264 1M Plastic DOME (Record)HDG-T312 1.6.0 H.264 1.3M Plastic DOME (Record)

HDG-T322 1.6.0H.264 Full HD Plastic DOME (Record)

1-3. Terminology

This document uses the following terms:○ PHP Personal Home Page - a scripting language originally designed for producing dynamic web pages. The built-in web server uses 4.3.7 version (or higher).○ CGI Common Gateway Interface – a standard protocol for interfacing external application software with an information server, web server.

- 17 -


○ URL Uniform Resource Locator – a type of Uniform Resource Identifier that specifies where an identified resource is available and the mechanism for retrieving it. RFC1738 describes the syntax and semantics for a URL.○ CH/ch Channel – physical input video/audio channel○ Stream/stream/strm Stream – encoded video/audio stream. One video channel can be encoded to multiple streams, MPEG-4, H.264, MJPEG.○ MUST This word or the adjective “REQUIRED” means that the item is an absolute requirement of this specification.○ MUST NOT This phrase means that the item is an absolute prohibition of this specification.○ SHOULD This word or the adjective “RECOMMENDED” means that there may exist valid reasons in particular circumstances to ignore this item, but the full implications should be understood and the case carefully weighed before choosing a different course.○ SHOULD NOT This phrase means that there may exist valid reasons in particular circumstances when the listed behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.○ MAY This word or the adjective “OPTIONAL” means that this item is truly optional. ○ N/A Not Available, Not Applicable○ 720p/576p/480p 1280x720/720x576/720x480 progressive scan/encoding○ GOV(gov) Group of Video Object Plane Each video object is sampled in time, each time sample of a video object is a video object plane. Video object planes can be grouped together to form a group of video object planes. In this document, it means how many I frames are appeared in a second.○ RO(ro) Read Only○ RW(rw) Read and Write

- 18 -


2. Syntax and Resources

2-1. General syntax

In URL syntax and descriptions, italics within angle brackets denote content that should be replaced with either a value or a string. For example, <server_address> MUST be replaced by the string server IP address or host name.The arguments are MUST be written in lower-case. All parameters and values are case sensitive. All the requests including internal camera parameters MUST be written exactly as named in the camera or video encoder. The requests are consist of function-related directories, PHP URI and arguments (parameters and values).

The basic parameter for operation is ‘app’.Expression Value Description

app=<value>get, set

Get the value of each parameter.Set the parameter with value

Syntax:http://<server_address>/

<function_directory>/<PHP_URI>.<ext>?[<parameter>=<value>[&<parameter>=<value>]…]

Example: Request of getting the network parametershttp://ipcam/system/network.php?app=get

Return:res=<code>[[&<parameter>=<value>][&<parameter>=<value>]…]

Example: Response of getting the network parametersres=200&net_dhcp=0&net_ip=192.168.90.211&net_mask=255.255.0.0&net_gateway=192.168.90.1&dns_dhcp=0&dns_domain=&net_dns=0.0.0.0&net_dns2=0.0.0.0&net_hostname=&http_port=80&https_port=443&rtsp_port=554&net_limit=4096

Note; Response example is just example. The returned data will differ depending on

- 19 -


product model and configuration.2-2. Resources

Resources are different according to the product model and version. The resources require operator or admin rights. Especially the system resources can be accessed by the users who have admin right.

[Table 1] Model_A ResourcesResource PHP Description

liveview source.php Select video input mode (HEV0118H)

video

image.php Image appearancevideo.php Video setting, Image settingmasking.php Privacy Maskingwebcasting.php Webcasting

audio audio.php Audio setting, Audio input, Audio output

event

onboot.php Event In - On boot settingalarm_in.php Event In - Alarm In settingtrigger.php Event In - Manual triggermotion.php Event In - Motionloss.php Event In – Video Lossnetloss.php Event In – Network Losssmtp.php Event Out – SMTP(E-Mail)ftp.php Event Out - FTP and JPEGhttp_server.php Event Out - HTTP serveralarm_out.php Event Out – Alarm outaudio_alert.php Event Out – Audio alertaudio_upload.php Event Out – Upload audio alert fileptz_preset.php Event Out – PTZ presetmap.php Event Map Listevent_pop.php Add/Modify Event Map

deviceptz.php PTZ 1 settingrs485.php Device – RS485

system user.php Security – Usershttps.php Security – HTTPScrtupload.php Security – Private Certificate Upload

- 20 -


filtering.php Security – IP Filteringtime.php Date and Timenetwork.php Network – Basicddns.php Network – DDNSrtp.php Network – RTPupnp.php Network – UPnPqos.php Network – QoSnat.php Network - NATrestart.php Restart the device

reset.phpReset all parameters, except the IP parameters

default.php Reset all parameters to the factory settingsupdate.php Upgrade the device with the new firmwarerestore.php Restore current configuration to backup fileinformation.php Device Name and Location Informationbonjour.php Network – Bonjourzeroconf.php Network – Zero Configuration

[Table 2] Model_B ResourcesResource PHP Description

liveview source.php Default Live View, Default TV Outvideo image.php Image – Basic Appearance

ae_awb.php Image – AE and AWBvideo.php Stream 1, 2, 3, 4 settingroictrl.php ROI (Region Of Interest) settingday_night.php Image – Day & Nightblc_wdr.php Image – Back Light Control settingmasking.php Image – Privacy Masking settingwebcasting.php Webcasting

audio audio.php Audio setting, Audio Input, Audio Outputevent alarm_in.php Event In – Alarm In

trigger.php Event In – Manual Triggermotion.php Event In – VMD Stream1,3,4smtp.php Event Out – SMTP (E-Mail)

- 21 -


ftp.php Event Out – FTP and JPEGhttp_server.php Event Out – HTTP Serveraudio_alert.php Event Out – Audio Alertaudio_upload.php Event Out – Upload Audio Alert Fileptz_preset.php Event Out – PTZ Presetmap.php Event Map Listevent_pop.php Add/Modify Event Maprecord.php Event Out – Recordformat.php Event Out – Device Formatremove.php Event Out – Device Remove

device ptz.php PTZ settingrs485.php Device – RS485

system

user.php Security – Usershttps.php Security – HTTPSfiltering.php Security – IP Filteringtime.php Date and Timenetwork.php Network – Basicddns.php Network – DDNSrtp.php Network – RTPupnp.php Network – UpnPqos.php Network – QoSlanguage.php Languagerestart.php Restart the network camerareset.php Reset all parameters, except the IP

parametersdefault.php Reset all parameters to the factory settingsupdate.php Upgrade the device with the new firmwarerestore.cgi Restore current configuration to backup file

[Table 3] Model_C ResourcesResource PHP Description

liveview source.php Select video input modevideo image.php Image appearance

video.php Video setting, Image settingmasking.php Privacy Masking

- 22 -


ae_awb.php Exposure & White Balance controlwebcasting.php Webcastingday_night.php Day & Night controlir_control.php Infrared light controlae.php Fastrax AE controlauto_focus.php Focus controlcamera_setup.php Fastrax camera setupdis Fastrax DIS controlwhite_balance.php Fastrax white balance control

audio audio.php Audio setting, Audio input, Audio outputevent onboot.php Event In - On boot setting

alarm_in.php Event In - Alarm In settingtrigger.php Event In - Manual triggermotion.php Event In - Motionloss.php Event In – Video Lossnetloss.php Event In – Network Losssmtp.php Event Out – SMTP(E-Mail)ftp.php Event Out - FTP and JPEGhttp_server.php Event Out - HTTP serveralarm_out.php Event Out – Alarm outaudio_alert.php Event Out – Audio alertaudio_upload.php Event Out – Upload audio alert fileptz_preset.php Event Out – PTZ presetmap.php Event Map Listevent_pop.php Add/Modify Event Maprecord.php Event Out – Recordformat.php Event Out – Device Formatremove.php Event Out – Device Removeanalytic.php Event In - fastrax Analyticaudio_detection.php

Event In - audio detection

light.php Event Out - lightpir.php Event In - pirevent_push.php Event Out - Event push

device ptz.php PTZ 1 setting

- 23 -


rs485.php Device – RS485led_control.php LED Control

system

user.php Security – Usershttps.php Security – HTTPScrtupload.php Security – Private Certificate Uploadfiltering.php Security – IP Filteringtime.php Date and Timenetwork.php Network – Basicddns.php Network – DDNSrtp.php Network – RTPupnp.php Network – UPnPqos.php Network – QoSnat.php Network - NATrestart.php Restart the device

reset.phpReset all parameters, except the IP parameters

default.php Reset all parameters to the factory settingsupdate.php Upgrade the device with the new firmwarerestore.php Restore current configuration to backup fileinformation.php Device Name and Location Informationbonjour.php Network – Bonjourzeroconf.php Network – Zero Configurationhole_punching.php

Network - Hole Punching

live_push Network - Live Pushwireless.php Network - Wirelesswireless_setup.php

Network - Wireless AP Setup

2-3. Return Value

If the request has succeeded, it returns ‘200 OK’. Otherwise, it returns specific error code, for example 400 (RFC 2616).

- 24 -


The information returned with the response is dependent on the model, method and resource used in the request. The return value MAY be simple return code or compound parameters and values.

The 4xx class of status code is intended for cases in which the client seems to have erred.

The request could not be understood by the server due to malformed syntax or unavailable resource. It returns ‘400 Bad Request’.

Some of resources require user authentication. In the case which the request could not be accessed by the user authentication level, it MAY return one of these. ‘401 Unauthorized’, ‘403 Forbidden’, ‘404 Not Found’ and ‘405 Method Not Allowed’.

Returned parameters are delimited by special character ‘&’ (26h). They MAY have list of values. Some of list are delimited by special character ‘|’ (7Ch) or ‘\n’ (ah).

- 25 -


3. Resources and Requests

3-1. Video & Image

The Video & Image is to configure custom video stream settings.

3-1-1. Video

The camera and video server have multiple video streams with selectable settings for codec, Profile, Resolution, Bit rate control, Compression, and Framerate.

Although each stream can be programmed independently, the settings of one stream can limit the options available for the other stream depending on the processing power used.

Syntax:http://<ipcam >/video/video.php? <app>=(get|set)[&[[<ch>=channel number]|<strm>=stream number]

Example: Request of getting video parameters and values (Model_A)http://<videoserver>/video/video.php?app=get&ch=1

NOTEH.264 is the new generation compression standard for digital video, also known as MPEG-4 Part 10. This function offers higher video resolution than Motion JPEG or MPEG-4 at the same bit rate and bandwidth, or the same quality video at a lower bit rate. MJPEG (Motion Joint Photographic Experts Group) is a simple compression technique for networked video. Latency is low and image quality is guaranteed, regardless of movement or complexity of the image. Image quality is controlled by adjusting the compression level, which in turn provides control over the file size, and thereby the bit rate.

- 26 -


Example: Response of getting video parameters (Model_A)res=200&input_mode=704x480&video_mode=NTSC&total_ch=1&total_strm=2&ch1_strm1_codec=H264MP&ch1_strm1_res=4CIF&ch1_strm1_fps=30&ch1_strm1_bitrate=4000&ch1_strm1_ratecontrol=vbr&ch1_strm1_gov=30&ch1_strm2_codec=MJPEG&ch1_strm2_res=4CIF&ch1_strm2_fps=30&ch1_strm2_quality=99&

Example: Request of getting video parameters and values (Model_B)http://<ipcam>/video/video.php?app=get&strm=1

Example: Response of getting video parameters (Model_B)res=200&input_mode=1600x1200&total_ch=1&total_strm=4&ch1_strm1_codec=H264HP&ch1_strm1_res=1280x720&ch1_strm1_bitrate=4000&ch1_strm1_ratecontrol=vbr&ch1_strm1_fps=30&ch1_strm1_quality=35&ch1_strm1_gov=60&ch1_strm1_gov_struct=1&ch1_strm1_maxfps=30&ch1_strm1_maxbr=6000&ch1_strm1_1080p=0&ch1_strm1_uxga=1&ch1_strm1_sxga=1&ch1_strm1_xgaplus=1&ch1_strm1_960p=0&ch1_strm1_720p=1&ch1_strm1_576p=1&ch1_strm1_480p=1&ch1_strm1_vga=1&ch1_strm1_cif288=1&ch1_strm1_cif240=1&ch1_strm1_qvga=1

Example: Request of getting video parameters and values (Model_C)http://<ipcam>/ video/video.php?app=get&ch=1

Example: Response of getting video parameters (Model_C)res=200&input_mode=1920x1080&video_mode=NTSC&total_ch=1&total_strm=3&ch1_strm1_enable=1&ch1_strm1_codec=MPEG4SP&ch1_strm1_res=1080P&ch1_strm1_fps=25&ch1_strm1_maxfps=30&ch1_strm1_bitrate=4000&ch1_strm1_maxbr=8000&ch1_strm1_ratecontrol=cbr&ch1_strm1_gov=30&ch1_strm2_enable=1&ch1_strm2_codec=MJPEG&ch1_strm2_res=VGA&ch1_strm2_fps=30&ch1_strm2_maxfps=30&ch1_strm2_quality=50&ch1_strm3_enable=1&ch1_strm3_codec=MPEG4SP&ch1_strm3_res=stream1&ch1_strm3_fps=25&ch1_strm3_maxfps=30&ch1_strm3_bitrate=4000&ch1_strm3_maxbr=8000&ch1_strm3_ratecontrol=cbr&ch1_strm3_gov=30&

Example: Request of setting video parameters and valueshttp://<ipcam>/video/video.php?app=set&ch=1&ch1_strm1_res=VGA&ch1_strm1_fps=25&ch1_strm1_bitrate=2000

- 27 -


Example: Response of setting video parametersres=200

[Table 4] Parameters of video.php

Name TypeLengt

hDescription Value

input_mode string 10

Resolution of the input channel

(Width)x(Height)704x480, 704x576,1600x12001920x1080

video_mode string 10Video mode only for video server (Model_A)

NTSC, PAL

total_chintege

rTotal number of input channels

Default=1

total_strmintege

rTotal number of encoding streams

ch#_strm#_codec string 10

Encoding video codec and profile of the specified channel and stream#: channel/stream number

*MPEG4SP,MPEG4ASP,H264BP,H264MP,H264HP,MJPEG

ch#_strm#_res string 10

Encoding resolution name or specified width and height (width)x(height)

*[Table 5]*[Table 6]

ch#_strm#_fpsintege

r

Encoding framerate of the specified channel and stream

1 ~ 30

ch#_strm#_bitrate integer

Encoding bitrate of the specified channel and

[Model_A]100 ~ 4000

- 28 -


stream (kbps) [Model_B]100 ~ 6000[Model_C]100 ~ 8000

ch#_strm#_ratecontrol

string 3Encoding rate control mode

CBR, VBR

ch#_strm#_govintege

rGroup of video object 1 ~ 60

ch#_strm#_gov_struct

integer

Structure of gov *[Table 8]

ch#_strm#_qualityintege

r

Quality of encoding [Model_A]1 ~ 100*[Model_B][Table 9][Model_C]1 ~ 100

ch#_strm#_en boolEnable/Disable the specified channel and stream

Enable: 1 (default)Disable: 0

ch#_strm#_t_enable boolEnable/Disable text overlay of the specified channel and stream

Enable: 1(default)Disable: 0

ch#_strm#_t_content

stringString for displaying overlay of the specified channel and stream

ch#_strm#_t_location

integer

Displaying position of the overlay string

TOP: 0(default)BOTTOM: 1

ch#_strm#_t_timer boolEnable/Disable the timer to display the overlaying text.

Enable: 1Disable: 0(default)

ch#_strm#_maxfpsintege

r

Available maximum framerate for the specified channel and stream

1 ~ 30

- 29 -


ch#_strm#_maxbrintege

r

Available maximum bitrate for the specified channel and stream (kbps)

Kbps

ch#_strm#_1080p bool

1080p available resolution for the specified channel and stream

*[Table 6]Available: 1Unavailable: 0

ch#_strm#_960p bool


ch#_strm#_uxga bool

UXGA available resolution for the specified channel and stream

ch#_strm#_ sxga bool

SXGA available resolution for the specified channel and stream

ch#_strm#_xgaplus bool

XGAPLUS available resolution for the specified channel and stream

ch#_strm#_720p bool


ch#_strm#_576p bool


ch#_strm#_480p bool 480p available resolution for the specified channel and

- 30 -


stream

ch#_strm#_vga boolVGA available resolution for the specified channel and stream

ch#_strm#_cif288 bool

CIF288 available resolution for the specified channel and stream

ch#_strm#_cif240 bool

CIF240 available resolution for the specified channel and stream

ch#_strm#_qvga bool

QVGA available resolution for the specified channel and stream

* Encoding video codec/ resolution/ bitrate depends on the model. The Model_A supports MPEG4, MPEG4ASP, H264BP, H264MP (video codec) and MJPEG (image codec). The Model_B supports H264BP, H264MP, H264HP (video codec) and MJPEG (image codec). The Model_A supports one of video stream and one image stream simultaneously. The Model_B supports triple video streams and one image stream.* The bitrate value MAY not be changed because it is associated with value of rate control. For example, in the case of Model_B, if the rate control mode is VBR, the value of the bitrate has no meaning. The bitrate would be controlled by the quality value. In the case of Model_A, if the rate control mode is VBR, the value of the bitrate means the targeting bitrate, and the device would encode the video for the best quality. So in the case of VBR mode, the encoded bitrate MAY not be predictable.* The quality of stream is different among the device models. The Model_B has representative values for encoding quality, very high (30), high (32), middle (35), low (40) and very low (45). And the stream 2, MJPEG, is available as very high (90), high (80), middle (68), low (40) and very low (20). The Model_A has no quality value for video stream. In the case of Model_A, the quality value is valid only for MJPEG stream. And the higher value means higher quality and bigger bitrate.

- 31 -


[Table 5] Model_A Resolution

FormatResolution in

NTSCResolution in

PAL4CIF 704x480 704x5762CIF 704x240 704x288CIF 352x240 352x288

QCIF 176x120 176x144VGA 640x480

QVGA 320x240QQVGA 160x120

[Table 6] Model_B ResolutionFormat Resolution Remark1080P 1920x1080 *SXGA 1280x1024 *XGA+ 1152x864 *960P 1280x960 *720P 1280x720576P 720x576480P 720x480VGA 640x480

QVGA 320x240Some resolutions (*) are available only for the specific devices.

[Table 7] Model_C ResolutionFormat Resolution Remark1080P 1920x1080 *SXGA 1280x1024 *720P 1280x720 *576P 720x576 *480P 720x480 *VGA 640x480CIFP 352x288CIFN 352x240

- 32 -


QVGA 320x240stream1 defend on Stream 1 Stream 3 onlystream2 defend on Stream 2 Stream 3 only

Some resolutions (*) are available only for the specific devices. (HDG-T3xx series)

[Table 8] Structure of GOV (Example, GOV size = 5, Framerate =10 fps)Structure

Frame sequence in a second

IP I P P P P I P P P PIBP I P B P B I P B P BIBBP I P B B P I P B B PIBBBP I P B B B I P B B B

[Table 9] Video Stream Quality Value Range in Model_B

QualityMJPEG H.264

Value Range

Representative

Value Range Representative

Very High 81~90 90 1~30 30High 71~80 80 31~32 32

Middle 51~70 68 32~35 35Low 31~50 40 36~40 40

Very Low 1~30 20 41~50 45

(1) Resolution of Video Input Channel (input_mode): roThis represents resolution of the video input channel, width and height. This value is read only. The Model_B returns 1600x1200 or 1920x1080. The Model_A returns 704x480 (NTSC) or 704x576 (PAL). And The Model_C returns 1920x1080 or 640x480.

(2) Number of Video Channels (total_ch): roThis is total count of video input channels. The default value is 1.

(3) Number of Video Streams (total_strm): roThis is total count of video encoding streams. The Model_B supports 3 video streams and 1 image stream. So the value of this is normally 4. The Model_A supports 1

- 33 -


video stream and 1 image stream. So the value of this is 2.

(4) Codec & Profile (ch#_strm#_codec) : rwThe codec and profile are dependant on the product. The Model_A supports MPEG-4 SP (simple profile), MPEG-4 ASP (advanced simple profile), H.264 BP (baseline profile) and H.264 MP (main profile). The Model_B supports H.264 BP, MP and HP (high profile). This is the codec and profile property of the specified stream.

(5) Resolution (ch#_strm#_res) : rwThe Resolution is the number of columns (width) and rows (height) of pixels of the specified stream. The Model_B uses resolution value itself, 1600x1200 or 1920x1080. It supports encoding from The Model_A and Model_C use standard name for resolutions, 4CIF, CIF, etc. It supports encoding from QVGA to D1 resolution and

(6) Bitrate Control (ch#_strm#_ratecontrol): rwThis is the value of bitrate control modes of specified stream, VBR or CBR.

NOTEH.264 High Profile: The High-profile is the primary profile for broadcast and disc storage applications, particularly for HDTV (High-Definition television) or Blu-ray Disc applications.H.264 Main Profile: The Main-profile is originally intended as the mainstream consumer profile for broadcast and storage applications. Additional tools over baseline profile include: B slice type.H.264 Baseline Profile: The Baseline-profile is primarily for low-cost applications that requires additional error robustness such as video conferencing, video over-IP and mobile applications. Tools used by baseline profile include: I and P slice types.

- 34 -


(7) Bitrate (ch#_strm#_bitrate): rwThe Bitrate indicates the quality of the video stream (rendered in kbps-kilobits per second). The higher value means the higher video quality and bandwidth required.

(8) Quality (ch#_strm#_quality): rwThis is supported in video streaming by the Model_B device. The quality is automatically adjusted the compression rate to guarantee the image quality at only VBR mode. The default setting is Middle.In the Model_A device, this is valid for image streaming. Thus, this is always used ch1_strm2_quality=xx in the request to Model_A.

(9) Framerate (ch#_strm#_fps): rwThe Framerate indicates the number of fps (frame per second) available for the video stream configuration. The Framerate can be adjusted in the range (1-30). The default setting is 30.

(10) GOP Structure (ch#_strm#_gov_struct): rwThe GOP structure variable is valid only with Model_B. The GOP structure describes the composition of the video stream. This GOP (Group of Picture) setting configures the number of partial frames that occur between full frames in the video stream. For example, in a scene where a door opens and a person walks through, only the movements of the door and the person are stored by the video encoder. The stationary background that occurs in the previous partial frames is not encoded because no changes occurred in that part of the scene; the stationary background is only encoded in the full frames. Partial frames improve video compression rates by

NOTEVBR: The VBR is automatically adjusts the bit rate according to the image complexity, using up bandwidth for increased activity in the image, and less for lower activity in the monitored area.CBR: The CBR is a fixed target bit rate that consumes a predictable amount of bandwidth. As the bit rate would usually need to increase for increased image activity, but in this case can not, the frame rate and image quality are affected negatively.

- 35 -


reducing the size of the video. As the GOP increases, the number of partial frames increases between full frames. This setting is only available with H.264 and MPEG-4 compression standards. The default setting is IP.

(11) GOP size (ch#_strm#_gov): rwThe higher value saves considerably on bandwidth but may have an adverse effect on image quality. Higher values are only recommended on networks with high reliability. The GOP size can be adjusted in the range 1-60. The default setting is 30.

(12) Enable Stream (ch#_strm#_en): rwWith Model_B, the streams are able to be enabled or disabled the stream, but not the first stream. This parameter is not available for the first stream.

(13) Enable Text Overlay (ch#_strm#_t_enable): rwWith Model_B, the streams support to display text overlay but not the first stream. This is to enable or disable text displaying.

(14) Text to display (ch#_strm#_t_content): rwWith Model_B, the streams support to display text displaying on the image and video but not the first stream. This parameter is for getting and setting the text to

NOTEI-Frame: I-frame is an abbreviation for Intra-frame, so-called because they can be decoded independently of any other frames. They may also be known as I-pictures, or keyframes due to their somewhat similar function to the key frames used in animation. I-frames can be considered effectively identical to baseline JPEG imagesP-Frame: P-frame is an abbreviation for Predicted-frame. They may also be called forward-predicted frames, or inter-frames (B-frames are also inter-frames).B-frames: B-frame stands for bidirectional-frame. They may also be known as backwards-predicted frames or B-pictures. B-frames are quite similar to P-frames, except they can make predictions using both the previous and future frames (i.e. two anchor frames).

- 36 -


display.

(15) Enable Displaying Text Timer (ch#_strm#_t_timer): rwWith Model_B, the streams support to display text displaying on the image and video but not the first stream. This is to show the text for a while, and after the specified time, the text is disappeared. If the timer is turned off, the text is displayed all the time.

(16) Resource Limitation Information (ch#_strm#_maxfps, ch#_strm#_1080p, ch#_strm#_uxga, ch#_strm#_xgaplus, ch#_strm#_720p, ch#_strm#_576p, ch#_strm#_480p, ch#_strm#_vga, ch#_strm#_qvga): roThese parameters show which resolution is available for the specified channel and stream and how many frames is able to be encoded. These are calculated by the device.

(17) Maximum bitrate (ch#_strm#_maxbr): roThis is the maximum bitrate for the specified stream. (kbps: kbit/sec)

3-1-2. ROI (Region Of Interest)

The Model_B device supports multiple streams. The first stream is original stream which is captured from the lens. And the others (2nd, 3rd and 4th) are able to be encoded partial area of the original stream. The areas of the sub-stream could be selected. Those areas are called ROI (Region of Interest). The /video/roictrl.php is for this. The syntax of ROI MUST specify the stream number.

Syntax: Request of getting/setting the ROI information of the streamhttp://<server_address>/video/roictrl.php?app=[get|set]&strm=<stream number>[[&<roi_parameter>=<value>]…]

Example: Request of getting the ROI information of the second streamhttp://<ipcam>/video/roictrl.php? app=get&strm=2

Example: Response of getting the ROI information of the second streamres=200&strm=2&roi_x=480&roi_y=240&roi_width=320&roi_height=240&roi_zoom

- 37 -


_enable=0&roi_zoom=12&roi_preseten=1

[Table 10] Parameters of roictrl.php

Name TypeLengt

hDescription Value

strm integer ROI Stream number 2, 3, 4

roi_x integerCoordinates X of left top of the region

roi_y integerCoordinates Y of left top of the region

roi_width integer Width of the regionroi_height integer Height of the region

roi_zoom_enable boolEnable/Disable the ROI zoom

Enable: 1Disable: 0

roi_zoom integer Zoom Level 0 ~ 16roi_move string ROI move command *[Table 11]

roi_preseten boolEnable/Disable Status of the ROI preset function availability

Enable: 1Disable: 0

roi_preset integerMove ROI preset position of given id

1 ~ 5

roi_presetsave integerSave current ROI position as given id

1 ~ 5

(1) ROI stream number (strm): rwThis is the ROI stream number. The [Model_B] supports 3 ROI streams and the ROI stream number starts from 2.

(2) Coordinates x of ROI (roi_x): rwThis represents coordinates X of the left top position of region.

(3) Coordinates y of ROI (roi_y); rwThis represents coordinates X of the left top position of region.

(4) Width of ROI (roi_width): rw

- 38 -


This is width of the region.

(5) Height of ROI (roi_height): rwThis is height of the region

(6) Enable/Disable the ROI zoom (roi_zoom_enable): rwThis is to enable/disable the ROI zoom function.

(7) Zoom Level of ROI (roi_zoom): rwThis is zooming level of the region.

(8) Move ROI (roi_move): wThis is to move ROI position.

(9) Enable/Disable Status of the ROI Preset Function Availability (roi_preseten): roThis is to represent the status of the ROI preset function availability. It would be enabled in the case of bigger resolution than 320x240 of the first stream. In other words, if the resolution of the first stream is 320x240, then this would be disabled.

(10) Move ROI preset position (roi_preset): wThis is to move ROI saved preset position. The [Model_B] supports 5 preset positions which are able to be defined by user.

(11) Save current ROI position (roi_presetsave): wThis is to save current ROI position to given number.

[Table 11] ROI Move Commands and Descriptions (roi_move)Command Description Command Description

up Move up upright Move 45 degree

NOTESome of the ROI functions MAY cause to overload the system performance. Zoom/Preset Movement of the ROI MAY make system to slow down.

- 39 -


down Move down upleft Move 115 degreeright Move right downleft Move 225 degreeleft Move left downright Move 315 degreetele Zoom in telemax Maximum zoom inwide Zoom out widemax Maximum zoom

out

3-1-3. Image

This is for adjusting of the image appearance, brightness, gamma, contrast, saturation, and sharpness. Some products have facilities of flipping and rotating image. They are dependant on the products. These belong to the image.php resource.

Example: Request of getting image appearance parameters and values (Model_A/C)http://<videoserver>/video/image.php?app=get

Example: Response of getting image appearance parameters and values (Model_A/C)Res=200&def_brightness=6&def_contrast=5&def_saturation=5&def_sharpness=3&brightness=6&contrast=5&saturation=5&sharpness=3

Example: Request of getting image appearance parameters and values (Model_B)http://<ipcam>/video/image.php?app=get

Example: Response of getting image appearance parameters and values (Model_B)Res=200&brightness=6&gamma=6&contrast=0&saturation=8&sharpness=12&flip=0&mirror=0

[Table 12] Parameters of image.php

Name TypeLengt

hDescription Value

brightness integer Brightness *[Table 13]gamma integer Gammacontrast integer Contrast

- 40 -


saturation integer Saturationsharpness integer Sharpnesshue integer Hue

flip boolEnable/Disable flipping *Disable: 0

(default)Enable: 1

mirror boolEnable/Disable mirroring *Disable: 0

(default)Enable : 1

*stabilizer boolEnable/Disable Stabilizer

*Disable: 0(default)Enable: 1

*deffect integer

Select Digital Effect 0: Off (default)1: Mirror2: Flip3: Rotate

*color boolEnable/Disable Black & White mode


*dzoompip boolShow/Hide Digital Zoom PIP controls


*usertitle boolEnable/Disable User Title Displaying


*usertitlestr string 20 User Title

*usertitleposx integerHorizontal position of User Title

0 ~ 28 (default 0)

*usertitleposy integerVertical position of User Title

0 ~ 11 (default 1)

nr boolEnable/Disable Noise Reduction

Disable: 0(default)Enable: 1

Some parameters (*) are available only for the specific devices in Model_B. (HDB-M120, HDG-M120 series).

- 41 -


[Table 13] Range of Image Appearance Values

Parameter \ Model

[Model_B] [Model_A] [Model_C]range default range default range Default

Brightness0,1, ~ 19,20

6

1, 2 ~ 9, 10

6

1, 2 ~ 9, 10

6*10

Contrast0,1, ~ 13,14

0 5 4

Saturation0,1, ~ 15,16

8 5 10

Sharpness0,1, ~ 19,20

12 3 3

*0,1, ~ 16,17

Gamma0,1, ~ 13,14

5 N/A N/A

Hue N/A N/A 1~10 1

(1) Brightness (brightness): rwThe higher value produces the brighter image.

(2) Gamma (gamma): rwThe Gamma is for adjustment details in the light and dark areas of the scene. The range of the Gamma is from 0.2 to 1.2. The lower value exposes more detail in the light area of the scene and the higher value exposes more detail in the dark area of the scene. The default value is 0.45. This is supported by Model_B device.

(3) Contrast (contrast): rwThe Contrast is to control the ratio of the luminance of the brightest color (white) to that of the darkest color (black). The higher value makes darker at dark color and brighter at bright color.

(4) Saturation (saturation): rwThe Saturation is to control how intense or vivid the colors are in a scene. The lower

- 42 -


value de-saturates a color.

(5) Sharpness (sharpness): rwThe Sharpness is to control the clarity of detail in a scene. The lower value makes more softening image. In the Model_C, the available value range is between 1 to 5.

(6) Hue (hue): rwThis is to control the color property in a scene. The lowest and highest values are for real color. And others makes complementary colored scene.

(7) Flip (flip): rwThe Enable flip image rotates the original image 180 degrees vertically. This is supported by Model_B device. Please refer image (B) in [Table 14]

(8) Mirror (mirror): rwThe Enable mirror image generates mirrored image by rotating the original image 180 degrees horizontally. This is supported by Model_B device. Please refer image (C) in [Table 14].

[Table 14] Flipping and Mirroring Images

NOTEHue is one of the main properties of a color.

value 0 6 10Hue INCLUDEPICTURE "http://upload.wikimedia.org/wikipedia/commons/thumb/a/ad/HueScale.svg/360px-HueScale.svg.png" \* MERGEFORMATINET

- 43 -

http://en.wikipedia.org/wiki/File:HueScale.svg

http://en.wikipedia.org/wiki/File:HueScale.svg


(A) Original image(B) After flipping image from (A)

(C) After mirroring image from (A)

(D) After flipping and mirroring (A)

(9) Enable/Disable Stabilizer (stabilizer): rwThis is to enable/disable the stabilizer (compensation of vertical shaking movement). This parameter is available only for the HDB-M120, HDG-M120 series.

(10) Select Digital Effect (defect): rwThis is to select the digital effect on the scene. If this is 1, the effected scene would be flipped (B in [Table 14]). If this is 2, it would be mirrored image (C in [Table 14]). And if this is 3, it would be rotated after mirrored image (D in [Table 14]). This parameter is available only for the HDB-M120, HDG-M120 series.

(11) Enable/Disable Black and White mode (color): rwIf this is 0, the scene would be displayed colored. Otherwise, it would be displayed in black and white mode. This parameter is available only for the HDB-M120, HDG-M120 series.

(12) Show/Hide Digital Zoom PIP Control (dzoompip): rwThis is to show the digital zoom pip control. If this is enabled, the digital zoom (zoom, pan, and tilt controls) controls would be displayed on the screen (OSD). And the OSD controls are used by PTZ move controls (move – enter, up, down, right, left, stop). This parameter is available only for the HDB-M120, HDG-M120 series. (Please refer the PTZ control)

(12) Enable/Disable Displaying User Title (usertitle): rwThis is to enable/disable displaying user title. This is available only for the HDB-M120.

- 44 -


(13) User Title (usertitle): rwThis is string to be displayed on the screen. The available characters are alpha-numeric and space, hyphen (-) and dot (.). (A ~ Z, a ~ z, 0 ~ 9, space, dot, hypen). The default is empty string.

(14) User Title Position x and y (usertitleposx, usertitlepos.y): rwThis is the coordinate value of the starting position of the user title string on the screen. The range of the usertitleposx is between 0 to 28 (default value is 0) and usetitleposy is between 0 to 11 (default value is 1). (If the usertitleposx is 28, the available string length to be displayed is about 4.) This parameter is available only for HDB-M120, HDG-M120 series.

(15) Noise Reduction (nr): rwThis is to enable/disable 2D noise reduction. This is available only for some Model_C.

3-1-4. AE & AWB

The AE & AWB is to control exposure and white balance of camera sensor. This feature is supported by Model_B and Model_C devices.Example: Request of getting ae & awb parameters and values (Model_B)http://<ipcam>/video/ae_awb.php?app=get

Example: Response of getting ae & awb parameters and values (Model_B)res=200&ae_mode=0&ae_sensitivity=10&ae_lowlight=0&ae_gain=5&ae_shutter_speed=5&ae_flickless_mode=0&awb_mode=0&awb_positon=64&awb_rgain=128&awb_ggain=118&awb_bgain=128

Example: Response of getting ae & awb parameters and values (Model_C)res=200&http_port=80&def_exposure_value=3&exposure_mode=0&exposure_value=3&auto_iris=1&flicker_mode=1&wb_mode=0

[Table 15] Parameters of ae_awb.php in MODE_B

Name TypeLengt

hDescription Value

ae_mode integer Exposure mode *[Table 16]

- 45 -


ae_sensitivity integerAE sensitivity 0 ~ 14

(Default=10)

ae_lowlight integer

AE low light mode 0: off for bright condition1: control frame rate for dark condition2: control gain for dark condition

ae_gain integerManual exposure global gain control

0~4: decrease5: current gain6~10: increase

ae_shutter_speed integerManual exposure shutter speed

*[Table 17]

ae_shutter_limit integer

AE shutter limit 0: 1/301: 1/1602: 1/2503: 1/5004: 1/7005: 1/10006: 1/16007: 1/25008: 1/50009: 1/700010: 1/10000

ae_flickless_mode integerAE flicker-free mode 1: 50Hz

2: 60Hz

awb_mode integer

Automatic White Balance mode

*0: AWB on1: Indoor2: Outdoor3: Manual4: ATW5: AWC_PUSH

awb_position integer AWB temperature 0 ~ 127

- 46 -


position

awb_rgain integerWhite balance manual R gain

*0 ~ 255/0 ~ 200

awb_ggain integerWhite balance manual G gain

0 ~ 255

awb_bgain integerWhite balance manual B gain

*0 ~ 255/0 ~ 200

[Table 16] Exposure Mode (ae_mode)Value Exposure Mode Remark

0 AE on without DC-IRIS1 AE on with DC-IRIS2 AE & DC-IRIS off3 Exposure manual gain control mode4 Exposure manual shutter speed mode

5Exposure manual gain control and shutter speed mode

0 ALC (Automatic Light Control) [Model_B]HDB-M120, HDG-M120 series

1 ELC (Electronic Light Control)

[Table 17] Manual Exposure Shutter Speed

ValueSpeed

(second)Value

Speed (second)

0 1/1000 1 1/5002 1/250 3 1/1004 1/60 5 1/506 1/30 7 1/258 1/15 9 1/510 1/2

[Table 18] Parameters of ae_awb.php in Model_CName Type Lengt Description Value

- 47 -


h

exposure_mode integerExposure mode 0: Automatic

1: Hold Current

exposure_value integerExposure Value 1 ~ 10

Default : 3

auto_iris integerEnable automatic IRIS adjustment

0: disable1: enable

flicker_mode integerFlicker mode 0: 50Hz

1: 60Hzwb_mode integer White Balance Control *[Table 19]

flicker_free integerFlicker Free Mode 0: disable

1: enable

blc_enable boolBack Light Compensation

0: disable1: enable

[Table 19] White Balance ControlValue White Balance Mode Description

0 Automatic Automatic Control Mode1 Fixed Indoor Fixed Indoor Mode (Illuminant A: 2854K)2 Fixed Fluorescent 1 Fixed Fluorescent 1 (TL84: 4100K)3 Fixed Fluorescent 2 Fixed Fluorescent 2 ( CWF_5000K: 4150K )4 Fixed Outdoor 1 Fixed Outdoor 1 ( D65: 6500K )5 Fixed Outdoor 2 Fixed Outdoor 2 ( CLOUD: 7500 ~ 8500K )6 Fixed Incandescent Fixed Incandescent7 Fixed Fluorescent Fixed Fluorescent8 Fixed Outdoor Fixed Outdoor

- 48 -


The Exposure is the amount of light detected by the camera sensor. A scene with correct exposure settings has adequate detail and contrast between white and dark values. An image with too little or too much exposure determines detail in the scene. The camera features automatic and manual exposure settings.

The White Balance Control defines how the camera processes video images to render true colors in a scene. White balance is especially effective in scenes with changing lighting conditions or in scene with more than one type of light source.

(1) Exposure Mode (ae_mode): rwThe Exposure mode is to control the amount of light detected by the camera sensor base on settings for light conditions. Manual exposure is recommended only for indoor applications that have a single unchanging primary light source. The default setting is automatic

Auto with DC-IRIS The Auto with DC-IRIS sets the amount of light detected by the camera sensor with DC-IRIS. This special type of iris is electrically controlled by the camera sensor, to automatically regulate the amount of light allowed to enter. Auto without DC-IRIS

NOTECIE standard illuminant A is intended to represent typical, domestic, tungsten-filament lighting. Its relative spectral power distribution is that of a Planckian radiator at a temperature of approximately 2856 K. CIE standard illuminant A should be used in all applications of colorimetry involving the use of incandescent lighting, unless there are specific reasons for using a different illuminantCIE Standard Illuminant D65 (sometimes written D65) is a commonly-used standard illuminant defined by the International Commission on Illumination (CIE). It is part of the D series of illuminants that try to portray standard illumination conditions at open-air in different parts of the world. D65 corresponds roughly to a mid-day sun in Western Europe / Northern Europe, hence it is also called a daylight illuminant.

- 49 -


The Auto with DC-IRIS sets the amount of light detected by the camera sensor without DC-IRIS. OffDisable the automatic exposure function with DC-IRIS. Manual GainIncrease the analog gain manually. Manual ShutterAdjust the electronic shutter manually. Manual Gain & ShutterSet the analog gain and electronic shutter simultaneously. ALC (Automatic Light Control)Use physical IRIS control device. (This is available only for HDB-M120, HDG-M120 series) ELC (Electronic Light Control)Set electrical IRIS control as average or peak scene luminance based on the brightness value. (This is available only for HDB-M120, HDG-M120 series)

(2) Exposure Sensitivity (ae_sensitivity): rwThe Exposure sensitivity indicates the sense degree for the amount of light. A higher value means more sensitive.

(3) Low Light (ae_lowlight): rwThe Low light provides the options for good image quality in the low light condition.

OffKeep maximum framerate. Frame controlIncrease the shutter width and decrease the framerate. Gain controlThe gain describes the amount of amplification applied to a signal, in this case the visual information in the image. Although it is possible to attain a high level of amplification, and thereby provide viewable images in very low light, high gain levels will also increase the amount of image noise. Increase the digital gain and decrease the noise keeping maximum framerate.

If the device supports Day & Night function, the default value of this is 2 (Gain control). Otherwise, this is 0 (Off).

- 50 -


(4) Exposure Gain (ae_gain): rwIncreasing Exposure gain increases the brightness of image, but it also increases the amount of noise in the image.

(5) Shutter Speed (ae_shutter_speed): rwSelect the electronic shutter speed. It's only available when Exposure mode is a Manual shutter mode. The range of shutter speed value is in [Table 17]. A slower speed in dark conditions will help to produce a brighter image, but will produce fewer frames per second, which may cause blurry images during motion. The default setting is 1/30 sec.

(6) Shutter Limit (ae_shutter_limit): rwSelect the electronic shutter limit. It’s only working when Exposure mode is ALC.The default setting is 1/1000 sec. This is only available for HDB-M120, HDG-M120.

(7) Exposure Flicker-free Mode (ae_flickless_mode): rwThe Exposure flicker-free mode provides the options for flicker less.

50HzSelect it at 50 Hz environments. 60HzSelect it at 60 Hz environments.

The default value of this depends on the SYSTEM specification (following the MODEL). If a device is for NTSC, the default value of this parameter would be 60Hz. Otherwise, it would be 50Hz.

(8) White Balance Mode (awb_mode): rwIt provides the options for White Balance. The default setting is automatic.

AutoAutomatically delivers the best possible image by adjusting the white balance based on the colors in the scene. IndoorSelect when the camera is installed at indoor. OutdoorSelect when the camera is installed at outdoor. Manual gain

- 51 -


Enter the manual gain setting mode. ATWAutomatic Tracing White (1500 ~ 11500K). This is available only for the HDB-M120, HDG-M120 series. AWC_PUSHExecute One Push White Balance. This is available only for the HDB-M120, HDG-

M120 series.

(9) White Balance Position (awb_position): rwThe White balance position is to control the white balance position into current color temperature.It is enabled when the White balance mode is not Auto.A higher value in the Indoor means the blue color increase and a higher value in the Outdoor means the red color increase. The White balance position can be adjusted in the range 0-127. The default setting is 64.

(10) White Balance R Gain (awb_rgain): rwThe White balance R gain adjusts the picture output in the red range (0-255). The higher value produces higher red image.

(11) White Balance G Gain (awb_ggain): rwThe White balance G gain adjusts the picture output in the green range (0-255). The higher value produces a higher green image. The HDB-M120, HDG-M120 series doesn’t support this parameter. (12) White Balance B Gain (awb_bgain): rwThe White balance B gain adjusts the picture output in the blue range (0-255). The

NOTEIn some installations, use manual gain white balance to render the most accurate image color possible. Manual white balance is recommended only for indoor applications that have a single unchanging primary source.

- 52 -


higher value produces a higher blue image.

(13) Back Light Compensation (blc_enable): rwThis is to enable/disable back light compensation. This is available only for some Model_C.

3-1-5. Privacy Masking

This is to configure privacy masking the video. The [Model_A] supports 8 masking areas. The HDB-M120, HDG-M120 series in the [Model_B] support 1 masking area. The masked areas would be shown as black or the specific colored.

Example: Request of getting privacy masking parameters and values (Model_A)http://<video_server>/video/masking.php?app=get&ch=1

Example: Response of getting privacy masking parameters and values (Model_A)res=200&http_port=80&https_port=443&masking_max_width=704&masking_max_height=480&masking_enable=1&masking_count=2&masking1_id=1&masking1_name=Mask_1&masking1_left=224&masking1_top=125&masking1_right=420&masking1_bottom=256&masking2_id=2&masking2_name=New&masking2_left=441&masking2_top=233&masking2_right=640&masking2_bottom=376&

Example: Request of getting privacy masking parameters and values (Model_B)http://<video_server>/video/masking.php?app=get&ch=1

Example: Response of getting privacy masking parameters and values (Model_B)res=200&privacy_mode=1&privacy_rcp=1&privacy_colorr=128&privacy_colorg=128&privacy_colorb=128&transparency=0

[Table 20] Parameters of masking.php in Model_A/C

Name TypeLengt

hDescription Value

method stringCreate, Modify and Delete Masking Area

create,modify,delete

- 53 -


ch integer Channel Number

masking_enable boolEnable/Disable Masking Enable: 1

Disable: 0

masking_count integerNumber of Masking Areas

masking_max_width integerMaximum Width of Masking Area

masking_max_height integerMaximum Height of Masking Area

masking#_id integerMasking ID of Masking Area Number

masking#_name stringMasking Area Name of Masking Area Number

masking#_left integerCoordinate Left Position of Masking Area Number

masking#_top integerCoordinate Top Position of Masking Area Number

masking#_right integerCoordinate Right Position of Masking Area Number

masking#_bottom integerCoordinate Bottom Position of Masking Area Number

masking_id integerMasking Area ID to Delete or Modify

masking_name stringMasking Area Name to Create

masking_left integerLeft Position of Masking Area to Create or Modify

masking_top integerTop Position of Masking Area to Create or Modify

masking_right integerRight Position of Masking Area to Create or Modify

masking_bottom integer Bottom Position of

- 54 -


Masking Area to Create or Modify

(1) Method (method): rwThis is the method to operate, create, modify or delete. To create masking area, the masking_name, left, top, right, and bottom values are required. To delete masking area the masking_id is required. To modify masking area, the masking_id, name, left, top, right, and bottom values are required.

(2) Channel Number (ch): rwThis is the channel number to set masking areas.

(3) Enable/Disable Masking (masking_enable): rwThis is to enable/disable masking for the specified channel.

(4) Number of Masking Areas (masking_count): roThis is the total number of masking areas in the channel. The maximum number of masking areas is 8.

(5) Maximum Width of Masking Area (masking_max_width): roThis is the maximum width of masking area to be set.

(6) Maximum Height of Masking Area (masking_max_height): roThis is the maximum height of masking area to be set.

(7) Masking ID of Masking Area Number (masking#_id): roThis is the masking id value of masking area number.

(8) Masking Name of Masking Area Number (masking#_name): roThis is the masking area name of masking area number.

(9) Left Position of Masking Area Number (masking#_left): roThis is the masking area left position value of masking area number.

(10) Top Position of Masking Area Number (masking#_top): ro

- 55 -


This is the masking area top position value of masking area number.

(11) Right Position of Masking Area Number (masking#_right): roThis is the masking area right position value of masking area number.

(12) Bottom Position of Masking Area Number (masking#_bottom): roThis is the masking area bottom position value of masking area number.

(13) Masking Area ID to Modify or Delete (masking_id): rwThis is the masking area id value to modify or delete.

(14) Masking Area Name to Modify or Create (masking_name): rwThis is the masking area name to modify or create.

(15) Masking Area Left to Modify or Create (masking_left): rwThis is the masking area left to modify or create.

(16) Masking Area Top to Modify or Create (masking_top): rwThis is the masking area top to modify or create.

(17) Masking Area Right to Modify or Create (masking_right): rwThis is the masking area right to modify or create.

(18) Masking Area Bottom to Modify or Create (masking_bottom): rwThis is the masking area bottom to modify or create.

Example: Request of creating privacy masking area (Model_A)http://<video_server>/video/masking.php?app=set&ch=1&method=create&masking_name=Mask_b&masking_left=50&masking_top=50&masking_right=180&masking_bottom=200

Example: Response of creating privacy masking area (Model_A)res=200&ch=1&method=create&masking_count=2&masking_id=2&masking_name=Mask_b&masking_left=50&masking_top=50&masking_right=180&masking_bottom=200

- 56 -


Example: Request of getting privacy masking parameters and values in HDB-M120, HDG-M120 series (Model_B)http://<ipcam>/video/masking.php?app=get

Example: Response of getting privacy masking parameters and values in HDB-M120, HDG-M120 series (Model_B)res=200&privacy_mode=1&privacy_rcp=1&privacy_colorr=128&privacy_colorg=128&privacy_colorb=128&transparency=0

[Table 21] Parameters of masking.php in the HDB-M120, HDG-M120 series in Model_B

Name TypeLengt

hDescription Value

privacy_mode boolShow/Hide Privacy Masking Area Controls

Hide: 0(default)Show: 1

privacy_rcp integer

Privacy Masking Area Shape

1: Rectangle(default)2: Circle3: Polygon

privacy_colorr integerPrivacy Masking Color Red value

0 ~ 255(default 128)

privacy_colorg integerPrivacy Masking Color Green value

0 ~ 255(default 128)

privacy_colorb integerPrivacy Masking Color Blue value

0 ~ 255(default 128)

transparency integerPrivacy Masking Transparency

0 ~ 16 (default 0)

(1) Show/Hide Privacy Masking Area Control (privacy_mode): rwThis is to show/hide privacy masking area control. If it is set, the privacy masking area controls would be displayed on the screen. The masking area is able to be set by PTZ controls (move – up, down, left, right, stop, enter). (Please refer the PTZ control)

- 57 -


(2) Privacy Masking Area Shape (privacy_rcp): rwThis is to set the privacy masking area shape. (1: Rectangle, 2: Circle, 3: Polygon) The default shape is rectangle.

(3) Privacy Masking Color Red/Green/Blue Value (privacy_colorr/ privacy_colorg/ privacy_colorb): rwThis is to set the privacy masking color properties.

(4) Privacy Masking Transparency (transparency): rwThis is to set the privacy masking transparency property. The lower values represent higher opacity.

Example: Request of creating privacy masking area in HDB-M120, HDG-M120 series (Model_B)http://<ipcam>/video/masking.php?app=set&privacy_mode=1&privacy_rcp=1&privacy_colorr=128&privacy_colorg=128&privacy_colorb=128&transparency=1

Example: Response of creating privacy masking area in HDB-M120, HDG-M120 series (Model_B)res=200&privacy_mode=1&privacy_rcp=1&privacy_colorr=128&privacy_colorg=128&privacy_colorb=128&transparency=1

3-1-6. Day & Night

This is to configure Day & Night control for some models with this function (refer to the 1-2. Applicable Device Models). The parameters are different among the devices.

Example: Request of getting day and night control parameters and values (Model_B)http://<ipcam>/video/day_night.php?app=get

Example: Response of getting day and night control parameters and values (MODE_B)

- 58 -


res=200&dnn_mode=0&dnn_manual_mode=2&dnn_delaytime_mode=0&dnn_switchbw=0

Example: Request of getting day and night control parameters and values (Model_C)http://<ipcam>/video/day_night.php?app=get

Example: Response of getting day and night control parameters and values (Model_C)res=200&http_port=80&dnn_mode=0&ir_mode=0&smart_focus_enable=0

[Table 22] Parameters of day_night.php

Name TypeLengt

hDescription Value

dnn_mode integer

Day & Night mode [Model_B]0: auto1: off2: manual[Model_C]0: auto3: day4: night

dnn_manual_mode integer

Day & Night Transition Mode

0: very high1: high2: middle3: low4: very low

dnn_delaytime_mode integer

Transition time of day and night control mode (seconds)

0: off5: 5 sec10: 10 sec20: 20 sec

dnn_switchbw integerBlack & White Mode 0: color

1: mono

ir_mode integerInfrared Light Control 0: all

1: near2: far

- 59 -


3: off

smart_focus_enable boolSmart Focus sync with Day & Night

Enable: 1Disable: 0

event_out_day_night *

boolDay&Night control sync with Alarm Input Event

Enable: 1Disable: 0

Some parameters (*) are available only for the specific devices in Model_B. (HDB-M120, HDG-M120 series).

(1) Day & Night mode (dnn_mode): rwThis is to set the day and night control mode. The available value for this parameter depends on the device model. In the Model_C, this is only available in mega-pixel devices.

(2) Day & Night transition mode (dnn_manual_mode): rwThis is to configure the day and night transition mode when the dnn_mode is manual (2).

[Table 23] Transition Level of Day & Night Control ModeValue/Mode Day Mode (Lux) Night Mode (Lux)

Very high 401

(Dark limit of civil twilight under a clear sky)

High 50 (Family living room) 1Middle 60 1

Low 70 1Very low 80 (Hallway/toilet) 1

NOTEDay & Night functionality is that automatic or manual removable infrared-cut filter from the camera provides color video when there is sufficient light and black/white video in dark condition to present better image without distortion.

- 60 -


(3) Transition time of the Day & Night mode (dnn_delaytime_mode): rwThis is to configure transition time. It may be changed mode caused by temporal light. This value is to protect that.

(4) Black & White switch mode (dnn_switchbw): rwThis is to enforce the device shows in black and white mode in any condition.

(5) IR Control Mode (ir_mode): rwThis is to turn on/off IR light and focus to near/far. This is available only for some Model_C.

(6) Smart Focus sync with Day & Night (smart_focus_enable): rwThis is to take the focus automatically when day and night transitted.

(7) Day & Night control sync with alarm input event (event_out_day_night): roThis informs whether the day and night transition is synchronized with alarm input

event or not.

Example: Request of getting day and night control parameters and values in HDB-M120, HDG-M120 series (Model_B)http://<ipcam>/video/day_night.php?app=get

Example: Response of getting day and night control parameters and values in HDB-M120, HDG-M120 series (Model_B)res=200&dnn_mode=0&dnn_level=1&dnn_dwell=10&ae_agc_mode=2

NOTEThe lux (symbol: lx) is the SI unit of illuminance and luminous emittance. It is used in photometry as a measure of the intensity, as perceived by the human eye, of light that hits or passes through a surface. It is analogous to the radiometric unit watts per square metre, but with the power at each wavelength weighted according to the luminosity function, a standardized model of human visual brightness perception.

- 61 -


[Table 24] Parameters of day_night.php in HDB-M120, HDG-M120 series (Model_B)

Name TypeLengt

hDescription Value

dnn_mode integer

Day & Night mode 0: Auto(default)1: Day2: Night

dnn_level integer

Transition Level 0: high1: middle(default)2: low

dnn_dwell integer Transition Dwell Time 5/10/15 sec

ae_agc_mode boolAGC mode Enable: 1

Disable: 0

(1) Day & Night mode (ddn_mode): rwThis is to set the day and night control mode. The day mode shows scene as colored. And night mode makes the scene as black and white mode. The default value is automatic. With the automatic mode, it would be controlled by the scene brightness.

(2) Transition Level (dnn_level): rwThis is to set the day and night transition level. The default value is middle.

(3) Transition Dwell Time (dnn_dwell): rwThis is to set the transition dwell time. The default value is 10 seconds.

(4) AGC mode (ae_agc_mode): roThis informs whether the day and night mode can be auto or not.

3-1-7. WDR & 3D-DNR

This is to configure BLC (Back Light Compensation) control. This is available only for

- 62 -


some devices.

Example: Request of getting WDR and 3D-DNR control parameters and values in HDB-M120, HDG-M120 series (Model_B)http://<ipcam>/video/blc_wdr.php?app=get

Example: Response of getting WDR and 3D-DNR control parameters and values in HDB-M120, HDG-M120 series (Model_B)res=200&mode=0&level=2&ae_agc_mode=2&ae_shutter_speed=13&ae_sensup_mode=0&ae_sensup_level=6&dnr_level=2

[Table 25] Parameters of blc_wdr.php in HDB-M120, HDG-M120 series (Model_B)

Name TypeLengt

hDescription Value

mode integer

WDR & BLC Control mode

0: off (default)1: WDR2: BLC3: HSBLC

level integerWDR & BLC Control level

0: high1: middle2: low (default)

ae_agc_mode integer

WDR & BLC Control AGC 0: off1: high2: middle (default)3: low

ae_shutter_speed integer

WDR & BLC Control Shutter Speed

0(x64)~13(automatic)14: off15(AntiFlk)~25(1/10000)Default:13 (automatic)

ae_sensup_mode integer WDR & BLC Control 0: off

- 63 -


Sens-Up Mode (default)1: auto

ae_sensup_level integerWDR & BLC Control Sens-Up Level

0(x64)~12(x2)Default: 6

dnr_level integer

3D-DNR Control Level 0: off1: high2: middle(default)3: low

(1) WDR & BLC Control Mode (mode): rwThis is to select among WDR (Wide Dynamic Range), BLC (Back Light Compensation) and HSBLC (High Suppressed BLC). If it is set as HSBLC, the OSD menu would be displayed and it would be able to be controlled by PTZ controls (move – up, down, left, right, stop, enter).

(2) WDR & BLC Control Level (level): rwIt is to control WDR & BLC level.

(3) WDR & BLC Control Shutter Speed (ae_shutter_speed): rwIt is to set the WDR & BLC control shutter speed. The available value range is between from 0 to 25.

[Table 26] Shutter SpeedValue Time Value Time

0 x64 13 Auto (default)1 x32 14 Off2 x24 15 AntiFlk3 x16 16 1604 x14 17 2505 x12 18 5006 x10 19 1/7007 x8 20 1/10008 x6 21 1/1600

- 64 -


9 x5 22 1/250010 x4 23 1/500011 x3 24 1/700012 x2 25 1/10000

(4) WDR & BLC Control Sens-Up Mode (ae_sensup_mode): rwThis is to set the sens-up mode for WDR and BLC mode. The default value is off.

(5) WDR & BLC Control Sens-Up Level (ae_sensup_level): rwThis is to set the sens-up level for WDR and BLC mode.

Value Level Value Level0 x64 7 x81 x32 8 x62 x24 9 x53 x16 10 x44 x14 11 x35 x12 12 x26 x10

(6) 3D-DNR Control Level (dnr_level): rwThis is to set the 3D-DNR mode and level.

NOTEThe wide dynamic range (WDR) function is intended to provide clear images even under back light circumstances where intensity of illumination can vary excessively, namely when there are both very bright and very dark areas simultaneously. The DNR stands for Digital Noise Reduction. The 3D-DNR compares one frame to the next one and then removing the non similar tiny points which does not exist in the original frame.

- 65 -


3-1-8. IR Control

This is to configure IR. This is available only for some Model_C don’t support day and night configurations.

Example: Request of getting IR control parameters and values (Model_C)http://<ipcam>/video/ir_control?app=get

Example: Response of getting IR control parameters and values (Model_C)res=200&http_port=80&ir_strength=1

[Table 27] Parameters of ir_control.php in Model_C

Name TypeLengt

hDescription Value

ir_strength integer

IR strength value 1: lowest2: lower3: higher4: highest

(1) IR strength value (ir_strength) : rwThis is to control IR strength value.

3-2. Audio

The requests specified in the audio section are supported by products with audio capability. Audio types and audio parameters are dependant on the devices. All devices support bi-directional audio operations (receiving and sending) at the same time.

Example: Request of getting audio parameters and valueshttp://<ipcam>/audio/audio.php?app=get

Example: Response of getting audio parametersres=200&total_snd_ch=1&snd1_enable=1&snd1_codec=G711U&snd1_samplerate=8000&snd1_in_gain=0.00&snd1_in_mute=0&snd1_out_gain=0.0&snd1_out_mute=0

- 66 -


Example: Request of setting audio parameters and values (Model_A/Model_C)http://<videoserver>/audio/audio.php?ch=1&app=set&snd1_out_mute=1

Example: Response of setting video parameters (Model_A/Model_C)Res=200

[Table 28] Parameters of audio.php

Name TypeLengt

hDescription Value

total_snd_ch integerTotal number of audio channel

Default=1

snd#_enableboolea

n

Enable/Disable audio channel of the specified channel#: audio channel

Enable: 1 (default)Disable: 0

snd#_codec string 10Encoding audio codec name of the specified channel

G711U, G711A

snd#_bitrate integerEncoding bitrate of the specified channel (kbps)

*Default=64

snd#_samplerate integerSampling rate of the specified channel (Hz)

*Default=8000

snd#_in integerInput amplifier of the specified channel

*Internal: 0External: 1

snd#_in_gain floatAudio input amplifier gain value of the specified channel

*[Table 29]

snd#_out_gain floatAudio output amplifier gain value of the specified channel

snd#_in_mute boolMute on/off of the specified channel

On: 1Off: 0 (default)

snd#_out_mute boolMute on/off of the specified channel

On: 1Off: 0 (default)

snd#_2way bool Enable/Disable bi- *Enable: 1

- 67 -


directional audio Disable: 0

snd#_2way_use boolState of Usage bi-directional audio

Using: 1Not-Using: 0

snd#_in_auto boolAuto input gain control for inner audio

Using: 1Not-Using: 0

[Table 29] Audio Input/Output Volume Gain Level

(1) Number of Audio Channels (total_snd_ch): roThis is total count of audio input channels. The default value is 1.

(2) Enable/Disable Audio Channel (snd#_enable): rwThis is to enable/disable audio channel. If it is disabled, all functions (receiving, sending, and audio alert) of audio would be disabled. The default value is ‘enabled’.

(3) Audio Encoding Codec (snd#_codec): rwThe supported audio encoding codec are G.711 u-law and G.711 A-law.

Mode Model_A/C Model_B Inner Audio(higher

)

Input

(lower)

12,9,6,3,

0 (default),-3,-6,-9,-12

21.00,15.75,10.50,5.25,

0.00 (default),-5.25,

-10.50,-15.75,-21.00,

18126

0 (default)

(higher)

Output

(lower)

9,6,3,

0 (default),-3,-6,-9,

-12,-15,-18,-24

6.0,4.0,2.0,

0.0 (default),-6.0,-12.0,-18.1,

0 (default)-8,

-16,-24,-32,-40,-48,-56

- 68 -


(4) Audio Encoding Bitrate (snd#_bitrate): rwThe G.711 codec uses fixed bitrate, 64 kbps, 8 kHz sampling frequency x 8 bits per sample = 64kbps.

(5) Audio Encoding Sampling Rate (snd#_samplerate): roThe sampling rate parameter is read only, 8 kHz. And the value is 8000.

(6) Amplifier (snd#_in): rwThis is to select the amplifier for input. 0 is to use internal amplifier and 1 is to use external. This parameter is valid with Model_A product. And it is dependant on the version. This version supports only external amplifier, value 1.

(7) Audio Input Gain Level (snd#_in_gain): rwThe audio input gain level is dependant on the product [Table 29]. This is encoding audio volume from microphone at the device. The value 0 doesn’t mean mute but means normal volume level. Higher value makes sound loudly.

(8) Audio Output Gain Level (snd#_out_gain): rwThe audio output gain level is dependant on the product as like audio input gain level [Table 29]. This is decoding audio volume of speaker at the device. Audio volume affects the received sound from network and audio alert sound by event. The value 0 doesn’t mean mute but means normal volume level. Higher value makes sound loudly.

NOTEG.711, also known as Pulse Code Modulation (PCM), is a very commonly used waveform codec. G.711 uses a sampling rate of 8,000 samples per second, with the tolerance on that rate 50 parts per million (ppm). Non-uniform quantization (logarithmic) with 8 bits is used to represent each sample, resulting in a 64 kbit/s bit rate. There are two slightly different versions; μ-law, which is used primarily in North America, and A-law, which is in use in most other countries outside North America.

- 69 -


(9) Audio Input Mute Control (snd#_in_mute): rwThis is to enable/disable audio volume. If it is enabled, the sound is encoded as no sound. The default value is disabled, value 0. It’s not available for inner audio.

(10) Audio Output Mute Control (snd#_out_mute): rwThis is to enable/disable audio volume. If it is enabled, there in no sound out even if the event audio alert happens or it receives the audio by network.

(11) Enable Bi-directional Audio (snd#_2way): rwThis is to enable/disable bi-directional audio transmission.

(12) State of Usage (snd#_2way_use): roThis is the state of bi-directional audio usage. If there is any client which is using bi-directional audio function, it is set as using.

(13) Auto input gain control for inner audio (snd#_in_auto): rwThis is to enable/disable auto input gain control for inner audio.

3-3. Event

The Event describes how and when the unit performs certain actions. Various events type (On Boot, Alarm In, Manual Trigger, Motion and Video loss) may be set up as alarm sources. Event Out actions are often set up to upload images (FTP), send email (SMTP), activate output ports (Alarm Out), and send various types of notification messages (HTTP Server, Audio Alert and PTZ operation). Many event actions require an Event server for their function. These servers are used to receive uploaded Motion JPEG images or event notification messages. The event types which are supported by the device MAY be different. It is able to be defined what the device acts when the event happens by the Event Map.

3-3-1. Event In – On Boot

When the device starts up, the device is able to do some defined event actions during the specified time if this is enabled. This event option is supported by Model_A and C.

- 70 -


Example: Request of getting the event in-on boot parameters and valueshttp://<videoserver>/event/onboot.php?app=get

Example: Response of getting the event in-on boot parameters and valuesres=200&onboot_enable=0&onboot_time=3

[Table 30] Parameters of onboot.php

Name TypeLengt

hDescription Value

onboot_enable boolEnable/Disable using booting as an event


onboot_time integerDwell time of on booting event

1 ~ 180 (seconds)

(1) Enable On Booting Event (onboot_event): rwIf the device is needed to do something as like event, it is achieved by enabling this.

(2) Dwell Time of the On Booting Event (onboot_time): rwThis is valid when the onboot_event is enabled. Range of this is up to 180 seconds.

3-3-2. Event In – Alarm In

Example: Request of getting event in-alarm in parameters and valueshttp://<videoserver>/event/alarm_in.php?app=get

Example: Response of getting event in-alarm in parameters and valuesres=200&alarm_in_1_enable=0&alarm_in_1_type=NO&alarm_in_1_time=60&alarm_in_2_enable=0&alarm_in_2_type=NO&alarm_in_2_time=60)

[Table 31] Parameters of alaram_in.php

Name TypeLengt

hDescription Value

alarm_in_count integer Number of alarm inputsalarm_in_#_enable bool Enable/Disable alarm of Enable: 1

- 71 -


the specified input number

Disable: 0

alarm_in_#_type string 2Normal Open or Normal Close

NO,NC

alarm_in_#_time integerDwell time of alarm of the specified input number

0 ~ 180 seconds

(1) Number of Alarm Inputs (alarm_in_count): roThis is the number of alarm inputs on the device. This is dependant on the device model.

(2) Enable the Alarm Input (alarm_in_#_enable): rwThis is to enable/disable the alarm input of the specified alarm number as an event.

(3) Type of the Alarm Input (alarm_in_#_type): rwThere are two kinds of alarm sensors, NO (Normal Open) and NC (Normal Close). For example of NC, there is a door which is always closed. Somebody opens the door. It becomes an event. The opposite alarm type is NO.

(4) Dwell Time of the Alarm Input (alaram_in_#_time): rwThis is valid when the alarm event of the specified the number of input is enabled. Range of this is up to 180 seconds.

3-3-3. Event In – Manual Trigger

If the device is needed to do some event action manually by user, this is useful. The manual trigger features are dependant on product model. Model_B supports only one kind of manual triggering.

Example: Request of getting event in – manual trigger parameters and valueshttp://<videoserver>/event/trigger.php?app=get

Example: Response of getting event in – manual trigger parameters and valuesres=200&trigger_count=4&trigger1_enable=0&trigger1_time=3&trigger2_enable=

- 72 -


0&trigger2_time=3&trigger3_enable=0&trigger3_time=3&trigger4_enable=0&trigger4_time=3&

[Table 32] Parameters of trigger.php

Name TypeLengt

hDescription Value

trigger_count integerNumber of manual triggers

trigger#_enable boolEnable/Disable manual triggering of the specified number

Enable: 1Disable: 0

trigger#_time integerDwell time of manual triggering of the specified number

0 ~ 180 Seconds

make_trigger integer

Make Manual Trigger Event

[Model_A]1 ~ 4[Model_B]1

(1) Number of Manual Triggering Events (trigger_count): roThe number of manual triggering events is dependant on the product model. Model_B supports one of manual triggering event. Some others supports 4.

(2) Enable Manual Triggering Event (trigger#_enable): rwThis is to enable/disable manual triggering event of the specified number.

(3) Dwell Time of Manual Triggering Event (trigger#_time): rwThis is valid when the manual triggering event of the specified the number of input is enabled. Range of this is up to 180 seconds.

(4) Make Manual Trigger Event (make_trigger): rwThis is to generate actual manual trigger event. This parameter MAY be used alone.

Example: Request of generating manual trigger event (Model_A)http://<video_server>/event/trigger.php?app=set&make_trigger=1

- 73 -


Example: Request of generating manual trigger event (Model_B)http://<ipcam>/event/trigger.php?make_trigger=1

3-3-4. Event In – Motion

The motion detection windows are defined by motion region. The Model_A and C support two types of motion region property, inclusion and exclusion. If the property of a region is exclusion, then motion detection is ignored. Otherwise the motion detection event is reported. There are two ways of region specification, one is pixel and the other is grid. The pixel type is matched area by pixel. The grid type divides the pixel by some areas.The Model_A and C support grid mode. The resolution is divided by 10x8 (80) areas. With the NTSC (704x480), the width of one area is 70 pixels and the height is 60 pixels. With the PAL (704x576), the width of one area is 70 pixels and the height is 72 pixels. In the case of Model_C, with the VGA (640x480), the width of one area is 64 pixels and the height is 60 pixels.The [Figure 1] Motion Region shows 3 motion regions and grid. The region1 and 3 are inclusion regions. If a motion is detected in those regions, motion detection event is reported. The region2 is exclusion region. Even if there is a motion in region2, it is ignored. The coordinates of region1 in [Figure 1] are (0, 0), (3, 0), (0, 3) and (3, 3). The coordinates of region 2 are (2, 2), (5, 2), (2, 5) and (5, 5). The coordinates of region3 are (4, 3), (9, 3), (4, 7) and (9, 7). The matching pixels of region1 are (0, 0) (210, 0), (0, 210) and (210, 210). The Model_B uses actual pixel information for defining motion area and doesn’t support exclusion area definition. The video streams of the Model_B supports 4 motion detection areas. Thus the total motion area of the Model_B is 12.The Model_A uses grid information and supports exclusion area definition.

- 74 -


[Figure 1] Motion Regions in Model_A and C

The requesting syntax of getting and setting motion detection MUST include channel parameter and value. And the JPEG stream doesn’t support motion detection. There are three operations for configuring motion detection region, create, delete, and modify. The requests of deleting and modifying MUST specify the region ID. The request of create MUST specify the region area information, top, bottom, left and right coordinates. Example: Request of getting motion detection parameters and values (Model_B)http://<ipcam>/event/motion.php?ch=1&app=get

Example: Response of getting motion detection parameters and values (Model_B)res=200&method=&ch=1&md_enable=1&md_rgn_count=1&md_rgn1_id=1&md_rgn1_name=New&md_rgn1_type=1&md_rgn1_thre=10&md_rgn1_sen=60&md_rgn1_rgntype=roi&md_rgn1_left=400&md_rgn1_top=224&md_rgn1_right=1120&md_rgn1_bottom=736

- 75 -


Example: Request of getting motion detection parameters and values (Model_A/C)res=200&md_enable=1&md_rgn_count=1&md_rgn1_id=1&md_rgn1_name=New&md_rgn1_type=1&md_rgn1_thre=50&md_rgn1_sen=50&md_rgn1_time=5&md_rgn1_rgntype=grid&md_rgn1_left=4&md_rgn1_top=1&md_rgn1_right=9&md_rgn1_bottom=4&

[Table 33] Parameters of motion.php

Name TypeLengt

hDescription Value

ch integerMotion Detection Channel

Default=1

md_enable boolEnable/Disable Motion Detection

Enable: 1Disable: 0

md_rgn_count integerNumber of motion detection regions

md_rgn#_id integerRegion ID of the specified number

md_rgn#_name string 20Name of the specified region ID

md_rgn#_type integerProperty of the specified region ID

Include: 1Exclude: 2

md_rgn#_thre integerThreshold of the specified region

1 ~ 100

md_rgn#_sen integerSensitivity of the specified region

1 ~ 100

md_rgn#_time integerDwell time of the specified region

0 ~ 180 seconds

md_rgn#_rgntype integer

Region type of the specified ID

*1: roi (pixel type)2: grid(grid type)

md_rgn#_left integerCoordinates X of the left top of the specified region

md_rgn#_top integer Coordinates Y of the left

- 76 -


top of the specified region

md_rgn#_right integerCoordinates X of the right bottom of the specified region

md_rgn#_bottom integerCoordinates Y of the right bottom of the specified region

method string 6

Create/delete/modify/save motion detection region

create,delete,modify,save

(1) Enable Motion Detection (md_enable): rwThis is to enable/disable motion detection function of the specified channel.

(2) Number of Motion Detection Regions (md_rgn_count): roThis is total number of defined motion detection region at the device.

(3) Region ID (md_rgn_id): roEach motion detection region owns unique ID. It is created by the device with creation method. The requests of deletion and modification MUST specify this parameter value.

(4) Name of Motion Detection Region (md_rgn#_name): rwEach motion detection region has name. It needs not be unique.

(5) Type of Motion Detection Region (md_rgn#_type): rwEach motion detection region works including mode or excluding mode. The excluding mode don’t detect motion in the region. In the [Figure 1], the sequence of defining region is 1, 2 and 3. There are two overlapped grids. The grid of (2, 2), (3, 2), (2, 3) and (3, 3) is excluding area, thus motions in that grid is ignored. And the grids of (4, 3), (5, 3), (4, 5) and (5, 5) are including areas, the motion in those is reported. The Model_B doesn’t support excluding motion region definition.

- 77 -


(6) Region Information of Motion Detection Region (md_rgn#_left, md_rgn#_top, md_rgn#_right, md_rgn#_bottom): rwThe Model_B uses real pixel coordinates for defining motion region (ROI mode). The Model_A and C use grid coordinates for defining motion region. The coordinates of the left top position is (0, 0) in the image. With the grid mode, the regions are divided 10x8 cells. The coordinates of the right bottom is (10, 8) in the image. With the pixel (ROI) mode, the right bottom is real pixel information, for example (1600, 1200). The creating method MUST be written with these region parameters (left, top, right, bottom).

(7) Method (method): rwThis is the operation mode, create, delete and modify motion detection region.

3-3-5. Event In - Video Loss

The Model_A supports video loss event.

Example: Request of getting video loss event parameters and values (Model_A)http://<videoserver>/event/loss.php?app=get

Example: Response of getting video loss event parameters and values (Model_A)res=200&vloss1_enable=0&vloss1_time=3&

[Table 34] Parameters of loss.php

Name TypeLengt

hDescription Value

vloss#_enable boolEnable/Disable video loss event of the specified channel

Enable: 1Disable: 0

vloss#_time integerDwell time of video loss event of the specified channel

0 ~ 180 Seconds

(1) Enable Video Loss Event (vloss#_enable): rwThis is to enable/disable video loss event of the specified channel. If this is enabled

- 78 -


and the video is lost, the device acts defined event operation.

(2) Dwell Time of the Video Loss Event (vloss#_time): rwThis is valid when then video loss event of the specified channel is enabled.

3-3-6. Event In – Network Loss

The Model_A and C support network loss event. This event is occurred when the network cable is pulled out from the device.

Example: Request of getting video loss event parameters and values (Model_A/C)http://<videoserver>/event/netloss.php?app=get

Example: Response of getting video loss event parameters and values (Model_A/C)res=200&netloss_enable=0&vloss_time=3&

[Table 35] Parameters of netloss.php

Name TypeLengt

hDescription Value

netloss_enable boolEnable/Disable network loss event

Enable: 1Disable: 0

netloss_time integerDwell time of network loss event

0 ~ 180 Seconds

(1) Enable Network Loss Event (netloss_enable): rwThis is to enable/disable network loss event. If this is enabled and the network cable is pulled out from the device, the device acts defined event operation.

(2) Dwell Time of the Video Loss Event (vloss#_time): rwThis is valid when then network loss event is enabled.

3-3-6. Event Out – SMTP (E-Mail)

When an event is occurred, the device is able to send e-mail to pre-defined mail addresses using SMTP. This is to set the SMTP environment and mail addresses.

- 79 -


Example: Request of getting SMTP parameters and values (Model_A)http://<videoserver>/event/smtp.php?app=get

Example: Response of getting SMTP parameters and values (Model_A)res=200&smtp_enable=1&smtp_server=&smtp_server_port=25&[email protected]&smtp_interval=60&smtp_limit=50&smtp_auth_enable=0&smtp_user=&smtp_pass=&smtp_auth_type=0&[email protected]&smtp_receiver_list2=&smtp_receiver_list3=&smtp_receiver_list4=&smtp_receiver_list5=&smtp_receiver_list6=&smtp_receiver_list7=&smtp_receiver_list8=&

[Table 36] Parameters of smtp.php

Name TypeLengt

hDescription Value

smtp_enable boolEnable/Disable SMTP event action

Disable: 0Enable: 1

smtp_sender string 63 Sender’s mail address

smtp_interval integerInterval time of sending mails

1 ~ 86400seconds

smtp_limit integerAggregate events for sending mail

1~100

smtp_server string 63SMTP server URL address

smtp_auth_enable boolEnable/Disable authentication of SMTP login

Enable: 1Disable: 0

NOTESimple Mail Transfer Protocol (SMTP) is an Internet standard for electronic mail (e-mail) transmission across Internet Protocol (IP) networks. SMTP was first defined in RFC 821 (STD 15),[1] and last updated by RFC 5321 (2008)[2] which includes the extended SMTP (ESMTP) additions, and is the protocol in widespread use today.

- 80 -


smtp_auth_type integerType of SMTP server authentication

AUTH LOGIN: 0AUTH PLAIN: 1

smtp_user string 31User ID for SMTP server login

smtp_pass string 31Password for SMTP server login

smtp_receiver_list1

string 31

E-Mail receiver listsmtp_receiver_list2smtp_receiver_list3smtp_receiver_list4smtp_receiver_list5smtp_receiver_list6smtp_receiver_list7smtp_receiver_list8method string 4 Test SMTP Testsmtp_receiver string 31 E-Mail Address to Test

smtp_use_server boolSend event notification mail thru SMTP server or not

Use: 1Not-Use: 0

smtp_server_port integerSMTP Server Port Number

1~65535

(1) Enable Event Out - SMTP (E-Mail) (smtp_enable): rwThis is to enable/disable one of event action that device sends e-mail by SMTP.

(2) Sender’s E-Mail address (smtp_sender): rwThis is the sender’s E-Mail address.

(3) Interval of Sending E-Mails (smtp_interval): rwThis is to send at least one e-mail in time interval. It is able to be maximum 1 day (24 hours). If the interval is 1 day (24 hours), the device sends at least one e-mail a day. It reports any event information in a day.

(4) Aggregating Count of Events to send (smtp_limit): rwIf the device has to send e-mail in every time of event, it may make burden to

- 81 -


device, SMTP server and receiver. This is to collect events to send e-mail notification. If it is 50, device doesn’t send e-mail until 50 events happen. It could be a useful function with interval value. If the interval of sending is 1 hour, and the limit is 50, the device would send e-mail every one hour or after 50 events happen.(5) SMTP Server Address (smtp_server): rwThis is to set SMTP server address for sending e-mail.

(6) Enable SMTP Authentication (smtp_auth_enable): rwThis is to enable/disable SMTP authentication. Usually SMTP server needs user ID and password to send e-mail by the server.

(7) SMTP Authentication Mechanisms (smtp_auth_type): rwThe SMTP-AUTH provides an access control mechanism. There are two types of mechanisms, AUTH LOGIN and AUTH PLAIN. (RFC2554, RFC2245)

(8) SMTP Server Login ID (smtp_user): rwThis is the parameter for SMTP server login id.

(9) SMTP Server Login Password (smtp_pass): rwThis is the parameter for SMTP server login password

NOTESMTP-AUTH Simple Authentication and Security Layer (SASL) is a framework for authentication and data security in Internet protocols. It decouples authentication mechanisms from application protocols, in theory allowing any authentication mechanism supported by SASL to be used in any application protocol that uses SASL. Authentication mechanisms can also support proxy authorization, a facility allowing one user to assume the identity of another. Authentication mechanisms can also provide a data security layer offering data integrity and data confidentiality services. DIGEST-MD5 is an example of mechanisms which can provide a data security layer. Application protocols that support SASL typically also support Transport Layer Security (TLS) to complement the services offered by SASL.

- 82 -


(10) SMTP Receiver List (smtp_receiver_list1, smtp_receiver_list2, smtp_receiver_list3, smtp_receiver_list4, smtp_receiver_list5, smtp_receiver_list6, smtp_receiver_list7, smtp_receiver_list8): rwMaximum 8 e-mail addresses are configurable to receive. This product supports a configuration that what kind of event makes the device to send e-mails to whom in the list. It is explained in the section Event Map.

(11) SMTP Test (method): rwThis is a method to test whether SMTP configuration is done or not. The method is ‘test’.

(12) E-Mail Address to Test (smtp_receiver): rwThis is a receiver’s e-mail address to test. This parameter is not stored on the device. It MUST be used with method.

(13) Use/Not Use SMTP Server (smtp_use_server): rwThis is to use or not use to send event notification email thru SMTP server.

(14) SMTP server port (smtp_server_port): rwThis is the SMTP server port number to access (1 ~ 65535).

3-3-7. Event Out – FTP & JPEG

This is a configuration for FTP and JPEG setting which are uploaded when an event happens. The Model_B provides different configuration of JPEG (resolution and quality) with image stream2. The Model_A uses same configuration of JPEG with stream 2.

Example: Request of getting event out - ftp and jpeg parameters and values (Model_A)http://<videoserver>/event/ftp.php?app=get

Example: Response of getting event out - ftp and jpeg parameters and values (Model_A)

- 83 -


res=200&ftp_enable=0&ftp_server=&ftp_port=21&ftp_mode=0&ftp_path=&ftp_user=&ftp_pass=&ftp_anonymous=0&jpg_pre_timeout=5&jpg_pre_fps=1&jpg_pst_timeout=5&jpg_pst_fps=1&jpg_base_name=basename_&jpg_suffix_name=1

Example: Request of getting event out - ftp and jpeg parameters and values (Model_B)http://<ipcam>/event/ftp.php?app=get

Example: Response of getting ftp and jpeg parameters and values (Model_B)res=200&ftp_enable=0&ftp_server=&ftp_port=21&ftp_mode=0&ftp_user=guest&ftp_pass=&ftp_path=&ftp_anonymous=0&jpg_pre_timeout=1&jpg_pre_fps=2&jpg_pst_timeout=1&jpg_pst_fps=2&jpg_quality=35&jpg_size=640X480&jpg_base_name=EventCapture_&jpg_suffix_name=1&jpg_quality_type_num=5&jpg_arr_quality_type1=25&jpg_arr_quality_type2=30&jpg_arr_quality_type3=35&jpg_arr_quality_type4=40&jpg_arr_quality_type5=49&jpg_size_type_num=4&jpg_arr_size_type1=720X576&jpg_arr_size_type2=720X480&jpg_arr_size_type3=640X480&jpg_arr_size_type4=320X240&jpg_min_timeout=0&jpg_max_timeout=5&jpg_min_fps=1&jpg_max_fps=5

[Table 37] Parameters of ftp.php

Name TypeLengt

hDescription Value

ftp_enable boolEnable/Disable FTP Event Out

Disable: 0Enable: 1

ftp_server string 63 FTP server addressftp_port integer FTP server port 1~65535

ftp_path string 250Remote directory for uploading JPEG images

ftp_mode integerFTP server mode Active Mode: 0

Passive Mode: 1

ftp_user string 31 FTP server login user id

ftp_pass string 31FTP server login user password

- 84 -


ftp_anonymous boolWhich the FTP server is anonymous or not

Anonymous: 1Non-anonymous: 0

jpg_pre_timeout integer

Pre-event JPEG uploading time

*[Model_A]0~30seconds*[Model_B]0~3 seconds

jpg_pre_fps integer

Uploading image count per second before event.

*[Model_A]1~2 fps*[Model_B]1~3fps

jpg_pst_timeout integer

Post-event JPEG uploading time

*[Model_A]0~30seconds*[Model_B]0~3 seconds

jpg_pst_fps integer

Uploading image count per second after event dwell time

*[Model_A]1~2 fps*[Model_B]1~3fps

jpg_base_name string 31Prefix of uploading image file name

jpg_suffix_name integer

Suffix of uploading image file name

None: 0Date/Time: 1Sequence number

jpg_quality integerUploading JPEG quality *[Model_B]

[Table 9]

jpg_size string 7Resolution of uploading JPEG image

[Model_B]320x240(QVGA)

jpg_quality_type_num

integerNumber of available JPEG quality types for uploading

[Model_B]

- 85 -


jpg_arr_quality_type#

integerAvailable JPEG quality value number(#) in the list

[Model_B]

jpg_size_type_num integerNumber of available JPEG quality types for uploading

[Model_B]

jpg_arr_size_type# string 7Available JPEG resolution number(#) in the list

[Model_B]

jpg_min_timeout integerMinimum time value for pre and post-event

[Model_B]

jpg_max_timeout integerMaximum time value for pre and post-event

[Model_B]

jpg_min_fps integerAvailable minimum framerate for uploading JPEG

[Model_B]

jpg_max_fps integerAvailable maximum framerate for uploading JPEG

[Model_B]

(1) Enable Event Out - FTP (ftp_enable): rwThis is to enable/disable one of event action that device uploads JPEG images to the defined FTP server

(2) FTP Server (ftp_server): rwThis is FTP server URL address.

(3) FTP Server Port Number (ftp_port): rwThis is FTP server port address to connect.

(4) FTP Remote Directory Path (ftp_path): rwThis is the remote directory path in the FTP server to upload JPEG images.

(5) FTP Mode (ftp_mode): rwThis is the FTP connection mode, active and passive mode. There is another FTP

- 86 -


connection mode, extended passive mode (RFC2428). But that mode is not supported by this version.

(6) FTP User ID (ftp_user): rwThis is the FTP user ID to connect the server.

(7) FTP User Password (ftp_pass): rwThis is the FTP user password to connect the server

(8) FTP Anonymous Mode (ftp_anonymous): rwThis is to set anonymous access to the FTP server.

NOTEIn active mode, the FTP client opens a dynamic port, sends the FTP server the dynamic port number on which it is listening over the control stream and waits for a connection from the FTP server. When the FTP server initiates the data connection to the FTP client it binds the source port to port 20 on the FTP server.In passive mode, the FTP server opens a dynamic port, sends the FTP client the server's IP address to connect to and the port on which it is listening (a 16-bit value broken into a high and low byte, as explained above) over the control stream and waits for a connection from the FTP client. In this case, the FTP client binds the source port of the connection to a dynamic port.

NOTEAnonymous FTP A host that provides an FTP service may additionally provide anonymous FTP access. Users typically login to the service with an 'anonymous' account when prompted for user name. Although users are commonly asked to send their email address in lieu of a password, little to no verification is actually performed on the supplied data.

- 87 -


(9) Pre-Event Time for FTP (jpg_pre_timeout): rwThis is to set pre-event time for FTP. If this value is bigger than 0, device stores images as defined pre-event fps. When an event happens, device uploads images which were stored before that event. The time limitation is dependant on the product model.

(10) Pre-Event FPS for FTP (jpg_pre_fps): rwThis is to set pre-event framerate for FTP. The fps limitation is dependant on the product model.

(12) Post-Event Time for FTP (jpg_pst_timeout): rwThis is to set post-event time for FTP. If this value is bigger than 0, device uploads image after dwell time of the event. The time limitation is dependant on the product model.

(13) Post-Event FPS for FTP (jpg_pst_fps): rwThis is to set post-event framerate for FTP. The fps limitation is dependant on the product model.

(14) Prefix of JPEG File Name for Uploading to FTP Server (jpg_basename): rwThe uploading file name MAY have the prefix string which is defined by this.

(15) Suffix of JPEG File Name for Uploading to FTP Server (jpg_suffix_name): rwThe uploading file name MAY have the suffix string using this value. If it is set as ‘None’, the uploading file overwrites the previous file. If it is set as ‘Date and Time’, the suffix of the file name has own date and time string (YYYYMMDDhhmmss). If it is set as ‘Sequence Number’, the suffix of the file name has own sequence number from 0.

(16) Uploading JPEG Quality (jpg_quality): rwThe Model_B provides jpeg configuration for FTP uploading. It is possible to set different JPEG quality from stream2. The JPEG quality value is explained in the [Table 9]. And the quality is selectable from the jpg_arr_quality_type#.

(17) Uploading JPEG resolution (jpg_size): rwThe Model_B provides jpeg configuration for FTP uploading. It is possible to set

- 88 -


different JPEG resolution form stream2. The JPEG resolution value is selectable from the jpg_arr_size_type#. The maximum resolution is VGA (640x480).

(18) Number of Available JPEG Quality Values (jpg_quality_type_num): roThis is the number of available JPEG quality values for FTP uploading. This shows how many jpg_arr_quality_type# parameters are appeared in the response. The jpg_quality MAY use one of the jpg_arr_quality_type# values.

(19) Available JPEG Quality Values (jpg_arr_quality_type#): roThis is available JPEG quality value in the list.

(20) Number of Available JPEG Resolutions (jpg_size_type_num): roThis is the number of available JPEG resolution values for FTP uploading. This shows how many jpg_arr_size_type# parameters are appeared in the response. The jpg_size MAY use one of the jpg_arr_size_type# values.

(21) Available JPEG Resolution Values (jpg_arr_size_type#): roThis is available JPEG resolution value in the list.

(22) Minimum Time Value of JPEG Pre- and Post-Event Time: (jpg_min_timeout): roThis is the minimum time value of pre- and post-event time.(23) Maximum Time Value of JPEG Pre- and Post-Event Time: (jpg_max_timeout): roThis is the maximum time value of pre- and post-event time.

(24) Minimum Framerate for Pre- and Post-Event (jpg_min_fps): roThis is the minimum framerate for FTP in pre- and post-event operations.

(25) Maximum Framerate for Pre- and Post-Event (jpg_max_fps): roThis is the maximum framerate for FTP in pre- and post-event operations.

3-3-8. Event Out – HTTP Server

This is to notify event status to the specified HTTP server.

Example: Request of getting event out-http server parameters and values (Model_A/C)

- 89 -


http://<videoserver>/event/http_server.php?app=get

Example: Response of getting event out-http server parameters and values (Model_A/C)res=200&http_nt_enable=0&http_nt_server=&http_nt_port=80&http_nt_mode=0&http_nt_user=&http_nt_pass=

Example: Request of getting event out-http server parameters and values (Model_B)http://<ipcam>/event/http_server.php?app=get

Example: Response of getting event out-http server parameters and values (Model_B)res=200&http_nt_enable=0&http_nt_server=&http_nt_port=80&http_nt_user=&http_nt_pass=

Example: Notification message POST /test/test.php HTTP/1.1 Accept: */* User-Agent: EON-Client HOST: 192.168.1.100 Content-Type: application/x-www-form-urlencoded Content-Length: XX Video loss

[Table 38] Parameters of http_server.php

Name TypeLengt

hDescription Value

http_nt_enable boolEnable/Disable HTTP server notification

Enable: 1Disable: 0

http_nt_server string 63HTTP notification server address

http_nt_port integerHTTP notification server port number to connect

1~ 65535

http_nt_mode integer HTTP notification mode *HTTP: 0

- 90 -


HTTPS(SSL): 1

http_nt_user string 31User ID for connecting to the HTTP server

http_nt_pass string 31User Password for connecting to the HTTP server

method string 4 Test HTTP Notification Test

http_nt_msg string 20Notification message for Test

(1) Enable Notification to the HTTP Server (http_nt_enable): rwThis is to enable/disable event notification to the HTTP server.

(2) HTTP Notification Server Address (http_nt_server): rwThis is the URL address of HTTP notification server to receive message.

(3) HTTP Notification Server Port Number (http_nt_port): rwThis is the port number to connect HTTP notification server.

(4) Connection Mode of HTTP Notification Server (http_nt_mode): rwThere are two types of connection, HTTP and HTTPS. This is not valid in Model_B.

(5) User ID to Connect HTTP Notification Server (http_nt_user): rwThis is user ID to connect HTTP notification server.

(6) Password to Connect HTTP Notification Server (http_nt_pass): rwThis is password to connect HTTP notification server.

NOTEHypertext Transfer Protocol Secure (HTTPS) is a combination of the Hypertext Transfer Protocol and a cryptographic protocol. HTTPS connections are often used for payment transactions on the World Wide Web and for sensitive transactions in corporate information systems.

- 91 -


(7) Test HTTP Notification (method): rwThis is a method to test whether HTTP notification configuration is done or not. The method is ‘test’.

(8) HTTP Notification Message for Test (http_nt_msg): rwThis is a notification message for test. This parameter is not stored on the device. It MUST be used with method.

3-3-9. Event Out – Alarm Out

When an event happens, the device is able to send alarm out. Because it could be controlled by the Event Map, the Model_B doesn’t need to set enable/disable.

Example: Request of getting event out-alarm out parameter and value (Model_A)http://<videoserver>/event/alarm_out.php?app=get

Example: Response of getting event out-alarm out parameter and value (Model_A)res=200&alarm_out_enable=0

[Table 39] Parameters of alarm_out.php

Name TypeLengt

hDescription Value

alarm_out_enable integerEnable/Disable alarm out on device

Enable: 1Disable: 0

alarm_out_type stringNormal Open or Normal Close

NO, NC

(1) Enable Alarm Out (alarm_out_enable): rwThis is to enable/disable alarm out on the device.

(2) Type of the Alarm Out (alarm_out_type): rwThere are two kinds of alarm out device, NO(Normal Open) and NC(Normal Close).

- 92 -


3-3-10. Event Out – Audio Alert

Devices provide audio file playing when an event happens. The audio files could be generated by the special program (ARecorder_Install.exe). And those files could be imported to the device. There is a limitation of file size to upload (Total 512KB). With this version.

Example: Request of getting event out-audio alert parameters and values (Model_A/Model_C)http://<videoserver>/event/audio_alert.php?app=get

Example: Response of getting event out-audio alert parameters and values (Model_A/Model_C)res=200&audio_alert_enable=0&audio_alert_file1=audio1.g711u&audio_alert_size1=240000&audio_alert_time1=30&audio_alert_bitrate1=64&audio_alert_file2=audio2.g711u&audio_alert_size2=240000&audio_alert_time2=30&audio_alert_bitrate2=64&audio_alert_file3=audio3.g711u&audio_alert_size3=178000&audio_alert_time3=22&audio_alert_bitrate3=64

[Table 40] Parameters of audio_alert.php

Name TypeLengt

hDescription Value

audio_alert_enable boolEnable/Disable audio alert function

Enable: 1Disable: 0

audio_alert_file1,2,3 string 64File name of the audio file 1, 2 and 3

audio_alert_size1,2,3 integerSize of the audio file 1,2 and 3

audio_alert_time1,2,3 integerPlaying time of the audio file 1, 2 and 3

audio_alert_bitrate1,2,3

integerBitrate of the audio file 1, 2 and 3

64

method stringTest, Update and Remove Audio file

update,remove

audio_alert_index integer Audio alert file index 1, 2, 3

- 93 -


(1) Enable Audio Alert (audio_alert_enable): rwThis is to enable/disable event out – audio alert.

(2) Audio File Name 1, 2, 3 (audio_alert_file1, audio_alert_file2, audio_alert_file3): rwThese are audio file names. The audio file could be generated by special program. The generated audio file could be uploaded to the device by /event/audio_upload.php and audio_alert_index parameter. The maximum length of the audio alert file name (not path) is 64.(3) Audio File Size 1, 2, 3 (audio_alert_size1, audio_alert_size2, audio_alert_size3): roThese are audio file sizes. There is a limitation of audio file size to upload. Total size of 3 files MUST be smaller than 512KB.

(4) Audio Playing Time 1, 2, 3 (audio_alert_time1, audio_alert_time2, audio_alert_time3): roThis is the playing time of each audio file. The maximum playing time for each audio file MUST be less than 30 seconds.

(5) Bitrate of the Audio File 1, 2, 3 (audio_alert_bitrate1, audio_alert_bitrate2, audio_alert_bitrate3): roThese are bitrate information of audio files.

(6) Method (method): rwThis is the operation of test, update or remove audio alert file. The test is to test playback file at the device. The speaker MUST be connected to the device. The update is to upload the audio alert file from PC to device. To upload audio alert file, audio_upload.php MUST be called. The remove is to remove the audio alert file from the device. The test and remove commands MUST be written with audio_alert_index parameter.

Example: Request of testing audio alert filehttp://<videoserver>/event/audio_alert.php?app=set&method=test&audio_alert_index=1

Example: Request of removing audio alert file

- 94 -


http://<videoserver>/event/audio_alert.php?app=set&method=remove&audio_alert_index=1

3-3-11. Event Out – Record

The some of Model_B, Model_C provide record function. When an event happens or it is configured as continuous recording, the video stream would be recorded into the SD card which is installed in the device.

Example: Request of getting event out-ptz preset parameters and values (Model_B, Model_C)http://<ipcam>/event/record.php?app=get

Example: Response of getting record parameters and values (Model_B, Model_C)res=200&record_enable=0&record_overwrite=1&record_stream=1&record_pre_time=0&record_post_time=0&record_audio=0&record_device_status=3&record_device_format=1&record_device_remove=1&record_device_total=968.75MB&record_device_used=968.75MB&record_device_available=0.00MB&record_device_percent=100.00%

[Table 41] Parameters of record.php

Name TypeLengt

hDescription Value

record_enable boolEnable/Disable recording

Enable: 1Disable: 0

record_overwrite bool

Enable/Disable overwriting when there is not enough disk space

Enable: 1Disable: 0

record_stream integerSelection recording video stream

1: Stream12: Stream23: Stream3

record_pre_time integerPre-event recording time

0 ~ 10 (second)

record_post_time integer Post-event recording 0 ~ 60

- 95 -


time (second)

record_audio boolEnable/Disable audio recording with video

Enable: 1Disable: 0

record_device_status integer SD card status *[Table 42]record_device_status_cifs integer CIFS statusrecord_device_status_nfs integer NFS status

record_device_format boolAvailability format operation of SD card

Not available: 0Available: 1

record_device_format_cifs boolAvailability format operation of CIFS

record_device_format_nfs boolAvailability format operation of NFS

record_device_remove boolAvailability removing operation of SD card

Not available: 0Available: 1record_device_remove_cif

sbool

Availability removing operation of CIFS

record_device_remove_nfs

boolAvailability removing operation of NFS

record_device_total stringTotal disk space for recording

record_device_used string Used disk spacerecord_device_available string Available disk space

record_device_percent stringUsage of disk space as percentage

record_device_bad_percent

stringBad sector size as percentage

[Table 42] Status of Recording DeviceStatus Value Description

0 No recording device1 Unformatted recording device installed2 Formatting the recording device3 Available for recording (Formatted)4 Remove5 Locked

- 96 -


6 Bad7 Unknown

(1) Enable Recording Device (record_enable): rwThis is to enable/disable recording device.

(2) Enable Overwritting Recording (record_overwrite): rwThis is to enable/disable overwritting the recording device when there is no enough disk space to record. If it is disabled overwriting and when there is no space to record more, then it stops to record.

(3) Selection Recording Video Stream (record_stream): rwThis is to select the video stream to record.

(4) Pre-event Recording Time (record_pre_time): rwThis is to set the pre-event recording time. The previous video/audio streams would be recorded before the event occurrence.

(5) Post-event Recording Time (record_post_time): rwThis is to set the post-event recording time. After an event occurrence, the video/audio streams would be recorded until the specified time.

(6) Enable Audio Stream Recording (record_audio): rwThis is to enable/disable audio stream recording with video stream. This MAY NOT be available in some of devices.

(7) SD Card Status (record_device_status): roThis is the status of the SD card.

(8) Availability Format Operation Status of the SD Card (record_device_format): roThis is to check status of the SD card before format operation. The status MUST be available before doing format operation.

(9) CIFS Status (record_device_status_cifs): roThis is the status of the CIFS.

- 97 -


(10) Availability Format Operation Status of the CIFS (record_device_format): roThis is to check status of the CIFS before format operation. The status MUST be available before doing format operation.

(11) NFS Status (record_device_status_cifs): roThis is the status of the NFS.

(12) Availability Format Operation Status of the NFS (record_device_format): roThis is to check status of the NFS before format operation. The status MUST be available before doing format operation.

(13) Availablity Removing Operation Status (record_device_remove): roThis is to check status of SD card before removing storage device. The status MUST be available before doing removing operation.

(14) CIFS Remove (record_device_remove_cifs) : roThis is to check status of CIFS removing. The status MUST be available before doing removing operation.

(15) NFS Remove (record_device_remove_nfs) : roThis is to check status of NFS removing. The status MUST be available before doing removing operation.

(16) Total Disk Space (record_device_total): roThis is the value of total disk space of storage device.

(17) Used Disk Space (record_device_used): roThis is the value of used disk space of storage device.

(18) Available Disk Space (record_device_available): roThis is the value of available disk space of storage device.

(19) Usage of Disk space as Percentage (record_device_percent): roThis is the value of usage of disk space as percentage.

- 98 -


(20) Bad sector size ad Percentage (record_device_bad_percent): roThis is the value of the bad sector size of the disk as percentage.

This command formats the storage device.

Example: Command for formatting the storage device http://< ipcam >/event/format.php?app=set&format=1

Before sending format command of storage device, it MUST be checked which is available to do format. The format operation MAY need a few minutes. The time for formatting depends on the size of the storage device. There is a command to check completion of formatting operation.

Example: Command for checking the completion of formatting the storage devicehttp://< ipcam >/event/format.php?app=get

Example: Response for checking the completion of formatting the storage device Res=200&format=1 <Not Completed Yet>

Res=200&format=0 <Completed >

This command is to remove the storage device.

Example: Command for removing the storage devicehttp://< ipcam >/event/remove.php?app=set&record_device_remove=1

Example: Response for removing the storage deviceres=200

After at least 5 seconds of receiving the response for removing, the storage device SHOULD be removed.

3-3-12. Event Out – PTZ Preset

The Model_A/B provides PTZ control function. When an event happens, PTZ camera

- 99 -


controls Pan/Tilt and Zoom. Sometimes, after a while, the PTZ moves to the home position.Example: Request of getting event out-ptz preset parameters and values (Model_A)http://<videoserver>/event/ptz_preset.php?app=get

Example: Response of getting event out-ptz preset parameters and values (Model_A)res=200&preset_out_enable=0&preset_out_home=0

[Table 43] Parameters of ptz_preset.php

Name TypeLengt

hDescription Value

ptz_preset_enable boolEnable/Disable PTZ preset function

Enable: 1Disable: 0

preset_out_home integerID of home preset position

0 ~2550: Not move1 ~ 255: Preset

(1) Enable PTZ Preset Control (ptz_preset_enable): rwThis is to enable/disable ptz preset control.

(2) Automatic Movement to the Home Position (preset_out_home): rwThis is the preset id of home position to return. If this is 0, it means no movement. Otherwise, the value is the preset id.

3-3-13. Event Map

It is configurable what an event happens (Event In) makes some specific actions (Event Out) by the Event Map. The map.php shows the event map list. The event_pop.php has the operations of creating, modifying and deleting the event map.

Example: Request of getting event map parameters and values (Model_A)http://<videoserver>/event/map.php?app=get

- 100 -


Example: Response of getting event map parameters and values (Model_A)res=200&preset_use=1&event_list=0800||Onboot|Alert(3)0600||Trigger(1)|Alert(2)0000|New Event|Motion(Ch:1,Region:1)|Alert(3)&event_in_cnt=3&event_max_cnt=9

[Table 44] Parameters of map.php

Name TypeLengt

hDescription Value

preset_use boolUsage of PTZ preset or not

Use: 1Not-Use: 0

event_list string List of Event Maps *Event List

event_max_cnt integerNumber of available events

(1) Usage of PTZ preset (preset_use): roThis is to show whether the device uses PTZ preset or not.

(2) Event List (event_list): roThe Event List shows defined event map list. An event map is consisted of event ID, event name, event type and event out actions. Each event item is delimited by ‘\n’ (0x0D 0x0A).The event ID is 4 numbered characters, ABCD. The first two characters, AB, mean event input type as below. And the next two characters, CD, mean actual event source ID. The event name is a string to point the event.The event type is a string for describe the event.The event outs are strings for describing the event out actionsEach item of an event is delimited by ‘|’.

[Table 45] Event ID in Event Map A B Description C D Description00 Motion Channel 1

00 ~ 07 Motion Region ID01 Motion Channel 202 Motion Channel 303 Motion Channel 4

- 101 -


05 Alarm Input00 Alarm Input 101 Alarm Input 2

06 Manual Trigger

00 Manual Trigger 101 Manual Trigger 202 Manual Trigger 303 Manual Trigger 4

08 On Boot 00 N/A09 Video Loss 00 ~ 04 Video Channel10 Network Loss 00 N/A

11 Analytic

00 Motion01 Tracking02 Cross03 Abandon04 Removal05 Enter

12 PIR 00 N/A13 Audio Detection 00 N/A

(3) Number of Available Events (event_max_cnt): roThis is the number of available (maximum) events to be configurable.

The event_pop.php is to add/modify/remove event map from list. The request MUST be written with method parameter. And modify and remove operations MUST be written with event_in_id parameter. The ‘add’ operation with app=set MUST be written with event_in_id parameter. The ‘add’ operation needs other parameters for correct event map.

Example: Request of getting event_pop parameters and values (Model_A)http://<videoserver>/event/event_pop.php?app=get&method=add

Example: Response of getting event_pop parameters and values (Model_A)res=200&preset_use=1&event_out_smtp_list1=&event_out_smtp_list2=&event_out_smtp_list3=&event_out_smtp_list4=&event_out_smtp_list5=&event_out_smtp_list6=&event_out_smtp_list7=&event_out_smtp_list8=&&event_in_id_list1=0500&event

- 102 -


_in_name_list1=AlarmIn(1)&event_in_id_list2=0501&event_in_name_list2=AlarmIn(2)&event_in_id_list3=0601&event_in_name_list3=Trigger(2)&event_in_id_list4=0602&event_in_name_list4=Trigger(3)&event_in_id_list5=0603&event_in_name_list5=Trigger(4)&event_in_id_list6=0900&event_in_name_list6=Loss(1)&&event_in_cnt=6

Example: Request of getting event_pop parameters and values for modify (Model_A)http://<videoserver>/event/event_pop.php?app=get&method=modify&event_in_id=0800

Example: Response of getting event_pop parameters and values for modify (Model_A)res=200&preset_use=1&event_name=&event_in_id=0800&event_in_name=Onboot&event_out_smtp=0&event_out_smtp_en1=0&event_out_smtp_list1=&event_out_smtp_en2=0&event_out_smtp_list2=&event_out_smtp_en3=0&event_out_smtp_list3=&event_out_smtp_en4=0&event_out_smtp_list4=&event_out_smtp_en5=0&event_out_smtp_list5=&event_out_smtp_en6=0&event_out_smtp_list6=&event_out_smtp_en7=0&event_out_smtp_list7=&event_out_smtp_en8=0&event_out_smtp_list8=&event_out_smtp_title=&event_out_smtp_msg=&event_out_ftp=0&event_out_http=0&event_out_http_msg=&event_out_alarm=0&event_out_audio=1&event_out_audio_file=3&event_out_preset=0&event_out_preset_num=1&event_out_preset_home=0

[Table 46] Parameters of event_pop.php

Name TypeLengt

hDescription Value

method string 6 Event Map Operationsadd, modify, remove

preset_use boolUsage of PTZ preset or not

*Use: 1Not-Use: 0

event_out_smtp_list# stringE-Mail Address for Event Out

event_in_id_list# stringEvent ID for the specified number in the list

*[Table 45]

event_in_id string Event In ID *[Table 45]

- 103 -


event_in_name_list# stringEvent In Type Name for the specified number in the list

event_in_name string Event In Name

event_in_cnt integerNumber of event input inthe list

event_out_smtp_en# boolSending Event E-Mail to the Specified Address or not

Send: 1Not-Send: 0

event_out_smtp_title string 127E-Mail Title for that Event

event_out_smtp_msg string 254E-Mail Message for that Event

event_out_alarm boolUsage of Alarm Out or not for that Event

Use: 1Not-Use: 0

event_out_ftp boolUsage of FTP for that Event

event_out_http boolUsage of HTTP Notification for that Event

event_out_smtp boolUsage of SMTP for that Event

event_out_http_msg string 31Message String for HTTP Notification

event_out_audio boolUsage of Audio Alert for that Event

Use: 1Not-Use: 0

event_out_audio_file integerAudio File to Play for that Event

1 ~ 3

event_out_preset usageUsage of PTZ preset for that Event

Use: 1Not-Use: 0

event_out_preset_num integerPTZ Preset ID for that Event

1 ~ 255

event_out_preset_home

boolMove PTZ Preset Home after PTZ operation

Move: 1Not-Move: 0

- 104 -


event_name string 31 Event Name

event_id integer Event Map ID

event_out_record boolUsage of recording for that Event

Use: 1Not-Use: 0

* event_out_day_night boolUsage of Day&Night Control by Alarm Input Event

[Model_B]Use: 1Not-Use: 0

event_out_privacy_mask

boolUsage of privacy mask for that Event

Use: 1Not-Use: 0

event_out_event_push boolUsage of event push for that Event

Use: 1Not-Use: 0

event_out_light boolUsage of light for that Event

Use: 1Not-Use: 0

sound_ch int Sum of sound channelSome parameters (*) are available only for the specific devices in Model_B.

(1) Event Map Operations (method): rwThere are 3 event map operations, add, modify and remove. The add operation of event map with app is set needs to be written with event_in_id, event_name, event_in_name, and one of the event out operations.

(2) Usage of PTZ Preset (preset_use): roIf the device is able to control PTZ operation, it is 1. This is not valid in Model_B.

(3) Event Out SMTP E-Mail Address (event_out_smtp_list#): roThese are the E-Mail addresses which are defined in the Event Out-SMTP.

(4) Event In ID List (event_in_id_list#): roThese are returned when the method is add and app is get. This shows available list of event_in_id in the device.

(5) Event In ID (event_in_id): roWhenever the operation is requested with set value of app parameter, the request MUST be written with event_in_id value. To get available event_in_id from the

- 105 -


device, the request ‘method=add’ and ‘app=get’ MUST be executed. This parameter is not used in the case of ‘method=add’ and ‘app=get’.

(6) Event In Name List (event_in_name_list#): roThese are Event In Type Names. This parameter is used in the return value when the ‘method=add’ and ‘app=get’.

(7) Event In Name (event_in_name): roThis is Event In Type Name. It is not used in the case of ‘method=add’ and ‘app=get’.

(8) Number of Available Event In (event_in_cnt): roThis is the number of available event inputs.

(9) Sending Event E-Mail to the Address (event_out_smtp_en#): rwThis is to set sending event e-mail to the address number or not.

(10) E-Mail Message Title (event_out_smtp_title): rwThis is the event e-mail message title to send.

(11) E-Mail Message (event_out_smtp_msg): rwThis is the event e-mail message to send.

(12) Usage of Event Alarm Out (event_out_alarm): rwThis is to set alarm out for the event or not.

(13) Usage of Event Out FTP (event_out_ftp): rwThis is to set FTP activation for the event or not.

(14) Usage of Event Out HTTP Notification (event_out_http): rwThis is to set sending HTTP notification message for the event or not.

(15) Event Out HTTP Notification Message (event_out_http_msg): rwThis is the event notification message to send HTTP notification server.

(16) Event Out SMTP (event_out_smtp): rw

- 106 -


This is to set the event notification by SMTP.

(17) Event Out Audio (event_out_audio): rwThis is to set audio playing for the event or not.

(18) Event Out Audio Playing File Number (event_out_audio_file): rwIt is possible to upload audio files up to 3. This is the number of audio file to play when event happens.

(19) Event Out PTZ Preset Move (event_out_preset): rwThis is to set PTZ move when the event happens or not.

(20) PTZ Preset ID to Move (event_out_preset_num): rwThis is the preset ID to move when the event happens. It is valid when the event_out_preset is enabled.

(20) PTZ Move to the Home Position (event_out_preset_home): rwThis is to move the PTZ predefined home position after dwell time.

(21) Event Name (event_name): rwThis is the event name.

(22) Event ID (event_id): roThis is the unique ID of the event map. This is generated by the device.

(23) Event Out Recording (event_out_record): rwThis is to set recording in external storage for the event or not.

(24) Day & Night Control by Alarm Input Port (event_out_day_night): rwThis is to set day and night transition when the alarm input event happens or not.

(25) Usage of privacy mask for that Event (event_out_privacy_mask): rwThis is to set privacy mask for the event or not.

(26) Usage of event push for that Event (event_out_event_push): rwThis is to set event push for the event or not.

- 107 -


(27) Usage of light for that Event (event_out_light): rwThis is to set light for the event or not.

(28) Sum of current supported sound channels (sound_ch): ro

3-3-14. Event In - PIR

Example: Request of getting event in-PIR parameters and valueshttp://< ipcam>/event/pir.php?app=get

Example: Response of getting event in-PIR parameters and valuesres=200&pir_enable=0&pir_level=5&pir_time=3

[Table 47] Parameters of pir.php

Name TypeLengt

hDescription Value

pir_enable boolEnable/Disable PIR Enable: 1

Disable: 0pir_level integer PIR detection level 1 ~ 10

pir_time integerDwell time of PIR 1 ~ 180

Seconds

(1) Enable/Disable PIR (pir_enable): rwThis is to enable/disable PIR.

(2) PIR detection level (pir_level): rw

(3) Dwell Time of PIR (pir_time): rwThis is valid when then pir event is enabled.

3-3-15. Event In – Audio Detection

Example: Request of getting event in-audio detection parameters and valueshttp://< ipcam>/event/audio_detection.php?app=get

- 108 -


Example: Response of getting event in-audio detection parameters and valuesres=200&audio_detection_enable=0&audio_detection_level=5&audio_detection_time=3

[Table 48] Parameters of pir.php

Name TypeLengt

hDescription Value

audio_detection_enable

boolEnable/Disable audio detection

Enable: 1Disable: 0

audio_detection_level integer Audio detection level 1 ~ 10

audio_detection_time integerDwell time of audio detection

1 ~ 180 Seconds

(1) Enable/Disable Audio Detection (audio_detection_enable): rwThis is to enable/disable Audio Detection.

(2) Audio Detection Level (audio_detection_level): rw

(3) Dwell time of Audio Detection (audio_detection_time): rwThis is valid when then audio detection event is enabled.

3-3-16. Event Out – Light

Example: Request of getting event out-light parameters and valueshttp://<videoserver>/event/light.php?app=get

Example: Response of getting event out-light parameters and valuesres=200&light_enable=0&light_level=5

[Table 49] Parameters of light.php

Name TypeLengt

hDescription Value

light_enable boolEnable/Disable light Enable: 1

Disable: 0

- 109 -


light_level integer Light brightness 1 ~ 10

(1) Enable/Disable light (light_enable): rwThis is to enable/disable light control.

(2) Light brightness (light_level): rw

3-3-17. Event Out – Event Push

When an event is occurred, the device is able to notify to the server. The server requests RTSP/RTP streaming for the device.

Example: Request of getting event out-event push parameters and valueshttp://<videoserver>/event/event_push.php?app=get

Example: Response of getting event out-event push parameters and valuesres=200&event_push_enable=1&event_push_pre_time=10&event_push_post_time=10&event_push_server=192.168.34.199&event_push_port=9000&event_push_user=admin&event_push_pass=admin&

[Table 50] Parameters of event_push.php

Name TypeLengt

hDescription Value

event_push_enable boolEnable/Disable event push

Enable: 1Disable: 0

event_push_pre_time integerPre-event event push time

0 ~ 10

event_push_post_time

integerPost-event event push time

0 ~ 60

event_push_server string 63 event push server URLevent_push_port integer 5 event push server port 1 ~ 65535event_push_user string 31 event push server user

event_push_pass string 31event push server password

(1) Enable/Disable event push (event_push_enable): rw

- 110 -


This is to enable/disable event push.

(2) Pre-event event push time (event_push_pre_time): rwThis is to set the pre-event event push time.

(3) Post-event event push time (event_push_post_time): rwThis is to set the post-event event push time.

(4) Event push server URL (event_push_server) : rwThis is to set the URL of event push server.

(5) Event push server port (event_push_port) : rwThis is to set the port of event push server.

(6) Event push server user (event_push_user) : rwThis is to set user account of event push server.

(7) Event push server password (event_push_pass) : rwThis is to set user password of event push server.

3-4. Device

Some devices which have PTZ/RS-485 have options to select the PTZ which is connected with the device and RS485 settings to communicate with other devices.

3-4-1. Device – PTZ

Example: Request of getting ptz parameters and valueshttp://<videoserver>/device/ptz.php?app=get

Example: Response of getting ptz parameters and valuesres=200&ptz_count=1&ptz1_enable=0&ptz1_protocol=0&ptz1_device=1&

[Table 51] Parameters of ptz.phpName Type Lengt Description Value

- 111 -


hptz_count integer Number of PTZ devices

ptz#_enable boolEnable/Disable PTZ device of the specified channel

Enable: 1Disable: 0

ptz#_protocol integerPTZ protocol value of the specified channel

0 ~ 10*[Table 52]

ptz#_device integerPTZ protocol ID of the specified channel

1 ~255

[Table 52] PTZ Protocols and ValuesValu

eProtocol Name Model_A/C Model_B

0 CDC2400 (DYNACOLOR) O1 D-PROTOCOL (PELCO) O O2 FASTRAX-II O O3 HDC-655 (HONEYWELL) O4 KTD-312 (KALATEL) O5 MINITRAX O6 MRX-1000 (SMASUNG) O7 P-PROTOCOL (PELCO) O O8 PIH-717 (LINLIN) O9 SMASUNG DOME (SMASUNG) O

10 SPECTRA DOME (PELCO) O11 VISTA-RS485 (NORBAIN) O O12 FASTRAX-IIE (HITRON) O O13 PHILIPS (PHILIPS) O O14 S 422 (SENSORMATIC) O O

(1) Number of PTZ devices (ptz_count): roThis is the number of PTZ device which the device has.

(2) Enable PTZ Device for the Channel (ptz#_enable): rwThis is to enable/disable the ptz device for the specified channel.

- 112 -


(3) PTZ Protocol Values for the Channel (ptz#_protocol): rwThis is the ptz protocol value for the specified channel.

(4) PTZ Device ID for the Channel (ptz#_device): rwThis is the ptz device ID for the specified channel.

3-4-2. Device - RS485

Some devices have RS485 for serial communication with other devices.

Example: Request of getting RS485 parameters and values (Model_A)http://<videoserver>/device/rs485.php?app=get

Example: Request of getting RS485 parameters and values (Model_B)http://<ipcam>/system/ rs485.php?app=get

Example: Response of getting RS485 parameters and values (Model_A/B)res=200&rs485_use=ptz&rs485_rate=9600&rs485_data=8&rs485_parity=0&rs485_stop=1

[Table 53] Parameters of rs485.php

Name TypeLengt

hDescription Value

NOTERS485 EIA-485 only specifies electrical characteristics of the driver and the receiver. It does not specify or recommend any data protocol. EIA-485 enables the configuration of inexpensive local networks and multidrop communications links. It offers high data transmission speeds (35 Mbit/s up to 10 m and 100 kbit/s at 1200 m). Since it uses a differential balanced line over twisted pair (like EIA-422), it can span relatively large distances (up to 4000 feet or just over 1200 meters).

- 113 -


rs485_use string 10 Use of the RS485 ptz

rs485_rate integer

Bit per second of the RS485 (Baudrate)

2400,4800,9600 (default),19200,38400,57600,115200

rs485_data integerData bits of the RS485 7,

8 (default)

rs485_stop integerStop bits of the RS485 1 (default),

2

rs485_parity integerParity of the RS485 NONE: 0

ODD: 1EVEN: 2

(1) Use of the RS485 (rs485_use): rwThis string is the use of the RS485. The Model_A supports RS485 for PTZ connection.

(2) Baudrate of the RS485 (rs485_rate): rwThis is the baudrate of the RS 485 (bps).

(3) Data bits of the RS485 (rs485_data): rwThis is the data bits of the RS485.

(4) Stop bits of the RS485 (rs485_stop): rw This is the stop bits of the RS485.

(5) Parity of the RS485 (rs485_parity): rwThis is the parity of the RS485.

3-4-3. Device – LED

Example: Request of getting LED parameters and valueshttp://<ipcam>/device/led_control.php?app=get

- 114 -


Example: Response of getting LED parameters and valuesres=200&led_enable=0

[Table 54] Parameters of ptz.php

Name TypeLengt

hDescription Value

led_enable bool Enable/Disable LEDEnable: 1Disable: 0

(1) LED Control (led_enable): rwThis is to turn on/off LED.

3-5. System

3-5-1. Security – Users

The Security – Users is to prevent unauthorized use of the product, it supports multi-user password protection. The maximum number of user for registering is dependant on the product model. The Model_B supports 20 users and the Model_A does 10 for registering. And both devices accept 10 connections at the same time.

Example: Request of getting user parameters and values (Model_A)http://<videoserver>/system/user.php?app=get

Example: Response of getting user parameters and values (Model_A)res=200&anonymous=1&ptz_use=1&user_count=1&list=admin|3|1

Example: Request of getting user parameters and values (Model_B)http://<ipcam>/system/user.php?app=get

Example: Response of getting user parameters and values (Model_B)res=200&anonymous=1&count=1&list=admin|3|0

Example: Request of getting user parameters and values (Model_C)

- 115 -


http://<ipcam>/system/user.php?app=get

Example: Response of getting user parameters and values (Model_C)res=200&anonymous=1&security=1&ptz_use=1&user_count=1&list=admin|3|1

[Table 55] Parameters of user.php

Name TypeLengt

hDescription Value

anonymous boolEnable/Disable anonymous user access

Enable: 1Disable: 0

ptz_use boolWhich device uses PTZ or not

*Use: 1Not Use: 0

user_count integer

Number of registered users

[Model_A]1 ~ 10[Model_B]1 ~ 20

list string List of registered users *[Table 56]

method string 6Add/Modify/Remove user to (from) list

add,modify,remove

user string 14 User IDpass string 14 Password

level integer

Authority of accessing level

guest: 1operator: 2administrator: 3

ptz_enable boolEnable/Disable ptz accessing authority to the user

Enable: 1Disable: 0

security boolEnable/Disable WS-security

Enable: 1Disable: 0

[Table 56] List of registered userssyntax <userid_1>|<level_1>|<PTZ_access_1>\n

<userid_2>|<level_2>|<PTZ_access_2>\n

- 116 -


…<userid_n>|<level_n>|<PTZ_access_n>\n

example admin|1|1\nuser2|2|0\nuser2|3|1\nexample user_count=3

(1) Enable Anonymous Access (anonymous): rwThis is to enable/disable anonymous access to the live view page and stream. If it is disabled, device requests the user id and password to access the live view page and stream. Otherwise, anyone can access the live view page and stream without any user confirmation procedure.(2) Usage of PTZ (ptz_use): roThis is to show the device has PTZ or not. This parameter is dependant on the product model. The Model_B doesn’t use this parameter.

(3) Number of Registered Users (user_count): rwThis is total number of registered users. Because the administrator id, ‘admin’ is not allowed to be removed/modified, it MUST be larger or equal than 1. This value is used to confirm and parse the list of registered users.

(4) Registered Users List (list): rwThis is the list of registered user. The [Table 56] shows the syntax of list and example.One user object is consisted of <user id>, <user level>, <ptz authority>. And each user object is delimited by new line character ‘\n’- (0x0D 0xDA).

(5) Method: Add/Modify/Remove User (method): rwThere are methods to add, modify and remove user to and from list.

NOTECR, LF Systems based on ASCII or a compatible character set use either LF (Line feed, 0x0A, 10 in decimal) or CR (Carriage return, 0x0D, 13 in decimal) individually, or CR followed by LF (CR+LF, 0x0D 0x0A); see below for the historical reason for the CR+LF convention.

- 117 -


Example: Request of addition one user to the list (Model_A)http://<videoserver>/system/user.php?app=set&method=add&user=user_a&pass=1111&level=2&ptz_enable=1

Example: Request of modification the user from the list (Model_A)http://<videoserver>/system/user.php?app=set&method=modify&user=user_a&pass=2222&level=1&ptz_enable=0

Example: Request of removal the user from the list (Model_A)http://<videoserver>/system/user.php?app=set&method=remove&user=user_a

(6) User ID (user): rwThis is the user id to add/modify/remove. It is valid with method parameter. The method parameters MUST be used with this parameter.

(7) Password (pass): rwThis is the user password to add/modify the user. It is valid with add and modify method parameter. These methods MUST be used with this parameter.

(8) Authority Level (level): rwThis is the user level. The device supports 3 authority levels. The user who has administrator level can access the all settings and functions. The user who has operator level can access the live view and some settings except system. The user who has guest level can access the live view. The Model_A has ptz control authority.

(9) Enable PTZ Accessing Authority to the User (ptz_enable): rwThis is used to give the PTZ control authority to user. The Model_A has this option in adding and modifying user information. These methods MAY have this option.

(10) Enable WS-security (security)This is to enable/disable WS-security for ONVIF. This is available only for some Model_C.

- 118 -


3-5-2. Security – HTTPS

This to select the way which the user accesses the device using web browser encrypted communication.

Example: Request of getting https parameter and value (Model_A)http://<videoserver>/system/https.php?app=get

Example: Response of getting https parameter and value (Model_A)res=200&https_mode=2&http_port=80&https_port=443&private_cert_name=server.pem&private_cert_time=2009-10-08 11:12:06

[Table 57] Parameters of user.php

Name TypeLengt

hDescription Value

https_mode integerHTTP/HTTPS mode http: 0

https: 1http&https: 2

http_port integer HTTP Port Number 80 (default)https_port integer HTTPS Port Number 443 (default)

private_cert_name stringPrivate Certificate File Name

private_cert_time stringPrivate Certificate File Uploading Time

private_cert_file stringPrivate Certificate File Path Name

method stringUpdate or Remove Certificate File

update,remove

(1) HTTP Connection Mode (https_mode): rwThis is to select connection mode among http, https and http&https. The main idea of HTTPS is to create a secure channel over an insecure network.

(2) HTTP Port Number (http_port): roThis is the port number to connect by HTTP. The default value is 80.

- 119 -


(3) HTTPS Port Number (https_port): roThis is the port number to connect by HTTPS. The default value is 443.

(4) Private Certification File Name (private_cert_name): roThis is the private certificate file name using now.

(5) Private Certification File Uploading Time (private_cert_time): roThis is the private certificate file uploading time

(6) Private Certification File Path Name (private_cert_file): rwThis is the private certificate file path name to upload. This is the form name of https.php web page.

(7) Private Certificate File Operation (method): rwThere are two operations of private certificate file, update and remove. The update is to upload the certificate file from PC to device. The remove is to remove the private certificate file from the device.

(8) Private Certificate File Uploading (crtpupload.php)This page MUST be called after setting the private certificate file (private_cert_file) selected to upload.

Example: Request of uploading private certificate file form PC to device (Model_A)http://<videoserver>/system/crtupload.php?app=set&method=update

Example: Response of getting https parameter and value (Model_A)res=200

- 120 -


3-5-3. Security – IP Filtering

The IP filtering is one kind of firewall. The Security - IP Filtering is to define packets from some IP address ranges or specific IP address to be allowed accessing or denied.

Example: Request of getting IP filtering parameters and values (Model_A)http://<videoserver>/system/filtering.php?app=get

Example: Response of getting IP filtering parameters and values (Model_A)res=200&ipfilter_enable=0&ipfilter_count=5&ipfilter1_enable=0&ipfilter1_policy=0&ipfilter1_startip=0.0.0.0&ipfilter1_endip=0.0.0.0&ipfilter2_enable=0&ipfilter2_policy=0&ipfilter2_startip=0.0.0.0&ipfilter2_endip=0.0.0.0&ipfilter3_enable=0&ipfilter3_policy=0&ipfilter3_startip=0.0.0.0&ipfilter3_endip=0.0.0.0&ipfilter4_enable=0&ipfilter4_policy=0&ipfilter4_startip=0.0.0.0&ipfilter4_endip=0.0.0.0&ipfilter5_enable=0&ipfilter5_policy=0&ipfilter5_startip=0.0.0.0&ipfilter5_endip=0.0.0.0&

[Table 58] Parameters of filering.php

Name TypeLengt

hDescription Value

ipfilter_enable boolEnable/Disable IP filtering function

Enable: 1Disable: 0

ipfilter_count integer Number of IP filtering 5

NOTEPrivate Certificate File .PEM In cryptography, a public key certificate (or identity certificate) is a certificate which uses a digital signature to bind together a public key with an identity. The certificate can be used to verify that a public key belongs to an individual. Privacy Enhanced Mail (PEM), is an early IETF proposal for securing email using public key cryptography. Although PEM became an IETF proposed standard it was never widely deployed or used. These can be a personal certificate or a Certificate Authority certificate.

- 121 -


groups (ranges)

ipfilter#_enable boolEnable/Disable IP filtering for the specified group (range)

Enable: 1Disable: 0

ipfilter#_policy integerPolicy (Allow/Deny access) for the specified group (range)

ALLOW: 1DENY: 0

ipfilter#_startip string 15Start IP address for the specified group (range)

ipfilter#_endip string 15End IP address for the specified group (range)

(1) Enable IP Filtering (ipfilter_enable): rwThis is to enable/disable IP Filtering function of the device. The other parameters are valid when this is enabled.

(2) Number of IP Filtering Groups (Ranges) (ipfilter_count): roThis is total number of IP filtering groups (ranges) to control.

(3) Enable IP Filtering for the Group (Range) (ipfilter#_enable): rwEach group (range) is able to be controlled, enabled or disabled.

(4) Policy for the IP Filtering Group (Range) (ipfilter#_policy): rwThere are two kinds of policy, accept and deny the access. If it is set as ‘DENY (0)’, no connection request is allowed from that IP address range.(5) Start IP Address of the Group (Range) (ipfilter#_startip): rwThis is the start IP address of the group (range) to apply the policy.

(6) End IP Address of the Group (Range) (ipfilter#_endip): rwThis is the end IP address of the group (range) to apply the policy.

3-5-4. Date & Time

This is to set date and time of the device.

- 122 -


Example: Request of getting date and time parameters and values (Model_A)http://<videoserver>/system/time.php?app=get

Example: Response of getting date and time parameters and values (Model_A)res=200&tsyncmode=1&dt=2010-01-06&tm=17:54:21&tzone=26&dst_enable=0&dst_user_enable=0&dst_smonth=3&dst_sweek=1&dst_sdayofweek=0&dst_stm=00:00&dst_emonth=10&dst_eweek=1&dst_edayofweek=0&dst_etm=00:00&dst_tm=0&ntp_server=time.nist.gov&ntp_interval=720&date_format=1&time_format=1

[Table 59] Parameters of time.php

Name TypeLengt

hDescription Value

tsyncmode integerDate and Time synchronization mode

*[Table 60]

dt string 10Current Date/Manual Date to set

tm string 8Current Time/Manual Time to set

tzone integerTime zone 0 ~ 74

*[Table 61]

dst_enable boolEnable/Disable DST (Daylight Saving Time)

Enable: 1Disable: 0

dst_user_enable boolEnable/Disable DST setting by user

Enable: 1Disable: 0

dst_smonth integer DST Start Month 1 ~ 12dst_sweek integer DST Start Week 1 ~ 5dst_sdayofweek integer DST Start day of week 0 ~ 6dst_stm string 5 DST Start Time HH:MMdst_emonth integer DST End Month 1 ~ 12dst_eweek integer DST End Week 1 ~ 5dst_edayofweek integer DST End day of week 0 ~ 6

dst_etm string 5 DST End Time HH:MM

dst_tm integer DST Time Difference 0 ~ 999

- 123 -


(minutes)ntp_server string 63 NTP Server URL

ntp_interval integer

NTP Interval (minutes) 60, 120, 180,360,720 (default),1440

date_format integerDate Format 1:YYYY-MM-DD

2:MM-DD-YYYY3:DD-MM-YYYY

time_format integerTime Format 1: 24 Hours

2: 12 Hours (AM/PM)

[Table 60] Time Synchronization ValueValue Method

1 Synchronize with computer time which is connected with the device2 Synchronize with NTP server, NTP server address is required0 Set manually

[Table 61] Time Zone Value and PropertyValu

eTime Zone City

0 GMT-12:00 International Date Line West1 GMT-11:00 Midway Island, Samoa2 GMT-10:00 Hawaii3 GMT-09:00 Alaska4 GMT-08:00 Pacific Time (US & Canada); Tijuana5 GMT-07:00 Arizona6 GMT-07:00 Chihuahua, La Paz, Mazatlan7 GMT-07:00 Mountain Time (US & Canada)8 GMT-06:00 Central America9 GMT-06:00 Central Time (US & Canada)

10 GMT-06:00 Guadalajara, Mexico City, Monterrey11 GMT-06:00 Saskatchewan12 GMT-05:00 Bogota, Lima, Quito

- 124 -


13 GMT-05:00 Eastern Time (US & Canada)14 GMT-05:00 Indiana (East)15 GMT-04:00 Atlantic Time (Canada)16 GMT-04:00 Caracas, La Paz17 GMT-04:00 Santiago18 GMT-03:30 Newfoundland19 GMT-03:00 Brasilia20 GMT-03:00 Buenos Aires, Georgetown21 GMT-03:00 Greenland22 GMT-02:00 Mid-Atlantic23 GMT-01:00 Azores24 GMT-01:00 Cape Verde Is.25 GMT Casablanca, Monrovia26 GMT Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London27 GMT+01:00 Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna28 GMT+01:00 Belgrade, Bratislava, Budapest, Ljubljana, Prague29 GMT+01:00 Brussels, Copenhagen, Madrid, Paris30 GMT+01:00 Sarajevo, Skopje, Warsaw, Zagreb31 GMT+01:00 West Central Africa32 GMT+02:00 Athens, Beirut, Istanbul, Minsk33 GMT+02:00 Bucharest34 GMT+02:00 Cairo35 GMT+02:00 Harare, Pretoria36 GMT+02:00 Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius37 GMT+02:00 Jerusalem38 GMT+03:00 Baghdad39 GMT+03:00 Kuwait, Riyadh40 GMT+03:00 Moscow, St. Petersburg, Volgograd41 GMT+03:00 Nairobi42 GMT+03:30 Tehran43 GMT+04:00 Abu Dhabi, Muscat44 GMT+04:00 Baku, Tbilisi, Yerevan45 GMT+04:30 Kabul46 GMT+05:00 Ekaterinburg47 GMT+05:00 Islamabad, Karachi, Tashkent

- 125 -


48 GMT+05:30 Chennai, Kolkata, Mumbai, New Delhi49 GMT+05:45 Kathmandu50 GMT+06:00 Almaty, Novosibirsk51 GMT+06:00 Astana, Dhaka52 GMT+06:00 Sri Jayawardenepura53 GMT+06:30 Rangoon54 GMT+07:00 Bangkok, Hanoi, Jakarta55 GMT+07:00 Krasnoyarsk56 GMT+08:00 Beijing, Chongqing, Hong Kong, Urumqi57 GMT+08:00 Irkutsk, Ulaan Bataar58 GMT+08:00 Kuala Lumpur, Singapore59 GMT+08:00 Perth60 GMT+08:00 Taipei61 GMT+09:00 Osaka, Sapporo, Tokyo62 GMT+09:00 Seoul63 GMT+09:00 Yakutsk64 GMT+09:30 Adelaide65 GMT+09:30 Darwin66 GMT+10:00 Brisbane67 GMT+10:00 Canberra, Melbourne, Sydney68 GMT+10:00 Guam, Port Moresby69 GMT+10:00 Hobart70 GMT+10:00 Vladivostok71 GMT+11:00 Magadan, Solomon Is., New Caledonia72 GMT+12:00 Auckland, Wellington73 GMT+12:00 Fiji, Kamchatka, Marshall Is.74 GMT+13:00 Nuku'alofa

(1) Time Synchronization Method (tysyncmode): rwThis is to set time synchronization method [Table 60]. The devices support synchronization with local PC time and NTP server. And the date and time could be set manually.

(2) Current Date/Date to Set Manually (dt): ro/rwThis is the current date value when it is read. If the time synchronization method is

- 126 -


manual, the request to set date MUST be written with this. The date format is YYYY-MM-DD. Otherwise, it works read only for current date.

(3) Current Time/Time to Set Manually (tm): ro/rwThis is the current time value when it is read. If the time synchronization method is manual, the request to set time MUST be written with this. The time format is hh:mm:ss. Otherwise, it works read only for current time.

(4) Time Zone (tzone): rwThis is the value of time zone.

(5) Enable DST (Daylight Saving Time) (dst_enable): rwThis is to enable/disable DST. If is enabled and dst_user_enable is disabled, DST is applied by the world wide using.

(6) Enable User Defining DST (dst_user_enable): rwThis is to enable/disable user defining DST. It is valid when the dst_enable is enabled.If this is enabled, below parameters are needed to specify the user defining DST time.

(7) DST Start Month for User Defining (dst_smonth): rwThis is the DST Start Month. The value 1 means January. And value 12 means December.

(8) DST Start Week for User Defining (dst_sweek): rwThis is the DST start week for user defining.

(9) DST Start Day of Week for User Defining (dst_sdayofweek): rwThis is the start day of week for user defining DST. The value 1 means Sunday. And the 7 means Saturday.

(10) DST Start Time for User Defining (dst_stm): rwThis is the DST start time for user defining. The format of time is hh:mm.

(11) DST End Month for User Defining (dst_emonth): rw

- 127 -


This is the DST end month. The value 1 means January. And value 12 means December.

(12) DST End Week for User Defining (dst_eweek): rwThis is the DST end week for user defining.

(13) DST End Day of Week for User Defining (dst_edayofweek): rwThis is the end day of week for user defining DST. The value 1 means Sunday. And the 7 means Saturday.

(14) DST End Time for User Defining (dst_etm): rwThis is the DST end time for user defining. The format of time is hh:mm.

(15) DST Time Difference for User Defining (dst_tm): rwThis is the DST time difference for user defining. The value is minutes.

(16) NTP Server Address for NTP Time Synchronization (ntp_server): rwThis is the URL address to synchronize time. This is valid when the time synchronization method is NTP server.

(17) NTP Accessing Interval for NTP Time Synchronization (ntp_interval): rwThis is the time interval to access the NTP server.

(18) Date Format (date_format): rwThis is the representation of date format.

(19) Time Format (time_format): rwThis is the representation of time format.

[Table 62] Date & Time Format Parameters and ValuesValue Date Format Time Format

1 YYYY-MM-DD 24 Hours2 MM-DD-YYYY 12 Hours AM/PM3 DD-MM-YYYY N/A

- 128 -


3-5-5. Network – Basic

The network configurations are consisted of basic and extra network control functions. The network configuration options are dependant on the product model. For example, the Model_A supports IPv6 but Model_B doesn’t.

Example: Request of getting network parameters and values (Model_A)http://<videoserver>/system/network.php?app=get

Example: Response of getting network parameters and values (Model_A)res=200&net_dhcp=0&net_ip=192.168.34.98&net_mask=255.255.255.0&net_gateway=192.168.34.1&net_ipv6=0&net_ipv6addr=fe80::aede:48ff:fedd:1523/64&dns_dhcp=0&dns_domain=&net_dns=168.126.63.1&net_dns2=0.0.0.0&http_port=80&https_port=443&rtsp_port=554&net_arp=1&net_hostname=TCUBENACDE48DD1523&gateway_priority=0

Example: Request of getting network parameters and values (Model_B)http://<ipcam>/system/network.php?app=get

Example: Response of getting network parameters and values (Model_B)res=200&net_dhcp=0&net_ip=192.168.90.210&net_mask=255.255.255.0&net_gateway=0.0.0.0&dns_dhcp=0&dns_domain=&net_dns=0.0.0.0&net_dns2=0.0.0.0&net_hostname=NXD-1401M0007D801B232&http_port=80&https_port=443&rtsp_port=554&net_limit=0

[Table 63] Parameters of network.php

Name TypeLengt

hDescription Value

net_dhcp boolEnable/Disable DHCP Enable: 1

Disable: 0net_ip string 15 IPv4 Addressnet_mask string 15 Network Mask Addressnet_gateway string 15 Gateway Addressnet_ipv6 bool Enable IPv6 Address [Model_A]

- 129 -


Enable: 1Disable: 0

net_ipv6addr string 40 IPv6 Address [Model_A]

dns_dhcp boolObtain DNS server via DHCP or not

DHCP: 1Manual: 0

dns_domain string 63 Domain Namenet_dns string 15 Primary DNS Addressnet_dns2 string 15 Secondary DNS Address

http_port integerHTTP Port Number 1 ~ 65535

(Default: 80)

https_port integerHTTPS Port Number 1 ~ 65535

(Default: 443)

rtsp_port integerRTSP Port Number 1 ~ 65535

(Default: 7070)

net_arp boolEnable/Disable ARP/Ping Setting

[Model_A]Enable: 1Disable: 0

net_limit integerMaximum Bandwidth for Traffic Control (kbps)

Default: 0[Model_B]

net_hostname string 127 Host name

geteway_priority intPriority for default gateway

0: wire1: wireless

(1) Obtain IP Address via DHCP (net_dhcp): rwThis is to set IP Address via DHCP or manually. If this is enabled, IP address, Mask address and gateway address are configured by DHCP. There MUST be a DHCP server to set it. The Model_A supports DHCP for IPv6(DHCPv6) (RFC3315).

- 130 -


(2) Network IP Address (net_ip): rwThis is IP address (IPv4) of the device.

(3) Network Mask Address (net_mask): rwThis is network mask address (IPv4) of the device.

(4) Network Gateway Address (net_gateway): rwThis is network gateway address (IPv4) of the device.

(5) Usage of IPv6 (net_ipv6): rwThis is to enable/disable usage of IPv6. The Model_A supports IPv6.

(6) Network IPv6 Address (net_ipv6addr): rwThis is network IPv6 address of the device. The Model_A supports IPv6.

(7) DNS obtain via DHCP (dns_dhcp): rwThis is to set DNS configurations via DHCP or not. If it is enabled, DNS are configured by DHCP.

(8) Domain Name for DNS (dns_domain): rwThis is the domain name to register DNS.(9) Primary DNS Address (net_dns): rwThis is the primary DNS address.

(10) Secondary DNS Address (net_dns2): rwThis is the secondary DNS address.

NOTEDynamic Host Configuration Protocol (DHCP) is a network application protocol used by devices (DHCP clients) to obtain configuration information for operation in an Internet Protocol network. This protocol reduces system administration workload, allowing networks to add devices with little or no manual intervention. (RFC1531, RFC2131, RFC3315)

- 131 -


(11) HTTP Port Number (http_port): rwThis is the port number to connect by HTTP. The default value is 80.

(12) HTTPS Port Number (https_port): rwThis is the port number to connect by HTTPS. The default value is 443.

(13) RTSP Port Number (rtsp_port): rwThis is the RTSP port number to serve RTSP. The default value is 7070.

(14) Enable ARP/Ping Protocol (net_arp): rwThis is to enable/disable ARP/Ping protocol.

(15) Priority of Default Gateway (gateway_priority): rwThis is to set priority of default gateway.

(15) Network Bandwidth Limitation (net_limit): rwThis is to control network maximum bandwidth to be used by the device. If it is 10240 kbps, the device would try not to over the 10Mbps.

(16) Network host name (net_hostname): rw

NOTEAddress Resolution Protocol (ARP) is the method for finding a host's link layer (hardware) address when only its Internet Layer (IP) or some other Network Layer address is known. ARP is defined in RFC 826.[1] It is Internet Standard STD 37.Real Time Streaming Protocol (RTSP) is a network control protocol for use in entertainment and communications systems to control streaming media servers. The protocol is used to establish and control media sessions between end points. Clients of media servers issue VCR-like commands, such as play and pause, to facilitate real-time control of playback of media files from the server.

- 132 -


This is the network host name.

3-5-6. Network – DDNS

The devices provide DDNS protocol.

Example: Request of getting ddns parameters and values (Model_A)http://<videoserver>/system/ddns.php?app=get

Example: Response of getting ddns parameters and values (Model_A)res=200&net_ddns=0&ddns_server=security-device.name&ddns_host=&ddns_user=&ddns_pwd=&ddns_interval=3600&ddns_local=0&ddns_publicip=

Example: Request of getting ddns parameters and values (Model_B)http://<ipcam>/system/ddns.php?app=get

Example: Response of getting ddns parameters and values (Model_B)res=200&net_ddns=0&ddns_server=&ddns_host=&ddns_user=&ddns_pwd=&ddns_interval=0&ddns_local=0

NOTEHostname is a label that is assigned to a device connected to a computer network and that is used to identify the device in various forms of electronic communication such as the World Wide Web, e-mail or Usernet.

NOTEDynamic DNS is a method, protocol, or network service that provides the capability for a networked device, such as a router or computer system using the Internet Protocol Suite, to notify a domain name server to change, in real time (ad-hoc) the active DNS configuration of its configured hostnames, addresses or other information stored in DNS.

- 133 -


[Table 64] Parameters of ddns.php

Name TypeLengt

hDescription Value

net_ddns boolEnable/Disable DDNS Enable: 1

Disable: 0

ddns_server string 63DDNS Server Address URL

cctv-network.co.kr,dyndns.org

ddns_host string 31 Registered Host Nameddns_user string 31 Registered User Nameddns_pwd string 31 Registered Password

ddns_interval integerTime Interval to Re-Register IP address for Host Name (seconds)

600, 1800,3600, 21600,86400

ddns_local boolRegister Local Network IP Address or Not

Register: 1Not-Register: 0

ddns_publicip string 15 Registered IP Address [Model_A]

(1) Enable DDNS (net_ddns): rwThis is to enable/disable DDNS protocol. If this is disabled, the other parameters are not valid.

(2) DDNS Server Address URL (ddns_server): rwThis is the URL of DDNS server.

(3) Host Name for DDNS (ddns_host): rwThis is the registered host name for DDNS.

(4) User ID for DDNS (ddns_user): rwThis is the registered user ID for DDNS.

(5) Password for DDNS (ddns_pwd): rwThis is the registered password for DDNS.

- 134 -


(6) Time Interval to Re-Register IP Address of Host Name (ddns_interval): rwThis is the time interval value (seconds) to re-register IP address of Host Name for DDNS.

(7) Register Local Network IP Address (ddns_local): rwThis is to select which device registers local network IP address for DDNS or not. In the case of private LAN, the device may register gateway address. If this is to be enabled, the IP address of device in private LAN is to be registered.

(8) Registered IP Address (ddns_publicip): roThis is the registered IP address of DDNS.

3-5-7. Network – RTP

The devices transport video/audio stream by RTP. This is the configuration for RTP connection.

Example: Request of getting rtp parameters and values (Model_A)http://<videoserver>/system/rtp.php?app=get

Example: Response of getting rtp parameters and values (Model_A)res=200&rtp_start_port=30000&rtp_end_port=30079&rtp_mcast1_enable=0&rtp_mcast1_ip=231.1.128.20&rtp_mcast1_port=40000&rtp_mcast1_ttl=1&rtp_always_mcast1_enable=0&rtp_mcast2_enable=0&rtp_mcast2_ip=231.1.128.21&rtp_mcast2_port=40006&rtp_mcast2_ttl=1&rtp_always_mcast2_enable=0&

Example: Request of getting rtp parameters and values (Model_B)

NOTEReal-time Transport Protocol (RTP) defines a standardized packet format for delivering audio and video over the Internet. It was developed by the Audio-Video Transport Working Group of the IETF and first published in 1996 as RFC 1889, and superseded by RFC 3550 in 2003.

- 135 -


http://<ipcam>/system/rtp.php?app=get

Example: Response of getting rtp parameters and values (Model_B)res=200&rtp_start_port=5008&rtp_end_port=51000&rtp_mcast1_enable=0&rtp_mcast1_ip=231.1.128.20&rtp_mcast1_port=40000&rtp_mcast1_ttl=1&rtp_mcast2_enable=0&rtp_mcast2_ip=231.1.128.21&rtp_mcast2_port=40006&rtp_mcast2_ttl=1

Example: Request of getting rtp parameters and values (Model_C)http://<videoserver>/system/rtp.php?app=get

Example: Response of getting rtp parameters and values (Model_C)res=200&rtp_start_port=30000&rtp_end_port=30079&rtp_mcast1_enable=0&rtp_mcast1_ip=231.1.128.20&rtp_mcast1_port=40000&rtp_mcast1_ttl=1&rtp_always_mcast1_enable=0&rtp_mcast2_enable=0&rtp_mcast2_ip=231.1.128.21&rtp_mcast2_port=40006&rtp_mcast2_ttl=1&rtp_always_mcast2_enable=0&

[Table 65] Parameters of rtp.php

Name TypeLengt

hDescription Value

rtp_start_port integerStart Port Number of RTP Port Range

*[Table 66] Even values

rtp_end_port integerEnd Port Number of RTP Port Range

rtp_mcast#_enable boolEnable/Disable RTP Multicast of the specified channel

Enable: 1Disable: 0

rtp_mcast#_ip string 15Multicasting IP Address of the specified channel

*[Table 66]Even values

rtp_mcast#_port integerMulticasting Port Number of the specified channel

rtp_mcast#_ttl integerTTL of Multicasting of the specified channel

rtp_always_mcast#_ena bool Enable/Disable RTP Enable: 1

- 136 -


bleAlways Multicast of the specified channel

Disable: 0

[Table 66] RTP Port RangesParameter Model_A Model_B Model_C

Port Range 30000 ~ 39920

1024 ~ 65532 30000 ~ 39920

Default 30000 ~ 30079

5008 ~ 51000 30000 ~ 30079

Multicast Destination IP 231.1.128.20 231.1.128.20 231.1.128.20Multicasting Port Range 1024 ~ 65530 1024 ~ 65532 1024 ~ 65530Multicasting RTP Port 40000 5000 40000Multicasting TTL Range 1~255 1~255 1~255

(1) RTP Start Port Number (rtp_start_port): rwThis is the starting port number of RTP range.

(2) RTP End Port Number (rtp_end_port): rwThis is the ending port number of RTP range.

(3) Enable RTP Multicast of the Channel (rtp_mcast#_enable/rtp_mcast): rwThis is to enable/disable RTP multicasting for the specified channel (video source).

(4) Multicasting IP Address of the Channel (rtp_mcast#_ip): rwThis is the multicasting destination IP address of the specified channel.

(5) Multicasting Port Number of the Channel (rtp_mcast#_port): rwThis is the multicasting port number of the channel.

(6) TTL for Multicasting (rtp_mcast#_ttl): rwThis is the TTL value of multicasting.

(7) Enable RTP Always Multicast of Channel (rtp_always_mcast#_enable): rwThis is to enable/disable RTP always multicasting for the specified channel (video &audio source).

- 137 -


3-5-8. Network – UPnP

The devices support UPnP (Universal Plug and Play).

Example: Request of getting upnp parameters and values (Model_A)http://<videoserver>/system/upnp.php?app=get

Example: Response of getting upnp parameters and values (Model_A)res=200&rtp_start_port=30000&rtp_end_port=30079&rtp_mcast1_enable=0&rtp_mcast1_ip=231.1.128.20&rtp_mcast1_port=40000&rtp_mcast1_ttl=1&rtp_mcast2_enable=0&rtp_mcast2_ip=231.1.128.21&rtp_mcast2_port=40006&rtp_mcast2_ttl=1

Example: Request of getting upnp parameters and values (Model_B)http://<ipcam>/system/upnp.php?app=get

NOTETime to live (sometimes abbreviated TTL) is a limit on the period of time or number of iterations or transmissions in computer and computer network technology that a unit of data (e.g. a packet) can experience before it should be discarded.

NOTEUniversal Plug and Play (UPnP) is a set of networking protocols promulgated by the UPnP Forum. The goals of UPnP are to allow devices to connect seamlessly and to simplify the implementation of networks in the home (data sharing, communications, and entertainment) and in corporate environments for simplified installation of computer components. UPnP achieves this by defining and publishing UPnP device control protocols (DCP) built upon open, Internet-based communication standards.

- 138 -


Example: Response of getting upnp parameters and values (Model_B)res=200&net_upnp=1&friendly_name=Model_BN-0007D800F2E3

Example: Request of getting rtp parameters and values (Model_C)http://<videoserver>/system/rtp.php?app=get

Example: Response of getting rtp parameters and values (Model_C)res=200&rtp_start_port=30000&rtp_end_port=30079&rtp_mcast1_enable=0&rtp_mcast1_ip=231.1.128.20&rtp_mcast1_port=40000&rtp_mcast1_ttl=1&rtp_mcast2_enable=0&rtp_mcast2_ip=231.1.128.21&rtp_mcast2_port=40006&rtp_mcast2_ttl=1

[Table 67] Parameters of upnp.php

Name TypeLengt

hDescription Value

net_upnp boolUsage of UPnP Use: 1

Not-Use: 0

friendly_name string 31Friendly name for UPnP <MODEL>-

<MAC>

(1) Usage of UPnP (net_upnp): rwThis is to set use of UPnP or not.

(2) Friendly Name for UPnP (fiendly_name): rwThis is the string of friendly name for UPnP.

3-5-9. Network – QoS

The QoS control mechanisms are dependant on the product model.

Example: Request of getting qos parameters and values (Model_A)http://<videoserver>/system/qos.php?app=get

Example: Response of getting qos parameters and values (Model_A)res=200&dscp_stream=0&dscp_event=0&dscp_management=0&net_ctrl_enable=0

- 139 -


&net_ctrl_mode=1&control_method=2&net_limit=1024

Example: Request of getting qos parameters and values (Model_B)http://<ipcam>/system/qos.php?app=get

Example: Response of getting qos parameters and values (Model_B)res=200&dscp_stream=0&dscp_event=0

[Table 68] Parameters of qos.php

Name TypeLengt

hDescription Value

dscp_stream integer Live Stream DSCP 0 ~ 63dscp_event integer Event/Alarm DSCP 0 ~ 63

dscp_management integerManagement DSCP [Model_A]

0 ~ 63

net_ctrl_enable boolEnable/Disable Automatic Network Traffic Control

[Model_A]Enable: 1Disable: 0

net_ctrl_mode integerNetwork Traffic Control Mode

[Model_A]*[Table 69]

control_method integerNetwork Traffic Control Method to Match Maximum Bandwidth

net_limit integerMaximum Network Bandwidth (kbps)

(1) Live Stream DSCP (dscp_stream): rwThis is the value of DSCP for live stream.

NOTEDifferentiated Services Code Point (DSCP) is a field in the header of IP packets for packet classification purposes. (RFC2474)

- 140 -


(2) Event/Alert DSCP (dscp_event): rwThis is the value of DSCP for event stream, HTTP event notification and event alert stream.

(3) Management DSCP (dscp_management): rwThis is the value of DSCP for management, control and setup.

(4) Enable Automatic Network Traffic Control (net_ctrl_enable): rwThis is to enable/disable automatic network traffic control.

(5) Network Traffic Control Mode (net_ctrl_mode): rwThis is the network traffic control mode. There are two ways of network traffic control modes. One is to keep the maximum network bandwidth. The other is to be controlled by network client. The network client can control the encoding framerate by RTSP SET_PARAMETER and GET_PARAMETER commands.

Example: Control framerate by the RTSP SET_PARAMETER commandSET_PARAMETER rtsp://192.168.12.198:7070 RTSP/1.0CSeq: 10Content-Type: text/parametersSession: 1047002337Authorization: Basic cm9vdDpyb290

framerate: 15

(6) Network Traffic Control Method (control_method): rwThis is the way of network traffic control to keep the maximum network bandwidth. There are 3 ways to control. The first is to control the encoding bitrate. The device tries to decrease the encoding bitrate to keep the network bandwidth. The second is to control the framerate. And the third is use both ways. The device controls the encoding bitrate or framerate automatically.

(7) Maximum Network Bandwidth (net_limit): rwThis is the maximum network bandwidth to keep.

- 141 -


[Table 69] Automatic Network Traffic Control Methodnet_ctrl_mod

econtrol_method

Description

MaximumBandwidth(value=1)

Bitrate Control(value=1)

To keep the maximum network bandwidth (net_limit), the device controls encoding bitrate.

Framerate Control(value=2)

To keep the maximum network bandwidth (net_limit), the device controls encoding framerate.

Bitrate &Framerate Control(value=3)

To keep the maximum network bandwidth (net_limit), the device controls encoding bitrate and framerate together.

Automatic Framerate Control(value=2)

Controlled by client(N/A)

The framerate is controlled by handshaking with network client.(net_limit = N/A)

3-5-10. Network - NAT Traversal

This is to configure NAT traversal function on device. This requires UPnP function and NAT supporting gateway.

Example: Request of getting NAT traversal parameters and values (Model_A)http://<videoserver>/system/nat.php?app=get

Example: Response of getting NAT traversal parameters and values (Model_A)res=200&enable_nat=0&nat_auto=1&nat_port=10000&nat_address=

[Table 70] Parameters of nat.php

Name TypeLengt

hDescription Value

enable_nat boolEnable/Disable NAT Traversal Function

Disable: 0 Enable: 1

nat_auto bool Automatic/Manual NAT Automatic: 1

- 142 -


Traversal Manual: 0

nat_port integerNAT Traversal Port Number

1024 ~ 65535

nat_address StringResolved IP Address and Port Number

(1) Enable/Disable NAT Traversal (enable_nat): rwThis is to enable/disable NAT traversal function.

(2) Automatic/Manual NAT Traversal (nat_auto): rwThis is the NAT traversal mode. The automatic mode set the IP address and port number automatically.

(3) NAT Traversal Port Number (nat_port): rwThis is the NAT traversal port number in manual mode.

(4) Resolved IP Address and Port Number (nat_address): roThis is the resolved IP address and port number of NAT traversal result.

[Table 71] Return value of NAT traversalCode Description200 OK459 Port already in use500 NAT traversal fail501 UPnP is not enabled

- 143 -


3-5-11. Maintenance

The device supports maintenance tools that restart device, reset, default, backup and restoration configuration and upgrading the firmware.

(1) RestartIf the device returns the result code is 200 after this request, the device would be restarted and disconnected.

Example: Request of restarting the devicehttp://<videoserver>/system/restart.php?app=set

(2) ResetIf the device returns the result code is 200 after this request, all parameters of device except network values would be changed to the factory default values.

Example: Request of resetting the devicehttp://<videoserver>/system/reset.php?app=set

NOTENAT traversal is a general term for techniques that establish and maintain TCP/IP network and/or UDP connections traversing network address translation (NAT) gateways. NAT traversal techniques are typically required for client-to-client networking applications, especially peer-to-peer and Voice-over-IP (VoIP) deployments. Many techniques exist, but no single method works in every situation since NAT behavior is not standardized. Many techniques require assistance from a computer server at a publicly-routable IP address. Some methods use the server only when establishing the connection (such as STUN), while others are based on relaying all data through it (such as TURN), which adds bandwidth costs and increases latency, detrimental to real-time voice and video communications.

- 144 -


(3) DefaultIf the device returns the result code is 200 after this request, all parameters of device including network values would be changed to the factory default values. So the device MAY not be connected with previous network address. Thus the default network IP address MUST be used to connect the device.

[Table 72] Default Network ParametersIP Address 192.168.30.220Network Mask 255.255.255.0Gateway IP Address 192.168.30.1

(4) BackupThis is to backup all parameters and configurations as a file. The backed up file could be use for restoring.

Example: Request of backup parameters and configurations as a filehttp://<videoserver>/system/backup.cgi?

(5) RestoreThis is to restore configuration to the device from a backed up file. Please consult [RFC2045], [RFC2388] for additional information about file uploads. The content “multipart/form-data” follows the rules of all multipart MIME data streams as outlined in RFC2045. The URL for this is ‘/system/restore.cgi’ and the input name is ‘backupsaveformfile’ and type is ‘file’ with multipart/form-data.

Example: Request of restoring configuration from a filehttp://<videoserver>/system/restore.cgi?app=set

(6) UpgradeThis is to update the firmware version of the device. The URL for this is ‘/system/update.php’ and the input name is ‘fimage’ and the type is ‘file’ with multipart/form-data.

- 145 -


Example: Request of upgrade firmwarehttp://<videoserver>/system/update.php?app=set

3-5-12. Language

This is to select language of HTTP web pages. The change of language would affect the all clients.

Example: Request of getting language parameters and values (Model_A)http://<videosrver>/system/language.php?app=get

Example: Response of getting language parameters and values (Model_A)res=200&language=English&language_list=English|Korean

[Table 73] Parameters of language.php

Name TypeLengt

hDescription Value

language stringSelected Language English

(default)language_list string Available Language List

(1) Selected Language (language): rwThis is the selected language to use.

(2) Available Language List (language_list): roThis is the list of available languages in the device.

3-5-13. Information

WarningThe firmware version MUST be matched with the device. Wrong file or old version MAY not work well with the device.

- 146 -


This is to configure the device name and location information.

Example: Request of getting information parameters and values (Model_A)http://<videosrver>/system/information.php?app=get

Example: Response of getting language parameters and values (Model_A)res=200&device_name=H.264 Network Camera&location1=&location2=&location3=&location4=

[Table 74] Parameters of information.php in Model_A

Name TypeLengt

hDescription Value

device_name string 63User defined device name

(default: model description)

location1,2,3,4 string 63User defined device location information

(1) User defined device name (device_name): rwThis is the user defined device name.

(2) User defined device location information (location1,2,3,4): rwThis is the user defined device location information.

3-5-14. Network - Zeroconf

Zero configuration networking (zeroconf), is a set of techniques that automatically creates a usable Internet Protocol (IP) network without manual operator intervention or special configuration servers

Example: Request of getting user parameters and valueshttp://<ipcam>/ptz/preset.php?app=get

Example: Response of getting user parameters and valuesres=200&zeroconf_enable=1&zeroconf_ip=169.254.242.139

- 147 -

http://en.wikipedia.org/wiki/Internet_Protocol


[Table 75] Parameters of zeroconf.php

Name TypeLengt

hDescription Value

zeroconf_enable boolEnable/Disable zeroconf Enable: 1

Disable: 0zeroconf_ip string Zeroconf IP address 169.254.*.*

(1) Enable/Disable zeroconf (zeroconf_enable) : rwThis is to set use of zeroconf or not.

(2) Zeroconf IP address (zeroconf_ip) : roThis is the IP address for zeroconf

3-5-15. Network - Bonjour

Bonjour is Apple Inc.'s trade name for its implementation of Zeroconf, a group of technologies that includes service discovery, address assignment, and name resolution. Bonjour locates devices such as printers, other computers, and the services that those devices offer on a local network using multicast Domain Name System (mDNS) service records.

Example: Request of getting user parameters and valueshttp://<ipcam>/system/ bonjour.php?app=get

Example: Response of getting user parameters and values res=200&bonjour_enable=1&bonjour_friendly_name=HNS-S113J(NBAR3)-ACDE48DD1036

[Table 76] Parameters of bonjour.php

Name TypeLengt

hDescription Value

bonjour_enable boolEnable/Disable bonjour Enable: 1

Disable: 0bonjour_friendly_name

stringFriendly name for bonjour

- 148 -

http://en.wikipedia.org/wiki/MDNS

http://en.wikipedia.org/wiki/Domain_Name_System

http://en.wikipedia.org/wiki/Domain_Name_System

http://en.wikipedia.org/wiki/Multicast

http://en.wikipedia.org/wiki/Local_area_network

http://en.wikipedia.org/wiki/Service_discovery

http://en.wikipedia.org/wiki/Zeroconf

http://en.wikipedia.org/wiki/Trade_name

http://en.wikipedia.org/wiki/Apple_Inc.


(1) Enable/Disable bonjour (bonjour_enable): rwThis is to set use of bonjour or not.

(2) Friendly Name for bonjour (bonjour_friendly_name): rwThis is the string of friendly name for bonjour.

3-5-16. Network – Live Push

This is to stream RTSP/RTP to the Live Push server. Maximum Live Push server count is 3.

Example: Request of getting live_push parameters and valueshttp://<ipcam>/system/live_push.php?app=get

Example: Response of getting live_push parameters and values res=200&live_push1_enable=1&live_push1_server=192.168.33.44&live_push1_port=80&live_push1_user=111&live_push1_pass=111&live_push2_enable=0&live_push2_server=&live_push2_port=80&live_push2_user=&live_push2_pass=&live_push3_enable=0&live_push3_server=&live_push3_port=80&live_push3_user=&live_push3_pass=&

[Table 77] Parameters of live_push.php

Name TypeLengt

hDescription Value

live_push#_enable

boolEnable/Disable live push Enable: 1

Disable: 0live_push#_server

string

Live push server address

live_push#_port int Live push server port number

live_push#_userstrin

gLive push server server user

live_push#_passstrin

gLive push server server password

(1) Enable/Disable live push (live_push#_enable): rwThis is to set use of live push or not.

- 149 -


(2) Live push server address (live_push#_server): rw

(3) Live push server port number (live_push#_port): rw

(4) Live push server user (live_push#_user): rw

(5) Live push server password (live_push#_pass): rw

3-5-17. Network – Hole Punching

This is to configure Rendezvous server for Hole Punching.

Example: Request of getting hole_punching parameters and valueshttp://<ipcam>/system/hole_punching.php?app=get

Example: Response of getting hole_punching parameters and values res=200&hole_punching_enable=1&hole_punching_server=192.168.33.33&hole_punching_port=80&hole_punching_user=11&hole_punching_pass=11&

[Table 78] Parameters of hole_punching.php

Name TypeLengt

hDescription Value

hole_punching_enable

boolEnable/Disable hole punching Enable: 1

Disable: 0hole_punching_server

string

Rendezvous server address

hole_punching_port intRendezvous server port number

hole_punching_userstrin

gRendezvous server user

hole_punching_passstrin

gRendezvous server password

(1) Enable/Disable hole punching (hole_punching_enable): rwThis is to set use of hole punching or not.

- 150 -


(2) Rendezvous server address (hole_punching_server): rw

(3) Rendezvous server port number (hole_punching_port): rw

(4) Rendezvous server user (hole_punching_user): rw

(5) Rendezvous server password (hole_punching_pass): rw

3-5-18. Network – Wireless

This is to configure wireless network address and AP.

Example: Request of getting wireless parameters and valueshttp://<ipcam>/system/wireless.php?app=get

Example: Response of getting wireless parameters and values res=200&wireless_dhcp=1&wireless_ip=192.168.0.220&wireless_mask=255.255.255.0&wireless_gateway=192.168.0.1&wireless_dns=168.126.63.1

[Table 79] Parameters of wireless.php

Name TypeLengt

hDescription Value

wireless_dhcp intDHCP or manual 1 : DHCP

0 : Manual

wireless_ipstrin

gwireless ip address

wireless_maskstrin

gwireless subnet mask

wireless_gatewaystrin

gwireless gateway ip address

wireless_dnsstrin

gwireless dns ip address

(1) DHCP or manual (wireless_dhcp): rw

- 151 -


(2) Wireless ip address (wireless_ip): rw

(3) Wireless subnet mask (wireless_mask): rw

(4) Wireless gateway ip address (wireless_gateway): rw

(5) Wireless dns ip address (wireless_dns): rw

Example: Request of getting wireless setup parameters and valueshttp://<ipcam>/system/wireless_steup.php?app=get

Example: Response of getting wireless setup parameters and values res=200&wireless_ap_count=9&wireless_ap_list=dv-1|1|74|0|0|WPA,Cube|1|64|0|0|WPA,WPS753fac659c|1|62|0|0|WPA,dv-2|1|48|0|0|WPA,hitron-adsl_3F|1|42|0|0|WPA,Mobile_N804|1|68|0|0|WPA,cloud_wifi|1|26|0|0|WPA2,GomGolf|1|58|0|0|WEP,RnD|0|44|0|0|OPEN,

[Table 80]Parameters of wireless_setup.php

Name TypeLengt

hDescription Value

methodstrin

g

Command for AP disconnect, delete, connect

wireless_ssidstrin

gSelected AP SSID

wireless_passwordstrin

gSelected Password

wireless_ap_count int Searched AP count

wireless_ap_liststrin

gDetails for Searched AP

(1) Command for AP (method): wodisconnect : disconnect to APdelete : delete saved AP passwordconnect : connect to AP

- 152 -


(2) Selected AP SSID (wireless_ssid): rwSelected AP SSID

(3) Selected Password (wireless_password): rwSelected Password

(4) Searched AP count (wireless_ap_count): rw

(5) Details for Searched AP (wireless_ap_list): rwSSID|Security|SignalLevel|Use|Save|Type,SSID|Security|Signal Level|Use|Save|Type,SSID|Security|Signal Level|Use|Save|Type

SSID : AP SSIDSecurity : 0 or 1Signal Level : 1 ~ 100Use : 0(Disconnected AP) or 1(Connected AP)Save : 0(Password not saved), 1(Password saved)Type : Encrption (OPEN, WEP, WPA, WPA2, AD-HOC)

3-6. Live View

This is to configure video out mode in Model_B and video input mode in HEV0118H

3-6-1. Live View for HEV0118H

This is to configure video input mode. The HEV0118H is able to detect the video input mode between NTSC and PAL. But some of cameras MAY not be detected automatically. In the case of that, the video input mode is able to be configured by this.

Example: Request of getting liveview parameters and values (HEV0118H)http://<videoserver>/liveview/source.php?app=get

Example: Response of getting liveview parameters and values (HEV0118)res=200&video_mode=auto

- 153 -


[Table 81] Parameters of source.php in HEV0118H

Name TypeLengt

hDescription Value

video_mode stringVideo input mode auto (default)

ntscpal

reboot integerDetecting video mode change after rebooting

Change:1

(1) Video input mode (video_mode): rwThis is the value of video input mode only for HEV0118H.

(2) Detecting video mode change after rebooting (reboot): rThis would be returned after detecting video mode change when the device is rebooted.

3-6-2. Live View for Model_B

This is to configure video output mode.

Example: Request of getting liveview parameters and values (Model_B)http://<ipcam>/liveview/source.php?app=get

Example: Response of getting liveview parameters and values (Model_B)res=200&tv_mode=ntsc&tv_source=1&tv_seq_source=31&tv_seq_t0=5&tv_seq_t1=5&tv_seq_t2=5&tv_seq_t3=5&tv_seq_t4=5&tv_efocus=0&tv_efocus_t=5

NOTEThe video server, HEV0118H, is able to detect the video input mode between NTSC and PAL when the device boots up. If the video input mode is changed after finishing the booting mode, the video server would be rebooted to operate correctly.

- 154 -


[Table 82] Parameters of source.php in Model_B

Name TypeLengt

hDescription Value

tv_mode string 4 NTSC, PAL

tv_source integerTV out source 1 ~ 6

*[Table 83]

tv_seq_source integerSequential TV Out source

*[Table 84]

tv_seq_t1 integer Timer for Stream 1 3 ~ 3600 (seconds)tv_seq_t2 integer Timer for Stream 2

tv_seq_t3 integer Timer for Stream 3tv_seq_t4 integer Timer for Stream 4

* tv_efocus boolEnable/Disable Easy Focus Mode

Enable: 1Disable: 0

* tv_efocus_t integer Timer for Easy Focus 1 ~ 60Some parameters (*) are available only for the specific devices in Model_B

[Table 83] TV Out Source and Value (tv_source)TV Source Value

(tv_source)Stream 1 1Stream 2 2Stream 3 3Stream 4 4reserved 5Sequence Mode 6

[Table 84] TV Out Sequence Parameter and Value (tv_seq_source)Bit # Description Value (Hex, Dec)

1 Stream 1 0x02, 22 Stream 2 0x04, 43 Stream 3 0x08, 84 Stream 4 0x10, 16

- 155 -


5 ~ 7 Reserved N/A

(1) TV Out Mode (tv_mode): rwThis is one of the TV out modes, NTSC and PAL. This is read only for some devices (ex. HDZ-A411, HDS-A411, HDA-A411F, HDZ-P622, HDS-S422W, ......).

(2) TV Out Source (tv_source): rwThis is the parameter to select TV out source.

(3) TV Out Sequence Mode (tv_seq_source): rwThis is the sequence mode of out going source on TV. If the value is 0x06 means, Stream 1 and Stream 2 are enabled to out on TV.

(4) Timer for Each Sequence Mode (tv_seq_t#): rwThese are timer value for each stream to out going source. The tv_seq0 is the timer value of quad stream mode.

(5) Enable Easy Focus (tv_efocus): rwThe Easy Focus function is activated once when the device is turned on. The Easy focus function helps to reduce the installation efforts especially video image focusing of the camera. If the Easy focus is activated, the new popup window will appears near a little below of center pane. From that window you can easily focus the camera.

(6) Timer for Easy Focus (tv_efocus_t): rwThis is the timer value how long time easy focus is working after booting.

- 156 -


4. Configurations (config.txt)

The device has a text file of configuration. The configuration shows that model, version of the device, various options and others.

Example: URL of Configuration File (Model_A)http://<videoserver>/config.txt

Example: Configuration File (Model_A)ver=1name=HNV3H22D1NSH10007D8BBBBBBipv4=192.168.34.112ipv6=fe80::207:d8ff:febb:bbbb/64device_name=H.264 Network PTZ Camerainput=704x480firmware=2.2.2-releasemodel_type=T1_Amodel=HNV3H22D1NSH1customer=HITRONmodel_customer=HNV3H22D1NSH1mac=0007D8BBBBBBrtsp_port=554http_port=80https_port=443https_mode=2tv_mode=ntsctotal_ch=1total_strm=2ch1_strm1_uri=rtsp://192.168.34.112/1/stream1ch1_strm1_codec=H264BPch1_strm1_res=4CIFch1_strm1_fps=30ch1_strm1_bitrate=2000ch1_strm1_ratecontrol=cbrch1_strm1_gop=30

- 157 -


ch1_strm2_uri=rtsp://192.168.34.112/1/stream2ch1_strm2_codec=JPEGch1_strm2_res=4CIFch1_strm2_fps=30ch1_strm2_quality=50total_snd_ch=1snd1_codec=G711Usnd1_bitrate=64snd1_samplerate=8000snd1_2way_use=0alarm_in=1alarm_out=1onvif_service_uri=http://192.168.34.112/onvif/device_servicemobile-stream=stream2options=BNC ALARM_IN ALARM_OUT HW_RESET LED VMD PTZ BUILTIN_PTZ FTP SMTP MULTI_STREAM MULTI_CODEC SSL MANUAL_TRIGGER IP_FILTER DDNS UPNP ONBOOT AUD AUD_ALERT ONVIF HTTP_NOTIFY NETWORK_LOSS

Example: URL of Configuration File (Model_B)http://<ipcam>/config.txt

Example: Configuration File (Model_B)ver=1name=HEB2MPN0007D800F2E3model=HEB2MPNcustomer=Hitronmodel_customer=HEB2MPNfirmware=0.3.9class=HD_H.264mac=0007D800F2E3input=1600x1200total_ch=1 total_strm=4model_type=M1_D_Bmobile_stream=stream1

- 158 -


ch1_strm1_en=1ch1_strm1_res=1600x1200ch1_strm1_bitrate=4000ch1_strm1_ratecontrol=vbrch1_strm1_fps=15ch1_strm1_quality=35ch1_strm1_codec=H264HPch1_strm1_gop_struct=1ch1_strm1_gop=30ch1_strm2_en=1ch1_strm2_res=320x240ch1_strm2_bitrate=2000ch1_strm2_ratecontrol=cbrch1_strm2_fps=15ch1_strm2_quality=68ch1_strm2_codec=MJPEGch1_strm2_t_enable=1ch1_strm2_t_cont=STREAM2 ch1_strm2_t_location=0ch1_strm2_t_timer=0ch1_strm2_roi_x=132ch1_strm2_roi_y=104ch1_strm2_roi_width=560ch1_strm2_roi_height=408ch1_strm2_roi_zoom=11ch1_strm3_en=1ch1_strm3_res=320x240ch1_strm3_bitrate=500ch1_strm3_ratecontrol=vbrch1_strm3_fps=15ch1_strm3_quality=35ch1_strm3_codec=H264HPch1_strm3_gop_struct=1ch1_strm3_gop=15ch1_strm3_t_enable=0

- 159 -


ch1_strm3_t_cont=STREAM3 ch1_strm3_t_location=0ch1_strm3_t_timer=0ch1_strm3_roi_x=292ch1_strm3_roi_y=400ch1_strm3_roi_width=284ch1_strm3_roi_height=212ch1_strm3_roi_zoom=14ch1_strm4_en=1ch1_strm4_res=320x240ch1_strm4_bitrate=500ch1_strm4_ratecontrol=vbrch1_strm4_fps=15ch1_strm4_quality=35ch1_strm4_codec=H264HPch1_strm4_gop_struct=1ch1_strm4_gop=15ch1_strm4_t_enable=0ch1_strm4_t_cont=STREAM4 ch1_strm4_t_location=0ch1_strm4_t_timer=0ch1_strm4_roi_x=640ch1_strm4_roi_y=480ch1_strm4_roi_width=320ch1_strm4_roi_height=240ch1_strm4_roi_zoom=16total_snd_ch=1 snd1_enable=1snd1_codec=g711usnd1_samplerate=8snd1_in_gain=5snd1_out_gain=4live_source=0live_stream=1tv_source=0

- 160 -


tv_mode=ntsctv_seq_source=31tv_seq_t0=5tv_seq_t1=5tv_seq_t2=5tv_seq_t3=5tv_seq_t4=5tv_efocus_en=0hostname=HTC-HEB2MPN0007D800F2E3tv_efocus_t=5net_dev=eth0ipv4=192.168.90.211ipv6=fe80::207:d8ff:fe00:f2a4/64net_ip=192.168.90.211net_dhcp=0net_limit=1024https_mode=2http_port=80https_port=443rtsp_port=7070rtsp_eport=0rtp_start_port=5008rtp_end_port=51000rtp_mcast=0rtp_mcast_ip=231.1.128.20rtp_mcast_port=5000rtp_mcast_ttl=1rtp_mcast_strm1=0rtp_mcast_strm1_ip=231.1.128.20rtp_mcast_strm1_port=5000rtp_mcast_strm1_ttl=1rtp_mcast_strm2=0rtp_mcast_strm2_ip=231.1.128.21rtp_mcast_strm2_port=5000rtp_mcast_strm2_ttl=1

- 161 -


rtp_mcast_strm3=0rtp_mcast_strm3_ip=231.1.128.22rtp_mcast_strm3_port=5000rtp_mcast_strm3_ttl=1rtp_mcast_strm4=0rtp_mcast_strm4_ip=231.1.128.23rtp_mcast_strm4_port=5000rtp_mcast_strm4_ttl=1onvif_service_uri=http://192.168.33.32/onvif/device_servicem_ptz_option=IRIS ZOOM FOCUS PRESETOPTIONS=AUD BNC ALARM_IN ALARM_OUT HW_RESET LED AEAWB VMD FTP SMTP ROI MULTI_STREAM MULTI_CODEC SSL MANUAL_TRIGGER IP_FILTER DDNS UPNP ONBOOT VIDEO_LOSS AUD_ALERT ONVIF HTTP_NOTIFY NETWORK_LOSS

Example: URL of Configuration File (Model_C)http://<ipcam>/config.txt

Example: Configuration File (Model_C)ver=1name=HDG-T420RNASS7ACDE48DD1202ipv4=192.168.34.42ipv6=fe80::aede:48ff:fedd:1202/64device_name=H.264 Motorized IR Full-HD Camerainput=1920x1080firmware=0.0.3-triplemodel_type=T3_Amodel=HDG-T420R(NASS7)customer=HITRONmodel_customer=HDG-T420R(NASS7)mac=ACDE48DD1202rtsp_port=554http_port=80https_port=443https_mode=2tv_mode=ntsc

- 162 -


total_ch=1total_strm=3ch1_strm1_uri=rtsp://192.168.34.42/1/stream1ch1_strm1_codec=MPEG4SPch1_strm1_res=1080Pch1_strm1_fps=25ch1_strm1_bitrate=4000ch1_strm1_ratecontrol=cbrch1_strm1_gop=30ch1_strm2_uri=rtsp://192.168.34.42/1/stream2ch1_strm2_codec=JPEGch1_strm2_res=VGAch1_strm2_fps=30ch1_strm2_quality=50ch1_strm3_uri=rtsp://192.168.34.42/1/stream3ch1_strm3_codec=MPEG4SPch1_strm3_res=1080Pch1_strm3_fps=25ch1_strm3_bitrate=4000ch1_strm3_ratecontrol=cbrch1_strm3_gop=30total_snd_ch=1snd2_codec=G711Usnd2_bitrate=64snd2_samplerate=8000snd2_2way_use=0alarm_in=1alarm_out=1onvif_service_uri=http://192.168.34.42/onvif/device_servicemobile-stream=stream2m_ptz_option=ZOOM FOCUSoptions=BNC ALARM_IN ALARM_OUT HW_RESET LED AEAWB DAY_NIGHT VMD FTP SMTP MULTI_STREAM MULTI_CODEC SSL MANUAL_TRIGGER IP_FILTER DDNS UPNP ONBOOT AUD AUD_ALERT ONVIF RECORD HTTP_NOTIFY NETWORK_LOSS M_PTZ IR MASK

- 163 -


[Table 85] Parameters of config.txt

Name TypeLengt

hDescription Value

ver integerConfiguration File Version

name stringHost Name of the device

<MODEL><MAC>

ipv4 string IP Address (IPv4)ipv6 string IP Address (IPv6)device_name string Device Nameinput string Resolution or TV Modefirmware string Firmware versionmodel string Model Namemodel_type string Model Typecustomer string Specific Buyer Name

mac stringMAC Address 0007D8#####

#rtsp_port integer RTSP Porthttp_port integer Web server port

https_port integerWeb server port for SSL

https_mode integerHTTP(S) mode 0: HTTP

1: HTTPS2: Both

tv_mode string TV out mode ntsc/paltotal_ch integer Total video channelstotal_strm integer Total video streamsmobile_stream integer Mobile stream IDch#_strm#_uri string RTSP Stream URIch#_strm#_codec string Video codec namech#_strm#_res string Video resolution WxHch#_strm#_fps integer Video frameratech#_strm#_bitrate integer Video bitratech#_strm#_ratecontr string Video rate control vbr, cbr

- 164 -


olch#_strm#_gop integer Video gop sizetotal_snd_ch integer Total Audio channelssnd#_codec string Audio codec namesnd#_bitrate string Audio bitrate kbpssnd#_samplerate integer Audio sampling rate

snd#_2way_use boolState of usage bi-directional audio

model_customer stringSpecific model name for buyer

mobile-stream stringMJPEG stream for mobile access

alarm_in integer Number of Alarm Inalarm_out integer Number of Alarm Outonvif_service_uri string ONVIF service uri

m_ptz_option stringAF module or Motorized Lens control option

options strings String arrays *[Table 86]

[Table 86] Device optionsOption Description Option Description

AUD Audio BNC BNC OutALARM_IN Alarm input port ALARM_OUT Alarm output portHW_RESET Factory Default

ButtonLED LED

AEAWB AE & AWB VMD Video motion detection

PTZ PTZ control FTP FTPSMTP SMTP ROI Region Of InterestMULTI_STREAM Multiple streams MULTI_CODEC Multiple codecSSL SSL MANUAL_TRIGGE

RManual trigger

IP_FILTER IP filtering DDNS DDNSUPNP UPnP ONBOOT On boot event

- 165 -


VIDEO_LOSS Video loss event AUD_ALERT Audio alertHTTP_NOTIFY HTTP notification OSD_CTRL OSD controlONVIF ONVIF Conformant BUILTIN_PTZ No PTZ optionsDAY_NIGHT Day & Night RECORD RecordingNETWORK_LOSS Network loss MASK Privacy MaskingBLC Back Light

CompensationM_PTZ AF module or

Motorized LensAUD_DETECTION Audio Detection LIGHT LightPIR PRI INNER_AUD Inner AudioWIRELESS Wireless LIVE_PUSH Live PushEVENT_PUSH Event Push HOLE_PUNCHING Hole Punching

- 166 -


5. PTZ Control via HTTP

Some models support PTZ control via HTTP. There are three URLs to control PTZ.The first URL is “/ptz/control.php” for general PTZ control. The second is “/menu/control.php” that controls OSD menu for Model_A/C. This supports only some of move parameters. The other is “/mptz/control.php” that controls AF module or motorized lens. This supports only focus near/far and zoom wide/tele. Any PTZ operation needs ‘move=stop’ command to stop the current action.

Example: Request of PTZ controlhttp://<videoserver>/ptz/control.php?move=left&pspd=4&tspd=4http://<videoserver>/ptz/control.php?move=stop

[Table 87] Parameters of /ptz/control.php , /menu/control.php and /mptz/control.php

Name TypeLengt

hDescription Value

ch integerVideo Channel Number 1 ~ 4

(Default=1)move string 9 Direction of Pan/Tilt *[Table 88]pspd integer Pan Speed 0 ~ 8tspd integer Tilt Speedzoom string 4 Zoom Control Mode *[Table 88]iris string 5 Iris Control Modefocus string 4 Focus Control Mode

preset integerMove to the Preset Position of ID

0 ~ 255

presetsave integerSave Current Position as Preset ID

ascan integer Automatic Scan of IDtour integer Tour of IDpattern integer Pattern of IDmenu string 7 OSD Function *[Table 88]

ctrl boolCtrl Key On/Off On: 1, Off: 0

Valid /menu/

- 167 -


position string 3 Get/Set Position Values get, setkeepalive string Keep Alive anything

[Table 88] PTZ Command Stringsparameter values Remark

move

home Invalid with /menu/control.phpup Valid with /menu/control.phpdownleftrightupright Invalid with /menu/control.phpupleftdownleftdownrightstop Valid with /menu/control.phpenter Invalid with /ptz/control.php in

[HEV0118H]

zoomtele Invalid with /menu/control.phpwidestop

irisopenclosestop

focusfarnearStop

menu camera Valid with /ptz/control.php[HPCB-E5WNH9][HPCB-F5WNH9]

presetascantourpatternescalarmup Valid with /ptz/control.php

[HEV0118H]down

- 168 -


leftrightstop

shortcutOn Valid with /ptz/control.phpOff

Example: Request of menu controlhttp://<ipcam>/menu/control.php?move=lefthttp://<ipcam>/menu/control.php?move=stop

(1) Channel Number (ch): rwThis is the PTZ channel number. The default value is 1. It MAY be specified the channel number in case of multiple channels.

(2) Direction of Pan/Tilt (move): rwThis is the direction of Pan/Tilt control.

(3) Pan Speed (pspd): rwThis is the value of Pan speed.

(4) Tilt Speed (tspd): rwThis is the value of Tilt speed

(5) Zoom Control Mode (zoom): rwThis is to control zoom mode.

(6) Iris Control Mode (iris): rwThis is to control iris mode.

(7) Focus Control Mode (focus): rwThis is to control focus mode.

(8) Move to the Preset Position of ID (preset): rwThis is to move preset position of ID. The ID numbers are dependant on the PTZ device.

- 169 -


(9) Save Current Position to Preset ID (presetsave): rwThis is to save current position to preset ID.

(10) Automatic Scan of ID (ascan): rwThis is to activate automatic scan of ID.

(11) Tour of ID (tour): rwThis is to activate tour of ID.

(12) Pattern (pattern): rwThis is to activate pattern of ID.(13) OSD Function (menu): rwThe HPCB-E5WNH9 and HPCB-F5WNH9 support this.

(14) Ctrl Key On/Off (ctrl): rwThis parameter is valid with /menu/control.php.

(15) Get/Set Position Values (position): rwThis is to get/set current position value of PTZ device. It MAY not be supported some device.

(16) Keep Alive (keepalive): rwThis is to keep the connection via HTTP. Otherwise, the operation MAY be delayed to establish the connection. The value of parameter could be anything, for example, time value, integer value, and etc.

- 170 -


6. Event Stream via HTTP

This is used to get an event notification alert stream from the device via HTTP. The connection is established with the device when the function is called, and stays open to constantly receive event notifications.

The sequence for using this is - Get HTTP port by config.txt- Connect to HTTP server with that port- Request event stream of specific channel and stream number using GET or

POST method- Receive event stream from HTTP server continuously- Send keep-alive message every 30 sec

The event types are all configurable events on the device, onboot, alarm, motion, trigger and vloss.

Example: Request of getting event streamhttp://<videoserver>/stream/event_stream.php?ch=1&strm=1&motion=1

Example: Response of event streamevent_time=2001-01-01 20:38:24onboot=0motion=0trigger=0alarm=0vloss=0

[Table 89] Parameters of /stream/event_strm.php for request

Name TypeLengt

hDescription Value


(Default=1)

strm integerVideo Stream Number 1 ~ 4

(Default=1)

- 171 -


fulltext bool All Event Information On: 1, Off: 0onboot bool On Boot Eventalarm bool Alarm In Eventmotion bool Motion Detection Eventtrigger bool Manual Trigger Eventvloss bool Video Loss Event

[Table 90] Parameters of /stream/event_strm.php for reply

Name TypeLengt

hDescription Value

event_time string 19Event Information Date and Time

YYYY-MM-DD HH:MM:SS

onboot bool On boot Event Event: 1No-Event: 0alarm bool Alarm Event

alarm# boolSpecified ID Alarm Event

motion bool Motion Detection Event

ch#_strm#_motion boolMotion Detection Event of the Specified Channel and Stream

ch#_strm#_rgn# boolMotion Detection Event of the Specified Region

ch#_strm#_rgn#_sen

integerSensitivity of the Region 1 ~ 100

ch#_strm#_rgn#_thre

integerThreshold of the Region 1 ~ 100

ch#_strm#_rgn#_act integerActivity(Status) of the Region

1 ~ 100

trigger bool Manual Trigger Event Event: 1No-Event: 0

trigger# boolManual Trigger Event of the ID

vloss bool Video Loss Event

ch#_strm#_vloss boolVideo Loss Event of the Channel/Stream

netloss bool Network Loss Event

- 172 -


record boolExistence of Recording Information

*0: No Information1: Information

record_bad integerRecording Bad Sector Status

0: Normal1: Warning2: Bad

ch#_record boolRecording Status 0: Not-

Recording1: Recording

* The record field is to represent any information of recording status, record_bad or ch#_record parameters. If this is 0, then there MAY be no information of record_bad and ch#_record.

- 173 -


7. Video/Audio Stream

The devices support RTSP/RTP for streaming video and audio. The [Table 91] shows the URLs of the streams. If the anonymous login is disabled, the user name and password are needed to access the streams. (RFC1945, RFC2616)

[Table 91] URLs of the streamsModel_A Model_B Model_C

syntax

RTSP://<videoserver>:<port>/<channel>/stream<streamnumber>

RTSP://<ipcam>:<port>/<channel>/stream<streamnumber>

RTSP://<ipcam>:<port>/<channel>/stream<streamnumber>

stream number

1 ~ 2 0 ~ 3 1 ~ 3

example

rtsp://<videoserver>/1/stream1

rtsp://<ipcam>/1/stream0

rtsp://<ipcam>/1/stream1

remarkstream1: H.264 or MPEG4

stream2: MJPEG

stream0: H.264

stream1: MJPEG

stream2: H.264

stream3: H.264

stream1: H.264 or MPEG4

stream2: MJPEG

stream3: H.264 or MPEG4

Example: RTSP Protocol to get video/audio stream with authentication (Model_A)<device to client>RTSP/1.0 401 UnauthorizedWWW-Authenticate: Basic realm="/"

<client to device>DESCRIBE rtsp://192.168.12.244/1/stream1 RTSP/1.0CSeq: 22Accept: application/sdpAuthorization: Basic YWRtaW46YWRtaW4=User-Agent: VLC media player (LIVE555 Streaming Media v2008.11.13)

- 174 -


NOTEBasic Authentication In the context of an HTTP transaction, the basic access authentication is a method designed to allow a web browser, or other client program, to provide credentials – in the form of a user name and password – when making a request. Before transmission, the user name is appended with a colon and concatenated with the password. The resulting string is encoded with the Base64 algorithm. For example, given the user name Aladdin and password open sesame, the string Aladdin:open sesame is Base64 encoded, resulting in QWxhZGRpbjpvcGVuIHNlc2FtZQ==. The Base64-encoded string is transmitted and decoded by the receiver, resulting in the colon-separated user name and password string.

- 175 -


8. JPEG Snapshot URL

There is a JPEG snapshot URL. The snapshot image would be changed whenever the URL is refreshed.

[Table 92] URL of the snapshot imageModel_A/Model_C Model_B

syntaxhttp://<videoserver>:<port>/snapshot/<channel>/snapshot.jpg

http://<ipcam>:<port>/snapshot/<channel>/snapshot.jpg

channelnumber

1 1

examplehttp://<videoserver>/snapshot/1/snapshot.jpg

http://<ipcam>/snapshot/1/snapshot.jpg

remarkJPEG option follows the stream2 configuration

JPEG option follows the ftp configuration

- 176 -


9. Replaying

The Model_C and Model_B support recording, searching and replaying the audio/video streams.There are searching method, timelaps and event searching.

9-1. Timelaps Searching

These commands are to search timelaps (calendar based) recorded data.

9-1-1. Get Recording Information of the Current Date and Time (get_calendar)

Example: Request of getting the recording information of current date and time (Model_C)http://<ipcam>/playback/search.php?app=get&method=get_calendar

Example: Response of getting the recording information of current date and time (Model_C)res=200&method=get_calendar&year=2010&month=11&day=4&hour=6&minute=44&day_list=0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0&hour_list=0,0,0,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0&minute_list=1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0

This response means that the current system date is Nov, 4, 2010 and system time is 06:44. And there are recording data in this month, Nov, 4 from day_list. There are recording data in this day from 05:00 to 06:00. The recording time is 0 ~ 44 minnutes in 06:00.

[Table 93] Recording Information of get_calendar command (Calendar)

Name TypeLengt

hDescription Value

year integer Current System Yearmonth integer Current System Month 1 ~ 12day integer Current System Day 1 ~ 31

- 177 -


hour integer Current System Hour 0 ~ 23minute integer Current System Minute 0 ~ 59

day_list stringsRecording date in current month

1: Recorded0: No-Recorded

hour_list stringsRecording hours in current day


minute_list stringsRecording minutes in current hour

0: No-RecordedN: Time Index

9-1-2. Get Recording Information of the Specified Month (get_month)

Example: Request of getting the recording information of specified month (Model_C)http://<ipcam>/playback/search.php?app=get&method=get_month&year=2010&month=11

This request is to get the recording information of Nov, 2010.

Example: Response of getting the recording information of specified month (Model_C)res=200&method=get_month&year=2010&month=11&day=4&hour=6&minute=27&day_list=0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0&hour_list=0,0,0,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0&minute_list=1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0

This response means that the last recording date and time is Nov, 4, 2010 and 06:27. And there is recording data in Nov, 4. There are recording data in that day from 05:00 to 06:00. There are recording data in that hour (06:00) from 0 to 27 minutes.

[Table 94] Recording Information of get_month command (Month)

Name TypeLengt

hDescription Value

year integer Specified Yearmonth integer Specified Month 1 ~ 12

- 178 -


day integerThe Last Recording Day in the Month

1 ~ 31

hour integerThe Last Recording Hour in the Day

0 ~ 23

minute integerThe Last Recording Minute in the Hour

0 ~ 59

day_list stringsRecording Date in the Specified Month


hour_list stringsRecording Hours in the Specified Day


minute_list stringsRecording Minutes in Specified Hour


9-1-3. Get Recording Information of the Specified Date (get_month with date)

Example: Request of getting the recording information of specified date (Model_C)http://<ipcam>/playback/search.php?app=get&method=get_month&year=2010&month=11&day=4

This request is to get the recording information of Nov, 4, 2010.

Example: Response of getting the recording information of specified date (Model_C)res=200&method=get_day&year=2010&month=11&day=4&hour=6&minute=47&day_list=0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0&hour_list=0,0,0,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0&minute_list=1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0,0,0,0,0

This response means that the last recording date and time is Nov, 4, 2010 and 06:47. And there is recording data in Nov, 4. There are recording data in that day from 05:00 to 06:00. There are recording data in that hour (06:00) from 0 to 47 minutes.

[Table 95] Recording Information of get_month with date command (Date)

Name TypeLengt

hDescription Value

- 179 -


year integer Specified Yearmonth integer Specified Month 1 ~ 12day integer Specified Date 1 ~ 31


0 ~ 23


0 ~ 59







9-1-4. Get Recording Information of the Specified Hour (get_hour)

Example: Request of getting the recording information of the specified hour (Model_C)http://<ipcam>/playback/search.php?app=get&method=get_hour&year=2010&month=11&day=4&hour=5

This request is to get the recording information of Nov, 4, 2010 at 05:00.

Example: Response of getting the recording information of the specified hour (Model_C)res=200&method=get_hour&year=2010&month=11&day=4&hour=6&minute=56&day_list=0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0&hour_list=0,0,0,0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0&minute_list=0,0,0,0,0,0,0,0,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,0,0,0

This response means that the last recording date and time is Nov, 4, 2010 and 06:56. And there is recording data in Nov, 4. There are recording data in that day in 06:00. There are recording data in that hour (06:00) from 8 to 56 minutes.

- 180 -


[Table 96] Recording Information of get_hour command (Hour)

Name TypeLengt

hDescription Value



0 ~ 23


0 ~ 59







9-1-5. Get Recording Information of the Specified Minute (get_hour)

Example: Request of getting the recording information of the specified minute (Model_C)http://<ipcam>/playback/search.php?app=get&method=get_minute&year=2010&month=11&day=4&hour=6&minute=30

This request is to get the recording information of Nov, 4, 2010 at 06:30.

Example: Response of getting the recording information of the specified minute (Model_C)res=200&method=get_minute&year=2010&month=11&day=4&hour=6&minute=30&day_list=0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0&hour_list=0,0,0,0,0,0,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0&minute_list=0,0,0,0,0,0,0,0,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1

- 181 -


This response means that the last recording date and time is Nov, 4, 2010 and 06:30. And there is recording data in Nov, 4. There are recording data in that day in 06:00. There are recording data in that hour (06:00) from 8 to 59 minutes.

[Table 97] Recording Information of get_hour command (Hour)

Name TypeLengt

hDescription Value



0 ~ 23


0 ~ 59







If there is no matched recording information to the request, the response returns the date or time value as 0. For example, the request of recording information Nov, 2, 2010 at 13:00 and there is no recording data in that day and time, the response would be returned with the specified date and time value and all list (day, hour and minute) are as 0 strings.

9-2. Event Searching

These commands are to search event recorded data.

9-2-1. Get Event Recording Information of the Specified Date and Time (get_event)

Example: Request of getting the event recording information of the specified date and time (Model_C)

- 182 -


http://<ipcam>/playback/search.php?app=get&method=get_event&event_type=0&start_date=2010-11-04&end_date=2010-11-04

This request is to search the event recording information during Nov, 4, 2010.

Example: Response of getting the event recording information of the specified date and time (Model_C)res=200&method=get_event&event_list_count=6&event_list=4|2010-11-04|07:05:28|1,4|2010-11-04|07:27:45|1,4|2010-11-04|07:27:51|1,4|2010-11-04|07:27:57|3,4|2010-11-04|07:28:08|7,4|2010-11-04|07:28:18|8

This response means total event list count is 6 of the searching request. And the events are followed event type and date time in the list.

[Table 98] Event type for searchingValue Event Type

0 All events1 Onboot2 Alarm3 Manual Trigger4 Motion Detection5 Video Loss6 Network Loss78 PIR9 Audio Detection

[Table 99] Event-recording Searching Information of get_event command

Name TypeLengt

hDescription Value

event_type integer Searching Event Type *[Table 98]

start_date stringStarting Date of Searching Range

yyyy-mm-dd

end_date string Ending Date of yyyy-mm-dd

- 183 -


Searching Range

event_list_count integerTotal Count in the Event List

event_list stringEvent Type and Date/Time

An event information in the event_list is consisted of EVENT_TYPE | YYYY-MM-DD | HH:MM:SS | RECORD_INDEX. For example, “4|2010-11-04|07:27:51|1”.

The RECORD_INDEX is the internal value to replay the recorded data from files.

9-2-2. Get Event Information of the Specified Record Index (get_index)

This is to get the event recording information with the specified record index and date time.

Example: Request of getting the event recording information of the specified record index (Model_C)http://<ipcam>/playback/search.php?app=get&method=get_index&year=2010&month=11&day=04&hour=07&minute=05&record_index=1

This request is to get index of the specified date and time, Nov, 4, 2010, 07:05 with record index as 1.

Example: Response of getting the event recording information of the specified record index (Model_C)res=200&method=get_index&year=2010&month=11&day=4&hour=7&minute=5&day_list=0,0,0,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0&hour_list=0,0,0,0,0,0,1,1,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0&minute_list=1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1&time_index=1

This response means the specified date and time and recording information. And the time index is 1. The time index is to distinguish the recorded data in the case of

- 184 -


time-overlapping. The time-overlapping MAY be happened to sychronize the time by the NTP or manually. In the case of that, time_index value is increased.

[Table 100] Event-recording Searching Information of get_event command

Name TypeLengt

hDescription Value

time_index integerTo distinguish the time index

First recorded data is 1

9-3. Replaying Connection Status (get_clients)

This command is to check the replaying connection status. The Model_C and some of Model_B have a limitation of connection for replaying. It supports maximum 3 clients of replaying simultaneously. And others support 1 client for replaying user. Before connecting the device for replaying, it SHOULD be checked availability for replaying.

Example: Request of checking connection status (Model_C)http://<ipcam>/playback/search.php?app=get&method=get_clients

Example: Response of checking connection status (Model_C)res=200&method=get_clients&max_clients=3&current_clients=1

[Table 101] Parameters of getting client connections status

Name TypeLengt

hDescription Value

max_clients integerMaximum Number of Clients for Replaying

current_clients integerCurrent Number of Connected Clients for Replaying

9-4. Get Olddest and Latest Recorded Data (gotofirst/gotolast)

These are to get the olddest and latest recorded data.

- 185 -


Example: Request of getting the olddest recorded data (gotofirst) (Model_C)http://<ipcam>/playback/search.php?app=get&method=gotofirst

Example: Response of getting the olddest recorded data (gotofirst) (Model_C)res=200&method=gotofirst&year=2010&month=11&day=4&hour=6&minute=44&time_index=1

The response means the information of the olddest recorded data is Nov, 4, 2010 and 06:44.

Example: Request of getting the latest recorded data (gotolast) (Model_C)http://<ipcam>/playback/search.php?app=get&method=gotolast

Example: Response of getting the latest recorded data (gotolast) (Model_C)res=200&method=gotolast&year=2010&month=11&day=4&hour=8&minute=46&time_index=1

The response means the information of the latest recorded data is Nov, 4, 2010 and 08:46.

[Table 102] Parameters of playback.php

Name TypeLengt

hDescription Value

method string

Commands for Getting Recorded Information as Calendar/Month/Day/Hour/Minute/Event/Index and Olddest/LatestGetting Replaying Status

get_calendarget_monthget_dayget_hourget_minuteget_eventget_indexget_clientgotofirstgotolast

year string Request/Response Year yyyy

- 186 -


month stringRequest/Response Month

m

day string Request/Response Day dhour string Request/Response Hour H

minute stringRequest/Response Minute

M

day_list stringExistence of Recording Data in the Month

1: Recorded0: No-Record

hour_list stringExistence of Recording Data in the Day

1: Recorded0: No-Record

minute_list stringExistence of Recording Data in the Hour

0: No-RecordN: Time Index

event_type stringEvent Type 0 ~ 6

*[Table 98]start_date string Starting Date of Range YYYY-MM-DDend_date string Ending Date of Range YYYY-MM-DD

event_list_count stringTotal Count in the Event List

event_list string

Event Data List event_type|YYYY-MM-DD|HH:MM:SS|record_index

record_index stringInternal Event Record Index

time_index stringTime Index for Time-Overlapping

1

max_clients stringMaximum Number of Clients for Replaying

Default: 3

current_clients stringCurrent Number of Connected Clients for Replaying

0 ~ 3

9-5. Replaying Controls (RTSP)

The replaying control uses the RTSP extensions.

- 187 -


Example: Replaying URI (Model_C)rtsp://<ip address>/<channel>/<date>/<time>/<time_index>/<to>/<recording>

Example: Replaying URI for channel 1 in July, 12, 2010 11:30:00 (Model_C)rtsp://192.168.30.220/1/20100712/113000/1/to/recording

[Table 103] URI Field in Replaying RTSPRTSP field Description

ip address Server AddressChannel Video Input Channel Number

(default: 1)Date Recorded DateTime Recorded Timetime_index Time Index for Time-Overlapping

(default: 1)To ReservedRecording Reserved

9-5-1. Initiating Playback

This allows clients to query the server’s support for these extensions using the require header as described in [RFC2326] section 12.3.1

Playback is initiated by means of the RTSP PLAY method.

Example: Initiation for Replaying RTSP (Model_C)PLAY rtsp://192.168.30.220/1/20100712/113000/1/to recording RTSP/1.0Cseq: 123Session: 12345678Authorization: Basic 3djklgreljpRequire: onvif-replayRange: clock=20100712T113000-Rate-Control: yesFrame: all

- 188 -


Scale: 1.0Refresh: 1

[Table 104] RTSP Header Fields for ReplayingName Description

Require Reserved: “onvif-replay”Range Playback Date and TimeRate-Control Synchronized replaying: yes

Non-synchronized replaying: noFrame Frame Type

All frames: allI frame only: intra

Scale Playback Direction and SpeedRange: -3.0 (Reverse) ~ 3.0 (Forward)Default: 1.0 (Forward, Normal Speed)

Refresh Reset for Time Changing1

9-5-2. Range header field

The Range filed shall be expressed using absolute times only; the other formats defined by [RFC2326] shall NOT be used by this client. The only open range format is allowed. The direction of the range shall correspond to the vlaue of the Scale header.The range field is the starting point for replay. The closed range is only available for forward playback.

9-5-3. Rate-Control header field

The Rate-Control field may be either “yes” or “no”. If the field is not present, “yest” is assumed, and the stream is delievered in real time using standard RTP timing mechanisms. If this field is “no”, the stream is delievered as fast as possible, using only the flow control provided by the transport to limit the delivery rate.The important difference between thest two modes is that with “Rate-Control=yes”, the server is in control of the playback speed. Otherwise the client is in control of

- 189 -


the playback speed.

9-5-4. Frames header field

The Frames header field may be used to reduce the number of frames that are transmitted.

1) Intra frames only.This is indicated using the value “intra”. In the reverse playback, this is default. If the Rate-Control is “yes” and the speed of replaying is not normal, then intra frames are transmitted with 1000 millisecond interval in the stream even which is MJPEG (all frames are intra frames).2) All framesAll frames are transmitted.

Example: Request intra frames onlyFrames: intra

Example: Request intra frames onlyFrames: all

9-5-5. Scale header field

NOTEONVIF Frames Header Field ONVIF Core Specification version 2.0 (November, 2010) has RTSP Feature and Header Fields for replaying service (21 Replay Control). Frame Header option has three modes: 1. Intra frames only, 2. Intra frames and predicted frames only, 3. All frames. Intra frames only option in ONVIF replaying Intra frame only is possible to use minimum interval between successive intra frames in the stream. “Frames: intra/4000” is to request intra frames with a minimum interval of 4000 milliseconds.

- 190 -


There is a scale header field in section 12.34 [RFC2326]. A scale value of 1 indicates normal play. If not 1, the value corresponds to the rate with respect to normal viewing rate. The range of Scale header in [Model_C] is -3.0 ~ 3.0 (no 0.0). The scale header means direction of playback and speed. If the absolute scale value is smaller than 1, it transmits the frames in one second from the starting point.

Example: Normal PlaybackPLAY rtsp://192.168.30.220/1/20100712/113000/1/to/recording RTSP/1.0Cseq: 123Session: 12345678Authorization: Basic 3djklgreljpRequire: onvif-replayRange: clock=20100712T113000-Rate-Control: yesFrame: allScale: 1.0Refresh: 1

Example: Reverse PlaybackPLAY rtsp://192.168.30.220/1/20100712/113000/1/to/recording RTSP/1.0Cseq: 123Session: 12345678Authorization: Basic 3djklgreljpRequire: onvif-replayRange: clock=20100712T113000-Rate-Control: yesFrame: intraScale: -1.0Refresh: 0

Example: Fast Playback with Double Speed PLAY rtsp://192.168.30.220/1/20100712/113000/1/to/recording RTSP/1.0Cseq: 123Session: 12345678Authorization: Basic 3djklgreljp

- 191 -


Require: onvif-replayRange: clock=20100712T113000-Rate-Control: yesFrames: intraScale: 2.0Refresh: 0

Example: Fast Playback with Triple Speed PLAY rtsp://192.168.30.220/1/20100712/113000/1/to/recording RTSP/1.0Cseq: 123Session: 12345678Authorization: Basic 3djklgreljpRequire: onvif-replayRange: clock=20100712T113000-Rate-Control: yesFrames: intraScale: 2.0Refresh: 0

Example: Reverse Playback with Triple SpeedPLAY rtsp://192.168.30.220/1/20100712/113000/1/to/recording RTSP/1.0Cseq: 123Session: 12345678Authorization: Basic 3djklgreljpRequire: onvif-replayRange: clock=20100712T113000-Rate-Control: yesFrames: intraScale: -2.0Refresh: 0

Example: Playback with 4 times fasterPLAY rtsp://192.168.30.220/1/20100712/113000/1/to/recording RTSP/1.0Cseq: 123Session: 12345678

- 192 -


Authorization: Basic 3djklgreljpRequire: onvif-replayRange: clock=20100712T113000-Rate-Control: noFrames: intraScale: 3.0Refresh: 0

Example: Reverse Playback with 4 times fasterPLAY rtsp://192.168.30.220/1/20100712/113000/1/to/recording RTSP/1.0Cseq: 123Session: 12345678Authorization: Basic 3djklgreljpRequire: onvif-replayRange: clock=20100712T113000-Rate-Control: yesFrames: intraScale: -3.0Refresh: 0

Example: Step PlaybackPLAY rtsp://192.168.30.220/1/20100712/113000/1/to/recording RTSP/1.0Cseq: 123Session: 12345678Authorization: Basic 3djklgreljpRequire: onvif-replayRange: clock=20100712T113000-Rate-Control: yesFrames: intraScale: 0.1Refresh: 0

Example: Step BackwardPLAY rtsp://192.168.30.220/1/20100712/113000/1/to/recording RTSP/1.0Cseq: 123

- 193 -


Session: 12345678Authorization: Basic 3djklgreljpRequire: onvif-replayRange: clock=20100712T113000-Rate-Control: yesFrames: intraScale: -0.1Refresh: 0

Example: Pause ReplayingPAUSE rtsp://192.168.30.220/1/20100712/113000/1/to/recording RTSP/1.0Cseq: 123Session: 12345678Authorization: Basic 3djklgreljpRequire: onvif-replayRange: clock=20100712T113000-Rate-Control: no

Example: Rate-Control: no and Closed RangePLAY rtsp://192.168.30.220/1/20100712/113000/1/to/recording RTSP/1.0CSeq: 123Session: 12345678Authorization: Basic 3djklgreljpRequire: onvif-replayRange: clock=20100712T113000-20100712T113500Rate-Control: noFrame: allScale: 1.0Refresh: 1

9-5-6. RTSP describe

The SDP returned by the RTSP describe command includes recording data information.

- 194 -


Example: DESCRIBE command for replayingDESCRIBE rtsp://192.168.30.220/1/20100712/113000/1/to/recording RTSP/1.0CSeq: 123Session: 12345678Authorization: Basic 3djklgreljpUser-Agent: ONVIF RTSP ClientAccept: application/sdp

Example: SDP response for replayingRTSP/1.0 200 OKCSeq: 124Content-type: application/sdpContent-Length: xxxv=0o=- 1 1 IN IP4 192.168.12.194s=Media Presentationc=IN IP4 0.0.0.0t=0 0a=control:*a=range:npt=now-m=video 0 RTP/AVP 96a=control:rtsp://192.168.12.194/1/20101203/95100/1/to/recording/videoa=x-onvif-track:VIDEO001a=rtpmap:96 H264/90000a=fmtp:96 packetization-mode=1;profile-level-id=0;sprop-parameter-sets=m=audio 0 RTP/AVP 0a=control:rtsp://192.168.12.194/1/20101203/95100/1/to/recording/audioa=x-onvif-track:AUDIO001a=rtpmap:0 PCMU/8000/1

9-6. Replaying Stream (RTP)

9-6-1. RTP

In order to allow clients to report stable and accurate timestamp for each frame

- 195 -


played back regardless of the direction of playback, it uses absolute timestamp with each packet.

The replay mechanism uses the extension ID 0xABAC for the replay extension

[Figure 2] RTP Packet Layout for Replaying

- NTP timestampAn NTP [RFC 1305] timestamp indicating the absolute UTC time associated with the access unit.- C: 1 bitIndicates that the access unit is a synchronization point or “clean poin”, e.g, the start of an intra-coded frame in the case of video streams- E: 1 bitIndicates that the end of a contiguous section of recording. The last access unit in each recording before a recording gap, or at the end of available footage, has this bit set. When replaying in reverse, the E flag shall be set on the last frame at the end of the contiguous section of recording.- D: 1 bitIndicates that this access unit follows a discontinuity in transmission. It is primarily used during reverse replay; the first packet of each GOP has the D bit set since it does not chronologically follow the previous packet in the data stream.- mbz MUST BE ZERO- Cseq: 1 byteThis is the low-order byte of the Cseq value used in the RTSP PLAY command that was used to initiate transmission. When a client sends multiple consecurtive PLAY commands, this value may be used to determine where the data from each new PLAY command begins.

- 196 -


10. Back-Channel Audio Transmission

All devices support back-channel audio transmission. This is the way to set and transmit audio data to the device.

The audio function MUST be turned on. (Section 3-2. Audio). The audio device is able to decode audio with the same configuration of encoder. Thus the audio data MUST be encoded the same method and configuration with the audio encoder configuration. If the device is set as G.726, 16 bit encoding mode, the back-channel audio data MUST be encoded the same way with G.726, 16 bit encoding mode.

There is a limitation of the audio packet size. The packet size MUST be under 256 bytes.

The SSRC value of RTP MUST be same with the received audio channel’s SSRC value.

In the case of UDP transmission, the back-channel audio data MUST be sent to the audio server port from the SDP.

In the case of TCP transmission, the back-channel audio transmission is available only the RTP/RTSP/TCP or RTP/RTSP/TCP/HTTP connection. The back-channel audio data MUST be sent interleaved format. [RFC2326]

11. JPEG Push

This is a JPEG Push URL which streams JPEG snapshots. JPEG Push works on Mozilla based web browser, not on Internet Explorer.

[Table 105] URL of the Jpeg Push

- 197 -


Model_A/Model_B/Model_Csyntax http://<videoserver>:<port>/jpeg/<channel>/jpeg.php

channel number 1example http://<videoserver>/jpeg/1/jpeg.phpremark JPEG option follows the stream2 configuration

- 198 -


12. Smart FocusThis is to take the focus automatically.

[Table 106] URL of the Smart FocusHDG-M220F

syntaxhttp://<videoserver>:<port>/live/live_control.php?smart_focus=1

example http://<videoserver>/live/live_control.php?smart_focus=1remark

13. Dome configurations for HDS-A411, HDS-S422W

13-1. Auto scan

This is for setting up scanning action. These belong to the autoscan.php resource.

Example: Request of getting image appearance parameters and values.http://<ipcam>/video/autoscan.php?app=get

Example: Response of getting auto scan parameters and values.res=200&method=get_num&http_port=80&https_port=443&auto_scan_list=0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0&auto_scan_sel_num=1&auto_scan_title=A01&auto_scan_mode=0&auto_scan_direction=0&auto_scan_swap=0&auto_scan_speed=5&auto_scan_dwell=3&auto_scan_start_X=&auto_scan_start_Y=&start_pan_position=FFFFFF&start_tilt_position=FFFFFF&start_zoom_position=FFFF&start_focus_position=FFFF&auto_scan_end_X=&auto_scan_end_Y=&end_pan_position=FFFFFF&end_tilt_position=FFFFFF&end_zoom_position=FFFF&end_focus_position=0400

[Table 107] Parameters of autoscan.php

Name TypeLengt

hDescription Value

method string get_num, start_angle,end_angle,delete,

- 199 -


saveauto_scan_list string 1,2,3,~17

auto_scan_sel_num integerAuto Scan select number

1~17(9:AUTO PAN)

auto_scan_title string 6 Auto Scan Title

auto_scan_mode integerScanning Mode Normal: 0

Vector: 1Random: 2

auto_scan_direction boolScanning Direction 0: CCW

1: CW

auto_scan_swap bool

Swap the scanning position(Start and End position)

0: off1: onauto_pan(9):disable

auto_scan_speed integer Auto Scan Speed 1 ~ 13auto_scan_dwell integer Auto Scan Dwell time 3 ~ 99auto_scan_start_X string 5 Format: 000.0auto_scan_start_Y string 5 Format: 000.0auto_scan_end_X string 5 Format: 000.0auto_scan_end_Y string 5 Format: 000.0start_pan_position string 6start_tilt_position string 6start_zoom_position string 4start_focus_position string 4end_pan_position string 6end_tilt_position string 6end_zoom_position string 4end_focus_position string 4

(1) Method (method): rwThis is the method to operate, get_num, start_angle, end_angle, delete or save. ‘get_num’ method retrieves specific auto scan configuration. ‘start_angle’ and ‘end_angle’ methods set scan angles. ‘delete’ method can’t delete built-in AUTO PAN 9.

- 200 -


(2) Auto Scan List (auto_scan_list): rThis is the list of 0 and 1 to represent existence of auto scan configurations. Total count of auto scan configuration is 17.

(3) Auto Scan select number (auto_scan_sel_num): rwThis is to select specific auto scan number to save or delete. The auto scan number can be adjusted in the range 1-17. Auto scan number 9 is AUTO PAN.

(4) Auto Scan Title (auto_scan_title): rwOnly capital alphabet, number and space are available. HDS-A411 series are not writable.

(5) Scanning Mode (auto_scan_mode): rw- Normal: Move from start point to end point in panning only.- Vector: Move from start point to end point including tilt and zoom simultaneously and linearly.- Random: Move randomly between the start point and the end point.

(6) Scanning Direction (auto_scan_direction): rw

(7) Swap the scanning position (auto_scan_swap): rwThis is to enable/disable automatically swap start with end point at each path.

(8) Auto Scan Speed (auto_scan_speed): rw. (9) Dwell Time (auto_scan_dwell): rwThis is to set dwell time in the preset position.

(10) X Position of Start (auto_scan_start_X): rThis is the x-coordinate of starting position in auto scan. It is used only to be shown to the user.

(11) Y Position of Start (auto_scan_start_Y): rThis is the y-coordinate of starting position in auto scan. It is used only to be shown to the user.

- 201 -


(12) X Position of End (auto_scan_end_X): rThis is the x-coordinate of ending position in auto scan. It is used only to be shown to the user.

(13) Y Position of End (auto_scan_end_Y): rThis is the y-coordinate of ending position in auto scan. It is used only to be shown to the user.

(14) Pan Position of Start (start_pan_position): rwThis is the pan coordinate of starting position in auto scan. It is used for internal operations. Pan coordinate retrieved by 'start_angle' method should be set when auto scan is saved.

(15) Tilt Position of Start (start_tilt_position): rwThis is the tilt coordinate of starting position in auto scan. It is used for internal operations. Tilt coordinate retrieved by 'start_angle' method should be set when auto scan is saved.

(16) Zoom Position of Start (start_pan_position): rwThis is the zoom scale of starting position in auto scan. It is used for internal operations. Zoom scale retrieved by 'start_angle' method should be set when auto scan is saved.

(17) Focus Position of Start (start_focus_position): rwThis is the focus value of starting position in auto scan. It is used for internal operations. Focus value retrieved by 'start_angle' method should be set when auto scan is saved.

(18) Pan Position of End (end_pan_position): rwThis is the pan coordinate of ending position in auto scan. It is used for internal operations. Pan coordinate retrieved by 'end_angle' method should be set when auto scan is saved.

(19) Tilt Position of End (end_tilt_position): rwThis is the tilt coordinate of ending position in auto scan. It is used for internal operations. Tilt coordinate retrieved by 'end_angle' method should be set when auto

- 202 -


scan is saved.

(20) Zoom Position of End (end_pan_position): rwThis is the zoom scale of ending position in auto scan. It is used for internal operations. Zoom scale retrieved by 'end_angle' method should be set when auto scan is saved.

(21) Focus Position of End (end_focus_position): rwThis is the focus value of ending position in auto scan. It is used for internal operations Focus value retrieved by 'end_angle' method should be set when auto scan is saved.

13-2. Preset

This is for setting up preset action. These belong to the preset.php resource.Example: Request of getting preset parameters and values.http://<ipcam>/ptz/preset.php?app=get

13-2-1. HDS-A411 Series

Example: Response of getting preset parameters and values. (HDS-A411 series)res=200&http_port=80&https_port=443&preset_list=1,102,195&preset_number=1&preset_title=001&preset_dwell=3&preset_focus_mode=0&preset_ae_mode=2&preset_ae_iris_offset=144&preset_ae_iris_peak=8&preset_ae_dss_limit=1&preset_ae_gain=1&preset_ae_shutter_speed=11&preset_ae_exposure=2&preset_ae_blc_mode=0&preset_ae_blc_level=4&preset_ae_wdr_level=64&preset_ae_dnn_mode=0&method=get_num

[Table 108] Parameters of preset.php

Name TypeLengt

hDescription Value

method string Methodget_num,create,delete

preset_list string Preset List 1,2,3…240

- 203 -


preset_number integer Preset Number 1~240preset_title string 6 Preset Titlepreset_dwell integer Preset Dwell Time 3 ~ 99preset_focus_mode integer Preset Focus Mode *[Table 109]preset_ae_mode integer Preset Exposure Mode *[Table 110]preset_ae_iris_offset integer Preset Iris Offset 0 ~ 255preset_ae_iris_peak integer Preset Iris Peak 0 ~ 127

preset_ae_dss_limit integer

Preset Digital Slow Shutter Limit

0: 1/301: 1/152: 1/83: 1/4

preset_ae_gain integer Preset AGC Gain 0 ~ 5preset_ae_shutter_speed

integerPreset Shutter Speed *[Table 112]

preset_ae_exposure integer Preset Exposure *[Table 113]

preset_ae_blc_mode integerPreset BLC/WDR Mode 0: Off

1: WDR2: BLC

preset_ae_blc_level bool Preset BLC Level *[Table 114]preset_ae_wdr_level bool Preset WDR Level 0 ~ 254

preset_ae_dnn_mode integerPreset Day & Night Cotrol

*[Table 115][Table 196]

(1) Method (method): rwThis is the method to operate get_num, create or delete. ‘get_num’ method retrieves specific preset information. ‘create’ method create or update the preset configuration.

(2) Preset List (preset_list): rThis is the list of configured preset numbers. Each preset number is separated by comma (,).

(3) Preset Number (preset_number): rwThis is to select specific preset number to save, delete or retrieve. The preset number can be adjusted in the range 1-240.

- 204 -


(4) Preset Title (preset_title): rHDS-A411 series are not writable.

(5) Preset Dwell Time (preset_dwell): rwThis is to set dwell time in the preset position.

(6) Preset Focus Mode (preset_focus_mode): rw

[Table 109] Preset Focus ModePreset Focus Mode Value

Auto 0Manual 1

One Push 2Constant Manual 3

(7) Preset Exposure Mode (preset_ae_mode): rwThis is to set exposure mode to adjust amount of light detected based on light conditions.

[Table 110] Preset Exposure ModeValue Exposure Mode

0 Auto1 Auto with DAWN2 Auto with DARK3 Auto with DSS4 Manual Gain5 Manual Shutter6 Manual Exposure

(8) Preset Iris Offset (preset_ae_iris_offset): rwThis is to set overall brightness of picture. Higher value for brighten the scene and vice versa.

(9) Preset Iris Peak (preset_ae_iris_peak): rw

- 205 -


This is to set the effect of focusing peak, or how video peaks affect the overall picture brightness. When the scene have bright lights such as spotlight or headlight, if you set Iris peak level high, the image get dark because of the effect of focusing peaks.

(10 Preset Digital Slow Shutter Limit (preset_ae_dss_limit): rwThis is to limit the Digital Slow Shutter.

(11) Preset AGC Gain (preset_ae_gain): rwThis is to set AGC gain in a preset. Increasing Exposure gain increases the brightness of image, but it also increases the amount of noise in the image.

[Table 111] Preset AGC GainAGC Gain Value

0 06 1

12 218 324 430 5

(12) Preset Shutter Speed (preset_ae_shutter_speed): rwThis is to set the electronic shutter speed. It's only available when exposure mode is the manual shutter mode. A slower speed in dark conditions will help to produce a brighter image, but will produce fewer frames per second, which may cause blurry images during motion.

[Table 112] Preset Shutter SpeedShutter Speed

Value

1/10000 01/4000 11/2000 21/1000 31/500 4

- 206 -


1/250 51/180 61/120 71/100 81/60 91/50 101/30 111/15 121/8 131/4 14

(13) Preset Exposure (preset_ae_exposure): rwThis is to set the exposure. It's only available when exposure mode is the manual exposure mode.

[Table 113] Preset ExposureExposure(F-

value)Value

F1.6 0F2.2 1F3.2 2F4.4 3F6.4 4F8.8 5F12 6F17 7F24 8F34 9

(14) Preset BLC/WDR Mode (preset_ae_blc_mode): rw

(15) Preset BLC Level (preset_ae_blc_level): rw

[Table 114] BLC LevelBLC Level Value

- 207 -


Very High 0High 1

Middle 2Low 3

Very Low 4

(16) Preset WDR Level (preset_ae_wdr_level): rw

(17) Preset Day & Night Cotrol (preset_ae_dnn_mode): rw

[Table 115] Day & Night ModeDay&Night

ModeValue

Auto 0Day 1

Night 2Global 3

13-2-2. HDS-S422W Series

Example: Response of getting ae parameters and values. (HDS-S422W series)res=200&http_port=80&https_port=443&preset_list=1,102,195&preset_ae_tv_mode=ntsc&preset_number=1&preset_title=001&preset_dwell=3&preset_focus_mode=0&preset_ae_mode=0&preset_ae_gain=1&preset_ae_slow_ae_response=0&preset_ae_shutter_speed=5&preset_ae_exposure=8&preset_ae_bright=8&preset_ae_max_bright=26&preset_ae_slow_shutter=0&preset_ae_high_sensitivity=0&preset_ae_dnn_mode=0&preset_ae_blc_mode=0&method=get_num

[Table 116] Parameters of preset.php

Name TypeLengt

hDescription Value

method string Methodget_num,create,delete

preset_list string Preset List 1,2,3…240

- 208 -


preset_ae_tv_mode stringntscpal

preset_number integer Preset Number 1~240preset_title string 6 Preset Titlepreset_dwell integer Preset Dwell Time 3 ~ 99preset_focus_mode integer Preset Focus Mode *[Table 117]preset_ae_mode

integerPreset Exposure Mode

*[Table 118]

preset_ae_gaininteger

Preset Exposure Gain

*[Table 119]

preset_ae_slow_ae_response

integerPreset Slow AE Response

0 ~ 47(1~48)

preset_ae_shutter_speed integerPreset Shutter Speed

*[Table 120]

preset_ae_exposure integer Preset Exposure *[Table 121]preset_ae_bright integer Preset Bright 0 ~ 27preset_ae_max_bright integer Preset Max Bright

preset_ae_slow_shutter boolPreset Slow Shutter Off: 0

On: 1

preset_ae_high_sensitivity boolPreset High Sensitivity

Off: 0On: 1

preset_ae_dnn_mode boolPreset Day & Night Cotrol

*[Table 122

preset_ae_blc_mode integer

Preset BLC and WDR mode

0: Off1: BLC2: WDR3: WDR-Auto

(1) Method (method): rwThis is the method to operate get_num, create or delete. ‘get_num’ method retrieves specific preset information. ‘create’ method create or update the preset configuration.

(2) Preset Listpreset_list): rThis is the list of configured preset numbers.

- 209 -


(3) TV out Mode (preset_ae_tv_mode): rThis is one of the TV out modes, NTSC and PAL.

(3) Preset Number (preset_number): rwThis is to select specific preset number to save, delete or retrieve. The preset number can be adjusted in the range 1-240.

(4) Preset Title (preset_title): rwOnly capital alphabet, number and space are available.

(5) Preset Dwell Time (preset_dwell): rwThis is to set dwell time in the preset position.

(6) Preset Focus Mode(preset_focus_mode): rw

[Table 117] Focus ModePreset Focus Mode Value

Auto 0Manual 1


(7) Preset Exposure Mode (preset_ae_mode) : rwThis is to set exposure mode to adjust amount of light detected based on light conditions. Manual exposure mode is recommended only for indoor applications that have a single unchanging primary light source.

[Table 118] Preset Exposure ModeExposure Mode Value

Auto 0Manual 1Manual Exposure 2Manual 3Manual Bright 4

- 210 -


(8) Preset Exposure Gain (preset_ae_gain): rwIncreasing Exposure gain increases the brightness of image, but it also increases the amount of noise in the image.

[Table 119] Preset Gain ValueGain(dB) Value Gain(dB) Value Gain(dB) Value

-3 0 10 6 22 120 1 12 7 24 132 2 14 8 26 144 3 16 9 28 156 4 18 108 5 20 11

(9) Preset Slow AE Response (preset_ae_slow_ae_response): rwSlower auto exposure allows you to reduce the exposure response speed.

(10) Preset Shutter Speed (preset_ae_shutter_speed): rwThis is to select the electronic shutter speed. It's only available when exposure mode is a Manual shutter mode.

[Table 120] Preset Shutter SpeedShutter Speed

ValueShutter Speed

ValueNTSC Mode PAL Mode NTSC Mode NTSC Mode

1/1 1/1 0 1/250 1/215 111/2 1/2 1 1/350 1/300 121/4 1/3 2 1/500 1/425 131/8 1/6 3 1/725 1/600 14

1/15 1/12 4 1/1000 1/1000 151/30 1/25 5 1/1500 1/1250 161/60 1/50 6 1/2000 1/1750 171/90 1/75 7 1/3000 1/2500 18

1/100 1/100 8 1/4000 1/3500 191/125 1/120 9 1/6000 1/6000 201/180 1/150 10 1/10000 1/10000 21

- 211 -


(11) Preset Exposure (preset_ae_exposure): rwThis is to select the exposure. It's only available when exposure mode is a Manual exposure mode.

[Table 121] Preset Exposure ValueExposure(F-

value)Value

Close 0F14.0 1F11.0 2F9.6 3F8.0 4F6.8 5F5.6 6F4.8 7F4.0 8F3.4 9F2.8 10F2.4 11F2.0 12F1.6 13

(12) Preset Bright (preset_ae_bright): rwThis is only available for manual expore mode. It is cannot bigger then Preset Max Bright.

(13) Preset Max Bright (preset_ae_max_bright): r

(14) Preset Slow Shutter (preset_ae_slow_shutter): rwThis is to control that the slow shutter is set automatically when the brightness drops.

(15) Preset High Sensitivity (preset_ae_high_sensitivity): rwHigher sensitivity gain is applied as standard gain increases, reaching a gain level

- 212 -


as MAX gain of up to 4x the standard gain. In such cases, however, there will be a high volume noise in the image.

(16) Preset Day & Night Cotrol (preset_ae_dnn_mode): rw

[Table 122] Preset Day&Night ModeDay&Night

ModeValue

Auto 0Day 1

Night 2Global 3

(17) Preset BLC and WDR mode (preset_ae_blc_mode): rw

13-3. Tour

This is for adjusting of the Tour. These belong to the tour.php resource.

Example: Request of getting tour parameters and values.http://<ipcam>/ptz/tour.php?app=get

Example: Response of getting auto focus parameters and values.res=200&method=get_num&http_port=80&https_port=443&tour_list=0,0,0,0,0,0,0,0&tour_number=1&tour_title=T01&tour_type=0&tour_speed=4&tour_tourlist=0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0

[Table 123] Parameters of tour.php

Name TypeLengt

hDescription Value

method string Method get_autoscan,get_preset,get_tour,get_pattern,

- 213 -


set_tour,delete,get_num

tour_list string Tour List Array 1,2,3…~40(42)tour_number integer Tour Number 1~8

tour_title string 6Tour Title Capital

Alphabet,Number, Space

tour_type boolTour Type 0: Normal

1: Vectortour_speed int Tour Speed 1~17tour_tourlist string Tour List Itempreset_list string Preset List 1,2,3,…240pattern_list string Pattern List 1,2,3,…8tour_list string Tour List 1,2,3,…8auto_scan_list string Auto Scan List 1,2,3,…17

(1) Method (method): rw‘get_num’ method retrieves specific tour information. ‘get_autoscan’, ‘get_preset’, ‘get_pattern’ retrieve each other PTZ functions.

(2) Tour List Array (tour_list): rThis is the list of 0 and 1 to represent existence of tour configurations. Total count of tour configuration is 8.

(3) Tour Number (tour_number): rwThis is to select specific tour number to delete.

(4) Tour Title (tour_title): rwOnly capital alphabet, number and space are available. HDS-A411 series are not writable.

(5) Tour Type (tour_type): rwThis is to set scan type between presets in a tour list.- Normal : Move to next preset immediately.

- 214 -


- Vector : Move to next preset with scan.

(6) Tour Speed (tour_speed): rwThis is to set scan speed between presets. It’s only available for ‘Vector’ tour type

(7) Tour List Item (tour_tourlist): rwThis is the list of other PTZ functions in the tour list. The tour list can’t include the tour itself. Tour list format is as follows:Format: mode|number, mode|number

mode valuepreset 1pattern 2tour 3auto scan

4

(8) Preset List (preset_list): rThis is the list of configured preset numbers retrieved by method with ‘get_preset’. Each preset is separated by comma (,).

(9) Pattern List (pattern_list): rThis is the list of configured pattern numbers retrieved by method with ‘get_pattern’. Each pattern is separated by comma (,).

(10) Tour List (tour_list): rThis is the list of configured tour numbers retrieved by method with ‘get_tour’. Each tour is separated by comma (,).

(11) Auto Scan List (auto_scan_list): rThis is the list of configured auto scan numbers retrieved by method with ‘get_autoscan’. Each auto scan is separated by comma (,).

13-4. Pattern

- 215 -


This is for adjusting of the pattern function. These belong to the pattern.php resource.

Example: Request of getting pattern parameters and values.http://<ipcam>/video/pattern.php?app=get

Example: Response of getting pattern parameters and values.res=200&http_port=80&https_port=443&pattern_1_title=P01&pattern_1_sec=15&pattern_1_percent=5.0&pattern_2_title=P02&pattern_2_sec=0&pattern_2_percent=0.0&pattern_3_title=P03&pattern_3_sec=0&pattern_3_percent=0.0&pattern_4_title=P04&pattern_4_sec=0&pattern_4_percent=0.0&pattern_5_title=P05&pattern_5_sec=0&pattern_5_percent=0.0&pattern_6_title=P06&pattern_6_sec=0&pattern_6_percent=0.0&pattern_7_title=P07&pattern_7_sec=0&pattern_7_percent=0.0&pattern_8_title=P08&pattern_8_sec=0&pattern_8_percent=0.0

[Table 124] Parameters of pattern.php

Name TypeLengt

hDescription Value

method string

Pattern Method set_title,view,start_pattern,end_pattern,delete

pattern_number integer Pattern Number 1~8title string 6 Pattern Titlesec string Pattern Timepercent string Pattern Percentpattern_#_title string 6 Pattern List Titlepattern_#_sec string Pattern List Timepattern_#_percent string Pattern List Percent

(1) Pattern Method (method): rw‘set_title’ method sets the title. ‘view’ method retreives the configuration. ‘start_pattern’ and ‘end_pattern’ methods are start and end of the configuration. ‘delete’ method deletes the pattern.

- 216 -


(2) Pattern Number (pattern_number): rwThis is to select specific pattern number to create or delete.

(3) Pattern Title (title): rwOnly capital alphabet, number and space are available. HDS-A411 series are not writable.

(4) Pattern Time (sec): rThis is the operating time of saved pattern.

(5) Pattern Percent (percent): rThis is the used percentage of memory of saved pattern.

(6) Pattern List Title (pattern_#_title): r

(7) Pattern List Time (pattern_#_sec): r

(8) Pattern List Percent (pattern_#_percent): r

13-5. OSD

This is to configure OSD function. These belong to the osd.php resource. HDS-A411 series are not available.

Example: Request of getting OSD parameters and values.http://<ipcam>/ptz/osd.php?app=get

Example: Response of getting OSD parameters and values.res=200&osd_display=1&osd_cam_title=DOMEID&osd_focus_exposure=0

[Table 125] Parameters of osd.php

Name TypeLengt

hDescription Value

osd_display bool OSD Display 0: Off

- 217 -


1: Onosd_cam_title string Camera Title

osd_focus_exposure boolFocus Exposure Display 0: Off

1: On

(1) OSD Display (osd_display): rw

(2) Camera Title (osd_cam_title): rwOnly capital alphabet, number and space are available.

(3) Focus Exposure Display (osd_focus_exposure): rwThis is to enable or disable focus and exposure status displaying.

13-6. Home

This is to configure Home function. These belong to the home.php resource.

Example: Request of getting home parameters and values.http://<ipcam>/ptz/home.php?app=get

Example: Response of getting home parameters and values.res=200&home_function=0&home_number=0&home_waiting_time=120&home_function_use=0

[Table 126] Parameters of home.php

Name TypeLengt

hDescription Value

home_function integer

Home Function Type 0: none,1: preset,2: pattern,3: tour,4: auto scan

home_number integer Home function numberhome_waiting_time integer Waiting Time 10,15,20…,240home_function_use bool Enable/Disable Home 0: off

- 218 -


Function 1: onpreset_list string Preset List 1,2,3,…240pattern_list string Pattern List 1,2,3,…8tour_list string Tour List 1,2,3,…8auto_scan_list string Auto Scan List 1,2,3,…17

method string

Method get_homeset_home,get_preset,get_pattern,get_tour,get_autoscan

(1) Home Function Type (home_function): rwThis is to set PTZ function to home function.

(2) Home Function Number (home_number): rwThis is to set PTZ function number. The auto scan number can be adjusted in the range 1-17. The preset number can be adjusted in the range 1-240. The tour and pattern number can be adjusted in the range 1-8.

(3) Waiting Time (home_waiting_time): rwThis is timeout to execute home function. It can be adjusted in the range 10 – 240 by 5.

(4) Enable/Disable Home Function (home_function_use): rw

(5) Preset List (preset_list): rThis is the list of configured preset numbers retrieved by method with ‘get_preset’. Each preset is separated by comma (,).

(6) Pattern List (pattern_list): rThis is the list of configured pattern numbers retrieved by method with ‘get_pattern’. Each pattern is separated by comma (,).

(7) Tour List (tour_list): r

- 219 -


This is the list of configured tour numbers retrieved by method with ‘get_tour’. Each tour is separated by comma (,).

(8) Auto Scan List (auto_scan_list): rThis is the list of configured auto scan numbers retrieved by method with ‘get_autoscan’. Each auto scan is separated by comma (,).

(9) Method (method)‘set_home’ method sets the home configuration. ‘get_home’ method retreives the home configuration. The other methods retrieve the configuration of PTZ functions.

13-7. Motor Setup

This is to configure Motor Setup function. These belong to the motor.php resource.

Example: Request of getting motor parameters and values.http://<ipcam>/ptz/motor.php?app=get

Example: Response of getting motor parameters and values.res=200&motor_pt=1&motor_mode=1&motor_slow_pan=6&motor_slow_tilt=6&motor_normal_pan=10&motor_normal_tilt=10&motor_turbo_pan=16&motor_turbo_tilt=2

[Table 127] Parameters of motor.php

Name TypeLengt

hDescription Value

motor_pt boolEnable/Disable Proportional P/T

0: Disable1: Enable

motor_mode integerMotor Mode 1: Slow

2: Normal3: Turbo

motor_slow_pan integerPan Speed in Slow mode

0~16

motor_slow_tilt integer Tilt Speed in Slow mode 0~16motor_normal_pan integer Pan Speed in Normal 0~38

- 220 -


mode

motor_normal_tilt integerTilt Speed in Normal mode

0~22

motor_turbo_pan integerPan Speed in Turbo mode

0~19

motor_turbo_tilt integerTilt Speed in Turbo mode

0~22

(1) Enable/Disable Proportional P/T (motor_pt): rw

(2) Motor Mode (motor_mode) : rwThis is to set the motor mode.

(3) Pan Speed in Slow mode (motor_ slow_pan): rwThis is to set the pan speed in slow mode of motor.Range : 19(0), 22(1), 25(2), 28(3), 32(4), 36(5), 40(6), ... , 85(15), 90(16)

(4) Tilt Speed in Slow mode (motor_ slow_tilt): rwThis is to set the tilt speed in slow mode of motor.Range : 19(0), 22(1), 25(2), 28(3), 32(4), 36(5), 40(6), ... , 85(15), 90(16)

(5) Pan Speed in Normal mode (motor_normal_pan): rwThis is to set the pan speed in normal mode of motor.Range : 40(0), 45(1), 50(2), ... , 80(8), 85(9), 90(10), 95(11), 100(12), 110(13), 120(14), ... , 330(35), 340(36), 350(37), 360(38)

(6) Tilt Speed in Normal mode (motor_normal_tilt): rwThis is to set the tilt speed in normal mode of motor.Range : 40(0), 45(1), 50(2), ... , 80(8), 85(9), 90(10), 95(11), 100(12), 110(13), 120(14), ... , 330(35), 340(36), 350(37), 360(38)

(7) Pan Speed in Turbo mode (motor_turbo_pan): rwThis is to set the pan speed in turbo mode of motor.Range : 200(0), 210(1), 220(3), 230(4), 240(5), ... , 350(15), 360(16), 370(17), 380(18), 390(19)

- 221 -


(8) Tilt Speed in Turbo mode (motor_turbo_tilt): rwThis is to set the tilt speed in turbo mode of motor.Range : 90(0), 95(1), 100(2), 110(3), 120(4), 130(5), 140(6), 150(7), ... , 270(19), 280(20), 290(21), 300(22)

13-8. View Angle

This is to configure View Angle. These belong to the view_angle.php resource.

Example: Request of getting view angle parameters and values.http://<ipcam>/ptz/view_angle.php?app=get

Example: Response of getting view angle parameters and values.res=200&http_port=80&https_port=443&view_angle_tiltoverangle=1&view_angle_pan_enable=0&view_angle_pan_swap=0&view_angle_pan_autopan=1&view_angle_pan_r_limit_angle=000.0&view_angle_pan_r_limit_pos=000000&view_angle_pan_l_limit_angle=000.0&view_angle_pan_l_limit_pos=000000

[Table 128] Parameters of view_angle.php

Name TypeLengt

hDescription Value

method string

View Angle method

get_view_angle,set_view_angle,right_angle,left_angle

view_angle_tiltoverangleintege

r

Tilt Angle 0: On1: W/O Bubble2: with Bubble

view_angle_pan_enable boolEnable/Disable limit Angle in Pan

0: Off1: On

view_angle_pan_swap boolOn/Off Swap Angle 0: Off

1: On

- 222 -


view_angle_pan_autopan boolEnable/Disable View Angle in Auto Pan

0: Off1: On

view_angle_pan_r_limit_angle

stringLimit Angle of Right in Pan(Angle)

000.0

view_angle_pan_r_limit_pos stringLimit Angle of Right in Pan

XXXXXX

view_angle_pan_l_limit_angle

stringLimit Angle of Left in Pan(Angle)

000.0

view_angle_pan_l_limit_pos stringLimit Angle of Left in Pan

XXXXXX

(1) View Angle method (method): rwThis is to set angle limit direction or inquire angle position.

(2) Tilt Angle (view_angle_tiltoverangle): rw

(3) Enable/Disable limit Angle in Pan (view_angle_pan_enable): rw

(4) On/Off Swap Angle (view_angle_pan_swap): rw

(5) Enable/Disable View Angle in Auto Pan (view_angle_pan_autopan): rwThis is to enable or disable the limit angle of pan in auto pan.

(6) Limit Angle of Right in Pan (Angle) (view_angle_pan_r_limit_angle): rThis is the pan coordinate of right limit angle in pan. It is returned by method with ‘right_angle’. It is used only to be shown to the user.

(7) Limit Angle of Right in Pan (view_angle_pan_r_limit_pos): rwThis is the pan coordinate of right limit angle in pan. It is used for internal operations. Pan coordinate retrieved by 'right_angle' method should be set when view angle is saved.

(8) Limit Angle of Left in Pan (Angle) (view_angle_pan_l_limit_angle): r

- 223 -


This is the pan coordinate of left limit angle in pan. It is returned by method with ‘left_angle’. It is used only to be shown to the user.

(9) Limit Angle of Left in Pan (view_angle_pan_l_limit_pos): rwThis is the pan coordinate of left limit angle in pan. It is used for internal operations. Pan coordinate retrieved by 'left_angle' method should be set when view angle is saved.

13-9. System Menu

This is to configure System of PTZ. These belong to the system_menu.php resource.

Example: Request of getting system menu parameters and values.http://<ipcam>/ptz/system_menu.php?app=get

Example: Response of getting view angle parameters and values.res=200&sys_calibration=1&sys_dome_answer_time=3&sys_dome_answer=1&camera_type=Mega DI-SC110&dome_type=Network MegaPixel F3&hw_ver=1.1&sw_ver=1.4

[Table 129] Parameters of system_menu.php

Name TypeLengt

hDescription Value

sys_calibration boolDome Calibration 0: Off

1: On

sys_dome_answer_time integer Dome answer time 1 ~ 8(sec)

sys_dome_answer boolDome answer 0: Off

1: Oncamera_type string Camera Typedome_type string Dome Typehw_ver string Dome H/W versionsw_ver string Dome S/W version

(1) Dome Calibration (sys_calibration) : rw

- 224 -


This is to enable or disable automatic orign check.

(2) Dome Answer Time (sys_dome_answer_time) : rwThis is the delay time of dome ACK.

(3) Dome Answer (sys_dome_answer) : rwThis is enable or diable dome ACK.

(4) Camera Type (camera_type): r

(5) Dome Type (dome_type): r

(6) Dome H/W version (hw_ver): rThis is the hardware version of PTZ.

(7) Dome S/W version (sw_ver): rThis is the software version of PTZ.

13-10. RS-485

This is to configure RS-485 of PTZ. These belong to the comm.php resource.

Example: Request of getting rs-485 parameters and values.http://<ipcam>/ptz/comm.php?app=get

Example: Response of getting rs-485 parameters and values.res=200&comm_id=2&comm_protocol=0&comm_baud=2&comm_parity=0

[Table 130] Parameters of comm.php

Name TypeLengt

hDescription Value

comm_id integer Dome ID 1~3999

comm_protocol integer 485 Protocol

comm_baud bool 485 Baud ratecomm_parity string 485 Parity Bit 0: NONE

- 225 -


1: EVEN2: ODD

(1) Dome ID (comm_id) : rw

(2) 485 Protocol (comm_protocol) : rw

Protocol ValueAUTO 0

F2, F2E 1PELCO-D, PELCO-P 2

(3) 485 Baud Rate (comm_baud) : rw

Baud Rate Value2400 04800 19600 2

19200 338400 4

(4) 485 Parity Bit (comm_parity): rw

14. Image configurations for HDS-A411

Camera Mode Resolution Max Frame

MODE 1(A)

1280 x 720720 x 576720 x 480640 x 480352 x 288352 x 240320 x 240

30fps

MODE 1(B) 1280 x 960 20fpsMODE 2(A) 1280 x 720 25fps

- 226 -


720 x 576720 x 480640 x 480352 x 288352 x 240320 x 240

MODE 2(B) 1280 x 960 16.7fps※ MODE 1: NTSC MODE※ MODE 2: PAL MODE

14-1. Image


Example: Request of getting image appearance parameters and values.http://<ipcam>/video/image.php?app=get

Example: Response of getting image appearance parameters and values.res=200&http_port=80&https_port=443&sharpness=32&flip=0&preset_freeze=0&fnr_mode=0&fnr_level=8&d_zoom_enable=0&d_zoom=0


Name TypeLengt

hDescription Value

sharpness integerSharpness * Auto: 32

(default)Manual : 0~31


(default)Enable: 1

preset_freeze bool Enable/Disable Preset freeze

*Disable: 0(default)

- 227 -


Enable : 1

fnr_mode intFrame Noise Reduction * Off: 0

(default)fnr_level int FNR Level 0~15

d_zoom_enable boolEnable/Disable Digital Zoom Function

*Disable: 0(default)Enable : 1

d_zoom boolEnable/Disable Digital Zoom


(1) Sharpness (sharpness): rwThis is to control the clarity of detail in a scene. The lower value makes more softened image.

(2) Flip (flip): rwThis is to enable or disable flip image rotates the original image 180 degrees vertically. Please refer image (B) in [Table 133] and [Table 134].

(3) Preset freeze (preset_freeze): rwThis is to enable or disable image freezing during preset moving.

(4) FNR (fnr_mode): rwThis is to control FNR. Please refer [Table 132].

[Table 132] FNR ValueFNR ValueOff 0

Low (week) 1Middle 2

High (String) 3Manual 4

(5) FNR Level (fnr_level): rwThis is to control FNR Level. (Range: 0[week] ~ 15[strong])

- 228 -


(6) Digital Zoom function (d_zoom_enable): rThis is to notify that the function of D-Zoom is enable or not. D-Zoom can use only in 1280X960 resolution.

(7) Digital Zoom (d_zoom): rw



[Table 134] Max Frame RateFlip on FNR on Flip FNR off

1280×960 ResolutionMax Frame Rate

15fps 15fps 20 / 16.7 fps

The others Resolution22.5fps 22.5fps 30 / 25 fps

Max Frame Rate

14-2. AE

The AE is to control exposure of camera sensor.

Example: Request of getting ae parameters and values.http://<ipcam>/video/ae.php?app=get

Example: Response of getting ae parameters and values.res=200&http_port=80&https_port=443&ae_mode=2&ae_dss_limit_list= 1/301/15|11/8|2

- 229 -


1/4|3&ae_dss_limit=1&ae_iris_offset=144&ae_iris_peak=8&ae_gain=1&ae_shutter_speed=11&ae_exposure=2&ae_event_out_day_night=0&ae_dnn_mode=0&ae_blc_mode=0&ae_blc_level=4&ae_wdr_level=64

[Table 135] Parameters of ae_awb.php

Name TypeLengt

hDescription Value

ae_mode integer Exposure mode *[Table 136]ae_dss_limit_list string Array of stringsae_dss_limit integer DSS Limit *[Table 137]

ae_iris_offset integerIris Offset 0 ~ 255

* default: 244

ae_iris_peak integerIris Peak 0 ~ 127

* default: 8ae_gain integer Manual AGC gain *[Table 138]


*[Table 139]

ae_exposure integer *[Table 140]

ae_event_out_day_night

boolEnable/Disable Day and Night Function

*Disable: 0Enable : 1(default)

ae_dnn_mode integer *[Table 141]ae_blc_mode integer WDR & BLC Mode *[Table 142]ae_blc_level integer BLC Level *[Table 143]ae_wdr_level integer WDR Level 0 ~ 254

[Table 136] Exposure ModeValue Exposure Mode

0 Auto1 Auto with DAWN2 Auto with DARK3 Auto with DSS4 Manual Gain5 Manual Shutter6 Manual Exposure

- 230 -


[Table 137] DSS Limit ListMODE DSS Limit Value MODE DSS Limit Value

The Other Resolution/ FNR, Flip, Mirror off

1/30 0 1280×960 Resolution/ FNR, Flip, Mirror off

1/20 01/15 1 1/15 11/8 2 1/8 21/4 3 1/4 3

The Other Resolution/ FNR, Flip, Mirror on

1/22.5 0 1280×960 Resolution/ FNR, Flip, Mirror on

1/15 1 1/15 11/8 2 1/8 21/4 3 1/4 3

(1) Exposure Mode (ae_mode): rwThe Exposure mode is to control the amount of light detected by the camera sensor base on settings for light conditions. Manual exposure is recommended only for indoor applications that have a single unchanging primary light source. The default setting is automatic.

(2) Digital Slow Shutter Limit List (ae_dss_limit_list): rThis is the select list of DSS limit. Each focus mode item is delimited by ‘\n’ (0x0D 0x0A) and ‘|’.Ex) DSS Limit1 | DSS Limit1_Value \n DSS Limit2 | DSS Limit2_Value

(3) Digital Slow Shutter Limit (ae_dss_limit): rw

(4) Iris Offset (ae_iris_offset): rwSet the overall brightness of a picture.

(5) Iris Peak (ae_iris_peak): rwSet the effect of focusing peak, or how video peaks affect the overall picture brightness.


- 231 -


[Table 138] AGC Gain ValueAGC Gain Value

0 06 1

12 218 324 430 5

(7) Shutter Speed (ae_shutter_speed): rwSelect the electronic shutter speed. It's only available when Exposure mode is a Manual shutter mode. The range of shutter speed value is in [Table 139]. A slower speed in dark conditions will help to produce a brighter image, but will produce fewer frames per second, which may cause blurry images during motion.

[Table 139] Shutter SpeedShutter Speed

Value

1/10000 01/4000 11/2000 21/1000 31/500 41/250 51/180 61/120 71/100 81/60 91/50 101/30 111/15 121/8 131/4 14

(8) Exposure (ae_exposure): rw

- 232 -


Select the exposure. It's only available when Exposure mode is a Manual exposure mode. The range of exposure value is in [Table 140].

[Table 140] Exposure ValueExposure(F-

value)Value

F1.6 0F2.2 1F3.2 2F4.4 3F6.4 4F8.8 5F12 6F17 7F24 8F34 9

(9) Day and Night function (ae_event_out_day_night): rThis is to notify that the function of normal Day and Night function in AE&AWB function. In order to use the normal Day & Night mode, uncheck the Day & Night checkbox in the Event / Event Map / Modify / Day & Night.

(10) Day & Night mode (ae_dnn_mode): rw

[Table 141] Day&Night ModeDay&Night

ModeValue

Auto 0Day 1

Night 2Global 3

(11) BLC and WDR mode (ae_blc_mode): rw

[Table 142] BLC/WDR Mode

- 233 -


BLC Mode ValueOff 0

WDR 1BLC 2

(12) BLC Level (ae_blc_level): rw

[Table 143] BLC LevelBLC Level ValueVery High 0

High 1Middle 2

Low 3Very Low 4

(13) WDR Level (ae_wdr_level): rw

14-3. Auto Focus

This is for adjusting of the Auto Focus. These belong to the auto_focus.php resource.

Example: Request of getting auto focus parameters and values.http://<ipcam>/video/auto_focus.php?app=get

Example: Response of getting auto focus parameters and values.res=200&http_port=80&https_port=443&focus_mode=0&focus_limit=2

[Table 144] Parameters of auto_focus.php

Name TypeLengt

hDescription Value

focus_mode integer Focus Mode *[Table 145]focus_limit integer Focus Limit *[Table 146]

(1) Focus mode (focus_mode): rw

- 234 -


[Table 145] Focus ModeFocus Mode Value

Auto 0Manual 1


(2) Focus limit (focus_mode): rw

[Table 146] Focus Limit

14-4. White Balance

This is for adjusting of the white balance. These belong to the white_balance.php resource.

Example: Request of getting auto white balance parameters and values.http://<ipcam>/video/white_balance.php?app=get

Example: Response of getting white balance parameters and values.res=200&http_port=80&https_port=443&wb_mode=0&wb_rgain=100&wb_bgain=100

[Table 147] Parameters of white_balance.php

Name TypeLengt

hDescription Value

wb_mode integer Automatic White Balance mode

0: Auto1: Indoor

Focus Limit Value1 cm 0

10 cm 130 cm 21 m 3

1.5 m 4

- 235 -


2: Outdoor3: Manual

wb_rgain integerWhite balance manual R gain

0 ~ 255

wb_bgain integerWhite balance manual B gain

0 ~ 255

(1) White Balance Mode (wb_mode): rwIt provides the options for White Balance. The default setting is automatic.

AutoAutomatically delivers the best possible image by adjusting the white balance based on the colors in the scene. IndoorSelect when the camera is installed at indoor. OutdoorSelect when the camera is installed at outdoor. Manual gainEnter the manual gain setting mode.

(2) White Balance R Gain (wb_rgain): rwThe White balance R gain adjusts the picture output in the red range (0-255). The higher value produces higher red image.

(3) White Balance B Gain (wb_bgain): rwThe White balance B gain adjusts the picture output in the blue range (0-255). The higher value produces a higher blue image.

15. Image configurations for HDZ-A411, HDA-A411F

- 236 -


※ MODE 1: NTSC MODE※ MODE 2: PAL MODE

15-1. Image



Example: Response of getting image appearance parameters and values.res=200&http_port=80&https_port=443&sharpness=32&flip=0&mirror=0&focus_mode=0&focus_limit=2&fnr_mode=0&fnr_level=0&d_zoom_enable=0&d_zoom=0


Name TypeLengt

hDescription Value

sharpness integerSharpness * Auto: 32

(default)Manual : 0~31

Camera Mode Resolution Max Frame

MODE 1(A)

1280 x 720720 x 576720 x 480640 x 480352 x 288352 x 240320 x 240

30fps

MODE 1(B) 1280 x 960 20fps

MODE 2(A)

1280 x 720720 x 576720 x 480640 x 480352 x 288352 x 240320 x 240

25fps

MODE 2(B) 1280 x 960 16.7fps

- 237 -



(default)Enable: 1


(default)Enable : 1

focus_mode boolFocus Mode * Auto: 0

(default)Manual: 1

focus_limit int Focus Limit 0~4

fnr_mode intFrame Noise Reduction * Off: 0

(default)fnr_level int FNR Level 0~15

d_zoom_enable boolEnable/Disable Digital Zoom Function


d_zoom boolEnable/Disable Digital Zoom


(1) Sharpness (sharpness): rwThe Sharpness is to control the clarity of detail in a scene. The lower value makes more softened image.

(2) Flip (flip): rwThe Enable flip image rotates the original image 180 degrees vertically. Please refer image (B) in [Table 151] and [Table 152].

(3) Mirror (mirror): rwThe Enable mirror image generates mirrored image by rotating the original image 180 degrees horizontally. Please refer image (C) in [Table 151] and [Table 152].



- 238 -


[Table 149] Focus LimitFocus Limit Value

1 cm 010 cm 130 cm 21 m 3

1.5 m 4

(7) FNR (fnr_mode): rw

[Table 150] FNRFNR ValueOff 0

Low (week) 1Middle 2

High (String) 3Manual 4

(8) FNR Level (fnr_level): rwThis is to control FNR Level. (Range: 0[week] ~ 15[strong])

(9) Digital Zoom function (d_zoom_enable): rThis is to notify that the function of D-Zoom is enable or not. D-Zoom can use only in 1280X960 resolution.



- 239 -





[Table 152] Max Frame RateFlip or Mirror

onFNR on

Flip, Mirror, FNR off

1280×960 ResolutionMax Frame Rate

15fps 15fps 20 / 16.7 fps

The others Resolution22.5fps 22.5fps 30 / 25 fps

Max Frame Rate

15-2. AE & AWB

The AE & AWB is to control exposure and white balance of camera sensor.

Example: Request of getting ae&awb parameters and values.http://<ipcam>/video/ae_awb.php?app=get

Example: Response of getting ae&awb parameters and values.res=200&http_port=80&https_port=443&ae_mode=0&ae_dss_mode=0&ae_dss_limit_list=1/301/15|11/8|21/4|3&ae_dss_limit=3&ae_gain=5&ae_shutter_speed=6&ae_exposure=2&ae_event_out_day_night=0&ae_dnn_mode=0&ae_dnn_irmode=1&ae_dnn_level=2&ae_blc_mode=0&ae_blc_level=0&wb_mode=0&wb_rgain=128&wb_bgain=128


Name TypeLengt

hDescription Value


ae_dss_mode boolEnable/Disable DSS *Disable: 0

(default)Enable : 1

- 240 -


ae_dss_limit_list string Array of stringsae_dss_limit integer DSS Limit *[Table 155]ae_gain integer Manual AGC gain *[Table 156]


*[Table 157]

ae_exposure integer *[Table 158]

ae_event_out_day_night

boolEnable/Disable Day and Night Function

*Disable: 0Enable : 1(default)

ae_dnn_mode integer *[Table 159]ae_dnn_irmode integer *[Table 160]

ae_dnn_level integer

*[Table 161]

ae_blc_mode integer WDR & BLC Mode *[Table 162]ae_blc_level integer BLC Level *[Table 163]

wb_mode integer

Automatic White Balance mode

0: Auto1: Indoor2: Outdoor3: Manual


0 ~ 255

wb_bgain integerWhite balance manual B gain

0 ~ 255

[Table 154] Exposure ModeValue Exposure Mode

0 Auto Exposure mode1 Exposure manual gain control mode2 Exposure manual shutter speed mode3 Exposure manual exposure mode.

[Table 155] DSS Limit List

- 241 -


MODE DSS Limit Value MODE DSS Limit ValueThe Other Resolution/ FNR, Flip, Mirror off

1/30 0 1280×960 Resolution/ FNR, Flip, Mirror off

1/20 01/15 1 1/15 11/8 2 1/8 21/4 3 1/4 3

The Other Resolution/ FNR, Flip, Mirror on

1/22.5 0 1280×960 Resolution/ FNR, Flip, Mirror on

1/15 1 1/15 11/8 2 1/8 21/4 3 1/4 3


(2) AE Digital Slow Shutter Mode (ae_dss_mode): rwThis is to control the digital slow shutter.

(3) Digital Slow Shutter Limit List (ae_dss_limit_list): rThis is the select list of DSS limit. Each focus mode item is delimited by ‘\n’ (0x0D 0x0A) and ‘|’.ex) DSS Limit1 | DSS Limit1_Value \n DSS Limit2 | DSS Limit2_Value

(4) Digital Slow Shutter Limit (ae_dss_limit): rw


[Table 156] AGC Gain ValueAGC Gain Value

0 06 1

12 2

- 242 -


18 324 430 5

(6) Shutter Speed (ae_shutter_speed): rwSelect the electronic shutter speed. It's only available when Exposure mode is a Manual shutter mode. A slower speed in dark conditions will help to produce a brighter image, but will produce fewer frames per second, which may cause blurry images during motion.


Value

1/10000 01/4000 11/2000 21/1000 31/500 41/250 51/180 61/120 71/100 81/60 91/50 101/30 111/15 121/8 131/4 14

(7) Exposure (ae_exposure): rwSelect the exposure. It's only available when Exposure mode is a Manual exposure mode.

[Table 158] Exposure ValueExposure(F- Value

- 243 -


value)F1.6 0F2.2 1F3.2 2F4.4 3F6.4 4F8.8 5F12 6F17 7F24 8F34 9

(8) Day and Night function (ae_event_out_day_night): rThis is to notify that the function of normal Day and Night function in AE&AWB function. In order to use the normal Day & Night mode, uncheck the Day & Night checkbox in the Event / Event Map / Modify / Day & Night.



ModeValue

Auto 0Day 1

Night 2

(10) Day & Night sensitivity (ae_dnn_level): rwThis is to configure the day and night sensitivity when the dnn_mode is auto mode.

(11) Day & Night IR Mode (ae_dnn_irmode)This is to configure the IR mode when the dnn_mode is night mode.

[Table 160] IR StatusIR Mode Value

Off 0

- 244 -


Turn on All IR 1Turn on Center IR 2Turn on Side IR 3

[Table 161] Day&Night SensitivityDay&Night Sensitivity

Value

Low 0Middle 1High 2


[Table 162] BLC ModeBLC Mode Value

Off 0WDR 1BLC 2

(13) BLC Level (ae_blc_level): rw

[Table 163] BLC LevelBLC Level ValueVery High 0

High 1Middle 2

Low 3Very Low 4

[Table 164] Day&Night and WDR function by Exposure ModeExposure Mode Day & Night WDRAuto DSS On Auto/Manual

[Sensitivity: High, Middle]○ [on/off]

- 245 -


DSS OffAuto/Manual

[Sensitivity: High, Middle, Low]○ [on/off]

Manual Gain Manual Only ×Manual Shutter Manual Only ×

Manual Exposure Manual Only ×

(14) White Balance Mode (wb_mode): rwIt provides the options for White Balance. The default setting is automatic.

AutoAutomatically delivers the best possible image by adjusting the white balance based on the colors in the scene. IndoorSelect when the camera is installed at indoor. OutdoorSelect when the camera is installed at outdoor. Manual gainEnter the manual gain setting mode.



16. Image configurations for HDS-S422W

16-1. Image


- 246 -



Example: Response of getting image appearance parameters and values.res=200&http_port=80&https_port=443&brightness=7&sharpness=10&gain_limit=9&custom_gamma=0&chroma=2&flip=0&preset_freeze=0&nr_level=4&moving_nr_level=2&dnn_threshold=19&d_zoom=0


Name TypeLengt

hDescription Value

brightness integerbrightness control 0 ~ 14(-7~7)

* default: 7(0)

sharpness integerSharpness 0 ~ 15

* default: 10gain_limit integer Gain Limit *[Table 166]custom_gamma integer gamma correction *[Table 167]chroma integer chroma correction *[Table 168]


(default)Enable: 1

preset_freeze boolEnable/Disable Preset freeze


nr_level integerNoise Reduction 0 ~ 5(Off, 1~5)

* default: 4

moving_nr_level integerNoise Reduction 0 ~ 5(Off, 1~5)

* default: 2

dnn_threshold integerDay & Night Threshold 0~28

* default: 19

d_zoom integer

Enable/Disable Digital Zoom

*Off: 0(default)x2 : 1x4 : 2Max : 3

- 247 -


(1) Brightness (brightness): rw


(3) Gain Limit (ae_gain_limit): rw

[Table 166] Gain LimitGain Limit(dB) Value Gain Limit(dB) Value

6 0 18 68 1 20 7

10 2 22 812 3 24 914 4 26 1016 5 28 11

(4) Custom Gamma(custom_gamma): rwControl the gamma correction. Blocked-up shadows in images will be more noticeable than usual.

[Table 167] Custom GammaCustom Gamma Value

Standard [default] 0Straight gamma 1S-curve - Low 2S-curve - Middle 3S-curve - High 4

(5) Chroma (chroma): rwConfigure a chroma suppress mode for low-illumination conditions.

[Table 168] ChromaChroma Value

- 248 -


Off 0Low 1Middle [default] 2High 3

(6) Flip (flip): rwThe Enable flip image rotates the original image 180 degrees vertically.



(7) Preset freeze (preset_freeze): rwThe Enable freeze image is freezing during preset moving.

(8) Noise Reduction Level (nr_level): rwThe NR(Noise Reduction) function removes noise to provide clearer images.

(9) Moving Noise Reduction Level (moving_nr_level): rwThe NR(Noise Reduction) function removes noise to provide clearer images during Pan and Tilt is working.

(10) Day & Night Threshold (dnn_threshold): rwThis is to configure the day and night sensitivity when the dnn_mode is auto mode.


16-2. AE

- 249 -


The AE is to control exposure of camera sensor.

Example: Request of getting ae parameters and values.http://<ipcam>/video/ae.php?app=get

Example: Response of getting ae parameters and values.res=200&http_port=80&https_port=443&ae_tv_mode=ntsc&ae_event_out_day_night=0&ae_mode=0&ae_slow_ae_response=0&ae_shutter_speed=5&ae_exposure=13&ae_gain=4&ae_bright=16&ae_max_bright=25&ae_slow_shutter=0&ae_high_sensitivity=0&ae_dnn_mode=0&ae_blc_mode=0


Name TypeLengt

hDescription Value

ae_tv_mode stringTV Out Mode ntsc

palae_event_out_day_night

boolDay&Night Control with Alarm Input

0: Disable1: Enable


ae_slow_ae_response integerSlow AE Response 0 ~ 47(1~48)

* default: 0

ae_shutter_speed integerShutter speed 0 ~ 21

* default: 5*[Table 172]

ae_exposure integerExposure 0 ~ 13

*[Table 173]ae_gain integer Exposure Gain *[Table 174]ae_bright integer Bright 0 ~ 27ae_max_bright integer Max Bright

ae_slow_shutter boolSlow Shutter Off: 0 [default]

On: 1

ae_high_sensitivity boolHigh Sensitivity *Off: 0

(default)On: 1

ae_dnn_mode integer Day & Night Cotrol *[Table 175]

- 250 -


ae_blc_mode integer

BLC and WDR mode 0: Off1: BLC2: WDR3: WDR-Auto

(1) TV Out Mode (ae_tv_mode): rThis is one of the TV out modes, NTSC and PAL.

(2) Day&Night Control with Alarm Input (ae_event_out_day_night): rThis is to notify that the function of normal Day and Night function in AE&AWB function. In order to use the normal Day & Night mode, uncheck the Day & Night checkbox in the Event / Event Map / Modify / Day & Night.


[Table 171] Exposure ModeExposure Mode Value

Auto [default] 0Manual 1Manual Exposure 2Manual 3Manual Bright 4

(4) Slow AE Response (ae_slow_ae_response): rwSlow auto exposure allows you to reduce the exposure response speed.

(5) Shutter Speed (ae_shutter_speed): rwSelect the electronic shutter speed. It's only available when Exposure mode is a Manual shutter mode.

[Table 172] Shutter Speed

- 251 -


Shutter SpeedValue

Shutter SpeedValue

NTSC Mode PAL Mode NTSC Mode NTSC Mode1/1 1/1 0 1/250 1/215 111/2 1/2 1 1/350 1/300 121/4 1/3 2 1/500 1/425 131/8 1/6 3 1/725 1/600 14

1/15 1/12 4 1/1000 1/1000 151/30 1/25 5 1/1500 1/1250 161/60 1/50 6 1/2000 1/1750 171/90 1/75 7 1/3000 1/2500 18

1/100 1/100 8 1/4000 1/3500 191/125 1/120 9 1/6000 1/6000 201/180 1/150 10 1/10000 1/10000 21


[Table 173] Exposure ValueExposure(F-

value)Value

Close 0F14.0 1F11.0 2F9.6 3F8.0 4F6.8 5F5.6 6F4.8 7F4.0 8F3.4 9F2.8 10F2.4 11F2.0 12F1.6 13

- 252 -



[Table 174] Gain ValueGain(dB) Value Gain(dB) Value Gain(dB) Value

-3 0 10 6 22 120 1 12 7 24 132 2 14 8 26 144 3 16 9 28 156 4 18 108 5 20 11

(8) Bright (ae_bright): rwThis is only available for manual bright exposure mode.

(9) Max Bright (ae_max_bright): rThis is the maximum value of ae_bright.

(10) Slow Shutter (ae_slow_shutter): rwControl that the slow shutter is set automatically when the brightness drops.

(11) High Sensitivity (high_sensitivity): rwHigher sensitivity gain is applied as standard gain increases, reaching a gain level as MAX gain of up to 4x the standard gain. In such cases, however, there will be a high volume noise in the image.



ModeValue

Auto 0Day 1

- 253 -


Night 2Global 3


16-3. Auto Focus

This is for adjusting of the Auto Focus. These belong to the auto_focus.php resource.

Example: Request of getting auto focus parameters and values.http://<ipcam>/video/auto_focus.php?app=get

Example: Response of getting auto focus parameters and values.res=200&http_port=80&https_port=443&focus_sensitivity=1&focus_mode=0&focus_limit=2

[Table 176] Parameters of auto_focus.php

Name TypeLengt

hDescription Value

focus_mode integer Focus Mode *[Table 177]

focus_sensitivity integerFocus sensitivity *Low: 0

Normal : 1(default)

focus_limit integer Focus Limit *[Table 178]



Auto 0Manual 1


(2) Auto Focus Sensitivity (focus_sensitivity): rw

- 254 -


Control the Auto Focus sensitivity.

(3) Focus limit (focus_mode): rwThis is to control focus limit.

[Table 178] Focus LimitFocus Limit Value Focus Limit Value

1 cm 0 2.3 m 78 cm 1 2.9 m 8

30 cm [default] 2 3.7 m 91 m 3 4.9 m 10

1.23 m 4 7 m 111.5 m 5 11 m 12

1.85 m 6 25m 13

16-4. White Balance

This is for adjusting of the white balance. These belong to the white_balance.php resource.

Example: Request of getting auto white balance parameters and values.http://<ipcam>/video/white_balance.php?app=get

Example: Response of getting white balance parameters and values.res=200&http_port=80&https_port=443&wb_mode=0&wb_rgain=100&wb_bgain=100

[Table 179] Parameters of white_balance.php

Name TypeLengt

hDescription Value

wb_mode integerAutomatic White Balance mode

*[Table 180]


0 ~ 255

wb_bgain integer White balance manual 0 ~ 255

- 255 -


B gain

(1) White Balance Mode (wb_mode): rw

[Table 180] White BalanceWhite Balance Mode ValueAuto 0Indoor 1Outdoor 2ATW 3Manual Gain 4Outdoor Auto 5Sodium Lamp Auto 6Sodium Lamp 7



16-5. Privacy Masking

This is to configure privacy masking the video. The masked areas would be shown black or gray color. These belong to the masking.php resource.

Example: Request of getting auto white balance parameters and values.http://<ipcam>/video/masking.php?app=get

Example: Response of getting Privacy Masking parameters and values.res=200&http_port=80&https_port=443&masking1_set=0&masking1_enable=0&masking1_color=0&masking2_set=0&masking2_enable=0&masking2_color=0&masking3_set=0&masking3_enable=0&masking3_color=0&masking4_set=0&masking4_e

- 256 -


nable=0&masking4_color=0&masking5_set=0&masking5_enable=0&masking5_color=0&masking6_set=0&masking6_enable=0&masking6_color=0&masking7_set=0&masking7_enable=0&masking7_color=0&masking8_set=0&masking8_enable=0&masking8_color=0&masking9_set=0&masking9_enable=0&masking9_color=0&masking10_set=0&masking10_enable=0&masking10_color=0&masking11_set=0&masking11_enable=0&masking11_color=0&masking12_set=0&masking12_enable=0&masking12_color=0

[Table 181] Parameters of masking.php

Name TypeLengt

hDescription Value

method string

Create, Modify and Delete or go to Masking Area

create,delete,modify,move

masking_number integerPrivacy masking number

1~12

masking#_set boolMasking Setting *None: 0

(default)Exist : 1

masking#_enable bool Enable/Disable Masking

Enable: 1Disable: 0

masking#_color boolMasking Color *Black: 0

(default)Gray : 1

(1) Method (method): rwThis is the method to operate, create, modify or delete. To create masking area, the method values are required. To delete or go to masking area, the masking_number and method is required. To modify masking area, the masking_number, masking_color and masking_enable values are required.

(2) Privacy masking number(masking_number): rwFor controlling the masking area(create, delete, moving or modify), the masking_number is required.

- 257 -


(3) Masking Setting(masking#_set): rThe masking_set indicates the masking area is setting or not.

(4) Enable/Disable Masking (masking_enable): rwThis is to enable/disable masking for the specified masking number.

(5) Masking Color (masking_enable): rwThis is to control the masking color. (balck or gray)

17. Image configurations for HDZ-P622, HDA-S422F, HDG-M220F

17-1. Image



Example: Response of getting image appearance parameters and values.res=200&http_port=80&https_port=443&brightness=7&sharpness=10&color_gain=4&high_resolution=1&high_sensitivity=0&custom_gamma=0&chroma=2&nr_level=4&flip=0&mirror=0&af_mode=0&af_active=4&af_interval=4&af_sensitivity=1&af_speed=0&af_limit=2&d_zoom=1&zoom_speed=0


Name TypeLengt

hDescription Value

brightness integerbrightness control 0 ~ 14(-7~7)

* default: 7(0)

sharpness integerSharpness 0 ~ 15

* default: 10

- 258 -


color_gain integerCustom Color Gain 0 ~ 16

* default: 4

high_resolution bool*Off: 0On: 1(default)

high_sensitivity bool*Off: 0(default)On: 1

custom_gamma integer gamma correction *[Table 184] chroma integer chroma correction *[Table 185]

pic_effect integer

Picture Effect [Model: HDG-M220F]0: Off1: Net. Art2: Monochrome


(default)Enable: 1


(default)Enable : 1

nr_level integerNoise Reduction 0 ~ 5(Off, 1~5)

* default: 4

af_mode integer

Focus Mode 0 ~ 3* default: 0(Auto)

*[Table 186]

af_active integerAuto Focus Active Time [sec]

0~254(1~255)* default: 4

af_interval integerAuto Focus idle time [sec]

0~254(1~255)* default: 4

af_sensitivity integerFocus sensitivity *Low: 0

Normal : 1(default)

af_speed integer Focus Speed Level 0~8

- 259 -


(0: Standard,1~8: Speed Level)

af_limit integer Focus Limit *]

af_smart_focus integer

Smart Focus [Model: HDG-M220F]0: Off1: Day & Night2: Zoom3: All

d_zoom integerEnable/Disable Digital Zoom


zoom_speed integer

Zoom speed 0~8(0: Standard,1~8: Speed Level)

(1) Brightness (brightness): rw


(3) Custom Color Gain (color_gain): rw

[Table 183] Custom Color GainCustom Color Gain Value60% 070% 180% 290% 3100% 4110% 5120% 6

- 260 -


130% 7140% 8150% 9160% 10170% 11180% 12190% 13200% 14

(4) High Resolution (high_resolution): rwEnhance edges and produces higher definition images.

(5) High Sensitivity (high_sensitivity): rwHigher sensitivity gain is applied as standard gain increases, reaching a gain level as MAX gain of up to 4x the standard gain. In such cases, however, there will be a high volume noise in the image.

(6) Custom Gamma (custom_gamma): rwControl the gamma correction. Blocked-up shadows in images will be more noticeable than usual.

[Table 184] Custom GammaCustom Gamma Value

Standard [default] 0Straight gamma 1S-curve - Low 2S-curve - Middle 3S-curve - High 4

(7) Chroma (chroma): rwConfigure a chroma suppress mode for low-illumination conditions.

[Table 185] ChromaChroma Value

Off 0

- 261 -


Low 1Middle [default] 2High 3

(8) Picture Effect (pic_effect): rwThis is to set Negative Art effect or Monochrome effect. This is only available for HDG-M220F series.

(9) Flip (flip): rwThe Enable flip image rotates the original image 180 degrees vertically.

(10) Mirror (mirror): rwThe Enable mirror image generates mirrored image by rotating the original image 180 degrees horizontally.

(11) Noise Reduction (nr_level): rwThe NR(Noise Reduction) function removes noise to provide clearer images.

(12) Focus mode (focus_mode): rwThis is only available for HDZ-P622 and HDA-S422F series.


Auto [default] 0Interval Auto 1Zoom trigger Auto 2Manual 3

(13) Auto Focus Active Time (af_active): rwThis is auto focus active time for Interval Auto mode. This is only available for HDZ-P622 and HDA-S422F series.

(14) Auto Focus Idle Time (af_interval): rwThis is auto focus idle time for Interval Auto mode. This is only available for HDZ-P622 and HDA-S422F series.

- 262 -


(15) Auto Focus Sensitivity (af_sensitivity): rwThis is only available for HDZ-P622 and HDA-S422F series.

(16) Focus Speed Level (af_speed): rw


[Table 187] Focus Limit- HDZ-P622 and HDA-S422F series.

Focus Limit Value Focus Limit Value1 cm 0 2.3 m 78 cm 1 2.9 m 8

30 cm [default] 2 3.7 m 91 m 3 4.9 m 10

1.23 m 4 7 m 111.5 m 5 11 m 12

1.85 m 6 25m 13

- HDG-M220F CameraFocus Limit Value

Under 30 cm 030 cm 1

(18) Smart Focus (af_dnn_change): rwThis is to enable or disable smart focus when day and night changed or zooming. This is only available for HDG-M220F series.


(20) Zoom Speed (zoom_speed): rw


- 263 -





17-2. AE & AWB

The AE & AWB is to control exposure and white balance of camera sensor.

Example: Request of getting ae&awb parameters and values.http://<ipcam>/video/ae_awb.php?app=get

Example: Response of getting ae&awb parameters and values.res=200&rtsp_port=554&http_port=80&https_port=443&ae_tv_mode=ntsc&ae_event_out_day_night=0&ae_mode=0&ae_spot=0&ae_spot_x=8&ae_spot_y=8&ae_slow_ae_response=0&ae_gain_limit=9&ae_shutter_speed=5&ae_exposure=13&ae_gain=2&ae_bright=14&ae_slow_shutter=0&ae_dnn_mode=0&ae_dnn_threshold=19&ae_dnn_irmode=1&ae_blc_mode=0&wb_mode=3&wb_rgain=210&wb_bgain=158


Name TypeLengt

hDescription Value

ae_tv_mode stringTV Out Mode ntsc

palae_event_out_day_night

boolDay&Night Control with Alarm Input

0: Disable1: Enable

ae_mode integer Exposure mode *[Table 190

ae_spot boolSpot Exposure 0: Off [default]

1: On

ae_spot_x integerX position of Spot Exposure

- 264 -


ae_spot_y integerY position of Spot Exposure

ae_slow_ae_response integerSlow AE Response 0 ~ 47(1~48)

* default: 0ae_gain_limit integer Gain Limit *]

ae_shutter_speed integerShutter speed 0 ~ 21

* default: 5*[Table 192]

ae_exposure integerExposure 0 ~ 13

*[Table 193]ae_gain integer Exposure Gain *[Table 194]

ae_bright integer

Bright [Model:HDZ-P622, HDA-S422F]0 ~ 27*default: 14[Model: HDG-M220F]0 ~ 31*default: 18*[Table 195]

ae_slow_shutter boolSlow Shutter Off: 0 [default]

On: 1ae_dnn_mode integer Day & Night Cotrol * [Table 196]

ae_dnn_threshold integerDay & Night Threshold 0~28

* default: 19ae_dnn_irmode integer Day & Night IR Mode [Model:

HDA-S422F]0: Off1: All [default]2: Center3: Side[Model: HDG-M220F]Off: 0

- 265 -


On: 1 [default]

ae_blc_mode integerBLC and WDR mode 0~5

*]wb_mode integer *]wb_rgain integerwb_bgain integer

(1) TV out Mode (ae_tv_mode): rThis is one of the TV out modes, NTSC and PAL.

(2) Day&Night Control with Alarm Input (ae_event_out_day_night): rThis is to notify that the function of normal Day and Night function in AE&AWB function. In order to use the normal Day & Night mode, uncheck the Day & Night checkbox in the Event / Event Map / Modify / Day & Night.


[Table 190] Exposure ModeExposure Mode Value

Auto [default] 0Manual 1Manual Exposure 2Manual Shutter 3Manual Bright 4

(4) Spot Exposure (ae_spot): rwThe spot exposure allows that iris and gain can be optimized to obtain an image for a particular section of the subject.

(5) X position of Spot Exposure (ae_spot_x): rwThis is the X position(0 ~ 15) of the grid divide the screen 16 x 16.

- 266 -


(6) Y position of Spot Exposure (ae_spot_y): rwThis is the Y position(0 ~ 15) of the grid divide the screen 16 x 16.

(7) Slow AE Response (ae_slow_ae_response): rwSlow auto exposure allows you to reduce the exposure response speed.

(8) Gain Limit (ae_gain_limit): rw

[Table 191] Gain LimitGain Limit(dB) Value Gain Limit(dB) Value

6 0 18 68 1 20 7

10 2 22 812 3 24 [default] 914 4 26 1016 5 28 11

(9) Shutter Speed (ae_shutter_speed): rwSelect the electronic shutter speed. It's only available when Exposure mode is a Manual shutter mode.


ValueShutter Speed

ValueNTSC Mode PAL Mode NTSC Mode NTSC Mode

1/1 1/1 0 1/250 1/215 111/2 1/2 1 1/350 1/300 121/4 1/3 2 1/500 1/425 131/8 1/6 3 1/725 1/600 14

1/15 1/12 4 1/1000 1/1000 151/30 1/25 5 1/1500 1/1250 161/60 1/50 6 1/2000 1/1750 171/90 1/75 7 1/3000 1/2500 18

1/100 1/100 8 1/4000 1/3500 191/125 1/120 9 1/6000 1/6000 20

- 267 -


1/180 1/150 10 1/10000 1/10000 21


[Table 193] Exposure Value

Exposure(F-value)MODEL: HDZ-P622,

HDA-S422F

Exposure(F-value)

MODEL:HDG-M220F

Value

Close Close 0F14.0 F19.0 1F11.0 F16.0 2F9.6 F14.0 3F8.0 F11.0 4F6.8 F9.6 5F5.6 F8.0 6F4.8 F6.8 7F4.0 F5.6 8F3.4 F4.8 9F2.8 F4.0 10F2.4 F3.4 11F2.0 F2.8 12F1.6 F2.4 13

F2.0 14F1.6 15F1.4 16F1.2 17


[Table 194] Gain Value

- 268 -


Gain(dB) Value Gain(dB) Value Gain(dB) Value-3 0 10 6 22 120 1 12 7 24 132 2 14 8 26 144 3 16 9 28 156 4 18 108 5 20 11

(12) Bright (ae_bright): rwThis is only available for Manual Bright exposue mode. The maximum value is limited by Gain Limit.

[Table 195] Max Bright Value with Gain Limit

Gain Limit(dB)Max Bright

MODEL: HDZ-P622, HDA-S422F

Max BrightMODEL:HDG-M220F

6 16 208 17 21

10 18 2212 19 2314 20 2416 21 2518 22 2620 23 2722 24 2824 25 2926 26 3028 27 21

(13) Slow Shutter (ae_slow_shutter): rwControl that the slow shutter is set automatically when the brightness drops.


- 269 -


[Table 196] Day & Night ModeDay&Night

ModeValue

Auto 0Day 1

Night 2

(15) Day & Night Threshold (ae_dnn_threshold): rwThis is to configure the day and night sensitivity when the ae_dnn_mode is auto mode.

(16) Day & Night IR Mode (ae_dnn_irmode)This is only available for HDA-S422F and HDG-M220F series.


[Table 197] WDR & BLC ModeWDR & BLC Mode Value

Off 0BLC 1WDR 2WDR-Auto 3WDR-Exposure Ratio 4WDR-Histogram 5

(18) White Balance Mode (wb_mode): rw

[Table 198] White BalanceWhite Balance Mode ValueAuto 0Indoor 1Outdoor 2ATW 3Manual Gain 4Outdoor Auto 5

- 270 -


Sodium Lamp Auto 6Sodium Lamp 7



18. Configurations for HNS-S113J

18-1. Auto Exposure

Example: Request of getting audio parameters and valueshttp://<ipcam>/video/ae.php?app=get

Example: Response of getting audio parameters (Model_C)res=200&http_port=80&https_port=443&time_format=1&ae_mode=0&ae_iris=5&ae_gain=1&ae_shutter=6&ae_bright=12&ae_blc=0&ae_slow_shutter=1&ae_night_shot=0&ae_start_hour=0&ae_start_min=0&ae_end_hour=0&ae_end_min=0&ae_wdr=0&menu_ae_mode=Auto,Manual,Iris Prio,Shutter Prio,Bright&menu_ae_iris=F1.6,F2,F2.4,F2.8,F3.4,F4,F4.8,F5.6,F6.8,F8,F9.6,F11,F14,F16,F19,F22,F28,Close&menu_ae_gain=-3 DB,0 DB,2 DB,4 DB,6 DB,8 DB,10 DB,12 DB,14 DB,16 DB,18 DB,20 DB,22 DB,24 DB,26 DB,28 DB&menu_ae_shutter=1/8,1/15,1/30,1/60,1/90,1/100,1/125,1/180,1/250,1/350,1/500,1/725,1/1000,1/1500,1/2000,1/3000,1/4000,1/6000,1/10000&menu_ae_nightshot=Auto,On,Off,Global,Time&menu_ae_starttime=show menu&menu_ae_endtime=show menu&menu_ae_wdr=Off,On,Auto&menu_ae_wdrlevel=hide menu&menu_ae_bright=0~31&menu_ae_irisoffset=hide menu&menu_ae_blc=Off,On&menu_ae_slowshutter=Off,On&menu_ae_dss_limit=hide menu&menu_ae_flickerless=hide menu&menu_ae_irispeak=hide menu&menu_ae_bakclightlevel=hide menu&menu_ae_highsensitvitymode=hide menu&menu_ae_customgammamode=hide

- 271 -


menu&menu_ae_lowilluminatuionchromasuppress=hide menu

[Table 199] Parameters of ae.php in Model_C

Name TypeLengt

hDescription Value



2: 12 Hours (AM/PM)ae_mode integer Mode Value

Module Table.xls

ae_iris integer IRIS Valueae_gain integer Gain Valueae_shutter integer Shutter valueae_bright integer Bright valueae_blc integer BLC valueae_slow_shutter integer Slow shutter valueae_night_shot integer Night shot valueae_start_hour integer Start hour valueae_start_min integer Start minute valueae_end_hour integer End hour valueae_end_min integer End minute valueae_wdr integer Wdr valueae_irisoffset integer IRIS offset valueae_wdrlevel integer WDR level valueae_dss_limit integer DSS limit valueae_flickerless integer Flickerless valueae_irispeak integer IRIS peak valueae_backlightlevel integer Backlight level valueae_highsensitvitymode

integer High sensitivity mode value

ae_atr integerAdaptive tone reproduction value

ae_blc_hlc integer BLC/HLC valueae_wdr_blc_hsblc integer WDR/BLC/HSBLC

value

- 272 -


ae_hsblc_level integer Hsblc level valueae_gain_limit integer Gain Limit valuemenu_ae_mode string Mode menumenu_ae_iris string IRIS menumenu_ae_gain string Gain menumenu_ae_shutter string Shutter menumenu_ae_bright string Bright menumenu_ae_blc string BLC menumenu_ae_slowshutter string Slow shutter menumenu_ae_nightshot string Night show menumenu_ae_starttime string Start time menumenu_ae_endtime string End time menumenu_ae_wdr string WDR menumenu_ae_irisoffset string IRIS offset menumenu_ae_wdrlevel string WDR level menumenu_ae_dss_limit string DSS limit menumenu_ae_flickerless string Flickerless menumenu_ae_irispeak string IRIS peak menumenu_ae_bakclightlevel

string Backlight level menu

menu_ae_highsensitvitymode

string High Sensitivity mode menu

menu_ae_atr stringAdaptive tone reproduction menu

menu_ae_blc_hlc string BLC/HLC menumenu_ae_wdr_blc_hsblc

stringWDR/BLC/HSBLC menu

menu_hsblc_level string Hsblc level menumenu_gain_limit string Gain Limit menu



- 273 -


(3) Mode Value (ae_mode) : rwThis is auto exposure mode. Reference ModuleTable.xls

(4) IRIS Value (ae_iris) : rwThis is a iris value of the exposure. Reference ModuleTable.xls

(5) Gain Value (ae_gain) : rwThis is a gain value of the exposure. Reference ModuleTable.xls

(6) Shutter value (ae_shutter) :rwThis is a shutter value of the exposure. Reference ModuleTable.xls

(7) Bright value (ae_bright) : rwThis is a bright value of the exposure. Reference ModuleTable.xls

(8) BLC value (ae_blc) : rwThis is a BLC(Backlight Compensation) value of the exposure. When background of a subject is too bright, subject appears dark since AE is working on the overall picture. The BLC function increases the visibility of underexposed subject. Reference ModuleTable.xls

(9) Slow shutter value (ae_slow_shutter) : rwThis is a slow shutter value of the exposure. Reference ModuleTable.xls

(10) Night shot value (ae_night_shot) : rwThis is a Night shot value of the exposure. Auto Night shot mode automatically remove IR cut filter according to current intensity. Reference ModuleTable.xls

(11) Start hour value (ae_start_hour) : rwSet hour time to change form “Color mode” to “B/W mode”. Reference ModuleTable.xls

(12) Start minute value (ae_start_min) : rwSet minute time to change form “Color mode” to “B/W mode”. Reference ModuleTable.xls

- 274 -


(13) End hour value (ae_end_hour) : rwSet hour time to change form “B/W mode” to “Color mode”. Reference ModuleTable.xls

(14) End minute value (ae_end_min) : rwSet minute time to change form “B/W mode” to “Color mode”. Reference ModuleTable.xls

(15) Wdr value (ae_wdr) : rwThis is a WDR(Wide Dynamic Range) value of the exposure. The Wide Dynamic Range function is combining long-exposure signals (normal shutter) with the signals of the high-intensity portions obtained with a short exposure (high-speed shutter). Reference ModuleTable.xls

(16) IRIS offset value (ae_irisoffset) : rwThis is a iris offset value of the exposure. Reference ModuleTable.xls

(17) WDR level value (ae_wdrlevel) : rwThis is a wdr level value of the exposure. Reference ModuleTable.xls

(18) DSS limit value (ae_dss_limit) : rwThis is a DSS(Digital Slow Shutter) limit value of the exposure. Reference ModuleTable.xls

(19) Flickerless value (ae_flickerless) : rwThis is a flickerless on/off value of the exposure. Reference ModuleTable.xls

(20) IRIS peak value (ae_irispeak) : rwThis is a iris peak value of the exposure. Reference ModuleTable.xls

(21) Backlight level value (ae_bakclightlevel) : rwThis is a backlight level value of the exposure. Reference ModuleTable.xls

(22) High sensitivity mode value (ae_highsensitvitymode) : rwThis is a high sensitivity value of the exposure. In this mode, higher sensitivity gain

- 275 -


is applied as standard gain increases, reaching a gain level at MAX gain of up to 4x the standard gain. In such cases, however, there will be a high volume noise in the image. Reference ModuleTable.xls

(23) Adaptive tone reproduction value (ae_atr) : rwThis is a ATR(Adaptive Tone Reproduction) value of the exposure. Atr is gradation processing technology that emphasizes enhanced visibility by performing the optimum gradation correction based on the brightness information. Reference ModuleTable.xls

(24) BLC/HLC value (ae_blc_hlc) : rwThis is a BLC(Backlight Compensation)/HLC(Highlight Compensation) value of the exposure. The high light compensation (HLC) function increases visibility of license plates and other objects by performing suppress processing and mask processing on strong light sources (automobile headlights, etc.) in dark locations. Reference ModuleTable.xls

(25) WDR/BLC/HSBLC value(ae_wdr_blc_hsblc) : rwThis is a WDR(Wide Dynamic Range)/BLC(Backlight Compensation)/HSBLC(Highlight Suppression BLC), value of the exposure. When there are highlights in the background of the object, HSBLC has powerful back light compensation performance. The function suppress highlight then it will make the object of image very clear and obvious. By setting the mask area, gray scale and HS Level, the user will experience better operating convenience and see a clearer number plate. Reference ModuleTable.xls

(26) Hsblc Level (ae_hsblc_level) : rwThis is a hsblc level value of the exposure. Reference ModuleTable.xls

(27) Gain Limit Value (ae_gain_limit) : rwThis is a gain limit value of the exposure. Reference ModuleTable.xls

(28) Mode menu (menu_ae_mode) : roThis is auto exposure mode. Reference ModuleTable.xls

(29) IRIS menu (menu_ae_iris) : ro

- 276 -


This is a iris value of the exposure.Reference ModuleTable.xls

(30) Gain menu (menu_ae_gain) : roThis is a gain value of the exposure. Reference ModuleTable.xls

(31) Shutter menu (menu_ae_shutter) : roThis is a shutter value of the exposure. Reference ModuleTable.xls

(32) Bright menu (menu_ae_bright) :roThis is a bright value of the exposure. Reference ModuleTable.xls

(33) BLC menu (menu_ae_blc) : roThis is a BLC(Backlight Compensation) value of the exposure. When background of a subject is too bright, subject appears dark since AE is working on the overall picture. The BLC function increases the visibility of underexposed subject. Reference ModuleTable.xls

(34) Slow shutter menu (menu_ae_slowshutter) : roThis is a slow shutter value of the exposure. Reference ModuleTable.xls

(35) Night shot menu (menu_ae_nightshot) : roThis is a Night shot value of the exposure. Auto Night shot mode automatically remove IR cut filter according to current intensity. Reference ModuleTable.xls

(36) Start time menu (menu_ae_starttime) : roSet time to change form “Color mode” to “B/W mode”. Reference ModuleTable.xls

(37) End time menu (menu_ae_endtime) : roSet time to change form “B/W mode” to “Color mode”. Reference ModuleTable.xls

(38) WDR menu (menu_ae_wdr) : roThis is a WDR(Wide Dynamic Range) value of the exposure. The Wide Dynamic Range function is combining long-exposure signals (normal shutter) with the signals of the high-intensity portions obtained with a short exposure (high-speed shutter). Reference ModuleTable.xls

- 277 -


(39) IRIS offset menu (menu_ae_irisoffset) : roThis is a iris offset value of the exposure. Reference ModuleTable.xls

(40) WDR level menu (menu_ae_wdrlevel) : roThis is a wdr level value of the exposure. Reference ModuleTable.xls

(41) DSS limit menu (menu_ae_dss_limit) : roThis is a DSS(Digital Slow Shutter) limit value of the exposure. Reference ModuleTable.xls

(42) Flickerless menu (menu_ae_flickerless) : roThis is a flickerless on/off value of the exposure. Reference ModuleTable.xls

(43) IRIS peak menu (menu_ae_irispeak) : roThis is a iris peak value of the exposure. Reference ModuleTable.xls

(44) Backlight level menu (menu_ae_bakclightlevel) : roThis is a backlight level value of the exposure. Reference ModuleTable.xls

(45) High Sensitvity mode menu (menu_ae_highsensitvitymode) : roThis is a high sensitivity value of the exposure. In this mode, higher sensitivity gain is applied as standard gain increases, reaching a gain level at MAX gain of up to 4x the standard gain. In such cases, however, there will be a high volume noise in the image. Reference ModuleTable.xls

(46) Adaptive tone reproduction menu (menu_ae_atr) : roThis is a ATR(Adaptive Tone Reproduction) value of the exposure. Atr is gradation processing technology that emphasizes enhanced visibility by performing the optimum gradation correction based on the brightness information. Reference ModuleTable.xls

(47) BLC/HLC menu (menu _blc_hlc) : roThis is a BLC(Backlight Compensation)/HLC(Highlight Compensation) value of the exposure. The high light compensation (HLC) function increases visibility of license plates and other objects by performing suppress processing and mask processing on strong light sources (automobile headlights, etc.) in dark locations. Reference

- 278 -


ModuleTable.xls

(48) WDR/BLC/HSBLC menu (menu _wdr_blc_hsblc) : roThis is a WDR(Wide Dynamic Range)/BLC(Backlight Compensation)/HSBLC(Highlight Suppression BLC), value of the exposure. When there are highlights in the background of the object, HSBLC has powerful back light compensation performance. The function suppress highlight then it will make the object of image very clear and obvious. By setting the mask area, gray scale and HS Level, the user will experience better operating convenience and see a clearer number plate. Reference ModuleTable.xls

(49) Hsblc Level (menu_hsblc_level) : roThis is a hsblc level value of the exposure. Reference ModuleTable.xls

(50) Gain Limit (menu_hsblc_level) : roThis is a gain limit value of the exposure. Reference ModuleTable.xls

18-2. Auto Focus

Example: Request of getting audio parameters and valueshttp://<ipcam>/video/auto_focus.php?app=get

Example: Response of getting audio parameters (Model_C)res=200&http_port=80&https_port=443&af_mode=0&af_sensitivity=1&af_focus_limit=4&menu_af_mode=Auto,Manual,One Push,Constant Manual&menu_af_sensitivity=Low,Normal&menu_af_focuslimit=1.0Cm,2.0Cm,4.5Cm,9.5Cm,32Cm,1.5m,2m,3m,5m,10m,20m

[Table 200] Parameters of auto_focus.php in Model_C

Name TypeLengt

hDescription Value

http_port integer HTTP Port Number 80 (default)https_port integer HTTPS Port Number 443 (default)af_mode integer Mode Value

Module Table.xlsaf_sensitivity integer Sensitivity Value

- 279 -


af_focus_limit integer Focus limit Valuemenu_af_mode string Mode menumenu_af_sensitivity string Sensitivity menumenu_af_focuslimit string Focus limit menu



(3) Mode Value (af_mode) : rwThis is a focus mode value of the focus. Reference ModuleTable.xls

(4) Sensitivity Value (af_sensitivity) : rwThis is a auto focus sensitivity value of the focus. Reference ModuleTable.xls

(5) Focus limit Value (af_focus_limit) : rwThis is a focus limit (focus distance) value of the focus. Reference ModuleTable.xls

(6) Mode menu (menu_af_mode) : roThis is a focus mode value of the focus. Reference ModuleTable.xls

(7) Sensitivity menu (menu_af_sensitivity) : roThis is a auto focus sensitivity value of the focus. Reference ModuleTable.xls

(8) Focus limit menu (menu_af_focuslimit) : roThis is a focus limit (focus distance) value of the focus. Reference ModuleTable.xls

18-3. White Balance

Example: Request of getting audio parameters and valueshttp://<ipcam>/video/white_balance.php?app=get

Example: Response of getting audio parameters (Model_C)

- 280 -


res=200&http_port=80&https_port=443&wb_mode=0&wb_rgain=206&wb_bgain=174&menu_awb_mode=Auto,Indoor,Outdoor,One Push,ATW,Manual,Outdoor Auto,Sodium Lamp Auto,Sodium Lamp&menu_awb_rgain=0~255&menu_awb_ggain=0~255

[Table 201] Parameters of white_balance.php in Model_C

Name TypeLengt

hDescription Value

http_port integer HTTP Port Number 80 (default)https_port integer HTTPS Port Number 443 (default)wb_mode integer Mode Value

Module Table.xlswb_rgain integer Rgain Valuewb_bgain integer Bgain Valuemenu_wb_mode string Mode menumenu_wb_rgain string Rgain rangemenu_wb_ggain string Ggain range



(3) Mode Value (wb_mode) : rwThis is a white balance mode value of the white balance.Reference ModuleTable.xls

(4) Rgain Value (wb_rgain) : rwThis is a Rgain(Red Gain) value of the white balance. Reference ModuleTable.xls

(5) Bgain Value (wb_bgain) : rwThis is a Bgain(Blue Gain) value of the white balance. Reference ModuleTable.xls

(6) Mode menu (menu_wb_mode) : roThis is a white balance mode value of the white balance. Reference ModuleTable.xls

- 281 -


(7) Rgain range (menu_wb_rgain) : roThis is a Rgain(Red Gain) value of the white balance. Reference ModuleTable.xls

(8) Ggain range (menu_wb_ggain) : roThis is a Bgain(Blue Gain) value of the white balance. Reference ModuleTable.xls18-4. Digital Image Stabilization

Example: Request of getting audio parameters and valueshttp://<ipcam>/video/dis.php?app=get

Example: Response of getting audio parameters (Model_C)res=200&dis_use=0&dis_image_show=0

[Table 202] Parameters of dis.php in Model_C

Name TypeLengt

hDescription Value

dis_use integerEnable / Disable digital image stabilizatiion

Enable: 1 Disable: 0(default)

dis_image_show integerNone : 0PIP : 1PBP : 2

(1) Enable / Disable digital image stabilizatiion (dis_use) : rwThis is to enable/disable digital image stabilizatiion.

(2) show dis image how (dis_image_show) : rwNone : Only viewing DIS Active image.PIP : View original image (small) and DIS active image (big) as picture in picture.PBP View original image (left) and DIS active image (right) as picture in picture.

18-5. Camera Setup

Example: Request of getting audio parameters and valueshttp://<ipcam>/video/camera_setup.php?app=get

- 282 -


Example: Response of getting audio parameters (Model_C)res=200&http_port=80&https_port=443&camera_sharpness=9&camera_dzoom=0&camera_flip=0&camera_preset_freeze=0&camera_bright_offset=7&camera_s_response=1&camera_dn_threshold=18&camera_stabilization=0&camera_drn=4&camera_moving_dnr=3&camera_gain_limit=10&menu_camera_sharpness=0~15&menu_camera_digitalzoom=Off,x2,x4,Max&menu_camera_imageflip=Off,On&menu_camera_presetfreeze=Off,On&menu_camera_brightoffset=-7~7&menu_camera_ircfthreshold=hide menu&menu_camera_dnthreshold=0~28&menu_camera_dnr=0~5&menu_camera_moving_dnr=0~5&menu_camera_2dnr=hide menu&menu_camera_moving_2dnr=hide menu&menu_camera_3dnr=hide menu&menu_camera_moving_3dnr=hide menu&menu_camera_stabilization=Off,On&menu_camera_slowresponse=1~48&menu_camera_gainlimit=+6 dB,+8 dB,+10 dB,+12 dB,+14 dB,+16 dB,+18 dB,+20 dB,+22 dB,+24 dB,+26 dB,+28 dB&menu_camera_screendisplay=hide menu&menu_camera_detectionsensitivity=hide menu&menu_camera_blockupshadowlevel=hide menu&menu_camera_blownouthightlightlevel=hide menu&menu_camera_exposureratioofshortexp=hide menu&menu_camera_irispeak=hide menu&menu_camera_blclevel=hide menu&menu_camera_agclimit=hide menu&menu_camera_fnrmode=hide menu&menu_camera_fnrlevel=hide menu&menu_camera_digitalclock=hide menu&menu_camera_aspecttype=hide menu

[Table 203] Parameters of camera_setup.php in Model_C

Name TypeLengt

hDescription Value

http_port integer HTTP Port Number 80 (default)https_port integer HTTPS Port Number 443 (default)camera_sharpness integer Sharpness valuecamera_dzoom integer Digital zoom valuecamera_flip integer Flip valuecamera_preset_freeze integer Preset Freeze valuecamera_bright_offset integer Bight offset valuecamera_ircfthreshold integer Ircf threshold valuecamera_dn_threshold integer Day & Night threshold

value

- 283 -


Module Table.xls

camera_dnr integer DNR valuecamera_moving_dnr integer Moving DNR valuecamera_2dnr integer 2DNR valuecamera_moving_2dnr integer Moving 2DNR valuecamera_3dnr integer 3DNR valuecamera_moving3_dnr integer Moving 3DNR valuecamera_stabilization integer Stabilization valuecamera_s_response integer Slow response valuecamera_irispeak integer IRIS peak valuecamera_blclevel integer BLC level valuecamera_fnrmode integer FNR mode valuecamera_fnrlevel integer FNR level valuecamera_digitalclock integer Digital clock valuecamera_aspecttype integer Aspect type valuecamera_gain_limit integer Gain limit valuecamera_lowilluminatuionchromasuppress

integer chroma suppress value

menu_camera_sharpness string Sharpness menumenu_camera_dzoom string Digital zoom menumenu_camera_flip string Flip menumenu_camera_preset_freeze

stringPreset Freeze menu

menu_camera_bright_offset

stringBright offset menu

menu_camera_ircfthreshold

stringIrcf threshold menu

menu_camera_dn_threshold

stringDay & Night threshold menu

menu_camera_dnr string DNR menumenu_camera_moving_dnr

stringMoving DNR menu

menu_camera_2dnr string 2DNR menumenu_camera_moving_2dnr

string Moving 2DNR menu

menu_camera_3dnr string 3DNR menu

- 284 -


menu_camera_moving3_dnr

string Moving 3DNR menu

menu_camera_stabilization

string Stabilization menu

menu_camera_s_response

string Slow response menu

menu_camera_irispeak string IRIS peak menu

menu_camera_blclevel string BLC leve menumenu_camera_fnrmode string FNR mode menumenu_camera_fnrlevel string FNR level menumenu_camera_digitalclock

string Digital clock menu

menu_camera_aspecttype

string Aspect type menu

menu_camera_gain_limit string Gain limit menumenu_camera_customgammamode

string Custom gamma mode menu

menu_camera_chromasuppress

string chroma suppress menu



(3) Sharpness value (camera_sharpness) : rwThis is a sharpness value of the camera. Reference ModuleTable.xls

(4) Digital zoom value (camera_dzoom) : rwThis is a digital zoom value of the camera. Reference ModuleTable.xls

(5) Flip value (camera_flip) : rwThis is a image flip value of the camera. This function turns the videos output from

- 285 -


the camera upside down and reverses it horizontally. Reference ModuleTable.xls

(6) Preset Freeze value (camera_preset_freeze) : rwThis is a preset freeze value of the camera. The image is frozen during calling preset. Reference ModuleTable.xls

(7) Bight offset value (camera_bright_offset) : rwThis is a bright offset value of the camera. Bright offset is a function which offsets the internal reference brightness level used in the AE mode. Reference ModuleTable.xls

(8) Ircf threshold value (camera_ircfthreshold) : rwThis is a Ircf (IR Cut-Filter) threshold value of the camera. Reference ModuleTable.xls

(9) Day & Night threshold value (camera_dn_threshold) : rwThis is a Dsy & Night threshold value of the camera. ICR(IR Cut-Removable) ON -> OFF Threshold Level. Reference ModuleTable.xls

(10) DNR value (camera_dnr) : rwThis is a DNR(Digital Noise Reduction) value of the camera. The DNR function removes noise (both random and non-random) using a temporal noise filter. DNR value applied when motor stopped. Reference ModuleTable.xls

(11) Moving DNR value (camera_moving_dnr) : rwThis is a Moving DNR(Digital Noise Reduction) value of the camera. DNR value applied when motor moving. Reference ModuleTable.xls

(12) 2DNR value (camera_2dnr) : rwThis is a 2DNR(Two-dimensional Digital Noise Reduction) value of the camera. 2DNR is by combining 2D filtering according to brightness and image color. 2DNR value applied when motor stopped. Reference ModuleTable.xls

(13) Moving 2DNR value (camera_moving_2dnr) : rwThis is a 2DNR(Two-dimensional Digital Noise Reduction) value of the camera. 2DNR value applied when motor moving. Reference ModuleTable.xls

- 286 -


(14) 3DNR value (camera_3dnr) : rwThis is a 3DNR(Three-dimensional Digital Noise Reduction) value of the camera. 3DNR is according to noise caused by motion and time difference, lower noise images can be obtained for the corresponding image brightness of a moving subject. 3DNR value applied when motor stopped. Reference ModuleTable.xls

(15) Moving 3DNR value (camera_moving3_dnr) : rwThis is a 3DNR(Three -dimensional Digital Noise Reduction) value of the camera. 3DNR value applied when motor moving. Reference ModuleTable.xls

(16) Stabilization value (camera_stabilization) : rwThis is a image stabilization value of the camera. Image Stabilizer function reduces image blurring caused by, for example, vibration, which allows you to obtain images without much blurring. Reference ModuleTable.xls

(17) Slow response value (camera_s_response) : rwThis is a slow response value of the camera. The slow AE Response (automatic exposure) function allows you to reduce the exposure response speed. Reference ModuleTable.xls

(18) IRIS peak value (camera_irispeak) : rwThis is a iris peak value of the camera. Reference ModuleTable.xls

(19) BLC level value (camera_blclevel) : rwThis is a BLC(Backlight Compensation) level value of the camera. Reference ModuleTable.xls

(20) FNR mode value (camera_fnrmode) : rwThis is a FNR(Frame Noise Reduction) mode value of the camera. FNR is a function to decrease the noise by the frame correlation. Reference ModuleTable.xls

(21) FNR level value (camera_fnrlevel) : rwThis is a FNR level value of the camera. Reference ModuleTable.xls

(22) Digital clock value (camera_digitalclock) : rwThis is a digital colock value of the camera. Reference ModuleTable.xls

- 287 -


(23) Aspect type value (camera_aspecttype) : rwThis is a aspect type value of the camera. Reference ModuleTable.xls

(24) Gain limit value (camera_gain_limit) : rwThis is a gain limit value of the camera. Use this setting when image signal-to-noise ratio is particularly important. Reference ModuleTable.xls

(25) Custom gamma mode value (ae_customgammamode) : rwThis is a custom gamma value of the camera. Gamma correction can be changed in this mode. Reference ModuleTable.xls

(26)chroma suppress value (ae_chromasuppress) : rwThis is a chroma suppress value of the camera. You can configure a chroma suppress mode for lowillumination conditions. This can be useful when color noise is particularly noticeable in such conditions. Reference ModuleTable.xls

(27) Sharpness menu (menu_camera_sharpness) : roThis is a sharpness value of the camera. Reference ModuleTable.xls

(28) Digital zoom menu (menu_camera_dzoom) : roThis is a digital zoom value of the camera. Reference ModuleTable.xls

(29) Flip menu (menu_camera_flip) : roThis is a image flip value of the camera. This function turns the videos output from the camera upside down and reverses it horizontally. Reference ModuleTable.xls

(30) Preset Freeze menu (menu_camera_preset_freeze) : roThis is a preset freeze value of the camera. The image is frozen during calling preset. Reference ModuleTable.xls

(31) Bright offset menu (menu_camera_bright_offset) : roThis is a bright offset value of the camera. Bright offset is a function which offsets the internal reference brightness level used in the AE mode. Reference ModuleTable.xls

- 288 -


(32) Ircf threshold menu (menu_camera_ircfthreshold) : roThis is a Ircf (IR Cut-Filter) threshold value of the camera. Reference ModuleTable.xls

(33) Day & Night threshold menu (menu_camera_dn_threshold) : roThis is a Dsy & Night threshold value of the camera. ICR(IR Cut-Removable) ON -> OFF Threshold Level. Reference ModuleTable.xls

(34) DNR menu (menu_camera_dnr) : roThis is a DNR(Digital Noise Reduction) value of the camera. The DNR function removes noise (both random and non-random) using a temporal noise filter. DNR value applied when motor stopped. Reference ModuleTable.xls (35) Moving DNR menu (menu_camera_moving_dnr) : roThis is a Moving DNR(Digital Noise Reduction) value of the camera. DNR value applied when motor moving. Reference ModuleTable.xls

(36) 2DNR menu (menu_camera_2dnr) : roThis is a 2DNR(Two-dimensional Digital Noise Reduction) value of the camera. 2DNR is by combining 2D filtering according to brightness and image color. 2DNR value applied when motor stopped. Reference ModuleTable.xls

(37) Moving 2DNR menu (menu_camera_moving_2dnr) : roThis is a 2DNR(Two-dimensional Digital Noise Reduction) value of the camera. 2DNR value applied when motor moving. Reference ModuleTable.xls

(38) 3DNR menu (menu_camera_3dnr) : roThis is a 3DNR(Three-dimensional Digital Noise Reduction) value of the camera. 3DNR is according to noise caused by motion and time difference, lower noise images can be obtained for the corresponding image brightness of a moving subject. 3DNR value applied when motor stopped. Reference ModuleTable.xls

(39) Moving 3DNR menu (menu_camera_moving3_dnr) : roMoving 3DNR value (camera_moving3_dnr) : rwThis is a 3DNR(Three -dimensional Digital Noise Reduction) value of the camera. 3DNR value applied when motor moving. Reference ModuleTable.xls

- 289 -


(40) Stabilization menu (menu_camera_stabilization) : roThis is a image stabilization value of the camera. Image Stabilizer function reduces image blurring caused by, for example, vibration, which allows you to obtain images without much blurring. Reference ModuleTable.xls

(41) Slow response menu (menu_camera_s_response) : roThis is a slow response value of the camera. The slow AE Response (automatic exposure) function allows you to reduce the exposure response speed. Reference ModuleTable.xls

(42) IRIS peak menu (menu_camera_irispeak) : roThis is a iris peak value of the camera. Reference ModuleTable.xls

(43) BLC leve menu (menu_camera_blclevel) : roThis is a BLC(Backlight Compensation) level value of the camera. Reference ModuleTable.xls

(44) FNR mode menu (menu_camera_fnrmode) : roThis is a FNR(Frame Noise Reduction) mode value of the camera. FNR is a function to decrease the noise by the frame correlation. Reference ModuleTable.xls

(45) FNR level menu (menu_camera_fnrlevel) : roThis is a FNR level value of the camera. Reference ModuleTable.xls

(46) Digital clock menu (menu_camera_digitalclock) : roThis is a digital colock value of the camera. Reference ModuleTable.xls

(47) Aspect type menu (menu_camera_aspecttype) : roThis is a aspect type value of the camera. Reference ModuleTable.xls

(48) Gain limit menu (menu_camera_gain_limit) : roThis is a gain limit value of the camera. Use this setting when image signal-to-noise ratio is particularly important. Reference ModuleTable.xls

(49) Custom gamma mode menu (menu_ae_customgammamode) : roThis is a custom gamma value of the camera. Gamma correction can be changed in

- 290 -


this mode. Reference ModuleTable.xls

(50) chroma suppress menu (menu_ae_chromasuppress) : roThis is a chroma suppress value of the camera. You can configure a chroma suppress mode for lowillumination conditions. This can be useful when color noise is particularly noticeable in such conditions. Reference ModuleTable.xls

18-6. Event In - Analytic

Example: Request of getting Analytic parameters and values (Model_C)http://<videoserver>/event/analytic.php?app=get

Example: Response of getting analytic parameters and values (Model_C)res=200&http_port=80&https_port=443&max_width=720&max_height=480&analytics_enable=1&function_list=1-motion,2-tracking,3-cross,4-enter,5-abandon,6-removal,7-none,&select_number=1&analytics_function=1&sensitivity=1&zoom=0&return_time=0&lost_mode=0&direction=0&tracking=0&base=0&event_time=0&size_min=1&size_max=6&exclusion_area=0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0&analytic_sx=0&analytic_sy=0&analytic_ex=0&analytic_ey=0

[Table 204] Parameters of analytic.php

Name TypeLengt

hDescription Value

method stringMethod preset_go,

get_num

- 291 -


app string 3Application type get

sethttp_port integer HTTP Port Number 80 (default)https_port integer HTTPS Port Number 443 (default)

analytics_enable integerEnable / Disable Analytic


function_list stringpreset number-analytic function

meta_data_type integer

Selected analytic function number

0 : none1 : motion detection2 : tracking3 : cross4 : enter5 : abandon6 : removal7 : absent8 : tamper9 : Crowd10:Flow11:Loitering12:Dehaze13:Appear14:Disappear15:Exit

analytics_function integerAnalytic function number of selected preset number

On: 1

sensitivity integerMotion detection sensitivity Value

1 ~ 8

zoom integerEnable / Disable tracking zoom

Enable: 1Disable: 0

return_time integerTracking return time value

0, 3 ~ 99

- 292 -


lost_mode integerTracking lost mode value

0 : Stop1 : Zoom out

exclusion_area stringMotion detection, tracking exclusion area value

direction integerCross direction value

0 : CW1 : CCW2 : Both

tracking integerEnable / Disable cross tracking mode

0 : off1 : on

base integerEnter base value 0 : top

1 : bottom2 : both

event_time integerAbandon & Removal event time value

10 ~ 240 second

max_width integer 720max_height integer 480analytic_sx integer max_width,

max_heightanalytic_sy integeranalytic_ex integeranalytic_ey integersize_min integer Pixel countsize_max integer Pixel countmax_level integer Max level of crowd 5~100(%)

current_level integerCurrent level of crowd

5~100

count integer Count of flow 0~ffff(65535)

tamper integerTamper value 0: defocus

1: tamper

classification integer

Classification value 0: None1: all2: human3: vehicle4: etc

color_y integer Color(y,cb,cr) of 0~255

- 293 -


detected objectcolor_cbcolor_crDehaze_level integer Level of dehaze 1~8

(1) Method (method) : rw



(4) Enable / Disable Analytic (analytics_enable): rwThis is to enable/disable Analytic function.

(5) Current Analytic List (function_list) : roThis is to retrieve analytic list of the selected preset.

(6) Selected preset number (select_number) : rw

(7) Analytic function number of selected preset number (analytics_function) : roThis is to retrieve analytic type of the selected preset.

(8) Motion detection sensitivity Value (sensitivity) : rwThis is the sensitivity step. 1-8 step, the lower number means the lower sensitivity (dull).

(9) Enable / Disable tracking zoom (zoom) : rwThis is to enable or disable linked zoom capability during tracking.

(10) Tracking return time value (return_time) : rwThis is the dwell time before move to previous position once tracking is inactive. (Off, 3~99 seconds.)

(11) Tracking lost mode value (lost_mode) : rw

- 294 -


Choose “Stop” or “Zoom Out” when object has been lost. Stop(0) : Stop Tracking in current position when object lost.Zoom Out(1) : “Zooming Out” will be activated in 3 seconds after object was lost.

However this can not work if you switched off “Zoom Enable”.

(12) Motion detection, tracking exclusion area value (exclusion_area) : rwThis is inactive area of Motion detection.

(13) Cross direction value (direction) : rwThis is the direction while object cross.

CW(0) : CW (Clock Wise)CCW(1) : CCW (Counter Clock Wise) Both(2) : CCW (Counter Clock Wise), CW (Clock Wise),

(14) Enable / Disable cross tracking mode (tracking) : rwThis is to enable or disable the tracking use while object crossed.

(15) Enter base value (base) : rwThis is the reference point while object entered. It occurs a event when reference point enters in a specified enter box.

Top(0) : Reference point is the top of object.Bottom(1) : Reference point is the bottom of object.Both(2) : Reference point is the top of object and bottom of object.

(16) Abandon & Removal event time value (event_time) : rwThis is the event time. 10s,20s,30s,40s,50s,60s,70s,80s,90s,100s,120s,180s,240s

(17) Max Width (max_width) : ro

(18) Max Height (max_height) : ro

(19) Start and End Position of Cross, Enter, Abandon and Removal (analytic_sx, analytic_sy, analytic_ex, analytic_ey ) : rwThese are pixel unit based on max_width and max_height.

(20) Minimum Size of Recognizable Object (size_min) : rw

- 295 -


(21) Maximum Size of Recognizable Object (size_max) : rw

(23) Current Level of Crowd (current_level) : r

(24) Count of Flow Per Second (count) :r

(25) Tamper Value (tamper) : rDefocus (0) : focus outTamper (1) : Scene was changed over 70%

(26) Classification Value (classification) :r0: all, 1: people, 2: vehicle, 3: etc

(27) Color of Recognized Object (color_y, color_cb, color_cr) : r

(28) Dehaze Level (dehaze_level) : rThis is the haze level. 1-8 step, The lower number means the lower level (low concentration).

18-7. Preset

Example: Request of getting preset parameters and values (Model_C)http://< ipcam >/ptz/preset.php?app=get

Example: Response of getting preset parameters and values (Model_C)res=200&http_port=80&https_port=443&time_format=1&preset_count=7&preset_list=1,2,3,4,5,6,7,&preset_number=1&preset_title=aaa/&preset_dwell=3&preset_focus=0&ae_mode=0&ae_iris=3&ae_gain=1&ae_shutter=6&ae_bright=14&ae_blc=0&ae_slow_shutter=1&ae_night_shot=0&ae_start_hour=0&ae_start_min=0&ae_end_hour=0&ae_end_min=0&ae_wdr=0&menu_ae_mode=Auto,Manual,Iris Prio,Shutter Prio,Bright&menu_ae_iris=F1.6,F2,F2.4,F2.8,F3.4,F4,F4.8,F5.6,F6.8,F8,F9.6,F11,F14,F16,F19,F22,F28,Close&menu_ae_gain=-3 DB,0 DB,2 DB,4 DB,6 DB,8 DB,10 DB,12 DB,14 DB,16 DB,18 DB,20 DB,22 DB,24 DB,26 DB,28

- 296 -


DB&menu_ae_shutter=1/8,1/15,1/30,1/60,1/90,1/100,1/125,1/180,1/250,1/350,1/500,1/725,1/1000,1/1500,1/2000,1/3000,1/4000,1/6000,1/10000&menu_ae_nightshot=Auto,On,Off,Global,Time&menu_ae_starttime=show menu&menu_ae_endtime=show menu&menu_ae_wdr=Off,On,Auto&menu_ae_wdrlevel=hide menu&menu_ae_bright=0~31&menu_ae_irisoffset=hide menu&menu_ae_blc=Off,On&menu_ae_slowshutter=Off,On&menu_ae_dss_limit=hide menu&menu_ae_flickerless=hide menu&menu_ae_irispeak=hide menu&menu_ae_bakclightlevel=hide menu&menu_ae_highsensitvitymode=hide menu&menu_ae_customgammamode=hide menu&menu_ae_lowilluminatuionchromasuppress=hide menu

[Table 205] Parameters of preset.php in Model_C

Name TypeLengt

hDescription Value



2: 12 Hours (AM/PM)

method stringOperation create, delete, get_num,

preset_gopreset_count integer 0 ~ 240preset_list string 1,2,3,~240preset_number integer Preset Numberpreset_title string Preset의 Titleae_mode integer Mode Valueae_iris integer IRIS Valueae_gain integer Gain Valueae_shutter integer Shutter valueae_bright integer Bright valueae_blc integer BLC valueae_slow_shutter integer Slow shutter valueae_night_shot integer Night shot valueae_start_hour integer Start hour value

- 297 -


ModuleTable.xls

ae_start_min integer Start minute valueae_end_hour integer End hour valueae_end_min integer End minute valueae_wdr integer Wdr valueae_irisoffset integer IRIS offset valueae_wdrlevel integer WDR level valueae_dss_limit integer DSS limit valueae_flickerless integer Flickerless valueae_irispeak integer IRIS peak valueae_backlightlevel integer Backlight level valueae_highsensitvitymode

integer High sensitivity mode value

ae_atr integerAdaptive tone reproduction value

ae_blc_hlc integer BLC/HLC value

ae_wdr_blc_hsblc integerWDR/BLC/HSBLCvalue

ae_hsblc_level integer Hsblc level valueae_gain_limit integer Gain Limit valuemenu_ae_mode string Mode menumenu_ae_iris string IRIS menumenu_ae_gain string Gain menumenu_ae_shutter string Shutter menumenu_ae_bright string Bright menumenu_ae_blc string BLC menumenu_ae_slowshutter string Slow shutter menumenu_ae_nightshot string Night show menumenu_ae_starttime string Start time menumenu_ae_endtime string End time menumenu_ae_wdr string WDR menumenu_ae_irisoffset string IRIS offset menumenu_ae_wdrlevel string WDR level menumenu_ae_dss_limit string DSS limit menumenu_ae_flickerless string Flickerless menumenu_ae_irispeak string IRIS peak menu

- 298 -


menu_ae_bakclightlevel

string Backlight level menu

menu_ae_highsensitvitymode

string High Sensitivity mode menu

menu_ae_atr stringAdaptive tone reproduction menu

menu_ae_blc_hlc string BLC/HLC menumenu_ae_wdr_blc_hsblc

stringWDR/BLC/HSBLC menu

menu_hsblc_level string Hsblc level menumenu_gain_limit string Gain Limit menu



(3) Preset Operations (method) : rwcreate : create a preset at current position.delete : delete selected preset.get_num : retrieve selected preset configuration.preset_go : move to selected preset..

(4) Preset Count (preset_count) : ro

(5) List of Preset Number List (preset_list) : ro

(6) Selected Preset Number (preset_number) : rw

(7) Preset Title (preset_title) : rw

(8) Mode Value (ae_mode) : rwThis is auto exposure mode. Reference ModuleTable.xls

- 299 -


(9) IRIS Value (ae_iris) : rwThis is a iris value of the exposure. Reference ModuleTable.xls

(10) Gain Value (ae_gain) : rwThis is a gain value of the exposure. Reference ModuleTable.xls

(11) Shutter value (ae_shutter) :rwThis is a shutter value of the exposure. Reference ModuleTable.xls

(12) Bright value (ae_bright) : rwThis is a bright value of the exposure. Reference ModuleTable.xls

(13) BLC value (ae_blc) : rwThis is a BLC(Backlight Compensation) value of the exposure. When background of a subject is too bright, subject appears dark since AE is working on the overall picture. The BLC function increases the visibility of underexposed subject. Reference ModuleTable.xls

(14) Slow shutter value (ae_slow_shutter) : rwThis is a slow shutter value of the exposure. Reference ModuleTable.xls

(15) Night shot value (ae_night_shot) : rwThis is a Night shot value of the exposure. Auto Night shot mode automatically remove IR cut filter according to current intensity. Reference ModuleTable.xls

(16) Start hour value (ae_start_hour) : rwSet hour time to change form “Color mode” to “B/W mode”. Reference ModuleTable.xls

(17) Start minute value (ae_start_min) : rwSet minute time to change form “Color mode” to “B/W mode”. Reference ModuleTable.xls

(18) End hour value (ae_end_hour) : rwSet hour time to change form “B/W mode” to “Color mode”. Reference ModuleTable.xls

- 300 -


(19) End minute value (ae_end_min) : rwSet minute time to change form “B/W mode” to “Color mode”. Reference ModuleTable.xls

(20) Wdr value (ae_wdr) : rwThis is a WDR(Wide Dynamic Range) value of the exposure. The Wide Dynamic Range function is combining long-exposure signals (normal shutter) with the signals of the high-intensity portions obtained with a short exposure (high-speed shutter). Reference ModuleTable.xls

(21) IRIS offset value (ae_irisoffset) : rwThis is a iris offset value of the exposure. Reference ModuleTable.xls

(22) WDR level value (ae_wdrlevel) : rwThis is a wdr level value of the exposure. Reference ModuleTable.xls

(23) DSS limit value (ae_dss_limit) : rwThis is a DSS(Digital Slow Shutter) limit value of the exposure. Reference ModuleTable.xls

(24) Flickerless value (ae_flickerless) : rwThis is a flickerless on/off value of the exposure. Reference ModuleTable.xls

(25) IRIS peak value (ae_irispeak) : rwThis is a iris peak value of the exposure. Reference ModuleTable.xls

(26) Backlight level value (ae_bakclightlevel) : rwThis is a backlight level value of the exposure. Reference ModuleTable.xls

(27) High sensitivity mode value (ae_highsensitvitymode) : rwThis is a high sensitivity value of the exposure. In this mode, higher sensitivity gain is applied as standard gain increases, reaching a gain level at MAX gain of up to 4x the standard gain. In such cases, however, there will be a high volume noise in the image. Reference ModuleTable.xls

- 301 -


(28) Adaptive tone reproduction value (ae_atr) : rwThis is a ATR(Adaptive Tone Reproduction) value of the exposure. Atr is gradation processing technology that emphasizes enhanced visibility by performing the optimum gradation correction based on the brightness information. Reference ModuleTable.xls

(29) BLC/HLC value (ae_blc_hlc) : rwThis is a BLC(Backlight Compensation)/HLC(Highlight Compensation) value of the exposure. The high light compensation (HLC) function increases visibility of license plates and other objects by performing suppress processing and mask processing on strong light sources (automobile headlights, etc.) in dark locations. Reference ModuleTable.xls

(30) WDR/BLC/HSBLC value(ae_wdr_blc_hsblc) : rwThis is a WDR(Wide Dynamic Range)/BLC(Backlight Compensation)/HSBLC(Highlight Suppression BLC), value of the exposure. When there are highlights in the background of the object, HSBLC has powerful back light compensation performance. The function suppress highlight then it will make the object of image very clear and obvious. By setting the mask area, gray scale and HS Level, the user will experience better operating convenience and see a clearer number plate. Reference ModuleTable.xls

(31) Hsblc Level (ae_hsblc_level) : rwThis is a hsblc level value of the exposure. Reference ModuleTable.xls

(32) Gain Limit Value (ae_gain_limit) : rwThis is a gain limit value of the exposure. Reference ModuleTable.xls

(33) Mode menu (menu_ae_mode) : roThis is auto exposure mode. Reference ModuleTable.xls

(34) IRIS menu (menu_ae_iris) : roThis is a iris value of the exposure. Reference ModuleTable.xls

(35) Gain menu (menu_ae_gain) : roThis is a gain value of the exposure. Reference ModuleTable.xls

- 302 -


(36) Shutter menu (menu_ae_shutter) : roThis is a shutter value of the exposure. Reference ModuleTable.xls

(37) Bright menu (menu_ae_bright) :roThis is a bright value of the exposure. Reference ModuleTable.xls

(38) BLC menu (menu_ae_blc) : roThis is a BLC(Backlight Compensation) value of the exposure. When background of a subject is too bright, subject appears dark since AE is working on the overall picture. The BLC function increases the visibility of underexposed subject. Reference ModuleTable.xls

(39) Slow shutter menu (menu_ae_slowshutter) : roThis is a slow shutter value of the exposure. Reference ModuleTable.xls

(40) Night shot menu (menu_ae_nightshot) : roThis is a Night shot value of the exposure. Auto Night shot mode automatically remove IR cut filter according to current intensity. Reference ModuleTable.xls

(41) Start time menu (menu_ae_starttime) : roSet time to change form “Color mode” to “B/W mode”. Reference ModuleTable.xls

(42) End time menu (menu_ae_endtime) : roSet time to change form “B/W mode” to “Color mode”. Reference ModuleTable.xls

(43) WDR menu (menu_ae_wdr) : roThis is a WDR(Wide Dynamic Range) value of the exposure. The Wide Dynamic Range function is combining long-exposure signals (normal shutter) with the signals of the high-intensity portions obtained with a short exposure (high-speed shutter). Reference ModuleTable.xls

(44) IRIS offset menu (menu_ae_irisoffset) : roThis is a iris offset value of the exposure. Reference ModuleTable.xls

(45) WDR level menu (menu_ae_wdrlevel) : ro

- 303 -


This is a wdr level value of the exposure. Reference ModuleTable.xls

(46) DSS limit menu (menu_ae_dss_limit) : roThis is a DSS(Digital Slow Shutter) limit value of the exposure. Reference ModuleTable.xls

(47) Flickerless menu (menu_ae_flickerless) : roThis is a flickerless on/off value of the exposure. Reference ModuleTable.xls

(48) IRIS peak menu (menu_ae_irispeak) : roThis is a iris peak value of the exposure. Reference ModuleTable.xls

(49) Backlight level menu (menu_ae_bakclightlevel) : roThis is a backlight level value of the exposure. Reference ModuleTable.xls

(50) High Sensitvity mode menu (menu_ae_highsensitvitymode) : roThis is a high sensitivity value of the exposure. In this mode, higher sensitivity gain is applied as standard gain increases, reaching a gain level at MAX gain of up to 4x the standard gain. In such cases, however, there will be a high volume noise in the image. Reference ModuleTable.xls

(51) Adaptive tone reproduction menu (menu_ae_atr) : roThis is a ATR(Adaptive Tone Reproduction) value of the exposure. Atr is gradation processing technology that emphasizes enhanced visibility by performing the optimum gradation correction based on the brightness information. Reference ModuleTable.xls

(52) BLC/HLC menu (menu _blc_hlc) : roThis is a BLC(Backlight Compensation)/HLC(Highlight Compensation) value of the exposure. The high light compensation (HLC) function increases visibility of license plates and other objects by performing suppress processing and mask processing on strong light sources (automobile headlights, etc.) in dark locations. Reference ModuleTable.xls

(53) WDR/BLC/HSBLC menu (menu _wdr_blc_hsblc) : roThis is a WDR(Wide Dynamic Range)/BLC(Backlight Compensation)/HSBLC(Highlight

- 304 -


Suppression BLC), value of the exposure. When there are highlights in the background of the object, HSBLC has powerful back light compensation performance. The function suppress highlight then it will make the object of image very clear and obvious. By setting the mask area, gray scale and HS Level, the user will experience better operating convenience and see a clearer number plate. Reference ModuleTable.xls

(54) Hsblc Level (menu_hsblc_level) : roThis is a hsblc level value of the exposure. Reference ModuleTable.xls

(55) Gain Limit (menu_hsblc_level) : roThis is a gain limit value of the exposure. Reference ModuleTable.틴18-8. Auto Scan

Example: Request of getting auto scan parameters and values (Model_C)http://< ipcam >/ptz/auto_scan.php?app=get

Example: Response of getting auto scan parameters and values (Model_C)res=200&http_port=80&https_port=443&auto_scan_list=0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,&auto_scan_title=A01&auto_scan_mode=0&auto_scan_direction=1&auto_scan_swap=0&auto_scan_speed=6&auto_scan_dwell=3&auto_scan_sel_num=1&auto_scan_start_X=&auto_scan_start_Y=&auto_scan_start_Z=0&auto_scan_end_X=&auto_scan_end_Y=&auto_scan_end_Z=0&start_pan_position=255255255&start_tilt_position=255255255&start_zoom_position=255255&start_focus_position=127098&end_pan_position=255255255&end_tilt_position=255255255&end_zoom_position=255255&end_focus_position=128000

[Table 206] Parameters of auto_scan.php in Model_C

Name TypeLengt

hDescription Value


method stringOperation get_num, start_angle,

end_angle, deleteauto_scan_list string 0 ~ 17

- 305 -


auto_scan_title string Auto Scan Title 1,2,3,~240

auto_scan_mode integerAuto Scan Mode 0 : Normal

1 : Vector2 : Random

auto_scan_direction integerAuto Scan Direction 0 : CW

1 : CCW

auto_scan_swap integerAuto Scan Swap 0 : Off

1 : Onauto_scan_speed integer Auto Scan Speed 1 ~ 17auto_scan_dwell integer Auto Scan Dwell 1 ~ 99auto_scan_start_X string Auto Scan Start X 0.0 ~ 359.9auto_scan_start_Y string Auto Scan Start Y 0.0 ~ 359.9auto_scan_start_Z string Auto Scan Start Z 1 ~ 36auto_scan_end_X string Auto Scan End X 0.0 ~ 359.9auto_scan_end_Y string Auto Scan End Y 0.0 ~ 359.9auto_scan_end_Z string Auto Scan End Z 1 ~ 36

auto_scan_sel_num integerSelected Auto Scan Number

start_pan_position stringAuto Scan Start Pan Position

start_tilt_position stringAuto Scan Start Tilt Position

start_zoom_position stringAuto Scan Start Zoom Position

start_focus_positionstring Auto Scan Start

Focus Position

end_pan_positionstring Auto Scan End Pan

Position

end_tilt_positionstring Auto Scan End Tilt

Position

end_zoom_positionstring Auto Scan End Zoom

Position

end_focus_positionstring Auto Scan End Focus

Position

- 306 -




(3) Auto Scan Operations (method) : rwget_num : retrieve auto scan numbers.start_angle : set current position as start angle.end_angle : set current position as end angle.delete : delete auto scan

(4) Auto Scan Number List (auto_scan_list) : ro

(5) Auto Scan Title (auto_scan_title) : rw

(6) Auto Scan Mode (auto_scan_mode) : rwNormal : Move from start point to end point in panning only.Vector : Move from start point to end point including tilt and zoom simultaneously

and linearly. In some model, the zoom is fixed at wider angle and the zoom magnification information is not displayed.

Random : Move randomly between the start point and the end point.

(7) Auto Scan Direction (auto_scan_direction) :rwCW : CW (Clock Wise)CCW : CCW (Counter Clock Wise)

(8) Auto Scan Swap (auto_scan_swap) : rw

(9) Auto Scan Speed (auto_scan_speed) : rw

(10) Auto Scan Dwell (auto_scan_dwell) : rw

(11) Auto Scan Start X (auto_scan_start_X) : ro

(12) Auto Scan Start Y (auto_scan_start_Y) : ro

- 307 -


(13) Auto Scan Start Z (auto_scan_start_Z) : ro

(14) Auto Scan End X (auto_scan_end_X) : ro

(15) Auto Scan End Y (auto_scan_end_Y) : ro

(16) Auto Scan End Z (auto_scan_end_Z) : ro

(17) Selected Auto Scan Number (auto_scan_sel_num) : rw

(18) Auto Scan Start Pan Position (start_pan_position) : ro

(19) Auto Scan Start Tilt Position (start_tile_position) : ro

(20) Auto Scan Start Zoom Position (start_zoom_position) : ro

(21) Auto Scan Start Focus Position (start_focus_position) : ro

(22) Auto Scan End Pan Position (end_pan_position) : ro

(23) Auto Scan End Tilt Position (end_tilt_position) : ro

(24) Auto Scan End Zoom Position (end_zoom_position) : ro

(25) Auto Scan End Focus Position (end_focus_position) : ro

18-9. Tour

Example: Request of getting tour parameters and values (Model_C)http://< ipcam >/ptz/tour.php?app=get

Example: Response of getting tour parameters and values (Model_C)res=200&http_port=80&https_port=443&tour_list=0,0,0,0,0,0,0,0,&tour_number=1&tour_title=T01&tour_type=0&tour_speed=4&tour_event_enable=0&tour_tourlist=

- 308 -


0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,0|0,

[Table 207] Parameters of tour.php in Model_C

Name TypeLengt

hDescription Value


method stringOperation get_autoscan, get_preset,

get_tour, get_pattern, delete, get_num

tour_list string 1,2,3,~24tour_number integer Tour Numbertour_title string Tour Title

tour_type integerTour Type 0 : Normal

1 : Vectortour_speed integer Tour Speed 1 ~ 13

tour_event_enable integerTour Event Enable 0 : Off

1 : On

tour_tourlist string

Tour Tourlist mode|number,mode|numbermode 1 : presetmode 2 : patternmode 3 : tourmode 4 : auto scan

preset_list string Preset List 1,2,3,~240auto_scan_list string Auto Scan List 1,2,3,~17pattern_list string Pattern List 1,2,3,~8



- 309 -


(3) Tour Operations (method) : rwget_autoscan : retrieve auto scan list.get_preset : retrieve preset list.get_tour : retrieve tour list.get_pattern : retrieve pattern list.delete : delete a pattern.get_num : retrieve pattern.

(4) Tour List (tour_list) : ro

(5) Tour Number (tour_number) : rw

(6) Tour Title (tour_title) : rw

(7) Tour Type (tour_type) : rwNormal : Move from start point to end point in panning onlyVector : Move from start point to end point including tilt and zoom simultaneously andlinearly. In some model, the zoom is fixed at wider angle and the zoom magnification information is not displayed

(8) Tour Speed (tour_speed) : rw

(9) Tour Event Enable (tour_event_enable) : rw

(10) Tour Tourlist (tour_tourlist) : rw

(11) Preset List (preset_list) : ro

(12) Auto Scan List (auto_scan_list) : ro

(13) Pattern List (pattern_list) : ro

18-10. Pattern

Example: Request of getting pattern parameters and values (Model_C)

- 310 -


http://< ipcam >/ptz/pattern.php?app=get

Example: Response of getting pattern parameters and values (Model_C)res=200&http_port=80&https_port=443&pattern_1_title=P01&pattern_1_sec=0&pattern_1_percent=0.0&pattern_2_title=P02&pattern_2_sec=0&pattern_2_percent=0.0&pattern_3_title=P03&pattern_3_sec=0&pattern_3_percent=0.0&pattern_4_title=P04&pattern_4_sec=0&pattern_4_percent=0.0&pattern_5_title=P05&pattern_5_sec=0&pattern_5_percent=0.0&pattern_6_title=P06&pattern_6_sec=0&pattern_6_percent=0.0&pattern_7_title=P07&pattern_7_sec=0&pattern_7_percent=0.0&pattern_8_title=P08&pattern_8_sec=0&pattern_8_percent=0.0

[Table 208] Parameters of pattern.php in Model_C

Name TypeLengt

hDescription Value


method stringOperation set_title, start_pattern,

end_pattern, deletepattern_number integertitle string selected Pattern Title

sec stringselected Pattern Second

percent stringselected Pattern Percent

pattern_#_title stringPattern Number # Title

pattern_#_sec stringPattern Number # Second

pattern_#_percent stringPattern Number # Percent


(2) HTTPS Port Number (https_port): ro

- 311 -


This is the port number to connect by HTTPS. The default value is 443.

(3) Pattern Operations : rwset_title : set titlestart_pattern : start pattern configuration.end_pattern : end pattern configuration.delete : delete pattern.

(4) Selected Pattern Number (pattern_number) : rw

(5) selected Pattern Title (title) : rw

(6) Selected Pattern Second (sec) : ro

(7) Selected Pattern Percent (percent) : ro

(8) Pattern Number # Title (pattern_#_title) : ro

(9) Pattern Number # Second (pattern_#_sec) : ro

(10) Pattern Number # Percent (pattern_#_percent) : ro

18-11. OSD

Example: Request of getting OSD parameters and values (Model_C)http://< ipcam >/ptz/osd.php?app=get

Example: Response of getting OSD parameters and values (Model_C)res=200&osd_display=1&osd_preset_title=6&osd_trace=0&osd_line_color=2&osd_bounding_box=1&osd_view_a_title=0&osd_blending=0&osd_af_ae=1&osd_date_time=1&osd_view_direction=0&osd_cam_title=DomeID

[Table 209] Parameters of osd.php in Model_C

Name TypeLengt

hDescription Value

- 312 -


osd_display integerEnable/Disable OSD 0 : Off

1 : On

osd_preset_title integer

0 : Off1 : 32 : 303 : 604 : 1205 : 1806 : Constant

osd_trace integerEnable/Disable Trace 0 : Off

1 : On

osd_line_color integer

0 : White1 : Black2 : Red3 : Green4 : Blue5 : Yellow6 : Violet7 : Orange

osd_bounding_box integer0 : Off1 : On

osd_view_a_title integer0 : Off1 : On

osd_blending integer

OSD Blending 0 : Off1 : 12 : 23 : 34 : 45 : 56 : 6

osd_af_aeinteger

OSD AF & AE 0 : Off1 : On

osd_date_time integerOSD Date & Time 0 : Off

1 : Onosd_view_direction integer OSD View Direction 0 : Off

- 313 -


1 : Onosd_cam_title string OSD Camera Title

(1) Enable/Disable OSD (osd_display): rw

(2) OSD Preset Title (osd_preset_title): rw

(3) Enable/Disable Trace (osd_trace) : rwChoose to enable or disable Trace. (Only Detection Mode)

(4) OSD Line Color (osd_line_color) : rw

(5) OSD Bounding Box (osd_bounding_box) : rw

(6) OSD View a Title (osd_view_a_title) : rw

(7) OSD Transparency (osd_blending) : rw

(8) OSD AF & AE (osd_af_ae) : rw

(9) OSD Date & Time (osd_date_time) : rw

(10) OSD View Direction (osd_view_direction) : rw“ON” sets current direction as N(north) and the coordinate angle to 000. “OFF” hides the directional title. Every 90 degrees of clockwise rotation will change the title to E(East), S(South), W(West). If using the ON/OFF option frequently, it is recommended that you set “North” as a Preset. Recall the “North” Preset before enabling the directional title.

(11) OSD Camera Title (osd_cam_title) : rw

18-12. Home Function

Example: Request of getting home function parameters and values (Model_C)http://< ipcam >/ptz/home_function.php?app=get

- 314 -


Example: Response of getting home function parameters and values (Model_C)res=200&osd_display=1&osd_preset_title=6&osd_trace=0&osd_line_color=2&osd_bounding_box=1&osd_view_a_title=0&osd_blending=0&osd_af_ae=1&osd_date_time=1&osd_view_direction=0&osd_cam_title=DomeID

[Table 210] Parameters of home_function.php in Model_C

Name TypeLengt

hDescription Value

method stringOperation get_preset, get_tour,

get_pattern, get_autoscan

home_function integer

0 : None1 : Preset2 : Pattern3 : Tour4 : Auto Scan

home_number integer 1 ~ 240

home_waiting_time integerHome Function Waiting Time

10 ~ 240

home_function_use integerEnable/Disable Home Function

0 : Off1 : On

home_boot_function integer

Power On Mode 0 : None1 : Preset2 : Pattern3 : Tour4 : Auto Scan

home_boot_function_number

integerPower On Mode Number

1 ~ 240

home_boot_function_use

integerEnable/Disable Power On Mode

0 : Off1 : On

(1) Home Function Operations (method): rwget_preset : retrieve preset list.get_tour : retrieve tour list.

- 315 -


get_pattern : retrieve pattern list.get_autoscan : retrieve auto scan list.

(2) Home Function (home_function): rwThe Home function can be set so that the camera automatically goes to Preset, Tour, Pattern, Auto Scan after the keyboard controller has been idle for certain time.

(3) Home Function Number (home_number) : rw

(4) Home Function Waiting Time (home_waiting_time) : rwSet the home function waiting time. 10~240 second.

(5) Enable/Disable Home Function (home_function_use) : rw

(6) Power On Mode (home_boot_function) : rwPower On function can set the camera to go Preset, Tour, Pattern, Auto Scan in case of power off or black out.

(7) Power On Mode Number (home_boot_function_number) : rw

(8) Enable/Disable Power On Mode (home_boot_function_use) : rw

18-13. Motor Setup

Example: Request of getting motor parameters and values (Model_C)http://< ipcam >/ptz/motor.php?app=get

Example: Response of getting motor parameters and values (Model_C)res=200&motor_pt=1&motor_mode=1&motor_slow_pan=6&motor_slow_tilt=6&motor_normal_pan=10&motor_normal_tilt=10&motor_turbo_pan=16&motor_turbo_tilt=2

[Table 211] Parameters of home_function.php in Model_C

Name TypeLengt

hDescription Value

motor_pt integer Enable/Disable 0 : Off

- 316 -


Proportional P/T 1 : On

motor_mode integerMotor Mode 1 : Slow

2 : Normal3 : Turbo

motor_slow_pan integer Slow Pan *[Table 212]motor_slow_tilt integer Slow Tiltmotor_normal_pan integer Normal Pan *[Table 213]motor_normal_tilt integer Normal Tilt *[Table 214]motor_turbo_pan integer Turbo Pan *[Table 215]motor_turbo_pan integer Turbo Tilt *[Table 216]

(1) Enable/Disable Proportional P/T (motor_pt): rw

(2) Motor Mode (motor_mode): rw

(3) Slow Pan (motor_slow_pan) : rw

(4) Slow Tilt (motor_slow_tilt) : rw

[Table 212] Slow Pan, Tilt ValueValue Speed Value Speed

0 19 9 551 22 10 602 25 11 653 28 12 704 32 13 755 36 14 806 40 15 857 45 16 908 50

(5) Normal Pan (motor_normal_pan) : rw

[Table 213] Normal Pan ValueValue Speed Value Speed Value Speed

- 317 -


0 40 13 110 26 2401 45 14 120 27 2502 50 15 130 28 2603 55 16 140 29 2704 60 17 150 30 2805 65 18 160 31 2906 70 19 170 32 3007 75 20 180 33 3108 80 21 190 34 3209 85 22 200 35 33010 90 23 210 36 34011 95 24 220 37 35012 100 25 230 38 360

(6) Normal Tilt (motor_normal_tilt) : rw

[Table 214] Normal Tilt ValueValue Speed Value Speed Value Speed

0 40 8 80 16 1401 45 9 85 17 1502 50 10 90 18 1603 55 11 95 19 1704 60 12 100 20 1805 65 13 110 21 1906 70 14 120 22 2007 75 15 130

(7) Turbo Pan (motor_turbo_pan) : rw

[Table 215] Turbo Pan ValueValue Speed Value Speed Value Speed

0 200 7 270 14 3401 210 8 280 15 3502 220 9 290 16 3603 230 10 300 17 370

- 318 -


4 240 11 310 18 3805 250 12 3206 260 13 330

(8) Turbo Tilt (motor_turbo_pan) : rw

[Table 216] Turbo Tilt ValueValue Speed Value Speed Value Speed

0 90 8 160 16 2401 95 9 170 17 2502 100 10 180 18 2603 110 11 190 19 2704 120 12 200 20 2805 130 13 210 21 2906 140 14 220 22 3007 150 15 230

18-14. RS-485

Example: Request of getting rs485 parameters and values (Model_C)http://< ipcam >/ptz/comm.php?app=get

Example: Response of getting rs485 parameters and values (Model_C)res=200&comm_id=1&comm_protocol=0&comm_baud=2&comm_parity=0

[Table 217] Parameters of comm.php in Model_C

Name TypeLengt

hDescription Value

comm_id integer RS485 ID 1 ~ 999comm_protocol integer RS485 Protocol *[Table 218]

comm_baud integer

RS485 Baud Rate 0 : 24001 : 48002 : 96003 : 192004 : 38400

- 319 -


comm_parity integerRS485 Parity Bit 0 : None

1 : Even

(1) RS485 ID (comm_id): rw

(2) RS485 Protocol (comm_protocol): rw

[Table 218] RS485 ProtocolValue Protocol

0 Auto1 F2/F2E2 SENSORMATIC3 PELCO-P/D4 VICON5 ERNITEC6 F27 PHILIPS8 PANASONIC9 DYNACOLOR

(3) RS485 Baud Rate (comm_baud) : rw

(4) RS485 Parity Bit (comm_parity) : rw

18-15. View Angle

Example: Request of getting view angle parameters and values (Model_C)http://< ipcam >/ptz/view_angle.php?app=get

Example: Response of getting view angle parameters and values (Model_C)res=200&http_port=80&https_port=443&view_angle_flip=2&view_angle_tiltoverangle=1&view_angle_pan_enable=0&view_angle_pan_swap=0&view_angle_pan_autopan=1&view_angle_pan_r_limit_angle=000.0&view_angle_pan_l_limit_angle=000.0&view_angle_pan_r_limit_pos1=0&view_angle_pan_r_limit_pos2=0&view_angle_pan_r_limit_pos3=0&view_angle_pan_l_limit_pos1=0&view_angle_pan_l_limit_pos2=0&

- 320 -


view_angle_pan_l_limit_pos3=0

[Table 219] Parameters of pattern.php in Model_C

Name TypeLengt

hDescription Value

http_port integer HTTP Port Number 80 (default)https_port integer HTTPS Port Number 443 (default)method string View Anlge right_angle, left_angle

view_angle_flip integer

Flip 0 : off1 : auto2 : 903 : 1004 : 1105 : 120

view_angle_tiltoverangle

integerTilt Over Angle 0 : on

1 : W/O Bubble2 : with Bubble

view_angle_pan_enable integerEnable/Disable Panning Range

0 : off1 : on

view_angle_pan_swap integerEnable/Disable Panning Swap

0 : off1 : on

view_angle_pan_autopan

integerEnable/Disable Panning Autopan

0 : off1 : on

view_angle_pan_r_limit_angle

stringPanning Range Right Limit

view_angle_pan_l_limit_angle

stringPanning Range Left Limit

view_angle_pan_r_limit_pos#

integerPanning Range Right Limit Position

view_angle_pan_l_limit_pos#

integerPanning Range Left Limit Position


- 321 -



(3) View Anlge (method) : rwright_angle : set current angle as right angle limit.left_angle : set current angle as left angle limit.

(4) Flip (view_angle_flip) : rw

(5) Tilt Over Angle Limit (view_angle_tiltoverangle) : rw

(6) Enable/Disable Panning Range (view_angle_pan_enable) : rw

(7) Enable/Disable Panning Swap (view_angle_pan_swap) : rw

(8) Enable/Disable Panning Autopan (view_angle_pan_autopan) : rw

(9) Panning Range Right Limit (view_angle_pan_r_limit_angle) : ro

(10) Panning Range Left Limit (view_angle_pan_l_limit_angle) : ro

(11) Panning Range Right Limit Position (view_angle_pan_r_limit_pos#) : ro

(12) Panning Range Left Limit (view_angle_pan_l_limit_pos#) : ro

18-16. System Menu

Example: Request of getting system menu parameters and values (Model_C)http://< ipcam >/ptz/system_menu.php?app=get

Example: Response of getting system menu parameters and values (Model_C)res=200&sys_calibration=1&sys_menu_time_out=0&sys_dome_answer=1&sys_passwd_use=0

[Table 220] Parameters of system_menu.php in Model_C

- 322 -


Name TypeLengt

hDescription Value

sys_calibration integerEnable/Disable Calibration

0 : Off1 : On

sys_menu_time_out integerEnable/Disable Menu Time Out

0 : Off1 : On

sys_dome_answer integerEnable/Disable Dome Answer

0 : Off1 : On

sys_passwd_use integerEnable/Disable Password

0 : Off1 : On

(1) Enable/Disable Calibration (sys_calibration): rwChoose to enable or disable calibration (auto origin check).

(2) Enable/Disable Menu Time Out (sys_menu_time_out): rwChoose to enable or disable the menu time out.

(3) Enable/Disable Dome Answer (sys_dome_answer) : rwChoose to enable or disable dome answer.

(4) Enable/Disable Password (sys_passwd_use) : rw

18-17. Privacy Zone

Example: Request of getting privacy zone parameters and values (Model_C)http://< ipcam >/ptz/privacy_zone.php?app=get

Example: Response of getting privacy zone parameters and values (Model_C)res=200&http_port=80&https_port=443&privacy_1_title=Zone1&privacy_1_zone=0&privacy_1_method=2&privacy_2_title=Zone2&privacy_2_zone=0&privacy_2_method=2&privacy_3_title=Zone3&privacy_3_zone=0&privacy_3_method=2&privacy_4_title=Zone4&privacy_4_zone=0&privacy_4_method=2&privacy_5_title=Zone5&privacy_5_zone=0&privacy_5_method=2&privacy_6_title=Zone6&privacy_6_zone=0&privacy_6_method=2&privacy_7_title=Zone7&privacy_7_zone=0&privacy_7_method=2&privacy_8_title=Zone8&privacy_8_zone=0&privacy_8_method=2&

- 323 -


[Table 221] Parameters of privacy_zone.php in Model_C

Name TypeLengt

hDescription Value


method stringOperation set_privacy_zone,

set_data, deleteprivacy_#_title string Privacy Zone Title

privacy_#_zone integerEnable/Disable Privacy Zone

0 : off1 : on

privacy_#_method integerPrivacy Zone 0 : Block

1 : V.Off2 : Init (read only)

privacy_number integerSelected Privacy Zone Number

1 ~ 8

title stringSelected Privacy Zone Title

zone integerEnable/Disable Selected Privacy Zone

method_value integerSelected Privacy Zone

0 : Block1 : V.Off



(3) Privacy Zone Operations (method) : rwset_privacy_zone : create a privay zone.set_data : update privacy zone configuration.delete : delete a privacy zone.

- 324 -


(4) Privacy Zone Title (privacy_#_title) : ro

(5) Enable/Disable Privacy Zone (privacy_#_zone) : ro

(6) Privacy Zone (privacy_#_method) : ro

(7) Selected Privacy Zone Number (privacy_number) : rw

(8) Selected Privacy Zone Title (title) : rw

(9) Enable/Disable Selected Privacy Zone (zone) : rw

(10) Selected Privacy Zone (method_value) : rw

19. HTTP Event Stream for Fastrax 4

This is used to get an event notification alert stream from the device via HTTP. The connection is established with the device when the function is called, and stays open to constantly receive event notifications.

The sequence for using this is - Get HTTP port by config.txt- Connect to HTTP server with that port- Request event stream of specific channel and stream number using GET or

POST method- Receive event stream from HTTP server continuously- Send keep-alive message every 30 sec

The event types are all configurable events on the device, onboot, alarm, motion, trigger and vloss.

Example: Request of getting event streamhttp://<videoserver>/stream/event_stream.php?ch=1&strm=1&motion=1

Example: Response of event stream

- 325 -


event_time=2001-01-01 20:38:24onboot=0motion=0trigger=0alarm=0netloss=0analytics=0

[Table 222] Parameters of /stream/event_strm.php for request

Name TypeLengt

hDescription Value


(Default=1)

strm integerVideo Stream Number 1 ~ 4

(Default=1)fulltext bool All Event Information On: 1, Off: 0onboot bool On Boot Eventalarm bool Alarm In Eventmotion bool Motion Detection Eventtrigger bool Manual Trigger Eventnetloss bool Network Loss Eventanalytics bool Analytics Event

[Table 223] Parameters of /stream/event_strm.php for reply

Name TypeLengt

hDescription Value

event_time string 19Event Information Date and Time

YYYY-MM-DD HH:MM:SS

onboot bool On boot Event Event: 1No-Event: 0alarm bool Alarm Event

alarm# boolSpecified ID Alarm Event

motion boolMotion Detection Event

ch#_strm#_motion bool Motion Detection

- 326 -


Event of the Specified Channel and Stream

ch#_strm#_rgn# boolMotion Detection Event of the Specified Region

ch#_strm#_rgn#_senintege

rSensitivity of the Region

1 ~ 100

ch#_strm#_rgn#_threintege

rThreshold of the Region

1 ~ 100

ch#_strm#_rgn#_actintege

rActivity(Status) of the Region

1 ~ 100

trigger boolManual Trigger Event

Event: 1No-Event: 0

trigger# boolManual Trigger Event of the ID

netloss boolNetwork Loss Event

analytics bool Analytcs Eventpan_value float Pan Position -1 ~ 1tilt_value float Tilt Position -1 ~ 1zoom_value float Zoom Position 0 ~ 1

analytics_motion boolAnalytics Motion Event

Event: 1No-Event: 0

analytics_tracking boolAnalytics Tracking Event

analytics_cross boolAnalytics Cross Event

analytics_abandon boolAnalytics Abandon Event

analytics_removal boolAnalytics Removal Event

analytics_enter boolAnalytics Enter Event

analytics_motion_sensitivity int Sensitivity Value *[18-6.

- 327 -


Event In - Analytic]

analytics_motion_classification intClassification Value

analytics_motion_min_obj_size int Min. Object Sizeanalytics_motion_max_obj_size

intMax. Object Size

analytics_motion_area_num int Motion Area Count 1 ~ 10

analytics_motion_area#_sx intMotion Area Start X

analytics_motion_area#_sy intMotion Area Start Y

analytics_motion_area#_ex int Motion Area End Xanalytics_motion_area#_ey int Motion Area End Y

analytics_motion_color#_y intMotion Area Y Value

analytics_motion_color#_cb intMotion Area Cb Value

analytics_motion_color#_cr intMotion Area Cr Value

analytics_tracking_sensitivity int Sensitivity Value *[18-6. Event In - Analytic]

analytics_tracking_zoom int Zoom Valueanalytics_tracking_min_obj_size

intMin. Object Size

analytics_tracking_max_obj_size

intMax. Object Size

analytics_tracking_cross int Cross Valueanalytics_tracking_indicate int Indicate Value

analytics_tracking_area_cx intTracking Area Center X

analytics_tracking_area_cx intTracking Area Center Y

analytics_tracking_color_y intTracking Area Y Value

analytics_tracking_color_cb intTracking Area Cb Value

analytics_tracking_color_cr int Tracking Area Cr

- 328 -


Valueanalytics_cross_direction int Direction Value *[18-6.


analytics_cross_classification intClassification Value

analytics_cross_min_obj_size int Min. Object Sizeanalytics_cross_max_obj_size int Max. Object Sizeanalytics_cross_tracking_enable

intTracking Enable Value

analytics_cross_position_sx intCross Position Start X

analytics_cross_position_sy intCross Position Start Y

analytics_cross_position_ex intCross Position End X

analytics_cross_position_ey intCross Position End Y

analytics_cross_area_num int Cross Area Count 1 ~ 10analytics_cross_area#_sx int Cross Area Start Xanalytics_cross_area#_sy int Cross Area Start Yanalytics_cross_area#_ex int Cross Area End Xanalytics_cross_area#_ey int Cross Area End Yanalytics_cross_event_area# int Cross Event Areaanalytics_abandon_event_time int Event Time Value *[18-6.


analytics_abandon_min_obj_size

intMin. Object Size

analytics_abandon_max_obj_size

intMax. Object Size

analytics_abandon_area_info_sx

intAbandon Area Information Start X

analytics_abandon_area_info_sy

intAbandon Area Information Start Y

analytics_abandon_area_info_ex

intAbandon Area Information End X

- 329 -


analytics_abandon_area_info_ey

intAbandon Area Information End Y

analytics_abandon_area_num intAbandon Area Count

1 ~ 10

analytics_abandon_area#_sx intAbandon Area Start X

analytics_abandon_area#_sy intAbandon Area Start Y

analytics_abandon_area#_ex intAbandon Area End X

analytics_abandon_area#_ey intAbandon Area End Y

analytics_abandon_event_area#

intAbandon Event Area

analytics_removal_event_time int Event Time Value *[18-6. Event In - Analytic]

analytics_removal_min_obj_size

intMin. Object Size

analytics_removal_max_obj_size

intMax. Object Size

analytics_removal_area_info_sx

int Removal Area Information Start X

analytics_removal_area_info_sy

int Removal Area Information Start Y

analytics_removal_area_info_ex

intRemoval Area Information End X

analytics_removal_area_info_ey

intRemoval Area Information End Y

analytics_removal_area_num intRemoval Area Count

1 ~ 10

analytics_removal_area#_sx intRemoval Area Start X

analytics_removal_area#_sy intRemoval Area Start Y

- 330 -


analytics_removal_area#_ex intRemoval Area End X

analytics_removal_area#_ey intRemoval Area End Y

analytics_removal_event_area#

intRemoval Event Area

analytics_enter_base int Base Value *[18-6. Event In - Analytic]

analytics_enter_classification intClassification Value

analytics_enter_min_obj_size int Min. Object Sizeanalytics_enter_max_obj_size int Max. Object Sizeanalytics_enter_area_info_sx int Enter Area

Information Start X

analytics_enter_area_info_sy int Enter Area Information Start Y

analytics_enter_area_info_ex intEnter Area Information End X

analytics_enter_area_info_ey intEnter Area Information End Y

analytics_enter_area_num int Enter Area Count 1 ~ 10analytics_enter_area#_sx int Enter Area Start Xanalytics_enter_area#_sy int Enter Area Start Yanalytics_enter_area#_ex int Enter Area End Xanalytics_enter_area#_ey int Enter Area End Yanalytics_enter_event_area# int Enter Event Area* The record field is to represent any information of recording status, record_bad or ch#_record parameters. If this is 0, then there MAY be no information of record_bad and ch#_record.

20. Discovery

This document specified the Smart-Search protocol which is the Hitron own protocol that can discover and maintain Hitron camera.

- 331 -


20-1. Communication Channel

Smart-Search is the server/client model using broadcasting.

[Table 224] Server/Client communication channelClient (Search Utility) Server (Camera)IP address 255.255.255.255 IP addressSend Port(request service)

------> 20000 ------> Receive Port

Receive Port <------ 20001 <------Send Port(response to service)

20-2. Message

Below table describes the message structure of the packets between server and client.

[Table 225] Message structureMember Name Type Length Descriptioncmd UINT32 4 Command Type ([Table 226] Command

List)host_name CHAR 128 Host namemac CHAR 20 MAC addressip CHAR 32 IP addresshttp_port CHAR 8 HTTP port numberrtsp_port CHAR 8 RTSP port numberrtp_addr CHAR 32 Multicast RTP addressrtp_port CHAR 8 Multicast RTP portfw_ver CHAR 64 Firmware versionbr_ver CHAR 64 Bootloader versionset_ip CHAR 32 New IP address https_mode CHAR 8 HTTP connection mode ([Table 227] Mode

List)

- 332 -


https_port CHAR 8 HTTPS port number model CHAR 32 Hitron Model namemodel_custromer

CHAR 32 Customer model name

camera_name CHAR 64 Friendly camera namezeroconf_ip CHAR 32 Zero configuration IP addresswireless_mac CHAR 20 Wireless MAC addresswireless_ip CHAR 32 Wireless configuration IP address

(1) cmdThis is command type of the message.

[Table 226] Command ListCommand Type Value DescriptionCMD_GET_INF_REQ 1000 Request to get information CMD_GET_INF_RES 1001 Response to get information (*ack)CMD_SET_INF_REQ 1002 Not usedCMD_SET_INF_RES 1003 Not usedCMD_SET_IP_REQ 1004 Request to set new ip addressCMD_SET_IP_RES 1005 Response to set new ip address (ack)CMD_SET_REBOOT_REQ 1006 Request to reboot systemCMD_SET_REBOOT_RES 1007 Response to reboot system (ack)CMD_SET_USERSET_REQ 1008 Request to reset parameters except IP

parametersCMD_SET_USERSET_RES 1009 Response to reset parameters except IP

parameters (ack)CMD_SET_RESTORE_REQ 1010 Request to reset parameters except IP

parametersCMD_SET_RESTORE_REQ 1011 Response to reset parameters except IP

parameters (ack)CMD_SET_DEFAULT_REQ 1012 Request to reset all parametersCMD_SET_DEFAULT_RES 1013 Response to reset all parameters (ack)*ack means that acknowledge for request command

(2) https_mode

- 333 -


This is mode type of HTTP connection.

[Table 227] Mode ListMode Value DescriptionHTTP_MODE 0 Only HTTP modeHTTPS_MODE 1 Only HTTPS modeHTTP_HTTPS_MODE 2 Both HTTP and HTTPS mode

20-3. Example Code

- 334 -

typedef struct __discovery_msg_type {UINT32 cmd;INT8 host_name[128];INT8 mac[20];INT8 ip[32];INT8 http_port[8];INT8 rtsp_port[8];INT8 rtp_addr[32];INT8 rtp_port[8];INT8 fw_ver[64];INT8 br_ver[64];INT8 set_ip[32];INT8 https_mode[8];INT8 https_port[8];INT8 model[32];INT8 model_customer[32];INT8 camera_name[64];INT8 zeroconf_ip[32];INT8 wireless_mac[20];INT8 wireless_ip[32];

} DISCOVERY_MSG, *PDISCOVERY_MSG;

typedef enum {CMD_GET_INF_REQ = 1000,CMD_GET_INF_RES,

. . .

CMD_SET_DEFAULT_REQ,CMD_SET_DEFAULT_RES} DISCOVERY_CMD_TYPE;

#define DISCOVERY_RECEIVER_PORT 20000#define DISCOVERY_SENDER_PORT20001


- 335 -

INT32 main (INT32 argc, INT8 *argv[]){

DISCOVERY_MSG msg;SOCKET sock;struct sockaddr_in to;struct sockaddr_in addr;INT32 flag = 1;INT32 msgsize = sizeof(DISCOVERY_MSG);

/* Create and bind broadcasting socket for receive request*/sock = socket (AF_INET, SOCK_DGRAM, 0);setsockopt (sock, SOL_SOCKET, SO_REUSEADDR, &flag, sizeof(flag));setsockopt (sock, SOL_SOCKET, SO_BROADCAST, &flag, sizeof(flag));

addr.sin_family = AF_INET;addr.sin_addr.s_addr = htons(INADDR_ANY);addr.sin_port = htons(DISCOVERY_RECEIVER_PORT);bind(sock, (struct sockaddr *)&addr, sizeof(addr));

while (TRUE){

if (recvfrom(sock, &msg, msgsize, &to, sizeof (struct sockaddr_in) > 0){

switch(msg.cmd) {case CMD_GET_INF_REQ:

/* Fill information in msg structure */to.sin_addr.s_addr = htonl(INADDR_BROADCAST);to.sin_port = htons(DISCOVERY_SENDER_PORT);msg.cmd = CMD_GET_INF_RES; ///< set ack messagesendto(sock, &msg, msgsize, 0, &to, sizeof( struct sockaddr_in));break;

}}

} return 0;}


21. Light Control via HTTP

This is to control the light via HTTP.

Example: Request of getting light_control parameters and valueshttp://<ipaddress>/live/light_control.php?app=get

Example: Response of getting light_control parameters and valuesres=200&light_status=0&light_level=5

[Table 228] Parameters of /lige/light_control

Name TypeLengt

hDescription Value

light_status bool Light On/Off On: 1, Off: 0light_level int Light Brightness 1~10

(1) Light On/Off (light_status): rw

(2) Light Brightness (light_level): rw

- 336 -

Documents

eVideo Product SDK Developer’s Manual (ver 1cgv_systeme/pub/CGV/IP/DMEIP30IR/SDK/e... · Web view2012/06/19 · MUST This word or the adjective “REQUIRED” means that the item