Delta Vivotek IB9391-EHTV-v2 User Manual

Delta Vivotek IB9391-EHTV-v2 User Manual

Bullet network camera
Hide thumbs Also See for Vivotek IB9391-EHTV-v2:

Advertisement

Quick Links

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
Network Camera
Rev. 1.0

Advertisement

Table of Contents
loading

Summary of Contents for Delta Vivotek IB9391-EHTV-v2

  • Page 1 IB9391-EHTV-v2 Bullet IB9365-EHTV-v2 Network 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 ..................................Revision History ..............................4 Read Before Use ..............................4 Package Contents ..............................7 Symbols and Statements in this Document ......................7 Physical Description .............................. 8 Hardware Installation ............................11 Software Installation ............................. 28 Network Deployment ............................35 Ready to Use ................................
  • Page 3: Overview

    VIVOTEK Applications > Shock detection ....................... 162 Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) ... 163 Recording > Recording settings ......................166 Storage ..............................171 Storage > SD card management ......................171 Storage > NAS management ........................172 Storage >...
  • Page 4: Revision History

    VIVOTEK Revision History ■ Rev. 1.0: Initial release. 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 5 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 6 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 7: 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 Guid e. ■ T20 wrench. . WARNING: 1. IR lights emit from ths product. 2.
  • Page 8: 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 9 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 - 9...
  • Page 10 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 100~240V LAN/PoE GE LAN...
  • Page 11: 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 are automatically collected by the onboard S-sensor.
  • Page 12 VIVOTEK 2. Use the alignment sticker to drill holes on the wall. If the use of an 1/2" conduit pipe is preferred, refer to the Installation option A. 12 - User's Manual...
  • Page 13 VIVOTEK 3. Route cables through the wall or ceiling, and remove the grommet on the base plate. 4. Remove the tip of the silicon grommet. Insert the RJ45 connector of your Ethernet cable into the penetration cap. 5 ~ 8mm User's Manual - 13...
  • Page 14 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. 14 - User's Manual...
  • Page 15 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 16 VIVOTEK 9. Below are the pinouts of the I/O combo cable. If you prefer more audio, DC, and I/ O connections, you can purchase and install an extension kit. Refer to the installation option B section for more information. DI-: Yellow icro icro DI1+: Blue...
  • Page 17 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 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 18 VIVOTEK Dry contact and using camera’s DO+ to supply a relay. Switch External AC power with Protected Earth Relay External Device 18 - User's Manual...
  • Page 19 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. User's Manual - 19...
  • Page 20 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 21 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 User's Manual - 21...
  • Page 22 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 23 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. User's Manual - 23...
  • Page 24 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 25 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 User's Manual - 25...
  • Page 26 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 26 - User's Manual...
  • Page 27 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 CONN 2 12 pin CONN 1 10 pin DI-: Green/W DO+(12V): Purple...
  • Page 28: Software Installation

    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 locate the utility in the Downloads > Software page. 22-1.
  • Page 29 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 30 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. Since your camera is used for the first time, there is no password. Enter “root” as the user name, and nothting for the password.
  • Page 31 VIVOTEK Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~. You can use them in the password combination. 23-3. Another prompt will request for the password you just configured. Enter the password and then you can start configure your camera and see the live view.
  • Page 32 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 33 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 34 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 35: Network Deployment

    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 sin- gle Ethernet cable. Follow the below illustration to connect the Network Camera to a PoE- enabled switch via Ethernet cable.
  • Page 36: 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 37 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 38 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 39: Accessing The Network Camera

    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 Installation Wizard 2 (IW2) to access the Network Cameras on LAN. If your network environment is not a LAN, follow these steps to access the Netwotk Camera: ®...
  • Page 40 VIVOTEK ® ► If you see a dialog box indicating that your security settings prohibit running ActiveX Controls, please enable the ActiveX ® Controls for your browser. 1. Choose Tools > Internet Options > Security > Custom Level. ® 2. Look for Download signed ActiveX controls;...
  • Page 41 VIVOTEK IMPORTANT: • Currently the Network Camera utilizes a 32-bit ActiveX plugin. You CAN NOT open a management/view session to the camera using a 64-bit IE browser. • If you encounter this problem, try execute the Iexplore.exe program from C:\Windows\ SysWOW64.
  • Page 42: 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. pvPlayer 2. Choose File > Open URL. A URL dialog box will pop up. 3.
  • Page 43: Using 3Gpp-Compatible Mobile Devices

    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 44: Using Vivotek Recording Software

    VIVOTEK Using VIVOTEK Recording Software You can download a VAST recording software, 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 45: Main Page

    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 46 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 47 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 48 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 49 VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Time 2019/01/25 17:08:56 Video (HTTP-V) Title and Time Video 17:08:56 2019/01/25 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 74.
  • Page 50: Client Settings

    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 51 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 52 VIVOTEK Joystick settings Enable Joystick Connect a joystick to a USB port on your management computer. Supported by the plug-in (Microsoft’s DirectX), once the plug-in for the web console is loaded, it will automatically detect if there is any joystick on the computer. The joystick should work properly without installing any other driver or software.
  • Page 53 VIVOTEK Buttons Configuration In the Button Configuration window, the left column shows the actions you can assign, and the right column shows the functional buttons and assigned actions. The number of buttons may differ from different joysticks. Please follow the steps below to configure your joystick buttons: 1.
  • Page 54 VIVOTEK Buttons Configuration Click the Configure Buttons button, a window will prompt as shown below. Please follow the steps below to configure your joystick buttons: 1. Select a button number from the Button # pull-down menu. Tips: If you are not sure of the locations of each button, use the Properties window in the Game Controllers utility.
  • Page 55: 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 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 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 57 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 58 VIVOTEK Western Argentina Summer Time (WARST) is 3 hours behind the prime meridian all year. There is a dummy fall-back 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 59: System > Homepage Layout

    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 hompage 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 60 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 61 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 62: 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 63 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. VIVOTEK Network Cameras Internet 3G Cell phone...
  • Page 64 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 65: 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. User's Manual - 65...
  • Page 66: System > Maintenance

    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 67 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 68 VIVOTEK The following message is displayed when attempting to upload an incorrect file format. 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 69: 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 70 VIVOTEK Video orientation: Flip - vertically reflect the display of the live video; Mirror - horizontally reflect the display of the live video. Select both options if the Network Camera is installed upside-down (e.g., on the ceiling) to correct the image orientation. Please note that if you have preset locations, those locations will be cleared after flip/mirror setting.
  • Page 71 VIVOTEK 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. ■ Auto mode (The Day/Night Exposure Profile will not be available if Auto mode is selected) The Network Camera automatically removes the filter by judging the level of ambient light.
  • Page 72 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 73 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 an “Exposure Exclude” window on an unavoidable object in the Exposure setting window. See page 72 for how to do it.
  • Page 74 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 75 VIVOTEK Hightlight 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 76 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 77 VIVOTEK Exposure On this page, you can set the Exposure measurement window, Exposure level, Exposure mode, Exposure time, Gain control, and Day/Night mode settings. You can configure two sets of Exposure settings: one for normal situations, the other for special situations, such as the day/night/schedule mode.
  • Page 78 VIVOTEK The inclusive window refers to the “weighted window“; the exclusive window refers to “ignored window“. It adopts the weighted averages method to calculate the value. The inclusive windows have a higher priority. You can overlap these windows, and, if you place an exclusive window within a larger inclusive window, the exclusive part of the overlapped windows will be deducted from the inclusive window.
  • Page 79 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 80 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 81 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 82 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 83 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 84 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 85 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 86: Media > Video

    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 the 3840 x 2160. ■...
  • Page 87: Media > Video

    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 Gloabl View window on the home page, will resize accordingly.
  • Page 88 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...
  • Page 89 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 90 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 91 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 92 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 93 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 94 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.
  • Page 95 VIVOTEK If the JPEG 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 96: Media > Audio

    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 97 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 98: Media Profiles

    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 99: 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 rememer to click on the Save button when you complete the Network setting.
  • Page 100 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. Secondary WINS server: The secondary WINS server that maintains the database of computer names and IP addresses.
  • Page 101 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 102 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 103 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. When IPv6 is enabled, by default, the network camera will listen to router advertisements and be assigned with a link-local IPv6 address accordingly.
  • Page 104 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: http://[2001:0c08:2500:0002:0202:d1ff:fe04:65f4]/ IPv6 address 4.
  • Page 105 VIVOTEK User's Manual - 105...
  • Page 106: 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 107 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 108 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 digest risks of it being intercepted.
  • Page 109 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 110 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 bandwith.
  • Page 111 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 112 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. Express link Express Link is a free service provided by VIVOTEK server, which allows users to register a domain name for a network device.
  • Page 113 VIVOTEK Manual setup DDNS: Dynamic domain name service Enable DDNS: Select this option to enable the DDNS setting. Provider: Select a DDNS provider from the provider drop-down list. VIVOTEK offers Safe100.net, a free dynamic domain name service, to VIVOTEK customers. It is recommended that you register Safe100.net to access VIVOTEK’s Network Cameras from the...
  • Page 114 VIVOTEK [Register] Successfully Your account information has been mailed to registered e-mail address 4. Select Enable DDNS and click Save to enable the setting. ■ CustomSafe100 VIVOTEK offers documents to establish a CustomSafe100 DDNS server for distributors and system integrators. You can use CustomSafe100 to register a dynamic domain name if your distributor or system integrators offer such services.
  • Page 115 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: Network > Snmp (Simple Network Management Protocol)

    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 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” account first.
  • Page 121 VIVOTEK Privilege management Digital Output & PTZ control: You can modify the management privilege as operators or viewers. Select or de-select the checkboxes, and then click Save to enable the settings. If you give Viewers the privilege, Operators will also have the ability to control the Network Camera through the main page. User's Manual - 121...
  • Page 122: Security > Https (Hypertext Transfer Protocol Over Ssl)

    VIVOTEK Security > HTTPS (Hypertext Transfer Protocol over SSL) This section explains how to enable authentication and encrypted communication over SSL (Secure Socket Layer). It helps protect streaming data transmission over the Internet on higher security level. Create and Install Certificate Method Before using HTTPS for communication with the Network Camera, a Certificate must be created first.
  • Page 123 VIVOTEK 5. Click Save to preserve your configuration, and your current session with the camera will change to the encrypted connection. 6. If your web session does not automatically change to an encrypted HTTPS session, click Home to return to the main page. Change the URL address from “http://” to “https://“ in the address bar and press Enter on your keyboard.
  • 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. 126 - 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 - 127...
  • Page 128 VIVOTEK Note that 11. When the certifice file is successfully loaded, its status will be stated as Active. a certificate must have been created and installed before you can click on the “Save" button for the configuration to take effect. 12.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 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 VIVOTEK Security > Miscellaneous The embedded TrendMicro utitlity 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 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. 138 - User's Manual...
  • Page 139: Event > Event Settings

    VIVOTEK Event > Event settings This section explains how to configure the Network Camera to respond to particular situations (event). A typical application is that when a motion is detected, the Network Camera sends buffered images to an FTP server or e-mail address as notifications. Click on Help, there is an illustration shown in the pop-up window explaining that an event can be triggered by many sources, such as motion detection or external digital input devices.
  • Page 140 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 141 VIVOTEK ■ Audio detection A preset threshold can be configured with an external microphone as the trigger to system event. The triggering condition can be an input exceeding or falling below a threshold. Audio detection can take place as a complement to motion detection or as a method to detect activities not covered by the camera's view.
  • Page 142 VIVOTEK Once the triggers are configured, they will be listed under the VADP option. 3. Action Define the actions to be performed by the Network Camera when a trigger is activated. ■ 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).
  • Page 143 VIVOTEK Add server It is necessary to configure the server and media settings so that the Network Camera will know what action to take (such as which server to send the media files to) when a trigger is activated. Click server to open the server setting window.
  • Page 144 VIVOTEK To verify if the email settings are correctly configured, click Test. The result will be shown in a pop-up window. If successful, you will also receive an email indicating the result. Click Save server to enable the settings. Note that after you configure the first event server, the new event server will automatically display on the Server list.
  • Page 145 VIVOTEK ■ Passive mode Most firewalls do not accept new connections initiated from external requests. If the FTP server supports passive mode, select this option to enable passive mode FTP and allow data transmission to pass through the firewall. The firmware default has the Passive mode checkbox selected.
  • Page 146 VIVOTEK If key authentication is not preferred, you can specify a username and password in the section below. An RSA key fingerprint will look like this: da:47:93:b4:3a:90:5b:50:1f:20:a8:f9:b7:a1:d0:e1. Verify if this is the SFTP server you want to connect to. ■ Folder name Enter the folder where the media file will be placed.
  • Page 147 VIVOTEK Publickey 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 Application Development Platform)

    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 To utilize a software module, acquire the software package and click Browse and Upload buttons. The screen message for a successful upload is shown below: 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 165 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. User's Manual - 165...
  • Page 166: 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 167 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 168 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 169 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 170 VIVOTEK Event f you want to enable recording notification, please click to configure event triggering settings. 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 171: 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 172: 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 173 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 174: 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 175 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 176 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 177: 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 178 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  An  example  of  this  is  the  description  of  the  name  for  the  server,  denoted with <servername> in the URL syntax description below, which is replaced with the string ...
  • Page 179 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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. The file extension .cgi is required.    Syntax:  http://<servername>/cgi‐bin/<subdir>[/<subdir>...]/<cgi>.<ext>  [?<parameter>=<value>[&<parameter>=<value>...]]    Example: Set digital output #1 to active  http://mywebserver/cgi‐bin/dido/setdo.cgi?do0=1    30  User's Manual - 179...
  • Page 180 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 4. Security Level  SECURITY LEVEL  SUB‐DIRECTORY  DESCRIPTION  0    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.  7    N/A  Internal APIs. Unable to be changed by any external  interfaces.    A viewer account can access all APIs with security level 0 and 1. An operator account can access all  APIs with security level 0, 1, or 4. An admin account can access all APIs except internal APIs.    Access  management  is  based  on  the  URL  directory  structure  and  is  described  in  following  paragraphs. ...
  • Page 181 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.    When querying parameter values, the current parameter values are returned.  A successful control request returns parameter pairs as follows:  Return:  HTTP/1.0 200 OK\r\n  Content‐Type: text/html\r\n  Context‐Length: <length>\r\n  \r\n  <parameter pair>  where<parameter pair> is    <parameter>=<value>\r\n ...
  • Page 182 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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    33  182 - User's Manual...
  • Page 183 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  <value>  The assigned <value> to the <parameter>.  <return page>  Redirect to the page <return page>after the <parameter> is assigned. The <return  page>can be a full URL path or relative path according to the current path. If you  omit this parameter, it will redirect to an empty page.    (Note: The return page can be a general HTML file (.htm, .html). It cannot be a CGI  command or have any extra parameters. This parameter must be placed at the end  of the parameter list. ...
  • Page 184 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved [<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    35  184 - User's Manual...
  • Page 185 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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‘*’ instead.  <integer>  Any single integer number in 32‐bits.  The range is ‐2147483648~2147483647.  <positive integer>  Any single positive integer number in 32‐bits.  The range is 1~ 4294967295.  <m> ~ <n>  Any number between ‘m’ and ‘n’.  domain name[<n>]  A string limited to a domain name shorter than ‘n’ characters (eg.  www.ibm.com).  email address [<n>]  A string limited to an email address shorter than ‘n’ characters (eg.  joe@www.ibm.com).  <ip address>  A string limited to an IP address (eg. 192.168.1.1).  <mac address>  A string limited to contain a MAC address without hyphens or colons.  <boolean>  A boolean value of 1 or 0 represents [Yes or No], [True or False], ...
  • Page 186 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  non‐valid  The API is listed in product WebAPIs, but is malfunction in this status.  <decimal>  Any decimal number expressed in 32‐bits ranging from  1.18e‐38~3.40e+38.  NOTE: The camera should not be restarted when parameters are changed.      7.1 System  Group: system  NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  hostname  string[64]  1/6 ...
  • Page 187 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  <blank>  timezoneindex  ‐489 ~ 529  6/6  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  ‐241: GMT‐06:00 Mexico City  ‐242: GMT‐06:00 Saskatchewan  ‐200: GMT‐05:00 Eastern Time, New  York, Toronto  ‐201: GMT‐05:00 Bogota, Lima, Quito,  Indiana  ‐180: GMT‐04:00 Caracas  ‐160: GMT‐04:00 Atlantic Time(Canada),  La Paz  ‐140: GMT‐03:30 Newfoundland  ‐120: GMT‐03:00 Brasilia, Buenos Aires, ...
  • Page 188 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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,  Tashkent  220: GMT 05:30 Calcutta, Chennai,  Mumbai, New Delhi  230: GMT 05:45 Kathmandu  240: GMT 06:00 Ekaterinburg, Almaty,  Astana, Dhaka, Sri Jayawardenepura  260: GMT 06:30 Rangoon  280: GMT 07:00 Bangkok, Hanoi,  Novosibirsk, Jakarta  320: GMT 08:00 Beijing, Chongqing,  Hong Kong, Kuala Lumpur, Singapore,  Taipei, Krasnoyarsk  360: GMT 09:00 Osaka, Sapporo, Tokyo,  Seoul  380: GMT 09:30 Adelaide, Darwin  400: GMT 10:00 Brisbane, Canberra, ...
  • Page 189 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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>  6/6  Enable automaticdaylight saving time in  time zone.  daylight_auto_begintim string[19]  6/7  Display the current daylight saving start  e  time.  daylight_auto_endtime  string[19]  6/7  Display the current daylight saving end  time.  daylight_timezones  ,‐360,‐320,‐28 6/7  List time zone index which support  0,‐240,‐241,‐2 daylight saving time.  00,‐140,‐121,‐...
  • Page 190 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  restoreexceptnet  0,  7/6  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.  restoreexceptdst  0,  7/6  Restore the system parameters to default  <positive  values except all daylight saving time  integer>  settings.  This command can cooperate with other  “restoreexceptXYZ” commands. When  cooperating with others, the system  parameters will be restored to default  values except for a union of combined ...
  • Page 191 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  restoreexceptfocusvalu 0,  7/6  Restore the system parameters to default  e  <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.  * Only available when  "capability_image_c<0~(n‐1)>_remotefo cus" != 0.  restoreexceptlen  0,  7/6  Restore the system parameters to default  <positive  values except    lens profile.  integer>  This command can cooperate with other ...
  • Page 192 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  serialnumber  <mac address>  1/7  12 characters MAC address (without  hyphens).  firmwareversion  string[40]  0/7  Firmware version, including model,  company, and version number in the  format:<MODEL‐BRAND‐VERSION>  language_count  <positive  0/7  Number of webpage languages available  integer>  on the server.  language_i<0~(count‐ string[16]  0/7  Available language lists.  1)>  language_i0 :  English  language_i1 :  Deutsch  language_i2 :  Español ...
  • Page 193 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  di_i<0~(k‐1)>  <boolean>  1/7  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,  * k=capability_ndi  do_i<0~(k‐1)>  <boolean>  1/7  0 => Inactive, normal  <product dependent>  1 => Active, triggered  (capability_ndo > 0)    k is determined by the below ...
  • Page 194 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  integer>  eth_i0  <string>  1/7  Get network information from  mii‐tool.  vi_i<0~(capability_nvi‐1)>  <boolean>  1/7  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  DESCRIPTION  (get/set)  signal_detect  <boolean>  1/7  Indicates whether the video source is ...
  • Page 195 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved   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  VALUE  SECURITY  DESCRIPTION  (get/set)  normalstate  open,  1/1  Indicate open circuit or closed circuit  grounded  (inactive status)    7.5 Security  Group: security  NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  privilege_do  view, operator,  1/6 ...
  • Page 196 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved   7.6 Network  Group: network  NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  preprocess  <positive integer>  6/6  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;    To stop service before changing its port  settings. It’s recommended to set this  parameter when change a service port  to the port occupied by another service  currently. Otherwise, the service may  fail.  Stopped service will auto‐start after  changing port settings.  Ex:  Change HTTP port from 80 to 5556, and  change RTP port for video from 5556 to  20480. ...
  • Page 197 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  0 => Use preset ipaddress, subnet,  rounter, dns1, and dns2.  ipaddress  <ip address>  6/6  IP address of server.  subnet  <ip address>  6/6  Subnet mask.  router  <ip address>  6/6  Default gateway.  dns1  <ip address>  6/6  Primary DNS server.  dns2  <ip address>  6/6  Secondary DNS server.  wins1  <ip address>  6/6  Primary WINS server.  wins2 ...
  • Page 198 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved   7.6.2 QOS  Subgroup of network: qos_cos (capability_protocol_qos_cos > 0)  NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  enable  <boolean>  6/6  Enable/disable CoS (IEEE 802.1p)  vlanid  1~4095  6/6  VLAN ID  video  0~7  6/6  Video channel for CoS  audio  0~7  6/6  Audio channel for CoS  <product dependent>  (capability_naudioin > 0)  eventalarm  0~7  6/6  Event/alarm channel for CoS  management  0~7 ...
  • Page 199 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved   7.6.4 FTP  Subgroup of network: ftp  NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  port  21, 1025~65535  6/6  Local ftp server port.  enable  <boolean>  6/6  Enable ftp.    7.6.5 HTTP  Subgroup of network: http  NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  port  80, 1025 ~  1/6  HTTP port.  65535  alternateport ...
  • Page 200 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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 string[32]  1/6  Http server push access name for  stream‐1)>_accessname    channel N and stream M, N= 1~  <product dependent>  capability_nvideoin, M= 1~  capability_nmediastream.  (capability_protocol_spush_mjpeg =1  and capability_nmediastream > 0)  The value are shown as ...
  • Page 201 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 65535    7.6.8 RTSP  Subgroup of network: rtsp (capability_protocol_rtsp > 0)  NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  port  554, 1025 ~ 65535  1/6  RTSP port.  (capability_protocol_rtsp=1)  authmode  disable,  1/6  RTSP authentication mode.  basic,  (capability_protocol_rtsp=1)  digest  s<0~(capability_nmed string[32]  1/6  RTSP access name for channel and  iastream*capability_n   stream.    videoin)‐1)>_accessna (capability_protocol_spush_mjpeg ...
  • Page 202 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  * We modify the value of RTSP  access name after version  number(httpversion) is 0311c  pimssm_enable  <boolean>  7/6  To enable the feature of Protocol  Independent Multicast ‐ Source  Specific Multicast.  * We support this parameter when  the version number (httpversion) is  equal or greater than 0313a.    7.6.9 RTSP Multicast ...
  • Page 203 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  * Reserved for compatibility, and suggest don't  use this since [httpversion] > 0304a  videoipaddress  <ip  4/4  Multicast video IP address.  address>  * We support this parameter when the version  number (httpversion) is equal or greater than  0304a.  audioipaddress  <ip  4/4  Multicast audio IP address.  <product  address>  * We support this parameter when the version  dependent>  number (httpversion) is equal or greater than  0304a.  * Only available when capability_naudioin > 0  metadataipaddres <ip  4/4  Multicast metadata IP address.  s  address> ...
  • Page 204 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  videoport  1025 ~ 65535  6/6  Video channel port for RTP.    audioport  1025 ~ 65535  6/6  Audio channel port for RTP.    metadataport  1025 ~ 65535  6/6  Metadata channel port for RTP.    7.6.12 PPPoE  Subgroup of network: pppoe (capability_protocol_pppoe > 0)  NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  user  string[128]  6/6  PPPoE account user name. ...
  • Page 205 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.7 IP Filter  Group: ipfilter  NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  enable  <boolean>  6/6  Enable access list filtering.  admin_enable  <boolean>  6/6  Enable administrator IP address.  admin_ip  string[43]  6/6  Administrator IP address.  maxconnection  1~  6/6  Maximum number of (s).  "capability_protoc ol_maxconnection"  type  0, 1  6/6  Ipfilter policy :  0 => allow  1 => deny ...
  • Page 206 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  after the version number (httpversion)  is equal or greater than 0400a.  whitebalance  auto,    4/4  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.  "rbgain": Use rgain and bgain to set  outdoor,  indoor,  white balance manually.  sodiumauto,  "manual": 2 cases:  etc  a. if "rbgain" is not supported, this   ...
  • Page 207 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  "capability_image_c<0~(n‐1)>_exposu re_mode" !=0  * 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.  irismode  fixed, indoor,  4/4  Control DC‐Iris mode.   ...
  • Page 208 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  after the version number (httpversion)  is equal or greater than 0400a.  enableblc  <boolean>  4/4  Enable backlight compensation.  <Not support  * Not support this parameter  anymore>  anymore when the version number  (httpversion) is equal or greater than  0301a.  * It's recommanded to use  "exposurewin_c<0~(n‐1)>_mode" to  switch on/off BLC.  color  0, 1  4/4  0 =>monochrome  1 => color  * Only available when "  capability_videoin_c<0~(n‐1)>_color_ support" is 1.  * We do not support this parameter  when "capability_nvideoin > 1".  * This parameter will not be used  after the version number (httpversion) ...
  • Page 209 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  1/7  A 32‐bit integer, each bit can be set  <Not support  integer>  separately as follows:  anymore>  Bit 0 => Support camera control  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 => Support focus operation;  0(not support), 1(support)(SD/PZ/IZ  series only) ...
  • Page 210 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  is equal or greater than 0400a.  minexposure  <1~32000>,  4/4  Minimum exposure time  <product dependent>  <5~32000>,  1~32000 => 1s ~ 1/32000s  <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  * Only available when  listed in  "capability_image_c<0~(n‐1)>_exposu "capability_image_ re_minrange" != "‐"  c<0~(n‐1)>_exposu * Only valid when  re_minrange"  "piris_mode"=manual or  "irismode"=fixed ...
  • Page 211 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  enablepreview  <boolean>  1/4  Usage for UI of exposure settings.  Preview settings of video profile.  * Only available when  "capability_image_c<0~(n‐1)>_exposu re_mode" !=0  * 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.    7.8.1 Video Input Setting per Channel ...
  • Page 212 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  "rbgain": Use rgain and bgain to set  outdoor,  indoor,  white balance manually.  sodiumauto,  "manual": 2 cases:      etc  a. if "rbgain" is not supported, this    means keep current white balance  (Available values are listed  status.  in  b. if "rbgain" is supported, "rgain" ...
  • Page 213 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY( DESCRIPTION  get/set)  bgain  0~100  4/4  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.  exposurelevel  0~12  4/4  Exposure level  "0,12": This range takes the concept  from DC's exposure tuning options.  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 ...
  • Page 214 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY( DESCRIPTION  get/set)  etc  with variable Shutter Speed, and keep    adjusting Iris, Gain automatically.  (Available options are list  "irispriority": Manually adjust with  in  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.  "manual": Manually adjust with  variable Shutter, Iris and Gain.  * We support this parameter when  the version number (httpversion) is  equal or greater than 0302a.  * Only available when  "capability_image_c<0~(n‐1)>_exposu re_mode" !=0  irismode  fixed, indoor, outdoor  4/4  Control DC‐Iris mode.    <product dependent> ...
  • Page 215 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  1/4  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" is "smartsensor"  * Only available when  "capability_image_c<0~(n‐1)>_iristype "=piris  enableblc  <boolean>  4/4  Enable backlight compensation  <Not support  * Not support this parameter  anymore>  anymore when the version number ...
  • Page 216 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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    or  "irismode"=fixed    * Normalized range.  * Only available when  "capability_image_c<0~(n‐1)>_exposu re_rangetype" is "twovalues".  gainvalue  0~100  4/4  Gain value.  0: Low <‐> 100: High  * Only available when  "capability_image_c<0~(n‐1)>_agc_m axgain" != "‐" and  "capability_image_c<0~(n‐1)>_exposu re_rangetype" is "onevalue".  * Normalized range.  * We support this parameter when  the version number (httpversion) is  equal or greater than 0302a. ...
  • Page 217 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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 => Support focus operation;  0(not support), 1(support)(SD/PZ/IZ  series only)  * Not support this parameter  anymore when the version number  (httpversion) is equal or greater than  0309a.  text  string[64]  1/4  Enclose caption.  imprinttimesta <boolean>  4/4  Overlay time stamp on video.  mp  textonvideo_p top, bottom  4/4 ...
  • Page 218 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY( DESCRIPTION  get/set)  in  "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>,  4/4  Maximum exposure time  <product  <5~32000>,  1~32000 => 1s ~ 1/32000s  dependent>  <1~8000>,  5~32000 => 1/5s ~ 1/32000s  <5~8000>,  1~8000 => 1s ~ 1/8000s  etc.  5~8000 => 1/5s ~ 1/8000s  * Available value is listed  etc.  in ...
  • Page 219 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY( DESCRIPTION  get/set)  * Available value is listed  * This parameter may also restrict  in  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.  * Only available when  "capability_image_c<0~(n‐1)>_exposu re_maxrange" != "‐" and  "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.  enablepreview  <boolean>  1/4  Usage for UI of exposure settings.  Preview settings of video profile.  * Only available when  "capability_image_c<0~(n‐1)>_exposu re_mode" !=0  meteringmode ...
  • Page 220 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY( DESCRIPTION  get/set)  zoomratiodispl <boolean>  1/4  Indicates multiple of zoom in is  ay  “on‐screen display” or not.  * We support this parameter when  the version number (httpversion) is  equal or greater than 0302a.  bracketing_lev 1~100  4/4  The total available lists   el  (capability_image_c<0~(n‐1)>_ex posure_bracketing_range) will be  normalized to 1~100 scale.  For example, the total available   list is 7. (2x,3x,4x,5x,6x,7x,8x)  1 ~ 14 that correspond with 2x.   15 ~ 30 that correspond with 3x.   *Only available when  "capability_image_c<0~(n‐1)>_exposu re_bracketing_mode"=1. ...
  • Page 221 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY( DESCRIPTION  get/set)  n‐1)>_maxresolution" and  "capability_videoin_c<0~( n‐1)>_minresolution"  s<0~(m‐1)>_s <boolean>  4/4  Enable "Smart fps" function.  martfps_enabl * Only available when  e  "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>  4/4  Enable "Dynamic intra frame period".  64_dintraperio * Only available when  d_enable  "capability_videoin_c<0~(n‐1)>_dintra period_support" is 1.  * We support this parameter when  the version number (httpversion) is  equal or greater than 0301c.  s<0~(m‐1)>_h2 250, 500, 1000, 2000, ...
  • Page 222 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  4/4  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.  s<0~(m‐1)>_h2 20000~"capability_videoin 4/4  The maximum allowed bit rate in fixed  64_maxvbrbitr _c<0~(n‐1)>_h264_maxbit quality mode.  ate  rate"  When the bit rate exceeds this value,  frames will be dropped to restrict the  bit rate.  * Only valid when ...
  • Page 223 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  4/4  Set prioritypolicy  64_prioritypoli * Only valid when  cy  "h264_ratecontrolmode"= cbr  s<0~(m‐1)>_h2 1~"capability_videoin_c<0 1/4  The maximum frame rates of a H264  64_maxframe  ~(n‐1)>_h264_maxframera stream at different  te"  resolutions("capability_videoin_c<0~( n‐1)>_resolution") are recorded in  "capability_videoin_c<0~(n‐1)>_h264 _maxframerate"  s<0~(m‐1)>_h2 0~2 ...
  • Page 224 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  4/4  cbr: Constant bit rate mode.  65_ratecontrol   vbr: Fixed quality mode, all frames are  mode  encoded in the same quality.  * Only available when h265 is listed in  "capability_videoin_codec".  s<0~(m‐1)>_h2 1~5,  4/4  Set the pre‐defined quality level:  65_quant  99, 100  1: Medium  2: Standard  3: Good  4: Detailed  5: Excellent ...
  • Page 225 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY( DESCRIPTION  get/set)  * Only valid when  "h265_ratecontrolmode"= vbr and  "quant"= 100.  s<0~(m‐1)>_h2 20000~"capability_videoin 4/4  The maximum allowed bit rate in fixed  65_maxvbrbitr _c<0~(n‐1)>_h265_maxbit quality mode.  ate  rate"  When the bit rate exceeds this value,  frames will be dropped to restrict the  bit rate.  * Only available when h265 is listed in  "capability_videoin_codec".  * Only valid when  "h265_ratecontrolmode"= vbr  s<0~(m‐1)>_h2 1~5, 100  4/4  Set the pre‐defined quality level:  65_cbr_quant  1: Medium  2: Standard  3: Good  4: Detailed ...
  • Page 226 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  4/4  Set prioritypolicy  65_prioritypoli * Only available when h265 is listed in  cy  "capability_videoin_codec".  * Only valid when  "h265_ratecontrolmode"= cbr  s<0~(m‐1)>_h2 1~"capability_videoin_c<0 1/4  The maximum frame rates of a H265  65_maxframe  ~(n‐1)>_h265_maxframera stream at different  te"  resolutions("capability_videoin_c<0~( n‐1)>_resolution") are recorded in  "capability_videoin_c<0~(n‐1)>_h265 _maxframerate"  * Only available when h265 is listed in ...
  • Page 227 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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    4/4  Manual video quality level input. The  peg_qvalue  (Only valid when  Q value which is used by encoded  "capability_api_httpversio library directly.  n" format is XXXXX_1 or  * Only valid when  XXXXX_3 or XXXXX_4  "mjpeg_ratecontrolmode"= vbr and  ex: 0301a_1 or 0301a_3 or  s<0~(m‐1)>_mjpeg_quant = 99  0301a_4)  or 1~99 ...
  • Page 228 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY( DESCRIPTION  get/set)  s<0~(m‐1)>_mj 1~5, 100  4/4  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  4/4  Select customized quality in a  peg_cbr_qperc normalized full range.  ent  1: Worst quality  100: Best quality  * Only valid when  "mjpeg_ratecontrolmode"= cbr and  "quant"= 100. ...
  • Page 229 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  4/4  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" = 2  wdrpro_streng 1~100  4/4  The strength of WDR Pro.  th  The bigger value means the stronger  <product  strength of WDR Pro.  dependent> ...
  • Page 230 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY( DESCRIPTION  get/set)  aespeed_spee 1~100  4/4  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.  * Only available when  "capability_image_c<0~(n‐1)>_aespee d" is 1  aespeed_sensi 1~100  4/4  The sensitivity of AE converge speed.  tivity  1~20: level 1  <product  21~40: level 2  dependent> ...
  • Page 231 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY( DESCRIPTION  get/set)  ttype" != "‐".  enablewaterm 0, 1  1/6  0: Not to add watermarks on images  ark  1: Add watermarks on images  <product  * Only available when  dependent>  "capability_fisheye" > 0  s<0~(m‐2)>_fis ‘1O, 1P, 2P, 1R, 4R’ for  1/4  Local dewarp mode.  heyedewarpm ceiling/floor mount  “1O” is original mode (disable).  ode  ‘1O, 1P, 1R, 4R’ for wall  Supported dewarp mode is different  <product  mount  by mount type.  dependent>  <product dependent>  * Only available when  * Available value is listed ...
  • Page 232 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  "capability_smartstream_mode_hybri d" is 1.  qualitypriority  ‐5,‐4,‐3,‐2,‐1,1,2,3,4,5  4/4  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. The level is from 1 to  5. Level 5 is the maximum level of the  quality difference between the ROI  and non‐ROI areas.  If the value is a negative number, the  video quality of non‐ROI areas is  better than the ROI. The level is from  ‐1 to ‐5. Level ‐5 is the maximum level  of the quality difference between the  ROI and non‐ROI areas.    Group: videoin_c<0~(n‐1)>_s<0~(m‐1)>_h264_smartstream2_win_i<0~(k‐1)>  (capability_smartstream_support=1, capability_smartstream_version>=2.0 and  capability_smartstream_mode_manual = 1)  Group: videoin_c<0~(n‐1)>_s<0~(m‐1)>_h265_smartstream2_win_i<0~(k‐1)>    (capability_smartstream_support=1, capability_smartstream_version>=2.0 and h265 is listed in ...
  • Page 233 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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" and m denotes the value of  "capability_nvideoinprofile" (capability_nvideoinprofile> 0)  NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  enable  <boolean>  4/4  Enable/disable this profile setting    policy  night,  4/4  The mode which the profile is applied  schedule  to.  <product dependent>  * Not support "policy=day" anymore  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".  begintime ...
  • Page 234 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  in  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.  * Only available when  "capability_image_c<0~(n‐1)>_exposu re_maxrange" != "‐"  * Only valid when  "piris_mode"=manual or  "irismode"=fixed  * Only available when ...
  • Page 235 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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>  4/4  Enable backlight compensation.  <Not support  * Not support this parameter  anymore>  anymore when the version number  (httpversion) is equal or greater than  0301a.  * It's recommanded to use  "exposurewin_c<n>_mode" to switch  on/off BLC.  exposurelevel  0~12  4/4  Exposure level  "0,12": This range takes the concept  from DC's exposure tuning options.  The definition is:  0: EV ‐2.0  1: EV ‐1.7 ...
  • Page 236 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  qualitypriority,  exposure level.  manual,  "shutterpriority": Manually adjust  etc  with variable Shutter Speed, and keep    adjusting Iris, Gain automatically.  "irispriority": Manually adjust with  (Available options are list  in  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.  "manual": Manually adjust with  variable Shutter, Iris and Gain.  * We support this parameter when  the version number (httpversion) is  equal or greater than 0302a.  *Only available when  "capability_image_c0_exposure_mod e" != 0  whitebalance ...
  • Page 237 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  4/4  Manual set rgain 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.  bgain  0~100  4/4  Manual set bgain value of gain control  setting. ...
  • Page 238 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  "piris_mode"=manual    or  "irismode"=fixed    * Normalized range.  * Only available when  "capability_image_c<0~(n‐1)>_exposu re_rangetype" is "twovalues".  mingain  0~100  4/4  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    or  "irismode"=fixed    * Normalized range.  * Only available when  "capability_image_c<0~(n‐1)>_exposu re_rangetype" is "twovalues". ...
  • Page 239 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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,‐  1/4  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.  "indoor": Avoid rolling and flicker  effect first.  "manual": Manual set P‐Iris by  "piris_position".  "‐": 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 ...
  • Page 240 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  "capability_image_c<0~(n‐1)>_iristype "=dciris  wdrpro_mode  0, 1, 2  4/4  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" = 2  wdrpro_streng 1~100  4/4  The strength of WDR Pro.  th  The bigger value means the stronger  <product  strength of WDR Pro.  dependent>  * Only available when  "capability_image_c<0~(n‐1)>_wdrpro _strength" is 1 ...
  • Page 241 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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 meas shorter  AE converged time during AE  executing.  * Only available when  "capability_image_c<0~(n‐1)>_aespee d" is 1  aespeed_sensi 1~100  4/4  The sensitivity of AE converge speed.  tivity  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 sensitivity level meas that  it is easy to be trigger while scene  changed. ...
  • Page 242 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved ipaddress  <ip address>  4/4  Multicast video IP address.    port  1025 ~ 65535  4/4  Multicast video port.    ipversion  IPv4, IPv6  4/4  The version of internet protocol.    ttl  1 ~ 255  4/4  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"  (capability_timeshift > 0)  NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  enable ...
  • Page 243 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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,  6/6  Set IR cut control mode  <Not  day,  * We replace this parameter with  recommended to  night,  “ircutcontrol_c0_mode” when the  use this>  di,  version number (httpversion) is equal    schedule…etc  or greater than 0312a.  * Available values are  * We do not support this parameter  listed in  when "capability_nvideoin > 1".  "capability_daynight_ * This parameter will not be used  c<0~(n‐1)>_mode"  after the version number (httpversion) ...
  • Page 244 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  is equal or greater than 0400a.  daymodeendtime  00:00~23:59  6/6  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.  * 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.  disableirled  <boolean>  6/6  Enable/disable built‐in IR led  <Not  * Only available when "  recommended to ...
  • Page 245 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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>  6/6  Enable/disable built‐in White led  <Not  * Only available when    "  recommended to  capability_daynight_c<0~"capability_ use this>  nvideoin"‐1>_builtinwled > 0".  * We replace this parameter with  "ircutcontrol_illuminators_builtin_whi teled_enabled" when the version  number (httpversion) is equal or  greater than 0312a.  * 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.  bwmode ...
  • Page 246 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  * 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.  spectrum_mode  visible,  6/6  Set spectrum method .  <Not  ir,  * Only available when ...
  • Page 247 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  SECURIT DESCRIPTION  Y    (get/set)  mode  auto,  6/6  Set IR cut control mode  day,  * We support this parameter when  night,  the version number (httpversion) is  di,  equal or greater than 0312a.  schedule…etc  * Available values  are listed in  "capability_daynig ht_c<0~(n‐1)>_mo de"  <product  dependent>  sir  <boolean>  6/6  Enable/disable Smart IR  <product dependent> ...
  • Page 248 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved * We support this parameter when  the version number (httpversion) is  equal or greater than 0312a.  sensitivity  low,normal,high,1 6/6  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)>  _ircutsensitivity_type" is not "‐".  * We support this parameter when  the version number (httpversion) is  equal or greater than 0312a.    7.10.2 IR cut control Illuminators  Group: ircutcontrol_illuminators (capability_daynight_c<0~(n‐1)>_support > 0)  n denotes the value of "capability_nvideoin"  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 ...
  • Page 249 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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>  6/6  Enable/disable built‐in white led  d  * Only available when    "capability_daynight_illuminators_buil tin_support > 0" and "whiteled" is  listed in "capability_daynight_  illuminators _builtin_type"  * We support this parameter when  the version number (httpversion) is  equal or greater than 0312a.  external_do_enabled  <boolean>  1/6  Enable/disable external led mounted  on do1  * Only available when    "capability_daynight_illuminators_ext ernal_support > 0" and "do" is listed  in  "capability_daynight_illuminators_ext ernal_interface".  * We support this parameter when ...
  • Page 250 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved equal or greater than 0312a.  spectrum_mode  visible,  6/6  Set spectrum method .  ir,  * 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 > 0".  "capability_daynig   ht_illuminators  _spectrum_mode" .    7.11 Image Setting per Channel  Group: image_c<0~(n‐1)> for n channel products and m profile    n denotes the value of "capability_nvideoin" and m denotes the value of  "capability_nvideoinprofile"  NAME  VALUE ...
  • Page 251 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  4/4  ‐5: Less saturation <‐> 5: More  <Not  saturation  recommended to  100: Use "  use this>  image_c<n>_saturationpercent"  * Only available when bit 2 of  "capability_image_c<0~(n‐1)>_basicse tting" is 1.  * We replace "saturation" with  "saturationpercent".  * This parameter will not be used  after the version number (httpversion)  is equal or greater than 0400a.  sharpness  ‐3~3,100  4/4  ‐3: Softer <‐> 3: Sharper  <Not ...
  • Page 252 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  4/4  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" is 1.  sharpnesspercent  0~100  4/4  Set sharpness in the normalized  range.  0: Softer <‐> 100: Sharper  * Only available when bit 3 of  "capability_image_c<0~(n‐1)>_basicse tting" is 1  gammacurve  0~100  4/4  0: Fine‐turned gamma curve by  <product ...
  • Page 253 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  tmode" is 1  hlm  <boolean>  4/4  Enable/disable hightlight mask.  <product  * Only available when  dependent>  "capability_image_c<0~(n‐1)>_hlm" is  1  dnr_mode  <boolean>  4/4  3D noise reduction.  <product  0:disable  dependent>  1:enable  * Only available when  "capability_image_c<0~(n‐1)>_dnr" is  1  dnr_strength  1~100  4/4  Strength of 3DNR  <product  * Only available when  dependent> ...
  • Page 254 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  4/4  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  visibility,  4/4  Value of scene mode  <product  noiseless,  * Only available when  dependent>  lpcparkinglot,  "capability_image_c<0~(n‐1)>_scene lpcstreet,  mode_support" is 1 ...
  • Page 255 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  4/4  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).  * Only available when  "capability_image_c<0~(n‐1)>_deinter lace_support" is 1.  xoffset  0~100  4/4  Adjusting the image to proper  position horizontally.  * Only available when the bit 4 of  capability_image_c<0~(n‐1)>_basicset ting is 1.  yoffset  0~100 ...
  • Page 256 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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>  4/4  Enable/disable this profile setting  _enable  profile_i<0~(m‐1)> night,  4/4  The mode which the profile is applied  _policy  schedule  to.  <product dependent>    * Not support "policy=day" anymore  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". ...
  • Page 257 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  profile_i<0~(m‐1)> ‐5~5,100  4/4  ‐5: Less saturation <‐> 5: More  _saturation  saturation  <Not  100: Use "  recommended to  image_c<0~(n‐1)>_saturationpercent"  use this>    * Only available when bit 2 of  "capability_image_c<0~(n‐1)>_basicse tting" is 1.   ...
  • Page 258 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  after the version number (httpversion)  is equal or greater than 0400a.  profile_i<0~(m‐1)> 0~100  4/4  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)> 0~100  4/4  Set contrast in the normalized range.  _contrastpercent  0: Less contrast <‐> 100: More  contrast  * Only available when bit 1 of  "capability_image_c<0~(n‐1)>_basicse tting" is 1  profile_i<0~(m‐1)> 0~100  4/4  Set saturation in the normalized  _saturationpercent ...
  • Page 259 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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>  4/4  Enable/disable low light mode.  _lowlightmode  * Only available when  <product  "capability_image_c<0~(n‐1)>_lowligh dependent>  tmode" is 1  profile_i<0~(m‐1)> <boolean>  4/4  Enable/disable hightlight mask.  _hlm  * Only available when  <product  "capability_image_c<0~(n‐1)>_hlm" is  dependent>  1  profile_i<0~(m‐1)>...
  • Page 260 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  4/4  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".  profile_i<0~(m‐1)> <boolean>  4/4  Digital image stabilizer  _dis_mode  0:disable  <product  1:enable  dependent>  * Only available when 'dis' is listed in ...
  • Page 261 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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" and valid when  "exposurewin_c<0~(n‐1)>_mode"=custom or "exposurewin_c<0~(n‐1)>_mode"=hlc)  NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  enable  <boolean>  4/4  Enable or disable the window.  policy  0~1  4/4  0: Indicate exclusive.  1: Indicate inclusive. ...
  • Page 262 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  H: 0~ The current image height  "capability_image_c<0~(n‐1)>_exposu ‐1  re_windomain".  sizepx  <0~Wx0~ H>  4/4  Width and height of the window.      W: 0~ The current image width  * Only available when px is listed in  ‐1  "capability_image_c<0~(n‐1)>_exposu H: 0~ The current image height  re_windomain".  ‐1  homestd  <0~9999,0~9999>  4/4  Left‐top corner coordinate of the  window.    * Only available when std is listed in  "capability_image_c<0~(n‐1)>_exposu re_windomain".  sizestd  <0~9999x0~9999> ...
  • Page 263 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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".  (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" and valid when  "exposurewin_c<0~(n‐1)>_mode"=custom or "exposurewin_c<0~(n‐1)>_mode"=hlc)  NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  enable  <boolean>  4/4  Enable or disable the window.  policy  0~1  4/4  0: Indicate exclusive. ...
  • Page 264 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  homepx  <0~W,0~H>  4/4  Left‐top corner coordinate of the    window.  W: 0~ The current image width    ‐1  * Only available when px is listed in  H: 0~ The current image height  "capability_image_c<0~(n‐1)>_exposu ‐1  re_windomain".  sizepx  <0~Wx0~ H>  4/4  Width and height of the window.      W: 0~ The current image width  * Only available when px is listed in  ‐1  "capability_image_c<0~(n‐1)>_exposu H: 0~ The current image height  re_windomain".  ‐1  homestd ...
  • Page 265 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  input  intmic, extmic  4/4  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.  volume_internal  0~100  4/4  Volume when take internal  microphone as input source.  0: Minimum  100: Maximum    * Only available when the channel  supports internal microphone (The  related bit of ...
  • Page 266 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  4/4  Enable microphone boost.  <Not recommended  Gain of input.  to use this>  (audioin_c<0~(n‐1)>_source = micin)  * Reserved for compatibility, and  suggest don't use this since the  version number (httpversion) is equal  or greater than 0301a.  * We replace "boostmic" with  "volume_internal" and  "volume_external". More details,  please refer the parameter  description of "volume_internal" and  "volume_external". ...
  • Page 267 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  5900,  6700,  7400,  7950,  10200,  12200  s0_g711_mode  pcmu,  4/4  Set G.711 companding algorithm.    pcma  pcmu: µ‐law algorithm  pcma: A‐law algorithm  * Only available if G.711 is supported.  s0_g726_bitrate  16000,  4/4  Set G.726 encoded bitrate in bps.    24000,  * Only available if G.726 is supported.  32000,  40000  s0_g726_bitstreamp little, big  4/4 ...
  • Page 268 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  schedule  to.  <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  4/4  Begin time of schedule mode.  profile_i0_endtime  hh:mm  4/4  End time of schedule mode.  profile_i0_alarm_lev 1~100  4/4  Audio detection alarm level  el  7.13.1. Multicast Settings for Audio Streaming  Group: audioin_c<0~(n‐1)>_s0_multicast (capability_naudioin > 0 and ...
  • Page 269 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.15 Play an Audio Clip  Group: audioclip_i<0~1> (capability_audio_audioclip=1)  NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  name  string[40]  1/4  Specify the audio clip name that can  be played when an event occurs.  size  0,<positive integer>  1/4  The size of audio clip.    Group: audioclip (capability_audio_audioclip=1)  NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  prerecord_seconds  1~10  1/4  Indicates the seconds that can be  waited before audio clip start to  record.   ...
  • Page 270 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  4/4  Percent of motion detection window.  sensitivity  0 ~ 100  4/4  Sensitivity of motion detection window.  <Not recommended  * We replace "sensitivity" with  to use this>  "win_sensitivity".  * This parameter will not be used after  the version number (httpversion) is  equal or greater than 0400a.  polygonpx  0 ~ W,0 ~ H, 0 ~ W,0  4/4 ...
  • Page 271 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  the version number (httpversion) is  equal or greater than 0400a.  left  0 ~ 320  4/4  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".  * It's recommended to use polygonsd  * This parameter will not be used after  the version number (httpversion) is  equal or greater than 0400a.  top  0 ~ 240  4/4  Top coordinate of window position.    <Not recommended  * Only available when  to use this>  "capability_motion_wintype" =  rectangle.  * Only available when qvga is listed in ...
  • Page 272 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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 " capability_nmotionprofile ",  (capability_nmotionprofile > 0)  NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  enable  <boolean>  4/4  Enable profile 1 ~ (m‐1).  policy  night,  4/4  The mode which the profile is applied to.  schedule    * Not support "policy=day" anymore  when the version number (httpversion) is ...
  • Page 273 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  enable  <boolean>  4/4  Enable motion detection window.  name  string[14]  4/4  Name of motion window.  polygonstd  0 ~ 9999,0 ~ 9999,  4/4  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" = polygon.  * Only available when std is listed in  "capability_motion_windomain  objsize  1 ~ 100  4/4  Percent of motion detection window.  sensitivity  0 ~ 100  4/4  Sensitivity of motion detection window. ...
  • Page 274 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  top  0 ~ 240  4/4  Top 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".  * It's recommended to use polygonsd  * This parameter will not be used after  the version number (httpversion) is equal  or greater than 0400a.  width ...
  • Page 275 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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    DESCRIPTION  (get/set)  enable  <boolean>  4/4  Enable or disable tamper detection.  threshold  0~100  4/4  Threshold of tamper detection.  duration  10~600  4/4  If tampering value exceeds the  "threshold" for more than "duration"  second(s), then tamper detection is ...
  • Page 276 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  detection  blurry_duration  1~10  4/4  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>  6/6  Enable or disable the dynamic DNS.  provider  DyndnsDynamic,  6/6  DyndnsDynamic => dyndns.org  DyndnsCustom,  (dynamic) ...
  • Page 277 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.20 UPnP Presentation  Group: upnppresentation  NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  enable  <boolean>  6/6  Enable or disable the UPnP  presentation service.    7.21 UPnP Port Forwarding  Group: upnpportforwarding  NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  enable  <boolean>  6/6  Enable or disable the UPnP port  forwarding service.  upnpnatstatus  0~3  6/7  The status of UPnP port forwarding,  used internally. ...
  • Page 278 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  setparamlevel  0~2  6/6  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  DESCRIPTION  (get/set)  v2  <boolean>  6/6  SNMP v2 enabled. 0 for disable, 1 for  enable  v3  <boolean>  6/6  SNMP v3 enabled. 0 for disable, 1 for  enable ...
  • Page 279 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.24 Layout Configuration  Group: layout    NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  logo_default  <boolean>  1/6  0 => Custom logo  1 => Default logo  logo_link  string[128]  1/6  Hyperlink of the logo    http://www.vivot ek.com  logo_powerbyvvtk_hidd <boolean>  1/6  0 => display the power by vivotek logo  en  1 => hide the power by vivotek logo  custombutton_manualtr <boolean>  1/6  Show or hide manual trigger (VI)  igger_show ...
  • Page 280 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  * We support this parameter when  the version number (httpversion) is  equal or greater than 0314b.  defaultpassword_length  8 ~ 64  6/7  Allowed password length.  * We support this parameter when  the version number (httpversion) is  equal or greater than 0314b.    131  280 - User's Manual...
  • Page 281 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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>  4/4  Enable privacy mask.  win_i<0~(m‐1)>_enable  <boolean>  4/4  Enable privacy mask window.  win_i<0~(m‐1)>_name  string[14]  4/4  Name of the privacy mask window.  win_i<0~(m‐1)>_left  0 ~ 320  4/4  Left coordinate of window position.  * Only available when  "capability_image_c<0~(n‐1)>_privacy mask_wintype" = rectangle.  * If the image is rotated by 90 or 270  degrees, the range of left coordinate  is 0~240. ...
  • Page 282 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  n  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".  win_i<0~(m‐1)>_polygo 0 ~ W,0 ~ H,    4/4  Coordinate of polygon window  npx  0 ~ W,0 ~ H,    position.    0 ~ W,0 ~ H,    (4 points: x0,y0,x1,y1,x2,y2,x3,y3) ...
  • Page 283 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  color  0~"  4/4  Privacy mask color  capability_image_c<0~(n‐ 1)>_privacymask_ncolor" ‐1  win_i<0~(m‐1)>_name  string[40]  4/4  Name of the privacy mask  window.  win_i<0~(m‐1)>_pan  "capability_ptz_c<0~(n‐1) 4/4  Pan position of window  >_minpan" ~  position.  "capability_ptz_c<0~(n‐1) * Only available when bit0 of  >_maxpan"  "capability_camctrl_c<0~(n‐1)>_ buildinpt" is "1"  win_i<0~(m‐1)>_tilt  "capability_ptz_c<0~(n‐1) 4/4  Tilt position of window position. ...
  • Page 284 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  Revision  Increase the revision when fix bugs  without change any features of the  output.  _platform  This is a constant, it is used to  distinguish between different  platforms  API version format:  MMmmr_k  Where "MM" is the major version,  "mm" is the minor version and "r" is  the revision.  'M' and 'm' and 'k' are decimal digit  from 0 to 9, while 'r' is an alphabetic.  EX: 0302b_1 => Major version = 03, ...
  • Page 285 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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>  0/7  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.  bootuptime  <positive integer>  0/7  Server bootup time.  nir  0,  0/7  Number of IR interfaces.  <Not support  <positive integer>  (Recommand to use  anymore>  capability_daynight_c<0~"capability_ nvideoin"‐1>_builtinir for built‐in IR ...
  • Page 286 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  nvideoout  0, <Positive Integer>  0/7  Number of video out interface.  nvideoinprofile  <positive integer>  0/7  Number of video input profiles.  nmediastream  <positive integer>  0/7  Number of media stream per  channels.  naudiosetting  <positive integer>  0/7  Number of audio settings per channel.  <Not support  * Not support this parameter  anymore>  anymore when the version number  (httpversion) is equal or greater than  0301a.  * We replace "naudiosetting" with  "naudioin". More details, please refer  the parameter description of  "volume_internal" and ...
  • Page 287 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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)  Bit 5 => (only available when bit0 is 1)  Support focus operation;    0(not support), 1(support)  (only available when RS‐485 interface  is supported or SD/PZ/PT/PD/video  server series)  Bit 6 => (only available when bit0 is 1)  Reserved bit; always 0.  Bit 7 => (only available when bit0 is 1)  External or built‐in PT;    0(built‐in), 1(external)  windowless ...
  • Page 288 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  * This is reserved for compatibility  and will not be used after the version  number (httpversion) is equal or  greater than 0400a.  * We replace  "capability_remotefocus" with "  capability_image_c0_remotefocus".  npreset  0, <positive integer>  0/7  Number of preset locations  presettourdirection  <boolean>  0/7  Indicate whether to support preset  tour direction function. It means users  can choose which direction the preset  tour goes. ...
  • Page 289 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  Then, the 1st bit of the group  indicates 1st stream of a channel  support ePTZ or not. The 2nd bit of  the group indicates 2nd stream of a  channel support ePTZ or not, and so  on.  * For most products, the last stream  of a channel will not support ePTZ. It  is reserved for full view of the  channel. For some dual‐stream  products, both streams support ePTZ.  nanystream  0, <positive integer>  0/7  number of any media stream per  channel  iva  <boolean>  0/7  Indicate whether to support  Intelligent Video analysis ...
  • Page 290 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  tamperingmode  tamper,toodark,toobri 0/7  Available tampering mode list.  ght,tooblurry  * Only available when  "capability_tampering" is 1.  adaptiverecording  <boolean>  0/7  Indicate whether to support adaptive  recording.  adaptivestreaming  <boolean>  0/7  Indicate whether to support adaptive  streaming.  supporttriggertype seq,boot,motion,netw 0/7  list all the trigger types which are  s  orkfail,recnotify,tamp supported in the camera:  ering,vi,vadp,di,volala "seq" = Periodic condition  rm,temperature,pir, ...
  • Page 291 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  * We support this parameter when  the version number (httpversion) is  equal or greater than 0311c.  storage_dbenabled  <boolean>  0/7  Media files are indexed in database.  protocol_https  <boolean >  0/7  Indicate whether to support HTTP  over SSL.  protocol_rtsp  <boolean >  0/7  Indicate whether to support RTSP.  protocol_sip  <boolean>  0/7  Indicate whether to support SIP.  protocol_ibis  <boolean>  0/7  Indicate whether to support  integrated on‐board information  system (IBIS).  * We support this parameter when ...
  • Page 292 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  protocol_ipv6  <boolean>  0/7  Indicate whether to support IPv6.  protocol_pppoe  <boolean>  0/7  Indicate whether to support PPPoE.  protocol_ieee8021 <boolean>  0/7  Indicate whether to support  x  IEEE802.1x.  protocol_qos_cos  <boolean>  0/7  Indicate whether to support CoS.  protocol_qos_dscp  <boolean>  0/7  Indicate whether to support  QoS/DSCP.  protocol_ddns  <boolean>  0/7  Indicate whether to support DDNS. ...
  • Page 293 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  * This is kept for compatibility.  videoin_mjpeg_ma A list of <Integer> and  0/7  This equals  xframerate  "‐"  "capability_videoin_c0_mjpeg_maxfra merate".  * This is kept for compatibility.  videoin_h264_max A list of <Integer> and  0/7  This equals  framerate  "‐"  "capability_videoin_c0_h264_maxfra merate".  * This is kept for compatibility.  videoin_codec  mjpeg, h264, h265  0/7  Available codec of a device, split by  <product dependent>  comma.  The sequence is not limited.  EX: ...
  • Page 294 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  ‐,  0/7  When acoustic echo cancellation  maxframerate:fixed:1 function is enabled, some features  5  may become malfunction or be forced  <product dependent>  to a 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.    ‐ (unchanged) : UI keeps the status as  before and user can't change it.  ‐ (hidden) : UI is hidden. ...
  • Page 295 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  audio_mic  <boolean>  0/7  Indicate whether to support built‐in  <Not support  microphone input.  anymore>  * Not support this parameter  anymore when the version number  (httpversion) is equal or greater than  0301a.  * We replace "audio_mic" with  "audio_intmic".    audio_intmic  <0~Positive Integer> ...
  • Page 296 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  * It will be replaced by audio_intmic  and audio_extmic.  audio_lineout  <boolean>  0/7  Indicate whether to support line  output.  audio_michardwar <boolean>  0/7  Indicate whether the hardware  eswitch  supports built‐in/external mic switch  audio_headphoneo <boolean>  0/7  Indicate whether to support  ut  headphone output.  <Not support    anymore>  * Not support this parameter  anymore when the version number  (httpversion) is equal or greater than  0301a.  audio_audioclip ...
  • Page 297 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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>  0/7  Indicate whether smart stream is  ort  supported.  smartstream_versi <integer>  0/7  Number of smart stream version.  on  * Only available when  "capability_smartstream_support" is 1  smartstream_nstre <positive integer>  0/7  Number of stream that support smart  am  stream.  * Only available when  "capability_smartstream_support" is 1  smartstream_wind qvga, px, std, ‐ ...
  • Page 298 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  dow_autotracking  of autotracking.  * Only available when  "capability_smartstream_support" is 1  smartstream_nwin <positive integer>  0/7  Maximum number of tracking window  dow_manual  of manual.  * Only available when  "capability_smartstream_support" is 1  smartstream_nwin <positive integer>  0/7  Maximum number of tracking window  dow_hybrid_autotr of autotracking in hybrid mode.  acking  * Only available when  "capability_smartstream_support" is 1  smartstream_nwin <positive integer>  0/7  Maximum number of tracking window  dow_hybrid_manu of manual in hybrid mode. ...
  • Page 299 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  (httpversion) is equal or greater than  0301b.  * It will be replaced by  capability_camctrl_ptztunnel.  camctrl_ptztunnel  <boolean>  0/7  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".  * This is kept for compatibility.  * Only available when  capability_ptzenabled > 0  camctrl_privilege  <boolean>  0/7  Indicate whether to support “Manage  Privilege” of PTZ control in the  security page.  1: support both  /cgi‐bin/camctrl/camctrl.cgi and  /cgi‐bin/viewer/camctrl.cgi  0: support only ...
  • Page 300 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  e  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>  0/7  Indicate whether to support wireless  1b  802.11b+.  wireless_s802dot1 <boolean>  0/7  Indicate whether to support wireless  1g  802.11g.  wireless_s802dot1 <boolean>  0/7  Indicate whether to support wireless  1n  802.11n.  wireless_begincha 1 ~ 14 ...
  • Page 301 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  the version number (httpversion) is  equal or greater than 0305a.  derivative_brand  <boolean>  0/7  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. (TCVV<‐>TCXX is  excepted)  test_ac  <boolean>  0/7  Indicate whether to support test ac  <Not support  key.  anymore>  version_onvifdaem <string>  0/7  Indicate ONVIF daemon version  on  version_onviftestto <string>  0/7  Indicate ONVIF test tool version ...
  • Page 302 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  the version number (httpversion) is  equal or greater than 0313a.  media_streamprofi <positive integer>  0/7  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>  0/7  Indicate iris type.  <Not  "piris": P‐Iris   recommended to  "dciris": DC‐Iris   use this>  "‐": No Iris control support   * When "capability_iris"=0, this value  must be "‐".  * Note: For some box‐type cameras,  this value may be varied depending on ...
  • Page 303 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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 0,  0/7  The maximum MOD connection  um  <positive integer>  numbers.  <Not  * Only available when  recommended to  "capability_supportsd" is 1 or  use this>  "capability_storage_dbenabled" is 1.  * We replace this parameter with  “capability_storage_management_mo dnum” when the version number  (httpversion) is equal or greater than  0312a.  localstorage_modv <string> ...
  • Page 304 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  "capability_supportsd" is 1 or  "capability_storage_dbenabled" is 1.  localstorage_slcon 0,<positive integer>  0/7  The maximum seamless connection  num  number for each channel.  * Only available when  "capability_supportsd" is 1 or  "capability_storage_dbenabled" is 1.  localstorage_smart <boolean>  0/7  The "Lifetime and Log SD Card"  sd  feature allows users to obtain the  card's remaining lifetime information.  0: Non‐support this feature  1: Support this feature  * Only Sony, Micron SD card can  support this function now.  * Only available when  "capability_supportsd" is 1 or  "capability_storage_dbenabled" is 1.  remotecamctrl_ma 0, <positive integer> ...
  • Page 305 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  layout_redirection  <string>  0/7  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>  0/7  Indicate support for security camera.  t  * We support this parameter when  the version number (httpversion) is  equal or greater than 0314a.  securecam_version  <string>  0/7  Indicate the security camera feature  phases.  * Only available when  capability_securecam_support=1.  * We support this parameter when  the version number (httpversion) is ...
  • Page 306 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  cameralink_num  0, <positive integer>  0/7  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>  0/7  Indicate the version of camera link  feature.  * Only available when  "capability_cameralink_support" is 1.  * We support this parameter when  the version number (httpversion) is  equal or greater than 0315a.    7.27.1 Capability for Camctrl  Group: capability_camctrl_c<0~(n‐1)> n denotes the value of "capability_nvideoin"  (capability_ptzenabled > 0)  * We support this group when the version number (httpversion) is equal or greater than 0303b.  PARAMETER ...
  • Page 307 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  buildinpt  <boolean>  0/7  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>  0/7  Indicate whether to support zoom lens.  In our product, only SD series and IZ  series use the zoom lens.  * Both varifocal and zoom lenses are  built with movable elements that  permit changing the effective focal  length. And the key difference between  a varifocal and a zoom lens can be  explained by thinking about a lens that  has been focused on an object at any  focal length. A varifocal will need to be  refocused whenever the focal length is  adjusted; the zoom will stay in focus  when the focal length is adjusted.  158  User's Manual - 307...
  • Page 308 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  focusmode  auto,onetimeauto,sp 0/7  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.  "spotlight": Camera will automatically  adjust the focus position full time, and  to consider a spotlight avoidance  situation.  "manual": Turn off the automatically  focus function. For user to control the  focus position manually as their  purpose.  * Only available when  "capability_camctrl_c<0~(n‐1)_zoommo dule" is 1.  * We support this parameter when the  version number (httpversion) is equal or ...
  • Page 309 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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" is "1"  maxpan  0, <positive integer>  0/7  The upper limit for pan position.  *Only available when bit0 of  "capability_camctrl_c<0~(n‐1)>_buildin pt" is "1"  minpanangle  <integer>  0/7  The lower limit for pan angle.  *Only available when bit0 of ...
  • Page 310 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  mintiltangle  <integer>  0/7  The lower limit for tilt angle.  *Only available when bit1 of  "capability_camctrl_c<0~(n‐1)>_buildin pt" is "1"  maxtiltangle  <integer>  0/7  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>  0/7  The maximum speed level of zoom  motion.  *Only available when the value of  "capability_camctrl_c<0~(n‐1)>_zoomm odule" is "1"  minzoom  0, <positive integer>  0/7  The lower limit for zoom position.  *Only available when the value of ...
  • Page 311 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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    DESCRIPTION  (get/set)  support  <boolean>  0/7  Indicate whether the camera supports  day/night mode switch  builtinir  <boolean>  0/7  Indicate whether to support built‐in IR   ...
  • Page 312 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  optimizedir  <boolean>  0/7  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>  0/7  Indicate whether to support smart IR.  ircutfilter  <boolean>  0/7  Indicate whether to support IR cut.  lightsensor  <boolean>  0/7  Indicate whether to support light  sensor.  blackwhitemode  <boolean>  0/7 ...
  • Page 313 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  ircutsensitivity_supportle 0,  0/7  The value indicate the support strength  vel  <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.  extled_interface  do  0/7  The device interface of external IR led:    <product  "do": digital output  dependent>  * Only available when  "capability_daynight_c<0~(n‐1)>_extern alir" is 1 ...
  • Page 314 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  spectrum_mode  visible,ir,irenhanced, 0/7  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.  "blueenhanced": This CCM model  increases the brightness effect of blue  light.  *Only available when  "capability_daynight_c<0~(n‐1)>_suppo rt" is 1 and  "capability_daynight_c<0~(n‐1)>_spectr um_support" is 1  * We replaced this parameter with  “capability_daynight_illuminators_spect rum_mode” when the version number  (httpversion) is equal or greater than ...
  • Page 315 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  mode  auto,daynight,di,di2, 0/7  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. In day mode, the camera  streams color video. In night mode, the  camera streams black and white video  in low light environments.  "di": the camera automatically switches  the current mode when a ditigal input 1  is triggered.  "di2": the camera automatically  switches the current mode when a  ditigal input 2 is triggered.  "di3": the camera automatically  switches the current mode when a  ditigal input 3 is triggered.  "di4": the camera automatically  switches the current mode when a  ditigal input 4 is triggered. ...
  • Page 316 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved optimizedir  <boolean>  0/7  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>  0/7  Indicate whether to support built‐in led.    * We support this parameter when the  version number (httpversion) is equal or  greater than 0312a.  builtin_type  irled,whiteled,‐  0/7  Indicate whether to support built‐in led  <product  type.  dependent>  "irled": IR led  "whiteled": white led  "‐": not support  * We support this parameter when the  version number (httpversion) is equal or  greater than 0312a.  external_support  <boolean>  0/7  Indicate whether to support external led. ...
  • Page 317 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved spectrum_support  <boolean>  0/7  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.  spectrum_mode  visible,ir,irenhanced, 0/7  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.  "blueenhanced": This CCM model  increases the brightness effect of blue  light.  *Only available when  "capability_daynight_c<0~(n‐1)>_support" ...
  • Page 318 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved device  sd, nas  0/7  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”. “\date\hour” format  is “\YYYYMMDD\hh”.  modnum  0,  0/7  The maximum MOD connection numbers.  <positive integer>  * Only available when  "capability_storage_dbenabled" is 1.  * We support this parameter when the  version number (httpversion) is equal or  greater than 0312a.  7.27.6 Capability for Video Input  Group: capability_videoin_c<0~(n‐1)> n denotes the value of "capability_nvideoin"  PARAMETER  VALUE  SECURITY    DESCRIPTION ...
  • Page 319 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  color_support  <boolean>  0/7  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.  eptz_zoomratio  <string>  0/7  Indicate the support zoom ratio of eptz.  "‐": not support ePTZ  * We support this parameter when the  version number (httpversion) is equal or  greater than 0310a.  rotation  <boolean>  0/7  Indicate current mode whether support  video rotation  170  User's Manual - 319...
  • Page 320 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  rotationaffect  ‐  0/7  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.    ‐ (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.  ‐ (enabled) : UI is checked.    ‐ (notsupport) : the affected function is not  available. ...
  • Page 321 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  rotationangle  <string>  0/7  The different angles which camera supports  for rotation.  * Only avaliable when  "capability_videoin_c<0~(n‐1)>_rotation" is  1.  * We support this parameter when the  version number (httpversion) is equal or  greater than 0309b.  orientation  flip,mirror,rotatio 0/7  Indicates the camera supports flip, mirror or  n  rotation.  <product  * We support this parameter when the  dependent>  version number (httpversion) is equal or  greater than 0309b.  streamcodec  <positive integer>  0/7  Represent supported codec types of each  stream. ...
  • Page 322 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  resolution  A list of <WxH>  0/7  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.  * The element number is defined as  "capability_nmediastream".  minresolution  A list of <Integer>  0/7  Represent supported minimum resolution  of each stream in current video mode.  * The element number is defined as  "capability_nmediastream".  * We support this parameter when the  version number (httpversion) is equal or  greater than 0304b. ...
  • Page 323 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  mjpeg_maxframerate  A list of <Positive  0/7  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".  * The element number is defined as  "nresolution" in this group.  * This parameter may be changed when  "videoin_c<n>_cmosfreq"=50 or  "videoin_c<n>_modulation"=pal.  Ex: 30 fps is changed to 25 fps, 60 fps is  changed to 50 fps, and so on.  * Only available when 'mjpeg' is listed in  "capability_videoin_codec".  mjpeg_maxbitrate  <positive  0/7  Maximum bitrates of MJPEG.  integer>, ‐  The unit is bps.  "‐" means MJPEG does not support bit rate  control. ...
  • Page 324 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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 0/7  Indicate H264 profiles  h  * Only available when 'h264' is listed in  <product  "capability_videoin_codec".  dependent>  * We support this parameter when the  version number (httpversion) is equal or  greater than 0309a.  h265_maxframerate  A list of <Positive  0/7  Maximum fps that the device can encoded  Integer> and "‐"  with H.265 on resolutions in current video  mode.  "‐" means not support. ...
  • Page 325 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  fisheye_mounttype  ceiling, wall, floor  0/7  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" >  0  * It's recommended to use  "capability_videoin_c<0~(n‐1)>_mounttype"  mounttype  ceiling, wall,  0/7  Indicate the supported mount type.  floor,‐  "‐": not support  <product  * We support this parameter when the  dependent  version number (httpversion) is equal or ...
  • Page 326 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  cameraunit_name  CU8131,  0/7  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 "‐".  CU8361‐H,  * We support this parameter when the  ...,  version number (httpversion) is equal or  ‐  greater than 0302b.  <product  dependent>  cmosfreq_support  <boolean>  0/7  0: The power line frequency(50/60Hz) is  detected by camera automatically.  1: The power line frequency(50/60Hz) can  be set by user. ...
  • Page 327 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  typewallmount  1O, 1P, 1R, 4R  0/7  Available dewarp types of wall mount.  resolutionC1P  A list of <WxH>  0/7  Available resolutions of 1P mode of  ceiling and floor mount.     resolutionC2P  A list of <WxH>  0/7  Available resolutions of 2P mode of  ceiling and floor mount.     resolutionC1R  A list of <WxH>  0/7  Available resolutions of 1R mode of  ceiling and floor mount.     resolutionC4R  A list of <WxH>  0/7  Available resolutions of 4R mode of  ceiling and floor mount. ...
  • Page 328 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  is_mode  eis,  0/7  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.  digitalzoom_support  <boolean>  0/7  Indicate this mode whether support  digital zoom.  * Only available when  "capability_camctrl_c<0~(n‐1)>_zoommo dule" is 1.  * We support this parameter when the  version number (httpversion) is equal or  greater than 0317a.  179 ...
  • Page 329 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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 => 2nd stream supports ePTZ or not,  and so on.  For nvideoin >= 2, the definition is  different:  First all 32 bits are divided into groups for  channel.  Ex:  nvideoin = 2, bit 0~15 are the 1st 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.  Then, the 1st bit of the group indicates  1st stream of a channel support ePTZ or  not. The 2nd bit of the group indicates  2nd stream of a channel support ePTZ or ...
  • Page 330 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  effectivepixel  <WxH>  0/7  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>  0/7  The output size of source, equal to the  captured size by device, in this video  mode. The unit is pixel.  This value is used as a basic coordinate  system for many features, like ePTZ,  privacy mask, motion, etc.  * Source (most for image sensor) may  perform scale or binning, etc on image  data, and output data with smaller size.  This parameter is designed to represent  this.  binning  0, 1, 3  0/7 ...
  • Page 331 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  maxresolution  A list of <Integer>  0/7  Represent supported maximum  resolution of each stream in current  video mode.  * The element number is defined as  "capability_nmediastream".  minresolution  A list of <Integer>  0/7  Represent supported minimum  resolution of each stream in current  video mode.  * The element number is defined as  "capability_nmediastream".  * We support this parameter when the  version number (httpversion) is equal or  greater than 0304b.  maxframerate  A list of <Positive  0/7  Indicates frame rate that the video  Integer>  source outputs in this video mode.  * One to one mapping to the resolution  in "resolution". ...
  • Page 332 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  maxfps_mjpeg  A list of <Positive  0/7  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".  * The element number is defined as  "nresolution" in this group.  * This parameter records the frame rate  when  "videoin_c<0~(n‐1)>_cmosfreq"=60 or  "videoin_c<0~(n‐1)>_modulation"=ntsc  * Only available when 'mjpeg' is listed in  "capability_videoin_codec".  maxfps_h264  A list of <Positive  0/7  Maximum fps which the device can  Integer> and "‐"  encoded with H.264 on resolutions in this  video mode.  "‐" means not support.  * One to one mapping to the resolution ...
  • Page 333 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  maxfps_h265  A list of <Positive  0/7  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".  * The element number is defined as  "nresolution" in this group.  * This parameter records the frame rate  when  "videoin_c<0~(n‐1)>_cmosfreq"=60 or  "videoin_c<0~(n‐1)>_modulation"=ntsc  * Only available when 'h265' is listed in  "capability_videoin_codec".  description  <string[128]>  0/7  Description about this mode.  7.27.9 Capability for Image  Group: capability_image_c<0~(n‐1)> n denotes the value of "capability_nvideoin"  NAME  VALUE ...
  • Page 334 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  equal or greater than 0311a.  wdrpro_mode  0, 1, 2  0/7  0: Non‐support WDR Pro  1: Support WDR Pro  2: Support WDR Pro II  wdrpro_strength  0, 1  0/7  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 1.  wdrpro_supportlevel  0, <positive  0/7  This contains a list of positive integers,  integer>  split by comma.  If "wdrpro_mode" =1, then the value  indicate the support strength level of  WDR Pro.  If "wdrpro_mode" =2, then the first  number indicate the support strength ...
  • Page 335 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  wdrc:enabled:,  "Affect API name" can be described in  wdrc:enabled:only hierarchy, such as  once,  "exposurewin.mode.blc:disabled:"  wdrc:unchanged:,  which means blc exposure window is  <x>: nonnegative  disabled. API name can be one word  integer  as well, such as ...
  • Page 336 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  ‐ (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.  "Affect API name" can be described in  hierarchy, such as  "exposurewin.mode.blc:disabled:"  which means blc exposure window is  disabled. API name can be one word ...
  • Page 337 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  1: Support 3D digital noise reduction  dnrstrength  <positive integer>  0/7  Indicate the support strength level of  3D digital noise reduction.  * Only available when  "capability_image_c<0~(n‐1)>_dnr" >  0.  * We support this parameter when  the version number (httpversion) is  equal or greater than 0306d.  dnrtype  2d,3d  0/7  Description about DNR type.  * Only available when  "capability_image_c<0~(n‐1)>_dnr" >  0.  * We support this parameter when  the version number (httpversion) is  equal or greater than 0308a.  eis  0,1  0/7  0: Non‐support electronic image  stabilizer ...
  • Page 338 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  is_supportlevel  0, <positive  0/7  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  ‐,  0/7  When Is mode is not "‐", some  <x>: nonnegative  features may become malfunction or  integer  be forced to a given value. The  <product  affected functions are list here.  dependent>  The format is "Affect API  name":"Policy":"Description"  "Policy" can be categorized into ...
  • Page 339 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  scenemode_support  0,1  0/7  0: Non‐support scene mode  1: Support scene mode  scenemode_supportty visibility,  0/7  list all the scene mode which are  pe  noiseless,  supported in the camera.  <product dependent>  lpcparkinglot,  * Only available when  lpcstreet,  "capability_image_c<0~(n‐1)>_ ...
  • Page 340 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  ‐ (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. API name can be one word  as well, such as  "exposurelevel:fixed:6" which means  exposurelevel is fixed to level 6.    "Description" can be a nonnegative  integer or string or NULL.    "‐" means no feature is affected.  * Only available when "signallight" is ...
  • Page 341 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  ‐ (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.  "Affect API name" can be described in  hierarchy, such as  "exposurewin.mode.blc: disabled:"  which means blc exposure window is  disabled. API name can be one word  as well, such as ...
  • Page 342 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  wbmode  auto,  0/7  Available white balance mode.  panorama,  "‐" means white balance is not  manual,  supported.  rbgain,  widerange,  outdoor,indoor,  sodiumauto,  ‐  <product  dependent>  iristype  piris,  0/7  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 343 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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,  0/7  * One to one mapping to the mode  etype  maximum,  type in "exposure_modetype".  ranged,  "fixed": The shutter value is the  ‐  assigned value  (videoin_c<0~(n‐1)>_shuttervalue).  "maximum": The shutter value can be  up to the assigned value  (videoin_c<0~(n‐1)>_shuttervalue).  "ranged": Need two parameters to  indicate the shutter range.  (videoin_c<0~(n‐1)>_maxexposure/ ...
  • Page 344 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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" 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.  exposure_automode_ ‐,  0/7  When exposure auto mode is  affect  exposurewin.mode enabled, some features may become  .blc:hidden:,  malfunction or be forced to a given ...
  • Page 345 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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. API name can be one word  as well, such as  "exposurelevel:fixed:6" which means  exposurelevel is fixed to level 6.  "Description" can be a nonnegative  integer or string or NULL.  "‐" means no feature is affected.  * Only available when auto 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.  exposure_shutterprior ‐,  0/7 ...
  • Page 346 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  "Affect API name" can be described in  hierarchy, such as  "exposurewin.mode.blc:disabled:"  which means blc exposure window is  disabled. API name can be one word  as well, such as  "exposurelevel:fixed:6" which means  exposurelevel is fixed to level 6.  "Description" can be a nonnegative  integer or string or NULL.  "‐" means no feature is affected.  * Only available when shutterpriority  is listed in  "capability_image_c<0~(n‐1)>_  exposure_modetype" and  "capability_image_c<0~(n‐1)>_  exposure_mode" is 1. ...
  • Page 347 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  ‐ (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.  "Affect API name" can be described in  hierarchy, such as  "exposurewin.mode.blc:disabled:" ...
  • Page 348 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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" 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 © 2022 VIVOTEK INC. All Right Reserved 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 ‐,  0/7  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. The affected functions are list  wdrpro:disabled:,  here.  exposurelevel:hidd The format is "Affect API  en:,  name":"Policy":"Description"  icrmode.auto:nots "Policy" can be categorized into  upport:  following groups:  or others ...
  • Page 350 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  exposure_levelrange  ‐,  0/7  Available range for  "0,12"  "videoin_c<0~(n‐1)>_exposurelevel"  * When "exposure_mode"=0, this  value must be set to "‐".  * Only available when  "capability_image_c<0~(n‐1)>_  exposure_mode" is 1.  exposure_winmode  auto,  0/7  Available options for  custom,  "exposurewin_c<0~(n‐1)>_mode" ...
  • Page 351 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  in "capability_image_c<0~(n‐1)>_  exposure_winmode".  exposure_hlcmode_af ‐,  0/7  When hlc mode is enabled, some  fect  sir:hidden:  features may become malfunction or  or others  be forced to a given value. The  <x>: nonnegative  affected functions are list here.  integer  The format is "Affect API  <product  name":"Policy":"Description"  dependent>  "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 352 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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,  0/7  The supported exposure window type.  "inclusive": The image inside a  exclusive,  ‐  window is the target area of exposure  control.  "exclusive": The image inside a  window is omitted by exposure  control.  "‐": Not supported.  * Only available when  "capability_image_c<0~(n‐1)>_  exposure_mode" is 1.  exposure_windomain  qvga, px, std, ‐  0/7  The domain to set an exposure  window. ...
  • Page 353 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  exposure_ntsc_totalra A list of <Positive  0/7  Available total range for NTSC analog  nge  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  0/7  Available total range for PAL analog  nge  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_maxrange ...
  • Page 354 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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/7  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  different exposure values.  * 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 0310a.  exposure_bracketing_ A list of ratio  0/7  The input parameter decides how ...
  • Page 355 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  rectangle shape.  privacymask_windom qvga, px, std, ‐  0/7  The domain to set an window.  ain  "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.  privacymask_ncolor  <Positive Integer>  0/7  Available total color numbers of  privacy mask.  agc_maxgain  "0,100",  0/7  Available range for  "‐"  "videoin_c<n>_maxgain"  “0,100” => 0~100 percent  "‐" means "videoin_c<n>_maxgain" is  not available.  agc_mingain ...
  • Page 356 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  "Affect API name" can be described in  hierarchy, such as  "exposurewin.mode.blc:disabled:"  which means blc exposure window is  disabled. API name can be one word  as well, such as  "exposurelevel:fixed:6" which means  exposurelevel is fixed to level 6.  "Description" can be a nonnegative  integer or string or NULL.  "‐" means no feature is affected.  * When "flickerless" = 0, this value  must be "‐"  defog_mode  0,1  0/7  0: Non‐support defog  1: Support defog  defog_strength ...
  • Page 357 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  ‐ (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.  "Affect API name" can be described in  hierarchy, such as  "exposurewin.mode.blc:disabled:"  which means blc exposure window is  disabled. API name can be one word  as well, such as  "exposurelevel:fixed:6" which means ...
  • Page 358 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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,1  0/7  0: Non‐support tuning Gamma curve  1: Support tuning Gamma curve  lowlightmode  ‐,0,1  0/7  ‐: Internal parameter, must not open  to user.  0: Non‐support low light mode  1: Support low light mode    focusassist  0,1  0/7  0: Non‐support focus assist  1: Support focus assist  remotefocus  0,<positive ...
  • Page 359 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  w  integer>  focuswindow_range  <leftrange,rightran 0/7  Available range for focuswindow.  ge,toprange,lowran * We support this parameter when  ge>  the version number (httpversion) is  <product  equal or greater than 0305d.  dependent>  *‐: Not supported.  lensconfiguration_sup 0,1  0/7  Indicate whether to support different  port  image library configuration files for  specific exchangeable lens.  freeze  <boolean>  0/7  0: Non‐support image freeze feature  1: Support image freeze feature  * We support this parameter when ...
  • Page 360 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  * Only available when  capability_image_c<0~(n‐1)>_deinterl ace_support is 1  lens_alignment  <boolean>  0/7  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>  0/7  The value indicate the support level of  alignment.  * Only available when  "capability_image_c<0~(n‐1)>_lens_al ignment" is 1.  lens_ldc_support  <boolean>  0/7  Indicate whether to support lens  distortion correction function.  * We support this parameter when  the version number (httpversion) is  equal or greater than 0309d. ...
  • Page 361 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  equal or greater than 0310a.  focussystem_mode  AFbyzoom,  0/7  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" > 0  * We support this parameter when  the version number (httpversion) is  equal or greater than 0316a  7.27.10 Capability for Peripheral Device  Group: capability_peripheral_c<0~(n‐1)> n denotes the value of "capability_nvideoin"  PARAMETER  VALUE  SECURITY    DESCRIPTION ...
  • Page 362 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  devicemonitor_heatern <integer>  0/7  Number of sensor sensors that can be  um  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>  0/7  The number of supported extension  digital input module.  * We support this parameter when the  version number (httpversion) is equal or  greater than 0316a.  do_num ...
  • Page 363 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  name  string[40]  6/6  Identification of this entry.  enable  0, 1  6/6  Enable or disable this event.  priority  0, 1, 2  6/6  Indicate the priority of this event:  "0"= low priority  "1"= normal priority  "2"= high priority  delay  1~999  6/6  Delay in seconds before detecting the  next event.  trigger  boot,  6/6  Indicate the trigger condition:  di,  "boot" = System boot.  pir, ...
  • Page 364 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  di  0,<positive  6/6  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" >  0  mdwin  0,<positive  6/6  Indicate the source window id of motion  integer>  detection.  This field is required when trigger  condition is “md”.  One bit represents one window.  The LSB indicates the 1  window.  For example, to detect the 1  and 3   windows, set mdwin as 5.  mdwin0 ...
  • Page 365 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  valevel0  0,1  6/6  Select audio detection profile event.  0: not select  1: select  inter  1~999  6/6  Interval of snapshots in minutes.  This field is used when trigger condition  is “seq”.  weekday  0~127  6/6  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.  begintime ...
  • Page 366 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  action_do_i<0~(k‐1)>_en <boolean>  6/6  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" >  0  action_do_i<0~(k‐1)>_du 1~999  6/6  Duration of the digital output trigger in  ration  seconds.  k is determined by the below criterion:  The following applies for  capability_extension_do_num >= 0 ...
  • Page 367 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  foldername  string[128]  6/6  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  6/6  Index of the attached media.  101 means “Recording Notify”  * Only available when  "capability_supportsd" > 0  action_cf_datefolder  <boolean>  6/6  Enable this to create folders by date,  <Not support anymore>  time, and hour automatically.  * Only available when  "capability_supportsd" > 0  action_cf_backup  <Boolean>  6/6  Enable or disable the function that send  media to SD card for backup if network is ...
  • Page 368 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  action_goto_sync  <boolean>  6/6  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>  6/6  Enable/disable auto tracking when an  <product dependent>  event is triggerd.  * Only avaliable when the bit4 of  capability_ptzenabled is 1 and the bit7 of  capability_ptzenabled is 0  action_autotrack_name  string[40]  6/6  Indicate the source name of smart  <product dependent>  tracking advanced when an event is  triggered.  * Only avaliable when the bit4 of ...
  • Page 369 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  action_audioclip_enable  <boolean>  6/6  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  6/6  Indicate the source id of audioclip event  integer>  notification.  * Only avaliable when  "capability_audio_audioclip" is 1.  tampering  0,<positive  6/6  Indicate the source channel id of  integer>  tampering detection.    A 4‐bit integer, each bit represents each  channel.    bit 0    => tampering detection for first  channel. ...
  • Page 370 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  type  email,  6/6  Indicate the server type:  ftp,  “email” = email server  http,  “ftp” = FTP server  ns,  “http” = HTTP server  sftp  “ns” = network storage  “sftp” = secure FTP  * “sftp” is only available when bit 1 of  “capability_protocol_ftp_client” is 1.  http_url  string[128]  6/6  URL of the HTTP server to upload.  http_username  string[64]  6/6  Username to log in to the server.  http_passwd  string[64]  7/6  Password of the user. ...
  • Page 371 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  ns_location  string[128]  6/6  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”.  * Note: “\date\hour” format is  “\YYYYMMDD\hh”.  ns_username  string[64]  6/6  Username to log in to the server.  ns_passwd  string[64]  7/6  Password of the user.  ns_workgroup  string[64]  6/6  Workgroup for network storage.   ...
  • Page 372 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved fingerprint_enable  boolean  6/6  Verify server fingerprint to avoid  connect to fake server.  fingerprint_content  <128‐bit hash  6/6  Server fingerprint(MD5).    value>  You can get it by calculate server host  key(public) md5.  publickey_pairmode  auto,  6/6  "autopair": Autopair mode is selected  download,  for this event server.  upload  "downloadkey": Download key pair  mode is selected for this event server.  "uploadkey": Upload key pair mode is  selected for this event server.  publickey_downloadkeytype  ed25519,  6/6  The keytype used for key pair.  rsa,  "ed25519": faster to generate with  ecdsa  higher security level, some old server  might not support. ...
  • Page 373 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  snapshot_channel  0~"capability_nvideoin"‐1  6/6  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.  snapshot_source  0~"capability_nmediastream 6/6  Indicate the source of media  "‐1  stream.  0 means the first stream.  1 means the second stream and  etc.  2 means the third stream and etc.  3 means the fourth stream and  etc.  snapshot_prefix  string[16] ...
  • Page 374 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  videoclip_channel  0~"capability_nvideoin"‐1  6/6  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.  videoclip_source  0~"capability_nmediastream 6/6  Indicate the source of media  "‐1  stream.  0 means the first stream.  1 means the second stream and  etc.  2 means the third stream and etc.  3 means the fourth stream and  etc.  videoclip_prefix  string[16] ...
  • Page 375 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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]  6/6  Identification of this entry.  trigger  schedule,  6/6  The event trigger type  networkfail  schedule: The event is triggered by  schedule  networkfail: The event is triggered by  the failure of network connection.  enable  <boolean>  6/6  Enable or disable this recording.  priority  0, 1, 2  6/6  Indicate the priority of this recording:  “0” indicates low priority.  “1” indicates normal priority. ...
  • Page 376 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  maxretentiontime  <string>  6/6  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. P7D, it means 7 days. P1DT10H, it  means 1 days and 10 hours.  The parameter takes effect when  autocleanup_  maxretentiontime_recording_enabled  is enabled.  notify  <boolean>  6/6  0: Disable recording notification  1: Enable recording notification  notifyserver  0~31  6/6  Indicate which notification server is  scheduled. ...
  • Page 377 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  weekday  0~127  6/6  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.  begintime  hh:mm  6/6  Start time of the weekly schedule.  endtime  hh:mm  6/6  End time of the weekly schedule.  (00:00~24:00 indicates schedule always  on)  prefix  string[16]  6/6 ...
  • Page 378 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  adaptive_enable  <boolean>  6/6  Indicate whether the adaptive    recording is enabled  adaptive_preevent  0~9  6/6  Indicate when is the adaptive recording    started before the event trigger point  (seconds)  adaptive_postevent  0~10  6/6  Indicate when is the adaptive recording    stopped after the event trigger point  (seconds)  recordingjob_Sourc string[64]  6/6  Indicate the source for media profile.  eToken_Token  * We support this parameter when the  version number (httpversion) is equal or ...
  • Page 379 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  stateorprovincen string[128]  6/6  State or province name in the  ame  certificate information.  localityname  string[128]  6/6  The locality name in thecertificate  information.  organizationname  string[64]  6/6  Organization name in the certificate  VIVOTEK Inc.  information.  unit  string[64]  6/6  Organizational unit name in  VIVOTEK Inc.  thecertificate information.  commonname  string[64]  6/6  Common name in the certificate  www.vivotek.com ...
  • Page 380 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  autocleanup_mode  targetbase,  6/6  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.  * We support this parameter when the  version number (httpversion) is equal or  greater than 0312a.  autocleanup_enabled  <boolean>  6/6  Enable automatic clean up method.    <Not recommended to  Expired and not locked media files will be  use this>  deleted.  * For forward compatibility reservations,  but only group disk_i0_autocleanup is  effective.  * Not recommended to use this. Please ...
  • Page 381 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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>  1/6  ROI left‐top corner coordinate.  <product  * If the minimal window size is 64x64,  dependent>  then the "home"=(0~resolution_W‐64,  0~resolution_H‐64), which the resolution  is equal to the captured size by device in  this video mode.    * If the stream doesn’t support ePTZ, the  permissions of this parameter must be  set as 1/7.  s<0~(m‐1)>_size  <WxH>  1/6  ROI width and height. The width value  <product  must be multiples of 16 and the height  dependent>  value must be multiples of 8 ...
  • Page 382 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  osdzoom  <boolean>  1/4  Indicates multiple of zoom in is  <Not recommended to  “on‐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" with "  videoin_c<0~(n‐1)>_zoomratiodisplay".    smooth  <boolean>  1/4  Enable the ePTZ "move smoothly"  feature  tiltspeed  ‐5 ~ 5  1/7  Tilt speed  (It should be set by eCamCtrl.cgi rather  than by setparam.cgi.)  panspeed  ‐5 ~ 5  1/7 ...
  • Page 383 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  patroldwelling  string[160]  1/4  The dwelling time (unit: second) of each  patrol point, separated by “,”.    preset_i<0~19>_name  string[40]  1/7  Name of ePTZ preset.  (It should be set by ePreset.cgi rather  than by setparam.cgi.)  preset_i<0~19>_pos  <W,H>  1/7  Left‐top corner coordinate of the preset.  <product  (It should be set by ePreset.cgi rather  dependent>  than by setparam.cgi.)  preset_i<0~19>_size  <WxH>  1/7  Width and height of the preset.  <product  (It should be set by ePreset.cgi rather  dependent> ...
  • Page 384 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  win_i0_size  <WxH>  4/4    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> 0)  * We do not support this parameter when "capability_nvideoin > 1".  PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  diskmode  seamless, ...
  • Page 385 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  maxconnection  3  1/7  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 > 1".  * This parameter will not be used after the  version number (httpversion) is equal or  greater than 0400a.  enable  <boolean>  1/7  Indicate whether seamless recording is    recording to local storage or not at present.  (Read only)  * We replace this parameter with  “seamlessrecording_c<0~(n‐1)>_triggerrecord ” when the version number (httpversion) is  equal or greater than 0312a.  * We do not support this parameter when ...
  • Page 386 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  guid<0~2>_number  0~3  1/7  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 > 1".  * This parameter will not be used after the  version number (httpversion) is equal or  greater than 0400a.  7.37.1 Seamless recording setting per channel  Group: seamlessrecording_c<0~(n‐1)> for n channel products  n denotes the value of "capability_nvideoin".    (capability_localstorage_seamless> 0)  PARAMETER  VALUE  SECURITY  DESCRIPTION  (get/set) ...
  • Page 387 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved triggerrecord  <boolean>  1/7  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]  1/7  The connected seamless streaming ID.    (Read only)  * k denotes the value of  "seamlessrecording_c<0~(n‐1)>_maxco nnection"  * We support this parameter when the  version number (httpversion) is equal or  greater than 0312a.  guid<0~(k‐1)>_number  0~3  1/7  Number of connected seamless  streaming with guid<0~(k‐1)>_id.  (Read only)  * k denotes the value of  "seamlessrecording_c<0~(n‐1)>_maxco nnection"  * We support this parameter when the  version number (httpversion) is equal or ...
  • Page 388 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  resource_free_storage  0,<positive  6/7  Indicate current free storage size for  integer>  uploading VADP modules.  module_number  0,<positive  6/7  Record the total module number that  integer>  already stored in the system.  module_order  string[40]  6/6  The execution order of the enabled  modules.  module_save2sd  <boolean>  6/6  Indicate if the module should be  saved to SD card when user want to  upload it.  If the value is false, save module to  the internal storage space and it will  occupy storage size.  * This feature is not supported when  "capability_securecam_support=1" ...
  • Page 389 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  url  string[120]  1/7  The URL address of vadp hyperlink.  status  string[40]  1/7  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)> for n VADP package number (capability_vadp_npackage > 0)  n denotes the value of "capability_vadp_npackage".  NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  enable  <boolean>  6/6  Indicate if the module is enabled or  not.  If yes, also add the index of this module ...
  • Page 390 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  statmsg  string[128]  6/6  Indicate the message that will be show  on the running status when mouse  over.  vvtklicensemec  string[40]  6/7  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".  (Only available when "capability_vadp_npackage" > 0 and the version number of "vadp_version" >=  "1.3.2.0")  NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  enable  <boolean> ...
  • Page 391 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  enableptztunnel  <boolean>  1/4  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  1/4  Pan speed  tiltspeed  ‐5 ~ 5  1/4  Tilt speed  zoomspeed  ‐5 ~ 5  1/4  Zoom speed  focusspeed  ‐5 ~ 5  1/4 ...
  • Page 392 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY  DESCRIPTION  (get/set)  capability_camctrl_c0_rs485=2  disablemdonptz  <boolean>  1/4  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    DESCRIPTION  (get/set)  ccdtype  string[16]    6/7  (Internal used, read only)  motortype  string[16]  6/7  (Internal used, read only)  cameraid ...
  • Page 393 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  listed in  "capability_cam ctrl_c<0~(n‐1)> _focusmode"  uart  0 ~  1/4  Select corresponding uart  "capability_nua (capability_nuart>0).  rt"‐1  * only available when  capability_camctrl_c0_rs485=2  isptz  0 ~ 2  1/4  0: disable PTZ commands.  1: enable PTZ commands with PTZ  driver.  2: enable PTZ commands with UART  tunnel.  * only available when  capability_camctrl_c0_rs485=2  preset_i<0~(k‐1)>_name  string[40]  1/4  Name of the preset location. ...
  • Page 394 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  version number (httpversion) is equal  or greater than 0305b.  patrolseq  string[120]  1/4  (For external device)  The indexes of patrol points, separated  by “,”  patroldwelling  string[160]  1/4  (For external device)  The dwelling time of each patrol point,  separated by “,”  * only available when  capability_camctrl_c0_rs485=2  disablemdonptz  <boolean>  1/4  Disable motion detection on PTZ  operation.  defaulthome  <boolean>  1/4  This field tells system to use default  home position or not.  axisz ...
  • Page 395 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved   API  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    DESCRIPTION  (get/set)  ccdtype  string[16]    6/7  (Internal used, read only)  motortype  string[16]  6/7  (Internal used, read only)  cameraid  1 ~ 255  1/4  Camera ID controlling external  PTZ camera.  Note:    Please set your speed dome to ...
  • Page 396 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  preset_i<0~(k‐1)>_name  string[40]  1/4  Name of the preset location.  preset_i<0~(k‐1)>_pan  capability_ptz_c<0~( 1/4  Pan position at each preset  n‐1)>_minpan ~  location.  capability_ptz_c<0~( n‐1)>_maxpan  preset_i<0~(k‐1)>_tilt  capability_ptz_c<0~( 1/4  Tilt position at each preset  n‐1)>_mintilt ~  location.  capability_ptz_c<0~( n‐1)>_maxtilt  preset_i<0~(k‐1)>_zoom  capability_ptz_c<0~( 1/4  Zoom position at each preset  n‐1)>_minzoom ~  location.  capability_ptz_c<0~( n‐1)>_maxzoom ...
  • Page 397 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  n‐1)>_minpan ~  capability_ptz_c<0~( n‐1)>_maxpan  axisy  capability_ptz_c<0~( 1/4  Custom home tilt position.  n‐1)>_mintilt ~  capability_ptz_c<0~( n‐1)>_maxtilt  axisz  capability_ptz_c<0~( 1/4  Custom home zoom position.  n‐1)>_minzoom ~  capability_ptz_c<0~( n‐1)>_maxzoom  axisf  capability_ptz_c<0~( 1/4  Custom home focus position.  n‐1)>_minfocus ~  capability_ptz_c<0~( n‐1)>_maxfocus  axisflip  <boolean>  1/4 ...
  • Page 398 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  tour_i<0~19>_speed  ‐5 ~ 5  1/4  Preset tour: pan and tilt speed  when moving between presets.  Recorded tour: unnecessary.  tour_i<0~19>_direction  forward,backward,ra 1/4  User can choose which direction  ndom  the preset tour goes.  "forward": preset tour goes in  forward order.  "backward": preset tour goes in  backward order.  "random": the presets of the tour  will be recalled randomly.  * Only available when  "capability_presettourdirection"  is 1.  * We support this parameter  when the version number  (httpversion) is equal or greater  than 0307a.  tour_i<0~19>_checklist  string[512] ...
  • Page 399 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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]  1/4  Name of the PTZ driver.  127>_name  ptzdrivers_i<0~19,  string[128]  1/4  Full path of the PTZ driver.  127>_location  enablehttptunnel  <boolean>  1/4  Enable HTTP tunnel channel to control  UART.    Group: uart_i<0~(n‐1)> n is uart port count (capability_nuart > 0 and capability_fisheye = 0)  NAME  VALUE  SECURITY    DESCRIPTION  (get/set) ...
  • Page 400 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  speedlink_i<0~4>_n string[40]  1/4  Additional PTZ command name.  ame  * only available when  capability_camctrl_c0_rs485=2  speedlink_i<0~4>_c string[40]  1/4  Additional PTZ command list.  md  * only available when  capability_camctrl_c0_rs485=2  ptzdriver  0~19,  1/4  The PTZ driver is used by this COM  127 (custom),  port.  128 (no driver)  * only available when  capability_camctrl_c0_rs485=2    7.43 UART Control (SD Series)  Group: uart_i<0~(n‐1)> n is uart port count (capability_nuart > 0 and the bit7 of ...
  • Page 401 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  "1": One stop bit is transmitted to  stopbit  1,2  4/4  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 uart_i<0~(n‐1)>_databit  set as 5 as well.    uartmode  rs485  4/7  RS485 mode.    7.44 UART Control (SC Series)  Group: uart_i<0~(n‐1)> n is uart port count (capability_nuart > 0 and capability_ibis = 1)  NAME  VALUE  SECURITY    DESCRIPTION ...
  • Page 402 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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>  6/7  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  SECURITY    DESCRIPTION  (get/set)  totalnumbers  0,<positive  6/7  Totoal support number of the default  integer>  lens profiles    Group: lens_user  NAME ...
  • Page 403 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  revisedcenteraxis  <coordinate>  1/7  The actual center axis coordinate  radius  0, <positive  1/7  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    DESCRIPTION  (get/set)  panspeed  ‐5 ~ 5  1/4  Pan speed of regional view  tiltspeed  ‐5 ~ 5  1/4 ...
  • Page 404 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  1/4  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 (capability_npir > 0)  NAME  VALUE  SECURITY    DESCRIPTION  (get/set)  enable  <boolean>  1/1  Enable/disable PIR   ...
  • Page 405 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.50 Wireless    Group: wireless (capability_network_wireless > 0)  PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  ssid  string[32]  6/6  SSID for wireless lan settings.  wlmode  Infra,  6/6  Wireless mode.  Adhoc  Infra: Infrastructure  channel  1~11    or  6/6  A list of WLAN channels.  1~13     or  Countries apply their own regulations  10~11   or  to the allowable channels.  10~13  ...
  • Page 406 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  key2  password [26]  6/6  WEP key2 for encryption.  * Only valid when "wireless_encrypt" is  "wep"  key3  password [26]  6/6  WEP key3 for encryption.  * Only valid when "wireless_encrypt" is  "wep"  key4  password [26]  6/6  WEP key4 for encryption.  * Only valid when "wireless_encrypt" is  "wep"  algorithm  AES, TKIP  6/6  Algorithm  * Only valid when "wireless_encrypt" is  "wpa" or "wpa2"  presharedkey  password [64]  6/6 ...
  • Page 407 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  fixed  <boolean>  1/7  The value indicates whether the profile  can be deleted or not.  Ex. fixed=1 indicates the profile cannot  be deleted.  occupied  <boolean>  1/6  Indicates the action of creating profile.  Ex. If occupied=1 indicates the current  profile is to be created; otherwise, if  occupied=0 indicates the current  profile is to be deleted.  alwaysmulticast  <boolean>  1/6  Enable always multicast.  videoconfiguration_en <boolean>  1/6  To enable the selected  able  videoconfiguration source for this  profile.  videoconfiguration_so c<0~(n‐1)>s<0~(m‐1) 1/6 ...
  • Page 408 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  audioconfiguration_so c<0~(n‐1)>s0  1/6  The audioconfiguration source for the  urce    profile.  * n denotes the value  Ex. audioconfiguration_source=  of  c<0~(n‐1)>s0 indicates audio stream of  "capability_naudioin"  channel n and stream 1 is selected for  the profile.    * Only available when  capability_naudioin > 0  metadataconfiguratio <boolean>  1/6  To enable the selected  n_enable  metadataconfiguration source for the  profile.  metadataconfiguratio c<0~(n‐1)>s0  1/6 ...
  • Page 409 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  name  string[40]  6/6  Identification of this entry.  ipaddress  <ip address>  6/6  The ipaddress of the receiving camera.  username  string[64]  6/6  The username of the receiving camera.  passwd  string[64]  7/6  The password of the receiving camera.  port  0~65535  6/6  The connection port to the receiving  camera.  do  <integer>[trigger  6/6  Indicate the source id and trigger time of  time]  di trigger. ...
  • Page 410 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  connected  <Boolean>  6/7  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>  7/6  To allow the feature of auto focus when  zoom is operated.  * Only available when  capability_image_c<0~(n‐1)>_focussyste m_mode=AFbyzoom  7.55.1. Save Day/Night Focus Position  Group: focussystem_c<0~(n‐1)> (capability_image_c<0~(n‐1)>_remotefocus > 0 and  capability_image_c<0~(n‐1)>_focussystem_mode=focusshift)  n denotes the value of "capability_nvideoin" ...
  • Page 411 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  SECURITY    DESCRIPTION  (get/set)  focusshift_night_lastdate  <blank>,  6/7  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.    262  User's Manual - 411...
  • Page 412 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  PARAMETER  VALUE  DESCRIPTION  do<num>  state[trigger time]  Ex: do0=1     Setting digital output #1 to trigger state.  Where "state" is 0, 1.  Ex: do0=0[30] “0” means inactive or  Setting digital output #1 to normal state, waiting 30  normal state while  seconds, setting it to trigger state.  “1” means active or    triggered state.  Where "trigger time"  is reset time after  state change. ...
  • Page 413 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved   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    8.3 Query Status of the Digital Output (capability_ndo > 0)  Note: This request requires Viewer privileges  Method: GET/POST  Syntax:  http://<servername>/cgi‐bin/dido/getdo.cgi?[do0][&do1][&do2][&do3]    If no parameter is specified, all the digital output statuses will be returned.    Return: ...
  • Page 414 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved [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>]  [&quality=<value>][&streamid=<value>]    If the request contains invalid parameters, a full FOV snapshot will return.  PARAMETER  VALUE  DESCRIPTION  channel  0~(capability_nvideoin ‐1)  The channel number of the video ...
  • Page 415 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  DESCRIPTION  quality  1~5  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. The size and quality of the image will be set according to the video settings on the server.    Return:  HTTP/1.0 200 OK\r\n  Content‐Type: image/jpeg\r\n  [Content‐Length: <image size>\r\n]  <binary JPEG image data>    8.5 Account Management  Note: This request requires Administrator privileges.  Method: POST    Syntax:  http://<servername>/cgi‐bin/admin/editaccount.cgi?  method=<value>&username=<name>[&userpass=<value>][&privilege=<value>][&return=<return  page>]   ...
  • Page 416 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.    “view”: Viewer privilege.  operator  “operator”: Operator privilege.  admin  “admin”: Administrator privilege.  return  <return page>  Redirect to the page <return page> after the parameter is  assigned. The <return page> should be the relative path  according to the root of camera. If you omit this  parameter, it will redirect to an empty page.  * If the <return page> is invalid path, it will ignore this  parameter.  Note:  Rules of password settings is defined by layout_defaultpassword group.   Example:  Request:  http://myserver/cgi‐bin/admin/editaccount.cgi?method=add&username=test&userpass=123&privi lege=view ...
  • Page 417 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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> if indicated.      268  User's Manual - 417...
  • Page 418 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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>] – Shift without stopping, used for joystick  [&x=<value>&y=<value>&videosize=<value>&resolution=<value>&stretch=<value>] –Click on  image  (Move the center of image to the coordination (x,y) based on resolution or videosize.)  [ [&speedpan=<value>][&speedtilt=<value>][&speedzoom=<value>][&speedapp=<value>] ] – Set  speeds  [&return=<return page>]    Example:  http://myserver/cgi‐bin/camctrl/eCamCtrl.cgi?channel=0&stream=0&move=right  http://myserver/cgi‐bin/camctrl/eCamCtrl.cgi?channel=0&stream=1&vx=2&vy=2&vz=2  http://myserver/cgi‐bin/camctrl/eCamCtrl.cgi?channel=0&stream=1&x=100&y=100&  videosize=640x480&resolution=640x480&stretch=0    In zoom operation, there are two ways to control it, scale zoom and area zoom.    1. [Scale zoom]: contains two control method, relative movement and continuous movement  a. relative movement ‐  If you trigger a relative movement, it will only zoom certain ratio and stop by itself. ...
  • Page 419 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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. [Area zoom]: it means to zoom in on a specific area, here is an example for a directly moving  [x, y] is the desired coordinate, and it will be the center after movement  [w, h] is the scaled area size  [resolution] is the base range of this coordinate system  The example shows [w, h] = [864, 488], which means to zoom in to ratio x2.2 based on [1920x1080].  Pay attention to that [x, y, w, h] are essential parameters in an area zoom case, and the stream index  is counted from 0 as the first stream.  http://IPAddr/cgi‐bin/camctrl/eCamCtrl.cgi?channel=0&stream=0&x=912&y=297&w=864&h=488&r esolution=1920x1080  PARAMETER  VALUE  DESCRIPTION  channel  <0~(n‐1)>  Channel of video source.  stream  <0~(m‐1)>  Stream.  move  home  Move to home ROI.  up  Move up. ...
  • Page 420 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  DESCRIPTION  y  <integer>  movement  w  <integer>  The scaled area size  h  <integer>  resolution  <window size>  The resolution of streaming.  vx  <integer>  The direction of movement, used for joystick control.  vy  <integer>  vs  0 ~ 7  Set the speed of movement, “0” means stop.  x  <integer>  x‐coordinate clicked by user.  It will be the x‐coordinate of center after movement.  y  <integer>  y‐coordinate clicked by user.  It will be the y‐coordinate of center after movement.  videosize  <window size>  The size of plug‐in (ActiveX)window in web page ...
  • Page 421 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  40 characters  return  <return page>  Redirect to the page <return page> after the parameter is  assigned. The <return page> should be the relative path  according to the root of camera. If you omit this  parameter, it will redirect to an empty page.  * If the <return page> is invalid path, it will ignore this  parameter.    ePTZ Preset Locations (capability_eptz > 0 and ...
  • Page 422 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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. The <return page> should be the relative path  according to the root of camera. If you omit this  parameter, it will redirect to an empty page.  * If the <return page> is invalid path, it will ignore this  parameter.    8.10 IP Filtering for ONVIF  Syntax:<product dependent>  http://<servername>/cgi‐bin/admin/ipfilter.cgi?type[=<value>]  http://<servername>/cgi‐bin/admin/ipfilter.cgi?method=add<v4/v6>&ip=<ipaddress>[&index=<val ue>][&return=<return page>]  http://<servername>/cgi‐bin/admin/ipfilter.cgi?method=del<v4/v6>&index=<value>[&return=<retu rn page>]    PARAMETER  VALUE  DESCRIPTION  type ...
  • Page 423 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved   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. The  contents of upstream should be base64 encoded to be able to pass through a proxy server.    This channel will help to transfer the raw data of UART over the network.  Please see UART tunnel spec for detail information    PARAMETER  VALUE  DESCRIPTION  channel  0 ~ (n‐1)  The channel number of UART.   ...
  • Page 424 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved ‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐  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. The  contents of upstream should be base64 encoded to be able to pass through the proxy server. ...
  • Page 425 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  Note:    * We recommend to use new format to access streaming when  capability_media_streamprofiles_support=1, please refer to Methods for Accessing Streaming  8.14 Open the Network Stream  Note: This request requires Viewer access privileges.    Syntax:  For HTTP push server (MJPEG):  http://<servername>/<network_http_s<0~m‐1>_accessname>    For RTSP (MP4), the user needs to input theURL below into an RTSP compatible player.  rtsp://<servername>/<network_rtsp_s<0~m‐1>_accessname>    “m” is the stream number.  For details on streaming protocol, please refer to the “control signaling” and “data format”  documents.    8.15 Send Data (capability_nuart > 0)  Note: This request requires Viewer privileges.  Method: GET/POST   ...
  • Page 426 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  no: Do not clear the receive data buffer.  wait  1 ~ 65535 Wait time in milliseconds before read data.    read  1 ~ 128 The data length in bytes to read. The read data will be in    the return page.    Return:  HTTP/1.0 200 OK\r\n  Content‐Type: text/plain\r\n  Content‐Length: <system information length>\r\n  \r\n  <hex decimal data>\r\n  Where hexadecimal data is digits from 0 ~ 9, A ~ F.    8.16 Storage Managements (capability_storage_dbenabled > 0)  Method: GET and POST ...
  • Page 427 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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>  Optional.  Indicate the file media type.  Ex. mediaType=videoclip  * logical “OR” is not supported for this parameter.  destPath  <text>  Optional.  Indicate the file location in camera.  Please embrace your input value with single quotes.  Ex. destPath =’/mnt/auto/CF/NCMF/abc.mp4’  resolution  <text>  Optional.  Indicate the media file resolution.  Please embrace your input value with single quotes.  Ex. resolution=’800x600’ ...
  • Page 428 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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” connectors for logical “OR” search  operations. Moreover, to search for a specific time period, you can use “TO” connector.  Ex. To search records triggered by motion or di or sequential and also triggered between  2008‐01‐01 00:00:00 and 2008‐01‐01 23:59:59.  http://<servername>/cgi‐bin/admin/lsctrl.cgi?cmd=search&triggerType=’motion’+OR+’di’+OR+’seq’ &triggerTime=’2008‐01‐01 00:00:00’+TO+’2008‐01‐01 23:59:59’    Command: queryStatus  PARAMETER  VALUE  DESCRIPTION  retType  xml or javascript  Optional.  Ex. retype=javascript  The default return message is in XML format.    Ex. Query local storage status and call for javascript format return message.  http://<servername>/cgi‐bin/admin/lsctrl.cgi?cmd=queryStatus&retType=javascript ...
  • Page 429 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  endtime  <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 430 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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” means  Ex: vi0=0(200)1  active or triggered state.  Setting virtual input 0 to normal state, waiting 200  Where "nstate" is next  milliseconds, setting it to trigger state.  state after duration.  Note that when the virtual input is waiting for next  state, it cannot accept new requests. ...
  • Page 431 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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” is the channel index.  “m” is the timeshift stream index.  For details on timeshift stream, please refer to the “TimeshiftCaching” documents.    PARAMETER  VALUE  DEFAULT  DESCRIPTION  maxsft  <positive  0  Request cached stream at most how many seconds  integer>  ago.  The value must be a positive integer. (>0) ...
  • Page 432 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  N/A  N/A  Check if the requested stream enables timeshift,  feature and    if minsft is achievable.  If false, return “415 Unsupported Media Type”.  minsft  <positive  0  How many seconds of cached stream client can  integer>  accept at least.  (Used by forcechk)  The value must be a positive integer. (>0)    Return Code ...
  • Page 433 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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 – Stop current operation  positioning – Position the motors  positioning,  irisopen,  irisopen – Fully open iris. It will maintain fully open iris  irisenable  status until sending function=irisenable cgi.  irisenable – return back to user setting status of iris.    direction  direct,  Motor’s moving direction.  forward,  It works only if function=zoom or function=focus.  backward  position  <motor_start> ~  Motor’s position.  <motor_end>  It works only if function=zoom or function= focus and ...
  • Page 434 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  remote_focus_zoom_motor: Current position of zoom motor  remote_focus_focus_motor: Current position of focus motor  remote_focus_zoom_enable: Current function of zoom motor  remote_focus_focus_enable: Current function of focus motor  remote_focus_iris_open: The current status of iris. 0: irisenable,  1: irisopen  Current function of zoom/focus motor, return value as below:  0: no service  1: zooming  2. focusing  3: auto focus  4: focus scan  5: positioning (both zoom motor and focus motor)  12: reset focus    8.20 BackFocus (capability_image_c<0~(n‐1)>_remotefocus=4)  Note: This request requires Administrator privileges.  Method: GET/POST   ...
  • Page 435 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  resetfocus   –   reset focus position to default     irisopen,  irisenable,  irisopen – Fully open iris. It will maintain fully open iris  resetfocus    status until sending function=irisenable cgi.  irisenable – return back to user setting status of iris.    direction  direct,  Motor’s moving direction.  forward,  It works only if function= focus.  backward  position ...
  • Page 436 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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. 0:  irisenable, 1: irisopen  Current function of zoom/focus motor, return value as  below:  0: no service  1: zooming  2. focusing  3: auto focus  4: focus scan  5: positioning (both zoom motor and focus motor)  12: reset focus    8.21 Export Files  Note: This request requires Administrator privileges.  Method: GET    Syntax:    For daylight saving time configuration file: ...
  • Page 437 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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” as a replacement.  http://<servername>/cgi‐bin/admin/upload_dst.cgi    Post data:  filename =<file name>\r\n  \r\n  <multipart encoded form data>    For language file:  http://<servername>/cgi‐bin/admin/upload_lan.cgi    Post data:  filename =<file name>\r\n  \r\n ...
  • Page 438 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved   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    For choose selected lens configuration:  http://<servername>/cgi‐bin/admin/update_lens.cgi?choose_lens=<value>  You need to reboot manually after you choose another lens configuration.    For choose selected lens configuration and reboot camera:  http://<servername>/cgi‐bin/admin/update_lens.cgi?choose_reboot_lens=<value>  The camera will reboot after using this cgi.    For delete selected lens configuration:  http://<servername>/cgi‐bin/admin/update_lens.cgi?delete_lens=<value>    PARAMETER  VALUE  DESCRIPTION  value  <string> ...
  • Page 439 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  Note: This request requires Viewer access privileges.  Syntax:  rtsp://<servername>/mod.sdp?[&stime=<value>][&etime=<value>][&length =<value>][&loctime  =<value>][&file=<value>][&tsmode=<value>]    PARAMETER  VALUE  DEFAULT  DESCRIPTION  stime  <YYYYMMDD_HHMMSS.MMM> N/A  Start time.  etime  <YYYYMMDD_HHMMSS.MMM> N/A  End time.  length  <positive integer>  N/A  The length of media of interest. ...
  • Page 440 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved X  V  V  X  Play recordings for length seconds which ends at  etime    rtsp://10.10.1.2/mod.sdp?etime=20110312_040400.000&length=120 X  X  X  V  Play file file    rtsp://10.10.1.2/mod.sdp?filename=/mnt/link0/       291  440 - User's Manual...
  • Page 441 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  Add a 3D privacy mask at current location  delete  Delete a 3D privacy mask  edit  Edit a 3D privacy mask  maskname  string[40]  3D privacy mask name  maskheight  integer  3D privacy mask height  maskwidth  integer  3D privacy mask width  videosize  <window size>  Optimal. ...
  • Page 442 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved   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>] – Shift without stopping, used for joystick  [&x=<value>&y=<value>&videosize=<value>&resolution=<value>&stretch=<value>] – Click on  image  (Move the center of image to the coordination (x,y) based on resolution or videosize.)  [ [&speedpan=<value>][&speedtilt=<value>][&speedzoom=<value>][&speedapp=<value>][&speedl ink=<value>] ] – Set speeds  [&return=<return page>]    Example:  http://myserver/cgi‐bin/camctrl/camctrl.cgi?channel=0&camid=1&move=right  http://myserver/cgi‐bin/camctrl/camctrl.cgi?channel=0&camid=1&zoom=tele  http://myserver/cgi‐bin/camctrl/camctrl.cgi?channel=0&camid=1&x=300&y=200&resolution=704x 480&videosize=704x480&strech=1    Example: (set the ptz preset with focus mode)  * We support this function when the version number of the PTZ control module is equal or greater  than 5.0.0.20.  http://myserver/cgi‐bin/camctrl/camctrl.cgi?name=xxx&focussetting=sync&cam=getsetpreset ...
  • Page 443 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  speedapp  ‐5 ~ 5  Set the auto pan/patrol speed.  auto  pan  Auto pan.  patrol  Auto patrol.  stop  Stop camera.  zoom  wide ...
  • Page 444 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  DESCRIPTION  focus  auto  Auto focus.  far  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.  cam  getsetpreset  Adds a named preset at current position, and return the  preset index.  * We support this function when the version number of  the PTZ control module is equal or greater than 5.0.0.20.    Syntax: (for query API)  http://<servername>/cgi‐bin/camctrl/camctrl.cgi?[<parameter>] [&<parameter>...]    Example:  http://myserver/cgi‐bin/camctrl/camctrl.cgi?getpan    Response:  HTTP/1.0 200 OK\r\n ...
  • Page 445 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  *Only available when bit1 of  "capability_camctrl_c<0~(n‐1)>_buildinpt" is "1"  getzoom  0, <positive integer>  Get the current zoom position.  getratio  <decimal>  Get the current zoom ratio.  getfocus  0, <positive integer>  Get the current focus position.  getminspeedlv  0, <positive integer>  Get the minimum speed level of the PTZ control. Normally,  the speed level is ‘0,’ which denotes halting a continuous  movement.  getmaxptspeedlv 0, <positive integer> ...
  • Page 446 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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" is "1"  getminzoom  0, <positive integer>  Get the lower limit for zoom position.  getmaxzoom  0, <positive integer>  Get the upper limit for zoom position.  getmaxdzoom  0, <positive integer>  Get the upper limit for digital zoom position.  getmaxratio  <decimal>  Get the maximum ratio of optical zoom.  * We support this parameter when the version number  (getversion) is equal or greater than 5.0.0.14  getmaxdratio  <decimal>  Get the maximum ratio of digital zoom.  * We support this parameter when the version number  (getversion) is equal or greater than 5.0.0.14 ...
  • Page 447 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved   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.  return  <return page>  Redirect to the page <return page> after the parameter  is assigned. The <return page> should be the relative  path according to the root of camera. If you omit this  parameter, it will redirect to an empty page.  * If the <return page> is invalid path, it will ignore this  parameter.   ...
  • Page 448 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved   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.  It means the accumulated percentage amount of flash  block has been written. The range is from 0 to 100 (unit: %).  The SD card is recommended to be replaced if the  percentage reaches above 90%.  smartsd_spare_block_rate:  Usage rate of spare blocks.  It means the usage percentage of total spare block. The  range is from 0 to 100 (unit: %). The SD card is  recommended to be replaced if the percentage reaches  above 90%.  smartsd_data_size_per_unit:  Size (in sectors) of data to be written when Life  Information1 is updated.  smartsd_num_of_sudden_power_failure:  Indicates how many times power disconnection occurred during write/erase  operations ...
  • Page 449 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved Syntax:  http://<servername>/cgi‐bin/admin/connect_ap.cgi    PARAMETER  VALUE  DESCRIPTION  N/A  N/A  Apply the wireless settings and connect to AP.    8.31 Get Wireless Information (capability_network_wireless >  0)    Note: This request requires Administrator privileges.  Method: GET/POST    Syntax:  http://<servername>/cgi‐bin/admin/getwirelessinfo.cgi    PARAMETER  VALUE  DESCRIPTION  N/A  N/A  Get wireless information. Camera will return following  information.  1. Wireless channel  2. Link quality  3. Signal level  4. Noise level  5. SNR  6. TX Rate ...
  • Page 450 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved   PARAMETER  VALUE  DESCRIPTION  N/A  N/A  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  N/A  N/A  Start WPS transaction.    8.34 Peripheral Control (capability_peripheral_c<0~(n‐1)>_  devicecontrol > 0)    Note: This request requires Administrator privileges.  Method: GET/POST    Syntax: (for control API)  http://<servername>/cgi‐bin/admin/peripheral.cgi?channel=<value>&operation=set ...
  • Page 451 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved "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  on  Enable the functionality of washer control  system.    off  Disable the functionality of washer control  system.  washer_dwelltime  15~999  Apply washer washer control system  operation time (including the time when  spraying and wiper actions take place).  heater_status  auto  automatic control the heater component to  keep the device in a workable environment. ...
  • Page 452 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  N/A  Get support peripheral device.  washer_supportmode  N/A  Get the support mode of washer control system.  washer_mode  N/A  Get the current mode of washer control system.    It return the value of "washer_mode"  washer_status  N/A  Get the current status of washer control module.  The status is 'off' as default, which means the  washer is stopped; and the status 'on' means the  washer is running.  washer_dwelltime  N/A  Get the current washer clean period of washer  control system.  heater_supportstatus ...
  • Page 453 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  N/A  N/A  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  fahrenheit temperature of the sensor  devicemonitor_heater_iY_name: the name of heater sensor  devicemonitor_heater_iY_status: Current on/off status of the  heater sensor    X: 0 ~  (capability_peripheral_c<0~(n‐1)>_devicemonitor_tempnum ...
  • Page 454 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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.  305  454 - User's Manual...
  • Page 455 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER  VALUE  DESCRIPTION  "onetimeauto": Camera will automatically adjust the IR  function  getstatus,  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” mode.  optimizedir_c<0~(n‐1)>_irnum:  The number of IR that camera supports.  optimizedir_c<0~(n‐1)>_irstrength:  Only available when irmode is set as manual. It’s a set of  integers, which indicate the strength of each IR LED (e.g.  23,45,100,100).  optimizedir_c<0~(n‐1)>_irstatus:  Current IR status, normal / adjusting:  "normal": the IR LED strength has been fixed.  "adjusting": the IR LED strength is adjusting.    optimizedir_c<0~(n‐1)>_supportmode:  “auto”: automatically adjust the IR control.  “manual”: manual adjustment.    Example:  http://myserver/cgi‐bin/admin/optimizedir.cgi?function=getstatus    Response: ...
  • Page 456 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved   PARAMETER  VALUE  DESCRIPTION  channel  0~"capability_nvideoin"‐1  Channel of the video source.  "set": set the strength of each IR LED separately    operation  set,  settoall  "settoall": use fixed strength for all IR LED  irmode  auto,  Irmode needs to be set as manual for adjusting IR  manual  LED strength.  strength  1~100  If the operation is set as "set", the number of  strength values need to be the same as it of  irnum. However, it needs only one value for  strength when the operation is set as "settoall".    Example:  http://myserver/cgi‐bin/admin/optimizedir.cgi?channel=0&operation=set&irmode=manual&  strength=50,70,50,50,50      Response:  HTTP/1.0 200 OK\r\n  Cache‐control: no‐cache\r\n ...
  • Page 457 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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] – list all adjustment mode that IR supports  [&irmode] – Get current IR mode  [&irnum] – Get the number of IR zone    PARAMETER  VALUE  DESCRIPTION  channel  0~"capability_nvideoin"‐1  Channel of the video source.  support_irmode ...
  • Page 458 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  OK    Example:  http://myserver/cgi‐bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate    Response: ...
  • Page 459 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved   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  N/A  Indicate lensctrl thermal version        Example: ...
  • Page 460 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved http://<servername>/cgi‐bin/admin/audioclip.cgi?operation=<value>[&name=<value>][&index=<value>]    PARAMETER  VALUE  DESCRIPTION  operation  startrecording,  "startrecording" = Record a new audio clip.    stoprecording,  "stoprecording" = Stop an ongoing recording.  "play" = Play an audio clip.    play,  stopplayback,  "stopplayback" = Stop to playback of an audio  remove,  clip.  download  "remove" = Delete a clip.    "download" = Download a clip to the client.  * Recording time is limited to 60 seconds.  name  <string>  Name of the audio clip.  The audio clip the action applies to. We  support two interfaces (name or index) to  specify the media clip to be played.  index  0, 1  Number of the audio clip.  The audio clip the action applies to. We ...
  • Page 461 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved If the user requests include an invalid parameter value, we will use the default value.  PARAMETER  VALUE  DESCRIPTION  operation  Set  Set formatting parameters and start  formatting  fstype  fat32, ext4  fat32: High compatibility for PC, but  low stability for Data  ext4 : Low compatibility for PC, but  high stability for Data.  1: Completely clean data (fat32  fullformat  0, 1  support only)  blockingmo blocking  blocking: Send an HTTP response at  de  the end of the format.  nonblocking: Send an HTTP response  at the start of the format  index  0~N  which one SD card    Example:  Request of format SD card:  http://myserver/cgi‐bin/admin/format_sdcard.cgi?operation=set&fstype=ext4   ...
  • Page 462 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved Get    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  ERROR: Format SD failed, but removed all contents success  ERROR: Format SD failed, and failed to remove all contents  ERROR: Please insert SD card  ERROR: Please use ext file system  ERROR: File system type is not supported  ERROR: The device does not exist or is busy  ERROR: Formatted successfully, but cannot create database  8.40  for Accessing Streaming  Methods 8.39.1 Get Stream URI (capability_media_streamprofiles_support = 1) ...
  • Page 463 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved “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.    PARAMETER  VALUE  DESCRIPTION  pimssm  1  1: Enable the feature of Protocol  Independent Multicast ‐ Source  Specific Multicast.  * This field is only required when  using PIM‐SSM feature.  * Only valid when  network_rtsp_pimssm_enable=1.    Example:  Request the streaming of streamprofile_i0_token=Profile200,  rtsp://192.168.1.1:554/media2/stream.sdp?profile=Profile200    Note:  If the requested certain profile streamprofile_i<x>_occupied=0, which indicates stream profile <x>  has not been created, the above method for requesting RTSP streaming will fail.   SDP for always multicast  8.39.2 Get  ...
  • Page 464 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  1: Enable the feature of Protocol  pimssm  1  Independent Multicast ‐ Source  Specific Multicast.  * This field is only required when  using PIM‐SSM feature.  * Only valid when  network_rtsp_pimssm_enable=1.    Note:    1. This method is only valid when always multicast is enabled, i.e.  streamprofile_i<x>_alwaysmulticast=1.  2. If the requested certain streamprofile_i<x>_profilename is empty, which indicates stream profile  <x> doesn’t have a valid SDP file, the above method of requesting SDP file will fail.  3. If there existed two or more streamprofile_i<x>_profilename which have the same value, the  requested SDP file will be overwrite by the last request.  8.41 Accessing SFTP server and client  8.40.1 SFTP server setting for event action ...
  • Page 465 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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>  sftp port  index  0~4  Event setting server index    * This field is required.  username  string[64]  Sftp server username    * This field is required.  passwd  string[64]  Sftp server password    * Required when operation=automode.  fingerprint_enable  <Boolean>  Verify fingerprint ...
  • Page 466 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved "ed25519": faster to generate with higher  keytype  ed25519, rsa, ecdsa  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. The selected order  will be ed25519/rsa/ecdsa until successful  pairing, an error message will return if all keytype  failed.    * Required when operation=download.  Example of download key:  Request:  http://<servername>/cgi‐bin/admin/sftpclient.cgi?operation=manualmode&key=download&index= 1&address=<ip>&username=xxx&fingerprint_enable=1&fingerprint_content=<MD5  value>&keytype=ecdsa  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  ok    Request:  http://<servername>/cgi‐bin/admin/sftpclient.cgi?operation=manualmode&key=download&index= 1&address=<ip>&username=xxx&fingerprint_enable=1&fingerprint_content=<MD5  value>&keytype=test    Response of failure:  HTTP/1.1 200 OK\r\n ...
  • Page 467 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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; name="parameter"    operation=manualmode&key=upload&index=1  ‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐7e1309282ed0f1a  Content‐Disposition: form‐data; name="uploadKeyFile"; filename="id_rsa"  Content‐Type: text/plain    ‐‐‐‐‐BEGIN RSA PRIVATE KEY‐‐‐‐‐  Proc‐Type: 4,ENCRYPTED  DEK‐Info: AES‐128‐CBC,E6B9F3F257EF2DA03BA8A4832BC6386F    NYzaqdoY7OxS0XhviOKncGbMLpnx6n3VRYbeArSBwn+6wA7Y4lknFoMQiuC4HrCa  oHgEex609584TWFBrkR+DfqKB73RCALTeAqAhEtywq75KQTWyHJcpOu8qZxquoKE  TovnyQQANfyNLykEtP7U7Htxbdqg4dqYdFahJEBNs0QHxhmYHTESccKM4NOB0qMY  5+9gwlMZqNIymxGlGwylTMcV7gV6JaY/bX0K4J0B6AhNHjCIOFErrQivp026TXj9  m+bnnrAt7v5uBMH4oclPC8oDHqd1jWwHIBcbqjRPWL37VW5B+YPZQ7FVUP496OKp  riheNLTF6yOtYFw9syyoOnRF+gxpFpQrSO7skENGyv4CO7kH/S7Kpc7qmMgTk/rL  s12230NogZsqghhTJIpg2vX5Ha3wCDIZZVKPUGItQl0MB6t74nsV1o8YVtRovI5F ...
  • Page 468 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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  operation  getserverhostkey  " getserverhostkey ": Auto scan  SFTP server host key.    * This field is required.  address  <sftp server address or hostname>  sftp server address or hostname ...
  • Page 469 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved <MD5 value>      8.40.2 SFTP Server Setting  * Only available when bit 1 of "capability_protocol_ftp_server" is 1.  Syntax: (for control API)  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” after key is generated.  * This field is required.  Example of re‐generate host key:  Request:  http://<servername>/cgi‐bin/admin/sftpserver.cgi?operation=updatehostkey    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  ok     ...
  • Page 470 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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>  321  470 - User's Manual...
  • Page 471: 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 472: 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