Vivotek IP8166 User Manual
Vivotek IP8166 User Manual

Vivotek IP8166 User Manual

2mp wdr vari-focal smart stream ii snv snapshot focus
Table of Contents

Advertisement

IP8166
User's Manual
2MP • WDR • Vari-Focal • Smart Stream II • SNV
Snapshot Focus
Box
Network Camera
Rev. 1.0

Advertisement

Table of Contents
loading

Summary of Contents for Vivotek IP8166

  • Page 1 IP8166 Network Camera User’s Manual 2MP • WDR • Vari-Focal • Smart Stream II • SNV Snapshot Focus Rev. 1.0...
  • Page 2: Table Of Contents

    ..........................119 Applications > Tampering detection ........................120 Applications > Audio detection ......................... 121 Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) ..... 123 Recording > Recording settings ........................126 Local storage > SD card management ....................... 131 Local storage >...
  • Page 3: Overview

    VIVOTEK’s IP8166 is a professional box network camera equipped with a Full HD sensor enabling a viewing resolution of 1920x1080 at a smooth 30 fps. The IP8166 is capable of capturing high quality, high resolution video at up to 2 Megapixels in low light environments with VIVOTEK’s SNV technology, making the camera ideal for a wide range of video...
  • Page 4: Read Before Use

    Network Camera and ensure proper operations. For creative and professional developers, the URL Commands of the Network Camera section serves as a helpful reference to customizing existing homepages or integrating with the current web server. Package Contents ■ IP8166. ■ Lens module ■ Software CD ■ Camera stand ■...
  • Page 5: Physical Description

    VIVOTEK Physical Description Front Panel Light Sensor Lens Rear Panel Recessed Reset Button Audio Out Audio In SD Card Slot Ethernet 10/100 RJ45 Socket Focus Assist NTSC/PAL switch BNC video output General I/O Terminal Block Status LED User's Manual - 5...
  • Page 6: 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 camera. 6 - User's Manual...
  • Page 7 VIVOTEK 4. Install the camera stand to camera. 5. Connect an Ethernet cable to the camera. 6. Install an SD card, and, if preferred, connect DI/DO wires to the terminal block The AC/ DC pins can accept either 12V or 24V power input with no polarity.
  • Page 8 VIVOTEK DI/DO Diagram Switch Source External BJT transistor power source Relay External device Switch Source BJT transistor Relay External device 1. The DO+ pin provides 5V output voltage, and the max. load is 50mA. 2. The max. voltage for DO- pins is 80VDC (External power).
  • Page 9 VIVOTEK When installing the camera, you can also use a camera tester to acquire images on site. User's Manual - 9...
  • Page 10 VIVOTEK 7. Install the IW2 utility. Use the IW2 utility to find the camera on LAN. Open a web console to have a live view. 00-02-D1-73-02-02 192.168.5.151 FD8168 0002D1730202 Browser 9. With a live view on screen, adjust the image zoom and focus using the pullers on lens module.
  • Page 11 VIVOTEK You can purchase the AE-236/237/241/242 enclosure for outdoor installations and also for operation under a cold weather. LED Definitions Item LED status Description Steady Powered and system booting, or network failed LED off Power off Green LED off Network is disconnected...
  • Page 12 VIVOTEK When choosing the lens for your camera, please notice the specifications as below. The screw mount (distance A-C) must be shorter than 7.3mm; in case that the bottom of screw mount may hit the IR Cut Filter. 12 - User's Manual...
  • Page 13 VIVOTEK Focus Assist (P-iris model only) Please follow the steps to fine-tune the camera focus: 1. Adjust the C- or CS-mount ring and fix the shooting direction. 2. Click “on“ to enable the focus assist function, then the Live Video Window will become full screen for precise focus adjustment.
  • Page 14: 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 15: Internet Connection Via A Router

    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 16 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 17: Software Installation

    2. The program will conduct an analysis of your network environment. After your network environment is analyzed, please click Next to continue the program. 3. The program will search for all VIVOTEK network devices on the same LAN. User's Manual - 17...
  • Page 18: Ready To Use

    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. Network Camera Model No: IP8166 MAC:0002D1730202 R o HS 00-02-D1-73-02-02 192.168.5.151...
  • Page 19: 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 20 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 83.
  • Page 21 VIVOTEK IMPORTANT: • Currently the Network Camera utilizes 32-bit ActiveX plugin. You CAN NOT open a management/view session with the camera using a 64-bit IE browser. • If you encounter this problem, try execute the Iexplore.exe program from C:\Windows\ SysWOW64. A 32-bit version of IE browser will be installed.
  • Page 22: 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. mpegable Player 2.
  • Page 23: 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 24: 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. 24 - User's Manual...
  • Page 25: 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 26 VIVOTEK Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 30. 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 27 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 96 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 28 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 29 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 30: 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.264 Media Options Select to stream video or audio data or both.
  • Page 31: Mp4 Saving Options

    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 32: Joystick Settings

    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 33 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 34 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 35: 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 36: 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 37: 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 38 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 39 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 40: 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 41 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 42: 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 43: 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 44 VIVOTEK General settings > Restore This feature allows you to restore the Network Camera to factory default settings. Network: Select this option to retain the Network Type settings (please refer to Network Type on page 67). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
  • Page 45 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 46 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 47: 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 48 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 a flip/mirror setting.
  • Page 49 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 50: Image Settings

    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 51 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 52 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 53 VIVOTEK The inclusive window refers to the “weighed window“; the exclusive window refers to “ignored window“. It adopts the weighed averages method to calculate the value. The inclusive windows have a higher priority. You can overlap these windows, and, if you place an exclusive window within a larger inclusive window, the exclusive part of the overlapped windows will be deducted from the inclusive window.
  • Page 54 VIVOTEK ■ Flickerless: Under some circumstances when there is a difference between the video capture frequency and local AC power frequency (NTSC or PAL), the mismatch causes color shifts or flickering images. If the above mismatch occurs, select the Flickerless checkbox, and the range of Exposure time (the shutter time) will be limited to a range in order to match the AC power frequency.
  • Page 55 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 56 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 57: Media > Video

    VIVOTEK Media > Video Stream settings Mode - Resolution and Frame rate The default resolution is 1080P full HD, and if bandwidth or frame rate per second is of the concern, you can select a lower resolution while enjoying a higher frame rate (e.g., in traffic monitoring). The other configurable options is 720P (16:9) at 60fps.
  • Page 58 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 59 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.264, and MJPEG compression standards (Triple Codec) for real-time viewing. If the H.264...
  • Page 60 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 61 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 codec: Smart codec effectively reduces the quality of the whole or the non-interested areas on a screen and therefore reduces the bandwidth consumed.
  • Page 62 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 63 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 64 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 65: 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 66: 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 17 for details.
  • Page 67 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 68 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. is not supported by your router, you will see the following message: ►...
  • Page 69 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 70 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 71 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 72 1025 and 65535. FTP port: The FTP server allows the user to save recorded video clips. You can utilize VIVOTEK's Installation Wizard 2 to upgrade the firmware via FTP server. By default, the FTP port is set to 21.
  • Page 73: 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 83 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 74: Rtsp Streaming

    VIVOTEK URL command -- http://<ip address>:<http port>/<access name for stream 1, 2, 3,4 > For example, when the Access name for stream 2 is set to video2.mjpg: 1. Launch Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter.
  • Page 75 VIVOTEK Authentication: Depending on your network security requirements, the Network Camera provides three types of security settings for streaming via RTSP protocol: disable, basic, and digest. basic authentication is selected, the password is sent in plain text format, but there can be potential risks of it being intercepted.
  • Page 76 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 77 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 78 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 79 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 80 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 81 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 82: 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 83: Security > User Accounts

    VIVOTEK Security > User accounts This section explains how to enable password protection and create multiple accounts. Root Password The administrator account name is “root”, which is permanent and can not be deleted. If you want to add more accounts in the Manage User column, please apply the password for the “root”...
  • Page 84: 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 85 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 86 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 87 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 88 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 89 VIVOTEK 9. Save the edit using the “.crt” extension, using a file name like “CAcert.crt.” 10. Return to the original firmware session, use the Browse button to locate the crt certificate file, and click Upload to enable the certification. User's Manual - 89...
  • Page 90 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 91: 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 92 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 93 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 94 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 95 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 96: 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 97 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 98 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 99: 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 100 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, http://www.vivotek.com/downloadfiles/support/...
  • Page 101 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 102: 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 103 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 104 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 105 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 106 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 107 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 108 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 109 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 129 for details. Note that only one NAS server can be configured. Click Save server to enable the settings.
  • Page 110 VIVOTEK Click 20150120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2015/01/20 2015/01/20 Click to go back to the previous Click to delete level of the directory selected items Click to delete all...
  • Page 111 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 112 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_20150513_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings.
  • Page 113 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 114 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 115 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. 20150213...
  • Page 116: 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: For special situations Motion Detection Setting 1: For normal situations Follow the steps below to enable motion detection: 1.
  • Page 117 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 102.
  • Page 118 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 103 for detailed informatio. NOTE: ►...
  • Page 119: 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. You can then select High or Low as the normal status.
  • Page 120: 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 121: 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 122 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 123: 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 124 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 125 Follow the onscreen instruction on VIVOTEK's website for the registration procedure. You can proced with the following link to download a license key: http://www.vivotek.com/ vadp-introduction/ or http://w3.vivotek.com/login.aspx. When the license key is downloaded to your computer, upload the key to the camera.
  • Page 126: Recording > Recording Settings

    VIVOTEK Recording > Recording settings This section explains how to configure the recording settings for the Network Camera. Recording Settings Insert your SD card and click here to test NOTE: ► Please remember to format your SD card via the camera’s web console (in the Local storage .
  • Page 127 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 128 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 129 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 130 VIVOTEK Event If you want to enable recording notification, please click to configure event triggering settings. Please refer to Event > Event settings on page 102 for more details. When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page.
  • Page 131: Local Storage > Sd Card Management

    VIVOTEK Local storage > SD card 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 132: Local Storage > Content Management

    VIVOTEK SD card control ■ Enable cyclic storage: Check this item if you want to enable cyclic recording. When the maximum capacity is reached, the oldest file will be overwritten by the latest one. ■ Enable automatic disk cleanup: Check this item and enter the number of days you wish to retain a file.
  • Page 133: Search Results

    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 134 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 135: Url Commands For The Network Camera

    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 136: General Cgi Url Syntax And Parameters

    VIVOTEK 3. General CGI URL Syntax and Parameters CGI parameters are written in lower-case and as one word without any underscores or other separators. When the CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server.
  • Page 137: Get Server Parameter Values

    VIVOTEK 5. Get Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/viewer/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/operator/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/admin/getparam.cgi?[<parameter>] [&<parameter>…] Where the <parameter> should be <group>[_<name>] or <group>[.<name>]. If you do not specify any parameters, all the parameters on the server will be returned.
  • Page 138: Set Server Parameter Values

    VIVOTEK Example: Request IP address and its response Request: 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 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>…][&update=<value>][&return=<return page>] http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value>...
  • Page 139 VIVOTEK (Note: The return page can be a general HTML file(.htm, .html) or a VIVOTEK server script executable (.vspx) file. It cannot be a CGI commandor have any extra parameters.This parameter must be placed at the end of the parameter list Return: HTTP/1.0 200 OK\r\n...
  • Page 140: Available Parameters On The Server

    VIVOTEK 7. Available parameters on the server Valid values: VALID VALUES DESCRIPTION string[<n>] Text strings shorter than ‘n’ characters. The characters “,’,<,>,& are invalid. string[n~m] Text strings longer than `n’ characters and shorter than `m’ characters. The characters “,’,<,>,& are invalid.
  • Page 141 VIVOTEK W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 NOTE: The camera should not be restarted when parameters are changed. User's Manual - 141...
  • Page 142 VIVOTEK 7.1system Group: system NAME VALUE SECURITY DESCRIPTION (get/set) hostname string[64] Host name of server (Network Camera, Wireless Network Camera, Video Server, Wireless Video Server). ledoff <boolean> Turn on (0) or turn off (1) all led indicators. date <YYYY/MM/DD>, Current date of system. Set to ‘keep’ to keep keep, date unchanged.
  • Page 143 VIVOTEK -140: GMT-03:30 Newfoundland -120: GMT-03:00 Brasilia, Buenos Aires, Georgetown, Greenland -80: GMT-02:00 Mid-Atlantic -40: GMT-01:00 Azores, Cape_Verde_IS. 0: GMT Casablanca, Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London 40: GMT 01:00 Amsterdam, Berlin, Rome, Stockholm, Vienna, Madrid, Paris 41: GMT 01:00 Warsaw, Budapest, Bern...
  • Page 144 VIVOTEK Caledonia 480: GMT 12:00 Aucklan, Wellington, Fiji, Kamchatka, Marshall Is. 520: GMT 13:00 Nuku'Alofa daylight_enable <boolean> Enable automaticdaylight saving time in time zone. daylight_dstactualmode <positive integer> Check if current time is under daylight saving time. (Used internally) daylight_auto_begintime string[19] Display the current daylight saving start time.
  • Page 145 VIVOTEK 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. restoreexceptvadp Restore the system parameters to default <positive integer>...
  • Page 146 VIVOTEK language_count <positive integer> Number of webpage languages available on the server. language_i<0~(count-1)> string[16] Available language lists. language_i0 : English language_i1 : Deutsch language_i2 : Español language_i3 : Français language_i4 : Italiano language_i5 : 日本 語 language_i6 : Português language_i7 : 简体...
  • Page 147 VIVOTEK 7.2status Group: status NAME VALUE SECURITY DESCRIPTION (get/set) di_i<0~(capability_ndi-1)> <boolean> 0 => Inactive, normal <product dependent> 1 => Active, triggered (capability.ndi > 0) do_i<0~(capability_ndo-1)> <boolean> 0 => Inactive, normal <product dependent> 1 => Active, triggered (capability.ndo > 0) onlinenum_rtsp 0,<positive...
  • Page 148 VIVOTEK 7.5security Group: security NAME VALUE SECURITY DESCRIPTION (get/set) privilege_do view, operator, Indicate which privileges and above can admin control digital output (capability.ndo > 0) privilege_camctrl view, operator, Indicate which privileges and above can admin control PTZ (capability.ptzenabled > 0 or capability.eptz >...
  • Page 149 VIVOTEK Otherwise, the service may fail. Stopped service will auto-start after changing port settings. Change HTTP port from 80 to 5556, and change RTP port for video from 5556 to 20480. Then, set preprocess=9 to stop both service first. ”/cgi-bin/admin/setparam.cgi? network_preprocess=9&network_http_port=...
  • Page 150 VIVOTEK integer> ca_size 0,<positive CA file size (in bytes) integer> certificate_exist <boolean> Certificate installed flag (for TLS) certificate_time 0,<positive Certificate installed time. Represented in integer> EPOCH certificate_size 0,<positive Certificate file size (in bytes) integer> privatekey_exist <boolean> Private key installed flag (for TLS) privatekey_time 0,<positive...
  • Page 151 VIVOTEK 7.6.3 IPV6 Subgroup of network: ipv6 (capability.protocol.ipv6 > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable IPv6. addonipaddress <ip address> IPv6 IP address. addonprefixlen 0~128 IPv6 prefix length. addonrouter <ip address> IPv6 router address. addondns <ip address> IPv6 DNS address.
  • Page 152 VIVOTEK 7.6.6 HTTPS port Subgroup of network: https (capability.protocol.https > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 443, 1025 ~ 65535 HTTPS port. 7.6.7 RTSP Subgroup of network: rtsp (capability.protocol.rtsp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 554, 1025 ~ 65535 RTSP port.
  • Page 153 VIVOTEK metadataport 1026~65534 Multicast metadata port. 1 ~ 255 Multicasttime to live value. 7.6.8 SIP port Subgroup of network: sip (capability.protocol.sip> 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 1025 ~ 65535 SIP port. 7.6.9 RTP port Subgroup of network: rtp...
  • Page 154 VIVOTEK 7.7IP Filter Group: ipfilter NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable access list filtering. admin_enable <boolean> Enable administrator IP address. admin_ip string[43] Administrator IP address. maxconnection 1~10 Maximum number of concurrent streaming connection(s). type 0, 1 Ipfilter policy : 0 =>...
  • Page 155: Video Input

    VIVOTEK 7.8Video input Group: videoin NAME VALUE SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 CMOS frequency. (capability.videoin.type=2) whitebalance auto, Modes of white balance. <product dependent> manual, "auto": Auto white balance "rbgain": Use rgain and bgain to set white rbgain, widerange, balance manually.
  • Page 156 VIVOTEK 8: EV +0.7 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.0 irismode fixed, indoor, Control DC-Iris mode. outdoor "outdoor": Auto-setting DC-Iris to get best <product quality, but easy to meet rolling or flicker effect independent>...
  • Page 157 VIVOTEK Bit 5 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only) text string[64] Enclose caption. imprinttimestamp <boolean> Overlay time stamp on video. minexposure <1~32000>, Minimum exposure time <product dependent> <5~32000>, 1~32000 => 1s ~ 1/32000s <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>,...
  • Page 158 VIVOTEK "capability_image_c<n>_exposure_rangetyp e" is "twovalues". enablepreview <boolean> Usage for UI of exposure settings. Preview settings of video profile. 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"...
  • Page 159 VIVOTEK 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c<n>_wbmode". * Only valid when "videoin_c<n>_whitebalance" != auto * Normalized range. bgain 0~100 Manual set bgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain"...
  • Page 160 VIVOTEK "capability_image_c<n>_exposure_m Gain. odetype") "irispriority": Adjust with variable Iris, auto Gain and Shutter speed. "manual": Adjust with variable Shutter, Iris and Gain. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. irismode fixed, indoor, outdoor Control DC-Iris mode.
  • Page 161 VIVOTEK ortype" is "smartsensor" * Only available when "capability_image_c<n>_iristype"=pi enableblc <boolean> Enable backlight compensation <Not support * Not support this parameter anymore anymore> when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c<n>_mode" to switch on/off BLC.
  • Page 162 VIVOTEK * Only available when "capability_image_c<n>_agc_maxgai n" != "-" and "capability_image_c<n>_exposure_ra ngetype" is "onevalue". * Normalized range. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. color 0, 1 0 =>monochrome 1 => color flip <boolean>...
  • Page 163 VIVOTEK textonvideo_fon /usr/share/font/Default.ttf, Choose camera default font file tpath /mnt/flash2/upload.ttf (/usr/share/font/Default.ttf) or user uploaded font file(/mnt/flash2/upload.ttf). textonvideo_upl Depends on the font file name Show the uploaded font file name. oadfilename uploaded by user minexposure <1~32000>, Minimum exposure time <product <5~32000>, 1~32000 =>...
  • Page 164 VIVOTEK * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<n>_exposure_ra ngetype" 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 165 VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0302a. s<0~(m-1)>_e <boolean> Indicate whether stream supprts eptz nableeptz or not s<0~(m-1)>_c Listed at "capability_videoin_codec" Codec type for this stream odectype Possible values are: mjpeg, h264,h265 <product dependent>...
  • Page 166 VIVOTEK directly. * Only valid when "ratecontrolmode"= vbr and s<0~(m-1)>_h264_quant = s<0~(m-1)>_h 1~100 Select customized quality in a 264_qpercent normalized full range. 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"= vbr and "quant"= 100. The maximum allowed bit rate in fixed  s<0~(m-1)>_h 20000~"capability_videoin_c<n>_h2 "...
  • Page 167 VIVOTEK cbr and "quant"= 100. * Only available when "capability_smartstream_version"=2.   s<0~(m-1)>_h 20000~"capability_videoin_c<n>_h2 The target bit rate in constant bit rate 264_bitrate 64_maxbitrate" mode. *  Only valid when "ratecontrolmode"=   s<0~(m-1)>_h framerate,imagequality Set prioritypolicy 264_prioritypoli *  Only valid when "ratecontrolmode"=  ...
  • Page 168 VIVOTEK * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_h 1~5, Set the pre-defined quality level: 265_quant 99, 100 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue"...
  • Page 169 VIVOTEK * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~5, 100 Set the pre-defined quality level: 265_cbr_quant 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent"...
  • Page 170 VIVOTEK 265_prioritypoli * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~"capability_videoin_c<n>_h265_m The maximum frame rates of a H265 265_maxframe axframerate" stream at different resolutions("capability_videoin_c0_re solution ") are recorded in "capability_videoin_c<n>_h265_maxf ramerate" * Only available when h265 is listed in "capability_videoin_codec".
  • Page 171 VIVOTEK ex: 0301a_1) * Only valid when "ratecontrolmode"= or 1~99 vbr and s<0~(m-1)>_mjpeg_quant = (Only valid when "capability_api_httpversion" format is XXXXX_2, ex: 0301a_2) <product dependent> s<0~(m-1)>_m 1~100 Select customized quality in a jpeg_qpercent normalized full range. 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"=...
  • Page 172 VIVOTEK 100: Best quality * Only valid when "ratecontrolmode"= cbr and "quant"= 100. * Only available when "capability_smartstream_version"="2 .0" s<0~(m-1)>_m 20000~"capability_videoin_c<n>_mj The target bit rate in constant bit rate jpeg_bitrate peg_maxbitrate" mode. * Only valid when "ratecontrolmode"= s<0~(m-1)>_m framerate,imagequality Set prioritypolicy jpeg_prioritypoli * Only valid when "ratecontrolmode"=...
  • Page 173 VIVOTEK * Only available when "capability_image_c<n>_wdrc_mode " is 1 aespeed_mode <boolean> Turning AE converge speed on or off.   <product 0: off dependent> 1: on * Only available when "capability_image_c<n>_aespeed" is aespeed_speedl 1~100 The speed level of AE converge speed.
  • Page 174 VIVOTEK     mounttype ceiling, wall, floor wall mount: 180° panoramic view <product ceiling mount: 360° surround view dependent> without blind spots floor mount: 360° surround view without blind spots * Only available when "capability_fisheye" > 0   enablewatermar 0, 1...
  • Page 175 VIVOTEK the regions of interest (ROI) and the areas of non-interest (non-ROI) of the display image. If the value is a positive number, the video quality of ROI is better than the non-ROI areas. The level is from 1 to 5.
  • Page 176 VIVOTEK 7.8.1.1 Alternative video input profiles per channel In addition to the primary setting of video input, there can be alternative profile video input setting for each channel which might be for different scene of light (daytime or nighttime). Group: videoin_c<0~(n-1)>_profile_i<0~(m-1)> for n channel profucts and m profile n denotes the value of "capability_nvideoin"...
  • Page 177 VIVOTEK * Available value is listed in * This parameter may also restrict image "capability_image_c frame rate from sensor due to sensor <n>_exposure_ma generates a frame per exposure time. Ex: If xrange" this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.
  • Page 178 VIVOTEK <Not support anymore> * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c<n>_mode" to switch on/off BLC. exposurelevel 0~12 Exposure level "0,12": This range takes the concept from DC's exposure tuning options.
  • Page 179 VIVOTEK widerange, balance manually. outdoor, "manual": 2 cases: indoor, a. if "rbgain" is not supported, this means sodiumauto, keep current white balance status. b. if "rbgain" is supported, "rgain" and "bgain" are updated to the current values (Available values are which is got from white balance module.
  • Page 180 VIVOTEK "irismode"=fixed * Normalized range. * Only available when "capability_image_c<n>_exposure_rangetyp e" is "twovalues". mingain 0~100 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<n>_agc_mingain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range.
  • Page 181 VIVOTEK "capability_image_c<n>_iristype"=piris piris_position 1~100 Manual set P-Iris. <product dependent> 1: Open <-> 100: Close * Only vaild when "piris_mode"=manual or "capability_image_c<0~(n-1)>_sensortype" is "smartsensor" * Only available when "capability_image_c<n>_iristype"=piris irismode fixed, indoor, Control DC-Iris mode. "outdoor": Auto-setting DC-Iris to get best outdoor <product...
  • Page 182 VIVOTEK "capability_image_c<n>_aespeed" is 1 aespeed_speedlevel 1~100 The speed level of AE converge speed.   <product dependent> 1~20: level 1 21~40: level 2 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher speed level meas shorter AE converged time during AE executing.
  • Page 183 VIVOTEK 7.9Time Shift settings Group: timeshift for n channel profucts and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" (capability.timeshift > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable time shift streaming. c<0~(n-1)>_s<0~(m-1) <boolean>...
  • Page 184 VIVOTEK capability_daynight There are two value format: _c<n>_ircutsensitiv "low,normal,high": if ity_type=options) capability_daynight_c<n>_ircutsensitivity_ty pe=options 1~100 (if capability_daynight "1~100": if _c<n>_ircutsensitiv capability_daynight_c<n>_ircutsensitivity_ty ity_type=normalize pe=normalize 7.11 Image setting per channel Group: image_c<0~(n-1)> for n channel profucts and m profile n denotes the value of "capability_nvideoin" and m denotes the value of "capability_nvideoinprofile"...
  • Page 185 VIVOTEK <Not recommended to use this> 100: Use " image_c<n>_saturationpercent" * Only available when bit 2 of "capability_image_c<n>_basicsetting" is 1. * We replace "saturation" with "saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
  • Page 186 VIVOTEK "capability_image_c<n>_basicsetting" is 1 gammacurve 0~100 0: Fine-turned gamma curve by Vivotek. 1: Gamma value = 0.01 2: Gamma value = 0.02 3: Gamma value = 0.03 100: Gamma value = 1 * Note: Although we set gamma value to 100 level, but not all gamma values are valid.
  • Page 187 VIVOTEK dis_mode <boolean> Digital image stabilizer <product dependent> 0:disable 1:enable * Only available when 'dis' is listed in "capability_image_c<n>_is_mode". dis_strength 1~100 Strength of digital image stabilizer <product dependent> * Only available when 'dis' is listed in "capability_image_c<n>_is_mode". scene_enable <boolean> Enable/disable scene mode <product dependent>...
  • Page 188 VIVOTEK "capability_image_c<n>_basicsetting" is 1 * We replace "profile_i0_brightness" with "profile_i0_brightnesspercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. profile_i<0~(m-1)>_contrast -5~5,100 -5: Less contrast <-> 5: More contrast <Not recommended to use this>...
  • Page 189 0: Softer <-> 100: Sharper * Only available when bit 3 of "capability_image_c<n>_basicsetting" is 1 profile_i<0~(m-1)>_gammacur 0~100 0: Fine-turned gamma curve by Vivotek. 1: Gamma value = 0.01 2: Gamma value = 0.02 3: Gamma value = 0.03 100: Gamma value = 1 * Note: Although we set gamma value to 100 level, but not all gamma values are valid.
  • Page 190 VIVOTEK profile_i<0~(m-1)>_dnr_stren 1~100 Strength of 3DNR * Only available when <product dependent> "capability_image_c<n>_dnr" is 1 profile_i<0~(m-1)>_defog_mo <boolean> Enable/disable defog mode. 0:disable <product dependent> 1:enable * Only available when "capability_image_c<n>_defog_mode" is 1 profile_i<0~(m-1)>_defog_str 1~100 Strength of defog ength * Only available when <product dependent>...
  • Page 191 VIVOTEK 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<n>_exposure_mode"=1) NAME VALUE SECURITY DESCRIPTION (get/set) "auto": Use full image view as the only mode auto, custom,blc exposure window.
  • Page 192 VIVOTEK sizepx <0~Wx0~ H> Width and height of the window. W: 0~ The current image width -1 * Only available when px is listed in H: 0~ The current image height -1 "capability_image_c<n>_exposure_windomai n". homestd <0~9999,0~9999> Left-top corner coordinate of the window.
  • Page 193 VIVOTEK 1: Indicate inclusive. * Only available when exclusive is listed in "capability_image_c<n>_exposure_wintype". home <0~320,0~240> Left-top corner coordinate of the window. * Only available when qvga is listed in "capability_image_c<n>_exposure_windomai n". size <0~320x0~240> Width and height of the window. * Only available when qvga is listed in "capability_image_c<n>_exposure_windomai...
  • Page 194 VIVOTEK 7.13 Audio input per channel Group: audioin_c<0~(n-1)> for n channel products (capability.naudioin>0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) source micin, linein micin => use built-in microphone input. <Not recommended to use <product linein => use external microphone input.
  • Page 195 VIVOTEK external microphone (The related bit of "capability_audio_extmic" is equal to 1). mute 0, 1 0: Mute off 1: Mute on gain 0~100 Gain of input. <Not recommended to use (audioin_c<0~(n-1)>_source = linein) this> * Reserved for compatibility, and suggest don't use this since the version number (httpversion) is equal or greater than 0301a.
  • Page 196 VIVOTEK 5150, 5900, * Only available if AMR is supported. 6700, 7400, 7950, 10200, 12200 s0_g711_mode pcmu, Set G.711 companding algorithm. pcma pcmu: µ-law algorithm pcma: A-law algorithm * Only available if G.711 is supported. s0_g726_bitrate 16000, Set G.726 encoded bitrate in bps.
  • Page 197: Motion Detection Settings

    VIVOTEK profile_i0_alarm_level 1~100 Audio detection alarm level 7.14 Motion detection settings Group: motion_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable motion detection. win_sensitivity 0 ~ 100 Sensitivity of all motion detection windows.
  • Page 198 VIVOTEK   image width -1 H: 0~ The current * Only available when px is listed in image height -1 "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 199 VIVOTEK version number (httpversion) is equal or greater than 0400a. width 0 ~ 320 Width of motion detection window. <Not recommended to use * Only available when   this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain".
  • Page 200 VIVOTEK * The value "0" is reserved for compatibility and will not be used after the version number (httpversion) is equal or greater than 0400a.   Group: motion_c<0~(n-1)>_profile_i<0~(m-1)>_win_i<0~(k-1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the vaule of "capability_nmotionprofile", k denotes the value of "capability_nmotion".
  • Page 201 VIVOTEK polygon 0 ~ 320,0 ~ 240, 0 Coordinate of polygon window position.   <Not recommended to use ~ 320,0 ~ 240, 0 ~ (4 points: x0,y0,x1,y1,x2,y2,x3,y3) this> 320,0 ~ 240, 0 ~ * Only available when 320,0 ~ 240 "capability_motion_wintype"...
  • Page 202 VIVOTEK * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. height 0 ~ 240 Height of motion detection window. <Not recommended to use * Only available when  ...
  • Page 203 VIVOTEK "threshold" for more than "duration" second(s), then image too bright detection is triggered. blurry_enable <boolean> Enable or disable image too blurry detection blurry_threshold 0~100 Threshold of image too blurry detection blurry_duration 1~10 If image too blurry value exceeds the "threshold"...
  • Page 204 VIVOTEK 7.17 Express link Group: expresslink PARAMETER VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable express link. state onlycheck, Camera will check the status of network onlyoffline, environment and express link URL checkonline, badnetwork string[64] The url user define to link to camera 7.18 UPnP presentation...
  • Page 205: System Log

    VIVOTEK 7.20 System log Group: syslog NAME VALUE SECURITY DESCRIPTION (get/set) enableremotelog <boolean> Enable remote log. serverip <IP address> Log server IP address. serverport 514, 1025~65535 Server port used for log. level Levels used to distinguish the importance of the information:...
  • Page 206 1 => Default logo logo_link string[128] Hyperlink of the logo http://www.vivotek. logo_powerbyvvtk_hidden <boolean> 0 => display the power by vivotek logo 1 => hide the power by vivotek logo custombutton_manualtrig <boolean> Show or hide manual trigger (VI) button in ger_show homepage 0 ->...
  • Page 207: Privacy Mask

    VIVOTEK round theme_color_videobackgr string[7] Background color of video area. ound theme_color_case string[7] Frame color 7.23 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"...
  • Page 208 VIVOTEK "capability_image_c<n>_privacymask_windomai win_i<0~(m-1)>_polygonpx 0 ~ W,0 ~ H, 0 Coordinate of polygon window position. ~ W,0 ~ H, 0 (4 points: x0,y0,x1,y1,x2,y2,x3,y3) ~ W,0 ~ H, 0 * Only available when ~ W,0 ~ H "capability_image_c<n>_privacymask_wintype" W: 0~ The = polygon.
  • Page 209 VIVOTEK 7.24 3D Privacy mask Group: privacymask3d_c<0~(n-1)> for n channel products and m privacy mask window. (capability_image_c<0~(n-1)>_privacymask_wintype = 3Drectangle) n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable the 3D privacy mask color 0~"...
  • Page 210 NAME VALUE SECURITY DESCRIPTION (get/set) api_httpversion <string> The version of VIVOTEK WebAPI with 4 This number start integers plus 1 alphabet, There are composed with 0301a. by "major version", "minor version", "revision","_platform". ex: 0301a_1 Major version Increase the major version when change,...
  • Page 211 VIVOTEK document. The 5th character is model-based version for API bug-fix and it's default to "a". Ex: If some APIs in a model does not follow the API definition of 0301a_1, we will fix them and change this API value to 0301b_1.
  • Page 212 VIVOTEK More details, please refer the parameter description of "volume_internal" and "volume_external". nuart Number of UART interfaces. <positive integer> nmotion <positive integer> The number of motion window. nmotionprofile 0, <positive Number of motion profiles. integer> ptzenabled 0, <positive An 32-bit integer, each bit can be set integer>...
  • Page 213 VIVOTEK it means that the camera supports remotefocus function. bit 0 => Indicate whether to support both zoom and focus function. bit 1 => Only support zoom function. bit 2 => Only support focus function. bit 3 => Currently, this is a reserved bit, and the default value is 0.
  • Page 214 VIVOTEK channel support ePTZ or not, and so on. * For most products, the last stream of a channel will not support ePTZ. It is reserved for full view of the channel. For some dual-stream products, both streams support ePTZ.
  • Page 215 VIVOTEK "visignal" = Video input signal loss. "backup" = Backing up recorded files * Only available when [httpversion] >= 0301a storage_dbenabled <boolean> Media files are indexed in database. protocol_https < boolean > Indicate whether to support HTTP over SSL. protocol_rtsp <...
  • Page 216 VIVOTEK dependent> * This is kept for compatibility. videoin_maxframerate A list of <Integer> This equals "capability_videoin_c0_maxframerate". * This is kept for compatibility. videoin_mjpeg_maxframe A list of <Integer> This equals rate and "-" "capability_videoin_c0_mjpeg_maxframerate ". * This is kept for compatibility.
  • Page 217 VIVOTEK "videoout_codec"=ntsc "nvideoout"=1 with PAL, "videoout_codec"=pal "nvideoout"=2 with both NTSC, "videoout_codec"=ntsc,ntsc * For camera, this feature is controlled by physical jump on device. No WebAPI to control it. This value is set only on camera power-on and maintains the status.
  • Page 218 VIVOTEK audio_lineout <boolean> Indicate whether to support line output. audio_michardwareswitch <boolean> Indicate whether the hardware supports built-in/external mic switch audio_headphoneout <boolean> Indicate whether to support headphone <Not support anymore> output. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.
  • Page 219 VIVOTEK std: A normalized 0~9999 range. -: Not supported. *only available when "capability_smartstream_support" is 1 smartstream_mode_autot <boolean> Indicate whether autotracking smart stream is racking supported. *only available when "capability_smartstream_support" is 1 smartstream_mode_man <boolean> Indicate whether manual smart stream is supported.
  • Page 220 VIVOTEK Bit 6 => Support shared memory API Bit 7 => Support digital signature of package Bit 8 => Support snapshot vadp_npackage <positive integer> Indicate the maximum number of VADP package that can be uploaded to the device. thermal_support <boolean>...
  • Page 221 VIVOTEK * This is kept for compatibility. uart_httptunnel <boolean> Indicate whether to support HTTP tunnel for UART transfer. transmission_mode Indicate transmission mode of the machine: TX = server, Rx = receiver box, Both = DVR. Both network_wire <boolean> Indicate whether to support Ethernet.
  • Page 222 VIVOTEK media_videoclip_maxpree <positive integer> Maximum duration (second) after event vent occurred in a videoclip. image_iristype <string> Indicate iris type. <Not recommended to use "piris": P-Iris  this> "dciris": DC-Iris  "-": No Iris control support  * When "capability_iris"=0, this value must be "-".
  • Page 223 VIVOTEK localstorage_slconnum 0,<positive integer> The maximum seamless connection number. localstorage_smartsd <boolean> The "Lifetime and Log SD Card" feature allows users to obtain the card's remaining lifetime information. 0: Non-support this feature 1: Support this feature * Only Sony SD card can support this function now.
  • Page 224 VIVOTEK buildinpt <boolean> An 32-bit integer, each bit can be set separately as follows: Bit 0 => support build-in pan Bit 1 => support build-in tilt zoommodule <boolean> Indicate whether to support zoom lens. In our product, only SD series and IZ series use the zoom lens.
  • Page 225 VIVOTEK ptz_maxpanangle <integer> The upper limit for pan angle. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" ptz_tiltspeedlv 0, <positive integer> 0/7 The maximum speed level of tilt motion. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" ptz_mintilt 0, <positive integer> 0/7 The lower limit for tilt position.
  • Page 226 VIVOTEK ptz_focusspeedlv 0, <positive integer> 0/7 The maximum speed level of focus motion. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule" is "1" ptz_minfocus 0, <positive integer> 0/7 The lower limit for focus position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule"...
  • Page 227 VIVOTEK ircutsensitivity_type <string> Indicate the cgi interface of "ircutcontrol_sensitivity". "options": the value of "ircutcontrol_sensitivity" parameter is "low, normal,high". "normalize": the value of "ircutcontrol_sensitivity" parameter is "1~100" * Only available when "capability_daynight_c<n>_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 228 VIVOTEK streamcodec <positive integer> Represent supported codec types of each stream. This contains a list of positive integers, split by comma. Each one stands for a stream, and the definition is as following: Bit 0: Support MPEG4. Bit 1: Support MJPEG Bit 2: Support H.264...
  • Page 229 VIVOTEK mjpeg_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer> and "-" MJPEG on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution"...
  • Page 230 VIVOTEK h264_maxbitrate <positive integer> Maximum bitrates of H.264. The unit is bps. * Only available when 'h264' is listed in "capability_videoin_codec". h265_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer> and "-" H.265 on resolutions in current video mode.
  • Page 231 VIVOTEK cameraunit_name CU8131, A "camera unit" name of a split-type camera CU8171, system, which the camera unit and the video CU8161-H, core are separated. CU8162-H, -: If the camera is not a split-type camera CU8163-H, system, the value of this parameter is "-".
  • Page 232 VIVOTEK effectivepixel <WxH> The visible area of full scene in this video mode. The unit is pixel in source. * If "effectivepixel"<"capability_videoin_c<n>_max size", then the visible area is located at the center of full scene. outputsize <WxH> The output size of source, equal to the captured size by device, in this video mode.
  • Page 233 VIVOTEK maxframerate A list of <Positive Indicates frame rate that the video source Integer> outputs in this video mode. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group.
  • Page 234 VIVOTEK maxfps_h265 A list of <Positive Maximum fps which the device can encoded with Integer> and "-" H.265 on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution"...
  • Page 235 VIVOTEK number indicate the support strength level of WDR Pro, and the scecond number indicate the support strength level of WDR Pro II. wdrpro_affect When WDR Pro or WDR Enhanced is exposurewin.mode:fixed:au enabled, some features may become malfunction or be forced to a given exposurewin.mode.blc:disab...
  • Page 236 VIVOTEK wdrpro_description <string> Description about WDR Pro mode. * Only available when "capability_image_c<0~(n-1)>_wdrp ro_mode" > 0       wdrc_mode 0, 1 0: Non-support WDR Enhanced 1: Support WDR Enhanced   wdrc_supportlevel 0, <positive integer> Indicate the support strength level of WDR Enhanced.
  • Page 237 VIVOTEK "-" means no feature is affected. * When "wdrpro"=0 and "wdrc"=0, this must be "-"         0: Non-support 3D digital noise reduction 1: Support 3D digital noise reduction   0: Non-support electronic image stabilizer 1: Support electronic image stabilizer...
  • Page 238 VIVOTEK minexposure:hidden:, features may become malfunction or mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here. 3dnr:unchanged:, or others The format is "Affect API name":"Policy":"Value" <x>: nonnegative integer <product dependent> "Policy" can be categorized into...
  • Page 239 VIVOTEK 1: Support scene mode scenemode_supporttype visibility, list all the scene mode which are <product dependent> noiseless, supported in the camera. lpcparkinglot, lpcstreet * Only available when <product dependent> "capability_image_c<n>_ scenemode_support" is 1 scenemode_visibility_affe When scene mode is enabled, some...
  • Page 240 VIVOTEK "-" means no feature is affected. * Only available when visibility is listed in "capability_image_c<n>_ scenemode_supporttype" and "capability_image_c<n>_ scenemode_support" is 1 scenemode_noiseless_aff When scene mode is enabled, some minexposure:hidden:, features may become malfunction or <product dependent> mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here.
  • Page 241 VIVOTEK * Only available when visibility is listed in "capability_image_c<n>_ scenemode_supporttype " and "capability_image_c<n>_ scenemode_support" is 1 scenemode_lpcparkinglot When scene mode is enabled, some _affect minexposure:hidden:, features may become malfunction or <product dependent> mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here.
  • Page 242 VIVOTEK in "capability_image_c<n>_ scenemode_supporttype " and "capability_image_c<n>_ scenemode_support" is 1 scenemode_lpcstreet_aff When scene mode is enabled, some minexposure:hidden:, features may become malfunction or <product dependent> mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here. 3dnr:unchanged:,or others The format is "Affect API...
  • Page 243 VIVOTEK scenemode_supporttype " and "capability_image_c<n>_ scenemode_support" is 1     wbmode auto, Available white balance mode. manual, "-" means white balance is not rbgain, supported.   widerange, outdoor,indoor, sodiumauto, <product dependent>   iristype   piris,   Indicate iris type. dciris, "piris": P-Iris...
  • Page 244 VIVOTEK or greater than 0302a. exposure_shuttervaluetyp fixed, * One to one mapping to the mode maximum, type in "exposure_modetype". "fixed": The shutter value is the assigned value (videoin_c<n>_shuttervalue). "maximum": The shutter value can be up to the assigned value (videoin_c<n>_shuttervalue).
  • Page 245 VIVOTEK name":"Policy":"Value" <x>: nonnegative integer <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden.
  • Page 246 VIVOTEK wdrpro:disabled:, here. exposurelevel:hidden:, or others The format is "Affect API name":"Policy":"Value" <x>: nonnegative integer <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it.
  • Page 247 VIVOTEK e_affect exposurewin.mode.blc:hidd some features may become en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here. exposurelevel:hidden:, or others The format is "Affect API name":"Policy":"Value" <x>: nonnegative integer <product dependent> "Policy" can be categorized into...
  • Page 248 VIVOTEK version number (httpversion) is equal or greater than 0302a. exposure_manualmode_a When exposure mode is enabled, ffect exposurewin.mode.blc:hidd some features may become en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here. exposurelevel:hidden:, or others The format is "Affect API...
  • Page 249 VIVOTEK "capability_image_c<n>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_levelrange     Available range for "0,12"   "videoin_c<n>_exposurelevel" * When "exposure_mode"=0, this must be set to "-".  ...
  • Page 250 VIVOTEK 0301a A list of <Positive Integer> exposure_pal_totalrange Available total range for PAL analog output * Only available when [httpversion] >=  0301a exposure_maxrange   "1,32000",   Available range for "1,8000", "videoin_c<n>_maxexposure" "1,32000" => 1s ~ 1/32000s or others   "1,8000" => 1s ~ 1/8000s <product dependent>   etc. "-" means maximum exposure time is not available.
  • Page 251 VIVOTEK privacy mask. agc_maxgain   "0,100",   Available range for "-"   "videoin_c<n>_maxgain" “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  ...
  • Page 252 VIVOTEK which means exposurelevel is fixed to level 6. "Value" can be a nonnegative integer or NULL. "-" means no feature is affected. * When "flickerless" = 0, this must be "-" defog_mode 0: Non-support defog 1: Support defog defog_strength...
  • Page 253 VIVOTEK selections or values. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6.
  • Page 254 VIVOTEK both zoom and focus function. bit 1 => Only support zoom function. bit 2 => Only support focus function. bit 3 => Currently, this is a reserved bit, and the default value is 0. focuswindomain qvga, px, std, - The domain to set an focus window.
  • Page 255: Event Setting

    VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) waterspray_support <boolean> 0: Non-support water spray feature 1: Support water spray feature * We support this parameter when the version number (httpversion) is equal or greater than 0302a. wiper_support <boolean> 0: Non-support wiper feature...
  • Page 256 VIVOTEK 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 tampering, “visignal” = Video input signal loss. “recnotify” = Recording notification.
  • Page 257 VIVOTEK vadp 0,<positive integer> Indicate the source id of vadp event notification. <product dependent> Each bit corresponds to one vadp source, and the LSB indicates source id 0. For example, to detect event from any one of source id 0, 1 and 3, set vadp to 11.
  • Page 258 VIVOTEK action_cf_media NULL, 0~4,101 Index of the attached media. 101 means “Recording Notify” action_cf_datefolder <boolean> Enable this to create folders by date, time, and hour automatically. action_cf_backup <Boolean> Enable or disable the function that send media to SD card for backup if network is disconnected.
  • Page 259 VIVOTEK 7.28 Server setting for event action Group: server_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry type email, Indicate the server type: ftp, “email” = email server http, “ftp” = FTP server “http” = HTTP server “ns”...
  • Page 260 VIVOTEK 7.29 Media setting for event action Group: media_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry type snapshot, Media type to send to the server or systemlog, store on the server. videoclip, recordmsg snapshot_source 0~"capability_nmediastream -1"...
  • Page 261 VIVOTEK videoclip_maxduration 1 ~ " Maximum duration of one video clip in capability_media_videoclip_maxlen seconds. gth" videoclip_maxsize 50 ~ " Maximum size of one video clip file in capability_media_videoclip_maxsiz Kbytes. e" 7.30 Recording Group: recording_i<0~1> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry.
  • Page 262 VIVOTEK limitsize <boolean> 0: Entire free space mechanism 1: Limit recording size mechanism cyclic <boolean> 0: Disable cyclic recording 1: Enable cyclic recording notify <boolean> 0: Disable recording notification 1: Enable recording notification notifyserver 0~31 Indicate which notification server is scheduled.
  • Page 263 VIVOTEK dest The destination to store the recorded data. “cf” means local storage (CF or SD card). “0” means the index of the network storage. cffolder string[128] Folder name. maxsize 100~2000 Unit: Mega bytes. When this condition is reached, recording file is truncated.
  • Page 264 State or province name in the certificate information. localityname string[128] The locality name in thecertificate information. organizationname string[64] Organization name in the certificate VIVOTEK Inc. information. unit string[64] Organizational unit name in thecertificate VIVOTEK Inc. information. commonname string[64] Common name in the certificate information.
  • Page 265 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) enabled <boolean> Enable automatic clean up method. Expired and not locked media files will be deleted. maxretentiontime_recordin <boolean> Enable automatic clean up method for video clip g_enabled generated by recording task. The parameter takes effect when autocleanup_enabled is enabled.
  • Page 266: Region Of Interest

    VIVOTEK maxretentiontime_others_ <string> To specify the expired time for automatic clean maxage up, and it takes effect for all media files except media files generated by recording task. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss]S’ , similar with ISO8601 with symbols P Ex. P7D, it means 7 days. P1DT10H, it means 1 days and 10 hours.
  • Page 267: Eptz Setting

    VIVOTEK 7.34 ePTZ setting Group: eptz_c<0~(n-1)> for n channel product. (capability.eptz > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) osdzoom <boolean> Indicates multiple of zoom in is “on-screen <Not recommended to use display” or not. this> * Reserved for compatibility, and suggest don't use this since [httpversion] >...
  • Page 268 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) patrolseq string[120] The patrol sequence of ePTZ. All the patrol position indexes will be separated by "," patroldwelling string[160] The dwelling time (unit: second) of each patrol point, separated by “,”. preset_i<0~19>_name string[40] Name of ePTZ preset.
  • Page 269 (Read only) guid<0~2>_id string[127] The connected seamless streaming ID. (Read only) guid<0~2>_number Number of connected seamless streaming with guid<0~2>_id. (Read only) 7.37 VIVOTEK Application Development Platformsetting Group: vadp NAME VALUE SECURITY DESCRIPTION (get/set) version <string> Indicate the VADP version.
  • Page 270 Indicate the message that will be show on the running status when mouse over. vvtklicensemec string[40] Indicate the module use VIVOTEK license mechanism Group: vadp_schedule_i<0~(n-1)> for n VADP package number n denotes the value of "capability_vadp_npackage". (Only available when capability_vadp_npackage > 0 and the version number of "vadp_version" is equal or greater than 1.3.2.0)
  • Page 271 VIVOTEK control the execution of the VADP package begintime hh:mm Begin time of the schedule endtime hh:mm End time of the schedule Group: vadp_event NAME VALUE SECURITY DESCRIPTION (get/set) ntrigger 0,<positive integer> Indicate the number of topics to be transferred to event manager for trigger.
  • Page 272 VIVOTEK cameraid 0~255 Camera ID controlling external PTZ camera. isptz 0 ~ 2 0: disable PTZ commands. 1: enable PTZ commands with PTZ driver. 2: enable PTZ commands with UART tunnel. * Only available when bit7 of capability_ptzenabled is 1 disablemdonptz <boolean>...
  • Page 273 VIVOTEK >_mintilt ~ capability_ptz_c<0~(n-1) >_maxtilt preset_i<0~(k-1)>_zoom capability_ptz_c<0~(n-1) Zoom position at each preset location. >_minzoom ~ capability_ptz_c<0~(n-1) >_maxzoom preset_i<0~(k-1)>_focus capability_ptz_c<0~(n-1) Focus position at each preset location. >_minfocus ~ capability_ptz_c<0~(n-1) >_maxfocus preset_i<0~(k-1)>_fliped <boolean> Flip side at each preset location. patrol_i<0~39>_name string[40] (For internal device) The name of patrol location patrol_i<0~39>_ dwelling...
  • Page 274 VIVOTEK digitalzoom <boolean> Enable/disable digital zoom idleaction_enable <boolean> Enable/disable idle action while idle idleaction_type pan,patrol,home,objtrack, This field tells what kind of action should prev be taken while idle. idleaction_interval 1~999 While idle over this time interval, idle action will be taken.
  • Page 275 VIVOTEK 7.40 UART control Group: uart (capability.nuart > 0 and capability.fisheye = 0) NAME VALUE SECURITY DESCRIPTION (get/set) ptzdrivers_i<0~19, string[40] Name of the PTZ driver. 127>_name ptzdrivers_i<0~19, string[128] Full path of the PTZ driver. 127>_location enablehttptunnel <boolean> Enable HTTP tunnel channel to control UART.
  • Page 276 VIVOTEK 7.41 UART control (SD series) Group: uart_i<0~(n-1)> n is uart port count (capability.nuart > 0 and the bit7 of capability_ptzenabled is 0, the bit4 of capability_ptzenabled is 1) NAME VALUE SECURITY DESCRIPTION (get/set) cameraid 1~255 Camera ID controlling external PTZ camera.
  • Page 277 VIVOTEK 7.42 Lens configuration Group: lens for n channel products n denotes the value of "capability_nvideoin" (capability.image.c<0~(n-1)>.lensconfiguration.support = 1) NAME VALUE SECURITY DESCRIPTION (get/set) selected <string> Current selected lens profile. e.g. lens_selected=lens_default_i0, it means choosen lens configuration is i0 lens of default group.
  • Page 278 VIVOTEK 7.43 Fisheye info Group: fisheyeinfo (capability.fisheye > 0) NAME VALUE SECURITY DESCRIPTION (get/set) revisedcenteraxis <coordinate> The actual center axis coordinate radius 0, <positive The actual center radius integer> 7.44 Fisheye local dewarp setting   Group: fisheyedewarp_c<0~(n-1)> (capability_fisheyelocaldewarp_c<0~(capability_nvideoin)-1> > 0)  ...
  • Page 279 VIVOTEK 7.45 PIR behavior define Group: pir (capability.npir > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable PIR 7.46 Auto tracking setting Group: autotrack (capbility_image_c<0~(capability_nvideoin)-1>_autotrack_support > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) objsize_type -1~2 Type of object size. -1 : customized width and height...
  • Page 280: Drive The Digital Output

    VIVOTEK 8. Useful Functions Drive the Digital Output (capability.ndo > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/setdo.cgi?do1=<state>[&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 281 VIVOTEK Query Status of the Digital Input(capability.ndi > 0) Note: This request requires Viewer privileges Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/getdi.cgi?[di0][&di1][&di2][&di3] If no parameter is specified, all of the digital input statuses will be returned. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <length>\r\n \r\n [di0=<state>]\r\n...
  • Page 282 VIVOTEK Query Status of the Digital Output (capability.ndo > 0) Note: This request requires Viewer privileges Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/getdo.cgi?[do0][&do1][&do2][&do3] If no parameter is specified, all the digital output statuses will be returned. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <length>\r\n \r\n [do0=<state>]\r\n...
  • Page 283: Capture Single Snapshot

    VIVOTEK 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. PARAMETER VALUE DEFA DESCRIPTION channel 0~(n-1) The channel number of the video source.
  • Page 284: Account Management

    VIVOTEK Account Management Note: This request requires Administrator privileges. Method: GET/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 285: System Logs

    VIVOTEK System Logs Note: This request require Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/syslog.cgi Server will return the most up-to-date system log. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <syslog length>\r\n \r\n <system log information>\r\n Upgrade Firmware Note: This request requires Administrator privileges.
  • Page 286 VIVOTEK ePTZ Camera Control (capability.eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eCamCtrl.cgi?channel=<value>&stream=<value> [&move=<value>] – Move home, up, down, left, right [&auto=<value>] – Auto pan, patrol [&zoom=<value>] –Zoom in, out [&zooming=<value>&zs=<value>] –Zoom without stopping, used for joystick [&x=<value>&y=<value>&w=<value>&h=<value>&resolution=<value>] - Zoom in, out on a specific area...
  • Page 287 VIVOTEK http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed. To stop a continuous movement, you have to use the command as below: http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zoom=stop&zs=0 2. [Area zoom]: it means to zoom in on a specific area, here is an example for a directly moving...
  • Page 288 VIVOTEK <integer> The direction of movement, used for joystick control. <integer> 0 ~ 7 Set the speed of movement, “0” means stop. <integer> x-coordinate clicked by user. It will be the x-coordinate of center after movement. <integer> y-coordinate clicked by user.
  • Page 289 VIVOTEK ePTZ Recall (capability.eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eRecall.cgi?channel=<value>&stream=<value>& recall=<value>[&return=<return page>] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source. stream <0~(m-1)> Stream. recall Text string less than 40 One of the present positions to recall.
  • Page 290 VIVOTEK 8.10 ePTZ Preset Locations(capability.eptz > 0 and capability_fisheye = 0) Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/ePreset.cgi?channel=<value>&stream=<value> [&addpos=<value>][&delpos=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source. stream <0~(m-1)> Stream. addpos <Text string less than Add one preset location to the preset list.
  • Page 291 VIVOTEK delv4 Delete IPv4 address from access list. delv6 Delete IPv6 address from access list. <IP address> Single address: <IP address> Network address: <IP address / network mask> Range address:<start IP address - end IP address> index <value> The start position to add or to delete.
  • Page 292 VIVOTEK 8.13 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 x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache...
  • Page 293 VIVOTEK 8.14 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 x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled...
  • Page 294 VIVOTEK 8.15 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” for setting the accessname of SDP.
  • Page 295 VIVOTEK 8.17 Senddata (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. number> data <hex decimal The <hex decimal data> is a series of digits from 0 ~ 9, A ~ F. Each data>[,<hex decimal...
  • Page 296 VIVOTEK 8.18 Storage managements (capability.storage.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> Required. Command to be executed, including search, insert, delete, update, and queryStatus.
  • Page 297 VIVOTEK 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. triggerTime <text> Optional. Indicate the event trigger time. (not the file created time) Format is “YYYY-MM-DD HH:MM:SS”...
  • Page 298 VIVOTEK Command: update PARAMETER VALUE DESCRIPTION label <integer primary key> Required. Identify the designated record. Ex. label=1 isLocked <boolean> Required. Indicate if the file is locked or not. Ex. Update records whose key numbers are 1 and 5 to be locked status.
  • Page 299 VIVOTEK 8.19 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 Setting virtual input 0 to trigger state Where "state" is 0, 1. “0”...
  • Page 300 VIVOTEK 8.20 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>&reftime=<v alue>&forcechk&minsft=<value>] For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player.
  • Page 301 VIVOTEK Return Code Description 400 Bad Request Request is rejected because some parameter values are illegal. 415 Unsupported Media Type Returned, if forcechk appears,when minsft is not achievable or the timeshift feature of the target stream is not enabled. User's Manual - 301...
  • Page 302 VIVOTEK 8.21 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] PARAMETER VALUE DESCRIPTION 302 - User's Manual...
  • Page 303 VIVOTEK function zoom, Function type focus, zoom - Move focus motor auto, focus – Move focus motor scan, auto – Perform auto focus scan – Perform focus scan stop, positioning, stop – Stop current operation getstatus positioning – Position the motors getstatus–Information of motors, return value as below:...
  • Page 304 VIVOTEK steps 1 ~ <motor_max> Motor’s moving steps. It works only if function=zoom | focus and direction=forward |   backward. <motor_max> is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from "function=getstatus" iris Open iris or not. It works only if function=auto | scan.
  • Page 305 VIVOTEK 8.22 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 - 305...
  • Page 306 VIVOTEK function focus, Function type auto, focus – Move focus motor scan, auto – Perform auto focus stop, scan – Perform focus scan stop – Stop current operation positioning, irisopen, positioning – Position the motors irisenable, resetfocus – reset focus position to default resetfocus, irisopen –...
  • Page 307 VIVOTEK steps 1 ~ <motor_max> Motor’s moving steps.   It works only if function=focus and direction=forward | backward. <motor_max> is refer to remote_focus_focus_motor_max which replied from "function=getstatus" iris Open iris or not. It works only if function=auto | scan. 8.23 Export Files Note: This request requires Administrator privileges.
  • Page 308 VIVOTEK 8.24 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 Post data: filename =<file name>\r\n \r\n <multipart encoded form data>...
  • Page 309 VIVOTEK 8.25 Update Lens Configuration Note: This request requires Administrator privileges. Method: GET Syntax: For list a name of lens currently used: http://<servername>/cgi-bin/admin/update_lens.cgi?get_currentlens For list all names of lens installed in camera: http://<servername>/cgi-bin/admin/update_lens.cgi?list_lens For choose selected lens configuration: http://<servername>/cgi-bin/admin/update_lens.cgi?choose_lens=<value> You need to reboot manually after you choose another lens configuration.
  • Page 310 VIVOTEK <multipart encoded form data> Server will accept the file named <file name> to upload the lens profile to camera. 8.26 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 311 VIVOTEK 8.27 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>] – Zoom wide, tele [[&speedpan=<value>][&speedtilt=<value>][&speedzoom=<value>]]...
  • Page 312 VIVOTEK zoom wide Zoom larger view with current speed. tele Zoom further with current speed. speedpan -5 ~ 5 Set the pan speed of current command. speedtilt -5 ~ 5 Set the tilt speed of current command. speedzoom -5 ~ 5 Set the zoom speed of current command.
  • Page 313 VIVOTEK 8.28 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>&name=<value>&[maskheight=<value>& maskwidth=<value>&videosize=<value>&return=<return page>] PARAMETER VALUE DESCRIPTION method Add a 3D privacy mask at current location delete...
  • Page 314: Camera Control

    VIVOTEK 8.29 Camera Control (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/camctrl.cgi?[channel=<value>][&camid=<value>] [&move=<value>] – Move home, up, down, left, right [&focus=<value>] – Focus operation [&auto=<value>] – Auto pan, patrol [&zoom=<value>] – Zoom in, out [&zooming=<value>&zs=<value>] – Zoom without stopping, used for joystick [&vx=<value>&vy=<value>&vs=<value>] –...
  • Page 315 VIVOTEK speedzoom -5 ~ 5 Set the zoom speed. speedfocus -5 ~ 5 Set the focus speed. speedapp -5 ~ 5 Set the auto pan/patrol speed. auto Auto pan. patrol Auto patrol. stop Stop camera. zoom wide Zoom larger view with current speed.
  • Page 316 VIVOTEK 8.30 Recall (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET Syntax: http://<servername>/cgi-bin/viewer/recall.cgi? recall=<value>[&channel=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION recall string[30] One of the present positions to recall. channel 0~(capability_nvideoin-1) Channel of the video source. return <return page>...
  • Page 317: Preset Locations

    VIVOTEK 8.31 Preset Locations (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/preset.cgi?[channel=<value>] [&addpos=<value>][&delpos=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION addpos string[30] Add one preset location to the preset list. channel 0~(capability_nvideoin-1) Channel of the video source. delpos string[30] Delete preset location from preset list.
  • Page 318 VIVOTEK 8.32 SmartSD (capability_localstorage_smartsd > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/smartsd.cgi?function=<value> 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...
  • Page 319: Technical Specifications

    All specifications are subject to change without notice. Copyright © VIVOTEK INC. All rights reserved. Ver. 7 6F, No.192, Lien- Cheng Rd., Chung-Ho, New Taipei Cit y, 235, Taiwan, R.O.C. T: +886-2-82455282 F: +886-2-82455532 E: sales@ vivotek.com W: w w w.vivotek.com...
  • Page 320: Technology License Notice

    VIVOTEK Technology License Notice AMR-NB Standard THIS PRODUCT IS LICENSED UNDER THE AMR-NB STANDARD PATENT LICENSE AGREEMENT. WITH RESPECT TO THE USE OF THIS PRODUCT, THE FOLLOWING LICENSORS’ PATENTS MAY APPLY: TELEFONAKIEBOLAGET ERICSSON AB: US PAT. 6192335; 6275798; 6029125; 6424938; 6058359. NOKIA CORPORATION: US PAT.
  • Page 321 取扱説明書に従って正しい取り扱いをして下さい 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:

Fd9381-htvFd9371-htvFd9381-ehtvFd9371-ehtv

Table of Contents