User Manual

ManualsBrandsVivotek ManualsSecurity CamerasS Series 6MP Outdoor Network Fisheye Dome Camera

Table Of Contents

User’s Manual

FE9382-EHV-v2

Fisheye

Network Camera

5MP • Vandal-proof • 360º Surround View • Smart IR 10/20m

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

FE9380-HV

Rev. 1.0

Summary of content (352 pages)

PAGE 1
FE9380-HV FE9382-EHV-v2 Fisheye Network Camera User ’s Manual 5MP • Vandal-proof • 360º Surround View • Smart IR 10/20m Smart Stream III • Pixel Calculator • PoE • IP66 • WDR Pro Rev. 1.
PAGE 2
VIVOTEK Table of Contents Overview �� 4 Revision History �� 4 Read Before Use ��
PAGE 3
VIVOTEK Network > QoS (Quality of Service) �� 104 Network > SNMP (Simple Network Management Protocol) �� 106 Network > FTP �� 107 Bonjour ��
PAGE 4
VIVOTEK Overview VIVOTEK’s FE9380 and FE9382 are two H.265 fisheye fixed dome network cameras, both featuring a detailed 5-Megapixel CMOS sensor that produces superb image clarity. By employing H.265 compression technology and VIVOTEK’s Smart Stream III technology, these cameras can reduce both bandwidth and storage consumption by up to 80%* while retaining the highest standard of image quality.
PAGE 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 hole 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 with 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 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 26
VIVOTEK Dry contact and using camera’s DO+ to supply a relay.
PAGE 27
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 28
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 29
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 90 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 112 for details.
PAGE 30
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 31
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 with the camera using a 64-bit IE browser. • If you encounter this problem, try execute the Iexplore.exe program from C:\Windows\ SysWOW64.
PAGE 32
VIVOTEK NOTE: For Mozilla Firefox users, your browser will use Quick Time 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 33
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 109. 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 34
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 35
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 27. To utilize this feature, please check the following settings on your Network Camera: 1.
PAGE 36
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 37
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 http://www.vivotek.com. Tips: 1.
PAGE 38
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 Resize Buttons Configuration Area 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 39
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 40
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 41
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 42
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 43
VIVOTEK Video Stream: This Network Camera supports multiple streams (stream #1 ~ #4) simultaneously. You can select any one of them for live viewing. For more information about multiple streams, please refer to page 79 for detailed information. 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. For more information about event setting, please refer to page 127.
PAGE 44
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 49.
PAGE 45
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 46
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 79. H.264 Protocol and Media Options: The transmission protocol (TCP or UDP, etc.)and media options for H.265 or H.
PAGE 47
VIVOTEK Start MP4 Recording: Click this button to record video clips in MP4 file format to your computer. Press the Stop MP4 Recording button to end recording. When you exit the web browser, video recording stops accordingly. To specify the storage destination and file name, please refer to MP4 Saving Options on page 50 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 48
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 49
VIVOTEK Client Settings This chapter explains how to select the stream transmission mode and saving options on the local computer. When completed with the settings on this page, click Save on the page bottom to enable the settings. H.265 / H.264 Media Options Select to stream video or audio data or both. This is enabled only when the video mode is set to H.265 or H.264. H.265 / H.
PAGE 50
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 51
VIVOTEK Joystick settings Enable Joystick Connect a joystick to a USB port on your management computer. Supported by the plug-in (Microsoft’s DirectX), once the plug-in for the web console is loaded, it will automatically detect if there is any joystick on the computer. The joystick should work properly without installing any other driver or software. Then you can begin to configure the joystick settings of connected devices. Please follow the instructions below to enable joystick settings. 1.
PAGE 52
VIVOTEK Buttons Configuration Click the Configure Buttons button, a window will prompt as shown below. Please follow the steps below to configure your joystick buttons: 1. Select a button number from the Button # pull-down menu. Tips If you are not sure of the locations of each button, use the Properties window in the Game Controllers utility. 2. Select a corresponding action, such as Patrol or Preset#. 3. Click the Assign button to assign an action to the button.
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. VIVOTEK provides an easy-to-use user interface that helps you set up your network camera with minimal effort. In order to simplify the user interface, detailed information will be hidden unless you click on the function item.
PAGE 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 filed. 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 90). 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. Smart IR Anti-overexposure: When enabled, the camera automatically adjusts the IR projection to adjacent objects in order to avoid over-exposure in the night mode. 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.
PAGE 70
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 73 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 71
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 72
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 73
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 74
VIVOTEK The inclusive window refers to the “weighted window“; the exclusive window refers to the “ignored window.“ It adopts the weighed 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 75
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 76
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 77
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 78
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 79
VIVOTEK Media > Video Mode When the WDR Pro feature is enabled, the maximum frame rate will be reduced to 24fps. 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 80
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 81
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 82
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 83
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 84
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 85
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 86
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 87
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 88
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 89
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 90
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 91
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 92
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 93
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 94
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 95
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 96
VIVOTEK Network > Streaming protocols HTTP streaming To utilize HTTP authentication, make sure that your have set a password for the Network Camera first; please refer to Security > User account on page 109 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 97
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 98
VIVOTEK Authentication: Depending on your network security requirements, the Network Camera provides three types of security settings for streaming via RTSP protocol: disable, basic, and digest. 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 99
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 100
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 101
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 102
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 103
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 104
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 105
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 106
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 107
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 108
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 109
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 110
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 111
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 112
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 113
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 114
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 115
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 116
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 117
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 118
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 Quick Time Player).
PAGE 119
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 Quick Time 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 120
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 121
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 122
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 123
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 124
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 125
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 126
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 127
VIVOTEK Event > Event settings This section explains how to configure the Network Camera to respond to particular situations (event). A typical application is that when a motion is detected, the Network Camera sends buffered images to an FTP server or e-mail address as notifications. Click on Help, there is an illustration shown in the pop-up window explaining that an event can be triggered by many sources, such as motion detection or external digital input devices.
PAGE 128
VIVOTEK ■ Event name: Enter a name for the event setting. ■ Enable this event: Select this checkbox to enable the event setting. ■ Priority: Select the relative importance of this event (High, Normal, or Low). Events with a higher priority setting will be executed first. ■ Detect next motion detection or digital input after seconds: Enter the duration in seconds to pause motion detection after a motion is detected. This prevents too many events to be triggered within a short time.
PAGE 129
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 130
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 131
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 132
VIVOTEK To verify if the email settings are correctly configured, click Test. The result will be shown in a pop-up window. If successful, you will also receive an email indicating the result. Click Save server to enable the settings, 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 133
VIVOTEK ■ Passive mode Most firewalls do not accept new connections initiated from external requests. If the FTP server supports passive mode, select this option to enable passive mode FTP and allow data transmission to pass through the firewall. 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 134
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 153 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 156 for detailed information.
PAGE 135
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 136
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 137
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 138
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 156. 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 139
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 140
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 only when the server setting is not being applied to an event setting can it be deleted.
PAGE 141
VIVOTEK Applications > Motion detection This section explains how to configure the Network Camera to enable motion detection. A total of 5 motion detection windows can be configured. Motion Detection Setting 2: For special situations Motion Detection Setting 1: For normal situations Follow the steps below to enable motion detection: Follow the steps below to enable motion detection: 1. Click New to add a new motion detection window. 2.
PAGE 142
VIVOTEK Photos or videos can be captured instantly and configured to be sent to a remote server (via an Email or FTP server). For more information on how to configure an event setting, please refer to Event settings on page 127. A green bar indicates that even though motions have been detected, the event has not been triggered because the image variations still fall under the preset threshold. Larger than the min.
PAGE 143
VIVOTEK This motion detection window will also be displayed on the Event Settings page. You can go to Event > Event settings > Trigger to select it as a trigger source. Please refer to page 127 for detailed information. NOTE: ► How does motion detection work? A C Min. item size Alerted pixels < Min. item size B D Min. item size Alerted pixels > Min. item size There are two motion detection parameters: Sensitivity and Min. Item Size.
PAGE 144
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 145
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 146
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 147
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 148
VIVOTEK Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) 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. • Once the software package is successfully uploaded, the module configuration (vadp.xml) information is displayed.
PAGE 149
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 150
VIVOTEK On the License page, register and activate the license for using VIVOTEK's VADP modules. You should acquire the license key elsewhere, and manually upload to the network camera. Follow the onscreen instruction on VIVOTEK's website for the registration procedure.
PAGE 151
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 156 for detailed information. Recording Settings Click Add to open the recording setting window.
PAGE 152
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 79 for more information.
PAGE 153
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 154
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. ■ Capacity: You can either choose the entire available space or impose a reserved space. The Reserved space should be of the size of at least 15MBytes.
PAGE 155
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 156
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 157
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 158
VIVOTEK 2. Click Test to check the setting. The result will be shown in the pop-up window. If successful, you will receive a test.txt file on the networked storage server. 3. Click Mount to complete the settings. NAS control ■ Minimum reserved storage space: The reserved space can be used as a safe buffer especially when the cyclic recording function is enabled, during the transaction stage when a storage space is full and the incoming streaming data is about to overwrite the previously saved videos.
PAGE 159
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 160
VIVOTEK Search Results The following is an example of search results. There are four columns: Trigger time, Media type, Trigger type, and Locked. Click to sort the search results in either direction. Numbers of entries displayed on one page Click to open a live view ■ 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 161
VIVOTEK ■ Lock/Unlock: Select the checkbox in front of a desired search result, then click this button. The selected items will become Locked, which will not be deleted during cyclic recording. You can click again to unlock the selections. For example: Click to switch pages ■ Remove: Select the desired search results, then click this button to delete the files.
PAGE 162
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 163
VIVOTEK 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. Syntax: http:///cgi-bin/[/...]/.
PAGE 164
VIVOTEK 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.cgi?[] [&…] Where the should be [_] or [.].
PAGE 165
VIVOTEK Example: Request IP address and its response Request: 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 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http:///cgi-bin/anonymous/setparam.
PAGE 166
VIVOTEK (Note: The return page can be a general HTML file(.htm, .html) or a VIVOTEK server script executable (.vspx) file. It cannot be a CGI commandor have any extra parameters.This parameter must be placed at the end of the parameter list Return: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: \r\n \r\n where is =\r\n [] Only the parameters that you set and are readable will be returned.
PAGE 167
VIVOTEK 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 168
VIVOTEK W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 NOTE: The camera should not be restarted when parameters are changed.
PAGE 169
VIVOTEK 7.1system Group: system NAME VALUE SECURITY DESCRIPTION (get/set) hostname string[64] 1/6 Host name of server (Network Camera, Wireless Network Camera, Video Server, Wireless Video Server). ledoff 6/6 Turn on (0) or turn off (1) all led indicators. date , 6/6 Current date of system. Set to ‘keep’ to keep time datetime keep, date unchanged. Set to ‘auto’ to use NTP to auto synchronize date. , 6/6 Current time of the system.
PAGE 170
VIVOTEK -140: GMT-03:30 Newfoundland -120: GMT-03:00 Brasilia, Buenos Aires, Georgetown, Greenland -80: GMT-02:00 Mid-Atlantic -40: GMT-01:00 Azores, Cape_Verde_IS.
PAGE 171
VIVOTEK Caledonia 480: GMT 12:00 Aucklan, Wellington, Fiji, Kamchatka, Marshall Is. 520: GMT 13:00 Nuku'Alofa daylight_enable 6/6 Enable automaticdaylight saving time in time zone. daylight_dstactualmode 6/7 Check if current time is under daylight saving time. (Used internally) daylight_auto_begintime string[19] 6/7 Display the current daylight saving start time. daylight_auto_endtime string[19] 6/7 Display the current daylight saving end time.
PAGE 172
VIVOTEK 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. restoreexceptvadp 0, 7/6 Restore the system parameters to default values except the vadp parameters and VADP modules that stored in the system. This command can cooperate with other “restoreexceptXYZ” commands.
PAGE 173
VIVOTEK 7.1.1 system.info Subgroup of system: info (The fields in this group are unchangeable.) NAME VALUE SECURITY DESCRIPTION (get/set) 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). If it is not an ODM model, this field will be equal to “modelname” serialnumber 0/7 12 characters MAC address (without hyphens).
PAGE 174
VIVOTEK xcount-1)> 7.2status Group: status NAME VALUE SECURITY DESCRIPTION (get/set) di_i<0~(capability_ndi-1)> 1/7 0 => Inactive, normal 1 => Active, triggered (capability.ndi > 0) do_i<0~(capability_ndo-1)> 1/7 0 => Inactive, normal 1 => Active, triggered (capability.ndo > 0) onlinenum_rtsp 0,
PAGE 175
VIVOTEK 7.5security Group: security NAME VALUE SECURITY DESCRIPTION (get/set) privilege_do view, operator, 1/6 admin Indicate which privileges and above can control digital output (capability.ndo > 0) privilege_camctrl view, operator, 1/6 admin Indicate which privileges and above can control PTZ (capability.ptzenabled > 0 or capability.
PAGE 176
VIVOTEK 7.6network Group: network NAME VALUE SECURITY DESCRIPTION (get/set) preprocess 6/6 An 32-bit integer, each bit can be set separately as follows: Bit 0 => HTTP service; Bit 1=> HTTPS service; Bit 2=> FTP service; Bit 3 => Two way audio and RTSP Streaming service; To stop service before changing its port settings. It’s recommended to set this parameter when change a service port to the port occupied by another service currently. Otherwise, the service may fail.
PAGE 177
VIVOTEK dns2 6/6 Secondary DNS server. wins1 6/6 Primary WINS server. wins2 6/6 Secondary WINS server. 7.6.1 802.1x Subgroup of network: ieee8021x (capability.protocol.ieee8021x > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable/disable IEEE 802.
PAGE 178
VIVOTEK 7.6.2 QOS Subgroup of network: qos_cos (capability.protocol.qos.cos > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable/disable CoS (IEEE 802.1p) vlanid 1~4095 6/6 VLAN ID video 0~7 6/6 Video channel for CoS audio 0~7 6/6 Audio channel for CoS (capability.
PAGE 179
VIVOTEK 7.6.4 FTP Subgroup of network: ftp NAME VALUE SECURITY DESCRIPTION (get/set) port 21, 1025~65535 6/6 Local ftp server port. VALUE SECURITY DESCRIPTION 7.6.5 HTTP Subgroup of network: http NAME (get/set) port 80, 1025 ~ 65535 1/6 HTTP port. alternateport 1025~65535 6/6 Alternate HTTP port. authmode basic, 1/6 HTTP authentication mode. 1/6 Http server push access name for stream N, digest s<0~(capability_nmediast string[32] ream-1)>_accessname N= 1~ capability.
PAGE 180
VIVOTEK 7.6.7 RTSP Subgroup of network: rtsp (capability.protocol.rtsp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 554, 1025 ~ 65535 1/6 RTSP port. (capability.protocol.rtsp=1) anonymousviewing 1/6 Enable anoymous streaming viewing. authmode disable, 1/6 RTSP authentication mode. basic, (capability.protocol.rtsp=1) digest s<0~(capability_nmediast string[32] 1/6 RTSP access name for stream N, N= 1~ ream-1)>_accessname capability.nmediastream.
PAGE 181
VIVOTEK 7.6.8 SIP port Subgroup of network: sip (capability.protocol.sip> 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 1025 ~ 65535 1/6 SIP port. VALUE SECURITY DESCRIPTION 7.6.9 RTP port Subgroup of network: rtp NAME (get/set) videoport 1025 ~ 65535 6/6 Video channel port for RTP. (capability.protocol.rtp_unicast=1) audioport 1025 ~ 65535 6/6 Audio channel port for RTP. (capability.protocol.rtp_unicast=1) metadataport 1025 ~ 65535 6/6 Metadata channel port for RTP. 7.6.
PAGE 182
VIVOTEK 7.7IP Filter Group: ipfilter NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable access list filtering. admin_enable 6/6 Enable administrator IP address. admin_ip string[43] 6/6 Administrator IP address. maxconnection 1~10 6/6 Maximum number of concurrent streaming connection(s). type 0, 1 6/6 Ipfilter policy : 0 => allow 1 => deny ipv4list_i<0~9> Single address:
PAGE 183
VIVOTEK 7.8Video input Group: videoin NAME VALUE SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 4/4 CMOS frequency. (capability.videoin.type=2) whitebalance auto, 4/4 manual, "auto": Auto white balance rbgain, "rbgain": Use rgain and bgain to set white widerange, balance manually. outdoor, "manual": 2 cases: indoor, Modes of white balance. a. if "rbgain" is not supported, this means sodiumauto, keep current white balance status. etc b.
PAGE 184
VIVOTEK 8: EV +0.7 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.0 irismode fixed, indoor, 4/4 Control DC-Iris mode. outdoor "outdoor": Auto-setting DC-Iris to get best in indoor environment. "indoor": Avoid rolling and flicker effect first. "fixed": Open the iris to maximum. * Only available when "capability_image_c_iristype"=dciris enableblc 4/4 Enable backlight compensation.
PAGE 185
VIVOTEK Bit 5 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only) text string[64] 1/4 Enclose caption. imprinttimestamp 4/4 Overlay time stamp on video. minexposure <1~32000>, 4/4 Minimum exposure time <5~32000>, 1~32000 => 1s ~ 1/32000s <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc. 5~8000 => 1/5s ~ 1/8000s etc.
PAGE 186
VIVOTEK "capability_image_c_exposure_rangetyp e" is "twovalues". enablepreview 1/4 Usage for UI of exposure settings. Preview settings of video profile. 7.8.1 Video input setting per channel Group: videoin_c<0~(n-1)> for n channel products, and m is stream number n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" NAME VALUE SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 4/4 CMOS frequency. (capability.videoin.
PAGE 187
VIVOTEK 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c_wbmode". * Only valid when "videoin_c_whitebalance" != auto * Normalized range. bgain 0~100 4/4 Manual set bgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c_wbmode". * Only valid when "videoin_c_whitebalance" != auto * Normalized range.
PAGE 188
VIVOTEK "capability_image_c_exposure_m Gain. odetype") "irispriority": Adjust with variable Iris, auto Gain and Shutter speed. "manual": Adjust with variable Shutter, Iris and Gain. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. 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.
PAGE 189
VIVOTEK ortype" is "smartsensor" * Only available when "capability_image_c_iristype"=pi ris enableblc 4/4 Enable backlight compensation when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c_mode" to switch on/off BLC. maxgain 0~100 4/4 Maximum gain value.
PAGE 190
VIVOTEK * Only available when "capability_image_c_agc_maxgai n" != "-" and "capability_image_c_exposure_ra ngetype" 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 flip 4/4 Flip the image. mirror 4/4 Mirror the image. rotate 0,90,180,270 1/4 The rotation angle of image. Support only in Rotation mode (capability.videoin.c.
PAGE 191
VIVOTEK textonvideo_fon /usr/share/font/Default.ttf, tpath /mnt/flash2/upload.ttf 4/4 Choose camera default font file (/usr/share/font/Default.ttf) or user uploaded font file(/mnt/flash2/upload.ttf). textonvideo_upl Depends on the font file name 1/7 Show the uploaded font file name.
PAGE 192
VIVOTEK * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c_exposure_ra ngetype" is "twovalues". shuttervalue <1~32000>, 4/4 Exposure time , 1~32000 => 1s ~ 1/32000s dependent> <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc. 5~8000 => 1/5s ~ 1/8000s etc.
PAGE 193
VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0302a. s<0~(m-1)>_e 4/4 nableeptz Indicate whether stream supprts eptz or not s<0~(m-1)>_c Listed at "capability_videoin_codec" odectype Possible values are: mjpeg, h264,h265 1/4 Codec type for this stream 1/4 Video resolution in pixels. 4/4 Enable "Dynamic intra frame period".
PAGE 194
VIVOTEK directly. * Only valid when "ratecontrolmode"= vbr and s<0~(m-1)>_h264_quant = 99. s<0~(m-1)>_h 1~100 4/4 264_qpercent Select customized quality in a normalized full range. 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"= vbr and "quant"= 100. s<0~(m-1)>_h 20000~"capability_videoin_c_h2 264_maxvbrbitr 64_maxbitrate" 4/4 The maximum allowed bit rate in fixed quality mode. When the bit rate exceeds this value, ate frames will be dropped to restrict the bit rate.
PAGE 195
VIVOTEK cbr and "quant"= 100. * Only available when "capability_smartstream_version"=2. 0 s<0~(m-1)>_h 20000~"capability_videoin_c_h2 264_bitrate 64_maxbitrate" 4/4 The target bit rate in constant bit rate mode.
PAGE 196
VIVOTEK * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_h 1~5, 265_quant 99, 100 4/4 Set the pre-defined quality level: 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue" * Only available when h265 is listed in "capability_videoin_codec" and "ratecontrolmode"= vbr. s<0~(m-1)>_h 0~51 4/4 265_qvalue Manual video quality level input. The Q value which is used by encoded library directly.
PAGE 197
VIVOTEK * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= vbr s<0~(m-1)>_h 1~5, 100 4/4 265_cbr_quant Set the pre-defined quality level: 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only available when h265 is listed in "capability_videoin_codec" and "ratecontrolmode"= cbr. * Only available when "capability_smartstream_version"="2 .
PAGE 198
VIVOTEK 265_prioritypoli cy * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= cbr s<0~(m-1)>_h 1~"capability_videoin_c_h265_m 265_maxframe axframerate" 1/4 The maximum frame rates of a H265 stream at different resolutions("capability_videoin_c0_re solution ") are recorded in "capability_videoin_c_h265_maxf ramerate" * Only available when h265 is listed in "capability_videoin_codec".
PAGE 199
VIVOTEK ex: 0301a_1) * Only valid when "ratecontrolmode"= or 1~99 vbr and s<0~(m-1)>_mjpeg_quant = (Only valid when 99 "capability_api_httpversion" format is XXXXX_2, ex: 0301a_2) s<0~(m-1)>_m 1~100 4/4 jpeg_qpercent Select customized quality in a normalized full range. 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"= vbr and s<0~(m-1)>_mjpeg_quant = 100.
PAGE 200
VIVOTEK 100: Best quality * Only valid when "ratecontrolmode"= cbr and "quant"= 100. * Only available when "capability_smartstream_version"="2 .0" s<0~(m-1)>_m 20000~"capability_videoin_c_mj jpeg_bitrate peg_maxbitrate" 4/4 The target bit rate in constant bit rate mode.
PAGE 201
VIVOTEK * Only available when "capability_image_c_wdrc_mode " is 1 aespeed_mode 4/4 Turning AE converge speed on or off. 1: on * Only available when "capability_image_c_aespeed" is 1 aespeed_speedl 1~100 4/4 The speed level of AE converge speed. evel 1~20: level 1 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 202
VIVOTEK mounttype ceiling, wall, floor 1/6 wall mount: 180° panoramic view without blind spots floor mount: 360° surround view without blind spots * Only available when "capability_fisheye" > 0 enablewatermar 0, 1 1/6 k 0: Not to add watermarks on images 1: Add watermarks on images * Only available when "capability_fisheye" > 0 s<0~(m-2)>_fi ‘1O, 1P, 2P, 1R, 4R’ for ceiling/floor sheyedewarpmo mount “1O” is original
PAGE 203
VIVOTEK of non-interest (non-ROI) of the display image. If the value is a positive number, the video quality of ROI is better than the non-ROI areas. The level is from 1 to 5. Level 5 is the maximum level of the quality difference between the ROI and non-ROI areas. If the value is a negative number, the video quality of non-ROI areas is better than the ROI. The level is from -1 to -5. Level -5 is the maximum level of the quality difference between the ROI and non-ROI areas.
PAGE 204
VIVOTEK 7.8.1.1 Alternative video input profiles per channel In addition to the primary setting of video input, there can be alternative profile video input setting for each channel which might be for different scene of light (daytime or nighttime). Group: videoin_c<0~(n-1)>_profile_i<0~(m-1)> for n channel profucts and m profile n denotes the value of "capability_nvideoin" and m denotes the value of "capability_nvideoinprofile" (capability.
PAGE 205
VIVOTEK * Available value is listed in * This parameter may also restrict image "capability_image_c frame rate from sensor due to sensor _exposure_ma generates a frame per exposure time. Ex: If xrange" this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.
PAGE 206
VIVOTEK * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c_mode" to switch on/off BLC. exposurelevel 0~12 4/4 Exposure level "0,12": This range takes the concept 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 207
VIVOTEK widerange, balance manually. outdoor, "manual": 2 cases: indoor, a. if "rbgain" is not supported, this means sodiumauto, keep current white balance status. etc b. if "rbgain" is supported, "rgain" and "bgain" are updated to the current values (Available values are which is got from white balance module. Then, listed in act as rbgain mode "capability_image_c "widerange": Auto Tracing White balance _wbmode") (2000K to 10000K).
PAGE 208
VIVOTEK "irismode"=fixed * Normalized range. * Only available when "capability_image_c_exposure_rangetyp e" is "twovalues". mingain 0~100 4/4 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c_agc_mingain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c_exposure_rangetyp e" is "twovalues". gainvalue 0~100 4/4 Gain value.
PAGE 209
VIVOTEK "capability_image_c_iristype"=piris piris_position 1~100 1/4 Manual set P-Iris. 1: Open <-> 100: Close * Only vaild when "piris_mode"=manual or "capability_image_c<0~(n-1)>_sensortype" is "smartsensor" * Only available when "capability_image_c_iristype"=piris irismode fixed, indoor, 4/4 Control DC-Iris mode. outdoor "outdoor": Auto-setting DC-Iris to get best in indoor environment.
PAGE 210
VIVOTEK "capability_image_c_aespeed" is 1 aespeed_speedlevel 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. * Only available when "capability_image_c_aespeed" is 1 aespeed_sensitivity 1~100 4/4 The sensitivity of AE converge speed.
PAGE 211
VIVOTEK 7.10 IR cut control Group: ircutcontrol (capability.
PAGE 212
VIVOTEK 7.11 Image setting per channel Group: image_c<0~(n-1)> for n channel profucts and m profile n denotes the value of "capability_nvideoin" and m denotes the value of "capability_nvideoinprofile" NAME VALUE SECURITY DESCRIPTION (get/set) brightness -5~5,100 4/4 -5: Darker <-> 5: Bright 100: Use " image_c_brightnesspercent" * Only available when bit 0 of "capability_image_c_basicsetting" is 1 * We replace "brightness" with "brightnesspercent".
PAGE 213
VIVOTEK sharpness -3~3,100 4/4 -3: Softer <-> 3: Sharper 100: Use " image_c_sharpnesspercent" * Only available when bit 3 of "capability_image_c_basicsetting" is 1. * We replace "sharpness" with "sharpnesspercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. brightnesspercent 0~100 4/4 Set brightness in the normalized range.
PAGE 214
VIVOTEK Internal module will take the closest valid one. For example, 1~45 may all be mapped to gamma value = 0.45, etc. lowlightmode 4/4 Enable/disable low light mode. * Only available when "capability_image_c_lowlightmode" is 1 dnr_mode 4/4 3D noise reduction.
PAGE 215
VIVOTEK 1: enable * Only available when "capability_image_c_scenemode_support " is 1 scene_mode visibility, 4/4 Value of scene mode noiseless, * Only available when lpcparkinglot, "capability_image_c_scenemode_support lpcstreet " is 1 "capability_image_c_scenemode_support type" restoreatwb 1~ 4/4 Restore of adjusting white balance of image according to mode settings freeze 4/4
PAGE 216
VIVOTEK * Only available when bit 1 of "capability_image_c_basicsetting" is 1. * We replace "profile_i0_contrast" with "profile_i0_contrastpercent ". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. profile_i<0~(m-1)>_saturation -5~5,100 4/4 -5: Less saturation <-> 5: More saturation 100: Use " image_c_saturationpercent" * Only available when bit 2 of "capability_image_c_basicsetting" is 1.
PAGE 217
VIVOTEK profile_i<0~(m-1)>_saturation 0~100 4/4 percent Set saturation in the normalized range. 0: Less saturation <-> 100: More saturation * Only available when bit 2 of "capability_image_c_basicsetting" is 1. profile_i<0~(m-1)>_sharpness 0~100 4/4 percent Set sharpness in the normalized range. 0: Softer <-> 100: Sharper * Only available when bit 3 of "capability_image_c_basicsetting" is 1 profile_i<0~(m-1)>_gammacur 0~100 4/4 ve 0: Fine-turned gamma curve by Vivotek.
PAGE 218
VIVOTEK profile_i<0~(m-1)>_eis_mode "capability_image_c_defog_mode" is 1 4/4 Electronic image stabilizer 0:disable 1:enable * Only available when 'eis' is listed in "capability_image_c_is_mode". profile_i<0~(m-1)>_eis_streng 1~100 4/4 Strength of electronic image stabilizer th * Only available when 'eis' is listed in "capability_image_c_is_mode".
PAGE 219
VIVOTEK 7.12 Exposure window setting per channel Group: exposurewin_c<0~(n-1)> for n channel profucts n denotes the value of "capability_nvideoin" (Only available when "capability_image_c_exposure_mode"=1) NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, custom,blc 4/4 "auto": Use full image view as the only exposure window. * Available values are listed in "custom": Use custom windows.
PAGE 220
VIVOTEK sizepx <0~Wx0~ H> 4/4 Width and height of the window. W: 0~ The current image width -1 * Only available when px is listed in H: 0~ The current image height -1 "capability_image_c_exposure_windomai n". homestd <0~9999,0~9999> 4/4 Left-top corner coordinate of the window. * Only available when std is listed in "capability_image_c_exposure_windomai n". sizestd <0~9999x0~9999> 4/4 Width and height of the window.
PAGE 221
VIVOTEK * Only available when exclusive is listed in "capability_image_c_exposure_wintype". home <0~320,0~240> 4/4 Left-top corner coordinate of the window. * Only available when qvga is listed in "capability_image_c_exposure_windomai n". size <0~320x0~240> 4/4 Width and height of the window. * Only available when qvga is listed in "capability_image_c_exposure_windomai n". homepx <0~W,0~H> 4/4 Left-top corner coordinate of the window.
PAGE 222
VIVOTEK 7.13 Audio input per channel Group: audioin_c<0~(n-1)> for n channel products (capability.naudioin>0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) source micin, linein dependent> 4/4 micin => use built-in microphone input. linein => use external microphone input. * Reserved for compatibility, and suggest don't use this since the version number (httpversion) is equal or greater than 0301a.
PAGE 223
VIVOTEK external microphone (The related bit of "capability_audio_extmic" is equal to 1). mute 0, 1 1/4 0: Mute off 1: Mute on gain 0~100 4/4 _source = linein) this> * 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".
PAGE 224
VIVOTEK 5150, 5900, * Only available if AMR is supported. 6700, 7400, 7950, 10200, 12200 s0_g711_mode pcmu, 4/4 pcma Set G.711 companding algorithm. pcmu: µ-law algorithm pcma: A-law algorithm * Only available if G.711 is supported. s0_g726_bitrate 16000, 4/4 Set G.726 encoded bitrate in bps. 24000, * Only available if G.726 is supported. 32000, 40000 s0_g726_bitstreampackin little, big 4/4 gmode Set G.726 bit streaming packing mode. little: Little-endian bitstream format.
PAGE 225
VIVOTEK profile_i0_alarm_level 1~100 4/4 Audio detection alarm level 7.14 Motion detection settings Group: motion_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable 4/4 Enable motion detection. win_sensitivity 0 ~ 100 4/4 Sensitivity of all motion detection windows. * The value "0" is reserved for compatibility and will not be used after the version number (httpversion) is equal or greater than 0400a.
PAGE 226
VIVOTEK image width -1 H: 0~ The current * Only available when px is listed in image height -1 "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. polygon 0 ~ 320,0 ~ 240, 0 4/4 Coordinate of polygon window position.
PAGE 227
VIVOTEK version number (httpversion) is equal or greater than 0400a. width 0 ~ 320 4/4 Width of motion detection window. "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. height 0 ~ 240 4/4 Height of motion detection window.
PAGE 228
VIVOTEK * The value "0" is reserved for compatibility and will not be used after the version number (httpversion) is equal or greater than 0400a. Group: motion_c<0~(n-1)>_profile_i<0~(m-1)>_win_i<0~(k-1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the vaule of "capability_nmotionprofile", k denotes the value of "capability_nmotion". NAME VALUE SECURITY DESCRIPTION (get/set) enable 4/4 Enable motion detection window.
PAGE 229
VIVOTEK polygon 0 ~ 320,0 ~ 240, 0 4/4 Coordinate of polygon window position. 320,0 ~ 240, 0 ~ * Only available when 320,0 ~ 240 "capability_motion_wintype" = polygon. * 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 230
VIVOTEK * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. height 0 ~ 240 4/4 Height of motion detection window. "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain".
PAGE 231
VIVOTEK 7.15 Tampering detection settings Group: tampering_c<0~(n-1)> for n channel products (capability.tampering > 0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable 4/4 Enable or disable tamper detection. threshold 0~100 4/4 Threshold of tamper detection. duration 10~600 4/4 If tampering value exceeds the "threshold" for more than "duration" second(s), then tamper detection is triggered.
PAGE 232
VIVOTEK 7.16 DDNS Group: ddns (capability.protocol.ddns > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable or disable the dynamic DNS. provider CustomSafe100, 6/6 Safe100 => safe100.net DyndnsDynamic, DyndnsDynamic => dyndns.org (dynamic) DyndnsCustom, DyndnsCustom => dyndns.org Safe100 CustomSafe100 => Custom server using safe100 method _hostname string[128] 6/6 Your DDNS hostname.
PAGE 233
VIVOTEK 7.18 UPnP presentation Group: upnppresentation NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable or disable the UPnP presentation service. 7.19 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. 0 = OK, 1 = FAIL, 2 = no IGD router, 3 = no need for port forwarding 7.
PAGE 234
VIVOTEK 0: disable 1: Show log of parameter setting set from external. 2. Show log of parameter setting set from external and internal. 7.21 SNMP Group: snmp (capability.protocol.snmp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) v2 6/6 SNMP v2 enabled. 0 for disable, 1 for enable v3 6/6 SNMP v3 enabled.
PAGE 235
VIVOTEK 7.22 Layout configuration Group: layout NAME VALUE SECURITY DESCRIPTION (get/set) logo_default 1/6 0 => Custom logo 1 => Default logo logo_link string[128] 1/6 Hyperlink of the logo 1/6 0 => display the power by vivotek logo http://www.vivotek.
PAGE 236
VIVOTEK 7.23 Privacy mask Group: privacymask_c<0~(n-1)> for n channel products and m privacy mask window. n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY DESCRIPTION (get/set) enable 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 237
VIVOTEK ~ W,0 ~ H "capability_image_c_privacymask_wintype" W: 0~ The = polygon. current image width -1 * Only available when px is listed in H: 0~ The "capability_image_c_privacymask_windomai current image n height -1 win_i<0~(m-1)>_polygonstd 0 ~ 9999,0 ~ 4/4 Coordinate of polygon window position. 9999, 0 ~ (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 9999,0 ~ * Only available when 9999, 0 ~ "capability_image_c_privacymask_wintype" 9999,0 ~ = polygon.
PAGE 238
VIVOTEK _minzoom" ~ "capability_ptz_c<0~(n-1)> _maxzoom" win_i<0~(m-1)>_fliped 4/4 Flip side of window position.
PAGE 239
VIVOTEK 7.25 Capability Group: capability NAME VALUE SECURITY DESCRIPTION (get/set) api_httpversion 0/7 The version of VIVOTEK WebAPI with 4 This number start integers plus 1 alphabet, There are composed with 0301a. by "major version", "minor version", "revision","_platform". ex: 0301a_1 Major version Increase the major version when change, remove the old features/interfaces or the firmware has substantially change in architecture and not able to roll back to previous version.
PAGE 240
VIVOTEK document. The 5th character is model-based version for API bug-fix and it's default to "a". Ex: If some APIs in a model does not follow the API definition of 0301a_1, we will fix them and change this API value to 0301b_1. bootuptime 0/7 Server bootup time. nir 0, 0/7 Number of IR interfaces.
PAGE 241
VIVOTEK More details, please refer the parameter description of "volume_internal" and "volume_external". nuart 0, 0/7 Number of UART interfaces. nmotion 0/7 The number of motion window. nmotionprofile 0,
PAGE 242
VIVOTEK it means that the camera supports remotefocus function. bit 0 => Indicate whether to support both zoom and focus function. bit 1 => Only support zoom function. bit 2 => Only support focus function. bit 3 => Currently, this is a reserved bit, and the default value is 0. * It's strongly non-recommended to use this. * This is reserved for compatibility and will not be used after the version number (httpversion) is equal or greater than 0400a.
PAGE 243
VIVOTEK channel support ePTZ or not, and so on. * For most products, the last stream of a channel will not support ePTZ. It is reserved for full view of the channel. For some dual-stream products, both streams support ePTZ. nanystream 0, iva analysis whitelight 0/7 Indicate whether to support white light led.
PAGE 244
VIVOTEK "visignal" = Video input signal loss. "backup" = Backing up recorded files * Only available when [httpversion] >= 0301a storage_dbenabled 0/7 Media files are indexed in database. protocol_https < boolean > 0/7 Indicate whether to support HTTP over SSL. protocol_rtsp < boolean > 0/7 Indicate whether to support RTSP. protocol_sip 0/7 Indicate whether to support SIP.
PAGE 245
VIVOTEK dependent> * This is kept for compatibility. videoin_maxframerate A list of 0/7 This equals "capability_videoin_c0_maxframerate". * This is kept for compatibility. videoin_mjpeg_maxframe A list of rate and "-" 0/7 This equals "capability_videoin_c0_mjpeg_maxframerate ". * This is kept for compatibility. videoin_h264_maxframer A list of ate and "-" 0/7 This equals "capability_videoin_c0_h264_maxframerate". * This is kept for compatibility.
PAGE 246
VIVOTEK "videoout_codec"=ntsc "nvideoout"=1 with PAL, "videoout_codec"=pal "nvideoout"=2 with both NTSC, "videoout_codec"=ntsc,ntsc * For camera, this feature is controlled by physical jump on device. No WebAPI to control it. This value is set only on camera power-on and maintains the status. * Only available when [httpversion] >= 0301a timeshift 0/7 Indicate whether to support time shift caching stream. audio_aec 0/7 Indicate whether to support acoustic echo cancellation.
PAGE 247
VIVOTEK audio_lineout 0/7 Indicate whether to support line output. audio_michardwareswitch 0/7 Indicate whether the hardware supports built-in/external mic switch audio_headphoneout 0/7 Indicate whether to support headphone output. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. audioin_codec aac4, gamr, g711, 0/7 g726, - Available audio codec.
PAGE 248
VIVOTEK std: A normalized 0~9999 range. -: Not supported. *only available when "capability_smartstream_support" is 1 smartstream_mode_autot 0/7 racking Indicate whether autotracking smart stream is supported. *only available when "capability_smartstream_support" is 1 smartstream_mode_man 0/7 ual Indicate whether manual smart stream is supported.
PAGE 249
VIVOTEK Bit 6 => Support shared memory API Bit 7 => Support digital signature of package Bit 8 => Support snapshot vadp_npackage 0/7 Indicate the maximum number of VADP package that can be uploaded to the device. thermal_support 0/7 Indicate whether to support thermal IC. thermal_controlmode auto, 0/7 Indicate the thermal control mode. "auto": control by camera automatically customheater "customheater": the threshold of heater can be sepcified by user.
PAGE 250
VIVOTEK * This is kept for compatibility. uart_httptunnel 0/7 Indicate whether to support HTTP tunnel for UART transfer. transmission_mode Tx, 0/7 Rx, Indicate transmission mode of the machine: TX = server, Rx = receiver box, Both = DVR. Both network_wire 0/7 Indicate whether to support Ethernet. network_wireless 0/7 Indicate whether to support wireless. wireless_s802dot11b 0/7 Indicate whether to support wireless 802.11b+.
PAGE 251
VIVOTEK media_videoclip_maxpree 0/7 vent image_iristype Maximum duration (second) after event occurred in a videoclip. 0/7 Indicate iris type.  "dciris": DC-Iris  "-": 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 252
VIVOTEK localstorage_slconnum 0, 0/7 The maximum seamless connection number. localstorage_smartsd 0/7 The "Lifetime and Log SD Card" feature allows users to obtain the card's remaining lifetime information. 0: Non-support this feature 1: Support this feature * Only Sony SD card can support this function now.
PAGE 253
VIVOTEK buildinpt 0/7 An 32-bit integer, each bit can be set separately as follows: Bit 0 => support build-in pan Bit 1 => support build-in tilt zoommodule 0/7 Indicate whether to support zoom lens. In our product, only SD series and IZ series use the zoom lens. * Both varifocal and zoom lenses are built with movable elements that permit changing the effective focal length.
PAGE 254
VIVOTEK maxpanangle 0/7 The upper limit for pan angle. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" tiltspeedlv 0, 0/7 The maximum speed level of tilt motion. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" mintilt 0, 0/7 The lower limit for tilt position.
PAGE 255
VIVOTEK focusspeedlv 0, 0/7 The maximum speed level of focus motion. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule" is "1" minfocus 0, 0/7 The lower limit for focus position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule" is "1" maxfocus 0, 0/7 The upper limit for focus position.
PAGE 256
VIVOTEK ircutsensitivity_type 0/7 Indicate the cgi interface of "ircutcontrol_sensitivity". "options": the value of "ircutcontrol_sensitivity" parameter is "low, normal,high". "normalize": the value of "ircutcontrol_sensitivity" parameter is "1~100" * Only available when "capability_daynight_c_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
PAGE 257
VIVOTEK streamcodec 0/7 Represent supported codec types of each stream. This contains a list of positive integers, split by comma. Each one stands for a stream, and the definition is as following: Bit 0: Support MPEG4. Bit 1: Support MJPEG Bit 2: Support H.264 Bit 3: Support H.265 mode 0, 0/7 Indicate current video mode. nmode 0/7 Indicate how many video modes supported by this channel.
PAGE 258
VIVOTEK 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. Ex: 30 fps is changed to 25 fps, 60 fps is changed to 50 fps, and so on.
PAGE 259
VIVOTEK h264_maxbitrate 0/7 Maximum bitrates of H.264. The unit is bps. * Only available when 'h264' is listed in "capability_videoin_codec". h265_maxframerate A list of and "-" Maximum fps that the device can encoded with H.265 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.
PAGE 260
VIVOTEK cameraunit_name CU8131, 0/7 A "camera unit" name of a split-type camera CU8171, system, which the camera unit and the video CU8161-H, core are separated. CU8162-H, -: If the camera is not a split-type camera CU8163-H, system, the value of this parameter is "-". CU8361-H, ..., * We support this parameter when the version - number (httpversion) is equal or greater than 0302b.
PAGE 261
VIVOTEK effectivepixel 0/7 The visible area of full scene in this video mode. The unit is pixel in source. * If "effectivepixel"<"capability_videoin_c_max size", then the visible area is located at the center of full scene. 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.
PAGE 262
VIVOTEK maxframerate A list of Indicates frame rate that the video source outputs in this video mode. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group. * This parameter records the frame rate when "videoin_c_cmosfreq"=60 or "videoin_c_modulation"=ntsc maxfps_mjpeg A list of and "-" Maximum fps which the device can encoded with MJPEG on resolutions in this video mode.
PAGE 263
VIVOTEK maxfps_h265 A list of and "-" H.265 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. * This parameter records the frame rate when "videoin_c_cmosfreq"=60 or "videoin_c_modulation"=ntsc * Only available when 'h265' is listed in "capability_videoin_codec".
PAGE 264
VIVOTEK number indicate the support strength level of WDR Pro, and the scecond number indicate the support strength level of WDR Pro II. wdrpro_affect -, 0/7 When WDR Pro or WDR Enhanced is exposurewin.mode:fixed:au enabled, some features may become to, malfunction or be forced to a given exposurewin.mode.blc:disab value. The affected functions are list led:, here.
PAGE 265
VIVOTEK wdrpro_description 0/7 Description about WDR Pro mode. * Only available when "capability_image_c<0~(n-1)>_wdrp ro_mode" > 0 wdrc_mode 0, 1 0/7 0: Non-support WDR Enhanced 1: Support WDR Enhanced wdrc_supportlevel 0, 0/7 Indicate the support strength level of WDR Enhanced. wdrc_affect -, 0/7 When WDR Pro or WDR Enhanced is exposurewin.mode:fixed:au enabled, some features may become to, malfunction or be forced to a given exposurewin.mode.
PAGE 266
VIVOTEK "-" means no feature is affected. * When "wdrpro"=0 and "wdrc"=0, this must be "-" dnr 0,1 0/7 0: Non-support 3D digital noise reduction 1: Support 3D digital noise reduction eis 0,1 0/7 0: Non-support electronic image stabilizer 1: Support electronic image stabilizer is_mode eis, 0/7 Indicate the image stabilizer mode.
PAGE 267
VIVOTEK minexposure:hidden:, features may become malfunction or mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here. 3dnr:unchanged:, or others The format is "Affect API name":"Policy":"Value" : nonnegative integer "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.
PAGE 268
VIVOTEK 1: Support scene mode scenemode_supporttype visibility, noiseless, 0/7 list all the scene mode which are supported in the camera. lpcparkinglot, lpcstreet * Only available when "capability_image_c_ scenemode_support" is 1 scenemode_visibility_affe -, 0/7 When scene mode is enabled, some ct minexposure:hidden:, features may become malfunction or mingain:hidden:, be forced to a given value.
PAGE 269
VIVOTEK "-" means no feature is affected. * Only available when visibility is listed in "capability_image_c_ scenemode_supporttype" and "capability_image_c_ scenemode_support" is 1 scenemode_noiseless_aff -, 0/7 When scene mode is enabled, some ect minexposure:hidden:, features may become malfunction or mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here.
PAGE 270
VIVOTEK * Only available when visibility is listed in "capability_image_c_ scenemode_supporttype " and "capability_image_c_ scenemode_support" is 1 scenemode_lpcparkinglot -, 0/7 When scene mode is enabled, some _affect minexposure:hidden:, features may become malfunction or mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here.
PAGE 271
VIVOTEK in "capability_image_c_ scenemode_supporttype " and "capability_image_c_ scenemode_support" is 1 scenemode_lpcstreet_aff -, 0/7 When scene mode is enabled, some ect minexposure:hidden:, features may become malfunction or mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here.
PAGE 272
VIVOTEK scenemode_supporttype " and "capability_image_c_ scenemode_support" is 1 wbmode auto, 0/7 Available white balance mode. manual, "-" means white balance is not rbgain, supported. widerange, outdoor,indoor, sodiumauto, iristype piris, 0/7 Indicate iris type. dciris, "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, 0/7 Indicate sensor type.
PAGE 273
VIVOTEK or greater than 0302a. exposure_shuttervaluetyp fixed, 0/7 * One to one mapping to the mode e maximum, type in "exposure_modetype". - "fixed": The shutter value is the assigned value (videoin_c_shuttervalue). "maximum": The shutter value can be up to the assigned value (videoin_c_shuttervalue). "-": not support. * Only available when "capability_image_c_exposure_ra ngetype" is "onevalue".
PAGE 274
VIVOTEK name":"Policy":"Value" : nonnegative integer "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. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.
PAGE 275
VIVOTEK wdrpro:disabled:, here. exposurelevel:hidden:, or others The format is "Affect API name":"Policy":"Value" : nonnegative integer "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 276
VIVOTEK e_affect exposurewin.mode.blc:hidd some features may become en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here. exposurelevel:hidden:, or others The format is "Affect API name":"Policy":"Value" : nonnegative integer "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 277
VIVOTEK version number (httpversion) is equal or greater than 0302a. exposure_manualmode_a -, 0/7 When exposure mode is enabled, ffect exposurewin.mode.blc:hidd some features may become en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here.
PAGE 278
VIVOTEK "capability_image_c_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_levelrange -, 0/7 "0,12" Available range for "videoin_c_exposurelevel" * When "exposure_mode"=0, this must be set to "-". exposure_winmode auto, 0/7 custom, Available options for "exposurewin_c_mode" blc, - * "-" means group: exposurewin is not supported. * When exposure_mode="0", this must be set to "-".
PAGE 279
VIVOTEK 0301a exposure_pal_totalrange A list of 0/7 Available total range for PAL analog output * Only available when [httpversion] >= 0301a exposure_maxrange "1,32000", 0/7 Available range for "1,8000", "videoin_c_maxexposure" -, "1,32000" => 1s ~ 1/32000s or others "1,8000" => 1s ~ 1/8000s etc. "-" means maximum exposure time is not available. * When "exposure_mode"=0, this must be set to "-".
PAGE 280
VIVOTEK privacy mask. agc_maxgain "0,100", 0/7 "-" Available range for "videoin_c_maxgain" “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.
PAGE 281
VIVOTEK which means exposurelevel is fixed to level 6. "Value" can be a nonnegative integer or NULL. "-" means no feature is affected. * When "flickerless" = 0, this must be "-" defog_mode 0,1 0/7 0: Non-support defog 1: Support defog defog_strength 0, 1 0/7 0: Non-support tuning strength of defog 1: Support tuning strength of defog * If "capability_image_c_defog_mode "=1, this may be either 0 or 1.
PAGE 282
VIVOTEK selections or values. "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. "Value" can be a nonnegative integer or NULL. "-" means no feature is affected.
PAGE 283
VIVOTEK both zoom and focus function. bit 1 => Only support zoom function. bit 2 => Only support focus function. bit 3 => Currently, this is a reserved bit, and the default value is 0. focuswindomain qvga, px, std, - 0/7 The domain to set an focus 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.
PAGE 284
VIVOTEK Group: capability_peripheral_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) waterspray_support 0/7 0: Non-support water spray feature 1: Support water spray feature * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
PAGE 285
VIVOTEK 7.27 Event setting Group: event_i<0~2> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] 6/6 Identification of this entry. enable 0, 1 6/6 Enable or disable this event. priority 0, 1, 2 6/6 Indicate the priority of this event: “0”= low priority “1”= normal priority “2”= high priority delay 1~999 6/6 Delay in seconds before detecting the next event.
PAGE 286
VIVOTEK mdwin 0, 6/6 Indicate the source window id of motion detection. This field is required when trigger condition is “md”. One bit represents one window. The LSB indicates the 1st window. For example, to detect the 1st and 3rd windows, set mdwin as 5. mdwin0 0, 6/6 Similar to mdwin. The parameter takes effect when profile 1 of motion detection is enabled. vi 0, 6/6 Indicate the source id of vi trigger.
PAGE 287
VIVOTEK 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 Begin time of the weekly schedule. endtime hh:mm 6/6 End time of the weekly schedule.
PAGE 288
VIVOTEK action_goto_name string[40] 6/6 Specify the preset name that ptz goto on event triggered. * Only available when capability_ptzenabled > 0. action_goto_sync 6/6 Capture media after moving to the location. * Only avaliable when the bit4 of capability_ptzenable is 1 and the bit7 of capability_ptzenable is 0 action_autotrack_enable 6/6 Enable/disable auto tracking on event triggerd.
PAGE 289
VIVOTEK email_port 0~65535 6/6 Port to connect to the server. email_username string[64] 6/6 Username to log in to the server. email_passwd string[64] 6/6 Password of the user. email_senderemail string[128] 6/6 Email address of the sender. email_recipientemail string[640] 6/6 Email address of the recipient. ns_location string[128] 6/6 Location to upload or store the media. ns_username string[64] 6/6 Username to log in to the server.
PAGE 290
VIVOTEK snapshot_postevent 0~" 6/6 capability_media_snapshot_maxpo Indicates the number of post-event images. stevent" videoclip_source 0~"capability_nmediastream -1" 6/6 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] 6/6 Indicate the prefix of the filename.
PAGE 291
VIVOTEK 7.30 Recording Group: recording_i<0~1> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] 6/6 Identification of this entry. trigger schedule, 6/6 The event trigger type networkfail 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. priority 0, 1, 2 6/6 Indicate the priority of this recording: “0” indicates low priority.
PAGE 292
VIVOTEK notifyserver 0~31 6/6 Indicate which notification server is scheduled. One bit represents one application server (server_i0~i4). bit0 (LSB) = server_i0. bit1 = server_i1. bit2 = server_i2. bit3 = server_i3. bit4 = server_i4. For example, enable server_i0, server_i2, and server_i4 as notification servers; the notifyserver value is 21. weekday 0~127 6/6 Indicate which weekday is scheduled. One bit represents one weekday.
PAGE 293
VIVOTEK maxduration 60~3600 6/6 Unit: Second When this condition is reached, recording file is truncated. 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.31 HTTPS Group: https (capability.protocol.
PAGE 294
VIVOTEK commonname string[64] 6/6 Common name in the certificate information. 6/6 Valid period for the certification. www.vivotek.com validdays 0 ~ 3650 7.32 Storage management setting Group: disk_i<0~(n-1)> n is the total number of storage devices. (capability.storage.dbenabled > 0) Currently it’s only for local storage (SD, CF card), so n is equal to 1. PARAMETER VALUE SECURITY DESCRIPTION (get/set) cyclic_enabled 6/6 Enable cyclic storage method.
PAGE 295
VIVOTEK maxretentiontime_recordin 6/6 g_enabled Enable automatic clean up method for video clip generated by recording task. The parameter takes effect when autocleanup_enabled is enabled. maxretentiontime_recordin 6/6 g_i <0~1>_maxage 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.
PAGE 296
VIVOTEK 7.33 Region of interest Group: roi_c<0~(n-1)> for n channel product. (capability.eptz > 0) m denotes the value of "capability_nmediastream". PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-2)>_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. s<0~(m-2)>_size 1/6 ROI width and height.
PAGE 297
VIVOTEK 7.34 ePTZ setting Group: eptz_c<0~(n-1)> for n channel product. (capability.eptz > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) osdzoom 1/4 * Reserved for compatibility, and suggest don't use this since [httpversion] > 0302a * We replace "eptz_c<0~(n-1)>_osdzoom" with " videoin_c<0~(n-1)>_zoomratiodisplay".
PAGE 298
VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) 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.cgi rather than by setparam.cgi.
PAGE 299
VIVOTEK 7.36 Seamless recording setting Group: seamlessrecording (capability.localstorage.seamless> 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) diskmode seamless, 1/6 manageable “seamless” indicates enable seamless recording. “manageable” indicates disable seamless recording. maxconnection 3 1/7 Maximum number of connected seamless streaming. enable 1/7 Indicate whether seamless recording is recording to local storage or not at present.
PAGE 300
VIVOTEK 7.37 VIVOTEK Application Development Platformsetting Group: vadp NAME VALUE SECURITY DESCRIPTION (get/set) version 6/7 Indicate the VADP version. resource_total_memory 0, 6/7 Indicate total available memory size for VADP modules. resource_total_storage 0, 6/7 Indicate total size of the internal storage space for storing VADP modules. resource_free_memory 0, 6/7 Indicate free memory size for VADP modules.
PAGE 301
VIVOTEK vendorurl string[120] 6/6 URL of the vendor. version string[40] 6/6 Version of the module. license string[40] 6/6 Indicate the license status of the module. licmsg string[128] 6/6 Indicate the message that will be show on license status when mouse over. path string[40] 6/6 Record the storage path of the module. initscr string[40] 6/6 The script that will handle operation commands from the system. status string[40] 6/6 Indicate the running status of the module.
PAGE 302
VIVOTEK 7.38 camera PTZ control Group: camctrl (capability.camctrl.ptztunnel > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enableptztunnel 1/4 Enable PTZ tunnel for camera control. Group: camctrl_c<0~(n-1)> for n channel products (capability.
PAGE 303
VIVOTEK 7.39 camera PTZ control (SD series) Group: camctrl_c<0~(n-1)> for n channel products (the bit7 of capability_ptzenabled is 0 and the bit4 of capability_ptzenabled is 1) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset" NAME VALUE SECURITY DESCRIPTION (get/set) ccdtype string[16] 6/7 (Internal used, read only) motortype string[16] 6/7 (Internal used, read only) cameraid 1 ~ 255 1/4 Camera ID controlling external PTZ camera.
PAGE 304
VIVOTEK preset_i<0~(k-1)>_focus capability_ptz_c<0~(n-1) 1/4 Focus position at each preset location. >_minfocus ~ capability_ptz_c<0~(n-1) >_maxfocus preset_i<0~(k-1)>_fliped 1/4 Flip side at each preset location. patrol_i<0~39>_name string[40] 1/4 (For internal device) The name of patrol location patrol_i<0~39>_ dwelling 0 ~ 999 1/4 (For internal device) The dwelling time of each patrol location disablemdonptz 1/4 Disable motion detection on PTZ operation.
PAGE 305
VIVOTEK zoomenhance 1/4 Enable / Disable zoom enhancement tour_index -1, 0~19 1/4 Index of the enabled tour group, from 0 to 19. Set -1 to disable all the tour groups. tour_i<0~19>_name string[40] 1/4 Name of the tour. tour_i<0~19>_type 1/4 0 = Recorded tour 1 = Preset tour tour_i<0~19>_speed -5 ~ 5 1/4 Preset tour: pan and tilt speed when moving between presets. Recorded tour: unnecessary.
PAGE 306
VIVOTEK paritybit none, 4/4 For error checking. 4/4 1 odd, even stopbit 1,2 2-1.5 , data bit is 5 2-2 uartmode rs485, 4/4 RS485 or RS232. rs232 customdrvcmd_i<0~9> string[128] 1/4 PTZ command for custom camera. speedlink_i<0~4>_name string[40] 1/4 Additional PTZ command name. speedlink_i<0~4>_cmd string[40] 1/4 Additional PTZ command list. ptzdriver 0~19, 1/4 The PTZ driver is used by this COM port. 127 (custom), 128 (no driver) 7.
PAGE 307
VIVOTEK stopbit 1,2 4/4 1 2-1.5 , data bit is 5 2-2 uartmode rs485 4/7 RS485 mode. 7.42 Lens configuration Group: lens for n channel products n denotes the value of "capability_nvideoin" (capability.image.c<0~(n-1)>.lensconfiguration.support = 1) NAME VALUE SECURITY DESCRIPTION (get/set) selected 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 308
VIVOTEK 7.43 Fisheye info Group: fisheyeinfo (capability.fisheye > 0) NAME VALUE SECURITY DESCRIPTION (get/set) revisedcenteraxis 6/7 The actual center axis coordinate radius 0, 7.
PAGE 309
VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) objsize_type -1~2 1/4 Type of object size. -1 : customized width and height 0 : object size = 30 x 30 1 : object size = 10 x 20 2 : object size = 10 x 10 objsize_customized_width 10~320 1/4 The minimum width of tracking target. objsize_customized_height 10~240 1/4 The minimum height of tracking target. sensitivity 0~2 1/4 Tracking sensitivity.
PAGE 310
VIVOTEK 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.
PAGE 311
VIVOTEK 8.2 Query Status of the Digital Input(capability.ndi > 0) Note: This request requires Viewer privileges Method: GET/POST Syntax: http:///cgi-bin/dido/getdi.cgi?[di0][&di1][&di2][&di3] If no parameter is specified, all of the digital input statuses will be returned. 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.
PAGE 312
VIVOTEK 8.3 Query Status of the Digital Output (capability.ndo > 0) Note: This request requires Viewer privileges Method: GET/POST Syntax: http:///cgi-bin/dido/getdo.cgi?[do0][&do1][&do2][&do3] If no parameter is specified, all the digital output statuses will be returned. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: \r\n \r\n [do0=]\r\n [do1=]\r\n [do2=]\r\n [do3=]\r\n where can be 0 or 1.
PAGE 313
VIVOTEK 8.4 Capture Single Snapshot Note: This request requires Normal User privileges. Method: GET/POST Syntax: http:///cgi-bin/viewer/video.jpg?[channel=][&resolution=] [&quality=][&streamid=] If the user requests a size larger than all stream settings on the server, this request will fail. PARAMETER VALUE DEFA DESCRIPTION ULT channel 0~(n-1) 0 The channel number of the video source. resolution IP8165: 0 The resolution of the image.
PAGE 314
VIVOTEK 8.5 Account Management Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/editaccount.cgi? method=&username=[&userpass=][&privilege=] [&privilege=][…][&return=] PARAMETER VALUE DESCRIPTION method Add Add an account to the server. When using this method, the“username” field is necessary. It will use the default value of other fields if not specified.
PAGE 315
VIVOTEK 8.6 System Logs Note: This request require Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/syslog.cgi Server will return the most up-to-date system log. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: \r\n \r\n \r\n 8.7 Upgrade Firmware Note: This request requires Administrator privileges. Method: POST Syntax: http:///cgi-bin/admin/upgrade.
PAGE 316
VIVOTEK 8.8 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 317
VIVOTEK http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed. To stop a continuous movement, you have to use the command as below: http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zoom=stop&zs=0 2.
PAGE 318
VIVOTEK 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. It will be the y-coordinate of center after movement. videosize The size of plug-in (ActiveX)window in web page resolution The resolution of streaming.
PAGE 319
VIVOTEK 8.9 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 One of the present positions to recall.
PAGE 320
VIVOTEK 8.10 ePTZ Preset Locations(capability.eptz > 0 and capability_fisheye = 0) Note: This request requires Operator privileges. Method: GET/POST Syntax: http:///cgi-bin/operator/ePreset.cgi?channel=&stream= [&addpos=][&delpos=][&return=] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source. stream <0~(m-1)> Stream. addpos
PAGE 321
VIVOTEK 8.11 IP Filtering Note: This request requires Administrator access privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/ipfilter.cgi?type[=] http:///cgi-bin/admin/ipfilter.cgi?method=add&ip=[&index=][&ret urn=] http:///cgi-bin/admin/ipfilter.
PAGE 322
VIVOTEK 8.12 IP Filtering for ONVIF Syntax: http:///cgi-bin/admin/ipfilter.cgi?type[=] http:///cgi-bin/admin/ipfilter.cgi?method=add&ip=[&index=][&ret urn=] http:///cgi-bin/admin/ipfilter.cgi?method=del&index=[&return=] PARAMETER VALUE DESCRIPTION type NULL Get IP filter type allow, deny Set IP filter type addv4 Add IPv4 address into access list.
PAGE 323
VIVOTEK 8.13 UART HTTP Tunnel Channel (capability.nuart > 0) Note: This request requires Operator privileges. Method: GET and POST Syntax: http:///cgi-bin/operator/uartchannel.cgi?[channel=] ------------------------------------------------------------------------GET /cgi-bin/operator/uartchannel.
PAGE 324
VIVOTEK 8.14 Event/Control HTTP Tunnel Channel (capability. evctrlchannel > 0) Note: This request requires Administrator privileges. Method: GET and POST Syntax: http:///cgi-bin/admin/ctrlevent.cgi ------------------------------------------------------------------------GET /cgi-bin/admin/ctrlevent.
PAGE 325
VIVOTEK 8.15 Get SDP of Streams Note: This request requires Viewer access privileges. Method: GET/POST Syntax: http:///_accessname> “m” is the stream number. “network_accessname_<0~(m-1)>” is the accessname for stream “1” to stream “m”. Please refer to the “subgroup of network: rtsp” for setting the accessname of SDP. You can get the SDP by HTTP GET. When using scalable multicast, Get SDP file which contains the multicast information via HTTP. 8.
PAGE 326
VIVOTEK 8.17 Senddata (capability.nuart > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http:///cgi-bin/viewer/senddata.cgi? [com=][&data=][&flush=] [&wait=] [&read=] PARAMETER VALUE DESCRIPTION com 1 ~ data is a series of digits from 0 ~ 9, A ~ F. Each data>[,
PAGE 327
VIVOTEK 8.18 Storage managements (capability.storage.dbenabled > 0) Note: This request requires administrator privileges. Method: GET and POST Syntax: http:///cgi-bin/admin/lsctrl.cgi?cmd=[&=…] The commands usage and their input arguments are as follows. PARAMETER VALUE DESCRIPTION cmd_type Required. Command to be executed, including search, insert, delete, update, and queryStatus.
PAGE 328
VIVOTEK Indicate if the file is locked or not. 0: file is not locked. 1: file is locked. A locked file would not be removed from UI or cyclic storage. triggerTime Optional. Indicate the event trigger time. (not the file created time) Format is “YYYY-MM-DD HH:MM:SS” Please embrace your input value with single quotes. Ex. triggerTime=’2008-01-01 00:00:00’ If you want to search for a time period, please apply “TO” operation. Ex.
PAGE 329
VIVOTEK label Required. Identify the designated record. Ex. label=1 isLocked Required. Indicate if the file is locked or not. Ex. Update records whose key numbers are 1 and 5 to be locked status. http:///cgi-bin/admin/lsctrl.cgi?cmd=update&isLocked=1&label=1&label=5 Ex. Update records whose key numbers are 2 and 3 to be unlocked status. http:///cgi-bin/admin/lsctrl.
PAGE 330
VIVOTEK 8.19 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] Ex: vi0=1 Setting virtual input 0 to trigger state Where "state" is 0, 1.
PAGE 331
VIVOTEK 8.20 Open Timeshift Stream (capability.timeshift > 0, timeshift_enable=1, timeshift_c_s_allow=1) Note: This request requires Viewer access privileges. Syntax: For HTTP push server (MJPEG): http:///_accessname>?maxsft=[&tsmode=&reftime=&forcechk&minsft=] For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player.
PAGE 332
VIVOTEK 400 Bad Request Request is rejected because some parameter values are illegal. 415 Unsupported Media Type Returned, if forcechk appears,when minsft is not achievable or the timeshift feature of the target stream is not enabled.
PAGE 333
VIVOTEK 8.21 RemoteFocus (capability_image_c<0~(n-1)>_remotefocus=1) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/remotefocus.
PAGE 334
VIVOTEK function zoom, Function type focus, zoom - Move focus motor auto, focus – Move focus motor scan, auto – Perform auto focus stop, scan – Perform focus scan positioning, stop – Stop current operation getstatus positioning – Position the motors getstatus–Information of motors, return value as below: remote_focus_zoom_motor_max: Maximum steps of zoom motor remote_focus_focus_motor_max: Maximum steps of focus motor remote_focus_zoom_motor_start: Start point of zoom motor remote_focus_zoom_
PAGE 335
VIVOTEK direction direct, Motor’s moving direction. forward, It works only if function= zoom | focus. backward position 0~ Motor’s position. It works only if function=zoom | 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. It works only if function=zoom | focus and direction=forward | backward.
PAGE 336
VIVOTEK 8.22 BackFocus (capability_image_c<0~(n-1)>_remotefocus=4) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/remotefocus.
PAGE 337
VIVOTEK function focus, Function type auto, focus – Move focus motor scan, auto – Perform auto focus stop, scan – Perform focus scan positioning, stop – Stop current operation irisopen, positioning – Position the motors irisenable, resetfocus – reset focus position to default resetfocus, irisopen – Fully open iris. It will maintain this status until sending getstatus irisenable cgi.
PAGE 338
VIVOTEK steps 1 ~ Motor’s moving steps. It works only if function=focus and direction=forward | backward. is refer to remote_focus_focus_motor_max which replied from "function=getstatus" iris N/A Open iris or not. It works only if function=auto | scan. 8.23 Export Files Note: This request requires Administrator privileges. Method: GET Syntax: For daylight saving time configuration file: http:///cgi-bin/admin/exportDst.
PAGE 339
VIVOTEK 8.24 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/upload_backup.
PAGE 340
VIVOTEK 8.25 Update Lens Configuration Note: This request requires Administrator privileges. Method: GET 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.
PAGE 341
VIVOTEK Server will accept the file named to upload the lens profile to camera. 8.26 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.
PAGE 342
VIVOTEK 8.27 Fisheye local dewarp camera control (capability.fisheye > 0 and capability.fisheyelocaldewarp.c0 > 0, only support in 1R mode) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http:///cgi-bin/camctrl/fdCamCtrl.
PAGE 343
VIVOTEK zoom wide Zoom larger view with current speed. tele Zoom further with current speed. speedpan -5 ~ 5 Set the pan speed of current command. speedtilt -5 ~ 5 Set the tilt speed of current command. speedzoom -5 ~ 5 Set the zoom speed of current command. zooming wide or tele Zoom without stopping for larger view or further view with zs speed, used for joystick control. zs 0~6 Set the speed of zooming, “0” means stop. vx -6 ~ 6 The direction of movement, used for joystick control.
PAGE 344
VIVOTEK 8.28 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 345
VIVOTEK 8.29 Camera Control (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http:///cgi-bin/camctrl/camctrl.
PAGE 346
VIVOTEK 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. tele Zoom further with current speed. stop Stop zoom. wide or tele Zoom without stopping for larger view or further view with zs speed, zoom zooming used for joystick control. zs 0 ~ 8 Set the speed of zooming, “0” means stop.
PAGE 347
VIVOTEK 8.30 Recall (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET Syntax: http:///cgi-bin/viewer/recall.cgi? recall=[&channel=][&return=] PARAMETER VALUE DESCRIPTION recall string[30] One of the present positions to recall. channel 0~(capability_nvideoin-1) Channel of the video source. return Redirect to the page after the parameter is assigned.
PAGE 348
VIVOTEK return Redirect to the page after the parameter is assigned. The can be a full URL path or relative path according to the current path. If you omit this parameter, it will redirect to an empty page.
PAGE 349
VIVOTEK 8.32 SmartSD (capability_localstorage_smartsd > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/smartsd.
PAGE 350
VIVOTEK 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. The range is from 0 to 100 (unit : %).
PAGE 351
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 352
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.