User's Manual

ManualsBrandsVivotek ManualsSecurity CamerasS Series 6MP Outdoor Network Fisheye Dome Camera

Table Of Contents

User’s Manual

FE9382-EHV-v2

Fisheye

Network Camera

6MP • Vandal-proof • 360º Surround View • Smart IR 20m

Smart Stream III • Pixel Calculator • PoE • IP66 • IK10 • WDR Pro

Rev. 1.0

Summary of content (436 pages)

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.
PAGE 2
VIVOTEK 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.
PAGE 3
VIVOTEK Privacy mask Pixel Calculator �� 78 �� 79 Media > Video �� 81 S
PAGE 4
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 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 5
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. It is important to first verify that all contents received are complete according to the Package Contents listed below.
PAGE 6
VIVOTEK NOTE: Camera Hardware Preventative Maintenance: 1. Visual inspection of all major components including accessories, cabling and connections where accessible for signs of deterioration or damage. 2. Check and clean cameras, lenses and housings inside and out as needed. • Please do not scratch, damage, or leave fingerprints on the dome/front cover and/or lens because this may decrease image quality.
PAGE 7
VIVOTEK IMPORTANT: 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. The HTTP-based camera interface provides the functionality to request a single image, control camera functions (PTZ, output relay etc.), and get and set internal parameter values. The image and CGI-requests are handled by the built-in Web server.
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. 2. Pour les raccordements PoE, utilisez uniquement un équipement de TI homologué UL, avec une sortie PoE. Use the camera only with a DC power supply that is UL listed, and limited power source (LPS) certified.
PAGE 9
VIVOTEK Physical Description Inner View Lens Connector for DI/DO combo Connector for DI/DO combo LEDs Contact pins for IR & Ethernet RJ45 microphone socket Cabling hole Cabling hole for DI/DO/audio for Ethernet SD card slot Reset button combo cable Outer View Lens Built-in Microphone Embedded IR LEDs User's Manual - 9
PAGE 10
VIVOTEK LED Definition Item 1 2 3 4 LED Status Description Steady Red Power on and system booting Red LED off Powered off Steady Red + blinking Green every 1 sec. (Green Network heartbeat LED on for 1 sec and off for another) Steady Red + Green LED off Network disconnected Blinking Red every 0.15 sec. + Blinking Green Upgrading firmware every 1 sec. (Red LED on for 0.15 sec. and Green LED on for 1 sec. and off for another) Blinking Red every 0.15 sec. + blinking Green Restoring defaults every 0.
PAGE 11
VIVOTEK The base plate provides mounting holes for a variety of electrical boxes.
PAGE 12
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 the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. Pat.
PAGE 13
VIVOTEK 3. Install an SD card if onboard storage is preferred. 64GB 10 1 I 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.
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.
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.
PAGE 17
VIVOTEK 11. Connect the Ethernet connector and secure the top of the silicone seal to the routing hole. You may need to adjust its position. 12. Pull the cable slightly backward. Please do not leave the edge of center hole folded toward the inside of the camera. Doing so will compromise its waterproof feature.
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. 14. Replace the desiccant bag on the 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.
PAGE 21
VIVOTEK 19. Please visit VIVOTEK’s website to Install the "Shepherd” software utility. The program will search for VIVOTEK Video Receivers, Video Servers or Network Cameras on the same LAN. Double-click on the camera’s MAC address to open a web console with the camera. Shepherd LAN IEEE 802.3af Browser Software Installation 20. Install the Shepherd utility, which helps you locate and configure your Network Camera in the local network.
PAGE 22
VIVOTEK 20-1. Run the Shepherd utility. 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. You can then double-click on the address to open a management session to the Network Camera.
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. 21-2. Enter the combination of alphabetic and numeric characters to fulfill the password strength requirement. The default name for the camera administrator is “root”, and can not be changed.
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. DIDO+ DI+ Switch DOPhoto Coupler DC External DC power DC 0V DC 0V NO AC External AC power with Protected Earth NC PE Relay External Device PE Wet contact with external DC power source to supply a relay. DIDO+ DI+ Switch DODC 0V DC External DC power AC NO NC PE Relay PE External AC power with Protected Earth External Device 1. The DO+ pin (3.
PAGE 27
VIVOTEK Dry contact and using camera’s DO+ to supply a relay.
PAGE 28
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 IP. The third way is to use PPPoE. Internet connection via a router Before enabling the access to the Network Camera over the Internet, make sure you have a router and follow the steps below. 1.
PAGE 29
VIVOTEK For example, your router and IP settings may look like this: Device IP Address: internal IP Address: External Port (Mapped port on the port router) Public IP of router 122.146.57.120 LAN IP of router 192.168.2.1 Camera 1 192.168.2.10:80 122.146.57.120:8000 Camera 2 192.168.2.11:80 122.146.57.120:8001 ... ... ...
PAGE 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. Please refer to PPPoE on page 117 for details.
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\. 2.
PAGE 32
VIVOTEK Accessing the Network Camera This chapter explains how to access the Network Camera through web browsers, RTSP players, 3GPP-compatible mobile devices, and VIVOTEK recording software. Using Web Browsers IMPORTANT: • Currently the Network Camera utilizes 32-bit ActiveX plugin. You CAN NOT open a management/view session to the camera using a 64-bit IE browser. • If you encounter this problem, try execute the Iexplore.exe program from C:\Windows\ SysWOW64.
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). Removing your browser cookies will solve this problem.
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. 2. If you see a dialogue box indicating that your security settings prohibit running ActiveX Controls®, please enable ActiveX Controls for your browser. To enable the ActiveX® Controls for your browser: 2-1.
PAGE 35
VIVOTEK Using RTSP Players To view the H.265 or H.264 streaming media using RTSP players, you can use one of the following players that support RTSP streaming. Quick Time Player VLC Player 1. Launch the RTSP player. 2. Choose File > Open URL. A URL dialog box will prompt. 3. The address format is rtsp://:/ As most ISPs and players only allow RTSP streaming through port number 554, please set the RTSP port to 554.
PAGE 36
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 28. 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. 2. If you encounter problems with displaying the configuration menus or UI items, try disable the Compatibility View on IE8 or IE9.
PAGE 38
VIVOTEK Using VIVOTEK Recording Software The product software CD also contains a VAST recording software, allowing simultaneous monitoring and video recording for multiple Network Cameras. Please install the recording software; then launch the program to add the Network Camera to the Channel list. For detailed information about how to use the recording software, please refer to the user’s manual of the software or download it from https://www.vivotek.com. Tips: 1.
PAGE 39
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 Area Resize Buttons Host name Camera Control Panel Live View window VIVOTEK INC. Logo Click this logo to visit the VIVOTEK website. Host Name The host name can be customized to fit your needs.
PAGE 40
VIVOTEK 1O (Original) Display mode: 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. 1O View (Original View) 180° Hemispheric The 1O view is especially adequate for taking an overview glimpse of the surveillance area when mounted on the ceiling.
PAGE 41
VIVOTEK 1R (Single Regional) Display mode: The 1R mode provides access to one image section within the hemisphere. You can zoom in or out (using the mouse wheel or PTZ panel) or travel to other areas in the hemisphere using mouse clicks and swipes. A single click on a particular object can bring the object to the center of your view window. Click and hold down the left mouse button, and you can swipe the view in all directions.
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. You can zoom in or out or travel to other areas within the hemisphere using identical methods as previously described in the 1R mode.
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. O 2 2 x1.
PAGE 44
VIVOTEK 4R (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. Note that zoom in/out and tilt control is not available in this mode.
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. Manual Trigger: Click to manually enable or disable an event trigger. Please configure an event setting before enabling this function. A total of 3 or 4 event settings can be configured.
PAGE 46
VIVOTEK Pan /Tilt /Zoom speed: Adjust the speed of these controls when exerted: Pan speed Tilt speed Zoom speed -5 -4 -3 -2 -1 -5 -4 -3 -2 -1 -5 -4 -3 -2 -1 Panoramic speed - 0 1 2 3 4 5 0 1 2 3 4 5 0 1 2 3 4 5 0 1 2 3 4 5 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 Title and Time Video (HTTP-V) 2015/03/10 17:08:56 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. Time: Display the current time. For more information, please refer to Media > Image on page 66. Title and Time: Video title and time can be stamped on the streaming video.
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 Video Title Title and Time Time Video (TPC-AV) Video 13:59:05 2012/07/04 Video 13:59:05 2012/07/04 Video and Audio Control Buttons Video Title: The video title can be configured. For more information, please refer to Video settings on page 81. H.264 Protocol and Media Options: The transmission protocol (TCP or UDP, etc.)and media options for H.265 or H.
PAGE 49
VIVOTEK Start MP4 Recording: Click this button to record video clips in MP4 file format to your computer. Stop MP4 Recording button to end recording. When you exit the web browser, video Press the recording stops accordingly. To specify the storage destination and file name, please refer to MP4 Saving Options on page 52 for details. Volume: When the local computer. Mute function is not activated, move the slider bar to adjust the volume on the Mute: Turn off the volume on the local computer.
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. 2. If you encounter problems with displaying the configuration menus or UI items, try disable the Compatibility View on IE8 or IE9.
PAGE 51
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. H.265 / H.264 Protocol Options Depending on your network environment, there are four options with the transmission protocols with the H.265 or H.
PAGE 52
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” button on the main page. Here, you can specify the storage destination and file name. Folder: Specify a storage destination for the recorded video files.
PAGE 53
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. The Navigation Area provides access to all different views from the Home page (for live viewing), Configuration page, and multi-language selection.
PAGE 54
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. Turn off the LED indicator: Click to disable the onboard LEDs. System time Time zone : Select the appropriate time zone from the list.
PAGE 55
VIVOTEK System > Homepage layout This section explains how to set up your own customized homepage layout. General settings This column shows the settings of your hompage layout. You can manually select the background and font colors in Theme Options (the second tab on this page). The settings will be displayed automatically in this Preview field. 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.
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. 2 3 1 4 4. Drag the slider bar and click on the left square to select a desired color. 5. The selected color will be displayed in the corresponding fields and in the Preview column. 6. Click Save to enable the settings.
PAGE 58
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. 2. In the port text box, enter the port number of the remote server. 3. When completed, click Save to enable the setting.
PAGE 59
VIVOTEK You can install the included VAST recording software, which provides an Event Management function group for delivering event messages via emails, GSM short messages, onscreen event panel, or to trigger an alarm, etc. For more information, refer to the VAST User Manual.
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. VADP log VADP log contains the information for the onboard VADP packages, including memory usage, module load and unload information.
PAGE 61
VIVOTEK 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.
PAGE 62
VIVOTEK System > Maintenance This chapter explains how to restore the Network Camera to factory default, upgrade firmware version, etc. General settings > Upgrade firmware This feature allows you to upgrade the firmware of your Network Camera. It takes a few minutes to complete the process. 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.
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). Custom Language: Select this option to retain the Custom Language settings.
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. on the first Sunday in November. Update daylight saving time rules: Click Browse… and specify the XML file to update. If incorrect date and time are assigned, you will see the following warning message when uploading the file to the Network Camera.
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. Export configuration file: Click to export all parameters for the device and user-defined scripts.
PAGE 66
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. Select both options if the Network Camera is installed upside-down (e.g., on the ceiling) to correct the image orientation.
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. Some camera housings come with such mechanism. ■ Schedule mode The Network Camera switches between day mode and night mode based on a specified schedule. Enter the start and end time for day mode.
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. Anti-overexposure When enabled, the camera automatically adjusts the IR projection to adjacent objects in order to avoid over-exposure in the night mode.
PAGE 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. For a surveillance area at a greater distance, e.g., 5 meters or farther away, the Smart IR function may not bring as significant benefits as in close range.
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. See page 75 for how to do it. You can also configure the “Exposure Exclude” window in a night mode “Profile” setting so that your day time setting is not affected.
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. Use the “One time adjust” button to come up with a recommended coverage. Camera firmware will automatically increase or decrease the lighting intensity of individual zones.
PAGE 73
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. White balance: Adjust the value for the best color temperature. ■ Auto: This will automatically adjust the color temperature of the light in response to different light sources.
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
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. For example, where low-light objects are posed against an extremely bright background.
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. An exposure value will then be calculated out of the remaining of 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. Click the Save button to preserve your configuration. Note that when WDR is enabled, the exposure time and gain control are not available. ■ AE Speed Adjustment: This function applies when you need to monitor fast changing lighting conditions.
PAGE 78
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. 4x ■ 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. 2. Use four mouse clicks to mark a square area, which is recommended to be at least twice the size of the object (height and width) you want to cover. 3.
PAGE 79
VIVOTEK Pixel Calculator Click the Add button at the lower screen to create a pixel calculator window. Place your cursor on the window to move it to an area of your interest, and change the size of window to fit the area of interest. Once they are drawn, the numbers of pixels on the sides of windows will appear. This allows you to calculate if your current configuration fulfills a requirement, for instance, for recognizing the faces of persons passing through a location.
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. 3. The recommended pixel number is, 40 to 80 for facial identification; or 100 pixels per foot (30.48cm) 3-1. One example is a human face in retail. 3-2.
PAGE 81
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. 3. Select the Maximum frame rate.
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 or H.264 mode is selected, the video is streamed via RTSP protocol. There are several parameters for you to adjust the video performance: ■ Local dewarp mode This applies when the computing efforts for dewarping the original round-shape image need to occur on the camera itself.
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. If the power line frequency is set to 60Hz, the frame rates are selectable at 1fps, 2fps, 3fps, 5fps, 8fps, 10fps, 15fps, 20fps, 25fps, and 30fps.
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 selfreferential and they are largest in size. The P-frames are predicted frames. The encoder refers to the previous I- or P-frames for redundant image information. H.
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. When motions occur, the encoding returns to normal to deliver real-time streaming. f1 f1 f1 f1 f5 f5 f5 f5 f9 f5 f6 f7 f8 f9 Motions Occur.
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 areas Slide bar to the left - higher quality in the non-ROI areas. Select an operation mode if Smart codec is preferred. - Auto tracking: The Auto mode configures the whole screen into the non-interested area.
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 at the following rates: 20Kbps, 30Kbps, 40Kbps, 50Kbps, 64Kbps, 128Kbps, 256Kbps, 512Kbps, 768Kbps, 1Mbps, 2Mbps, 3Mbps, 4Mbps, 6Mbps, 8Mbps, 10Mbps, 12Mbps, 14Mbps, ~ to 40Mbps.
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
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. In that case, the following message is displayed: Internal microphone input gain: Select the gain of the internal audio input according to ambient conditions. Adjust the gain from 0% (least) to 100% (most).
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. Because the memory space is limited, a recording count down will be available on screen. You can also upload an audio file to the camera's flash memory.
PAGE 93
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
VIVOTEK Network > General settings This section explains how to configure a wired network connection for the Network Camera. Network Type LAN Select this option when the Network Camera is deployed on a local area network (LAN) and is intended to be accessed by local computers. The default setting for the Network Type is LAN. Rememer to click Save when you complete the Network setting.
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. Secondary WINS server: The secondary 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 TM is not supported by your router, you will see the following message: Error: Router does not support UPnP port forwarding. ► Below are steps to enable the UPnP TM user interface on your computer: Note that you must log on to the computer as a system administrator to install the UPnP TM components. 1.
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 TM is enabled. ► How does UPnP TM work? UPnP TM networking technology provides automatic IP configuration and dynamic discovery of devices added to a network. Services and capabilities offered by networked devices, such as printing and file sharing, are available among each other without the need for cumbersome network configuration.
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. When IPv6 is enabled, by default, the network camera will listen to router advertisements and be assigned with a link-local IPv6 address accordingly. IPv6 Information: Click this button to obtain the IPv6 information as shown below.
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. Press Enter on the keyboard or click Refresh button to refresh the webpage.
PAGE 100
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://:/ For example, when the Access name for stream 2 is set to video1s2.mjpg: 1. Launch Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter. 3. The JPEG images will be displayed in your web browser. http://192.168.5.151/video1s2.
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. If basic authentication is selected, the password is sent in plain text format, but there can be potential risks of it being intercepted. If digest authentication is selected, user credentials are encrypted using MD5 algorithm, thus providing better protection against unauthorized access.
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
VIVOTEK Unicast video transmission delivers a stream through point-to-point transmission; multicast, on the other hand, sends a stream to the multicast group address and allows multiple clients to acquire the stream at the same time by requesting a copy from the multicast group address. Therefore, enabling multicast can effectively save Internet bandwith. The ports can be changed to values between 1025 and 65535.
PAGE 105
VIVOTEK SIP 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. The Network Camera supports two way audio communication so that operators can transmit and receive audio simultaneously.
PAGE 106
VIVOTEK Network > DDNS This section explains how to configure the dynamic domain name service for the Network Camera. DDNS is a service that allows your Network Camera, especially when assigned with a dynamic IP address, to have a fixed host and domain name. Manual setup DDNS: Dynamic domain name service Enable DDNS: Select this option to enable the DDNS setting. Provider: Select a DDNS provider from the provider drop-down list. VIVOTEK offers Safe100.
PAGE 107
VIVOTEK 3. Click Copy and all the registered information will automatically be uploaded to the corresponding fields in the DDNS column at the top of the page as seen in the picture. [Register] Successfully Your account information has been mailed to registered e-mail address 4. 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.
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. Express Link is more convenient and easier to set up. Please follow the steps below to enable Express Link: 1.
PAGE 109
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. It gives an indication of how a given packet is to be forwarded, known as the Per Hop Behavior (PHB).
PAGE 111
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. ■ The SNMP consists of the following three key components: 1.
PAGE 112
VIVOTEK Network > FTP The newer firmware disabled the FTP port for security concerns. You can manually enable the FTP server service to enable the FTP function. You can disable the FTP server function when it is not in use. FTP port: The FTP server allows the user to save recorded video clips. 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
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. The camera main page will open in your browser. Some later iOSes may come without the Bonjour option. Install the Discovery utility instead. Find the Discovery (formerly Bonjour Browser) from the Mac App Store.
PAGE 114
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. The administrator can create up to 20 user accounts. To create a new user, 1. Click to unfold the pull-down menu. Select New user. 2.
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. Allow anonymous viewing: If you select this item, any client can access the live stream without entering a User ID and Password.
PAGE 116
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. There are three ways to create and install a certificate: Create self-signed certificate 1.
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 return to the main page. Change the URL address from “http://” to “https://“ in the address bar and press Enter on your keyboard. Some Security Alert dialogs will pop up. Click OK or Yes to enable HTTPS.
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. 4. The Certificate request window will prompt. If you see the following Information bar, click OK and click on the Information bar at the top of the page to allow pop-ups.
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. 6. Once completed, your SSL certificate should be delivered to you via an email or other means.
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.
PAGE 122
VIVOTEK 11. When the certifice file is successfully loaded, its status will be stated as Active. Note that a certificate must have been created and installed before you can click on the “Save" button for the configuration to take effect. 12.To begin an encrypted HTTPS session, click Home to return to the main page. Change the URL address from “http://” to “https://“ in the address bar and press Enter on your keyboard. Some Security Alert dialogs will pop up. Click OK or Yes to enable HTTPS.
PAGE 123
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). Enable access list filtering: Check this item and click Save if you want to enable the access list filtering function. Filter Filter type: Select Allow or Deny as the filter type.
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. For example: • 192.168.100.14/24 represents the IPv4 address 192.168.100.14 and its associated routing prefix 192.168.100.0, or equivalently, its subnet mask 255.255.255.0 has 24 leading 1-bits. • The IPv4 block 192.168.100.
PAGE 126
VIVOTEK Security > IEEE 802.1x Enable this function if your network environment uses IEEE 802.1x, which is a port-based network access control. The network devices, intermediary switch/access point/hub, and RADIUS server must support and enable 802.1x settings. The 802.1x standard is designed to enhance the security of local area networks, which provides authentication to network devices (clients) attached to a network port (wired or wireless).
PAGE 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). 2. A Network Camera requests access to the protected LAN using 802.
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. Unauthorized commands are transmitted from a user that the web application trusts, using the mechanism of forging a trusted user's own request with a request containing his own cookies, etc.
PAGE 129
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. Users can then move the view in different directions or zoom in or zoom out on the screen.
PAGE 130
VIVOTEK PTZ Settings 1 Zoom In Zoom Out 2 3 5 11 11 4 6 7 8 9 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. 1. First select a video stream on which the PTZ settings will take place.
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. 3. After you selected an area of interest, enter a name for the new position, which can contain up to forty alphabetic and numeric characters. 4. Click Add to enable the settings.
PAGE 132
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. seconds: Enter the duration in seconds to pause ■ Detect next motion detection or digital input after motion detection after a motion is detected. This prevents too many events to be triggered within a short time.
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. ■ Camera tampering detection This option allows the Network Camera to trigger when the camera detects that is is being tampered with.
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. Use the arrow buttons to select these triggers. Users may implant these modules for different purposes such as triggering motion detection, or applications related to video analysis, etc.
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. Specify the length of the trigger interval in the text box.
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
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. You can configure either one or all of them. Server type - Email Select to send the media files via email when a trigger is activated.
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. After you set up the first event server, a new item for event server will automatically appear on the Server list. If you wish to add more server options, click Add server.
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. If successful, you will also receive a test.txt file on the FTP server.
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. If the folder name does not exist, the Network Camera will create one on the SFTP server. Use backslash “\” when you need to specify a path.
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. The supported formats are: ED25519 (default.
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. ■ Password: Enter the password if necessary. To verify if the HTTP settings are correctly configured, click Test. The result will be shown in a pop-up window as below. If successful, you will receive a test.txt file on the HTTP server.
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. ■ SD Test: Click to test your SD card. The system will display a message indicating success or failure. If you want to use your SD card for local storage, please format it before use. Please refer to page 167 for detailed information.
PAGE 145
VIVOTEK Add media Click Add media 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. Select the item to display the detailed configuration options. You can configure either one or all of them. Media type - Snapshot Select to send snapshots when a trigger is activated.
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 preﬁx Date and time sufﬁx The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings, then click Close to exit the Add media page. After you set up the first media server, a new column for media server will automatically display on the Media list. If you wish to add more media options, click Add media.
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. 1 sec. 2 sec. 3 sec. 4 sec. 5 sec. 6 sec. 7 sec. 8 sec. 9 sec. 10 sec. Trigger Activation ■ Maximum file size Specify the maximum file size allowed.
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. For more information about Local storage, please refer to page 167. If you click View button of Network storage, a file directory window will pop up for you to view recorded data on Network storage.
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.
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. If you want to stop the event trigger, you can click ON to turn it to OFF status or click Delete to remove a previously-configured event setting. To remove a server setting from the list, select a server name and click Delete. Note that you can only delete a server when it is not involved in an Event setting.
PAGE 151
VIVOTEK Customized Script This function allows you to upload a sample script (.xml file) to the webpage, which will save your time on configuring the settings. Please note that there is a limited number of customized scripts you can upload; if the current amount of customized scripts has reached the limit, an alert message will prompt. If you need more information, please contact VIVOTEK’s technical support.
PAGE 152
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. If Human detection is applied, make sure you measured the height of your camera at the installation site.
PAGE 153
VIVOTEK Applications > Smart VCA Smart VCA provides the following features: Intrusion detection, Loitering detection, Missing object detection, Unattended Object detection, Line Crossing detection, and Face detection. Please refer to Smart VCA’s user documentation for more information: 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
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. Set up the event source as DI on Event > Event settings > Trigger.
PAGE 155
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. Click to select the checkbox before tampering conditions: Tampering detection, Image too dark, Image too bright, and Image too blurry. Enter the tamper trigger duration. (10 sec. ~ 10 min.).
PAGE 156
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. 3. A PTZ camera can be directed to turn to a preset point by the occurrence of audio events. 4.
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. 2. Use a mouse click to drag the Alarm level tab to a preferred location on the slide bar. 3. Select the Day, Night, or Schedule mode check circles.
PAGE 158
VIVOTEK Applications > Shock detection The camera comes with a shock accelerometer. The shock sensor can detect impacts to the camera. For example, when a person deliberately tries to destroy the camera, the camera can report the event to the administrator. Normally, a 5kgm impact can cause the detected impact level to surge to 50% on the scale. Configure the Alarm Level to a preferred percentage on the chart. Click the Enable shock detector checkbox and click Save to complete the configuration.
PAGE 159
VIVOTEK Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) Note that the IoT Security package is started from here. Click to enter the configuration page. Users can store and execute VIVOTEK's or 3rd-party software modules onto the camera's flash memory or SD card. These software modules can apply in video analysis for intelligent video applications such as license plate recognition, object counting, or as an agent for edge recording, etc.
PAGE 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. Click on the X button to remove an existing module. When prompted by a confirm message, Click Yes to proceed.
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
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. Recording Settings Click Add to open the recording setting window.
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 on the Stream setting page. Please refer to page 81 for more information.
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). 2. Destination You can select the SD card or network storage (NAS) for the recorded video files.
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. ■ Maximum file size: This determines the file size of each concluded recording. The applicable sizes range from 100 to 2000 Megabytes. ■ File name prefix: Enter a name for each recorded video.
PAGE 167
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. Camera filesystem takes up several megabytes of memory space. The storage space cannot be used for recording. Using an SD card that already contains data recorded by another device should not be used in this camera. Please do not modify or change the folder names in the SD card.
PAGE 168
VIVOTEK SD card control ■ Enable cyclic storage: Check this item if you want to enable cyclic recording. When the maximum capacity is reached, the oldest file will be overwritten by the latest one. ■ Enable automatic disk cleanup: Check this item and enter the number of days you wish to retain a file. For example, if you enter “7 days”, the recorded files will be stored on the SD card for 7 days. Click Save to enable your settings.
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
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. ■ File attributes: Select one or more items as your search criteria.
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 ■ Play: Click on a search result which will highlight the selected item. A Play window will appear on top for immediate review of the selected file.
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: Click to switch pages ■ Remove: Select the desired search results, then click this button to delete the files.
PAGE 173
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. The HTTP-based camera interface provides the functionality to request a single image, control camera functions (PTZ, output relay etc.), and get and set internal parameter values.
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. The CGIs are organized in functionally-related directories under the cgi-bin directory. The file extension .cgi is required.
PAGE 175
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 4. Security Level SECURITY LEVEL SUB-DIRECTORY DESCRIPTION 0 anonymous Unprotected. 1 [view] viewer Can view, listen, and talk to camera. 4 [operator] operator Operator access rights can modify most of the camera’s parameters except some privileges and network options. 6 [admin] admin Administrator access rights can fully control the camera’s operations. 7 N/A Internal APIs. Unable to be changed by any external interfaces.
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:///cgi-bin/anonymous/getparam.cgi?[] [&…] http:///cgi-bin/viewer/getparam.cgi?[] [&…] http:///cgi-bin/operator/getparam.cgi?[] [&…] http:///cgi-bin/admin/getparam.
PAGE 177
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n 29 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:///cgi-bin/anonymous/setparam.cgi? = [&=…][&return=] http:///cgi-bin/viewer/setparam.cgi? = [&=…][&return=] http:///cgi-bin/operator/setparam.
PAGE 179
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK [] 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 31 User's Manual - 179
PAGE 180
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7. Available Parameters on the Server Valid values: VALID VALUES DESCRIPTION string[] Text strings shorter than ‘n’ characters. The characters “,’,<,>,& are invalid. string[n~m] Text strings longer than `n’ characters and shorter than `m’ characters. The characters “,’,<,>,& are invalid. password[] The same as string but displays‘*’ instead. Any single integer number in 32-bits. The range is -2147483648~2147483647.
PAGE 181
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved VALID VALUES DESCRIPTION The format for resolution. W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 available The API is listed in product WebAPIs. non-available The API is not in product WebAPIs. valid The API is listed in product WebAPIs, and is functional. non-valid The API is listed in product WebAPIs, but is malfunction in this status.
PAGE 184
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME SECURITY (get/set) DESCRIPTION daylight_auto_begintim string[19] e 6/7 Display the current daylight saving start time. daylight_auto_endtime string[19] 6/7 Display the current daylight saving end time. daylight_timezones string 6/6 List time zone index which support daylight saving time.
PAGE 185
© 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) VIVOTEK DESCRIPTION values except the custom language file 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 (get/set) DESCRIPTION * 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 (get/set) DESCRIPTION modelname string[40] 0/7 Internal model name of the server extendedmodelname string[40] 0/7 ODM specific model name of server (eg. DCS-5610).
PAGE 187
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 0, 0/6 Maximum number of custom languages supported on the server. customlanguage_coun 0, 0/6 Number of custom languages which have been uploaded to the server. customlanguage_i<0~ (maxcount-1)> 0/6 Custom language name. language_i7 : 简体中文 language_i8 : 繁體中文 customlanguage_max count string 7.
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 1/7 Indicates whether the video source is connected or not. * Only available when capability_videoin_type is 0 or 1. signal_type ntsc,pal 1/7 The actual modulation type. * Only available when capability_videoin_type is 0 or 1. 7.
PAGE 190
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION changing port settings. Ex: 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. ”/cgi-bin/admin/setparam.cgi? network_preprocess=9&network_http_ port=5556& network_rtp_videoport=20480” type lan, pppoe 6/6 Network connection type.
PAGE 191
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION password string[200] 7/6 Password for TLS privatekeypassword string[200] 7/6 Password for PEAP ca_exist 6/6 CA installed flag ca_time 0, 6/7 CA installed time.
PAGE 192
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) video 0~63 6/6 Video channel for DSCP audio 0~63 6/6 Audio channel for DSCP (capability_naudioin > 0) eventalarm 0~63 6/6 Event/alarm channel for DSCP management 0~63 6/6 Management channel for DSCP eventtunnel 0~63 6/6 Event/Control channel for DSCP 7.6.
PAGE 193
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK NAME VALUE SECURITY (get/set) DESCRIPTION authmode basic, digest 1/6 HTTP authentication mode. s<0~(capability_nmed iastream*capability_n videoin)-1)>_accessna me string[32] 1/6 Http server push access name for stream N, N= 1~(capability_nmediastream*capability_ nvideoin)-1). (capability_protocol_spush_mjpeg =1 and capability_nmediastream > 0) The value are shown as video1s1.
PAGE 194
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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. 7.6.
PAGE 195
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) me c<0~(capability_nvide string[32] oin)-1>_s<0~(capabilit y_nmediastream)-1)> _accessname DESCRIPTION =1 and capability_nmediastream > 0) 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 NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION * We modify the value of RTSP access name after version number(httpversion) is 0311c pimssm_enable 7/6 To enable the feature of Protocol Independent Multicast - Source Specific Multicast. * We support this parameter when the version number (httpversion) is equal or greater than 0313a. 7.6.
PAGE 197
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION number (httpversion) is equal or greater than 0304a. videoport 1025 ~ 65535 4/4 Multicast video port. audioport 1025 ~ 65535 4/4 Multicast audio port. * Only available when capability_naudioin > 0 metadataport 1026~6553 4 4/4 Multicast metadata port. ttl 1 ~ 255 4/4 Multicasttime to live value. 7.6.
PAGE 198
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) pass password[64] 7/6 PPPoE account password. 7.6.13 Bonjour Subgroup of network: service_bonjour NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable bonjour service feature. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. servicename 6/6 A friendly name for bonjour service.
PAGE 199
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 6/6 IPv6 address list. address - end ip address> ipv6list_i<0~9> string[43] 7.8 Video Input Group: videoin * We do not support this parameter when "capability_nvideoin > 1". NAME VALUE SECURITY (get/set) DESCRIPTION cmosfreq 50, 60 4/4 CMOS frequency. * Only available when capability_videoin_type is 2. * We do not support this parameter when "capability_nvideoin > 1".
PAGE 200
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION 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 de" !="-" * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
PAGE 201
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. irismode fixed, indoor, outdoor 4/4 Control DC-Iris mode. "outdoor": Auto-setting DC-Iris to get best quality, but easy to meet rolling or flicker effect in indoor environment. "indoor": Avoid rolling and flicker effect first. "fixed": Open the iris to maximum.
PAGE 202
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION 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. flip 4/4 Flip the image. * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
PAGE 203
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only) * 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. text string[64] 1/4 Enclose caption.
PAGE 204
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * 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. maxexposure <1~32000>, <5~32000>, <1~8000>, <5~8000>, etc.
PAGE 205
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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. 7.8.
PAGE 206
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION 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. "sodiumauto": sodium vapor lamps. * Only available when "capability_image_c<0~(n-1)>_wbmo de" !="-" rgain 0~100 4/4 Manual set rgain value of gain control setting.
PAGE 207
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION 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 8: EV +0.7 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.
PAGE 208
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION * Only available when "capability_image_c<0~(n-1)>_exposu re_mode" !=0 irismode fixed, indoor, outdoor 4/4 Control DC-Iris mode. "outdoor": Auto-setting DC-Iris to get best quality, but easy to meet rolling or flicker effect in indoor environment. "indoor": Avoid rolling and flicker effect first. "fixed": Open the iris to maximum.
PAGE 209
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION "capability_image_c<0~(n-1)>_iristype "=piris enableblc 4/4 Enable backlight compensation * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c<0~(n-1)>_mode" to switch on/off BLC. maxgain 0~100 4/4 Maximum gain value.
PAGE 210
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION * 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. color 0, 1 4/4 0 =>monochrome 1 => color * Only available when " capability_videoin_c<0~(n-1)>_color_ support" is 1. flip 4/4 Flip the image.
PAGE 211
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION imprinttimesta mp 4/4 Overlay time stamp on video. textonvideo_p osition top, bottom 4/4 Text on video string position textonvideo_si ze 20~40 4/4 Text on video font size textonvideo_fo /usr/share/font/Default.ttf 4/4 ntpath , /mnt/flash2/upload.ttf Choose camera default font file (/usr/share/font/Default.ttf) or user uploaded font file(/mnt/flash2/upload.ttf).
PAGE 212
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION 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 re_maxrange" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues".
PAGE 213
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION * Only available when "capability_image_c<0~(n-1)>_exposu re_mode" !=0 meteringmode auto, 4/4 blc, hlc * Available value is listed in "capability_image_c<0~(n1)>_exposure_meteringm ode" "auto": The algorithm chooses the best metering strategy. "blc": This metering method increases the weight of dark area. "hlc": The metering method can detect strong light and make affected area clear.
PAGE 214
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION the version number (httpversion) is equal or greater than 0310a. s<0~(m-1)>_en ableeptz 4/4 Indicate whether stream supprts eptz or not s<0~(m-1)>_co dectype Listed at 1/4 "capability_videoin_codec " Possible values are: mjpeg, h264,h265 Codec type for this stream s<0~(m-1)>_re solution Available options are list in 1/4 "capability_videoin_c<0~( n-1)>_resolution".
PAGE 215
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION The unit is millisecond (ms). s<0~(m-1)>_h2 cbr, vbr 64_ratecontrol mode 4/4 cbr: Constant bit rate mode. vbr: Fixed quality mode, all frames are encoded in the same quality.
PAGE 216
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) 64_cbr_quant s<0~(m-1)>_h2 1~100 64_cbr_qperce nt DESCRIPTION 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only available when "h264_ratecontrolmode"= cbr. 4/4 Select customized quality in a normalized full range. 1: Worst quality 100: Best quality * Only valid when "h264_ratecontrolmode"= cbr and "quant"= 100.
PAGE 217
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION q_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. s<0~(m-1)>_h2 65_dintraperio d_enable 4/4 Enable "Dynamic intra frame period". * Only available when "capability_videoin_c<0~(n-1)>_dintra period_support" is 1 and h265 is listed in "capability_videoin_codec".
PAGE 218
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) 65_qvalue s<0~(m-1)>_h2 1~100 65_qpercent DESCRIPTION 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. 4/4 Select customized quality in a normalized full range. 1: Worst quality 100: Best quality * Only available when h265 is listed in "capability_videoin_codec".
PAGE 219
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION 4/4 Select customized quality in a 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 "quant"= 100. s<0~(m-1)>_h2 20000~"capability_videoin 4/4 65_bitrate _c<0~(n-1)>_h265_maxbit rate" The target bit rate in constant bit rate mode.
PAGE 220
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) able DESCRIPTION "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. s<0~(m-1)>_mj cbr, vbr peg_ratecontr olmode 4/4 cbr: Constant bit rate mode. vbr: Fixed quality mode, all frames are encoded in the same quality.
PAGE 221
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION 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 4/4 peg_maxvbrbit _c<0~(n-1)>_mjpeg_maxbi rate trate" The maximum allowed bit rate in fixed quality mode. When the bit rate exceeds this value, frames will be dropped to restrict the bit rate.
PAGE 223
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION mode" is 1 wdrc_strength 1~100 4/4 The strength of WDR enhanced. The bigger value means the stronger strength of WDR enhanced. * Only available when "capability_image_c<0~(n-1)>_wdrc_ mode" is 1 aespeed_mod e 4/4 Turning AE converge speed on or off.
PAGE 224
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION * 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 4/4 Turn on(1) or turn off(0) the flickerless mode * Only available when "capability_image_c<0~(n-1)>_flickerl ess" is 1. mounttype ceiling, wall, floor 1/6 Hardware installation.
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 (get/set) DESCRIPTION enable 4/4 Enable or Disable smart codec function mode autotracking,manual,hybri d 4/4 Set Smart stream mode "autotracking": only available when "capability_smartstream_mode_autot racking" is 1.
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 (get/set) DESCRIPTION enable 4/4 Enable or disable the window. home 0~320,0~240 4/4 Left-top corner coordinate of the window. size 0~320x0~240 4/4 Width and height of the window 7.8.1.
PAGE 227
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". maxexposure <1~32000>, <5~32000>, <1~8000>, <5~8000>, etc. 4/4 * Available value is listed in "capability_image_c<0~(n1)>_exposure_maxrange" shuttervalue <1~32000>, 4/4 <5~32000>, <1~8000>, <5~8000>, etc.
PAGE 228
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION 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 re_maxrange" != "-" 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.
PAGE 229
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 12: EV +2.0 *Only available when "capability_image_c0_exposure_mod e" != 0 exposuremode auto, shutterpriority, irispriority, qualitypriority, manual, etc 4/4 Select exposure mode. "auto": Automatically adjust the Iris, Gain and Shutter Speed to fit the exposure level. "shutterpriority": Manually adjust with variable Shutter Speed, and keep adjusting Iris, Gain automatically.
PAGE 230
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) in "capability_image_c<0~(n1)>_wbmode") DESCRIPTION b. if "rbgain" is supported, "rgain" and "bgain" are updated to the current values which is got from 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. "sodiumauto": sodium vapor lamps.
PAGE 231
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * Normalized range. maxgain 0~100 4/4 Maximum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_m axgain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". mingain 0~100 4/4 Minimum gain value.
PAGE 232
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION meteringmode auto, blc, hlc 4/4 "auto": The algorithm chooses the best metering strategy. "blc": This metering method increases the weight of dark area. "hlc": The metering method can detect strong light and make affected area clear. * We support this parameter when the version number (httpversion) is equal or greater than 0311a.
PAGE 233
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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 "=dciris wdrpro_mode 0, 1, 2 4/4 0: Disable WDR Pro. 1: Enable WDR Pro. * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode" = 1 2: Enable WDR Pro II.
PAGE 234
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION 1: on * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1 aespeed_spee dlevel 1~100 4/4 The speed level of AE converge speed. 1~20: level 1 21~40: level 2 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher speed level meas shorter AE converged time during AE executing.
PAGE 235
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION ess" is 1 7.8.2 Multicast Settings for Video Streaming Group: videoin_c<0~(n-1)>_s<0~(m-1)>_multicast (capability_media_streamprofiles_support = 1) n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" NAME VALUE SECURITY( get/set) DESCRIPTION ipaddress 4/4 Multicast video IP address. port 1025 ~ 65535 4/4 Multicast video port.
PAGE 236
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION the version number (httpversion) is equal or greater than 0312a. c<0~(n-1)>_s< 0~(m-1)>_allo w 4/4 Enable time shift streaming for specific stream. 7.
PAGE 237
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION is equal or greater than 0400a. daymodebegintime 00:00~23:59 6/6 Day mode begin time * We replace this parameter with “ircutcontrol_c<0~(n-1)>_daymodebe gintime” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin > 1".
PAGE 238
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION is equal or greater than 0400a. enableextled 1/6 Enable/disable external IR led * Only available when "capability_daynight_c<0~"capability_ nvideoin"-1>_externalir > 0". * We replace this parameter with "ircutcontrol_illuminators_external_d o_enabled" when the version number (httpversion) is equal or greater than 0312a.
PAGE 239
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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. sensitivity low,normal,high,1~10 0 6/6 Sensitivity of day/night control.
PAGE 240
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) "capability_daynight_ c<0~(n-1)>_spectrum _mode". DESCRIPTION (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. 7.10.
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 6/6 Day mod end time * We support this parameter when the version number (httpversion) is equal or greater than 0312a. bwmode 6/6 Switch to B/W in night mode if enabled. * Only available when "capability_daynight_c<0~(n-1)>_ blackwhitemode" is 1.
PAGE 242
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Y (get/set) builtin_irled_enabled 6/6 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, 6/6 ir, irenhanced, blueenhanced * Available values are listed in "capability_daynig ht_illuminators _spectrum_mode" . Set spectrum method .
PAGE 244
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION contrast -5~5,100 4/4 -5: Less contrast <-> 5: More contrast 100: Use " image_c<0~(n-1)>_contrastpercent" * Only available when bit 1 of "capability_image_c<0~(n-1)>_basicse tting" is 1. * We replace "contrast" with "contrastpercent ". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
PAGE 245
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 0: Darker <-> 100: Bright * Only available when bit 0 of "capability_image_c<0~(n-1)>_basicse tting" is 1. contrastpercent 0~100 4/4 Set contrast in the normalized range. 0: Less contrast <-> 100: More contrast * Only available when bit 1 of "capability_image_c<0~(n-1)>_basicse tting" is 1 saturationpercent 0~100 4/4 Set saturation in the normalized range.
PAGE 246
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION * Only available when "capability_image_c<0~(n-1)>_gamm acurve" is 1 lowlightmode 4/4 Enable/disable low light mode. * Only available when "capability_image_c<0~(n-1)>_lowligh tmode" is 1 hlm 4/4 Enable/disable hightlight mask.
PAGE 247
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION e". eis_strength 1~100 4/4 Strength of electronic image stabilizer * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mod e". dis_mode 4/4 Digital image stabilizer 0:disable 1:enable * Only available when 'dis' is listed in "capability_image_c<0~(n-1)>_is_mod e".
PAGE 248
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "capability_image_c<0~(n-1)>_freeze" is 1 deinterlace_enable 4/4 Enable/disable deinterlace function. 0: disable 1: enable * Only available when "capability_image_c<0~(n-1)>_deinter lace_support" is 1.
PAGE 249
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * Only available when "capability_image_c<0~(n-1)>_lens_ld c_support" is 1. palette_mode Available value is listed in "capability_image_c< 0~(n-1)>_palette_mo de" 1/4 Set color palette option. profile_i<0~(m-1)> _enable 4/4 Enable/disable this profile setting profile_i<0~(m-1)> _policy night, schedule 4/4 The mode which the profile is applied to.
PAGE 250
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION after the version number (httpversion) is equal or greater than 0400a. profile_i<0~(m-1)> _contrast -5~5,100 4/4 -5: Less contrast <-> 5: More contrast 100: Use " image_c<0~(n-1)>_contrastpercent" * Only available when bit 1 of "capability_image_c<0~(n-1)>_basicse tting" is 1. * We replace "profile_i0_contrast" with "profile_i0_contrastpercent ".
PAGE 251
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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. profile_i<0~(m-1)> 0~100 _brightnesspercent 4/4 Set brightness in the normalized range. 0: Darker <-> 100: Bright * Only available when bit 0 of "capability_image_c<0~(n-1)>_basicse tting" is 1.
PAGE 252
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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. For example, 1~45 may all be mapped to gamma value = 0.45, etc. * Only available when "capability_image_c<0~(n-1)>_gamm acurve" is 1 profile_i<0~(m-1)> _lowlightmode 4/4 Enable/disable low light mode.
PAGE 253
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION profile_i<0~(m-1)> _defog_strength 1~100 4/4 Strength of defog * Only available when "capability_image_c<0~(n-1)>_defog_ mode" is 1 profile_i<0~(m-1)> _eis_mode 4/4 Electronic image stabilizer 0:disable 1:enable * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mod e".
PAGE 254
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) "capability_image_c<0~(n-1) >_exposure_winmode" DESCRIPTION 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. "center": Use Center window as metering area and give the necessary light compensation.
PAGE 255
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION homepx <0~W,0~H> 4/4 Left-top corner coordinate of the window. W: 0~ The current image width -1 H: 0~ The current image height -1 sizepx <0~Wx0~ H> * Only available when px is listed in "capability_image_c<0~(n-1)>_exposu re_windomain". 4/4 W: 0~ The current image width -1 H: 0~ The current image height -1 homestd <0~9999,0~9999> Width and height of the window.
PAGE 256
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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. "center": Use Center window as metering area and give the necessary light compensation.
PAGE 257
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION re_windomain". homepx <0~W,0~H> 4/4 W: 0~ The current image width -1 H: 0~ The current image height -1 sizepx <0~Wx0~ H> Left-top corner coordinate of the window. * Only available when px is listed in "capability_image_c<0~(n-1)>_exposu re_windomain". 4/4 W: 0~ The current image width -1 H: 0~ The current image height -1 Width and height of the window.
PAGE 258
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION or greater than 0301a. * We replace "source" with "input". More details, please refer the parameter description of "input". input intmic, extmic 4/4 intmic: Internal (built-in) microphone. (Only available when capability_audio_intmic = 1) extmic: External microphone input.
PAGE 259
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION gain 0~100 4/4 Gain of input. (audioin_c<0~(n-1)>_source = linein) * Reserved for compatibility, and suggest don't use this since the version number (httpversion) is equal or greater than 0301a. * We replace "gain" with "volume_internal" and "volume_external". More details, please refer the parameter description of "volume_internal" and "volume_external".
PAGE 260
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 96000, 128000 s0_gamr_bitrate 4750, 5150, 5900, 6700, 7400, 7950, 10200, 12200 4/4 AMR encoded bitrate in bps. * Only available if AMR is supported. s0_g711_mode pcmu, pcma 4/4 Set G.711 companding algorithm. pcmu: µ-law algorithm pcma: A-law algorithm * Only available if G.711 is supported. s0_g726_bitrate 16000, 24000, 32000, 40000 4/4 Set G.726 encoded bitrate in bps. * Only available if G.
PAGE 261
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION alarm_enable 4/4 Enable audio detection alarm_level 1~100 4/4 Audio detection alarm level profile_i0_enable 4/4 Enable/disable this profile setting profile_i0_policy night, schedule 4/4 The mode which the profile is applied to. * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a.
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 (get/set) DESCRIPTION name string[40] 1/4 Specify the audio clip name that can be played when an event occurs. size 0, 1/4 The size of audio clip.
PAGE 263
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) ~ 9999,0 ~ 9999, 0 ~ 9999,0 ~ 9999, 0 ~ 9999,0 ~ 9999 position. (4 points: x0,y0,x1,y1,x2,y2,x3,y3) * Only available when "capability_motion_wintype" = polygon. * Only available when std is listed in "capability_motion_windomain" objsize 1 ~ 100 4/4 Percent of motion detection window. sensitivity 0 ~ 100 4/4 Sensitivity of motion detection window.
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 4/4 Left coordinate of window position. * Only available when "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain".
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] 4/4 Name of motion window. polygonstd 0 ~ 9999,0 ~ 9999, 0 ~ 9999,0 ~ 9999, 0 ~ 9999,0 ~ 9999, 0 ~ 9999,0 ~ 9999 4/4 Coordinate of polygon window position. (4 points: x0,y0,x1,y1,x2,y2,x3,y3) * Only available when "capability_motion_wintype" = polygon. * Only available when std is listed in "capability_motion_windomain objsize 1 ~ 100 4/4 Percent of motion detection window.
PAGE 267
© 2020 VIVOTEK INC. All Right Reserved NAME VALUE VIVOTEK 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. top 0 ~ 240 4/4 Top coordinate of window position. * Only available when "capability_motion_wintype" = rectangle.
PAGE 268
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved 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" NAME VALUE SECURITY (get/set) DESCRIPTION enable 4/4 Enable or disable tamper detection. threshold 0~100 4/4 Threshold of tamper detection.
PAGE 269
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION blurry_duration 1~10 4/4 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) NAME VALUE SECURITY (get/set) DESCRIPTION enable 6/6 Enable or disable the dynamic DNS. provider DyndnsDynamic, DyndnsCustom, Safe100 6/6 DyndnsDynamic => dyndns.
PAGE 270
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Group: upnppresentation NAME VALUE SECURITY (get/set) DESCRIPTION enable 6/6 Enable or disable the UPnP presentation service. 7.21 UPnP Port Forwarding Group: upnpportforwarding NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable or disable the UPnP port forwarding service. upnpnatstatus 0~3 6/7 The status of UPnP port forwarding, used internally.
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) NAME VALUE SECURITY (get/set) DESCRIPTION v2 6/6 SNMP v2 enabled. 0 for disable, 1 for enable v3 6/6 SNMP v3 enabled.
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 (get/set) DESCRIPTION enable 4/4 Enable privacy mask. win_i<0~(m-1)>_enable 4/4 Enable privacy mask window. win_i<0~(m-1)>_name string[14] 4/4 Name of the privacy mask window.
PAGE 274
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE npx 0 ~ W,0 ~ H, 0 ~ W,0 ~ H, 0 ~ W,0 ~ H W: 0~ The current image width -1 H: 0~ The current image height -1 win_i<0~(m-1)>_polygo nstd 0 ~ 9999,0 ~ 9999, 0 ~ 9999,0 ~ 9999, 0 ~ 9999,0 ~ 9999, 0 ~ 9999,0 ~ 9999 SECURITY (get/set) DESCRIPTION position. (4 points: x0,y0,x1,y1,x2,y2,x3,y3) * Only available when "capability_image_c<0~(n-1)>_privacy mask_wintype" = polygon.
PAGE 275
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION >_maxpan" "capability_camctrl_c<0~(n-1)>_ buildinpt" is "1" win_i<0~(m-1)>_tilt "capability_ptz_c<0~(n-1) 4/4 >_mintilt" ~ "capability_ptz_c<0~(n-1) >_maxtilt" Tilt position of window position. * Only available when bit1 of "capability_camctrl_c<0~(n-1)>_ buildinpt" is "1" win_i<0~(m-1)>_zoom "capability_ptz_c<0~(n-1) 4/4 >_minzoom" ~ "capability_ptz_c<0~(n-1) >_maxzoom" Zoom position of window position.
PAGE 276
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION 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 distinguish between different platforms API version format: MMmmr_k Where "MM" is the major version, "mm" is the minor version and "r" is the revision. 'M' and 'm' and 'k' are decimal digit from 0 to 9, while 'r' is an alphabetic.
PAGE 277
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION capability_daynight_c<0~"capability_ nvideoin"-1>_externalir for external IR) * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. npir 0, 0/7 Number of PIRs. ndi 0, 0/7 Number of digital inputs.
PAGE 278
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION nmotion 0/7 The number of motion window. nmotionprofile 0, 0/7 Number of motion profiles. nevent 0, 0/7 Number of event. * We support this parameter when the version number (httpversion) is equal or greater than 0311c. nrecording 0, 0/7 Number of recording.
PAGE 279
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION is supported or SD/PZ/PT/PD/video server series) Bit 6 => (only available when bit0 is 1) Reserved bit; always 0. Bit 7 => (only available when bit0 is 1) External or built-in PT; 0(built-in), 1(external) windowless 0/7 Indicate whether to support windowless plug-in. evctrlchannel 0/7 Indicate whether to support HTTP tunnel for event/control transfer.
PAGE 280
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved SECURITY (get/set) DESCRIPTION presettourdirection 0/7 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 (get/set) DESCRIPTION channel. For some dual-stream products, both streams support ePTZ. nanystream 0, 0/7 number of any media stream per channel iva 0/7 Indicate whether to support Intelligent Video analysis whitelight 0/7 Indicate whether to support white light led.
PAGE 282
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "tampering" = Tamper detection. "vi" = Virtual input (Manual trigger) "vadp" = VADP trigger. "di"= Digital input. "volalarm" = Audio detection. "temperature" = Temperature detection. "pir" = PIR detection. "visignal" = Video input signal loss. "backup" = Backing up recorded files. "smartsd" = Lifetime detection of SD card. "shockalarm" = Shock detection. "virestore" = Video input signal restore.
PAGE 283
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION protocol_rtp_multi cast_scalable 0/7 Indicate whether to support scalable multicast. protocol_rtp_multi cast_backchannel 0/7 Indicate whether to support backchannel multicast. protocol_rtp_tcp 0/7 Indicate whether to support RTP over TCP. protocol_rtp_http 0/7 Indicate whether to support RTP over HTTP.
PAGE 284
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE xframerate "-" videoin_h264_max framerate A list of and "-" 0/7 This equals "capability_videoin_c0_h264_maxfra merate". * This is kept for compatibility. videoin_codec mjpeg, h264, h265 0/7 Available codec of a device, split by comma. The sequence is not limited. EX: FD8183 supports H.264 and MJPEG, then this is "mjpeg,h264". IP9171 supports H.264, MJPEG and H.
PAGE 285
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * We support this parameter when the version number (httpversion) is equal or greater than 0306b. audio_aecaffect -, maxframerate:fixed:1 5 0/7 When acoustic echo cancellation function is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here.
PAGE 286
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION 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". * We support this parameter when the version number (httpversion) is equal or greater than 0306b. audio_mic 0/7 Indicate whether to support built-in microphone input.
PAGE 287
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION audio_lineout 0/7 Indicate whether to support line output. audio_michardwar eswitch 0/7 Indicate whether the hardware supports built-in/external mic switch audio_headphoneo ut 0/7 Indicate whether to support headphone output. audio_audioclip 0/7 Indicate whether to support audio clip function.
PAGE 288
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION with pixels. "std": A normalized 0~9999 range. "-": Not supported. smartstream_supp ort 0/7 Indicate whether smart stream is supported. smartstream_versi on 0/7 Number of smart stream version. * Only available when "capability_smartstream_support" is 1 smartstream_nstre am 0/7 Number of stream that support smart stream.
PAGE 289
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "capability_smartstream_support" is 1 smartstream_nwin dow_manual 0/7 Maximum number of tracking window of manual. * Only available when "capability_smartstream_support" is 1 smartstream_nwin dow_hybrid_autotr acking 0/7 Maximum number of tracking window of autotracking in hybrid mode.
PAGE 290
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION camctrl_ptztunnel 0/7 Indicate whether to support ptztunnel. * We support this parameter when the version number (httpversion) is equal or greater than 0301b. This equals "capability_camctrl_c0_ptztunnel". * This is kept for compatibility. camctrl_privilege 0/7 Indicate whether to support “Manage Privilege” of PTZ control in the security page. 1: support both /cgi-bin/camctrl/camctrl.
PAGE 291
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION wireless_s802dot1 1g 0/7 Indicate whether to support wireless 802.11g. wireless_s802dot1 1n 0/7 Indicate whether to support wireless 802.11n. wireless_begincha nnel 1 ~ 14 0/7 Indicate the begin channel of wireless network wireless_endchann el 1 ~ 14 0/7 Indicate the end channel of wireless network wireless_encrypt_ wep 0/7 Indicate whether to support wireless WEP.
PAGE 292
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION test_ac 0/7 Indicate whether to support test ac key. version_onvifdaem on 0/7 Indicate ONVIF daemon version version_onviftestto ol 0/7 Indicate ONVIF test tool version version_genetec 0/7 Indicate Genetec daemon version * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
PAGE 293
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) use this> DESCRIPTION  "-": 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. * We replace "capability_image_iristype" with "capability_image_c0_iristype".
PAGE 294
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) recommended to use this> DESCRIPTION "capability_supportsd" is 1 or "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. localstorage_modv ersion 0/7 Indicate MOD daemon version. * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1.
PAGE 295
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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" is 1 or "capability_storage_dbenabled" is 1. remotecamctrl_ma ster 0, 0/7 Indicate whether to support remote auxiliary camera (master side), this value means supporting max number of auxiliary camera.
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 (get/set) DESCRIPTION ptztunnel 0/7 Indicate whether to support ptztunnel in this video input. privilege 0/7 Indicate whether to support “Manage Privilege” of PTZ control in the security page in this video input. 1: support both /cgi-bin/camctrl/camctrl.cgi and /cgi-bin/viewer/camctrl.
PAGE 297
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) focusmode auto,onetimeauto,sp 0/7 otlight,manual DESCRIPTION Focus mode selection: "auto": Camera will automatically adjust the focus position full time to 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 (get/set) DESCRIPTION minpan 0, 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, 0/7 The upper limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" minpanangle 0/7 The lower limit for pan angle.
PAGE 299
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION maxtiltangle 0/7 The upper limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" zoomspeedlv 0, 0/7 The maximum speed level of zoom motion. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoomm odule" is "1" minzoom 0, 0/7 The lower limit for zoom position.
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 0/7 Indicate whether the camera supports day/night mode switch builtinir 0/7 Indicate whether to support built-in IR led. * We replaced this parameter with “capability_daynight_illuminators_builti n_support” when the version number (httpversion) is equal or greater than 0312a.
PAGE 301
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) blackwhitemode 0/7 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. ircutsensitivity_type 0/7 Indicate the cgi interface of "ircutcontrol_sensitivity". "options": the value of "ircutcontrol_sensitivity" parameter is "low, normal,high".
PAGE 302
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) extled_interface do 0/7 The device interface of external IR led: "do": digital output * Only available when "capability_daynight_c<0~(n-1)>_extern alir" is 1 * We replaced this parameter with “capability_daynight_illuminators_exter nal_interface” when the version number (httpversion) is equal or greater than 0312a.
PAGE 303
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) spectrum_mode visible,ir,irenhanced, 0/7 blueenhanced Indicate the spectrum mode. "visible": The ideal default setting for visible light. "ir": The ideal default setting for IR light. "irenhanced": This CCM model increases the brightness effect of IR light. "blueenhanced": This CCM model increases the brightness effect of blue light.
PAGE 304
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mode auto,daynight,di,di2, 0/7 di3,di4,schedule, Indicate the day / night switch mode. "auto": The Camera automatically judges the current operation mode by the level of ambient light detected. "daynight": support day mode and night mode. In day mode, the camera streams color video. In night mode, the camera streams black and white video in low light environments.
PAGE 305
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK builtin_support 0/7 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, 0/7 Indicate whether to support built-in led type. "irled": IR led "whiteled": white led "-": not support * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
PAGE 306
VIVOTEK spectrum_mode © 2020 VIVOTEK INC. All Right Reserved visible,ir,irenhanced, 0/7 blueenhanced Indicate the spectrum mode. "visible": The ideal default setting for visible light. "ir": The ideal default setting for IR light. "irenhanced": This CCM model increases the brightness effect of IR light. "blueenhanced": This CCM model increases the brightness effect of blue light.
PAGE 307
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK Group: capability_videoin_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY (get/set) DESCRIPTION lens_type fisheye, fixed, varifocal, changeable, motor, ics, 0/7 The lens type of this channel. "fisheye": Fisheye lens "fixed": Build-in fixed-focus lens. "varifocal": Build-in varifocal lens. "changeable": changeable lens. Like box-type camera, users can install any C-Mount or CS-Mount lens as they wish.
PAGE 308
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION rotationaffect 0/7 When rotation is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here. The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it.
PAGE 309
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION rotationangle 0/7 The different angles which camera supports for rotation. * Only avaliable when "capability_videoin_c<0~(n-1)>_rotation" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309b. orientation flip,mirror,rotatio 0/7 n Indicates the camera supports flip, mirror or rotation.
PAGE 310
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION resolution A list of 0/7 Resolution options in current video mode. These options are the possible options for "videoin_c_s_resolution". The last one is the maximum resolution in current mode. maxresolution A list of 0/7 Represent supported maximum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream".
PAGE 311
© 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) VIVOTEK DESCRIPTION mjpeg_maxframerate A list of and "-" Maximum fps that the device can encoded with MJPEG on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group. * This parameter may be changed when "videoin_c_cmosfreq"=50 or "videoin_c_modulation"=pal.
PAGE 312
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION h264_maxbitrate 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 0/7 h Indicate H264 profiles * Only available when 'h264' is listed in "capability_videoin_codec". * We support this parameter when the version number (httpversion) is equal or greater than 0309a.
PAGE 314
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION cameraunit_name CU8131, CU8171, CU8161-H, CU8162-H, CU8163-H, CU8361-H, ..., 0/7 A "camera unit" name of a split-type camera system, which the camera unit and the video core are separated. -: If the camera is not a split-type camera system, the value of this parameter is "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302b.
PAGE 315
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) resolutionC1P A list of 0/7 Available resolutions of 1P mode of ceiling and floor mount. resolutionC2P A list of 0/7 Available resolutions of 2P mode of ceiling and floor mount. resolutionC1R A list of 0/7 Available resolutions of 1R mode of ceiling and floor mount. resolutionC4R A list of 0/7 Available resolutions of 4R mode of ceiling and floor mount.
PAGE 316
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) eptz 0, 0/7 Indicate this mode whether support eptz. For "nvideoin" = 1, the definition is as following: A 32-bits integer, each bit can be set separately as follows: Bit 0 => 1st stream supports ePTZ or not. Bit 1 => 2nd stream supports ePTZ or not, and so on. For nvideoin >= 2, the definition is different: First all 32 bits are divided into groups for channel.
PAGE 317
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) outputsize 0/7 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. * Source (most for image sensor) may perform scale or binning, etc on image data, and output data with smaller size. This parameter is designed to represent this.
PAGE 318
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) minresolution A list of 0/7 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. maxframerate A list of 0/7 Indicates frame rate that the video source outputs in this video mode.
PAGE 319
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxfps_h264 A list of and "-" 0/7 Maximum fps which the device can encoded with H.264 on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group.
PAGE 320
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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. Bit 5 => Supports adjusting the image to proper position vertically or not. hlm 0/7 Hightlight Mask: The function will strengthen the image contrast and mask the specified zone of image if any strong spot-light exists.
PAGE 321
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION exposurelevel:hidd en:, exposurelevel:fixed :, exposurelevel:fixed :/, exposuremode:fixe d:auto, gammacurve:disabl ed:, exposurewin.mode .blc:hidden:, exposurewin.mode .hlc:hidden:, exposuretime:hidd en:, gaincontrol:hidden: , flickerless:unchang ed:, wdrc:enabled:, wdrc:enabled:only once, wdrc:unchanged:, : nonnegative integer affected functions are list here.
PAGE 322
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION be "-" wdrpro_description 0/7 Description about WDR Pro mode. * Only available when "capability_image_c<0~(n-1)>_wdrpro _mode" > 0 wdrc_mode 0, 1 0/7 0: Non-support WDR Enhanced 1: Support WDR Enhanced wdrc_supportlevel 0, WDR Enhanced.
PAGE 323
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "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. "-" means no feature is affected.
PAGE 324
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION * We support this parameter when the version number (httpversion) is equal or greater than 0302a. is_strength 0/7 0: Non-support tuning strength of image stabilizer mode. 1: Support tuning strength of image stabilizer mode. * Only available when "capability_image_c<0~(n-1)>_is_mod e" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
PAGE 325
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc: disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6.
PAGE 326
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) panorama, manual, rbgain, widerange, outdoor,indoor, sodiumauto, DESCRIPTION "-" means white balance is not supported. iristype piris, dciris, - 0/7 Indicate iris type. "piris": P-Iris "dciris": DC-Iris "-": No Iris control support * Note: For some cameras, this value may be varied depending on mounted lens. sensortype rawsensor, smartsensor, thermalsensor, - 0/7 Indicate sensor type.
PAGE 327
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "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. exposure_shuttervalu etype fixed, maximum, - 0/7 * One to one mapping to the mode type in "exposure_modetype".
PAGE 328
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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_ affect -, exposurewin.mode .
PAGE 329
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "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)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_shutterprior -, itymode_affect exposurewin.mode .
PAGE 330
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when shutterpriority is listed in "capability_image_c<0~(n-1)>_ exposure_modetype" and "capability_image_c<0~(n-1)>_ exposure_mode" is 1.
PAGE 331
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL.
PAGE 332
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled.
PAGE 333
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) icrmode.auto:nots upport: or others : nonnegative integer DESCRIPTION "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values.
PAGE 334
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * 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, custom, blc, hlc, center, 0/7 Available options for "exposurewin_c<0~(n-1)>_mode" * "-" means group: exposurewin is not supported. * When exposure_mode="0", this value must be set to "-".
PAGE 335
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION - (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. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.
PAGE 336
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION control. "-": Not supported. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_windomain qvga, px, std, - 0/7 The domain to set an exposure window. "qvga": a 320x240 range to represent the whole image. "px": Locate a window in the image with pixels. "std": A normalized 0~9999 range. "-": Not supported. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1.
PAGE 337
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0301a. exposure_maxrange "1,32000", "1,8000", -, or others 0/7 Available range for "videoin_c_maxexposure" "1,32000" => 1s ~ 1/32000s "1,8000" => 1s ~ 1/8000s etc. "-" means maximum exposure time is not available. * When "exposure_mode"=0, this value must be set to "-".
PAGE 338
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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 (get/set) DESCRIPTION “0,100” => 0~100 percent "-" means "videoin_c_maxgain" is not available. agc_mingain "0,100", "-" 0/7 Available range for "videoin_c_mingain" “0,100” => 0~100 percent "-" means "videoin_c_mingain" is not available. flickerless 0,1 0/7 0: Non-support flickerless 1: Support flickerless flickerlessaffect -, minexposure.
PAGE 340
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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 (get/set) DESCRIPTION - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL.
PAGE 342
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION focusassist 0,1 0/7 0: Non-support focus assist 1: Support focus assist remotefocus 0, 0/7 An 4-bit integer, which indicates the supportive application of remotefocus in this channel. If the value of this parameter is larger than 0, it means that the camera supports remotefocus function in this channel. bit 0 => Indicate whether to support both zoom and focus function.
PAGE 343
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION the version number (httpversion) is equal or greater than 0302a. autotrack_support 0/7 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. smartsensor_iristotalr ange A list of iris value 0/7 Available total step for iris value.
PAGE 344
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION ignment" is 1. lens_ldc_support 0/7 Indicate whether to support lens distortion correction function. * We support this parameter when the version number (httpversion) is equal or greater than 0309d. palette_support 0/7 Indicate support color palettes or not.
PAGE 345
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.28 Customized Event Script Group: event_customtaskfile_i<0~2> PARAMETER VALUE SECURITY (get/set) DESCRIPTION name string[40] 6/6 Custom script identification of this entry. date string[4~20] 6/6 Date of custom script. time string[4~20] 6/6 Time of custom script. 7.
PAGE 346
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) trigger boot, di, pir, motion, seq, recnotify, tampering, vi, volalarm, visignal, vadp, smartsd 6/6 Indicate the trigger condition: "boot" = System boot. "di"= Digital input. "pir"= PIR detection. "motion" = Video motion detection. "seq" = Periodic condition. "visignal" = Video input signal loss. "recnotify" = Recording notification. "tampering" = Tamper detection.
PAGE 347
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) vi 0, 6/6 Indicate the source id of vi trigger. This field is required when trigger condition is “vi”. One bit represents one digital input. The LSB indicates VI 0. vadp 0, 6/6 Indicate the source id of vadp event notification. Each bit corresponds to one vadp source, and the LSB indicates source id 0.
PAGE 348
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) endtime hh:mm 6/6 End time of the weekly schedule. (00:00 ~ 24:00 sets schedule as always on) lowlightcondition 0, 1 6/6 Switch on white light LED in low light condition 0 => Do action at all times 1 => Do action in low-light conditions action_do_i<0~(ndo-1)>_ enable 6/6 Enable or disable trigger digital output.
PAGE 349
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_cf_backup 6/6 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 able 6/6 Enable or disable this server action. action_server_i<0~4>_m NULL, 0~4,101 edia 6/6 Index of the attached media.
PAGE 350
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_audioclip_media 0, 6/6 Indicate the source id of audioclip event notification. * Only avaliable when "capability_audio_audioclip" is 1. tampering 6/6 Indicate the source channel id of tampering detection. A 4-bit integer, each bit represents each channel. bit 0 => tampering detection for first channel. bit 1 => tampering detection for second channel.
PAGE 351
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) ftp_username string[64] 6/6 Username to log in to the server. ftp_passwd string[64] 7/6 Password of the user. ftp_port 0~65535 6/6 Port to connect to the server. ftp_location string[128] 6/6 Location to upload or store the media. ftp_passive 6/6 Enable or disable passive mode. 0 = disable passive mode 1 = enable passive mode email_address string[128] 6/6 Email server address.
PAGE 352
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) snapshot_channel 0~"capability_nvideoin"-1 6/6 snapshot_source 0~"capability_nmediastream 6/6 "-1 Indicate the source of media stream. 0 means the first stream. 1 means the second stream and etc. 2 means the third stream and etc. 3 means the fourth stream and etc. snapshot_prefix string[16] 6/6 Indicate the prefix of the filename.
PAGE 353
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) videoclip_channel 0~"capability_nvideoin"-1 6/6 videoclip_source 0~"capability_nmediastream 6/6 "-1 Indicate the source of media stream. 0 means the first stream. 1 means the second stream and etc. 2 means the third stream and etc. 3 means the fourth stream and etc. videoclip_prefix string[16] Indicate the prefix of the filename.
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] 6/6 Identification of this entry. trigger schedule, networkfail 6/6 The event trigger type schedule: The event is triggered by schedule networkfail: The event is triggered by the failure of network connection. enable 6/6 Enable or disable this recording.
PAGE 355
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxretentiontime 6/6 To specify the expired time for automatic clean up, and it only takes effect for video clip generated by recording_i <0~1>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss] S’ , similar with ISO8601 with symbols P Ex. P7D, it means 7 days. P1DT10H, it means 1 days and 10 hours. The parameter takes effect when autocleanup_ maxretentiontime_recording_enabled is enabled.
PAGE 356
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) weekday 0~127 6/6 Indicate which weekday is scheduled. One bit represents one weekday. bit0 (LSB) = Saturday bit1 = Friday bit2 = Thursday bit3 = Wednesday bit4 = Tuesday bit5 = Monday bit6 = Sunday For example, to detect events on Friday and Sunday, set weekday as 66. begintime hh:mm 6/6 Start time of the weekly schedule. endtime hh:mm 6/6 End time of the weekly schedule.
PAGE 357
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) adaptive_enable 6/6 Indicate whether the adaptive recording is enabled adaptive_preevent 0~9 6/6 Indicate when is the adaptive recording started before the event trigger point (seconds) adaptive_postevent 0~10 6/6 Indicate when is the adaptive recording stopped after the event trigger point (seconds) 7.
PAGE 358
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION organizationname string[64] VIVOTEK Inc. 6/6 Organization name in the certificate information. unit string[64] VIVOTEK Inc. 6/6 Organizational unit name in thecertificate information. commonname string[64] www.vivotek.com 6/6 Common name in the certificate information. validdays 0 ~ 3650 6/6 Valid period for the certification. 7.
PAGE 359
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION autocleanup_enabled 6/6 Enable automatic clean up method. Expired and not locked media files will be deleted. * For forward compatibility reservations, but only group disk_i0_autocleanup is effective. * Not recommended to use this. Please refers "autocleanup" group.
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 (get/set) DESCRIPTION s<0~(m-1)>_home 1/6 ROI left-top corner coordinate.* If the minimal window size is 64x64, then the "win_i0_home"=(0~resolution_W-64, 0~resolution_H-64), which the resolution is the value in current stream.
PAGE 361
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION tiltspeed -5 ~ 5 1/4 Tilt speed * Only available when "capability_fisheye" is 1 1/7 Tilt speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.) 1/4 Pan speed * Only available when "capability_fisheye" is 1 1/7 Pan speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.
PAGE 362
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION patrolseq string[120] 1/4 The patrol sequence of ePTZ. All the patrol position indexes will be separated by "," patroldwelling string[160] 1/4 The dwelling time (unit: second) of each patrol point, separated by “,”. preset_i<0~19>_name string[40] 1/4 Name of ePTZ preset. * Only available when "capability_fisheye" is 1 1/7 Name of ePTZ preset. (It should be set by ePreset.
PAGE 363
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION win_i0_home 4/4 Left-top corner coordinate of the window. * 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_ c<0~(n-1)>_focuswindow_range" . win_i0_size 4/4 Width and height of the window.
PAGE 364
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION maxconnection 3 1/7 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 > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
PAGE 365
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION guid<0~2>_number 0~3 1/7 Number of connected seamless streaming with guid<0~(k-1)>_id. (Read only) * We replace this parameter with “seamlessrecording_c<0~(n-1)>_guid<0~2>_n umber” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin > 1".
PAGE 366
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved triggerrecord 1/7 Indicate whether seamless recording is recording to local storage or not at present. (Read only) * We support this parameter when the version number (httpversion) is equal or greater than 0312a. guid<0~(k-1)>_id string[127] 1/7 The connected seamless streaming ID.
PAGE 367
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) resource_free_storage 0, 6/7 Indicate current free storage size for uploading VADP modules. module_number 0, 6/7 Record the total module number that already stored in the system. module_order string[40] 6/6 The execution order of the enabled modules. module_save2sd 6/6 Indicate if the module should be saved to SD card when user want to upload it.
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 (get/set) DESCRIPTION enable 6/6 Indicate if the module is enabled or not. If yes, also add the index of this module to the module_order. name string[40] 6/6 Module name extendedname string[40] 6/6 Extended module name.
PAGE 369
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION enable 6/6 Enable or disable the schedule mode to control the execution of the VADP package begintime hh:mm 6/6 Begin time of the schedule endtime hh:mm 6/6 End time of the schedule VALUE SECURITY DESCRIPTION Group: vadp_event NAME (get/set) ntrigger 0, 6/7 Indicate the number of topics to be transferred to event manager for trigger.
PAGE 370
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION The dwelling time of each patrol point, separated by “,” * only available when capability_camctrl_c0_rs485=2 preset_i<0~(k-1)>_nam e string[40] 1/4 Name of the preset location. preset_i<0~(k-1)>_ dwelling 0 ~ 999 1/4 The dwelling time of each preset location * only available when capability_camctrl_c0_rs485=2 uart 0~" capability_nuar t"-1 1/4 Select corresponding uart (capability_nuart>0).
PAGE 371
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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. Therefore, once you send a controlling signal, each camera will only accept the inputs with the corresponding ID.
PAGE 372
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE preset_i<0~(k-1)>_name string[40] SECURITY (get/set) DESCRIPTION 1/4 Name of the preset location. preset_i<0~(k-1)>_zoom capability_ptz_ 1/4 c<0~(n-1)>_min zoom ~ capability_ptz_ c<0~(n-1)>_ma xzoom Zoom position at each preset location. preset_i<0~(k-1)>_focus capability_ptz_ 1/4 c<0~(n-1)>_min focus ~ capability_ptz_ c<0~(n-1)>_ma xfocus Focus position at each preset location.
PAGE 373
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION c<0~(n-1)>_min zoom ~ capability_ptz_ c<0~(n-1)>_ma xzoom axisf capability_ptz_ 1/4 c<0~(n-1)>_min focus ~ capability_ptz_ c<0~(n-1)>_ma xfocus Custom home focus position. digitalzoom 1/4 Enable/disable digital zoom zoomenhance 1/4 Enable /disable zoom enhancement returnhome 1/4 Enable/disable return home while idle.
PAGE 374
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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. Therefore, once you send a controlling signal, each camera will only accept the inputs with the corresponding ID.
PAGE 375
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION preset_i<0~(k-1)>_focus capability_ptz_c<0~( n-1)>_minfocus ~ capability_ptz_c<0~( n-1)>_maxfocus 1/4 Focus position at each preset location. preset_i<0~(k-1)>_focus setting sync, fixcurrent 1/4 The focus mode of each preset, which is essential and should be grouped with “preset_i<0~(k-1)>_name.” * We support this parameter when the version number (httpversion) is equal or greater than 0305b.
PAGE 376
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION capability_ptz_c<0~( n-1)>_maxfocus axisflip 1/4 Custom home flip side. returnhome 1/4 Enable/disable return home while idle. returnhomeinterval 1~999 1/4 While idle over this time interval, idle action will be taken.
PAGE 377
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0307a. tour_i<0~19>_checklist string[512] 1/4 The indexes of preset positions, separated by “,” tour_i<0~19>_dwelltim e string[512] 1/4 Preset tour: time to wait before moving to the next preset position, separated by “,” Recorded tour: number of seconds to wait before continuing a loop tour.
PAGE 378
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION paritybit none, odd, even 4/4 For error checking. stopbit 1,2 4/4 "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. If you want to transfer the stopbit for 150% of the normal time used to transfer one bit, the uart_i<0~(n-1)>_stopbit should be set as 2 and the uart_i<0~(n-1)>_databit set as 5 as well.
PAGE 379
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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. Therefore, once you send a controlling signal, each camera will only accept the inputs with the corresponding ID. baudrate 2400,4800,9600,19 200,38400,57600,1 15200 4/4 Set baud rate of COM port.
PAGE 380
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION selected 6/7 Current selected lens profile. e.g. lens_selected=lens_default_i0, it means choosen lens configuration is i0 lens of default group.
PAGE 382
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION [0~90]. Tilt range of wall mount is [-90~90]. s<0~(m-2)>_region_r 100~300 <0~(i-1)>_zoom 1/4 Zoom home ratio of regional view (for 4R mode, i is the view index and range from 0 to 3) PLEASE REFER TO FISHEYE LOCAL DEWARP API 7.48 PIR Behavior Define Group: pir (capability_npir > 0) NAME VALUE SECURITY (get/set) DESCRIPTION enable 1/1 Enable/disable PIR 7.
PAGE 383
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.50 Wireless Group: wireless (capability_network_wireless > 0) PARAMETER VALUE SECURITY (get/set) DESCRIPTION ssid string[32] 6/6 SSID for wireless lan settings. wlmode Infra, Adhoc 6/6 Wireless mode. Infra: Infrastructure channel 1~11 1~13 10~11 10~13 1~14 6/6 A list of WLAN channels. Countries apply their own regulations to the allowable channels.
PAGE 384
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION key2 password [26] 6/6 WEP key2 for encryption. * Only valid when "wireless_encrypt" is "wep" key3 password [26] 6/6 WEP key3 for encryption. * Only valid when "wireless_encrypt" is "wep" key4 password [26] 6/6 WEP key4 for encryption.
PAGE 385
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION fixed 1/7 The value indicates whether the profile can be deleted or not. Ex. fixed=1 indicates the profile cannot be deleted. occupied 1/6 Indicates the action of creating profile. Ex. If occupied=1 indicates the current profile is to be created; otherwise, if occupied=0 indicates the current profile is to be deleted. alwaysmulticast 1/6 Enable always multicast.
PAGE 386
VIVOTEK PARAMETER © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) audioconfiguration_so c<0~(n-1)>s0 1/6 urce * n denotes the value of "capability_naudioin" DESCRIPTION The audioconfiguration source for the profile. Ex. audioconfiguration_source= c<0~(n-1)>s0 indicates audio stream of 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:///cgi-bin/dido/setdo.cgi?do1= [&do2=] [&do3=][&do4=] 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: \r\n \r\n [di0=]\r\n [di1=]\r\n [di2=]\r\n [di3=]\r\n where 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 Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n di1=1\r\n 8.
PAGE 389
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved [do1=]\r\n [do2=]\r\n [do3=]\r\n where 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. Method: GET/POST Syntax: http:///cgi-bin/viewer/video.
PAGE 390
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION quality 1~5 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. The size and quality of the image will be set according to the video settings on the server. Return: HTTP/1.0 200 OK\r\n Content-Type: image/jpeg\r\n [Content
PAGE 391
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK PARAMETER VALUE DESCRIPTION username The name of the user to add, delete, or edit. userpass The password of the new user to add or that of the old user to modify. The default value is an empty string. privilege view The privilege of the user to add or to modify. “view”: Viewer privilege. “operator”: Operator privilege. “admin”: Administrator privilege.
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:///cgi-bin/camctrl/eCamCtrl.
PAGE 393
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK 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 y movement w The scaled area size h resolution The resolution of streaming. vx The direction of movement, used for joystick control. vy vs 0~7 Set the speed of movement, “0” means stop. x x-coordinate clicked by user. It will be the x-coordinate of center after movement. y y-coordinate clicked by user.
PAGE 395
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK 8.8 ePTZ Recall (capability_eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http:///cgi-bin/camctrl/eRecall.cgi?channel=&stream=& recall=[&return=] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source. stream <0~(m-1)> Stream. recall Text string less than 40 characters One of the present positions to recall.
PAGE 396
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION addpos delpos return Redirect to the page after the parameter is assigned. The should be the relative path according to the root of camera. If you omit this parameter, it will redirect to an empty page.
PAGE 397
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK Syntax: http:///cgi-bin/operator/uartchannel.cgi?[channel=] ------------------------------------------------------------------------GET /cgi-bin/operator/uartchannel.cgi?[channel=] x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------POST /cgi-bin/operator/uartchannel.
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.
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:///_accessname> For RTSP (MP4), the user needs to input theURL below into an RTSP compatible player. rtsp:///_accessname> “m” is the stream number. For details on streaming protocol, please refer to the “control signaling” and “data format” documents. 8.
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: \r\n \r\n \r\n Where hexadecimal data is digits from 0 ~ 9, A ~ F. 8.16 Storage Managements (capability_stroage.dbenabled > 0) Note: This request requires administrator privileges. Method: GET and POST Syntax: http:///cgi-bin/admin/lsctrl.
PAGE 401
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK PARAMETER VALUE DESCRIPTION destPath Optional. Indicate the file location in camera. Please embrace your input value with single quotes. Ex. destPath =’/mnt/auto/CF/NCMF/abc.mp4’ resolution Optional. Indicate the media file resolution. Please embrace your input value with single quotes. Ex. resolution=’800x600’ isLocked Optional. Indicate if the file is locked or not. 0: file is not locked. 1: file is locked.
PAGE 402
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http:///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 Required. Identify the designated record. Ex. label=1 Ex. Delete records whose key numbers are 1, 4, and 8. http:///cgi-bin/admin/lsctrl.
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:///cgi-bin/admin/setvi.cgi?vi0=[&vi1=][&vi2=] [&return=] PARAMETER VALUE DESCRIPTION vi state[(duration)nstate] Where "state" is 0, 1. “0” means inactive or normal state while “1” means active or triggered state. Where "nstate" is next state after duration.
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_s_allow=1) Note: This request requires Viewer access privileges.
PAGE 405
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK PARAMETER VALUE DEFAULT DESCRIPTION reftime mm:ss The time camera receives the request. Reference time for maxsft and minsft. (This provides more precise time control to eliminate the inaccuracy due to network latency.) Ex: Request the streaming from 12:20 rtsp://10.0.0.1/live.sdp?maxsft=10&reftime=12:30 forcechk N/A N/A Check if the requested stream enables timeshift, feature and if minsft is achievable.
PAGE 406
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function Function type zoom - Move focus motor focus – Move focus motor auto – Perform auto focus scan – Perform focus scan stop – Stop current operation positioning – Position the motors irisopen – Fully open iris. It will maintain fully open iris status until sending function=irisenable cgi. irisenable – return back to user setting status of iris.
PAGE 407
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION direction direct, forward, backward Motor’s moving direction. It works only if function=zoom or function=focus. position 0~ Motor’s position. It works only if function=zoom or function= focus and direction=direct. is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from "function=getstatus" steps 1 ~ Motor’s moving steps.
PAGE 408
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function focus, auto, scan, stop, positioning, irisopen, irisenable, resetfocus, getstatus Function type focus – Move focus motor auto – Perform auto focus scan – Perform focus scan stop – Stop current operation positioning – Position the motors resetfocus – reset focus position to default irisopen – Fully open iris. It will maintain fully open iris status until sending function=irisenable cgi.
PAGE 409
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION position 0~ Motor’s position. It works only if function=focus and direction=direct. is refer to remote_focus_focus_motor_max which replied from "function=getstatus" steps 1 ~ 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:///cgi-bin/admin/upload_dst.cgi Post data: filename =\r\n \r\n For language file: http:///cgi-bin/admin/upload_lan.cgi Post data: filename =\r\n \r\n For setting backup file: http:///cgi-bin/admin/uploa
PAGE 411
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK Syntax: For list a name of lens currently used: http:///cgi-bin/admin/update_lens.cgi?get_currentlens For list all names of lens installed in camera: http:///cgi-bin/admin/update_lens.cgi?list_lens For choose selected lens configuration: http:///cgi-bin/admin/update_lens.cgi?choose_lens= 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:///mod.sdp?[&stime=][&etime=][&length =][&loctime =][&file=][&tsmode=] PARAMETER VALUE DEFAULT DESCRIPTION stime N/A Start time.
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:///cgi-bin/admin/setpm3d.
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:///cgi-bin/camctrl/camctrl.
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. speedfocus -5 ~ 5 Set the focus speed. speedapp -5 ~ 5 Set the auto pan/patrol speed. auto pan Auto pan. patrol Auto patrol. stop Stop camera. wide Zoom larger view with current speed.
PAGE 416
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION focus auto Auto focus. far Focus on further distance. near Focus on closer distance. 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. focusseting * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20.
PAGE 417
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION getpanangle Get the current pan angle. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" gettilt 0, Get the current tilt position. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" gettiltangle getzoom 0, Get the current zoom position.
PAGE 418
VIVOTEK PARAMETER © 2020 VIVOTEK INC. All Right Reserved VALUE DESCRIPTION "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmintiltangle Get the lower limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmaxtiltangle Get the upper limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getminzoom 0, Get the lower limit for zoom position.
PAGE 419
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK 8.28 Preset Locations (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Operator privileges. Method: GET/POST Syntax: http:///cgi-bin/operator/preset.cgi?[channel=] [&addpos=][&delpos=][&return=] 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 smartsd_lifetime_rate: The ratio of smartsd_lifetime_num to smartsd_lifetime_den. It means the accumulated percentage amount of flash block has been written.
PAGE 421
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK Syntax: http:///cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION N/A N/A Apply the wireless settings and connect to AP. 8.31 Get Wireless Information (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/getwirelessinfo.cgi PARAMETER VALUE DESCRIPTION N/A N/A Get wireless information. Camera will return following information. 1.
PAGE 422
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION N/A N/A Get wireless signal strength. 8.33 WPS Transaction (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/start_wps.cgi PARAMETER VALUE DESCRIPTION N/A N/A Start WPS transaction. 8.34 Peripheral Control (capability_peripheral_c<0~(n-1)>_ devicecontrol > 0) Note: This request requires Administrator privileges.
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. on Enable the functionality of washer control washer_status system. off Disable the functionality 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 N/A 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:///cgi-bin/admin/optimizedir.cgi?function=[&channel=] PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. function getstatus, onetimeauto "onetimeauto": Camera will automatically adjust the IR 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:///cgi-bin/admin/optimizedir.
PAGE 427
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK 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
PAGE 428
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http:///cgi-bin/admin/optimizedir.cgi?channel=&operation=get [&support_irmode] – list all adjustment mode that IR supports [&irmode] – Get current IR mode [&irnum] – Get the number of IR zone PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. support_irmode N/A List all adjustment mode that IR supports irmode N/A Get the current IR control mode.
PAGE 429
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved \r\n OK 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
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 Syntax: (for control API) http:///cgi-bin/admin/audioclip.
PAGE 431
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved clipname 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:///cgi-bin/admin/format_sdcard.cgi?operation=set[&=] 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: \r\n \r\n Syntax: (for query API) http:///cgi-bin/admin/ format_sdcard.cgi?operation=get PARAMETER VALUE Get 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 Methods for Accessing Streaming 8.39.1 Get Stream URI (capability_media_streamprofiles_support = 1) Note: This request requires Viewer access privileges. Syntax: For RTSP, the user needs to input the URL below into a RTSP compatible player. rtsp://:/media2/stream.
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. Note: 1. This method is only valid when always multicast is enabled, i.e. streamprofile_i_alwaysmulticast=1. 2.
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. 5946651; 6199035. VOICEAGE CORPORATION: AT PAT. 0516621; BE PAT. 0516621; CA PAT. 2010830; CH PAT. 0516621; DE PAT. 0516621; DK PAT. 0516621; ES PAT. 0516621; FR PAT. 0516621; GB PAT.
PAGE 436
VIVOTEK Electromagnetic Compatibility (EMC) FCC Statement This device compiles with FCC Rules Part 15. Operation is subject to the following two conditions. ■ This device may not cause harmful interference, and ■ This device must accept any interference received, including interference that may cause undesired operation. This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of the FCC Rules.