Page 1 MD9584-H Mobile Network Camera User ’s Manual 5MP • Outdoor • IP66 • IK10 • Day & Night • Trend Micro Virus Protection • IK10+ • EN50155 2017 OT4, IEC60571, EN61373, EN50121-3-2, EN50121-4, EN50132-7, IEC62236-3-2, EN45545 HL3 (2020) ECE R118, EN50124-1, EN50498, WDR Pro • Smart Stream III • 50M Smart IR • EN62676-4, IEC/EN62471, NEMA 4x, IP68, IP6K9K Rev.
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 ............................. 9 Software Installation ............................. 15 Network Deployment ............................24 Ready to Use ................................
Page 3: Overview
VIVOTEK Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) ... 145 Recording > Recording settings ......................148 Storage ..............................153 Storage > NAS management ........................154 Storage > Content management ......................156 Appendix ..............................URL Commands for the Network Camera ....................159 Technology License Notice ........................
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 ■ MD9584-H ■ Screw pack and T20 wrench. ■ Quick Installation Guide. ■ Alignment sticker. ■ DI/DO combo cable (separately purchased).. WARNING: 1. IR lights emit from this product. 2. Use appropriate shielding or eye protection. Symbols and Statements in this Document INFORMATION: provides important messages or advices that might help prevent inconvenient or problem situations.
Page 6: Physical Description
VIVOTEK Physical Description Outer View IR LEDs Lens Inner View Lens MicroUSB - reserved Tilt retention screw IR LEDs 6 - User's Manual...
Page 7 VIVOTEK MicroSD card slot Reset button LEDs User's Manual - 7...
Page 8 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 Power Input: Camera: PoE (IEEE 802.3af Class 0) Heater: DC 24V 1.
Page 9: Hardware Installation
VIVOTEK Hardware Installation 1. Jot down the camera's MAC address for later reference. XXXXXX 0002D10766AD 2. Loosen the T20 screws on the top cover. User's Manual - 9...
Page 10 VIVOTEK 3. Install an SD card if onboard storage is preferred. Refer to below if you purchased a customized version that comes with the DI/DO combo cable. Optional DI/DO cable Name DO+ (12V, max. 50mA) DI+ (any input <30V) DI- GND Name L-OUT Name...
Page 11 VIVOTEK Below are the pinouts of the M12 cables. M12 Ethernet D-coded female RxData+ TxData+ RxData- TxData- M12 Power A-coded male +24V DC +24V DC Not used The IR light coverage angles are as follows: 0 ~ 70° 100° User's Manual - 11...
Page 12 VIVOTEK 4. Select a preferred position for installation. Use the alignment sticker to mark the mounting holes. 5. Drill holes for mounting the camera, and also drill a hole for routing the cables. Ø ≥20mm Ø 6mm 12 - User's Manual...
Page 13 VIVOTEK 6.Connect a ground wire to the bottom of the camera. Grounding M6 Optional Grounding M8 Do not loosen. IMPORTANT: Below are things to notice connecting a ground wire: 1. The minimum ground screw type is M8 screw. 2. The minimum ground wire gauge is 18AWG. 3.
Page 14 VIVOTEK 7.Secure the camera by driving 4 M6 screws. NOTE: Installation mounitng screws 4xM6 recommended torque value 39.2 ~ 49 kgf.cm 8. 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.
Page 15: Software Installation
VIVOTEK Software Installation 9. 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. 9-1.
Page 16 VIVOTEK 9-3. The program will search for all VIVOTEK network devices on the same LAN. 9-4. After a brief search, the installer window will prompt. Click on the MAC and model name that matches the one printed on the product label. You can then double-click on the address to open a management session with the Network Camera.
Page 17 VIVOTEK Forceful Password Configuration 10. The first time you log in to the camera, the firmware will prompt for a password configuration for security concerns. 10-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 18 VIVOTEK Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~. You can use them in the password combination. 10-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 19 VIVOTEK Hardware Reset The reset button is used to reset the system or restore the factory default settings. Sometimes resetting the system can return the camera to normal operation. If the system problems remain after reset, restore the factory settings and install again. Reset: Press the recessed reset button.
Page 20 VIVOTEK If the need should arise, rotate the lens module to find the best field of view for your application. ±90° 20 - User's Manual...
Page 21 VIVOTEK 11. If you need to tilt the lens, loosen the retention screws on the sides, tilt the angle, and then fasten the screws. 0 ~ 30° 12. When done, install the top cover by fastening the 4 T20 screws. User's Manual - 21...
Page 22 VIVOTEK Note the following when routing the cables. Cable BEND RADIUS HL3: min. bend radius 72mm (10x O.D.) during installation 36mm (5x O.D.) during operation 22 - User's Manual...
Page 23 VIVOTEK You can also rotate the image using the firmware function. 90° 270° User's Manual - 23...
Page 24: 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 25: 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 26 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 27 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 28: 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 29 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 104.
Page 30 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 31: Using Rtsp Players
VIVOTEK Using RTSP Players To view the streaming media using RTSP players, you can use one of the following players that support RTSP streaming. VLC media player VLC media player mpegable Player 1. Launch the RTSP player. 2. Choose File > Open URL. A URL dialog box will pop up. pvPlayer 3.
Page 32: Using 3Gpp-Compatible Mobile Devices
VIVOTEK Using 3GPP-compatible Mobile Devices To view the streaming media through 3GPP-compatible mobile devices, make sure the Network Camera can be accessed over the Internet. For more information on how to set up the Network Camera over the Internet, please refer to Setup the Network Camera over the Internet on page To utilize this feature, please check the following settings on your Network Camera: 1.
Page 33: Using Vivotek Recording Software
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 34: 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. Digital zoom is only available in the Liveview profile. Resize Buttons VIVOTEK INC.
Page 35 VIVOTEK Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 39. 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 36 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 119 for detailed information. Global View: Click on this item to display the Global View window. The Global View window contains a full view image (the largest frame size of the captured video) and a floating frame (the viewing region of the current video stream).
Page 37 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 38 VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Time 2018/07/25 17:08:56 Video (HTTP-V) Title and Time Video 17:08:56 2018/07/25 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 63.
Page 39: 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 40 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 41 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 42 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 43 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 44: 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 45: 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 46 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 47 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 48: 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 49 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 50 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 51: 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 52 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 53 VIVOTEK Access log Access log displays the access time and IP address of all viewers (including operators and administrators) in a chronological order. The access log is stored in the Network Camera’s buffer area and will be overwritten when reaching a certain limit. Set Parameter log VADP log contains the history of changes made to system parameters such as recording, imaging parameters, and all other parameters.
Page 54: 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. 54 - User's Manual...
Page 55: 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 56 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 85). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
Page 57 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 58: 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, Privacy mask, and Pixel Calculator. The Focus window is available only for models that come with motorized lens.
Page 59 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 60 VIVOTEK IR cut filter With a removable IR-cut filter, this Network Camera can automatically remove the filter to let Infrared light pass into the sensor during low light conditions. ■ Auto mode (The Day/Night Exposure Profile will not be available if Auto mode is selected) The Network Camera automatically removes the filter by judging the level of ambient light.
Page 61 VIVOTEK Illuminators Turn on built-in IR illuminator in night mode Select this to turn on the camera’s onboard IR illuminator when the camera detects low light condition and enters the night mode. Connector type You might use an external IR illuminator triggered by a digital output. Select this option when used. 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 62 VIVOTEK Tips: If there is an object in close proximity, the IR lights reflected back from it can mislead the Smart IR’s calculation of light level. To solve this problem, you can place an “Exposure Exclude” window on an unavoidable object in the Exposure setting window. See page 66 for how to do it.
Page 63 VIVOTEK Image settings On this page, you can tune the White balance and Image adjustment. Sensor Setting 2: For special situations Sensor Setting 1: For normal situations White balance: Adjust the value for the best color temperature. ■ You may follow the steps below to adjust the white balance to the best color temperature. 1.
Page 64 VIVOTEK Highlight mask ■ Strong light sources will be masked from the scene, and the image contrast will be strengthened. This function is useful to prevent the spot-light effects in a high dynamic scene. False color may be observed around the edges of strong light sources. Noise reduction ■...
Page 65 VIVOTEK Exposure On this page, you can set the Exposure measurement window, Exposure level, Exposure mode, Exposure time, Gain control, and Day/Night mode settings. You can configure two sets of Exposure settings: one for normal situations, the other for special situations, such as the day/night/schedule mode.
Page 66 VIVOTEK The inclusive window refers to the “weighted window“; the exclusive window refers to “ignored window“. It adopts the weighted averages method to calculate the value. The inclusive windows have a higher priority. You can overlap these windows, and, if you place an exclusive window within a larger inclusive window, the exclusive part of the overlapped windows will be deducted from the inclusive window.
Page 67 VIVOTEK Exposure control: ■ Exposure level: You can manually set the Exposure level, which ranges from -2.0 to +2.0 (dark to bright). You can click and drag the semi-circular pointers on the Exposure time and Gain control slide bars to specify a range of shutter time and Gain control values within which the camera can automatically tune to an optimal imaging result.
Page 68 VIVOTEK You can click Restore to recall the original settings without incorporating the changes. When completed with the settings on this page, click Save to enable the settings. If you want to configure another sensor setting for day/night/schedule mode, please click Profile to open the Profile of exposure settings page as shown below.
Page 69 VIVOTEK Privacy mask Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to address privacy concerns. ■ To configure privacy mask windows, 1. Click 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 70: 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 ratio, with the WDR function enabled. ■ 4-Megapixel (16:9)(MAX 30fps) (WDR Pro): This is the full resolution at 4 megapixels in a 16:9 screen aspect ratio, with the WDR function enabled.
Page 71: Media > Video
VIVOTEK Media > Video Stream settings This Network Camera supports multiple streams with frame sizes ranging from 640 x 480 to 2560 x 1920 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 72: Media > Video
VIVOTEK Please follow the steps below to set up the configurable 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 Gloabl View window on the home page, will resize accordingly.
Page 73 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 Codec) for real-time viewing. If the H.265 H.264 mode is selected, the video is streamed via...
Page 74 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 75 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 76 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 77 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 78 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 79 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 80 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 81: Media > Audio
VIVOTEK Media > Audio Audio Settings Mute: Select this option to disable audio transmission from the Network Camera to all clients. Note that if muted, no audio data will be transmitted even if audio transmission is enabled on the Client Settings page.
Page 82 VIVOTEK Audio clips ■ Output gain: Use the slide bar to change the audio output gains value. ■ Audio clip: When the camera's audio input is connected to a microphone, you can record a short period of audio recordings (1 to 10 seconds). You can also use the camera's embedded microphone to record an audio clip, if available.
Page 83: 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 84: 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 85 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 86 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 87 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 88 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 89 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 90 VIVOTEK 90 - User's Manual...
Page 91: 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 92 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 93 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 94 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 95 VIVOTEK SIP is short for Session Initiation Protocol. If necessary, you can change the default port number, 5060, to one between 1025 and 65535. Two way audio port: By default, the two way audio port is set to 5060. Also, it can also be assigned to another port number between 1025 and 65535.
Page 96 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 97 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 98 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 99 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 100 VIVOTEK QoS/DSCP (the DiffServ model) DSCP-ECN defines QoS at Layer 3 (Network Layer). The Differentiated Services (DiffServ) model is based on packet marking and router queuing disciplines. The marking is done by adding a field to the IP header, called the DSCP (Differentiated Services Codepoint). This is a 6-bit field that provides 64 different class IDs.
Page 101: 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 102: 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 103: 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 104: Security > User Accounts
VIVOTEK Security > User accounts This section explains how to enable password protection and create multiple accounts. Account management The administrator account name is “root”, which is permanent and can not be deleted. If you want to add more accounts in the Account management window, please apply the password for the “root” account first.
Page 105 VIVOTEK Privilege management 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. (Please refer to Configuration on page 44).
Page 106: 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 107 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 108 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 109 VIVOTEK 5. Look for a trusted certificate authority, such as Symantec’s VeriSign Authentication Services, that issues digital certificates. Sign in and purchase the SSL certification service. Copy the certificate request from your request prompt and paste it in the CA’s signing request window. Proceed with the rest of the process as CA’s instructions on their webpage.
Page 110 VIVOTEK 7. Open a new edit, paste the certificate contents, and press ENTER at the end of the contents to add an empty line. 8. Convert file format from DOS to UNIX. Open File menu > Conversions > DOS to Unix. 110 - User's Manual...
Page 111 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 - 111...
Page 112 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 113: 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 114 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 115 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 116 VIVOTEK Security > IEEE 802.1X Enable this function if your network environment uses IEEE 802.1x, which is a port-based network access control. The network devices, intermediary switch/access point/hub, and RADIUS server must support and enable 802.1x settings. The 802.1x standard is designed to enhance the security of local area networks, which provides authentication to network devices (clients) attached to a network port (wired or wireless).
Page 117 VIVOTEK 3. When all settings are complete, move the Network Camera to the protected LAN by connecting it to an 802.1x enabled switch. The devices will then start the authentication automatically. NOTE: ► The authentication process for 802.1x: 1. The Certificate Authority (CA) provides the required signed certificates to the Network Camera (the supplicant) and the RADIUS Server (the authentication server).
Page 118 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 119: Ptz > Ptz Settings
VIVOTEK PTZ > PTZ settings This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation. Digital: Control the e-PTZ operation. Within a field of view,it allows users to quickly move the focus to a target area for close-up viewing without physically moving the camera. Digital PTZ Operation (E-PTZ Operation) The e-PTZ control settings section will be displayed as shown below: 2015/05/20 09:57:30...
Page 120 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 121 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 122 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. 122 - User's Manual...
Page 123: 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 124 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 125 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 143 for detailed information. ■...
Page 126 VIVOTEK Once the triggers are configured, they will be listed under the VADP option. 3. Action Define the actions to be performed by the Network Camera when a trigger is activated. ■ Trigger digital output for seconds Select this option to turn on the external digital output device when a trigger is activated. Specify the length of the trigger interval in the text box.
Page 127 VIVOTEK ■ Play audio clip: A pre-loaded audio clip can be configured to be played when one triggering condition is met. For example, playing a warning message to deter an intruder. ■ Configure CameraLink The camera can be associated with another camera with responsive actions. For example, if a thermal camera detects some abnormal situations, e.g., a fire, the camera can tell another camera, say, a PTZ camera to move to a preset position to observe the current situation.
Page 128 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 129 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 130 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 131 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 132 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 133 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 134 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 151 for details. Note that only one NAS server can be configured. Click Save server to enable the settings. ■...
Page 135 VIVOTEK Click 20190120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2019/01/20 2019/01/20 Click to go back to the previous Click to delete level of the directory selected items Click to delete all recorded data 2019/01/20 2019/01/20...
Page 136 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 137 VIVOTEK ■ Add date and time suffix to the file name Select this option to add a date/time suffix to the file name. For example: Snapshot_20190513_100341 File name preﬁx Date and time sufﬁx The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings. Note that after you set up the first media server, a new column for media server will automatically display on the Media list.
Page 138 VIVOTEK ■ Maximum file size Specify the maximum file size allowed. Some users may need to stitch the video clips together when searching and packing up forensic evidence. ■ File name prefix Enter the text that will be appended to the front of the file name. For example: Video_20190513_100341 File name preﬁx...
Page 139 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 140: Applications > Motion Detection
VIVOTEK Applications > Motion detection The camera comes with a Smart Motion Detection utility as its pre-loaded VCA package. Please refer to its User Guide for more information: http://download.vivotek.com/downloadfile/solutions/vadp/smart-motion-detection-manual_ en.pdf. Click on Configuration > Applications > Motion detection. The Smart Motion utility will be automatically started.
Page 141: 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 142: Applications > Di And Do
VIVOTEK Applications > DI and DO Digital input: Select High or Low to define normal status for the digital input. Connect a digital input from a sensor device to the camera, the Network Camera will report the current signal status. You may then configure the Normal status (non-trigger status) as High or Low.
Page 143: 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 144: 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 145: Applications > Package Management - A.k.a., Vadp (Vivotek Application Development Platform)
VIVOTEK Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) The camera comes 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. To learn more about this feature, download its User Guide in: http://download.vivotek.com/downloadfile/solutions/vadp/smart-motion-detection-manual_ en.pdf...
Page 146 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 147 VIVOTEK On the License page, register and activate the license for using VIVOTEK's VADP modules. You should acquire the license key elsewhere, and manually upload to the network camera. Follow the onscreen instruction on VIVOTEK's website for the registration procedure. User's Manual - 147...
Page 148: 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 149 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 150 VIVOTEK 2. Destination You can select the SD card or network storage (NAS) for the recorded video files. If you have not configured a NAS server, see details in the following. NAS server Click Add NAS server to open the server setting window and follow the steps below to set up: 1.
Page 151 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 152 VIVOTEK Event f you want to enable recording notification, please click to configure event triggering settings. Please refer to Event > Event settings on page 123 for more details. When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page.
Page 153: 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 154: 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 155 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 156: 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 157 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 158 VIVOTEK ■ Lock/Unlock: Select the checkbox in front of a desired search result, then click this button. The selected items will become Locked, which will not be deleted during cyclic recording. You can click again to unlock the selections. For example: Click to switch pages ■...
Page 159: 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 160 VIVOTEK © 2022 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 161 VIVOTEK © 2022 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 162 VIVOTEK © 2022 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 163 VIVOTEK © 2022 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 - 163...
Page 164 VIVOTEK © 2022 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 165 VIVOTEK © 2022 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 - 165...
Page 166 VIVOTEK © 2022 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 167 VIVOTEK © 2022 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 168 VIVOTEK © 2022 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 169 VIVOTEK © 2022 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 170 VIVOTEK © 2022 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 171 VIVOTEK © 2022 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 172 VIVOTEK © 2022 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 173 VIVOTEK © 2022 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 174 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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 * if extension_connected=0,...
Page 175 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) integer> eth_i0 <string> Get network information from mii-tool. vi_i<0~(capability_nvi-1)> <boolean> Virtual input <product dependent> 0 => Inactive 1 => Active (capability_nvi > 0) 7.2.1 Status per Channel Group: status_c<0~(n-1)>...
Page 176 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.4 Digital Output Behavior Define Group: do_i<0~(k-1)> for k 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 * if extension_connected=0, k=capability_ndo+ capability_extension_do_num Otherwise, * k=capability_ndo...
Page 177 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.6 Network Group: network NAME VALUE SECURITY DESCRIPTION (get/set) preprocess <positive integer> An 32-bit integer, each bit can be set separately as follows: Bit 0 => HTTP service; Bit 1=> HTTPS service; Bit 2=>...
Page 178 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0 => Use preset ipaddress, subnet, rounter, dns1, and dns2. ipaddress <ip address> IP address of server. subnet <ip address> Subnet mask. router <ip address> Default gateway. dns1 <ip address>...
Page 179 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.6.2 QOS Subgroup of network: qos_cos (capability_protocol_qos_cos > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable CoS (IEEE 802.1p) vlanid 1~4095 VLAN ID video Video channel for CoS audio Audio channel for CoS <product dependent>...
Page 180 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.6.4 FTP Subgroup of network: ftp NAME VALUE SECURITY DESCRIPTION (get/set) port 21, 1025~65535 Local ftp server port. enable <boolean> Enable ftp. 7.6.5 HTTP Subgroup of network: http NAME VALUE SECURITY DESCRIPTION (get/set) port 80, 1025 ~...
Page 181 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY...
Page 182 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 65535 7.6.8 RTSP Subgroup of network: rtsp (capability_protocol_rtsp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 554, 1025 ~ 65535 RTSP port. (capability_protocol_rtsp=1) authmode disable, RTSP authentication mode. basic, (capability_protocol_rtsp=1) digest s<0~(capability_nmed string[32] RTSP access name for channel and iastream*capability_n...
Page 183 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) live1s1.sdp = c0_s0_accessname, (channel1stream1) live1s2.sdp = c0_s1_accessname, (channel1stream2) live1s3.sdp = c0_s2_accessname, (channel1stream3) live1s4.sdp = c0_s3_accessname, (channel1stream4) etc. * Values start with prefix “cgi-bin” are prohibited. For example, “c, cg, cgi, cgi-, cgi-b, cgi-bi, cgi-bin”...
Page 184 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Reserved for compatibility, and suggest don't use this since [httpversion] > 0304a videoipaddress <ip Multicast video IP address. address> * We support this parameter when the version number (httpversion) is equal or greater than 0304a.
Page 185 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) videoport 1025 ~ 65535 Video channel port for RTP. audioport 1025 ~ 65535 Audio channel port for RTP. metadataport 1025 ~ 65535 Metadata channel port for RTP. 7.6.12 PPPoE Subgroup of network: pppoe (capability_protocol_pppoe >...
Page 186 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.7 IP Filter Group: ipfilter NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable access list filtering. admin_enable <boolean> Enable administrator IP address. admin_ip string[43] Administrator IP address. maxconnection Maximum number of (s). "capability_protoc ol_maxconnection"...
Page 187 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) after the version number (httpversion) is equal or greater than 0400a. whitebalance auto, Modes of white balance. "auto": Auto white balance <product dependent> panorama, manual, "panorama": indicates that camera rbgain, would try to balance the white widerange,...
Page 188 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) The definition is: 0: EV -2.0 1: EV -1.7 2: EV -1.3 3: EV -1.0 4: EV -0.7 5: EV -0.3 6: EV 0 7: EV +0.3 8: EV +0.7 9: EV +1.0 10: EV +1.3...
Page 189 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) after the version number (httpversion) is equal or greater than 0400a. enableblc <boolean> Enable backlight compensation. <Not support * Not support this parameter anymore> anymore when the version number (httpversion) is equal or greater than 0301a.
Page 190 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) n"=1 * 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. ptzstatus 0,<positive A 32-bit integer, each bit can be set...
Page 191 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) is equal or greater than 0400a. minexposure <1~32000>, Minimum exposure time <product dependent> <5~32000>, 1~32000 => 1s ~ 1/32000s <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc.
Page 192 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) re_maxrange" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 193 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "auto": Auto white balance <product panorama, dependent> manual, "panorama": indicates that camera rbgain, would try to balance the white widerange, balance effect of every sensor. "rbgain": Use rgain and bgain to set outdoor, indoor, white balance manually.
Page 194 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) bgain 0~100 Manual set bgain 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 195 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) with variable Shutter Speed, and keep adjusting Iris, Gain automatically. (Available options are list "irispriority": Manually adjust with variable Iris, and keep adjusting Gain "capability_image_c<0~(n- and Shutter speed automatically. 1)>_exposure_modetype") "qualitypriority": Automatically adjust the Iris, Gain and Shutter Speed...
Page 196 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "-": not support. (only available when "capability_image_c<0~(n-1)>_sensor type" is "smartsensor") * Only available when "capability_image_c<0~(n-1)>_iristype "=piris piris_position 1~100 Manual set P-Iris. <product 1: Open <-> 100: Close dependent>...
Page 197 VIVOTEK © 2022 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_mi ngain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype"...
Page 198 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) function; 0(not support), 1(support) Bit 1 =>Built-in or external camera; 0 (external), 1(built-in) Bit 2 => Support pan operation; 0(not support), 1(support) Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 =>...
Page 199 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "capability_image_c<0~(n-1)>_exposu "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 200 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Available value is listed * This parameter may also restrict image frame rate from sensor due to "capability_image_c<0~(n- sensor generates a frame per 1)>_exposure_maxrange" exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.
Page 201 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) zoomratiodispl <boolean> Indicates multiple of zoom in is “on-screen display” or not. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. bracketing_lev 1~100 The total available lists...
Page 202 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) n-1)>_maxresolution" and "capability_videoin_c<0~( n-1)>_minresolution" s<0~(m-1)>_s <boolean> Enable "Smart fps" function. martfps_enabl * Only available when "capability_videoin_c<0~(n-1)>_smart fps_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309a.
Page 203 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) library directly. * Only valid when "h264_ratecontrolmode"= vbr and s<0~(m-1)>_h264_quant = 99. s<0~(m-1)>_h2 1~100 Select customized quality in a 64_qpercent normalized full range. 1: Worst quality 100: Best quality * Only valid when "h264_ratecontrolmode"= vbr and "quant"= 100.
Page 204 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 64_bitrate _c<0~(n-1)>_h264_maxbit mode. rate" * Only valid when "h264_ratecontrolmode"= cbr s<0~(m-1)>_h2 framerate,imagequality Set prioritypolicy 64_prioritypoli * Only valid when "h264_ratecontrolmode"= cbr s<0~(m-1)>_h2 1~"capability_videoin_c<0 The maximum frame rates of a H264 64_maxframe ~(n-1)>_h264_maxframera stream at different...
Page 205 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 65_intraperiod 3000, 4000 I-frames (Intra coded picture). The unit is millisecond (ms). * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_h2 cbr, vbr cbr: Constant bit rate mode. 65_ratecontrol vbr: Fixed quality mode, all frames are mode...
Page 206 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only valid when "h265_ratecontrolmode"= vbr and "quant"= 100. s<0~(m-1)>_h2 20000~"capability_videoin The maximum allowed bit rate in fixed 65_maxvbrbitr _c<0~(n-1)>_h265_maxbit quality mode. rate" When the bit rate exceeds this value, frames will be dropped to restrict the bit rate.
Page 207 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) rate" * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "h265_ratecontrolmode"= cbr s<0~(m-1)>_h2 framerate,imagequality Set prioritypolicy 65_prioritypoli * Only available when h265 is listed in "capability_videoin_codec".
Page 208 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) Set the pre-defined quality level: 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue" s<0~(m-1)>_mj 10~200 Manual video quality level input.
Page 209 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) s<0~(m-1)>_mj 1~5, 100 Set the pre-defined quality level: peg_cbr_quant 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only valid when "mjpeg_ratecontrolmode"= cbr.
Page 210 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) For NTSC: D1/4CIF(720/704x480) -> (640x480) CIF(352x240)->(320x240) * Only available when capability_videoin_type is 0 or 1. wdrpro_mode 0, 1, 2 0: Disable WDR Pro. <product 1: Enable WDR Pro. dependent>...
Page 211 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) aespeed_spee 1~100 The speed level of AE converge speed. dlevel 1~20: level 1 <product 21~40: level 2 dependent> 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher speed level meas shorter AE converged time during AE...
Page 212 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) ttype" != "-". enablewaterm 0, 1 0: Not to add watermarks on images 1: Add watermarks on images <product * Only available when dependent> "capability_fisheye" > 0 s<0~(m-2)>_fis ‘1O, 1P, 2P, 1R, 4R’...
Page 213 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_smartstream_mode_hybri d" is 1. qualitypriority -5,-4,-3,-2,-1,1,2,3,4,5 The differential value of Q between the regions of interest (ROI) and the areas of non-interest (non-ROI) of the display image. If the value is a positive number, the video quality of ROI is better than the non-ROI areas.
Page 214 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.8.1.1 Alternative Video Input Profiles per Channel In addition to the primary setting of video input, there can be alternative profile video input setting for each channel which might be for different scene of light (daytime or nighttime). Group: videoin_c<0~(n-1)>_profile_i<0~(m-1)>...
Page 215 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) dependent> <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc. 5~8000 => 1/5s ~ 1/8000s etc. * Available value is listed * This parameter may also restrict image frame rate from sensor due to "capability_image_c<0~(n- sensor generates a frame per...
Page 216 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_exposu re_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. enableblc <boolean> Enable backlight compensation. <Not support * Not support this parameter anymore>...
Page 217 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) qualitypriority, exposure level. manual, "shutterpriority": Manually adjust with variable Shutter Speed, and keep adjusting Iris, Gain automatically. "irispriority": Manually adjust with (Available options are list variable Iris, and keep adjusting Gain "capability_image_c<0~(n- and Shutter speed automatically.
Page 218 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "outdoor": auto white balance mode specifically for outdoor. "indoor": auto white balance mode specifically for indoor. "sodiumauto": sodium vapor lamps. * Only available when "capability_image_c<0~(n-1)>_wbmo de" !="-" rgain 0~100 Manual set rgain value of gain control...
Page 219 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". mingain 0~100 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_mi ngain"...
Page 220 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 1)>_exposure_meteringm * We support this parameter when ode" the version number (httpversion) is equal or greater than 0311a. piris_mode manual, indoor, outdoor,- Control P-Iris mode. <product "outdoor": Auto-setting P-Iris to get dependent>...
Page 221 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_iristype "=dciris wdrpro_mode 0, 1, 2 0: Disable WDR Pro. <product 1: Enable WDR Pro. dependent> * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode" = 1 2: Enable WDR Pro II. * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode"...
Page 222 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) dependent> 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher speed level meas shorter AE converged time during AE executing. * Only available when "capability_image_c<0~(n-1)>_aespee d"...
Page 223 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved ipaddress <ip address> Multicast video IP address. port 1025 ~ 65535 Multicast video port. ipversion IPv4, IPv6 The version of internet protocol. 1 ~ 255 Multicast video time to live value. 7.9 Time Shift Settings Group: timeshift for n channel products and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream"...
Page 224 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved Group: ircutcontrol (capability_nvideoinprofile> 0 and capability_daynight_c<0~(n-1)>_support > 0) n denotes the value of "capability_nvideoin" * We do not support these parameters when "capability_nvideoin > 1" NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, Set IR cut control mode <Not day,...
Page 225 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) is equal or greater than 0400a. daymodeendtime 00:00~23:59 Day mod end time <Not * We replace this parameter with recommended to “ircutcontrol_c<0~(n-1)>_daymodeen use this> dtime” when the version number (httpversion) is equal or greater than 0312a.
Page 226 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. enablewled <boolean> Enable/disable built-in White led <Not * Only available when "...
Page 227 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) use this> capability_daynight_c<0~(n-1)>_ircuts ensitivity_type=options "1~100": if capability_daynight_c<0~(n-1)>_ircuts ensitivity_type=normalize * Only available when "capability_daynight_c<0~(n-1)> _ircutsensitivity_type" is not "-". * We replace this parameter with ircutcontrol_c<0~(n-1)>_sensitivity” when the version number (httpversion) is equal or greater than 0312a.
Page 228 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved Group: ircutcontrol_c<0~(n-1)> for n channel products (capability_daynight_c<0~(n-1)>_support > n denotes the value of "capability_nvideoin" NAME VALUE SECURIT DESCRIPTION (get/set) mode auto, Set IR cut control mode day, * We support this parameter when night, the version number (httpversion) is equal or greater than 0312a.
Page 229 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved * We support this parameter when the version number (httpversion) is equal or greater than 0312a. sensitivity low,normal,high,1 Sensitivity of day/night control. ~100 There are two value format: "low,normal,high": if capability_daynight_c<0~(n-1)>_ircuts ensitivity_type=options "1~100": if capability_daynight_c<0~(n-1)>_ircuts ensitivity_type=normalize...
Page 230 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved tin_support > 0" and "irled" is listed in "capability_daynight_ illuminators _builtin_type" * We support this parameter when the version number (httpversion) is equal or greater than 0312a. builtin_whiteled_enable <boolean> Enable/disable built-in white led * Only available when "capability_daynight_illuminators_buil tin_support >...
Page 231 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved equal or greater than 0312a. spectrum_mode visible, Set spectrum method . * We support this parameter when irenhanced, the version number (httpversion) is blueenhanced equal or greater than 0312a. <product dependent> * Only available when * Available values "capability_daynight_illuminators_ are listed in...
Page 232 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * We replace "contrast" with "contrastpercent ". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. saturation -5~5,100 -5: Less saturation <->...
Page 233 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) contrast * Only available when bit 1 of "capability_image_c<0~(n-1)>_basicse tting" is 1 saturationpercent 0~100 Set saturation in the normalized range. 0: Less saturation <-> 100: More saturation * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicse tting"...
Page 234 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) tmode" is 1 <boolean> Enable/disable hightlight mask. <product * Only available when dependent> "capability_image_c<0~(n-1)>_hlm" is dnr_mode <boolean> 3D noise reduction. <product 0:disable dependent> 1:enable * Only available when "capability_image_c<0~(n-1)>_dnr"...
Page 235 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <product 0:disable dependent> 1:enable * Only available when 'dis' is listed in "capability_image_c<0~(n-1)>_is_mod e". dis_strength 1~100 Strength of digital image stabilizer <product * Only available when 'dis' is listed in dependent>...
Page 236 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 1: enable * Only available when "capability_image_c<0~(n-1)>_deinter lace_support" is 1. deinterlace_mode spatial,blend Users can choose between two different deinterlacing techniques: Spatical mode provides the best image quality, while Blend mode provides better image quality (than not using the deinterlace function at all).
Page 237 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) listed in "capability_image_c< * Only available when 0~(n-1)>_palette_mo "capability_image_c<0~(n-1)>_palette de" _support" is 1. profile_i<0~(m-1)> <boolean> Enable/disable this profile setting _enable profile_i<0~(m-1)> night, The mode which the profile is applied _policy schedule <product dependent>...
Page 238 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) recommended to use this> * Only available when bit 1 of "capability_image_c<0~(n-1)>_basicse tting" is 1. * We replace "profile_i0_contrast" with "profile_i0_contrastpercent ". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 239 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) after the version number (httpversion) is equal or greater than 0400a. profile_i<0~(m-1)> 0~100 Set brightness in the normalized _brightnesspercent range. 0: Darker <-> 100: Bright * Only available when bit 0 of "capability_image_c<0~(n-1)>_basicse tting"...
Page 240 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) are valid. Internal module will take the closest valid one. For example, 1~45 may all be mapped to gamma value = 0.45, etc. * Only available when "capability_image_c<0~(n-1)>_gamm acurve"...
Page 241 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) _eis_mode 0:disable <product 1:enable dependent> * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mod e". profile_i<0~(m-1)> 1~100 Strength of electronic image stabilizer _eis_strength * Only available when 'eis' is listed in <product "capability_image_c<0~(n-1)>_is_mod dependent>...
Page 242 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) masking of bright light area. "center": Use Center window as metering area and give the necessary light compensation. 7.12.1. Exposure Window Setting for Each Window Group: exposurewin_c<0~(n-1)>_win_i<0~(k-1)> n denotes the value of "capability_nvideoin", k denotes the value of "capability_image_c<0~(n-1)>_exposure_winnum".
Page 243 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) H: 0~ The current image height "capability_image_c<0~(n-1)>_exposu re_windomain". sizepx <0~Wx0~ H> Width and height of the window. W: 0~ The current image width * Only available when px is listed in "capability_image_c<0~(n-1)>_exposu H: 0~ The current image height re_windomain".
Page 244 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Compensation), and to perform the masking of bright light area. "center": Use Center window as metering area and give the necessary light compensation. Group: exposurewin_c<0~(n-1)>_profile_i<0~(m-1)>_win_i<0~(k-1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the value of "capability_nvideoinprofile", k denotes the value of "capability_image_c<0~(n-1)>_exposure_winnum".
Page 245 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) homepx <0~W,0~H> Left-top corner coordinate of the window. W: 0~ The current image width * Only available when px is listed in H: 0~ The current image height "capability_image_c<0~(n-1)>_exposu re_windomain".
Page 246 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) input intmic, extmic intmic: Internal (built-in) microphone. <product (Only available when dependent> capability_audio_intmic = 1) extmic: External microphone input. (Only available when capability_audio_extmic =1) * Note: If physical microphone switch is showed on product, this value is updated during booting to fit switch status.
Page 247 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) suggest don't use this since the version number (httpversion) is equal or greater than 0301a. * We replace "gain" with "volume_internal" and "volume_external". More details, please refer the parameter description of "volume_internal"...
Page 248 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 5900, 6700, 7400, 7950, 10200, 12200 s0_g711_mode pcmu, Set G.711 companding algorithm. pcma pcmu: µ-law algorithm pcma: A-law algorithm * Only available if G.711 is supported. s0_g726_bitrate 16000, Set G.726 encoded bitrate in bps.
Page 249 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) schedule <product * Not support "policy=day" anymore dependent> when the version number (httpversion) is equal or greater than 0301a. * "policy=night" is only available when "capability_daynight_c<0~(n-1)>_sup port > 0". profile_i0_begintime hh:mm Begin time of schedule mode.
Page 250 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.15 Play an Audio Clip Group: audioclip_i<0~1> (capability_audio_audioclip=1) NAME VALUE SECURITY DESCRIPTION (get/set) name string[40] Specify the audio clip name that can be played when an event occurs. size 0,<positive integer> The size of audio clip. Group: audioclip (capability_audio_audioclip=1) NAME...
Page 251 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) ~ 9999,0 ~ 9999, 0 ~ position. 9999,0 ~ 9999, 0 ~ (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 9999,0 ~ 9999 * Only available when "capability_motion_wintype" = polygon. * Only available when std is listed in "capability_motion_windomain"...
Page 252 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0400a. left 0 ~ 320 Left coordinate of window position. <Not recommended * Only available when to use this> "capability_motion_wintype"...
Page 253 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * 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 254 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable motion detection window. name string[14] Name of motion window. polygonstd 0 ~ 9999,0 ~ 9999, Coordinate of polygon window position. 0 ~ 9999,0 ~ 9999, (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 0 ~ 9999,0 ~ 9999, * Only available when...
Page 255 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <Not recommended * Only available when 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 256 VIVOTEK © 2022 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. 7.17 Tampering Detection Settings Group: tampering_c<0~(n-1)> for n channel products (capability_tampering >...
Page 257 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) detection blurry_duration 1~10 If image too blurry value exceeds the "threshold" for more than "duration" second(s), then image too blurry detection is triggered. 7.18 DDNS Group: ddns (capability_protocol_ddns >...
Page 258 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.20 UPnP Presentation Group: upnppresentation NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP presentation service. 7.21 UPnP Port Forwarding Group: upnpportforwarding NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP port forwarding service.
Page 259 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) setparamlevel Show log of parameter setting. 0: disable 1: Show log of parameter setting set from external. 2. Show log of parameter setting set from external and internal. 7.23 SNMP Group: snmp (capability_protocol_snmp >...
Page 260 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.24 Layout Configuration Group: layout NAME VALUE SECURITY DESCRIPTION (get/set) logo_default <boolean> 0 => Custom logo 1 => Default logo logo_link string[128] Hyperlink of the logo http://www.vivot ek.com logo_powerbyvvtk_hidd <boolean> 0 => display the power by vivotek logo 1 =>...
Page 261 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Bit 1 => Require special character Bit 2 => Require digit number Bit 3 => Require lowercase letter Bit 4 => Require uppercase letter Bit 5 => Allow checking username and password;...
Page 262 VIVOTEK © 2022 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 263 VIVOTEK © 2022 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 264 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) color 0~" Privacy mask color capability_image_c<0~(n- 1)>_privacymask_ncolor" win_i<0~(m-1)>_name string[40] Name of the privacy mask window. win_i<0~(m-1)>_pan "capability_ptz_c<0~(n-1) Pan position of window >_minpan" ~ position. "capability_ptz_c<0~(n-1) * Only available when bit0 of >_maxpan"...
Page 265 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) features/interfaces or the firmware has substantially change in architecture and not able to roll back to previous version. This may cause incompatibility with supporting software. Minor version Increase the minor version when add new features/interfaces without change the old features and...
Page 266 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) follow the API definition of 0301a_1, we will fix them and change this API value to 0301b_1. api_logoversion <string> Indicate the version of Vivotek log This number start format.
Page 267 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) nvideoout 0, <Positive Integer> Number of video out interface. nvideoinprofile <positive integer> Number of video input profiles. nmediastream <positive integer> Number of media stream per channels. naudiosetting <positive integer>...
Page 268 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Support pan operation; 0(not support), 1(support) Bit 3 => (only available when bit0 is 1) Support tilt operation; 0(not support), 1(support) Bit 4 => (only available when bit0 is 1) Support zoom operation;...
Page 269 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) bit 1 => Only support zoom function. bit 2 => Only support focus function. bit 3 => Currently, this is a reserved bit, and the default value is 0. * It's strongly non-recommended to use this.
Page 270 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) group for 1st channel, bit 16~31 are the 2nd group for 2nd channel. nvideoin = 3, bit 0~9 are the 1st group for 1st channel, bit 10~19 are the 2nd group for 2nd channel, bit 20~31 are the 3rd group for 3rd channel.
Page 271 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) tamperingmode tamper,toodark,toobri Available tampering mode list. ght,tooblurry * Only available when "capability_tampering" is 1. adaptiverecording <boolean> Indicate whether to support adaptive recording. adaptivestreaming <boolean> Indicate whether to support adaptive streaming.
Page 272 VIVOTEK © 2022 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 0311c. storage_dbenabled <boolean> Media files are indexed in database. protocol_https <boolean > Indicate whether to support HTTP over SSL.
Page 273 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) protocol_ipv6 <boolean> Indicate whether to support IPv6. protocol_pppoe <boolean> Indicate whether to support PPPoE. protocol_ieee8021 <boolean> Indicate whether to support IEEE802.1x. protocol_qos_cos <boolean> Indicate whether to support CoS. protocol_qos_dscp <boolean>...
Page 274 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * This is kept for compatibility. videoin_mjpeg_ma A list of <Integer> and This equals xframerate "-" "capability_videoin_c0_mjpeg_maxfra merate". * This is kept for compatibility. videoin_h264_max A list of <Integer> and This equals framerate "-"...
Page 275 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) *Only available when "capability_audio_aec" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0306b. audio_aecaffect When acoustic echo cancellation maxframerate:fixed:1 function is enabled, some features may become malfunction or be forced...
Page 276 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) For example: "maxframerate: fixed:15" which means the max frame rate is 15fps when acoustic echo cancellation function is enabled. "-" means no feature is affected. * Only available when "capability_audio_aec"...
Page 277 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * It will be replaced by audio_intmic and audio_extmic. audio_lineout <boolean> Indicate whether to support line output. audio_michardwar <boolean> Indicate whether the hardware eswitch supports built-in/external mic switch audio_headphoneo <boolean>...
Page 278 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the whole image. "px": Locate a window in the image with pixels. "std": A normalized 0~9999 range. "-": Not supported. smartstream_supp <boolean> Indicate whether smart stream is supported.
Page 279 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) dow_autotracking of autotracking. * Only available when "capability_smartstream_support" is 1 smartstream_nwin <positive integer> Maximum number of tracking window dow_manual of manual. * Only available when "capability_smartstream_support" is 1 smartstream_nwin <positive integer>...
Page 280 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) (httpversion) is equal or greater than 0301b. * It will be replaced by capability_camctrl_ptztunnel. camctrl_ptztunnel <boolean> Indicate whether to support ptztunnel. * We support this parameter when the version number (httpversion) is equal or greater than 0301b.
Page 281 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) is supported. * Only available when "capability_network_wireless" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0305a. wireless_s802dot1 <boolean> Indicate whether to support wireless 802.11b+.
Page 282 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0305a. derivative_brand <boolean> Indicate whether to support the upgrade function for the derivative brand. For example, if the value is true, the VVTK product can be upgraded to VVXX.
Page 283 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0313a. media_streamprofi <positive integer> Maximum number of stream profiles. les_num * We support this parameter when the version number (httpversion) is equal or greater than 0313a.
Page 284 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) One bit represents one channel. Ex: “3” means channel 0 and channel1 support seamless recording . * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_modn The maximum MOD connection <positive integer>...
Page 285 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_slcon 0,<positive integer> The maximum seamless connection number for each channel. * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_smart <boolean>...
Page 286 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) layout_redirection <string> Indicate which function will be redirected to the vadp package path. "-": Not supported. * We support this parameter when the version number (httpversion) is equal or greater than 0309a.
Page 287 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) cameralink_num 0, <positive integer> Indicate the maximum number of receiver camera link. * Only available when "capability_cameralink_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0315a.
Page 288 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) buildinpt <boolean> An 32-bit integer, each bit can be set separately as follows: Bit 0 => support build-in pan Bit 1 => support build-in tilt zoommodule <boolean> Indicate whether to support zoom lens.
Page 289 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) focusmode auto,onetimeauto,sp Focus mode selection: otlight,manual "auto": Camera will automatically <product adjust the focus position full time to dependent> adapt a clear picture. "onetimeauto": Camera will automatically adjust the focus position one time, which follows any PTZ control.
Page 290 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) panspeedlv 0, <positive integer> 0/7 The maximum speed level of pan motion. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" minpan 0, <positive integer> 0/7 The lower limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildin pt"...
Page 291 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mintiltangle <integer> The lower limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" maxtiltangle <integer> The upper limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt"...
Page 292 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxfocus 0, <positive integer> 0/7 The upper limit for focus position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoomm odule" is "1" 7.27.3 Capability for IR Led Group: capability_daynight_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY...
Page 293 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) optimizedir <boolean> Indicate whether to support optimized IR control technology. * We replaced this parameter with “capability_daynight_illumintators_opti mizedir” when the version number (httpversion) is equal or greater than 0312a.
Page 294 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) ircutsensitivity_supportle The value indicate the support strength <positive integer> level of ircutsensitivity. * Only available when "capability_daynight_c<0~(n-1)>_suppo rt" is 1 and "capability_daynight_c<0~(n-1)>_ircuts ensitivity_type" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 295 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) spectrum_mode visible,ir,irenhanced, Indicate the spectrum mode. blueenhanced "visible": The ideal default setting for <product visible light. dependent> "ir": The ideal default setting for IR light. "irenhanced": This CCM model increases the brightness effect of IR light.
Page 296 VIVOTEK © 2022 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 297 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved optimizedir <boolean> Indicate whether to support optimized IR control technology. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. builtin_support <boolean> Indicate whether to support built-in led. * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
Page 298 VIVOTEK © 2022 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 299 VIVOTEK © 2022 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 300 VIVOTEK © 2022 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 301 VIVOTEK © 2022 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 302 VIVOTEK © 2022 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 303 VIVOTEK © 2022 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 304 VIVOTEK © 2022 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 305 VIVOTEK © 2022 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 306 VIVOTEK © 2022 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 307 VIVOTEK © 2022 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 308 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) typewallmount 1O, 1P, 1R, 4R Available dewarp types of wall mount. resolutionC1P A list of <WxH> Available resolutions of 1P mode of ceiling and floor mount. resolutionC2P A list of <WxH>...
Page 309 VIVOTEK © 2022 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 310 VIVOTEK © 2022 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 311 VIVOTEK © 2022 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 312 VIVOTEK © 2022 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 313 VIVOTEK © 2022 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 314 VIVOTEK © 2022 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 315 VIVOTEK © 2022 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 316 VIVOTEK © 2022 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 317 VIVOTEK © 2022 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 318 VIVOTEK © 2022 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 319 VIVOTEK © 2022 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 320 VIVOTEK © 2022 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 321 VIVOTEK © 2022 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 322 VIVOTEK © 2022 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 323 VIVOTEK © 2022 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 324 VIVOTEK © 2022 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 325 VIVOTEK © 2022 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 326 VIVOTEK © 2022 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 327 VIVOTEK © 2022 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 328 VIVOTEK © 2022 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 329 VIVOTEK © 2022 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 330 VIVOTEK © 2022 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 331 VIVOTEK © 2022 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 332 VIVOTEK © 2022 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 333 VIVOTEK © 2022 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 334 VIVOTEK © 2022 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 335 VIVOTEK © 2022 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 336 VIVOTEK © 2022 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 337 VIVOTEK © 2022 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 338 VIVOTEK © 2022 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 339 VIVOTEK © 2022 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 340 VIVOTEK © 2022 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 341 VIVOTEK © 2022 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 342 VIVOTEK © 2022 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 343 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) devicemonitor_heatern <integer> Number of sensor sensors that can be monitored. * Only available when "capability_peripheral_c<0~(n-1)>_devi cemonitor_support" > 0 7.27.11 Capability for Extension Modules Group: capability_extension PARAMETER VALUE SECURITY DESCRIPTION (get/set)
Page 344 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. enable 0, 1 Enable or disable this event. priority 0, 1, 2 Indicate the priority of this event: "0"= low priority "1"= normal priority "2"= high priority delay...
Page 345 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) 0,<positive Indicate the source id of di trigger. integer> This field is required when trigger condition is “di”. One bit represents one digital input. The LSB indicates DI 0. * Only available when "capability_ndi"...
Page 346 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) valevel0 Select audio detection profile event. 0: not select 1: select inter 1~999 Interval of snapshots in minutes. This field is used when trigger condition is “seq”. weekday 0~127 Indicate which weekday is scheduled.
Page 347 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_do_i<0~(k-1)>_en <boolean> Enable or disable trigger digital output. able 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...
Page 348 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) foldername string[128] Path to store media. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. action_cf_media NULL, 0~4,101 Index of the attached media. 101 means “Recording Notify”...
Page 349 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_goto_sync <boolean> Capture media after moving to the <product dependent> location. * Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0, or capability_camctrl_c0_zoommodule >...
Page 350 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_audioclip_enable <boolean> Enable/disable the function the play an audio clip when an event is triggered. * Only avaliable when "capability_audio_audioclip" is 1. action_audioclip_media 0,<positive Indicate the source id of audioclip event integer>...
Page 351 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) type email, Indicate the server type: ftp, “email” = email server http, “ftp” = FTP server “http” = HTTP server sftp “ns” = network storage “sftp” = secure FTP * “sftp”...
Page 352 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) ns_location string[128] Location to upload or store the media. * For httpversion is equal or greater than 0312a: The media storage path format is “\<mac address>\date\hour”. (Only available when “nas”...
Page 353 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved fingerprint_enable boolean Verify server fingerprint to avoid connect to fake server. fingerprint_content <128-bit hash Server fingerprint(MD5). value> You can get it by calculate server host key(public) md5. publickey_pairmode auto, "autopair": Autopair mode is selected download, for this event server.
Page 354 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) snapshot_channel 0~"capability_nvideoin"-1 Indicate the source of media channel. 0 means the first channel. 1 means the second channel. 2 means the third channel. 3 means the fourth channel. * We support this parameter when the version number (httpversion) is equal or greater...
Page 355 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) videoclip_channel 0~"capability_nvideoin"-1 Indicate the source of media channel. 0 means the first channel. 1 means the second channel. 2 means the third channel. 3 means the fourth channel. * We support this parameter when the version number (httpversion) is equal or greater...
Page 356 VIVOTEK © 2022 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 357 VIVOTEK © 2022 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 358 VIVOTEK © 2022 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 359 VIVOTEK © 2022 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 360 VIVOTEK © 2022 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 361 VIVOTEK © 2022 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 362 VIVOTEK © 2022 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 363 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) osdzoom <boolean> Indicates multiple of zoom in is <Not recommended to “on-screen display” or not. use this> * Reserved for compatibility, and suggest don't use this since [httpversion] > 0302a * We replace "eptz_c<0~(n-1)>_osdzoom"...
Page 364 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) 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. (It should be set by ePreset.cgi rather than by setparam.cgi.) preset_i<0~19>_pos <W,H>...
Page 365 VIVOTEK © 2022 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 366 VIVOTEK © 2022 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 367 VIVOTEK © 2022 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 368 VIVOTEK © 2022 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 369 VIVOTEK © 2022 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 370 VIVOTEK © 2022 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 371 VIVOTEK © 2022 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 372 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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 373 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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)> for n channel products (capability_camctrl_c0_zoommodule = 1 and capability_camctrl_c0_buildinpt = 0) n denotes the value of "capability_nvideoin"...
Page 374 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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 375 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) version number (httpversion) is equal or greater than 0305b. patrolseq string[120] (For external device) The indexes of patrol points, separated by “,” patroldwelling string[160] (For external device) The dwelling time of each patrol point, separated by “,”...
Page 376 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PTZ C LEASE REFER TO ONTROL 7.41 Camera PTZ Control (SD Series) Group: camctrl_c<0~(n-1)> for n channel products (the bit7 of capability_ptzenabled is 0 and the bit4 of capability_ptzenabled is 1) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset" NAME VALUE SECURITY...
Page 377 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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~( Tilt position at each preset n-1)>_mintilt ~ location.
Page 378 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) n-1)>_minpan ~ capability_ptz_c<0~( n-1)>_maxpan axisy capability_ptz_c<0~( Custom home tilt position. n-1)>_mintilt ~ capability_ptz_c<0~( n-1)>_maxtilt axisz capability_ptz_c<0~( Custom home zoom position. n-1)>_minzoom ~ capability_ptz_c<0~( n-1)>_maxzoom axisf capability_ptz_c<0~( Custom home focus position. n-1)>_minfocus ~ capability_ptz_c<0~( n-1)>_maxfocus...
Page 379 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) tour_i<0~19>_speed -5 ~ 5 Preset tour: pan and tilt speed when moving between presets. Recorded tour: unnecessary. tour_i<0~19>_direction forward,backward,ra User can choose which direction ndom the preset tour goes. "forward": preset tour goes in forward order.
Page 380 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.42 UART Control Group: uart (capability_nuart > 0 and capability_fisheye = 0) NAME VALUE SECURITY DESCRIPTION (get/set) ptzdrivers_i<0~19, string[40] Name of the PTZ driver. 127>_name ptzdrivers_i<0~19, string[128] Full path of the PTZ driver. 127>_location enablehttptunnel <boolean>...
Page 381 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) speedlink_i<0~4>_n string[40] Additional PTZ command name. * only available when capability_camctrl_c0_rs485=2 speedlink_i<0~4>_c string[40] Additional PTZ command list. * only available when capability_camctrl_c0_rs485=2 ptzdriver 0~19, The PTZ driver is used by this COM 127 (custom), port.
Page 382 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "1": One stop bit is transmitted to stopbit indicate the end of a byte. "2": Two stop bits are transmitted to indicate the end of a byte. If you want to transfer the stopbit for 150% of the normal time used to transfer one bit, the...
Page 383 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved Group: lens for n channel products n denotes the value of "capability_nvideoin" (capability_image_c<0~(n-1)>_lensconfiguration_support = 1) NAME VALUE SECURITY DESCRIPTION (get/set) selected <string> Current selected lens profile. e.g. lens_selected=lens_default_i0, it means choosen lens configuration is i0 lens of default group.
Page 384 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) revisedcenteraxis <coordinate> The actual center axis coordinate radius 0, <positive The actual center radius integer> 7.47 Fisheye Local Dewarp Setting Group: fisheyedewarp_c<0~(n-1)> (capability_fisheyelocaldewarp_c<0~(n-1)> > 0) n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" NAME VALUE SECURITY...
Page 385 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) from 0 to 3) Tilt range of ceiling/floor mount is [0~90]. Tilt range of wall mount is [-90~90]. s<0~(m-2)>_region_r 100~300 Zoom home ratio of regional view (for <0~(i-1)>_zoom 4R mode, i is the view index and range from 0 to 3)
Page 386 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 7.50 Wireless Group: wireless (capability_network_wireless > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) ssid string[32] SSID for wireless lan settings. wlmode Infra, Wireless mode. Adhoc Infra: Infrastructure channel 1~11 or A list of WLAN channels. 1~13 Countries apply their own regulations 10~11 or...
Page 387 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) key2 password [26] WEP key2 for encryption. * Only valid when "wireless_encrypt" is "wep" key3 password [26] WEP key3 for encryption. * Only valid when "wireless_encrypt" is "wep"...
Page 388 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) fixed <boolean> The value indicates whether the profile can be deleted or not. Ex. fixed=1 indicates the profile cannot be deleted. occupied <boolean> Indicates the action of creating profile. Ex.
Page 389 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) audioconfiguration_so c<0~(n-1)>s0 The audioconfiguration source for the urce profile. * n denotes the value Ex. audioconfiguration_source= c<0~(n-1)>s0 indicates audio stream of "capability_naudioin" channel n and stream 1 is selected for the profile.
Page 390 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. ipaddress <ip address> The ipaddress of the receiving camera. username string[64] The username of the receiving camera. passwd string[64] The password of the receiving camera. port 0~65535 The connection port to the receiving...
Page 391 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) connected <Boolean> Indication if extension module IO is connected. 7.56 Focussystem Group: focussystem_c<0~(n-1)> (capability_image_c<0~(n-1)>_remotefocus > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) autofocus_enablebyzoom <Boolean>...
Page 392 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) focusshift_night_lastdate <blank>, A recorded UTC time when IR offset value <YYYY/MM/DD is saved during night mode. HH:MM:SS> <blank>: IR offset value hasn't been saved before. 392 - User's Manual...
Page 393 VIVOTEK © 2022 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 394 VIVOTEK © 2022 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 395 VIVOTEK © 2022 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 396 VIVOTEK © 2022 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 397 VIVOTEK © 2022 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 398 VIVOTEK © 2022 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 399 VIVOTEK © 2022 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 400 VIVOTEK © 2022 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 401 VIVOTEK © 2022 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 402 VIVOTEK © 2022 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 403 VIVOTEK © 2022 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 404 VIVOTEK © 2022 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 405 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved ------------------------------------------------------------------------- GET /cgi-bin/admin/ctrlevent.cgi x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------- POST /cgi-bin/admin/ ctrlevent.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache cache-control : no-cache content-length: 32767 expires: Sun, 9 Jam 1972 00:00:00 GMT User must use GET and POST to establish two channels for downstream and upstream.
Page 406 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved network_rtsp_s2_accessname = live2s1.sdp network_rtsp_s3_accessname = live2s2.sdp etc. * For version number(httpversion) above 0311c, the default RTSP access name format is “live<n>s<m>.sdp”. Please refer to the “subgroup of network: rtsp” for setting the accessname of SDP.
Page 407 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved data <hex decimal The <hex decimal data> is a series of digits from 0 ~ 9, A ~ data>[,<hex decimal F. Each comma separates the commands by 200 data>] milliseconds. flush yes,no yes: Receive data buffer of the COM port will be cleared before read.
Page 408 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved Command: search PARAMETER VALUE DESCRIPTION label <integer primary key> Optional. The integer primary key column will automatically be assigned a unique integer. triggerType <text> Optional. Indicate the event trigger type. Please embrace your input value with single quotes. Ex.
Page 409 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION limit <positive integer> Optional. Limit the maximum number of returned search records. offset <positive integer> Optional. Specifies how many rows to skip at the beginning of the matched records. Note that the offset keyword is used after limit keyword.
Page 410 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved http://<servername>/cgi-bin/admin/downloadMedias.cgi?type=<type>[&<parameter>=<value>…] PARAMETER VALUE DESCRIPTION type <text> Required command to be excuted include videoclip device <text> command to be excuted include sd, nas recordingtoken <text> Please refer to Edge Storage API starttime <text> Optional.
Page 411 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 8.17 Virtual Input (capability_nvi > 0) Note: Change virtual input (manual trigger) status. Method: GET Syntax: http://<servername>/cgi-bin/admin/setvi.cgi?vi0=<value>[&vi1=<value>][&vi2=<value>] [&return=<return page>] PARAMETER VALUE DESCRIPTION vi<num> state[(duration)nstate] Ex: vi0=1 Where "state" is 0, 1. “0” Setting virtual input 0 to trigger state means inactive or normal state while “1”...
Page 412 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved setvi.cgi?vi0=0(15000)1 setvi.cgi?vi0=1 Request 2 will not be accepted during the execution time(15 seconds). 8.18 Open Timeshift Stream (capability_timeshift > 0, timeshift_enable=1, timeshift_c<n>_s<m>_allow=1) Note: This request requires Viewer access privileges. Syntax: For HTTP push server (MJPEG): http://<servername>/<network_http_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&reft ime=<value>&forcechk&minsft=<value>] For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player.
Page 413 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE DEFAULT DESCRIPTION reftime mm:ss The time Reference time for maxsft and minsft. camera (This provides more precise time control to eliminate receives the the inaccuracy due to network latency.) request. Ex: Request the streaming from 12:20 rtsp://10.0.0.1/live.sdp?maxsft=10&reftime=12:30 forcechk...
Page 414 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function zoom, zoom - Move focus motor focus – Move focus motor focus, auto, auto – Perform auto focus scan, scan – Perform focus scan stop, stop – Stop current operation positioning –...
Page 415 VIVOTEK © 2022 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 416 VIVOTEK © 2022 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 417 VIVOTEK © 2022 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 418 VIVOTEK © 2022 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 419 VIVOTEK © 2022 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 420 VIVOTEK © 2022 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 421 VIVOTEK © 2022 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 - 421...
Page 422 VIVOTEK © 2022 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 423 VIVOTEK © 2022 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 424 VIVOTEK © 2022 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 425 VIVOTEK © 2022 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 426 VIVOTEK © 2022 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 427 VIVOTEK © 2022 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 428 VIVOTEK © 2022 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 429 VIVOTEK © 2022 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 430 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved Syntax: http://<servername>/cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION Apply the wireless settings and connect to AP. 8.31 Get Wireless Information (capability_network_wireless > Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/getwirelessinfo.cgi PARAMETER VALUE DESCRIPTION Get wireless information.
Page 431 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION Get wireless signal strength. 8.33 WPS Transaction (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/start_wps.cgi PARAMETER VALUE DESCRIPTION Start WPS transaction. 8.34 Peripheral Control (capability_peripheral_c<0~(n-1)>_ devicecontrol >...
Page 432 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved "washer_mode : OK\r\n" "washer_status : FAIL\r\n" PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. washer_mode wiper Apply the wiper to the mode of washer control system. washer Apply the washer to the mode of washer control system.
Page 433 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved Pragma: no-cache\r\n \r\n supportdevice=washer,heater\r\n washer_status=off\r\n PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. supportdevice Get support peripheral device. washer_supportmode N/A Get the support mode of washer control system. washer_mode Get the current mode of washer control system. It return the value of "washer_mode"...
Page 434: Technology License Notice
VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 8.35 Device monitor (capability_peripheral_c<0~(n-1)>_ devicemonitor_support > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/devicemonitor.cgi PARAMETER VALUE DESCRIPTION Return a status overview of all sensors and peripheral devices on camera. Response: devicemonitor_tempsensor_iX_name: the name of temperature sensor...
Page 435: Electromagnetic Compatibility (Emc)
VIVOTEK © 2022 VIVOTEK INC. All Right Reserved http://myserver/cgi-bin/admin/devicemonitor.cgi Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n devicemonitor_tempsensor_i0_name=front glass devicemonitor_tempsensor_i0_celsius=30 devicemonitor_tempsensor_i0_fahrenheit=86 devicemonitor_heater_i0_name=front glass devicemonitor_heater_i0_status=off 8.36 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...
Page 436 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION "onetimeauto": Camera will automatically adjust the IR function getstatus, onetimeauto zone one time only. "getstatus": Information of optimized IR control status and return value as below: optimizedir_c<0~(n-1)>_irmode: Indicate the IR current mode, available value is “auto” and “manual”...
Page 437 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. "set": set the strength of each IR LED separately operation set, settoall "settoall": use fixed strength for all IR LED irmode auto, Irmode needs to be set as manual for adjusting IR manual LED strength.
Page 438 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: Must have the "irmode=manual" argument! Syntax: (for query API) http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=get...
Page 439 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=get&irmode Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irmode='auto'" 8.37 Lens Thermal Control (capabiltiy_image_c<0~(n-1)>_sensortype=thermalsensor) Note: This request requires Administrator privileges. Method: GET/POST (for control API) Syntax: http://<servername>/cgi-bin/admin/thermalctrl.cgi?operation=set &action=<value> 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...
Page 440 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved 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. Syntax: (for query API) http://<servername>/cgi-bin/admin/thermalctrl.cgi?operation=get&version=<value> PARAMETER VALUE DESCRIPTION version Indicate lensctrl thermal version Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=get&version...
Page 441 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved http://<servername>/cgi-bin/admin/audioclip.cgi?operation=<value>[&name=<value>][&index=<value>] PARAMETER VALUE DESCRIPTION operation startrecording, "startrecording" = Record a new audio clip. stoprecording, "stoprecording" = Stop an ongoing recording. "play" = Play an audio clip. play, stopplayback, "stopplayback" = Stop to playback of an audio remove, clip.
Page 442 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved If the user requests include an invalid parameter value, we will use the default value. PARAMETER VALUE DESCRIPTION operation Set formatting parameters and start formatting fstype fat32, ext4 fat32: High compatibility for PC, but low stability for Data ext4 : Low compatibility for PC, but high stability for Data.
Page 443 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved Get formatting progress(0~100) or result(error message) *It is unnecessary when using the blocking mode. Example: Request of get formatting progress(0~100): http://myserver/cgi-bin/admin/format_sdcard.cgi?operation=get 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 <Success Message>...
Page 444 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved “n” is the maximum stream profile number (capability_media_streamprofiles_num)  “streamprofile_i<x>_token” is the unique identifier for each profile, x is within  0~(capability_media_streamprofiles_num)-1. port is the rtsp port.  Please refer to the streamprofile group for requesting the stream profile token value for each profile.
Page 445 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved Please refer to the streamprofile group for requesting the stream profile name value for each profile. You can get the SDP by HTTP GET. When using scalable multicast, Get SDP file which contains the multicast information via HTTP. PARAMETER VALUE DESCRIPTION 1: Enable the feature of Protocol...
Page 446 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved POST and “content-type: multipart/form-data”. HTTP headers with its name=”parameter” or name=” uploadKeyFile” will be describing the request body, see examples below. * Required when operation=manualmode address <sftp server address or sftp server address or hostname hostname>...
Page 447 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved "ed25519": faster to generate with higher keytype ed25519, rsa, ecdsa security level, some old server might not support. "rsa": slower to generate with slightly lower security level than ed25519. "ecdsa": low security level. A keytype will be automatically selected if the parameter is not provided.
Page 448 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved Accept: text/html, application/xhtml+xml, */* Accept-Language: zh-TW User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; rv:11.0) like Gecko Content-Type: multipart/form-data; boundary=---------------------------7e1309282ed0f1a Accept-Encoding: gzip, deflate Host: 172.16.219.217 Content-Length: 6123 Connection: Keep-Alive Pragma: no-cache Cookie: webptzmode=continuous; activatedmode=digital; g_mode=1; viewsizemode=Auto; 4x3=false;...
Page 449 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved IjSd+RMqL3yCFzM0aqcQNjd77nDP6+u9RYYyGT8dH5ud7pJVofxI+pvpQN3k5Tlb Pm9IM6OJPDy/Netcu6YEl3ULa6XHkYldqezJDnUfCBHe3OKjhue2FTBRmM2/j9Zl DkUrO7lQz7X88T/w5+rI2OnDIm3szOhzMCYPtHxf8ygMKXI/DKp3OR2/cu6ayGhb DezpoSyTjL1fTFINQAymDtP5tbomfESjFDW1fmfD9h1FivqYEy7017djPWrq8mjH N6nAhlaLVVuTVJ+xxaJAzYiQwMdwWY8SGUq062ksDvfixYCQfhXUd629oEX82fJU 8OxF8CM0WEHFCIotJVbFjDyT5lP4qln5EMeMlPE8jrmUKEEV+AJw9AbaqvCYUNaH EVZ7nlYjrnQqMCktYlO/Um8vSiVsOaMFLUdiYJwj2pzyceTzyW19/KEo//8ufOFD LaSp5EGH6lBCTBfQ9PGeOkB2ZVf0jLFB9Sage8Ln5frWYOAROxzumUJWSvOoBael 15OdV5hApqQjGrn1vbc/kC8p478ZCzx2iDyckPqyVpHSke70T5bV6vcDZcCTrwkA PHdD4Q0cqd7sX0R2OAScwJk2AkaQ+PsLwS05hw1nQBsQrC4m9e8Kmg32RgCGDAES xpV9dkSkvoaLZmN1qfBwnyOxsjmx9OAOBKWzMlW5PoPCR9z8Z1gsiACBnrT+K5ec NZdgsxvxMfdI7vfj6mkO89MvwLX8YEtnFrihIZmDnnVMuHfq6g5kbwlHbHVaoImo -----END RSA PRIVATE KEY----- -----------------------------7e1309282ed0f1a-- (for query API) Syntax: http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=<value>[&parameter=<value>] PARAMETER VALUE DESCRIPTION operation getserverhostkey " getserverhostkey ": Auto scan SFTP server host key.
Page 450 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved <MD5 value> 8.40.2 SFTP Server Setting * Only available when bit 1 of "capability_protocol_ftp_server" is 1. Syntax: (for control API) http://<servername>/cgi-bin/admin/sftpserver.cgi?operation=<value> PARAMETER VALUE DESCRIPTION operation updatehostkey "updatehostkey": Re-generate host key for SFTP server. * It might take several seconds to generate key, you can use “gethostkey”...
Page 451 VIVOTEK © 2022 VIVOTEK INC. All Right Reserved finished, you will receive error message. Example of get host key: Request: http://<servername>/cgi-bin/admin/sftpserver.cgi?operation=gethostkey Response of success HTTP/1.1 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <Success Message Length>\r\n \r\n MD5:a5:8a:7d:e2:2a:f8:c9:a0:ee:93:93:b8:0a:7a:18:97 (RSA) MD5:7a:f4:07:48:e3:70:d5:89:15:36:6f:d5:25:f2:7e:0d (ED25519) <End of document> User's Manual - 451...
Page 452 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 453 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 MD9584-H User Manual

Quick Links

Related Manuals for Delta Vivotek MD9584-H

Summary of Contents for Delta Vivotek MD9584-H

Table of Contents