Download Print this page

DELTA GROUP Vivotek MA9321-EHTV User Manual

DELTA GROUP Vivotek MA9321-EHTV User Manual

Multi-sensor panoramic network camera

Table Of Contents

page of 432

/ 432
Contents
Table of Contents
Bookmarks

Table of Contents

Advertisement

Quick Links

Download this manual

MS9321-EHV-V2

Multi-sensor Panoramic Network Camera

User's Manual

18MP 30fps □ 30M IR □ WDR Pro □ SNV □ Panoramic View IP66 □

IK10 □ IP6K9K □ Smart Stream III □ Smart VCA

Rev. 1.0

Table of Contents

Advertisement

Table of Contents

Need help?

Need help?

Do you have a question about the Vivotek MA9321-EHTV and is the answer not in the manual?

Questions and answers

Summary of Contents for DELTA GROUP Vivotek MA9321-EHTV

Page 1 MS9321-EHV-V2 Multi-sensor Panoramic Network Camera User’s Manual 18MP 30fps □ 30M IR □ WDR Pro □ SNV □ Panoramic View IP66 □ IK10 □ IP6K9K □ Smart Stream III □ Smart VCA Rev. 1.0...
Page 2: Table Of Contents
VIVOTEK Table of Contents Overview ................................6 Revision History ................................7 Read Before Use ................................7 Package Contents ................................8 Symbols and Statements in this Document ........................8 Physical Description ................................ 11 802.3at .................................... 13 Software Installation ................................ 21 Accessing the Network Camera ........................32 Using Web Browsers ...............................
Page 3 VIVOTEK Storage > Content management ........................... 167 Appendix ................................. 170 URL Commands for the Network Camera ........................170 General CGI URL Syntax and Parameters ................171 Security Level ......................... 172 Get Server Parameter Values ....................173 Set Server Parameter Values ....................175 Available Parameters on the Server ..................
Page 4 VIVOTEK 7.17 Tampering Detection Settings ....................265 7.18 DDNS ............................266 7.19 Express Link ..........................267 7.20 UPnP Presentation ........................267 7.21 UPnP Port Forwarding ......................267 7.22 System Log ..........................268 7.23 SNMP ............................268 7.24 Layout Configuration ....................... 269 7.25 Privacy Mask ...........................
Page 5 VIVOTEK 7.47 PIR Behavior Define ........................ 383 7.48 Auto Tracking Setting ......................383 7.49 Wireless ..........................384 7.50 Shock Detection ........................386 7.51 Stream Profiles ........................386 Multicast Settings for Metadata Streaming ................387 7.52 Useful Functions ........................389 Query Status of the Digital Input (capability_ndi > 0) .............. 389 Query Status of the Digital Output (capability_ndo >...
Page 6: Overview
VIVOTEK 8.40.1 SFTP server setting for event action ......................438 8.40.2 SFTP Server Setting ............................ 443 Technology License Notice ............................445 Electromagnetic Compatibility (EMC) ........................... 446 Overview VIVOTEK's newly designed MS9321-EHV-V2 multi-sensor panoramic network camera offers the highest resolution and maximum field of view, reducing the total number of cameras required and helping save on the installation costs.
Page 7: Revision History
VIVOTEK Revision History ■ Rev. 1.0: Initial release. 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 8: Package Contents
VIVOTEK Package Contents ■ MS9321-EHV-V2 ■ AM-719 junction box ■ Screws ■ Alignment sticker ■ Quick Installation Guide ■ Hex L-wrench WARNING: 1. IR lights emit from this product. 2. Use appropriate shielding or eye protection. Symbols and Statements in this Document INFORMATION: provides important messages or advices that might help prevent inconvenient or problem situations.
Page 9 VIVOTEK NOTE: Camera Hardware Preventative Maintenance: 1. Visual inspection of all major components including accessories, cabling and connections where accessible for signs of deterioration or damage. 2. Check and clean cameras, lenses and housings inside and out as needed. • Please do not scratch, damage, or leave fingerprints on the dome/front cover and/or lens because this may decrease image quality.
Page 10 VIVOTEK IMPORTANT: 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. The HTTP-based camera interface provides the functionality to request a single image, control camera functions (PTZ, output relay etc.), and get and set internal parameter values.
Page 11: Physical Description
VIVOTEK Physical Description Front Panel Junction box Mount hole for 3/4" conduit; conduit is user-supplied. Lens IR lights Inner View MicroSD card slot Status LED Reset button User's Manual - 11...
Page 12 VIVOTEK NOTE: w/ heater for extreme weather Focal length w/ number w/ Remote focus lens w/ PoE repeater w/ High Dynamic Range functionality Power source Power consumption AC24V AC24V input: 26.4W PoE: 18.7 ~ 18.81W High Power PoE 12 - User's Manual...
Page 13 VIVOTEK Power Consumption 802.3at 24V 2A injector Due to its IR lights and onboard heater for operation in low temperature environments, care should be taken when selecting the power source for the camera. Listed below are the requirements for powering the camera: Use conditions Power consumption ≥-40ºC, heater on...
Page 14 VIVOTEK Wet contact with external DC power source to supply a relay. Switch DC 0V External DC power External AC power with Protected Earth Relay External Device 1. The DO+ pin provides a 5V output voltage, and the max. load is 50mA. 2.
Page 15 VIVOTEK Shooting Angle & Field of View 180º 62.5º is the blind spot area underneath the camera. The camera can be mounted at a height of 5 meters or higher to cover a panoramic view area with its center of view aiming at the horizon.
Page 16 VIVOTEK Hardware Installation 1. Jot down the camera's MAC address for later reference. XXXXXX 0002D10766AD 2. Loosen the 2 hex socket screws at the back of the camera. Install a MicroSD card if onboard storage is preferred. 16 - User's Manual...
Page 17 VIVOTEK 3. Attach the included alignment sticker to a preferred location. 4. Drill holes for mounting screws and/or a cabling hole. You can also route cables from the center using 3/4" conduits. AM-719 5. Use a coin to remove the plastic cover from a preferred routing hole. User's Manual - 17...
Page 18 VIVOTEK 6. Always form a drip loop by connecting the conduit from below. If you have a routing hole on a wall, you can also connect a conduit through it. Route cables through the conduit. Please do not connect a conduit from the top! Moisture accumulated in the conduit will eventually enter the box.
Page 19 VIVOTEK 8. See below for the DI, DO, power, and audio pinouts. Connect these wires if preferred. Use putties on the connection joints to prevent moisture. AC24V+ AC24V- MICP MICN DO+ (5V) 9. Pass an Ethernet cable through the waterproof cable gland components, and through the rubber seal as shown below.
Page 20 VIVOTEK 10. Secure the camera to the junction box using 4 included screws. Tighten the screws. 11. Remove the protective sheet from the front of the camera. 20 - User's Manual...
Page 21: Software Installation
VIVOTEK 12. Please visit VIVOTEK’s website to Install the "Shepherd” software utility. The program will search for VIVOTEK Video Receivers, Video Servers or Network Cameras on the same LAN. Double-click on the camera’s MAC address to open a web console to the camera. Shepherd Browser Software Installation...
Page 22 VIVOTEK 13-1. Run the Shepherd utility. 13-2. The program will conduct an analysis of your network environment. 13-3. The program will search for all VIVOTEK network devices on the same LAN. 13-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 23 VIVOTEK 14. The first time you log in to the camera, the firmware will prompt for a password root” as the username, and nothing for the password. strength requirement. The default name for the camera administrator is “root”, and cannot be changed. User's Manual - 23...
Page 24 VIVOTEK Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~. You can use them in the password combination. Message 24 - User's Manual...
Page 25 VIVOTEK you can check the live view at the installation site, at a position of your estimation. 15. With a live view displayed on your laptop, you can adjust the lens shooting direction to User's Manual - 25...
Page 26 VIVOTEK 16. You can move the camera from side to side, turn the lens shooting direction up or down, or rotate the module to cover the area of your interest. 26 - User's Manual...
Page 27 VIVOTEK Item LED status Description Steady Powered and system booting, or network failed LED off Power off Green LED off Network is disconnected Steady Green LED blinks every 1 Connected to network sec. Green LED blinks every 1 sec. and LED blinks consecutively every 0.15 sec.
Page 28 VIVOTEK Network Deployment General Connection (PoE) When using a PoE-enabled switch The Network Camera is PoE-compliant, allowing transmission of power and data via a sin- gle Ethernet cable. Follow the below illustration to connect the Network Camera to a PoE- enabled switch via Ethernet cable.
Page 29 VIVOTEK Internet connection via a router Before setting up the Network Camera over the Internet, make sure you have a router and follow the steps below. 1. Connect your Network Camera behind a router, the Internet environment is illustrated below. Regarding how to obtain your IP address, please refer to Software Installation on page 15 for details.
Page 30 VIVOTEK Configure the router, virtual server or firewall, so that the router can forward any data com- ing into a preconfigured port number to a network camera on the private network, and allow data from the camera to be transmitted to the outside of the network over the same path.
Page 31 VIVOTEK Ready to Use 1. A browser session with the Network Camera should prompt as shown below. 2. You should be able to see live video from your camera. You may also install the 32- channel recording software from the software CD in a deployment consisting of multiple cameras.
Page 32: Accessing The Network Camera
VIVOTEK Accessing the Network Camera This chapter explains how to access the Network Camera through web browsers, RTSP players, 3GPP-compatible mobile devices, and VIVOTEK recording software. Using Web Browsers Use Installation Wizard 2 (IW2) to access the Network Cameras on LAN. If your network environment is not a LAN, follow these steps to access the Network Camera: 1.
Page 33 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 114.
Page 34: 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. VLC media player VLC media player mpegable Player 1. Launch the RTSP player. 2. Choose File > Open URL. A URL dialog box will pop up. pvPlayer 3.
Page 35: 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 36: Using Vivotek Recording Software
VIVOTEK Using VIVOTEK Recording Software The VSS recording software allows simultaneous monitoring and video recording for multiple Network Cameras. Please install the recording software; then launch the program to add the Network Camera to the Channel list. For detailed information about how to use the recording software, please refer to the user’s manual of the software or download it from http://www.vivotek.com.
Page 37: 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 Host Name VIVOTEK INC. Configuration Area Logo Live View Window...
Page 38 VIVOTEK Configuration Area 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. For more information, please refer to Configuration on page 52. Language: Click this button to choose a language for the user interface.
Page 39 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 40 VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Time 2018/07/25 17:08:56 Title and Time Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 71.
Page 41 VIVOTEK MP4 Saving Options Users can record live video as they are watching it by clicking Start MP4 Recording on the main page. Here, you can specify the storage destination and file name. Folder: Specify a storage destination on your PC for the recorded video files. The location can be changed.
Page 42 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 43 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 44 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 45 VIVOTEK Click Configuration on the main page to enter the camera setting pages. Note that only 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 46: 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 47 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. Synchronize with computer time: Select this option to synchronize the date and time of the Network Camera with the local computer.
Page 48 VIVOTEK Western Argentina Summer Time (WARST) is 3 hours behind the prime meridian all year. There is a dummy fallback transition on December 31 at 25:00 daylight saving time (i.e., 24:00 standard time, equivalent to January 1 at 00:00 standard time), and a simultaneous spring-forward transition on January 1 at 00:00 standard time, so daylight saving time is in effect all year and the initial WART is a placeholder.
Page 49: System > Homepage Layout
VIVOTEK System > Homepage layout This section explains how to set up your own customized homepage layout. General settings This column shows the settings of your homepage layout. You can manually select the background and font colors in Theme Options (the second tab on this page). The settings will be displayed automatically MS9321-EHV-V2 ■...
Page 50 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 Save to enable the settings. MS9321-EHV-V2 Font Color Background Color of the Control Area...
Page 51 VIVOTEK ■ Follow the steps below to set up the customized 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. 4.
Page 52: 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. 2.
Page 53 VIVOTEK You can install the included VAST recording software, which provides an Event Management function group for delivering event messages via emails, GSM short messages, onscreen event panel, or to trigger an alarm, etc. For more information, refer to the VAST User Manual.
Page 54 VIVOTEK Access log Access log displays the access time and IP address of all viewers (including operators and administrators) in a chronological order. The access log is stored in the Network Camera’s buffer area and will be overwritten when reaching a certain limit. Set Parameter log VADP log contains the history of changes made to system parameters such as recording, imaging parameters, and all other parameters.
Page 55: System > Parameters
VIVOTEK 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. User's Manual - 55...
Page 56: System > Maintenance
VIVOTEK System > Maintenance This chapter explains how to restore the Network Camera to factory default, upgrade firmware version, etc. General settings > Upgrade firmware This feature allows you to upgrade the firmware of your Network Camera. It takes a few minutes to complete the process.
Page 57 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 95). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
Page 58 VIVOTEK Export language file: Click to export language strings. VIVOTEK provides nine languages: English, Deutsch, Español, Français, Italiano, 日本語, Português, 簡体中文, and 繁體中文 . : Click Browse… : Click Browse… Export server staus report: Click to export the current server status report, such as time, logs, etwork status, kernel message ...
Page 59: Media > Image
VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following columns: General settings, IR control, Image settings, Exposure, Focus, and Privacy mask. The Focus window is available only for models that come with motorized lens.
Page 60 VIVOTEK IR cut filter With a removable IR-cut filter, this Network Camera can automatically remove the filter to let Infrared light pass into the sensor during low light conditions. ■ Auto mode (The Day/Night Exposure Profile will not be available if Auto mode is selected) The Network Camera automatically removes the filter by judging the level of ambient light.
Page 61 VIVOTEK Illuminators Turn on built-in IR illuminator in night mode Select this to turn on the camera’s onboard IR illuminator when the camera detects low light condition and enters the night mode. Turn on external IR illuminator in night mode Select which DO (digital output) you use to trigger an external IR illuminator.
Page 62 VIVOTEK Tips: If there is an object in close proximity, the IR lights reflected back from it can mislead the Smart IR’s calculation of light level. To solve this problem, you can place “Exposure Exclude” window unavoidable object in the Exposure setting window. See page 74 for how to do it.
Page 63 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. 1.
Page 64 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 slide bar to adjust the reduction strength. Note that applying this function to the video channel will consume system computing power.
Page 65 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 66 VIVOTEK The inclusive window refers to the “weighted window“; the exclusive window refers to “ignored window“. It adopts the weighted averages method to calculate the value. The inclusive windows have a higher priority. You can overlap these windows, and, if you place an exclusive window within a larger inclusive window, the exclusive part of the overlapped windows will be deducted from the inclusive window.
Page 67 VIVOTEK Exposure control: ■ Exposure level: You can manually set the Exposure level, which ranges from -2.0 to +2.0 (dark to bright). You can click and drag the semi-circular pointers on the Exposure time and Gain control slide bars to specify a range of shutter time and Gain control values within which the camera can automatically tune to an optimal imaging result.
Page 68 VIVOTEK You can click Restore to recall the original settings without incorporating the changes. When completed with the settings on this page, click Save to enable the settings. If you want to configure another sensor setting for day/night/schedule mode, please click Profile to open the Profile of exposure settings page as shown below.
Page 69 VIVOTEK Privacy mask Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to address privacy concerns. ■ To configure privacy mask windows, 1. Click on the Enable privacy mask checkbox to enable this function. 2.
Page 70: Media > Video
VIVOTEK Media > Video Stream settings This Network Camera supports multiple streams with frame sizes ranging from 2340 x 832 to 6912 x 2624 pixels The definition of multiple streams: ■ Stream 1: The default frame size for Stream 1 is set to the 6912 x 2624. ■...
Page 71 VIVOTEK This Network Camera provides real-time H.265, H.264 and MJPEG compression standards (Triple Codec) for real-time viewing. If the H.265 H.264 mode is selected, the video is streamed via RTSP protocol. There are several parameters through which you can adjust the video performance: ■...
Page 72 VIVOTEK The frame rate will decrease if you select a higher resolution. ■ Intra frame period Determine how often for firmware to plant an I frame. The shorter the duration, the more likely you will get better video quality, but at the cost of higher network bandwidth consumption. Select the intra frame period from the following durations: 1/4 second, 1/2 second, 1 second, 2 seconds, 3 seconds, and 4 seconds.
Page 73 VIVOTEK VIVOTEK Dynamic Intra Frame w/ static scenes P P P P P P P P P P P P P P P P P P P I Static scene Dynamic Intra Frame w/ activities in scenes P P P P P P P I P P P P P P P IP P P Activities With the H.265 codec in an optimal scenario and when Dynamic Intra frame is combined with...
Page 74 VIVOTEK NOTE: Comparing with Smart Stream II, Smart Stream III has two more configurable options: Smart Smart FPS. 74 - User's Manual...
Page 75 VIVOTEK VIVOTEK • Smart codec: Smart codec effectively reduces the quality of the whole or the non- interested areas on a screen and therefore reduces the bandwidth consumed. You can manually specify the video quality for the foreground and the background areas.
Page 76 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 77 VIVOTEK VIVOTEK ■ Bit rate control Constrained bit rate: A complex scene generally produces a larger file size, meaning that higher bandwidth will be needed for data transmission. The bandwidth utilization is configurable to match a selected level, resulting in mutable video quality performance. The bit rates are selectable at the following rates: 20Kbps, 30Kbps, 40Kbps, 50Kbps, 64Kbps, 128Kbps, 256Kbps, 512Kbps, 768Kbps, 1Mbps, 2Mbps, 3Mbps, 4Mbps, 6Mbps, 8Mbps, 10Mbps, 12Mbps, 14Mbps, ~ to 80Mbps.
Page 78 VIVOTEK Fixed quality: On the other hand, if Fixed quality is selected, all frames are transmitted with the same quality; bandwidth utilization is therefore unpredictable. The video quality can be adjusted to the following settings: Medium, Standard, Good, Detailed, and Excellent. You can also select Customize and manually enter a value.
Page 79 VIVOTEK VIVOTEK If the JPEG mode is selected, the Network Camera sends consecutive JPEG images to the client, producing a moving effect similar to a filmstrip. Every single JPEG image transmitted guarantees the same image quality, which in turn comes at the expense of variable bandwidth usage. Because the media contents are a combination of JPEG images, no audio data is transmitted to the client.
Page 80: Media > Audio
VIVOTEK Media > Audio The available audio input can vary depending on whether you use an I/O extension module. Audio Settings Mute: Select this option to disable audio transmission from the Network Camera to all clients. Internal microphone input: Select the gain of the internal audio input according to ambient conditions.
Page 81 VIVOTEK VIVOTEK Audio clips ■ Output gain: Use the slide bar to change the audio output gains value. ■ Audio clip: When the camera's audio input is connected to a microphone, you can record a short period of audio recordings (1 to 10 seconds). You can also use the camera's embedded microphone to record an audio clip, if available.
Page 82: Media Profiles
VIVOTEK Media profiles You can configure a different video stream for each of the 3 default profiles, Max. view, Recording, Live view, and App. The related video stream information will display, including stream number, resolution, codec used, frame rate, etc. The Multicast port number, and address for video, audio, and Metadata configuration will also be listed.
Page 83: Network > General Settings
VIVOTEK VIVOTEK Network > General settings This section explains how to configure a wired network connection for the Network Camera. Network Type Select this option when the Network Camera is deployed on a local area network (LAN) and is intended to be accessed by local computers. The default setting for the Network Type is LAN. Please rememer to click on the Save button when you complete the Network setting.
Page 84 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. Secondary WINS server: The secondary WINS server that maintains the database of computer names and IP addresses.
Page 85 VIVOTEK 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 86 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 87 VIVOTEK VIVOTEK Enable IPv6 Select this option and click Save to enable IPv6 settings. Please note that this only works if your network environment and hardware equipment support ® IPv6. The browser should be Microsoft Internet Explorer 6.5, Mozilla Firefox 3.0 or above. When IPv6 is enabled, by default, the network camera will listen to router advertisements and be assigned with a link-local IPv6 address accordingly.
Page 88 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: IPv6 address 4.
Page 89 VIVOTEK VIVOTEK User's Manual - 89 VIVOTEK...
Page 90: Network > Streaming Protocols
VIVOTEK Network > Streaming protocols NOTE: The metadata information can only be transmitted through the HTTP main port. Metadata is not available through the secondary HTTP port. HTTP streaming To utilize HTTP authentication, make sure that your have set a password for the Network Camera Authentication: Depending on your network security requirements, the Network Camera provides two types of security settings for an HTTP transaction: basic and digest.
Page 91 VIVOTEK VIVOTEK URL command -- http://<ip address>:<http port>/<access name for stream 1, 2, 3> For example, when the Access name for stream 2 is set to video1s2.mjpg: 1. Launch your browser. 2. Type the above URL command in the address bar. Press Enter. 3.
Page 92 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 93 VIVOTEK VIVOTEK Multicast settings for streams: Click the items to display the detailed configuration information. Select the Always multicast option to enable multicast for video streams. Unicast video transmission delivers a stream through point-to-point transmission; multicast, on the other hand, sends a stream to the multicast group address and allows multiple clients to acquire the stream at the same time by requesting a copy from the multicast group address.
Page 94 VIVOTEK SIP is short for Session Initiation Protocol. If necessary, you can change the default port number, 5060, to one between 1025 and 65535. Two way audio port: 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 95: Network > Ddns
VIVOTEK VIVOTEK Network > DDNS Camera. DDNS is a service that allows your Network Camera, especially when assigned Express link Express Link is a free service provided by VIVOTEK server, which allows users to register a domain name for a network device. One URL can only be mapped to one MAC address. This service will examine if the host name is valid and automatically open a port on your Link is more convenient and easier to set up.
Page 96 VIVOTEK Manual setup 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 to access VIVOTEK’s Network Cameras from the is recommended that you register Safe100.net...
Page 97 VIVOTEK VIVOTEK [Register] Successfully Your account information has been mailed to registered e-mail address 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.
Page 98: Network > Qos (Quality Of Service)
VIVOTEK Network > QoS (Quality of Service) Quality of Service refers to a resource reservation control mechanism, which guarantees a certain quality to different services on the network. Quality of service guarantees are important if the network capacity is insufficient, especially for real-time streaming multimedia applications. Quality can be defined as, for instance, a maintained level of bit rate, low latency, no packet dropping, etc.
Page 99 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 101 VIVOTEK 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 102 VIVOTEK Network > FTP The newer firmware disabled the FTP port for security concerns. You can manually enable the FTP server service to enable the FTP function. You can disable the FTP server function when it is not in use. FTP port: The FTP server allows the user to save recorded video clips.
Page 103: Bonjour
VIVOTEK VIVOTEK Bonjour To access the camera from a Mac computer, go to Safari, click on Bonjour and select the camera from a drop-down list. You can go to Safari > Preferences to enter your user name and password, and provide the root password the first time you access the camera.
Page 104: Security > User Accounts
VIVOTEK Security > User accounts This section explains how to enable password protection and create multiple accounts. Account management The administrator account name is “root”, which is permanent and can not be deleted. If you want to add more accounts in the Account management window, please apply the password for the “root” account first.
Page 105 VIVOTEK VIVOTEK Privilege management Digital Output: You can modify the management privilege as operators or viewers. Select or de- select the checkboxes, and then click Save to enable the settings. If you give Viewers the privilege, Operators will also have the ability to control the Network Camera through the main page. (Please refer to Configuration on page 52).
Page 106 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 107 VIVOTEK VIVOTEK 5. Click Save 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 108 VIVOTEK Create certificate request and install 1. Select the option from the Method pull-down menu. 2. Click to proceed. 3. The following information will show up in a pop-up window after clicking Create. Then click Save Allow pop-ups if you are asked whether to do so. 118 - User's Manual...
Page 109: Security > Access List
VIVOTEK 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 110 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. 120 - User's Manual...
Page 111 VIVOTEK 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 - 121...
Page 112 VIVOTEK Note 11. When the certificate file is successfully loaded, its status will be stated as Active. that a certificate must have been created and installed before you can click on the “Save" button for the configuration to take effect. To begin an encrypted HTTPS session, click Home to return to the main page.
Page 113 VIVOTEK VIVOTEK Security > Access List Filter Enable access list filtering: Check this item and click Save if you want to enable the access list filtering function. Filter type: Select Allow or Deny as the filter type. If you choose Allow Type, only those clients whose IP addresses are on the Access List below can access the Network Camera, and the others cannot.
Page 114 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: Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List.
Page 115 VIVOTEK VIVOTEK Range: This rule allows the user to assign a range of IP addresses to the Allow/Deny List. Note: This rule only applies to IPv4 addresses. For example: Administrator IP address Always allow the IP address to access this device: You can check this item and add the Administrator’s IP address in this field to make sure the Administrator can always connect to the device.
Page 116: Security > Ieee 802.1X
VIVOTEK Security > IEEE 802.1X Enable this function if your network environment uses IEEE 802.1x, which is a port-based network access control. The network devices, intermediary switch/access point/hub, and RADIUS server must support and enable 802.1x settings. The 802.1x standard is designed to enhance the security of local area networks, which provides authentication to network devices (clients) attached to a network port (wired or wireless).
Page 117 VIVOTEK 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 118: Security > Miscellaneous
VIVOTEK Security > Miscellaneous The embedded TrendMicro utility provides the protection against Cross-Site Request Forgery. Cross-site request forgery is also known as one-click attack or session riding and is abbreviated as CSRF. CSRF is a type of malicious exploit of a website, in this case, the camera.
Page 119: Event > Event Settings
VIVOTEK VIVOTEK Event > Event settings This section explains how to configure the Network Camera to respond to particular situations (event). A typical application is that when a motion is detected, the Network Camera sends buffered images to an FTP server or e-mail address as notifications. Click on Help, there is an illustration shown in the pop-up window explaining that an event can be triggered by many sources, such as motion detection or external digital input devices.
Page 120 VIVOTEK ■ Event name: Enter a name for the event setting. ■ Enable this event: Select this checkbox to enable the event setting. ■ Priority: Select the relative importance of this event (High, Normal, or Low). Events with a higher priority setting will be executed first.
Page 121 VIVOTEK ■ Camera tampering detection This option allows the Network Camera to trigger when the camera detects that is is being tampered with. Please refer to page 152 for detailed information. ■ Manual Triggers This option allows users to enable event triggers manually by clicking the on/off button on the ■...
Page 122 VIVOTEK 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 123 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 124 VIVOTEK 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 125 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. To verify if the FTP settings are correctly configured, click Test.
Page 126 VIVOTEK VIVOTEK If key authentication is not preferred, you can specify a username and password in the section below. An RSA key fingerprint will look like this: da:47:93:b4:3a:90:5b:50:1f:20:a8:f9:b7:a1:d0:e1. Verify if this is the SFTP server you want to connect to. ■...
Page 127 VIVOTEK Public key mode: Selecting the Public key mode will bring up the Pairing mode options: Auto, Download, Upload. Auto Camera will generate a key pair and auto pair public key with the SFTP server. Download Camera will generate a key pair and download the public key for the user to upload it to the SFTP server.
Page 128 VIVOTEK VIVOTEK Server type - HTTP Select to send the media files to an HTTP server when a trigger is activated. ■ Server name: Enter a name for the server setting. ■ URL: Enter the URL of the HTTP server. ■...
Page 129 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 162 for details. Note that only one NAS server can be configured. Click Save server to enable the settings. ■...
Page 130 VIVOTEK VIVOTEK Click 20190120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2019/01/20 2019/01/20 Click to go back to the previous Click to delete level of the directory selected items Click to delete all recorded data 2019/01/20...
Page 131 VIVOTEK Add media Click Add media to open the media setting window. You can specify the type of media that will be sent when a trigger is activated. A total of 5 media settings can be configured. There are three choices of media types available: Snapshot, Video Clip, and System log.
Page 132 VIVOTEK 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_20190513_100341 File name preﬁx Date and time sufﬁx The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings. Note that after you set up the first media server, a new column for media server will automatically display on the Media list.
Page 133 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. For example: Video_20190513_100341 File name preﬁx...
Page 134 VIVOTEK 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 135: Applications > Motion Detection
VIVOTEK Applications > Motion detection The camera comes with a Smart Motion Detection utility as its pre-loaded VCA package. Please refer to its User Guide for more information: http://download.vivotek.com/downloadfile/solutions/vadp/smart-motion-detection-manual_ en.pdf. Click on Configuration > Applications > Motion detection. The Smart Motion utility will be automatically started.
Page 136: Applications > Smart Vca
VIVOTEK VIVOTEK Applications > Smart VCA Smart VCA provides the following features: Intrusion detection, Loitering detection, Missing object detection, Unattended Object detection, Line Crossing detection, and Face detection. Please refer to Smart VCA’s user documentation for more information. Click on Configuration > Applications > Smart VCA. The Smart VCA utility will be automatically started.
Page 137: Applications > Di And Do
VIVOTEK Applications > DI and DO Digital input: Select High or Low as the Normal status for the digital input connection. 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.
Page 138: Applications > Tampering Detection
VIVOTEK 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 139: 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 140 VIVOTEK 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 141: Applications > Shock Detection
VIVOTEK Applications > Shock detection The camera comes with a shock accelerometer. The shock sensor can detect impacts to the camera. For example, when a person deliberately tries to destroy the camera, the camera can report the event to the administrator. Normally, a 5kgm impact can cause the detected impact level to surge to 50% on the scale.
Page 142: Applications > Package Management - A.k.a., Vadp
VIVOTEK VIVOTEK Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) The Smart Motion detection, with Human detection and tunable time filter, can eliminate the defects of traditional motion detection and facilitate the configuration at a surveillance site. To learn more about this feature, download its User Guide in: http://download.vivotek.com/downloadfile/solutions/vadp/smart-motion-detection-manual_ en.pdf...
Page 143 VIVOTEK To utilize a software module, acquire the software package and click Browse and Upload buttons. The screen message for a successful upload is shown below: To start a module, select the check circle in front, and click the Start button. If you should need to remove a module, select the check circle in front and then click the Stop button.
Page 144 VIVOTEK VIVOTEK On the License page, register and activate the license for using VIVOTEK's VADP modules. You should acquire the license key elsewhere, and manually upload to the network camera. Follow the onscreen instruction on VIVOTEK's website for the registration procedure. 158 - User's Manual...
Page 145: 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 . SD card management page) when using it for the first time.
Page 146 VIVOTEK 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 147 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 148 VIVOTEK 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 149 VIVOTEK f you want to enable recording notification, please click Event to configure event triggering settings. Please refer to Event > Event settings on page 133 for more details. When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page.
Page 150: Storage
VIVOTEK VIVOTEK Storage NOTE: • It is recommended to turn OFF the recording activity before you remove an SD card from the camera. • The lifespan of an SD card is limited. Regular replacement of the SD card can be necessary. •...
Page 151: Storage > Nas 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. For example, if you enter “7 days”, the recorded files will be stored on the SD card for 7 days.
Page 152 VIVOTEK VIVOTEK 2. Click Test to check the setting. The result will be shown in the pop-up window. If successful, you will receive a test.txt file on the networked storage server. 3. Click Mount to complete the settings. NAS management ■...
Page 153: Storage > Content Management
VIVOTEK Storage > Content management This section explains how to manage the content of recorded videos on the Network Camera. Here you can search and view the records and view the searched results. Searching and Viewing the Records This column allows the user to set up search criteria for recorded data. If you do not select any criteria and click Search button, all recorded data will be listed in the Search Results column.
Page 154 VIVOTEK 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 155 VIVOTEK ■ Lock/Unlock: Select the checkbox in front of a desired search result, then click this button. The selected items will become Locked, which will not be deleted during cyclic recording. You can click again to unlock the selections. For example: Click to switch pages ■...
Page 156: Appendix
VIVOTEK 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 157: General Cgi Url Syntax And Parameters
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 3. General CGI URL Syntax and Parameters CGI parameters are written in lower-case and as one word without any underscores or other separators. When the CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server.
Page 158: Security Level
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 4. Security Level SECURITY LEVEL SUB-DIRECTORY DESCRIPTION anonymous Unprotected. 1 [view] viewer Can view, listen, and talk to camera. 4 [operator] operator Operator access rights can modify most of the camera’s parameters except some privileges and network options. 6 [admin] admin Administrator access rights can fully control the...
Page 159: Get Server Parameter Values
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 5. Get Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/viewer/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/operator/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/admin/getparam.cgi?[<parameter>] [&<parameter>…] Where the <parameter> should be <group>[_<name>] or <group>[.<name>]. If you do not specify any parameters, all the parameters on the server will be returned.
Page 160 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n User's Manual - 174...
Page 161: Set Server Parameter Values
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/operator/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/admin/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] PARAMETER DESCRIPTION <parameter>...
Page 162 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved [<parameter pair>] Only the parameters that you set and are readable will be returned. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123 Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n User's Manual - 176...
Page 163: Available Parameters On The Server
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7. Available Parameters on the Server Valid values: VALID VALUES DESCRIPTION string[<n>] Text strings shorter than ‘n’ characters. The characters “,’,<,>,& are invalid. string[n~m] Text strings longer than `n’ characters and shorter than `m’ characters. The characters “,’,<,>,&...
Page 164: System
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved VALID VALUES DESCRIPTION <WxH> The format for resolution. W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 available The API is listed in product WebAPIs. non-available The API is not in product WebAPIs.
Page 165 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <blank> timezoneindex -489 ~ 529 Indicate timezone and area. <Not recommended to -480: GMT-12:00 Eniwetok, Kwajalein use this> -440: GMT-11:00 Midway Island, Samoa -400: GMT-10:00 Hawaii -360: GMT-09:00 Alaska -320: GMT-08:00 Las Vegas, San_Francisco, Vancouver...
Page 166 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 120: GMT 03:00 Baghdad, Kuwait, Riyadh, Moscow, St. Petersburg, Nairobi 121: GMT 03:00 Iraq 140: GMT 03:30 Tehran 160: GMT 04:00 Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan 180: GMT 04:30 Kabul 200: GMT 05:00 Ekaterinburg, Islamabad, Karachi, Tashkent...
Page 167 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) time zone. daylight_auto_begintim string[19] Display the current daylight saving start time. daylight_auto_endtime string[19] Display the current daylight saving end time. daylight_timezones string List time zone index which support daylight saving time.
Page 168 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <positive values except all daylight saving time integer> settings. This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to default values except for a union of combined results.
Page 169: System.info
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) cus" != 0. restoreexceptlen Restore the system parameters to default <positive values except lens profile. integer> This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.
Page 170: Status
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) language_i1 : Deutsch language_i2 : Español language_i3 : Français language_i4 : Italiano language_i5 : 日本語 language_i6 : Português language_i7 : 简体中文 language_i8 : 繁體中文 customlanguage_max 0,<positive Maximum number of custom languages count integer>...
Page 171: Status Per Channel
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) onlinenum_httppush 0,<positive Current number of HTTP push server integer> connections. onlinenum_sip 0,<positive Current number of SIP connections. integer> eth_i0 <string> Get network information from mii-tool. vi_i<0~(capability_nvi-1)> <boolean> Virtual input <product dependent>...
Page 172: Security
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) normalstate open, Indicate open circuit or closed circuit grounded (inactive status) 7.5 Security Group: security NAME VALUE SECURITY DESCRIPTION (get/set) privilege_do view, operator, Indicate which privileges and above admin can control digital output (capability_ndo >...
Page 173 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Bit 2=> FTP service; Bit 3 => Two way audio and RTSP Streaming service; To stop service before changing its port settings. It’s recommended to set this parameter when change a service port to the port occupied by another service currently.
Page 174: 188
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) wins2 <ip address> Secondary WINS server. 7.6.1 802.1x Subgroup of network: ieee8021x (capability_protocol_ieee8021x > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable IEEE 802.1x eapmethod eap-peap, eap-tls Selected EAP method identity_peap string[64]...
Page 175: Ipv6
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) video Video channel for CoS audio Audio channel for CoS <product dependent> (capability_naudioin > 0) eventalarm Event/alarm channel for CoS management Management channel for CoS eventtunnel Event/Control channel for CoS Subgroup of network: qos_dscp (capability_protocol_qos_dscp >...
Page 176: Http
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) port 21, 1025~65535 Local ftp server port. enable <boolean> Enable ftp. 7.6.5 HTTP Subgroup of network: http NAME VALUE SECURITY DESCRIPTION (get/set) port 80, 1025 ~ HTTP port. 65535 alternateport 1025~65535...
Page 177: Http Per Channel
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.6.6 HTTP per Channel Subgroup of network: http_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) s<0~(capability_nmedia string[32] Http server push access name for stream-1)>_accessname channel N and stream M, N= 1~ capability_nvideoin, M= 1~ <product dependent>...
Page 178 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) port 554, 1025 ~ 65535 RTSP port. (capability_protocol_rtsp=1) authmode disable, RTSP authentication mode. basic, (capability_protocol_rtsp=1) digest s<0~(capability_nmed string[32] RTSP access name for channel and iastream*capability_n stream. videoin)-1)>_accessna (capability_protocol_spush_mjpeg =1 and capability_nmediastream >...
Page 179: Rtsp Multicast
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) (channel1stream3) live1s4.sdp = c0_s3_accessname, (channel1stream4) etc. * Values start with prefix “cgi-bin” are prohibited. For example, “c, cg, cgi, cgi-, cgi-b, cgi-bi, cgi-bin” are not allowed. * We modify the value of RTSP access name after version number(httpversion) is 0311c pimssm_enable...
Page 180: Sip Port
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0304a. audioipaddress <ip Multicast audio IP address. <product address> * We support this parameter when the version dependent> number (httpversion) is equal or greater than 0304a. * Only available when capability_naudioin > 0 metadataipaddres <ip Multicast metadata IP address.
Page 181: Pppoe
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) metadataport 1025 ~ 65535 Metadata channel port for RTP. 7.6.12 PPPoE Subgroup of network: pppoe (capability_protocol_pppoe > 0) NAME VALUE SECURITY DESCRIPTION (get/set) user string[128] PPPoE account user name. pass password[64] PPPoE account password.
Page 182: Video Input
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable access list filtering. admin_enable <boolean> Enable administrator IP address. admin_ip string[43] Administrator IP address. maxconnection Maximum number of (s). "capability_protoc ol_maxconnection" type 0, 1 Ipfilter policy : 0 =>...
Page 183 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <product dependent> panorama, "auto": Auto white balance manual, "panorama": indicates that camera rbgain, would try to balance the white widerange, balance effect of every sensor. outdoor, "rbgain": Use rgain and bgain to set indoor, white balance manually.
Page 184 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 2: EV -1.3 3: EV -1.0 4: EV -0.7 5: EV -0.3 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 * Only available when...
Page 185 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <Not support * Not support this parameter anymore> anymore when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c<0~(n-1)>_mode" to switch on/off BLC.
Page 186 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. ptzstatus 0,<positive A 32-bit integer, each bit can be set <Not support integer>...
Page 187 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc. 5~8000 => 1/5s ~ 1/8000s etc. * Available value is * Only available when listed in "capability_image_c<0~(n-1)>_exposu "capability_image_...
Page 188: Video Input Setting Per Channel
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 189 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) widerange, balance effect of every sensor. outdoor, "rbgain": Use rgain and bgain to set indoor, white balance manually. sodiumauto, "manual": 2 cases: a. if "rbgain" is not supported, this means keep current white balance (Available values are listed status.
Page 190 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbmo de". * Only valid when "videoin_c<0~(n-1)>_whitebalance" ! = auto * Normalized range. exposurelevel 0~12 Exposure level "0,12": This range takes the concept from DC's exposure tuning options.
Page 191 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) variable Iris, and keep adjusting Gain "capability_image_c<0~(n- and Shutter speed automatically. 1)>_exposure_modetype") "qualitypriority": Automatically adjust the Iris, Gain and Shutter Speed by VIVOTEK quality algorithm. "manual": Manually adjust with variable Shutter, Iris and Gain.
Page 192 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only available when "capability_image_c<0~(n-1)>_iristype "=piris piris_position 1~100 Manual set P-Iris. <product 1: Open <-> 100: Close dependent> * Only valid when "piris_mode"=manual or "capability_image_c<0~(n-1)>_sensor type" is "smartsensor" * Only available when "capability_image_c<0~(n-1)>_iristype "=piris...
Page 193 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) ngain" != "-" * Only valid when "piris_mode"=manual "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". gainvalue 0~100 Gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_m axgain"...
Page 194 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) Bit 2 => Support pan operation; 0(not support), 1(support) Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 =>...
Page 195 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". maxexposure <1~32000>, Maximum exposure time <product <5~32000>, 1~32000 => 1s ~ 1/32000s dependent> <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 =>...
Page 196 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 1)>_exposure_maxrange" exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s. * Only available when "capability_image_c<0~(n-1)>_exposu re_maxrange"...
Page 197 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) the version number (httpversion) is equal or greater than 0302a.  bracketing_lev 1~100 The total available lists (capability_image_c<0~(n-1)>_ex posure_bracketing_range) will be normalized to 1~100 scale.  For example, the total available list is 7.
Page 198 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "capability_videoin_c<0~(n-1)>_smart fps_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. s<0~(m-1)>_h2 <boolean> Enable "Dynamic intra frame period". 64_dintraperio * Only available when d_enable...
Page 199 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 64_qpercent normalized full range. 1: Worst quality 100: Best quality * Only valid when "h264_ratecontrolmode"= vbr and "quant"= 100. s<0~(m-1)>_h2 20000~"capability_videoin The maximum allowed bit rate in fixed 64_maxvbrbitr _c<0~(n-1)>_h264_maxbit quality mode.
Page 200 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "h264_ratecontrolmode"= cbr s<0~(m-1)>_h2 1~"capability_videoin_c<0 The maximum frame rates of a H264 64_maxframe ~(n-1)>_h264_maxframera stream at different te" resolutions("capability_videoin_c<0~( n-1)>_resolution") are recorded in "capability_videoin_c<0~(n-1)>_h264 _maxframerate" s<0~(m-1)>_h2 Indicate H264 profiles 64_profile * Available values can also 0: baseline...
Page 201 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 65_ratecontrol vbr: Fixed quality mode, all frames are mode encoded in the same quality. * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_h2 1~5, Set the pre-defined quality level: 65_quant 99, 100 1: Medium...
Page 202 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) rate" When the bit rate exceeds this value, frames will be dropped to restrict the bit rate. * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "h265_ratecontrolmode"= vbr s<0~(m-1)>_h2 1~5, 100...
Page 203 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 65_prioritypoli * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "h265_ratecontrolmode"= cbr s<0~(m-1)>_h2 1~"capability_videoin_c<0 The maximum frame rates of a H265 65_maxframe ~(n-1)>_h265_maxframera stream at different te"...
Page 204 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 5: Excellent 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue" s<0~(m-1)>_mj 10~200 Manual video quality level input. The peg_qvalue (Only valid when Q value which is used by encoded "capability_api_httpversio library directly.
Page 205 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only valid when "mjpeg_ratecontrolmode"= cbr. s<0~(m-1)>_mj 1~100 Select customized quality in a peg_cbr_qperc normalized full range. 1: Worst quality 100: Best quality * Only valid when "mjpeg_ratecontrolmode"= cbr and...
Page 206 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) wdrpro_mode 0, 1, 2 0: Disable WDR Pro. <product 1: Enable WDR Pro. dependent> * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode" = 1 2: Enable WDR Pro II. * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode"...
Page 207 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 81~100: level 5 Level 1~4(low ~ high) The higher speed level meas shorter AE converged time during AE executing. * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1 aespeed_sensi 1~100 The sensitivity of AE converge speed.
Page 208 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) s<0~(m-2)>_fis ‘1O, 1P, 2P, 1R, 4R’ for Local dewarp mode. heyedewarpm ceiling/floor mount “1O” is original mode (disable). ‘1O, 1P, 1R, 4R’ for wall Supported dewarp mode is different <product mount by mount type.
Page 209 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) display image. If the value is a positive number, the video quality of ROI is better than the non-ROI areas. The level is from 1 to 5. Level 5 is the maximum level of the quality difference between the ROI and non-ROI areas.
Page 210 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable this profile setting policy night, The mode which the profile is applied schedule <product dependent> * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a.
Page 211 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n- sensor generates a frame per 1)>_exposure_maxrange" exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.
Page 212 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <Not support * Not support this parameter anymore> anymore when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c<n>_mode" to switch on/off BLC.
Page 213 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n- and Shutter speed automatically. 1)>_exposure_modetype") "qualitypriority": Automatically adjust the Iris, Gain and Shutter Speed by VIVOTEK quality algorithm. "manual": Manually adjust with variable Shutter, Iris and Gain. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 214 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_wbmo de" !="-" rgain 0~100 Manual set rgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbmo de".
Page 215 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) mingain 0~100 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_mi ngain" != "-" * Only valid when "piris_mode"=manual "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype"...
Page 216 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) or flicker effect in indoor environment. "indoor": Avoid rolling and flicker effect first. "manual": Manual set P-Iris by "piris_position". "-": not support (only available when "capability_image_c<0~(n-1)>_sensor type" is "smartsensor") * Only available when "capability_image_c<0~(n-1)>_iristype "=piris...
Page 217 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) _mode" = 1 2: Enable WDR Pro II. * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode" = 2 wdrpro_streng 1~100 The strength of WDR Pro. The bigger value means the stronger <product strength of WDR Pro.
Page 218: Multicast Settings For Video Streaming
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) executing. * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1 aespeed_sensi 1~100 The sensitivity of AE converge speed. tivity 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 219: Time Shift Settings
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 1 ~ 255 Multicast video time to live value. 7.9 Time Shift Settings Group: timeshift for n channel products and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" (capability_timeshift >...
Page 220 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <Not day, * We replace this parameter with recommended to night, “ircutcontrol_c0_mode” when the use this> version number (httpversion) is equal schedule…etc or greater than 0312a. * Available values are * We do not support this parameter listed in when "capability_nvideoin >...
Page 221 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) use this> dtime” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 222 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enablewled <boolean> Enable/disable built-in White led <Not * Only available when " recommended to capability_daynight_c<0~"capability_ use this> nvideoin"-1>_builtinwled > 0". * We replace this parameter with "ircutcontrol_illuminators_builtin_whi teled_enabled"...
Page 223: Ir Cut Control Setting Per Channel
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) ensitivity_type=normalize * Only available when "capability_daynight_c<0~(n-1)> _ircutsensitivity_type" is not "-". * We replace this parameter with ircutcontrol_c<0~(n-1)>_sensitivity” when the version number (httpversion) is equal or greater than 0312a.
Page 224 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved (get/set) mode auto, Set IR cut control mode day, * We support this parameter when the version number (httpversion) is night, equal or greater than 0312a. schedule…etc * Available values are listed in "capability_daynig ht_c<0~(n-1)>_mo de"...
Page 225: Ir Cut Control Illuminators
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved There are two value format: "low,normal,high": if capability_daynight_c<0~(n-1)>_ircuts ensitivity_type=options "1~100": if capability_daynight_c<0~(n-1)>_ircuts ensitivity_type=normalize * Only available when "capability_daynight_c<0~(n-1)> _ircutsensitivity_type" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
Page 226 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved * We support this parameter when the version number (httpversion) is equal or greater than 0312a. external_do_enabled <boolean> Enable/disable external led mounted on do1 * Only available when "capability_daynight_illuminators_ext ernal_support > 0" and "do" is listed "capability_daynight_illuminators_ext ernal_interface".
Page 227: Image Setting Per Channel
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved _spectrum_mode" 7.11 Image Setting per Channel Group: image_c<0~(n-1)> for n channel products and m profile n denotes the value of "capability_nvideoin" and m denotes the value of "capability_nvideoinprofile" NAME VALUE SECURITY DESCRIPTION (get/set) brightness -5~5,100...
Page 228 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) tting" is 1. * We replace "saturation" with "saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. sharpness -3~3,100 -3: Softer <->...
Page 229 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) sharpnesspercent 0~100 Set sharpness in the normalized range. 0: Softer <-> 100: Sharper * Only available when bit 3 of "capability_image_c<0~(n-1)>_basicse tting" is 1 gammacurve 0~100 0: Fine-turned gamma curve by <product Vivotek.
Page 230 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) dnr_strength 1~100 Strength of 3DNR <product * Only available when dependent> "capability_image_c<0~(n-1)>_dnr" is defog_mode <boolean> Enable/disable defog mode. <product 0:disable dependent> 1:enable * Only available when "capability_image_c<0~(n-1)>_defog_ mode"...
Page 231 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) scene_mode visibility, Value of scene mode <product noiseless, * Only available when dependent> lpcparkinglot, "capability_image_c<0~(n-1)>_scene lpcstreet, mode_support" is 1 lpchighway, auto, deblur, lpcfreeway <product dependent> * Available values are listed in "capability_image_c<...
Page 232 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when "capability_image_c<0~(n-1)>_deinter lace_support" is 1. xoffset 0~100 Adjusting the image to proper position horizontally. * Only available when the bit 4 of capability_image_c<0~(n-1)>_basicset ting is 1. yoffset 0~100 Adjusting the image to proper...
Page 233 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) (httpversion) is equal or greater than 0301a. * "policy=night" is only available when "capability_daynight_c<0~(n-1)>_sup port > 0". profile_i<0~(m-1)> hh:mm Begin time of schedule mode. _begintime profile_i<0~(m-1)> hh:mm End time of schedule mode.
Page 234 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) _saturation saturation <Not 100: Use " recommended to image_c<0~(n-1)>_saturationpercent" use this> * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicse tting" is 1. * We replace "profile_i0_saturation" with "profile_i0_saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 235 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when bit 1 of "capability_image_c<0~(n-1)>_basicse tting" is 1 profile_i<0~(m-1)> 0~100 Set saturation in the normalized _saturationpercent range. 0: Less saturation <-> 100: More saturation * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicse tting"...
Page 236 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) profile_i<0~(m-1)> <boolean> Enable/disable hightlight mask. _hlm * Only available when <product "capability_image_c<0~(n-1)>_hlm" is dependent> profile_i<0~(m-1)> <boolean> 3D noise reduction. _dnr_mode 0:disable <product 1:enable dependent> * Only available when "capability_image_c<0~(n-1)>_dnr"...
Page 237: Exposure Window Setting Per Channel
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <product 1:enable dependent> * Only available when 'dis' is listed in "capability_image_c<0~(n-1)>_is_mod e". profile_i<0~(m-1)> 1~100 Strength of digital image stabilizer _dis_strength * Only available when 'dis' is listed in <product "capability_image_c<0~(n-1)>_is_mod dependent>...
Page 238 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1 and when custom is listed in "capability_image_c<0~(n-1)>_exposure_winmode" and valid when "exposurewin_c<0~(n-1)>_mode"=custom or "exposurewin_c<0~(n-1)>_mode"=hlc) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the window. policy 0: Indicate exclusive. 1: Indicate inclusive.
Page 239 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when std is listed in "capability_image_c<0~(n-1)>_exposu re_windomain". sizestd <0~9999x0~9999> Width and height of the window. * Only available when std is listed in "capability_image_c<0~(n-1)>_exposu re_windomain".
Page 240 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1 and when custom is listed in "capability_image_c<0~(n-1)>_exposure_winmode" and valid when "exposurewin_c<0~(n-1)>_mode"=custom or "exposurewin_c<0~(n-1)>_mode"=hlc) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the window. policy 0: Indicate exclusive. 1: Indicate inclusive.
Page 241: Audio Input Per Channel
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) homestd <0~9999,0~9999> Left-top corner coordinate of the window. * Only available when std is listed in "capability_image_c<0~(n-1)>_exposu re_windomain". sizestd <0~9999x0~9999> Width and height of the window. * Only available when std is listed in "capability_image_c<0~(n-1)>_exposu re_windomain".
Page 242 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0: Minimum 100: Maximum * Only available when the channel supports internal microphone (The related bit of "capability_audio_intmic" is equal to volume_external 0~100 Volume when take external microphone as input source.
Page 243 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Reserved for compatibility, and suggest don't use this since the version number (httpversion) is equal or greater than 0301a. * We replace "boostmic" with "volume_internal" and "volume_external".
Page 244 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 32000, 40000 s0_g726_bitstreamp little, big Set G.726 bit streaming packing ackingmode mode. little: Little-endian bitstream format. big: Big-endian bitstream format. * Only available if G.726 is supported. s0_g726_vlcmode 0, 1 Enable vlcmode for G.726.
Page 245: Multicast Settings For Audio Streaming
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.13.1. Multicast Settings for Audio Streaming Group: audioin_c<0~(n-1)>_s0_multicast (capability_naudioin > 0 and capability_media_streamprofiles_support = 1) n denotes the value of "capability_naudioin" NAME VALUE SECURITY( DESCRIPTION get/set) ipaddress <ip address> Multicast audio IP address. port 1025 ~ 65535 Multicast audio port.
Page 246: Motion Detection Settings
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) record. 7.16 Motion Detection Settings Group: motion_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable motion detection. win_sensitivity 0 ~ 100 Sensitivity of all motion detection...
Page 247 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0400a. polygonpx 0 ~ W,0 ~ H, 0 ~ W,0 Coordinate of polygon window <Not recommended ~ H, 0 ~ W,0 ~ H, 0 ~ position.
Page 248 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0 ~ 240 Top coordinate of window position. <Not recommended * Only available when to use this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain".
Page 249 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable profile 1 ~ (m-1). policy night, The mode which the profile is applied to. schedule * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a.
Page 250 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) to use this> "win_sensitivity". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. polygonpx 0 ~ W,0 ~ H, 0 ~ Coordinate of polygon window position.
Page 251: Tampering Detection Settings
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) to use this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 252: Ddns
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) threshold 0~100 Threshold of tamper detection. duration 10~600 If tampering value exceeds the "threshold" for more than "duration" second(s), then tamper detection is triggered. ignorewidth 0,<positive Indicate the width to offset to start to integer>...
Page 253: Express Link
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the dynamic DNS. provider DyndnsDynamic, DyndnsDynamic => dyndns.org DyndnsCustom, (dynamic) Safe100 DyndnsCustom => dyndns.org Safe100 => safe100.net <provider>_hostnam string[128] Your DDNS hostname. <provider>_usernam string[64] Your user name or email to login to...
Page 254: System Log
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP port forwarding service. upnpnatstatus The status of UPnP port forwarding, used internally. 0 = OK, 1 = FAIL, 2 = no IGD router, 3 = no need for port forwarding 7.22 System Log Group: syslog...
Page 255: Layout Configuration
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <boolean> SNMP v2 enabled. 0 for disable, 1 for enable <boolean> SNMP v3 enabled. 0 for disable, 1 for enable secnamerw string[31] Read/write security name secnamero string[31] Read only security name authpwrw string[8~128]...
Page 256 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) custombutton_manualtr <boolean> Show or hide manual trigger (VI) igger_show button in homepage 0 -> Hidden 1 -> Visible theme_option 1~3: One of the default themes. 4: Custom definition. theme_color_font string[7] Font color...
Page 257 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) equal or greater than 0314b. defaultpassword_length 8 ~ 64 Allowed password length. * We support this parameter when the version number (httpversion) is equal or greater than 0314b. 271 - User's Manual...
Page 258: Privacy Mask
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.25 Privacy Mask Group: privacymask_c<0~(n-1)> for n channel products and m privacy mask window. n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean>...
Page 259: Privacy Mask
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0 ~ W,0 ~ H, (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 0 ~ W,0 ~ H * Only available when W: 0~ The "capability_image_c<0~(n-1)>_privacy current image mask_wintype" = polygon. width -1 * Only available when px is listed in H: 0~ The current "capability_image_c<0~(n-1)>_privacy...
Page 260: Capability
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) buildinpt" is "1" win_i<0~(m-1)>_tilt "capability_ptz_c<0~(n-1) Tilt position of window position. >_mintilt" ~ * Only available when bit1 of "capability_ptz_c<0~(n-1) "capability_camctrl_c<0~(n-1)>_ >_maxtilt" buildinpt" is "1" win_i<0~(m-1)>_zoom "capability_ptz_c<0~(n-1) Zoom position of window >_minzoom"...
Page 261 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) interfaces. Revision Increase the revision when fix bugs without change any features of the output. _platform This is a constant, it is used to distinguish between different platforms API version format: MMmmr_k...
Page 262 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) nvideoin"-1>_externalir for external * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. npir Number of PIRs. <positive integer> Number of digital inputs. <positive integer>...
Page 263 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) nmotion <positive integer> The number of motion window. nmotionprofile 0, <positive integer> Number of motion profiles. nevent 0, <positive integer> Number of event. * We support this parameter when the version number (httpversion) is equal or greater than 0311c.
Page 264 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) server series) Bit 6 => (only available when bit0 is 1) Reserved bit; always 0. Bit 7 => (only available when bit0 is 1) External or built-in PT; 0(built-in), 1(external) windowless <boolean>...
Page 265 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) presettourdirection <boolean> Indicate whether to support preset tour direction function. It means users can choose which direction the preset tour goes. * We support this parameter when the version number (httpversion) is equal or greater than 0307a.
Page 266 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) channel. For some dual-stream products, both streams support ePTZ. nanystream 0, <positive integer> number of any media stream per channel <boolean> Indicate whether to support Intelligent Video analysis whitelight <boolean>...
Page 267 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "tampering" = Tamper detection. "vi" = Virtual input (Manual trigger) "vadp" = VADP trigger. "di"= Digital input. "volalarm" = Audio detection. "temperature" = Temperature detection. "pir" = PIR detection. "visignal"...
Page 268 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) protocol_rtp_multi <boolean> Indicate whether to support scalable cast_scalable multicast. protocol_rtp_multi <boolean> Indicate whether to support cast_backchannel backchannel multicast. protocol_rtp_tcp <boolean> Indicate whether to support RTP over TCP. protocol_rtp_http <boolean>...
Page 269 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 1 => Progressive CCD 2 => CMOS videoin_nresolutio <positive integer> This equals "capability_videoin_c0_nresolution". * This is kept for compatibility. videoin_resolution A list of <WxH> This equals <product dependent> "capability_videoin_c0_resolution".
Page 270 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) by commas <product dependent> timeshift <boolean> Indicate whether to support time shift caching stream. audio_aec <boolean> Indicate whether to support acoustic echo cancellation. audio_aecmode auto, Indicate the acoustic echo manual cancellation control mode.
Page 271 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6"...
Page 272 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0: Not support 1: Support Bit 0 for CH0, bit 1 for CH1, and so on. audio_alarm <0~Positive Integer> 0: Not support audio alarm. 1: Support audio alarm. Bit 0 for CH0, bit 1 for CH1, and so on.
Page 273 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "g726": G.726 "-": Not supported. audioout_codec g711, - Available codec list for SIP. <product dependent> "-": Not supported. motion_wintype rectangle, polygon,- The supported motion window type. "polygon": The window is a 2D polygon shape.
Page 274 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) e_autotracking stream is supported. * Only available when "capability_smartstream_support" is 1 smartstream_mod <boolean> Indicate whether manual smart e_manual stream is supported. * Only available when "capability_smartstream_support" is 1 smartstream_mod <boolean>...
Page 275 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Bit 7 => Support digital signature of package Bit 8 => Support snapshot Bit 9 => Support upload encrypted package vadp_npackage <positive integer> Indicate the maximum number of VADP package that can be uploaded to the device.
Page 276 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) tunnel for UART transfer. transmission_mod Indicate transmission mode of the machine: TX = server, Rx = receiver Both box, Both = DVR. network_wire <boolean> Indicate whether to support Ethernet. network_wireless <boolean>...
Page 277 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) equal or greater than 0305a. wireless_apmode_ <string> Indicate the prefix of broadcasted ssidprefix SSID when camera is in wireless AP mode. * Only available when "capability_wireless_apmode_enable" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0305a.
Page 278 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) media_videoclip_ <positive integer> Maximum length (second) of a maxlength videoclip. media_videoclip_ <positive integer> Maximum duration (second) after maxpreevent event occurred in a videoclip. media_streamprofi <boolean> Indicates support of stream profile les_support feature.
Page 279 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) localstorage_mana <boolean> Indicate whether manageable local geable storage is supported. * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_seaml Indicate whether seamless recording <positive integer> is supported.
Page 280 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) than 0, it means that the camera supports edge recording function. bit 0 : It supports to record directly to an on-board SD-Card. bit 1~: Currently, they are reserved bit, and the default value is 0.
Page 281 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when "capability_fisheye" > 0 shockalarm_suppo <boolean> Indicate whether to support the shock detection. * We support this parameter when the version number (httpversion) is equal or greater than 0306e.
Page 282: Capability For Camctrl
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0314b. 7.27.1 Capability for Camctrl Group: capability_camctrl_c<0~(n-1)> n denotes the value of "capability_nvideoin" (capability_ptzenabled > 0) * We support this group when the version number (httpversion) is equal or greater than 0303b. PARAMETER VALUE SECURITY...
Page 283 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) zoommodule <boolean> Indicate whether to support zoom lens. In our product, only SD series and IZ series use the zoom lens. * Both varifocal and zoom lenses are built with movable elements that permit changing the effective focal length.
Page 284: Capability For Ptz
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.27.2 Capability for PTZ Group: capability_ptz_c<0~(n-1)> n denotes the value of "capability_nvideoin" (capability_ptzenabled > 0 and capability_camctrl_c<0~(n-1)>_zoommodule !=0) * We support this group when the version number (httpversion) is equal or greater than 0303b. PARAMETER VALUE SECURITY...
Page 285 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxtilt 0, <positive integer> 0/7 The upper limit for tilt position. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" mintiltangle <integer> The lower limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt"...
Page 286: Capability For Ir Led
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) minfocus 0, <positive integer> 0/7 The lower limit for focus position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoomm odule" is "1" maxfocus 0, <positive integer> 0/7 The upper limit for focus position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoomm odule"...
Page 287 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) externalir <boolean> Indicate whether to support external IR led. * We replaced this parameter with “capability_daynight_illuminators_exter nal_support” when the version number (httpversion) is equal or greater than 0312a.
Page 288 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) 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" "-":not support * Only available when "capability_daynight_c<0~(n-1)>_suppo rt"...
Page 289 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) spectrum_support <boolean> Indicate whether to support proposed a brightness enhancement method based on CCM(Color Correction Matrix) model to improve the brightness effect of the images if the IR and blue light exists. * Only available when "capability_daynight_c<0~(n-1)>_suppo rt"...
Page 290: Capability For Ir Illuminators
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mode auto,daynight,di,di2, Indicate the day / night switch mode. di3,di4,schedule,- "auto": The Camera automatically <product judges the current operation mode by dependent> the level of ambient light detected. "daynight": support day mode and night mode.
Page 291 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved optimizedir <boolean> Indicate whether to support optimized IR control technology. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. builtin_support <boolean> Indicate whether to support built-in led. * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
Page 292: Capability For Storage Management
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved spectrum_support <boolean> Indicate whether to support proposed a brightness enhancement method based on CCM(Color Correction Matrix) model to improve the brightness effect of the images if the IR and blue light exists. * Only available when "capability_daynight_c<0~(n-1)>_support"...
Page 293: Capability For Video Input
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved device sd, nas Indicate the supported storage devices. <product * Only available when dependent> "capability_storage_dbenabled" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. * Note: If “nas”...
Page 294 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) color_support <boolean> 1 : camera can select to display color or black/white video streams. 0: camera do not support this feature. * We support this parameter when the version number (httpversion) is equal or greater than 0310a.
Page 295 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) rotationaffect When rotation is enabled, some features <product may become malfunction or be forced to a dependent> given value. The affected functions are list here. The format is "Affect API name":"Policy":"Description"...
Page 296 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) rotationangle <string> The different angles which camera supports for rotation. * Only avaliable when "capability_videoin_c<0~(n-1)>_rotation" is * We support this parameter when the version number (httpversion) is equal or greater than 0309b.
Page 297 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) resolution A list of <WxH> Resolution options in current video mode. <product These options are the possible options for dependent> "videoin_c<n>_s<m>_resolution". The last one is the maximum resolution in current mode.
Page 298 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mjpeg_maxframerate A list of <Positive Maximum fps that the device can encoded Integer> and "-" with MJPEG on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution".
Page 299 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) h264_maxbitrate <positive integer> 0/7 Maximum bitrates of H.264. The unit is bps. * Only available when 'h264' is listed in "capability_videoin_codec". h264_profile baseline,main,hig Indicate H264 profiles * Only available when 'h264' is listed in "capability_videoin_codec".
Page 300 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) fisheye_mounttype ceiling, wall, floor Indicate the supported type. <Not recommended <product wall mount: 180° panoramic view to use this> dependent> ceiling mount: 360° surround view without blind spots floor mount: 360°...
Page 301: Capability For Local Dewarp
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) cameraunit_name CU8131, A "camera unit" name of a split-type camera CU8171, system, which the camera unit and the CU8161-H, video core are separated. CU8162-H, -: If the camera is not a split-type camera CU8163-H, system, the value of this parameter is "-".
Page 302: Capability For Video Mode
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) typewallmount 1O, 1P, 1R, 4R Available dewarp types of wall mount. resolutionC1P A list of <WxH> Available resolutions of 1P mode of ceiling and floor mount. resolutionC2P A list of <WxH>...
Page 303 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) eptz 0, <positive integer> 0/7 Indicate this mode whether support eptz. For "nvideoin" = 1, the definition is as following: A 32-bits integer, each bit can be set separately as follows: Bit 0 =>...
Page 304 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) outputsize <WxH> The output size of source, equal to the captured size by device, in this video mode. The unit is pixel. This value is used as a basic coordinate system for many features, like ePTZ, privacy mask, motion, etc.
Page 305 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) minresolution A list of <Integer> Represent supported minimum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream". * We support this parameter when the version number (httpversion) is equal or greater than 0304b.
Page 306: Capability For Image
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxfps_h264 A list of <Positive Maximum fps which the device can Integer> and "-" encoded with H.264 on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution".
Page 307 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Bit 0 => Supports Brightness or not. Bit 1 => Supports Contrast or not. Bit 2 => Supports Saturation or not. Bit 3 => Supports Sharpness or not. Bit 4 =>...
Page 308 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) :fixed:auto, be forced to a given value. The exposurelevel:hidd affected functions are list here. en:, The format is "Affect API exposurelevel:fixed name":"Policy":"Description" :<x>, "Policy" can be categorized into exposurelevel:fixed following groups: :<x>/<x>,...
Page 309 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * When "wdrpro"=0, this value must be "-" wdrpro_description <string> Description about WDR Pro mode. * Only available when "capability_image_c<0~(n-1)>_wdrpro _mode" > 0 wdrc_mode 0, 1 0: Non-support WDR Enhanced 1: Support WDR Enhanced wdrc_supportlevel 0, <positive...
Page 310 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. For example: "exposurelevel:fixed:6/8/12" which means exposurelevel is fixed to level 6, level 8 and level 12.
Page 311 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "-": not support * We support this parameter when the version number (httpversion) is equal or greater than 0302a. is_strength <boolean> 0: Non-support tuning strength of image stabilizer mode. 1: Support tuning strength of image stabilizer mode.
Page 312 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available.
Page 313 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) wbmode auto, Available white balance mode. panorama, "-" means white balance is not manual, supported. rbgain, widerange, outdoor,indoor, sodiumauto, <product dependent> iristype piris, Indicate iris type. dciris, "piris": P-Iris "dciris": DC-Iris "-": No Iris control support...
Page 314 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) constant value. "twovalues": Need two parameters to indicate the exposure range. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 315 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_ exposure_mode" is 1 and "capability_image_c<0~(n-1)>_exposu re_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_automode_ When exposure auto mode is affect exposurewin.mode enabled, some features may become...
Page 316 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when auto is listed in "capability_image_c<0~(n-1)>_ exposure_modetype"...
Page 317 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description"...
Page 318 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:"...
Page 319 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) dependent> before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values.
Page 320 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) en:, name":"Policy":"Description" icrmode.auto:nots "Policy" can be categorized into upport: following groups: or others - (disabled) : UI turns grey and users <x>: nonnegative can't select it. integer - (unchanged) : UI keeps the status as <product before and...
Page 321 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "0,12" "videoin_c<0~(n-1)>_exposurelevel" * When "exposure_mode"=0, this value must be set to "-". * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_winmode auto, Available options for custom, "exposurewin_c<0~(n-1)>_mode" blc, * "-"...
Page 322 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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 323 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) window is omitted by exposure control. "-": Not supported. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_windomain qvga, px, std, - The domain to set an exposure window.
Page 324 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0301a. exposure_maxrange "1,32000", Available range for "1,8000", "videoin_c<n>_maxexposure" "1,32000"...
Page 325 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) two or more exposures but with different exposure values. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0310a.
Page 326 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "-" "videoin_c<n>_maxgain" “0,100” => 0~100 percent "-" means "videoin_c<n>_maxgain" is not available. agc_mingain "0,100", Available range for "-" "videoin_c<n>_mingain" “0,100” => 0~100 percent "-" means "videoin_c<n>_mingain" is not available.
Page 327 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-"...
Page 328 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:"...
Page 329 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 1: Support low light mode focusassist 0: Non-support focus assist 1: Support focus assist remotefocus 0,<positive An 4-bit integer, which indicates the integer> supportive application of remotefocus in this channel.
Page 330 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * We support this parameter when the version number (httpversion) is equal or greater than 0302a. 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 331: Capability For Peripheral Device
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_lens_al ignment" is 1. lens_ldc_support <boolean> Indicate whether to support lens distortion correction function. * We support this parameter when the version number (httpversion) is equal or greater than 0309d. palette_support <boolean>...
Page 332: Event Setting
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.28 Event Setting Group: event_i<0~(n-1)> n denotes the value of "capability_nevent" (capability_nevent > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. enable 0, 1 Enable or disable this event. priority 0, 1, 2 Indicate the priority of this event:...
Page 333 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) 0,<positive Indicate the source id of di trigger. integer> This field is required when trigger condition is “di”. One bit represents one digital input. The LSB indicates DI 0. * Only available when "capability_ndi"...
Page 334 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) valevel0 Select audio detection profile event. 0: not select 1: select inter 1~999 Interval of snapshots in minutes. This field is used when trigger condition is “seq”. weekday 0~127 Indicate which weekday is scheduled.
Page 335 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_cf_folder string[128] Path to store media. <Not recommended to * Only available when use this> "capability_supportsd" > 0 foldername string[128] Path to store media. * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
Page 336 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_goto_sync <boolean> Capture media after moving to the <product dependent> location. * Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0, or capability_camctrl_c0_zoommodule >...
Page 337: Server Setting For Event Action
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.29 Server Setting for Event Action Group: server_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry type email, Indicate the server type: ftp, “email” = email server http, “ftp” = FTP server “http”...
Page 338: Server Setting For Event Action Of Sftp
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) ns_location string[128] Location to upload or store the media. * For httpversion is equal or greater than 0312a: The media storage path format is “\<mac address>\date\hour”. (Only available when “nas”...
Page 339: Media Setting For Event Action
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved fingerprint_enable boolean Verify server fingerprint to avoid connect to fake server. fingerprint_content string[128] Server fingerprint(MD5). You can get it by calculate server host key(public) md5. publickey_pairmode auto, "autopair": Autopair mode is selected download, for this event server.
Page 340 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) snapshot_channel 0~"capability_nvideoin"-1 Indicate the source of media channel. 0 means the first channel. 1 means the second channel. 2 means the third channel. 3 means the fourth channel. * We support this parameter when the version number (httpversion) is equal or greater...
Page 341 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) videoclip_channel 0~"capability_nvideoin"-1 Indicate the source of media channel. 0 means the first channel. 1 means the second channel. 2 means the third channel. 3 means the fourth channel. * We support this parameter when the version number (httpversion) is equal or greater...
Page 342: Recording
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.31 Recording Group: recording_i<0~(n-1)> n denotes the value of "capability_nrecording" (capability_nrecording > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. trigger schedule, The event trigger type networkfail schedule: The event is triggered by schedule networkfail: The event is triggered by the failure of network connection.
Page 343 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxretentiontime <string> To specify the expired time for automatic clean up, and it only takes effect for video clip generated by recording_i <0~1>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss] S’ , similar with ISO8601 with symbols P Ex.
Page 344 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) weekday 0~127 Indicate which weekday is scheduled. One bit represents one weekday. bit0 (LSB) = Saturday bit1 = Friday bit2 = Thursday bit3 = Wednesday bit4 = Tuesday bit5 = Monday bit6 = Sunday For example, to detect events on Friday...
Page 345: Https
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) adaptive_enable <boolean> Indicate whether the adaptive recording is enabled adaptive_preevent 0~9 Indicate when is the adaptive recording started before the event trigger point (seconds) adaptive_postevent 0~10 Indicate when is the adaptive recording stopped after the event trigger point (seconds) recordingjob_Sourc...
Page 346: Storage Management Setting
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) stateorprovincen string[128] State or province name in the certificate information. localityname string[128] The locality name in thecertificate information. organizationname string[64] Organization name in the certificate VIVOTEK Inc. information.
Page 347 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) autocleanup_mode targetbase, Specify the automatic clean up method sourcebase for storage devices, where “targetbase” indicate the automatic clean up is based on the attached devices such as nas or sd card, whereas “sourcebase”...
Page 348: Region Of Interest
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.34 Region of Interest Group: roi_c<0~(n-1)> for n channel product and m is the index of video stream which support ePTZ. (capability_eptz > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-1)>_home <W,H> ROI left-top corner coordinate.* If the <product minimal window size is 64x64, then the dependent>...
Page 349: Eptz Settings For Each Stream
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) 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...
Page 350: Focus Window Setting
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) preset_i<0~19>_size <WxH> Width and height of the preset. <product (It should be set by ePreset.cgi rather dependent> than by setparam.cgi.) 7.36 Focus Window Setting Group: focuswindow_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin".
Page 351 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) diskmode seamless, “seamless” indicates enable seamless manageable recording. “manageable” indicates disable seamless recording. * We replace this parameter with “seamlessrecording_c<0~(n-1)>_diskmode” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin >...
Page 352: Seamless Recording Setting Per Channel
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) guid<0~2>_id string[127] The connected seamless streaming ID. (Read only) * We replace this parameter with “seamlessrecording_c<0~(n-1)>_guid<0~2>_i d” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin >...
Page 353 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved diskmode seamless, “seamless” indicates enable seamless manageable recording. “manageable” indicates disable seamless recording. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. maxconnection Maximum number of connected seamless streaming.
Page 354: Vivotek Application Development Platform Setting
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.38 VIVOTEK Application Development Platform Setting Group: vadp NAME VALUE SECURITY DESCRIPTION (get/set) version <string> Indicate the VADP version. resource_total_memory 0,<positive Indicate total available memory size integer> for VADP modules. resource_total_storage 0,<positive Indicate total size of the internal integer>...
Page 355: Vadp Settings For Each Package
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Maximum of n=10 hyperlink is supported. NAME VALUE SECURITY DESCRIPTION (get/set) moduleidx 0,<positive Refer to the package index. integer> title string[40] Name of the vadp hyperlink. string[120] The URL address of vadp hyperlink. status string[40] Value of “on”...
Page 356: Vadp Schedule Settings
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) initscr string[40] The script that will handle operation commands from the system. status string[40] Indicate the running status of the module. statmsg string[128] Indicate the message that will be show on the running status when mouse over.
Page 357: Camera Ptz Control
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.39 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" and k denotes the value of "capability_npreset" NAME VALUE SECURITY...
Page 358: Camera Ptz Control (Iz Series)
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) driver. 2: enable PTZ commands with UART tunnel. * only available when capability_camctrl_c0_rs485=2 disablemdonptz <boolean> Disable motion detection on PTZ operation. 7.40 Camera PTZ Control (IZ Series) Group: camctrl_c<0~(n-1)>...
Page 359 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) nual * Available values are listed in "capability_cam ctrl_c<0~(n-1)> _focusmode" uart Select corresponding uart "capability_nua (capability_nuart>0). rt"-1 * only available when capability_camctrl_c0_rs485=2 isptz 0 ~ 2 0: disable PTZ commands. 1: enable PTZ commands with PTZ driver.
Page 360 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) setting fixcurrent essential and should be grouped with “preset_i<0~(k-1)>_name.” * We support this parameter when the version number (httpversion) is equal or greater than 0305b. patrolseq string[120] (For external device) The indexes of patrol points, separated by “,”...
Page 361: Camera Ptz Control (Sd Series)
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) should be taken while idle. idleaction_interval 1~999 While idle over this time interval, idle action will be taken. PTZ C LEASE REFER TO ONTROL 7.41 Camera PTZ Control (SD Series) Group: camctrl_c<0~(n-1)>...
Page 362 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Available values are listed in "capability_camctrl_c <0~(n-1)>_focusmod e" preset_i<0~(k-1)>_name string[40] Name of the preset location. preset_i<0~(k-1)>_pan capability_ptz_c<0~( Pan position at each preset n-1)>_minpan ~ location. capability_ptz_c<0~( n-1)>_maxpan preset_i<0~(k-1)>_tilt capability_ptz_c<0~(...
Page 363 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) disablemdonptz <boolean> Disable motion detection on PTZ operation. defaulthome <boolean> This field tells system to use default home position or not. axisx capability_ptz_c<0~( Custom home pan position. n-1)>_minpan ~ capability_ptz_c<0~( n-1)>_maxpan...
Page 364: Uart Control
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Set -1 to disable all the tour groups. tour_i<0~19>_name string[40] Name of the tour. tour_i<0~19>_type <boolean> 0 = Recorded tour 1 = Preset tour tour_i<0~19>_speed -5 ~ 5 Preset tour: pan and tilt speed when moving between presets.
Page 365 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Group: uart (capability_nuart > 0 and capability_fisheye = 0) NAME VALUE SECURITY DESCRIPTION (get/set) ptzdrivers_i<0~19, string[40] Name of the PTZ driver. 127>_name ptzdrivers_i<0~19, string[128] Full path of the PTZ driver. 127>_location enablehttptunnel <boolean>...
Page 366: Uart Control (Sd Series)
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) speedlink_i<0~4>_c string[40] Additional PTZ command list. * only available when capability_camctrl_c0_rs485=2 ptzdriver 0~19, The PTZ driver is used by this COM 127 (custom), port. 128 (no driver) * only available when capability_camctrl_c0_rs485=2 7.43 UART Control (SD Series)
Page 367: Lens Configuration
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) stopbit "1": One stop bit is transmitted to indicate the end of a byte. "2": Two stop bits are transmitted to indicate the end of a byte. If you want to transfer the stopbit for 150% of the normal time used to transfer one bit, the...
Page 368: Fisheye Info
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Group: lens_default_i<0~(n-1)> n denotes the value of "lens_default_totalnumbers" NAME VALUE SECURITY DESCRIPTION (get/set) name <string> Default lens name Group: lens_user_i<0~(n-1)> n denotes the value of "lens_user_totalnumbers" NAME VALUE SECURITY DESCRIPTION (get/set) name <string>...
Page 369: Pir Behavior Define
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) s<0~(m-2)>_region_t -90~90 Tilt home angle of regional view (for 1R mode) Tilt range of ceiling/floor mount is [0~90]. Tilt range of wall mount is [-90~90]. s<0~(m-2)>_region_ 100~300 Zoom home ratio of regional view (for zoom 1R mode)
Page 370: Wireless
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 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 2 : object size = 10 x 10 objsize_customized_w 10~320...
Page 371 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) encrypt none, Encryption method: wep, none: NONE, wpa, wep: WEP, wpa2 wpa: WPA, wpa2: WPA2PSK authmode OPEN, SHARED Authentication mode. * Only valid when "wireless_encrypt" is "wep" keylength 64, 128 Key length in bits.
Page 372: Shock Detection
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.50 Shock Detection Group: shock_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" (capability_shockalarm_support > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) alarm_enable <boolean> Enable shock detection's alarm. alarm_level 1~100 The value indicate the support strength level of shock detection's alarm.
Page 373: Multicast Settings For Metadata Streaming
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) videoconfiguration_so c<0~(n-1)>s<0~(m-1) The videoconfiguration source for the urce > profile. Ex. videoconfiguration_source= * n denotes the value c<0~(n-1)>s<0~(m-1)> indicates video stream of channel n stream m is “capability_nvideoin, selected for the profile.
Page 374 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Group: metadata_c<0~(n-1)>_s0_multicast (capability_media_streamprofiles_support = 1) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY( DESCRIPTION get/set) ipaddress <ip address> Multicast metadata IP address. port 1025 ~ 65535 Multicast metadata port. ipversion IPv4, IPv6 The version of internet protocol.
Page 375: Useful Functions
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8. Useful Functions 8.1 Drive the Digital Output (capability_ndo > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/setdo.cgi?do1=<value> [&do2=<value>] [&do3=<value>][&do4=<value>] Where state is 0 or 1; “0” means inactive or normal state, while “1” means active or triggered state, and trigger time is indicated in seconds.
Page 376: Query Status Of The Digital Output (Capability_Ndo > 0)
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <length>\r\n \r\n [di0=<state>]\r\n [di1=<state>]\r\n [di2=<state>]\r\n [di3=<state>]\r\n where <state> can be 0 or 1. Example: Query the status of digital input 1 . Request: http://myserver/cgi-bin/dido/getdi.cgi?di1 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n...
Page 377: Capture Single Snapshot
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved [do1=<state>]\r\n [do2=<state>]\r\n [do3=<state>]\r\n where <state> can be 0 or 1. Example: Query the status of digital output 1. Request: http://myserver/cgi-bin/dido/getdo.cgi?do1 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n do1=1\r\n 8.4 Capture Single Snapshot Note: This request requires Normal User privileges.
Page 378: Account Management
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION quality The quality of the image. streamid 0~( capability_nmediastream -1) The stream number. Default: Returns snapshot of maxmum resolution for current channel. The server will return the most up-to-date snapshot of the selected channel and stream in JPEG format.
Page 379 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION username <name> The name of the user to add, delete, or edit. userpass <value> The password of the new user to add or that of the old user to modify. The default value is an empty string. privilege view The privilege of the user to add or to modify.
Page 380: Upgrade Firmware
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved ERROR: Update user's privilege fail! 8.6 Upgrade Firmware Note: This request requires Administrator privileges. Method: POST Syntax: http://<servername>/cgi-bin/admin/upgrade.cgi Post data: fimage=<file name>[&return=<return page>]\r\n \r\n <multipart encoded form data> Server will accept the file named <file name> to upgradethe firmware and return with <return page>...
Page 381: Eptz Camera Control
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.7 ePTZ Camera Control (capability_eptz > 0 and Capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eCamCtrl.cgi?channel=<value>&stream=<value> [&move=<value>] – Move home, up, down, left, right [&auto=<value>] – Auto pan, patrol [&zoom=<value>] –Zoom in, out [&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...
Page 382 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved b. continuous movement - If you trigger a continuous movement, you have to handle the stop time by yourself. A continuous movement is convenient to integrate a joystick control. http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=tele&zs=1 http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed. 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.
Page 383 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION <integer> movement <integer> The scaled area size <integer> resolution <window size> The resolution of streaming. <integer> The direction of movement, used for joystick control. <integer> 0 ~ 7 Set the speed of movement, “0” means stop. <integer>...
Page 384: Eptz Recall (Capability_Eptz > 0 And Capability_Fisheye = 0)
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.8 ePTZ Recall (capability_eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eRecall.cgi?channel=<value>&stream=<value>& recall=<value>[&return=<return page>] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source. stream <0~(m-1)>...
Page 385: Ip Filtering For Onvif
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION addpos <Text string less than Add one preset location to the preset list. 40 characters> delpos <Text string less than Delete preset location from the preset list. 40 characters> return <return page>...
Page 386: Event/Control Http Tunnel Channel
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Syntax: http://<servername>/cgi-bin/operator/uartchannel.cgi?[channel=<value>] GET /cgi-bin/operator/uartchannel.cgi?[channel=<value>] x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache POST /cgi-bin/operator/uartchannel.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache cache-control : no-cache content-length: 32767 expires: Sun, 9 Jam 1972 00:00:00 GMT User must use GET and POST to establish two channels for downstream and upstream.
Page 387: Get Sdp Of Streams
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved GET /cgi-bin/admin/ctrlevent.cgi x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache POST /cgi-bin/admin/ ctrlevent.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache cache-control : no-cache content-length: 32767 expires: Sun, 9 Jam 1972 00:00:00 GMT User must use GET and POST to establish two channels for downstream and upstream.
Page 388: Open The Network Stream
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved network_rtsp_s2_accessname = live2s1.sdp network_rtsp_s3_accessname = live2s2.sdp etc. * Note: RTSP access name format is modified to “live<n>s<m>.sdp” after version number(httpversion) is 0311c. Please refer to the “subgroup of network: rtsp” for setting the accessname of SDP. You can get the SDP by HTTP GET.
Page 389: Storage Managements (Capability_Storage_Dbenabled > 0)
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved data <hex decimal The <hex decimal data> is a series of digits from 0 ~ 9, A ~ data>[,<hex decimal F. Each comma separates the commands by 200 data>] milliseconds. flush yes,no yes: Receive data buffer of the COM port will be cleared before read.
Page 390 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Command: search PARAMETER VALUE DESCRIPTION label <integer primary key> Optional. The integer primary key column will automatically be assigned a unique integer. triggerType <text> Optional. Indicate the event trigger type. Please embrace your input value with single quotes. Ex.
Page 391: Virtual Input (Capability_Nvi > 0)
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION limit <positive integer> Optional. Limit the maximum number of returned search records. offset <positive integer> Optional. Specifies how many rows to skip at the beginning of the matched records. Note that the offset keyword is used after limit keyword.
Page 392: Open Timeshift Stream
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION state while “1” means Ex: vi0=0(200)1 active or triggered state. Setting virtual input 0 to normal state, waiting 200 Where "nstate" is next milliseconds, setting it to trigger state. state after duration.
Page 393 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http://<servername>/<network_http_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&reft ime=<value>&forcechk&minsft=<value>] For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player. rtsp://<servername>/<network_rtsp_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&refti me=<value>&forcechk&minsft=<value>] “n” is the channel index. “m” is the timeshift stream index. For details on timeshift stream, please refer to the “TimeshiftCaching”...
Page 394: Remotefocus
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 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.19 RemoteFocus (capability_image_c<0~(n-1)>_remotefocus=1) Note: This request requires Administrator privileges.
Page 395 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION position <motor_start> ~ Motor’s position. <motor_end> It works only if function=zoom or function= focus and direction=direct. <motor_start> : remote_focus_zoom_motor_start or remote_focus_focus_motor_start, <motor_end> : remote_focus_zoom_motor_end or remote_focus_focus_motor_end replied from "function=getstatus" steps 1 ~ 30 Motor’s moving steps.
Page 396: Backfocus (Capability_Image_C<0~(N-1)>_Remotefocus=4)
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved function getstatus Information of motors, return value as below: remote_focus_zoom_motor_max: Maximum steps of zoom motor remote_focus_focus_motor_max: Maximum steps of focus motor remote_focus_zoom_motor_start: Start point of zoom motor remote_focus_zoom_motor_end: End point of zoom motor remote_focus_focus_motor_start: Start point of effective focal length remote_focus_focus_motor_end: End point of effective focal...
Page 397 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function focus, focus – Move focus motor auto, auto – Perform auto focus scan, scan – Perform focus scan stop, stop – Stop current operation positioning, positioning – Position the motors irisopen, resetfocus –...
Page 398: Export Files
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved function getstatus Information of motors, return value as below: remote_focus_focus_motor_max: Maximum steps of focus motor remote_focus_focus_motor_start: Start point of effective focal length remote_focus_focus_motor_end: End point of effective focal length remote_focus_focus_motor: Current position of focus motor remote_focus_focus_enable: Current function of focus motor...
Page 399: Upload Files
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved currentlanguage 0~20 Available language lists. Please refer to: system_info_language_i0 ~ system_info_language_i19 For setting backup file: http://<servername>/cgi-bin/admin/export_backup.cgi?backup 8.22 Upload Files Note: This request requires Administrator privileges. Method: POST Syntax: For daylight saving time configuration file: * This CGI is not supported when the version number (httpversion) is equal or greater than 0314b, please use “system_tz”...
Page 400: Update Lens Configuration
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Server will accept the file named <file name> to upload this one to camera. 8.23 Update Lens Configuration (capability_image_c<0~(n-1)>_lensconfiguration_support > 0) Note: This request requires Administrator privileges. Method: GET Syntax: For list a name of lens currently used: http://<servername>/cgi-bin/admin/update_lens.cgi?get_currentlens For list all names of lens installed in camera: http://<servername>/cgi-bin/admin/update_lens.cgi?list_lens...
Page 401: Media On Demand (Capability_Localstorage.modnum > 0)
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved For upload user-defined lens configuration: http://<servername>/cgi-bin/admin/update_lens.cgi?upload_lens Post data: upload_lens_profile_input = <file name>\r\n \r\n <multipart encoded form data> Server will accept the file named <file name> to upload the lens profile to camera. 8.24 Media on Demand (capability_localstorage.modnum >...
Page 402 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Play recordings for length seconds which ends at etime rtsp://10.10.1.2/mod.sdp?etime=20110312_040400.000&length=120 Play file file rtsp://10.10.1.2/mod.sdp?filename=/mnt/link0/ User's Manual - 416...
Page 403: Privacy Mask
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.25 3D Privacy Mask (Capability_image_c<0~(n-1)>_privacymask_wintype = 3Drectangle) n denotes the value of "capability_nvideoin" Note: This request requires admin user privilege Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/setpm3d.cgi?method=<value>&maskname=<value>&[maskhei ght=<value>&maskwidth=<value>&videosize=<value>&return=<return page>] PARAMETER VALUE DESCRIPTION method Add a 3D privacy mask at current location delete Delete a 3D privacy mask edit...
Page 404: Camera Control
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.26 Camera Control (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/camctrl/camctrl.cgi?[channel=<value>][&camid=<value>] [&move=<value>] – Move home, up, down, left, right [&focus=<value>] – Focus operation [&zoom=<value>] – Zoom in, out [&zooming=<value>&zs=<value>] –...
Page 405 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION down Move camera down. left Move camera left. right Move camera right. speedpan -5 ~ 5 Set the pan speed. speedtilt -5 ~ 5 Set the tilt speed. speedzoom -5 ~ 5 Set the zoom speed.
Page 406 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION focus auto Auto focus. Focus on further distance. near Focus on closer distance. focusseting sync Applies the selected focus mode in camctrl_c<0~(n-1)>_focusmode to this preset. fixcurrent Applies the current focus position to this preset. * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20.
Page 407 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION getpanangle <integer> Get the current pan angle. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" gettilt 0, <positive integer> Get the current tilt position. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt"...
Page 408: Recall (Capability_Camctrl_C<0~(N-1)>_Zoommodule = 1)
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmintiltangle <integer> Get the lower limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmaxtiltangle <integer> Get the upper limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt"...
Page 409: Preset Locations
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.28 Preset Locations (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/preset.cgi?[channel=<value>] [&addpos=<value>][&delpos=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION addpos string[30] Add one preset location to the preset list. channel 0~"capability_nvideoin"-1 Channel of the video source.
Page 410: Connect To Ap (Capability_Network_Wireless > 0)
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function getstatus Function type getstauts : Information of smartSD internal status return value as below: smartsd_lifetime_num: Accumulated amount of data that has been written smartsd_lifetime_den: Card-guaranteed amount of data that can be written smartsd_lifetime_rate: The ratio of smartsd_lifetime_num to smartsd_lifetime_den.
Page 411: Get Wireless Information
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Syntax: http://<servername>/cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION Apply the wireless settings and connect to AP. 8.31 Get Wireless Information (capability_network_wireless > Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/getwirelessinfo.cgi PARAMETER VALUE DESCRIPTION Get wireless information.
Page 412: Wps Transaction (Capability_Network_Wireless > 0)
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION Get wireless signal strength. 8.33 WPS Transaction (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/start_wps.cgi PARAMETER VALUE DESCRIPTION Start WPS transaction. 8.34 Peripheral Control (capability_peripheral_c<0~(n-1)>_ devicecontrol >...
Page 413 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved "washer_mode : OK\r\n" "washer_status : FAIL\r\n" PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. washer_mode wiper Apply the wiper to the mode of washer control system. washer Apply the washer to the mode of washer control system.
Page 414 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Pragma: no-cache\r\n \r\n supportdevice=washer,heater\r\n washer_status=off\r\n PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. supportdevice Get support peripheral device. washer_supportmode N/A Get the support mode of washer control system. washer_mode Get the current mode of washer control system. It return the value of "washer_mode"...
Page 415: Optimized Ir Control
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.35 Optimized IR control (capability_daynight_c<0~(n-1)>_optimizedir > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/optimizedir.cgi?function=<value>[&channel=<value>] PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. function getstatus, "onetimeauto": Camera will automatically adjust the IR onetimeauto zone one time only.
Page 416 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http://myserver/cgi-bin/admin/optimizedir.cgi?function=getstatus Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irmode='auto'" "optimizedir_c0_irnum='5'" "optimizedir_c0_irstrength='1,97,100,100,100'" "optimizedir_c0_irstatus='normal'" Syntax: (for control API) http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=<value>&irmode= manual[&strength=<value>] – Set IR strength PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. operation set, "set": set the strength of each IR LED separately...
Page 417 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=settoall&irmode=manual&str ength=100 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irstrength='100,100,100,100,100'" "optimizedir_c0_irmode='manual'" Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&irmode=auto&strength= 50,70,50,50,50 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: Parameter "irmode" must be set as "manual"! Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&strength=50,70,50,50,50 Response:...
Page 418: Lens Thermal Control
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=get [&support_irmode] – list all adjustment mode that IR supports [&irmode] – Get current IR mode [&irnum] – Get the number of IR zone PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. support_irmode List all adjustment mode that IR supports irmode...
Page 419 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved \r\n Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: time out Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: fail PARAMETER VALUE DESCRIPTION action shuttercompensate Camera will do shutter compensate.
Page 420: Audio Clip Control (Capability_Audio_Audioclip=1)
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n version=1120B15 8.37 Audio Clip Control (capability_audio_audioclip=1) Note: This request requires Administrator privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/admin/audioclip.cgi?operation=<value>[&name=<value>][&index=<value>] PARAMETER VALUE DESCRIPTION operation startrecording, "startrecording"...
Page 421: Format Sd Card
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved clipname <string> Name of the audio clip. clipindex 0, 1 Number of the audio clip. 8.38 Format SD card Note: This request requires Administrator privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/admin/format_sdcard.cgi?operation=set[&<parameter>=<value>] If the user requests a size larger than all stream settings on the server, this request will fail.
Page 422 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Response of formatting fail: HTTP/1.1 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <Error Message Length>\r\n \r\n <Error Message> Syntax: (for query API) http://<servername>/cgi-bin/admin/ format_sdcard.cgi?operation=get PARAMETER VALUE DESCRIPTION Get formatting progress(0~100) or result(error message) *It is unnecessary when using the blocking mode.
Page 423: Get Sdp For Always Multicast
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved ERROR: The device does not exist or is busy ERROR: Formatted successfully, but cannot create database 8.39 for Accessing Streaming Methods 8.39.1 Get Stream URI (capability_media_streamprofiles_support = 1) Note: This request requires Viewer access privileges. Syntax: For RTSP, the user needs to input the URL below into a RTSP compatible player.
Page 424: Accessing Sftp Server And Client
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Note: This request requires Viewer access privileges. Method: GET/POST Syntax: http://<servername>:<port>/media2/<streamprofile_i<0~(n-1)>_profilename>.sdp?[<parameter>= <value>]  “n” is the maximum stream profile number (capability_media_streamprofiles_num)  “streamprofile_i<x>_profilename” is a friendly name for certain profile, x is within 0~(capability_media_streamprofiles_num)-1.
Page 425 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=<value>[&parameter=<value>] PARAMETER VALUE DESCRIPTION operation automode, manualmode "automode": Key pair will be generated, and automatically copy public key to server. "manualmode": Key should be downloaded or uploaded by user. * This field is required. download, upload "download": Download public key.
Page 426 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved * Only valid when operation=manualmode and key=upload. passphrase_content <128-bit hash value > Passphrase * Only valid when operation=manualmode and key=upload. location string[128] sftp server file location name string[40] Username for server_i<index>_name * The default value is sftp<index>. keytype ed25519, rsa, ecdsa "ed25519": faster to generate with higher...
Page 427 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved value>&keytype=test Response of failure: HTTP/1.1 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <Error Message Length>\r\n \r\n ERROR: Invalid keytype Example of upload private key: POST http://172.16.219.217/cgi-bin/admin/sftpclient.cgi HTTP/1.1 Accept: text/html, application/xhtml+xml, */* Accept-Language: zh-TW User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; rv:11.0) like Gecko Content-Type: multipart/form-data;...
Page 428 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved TovnyQQANfyNLykEtP7U7Htxbdqg4dqYdFahJEBNs0QHxhmYHTESccKM4NOB0qMY 5+9gwlMZqNIymxGlGwylTMcV7gV6JaY/bX0K4J0B6AhNHjCIOFErrQivp026TXj9 m+bnnrAt7v5uBMH4oclPC8oDHqd1jWwHIBcbqjRPWL37VW5B+YPZQ7FVUP496OKp riheNLTF6yOtYFw9syyoOnRF+gxpFpQrSO7skENGyv4CO7kH/S7Kpc7qmMgTk/rL s12230NogZsqghhTJIpg2vX5Ha3wCDIZZVKPUGItQl0MB6t74nsV1o8YVtRovI5F YX2d8sPIIkcTDWBO498+v98DQ7DH51/i39JoJouRojz+n3ffsSGjY2AKEcTde2xI v2f81KqAxkraXllScl1SNEGXQpngXy3IK2GrVw9BzJILMSBuj30Ar2zfTbc0C5VC YqWK1FcMA5Jb6AvYwmpgijIb52T9P7g07RwFGJpumvaqTchBeSp8pXa3C++DoBdY 9zYohmuSSs52QLoIkTPzDjJJHvncddPi6VuUkSyaK5x75p0+aoljPjlAQHXbXsmt 8HAdPs9Fwab9GbC2aumH4XT1xoWFnYJ9lBHc3iZRiI/nSIPev2YneyyOhJg4tHYD swUUEydNC8Q5qrbLfHESDrkHlx0sQiM7A/DyY1akkoxKEFW9LxqsJpcf7LM2TrlX IjSd+RMqL3yCFzM0aqcQNjd77nDP6+u9RYYyGT8dH5ud7pJVofxI+pvpQN3k5Tlb Pm9IM6OJPDy/Netcu6YEl3ULa6XHkYldqezJDnUfCBHe3OKjhue2FTBRmM2/j9Zl DkUrO7lQz7X88T/w5+rI2OnDIm3szOhzMCYPtHxf8ygMKXI/DKp3OR2/cu6ayGhb DezpoSyTjL1fTFINQAymDtP5tbomfESjFDW1fmfD9h1FivqYEy7017djPWrq8mjH N6nAhlaLVVuTVJ+xxaJAzYiQwMdwWY8SGUq062ksDvfixYCQfhXUd629oEX82fJU 8OxF8CM0WEHFCIotJVbFjDyT5lP4qln5EMeMlPE8jrmUKEEV+AJw9AbaqvCYUNaH EVZ7nlYjrnQqMCktYlO/Um8vSiVsOaMFLUdiYJwj2pzyceTzyW19/KEo//8ufOFD LaSp5EGH6lBCTBfQ9PGeOkB2ZVf0jLFB9Sage8Ln5frWYOAROxzumUJWSvOoBael 15OdV5hApqQjGrn1vbc/kC8p478ZCzx2iDyckPqyVpHSke70T5bV6vcDZcCTrwkA PHdD4Q0cqd7sX0R2OAScwJk2AkaQ+PsLwS05hw1nQBsQrC4m9e8Kmg32RgCGDAES xpV9dkSkvoaLZmN1qfBwnyOxsjmx9OAOBKWzMlW5PoPCR9z8Z1gsiACBnrT+K5ec NZdgsxvxMfdI7vfj6mkO89MvwLX8YEtnFrihIZmDnnVMuHfq6g5kbwlHbHVaoImo -----END RSA PRIVATE KEY----- - --------------------------- 7e1309282ed0f1a-- Syntax: (for query API) http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=<value>[&parameter=<value>] PARAMETER VALUE...
Page 429: Sftp Server Setting
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved * This field is required. Example of scanning SFTP server host key: Request: http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=getserverhostkey&address=<ip> Response of success: HTTP/1.1 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <Success Message Length>\r\n \r\n <MD5 value> 8.40.2 SFTP Server Setting * Only available when bit 1 of "capability_protocol_ftp_server"...
Page 430 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Syntax: (for query API) http://<servername>/cgi-bin/admin/sftpserver.cgi?operation=<value> PARAMETER VALUE DESCRIPTION operation gethostkey "gethostkey": Get host key for SFTP server. * This field is required. * If “updatehostkey” is not yet finished, you will receive error message.
Page 431: Technology License Notice
VIVOTEK Technology License Notice AMR-NB Standard THIS PRODUCT IS LICENSED UNDER THE AMR-NB STANDARD PATENT LICENSE AGREEMENT. WITH RESPECT TO THE USE OF THIS PRODUCT, THE FOLLOWING LICENSORS’ PATENTS MAY APPLY: TELEFONAKIEBOLAGET ERICSSON AB: US PAT. 6192335; 6275798; 6029125; 6424938; 6058359. NOKIA CORPORATION: US PAT.
Page 432: Electromagnetic Compatibility (Emc)
VIVOTEK Electromagnetic Compatibility (EMC) FCC Statement This device compiles with FCC Rules Part 15. Operation is subject to the following two conditions. ■ This device may not cause harmful interference, and ■ This device must accept any interference received, including interference that may cause undesired operation.

This manual is also suitable for:

Vivotek ms9321-ehv-v2