Page 1 SD9361-EHL SD9362-EH/EHL Speed Dome SD9362-EH-v2 Network Camera User ’s Manual 2MP • 20x/30x Zoom • 60fps • NEMA 4x • IP68 • Extreme Weatherproof Rev. 1.1...
Page 2: Table Of Contents
Security > Access List ........................106 PTZ > PTZ settings ..........................112 Event > Event settings ........................119 Applications > Motion detection......................134 Applications > DI and DO ........................137 Applications > Audio detection ......................138 Applications > VADP (VIVOTEK Application Development Platform) ..........140 2 - User's Manual...
Page 3 VIVOTEK Recording > Recording settings ........................143 Local storage > SD card management ....................... 148 Local storage > Content management ....................... 149 Appendix 152 URL Commands for the Network Camera ......................152 Technical Specifications ............................. 455 Technology License Notice ..........................458 Electromagnetic Compatibility (EMC) .........................
Page 4: Revision History
Armed with a 20x or 30x optical zoom lens, the camera is able to capture fine details at top-notch quality. By combining both H.265 and VIVOTEK’s Smart Stream II technology, it is capable of reducing both bandwidth and storage consumption by up to 80%* while maintaining the highest standard of image quality.
Page 5: Read Before Use
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.
Page 6 3. If powered by a power adapter, the adapter should be properly grounded. 4. Maintenance and repair work must always be carried out by qualified technical personnel. 5. Disconnect power from the unit when performing a maintenance task. 6. Please contact VIVOTEK's certified dealers for power adapters. NOTE: Camera Hardware Preventative Maintenance: 1.
Page 7: Physical Description
VIVOTEK Physical Description Outer View This drawing shows a camera with its dome cover removed. Lens Reset Button MicroSD card slot Status LED Inner View IR unit connector Safety wire hook LAN connector I/O combo connector Alignment marks User's Manual - 7...
Page 8 VIVOTEK NOTE: 1. This equipment is only to be connected to PoE networks without routing to outside plants. 2. For PoE input, use only UL listed I.T.E. with PoE output. Tips: 1. If you forget the root (administrator) password for the camera, you can restore the camera defaults by pressing the reset button for longer than 5 seconds.
Page 9 VIVOTEK Wet contact with external DC power source to supply a relay. Switch DC 0V External DC power External AC power with Protected Earth Relay External Device Dry contact and using camera’s DO+ to supply a relay. Switch External AC power...
Page 10: Hardware Installation
VIVOTEK Hardware Installation 1. Jot down the camera's MAC address for later reference. 2. The camera weighs 3kg. Select a rigid mounting location to prevent vibration to the camera. Attach the alignment sticker to the wall. 3. Drill 4 pilot holes (9.5mm in diameter and 4cm deep) into the wall, and then hammer in threaded anchors.
Page 11 VIVOTEK 5. Connect power or I/O wires, and use foam tapes or seal foam to ensure the back-end connection is waterproof. 6. Route your I/O combo and Ethernet cables along the routing guide poles to form drip loops. LAN I/O combo...
Page 12 VIVOTEK 7. Secure the bracket to wall. The cable length hanging on the outside of the bracket should be 15cm. 8. Remove the cable gland from the LAN port. If I/O wires or 24V power are preferred, use the T20 L-wrench to remove 15cm the top cover on the I/O connectors.
Page 13 VIVOTEK 9. Install the safety wire bracket and a self-supplied ground wire to one of its screws. Hook up the safety wire between the bracket and the camera. 10. Install the components of the waterproof cable gland to the Ethernet and I/O combo cables.
Page 14 VIVOTEK 11. Connect the I/O wire headers to camera and then secure the top cover. 12. Connect the Ethernet cable (along with its cable gland) to the camera. IMPORTANT: Make sure all waterproof cable glands have been properly installed. Water leakage will cause irrepairable damage to the camera.
Page 15 VIVOTEK 13. Install the camera to bracket by aligning the mark on bracket with the #1 marking on the cam- era. 14. Turn the camera clockwise. The camera should be locked in place. NOTE: To disconnect a LAN cable, loosen the cable gland and pull the cable against the socket wall towards the side of the locking tab.
Page 16 VIVOTEK 15. Secure the connection using the T25 L-wrench from the top. 16. Open the dome cover using the T20 L-wrench. Install a microSD card, and replace the desic- cant bag on the inner side of camera chassis. icro 16 - User's Manual...
Page 17 VIVOTEK 17. Remove the foam blocks in the chassis, and the front and rear of the lens module. Also re- move the plastic sheet from the inside of the dome cover. 18. When done, secure the dome cover using the T20 L-wrench.
Page 18 VIVOTEK IR Unit Installation 1. Remove the sun shield from the camera, and then install the IR unit by driving 3 Phillips screws. Align the cable with the routing groove on camera. 2. Remove the metal cap on the IR unit connector. Install the connector by aligning the indica- tors.
Page 19 VIVOTEK 3. Pess the cable into the routing groove so that the cable will not get in the way when installing the camera. Pendant Mount The camera can also be mounted through a 3/4” pendant mount combination as shown below.
Page 20 VIVOTEK Mechanical Dimensions Shown below are the dimensions of the wall mount bracket and its mounting holes: You can find the installation instructions on VIVOTEK’s website for other options such as para- pet mount: http://www.vivotek.com/web/product/accessories.aspx 20 - User's Manual...
Page 21: Network Deployment
VIVOTEK Network Deployment Setting up the Network Camera over the Internet There are several ways to set up the Network Camera over the Internet. The first way is to set up the Network Camera behind a router. The second way is to utilize a static...
Page 22 For more information with network configuration options (such as that of streaming ports), please refer to Configuration > Network Settings. VIVOTEK also provides the automatic port forwarding feature as an NAT traversal function with the precondition that your router must support the UPnP port forwarding feature.
Page 23 VIVOTEK Internet connection with static IP Choose this connection type if you are required to use a static IP for the Network Camera. Please refer to LAN on page 79 for details. Internet connection via PPPoE (Point-to-Point over Ethernet) Choose this connection type if you are connected to the Internet via a DSL Line. Please refer to PPPoE on page 80 for details.
Page 24: Software Installation
Software Installation 19. 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.
Page 25 VIVOTEK 19-3. The program will search for all VIVOTEK network devices on the same LAN. 19-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 26 VIVOTEK Forceful Password Configuration 20. The first time you log in to the camera, the firmware will prompt for a password configuration for security concerns. Protecting your camera with a password can deter the majority of cyber attacks. 20-1. Enter the combination of alphabetic and numeric characters to fulfill the password strength.
Page 27 VIVOTEK 20-2. Another prompt will request for the password you just configured. Enter the password and then you can start configure your camera and see the live view. Hardware Reset The reset button is used to reset the system or restore the factory default settings. Sometimes resetting the system can return the camera to normal operation.
Page 28: Ready To Use
VIVOTEK Ready to Use 1. A browser session with the Network Camera should prompt as shown below. 2. You should be able to see live video from your camera. You may also install the 32-channel recording software from the software CD in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents.
Page 29: Accessing The Network Camera 29
3. Live video will display in your web browser. 4. If it is the first time installing the VIVOTEK network camera, an information bar will pop up as shown below. Follow the instructions to install the required plug-in on your computer.
Page 30 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 31: Using Rtsp Players
VIVOTEK Using RTSP Players To view the streaming media using RTSP players, you can use one of the following players that support RTSP streaming. VLC media player VLC media player 1. Launch the RTSP player. mpegable Player 2. Choose File > Open URL. A URL dialog box will pop up.
Page 32: Using 3Gpp-Compatible Mobile Devices
VIVOTEK Using 3GPP-compatible Mobile Devices To view the streaming media through 3GPP-compatible mobile devices, make sure the Network Camera can be accessed over the Internet. For more information on how to set up the Network Camera over the Internet, please refer to Setup the Network Camera over the Internet on page To utilize this feature, please check the following settings on your Network Camera: 1.
Page 33: Using Vivotek Recording Software
Network Camera to the Channel list. For detailed information about how to use the recording software, please refer to the user’s manual of the software or download it from http://www.vivotek.com. 1. If you encounter problems with displaying live view or the onscreen plug-in control, you may try to remove the plug-ins that might have been installed on your computer.
Page 34: Main Page 34
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, and Live Video Window. VIVOTEK INC. Resize Buttons Host Name Logo...
Page 35 VIVOTEK VIVOTEK INC. Logo Click this logo to visit the VIVOTEK website. Host Name The host name can be customized to fit your needs. For more information, please refer to System on page 46. Camera Control Area Video Stream: This Network Camera supports multiple streams (stream 1 ~ 4) simultaneously. You can select either one for live viewing.
Page 36 VIVOTEK Pan /Tilt /Zoom /Focus speed: Adjust the speed of Pan/ Tilt/ Zoom/ Focus: Pan speed Tilt speed Zoom speed Focus speed Slower Faster Note that mouse screen control is also supported. You can refer to page 112 for related information.
Page 37 VIVOTEK Resize Buttons Click the Auto button, the video cell will resize automatically to fit the monitor. Click 100% is to display the original homepage size. Click 50% is to resize the homepage to 50% of its original size. Click 25% is to resize the homepage to 25% of its original size.
Page 38 VIVOTEK Snapshot: Click this button to capture and save still images. The captured images will be displayed in a pop-up window. Right-click the image and choose Save Picture As to save it in JPEG (*.jpg) or BMP (*.bmp) format. Digital Zoom: Click and deselect the “Disable digital zoom” to enable the zoom operation. The navigation screen indicates the part of the image being magnified.
Page 39 VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Time Video (HTTP-V) 2011/03/10 17:08:56 Title and Time Video 17:08:56 2011/03/10 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 60.
Page 40: Client Settings 40
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 41 VIVOTEK Two way audio Half duplex: Audio is transmitted from one direction at a time, e.g., from a PC holding a web console with the camera. Full duplex: Audio is transmitted in both directions simultaneously. MP4 Saving Options Users can record live video as they are watching it by clicking the button - Start MP4 Recording - on the main page.
Page 42 VIVOTEK Joystick Settings Enable Joystick Connect to the USB plug of the joystick to a USB port on your management computer. Once a USB joystick is connected, the related joystick configuration will be available on the Client settings window. The joystick should work properly without installing any other driver or software.
Page 43 VIVOTEK Buttons Configuration In the Joystick Settings window, you can use the combinations of pull-down menus, Actions and Button number, to assign joystick buttons with different functions. The number of buttons may differ from the joystick you attached. Please follow the steps below to configure your joystick buttons: 1.
Page 44 VIVOTEK NOTE: • If you want to assign Preset actions to your joystick, the PTZ preset locations should be configured in advance. • If your joystick is not working properly, it may need to be calibrated. Click the Calibrate button to open the Game Controllers window located in Microsoft Windows control panel and follow the instructions for trouble shooting.
Page 45: Configuration 45
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.
Page 46: System > General Settings
VIVOTEK System > General settings This section explains how to configure the basic settings for the Network Camera, such as the host name and system time. It is composed of the following two columns: System and System Time. System Host name: Enter a desired name for the Network Camera. The text will be displayed at the top of the main page.
Page 47 VIVOTEK System time Keep current date and time: Select this option to preserve the current date and time of the Network Camera. The Network Camera’s internal real-time clock maintains the date and time even when the power of the system is turned off.
Page 48 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.
Page 49: System > Homepage Layout
Theme Options (the second tab on this page). The settings will be displayed automatically in this Preview field. The following shows the homepage using the default settings: ■ Hide Powered by VIVOTEK: If you check this item, such wording will be removed from the homepage. Logo graph Here you can change the logo at the top of your homepage.
Page 50 VIVOTEK Theme Options Here you can change the color of your homepage layout. There are three types of preset patterns for you to choose from. The new layout will simultaneously appear in the Preview filed. Click Save to enable the settings.
Page 51 6. Click Save to enable the settings. Below are the options for system integrators or VARs. You can use the checkboxes to replace VIVOTEK’s company logo, the embedded website address or the slogan “Powered by VIVOTEK.“ When done, use the Save button to complete the configuration.
Page 52: System > Logs
VIVOTEK System > Logs This section explains how to configure the Network Camera to send the system log to the remote server as backup. Log server settings Follow the steps below to set up the remote log: 1. Select Enable remote log.
Page 53 VIVOTEK Access log Access log displays the access time and IP address of all viewers (including operators and administrators) in a chronological order. The access log is stored in the Network Camera’s buffer area and will be overwritten when reaching a certain limit.
Page 54 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...
Page 55: System > Parameters
VIVOTEK System > Parameters The View Parameters page lists the entire system’s parameters in an alphabetical order. If you need technical assistance, please provide the information listed on this page. User's Manual - 55...
Page 56: System > Maintenance
Note: Do not power off the Network Camera during the upgrade! Follow the steps below to upgrade the firmware: 1. Download the latest firmware file from the VIVOTEK website. The file is in .pkg file format. 2. Click Browse… and specify the firmware file.
Page 57 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. General settings > Reboot This feature allows you to reboot the Network Camera, which takes about one minute to complete.
Page 58 VIVOTEK General settings > Restore This feature allows you to restore the Network Camera’s factory defaults. 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 59 VIVOTEK The following message is displayed when attempting to upload an incorrect file format. Export language file: Click to export language strings. VIVOTEK provides nine languages: English, Deutsch, Español, Français, Italiano, 日本語, Português, 簡体中文, and 繁體中文 . Update custom language file: Click Browse… and specify your own custom language file to upload.
Page 60: Media > Image
VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following four columns: General settings, Picture settings, Exposure, and Privacy mask. General settings Video title Show_timestamp and video title in videos_and_snapshots: Enter a name that will be displayed on the title bar of the live video as the picture shown below.
Page 61 The Network Camera automatically removes the IR cut filter when a Digital Input is triggerred. For example, the digital input can come from a housing that is equipped with IR illumination and control circuits such as VIVOTEK’s AM-214. ■ Schedule mode The Network Camera switches between day mode and night mode based on a specified schedule.
Page 62 VIVOTEK Image settings On this page, you can tune the White balance and Image adjustment settings. Sensor Setting 1: For normal situations White balance: Adjust the value for the best color temperature. ■ Select one of the white balance modes: 1.
Page 63 VIVOTEK Enable 3D Noise reduction ■ Check to enable noise reduction in order to reduce noises and flickers in image. This applies to the onboard 3D Noise Reduction feature. Use the pull-down menu to adjust the reduction strength. Note that applying this function to the video channel will consume system computing power.
Page 64 VIVOTEK Exposure control: ■ Exposure level: You can manually set the Exposure level, which ranges from -2.0 to +2.0 (dark to bright). You can also select other values from the Exposure mode menus and select a preferred scenario or manually configure the associated settings. You may prefer a shorter shutter time to better capture moving objects, while a faster shutter reduces light and needs to be compensated by electrical brightness gains.
Page 65 VIVOTEK ■ Maximum gain control: Select a maximum value for the electronic gain from the slide bar. The gain value also has its effect on the sensitivity of the IR cut filter. When applying the gain control, IR cut filter setting will change accordingly.
Page 66 VIVOTEK Exposure Profile: (Only available when the IR cut filter is not set to the Auto mode) If you want to configure another sensor and exposure setting for an individual day/night/schedule mode, please click Profile mode to open the Profile of exposure settings page as shown below.
Page 67 VIVOTEK Focus Focus here refers to the Remote Focus, is applicable to Network Cameras that are equipped with stepping motor lens. Focus window Chances are while moving the lens around the surveillance area, focusing can be slow when zooming in on a complex scene with no distinctive objects especially in the center of the field of view.
Page 68 VIVOTEK Privacy mask On this page, you can block out sensitive view areas to address privacy concerns. NOTE: 1. The navigation buttons here also support the continuous move. You can click and hold down the button to move across the screen until you release the button.
Page 69 VIVOTEK NOTE: • The camera supports "3D Privacy Mask." Privacy masks should stay at the same positions regardless of how the camera lens may move. • When the "Enabled privacy mask" checkbox is deselected, no privacy masks will appear on screen.
Page 70: Media > Video
VIVOTEK Media > Video Stream settings This Network Camera supports multiple streams with frame sizes ranging from 384 x 216 to 1920 x 1080 pixels. The definition of multiple streams: ■ Stream 1: Users can define the Frame sizes, compression format, image quality, etc.
Page 71 VIVOTEK Click the stream item to display the detailed information. . This Network Camera offers real-time H.265, H.264, and MJPEG compression standards (Multiple Codec) for real-time viewing. If the H.265 / H.264 mode is selected, the video is streamed via RTSP protocol.
Page 72 VIVOTEK ■ Frame size You can set up different video resolution for different viewing devices. For example, set a smaller frame size and lower bit rate for remote viewing on mobile phones and a larger video size and a higher bit rate for live viewing on web browsers.
Page 73 VIVOTEK Dynamic Intra Frame w/ static scenes Static scene P P P P P P P P P P P P P P P P P P P I Dynamic Intra Frame w/ activities in scenes P P P P P P P I...
Page 74 VIVOTEK non-interested ROI_0 ROI_0 As the result, the lower screen is constantly displayed in high details, while the upper half is transmitted using a lower-quality format. Although the upper half is transmitted using a lower quality format, you still have an awareness of what is happening on the whole screen.
Page 75 VIVOTEK - Quality priority: Use the slide bar to tune the quality contrast between the ROI and non- interested areas. The farther the slide bar button is to the right, the higher the image quality of the ROI areas. On the contrary, the farther the slide bar button to the left, the higher the image quality of the non-interested area.
Page 76 VIVOTEK JPEG mode is selected, the Network Camera sends consecutive JPEG images to the client, producing a moving effect similar to a filmstrip. Every single JPEG image transmitted guarantees the same image quality, which in turn comes at the expense of variable bandwidth usage. Because the media contents are a combination of JPEG images, no audio data is transmitted to the client.
Page 77: Media > Audio
VIVOTEK Media > Audio Audio Settings Mute: Select this option to disable audio transmission from the Network Camera to all clients. Note that if muted, no audio data will be transmitted even if audio transmission is enabled on the Client Settings page.
Page 78: Media Profiles
VIVOTEK Media profiles You can configure a different video stream for each of the 3 default profiles, Max. view, Recording, Live view, and App. The related video stream information will display, including stream number, resolution, codec used, frame rate, etc. The Multicast port number, and address for video, audio, and Metadata configuration will also be listed.
Page 79: Network > General Settings
Use fixed IP address: Select this option to manually assign a static IP address to the Network Camera. 1. You can make use of VIVOTEK Installation Wizard 2 on the software CD to easily set up the Network Camera on LAN. Please refer to Software Installation on page 24 for details.
Page 80 VIVOTEK Primary DNS: The primary domain name server that translates host names into IP addresses. Secondary DNS: Secondary domain name server that backs up the Primary DNS. Primary WINS server: The primary WINS server that maintains the database of computer names and IP addresses.
Page 81 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 82 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 83 VIVOTEK Enable IPv6 Select this option and click Save to enable IPv6 settings. Please note that this only works if your network environment and hardware equipment support IPv6. The ® browser should be Microsoft Internet Explorer 6.5, Mozilla Firefox 3.0 or above.
Page 84 VIVOTEK Please follow the steps below to link to an IPv6 address: 1. Open your web browser. 2. Enter the link-global or link-local IPv6 address in the address bar of your web browser. 3. The format should be: http://[2001:0c08:2500:0002:0202:d1ff:fe04:65f4]/ IPv6 address 4.
Page 85 VIVOTEK User's Manual - 85...
Page 86: Network > Streaming Protocols
VIVOTEK Network > Streaming protocols NOTE: The metadata information can only be transmitted through the HTTP main port. Metadata is not available through the secondary HTTP port. HTTP streaming To utilize HTTP authentication, make sure that your have set a password for the Network Camera first;...
Page 87 VIVOTEK URL command -- http://<ip address>:<http port>/<access name for stream 1, 2, 3, 4, or 5> For example, when the Access name for stream 2 is set to video2.mjpg: 1. Launch the Mozilla Firefox browser. 2. Type the above URL command in the address bar. Press Enter.
Page 88 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 digest risks of it being intercepted.
Page 89 Unrestricted in scope IMPORTANT: The Multicast metadata port is utilized by VIVOTEK VADP modules to transfer video analytics results, PTZ stream, textual data, and event messages between the camera and the client side running and observing the video analysis. If your client side computer is located outside the local network, you may need to open the associated TCP port on routers and firewall.
Page 90: Network > Ddns
IP address, to have a fixed host and domain name. Express link Express Link is a free service provided by VIVOTEK server, which allows users to register a domain name for a network device. One URL can only be mapped to one MAC address. This service will examine if the host name is valid and automatically open a port on your router.
Page 91 DDNS: Dynamic domain name service Enable DDNS: Select this option to enable the DDNS setting. Provider: Select a DDNS provider from the provider drop-down list. VIVOTEK offers Safe100.net, a free dynamic domain name service, to VIVOTEK customers. It is recommended that you register Safe100.net to access VIVOTEK’s Network Cameras from the Internet.
Page 92 4. Select Enable DDNS and click Save to enable the setting. ■ CustomSafe100 VIVOTEK offers documents to establish a CustomSafe100 DDNS server for distributors and system integrators. You can use CustomSafe100 to register a dynamic domain name if your distributor or system integrators offer such services.
Page 93 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 94 VIVOTEK QoS/DSCP (the DiffServ model) DSCP-ECN defines QoS at Layer 3 (Network Layer). The Differentiated Services (DiffServ) model is based on packet marking and router queuing disciplines. The marking is done by adding a field to the IP header, called the DSCP (Differentiated Services Codepoint). This is a 6-bit field that provides 64 different class IDs.
Page 95: Network > Snmp (Simple Network Management Protocol)
VIVOTEK Network > SNMP (Simple Network Management Protocol) This section explains how to use the SNMP on the network camera. The Simple Network Management Protocol is an application layer protocol that facilitates the exchange of management information between network devices. It helps network administrators to remotely manage network devices and find, solve network problems with ease.
Page 96: Network > Ftp
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. You can utilize VIVOTEK's Shepherd utility to upgrade the firmware via FTP server. By default, the FTP port is set to 21. It can also be assigned to another port number between 1025 and 65535.
Page 97: Security > User Accounts
VIVOTEK Security > User accounts This section explains how to enable password protection and create multiple accounts. Account management The administrator account name is “root”, which is permanent and can not be deleted. If you want to add more accounts in the Account management window, please apply the password for the “root” account first.
Page 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.
Page 99: Security > Https (Hypertext Transfer Protocol Over Ssl)
VIVOTEK Security > HTTPS (Hypertext Transfer Protocol over SSL) This section explains how to enable authentication and encrypted communication over SSL (Secure Socket Layer). It helps protect streaming data transmission over the Internet on higher security level. Create and Install Certificate Method Before using HTTPS for communication with the Network Camera, a Certificate must be created first.
Page 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 re- turn to the main page. Change the URL address from “http://” to “https://“ in the address bar and press Enter on your keyboard.
Page 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.
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.
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 a 11. When the certifice file is successfully loaded, its status will be stated as Active. certificate must have been created and installed before you can click on the “Save" button for the configuration to take effect.
Page 106: Security > Access List
VIVOTEK Security > Access List This section explains how to control access permission by verifying the client PC’s IP address. General Settings Maximum number of concurrent streaming connection(s) limited to: Simultaneous live viewing for 1~10 clients (including all streams). 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 VLC Player).
Page 107 VIVOTEK ■ Disconnect: If you want to break off the current connections, please select them and click this button. Please note that those checked connections will only be disconnected temporarily and they will automatically retry a connection (IE Explorer or VLC Player).
Page 108 VIVOTEK Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List in the CIDR format, e.g. 192.168.xx.xx/24. For example: IP address 192.168.2.x will be blocked. Range: This rule allows the user to assign a range of IP addresses to the Allow/Deny List.
Page 109 Authentication server (usually a RADIUS server): Checks the client certificate and decides whether to accept the end user’s access request. ■ VIVOTEK Network Cameras support two types of EAP methods to perform authentication: EAP-PEAP and EAP-TLS. Please follow the steps below to enable 802.1x settings: 1.
Page 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: ► Below is the authentication process for 802.1x: 1.
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.
Page 112: Ptz > Ptz Settings
VIVOTEK PTZ > PTZ settings This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation. The camera comes with built-in PTZ mechanisms. NOTE: The navigation buttons here also support the continuous move. You can click and hold down the button to move across the screen until you release the button.
Page 113 You can also restore the home posiotion to the factory default, which is approximately 45 degree looking down with the lens lined up with the VIVOTEK logo. Patrol list This column displays the configured patrols.
Page 114 VIVOTEK To create a recorded patrol, 1. Enter a name for the patrol. 2. Use mouse clicks or the PTZ panel to select a field of view as your start point. 3. Select the Pan/Tilt/Zoom/Focus speed, and the PTZ control mode.
Page 115 VIVOTEK Misc. settings: Use the checkboxes and the pull-down menus for the camera to automatically resume the previous action or return to the home position after the camera has stayed idle for a period of time. PTZ control panel operation mode: This determines how your mouse and PTZ control panel works on a live view window.
Page 116 VIVOTEK another. Only the preset points are displayed. Apply previous action if the camera idles for __(1~999) seconds: You can assign an action to be taken when the camera sits idle for a configurable period time. For example, you can let camera resume a patrol tour.
Page 117 VIVOTEK Auto tracking In this window, you can modify the minimum object size as the triggering factor while performing the Auto Tracking function. You can move the camera view to an area of your interest, estimate, and define the possible size of objects. For example, you can designate the object size such as that of a human trespasser.
Page 118 VIVOTEK Auto tracking is configured by designating the minimum object size. Moving objects that enter the current region of view will trigger the tracking action. Auto tracking, if applied, is designed to track an intruder in a place where human traffic is not heavy, such as a warehouse or a load area.
Page 119: Event > Event Settings
VIVOTEK Event > Event settings This section explains how to configure the Network Camera to responds to particular situations (event). A typical application is that when a motion is detected, the Network Camera sends buffered images to an FTP server or e-mail address as notifications. Click on Help, there is an illustration shown in the pop-up window explaining that an event can be triggered by many sources, such as motion detection or external digital input devices.
Page 120 VIVOTEK ■ Event name: Enter a name for the event setting. ■ Enable this event: Select this option to enable the event setting. ■ Priority: Select the relative importance of this event (High, Normal, or Low). Events with a higher priority setting will be executed first.
Page 121 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 122 VIVOTEK 3. Action Define the actions to be performed by the Network Camera when a trigger is activated. ■ Trigger digital output for seconds Select this option to turn on the external digital output device when a trigger is activated. Specify the length of the trigger interval in the text box.
Page 123 VIVOTEK NOTE: If you configured a motion detection window as a trigger, the motion detection may become invalid when the camera’s field of view moved away from the detection window. You can let camera return to the motion detection position to detect the coming event by re-configuring your Home position in PTZ >...
Page 124 VIVOTEK Add server Click Add server to unfold the server setting window. You can specify where the notification messages are sent when a trigger is activated. A total of 5 server settings can be configured. There are four choices of server types available: Email, FTP, HTTP, and Network storage. Select the item to display the detailed configuration options.
Page 125 VIVOTEK To verify if the email settings are correctly configured, click Test. The result will be shown in a pop-up window. If successful, you will also receive an email indicating the result. Click Save server to enable the settings, then click Close to exit the Add server page.
Page 126 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 127 VIVOTEK Network storage: Select to send the media files to a network storage location when a trigger is activated. Please refer to NAS server on page 145 for details. Click Save server to enable the settings, then click Close to exit the Add server page.
Page 128 VIVOTEK Add media Add media Click to open the media setting window. You can specify the type of media that will be sent and preserved 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 129 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_20110320_100341 File name preﬁx Date and time sufﬁx The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings, then click Close to exit the Add media page.
Page 130 VIVOTEK ■ Maximum duration Specify the maximum recording duration in seconds. Up to 20 seconds can be set. For example, if pre-event recording is set to 5 seconds and the maximum duration is set to 10 seconds, the Network Camera continues to record for another 4 seconds after a trigger is activated.
Page 131 VIVOTEK ■ View: Click this button to open a file list window. This function only apllies when an SD card and networked storage are available. If you click View button of SD card, a Local storage page will pop up for you to manage recorded files on SD card.
Page 132 VIVOTEK Here is an example of the Event setting: When completed the settings with steps 1~3 to arrange Schedule, Trigger, and Action of an event, click Save event to enable the settings and click Close to exit the page. The following is an example of the Event setting page:...
Page 133 VIVOTEK When the Event Status is ON, once an event is triggered by motion detection, the Network Camera will automatically send snapshots via e-mails. status or click Delete to remove If you want to stop the event trigger, you can click to turn it to the event setting.
Page 134: Applications > Motion Detection
VIVOTEK Applications > Motion detection This section explains how to configure the Network Camera to enable motion detection. A total of 5 motion detection windows can be configured. Motion Detection Setting 2: For special situations Motion Detection Setting 1: For normal situations Follow the steps below to enable motion detection: 1.
Page 135 VIVOTEK Photos or videos can be captured instantly and configured to be sent to a remote server (via an Email or FTP server). For more information on how to configure an event setting, please refer to Event settings on page 119.
Page 136 VIVOTEK This motion detection window will also be displayed on the Event Settings page. You can go to Event > Event settings > Trigger to select it as a trigger source. Please refer to page 120 for detailed information. NOTE: ►...
Page 137: Applications > Di And Do
VIVOTEK Applications > DI and DO Digital input: Select High or Low to define normal status for the digital input. Connect a digital input from a sensor device to the camera, the Network Camera will report the current signal status. You may then configure the Normal status (non-trigger status) as High or Low.
Page 138: Applications > Audio Detection
VIVOTEK Applications > Audio detection Audio detection, along with video motion detection, is applicable in the following scenarios: 1. Detection of activities not covered by camera view, e.g., a loud input by gun shots or breaking a door/ window. 2. A usually noisy environment, such as a factory, suddenly becomes quiet due to a breakdown of machines.
Page 139 VIVOTEK You can use the Profile window to configure a different Audio detection setting. For example, a place can be noisy in the day time and become very quiet in the night. 1. Click on the Enable this profile checkbox. Once the Audio detection window is opened, the current sound input will be interactively indicated by a fluctuating yellow wave diagram.
Page 140: Applications > Vadp (Vivotek Application Development Platform)
VADP requirements. Please contact technical support or the vendor of your 3rd-party module for the parameters contained within. • Users can also run VIVOTEK's VADP packages as a means to access updated functionality instead of replacing the entire firmware. •...
Page 141 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 142 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.
Page 143: Recording > Recording Settings
VIVOTEK Recording > Recording settings This section explains how to configure the recording settings for the Network Camera. Recording Settings Insert your SD card and click here to test NOTE: ► Please remember to format your SD card when using it for the first time. Please refer to page 148 for detailed information.
Page 144 VIVOTEK If you enable adaptive recording and enable time-shift cache stream on Camera A, only when an event is triggered on Camera A will the server record video streams in the full frame rate; otherwise, it will only request the I frame data during normal monitoring, thus effectively save lots of bandwidth and storage.
Page 145 VIVOTEK 2. Destination You can select the SD card or network attached storage (NAS) for recording video files. NAS server Click Add NAS server to open the server setting window and follow the steps below to set up: 1. Fill in the information for your server.
Page 146 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 select either the entire storage space available or specify a reserved space. The recording size limit must be larger than the reserved space for cyclic recording.
Page 147 VIVOTEK this page. When the system begins recording, it will send the recorded files to a networked storage or SD card. The new recording name will appear on the recording page as shown below. To remove a recording setting from the list, select it and click Delete.
Page 148: Local Storage > Sd Card Management
VIVOTEK Local storage > SD card management NOTE: • It is recommended to turn OFF the recording activity before you remove an SD card from the camera. • The lifespan of an SD card is limited. Regular replacement of the SD card can be necessary.
Page 149: Local Storage > Content Management
VIVOTEK SD card control ■ Enable cyclic storage: Check this item if you want to enable cyclic recording. When the maximum capacity is reached, the oldest file will be overwritten by the latest one. ■ Enable automatic disk cleanup: Check this item and enter the number of days you wish to retain a file.
Page 150 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 151 VIVOTEK ■ Lock/Unlock: Select the checkbox in front of a desired search result, then click this button. The selected items will become Locked, which will not be deleted during cyclic recording. You can click again to unlock the selections. For example:...
Page 152: Appendix
VIVOTEK Appendix URL Commands for the Network Camera 1. Overview For some customers who already have their own web site or web control application, the Network Camera/Video Server can be easily integrated through URL syntax. This section specifies the external HTTP-based application programming interface.
Page 153 VIVOTEK URL C OMMAND IST FOR Version 3.2d 2020/09/01 www.vivotek.com User's Manual - 153...
Page 154 VIVOTEK may make changes to specifications and product descriptions at any time, without notice. The following is trademarks of VIVOTEK INC., and may be used to identify VIVOTEK products only: VIVOTEK. Other product and company names contained herein may be trademarks of their respective owners.
Page 155 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Index Index ..............................2 Revision History ........................... 6 Overview ............................. 26 Style Convention ........................27 General CGI URL Syntax and Parameters ................28 Security Level ..........................29 Get Server Parameter Values ....................30 Set Server Parameter Values .....................
Page 156 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.10 IR Cut Control......................90 7.10.1 IR cut control setting per channel ................ 94 7.10.2 IR cut control Illuminators ................... 96 7.11 Image Setting per Channel ................... 98 7.12 Exposure Window Setting per Channel ..............108 7.12.1.
Page 157 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.32 HTTPS ........................216 7.33 Storage Management Setting ..................217 7.34 Region of Interest ....................... 219 7.35 ePTZ Setting ......................219 7.35.1. ePTZ Settings for Each Stream ................220 7.36 Focus Window Setting ....................221 7.37...
Page 158 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.11 UART HTTP Tunnel Channel (capability_nuart > 0) ..........256 8.12 Event/Control HTTP Tunnel Channel (capability_evctrlchannel > 0) ...... 257 8.13 Get SDP of Streams ....................258 8.14 Open the Network Stream ..................259 8.15...
Page 159 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Revision History Version Issue date Editor Comment V1.0a 2015/03/11 Kelly 1. Initial draft V1.0b 2015/04/24 Kelly 1. Fixed bugs V1.0c 2015/05/18 Kelly 1. Fixed bugs 2. Add fisheye parameters and cgi 3. Remove videoinpreview and imagepreview parameters 4.
Page 160 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment 2. Make description that polygon qvga and polygon px in motion are not recommended to use 3. Add PIR group 4. Modify the description of capability_remotefocus, camctrl_c<0~(n-1)>_isptz, network_rtsp_s<0~capability_nmediastream-1>_accessname...
Page 161 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment videoin_c<0~(n-1)>_minexposure, videoin_c<0~(n-1)>_maxexposure, videoin_c<0~(n-1)>_piris_mode, videoin_c<0~(n-1)>_piris_position, videoin_c<0~(n-1)>_maxgain, videoin_c<0~(n-1)>_mingain, ircutcontrol_sensitivity, image_c<0~(n-1)>_eis_mode, exposurewin_c<0~(n-1)>_mode, capability_image_c<0~(n-1)>_wbmode, eptz_c<0~(n-1)>osdzoom capability_image_c<0~(n-1)>_privacymask_wintype, capability_ptzenabled (Bit6/Bit8/Bit9) 2. Add these parameter: videoin_c<0~(n-1)>_exposuremode, videoin_c<0~(n-1)>_gainvalue, videoin_c<0~(n-1)>_shuttervalue, videoin_c<0~(n-1)>_zoomratiodisplay, image_c<0~(n-1)>_eis_strength, image_c<0~(n-1)>_dis_mode, image_c<0~(n-1)>_dis_strength, image_c<0~(n-1)>_freeze, capability_thermal_controlmode, capability_daynight_c<0~(n-1)>_blackwhitemode,...
Page 162 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment capability_image_c<0~(n-1)>_privacymask_ncolor 3. Add 3D privacy mask group 4. Add capability_smartsensor_c<0~(n-1)> group 5. Add capability_peripheral_c<0~(n-1)> 6. Add camera PTZ control group for SD series 7. Add uart control group for SD series 8.
Page 163 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment 5. Add capability_ptz_c<0~(n-1)> group 6. Add capability_smartstream_version parameter 7. Remove capability_smartstream_supportquality and capability_smartstream_supportmaxbitrate parameters 8. Modify the security level of eptz_c<0~(n-1)> group for fisheye 9. Remove the unused parameter: camctrl_c<0~(n-1)>_horizontalalignment...
Page 164 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment 2. Add smartsd value type to capability_supporttriggertype parameter 3. Add these parameters: ircutcontrol_extledmode, camctrl_c<0~(n-1)>_focusmode, capability_image_c<0~(n-1)>_exposure_hlcmode_affect, capability_daynight_c<0~(n-1)>_extled_interface, capability_camctrl_c<0~(n-1)>_focusmode, capability_videoin_c<0~(n-1)>_rotationaffect, capability_videoin_c<0~(n-1)>_minresolution, capability_videoin_c<0~(n-1)>_mode<0~(m-1)>_eptz, capability_videoin_c<0~(n-1)>_mode<0~(m-1)>_wdrpro, capability_videoin_c<0~(n-1)>_mode<0~(m-1)>_minresolution 4. Add camera PTZ control group for IZ series 5.
Page 165 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment 4. Modify the value range description of image_c0_restoreatwb V1.9a 2016/07/06 Kelly 1. Add these parameters: capability_image_c<0~(n-1)>_aespeedsupportsensitivity 2. Add wireless group 3. Add wireless cgi (connect_ap.cgi/getwirelessinfo.cgi/getwlsignalstrength.cgi/sta rt_wps.cgi) in chapter 8.
Page 166 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment 4. Remove washerctrl.cgi 5. Add peripheral cgi 6. Remove camclean group V1.9e 2016/10/14 Sarah 1. Add these parameters: capability_image_c<0~(n-1)>_focuswindow_nwindow, capability_image_c<0~(n-1)>_focuswindow_range, 2. Modify the description of focuswindow group V2.0a...
Page 167 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment V2.1b 2017/01/04 Sarah 1. Modify the description of these parameters: audioin_c0_aec_enable, capability_image_c<0~(n-1)>_exposure_hlcmode_supportwind capability_image_c<0~(n-1)>_exposure_hlcmode_affect, event_i<0~2>_action_goto_sync, ircutcontrol_bwmode 2. Remove these parameters: event_i<0~2>_action_cutsom<0~2>_enable, event_i<0~2>_action_cutsom<0~2>_name, 3. Rename aec parameter: capability_audio_aecswitch -> capability_audio_aecmode 4.
Page 168 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment camctrl_c<0~(n-1)>_idleaction_interval V2.2c 2017/04/27 Kelly 1. Modify the description of these parameters: capability_camctrl_c<0~(n-1)>_focusmode V2.3a 2017/06/01 Kelly 1. Add these parameters: capability_videoin_c<0~(n-1)>_cmosfreq_support, image_c<0~(n-1)>_xoffset, image_c<0~(n-1)>_yoffset, capability_image_c<0~(n-1)>_deinterlace_support, capability_image_c<0~(n-1)>_deinterlace_mode, image_c<0~(n-1)>_deinterlace_enable, image_c<0~(n-1)>_deinterlace_mode, capability_image_c<0~(n-1)>_dnrtype, status_c<0~(n-1)>_signal_detect,...
Page 169 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment capability_localstorage_modnum, capability_localstorage_modversion, capability_localstorage_stormgrversion, capability_localstorage_supportedge, capability_localstorage_slconnum 3. Modify the description of these groups: exposurewin_c<0~(n-1)>_win_i<0~(k-1)>, exposurewin_c<0~(n-1)>_profile_i<0~(m-1)>_win_i<0~(k-1)> V2.3b 2017/07/10 Kelly 1. Modify the description of these parameters: videoin_exposurelevel, videoin_enablepreview, videoin_c<0~(n-1)>_exposurelevel, videoin_c<0~(n-1)>_exposuremode,...
Page 170 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment videoin_c<0~(n-1)>_s<0~(m-1)>_smartfps_enable, audioclip_i<0~1>_name, audioout_c<0~(n-1)>_volume, event_i<0~2>_action_audioclip_enable, event_i<0~2>_action_audioclip_media V2.4b 2017/11/02 Kelly 1. Add these parameters: capability_image_c<0~(n-1)>_lens_alignment, capability_image_c<0~(n-1)>_lens_alignmentlevel, image_c<0~(n-1)>_lens_alignment, capability_videoin_c<0~(n-1)>_rotationangle, capability_videoin_c<0~(n-1)>_orientation, audioclip_i<0~1>_size 2. Modify the description of these parameters: network_rtp_videoport, network_rtp_audioport, videoin_c<0~(n-1)>_s<0~(m-1)>_h264_cbr_quant,...
Page 171 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment 2. Remove these parameters: capability_image_c<0~(n-1)>_scenemode_visibility_affect, capability_image_c<0~(n-1)>_scenemode_noiseless_affect, capability_image_c<0~(n-1)>_scenemode_lpcparkinglot_affect capability_image_c<0~(n-1)>_scenemode_lpcstree_affect, image_c<0~(n-1)>_scene_enable, image_c<0~(n-1)>_profile_i0_scene_enable, image_c<0~(n-1)>_profile_i0_scene_mode 3. Add these parameters for WebAPI version 0309d: capability_daynight_c<0~(n-1)>_mode, capability_daynight_c<0~(n-1)>_builtinwled, capability_image_c<0~(n-1)>_lens_ldc_support, image_c<0~(n-1)>_lens_ldc_mode 4. Replace "capability_whitelight" with "capability_daynight_c<n>_builtinwled"...
Page 172 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment capability_image_c<0~(n-1)>_exposure_bracketing_range, videoin_c<0~(n-1)>_bracketing_level, capability_image_c<0~(n-1)>_palette_support, capability_image_c<0~(n-1)>_palette_mode, image_c<0~(n-1)>_palette_mode, capability_videoin_c<0~(n-1)>_color_support, capability_videoin_c<0~(n-1)>_eptz_zoomratio 3. Add thermalsensor type in capabiltiy_image_c<0~(n-1)>_sensortype 4. Remove the [&update=<value>] parameter V2.7a 2018/09/11 Kelly 1. Modify security level of image_c<0~(n-1)>_palette_mode 2.
Page 173 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment 4. Add these parameters for WebAPI version 0311c: capability_nevent, capability_daynight_illuminators group, capability_media_num, ircutcontrol_illuminators group, network_http per channel group, audioclip_prerecord_seconds, system_restoreexceptlen, timeshift_c<0~(n-1)>_enable, seamlessrecording_c<0~(n-1)> group, media_i<0~(n-1)>_snapshot_channel, media_i<0~(n-1)>_videoclip_channel, recording_i<0~(n-1)>_channel 5. Modify the value type of these parameters for WebAPI version...
Page 174 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment capability_protocol_maxgenconnection V2.7c 2018/12/10 Grace Add ircutcontrol_c<0~(n-1)> group Modify the description of these parameters for WebAPI version: capability_daynight_illuminators group, network_rtsp_s<0~(n-1)>_multicast group, ircutcontrol group, ircutcontrol_illuminators group, Modify the description of these parameters: capability_videoin_c<0~(n-1)>_mounttype,...
Page 175 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment accessname, ircutcontrol group, seamlessrecording group, 3. Remove these parameters for WebAPI version 0312a: autocleanup group, recording_i<0~(n-1)>_limitsize, recording_i<0~(n-1)>_cyclic, recording_i<0~(n-1)>_cyclesize, recording_i<0~(n-1)>_reserveamount 4. Add these parameters for WebAPI version 0312a: capability_storage_management group, disk_i<0~(n-1)>_autocleanup_mode,...
Page 176 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment ffect, capability_image_c<0~(n-1)>_exposure_manualmode_affect Not support structure of parameters without channel format. 2.9c 2019/10/22 Grace 1. Add audio clip control CGI. 2. Add optimizedir_c<0~(n-1)>_supportmode for Optimized IR control CGI.
Page 177 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment 3.1a 2020/4/30 Grace 1. Add PIM-SSM stream URI. 2. Remove event_customtaskfile group 3. Remove eptz support for fisheye 4. Add these parameters for WebAPI version 0314a: capability_securecam_support,...
Page 178 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Version Issue date Editor Comment system_tz, media_i<0~(n-1)>_videoclip_profiletoken 2. Add error messages for editaccount.cgi 3.2b 2020/08/19 Grace 1. Add these parameters for WebAPI version 0314b: recording_ i<0~(n-1)>_recordingjob_SourceToken_Token 3.2c 2020/08/26 Grace 1. Remove the support of exportDst.cgi and upload_dst.cgi for WebAPI version 0314b 3.2d...
Page 179 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 1. Overview For some customers who already have their own web site or web control application, a Network Camera/Video server can be easily integrated through URLs. This document provides the supersets of URL commands for VIVOTEK products.
Page 180 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 2. Style Convention In URL syntax and in descriptions of CGI parameters, a text within angle brackets denotes a content that is to be replaced with either a value or a string. When replacing the text string, the angle brackets shall also be replaced.
Page 181 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 3. General CGI URL Syntax and Parameters CGI parameters are written in lower-case and as one word without any underscores or other separators. When the CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server.
Page 182 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 4. Security Level SECURITY LEVEL SUB-DIRECTORY DESCRIPTION anonymous Unprotected. 1 [view] viewer Can view, listen, and talk to camera. 4 [operator] operator Operator access rights can modify most of the camera’s parameters except some privileges and network options.
Page 183 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 5. Get Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/viewer/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/operator/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/admin/getparam.cgi?[<parameter>] [&<parameter>…] Where the <parameter> should be <group>[_<name>] or <group>[.<name>]. If you do not specify any parameters, all the parameters on the server will be returned.
Page 184 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n 184 - User's Manual...
Page 185 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/operator/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/admin/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>]...
Page 186 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved [<parameter pair>] Only the parameters that you set and are readable will be returned. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123 Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n...
Page 187 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7. Available Parameters on the Server Valid values: VALID VALUES DESCRIPTION string[<n>] Text strings shorter than ‘n’ characters. The characters “,’,<,>,& are invalid. string[n~m] Text strings longer than `n’ characters and shorter than `m’ characters.
Page 188 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved VALID VALUES DESCRIPTION <WxH> The format for resolution. W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 available The API is listed in product WebAPIs.
Page 189 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <blank> timezoneindex -489 ~ 529 Indicate timezone and area. <Not recommended to -480: GMT-12:00 Eniwetok, Kwajalein use this> -440: GMT-11:00 Midway Island, Samoa -400: GMT-10:00 Hawaii -360: GMT-09:00 Alaska...
Page 190 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 120: GMT 03:00 Baghdad, Kuwait, Riyadh, Moscow, St. Petersburg, Nairobi 121: GMT 03:00 Iraq 140: GMT 03:30 Tehran 160: GMT 04:00 Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan...
Page 191 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) time zone. daylight_auto_begintim string[19] Display the current daylight saving start time. daylight_auto_endtime string[19] Display the current daylight saving end time. daylight_timezones string List time zone index which support daylight saving time.
Page 192 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <positive values except all daylight saving time integer> settings. This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to default values except for a union of combined results.
Page 193 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) cus" != 0. restoreexceptlen Restore the system parameters to default <positive values except lens profile. integer> This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system...
Page 194 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) language_i1 : Deutsch language_i2 : Español language_i3 : Français language_i4 : Italiano language_i5 : 日本語 language_i6 : Português language_i7 : 简体中文 language_i8 : 繁體中文 customlanguage_max 0,<positive Maximum number of custom languages count integer>...
Page 195 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) onlinenum_httppush 0,<positive Current number of HTTP push server integer> connections. onlinenum_sip 0,<positive Current number of SIP connections. integer> eth_i0 <string> Get network information from mii-tool. vi_i<0~(capability_nvi-1)> <boolean>...
Page 196 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) normalstate open, Indicate open circuit or closed circuit grounded (inactive status) 7.5 Security Group: security NAME VALUE SECURITY DESCRIPTION (get/set) privilege_do view, operator, Indicate which privileges and above...
Page 197 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Bit 2=> FTP service; Bit 3 => Two way audio and RTSP Streaming service; To stop service before changing its port settings. It’s recommended to set this...
Page 198 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) wins2 <ip address> Secondary WINS server. 7.6.1 802.1x Subgroup of network: ieee8021x (capability_protocol_ieee8021x > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable IEEE 802.1x eapmethod eap-peap, eap-tls...
Page 199 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) video Video channel for CoS audio Audio channel for CoS <product dependent> (capability_naudioin > 0) eventalarm Event/alarm channel for CoS management Management channel for CoS eventtunnel Event/Control channel for CoS Subgroup of network: qos_dscp (capability_protocol_qos_dscp >...
Page 200 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) port 21, 1025~65535 Local ftp server port. enable <boolean> Enable ftp. 7.6.5 HTTP Subgroup of network: http NAME VALUE SECURITY DESCRIPTION (get/set) port 80, 1025 ~ HTTP port.
Page 201 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.6.6 HTTP per Channel Subgroup of network: http_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) s<0~(capability_nmedia string[32] Http server push access name for stream-1)>_accessname channel N and stream M, N= 1~ <product dependent>...
Page 202 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) port 554, 1025 ~ 65535 RTSP port. (capability_protocol_rtsp=1) authmode disable, RTSP authentication mode. basic, (capability_protocol_rtsp=1) digest s<0~(capability_nmed string[32] RTSP access name for channel and iastream*capability_n stream. videoin)-1)>_accessna (capability_protocol_spush_mjpeg =1 and capability_nmediastream >...
Page 203 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) (channel1stream3) live1s4.sdp = c0_s3_accessname, (channel1stream4) etc. * Values start with prefix “cgi-bin” are prohibited. For example, “c, cg, cgi, cgi-, cgi-b, cgi-bi, cgi-bin” are not allowed. * We modify the value of RTSP...
Page 204 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0304a. audioipaddress <ip Multicast audio IP address. <product address> * We support this parameter when the version dependent> number (httpversion) is equal or greater than 0304a. * Only available when capability_naudioin > 0 metadataipaddres <ip...
Page 205 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) metadataport 1025 ~ 65535 Metadata channel port for RTP. 7.6.12 PPPoE Subgroup of network: pppoe (capability_protocol_pppoe > 0) NAME VALUE SECURITY DESCRIPTION (get/set) user string[128] PPPoE account user name.
Page 206 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable access list filtering. admin_enable <boolean> Enable administrator IP address. admin_ip string[43] Administrator IP address. maxconnection Maximum number of (s). "capability_protoc ol_maxconnection" type 0, 1 Ipfilter policy : 0 =>...
Page 207 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "auto": Auto white balance <product dependent> panorama, manual, "panorama": indicates that camera rbgain, would try to balance the white widerange, balance effect of every sensor. "rbgain": Use rgain and bgain to set...
Page 208 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 2: EV -1.3 3: EV -1.0 4: EV -0.7 5: EV -0.3 6: EV 0 7: EV +0.3 8: EV +0.7 9: EV +1.0 10: EV +1.3 11: EV +1.7...
Page 209 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <Not support * Not support this parameter anymore> anymore when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c<0~(n-1)>_mode" to switch on/off BLC.
Page 210 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. ptzstatus 0,<positive A 32-bit integer, each bit can be set <Not support...
Page 211 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc. 5~8000 => 1/5s ~ 1/8000s etc. * Available value is * Only available when listed in "capability_image_c<0~(n-1)>_exposu...
Page 212 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 213 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) widerange, balance effect of every sensor. outdoor, "rbgain": Use rgain and bgain to set indoor, white balance manually. sodiumauto, "manual": 2 cases: a. if "rbgain" is not supported, this...
Page 214 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbmo de". * Only valid when "videoin_c<0~(n-1)>_whitebalance" ! = auto * Normalized range. exposurelevel 0~12 Exposure level "0,12": This range takes the concept from DC's exposure tuning options.
Page 215 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) variable Iris, and keep adjusting Gain "capability_image_c<0~(n- and Shutter speed automatically. 1)>_exposure_modetype") "qualitypriority": Automatically adjust the Iris, Gain and Shutter Speed by VIVOTEK quality algorithm. "manual": Manually adjust with variable Shutter, Iris and Gain.
Page 216 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only available when "capability_image_c<0~(n-1)>_iristype "=piris piris_position 1~100 Manual set P-Iris. <product 1: Open <-> 100: Close dependent> * Only valid when "piris_mode"=manual or "capability_image_c<0~(n-1)>_sensor type" is "smartsensor"...
Page 217 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) ngain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". gainvalue 0~100 Gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_m...
Page 218 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) Bit 2 => Support pan operation; 0(not support), 1(support) Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 =>...
Page 219 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". maxexposure <1~32000>, Maximum exposure time <product <5~32000>, 1~32000 => 1s ~ 1/32000s dependent> <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>,...
Page 220 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 1)>_exposure_maxrange" exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s. * Only available when "capability_image_c<0~(n-1)>_exposu...
Page 221 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) the version number (httpversion) is equal or greater than 0302a. bracketing_lev 1~100 The total available lists  (capability_image_c<0~(n-1)>_ex posure_bracketing_range) will be normalized to 1~100 scale. For example, the total available ...
Page 222 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "capability_videoin_c<0~(n-1)>_smart fps_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. s<0~(m-1)>_h2 <boolean> Enable "Dynamic intra frame period".
Page 223 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 64_qpercent normalized full range. 1: Worst quality 100: Best quality * Only valid when "h264_ratecontrolmode"= vbr and "quant"= 100. s<0~(m-1)>_h2 20000~"capability_videoin The maximum allowed bit rate in fixed 64_maxvbrbitr _c<0~(n-1)>_h264_maxbit...
Page 224 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "h264_ratecontrolmode"= cbr s<0~(m-1)>_h2 1~"capability_videoin_c<0 The maximum frame rates of a H264 64_maxframe ~(n-1)>_h264_maxframera stream at different te" resolutions("capability_videoin_c<0~( n-1)>_resolution") are recorded in "capability_videoin_c<0~(n-1)>_h264 _maxframerate" s<0~(m-1)>_h2 Indicate H264 profiles...
Page 225 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) vbr: Fixed quality mode, all frames are 65_ratecontrol mode encoded in the same quality. * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_h2 1~5, Set the pre-defined quality level:...
Page 226 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) rate" When the bit rate exceeds this value, frames will be dropped to restrict the bit rate. * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "h265_ratecontrolmode"= vbr...
Page 227 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 65_prioritypoli * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "h265_ratecontrolmode"= cbr s<0~(m-1)>_h2 1~"capability_videoin_c<0 The maximum frame rates of a H265 65_maxframe ~(n-1)>_h265_maxframera stream at different te"...
Page 228 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 5: Excellent 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue" s<0~(m-1)>_mj 10~200 Manual video quality level input. The peg_qvalue (Only valid when Q value which is used by encoded "capability_api_httpversio...
Page 229 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only valid when "mjpeg_ratecontrolmode"= cbr. s<0~(m-1)>_mj 1~100 Select customized quality in a peg_cbr_qperc normalized full range. 1: Worst quality...
Page 230 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) wdrpro_mode 0, 1, 2 0: Disable WDR Pro. <product 1: Enable WDR Pro. dependent> * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode" = 1 2: Enable WDR Pro II.
Page 231 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 81~100: level 5 Level 1~4(low ~ high) The higher speed level meas shorter AE converged time during AE executing. * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1...
Page 232 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) s<0~(m-2)>_fis ‘1O, 1P, 2P, 1R, 4R’ for Local dewarp mode. heyedewarpm ceiling/floor mount “1O” is original mode (disable). ‘1O, 1P, 1R, 4R’ for wall Supported dewarp mode is different <product...
Page 233 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) display image. If the value is a positive number, the video quality of ROI is better than the non-ROI areas. The level is from 1 to 5. Level 5 is the maximum level of the quality difference between the ROI and non-ROI areas.
Page 234 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable this profile setting policy night, The mode which the profile is applied schedule <product dependent> * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a.
Page 235 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n- sensor generates a frame per 1)>_exposure_maxrange" exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.
Page 236 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <Not support * Not support this parameter anymore> anymore when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c<n>_mode" to switch on/off BLC.
Page 237 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n- and Shutter speed automatically. 1)>_exposure_modetype") "qualitypriority": Automatically adjust the Iris, Gain and Shutter Speed by VIVOTEK quality algorithm. "manual": Manually adjust with variable Shutter, Iris and Gain.
Page 238 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_wbmo de" !="-" rgain 0~100 Manual set rgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbmo de".
Page 239 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) mingain 0~100 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_mi ngain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range.
Page 240 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) or flicker effect in indoor environment. "indoor": Avoid rolling and flicker effect first. "manual": Manual set P-Iris by "piris_position". "-": not support (only available when "capability_image_c<0~(n-1)>_sensor type" is "smartsensor") * Only available when "capability_image_c<0~(n-1)>_iristype...
Page 241 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) _mode" = 1 2: Enable WDR Pro II. * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode" = 2 wdrpro_streng 1~100 The strength of WDR Pro. The bigger value means the stronger <product...
Page 242 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) executing. * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1 aespeed_sensi 1~100 The sensitivity of AE converge speed. tivity 1~20: level 1 <product 21~40: level 2 dependent> 41~60: level 3...
Page 243 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 1 ~ 255 Multicast video time to live value. 7.9 Time Shift Settings Group: timeshift for n channel products and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream"...
Page 244 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <Not day, * We replace this parameter with recommended to night, “ircutcontrol_c0_mode” when the use this> version number (httpversion) is equal schedule…etc or greater than 0312a. * Available values are...
Page 245 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) use this> dtime” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 246 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enablewled <boolean> Enable/disable built-in White led <Not * Only available when " recommended to capability_daynight_c<0~"capability_ use this> nvideoin"-1>_builtinwled > 0". * We replace this parameter with "ircutcontrol_illuminators_builtin_whi teled_enabled"...
Page 247 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) ensitivity_type=normalize * Only available when "capability_daynight_c<0~(n-1)> _ircutsensitivity_type" is not "-". * We replace this parameter with ircutcontrol_c<0~(n-1)>_sensitivity” when the version number (httpversion) is equal or greater than 0312a.
Page 248 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved (get/set) mode auto, Set IR cut control mode day, * We support this parameter when night, the version number (httpversion) is equal or greater than 0312a. schedule…etc * Available values are listed in "capability_daynig...
Page 249 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved There are two value format: "low,normal,high": if capability_daynight_c<0~(n-1)>_ircuts ensitivity_type=options "1~100": if capability_daynight_c<0~(n-1)>_ircuts ensitivity_type=normalize * Only available when "capability_daynight_c<0~(n-1)> _ircutsensitivity_type" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
Page 250 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved * We support this parameter when the version number (httpversion) is equal or greater than 0312a. external_do_enabled <boolean> Enable/disable external led mounted on do1 * Only available when "capability_daynight_illuminators_ext ernal_support > 0" and "do" is listed "capability_daynight_illuminators_ext...
Page 251 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved _spectrum_mode" 7.11 Image Setting per Channel Group: image_c<0~(n-1)> for n channel products and m profile n denotes the value of "capability_nvideoin" and m denotes the value of "capability_nvideoinprofile" NAME VALUE SECURITY DESCRIPTION...
Page 252 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) tting" is 1. * We replace "saturation" with "saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 253 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) sharpnesspercent 0~100 Set sharpness in the normalized range. 0: Softer <-> 100: Sharper * Only available when bit 3 of "capability_image_c<0~(n-1)>_basicse tting" is 1 gammacurve 0~100 0: Fine-turned gamma curve by <product...
Page 254 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) dnr_strength 1~100 Strength of 3DNR <product * Only available when dependent> "capability_image_c<0~(n-1)>_dnr" is defog_mode <boolean> Enable/disable defog mode. <product 0:disable dependent> 1:enable * Only available when "capability_image_c<0~(n-1)>_defog_ mode"...
Page 255 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) scene_mode visibility, Value of scene mode <product noiseless, * Only available when dependent> lpcparkinglot, "capability_image_c<0~(n-1)>_scene lpcstreet, mode_support" is 1 lpchighway, auto, deblur, lpcfreeway <product dependent> * Available values are listed in "capability_image_c<...
Page 256 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when "capability_image_c<0~(n-1)>_deinter lace_support" is 1. xoffset 0~100 Adjusting the image to proper position horizontally. * Only available when the bit 4 of capability_image_c<0~(n-1)>_basicset ting is 1.
Page 257 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) (httpversion) is equal or greater than 0301a. * "policy=night" is only available when "capability_daynight_c<0~(n-1)>_sup port > 0". profile_i<0~(m-1)> hh:mm Begin time of schedule mode. _begintime profile_i<0~(m-1)> hh:mm End time of schedule mode.
Page 258 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) _saturation saturation <Not 100: Use " recommended to image_c<0~(n-1)>_saturationpercent" use this> * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicse tting" is 1. * We replace "profile_i0_saturation" with "profile_i0_saturationpercent".
Page 259 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when bit 1 of "capability_image_c<0~(n-1)>_basicse tting" is 1 profile_i<0~(m-1)> 0~100 Set saturation in the normalized _saturationpercent range. 0: Less saturation <-> 100: More saturation * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicse...
Page 260 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) profile_i<0~(m-1)> <boolean> Enable/disable hightlight mask. _hlm * Only available when <product "capability_image_c<0~(n-1)>_hlm" is dependent> profile_i<0~(m-1)> <boolean> 3D noise reduction. _dnr_mode 0:disable <product 1:enable dependent> * Only available when "capability_image_c<0~(n-1)>_dnr"...
Page 261 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <product 1:enable dependent> * Only available when 'dis' is listed in "capability_image_c<0~(n-1)>_is_mod e". profile_i<0~(m-1)> 1~100 Strength of digital image stabilizer _dis_strength * Only available when 'dis' is listed in <product...
Page 262 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1 and when custom is listed in "capability_image_c<0~(n-1)>_exposure_winmode" and valid when "exposurewin_c<0~(n-1)>_mode"=custom or "exposurewin_c<0~(n-1)>_mode"=hlc) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the window. policy 0: Indicate exclusive.
Page 263 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when std is listed in "capability_image_c<0~(n-1)>_exposu re_windomain". sizestd <0~9999x0~9999> Width and height of the window. * Only available when std is listed in "capability_image_c<0~(n-1)>_exposu re_windomain".
Page 264 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1 and when custom is listed in "capability_image_c<0~(n-1)>_exposure_winmode" and valid when "exposurewin_c<0~(n-1)>_mode"=custom or "exposurewin_c<0~(n-1)>_mode"=hlc) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the window. policy 0: Indicate exclusive.
Page 265 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) homestd <0~9999,0~9999> Left-top corner coordinate of the window. * Only available when std is listed in "capability_image_c<0~(n-1)>_exposu re_windomain". sizestd <0~9999x0~9999> Width and height of the window. * Only available when std is listed in "capability_image_c<0~(n-1)>_exposu...
Page 266 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0: Minimum 100: Maximum * Only available when the channel supports internal microphone (The related bit of "capability_audio_intmic" is equal to volume_external 0~100 Volume when take external microphone as input source.
Page 267 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Reserved for compatibility, and suggest don't use this since the version number (httpversion) is equal or greater than 0301a. * We replace "boostmic" with "volume_internal" and "volume_external".
Page 268 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 32000, 40000 s0_g726_bitstreamp little, big Set G.726 bit streaming packing ackingmode mode. little: Little-endian bitstream format. big: Big-endian bitstream format. * Only available if G.726 is supported.
Page 269 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.13.1. Multicast Settings for Audio Streaming Group: audioin_c<0~(n-1)>_s0_multicast (capability_naudioin > 0 and capability_media_streamprofiles_support = 1) n denotes the value of "capability_naudioin" NAME VALUE SECURITY( DESCRIPTION get/set) ipaddress <ip address> Multicast audio IP address.
Page 270 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) record. 7.16 Motion Detection Settings Group: motion_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable motion detection.
Page 271 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0400a. polygonpx 0 ~ W,0 ~ H, 0 ~ W,0 Coordinate of polygon window <Not recommended ~ H, 0 ~ W,0 ~ H, 0 ~ position.
Page 272 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0 ~ 240 Top coordinate of window position. <Not recommended * Only available when to use this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain".
Page 273 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable profile 1 ~ (m-1). policy night, The mode which the profile is applied to. schedule * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a.
Page 274 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) to use this> "win_sensitivity". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. polygonpx 0 ~ W,0 ~ H, 0 ~ Coordinate of polygon window position.
Page 275 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) to use this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 276 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) threshold 0~100 Threshold of tamper detection. duration 10~600 If tampering value exceeds the "threshold" for more than "duration" second(s), then tamper detection is triggered. ignorewidth 0,<positive Indicate the width to offset to start to integer>...
Page 277 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the dynamic DNS. provider DyndnsDynamic, DyndnsDynamic => dyndns.org DyndnsCustom, (dynamic) Safe100 DyndnsCustom => dyndns.org Safe100 => safe100.net <provider>_hostnam string[128] Your DDNS hostname.
Page 278 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP port forwarding service. upnpnatstatus The status of UPnP port forwarding, used internally. 0 = OK, 1 = FAIL, 2 = no IGD router, 3 = no need for port forwarding 7.22 System Log...
Page 279 <boolean> 0 => Custom logo 1 => Default logo logo_link string[128] Hyperlink of the logo http://www.vivot ek.com logo_powerbyvvtk_hidd <boolean> 0 => display the power by vivotek logo 1 => hide the power by vivotek logo User's Manual - 279...
Page 280 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) custombutton_manualtr <boolean> Show or hide manual trigger (VI) igger_show button in homepage 0 -> Hidden 1 -> Visible theme_option 1~3: One of the default themes. 4: Custom definition.
Page 281 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) equal or greater than 0314b. defaultpassword_length 8 ~ 64 Allowed password length. * We support this parameter when the version number (httpversion) is equal or greater than 0314b.
Page 282 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.25 Privacy Mask Group: privacymask_c<0~(n-1)> for n channel products and m privacy mask window. n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean>...
Page 283 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0 ~ W,0 ~ H, (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 0 ~ W,0 ~ H * Only available when W: 0~ The "capability_image_c<0~(n-1)>_privacy current image mask_wintype" = polygon. width -1...
Page 284 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) buildinpt" is "1" win_i<0~(m-1)>_tilt "capability_ptz_c<0~(n-1) Tilt position of window position. >_mintilt" ~ * Only available when bit1 of "capability_ptz_c<0~(n-1) "capability_camctrl_c<0~(n-1)>_ >_maxtilt" buildinpt" is "1" win_i<0~(m-1)>_zoom "capability_ptz_c<0~(n-1) Zoom position of window >_minzoom"...
Page 285 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) interfaces. Revision Increase the revision when fix bugs without change any features of the output. _platform This is a constant, it is used to distinguish between different...
Page 286 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) nvideoin"-1>_externalir for external * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. npir Number of PIRs. <positive integer> Number of digital inputs.
Page 287 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) nmotion <positive integer> The number of motion window. nmotionprofile 0, <positive integer> Number of motion profiles. nevent 0, <positive integer> Number of event. * We support this parameter when the version number (httpversion) is equal or greater than 0311c.
Page 288 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) server series) Bit 6 => (only available when bit0 is 1) Reserved bit; always 0. Bit 7 => (only available when bit0 is 1) External or built-in PT;...
Page 289 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) presettourdirection <boolean> Indicate whether to support preset tour direction function. It means users can choose which direction the preset tour goes. * We support this parameter when the version number (httpversion) is equal or greater than 0307a.
Page 290 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) channel. For some dual-stream products, both streams support ePTZ. nanystream 0, <positive integer> number of any media stream per channel <boolean> Indicate whether to support Intelligent Video analysis whitelight <boolean>...
Page 291 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "tampering" = Tamper detection. "vi" = Virtual input (Manual trigger) "vadp" = VADP trigger. "di"= Digital input. "volalarm" = Audio detection. "temperature" = Temperature detection. "pir" = PIR detection.
Page 292 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) protocol_rtp_multi <boolean> Indicate whether to support scalable cast_scalable multicast. protocol_rtp_multi <boolean> Indicate whether to support cast_backchannel backchannel multicast. protocol_rtp_tcp <boolean> Indicate whether to support RTP over TCP.
Page 293 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 1 => Progressive CCD 2 => CMOS videoin_nresolutio <positive integer> This equals "capability_videoin_c0_nresolution". * This is kept for compatibility. videoin_resolution A list of <WxH> This equals <product dependent>...
Page 294 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) by commas <product dependent> timeshift <boolean> Indicate whether to support time shift caching stream. audio_aec <boolean> Indicate whether to support acoustic echo cancellation. audio_aecmode auto, Indicate the acoustic echo manual cancellation control mode.
Page 295 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6"...
Page 296 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0: Not support 1: Support Bit 0 for CH0, bit 1 for CH1, and so on. audio_alarm <0~Positive Integer> 0: Not support audio alarm. 1: Support audio alarm.
Page 297 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "g726": G.726 "-": Not supported. audioout_codec g711, - Available codec list for SIP. <product dependent> "-": Not supported. motion_wintype rectangle, polygon,- The supported motion window type. "polygon": The window is a 2D polygon shape.
Page 298 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) e_autotracking stream is supported. * Only available when "capability_smartstream_support" is 1 smartstream_mod <boolean> Indicate whether manual smart e_manual stream is supported. * Only available when "capability_smartstream_support" is 1 smartstream_mod <boolean>...
Page 299 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Bit 7 => Support digital signature of package Bit 8 => Support snapshot Bit 9 => Support upload encrypted package vadp_npackage <positive integer> Indicate the maximum number of VADP package that can be uploaded to the device.
Page 300 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) tunnel for UART transfer. transmission_mod Indicate transmission mode of the machine: TX = server, Rx = receiver Both box, Both = DVR. network_wire <boolean> Indicate whether to support Ethernet.
Page 301 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) equal or greater than 0305a. wireless_apmode_ <string> Indicate the prefix of broadcasted ssidprefix SSID when camera is in wireless AP mode. * Only available when "capability_wireless_apmode_enable" is "1".
Page 302 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) media_videoclip_ <positive integer> Maximum length (second) of a maxlength videoclip. media_videoclip_ <positive integer> Maximum duration (second) after maxpreevent event occurred in a videoclip. media_streamprofi <boolean> Indicates support of stream profile les_support feature.
Page 303 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) localstorage_mana <boolean> Indicate whether manageable local geable storage is supported. * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_seaml Indicate whether seamless recording <positive integer>...
Page 304 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) than 0, it means that the camera supports edge recording function. bit 0 : It supports to record directly to an on-board SD-Card. bit 1~: Currently, they are reserved bit, and the default value is 0.
Page 305 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when "capability_fisheye" > 0 shockalarm_suppo <boolean> Indicate whether to support the shock detection. * We support this parameter when the version number (httpversion) is equal or greater than 0306e.
Page 306 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0314b. 7.27.1 Capability for Camctrl Group: capability_camctrl_c<0~(n-1)> n denotes the value of "capability_nvideoin" (capability_ptzenabled > 0) * We support this group when the version number (httpversion) is equal or greater than 0303b.
Page 307 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) zoommodule <boolean> Indicate whether to support zoom lens. In our product, only SD series and IZ series use the zoom lens. * Both varifocal and zoom lenses are...
Page 308 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.27.2 Capability for PTZ Group: capability_ptz_c<0~(n-1)> n denotes the value of "capability_nvideoin" (capability_ptzenabled > 0 and capability_camctrl_c<0~(n-1)>_zoommodule !=0) * We support this group when the version number (httpversion) is equal or greater than 0303b.
Page 309 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxtilt 0, <positive integer> 0/7 The upper limit for tilt position. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" mintiltangle <integer> The lower limit for tilt angle.
Page 310 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) minfocus 0, <positive integer> 0/7 The lower limit for focus position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoomm odule" is "1" maxfocus 0, <positive integer> 0/7 The upper limit for focus position.
Page 311 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) externalir <boolean> Indicate whether to support external IR led. * We replaced this parameter with “capability_daynight_illuminators_exter nal_support” when the version number (httpversion) is equal or greater than 0312a.
Page 312 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) ircutsensitivity_type <string> Indicate the cgi interface of "ircutcontrol_sensitivity". "options": the value of "ircutcontrol_sensitivity" parameter is "low, normal,high". "normalize": the value of "ircutcontrol_sensitivity" parameter is "1~100" "-":not support * Only available when "capability_daynight_c<0~(n-1)>_suppo...
Page 313 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) spectrum_support <boolean> Indicate whether to support proposed a brightness enhancement method based on CCM(Color Correction Matrix) model to improve the brightness effect of the images if the IR and blue light exists.
Page 314 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mode auto,daynight,di,di2, Indicate the day / night switch mode. di3,di4,schedule,- "auto": The Camera automatically <product judges the current operation mode by dependent> the level of ambient light detected.
Page 315 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved optimizedir <boolean> Indicate whether to support optimized IR control technology. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. builtin_support <boolean> Indicate whether to support built-in led.
Page 316 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved spectrum_support <boolean> Indicate whether to support proposed a brightness enhancement method based on CCM(Color Correction Matrix) model to improve the brightness effect of the images if the IR and blue light exists.
Page 317 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved device sd, nas Indicate the supported storage devices. <product * Only available when dependent> "capability_storage_dbenabled" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
Page 318 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) color_support <boolean> 1 : camera can select to display color or black/white video streams. 0: camera do not support this feature. * We support this parameter when the version number (httpversion) is equal or greater than 0310a.
Page 319 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) rotationaffect When rotation is enabled, some features <product may become malfunction or be forced to a dependent> given value. The affected functions are list here. The format is "Affect API name":"Policy":"Description"...
Page 320 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) rotationangle <string> The different angles which camera supports for rotation. * Only avaliable when "capability_videoin_c<0~(n-1)>_rotation" is * We support this parameter when the version number (httpversion) is equal or greater than 0309b.
Page 321 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) resolution A list of <WxH> Resolution options in current video mode. <product These options are the possible options for dependent> "videoin_c<n>_s<m>_resolution". The last one is the maximum resolution in current mode.
Page 322 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mjpeg_maxframerate A list of <Positive Maximum fps that the device can encoded Integer> and "-" with MJPEG on resolutions in current video mode. "-" means not support.
Page 323 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) h264_maxbitrate <positive integer> 0/7 Maximum bitrates of H.264. The unit is bps. * Only available when 'h264' is listed in "capability_videoin_codec". h264_profile baseline,main,hig Indicate H264 profiles * Only available when 'h264' is listed in "capability_videoin_codec".
Page 324 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) fisheye_mounttype ceiling, wall, floor Indicate the supported type. <Not recommended <product wall mount: 180° panoramic view to use this> dependent> ceiling mount: 360° surround view without blind spots floor mount: 360°...
Page 325 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) cameraunit_name CU8131, A "camera unit" name of a split-type camera CU8171, system, which the camera unit and the CU8161-H, video core are separated. CU8162-H, -: If the camera is not a split-type camera CU8163-H, system, the value of this parameter is "-".
Page 326 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) typewallmount 1O, 1P, 1R, 4R Available dewarp types of wall mount. resolutionC1P A list of <WxH> Available resolutions of 1P mode of ceiling and floor mount. resolutionC2P A list of <WxH>...
Page 327 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) eptz 0, <positive integer> 0/7 Indicate this mode whether support eptz. For "nvideoin" = 1, the definition is as following: A 32-bits integer, each bit can be set separately as follows: Bit 0 =>...
Page 328 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) outputsize <WxH> The output size of source, equal to the captured size by device, in this video mode. The unit is pixel. This value is used as a basic coordinate system for many features, like ePTZ, privacy mask, motion, etc.
Page 329 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) minresolution A list of <Integer> Represent supported minimum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream". * We support this parameter when the version number (httpversion) is equal or greater than 0304b.
Page 330 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxfps_h264 A list of <Positive Maximum fps which the device can Integer> and "-" encoded with H.264 on resolutions in this video mode. "-" means not support.
Page 331 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Bit 0 => Supports Brightness or not. Bit 1 => Supports Contrast or not. Bit 2 => Supports Saturation or not. Bit 3 => Supports Sharpness or not.
Page 332 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) :fixed:auto, be forced to a given value. The exposurelevel:hidd affected functions are list here. en:, The format is "Affect API exposurelevel:fixed name":"Policy":"Description" :<x>, "Policy" can be categorized into...
Page 333 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * When "wdrpro"=0, this value must be "-" wdrpro_description <string> Description about WDR Pro mode. * Only available when "capability_image_c<0~(n-1)>_wdrpro _mode" > 0 wdrc_mode 0, 1 0: Non-support WDR Enhanced...
Page 334 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. For example: "exposurelevel:fixed:6/8/12" which means exposurelevel is fixed to level 6, level 8 and level 12.
Page 335 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "-": not support * We support this parameter when the version number (httpversion) is equal or greater than 0302a. is_strength <boolean> 0: Non-support tuning strength of image stabilizer mode.
Page 336 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked.
Page 337 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) wbmode auto, Available white balance mode. panorama, "-" means white balance is not manual, supported. rbgain, widerange, outdoor,indoor, sodiumauto, <product dependent> iristype piris, Indicate iris type. dciris, "piris": P-Iris...
Page 338 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) constant value. "twovalues": Need two parameters to indicate the exposure range. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 339 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_ exposure_mode" is 1 and "capability_image_c<0~(n-1)>_exposu re_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_automode_ When exposure auto mode is affect exposurewin.mode...
Page 340 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when auto is listed in "capability_image_c<0~(n-1)>_...
Page 341 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6.
Page 342 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:"...
Page 343 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) dependent> before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values.
Page 344 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) en:, name":"Policy":"Description" icrmode.auto:nots "Policy" can be categorized into upport: following groups: or others - (disabled) : UI turns grey and users <x>: nonnegative can't select it. integer - (unchanged) : UI keeps the status as <product...
Page 345 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "0,12" "videoin_c<0~(n-1)>_exposurelevel" * When "exposure_mode"=0, this value must be set to "-". * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_winmode auto, Available options for custom, "exposurewin_c<0~(n-1)>_mode"...
Page 346 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value.
Page 347 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) window is omitted by exposure control. "-": Not supported. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_windomain qvga, px, std, - The domain to set an exposure window.
Page 348 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0301a. exposure_maxrange "1,32000", Available range for "1,8000", "videoin_c<n>_maxexposure"...
Page 349 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) two or more exposures but with different exposure values. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0310a.
Page 350 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "-" "videoin_c<n>_maxgain" “0,100” => 0~100 percent "-" means "videoin_c<n>_maxgain" is not available. agc_mingain "0,100", Available range for "-" "videoin_c<n>_mingain" “0,100” => 0~100 percent "-" means "videoin_c<n>_mingain" is not available.
Page 351 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL.
Page 352 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:"...
Page 353 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 1: Support low light mode focusassist 0: Non-support focus assist 1: Support focus assist remotefocus 0,<positive An 4-bit integer, which indicates the integer> supportive application of remotefocus in this channel.
Page 354 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * We support this parameter when the version number (httpversion) is equal or greater than 0302a. autotrack_support <boolean> 0: Non-support auto tracking feature 1: Support auto tracking feature...
Page 355 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_lens_al ignment" is 1. lens_ldc_support <boolean> Indicate whether to support lens distortion correction function. * We support this parameter when the version number (httpversion) is equal or greater than 0309d.
Page 356 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.28 Event Setting Group: event_i<0~(n-1)> n denotes the value of "capability_nevent" (capability_nevent > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. enable 0, 1 Enable or disable this event.
Page 357 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) 0,<positive Indicate the source id of di trigger. integer> This field is required when trigger condition is “di”. One bit represents one digital input. The LSB indicates DI 0.
Page 358 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) valevel0 Select audio detection profile event. 0: not select 1: select inter 1~999 Interval of snapshots in minutes. This field is used when trigger condition is “seq”.
Page 359 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_cf_folder string[128] Path to store media. <Not recommended to * Only available when use this> "capability_supportsd" > 0 foldername string[128] Path to store media. * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
Page 360 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_goto_sync <boolean> Capture media after moving to the <product dependent> location. * Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0, or capability_camctrl_c0_zoommodule >...
Page 361 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.29 Server Setting for Event Action Group: server_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry type email, Indicate the server type: ftp, “email” = email server http, “ftp” = FTP server “http”...
Page 362 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) ns_location string[128] Location to upload or store the media. * For httpversion is equal or greater than 0312a: The media storage path format is “\<mac address>\date\hour”. (Only available when “nas”...
Page 363 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved fingerprint_enable boolean Verify server fingerprint to avoid connect to fake server. fingerprint_content string[128] Server fingerprint(MD5). You can get it by calculate server host key(public) md5. publickey_pairmode auto, "autopair": Autopair mode is selected download, for this event server.
Page 364 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) snapshot_channel 0~"capability_nvideoin"-1 Indicate the source of media channel. 0 means the first channel. 1 means the second channel. 2 means the third channel. 3 means the fourth channel.
Page 365 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) videoclip_channel 0~"capability_nvideoin"-1 Indicate the source of media channel. 0 means the first channel. 1 means the second channel. 2 means the third channel. 3 means the fourth channel.
Page 366 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.31 Recording Group: recording_i<0~(n-1)> n denotes the value of "capability_nrecording" (capability_nrecording > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. trigger schedule, The event trigger type networkfail schedule: The event is triggered by...
Page 367 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxretentiontime <string> To specify the expired time for automatic clean up, and it only takes effect for video clip generated by recording_i <0~1>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss] S’...
Page 368 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) weekday 0~127 Indicate which weekday is scheduled. One bit represents one weekday. bit0 (LSB) = Saturday bit1 = Friday bit2 = Thursday bit3 = Wednesday bit4 = Tuesday...
Page 369 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) adaptive_enable <boolean> Indicate whether the adaptive recording is enabled adaptive_preevent 0~9 Indicate when is the adaptive recording started before the event trigger point (seconds) adaptive_postevent 0~10 Indicate when is the adaptive recording...
Page 370 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) stateorprovincen string[128] State or province name in the certificate information. localityname string[128] The locality name in thecertificate information. organizationname string[64] Organization name in the certificate VIVOTEK Inc.
Page 371 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) autocleanup_mode targetbase, Specify the automatic clean up method sourcebase for storage devices, where “targetbase” indicate the automatic clean up is based on the attached devices such as nas or sd card, whereas “sourcebase”...
Page 372 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.34 Region of Interest Group: roi_c<0~(n-1)> for n channel product and m is the index of video stream which support ePTZ. (capability_eptz > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-1)>_home <W,H> ROI left-top corner coordinate.* If the <product...
Page 373 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) tiltspeed -5 ~ 5 Tilt speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.) panspeed -5 ~ 5 Pan speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.)
Page 374 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) preset_i<0~19>_size <WxH> Width and height of the preset. <product (It should be set by ePreset.cgi rather dependent> than by setparam.cgi.) 7.36 Focus Window Setting Group: focuswindow_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin".
Page 375 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) diskmode seamless, “seamless” indicates enable seamless manageable recording. “manageable” indicates disable seamless recording. * We replace this parameter with “seamlessrecording_c<0~(n-1)>_diskmode” when the version number (httpversion) is equal or greater than 0312a.
Page 376 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) guid<0~2>_id string[127] The connected seamless streaming ID. (Read only) * We replace this parameter with “seamlessrecording_c<0~(n-1)>_guid<0~2>_i d” when the version number (httpversion) is equal or greater than 0312a.
Page 377 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved diskmode seamless, “seamless” indicates enable seamless manageable recording. “manageable” indicates disable seamless recording. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. maxconnection Maximum number of connected seamless streaming.
Page 378 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.38 VIVOTEK Application Development Platform Setting Group: vadp NAME VALUE SECURITY DESCRIPTION (get/set) version <string> Indicate the VADP version. resource_total_memory 0,<positive Indicate total available memory size integer> for VADP modules. resource_total_storage 0,<positive Indicate total size of the internal integer>...
Page 379 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Maximum of n=10 hyperlink is supported. NAME VALUE SECURITY DESCRIPTION (get/set) moduleidx 0,<positive Refer to the package index. integer> title string[40] Name of the vadp hyperlink. string[120] The URL address of vadp hyperlink.
Page 380 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) initscr string[40] The script that will handle operation commands from the system. status string[40] Indicate the running status of the module. statmsg string[128] Indicate the message that will be show on the running status when mouse over.
Page 381 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.39 Camera PTZ Control Group: camctrl (capability_camctrl_ptztunnel > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enableptztunnel <boolean> Enable PTZ tunnel for camera control. Group: camctrl_c<0~(n-1)> for n channel products (capability_ptzenabled > 0) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset"...
Page 382 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) driver. 2: enable PTZ commands with UART tunnel. * only available when capability_camctrl_c0_rs485=2 disablemdonptz <boolean> Disable motion detection on PTZ operation. 7.40 Camera PTZ Control (IZ Series) Group: camctrl_c<0~(n-1)>...
Page 383 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) nual * Available values are listed in "capability_cam ctrl_c<0~(n-1)> _focusmode" uart Select corresponding uart "capability_nua (capability_nuart>0). rt"-1 * only available when capability_camctrl_c0_rs485=2 isptz 0 ~ 2 0: disable PTZ commands.
Page 384 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) setting fixcurrent essential and should be grouped with “preset_i<0~(k-1)>_name.” * We support this parameter when the version number (httpversion) is equal or greater than 0305b. patrolseq string[120]...
Page 385 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) should be taken while idle. idleaction_interval 1~999 While idle over this time interval, idle action will be taken. PTZ C LEASE REFER TO ONTROL 7.41 Camera PTZ Control (SD Series) Group: camctrl_c<0~(n-1)>...
Page 386 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Available values are listed in "capability_camctrl_c <0~(n-1)>_focusmod e" preset_i<0~(k-1)>_name string[40] Name of the preset location. preset_i<0~(k-1)>_pan capability_ptz_c<0~( Pan position at each preset n-1)>_minpan ~ location. capability_ptz_c<0~( n-1)>_maxpan...
Page 387 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) disablemdonptz <boolean> Disable motion detection on PTZ operation. defaulthome <boolean> This field tells system to use default home position or not. axisx capability_ptz_c<0~( Custom home pan position.
Page 388 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Set -1 to disable all the tour groups. tour_i<0~19>_name string[40] Name of the tour. tour_i<0~19>_type <boolean> 0 = Recorded tour 1 = Preset tour tour_i<0~19>_speed -5 ~ 5 Preset tour: pan and tilt speed when moving between presets.
Page 389 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Group: uart (capability_nuart > 0 and capability_fisheye = 0) NAME VALUE SECURITY DESCRIPTION (get/set) ptzdrivers_i<0~19, string[40] Name of the PTZ driver. 127>_name ptzdrivers_i<0~19, string[128] Full path of the PTZ driver. 127>_location enablehttptunnel <boolean>...
Page 390 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) speedlink_i<0~4>_c string[40] Additional PTZ command list. * only available when capability_camctrl_c0_rs485=2 ptzdriver 0~19, The PTZ driver is used by this COM 127 (custom), port. 128 (no driver)
Page 391 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "1": One stop bit is transmitted to stopbit indicate the end of a byte. "2": Two stop bits are transmitted to indicate the end of a byte.
Page 392 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Group: lens_default_i<0~(n-1)> n denotes the value of "lens_default_totalnumbers" NAME VALUE SECURITY DESCRIPTION (get/set) name <string> Default lens name Group: lens_user_i<0~(n-1)> n denotes the value of "lens_user_totalnumbers" NAME VALUE SECURITY DESCRIPTION (get/set) name <string>...
Page 393 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) s<0~(m-2)>_region_t -90~90 Tilt home angle of regional view (for 1R mode) Tilt range of ceiling/floor mount is [0~90]. Tilt range of wall mount is [-90~90]. s<0~(m-2)>_region_ 100~300...
Page 394 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) objsize_type -1~2 Type of object size. -1 : customized width and height 0 : object size = 30 x 30 1 : object size = 10 x 20...
Page 395 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) encrypt none, Encryption method: wep, none: NONE, wpa, wep: WEP, wpa2 wpa: WPA, wpa2: WPA2PSK authmode OPEN, SHARED Authentication mode. * Only valid when "wireless_encrypt" is "wep"...
Page 396 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.50 Shock Detection Group: shock_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" (capability_shockalarm_support > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) alarm_enable <boolean> Enable shock detection's alarm. alarm_level 1~100 The value indicate the support strength level of shock detection's alarm.
Page 397 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) videoconfiguration_so c<0~(n-1)>s<0~(m-1) The videoconfiguration source for the urce > profile. Ex. videoconfiguration_source= * n denotes the value c<0~(n-1)>s<0~(m-1)> indicates video stream of channel n stream m is “capability_nvideoin,...
Page 398 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Group: metadata_c<0~(n-1)>_s0_multicast (capability_media_streamprofiles_support = 1) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY( DESCRIPTION get/set) ipaddress <ip address> Multicast metadata IP address. port 1025 ~ 65535 Multicast metadata port. ipversion IPv4, IPv6 The version of internet protocol.
Page 399 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8. Useful Functions 8.1 Drive the Digital Output (capability_ndo > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/setdo.cgi?do1=<value> [&do2=<value>] [&do3=<value>][&do4=<value>] Where state is 0 or 1; “0” means inactive or normal state, while “1” means active or triggered state, and trigger time is indicated in seconds.
Page 400 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <length>\r\n \r\n [di0=<state>]\r\n [di1=<state>]\r\n [di2=<state>]\r\n [di3=<state>]\r\n where <state> can be 0 or 1. Example: Query the status of digital input 1 . Request: http://myserver/cgi-bin/dido/getdi.cgi?di1 Response: HTTP/1.0 200 OK\r\n...
Page 401 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved [do1=<state>]\r\n [do2=<state>]\r\n [do3=<state>]\r\n where <state> can be 0 or 1. Example: Query the status of digital output 1. Request: http://myserver/cgi-bin/dido/getdo.cgi?do1 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n do1=1\r\n 8.4 Capture Single Snapshot Note: This request requires Normal User privileges.
Page 402 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION quality The quality of the image. streamid 0~( capability_nmediastream -1) The stream number. Default: Returns snapshot of maxmum resolution for current channel. The server will return the most up-to-date snapshot of the selected channel and stream in JPEG format.
Page 403 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION username <name> The name of the user to add, delete, or edit. userpass <value> The password of the new user to add or that of the old user to modify. The default value is an empty string.
Page 404 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved ERROR: Update user's privilege fail! 8.6 Upgrade Firmware Note: This request requires Administrator privileges. Method: POST Syntax: http://<servername>/cgi-bin/admin/upgrade.cgi Post data: fimage=<file name>[&return=<return page>]\r\n \r\n <multipart encoded form data> Server will accept the file named <file name> to upgradethe firmware and return with <return page>...
Page 405 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.7 ePTZ Camera Control (capability_eptz > 0 and Capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eCamCtrl.cgi?channel=<value>&stream=<value> [&move=<value>] – Move home, up, down, left, right [&auto=<value>] – Auto pan, patrol [&zoom=<value>] –Zoom in, out...
Page 406 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved b. continuous movement - If you trigger a continuous movement, you have to handle the stop time by yourself. A continuous movement is convenient to integrate a joystick control. http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=tele&zs=1 http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed.
Page 407 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION <integer> movement <integer> The scaled area size <integer> resolution <window size> The resolution of streaming. <integer> The direction of movement, used for joystick control. <integer> 0 ~ 7 Set the speed of movement, “0” means stop.
Page 408 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.8 ePTZ Recall (capability_eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eRecall.cgi?channel=<value>&stream=<value>& recall=<value>[&return=<return page>] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source.
Page 409 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION addpos <Text string less than Add one preset location to the preset list. 40 characters> delpos <Text string less than Delete preset location from the preset list. 40 characters>...
Page 410 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Syntax: http://<servername>/cgi-bin/operator/uartchannel.cgi?[channel=<value>] ------------------------------------------------------------------------- GET /cgi-bin/operator/uartchannel.cgi?[channel=<value>] x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------- POST /cgi-bin/operator/uartchannel.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache cache-control : no-cache content-length: 32767 expires: Sun, 9 Jam 1972 00:00:00 GMT User must use GET and POST to establish two channels for downstream and upstream.
Page 411 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved ------------------------------------------------------------------------- GET /cgi-bin/admin/ctrlevent.cgi x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------- POST /cgi-bin/admin/ ctrlevent.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache cache-control : no-cache content-length: 32767 expires: Sun, 9 Jam 1972 00:00:00 GMT User must use GET and POST to establish two channels for downstream and upstream.
Page 412 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved network_rtsp_s2_accessname = live2s1.sdp network_rtsp_s3_accessname = live2s2.sdp etc. * Note: RTSP access name format is modified to “live<n>s<m>.sdp” after version number(httpversion) is 0311c. Please refer to the “subgroup of network: rtsp” for setting the accessname of SDP.
Page 413 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved data <hex decimal The <hex decimal data> is a series of digits from 0 ~ 9, A ~ data>[,<hex decimal F. Each comma separates the commands by 200 data>] milliseconds. flush yes,no yes: Receive data buffer of the COM port will be cleared before read.
Page 414 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Command: search PARAMETER VALUE DESCRIPTION label <integer primary key> Optional. The integer primary key column will automatically be assigned a unique integer. triggerType <text> Optional. Indicate the event trigger type. Please embrace your input value with single quotes.
Page 415 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION limit <positive integer> Optional. Limit the maximum number of returned search records. offset <positive integer> Optional. Specifies how many rows to skip at the beginning of the matched records.
Page 416 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION state while “1” means Ex: vi0=0(200)1 active or triggered state. Setting virtual input 0 to normal state, waiting 200 milliseconds, setting it to trigger state. Where "nstate" is next state after duration.
Page 417 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http://<servername>/<network_http_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&reft ime=<value>&forcechk&minsft=<value>] For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player. rtsp://<servername>/<network_rtsp_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&refti me=<value>&forcechk&minsft=<value>] “n” is the channel index. “m” is the timeshift stream index.
Page 418 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Return Code Description 400 Bad Request Request is rejected because some parameter values are illegal. 415 Unsupported Media Type Returned, if forcechk appears,when minsft is not achievable or the timeshift feature of the target stream is not enabled.
Page 419 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION position <motor_start> ~ Motor’s position. <motor_end> It works only if function=zoom or function= focus and direction=direct. <motor_start> : remote_focus_zoom_motor_start or remote_focus_focus_motor_start, <motor_end> : remote_focus_zoom_motor_end or remote_focus_focus_motor_end replied from "function=getstatus"...
Page 420 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved function getstatus Information of motors, return value as below: remote_focus_zoom_motor_max: Maximum steps of zoom motor remote_focus_focus_motor_max: Maximum steps of focus motor remote_focus_zoom_motor_start: Start point of zoom motor remote_focus_zoom_motor_end: End point of zoom motor...
Page 421 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function focus, focus – Move focus motor auto – Perform auto focus auto, scan, scan – Perform focus scan stop, stop – Stop current operation positioning, positioning – Position the motors resetfocus –...
Page 422 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved function getstatus Information of motors, return value as below: remote_focus_focus_motor_max: Maximum steps of focus motor remote_focus_focus_motor_start: Start point of effective focal length remote_focus_focus_motor_end: End point of effective focal length remote_focus_focus_motor: Current position of focus...
Page 423 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved currentlanguage 0~20 Available language lists. Please refer to: system_info_language_i0 ~ system_info_language_i19 For setting backup file: http://<servername>/cgi-bin/admin/export_backup.cgi?backup 8.22 Upload Files Note: This request requires Administrator privileges. Method: POST Syntax: For daylight saving time configuration file: * This CGI is not supported when the version number (httpversion) is equal or greater than 0314b, please use “system_tz”...
Page 424 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Server will accept the file named <file name> to upload this one to camera. 8.23 Update Lens Configuration (capability_image_c<0~(n-1)>_lensconfiguration_support > 0) Note: This request requires Administrator privileges. Method: GET Syntax: For list a name of lens currently used: http://<servername>/cgi-bin/admin/update_lens.cgi?get_currentlens...
Page 425 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved For upload user-defined lens configuration: http://<servername>/cgi-bin/admin/update_lens.cgi?upload_lens Post data: upload_lens_profile_input = <file name>\r\n \r\n <multipart encoded form data> Server will accept the file named <file name> to upload the lens profile to camera.
Page 426 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Play recordings for length seconds which ends at etime rtsp://10.10.1.2/mod.sdp?etime=20110312_040400.000&length=120 Play file file rtsp://10.10.1.2/mod.sdp?filename=/mnt/link0/ 426 - User's Manual...
Page 427 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.25 3D Privacy Mask (Capability_image_c<0~(n-1)>_privacymask_wintype = 3Drectangle) n denotes the value of "capability_nvideoin" Note: This request requires admin user privilege Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/setpm3d.cgi?method=<value>&maskname=<value>&[maskhei ght=<value>&maskwidth=<value>&videosize=<value>&return=<return page>] PARAMETER VALUE DESCRIPTION method Add a 3D privacy mask at current location...
Page 428 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.26 Camera Control (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/camctrl/camctrl.cgi?[channel=<value>][&camid=<value>] [&move=<value>] – Move home, up, down, left, right [&focus=<value>] – Focus operation [&zoom=<value>] – Zoom in, out [&zooming=<value>&zs=<value>] –...
Page 429 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION down Move camera down. left Move camera left. right Move camera right. speedpan -5 ~ 5 Set the pan speed. speedtilt -5 ~ 5 Set the tilt speed. speedzoom -5 ~ 5 Set the zoom speed.
Page 430 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION focus auto Auto focus. Focus on further distance. near Focus on closer distance. focusseting sync Applies the selected focus mode in camctrl_c<0~(n-1)>_focusmode to this preset. fixcurrent Applies the current focus position to this preset.
Page 431 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION getpanangle <integer> Get the current pan angle. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" gettilt 0, <positive integer> Get the current tilt position. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt"...
Page 432 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmintiltangle <integer> Get the lower limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmaxtiltangle <integer> Get the upper limit for tilt angle.
Page 433 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.28 Preset Locations (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/preset.cgi?[channel=<value>] [&addpos=<value>][&delpos=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION addpos string[30] Add one preset location to the preset list. channel 0~"capability_nvideoin"-1 Channel of the video source.
Page 434 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function getstatus Function type getstauts : Information of smartSD internal status return value as below: smartsd_lifetime_num: Accumulated amount of data that has been written smartsd_lifetime_den: Card-guaranteed amount of data that can be written...
Page 435 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Syntax: http://<servername>/cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION Apply the wireless settings and connect to AP. 8.31 Get Wireless Information (capability_network_wireless > Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/getwirelessinfo.cgi PARAMETER VALUE DESCRIPTION Get wireless information.
Page 436 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION Get wireless signal strength. 8.33 WPS Transaction (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/start_wps.cgi PARAMETER VALUE DESCRIPTION Start WPS transaction. 8.34 Peripheral Control (capability_peripheral_c<0~(n-1)>_...
Page 437 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved "washer_mode : OK\r\n" "washer_status : FAIL\r\n" PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. washer_mode wiper Apply the wiper to the mode of washer control system. washer Apply the washer to the mode of washer control system.
Page 438 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Pragma: no-cache\r\n \r\n supportdevice=washer,heater\r\n washer_status=off\r\n PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. supportdevice Get support peripheral device. washer_supportmode N/A Get the support mode of washer control system. washer_mode Get the current mode of washer control system.
Page 439 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.35 Optimized IR control (capability_daynight_c<0~(n-1)>_optimizedir > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/optimizedir.cgi?function=<value>[&channel=<value>] PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. function getstatus, "onetimeauto": Camera will automatically adjust the IR onetimeauto zone one time only.
Page 440 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http://myserver/cgi-bin/admin/optimizedir.cgi?function=getstatus Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irmode='auto'" "optimizedir_c0_irnum='5'" "optimizedir_c0_irstrength='1,97,100,100,100'" "optimizedir_c0_irstatus='normal'" Syntax: (for control API) http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=<value>&irmode= manual[&strength=<value>] – Set IR strength PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source.
Page 441 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=settoall&irmode=manual&str ength=100 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irstrength='100,100,100,100,100'" "optimizedir_c0_irmode='manual'" Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&irmode=auto&strength= 50,70,50,50,50 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: Parameter "irmode" must be set as "manual"! Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&strength=50,70,50,50,50...
Page 442 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=get [&support_irmode] – list all adjustment mode that IR supports [&irmode] – Get current IR mode [&irnum] – Get the number of IR zone PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source.
Page 443 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved \r\n Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: time out Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: fail PARAMETER VALUE DESCRIPTION action shuttercompensate Camera will do shutter compensate.
Page 444 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n version=1120B15 8.37 Audio Clip Control (capability_audio_audioclip=1) Note: This request requires Administrator privileges. Method: GET/POST (for control API) Syntax: http://<servername>/cgi-bin/admin/audioclip.cgi?operation=<value>[&name=<value>][&index=<value>] PARAMETER VALUE DESCRIPTION operation startrecording, "startrecording"...
Page 445 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved clipname <string> Name of the audio clip. clipindex 0, 1 Number of the audio clip. 8.38 Format SD card Note: This request requires Administrator privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/admin/format_sdcard.cgi?operation=set[&<parameter>=<value>] If the user requests a size larger than all stream settings on the server, this request will fail.
Page 446 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Response of formatting fail: HTTP/1.1 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <Error Message Length>\r\n \r\n <Error Message> Syntax: (for query API) http://<servername>/cgi-bin/admin/ format_sdcard.cgi?operation=get PARAMETER VALUE DESCRIPTION Get formatting progress(0~100) or result(error message) *It is unnecessary when using the blocking mode.
Page 447 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved ERROR: The device does not exist or is busy ERROR: Formatted successfully, but cannot create database 8.39 for Accessing Streaming Methods 8.39.1 Get Stream URI (capability_media_streamprofiles_support = 1) Note: This request requires Viewer access privileges.
Page 448 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Note: This request requires Viewer access privileges. Method: GET/POST Syntax: http://<servername>:<port>/media2/<streamprofile_i<0~(n-1)>_profilename>.sdp?[<parameter>= <value>] “n” is the maximum stream profile number (capability_media_streamprofiles_num)  “streamprofile_i<x>_profilename” is a friendly name for certain profile, x is within ...
Page 449 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=<value>[&parameter=<value>] PARAMETER VALUE DESCRIPTION operation automode, manualmode "automode": Key pair will be generated, and automatically copy public key to server. "manualmode": Key should be downloaded or uploaded by user. * This field is required.
Page 450 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved * Only valid when operation=manualmode and key=upload. passphrase_content <128-bit hash value > Passphrase * Only valid when operation=manualmode and key=upload. location string[128] sftp server file location name string[40] Username for server_i<index>_name * The default value is sftp<index>.
Page 451 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved value>&keytype=test Response of failure: HTTP/1.1 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <Error Message Length>\r\n \r\n ERROR: Invalid keytype Example of upload private key: POST http://172.16.219.217/cgi-bin/admin/sftpclient.cgi HTTP/1.1 Accept: text/html, application/xhtml+xml, */* Accept-Language: zh-TW User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; rv:11.0) like Gecko Content-Type: multipart/form-data;...
Page 452 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved TovnyQQANfyNLykEtP7U7Htxbdqg4dqYdFahJEBNs0QHxhmYHTESccKM4NOB0qMY 5+9gwlMZqNIymxGlGwylTMcV7gV6JaY/bX0K4J0B6AhNHjCIOFErrQivp026TXj9 m+bnnrAt7v5uBMH4oclPC8oDHqd1jWwHIBcbqjRPWL37VW5B+YPZQ7FVUP496OKp riheNLTF6yOtYFw9syyoOnRF+gxpFpQrSO7skENGyv4CO7kH/S7Kpc7qmMgTk/rL s12230NogZsqghhTJIpg2vX5Ha3wCDIZZVKPUGItQl0MB6t74nsV1o8YVtRovI5F YX2d8sPIIkcTDWBO498+v98DQ7DH51/i39JoJouRojz+n3ffsSGjY2AKEcTde2xI v2f81KqAxkraXllScl1SNEGXQpngXy3IK2GrVw9BzJILMSBuj30Ar2zfTbc0C5VC YqWK1FcMA5Jb6AvYwmpgijIb52T9P7g07RwFGJpumvaqTchBeSp8pXa3C++DoBdY 9zYohmuSSs52QLoIkTPzDjJJHvncddPi6VuUkSyaK5x75p0+aoljPjlAQHXbXsmt 8HAdPs9Fwab9GbC2aumH4XT1xoWFnYJ9lBHc3iZRiI/nSIPev2YneyyOhJg4tHYD swUUEydNC8Q5qrbLfHESDrkHlx0sQiM7A/DyY1akkoxKEFW9LxqsJpcf7LM2TrlX IjSd+RMqL3yCFzM0aqcQNjd77nDP6+u9RYYyGT8dH5ud7pJVofxI+pvpQN3k5Tlb Pm9IM6OJPDy/Netcu6YEl3ULa6XHkYldqezJDnUfCBHe3OKjhue2FTBRmM2/j9Zl DkUrO7lQz7X88T/w5+rI2OnDIm3szOhzMCYPtHxf8ygMKXI/DKp3OR2/cu6ayGhb DezpoSyTjL1fTFINQAymDtP5tbomfESjFDW1fmfD9h1FivqYEy7017djPWrq8mjH N6nAhlaLVVuTVJ+xxaJAzYiQwMdwWY8SGUq062ksDvfixYCQfhXUd629oEX82fJU 8OxF8CM0WEHFCIotJVbFjDyT5lP4qln5EMeMlPE8jrmUKEEV+AJw9AbaqvCYUNaH EVZ7nlYjrnQqMCktYlO/Um8vSiVsOaMFLUdiYJwj2pzyceTzyW19/KEo//8ufOFD LaSp5EGH6lBCTBfQ9PGeOkB2ZVf0jLFB9Sage8Ln5frWYOAROxzumUJWSvOoBael 15OdV5hApqQjGrn1vbc/kC8p478ZCzx2iDyckPqyVpHSke70T5bV6vcDZcCTrwkA PHdD4Q0cqd7sX0R2OAScwJk2AkaQ+PsLwS05hw1nQBsQrC4m9e8Kmg32RgCGDAES xpV9dkSkvoaLZmN1qfBwnyOxsjmx9OAOBKWzMlW5PoPCR9z8Z1gsiACBnrT+K5ec NZdgsxvxMfdI7vfj6mkO89MvwLX8YEtnFrihIZmDnnVMuHfq6g5kbwlHbHVaoImo -----END RSA PRIVATE KEY----- -----------------------------7e1309282ed0f1a-- (for query API) Syntax: http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=<value>[&parameter=<value>]...
Page 453 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved * This field is required. Example of scanning SFTP server host key: Request: http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=getserverhostkey&address=<ip> Response of success: HTTP/1.1 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <Success Message Length>\r\n \r\n <MD5 value> 8.40.2 SFTP Server Setting * Only available when bit 1 of "capability_protocol_ftp_server"...
Page 454 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Syntax: (for query API) http://<servername>/cgi-bin/admin/sftpserver.cgi?operation=<value> PARAMETER VALUE DESCRIPTION operation gethostkey "gethostkey": Get host key for SFTP server. * This field is required. * If “updatehostkey” is not yet finished, you will receive error message.
Page 455: Technical Specifications
VIVOTEK Technical Specifications Technical Specifications Model SD9362-EH-v2 Compression G.711, G.726 System Information External microphone input Interface External line output Multimedia SoC (System-on-Chip) Network Flash 128MB Users Live viewing for up to 10 clients 512MB 802.1X, ARP, CIFS/SMB, CoS, DDNS, DHCP,...
Page 456 VIVOTEK Technical Specifications Microsoft Windows 8/7 Operating System Mac 10.12 (Chrome only) Chrome 58.0 or above Web Browser Internet Explorer 10/11 VLC: 1.1.11 or above Other Players QuickTime: 7 or above Included Accessories Wall mount bracket, I/O combo cable, screws, waterproof connectors, quick...
Page 457 All specifications are subject to change without notice. Copyright © VIVOTEK INC. All rights reserved. Ver. 2 6F, No.192, Lien-Cheng Rd., Chung-Ho, New Taipei City, 235, Taiwan, R.O.C. | T: +886-2-82455282 | F: +886-2-82455532 | E: sales@vivotek.com | W: www.vivotek.com...
Page 458: Technology License Notice
VIVOTEK Technology License Notice Notices from HEVC Advance: THIS PRODUCT IS SOLD WITH A LIMITED LICENSE AND IS AUTHORIZED TO BE USED ONLY IN CONNECTION WITH HEVC CONTENT THAT MEETS EACH OF THE THREE FOLLOWING QUALIFICATIONS: (1) HEVC CONTENT ONLY FOR PERSONAL USE; (2) HEVC CONTENT THAT IS NOT OFFERED FOR SALE;...
Page 459: Electromagnetic Compatibility (Emc)
取扱説明書に従って正しい取り扱いをして下さい Liability VIVOTEK Inc. cannot be held responsible for any technical or typographical errors and reserves the right to make changes to the product and manuals without prior notice. VIVOTEK Inc. makes no warranty of any kind with regard to the material contained within this document, including, but not limited to, the implied warranties of merchantability and fitness for any particular purpose.

This manual is also suitable for:

Supreme sd9361-ehl Supreme sd9362-eh Supreme sd9362-ehl

Vivotek SUPREME SD9362-EH-v2 User Manual

Quick Links

Related Manuals for Vivotek SUPREME SD9362-EH-v2

Summary of Contents for Vivotek SUPREME SD9362-EH-v2

This manual is also suitable for:

Table of Contents