Vivotek Supreme FE9382-EHV-v2 User Manual

Vivotek Supreme FE9382-EHV-v2 User Manual

Fisheye network camera
Hide thumbs Also See for Supreme FE9382-EHV-v2:
Table of Contents

Advertisement

Quick Links

FE9382-EHV-v2
User 's Manual
6MP • Vandal-proof • 360º Surround View • Smart IR 20m
Smart Stream III • Pixel Calculator • PoE • IP66 • IK10 • WDR Pro
Fisheye
Network Camera
Rev. 1.0

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Supreme FE9382-EHV-v2 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Vivotek Supreme FE9382-EHV-v2

  • Page 1 FE9382-EHV-v2 Fisheye Network Camera User ’s Manual 6MP • Vandal-proof • 360º Surround View • Smart IR 20m Smart Stream III • Pixel Calculator • PoE • IP66 • IK10 • WDR Pro Rev. 1.0...
  • Page 2: Table Of Contents

    Table of Contents Overview..................................4 VIVOTEK’s FE9380 and FE9382 are two H.265 fisheye fixed dome network cameras, both featuring a detailed 5-Megapixel CMOS sensor that produces superb image clarity. By employing H.265 compression technology and VIVOTEK’s Smart Stream III technology, these cameras can reduce both bandwidth and storage consumption by up to 80%* while retaining the highest standard of image quality.
  • Page 3 Applications > Tampering detection ........................155 Applications > Audio detection ......................... 156 Applications > Shock detection ......................... 158 Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) ..... 159 Recording > Recording settings ........................162 Storage ................................167 Storage >...
  • Page 4: Overview

    VIVOTEK Overview VIVOTEK’s FE9382 is an H.265 fisheye fixed dome network cameras, featuring a detailed 6-Megapixel CMOS sensor that produces superb image clarity. By employing H.265 compres- sion technology and VIVOTEK’s Smart Stream III technology, these cameras can reduce both bandwidth and storage consumption by up to 80%* while retaining the highest standard of im- age quality.
  • Page 5: Read Before Use

    VIVOTEK Read Before Use The use of surveillance devices may be prohibited by law in your country. The Network Camera is not only a high-performance web-ready camera but can also be part of a flexible surveillance system. It is the user’s responsibility to ensure that the operation of such devices is legal before installing this unit for its intended use.
  • Page 6 8. Make sure cameras are securely attached to the wall/ceiling/mounting kits. IMPORTANT: 1. Please contact VIVOTEK's certified dealers for power adapters. 2. Installation and maintenance service should only be performed by qualified technicians. 3. If powered by a power adapter, the adapter should be properly grounded.
  • Page 7 Cross-Site Request Forgery (CSRF) protection in Configuration > Security > Miscellaneous. • For up-to-date documentation of URL commands, please go to VIVOTEK’s website, register an account with a business mail address and submit for authorization for SDK in Support > Downloads > SDK.
  • Page 8 VIVOTEK IMPORTANT: 1. The camera is only to be connected to PoE networks without routing to outside plants. 2. For PoE connection, use only UL listed I.T.E. with PoE output. 1. La caméra ne doit être raccordée qu’à des réseaux PoE, sans routage vers des installations extérieures.
  • Page 9: Physical Description

    VIVOTEK Physical Description Inner View Lens Connector for DI/DO Connector for DI/DO combo combo LEDs Contact pins for IR & Ethernet RJ45 microphone socket Cabling hole Cabling hole for Ethernet for DI/DO/audio SD card slot Reset button combo cable Outer View...
  • Page 10: Led Definition

    VIVOTEK LED Definition Item LED Status Description Steady Power on and system booting LED off Powered off Steady + blinking Green every 1 sec. (Green Network heartbeat LED on for 1 sec and off for another) Steady Green LED off...
  • Page 11 VIVOTEK The base plate provides mounting holes for a variety of electrical boxes. Refer to below for their associated mount hole positions: AM-525 4" square and round box 14-11/16"square gang box 1" single gang box 4" octagon box Cantex 3/4” type FSE 2 Gang, Outdoor/Indoor electrical box Generic 3/4”...
  • Page 12: Hardware Installation

    VIVOTEK Hardware Installation 1. Jot down the MAC address of the camera for later reference. This is especially important for an installation consisting of many cameras. Network Camera Model No: XXXXXX MAC: 0002D14BAD55 This device complies with part 15 of the FCC Rules. Operation is subject to...
  • Page 13 VIVOTEK 3. Install an SD card if onboard storage is preferred. 4. Use the alignment sticker to drill mounting holes or a cabling routing hole on a wall or ceiling. Route an Ethernet cable through the wall or ceiling. Hammer the included anchors into the mounting holes.
  • Page 14 VIVOTEK 5. Hold the camera with both hands and press the snap-in tab to separate the base plate from the camera. 6. Secure the base plate to wall using the included screws. P/N : 621071200G A holes 14 - User's Manual...
  • Page 15 VIVOTEK 7. Remove the silicone seal from the routing hole. 8. Remove the tip of the silicone seal by pulling it off. Insert the RJ45 connector of your Ethernet cable into the penetration cap. User's Manual - 15...
  • Page 16 VIVOTEK 9. Push the penetration cap through the center of the silicone seal. 10. Install the silicone seal to its original routing hole. 16 - User's Manual...
  • Page 17 VIVOTEK 11. Connect the Ethernet connector and secure the top of the silicone seal to the routing hole. 11. Connect the Ethernet connector and secure the top of the silicone seal to the routing hole. You may need to adjust its position.
  • Page 18 VIVOTEK 13. If you purchased a DI/DO combo cable for the FE9382, pass the white pin headers through the cabling hole. Using a crescent wrench, tighten a hex nut and washer to waterproof the combo cable. Connect these headers to the connectors on camera.
  • Page 19 VIVOTEK 15. Secure the camera to the base plate by aligning the snap-in tabs. Press until the snap-in tabs are firmly in place. 16. Install the dome cover by aligning the side-routing tab with the cabling cut-out on the base plate.
  • Page 20 VIVOTEK 17. Secure the dome cover by fastening the T10 anti-tamper screws. 18. Remove the protective sheet from the dome cover. 20 - User's Manual...
  • Page 21: Software Installation

    Software Installation 20. Install the Shepherd utility, which helps you locate and configure your Network Camera in the local network. If your camera comes without the CD, go to VIVOTEK’s website, and locate the utility in the Downloads > Software page.
  • Page 22 20-2. The program will conduct an analysis of your network environment. 20-3. The program will search for all VIVOTEK network devices on the same LAN. 20-4. After a brief search, the installer window will prompt. Click on the MAC and model name that matches the one printed on the product label.
  • Page 23 VIVOTEK Forceful Password Configuration 21. The first time you log in to the camera, the firmware will prompt for a password configuration for security concerns. 21-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 24 VIVOTEK Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~. You can use them in the password combination. 21-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 25 VIVOTEK Cybersecurity Once you open the web console, enter Configuration > Applications > Package management, and click on Trend Micro IoT Security. Turn on the protection to fend off cyber attacks. In here, you can let the camera automatically update the virus codes or manually update the virus codes.
  • Page 26 VIVOTEK DI/DO Diagram Dry contact with external DC power source to supply a relay. Dry contact is the safest connection to protect devices. Switch Photo Coupler External DC power DC 0V External AC power DC 0V with Protected Earth Relay External Device Wet contact with external DC power source to supply a relay.
  • Page 27 VIVOTEK Dry contact and using camera’s DO+ to supply a relay. Switch External AC power with Protected Earth Relay External Device User's Manual - 27...
  • Page 28: Network Deployment

    VIVOTEK Network Deployment Setting up the Network Camera over the Internet There are several ways to set up the Network Camera over the Internet. The first way is to set up the Network Camera behind a router. The second way is to utilize a static...
  • Page 29 For more information with network configuration options (such as that of streaming ports), please refer to Configuration > Network Settings. VIVOTEK also provides the automatic port for- warding feature as an NAT traversal function with the precondition that your router must support the UPnP port forwarding feature.
  • Page 30 VIVOTEK Internet connection with static IP Choose this connection type if you are required to use a static IP for the Network Camera. Please refer to LAN configuration on page 94 for details. Internet connection via PPPoE (Point-to-Point over Ethernet) Choose this connection type if you are connected to the Internet via a DSL Line.
  • Page 31 VIVOTEK IMPORTANT: If DC power is preferred, it should comply with: O/P: 12VDC, 2A min., L.P.S. per IEC 60950-1. NOTE: 1. If you encounter problems with displaying live view or the onscreen plug-in control, you may try to remove the plug-ins that might have been installed on your computer. Remove the following folder: C:\Program Files (x86)\Camera Stream Controller\.
  • Page 32: Accessing The Network Camera

    3. The live video will be displayed in your web browser. 4. If it is the first time installing the VIVOTEK network camera, an information bar will prompt as shown below. Follow the instructions to install the required plug-in on your computer.
  • Page 33 VIVOTEK NOTE: For Mozilla Firefox users, your browser will use QuickTime to stream live video. If you do not have QuickTime on your computer, please download QuickTime from Apple Inc's website, and then launch your web browser. Tips: • The onscreen Java control can malfunction under the following situations: A PC connects to different cameras that are using the same IP address (or the same camera running different firmware versions).
  • Page 34 VIVOTEK NOTE: 1. By default, your Network Camera is not password-protected. To prevent unauthorized access, it is highly recommended to configure a password for your camera later. For more information about how to enable password protection, please refer to Security on page 114.
  • Page 35: Using Rtsp Players

    Quick Time. VLC player supports H.265/H.264/MPEG-4/ MJPEG, and all audio codecs supported by VIVOTEK’s cameras. The RTSP players will show the original circular-shape image. You can access the Regional views via the VAST software. See page 102 for an example.
  • Page 36: 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 37 VIVOTEK Tips: 1. The onscreen Java control can malfunction under the following situations: A PC connects to different cameras that are using the same IP address (or the same camera running different firmware versions). Removing your browser cookies will solve this problem.
  • Page 38: Using Vivotek Recording Software

    Network Camera to the Channel list. For detailed information about how to use the recording software, please refer to the user’s manual of the software or download it from https://www.vivotek.com. Tips: 1. If you encounter problems with displaying live view or the onscreen plug-in control, you may try to remove the plug-ins that might have been installed on your computer.
  • Page 39: Main Page

    VIVOTEK Main Page This chapter explains the screen elements on the main page. It is composed of the following sections: VIVOTEK INC. Logo, Host Name, Camera Control Area, Configuration Area, and Live Video Window. VIVOTEK logo Configuration Resize Buttons Area...
  • Page 40 VIVOTEK (Original) Display mode: 1O View (Original View) When mounted on a ceiling, the fisheye camera can cover an approximate of 64 m² surveillance area (installed at a height of approximately 3 meters), while still keeping details in videos with recognizable facial features of people trafficking through the area.
  • Page 41 Both panoramic views are corrected into a more viewable dewarped image. Viewers can use a mouse click and swipe to quickly scroll horizontally through the surveillance area. * Note that the dividing line falls approximately on the center of the VIVOTEK logo on camera. 2P View (Panoramic View)
  • Page 42 VIVOTEK 1O3R (One Original & Three Regional) Display mode: The 1O3R mode provides access to multiple live view sections within the hemisphere and the reference to their relative positions on an Original circular view. The FOV indicators (#1 ~ #3) interact with your current operation as you may zoom in/out or move the live view window to a different place.
  • Page 43 VIVOTEK When you select a regional view, its relative position in the FOV will be indicated by a semi-transparent color polygon on the the circular original view. When you move your regional view, the color polygon moves accordingly. x1.00 Pan or tilt...
  • Page 44 VIVOTEK (Four Regional) Display mode: The view control and look and feel are identical to that as described in the 1O3R mode except that the Original circular view is absent from this mode. 4R PRO (Four Regional Proactive) Display mode: The 4R PRO mode is similar to the 4R mode except that the quad view windows consecutively rotate in correspondence to the change of view area in one window.
  • Page 45 VIVOTEK Profile mode: 3 pre-configured streaming profiles are provided through here: Max. view, Recording view, Live view. Each mode features a different stream source (channel), resolution, multicast, and metadata configuration. The profiles can be configured in Configuration > Media > Media profiles.
  • Page 46 VIVOTEK Pan /Tilt /Zoom speed: Adjust the speed of these controls when exerted: Pan speed Tilt speed Zoom speed Panoramic speed Slower Faster Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 51.
  • Page 47 VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Time Video (HTTP-V) 2015/03/10 17:08:56 Title and Time Video 17:08:56 2015/03/10 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 66.
  • Page 48 VIVOTEK Live Video Window ■ The following window is displayed when the video mode is set to H.265 or H.264: H.264/MPEG-4 Protocol and Media Options Time Video Title Video (TPC-AV) Video 13:59:05 2012/07/04 Title and Time Video 13:59:05 2012/07/04 Video and Audio Control Buttons Video Title: The video title can be configured.
  • Page 49 VIVOTEK Start MP4 Recording: Click this button to record video clips in MP4 file format to your computer. Press the Stop MP4 Recording button to end recording. When you exit the web browser, video recording stops accordingly. To specify the storage destination and file name, please refer to MP4 Saving Options on page 52 for details.
  • Page 50 VIVOTEK Tips: 1. The onscreen Java control can malfunction under the following situations: A PC connects to different cameras that are using the same IP address (or the same camera running different firmware versions). Removing your browser cookies will solve this problem.
  • Page 51: 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. Select to stream video or audio data or both. This is enabled only when the video mode is set to H.265 or H.264.
  • Page 52: Mp4 Saving Options

    VIVOTEK Two way audio Half duplex: Audio is transmitted from one direction at a time, e.g., from a PC holding a web console with the camera. Full duplex: Audio is transmitted in both directions simultaneously. MP4 Saving Options Users can record live video as they are watching it by clicking the “Start MP4 Recording”...
  • Page 53: Configuration

    VIVOTEK Configuration Click Configuration on the main page to enter the camera setting pages. Note that only Administrators can access the configuration page. The following is the interface of the main page: Navigation Area Configuration List Firmware Version Each function on the configuration list will be explained in the following sections.
  • Page 54: System > General Settings

    VIVOTEK System > General settings This section explains how to configure the basic settings for the Network Camera, such as the host name and system time. It is composed of the following two columns: System and System Time. System Host name: Enter a desired name for the Network Camera. The name will be displayed at the top center of the main page.
  • Page 55: System > Homepage Layout

    Theme Options (the second tab on this page). The settings will be displayed automatically in this Preview field. The following shows the homepage using the default settings: ■ Hide Powered by VIVOTEK: If you check this item, it will be removed from the homepage. Logo graph Here you can change the logo at the top of your homepage.
  • Page 56 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 field. Click Save to enable the settings.
  • Page 57 VIVOTEK ■ Follow the steps below to set up a custom homepage: 1. Click Custom on the left column. 2. Click to select a color on on the right column. Color Selector Custom Pattern 3. The palette window will pop up as shown below.
  • Page 58: System > Logs

    VIVOTEK System > Logs This section explains how to configure the Network Camera to backup system log to a remote server. Log server settings Follow the steps below to set up the remote log: 1. Select Enable remote log. 2. In the IP address text box, enter the IP address of the remote server.
  • Page 59 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 60 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 and older events will be overwritten when the number of events reaches a limit.
  • Page 61: System > Parameters

    The View Parameters page lists the entire system’s parameters in an alphabetical order. If you need technical assistance, use a text-editor program to copy and save the parameters listed on this page. Send the parameter text file to VIVOTEK’s technical support. User's Manual - 61...
  • Page 62: System > Maintenance

    Note: Do not power off the Network Camera during the upgrade! Follow the steps below to upgrade the firmware: 1. Download the latest firmware file from the VIVOTEK website. The file is in .pkg file format. 2. Click Browse… and specify the firmware file.
  • Page 63 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 94). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
  • Page 64 VIVOTEK ® 3. Open the file with Microsoft Notepad and locate your time zone; set the start and end time of DST. When completed, save the file. In the example below, DST begins each year at 2:00 a.m. on the second Sunday in March and ends at 2:00 a.m.
  • Page 65 VIVOTEK The following message is displayed when attempting to upload an incorrect file format. Export language file: Click to export language strings. VIVOTEK provides nine languages: English, Deutsch, Español, Français, Italiano, 日本語, Português, 簡体中文, and 繁體中文 . Update custom language file: Click Browse… and specify your own custom language file to upload.
  • Page 66: Media > Image

    VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following tabbed windows: General settings, Image settings, Exposure, and Privacy mask, and Pixel Calculator. General settings Video title: Enter a name that will be displayed on the title bar of the live video as well as the view cell on the ST7501 and VAST recording software.
  • Page 67 VIVOTEK Color: Select to display color or black/white video streams. Power line frequency: Set the power line frequency consistent with local utility settings to eliminate image flickering associated with fluorescent lights. Video orientation: Flip - vertically reflect the display of the live video; Mirror - horizontally reflect the display of the live video.
  • Page 68 VIVOTEK ■ Synchronize with digital input The Network Camera automatically removes the IR cut filter when a digital input is triggered, for example, when the camera is accompanied by an external IR light that comes with its own sensor and provides a signal to the camera.
  • Page 69 VIVOTEK Illuminators Turn on built-in IR illuminator in night mode Select this to turn on the camera’s onboard IR illuminator when the camera detects low light condition and enters the night mode. Turn on external illuminator in night mode Select Digital output to turn on an external IR illuminator if it is added to your application.
  • Page 70 VIVOTEK Smart IR Auto IR adjust The Smart IR function is more beneficial when the spot of intrusions or an object of your interest is close to the lens and the IR lights. For example, if an intruder has a chance of getting near the range of 3 meters, Smart IR can effectively reduce the over-exposure.
  • Page 71 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.
  • Page 72 VIVOTEK Manual IR adjust: You can manually adjust the lighting intensity of individual IR LEDs. The lighting coverage is divided into 4 zones as indicated on the configuration window. Use the pull bar below to adjust their lighting intensity. Observe the effects at night and tune for the best imaging results.
  • Page 73: Image Settings

    VIVOTEK Image settings On this page, you can tune the White balance, Image adjustment and related parameters. You can configure two sets of preferred settings: one for normal situations, the other for special situations, such as a schedule mode. Quality: select from the pull-down menu the image quality of the current live view.
  • Page 74 VIVOTEK ■ Sharpness: Adjust the image sharpness level, which ranges from 0% to 100%. ■ Gamma curve: Adjust the image sharpness level, which ranges from 0.45 to 1, from Detailed to Contrast. You may let firmware Optimize your display or select the Manual mode, and pull the slide bar pointer to change the preferred level of Gamma correction towards higher contrast or towards the higher luminance for detailed expression for both dark and lighted areas of an image.
  • Page 75: Exposure

    VIVOTEK Exposure On this page, you can configure the Exposure measurement window, Exposure level, Exposure mode, Exposure time, Gain control, and Day/Night mode settings. Quality: select the pull-down menu to configure the image quality of the current display. Measurement Window: This function allows users to set measurement window(s) for low light compensation.
  • Page 76 VIVOTEK The inclusive window refers to the “weighted window“; the exclusive window refers to the “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 77 VIVOTEK ■ Gain control: Tune the slide bar to set the Gain Control to the best image quality. Higher gain control value will generate a certain amount of noises, and that the gain control, lighting levels, and picture performance are closely related.
  • Page 78: Privacy Mask

    VIVOTEK Privacy mask Click Privacy Mask to open the configuration page. On this page, you can block out certain sensitive zones to address privacy concerns. ■ To configure the privacy mask windows, follow the steps below: 1. Click New to add a new window. A text box will appear allowing you to enter a name for the mask.
  • Page 79: Pixel Calculator

    VIVOTEK Pixel Calculator Click the Add button at the lower screen to create a pixel calculator window. Place your cursor on the window to move it to an area of your interest, and change the size of window to fit the area of interest.
  • Page 80 VIVOTEK Take the following into consideration when using this feature: 1. Operational requirement: Identify a human or a human face. 2. Why human face? There are less variances in the size of a face than that for limbs and body. Human face is normally 16cm wide.
  • Page 81: Media > Video

    VIVOTEK Media > Video Stream settings Please follow the steps below to set up those settings for an individual stream: 1. Select a stream to configure its viewing region. 2. Choose a proper Frame Size from the drop-down list according to the size of monitored device.
  • Page 82 VIVOTEK Click the stream item to display the detailed information. This Network Camera offers real-time H.265, H.264 and MJPEG compression standards (dual Codec) for real-time viewing. If the H.265 H.264 mode is selected, the video is streamed via RTSP protocol. There are several parameters for you to adjust the video performance: ■...
  • Page 83 VIVOTEK ■ Maximum frame rate This limits the maximum refresh frame rate per second. Set the frame rate higher for smoother video quality and for recognizing moving objects in the field of view. If the power line frequency is set to 50Hz, the frame rates are selectable at 1fps, 2fps, 3fps, 5fps, 8fps, 10fps, 15fps, 20fps, and 25fps.
  • Page 84 VIVOTEK Smart stream III ■ Dynamic Intra frame period High quality motion codecs, such as H.265 or H.264, utilize the redundancies between video frames to deliver video streams at a balance of quality and bit rate. The encoding parameters are summarized and illustrated below. The I-frames are completely self- referential and they are largest in size.
  • Page 85 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 86 VIVOTEK Smart codec effectively reduces the quality of the whole or the non-interested areas on a ■ screen and therefore reduces the bandwidth consumed. You can manually specify the video quality for the foreground and the background areas. Slide bar to the right - higher quality in the ROI...
  • Page 87 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 88 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...
  • Page 89 VIVOTEK Fixed quality: On the other hand, if Fixed quality is selected, all frames are transmitted with the same quality; bandwidth utilization is therefore unpredictable. The video quality can be adjusted to the following settings: Medium, Standard, Good, Detailed, and Excellent. You can also select Customize and manually enter a value.
  • Page 90 VIVOTEK If the JPEG mode is selected, the Network Camera sends consecutive JPEG images to the client, producing a moving effect similar to a filmstrip. Every single JPEG image transmitted guarantees the same image quality, which in turn comes at the expense of variable bandwidth usage. Because the media contents are a combination of JPEG images, no audio data is transmitted to the client.
  • Page 91: Media > Audio

    VIVOTEK Media > Audio Audio Settings Mute: Select this option to disable audio transmission from the Network Camera to all clients. Note that if mute mode is turned on, no audio data will be transmitted even if audio transmission is enabled on the Client Settings page.
  • Page 92 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 93: Media Profiles

    VIVOTEK Media profiles You can configure a different video stream for each of the 3 default profiles, Max. view, Recording, and Live view. 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 94: Network > General Settings

    Use fixed IP address: Select this option to manually assign a static IP address to the Network Camera. 1. You can make use of VIVOTEK Installation Wizard 2 on the software CD to easily set up the Network Camera on LAN. Please refer to Software Installation on page 21 for details.
  • Page 95 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 name and IP address.
  • Page 96 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 97 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 98 VIVOTEK Enable IPv6 Select this option and click Save to enable IPv6 settings. Please note that this only works if your network environment and hardware equipment support IPv6. The ® browser should be Microsoft Internet Explorer 6.5, Mozilla Firefox 3.0 or above.
  • Page 99 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 100: Network > Streaming Protocols

    VIVOTEK Network > Streaming protocols HTTP streaming To utilize HTTP authentication, make sure that you have set a password for the Network Camera first; please refer to Security > User account on page 114 for details. Authentication: Depending on your network security requirements, the Network Camera provides two types of security settings for an HTTP transaction: basic and digest.
  • Page 101 VIVOTEK URL command -- http://<ip address>:<http port>/<access name for stream 1 ~ 4> 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.
  • Page 102 VIVOTEK Authentication: Depending on your network security requirements, the Network Camera provides three types of security settings for streaming via RTSP protocol: disable, basic, and digest. basic authentication is selected, the password is sent in plain text format, but there can be potential digest risks of it being intercepted.
  • Page 103 VIVOTEK RTSP port /RTP port for video, audio/ RTCP port for video, audio ■ RTSP (Real-Time Streaming Protocol) controls the delivery of streaming media. By default, the port number is set to 554. ■ The RTP (Real-time Transport Protocol) is used to deliver video and audio data to the clients. By default, the RTP port for video is set to 5556 and the RTP port for audio is set to 5558.
  • Page 104 Unrestricted in scope IMPORTANT: The Multicast metadata port is utilized by VIVOTEK VADP modules to transfer video analytics results, PTZ stream, textual data, and event messages between the camera and the client side running and observing the video analysis. If your client side computer is located outside the local network, you may need to open the associated TCP port on routers and firewall.
  • Page 105 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 106 DDNS: Dynamic domain name service Enable DDNS: Select this option to enable the DDNS setting. Provider: Select a DDNS provider from the provider drop-down list. VIVOTEK offers Safe100.net, a free dynamic domain name service, to VIVOTEK customers. It is recommended that you register Safe100.net to access VIVOTEK’s Network Cameras from the Internet.
  • Page 107 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 108 VIVOTEK Express link Express Link is a free service provided by VIVOTEK server, which allows users to register a domain name for a network device. One URL can only be mapped to one MAC address. This service will examine if the host name is valid and automatically open a port on your router. If using DDNS, the user has to manually configure UPnP port forwarding.
  • Page 109: Network > Qos (Quality Of Service)

    VIVOTEK Network > QoS (Quality of Service) Quality of Service refers to a resource reservation control mechanism, which guarantees a certain quality to different services on the network. Quality of service guarantees are important if the network capacity is insufficient, especially for real-time streaming multimedia applications. Quality can be defined as, for instance, a maintained level of bit rate, low latency, no packet dropping, etc.
  • Page 110 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 111: 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 112: Network > Ftp

    FTP function. You can disable the FTP server function when it is not in use. FTP port: The FTP server allows the user to save recorded video clips. You can utilize VIVOTEK's Shepherd utility to upgrade the firmware via FTP server. By default, the FTP port is set to 21. It can also be assigned to another port number between 1025 and 65535.
  • Page 113: 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 114: 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 115 VIVOTEK Privilege management Digital Output & PTZ control: You can modify the management privilege as operators or viewers. Select or de-select the checkboxes, and then click Save to enable the settings. If you give Viewers the privilege, Operators will also have the ability to control the Network Camera through the main page.
  • Page 116: 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 117 VIVOTEK 5. Click Save to preserve your configuration, and your current session with the camera will change to the encrypted connection. 6. If your web session does not automatically change to an encrypted HTTPS session, click Home to re- turn to the main page. Change the URL address from “http://” to “https://“ in the address bar and press Enter on your keyboard.
  • Page 118 VIVOTEK Create certificate request and install 1. Select the option from the Method pull-down menu. 2. Click Create certificate to proceed. 3. The following information will show up in a pop-up window after clicking Create. Then click Save to generate the certificate request.
  • Page 119 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 120 VIVOTEK 7. Open a new edit, paste the certificate contents, and press ENTER at the end of the contents to add an empty line. 8. Convert file format from DOS to UNIX. Open File menu > Conversions > DOS to Unix.
  • Page 121 VIVOTEK 9. Save the edit using the “.crt” extension, using a file name like “CAcert.crt.” 10. Return to the original firmware session, use the Browse button to locate the crt certificate file, and click Upload to enable the certification. User's Manual - 121...
  • Page 122 VIVOTEK Note that a 11. When the certifice file is successfully loaded, its status will be stated as Active. certificate must have been created and installed before you can click on the “Save" button for the configuration to take effect.
  • Page 123: 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, #2, and #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 QuickTime Player).
  • Page 124 VIVOTEK ■ Disconnect: If you want to break off the current connections, please select them and click this button. Please note that those checked connections will only be disconnected temporarily and will automatically try to re-link again (IE Explorer or QuickTime Player).
  • Page 125 VIVOTEK Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List. The routing prefix is written in CIDR (Classless Inter-Domain Routing) notation. For example: accesses from IP address 192.168.2.x will be bolcked.
  • Page 126: Security > Ieee 802.1X

    Authentication server (usually a RADIUS server): Checks the client certificate and decides whether to accept the end user’s access request. ■ VIVOTEK Network Cameras support two types of EAP methods to perform authentication: EAP-PEAP and EAP-TLS. Please follow the steps below to enable 802.1x settings: 1.
  • Page 127 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 128 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 129: Ptz > Ptz Settings

    VIVOTEK PTZ > PTZ settings This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation. The fisheye PTZ function allows users to move among regional views for close-up viewing. The PTZ view takes effect when the current field of view is not the round-shape original view or the panoramic view.
  • Page 130: Ptz Settings

    VIVOTEK PTZ Settings Zoom Out Zoom In Preset positions and rotation settings In the PTZ settings page, you can create preset positions in the hemisphere covered by the fisheye lens. A total of 20 preset positions can be configured. Please follow the steps below to configure preset positions and arrange them in a rotational tour through different positions.
  • Page 131 VIVOTEK 2. Adjust the shooting area to the desired position using the PTZ keypad, the FOV indicators, or mouse clicks on the live screen. To begin the mouse control, click on the two interactive windows. Due to the highly-sensitive mouse control, the PTZ control buttons can help fine-tune to an optimal location.
  • Page 132: 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 133 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 134 VIVOTEK ■ Audio detection A preset threshold can be configured with an external microphone as the trigger to system event. The triggering condition can be an input exceeding or falling below a threshold. Audio detection can take place as a complement to motion detection or as a method to detect activities not covered by the camera's view.
  • Page 135 VIVOTEK ■ VADP It is presumed that you already uploaded and enabled the VADP modules before you can associatee VADP triggers with an Event setting. Click on the Set VADP Trigger button to open the VADP setup menu. The triggering conditions available with 3rd-party software modules known as VADP will be listed.
  • Page 136 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 digital output signals (via the DO connectors on the main assembly) when a trigger is activated.
  • Page 137 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. You should have recorded or uploaded an audio file in the Configuration > Media > Audio > Audio clips page.
  • Page 138: Add Server

    VIVOTEK Add server Click Add server to unfold the server setting window. You can specify how the notification messages are delivered when a trigger is activated. A total of 5 server settings can be configured. There are four choices of server types available: Email, FTP, HTTP, and Network storage. Select the item to display the detailed configuration options.
  • Page 139 VIVOTEK To verify if the email settings are correctly configured, click Test. The result will be shown in a pop-up window. If successful, you will also receive an email indicating the result. Click Save server to enable the settings, then click Close to exit the Add server page.
  • Page 140 VIVOTEK ■ Passive mode Most firewalls do not accept new connections initiated from external requests. If the FTP server supports passive mode, select this option to enable passive mode FTP and allow data transmission to pass through the firewall. To verify if the FTP settings are correctly configured, click Test. The result will be shown in a pop-up window as shown below.
  • Page 141 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 142 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 143 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 144 VIVOTEK Network storage: Select to send the media files to a network storage location when a trigger is activated. Please refer to NAS server on page 164 for details. Click Save server to enable the settings, then click Close to exit the Add server page.
  • Page 145: Add Media

    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 146 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_20200720_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings, then click Close to exit the Add media page.
  • Page 147 VIVOTEK ■ Maximum duration Specify the maximum recording duration in seconds. Up to 10 seconds of video can be recorded. For example, if pre-event recording is set to 5 seconds and the maximum duration is set to 10 seconds, the Network Camera continues to record for another 4 seconds after a trigger is activated.
  • Page 148 VIVOTEK ■ View: Click this button to open a file list window. This function is only for SD card and Network Storage. If you click View button of SD card, a Local storage page will pop up for you to manage recorded files on SD card.
  • Page 149 VIVOTEK Here is an example of the Event setting: When completed the settings with steps 1~3 to arrange Schedule, Trigger, and Action of an event, click Save event to enable the settings and click Close to exit the page. The following is an example of the Event setting page:...
  • Page 150 VIVOTEK When the Event Status is ON, once an event is triggered by motion detection, the Network Camera will automatically send snapshots via e-mail. status or click Delete to remove a If you want to stop the event trigger, you can click to turn it to previously-configured event setting.
  • Page 151 Please note that there is a limited number of customized scripts you can upload; if the current amount of customized scripts has reached the limit, an alert message will prompt. If you need more information, please contact VIVOTEK’s technical support. Click to upload a file...
  • Page 152: 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 153: Applications > Smart Vca

    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: http://download.vivotek. com/downloadfile/solutions/vadp/smart-vca-manual_en.pdf. Click on Configuration > Applications > Smart VCA. The Smart VCA utility will be automatically started.
  • Page 154: Applications > Di And Do

    VIVOTEK Applications > DI and DO Digital input: Select High or Low as the Normal status for the digital input. Connect the digital input pin of the Network Camera to an external device to detect the current connection status. Digital output: Select Grounded or Open to define the normal status for the digital output. Connect the digital output pin of the Network Camera to an external device to determine the current status.
  • Page 155: 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 156: Applications > Audio Detection

    VIVOTEK Applications > Audio detection Audio detection, along with video motion detection, is applicable in the following scenarios: 1. Detection of activities not covered by camera view, e.g., a loud input by gun shots or breaking a door/ window. 2. A usually noisy environment, such as a factory, suddenly becomes quiet due to a breakdown of machines.
  • Page 157 VIVOTEK You can use the Profile window to configure a different Audio detection setting. For example, a place can be noisy in the day time and become very quiet in the night. 1. Click on the Enable this profile checkbox. Once the Audio detection window is opened, the current sound input will be interactively indicated by a fluctuating yellow wave diagram.
  • Page 158: 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.
  • Page 159: Applications > Package Management - A.k.a., Vadp (Vivotek Application Development Platform)

    VADP requirements. Please contact our technical support or the vendor of your 3rd-party module for the parameters contained within. • Users can also run VIVOTEK's VADP packages as a means to access updated functionality instead of replacing the entire firmware. •...
  • Page 160 VIVOTEK To start a module, select the checkcircle in front, and click the Start button. If you should need to remove a module, select the checkcircle in front and then click the Stop button. By then the module status will become OFF, and the X button will appear at the end of the row.
  • Page 161 VIVOTEK On the License page, register and activate the license for using VIVOTEK's VADP modules. You should acquire the license key elsewhere, and manually upload to the network camera. Follow the onscreen instruction on VIVOTEK's website for the registration procedure.
  • Page 162: Recording > Recording Settings

    VIVOTEK Recording > Recording settings This section explains how to configure the recording settings for the Network Camera. Recording Settings NOTE: 1. Each Recording setting records a video stream from one channel, i.e., from a single lens module. 2. Please remember to format your SD card when used for the first time. Please refer to page 167 for detailed information.
  • Page 163 VIVOTEK ■ Recording name: Enter a name for the recording setting. ■ Enable this recording: Select this option to enable video recording. ■ With adaptive recording: Select this option will activate the frame rate control according to alarm trigger. The frame control means that when there is a triggered alarm/event, the frame rate will raise up to the value you’ve set...
  • Page 164 VIVOTEK Please follow steps 1~2 below to set up the recording: 1. Trigger Select a trigger source. ■ Schedule: The server will start to record files on the local storage or network attached storage (NAS). ■ Network fail: Since network fail, the server will start to record files onto the local storage (SD card).
  • Page 165 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. Enter a server name. 4. Click Save to complete the settings and click Close to exit the page.
  • Page 166 VIVOTEK ■ Enable cyclic recording: If you check this item, when the maximum capacity is reached, the oldest file will be overwritten by the latest one. Recording file management ■ Maximum duration: This determines the length of each recorded video, applicable from 1 to 60 minutes.
  • Page 167: 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 168: 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.
  • Page 169 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 170: 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 171 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 172 VIVOTEK ■ Lock/Unlock: Select the checkbox in front of a desired search result, then click this button. The selected items will become Locked, which will not be deleted during cyclic recording. You can click again to unlock the selections. For example:...
  • Page 173: 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 174 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 3. General CGI URL Syntax and Parameters CGI parameters are written in lower-case and as one word without any underscores or other separators. When the CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server.
  • Page 175 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 4. Security Level SECURITY LEVEL SUB-DIRECTORY DESCRIPTION anonymous Unprotected. 1 [view] viewer Can view, listen, and talk to camera. 4 [operator] operator Operator access rights can modify most of the camera’s parameters except some privileges and network options.
  • Page 176 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 5. Get Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/viewer/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/operator/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/admin/getparam.cgi?[<parameter>] [&<parameter>…] Where the <parameter> should be <group>[_<name>] or <group>[.<name>]. If you do not specify any parameters, all the parameters on the server will be returned.
  • Page 177 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n User's Manual - 177...
  • Page 178 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/operator/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/admin/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>]...
  • Page 179 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved [<parameter pair>] Only the parameters that you set and are readable will be returned. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123 Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n...
  • Page 180 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7. Available Parameters on the Server Valid values: VALID VALUES DESCRIPTION string[<n>] Text strings shorter than ‘n’ characters. The characters “,’,<,>,& are invalid. string[n~m] Text strings longer than `n’ characters and shorter than `m’ characters.
  • Page 181 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved VALID VALUES DESCRIPTION <WxH> The format for resolution. W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 available The API is listed in product WebAPIs.
  • Page 182 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <blank> timezoneindex -489 ~ 529 Indicate timezone and area. -480: GMT-12:00 Eniwetok, Kwajalein -440: GMT-11:00 Midway Island, Samoa -400: GMT-10:00 Hawaii -360: GMT-09:00 Alaska -320: GMT-08:00 Las Vegas,...
  • Page 183 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 120: GMT 03:00 Baghdad, Kuwait, Riyadh, Moscow, St. Petersburg, Nairobi 121: GMT 03:00 Iraq 140: GMT 03:30 Tehran 160: GMT 04:00 Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan...
  • Page 184 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) daylight_auto_begintim string[19] Display the current daylight saving start time. daylight_auto_endtime string[19] Display the current daylight saving end time. daylight_timezones string List time zone index which support daylight saving time.
  • Page 185 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <positive values except the custom language file integer> the user has uploaded. This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.
  • Page 186 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when "capability_image_c<0~(n-1)>_lensconfig uration_support" != 0. 7.1.1 System.Info Subgroup of system: info (The fields in this group are unchangeable.) NAME VALUE SECURITY DESCRIPTION (get/set) modelname...
  • Page 187 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) language_i7 : 简体中文 language_i8 : 繁體中文 customlanguage_max 0,<positive Maximum number of custom languages count integer> supported on the server. customlanguage_coun 0,<positive Number of custom languages which have integer>...
  • Page 188 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.2.1 Status per Channel Group: status_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) signal_detect <boolean> Indicates whether the video source is connected or not.
  • Page 189 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) privilege_camctrl view, operator, Indicate which privileges and above admin can control PTZ (capability_ptzenabled > 0 or capability_eptz > 0 or capability_fisheye > 0) user_i0_name string[64] User name of root user_i<1~20>_name...
  • Page 190 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) changing port settings. Change HTTP port from 80 to 5556, and change RTP port for video from 5556 to 20480. Then, set preprocess=9 to stop both service first.
  • Page 191 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) password string[200] Password for TLS privatekeypassword string[200] Password for PEAP ca_exist <boolean> CA installed flag ca_time 0,<positive CA installed time. Represented in integer> EPOCH ca_size 0,<positive CA file size (in bytes) integer>...
  • Page 192 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) video 0~63 Video channel for DSCP audio 0~63 Audio channel for DSCP (capability_naudioin > 0) eventalarm 0~63 Event/alarm channel for DSCP management 0~63 Management channel for DSCP...
  • Page 193 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) authmode basic, HTTP authentication mode. digest s<0~(capability_nmed string[32] Http server push access name for stream iastream*capability_n N, N= videoin)-1)>_accessna 1~(capability_nmediastream*capability_ nvideoin)-1). <product dependent> (capability_protocol_spush_mjpeg =1 <Not recommended and capability_nmediastream >...
  • Page 194 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) and capability_nmediastream > 0) The value are shown as video1s1.mjpg = c0_s0_accessname, (channel1stream1) video1s2.mjpg = c0_s1_accessname, (channel1stream2) video2s1.mjpg = c1_s0_accessname, (channel2stream1) video2s2.mjpg = c1_s1_accessname, (channel2stream2) etc. * We support this parameter when the version number (httpversion) is equal or greater than 0311c.
  • Page 195 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) =1 and capability_nmediastream > 0) <product dependent> The value are shown as live1s1.sdp = s0_accessname, (channel1stream1) live1s2.sdp = s1_accessname, (channel1stream2) live1s3.sdp = s2_accessname, (channel1stream3) live1s4.sdp = s3_accessname, (channel1stream4) etc.
  • Page 196 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * We modify the value of RTSP access name after version number(httpversion) is 0311c pimssm_enable <boolean> To enable the feature of Protocol Independent Multicast - Source Specific Multicast.
  • Page 197 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) number (httpversion) is equal or greater than 0304a. videoport 1025 ~ Multicast video port. 65535 audioport 1025 ~ Multicast audio port. <product 65535 * Only available when capability_naudioin > 0 dependent>...
  • Page 198 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) pass password[64] PPPoE account password. 7.6.13 Bonjour Subgroup of network: service_bonjour NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable bonjour service feature. * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
  • Page 199 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) address - end ip address> ipv6list_i<0~9> string[43] IPv6 address list. 7.8 Video Input <Not Recommended to use> Group: videoin * We do not support this parameter when "capability_nvideoin > 1".
  • Page 200 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) balance (2000K to 10000K). "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...
  • Page 201 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. irismode fixed, indoor, Control DC-Iris mode. outdoor "outdoor": Auto-setting DC-Iris to get <product...
  • Page 202 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) support" is 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.
  • Page 203 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ...
  • Page 204 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * 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 205 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Preview settings of video profile. * Only available when "capability_image_c<0~(n-1)>_exposu re_mode" !=0 * 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 206 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) white balance module. Then, act as rbgain mode "widerange": Auto Tracing White balance (2000K to 10000K). "outdoor": auto white balance mode specifically for outdoor. "indoor": auto white balance mode specifically for indoor.
  • Page 207 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) from DC's exposure tuning options. 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...
  • Page 208 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only available when "capability_image_c<0~(n-1)>_exposu re_mode" !=0 irismode fixed, indoor, outdoor Control DC-Iris mode. <product dependent> "outdoor": Auto-setting DC-Iris to get best quality, but easy to meet rolling or flicker effect in indoor environment.
  • Page 209 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) "capability_image_c<0~(n-1)>_iristype "=piris 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 210 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only available when "capability_image_c<0~(n-1)>_agc_m axgain" != "-" and "capability_image_c<0~(n-1)>_exposu re_rangetype" is "onevalue". * Normalized range. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 211 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) imprinttimesta <boolean> Overlay time stamp on video. textonvideo_p top, bottom Text on video string position osition textonvideo_si 20~40 Text on video font size textonvideo_fo /usr/share/font/Default.ttf Choose camera default font file ntpath , /mnt/flash2/upload.ttf...
  • Page 212 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s. * Only available when "capability_image_c<0~(n-1)>_exposu...
  • Page 213 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only available when "capability_image_c<0~(n-1)>_exposu re_mode" !=0 meteringmode auto, "auto": The algorithm chooses the blc, best metering strategy. "blc": This metering method increases * Available value is listed the weight of dark area.
  • Page 214 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) the version number (httpversion) is equal or greater than 0310a. s<0~(m-1)>_en <boolean> Indicate whether stream supprts eptz ableeptz or not s<0~(m-1)>_co Listed at Codec type for this stream dectype "capability_videoin_codec...
  • Page 215 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) The unit is millisecond (ms). s<0~(m-1)>_h2 cbr, vbr cbr: Constant bit rate mode. 64_ratecontrol vbr: Fixed quality mode, all frames are mode encoded in the same quality.
  • Page 216 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 64_cbr_quant 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only available when "h264_ratecontrolmode"= cbr. s<0~(m-1)>_h2 1~100 Select customized quality in a 64_cbr_qperce normalized full range.
  • Page 217 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) q_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. s<0~(m-1)>_h2 <boolean> Enable "Dynamic intra frame period". 65_dintraperio...
  • Page 218 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) 65_qvalue Q value which is used by encoded library directly. * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "h265_ratecontrolmode"= vbr and s<0~(m-1)>_h265_quant = 99.
  • Page 219 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) s<0~(m-1)>_h2 1~100 Select customized quality in a 65_cbr_qperce normalized full range. 1: Worst quality 100: Best quality * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "h265_ratecontrolmode"= cbr and...
  • Page 220 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) able "capability_videoin_codec". * Only available when "capability_videoin_c<0~(n-1)>_smart q_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. cbr: Constant bit rate mode.
  • Page 221 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) peg_qpercent normalized full range. 1: Worst quality 100: Best quality * Only valid when "mjpeg_ratecontrolmode"= vbr and s<0~(m-1)>_mjpeg_quant = 100. s<0~(m-1)>_mj 20000~"capability_videoin The maximum allowed bit rate in fixed peg_maxvbrbit _c<0~(n-1)>_mjpeg_maxbi...
  • Page 222 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) s<0~(m-1)>_mj framerate,imagequality Set prioritypolicy peg_prioritypo * Only valid when licy "mjpeg_ratecontrolmode"= cbr s<0~(m-1)>_mj 1~"capability_videoin_c<0 The maximum frame rates of a mjpeg peg_maxframe ~(n-1)>_mjpeg_maxframer stream at different ate"...
  • Page 223 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) mode" is 1 wdrc_strength 1~100 The strength of WDR enhanced. <product The bigger value means the stronger dependent> strength of WDR enhanced. * Only available when "capability_image_c<0~(n-1)>_wdrc_ mode"...
  • Page 224 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( DESCRIPTION get/set) * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1 and "capability_image_c<0~(n-1)>_aespee dsupportsensitivity" is 1. flickerless <boolean> Turn on(1) or turn off(0) the flickerless <product mode dependent> * Only available when "capability_image_c<0~(n-1)>_flickerl...
  • Page 225 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved capability_smartstream_version>=2.0 and h265 is listed in "capability_videoin_codec") n denotes the value of "capability_nvideoin",m denotes the value of " capability_nmediastream" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or Disable smart codec function...
  • Page 226 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved "capability_videoin_codec" and capability_smartstream_mode_manual = 1) n denotes the value of "capability_nvideoin",m denotes the value of " capability_nmediastream",k denotes the value of "capability_smartstream_nwindow_manual". NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the window.
  • Page 227 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". maxexposure <1~32000>, Maximum exposure time <product <5~32000>, 1~32000 => 1s ~ 1/32000s dependent> <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>,...
  • Page 228 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s. * Only available when "capability_image_c<0~(n-1)>_exposu...
  • Page 229 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 12: EV +2.0 *Only available when "capability_image_c0_exposure_mod e" != 0 exposuremode auto, Select exposure mode. <product shutterpriority, "auto": Automatically adjust the Iris, dependent> irispriority, Gain and Shutter Speed to fit the qualitypriority, exposure level.
  • Page 230 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) b. if "rbgain" is supported, "rgain" "capability_image_c<0~(n- and "bgain" are updated to the 1)>_wbmode") current values which is got from white balance module. Then, act as rbgain mode "widerange": Auto Tracing White...
  • Page 231 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Normalized range. maxgain 0~100 Maximum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_m axgain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed...
  • Page 232 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) meteringmode auto, "auto": The algorithm chooses the blc, best metering strategy. "blc": This metering method increases the weight of dark area. * Available value is listed "hlc": The metering method can detect strong light and make affected "capability_image_c<0~(n-...
  • Page 233 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) best quality, but easy to meet rolling or flicker effect in indoor environment. "indoor": Avoid rolling and flicker effect first. "fixed": Open the iris to maximum. * Only available when "capability_image_c<0~(n-1)>_iristype...
  • Page 234 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <product 1: on dependent> * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1 aespeed_spee 1~100 The speed level of AE converge speed. dlevel 1~20: level 1 <product 21~40: level 2 dependent>...
  • Page 235 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) ess" is 1 7.8.2 Multicast Settings for Video Streaming Group: videoin_c<0~(n-1)>_s<0~(m-1)>_multicast (capability_media_streamprofiles_support = 1) n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" NAME...
  • Page 236 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0312a. c<0~(n-1)>_s< <boolean> Enable time shift streaming for 0~(m-1)>_allo specific stream. 7.10 IR Cut Control <Not recommended to use this>...
  • Page 237 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) is equal or greater than 0400a. daymodebegintime 00:00~23:59 Day mode begin time <Not * We replace this parameter with recommended to “ircutcontrol_c<0~(n-1)>_daymodebe use this> gintime” when the version number (httpversion) is equal or greater than 0312a.
  • Page 238 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) is equal or greater than 0400a. enableextled <boolean> Enable/disable external IR led <Not * Only available when recommended to "capability_daynight_c<0~"capability_ use this> nvideoin"-1>_externalir > 0". * We replace this parameter with "ircutcontrol_illuminators_external_d...
  • Page 239 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
  • Page 240 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_daynight_ (httpversion) is equal or greater than c<0~(n-1)>_spectrum 0312a. _mode". * 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 241 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved * We support this parameter when the version number (httpversion) is equal or greater than 0312a. daymodeendtime 00:00~23:59 Day mod end time * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
  • Page 242 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved (get/set) builtin_irled_enabled <boolean> Enable/disable built-in IR led * Only available when "capability_daynight_illuminators_buil 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.
  • Page 243 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved ernal_support > 0" and "do<2~(capability_ndo)>" are listed in "capability_daynight_illuminators_ext ernal_interface". * We support this parameter when the version number (httpversion) is equal or greater than 0312a. spectrum_mode visible, Set spectrum method .
  • Page 244 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) contrast -5~5,100 -5: Less contrast <-> 5: More contrast <Not 100: Use " recommended to image_c<0~(n-1)>_contrastpercent" use this> * Only available when bit 1 of "capability_image_c<0~(n-1)>_basicse tting" is 1.
  • Page 245 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0: Darker <-> 100: Bright * Only available when bit 0 of "capability_image_c<0~(n-1)>_basicse tting" is 1. contrastpercent 0~100 Set contrast in the normalized range. 0: Less contrast <-> 100: More...
  • Page 246 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when "capability_image_c<0~(n-1)>_gamm acurve" is 1 lowlightmode <boolean> Enable/disable low light mode. <product * Only available when dependent> "capability_image_c<0~(n-1)>_lowligh tmode" is 1 <boolean> Enable/disable hightlight mask.
  • Page 247 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) e". eis_strength 1~100 Strength of electronic image stabilizer <product * Only available when 'eis' is listed in dependent> "capability_image_c<0~(n-1)>_is_mod e". dis_mode <boolean> Digital image stabilizer <product 0:disable dependent>...
  • Page 248 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1)>_freeze" is 1 deinterlace_enable <boolean> Enable/disable deinterlace function. 0: disable 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...
  • Page 249 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * Only available when "capability_image_c<0~(n-1)>_lens_ld c_support" is 1. palette_mode Available value is Set color palette option. listed in "capability_image_c< * Only available when 0~(n-1)>_palette_mo "capability_image_c<0~(n-1)>_palette de" _support" is 1.
  • Page 250 VIVOTEK © 2020 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)> -5~5,100 -5: Less contrast <-> 5: More contrast _contrast 100: Use " <Not image_c<0~(n-1)>_contrastpercent" recommended to use this>...
  • Page 251 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) tting" is 1. * We replace "profile_i0_saturation" with "profile_i0_saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
  • Page 252 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 3: Gamma value = 0.03 100: Gamma value = 1 * Note: Although we set gamma value to 100 level, but not all gamma values are valid. Internal module will take the closest valid one.
  • Page 253 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) profile_i<0~(m-1)> 1~100 Strength of defog _defog_strength * Only available when <product "capability_image_c<0~(n-1)>_defog_ dependent> mode" is 1 profile_i<0~(m-1)> <boolean> Electronic image stabilizer _eis_mode 0:disable <product 1:enable dependent> * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mod...
  • Page 254 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_image_c<0~(n-1) Compensation), and the only >_exposure_winmode" exposure window is located at the center of view. "hlc": Use HLC (High Light Compensation), and to perform the masking of bright light area.
  • Page 255 VIVOTEK © 2020 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...
  • Page 256 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Compensation), and the only exposure window is located at the center of view. "hlc": Use HLC (High Light Compensation), and to perform the masking of bright light area.
  • Page 257 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) re_windomain". 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...
  • Page 258 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) or greater than 0301a. * We replace "source" with "input". More details, please refer the parameter description of "input". input intmic, extmic intmic: Internal (built-in) microphone. <product (Only available when dependent>...
  • Page 259 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) gain 0~100 Gain of input. <Not recommended (audioin_c<0~(n-1)>_source = linein) to use this> * Reserved for compatibility, and suggest don't use this since the version number (httpversion) is equal or greater than 0301a.
  • Page 260 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 96000, 128000 s0_gamr_bitrate 4750, AMR encoded bitrate in bps. 5150, * Only available if AMR is supported. 5900, 6700, 7400, 7950, 10200, 12200 s0_g711_mode pcmu, Set G.711 companding algorithm.
  • Page 261 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) alarm_enable <boolean> Enable audio detection alarm_level 1~100 Audio detection alarm level profile_i0_enable <boolean> Enable/disable this profile setting profile_i0_policy night, The mode which the profile is applied schedule * Not support "policy=day"...
  • Page 262 VIVOTEK © 2020 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.
  • Page 263 VIVOTEK © 2020 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 264 VIVOTEK © 2020 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>...
  • Page 265 VIVOTEK © 2020 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 266 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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,...
  • Page 267 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) to use this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
  • Page 268 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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 > 0) n denotes the value of "capability_nvideoin"...
  • Page 269 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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 > 0)
  • Page 270 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 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 271 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 1: Show log of parameter setting set from external. 2. Show log of parameter setting set from external and internal. 7.23 SNMP Group: snmp (capability_protocol_snmp > 0)
  • Page 272 Hyperlink of the logo http://www.vivot ek.com logo_powerbyvvtk_hidd <boolean> 0 => display the power by vivotek logo 1 => hide the power by vivotek logo custombutton_manualtr <boolean> Show or hide manual trigger (VI) igger_show button in homepage 0 -> Hidden 1 ->...
  • Page 273 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.25 Privacy Mask Group: privacymask_c<0~(n-1)> for n channel products and m privacy mask window. n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean>...
  • Page 274 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 0 ~ W,0 ~ H, position. 0 ~ W,0 ~ H, (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 0 ~ W,0 ~ H * Only available when W: 0~ The "capability_image_c<0~(n-1)>_privacy current image mask_wintype"...
  • Page 275 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) >_maxpan" "capability_camctrl_c<0~(n-1)>_ buildinpt" is "1" win_i<0~(m-1)>_tilt "capability_ptz_c<0~(n-1) Tilt position of window position. >_mintilt" ~ * Only available when bit1 of "capability_ptz_c<0~(n-1) "capability_camctrl_c<0~(n-1)>_ >_maxtilt" buildinpt" is "1" win_i<0~(m-1)>_zoom "capability_ptz_c<0~(n-1)
  • Page 276 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) change the old features and interfaces. Revision Increase the revision when fix bugs without change any features of the output. _platform This is a constant, it is used to...
  • Page 277 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) capability_daynight_c<0~"capability_ nvideoin"-1>_externalir for external * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. npir Number of PIRs. <positive integer>...
  • Page 278 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) <positive integer> nmotion <positive integer> The number of motion window. nmotionprofile 0, <positive integer> Number of motion profiles. nevent 0, <positive integer> Number of event. * We support this parameter when the version number (httpversion) is equal or greater than 0311c.
  • Page 279 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) is supported or SD/PZ/PT/PD/video server series) Bit 6 => (only available when bit0 is 1) Reserved bit; always 0. Bit 7 => (only available when bit0 is 1) External or built-in PT;...
  • Page 280 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) presettourdirection <boolean> Indicate whether to support preset tour direction function. It means users can choose which direction the preset tour goes. * We support this parameter when the version number (httpversion) is equal or greater than 0307a.
  • Page 281 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) channel. For some dual-stream products, both streams support ePTZ. nanystream 0, <positive integer> number of any media stream per channel <boolean> Indicate whether to support Intelligent Video analysis whitelight <boolean>...
  • Page 282 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "tampering" = Tamper detection. "vi" = Virtual input (Manual trigger) "vadp" = VADP trigger. "di"= Digital input. "volalarm" = Audio detection. "temperature" = Temperature detection. "pir" = PIR detection.
  • Page 283 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) protocol_rtp_multi <boolean> Indicate whether to support scalable cast_scalable multicast. protocol_rtp_multi <boolean> Indicate whether to support cast_backchannel backchannel multicast. protocol_rtp_tcp <boolean> Indicate whether to support RTP over TCP.
  • Page 284 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) xframerate "-" "capability_videoin_c0_mjpeg_maxfra merate". * This is kept for compatibility. videoin_h264_max A list of <Integer> and This equals framerate "-" "capability_videoin_c0_h264_maxfra merate". * This is kept for compatibility.
  • Page 285 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * We support this parameter when the version number (httpversion) is equal or greater than 0306b. audio_aecaffect When acoustic echo cancellation maxframerate:fixed:1 function is enabled, some features may become malfunction or be forced <product dependent>...
  • Page 286 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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" is "1".
  • Page 287 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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> Indicate whether to support headphone output.
  • Page 288 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) with pixels. "std": A normalized 0~9999 range. "-": Not supported. smartstream_supp <boolean> Indicate whether smart stream is supported. smartstream_versi <integer> Number of smart stream version. * Only available when "capability_smartstream_support"...
  • Page 289 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "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> Maximum number of tracking window dow_hybrid_autotr of autotracking in hybrid mode.
  • Page 290 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) camctrl_ptztunnel <boolean> Indicate whether to support ptztunnel. * We support this parameter when the version number (httpversion) is equal or greater than 0301b. This equals "capability_camctrl_c0_ptztunnel". * This is kept for compatibility.
  • Page 291 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) wireless_s802dot1 <boolean> Indicate whether to support wireless 802.11g. wireless_s802dot1 <boolean> Indicate whether to support wireless 802.11n. wireless_begincha 1 ~ 14 Indicate the begin channel of wireless nnel...
  • Page 292 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) test_ac <boolean> Indicate whether to support test ac key. version_onvifdaem <string> Indicate ONVIF daemon version version_onviftestto <string> Indicate ONVIF test tool version version_genetec <string> Indicate Genetec daemon version...
  • Page 293 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) use this> "-": No Iris control support  * When "capability_iris"=0, this value must be "-". * Note: For some box-type cameras, this value may be varied depending on mounted lens.
  • Page 294 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) recommended to "capability_supportsd" is 1 or use this> "capability_storage_dbenabled" is 1. * We replace this parameter with “capability_storage_management_mo dnum” when the version number (httpversion) is equal or greater than 0312a.
  • Page 295 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) card's remaining lifetime information. 0: Non-support this feature 1: Support this feature * Only Sony, Micron SD card can support this function now. * Only available when "capability_supportsd"...
  • Page 296 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved * We support this group when the version number (httpversion) is equal or greater than 0303b. PARAMETER VALUE SECURITY DESCRIPTION (get/set) ptztunnel <boolean> Indicate whether to support ptztunnel in this video input.
  • Page 297 VIVOTEK © 2020 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 298 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) 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" is "1" maxpan 0, <positive integer> 0/7 The upper limit for pan position.
  • Page 299 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxtiltangle <integer> The upper limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" zoomspeedlv 0, <positive integer> 0/7 The maximum speed level of zoom motion.
  • Page 300 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Group: capability_daynight_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) support <boolean> Indicate whether the camera supports day/night mode switch builtinir <boolean> Indicate whether to support built-in IR led.
  • Page 301 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) blackwhitemode <boolean> Indicate whether to support automatically switch to Black & White display during the night mode. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 302 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) extled_interface The device interface of external IR led: <product "do": digital output dependent> * Only available when "capability_daynight_c<0~(n-1)>_extern alir" is 1 * We replaced this parameter with “capability_daynight_illuminators_exter...
  • Page 303 VIVOTEK © 2020 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 304 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mode auto,daynight,di,di2, Indicate the day / night switch mode. di3,di4,schedule,- "auto": The Camera automatically <product judges the current operation mode by dependent> the level of ambient light detected.
  • Page 305 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 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. builtin_type irled,whiteled,- Indicate whether to support built-in led <product...
  • Page 306 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved spectrum_mode visible,ir,irenhanced, Indicate the spectrum mode. blueenhanced "visible": The ideal default setting for <product visible light. "ir": The ideal default setting for IR light. dependent> "irenhanced": This CCM model increases the brightness effect of IR light.
  • Page 307 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Group: capability_videoin_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) lens_type fisheye, fixed, The lens type of this channel. varifocal, "fisheye": Fisheye lens changeable, "fixed": Build-in fixed-focus lens. "varifocal": Build-in varifocal lens.
  • Page 308 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) rotationaffect When rotation is enabled, some features <product may become malfunction or be forced to a dependent> given value. The affected functions are list here. The format is "Affect API name":"Policy":"Description"...
  • Page 309 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) rotationangle <string> The different angles which camera supports for rotation. * Only avaliable when "capability_videoin_c<0~(n-1)>_rotation" is * We support this parameter when the version number (httpversion) is equal or greater than 0309b.
  • Page 310 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) resolution A list of <WxH> Resolution options in current video mode. <product These options are the possible options for dependent> "videoin_c<n>_s<m>_resolution". The last one is the maximum resolution in current mode.
  • Page 311 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mjpeg_maxframerate A list of <Positive Maximum fps that the device can encoded Integer> and "-" with MJPEG on resolutions in current video mode. "-" means not support.
  • Page 312 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) h264_maxbitrate <positive integer> 0/7 Maximum bitrates of H.264. The unit is bps. * Only available when 'h264' is listed in "capability_videoin_codec". h264_profile baseline,main,hig Indicate H264 profiles * Only available when 'h264' is listed in "capability_videoin_codec".
  • Page 313 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) fisheye_mounttype ceiling, wall, floor Indicate the supported type. <Not recommended <product wall mount: 180° panoramic view to use this> dependent> ceiling mount: 360° surround view without blind spots floor mount: 360°...
  • Page 314 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) cameraunit_name CU8131, A "camera unit" name of a split-type camera CU8171, system, which the camera unit and the CU8161-H, video core are separated. CU8162-H, -: If the camera is not a split-type camera CU8163-H, system, the value of this parameter is "-".
  • Page 315 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) resolutionC1P A list of <WxH> Available resolutions of 1P mode of ceiling and floor mount. resolutionC2P A list of <WxH> Available resolutions of 2P mode of ceiling and floor mount.
  • Page 316 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) eptz 0, <positive integer> 0/7 Indicate this mode whether support eptz. For "nvideoin" = 1, the definition is as following: A 32-bits integer, each bit can be set separately as follows: Bit 0 =>...
  • Page 317 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) outputsize <WxH> The output size of source, equal to the captured size by device, in this video mode. The unit is pixel. This value is used as a basic coordinate system for many features, like ePTZ, privacy mask, motion, etc.
  • Page 318 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) minresolution A list of <Integer> Represent supported minimum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream". * We support this parameter when the version number (httpversion) is equal or greater than 0304b.
  • Page 319 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxfps_h264 A list of <Positive Maximum fps which the device can Integer> and "-" encoded with H.264 on resolutions in this video mode. "-" means not support.
  • Page 320 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Bit 1 => Supports Contrast or not. Bit 2 => Supports Saturation or not. Bit 3 => Supports Sharpness or not. Bit 4 => Supports adjusting the image to proper position horizontally or not.
  • Page 321 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) exposurelevel:hidd affected functions are list here. en:, The format is "Affect API exposurelevel:fixed name":"Policy":"Description" :<x>, "Policy" can be categorized into exposurelevel:fixed following groups: :<x>/<x>, - (disabled) : UI turns grey and users exposuremode:fixe can't select it.
  • Page 322 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) be "-" wdrpro_description <string> Description about WDR Pro mode. * Only available when "capability_image_c<0~(n-1)>_wdrpro _mode" > 0 wdrc_mode 0, 1 0: Non-support WDR Enhanced 1: Support WDR Enhanced wdrc_supportlevel 0, <positive...
  • Page 323 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. For example: "exposurelevel:fixed:6/8/12" which means exposurelevel is fixed to level 6, level 8 and level 12.
  • Page 324 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * We support this parameter when the version number (httpversion) is equal or greater than 0302a. is_strength <boolean> 0: Non-support tuning strength of image stabilizer mode. 1: Support tuning strength of image stabilizer mode.
  • Page 325 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available.
  • Page 326 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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 327 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "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 328 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) exposure_mode" is 1 and "capability_image_c<0~(n-1)>_exposu re_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_automode_ When exposure auto mode is affect exposurewin.mode...
  • Page 329 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when auto is listed in "capability_image_c<0~(n-1)>_ exposure_modetype" and "capability_image_c<0~(n-1)>_...
  • Page 330 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL.
  • Page 331 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled.
  • Page 332 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values.
  • Page 333 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) icrmode.auto:nots "Policy" can be categorized into upport: following groups: or others - (disabled) : UI turns grey and users <x>: nonnegative can't select it. integer - (unchanged) : UI keeps the status as <product...
  • Page 334 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) * When "exposure_mode"=0, this value must be set to "-". * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_winmode auto, Available options for custom, "exposurewin_c<0~(n-1)>_mode" blc, * "-" means group: exposurewin is not hlc, supported.
  • Page 335 VIVOTEK © 2020 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 336 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) control. "-": Not supported. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_windomain qvga, px, std, - The domain to set an exposure window. "qvga": a 320x240 range to represent the whole image.
  • Page 337 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0301a. exposure_maxrange "1,32000", Available range for "1,8000", "videoin_c<n>_maxexposure" "1,32000" => 1s ~ 1/32000s or others "1,8000"...
  • Page 338 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) different exposure values. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0310a.
  • Page 339 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) “0,100” => 0~100 percent "-" means "videoin_c<n>_maxgain" is not available. agc_mingain "0,100", Available range for "-" "videoin_c<n>_mingain" “0,100” => 0~100 percent "-" means "videoin_c<n>_mingain" is not available.
  • Page 340 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected.
  • Page 341 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled.
  • Page 342 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) focusassist 0: Non-support focus assist 1: Support focus assist remotefocus 0,<positive An 4-bit integer, which indicates the integer> supportive application of remotefocus in this channel. If the value of this parameter is larger...
  • Page 343 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0302a. autotrack_support <boolean> 0: Non-support auto tracking feature 1: Support auto tracking feature * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 344 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) ignment" is 1. lens_ldc_support <boolean> Indicate whether to support lens distortion correction function. * We support this parameter when the version number (httpversion) is equal or greater than 0309d.
  • Page 345 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.28 Customized Event Script Group: event_customtaskfile_i<0~2> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Custom script identification of this entry. date string[4~20] Date of custom script. time string[4~20] Time of custom script. 7.29 Event Setting Group: event_i<0~(n-1)>...
  • Page 346 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) trigger boot, Indicate the trigger condition: "boot" = System boot. pir, "di"= Digital input. motion, "pir"= PIR detection. seq, "motion" = Video motion detection. recnotify, "seq" = Periodic condition.
  • Page 347 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) 0,<positive Indicate the source id of vi trigger. integer> This field is required when trigger condition is “vi”. One bit represents one digital input. The LSB indicates VI 0.
  • Page 348 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) endtime hh:mm End time of the weekly schedule. (00:00 ~ 24:00 sets schedule as always lowlightcondition 0, 1 Switch on white light LED in low light <product dependent>...
  • Page 349 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_cf_backup <Boolean> Enable or disable the function that send media to SD card for backup if network is disconnected. * Only available when "capability_supportsd" > 0 action_server_i<0~4>_en <boolean>...
  • Page 350 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_audioclip_media 0,<positive Indicate the source id of audioclip event integer> notification. * Only avaliable when "capability_audio_audioclip" is 1. tampering 0,<positive Indicate the source channel id of integer>...
  • Page 351 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) ftp_username string[64] Username to log in to the server. ftp_passwd string[64] Password of the user. ftp_port 0~65535 Port to connect to the server. ftp_location string[128] Location to upload or store the media.
  • Page 352 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) snapshot_channel 0~"capability_nvideoin"-1 Indicate the source of media channel. 0 means the first channel. 1 means the second channel. 2 means the third channel. 3 means the fourth channel.
  • Page 353 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) videoclip_channel 0~"capability_nvideoin"-1 Indicate the source of media channel. 0 means the first channel. 1 means the second channel. 2 means the third channel. 3 means the fourth channel.
  • Page 354 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.32 Recording Group: recording_i<0~(n-1)> n denotes the value of "capability_nrecording" (capability_nrecording > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. trigger schedule, The event trigger type networkfail schedule: The event is triggered by...
  • Page 355 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxretentiontime <string> To specify the expired time for automatic clean up, and it only takes effect for video clip generated by recording_i <0~1>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss] S’...
  • Page 356 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) weekday 0~127 Indicate which weekday is scheduled. One bit represents one weekday. bit0 (LSB) = Saturday bit1 = Friday bit2 = Thursday bit3 = Wednesday bit4 = Tuesday...
  • Page 357 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) adaptive_enable <boolean> Indicate whether the adaptive recording is enabled adaptive_preevent 0~9 Indicate when is the adaptive recording started before the event trigger point (seconds) adaptive_postevent 0~10 Indicate when is the adaptive recording...
  • Page 358 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) organizationname string[64] Organization name in the certificate VIVOTEK Inc. information. unit string[64] Organizational unit name in VIVOTEK Inc. thecertificate information. commonname string[64] Common name in the certificate www.vivotek.com...
  • Page 359 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) autocleanup_enabled <boolean> Enable automatic clean up method. <Not recommended to Expired and not locked media files will be use this> deleted. * For forward compatibility reservations, but only group disk_i0_autocleanup is effective.
  • Page 360 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.35 Region of Interest Group: roi_c<0~(n-1)> for n channel product and m is the index of video stream which support ePTZ. (capability_eptz > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-1)>_home <W,H> ROI left-top corner coordinate.* If the <product...
  • Page 361 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) tiltspeed -5 ~ 5 Tilt speed * Only available when "capability_fisheye" is 1 Tilt speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.) panspeed -5 ~ 5...
  • Page 362: Technology License Notice

    VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) patrolseq string[120] The patrol sequence of ePTZ. All the patrol position indexes will be separated by "," patroldwelling string[160] The dwelling time (unit: second) of each patrol point, separated by “,”.
  • Page 363: Amr-Nb Standard 362 Electromagnetic Compatibility (Emc)

    VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) win_i0_home <W,H> Left-top corner coordinate of the <product window. dependent> * If the minimal window size is 192x144, then the "win_i0_home"=(0~resolution_W-192, 0~resolution_H-144), resolution_W and resolution_H based on "capability_image_...
  • Page 364 VIVOTEK © 2020 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 365 VIVOTEK © 2020 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.
  • Page 366 VIVOTEK © 2020 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.
  • Page 367 VIVOTEK © 2020 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...
  • Page 368 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Group: vadp_module_i<0~(n-1)> for n VADP package number (capability_vadp_npackage > 0) n denotes the value of "capability_vadp_npackage". NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Indicate if the module is enabled or not. If yes, also add the index of this module to the module_order.
  • Page 369 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the schedule mode to control the execution of the VADP package begintime hh:mm Begin time of the schedule endtime hh:mm End time of the schedule...
  • Page 370 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) The dwelling time of each patrol point, separated by “,” * only available when capability_camctrl_c0_rs485=2 preset_i<0~(k-1)>_nam string[40] Name of the preset location. preset_i<0~(k-1)>_ 0 ~ 999 The dwelling time of each preset...
  • Page 371 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) camera. Note: Please set your speed dome to the appropriate baud rate, and Camera ID, e.g. 2400bps, camera ID 1,2,3,,,,etc. All Camera IDs on the same controlling system (NVR or rs485 keyboard) have to be distinct.
  • Page 372 VIVOTEK © 2020 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)>_zoom capability_ptz_ Zoom position at each preset location. c<0~(n-1)>_min zoom ~ capability_ptz_ c<0~(n-1)>_ma xzoom preset_i<0~(k-1)>_focus capability_ptz_ Focus position at each preset location.
  • Page 373 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) c<0~(n-1)>_min zoom ~ capability_ptz_ c<0~(n-1)>_ma xzoom axisf capability_ptz_ Custom home focus position. c<0~(n-1)>_min focus ~ capability_ptz_ c<0~(n-1)>_ma xfocus digitalzoom <boolean> Enable/disable digital zoom zoomenhance <boolean> Enable /disable zoom enhancement returnhome <boolean>...
  • Page 374 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) Please set your speed dome to the appropriate baud rate, and Camera ID, e.g. 2400bps, camera ID 1,2,3,,,,etc. All Camera IDs on the same controlling system (NVR or rs485 keyboard) have to be distinct.
  • Page 375 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) preset_i<0~(k-1)>_focus capability_ptz_c<0~( Focus position at each preset n-1)>_minfocus ~ location. capability_ptz_c<0~( n-1)>_maxfocus preset_i<0~(k-1)>_focus sync, The focus mode of each preset, setting fixcurrent which is essential and should be grouped with “preset_i<0~(k-1)>_name.”...
  • Page 376 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) capability_ptz_c<0~( n-1)>_maxfocus axisflip <boolean> Custom home flip side. returnhome <boolean> Enable/disable return home while idle. returnhomeinterval 1~999 While idle over this time interval, idle action will be taken.
  • Page 377 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0307a. tour_i<0~19>_checklist string[512] The indexes of preset positions, separated by “,”...
  • Page 378 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) paritybit none, For error checking. odd, even stopbit "1": One stop bit is transmitted to indicate the end of a byte. "2": Two stop bits are transmitted to indicate the end of a byte.
  • Page 379 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) camera. Note: Please set your speed dome to the appropriate baud rate, and Camera ID, e.g. 2400bps, camera ID 1,2,3,,,,etc. All Camera IDs on the same controlling system (NVR or rs485 keyboard) have to be distinct.
  • Page 380 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 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. Group: lens_default NAME VALUE SECURITY DESCRIPTION (get/set) totalnumbers 0,<positive...
  • Page 381 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) 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 DESCRIPTION...
  • Page 382 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) [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...
  • Page 383 VIVOTEK © 2020 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.
  • Page 384 VIVOTEK © 2020 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 385 VIVOTEK © 2020 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.
  • Page 386 VIVOTEK © 2020 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 387 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8. Useful Functions 8.1 Drive the Digital Output (capability_ndo > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/setdo.cgi?do1=<value> [&do2=<value>] [&do3=<value>][&do4=<value>] Where state is 0 or 1; “0” means inactive or normal state, while “1” means active or triggered state, and trigger time is indicated in seconds.
  • Page 388 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <length>\r\n \r\n [di0=<state>]\r\n [di1=<state>]\r\n [di2=<state>]\r\n [di3=<state>]\r\n where <state> can be 0 or 1. Example: Query the status of digital input 1 . Request: http://myserver/cgi-bin/dido/getdi.cgi?di1 Response: HTTP/1.0 200 OK\r\n...
  • Page 389 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved [do1=<state>]\r\n [do2=<state>]\r\n [do3=<state>]\r\n where <state> can be 0 or 1. Example: Query the status of digital output 1. Request: http://myserver/cgi-bin/dido/getdo.cgi?do1 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n do1=1\r\n 8.4 Capture Single Snapshot Note: This request requires Normal User privileges.
  • Page 390 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION quality The quality of the image. streamid 0~( capability_nmediastream -1) The stream number. Default: Returns snapshot of maxmum resolution for current channel. The server will return the most up-to-date snapshot of the selected channel and stream in JPEG format.
  • Page 391 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION username <name> The name of the user to add, delete, or edit. userpass <value> The password of the new user to add or that of the old user to modify. The default value is an empty string.
  • Page 392 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.7 ePTZ Camera Control (capability_eptz > 0 and Capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eCamCtrl.cgi?channel=<value>&stream=<value> [&move=<value>] – Move home, up, down, left, right [&auto=<value>] – Auto pan, patrol [&zoom=<value>] –Zoom in, out...
  • Page 393 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved b. continuous movement - If you trigger a continuous movement, you have to handle the stop time by yourself. A continuous movement is convenient to integrate a joystick control. http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=tele&zs=1 http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed.
  • Page 394 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION <integer> movement <integer> The scaled area size <integer> resolution <window size> The resolution of streaming. <integer> The direction of movement, used for joystick control. <integer> 0 ~ 7 Set the speed of movement, “0” means stop.
  • Page 395 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.8 ePTZ Recall (capability_eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eRecall.cgi?channel=<value>&stream=<value>& recall=<value>[&return=<return page>] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source.
  • Page 396 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION addpos <Text string less than Add one preset location to the preset list. 40 characters> delpos <Text string less than Delete preset location from the preset list. 40 characters>...
  • Page 397 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Syntax: http://<servername>/cgi-bin/operator/uartchannel.cgi?[channel=<value>] ------------------------------------------------------------------------- GET /cgi-bin/operator/uartchannel.cgi?[channel=<value>] x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------- POST /cgi-bin/operator/uartchannel.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache cache-control : no-cache content-length: 32767 expires: Sun, 9 Jam 1972 00:00:00 GMT User must use GET and POST to establish two channels for downstream and upstream.
  • Page 398 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved ------------------------------------------------------------------------- GET /cgi-bin/admin/ctrlevent.cgi x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------- POST /cgi-bin/admin/ ctrlevent.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache cache-control : no-cache content-length: 32767 expires: Sun, 9 Jam 1972 00:00:00 GMT User must use GET and POST to establish two channels for downstream and upstream.
  • Page 399 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.14 Open the Network Stream Note: This request requires Viewer access privileges. Syntax: For HTTP push server (MJPEG): http://<servername>/<network_http_s<0~m-1>_accessname> For RTSP (MP4), the user needs to input theURL below into an RTSP compatible player.
  • Page 400 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <system information length>\r\n \r\n <hex decimal data>\r\n Where hexadecimal data is digits from 0 ~ 9, A ~ F. 8.16 Storage Managements (capability_stroage.dbenabled > 0)
  • Page 401 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION destPath <text> Optional. Indicate the file location in camera. Please embrace your input value with single quotes. Ex. destPath =’/mnt/auto/CF/NCMF/abc.mp4’ resolution <text> Optional. Indicate the media file resolution. Please embrace your input value with single quotes.
  • Page 402 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=search&triggerType=’motion’+OR+’di’+OR+’seq’ &triggerTime=’2008-01-01 00:00:00’+TO+’2008-01-01 23:59:59’ Command: delete PARAMETER VALUE DESCRIPTION label <integer primary key> Required. Identify the designated record. Ex. label=1 Ex. Delete records whose key numbers are 1, 4, and 8. http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=delete&label=1&label=4&label=8...
  • Page 403 VIVOTEK © 2020 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”...
  • Page 404 VIVOTEK © 2020 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...
  • Page 405 VIVOTEK © 2020 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.
  • Page 406 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function zoom, Function type zoom - Move focus motor focus, auto, focus – Move focus motor scan, auto – Perform auto focus stop, scan – Perform focus scan stop – Stop current operation...
  • Page 407 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION direction direct, Motor’s moving direction. forward, It works only if function=zoom or function=focus. backward position 0~<motor_max> Motor’s position. It works only if function=zoom or function= focus and direction=direct. <motor_max> is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from "function=getstatus"...
  • Page 408 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function focus, Function type focus – Move focus motor auto, scan, auto – Perform auto focus stop, scan – Perform focus scan positioning, stop – Stop current operation positioning – Position the motors...
  • Page 409 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION position 0~<motor_max> Motor’s position. It works only if function=focus and direction=direct. <motor_max> is refer to remote_focus_focus_motor_max which replied from "function=getstatus" steps 1 ~ <motor_max> Motor’s moving steps. It works only if function=focus and direction=forward or direction=backward.
  • Page 410 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.22 Upload Files Note: This request requires Administrator privileges. Method: POST Syntax: For daylight saving time configuration file: http://<servername>/cgi-bin/admin/upload_dst.cgi Post data: filename =<file name>\r\n \r\n <multipart encoded form data> For language file: http://<servername>/cgi-bin/admin/upload_lan.cgi...
  • Page 411 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Syntax: For list a name of lens currently used: http://<servername>/cgi-bin/admin/update_lens.cgi?get_currentlens For list all names of lens installed in camera: http://<servername>/cgi-bin/admin/update_lens.cgi?list_lens For choose selected lens configuration: http://<servername>/cgi-bin/admin/update_lens.cgi?choose_lens=<value> You need to reboot manually after you choose another lens configuration.
  • Page 412 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.24 Media on Demand (capability_localstorage.modnum > 0) Media on demand allows users to select and receive/watch/listen to metadata/video/audio contents on demand. Note: This request requires Viewer access privileges. Syntax: rtsp://<servername>/mod.sdp?[&stime=<value>][&etime=<value>][&length =<value>][&loctime =<value>][&file=<value>][&tsmode=<value>]...
  • Page 413 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.25 3D Privacy Mask (Capability_image_c<0~(n-1)>_privacymask_wintype = 3Drectangle) n denotes the value of "capability_nvideoin" Note: This request requires admin user privilege Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/setpm3d.cgi?method=<value>&maskname=<value>&[maskhei ght=<value>&maskwidth=<value>&videosize=<value>&return=<return page>] PARAMETER VALUE DESCRIPTION method Add a 3D privacy mask at current location...
  • Page 414 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.26 Camera Control (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/camctrl/camctrl.cgi?[channel=<value>][&camid=<value>] [&move=<value>] – Move home, up, down, left, right [&focus=<value>] – Focus operation [&zoom=<value>] – Zoom in, out [&zooming=<value>&zs=<value>] –...
  • Page 415 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION down Move camera down. left Move camera left. right Move camera right. speedpan -5 ~ 5 Set the pan speed. speedtilt -5 ~ 5 Set the tilt speed. speedzoom -5 ~ 5 Set the zoom speed.
  • Page 416 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION focus auto Auto focus. Focus on further distance. near Focus on closer distance. focusseting sync Applies the selected focus mode in camctrl_c<0~(n-1)>_focusmode to this preset. fixcurrent Applies the current focus position to this preset.
  • Page 417 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION getpanangle <integer> Get the current pan angle. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" gettilt 0, <positive integer> Get the current tilt position. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt"...
  • Page 418 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmintiltangle <integer> Get the lower limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmaxtiltangle <integer> Get the upper limit for tilt angle.
  • Page 419 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.28 Preset Locations (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/preset.cgi?[channel=<value>] [&addpos=<value>][&delpos=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION addpos string[30] Add one preset location to the preset list. channel 0~"capability_nvideoin"-1 Channel of the video source.
  • Page 420 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function getstatus Function type getstauts : Information of smartSD internal status return value as below: smartsd_lifetime_num: Accumulated amount of data that has been written smartsd_lifetime_den: Card-guaranteed amount of data that can be written...
  • Page 421 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Syntax: http://<servername>/cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION Apply the wireless settings and connect to AP. 8.31 Get Wireless Information (capability_network_wireless > Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/getwirelessinfo.cgi PARAMETER VALUE DESCRIPTION Get wireless information.
  • Page 422 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION Get wireless signal strength. 8.33 WPS Transaction (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/start_wps.cgi PARAMETER VALUE DESCRIPTION Start WPS transaction. 8.34 Peripheral Control (capability_peripheral_c<0~(n-1)>_...
  • Page 423 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved "washer_mode : OK\r\n" "washer_status : FAIL\r\n" PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. washer_mode wiper Apply the wiper to the mode of washer control system. washer Apply the washer to the mode of washer control system.
  • Page 424 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Pragma: no-cache\r\n \r\n supportdevice=washer,heater\r\n washer_status=off\r\n PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. supportdevice Get support peripheral device. washer_supportmode N/A Get the support mode of washer control system. washer_mode Get the current mode of washer control system.
  • Page 425 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.35 Optimized IR control (capability_daynight_c<0~(n-1)>_optimizedir > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/optimizedir.cgi?function=<value>[&channel=<value>] PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. function getstatus, "onetimeauto": Camera will automatically adjust the IR onetimeauto zone one time only.
  • Page 426 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http://myserver/cgi-bin/admin/optimizedir.cgi?function=getstatus Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irmode='auto'" "optimizedir_c0_irnum='5'" "optimizedir_c0_irstrength='1,97,100,100,100'" "optimizedir_c0_irstatus='normal'" Syntax: (for control API) http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=<value>&irmode= manual[&strength=<value>] – Set IR strength PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source.
  • Page 427 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=settoall&irmode=manual&str ength=100 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irstrength='100,100,100,100,100'" "optimizedir_c0_irmode='manual'" Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&irmode=auto&strength= 50,70,50,50,50 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: Parameter "irmode" must be set as "manual"! Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&strength=50,70,50,50,50...
  • Page 428 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=get [&support_irmode] – list all adjustment mode that IR supports [&irmode] – Get current IR mode [&irnum] – Get the number of IR zone PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source.
  • Page 429 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved \r\n Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: time out Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: fail PARAMETER VALUE DESCRIPTION action shuttercompensate Camera will do shutter compensate.
  • Page 430 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n version=1120B15 8.37 Audio Clip Control (capability_audio_audioclip=1) Note: This request requires Administrator privileges. Method: GET/POST (for control API) Syntax: http://<servername>/cgi-bin/admin/audioclip.cgi?operation=<value>[&name=<value>][&index=<value>] PARAMETER VALUE DESCRIPTION operation startrecording, "startrecording"...
  • Page 431 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved clipname <string> Name of the audio clip. clipindex 0, 1 Number of the audio clip. 8.38 Format SD card Note: This request requires Administrator privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/admin/format_sdcard.cgi?operation=set[&<parameter>=<value>] If the user requests a size larger than all stream settings on the server, this request will fail.
  • Page 432 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Response of formatting fail: HTTP/1.1 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <Error Message Length>\r\n \r\n <Error Message> Syntax: (for query API) http://<servername>/cgi-bin/admin/ format_sdcard.cgi?operation=get PARAMETER VALUE DESCRIPTION Get formatting progress(0~100) or result(error message) *It is unnecessary when using the blocking mode.
  • Page 433 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved ERROR: The device does not exist or is busy ERROR: Formatted successfully, but cannot create database 8.39 for Accessing Streaming Methods 8.39.1 Get Stream URI (capability_media_streamprofiles_support = 1) Note: This request requires Viewer access privileges.
  • Page 434 VIVOTEK © 2020 VIVOTEK INC. All Right Reserved port is the http port.  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.
  • Page 435 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 436 VCCI Warning Liability VIVOTEK Inc. cannot be held responsible for any technical or typographical errors and reserves the right to make changes to the product and manuals without prior notice. VIVOTEK Inc. makes no warranty of any kind with regard to the material contained within this document, including, but not limited to, the implied warranties of merchantability and fitness for any particular purpose.

This manual is also suitable for:

Supreme fe93804710469351747

Table of Contents