Page 1 IT9389-H-v2 Turret Dome Camera User ’s Manual 5MP • Outdoor • IP66 • IK08 • Day & Night • Smart Motion Detection • 30m Smart IR WDR Pro • Smart Stream III • Shock Detection Rev. 1.0...
Page 2: Table Of Contents
VIVOTEK Table of Contents Overview ..................................Revision History ..............................4 Read Before Use ..............................4 Package Contents ..............................5 Symbols and Statements in this Document ......................5 Physical Description .............................. 6 Hardware Installation ............................. 8 Software Installation ............................. 16 Network Deployment ............................29 Ready to Use ................................
Page 3: Overview
VIVOTEK Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) ... 148 Recording > Recording settings ......................151 Storage ..............................156 Storage > SD card management ......................156 Storage > NAS management ........................157 Storage > Content management ......................159 Appendix ..............................
Page 4: Revision History
VIVOTEK Revision History ■ Rev. 1.0: Initial release. Read Before Use The use of surveillance devices may be prohibited by law in your country. The Network Camera is not only a high-performance web-ready camera but can also be part of a flexible surveillance system.
Page 5: Package Contents
VIVOTEK Package Contents ■ IT9389-H-v2 ■ Screw pack, T10 anti-tamper screw wrench. ■ Alignment sticker. ■ Mounting plate. ■ Quick Installation Guide. ■ Waterproof cable gland. Symbols and Statements in this Document INFORMATION: provides important messages or advices that might help prevent inconvenient or problem situations.
Page 6: Physical Description
VIVOTEK Physical Description IR LEDs Microphone Lens SC card access panel RJ45 Ethernet connector Reset button SD card slot 6 - User's Manual...
Page 7 VIVOTEK NOTE: Some of the suffix syntax used in model naming are listed below: w/ heater for extreme weather Focal length w/ number w/ Remote focus lens w/ PoE repeater w/ High Dynamic Range functionality User's Manual - 7...
Page 8: Hardware Installation
VIVOTEK Hardware Installation 1. Jot down the camera's MAC address for later reference. XXXXXX 0002D10766AD 2. Remove the trim ring by snatching and pulling it. 8 - User's Manual...
Page 9 VIVOTEK You can tilt, pan, or rotate the lens body to acquire the best field of view. 75° 180° 180° 3. Tilt the camera to access the MicroSD access panel. Loosen 2 T10 screws to open it. User's Manual - 9...
Page 10 VIVOTEK 4. Install a MicroSD card if onboard storage is preferred. 4. Use the alignment sticker to drill mounting holes on the wall or ceiling. Drill a cabling routing hole if preferred. P/N:XXXXXX Ø ≥25mm 10 - User's Manual...
Page 11 VIVOTEK 5. Install the access panel back to its original position. 6. Use the alignment sticker to drill holes on a wall or ceiling. User's Manual - 11...
Page 12 VIVOTEK 7. Route an Ethernet cable through the routing hole. Ø ≥25mm 8.If a routing hole is not applicable, you can route the cable along the wall by removing a side lid from the mouting bracket using a pincer. 12 - User's Manual...
Page 13 VIVOTEK 9. Pass an Ethernet cable through the waterproof cable gland components, and through the rubber seal as shown below. Connect the Ethernet cable to the camera's RJ45 connector. 10. Install the seal ring and tighten the waterproof components. User's Manual - 13...
Page 14 VIVOTEK 11.Secure the camera to wall by driving 2 screws. You can also route the cables through the side by breaking the side lid using a pincer. Note that it is always a good practice to form a drip loop of cables. Moisture condensation or dripping water can eventually cause problems without the drip loop.
Page 15 VIVOTEK 12. Please visit VIVOTEK’s website to Install the "Shepherd” software utility. The program will search for VIVOTEK Video Receivers, Video Servers or Network Cameras on the same LAN. Double-click on the camera’s MAC address to open a web console to the camera. Shepherd IEEE 802.3af Browser...
Page 16: Software Installation
VIVOTEK Software Installation 13. 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. 13-1.
Page 17 VIVOTEK 13-3. The program will search for all VIVOTEK network devices on the same LAN. 13-4. After a brief search, the installer window will prompt. Click on the MAC and model name that matches the one printed on the product label. You can then double-click on the address to open a management session with the Network Camera.
Page 18 VIVOTEK Forceful Password Configuration 13. The first time you log in to the camera, the firmware will prompt for a password configuration for security concerns. 13-1. Since your camera is used for the first time, there is no password. Enter “root” as the user name, and nothting for the password.
Page 19 VIVOTEK Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~. You can use them in the password combination. 13-3. 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.
Page 20 VIVOTEK 14. With a live view on your computer, rotate, pan, or tilt the camera until you acquire an optimal field of view. Loosen the retention screw on the side of the camera. 15. Pan or tilt the camera. 20 - User's Manual...
Page 21 VIVOTEK 15. When done, tighten the retention screw. 16. Install the trim ring. User's Manual - 21...
Page 22 VIVOTEK With the mount bracket, the camera can be installed to a single gang box, or 3.5” box. 3.5" single gang box 3.5" Octagon gang box B holes 3.5" single gang box 22 - User's Manual...
Page 23 VIVOTEK C holes 3.5" Octagon gang box You can press fit the Ethernet cable to clips on the bracket. User's Manual - 23...
Page 24 VIVOTEK You can press fit the cable gland assembly in the center. Route the cable along the side of the bracket. Install the camera by aligning with the associated key-slot holes. 24 - User's Manual...
Page 25 VIVOTEK Turn the camera clockwise and fasten a retention screw. User's Manual - 25...
Page 26 VIVOTEK The mounting bracket can be directly installed to a wall or ceiling. Use the included alignment sticker. The mounting bracket can be directly installed to a wall or ceiling. Use the included alignment sticker. Refer to Step A-2 for the rest of the procedure. A holes 26 - User's Manual...
Page 27 VIVOTEK The mounting bracket can be installed to a 3/4” NPT pipe. With a 3/4” female coupling, and a hex nut, you can install the bracket to it. 3/4” NPT pipe 3/4” female threaded fitting/coupling Locknut User's Manual - 27...
Page 28 VIVOTEK 17. Remove the protective sheet from the dome cover. Hardware Reset The reset button is used to reset the system or restore the factory default settings. Sometimes resetting the system can return the camera to normal operation. If the system problems remain after reset, restore the factory settings and install again.
Page 29: Network Deployment
VIVOTEK Network Deployment General Connection (PoE) When using a PoE-enabled switch The Network Camera is PoE-compliant, allowing transmission of power and data via a sin- gle Ethernet cable. Follow the below illustration to connect the Network Camera to a PoE- enabled switch via Ethernet cable.
Page 30: Ready To Use
VIVOTEK Ready to Use 1. A browser session to 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 in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents.
Page 31 VIVOTEK Internet connection via a router Before setting up the Network Camera over the Internet, make sure you have a router and follow the steps below. 1. Connect your Network Camera behind a router, the Internet environment is illustrated below. Regarding how to obtain your IP address, please refer to Software Installation on page 20 for details.
Page 32 VIVOTEK For example, your router and IP settings may look like this: Device IP Address: internal port IP Address: External Port (Mapped port on the router) Public IP of router 122.146.57.120 LAN IP of router 192.168.2.1 Camera 1 192.168.2.10:80 122.146.57.120:8000 Camera 2 192.168.2.11:80 122.146.57.120:8001...
Page 33: Accessing The Network Camera
VIVOTEK Accessing the Network Camera This chapter explains how to access the Network Camera through web browsers, RTSP players, 3GPP-compatible mobile devices, and VIVOTEK recording software. Using Web Browsers Use Installation Wizard 2 (IW2) to access the Network Cameras on LAN. If your network environment is not a LAN, follow these steps to access the Netwotk Camera: ®...
Page 34 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 108.
Page 35 VIVOTEK IMPORTANT: • Currently the Network Camera utilizes a 32-bit ActiveX plugin. You CAN NOT open a management/view session with the camera using a 64-bit IE browser. • If you encounter this problem, try execute the Iexplore.exe program from C:\Windows\ SysWOW64.
Page 36: 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. 3.
Page 37: 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 38: Using Vivotek Recording Software
VIVOTEK Using VIVOTEK Recording Software Visit our website for download the VAST recording software that provides simultaneous monitoring and video recording for multiple Network Cameras. Please install the recording software; then launch the program to add the Network Camera to the Channel list. For detailed information about how to use the recording software, please refer to the user’s manual of the software or download it from http://www.vivotek.com.
Page 39: Main Page
VIVOTEK Main Page This chapter explains the layout of the main page. It is composed of the following sections: VIVOTEK INC. Logo, Host Name, Camera Control Area, Configuration Area, Menu, and Live Video Window. Resize Buttons VIVOTEK INC. Host Name Logo Configuration Camera Control...
Page 40 VIVOTEK Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 44. Configuration: Click this button to access the configuration page of the Network Camera. It is suggested that a password be applied to the Network Camera so that only the administrator can configure the Network Camera.
Page 41 VIVOTEK PTZ Panel: This Network Camera supports “digital“ (e-PTZ) pan/tilt/zoom control, which allows roaming a smaller view frame within a large view frame. Please refer to PTZ settiings on page 123 for detailed information. Global view and the PTZ panel are available with the 3rd or the last video profile. Global View: Global view is available with the 3rd or the last video profile.
Page 42 VIVOTEK Video Control Buttons: Depending on the Network Camera model and Network Camera configuration, some buttons may not be available. Snapshot: Click this button to capture and save still images. The captured images will be displayed in a pop-up window. Right-click the image and choose Save Picture As to save it in JPEG (*.jpg) or BMP (*.bmp) format.
Page 43 VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Time 2021/03/25 17:08:56 Video (HTTP-V) Title and Time Video 17:08:56 2021/03/25 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 68.
Page 44: Client Settings
VIVOTEK Client Settings This chapter explains how to select the stream transmission mode and saving options on the local computer. When completed with the settings on this page, click Save on the page bottom to enable the settings. H.265/H.264 Protocol Options H.264 Protocol Options Depending on your network environment, there are four transmission modes of H.264 streaming: UDP unicast: This protocol allows for more real-time audio and video streams.
Page 45 VIVOTEK MP4 Saving Options Users can record live video as they are watching it by clicking Start MP4 Recording on the main page. Here, you can specify the storage destination and file name. Folder: Specify a storage destination on your PC for the recorded video files. The location can be changed.
Page 46 VIVOTEK Joystick settings Enable Joystick Connect a joystick to a USB port on your management computer. Supported by the plug-in (Microsoft’s DirectX), once the plug-in for the web console is loaded, it will automatically detect if there is any joystick on the computer. The joystick should work properly without installing any other driver or software.
Page 47 VIVOTEK Buttons Configuration In the Button Configuration window, the left column shows the actions you can assign, and the right column shows the functional buttons and assigned actions. The number of buttons may differ from different joysticks. Please follow the steps below to configure your joystick buttons: 1.
Page 48 VIVOTEK Buttons Configuration Click the Configure Buttons button, a window will prompt as shown below. Please follow the steps below to configure your joystick buttons: 1. Select a button number from the Button # pull-down menu. Tips: If you are not sure of the locations of each button, use the Properties window in the Game Controllers utility.
Page 49: Configuration
VIVOTEK Configuration Click Configuration on the main page to enter the camera setting pages. Note that only Administrators can access the configuration page. VIVOTEK provides an easy-to-use user interface that helps you set up your network camera with minimal effort. In order to simplify the user interface, detailed information will be hidden unless you click on the function item.
Page 50: System > General Settings
VIVOTEK System > General settings This section explains how to configure the basic settings for the Network Camera, such as the host name and system time. It is composed of the following two columns: System, and System Time. When finished with the settings on this page, click Save at the bottom of the page to enable the settings.
Page 51 VIVOTEK System time Keep current date and time: Select this option to preserve the current date and time of the Network Camera. The Network Camera’s internal real-time clock maintains the date and time even when the power of the system is turned off. Synchronize with computer time: Select this option to synchronize the date and time of the Network Camera with the local computer.
Page 52 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 53: System > Homepage Layout
VIVOTEK System > Homepage layout This section explains how to set up your own customized homepage layout. General settings This column shows the settings of your hompage layout. You can manually select the background and font colors in Theme Options (the second tab on this page). The settings will be displayed automatically in this Preview field.
Page 54 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 55 VIVOTEK ■ Follow the steps below to set up the customized homepage: 1. Click Custom on the left column. 2. Click the field where you want to change the color on the right column. Color Selector Custom Pattern 3. The palette window will pop up as shown below. 4.
Page 56: System > Logs
VIVOTEK System > Logs This section explains how to configure the Network Camera to send the system log to a remote server as backup. Log server settings Follow the steps below to set up the remote log: 1. Select Enable remote log. 2.
Page 57 VIVOTEK You can install the included VAST recording software, which provides an Event Management function group for delivering event messages via emails, GSM short messages, onscreen event panel, or to trigger an alarm, etc. For more information, refer to the VAST User Manual. VIVOTEK Network Cameras Internet 3G Cell phone...
Page 58 VIVOTEK Access log Access log displays the access time and IP address of all viewers (including operators and administrators) in a chronological order. The access log is stored in the Network Camera’s buffer area and will be overwritten when reaching a certain limit. Set Parameter log VADP log contains the history of changes made to system parameters such as recording, imaging parameters, and all other parameters.
Page 59: System > Parameters
VIVOTEK System > Parameters The View Parameters page lists the entire system’s parameters. If you need technical assistance, please provide the information listed on this page. User's Manual - 59...
Page 60: System > Maintenance
VIVOTEK System > Maintenance This chapter explains how to restore the Network Camera to factory default, upgrade firmware version, etc. General settings > Upgrade firmware This feature allows you to upgrade the firmware of your Network Camera. It takes a few minutes to complete the process.
Page 61 VIVOTEK General settings > Restore This feature allows you to restore the Network Camera to factory default settings. Network: Select this option to retain the Network Type settings (please refer to Network Type on page 90). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
Page 62 VIVOTEK The following message is displayed when attempting to upload an incorrect file format. Export language file: Click to export language strings. VIVOTEK provides nine languages: English, Deutsch, Español, Français, Italiano, 日本語, Português, 簡体中文, and 繁體中文 . Update custom language file: Click Browse… and specify your own custom language file to upload. Export configuration file: Click to export all parameters for the device and user-defined scripts.
Page 63: Media > Image
VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following columns: General settings, IR control, Image settings, Exposure, Focus, and Privacy mask. The Focus window is available only for models that come with motorized lens.
Page 64 VIVOTEK Video orientation: Flip - vertically reflect the display of the live video; Mirror - horizontally reflect the display of the live video. Select both options if the Network Camera is installed upside-down (e.g., on the ceiling) to correct the image orientation. Please note that if you have preset locations, those locations will be cleared after flip/mirror setting.
Page 65 VIVOTEK IR cut filter With a removable IR-cut filter, this Network Camera can automatically remove the filter to let Infrared light pass into the sensor during low light conditions. ■ Auto mode (The Day/Night Exposure Profile will not be available if Auto mode is selected) The Network Camera automatically removes the filter by judging the level of ambient light.
Page 66 VIVOTEK Illuminators Turn on built-in IR illuminator in night mode Select this to turn on the camera’s onboard IR illuminator when the camera detects low light condition and enters the night mode. Smart IR Anti-overexposure: When enabled, the camera automatically adjusts the IR projection to adjacent objects in order to avoid over-exposure in the night mode.
Page 67 VIVOTEK Tips: If there is an object in close proximity, the IR lights reflected back from it can mislead the Smart IR’s calculation of light level. To solve this problem, you can place an “Exposure Exclude” window on an unavoidable object in the Exposure setting window. See page 71 for how to do it.
Page 68 VIVOTEK Image settings On this page, you can tune the White balance and Image adjustment. Sensor Setting 2: For special situations Sensor Setting 1: For normal situations White balance: Adjust the value for the best color temperature. ■ You may follow the steps below to adjust the white balance to the best color temperature. 1.
Page 69 VIVOTEK Noise reduction ■ Enable noise reduction: Check to enable noise reduction in order to reduce noises and flickers in image. This applies to the onboard 3D Noise Reduction feature. Use the slide bar to adjust the reduction strength. Note that applying this function to the video channel will consume system computing power.
Page 70 VIVOTEK Exposure On this page, you can set the Exposure measurement window, Exposure level, Exposure mode, Exposure time, Gain control, and Day/Night mode settings. You can configure two sets of Exposure settings: one for normal situations, the other for special situations, such as the day/night/schedule mode.
Page 71 VIVOTEK The inclusive window refers to the “weighted window“; the exclusive window refers to “ignored window“. It adopts the weighted averages method to calculate the value. The inclusive windows have a higher priority. You can overlap these windows, and, if you place an exclusive window within a larger inclusive window, the exclusive part of the overlapped windows will be deducted from the inclusive window.
Page 72 VIVOTEK Exposure control: ■ Exposure level: You can manually set the Exposure level, which ranges from -2.0 to +2.0 (dark to bright). You can click and drag the semi-circular pointers on the Exposure time and Gain control slide bars to specify a range of shutter time and Gain control values within which the camera can automatically tune to an optimal imaging result.
Page 73 VIVOTEK You can click Restore to recall the original settings without incorporating the changes. When completed with the settings on this page, click Save to enable the settings. If you want to configure another sensor setting for day/night/schedule mode, please click Profile to open the Profile of exposure settings page as shown below.
Page 74 VIVOTEK Privacy mask Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to address privacy concerns. ■ To configure privacy mask windows, 1. Click New to add a new window. 2. You can use 4 mouse clicks to create a new masking window, which is recommended to be at least twice the size of the object (height and width) you want to cover.
Page 75 VIVOTEK Pixel Calculator Click the Add button at the lower screen to create a pixel calculator window. Place your cursor on the window to move it to an area of your interest, and change the size of window to fit the area of interest. Once they are drawn, the numbers of pixels on the sides of windows will appear.
Page 76: Media > Video
VIVOTEK Media > Video Mode The applicable video modes include: ■ 5-Megapixel (4:3)(MAX 30fps) (WDR Pro): This is the full resolution at 5 megapixels in a 4:3 screen aspect , with the WDR function enabled. ■ 4-Megapixel (16:9)(MAX 30fps) (WDR Pro): At the 16:9 aspect ratio, the highest frame rate can reach 30fps, with the WDR function.
Page 77: Media > Video
VIVOTEK Media > Video Stream settings This Network Camera supports multiple streams with frame sizes ranging from 480 x 272 to 2560x1920 pixels The definition of multiple streams: ■ Stream 1: Users can define the "Region of Interest" (viewing region) and the "Output Frame Size" (size of the live view window).
Page 78: Media > Video
VIVOTEK Please follow the steps below to set up those settings for a stream: 1. Select a stream for which you want to set up the viewing region. 2. Select a Region of Interest from the drop-down list. The floating frame, the same as the one in the Global View window on the home page, will resize accordingly.
Page 79 VIVOTEK Click the stream item to display the detailed information. The maximum frame size will follow your settings in the above Viewing Window sections. This Network Camera provides real-time H.265, H.264 and MJPEG compression standards (Triple H.265 H.264 Codec) for real-time viewing. If the mode is selected, the video is streamed via RTSP protocol.
Page 80 VIVOTEK The frame rate will decrease if you select a higher resolution. ■ Intra frame period Determine how often for firmware to plant an I frame. The shorter the duration, the more likely you will get better video quality, but at the cost of higher network bandwidth consumption. Select the intra frame period from the following durations: 1/4 second, 1/2 second, 1 second, 2 seconds, 3 seconds, and 4 seconds.
Page 81 VIVOTEK With the H.265 codec in an optimal scenario and when Dynamic Intra frame is combined with the Smart Stream function, an 80% of bandwidth saving can be achieved compared with using H.264 without enabling these bandwidth-saving features. ■ Smart FPS In a static scene, the algorithm puts old frames in queue when no motions occur in scene.
Page 82 VIVOTEK • Smart codec: Smart codec effectively reduces the quality of the whole or the non- interested areas on a screen and therefore reduces the bandwidth consumed. You can manually specify the video quality for the foreground and the background areas.
Page 83 VIVOTEK As the result, the lower screen is constantly displayed in high details, while the upper half is transmitted using a lower-quality format. Although the upper half is transmitted using a lower quality format, you still have an awareness of what is happening on the whole screen.
Page 84 VIVOTEK Bit rate control ■ Constrained bit rate: A complex scene generally produces a larger file size, meaning that higher bandwidth will be needed for data transmission. The bandwidth utilization is configurable to match a selected level, resulting in mutable video quality performance. The bit rates are selectable at the following rates: 20Kbps, 30Kbps, 40Kbps, 50Kbps, 64Kbps, 128Kbps, 256Kbps, 512Kbps, 768Kbps, 1Mbps, 2Mbps, 3Mbps, 4Mbps, 6Mbps, 8Mbps, 10Mbps, 12Mbps, 14Mbps, ~ to 80Mbps.
Page 85 VIVOTEK Fixed quality: On the other hand, if Fixed quality is selected, all frames are transmitted with the same quality; bandwidth utilization is therefore unpredictable. The video quality can be adjusted to the following settings: Medium, Standard, Good, Detailed, and Excellent.
Page 86 VIVOTEK JPEG If the mode is selected, the Network Camera sends consecutive JPEG images to the client, producing a moving effect similar to a filmstrip. Every single JPEG image transmitted guarantees the same image quality, which in turn comes at the expense of variable bandwidth usage. Because the media contents are a combination of JPEG images, no audio data is transmitted to the client.
Page 87: Media > Audio
VIVOTEK Media > Audio Audio Settings Mute: Select this option to disable audio transmission from the Network Camera to all clients. Note that if mute mode is turned on, no audio data will be transmitted even if audio transmission is enabled on the Client Settings page.
Page 88: 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 89: Network > General Settings
VIVOTEK Network > General settings This section explains how to configure a wired network connection for the Network Camera. Network Type Select this option when the Network Camera is deployed on a local area network (LAN) and is intended to be accessed by local computers. The default setting for the Network Type is LAN. Please rememer to click on the Save button when you complete the Network setting.
Page 90 VIVOTEK Primary DNS: The primary domain name server that translates hostnames into IP addresses. Secondary DNS: Secondary domain name server that backups the Primary DNS. Primary WINS server: The primary WINS server that maintains the database of computer names and IP addresses. Secondary WINS server: The secondary WINS server that maintains the database of computer names and IP addresses.
Page 91 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 92 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 93 VIVOTEK Enable IPv6 Select this option and click Save to enable IPv6 settings. Please note that this only works if your network environment and hardware equipment support ® IPv6. The browser should be Microsoft Internet Explorer 6.5, Mozilla Firefox 3.0 or above. When IPv6 is enabled, by default, the network camera will listen to router advertisements and be assigned with a link-local IPv6 address accordingly.
Page 94 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 95 VIVOTEK User's Manual - 95...
Page 96: 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 97 VIVOTEK URL command -- http://<ip address>:<http port>/<access name for stream 1, 2, 3> For example, when the Access name for stream 2 is set to video1s2.mjpg: 1. Launch Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter. 3.
Page 98 VIVOTEK Authentication: Depending on your network security requirements, the Network Camera provides three types of security settings for streaming via RTSP protocol: disable, basic, and digest. basic authentication is selected, the password is sent in plain text format, but there can be potential risks of it being intercepted.
Page 99 VIVOTEK Multicast settings for streams: Click the items to display the detailed configuration information. Select the Always multicast option to enable multicast for video streams. Unicast video transmission delivers a stream through point-to-point transmission; multicast, on the other hand, sends a stream to the multicast group address and allows multiple clients to acquire the stream at the same time by requesting a copy from the multicast group address.
Page 100 VIVOTEK Network > DDNS This section explains how to configure the dynamic domain name service for the Network Camera. DDNS is a service that allows your Network Camera, especially when assigned with a dynamic IP address, to have a fixed host and domain name. Express link Express Link is a free service provided by VIVOTEK server, which allows users to register a domain name for a network device.
Page 101 VIVOTEK Manual setup DDNS: Dynamic domain name service Enable DDNS: Select this option to enable the DDNS setting. Provider: Select a DDNS provider from the provider drop-down list. VIVOTEK offers Safe100.net, a free dynamic domain name service, to VIVOTEK customers. It is recommended that you register Safe100.net to access VIVOTEK’s Network Cameras from the...
Page 102 VIVOTEK [Register] Successfully Your account information has been mailed to registered e-mail address 4. Select Enable DDNS and click Save to enable the setting. ■ CustomSafe100 VIVOTEK offers documents to establish a CustomSafe100 DDNS server for distributors and system integrators. You can use CustomSafe100 to register a dynamic domain name if your distributor or system integrators offer such services.
Page 103 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 104 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 105: 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 106: Network > Ftp
VIVOTEK Network > FTP The newer firmware disabled the FTP port for security concerns. You can manually enable the FTP server service to enable the FTP function. You can disable the FTP server function when it is not in use. FTP port: The FTP server allows the user to save recorded video clips.
Page 107: Bonjour
VIVOTEK Bonjour To access the camera from a Mac computer, go to Safari, click on Bonjour and select the camera from a drop-down list. You can go to Safari > Preferences to enter your user name and password, and provide the root password the first time you access the camera.
Page 108: 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 109 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 110: 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 111 VIVOTEK 5. Click Save to preserve your configuration, and your current session with the camera will change to the encrypted connection. 6. If your web session does not automatically change to an encrypted HTTPS session, click Home to return to the main page. Change the URL address from “http://” to “https://“ in the address bar and press Enter on your keyboard.
Page 112 VIVOTEK Create certificate request and install 1. Select the option from the Method pull-down menu. 2. Click Create certificate to proceed. 3. The following information will show up in a pop-up window after clicking Create. Then click Save to generate the certificate request. 4.
Page 113 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 114 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. 114 - User's Manual...
Page 115 VIVOTEK 9. Save the edit using the “.crt” extension, using a file name like “CAcert.crt.” 10. Return to the original firmware session, use the Browse button to locate the crt certificate file, and click Upload to enable the certification. User's Manual - 115...
Page 116 VIVOTEK Note that 11. When the certifice file is successfully loaded, its status will be stated as Active. a certificate must have been created and installed before you can click on the “Save" button for the configuration to take effect. 12.To begin an encrypted HTTPS session, click Home to return to the main page.
Page 117: Security > Access List
VIVOTEK Security > Access List This section explains how to control access permission by verifying the client PC’s IP address. General Settings Maximum number of concurrent streaming connection(s) limited to: Simultaneous live viewing for 1~10 clients (including stream 1 to stream 3). The default value is 10. If you modify the value and click Save, all current connections will be disconnected and automatically attempt to re-link (IE Explorer or Quick Time Player).
Page 118 VIVOTEK ■ Refresh: Click this button to refresh all current connections. ■ Add to deny list: You can select entries from the Connection Status list and add them to the Deny List to deny access. Please note that those checked connections will only be disconnected temporarily and will automatically try to re-link again (IE Explore or Quick Time Player).
Page 119 VIVOTEK There are three types of rules: Single: This rule allows the user to add an IP address to the Allowed/Denied list. For example: 192.168.2.1 Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List.
Page 120 VIVOTEK Security > IEEE 802.1X Enable this function if your network environment uses IEEE 802.1x, which is a port-based network access control. The network devices, intermediary switch/access point/hub, and RADIUS server must support and enable 802.1x settings. The 802.1x standard is designed to enhance the security of local area networks, which provides authentication to network devices (clients) attached to a network port (wired or wireless).
Page 121 VIVOTEK 3. When all settings are complete, move the Network Camera to the protected LAN by connecting it to an 802.1x enabled switch. The devices will then start the authentication automatically. NOTE: ► The authentication process for 802.1x: 1. The Certificate Authority (CA) provides the required signed certificates to the Network Camera (the supplicant) and the RADIUS Server (the authentication server).
Page 122 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 123: Ptz > Ptz Settings
VIVOTEK PTZ > PTZ settings This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation (available in the 3rd or the last video profile). Digital: Control the e-PTZ operation. Within a field of view,it allows users to quickly move the focus to a target area for close-up viewing without physically moving the camera.
Page 124 VIVOTEK Home page in the E-PTZ Mode ■ The e-Preset Positions will also be displayed on the home page. Select one from the drop-down list, and the Network Camera will move to the selected position. ■ If you have set up different preset positions for different streams, you can select one of the video streams to display its separate preset positions.
Page 125 VIVOTEK Patrol settings You can select some preset positions for the Network Camera to patrol. Please follow the steps below to set up a patrol schedule: 1. Select the preset locations on the list, and click 2. The selected preset locations will be displayed on the Patrol locations list. 3.
Page 126 VIVOTEK NOTE: • The Preset Positions will also be displayed on the Home page. Select one from the Go to menu, and the Network Camera will move to the selected preset position. • Click Patrol: The Network Camera will patrol along the selected positions repeatedly. 126 - User's Manual...
Page 127: Event > Event Settings
VIVOTEK Event > Event settings This section explains how to configure the Network Camera to respond to particular situations (event). A typical application is that when a motion is detected, the Network Camera sends buffered images to an FTP server or e-mail address as notifications. Click on Help, there is an illustration shown in the pop-up window explaining that an event can be triggered by many sources, such as motion detection or external digital input devices.
Page 128 VIVOTEK ■ Event name: Enter a name for the event setting. ■ Enable this event: Select this checkbox to enable the event setting. ■ Priority: Select the relative importance of this event (High, Normal, or Low). Events with a higher priority setting will be executed first.
Page 129 VIVOTEK ■ Camera tampering detection This option allows the Network Camera to trigger when the camera detects that is is being tampered with. To enable this function, you need to configure the Tampering Detection option first. Please refer to page 144 for detailed information. ■...
Page 130 VIVOTEK 3. Action Define the actions to be performed by the Network Camera when a trigger is activated. ■ Backup media if the network is disconnected Select this option to backup media file on SD card if the network is disconnected. This function will only be displayed after you set up a network storage (NAS).
Page 131 VIVOTEK Add server It is necessary to configure the server and media settings so that the Network Camera will know what action to take (such as which server to send the media files to) when a trigger is activated. Click server to open the server setting window.
Page 132 VIVOTEK To verify if the email settings are correctly configured, click Test. The result will be shown in a pop-up window. If successful, you will also receive an email indicating the result. Click Save server to enable the settings. Note that after you configure the first event server, the new event server will automatically display on the Server list.
Page 133 VIVOTEK ■ Passive mode Most firewalls do not accept new connections initiated from external requests. If the FTP server supports passive mode, select this option to enable passive mode FTP and allow data transmission to pass through the firewall. The firmware default has the Passive mode checkbox selected. To verify if the FTP settings are correctly configured, click Test.
Page 134 VIVOTEK If key authentication is not preferred, you can specify a username and password in the section below. An RSA key fingerprint will look like this: da:47:93:b4:3a:90:5b:50:1f:20:a8:f9:b7:a1:d0:e1. Verify if this is the SFTP server you want to connect to. ■ Folder name Enter the folder where the media file will be placed.
Page 135 VIVOTEK Publickey mode: Selecting the Public key mode will bring up the Pairing mode options: Auto, Download, Upload. Auto Camera will generate a key pair and auto pair public key with the SFTP server. Download Camera will generate a key pair and download the public key for the user to upload it to the SFTP server.
Page 136 VIVOTEK Server type - HTTP Select to send the media files to an HTTP server when a trigger is activated. ■ Server name: Enter a name for the server setting. ■ URL: Enter the URL of the HTTP server. ■ User name: Enter the user name if necessary. ■...
Page 137 VIVOTEK Network storage: Select to send the media files to a networked storage when a trigger is activated. Please refer to NAS server on page 154 for details. Note that only one NAS server can be configured. Click Save server to enable the settings. ■...
Page 138 VIVOTEK Click 20210120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2021/01/20 2021/01/20 Click to go back to the previous Click to delete level of the directory selected items Click to delete all recorded data 2021/01/20 2021/01/20...
Page 139 VIVOTEK Add media Add media Click to open the media setting window. You can specify the type of media that will be sent when a trigger is activated. A total of 5 media settings can be configured. There are three choices of media types available: Snapshot, Video Clip, and System log.
Page 140 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_20210513_100341 File name preﬁx Date and time sufﬁx The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings. Note that after you set up the first media server, a new column for media server will automatically display on the Media list.
Page 141 VIVOTEK ■ Maximum file size Specify the maximum file size allowed. Some users may need to stitch the video clips together when searching and packing up forensic evidence. ■ File name prefix Enter the text that will be appended to the front of the file name. For example: Video_20210513_100341 File name preﬁx...
Page 142 VIVOTEK In the Event settings column, the Servers and Medias you configured will be listed; please make sure the Event -> Status is indicated as ON, in order to enable the event triggering action. When completed, click the Save event button to enable the settings and click Close to exit Event Settings page.
Page 143: Applications > Motion Detection
VIVOTEK Applications > Motion detection NOTE: • Due to system resources concern, the motion tracking blocks and the Human detection area will not display when running motion detection on this model. The camera comes with a Smart Motion Detection utility as its pre-loaded VCA package. Please refer to its User Guide for more information: http://download.vivotek.com/downloadfile/solutions/vadp/smart-motion-detection-manual_ en.pdf.
Page 144: Applications > Tampering Detection
VIVOTEK Applications > Tampering detection This section explains how to set up camera tamper detection. With tamper detection, the camera is capable of detecting incidents such as redirection, blocking or defocusing, or even spray paint. Please follow the steps below to set up the camera tamper detection function: 1.
Page 145: Applications > Smart Vca
VIVOTEK Applications > Smart VCA Smart VCA provides the following features: Intrusion detection, Loitering detection, Missing object detection, Unattended Object detection, Line Crossing detection, and Face detection. Please refer to Smart VCA’s user documentation for more information. Click on Configuration > Applications > Smart VCA. The Smart VCA utility will be automatically started.
Page 146: 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 147: Applications > Shock Detection
VIVOTEK Applications > Shock detection The camera comes with a shock accelerometer. The shock sensor can detect impacts to the camera. For example, when a person deliberately tries to destroy the camera, the camera can report the event to the administrator. Normally, a 5kgm impact can cause the detected impact level to surge to 50% on the scale.
Page 148: Applications > Package Management - A.k.a., Vadp (Vivotek Application Development Platform)
VIVOTEK Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) The IB9365-HT is the first camera line to come embedded with the Smart Motion Detection feature. The Smart Motion detection, with Human detection and tunable time filter, can eliminate the defects of traditional motion detection and facilitate the configuration at a surveillance site.
Page 149 VIVOTEK To utilize a software module, acquire the software package and click Browse and Upload buttons. The screen message for a successful upload is shown below: To start a module, select the 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.
Page 150 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. 150 - User's Manual...
Page 151: Recording > Recording Settings
VIVOTEK Recording > Recording settings This section explains how to configure the recording settings for the Network Camera. Recording Settings Insert your SD card and click here to test NOTE: ► Please remember to format your SD card via the camera’s web console (in the Local storage . SD card management page) when using it for the first time.
Page 152 VIVOTEK If you enable adaptive recording on a camera, only when an event is triggered on Camera A will the server record the full frame rate streaming data; otherwise, it will only request the I frame data during normal monitoring, thus effectively saves bandwidths and storage space. NOTE: ►...
Page 153 VIVOTEK 2. Destination You can select the SD card or networked storage (NAS) for the recorded video files. If you have not configured a NAS server, see details in the following. NAS server Click Add NAS server to open the server setting window and follow the steps below to set up: 1.
Page 154 VIVOTEK If successful, you will receive a test.txt file on the network storage server. 3. Enter a server name. 4. Click Save to complete the settings and click Close to exit the page. ■ Capacity: You can choose either the entire free space available or limit the reserved space. The recording size limit must be larger than the reserved amount for cyclic recording.
Page 155 VIVOTEK Event f you want to enable recording notification, please click to configure event triggering settings. Please refer to Event > Event settings on page 127 for more details. When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page.
Page 156: Storage
VIVOTEK Storage NOTE: • It is recommended to turn OFF the recording activity before you remove an SD card from the camera. • The lifespan of an SD card is limited. Regular replacement of the SD card can be necessary. •...
Page 157: Storage > Nas Management
VIVOTEK SD card control ■ Enable cyclic storage: Check this item if you want to enable cyclic recording. When the maximum capacity is reached, the oldest file will be overwritten by the latest one. ■ Enable automatic disk cleanup: Check this item and enter the number of days you wish to retain a file. For example, if you enter “7 days”, the recorded files will be stored on the SD card for 7 days.
Page 158 VIVOTEK 2. Click Test to check the setting. The result will be shown in the pop-up window. If successful, you will receive a test.txt file on the networked storage server. 3. Click Mount to complete the settings. NAS management ■ Minimum reserved storage space: The reserved space can be used as a safe buffer especially when the cyclic recording function is enabled, during the transaction stage when a storage space is full and the incoming streaming data is about to overwrite the previously saved videos.
Page 159: Storage > Content Management
VIVOTEK Storage > Content management This section explains how to manage the content of recorded videos on the Network Camera. Here you can search and view the records and view the searched results. Searching and Viewing the Records This column allows the user to set up search criteria for recorded data. If you do not select any criteria and click Search button, all recorded data will be listed in the Search Results column.
Page 160 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 161 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: C l i c k switch pages ■...
Page 162: 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 163 VIVOTEK © 2021 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 164 VIVOTEK © 2021 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 165 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 4. Security Level SECURITY LEVEL SUB-DIRECTORY DESCRIPTION anonymous Unprotected. 1 [view] viewer Can view, listen, and talk to camera. 4 [operator] operator Operator access rights can modify most of the camera’s parameters except some privileges and network options. 6 [admin] admin Administrator access rights can fully control the...
Page 166 VIVOTEK © 2021 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 167 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n User's Manual - 167...
Page 168 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/operator/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/admin/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] PARAMETER DESCRIPTION <parameter>...
Page 169 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved [<parameter pair>] Only the parameters that you set and are readable will be returned. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123 Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n User's Manual - 169...
Page 170 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7. Available Parameters on the Server Valid values: VALID VALUES DESCRIPTION string[<n>] Text strings shorter than ‘n’ characters. The characters “,’,<,>,& are invalid. string[n~m] Text strings longer than `n’ characters and shorter than `m’ characters. The characters “,’,<,>,&...
Page 171 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved VALID VALUES DESCRIPTION <WxH> The format for resolution. W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 available The API is listed in product WebAPIs. non-available The API is not in product WebAPIs.
Page 172 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <blank> timezoneindex -489 ~ 529 Indicate timezone and area. <Not recommended to -440: GMT-11:00 Midway Island, Samoa use this> -400: GMT-10:00 Hawaii -360: GMT-09:00 Alaska -320: GMT-08:00 Las Vegas, San Francisco, Vancouver -280: GMT-07:00 Mountain Time, Denver -281: GMT-07:00 Arizona...
Page 173 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 82: GMT 02:00 Lebanon 83: GMT 02:00 120: GMT 03:00 Baghdad, Kuwait, Riyadh, Nairobi 121: GMT 03:00 Iraq, Minsk 140: GMT 03:30 Tehran 160: GMT 04:00 Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan, Moscow, St.
Page 174 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * We replace this parameter with “system_tz” when the version number (httpversion) is equal or greater than 0314b. daylight_enable <boolean> Enable automaticdaylight saving time in time zone. daylight_auto_begintim string[19] Display the current daylight saving start...
Page 175 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) restoreexceptnet Restore the system parameters to default <positive values except (ipaddress, subnet, router, integer> dns1, dns2, pppoe). This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.
Page 176 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) restoreexceptfocusvalu Restore the system parameters to default <positive values except zoom and focus value. integer> This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.
Page 177 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) serialnumber <mac address> 12 characters MAC address (without hyphens). firmwareversion string[40] Firmware version, including model, company, and version number in the format:<MODEL-BRAND-VERSION> language_count <positive Number of webpage languages available integer>...
Page 178 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.2 Status Group: status NAME VALUE SECURITY DESCRIPTION (get/set) di_i<0~(k-1)> <boolean> 0 => Inactive, normal <product dependent> 1 => Active, triggered (capability_ndi > 0) k is determined by the below criterion: The following applies for capability_extension_di_num >= 0 * if extension_connected=1, k=capability_ndi...
Page 179 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) integer> connections. 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)>...
Page 180 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) normalstate high, Indicates open circuit or closed circuit (inactive status) 7.4 Digital Output Behavior Define Group: do_i<0~(n-1)> for n is the value of "capability_ndo" (capability_ndo > 0) k is determined by the below criterion: The following applies for capability_extension_do_num >= 0 * if extension_connected=1, k=capability_ndo...
Page 181 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) admin user_i<1~20>_ privilege view, User privilege operator, admin 7.6 Network Group: network NAME VALUE SECURITY DESCRIPTION (get/set) preprocess <positive integer> An 32-bit integer, each bit can be set separately as follows: Bit 0 =>...
Page 182 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) type lan, Network connection type. pppoe resetip <boolean> 1 => Get ipaddress, subnet, router, dns1, dns2 from DHCP server at next reboot. 0 => Use preset ipaddress, subnet, rounter, dns1, and dns2.
Page 183 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) integer> privatekey_exist <boolean> Private key installed flag (for TLS) privatekey_time 0,<positive Private key installed time. Represented integer> in EPOCH privatekey_size 0,<positive Private key file size (in bytes) integer>...
Page 184 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable IPv6. addonipaddress <ip address> IPv6 IP address. addonprefixlen 0~128 IPv6 prefix length. addonrouter <ip address> IPv6 router address. addondns <ip address> IPv6 DNS address. allowoptional <boolean>...
Page 185 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) (channel1stream2) video1s3.mjpg = c0_s2_accessname, (channel1stream3) video1s4.mjpg = c0_s3_accessname, (channel1stream4) etc. * We replace this parameter with "network_http_c<0~(capability_nvideoin -1)>_s<0~(capability_nmediastream-1)>_ accessname " when the version number (httpversion) is equal or greater than 0311c. 7.6.6 HTTP per Channel Subgroup of network: http_c<0~(n-1)>...
Page 186 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) version number (httpversion) is equal or greater than 0311c. 7.6.7 HTTS Port Subgroup of network: https (capability_protocol_https > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 443, 1025 ~ HTTPS port.
Page 187 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) are prohibited. For example, “c, cg, cgi, cgi-, cgi-b, cgi-bi, cgi-bin” are not allowed. * We modify the value of RTSP access name after version number(httpversion) is 0311c c<0~(capability_nvide string[32] RTSP access name for channel N...
Page 188 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.6.9 RTSP Multicast Subgroup of network: rtsp_s<0~(n-1)>_multicast n denotes the value of "capability_nmediastream * capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) alwaysmulticast <boolean> Enable always multicast. ipaddress <ip Multicast video IP address. address> * We replace "network_rtsp_s<0~(n-1)>_multicast_ipaddress"...
Page 189 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.6.10 SIP Port Subgroup of network: sip (capability_protocol_sip> 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 1025 ~ 65535 SIP port. 7.6.11 RTP Port Subgroup of network: rtp NAME VALUE SECURITY DESCRIPTION (get/set) videoport 1025 ~ 65535 Video channel port for RTP.
Page 190 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) or greater than 0312a. 7.6.14 SFTP server * Only available when bit 1 of "capability_protocol_ftp_server " is 1. Subgroup of network: sftp NAME VALUE SECURITY DESCRIPTION (get/set) port Local sftp server port.
Page 191 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.8 Video Input <Not Recommended to use> Group: videoin * We do not support this parameter when "capability_nvideoin > 1". NAME VALUE SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 CMOS frequency. * Only available when capability_videoin_type is 2.
Page 192 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when "capability_image_c<0~(n-1)>_wbmo de" !="-" * 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 193 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) independent> or flicker effect in indoor environment. "indoor": Avoid rolling and flicker effect first. "fixed": Open the iris to maximum. * Only available when "capability_image_c<0~(n-1)>_iristype "=dciris * We do not support this parameter when "capability_nvideoin >...
Page 194 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) is equal or greater than 0400a. mirror <boolean> Mirror the image. * 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 195 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) text string[64] Enclose caption. * 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 196 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) etc. 5~8000 => 1/5s ~ 1/8000s etc. * Available value is * This parameter may also restrict listed in image frame rate from sensor due to "capability_image_ sensor generates a frame per c<0~(n-1)>_exposu exposure time.
Page 197 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.8.1 Video Input Setting per Channel Group: videoin_c<0~(n-1)> for n channel products, and m is stream number n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" NAME VALUE SECURITY( DESCRIPTION get/set) cmosfreq...
Page 198 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 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". * Only valid when "videoin_c<0~(n-1)>_whitebalance"...
Page 199 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.0 * Only available when "capability_image_c<0~(n-1)>_exposu re_mode" !=0 exposuremode auto, Select exposure mode. <product shutterpriority, "auto": Automatically adjust the Iris, dependent>...
Page 200 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only available when "capability_image_c<0~(n-1)>_iristype "=dciris piris_mode manual, indoor, outdoor,- Control P-Iris mode. <product "outdoor": Auto-setting P-Iris to get dependent> best quality, but easy to meet rolling or flicker effect in indoor environment.
Page 201 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_m axgain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype"...
Page 202 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only available when " capability_videoin_c<0~(n-1)>_color_ support" is 1. flip <boolean> Flip the image. mirror <boolean> Mirror the image. rotate 0,90,180,270 The rotation angle of image. Support only in Rotation mode (capability_videoin_c<0~(n-1)>_rotati on=1) ptzstatus...
Page 203 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) ntpath , /mnt/flash2/upload.ttf (/usr/share/font/Default.ttf) or user uploaded font file(/mnt/flash2/upload.ttf). textonvideo_u Depends on the font file Show the uploaded font file name. ploadfilename name uploaded by user minexposure <1~32000>, Minimum exposure time <product...
Page 204 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". shuttervalue <1~32000>, Exposure time <product <5~32000>, 1~32000 => 1s ~ 1/32000s dependent> <1~8000>, 5~32000 =>...
Page 205 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "hlc": The metering method can "capability_image_c<0~(n- detect strong light and make affected 1)>_exposure_meteringm area clear. ode" * We support this parameter when the version number (httpversion) is equal or greater than 0311a.
Page 206 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) Possible values are: mjpeg, h264,h265 <product dependent> s<0~(m-1)>_re Available options are list in Video resolution in pixels. solution "capability_videoin_c<0~( n-1)>_resolution". Besides, available options is referred to "capability_videoin_c<0~( n-1)>_maxresolution"...
Page 207 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue" * Only valid when "h264_ratecontrolmode"= vbr. s<0~(m-1)>_h2 0~51 Manual video quality level input.
Page 208 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only available when "h264_ratecontrolmode"= cbr. s<0~(m-1)>_h2 1~100 Select customized quality in a 64_cbr_qperce normalized full range. 1: Worst quality 100: Best quality * Only valid when "h264_ratecontrolmode"= cbr and "quant"= 100.
Page 209 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) equal or greater than 0309a. s<0~(m-1)>_h2 <boolean> Enable "Dynamic intra frame period". 65_dintraperio * Only available when d_enable "capability_videoin_c<0~(n-1)>_dintra period_support" is 1 and h265 is listed in "capability_videoin_codec". * We support this parameter when the version number (httpversion) is equal or greater than 0301c.
Page 210 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "capability_videoin_codec". * Only valid when "h265_ratecontrolmode"= vbr and s<0~(m-1)>_h265_quant = 99. s<0~(m-1)>_h2 1~100 Select customized quality in a 65_qpercent normalized full range. 1: Worst quality 100: Best quality * Only available when h265 is listed in "capability_videoin_codec".
Page 211 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 1: Worst quality 100: Best quality * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "h265_ratecontrolmode"= cbr and "quant"= 100. s<0~(m-1)>_h2 20000~"capability_videoin The target bit rate in constant bit rate 65_bitrate _c<0~(n-1)>_h265_maxbit mode.
Page 212 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) q_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. s<0~(m-1)>_mj cbr, vbr cbr: Constant bit rate mode. peg_ratecontr vbr: Fixed quality mode, all frames are olmode...
Page 213 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only valid when "mjpeg_ratecontrolmode"= vbr and s<0~(m-1)>_mjpeg_quant = 100. s<0~(m-1)>_mj 20000~"capability_videoin The maximum allowed bit rate in fixed peg_maxvbrbit _c<0~(n-1)>_mjpeg_maxbi quality mode. rate trate" When the bit rate exceeds this value, frames will be dropped to restrict the bit rate.
Page 214 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) s<0~(m-1)>_mj 1~"capability_videoin_c<0 The maximum frame rates of a mjpeg peg_maxframe ~(n-1)>_mjpeg_maxframer stream at different ate" resolutions("capability_videoin_c<0~( n-1)>_resolution") are recorded in "capability_videoin_c<0~(n-1)>_mjpe g_maxframerate" s<0~(m-1)>_ra <boolean> Change resolution to fit 4:3 ratio. tiocorrect For PAL: D1/4CIF(720/704x576) ->...
Page 215 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) dependent> strength of WDR enhanced. * Only available when "capability_image_c<0~(n-1)>_wdrc_ mode" is 1 aespeed_mod <boolean> Turning AE converge speed on or off. 0: off <product 1: on dependent>...
Page 216 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "capability_image_c<0~(n-1)>_aespee dsupportsensitivity" is 1. flickerless <boolean> Turn on(1) or turn off(0) the flickerless <product mode dependent> * Only available when "capability_image_c<0~(n-1)>_flickerl ess" is 1. mounttype ceiling, wall, floor Hardware installation.
Page 217 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or Disable smart codec function mode autotracking,manual,hybri Set Smart stream mode "autotracking": only available when "capability_smartstream_mode_autot racking" is 1. "manual": only available when "capability_smartstream_mode_man ual"...
Page 218 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved n denotes the value of "capability_nvideoin",m denotes the value of " capability_nmediastream",k denotes the value of "capability_smartstream_nwindow_manual". NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the window. home 0~320,0~240 Left-top corner coordinate of the window.
Page 219 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n- re_minrange" != "-" 1)>_exposure_minrange" * Only valid when "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 =>...
Page 220 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n- image frame rate from sensor due to 1)>_exposure_maxrange" sensor generates a frame per 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 221 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 10: EV +1.3 11: EV +1.7 12: EV +2.0 *Only available when "capability_image_c0_exposure_mod e" != 0 exposuremode auto, Select exposure mode. "auto": Automatically adjust the Iris, <product shutterpriority, dependent>...
Page 222 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) means keep current white balance (Available values are listed status. b. if "rbgain" is supported, "rgain" "capability_image_c<0~(n- and "bgain" are updated to the 1)>_wbmode") current values which is got from white balance module.
Page 223 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "videoin_c<0~(n-1)>_whitebalance" ! = auto * Normalized range. maxgain 0~100 Maximum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_m axgain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range.
Page 224 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0302a. meteringmode auto, "auto": The algorithm chooses the blc, best metering strategy. "blc": This metering method increases the weight of dark area. * Available value is listed "hlc": The metering method can detect strong light and make affected...
Page 225 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) irismode fixed, indoor, outdoor Control DC-Iris mode. <product dependent> "outdoor": Auto-setting DC-Iris to get best quality, but easy to meet rolling or flicker effect in indoor environment. "indoor": Avoid rolling and flicker effect first.
Page 226 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) aespeed_mod <boolean> Turning AE converge speed on or off. 0: off <product 1: on dependent> * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1 aespeed_spee 1~100 The speed level of AE converge speed. dlevel 1~20: level 1 <product...
Page 227 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) dependent> * Only available when "capability_image_c<0~(n-1)>_flickerl ess" is 1 7.8.2 Multicast Settings for Video Streaming Group: videoin_c<0~(n-1)>_s<0~(m-1)>_multicast (capability_media_streamprofiles_support = 1) n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" NAME VALUE SECURITY(...
Page 228 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) c<0~(n-1)>_en <boolean> Enable time shift streaming. able * We support this parameter when the version number (httpversion) is equal or greater than 0312a. c<0~(n-1)>_s< <boolean> Enable time shift streaming for 0~(m-1)>_allo specific stream.
Page 229 VIVOTEK © 2021 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. daymodebegintime 00:00~23:59 Day mode begin time <Not * We replace this parameter with recommended to “ircutcontrol_c<0~(n-1)>_daymodebe use this>...
Page 230 VIVOTEK © 2021 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. enableextled <boolean> Enable/disable external IR led <Not * Only available when recommended to "capability_daynight_c<0~"capability_ use this>...
Page 231 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * We replace this parameter with “ircutcontrol_c<0~(n-1)>_bwmode” 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 232 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Available values are "ircutcontrol_illuminators_spectrum_ listed in mode" when the version number "capability_daynight_ (httpversion) is equal or greater than c<0~(n-1)>_spectrum 0312a. _mode". * We do not support this parameter when "capability_nvideoin >...
Page 233 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved equal or greater than 0312a. daymodebegintime 00:00~23:59 Day mode begin time * We support this parameter when the version number (httpversion) is equal or greater than 0312a. daymodeendtime 00:00~23:59 Day mod end time * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
Page 234 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.10.2 IR cut control Illuminators Group: ircutcontrol_illuminators (capability_daynight_c<0~(n-1)>_support > 0) n denotes the value of "capability_nvideoin" k is determined by the below criterion: The following applies for capability_extension_do_num >= 0 * if extension_connected=1, k=capability_ndo * if extension_connected=0, k=capability_ndo+ capability_extension_do_num Otherwise, * k=capability_ndo...
Page 235 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved "capability_daynight_illuminators_ext ernal_interface". * We support this parameter when the version number (httpversion) is equal or greater than 0312a. external_do<2~(k)>_ena <boolean> Enable/disable external led mounted bled on do<2~(k)>. * Only available when "capability_ndo >...
Page 236 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.11 Image Setting per Channel Group: image_c<0~(n-1)> for n channel products and m profile n denotes the value of "capability_nvideoin" and m denotes the value of "capability_nvideoinprofile" NAME VALUE SECURITY DESCRIPTION (get/set) brightness -5~5,100 -5: Darker <->...
Page 237 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. sharpness -3~3,100 -3: Softer <-> 3: Sharper <Not 100: Use "...
Page 238 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0: Softer <-> 100: Sharper * Only available when bit 3 of "capability_image_c<0~(n-1)>_basicse tting" is 1 gammacurve 0~100 0: Fine-turned gamma curve by <product Vivotek. dependent> 1: Gamma value = 0.01 2: Gamma value = 0.02 3: Gamma value = 0.03 100: Gamma value = 1...
Page 239 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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" is 1 defog_strength 1~100 Strength of defog <product * Only available when dependent>...
Page 240 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) lpchighway, auto, deblur, lpcfreeway, signallight, railtrack <product dependent> * Available values are listed in "capability_image_c< 0~(n-1)>_scenemode_ supporttype" restoreatwb <positive integer> Restore of adjusting white balance of image according to mode settings freeze <boolean>...
Page 241 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) lace_support" is 1. xoffset 0~100 Adjusting the image to proper position horizontally. * Only available when the bit 4 of capability_image_c<0~(n-1)>_basicset ting is 1. yoffset 0~100 Adjusting the image to proper position vertically.
Page 242 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * "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. _endtime profile_i<0~(m-1)> -5~5,100 -5: Darker <->...
Page 243 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) recommended to image_c<0~(n-1)>_saturationpercent" use this> * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicse tting" is 1. * We replace "profile_i0_saturation" with "profile_i0_saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 244 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) tting" is 1 profile_i<0~(m-1)> 0~100 Set saturation in the normalized _saturationpercent range. 0: Less saturation <-> 100: More saturation * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicse tting"...
Page 245 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <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" is profile_i<0~(m-1)> 1~100 Strength of 3DNR _dnr_strength * Only available when <product "capability_image_c<0~(n-1)>_dnr"...
Page 246 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_is_mod e". profile_i<0~(m-1)> 1~100 Strength of digital image stabilizer _dis_strength * Only available when 'dis' is listed in <product "capability_image_c<0~(n-1)>_is_mod dependent> e". 7.12 Exposure Window Setting per Channel Group: exposurewin_c<0~(n-1)>...
Page 247 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1 and when custom is listed in "capability_image_c<0~(n-1)>_exposure_winmode" and valid when "exposurewin_c<0~(n-1)>_mode"=custom or "exposurewin_c<0~(n-1)>_mode"=hlc) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the window. policy 0: Indicate exclusive. 1: Indicate inclusive.
Page 248 VIVOTEK © 2021 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 249 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1 and when custom is listed in "capability_image_c<0~(n-1)>_exposure_winmode" and valid when "exposurewin_c<0~(n-1)>_mode"=custom or "exposurewin_c<0~(n-1)>_mode"=hlc) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the window. policy 0: Indicate exclusive. 1: Indicate inclusive.
Page 250 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) homestd <0~9999,0~9999> Left-top corner coordinate of the window. * Only available when std is listed in "capability_image_c<0~(n-1)>_exposu re_windomain". sizestd <0~9999x0~9999> Width and height of the window. * Only available when std is listed in "capability_image_c<0~(n-1)>_exposu re_windomain".
Page 251 VIVOTEK © 2021 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 252 VIVOTEK © 2021 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 253 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 32000, 40000 s0_g726_bitstreamp little, big Set G.726 bit streaming packing ackingmode mode. little: Little-endian bitstream format. big: Big-endian bitstream format. * Only available if G.726 is supported. s0_g726_vlcmode 0, 1 Enable vlcmode for G.726.
Page 254 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.13.1. Multicast Settings for Audio Streaming Group: audioin_c<0~(n-1)>_s0_multicast (capability_naudioin > 0 and capability_media_streamprofiles_support = 1) n denotes the value of "capability_naudioin" NAME VALUE SECURITY( DESCRIPTION get/set) ipaddress <ip address> Multicast audio IP address. port 1025 ~ 65535 Multicast audio port.
Page 255 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) record. 7.16 Motion Detection Settings Group: motion_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable motion detection. win_sensitivity 0 ~ 100 Sensitivity of all motion detection...
Page 256 VIVOTEK © 2021 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 257 VIVOTEK © 2021 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 258 VIVOTEK © 2021 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 259 VIVOTEK © 2021 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 260 VIVOTEK © 2021 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 261 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.17 Tampering Detection Settings Group: tampering_c<0~(n-1)> for n channel products (capability_tampering > 0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable tamper detection. threshold 0~100 Threshold of tamper detection.
Page 262 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.18 DDNS Group: ddns (capability_protocol_ddns > 0) 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 263 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.21 UPnP Port Forwarding Group: upnpportforwarding NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP port forwarding service. upnpnatstatus The status of UPnP port forwarding, used internally. 0 = OK, 1 = FAIL, 2 = no IGD router, 3 = no need for port forwarding 7.22 System Log Group: syslog...
Page 264 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.23 SNMP Group: snmp (capability_protocol_snmp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) <boolean> SNMP v2 enabled. 0 for disable, 1 for enable <boolean> SNMP v3 enabled. 0 for disable, 1 for enable secnamerw string[31] Read/write security name...
Page 265 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) ek.com logo_powerbyvvtk_hidd <boolean> 0 => display the power by vivotek logo 1 => hide the power by vivotek logo custombutton_manualtr <boolean> Show or hide manual trigger (VI) igger_show button in homepage 0 ->...
Page 266 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) username=password is allowed, otherwise is not allowed. * We support this parameter when the version number (httpversion) is equal or greater than 0314b. defaultpassword_length 8 ~ 64 Allowed password length.
Page 267 VIVOTEK © 2021 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 268 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0 ~ 320,0 ~ 240, position. 0 ~ 320,0 ~ 240, (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 0 ~ 320,0 ~ 240 * Only available when "capability_image_c<n>_privacymask _wintype" = polygon. * Only available when qvga is listed in "capability_image_c<0~(n-1)>_privacy mask_windomain".
Page 269 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.26 3D Privacy Mask Group: privacymask3d_c<0~(n-1)> for n channel products and m privacy mask window. (capability_image_c<0~(n-1)>_privacymask_wintype = 3Drectangle) n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY DESCRIPTION...
Page 270 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.27 Capability Group: capability NAME VALUE SECURITY DESCRIPTION (get/set) api_httpversion <string> The version of VIVOTEK WebAPI with This number start 4 integers plus 1 alphabet, There are with 0301a. composed by "major version", "minor version", "revision","_platform".
Page 271 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 'M' and 'm' and 'k' are decimal digit from 0 to 9, while 'r' is an alphabetic. EX: 0302b_1 => Major version = 03, minor version = 02, revision = b, platform = 1 The 4 integer numbers are WebAPI version, we use short name:...
Page 272 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Number of digital inputs. <positive integer> Number of virtual inputs (manual <positive integer> trigger) Number of digital outputs. <positive integer> naudioin The number of audio input channel. 0 <positive integer>...
Page 273 VIVOTEK © 2021 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 0309a. ptzenabled 0, <positive integer> An 32-bit integer, each bit can be set separately as follows: Bit 0 =>...
Page 274 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) evctrlchannel <boolean> Indicate whether to support HTTP tunnel for event/control transfer. joystick <boolean> Indicate whether to support joystick control. remotefocus 0,<positive integer> An 4-bit integer, which indicates the <Not supportive application of recommended to...
Page 275 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) A 32-bits integer, each bit can be set separately as follows: Bit 0 => 1st stream supports ePTZ or not. Bit 1 => 2nd stream supports ePTZ or not, and so on.
Page 276 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) use this> "capability_daynight_c<0~(n-1)>_built inwled" when the version number (httpversion) is equal or greater than 0309d. iris <boolean> Indicate whether to support iris control. supportsd <boolean> Indicate whether to support local storage.
Page 277 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "backup" = Backing up recorded files. "smartsd" = Lifetime detection of SD card. "shockalarm" = Shock detection. "virestore" = Video input signal restore. "presetreached" = When any preset is reached "casingopen"...
Page 278 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) protocol_rtp_multi <boolean> Indicate whether to support scalable cast_scalable multicast. protocol_rtp_multi <boolean> Indicate whether to support cast_backchannel backchannel multicast. protocol_rtp_tcp <boolean> Indicate whether to support RTP over TCP. protocol_rtp_http <boolean>...
Page 279 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 1 => Progressive CCD 2 => CMOS videoin_nresolutio <positive integer> This equals "capability_videoin_c0_nresolution". * This is kept for compatibility. videoin_resolution A list of <WxH> This equals <product dependent> "capability_videoin_c0_resolution".
Page 280 VIVOTEK © 2021 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 281 VIVOTEK © 2021 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 282 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0: Not support 1: Support Bit 0 for CH0, bit 1 for CH1, and so on. audio_alarm <0~Positive Integer> 0: Not support audio alarm. 1: Support audio alarm. Bit 0 for CH0, bit 1 for CH1, and so on.
Page 283 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "g726": G.726 "-": Not supported. audioout_codec g711, - Available codec list for SIP. "-": Not supported. <product dependent> motion_wintype rectangle, polygon,- The supported motion window type. "polygon": The window is a 2D polygon shape.
Page 284 VIVOTEK © 2021 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 285 VIVOTEK © 2021 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 286 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * This is kept for compatibility. * Only available when capability_ptzenabled > 0 uart_httptunnel <boolean> Indicate whether to support HTTP tunnel for UART transfer. transmission_mod Indicate transmission mode of the machine: TX = server, Rx = receiver Both box, Both = DVR.
Page 287 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when "capability_network_wireless" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0305a. wireless_apmode_ <string> Indicate the prefix of broadcasted ssidprefix SSID when camera is in wireless AP mode.
Page 288 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) maxpostevent event occurred. media_snapshot_ <positive integer> Maximum size (KB) of a snapshot. maxsize media_videoclip_ <positive integer> Maximum size (KB) of a videoclip. maxsize media_videoclip_ <positive integer> Maximum length (second) of a maxlength videoclip.
Page 289 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) use this> focusassist "with "capability_image_c0_ focusassist". * Reserved for compatibility, and suggest don't use this since [httpversion] > 0301a localstorage_mana <boolean> Indicate whether manageable local geable storage is supported. * Only available when "capability_supportsd"...
Page 290 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_storage_dbenabled" is 1. localstorage_suppo An 32-bit integer, which indicates the rtedge <positive integer> supportive application of edge storage. If the value of this parameter is larger than 0, it means that the camera supports edge recording function.
Page 291 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) fisheyelocaldewarp 0, <positive integer> Indicate the supported streams of _c<0~(capability_n local dewarp. One bit represents videoin)-1> one supported stream. The LSB <product indicates stream 0. dependent> Ex: “3” means stream 0 and stream 1 support local dewarp.
Page 292 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) taics_level 0, <positive integer> Indicate the support level for Video Surveillance System Security from TAICS. * Only available when "capability_taics_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0314b.
Page 293 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.27.1 Capability for Camctrl Group: capability_camctrl_c<0~(n-1)> n denotes the value of "capability_nvideoin" (capability_ptzenabled > 0) * We support this group when the version number (httpversion) is equal or greater than 0303b. PARAMETER VALUE SECURITY DESCRIPTION...
Page 294 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) zoommodule <boolean> Indicate whether to support zoom lens. In our product, only SD series and IZ series use the zoom lens. * Both varifocal and zoom lenses are built with movable elements that permit changing the effective focal length.
Page 295 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) digitalzoom_support <boolean> Indicate the lens support digital zoom or not. * We support this parameter when the version number (httpversion) is equal or greater than 0317a. 7.27.2 Capability for PTZ Group: capability_ptz_c<0~(n-1)>...
Page 296 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) tiltspeedlv 0, <positive integer> 0/7 The maximum speed level of tilt motion. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" mintilt 0, <positive integer> 0/7 The lower limit for tilt position. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt"...
Page 297 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxdzoom 0, <positive integer> 0/7 The upper limit for digital zoom position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoomm odule" is "1" focusspeedlv 0, <positive integer> 0/7 The maximum speed level of focus motion.
Page 298 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) builtinwled <boolean> Indicate whether to support built-in white led. * We replaced this parameter with “capability_daynight_illuminators_builti n_type=whiteled” when the version number (httpversion) is equal or greater than 0312a. externalir <boolean>...
Page 299 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) ircutsensitivity_type <string> Indicate the cgi interface of "ircutcontrol_sensitivity". "options": the value of "ircutcontrol_sensitivity" parameter is "low, normal,high". "normalize": the value of "ircutcontrol_sensitivity" parameter is "1~100" "-":not support * Only available when "capability_daynight_c<0~(n-1)>_suppo rt"...
Page 300 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) spectrum_support <boolean> Indicate whether to support proposed a brightness enhancement method based on CCM(Color Correction Matrix) model to improve the brightness effect of the images if the IR and blue light exists. * Only available when "capability_daynight_c<0~(n-1)>_suppo rt"...
Page 301 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mode auto,daynight,di,di2, Indicate the day / night switch mode. di3,di4,schedule,- "auto": The Camera automatically <product judges the current operation mode by dependent> the level of ambient light detected. "daynight": support day mode and night mode.
Page 302 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.27.4 Capability for IR Illuminators Group: capability_daynight_illuminators PARAMETER VALUE SECURITY DESCRIPTION (get/set) 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.
Page 303 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved spectrum_support <boolean> Indicate whether to support proposed a brightness enhancement method based on CCM(Color Correction Matrix) model to improve the brightness effect of the images if the IR and blue light exists. * Only available when "capability_daynight_c<0~(n-1)>_support"...
Page 304 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved device sd, nas Indicate the supported storage devices. <product * Only available when dependent> "capability_storage_dbenabled" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. * Note: If “nas”...
Page 305 VIVOTEK © 2021 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 306 VIVOTEK © 2021 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 307 VIVOTEK © 2021 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 308 VIVOTEK © 2021 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 309 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mjpeg_maxframerate A list of <Positive Maximum fps that the device can encoded Integer> and "-" with MJPEG on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution".
Page 310 VIVOTEK © 2021 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 <product "capability_videoin_codec".
Page 311 VIVOTEK © 2021 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 312 VIVOTEK © 2021 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 313 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.27.7 Capability for Local Dewarp Group: capability_videoin_c<0~(n-1)>_localdewarp (capability_fisheyelocaldewarp_c<0~(capability_nvideoin)-1> > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) typeceilingmount 1O, 1P, 2P, 1R, 4R Available dewarp types of ceiling and floor mount.
Page 314 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) is_mode eis, Indicate this mode whether support dis, image stabilizer mode. "eis": electronic image stabilizer "dis": digital image stabilizer "-": not support * Only available when "capability_image_c<0~(n-1)>_eis" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0317a.
Page 315 VIVOTEK © 2021 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 316 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) effectivepixel <WxH> The visible area of full scene in this video mode. The unit is pixel in source. * If "effectivepixel"<"capability_videoin_c<0~ (n-1)>_maxsize", then the visible area is located at the center of full scene.
Page 317 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxresolution A list of <Integer> Represent supported maximum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream". minresolution A list of <Integer> Represent supported minimum resolution of each stream in current video mode.
Page 318 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxfps_mjpeg A list of <Positive Maximum fps which the device can Integer> and "-" encoded with MJPEG on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution".
Page 319 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxfps_h265 A list of <Positive Maximum fps which the device can Integer> and "-" encoded with H.265 on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution".
Page 320 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) equal or greater than 0311a. wdrpro_mode 0, 1, 2 0: Non-support WDR Pro 1: Support WDR Pro 2: Support WDR Pro II wdrpro_strength 0, 1 0: Non-support tuning strength of WDR Pro 1: Support tuning strength of WDR Pro * If...
Page 321 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) .hlc:hidden:, selections or values. exposuretime:hidd - (enabled) : UI is checked. en:, - (notsupport) : the affected function gaincontrol:hidden: is not available. - (onlyonce) : when wdrpro is enabled, flickerless:unchang wdrc is checked;...
Page 322 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) integer here. <product The format is "Affect API dependent> name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it.
Page 323 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 1: Support 3D digital noise reduction dnrstrength <positive integer> Indicate the support strength level of 3D digital noise reduction. * Only available when "capability_image_c<0~(n-1)>_dnr" > * We support this parameter when the version number (httpversion) is equal or greater than 0306d.
Page 324 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) is_supportlevel 0, <positive Indicate the support strength level of integer> image stabilizer mode. * Only available when "capability_image_c<0~(n-1)>_is_mod e" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 325 VIVOTEK © 2021 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 "capability_image_c<0~(n-1)>_is_mod e"...
Page 326 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) - (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 327 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) dependent> name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it.
Page 328 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) wbmode auto, Available white balance mode. panorama, "-" means white balance is not manual, supported. rbgain, widerange, outdoor,indoor, sodiumauto, <product dependent> iristype piris, Indicate iris type. dciris, "piris": P-Iris "dciris": DC-Iris "-": No Iris control support...
Page 329 VIVOTEK © 2021 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 330 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "maximum": The gain value can be up to the assigned value (videoin_c<0~(n-1)>_gainvalue) "ranged": Need two parameters to indicate the gain range. (videoin_c<0~(n-1)>_maxgain/ videoin_c<0~(n-1)>_maxgain) "-": not support. * Only available when "irispriority" or "shutterpriority"...
Page 331 VIVOTEK © 2021 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 332 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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 333 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) defaultgain:fixed:x "Policy" can be categorized into or others following groups: <x>: nonnegative - (disabled) : UI turns grey and users integer can't select it. <product - (unchanged) : UI keeps the status as dependent>...
Page 334 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) itymode_affect exposurewin.mode is enabled, some features may .blc:hidden:, become malfunction or be forced to a defog:disabled:, given value. The affected functions wdrpro:disabled:, are list here. exposurelevel:hidd The format is "Affect API en:, name":"Policy":"Description"...
Page 335 VIVOTEK © 2021 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 0305a. exposure_manualmod When exposure manual mode is e_affect exposurewin.mode enabled, some features may become .blc:hidden:,...
Page 336 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) integer or string or NULL. "-" means no feature is affected. * Only available when manual is listed in "capability_image_c<0~(n-1)>_ exposure_modetype" and "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 337 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) in "capability_image_c<0~(n-1)>_ exposure_winmode". exposure_hlcmode_af When hlc mode is enabled, some fect sir:hidden: features may become malfunction or or others be forced to a given value. The <x>: nonnegative affected functions are list here.
Page 338 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) exposure_mode" is 1 and hlc is listed in "capability_image_c<0~(n-1)>_ exposure_winmode". * We support this parameter when the version number (httpversion) is equal or greater than 0304a. exposure_wintype inclusive, The supported exposure window type.
Page 339 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) exposure_ntsc_totalra A list of <Positive Available total range for NTSC analog Integer> output. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0301a.
Page 340 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) value must be set to "-". * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_bracketing_ <boolean> 0: Non-support Auto Exposure mode Bracketing (AEB) 1: Support Auto Exposure Bracketing (AEB) Auto Exposure Bracketing (AEB) is a term that is used to signify a process...
Page 341 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) rectangle shape. privacymask_windom qvga, px, std, - The domain to set an window. "qvga": a 320x240 range to represent the whole image. "px": Locate a window in the image with pixels.
Page 342 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available.
Page 343 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <product "Policy" can be categorized into dependent> following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it.
Page 344 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) ivity of AE converge speed. 1: Support tuning the sensitivity of AE converge speed. * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1. gammacurve 0: Non-support tuning Gamma curve 1: Support tuning Gamma curve lowlightmode -,0,1...
Page 345 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) integer> focuswindow_range <leftrange,rightran Available range for focuswindow. ge,toprange,lowran * We support this parameter when ge> the version number (httpversion) is <product equal or greater than 0305d. dependent> *-: Not supported.
Page 346 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when capability_image_c<0~(n-1)>_deinterl ace_support is 1 lens_alignment <boolean> Indicate whether to support lens alignment function. * We support this parameter when the version number (httpversion) is equal or greater than 0309b.
Page 347 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) equal or greater than 0310a. focussystem_mode AFbyzoom, Supported features for remotefocus. focusshift, - "AFbyzoom": Trigger autofocus if <product zoom is operated. dependent> "focusshift": Ability to adjust day/night focus position. "-": Not supported.
Page 348 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) do_num <integer> The number of supported extension digital output module. * We support this parameter when the version number (httpversion) is equal or greater than 0316a. 7.28 Event Setting Group: event_i<0~(n-1)>...
Page 349 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) trigger boot, Indicate the trigger condition: "boot" = System boot. pir, "di"= Digital input. motion, "pir"= PIR detection. seq, "motion" = Video motion detection. recnotify, "seq" = Periodic condition. tampering, "visignal"...
Page 350 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mdwin0 0,<positive Similar to mdwin. The parameter takes integer> effect when profile 1 of motion detection is enabled. 0,<positive Indicate the source id of vi trigger. integer> This field is required when trigger condition is “vi”.
Page 351 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) weekday 0~127 Indicate which weekday is scheduled. One bit represents one weekday. bit0 (LSB) = Saturday bit1 = Friday bit2 = Thursday bit3 = Wednesday bit4 = Tuesday bit5 = Monday bit6 = Sunday For example, to detect events on Friday...
Page 352 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_do_i<0~(k-1)>_du 1~999 Duration of the digital output trigger in ration seconds. k is determined by the below criterion: The following applies for capability_extension_do_num >= 0 * if extension_connected=1, k=capability_ndo * if extension_connected=0, k=capability_ndo+...
Page 353 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_cf_backup <Boolean> Enable or disable the function that send media to SD card for backup if network is disconnected. * Only available when "capability_supportsd" > 0 action_server_i<0~4>_en <boolean>...
Page 354 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_autotrack_name string[40] Indicate the source name of smart <product dependent> tracking advanced when an event is triggered. * Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0, and the camera supports “Smart Tracking Advanced”...
Page 355 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) tampering 0,<positive Indicate the source channel id of integer> tampering detection. A 4-bit integer, each bit represents each channel. bit 0 => tampering detection for first channel. bit 1 =>...
Page 356 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) http_url string[128] URL of the HTTP server to upload. http_username string[64] Username to log in to the server. http_passwd string[64] Password of the user. ftp_address string[128] FTP server address. ftp_username string[64] Username to log in to the server.
Page 357 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.29.1. Server Setting for Event Action of sftp Group: server_i<0~4>_sftp * Only available when bit 1 of “capability_protocol_ftp_client” is 1. PARAMETER VALUE SECURITY DESCRIPTION (get/set) address string[128] Server address loginmode passwd, authentication method: publickey ”passwd”...
Page 358 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved publickey_downloadkeytype ed25519, The keytype used for key pair. rsa, "ed25519": faster to generate with ecdsa higher security level, some old server might not support. "rsa": slower to generate with slightly lower security level than ed25519. "ecdsa": low security level.
Page 359 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) snapshot_source 0~"capability_nmediastream Indicate the source of media "-1 stream. 0 means the first stream. 1 means the second stream and etc. 2 means the third stream and etc. 3 means the fourth stream and etc.
Page 360 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) videoclip_source 0~"capability_nmediastream Indicate the source of media "-1 stream. 0 means the first stream. 1 means the second stream and etc. 2 means the third stream and etc. 3 means the fourth stream and etc.
Page 361 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.31 Recording Group: recording_i<0~(n-1)> n denotes the value of "capability_nrecording" (capability_nrecording > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. trigger schedule, The event trigger type networkfail schedule: The event is triggered by schedule networkfail: The event is triggered by the failure of network connection.
Page 362 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxretentiontime <string> To specify the expired time for automatic clean up, and it only takes effect for video clip generated by recording_i <0~1>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss] S’ , similar with ISO8601 with symbols P Ex.
Page 363 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) weekday 0~127 Indicate which weekday is scheduled. One bit represents one weekday. bit0 (LSB) = Saturday bit1 = Friday bit2 = Thursday bit3 = Wednesday bit4 = Tuesday bit5 = Monday bit6 = Sunday For example, to detect events on Friday...
Page 364 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) adaptive_enable <boolean> Indicate whether the adaptive recording is enabled adaptive_preevent 0~9 Indicate when is the adaptive recording started before the event trigger point (seconds) adaptive_postevent 0~10 Indicate when is the adaptive recording stopped after the event trigger point (seconds) recordingjob_Sourc...
Page 365 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) stateorprovincen string[128] State or province name in the certificate information. localityname string[128] The locality name in thecertificate information. organizationname string[64] Organization name in the certificate VIVOTEK Inc. information.
Page 366 VIVOTEK © 2021 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 367 VIVOTEK © 2021 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. <product * If the minimal window size is 64x64, dependent>...
Page 368 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.35 ePTZ Setting Group: eptz_c<0~(n-1)> for n channel product. (capability_eptz > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) osdzoom <boolean> Indicates multiple of zoom in is <Not recommended to “on-screen display” or not. use this>...
Page 369 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) patrolseq string[120] The patrol sequence of ePTZ. All the patrol position indexes will be separated by "," patroldwelling string[160] The dwelling time (unit: second) of each patrol point, separated by “,”. preset_i<0~19>_name string[40] Name of ePTZ preset.
Page 370 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) win_i0_size <WxH> Width and height of the window. <product * The minimal window size is 192x144, dependent> and resolution_W and resolution_H is based on "capability_image_ c<0~(n-1)>_focuswindow_range" . 7.37 Seamless Recording Setting <Not recommended to use>...
Page 371 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxconnection Maximum number of connected seamless streaming. * We replace this parameter with “seamlessrecording_c<0~(n-1)>_maxconnecti on” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin >...
Page 372 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) guid<0~2>_number Number of connected seamless streaming with guid<0~(k-1)>_id. (Read only) * We replace this parameter with “seamlessrecording_c<0~(n-1)>_guid<0~2>_n umber” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin >...
Page 373 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved triggerrecord <boolean> Indicate whether seamless recording is recording to local storage or not at present. (Read only) * We support this parameter when the version number (httpversion) is equal or greater than 0312a. guid<0~(k-1)>_id string[127] The connected seamless streaming ID.
Page 374 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) resource_free_storage 0,<positive Indicate current free storage size for integer> uploading VADP modules. module_number 0,<positive Record the total module number that integer> already stored in the system. module_order string[40] The execution order of the enabled modules.
Page 375 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) string[120] The URL address of vadp hyperlink. status string[40] Value of “on” indicates a valid connection of vadp hyperlink. Value of “off” indicates a invalid connection of vadp hyperlink. 7.38.2.
Page 376 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) statmsg string[128] Indicate the message that will be show on the running status when mouse over. vvtklicensemec string[40] Indicate the module use VIVOTEK license mechanism 7.38.3. VADP Schedule Settings Group: vadp_schedule_i<0~(n-1)>...
Page 377 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.39 Camera PTZ Control Group: camctrl (capability_camctrl_ptztunnel > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enableptztunnel <boolean> Enable PTZ tunnel for camera control. Group: camctrl_c<0~(n-1)> for n channel products (capability_ptzenabled > 0) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset" NAME VALUE SECURITY...
Page 378 VIVOTEK © 2021 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 379 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) nual * Available values are listed in "capability_cam ctrl_c<0~(n-1)> _focusmode" uart Select corresponding uart "capability_nua (capability_nuart>0). rt"-1 * only available when capability_camctrl_c0_rs485=2 isptz 0 ~ 2 0: disable PTZ commands. 1: enable PTZ commands with PTZ driver.
Page 380 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) setting fixcurrent essential and should be grouped with “preset_i<0~(k-1)>_name.” * We support this parameter when the version number (httpversion) is equal or greater than 0305b. patrolseq string[120] (For external device) The indexes of patrol points, separated by “,”...
Page 381 VIVOTEK © 2021 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 382 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Available values are listed in "capability_camctrl_c <0~(n-1)>_focusmod e" preset_i<0~(k-1)>_name string[40] Name of the preset location. preset_i<0~(k-1)>_pan capability_ptz_c<0~( Pan position at each preset n-1)>_minpan ~ location. capability_ptz_c<0~( n-1)>_maxpan preset_i<0~(k-1)>_tilt capability_ptz_c<0~(...
Page 383 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) disablemdonptz <boolean> Disable motion detection on PTZ operation. defaulthome <boolean> This field tells system to use default home position or not. axisx capability_ptz_c<0~( Custom home pan position. n-1)>_minpan ~ capability_ptz_c<0~( n-1)>_maxpan...
Page 384 VIVOTEK © 2021 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 385 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) (httpversion) is equal or greater than 0317a. PTZ C LEASE REFER TO ONTROL 7.42 UART Control Group: uart (capability_nuart > 0 and capability_fisheye = 0) NAME VALUE SECURITY DESCRIPTION (get/set)
Page 386 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) set as 5 as well. uartmode rs485, RS485 or RS232. rs232 customdrvcmd_i<0~ string[128] PTZ command for custom camera. 9> * only available when capability_camctrl_c0_rs485=2 speedlink_i<0~4>_n string[40] Additional PTZ command name. * only available when capability_camctrl_c0_rs485=2 speedlink_i<0~4>_c...
Page 387 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) inputs with the corresponding ID. baudrate 2400,4800,9600,19 Set baud rate of COM port. 200,38400,57600,1 15200 databit 5,6,7,8 Data bits in a character frame. paritybit none, For error checking. odd, even "1": One stop bit is transmitted to...
Page 388 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) If you want to transfer the stopbit for 150% of the normal time used to transfer one bit, the uart_i<0~(n-1)>_stopbit should be set as 2 and the uart_i<0~(n-1)>_databit set as 5 as well.
Page 389 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved Group: lens_user_i<0~(n-1)> n denotes the value of "lens_user_totalnumbers" NAME VALUE SECURITY DESCRIPTION (get/set) name <string> User-defined lens name 7.46 Fisheye Info. Group: fisheyeinfo (capability_fisheye > 0) NAME VALUE SECURITY DESCRIPTION (get/set) revisedcenteraxis <coordinate>...
Page 390 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) s<0~(m-2)>_region_ 100~300 Zoom home ratio of regional view (for zoom 1R mode) s<0~(m-2)>_region_r -90~359 Pan home angle of regional view (for <0~(i-1)>_pan 4R mode, i is the view index and range from 0 to 3) Pan range of ceiling/floor mount is [0~359].
Page 391 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) objsize_type -1~2 Type of object size. -1 : customized width and height 0 : object size = 30 x 30 1 : object size = 10 x 20 2 : object size = 10 x 10 objsize_customized_w 10~320...
Page 392 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) encrypt none, Encryption method: wep, none: NONE, wpa, wep: WEP, wpa2 wpa: WPA, wpa2: WPA2PSK authmode OPEN, SHARED Authentication mode. * Only valid when "wireless_encrypt" is "wep" keylength 64, 128 Key length in bits.
Page 393 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.51 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 394 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) videoconfiguration_so c<0~(n-1)>s<0~(m-1) The videoconfiguration source for the urce > profile. Ex. videoconfiguration_source= * n denotes the value c<0~(n-1)>s<0~(m-1)> indicates video stream of channel n stream m is “capability_nvideoin, selected for the profile.
Page 395 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 7.53 Multicast Settings for Metadata Streaming 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.
Page 396 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) autotrack_index 0,<positive PTZ preset index with smart tracking integer> advanced of the receiving camera. * Only valid when the camera supports “Smart Tracking Advanced” feature. (Please refer to PTZ Control API for more details) * We support this parameter when the version number (httpversion) is equal or...
Page 397 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) autofocus_enablebyzoom <Boolean> To allow the feature of auto focus when zoom is operated. * Only available when capability_image_c<0~(n-1)>_focussyste m_mode=AFbyzoom 7.55.1. Save Day/Night Focus Position Group: focussystem_c<0~(n-1)> (capability_image_c<0~(n-1)>_remotefocus > 0 and capability_image_c<0~(n-1)>_focussystem_mode=focusshift) n denotes the value of "capability_nvideoin"...
Page 398 VIVOTEK © 2021 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?do0=<value> [&do1=<value>] [&do2=<value>][&do3=<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 399 VIVOTEK © 2021 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?di0 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n...
Page 400 VIVOTEK © 2021 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?do0 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n do0=1\r\n 8.4 Capture Single Snapshot Note: This request requires Normal User privileges.
Page 401 VIVOTEK © 2021 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 402 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION username <name> The name of the user to add, delete, or edit. userpass <value> The password of the new user to add or that of the old user to modify. The default value is an empty string. privilege view The privilege of the user to add or to modify.
Page 403 VIVOTEK © 2021 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 404 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 8.7 ePTZ Camera Control (capability_eptz > 0 and Capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eCamCtrl.cgi?channel=<value>&stream=<value> [&move=<value>] – Move home, up, down, left, right [&auto=<value>] – Auto pan, patrol [&zoom=<value>] –Zoom in, out [&zooming=<value>&zs=<value>] –Zoom without stopping, used for joystick [&x=<value>&y=<value>&w=<value>&h=<value>&resolution=<value>] - Zoom in, out on a specific...
Page 405 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved b. continuous movement - If you trigger a continuous movement, you have to handle the stop time by yourself. A continuous movement is convenient to integrate a joystick control. http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=tele&zs=1 http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed. To stop a continuous movement, you have to use the command as below: http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zoom=stop&zs=0 2.
Page 406 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION <integer> movement <integer> The scaled area size <integer> resolution <window size> The resolution of streaming. <integer> The direction of movement, used for joystick control. <integer> 0 ~ 7 Set the speed of movement, “0” means stop. <integer>...
Page 407 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 8.8 ePTZ Recall (capability_eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eRecall.cgi?channel=<value>&stream=<value>& recall=<value>[&return=<return page>] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source. stream <0~(m-1)>...
Page 408 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION addpos <Text string less than Add one preset location to the preset list. 40 characters> delpos <Text string less than Delete preset location from the preset list. 40 characters> return <return page>...
Page 409 VIVOTEK © 2021 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 410 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 8.12 Event/Control HTTP Tunnel Channel (capability_evctrlchannel > 0) Note: This request requires Administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/ctrlevent.cgi ------------------------------------------------------------------------- GET /cgi-bin/admin/ctrlevent.cgi x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------- POST /cgi-bin/admin/ ctrlevent.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled...
Page 411 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved Method: GET/POST Syntax: http://<servername>/<network_rtsp_s<0~(n*m)-1>_accessname> n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream". Example: For m=2, the values are shown as network_rtsp_s0_accessname = live1s1.sdp network_rtsp_s1_accessname = live1s2.sdp network_rtsp_s2_accessname = live2s1.sdp network_rtsp_s3_accessname = live2s2.sdp etc.
Page 412 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 8.15 Send Data (capability_nuart > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/senddata.cgi? [com=<value>][&data=<value>][&flush=<value>] [&wait=<value>] [&read=<value>] PARAMETER VALUE DESCRIPTION 1 ~ <max. com port The target COM/RS485 port number. number>...
Page 413 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved Ability to change database content from lsctrl.cgi was removed, lsctrl.cgi is changed to read-only. LEASE REFER TO TORAGE Syntax: http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=<cmd_type>[&<parameter>=<value>…] The commands usage and their input arguments are as follows. PARAMETER VALUE DESCRIPTION cmd_type <string>...
Page 414 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION A locked file would not be removed from UI or cyclic storage. triggerTime <text> Optional. Indicate the event trigger time. (not the file created time) Format is “YYYY-MM-DD HH:MM:SS” Please embrace your input value with single quotes.
Page 415 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved There are two cgi commands for download and composing jpegs to avi format. For download single selected file, you can use “/cgi-bin/admin/downloadMedias.cgi”. Just assign the request file path to this cgi. Syntax: http://<servername>/cgi-bin/admin/downloadMedias.cgi?<File_Path>...
Page 416 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION resolution <width>x<height> Resolution <positive integer> Frame rate list <fileList> The JPEG file list. The file path should be embraced by single quotation marks <servername> http:// /cgi-bin/admin/ jpegtoavi.cgi ?resolution=800x600&fps=1&list=’/mnt/auto/CF/NCMF/video1650.jpg’, ’/mnt/auto/C F/NCMF/video1651.jpg’, ’/mnt/auto/CF/NCMF/video1652.jpg’, 8.17 Virtual Input (capability_nvi >...
Page 417 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved Return Code Description The request is successfully executed. The request cannot be assigned, ex. incorrect parameters. Examples: setvi.cgi?vi0=0(10000)1(15000)0(20000)1 No multiple duration. setvi.cgi?vi3=0 VI index is out of range. setvi.cgi?vi=1 No VI index is specified. The resource is unavailable, ex.
Page 418 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE DEFAULT DESCRIPTION maxsft <positive Request cached stream at most how many seconds integer> ago. The value must be a positive integer. (>0) tsmode normal, normal Streaming mode: adaptive normal => Full FPS all the time. adaptive =>...
Page 419 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 8.19 RemoteFocus (capability_image_c<0~(n-1)>_remotefocus=1) Note: This request requires Administrator privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/admin/remotefocus.cgi?channel=<value>&[function=<value>][&direct ion=<value>][&position=<value>][&steps=<value>][&iris] PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. function zoom, zoom - Move focus motor focus –...
Page 420 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION steps 1 ~ 30 Motor’s moving steps. It works only if function=zoom or function=focus and direction=forward and direction=backward. * Motor will stop when it reaches to <motor_start> or <motor_end>. * This parameter is for additional fine-tune, the value is from 1 to 30.
Page 421 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved function getstatus Information of motors, return value as below: remote_focus_zoom_motor_max: Maximum steps of zoom motor remote_focus_focus_motor_max: Maximum steps of focus motor remote_focus_zoom_motor_start: Start point of zoom motor remote_focus_zoom_motor_end: End point of zoom motor remote_focus_focus_motor_start: Start point of effective focal length remote_focus_focus_motor_end: End point of effective focal...
Page 422 VIVOTEK © 2021 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 423 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved function getstatus Information of motors, return value as below: remote_focus_focus_motor_max: Maximum steps of focus motor remote_focus_focus_motor_start: Start point of effective focal length remote_focus_focus_motor_end: End point of effective focal length remote_focus_focus_motor: Current position of focus motor remote_focus_focus_enable: Current function of focus motor...
Page 424 VIVOTEK © 2021 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 425 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved Server will accept the file named <file name> to upload this one to camera. 8.23 Update Lens Configuration (capability_image_c<0~(n-1)>_lensconfiguration_support > 0) Note: This request requires Administrator privileges. Method: GET Syntax: For list a name of lens currently used: http://<servername>/cgi-bin/admin/update_lens.cgi?get_currentlens For list all names of lens installed in camera: http://<servername>/cgi-bin/admin/update_lens.cgi?list_lens...
Page 426 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved For upload user-defined lens configuration: http://<servername>/cgi-bin/admin/update_lens.cgi?upload_lens Post data: upload_lens_profile_input = <file name>\r\n \r\n <multipart encoded form data> Server will accept the file named <file name> to upload the lens profile to camera. 8.24 Media on Demand (capability_localstorage.modnum >...
Page 427 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved Play recordings for length seconds which ends at etime rtsp://10.10.1.2/mod.sdp?etime=20110312_040400.000&length=120 Play file file rtsp://10.10.1.2/mod.sdp?filename=/mnt/link0/ User's Manual - 427...
Page 428 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 8.25 3D Privacy Mask (Capability_image_c<0~(n-1)>_privacymask_wintype = 3Drectangle) n denotes the value of "capability_nvideoin" Note: This request requires admin user privilege Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/setpm3d.cgi?method=<value>&maskname=<value>&[maskhei ght=<value>&maskwidth=<value>&videosize=<value>&return=<return page>] PARAMETER VALUE DESCRIPTION method Add a 3D privacy mask at current location delete Delete a 3D privacy mask edit...
Page 429 VIVOTEK © 2021 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 430 VIVOTEK © 2021 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 431 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION focus auto Auto focus. Focus on further distance. near Focus on closer distance. focusseting sync Applies the selected focus mode in camctrl_c<0~(n-1)>_focusmode to this preset. fixcurrent Applies the current focus position to this preset. * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20.
Page 432 VIVOTEK © 2021 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 433 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmintiltangle <integer> Get the lower limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmaxtiltangle <integer> Get the upper limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt"...
Page 434 VIVOTEK © 2021 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 435 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 8.29 SmartSD (capability_localstorage_smartsd > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/smartsd.cgi?function=<value> User's Manual - 435...
Page 436 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function getstatus Function type getstauts : Information of smartSD internal status return value as below: smartsd_lifetime_num: Accumulated amount of data that has been written smartsd_lifetime_den: Card-guaranteed amount of data that can be written smartsd_lifetime_rate: The ratio of smartsd_lifetime_num to smartsd_lifetime_den.
Page 437: Technology License Notice
VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 8.30 Connect to AP (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION Apply the wireless settings and connect to AP. 8.31 Get Wireless Information (capability_network_wireless >...
Page 438: Electromagnetic Compatibility (Emc)
VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 8.32 Get Wireless Signal Strength (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/getwlsignalstrength.cgi METER 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...
Page 439 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved Example: http://myserver/cgi-bin/admin/peripheral.cgi?channel=0&operation=set&washer_mode=wiper& washer_status=on Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "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.
Page 440 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved [&heater_supportstatus] – Get heater support control status [&heater_status] – Get heater status Example: http://myserver/cgi-bin/admin/peripheral.cgi?channel=0&operation=get&supportdevice&washer_ status Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n 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.
Page 441 VIVOTEK © 2021 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 442 VIVOTEK © 2021 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. "set": set the strength of each IR LED separately operation set,...
Page 443 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=settoall&irmode=manual&str ength=100 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irstrength='100,100,100,100,100'" "optimizedir_c0_irmode='manual'" Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&irmode=auto&strength= 50,70,50,50,50 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: Parameter "irmode" must be set as "manual"! Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&strength=50,70,50,50,50 Response:...
Page 444 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=get [&support_irmode] – list all adjustment mode that IR supports [&irmode] – Get current IR mode [&irnum] – Get the number of IR zone PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. support_irmode List all adjustment mode that IR supports irmode...
Page 445 VIVOTEK © 2021 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 446 VIVOTEK © 2021 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 447 VIVOTEK © 2021 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 448 VIVOTEK © 2021 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 449 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved ERROR: The device does not exist or is busy ERROR: Formatted successfully, but cannot create database 8.39 for Accessing Streaming Methods 8.39.1 Get Stream URI (capability_media_streamprofiles_support = 1) Note: This request requires Viewer access privileges. Syntax: For RTSP, the user needs to input the URL below into a RTSP compatible player.
Page 450 VIVOTEK © 2021 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 451 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 8.40 Accessing SFTP server and client 8.40.1 SFTP server setting for event action * Only available when bit 1 of "capability_protocol_ftp_client" is 1. Syntax: (for control API) 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.
Page 452 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved fingerprint_enable <Boolean> Verify fingerprint * Default is 1. fingerprint_content <128-bit hash value> Fingerprint content * Required when fingerprint_enable=1. passphrase_enable <Boolean> Enable passphrase * Only valid when operation=manualmode and key=upload. passphrase_content <128-bit hash value > Passphrase * Only valid when operation=manualmode and key=upload.
Page 453 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved Content-Length: <Success Message Length>\r\n \r\n Request: http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=manualmode&key=download&index= 1&address=<ip>&username=xxx&fingerprint_enable=1&fingerprint_content=<MD5 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;...
Page 454 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved -----BEGIN RSA PRIVATE KEY----- Proc-Type: 4,ENCRYPTED DEK-Info: AES-128-CBC,E6B9F3F257EF2DA03BA8A4832BC6386F NYzaqdoY7OxS0XhviOKncGbMLpnx6n3VRYbeArSBwn+6wA7Y4lknFoMQiuC4HrCa oHgEex609584TWFBrkR+DfqKB73RCALTeAqAhEtywq75KQTWyHJcpOu8qZxquoKE 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--...
Page 455 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION operation getserverhostkey " getserverhostkey ": Auto scan SFTP server host key. * This field is required. address <sftp server address or hostname> sftp server address or hostname * This field is required. Example of scanning SFTP server host key: Request: http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=getserverhostkey&address=<ip>...
Page 456 VIVOTEK © 2021 VIVOTEK INC. All Right Reserved 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 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”...
Page 457 VIVOTEK Technology License Notice AMR-NB Standard THIS PRODUCT IS LICENSED UNDER THE AMR-NB STANDARD PATENT LICENSE AGREEMENT. WITH RESPECT TO THE USE OF THIS PRODUCT, THE FOLLOWING LICENSORS’ PATENTS MAY APPLY: TELEFONAKIEBOLAGET ERICSSON AB: US PAT. 6192335; 6275798; 6029125; 6424938; 6058359. NOKIA CORPORATION: US PAT.
Page 458 VIVOTEK Electromagnetic Compatibility (EMC) FCC Statement This device compiles with FCC Rules Part 15. Operation is subject to the following two conditions. ■ This device may not cause harmful interference, and ■ This device must accept any interference received, including interference that may cause undesired operation.

Delta Vivotek IT9389-H-v2 User Manual

Quick Links

Related Manuals for Delta Vivotek IT9389-H-v2

Summary of Contents for Delta Vivotek IT9389-H-v2

Table of Contents