Vivotek TD5328-VF2 User Manual
  1. Manuals
  2. Brands
  3. Vivotek Manuals
  4. Security Camera
  5. TD5328-VF2
  6. User manual

Vivotek TD5328-VF2 User Manual

Fixed dome network camera
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
TD5328-(E)VF2, TD5328-(E)TV
User 's Manual
H.264 • 2MP/5MP • 30M IR • P-iris • Smart Stream • Smart IR
Fixed Dome
Network Camera
Rev. 1.1

Advertisement

Table of Contents
loading

Related Manuals for Vivotek TD5328-VF2

Summary of Contents for Vivotek TD5328-VF2

  • Page 1 TD5328-(E)VF2, TD5328-(E)TV Fixed Dome Network Camera User ’s Manual H.264 • 2MP/5MP • 30M IR • P-iris • Smart Stream • Smart IR Rev. 1.1...

  • Page 2: Table Of Contents

    Applications > DI and DO ...........................123 Applications > Tampering detection ......................124 Applications > Audio detection ........................125 Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) ..127 Recording > Recording settings ........................130 Local storage > SD card management ......................135 Local storage >...

  • Page 3: Overview

    VIVTOTEK’s 5MP Lite series which offer up to 15 fps at 5-Megapixel or 30 fps at 1080p resolution at a competitive price. To create the perfect focus required to reap the benefits of higher resolutions, VIVOTEK’s TD5328 series provides the options of both fixed focus, used for simple operation without electrical power, and remote focus with built-in stepping motors and P-iris for precise adjustment remotely.

  • Page 4: Revision History

    VIVOTEK Revision History ■ Rev. 1.0: Initial release. ■ Rev. 1.1: Updated URL commands to rev. 1.4b. Read Before Use The use of surveillance devices may be prohibited by law in your country. The Network Camera is not only a high-performance web-ready camera but can also be part of a flexible surveillance system.

  • Page 5: Physical Description

    VIVOTEK Physical Description IR LEDs Motorized or fixed lens Terminal block SD/SDHC/SDXC Card Slot RJ45 Ethernet port Reset button NOTE: The "T" and "HT" models have an auto-focus motorized lens. Some of the suffix syntax are listed below: w/ heater for extreme weather...

  • Page 6: Hardware Installation

    VIVOTEK Hardware Installation 1. Jot down the camera's MAC address for later reference. This is especially important if you install numerous cameras at an installation site. Network Camera Model No: XXXXXX MAC: 0002D1083236 This device complies with part 15 of the FCC Rules. Operation is subject to...
  • Page 7 VIVOTEK 3. Loosen and remove the waterproof connectors. 4. Insert an Ethernet cable through the cable gland, and the rubber seal. 5. Remove part of cable sheath. 6. You will need an RJ45 crimping tool to attach the Ethernet wires to a connector. When done, connect the cable to the camera’s Ethernet RJ45 socket.
  • Page 8 VIVOTEK 7. If applied, connect DI/DO wires, 12V DC power, or audio wires to the terminal block. Name EXT_MIC_N EXT_MIC_P Audio_out- Audio_out+ 9 10 12V DC-_IN 10 12V DC+_IN 8. Attach the included alignment sticker to a preferred location. Drill holes for mounting screws and if preferred, drill one or two routing holes.
  • Page 9 VIVOTEK 9. When fastening the screws, do not completely tighten the screws. Pass cables through the routing holes, and then mount the camera by passing the screw heads through the keyhole slots. Turn the camera counter-clock wise, and then fasten the screws.
  • Page 10 Ø< 35mm 11. Install the "Installation Wizard 2" software utility from your software CD. The program will search for VIVOTEK Video Receivers, Video Servers or Network Cameras on the same LAN. Double-click on the camera’s MAC address to open a browser management session with the camera.
  • Page 11 VIVOTEK 12. With a live view displayed on your laptop, adjust the zoom and focus to obtain an optimal image. Check the live view to ensure the image is in focus. The "T" models comes with motorized focus lens. Use the Auto Focus function in firmware menu for best image.
  • Page 12 VIVOTEK 13. Align and install the dome cover. 14. Remove the protection membrane from the dome cover. LED Definitions Item LED status Description Steady Powered and system booting, or network failed LED off Power off Green LED off Network is disconnected...
  • Page 13 VIVOTEK Hardware Reset The reset button is used to reset the system or restore the factory default settings. Sometimes resetting the system can return the camera to normal operation. If the system problems remain after reset, restore the factory settings and install again.

  • Page 14: Network Deployment

    VIVOTEK Network Deployment General Connection (PoE) When using a PoE switch The Network Camera is PoE-compliant, allowing transmission of power and data via a sin- gle Ethernet cable. Follow the illustration below to connect the Network Camera to a PoE switch via an Ethernet cable.
  • Page 15 VIVOTEK Internet connection via a router Before setting up the Network Camera over the Internet, make sure you have a router and follow the steps below. 1. Connect your Network Camera behind a router, the Internet environment is illustrated below.
  • Page 16 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 17: 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 installer window will prompt. Click on the MAC and model name that matches the one printed on the product label.

  • Page 18: Ready To Use

    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. TD5328-VF2 18 - User's Manual...

  • Page 19: Auto Focus (For Motorized Lens Models Only)

    VIVOTEK Auto Focus (for Motorized Lens Models only) On the web console, visit the Configuration > Image > Focus window. Perform the Auto Focus function for best image focus. Focus here refers to the Remote Focus, applicable to Network Cameras that are equipped with a stepping motor lens.

  • Page 20: Accessing The Network Camera

    3. Live video will be displayed in your web browser. 4. If it is the first time installing the VIVOTEK network camera, an information bar will prompt as shown below. Follow the instructions to install the required plug-in on your computer.
  • Page 21 VIVOTEK ► By default, the Network Camera is not password-protected. To prevent unauthorized access, it is highly recommended to set a password for the Network Camera. For more information about how to enable password protection, please refer to Security on page 89.
  • Page 22 VIVOTEK IMPORTANT: • Currently the Network Camera utilizes 32-bit ActiveX plugin. You CAN NOT open a management/view session with the camera using a 64-bit IE browser. • If you encounter this problem, try execute the Iexplore.exe program from C:\Windows\ SysWOW64. A 32-bit version of IE browser will be installed.

  • Page 23: Using Rtsp Players

    VIVOTEK Using RTSP Players To view the streaming media using RTSP players, you can use one of the following players that support RTSP streaming. Quick Time Player VLC media player VLC media player 1. Launch the RTSP player. mpegable Player 2.

  • Page 24: 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 25: Using Vivotek Recording Software

    Network Camera to the Channel list. For detailed information about how to use the recording software, please refer to the user’s manual of the software or download it from http://www.vivotek.com. Tips: 1. If you forget the root (administrator) password for the camera, you can restore the camera defaults by pressing the reset button for longer than 5 seconds.

  • Page 26: Main Page

    VIVOTEK Main Page This chapter explains the layout of the main page. It is composed of the following sections: VIVOTEK INC. Logo, Host Name, Camera Control Area, Configuration Area, Menu, and Live Video Window. Resize Buttons VIVOTEK INC. Host Name...
  • Page 27 VIVOTEK Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 31. Configuration: Click this button to access the configuration page of the Network Camera. It is suggested that a password be applied to the Network Camera so that only the administrator can configure the Network Camera.
  • Page 28 VIVOTEK PTZ Panel: This Network Camera supports “digital“ (e-PTZ) pan/tilt/zoom control, which allows roaming a smaller view frame within a large view frame. Please refer to PTZ settiings on page 102 for detailed information. Global View: Click on this item to display the Global View window. The Global View window contains a full view image (the largest frame size of the captured video) and a floating frame (the viewing region of the current video stream).
  • Page 29 VIVOTEK Video Control Buttons: Depending on the Network Camera model and Network Camera configuration, some buttons may not be available. Snapshot: Click this button to capture and save still images. The captured images will be displayed in a pop-up window. Right-click the image and choose Save Picture As to save it in JPEG (*.jpg) or BMP (*.bmp) format.
  • Page 30 VIVOTEK Mute: Turn off the Mic volume on the local computer. The button becomes the Mic On button after clicking the Mute button. Full Screen: Click this button to switch to full screen mode. Press the “Esc” key to switch back to normal mode.

  • Page 31: 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 32 VIVOTEK Two way audio Half duplex: Audio is transmitted from one direction at a time, e.g., from a PC holding a web console with the camera. Full duplex: Audio is transmitted in both directions simultaneously. MP4 Saving Options Users can record live video as they are watching it by clicking Start MP4 Recording on the main page.
  • Page 33 VIVOTEK Joystick settings Enable Joystick Connect a joystick to a USB port on your management computer. Supported by the plug-in (Microsoft’s DirectX), once the plug-in for the web console is loaded, it will automatically detect if there is any joystick on the computer. The joystick should work properly without installing any other driver or software.
  • Page 34 VIVOTEK Buttons Configuration In the Button Configuration window, the left column shows the actions you can assign, and the right column shows the functional buttons and assigned actions. The number of buttons may differ from different joysticks. Please follow the steps below to configure your joystick buttons: 1.
  • Page 35 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 36: 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 37: System > General Settings

    VIVOTEK System > General settings This section explains how to configure the basic settings for the Network Camera, such as the host name and system time. It is composed of the following two columns: System, and System Time. When finished with the settings on this page, click Save at the bottom of the page to enable the settings.
  • Page 38 VIVOTEK System time Keep current date and time: Select this option to preserve the current date and time of the Network Camera. The Network Camera’s internal real-time clock maintains the date and time even when the power of the system is turned off.

  • Page 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 that is placed 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 the customed homepage: 1. Click Custom on the left column. 2. Click the field where you want to change the color on the right column. Color Selector Custom Pattern 3. The palette window will pop up as shown below.

  • Page 42: System > Logs

    VIVOTEK System > Logs This section explains how to configure the Network Camera to send the system log to a remote server as backup. Log server settings Follow the steps below to set up the remote log: 1. Select Enable remote log.
  • Page 43 Event Management function group for delivering event messages via emails, GSM short messages, onscreen event panel, or to trigger an alarm, etc. For more information, refer to the ST7501 or VAST User Manual. VIVOTEK Network Cameras Internet 3G Cell phone...

  • Page 44: System > Parameters

    System > Parameters The View Parameters page lists the entire system’s parameters. If you need technical assistance, please provide the information listed on this page. TD5328-VF2 44 - User's Manual...

  • Page 45: System > Maintenance

    Note: Do not power off the Network Camera during the upgrade! Follow the steps below to upgrade the firmware: 1. Download the latest firmware file from the VIVOTEK website. The file is in .pkg file format. 2. Click Browse… and locate the firmware file.
  • Page 46 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 72). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
  • Page 47 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 48 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 49: Media > Image

    VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. The Focus window is available only for models that come with motorized lens. General settings Video title Show_timestamp_and video_title_in_video_and_snapshots: Enter a name that will be displayed on the title bar of the live video as the picture shown below.
  • Page 50 VIVOTEK Video orientation: Flip - vertically reflect the display of the live video; Mirror - horizontally reflect the display of the live video. Select both options if the Network Camera is installed upside-down (e.g., on the ceiling) to correct the image orientation. Please note that if you have preset locations, those locations will be cleared after flip/mirror setting.
  • Page 51 VIVOTEK Smart IR (IMPORTANT: Smart IR is available when the external/built-in IR option is enabled) When enabled, the camera automatically adjust the IR projection to adjacent objects in order to avoid over-exposure in the night mode. The Smart IR function is more beneficial when the spot of intrusions or an object of your interest is close to the lens and the IR lights.
  • Page 52 The Network Camera automatically removes the IR cut filter when a Digital Input is triggerred. For example, the digital input can come from a housing that is equipped with IR illumination and control circuits such as VIVOTEK’s AE-241. 52 - User's Manual...
  • Page 53 VIVOTEK ■ Schedule mode The Network Camera switches between day mode and night mode based on a specified schedule. Enter the start and end time for day mode. Note that the time format is [hh:mm] and is expressed in 24-hour clock time. By default, the start and end time of day mode are set to 07:00 and 18:00.
  • Page 54 VIVOTEK Image settings On this page, you can tune the White balance and Image adjustment. Sensor Setting 2: For special situations Sensor Setting 1: For normal situations White balance: Adjust the value for the best color temperature. ■ You may follow the steps below to adjust the white balance to the best color temperature.
  • Page 55 VIVOTEK Noise reduction ■ Enable noise reduction: Check to enable noise reduction in order to reduce noises and flickers in image. This applies to the onboard 3D Noise Reduction feature. Use the pull-down menu to adjust the reduction strength. Note that applying this function to the video channel will consume system computing power.
  • Page 56 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. You can configure two sets of Exposure settings: one for normal situations, the other for special situations, such as the day/night/schedule mode.
  • Page 57 VIVOTEK The inclusive window refers to the “weighed window“; the exclusive window refers to “ignored window“. It adopts the weighed averages methodology 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 58 VIVOTEK Auto: If you set Exposure mode as Auto, the Exposure time and Gain control will not be configurable since the sensor library will automatically adjust the value according to the ambient light. Then you can configure iris mode as “indoor” or “outdoor” to reach the best image quality.
  • Page 59 VIVOTEK Focus (For models that come with a motorized lens) Focus here refers to the Remote Focus, and is applicable to Network Cameras that are equipped with stepping motor lens. The automated focus adjustment function eliminates the needs to physically adjust camera focus. In an outdoor deployment consisting of a large number of cameras, the auto focus function can be very helpful when these cameras become out of focus after days or weeks of operation.
  • Page 60 VIVOTEK 5. Wait for the scan to complete. After a short while, the clearest image obtained should be displayed and the optimal focus range achieved. Use the arrow marks on the sides to fine-tune the focus if you are not satisfied with the results. You may still need to use the arrow marks to fine-tune the focus depending on the live image on your screen.
  • Page 61 VIVOTEK Privacy mask Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to address privacy concerns. ■ To set the privacy mask windows, follow the steps below: 1. Click New to add a new window.

  • Page 62: Media > Video

    VIVOTEK Media > Video Mode (Available on 5MP resolution models) You can select different resolutions, 5 megapixel at the max. of 15fps and a lower 1080P Full HD resolution at a higher 30fps frame rate, with different aspect ratios, 4:3 or 16:9 for the video streams.
  • Page 63 VIVOTEK Stream settings This Network Camera supports multiple streams with frame sizes ranging from 176 x 144 to 1920 x 1080 pixels (2MP models). The 5MP model supports a maximum resolution of 2560 x 1920. The definition of multiple streams: ■...
  • Page 64 VIVOTEK Please follow the steps below to set up the configurations of a video stream: 1. Select a stream for which you want to set up the viewing region. 2. Select a Region of Interest from the drop-down list. The floating frame, the same as the one in the Global View window on the home page, will resize accordingly.
  • Page 65 VIVOTEK Click the stream item to display the detailed information. The maximum frame size will follow your settings in the above Viewing Window sections. This Network Camera provides a real-time H.264 or MJPEG compression standard (Dual Codec) for real-time viewing. If the H.264...
  • Page 66 VIVOTEK If the power line frequency is set to 50Hz, the frame rates are selectable at 1fps, 2fps, 3fps, 5fps, 8fps, 10fps, 15fps, 20fps, and 25fps. If the power line frequency is set to 60Hz, the frame rates are selectable at 1fps, 2fps, 3fps, 5fps, 8fps, 10fps, 15fps, 20fps, 25fps, and 30fps.
  • Page 67 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 68 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 69 VIVOTEK JPEG mode is selected, the Network Camera sends consecutive JPEG images to the client, producing a moving effect similar to a filmstrip. Every single JPEG image transmitted guarantees the same image quality, which in turn comes at the expense of variable bandwidth usage.

  • Page 70: Media > Audio

    VIVOTEK Media > Audio Audio Settings Mute: Select this option to disable audio transmission from the Network Camera to all clients. Note that if muted, no audio data will be transmitted even if audio transmission is enabled on the Client Settings page.

  • Page 71: Network > General Settings

    Use fixed IP address: Select this option to manually assign a static IP address to the Network Camera. 1. You can make use of VIVOTEK Installation Wizard 2 on the software CD to easily set up the Network Camera on LAN. Please refer to Software Installation on page 17 for details.
  • Page 72 VIVOTEK Primary DNS: The primary domain name server that translates hostnames into IP addresses. Secondary DNS: Secondary domain name server that backups the Primary DNS. Primary WINS server: The primary WINS server that maintains the database of computer names and IP addresses.
  • Page 73 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 74 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 75 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 8 or 9, Mozilla Firefox 6.0 or above.
  • Page 76 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 77 VIVOTEK Port HTTPS port: By default, the HTTPS port is set to 443. It can also be assigned to another port number between 1025 and 65535. Two way audio port: By default, the two way audio port is set to 5060. Also, it can also be assigned to another port number between 1025 and 65535.
  • Page 78 To stop talking, click again. FTP port: The FTP server allows the user to save recorded video clips. You can utilize VIVOTEK's Installation Wizard 2 to upgrade the firmware via FTP server. By default, the FTP port is set to 21.

  • Page 79: 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 89 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 80 VIVOTEK URL command -- http://<ip address>:<http port>/<access name for stream 1, 2, 3 or 4> For example, when the Access name for stream 2 is set to video2.mjpg: 1. Launch Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter.
  • Page 81 VIVOTEK Authentication: Depending on your network security requirements, the Network Camera provides three types of security settings for streaming via RTSP protocol: disable, basic, and digest. basic authentication is selected, the password is sent in plain text format, but there can be potential risks of it being intercepted.
  • Page 82 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 83 IP address, to have a consistent host and domain name. Express link Express Link is a free service provided by VIVOTEK server, which allows users to register a domain name for a network device. One URL can only be mapped to one MAC address.
  • Page 84 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 85 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 86 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 87 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 88: 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 89: Security > User Accounts

    VIVOTEK Security > User accounts This section explains how to enable password protection and create multiple accounts. Root Password The administrator account name is “root”, which is permanent and can not be deleted. If you want to add more accounts in the Manage User column, please apply the password for the “root”...

  • Page 90: 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 91 VIVOTEK 5. Click Save to preserve your configuration, and your current session with the camera will change to the encrypted connection. 6. If your web session does not automatically change to an encrypted HTTPS session, click Home to return to the main page. Change the URL address from “http://” to “https://“ in the address bar and press Enter on your keyboard.
  • Page 92 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 93 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 94 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 95 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 - 95...
  • Page 96 VIVOTEK Note that 11. When the certifice file is successfully loaded, its status will be stated as Active. a certificate must have been created and installed before you can click on the “Save" button for the configuration to take effect.

  • Page 97: Security > Access List

    VIVOTEK Security > Access List This section explains how to control access permission by verifying the client PC’s IP address. General Settings Maximum number of concurrent streaming connection(s) limited to: Simultaneous live viewing for 1~10 clients (including stream 1 to stream 3). The default value is 10. If you modify the value and click Save, all current connections will be disconnected and automatically attempt to re-link (IE Explorer or Quick Time Player).
  • Page 98 VIVOTEK ■ Refresh: Click this button to refresh all current connections. ■ Add to deny list: You can select entries from the Connection Status list and add them to the Deny List to deny access. Please note that those checked connections will only be disconnected temporarily and will automatically try to re-link again (IE Explorer or QuickTime Player).
  • Page 99 VIVOTEK There are three types of rules: Single: This rule allows the user to add an IP address to the Allowed/Denied list. For example: 192.168.2.1 Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List.
  • Page 100 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 101 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 102: Ptz > Ptz Settings

    VIVOTEK PTZ > PTZ settings This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation. Digital: Control the e-PTZ operation. Within a field of view,it allows users to quickly move the focus to a target area for close-up viewing without physically moving the camera.
  • Page 103 VIVOTEK Home page in the E-PTZ Mode x3.3 ■ The e-Preset Positions will also be displayed on the home page. Select one from the drop-down list, and the Network Camera will move to the selected position. ■ If you have set up different preset positions for different streams, you can select one of the video streams to display its separate preset positions.
  • Page 104 VIVOTEK Patrol settings You can select some preset positions for the Network Camera to patrol. Please follow the steps below to set up a patrol schedule: 1. Select the preset locations on the list, and click 2. The selected preset locations will be displayed on the Patrol locations list.
  • Page 105 VIVOTEK NOTE: ► The Preset Positions will also display on the Home page. Select one from the Go to menu, and the Network Camera will move to the selected position. ► Click Patrol: The Network Camera will patrol along the positions repeatedly.

  • Page 106: 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 devices connected via the digital input wires.
  • Page 107 VIVOTEK ■ Event name: Enter a name for the event setting. ■ Enable this event: Select this option to enable the event setting. ■ Priority: Select the relative importance of this event (High, Normal, or Low). Events with a higher priority setting will be executed first.
  • Page 108 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 109 VIVOTEK Once the triggers are configured, they will be listed under the VADP option. 3. Action Define the actions to be performed by the Network Camera when a trigger is activated. ■ Trigger digital output for seconds Select this option to turn on the external digital output device when a trigger is activated. Specify the length of the trigger interval in the text box.
  • Page 110 VIVOTEK Add server It is necessary to configure the server and media settings so that the Network Camera will know what action to take (such as which server to send the media files to) when a trigger is activated. Click server to open the server setting window.
  • Page 111 VIVOTEK To verify if the email settings are correctly configured, click Test. The result will be shown in a pop-up window. If successful, you will also receive an email indicating the result. Click Save server to enable the settings. Note that after you configure the first event server, the new event server will automatically display on the Server list.
  • Page 112 VIVOTEK ■ Passive mode Most firewalls do not accept new connections initiated from external requests. If the FTP server supports passive mode, select this option to enable passive mode FTP and allow data transmission to pass through the firewall. The firmware default has the Passive mode checkbox selected.
  • Page 113 VIVOTEK Network storage: Select to send the media files to a networked storage when a trigger is activated. Please refer to NAS server on page 133 for details. Note that only one NAS server can be configured. Click Save server to enable the settings.
  • Page 114 VIVOTEK Click 20150120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2015/01/20 2015/01/20 Click to go back to the previous Click to delete level of the directory selected items Click to delete all...
  • Page 115 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 116 VIVOTEK ■ Add date and time suffix to the file name Select this option to add a date/time suffix to the file name. For example: Snapshot_20150513_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings.
  • Page 117 VIVOTEK ■ Maximum file size Specify the maximum file size allowed. Some users may need to stitch the video clips together when searching and packing up forensic evidence. ■ File name prefix Enter the text that will be appended to the front of the file name.
  • Page 118 VIVOTEK In the Event settings column, the Servers and Medias you configured will be listed; please make sure the Event -> Status is indicated as ON, in order to enable the event triggering action. When completed, click the Save event button to enable the settings and click Close to exit Event Settings page.
  • Page 119 Please note that there is a limited number of customized scripts you can upload; if the current amount of customized scripts has reached the limit, an alert message will prompt. If you need more information, please contact VIVOTEK technical support. 20150213...

  • Page 120: Applications > Motion Detection

    VIVOTEK Applications > Motion detection This section explains how to configure the Network Camera to enable motion detection. A total of 5 motion detection windows can be configured. Motion Detection Setting 2: For special situations Motion Detection Setting 1: For normal situations Follow the steps below to enable motion detection: 1.
  • Page 121 VIVOTEK Photos or videos can be captured instantly and configured to be sent to a remote recepient (via an Email or FTP server). For more information on how to configure an event setting, please refer to Event settings on page 106.
  • Page 122 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 131 for detailed information. NOTE: ►...

  • Page 123: Applications > Di And Do

    VIVOTEK Applications > DI and DO Digital input: Select High or Low as the Normal status for the digital input. Connect the digital input pin of the Network Camera to an external device to detect the current connection status. Digital output: Select Grounded or Open to define the normal status for the digital output. Connect the digital output pin of the Network Camera to an external device to determine the current status.

  • Page 124: 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 125: 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 126 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 127: Applications > Package Management - A.k.a., Vadp (Vivotek Application Development Platform)

    Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) Users can store and execute VIVOTEK's or 3rd-party software modules onto the camera's flash memory or SD card. These software modules can apply in video analysis for intelligent video applications such as license plate recognition, object counting, or as an agent for edge recording, etc.
  • Page 128 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 129 Follow the onscreen instruction on VIVOTEK's website for the registration procedure. You can proced with the following link to download a license key: http://www.vivotek.com/ vadp_requestactivation.aspx?application=VCA When the license key is downloaded to your computer, upload the key to the camera.

  • Page 130: Recording > Recording Settings

    VIVOTEK Recording > Recording settings This section explains how to configure the recording settings for the Network Camera. Recording Settings Insert your SD card and click here to test NOTE: ► Please remember to format your SD card via the camera’s web console (in the Local storage .
  • Page 131 VIVOTEK If you enable adaptive recording on a camera, only when an event is triggered on Camera A will the server record the full frame rate streaming data; otherwise, it will only request the I frame data during normal monitoring, thus effectively saves bandwidths and storage space.
  • Page 132 VIVOTEK 2. Destination You can select the SD card or network storage (NAS) for the recorded video files. If you have not configured a NAS server, see details in the following. NAS server Click Add NAS server to open the server setting window and follow the steps below to set up: 1.
  • Page 133 VIVOTEK If successful, you will receive a test.txt file on the network storage server. 3. Enter a server name. 4. Click Save to complete the settings and click Close to exit the page. ■ Capacity: You can choose either the entire free space available or limit the reserved space. The recording size limit must be larger than the reserved amount for cyclic recording.
  • Page 134 VIVOTEK Event f you want to enable recording notification, please click to configure event triggering settings. Please refer to Event > Event settings on page 106 for more details. When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page.

  • Page 135: 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 is necessary.

  • Page 136: 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 137 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 138 VIVOTEK ■ Lock/Unlock: Select the checkbox in front of a desired search result, then click this button. The selected items will become Locked, and they will not be deleted during cyclic recording. You can click again to unlock the selections.

  • Page 139: 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 140 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 141 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 142 If you omit this parameter, it will redirect to an empty page. (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 142 - User's Manual...
  • Page 143 VIVOTEK placed at the end of the parameter list Return: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: <length>\r\n \r\n <parameter pair> where<parameter pair> is <parameter>=<value>\r\n [<parameter pair>] Only the parameters that you set and are readable will be returned. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123...
  • Page 144 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 145 VIVOTEK W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 NOTE: The camera should not be restarted when parameters are changed. User's Manual - 145...
  • Page 146 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 147 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 148 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 149 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 150 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 151 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 152 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 153 VIVOTEK Otherwise, the service may fail. Stopped service will auto-start after changing port settings. Change HTTP port from 80 to 5556, and change RTP port for video from 5556 to 20480. Then, set preprocess=9 to stop both service first. ”/cgi-bin/admin/setparam.cgi? network_preprocess=9&network_http_port=...
  • Page 154 VIVOTEK integer> ca_size 0,<positive CA file size (in bytes) integer> certificate_exist <boolean> Certificate installed flag (for TLS) certificate_time 0,<positive Certificate installed time. Represented in integer> EPOCH certificate_size 0,<positive Certificate file size (in bytes) integer> privatekey_exist <boolean> Private key installed flag (for TLS) privatekey_time 0,<positive...
  • Page 155 VIVOTEK 7.6.3 IPV6 Subgroup of network: ipv6 (capability.protocol.ipv6 > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable IPv6. addonipaddress <ip address> IPv6 IP address. addonprefixlen 0~128 IPv6 prefix length. addonrouter <ip address> IPv6 router address. addondns <ip address> IPv6 DNS address.
  • Page 156 VIVOTEK 7.6.6 HTTPS port Subgroup of network: https (capability.protocol.https > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 443, 1025 ~ 65535 HTTPS port. 7.6.7 RTSP Subgroup of network: rtsp (capability.protocol.rtsp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 554, 1025 ~ 65535 RTSP port.
  • Page 157 VIVOTEK metadataport 1026~65534 Multicast metadata port. 1 ~ 255 Multicasttime to live value. 7.6.8 SIP port Subgroup of network: sip (capability.protocol.sip> 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 1025 ~ 65535 SIP port. 7.6.9 RTP port Subgroup of network: rtp...
  • Page 158 VIVOTEK type 0, 1 Ipfilter policy : 0 => allow 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.
  • Page 159 VIVOTEK * Only available when "capability_image_c<n>_wbmode" !="-" exposurelevel 0~12 Exposure level "0,12": This range takes the concept from DC's exposure tuning options. The definition is: 0: EV -2.0 1: EV -1.7 2: EV -1.3 3: EV -1.0 4: EV -0.7 5: EV -0.3...
  • Page 160 VIVOTEK (capability.videoin.c<n>.rotation=1) ptzstatus 0,<positive A 32-bit integer, each bit can be set separately integer> as follows: Bit 0 => Support camera control function; 0(not support), 1(support) Bit 1 =>Built-in or external camera; 0 (external), 1(built-in) Bit 2 => Support pan operation; 0(not support), 1(support) Bit 3 =>...
  • Page 161 VIVOTEK * Available value is listed in * This parameter may also restrict image "capability_image_c frame rate from sensor due to sensor <n>_exposure_ma generates a frame per exposure time. Ex: If xrange" this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.
  • Page 162 VIVOTEK module. Then, act as rbgain mode "widerange": Auto Tracing White balance (2000K to 10000K). "outdoor": auto white balance mode specifically for outdoor. "indoor": auto white balance mode specifically for indoor. "sodiumauto": sodium vapor lamps. * Only available when "capability_image_c<n>_wbmode" != "-"...
  • Page 163 VIVOTEK 6: EV 0 7: EV +0.3 8: EV +0.7 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.0 exposuremode auto, Select exposure mode. <product shutterpriority, dependent> irispriority, "auto": Iris, Gain and Shutter manual, Speed(Exposure time) can be set automatically.
  • Page 164 VIVOTEK "manual": Manual set P-Iris by "piris_position". "-": not support. (only available when "capability_image_c<0~(n-1)>_sens ortype" is "smartsensor") * 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 or "capability_image_c<0~(n-1)>_sens...
  • Page 165 VIVOTEK 0: Low <-> 100: High * Only available when "capability_image_c<n>_agc_mingai n" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<n>_exposure_ra ngetype" is "twovalues". gainvalue 0~100 Gain value. 0: Low <-> 100: High * Only available when "capability_image_c<n>_agc_maxgai...
  • Page 166 VIVOTEK Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only) text string[64] Enclose caption. imprinttimesta <boolean> Overlay time stamp on video.
  • Page 167 VIVOTEK etc. 5~8000 => 1/5s ~ 1/8000s etc. * Available value is listed in "capability_image_c<n>_exposure_m * This parameter may also restrict axrange" image frame rate from sensor due to sensor generates a frame per exposure time. Ex: If this is set to 1/5s...
  • Page 168 VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0302a. enablepreview <boolean> Usage for UI of exposure settings. Preview settings of video profile. crop_position <coordinate> Crop left-top corner coordinate. (x,y) crop_size <window size>...
  • Page 169 VIVOTEK valid when "capability_smartstream_support"=1 and "capability_smartstream_version" is not equal "2.0") s<0~(m-1)>_h 1~5, Set the 264_quant 99, 100 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 170 VIVOTEK 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~5, 100 Set the pre-defined quality level: 264_cbr_quant 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only available when "ratecontrolm...
  • Page 171 VIVOTEK   s<0~(m-1)>_h framerate,imagequality Set prioritypolicy 264_prioritypoli *  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 Indicate H264 profiles 264_profile...
  • Page 172 VIVOTEK s<0~(m-1)>_h 250, 500, 1000, 2000, 3000, 4000 The time interval between two 265_intraperiod I-frames (Intra coded picture). The unit is millisecond (ms). * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_h cbr, vbr, smart cbr: Constant bit rate mode.
  • Page 173 VIVOTEK "capability_videoin_codec" and "ratecontrolmode"= vbr. s<0~(m-1)>_h 0~51 Manual video 265_qvalue quality level input. The Q value which is used by encoded 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...
  • Page 174 VIVOTEK quality level: 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only available when h265 is listed in "capability_videoin_codec" and "ratecontrolmode"= cbr. * Only available when "capability_smartstream_version"=2. s<0~(m-1)>_h 1~100 Select customized quality in a 265_cbr_qperce normalized full range.
  • Page 175 VIVOTEK s<0~(m-1)>_h 1~"capability_videoin_c<n>_h265_m The maximum frame rates of a H265 265_maxframe axframerate" stream at different resolutions("capability_videoin_c0_re solution ") are recorded in "capability_videoin_c<n>_h265_maxf ramerate" * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_h Indicate H265 profiles 265_profile 0: baseline 1: main profile...
  • Page 176 VIVOTEK ex: 0301a_2) <product dependent> s<0~(m-1)>_m 1~100 Select customized quality in a jpeg_qpercent normalized full range. 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"= vbr and s<0~(m-1)>_mjpeg_quant = 100. s<0~(m-1)>_m 20000~"capability_videoin_c<n>_mj The maximum allowed bit rate in fixed jpeg_maxvbrbit peg_maxbitrate"...
  • Page 177 VIVOTEK "capability_smartstream_version"=2. s<0~(m-1)>_m 20000~"capability_videoin_c<n>_mj The target bit rate in constant bit rate jpeg_bitrate peg_maxbitrate" mode. * Only valid when "ratecontrolmode"= s<0~(m-1)>_m framerate,imagequality Set prioritypolicy jpeg_prioritypoli * Only valid when "ratecontrolmode"= s<0~(m-1)>_m 1~"capability_videoin_c<n>_mjpeg_ The maximum frame rates of a mjpeg jpeg_maxframe maxframerate"...
  • Page 178 VIVOTEK dependent> 1: on * Only available when "capability_image_c<n>_aespeed" is 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)
  • Page 179 VIVOTEK * Only available when "capability_fisheye" > 0   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.
  • Page 180 VIVOTEK Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h265_smartstream_win_i<0~(k-1)> (capability_smartstream_support=1 and h265 is listed in "capability_videoin_codec" and capability_smartstream_mode_manual = 1) n denotes the value of "capability_nvideoin",m denotes the value of " capability_nmediastream",k denotes the value of "capability_smartstream_nwindow_manual". NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the window.
  • Page 181 VIVOTEK range" * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<n>_exposure_rangetyp e" is "twovalues". maxexposure <1~32000>, Maximum exposure time <product dependent> <5~32000>, 1~32000 => 1s ~ 1/32000s <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc.
  • Page 182 VIVOTEK * Only available when "capability_image_c<n>_exposure_maxrang e" != "-" and "capability_image_c<n>_exposure_rangetyp e" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. enableblc <boolean> Enable backlight compensation. <Not support anymore> * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.
  • Page 183 VIVOTEK "irispriority": Adjust with variable Iris, auto are list in "capability_image_c Gain and Shutter speed. <n>_exposure_mo "manual": Adjust with variable Shutter, Iris detype") and Gain. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 184 VIVOTEK * Only available when "rbgain" is listed in "capability_image_c<n>_wbmode". * Only valid when "videoin_c<n>_whitebalance" != auto * Normalized range. maxgain 0~100 Maximum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<n>_agc_maxgain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed...
  • Page 185 VIVOTEK 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. "indoor": Avoid rolling and flicker effect first. "manual": Manual set P-Iris by "piris_position".
  • Page 186 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 187 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 188 VIVOTEK capability_daynight There are two value format: _c<n>_ircutsensitiv "low,normal,high": if ity_type=options) capability_daynight_c<n>_ircutsensitivity_ty pe=options 1~100 (if capability_daynight "1~100": if _c<n>_ircutsensitiv capability_daynight_c<n>_ircutsensitivity_ty ity_type=normalize pe=normalize 7.11 Image setting per channel Group: image_c<0~(n-1)> for n channel profucts and m profile n denotes the value of "capability_nvideoin" and m denotes the value of "capability_nvideoinprofile"...
  • Page 189 VIVOTEK <Not recommended to use this> 100: Use " image_c<n>_saturationpercent" * Only available when bit 2 of "capability_image_c<n>_basicsetting" is 1. * We replace "saturation" with "saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
  • Page 190 VIVOTEK "capability_image_c<n>_basicsetting" is 1 gammacurve 0~100 0: Fine-turned gamma curve by Vivotek. 1: Gamma value = 0.01 2: Gamma value = 0.02 3: Gamma value = 0.03 100: Gamma value = 1 * Note: Although we set gamma value to 100 level, but not all gamma values are valid.
  • Page 191 VIVOTEK dis_mode <boolean> Digital image stabilizer <product dependent> 0:disable 1:enable * Only available when 'dis' is listed in "capability_image_c<n>_is_mode". dis_strength 1~100 Strength of digital image stabilizer <product dependent> * Only available when 'dis' is listed in "capability_image_c<n>_is_mode". scene_enable <boolean> Enable/disable scene mode <product dependent>...
  • Page 192 VIVOTEK "capability_image_c<n>_basicsetting" is 1 * We replace "profile_i0_brightness" with "profile_i0_brightnesspercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. profile_i<0~(m-1)>_contrast -5~5,100 -5: Less contrast <-> 5: More contrast <Not recommended to use this>...
  • Page 193 0: Softer <-> 100: Sharper * Only available when bit 3 of "capability_image_c<n>_basicsetting" is 1 profile_i<0~(m-1)>_gammacur 0~100 0: Fine-turned gamma curve by Vivotek. 1: Gamma value = 0.01 2: Gamma value = 0.02 3: Gamma value = 0.03 100: Gamma value = 1 * Note: Although we set gamma value to 100 level, but not all gamma values are valid.
  • Page 194 VIVOTEK profile_i<0~(m-1)>_dnr_stren 1~100 Strength of 3DNR * Only available when <product dependent> "capability_image_c<n>_dnr" is 1 profile_i<0~(m-1)>_defog_mo <boolean> Enable/disable defog mode. 0:disable <product dependent> 1:enable * Only available when "capability_image_c<n>_defog_mode" is 1 profile_i<0~(m-1)>_defog_str 1~100 Strength of defog ength * Only available when <product dependent>...
  • Page 195 VIVOTEK <product dependent> lpcparkinglot, "capability_image_c<n>_scenemode_support lpcstreet " is 1 <product * Available value is listed in dependent> "capability_image_c<n>_scenemode_support type" 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 196 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 197 VIVOTEK (Only valid when exposurewin_c<n>_mode=custom) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the window. policy 0: Indicate exclusive. 1: Indicate inclusive. * Only available when exclusive is listed in "capability_image_c<n>_exposure_wintype". home <0~320,0~240> Left-top corner coordinate of the window.
  • Page 198 VIVOTEK 7.13 Audio input per channel Group: audioin_c<0~(n-1)> for n channel products (capability.naudioin>0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) source micin, linein micin => use built-in microphone input. <Not recommended to use <product linein => use external microphone input.
  • Page 199 VIVOTEK "capability_audio_extmic" is equal to 1). mute 0, 1 0: Mute off 1: Mute on gain 0~100 Gain of input. <Not recommended to use (audioin_c<0~(n-1)>_source = linein) this> * Reserved for compatibility, and suggest don't use this since the version number (httpversion) is equal or greater than 0301a.
  • Page 200 VIVOTEK 5900, * Only available if AMR is supported. 6700, 7400, 7950, 10200, 12200 s0_g711_mode pcmu, Set G.711 companding algorithm. pcma pcmu: µ-law algorithm pcma: A-law algorithm * Only available if G.711 is supported. s0_g726_bitrate 16000, Set G.726 encoded bitrate in bps.
  • Page 201 VIVOTEK 7.14 Motion detection settings Group: motion_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable motion detection. win_sensitivity 1 ~ 100 Sensitivity of all motion detection windows. Group: motion_c<0~(n-1)>_win_i<0~(k-1)>  ...
  • Page 202 VIVOTEK * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. polygon 0 ~ 320,0 ~ 240, 0 Coordinate of polygon window position.   <Not recommended to use...
  • Page 203 VIVOTEK   this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. height 0 ~ 240 Height of motion detection window.
  • Page 204 VIVOTEK NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable motion detection window. name string[14] Name of motion window. polygonstd 0 ~ 9999,0 ~ 9999, Coordinate of polygon window position.   0 ~ 9999,0 ~ 9999, (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 0 ~ 9999,0 ~ 9999,...
  • Page 205 VIVOTEK * 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. <Not recommended to use * Only available when  ...
  • Page 206 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. 7.15 Tampering detection settings Group: tampering_c<0~(n-1)> for n channel products (capability.tampering >...
  • Page 207 VIVOTEK triggered. 7.16 DDNS Group: ddns (capability.protocol.ddns > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the dynamic DNS. provider CustomSafe100, Safe100 => safe100.net DyndnsDynamic, DyndnsDynamic => dyndns.org (dynamic) DyndnsCustom, DyndnsCustom => dyndns.org Safe100 CustomSafe100 => Custom server using safe100 method <provider>_hostname...
  • Page 208 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 209 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 210 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 211 VIVOTEK 7.23 Privacy mask Group: privacymask_c<0~(n-1)> for n channel products and m privacy mask window. n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable privacy mask. win_i<0~(m-1)>_enable <boolean>...
  • Page 212 VIVOTEK ~ W,0 ~ H "capability_image_c<n>_privacymask_wintype" W: 0~ The = polygon. current image width -1 * Only available when px is listed in H: 0~ The "capability_image_c<n>_privacymask_windomai current image height -1 win_i<0~(m-1)>_polygonstd 0 ~ 9999,0 ~ Coordinate of polygon window position.
  • Page 213 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 214 VIVOTEK document. The 5th character is model-based version for API bug-fix and it's default to "a". Ex: If some APIs in a model does not follow the API definition of 0301a_1, we will fix them and change this API value to 0301b_1.
  • Page 215 VIVOTEK More details, please refer the parameter description of "volume_internal" and "volume_external". nuart Number of UART interfaces. <positive integer> nmotion <positive integer> The number of motion window. nmotionprofile 0, <positive Number of motion profiles. integer> ptzenabled 0, <positive An 32-bit integer, each bit can be set integer>...
  • Page 216 VIVOTEK it means that the camera supports remotefocus function. bit 0 => Indicate whether to support both zoom and focus function. bit 1 => Only support zoom function. bit 2 => Only support focus function. bit 3 => Currently, this is a reserved bit, and the default value is 0.
  • Page 217 VIVOTEK 2nd bit of the group indicates 2nd stream of a channel support ePTZ or not, and so on. * For most products, the last stream of a channel will not support ePTZ. It is reserved for full view of the channel. For some dual-stream products, both streams support ePTZ.
  • Page 218 VIVOTEK "pir" = PIR detection "visignal" = Video input signal loss. "backup" = Backing up recorded files * Only available when [httpversion] >= 0301a storage_dbenabled <boolean> Media files are indexed in database. protocol_https < boolean > Indicate whether to support HTTP over SSL.
  • Page 219 VIVOTEK <product "capability_videoin_c0_resolution". dependent> * This is kept for compatibility. videoin_maxframerate A list of <Integer> This equals "capability_videoin_c0_maxframerate". * This is kept for compatibility. videoin_mjpeg_maxframe A list of <Integer> This equals rate and "-" "capability_videoin_c0_mjpeg_maxframerate ". * This is kept for compatibility.
  • Page 220 VIVOTEK "nvideoout"=1 with NTSC, "videoout_codec"=ntsc "nvideoout"=1 with PAL, "videoout_codec"=pal "nvideoout"=2 with both NTSC, "videoout_codec"=ntsc,ntsc * For camera, this feature is controlled by physical jump on device. No WebAPI to control it. This value is set only on camera power-on and maintains the status.
  • Page 221 VIVOTEK audio_extmic. audio_lineout <boolean> Indicate whether to support line output. audio_michardwareswitch <boolean> Indicate whether the hardware supports built-in/external mic switch audio_headphoneout <boolean> Indicate whether to support headphone <Not support anymore> output. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.
  • Page 222 VIVOTEK std: A normalized 0~9999 range. -: Not supported. *only available when "capability_smartstream_support" is 1 smartstream_mode_autot <boolean> Indicate whether autotracking smart stream is racking supported. *only available when "capability_smartstream_support" is 1 smartstream_mode_man <boolean> Indicate whether manual smart stream is supported.
  • Page 223 VIVOTEK vadp_supportfeature <positive integer> An 32-bit integer, each bit can be set separately as follows: Bit 0 => VADP interface Bit 1 => Capture video raw data Bit 2 => Support encode jpeg Bit 3 => Capture audio raw data Bit 4 =>...
  • Page 224 VIVOTEK 0: support only /cgi-bin/viewer/camctrl.cgi uart_httptunnel <boolean> Indicate whether to support HTTP tunnel for UART transfer. transmission_mode Indicate transmission mode of the machine: TX = server, Rx = receiver box, Both = DVR. Both network_wire <boolean> Indicate whether to support Ethernet.
  • Page 225 VIVOTEK media_videoclip_maxpree <positive integer> Maximum duration (second) after event vent occurred in a videoclip. image_iristype <string> Indicate iris type. <Not recommended to use "piris": P-Iris  this> "dciris": DC-Iris  "-": No Iris control support  * When "capability_iris"=0, this value must be "-".
  • Page 226 VIVOTEK localstorage_slconnum 0,<positive integer> The maximum seamless connection number. localstorage_smartsd <boolean> The "Lifetime and Log SD Card" feature allows users to obtain the card's remaining lifetime information. 0: Non-support this feature 1: Support this feature * Only Sony SD card can support this function now.
  • Page 227 VIVOTEK ircutsensitivity_type <string> Indicate the cgi interface of "ircutcontrol_sensitivity". "options": the value of "ircutcontrol_sensitivity" parameter is "low, normal,high". "normalize": the value of "ircutcontrol_sensitivity" parameter is "1~100" * Only available when "capability_daynight_c<n>_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 228 VIVOTEK streamcodec <positive integer> Represent supported codec types of each stream. This contains a list of positive integers, split by comma. Each one stands for a stream, and the definition is as following: Bit 0: Support MPEG4. Bit 1: Support MJPEG Bit 2: Support H.264...
  • Page 229 VIVOTEK mjpeg_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer> and "-" MJPEG on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution"...
  • Page 230 VIVOTEK h264_maxbitrate <positive integer> Maximum bitrates of H.264. The unit is bps. * Only available when 'h264' is listed in "capability_videoin_codec". h265_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer> and "-" H.265 on resolutions in current video mode.
  • Page 231 VIVOTEK cameraunit_name CU8131, A "camera unit" name of a split-type camera CU8171, system, which the camera unit and the video CU8161-H, core are separated. CU8162-H, -: If the camera is not a split-type camera CU8163-H, system, the value of this parameter is "-".
  • Page 232 VIVOTEK resolutionC2P A list of <WxH> Available resolutions of 2P mode of ceiling and floor mount. resolutionC1R A list of <WxH> Available resolutions of 1R mode of ceiling and floor mount. resolutionC4R A list of <WxH> Available resolutions of 4R mode of ceiling and floor mount.
  • Page 233 VIVOTEK binning 0, 1, 3 Indicate binning is used or not in this video mode. 0: No binning 1: 2x2 binning 3: 3x3 binning * Binning is a technology to increase light sensitivity by combining multiple pixels to one. The drawback is reduced resolution. We design this parameter to disclose this information.
  • Page 234 VIVOTEK maxfps_mjpeg A list of <Positive Maximum fps which the device can encoded with Integer> and "-" MJPEG on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution"...
  • Page 235 VIVOTEK Group: capability_videoin_c<0~(n-1)>_mode<0~(m-1)>_defaultsetting_s<0~(j-1)> n denotes the value of "capability_nvideoin", m denotes the value of "capability_videoin_c<n>_nmode", j denotes the value of "capability_nmediastream" PARAMETER VALUE SECURITY DESCRIPTION (get/set) resolution A list of <WxH> Default setting of resolution options. "-" means not support.
  • Page 236 VIVOTEK "capability_nresolution". h265_bitrate A list of <Positive Default setting of h265 bitrate on resolutions in Integer> and "-" this video mode. "-" means not support. * The element number is defined as "capability_nresolution". Group: capability_image_c<0~(n-1)> n denotes the value of "capability_nvideoin"...
  • Page 237 VIVOTEK exposurewin.mode.blc:disab value. The affected functions are list led:, here. aespeed:disabled:, exposurelevel:hidden:, The format is "Affect API exposurelevel:fixed:<x>, name":"Policy":"Value" exposurelevel:ranged:<x>- <x>, "Policy" can be categorized into exposuremode:fixed:auto following groups: - (disabled) : UI turns grey and users <x>: nonnegative integer can't select it.
  • Page 238 VIVOTEK WDR Enhanced. wdrc_affect     When WDR Pro or WDR Enhanced is exposurewin.mode:fixed:au enabled, some features may become malfunction or be forced to a given exposurewin.mode.blc:disab value. The affected functions are list led:, here. aespeed:disabled:, exposurelevel:hidden:, The format is "Affect API exposurelevel:fixed:<x>,...
  • Page 239 VIVOTEK 0: Non-support electronic image stabilizer 1: Support electronic image stabilizer is_mode eis, Indicate the image stabilizer mode. "eis": electronic image stabilizer dis, "dis": digital image stabilizer "-": not support * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 240 VIVOTEK <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden.
  • Page 241 VIVOTEK scenemode_visibility_affe When scene mode is enabled, some minexposure:hidden:, features may become malfunction or <product dependent> mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here. 3dnr:unchanged:, or others The format is "Affect API name":"Policy":"Value" <x>: nonnegative integer <product dependent>...
  • Page 242 VIVOTEK minexposure:hidden:, features may become malfunction or <product dependent> mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here. 3dnr:unchanged:, or others The format is "Affect API name":"Policy":"Value" <x>: nonnegative integer <product dependent> "Policy" can be categorized into...
  • Page 243 VIVOTEK <product dependent> mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here. 3dnr:unchanged:, or others The format is "Affect API name":"Policy":"Value" <x>: nonnegative integer <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it.
  • Page 244 VIVOTEK wdrpro:unchanged:, affected functions are list here. 3dnr:unchanged:,or others The format is "Affect API <x>: nonnegative integer name":"Policy":"Value" <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it.
  • Page 245 VIVOTEK outdoor,indoor, sodiumauto, <product dependent>       iristype piris, Indicate iris type. dciris, "piris": P-Iris   "dciris": DC-Iris "-": No Iris control support * Note: For some cameras, this value may be varied depending on mounted   lens. sensortype rawsensor, Indicate sensor type.
  • Page 246 VIVOTEK be up to the assigned value (videoin_c<n>_shuttervalue). "-": not support. * Only available when "capability_image_c<n>_exposure_ra ngetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_gainvaluetype fixed, * One to one mapping to the mode maximum, type in "exposure_modetype".
  • Page 247 VIVOTEK before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:"...
  • Page 248 VIVOTEK - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value.
  • Page 249 VIVOTEK <x>: nonnegative integer <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden.
  • Page 250 VIVOTEK exposurelevel:hidden:, or others The format is "Affect API name":"Policy":"Value" <x>: nonnegative integer <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it.
  • Page 251 VIVOTEK * When "exposure_mode"=0, this must be set to "-".       exposure_winmode auto, Available options for custom, "exposurewin_c<n>_mode" blc, * "-" means group: exposurewin is not   <product dependent> supported. * When exposure_mode="0", this must be set to "-".
  • Page 252 VIVOTEK "1,32000" => 1s ~ 1/32000s or others   "1,8000" => 1s ~ 1/8000s <product dependent>   etc. "-" means maximum exposure time is not available. * When "exposure_mode"=0, this must be set to "-".   exposure_minrange   "1,32000",  ...
  • Page 253 VIVOTEK   "-" "videoin_c<n>_mingain" “0,100” => 0~100 percent "-" means "videoin_c<n>_mingain" is not available.         flickerless 0: Non-support flickerless 1: Support flickerless   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.
  • Page 254 VIVOTEK * When "flickerless" = 0, this must be "-" defog_mode 0: Non-support defog 1: Support defog defog_strength 0, 1 0: Non-support tuning strength of defog 1: Support tuning strength of defog * If "capability_image_c<n>_defog_mode "=1, this may be either 0 or 1.
  • Page 255 VIVOTEK 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. * When "defog" = 0, this must be "-" aespeed 0: Non-support AE speed...
  • Page 256 VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0302a. autotrack_support <boolean> 0: Non-support auto tracking feature 1: Support auto tracking feature * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 257 VIVOTEK 7.26 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.27 Event setting Group: event_i<0~2> PARAMETER VALUE SECURITY...
  • Page 258 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 259 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 260 VIVOTEK action_goto_name string[40] Specify the preset name that ptz goto on event <product dependent> triggered. * Only available when capability_ptzenabled > 7.28 Server setting for event action Group: server_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry...
  • Page 261 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.29 Media setting for event action Group: media_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry...
  • Page 262 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 263 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 264 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 265 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 266 VIVOTEK 7.32 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 267 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 268 VIVOTEK 7.33 Region of interest Group: roi_c<0~(n-1)> for n channel product. (capability.eptz > 0) m denotes the value of "capability_nmediastream". PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-2)>_home <W,H> ROI left-top corner coordinate.* If the minimal <product dependent> window size is 64x64, then the "win_i0_home"=(0~resolution_W-64,...
  • Page 269 VIVOTEK tiltspeed -5 ~ 5 Tilt speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.) panspeed -5 ~ 5 Pan speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.) zoomspeed -5 ~ 5 Zoom speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.)
  • Page 270 VIVOTEK 7.35 Focus Window setting Group: focuswindow_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin". (capability_image_c<0~(n-1)>_backfocus=1 or capability_image_c<0~(n-1)>_remotefocus=1) PARAMETER VALUE SECURITY DESCRIPTION (get/set) win_i0_enable <boolean> Enable or disable the window. win_i0_home <W,H> Left-top corner coordinate of the window.
  • Page 271 VIVOTEK 7.37 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. resource_total_storage 0,<positive integer> Indicate total size of the internal storage space for storing VADP modules.
  • Page 272 Indicate the message that will be show on the running status when mouse over. vvtklicensemec string[40] Indicate the module use VIVOTEK license mechanism Group: vadp_schedule_i<0~(n-1)> for n VADP package number n denotes the value of "capability_vadp_npackage". (Only available when capability_vadp_npackage > 0 and the version number of "vadp_version" is equal or greater than 1.3.2.0)
  • Page 273 VIVOTEK 7.38 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 274 VIVOTEK 7.39 camera PTZ control (SD series) Group: camctrl (the bit7 of capability_ptzenabled is 0 and the bit4 of capability_ptzenable is 1) k denotes the value of "capability_npreset" NAME VALUE SECURITY DESCRIPTION (get/set) ccdtype string[16] (Internal used, read only) motortype...
  • Page 275 VIVOTEK The dwelling time of each patrol location disablemdonptz <boolean> Disable motion detection on PTZ operation. defaulthome <boolean> This field tells system to use default home position or not. axisx capability_ptz_minpan ~ Custom home pan position. capability_ptz_maxpan axisy capability_ptz_mintilt ~ Custom home tilt position.
  • Page 276 VIVOTEK tour_i<0~19>_checklist string[512] The indexes of preset positions, separated by “,” tour_i<0~19>_dwelltime string[512] Preset tour: time to wait before moving to the next preset position, separated by “,” Recorded tour: number of seconds to wait before continuing a loop tour.
  • Page 277 VIVOTEK speedlink_i<0~4>_name string[40] Additional PTZ command name. speedlink_i<0~4>_cmd string[40] Additional PTZ command list. ptzdriver 0~19, The PTZ driver is used by this COM port. 127 (custom), 128 (no driver) 7.41 UART control (SD series) Group: uart (capability.nuart > 0 and the bit7 of capability_ptzenabled is 0, the bit4 of capability_ptzenable is 1)
  • Page 278 VIVOTEK 7.42 Lens configuration Group: lens for n channel products n denotes the value of "capability_nvideoin" (capability.image.c<0~(n-1)>.lensconfiguration.support = 1) NAME VALUE SECURITY DESCRIPTION (get/set) selected <string> Current selected lens profile. e.g. lens_selected=lens_default_i0, it means choosen lens configuration is i0 lens of default group.
  • Page 279 VIVOTEK 7.43 Fisheye info Group: fisheyeinfo (capability.fisheye > 0) NAME VALUE SECURITY DESCRIPTION (get/set) revisedcenteraxis <coordinate> The actual center axis coordinate radius 0, <positive The actual center radius integer> 7.44 Fisheye local dewarp setting   Group: fisheyedewarp_c<0~(n-1)> (capability_fisheyelocaldewarp_c<0~(capability_nvideoin)-1> > 0)  ...
  • Page 280 VIVOTEK 7.46 Auto tracking setting Group: autotrack (capbility_image_c<0~(capability_nvideoin)-1>_autotrack_support > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) objsize_type -1~2 Type of object size. -1 : customized width and height 0 : object size = 30 x 30 1 : object size = 10 x 20...
  • Page 281 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 282 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 283 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 284 VIVOTEK Account Management Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/editaccount.cgi? method=<value>&username=<name>[&userpass=<value>][&privilege=<value>] [&privilege=<value>][…][&return=<return page>] PARAMETER VALUE DESCRIPTION method Add an account to the server. When using this method, the“username” field is necessary. It will use the default value of other fields if not specified.
  • Page 285 VIVOTEK System Logs Note: This request require Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/syslog.cgi Server will return the most up-to-date system log. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <syslog length>\r\n \r\n <system log information>\r\n Upgrade Firmware Note: This request requires Administrator privileges.
  • Page 286 VIVOTEK ePTZ Camera Control (capability.eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eCamCtrl.cgi?channel=<value>&stream=<value> [&move=<value>] – Move home, up, down, left, right [&auto=<value>] – Auto pan, patrol [&zoom=<value>] –Zoom in, out [&zooming=<value>&zs=<value>] –Zoom without stopping, used for joystick [&x=<value>&y=<value>&w=<value>&h=<value>&resolution=<value>] - Zoom in, out on a specific area...
  • Page 287 VIVOTEK http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed. To stop a continuous movement, you have to use the command as below: http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zoom=stop&zs=0 2. [Area zoom]: it means to zoom in on a specific area, here is an example for a directly moving...
  • Page 288 VIVOTEK <integer> The direction of movement, used for joystick control. <integer> 0 ~ 7 Set the speed of movement, “0” means stop. <integer> x-coordinate clicked by user. It will be the x-coordinate of center after movement. <integer> y-coordinate clicked by user.
  • Page 289 VIVOTEK recall Text string less than 40 One of the present positions to recall. characters 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.
  • Page 290 VIVOTEK 8.11 IP Filtering Note: This request requires Administrator access privileges. Method: GET/POST 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.
  • Page 291 VIVOTEK method addv4 Add IPv4 address into access list. addv6 Add IPv6 address into access list. delv4 Delete IPv4 address from access list. delv6 Delete IPv6 address from access list. <IP address> Single address: <IP address> Network address: <IP address / network mask>...
  • Page 292 VIVOTEK This channel will help to transfer the raw data of UART over the network. Please see UART tunnel spec for detail information PARAMETER VALUE DESCRIPTION channel 0 ~ (n-1) The channel number of UART. 8.14 Event/Control HTTP Tunnel Channel (capability.
  • Page 293 VIVOTEK 8.15 Get SDP of Streams Note: This request requires Viewer access privileges. Method: GET/POST Syntax: http://<servername>/<network_rtsp_s<0~m-1>_accessname> “m” is the stream number. “network_accessname_<0~(m-1)>” is the accessname for stream “1” to stream “m”. Please refer to the “subgroup of network: rtsp” for setting the accessname of SDP.
  • Page 294 VIVOTEK 8.17 Senddata (capability.nuart > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/senddata.cgi? [com=<value>][&data=<value>][&flush=<value>] [&wait=<value>] [&read=<value>] PARAMETER VALUE DESCRIPTION 1 ~ <max. com port The target COM/RS485 port number. number> data <hex decimal The <hex decimal data> is a series of digits from 0 ~ 9, A ~ F. Each data>[,<hex decimal...
  • Page 295 VIVOTEK 8.18 Storage managements (capability.storage.dbenabled > 0) Note: This request requires administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=<cmd_type>[&<parameter>=<value>…] The commands usage and their input arguments are as follows. PARAMETER VALUE DESCRIPTION cmd_type <string> Required. Command to be executed, including search, insert, delete, update, and queryStatus.
  • Page 296 VIVOTEK Indicate if the file is locked or not. 0: file is not locked. 1: file is locked. A locked file would not be removed from UI or cyclic storage. triggerTime <text> Optional. Indicate the event trigger time. (not the file created time) Format is “YYYY-MM-DD HH:MM:SS”...
  • Page 297 VIVOTEK 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 298 VIVOTEK 8.19 Virtual input (capability.nvi > 0) Note: Change virtual input (manual trigger) status. Method: GET Syntax: http://<servername>/cgi-bin/admin/setvi.cgi?vi0=<value>[&vi1=<value>][&vi2=<value>] [&return=<return page>] PARAMETER VALUE DESCRIPTION vi<num> state[(duration)nstate] Ex: vi0=1 Setting virtual input 0 to trigger state Where "state" is 0, 1. “0”...
  • Page 299 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 300 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 301 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 302 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 303 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 304 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 305 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 306 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 307 VIVOTEK 8.27 3D Privacy Mask (capability_image_c<0~(n-1)>_privacymask_wintype = 3Drectangle) n denotes the value of "capability_nvideoin" Note: This request requires admin user privilege Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/setpm3d.cgi?method=<value>&name=<value>&[maskheight=<value>& maskwidth=<value>&videosize=<value>&return=<return page>] PARAMETER VALUE DESCRIPTION method Add a 3D privacy mask at current location delete...
  • Page 308 VIVOTEK 8.28 Camera Control (capability.ptzenabled > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/camctrl.cgi?[channel=<value>][&camid=<value>] [&move=<value>] – Move home, up, down, left, right [&focus=<value>] – Focus operation [&auto=<value>] – Auto pan, patrol [&zoom=<value>] – Zoom in, out [&zooming=<value>&zs=<value>] – Zoom without stopping, used for joystick [&vx=<value>&vy=<value>&vs=<value>] –...
  • Page 309 VIVOTEK speedapp -5 ~ 5 Set the auto pan/patrol speed. auto Auto pan. patrol Auto patrol. stop Stop camera. zoom wide Zoom larger view with current speed. tele Zoom further with current speed. stop Stop zoom. zooming wide or tele Zoom without stopping for larger view or further view with zs speed, used for joystick control.
  • Page 310 VIVOTEK 8.29 Recall (capability.ptzenabled > 0) Note: This request requires Viewer privileges. Method: GET Syntax: http://<servername>/cgi-bin/viewer/recall.cgi? recall=<value>[&channel=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION recall string[30] One of the present positions to recall. channel 0~(capability_nvideoin-1) Channel of the video source. return <return page>...
  • Page 311 VIVOTEK The <return page> can be a full URL path or relative path according to the current path. If you omit this parameter, it will redirect to an empty page. <End of document> User's Manual - 311...
  • Page 312 AM-520 (v03) AM-713 L Shape Bracket Adapter Ring Mounting Adapter Conduit Box All specifications are subject to change without notice. Copyright © VIVOTEK INC. All rights reserved. Ver. 4 VIVOTEK INC. VIVOTEK USA VIVOTEK Europe VIVOTEK India 6F, No.192, Lien-Cheng Rd., Chung-Ho,...
  • Page 313 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 314 取扱説明書に従って正しい取り扱いをして下さい 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:

Td5328-etvTd5328-evf2Td5328-tv

Table of Contents