Vivotek FD816C-HF2 User Manual
Vivotek FD816C-HF2 User Manual

Vivotek FD816C-HF2 User Manual

Recess mount network camera
Hide thumbs Also See for FD816C-HF2:
Table of Contents

Advertisement

Quick Links

FD816C-HF2
FE8182
User's Manual
Recess Mount • WDR • PoE • 3DNR • Smart Stream
Fixed or Fisheye Lens • Pixel Calculator
Recess Mount
Network Camera
Rev. 1.0

Advertisement

Table of Contents
loading

Summary of Contents for Vivotek FD816C-HF2

  • Page 1 FD816C-HF2 FE8182 Recess Mount Network Camera User’s Manual Recess Mount • WDR • PoE • 3DNR • Smart Stream Fixed or Fisheye Lens • Pixel Calculator Rev. 1.0...
  • Page 2: Table Of Contents

    Accessing the Network Camera  16 Using Web Browsers ............................16 Using RTSP Players ............................. 19 Using 3GPP-compatible Mobile Devices ......................20 Using VIVOTEK Recording Software ........................21 Main Page  22 Client Settings  33 H264 Media Options  33...
  • Page 3 Applications > Motion detection.......................... 114 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 4: Overview

    VIVOTEK Overview The VIVOTEK FD816C-HF2 is a recessed-mount fixed dome network camera offering up to 30 fps at 2-Megapixel resolution with superb image quality, even in the darkest hours of the night. Due to its compact size, the camera is able to blend into any surroundings such as banks, retail stores, restaurants, offices and more.
  • Page 5: Read Before Use

    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 ■ FD816C-HF2 or FE8182 camera ■ Quick Installation Guide ■ Alignment Stickers ■ Software CD ■...
  • Page 6: Introduction

    VIVOTEK Introduction The cameras come with different lens modules. A fisheye lens can be used to cover an entire space, while a fixed focal lens a specific field of view. Fixed focal lens module Fisheye lens module Fisheye Fixed focal...
  • Page 7: Hardware Installation

    VIVOTEK Hardware Installation 1. Jot down the camera’s MAC address for later reference. This is important if you have multiple cameras at one installation site. Network Camera Model No: XXXXXX MAC: 0002D1083236 This device complies with part 15 of the FCC Rules. Operation is subject to...
  • Page 8 VIVOTEK 3-1. Detach the top cover. 3-2. Route an Ethernet cable through the pre-drill hole and then connect it to the camera. The camera can only be powered through the PoE connection. If preferred, install a MicroSD card. icro 4. Pull the retention clips to the back of the camera, and then insert the camera into the wall.
  • Page 9 VIVOTEK 5. The retention clips will hold the module in place. 6. Note that the shooting angle of a fixed lens can only be vertically adjusted. This mark should be on top. There is no need to change the shooting angle for the fisheye lens model.
  • Page 10: Led Definition

    VIVOTEK LED Definition Item LED Status Description Steady Power on and system booting LED off Powered off Steady + blinking Green every 1 sec. (Green Network heartbeat LED on for 1 sec and off for another) Steady Green LED off...
  • Page 11: Network Deployment

    VIVOTEK Network Deployment Setting up the Network Camera over the Internet There are several ways to set up the Network Camera over the Internet. The first way is to set up the Network Camera behind a router. The second way is to utilize a static...
  • 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 Internet connection with static IP Choose this connection type if you are required to use a static IP for the Network Camera. Please refer to LAN configuration on page 65 for details. Internet connection via PPPoE (Point-to-Point over Ethernet) Choose this connection type if you are connected to the Internet via a DSL Line.
  • Page 14: Software Installation

    After your network environment is analyzed, please click Next to continue the program. 3. The program will search for all VIVOTEK network devices on the same LAN. 4. After a brief search, the main installer window will pop up. Double-click on the MAC address that matches the one printed on the camera label or the S/N number on the package box label to open a browser management session with the Network Camera.
  • Page 15: 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 16: Accessing The Network Camera

    3. The 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 17 VIVOTEK NOTE: For Mozilla Firefox users, your browser will use QuickTime to stream live video. If you do not have QuickTime on your computer, please download QuickTime from Apple Inc's website, and then launch your web browser. Tips: • The onscreen Java control can malfunction under the following situations: A PC connects to different cameras that are using the same IP address (or the same camera running different firmware versions).
  • Page 18 VIVOTEK NOTE: 1. By default, your Network Camera is not password-protected. To prevent unauthorized access, it is highly recommended to configure a password for your camera later. For more information about how to enable password protection, please refer to Security on page 83.
  • Page 19: Using Rtsp Players

    VIVOTEK Using RTSP Players To view the H.264 streaming media using RTSP players, you can use one of the following players that support RTSP streaming. Quick Time Player VLC Player 1. Launch the RTSP player. 2. Choose File > Open URL. A URL dialog box will prompt.
  • Page 20: 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 21: Using Vivotek Recording Software

    VIVOTEK Using VIVOTEK Recording Software The product software CD also contains recording software, allowing simultaneous monitoring and video recording for multiple Network Cameras. Please install the recording software; then launch the program to add the Network Camera to the Channel list. For detailed information about how to use the recording software, please refer to the user’s manual of the software or...
  • Page 22: Main Page

    VIVOTEK Main Page This chapter explains the screen elements on the main page. It is composed of the following sections: VIVOTEK INC. Logo, Host Name, Camera Control Area, Configuration Area, and Live Video Window. VIVOTEK logo Resize Buttons Configuration Area...
  • Page 23 VIVOTEK NOTE: Skip this section if you use the FD816C-HF2 in your configuration. Display mode: (This menu only displays with FE8182) This is a configuration menu exclusively designed for Fisheye lens. Due to the fisheye lens’ wide coverage of 180º hemispheric and 360º panoramic views and to manipulate the details within, the following display modes are provided: 1O - One Original fisheye view.
  • Page 24 VIVOTEK (Original) Display mode: 1O View (Original View) When mounted on a ceiling, the fisheye camera can cover an approximately 50 m² of surveillance area (hung at a height of approximately 3 meters), while still keeping details in videos with recognizable facial features of people trafficking through the area.
  • Page 25 Both panoramic views are corrected into a more viewable dewarped image. Viewers can use a mouse click and swipe to quickly scroll horizontally through the surveillance area. * Note that the dividing line falls approximately on the center of the VIVOTEK logo. 2P View (Panoramic View)
  • Page 26 VIVOTEK 1O3R (One Original & Three Regional) Display mode: The 1O3R mode provides access to multiple live view sections within the hemisphere and the reference to their relative positions on an Original circular view. The FOV indicators (#1 ~ #3) interact with your current operation as you may zoom in/out or move the live view window to a different place.
  • Page 27 VIVOTEK (Four Regional) Display mode: The view control and look and feel are identical to that as described in the 1O3R mode except the absence of the Original circular view. 4R PRO (Four Regional Proactive) Display mode: The 4R PRO mode is similar to the 4R mode except that the quad view windows consecutively rotate in correspondence to the change of view area in one window.
  • Page 28 VIVOTEK The following apply to both FD816C and FE8182. Video Stream: This Network Camera supports multiple streams (channel # and stream #1 ~ #3) simultaneously. You can select any one of them for live viewing. For more information about multiple streams, please refer to page 57 for detailed information.
  • Page 29 VIVOTEK Language: Click this button to choose a language for the user interface. Language options are available in: English, Deutsch, Español, Français, Italiano, 日本語 , Português, 簡体中文 , and 繁體中文 . You can also change a language on the Configuration page; please refer to page 37.
  • Page 30 VIVOTEK 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. Pause: Pause the transmission of the streaming media. The button becomes the Resume button after clicking the Pause button.
  • Page 31 VIVOTEK Video Title Time Video (HTTP-V) 2015/03/10 17:08:56 Title and Time Video 17:08:56 2015/03/10 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 48. Time: Display the current time. For more information, please refer to Media > Image on page 48.
  • Page 32 VIVOTEK Tips: The onscreen Java control can malfunction under the following situations: A PC connects to different cameras that are using the same IP address (or the same camera running different firmware versions). Removing your browser cookies will solve this problem.
  • Page 33: Client Settings

    VIVOTEK Client Settings This chapter explains how to select the stream transmission mode and saving options on the local computer. When completed with the settings on this page, click Save on the page bottom to enable the settings. H.264 Media Options Select to stream video or audio data or both.
  • Page 34: Mp4 Saving Options

    VIVOTEK MP4 Saving Options Users can record live video as they are watching it by clicking the “Start MP4 Recording” button on the main page. Here, you can specify the storage destination and file name. Folder: Specify a storage destination for the recorded video files.
  • Page 35 VIVOTEK Joystick settings (Available on FD816C-HF2) Enable Joystick Connect a joystick to a USB port on your management computer. Supported by the plug-in (Microsoft’s DirectX), once the plug-in for the web console is loaded, it will automatically detect if there is any joystick on the computer. The joystick should work properly without installing any other driver or software.
  • Page 36 VIVOTEK Buttons Configuration 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 37: 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 38: 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. System Host name: Enter a desired name for the Network Camera. The name will be displayed at the top center of the main page.
  • Page 39: 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 at the top of your homepage.
  • Page 40 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 41 VIVOTEK ■ Follow the steps below to set up a custom homepage: 1. Click Custom on the left column. 2. Click to select a color on on the right column. Color Selector Custom Pattern 3. The palette window will pop up as shown below.
  • Page 42: System > Logs

    VIVOTEK System > Logs This section explains how to configure the Network Camera to backup system log to a remote server. Log server settings Follow the steps below to set up the remote log: 1. Select Enable remote log. 2. In the IP address text box, enter the IP address of the remote server.
  • Page 43: System > Parameters

    The View Parameters page lists the entire system’s parameters in an alphabetical order. If you need technical assistance, use a text-editor program to copy and save the parameters listed on this page. Send the parameter text file to VIVOTEK’s technical support. User's Manual - 43...
  • Page 44: 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 specify the firmware file.
  • Page 45 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 65). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
  • Page 46 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 47 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 48: Media > Image

    VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following tabbed windows: General settings, Image settings, Exposure, Privacy mask, and Pixel Calculator. General settings Video title: Enter a name that will be displayed on the title bar of the live video as well as the view cell on the ST7501 and VAST recording software.
  • Page 49 VIVOTEK Video Title and Time Video 17:08:56 2011/03/13 2011/03/13 17:08:56 Color: Select to display color or black/white video streams. Power line frequency: Set the power line frequency consistent with local utility settings to eliminate image flickering associated with fluorescent lights.
  • Page 50: Image Settings

    VIVOTEK Image settings On this page, you can tune the White balance, Image adjustment and WDR enhanced parameters. You can configure two sets of preferred settings: one for normal situations, the other for special situations, such as day/night/schedule mode. White balance: Adjust the value for the best color temperature.
  • Page 51 VIVOTEK ■ Sharpness: Adjust the image sharpness level, which ranges from 0% to 100%. ■ Gamma curve: Adjust the image sharpness level, which ranges from 0.45 to 1, from Detailed to Contrast. You may let firmware Optimize your display or select the Manual mode, and pull the slide bar pointer to change the preferred level of Gamma correction towards higher contrast or towards the higher luminance for detailed expression for both dark and lighted areas of an image.
  • Page 52: Exposure

    VIVOTEK Exposure On this page, you can set the Exposure measurement window, Exposure level, Exposure mode, Exposure time, Gain control, and Day/Night mode settings. Measurement Window: This function allows users to set measurement window(s) for low light compensation. For example, where low-light objects are posed against an extremely bright background.
  • Page 53 VIVOTEK The inclusive window refers to the “weighed window“; the exclusive window refers to “ignored window“. It adopts the weighed averages method to calculate the value. The inclusive windows have a higher priority. You can overlap these windows, and, if you place an exclusive window within a larger inclusive window, the exclusive part of the overlapped windows will be deducted from the inclusive window.
  • Page 54: Privacy Mask

    VIVOTEK Privacy mask Click Privacy Mask to open the settings page. On this page, you can block out certain sensitive zones to address privacy concerns. ■ To set the privacy mask windows, follow the steps below: 1. Click New to add a new window. A text box will appear allowing you to enter a name for the mask.
  • Page 55: Pixel Calculator (Currently Available On Fe8182)

    VIVOTEK Pixel Calculator (Currently available on FE8182) Click the Add button at the lower screen to create a pixel calculator window. Place your cursor on the window to move it to an area of your interest, and change the size of window to fit the area of interest.
  • Page 56 VIVOTEK Take the following into consideration when using this feature: 1. Operational requirement: Identify a human or a human face. 2. Why human face? There are less variances in the size of a face than that for limbs and body. Human face is normally 16cm wide.
  • Page 57: Media > Video

    VIVOTEK Media > Video Stream settings Please follow the steps below to set up those settings for an individual stream: 1. Select a stream to configure its viewing region. 2. Choose a proper Frame Size from the drop-down list according to the size of monitored device.
  • Page 58 VIVOTEK The Viewing Window (Video Crop) function is only available on the fixed-focal camera (FD816C-HF2). Click Viewing Window to open the viewing region settings page. On this page, you can set the Region of Interest and the Output Frame Size for stream 1. If you prefer not to stream the full image the sensor can capture, you can designate a smaller region of interest.
  • Page 59 VIVOTEK Click the stream item to display the detailed information. This Network Camera offers real-time H.264 and MJPEG compression standards (dual Codec) for real- time viewing. If the H.264 mode is selected, the video is streamed via RTSP protocol. There are several parameters for you to adjust the video performance: ■...
  • Page 60 VIVOTEK ■ Intra frame period Determine how often 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 stream: Smart stream 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 If the JPEG mode is selected, the Network Camera continuously sends 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 64: 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 mute mode is turned on, no audio data will be transmitted even if audio transmission is enabled on the Client Settings page.
  • Page 65: 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 14 for details.
  • Page 66 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 name and IP address.
  • Page 67 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 68 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 69 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 70 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 71 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, or assigned to another port number between 1025 and 65535.
  • Page 72: 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 73 VIVOTEK URL command -- http://<ip address>:<http port>/<access name for stream 1 ~ 3> For example, when the Access name for stream 2 is set to video2.mjpg: 1. Launch Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter.
  • Page 74 NOTE: When using a fisheye lens model, an original, circular view will be displayed using all RTSP players. For access to the Regional Views, you can install VIVOTEK's ST7501 or VAST software. You can then right- click on a live view window to see the Display mode options.
  • Page 75 VIVOTEK RTSP port /RTP port for video, audio/ RTCP port for video, audio ■ RTSP (Real-Time Streaming Protocol) controls the delivery of streaming media. By default, the port number is set to 554. ■ The RTP (Real-time Transport Protocol) is used to deliver video and audio data to the clients. By default, the RTP port for video is set to 5556 and the RTP port for audio is set to 5558.
  • Page 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 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 78 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 79 VIVOTEK 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. This service will examine if the host name is valid and automatically open a port on your router. If using DDNS, the user has to manually configure UPnP port forwarding.
  • Page 80: Network > Qos (Quality Of Service)

    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 Account

    VIVOTEK Security > User Account 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” account first.
  • 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 re- turn 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 a 11. When the certifice file is successfully loaded, its status will be stated as Active. 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, #2, and #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 ■ Disconnect: If you want to break off the current connections, please select them and click this button. Please note that those checked connections will only be disconnected temporarily and will automatically try to re-link again (IE Explorer or Quick Time Player).
  • Page 93 VIVOTEK Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List. The routing prefix is written in CIDR notation. For example: accesses from IP address 192.168.2.x will be bolcked. If IPv6 filter is preferred, you will be prompted by the following window. Enter the IPv6 address and the two-digit prefix length to specify the range of IP addresses in your configuration.
  • Page 94: Security > Ieee 802.1X

    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. The PTZ function allows users to quickly move the focus to a target area for close-up viewing without physically zooming the camera. The screen from a fisheye lens model is shown Digital PTZ Operation (E-PTZ Operation) below.
  • Page 97 VIVOTEK 2. Adjust the shooting area to the desired position using the PTZ keypad, the FOV indicators, or mouse clicks on the live screen. To begin the mouse control, click on the two interactive windows. If you click on the Original view window, an FOV indicator will appear. You can click and hold down the left mouse button to drag the FOV indicator to a desired position.
  • Page 98 VIVOTEK Home page in Regional Display Mode Shown below is the display order of preset positions when you click on the Patrol button on the main page. Preset positions ■ The preset positions will also be displayed on the home page. Select one from the Go to drop-down list, and the preset position will display on one of the Regional view windows.
  • Page 99: 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 100 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 101 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 102 VIVOTEK Once the triggers are configured, they will be listed under the VADP option. 102 - User's Manual...
  • Page 103 VIVOTEK 3. Action Define the actions to be performed by the Network Camera when a trigger is activated. ■ Backup media if the network is disconnected Select this option to backup media file on SD card if the network is disconnected. Please note that this function will only apply after you set up the connection to networked storage (NAS).
  • Page 104: Add Server

    VIVOTEK Add server Click Add server to unfold the server setting window. You can specify how the notification messages are delivered when a trigger is activated. A total of 5 server settings can be configured. There are four choices of server types available: Email, FTP, HTTP, and Network storage. Select the item to display the detailed configuration options.
  • 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, then click Close to exit the Add server page.
  • 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. To verify if the FTP settings are correctly configured, click Test. The result will be shown in a pop-up window as shown below.
  • Page 107 VIVOTEK Network storage: Select to send the media files to a network storage location when a trigger is activated. Please refer to NAS server on page 125 for details. Click Save server to enable the settings, then click Close to exit the Add server page.
  • Page 108: Add Media

    VIVOTEK Add media Add media Click to open the media setting window. You can specify the type of media that will be sent when a trigger is activated. A total of 5 media settings can be configured. There are three choices of media types available: Snapshot, Video Clip, and System log.
  • Page 109 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_20150720_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings, then click Close to exit the Add media page.
  • Page 110 VIVOTEK ■ Maximum duration Specify the maximum recording duration in seconds. Up to 10 seconds of video can be recorded. For example, if pre-event recording is set to 5 seconds and the maximum duration is set to 10 seconds, the Network Camera continues to record for another 4 seconds after a trigger is activated.
  • Page 111 VIVOTEK ■ View: Click this button to open a file list window. This function is only for SD card and Network Storage. If you click View button of SD card, a Local storage page will pop up for you to manage recorded files on SD card.
  • Page 112 VIVOTEK Here is an example of the Event setting: When completed the settings with steps 1~3 to arrange Schedule, Trigger, and Action of an event, click Save event to enable the settings and click Close to exit the page. The following is an example of the Event setting 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’s technical support. Click to upload a file...
  • 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...
  • 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 99.
  • 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 99 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)

    VADP requirements. Please contact our technical support or the vendor of your 3rd-party module for the parameters contained within. • Users can also run VIVOTEK's VADP packages as a means to access updated functionality instead of replacing the entire firmware. •...
  • 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 Without Internet connection, you should acquire the license key elsewhere, and manually upload to the network camera. Follow the onscreen instruction on VIVOTEK's website for the registration procedure. You can proceed with the following link to download a license key: http://www.vivotek.com/...
  • 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: 1. Each Recording setting records a video stream from one channel, i.e., from a single lens module.
  • Page 124 VIVOTEK ■ Recording name: Enter a name for the recording setting. ■ Enable this recording: Select this option to enable video recording. ■ With adaptive recording: Select this option will activate the frame rate control according to alarm trigger. The frame control means that when there is a triggered alarm/event, the frame rate will raise up to the value you’ve set...
  • Page 125 VIVOTEK Please follow steps 1~2 below to set up the recording: 1. Trigger Select a trigger source. ■ Schedule: The server will start to record files on the local storage or network attached storage (NAS). ■ Network fail: Since network fail, the server will start to record files onto the local storage (SD card).
  • Page 126 VIVOTEK 2. Click Test to check the setting. The result will be shown in the pop-up window. If successful, you will receive a test.txt file on the networked storage server. 3. Enter a server name. 4. Click Save to complete the settings and click Close to exit the page.
  • Page 127 VIVOTEK ■ Enable cyclic recording: If you check this item, when the maximum capacity is reached, the oldest file will be overwritten by the latest one. Recording file management ■ Maximum duration: This determines the length of each recorded video, applicable from 1 to 60 minutes.
  • 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: Search Results

    VIVOTEK Search Results The following is an example of search results. There are four columns: Trigger time, Media type, Trigger type, and Locked. Click to sort the search results in either direction. Numbers of entries displayed on one page Click to open a live view ■...
  • Page 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: General Cgi Url Syntax And Parameters

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

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

    VIVOTEK Example: Request IP address and its response Request: http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&update=<value>][&return=<return page>] http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value>...
  • Page 136 VIVOTEK (Note: The return page can be a general HTML file(.htm, .html) or a VIVOTEK server script executable (.vspx) file. It cannot be a CGI commandor have any extra parameters.This parameter must be placed at the end of the parameter list Return: HTTP/1.0 200 OK\r\n...
  • Page 137: Available Parameters On The Server

    VIVOTEK 7. Available parameters on the server Valid values: VALID VALUES DESCRIPTION string[<n>] Text strings shorter than ‘n’ characters. The characters “,’,<,>,& are invalid. string[n~m] Text strings longer than `n’ characters and shorter than `m’ characters. The characters “,’,<,>,& are invalid.
  • Page 138 VIVOTEK W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 NOTE: The camera should not be restarted when parameters are changed. 138 - User's Manual...
  • 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 -140: GMT-03:30 Newfoundland -120: GMT-03:00 Brasilia, Buenos Aires, Georgetown, Greenland -80: GMT-02:00 Mid-Atlantic -40: GMT-01:00 Azores, Cape_Verde_IS. 0: GMT Casablanca, Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London 40: GMT 01:00 Amsterdam, Berlin, Rome, Stockholm, Vienna, Madrid, Paris 41: GMT 01:00 Warsaw, Budapest, Bern...
  • Page 141 VIVOTEK Caledonia 480: GMT 12:00 Aucklan, Wellington, Fiji, Kamchatka, Marshall Is. 520: GMT 13:00 Nuku'Alofa daylight_enable <boolean> Enable automaticdaylight saving time in time zone. daylight_dstactualmode <positive integer> Check if current time is under daylight saving time. (Used internally) daylight_auto_begintime string[19] Display the current daylight saving start time.
  • Page 142 VIVOTEK user has uploaded. This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results. restoreexceptvadp Restore the system parameters to default <positive integer>...
  • Page 143 VIVOTEK format:<MODEL-BRAND-VERSION> language_count <positive integer> Number of webpage languages available on the server. language_i<0~(count-1)> string[16] Available language lists. language_i0 : English language_i1 : Deutsch language_i2 : Español language_i3 : Français language_i4 : Italiano language_i5 : 日本 語 language_i6 : Português language_i7 : 简体...
  • Page 144 VIVOTEK 7.2status Group: status NAME VALUE SECURITY DESCRIPTION (get/set) di_i<0~(capability_ndi-1)> <boolean> 0 => Inactive, normal <product dependent> 1 => Active, triggered (capability.ndi > 0) do_i<0~(capability_ndo-1)> <boolean> 0 => Inactive, normal <product dependent> 1 => Active, triggered (capability.ndo > 0) onlinenum_rtsp 0,<positive...
  • Page 145 VIVOTEK 7.5security Group: security NAME VALUE SECURITY DESCRIPTION (get/set) privilege_do view, operator, Indicate which privileges and above can admin control digital output (capability.ndo > 0) privilege_camctrl view, operator, Indicate which privileges and above can admin control PTZ (capability.ptzenabled > 0 or capability.eptz >...
  • Page 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 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> Enable/disable IEEE 802.1x eapmethod eap-peap, eap-tls...
  • 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~(nmediastream-1)> string[32] RTSP access name for stream N, N= 1~ _accessname capability.nmediastream.
  • Page 151 VIVOTEK 7.6.8 SIP port Subgroup of network: sip (capability.protocol.sip> 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 1025 ~ 65535 SIP port. 7.6.9 RTP port Subgroup of network: rtp NAME VALUE SECURITY DESCRIPTION (get/set) videoport 1025 ~ 65535 Video channel port for RTP.
  • Page 152: Video Input

    VIVOTEK 1 => deny ipv4list_i<0~9> Single address: <ip IPv4 address list. address> Network address: <ip address / network mask> Range address:<start ip address - end ip address> ipv6list_i<0~9> string[43] IPv6 address list. 7.8Video input Group: videoin NAME VALUE SECURITY DESCRIPTION...
  • Page 153 VIVOTEK <product quality, but easy to meet rolling or flicker effect independent> in indoor environment. "indoor": Avoid rolling and flicker effect first. "fixed": Open the iris to maximum. * Only available when "capability_image_c<n>_iristype"=dciris enableblc <boolean> Enable backlight compensation. <Not support anymore>...
  • Page 154 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_minrange <n>_exposure_min " != "-" range" * Only valid when "piris_mode"=manual or "irismode"=fixed...
  • Page 155 VIVOTEK 7.8.1 Video input setting per channel Group: videoin_c<0~(n-1)> for n channel products, and m is stream number n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" NAME VALUE SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 CMOS frequency.
  • Page 156 VIVOTEK * Only available when "rbgain" is listed in "capability_image_c<n>_wbmode". * Only valid when "videoin_c<n>_whitebalance" != auto * Normalized range. exposurelevel 0~12 Exposure level "0,12": This range takes the concept from DC's exposure tuning options. The definition is: 0: EV -2.0 1: EV -1.7...
  • Page 157 VIVOTEK * Only available when "capability_image_c<n>_iristype"=pi piris_position 1~100 Manual set P-Iris. <product 1: Open <-> 100: Close dependent> * Only vaild when "piris_mode"=manual enableblc <boolean> Enable backlight compensation <Not support * Not support this parameter anymore anymore> when the version number (httpversion) is equal or greater than 0301a.
  • Page 158 VIVOTEK rotate 0,90,180,270 The rotation angle of image. Support only in Rotation mode (capability.videoin.c<n>.rotation=1) ptzstatus 0,<positive integer> A 32-bit integer, each bit can be set separately as follows: Bit 0 => Support camera control function; 0(not support), 1(support) Bit 1 =>Built-in or external camera;...
  • Page 159 VIVOTEK inrange" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed maxexposure <1~32000>, Maximum exposure time <5~32000>, 1~32000 => 1s ~ 1/32000s <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc. 5~8000 => 1/5s ~ 1/8000s etc.
  • Page 160 VIVOTEK s<0~(m-1)>_h 250, 500, 1000, 2000, 3000, 4000 Intra frame period in milliseconds. 264_intraperiod s<0~(m-1)>_h cbr, vbr, smart cbr: Constant bit rate mode. 264_ratecontrol vbr: Fixed quality mode, all frames are mode encoded in the same quality. smart: Smart stream mode. Only valid...
  • Page 161 VIVOTEK The maximum allowed bit rate in fixed  s<0~(m-1)>_h 20000~"capability_videoin_c<n>_mj " quality mode.  264_maxvbrbitr peg_maxbitrate When the bit rate exceeds this value,  frames will be dropped to restrict the  bit rate.    * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~"capability_videoin_c<n>_h264_m The maximum frame rates of a H264 264_maxframe axframerate" stream at different resolutions("capability_videoin_c0_re solution ") are recorded in "capability_videoin_c<n>_h264_maxf ramerate" s<0~(m-1)>_h...
  • Page 162 VIVOTEK "capability_videoin_codec". Set the pre‐defined quality level:  s<0~(m-1)>_h 1~5, 1: Medium  265_quant 99, 100 2: Standard  3: Good  4: Detailed  5: Excellent  100: Use the quality level in  "qpercent"  99: Use the quality level in "qvalue"    * Only available when h265 is listed in  "capability_videoin_codec" and    "ratecontrolmode"= vbr.  Manual video quality level input.   s<0~(m-1)>_h 0~51 The Q value which is used by encoded  265_qvalue library directly.  * Only available when h265 is listed in  "capability_videoin_codec".  * Only valid when "ratecontrolmode"=  vbr and  s<0~(m-1)>_h265_quant = s<0~(m-1)>_h 1~100 Select customized quality in a 265_qpercent normalized full range.
  • Page 163 VIVOTEK " quality mode.  265_maxvbrbitr peg_maxbitrate When the bit rate exceeds this value,  frames will be dropped to restrict the  bit rate.    * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~"capability_videoin_c<n>_h265_m The maximum frame rates of a H265 265_maxframe axframerate" stream at different resolutions("capability_videoin_c0_re solution ") are recorded in "capability_videoin_c<n>_h265_maxf...
  • Page 164 VIVOTEK s<0~(m-1)>_m 1~5, * Only valid when "ratecontrolmode"= jpeg_quant 99, 100 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"...
  • Page 165 VIVOTEK bit rate. * Only valid when "ratecontrolmode"= s<0~(m-1)>_m 1~"capability_videoin_c<n>_mjpeg_ The maximum frame rates of a mjpeg jpeg_maxframe maxframerate" stream at different resolutions("capability_videoin_c0_re solution ") are recorded in "capability_videoin_c<n>_mjpeg_ma xframerate" s<0~(m-1)>_m framerate,imagequality Set prioritypolicy jpeg_prioritypoli wdrpro_mode <boolean> Enable WDR pro <product...
  • Page 166 VIVOTEK aespeed_speedl 1~100 The speed level of AE converge speed.   evel 1~20: level 1 <product 21~40: level 2 dependent> 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher speed level meas shorter AE converged time during AE executing.
  • Page 167 VIVOTEK   enablewatermar 0, 1 0: Not to add watermarks on images 1: Add watermarks on images <product dependent> * Only available when "capability_fisheye" > 0   s<0~(m-2)>_fi ‘1O, 1P, 2P, 1R, 4R’ for ceiling/floor Local dewarp mode.   sheyedewarpmo mount “1O”...
  • Page 168 VIVOTEK n denotes the value of "capability_nvideoin",m denotes the value of " capability_nmediastream",k denotes the value of "capability_smartstream_nwindow_manual". NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the window. home 0~320,0~240 Left-top corner coordinate of the window. size 0~320x0~240 Width and height of the window 7.8.1.1 Alternative video input profiles per channel...
  • Page 169 VIVOTEK <5~32000>, 1~32000 => 1s ~ 1/32000s <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc. 5~8000 => 1/5s ~ 1/8000s etc. * Available value is listed in * This parameter may also restrict image "capability_image_c frame rate from sensor due to sensor <n>_exposure_ma...
  • Page 170 VIVOTEK 12: EV +2.0 whitebalance auto, manual, Modes of white balance. rbgain "auto": Auto white balance "rbgain": Use rgain and bgain to set white (Available values are balance manually. listed in "manual": 2 cases: "capability_image_c a. if "rbgain" is not supported, this means <n>_wbmode")
  • Page 171 VIVOTEK 0: Low <-> 100: High * Only available when "capability_image_c<n>_agc_mingain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. piris_mode manual, indoor, Control P-Iris mode. <product dependent> outdoor "outdoor": Auto-setting P-Iris to get best quality, but easy to meet rolling or flicker effect in indoor environment.
  • Page 172 VIVOTEK "capability_image_c<n>_wdrc_mode" is 1 wdrc_strength 1~100 The strength of WDR enhanced. <product dependent> The bigger value means the stronger strength of WDR enhanced. * Only available when "capability_image_c<n>_wdrc_mode" is 1 aespeed_mode <boolean> Turning AE converge speed on or off.  ...
  • Page 173 VIVOTEK 7.9Time Shift settings Group: timeshift for n channel profucts and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" (capability.timeshift > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable time shift streaming. c<0~(n-1)>_s<0~(m-1) <boolean>...
  • Page 174 VIVOTEK normal, high 7.11 Image setting per channel Group: image_c<0~(n-1)> for n channel profucts n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) brightness -5~5,100 -5: Darker <-> 5: Bright <Not recommended to use this> 100: Use " image_c<n>_brightnesspercent"...
  • Page 175 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 176 VIVOTEK * Note: Although we set gamma value to 100 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>...
  • Page 177 VIVOTEK dependent> "capability_image_c<n>_scenemode_suppor ttype" restoreatwb Restore of adjusting white balance of image according to mode settings profile_i0_enable <boolean> Enable/disable this profile setting profile_i0_policy night, The mode which the profile is applied to. schedule * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a.
  • Page 178 0: Softer <-> 100: Sharper * Only available when bit 3 of "capability_image_c<n>_basicsetting" is 1 profile_i0_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 178 - User's Manual...
  • Page 179 VIVOTEK 100: Gamma value = 1 * Note: Although we set gamma value to 100 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.
  • Page 180 VIVOTEK lpcparkinglot, "capability_image_c<n>_scenemode_suppor lpcstreet t" is 1 <product * Available value is listed in dependent> "capability_image_c<n>_scenemode_suppor ttype" 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...
  • Page 181 VIVOTEK homepx <0~W,0~H> Left-top corner coordinate of the window. W: 0~ The current image width -1 * Only available when px is listed in H: 0~ The current image height -1 "capability_image_c<n>_exposure_windomai n". sizepx <0~Wx0~ H> Width and height of the window.
  • Page 182 VIVOTEK Group: exposurewin_c<0~(n-1)>_profile_i<0~(m-1)>_win_i<0~(k-1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the value of "capability_nvideoinprofile", k denotes the value of "capability_image_c<n>_exposure_winnum". * Only valid when exposurewin_c<n>_mode=custom. NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean>...
  • Page 183 VIVOTEK * Only available when std is listed in "capability_image_c<n>_exposure_windomai n". 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.
  • Page 184 VIVOTEK 100: Maximum * Only available when the channel supports 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>...
  • Page 185 VIVOTEK 96000, 128000 s0_gamr_bitrate 4750, AMR encoded bitrate in bps. 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.
  • Page 186: Motion Detection Settings

    VIVOTEK greater than 0301a. profile_i0_begintime hh:mm Begin time of schedule mode. profile_i0_endtime hh:mm End time of schedule mode. 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"...
  • Page 187 VIVOTEK   image width -1 H: 0~ The current * Only available when px is listed in image height -1 "capability_motion_windomain * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
  • Page 188 VIVOTEK version number (httpversion) is equal or greater than 0400a. width 0 ~ 320 Width of motion detection window. <Not recommended to use * Only available when   this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain".
  • Page 189 VIVOTEK   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". NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable motion detection window.
  • Page 190 VIVOTEK * Only available when qvga is listed in "capability_motion_windomain * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. left 0 ~ 320 Left coordinate of window position.
  • Page 191 VIVOTEK greater than 0400a. height 0 ~ 240 Height 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 192 VIVOTEK 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" second(s), then image too blurry detection is triggered. 7.16 DDNS Group: ddns (capability.protocol.ddns > 0) NAME VALUE...
  • Page 193: System Log

    VIVOTEK 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> Enable or disable the UPnP port forwarding service.
  • Page 194 VIVOTEK 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 SECURITY DESCRIPTION (get/set) <boolean> SNMP v2 enabled. 0 for disable, 1 for enable <boolean>...
  • Page 195 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 196 VIVOTEK 7.23 Privacy mask Group: privacymask_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable privacy mask. win_i<0~4>_enable <boolean> Enable privacy mask window. win_i<0~4>_name string[14] Name of the privacy mask window.
  • Page 197 NAME VALUE SECURITY DESCRIPTION (get/set) api_httpversion <string> The version of VIVOTEK WebAPI with 4 This number start integers plus 1 alphabet, There are composed with 0301a. by "major version", "minor version", "revision","_platform". ex: 0301a_1 Major version Increase the major version when change,...
  • Page 198 VIVOTEK This is a constant, it is used to distinguish between different platforms API version format: MMmmr_k Where "MM" is the major version, "mm" is the minor version and "r" is the revision. 'M' and 'm' and 'k' are decimal digit from 0 to 9, while 'r' is an alphabetic.
  • Page 199 VIVOTEK <positive integer> no audio input support. naudioout The number of audio output channel <positive integer> nvideoin <positive integer> Number of video inputs. nvideoout 0, <Positive Number of video out interface. Integer> nvideoinprofile <positive integer> Number of video input profiles.
  • Page 200 VIVOTEK (only available when RS-485 interface is supported or SD/PZ/PT/PD/video server series) Bit 6 => Support iris operation; 0(not support), 1(support) Bit 7 => External or built-in PT; 0(built-in), 1(external) Bit 8 => Invalidate bit 1 ~ 7; 0(bit 1 ~ 7 are valid), 1(bit 1 ~ 7 are invalid) Bit 9 =>...
  • Page 201 VIVOTEK npreset 0, <positive Number of preset locations integer> eptz 0, <positive For "nvideoin" = 1, the definition is as integer> following: A 32-bits integer, each bit can be set separately as follows: Bit 0 => 1st stream supports ePTZ or not.
  • Page 202 VIVOTEK the product is fisheye or not. tampering <boolean> Indicate whether to support tampering detection. tamperingmode tamper,toodark,toob Available tampering mode list. right,tooblurry * Only available when "capability_tampering" is 1. adaptiverecording <boolean> Indicate whether to support adaptive recording. adaptivestreaming <boolean> Indicate whether to support adaptive streaming.
  • Page 203 VIVOTEK ckchannel multicast. protocol_rtp_tcp <boolean> Indicate whether to support RTP over TCP. protocol_rtp_http <boolean> Indicate whether to support RTP over HTTP. protocol_spush_mjpeg <boolean> Indicate whether to support server push MJPEG. protocol_snmp <boolean> Indicate whether to support SNMP. protocol_ipv6 <boolean> Indicate whether to support IPv6.
  • Page 204 VIVOTEK videoin_codec mjpeg, h264, h265 Available codec of a device, split by comma. <product The sequence is not limited. dependent> FD8183 supports H.264 and MJPEG, then this is "mjpeg,h264". IP9171 supports H.264, MJPEG and H.265, then this is "mjpeg,h264,h265" videoin_streamcodec A list of <Positive...
  • Page 205 VIVOTEK audio_mic <boolean> Indicate whether to support built-in <Not support anymore> microphone input. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * We replace "audio_mic" with "audio_intmic". audio_intmic <0~Positive Internal (Built-in) Microphone.
  • Page 206 VIVOTEK g711: G.711 g726: G.726 -: Not supported. audioout_codec g711, - Available codec list for SIP. <product -: Not supported. dependent> motion_wintype rectangle, polygon The supported motion window type. polygon: The motion window is a polygon shape. rectangle: The motion window is a rectangle shape.
  • Page 207 VIVOTEK *only available when "capability_smartstream_support" is 1 smartstream_nwindow_a <positive integer> Maximum number of tracking window of utotracking autotracking. *only available when "capability_smartstream_support" is 1 smartstream_nwindow_m <positive integer> Maximum number of tracking window of anual manual. *only available when "capability_smartstream_support" is 1 smartstream_nwindow_h <positive integer>...
  • Page 208 VIVOTEK thermal_temperaturedete <boolean> Indicate whether to support temperature ction detection. camctrl_httptunnel <boolean> Indicate whether to support httptunnel. <Not support anymore> * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301b. * It will be replaced by capability_camctrl_ptztunnel.
  • Page 209 VIVOTEK excepted) 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 210 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 211 VIVOTEK ircutfilter <boolean> Indicate whether to support IR cut. lightsensor <boolean> Indicate whether to support light sensor. Group: capability_videoin_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) The lens type of this channel.  lens_type fisheye, fixed, fisheye: Fisheye lens  varifocal, changeable, fixed: Build‐in fixed‐focus lens.  motor, - varifocal: Build‐in varifocal lens. ...
  • Page 212 VIVOTEK resolution A list of <WxH> Resolution options in current video mode. These <product dependent> options are the possible options for "videoin_c<n>_s<m>_resolution". The last one is the maximum resolution in current mode. maxresolution A list of <Integer> Represent supported maximum resolution of each stream in current video mode.
  • Page 213 VIVOTEK mjpeg_maxbitrate <positive integer>, - 0/7 Maximum bitrates of MJPEG. The unit is bps. "-" means MJPEG does not support bit rate control. * Only available when 'mjpeg' is listed in "capability_videoin_codec". h264_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer>...
  • Page 214 VIVOTEK h265_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer> and "-" H.265 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 215 VIVOTEK Group: capability_videoin_c<0~(n-1)>_localdewarp (capability_fisheyelocaldewarp_c<0~(capability_nvideoin)-1> > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) typeceilingmount 1O, 1P, 2P, 1R, 4R Available dewarp types of ceiling and floor mount. typewallmount 1O, 1P, 1R, 4R Available dewarp types of wall mount.
  • Page 216 VIVOTEK outputsize <WxH> The output size of source, equal to the captured size by device, in this video mode. The unit is pixel. This value is used as a basic coordinate system for many features, like ePTZ, privacy mask, motion, etc.
  • Page 217 VIVOTEK maxframerate A list of <Positive Indicates frame rate that the video source Integer> outputs in this video mode. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group.
  • Page 218 VIVOTEK maxfps_h265 A list of <Positive Maximum fps which the device can encoded with Integer> and "-" H.265 on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution"...
  • Page 219 VIVOTEK "-" means not support. * The element number is defined as "capability_nresolution". h264_bitrate A list of <Positive Default setting of h264 bitrate on resolutions in Integer> and "-" this video mode. "-" means not support. * The element number is defined as "capability_nresolution".
  • Page 220 VIVOTEK "capability_image_c<n>_wdrpro"=1, this may be either 0 or 1. wdrpro_supportlevel 0, <positive integer> This contains a list of positive integers, split by comma. If "wdrpro_mode" =1, then the value indicate the support strength level of WDR Pro. If "wdrpro_mode" =2, then the first...
  • Page 221 VIVOTEK level 6. "Value" can be a nonnegative integer or NULL. "-" means no feature is affected. * When "wdrpro"=0 and "wdrc"=0, this must be "-" wdrpro_description <string> Description about WDR Pro mode. * Only available when "capability_image_c<0~(n-1)>_wdrp ro_mode" > 0 wdrc_mode  ...
  • Page 222 VIVOTEK which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Value" can be a nonnegative integer or NULL. "-" means no feature is affected.
  • Page 223 VIVOTEK 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. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:"...
  • Page 224 VIVOTEK - (hidden) : UI is hidden. - (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:"...
  • Page 225 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 226 VIVOTEK 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. API name can be one word as well, such as "exposurelevel:fixed:6"...
  • Page 227 VIVOTEK   must be set to "-". exposure_winmode   auto,   Available options for custom, "exposurewin_c<n>_mode" blc,   * "-" means group: exposurewin is not supported. * When exposure_mode="0", this   must be set to "-". exposure_wintype   inclusive,  ...
  • Page 228 VIVOTEK   <product dependent> etc. "-" means maximum exposure time is not available. * When "exposure_mode"=0, this must be set to "-".   exposure_minrange   "1,32000",   Available range for "1,8000", "videoin_c<n>_minexposure" "1,32000" => 1s ~ 1/32000s or others  ...
  • Page 229 VIVOTEK flickerlessaffect When flickerless is enabled, some minexposure:hidden:, features may become malfunction or mingain:hidden:, be forced to a given value. The or others affected functions are list here. <x>: nonnegative integer The format is "Affect API <product dependent> name":"Policy":"Value" "Policy" can be categorized into...
  • Page 230 VIVOTEK 1: Support tuning strength of defog * If "capability_image_c<n>_defog_mode "=1, this may be either 0 or 1. defog_supportlevel 0, <positive integer> The value indicate the support strength level of defog. defog_affect When defog is enabled, some features wdrpro:unchanged:, may become malfunction or be forced or others to a given value.
  • Page 231 VIVOTEK "-" means no feature is affected. * When "defog" = 0, this must be "-" aespeed 0: Non-support AE speed 1: Support AE speed aespeedsupportlevel <positive integer> The value indicate the support strength level of aespeed. * Only available when "capability_image_c<n>_aespeed"...
  • Page 232: Event Setting

    VIVOTEK 7.25 Customized event script Group: event_customtaskfile_i<0~2> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Custom script identification of this entry. date string[4~20] Date of custom script. time string[4~20] Time of custom script. 7.26 Event setting Group: event_i<0~2> PARAMETER VALUE SECURITY...
  • Page 233 VIVOTEK 0,<positive integer> Indicate the source id of di trigger. This field is required when trigger condition is “di”. One bit represents one digital input. The LSB indicates DI 0. mdwin 0,<positive integer> Indicate the source window id of motion detection.
  • Page 234 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 235 VIVOTEK action_goto_name string[40] Specify the preset name that ptz goto on event <product dependent> triggered. * Only available when capability_ptzenabled > 7.27 Server setting for event action Group: server_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry...
  • Page 236 VIVOTEK ns_username string[64] Username to log in to the server. ns_passwd string[64] Password of the user. ns_workgroup string[64] Workgroup for network storage. 7.28 Media setting for event action Group: media_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry...
  • Page 237 VIVOTEK videoclip_prefix string[16] Indicate the prefix of the filename. videoclip_preevent 0 ~ " Indicates the time for pre-event capability_media_videoclip_maxpre recording in seconds. event" videoclip_maxduration 1 ~ " Maximum duration of one video clip in capability_media_videoclip_maxlen seconds. gth" videoclip_maxsize 50 ~ "...
  • Page 238 VIVOTEK maxretentiontime <string> To specify the expired time for automatic clean up, and it only takes effect for video clip generated by recording_i <0~1>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss]S’ , similar with ISO8601 with symbols P Ex. P7D, it means 7 days. P1DT10H, it means 1 days and 10 hours.
  • Page 239 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 240 State or province name in the certificate information. localityname string[128] The locality name in thecertificate information. organizationname string[64] Organization name in the certificate VIVOTEK Inc. information. unit string[64] Organizational unit name in thecertificate VIVOTEK Inc. information. commonname string[64] Common name in the certificate information.
  • Page 241 VIVOTEK 7.31 Storage management setting Group: disk_i<0~(n-1)> n is the total number of storage devices. (capability.storage.dbenabled > 0) Currently it’s only for local storage (SD, CF card), so n is equal to 1. PARAMETER VALUE SECURITY DESCRIPTION (get/set) cyclic_enabled <boolean>...
  • Page 242 VIVOTEK 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>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss]S’ , similar with ISO8601 with symbols P Ex. P7D, it means 7 days. P1DT10H, it means 1 days and 10 hours.
  • Page 243: Region Of Interest

    VIVOTEK 7.32 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 244: Eptz Setting

    VIVOTEK 7.33 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 display” or not smooth <boolean> Enable the ePTZ "move smoothly" feature tiltspeed -5 ~ 5 Tilt speed (It should be set by eCamCtrl.cgi rather than by...
  • Page 245 VIVOTEK preset_i<0~19>_pos <W,H> Left-top corner coordinate of the preset. <product dependent> (It should be set by ePreset.cgi rather than by setparam.cgi.) preset_i<0~19>_size <WxH> Width and height of the preset. <product dependent> (It should be set by ePreset.cgi rather than by setparam.cgi.)
  • Page 246 VIVOTEK guid<0~2>_number Number of connected seamless streaming with guid<0~2>_id. (Read only) 7.36 VIVOTEK Application Development Platformsetting Group: vadp NAME VALUE SECURITY DESCRIPTION (get/set) version <string> Indicate the VADP version. resource_total_memory 0,<positive integer> Indicate total available memory size for VADP modules.
  • Page 247 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 (capability_vadp_npackage > 0) n denotes the value of "capability_vadp_npackage".
  • Page 248 VIVOTEK 7.37 camera PTZ control Group: camctrl (capability.camctrl.ptztunnel > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enableptztunnel <boolean> Enable PTZ tunnel for camera control. Group: camctrl_c<0~(n-1)> for n channel products (capability.ptzenabled > 0) n denotes the value of "capability_nvideoin" NAME VALUE...
  • Page 249 VIVOTEK 7.38 UART control Group: uart (capability.nuart > 0 and capability.fisheye = 0) NAME VALUE SECURITY DESCRIPTION (get/set) ptzdrivers_i<0~19, string[40] Name of the PTZ driver. 127>_name ptzdrivers_i<0~19, string[128] Full path of the PTZ driver. 127>_location enablehttptunnel <boolean> Enable HTTP tunnel channel to control UART.
  • Page 250 VIVOTEK 7.39 Lens configuration Group: lens (capability.image.c<0~(n-1)>.lensconfiguration.support = 1) for n channel products n denotes the value of "capability_nvideoin" 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 251 VIVOTEK 7.40 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.41 Fisheye local dewarp setting   Group: fisheyedewarp_c<0~(n-1)> (capability_fisheyelocaldewarp_c<0~(capability_nvideoin)-1> > 0)  ...
  • Page 252 VIVOTEK 7.42 PIR behavior define Group: pir (capability.npir > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable PIR 252 - User's Manual...
  • Page 253: Drive The Digital Output

    VIVOTEK 8. Useful Functions Drive the Digital Output (capability.ndo > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/setdo.cgi?do1=<state>[&do2=<state>] [&do3=<state>][&do4=<state>] Where state is 0 or 1; “0” means inactive or normal state, while “1” means active or triggered state.
  • Page 254 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 255: Capture Single Snapshot

    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 256: Account Management

    VIVOTEK Account Management Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/editaccount.cgi? method=<value>&username=<name>[&userpass=<value>][&privilege=<value>] [&privilege=<value>][…][&return=<return page>] PARAMETER VALUE DESCRIPTION method Add an account to the server. When using this method, the“username” field is necessary. It will use the default value of other fields if not specified.
  • Page 257: System Logs

    VIVOTEK System Logs Note: This request require Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/syslog.cgi Server will return the most up-to-date system log. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <syslog length>\r\n \r\n <system log information>\r\n Upgrade Firmware Note: This request requires Administrator privileges.
  • Page 258 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 259 VIVOTEK http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed. To stop a continuous movement, you have to use the command as below: http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zoom=stop&zs=0 2. [Area zoom]: it means to zoom in on a specific area, here is an example for a directly moving...
  • Page 260 VIVOTEK <integer> The direction of movement, used for joystick control. <integer> 0 ~ 7 Set the speed of movement, “0” means stop. <integer> x-coordinate clicked by user. It will be the x-coordinate of center after movement. <integer> y-coordinate clicked by user.
  • Page 261 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 262 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 263 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>][&ret urn=<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 264 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 265 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 266 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 267 VIVOTEK 8.17 Senddata (capability.nuart > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/senddata.cgi? [com=<value>][&data=<value>][&flush=<value>] [&wait=<value>] [&read=<value>] PARAMETER VALUE DESCRIPTION 1 ~ <max. com port The target COM/RS485 port number. number> data <hex decimal The <hex decimal data> is a series of digits from 0 ~ 9, A ~ F. Each data>[,<hex decimal...
  • Page 268 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 269 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 270 VIVOTEK Command: update PARAMETER VALUE DESCRIPTION label <integer primary key> Required. Identify the designated record. Ex. label=1 isLocked <boolean> Required. Indicate if the file is locked or not. Ex. Update records whose key numbers are 1 and 5 to be locked status.
  • Page 271 VIVOTEK means inactive or normal Ex: vi0=0(200)1 state while “1” means Setting virtual input 0 to normal state, waiting 200 active or triggered state. milliseconds, setting it to trigger state. Where "nstate" is next Note that when the virtual input is waiting for next state, it state after duration.
  • Page 272 VIVOTEK 8.20 Open Timeshift Stream (capability.timeshift > 0, timeshift_enable=1, timeshift_c<n>_s<m>_allow=1) Note: This request requires Viewer access privileges. Syntax: For HTTP push server (MJPEG): http://<servername>/<network_http_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&reftime=<v alue>&forcechk&minsft=<value>] For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player.
  • Page 273 VIVOTEK Return Code Description 400 Bad Request Request is rejected because some parameter values are illegal. 415 Unsupported Media Type Returned, if forcechk appears,when minsft is not achievable or the timeshift feature of the target stream is not enabled. 8.21 Remote Focus Note: This request requires Administrator privileges.
  • Page 274 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 which replied from "function=getstatus" steps 1 ~ <motor_max> Motor’s moving steps. It works only if function= focus and direction=forward | backward.
  • Page 275 VIVOTEK 8.23 Upload Files Note: This request requires Administrator privileges. Method: POST Syntax: For daylight saving time configuration file: http://<servername>/cgi-bin/admin/upload_dst.cgi Post data: filename =<file name>\r\n \r\n <multipart encoded form data> For language file: http://<servername>/cgi-bin/admin/upload_lan.cgi Post data: filename =<file name>\r\n \r\n <multipart encoded form data>...
  • Page 276 VIVOTEK 8.24 Update Lens Configuration Note: This request requires Administrator privileges. Method: GET Syntax: For list all names of lens installed in camera: http://<servername>/cgi-bin/admin/update_lens.cgi?list_lens For choose selected lens configuration: http://<servername>/cgi-bin/admin/update_lens.cgi?choose_lens=<value> For delete selected lens configuration: http://<servername>/cgi-bin/admin/update_lens.cgi?delete_lens=<value> PARAMETER VALUE DESCRIPTION value <string>...
  • Page 277: Technical Specifications

    VIVOTEK 8.25 Media on demand (capability.localstorage.modnum > 0) Media on demand allows users to select and receive/watch/listen to metadata/video/audio contents on demand. Note: This request requires Viewer access privileges. Syntax: rtsp://<servername>/mod.sdp?[&stime=<value>][&etime=<value>][&length =<value>][&loctime =<value>][&file=<value>][&tsmode=<value>] PARAMETER VALUE DEFAULT DESCRIPTION stime <YYYYMMDD_HHMMSS.MMM> N/A Start time.
  • Page 278 VIVOTEK 8.26 Fisheye local dewarp camera control (capability.fisheye > 0 and capability.fisheyelocaldewarp.c0 > 0, only support in 1R mode) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/fdCamCtrl.cgi?channel=<value>&stream=<value> [&move=<value>] – Move home, up, down, left, right [&zoom=<value>] – Zoom wide, tele [[&speedpan=<value>][&speedtilt=<value>][&speedzoom=<value>]]...
  • Page 279: Technology License Notice

    VIVOTEK zoom wide Zoom larger view with current speed. tele Zoom further with current speed. speedpan -5 ~ 5 Set the pan speed of current command. speedtilt -5 ~ 5 Set the tilt speed of current command. speedzoom -5 ~ 5 Set the zoom speed of current command.
  • Page 280: Electromagnetic Compatibility (Emc)

    Buit-in Microphone Effective Range 5 Meters Network Users Live viewing for up to 10 clients All specifications are subject to change without notice. Copyright © VIVOTEK INC. All rights reserved. Ver. 10 VIVOTEK INC. VIVOTEK USA VIVOTEK Europe VIVOTEK India 6F, No.192, Lien-Cheng Rd., Chung-Ho,...
  • Page 281 RTCP, IGMP, SMTP, FTP, DHCP, NTP, DNS, DDNS, Protocols PPPoE, CoS, QoS, SNMP, 802.1X, UDP, ICMP, ARP, SSL, TLS All specifications are subject to change without notice. Copyright © VIVOTEK INC. All rights reserved. Ver. 5 VIVOTEK INC. VIVOTEK USA...
  • Page 282 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 283 取扱説明書に従って正しい取り扱いをして下さい Liability VIVOTEK Inc. cannot be held responsible for any technical or typographical errors and reserves the right to make changes to the product and manuals without prior notice. VIVOTEK Inc. makes no warranty of any kind with regard to the material contained within this document, including, but not limited to, the implied warranties of merchantability and fitness for any particular purpose.

This manual is also suitable for:

Fe8182

Table of Contents