Vivotek FD8166A-N User Manual

Vivotek FD8166A-N User Manual

Ultra-mini dome network camera
Hide thumbs Also See for FD8166A-N:

Advertisement

Quick Links

FD8166A-N
User 's Manual
2MP • 940nm IR • Compact Design • PoE • Smart Stream II • SNV
Video Rotation • WDR Enhanced • 3DNR
Ultra-Mini Dome
Network Camera
Rev. 1.0

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the FD8166A-N and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Vivotek FD8166A-N

  • Page 1 FD8166A-N Ultra-Mini Dome Network Camera User ’s Manual 2MP • 940nm IR • Compact Design • PoE • Smart Stream II • SNV Video Rotation • WDR Enhanced • 3DNR Rev. 1.0...
  • Page 2: Table Of Contents

    Applications > Digital input ......................... 116 Applications > Tampering detection ......................117 Applications > Audio detection ........................118 Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) ..120 Recording > Recording settings ........................123 Local storage > SD card management ......................128 Local storage >...
  • Page 3: Overview

    Power over Ethernet (PoE) functionality, making setup both quick and simple. The FD8166A-N is also completely compatible with VIVOTEK’s VAST free 32-channel recording software. With all of these benefits and more, the FD8166A-N is a sure bet to fulfill your surveillance needs.
  • 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 ■ FD8166A-N ■ screws and anchors ■ Quick Installation Guide ■ Focus adjustment tool...
  • Page 5: Symbols And Statements In This Document

    VIVOTEK Symbols and Statements in this Document INFORMATION: provides important messages or advices that might help prevent inconvenient or problem situations. NOTE: Notices provide guidance or advices that are related to the functional integrity of the machine. Tips: Tips are useful information that helps enhance or facilitae an installation, function, or process.
  • Page 6: Hardware Installation

    VIVOTEK Hardware Installation 1. Jot down the camera's MAC address for later reference. XXXXXX 0002D10766AD Slide cover 1. Use one hand to hold the camera Semi-circular cut-out bottom and another hand to hold the dome cover. Press the release button.
  • Page 7 VIVOTEK Mounting the Network Camera - Ceiling or Wall Mount 4. Use the curved slots on the camera as a template to mark where holes will be drilled on the ceiling. Drill two holes into the ceiling; and hammer in the plastic anchors.
  • Page 8 VIVOTEK 8 - User's Manual...
  • Page 9 VIVOTEK 8. There is a tilt adjustment screw near the lens module. Use a #0, #1, or #2 Phillips screwdriver to turn the screw and the lens will move upwards or downwards. Lens UP Lens DOWN WARNING! Do not use your hands to tune the lens module's tilt angle. Doing so will damage the delicate tilt mechanism.
  • Page 10: Network Deployment

    VIVOTEK 8-1. You may also tune the camera's horizontal orientation by turning it along its curved screw slots. 8-2. Tighten the camera's mounting screws after you change the horizontal shooting direction. Network Deployment General Connection (without PoE) Power over Ethernet (PoE)
  • Page 11 VIVOTEK Internet connection via a router Before setting up the Network Camera over the Internet, make sure you have a router and follow the steps below. 1. Connect your Network Camera behind a router, the Internet environment is illustrated below. Regarding how to obtain your IP address, please refer to Software Installation on page 12 for details.
  • Page 12 For more information with network configuration options (such as that of streaming ports), please refer to Configuration > Network Settings. VIVOTEK also provides the automatic port forwarding feature as an NAT traversal function with the precondition that your router must support the UPnP port forwarding feature.
  • Page 13 VIVOTEK 6. Install the "Installation Wizard 2" software utility from your software CD. The program will search for VIVOTEK Video Receivers, Video Servers or Network Cameras on the same LAN. Double-click on the camera’s MAC address to open a browser management session with the camera.
  • Page 14 VIVOTEK LED Definitions Item LED status Description Steady Powered and system booting, or network failed LED off Power off Green LED off Network is disconnected Steady Green LED blinks every 1 Connected to network sec. Upgrading firmware Green LED blinks every 1 sec. and LED blinks consecutively every 0.15 sec.
  • Page 15 VIVOTEK If your camera should become defocused, you can place the focus adjustment tool carefully on the lens, and use it to turn the lens clockwise or counter-clockwise to adjust to the best image focus. NOTE: 1. The camera is only to be connected to PoE networks without routing to outside plants.
  • Page 16 VIVOTEK 9. Use a piece of clean cotton cloth to hold and and install the dome cover. Install dome cover by aligning the semi-circular cut-out with the release tab. Press on both ends of the dome cover for it to snap into place. A "Click" sound should be heard when it is properly installed.
  • Page 17: Ready To Use

    VIVOTEK Ready to Use 1. A browser session with the Network Camera should prompt as shown below. 2. You should be able to see live video from your camera. You may also install the 32-channel recording software from the software CD in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents.
  • Page 18: 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 19 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 20 VIVOTEK IMPORTANT: • Currently the Network Camera utilizes a 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.
  • Page 21: Using Rtsp Players

    VIVOTEK Using RTSP Players To view the streaming media using RTSP players, you can use one of the following players that support RTSP streaming. Quick Time Player VLC media player VLC media player 1. Launch the RTSP player. 2. Choose File > Open URL. A URL dialog box will pop up.
  • Page 22: 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 23: 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. Tips: 1. If you forget the root (administrator) password for the camera, you can restore the camera defaults by pressing the reset button for longer than 5 seconds.
  • Page 24: 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 25 VIVOTEK Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 29. 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 26 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 27 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 28 VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Time 2016/07/25 17:08:56 Video (HTTP-V) Title and Time Video 17:08:56 2016/07/25 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 47.
  • Page 29: 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 30 VIVOTEK MP4 Saving Options Users can record live video as they are watching it by clicking Start MP4 Recording on the main page. Here, you can specify the storage destination and file name. Folder: Specify a storage destination on your PC for the recorded video files. The location can be changed.
  • Page 31 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 32 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 33 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 34: 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 35: 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 36 VIVOTEK System time Keep current date and time: Select this option to preserve the current date and time of the Network Camera. The Network Camera’s internal real-time clock maintains the date and time even when the power of the system is turned off.
  • 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, Image settings, Exposure, and Privacy mask. General settings Video title Show_timestamp_and video_title_in_video_and_snapshots: Enter a name that will be displayed on the title bar of the live video as the picture shown below.
  • Page 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 flip/mirror setting.
  • Page 49 VIVOTEK Smart IR When enabled, the camera automatically adjust the IR projection to adjacent objects in order to avoid over-exposure in the night mode. The Smart IR function is more beneficial when the spot of intrusions or an object of your interest is close to the lens and the IR lights.
  • Page 50 VIVOTEK Tips: If there is an object in close proximity, the IR lights reflected back from it can mislead the Smart IR’s calculation of light level. To solve this issue, you can place an “Exposure Exclude” window on an unavoidable object in the Exposure setting window.
  • Page 51 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 52 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 53 VIVOTEK Exposure On this page, you can configure the Exposure measurement window, Exposure level, Exposure time, Gain control, and WDR Enhanced settings. You can configure two sets of Exposure settings: one for normal situations, the other for special situations, such as the profile schedule mode.
  • Page 54 VIVOTEK The inclusive window refers to the “weighted 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 55 VIVOTEK Enable WDR enhanced: This function allows users to identify more image details with an extreme contrast from an object of interest with one shadowed side against a bright background, e.g., an entrance. You may select the Enable WDR enhanced checkbox, and then adjust the strength (low, medium, high) to reach the best image quality.
  • 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 configure privacy mask windows, 1. Click New to add a new window. 2. You can use 4 mouse clicks to create a new masking window, which is recommended to be at least twice the size of the object (height and width) you want to cover.
  • Page 57: Media > Video

    VIVOTEK Media > Video Stream settings FOV (Field of View) The default resolution is 2 Megapixels 1080P, and if bandwidth or frame rate per second is of the concern, you can select a lower resolution while enjoying a higher frame rate. The other configurable options is 720P (16:9) at 60fps high frame rate.
  • 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 Gloabl 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 (Dual Codec) for real-time viewing. If the H.264...
  • Page 60 VIVOTEK The frame rate will decrease if you select a higher resolution. ■ Intra frame period Determine how often for firmware to plant an I frame. The shorter the duration, the more likely you will get better video quality, but at the cost of higher network bandwidth consumption. Select the intra frame period from the following durations: 1/4 second, 1/2 second, 1 second, 2 seconds, 3 seconds, and 4 seconds.
  • Page 61 VIVOTEK • Smart codec: Smart codec effectively reduces the quality of the whole or the non- interested areas on a screen and therefore reduces the bandwidth consumed. You can manually specify the video quality for the foreground and the background areas.
  • Page 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 ■ B it rate control Constrained bit rate: A complex scene generally produces a larger file size, meaning that higher bandwidth will be needed for data transmission. The bandwidth utilization is configurable to match a selected level, resulting in mutable video quality performance. The bit rates...
  • Page 64 VIVOTEK If the JPEG mode is selected, the Network Camera sends consecutive JPEG images to the client, producing a moving effect similar to a filmstrip. Every single JPEG image transmitted guarantees the same image quality, which in turn comes at the expense of variable bandwidth usage. Because the media contents are a combination of JPEG images, no audio data is transmitted to the client.
  • Page 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 13 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. ► If UPnP is not supported by your router, you will see the following message: Error: Router does not support UPnP port forwarding.
  • 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 VIVOTEK http://<ip address>:<http port>/<access name for stream 1, 2, 3> URL command -- is set to video2.mjpg: For example, when the Access name for stream 2 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. 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 VIVOTEK NOTE: ► The Preset Positions will also be displayed on the Home page. Select one from the Go to menu, and the Network Camera will move to the selected preset position. ► Click Patrol: The Network Camera will patrol along the selected positions repeatedly.
  • Page 100: 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 101 VIVOTEK ■ Event name: Enter a name for the event setting. ■ Enable this event: Select this checkbox to enable the event setting. ■ Priority: Select the relative importance of this event (High, Normal, or Low). Events with a higher priority setting will be executed first.
  • Page 102 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 103 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 104 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 to open the server setting window.
  • Page 105 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 106 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 107 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 126 for details. Note that only one NAS server can be configured. Click Save server to enable the settings.
  • Page 108 VIVOTEK to open the directory: Click 20160120 The format is: HH (24r) Click to open the file list for that hour 2016/01/20 2016/01/20 Click to go back to the previous Click to delete level of the directory selected items Click to delete all...
  • Page 109 VIVOTEK Add media Click Add media 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 110 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 111 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 112 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 113 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 114: 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 115 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 100.
  • Page 116 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 124 for detailed information. NOTE: ►...
  • Page 117: 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 118: 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 119 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 120: 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 121 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 122 VIVOTEK On the License page, use the Manual or Automatic to register and activate the license for using VIVOTEK's VADP modules. The Automatic method requires an Internet connection. Without Internet connection, you should acquire the license key elsewhere, and manually upload to the network camera.
  • Page 123: 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 124 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 125 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 126 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 limit must be larger than the reserved amount for cyclic recording.
  • Page 127 VIVOTEK f you want to enable recording notification, please click to configure event triggering settings. Event Please refer to Event > Event settings on page 100 for more details. When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page.
  • Page 128: 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 129: 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 130 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 131 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 132: Appendix

    VIVOTEK Appendix URL Commands for the Network Camera 1. Overview For some customers who already have their own web site or web control application, the Network Camera/Video Server can be easily integrated through URL syntax. This section specifies the external HTTP-based application programming interface.
  • Page 133 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 134 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 135 (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 User's Manual - 135...
  • Page 136 VIVOTEK must be placed at the end of the parameter list Return: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: <length>\r\n \r\n <parameter pair> where<parameter pair> is <parameter>=<value>\r\n [<parameter pair>] Only the parameters that you set and are readable will be returned.
  • Page 137 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 138 VIVOTEK <WxH> The format for resolution. W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 available The API is listed in product WebAPIs. non-available The API is not in product WebAPIs. valid The API is listed in product WebAPIs, and is functional.
  • Page 139 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 140 VIVOTEK Paz, Santiago -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...
  • Page 141 VIVOTEK Melbourne, Sydney, Guam, Vladivostok 440: GMT 11:00 Magadan, Solomon Is., New 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.
  • Page 142 VIVOTEK parameters will be restored to default values except for a union of combined results. restoreexceptlang Restore the system parameters to default <positive integer> values except the custom language file the user has uploaded. This command can cooperate with other “restoreexceptXYZ”...
  • Page 143 VIVOTEK 7.1.1 system.info Subgroup of system: info (The fields in this group are unchangeable.) NAME VALUE SECURITY DESCRIPTION (get/set) modelname string[40] Internal model name of the server extendedmodelname string[40] ODM specific model name of server (eg. DCS-5610). If it is not an ODM model, this field will be equal to “modelname”...
  • Page 144 VIVOTEK customlanguage_i<0~(ma string Custom language name. xcount-1)> 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 >...
  • Page 145 VIVOTEK 7.4digital output behavior define Group: do_i<0~(n-1)> for n is the value of "capability_ndo" (capability.ndo > 0) NAME VALUE SECURITY DESCRIPTION (get/set) normalstate open, Indicate open circuit or closed circuit grounded (inactive status) 7.5security Group: security NAME VALUE SECURITY DESCRIPTION...
  • Page 146 VIVOTEK 7.6network Group: network NAME VALUE SECURITY DESCRIPTION (get/set) preprocess <positive integer> An 32-bit integer, each bit can be set separately as follows: Bit 0 => HTTP service; Bit 1=> HTTPS service; Bit 2=> FTP service; Bit 3 => Two way audio and RTSP Streaming service;...
  • Page 147 VIVOTEK dns1 <ip address> Primary DNS server. dns2 <ip address> Secondary DNS server. wins1 <ip address> Primary WINS server. wins2 <ip address> Secondary WINS server. 7.6.1 802.1x Subgroup of network: ieee8021x (capability.protocol.ieee8021x > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean>...
  • Page 148 VIVOTEK 7.6.2 QOS Subgroup of network: qos_cos (capability.protocol.qos.cos > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable CoS (IEEE 802.1p) vlanid 1~4095 VLAN ID video Video channel for CoS audio Audio channel for CoS <product dependent> (capability.naudioin > 0)
  • Page 149 VIVOTEK 7.6.4 FTP Subgroup of network: ftp NAME VALUE SECURITY DESCRIPTION (get/set) port 21, 1025~65535 Local ftp server port. 7.6.5 HTTP Subgroup of network: http NAME VALUE SECURITY DESCRIPTION (get/set) port 80, 1025 ~ 65535 HTTP port. alternateport 1025~65535 Alternate HTTP port.
  • Page 150 VIVOTEK 7.6.7 RTSP Subgroup of network: rtsp (capability.protocol.rtsp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 554, 1025 ~ 65535 RTSP port. (capability.protocol.rtsp=1) anonymousviewing <boolean> Enable anoymous streaming viewing. authmode disable, RTSP authentication mode. basic, (capability.protocol.rtsp=1) digest s<0~(capability_nmediast string[32] RTSP access name for stream N, N= 1~ ream-1)>_accessname...
  • Page 151 VIVOTEK (httpversion) is equal or greater than 0304a. audioipaddress <ip address> Multicast audio IP address. <product dependent> * We support this parameter when the version number (httpversion) is equal or greater than 0304a. * Only available when capability_naudioin > 0 metadataipaddress <ip address>...
  • Page 152 VIVOTEK pass password[64] PPPoE account password. 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).
  • Page 153 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, "rbgain": Use rgain and bgain to set white widerange, balance manually.
  • Page 154 VIVOTEK 7: EV +0.3 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 independent>...
  • Page 155 VIVOTEK Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only) text string[64] Enclose caption. imprinttimestamp <boolean> Overlay time stamp on video. minexposure <1~32000>, Minimum exposure time <product dependent> <5~32000>, 1~32000 =>...
  • Page 156 VIVOTEK "irismode"=fixed * Only available when "capability_image_c<n>_exposure_rangety pe" 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 157 VIVOTEK "capability_image_c<n>_wbmode" ! ="-" rgain 0~100 Manual set rgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c<n>_wbmode". * Only valid when "videoin_c<n>_whitebalance" != auto * Normalized range. bgain 0~100 Manual set bgain value of gain control setting.
  • Page 158 VIVOTEK 12: EV +2.0 exposuremode auto, Select exposure mode. <product shutterpriority, dependent> irispriority, "auto": Iris, Gain and Shutter manual, Speed(Exposure time) can be set automatically. "shutterpriority": Adjust with (Available options are list in variable Shutter Speed, auto Iris and "capability_image_c<n>_exposure_m Gain.
  • Page 159 VIVOTEK sortype" is "smartsensor") * Only available when "capability_image_c<n>_iristype"= piris piris_position 1~100 Manual set P-Iris. <product 1: Open <-> 100: Close dependent> * Only valid when "piris_mode"=manual or "capability_image_c<0~(n-1)>_sen sortype" is "smartsensor" * Only available when "capability_image_c<n>_iristype"= piris enableblc <boolean>...
  • Page 160 VIVOTEK in" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<n>_exposure_ rangetype" is "twovalues". gainvalue 0~100 Gain value. 0: Low <-> 100: High * Only available when "capability_image_c<n>_agc_maxg ain" != "-" and "capability_image_c<n>_exposure_...
  • Page 161 VIVOTEK Bit 5 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only) text string[64] Enclose caption. imprinttimesta <boolean> Overlay time stamp on video. textonvideo_po top, bottom Text on video string position sition textonvideo_siz 20~40 Text on video font size textonvideo_fon /usr/share/font/Default.ttf,...
  • Page 162 VIVOTEK axrange" image frame rate from sensor due to sensor generates a frame per exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s. * Only available when "capability_image_c<n>_exposure_...
  • Page 163 VIVOTEK enablepreview <boolean> Usage for UI of exposure settings. Preview settings of video profile. crop_position <coordinate> Crop left-top corner coordinate. (x,y) crop_size <window size> Crop width and height. (WxH) (width must be 16x or 32x and height must be 8x) zoomratiodispla <boolean>...
  • Page 164 VIVOTEK 4: Detailed 5: Excellent 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue" * Only valid when "ratecontrolmode"= vbr. s<0~(m-1)>_h 0~51 Manual video quality level input. The 264_qvalue Q value which is used by encoded library directly.
  • Page 165 VIVOTEK * Only available when "ratecontrolmode"= cbr. * Only available when "capability_smartstream_version"=2   s<0~(m-1)>_h 1~100 Select customized quality in a 264_cbr_qperce normalized full range. 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"= cbr and "quant"= 100. * Only available when "capability_smartstream_version"=2...
  • Page 166 VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0301c. s<0~(m-1)>_h 250, 500, 1000, 2000, 3000, 4000 The time interval between two 265_intraperiod I-frames (Intra coded picture). The unit is millisecond (ms). * Only available when h265 is listed in "capability_videoin_codec".
  • Page 167 VIVOTEK 1: Worst quality 100: Best quality * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= vbr and "quant"= 100. s<0~(m-1)>_h 20000~"capability_videoin_c<n>_h2 The maximum allowed bit rate in " 265_maxvbrbitr fixed quality mode. 65_maxbitrate When the bit rate exceeds this value, frames will be dropped to restrict the bit rate.
  • Page 168 VIVOTEK * Only valid when "ratecontrolmode"= cbr and "quant"= 100. * Only available when "capability_smartstream_version"=" 2.0" s<0~(m-1)>_h 20000~"capability_videoin_c<n>_h2 The target bit rate in constant bit rate 265_bitrate 65_maxbitrate" mode. * Only available when h265 is listed in "capability_videoin_codec". *  Only valid when  ...
  • Page 169 VIVOTEK jpeg_quant 99, 100 "ratecontrolmode"= vbr. Set the pre-defined quality level: 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue" s<0~(m-1)>_m 10~200 Manual video quality level input. The...
  • Page 170 VIVOTEK 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only available when "ratecontrolmode"= cbr. * Only available when "capability_smartstream_version"=" 2.0" s<0~(m-1)>_m 1~100 Select customized quality in a jpeg_cbr_qperc normalized full range. 1: Worst quality...
  • Page 171 VIVOTEK ode" > 0 wdrpro_strengt 1~100 The strength of WDR Pro. The bigger value means the stronger <product strength of WDR Pro. dependent> * Only available when "capability_image_c<n>_wdrpro_st rength" is 1 wdrc_mode <boolean> Enable WDR enhanced. <product * Only available when dependent>...
  • Page 172 VIVOTEK <product 21~40: level 2 dependent> 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher sensitivity level meas that it is easy to be trigger while scene changed. * Only available when "capability_image_c<n>_aespeed" is 1 flickerless <boolean>...
  • Page 173 VIVOTEK * Only available when "capability_fisheyelocaldewarp_c<0 ~(capability_nvideoin)-1>" > 0 Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h264_smartstream2 (capability_smartstream_support=1 and capability_smartstream_version=2.0) Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h265_smartstream2 (capability_smartstream_support=1, capability_smartstream_version=2.0 and h265 is listed in "capability_videoin_codec") n denotes the value of "capability_nvideoin",m denotes the value of " capability_nmediastream" NAME VALUE SECURITY DESCRIPTION...
  • Page 174 VIVOTEK -1 to -5. Level -5 is the maximum level of the quality difference between the ROI and non-ROI areas. Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h264_smartstream2_win_i<0~(k-1)> (capability_smartstream_support=1, capability_smartstream_version=2.0 and capability_smartstream_mode_manual = 1) Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h265_smartstream2_win_i<0~(k-1)> (capability_smartstream_support=1, capability_smartstream_version=2.0 and h265 is listed in "capability_videoin_codec" and capability_smartstream_mode_manual = 1) n denotes the value of "capability_nvideoin",m denotes the value of "...
  • Page 175 VIVOTEK <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc. 5~8000 => 1/5s ~ 1/8000s etc. * Available value is listed in * Only available when "capability_image_c "capability_image_c<n>_exposure_minrang <n>_exposure_min e" != "-" range" * Only valid when "piris_mode"=manual or "irismode"=fixed...
  • Page 176 VIVOTEK etc. * 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 177 VIVOTEK 11: EV +1.7 12: EV +2.0 exposuremode auto, Select exposure mode. <product dependent> shutterpriority, irispriority, "auto": Iris, Gain and Shutter manual, Speed(Exposure time) can be set automatically. "shutterpriority": Adjust with variable (Available options Shutter Speed, auto Iris and Gain.
  • Page 178 VIVOTEK * 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" is listed in "capability_image_c<n>_wbmode".
  • Page 179 VIVOTEK 0: Low <-> 100: High * Only available when "capability_image_c<n>_agc_maxgain" != "-" and "capability_image_c<n>_exposure_rangety pe" is "onevalue". * Normalized range. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. piris_mode manual, indoor, Control P-Iris mode.
  • Page 180 VIVOTEK * Only available when "capability_image_c<n>_iristype"=dciris wdrpro_mode <boolean> Enable WDR pro <product dependent> * Only available when "capability_image_c<n>_wdrpro_mode" > 0 wdrpro_strength 1~100 The strength of WDR Pro. <product dependent> The bigger value means the stronger strength of WDR Pro. * Only available when "capability_image_c<n>_wdrpro_strength"...
  • Page 181 VIVOTEK 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher sensitivity level meas that it is easy to be trigger while scene changed. * Only available when "capability_image_c<n>_aespeed" is 1 flickerless <boolean> Turn on(1) or turn off(0) the flickerless mode <product dependent>...
  • Page 182 VIVOTEK 7.10 IR cut control Group: ircutcontrol (capability.nvideoinprofile> 0 and capability_daynight_c<0~(n-1)>_ircutfilter=1) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, Set IR cut control mode day, night, schedule <product dependent> <boolean> Enable/disable Smart IR <product dependent>...
  • Page 183 VIVOTEK _ircutsensitivity_type" is not "-". 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" NAME VALUE SECURITY DESCRIPTION (get/set) brightness -5~5,100 -5: Darker <-> 5: Bright <Not recommended to use this>...
  • Page 184 0: Softer <-> 100: Sharper * Only available when bit 3 of "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...
  • Page 185 VIVOTEK level, but not all gamma values are valid. Internal module will take the closest valid one. For example, 1~45 may all be mapped to gamma value = 0.45, etc. lowlightmode <boolean> Enable/disable low light mode. <product dependent> * Only available when "capability_image_c<n>_lowlightmode"...
  • Page 186 VIVOTEK <product dependent> 0: disable 1: enable * Only available when "capability_image_c<n>_scenemode_suppor t" is 1 scene_mode visibility, Value of scene mode <product dependent> noiseless, * Only available when lpcparkinglot, "capability_image_c<n>_scenemode_suppor lpcstreet t" is 1 <product * Available value is listed in dependent>...
  • Page 187 VIVOTEK * Only available when bit 1 of "capability_image_c<n>_basicsetting" is 1. * We replace "profile_i0_contrast" with "profile_i0_contrastpercent ". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. profile_i<0~(m-1)>_saturation -5~5,100 -5: Less saturation <-> 5: More saturation <Not recommended to use this>...
  • Page 188 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 189 VIVOTEK ength * Only available when <product dependent> "capability_image_c<n>_defog_mode" is 1 profile_i<0~(m-1)>_eis_mode <boolean> Electronic image stabilizer <product dependent> 0:disable 1:enable * Only available when 'eis' is listed in "capability_image_c<n>_is_mode". profile_i<0~(m-1)>_eis_streng 1~100 Strength of electronic image stabilizer * Only available when 'eis' is listed in <product dependent>...
  • Page 190 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) mode auto, custom,blc "auto": Use full image view as the only exposure window.
  • Page 191 VIVOTEK ain". 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_windom ain". homestd <0~9999,0~9999> Left-top corner coordinate of the window.
  • Page 192 VIVOTEK enable <boolean> Enable or disable the window. policy 0: Indicate exclusive. 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_windom...
  • Page 193 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 194 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 195 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 196 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 197 VIVOTEK 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 198 VIVOTEK 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". * It's recommended to use polygonsd...
  • Page 199 VIVOTEK 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 200 VIVOTEK   <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" = polygon. * Only available when qvga is listed in "capability_motion_windomain...
  • Page 201 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 202 VIVOTEK 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" for more than "duration"...
  • Page 203 VIVOTEK string[64] The url user define to link to camera 7.18 UPnP presentation Group: upnppresentation NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP presentation service. 7.19 UPnP port forwarding Group: upnpportforwarding NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean>...
  • Page 204 VIVOTEK 7: LOG_DEBUG setparamlevel Show log of parameter setting. 0: disable 1: Show log of parameter setting set from external. 2. Show log of parameter setting set from external and internal. 7.21 SNMP Group: snmp (capability.protocol.snmp > 0) NAME VALUE...
  • Page 205 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 206 VIVOTEK 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" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable privacy mask. win_i<0~(m-1)>_enable <boolean>...
  • Page 207 VIVOTEK W: 0~ The = polygon. current image width -1 * Only available when px is listed in H: 0~ The "capability_image_c<n>_privacymask_windomain current image height -1 win_i<0~(m-1)>_polygonstd 0 ~ 9999,0 ~ Coordinate of polygon window position. 9999, 0 ~ (4 points: x0,y0,x1,y1,x2,y2,x3,y3)
  • Page 208 Group: capability 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 with 0301a. composed by "major version", "minor version", "revision","_platform". ex: 0301a_1 Major version Increase the major version when change,...
  • Page 209 VIVOTEK EX: 0302b_1 => Major version = 03, minor version = 02, revision = b, platform = 1 The 4 integer numbers are WebAPI version, we use short name: [httpversion] for it in this document. The 5th character is model-based version for API bug-fix and it's default to "a".
  • Page 210 VIVOTEK naudiosetting <positive integer> Number of audio settings per channel. <Not support anymore> * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * We replace "naudiosetting" with "naudioin". More details, please refer the parameter description of "volume_internal"...
  • Page 211 VIVOTEK event/control transfer. joystick <boolean> Indicate whether to support joystick control. remotefocus 0,<positive integer> An 4-bit integer, which indicates the <Not recommended to use supportive application of remotefocus. this> If the value of this parameter is larger than 0, it means that the camera supports remotefocus function.
  • Page 212 VIVOTEK 1st channel, bit 10~19 are the 2nd group for 2nd channel, bit 20~31 are the 3rd group for 3rd channel. Then, the 1st bit of the group indicates 1st stream of a channel support ePTZ or not. The 2nd bit of the group indicates 2nd stream of a channel support ePTZ or not, and so on.
  • Page 213 VIVOTEK "vi" = Virtual input (Manual trigger) "vadp" = VADP trigger "di"= Digital input "volalarm" = Audio detection "temperature" = Temperature detection "pir" = PIR detection "visignal" = Video input signal loss. "backup" = Backing up recorded files * Only available when [httpversion] >=...
  • Page 214 VIVOTEK videoin_nresolution <positive integer> This equals "capability_videoin_c0_nresolution". * This is kept for compatibility. videoin_resolution A list of <WxH> This equals <product "capability_videoin_c0_resolution". dependent> * This is kept for compatibility. videoin_maxframerate A list of <Integer> This equals "capability_videoin_c0_maxframerate". * This is kept for compatibility.
  • Page 215 VIVOTEK "capability_nvideooout". "-": Video-out is not available ntsc: NTSC analog output pal: PAL analog output "nvideoout"=0, "videoout_codec"=- "nvideoout"=1 with NTSC, "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.
  • Page 216 VIVOTEK audio_alarm <0~Positive 0: Not support audio alarm. Integer> 1: Support audio alarm. Bit 0 for CH0, bit 1 for CH1, and so on. audio_linein <boolean> Indicate whether to support external line <Not support anymore> input. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.
  • Page 217 VIVOTEK -: Not supported. smartstream_support <boolean> Indicate whether smart stream is supported. smartstream_version <integer> Number of smart stream version smartstream_nstream <positive integer> Number of stream that support smart stream. *only available when "capability_smartstream_support" is 1 smartstream_windomain qvga, px, std, - The domain to set an focus window.
  • Page 218 VIVOTEK smartstream_nwindow_h <positive integer> Maximum number of tracking window of ybrid_manual manual in hybrid mode. *only available when "capability_smartstream_support" is 1 vadp_supportfeature <positive integer> An 32-bit integer, each bit can be set separately as follows: Bit 0 => VADP interface Bit 1 =>...
  • Page 219 VIVOTEK This equals "capability_camctrl_c0_ptztunnel". * This is kept for compatibility. camctrl_privilege <boolean> Indicate whether to support “Manage Privilege” of PTZ control in the security page. 1: support both /cgi-bin/camctrl/camctrl.cgi and /cgi-bin/viewer/camctrl.cgi 0: support only /cgi-bin/viewer/camctrl.cgi This is equivalent to"capability_camctrl_c0_privilege". * This is kept for compatibility.
  • Page 220 VIVOTEK test_ac <boolean> Indicate whether to support test ac key. version_onvifdaemon <string> Indicate ONVIF daemon version version_onviftesttool <string> Indicate ONVIF test tool version media_totalspace <positive integer> Available memory space (KB) for media. media_snapshot_maxpre <positive integer> Maximum snapshot number before event event occurred.
  • Page 221 VIVOTEK localstorage_modnum The maximum MOD connection numbers. <positive integer> localstorage_modversion <string> Indicate MOD daemon version localstorage_stormgrversi <string> Indicate storage manager daemon version localstorage_supportedge An 32-bit integer, which indicates the <positive integer> supportive application of edge storage. If the value of this parameter is larger than 0, it means that the camera supports edge recording function.
  • Page 222 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) ptztunnel <boolean> Indicate whether to support ptztunnel in this video input. privilege <boolean> Indicate whether to support “Manage Privilege” of PTZ control in the security page in this video input. 1: support both /cgi-bin/camctrl/camctrl.cgi and /cgi-bin/viewer/camctrl.cgi...
  • Page 223 VIVOTEK minpan 0, <positive integer> 0/7 The lower limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" maxpan 0, <positive integer> 0/7 The upper limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" minpanangle <integer>...
  • Page 224 VIVOTEK minzoom 0, <positive integer> 0/7 The lower limit for zoom position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodul e" is "1" maxzoom 0, <positive integer> 0/7 The upper limit for zoom position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodul e"...
  • Page 225 VIVOTEK blackwhitemode <boolean> Indicate whether to support automatically switch to Black & White display during the night mode. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. ircutsensitivity_type <string> Indicate the cgi interface of "ircutcontrol_sensitivity".
  • Page 226 VIVOTEK lens_type fisheye, fixed, The lens type of this channel.  fisheye: Fisheye lens  varifocal, changeable, fixed: Build‐in fixed‐focus lens.  motor, - <product dependent> varifocal: Build‐in varifocal lens.  changeable: changeable lens. Like box‐type  camera, users can install any C‐Mount or  CS‐Mount lens as they wish.  motor: Lens with motor to support zoom,  focus, etc.  ‐: N/A    * Only available when [httpversion] >= 0301a rotation <boolean> Indicate current mode whether support video rotation streamcodec <positive integer>...
  • Page 227 VIVOTEK maxresolution A list of <Integer> Represent supported maximum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream". maxframerate A list of <Integer> Indicate frame rate that the video source outputs in current video mode.
  • Page 228 VIVOTEK h264_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer> and "-" H.264 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 229 VIVOTEK fisheye_mounttype ceiling, wall, floor Indicate the supported type. <product dependent> <product dependent> wall mount: 180° panoramic view ceiling mount: 360° surround view without blind spots floor mount: 360° surround view without blind spots Only available when "capability_fisheye" > 0 dintraperiod_support <boolean>...
  • Page 230 VIVOTEK resolutionC4R A list of <WxH> Available resolutions of 4R mode of ceiling and floor mount. resolutionW1P A list of <WxH> Available resolutions of 1P mode of wall mount. resolutionW1R A list of <WxH> Available resolutions of 1R mode of wall mount.
  • Page 231 VIVOTEK binning 0, 1, 3 Indicate binning is used or not in this video mode. 0: No binning 1: 2x2 binning 3: 3x3 binning * Binning is a technology to increase light sensitivity by combining multiple pixels to one. The drawback is reduced resolution. We design this parameter to disclose this information.
  • Page 232 VIVOTEK maxfps_mjpeg A list of <Positive Maximum fps which the device can encoded Integer> and "-" with MJPEG on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution"...
  • Page 233 VIVOTEK Group: capability_image_c<0~(n-1)> n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set)       basicsetting 0, <positive integer> A 32-bits integer, each bit can be set separately as follows: Bit 0 => Supports Brightness or not. Bit 1 => Supports Contrast or not.
  • Page 234 VIVOTEK <x>, "Policy" can be categorized into exposuremode:fixed:auto following groups: - (disabled) : UI turns grey and users <x>: nonnegative integer can't select it. <product dependent> - (unchanged) : UI keeps the status as before and user can't change it.
  • Page 235 VIVOTEK led:, here. aespeed:disabled:, exposurelevel:hidden:, The format is "Affect API exposurelevel:fixed:<x>, name":"Policy":"Value" exposurelevel:ranged:<x>- <x>, "Policy" can be categorized into exposuremode:fixed:auto following groups: - (disabled) : UI turns grey and users <x>: nonnegative integer can't select it.   <product dependent> - (unchanged) : UI keeps the status as before and user can't change it.
  • Page 236 VIVOTEK is_mode eis, Indicate the image stabilizer mode. dis, "eis": electronic image stabilizer "dis": digital image stabilizer "-": not support * We support this parameter when the version number (httpversion) is equal or greater than 0302a. is_strength <boolean> 0: Non-support tuning strength of image stabilizer mode.
  • Page 237 VIVOTEK can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values.
  • Page 238 VIVOTEK <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 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.
  • Page 239 VIVOTEK <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 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.
  • Page 240 VIVOTEK <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 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.
  • Page 241 VIVOTEK <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 <x>: nonnegative integer name":"Policy":"Value" <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it.
  • Page 242 VIVOTEK   rbgain, supported. widerange, outdoor,indoor, sodiumauto,   <product dependent>     iristype piris, Indicate iris type. dciris, "piris": P-Iris   "dciris": DC-Iris "-": No Iris control support * Note: For some cameras, this value may be varied depending on  ...
  • Page 243 VIVOTEK (videoin_c<n>_shuttervalue). "maximum": The shutter value can be up to the assigned value (videoin_c<n>_shuttervalue). "-": not support. * Only available when "capability_image_c<n>_exposure_ rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 244 VIVOTEK can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values.
  • Page 245 VIVOTEK <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 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 name":"Policy":"Value" <x>: nonnegative integer <product dependent>...
  • Page 248 VIVOTEK 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 249 VIVOTEK output * Only available when [httpversion]  >= 0301a exposure_pal_totalrange A list of <Positive Integer> 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>...
  • Page 250 VIVOTEK -: Not supported. <Positive Integer> privacymask_ncolor Available total color numbers of 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  ...
  • Page 251 VIVOTEK disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level "Value" can be a nonnegative integer or NULL. "-" means no feature is affected. * When "flickerless" = 0, this must be "-"...
  • Page 252 VIVOTEK - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled.
  • Page 253 VIVOTEK camera supports remotefocus function in this channel. 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...
  • Page 254 VIVOTEK Group: capability_peripheral_c<0~(n-1)> n denotes the value of "capability_nvideoin" 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.
  • Page 255 VIVOTEK 7.27 Event setting Group: event_i<0~2> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. enable 0, 1 Enable or disable this event. priority 0, 1, 2 Indicate the priority of this event: “0”= low priority “1”= normal priority “2”= high priority...
  • Page 256 VIVOTEK mdwin 0,<positive integer> Indicate the source window id of motion detection. This field is required when trigger condition is “md”. One bit represents one window. The LSB indicates the 1 window. For example, to detect the 1 and 3 windows, set mdwin as 5.
  • Page 257 VIVOTEK weekday 0~127 Indicate which weekday is scheduled. One bit represents one weekday. bit0 (LSB) = Saturday bit1 = Friday bit2 = Thursday bit3 = Wednesday bit4 = Tuesday bit5 = Monday bit6 = Sunday For example, to detect events on Friday and Sunday, set weekday as 66.
  • Page 258 VIVOTEK action_goto_enable <boolean> Enable/disable ptz goto preset position on <product dependent> event triggered. * Only available when capability_ptzenabled > action_goto_name string[40] Specify the preset name that ptz goto on event <product dependent> triggered. * Only available when capability_ptzenabled > action_goto_sync <boolean>...
  • Page 259 VIVOTEK ftp_passive <boolean> Enable or disable passive mode. 0 = disable passive mode 1 = enable passive mode email_address string[128] Email server address. email_sslmode <boolean> Enable support SSL. email_port 0~65535 Port to connect to the server. email_username string[64] Username to log in to the server.
  • Page 260 VIVOTEK snapshot_datesuffix 0, 1 Add date and time suffix to filename: 1 = Add date and time suffix. 0 = Do not add. snapshot_preevent 0~" Indicates the number of pre-event capability_media_snapshot_maxpr images. eevent" snapshot_postevent 0~" Indicates the number of post-event capability_media_snapshot_maxpo images.
  • Page 261 VIVOTEK 7.30 Recording Group: recording_i<0~1> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. trigger schedule, The event trigger type networkfail schedule: The event is triggered by schedule networkfail: The event is triggered by the failure of network connection.
  • Page 262 VIVOTEK notifyserver 0~31 Indicate which notification server is scheduled. One bit represents one application server (server_i0~i4). bit0 (LSB) = server_i0. bit1 = server_i1. bit2 = server_i2. bit3 = server_i3. bit4 = server_i4. For example, enable server_i0, server_i2, and server_i4 as notification servers; the notifyserver value is 21.
  • Page 263 Country name in the certificate information. stateorprovincename string[128] State or province name in the certificate information. localityname string[128] The locality name in thecertificate information. organizationname string[64] Organization name in the certificate VIVOTEK Inc. information. User's Manual - 263...
  • Page 264 VIVOTEK unit string[64] Organizational unit name in thecertificate VIVOTEK Inc. information. commonname string[64] Common name in the certificate information. www.vivotek.com validdays 0 ~ 3650 Valid period for the certification. 7.32 Storage management setting Group: disk_i<0~(n-1)> n is the total number of storage devices.
  • Page 265 VIVOTEK maxretentiontime_recordin <boolean> Enable automatic clean up method for video g_enabled clip generated by recording task. The parameter takes effect when autocleanup_enabled is enabled. maxretentiontime_recordin <string> To specify the expired time for automatic clean g_i <0~1>_maxage up, and it only takes effect for video clip generated by recording_i <0~1>.
  • Page 266 VIVOTEK 7.33 Region of interest Group: roi_c<0~(n-1)> for n channel product. (capability.eptz > 0) m denotes the value of "capability_nmediastream". PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-2)>_home <W,H> ROI left-top corner coordinate.* If the minimal <product dependent> window size is 64x64, then the "win_i0_home"=(0~resolution_W-64,...
  • Page 267 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 ePTZ. (capability.eptz > 0) 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 “,”.
  • 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 enable <boolean> Enable or disable the schedule mode to control the execution of the VADP package begintime hh:mm Begin time of the schedule endtime hh:mm End time of the schedule Group: vadp_event NAME VALUE SECURITY DESCRIPTION (get/set) ntrigger 0,<positive integer>...
  • Page 272 VIVOTEK preset -1)>_ dwelling uart Select corresponding uart (capability_nuart -1) (capability.nuart>0). 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.
  • Page 273 VIVOTEK >_minpan ~ capability_ptz_c<0~(n-1) >_maxpan preset_i<0~(k-1)>_tilt capability_ptz_c<0~(n-1) Tilt position at each preset location. >_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...
  • Page 274 VIVOTEK axisflip <boolean> Custom home flip side. returnhome <boolean> Enable/disable return home while idle. returnhomeinterval 1~999 While idle over this time interval, idle action will be taken. digitalzoom <boolean> Enable/disable digital zoom idleaction_enable <boolean> Enable/disable idle action while idle idleaction_type...
  • Page 275 VIVOTEK Group: uart_i<0~(n-1)> n is uart port count (capability.nuart > 0 and capability.fisheye = 0) NAME VALUE SECURITY DESCRIPTION (get/set) baudrate 110,300,600,1200, Set baud rate of COM port. 2400,3600,4800,72 00,9600,19200,384 00,57600,115200 databit 5,6,7,8 Data bits in a character frame. paritybit none, For error checking.
  • 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.46 Auto tracking setting Group: autotrack_c<0~(n-1)> (capbility_image_c<0~(capability_nvideoin)-1>_autotrack_support > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) objsize_type -1~2 Type of object size. -1 : customized width and height 0 : object size = 30 x 30...
  • Page 280 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 Example: Query the status of digital input 1 . Request: http://myserver/cgi-bin/dido/getdi.cgi?di1 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n di1=1\r\n 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]...
  • Page 282 VIVOTEK \r\n do1=1\r\n 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...
  • Page 283 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 284 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 285 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 286 VIVOTEK http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=tele&zs=1 http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed. To stop a continuous movement, you have to use the command as below: http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zoom=stop&zs=0 2. [Area zoom]: it means to zoom in on a specific area, here is an example for a directly moving...
  • Page 287 VIVOTEK resolution <window size> The resolution of streaming. <integer> The direction of movement, used for joystick control. <integer> 0 ~ 7 Set the speed of movement, “0” means stop. <integer> x-coordinate clicked by user. It will be the x-coordinate of center after movement.
  • Page 288 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 289 VIVOTEK return <return page> Redirect to the page <return page>after the parameter is assigned. The <return page>can be a full URL path or relative path according to the current path. 8.11 IP Filtering Note: This request requires Administrator access privileges.
  • Page 290 VIVOTEK 8.12 IP Filtering for ONVIF Syntax:<product dependent> http://<servername>/cgi-bin/admin/ipfilter.cgi?type[=<value>] http://<servername>/cgi-bin/admin/ipfilter.cgi?method=add<v4/v6>&ip=<ipaddress>[&index=<value>] [&return=<return page>] http://<servername>/cgi-bin/admin/ipfilter.cgi?method=del<v4/v6>&index=<value>[&return=<return page>] PARAMETER VALUE DESCRIPTION type NULL Get IP filter type allow, deny Set IP filter type method addv4 Add IPv4 address into access list. addv6 Add IPv6 address into access list.
  • Page 291 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 292 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 293 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 294 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.
  • Page 295 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 296 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 297 VIVOTEK 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. http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=update&isLocked=1&label=1&label=5 Ex. Update records whose key numbers are 2 and 3 to be unlocked status.
  • Page 298 VIVOTEK state after duration. it cannot accept new requests. return <return page> Redirect to the page <return page>after the request is completely assigned. The <return page>can be a full URL path or relative path according the current path. If you omit this parameter, it will redirect to an empty page.
  • Page 299 VIVOTEK “m” is the timeshift stream index. For details on timeshift stream, please refer to the “TimeshiftCaching” documents. PARAMETER VALUE DEFAULT DESCRIPTION maxsft <positive Request cached stream at most how many seconds ago. integer> tsmode normal, normal Streaming mode: adaptive normal =>...
  • Page 300 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 300 - User's Manual...
  • Page 301 VIVOTEK function zoom, Function type focus, zoom - Move focus motor auto, focus – Move focus motor scan, auto – Perform auto focus stop, scan – Perform focus scan positioning, stop – Stop current operation getstatus positioning – Position the motors getstatus–Information of motors, return value as below:...
  • Page 302 VIVOTEK position 0~<motor_max> Motor’s position. It works only if function=zoom | focus and direction=direct. <motor_max> is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from "function=getstatus" steps 1 ~ <motor_max> Motor’s moving steps. It works only if function=zoom | focus and direction=forward |  ...
  • Page 303 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 - 303...
  • Page 304 VIVOTEK function focus, Function type auto, focus – Move focus motor scan, auto – Perform auto focus stop, scan – Perform focus scan positioning, stop – Stop current operation irisopen, positioning – Position the motors irisenable, resetfocus – reset focus position to default resetfocus, irisopen –...
  • Page 305 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 306 VIVOTEK \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> For setting backup file: http://<servername>/cgi-bin/admin/upload_backup.cgi Post data: filename =<file name>\r\n \r\n <multipart encoded form data> Server will accept the file named <file name> to upload this one to camera.
  • Page 307 VIVOTEK For delete selected lens configuration: http://<servername>/cgi-bin/admin/update_lens.cgi?delete_lens=<value> PARAMETER VALUE DESCRIPTION value <string> Available lens name. Please refer to: lens_default_i<0~(n-1)>_name lens_user_i<0~(n-1)>_name n is a positive integer. Method: POST Syntax: For upload user-defined lens configuration: http://<servername>/cgi-bin/admin/update_lens.cgi?upload_lens Post data: upload_lens_profile_input = <file name>\r\n \r\n <multipart encoded form data>...
  • Page 308 VIVOTEK tsmode <positive integer> Timeshift mode, the unit is second. stime etime length file Description Play recordings between stime and etime rtsp://10.10.1.2/mod.sdp?stime=20110312_040400.000&etim e=2011_0312_040510.000 Play recordings for length seconds which start from stime rtsp://10.10.1.2/mod.sdp?stime=20110312_040400.000&leng th=120 Play recordings for length seconds which ends at etime rtsp://10.10.1.2/mod.sdp?etime=20110312_040400.000&leng...
  • Page 309 VIVOTEK http://myserver/cgi-bin/camctrl/fdCamCtrl.cgi?channel=0&stream=0&zooming=tele&zs=2 http://myserver/cgi-bin/camctrl/fdCamCtrl.cgi?channel=0&stream=0&vx=5&vy=3&vs=2 http://myserver/cgi-bin/camctrl/fdCamCtrl.cgi?channel=0&stream=0&x=700&y=700&videosize=1920x19 20&resolution=1920x1920&stretch=1 PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of video source. stream <0~(m-1)> Stream. move home Move to home position. Move up. down Move down. left Move left. right Move right. zoom wide Zoom larger view with current speed.
  • Page 310 VIVOTEK return <return page> Redirect to the page <return page> after the parameter is assigned. The <return page> can be a full URL path or relative path according to the current path. If you omit this parameter, it will redirect to an empty page.
  • Page 311 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 312 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 313 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 314 VIVOTEK return <return page> Redirect to the page <return page> after the parameter is assigned. The <return page> can be a full URL path or relative path according to the current path. If you omit this parameter, it will redirect to an empty page.
  • Page 315 VIVOTEK function getstatus Function type getstauts : Information of smartSD internal status return value as below: smartsd_lifetime_num: Accumulated amount of data that has been written smartsd_lifetime_den: Card-guaranteed amount of data that can be written smartsd_lifetime_rate: The ratio of smartsd_lifetime_num to smartsd_lifetime_den.
  • Page 316 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 City, 235, Taiwan, R.O.C. | T: +886-2-82455282 | F: +886-2-82455532 | E: sales@vivotek.com | W: www.vivotek.com...
  • Page 317 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 318 取扱説明書に従って正しい取り扱いをして下さい 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.

Table of Contents