Vivotek IP9164-HT User Manual

page of 424

/ 424
Contents
Table of Contents
Bookmarks

Table of Contents

Quick Links

Download this manual

IP9164-HT

IP9164-LPC

User 's Manual

2MP • License Plate Capture • P-iris/DC-iris • H.265 • WDR Pro • Remote Back Focus

Smart Stream III • SNV II • 3DNR

Box

Network Camera

Rev. 1.0

Table of Contents

Need help?

Do you have a question about the IP9164-HT and is the answer not in the manual?

Questions and answers

Summary of Contents for Vivotek IP9164-HT

Page 1 IP9164-HT IP9164-LPC Network Camera User ’s Manual 2MP • License Plate Capture • P-iris/DC-iris • H.265 • WDR Pro • Remote Back Focus Smart Stream III • SNV II • 3DNR Rev. 1.0...
Page 2: Table Of Contents
Applications > DI and DO ..........................140 Applications > Tampering detection ........................141 Applications > Audio detection ......................... 142 Applications > Shock detection ......................... 144 Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) ..... 145 2 - User's Manual...
Page 3: Overview
1920x1080 at a smooth 60 fps in any condition. Further, by employing VIVOTEK’s WDR Pro II, 3DNR and SNV II technologies, no matter whether in high contrast or in low light environments, the camera will ensure clear image quality for license plate capture or traffc monitoring.
Page 4: Read Before Use
Commands of the Network Camera section serves as a helpful reference to customizing existing homepages or integrating with the current web server. Package Contents ■ IP9164-HT or IP9164-LPC. ■ Lens module (separately purchased) ■ Screws ■ Camera stand, L wrench ■...
Page 5: Physical Description
Si l'alimentation CC est préférable, elle devrait être conforme avec ce qui suit : Sortie : 12 VCC, 2 A min., alimentation limitée à conformité CEI 60950-1. IMPORTANT: Please contact VIVOTEK's certified dealers for power adapters. User's Manual - 5...
Page 6 8. Make sure cameras are securely attached to the wall/ceiling/mounting kits. IMPORTANT: 1. Please contact VIVOTEK's certified dealers for power adapters. 2. Installation and maintenance service should only be performed by qualified technicians. 3. If powered by a power adapter, the adapter should be properly grounded.
Page 7 Cross-Site Request Forgery (CSRF) protection in Configuration > Security > Miscellaneous. • For up-to-date documentation of URL commands, please go to VIVOTEK’s website, register an account with a business mail address and submit for authorization for SDK in Support > Downloads > SDK.
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+...
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 Protected Earth 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. Double-click on the camera’s MAC address to open a web console with the camera.
Page 13 VIVOTEK 8. Remove the sticker on the light sensor. 9. With a live view on screen, enter Configuration > Image > Focus to adjust the image zoom and focus. Click on the Auto focus button and let the camera find an optimal focus.
Page 14 VIVOTEK If you purchased a larger lens, make sure the light sensor is not blocked by the lens. You can purchase the AE-237/241/242 enclosure for outdoor installations. LED Definitions Item LED status Description Steady Powered and system booting, or network...
Page 15: Software Installation
Software Installation 10. 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.
Page 16 VIVOTEK 10-3. The program will search for all VIVOTEK network devices on the same LAN. 10-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 17 VIVOTEK Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~. You can use them in the password combination. 11-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 18: 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.
Page 19 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.
Page 20 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 21 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 22: Ready To Use
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. For its installation details, please refer to its related documents.
Page 23: Accessing The Network Camera
3. Live video will be displayed in your web browser. 4. If it is the first time installing the VIVOTEK network camera, an information bar will prompt as shown below. Follow the instructions to install the required plug-in on your computer.
Page 24 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 101.
Page 25 VIVOTEK IMPORTANT: • Currently the Network Camera utilizes 32-bit ActiveX plugin. You CAN NOT open a management/view session to the camera using a 64-bit IE browser. • If you encounter this problem, try execute the Iexplore.exe program from C:\Windows\ SysWOW64. A 32-bit version of IE browser will be installed.
Page 26: 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. Quick Time Player VLC media player VLC media player 1. Launch the RTSP player. 2. Choose File > Open URL. A URL dialog box will pop up.
Page 27: 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 28: Using Vivotek Recording Software
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. 28 - User's Manual...
Page 29: 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...
Page 30 VIVOTEK Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 34. 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 31 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 116 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 32 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 33 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 34: 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 35 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 36 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 37 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 38 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 39: 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 40: 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 41: System > Homepage Layout
Theme Options (the second tab on this page). The settings will be displayed automatically in this Preview field. The following shows the homepage using the default settings: ■ Hide Powered by VIVOTEK: If you check this item, it will be removed from the homepage. Logo graph Here you can change the logo that is placed at the top of your homepage.
Page 42 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 43 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.
Page 44: 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.
Page 45 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 HTTP...
Page 46: 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.
Page 47: System > Maintenance
Note: Do not power off the Network Camera during the upgrade! Follow the steps below to upgrade the firmware: 1. Download the latest firmware file from the VIVOTEK website. The file is in .pkg file format. 2. Click Browse… and locate the firmware file.
Page 48 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 49 VIVOTEK Import/Export files This feature allows you to Export / Update daylight saving time rules, custom language file, configuration file, and server status report. Export daylight saving time configuration file: Click to set the start and end time of DST (Daylight Saving).
Page 50 VIVOTEK 3. Open the file with Microsoft ® Notepad and locate your time zone; set the start and end time of DST. When completed, save the file. In the example below, DST begins each year at 2:00 a.m. on the second Sunday in March and ends at 2:00 a.m.
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.
Page 52: Media > Image
VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following four columns: General settings, Picture settings, Exposure, and Privacy mask. The Focus window is available only for models that come with motorized lens.
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 The Network Camera automatically removes the IR cut filter when a Digital Input is triggerred. For example, the digital input can come from a housing that is equipped with IR illumination and control circuits such as VIVOTEK’s AM-214. ■ Schedule mode The Network Camera switches between day mode and night mode based on a specified schedule.
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.
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.
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.
Page 58 VIVOTEK Noise reduction ■ Enable noise reduction: Check to enable noise reduction in order to reduce noises and flickers in image. This applies to the onboard 3D Noise Reduction feature. Use the pull-down menu to adjust the reduction strength. Note that applying this function to the video channel will consume system computing power.
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 ■ 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. The same applies if the camera is installed on a vehicle, and when it needs to adapts to fast changes of light when entering and leaving a tunnel.
Page 62 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 63 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 64 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 64 - User's Manual...
Page 65 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 66 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.
Page 67: Media > Video
VIVOTEK Media > Video Mode - Resolution and Frame rate With the WDR Pro enabled for the high-contrast environment, the maximum frame rate is 30fps. Without the WDR function, you can enjoy a higher frame rate for up to 60fps (e.g., in traffic monitoring).
Page 68 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 2 is set to the 1920 x 1080. ■ Stream 2: The default frame size for Stream 2 is set to the 640 x 360.
Page 69 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 70 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 71 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 72 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 73 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.
Page 74 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 75 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.
Page 76 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 77 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 78: 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 79 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 80: Network > General Settings
Use fixed IP address: Select this option to manually assign a static IP address to the Network Camera. 1. You can make use of VIVOTEK Installation Wizard 2 on the software CD to easily set up the Network Camera on LAN. Please refer to Software Installation on page 21 for details.
Page 81 VIVOTEK Primary DNS: The primary domain name server that translates hostnames into IP addresses. Secondary DNS: Secondary domain name server that backups the Primary DNS. Primary WINS server: The primary WINS server that maintains the database of computer names and IP addresses.
Page 82 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 83 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 84 VIVOTEK Enable IPv6 Select this option and click Save to enable IPv6 settings. Please note that this only works if your network environment and hardware equipment support ® IPv6. The browser should be Microsoft Internet Explorer 6.5, Mozilla Firefox 3.0 or above.
Page 85 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 86 VIVOTEK 86 - User's Manual...
Page 87: 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 101 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 88 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.
Page 89 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 90 Unrestricted in scope IMPORTANT: The Multicast metadata port is utilized by VIVOTEK VADP modules to transfer video analytics results, PTZ stream, textual data, and event messages between the camera and the client side running and observing the video analysis. If your client side computer is located outside the local network, you may need to open the associated TCP port on routers and firewall.
Page 91 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 92 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 93 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. One URL can only be mapped to one MAC address.
Page 94 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 95 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 96 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 97 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 98: 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 99: Network > Ftp
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. You can utilize VIVOTEK's Shepherd utility to upgrade the firmware via FTP server. By default, the FTP port is set to 21. It can also be assigned to another port number between 1025 and 65535.
Page 100: 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 101: 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”...
Page 102 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 103: 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 104 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 105 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.
Page 106 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 107 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.
Page 108 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. 108 - User's Manual...
Page 109 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.
Page 110: 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 111 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 112 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 113 Authentication server (usually a RADIUS server): Checks the client certificate and decides whether to accept the end user’s access request. ■ VIVOTEK Network Cameras support two types of EAP methods to perform authentication: EAP- PEAP and EAP-TLS. Please follow the steps below to enable 802.1x settings: 1.
Page 114 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 115 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 116: 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.
Page 117 VIVOTEK Home page in the E-PTZ Mode x3.3 ■ The e-Preset Positions will also be displayed on the home page. Select one from the drop-down list, and the Network Camera will move to the selected position. ■ If you have set up different preset positions for different streams, you can select one of the video streams to display its separate preset positions.
Page 118 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.
Page 119: Ptz
Then you can configure the PTZ driver and RS485 port with the following settings. VIVOTEK provides the following PTZ drivers: DynaDome/SmartDOME, Lilin PIH-7x00, Pelco D, and Pelco P protocol. If none of the above PTZ drivers is supported by your PTZ scanner, please select Custom camera (scanner).
Page 120 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/...
Page 121 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 122: 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 123 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 124 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 125 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 126 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 127 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 128 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 129 VIVOTEK ■ Passive mode Most firewalls do not accept new connections initiated from external requests. If the FTP server supports passive mode, select this option to enable passive mode FTP and allow data transmission to pass through the firewall. The firmware default has the Passive mode checkbox selected.
Page 130 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 151 for details. Note that only one NAS server can be configured. Click Save server to enable the settings.
Page 131 VIVOTEK Click 20200120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2020/01/20 2020/01/20 Click to go back to the previous Click to delete level of the directory selected items Click to delete all...
Page 132 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 133 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.
Page 134 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.
Page 135 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 136 Please note that there is a limited number of customized scripts you can upload; if the current amount of customized scripts has reached the limit, an alert message will prompt. If you need more information, please contact VIVOTEK technical support. 20200213...
Page 137: Applications > Motion Detection
VIVOTEK Applications > Motion detection This section explains how to configure the Network Camera to enable motion detection. A total of 5 motion detection windows can be configured. Motion Detection Setting 2: Motion Detection Setting 1: For special situations For normal situations Follow the steps below to enable motion detection: 1.
Page 138 VIVOTEK Photos or videos can be captured instantly and configured to be sent to a remote server (via an Email or FTP server). For more information on how to configure an event setting, please refer to Event settings on page 122.
Page 139 VIVOTEK This motion detection window will also be displayed on the Event Settings page. You can go to Event > Event settings > Trigger to select it as a trigger source. Please refer to page 123 for detailed informatio. NOTE: ►...
Page 140: 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 141: 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 142: 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 143 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 144: 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.
Page 145: Applications > Package Management - A.k.a., Vadp (Vivotek Application Development Platform)
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 146 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 147 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.
Page 148: Recording > Recording Settings
VIVOTEK Recording > Recording settings This section explains how to configure the recording settings for the Network Camera. Recording Settings 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. Please refer to page 153 for detailed information.
Page 149 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.
Page 150 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 151 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 152 VIVOTEK Event If you want to enable recording notification, please click to configure event triggering settings. Please refer to Event > Event settings on page 122 for more details. When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page.
Page 153: 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 154 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 155 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 156: 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 157 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 158 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:...
Page 159: 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 160 VIVOTEK © 2019 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 161: Technology License Notice
VIVOTEK © 2019 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.
Page 162: Electromagnetic Compatibility (Emc)
VIVOTEK © 2019 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 163 VIVOTEK © 2019 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 User's Manual - 163...
Page 164 VIVOTEK © 2019 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>]...
Page 165 VIVOTEK © 2019 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...
Page 166 VIVOTEK © 2019 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.
Page 167 VIVOTEK © 2019 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.
Page 168 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <blank> timezoneindex -489 ~ 529 Indicate timezone and area. -480: GMT-12:00 Eniwetok, Kwajalein -440: GMT-11:00 Midway Island, Samoa -400: GMT-10:00 Hawaii -360: GMT-09:00 Alaska -320: GMT-08:00 Las Vegas,...
Page 169 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 120: GMT 03:00 Baghdad, Kuwait, Riyadh, Moscow, St. Petersburg, Nairobi 121: GMT 03:00 Iraq 140: GMT 03:30 Tehran 160: GMT 04:00 Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan...
Page 170 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) daylight_auto_begintim string[19] Display the current daylight saving start time. daylight_auto_endtime string[19] Display the current daylight saving end time. daylight_timezones string List time zone index which support daylight saving time.
Page 171 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <positive values except the custom language file integer> the user has uploaded. 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 172 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when "capability_image_c<0~(n-1)>_lensconfig uration_support" != 0. 7.1.1 System.Info Subgroup of system: info (The fields in this group are unchangeable.) NAME VALUE SECURITY DESCRIPTION (get/set) modelname...
Page 173 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) language_i7 : 简体中文 language_i8 : 繁體中文 customlanguage_max 0,<positive Maximum number of custom languages count integer> supported on the server. customlanguage_coun 0,<positive Number of custom languages which have integer>...
Page 174 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.2.1 Status per Channel Group: status_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) signal_detect <boolean> Indicates whether the video source is connected or not.
Page 175 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.5 Security Group security NAME VALUE SECURITY DESCRIPTION (get/set) privilege_do view, operator, Indicate which privileges and above admin can control digital output (capability_ndo > 0) privilege_camctrl view, operator, Indicate which privileges and above...
Page 176 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.6 Network Group: network NAME VALUE SECURITY DESCRIPTION (get/set) preprocess <positive integer> An 32-bit integer, each bit can be set separately as follows: Bit 0 => HTTP service; Bit 1=> HTTPS service;...
Page 177 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0 => Use preset ipaddress, subnet, rounter, dns1, and dns2. ipaddress <ip address> IP address of server. subnet <ip address> Subnet mask. router <ip address> Default gateway.
Page 178 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.6.2 QOS Subgroup of network: qos_cos (capability_protocol_qos_cos > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable CoS (IEEE 802.1p) vlanid 1~4095 VLAN ID video Video channel for CoS audio Audio channel for CoS <product dependent>...
Page 179 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.6.4 FTP Subgroup of network: ftp NAME VALUE SECURITY DESCRIPTION (get/set) port 21, 1025~65535 Local ftp server port. enable <boolean> Enable ftp. 7.6.5 HTTP Subgroup of network: http NAME VALUE SECURITY DESCRIPTION...
Page 180 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) is equal or greater than 0311c. anonymousviewing <boolean> Enable anonymous streaming viewing. 7.6.6 HTTP per Channel Subgroup of network: http_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin"...
Page 181 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.6.8 RTSP Subgroup of network: rtsp (capability_protocol_rtsp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 554, 1025 ~ 65535 RTSP port. (capability_protocol_rtsp=1) anonymousviewing <boolean> Enable anoymous streaming viewing. authmode disable, RTSP authentication mode.
Page 182 VIVOTEK © 2019 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 183 VIVOTEK © 2019 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)
Page 184 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) or greater than 0312a. 7.7 IP Filter Group: ipfilter NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable access list filtering. admin_enable <boolean> Enable administrator IP address. admin_ip string[43] Administrator IP address.
Page 185 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.8 Video Input <Not supported anymore> Group: videoin NAME VALUE SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 CMOS frequency. * Only available when capability_videoin_type is 2. whitebalance auto, Modes of white balance. <product dependent>...
Page 186 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) from DC's exposure tuning options. The definition is: 0: EV -2.0 1: EV -1.7 2: EV -1.3 3: EV -1.0 4: EV -0.7 5: EV -0.3 6: EV 0 7: EV +0.3...
Page 187 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) switch on/off BLC. color 0, 1 0 =>monochrome 1 => color * Only available when " capability_videoin_c<0~(n-1)>_color_ support" is 1. flip <boolean> Flip the image. mirror <boolean>...
Page 188 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) etc. 5~8000 => 1/5s ~ 1/8000s etc. * Available value is * Only available when listed in "capability_image_c<0~(n-1)>_exposu "capability_image_ re_minrange" != "-" c<0~(n-1)>_exposu * Only valid when re_minrange"...
Page 190 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.8.1 Video Input Setting per Channel Group: videoin_c<0~(n-1)> for n channel products, and m is stream number n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" NAME VALUE SECURITY(...
Page 191 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) de" !="-" rgain 0~100 Manual set rgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbmo de".
Page 192 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.0 * Only available when "capability_image_c<0~(n-1)>_exposu re_mode" !=0 exposuremode auto, Select exposure mode. "auto": Automatically adjust the Iris, <product...
Page 193 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only available when "capability_image_c<0~(n-1)>_iristype "=dciris piris_mode manual, indoor, outdoor,- Control P-Iris mode. <product "outdoor": Auto-setting P-Iris to get dependent> best quality, but easy to meet rolling or flicker effect in indoor environment.
Page 194 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_m axgain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposu...
Page 195 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only available when " capability_videoin_c<0~(n-1)>_color_ support" is 1. flip <boolean> Flip the image. mirror <boolean> Mirror the image. rotate 0,90,180,270 The rotation angle of image. Support only in Rotation mode (capability_videoin_c<0~(n-1)>_rotati...
Page 196 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) ploadfilename name uploaded by user Minimum exposure time minexposure <1~32000>, <product <5~32000>, 1~32000 => 1s ~ 1/32000s dependent> <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc.
Page 197 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". shuttervalue <1~32000>, Exposure time <product <5~32000>, 1~32000 => 1s ~ 1/32000s dependent> <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc.
Page 198 VIVOTEK © 2019 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 0311a. crop_position <coordinate> Crop left-top corner coordinate. (x,y) crop_size <window size> Crop width and height.
Page 199 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) solution "capability_videoin_c<0~( n-1)>_resolution". Besides, available options is referred to "capability_videoin_c<0~( n-1)>_maxresolution" and "capability_videoin_c<0~( n-1)>_minresolution" s<0~(m-1)>_s <boolean> Enable "Smart fps" function. martfps_enabl * Only available when "capability_videoin_c<0~(n-1)>_smart fps_support" is 1.
Page 200 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "qpercent" 99: Use the quality level in "qvalue" * Only valid when "h264_ratecontrolmode"= vbr. s<0~(m-1)>_h2 0~51 Manual video quality level input. The 64_qvalue Q value which is used by encoded library directly.
Page 201 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 1: Worst quality 100: Best quality * Only valid when "h264_ratecontrolmode"= cbr and "quant"= 100. s<0~(m-1)>_h2 20000~"capability_videoin The target bit rate in constant bit rate 64_bitrate _c<0~(n-1)>_h264_maxbit mode.
Page 202 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) equal or greater than 0301c. s<0~(m-1)>_h2 250, 500, 1000, 2000, The time interval between two 65_intraperiod 3000, 4000 I-frames (Intra coded picture). The unit is millisecond (ms).
Page 203 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "capability_videoin_codec". * Only valid when "h265_ratecontrolmode"= vbr and "quant"= 100. s<0~(m-1)>_h2 20000~"capability_videoin The maximum allowed bit rate in fixed 65_maxvbrbitr _c<0~(n-1)>_h265_maxbit quality mode. rate" When the bit rate exceeds this value, frames will be dropped to restrict the bit rate.
Page 204 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 65_bitrate _c<0~(n-1)>_h265_maxbit mode. rate" * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "h265_ratecontrolmode"= cbr s<0~(m-1)>_h2 framerate,imagequality Set prioritypolicy 65_prioritypoli * Only available when h265 is listed in "capability_videoin_codec".
Page 205 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) peg_quant 99, 100 "mjpeg_ratecontrolmode"= vbr. Set the pre-defined quality level: 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "qpercent"...
Page 206 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "mjpeg_ratecontrolmode"= vbr s<0~(m-1)>_mj 1~5, 100 Set the pre-defined quality level: peg_cbr_quant 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent"...
Page 207 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) CIF(352x288)->(384x288) For NTSC: D1/4CIF(720/704x480) -> (640x480) CIF(352x240)->(320x240) * Only available when capability_videoin_type is 0 or 1. wdrpro_mode 0, 1, 2 0: Disable WDR Pro. <product 1: Enable WDR Pro.
Page 208 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) d" is 1 aespeed_spee 1~100 The speed level of AE converge speed. dlevel 1~20: level 1 <product 21~40: level 2 dependent> 41~60: level 3 61~80: level 4...
Page 209 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "capability_videoin_c<0~(n-1)>_moun ttype" != "-". enablewaterm 0, 1 0: Not to add watermarks on images 1: Add watermarks on images <product * Only available when dependent> "capability_fisheye" > 0 s<0~(m-2)>_fis...
Page 210 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) ual" is 1. "hybrid": only available when "capability_smartstream_mode_hybri d" is 1. qualitypriority -5,-4,-3,-2,-1,1,2,3,4,5 The differential value of Q between the regions of interest (ROI) and the areas of non-interest (non-ROI) of the display image.
Page 211 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.8.1.1 Alternative Video Input Profiles per Channel In addition to the primary setting of video input, there can be alternative profile video input setting for each channel which might be for different scene of light (daytime or nighttime).
Page 212 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) etc. * Available value is listed * This parameter may also restrict image frame rate from sensor due to "capability_image_c<0~(n- sensor generates a frame per 1)>_exposure_maxrange" exposure time. Ex: If this is set to 1/5s...
Page 213 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0302a. enableblc <boolean> Enable backlight compensation. <Not support * Not support this parameter anymore> anymore when the version number (httpversion) is equal or greater than 0301a.
Page 214 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) adjusting Iris, Gain automatically. "irispriority": Manually adjust with (Available options are list variable Iris, and keep adjusting Gain "capability_image_c<0~(n- and Shutter speed automatically. 1)>_exposure_modetype") "qualitypriority": Automatically adjust the Iris, Gain and Shutter Speed by VIVOTEK quality algorithm.
Page 215 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) specifically for indoor. "sodiumauto": sodium vapor lamps. * Only available when "capability_image_c<0~(n-1)>_wbmo de" !="-" rgain 0~100 Manual set rgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain"...
Page 216 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". mingain 0~100 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_mi ngain" != "-" * Only valid when "piris_mode"=manual or...
Page 217 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) piris_mode manual, indoor, outdoor,- Control P-Iris mode. "outdoor": Auto-setting P-Iris to get <product dependent> best quality, but easy to meet rolling or flicker effect in indoor environment.
Page 218 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <product 1: Enable WDR Pro. dependent> * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode" = 1 2: Enable WDR Pro II. * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode" = 2...
Page 219 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Level 1~4(low ~ high) The higher speed level meas shorter AE converged time during AE executing. * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1 aespeed_sensi 1~100 The sensitivity of AE converge speed.
Page 220 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.9 Time Shift Settings Group: timeshift for n channel products and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" (capability_timeshift > 0) NAME VALUE SECURITY DESCRIPTION...
Page 221 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.10 IR Cut Control <Not supported anymore> Group: ircutcontrol (capability__nvideoinprofile> 0 and capability_daynight_c<0~(n-1)>_support > n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, Set IR cut control mode <Not...
Page 222 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0312a. disableirled <boolean> Enable/disable built-in IR led <Not * Only available when recommended to "capability_daynight_illuminators_buil use this> tin_support > 0" and irled is listed in "capability_daynight_ illuminators _builtin_type"...
Page 223 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) blackwhitemode" is 1. * We replace this parameter with “ircutcontrol_c<0~(n-1)>_bwmode” when the version number (httpversion) is equal or greater than 0312a. sensitivity low,normal,high,1~10 Sensitivity of day/night control.
Page 224 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.10.1 IR cut control setting per channel Group: ircutcontrol_c<0~(n-1)> for n channel products (capability_daynight_c<0~(n-1)>_support > n denotes the value of "capability_nvideoin" NAME VALUE SECURIT DESCRIPTION (get/set) mode auto, Set IR cut control mode...
Page 225 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved * Only available when "capability_daynight_c<0~(n-1)>_ blackwhitemode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. sensitivity low,normal,high,1 Sensitivity of day/night control. ~100 There are two value format: "low,normal,high": if...
Page 226 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 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 227 VIVOTEK © 2019 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" 7.11 Image Setting per Channel Group: image_c<0~(n-1)> for n channel products and m profile n denotes the value of "capability_nvideoin"...
Page 228 VIVOTEK © 2019 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...
Page 229 VIVOTEK © 2019 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...
Page 230 VIVOTEK © 2019 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 231 VIVOTEK © 2019 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...
Page 232 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Spatical mode provides the best image quality, while Blend mode provides better image quality (than not using the deinterlace function at all). * Only available when "capability_image_c<0~(n-1)>_deinter lace_support"...
Page 233 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) (httpversion) is equal or greater than 0310a. 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 * Not support "policy=day" anymore...
Page 234 VIVOTEK © 2019 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 235 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * 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 236 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "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. _hlm * Only available when <product...
Page 237 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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...
Page 238 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.12 Exposure Window Setting per Channel Group: exposurewin_c<0~(n-1)> for n channel profucts n denotes the value of "capability_nvideoin" (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1) NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, custom,blc,hlc,center "auto": Use full image view as the only exposure window.
Page 239 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) window. * Only available when qvga is listed in "capability_image_c<0~(n-1)>_exposu re_windomain". size <0~320x0~240> Width and height of the window. * Only available when qvga is listed in "capability_image_c<0~(n-1)>_exposu...
Page 240 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1) NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, custom,blc,hlc,center The mode indicates how to decide the * Available values are listed exposure. "auto": Use full view as the only one "capability_image_c<0~(n-1)
Page 241 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when qvga is listed in "capability_image_c<0~(n-1)>_exposu re_windomain". size <0~320x0~240> Width and height of the window. * Only available when qvga is listed in "capability_image_c<0~(n-1)>_exposu re_windomain".
Page 242 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.13 Audio Input per Channel Group: audioin_c<0~(n-1)> (capability_naudioin>0) n denotes the value of "capability_naudioin" NAME VALUE SECURITY DESCRIPTION (get/set) source micin, linein micin => use built-in microphone <Not recommended <product input. to use this>...
Page 243 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) volume_external 0~100 Volume when take external microphone as input source. 0: Minimum 100: Maximum * Only available when the channel supports external microphone (The related bit of "capability_audio_extmic"...
Page 244 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) description of "volume_internal" and "volume_external". s0_codectype aac4, gamr, g711, Set audio codec type for input. g726 aac4: Advanced Audio Coding (AAC) (Available codec are gamr: Adaptive Multi-Rate (AMR) listed in g711: G.711...
Page 245 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) s0_g726_vlcmode 0, 1 Enable vlcmode for G.726. 0: Standard mode. 1: Solve compatibility problem with VLC player. * Only available if G.726 is supported. aec_enable <boolean> Enable acoustic echo cancellation.
Page 246 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.15 Play an Audio Clip Group: audioclip_i<0~1> (capability_audio_audioclip=1) NAME VALUE SECURITY DESCRIPTION (get/set) name string[40] Specify the audio clip name that can be played when an event occurs. size 0,<positive integer> The size of audio clip.
Page 247 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) ~ 9999,0 ~ 9999, 0 ~ position. 9999,0 ~ 9999, 0 ~ (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 9999,0 ~ 9999 * Only available when "capability_motion_wintype" = polygon. * Only available when std is listed in "capability_motion_windomain"...
Page 248 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0400a. left 0 ~ 320 Left coordinate of window position. <Not recommended * Only available when to use this>...
Page 249 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 250 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) name string[14] Name of motion window. polygonstd 0 ~ 9999,0 ~ 9999, Coordinate of polygon window position. 0 ~ 9999,0 ~ 9999, (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 0 ~ 9999,0 ~ 9999,...
Page 251 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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 252 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0400a. 7.17 Tampering Detection Settings Group: tampering_c<0~(n-1)> for n channel products (capability_tampering > 0) n denotes the value of "capability_nvideoin"...
Page 253 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) blurry_duration 1~10 If image too blurry value exceeds the "threshold" for more than "duration" second(s), then image too blurry detection is triggered. 7.18 DDNS Group: ddns (capability_protocol_ddns > 0)
Page 254 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.20 UPnP Presentation Group: upnppresentation NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP presentation service. 7.21 UPnP Port Forwarding Group: upnpportforwarding NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean>...
Page 255 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 7: LOG_DEBUG setparamlevel Show log of parameter setting. 0: disable 1: Show log of parameter setting set from external. 2. Show log of parameter setting set from external and internal.
Page 256 Hyperlink of the logo http://www.vivot ek.com logo_powerbyvvtk_hidd <boolean> 0 => display the power by vivotek logo 1 => hide the power by vivotek logo custombutton_manualtr <boolean> Show or hide manual trigger (VI) igger_show button in homepage 0 -> Hidden 1 ->...
Page 257 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.25 Privacy Mask Group: privacymask_c<0~(n-1)> for n channel products and m privacy mask window. n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean>...
Page 258 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0 ~ W,0 ~ H, position. 0 ~ W,0 ~ H, (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 0 ~ W,0 ~ H * Only available when W: 0~ The "capability_image_c<0~(n-1)>_privacy current image mask_wintype"...
Page 259 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) >_maxpan" "capability_camctrl_c<0~(n-1)>_ buildinpt" is "1" win_i<0~(m-1)>_tilt "capability_ptz_c<0~(n-1) Tilt position of window position. >_mintilt" ~ * Only available when bit1 of "capability_ptz_c<0~(n-1) "capability_camctrl_c<0~(n-1)>_ >_maxtilt" buildinpt" is "1" win_i<0~(m-1)>_zoom "capability_ptz_c<0~(n-1)
Page 260 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) change the old features and interfaces. Revision Increase the revision when fix bugs without change any features of the output. _platform This is a constant, it is used to...
Page 261 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) capability_daynight_c<0~"capability_ nvideoin"-1>_externalir for external * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. npir Number of PIRs. <positive integer>...
Page 262 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <positive integer> nmotion <positive integer> The number of motion window. nmotionprofile 0, <positive integer> Number of motion profiles. nevent 0, <positive integer> Number of event. * We support this parameter when the version number (httpversion) is equal or greater than 0311c.
Page 263 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) is supported or SD/PZ/PT/PD/video server series) Bit 6 => (only available when bit0 is 1) Reserved bit; always 0. Bit 7 => (only available when bit0 is 1) External or built-in PT;...
Page 264 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) presettourdirection <boolean> Indicate whether to support preset tour direction function. It means users can choose which direction the preset tour goes. * We support this parameter when the version number (httpversion) is equal or greater than 0307a.
Page 265 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) channel. For some dual-stream products, both streams support ePTZ. nanystream 0, <positive integer> number of any media stream per channel <boolean> Indicate whether to support Intelligent Video analysis whitelight <boolean>...
Page 266 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "tampering" = Tamper detection. "vi" = Virtual input (Manual trigger) "vadp" = VADP trigger. "di"= Digital input. "volalarm" = Audio detection. "temperature" = Temperature detection. "pir" = PIR detection.
Page 267 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) protocol_rtp_multi <boolean> Indicate whether to support scalable cast_scalable multicast. protocol_rtp_multi <boolean> Indicate whether to support cast_backchannel backchannel multicast. protocol_rtp_tcp <boolean> Indicate whether to support RTP over TCP.
Page 268 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) xframerate "-" "capability_videoin_c0_mjpeg_maxfra merate". * This is kept for compatibility. videoin_h264_max A list of <Integer> and This equals framerate "-" "capability_videoin_c0_h264_maxfra merate". * This is kept for compatibility.
Page 269 VIVOTEK © 2019 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 0306b. audio_aecaffect When acoustic echo cancellation maxframerate:fixed:1 function is enabled, some features may become malfunction or be forced <product dependent>...
Page 270 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) means the max frame rate is 15fps when acoustic echo cancellation function is enabled. "-" means no feature is affected. * Only available when "capability_audio_aec" is "1".
Page 271 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) audio_lineout <boolean> Indicate whether to support line output. audio_michardwar <boolean> Indicate whether the hardware eswitch supports built-in/external mic switch audio_headphoneo <boolean> Indicate whether to support headphone output.
Page 272 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) with pixels. "std": A normalized 0~9999 range. "-": Not supported. smartstream_supp <boolean> Indicate whether smart stream is supported. smartstream_versi <integer> Number of smart stream version. * Only available when "capability_smartstream_support"...
Page 273 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_smartstream_support" is 1 smartstream_nwin <positive integer> Maximum number of tracking window dow_manual of manual. * Only available when "capability_smartstream_support" is 1 smartstream_nwin <positive integer> Maximum number of tracking window dow_hybrid_autotr of autotracking in hybrid mode.
Page 274 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) camctrl_ptztunnel <boolean> Indicate whether to support ptztunnel. * We support this parameter when the version number (httpversion) is equal or greater than 0301b. This equals "capability_camctrl_c0_ptztunnel". * This is kept for compatibility.
Page 275 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) wireless_s802dot1 <boolean> Indicate whether to support wireless 802.11g. wireless_s802dot1 <boolean> Indicate whether to support wireless 802.11n. wireless_begincha 1 ~ 14 Indicate the begin channel of wireless nnel...
Page 276 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) test_ac <boolean> Indicate whether to support test ac key. version_onvifdaem <string> Indicate ONVIF daemon version version_onviftestto <string> Indicate ONVIF test tool version version_genetec <string> Indicate Genetec daemon version...
Page 277 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Reserved for compatibility, and suggest don't use this since [httpversion] > 0301a image_focusassist <boolean> Indicate whether to support focus <Not assist. recommended to * We replace "capability_image_ use this>...
Page 278 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_storm <string> Indicate storage manager daemon grversion version. * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_suppo...
Page 279 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) ster auxiliary camera (master side), this value means supporting max number of auxiliary camera. remotecamctrl_sla <boolean> Indicate whether to support remote camera control (slave side). fisheyelocaldewarp 0, <positive integer>...
Page 280 VIVOTEK © 2019 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...
Page 281 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) focusmode auto,onetimeauto,sp Focus mode selection: "auto": Camera will automatically otlight,manual <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 282 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) minpan 0, <positive integer> 0/7 The lower limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" maxpan 0, <positive integer> 0/7 The upper limit for pan position.
Page 283 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxtiltangle <integer> The upper limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" zoomspeedlv 0, <positive integer> 0/7 The maximum speed level of zoom motion.
Page 284 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Group: capability_daynight_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) support <boolean> Indicate whether the camera supports day/night mode switch builtinir <boolean> Indicate whether to support built-in IR led.
Page 285 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) blackwhitemode <boolean> Indicate whether to support automatically switch to Black & White display during the night mode. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 286 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) extled_interface The device interface of external IR led: <product "do": digital output dependent> * Only available when "capability_daynight_c<0~(n-1)>_extern alir" is 1 * We replaced this parameter with “capability_daynight_illuminators_exter...
Page 287 VIVOTEK © 2019 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 288 VIVOTEK © 2019 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.
Page 289 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 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. builtin_type irled,whiteled,- Indicate whether to support built-in led <product...
Page 290 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 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 291 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Group: capability_videoin_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) lens_type fisheye, fixed, The lens type of this channel. varifocal, "fisheye": Fisheye lens changeable, "fixed": Build-in fixed-focus lens. motor, ics,- "varifocal": Build-in varifocal lens.
Page 292 VIVOTEK © 2019 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 293 VIVOTEK © 2019 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 294 VIVOTEK © 2019 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 295 VIVOTEK © 2019 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.
Page 296 VIVOTEK © 2019 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 "capability_videoin_codec".
Page 297 VIVOTEK © 2019 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 298 VIVOTEK © 2019 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 299 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) resolutionC1P A list of <WxH> Available resolutions of 1P mode of ceiling and floor mount. resolutionC2P A list of <WxH> Available resolutions of 2P mode of ceiling and floor mount.
Page 300 VIVOTEK © 2019 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 301 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) outputsize <WxH> The output size of source, equal to the captured size by device, in this video mode. The unit is pixel. This value is used as a basic coordinate system for many features, like ePTZ, privacy mask, motion, etc.
Page 302 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) minresolution A list of <Integer> Represent supported minimum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream". * We support this parameter when the version number (httpversion) is equal or greater than 0304b.
Page 303 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxfps_h264 A list of <Positive Maximum fps which the device can Integer> and "-" encoded with H.264 on resolutions in this video mode. "-" means not support.
Page 304 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Bit 1 => Supports Contrast or not. Bit 2 => Supports Saturation or not. Bit 3 => Supports Sharpness or not. Bit 4 => Supports adjusting the image to proper position horizontally or not.
Page 305 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) exposurelevel:hidd affected functions are list here. en:, The format is "Affect API exposurelevel:fixed name":"Policy":"Description" :<x>, "Policy" can be categorized into exposurelevel:fixed following groups: :<x>/<x>, - (disabled) : UI turns grey and users exposuremode:fixe can't select it.
Page 306 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) be "-" wdrpro_description <string> Description about WDR Pro mode. * Only available when "capability_image_c<0~(n-1)>_wdrpro _mode" > 0 wdrc_mode 0, 1 0: Non-support WDR Enhanced 1: Support WDR Enhanced wdrc_supportlevel 0, <positive...
Page 307 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. For example: "exposurelevel:fixed:6/8/12" which means exposurelevel is fixed to level 6, level 8 and level 12.
Page 308 VIVOTEK © 2019 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. is_strength <boolean> 0: Non-support tuning strength of image stabilizer mode. 1: Support tuning strength of image stabilizer mode.
Page 309 VIVOTEK © 2019 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.
Page 310 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) panorama, "-" means white balance is not manual, supported. rbgain, widerange, outdoor,indoor, sodiumauto, <product dependent> iristype piris, Indicate iris type. dciris, "piris": P-Iris "dciris": DC-Iris "-": No Iris control support...
Page 311 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "twovalues": Need two parameters to indicate the exposure range. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 312 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) exposure_mode" is 1 and "capability_image_c<0~(n-1)>_exposu re_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_automode_ When exposure auto mode is affect exposurewin.mode...
Page 313 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when auto is listed in "capability_image_c<0~(n-1)>_ exposure_modetype" and "capability_image_c<0~(n-1)>_...
Page 314 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL.
Page 315 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled.
Page 316 VIVOTEK © 2019 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 317 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) icrmode.auto:nots "Policy" can be categorized into upport: following groups: or others - (disabled) : UI turns grey and users <x>: nonnegative can't select it. integer - (unchanged) : UI keeps the status as <product...
Page 318 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * When "exposure_mode"=0, this value must be set to "-". * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_winmode auto, Available options for custom, "exposurewin_c<0~(n-1)>_mode" blc, * "-" means group: exposurewin is not hlc, supported.
Page 319 VIVOTEK © 2019 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 320 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) control. "-": Not supported. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_windomain qvga, px, std, - The domain to set an exposure window. "qvga": a 320x240 range to represent the whole image.
Page 321 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0301a. exposure_maxrange "1,32000", Available range for "1,8000", "videoin_c<n>_maxexposure" "1,32000" => 1s ~ 1/32000s or others "1,8000"...
Page 322 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) different exposure values. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0310a.
Page 323 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) “0,100” => 0~100 percent "-" means "videoin_c<n>_maxgain" is not available. agc_mingain "0,100", Available range for "-" "videoin_c<n>_mingain" “0,100” => 0~100 percent "-" means "videoin_c<n>_mingain" is not available.
Page 324 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected.
Page 325 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled.
Page 326 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) focusassist 0: Non-support focus assist 1: Support focus assist remotefocus 0,<positive An 4-bit integer, which indicates the integer> supportive application of remotefocus in this channel. If the value of this parameter is larger...
Page 327 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0302a. autotrack_support <boolean> 0: Non-support auto tracking feature 1: Support auto tracking feature * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 328 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) ignment" is 1. lens_ldc_support <boolean> Indicate whether to support lens distortion correction function. * We support this parameter when the version number (httpversion) is equal or greater than 0309d.
Page 329 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.28 Customized Event Script Group: event_customtaskfile_i<0~2> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Custom script identification of this entry. date string[4~20] Date of custom script. time string[4~20] Time of custom script. 7.29 Event Setting Group: event_i<0~(n-1)>...
Page 330 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) trigger boot, Indicate the trigger condition: "boot" = System boot. pir, "di"= Digital input. motion, "pir"= PIR detection. seq, "motion" = Video motion detection. recnotify, "seq" = Periodic condition.
Page 331 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) 0,<positive Indicate the source id of vi trigger. integer> This field is required when trigger condition is “vi”. One bit represents one digital input. The LSB indicates VI 0.
Page 332 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) endtime hh:mm End time of the weekly schedule. (00:00 ~ 24:00 sets schedule as always lowlightcondition 0, 1 Switch on white light LED in low light <product dependent>...
Page 333 VIVOTEK © 2019 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 334 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_audioclip_media 0,<positive Indicate the source id of audioclip event integer> notification. * Only avaliable when "capability_audio_audioclip" is 1. tampering 0,<positive Indicate the source channel id of integer>...
Page 335 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) ftp_username string[64] Username to log in to the server. ftp_passwd string[64] Password of the user. ftp_port 0~65535 Port to connect to the server. ftp_location string[128] Location to upload or store the media.
Page 336 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.31 Media Setting for Event Action Group: media_i<0~(n-1)> n denotes the value of "capability_media_num" (capability_media_num > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) Name string[40] Identification of this entry Type snapshot, Media type to send to the server systemlog, or store on the server.
Page 337 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) snapshot_datesuffix 0, 1 Add date and time suffix to filename: 1 = Add date and time suffix. 0 = Do not add. snapshot_preevent 0~" Indicates the number of pre-event capability_media_snapshot_ images.
Page 338 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) videoclip_maxsize 50 ~ " Maximum size of one video clip capability_media_videoclip_ file in Kbytes. maxsize" 338 - User's Manual...
Page 339 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.32 Recording Group: recording_i<0~(n-1)> n denotes the value of "capability_nrecording" (capability_nrecording > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. trigger schedule, The event trigger type networkfail schedule: The event is triggered by...
Page 340 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxretentiontime <string> To specify the expired time for automatic clean up, and it only takes effect for video clip generated by recording_i <0~1>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss] S’...
Page 341 VIVOTEK © 2019 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...
Page 342 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) adaptive_enable <boolean> Indicate whether the adaptive recording is enabled adaptive_preevent 0~9 Indicate when is the adaptive recording started before the event trigger point (seconds) adaptive_postevent 0~10 Indicate when is the adaptive recording...
Page 343 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) organizationname string[64] Organization name in the certificate VIVOTEK Inc. information. unit string[64] Organizational unit name in VIVOTEK Inc. thecertificate information. commonname string[64] Common name in the certificate www.vivotek.com...
Page 344 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) autocleanup_enabled <boolean> Enable automatic clean up method. <Not recommended to Expired and not locked media files will be use this> deleted. * For forward compatibility reservations, but only group disk_i0_autocleanup is effective.
Page 345 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.35 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 or capability_fisheye = 1) PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-1)>_home...
Page 346 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.36 ePTZ Setting Group: eptz_c<0~(n-1)> for n channel product. (capability_eptz > 0 or capability_fisheye = 1) PARAMETER VALUE SECURITY DESCRIPTION (get/set) osdzoom <boolean> Indicates multiple of zoom in is <Not recommended to “on-screen display”...
Page 347 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) Auto pan/patrol speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.) rotatespeed 1 ~ 5 Rotate speed (only for Fisheye series) * Only available when "capability_fisheye"...
Page 348 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) Width and height of the preset. (It should be set by ePreset.cgi rather than by setparam.cgi.) 7.37 Focus Window Setting Group: focuswindow_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin".
Page 349 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.38 Seamless Recording Setting <Not supported anymore> Group: seamlessrecording (capability_localstorage_seamless> 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) diskmode seamless, “seamless” indicates enable seamless manageable recording. “manageable” indicates disable seamless recording. * We replace this parameter with “seamlessrecording_c<0~(n-1)>_diskmode”...
Page 350 VIVOTEK © 2019 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.
Page 351 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved guid<0~(k-1)>_id string[127] The connected seamless streaming ID. (Read only) * k denotes the value of "seamlessrecording_c<0~(n-1)>_maxco nnection" * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
Page 352 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) saved to SD card when user want to upload it. If the value is false, save module to the internal storage space and it will occupy storage size.
Page 353 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Group: vadp_module_i<0~(n-1)> for n VADP package number (capability_vadp_npackage > 0) n denotes the value of "capability_vadp_npackage". NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Indicate if the module is enabled or not. If yes, also add the index of this module to the module_order.
Page 354 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the schedule mode to control the execution of the VADP package begintime hh:mm Begin time of the schedule endtime hh:mm End time of the schedule...
Page 355 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) The dwelling time of each patrol point, separated by “,” * only available when capability_camctrl_c0_rs485=2 preset_i<0~(k-1)>_nam string[40] Name of the preset location. preset_i<0~(k-1)>_ 0 ~ 999 The dwelling time of each preset...
Page 356 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.41 Camera PTZ Control (IZ Series) Group: camctrl_c<0~(n-1)> for n channel products (capability_camctrl_c0_zoommodule = 1 and capability_camctrl_c0_buildinpt = 0) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset"...
Page 357 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) rt"-1 * only available when capability_camctrl_c0_rs485=2 isptz 0 ~ 2 0: disable PTZ commands. 1: enable PTZ commands with PTZ driver. 2: enable PTZ commands with UART tunnel.
Page 358 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) The dwelling time of each patrol point, separated by “,” * only available when capability_camctrl_c0_rs485=2 disablemdonptz <boolean> Disable motion detection on PTZ operation. defaulthome <boolean> This field tells system to use default home position or not.
Page 359 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.42 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"...
Page 360 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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. capability_ptz_c<0~( n-1)>_maxtilt preset_i<0~(k-1)>_zoom capability_ptz_c<0~( Zoom position at each preset n-1)>_minzoom ~ location.
Page 361 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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.
Page 362 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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. "backward": preset tour goes in backward order.
Page 363 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.43 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.
Page 364 VIVOTEK © 2019 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 365 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) stopbit "1": One stop bit is transmitted to indicate the end of a byte. "2": Two stop bits are transmitted to indicate the end of a byte.
Page 366 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Group: lens_default_i<0~(n-1)> n denotes the value of "lens_default_totalnumbers" NAME VALUE SECURITY DESCRIPTION (get/set) name <string> Default lens name Group: lens_user_i<0~(n-1)> n denotes the value of "lens_user_totalnumbers" NAME VALUE SECURITY DESCRIPTION (get/set) name <string>...
Page 367 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) [0~359]. Pan range of wall mount is [-90~90]. s<0~(m-2)>_region_t -90~90 Tilt home angle of regional view <integer> Tilt range of ceiling/floor mount is [0~90]. Tilt range of wall mount is [-90~90].
Page 368 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.50 Wireless Group: wireless (capability_network_wireless > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) ssid string[32] SSID for wireless lan settings. wlmode Infra, Wireless mode. Adhoc Infra: Infrastructure channel 1~11 or A list of WLAN channels.
Page 369 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) key1 password [26] WEP key1 for encryption. * Only valid when "wireless_encrypt" is "wep" key2 password [26] WEP key2 for encryption. * Only valid when "wireless_encrypt" is "wep"...
Page 370 VIVOTEK © 2019 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: [&do2=<state>] [&do3=<state>][&do4=<state>] Where state is 0 or 1; “0” means inactive or normal state, while “1” means active or triggered state.
Page 371 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved [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?di1 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n di1=1\r\n 8.3 Query Status of the Digital Output (capability_ndo >...
Page 372 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n do1=1\r\n 8.4 Capture Single Snapshot Note: This request requires Normal User privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/video.jpg?[channel=<value>][&resolution=<value>] [&quality=<value>][&streamid=<value>] If the user requests a size larger than all stream settings on the server, this request will fail.
Page 373 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.5 Account Management Note: This request requires Administrator privileges. Method: POST Syntax: http://<servername>/cgi-bin/admin/editaccount.cgi? method=<value>&username=<name>[&userpass=<value>][&privilege=<value>] [&privilege=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION method Add an account to the server. When using this method, the“username” field is necessary. It will use the default value of other fields if not specified.
Page 374 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 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 375 VIVOTEK © 2019 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...
Page 376 VIVOTEK © 2019 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.
Page 377 VIVOTEK © 2019 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.
Page 378 VIVOTEK © 2019 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.
Page 379 VIVOTEK © 2019 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>...
Page 380 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.11 UART HTTP Tunnel Channel (capability_nuart > 0) Note: This request requires Operator privileges. Method: GET and POST 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...
Page 381 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.12 Event/Control HTTP Tunnel Channel (capability_evctrlchannel > 0) Note: This request requires Administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/ctrlevent.cgi ------------------------------------------------------------------------- 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...
Page 382 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.13 Get SDP of Streams Note: This request requires Viewer access privileges. Method: GET/POST Syntax: http://<servername>/<network_rtsp_s<0~m-1>_accessname> “m” is the stream number. “network_accessname_<0~(m-1)>” is the accessname for stream “1” to stream “m”. Please refer to the “subgroup of network: rtsp”...
Page 383 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.15 Send Data (capability_nuart > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/senddata.cgi? [com=<value>][&data=<value>][&flush=<value>] [&wait=<value>] [&read=<value>] PARAMETER VALUE DESCRIPTION 1 ~ <max. com port The target COM/RS485 port number.
Page 384 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.16 Storage Managements (capability_stroage.dbenabled > 0) Note: This request requires administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=<cmd_type>[&<parameter>=<value>…] The commands usage and their input arguments are as follows. PARAMETER VALUE DESCRIPTION cmd_type <string>...
Page 385 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION Ex. resolution=’800x600’ isLocked <boolean> Optional. Indicate if the file is locked or not. 0: file is not locked. 1: file is locked. A locked file would not be removed from UI or cyclic storage.
Page 386 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION Ex. label=1 Ex. Delete records whose key numbers are 1, 4, and 8. http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=delete&label=1&label=4&label=8 Command: update PARAMETER VALUE DESCRIPTION label <integer primary key> Required. Identify the designated record. Ex. label=1 isLocked <boolean>...
Page 387 VIVOTEK © 2019 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”...
Page 388 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Examples: 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...
Page 389 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DEFAULT DESCRIPTION ignored. 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.
Page 390 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.19 RemoteFocus (capability_image_c<0~(n-1)>_remotefocus=1) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/remotefocus.cgi?function=<value>[&direction=<value>] [&position=<value>][&steps=<value>][&iris] 390 - User's Manual...
Page 391 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function zoom, Function type focus, zoom - Move focus motor focus – Move focus motor auto, scan, auto – Perform auto focus stop, scan – Perform focus scan positioning, stop –...
Page 392 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION direction direct, Motor’s moving direction. forward, It works only if function=zoom or function=focus. backward position 0~<motor_max> Motor’s position. It works only if function=zoom or function= focus and direction=direct. <motor_max> is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from "function=getstatus"...
Page 393 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.20 BackFocus (capability_image_c<0~(n-1)>_remotefocus=4) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/remotefocus.cgi?function=<value>[&direction=<value>] [&position=<value>][&steps=<value>][&iris] PARAMETER VALUE DESCRIPTION User's Manual - 393...
Page 394 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function focus, Function type auto, focus – Move focus motor auto – Perform auto focus scan, stop, scan – Perform focus scan positioning, stop – Stop current operation irisopen, positioning –...
Page 395 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION position 0~<motor_max> Motor’s position. It works only if function=focus and direction=direct. <motor_max> is refer to remote_focus_focus_motor_max which replied from "function=getstatus" steps 1 ~ <motor_max> Motor’s moving steps. It works only if function=focus and direction=forward or direction=backward.
Page 396 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.22 Upload Files Note: This request requires Administrator privileges. Method: POST Syntax: For daylight saving time configuration file: http://<servername>/cgi-bin/admin/upload_dst.cgi Post data: filename =<file name>\r\n \r\n <multipart encoded form data> For language file: http://<servername>/cgi-bin/admin/upload_lan.cgi...
Page 397 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 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 398 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Post data: upload_lens_profile_input = <file name>\r\n \r\n <multipart encoded form data> Server will accept the file named <file name> to upload the lens profile to camera. 8.24 Media on Demand (capability_localstorage.modnum > 0) Media on demand allows users to select and receive/watch/listen to metadata/video/audio contents on demand.
Page 399 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 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 - 399...
Page 400 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.25 Fisheye Local Dewarp Camera Control (capability_fisheye > 0 and capability_fisheyelocaldewarp.c0 > 0, only support in 1R mode) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/fdCamCtrl.cgi?channel=<value>&stream=<value> [&move=<value>] – Move home, up, down, left, right [&zoom=<value>]...
Page 401 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION left Move left. right Move right. zoom wide Zoom larger view with current speed. tele Zoom further with current speed. speedpan -5 ~ 5 Set the pan speed of current command.
Page 402 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.26 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...
Page 403 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.27 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 404 VIVOTEK © 2019 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 405 VIVOTEK © 2019 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.
Page 406 VIVOTEK © 2019 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 407 VIVOTEK © 2019 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.
Page 408 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.29 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 409 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.30 SmartSD (capability_localstorage_smartsd > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/smartsd.cgi?function=<value> User's Manual - 409...
Page 410 VIVOTEK © 2019 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...
Page 411 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.31 Connect to AP (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION Apply the wireless settings and connect to AP. 8.32 Get Wireless Information (capability_network_wireless >...
Page 412 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.33 Get Wireless Signal Strength (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/getwlsignalstrength.cgi 412 - User's Manual...
Page 413 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION Get wireless signal strength. 8.34 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.35 Peripheral Control (capability_peripheral_c<0~(n-1)>_...
Page 414 VIVOTEK © 2019 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 415 VIVOTEK © 2019 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.
Page 416 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.36 Optimized IR control (capability_daynight_c<0~(n-1)>_optimizedir > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/optimizedir.cgi?function=<value>[&channel=<value>] PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. function getstatus, "onetimeauto": Camera will automatically adjust the IR onetimeauto zone one time only.
Page 417 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved http://myserver/cgi-bin/admin/optimizedir.cgi?function=getstatus 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'" "optimizedir_c0_irnum='5'" "optimizedir_c0_irstrength='1,97,100,100,100'" "optimizedir_c0_irstatus='normal'" (for control API) Syntax: http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=<value>&irmode= manual[&strength=<value>] – Set IR strength PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source.
Page 418 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=settoall&irmode=manual&str ength=100 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irstrength='100,100,100,100,100'" "optimizedir_c0_irmode='manual'" Example: 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...
Page 419 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=get [&support_irmode] – list all adjustment mode that IR supports [&irmode] – Get current IR mode [&irnum] – Get the number of IR zone PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source.
Page 420 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved \r\n 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: time out 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.
Page 421 VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n version=1120B15 8.38 Audio Clip Control (capability_audio_audioclip=1) Note: This request requires Administrator privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/admin/audioclip.cgi?operation=<value>[&name=<value>][&index=<value>] PARAMETER VALUE DESCRIPTION operation startrecording, "startrecording"...
Page 423 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 424 を経由し接続してください。」 Liability VIVOTEK Inc. cannot be held responsible for any technical or typographical errors and reserves the right to make changes to the product and manuals without prior notice. VIVOTEK Inc. makes no warranty of any kind with regard to the material contained within this document, including, but not limited to, the implied warranties of merchantability and fitness for any particular purpose.

This manual is also suitable for:

Ip9164-lpc

Vivotek IP9164-HT User Manual

Quick Links

Need help?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Vivotek IP9164-HT

Summary of Contents for Vivotek IP9164-HT

This manual is also suitable for:

Table of Contents