Page 1 IP9181-HT-v2, IP9191-HT-v2 Box Network Camera User ’s Manual 5/8MP • i-CS/P-iris/DC-iris • H.265 • WDR Pro II • Remote Back Focus • Smart Stream III • SNV II • 3DNR Rev. 1.0...
Page 2: Table Of Contents
VIVOTEK Table of Contents Overview ..................................Revision History ..............................3 Read Before Use ..............................4 Package Contents ..............................4 Symbols and Statements in this Document ......................4 Physical Description ............................... 9 Hardware Installation ............................10 Software Installation ............................. 16 Network Deployment ............................19 Ready to Use ................................
Page 3: Overview
VIVOTEK Applications > Shock detection ....................... 145 Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) ... 146 Recording > Recording settings ......................149 Storage > Storage management ......................154 Storage > Content management ......................157 Appendix ..............................URL Commands for the Network Camera ....................
Page 4: Read Before Use
VIVOTEK 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. It is the user’s responsibility to ensure that the operation of such devices is legal before installing this unit for its intended use.
Page 5 VIVOTEK IMPORTANT: 1. The wire gauge for the required protective earth conductor is 18AWG (green and yellow). 2. Ensure to connect one end to the protective earth terminal and the other to earth. 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.
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: Physical Description
VIVOTEK Physical Description Front Panel Light Sensor Lens Rear Panel MicroSD Card Slot Audio In BNC connector Audio Out Recessed Reset Button General I/O Terminal Block Grounding screw Ethernet 10/100 RJ45 Socket Status LED IMPORTANT: If DC power is preferred, it should comply with: O/P: 12VDC, 2A min., L.P.S. per IEC 60950-1.
Page 8: Hardware Installation
VIVOTEK Hardware Installation 1. Jot down the camera's MAC address for later reference. XXXXXX 0002D10766AD 2. Install the lens module to the camera. 3. Connect the iris control cable to the socket on the camera. 8 - User's Manual...
Page 9 VIVOTEK 4. Install the camera stand to camera. 5. Connect an Ethernet cable to the camera. When choosing the lens for your camera, please notice the specifications as below. The screw mount (distance A-C) must be shorter than 5.2mm; in case that the bottom of screw mount may hit the IR Cut Filter.
Page 10 VIVOTEK 6. Install a MicroSD card, and, if preferred, connect DI/DO wires to the terminal block. The AC/DC pins can accept either 12V or 24V power input. AC24V has with no polarity. AC/DC- pw 12V or 24V AC/DC+ pw RS485+ RS485- DI- (common GND for all DIs) DI2+...
Page 11 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 12 VIVOTEK Dry contact and using camera’s DO+ to supply a relay. Switch External AC power with Protected Eart h Relay External Device 7. 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 13 VIVOTEK 8. With a live view on screen, adjust the image zoom and focus using the Zoom and Focus pullers on the lens module. You can purchase the AE-23E-V2/AE-244 enclosure kit for outdoor LPR installations. LED Definitions Item LED status Description Steady Powered and system booting, or network...
Page 14: Software Installation
VIVOTEK Software Installation 9. 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. 9-1.
Page 15 VIVOTEK 9-3. The program will search for all VIVOTEK network devices on the same LAN. 9-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 16 VIVOTEK Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~. You can use them in the password combination. 10-2. 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 17: Network Deployment
VIVOTEK Hardware Reset Reset Button 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 18 VIVOTEK When using a non-PoE switch Use a PoE power injector (optional) to connect between the Network Camera and a non- PoE switch. PoE Power Injector (optional) Non-PoE Switch NOTE: 1. The camera is only to be connected to PoE networks without routing to outside plants. 2.
Page 19 VIVOTEK 2. In this case, if the Local Area Network (LAN) IP address of your Network Camera is 192.168.0.3, please forward the following ports for the Network Camera on the router. ■ HTTP port: default is 80 ■ RTSP port: default is 554 ■...
Page 20 VIVOTEK For more information with network configuration options (such as that of streaming ports), please refer to Configuration > Network Settings. VIVOTEK also provides the automatic port forwarding feature as an NAT traversal function with the precondition that your router must sup- port the UPnP port forwarding feature.
Page 21: Ready To Use
VIVOTEK Ready to Use 1. A browser session with the Network Camera should prompt as shown below. 2. You should be able to see live video from your camera. You may also download and install the 32-channel recording software from VIVOTEK's website in a deployment consisting of multiple cameras.
Page 22: 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 23 VIVOTEK ► By default, the Network Camera is not password-protected. To prevent unauthorized access, it is highly recommended to set a password for the Network Camera. For more information about how to enable password protection, please refer to Security on page 104.
Page 24 VIVOTEK IMPORTANT: • Currently the Network Camera utilizes 32-bit ActiveX plugin. You CAN NOT open a management/view session with the camera using a 64-bit IE browser. • If you encounter this problem, try execute the Iexplore.exe program from C:\Windows\ SysWOW64. A 32-bit version of IE browser will be installed. • On Windows 7, the 32-bit explorer browser can be accessed from here: C:\Program Files (x86)\Internet Explorer\iexplore.exe • If you open a web session from the IW2 utility, a 32-bit IE browser will be opened.
Page 25: Using Rtsp Players
VIVOTEK Using RTSP Players To view the streaming media using RTSP players, you can use one of the following players that support RTSP streaming. VLC media player VLC media player mpegable Player 1. Launch the RTSP player. 2. Choose File > Open URL. A URL dialog box will pop up. pvPlayer 3.
Page 26: 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 27: Using Vivotek Recording Software
VIVOTEK Using VIVOTEK Recording Software Visit our website for download the VAST recording software that provides 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 28: 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 Configuration Logo Area...
Page 29 VIVOTEK Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 35. 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 30 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 119 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 31 VIVOTEK Video Control Buttons: Depending on the Network Camera model and Network Camera configuration, some buttons may not be available. Snapshot: Click this button to capture and save still images. The captured images will be displayed in a pop-up window. Right-click the image and choose Save Picture As to save it in JPEG (*.jpg) or BMP (*.bmp) format.
Page 32 VIVOTEK Mute: Turn off the Mic volume on the local computer. The button becomes the Mic On button after clicking the Mute button. Full Screen: Click this button to switch to full screen mode. Press the “Esc” key to switch back to normal mode.
Page 33: 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 34 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 35 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 36 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 37 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 38: 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 39: System > General Settings
VIVOTEK System > General settings This section explains how to configure the basic settings for the Network Camera, such as the host name and system time. It is composed of the following two columns: System, and System Time. When finished with the settings on this page, click Save at the bottom of the page to enable the settings.
Page 40 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 41 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 42: 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 43 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 filed. Click Save to enable the settings.
Page 44 VIVOTEK ■ Follow the steps below to set up the customed 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 45: 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 46 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 47: System > Parameters
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. System >...
Page 48: 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 49 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 84). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
Page 50 VIVOTEK Import/Export files This feature allows you to Export / Update daylight saving time rules, custom language file, configuration file, and server status report. 50 - User's Manual...
Page 51 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 52: Media > Image
VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. The Focus window is available only for models that come with motorized lens. General settings Video title Show_timestamp_and video_title_in_video_and_snapshots: Enter a name that will be displayed on the title bar of the live video as the picture shown below.
Page 53 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 54 VIVOTEK IR cut filter With a removable IR-cut filter, this Network Camera can automatically remove the filter to let IR light enter the light sensor during low light conditions. ■ Auto mode The Network Camera automatically removes the filter by judging the level of ambient light. ■...
Page 55 VIVOTEK Illuminators 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. A Digital Output connection to an external IR is needed. Spectrum mode Select the light source in your application in the night time.
Page 56 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 56 for how to do it.
Page 57 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 58 VIVOTEK Highlight mask ■ If there is a strong light source in your application, e.g., light pole, enable this function to avoid negative interference. Noise reduction ■ Enable noise reduction: Check to enable noise reduction in order to reduce noises and flickers in image.
Page 59 VIVOTEK Exposure On this page, you can configure 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 60 VIVOTEK Tips: • The LPC model comes with pre-configured firmware for special Exposure > Shutter Priority configuration. That aims for traffic monitoring and control applications. Normally you need not change the related Exposure settings here. The inclusive window refers to the “weighed window“; the exclusive window refers to “ignored window“.
Page 61 VIVOTEK ■ Iris adjustment: Use the pull bar to change the aperture size. The preset iris aperture setting will apply. ■ AE Speed Adjustment: This function applies when you need to monitor fast changing lighting conditions. For example, the camera may need to monitor a highway lane or entrance of a parking area at night where cars passing by with their lights on can bring fast changes in light levels.
Page 62 VIVOTEK Please follow the steps below to set up a profile: 1. Select the Profile mode tab. 2. Select the applicable mode: Night mode or Schedule mode. Please manually enter a range of time if you choose the Schedule mode. 3.
Page 63 VIVOTEK Lens configuration If you apply a different lens to the camera, you can upload a different configuration file (containing an image library) for the specific lens module without updating the entire firmware. Please contact VIVOTEK's technical support for the supported Lens configuration files. Note that applying a new lens configuration requires a camera reboot.
Page 64 VIVOTEK Focus (This function applies when using the auto focus lens) Focus here refers to the Remote Focus, is applicable to Network Cameras that are equipped with 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 65 VIVOTEK If using an iCS lens model, use the auto focus function for an optimal image. The configuration page automaticallly displays different options according to the lens you installed. iCS lens User's Manual - 65...
Page 66 VIVOTEK Below is the procedure to perform the automated Focus function: 1. Select from the bottom of the screen whether you want to perform focus adjustment on the Full view or within a Custom focus window. You can create a custom window and click and drag the window to a desired position on screen.
Page 67 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 68 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 69 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 set the privacy mask windows, follow the steps below: 1. Click New to add a new window. 2.
Page 70: Media > Video
VIVOTEK Media > Video Mode - Resolution and Frame rate With the WDR Pro II enabled for the high-contrast environment, the maximum frame rate is 30fps. With the WDR Pro function, you can enjoy a higher frame rate for up to 60fps (e.g., in traffic monitoring).
Page 71 VIVOTEK Stream settings This Network Camera supports multiple streams with frame sizes ranging from 640 x 360 to 1920 x 1080 pixels. ■ Stream 1: The default frame size for Stream 1 is set to the 2560 x 1920. ■ Stream 2: The default frame size for Stream 2 is set to the 2560 x 1920. ■...
Page 72 VIVOTEK Please follow the steps below to set up those settings for a stream: 1. Select a stream for which you want to set up the viewing region. 2. Select a Region of Interest from the drop-down list. The floating frame, the same as the one in the Global View window on the home page, will resize accordingly.
Page 73 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 offers real-time H.265, H.264, and MJPEG compression standards (Triple H.264 H.265 Codec) for real-time viewing. If the mode is selected, the video is streamed via the RTSP protocol.
Page 74 VIVOTEK ■ 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 75 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 re-encodes old frames when no motions occur in scene.
Page 76 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. Select an operation mode if Smart codec is preferred. - Auto tracking: The Auto mode configures the whole screen into the non-interested area.
Page 77 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 78 VIVOTEK Video quality ■ Constant bit rate: • Constant 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,...
Page 79 VIVOTEK • Fixed quality: On the other hand, if Fixed quality is selected, all frames are transmitted with the same quality; bandwidth utilization is therefore unpredictable. The video quality can be adjusted to the following settings: Medium, Standard, Good, Detailed, and Excellent. You can also select Customize and manually enter a value.
Page 80 VIVOTEK 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 81: 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 82 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 83: 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 84: 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 85 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 86 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 87 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 88 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 89 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 90 VIVOTEK 90 - User's Manual...
Page 91: Network > Streaming Protocols
VIVOTEK Network > Streaming protocols HTTP streaming To utilize HTTP authentication, make sure that your have set a password for the Network Camera first; please refer to Security > User account on page 104 for details. Authentication: Depending on your network security requirements, the Network Camera provides two types of security settings for an HTTP transaction: basic and digest.
Page 92 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 93 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 digest potential risks of it being intercepted.
Page 94 VIVOTEK Multicast settings for streams: Click the items to display the detailed configuration information. Select the Always multicast option to enable multicast for video streams. 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.
Page 95 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 96 VIVOTEK Audio is being transmitted to the Network Camera 2011/03/09 17:08:56 Video (TCP-AV) Mute Talk Button Mic Volume Click to enable audio transmission to the Network Camera; click to adjust the volume of microphone; click to turn off the audio. To stop talking, click again.
Page 97 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 98 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 99 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 100 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 101 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 102: 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 103: 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 104: 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 105: 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 106 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.
Page 107: 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 108 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 109 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 110 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 111 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. User's Manual - 111...
Page 112 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. 112 - User's Manual...
Page 113 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 114: 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 115 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 116 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 117 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 118 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 119 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 120: Ptz > Ptz Settings
VIVOTEK PTZ > PTZ settings This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation. 1. 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. 2.
Page 121 VIVOTEK Home page in Mechanical PTZ Mode This view is only avaialbe when the 3rd video profile (Live view) is selected. The 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 preset position. ■...
Page 122 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 123: Ptz
VIVOTEK Mechanical PTZ Operation Select the “Mechanical” tab to display the RS485 Settings: RS485 Settings Disable: Select this option to disable this function. PTZ camera: Select this option to enable PTZ operation. To utilize this feature, please connect the Network Camera to a PTZ driver or scanner via RS485 serial interface first.
Page 124 VIVOTEK Transparent HTTP Tunnel: If you want to use your own RS-485 device, you can use UART commands to build a Transparent HTTP Tunnel. The UART commands will be sent through HTTP tunnel established between the RS-485 device and the camera. For detailed application notes, https://vivotek.force.com/Customers/s/ please refer to URL Commands started on page 160 or to search...
Page 125 VIVOTEK Home page in Mechanical PTZ Mode The 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 preset position. 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.
Page 126: 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 127 VIVOTEK ■ Event name: Enter a name for the event setting. ■ Enable this event: Select this option 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 128 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 129 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. ■ Trigger digital output for seconds Select this option to turn on the external digital output device when a trigger is activated. Specify the length of the trigger interval in the text box.
Page 130 VIVOTEK ■ Play audio clip: A pre-loaded audio clip can be configured to be played when one triggering condition is met. For example, when an intruder is detected, the event plays a warning message to deter an intruder. ■ Backup media if the network is disconnected Select this option to backup media file on SD card if the network is disconnected.
Page 131 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 132 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 133 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. To verify if the FTP settings are correctly configured, click Test.
Page 134 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 152 for details. Note that only one NAS server can be configured. Click Save server to enable the settings. ■...
Page 135 VIVOTEK Click 20180120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2018/01/20 2018/01/20 Click to go back to the previous Click to delete level of the directory selected items Click to delete all recorded data 2018/01/20 2018/01/20...
Page 136 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 137 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_20200113_100341 File name preﬁx Date and time sufﬁx 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 138 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_20200113_100341 File name preﬁx...
Page 139 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 140: 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 141: 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 142: Applications > Di And Do
VIVOTEK Applications > DI and DO Digital input: Select High or Low as the Normal status for the digital input. 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. Connect the digital output pin of the Network Camera to an external device to determine the current status.
Page 143: 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 144: 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 145 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 146: 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 147: Applications > Package Management - A.k.a., Vadp (Vivotek Application Development Platform)
VIVOTEK Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) Users can store and execute VIVOTEK's or 3rd-party software modules onto the camera's flash memory or SD card. These software modules can apply in video analysis for intelligent video applications such as license plate recognition, object counting, or as an agent for edge recording, etc.
Page 148 VIVOTEK 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. By then the module status will become OFF, and the X button will appear at the end of the row.
Page 149 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 - 149...
Page 150: 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 151 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 152 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 server, 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 153 VIVOTEK If successful, you will receive a test.txt file on the network storage server. 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 limitation must be larger than the reserved amount for cyclic recording.
Page 154 VIVOTEK Event If you want to enable recording notification, please click to configure event triggering settings. Please refer to Event > Event settings on page 125 for more details. When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page.
Page 155: Storage > Storage Management
VIVOTEK Storage > Storage management 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 156 VIVOTEK SD card control ■ Minimum reserved storage space: The reserved space can be used as a customized turn-around space when the storage is about to be full and needs to delete old recordings. ■ 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.
Page 157 VIVOTEK NAS control ■ Minimum reserved storage space: This can be used to configure the percentage of space threshold for the camera commencing space clean-ups. The minimum reserved space is 512MB for SD card; 1GB for a network share. ■ 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.
Page 158: 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 159 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 160 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: C l i c k switch pages ■...
Page 161: 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 162 VIVOTEK © 2023 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.
Page 163 VIVOTEK © 2023 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.
Page 164 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 4. Security Level SECURITY LEVEL SUB-DIRECTORY DESCRIPTION anonymous Unprotected. 1 [view] viewer Can view, listen, and talk to camera. 4 [operator] operator Operator access rights can modify most of the camera’s parameters except some privileges and network options. 6 [admin] admin Administrator access rights can fully control the...
Page 165 VIVOTEK © 2023 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.
Page 166 VIVOTEK © 2023 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 166 - User's Manual...
Page 167 VIVOTEK © 2023 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>...
Page 168 VIVOTEK © 2023 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 168 - User's Manual...
Page 169 VIVOTEK © 2023 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 “,’,<,>,&...
Page 170 VIVOTEK © 2023 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.
Page 171 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <blank> * We replace "system_ntp" with "system_ntpserver_i0" since httpversion 0320a. ntpserver_i<0~4> <domain NTP server. name>, <ip address>, * We support this parameter when the <blank> version number (httpversion) is equal or greater than 0320a.
Page 172 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Rome, Stockholm, Vienna, Madrid, Paris, Warsaw, Budapest, Bern 41: GMT 01:00 Amsterdam, Berlin, Rome, Stockholm, Vienna, Madrid, Paris, Warsaw, Budapest, Bern 80: GMT 02:00 Athens, Helsinki, Riga 81: GMT 02:00 Cairo 82: GMT 02:00 Lebanon 83: GMT 02:00...
Page 173 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 440: GMT 11:00 Magadan, Solomon Is., New Caledonia, Vladivostok 480: GMT 12:00 481: GMT 12:00 Auckland, Wellington, Fiji, Marshall Is. -480: GMT 12:00 Eniwetok, Kwajalein 520: GMT 13:00 Nuku'Alofa * We replace this parameter with “system_tz”...
Page 174 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) version number (httpversion) is equal or greater than 0314b. restore Restore the system parameters to default <positive values after <value> seconds. integer> reset Restart the server after <value> seconds <positive if <value>...
Page 175 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <positive values except the vadp parameters and integer> VADP modules that stored in the system. This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.
Page 176 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved Subgroup of system: info (The fields in this group are unchangeable.) NAME VALUE SECURITY DESCRIPTION (get/set) modelname string[40] Internal model name of the server extendedmodelname string[40] ODM specific model name of server (eg. DCS-5610).
Page 177 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) (maxcount-1)> 7.2 Status Group: status NAME VALUE SECURITY DESCRIPTION (get/set) di_i<0~(k-1)> <boolean> 0 => Inactive, normal <product dependent> 1 => Active, triggered (capability_ndi > 0) k is determined by the below criterion: The following applies for capability_extension_di_num >= 0...
Page 178 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Otherwise, * k=capability_ndo onlinenum_rtsp 0,<positive Current number of RTSP integer> connections. onlinenum_httppush 0,<positive Current number of HTTP push server integer> connections. onlinenum_sip 0,<positive Current number of SIP connections. integer>...
Page 179 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved * if extension_connected=1, k=capability_ndi * if extension_connected=0, k=capability_ndi+ capability_extension_di_num Otherwise, * k=capability_ndi NAME VALUE SECURITY DESCRIPTION (get/set) normalstate high, Indicates open circuit or closed circuit (inactive status) 7.4 Digital Output Behavior Define Group: do_i<0~(k-1)>...
Page 180 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) user_i0_pass password[64] Root password user_i<1~20>_pass password[64] User password user_i0_privilege view, Root privilege operator, admin user_i<1~20>_ privilege view, User privilege operator, admin 7.6 Network Group: network NAME VALUE SECURITY DESCRIPTION (get/set)
Page 181 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) ”/cgi-bin/admin/setparam.cgi? network_preprocess=9&network_http_ port=5556& network_rtp_videoport=20480” type lan, Network connection type. pppoe resetip <boolean> 1 => Get ipaddress, subnet, router, dns1, dns2 from DHCP server at next reboot. 0 => Use preset ipaddress, subnet, rounter, dns1, and dns2.
Page 182 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) certificate_exist <boolean> Certificate installed flag (for TLS) certificate_time 0,<positive Certificate installed time. Represented integer> in EPOCH certificate_size 0,<positive Certificate file size (in bytes) integer> privatekey_exist <boolean> Private key installed flag (for TLS) privatekey_time 0,<positive Private key installed time.
Page 183 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 7.6.3 IPV6 Subgroup of network: ipv6 (capability_protocol_ipv6 > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable IPv6. addonipaddress <ip address> IPv6 IP address. addonprefixlen 0~128 IPv6 prefix length. addonrouter <ip address> IPv6 router address.
Page 184 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) video1s1.mjpg = c0_s0_accessname, (channel1stream1) video1s2.mjpg = c0_s1_accessname, (channel1stream2) video1s3.mjpg = c0_s2_accessname, (channel1stream3) video1s4.mjpg = c0_s3_accessname, (channel1stream4) etc. * We replace this parameter with "network_http_c<0~(capability_nvideoin -1)>_s<0~(capability_nmediastream-1)>_ accessname " when the version number (httpversion) is equal or greater than 0311c.
Page 185 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) (channel2stream2) etc. * We support this parameter when the version number (httpversion) is equal or greater than 0311c. 7.6.7 HTTS Port Subgroup of network: https (capability_protocol_https > 0) NAME VALUE SECURITY...
Page 186 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) (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 c<0~(capability_nvide...
Page 187 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 7.6.9 RTSP Multicast Subgroup of network: rtsp_s<0~(n-1)>_multicast n denotes the value of "capability_nmediastream * capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) alwaysmulticast <boolean> Enable always multicast. ipaddress <ip Multicast video IP address. address> * We replace "network_rtsp_s<0~(n-1)>_multicast_ipaddress"...
Page 188 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 7.6.10 SIP Port Subgroup of network: sip (capability_protocol_sip> 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 1025 ~ 65535 SIP port. 7.6.11 RTP Port Subgroup of network: rtp NAME VALUE SECURITY DESCRIPTION (get/set) videoport 1025 ~ 65535 Video channel port for RTP.
Page 189 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) or greater than 0312a. 7.6.14 SFTP server * Only available when bit 1 of "capability_protocol_ftp_server " is 1. Subgroup of network: sftp NAME VALUE SECURITY DESCRIPTION (get/set) port Local sftp server port.
Page 190 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 7.8 Video Input <Not Recommended to use> Group: videoin * We do not support this parameter when "capability_nvideoin > 1". NAME VALUE SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 CMOS frequency. * Only available when capability_videoin_type is 2.
Page 191 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "sodiumauto": sodium vapor lamps. "snowauto": Auto white balance by individual sensor, focusing on high colour temperature, snow. "snowpanorama": Auto white balance by panoramic view, focusing on high colour temperature, snow. * Only available when "capability_image_c<0~(n-1)>_wbmo de"...
Page 192 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * 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, Control DC-Iris mode.
Page 193 VIVOTEK © 2023 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. flip <boolean> Flip the image. * We do not support this parameter when "capability_nvideoin >...
Page 194 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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.
Page 195 VIVOTEK © 2023 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. maxexposure <1~32000>, Maximum exposure time <product dependent>...
Page 196 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * 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 Group: videoin_c<0~(n-1)>...
Page 197 VIVOTEK © 2023 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. "snowauto": Auto white balance by individual sensor, focusing on high colour temperature, snow.
Page 198 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Normalized range. exposurelevel 0~12 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...
Page 199 VIVOTEK © 2023 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 0302a. * Only available when "capability_image_c<0~(n-1)>_exposu re_mode" !=0 irismode fixed, indoor, outdoor Control DC-Iris mode.
Page 200 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "capability_image_c<0~(n-1)>_sensor type" is "smartsensor" * Only available when "capability_image_c<0~(n-1)>_iristype "=piris enableblc <boolean> Enable backlight compensation <Not support * Not support this parameter anymore> anymore when the version number (httpversion) is equal or greater than 0301a.
Page 201 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) re_rangetype" is "twovalues". gainvalue 0~100 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 202 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 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] Enclose caption. imprinttimesta <boolean>...
Page 203 VIVOTEK © 2023 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 * Available value is listed etc. * This parameter may also restrict "capability_image_c<0~(n- image frame rate from sensor due to 1)>_exposure_maxrange"...
Page 204 VIVOTEK © 2023 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. enablepreview <boolean> Usage for UI of exposure settings. Preview settings of video profile.
Page 205 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 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. * We support this parameter when the version number (httpversion) is equal or greater than 0310a.
Page 206 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) s<0~(m-1)>_h2 <boolean> 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.
Page 207 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "quant"= 100. s<0~(m-1)>_h2 20000~"capability_videoin The maximum allowed bit rate in fixed 64_maxvbrbitr _c<0~(n-1)>_h264_maxbit quality mode. rate" When the bit rate exceeds this value, frames will be dropped to restrict the bit rate.
Page 208 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "capability_videoin_c<0~(n-1)>_h264 _maxframerate" s<0~(m-1)>_h2 Indicate H264 profiles 64_profile * Available values can also 0: baseline be <string> listed in 1: main "capability_videoin_c<n>_ 2: high h264_profile" * It’s recommended to use available values from "capability_videoin_c<n>_h264_profil e".
Page 209 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 65_quant 99, 100 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue" * Only available when h265 is listed in "capability_videoin_codec"...
Page 210 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only valid when "h265_ratecontrolmode"= vbr s<0~(m-1)>_h2 1~5, 100 Set the pre-defined quality level: 65_cbr_quant 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent"...
Page 211 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 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 "capability_videoin_codec". s<0~(m-1)>_h2 Available values are listed Indicate H265 profiles 65_profile in "...
Page 212 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 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)
Page 213 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) s<0~(m-1)>_mj 1~100 Select customized quality in a peg_cbr_qperc normalized full range. 1: Worst quality 100: Best quality * Only valid when "mjpeg_ratecontrolmode"= cbr and "quant"= 100. s<0~(m-1)>_mj 20000~"capability_videoin The target bit rate in constant bit rate peg_bitrate...
Page 214 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 2: Enable WDR Pro II. * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode" = 2 wdrpro_streng 1~100 The strength of WDR Pro. The bigger value means the stronger <product strength of WDR Pro.
Page 215 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1 aespeed_sensi 1~100 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)
Page 216 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Available value is listed "capability_fisheyelocaldewarp_c<0~( capability_nvideoin)-1>" > 0 "capability_videoin_c<0~( n-1)>_localdewarp_typece ilingmount" and "capability_videoin_c<0~( n-1)>_localdewarp_typew allmount" Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h264_smartstream2 (capability_smartstream_support=1 and capability_smartstream_version>=2.0) Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h265_smartstream2 (capability_smartstream_support=1, capability_smartstream_version>=2.0 and h265 is listed in "capability_videoin_codec") n denotes the value of "capability_nvideoin",m denotes the value of "...
Page 217 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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.
Page 218 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <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 hh:mm Begin time of schedule mode.
Page 219 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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 "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". shuttervalue <1~32000>, Exposure time <product <5~32000>, 1~32000 =>...
Page 220 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * It's recommanded to use "exposurewin_c<n>_mode" to switch on/off BLC. exposurelevel 0~12 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...
Page 221 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "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"...
Page 222 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) on high colour temperature, snow. * Only available when "capability_image_c<0~(n-1)>_wbmo de" !="-" rgain 0~100 Manual set rgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain"...
Page 223 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". mingain 0~100 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_mi ngain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range.
Page 224 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "outdoor": Auto-setting P-Iris to get <product 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".
Page 225 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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 The strength of WDR Pro. The bigger value means the stronger <product strength of WDR Pro.
Page 226 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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 The sensitivity of AE converge speed. tivity 1~20: level 1 <product...
Page 227 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved ipversion IPv4, IPv6 The version of internet protocol. 1 ~ 255 Multicast video time to live value. 7.9 Time Shift Settings Group: timeshift for n channel products and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" (capability_timeshift >...
Page 228 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, Set IR cut control mode <Not day, * We replace this parameter with recommended to night, “ircutcontrol_c0_mode” when the use this> version number (httpversion) is equal schedule…etc or greater than 0312a.
Page 229 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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.
Page 230 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) is equal or greater than 0400a. enablewled <boolean> Enable/disable built-in White led <Not * Only available when " recommended to capability_daynight_c<0~"capability_ use this> nvideoin"-1>_builtinwled > 0". * We replace this parameter with "ircutcontrol_illuminators_builtin_whi teled_enabled"...
Page 231 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) capability_daynight_c<0~(n-1)>_ircuts ensitivity_type=normalize * Only available when "capability_daynight_c<0~(n-1)> _ircutsensitivity_type" is not "-". * We replace this parameter with ircutcontrol_c<0~(n-1)>_sensitivity” when the version number (httpversion) is equal or greater than 0312a.
Page 232 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved (get/set) mode auto, Set IR cut control mode day, * We support this parameter when night, the version number (httpversion) is equal or greater than 0312a. schedule…etc * Available values are listed in "capability_daynig ht_c<0~(n-1)>_mo de"...
Page 233 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved ~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.
Page 234 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved the version number (httpversion) is equal or greater than 0312a. builtin_whiteled_enable <boolean> Enable/disable built-in white led * Only available when "capability_daynight_illuminators_buil tin_support > 0" and "whiteled" is listed in "capability_daynight_ illuminators _builtin_type" * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
Page 235 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 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" optimize_target_enable <boolean> Enable the target zone function or not * Only available when "capability_daynight_illuminators_opt imize_target"...
Page 236 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved overexposing target zone. if set to "100", it means the algorithm has the lowest strength to avoid overexposing target zone. * Only available when "capability_daynight_illuminators_opt imize_target" != - 7.11 Image Setting per Channel Group: image_c<0~(n-1)>...
Page 237 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) is equal or greater than 0400a. saturation -5~5,100 -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"...
Page 238 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) saturationpercent 0~100 Set saturation in the normalized range. 0: Less saturation <-> 100: More saturation * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicse tting" is 1. sharpnesspercent 0~100 Set sharpness in the normalized range.
Page 239 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) dnr_mode <boolean> 3D noise reduction. <product 0:disable dependent> 1:enable * Only available when "capability_image_c<0~(n-1)>_dnr" is dnr_strength 1~100 Strength of 3DNR <product * Only available when dependent> "capability_image_c<0~(n-1)>_dnr" is defog_mode <boolean>...
Page 240 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) e". dis_strength 1~100 Strength of digital image stabilizer <product * Only available when 'dis' is listed in dependent> "capability_image_c<0~(n-1)>_is_mod e". scene_mode visibility, Value of scene mode <product noiseless, * Only available when dependent>...
Page 241 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) deinterlace_mode spatial,blend Users can choose between two different deinterlacing techniques: Spatical mode provides the best image quality, while Blend mode provides better image quality (than not using the deinterlace function at all).
Page 242 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) profile_i<0~(m-1)> <boolean> Enable/disable this profile setting _enable profile_i<0~(m-1)> night, The mode which the profile is applied _policy schedule <product dependent> * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a.
Page 243 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * 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 -5: Less saturation <->...
Page 244 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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 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...
Page 245 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when "capability_image_c<0~(n-1)>_gamm acurve" is 1 profile_i<0~(m-1)> <boolean> Enable/disable low light mode. _lowlightmode * Only available when <product "capability_image_c<0~(n-1)>_lowligh dependent> tmode" is 1 profile_i<0~(m-1)> <boolean> Enable/disable hightlight mask.
Page 246 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) e". profile_i<0~(m-1)> 1~100 Strength of electronic image stabilizer _eis_strength * Only available when 'eis' is listed in <product "capability_image_c<0~(n-1)>_is_mod dependent> e". profile_i<0~(m-1)> <boolean> Digital image stabilizer _dis_mode 0:disable <product 1:enable...
Page 247 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 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...
Page 248 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) H: 0~ The current image height re_windomain". homestd <0~9999,0~9999> 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> Width and height of the window.
Page 249 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 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"...
Page 250 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) W: 0~ The current image width * Only available when px is listed in "capability_image_c<0~(n-1)>_exposu H: 0~ The current image height re_windomain". homestd <0~9999,0~9999> Left-top corner coordinate of the window.
Page 251 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) updated during booting to fit switch status. volume_internal 0~100 Volume when take internal microphone as input source. 0: Minimum 100: Maximum * Only available when the channel supports internal microphone (The related bit of "capability_audio_intmic"...
Page 252 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "volume_external". boostmic 0~100 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.
Page 253 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) pcma: A-law algorithm * Only available if G.711 is supported. s0_g726_bitrate 16000, Set G.726 encoded bitrate in bps. 24000, * Only available if G.726 is supported. 32000, 40000 s0_g726_bitstreamp little, big...
Page 254 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) (httpversion) is equal or greater than 0301a. * "policy=night" is only available when "capability_daynight_c<0~(n-1)>_sup port > 0". profile_i0_begintime hh:mm Begin time of schedule mode. profile_i0_endtime hh:mm End time of schedule mode. profile_i0_alarm_lev 1~100 Audio detection alarm level...
Page 255 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) name string[40] Specify the audio clip name that can be played when an event occurs. size 0,<positive integer> The size of audio clip. Group: audioclip (capability_audio_audioclip=1) NAME VALUE SECURITY DESCRIPTION...
Page 256 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_motion_wintype" = polygon. * Only available when std is listed in "capability_motion_windomain" objsize 1 ~ 100 Percent of motion detection window. sensitivity 0 ~ 100 Sensitivity of motion detection window. <Not recommended * We replace "sensitivity"...
Page 257 VIVOTEK © 2023 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.
Page 258 VIVOTEK © 2023 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. Group: motion_c<0~(n-1)>_profile_i<0~(m-1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the vaule of "...
Page 259 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) polygonstd 0 ~ 9999,0 ~ 9999, Coordinate of polygon window position. 0 ~ 9999,0 ~ 9999, (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 0 ~ 9999,0 ~ 9999, * Only available when 0 ~ 9999,0 ~ 9999 "capability_motion_wintype"...
Page 260 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) rectangle. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 261 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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>...
Page 262 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "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> Enable or disable the dynamic DNS.
Page 263 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) upnpnatstatus The status of UPnP port forwarding, used internally. 0 = OK, 1 = FAIL, 2 = no IGD router, 3 = no need for port forwarding 7.21 System Log Group: syslog NAME...
Page 264 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> SNMP v3 enabled. 0 for disable, 1 for enable secnamerw string[31] Read/write security name secnamero string[31] Read only security name authpwrw string[8~128] Read/write authentication password authpwro string[8~128] Read only authentication password...
Page 265 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) igger_show button in homepage 0 -> Hidden 1 -> Visible theme_option 1~3: One of the default themes. 4: Custom definition. theme_color_font string[7] Font color theme_color_configfont string[7] Font color of configuration area. theme_color_titlefont string[7] Font color of video title.
Page 266 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) defaultpassword_length 8 ~ 64 Allowed password length. * We support this parameter when the version number (httpversion) is equal or greater than 0314b. 266 - User's Manual...
Page 267 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 7.24 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>...
Page 268 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0 ~ 320,0 ~ 240, position. 0 ~ 320,0 ~ 240, (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 0 ~ 320,0 ~ 240 * Only available when "capability_image_c<n>_privacymask _wintype" = polygon. * Only available when qvga is listed in "capability_image_c<0~(n-1)>_privacy mask_windomain".
Page 269 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) color 0~" Privacy mask color capability_image_c<0~(n- 1)>_privacymask_ncolor" win_i<0~(m-1)>_name string[40] Name of the privacy mask window. win_i<0~(m-1)>_pan "capability_ptz_c<0~(n-1) Pan position of window >_minpan" ~ position. "capability_ptz_c<0~(n-1) * Only available when bit0 of >_maxpan"...
Page 270 VIVOTEK © 2023 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...
Page 271 VIVOTEK © 2023 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> Indicate the version of Vivotek log This number start format.
Page 272 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) nvideoout 0, <Positive Integer> Number of video out interface. nvideoinprofile <positive integer> Number of video input profiles. nmediastream <positive integer> Number of media stream per channels. naudiosetting <positive integer>...
Page 273 VIVOTEK © 2023 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;...
Page 274 VIVOTEK © 2023 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.
Page 275 VIVOTEK © 2023 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.
Page 276 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) tamperingmode tamper,toodark,toobri Available tampering mode list. ght,tooblurry * Only available when "capability_tampering" is 1. adaptiverecording <boolean> Indicate whether to support adaptive recording. adaptivestreaming <boolean> Indicate whether to support adaptive streaming.
Page 277 VIVOTEK © 2023 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> Media files are indexed in database. protocol_https <boolean > Indicate whether to support HTTP over SSL.
Page 278 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) protocol_ipv6 <boolean> Indicate whether to support IPv6. protocol_pppoe <boolean> Indicate whether to support PPPoE. protocol_ieee8021 <boolean> Indicate whether to support IEEE802.1x. protocol_qos_cos <boolean> Indicate whether to support CoS. protocol_qos_dscp <boolean>...
Page 279 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * This is kept for compatibility. videoin_mjpeg_ma A list of <Integer> and This equals xframerate "-" "capability_videoin_c0_mjpeg_maxfra merate". * This is kept for compatibility. videoin_h264_max A list of <Integer> and This equals framerate "-"...
Page 280 VIVOTEK © 2023 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 When acoustic echo cancellation maxframerate:fixed:1 function is enabled, some features may become malfunction or be forced...
Page 281 VIVOTEK © 2023 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"...
Page 282 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * It will be replaced by audio_intmic and audio_extmic. audio_lineout <boolean> Indicate whether to support line output. audio_michardwar <boolean> Indicate whether the hardware eswitch supports built-in/external mic switch audio_headphoneo <boolean>...
Page 283 VIVOTEK © 2023 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> Indicate whether smart stream is supported.
Page 284 VIVOTEK © 2023 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> Maximum number of tracking window dow_manual of manual. * Only available when "capability_smartstream_support" is 1 smartstream_nwin <positive integer>...
Page 285 VIVOTEK © 2023 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> Indicate whether to support ptztunnel. * We support this parameter when the version number (httpversion) is equal or greater than 0301b.
Page 286 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) is supported. * Only available when "capability_network_wireless" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0305a. network_ntpnum <positive integer> Maximum number of NTP servers supported.
Page 287 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) mode. * Only available when "capability_wireless_apmode_enable" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0305a. derivative_brand <boolean> Indicate whether to support the upgrade function for the derivative brand.
Page 288 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) media_videoclip_ <positive integer> Maximum duration (second) after maxpreevent event occurred in a videoclip. media_streamprofi <boolean> Indicates support of stream profile les_support feature. * We support this parameter when the version number (httpversion) is equal or greater than 0313a.
Page 289 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_seaml Indicate whether seamless recording <positive integer> is supported. One bit represents one channel. Ex: “3” means channel 0 and channel1 support seamless recording .
Page 290 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) bit 0 : It supports to record directly to an on-board SD-Card. bit 1~: Currently, they are reserved bit, and the default value is 0. * Only available when "capability_supportsd"...
Page 291 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) shockalarm_suppo <boolean> Indicate whether to support the shock detection. * We support this parameter when the version number (httpversion) is equal or greater than 0306e. layout_redirection <string> Indicate which function will be redirected to the vadp package path.
Page 292 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) cameralink_suppor <Boolean> Indicate support for the feature of camera link. * We support this parameter when the version number (httpversion) is equal or greater than 0315a. cameralink_num 0, <positive integer>...
Page 293 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) privilege <boolean> Indicate whether to support “Manage Privilege” of PTZ control in the security page in this video input. 1: support both /cgi-bin/camctrl/camctrl.cgi and /cgi-bin/viewer/camctrl.cgi 0: support only /cgi-bin/viewer/camctrl.cgi rs485 <boolean>...
Page 294 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) focusmode auto,onetimeauto,sp Focus mode selection: otlight,manual "auto": Camera will automatically <product adjust the focus position full time to dependent> adapt a clear picture. "onetimeauto": Camera will automatically adjust the focus position one time, which follows any PTZ control.
Page 295 VIVOTEK © 2023 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"...
Page 296 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mintiltangle <integer> The lower limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" maxtiltangle <integer> The upper limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt"...
Page 297 VIVOTEK © 2023 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.26.3 Capability for IR Led Group: capability_daynight_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY...
Page 298 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) optimizedir <boolean> Indicate whether to support optimized IR control technology. * We replaced this parameter with “capability_daynight_illumintators_opti mizedir” when the version number (httpversion) is equal or greater than 0312a.
Page 299 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) ircutsensitivity_supportle The value indicate the support strength <positive integer> level of ircutsensitivity. * Only available when "capability_daynight_c<0~(n-1)>_suppo rt" is 1 and "capability_daynight_c<0~(n-1)>_ircuts ensitivity_type" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 300 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) spectrum_mode visible,ir,irenhanced, Indicate the spectrum mode. blueenhanced "visible": The ideal default setting for <product visible light. dependent> "ir": The ideal default setting for IR light. "irenhanced": This CCM model increases the brightness effect of IR light.
Page 301 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mode auto,daynight,di,di2, Indicate the day / night switch mode. di3,di4,schedule,- "auto": The Camera automatically <product judges the current operation mode by dependent> the level of ambient light detected. "daynight": support day mode and night mode.
Page 302 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved optimizedir <boolean> Indicate whether to support optimized IR control technology. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. builtin_support <boolean> Indicate whether to support built-in led. * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
Page 303 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved spectrum_support <boolean> Indicate whether to support proposed a brightness enhancement method based on CCM(Color Correction Matrix) model to improve the brightness effect of the images if the IR and blue light exists. * Only available when "capability_daynight_c<0~(n-1)>_support"...
Page 304 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved Indicate if the target zone function can be optimize_target bright, available or not. objectanalytics, bright : the algorithm will analyze bright " " <product area of image and apply this bright ares as dependent>...
Page 305 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved modnum 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.26.6 Capability for Video Input Group: capability_videoin_c<0~(n-1)>...
Page 306 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) eptz_zoomratio <string> 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>...
Page 307 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) rotationaffect When rotation is enabled, some features <product may become malfunction or be forced to a dependent> given value. The affected functions are list here. The format is "Affect API name":"Policy":"Description"...
Page 308 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) rotationangle <string> The different angles which camera supports for rotation. * Only avaliable when "capability_videoin_c<0~(n-1)>_rotation" is * We support this parameter when the version number (httpversion) is equal or greater than 0309b.
Page 309 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) resolution A list of <WxH> Resolution options in current video mode. <product These options are the possible options for dependent> "videoin_c<n>_s<m>_resolution". The last one is the maximum resolution in current mode.
Page 310 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mjpeg_maxframerate A list of <Positive Maximum fps that the device can encoded Integer> and "-" with MJPEG on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution".
Page 311 VIVOTEK © 2023 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 Indicate H264 profiles * Only available when 'h264' is listed in <product "capability_videoin_codec".
Page 312 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) fisheye_mounttype ceiling, wall, floor Indicate the supported type. <Not recommended <product wall mount: 180° panoramic view to use this> dependent> ceiling mount: 360° surround view without blind spots floor mount: 360°...
Page 313 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) cameraunit_name CU8131, A "camera unit" name of a split-type camera CU8171, system, which the camera unit and the CU8161-H, video core are separated. CU8162-H, -: If the camera is not a split-type camera CU8163-H, system, the value of this parameter is "-".
Page 314 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) typewallmount 1O, 1P, 1R, 4R Available dewarp types of wall mount. resolutionC1P A list of <WxH> Available resolutions of 1P mode of ceiling and floor mount. resolutionC2P A list of <WxH>...
Page 315 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) is_mode eis, Indicate this mode whether support dis, image stabilizer mode. "eis": electronic image stabilizer "dis": digital image stabilizer "-": not support * Only available when "capability_image_c<0~(n-1)>_eis" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0317a.
Page 316 VIVOTEK © 2023 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 =>...
Page 317 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) effectivepixel <WxH> The visible area of full scene in this video mode. The unit is pixel in source. * If "effectivepixel"<"capability_videoin_c<0~ (n-1)>_maxsize", then the visible area is located at the center of full scene.
Page 318 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxresolution A list of <Integer> Represent supported maximum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream". minresolution A list of <Integer> Represent supported minimum resolution of each stream in current video mode.
Page 319 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxfps_mjpeg A list of <Positive Maximum fps which the device can Integer> and "-" encoded with MJPEG on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution".
Page 320 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxfps_h265 A list of <Positive Maximum fps which the device can Integer> and "-" encoded with H.265 on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution".
Page 321 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) equal or greater than 0311a. wdrpro_mode 0, 1, 2 0: Non-support WDR Pro 1: Support WDR Pro 2: Support WDR Pro II wdrpro_strength 0, 1 0: Non-support tuning strength of WDR Pro 1: Support tuning strength of WDR Pro * If...
Page 322 VIVOTEK © 2023 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;...
Page 323 VIVOTEK © 2023 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.
Page 324 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 1: Support 3D digital noise reduction dnrstrength <positive integer> Indicate the support strength level of 3D digital noise reduction. * Only available when "capability_image_c<0~(n-1)>_dnr" > * We support this parameter when the version number (httpversion) is equal or greater than 0306d.
Page 325 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) is_supportlevel 0, <positive Indicate the support strength level of integer> image stabilizer mode. * Only available when "capability_image_c<0~(n-1)>_is_mod e" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 326 VIVOTEK © 2023 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"...
Page 327 VIVOTEK © 2023 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.
Page 328 VIVOTEK © 2023 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.
Page 329 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) wbmode auto, Available white balance mode. panorama, "-" means white balance is not manual, supported. rbgain, widerange, outdoor,indoor, sodiumauto, snowauto, snowpanorama <product dependent> iristype piris, Indicate iris type. dciris, "piris": P-Iris "dciris": DC-Iris...
Page 330 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) exposure_rangetype onevalue, Support interface of exposure range. twovalues "onevalue": The parameter is a constant value. "twovalues": Need two parameters to indicate the exposure range. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode"...
Page 331 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "fixed": The gain value is the assigned ranged, value (videoin_c<0~(n-1)>_gainvalue). "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.
Page 332 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name"...
Page 333 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <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.
Page 334 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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.
Page 335 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) equal or greater than 0302a. exposure_qualityprior When exposure quality priority mode itymode_affect exposurewin.mode is enabled, some features may .blc:hidden:, become malfunction or be forced to a defog:disabled:, given value.
Page 336 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "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 0305a. exposure_manualmod When exposure manual mode is e_affect exposurewin.mode enabled, some features may become...
Page 337 VIVOTEK © 2023 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 manual is listed in "capability_image_c<0~(n-1)>_ exposure_modetype"...
Page 338 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_ exposure_mode" is 1 and hlc is listed in "capability_image_c<0~(n-1)>_ exposure_winmode". exposure_hlcmode_af When hlc mode is enabled, some fect sir:hidden: features may become malfunction or or others be forced to a given value.
Page 339 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1 and hlc is listed in "capability_image_c<0~(n-1)>_ exposure_winmode". * We support this parameter when the version number (httpversion) is equal or greater than 0304a. exposure_wintype inclusive, The supported exposure window type.
Page 340 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_ntsc_totalra A list of <Positive Available total range for NTSC analog Integer> output. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0301a.
Page 341 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) not available. * When "exposure_mode"=0, this value must be set to "-". * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_bracketing_ <boolean> 0: Non-support Auto Exposure mode Bracketing (AEB) 1: Support Auto Exposure Bracketing (AEB)
Page 342 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) rectangle shape. "3Drectangle": The window is a 3D rectangle shape. privacymask_windom qvga, px, std, - The domain to set an window. "qvga": a 320x240 range to represent the whole image.
Page 343 VIVOTEK © 2023 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.
Page 344 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <x>: nonnegative The format is "Affect API integer name":"Policy":"Description" <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.
Page 345 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) d" is 1. aespeedsupportsensit 0: Non-support tuning the sensitivity 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"...
Page 346 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "-": Not supported. focuswindow_nwindo 0,<positive Number of focus window integer> focuswindow_range <leftrange,rightran Available range for focuswindow. ge,toprange,lowran * We support this parameter when ge> the version number (httpversion) is <product equal or greater than 0305d.
Page 347 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) not using the deinterlace function at all). * Only available when capability_image_c<0~(n-1)>_deinterl ace_support is 1 lens_alignment <boolean> Indicate whether to support lens alignment function. * We support this parameter when the version number (httpversion) is equal or greater than 0309b.
Page 348 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) color palettes on the camera, that help quickly distinguish thermal variations and patterns in an image. The color tones correspond to the apparent surface temperatures of the target.
Page 349 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) devicecontrol <boolean> Indicate whether to support the peripheral device control. * We support this parameter when the version number (httpversion) is equal or greater than 0305c. devicemonitor_support <boolean> Indicate whether to support overview of all sensors and peripheral devices status on camera.
Page 350 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 7.26.12 Capability for Onvif Group: capability_onvif PARAMETER VALUE SECURITY DESCRIPTION (get/set) dbsize <integer> Indicate the maximum size (Megabyte) of persistent notification storage. * We support this parameter when the version number (httpversion) is equal or greater than 0319a.
Page 351 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) priority 0, 1, 2 Indicate the priority of this event: "0"= low priority "1"= normal priority "2"= high priority delay 1~999 Delay in seconds before detecting the next event.
Page 352 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mdwin 0,<positive 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.
Page 353 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) weekday 0~127 Indicate which weekday is scheduled. One bit represents one weekday. bit0 (LSB) = Saturday bit1 = Friday bit2 = Thursday bit3 = Wednesday bit4 = Tuesday bit5 = Monday bit6 = Sunday For example, to detect events on Friday...
Page 354 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_do_i<0~(k-1)>_du 1~999 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 * if extension_connected=1, k=capability_ndo * if extension_connected=0, k=capability_ndo+...
Page 355 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_cf_backup <Boolean> Enable or disable the function that send media to SD card for backup if network is disconnected. * Only available when "capability_supportsd" > 0 action_server_i<0~4>_en <boolean>...
Page 356 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_autotrack_name string[40] Indicate the source name of smart <product dependent> tracking advanced when an event is triggered. * Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0, and the camera supports “Smart Tracking Advanced”...
Page 357 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) tampering 0,<positive 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. bit 1 =>...
Page 358 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) http_url string[128] URL of the HTTP server to upload. http_username string[64] Username to log in to the server. http_passwd string[64] Password of the user. ftp_address string[128] FTP server address. ftp_username string[64] Username to log in to the server.
Page 359 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 7.28.1. Server Setting for Event Action of sftp Group: server_i<0~4>_sftp * Only available when bit 1 of “capability_protocol_ftp_client” is 1. PARAMETER VALUE SECURITY DESCRIPTION (get/set) address string[128] Server address loginmode passwd, authentication method: publickey ”passwd”...
Page 360 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved publickey_downloadkeytype ed25519, The keytype used for key pair. rsa, "ed25519": faster to generate with ecdsa higher security level, some old server might not support. "rsa": slower to generate with slightly lower security level than ed25519. "ecdsa": low security level.
Page 361 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) snapshot_source 0~"capability_nmediastream 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.
Page 362 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) videoclip_source 0~"capability_nmediastream 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.
Page 363 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) trigger schedule, The event trigger type networkfail schedule: The event is triggered by schedule networkfail: The event is triggered by the failure of network connection. enable <boolean> Enable or disable this recording.
Page 364 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) notify <boolean> 0: Disable recording notification 1: Enable recording notification notifyserver 0~31 Indicate which notification server is scheduled. One bit represents one application server (server_i0~i4). bit0 (LSB) = server_i0. bit1 = server_i1.
Page 365 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) cffolder string[128] Folder name. <Not recommended to use this> foldername string[128] Folder name. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. maxsize 100~2000 Unit: Mega bytes.
Page 366 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) method auto, "auto": Create self-signed certificate manual, automatically. install, "manual": Create self-signed certificate installwithkey manually. "install": Create certificate request and (Available values are install. listed in "installwithkey": Upload a certificate "capability_security_c and private key.
Page 367 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 7.32 Storage Management Setting Group: disk_i<0~(n-1)> n denotes the value of "capability_storage_management_ndevice" (capability_storage_management_ndevice > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) cyclic_enabled <boolean> Enable cyclic storage method. cyclic_reserve 10 ~ 99 The reserved percentage of this disk. * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
Page 368 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 7.33 Region of Interest Group: roi_c<0~(n-1)> for n channel product and m is the index of video stream which support ePTZ. (capability_eptz > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-1)>_home <W,H> ROI left-top corner coordinate. <product * If the minimal window size is 64x64, dependent>...
Page 369 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) osdzoom <boolean> 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"...
Page 370 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) patroldwelling string[160] The dwelling time (unit: second) of each patrol point, separated by “,”. preset_i<0~19>_name string[40] Name of ePTZ preset. (It should be set by ePreset.cgi rather than by setparam.cgi.) preset_i<0~19>_pos <W,H>...
Page 371 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) win_i0_size <WxH> Width and height of the window. <product * The minimal window size is 192x144, dependent> and resolution_W and resolution_H is based on "capability_image_ c<0~(n-1)>_focuswindow_range" . 7.36 Seamless Recording Setting <Not recommended to use>...
Page 372 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxconnection Maximum number of connected seamless streaming. * We replace this parameter with “seamlessrecording_c<0~(n-1)>_maxconnecti on” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin >...
Page 373 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) guid<0~2>_number Number of connected seamless streaming with guid<0~(k-1)>_id. (Read only) * We replace this parameter with “seamlessrecording_c<0~(n-1)>_guid<0~2>_n umber” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin >...
Page 374 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved triggerrecord <boolean> Indicate whether seamless recording is recording to local storage or not at present. (Read only) * We support this parameter when the version number (httpversion) is equal or greater than 0312a. guid<0~(k-1)>_id string[127] The connected seamless streaming ID.
Page 375 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) resource_free_storage 0,<positive Indicate current free storage size for integer> uploading VADP modules. module_number 0,<positive Record the total module number that integer> already stored in the system. module_order string[40] The execution order of the enabled modules.
Page 376 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) string[120] The URL address of vadp hyperlink. status string[40] Value of “on” indicates a valid connection of vadp hyperlink. Value of “off” indicates a invalid connection of vadp hyperlink. 7.37.2.
Page 377 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) statmsg string[128] Indicate the message that will be show on the running status when mouse over. vvtklicensemec string[40] Indicate the module use VIVOTEK license mechanism 7.37.3. VADP Schedule Settings Group: vadp_schedule_i<0~(n-1)>...
Page 378 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enableptztunnel <boolean> Enable PTZ tunnel for camera control. Group: camctrl_c<0~(n-1)> for n channel products (capability_ptzenabled > 0) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset" NAME VALUE SECURITY...
Page 379 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) capability_camctrl_c0_rs485=2 disablemdonptz <boolean> Disable motion detection on PTZ operation. 7.39 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"...
Page 380 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) listed in "capability_cam ctrl_c<0~(n-1)> _focusmode" uart Select corresponding uart "capability_nua (capability_nuart>0). rt"-1 * only available when capability_camctrl_c0_rs485=2 isptz 0 ~ 2 0: disable PTZ commands. 1: enable PTZ commands with PTZ driver.
Page 381 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) version number (httpversion) is equal or greater than 0305b. patrolseq string[120] (For external device) The indexes of patrol points, separated by “,” patroldwelling string[160] (For external device) The dwelling time of each patrol point, separated by “,”...
Page 382 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PTZ C LEASE REFER TO ONTROL 7.40 Camera PTZ Control (SD Series) Group: camctrl_c<0~(n-1)> for n channel products (the bit7 of capability_ptzenabled is 0 and the bit4 of capability_ptzenabled is 1) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset" NAME VALUE SECURITY...
Page 383 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) preset_i<0~(k-1)>_name string[40] Name of the preset location. preset_i<0~(k-1)>_pan capability_ptz_c<0~( 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~( Tilt position at each preset n-1)>_mintilt ~ location.
Page 384 VIVOTEK © 2023 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~( Custom home tilt position. n-1)>_mintilt ~ capability_ptz_c<0~( n-1)>_maxtilt axisz capability_ptz_c<0~( Custom home zoom position. n-1)>_minzoom ~ capability_ptz_c<0~( n-1)>_maxzoom axisf capability_ptz_c<0~( Custom home focus position. n-1)>_minfocus ~ capability_ptz_c<0~( n-1)>_maxfocus...
Page 385 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) tour_i<0~19>_speed -5 ~ 5 Preset tour: pan and tilt speed when moving between presets. Recorded tour: unnecessary. tour_i<0~19>_direction forward,backward,ra User can choose which direction ndom the preset tour goes. "forward": preset tour goes in forward order.
Page 386 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 7.41 UART Control Group: uart (capability_nuart > 0 and capability_fisheye = 0) NAME VALUE SECURITY DESCRIPTION (get/set) ptzdrivers_i<0~19, string[40] Name of the PTZ driver. 127>_name ptzdrivers_i<0~19, string[128] Full path of the PTZ driver. 127>_location enablehttptunnel <boolean>...
Page 387 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) speedlink_i<0~4>_n string[40] Additional PTZ command name. * only available when capability_camctrl_c0_rs485=2 speedlink_i<0~4>_c string[40] Additional PTZ command list. * only available when capability_camctrl_c0_rs485=2 ptzdriver 0~19, The PTZ driver is used by this COM 127 (custom), port.
Page 388 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "1": One stop bit is transmitted to stopbit indicate the end of a byte. "2": Two stop bits are transmitted to indicate the end of a byte. If you want to transfer the stopbit for 150% of the normal time used to transfer one bit, the...
Page 389 VIVOTEK © 2023 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> Current selected lens profile. e.g. lens_selected=lens_default_i0, it means choosen lens configuration is i0 lens of default group.
Page 390 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) revisedcenteraxis <coordinate> The actual center axis coordinate radius 0, <positive The actual center radius integer> 7.46 Fisheye Local Dewarp Setting Group: fisheyedewarp_c<0~(n-1)> (capability_fisheyelocaldewarp_c<0~(n-1)> > 0) n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" NAME VALUE SECURITY...
Page 391 VIVOTEK © 2023 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 Zoom home ratio of regional view (for <0~(i-1)>_zoom 4R mode, i is the view index and range from 0 to 3)
Page 392 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 7.49 Wireless Group: wireless (capability_network_wireless > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) ssid string[32] SSID for wireless lan settings. wlmode Infra, Wireless mode. Adhoc Infra: Infrastructure channel 1~11 or A list of WLAN channels. 1~13 Countries apply their own regulations 10~11 or...
Page 393 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) key2 password [26] WEP key2 for encryption. * Only valid when "wireless_encrypt" is "wep" key3 password [26] WEP key3 for encryption. * Only valid when "wireless_encrypt" is "wep"...
Page 394 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) fixed <boolean> The value indicates whether the profile can be deleted or not. Ex. fixed=1 indicates the profile cannot be deleted. occupied <boolean> Indicates the action of creating profile. Ex.
Page 395 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) audioconfiguration_so c<0~(n-1)>s0 The audioconfiguration source for the urce profile. * n denotes the value Ex. audioconfiguration_source= c<0~(n-1)>s0 indicates audio stream of "capability_naudioin" channel n and stream 1 is selected for the profile.
Page 396 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. ipaddress <ip address> The ipaddress of the receiving camera. username string[64] The username of the receiving camera. passwd string[64] The password of the receiving camera. port 0~65535 The connection port to the receiving...
Page 397 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) connected <Boolean> Indication if extension module IO is connected. 7.55 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>...
Page 398 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) focusshift_night_lastdate <blank>, A recorded UTC time when IR offset value <YYYY/MM/DD is saved during night mode. HH:MM:SS> <blank>: IR offset value hasn't been saved before. 398 - User's Manual...
Page 399 VIVOTEK © 2023 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.
Page 400 VIVOTEK © 2023 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...
Page 401 VIVOTEK © 2023 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.
Page 402 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION quality The quality of the image. streamid 0~( capability_nmediastream -1) The stream number. Default: Returns snapshot of maxmum resolution for current channel. The server will return the most up-to-date snapshot of the selected channel and stream in JPEG format.
Page 403 VIVOTEK © 2023 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.
Page 404 VIVOTEK © 2023 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>...
Page 405 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 8.7 ePTZ Camera Control (capability_eptz > 0 and Capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eCamCtrl.cgi?channel=<value>&stream=<value> [&move=<value>] – Move home, up, down, left, right [&auto=<value>] – Auto pan, patrol [&zoom=<value>] –Zoom in, out [&zooming=<value>&zs=<value>] –Zoom without stopping, used for joystick [&x=<value>&y=<value>&w=<value>&h=<value>&resolution=<value>] - Zoom in, out on a specific...
Page 406 VIVOTEK © 2023 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.
Page 407 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION <integer> movement <integer> The scaled area size <integer> resolution <window size> The resolution of streaming. <integer> The direction of movement, used for joystick control. <integer> 0 ~ 7 Set the speed of movement, “0” means stop. <integer>...
Page 408 VIVOTEK © 2023 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)>...
Page 409 VIVOTEK © 2023 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>...
Page 410 VIVOTEK © 2023 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.
Page 411 VIVOTEK © 2023 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.
Page 412 VIVOTEK © 2023 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.
Page 413 VIVOTEK © 2023 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.
Page 414 VIVOTEK © 2023 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.
Page 415 VIVOTEK © 2023 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.
Page 416 VIVOTEK © 2023 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.
Page 417 VIVOTEK © 2023 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”...
Page 418 VIVOTEK © 2023 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.
Page 419 VIVOTEK © 2023 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...
Page 420 VIVOTEK © 2023 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 –...
Page 421 VIVOTEK © 2023 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...
Page 422 VIVOTEK © 2023 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 –...
Page 423 VIVOTEK © 2023 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...
Page 424 VIVOTEK © 2023 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”...
Page 425 VIVOTEK © 2023 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...
Page 426 VIVOTEK © 2023 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 >...
Page 427 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved Play recordings for length seconds which ends at etime rtsp://10.10.1.2/mod.sdp?etime=20110312_040400.000&length=120 Play file file rtsp://10.10.1.2/mod.sdp?filename=/mnt/link0/ User's Manual - 427...
Page 428 VIVOTEK © 2023 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 a 3D privacy mask at current location delete Delete a 3D privacy mask edit...
Page 429 VIVOTEK © 2023 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>] –...
Page 430 VIVOTEK © 2023 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.
Page 431 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION focus auto Auto focus. Focus on further distance. near Focus on closer distance. focusseting sync Applies the selected focus mode in camctrl_c<0~(n-1)>_focusmode to this preset. fixcurrent Applies the current focus position to this preset. * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20.
Page 432 VIVOTEK © 2023 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"...
Page 433 VIVOTEK © 2023 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"...
Page 434 VIVOTEK © 2023 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.
Page 435 VIVOTEK © 2023 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.
Page 436 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved Syntax: http://<servername>/cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION Apply the wireless settings and connect to AP. 8.31 Get Wireless Information (capability_network_wireless > Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/getwirelessinfo.cgi PARAMETER VALUE DESCRIPTION Get wireless information.
Page 437 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION Get wireless signal strength. 8.33 WPS Transaction (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/start_wps.cgi PARAMETER VALUE DESCRIPTION Start WPS transaction. 8.34 Peripheral Control (capability_peripheral_c<0~(n-1)>_ devicecontrol >...
Page 438 VIVOTEK © 2023 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.
Page 439 VIVOTEK © 2023 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 Get support peripheral device. washer_supportmode N/A Get the support mode of washer control system. washer_mode Get the current mode of washer control system. It return the value of "washer_mode"...
Page 440 VIVOTEK © 2023 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 Return a status overview of all sensors and peripheral devices on camera. Response: devicemonitor_tempsensor_iX_name: the name of temperature sensor...
Page 441 VIVOTEK © 2023 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...
Page 442 VIVOTEK © 2023 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”...
Page 443 VIVOTEK © 2023 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.
Page 444 VIVOTEK © 2023 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...
Page 445 VIVOTEK © 2023 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 (for control API) Syntax: 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...
Page 446 VIVOTEK © 2023 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 Indicate lensctrl thermal version Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=get&version...
Page 447 VIVOTEK © 2023 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.
Page 448 VIVOTEK © 2023 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 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.
Page 449 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved 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>...
Page 450 VIVOTEK © 2023 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.
Page 451 VIVOTEK © 2023 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...
Page 452 VIVOTEK © 2023 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>...
Page 453 VIVOTEK © 2023 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.
Page 454 VIVOTEK © 2023 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;...
Page 455 VIVOTEK © 2023 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-- (for query API) Syntax: http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=<value>[&parameter=<value>] PARAMETER VALUE DESCRIPTION operation getserverhostkey " getserverhostkey ": Auto scan SFTP server host key.
Page 456 VIVOTEK © 2023 VIVOTEK INC. All Right Reserved <MD5 value> 8.41.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”...
Page 457 VIVOTEK © 2023 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) 8.42 Lens alignment control (capabiltiy_image_c<0~(n-1)>_lens_alignment = 1 and “dynamic”...
Page 459 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 460 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 ip9191-ht-v2

Delta Vivotek IP9181-HT-v2 User Manual

Quick Links

Related Manuals for Delta Vivotek IP9181-HT-v2

Summary of Contents for Delta Vivotek IP9181-HT-v2

This manual is also suitable for:

Table of Contents