DELTA GROUP Vivotek IB9391-EHTV-v2 User Manual
  1. Manuals
  2. Brands
  3. DELTA GROUP Manuals
  4. Security Camera
  5. Vivotek IB9391-EHTV-v2
  6. User manual

DELTA GROUP Vivotek IB9391-EHTV-v2 User Manual

Bullet network camera
Hide thumbs
1
Table Of Contents
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
Table of Contents

Advertisement

Quick Links

Download this manual
IB9391-EHTV-v2
IB9365-EHTV-v2
User 's Manual
2MP (IB9365) / 8MP (IB9391) • IP67 • IK10 • Day & Night • Smart Motion Detection •
Remote Focus • WDR Pro II • Smart Stream III • SNV II • 50M Smart IR • Shock Detection
Bullet
Net work Camera
Rev. 1.1

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Vivotek IB9391-EHTV-v2 and is the answer not in the manual?

Questions and answers

Related Manuals for DELTA GROUP Vivotek IB9391-EHTV-v2

Summary of Contents for DELTA GROUP Vivotek IB9391-EHTV-v2

  • Page 1 IB9391-EHTV-v2 Bullet IB9365-EHTV-v2 Net work Camera User ’s Manual 2MP (IB9365) / 8MP (IB9391) • IP67 • IK10 • Day & Night • Smart Motion Detection • Remote Focus • WDR Pro II • Smart Stream III • SNV II • 50M Smart IR • Shock Detection Rev.

  • Page 2: Table Of Contents

    VIVOTEK Table of Contents Overview ................................7 Revision History ................................. 8 Read Before Use ................................8 Package Contents ................................11 Symbols and Statements in this Document ........................11 Physical Description ................................. 12 Hardware Installation ................................ 15 Software Installation ................................. 28 Network Deployment ................................
  • Page 3 VIVOTEK Applications > Tampering detection ..........................157 Applications > Audio detection ............................158 Applications > Shock detection ............................160 Applications > Package management - a.k.a., VADP (VIVOTEK .................. 161 Recording > Recording settings ............................. 165 Storage ................................... 170 Storage > SD card management ........................... 170 Storage >...
  • Page 4 VIVOTEK 7.11 Image Setting per Channel ..................... 249 7.12 Exposure Window Setting per Channel ................... 259 7.12.1. Exposure Window Setting for Each Window ......................260 7.13 Audio Input per Channel ......................263 7.13.1. Multicast Settings for Audio Streaming ........................267 7.14 Audio Output per Channel ......................
  • Page 5 VIVOTEK 7.38.1. VADP Settings for Each Hyperlink ........................ 387 7.38.2. VADP Settings for Each Package ........................388 7.38.3. VADP Schedule Settings ..........................389 7.38.4. VADP Event Settings ..........................389 7.39 Camera PTZ Control ....................... 389 7.40 Camera PTZ Control (IZ Series) ..................... 391 7.41 Camera PTZ Control (SD Series) ....................
  • Page 6 VIVOTEK 8.24 Media on Demand (capability_localstorage.modnum > 0) ............438 8.25 3D Privacy Mask (Capability_image_c<0~(n‐1)>_privacymask_wintype = ......440 8.26 Camera Control ........................441 8.27 Recall (capability_camctrl_c<0~(n‐1)>_zoommodule = 1) ............445 8.28 Preset Locations ........................446 8.29 SmartSD (capability_localstorage_smartsd > 0) ..............446 8.30 Connect to AP (capability_network_wireless >...

  • Page 7: Overview

    VIVOTEK Overview The IB9391 and 9365 series is a camera line to come embedded with the Smart Motion Detection feature. The Smart Motion detection, with Human detection and tunable time filter, can eliminate the defects of traditional motion detection and facilitate the configuration at a surveillance site.

  • Page 8: Revision History

    VIVOTEK Revision History ■ Rev. 1.0: Initial release. ■ Rev. 1.1: Update content based on new firmware. Read Before Use The use of surveillance devices may be prohibited by law in your country. The Network Camera is not only a high-performance web-ready camera but can also be part of a flexible surveillance system.
  • Page 9 VIVOTEK NOTE: Camera Hardware Preventative Maintenance: 1. Visual inspection of all major components including accessories, cabling and connections where accessible for signs of deterioration or damage. 2. Check and clean cameras, lenses and housings inside and out as needed. • Please do not scratch, damage, or leave fingerprints on the dome/front cover and/or lens because this may decrease image quality.
  • Page 10 VIVOTEK IMPORTANT: For some customers who already have their own web site or web control application, the Network Camera/Video Server can be easily integrated through URL syntax. This section specifies the external HTTP-based application programming interface. The HTTP-based camera interface provides the functionality to request a single image, control camera functions (PTZ, output relay etc.), and get and set internal parameter values.

  • Page 11: Package Contents

    VIVOTEK Package Contents ■ IB9391 or IB9365 ■ Screw pack, sun shield, penetration cap, I/O combo cable, base plate. ■ Alignment sticker. ■ Mounting plate ■ Conduit bracket ■ Quick Installation Guide ■ T20 wrench WARNING: 1. IR lights emit from this product. 2.

  • Page 12: Physical Description

    VIVOTEK Physical Description Outer View Sun shield Lens IR LEDs IMPORTANT: Many copper coated aluminum (CCA) and other non-standard conductors cabling products are masqueraded as CAT5E or CAT6 cables. Please avoid using these CCA products especially when cascading PoE cameras. It is a must to use Ethernet cables compliant with the 3P/ETL standard.
  • Page 13 VIVOTEK Inner View LEDs MicroSD card slot Micro USB connector for Wi-Fi dongle Reset button Conn 1 DI/DO connector Conn 2 Audio connector Ethernet port User's Manual - 13...
  • Page 14 VIVOTEK NOTE: Some of the suffix syntax used in model naming are listed below: w/ heater for extreme weather Focal length w/ number w/ Remote focus lens w/ PoE repeater w/ High Dynamic Range functionality Manual focus lens IMPORTANT: 802.3af or 802.3at The E model camera comes with an embedded heater and requires an 802.3at PoE switch.

  • Page 15: Hardware Installation

    VIVOTEK Hardware Installation IMPORTANT: If you plan to use the Human Detection feature, make sure you measure the installation height of your camera. The height information is important for the accuracy of the video analytics results. Some of the other perspective information is automatically collected by the onboard S-sensor.
  • Page 16 VIVOTEK 2. Use the alignment sticker to drill holes in the wall. If the use of a 1/2" conduit pipe is preferred, refer to the Installation option A. 16 - User's Manual...
  • Page 17 VIVOTEK 3. Route cables through the wall or ceiling, and remove the grommet from the base plate. 4. Remove the tip of the silicon grommet. Insert the RJ45 connector of your Ethernet cable into the penetration cap. User's Manual - 17...
  • Page 18 VIVOTEK VIVOTEK 5. Insert and pass the cable through the silicon grommet. If grommets are damaged, replace them with new ones. 6. Install the silicone grommet to the original opening from the bottom of the base plate. 18- User's Manual...
  • Page 19 VIVOTEK VIVOTEK 7. When installing the silicon grommet, make sure the cable is slightly pulled back to the outside. Do not leave the rim of the seal jammed in the inside of the seal. 8. The I/O combo cable comes with a pre-installed grommet. Install the cable to the opening and place I/O wires in the cable clip.
  • Page 20 VIVOTEK 9. Below are the pinouts of the I/O combo cable. Refer to the installation option B section for more information. 10. All cabling joints on the outside of the camera must be properly sealed for waterproofing. Use a crimping plier to connect a grounding wire to the ground screw following the instructions below.
  • Page 21 VIVOTEK DI/DO Diagram Dry contact with external DC power source to supply a relay. Dry contact is the safest connection to protect devices. Switch Photo Coupler DC External DC power DC 0V External AC power DC 0V with Protected Earth Relay External Device Wet contact with external DC power source to supply a relay.
  • Page 22 VIVOTEK depending on the type of relay you use. 4. In case of using an individual relay (instead of using a relay module), for protection against voltage or current spikes, a transient voltage suppression diode must be connected in parallel with the inductive load. 32- User's Manual...
  • Page 23 VIVOTEK Dry contact and using camera’s DO+ to supply a relay. Switch External AC power with Protected Earth Relay External Device User's Manual - 23 User's Manual – 31...
  • Page 24 VIVOTEK 11. Install the base plate to wall by driving 4 screws. 12. Use the T20 wrench to open the panel cover on the camera. 32- User's Manual...
  • Page 25 VIVOTEK 13. If preferred, install a MicroSD card to the camera. You can connect a WiFi dongle to the camera's micro USB port for an onsite adjustment of imaging and the shooting direction. You can use a notebook to connect the camera at the installation site via a wireless connection.
  • Page 26 VIVOTEK 15. Connect the Ethernet and the I/O combo cable to the camera. Ethernet 16. Use the alignment marks on the camera and the base plate to align and secure the camera by fastening 3 T20 anti-tamper screws. T20 x3 32- User's Manual...
  • Page 27 VIVOTEK 17. Install the sun shield to camera. You can move the sun shield back and forth depending on the relative position at your installation site. 18. Please visit VIVOTEK’s website to Install the "Shepherd” software utility. The program will search for VIVOTEK Video Receivers, Video Servers or Network Cameras on the same LAN.
  • Page 28 VIVOTEK 19. Loosen the retention screw on the side of camera bracket in order to adjust the camera's shooting direction. 20. Remove the protective sheet on the camera lens. 32- User's Manual...
  • Page 29 VIVOTEK Installation option A: A-1. See below for the mounting holes used with applicable conduit boxes. 4" square and round box 4-11/16" square gang box 1" single gang box 4" octagon box Cantex 3/4” type FSE 2 Gang, Outdoor/Indoor electrical box Generic 3/4”...

  • Page 30: Software Installation

    VIVOTEK A-3. Drive screws to secure the bracket to wall. When installing camera, secure 4 T20 screws from the base plate. Wall-mount using A holes T20 anti-tamper M4 x 18 32- User's Manual...
  • Page 31 VIVOTEK A-4. Secure the 1/2" conduit pipe using the side-routing bracket. You can then route cables and install the camera and base plate to the bracket. 1/2” Pipe Installation option B: B-1. Pass the I/O extension kit cable through the cabling hole. CONN 2 12 pin CONN 1 10 pin User's Manual - 31...
  • Page 33 VIVOTEK B-2. Connect the pin headers to the I/O extension module and that on the camera. Note the orientation of the pin headers with the positions of the tabs. Properly install the grommet as previously described. Tabs DI-: Green/W DO+(12V): Purple DI2+: Orange/W DI3+: Yellow/W DO2-: Gray...
  • Page 34 VIVOTEK Software Installation 22. Install the Shepherd utility, which helps you locate and configure your Network Camera in the local network. If your camera comes without the CD, go to VIVOTEK’s website, and go to Products > Software > Application Software > Shepherd. 22-1.
  • Page 35 VIVOTEK 22-3. The program will search for all VIVOTEK network devices on the same LAN. 22-4. After a brief search, the installer window will prompt. Click on the MAC and model name that matches the one printed on the product label. You can then double-click on the address to open a management session with the Network Camera.
  • Page 36 VIVOTEK Forceful Password Configuration 23. The first time you log in to the camera, the firmware will prompt for a password configuration for security concerns. 23-1. Enter the combination of alphabetic and numeric characters to fulfill the password strength. requirement. The default name for the camera administrator is “root”, and can not be changed.

  • Page 37: Network Deployment

    VIVOTEK Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~. You can use them in the password combination. 23-3. Accept the anti-virus software license. Then, enter the username and password to sign in.
  • Page 38 VIVOTEK Cybersecurity Once you open the web console, enter Configuration > Applications > Package management, and click on Trend Micro IoT Security. Turn on the protection to fend off cyber attacks. In here, you can let the camera automatically update the virus codes or manually update the virus codes.
  • Page 39 VIVOTEK VIVOTEK 24. On a web console, go to Configuration > Media > Image > Focus, to tune for a best image focus. Configuration > Media > Image > Focus 25. With a satisfactory field of view, you can tighten the retention screw on the bracket. User's Manual - 33...
  • Page 40 VIVOTEK Hardware Reset The reset button is used to reset the system or restore the factory default settings. Sometimes resetting the system can return the camera to normal operation. If the system problems remain after reset, restore the factory settings and install again. Reset: Press the recessed reset button.

  • Page 41: Accessing The Network Camera

    VIVOTEK VIVOTEK Network Deployment General Connection (PoE) When using a PoE-enabled switch The Network Camera is PoE-compliant, allowing transmission of power and data via a single Ethernet cable. Follow the below illustration to connect the Network Camera to a PoE- enabled switch via Ethernet cable.

  • Page 42: Ready To Use

    VIVOTEK Ready to Use 1. A browser session to the Network Camera should prompt as shown below. 2. You should be able to see live video from your camera. You may also install the 32-channel recording software in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents.
  • Page 43 VIVOTEK VIVOTEK Internet connection via a router Before setting up the Network Camera over the Internet, make sure you have a router and follow the steps below. 1. Connect your Network Camera behind a router, the Internet environment is illustrated below. Regarding how to obtain your IP address, please refer to Software Installation on page 20 for details.

  • Page 44: Using Vivotek Recording Software

    VIVOTEK For example, your router and IP settings may look like this: Device IP Address: internal port IP Address: External Port (Mapped port on the router) Public IP of router 122.146.57.120 LAN IP of router 192.168.2.1 Camera 1 192.168.2.10:80 122.146.57.120:8000 Camera 2 192.168.2.11:80 122.146.57.120:8001...

  • Page 45: Using Web Browsers

    VIVOTEK VIVOTEK Accessing the Network Camera This chapter explains how to access the Network Camera through web browsers, RTSP players, 3GPP-compatible mobile devices, and VIVOTEK recording software. Using Web Browsers Use Vivotek Shepherd to access the Network Cameras on LAN. If your network environment is not a LAN, follow these steps to access the Network Camera: 1.

  • Page 46: Using Rtsp Players

    VIVOTEK Using RTSP Players To view the streaming media using RTSP players, you can use one of the following players that support RTSP streaming. VLC media player VLC media player mpegable Player 1. Launch the RTSP player. 2. Choose File > Open URL. A URL dialog box will pop up. pvPlayer 3.

  • Page 47: Using 3Gpp-Compatible Mobile Devices

    VIVOTEK VIVOTEK Using 3GPP-compatible Mobile Devices To view the streaming media through 3GPP-compatible mobile devices, make sure the Network Camera can be accessed over the Internet. For more information on how to set up the Network Camera over the Internet, please refer to Setup the Network Camera over the Internet on page To utilize this feature, please check the following settings on your Network Camera: 1.
  • Page 48 VIVOTEK Using VIVOTEK Recording Software You can download a VSS recording software program, allowing simultaneous monitoring and video recording for multiple Network Cameras. Please install the recording software; then launch the program to add the Network Camera to the Channel list. For detailed information about how to use the recording software, please refer to the user’s manual of the software or download it from http://www.vivotek.com.

  • Page 49: Main Page

    VIVOTEK VIVOTEK Main Page This chapter explains the layout of the main page. It is composed of the following sections: VIVOTEK INC. Logo, Host Name, Camera Control Area, Configuration Area, Menu, and Live Video Window. Resize Buttons VIVOTEK INC. Host Name Logo Configuration Area...

  • Page 50: Client Settings

    VIVOTEK Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 50. Configuration: Click this button to access the configuration page of the Network Camera. It is suggested that a password be applied to the Network Camera so that only the administrator can configure the Network Camera.
  • Page 51 VIVOTEK VIVOTEK PTZ Panel: This Network Camera supports “digital“ (e-PTZ) pan/tilt/zoom control, which allows roaming a smaller view frame within a large view frame. Please refer to PTZ settiings on page 135 for detailed information. Global View: Click on this item to display the Global View window. The Global View window contains a full view image (the largest frame size of the captured video) and a floating frame (the viewing region of the current video stream).
  • Page 52 VIVOTEK Mute: Turn off the volume on the local computer. The button becomes the Audio On button after clicking the Mute button. Talk: Click this button to talk to people around the Network Camera. Audio will project from the external speaker connected to the Network Camera. Click this button again to end talking transmission.

  • Page 53: Configuration

    VIVOTEK VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Time 2019/01/25 17:08:56 Title and Time Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 74.
  • Page 54 VIVOTEK Client Settings This chapter explains how to select the stream transmission mode and saving options on the local computer. When completed with the settings on this page, click Save on the page bottom to enable the settings. H.265/H.264 Media Options Select to stream video or audio data or both.
  • Page 55 VIVOTEK VIVOTEK Two way audio Half duplex: Audio is transmitted from one direction at a time, e.g., from a PC holding a web console with the camera. Full duplex: Audio is transmitted in both directions simultaneously. MP4 Saving Options Users can record live video as they are watching it by clicking Start MP4 Recording on the main page.

  • Page 56: Configuration

    VIVOTEK Configuration Click Configuration on the main page to enter the camera setting pages. Note that only Administrators can access the configuration page. VIVOTEK provides an easy-to-use user interface that helps you set up your network camera with minimal effort. In order to simplify the user interface, detailed information will be hidden unless you click on the function item.

  • Page 57: System > Homepage Layout

    VIVOTEK VIVOTEK Configuration Click Configuration on the main page to enter the camera setting pages. Note that only Administrators can access the configuration page. VIVOTEK offers an easy-to-use user interface that helps you set up your network camera with minimal effort. To simplify the setting procedure, two types of user interfaces are available: Advanced Mode for professional users and Basic Mode for entry-level users.
  • Page 58 VIVOTEK System time Keep current date and time: Select this option to preserve the current date and time of the Network Camera. The Network Camera’s internal real-time clock maintains the date and time even when the power of the system is turned off. Synchronize with computer time: Select this option to synchronize the date and time of the Network Camera with the local computer.
  • Page 59 VIVOTEK VIVOTEK Here are some examples for TZ values, including the appropriate Daylight Saving Time and its dates of applicability. In North American Eastern Standard Time (EST) and Eastern Daylight Time (EDT), the normal offset from UTC is 5 hours; since this is west of the prime meridian, the sign is positive.
  • Page 60 VIVOTEK Western Argentina Summer Time (WARST) is 3 hours behind the prime meridian all year. There is a dummy fallback transition on December 31 at 25:00 daylight saving time (i.e., 24:00 standard time, equivalent to January 1 at 00:00 standard time), and a simultaneous spring-forward transition on January 1 at 00:00 standard time, so daylight saving time is in effect all year and the initial WART is a placeholder.
  • Page 61 VIVOTEK VIVOTEK System > Homepage layout This section explains how to set up your own customized homepage layout. General settings This column shows the settings of your homepage layout. You can manually select the background and font colors in Theme Options (the second tab on this page). The settings will be displayed automatically in this Preview field.
  • Page 62 VIVOTEK Theme Options Here you can change the color of your homepage layout. There are three types of preset patterns for you to choose from. The new layout will simultaneously appear in the Preview field. Click Save to enable the settings.
  • Page 63 VIVOTEK VIVOTEK ■ Follow the steps below to set up the customized homepage: 1. Click Custom on the left column. 2. Click the field where you want to change the color on the right column. Color Selector Custom Pattern 3. The palette window will pop up as shown below. 4.

  • Page 64: System > Logs

    VIVOTEK System > Logs This section explains how to configure the Network Camera to send the system log to a remote server as backup. Log server settings Follow the steps below to set up the remote log: 1. Select Enable remote log. 2.
  • Page 65 VIVOTEK VIVOTEK You can install the included VAST recording software, which provides an Event Management function group for delivering event messages via emails, GSM short messages, onscreen event panel, or to trigger an alarm, etc. For more information, refer to the VAST User Manual.
  • Page 66 VIVOTEK Access log Access log displays the access time and IP address of all viewers (including operators and administrators) in a chronological order. The access log is stored in the Network Camera’s buffer area and will be overwritten when reaching a certain limit. Set Parameter log VADP log contains the history of changes made to system parameters such as recording, imaging parameters, and all other parameters.

  • Page 67: System > Audit Log

    VIVOTEK VIVOTEK System > Audit Log The page records all the events trying to access the camera, no matter if the attempt is successful. User's Manual - 61...

  • Page 68: System > Parameters

    VIVOTEK System > Parameters The View Parameters page lists the entire system’s parameters. If you need technical assistance, please provide the information listed on this page. 62 - User's Manual...

  • Page 69: System > Maintenance

    VIVOTEK VIVOTEK System > Maintenance This chapter explains how to restore the Network Camera to factory default, upgrade firmware version, etc. General settings > Upgrade firmware This feature allows you to upgrade the firmware of your Network Camera. It takes a few minutes to complete the process.
  • Page 70 VIVOTEK General settings > Restore This feature allows you to restore the Network Camera to factory default settings. Network: Select this option to retain the Network Type settings (please refer to Network Type on page 100). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
  • Page 71 VIVOTEK VIVOTEK Export language file: Click to export language strings. VIVOTEK provides nine languages: English, Deutsch, Español, Français, Italiano, 日本語, Português, 簡体中文, and 繁體中文 . Update custom language file: Click Browse… and specify your own custom language file to upload. Export configuration file: Click to export all parameters for the device and user-defined scripts.

  • Page 72: Media > Image

    VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following columns: General settings, IR control, Image settings, Exposure, Focus, and Privacy mask. The Focus window is available only for models that come with motorized lens.
  • Page 73 VIVOTEK VIVOTEK Position of timestamp and video title on image: Select to display time stamp and video title on the top or at the bottom of the video stream. Timestamp and video title font size: Select the font size for the time stamp and title. Video font (.ttf): You can select a True Type font file for the display of textual messages on video.
  • Page 74 VIVOTEK Day/Night Settings Switch to B/W in night mode Select this to enable the Network Camera to automatically switch to Black/White during night mode. IR cut filter With a removable IR-cut filter, this Network Camera can automatically remove the filter to let Infrared light pass into the sensor during low light conditions.
  • Page 75 VIVOTEK VIVOTEK Illuminators Turn on built-in IR illuminator in night mode Select this to turn on the camera’s onboard IR illuminator when the camera detects low light condition and enters the night mode. Turn on external IR illuminator in night mode Select this to turn on the external IR illuminator when the camera detects low light condition and enters the night mode.
  • Page 76 VIVOTEK Tips: If there is an object in close proximity, the IR lights reflected back from it can mislead the Smart IR’s calculation of light level. To solve this problem, you can place “Exposure Exclude” window unavoidable object in the Exposure setting window. See page 72 for how to do it.
  • Page 77 VIVOTEK VIVOTEK Image settings On this page, you can tune the White balance and Image adjustment. Sensor Setting 2: For special situations Sensor Setting 1: For normal situations White balance: Adjust the value for the best color temperature. ■ You may follow the steps below to adjust the white balance to the best color temperature. 1.
  • Page 78 VIVOTEK Highlight mask: If there are strong light sources in the scene, the system will block out the strong light sources, and eliminate the effects from the lighting sources. For example, a strong lighting source can mislead the system to consider the whole scene is well lit, while the other areas is in fact poorly represented.
  • Page 79 VIVOTEK VIVOTEK Note that the Preview button has been cancelled, all changes made to image settings is directly shown on screen. You can click Restore to recall the original settings without incorporating the changes. When completed with the settings on this page, click Save to enable the setting. You can also click on Profile mode to adjust all settings above in a tabbed window for special lighting conditions.
  • Page 80 VIVOTEK Exposure strategy: Measurement window: This function allows users to set measurement window(s) for low light compensation. For example, where low-light objects are posed against an extremely bright background. You may want to exclude the bright sunlight shining through a building's corridor. ■...
  • Page 81 VIVOTEK VIVOTEK Exposure control: ■ Exposure level: You can manually set the Exposure level, which ranges from -2.0 to +2.0 (dark to bright). You can click and drag the semi-circular pointers on the Exposure time and Gain control slide bars to specify a range of shutter time and Gain control values within which the camera can automatically tune to an optimal imaging result.
  • Page 82 VIVOTEK You can click Restore to recall the original settings without incorporating the changes. When completed with the settings on this page, click Save to enable the settings. If you want to configure another sensor setting for day/night/schedule mode, please click Profile to open the Profile of exposure settings page as shown below.
  • Page 83 VIVOTEK VIVOTEK Focus Focus here refers to the Remote Focus, applicable to Network Cameras that are equipped with a stepping motor lens. The automated focus adjustment function eliminates the needs to physically adjust camera focus. In an outdoor deployment consisting of a large number of cameras, the auto focus function can be very helpful when these cameras become out of focus after days or weeks of operation.

  • Page 84: Media > Video

    VIVOTEK 5. Wait for the scan to complete. After a short while, the clearest image obtained should be displayed and the optimal focus range achieved. Use the arrow marks on the sides to fine-tune the focus if you are not satisfied with the results. You may still need to use the arrow marks to fine-tune the focus depending on the live image on your screen.
  • Page 85 VIVOTEK VIVOTEK Privacy mask Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to address privacy concerns. ■ To configure privacy mask windows, 1. Click New to add a new window. 2. You can use 4 mouse clicks to create a new masking window, which is recommended to be at least twice the size of the object (height and width) you want to cover.
  • Page 86 VIVOTEK Pixel Calculator Click the Add button at the lower screen to create a pixel calculator window. Place your cursor on the window to move it to an area of your interest, and change the size of window to fit the area of interest.
  • Page 87 VIVOTEK VIVOTEK Take the following into consideration when using this feature: 1. Operational requirement: Identify a human or a human face. 2. Why human face? There are less variances in the size of a face than that for limbs and body. Human face is normally 16cm wide.
  • Page 88 VIVOTEK Media > Video Stream settings This Network Camera supports multiple streams with frame sizes ranging from 640 x 360 to 1920 x 1080 pixels The definition of multiple streams (IB9391): ■ Stream 1: The default frame size for Stream 2 is set to 3840 x 2160. ■...
  • Page 89 VIVOTEK VIVOTEK Please follow the steps below to set up those settings for a stream: 1. Select a stream for which you want to set up the viewing region. 2. Select a Region of Interest from the drop-down list. The floating frame, the same as the one in the Global View window on the home page, will resize accordingly.
  • Page 90 VIVOTEK Click the stream item to display the detailed information. The maximum frame size will follow your settings in the above Viewing Window sections. This Network Camera provides real-time H.265, H.264 and MJPEG compression standards (Triple Codec) for real-time viewing. If the H.265 H.264 mode is selected, the video is streamed via RTSP...
  • Page 91 VIVOTEK The frame rate will decrease if you select a higher resolution. ■ Intra frame period Determine how often for firmware to plant an I frame. The shorter the duration, the more likely you will get better video quality, but at the cost of higher network bandwidth consumption. Select the intra frame period from the following durations: 1/4 second, 1/2 second, 1 second, 2 seconds, 3 seconds, and 4 seconds.
  • Page 92 VIVOTEK VIVOTEK With the H.265 codec in an optimal scenario and when Dynamic Intra frame is combined with the Smart Stream function, an 80% of bandwidth saving can be achieved compared with using H.264 without enabling these bandwidth-saving features. ■ Smart FPS In a static scene, the algorithm puts old frames in queue when no motions occur in scene.
  • Page 93 VIVOTEK • Smart codec: Smart codec effectively reduces the quality of the whole or the non- interested areas on a screen and therefore reduces the bandwidth consumed. You can manually specify the video quality for the foreground and the background areas.
  • Page 94 VIVOTEK VIVOTEK As the result, the lower screen is constantly displayed in high details, while the upper half is transmitted using a lower-quality format. Although the upper half is transmitted using a lower quality format, you still have an awareness of what is happening on the whole screen.
  • Page 95 VIVOTEK Bit rate control ■ Constrained bit rate: A complex scene generally produces a larger file size, meaning that higher bandwidth will be needed for data transmission. The bandwidth utilization is configurable to match a selected level, resulting in mutable video quality performance. The bit rates are selectable at the following rates: 20Kbps, 30Kbps, 40Kbps, 50Kbps, 64Kbps, 128Kbps, 256Kbps, 512Kbps, 768Kbps, 1Mbps, 2Mbps, 3Mbps, 4Mbps, 6Mbps, 8Mbps, 10Mbps, 12Mbps, 14Mbps, ~ to 80Mbps.
  • Page 96 VIVOTEK VIVOTEK Fixed quality: On the other hand, if Fixed quality is selected, all frames are transmitted with the same quality; bandwidth utilization is therefore unpredictable. The video quality can be adjusted to the following settings: Medium, Standard, Good, Detailed, and Excellent. You can also select Customize and manually enter a value.
  • Page 97 VIVOTEK JPEG If the mode is selected, the Network Camera sends consecutive JPEG images to the client, producing a moving effect similar to a filmstrip. Every single JPEG image transmitted guarantees the same image quality, which in turn comes at the expense of variable bandwidth usage. Because the media contents are a combination of JPEG images, no audio data is transmitted to the client.

  • Page 98: Media > Audio

    VIVOTEK VIVOTEK Media > Audio Audio Settings Mute: Select this option to disable audio transmission from the Network Camera to all clients. Note that if muted, no audio data will be transmitted even if audio transmission is enabled on the Client Settings page.
  • Page 99 VIVOTEK Audio clips ■ Output gain: Use the slide bar to change the audio output gains value. ■ Audio clip: When the camera's audio input is connected to a microphone, you can record a short period of audio recordings (1 to 10 seconds). You can also use the camera's embedded microphone to record an audio clip, if available.

  • Page 100: Media Profiles

    VIVOTEK VIVOTEK Media profiles You can configure a different video stream for each of the 3 default profiles, Max. view, Recording, Live view, and App. The related video stream information will display, including stream number, resolution, codec used, frame rate, etc. The Multicast port number, and address for video, audio, and Metadata configuration will also be listed.

  • Page 101: Network > General Settings

    VIVOTEK Network > General settings This section explains how to configure a wired network connection for the Network Camera. Network Type Select this option when the Network Camera is deployed on a local area network (LAN) and is intended to be accessed by local computers. The default setting for the Network Type is LAN. Please remember to click on the Save button when you complete the Network setting.
  • Page 102 VIVOTEK VIVOTEK Primary DNS: The primary domain name server that translates hostnames into IP addresses. Secondary DNS: Secondary domain name server that backups the Primary DNS. Primary WINS server: The primary WINS server that maintains the database of computer names and IP addresses.
  • Page 103 VIVOTEK NOTE: ► If the default ports are already used by other devices connected to the same router, the Network Camera will select other ports for the Network Camera. ► If UPnP is not supported by your router, you will see the following message: Error: Router does not support UPnP port forwarding.
  • Page 104 VIVOTEK VIVOTEK 4. In the Networking Services dialog box, select Universal Plug and Play and click OK. 5. Click Next in the following window. 6. Click Finish. UPnP is enabled. ► How does UPnP work? UPnP networking technology provides automatic IP configuration and dynamic discovery of devices added to a network.
  • Page 105 VIVOTEK Enable IPv6 Select this option and click Save to enable IPv6 settings. Please note that this only works if your network environment and hardware equipment support IPv6. The browser should be Microsoft Internet Explorer 6.5, Mozilla Firefox 3.0 or above. ®...
  • Page 106 VIVOTEK VIVOTEK Please follow the steps below to link to an IPv6 address: 1. Open your web browser. 2. Enter the link-global or link-local IPv6 address in the address bar of your web browser. 3. The format should be: IPv6 address 4.

  • Page 107: Network > Streaming Protocols

    VIVOTEK Network > Streaming protocols NOTE: The metadata information can only be transmitted through the HTTP main port. Metadata is not available through the secondary HTTP port. HTTP streaming To utilize HTTP authentication, make sure that your have set a password for the Network Camera first; please refer to Security >...
  • Page 108 VIVOTEK VIVOTEK URL command -- http://<ip address>:<http port>/<access name for stream 1, 2, 3> For example, when the Access name for stream 2 is set to video1s2.mjpg: 1. Launch Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter. 3.
  • Page 109 VIVOTEK Authentication: Depending on your network security requirements, the Network Camera provides three types of security settings for streaming via RTSP protocol: disable, basic, and digest. basic authentication is selected, the password is sent in plain text format, but there can be potential risks of it being intercepted.
  • Page 110 VIVOTEK VIVOTEK RTSP port /RTP port for video, audio/ RTCP port for video, audio ■ RTSP (Real-Time Streaming Protocol) controls the delivery of streaming media. By default, the port number is set to 554. ■ The RTP (Real-time Transport Protocol) is used to deliver video and audio data to the clients. By default, the RTP port for video is set to 5556 and the RTP port for audio is set to 5558.
  • Page 111 VIVOTEK Unicast video transmission delivers a stream through point-to-point transmission; multicast, on the other hand, sends a stream to the multicast group address and allows multiple clients to acquire the stream at the same time by requesting a copy from the multicast group address. Therefore, enabling multicast can effectively save Internet bandwidth.
  • Page 112 VIVOTEK VIVOTEK SIP is short for Session Initiation Protocol. If necessary, you can change the default port number, 5060, to one between 1025 and 65535. Two way audio port: The Network Camera supports two way audio communication so that operators can transmit and receive audio simultaneously.

  • Page 113: Network > Ddns

    VIVOTEK Network > DDNS This section explains how to configure the dynamic domain name service for the Network Camera. DDNS is a service that allows your Network Camera, especially when assigned with a dynamic IP address, to have a fixed host and domain name. Manual setup DDNS: Dynamic domain name service Enable DDNS: Select this option to enable the DDNS setting.
  • Page 114 VIVOTEK VIVOTEK 3. Click Copy and all the registered information will automatically be uploaded to the corresponding fields in the DDNS column at the top of the page as seen in the picture. [Register] Successfully Your account information has been mailed to registered e-mail address 4.

  • Page 115: Network > Qos (Quality Of Service)

    VIVOTEK Network > QoS (Quality of Service) Quality of Service refers to a resource reservation control mechanism, which guarantees a certain quality to different services on the network. Quality of service guarantees are important if the network capacity is insufficient, especially for real-time streaming multimedia applications. Quality can be defined as, for instance, a maintained level of bit rate, low latency, no packet dropping, etc.
  • Page 116 VIVOTEK QoS/DSCP (the DiffServ model) DSCP-ECN defines QoS at Layer 3 (Network Layer). The Differentiated Services (DiffServ) model is based on packet marking and router queuing disciplines. The marking is done by adding a field to the IP header, called the DSCP (Differentiated Services Codepoint). This is a 6-bit field that provides 64 different class IDs.
  • Page 117 VIVOTEK Network > SNMP (Simple Network Management Protocol) This section explains how to use the SNMP on the network camera. The Simple Network Management Protocol is an application layer protocol that facilitates the exchange of management information between network devices. It helps network administrators to remotely manage network devices and find, solve network problems with ease.

  • Page 118: Network > Ftp

    VIVOTEK Network > FTP The newer firmware disabled the FTP port for security concerns. You can manually enable the FTP server service to enable the FTP function. You can disable the FTP server function when it is not in use. FTP port: The FTP server allows the user to save recorded video clips.

  • Page 119: Bonjour

    VIVOTEK Bonjour To access the camera from a Mac computer, go to Safari, click on Bonjour and select the camera from a drop-down list. You can go to Safari > Preferences to enter your user name and password, and provide the root password the first time you access the camera.

  • Page 120: Security > User Accounts

    VIVOTEK Security > User accounts This section explains how to enable password protection and create multiple accounts. Account management Tips: Follow the tips for creating a password (as shown in the above highlighted orange box) for better security. The administrator account name is “root”, which is permanent and can not be deleted. If you want to add more accounts in the Account management window, please apply the password for the “root”...
  • Page 121 VIVOTEK Access rights are sorted by user privilege (Administrator, Operator, and Viewer). Only administrators can access the Configuration page. Although operators cannot access the Configuration page, they can use the URL Commands to get and set the value of parameters. For more information, please refer to URL Commands of the Network Camera on page 161.
  • Page 122 VIVOTEK Account block Here you can control the security degree such as defining the number of login fails before blocking the user to log in. Security > HTTPS (Hypertext Transfer Protocol over SSL) This section explains how to enable authentication and encrypted communication over SSL (Secure Socket Layer).
  • Page 123 VIVOTEK 4. The Certificate Information will automatically be displayed as shown below. You can click Certificate properties to view detailed information about the certificate. 5. Click Save to preserve your configuration, and your current session with the camera will change to the encrypted connection.
  • Page 124 VIVOTEK Create certificate request and install 1. Select the option from the Method pull-down menu. 2. Click Create certificate to proceed. 3. The following information will show up in a pop-up window after clicking Create. Then click Save to generate the certificate request. 4.
  • Page 125 VIVOTEK 5. Look for a trusted certificate authority, such as Symantec’s VeriSign Authentication Services, that issues digital certificates. Sign in and purchase the SSL certification service. Copy the certificate request from your request prompt and paste it in the CA’s signing request window. Proceed with the rest of the process as CA’s instructions on their webpage.
  • Page 126 VIVOTEK 7. Open a new edit, paste the certificate contents, and press ENTER at the end of the contents to add an empty line. 8. Convert file format from DOS to UNIX. Open File menu > Conversions > DOS to Unix. 124 - User's Manual...
  • Page 127 VIVOTEK 9. Save the edit using the “.crt” extension, using a file name like “CAcert.crt.” 10. Return to the original firmware session, use the Browse button to locate the crt certificate file, and click Upload to enable the certification. User's Manual - 125...
  • Page 128 VIVOTEK Note 11. When the certificate file is successfully loaded, its status will be stated as Active. that a certificate must have been created and installed before you can click on the “Save" button for the configuration to take effect. To begin an encrypted HTTPS session, click Home to return to the main page.

  • Page 129: Security > Access List

    VIVOTEK Security > Access List This section explains how to control access permission by verifying the client PC’s IP address. General Settings Maximum number of concurrent streaming connection(s) limited to: Simultaneous live viewing for 1~10 clients (including stream 1 to stream 3). The default value is 10. If you modify the value and click Save, all current connections will be disconnected and automatically attempt to re-link (IE Explorer or Quick Time Player).
  • Page 130 VIVOTEK ■ Refresh: Click this button to refresh all current connections. ■ Add to deny list: You can select entries from the Connection Status list and add them to the Deny List to deny access. Please note that those checked connections will only be disconnected temporarily and will automatically try to re-link again (IE Explore or Quick Time Player).
  • Page 131 VIVOTEK There are three types of rules: Single: This rule allows the user to add an IP address to the Allowed/Denied list. For example: 192.168.2.1 Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List.

  • Page 132: Security > Ieee 802.1X

    VIVOTEK Security > IEEE 802.1X Enable this function if your network environment uses IEEE 802.1x, which is a port-based network access control. The network devices, intermediary switch/access point/hub, and RADIUS server must support and enable 802.1x settings. The 802.1x standard is designed to enhance the security of local area networks, which provides authentication to network devices (clients) attached to a network port (wired or wireless).
  • Page 133 VIVOTEK 3. When all settings are complete, move the Network Camera to the protected LAN by connecting it to an 802.1x enabled switch. The devices will then start the authentication automatically. NOTE: ► The authentication process for 802.1x: 1. The Certificate Authority (CA) provides the required signed certificates to the Network Camera (the supplicant) and the RADIUS Server (the authentication server).

  • Page 134: Security > Miscellaneous

    VIVOTEK Security > Miscellaneous The embedded TrendMicro utility provides the protection against Cross-Site Request Forgery. Cross-site request forgery is also known as one-click attack or session riding and is abbreviated as CSRF. CSRF is a type of malicious exploit of a website, in this case, the camera.

  • Page 135: Ptz > Ptz Settings

    VIVOTEK PTZ > PTZ settings This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation. Digital: Control the e-PTZ operation. Within a field of view, it allows users to quickly move the focus to a target area for close-up viewing without physically moving the camera. Digital PTZ Operation (E-PTZ Operation) The e-PTZ control settings section will be displayed as shown below: 2019/05/20 09:57:30...
  • Page 136 VIVOTEK Home page in the E-PTZ Mode ■ The e-Preset Positions will also be displayed on the home page. Select one from the drop-down list, and the Network Camera will move to the selected position. ■ If you have set up different preset positions for different streams, you can select one of the video streams to display its separate preset positions.
  • Page 137 VIVOTEK Patrol settings You can select some preset positions for the Network Camera to patrol. Please follow the steps below to set up a patrol schedule: 1. Select the preset locations on the list, and click 2. The selected preset locations will be displayed on the Patrol locations list. 3.

  • Page 138: Event > Event Settings

    VIVOTEK NOTE: • The Preset Positions will also be displayed on the Home page. Select one from the Go to menu, and the Network Camera will move to the selected preset position. • Click Patrol: The Network Camera will patrol along the selected positions repeatedly. Event >...
  • Page 139 VIVOTEK ■ Event name: Enter a name for the event setting. ■ Enable this event: Select this checkbox to enable the event setting. ■ Priority: Select the relative importance of this event (High, Normal, or Low). Events with a higher priority setting will be executed first.
  • Page 140 VIVOTEK ■ Periodically This option allows the Network Camera to trigger periodically for every other defined minute. Up to 999 minutes are allowed. ■ Digital input This option allows the Network Camera to use an external digital input device or sensor as a trigger source.
  • Page 141 VIVOTEK Click on the Set VADP Trigger button to open the VADP setup menu. The triggering conditions available with 3rd-party software modules known as VADP will be listed. Use the arrow buttons to select these triggers. Users may implant these modules for different purposes such as triggering motion detection, or applications related to video analysis, etc.
  • Page 142 VIVOTEK ■ Backup media if the network is disconnected Select this option to backup media file on SD card if the network is disconnected. This function will only be displayed after you set up a network storage (NAS). The media to back up can include snapshot images, video, or system logs depending on your event settings.
  • Page 143 VIVOTEK There are four choices of server types available: Email, FTP, HTTP, and Network storage. Select the item to display the detailed configuration options. You can configure either one or all of them. Server type - Email Select to send the media files via email when a trigger is activated. ■...
  • Page 144 VIVOTEK Server type - FTP Select to send the media files to an FTP server when a trigger is activated. ■ Server name: Enter a name for the server setting. ■ Server address: Enter the domain name or IP address of the FTP server. ■...
  • Page 145 VIVOTEK Server type - SFTP Select to send the media files to an SFTP (Secure File Transfer Protocol) server when a trigger is activated. This page contains the client side settings. ■ Server address: Enter the SFTP server address in either the domain name or IP address. ■...
  • Page 146 VIVOTEK ■ Login mode Select a Login mode as either the Password or the Public key mode. When using SFTP, you can authenticate using a public/private SSH key pair instead of a password. If key authentication is not enabled, you need to specify a password instead. The administrator of the SFTP server will need to manually add the corresponding public key to the SFTP server.
  • Page 147 VIVOTEK Public key mode: Selecting the Public key mode will bring up the Pairing mode options: Auto, Download, Upload. Auto Camera will generate a key pair and auto pair public key with the SFTP server. Download Camera will generate a key pair and download the public key for the user to upload it to the SFTP server.
  • Page 148 VIVOTEK Server type - HTTP Select to send the media files to an HTTP server when a trigger is activated. ■ Server name: Enter a name for the server setting. ■ URL: Enter the URL of the HTTP server. ■ User name: Enter the user name if necessary. ■...
  • Page 149 VIVOTEK Network storage: Select to send the media files to a networked storage when a trigger is activated. Please refer to NAS server on page 169 for details. Note that only one NAS server can be configured. Click Save server to enable the settings. ■...
  • Page 150 VIVOTEK Click 20190120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2019/01/20 2019/01/20 Click to go back to the previous Click to delete level of the directory selected items Click to delete all recorded data 2019/01/20 2019/01/20...
  • Page 151 VIVOTEK Add media Add media Click to open the media setting window. You can specify the type of media that will be sent when a trigger is activated. A total of 5 media settings can be configured. There are three choices of media types available: Snapshot, Video Clip, and System log.
  • Page 152 VIVOTEK ■ Add date and time suffix to the file name Select this option to add a date/time suffix to the file name. For example: Snapshot_20190513_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings. Note that after you set up the first media server, a new column for media server will automatically display on the Media list.
  • Page 153 VIVOTEK ■ Maximum file size Specify the maximum file size allowed. Some users may need to stitch the video clips together when searching and packing up forensic evidence. ■ File name prefix Enter the text that will be appended to the front of the file name. For example: Video_20190513_100341 File name prefix...
  • Page 154 VIVOTEK In the Event settings column, the Servers and Medias you configured will be listed; please make sure the Event -> Status is indicated as ON, in order to enable the event triggering action. When completed, click the Save event button to enable the settings and click Close to exit Event Settings page.
  • Page 155 VIVOTEK Customized Script This function allows you to upload a sample script (.xml file) to the camera, which will save your time on configuring the settings. Please note that there is a limited number of customized scripts you can upload; if the current amount of customized scripts has reached the limit, an alert message will prompt.

  • Page 156: Applications > Motion Detection

    VIVOTEK Applications > Motion detection The camera comes with a Smart Motion Detection utility as its pre-loaded VCA package. Please refer to its User Guide for more information: http://download.vivotek.com/downloadfile/solutions/vadp/smart-motion-detection-manual_ en.pdf. Click on Configuration > Applications > Motion detection. The Smart Motion utility will be automatically started.

  • Page 157: Applications > Smart Vca

    VIVOTEK Applications > Smart VCA Smart VCA provides the following features: Intrusion detection, Loitering detection, Missing object detection, Unattended Object detection, Line Crossing detection, and Face detection. Please refer to Smart VCA’s user documentation for more information. Click on Configuration > Applications > Smart VCA. The Smart VCA utility will be automatically started.

  • Page 158: Applications > Di And Do

    VIVOTEK Applications > DI and DO Digital input: Select High or Low as the Normal status for the digital input connection. Connect the digital input pin of the Network Camera to an external device to detect the current connection status. Digital output: Select Grounded or Open to define the normal status for the digital output.

  • Page 159: Applications > Tampering Detection

    VIVOTEK Applications > Tampering detection This section explains how to set up camera tamper detection. With tamper detection, the camera is capable of detecting incidents such as redirection, blocking or defocusing, or even spray paint. Please follow the steps below to set up the camera tamper detection function: 1.

  • Page 160: Applications > Audio Detection

    VIVOTEK Applications > Audio detection Audio detection, along with video motion detection, is applicable in the following scenarios: 1. Detection of activities not covered by camera view, e.g., a loud input by gun shots or breaking a door/window. 2. A usually noisy environment, such as a factory, suddenly becomes quiet due to a breakdown of machines.
  • Page 161 VIVOTEK You can use the Profile window to configure a different Audio detection setting. For example, a place can be noisy in the day time and become very quiet in the night. 1. Click on the Enable this profile checkbox. Once the Audio detection window is opened, the current sound input will be interactively indicated by a fluctuating yellow wave diagram.

  • Page 162: Applications > Shock Detection

    VIVOTEK Applications > Shock detection The camera comes with a shock accelerometer. The shock sensor can detect impacts to the camera. For example, when a person deliberately tries to destroy the camera, the camera can report the event to the administrator. Normally, a 5kgm impact can cause the detected impact level to surge to 50% on the scale.

  • Page 163: Applications > Package Management - A.k.a., Vadp

    VIVOTEK Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) The camera comes embedded with the Smart Motion Detection feature. The Smart Motion detection, with Human detection and tunable time filter, can eliminate the defects of traditional motion detection and facilitate the configuration at a surveillance site. To learn more about this feature, download its User Guide in: http://download.vivotek.com/downloadfile/solutions/vadp/smart-motion-detection-manual_ en.pdf...
  • Page 164 VIVOTEK • Users can also run VIVOTEK's VADP packages as a means to access updated functionality instead of replacing the entire firmware. • Note that for some cameras the flash is too small to hold VADP packages. These cameras will have its "Save to SD card" checkbox selected and grayed-out for all time. •...
  • Page 165 VIVOTEK To utilize a software module, acquire the software package and click Browse and Upload buttons. To start a module, select the checkcircle in front, and click the Start button. If you should need to remove a module, select the checkcircle in front and then click the Stop button.
  • Page 166 VIVOTEK On the License page, register and activate the license for using VIVOTEK's VADP modules. You should acquire the license key elsewhere, and manually upload to the network camera. Follow the onscreen instruction on VIVOTEK's website for the registration procedure. 164 - User's Manual...

  • Page 167: Recording > Recording Settings

    VIVOTEK Recording > Recording settings This section explains how to configure the recording settings for the Network Camera. Recording Settings Insert your SD card and click here to test NOTE: ► Please remember to format your SD card via the camera’s web console (in the Local storage . SD card management page) when using it for the first time.
  • Page 168 VIVOTEK If you enable adaptive recording on a camera, only when an event is triggered on Camera A will the server record the full frame rate streaming data; otherwise, it will only request the I frame data during normal monitoring, thus effectively saves bandwidths and storage space. NOTE: ►...
  • Page 169 VIVOTEK 2. Destination You can select the SD card or network storage (NAS) for the recorded video files. If you have not configured a NAS share, see details in the following. NAS server Click Add NAS server to open the server setting window and follow the steps below to set up: 1.
  • Page 170 VIVOTEK If successful, you will receive a test.txt file on the networked storage. 3. Enter a server name. 4. Click Save to complete the settings and click Close to exit the page. ■ Capacity: You can choose either the entire free space available or limit the reserved space. The recording size limit must be larger than the reserved amount for cyclic recording.
  • Page 171 VIVOTEK f you want to enable recording notification, please click to configure event triggering settings. Event Please refer to Event > Event settings on page 139 for more details. When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page.

  • Page 172: Storage

    VIVOTEK Storage NOTE: • It is recommended to turn OFF the recording activity before you remove an SD card from the camera. • The lifespan of an SD card is limited. Regular replacement of the SD card can be necessary. •...

  • Page 173: Storage > Nas Management

    VIVOTEK SD card control ■ Enable cyclic storage: Check this item if you want to enable cyclic recording. When the maximum capacity is reached, the oldest file will be overwritten by the latest one. ■ Enable automatic disk cleanup: Check this item and enter the number of days you wish to retain a file. For example, if you enter “7 days”, the recorded files will be stored on the SD card for 7 days.
  • Page 174 VIVOTEK 2. Click Test to check the setting. The result will be shown in the pop-up window. If successful, you will receive a test.txt file on the networked storage server. 3. Click Mount to complete the settings. NAS management ■ Minimum reserved storage space: The reserved space can be used as a safe buffer especially when the cyclic recording function is enabled, during the transaction stage when a storage space is full and the incoming streaming data is about to overwrite the previously saved videos.

  • Page 175: Storage > Content Management

    VIVOTEK Storage > Content management This section explains how to manage the content of recorded videos on the Network Camera. Here you can search and view the records and view the searched results. Searching and Viewing the Records This column allows the user to set up search criteria for recorded data. If you do not select any criteria and click Search button, all recorded data will be listed in the Search Results column.
  • Page 176 VIVOTEK Search Results The following is an example of search results. There are four columns: Trigger time, Media type, Trigger type, and Locked. Click to sort the search results in either direction. Numbers of entries displayed on one page Click to open a live view ■...
  • Page 177 VIVOTEK ■ Lock/Unlock: Select the checkbox in front of a desired search result, then click this button. The selected items will become Locked, which will not be deleted during cyclic recording. You can click again to unlock the selections. For example: Click to switch pages ■...

  • Page 178: Appendix

    VIVOTEK Appendix URL Commands for the Network Camera 1. Overview For some customers who already have their own web site or web control application, the Network Camera/Video Server can be easily integrated through URL syntax. This section specifies the external HTTP-based application programming interface.

  • Page 179: Style Convention

    VIVOTEK 2. Style Convention In URL syntax and in descriptions of CGI parameters, a text within angle brackets denotes a content that is to be replaced with either a value or a string. When replacing the text string, the angle brackets shall also be replaced.

  • Page 180: General Cgi Url Syntax And Parameters

    VIVOTEK 3. General CGI URL Syntax and Parameters CGI parameters are written in lower-case and as one word without any underscores or other separators. When the CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server. The CGIs are organized in functionally-related directories under the cgi-bin directory.

  • Page 181: Security Level

    VIVOTEK 4. Security Level SECURITY LEVEL SUB-DIRECTORY DESCRIPTION anonymous Unprotected. 1 [view] viewer Can view, listen, and talk to camera. 4 [operator] operator Operator access rights can modify most of the camera’s parameters except some privileges and network options. 6 [admin] admin Administrator access rights can fully control the camera’s operations.

  • Page 182: Get Server Parameter Values

    VIVOTEK 5. Get Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/viewer/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/operator/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/admin/getparam.cgi?[<parameter>] [&<parameter>…] Where the <parameter> should be <group>[_<name>] or <group>[.<name>]. If you do not specify any parameters, all the parameters on the server will be returned. If you specify only <group>, the parameters oftherelated group will be returned.
  • Page 183 VIVOTEK http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context- Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n 181 - User's Manual...

  • Page 184: Set Server Parameter Values

    VIVOTEK 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/operator/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/admin/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] PARAMETER DESCRIPTION <parameter> A full path like: "videoin_c0_s0_h264_resolution", "videoin_c0_s0_h264_maxframe", etc.
  • Page 185 VIVOTEK [<parameter pair>] Only the parameters that you set and are readable will be returned. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi- bin/admin/setparam.cgi?network_ipaddress=192.168.0.123 Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context- Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n 183 - User's Manual...

  • Page 186: Available Parameters On The Server

    VIVOTEK 7. Available Parameters on the Server Valid values: VALID VALUES DESCRIPTION string[<n>] Text strings shorter than ‘n’ characters. The characters “,’,<,>,& are invalid. string[n~m] Text strings longer than `n’ characters and shorter than `m’ characters. The characters “,’,<,>,& are invalid. password[<n>] The same as string but displays‘*’...

  • Page 187: System

    VIVOTEK VALID VALUES DESCRIPTION <WxH> The format for resolution. W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 available The API is listed in product WebAPIs. non-available The API is not in product WebAPIs. valid The API is listed in product WebAPIs, and is functional.
  • Page 188 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) <blank> timezoneindex -489 ~ 529 Indicate timezone and area. <Not recommended to -440: GMT-11:00 Midway Island, Samoa use this> -400: GMT-10:00 Hawaii -360: GMT-09:00 Alaska -320: GMT-08:00 Las Vegas, San Francisco, Vancouver -280: GMT-07:00 Mountain Time, Denver -281: GMT-07:00 Arizona -240: GMT-06:00 Central America, Central Time...
  • Page 189 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) 82: GMT 02:00 Lebanon 83: GMT 02:00 120: GMT 03:00 Baghdad, Kuwait, Riyadh, Nairobi 121: GMT 03:00 Iraq, Minsk 140: GMT 03:30 Tehran 160: GMT 04:00 Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan, Moscow, St. Petersburg 180: GMT 04:30 Kabul 200: GMT 05:00 Islamabad, Karachi,...
  • Page 190 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) * We replace this parameter with “system_tz” when the version number (httpversion) is equal or greater than 0314b. daylight_enable <boolean> Enable automaticdaylight saving time in time zone. daylight_auto_begintim string[19] Display the current daylight saving start time.
  • Page 191 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) restoreexceptnet Restore the system parameters to default <positive values except (ipaddress, subnet, router, integer> dns1, dns2, pppoe). This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.

  • Page 192: System.info

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) restoreexceptfocusvalu Restore the system parameters to default <positive values except zoom and focus value. integer> This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.

  • Page 193: Status

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) serialnumber <mac address> 12 characters MAC address (without hyphens). firmwareversion string[40] Firmware version, including model, company, and version number in the format:<MODEL-BRAND-VERSION> language_count <positive Number of webpage languages available integer> on the server. language_i<0~(count- string[16] Available language lists.
  • Page 194 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) di_i<0~(k-1)> <boolean> 0 => Inactive, normal <product dependent> 1 => Active, triggered (capability_ndi > 0) k is determined by the below criterion: The following applies for capability_extension_di_num >= 0 * if extension_connected=1, k=capability_ndi * if extension_connected=0, k=capability_ndi+ capability_extension_di_num Otherwise,...

  • Page 195: Status Per Channel

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) integer> eth_i0 <string> Get network information from mii-tool. vi_i<0~(capability_nvi-1)> <boolean> Virtual input <product dependent> 0 => Inactive 1 => Active (capability_nvi > 0) 7.2.1 Status per Channel Group: status_c<0~(n‐1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY...

  • Page 196: Digital Output Behavior Define

    VIVOTEK 7.4 Digital Output Behavior Define Group: do_i<0~(k‐1)> for k is the value of "capability_ndo" (capability_ndo > 0) k is determined by the below criterion: The following applies for capability_extension_do_num >= 0 * if extension_connected=1, k=capability_ndo * if extension_connected=0, k=capability_ndo+ capability_extension_do_num Otherwise, * k=capability_ndo NAME...

  • Page 197: Network

    VIVOTEK 7.6 Network Group: network NAME VALUE SECURITY DESCRIPTION (get/set) preprocess <positive integer> An 32-bit integer, each bit can be set separately as follows: Bit 0 => HTTP service; Bit 1=> HTTPS service; Bit 2=> FTP service; Bit 3 => Two way audio and RTSP Streaming service;...

  • Page 198: 196

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) 0 => Use preset ipaddress, subnet, rounter, dns1, and dns2. ipaddress <ip address> IP address of server. subnet <ip address> Subnet mask. router <ip address> Default gateway. dns1 <ip address> Primary DNS server. dns2 <ip address>...

  • Page 199: Qos

    VIVOTEK 7.6.2 QOS Subgroup of network: qos_cos (capability_protocol_qos_cos > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable CoS (IEEE 802.1p) vlanid 1~4095 VLAN ID video Video channel for CoS audio Audio channel for CoS <product dependent> (capability_naudioin > 0) eventalarm Event/alarm channel for CoS management...

  • Page 200: Ftp

    VIVOTEK 7.6.4 FTP Subgroup of network: ftp NAME VALUE SECURITY DESCRIPTION (get/set) port 21, 1025~65535 Local ftp server port. enable <boolean> Enable ftp. 7.6.5 HTTP Subgroup of network: http NAME VALUE SECURITY DESCRIPTION (get/set) port 80, 1025 ~ HTTP port. 65535 alternateport 1025~65535...

  • Page 201: Http Per Channel

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) accessname " when the version number (httpversion) is equal or greater than 0311c. 7.6.6 HTTP per Channel Subgroup of network: http_c<0~(n‐1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) s<0~(capability_nmedia...

  • Page 202: Rtsp

    VIVOTEK 65535 7.6.8 RTSP Subgroup of network: rtsp (capability_protocol_rtsp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 554, 1025 ~ 65535 RTSP port. (capability_protocol_rtsp=1) authmode disable, RTSP authentication mode. basic, (capability_protocol_rtsp=1) digest s<0~(capability_nmed string[32] RTSP access name for channel and iastream*capability_n stream.

  • Page 203: Rtsp Multicast

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) live1s1.sdp = c0_s0_accessname, (channel1stream1) live1s2.sdp = c0_s1_accessname, (channel1stream2) live1s3.sdp = c0_s2_accessname, (channel1stream3) live1s4.sdp = c0_s3_accessname, (channel1stream4) etc. * Values start with prefix “cgi-bin” are prohibited. For example, “c, cg, cgi, cgi-, cgi-b, cgi-bi, cgi-bin” are not allowed.

  • Page 204: Sip Port

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) * Reserved for compatibility, and suggest don't use this since [httpversion] > 0304a videoipaddress <ip Multicast video IP address. address> * We support this parameter when the version number (httpversion) is equal or greater than 0304a.

  • Page 205: Pppoe

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) videoport 1025 ~ 65535 Video channel port for RTP. audioport 1025 ~ 65535 Audio channel port for RTP. metadataport 1025 ~ 65535 Metadata channel port for RTP. 7.6.12 PPPoE Subgroup of network: pppoe (capability_protocol_pppoe > 0) NAME VALUE SECURITY...

  • Page 206: Ip Filter

    VIVOTEK 7.7 IP Filter Group: ipfilter NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable access list filtering. admin_enable <boolean> Enable administrator IP address. admin_ip string[43] Administrator IP address. maxconnection Maximum number of (s). "capability_protoc ol_maxconnection" type 0, 1 Ipfilter policy : 0 =>...
  • Page 207 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) after the version number (httpversion) is equal or greater than 0400a. whitebalance auto, Modes of white balance. "auto": Auto white balance <product dependent> panorama, manual, "panorama": indicates that camera rbgain, would try to balance the white widerange, balance effect of every sensor.
  • Page 208 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) The definition is: 0: EV -2.0 1: EV -1.7 2: EV -1.3 3: EV -1.0 4: EV -0.7 5: EV -0.3 6: EV 0 7: EV +0.3 8: EV +0.7 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.0 * Only available when...
  • Page 209 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) after the version number (httpversion) is equal or greater than 0400a. enableblc <boolean> Enable backlight compensation. <Not support * Not support this parameter anymore> anymore when the version number (httpversion) is equal or greater than 0301a.
  • Page 210 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) n"=1 * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. ptzstatus 0,<positive A 32-bit integer, each bit can be set <Not support integer>...
  • Page 211 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) is equal or greater than 0400a. minexposure <1~32000>, Minimum exposure time <product dependent> <5~32000>, 1~32000 => 1s ~ 1/32000s <1~8000>, 5~32000 => 1/5s ~ 1/32000s 1~8000 => 1s ~ 1/8000s <5~8000>, etc. 5~8000 => 1/5s ~ 1/8000s etc.

  • Page 212: Video Input Setting Per Channel

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) re_maxrange" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
  • Page 213 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) "auto": Auto white balance <product panorama, dependent> manual, "panorama": indicates that camera rbgain, would try to balance the white widerange, balance effect of every sensor. outdoor, "rbgain": Use rgain and bgain to set indoor, white balance manually.
  • Page 214 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) bgain 0~100 Manual set bgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c<0~(n- 1)>_wbmo de". * Only valid when "videoin_c<0~(n- 1)>_whitebalance" ! = auto * Normalized range.
  • Page 215 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) with variable Shutter Speed, and keep adjusting Iris, Gain automatically. (Available options are list "irispriority": Manually adjust with variable Iris, and keep adjusting Gain "capability_image_c<0~(n- and Shutter speed automatically. 1)>_exposure_modetype") "qualitypriority": Automatically adjust the Iris, Gain and Shutter Speed by VIVOTEK quality algorithm.
  • Page 216 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) "‐": not support. (only available when "capability_image_c<0~(n-1)>_sensor type" is "smartsensor") Only available when "capability_image_c<0~(n-1)>_iristype "=piris piris_position 1~100 Manual set P-Iris. <product 1: Open <-> 100: Close dependent> * Only valid when "piris_mode"=manual or "capability_image_c<0~(n-1)>_sensor type"...
  • Page 217 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_mi ngain" != "-" * Only valid when "piris_mode"=manual "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". gainvalue 0~100 Gain value. 0: Low <->...
  • Page 218 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) function; 0(not support), 1(support) Bit 1 =>Built‐in or external camera; 0 (external), 1(built-in) Bit 2 => Support pan operation; 0(not support), 1(support) Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 =>...
  • Page 219 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) "capability_image_c<0~(n-1)>_exposu "capability_image_c<0~(n- re_minrange" != "-" 1)>_exposure_minrange" * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". maxexposure <1~32000>, Maximum exposure time <product <5~32000>, 1~32000 => 1s ~ 1/32000s dependent> <1~8000>, 5~32000 =>...
  • Page 220 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) * Available value is listed * This parameter may also restrict image frame rate from sensor due to "capability_image_c<0~(n- sensor generates a frame per 1)>_exposure_maxrange" exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.
  • Page 221 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) zoomratiodispl <boolean> Indicates multiple of zoom in is “on- screen display” or not. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. bracketing_lev 1~100 The total available lists ...
  • Page 222 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) n-1)>_maxresolution" and "capability_videoin_c<0~( n-1)>_minresolution" s<0~(m-1)>_s <boolean> Enable "Smart fps" function. martfps_enabl * Only available when "capability_videoin_c<0~(n-1)>_smart fps_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. s<0~(m-1)>_h2 <boolean>...
  • Page 223 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) library directly. * Only valid when "h264_ratecontrolmode"= vbr and s<0~(m-1)>_h264_quant = 99. s<0~(m-1)>_h2 1~100 Select customized quality in a 64_qpercent normalized full range. 1: Worst quality 100: Best quality * Only valid when "h264_ratecontrolmode"= vbr and "quant"= 100.
  • Page 224 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) 64_bitrate _c<0~(n-1)>_h264_maxbit mode. rate" * Only valid when "h264_ratecontrolmode"= cbr s<0~(m-1)>_h2 framerate,imagequality Set prioritypolicy 64_prioritypoli * Only valid when "h264_ratecontrolmode"= cbr s<0~(m-1)>_h2 1~"capability_videoin_c<0 The maximum frame rates of a H264 64_maxframe ~(n-1)>_h264_maxframera stream at different te"...
  • Page 225 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) 65_intraperiod 3000, 4000 I-frames (Intra coded picture). The unit is millisecond (ms). * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_h2 cbr, vbr cbr: Constant bit rate mode. 65_ratecontrol vbr: Fixed quality mode, all frames are mode encoded in the same quality.
  • Page 226 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) * Only valid when "h265_ratecontrolmode"= vbr and "quant"= 100. s<0~(m-1)>_h2 20000~"capability_videoin The maximum allowed bit rate in fixed 65_maxvbrbitr _c<0~(n-1)>_h265_maxbit quality mode. rate" When the bit rate exceeds this value, frames will be dropped to restrict the bit rate.
  • Page 227 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) rate" * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "h265_ratecontrolmode"= cbr s<0~(m-1)>_h2 framerate,imagequality Set prioritypolicy 65_prioritypoli * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "h265_ratecontrolmode"= cbr 1~"capability_videoin_c<0 s<0~(m-1)>_h2...
  • Page 228 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) Set the pre-defined quality level: 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue" s<0~(m-1)>_mj 10~200 Manual video quality level input. The peg_qvalue (Only valid when Q value which is used by encoded...
  • Page 229 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) s<0~(m-1)>_mj 1~5, 100 Set the pre-defined quality level: peg_cbr_quant 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only valid when "mjpeg_ratecontrolmode"= cbr. s<0~(m-1)>_mj 1~100 Select customized quality in a peg_cbr_qperc normalized full range.
  • Page 230 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) For NTSC: D1/4CIF(720/704x480) -> (640x480) CIF(352x240)->(320x240) * Only available when capability_videoin_type is 0 or 1. wdrpro_mode 0, 1, 2 0: Disable WDR Pro. <product 1: Enable WDR Pro. dependent> * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode"...
  • Page 231 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) aespeed_spee 1~100 The speed level of AE converge speed. dlevel 1~20: level 1 <product 21~40: level 2 dependent> 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher speed level meas shorter AE converged time during AE executing.
  • Page 232 VIVOTEK NAME VALUE SECURITY( DESCRIPTION get/set) ttype" != "-". enablewaterm 0, 1 0: Not to add watermarks on images 1: Add watermarks on images <product * Only available when dependent> "capability_fisheye" > 0 s<0~(m-2)>_fis ‘1O, 1P, 2P, 1R, 4R’ for Local dewarp mode.
  • Page 233 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) "capability_smartstream_mode_hybri d" is 1. qualitypriority -5,-4,-3,-2,-1,1,2,3,4,5 The differential value of Q between the regions of interest (ROI) and the areas of non-interest (non-ROI) of the display image. If the value is a positive number, the video quality of ROI is better than the non-ROI areas.
  • Page 234 VIVOTEK 7.8.1.1 Alternative Video Input Profiles per Channel In addition to the primary setting of video input, there can be alternative profile video input setting for each channel which might be for different scene of light (daytime or nighttime). Group: videoin_c<0~(n‐1)>_profile_i<0~(m‐1)> for n channel products and m profile n denotes the value of "capability_nvideoin"...
  • Page 235 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) dependent> <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc. 5~8000 => 1/5s ~ 1/8000s etc. * Available value is listed * This parameter may also restrict image frame rate from sensor due to "capability_image_c<0~(n- sensor generates a frame per 1)>_exposure_maxrange"...
  • Page 236 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_exposu re_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. enableblc <boolean> Enable backlight compensation. <Not support * Not support this parameter anymore> anymore when the version number (httpversion) is equal or greater than 0301a.
  • Page 237 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) qualitypriority, exposure level. manual, "shutterpriority": Manually adjust with variable Shutter Speed, and keep adjusting Iris, Gain automatically. (Available options are list "irispriority": Manually adjust with variable Iris, and keep adjusting Gain "capability_image_c<0~(n- and Shutter speed automatically. "qualitypriority": Automatically 1)>_exposure_modetype") adjust the Iris, Gain and Shutter Speed...
  • Page 238 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) "outdoor": auto white balance mode specifically for outdoor. "indoor": auto white balance mode specifically for indoor. "sodiumauto": sodium vapor lamps. * Only available when "capability_image_c<0~(n-1)>_wbmo de" !="-" rgain 0~100 Manual set rgain value of gain control setting.
  • Page 239 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) "piris_mode"=manual "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". mingain 0~100 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_mi ngain" != "-" * Only valid when "piris_mode"=manual "irismode"=fixed * Normalized range.
  • Page 240 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) 1)>_exposure_meteringm * We support this parameter when ode" the version number (httpversion) is equal or greater than 0311a. piris_mode manual, indoor, outdoor,- Control P-Iris mode. <product "outdoor": Auto-setting P-Iris to get dependent> best quality, but easy to meet rolling or flicker effect in indoor environment.
  • Page 241 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_iristype "=dciris wdrpro_mode 0, 1, 2 0: Disable WDR Pro. <product 1: Enable WDR Pro. dependent> * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode" = 1 2: Enable WDR Pro II. * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode"...

  • Page 242: Multicast Settings For Video Streaming

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) dependent> 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher speed level means shorter AE converged time during AE executing. * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1 aespeed_sensi 1~100 The sensitivity of AE converge speed.

  • Page 243: Time Shift Settings

    VIVOTEK ipaddress <ip address> Multicast video IP address. port 1025 ~ 65535 Multicast video port. ipversion IPv4, IPv6 The version of internet protocol. 1 ~ 255 Multicast video time to live value. 7.9 Time Shift Settings Group: timeshift for n channel products and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream"...
  • Page 244 VIVOTEK Group: ircutcontrol (capability_nvideoinprofile> 0 and capability_daynight_c<0~(n-1)>_support > 0) n denotes the value of "capability_nvideoin" * We do not support these parameters when "capability_nvideoin > 1" NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, Set IR cut control mode <Not day, * We replace this parameter with recommended to night,...
  • Page 245 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) is equal or greater than 0400a. daymodeendtime 00:00~23:59 Day mod end time <Not * We replace this parameter with recommended to “ircutcontrol_c<0~(n-1)>_daymodeen use this> dtime” when the version number (httpversion) is equal or greater than 0312a.
  • Page 246 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. enablewled <boolean> Enable/disable built-in White led <Not * Only available when " recommended to capability_daynight_c<0~"capability_ use this>...
  • Page 247 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) use this> capability_daynight_c<0~(n-1)>_ircuts ensitivity_type=options "1~100": if capability_daynight_c<0~(n- 1)>_ircuts ensitivity_type=normalize * Only available when "capability_daynight_c<0~(n-1)> _ircutsensitivity_type" is not "-". * We replace this parameter with ircutcontrol_c<0~(n-1)>_sensitivity” when the version number (httpversion) is equal or greater than 0312a.

  • Page 248: Ir Cut Control Setting Per Channel

    VIVOTEK 7.10.1 IR cut control setting per channel Group: ircutcontrol_c<0~(n‐1)> for n channel products (capability_daynight_c<0~(n‐1)>_support > 0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, Set IR cut control mode day, * We support this parameter when the version number (httpversion) is equal or night, greater than 0312a.

  • Page 249: Ir Cut Control Illuminators

    VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0312a. sensitivity low,normal,high,1 Sensitivity of day/night control. ~100 There are two value format: "low,normal,high": if capability_daynight_c<0~(n-1)>_ircuts ensitivity_type=options "1~100": if capability_daynight_c<0~(n- 1)>_ircuts ensitivity_type=normalize * Only available when "capability_daynight_c<0~(n-1)>...
  • Page 250 VIVOTEK tin_support > 0" and "irled" is listed in "capability_daynight_ illuminators _builtin_type" * We support this parameter when the version number (httpversion) is equal or greater than 0312a. builtin_whiteled_enable <boolean> Enable/disable built-in white led * Only available when "capability_daynight_illuminators_buil tin_support > 0" and "whiteled" is listed in "capability_daynight_ illuminators _builtin_type"...

  • Page 251: Image Setting Per Channel

    VIVOTEK equal or greater than 0312a. spectrum_mode visible, Set spectrum method . * We support this parameter when irenhanced, the version number (httpversion) is blueenhanced equal or greater than 0312a. <product dependent> * Only available when * Available values "capability_daynight_illuminators_ are listed in spectrum _support >...
  • Page 252 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) * We replace "contrast" with "contrastpercent ". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. saturation -5~5,100 -5: Less saturation <-> 5: More <Not saturation recommended to 100: Use "...
  • Page 253 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) contrast * Only available when bit 1 of "capability_image_c<0~(n-1)>_basicse tting" is 1 saturationpercent 0~100 Set saturation in the normalized range. 0: Less saturation <-> 100: More saturation * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicse tting"...
  • Page 254 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) tmode" is 1 <boolean> Enable/disable hightlight mask. <product * Only available when dependent> "capability_image_c<0~(n-1)>_hlm" is dnr_mode <boolean> 3D noise reduction. <product 0:disable dependent> 1:enable * Only available when "capability_image_c<0~(n-1)>_dnr" is dnr_strength 1~100 Strength of 3DNR <product * Only available when dependent>...
  • Page 255 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) <product 0:disable dependent> 1:enable * Only available when 'dis' is listed in "capability_image_c<0~(n-1)>_is_mod e". dis_strength 1~100 Strength of digital image stabilizer <product * Only available when 'dis' is listed in dependent> "capability_image_c<0~(n-1)>_is_mod e". scene_mode Value of scene mode visibility, <product...
  • Page 256 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) 1: enable * Only available when "capability_image_c<0~(n-1)>_deinter lace_support" is 1. deinterlace_mode spatial,blend Users can choose between two different deinterlacing techniques: Spatical mode provides the best image quality, while Blend mode provides better image quality (than not using the deinterlace function at all).
  • Page 257 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) listed in "capability_image_c< * Only available when 0~(n-1)>_palette_mo "capability_image_c<0~(n-1)>_palette de" _support" is 1. profile_i<0~(m-1)> <boolean> Enable/disable this profile setting _enable profile_i<0~(m-1)> night, The mode which the profile is applied _policy schedule <product dependent> * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a.
  • Page 258 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) recommended to use this> * Only available when bit 1 of "capability_image_c<0~(n-1)>_basicse tting" is 1. * We replace "profile_i0_contrast" with "profile_i0_contrastpercent ". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
  • Page 259 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) after the version number (httpversion) is equal or greater than 0400a. profile_i<0~(m-1)> 0~100 Set brightness in the normalized _brightnesspercent range. 0: Darker <-> 100: Bright * Only available when bit 0 of "capability_image_c<0~(n-1)>_basicse tting" is 1. profile_i<0~(m-1)>...
  • Page 260 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) are valid. Internal module will take the closest valid one. For example, 1~45 may all be mapped to gamma value = 0.45, etc. * Only available when "capability_image_c<0~(n-1)>_gamm acurve" is 1 profile_i<0~(m-1)> <boolean> Enable/disable low light mode. _lowlightmode * Only available when <product...

  • Page 261: Exposure Window Setting Per Channel

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) _eis_mode 0:disable <product 1:enable dependent> * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mod e". profile_i<0~(m-1)> 1~100 Strength of electronic image stabilizer _eis_strength * Only available when 'eis' is listed in <product "capability_image_c<0~(n-1)>_is_mod dependent> e".

  • Page 262: Exposure Window Setting For Each Window

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) masking of bright light area. "center": Use Center window as metering area and give the necessary light compensation. 7.12.1. Exposure Window Setting for Each Window Group: exposurewin_c<0~(n‐1)>_win_i<0~(k‐1)> n denotes the value of "capability_nvideoin", k denotes the value of "capability_image_c<0~(n-1)>_exposure_winnum". (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1 and when custom is listed in "capability_image_c<0~(n-1)>_exposure_winmode"...
  • Page 263 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) H: 0~ The current image height "capability_image_c<0~(n-1)>_exposu re_windomain". sizepx <0~Wx0~ H> Width and height of the window. W: 0~ The current image width * Only available when px is listed in "capability_image_c<0~(n-1)>_exposu H: 0~ The current image height re_windomain".
  • Page 264 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) Compensation), and to perform the masking of bright light area. "center": Use Center window as metering area and give the necessary light compensation. Group: exposurewin_c<0~(n‐1)>_profile_i<0~(m‐1)>_win_i<0~(k‐1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the value of "capability_nvideoinprofile", k denotes the value of "capability_image_c<0~(n-1)>_exposure_winnum".

  • Page 265: Audio Input Per Channel

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) homepx <0~W,0~H> Left-top corner coordinate of the window. W: 0~ The current image width * Only available when px is listed in H: 0~ The current image height "capability_image_c<0~(n-1)>_exposu re_windomain". sizepx <0~Wx0~ H> Width and height of the window. W: 0~ The current image width * Only available when px is listed in "capability_image_c<0~(n-1)>_exposu...
  • Page 266 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) input intmic, extmic intmic: Internal (built-in) microphone. <product (Only available when dependent> capability_audio_intmic = 1) extmic: External microphone input. (Only available when capability_audio_extmic =1) * Note: If physical microphone switch is showed on product, this value is updated during booting to fit switch status.
  • Page 267 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) suggest don't use this since the version number (httpversion) is equal or greater than 0301a. * We replace "gain" with "volume_internal" and "volume_external". More details, please refer the parameter description of "volume_internal" and "volume_external". boostmic 0~100 Enable microphone boost.
  • Page 268 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) 5900, 6700, 7400, 7950, 10200, 12200 s0_g711_mode pcmu, Set G.711 companding algorithm. pcma pcmu: µ-law algorithm pcma: A-law algorithm * Only available if G.711 is supported. s0_g726_bitrate 16000, Set G.726 encoded bitrate in bps. 24000, * Only available if G.726 is supported.

  • Page 269: Multicast Settings For Audio Streaming

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) schedule <product * Not support "policy=day" anymore dependent> when the version number (httpversion) is equal or greater than 0301a. * "policy=night" is only available when "capability_daynight_c<0~(n-1)>_sup port > 0". profile_i0_begintime hh:mm Begin time of schedule mode. profile_i0_endtime hh:mm End time of schedule mode.

  • Page 270: Play An Audio Clip

    VIVOTEK 7.15 Play an Audio Clip Group: audioclip_i<0~1> (capability_audio_audioclip=1) NAME VALUE SECURITY DESCRIPTION (get/set) name string[40] Specify the audio clip name that can be played when an event occurs. size 0,<positive integer> The size of audio clip. Group: audioclip (capability_audio_audioclip=1) NAME VALUE SECURITY...
  • Page 271 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) ~ 9999,0 ~ 9999, 0 ~ position. 9999,0 ~ 9999, 0 ~ (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 9999,0 ~ 9999 * Only available when "capability_motion_wintype" = polygon. * Only available when std is listed in "capability_motion_windomain" objsize 1 ~ 100 Percent of motion detection window.
  • Page 272 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0400a. left 0 ~ 320 Left coordinate of window position. <Not recommended * Only available when to use this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain".
  • Page 273 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. Group: motion_c<0~(n‐1)>_profile_i<0~(m‐1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the vaule of "...
  • Page 274 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable motion detection window. name string[14] Name of motion window. polygonstd 0 ~ 9999,0 ~ 9999, Coordinate of polygon window position. 0 ~ 9999,0 ~ 9999, (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 0 ~ 9999,0 ~ 9999, * Only available when 0 ~ 9999,0 ~ 9999 "capability_motion_wintype"...
  • Page 275 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) <Not recommended * Only available when to use this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.

  • Page 276: Tampering Detection Settings

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. 7.17 Tampering Detection Settings Group: tampering_c<0~(n‐1)> for n channel products (capability_tampering > 0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY...

  • Page 277: Ddns

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) detection blurry_duration 1~10 If image too blurry value exceeds the "threshold" for more than "duration" second(s), then image too blurry detection is triggered. 7.18 DDNS Group: ddns (capability_protocol_ddns > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean>...

  • Page 278: Upnp Presentation

    VIVOTEK 7.20 UPnP Presentation Group: upnppresentation NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP presentation service. 7.21 UPnP Port Forwarding Group: upnpportforwarding NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP port forwarding service. upnpnatstatus The status of UPnP port forwarding, used internally.

  • Page 279: Snmp

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) setparamlevel Show log of parameter setting. 0: disable 1: Show log of parameter setting set from external. 2. Show log of parameter setting set from external and internal. 7.23 SNMP Group: snmp (capability_protocol_snmp > 0) NAME VALUE SECURITY...

  • Page 280: Layout Configuration

    VIVOTEK 7.24 Layout Configuration Group: layout NAME VALUE SECURITY DESCRIPTION (get/set) logo_default <boolean> 0 => Custom logo 1 => Default logo logo_link string[128] Hyperlink of the logo http://www.vivot ek.com logo_powerbyvvtk_hidd <boolean> 0 => display the power by vivotek logo 1 => hide the power by vivotek logo custombutton_manualtr <boolean>...
  • Page 281 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) Bit 1 => Require special character Bit 2 => Require digit number Bit 3 => Require lowercase letter Bit 4 => Require uppercase letter Bit 5 => Allow checking username and password; if "bit=1" means username=password is allowed, otherwise is not allowed.

  • Page 282: Privacy Mask

    VIVOTEK 7.25 Privacy Mask Group: privacymask_c<0~(n‐1)> for n channel products and m privacy mask window. n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable privacy mask. win_i<0~(m-1)>_enable <boolean> Enable privacy mask window.

  • Page 283: Privacy Mask

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) 0 ~ 320,0 ~ 240, position. 0 ~ 320,0 ~ 240, (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 0 ~ 320,0 ~ 240 * Only available when "capability_image_c<n>_privacymask _wintype" = polygon. * Only available when qvga is listed in "capability_image_c<0~(n-1)>_privacy mask_windomain".

  • Page 284: Capability

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) color 0~" Privacy mask color capability_image_c<0~(n- 1)>_privacymask_ncolor" win_i<0~(m-1)>_name string[40] Name of the privacy mask window. win_i<0~(m-1)>_pan "capability_ptz_c<0~(n-1) Pan position of window >_minpan" ~ position. "capability_ptz_c<0~(n-1) * Only available when bit0 of "capability_camctrl_c<0~(n-1)>_ >_maxpan" buildinpt" is "1" win_i<0~(m-1)>_tilt "capability_ptz_c<0~(n-1) Tilt position of window position.
  • Page 285 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) features/interfaces or the firmware has substantially change in architecture and not able to roll back to previous version. This may cause incompatibility with supporting software. Minor version Increase the minor version when add new features/interfaces without change the old features and interfaces.
  • Page 286 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) follow the API definition of 0301a_1, we will fix them and change this API value to 0301b_1. api_logoversion <string> Indicate the version of Vivotek log This number start format. with 1.0 * We support this parameter when the version number (httpversion) is equal or greater than 0317c.
  • Page 287 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) nvideoout 0, <Positive Integer> Number of video out interface. nvideoinprofile <positive integer> Number of video input profiles. nmediastream <positive integer> Number of media stream per channels. naudiosetting <positive integer> Number of audio settings per channel. <Not support * Not support this parameter anymore>...
  • Page 288 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) Support pan operation; 0(not support), 1(support) Bit 3 => (only available when bit0 is 1) Support tilt operation; 0(not support), 1(support) Bit 4 => (only available when bit0 is 1) Support zoom operation; 0(not support), 1(support) (only available when RS-485 interface is supported or SD/PZ/PT/PD/video server series)
  • Page 289 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) bit 1 => Only support zoom function. bit 2 => Only support focus function. bit 3 => Currently, this is a reserved bit, and the default value is 0. * It's strongly non-recommended to use this.
  • Page 290 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) group for 1st channel, bit 16~31 are the 2nd group for 2nd channel. nvideoin = 3, bit 0~9 are the 1st group for 1st channel, bit 10~19 are the 2nd group for 2nd channel, bit 20~31 are the 3rd group for 3rd channel.
  • Page 291 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) tamperingmode tamper,toodark,toobri Available tampering mode list. ght,tooblurry * Only available when "capability_tampering" is 1. adaptiverecording <boolean> Indicate whether to support adaptive recording. adaptivestreaming <boolean> Indicate whether to support adaptive streaming. supporttriggertype seq,boot,motion,netw list all the trigger types which are orkfail,recnotify,tamp supported in the camera: ering,vi,vadp,di,volala...
  • Page 292 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) * We support this parameter when the version number (httpversion) is equal or greater than 0311c. storage_dbenabled <boolean> Media files are indexed in database. protocol_https <boolean > Indicate whether to support HTTP over SSL. protocol_rtsp <boolean >...
  • Page 293 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) protocol_ipv6 <boolean> Indicate whether to support IPv6. protocol_pppoe <boolean> Indicate whether to support PPPoE. protocol_ieee8021 <boolean> Indicate whether to support IEEE802.1x. protocol_qos_cos <boolean> Indicate whether to support CoS. protocol_qos_dscp <boolean> Indicate whether to support QoS/DSCP.
  • Page 294 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) * This is kept for compatibility. videoin_mjpeg_ma A list of <Integer> and This equals xframerate "-" "capability_videoin_c0_mjpeg_maxfra merate". * This is kept for compatibility. videoin_h264_max A list of <Integer> and This equals framerate "-" "capability_videoin_c0_h264_maxfra merate".
  • Page 295 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) *Only available when "capability_audio_aec" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0306b. audio_aecaffect When acoustic echo cancellation maxframerate:fixed:1 function is enabled, some features may become malfunction or be forced to a given value.
  • Page 296 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) For example: "maxframerate: fixed:15" which means the max frame rate is 15fps when acoustic echo cancellation function is enabled. "-" means no feature is affected. * Only available when "capability_audio_aec" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0306b.
  • Page 297 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) * It will be replaced by audio_intmic and audio_extmic. audio_lineout <boolean> Indicate whether to support line output. audio_michardwar <boolean> Indicate whether the hardware eswitch supports built-in/external mic switch audio_headphoneo <boolean> Indicate whether to support headphone output.
  • Page 298 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) the whole image. "px": Locate a window in the image with pixels. "std": A normalized 0~9999 range. "‐": Not supported. smartstream_supp <boolean> Indicate whether smart stream is supported. smartstream_versi <integer> Number of smart stream version. * Only available when "capability_smartstream_support"...
  • Page 299 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) dow_autotracking of autotracking. * Only available when "capability_smartstream_support" is 1 smartstream_nwin <positive integer> Maximum number of tracking window dow_manual of manual. * Only available when "capability_smartstream_support" is 1 smartstream_nwin <positive integer> Maximum number of tracking window dow_hybrid_autotr of autotracking in hybrid mode.
  • Page 300 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) (httpversion) is equal or greater than 0301b. * It will be replaced by capability_camctrl_ptztunnel. camctrl_ptztunnel <boolean> Indicate whether to support ptztunnel. * We support this parameter when the version number (httpversion) is equal or greater than 0301b. This equals "capability_camctrl_c0_ptztunnel".
  • Page 301 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) is supported. * Only available when "capability_network_wireless" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0305a. wireless_s802dot1 <boolean> Indicate whether to support wireless 802.11b+. wireless_s802dot1 <boolean>...
  • Page 302 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0305a. derivative_brand <boolean> Indicate whether to support the upgrade function for the derivative brand. For example, if the value is true, the VVTK product can be upgraded to VVXX.
  • Page 303 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0313a. media_streamprofi <positive integer> Maximum number of stream profiles. les_num * We support this parameter when the version number (httpversion) is equal or greater than 0313a. image_iristype <string>...
  • Page 304 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) One bit represents one channel. Ex: “3” means channel 0 and channel1 support seamless recording . * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_modn The maximum MOD connection <positive integer> numbers.
  • Page 305 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_slcon 0,<positive integer> The maximum seamless connection number for each channel. * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_smart <boolean> The "Lifetime and Log SD Card" feature allows users to obtain the card's remaining lifetime information.
  • Page 306 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) layout_redirection <string> Indicate which function will be redirected to the vadp package path. "-": Not supported. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. securecam_suppor <Boolean> Indicate support for security camera.

  • Page 307: Capability For Camctrl

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) cameralink_num 0, <positive integer> Indicate the maximum number of receiver camera link. * Only available when "capability_cameralink_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0315a. cameralink_version <integer>...
  • Page 308 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) buildinpt <boolean> An 32-bit integer, each bit can be set separately as follows: Bit 0 => support build-in pan Bit 1 => support build-in tilt zoommodule <boolean> Indicate whether to support zoom lens. In our product, only SD series and IZ series use the zoom lens.

  • Page 309: Capability For Ptz

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) focusmode auto,onetimeauto,sp Focus mode selection: otlight,manual "auto": Camera will automatically <product adjust the focus position full time to dependent> adapt a clear picture. "onetimeauto": Camera will automatically adjust the focus position one time, which follows any PTZ control.
  • Page 310 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) panspeedlv 0, <positive integer> 0/7 The maximum speed level of pan motion. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" minpan 0, <positive integer> 0/7 The lower limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildin pt"...
  • Page 311 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) mintiltangle <integer> The lower limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" maxtiltangle <integer> The upper limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" zoomspeedlv 0, <positive integer>...

  • Page 312: Capability For Ir Led

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxfocus 0, <positive integer> 0/7 The upper limit for focus position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoomm odule" is "1" 7.27.3 Capability for IR Led Group: capability_daynight_c<0~(n‐1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY...
  • Page 313 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) optimizedir <boolean> Indicate whether to support optimized IR control technology. * We replaced this parameter with “capability_daynight_illumintators_opti mizedir” when the version number (httpversion) is equal or greater than 0312a. smartir <boolean> Indicate whether to support smart IR. ircutfilter <boolean>...
  • Page 314 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) ircutsensitivity_supportle The value indicate the support strength <positive integer> level of ircutsensitivity. * Only available when "capability_daynight_c<0~(n-1)>_suppo rt" is 1 and "capability_daynight_c<0~(n-1)>_ircuts ensitivity_type" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 315 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) spectrum_mode visible,ir,irenhanced, Indicate the spectrum mode. blueenhanced "visible": The ideal default setting for <product visible light. dependent> "ir": The ideal default setting for IR light. "irenhanced": This CCM model increases the brightness effect of IR light.

  • Page 316: Capability For Ir Illuminators

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) mode auto,daynight,di,di2, Indicate the day / night switch mode. di3,di4,schedule,- "auto": The Camera automatically <product judges the current operation mode by dependent> the level of ambient light detected. "daynight": support day mode and night mode.
  • Page 317 VIVOTEK optimizedir <boolean> Indicate whether to support optimized IR control technology. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. builtin_support <boolean> Indicate whether to support built-in led. * We support this parameter when the version number (httpversion) is equal or greater than 0312a.

  • Page 318: Capability For Storage Management

    VIVOTEK spectrum_support <boolean> Indicate whether to support proposed a brightness enhancement method based on CCM(Color Correction Matrix) model to improve the brightness effect of the images if the IR and blue light exists. * Only available when "capability_daynight_c<0~(n-1)>_support" is 1 * We support this parameter when the version number (httpversion) is equal or greater than 0312a.

  • Page 319: Capability For Video Input

    VIVOTEK device sd, nas Indicate the supported storage devices. <product * Only available when dependent> "capability_storage_dbenabled" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. * Note: If “nas” storage is supported, the media storage path format is “\<mac address>\date\hour”.
  • Page 320 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) color_support <boolean> 1 : camera can select to display color or black/white video streams. 0: camera do not support this feature. * We support this parameter when the version number (httpversion) is equal or greater than 0310a.
  • Page 321 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) rotationaffect When rotation is enabled, some features <product may become malfunction or be forced to a dependent> given value. The affected functions are list here. The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it.
  • Page 322 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) rotationangle <string> The different angles which camera supports for rotation. * Only avaliable when "capability_videoin_c<0~(n-1)>_rotation" is * We support this parameter when the version number (httpversion) is equal or greater than 0309b. orientation flip,mirror,rotatio Indicates the camera supports flip, mirror or rotation.
  • Page 323 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) resolution A list of <WxH> Resolution options in current video mode. <product These options are the possible options for dependent> "videoin_c<n>_s<m>_resolution". The last one is the maximum resolution in current mode. maxresolution A list of <Integer> 0/7 Represent supported maximum resolution of each stream in current video mode.
  • Page 324 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) mjpeg_maxframerate A list of <Positive Maximum fps that the device can encoded Integer> and "-" with MJPEG on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution".
  • Page 325 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) h264_maxbitrate <positive integer> 0/7 Maximum bitrates of H.264. The unit is bps. * Only available when 'h264' is listed in "capability_videoin_codec". h264_profile baseline,main,hig Indicate H264 profiles * Only available when 'h264' is listed in <product "capability_videoin_codec".
  • Page 326 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) fisheye_mounttype ceiling, wall, floor Indicate the supported type. <Not recommended <product wall mount: 180° panoramic view to use this> dependent> ceiling mount: 360° surround view without blind spots floor mount: 360° surround view without blind spots * Only available when "capability_fisheye"...

  • Page 327: Capability For Local Dewarp

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) cameraunit_name CU8131, A "camera unit" name of a split-type camera CU8171, system, which the camera unit and the CU8161-H, video core are separated. CU8162-H, -: If the camera is not a split-type camera CU8163-H, system, the value of this parameter is "-".

  • Page 328: Capability For Video Mode

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) typewallmount 1O, 1P, 1R, 4R Available dewarp types of wall mount. resolutionC1P A list of <WxH> Available resolutions of 1P mode of ceiling and floor mount. resolutionC2P A list of <WxH> Available resolutions of 2P mode of ceiling and floor mount.
  • Page 329 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) is_mode eis, Indicate this mode whether support dis, image stabilizer mode. "eis": electronic image stabilizer "dis": digital image stabilizer "‐ ": not support * Only available when "capability_image_c<0~(n-1)>_eis" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0317a.
  • Page 330 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) eptz 0, <positive integer> 0/7 Indicate this mode whether support eptz. For "nvideoin" = 1, the definition is as following: A 32-bits integer, each bit can be set separately as follows: Bit 0 => 1st stream supports ePTZ or not. Bit 1 =>...
  • Page 331 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) effectivepixel <WxH> The visible area of full scene in this video mode. The unit is pixel in source. * If "effectivepixel"<"capability_videoin_c<0~ (n-1)>_maxsize", then the visible area is located at the center of full scene. outputsize <WxH>...
  • Page 332 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxresolution A list of <Integer> Represent supported maximum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream". minresolution A list of <Integer> Represent supported minimum resolution of each stream in current video mode.
  • Page 333 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxfps_mjpeg A list of <Positive Maximum fps which the device can Integer> and "-" encoded with MJPEG on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution".

  • Page 334: Capability For Image

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxfps_h265 A list of <Positive Maximum fps which the device can Integer> and "-" encoded with H.265 on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution".
  • Page 335 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) equal or greater than 0311a. wdrpro_mode 0, 1, 2 0: Non-support WDR Pro 1: Support WDR Pro 2: Support WDR Pro II wdrpro_strength 0, 1 0: Non-support tuning strength of WDR Pro 1: Support tuning strength of WDR Pro * If "capability_image_c<0~(n- 1)>_wdrpro "=1, this may be either 0 or wdrpro_supportlevel...
  • Page 336 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) .hlc:hidden:, selections or values. exposuretime:hidd - (enabled) : UI is checked. en:, - (notsupport) : the affected function gaincontrol:hidden: is not available. - (onlyonce) : when wdrpro is enabled, flickerless:unchang wdrc is checked; when wdrpro is ed:, disable, wdrc is unchecked.
  • Page 337 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) integer here. <product The format is "Affect API dependent> name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it.
  • Page 338 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) 1: Support 3D digital noise reduction dnrstrength <positive integer> Indicate the support strength level of 3D digital noise reduction. * Only available when "capability_image_c<0~(n-1)>_dnr" > * We support this parameter when the version number (httpversion) is equal or greater than 0306d.
  • Page 339 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) is_supportlevel 0, <positive Indicate the support strength level of integer> image stabilizer mode. * Only available when "capability_image_c<0~(n-1)>_is_mod e" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. is_affect When Is mode is not "-", some <x>: nonnegative...
  • Page 340 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when "capability_image_c<0~(n-1)>_is_mod e" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 341 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values.
  • Page 342 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) dependent> name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden.
  • Page 343 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) wbmode auto, Available white balance mode. panorama, "-" means white balance is not manual, supported. rbgain, widerange, outdoor,indoor, sodiumauto, <product dependent> iristype piris, Indicate iris type. dciris, "piris": P-Iris "dciris": DC-Iris "-": No Iris control support * Note: For some cameras, this value may be varied depending on mounted lens.
  • Page 344 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) constant value. "twovalues": Need two parameters to indicate the exposure range. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_shuttervalu fixed, * One to one mapping to the mode...
  • Page 345 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) "maximum": The gain value can be up to the assigned value (videoin_c<0~(n- 1)>_gainvalue) "ranged": Need two parameters to indicate the gain range. (videoin_c<0~(n-1)>_maxgain/ videoin_c<0~(n-1)>_maxgain) "‐": not support. * Only available when "irispriority" or "shutterpriority" is listed in "capability_image_c<0~(n-1)>_ exposure_modetype"...
  • Page 346 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled.
  • Page 347 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available.
  • Page 348 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) defaultgain:fixed:x "Policy" can be categorized into or others following groups: <x>: nonnegative - (disabled) : UI turns grey and users integer can't select it. <product - (unchanged) : UI keeps the status as dependent> before and user can't change it.
  • Page 349 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) itymode_affect exposurewin.mode is enabled, some features may .blc:hidden:, become malfunction or be forced to a defog:disabled:, given value. The affected functions wdrpro:disabled:, are list here. exposurelevel:hidd The format is "Affect API en:, name":"Policy":"Description" defaultgain:fixed:x "Policy"...
  • Page 350 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0305a. exposure_manualmod When exposure manual mode is e_affect exposurewin.mode enabled, some features may become .blc:hidden:, malfunction or be forced to a given defog:disabled:, value.
  • Page 351 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) integer or string or NULL. "-" means no feature is affected. * Only available when manual is listed in "capability_image_c<0~(n-1)>_ exposure_modetype" and "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 352 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) in "capability_image_c<0~(n-1)>_ exposure_winmode". exposure_hlcmode_af When hlc mode is enabled, some fect sir:hidden: features may become malfunction or be forced to a given value. The or others <x>: nonnegative affected functions are list here. integer The format is "Affect API <product name":"Policy":"Description"...
  • Page 353 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) exposure_mode" is 1 and hlc is listed in "capability_image_c<0~(n-1)>_ exposure_winmode". * We support this parameter when the version number (httpversion) is equal or greater than 0304a. exposure_wintype inclusive, The supported exposure window type. exclusive, "inclusive": The image inside a window is the target area of exposure control.
  • Page 354 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) exposure_ntsc_totalra A list of <Positive Available total range for NTSC analog Integer> output. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0301a. exposure_pal_totalra A list of <Positive Available total range for PAL analog...
  • Page 355 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) value must be set to "-". * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_bracketing_ <boolean> 0: Non-support Auto Exposure mode Bracketing (AEB) 1: Support Auto Exposure Bracketing (AEB) Auto Exposure Bracketing (AEB) is a term that is used to signify a process where the camera automatically takes two or more exposures but with...
  • Page 356 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) rectangle shape. privacymask_windom qvga, px, std, - The domain to set an window. "qvga": a 320x240 range to represent the whole image. "px": Locate a window in the image with pixels. "std": A normalized 0~9999 range. "‐": Not supported.
  • Page 357 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available.
  • Page 358 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) <product "Policy" can be categorized into dependent> following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden.
  • Page 359 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) ivity of AE converge speed. 1: Support tuning the sensitivity of AE converge speed. * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1. gammacurve 0: Non-support tuning Gamma curve 1: Support tuning Gamma curve lowlightmode -,0,1 Internal parameter, must not open to user.
  • Page 360 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) integer> focuswindow_range <leftrange,rightran Available range for focuswindow. ge,toprange,lowran * We support this parameter when ge> the version number (httpversion) is equal or greater than 0305d. <product dependent> *-: Not supported. lensconfiguration_sup Indicate whether to support different port image library configuration files for specific exchangeable lens.
  • Page 361 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when capability_image_c<0~(n-1)>_deinterl ace_support is 1 lens_alignment <boolean> Indicate whether to support lens alignment function. * We support this parameter when the version number (httpversion) is equal or greater than 0309b. lens_alignmentlevel <positive integer>...

  • Page 362: Capability For Peripheral Device

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) equal or greater than 0310a. focussystem_mode AFbyzoom, Supported features for remotefocus. focusshift, - "AFbyzoom": Trigger autofocus if <product zoom is operated. dependent> "focusshift": Ability to adjust day/night focus position. "‐": Not supported. * Only available when "capability_image_c<0~(n-1)>_remote focus"...

  • Page 363: Capability For Extension Modules

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) devicemonitor_heatern <integer> Number of sensor sensors that can be monitored. * Only available when "capability_peripheral_c<0~(n-1)>_devi cemonitor_support" > 0 7.27.11 Capability for Extension Modules Group: capability_extension PARAMETER VALUE SECURITY DESCRIPTION (get/set) di_num <integer> The number of supported extension digital input module.
  • Page 364 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. enable 0, 1 Enable or disable this event. priority 0, 1, 2 Indicate the priority of this event: "0"= low priority "1"= normal priority "2"= high priority delay 1~999 Delay in seconds before detecting the next event.
  • Page 365 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) 0,<positive Indicate the source id of di trigger. integer> This field is required when trigger condition is “di”. One bit represents one digital input. The LSB indicates DI 0. * Only available when "capability_ndi" > mdwin 0,<positive Indicate the source window id of motion...
  • Page 366 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) valevel0 Select audio detection profile event. 0: not select 1: select inter 1~999 Interval of snapshots in minutes. This field is used when trigger condition is “seq”. weekday 0~127 Indicate which weekday is scheduled. One bit represents one weekday.
  • Page 367 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_do_i<0~(k-1)>_en <boolean> Enable or disable trigger digital output. able k is determined by the below criterion: The following applies for capability_extension_do_num >= 0 * if extension_connected=1, k=capability_ndo * if extension_connected=0, k=capability_ndo+ capability_extension_do_num Otherwise, * k=capability_ndo * Only available when "capability_ndo"...
  • Page 368 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) foldername string[128] Path to store media. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. action_cf_media NULL, 0~4,101 Index of the attached media. 101 means “Recording Notify” * Only available when "capability_supportsd"...
  • Page 369 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_goto_sync <boolean> Capture media after moving to the <product dependent> location. * Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0, or capability_camctrl_c0_zoommodule > 0 action_autotrack_enable <boolean> Enable/disable auto tracking when an <product dependent>...

  • Page 370: Server Setting For Event Action

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_audioclip_enable <boolean> Enable/disable the function the play an audio clip when an event is triggered. * Only avaliable when "capability_audio_audioclip" is 1. action_audioclip_media 0,<positive Indicate the source id of audioclip event integer> notification. * Only avaliable when "capability_audio_audioclip"...
  • Page 371 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) type email, Indicate the server type: ftp, “email” = email server http, “ftp” = FTP server “http” = HTTP server sftp “ns” = network storage “sftp” = secure FTP * “sftp” is only available when bit 1 of “capability_protocol_ftp_client”...

  • Page 372: Server Setting For Event Action Of Sftp

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) ns_location string[128] Location to upload or store the media. * For httpversion is equal or greater than 0312a: The media storage path format is “\<mac address>\date\hour”. (Only available when “nas” is included in “capability_storage_management_device”) * For httpversion smaller than 0312a: The media storage format is “\date\hour”.

  • Page 373: Media Setting For Event Action

    VIVOTEK fingerprint_enable boolean Verify server fingerprint to avoid connect to fake server. fingerprint_content <128-bit hash Server fingerprint(MD5). value> You can get it by calculate server host key(public) md5. publickey_pairmode auto, "autopair": Autopair mode is selected download, for this event server. upload "downloadkey": Download key pair mode is selected for this event server.
  • Page 374 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) snapshot_channel 0~"capability_nvideoin"-1 Indicate the source of media channel. 0 means the first channel. 1 means the second channel. 2 means the third channel. 3 means the fourth channel. * We support this parameter when the version number (httpversion) is equal or greater than 0311c.
  • Page 375 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) videoclip_channel 0~"capability_nvideoin"-1 Indicate the source of media channel. 0 means the first channel. 1 means the second channel. 2 means the third channel. 3 means the fourth channel. * We support this parameter when the version number (httpversion) is equal or greater than 0311c.

  • Page 376: Recording

    VIVOTEK 7.31 Recording Group: recording_i<0~(n‐1)> n denotes the value of "capability_nrecording" (capability_nrecording > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. trigger schedule, The event trigger type networkfail schedule: The event is triggered by schedule networkfail: The event is triggered by the failure of network connection.
  • Page 377 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxretentiontime <string> To specify the expired time for automatic clean up, and it only takes effect for video clip generated by recording_i <0~1>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss] S’ , similar with ISO8601 with symbols P Ex.
  • Page 378 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) weekday 0~127 Indicate which weekday is scheduled. One bit represents one weekday. bit0 (LSB) = Saturday bit1 = Friday bit2 = Thursday bit3 = Wednesday bit4 = Tuesday bit5 = Monday bit6 = Sunday For example, to detect events on Friday and Sunday, set weekday as 66.

  • Page 379: Https

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) adaptive_enable <boolean> Indicate whether the adaptive recording is enabled adaptive_preevent 0~9 Indicate when is the adaptive recording started before the event trigger point (seconds) adaptive_postevent 0~10 Indicate when is the adaptive recording stopped after the event trigger point (seconds) recordingjob_Sourc string[64]...

  • Page 380: Storage Management Setting

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) stateorprovincen string[128] State or province name in the certificate information. localityname string[128] The locality name in thecertificate information. organizationname string[64] Organization name in the certificate VIVOTEK Inc. information. unit string[64] Organizational unit name in VIVOTEK Inc.
  • Page 381 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) autocleanup_mode targetbase, Specify the automatic clean up method sourcebase for storage devices, where “targetbase” indicate the automatic clean up is based on the attached devices such as nas or sd card, whereas “sourcebase” indicate automatic clean up is based on the selected recording track.

  • Page 382: Region Of Interest

    VIVOTEK 7.34 Region of Interest Group: roi_c<0~(n‐1)> for n channel product and m is the index of video stream which support ePTZ. (capability_eptz > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-1)>_home <W,H> ROI left-top corner coordinate. <product * If the minimal window size is 64x64, dependent>...

  • Page 383: Eptz Settings For Each Stream

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) osdzoom <boolean> Indicates multiple of zoom in is “on- <Not recommended to screen display” or not. use this> * Reserved for compatibility, and suggest don't use this since [httpversion] > 0302a * We replace "eptz_c<0~(n- 1)>_osdzoom"...

  • Page 384: Focus Window Setting

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) patroldwelling string[160] The dwelling time (unit: second) of each patrol point, separated by “,”. preset_i<0~19>_name string[40] Name of ePTZ preset. (It should be set by ePreset.cgi rather than by setparam.cgi.) preset_i<0~19>_pos <W,H> Left-top corner coordinate of the preset. <product (It should be set by ePreset.cgi rather dependent>...

  • Page 385: Seamless Recording Setting

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) win_i0_size <WxH> Width and height of the window. <product * The minimal window size is 192x144, dependent> and resolution_W and resolution_H is based on "capability_image_ c<0~(n- 1)>_focuswindow_range" . 7.37 Seamless Recording Setting <Not recommended to use> Group: seamlessrecording (capability_localstorage_seamless>...
  • Page 386 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxconnection Maximum number of connected seamless streaming. * We replace this parameter with “seamlessrecording_c<0~(n-1)>_maxconnecti on” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin >...

  • Page 387: Seamless Recording Setting Per Channel

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) guid<0~2>_number Number of connected seamless streaming with guid<0~(k-1)>_id. (Read only) * We replace this parameter with “seamlessrecording_c<0~(n-1)>_guid<0~2>_n umber” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin >...

  • Page 388: Vivotek Application Development Platform Setting

    VIVOTEK triggerrecord <boolean> Indicate whether seamless recording is recording to local storage or not at present. (Read only) * We support this parameter when the version number (httpversion) is equal or greater than 0312a. guid<0~(k-1)>_id string[127] The connected seamless streaming ID. (Read only) * k denotes the value of "seamlessrecording_c<0~(n-1)>_maxco...

  • Page 389: Vadp Settings For Each Hyperlink

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) resource_free_storage 0,<positive Indicate current free storage size for integer> uploading VADP modules. module_number 0,<positive Record the total module number that integer> already stored in the system. module_order string[40] The execution order of the enabled modules.

  • Page 390: Vadp Settings For Each Package

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) string[120] The URL address of vadp hyperlink. status string[40] Value of “on” indicates a valid connection of vadp hyperlink. Value of “off” indicates a invalid connection of vadp hyperlink. 7.38.2. VADP Settings for Each Package Group: vadp_module_i<0~(n‐1)>...

  • Page 391: Vadp Schedule Settings

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) statmsg string[128] Indicate the message that will be show on the running status when mouse over. vvtklicensemec string[40] Indicate the module use VIVOTEK license mechanism 7.38.3. VADP Schedule Settings Group: vadp_schedule_i<0~(n‐1)> for n VADP package number n denotes the value of "capability_vadp_npackage".
  • Page 392 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) enableptztunnel <boolean> Enable PTZ tunnel for camera control. Group: camctrl_c<0~(n‐1)> for n channel products (capability_ptzenabled > 0) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset" NAME VALUE SECURITY DESCRIPTION (get/set) panspeed -5 ~ 5...

  • Page 393: Camera Ptz Control (Iz Series)

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) capability_camctrl_c0_rs485=2 disablemdonptz <boolean> Disable motion detection on PTZ operation. 7.40 Camera PTZ Control (IZ Series) Group: camctrl_c<0~(n‐1)> for n channel products (capability_camctrl_c0_zoommodule = 1 and capability_camctrl_c0_buildinpt = 0) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset" NAME VALUE SECURITY...
  • Page 394 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) listed in "capability_cam ctrl_c<0~(n-1)> _focusmode" uart Select corresponding uart "capability_nua (capability_nuart>0). rt"-1 * only available when capability_camctrl_c0_rs485=2 isptz 0 ~ 2 0: disable PTZ commands. 1: enable PTZ commands with PTZ driver. 2: enable PTZ commands with UART tunnel.
  • Page 395 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) version number (httpversion) is equal or greater than 0305b. patrolseq string[120] (For external device) The indexes of patrol points, separated by “,” patroldwelling string[160] (For external device) The dwelling time of each patrol point, separated by “,”...

  • Page 396: Camera Ptz Control (Sd Series)

    VIVOTEK PTZ C LEASE REFER TO ONTROL 7.41 Camera PTZ Control (SD Series) Group: camctrl_c<0~(n‐1)> for n channel products (the bit7 of capability_ptzenabled is 0 and the bit4 of capability_ptzenabled is 1) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset" NAME VALUE SECURITY...
  • Page 397 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) preset_i<0~(k-1)>_name string[40] Name of the preset location. preset_i<0~(k-1)>_pan capability_ptz_c<0~( n- Pan position at each preset 1)>_minpan ~ location. capability_ptz_c<0~( n-1)>_maxpan preset_i<0~(k-1)>_tilt capability_ptz_c<0~( n- Tilt position at each preset 1)>_mintilt ~ location. capability_ptz_c<0~( n-1)>_maxtilt preset_i<0~(k-1)>_zoom capability_ptz_c<0~( n- Zoom position at each preset 1)>_minzoom ~...
  • Page 398 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) n-1)>_minpan ~ capability_ptz_c<0~( n-1)>_maxpan axisy capability_ptz_c<0~( n- Custom home tilt position. 1)>_mintilt ~ capability_ptz_c<0~( n-1)>_maxtilt axisz capability_ptz_c<0~( n- Custom home zoom position. 1)>_minzoom ~ capability_ptz_c<0~( n-1)>_maxzoom axisf capability_ptz_c<0~( n- Custom home focus position. 1)>_minfocus ~ capability_ptz_c<0~( n-1)>_maxfocus axisflip...
  • Page 399 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) tour_i<0~19>_speed -5 ~ 5 Preset tour: pan and tilt speed when moving between presets. Recorded tour: unnecessary. tour_i<0~19>_direction forward,backward,ra User can choose which direction ndom the preset tour goes. "forward": preset tour goes in forward order.

  • Page 400: Uart Control

    VIVOTEK 7.42 UART Control Group: uart (capability_nuart > 0 and capability_fisheye = 0) NAME VALUE SECURITY DESCRIPTION (get/set) ptzdrivers_i<0~19, string[40] Name of the PTZ driver. 127>_name ptzdrivers_i<0~19, string[128] Full path of the PTZ driver. 127>_location enablehttptunnel <boolean> Enable HTTP tunnel channel to control UART.

  • Page 401: Uart Control (Sd Series)

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) speedlink_i<0~4>_n string[40] Additional PTZ command name. * only available when capability_camctrl_c0_rs485=2 speedlink_i<0~4>_c string[40] Additional PTZ command list. * only available when capability_camctrl_c0_rs485=2 ptzdriver 0~19, The PTZ driver is used by this COM 127 (custom), port.

  • Page 402: Uart Control (Sc Series)

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) "1": One stop bit is transmitted to stopbit indicate the end of a byte. "2": Two stop bits are transmitted to indicate the end of a byte. If you want to transfer the stopbit for 150% of the normal time used to transfer one bit, the uart_i<0~(n- 1)>_stopbit should be set as 2 and the...

  • Page 403: Fisheye Info

    VIVOTEK Group: lens for n channel products n denotes the value of "capability_nvideoin" (capability_image_c<0~(n-1)>_lensconfiguration_support = 1) NAME VALUE SECURITY DESCRIPTION (get/set) selected <string> Current selected lens profile. e.g. lens_selected=lens_default_i0, it means choosen lens configuration is i0 lens of default group. Group: lens_default NAME VALUE...

  • Page 404: Fisheye Local Dewarp Setting

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) revisedcenteraxis <coordinate> The actual center axis coordinate radius 0, <positive The actual center radius integer> 7.47 Fisheye Local Dewarp Setting Group: fisheyedewarp_c<0~(n‐1)> (capability_fisheyelocaldewarp_c<0~(n-1)> > 0) n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" NAME VALUE SECURITY...

  • Page 405: Pir Behavior Define

    VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) from 0 to 3) Tilt range of ceiling/floor mount is [0~90]. Tilt range of wall mount is [-90~90]. s<0~(m-2)>_region_r 100~300 Zoom home ratio of regional view (for <0~(i-1)>_zoom 4R mode, i is the view index and range from 0 to 3) 7.48 PIR Behavior Define Group: pir...

  • Page 406: Wireless

    VIVOTEK 7.50 Wireless Group: wireless (capability_network_wireless > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) ssid string[32] SSID for wireless lan settings. wlmode Infra, Wireless mode. Adhoc Infra: Infrastructure channel 1~11 or A list of WLAN channels. 1~13 Countries apply their own regulations 10~11 or to the allowable channels.

  • Page 407: Shock Detection

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) key2 password [26] WEP key2 for encryption. * Only valid when "wireless_encrypt" is "wep" key3 password [26] WEP key3 for encryption. * Only valid when "wireless_encrypt" is "wep" key4 password [26] WEP key4 for encryption. * Only valid when "wireless_encrypt"...
  • Page 408 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) fixed <boolean> The value indicates whether the profile can be deleted or not. Ex. fixed=1 indicates the profile cannot be deleted. occupied <boolean> Indicates the action of creating profile. Ex. If occupied=1 indicates the current profile is to be created;...

  • Page 409: Multicast Settings For Metadata Streaming

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) audioconfiguration_so c<0~(n-1)>s0 The audioconfiguration source for the urce profile. * n denotes the value Ex. audioconfiguration_source= c<0~(n- 1)>s0 indicates audio stream of channel "capability_naudioin" n and stream 1 is selected for the profile. * Only available when capability_naudioin >...

  • Page 410: Extension Module Io

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. ipaddress <ip address> The ipaddress of the receiving camera. username string[64] The username of the receiving camera. passwd string[64] The password of the receiving camera. port 0~65535 The connection port to the receiving camera.

  • Page 411: Focussystem

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) connected <Boolean> Indication if extension module IO is connected. 7.56 Focussystem Group: focussystem_c<0~(n‐1)> (capability_image_c<0~(n-1)>_remotefocus > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) autofocus_enablebyzoom <Boolean> To allow the feature of auto focus when zoom is operated.
  • Page 412 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) focusshift_night_lastdate <blank>, A recorded UTC time when IR offset value <YYYY/MM/DD is saved during night mode. HH:MM:SS> <blank>: IR offset value hasn't been saved before. User's Manual - 410...

  • Page 413: Useful Functions

    VIVOTEK 8. Useful Functions 8.1 Drive the Digital Output (capability_ndo > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/setdo.cgi?do0=<value> [&do1=<value>] [&do2=<value>][&do3=<value>] Where state is 0 or 1; “0” means inactive or normal state, while “1” means active or triggered state, and trigger time is indicated in seconds.

  • Page 414: Query Status Of The Digital Output (Capability_Ndo > 0)

    VIVOTEK Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <length>\r\n \r\n [di0=<state>]\r\n [di1=<state>]\r\n [di2=<state>]\r\n [di3=<state>]\r\n where <state> can be 0 or 1. Example: Query the status of digital input #1 . Request: http://myserver/cgi- bin/dido/getdi.cgi?di0 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content- Length: 7\r\n \r\n di0=1\r\n...

  • Page 415: Capture Single Snapshot

    VIVOTEK [do1=<state>]\r\n [do2=<state>]\r\n [do3=<state>]\r\n where <state> can be 0 or 1. Example: Query the status of digital output #1. Request: http://myserver/cgi- bin/dido/getdo.cgi?do0 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content- Length: 7\r\n \r\n do0=1\r\n 8.4 Capture Single Snapshot Note: This request requires Normal User privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/video.jpg?[channel=<value>][&resolution=<value>]...

  • Page 416: Account Management

    VIVOTEK PARAMETER VALUE DESCRIPTION quality The quality of the image. streamid 0~( capability_nmediastream -1) The stream number. Default: Returns snapshot of maxmum resolution for current channel. The server will return the most up-to-date snapshot of the selected channel and stream in JPEG format.
  • Page 417 VIVOTEK PARAMETER VALUE DESCRIPTION username <name> The name of the user to add, delete, or edit. userpass <value> The password of the new user to add or that of the old user to modify. The default value is an empty string. privilege view The privilege of the user to add or to modify.

  • Page 418: Upgrade Firmware

    VIVOTEK ERROR: Update user's privilege fail! 8.6 Upgrade Firmware Note: This request requires Administrator privileges. Method: POST Syntax: http://<servername>/cgi-bin/admin/upgrade.cgi Post data: fimage=<file name>[&return=<return page>]\r\n \r\n <multipart encoded form data> Server will accept the file named <file name> to upgradethe firmware and return with <return page>...

  • Page 419: Eptz Camera Control

    VIVOTEK 8.7 ePTZ Camera Control (capability_eptz > 0 and Capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eCamCtrl.cgi?channel=<value>&stream=<value> [&move=<value>] – Move home, up, down, left, right [&auto=<value>] – Auto pan, patrol [&zoom=<value>] –Zoom in, out [&zooming=<value>&zs=<value>] –Zoom without stopping, used for joystick [&x=<value>&y=<value>&w=<value>&h=<value>&resolution=<value>] - Zoom in, out on a specific area [&vx=<value>&vy=<value>&vs=<value>] –...
  • Page 420 VIVOTEK b. continuous movement - If you trigger a continuous movement, you have to handle the stop time by yourself. A continuous movement is convenient to integrate a joystick control. http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=tele&zs=1 http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed. To stop a continuous movement, you have to use the command as below: http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zoom=stop&zs=0 2.
  • Page 421 VIVOTEK PARAMETER VALUE DESCRIPTION <integer> movement <integer> The scaled area size <integer> resolution <window size> The resolution of streaming. <integer> The direction of movement, used for joystick control. <integer> 0 ~ 7 Set the speed of movement, “0” means stop. <integer>...

  • Page 422: Eptz Recall (Capability_Eptz > 0 And Capability_Fisheye = 0)

    VIVOTEK 8.8 ePTZ Recall (capability_eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eRecall.cgi?channel=<value>&stream=<value>& recall=<value>[&return=<return page>] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source. stream <0~(m-1)> Stream. recall Text string less than One of the present positions to recall.

  • Page 423: Ip Filtering For Onvif

    VIVOTEK PARAMETER VALUE DESCRIPTION addpos <Text string less than Add one preset location to the preset list. 40 characters> delpos <Text string less than Delete preset location from the preset list. 40 characters> return <return page> Redirect to the page <return page> after the parameter is assigned.

  • Page 424: Event/Control Http Tunnel Channel

    VIVOTEK Syntax: http://<servername>/cgi-bin/operator/uartchannel.cgi?[channel=<value>] ------------------------------------------------------------------------- GET /cgi-bin/operator/uartchannel.cgi?[channel=<value>] x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------- POST /cgi-bin/operator/uartchannel.cgi x- sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache cache-control : no-cache content-length: 32767 expires: Sun, 9 Jam 1972 00:00:00 GMT User must use GET and POST to establish two channels for downstream and upstream. The x- sessioncookie in GET and POST should be the same to be recognized as a pair for one session.

  • Page 425: Get Sdp Of Streams

    VIVOTEK ------------------------------------------------------------------------- GET /cgi-bin/admin/ctrlevent.cgi x- sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------- POST /cgi-bin/admin/ ctrlevent.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache cache-control : no-cache content-length: 32767 expires: Sun, 9 Jam 1972 00:00:00 GMT User must use GET and POST to establish two channels for downstream and upstream. The x- sessioncookie in GET and POST should be the same to be recognized as a pair for one session.

  • Page 426: Open The Network Stream

    VIVOTEK network_rtsp_s2_accessname = live2s1.sdp network_rtsp_s3_accessname = live2s2.sdp etc. * For version number(httpversion) above 0311c, the default RTSP access name format is “live<n>s<m>.sdp”. Please refer to the “subgroup of network: rtsp” for setting the accessname of SDP. * You can get the SDP by HTTP GET. * When using scalable multicast, Get SDP file which contains the multicast information via HTTP.

  • Page 427: Storage Managements (Capability_Storage_Dbenabled > 0)

    VIVOTEK data <hex decimal The <hex decimal data> is a series of digits from 0 ~ 9, A ~ data>[,<hex decimal F. Each comma separates the commands by 200 data>] milliseconds. flush yes,no yes: Receive data buffer of the COM port will be cleared before read.
  • Page 428 VIVOTEK Command: search PARAMETER VALUE DESCRIPTION label <integer primary key> Optional. The integer primary key column will automatically be assigned a unique integer. triggerType <text> Optional. Indicate the event trigger type. Please embrace your input value with single quotes. Ex. triggerType=’vi’ mediaType <text>...
  • Page 429 VIVOTEK PARAMETER VALUE DESCRIPTION limit <positive integer> Optional. Limit the maximum number of returned search records. offset <positive integer> Optional. Specifies how many rows to skip at the beginning of the matched records. Note that the offset keyword is used after limit keyword. To increase the flexibility of search command, you may use “OR”...
  • Page 430 VIVOTEK http://<servername>/cgi-bin/admin/downloadMedias.cgi?type=<type>[&<parameter>=<value>…] PARAMETER VALUE DESCRIPTION type <text> Required command to be excuted include videoclip device <text> command to be excuted include sd, nas recordingtoken <text> Please refer to Edge Storage API starttime <text> Optional. Format is “YYYY-MM-DD HH:MM:SS” Please embrace your input value with single quotes. Example: starttime=2008-01-01 00:00:00 Notice: you should use UTC time...

  • Page 431: Virtual Input (Capability_Nvi > 0)

    VIVOTEK 8.17 Virtual Input (capability_nvi > 0) Note: Change virtual input (manual trigger) status. Method: GET Syntax: http://<servername>/cgi-bin/admin/setvi.cgi?vi0=<value>[&vi1=<value>][&vi2=<value>] [&return=<return page>] PARAMETER VALUE DESCRIPTION vi<num> state[(duration)nstate] Ex: vi0=1 Where "state" is 0, 1. “0” Setting virtual input 0 to trigger state means inactive or normal state while “1”...

  • Page 432: Open Timeshift Stream

    VIVOTEK setvi.cgi?vi0=0(15000)1 setvi.cgi?vi0=1 Request 2 will not be accepted during the execution time(15 seconds). 8.18 Open Timeshift Stream (capability_timeshift > 0, timeshift_enable=1, timeshift_c<n>_s<m>_allow=1) Note: This request requires Viewer access privileges. Syntax: For HTTP push server (MJPEG): http://<servername>/<network_http_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&reft ime=<value>&forcechk&minsft=<value>] For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player. rtsp://<servername>/<network_rtsp_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&refti me=<value>&forcechk&minsft=<value>] “n”...

  • Page 433: Remotefocus

    VIVOTEK PARAMETER VALUE DEFAULT DESCRIPTION reftime mm:ss The time Reference time for maxsft and minsft. camera (This provides more precise time control to eliminate receives the the inaccuracy due to network latency.) request. Ex: Request the streaming from 12:20 rtsp://10.0.0.1/live.sdp?maxsft=10&reftime=12:30 forcechk Check if the requested stream enables timeshift, feature and if minsft is achievable.
  • Page 434 VIVOTEK PARAMETER VALUE DESCRIPTION function zoom, zoom - Move focus motor focus – Move focus motor focus, auto, auto – Perform auto focus scan, scan – Perform focus scan stop – Stop current operation stop, positioning, positioning – Position the motors irisopen, irisopen –...

  • Page 435: Backfocus (Capability_Image_C<0~(N-1)>_Remotefocus=4)

    VIVOTEK function getstatus Information of motors, return value as below: remote_focus_zoom_motor_max: Maximum steps of zoom motor remote_focus_focus_motor_max: Maximum steps of focus motor remote_focus_zoom_motor_start: Start point of zoom motor remote_focus_zoom_motor_end: End point of zoom motor remote_focus_focus_motor_start: Start point of effective focal length remote_focus_focus_motor_end: End point of effective focal length...
  • Page 436 VIVOTEK PARAMETER VALUE DESCRIPTION function focus, focus – Move focus motor auto – Perform auto focus auto, scan, scan – Perform focus scan stop, stop – Stop current operation positioning, positioning – Position the motors irisopen, resetfocus – reset focus position to default irisenable, irisopen –...

  • Page 437: Export Files

    VIVOTEK function getstatus Information of motors, return value as below: remote_focus_focus_motor_max: Maximum steps of focus motor remote_focus_focus_motor_start: Start point of effective focal length remote_focus_focus_motor_end: End point of effective focal length remote_focus_focus_motor: Current position of focus motor remote_focus_focus_enable: Current function of focus motor remote_focus_iris_open: The current status of iris.

  • Page 438: Upload Files

    VIVOTEK currentlanguage 0~20 Available language lists. Please refer to: system_info_language_i0 ~ system_info_language_i19 For setting backup file: http://<servername>/cgi-bin/admin/export_backup.cgi?backup 8.22 Upload Files Note: This request requires Administrator privileges. Method: POST Syntax: For daylight saving time configuration file: * This CGI is not supported when the version number (httpversion) is equal or greater than 0314b, please use “system_tz”...

  • Page 439: Update Lens Configuration (Capability_Image_C<0~(N-1)>_Lensconfiguration_Support > 0)

    VIVOTEK Server will accept the file named <file name> to upload this one to camera. 8.23 Update Lens Configuration (capability_image_c<0~(n‐ 1)>_lensconfiguration_support > 0) Note: This request requires Administrator privileges. Method: GET Syntax: For list a name of lens currently used: http://<servername>/cgi-bin/admin/update_lens.cgi?get_currentlens For list all names of lens installed in camera: http://<servername>/cgi-bin/admin/update_lens.cgi?list_lens...

  • Page 440: Media On Demand (Capability_Localstorage.modnum > 0)

    VIVOTEK For upload user-defined lens configuration: http://<servername>/cgi-bin/admin/update_lens.cgi?upload_lens Post data: upload_lens_profile_input = <file name>\r\n \r\n <multipart encoded form data> Server will accept the file named <file name> to upload the lens profile to camera. 8.24 Media on Demand (capability_localstorage.modnum > 0) Media on demand allows users to select and receive/watch/listen to metadata/video/audio contents on demand.
  • Page 441 VIVOTEK Play recordings for length seconds which ends at etime rtsp://10.10.1.2/mod.sdp?etime=20110312_040400.000&length=120 Play file file rtsp://10.10.1.2/mod.sdp?filename=/mnt/link0/ 439 - User's Manual...

  • Page 442: Privacy Mask (Capability_Image_C<0~(N-1)>_Privacymask_Wintype

    VIVOTEK 8.25 3D Privacy Mask (Capability_image_c<0~(n‐ 1)>_privacymask_wintype = 3Drectangle) n denotes the value of "capability_nvideoin" Note: This request requires admin user privilege Method: GET/POST Syntax: http://<servername>/cgi- bin/admin/setpm3d.cgi?method=<value>&maskname=<value>&[maskhei ght=<value>&maskwidth=<value>&videosize=<value>&return=<return page>] PARAMETER VALUE DESCRIPTION method Add a 3D privacy mask at current location delete Delete a 3D privacy mask edit...

  • Page 443: Camera Control

    VIVOTEK 8.26 Camera Control (capability_camctrl_c<0~(n‐1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/camctrl/camctrl.cgi?[channel=<value>][&camid=<value>] [&move=<value>] – Move home, up, down, left, right [&focus=<value>] – Focus operation [&zoom=<value>] – Zoom in, out [&zooming=<value>&zs=<value>] – Zoom without stopping, used for joystick [&vx=<value>&vy=<value>&vs=<value>] –...
  • Page 444 VIVOTEK PARAMETER VALUE DESCRIPTION down Move camera down. left Move camera left. right Move camera right. speedpan -5 ~ 5 Set the pan speed. speedtilt -5 ~ 5 Set the tilt speed. speedzoom -5 ~ 5 Set the zoom speed. speedfocus -5 ~ 5 Set the focus speed.
  • Page 445 VIVOTEK PARAMETER VALUE DESCRIPTION focus auto Auto focus. Focus on further distance. near Focus on closer distance. focusseting sync Applies the selected focus mode in camctrl_c<0~(n-1)>_focusmode to this preset. fixcurrent Applies the current focus position to this preset. * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20.
  • Page 446 VIVOTEK PARAMETER VALUE DESCRIPTION getpanangle <integer> Get the current pan angle. *Only available when bit0 of "capability_camctrl_c<0~(n- 1)>_buildinpt" is "1" gettilt 0, <positive integer> Get the current tilt position. *Only available when bit1 of "capability_camctrl_c<0~(n- 1)>_buildinpt" is "1" gettiltangle <integer> Get the current tilt angle.

  • Page 447: Recall (Capability_Camctrl_C<0~(N-1)>_Zoommodule = 1)

    VIVOTEK PARAMETER VALUE DESCRIPTION "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmintiltangle <integer> Get the lower limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n- 1)>_buildinpt" is "1" getmaxtiltangle <integer> Get the upper limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n- 1)>_buildinpt"...

  • Page 448: Preset Locations

    VIVOTEK 8.28 Preset Locations (capability_camctrl_c<0~(n‐1)>_zoommodule = 1) Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/preset.cgi?[channel=<value>] [&addpos=<value>][&delpos=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION addpos string[30] Add one preset location to the preset list. channel 0~"capability_nvideoin"-1 Channel of the video source. delpos string[30] Delete preset location from preset list.

  • Page 449: Connect To Ap (Capability_Network_Wireless > 0)

    VIVOTEK PARAMETER VALUE DESCRIPTION function getstatus Function type getstauts : Information of smartSD internal status return value as below: smartsd_lifetime_num: Accumulated amount of data that has been written smartsd_lifetime_den: Card-guaranteed amount of data that can be written smartsd_lifetime_rate: The ratio of smartsd_lifetime_num to smartsd_lifetime_den.

  • Page 450: Get Wireless Information

    VIVOTEK Syntax: http://<servername>/cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION Apply the wireless settings and connect to AP. 8.31 Get Wireless Information (capability_network_wireless > Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/getwirelessinfo.cgi PARAMETER VALUE DESCRIPTION Get wireless information. Camera will return following information.

  • Page 451: Wps Transaction (Capability_Network_Wireless > 0)

    VIVOTEK PARAMETER VALUE DESCRIPTION Get wireless signal strength. 8.33 WPS Transaction (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/start_wps.cgi PARAMETER VALUE DESCRIPTION Start WPS transaction. 8.34 Peripheral Control (capability_peripheral_c<0~(n‐1)>_ devicecontrol > 0) Note: This request requires Administrator privileges. Method: GET/POST (for control API) Syntax:...
  • Page 452 VIVOTEK "washer_mode : OK\r\n" "washer_status : FAIL\r\n" PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. washer_mode wiper Apply the wiper to the mode of washer control system. washer Apply the washer to the mode of washer control system. washer_status Enable the functionality of washer control system.
  • Page 453 VIVOTEK Pragma: no-cache\r\n \r\n supportdevice=washer,heater\r\n washer_status=off\r\n PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. supportdevice Get support peripheral device. washer_supportmode N/A Get the support mode of washer control system. washer_mode Get the current mode of washer control system. It return the value of "washer_mode"...

  • Page 454: Device Monitor (Capability_Peripheral_C<0~(N-1)

    VIVOTEK 8.35 Device monitor (capability_peripheral_c<0~(n‐1)>_ devicemonitor_support > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/devicemonitor.cgi PARAMETER VALUE DESCRIPTION Return a status overview of all sensors and peripheral devices on camera. Response: devicemonitor_tempsensor_iX_name: the name of temperature sensor devicemonitor_tempsensor_iX_celsius: Current Celsius temperature of the sensor devicemonitor_tempsensor_iX_fahrenheit: Current...

  • Page 455: Optimized Ir Control

    VIVOTEK http://myserver/cgi-bin/admin/devicemonitor.cgi Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n devicemonitor_tempsensor_i0_name=front glass devicemonitor_tempsensor_i0_celsius=30 devicemonitor_tempsensor_i0_fahrenheit=86 devicemonitor_heater_i0_name=front glass devicemonitor_heater_i0_status=off 8.36 Optimized IR control (capability_daynight_c<0~(n‐1)>_optimizedir > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/optimizedir.cgi?function=<value>[&channel=<value>] PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. 453 - User's Manual...
  • Page 456 VIVOTEK PARAMETER VALUE DESCRIPTION function getstatus, "onetimeauto": Camera will automatically adjust the IR onetimeauto zone one time only. "getstatus": Information of optimized IR control status and return value as below: optimizedir_c<0~(n‐1)>_irmode: Indicate the IR current mode, available value is “auto” and “manual”...
  • Page 457 VIVOTEK PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. operation set, "set": set the strength of each IR LED separately settoall "settoall": use fixed strength for all IR LED irmode auto, Irmode needs to be set as manual for adjusting IR manual LED strength.
  • Page 458 VIVOTEK http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&irmode=auto&strength= 50,70,50,50,50 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: Parameter "irmode" must be set as "manual"! Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&strength=50,70,50,50,50 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: Must have the "irmode=manual" argument! Syntax: (for query API) http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=get [&support_irmode] –...

  • Page 459: Lens Thermal Control

    VIVOTEK http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=get&irmode Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irmode='auto'" 8.37 Lens Thermal Control (capabiltiy_image_c<0~(n‐1)>_sensortype=thermalsensor) Note: This request requires Administrator privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/admin/thermalctrl.cgi?operation=set &action=<value> Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate...

  • Page 460: Audio Clip Control (Capability_Audio_Audioclip=1)

    VIVOTEK Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: fail PARAMETER VALUE DESCRIPTION action shuttercompensate Camera will do shutter compensate. Syntax: (for query API) http://<servername>/cgi-bin/admin/thermalctrl.cgi?operation=get&version=<value> PARAMETER VALUE DESCRIPTION version Indicate lensctrl thermal version Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=get&version Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n...

  • Page 461: Format Sd Card

    VIVOTEK http://<servername>/cgi-bin/admin/audioclip.cgi?operation=<value>[&name=<value>][&index=<value>] PARAMETER VALUE DESCRIPTION "startrecording" = Record a new audio clip. operation startrecording, stoprecording, "stoprecording" = Stop an ongoing recording. play, "play" = Play an audio clip. stopplayback, "stopplayback" = Stop to playback of an audio remove, clip. download "remove"...
  • Page 462 VIVOTEK If the user requests include an invalid parameter value, we will use the default value. PARAMETER VALUE DESCRIPTION operation Set formatting parameters and start formatting fat32: High compatibility for PC, but fstype fat32, ext4 low stability for Data ext4 : Low compatibility for PC, but high stability for Data.
  • Page 463 VIVOTEK Get formatting progress(0~100) or result(error message) *It is unnecessary when using the blocking mode. Example: Request of get formatting progress(0~100): http://myserver/cgi-bin/admin/format_sdcard.cgi?operation=get Response of success: HTTP/1.1 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <Success Message Length>\r\n \r\n <Success Message> List of success message: 0~100 and 100 represents formatting completed List of error message: ERROR: You cannot format an SD card repeatedly...

  • Page 464: Get Sdp For Always Multicast

    VIVOTEK “n” is the maximum stream profile number (capability_media_streamprofiles_num)  “streamprofile_i<x>_token” is the unique identifier for each profile, x is within  0~(capability_media_streamprofiles_num)-1. port is the rtsp port.  Please refer to the streamprofile group for requesting the stream profile token value for each profile.

  • Page 465: Accessing Sftp Server And Client

    VIVOTEK Please refer to the streamprofile group for requesting the stream profile name value for each profile. You can get the SDP by HTTP GET. When using scalable multicast, Get SDP file which contains the multicast information via HTTP. PARAMETER VALUE DESCRIPTION pimssm 1: Enable the feature of Protocol...
  • Page 466 VIVOTEK POST and “content-type: multipart/form-data”. HTTP headers with its name=”parameter” or name=” uploadKeyFile” will be describing the request body, see examples below. * Required when operation=manualmode address <sftp server address or sftp server address or hostname hostname> * This field is required. port <sftp port>...
  • Page 467 VIVOTEK keytype ed25519, rsa, ecdsa "ed25519": faster to generate with higher security level, some old server might not support. "rsa": slower to generate with slightly lower security level than ed25519. "ecdsa": low security level. A keytype will be automatically selected if the parameter is not provided.
  • Page 468 VIVOTEK Accept: text/html, application/xhtml+xml, */* Accept- Language: zh-TW User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; rv:11.0) like Gecko Content- Type: multipart/form-data; boundary=---------------------------7e1309282ed0f1a Accept-Encoding: gzip, deflate Host: 172.16.219.217 Content-Length: 6123 Connection: Keep-Alive Pragma: no-cache Cookie: webptzmode=continuous; activatedmode=digital; g_mode=1; viewsizemode=Auto; 4x3=false; lan=8 Authorization: Basic cm9vdDpGREQwMDAwMA== -----------------------------7e1309282ed0f1a Content- Disposition: form-data;...
  • Page 469 VIVOTEK IjSd+RMqL3yCFzM0aqcQNjd77nDP6+u9RYYyGT8dH5ud7pJVofxI+pvpQN3k5Tlb Pm9IM6OJPDy/Netcu6YEl3ULa6XHkYldqezJDnUfCBHe3OKjhue2FTBRmM2/j9Zl DkUrO7lQz7X88T/w5+rI2OnDIm3szOhzMCYPtHxf8ygMKXI/DKp3OR2/cu6ayGhb DezpoSyTjL1fTFINQAymDtP5tbomfESjFDW1fmfD9h1FivqYEy7017djPWrq8mjH N6nAhlaLVVuTVJ+xxaJAzYiQwMdwWY8SGUq062ksDvfixYCQfhXUd629oEX82fJU 8OxF8CM0WEHFCIotJVbFjDyT5lP4qln5EMeMlPE8jrmUKEEV+AJw9AbaqvCYUNaH EVZ7nlYjrnQqMCktYlO/Um8vSiVsOaMFLUdiYJwj2pzyceTzyW19/KEo//8ufOFD LaSp5EGH6lBCTBfQ9PGeOkB2ZVf0jLFB9Sage8Ln5frWYOAROxzumUJWSvOoBael 15OdV5hApqQjGrn1vbc/kC8p478ZCzx2iDyckPqyVpHSke70T5bV6vcDZcCTrwkA PHdD4Q0cqd7sX0R2OAScwJk2AkaQ+PsLwS05hw1nQBsQrC4m9e8Kmg32RgCGDAES xpV9dkSkvoaLZmN1qfBwnyOxsjmx9OAOBKWzMlW5PoPCR9z8Z1gsiACBnrT+K5ec NZdgsxvxMfdI7vfj6mkO89MvwLX8YEtnFrihIZmDnnVMuHfq6g5kbwlHbHVaoImo -----END RSA PRIVATE KEY----- -----------------------------7e1309282ed0f1a-- Syntax: (for query API) http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=<value>[&parameter=<value>] PARAMETER VALUE DESCRIPTION " getserverhostkey ": Auto scan operation getserverhostkey SFTP server host key. * This field is required. address <sftp server address or hostname>...

  • Page 470: Sftp Server Setting

    VIVOTEK <MD5 value> 8.40.2 SFTP Server Setting * Only available when bit 1 of "capability_protocol_ftp_server" is 1. (for control API) Syntax: http://<servername>/cgi-bin/admin/sftpserver.cgi?operation=<value> PARAMETER VALUE DESCRIPTION operation updatehostkey "updatehostkey": Re-generate host key for SFTP server. * It might take several seconds to generate key, you can use “gethostkey”...
  • Page 471 VIVOTEK finished, you will receive error message. Example of get host key: Request: http://<servername>/cgi-bin/admin/sftpserver.cgi?operation=gethostkey Response of success HTTP/1.1 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <Success Message Length>\r\n \r\n MD5:a5:8a:7d:e2:2a:f8:c9:a0:ee:93:93:b8:0a:7a:18:97 (RSA) MD5:7a:f4:07:48:e3:70:d5:89:15:36:6f:d5:25:f2:7e:0d (ED25519) <End of document> 469 - User's Manual...

  • Page 472: Technology License Notice

    VIVOTEK Technology License Notice AMR-NB Standard THIS PRODUCT IS LICENSED UNDER THE AMR-NB STANDARD PATENT LICENSE AGREEMENT. WITH RESPECT TO THE USE OF THIS PRODUCT, THE FOLLOWING LICENSORS’ PATENTS MAY APPLY: TELEFONAKIEBOLAGET ERICSSON AB: US PAT. 6192335; 6275798; 6029125; 6424938; 6058359. NOKIA CORPORATION: US PAT.

  • Page 473: Electromagnetic Compatibility (Emc)

    VIVOTEK Electromagnetic Compatibility (EMC) FCC Statement This device compiles with FCC Rules Part 15. Operation is subject to the following two conditions. ■ This device may not cause harmful interference, and ■ This device must accept any interference received, including interference that may cause undesired operation.

This manual is also suitable for:

Vivotek ib9365-ehtv-v2

Table of Contents