VIVOTEK Table of Contents Overview ................................Revision History ...............................3 Read Before Use ..............................4 Package Contents ............................4 Symbols and Statements in this Document ......................5 Physical Description ............................5 Hardware Installation ............................8 Mounting Options .............................8 Software Installation ............................15 Network Deployment ............................23 Ready to Use ..............................26 Accessing the Network Camera ........................
VIVOTEK Storage ..............................143 Storage > NAS management ........................144 Storage > Content management ......................146 Appendix ..............................URL Commands for the Network Camera ....................149 Technical Specifications ........................... 375 Technology License Notice ........................377 Electromagnetic Compatibility (EMC) ....................... 378 Overview VIVOTEK’s MS9390-EHV-v2 is the latest and most effcient panoramic network camera offered in surveillance.
VIVOTEK 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. It is the user’s responsibility to ensure that the operation of such devices is legal before installing this unit for its intended use.
VIVOTEK Symbols and Statements in this Document INFORMATION: provides important messages or advices that might help prevent inconvenient or problem situations. NOTE: Notices provide guidance or advices that are related to the functional integrity of the machine. Tips: Tips are useful information that helps enhance or facilitae an installation, function, or process.
Page 6
VIVOTEK Inner View Lenses IR LEDs IR LEDs Microphone contacts MicroSD card slot Reset button Status LEDs Bottom View Ground screw RJ45 Ethernet port Ethernet enclosure retention clips Tether wire safety hook (to the mounting plate) Bottom routing cap 6 - User's Manual...
Page 7
VIVOTEK Power Consumption 802.3at 100~240V LAN/PoE GE LAN GE LAN 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 &...
VIVOTEK Hardware Installation 1. Jot down the camera's MAC address from the product label. This is important if you have multiple cameras at your installation site. Network Camera Model No: XXXXXX MAC: 0002D1083236 This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference...
Page 9
VIVOTEK If preferred, the camera can also be pole-mounted using the AM-114 mount head, AM-117 pole, and the AM-11G adapter. AM-114 Note that this configuration is indoor only. 473 mm AM-117 AM-11G Note the camera's field of view when planning an installation. The horizontal view is 180º.
Page 10
VIVOTEK Below is the process for a standard wall-mount. 2. Use the included alignment sticker to drill mounting holes on the wall (the C holes). If preferred, drill another hole of a diameter of approximately 2cm for routing the Ethernet cable.
Page 11
VIVOTEK 4. Pass an Ethernet cable through the routing hole. 5. Pass an Ethernet cable through the waterproof cable gland components, and through the rubber seal as shown below. Connect the Ethernet cable to the camera's RJ45 onnector. Tighten the components to prevent water ingress. User's Manual - 11...
Page 12
VIVOTEK 5. Press the Ethernet waterproof enclosure in between the retention clips at the back of the camera. The retention clips will hold the enclosure in place. Connect the ground wire to a grounded earth rod with a resistance smaller than 4Ω, with a section area larger than 25mm , to a ground rod 1.5 meters into the ground.
Page 13
VIVOTEK 7. Connect the tether wire on the mounting plate to the safety latch hook on the back of the camera. 8. Align the camera with the mounting plate, and then secure the T10 anti-tamper screws to install the camera. User's Manual - 13...
Page 14
VIVOTEK 9. Install a Micro SD card. 10. When the Ethernet and I/O wires connection is done and the camera is powered up, try find the camera using VIVOTEK's Shepherd utility. Double-click on the camera's entry on Shepherd to open a web console with the camera.
VIVOTEK Software Installation 11. Install the Shepherd utility, which helps you locate and configure your Network Camera in the local network. If your camera comes without the CD, go to VIVOTEK’s website, and locate the utility in the Downloads > Software page. 11-1.
Page 16
VIVOTEK 11-3. The program will search for all VIVOTEK network devices on the same LAN. 11-4. After a brief search, the installer window will prompt. Click on the MAC and model name that matches the one printed on the product label. You can then double-click on the address to open a management session with the Network Camera.
Page 17
VIVOTEK 12-2. Enter the combination of alphabetic and numeric characters to fulfill the password strength. requirement. The default name for the camera administrator is “root”, and can not be changed. Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~. You can use them in the password combination.
Page 18
VIVOTEK Cybersecurity Once you open the web console, enter Configuration > Applications > Package management, and click on Trend Micro IoT Security. Turn on the protection to fend off cyber attacks. In here, you can let the camera automatically update the virus codes or manually update the virus codes.
Page 19
VIVOTEK Depending on the live view, you can turn the lens modules down to cover the FOV you desire. 20º 13. Replace the desiccant bag that is attached to the center of the dome cover. User's Manual - 19...
Page 20
VIVOTEK Tilt the lens assembly, not the lens. 20 - User's Manual...
Page 21
VIVOTEK 14. Install the dome cover by fastening 4 T10 screws. Torque: 6.5±0.5kgf-cm 15. Install the sunshield if your mounting position is exposed to direct sun light. User's Manual - 21...
Page 22
VIVOTEK Hardware Reset Reset Button The reset button is used to reset the system or restore the factory default settings. Sometimes resetting the system can return the camera to normal operation. If the system problems remain after reset, restore the factory settings and install again. Reset: Press the recessed reset button.
VIVOTEK Network Deployment General Connection (PoE) When using a PoE switch The Network Camera is PoE-compliant, allowing transmission of power and data via a sin- gle Ethernet cable. Follow the below illustration to connect the Network Camera to a PoE 802.3at class 1 or class 2 switch or mid-span via an Ethernet cable.
Page 24
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 25
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.
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 VAST 32-channel recording software in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents.
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 Netwotk Camera: ®...
Page 28
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 97.
Page 29
VIVOTEK IMPORTANT: • Currently the Network Camera utilizes a 32-bit ActiveX plugin. You CAN NOT open a management/view session with the camera using a 64-bit IE browser. • If you encounter this problem, try execute the Iexplore.exe program from C:\Windows\ SysWOW64.
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 1. Launch the RTSP player. 2. Choose File > Open URL. A URL dialog box will pop up. mpegable Player 3.
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.
VIVOTEK Using VIVOTEK Recording Software The VAST 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 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 Configuration Area VIVOTEK INC. Host Name Logo Camera Control...
Page 34
VIVOTEK Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 38. Configuration: Click this button to access the configuration page of the Network Camera. It is suggested that a password be applied to the Network Camera so that only the administrator can configure the Network Camera.
Page 35
VIVOTEK Video Title: The video title can be configured. For more information, please refer to Video Settings on page 54. H.264 or H. 265 Protocol and Media Options: The transmission protocol and media options for H.264 video streaming. For further configuration, please refer to Client Settings on page 38. Time: Display the current time.
Page 36
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 37
VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Time Video (HTTP-V) 2015/03/25 17:08:56 Title and Time Video 17:08:56 2015/03/25 Zoom Indicator x4.0 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 58.
VIVOTEK Client Settings This chapter explains how to select the stream transmission mode and saving options on the local computer. When completed with the settings on this page, click Save on the page bottom to enable the settings. H.265/H.264 Media Options Select to stream video or audio data or both.
Page 39
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.
VIVOTEK Configuration Click Configuration on the main page to enter the camera setting pages. Note that only Administrators can access the configuration page. Please refer to page 97 Security > User Account for how to configure access rights for different users. Navigation Area Configuration List Firmware Version...
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 42
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 43
VIVOTEK Western Argentina Summer Time (WARST) is 3 hours behind the prime meridian all year. There is a dummy fall-back 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.
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 hompage 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 in this Preview field.
Page 45
VIVOTEK Theme Options Here you can change the color of your homepage layout. There are three types of preset patterns for you to choose from. The new layout will simultaneously appear in the Preview filed. Click Save to enable the settings.
Page 46
VIVOTEK ■ Follow the steps below to set up the customed homepage: 1. Click Custom on the left column. 2. Click the field where you want to change the color on the right column. Color Selector Custom Pattern 3. The palette window will pop up as shown below. 4.
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 48
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. VIVOTEK Network Cameras Internet 3G Cell phone...
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. System >...
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 51
VIVOTEK IMPORTANT: Through extensive use, temporary files may accumulate that disable a firmware upgrade. You can use the Clean up function in the Application > Package management window to solve this problem. User's Manual - 51...
Page 52
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 79). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
Page 53
VIVOTEK The following message is displayed when attempting to upload an incorrect file format. Export language file: Click to export language strings. VIVOTEK provides nine languages: English, Deutsch, Español, Français, Italiano, 日本語, Português, 簡体中文, and 繁體中文 . Update custom language file: Click Browse… and specify your own custom language file to upload. Export configuration file: Click to export all parameters for the device and user-defined scripts.
VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following four columns: General settings, Picture settings, Exposure, Focus, and Privacy mask. The Focus window is available only for models that come with motorized lens.
Page 55
VIVOTEK Video orientation: Flip - vertically reflect the display of the live video; Mirror - horizontally reflect the display of the live video. Select both options if the Network Camera is installed upside-down (e.g., on the ceiling) to correct the image orientation. Please note that if you have preset locations, those locations will be cleared after flip/mirror setting.
Page 56
VIVOTEK IR control 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. Smart IR Anti-overexposure: When enabled, the camera automatically adjusts the IR projection to adjacent objects in order to avoid over-exposure in the night mode.
Page 57
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 an “Exposure Exclude” window on an unavoidable object in the Exposure setting window. See page 61 for how to do it.
Page 58
VIVOTEK Image settings On this page, you can tune the White balance and Image adjustment. Sensor mode: By default, the firmware adopts the Panorama mode and tries its best to stitch the imaging results to form a coherent 180º panoramic view. If you select the Regional mode, the firmware will ignore the incoherence among images and display 4 regional views according to their separate lighting conditions.
Page 59
VIVOTEK Image Adjustment ■ Brightness: Adjust the image brightness level, which ranges from 0% to 100%. ■ Contrast: Adjust the image contrast level, which ranges from 0% to 100%. ■ Saturation: Adjust the image saturation level, which ranges from 0% to 100%. ■...
Page 60
VIVOTEK Exposure On this page, you can configure the Exposure measurement window, Exposure level, Exposure mode, Exposure time, Gain control, and Day/Night mode settings. You can configure two sets of Exposure settings: one for normal situations, the other for special situations, such as the day/night/ schedule mode.
Page 61
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 62
VIVOTEK ■ AE Speed Adjustment: This function applies when you need to monitor fast changing lighting conditions. For example, the camera may need to monitor a highway lane or entrance of a parking area at night where cars passing by with their lights on can bring fast changes in light levels. The same applies if the camera is installed on a vehicle, and when it needs to adapt to fast changes of light when entering and leaving a tunnel.
Page 63
VIVOTEK Privacy mask Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to address privacy concerns. ■ To configure privacy mask windows, 1. Click New to add a new window. 2. You can use 4 mouse clicks to create a new masking window. 3.
Page 64
VIVOTEK Pixel Calculator Click the Add button at the lower screen to create a pixel calculator window. Place your cursor on the window to move it to an area of your interest, and change the size of window to fit the area of interest. Once they are drawn, the numbers of pixels on the sides of windows will appear.
Page 65
VIVOTEK Take the following into consideration when using this feature: 1. Operational requirement: Identify a human or a human face. 2. Why human face? There are less variances in the size of a face than that for limbs and body. Human face is normally 16cm wide.
Page 66
VIVOTEK Lens alignment The system default is 10 meters. The configurable range is 3 to 20 meters. Because the FOVs of the juxtaposed lenses are slightly overlapped, and the stitching of these FOVs is coordinated with the distance to your point of interest in scene. Use the slide bar to select the distance between your spot of interest and your camera to acquire an optimal stitched-up image.
VIVOTEK Media > Video Stream settings This Network Camera supports multiple streams with frame sizes ranging from 640 x 256 to 4864 x 1632 pixels. ■ Stream 1: The default frame size for Stream 2 is set to the 4864 x 1632. ■...
Page 68
VIVOTEK Click the stream item to display the detailed information. The maximum frame size will follow your settings in the above Viewing Window sections. This Network Camera offers real-time H.265, H.264 and MJPEG compression standards (Triple H.265 or H.264 Codec) for real-time viewing. If the mode is selected, the video is streamed via RTSP protocol.
Page 69
VIVOTEK ■ Intra frame period Determine how often for firmware to plant an I frame. The shorter the duration, the more likely you will get better video quality, but at the cost of higher network bandwidth consumption. Select the intra frame period from the following durations: 1/4 second, 1/2 second, 1 second, 2 seconds, 3 seconds, and 4 seconds.
Page 70
VIVOTEK With the H.265 codec in an optimal scenario and when Dynamic Intra frame is combined with the Smart Stream function, an 80% of bandwidth saving can be achieved compared with using H.264 without enabling these bandwidth-saving features. ■ Smart FPS In a static scene, the algorithm re-encodes old frames when no motions occur in scene.
Page 71
VIVOTEK 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. Slide bar to the right - higher quality in the ROI areas Slide bar to the left - higher quality in the non-ROI areas.
Page 72
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. non-ROI: lower-quality ROI:...
Page 73
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 74
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.
Page 75
VIVOTEK JPEG If the 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.
VIVOTEK Media > Audio Audio Settings Mute: Select this option to disable audio transmission from the Network Camera to all clients. Note that if muted, no audio data will be transmitted even if audio transmission is enabled on the Client Settings page.
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.
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 79
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 80
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 81
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 82
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 83
VIVOTEK Please follow the steps below to link to an IPv6 address: 1. Open your web browser. 2. Enter the link-global or link-local IPv6 address in the address bar of your web browser. 3. The format should be: http://[2001:0c08:2500:0002:0202:d1ff:fe04:65f4]/ IPv6 address 4.
VIVOTEK Network > Streaming protocols HTTP streaming To utilize HTTP authentication, make sure that your have set a password for the Network Camera first; please refer to Security > User account on page 97 for details. Authentication: Depending on your network security requirements, the Network Camera provides two types of security settings for an HTTP transaction: basic and digest.
Page 86
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 Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter. 3.
Page 87
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 88
VIVOTEK RTSP port /RTP port for video, audio/ RTCP port for video, audio ■ RTSP (Real-Time Streaming Protocol) controls the delivery of streaming media. By default, the port number is set to 554. ■ The RTP (Real-time Transport Protocol) is used to deliver video and audio data to the clients. By default, the RTP port for video is set to 5556 and the RTP port for audio is set to 5558.
Page 89
VIVOTEK 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. Therefore, enabling multicast can effectively save Internet bandwith.
VIVOTEK Network > DDNS This section explains how to configure the dynamic domain name service for the Network Camera. DDNS is a service that allows your Network Camera, especially when assigned with a dynamic IP address, to have a fixed host and domain name. Manual setup DDNS: Dynamic domain name service Enable DDNS: Select this option to enable the DDNS setting.
Page 91
VIVOTEK 3. Click Copy and all the registered information will automatically be uploaded to the corresponding fields in the DDNS column at the top of the page as seen in the picture. [Register] Successfully Your account information has been mailed to registered e-mail address 4.
Page 92
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 93
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.
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.
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.
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.
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 98
VIVOTEK Privilege management Digital Output & PTZ control: 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.
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 100
VIVOTEK 5. Click Save to preserve your configuration, and your current session with the camera will change to the encrypted connection. 6. If your web session does not automatically change to an encrypted HTTPS session, click Home to return to the main page. Change the URL address from “http://” to “https://“ in the address bar and press Enter on your keyboard.
Page 101
VIVOTEK Create certificate request and install 1. Select the option from the Method pull-down menu. 2. Click Create certificate to proceed. 3. The following information will show up in a pop-up window after clicking Create. Then click Save to generate the certificate request. 4.
Page 102
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 103
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. User's Manual - 103...
Page 104
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. 104 - User's Manual...
Page 105
VIVOTEK Note that 11. When the certifice file is successfully loaded, its status will be stated as Active. a certificate must have been created and installed before you can click on the “Save" button for the configuration to take effect. 12.To begin an encrypted HTTPS session, click Home to return to the main page.
VIVOTEK Security > Access List This section explains how to control access permission by verifying the client PC’s IP address. General Settings Maximum number of concurrent streaming connection(s) limited to: Simultaneous live viewing for 1~10 clients (including stream 1 to stream 3). The default value is 10. If you modify the value and click Save, all current connections will be disconnected and automatically attempt to re-link (IE Explorer or Quick Time Player).
Page 107
VIVOTEK ■ Refresh: Click this button to refresh all current connections. ■ Add to deny list: You can select entries from the Connection Status list and add them to the Deny List to deny access. Please note that those checked connections will only be disconnected temporarily and will automatically try to re-link again (IE Explorer or Quick Time Player).
Page 108
VIVOTEK There are three types of rules: Single: This rule allows the user to add an IP address to the Allowed/Denied list. For example: 192.168.2.1 Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List.
Page 109
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 110
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 111
VIVOTEK Security > Miscellaneous The embedded TrendMicro utitlity 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. Unauthorized commands are transmitted from a user that the web application trusts, using the mechanism of forging a trusted user's own request with a request containing his own cookies, etc.
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 explaining that an event can be triggered by many sources, such as motion detection or external digital input devices.
Page 113
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 114
VIVOTEK ■ Audio detection A preset threshold can be configured with an external microphone as the trigger to system event. The triggering condition can be an input exceeding or falling below a threshold. Audio detection can take place as a complement to motion detection or as a method to detect activities not covered by the camera's view.
Page 115
VIVOTEK ■ VADP It is presumed that you already uploaded and enabled the VADP modules before you can associatee VADP triggers with an Event setting. Click on the Set VADP Trigger button to open the VADP setup menu. The triggering conditions available with 3rd-party software modules known as VADP will be listed.
Page 116
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 117
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 118
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 119
VIVOTEK ■ Passive mode Most firewalls do not accept new connections initiated from external requests. If the FTP server supports passive mode, select this option to enable passive mode FTP and allow data transmission to pass through the firewall. To verify if the FTP settings are correctly configured, click Test. The result will be shown in a pop-up window as shown below.
Page 120
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. ■ Folder name Enter the folder where the media file will be placed.
Page 121
VIVOTEK Publickey 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 122
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. ■ User name: Enter the user name if necessary. ■...
Page 123
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 141 for details. Note that only one NAS server can be configured. Click Save server to enable the settings. ■...
Page 124
VIVOTEK Click 20170120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2017/01/20 2017/01/20 Click to go back to the previous Click to delete level of the directory selected items Click to delete all recorded data 2017/01/20 2017/01/20...
Page 125
VIVOTEK Add media Add media Click to open the media setting window. You can specify the type of media that will be sent when a trigger is activated. A total of 5 media settings can be configured. There are three choices of media types available: Snapshot, Video Clip, and System log.
Page 126
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_20170513_100341 File name prefix Date and time suffix 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 127
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_20170513_100341 File name prefix...
Page 128
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 129
VIVOTEK Customized Script This function allows you to upload a sample script (.xml file) to the camera, which will save your time on configuring the settings. Please note that there is a limited number of customized scripts you can upload; if the current amount of customized scripts has reached the limit, an alert message will prompt.
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.
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.
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 133
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.
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.
VIVOTEK Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) Users can store and execute VIVOTEK's or 3rd-party software modules onto the camera's flash memory or SD card. These software modules can apply in video analysis for intelligent video applications such as license plate recognition, object counting, or as an agent for edge recording, etc.
Page 136
VIVOTEK To start a module, select the checkcircle in front, and click the Start button. If you should need to remove a module, select the checkcircle in front and then click the Stop button. By then the module status will become OFF, and the X button will appear at the end of the row.
Page 137
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. User's Manual - 137...
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 139
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. NOTE: ►...
Page 140
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 141
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 142
VIVOTEK Event f you want to enable recording notification, please click to configure event triggering settings. Please refer to Event > Event settings on page 112 for more details. When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page.
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. •...
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 145
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 ■ Minimum reserved storage space: The reserved space can be used as a safe buffer especially when the cyclic recording function is enabled, during the transaction stage when a storage space is full and the incoming streaming data is about to overwrite the previously saved videos.
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 147
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 148
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 ■...
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 150
VIVOTEK 3. General CGI URL Syntax and Parameters CGI parameters are written in lower-case and as one word without any underscores or other separators. When the CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server.
Page 151
VIVOTEK 5. Get Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/viewer/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/operator/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/admin/getparam.cgi?[<parameter>] [&<parameter>…] Where the <parameter> should be <group>[_<name>] or <group>[.<name>]. If you do not specify any parameters, all the parameters on the server will be returned.
Page 152
VIVOTEK http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&update=<value>][&return=<return page>] http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&update=<value>] [&return=<return page>] http://<servername>/cgi-bin/operator/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&update=<value>] [&return=<return page>] http://<servername>/cgi-bin/admin/setparam.cgi? <parameter>=<value>...
Page 153
VIVOTEK placed at the end of the parameter list Return: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: <length>\r\n \r\n <parameter pair> where<parameter pair> is <parameter>=<value>\r\n [<parameter pair>] Only the parameters that you set and are readable will be returned. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123 Response:...
Page 154
VIVOTEK 7. Available parameters on the server Valid values: VALID VALUES DESCRIPTION string[<n>] Text strings shorter than ‘n’ characters. The characters “,’,<,>,& are invalid. string[n~m] Text strings longer than `n’ characters and shorter than `m’ characters. The characters “,’,<,>,& are invalid. password[<n>] The same as string but displays‘*’...
Page 155
VIVOTEK W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 available The API is listed in product WebAPIs. non-available The API is not in product WebAPIs. valid The API is listed in product WebAPIs, and is functional. non-valid The API is listed in product WebAPIs, but is malfunction in this status.
Page 156
VIVOTEK 7.1 System Group: system NAME VALUE SECURITY DESCRIPTION (get/set) hostname string[64] Host name of server (Network Camera, Wireless Network Camera, Video Server, Wireless Video Server). ledoff <boolean> Turn on (0) or turn off (1) all led indicators. date <YYYY/MM/DD>, Current date of system.
Page 158
VIVOTEK Caledonia 480: GMT 12:00 Aucklan, Wellington, Fiji, Kamchatka, Marshall Is. 520: GMT 13:00 Nuku'Alofa daylight_enable <boolean> Enable automaticdaylight saving time in time zone. daylight_dstactualmode <positive integer> Check if current time is under daylight saving time. (Used internally) daylight_auto_begintime string[19] Display the current daylight saving start time.
Page 159
VIVOTEK user has uploaded. This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results. restoreexceptvadp Restore the system parameters to default <positive integer>...
Page 160
VIVOTEK 7.1.1 System.info Subgroup of system: info (The fields in this group are unchangeable.) NAME VALUE SECURITY DESCRIPTION (get/set) modelname string[40] Internal model name of the server extendedmodelname string[40] ODM specific model name of server (eg. DCS-5610). If it is not an ODM model, this field will be equal to “modelname”...
Page 161
VIVOTEK xcount-1)> 7.2status Group: status NAME VALUE SECURITY DESCRIPTION (get/set) di_i<0~(capability_ndi-1)> <boolean> 0 => Inactive, normal <product dependent> 1 => Active, triggered (capability.ndi > 0) do_i<0~(capability_ndo-1)> <boolean> 0 => Inactive, normal <product dependent> 1 => Active, triggered (capability.ndo > 0) onlinenum_rtsp 0,<positive Current number of RTSP connections.
Page 162
VIVOTEK 7.2.1 status per channel Group: status_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) signal_detect <boolean> Indicates whether the video source is connected or not. * Only available when capability_videoin_type is 0 or 1. signal_type ntsc,pal The actual modulation type.
Page 163
VIVOTEK 7.5security Group: security NAME VALUE SECURITY DESCRIPTION (get/set) privilege_do view, operator, Indicate which privileges and above can admin control digital output (capability.ndo > 0) privilege_camctrl view, operator, Indicate which privileges and above can admin control PTZ (capability.ptzenabled > 0 or capability.eptz > user_i0_name string[64] User name of root...
Page 164
VIVOTEK 7.6 Network Group: network NAME VALUE SECURITY DESCRIPTION (get/set) preprocess <positive integer> An 32-bit integer, each bit can be set separately as follows: Bit 0 => HTTP service; Bit 1=> HTTPS service; Bit 2=> FTP service; Bit 3 => Two way audio and RTSP Streaming service;...
Page 166
VIVOTEK 7.6.2 QOS Subgroup of network: qos_cos (capability.protocol.qos.cos > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable CoS (IEEE 802.1p) vlanid 1~4095 VLAN ID video Video channel for CoS audio Audio channel for CoS <product dependent> (capability.naudioin > 0) eventalarm Event/alarm channel for CoS management...
Page 167
VIVOTEK 7.6.4 FTP Subgroup of network: ftp 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 ~ 65535 HTTP port. alternateport 1025~65535 Alternate HTTP port.
Page 168
VIVOTEK 7.6.7 RTSP Subgroup of network: rtsp (capability.protocol.rtsp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 554, 1025 ~ 65535 RTSP port. (capability.protocol.rtsp=1) anonymousviewing <boolean> Enable anoymous streaming viewing. authmode disable, RTSP authentication mode. basic, (capability.protocol.rtsp=1) digest s<0~(capability_nmediast string[32] RTSP access name for stream N, N= 1~ ream-1)>_accessname capability.nmediastream.
Page 169
VIVOTEK number (httpversion) is equal or greater than 0304a. audioipaddress <ip address> Multicast audio IP address. <product dependent> * We support this parameter when the version number (httpversion) is equal or greater than 0304a. * Only available when capability_naudioin > 0 metadataipaddress <ip address>...
Page 170
VIVOTEK 7.6.10 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. 7.7IP Filter Group: ipfilter NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable access list filtering. admin_enable <boolean>...
Page 171
VIVOTEK 7.8Video input Group: videoin NAME VALUE SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 CMOS frequency. * Only available when capability_videoin_type is 2. whitebalance auto, Modes of white balance. "auto": Auto white balance <product dependent> manual, rbgain, "rbgain": Use rgain and bgain to set white widerange, balance manually.
Page 172
VIVOTEK 6: EV 0 7: EV +0.3 8: EV +0.7 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.0 * Only available when "capability_image_c<0~(n-1)>_exposure_m ode" !=0 irismode fixed, indoor, Control DC-Iris mode. "outdoor": Auto-setting DC-Iris to get best outdoor <product quality, but easy to meet rolling or flicker effect...
Page 173
VIVOTEK (external), 1(built-in) 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 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only) text string[64] Enclose caption.
Page 174
VIVOTEK * Only available when "capability_image_c<0~(n-1)>_exposure_m axrange" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposure_ra ngetype" is "twovalues". enablepreview <boolean> Usage for UI of exposure settings. Preview settings of video profile. * Only available when "capability_image_c<0~(n-1)>_exposure_m ode"...
Page 175
VIVOTEK 7.8.1 Video input setting per channel Group: videoin_c<0~(n-1)> for n channel products, and m is stream number n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" NAME VALUE SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 CMOS frequency. * Only available when "...
Page 176
VIVOTEK * Only available when "rbgain" is listed "capability_image_c<0~(n-1)>_wbm ode". * Only valid when "videoin_c<0~(n-1)>_whitebalance" != auto * Normalized range. bgain 0~100 Manual set bgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain" is listed "capability_image_c<0~(n-1)>_wbm ode".
Page 177
VIVOTEK exposuremode auto, Select exposure mode. <product shutterpriority, dependent> irispriority, "auto": Automatically adjust the Iris, qualitypriority, Gain and Shutter Speed to fit the manual, exposure level. "shutterpriority": Manually adjust with variable Shutter Speed, and keep (Available options are list in adjusting Iris, Gain automatically.
Page 178
VIVOTEK "manual": Manual set P-Iris by "piris_position". "-": not support. (only available when "capability_image_c<0~(n-1)>_sens ortype" is "smartsensor") * Only available when "capability_image_c<0~(n-1)>_iristy pe"=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)>_sens ortype"...
Page 179
VIVOTEK 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_ mingain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_expo sure_rangetype" is "twovalues". gainvalue 0~100 Gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_ maxgain"...
Page 180
VIVOTEK 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 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only) text string[64] Enclose caption. imprinttimesta <boolean> Overlay time stamp on video. textonvideo_po top, bottom Text on video string position...
Page 181
VIVOTEK <5~8000>, 1~8000 => 1s ~ 1/8000s etc. 5~8000 => 1/5s ~ 1/8000s etc. * Available value is listed in "capability_image_c<0~(n-1)>_expo * This parameter may also restrict sure_maxrange" image frame rate from sensor due to sensor generates a frame per exposure time.
Page 182
VIVOTEK sure_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. enablepreview <boolean> Usage for UI of exposure settings. Preview settings of video profile. * Only available when "capability_image_c<0~(n-1)>_expo sure_mode" !=0 crop_position <coordinate>...
Page 183
VIVOTEK "capability_videoin_c<0~(n-1)>_sma rtfps_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. s<0~(m-1)>_h <boolean> Enable "Dynamic intra frame period". 264_dintraperio * Only available when d_enable "capability_videoin_c<0~(n-1)>_dint raperiod_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0301c.
Page 184
VIVOTEK 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"= vbr and "quant"= 100. The maximum allowed bit rate in fixed s<0~(m-1)>_h 20000~"capability_videoin_c<0~(n-1 " quality mode. 264_maxvbrbitr )>_h264_maxbitrate When the bit rate exceeds this value, frames will be dropped to restrict the bit rate. * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~5, 100 Set the pre-defined quality level: 264_cbr_quant 1: Medium 2: Standard...
Page 185
VIVOTEK * Only valid when "ratecontrolmode"= s<0~(m-1)>_h framerate,imagequality Set prioritypolicy 264_prioritypoli * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~"capability_videoin_c<0~(n-1)>_h The maximum frame rates of a H264 264_maxframe 264_maxframerate" stream at different resolutions("capability_videoin_c<0~ (n-1)>_resolution") are recorded in "capability_videoin_c<0~(n-1)>_h26 4_maxframerate" s<0~(m-1)>_h Indicate H264 profiles 264_profile 0: baseline...
Page 186
VIVOTEK mode encoded in the same quality. * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_h 1~5, Set the pre-defined quality level: 265_quant 99, 100 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "qpercent"...
Page 187
VIVOTEK bit rate. * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~5, 100 Set the pre-defined quality level: 265_cbr_quant 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent"...
Page 188
VIVOTEK s<0~(m-1)>_h framerate,imagequality Set prioritypolicy 265_prioritypoli * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~"capability_videoin_c<0~(n-1)>_h The maximum frame rates of a H265 265_maxframe 265_maxframerate" stream at different resolutions("capability_videoin_c<0~ (n-1)>_resolution") are recorded in "capability_videoin_c<0~(n-1)>_h26 5_maxframerate"...
Page 189
VIVOTEK 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue" s<0~(m-1)>_m 10~200 Manual video quality level input. The Q jpeg_qvalue (Only valid when value which is used by encoded library "capability_api_httpversion" format is directly. XXXXX_1 or XXXXX_3 ex: 0301a_1 or 0301a_3) * Only valid when "ratecontrolmode"= or 1~99...
Page 190
VIVOTEK "ratecontrolmode"= cbr. * Only available when "capability_smartstream_version" >= "2.0" s<0~(m-1)>_m 1~100 Select customized quality in a jpeg_cbr_qperc normalized full range. 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"= cbr and "quant"= 100. * Only available when "capability_smartstream_version"...
Page 191
VIVOTEK dependent> * Only available when "capability_image_c<0~(n-1)>_wdrp ro_mode" > 0 wdrpro_strengt 1~100 The strength of WDR Pro. The bigger value means the stronger <product strength of WDR Pro. dependent> * Only available when "capability_image_c<0~(n-1)>_wdrp ro_strength" is 1 wdrc_mode <boolean> Enable WDR enhanced. <product * Only available when dependent>...
Page 192
VIVOTEK vity 1~20: level 1 <product 21~40: level 2 dependent> 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher sensitivity level meas that it is easy to be trigger while scene changed. * Only available when "capability_image_c<0~(n-1)>_aesp eed"...
Page 193
VIVOTEK * Only available when "capability_fisheyelocaldewarp_c<0~( capability_nvideoin)-1>" > 0 Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h264_smartstream2 (capability_smartstream_support=1 and capability_smartstream_version>=2.0) Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h265_smartstream2 (capability_smartstream_support=1, capability_smartstream_version>=2.0 and h265 is listed in "capability_videoin_codec") n denotes the value of "capability_nvideoin",m denotes the value of " capability_nmediastream" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean>...
Page 194
VIVOTEK Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h264_smartstream2_win_i<0~(k-1)> (capability_smartstream_support=1, capability_smartstream_version>=2.0 and capability_smartstream_mode_manual = 1) Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h265_smartstream2_win_i<0~(k-1)> (capability_smartstream_support=1, capability_smartstream_version>=2.0 and h265 is listed in "capability_videoin_codec" and capability_smartstream_mode_manual = 1) n denotes the value of "capability_nvideoin",m denotes the value of " capability_nmediastream",k denotes the value of "capability_smartstream_nwindow_manual". NAME VALUE SECURITY...
Page 195
VIVOTEK 7.8.1.1 Alternative video input profiles per channel In addition to the primary setting of video input, there can be alternative profile video input setting for each channel which might be for different scene of light (daytime or nighttime). Group: videoin_c<0~(n-1)>_profile_i<0~(m-1)> for n channel profucts and m profile n denotes the value of "capability_nvideoin"...
Page 196
VIVOTEK * Available value is listed in * This parameter may also restrict image "capability_image_c frame rate from sensor due to sensor <0~(n-1)>_exposu generates a frame per exposure time. Ex: If re_maxrange" this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.
Page 197
VIVOTEK <Not support anymore> * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c<n>_mode" to switch on/off BLC. exposurelevel 0~12 Exposure level "0,12": This range takes the concept from DC's exposure tuning options.
Page 198
VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0302a. *Only available when "capability_image_c0_exposure_mode" is 0 whitebalance auto, Modes of white balance. <product dependent> manual, "auto": Auto white balance "rbgain": Use rgain and bgain to set white rbgain, widerange, balance manually.
Page 199
VIVOTEK * Only valid when "videoin_c<0~(n-1)>_whitebalance" != auto * Normalized range. maxgain 0~100 Maximum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_maxgain " != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposure_ra ngetype"...
Page 200
VIVOTEK piris_mode manual, indoor, Control P-Iris mode. <product dependent> outdoor,- "outdoor": Auto-setting P-Iris to get best quality, but easy to meet rolling or flicker effect in indoor environment. "indoor": Avoid rolling and flicker effect first. "manual": Manual set P-Iris by "piris_position".
Page 201
VIVOTEK "capability_image_c<0~(n-1)>_wdrpro_stren gth" is 1 wdrc_mode <boolean> Enable WDR enhanced. <product dependent> * Only available when "capability_image_c<0~(n-1)>_wdrc_mode" is 1 wdrc_strength 1~100 The strength of WDR enhanced. <product dependent> The bigger value means the stronger strength of WDR enhanced. * Only available when "capability_image_c<0~(n-1)>_wdrc_mode"...
Page 202
VIVOTEK "capability_image_c<0~(n-1)>_aespeedsupp ortsensitivity" is 1. flickerless <boolean> Turn on(1) or turn off(0) the flickerless mode <product dependent> * Only available when "capability_image_c<0~(n-1)>_flickerless" is 7.9Time Shift settings Group: timeshift for n channel profucts and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" (capability.timeshift >...
Page 203
VIVOTEK 7.10 IR cut control Group: ircutcontrol (capability.nvideoinprofile> 0 and capability_daynight_c<0~(n-1)>_support > 0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, Set IR cut control mode day, night, schedule <product dependent> <boolean> Enable/disable Smart IR <product dependent>...
Page 204
VIVOTEK "low,normal,high": if _c<0~(n-1)>_ircut sensitivity_type=op capability_daynight_c<0~(n-1)>_ircutsensiti tions) vity_type=options "1~100": if 1~100 (if capability_daynight capability_daynight_c<0~(n-1)>_ircutsensiti _c<0~(n-1)>_ircut vity_type=normalize sensitivity_type=no rmalize) * Only available when "capability_daynight_c<0~(n-1)> _ircutsensitivity_type" is not "-". 204 - User's Manual...
Page 205
VIVOTEK 7.11 Image setting per channel Group: image_c<0~(n-1)> for n channel profucts and m profile n denotes the value of "capability_nvideoin" and m denotes the value of "capability_nvideoinprofile" NAME VALUE SECURITY DESCRIPTION (get/set) brightness -5~5,100 -5: Darker <-> 5: Bright <Not recommended to use this>...
Page 206
VIVOTEK "saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. sharpness -3~3,100 -3: Softer <-> 3: Sharper <Not recommended to use this> 100: Use " image_c<0~(n-1)>_sharpnesspercent" * Only available when bit 3 of "capability_image_c<0~(n-1)>_basicsetting"...
Page 207
VIVOTEK is 1 gammacurve 0~100 0: Fine-turned gamma curve by Vivotek. <product dependent> 1: Gamma value = 0.01 2: Gamma value = 0.02 3: Gamma value = 0.03 100: Gamma value = 1 * Note: Although we set gamma value to 100 level, but not all gamma values are valid.
Page 208
VIVOTEK 1:enable * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mode". eis_strength 1~100 Strength of electronic image stabilizer <product dependent> * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mode". dis_mode <boolean> Digital image stabilizer <product dependent> 0:disable 1:enable * Only available when 'dis' is listed in "capability_image_c<0~(n-1)>_is_mode".
Page 209
VIVOTEK deinterlace_mode spatial,blend Users can choose between two different deinterlacing techniques: Spatical mode provides the best image quality, while Blend mode provides better image quality (than not using the deinterlace function at all). * Only available when "capability_image_c<0~(n-1)>_deinterlace_s upport" is 1. xoffset 0~100 Adjusting the image to proper position...
Page 210
VIVOTEK * We replace "profile_i0_brightness" with "profile_i0_brightnesspercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. profile_i<0~(m-1)>_contrast -5~5,100 -5: Less contrast <-> 5: More contrast <Not recommended to use this> 100: Use " image_c<0~(n-1)>_contrastpercent"...
Page 211
VIVOTEK * 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. profile_i<0~(m-1)>_brightness 0~100 Set brightness in the normalized range. percent 0: Darker <-> 100: Bright * Only available when bit 0 of "capability_image_c<0~(n-1)>_basicsetting"...
Page 212
VIVOTEK gamma value = 0.45, etc. * Only available when "capability_image_c<0~(n-1)>_gammacurve " is 1 profile_i<0~(m-1)>_lowlightm <boolean> Enable/disable low light mode. * Only available when <product dependent> "capability_image_c<0~(n-1)>_lowlightmode " is 1 profile_i<0~(m-1)>_dnr_mode <boolean> 3D noise reduction. <product dependent> 0:disable 1:enable * Only available when "capability_image_c<0~(n-1)>_dnr"...
Page 213
VIVOTEK * Only available when 'dis' is listed in <product dependent> "capability_image_c<0~(n-1)>_is_mode". profile_i<0~(m-1)>_scene_ena <boolean> Enable/disable scene mode 0: disable <product dependent> 1: enable * Only available when "capability_image_c<0~(n-1)>_scenemode_ support" is 1 profile_i<0~(m-1)>_scene_mo visibility, Value of scene mode noiseless, * Only available when <product dependent>...
Page 214
VIVOTEK 7.12 Exposure window setting per channel Group: exposurewin_c<0~(n-1)> for n channel profucts n denotes the value of "capability_nvideoin" (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1) NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, custom,blc,hlc "auto": Use full image view as the only exposure window. * Available values are listed in "custom": Use custom windows.
Page 215
VIVOTEK "capability_image_c<0~(n-1)>_exposure_wi ndomain". homepx <0~W,0~H> Left-top corner coordinate of the window. W: 0~ The current image width -1 * Only available when px is listed in H: 0~ The current image height -1 "capability_image_c<0~(n-1)>_exposure_wi ndomain". sizepx <0~Wx0~ H> Width and height of the window. W: 0~ The current image width -1 * Only available when px is listed in H: 0~ The current image height -1...
Page 216
VIVOTEK Group: exposurewin_c<0~(n-1)>_profile_i<0~(m-1)>_win_i<0~(k-1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the value of "capability_nvideoinprofile", k denotes the value of "capability_image_c<0~(n-1)>_exposure_winnum". (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...
Page 217
VIVOTEK ndomain". sizestd <0~9999x0~9999> Width and height of the window. * Only available when std is listed in "capability_image_c<0~(n-1)>_exposure_wi ndomain". 7.13 Audio input per channel Group: audioin_c<0~(n-1)> for n channel products (capability.naudioin>0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set)
Page 218
VIVOTEK volume_external 0~100 Volume when take external microphone as input source. 0: Minimum 100: Maximum * Only available when the channel supports external microphone (The related bit of "capability_audio_extmic" is equal to 1). mute 0, 1 0: Mute off 1: Mute on gain 0~100 Gain of input.
Page 219
VIVOTEK 48000, * Only available if AAC is supported. 64000, 96000, 128000 s0_gamr_bitrate 4750, AMR encoded bitrate in bps. 5150, 5900, * Only available if AMR is supported. 6700, 7400, 7950, 10200, 12200 s0_g711_mode pcmu, Set G.711 companding algorithm. pcma pcmu: µ-law algorithm pcma: A-law algorithm * Only available if G.711 is supported.
Page 220
VIVOTEK alarm_level 1~100 Audio detection alarm level profile_i0_enable <boolean> Enable/disable this profile setting profile_i0_policy night, The mode which the profile is applied to. schedule * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a. profile_i0_begintime hh:mm Begin time of schedule mode.
Page 221
VIVOTEK 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 windows. * The value "0" is reserved for compatibility and will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 222
VIVOTEK H: 0~ The current * Only available when px is listed in image height -1 "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. polygon 0 ~ 320,0 ~ 240, 0 Coordinate of polygon window position.
Page 223
VIVOTEK greater than 0400a. width 0 ~ 320 Width of motion detection window. <Not recommended to use * Only available when this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 224
VIVOTEK and will not be used after the version number (httpversion) is equal or greater than 0400a. Group: motion_c<0~(n-1)>_profile_i<0~(m-1)>_win_i<0~(k-1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the vaule of "capability_nmotionprofile", k denotes the value of "capability_nmotion". NAME VALUE SECURITY...
Page 225
VIVOTEK <Not recommended to use ~ 320,0 ~ 240, 0 ~ (4 points: x0,y0,x1,y1,x2,y2,x3,y3) this> 320,0 ~ 240, 0 ~ * Only available when 320,0 ~ 240 "capability_motion_wintype" = polygon. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or...
Page 226
VIVOTEK * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. height 0 ~ 240 Height of motion detection window. <Not recommended to use * Only available when ...
Page 227
VIVOTEK 7.17 Tampering detection settings Group: tampering_c<0~(n-1)> for n channel products (capability.tampering > 0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable tamper detection. threshold 0~100 Threshold of tamper detection. duration 10~600 If tampering value exceeds the "threshold"...
Page 228
VIVOTEK 7.18 DDNS Group: ddns (capability.protocol.ddns > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the dynamic DNS. provider CustomSafe100, Safe100 => safe100.net DyndnsDynamic, DyndnsDynamic => dyndns.org (dynamic) DyndnsCustom, DyndnsCustom => dyndns.org Safe100 CustomSafe100 => Custom server using safe100 method <provider>_hostname string[128] Your DDNS hostname.
Page 229
VIVOTEK 7.20 UPnP presentation Group: upnppresentation NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP presentation service. 7.21 UPnP port forwarding Group: upnpportforwarding NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP port forwarding service.
Page 230
VIVOTEK 0: disable 1: Show log of parameter setting set from external. 2. Show log of parameter setting set from external and internal. 7.23 SNMP Group: snmp (capability.protocol.snmp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) <boolean> SNMP v2 enabled. 0 for disable, 1 for enable <boolean>...
Page 231
VIVOTEK 7.24 Layout configuration Group: layout NAME VALUE SECURITY DESCRIPTION (get/set) logo_default <boolean> 0 => Custom logo 1 => Default logo logo_link string[128] Hyperlink of the logo http://www.vivotek. logo_powerbyvvtk_hidden <boolean> 0 => display the power by vivotek logo 1 => hide the power by vivotek logo custombutton_manualtrig <boolean>...
Page 232
VIVOTEK 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> Enable privacy mask. win_i<0~(m-1)>_enable <boolean> Enable privacy mask window.
Page 233
VIVOTEK 0 ~ W,0 ~ H "capability_image_c<0~(n-1)>_privacymask W: 0~ The current _wintype" = polygon. image width -1 H: 0~ The current * Only available when px is listed in image height -1 "capability_image_c<0~(n-1)>_privacymask _windomain". win_i<0~(m-1)>_polygo 0 ~ 9999,0 ~ 9999, Coordinate of polygon window position.
Page 234
VIVOTEK "capability_ptz_c<0~(n-1)> _maxzoom" win_i<0~(m-1)>_fliped <boolean> Flip side of window position. 0: Non-flip side 1: Flip side 7.27 Capability Group: capability NAME VALUE SECURITY DESCRIPTION (get/set) api_httpversion <string> The version of VIVOTEK WebAPI with 4 This number start integers plus 1 alphabet, There are composed with 0301a.
Page 235
VIVOTEK EX: 0302b_1 => Major version = 03, minor version = 02, revision = b, platform = 1 The 4 integer numbers are WebAPI version, we use short name: [httpversion] for it in this document. The 5th character is model-based version for API bug-fix and it's default to "a".
Page 236
VIVOTEK naudiosetting <positive integer> Number of audio settings per channel. <Not support anymore> * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * We replace "naudiosetting" with "naudioin". More details, please refer the parameter description of "volume_internal"...
Page 237
VIVOTEK (only available when RS-485 interface is supported or SD/PZ/PT/PD/video 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 238
VIVOTEK 0307a. eptz 0, <positive For "nvideoin" = 1, the definition is as integer> following: A 32-bits integer, each bit can be set separately as follows: Bit 0 => 1st stream supports ePTZ or not. Bit 1 => 2nd stream supports ePTZ or not, and so on.
Page 239
VIVOTEK tampering <boolean> Indicate whether to support tampering detection. tamperingmode tamper,toodark,toob Available tampering mode list. right,tooblurry * Only available when "capability_tampering" is 1. adaptiverecording <boolean> Indicate whether to support adaptive recording. adaptivestreaming <boolean> Indicate whether to support adaptive streaming. supporttriggertypes seq,boot,motion,net list all the trigger types which are supported in workfail,recnotify,ta...
Page 240
VIVOTEK alable protocol_rtp_multicast_ba <boolean> Indicate whether to support backchannel ckchannel multicast. protocol_rtp_tcp <boolean> Indicate whether to support RTP over TCP. protocol_rtp_http <boolean> Indicate whether to support RTP over HTTP. protocol_spush_mjpeg <boolean> Indicate whether to support server push MJPEG. protocol_snmp <boolean> Indicate whether to support SNMP.
Page 241
VIVOTEK * This is kept for compatibility. videoin_codec mjpeg, h264, h265 Available codec of a device, split by comma. <product The sequence is not limited. dependent> FD8183 supports H.264 and MJPEG, then this is "mjpeg,h264". IP9171 supports H.264, MJPEG and H.265, then this is "mjpeg,h264,h265"...
Page 242
VIVOTEK <product affected functions are list here. dependent> The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it.
Page 243
VIVOTEK <Not support anymore> microphone input. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * We replace "audio_mic" with "audio_intmic". audio_intmic <0~Positive Internal (Built-in) Microphone. Integer> 0: Not support 1: Support Bit 0 for CH0, bit 1 for CH1, and so on.
Page 244
VIVOTEK audioin_codec aac4, gamr, g711, Available audio codec. We take comma to split g726, - codec without any space. <product dependent> aac4: Advanced Audio Coding (AAC) gamr: Adaptive Multi-Rate (AMR) g711: G.711 g726: G.726 -: Not supported. audioout_codec g711, - Available codec list for SIP.
Page 245
VIVOTEK supported. * Only available when "capability_smartstream_support" is 1 smartstream_mode_hybri <boolean> Indicate whether hybrid(autotracking+ manual) smart stream is supported. * Only available when "capability_smartstream_support" is 1 smartstream_nwindow_a <positive integer> Maximum number of tracking window of utotracking autotracking. * Only available when "capability_smartstream_support"...
Page 246
VIVOTEK * It will be replaced by capability_camctrl_ptztunnel. camctrl_ptztunnel <boolean> Indicate whether to support ptztunnel. * We support this parameter when the version number (httpversion) is equal or greater than 0301b. This equals "capability_camctrl_c0_ptztunnel". * This is kept for compatibility. camctrl_privilege <boolean>...
Page 247
VIVOTEK wireless_beginchannel 1 ~ 14 Indicate the begin channel of wireless network wireless_endchannel 1 ~ 14 Indicate the end channel of wireless network wireless_encrypt_wep <boolean> Indicate whether to support wireless WEP. wireless_encrypt_wpa <boolean> Indicate whether to support wireless WPA. wireless_encrypt_wpa2 <boolean>...
Page 248
VIVOTEK media_videoclip_maxleng <positive integer> Maximum length (second) of a videoclip. media_videoclip_maxpree <positive integer> Maximum duration (second) after event vent occurred in a videoclip. image_iristype <string> Indicate iris type. <Not recommended to use "piris": P-Iris this> "dciris": DC-Iris "-": No Iris control support ...
Page 249
VIVOTEK localstorage_supportedge An 32-bit integer, which indicates the <positive integer> supportive application of edge storage. If the value of this parameter is larger than 0, it means that the camera supports edge recording function. bit 0 : It supports to record directly to an on-board SD-Card.
Page 250
VIVOTEK layout_redirection <string> Indicate which function will be redirected to the vadp package path. "-": Not supported. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. Group: capability_camctrl_c<0~(n-1)> n denotes the value of "capability_nvideoin" (capability_ptzenabled >...
Page 251
VIVOTEK 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. And the key difference between a varifocal and a zoom lens can be explained by thinking about a lens that has been focused on an object at any focal length.
Page 252
VIVOTEK minpan 0, <positive integer> 0/7 The lower limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" maxpan 0, <positive integer> 0/7 The upper limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" minpanangle <integer>...
Page 253
VIVOTEK minzoom 0, <positive integer> 0/7 The lower limit for zoom position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule" is "1" maxzoom 0, <positive integer> 0/7 The upper limit for zoom position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule" is "1" maxdzoom 0, <positive integer>...
Page 254
VIVOTEK lightsensor <boolean> Indicate whether to support light sensor. blackwhitemode <boolean> Indicate whether to support automatically switch to Black & White display during the night mode. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 255
VIVOTEK Group: capability_videoin_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) The lens type of this channel. lens_type fisheye, fixed, fisheye: Fisheye lens varifocal, changeable, fixed: Build‐in fixed‐focus lens. motor, - varifocal: Build‐in varifocal lens. <product dependent> changeable: changeable lens. Like box‐type camera, users can install any C‐Mount or CS‐Mount lens as they wish. motor: Lens with motor to support zoom, focus, etc. ‐: N/A * Only available when [httpversion] >= 0301a rotation <boolean>...
Page 256
VIVOTEK rotationaffect When rotation is enabled, some features may <product dependent> become malfunction or be forced to a given value. The affected functions are list here. The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select - (unchanged) : UI keeps the status as before and user can't change it.
Page 257
VIVOTEK rotationangle <string> The different angles which camera supports for rotation. * Only avaliable when " " capability_videoin_c<0~(n-1)>_rotation is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309b. orientation flip,mirror,rotation Indicates the camera supports flip, mirror or <product dependent>...
Page 258
VIVOTEK 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 259
VIVOTEK mjpeg_maxbitrate <positive integer>, - 0/7 Maximum bitrates of MJPEG. The unit is bps. "-" means MJPEG does not support bit rate control. * Only available when 'mjpeg' is listed in "capability_videoin_codec". h264_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer>...
Page 260
VIVOTEK h265_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer> and "-" H.265 on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution"...
Page 261
VIVOTEK mounttype ceiling, wall, floor,- Indicate the supported mount type. <product dependent> "-": not support * We support this parameter when the version number (httpversion) is equal or greater than 0309c. dintraperiod_support <boolean> 0: Non-support "Dynamic intra frame period" 1: Support "Dynamic intra frame period" "Dynamic intra frame period"...
Page 262
VIVOTEK smartq_support <boolean> Indicate whether to support Smart Q function. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. Group: capability_videoin_c<0~(n-1)>_localdewarp (capability_fisheyelocaldewarp_c<0~(capability_nvideoin)-1> > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set)
Page 263
VIVOTEK 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 => 1st stream supports ePTZ or not. Bit 1 =>...
Page 264
VIVOTEK effectivepixel <WxH> The visible area of full scene in this video mode. The unit is pixel in source. * If "effectivepixel"<"capability_videoin_c<0~(n-1) >_maxsize", then the visible area is located at the center of full scene. outputsize <WxH> The output size of source, equal to the captured size by device, in this video mode.
Page 265
VIVOTEK 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 266
VIVOTEK maxfps_h264 A list of <Positive Maximum fps which the device can encoded with Integer> and "-" H.264 on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution"...
Page 267
VIVOTEK to proper position vertically or not. wdrpro_mode 0, 1, 2 0: Non-support WDR Pro 1: Support WDR Pro 2: Support WDR Pro and WDR Pro II wdrpro_strength 0, 1 0: Non-support tuning strength of WDR Pro 1: Support tuning strength of WDR Pro * If...
Page 268
VIVOTEK - (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:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6"...
Page 269
VIVOTEK exposurelevel:ranged:<x>- - (disabled) : UI turns grey and users <x>, can't select it. exposuremode:fixed:auto - (unchanged) : UI keeps the status as before and user can't change it. <x>: nonnegative integer - (hidden) : UI is hidden. <product dependent> ...
Page 270
VIVOTEK > 0. * We support this parameter when the version number (httpversion) is equal or greater than 0306d. dnrtype 2d,3d Description about DNR type. * Only available when "capability_image_c<0~(n-1)>_dnr" > 0. * We support this parameter when the version number (httpversion) is equal or greater than 0308a.
Page 271
VIVOTEK "capability_image_c<0~(n-1)>_is_m ode" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. is_affect When Is mode is not "-", some minexposure:hidden:, features may become malfunction or mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here.
Page 272
VIVOTEK integer or string or NULL. "-" means no feature is affected. * Only available when "capability_image_c<0~(n-1)>_is_m ode" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. scenemode_support 0: Non-support scene mode 1: Support scene mode scenemode_supporttype visibility,...
Page 273
VIVOTEK "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL.
Page 274
VIVOTEK - (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" which means exposurelevel is fixed to level 6.
Page 275
VIVOTEK 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:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6"...
Page 276
VIVOTEK value. - (ranged) : UI is fixed to multiple 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:" which means blc exposure window is disabled.
Page 277
VIVOTEK lens. sensortype rawsensor, Indicate sensor type. smartsensor, "rawsensor": Raw sensor "smartsensor": Smart sensor "-": N/A * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_mode 0: Non-support exposure control. 1: Support exposure control.
Page 278
VIVOTEK * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1 and "capability_image_c<0~(n-1)>_expo sure_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_gainvaluetype fixed, * One to one mapping to the mode maximum, type in "exposure_modetype".
Page 279
VIVOTEK before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available.
Page 280
VIVOTEK <x>: nonnegative integer <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value.
Page 281
VIVOTEK e_affect exposurewin.mode.blc:hidd enabled, some features may become en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here. exposurelevel:hidden:, or others The format is "Affect API name":"Policy":"Description" <x>: nonnegative integer <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it.
Page 282
VIVOTEK exposure_modetype" and "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. exposure_qualitypriority When exposure quality priority mode mode_affect exposurewin.mode.blc:hidd is enabled, some features may become en:, malfunction or be forced to a given defog:disabled:, value.
Page 283
VIVOTEK "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when qualitypriority is listed in "capability_image_c<0~(n-1)>_ exposure_modetype" and "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0305a.
Page 284
VIVOTEK "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" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when manual is listed in "capability_image_c<0~(n-1)>_ exposure_modetype"...
Page 285
VIVOTEK * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1 and hlc is listed in "capability_image_c<0~(n-1)>_ exposure_winmode". exposure_hlcmode_affect When hlc mode is enabled, some or others features may become malfunction or be forced to a given value. The <x>: nonnegative integer affected functions are list here.
Page 286
VIVOTEK "-" means no feature is affected. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1 and hlc is listed in "capability_image_c<0~(n-1)>_ exposure_winmode". * We support this parameter when the version number (httpversion) is equal or greater than 0304a. exposure_wintype inclusive, ...
Page 287
VIVOTEK "capability_image_c<0~(n-1)>_ exposure_mode" is 1. A list of <Positive Integer> exposure_ntsc_totalrange Available total range for NTSC analog output. * 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 0301a. A list of <Positive Integer> exposure_pal_totalrange Available total range for PAL analog output. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode"...
Page 288
VIVOTEK * When "exposure_mode"=0, this value must be set to "-". * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. privacymask_wintype rectangle, The supported mask window type. polygon, "polygon": The window is a 2D 3Drectangle polygon shape. "rectangle": The window is a 2D rectangle shape.
Page 289
VIVOTEK "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value.
Page 290
VIVOTEK _mode"=1, this may be either 0 or 1. defog_supportlevel 0, <positive integer> The value indicate the support strength level of defog. defog_affect When defog is enabled, some features wdrpro:unchanged:, may become malfunction or be forced or others to a given value. The affected functions are list here.
Page 291
VIVOTEK * When "defog" = 0, this value must be "-" aespeed 0: Non-support AE speed 1: Support AE speed aespeedsupportlevel <positive integer> The value indicate the support strength level of aespeed. * Only available when "capability_image_c<0~(n-1)>_aesp eed" is 1. aespeedsupportsensitivity 0: Non-support tuning the sensitivity of AE converge speed.
Page 292
VIVOTEK focuswindomain qvga, px, std, - The domain to set a focus window. "qvga": a 320x240 range to represent the whole image. "px": Locate a window in the image with pixels. "std": A normalized 0~9999 range. "-": Not supported. focuswindow_nwindow 0,<positive integer>...
Page 293
VIVOTEK better image quality (than not using the deinterlace function at all). * Only available when capability_image_c<0~(n-1)>_deinte rlace_support is 1 lens_alignment <boolean> Indicate whether to support lens alignment function. * We support this parameter when the version number (httpversion) is equal or greater than 0309b.
Page 294
VIVOTEK 7.29 Event setting Group: event_i<0~2> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. enable 0, 1 Enable or disable this event. priority 0, 1, 2 Indicate the priority of this event: “0”= low priority “1”= normal priority “2”= high priority delay 1~999...
Page 295
VIVOTEK mdwin 0,<positive integer> Indicate the source window id of motion detection. This field is required when trigger condition is “md”. One bit represents one window. The LSB indicates the 1 window. For example, to detect the 1 and 3 windows, set mdwin as 5.
Page 296
VIVOTEK weekday 0~127 Indicate which weekday is scheduled. One bit represents one weekday. bit0 (LSB) = Saturday bit1 = Friday bit2 = Thursday bit3 = Wednesday bit4 = Tuesday bit5 = Monday bit6 = Sunday For example, to detect events on Friday and Sunday, set weekday as 66.
Page 297
VIVOTEK action_server_i<0~4>_ena <boolean> Enable or disable this server action. action_server_i<0~4>_me NULL, 0~4,101 Index of the attached media. 101 means "Recording Notify" action_server_i<0~4>_dat <boolean> Enable this to create folders by date, time, and efolder hour automatically. action_goto_enable <boolean> Enable/disable ptz goto preset position on event <product dependent>...
Page 298
VIVOTEK 7.30 Server setting for event action Group: server_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry type email, Indicate the server type: ftp, “email” = email server http, “ftp” = FTP server “http” = HTTP server “ns”...
Page 299
VIVOTEK 7.31 Media setting for event action Group: media_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry type snapshot, Media type to send to the server or systemlog, store on the server. videoclip, recordmsg snapshot_source 0~"capability_nmediastream"-1 Indicate the source of media stream. 0 means the first stream.
Page 300
VIVOTEK videoclip_maxduration 1 ~ " Maximum duration of one video clip in capability_media_videoclip_maxlen seconds. gth" videoclip_maxsize 50 ~ " Maximum size of one video clip file in capability_media_videoclip_maxsiz Kbytes. e" 7.32 Recording Group: recording_i<0~1> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry.
Page 302
VIVOTEK dest The destination to store the recorded data. “cf” means local storage (CF or SD card). “0” means the index of the network storage. cffolder string[128] Folder name. maxsize 100~2000 Unit: Mega bytes. When this condition is reached, recording file is truncated.
Page 303
VIVOTEK 7.33 HTTPS Group: https (capability.protocol.https > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> To enable or disable secure HTTP. policy <Boolean> If the value is 1, it will force HTTP connection redirect to HTTPS connection method auto, auto =>Create self-signed certificate manual, automatically.
Page 304
VIVOTEK 7.34 Storage management setting Group: disk_i<0~(n-1)> n is the total number of storage devices. (capability.storage.dbenabled > 0) Currently it’s only for local storage (SD, CF card), so n is equal to 1. PARAMETER VALUE SECURITY DESCRIPTION (get/set) cyclic_enabled <boolean> Enable cyclic storage method.
Page 305
VIVOTEK maxretentiontime_recordin <string> To specify the expired time for automatic clean g_i<0~1>_maxage up, and it only takes effect for video clip generated by recording_i <0~1>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss]S’ , similar with ISO8601 with symbols P Ex. P7D, it means 7 days. P1DT10H, it means 1 days and 10 hours.
Page 306
VIVOTEK 7.35 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 or capability_fisheye = 1) PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-1)>_home <W,H> ROI left-top corner coordinate.* If the minimal <product dependent>...
Page 307
VIVOTEK 7.36 ePTZ setting Group: eptz_c<0~(n-1)> for n channel product. (capability.eptz > 0 or capability_fisheye = 1) PARAMETER VALUE SECURITY DESCRIPTION (get/set) osdzoom <boolean> Indicates multiple of zoom in is “on-screen <Not recommended to use display” or not. this> * Reserved for compatibility, and suggest don't use this since [httpversion] >...
Page 308
VIVOTEK Group: eptz_c<0~(n-1)>_s<0~(m-1)> for n channel product and m is the index of video stream which support ePTZ. (capability.eptz > 0 or capability_fisheye = 1) PARAMETER VALUE SECURITY DESCRIPTION (get/set) patrolseq string[120] The patrol sequence of ePTZ. All the patrol position indexes will be separated by ","...
Page 309
VIVOTEK 7.37 Focus Window setting Group: focuswindow_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin". (capability_image_c<0~(n-1)>_focuswindow_nwindow > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) win_i0_enable <boolean> Enable or disable the window. win_i0_home <W,H> Left-top corner coordinate of the window. <product dependent>...
Page 310
VIVOTEK 7.39 VIVOTEK Application Development Platformsetting Group: vadp NAME VALUE SECURITY DESCRIPTION (get/set) version <string> Indicate the VADP version. resource_total_memory 0,<positive integer> Indicate total available memory size for VADP modules. resource_total_storage 0,<positive integer> Indicate total size of the internal storage space for storing VADP modules.
Page 311
VIVOTEK vendorurl string[120] URL of the vendor. version string[40] Version of the module. license string[40] Indicate the license status of the module. licmsg string[128] Indicate the message that will be show on license status when mouse over. path string[40] Record the storage path of the module. initscr string[40] The script that will handle operation...
Page 312
VIVOTEK 7.40 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 313
VIVOTEK 7.41 camera PTZ control (IZ series) Group: camctrl_c<0~(n-1)> for n channel products (capability_camctrl_c0_zoommodule = 1 and capability_camctrl_c0_buildinpt = 0) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset" NAME VALUE SECURITY DESCRIPTION (get/set) ccdtype string[16] (Internal used, read only) motortype string[16]...
Page 314
VIVOTEK * Only available when bit7 of capability_ptzenabled is 1 preset_i<0~(k-1)>_name string[40] Name of the preset location. preset_i<0~(k-1)>_zoom capability_ptz_c<0~(n-1) Zoom position at each preset location. >_minzoom ~ capability_ptz_c<0~(n-1) >_maxzoom preset_i<0~(k-1)>_focus capability_ptz_c<0~(n-1) Focus position at each preset location. >_minfocus ~ capability_ptz_c<0~(n-1) >_maxfocus preset_i<0~(k-1)>_ 0 ~ 999...
Page 315
VIVOTEK returnhomeinterval 1~999 While idle over this time interval, idle action will be taken. idleaction_enable <boolean> Enable/disable idle action while idle idleaction_type home This field tells what kind of action should be taken while idle. idleaction_interval 1~999 While idle over this time interval, idle action will be taken.
Page 316
VIVOTEK preset_i<0~(k-1)>_name string[40] Name of the preset location. preset_i<0~(k-1)>_pan capability_ptz_c<0~(n-1) Pan position at each preset location. >_minpan ~ capability_ptz_c<0~(n-1) >_maxpan preset_i<0~(k-1)>_tilt capability_ptz_c<0~(n-1) Tilt position at each preset location. >_mintilt ~ capability_ptz_c<0~(n-1) >_maxtilt preset_i<0~(k-1)>_zoom capability_ptz_c<0~(n-1) Zoom position at each preset location. >_minzoom ~ capability_ptz_c<0~(n-1) >_maxzoom...
Page 317
VIVOTEK axisz capability_ptz_c<0~(n-1) Custom home zoom position. >_minzoom ~ capability_ptz_c<0~(n-1) >_maxzoom axisf capability_ptz_c<0~(n-1) Custom home focus position. >_minfocus ~ capability_ptz_c<0~(n-1) >_maxfocus axisflip <boolean> Custom home flip side. returnhome <boolean> Enable/disable return home while idle. returnhomeinterval 1~999 While idle over this time interval, idle action will be taken.
Page 318
VIVOTEK greater than 0307a. tour_i<0~19>_checklist string[512] The indexes of preset positions, separated by “,” tour_i<0~19>_dwelltime string[512] Preset tour: time to wait before moving to the next preset position, separated by “,” Recorded tour: number of seconds to wait before continuing a loop tour. 7.43 UART control Group: uart (capability.nuart >...
Page 319
VIVOTEK and the uart_i<0~(n-1)>_databit set as 5 as well. uartmode rs485, RS485 or RS232. rs232 customdrvcmd_i<0~9> string[128] PTZ command for custom camera. speedlink_i<0~4>_name string[40] Additional PTZ command name. speedlink_i<0~4>_cmd string[40] Additional PTZ command list. ptzdriver 0~19, The PTZ driver is used by this COM port. 127 (custom), 128 (no driver) 7.44 UART control (SD series)
Page 320
VIVOTEK the end of a byte. If you want to transfer the stopbit for 150% of the normal time used to transfer one bit, the uart_i<0~(n-1)>_stopbit should be set as 2 and the uart_i<0~(n-1)>_databit set as 5 as well. uartmode rs485 RS485 mode.
Page 321
VIVOTEK name <string> User-defined lens name 7.46 Fisheye info Group: fisheyeinfo (capability.fisheye > 0) NAME VALUE SECURITY DESCRIPTION (get/set) revisedcenteraxis <coordinate> The actual center axis coordinate radius 0, <positive The actual center radius integer> 7.47 Fisheye local dewarp setting Group: fisheyedewarp_c<0~(n-1)>...
Page 322
VIVOTEK 7.48 PIR behavior define Group: pir (capability.npir > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable PIR 7.49 Auto tracking setting Group: autotrack_c<0~(n-1)> (capability_image_c<0~(n-1)>_autotrack_support > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) objsize_type -1~2 Type of object size.
Page 323
VIVOTEK 7.50 Wireless Group: wireless (capability_network_wireless > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) ssid string[32] SSID for wireless lan settings. wlmode Infra, Wireless mode. Adhoc Infra: Infrastructure channel 1~11 A list of WLAN channels. 1~13 Countries apply their own regulations to the 10~11 or allowable channels.
Page 324
VIVOTEK key4 password [26] WEP key4 for encryption. * Only valid when "wireless_encrypt" is "wep" algorithm AES, TKIP Algorithm * Only valid when "wireless_encrypt" is "wpa" or "wpa2" presharedkey password [64] WPA/WPA2PSK mode pre-shared key. * Only valid when "wireless_encrypt" is "wpa" or "wpa2"...
Page 325
VIVOTEK 8. Useful Functions Drive the Digital Output (capability.ndo > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/setdo.cgi?do1=<state>[&do2=<state>] [&do3=<state>][&do4=<state>] Where state is 0 or 1; “0” means inactive or normal state, while “1” means active or triggered state. PARAMETER VALUE DESCRIPTION...
Page 326
VIVOTEK Query Status of the Digital Input(capability.ndi > 0) Note: This request requires Viewer privileges Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/getdi.cgi?[di0][&di1][&di2][&di3] If no parameter is specified, all of the digital input statuses will be returned. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <length>\r\n \r\n [di0=<state>]\r\n [di1=<state>]\r\n...
Page 327
VIVOTEK Query Status of the Digital Output (capability.ndo > 0) Note: This request requires Viewer privileges Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/getdo.cgi?[do0][&do1][&do2][&do3] If no parameter is specified, all the digital output statuses will be returned. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <length>\r\n \r\n [do0=<state>]\r\n [do1=<state>]\r\n...
Page 328
VIVOTEK Capture Single Snapshot Note: This request requires Normal User privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/video.jpg?[channel=<value>][&resolution=<value>] [&quality=<value>][&streamid=<value>] If the user requests a size larger than all stream settings on the server, this request will fail. PARAMETER VALUE DESCRIPTION channel 0~(capability_nvideoin -1) The channel number of the video source.
Page 329
VIVOTEK Account Management Note: This request requires Administrator privileges. Method: POST Syntax: http://<servername>/cgi-bin/admin/editaccount.cgi? method=<value>&username=<name>[&userpass=<value>][&privilege=<value>] [&privilege=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION method Add an account to the server. When using this method, the“username” field is necessary. It will use the default value of other fields if not specified.
Page 330
VIVOTEK System Logs Note: This request require Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/syslog.cgi Server will return the most up-to-date system log. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <syslog length>\r\n \r\n <system log information>\r\n Upgrade Firmware Note: This request requires Administrator privileges. Method: POST Syntax: http://<servername>/cgi-bin/admin/upgrade.cgi...
Page 331
VIVOTEK ePTZ Camera Control (capability.eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eCamCtrl.cgi?channel=<value>&stream=<value> [&move=<value>] – Move home, up, down, left, right [&auto=<value>] – Auto pan, patrol [&zoom=<value>] –Zoom in, out [&zooming=<value>&zs=<value>] –Zoom without stopping, used for joystick [&x=<value>&y=<value>&w=<value>&h=<value>&resolution=<value>] - Zoom in, out on a specific area [&vx=<value>&vy=<value>&vs=<value>] –...
Page 332
VIVOTEK http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed. To stop a continuous movement, you have to use the command as below: http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zoom=stop&zs=0 2. [Area zoom]: it means to zoom in on a specific area, here is an example for a directly moving [x, y] is the desired coordinate, and it will be the center after movement [w, h] is the scaled area size [resolution] is the base range of this coordinate system...
Page 333
VIVOTEK <integer> The direction of movement, used for joystick control. <integer> 0 ~ 7 Set the speed of movement, “0” means stop. <integer> x-coordinate clicked by user. It will be the x-coordinate of center after movement. <integer> y-coordinate clicked by user. It will be the y-coordinate of center after movement.
Page 334
VIVOTEK ePTZ Recall (capability.eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eRecall.cgi?channel=<value>&stream=<value>& recall=<value>[&return=<return page>] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source. stream <0~(m-1)> Stream. recall Text string less than 40 One of the present positions to recall.
Page 335
VIVOTEK 8.10 ePTZ Preset Locations(capability.eptz > 0 and capability_fisheye = 0) Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/ePreset.cgi?channel=<value>&stream=<value> [&addpos=<value>][&delpos=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source. stream <0~(m-1)> Stream. addpos <Text string less than Add one preset location to the preset list.
Page 336
VIVOTEK delv6 Delete IPv6 address from access list. <IP address> Single address: <IP address> Network address: <IP address / network mask> Range address:<start IP address - end IP address> index <value> The start position to add or to delete. return <return page>...
Page 337
VIVOTEK 8.12 UART HTTP Tunnel Channel (capability.nuart > 0) Note: This request requires Operator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/operator/uartchannel.cgi?[channel=<value>] ------------------------------------------------------------------------- GET /cgi-bin/operator/uartchannel.cgi?[channel=<value>] x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------- POST /cgi-bin/operator/uartchannel.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache cache-control : no-cache content-length: 32767 expires: Sun, 9 Jam 1972 00:00:00 GMT...
Page 338
VIVOTEK 8.13 Event/Control HTTP Tunnel Channel (capability. evctrlchannel > 0) Note: This request requires Administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/ctrlevent.cgi ------------------------------------------------------------------------- GET /cgi-bin/admin/ctrlevent.cgi x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------- POST /cgi-bin/admin/ ctrlevent.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache cache-control : no-cache content-length: 32767...
Page 339
VIVOTEK 8.14 Get SDP of Streams Note: This request requires Viewer access privileges. Method: GET/POST Syntax: http://<servername>/<network_rtsp_s<0~m-1>_accessname> “m” is the stream number. “network_accessname_<0~(m-1)>” is the accessname for stream “1” to stream “m”. Please refer to the “subgroup of network: rtsp” for setting the accessname of SDP. You can get the SDP by HTTP GET.
Page 340
VIVOTEK 8.16 Senddata (capability.nuart > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/senddata.cgi? [com=<value>][&data=<value>][&flush=<value>] [&wait=<value>] [&read=<value>] PARAMETER VALUE DESCRIPTION 1 ~ <max. com port The target COM/RS485 port number. number> data <hex decimal The <hex decimal data> is a series of digits from 0 ~ 9, A ~ F. Each data>[,<hex decimal comma separates the commands by 200 milliseconds.
Page 341
VIVOTEK 8.17 Storage managements (capability.storage.dbenabled > 0) Note: This request requires administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=<cmd_type>[&<parameter>=<value>…] The commands usage and their input arguments are as follows. PARAMETER VALUE DESCRIPTION cmd_type <string> Required. Command to be executed, including search, insert, delete, update, and queryStatus.
Page 342
VIVOTEK Indicate if the file is locked or not. 0: file is not locked. 1: file is locked. A locked file would not be removed from UI or cyclic storage. triggerTime <text> Optional. Indicate the event trigger time. (not the file created time) Format is “YYYY-MM-DD HH:MM:SS”...
Page 343
VIVOTEK label <integer primary key> Required. Identify the designated record. Ex. label=1 isLocked <boolean> Required. Indicate if the file is locked or not. Ex. Update records whose key numbers are 1 and 5 to be locked status. http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=update&isLocked=1&label=1&label=5 Ex. Update records whose key numbers are 2 and 3 to be unlocked status. http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=update&isLocked=0&label=2&label=3 Command: queryStatus PARAMETER...
Page 344
VIVOTEK 8.18 Virtual input (capability.nvi > 0) Note: Change virtual input (manual trigger) status. Method: GET Syntax: http://<servername>/cgi-bin/admin/setvi.cgi?vi0=<value>[&vi1=<value>][&vi2=<value>] [&return=<return page>] PARAMETER VALUE DESCRIPTION vi<num> state[(duration)nstate] Ex: vi0=1 Setting virtual input 0 to trigger state Where "state" is 0, 1. “0” means inactive or normal Ex: vi0=0(200)1 state while “1”...
Page 345
VIVOTEK Request 2 will not be accepted during the execution time(15 seconds). 8.19 Open Timeshift Stream (capability.timeshift > 0, timeshift_enable=1, timeshift_c<n>_s<m>_allow=1) Note: This request requires Viewer access privileges. Syntax: For HTTP push server (MJPEG): http://<servername>/<network_http_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&reftime=<v alue>&forcechk&minsft=<value>] For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player. rtsp://<servername>/<network_rtsp_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&reftime=<va lue>&forcechk&minsft=<value>] “n”...
Page 346
VIVOTEK Return Code Description 400 Bad Request Request is rejected because some parameter values are illegal. 415 Unsupported Media Type Returned, if forcechk appears,when minsft is not achievable or the timeshift feature of the target stream is not enabled. 346 - User's Manual...
Page 348
VIVOTEK function zoom, Function type focus, zoom - Move focus motor auto, focus – Move focus motor scan, auto – Perform auto focus scan – Perform focus scan stop, positioning, stop – Stop current operation getstatus positioning – Position the motors getstatus–Information of motors, return value as below: remote_focus_zoom_motor_max: Maximum steps of zoom motor remote_focus_focus_motor_max: Maximum steps of focus motor...
Page 349
VIVOTEK steps 1 ~ <motor_max> Motor’s moving steps. It works only if function=zoom | focus and direction=forward | backward. <motor_max> is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from "function=getstatus" * This parameter is for additional fine-tune, the value is from 1 to 30. iris Open iris or not.
Page 350
VIVOTEK 8.21 BackFocus (capability_image_c<0~(n-1)>_remotefocus=4) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/remotefocus.cgi?function=<value>[&direction=<value>] [&position=<value>][&steps=<value>][&iris] PARAMETER VALUE DESCRIPTION function focus, Function type auto, focus – Move focus motor auto – Perform auto focus scan, stop, scan – Perform focus scan positioning, stop –...
Page 351
VIVOTEK direction direct, Motor’s moving direction. forward, It works only if function= focus. backward position 0~<motor_max> Motor’s position. It works only if function=focus and direction=direct. <motor_max> is refer to remote_focus_focus_motor_max which replied from "function=getstatus" steps 1 ~ <motor_max> Motor’s moving steps. ...
Page 352
VIVOTEK 8.22 Export Files Note: This request requires Administrator privileges. Method: GET Syntax: For daylight saving time configuration file: http://<servername>/cgi-bin/admin/exportDst.cgi For language file: http://<servername>/cgi-bin/admin/export_language.cgi?currentlanguage=<value> PARAMETER VALUE DESCRIPTION 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 352 - User's Manual...
Page 353
VIVOTEK 8.23 Upload Files Note: This request requires Administrator privileges. Method: POST Syntax: For daylight saving time configuration file: http://<servername>/cgi-bin/admin/upload_dst.cgi Post data: filename =<file name>\r\n \r\n <multipart encoded form data> For language file: http://<servername>/cgi-bin/admin/upload_lan.cgi Post data: filename =<file name>\r\n \r\n <multipart encoded form data>...
Page 354
VIVOTEK 8.24 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 For choose selected lens configuration: http://<servername>/cgi-bin/admin/update_lens.cgi?choose_lens=<value>...
Page 355
VIVOTEK 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.25 Media on demand (capability.localstorage.modnum > 0) Media on demand allows users to select and receive/watch/listen to metadata/video/audio contents on demand. Note: This request requires Viewer access privileges.
Page 356
VIVOTEK 8.26 Fisheye local dewarp camera control (capability.fisheye > 0 and capability.fisheyelocaldewarp.c0 > 0, only support in 1R mode) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/fdCamCtrl.cgi?channel=<value>&stream=<value> [&move=<value>] – Move home, up, down, left, right [&zoom=<value>] – Zoom wide, tele [[&speedpan=<value>][&speedtilt=<value>][&speedzoom=<value>]] –...
Page 357
VIVOTEK zoom wide Zoom larger view with current speed. tele Zoom further with current speed. speedpan -5 ~ 5 Set the pan speed of current command. speedtilt -5 ~ 5 Set the tilt speed of current command. speedzoom -5 ~ 5 Set the zoom speed of current command.
Page 358
VIVOTEK 8.27 3D Privacy Mask (capability_image_c<0~(n-1)>_privacymask_wintype = 3Drectangle) n denotes the value of "capability_nvideoin" Note: This request requires admin user privilege Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/setpm3d.cgi?method=<value>&maskname=<value>&[maskheight=<valu e>&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 Edit a 3D privacy mask...
Page 359
VIVOTEK 8.28 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>] – Zoom without stopping, used for joystick [&vx=<value>&vy=<value>&vs=<value>] –...
Page 360
VIVOTEK speedpan -5 ~ 5 Set the pan speed. speedtilt -5 ~ 5 Set the tilt speed. speedzoom -5 ~ 5 Set the zoom speed. speedfocus -5 ~ 5 Set the focus speed. speedapp -5 ~ 5 Set the auto pan/patrol speed. auto Auto pan.
Page 361
VIVOTEK * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20. getsetpreset Adds a named preset at current position, and return the preset index. * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20.
Page 362
VIVOTEK gettiltangle <integer> Get the current tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getzoom 0, <positive integer> Get the current zoom position. getratio <decimal> Get the current zoom ratio. getfocus 0, <positive integer> Get the current focus position. getminspeedlv 0, <positive integer>...
Page 363
VIVOTEK getmaxratio <decimal> Get the maximum ratio of optical zoom. * We support this parameter when the version number (getversion) is equal or greater than 5.0.0.14 getmaxdratio <decimal> Get the maximum ratio of digital zoom. * We support this parameter when the version number (getversion) is equal or greater than 5.0.0.14 getminfocus 0, <positive integer>...
Page 364
VIVOTEK 8.30 Preset Locations (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/preset.cgi?[channel=<value>] [&addpos=<value>][&delpos=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION addpos string[30] Add one preset location to the preset list. channel 0~"capability_nvideoin"-1 Channel of the video source. delpos string[30] Delete preset location from preset list.
Page 365
VIVOTEK 8.31 SmartSD (capability_localstorage_smartsd > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/smartsd.cgi?function=<value> PARAMETER VALUE DESCRIPTION function getstatus Function type getstauts : Information of smartSD internal status return value as below: smartsd_lifetime_num: Accumulated amount of data that has been written smartsd_lifetime_den: Card-guaranteed amount of data that can be written smartsd_lifetime_rate:...
Page 366
VIVOTEK 8.32 Connect to AP (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION Apply the wireless settings and connect to AP. 8.33 Get wireless information (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/getwirelessinfo.cgi...
Page 367
VIVOTEK 8.34 Get wireless signal strength (capability_network_wireless > Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/getwlsignalstrength.cgi PARAMETER VALUE DESCRIPTION Get wireless signal strength. 8.35 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...
Page 368
VIVOTEK 8.36 Peripheral control (capability_peripheral_c<0~(n-1)>_ devicecontrol > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/admin/peripheral.cgi?channel=<value>&operation=set [&washer_mode=<value>] – Set washer mode [&washer_status=<value>] – Set washer status [&washer_dwelltime=<value>] – Set washer clean time [&heater_status=<value>] – Set heater status Example: http://myserver/cgi-bin/admin/peripheral.cgi?channel=0&operation=set&washer_mode=wiper&...
Page 369
VIVOTEK *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 Disable the functionality of washer control system. *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 washer_dwelltime 15~999 Apply washer washer control system operation time (including the time when spraying and wiper actions take place). *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 heater_status...
Page 370
VIVOTEK \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 Get the support mode of washer control system, its value is the same with "capability_peripheral_ c<0~(n-1)>_washer_mode". *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 washer_mode Get the current mode of washer control system.
Page 371
VIVOTEK transfer to ‘auto’ after reach the internal condition. *Only available when capability_peripheral_c<0~(n-1)>_heater_suppo rt=1 8.37 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 zone one...
Page 372
VIVOTEK 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, ...
Page 373
VIVOTEK Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=settoall&irmode=manual&strength=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, 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 ...
Page 374
VIVOTEK PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. support_irmode List all adjustment mode that IR supports irmode Get the current IR control mode. irnum Get the number of IR that camera supports. Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=get&irmode Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n...
Technical Specifications VIVOTEK Technical Specifications Model MS9390-HV Interface Built-in Microphone System Information Effective Range 5 meters Network Multimedia SoC (System-on-Chip) Flash 128MB Users Live viewing for up to 10 clients IPv4, IPv6, TCP/IP, HTTP, HTTPS, UPnP, RTSP/ RTP/RTCP, IGMP, SMTP, FTP, DHCP, NTP, DNS, Protocols DDNS, PPPoE, CoS, QoS, SNMP, 802.1X, ARP, Camera Features...
Page 376
VIVOTEK Technical Specifications Included Packaging Quick installation guide, warranty card, Others alignment sticker, desiccant bag, screw driver, screws pack, sunshield Dimensions • w/o sunshield • w/ sunshield 165 mm 97 mm 165 mm 100 mm Compatible Accessories Mounting Kits AM-312 Pole Mount All specifications are subject to change without 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.
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.
Need help?
Do you have a question about the Vivotek Supreme MS9390-EHV-v2 and is the answer not in the manual?
Questions and answers