User manual

ManualsBrandsVIVOTEK ManualsIP CCTV SystemsLAN IP CCTV camera 1920 x 1080 pix

User’s Manual

2MP • WDR • Day & Night • 30M IR • IP66 • IK10 • Extreme Weather •

Defog

Bullet

Network Camera

IB836BA-EHT, IB836BA-EHF3

IB836BA-HT, IB836BA-HF3

Rev. 1.2

Summary of content (334 pages)

PAGE 1
IB836BA-HT, IB836BA-HF3 IB836BA-EHT, IB836BA-EHF3 Bullet Network Camera User ’s Manual 2MP • WDR • Day & Night • 30M IR • IP66 • IK10 • Extreme Weather • Defog Rev. 1.
PAGE 2
VIVOTEK Table of Contents Overview ��3 Revision History ��3 Read Before Use ��
PAGE 3
VIVOTEK Appendix �� 139 URL Commands for the Network Camera �� 139 Technology License Notice �� 333 Electromagnetic Compatibility (EMC) ��
PAGE 4
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 5
VIVOTEK Symbols and Statements in this Document i INFORMATION: provides important messages or advices that might help prevent inconvenient or problem situations. NOTE: Notices provide guidance or advices that are related to the functional integrity of the machine. Tips: Tips are useful information that helps enhance or facilitae an installation, function, or process. WARNING: or IMPORTANT:: These statements indicate situations that can be dangerous or hazardous to the machine or you.
PAGE 6
VIVOTEK Hardware Installation 1. Attach the included alignment sticker to a preferred location. 2. Drill holes for mounting screws and a cabling hole. 3. Loosen the anti-tamper screws to open the top cover. 4. Insert an SD card (user-supplied). 5. Replace the desiccant bag whenever you open the top cover. This ensures the components are free from the moisture.
PAGE 7
VIVOTEK 6. Secure the Network Camera to a wall or ceiling. 6 Ceiling Mount Wall Mount 7. Secure the sun shield to camera.
PAGE 8
VIVOTEK 8. When connecting the LAN cable, use the cable housing to make sure the connections are waterproof. 8-1. Pass the cable through the seal dome, and squeeze the rubber seal through an RJ45 connector. 8-2. You can then pass the cable through the cable gland body. 8-3. Fasten up these components. Make sure enough pressure is exerted on the rubber seal. 8-4. Connect the Ethernet cable to the RJ45 connector with a seal ring. Fasten the cable housing. 8 3.
PAGE 9
VIVOTEK 9. If your cables pass through a hole on a wall or ceiling, make sure the passage is waterproof using sealant foam, heat shrink tubing, or putties. Make sure the interfaces, e.g., DC connectors and terminal connectors, if unused, are also wrapped up using waterproof putties. 9 You can also purchase the AM-714 junction box to place all cabling connections within the protection of the box .
PAGE 10
VIVOTEK 10. Loosen the fastening ring on the mount bracket using a hex wrench, and aim the camera at the area of your interest. When done, tighten the fastening ring. 10 Fastening ring 11. Connect the other interfaces, such as I/O wires. 12. Install the "Installation Wizard 2" software utility on your software CD. 13. The program will search for VIVOTEK Video Receivers, Video Servers or Network Cameras on the same LAN. 14.
PAGE 11
VIVOTEK LED Definitions Item LED status LED De`finitions 1 2 3 4 5 Steady Red Description Powered and system booting, or network failed Power off Network is disconnected Connected to network Red LED off Green LED off Steady Red and Green LED blinks every 1 sec. Green LED blinks every 1 sec. and RED Upgrading firmware LED blinks consecutively every 0.15 sec. Green and RED blink every 0.15 sec, Green Restoring defaults and RED light on, then blink again.
PAGE 12
VIVOTEK Hardware Reset Reset Button The reset button is used to reset the system or restore the factory default settings. Sometimes resetting the system can return the camera to normal operation. If the system problems remain after reset, restore the factory settings and install again. Reset: Press the recessed reset button. Wait for the Network Camera to reboot. Restore: Press and hold the reset button until the status LED rapidly blinks. Note that all settings will be restored to factory default.
PAGE 13
VIVOTEK Network Deployment General Connection (PoE) When using a PoE-enabled switch The Network Camera is PoE-compliant, allowing transmission of power and data via a single Ethernet cable. Follow the below illustration to connect the Network Camera to a PoEenabled switch via Ethernet cable. 802.3af PoE Switch When using a non-PoE switch Use a PoE power injector (optional) to connect between the Network Camera and a nonPoE switch. PoE Power Injector (optional) Non-PoE Switch NOTE: 1.
PAGE 14
VIVOTEK Internet connection via a router Before setting up the Network Camera over the Internet, make sure you have a router and follow the steps below. 1. Connect your Network Camera behind a router, the Internet environment is illustrated below. Regarding how to obtain your IP address, please refer to Software Installation on page 16 for details. IP address : 192.168.0.3 WAN (Wide Area Network ) Internet Router IP address : from ISP POWER COLLISION 1 2 3 4 5 Subnet mask : 255.255.255.
PAGE 15
VIVOTEK Configure the router, virtual server or firewall, so that the router can forward any data coming into a preconfigured port number to a network camera on the private network, and allow data from the camera to be transmitted to the outside of the network over the same path. From Forward to 122.146.57.120:8000 192.168.2.10:80 122.146.57.120:8001 192.168.2.11:80 ... ... When properly configured, you can access a camera behind the router using the HTTP request such as follows: http://122.146.57.
PAGE 16
VIVOTEK Software Installation Installation Wizard 2 (IW2), a software included in the product CD, helps you set up your Network Camera on the LAN. IW2 1. Install IW2 under the Software Utility directory from the software CD. Double-click the IW2 shortcut on your desktop to launch the program. Installation Wizard 2 2. The program will conduct an analysis of your network environment. After your network environment is analyzed, please click Next to continue the program. 3.
PAGE 17
VIVOTEK Ready to Use 1. A browser session with the Network Camera should prompt as shown below. 2. You should be able to see live video from your camera. You may also install the 32-channel recording software from the software CD in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents. IB836BA IMPORTANT: • The "E" models, e.g., IB836BA-EHF3, IB836BA-EHT, are able to operate in low temperature environments.
PAGE 18
VIVOTEK Auto Focus On the web session, visit the Configuration > Image > Focus window. Perform the Auto Focus function for best image. However, if you have cascaded cameras, do this one by one. Do not perform this function simultaneously on multiple cameras because the motorized lens also consume considerable amount of power, and may cause the last camera on the line to hang.
PAGE 19
VIVOTEK Accessing the Network Camera This chapter explains how to access the Network Camera through web browsers, RTSP players, 3GPP-compatible mobile devices, and VIVOTEK recording software. Using Web Browsers Use Installation Wizard 2 (IW2) to access the Network Cameras on LAN. If your network environment is not a LAN, follow these steps to access the Netwotk Camera: 1. Launch your web browser (e.g., Microsoft® Internet Explorer or Mozilla Firefox). 2.
PAGE 20
VIVOTEK ► By default, the Network Camera is not password-protected. To prevent unauthorized access, it is highly recommended to set a password for the Network Camera. For more information about how to enable password protection, please refer to Security on page 89. ► If you see a dialog box indicating that your security settings prohibit running ActiveX ® Controls, please enable the ActiveX ® Controls for your browser. 1. Choose Tools > Internet Options > Security > Custom Level. 2.
PAGE 21
VIVOTEK IMPORTANT: • Currently the Network Camera utilizes a 32-bit ActiveX plugin. You CAN NOT open a management/view session with the camera using a 64-bit IE browser. • If you encounter this problem, try execute the Iexplore.exe program from C:\Windows\ SysWOW64. A 32-bit version of IE browser will be installed. • On Windows 7, the 32-bit explorer browser can be accessed from here: C:\Program Files (x86)\Internet Explorer\iexplore.
PAGE 22
VIVOTEK Using RTSP Players To view the streaming media using RTSP players, you can use one of the following players that support RTSP streaming. Quick Time Player VLC media player VLC media player 1. Launch the RTSP player. mpegable Player 2. Choose File > Open URL. A URL dialog box will pop up. 3.
PAGE 23
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 13. To utilize this feature, please check the following settings on your Network Camera: 1.
PAGE 24
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 25
VIVOTEK Main Page This chapter explains the layout of the main page. It is composed of the following sections: VIVOTEK INC. Logo, Host Name, Camera Control Area, Configuration Area, Menu, and Live Video Window. Resize Buttons VIVOTEK INC. Logo IB836BA Host Name Configuration Area Camera Control Area Hide Button 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 26
VIVOTEK Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 30. Configuration: Click this button to access the configuration page of the Network Camera. It is suggested that a password be applied to the Network Camera so that only the administrator can configure the Network Camera. For more information, please refer to Configuration on page 35.
PAGE 27
VIVOTEK PTZ Panel: This Network Camera supports “digital“ (e-PTZ) pan/tilt/zoom control, which allows roaming a smaller view frame within a large view frame. Please refer to PTZ settiings on page 102 for detailed information. Global View: Click on this item to display the Global View window. The Global View window contains a full view image (the largest frame size of the captured video) and a floating frame (the viewing region of the current video stream).
PAGE 28
VIVOTEK Video Control Buttons: Depending on the Network Camera model and Network Camera configuration, some buttons may not be available. Snapshot: Click this button to capture and save still images. The captured images will be displayed in a pop-up window. Right-click the image and choose Save Picture As to save it in JPEG (*.jpg) or BMP (*.bmp) format. Digital Zoom: Click and uncheck “Disable digital zoom” to enable the zoom operation.
PAGE 29
VIVOTEK Mute: Turn off the Mic volume on the local computer. The button becomes the after clicking the Mute button. Mic On button Full Screen: Click this button to switch to full screen mode. Press the “Esc” key to switch back to normal mode. ■ The following window is displayed when the video mode is set to MJPEG: Video Title Title and Time Video (HTTP-V) 2015/07/25 17:08:56 Time Video 17:08:56 2015/07/25 Video Control Buttons Video Title: The video title can be configured.
PAGE 30
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.264 Media Options Select to stream video or audio data or both. This is enabled only when the video mode is set to H.264. H.264 Protocol Options H.264 Protocol Options Depending on your network environment, there are four transmission modes of H.
PAGE 31
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 page. Here, you can specify the storage destination and file name. Start MP4 Recording on the main Folder: Specify a storage destination on your PC for the recorded video files. The location can be changed.
PAGE 32
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 33
VIVOTEK Buttons Configuration In the Button Configuration window, the left column shows the actions you can assign, and the right column shows the functional buttons and assigned actions. The number of buttons may differ from different joysticks. Please follow the steps below to configure your joystick buttons: 1. Choosing one of the actions and click Assign will pop up a dialog. Then you can assign this action to a button by pressing the joystick button or select it from the drop-down list.
PAGE 34
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 35
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 36
VIVOTEK System > General settings This section explains how to configure the basic settings for the Network Camera, such as the host name and system time. It is composed of the following two columns: System, and System Time. When finished with the settings on this page, click Save at the bottom of the page to enable the settings. System Host name: Enter a desired name for the Network Camera.
PAGE 37
VIVOTEK System time Keep current date and time: Select this option to preserve the current date and time of the Network Camera. The Network Camera’s internal real-time clock maintains the date and time even when the power of the system is turned off. Synchronize with computer time: Select this option to synchronize the date and time of the Network Camera with the local computer. The read-only date and time of the PC is displayed as updated. Manual: The administrator can enter the date and time manually.
PAGE 38
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 39
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 40
VIVOTEK ■ Follow the steps below to set up the customed homepage: 1. Click Custom on the left column. 2. Click the field where you want to change the color on the right column. Color Selector Custom Pattern 3. The palette window will pop up as shown below. 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 41
VIVOTEK System > Logs This section explains how to configure the Network Camera to send the system log to a remote server as backup. Log server settings Follow the steps below to set up the remote log: 1. Select Enable remote log. 2. 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 42
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 43
VIVOTEK Access log Access log displays the access time and IP address of all viewers (including operators and administrators) in a chronological order. The access log is stored in the Network Camera’s buffer area and will be overwritten when reaching a certain limit. System > Parameters The View Parameters page lists the entire system’s parameters. If you need technical assistance, please provide the information listed on this page.
PAGE 44
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 45
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 72). 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 46
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 the incorrect date and time are assigned, you will see the following warning message when uploading the file to the Network Camera.
PAGE 47
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 48
VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following four columns: General settings, Picture settings, Exposure, and Privacy mask. The Focus window is available only for models that come with motorized lens. General settings Video title Show_timestamp_and video_title_in_video_and_snapshots: Enter a name that will be displayed on the title bar of the live video as the picture shown below.
PAGE 49
VIVOTEK Video orientation: Flip - vertically reflect the display of the live video; Mirror - horizontally reflect the display of the live video. Select both options if the Network Camera is installed upside-down (e.g., on the ceiling) to correct the image orientation. Please note that if you have preset locations, those locations will be cleared after flip/mirror setting. Rotate - Normal Flip Mirror Rotate 90° clockwise The rotation here indicates clockwise rotation.
PAGE 50
VIVOTEK Smart IR 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. For example, if an intruder has a chance of getting near the range of 3 meters, Smart IR can effectively reduce the over-exposure. For a surveillance area at a greater distance, e.g.
PAGE 51
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 56 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 52
VIVOTEK ■ Schedule mode The Network Camera switches between day mode and night mode based on a specified schedule. Enter the start and end time for the day mode. Note that the time format is [hh:mm] and is expressed in 24-hour clock time. By default, the start and end time of day mode are set to 07:00 and 18:00. Light sensor sensitivity Tune the responsiveness of the IR filter to lighting conditions as Low, Normal, or High. When completed with the settings on this page, click Save to enable the settings.
PAGE 53
VIVOTEK Image settings On this page, you can tune the White balance and Image adjustment. Sensor Setting 2: For special situations Sensor Setting 1: For normal situations White balance: Adjust the value for the best color temperature. ■ You may follow the steps below to adjust the white balance to the best color temperature. 1. Place a sheet of paper of white or cooler-color temperature color, such as blue, in front of the lens, then allow the Network Camera to automatically adjust the color temperature.
PAGE 54
VIVOTEK Noise reduction ■ Enable noise reduction: Check to enable noise reduction in order to reduce noises and flickers in image. This applies to the onboard 3D Noise Reduction feature. Use the pull-down menu to adjust the reduction strength. Note that applying this function to the video channel will consume system computing power. 3D Noise Reduction is mostly applied in low-light conditions. When enabled in a low-light condition with fast moving objects, trails of after-images may occur.
PAGE 55
VIVOTEK Exposure On this page, you can set the Exposure measurement window, Exposure level, Exposure mode, Exposure time, Gain control, and Day/Night mode settings. You can configure two sets of Exposure settings: one for normal situations, the other for special situations, such as the day/night/schedule mode. Sensor Setting 2: For special situations Sensor Setting 1: For normal situations Measurement Window: This function allows users to set measurement window(s) for low light compensation.
PAGE 56
VIVOTEK The inclusive window refers to the “weighed window“; the exclusive window refers to “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 57
VIVOTEK ■ AE Speed Adjustment: This function applies when you need to monitor fast changing lighting conditions. For example, the camera may need to monitor a highway lane or entrance of a parking area at night where cars passing by with their lights on can bring fast changes in light levels. The same applies if the camera is installed on a vehicle, and when it needs to adapts to fast changes of light when entering and leaving a tunnel.
PAGE 58
VIVOTEK Focus (IB836BA-HT/EHT) Focus here refers to the Remote Focus, applicable to Network Cameras that are equipped with a stepping motor lens. The automated focus adjustment function eliminates the needs to physically adjust camera focus. In an outdoor deployment consisting of a large number of cameras, the auto focus function can be very helpful when these cameras become out of focus after days or weeks of operation. And that can easily result from the effects of natural forces, e.g.
PAGE 59
VIVOTEK 5. Wait for the scan to complete. After a short while, the clearest image obtained should be displayed and the optimal focus range achieved. Use the arrow marks on the sides to fine-tune the focus if you are not satisfied with the results. You may still need to use the arrow marks to fine-tune the focus depending on the live image on your screen. “>” means moving from wide to tele end; and “<” tele to wide.
PAGE 60
VIVOTEK Privacy mask Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to address privacy concerns. ■ To set the privacy mask windows, follow the steps below: 1. Click New to add a new window. 2. You can use 4 mouse clicks to create a new masking window, which is recommended to be at least twice the size of the object (height and width) you want to cover. 3. Enter a Window Name and click Save to enable the setting. 4.
PAGE 61
VIVOTEK Media > Video Stream settings This Network Camera supports multiple streams with frame sizes ranging from 176 x 144 to 2560 x 1920 pixels. The definition of multiple streams: ■ Stream 1: Users can define the "Region of Interest" (viewing region) and the "Output Frame Size" (size of the live view window). ■ Stream 2: The default frame size for Stream 2 is set to the 1600 x 1200. ■ Stream 3: The default frame size for Stream 3 is set to the 640 x 480.
PAGE 62
VIVOTEK Please follow the steps below to set up those settings for a stream: 1. Select a stream for which you want to set up the viewing region. 2. Select a Region of Interest from the drop-down list. The floating frame, the same as the one in the Gloabl View window on the home page, will resize accordingly. If you want to set up a customized viewing region, you can also resize and drag the floating frame to a desired position with your mouse. 3.
PAGE 63
VIVOTEK Click the stream item to display the detailed information. The maximum frame size will follow your settings in the above Viewing Window sections. This Network Camera offers real-time H.264 and MJPEG compression standards (Dual Codec) for real-time viewing. If the H.264 mode is selected, the video is streamed via RTSP protocol. There are several parameters through which you can adjust the video performance: ■ Frame size You can set up different video resolutions for different viewing devices.
PAGE 64
VIVOTEK The frame rate will decrease if you select a higher resolution. ■ Intra frame period Determine how often for firmware to plant an I frame. The shorter the duration, the more likely you will get better video quality, but at the cost of higher network bandwidth consumption. Select the intra frame period from the following durations: 1/4 second, 1/2 second, 1 second, 2 seconds, 3 seconds, and 4 seconds. ■ Smart stream II ■ Dynamic Intra frame period High quality motion codecs, such as H.
PAGE 65
VIVOTEK Streaming a typical 2MP scene normally requires 3~4Mb/s of bandwidth. With the Dynamic Intra frame function, the bandwidth for streaming a medium-traffic scene can be reduced to 2~3Mb/s, and during the no-traffic period of time, down to 500kb/s.
PAGE 66
VIVOTEK • Smart codec: Smart codec effectively reduces the quality of the whole or the noninterested areas on a screen and therefore reduces the bandwidth consumed. You can manually specify the video quality for the foreground and the background areas. Select an operation mode if Smart codec is preferred. - Auto tracking: The Auto mode configures the whole screen into the non-interested area. The video quality of part of the screen returns to normal when one or more objects move in that area.
PAGE 67
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 68
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 69
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 70
VIVOTEK Media > Audio Audio Settings Mute: Select this option to disable audio transmission from the Network Camera to all clients. Note that if muted, no audio data will be transmitted even if audio transmission is enabled on the Client Settings page. In that case, the following message is displayed: External microphone input: Select the gain of the external audio input according to ambient conditions. Adjust the gain from +21 db (most sensitive) or -33 db (least sensitive).
PAGE 71
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. Please rememer to click on the Save button when you complete the Network setting.
PAGE 72
VIVOTEK Primary DNS: The primary domain name server that translates hostnames into IP addresses. Secondary DNS: Secondary domain name server that backups the Primary DNS. Primary WINS server: The primary WINS server that maintains the database of computer names and IP addresses. Secondary WINS server: The secondary WINS server that maintains the database of computer names and IP addresses.
PAGE 73
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. ► 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 74
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 75
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 76
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 77
VIVOTEK Port HTTPS port: By default, the HTTPS port is set to 443. It can also be assigned to another port number between 1025 and 65535. Two way audio port: By default, the two way audio port is set to 5060. Also, it can also be assigned to another port number between 1025 and 65535. The Network Camera supports two way audio communication so that operators can transmit and receive audio simultaneously.
PAGE 78
VIVOTEK Audio is being transmitted to the Network Camera 2011/03/09 17:08:56 Video (TCP-AV) Talk Button Click Mic Volume Mute to enable audio transmission to the Network Camera; click microphone; click to turn off the audio. To stop talking, click to adjust the volume of again. FTP port: The FTP server allows the user to save recorded video clips. You can utilize VIVOTEK's Installation Wizard 2 to upgrade the firmware via FTP server. By default, the FTP port is set to 21.
PAGE 79
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 89 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 80
VIVOTEK URL command -- http://:/ For example, when the Access name for stream 2 is set to video2.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/video2.
PAGE 81
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 82
VIVOTEK Multicast settings for streams: Click the items to display the detailed configuration information. Select the Always multicast option to enable multicast for video streams. Unicast video transmission delivers a stream through point-to-point transmission; multicast, on the other hand, sends a stream to the multicast group address and allows multiple clients to acquire the stream at the same time by requesting a copy from the multicast group address.
PAGE 83
VIVOTEK Network > DDNS This section explains how to configure the dynamic domain name service for the Network Camera. DDNS is a service that allows your Network Camera, especially when assigned with a dynamic IP address, to have a fixed host and domain name. Express link Express Link is a free service provided by VIVOTEK server, which allows users to register a domain name for a network device. One URL can only be mapped to one MAC address.
PAGE 84
VIVOTEK Manual setup DDNS: Dynamic domain name service Enable DDNS: Select this option to enable the DDNS setting. Provider: Select a DDNS provider from the provider drop-down list. VIVOTEK offers Safe100.net, a free dynamic domain name service, to VIVOTEK customers. It is recommended that you register Safe100.net to access VIVOTEK’s Network Cameras from the Internet. Additionally, we offer other DDNS providers, such as Dyndns.org(Dynamic), Dyndns. org(Custom), TZO.com, DHS.
PAGE 85
VIVOTEK [Register] Successfully Your account information has been mailed to registered e-mail address 4. Select Enable DDNS and click Save to enable the setting. ■ CustomSafe100 VIVOTEK offers documents to establish a CustomSafe100 DDNS server for distributors and system integrators. You can use CustomSafe100 to register a dynamic domain name if your distributor or system integrators offer such services. 1. In the DDNS column, select CustomSafe100 from the drop-down list. 2.
PAGE 86
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 87
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 88
VIVOTEK Network > SNMP (Simple Network Management Protocol) This section explains how to use the SNMP on the network camera. The Simple Network Management Protocol is an application layer protocol that facilitates the exchange of management information between network devices. It helps network administrators to remotely manage network devices and find, solve network problems with ease.
PAGE 89
VIVOTEK Security > User accounts This section explains how to enable password protection and create multiple accounts. Root Password The administrator account name is “root”, which is permanent and can not be deleted. If you want to add more accounts in the Manage User column, please apply the password for the “root” account first. 1. Type the password identically in both text boxes, then click Save to enable password protection. 2.
PAGE 90
VIVOTEK Security > HTTPS (Hypertext Transfer Protocol over SSL) This section explains how to enable authentication and encrypted communication over SSL (Secure Socket Layer). It helps protect streaming data transmission over the Internet on higher security level. Create and Install Certificate Method Before using HTTPS for communication with the Network Camera, a Certificate must be created first.
PAGE 91
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. https:// https://192.168.5.151/index.
PAGE 92
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 93
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 94
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 95
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 96
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 97
VIVOTEK Security > Access List This section explains how to control access permission by verifying the client PC’s IP address. General Settings Maximum number of concurrent streaming connection(s) limited to: Simultaneous live viewing for 1~10 clients (including stream 1 to stream 3). The default value is 10. If you modify the value and click Save, all current connections will be disconnected and automatically attempt to re-link (IE Explorer or Quick Time Player).
PAGE 98
VIVOTEK ■ Refresh: Click this button to refresh all current connections. ■ Add to deny list: You can select entries from the Connection Status list and add them to the Deny List to deny access. Please note that those checked connections will only be disconnected temporarily and will automatically try to re-link again (IE Explore or Quick Time Player). If you want to enable the denied list, please check Enable access list filtering and click Save in the first column.
PAGE 99
VIVOTEK There are three types of rules: Single: This rule allows the user to add an IP address to the Allowed/Denied list. For example: 192.168.2.1 Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List. The address and network mask are written in CIDR format. For example: IP address range 192.168.2.x will be bolcked. If IPv6 filter is preferred, you will be prompted by the following window.
PAGE 100
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 101
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 102
VIVOTEK PTZ > PTZ settings This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation. Digital: Control the e-PTZ operation. Within a field of view,it allows users to quickly move the focus to a target area for close-up viewing without physically moving the camera. Digital PTZ Operation (E-PTZ Operation) The e-PTZ control settings section will be displayed as shown below: 2015/05/20 09:57:30 x1.8 x1.8 For e-PTZ related details, please refer to page 104.
PAGE 103
VIVOTEK Home page in the E-PTZ Mode x3.3 ■ The e-Preset Positions will also be displayed on the home page. Select one from the drop-down list, and the Network Camera will move to the selected position. ■ If you have set up different preset positions for different streams, you can select one of the video streams to display its separate preset positions.
PAGE 104
VIVOTEK Patrol settings You can select some preset positions for the Network Camera to patrol. Please follow the steps below to set up a patrol schedule: 1. Select the preset locations on the list, and click . 2. The selected preset locations will be displayed on the Patrol locations list. 3. Set the Dwelling time for the preset location during an auto patrol. 4. If you want to delete a preset location from the Patrol locations list, select it and click Remove. 5.
PAGE 105
VIVOTEK NOTE: ► The Preset Positions will also be displayed on the Home page. Select one from the Go to menu, and the Network Camera will move to the selected preset position. ► Click Patrol: The Network Camera will patrol along the selected positions repeatedly.
PAGE 106
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 107
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 event after seconds: Enter the duration in seconds to pause motion detection after a motion is detected. This can prevent event-related actions to take place too frequently. 1.
PAGE 108
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 109
VIVOTEK Once the triggers are configured, they will be listed under the VADP option. 3. Action Define the actions to be performed by the Network Camera when a trigger is activated. ■ Trigger digital output for seconds Select this option to turn on the external digital output device when a trigger is activated. Specify the length of the trigger interval in the text box. ■ Backup media if the network is disconnected Select this option to backup media file on SD card if the network is disconnected.
PAGE 110
VIVOTEK Add server It is necessary to configure the server and media settings so that the Network Camera will know what action to take (such as which server to send the media files to) when a trigger is activated. Click Add server to open the server setting window. You can specify where the notification messages are sent to 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.
PAGE 111
VIVOTEK To verify if the email settings are correctly configured, click Test. The result will be shown in a pop-up window. If successful, you will also receive an email indicating the result. Click Save server to enable the settings. Note that after you configure the first event server, the new event server will automatically display on the Server list. If you wish to add other server options, click Add server. Server type - FTP Select to send the media files to an FTP server when a trigger is activated.
PAGE 112
VIVOTEK ■ Passive mode Most firewalls do not accept new connections initiated from external requests. If the FTP server supports passive mode, select this option to enable passive mode FTP and allow data transmission to pass through the firewall. The firmware default has the Passive mode checkbox selected. To verify if the FTP settings are correctly configured, click Test. 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 113
VIVOTEK Network storage: Select to send the media files to a networked storage when a trigger is activated. Please refer to NAS server on page 133 for details. Note that only one NAS server can be configured. Click Save server to enable the settings. ■ SD Test: Click to test your SD card. The system will display a message indicating the result as a success or a failure. If you want to use your SD card for local storage, please format it before use. Please refer to page 115 for detailed information.
PAGE 114
VIVOTEK Click 20150120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2015/01/20 2015/01/20 Click to go back to the previous level of the directory Click to delete selected items Click to delete all recorded data 2015/01/20 2015/01/20 The format is: File name prefix + Minute (mm) You can set up the file name prefix on Add media page. Please refer to next page for detailed information.
PAGE 115
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 116
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_20150513_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings. Note that after you set up the first media server, a new column for media server will automatically display on the Media list. If you wish to add more media options, click Add media.
PAGE 117
VIVOTEK ■ Maximum file size Specify the maximum file size allowed. Some users may need to stitch the video clips together when searching and packing up forensic evidence. ■ File name prefix Enter the text that will be appended to the front of the file name. For example: Video_20150513_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings. Media type - System log Select to send a system log when a trigger is activated.
PAGE 118
VIVOTEK In the Event settings column, the Servers and Medias you configured will be listed; please make sure the Event -> Status is indicated as ON, in order to enable the event triggering action. When completed, click the Save event button to enable the settings and click Close to exit Event Settings page. The new Event / Server settings / Media will appear in the event drop-down list on the Event setting page.
PAGE 119
VIVOTEK Customized Script This function allows you to upload a sample script (.xml file) to the camera, which will save your time on configuring the settings. Please note that there is a limited number of customized scripts you can upload; if the current amount of customized scripts has reached the limit, an alert message will prompt. If you need more information, please contact VIVOTEK technical support.
PAGE 120
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: 1. Click New to add a new motion detection window. 2. In the Window Name text box, enter a name for the motion detection window.
PAGE 121
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 106. 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 122
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 131 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 123
VIVOTEK Applications > DI and DO Digital input: Select High or Low as the Normal status for the digital input connection. 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 124
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 125
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 126
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 127
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 128
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 129
VIVOTEK On the License page, use the Manual or Automatic to register and activate the license for using VIVOTEK's VADP modules. The Automatic method requires an Internet connection. Without Internet connection, 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. You can proced with the following link to download a license key: http://www.vivotek.com/ vadp_requestactivation.
PAGE 130
VIVOTEK Recording > Recording settings This section explains how to configure the recording settings for the Network Camera. Recording Settings Insert your SD card and click here to test NOTE: ► Please remember to format your SD card via the camera’s web console (in the Local storage . SD card management page) when using it for the first time. Please refer to page 135 for detailed information. Recording Settings Click Add to open the recording setting window.
PAGE 131
VIVOTEK If you enable adaptive recording on a camera, only when an event is triggered on Camera A will the server record the full frame rate streaming data; otherwise, it will only request the I frame data during normal monitoring, thus effectively saves bandwidths and storage space. NOTE: ► To enable adaptive recording, please make sure you’ve set up the trigger source such as Motion Detection, DI Device, or Manual Trigger.
PAGE 132
VIVOTEK 2. Destination You can select the SD card or network storage (NAS) for the recorded video files. If you have not configured a NAS server, see details in the following. NAS server Click Add NAS server to open the server setting window and follow the steps below to set up: 1. Fill in the information for your server. For example: 3 Network storage path (\\server name or IP address\folder name) 1 2 4 User name and password for your server 2. Click Test to check the setting.
PAGE 133
VIVOTEK If successful, you will receive a test.txt file on the network storage server. 3. Enter a server name. 4. Click Save to complete the settings and click Close to exit the page. ■ Capacity: You can choose either the entire free space available or limit the reserved space. The recording size limit must be larger than the reserved amount for cyclic recording. ■ Enable cyclic recording: If you check this item, when the maximum capacity is reached, the oldest file will be overwritten by the latest one.
PAGE 134
VIVOTEK f you want to enable recording notification, please click Event to configure event triggering settings. Please refer to Event > Event settings on page 106 for more details. When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page. When the system begins recording, it will send the recorded files to the network storage. The new recording name will appear in the drop-down list on the recording page as shown below.
PAGE 135
VIVOTEK Local storage > SD card management 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.
PAGE 136
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 137
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 138
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 139
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 140
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 141
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 142
VIVOTEK http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http:///cgi-bin/anonymous/setparam.cgi? = [&=…][&update=][&return=] http:///cgi-bin/viewer/setparam.
PAGE 143
VIVOTEK 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. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123 Response: HTTP/1.
PAGE 144
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 145
VIVOTEK W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 available The API is listed in product WebAPIs. non-available The API is not in product WebAPIs. valid The API is listed in product WebAPIs, and is functional. non-valid The API is listed in product WebAPIs, but is malfunction in this status. Any decimal number expressed in 32-bits ranging from 1.18e-38~3.40e+38. NOTE: The camera should not be restarted when parameters are changed.
PAGE 146
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 147
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 148
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 149
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 150
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 151
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 152
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 153
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 154
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 155
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 156
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 157
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 158
VIVOTEK number (httpversion) is equal or greater than 0304a. audioipaddress 4/4 Multicast audio IP address. * We support this parameter when the version number (httpversion) is equal or greater than 0304a. * Only available when capability_naudioin > 0 metadataipaddress 4/4 Multicast metadata IP address. * We support this parameter when the version number (httpversion) is equal or greater than 0304a. videoport 1025 ~ 65535 4/4 Multicast video port.
PAGE 159
VIVOTEK pass password[64] 6/6 PPPoE account password. VALUE SECURITY DESCRIPTION 7.7 IP Filter Group: ipfilter NAME (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 160
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 161
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 162
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 163
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 164
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 165
VIVOTEK "capability_image_c_exposure_ Gain. modetype") "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 166
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 167
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 168
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 169
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 170
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, 1/4 Codec type for this stream 1/4 Video resolution in pixels. 4/4 Enable "Dynamic intra frame period".
PAGE 171
VIVOTEK "qpercent" 99: Use the quality level in "qvalue" * Only valid when "ratecontrolmode"= vbr. s<0~(m-1)>_h 0~51 4/4 264_qvalue Manual video quality level input. The Q value which is used by encoded library 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.
PAGE 172
VIVOTEK 0 s<0~(m-1)>_h 1~100 4/4 Select customized quality in a 264_cbr_qperce normalized full range. nt 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"= 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 173
VIVOTEK The unit is millisecond (ms). * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_h cbr, vbr 4/4 cbr: Constant bit rate mode. 265_ratecontrol vbr: Fixed quality mode, all frames are mode encoded in the same quality. * Only available when h265 is listed in "capability_videoin_codec".
PAGE 174
VIVOTEK * Only valid when "ratecontrolmode"= vbr and "quant"= 100. s<0~(m-1)>_h 20000~"capability_videoin_c_h2 265_maxvbrbitr 65_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. * Only available when h265 is listed in "capability_videoin_codec".
PAGE 175
VIVOTEK 265_bitrate 65_maxbitrate" mode. * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= cbr s<0~(m-1)>_h framerate,imagequality 4/4 Set prioritypolicy 265_prioritypoli cy * Only available when h265 is listed in "capability_videoin_codec".
PAGE 176
VIVOTEK 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue" s<0~(m-1)>_m 10~200 4/4 Manual video quality level input. The Q jpeg_qvalue (Only valid when value which is used by encoded library "capability_api_httpversion" format is directly.
PAGE 177
VIVOTEK "ratecontrolmode"= cbr. * Only available when "capability_smartstream_version"="2 .0" s<0~(m-1)>_m 1~100 4/4 Select customized quality in a jpeg_cbr_qperc normalized full range. ent 1: Worst quality 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 178
VIVOTEK "capability_image_c_wdrc_mode " is 1 wdrc_strength 1~100 4/4 The strength of WDR enhanced. strength of WDR enhanced. * Only available when "capability_image_c_wdrc_mode " is 1 aespeed_mode 4/4 Turning AE converge speed on or off.
PAGE 179
VIVOTEK "capability_image_c_aespeed" is 1 and "capability_image_c_aespeedsup portsensitivity" is 1.
PAGE 180
VIVOTEK Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h265_smartstream2 (capability_smartstream_support=1, capability_smartstream_version=2.
PAGE 181
VIVOTEK (capability_smartstream_support=1, capability_smartstream_version=2.0 and h265 is listed in "capability_videoin_codec" and capability_smartstream_mode_manual = 1) n denotes the value of "capability_nvideoin",m denotes the value of " capability_nmediastream",k denotes the value of "capability_smartstream_nwindow_manual". NAME VALUE SECURITY DESCRIPTION (get/set) enable 4/4 Enable or disable the window. home 0~320,0~240 4/4 Left-top corner coordinate of the window.
PAGE 182
VIVOTEK "irismode"=fixed * Only available when "capability_image_c_exposure_rangetyp e" is "twovalues". maxexposure <1~32000>, 4/4 Maximum 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 183
VIVOTEK * Only available when "capability_image_c_exposure_maxrang e" != "-" and "capability_image_c_exposure_rangetyp e" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. enableblc 4/4 Enable backlight compensation. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c_mode" to switch on/off BLC.
PAGE 184
VIVOTEK "capability_image_c Gain and Shutter speed. _exposure_mo "manual": Adjust with variable Shutter, Iris detype") and Gain. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. 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.
PAGE 185
VIVOTEK "capability_image_c_wbmode". * Only valid when "videoin_c_whitebalance" != auto * Normalized range. maxgain 0~100 4/4 Maximum gain value. 0: Low <-> 100: High * Only available when "capability_image_c_agc_maxgain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c_exposure_rangetyp e" is "twovalues". mingain 0~100 4/4 Minimum gain value.
PAGE 186
VIVOTEK "outdoor": Auto-setting P-Iris to get best outdoor,- quality, but easy to meet rolling or flicker effect in indoor environment. "indoor": Avoid rolling and flicker effect first. "manual": Manual set P-Iris by "piris_position". "-": not support (only available when "capability_image_c<0~(n-1)>_sensortype" is "smartsensor") * Only available when "capability_image_c_iristype"=piris piris_position 1~100 1/4 Manual set P-Iris.
PAGE 187
VIVOTEK wdrc_strength 1~100 4/4 The strength of WDR enhanced. The bigger value means the stronger strength of WDR enhanced. * Only available when "capability_image_c_wdrc_mode" is 1 aespeed_mode 4/4 Turning AE converge speed on or off. 0: off 1: on * Only available when "capability_image_c_aespeed" is 1 aespeed_speedlevel 1~100 4/4 The speed level of AE converge speed.
PAGE 188
VIVOTEK 7.9 Time Shift settings Group: timeshift for n channel profucts and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" (capability.timeshift > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable 4/4 Enable time shift streaming. c<0~(n-1)>_s<0~(m-1) 4/4 Enable time shift streaming for specific >_allow stream. 7.10 IR cut control Group: ircutcontrol (capability.
PAGE 189
VIVOTEK "capability_daynight "capability_daynight_c<0~"capability_nvideoi _c_extled_inter n"-1>_externalir" is 1. face" * Only valid when "ircutcontrol_enableextled" is 1. bwmode 6/6 Switch to B/W in night mode if enabled sensitivity low, normal, high 6/6 Sensitivity of day/night control.
PAGE 190
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 191
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 192
VIVOTEK Internal module will take the closest valid one. For example, 1~45 may all be mapped to gamma value = 0.45, etc. * Only available when "capability_image_c_gammacurve" is 1 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 193
VIVOTEK scene_enable 4/4 Enable/disable scene mode 0: disable 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 freeze
PAGE 194
VIVOTEK 100: Use " image_c_contrastpercent" * 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.
PAGE 195
VIVOTEK * Only available when bit 1 of "capability_image_c_basicsetting" is 1 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.
PAGE 196
VIVOTEK * Only available when "capability_image_c_defog_mode" is 1 profile_i<0~(m-1)>_defog_str 1~100 4/4 Strength of defog ength * Only available when "capability_image_c_defog_mode" is 1 profile_i<0~(m-1)>_eis_mode 4/4 Electronic image stabilizer 0:disable 1:enable * Only available when 'eis' is listed in "capability_image_c_is_mode".
PAGE 197
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,hlc 4/4 "auto": Use full image view as the only exposure window. * Available values are listed in "custom": Use custom windows.
PAGE 198
VIVOTEK 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". 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.
PAGE 199
VIVOTEK k denotes the value of "capability_image_c_exposure_winnum". (Only available when custom is listed in "capability_image_c_exposure_winmode" and valid when "exposurewin_c_mode"=custom or "exposurewin_c_mode"=hlc) NAME VALUE SECURITY DESCRIPTION (get/set) enable 4/4 Enable or disable the window. policy 0~1 4/4 0: Indicate exclusive. 1: Indicate inclusive. * Only available when exclusive is listed in "capability_image_c_exposure_wintype".
PAGE 200
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 201
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 202
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 203
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 204
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 205
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 206
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 207
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 208
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 209
VIVOTEK "threshold" for more than "duration" second(s), then image too bright detection is triggered. blurry_enable 4/4 Enable or disable image too blurry detection blurry_threshold 0~100 4/4 Threshold of image too blurry detection blurry_duration 1~10 4/4 If image too blurry value exceeds the "threshold" for more than "duration" second(s), then image too blurry detection is triggered. 7.16 DDNS Group: ddns (capability.protocol.
PAGE 210
VIVOTEK 7.17 Express link Group: expresslink PARAMETER VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable or disable express link. state onlycheck, 6/6 Camera will check the status of network onlyoffline, environment and express link URL checkonline, badnetwork url string[64] 6/6 The url user define to link to camera 7.
PAGE 211
VIVOTEK 7.20 System log Group: syslog NAME VALUE SECURITY DESCRIPTION (get/set) enableremotelog 6/6 Enable remote log. serverip 6/6 Log server IP address. serverport 514, 1025~65535 6/6 Server port used for log. level 0~7 6/6 Levels used to distinguish the importance of the information: 0: LOG_EMERG 1: LOG_ALERT 2: LOG_CRIT 3: LOG_ERR 4: LOG_WARNING 5: LOG_NOTICE 6: LOG_INFO 7: LOG_DEBUG setparamlevel 0~2 6/6 Show log of parameter setting.
PAGE 212
VIVOTEK authtyperw MD5,SHA 6/6 Read/write authentication type authtypero MD5,SHA 6/6 Read only authentication type encryptpwrw string[8~128] 6/6 Read/write passwrd encryptpwro string[8~128] 6/6 Read only password encrypttyperw DES 6/6 Read/write encryption type encrypttypero DES 6/6 Read only encryption type rwcommunity string[31] 6/6 Read/write community rocommunity string[31] 6/6 Read only community syslocation string[128] 6/6 System location syscontact string[128] 6/
PAGE 213
VIVOTEK round theme_color_videobackgr string[7] 1/6 Background color of video area. string[7] 1/6 Frame color ound theme_color_case 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.
PAGE 214
VIVOTEK "capability_image_c_privacymask_windomai n win_i<0~(m-1)>_polygonpx 0 ~ W,0 ~ H, 0 4/4 Coordinate of polygon window position. ~ W,0 ~ H, 0 (4 points: x0,y0,x1,y1,x2,y2,x3,y3) ~ W,0 ~ H, 0 * Only available when ~ W,0 ~ H "capability_image_c_privacymask_wintype" W: 0~ The = polygon.
PAGE 215
VIVOTEK win_i<0~(m-1)>_tilt win_i<0~(m-1)>_zoom "capability_ptz_c<0~(n-1)> 4/4 Tilt position of window position. _mintilt" ~ * Only available when bit1 of "capability_ptz_c<0~(n-1)> "capability_camctrl_c<0~(n-1)>_buil _maxtilt" dinpt" is "1" "capability_ptz_c<0~(n-1)> 4/4 Zoom position of window position. 4/4 Flip side of window position. _minzoom" ~ "capability_ptz_c<0~(n-1)> _maxzoom" win_i<0~(m-1)>_fliped 0: Non-flip side 1: Flip side 7.
PAGE 216
VIVOTEK API version format: MMmmr_k Where "MM" is the major version, "mm" is the minor version and "r" is the revision. 'M' and 'm' and 'k' are decimal digit from 0 to 9, while 'r' is an alphabetic. EX: 0302b_1 => Major version = 03, minor version = 02, revision = b, platform = 1 The 4 integer numbers are WebAPI version, we use short name: [httpversion] for it in this document. The 5th character is model-based version for API bug-fix and it's default to "a".
PAGE 217
VIVOTEK nvideoin 0/7 Number of video inputs. nvideoout 0, nvideoinprofile 0/7 Number of video input profiles. nmediastream 0/7 Number of media stream per channels. naudiosetting 0/7 Number of audio settings per channel. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.
PAGE 218
VIVOTEK Bit 7 => External or built-in PT; 0(built-in), 1(external) windowless 0/7 Indicate whether to support windowless plug-in. evctrlchannel 0/7 Indicate whether to support HTTP tunnel for event/control transfer. joystick 0/7 Indicate whether to support joystick control. remotefocus 0, 0/7 An 4-bit integer, which indicates the supportive
PAGE 219
VIVOTEK Ex: nvideoin = 2, bit 0~15 are the 1st group for 1st channel, bit 16~31 are the 2nd group for 2nd channel. nvideoin = 3, bit 0~9 are the 1st group for 1st channel, bit 10~19 are the 2nd group for 2nd channel, bit 20~31 are the 3rd group for 3rd channel. Then, the 1st bit of the group indicates 1st stream of a channel support ePTZ or not. The 2nd bit of the group indicates 2nd stream of a channel support ePTZ or not, and so on. * For most products, the last stream of a channel will not support ePTZ.
PAGE 220
VIVOTEK volalarm,temperatu "boot" = System boot re,pir, visignal, "motion" = Video motion detection backup,smartsd "networkfail" = network connection failure "tampering" = Tamper detection. "vi" = Virtual input (Manual trigger) "vadp" = VADP trigger "di"= Digital input "volalarm" = Audio detection "temperature" = Temperature detection "pir" = PIR detection "visignal" = Video input signal loss.
PAGE 221
VIVOTEK protocol_qos_dscp 0/7 Indicate whether to support QoS/DSCP. protocol_ddns 0/7 Indicate whether to support DDNS. videoin_type 0, 1, 2 0/7 0 => Interlaced CCD 1 => Progressive CCD 2 => CMOS videoin_nresolution 0/7 This equals "capability_videoin_c0_nresolution". * This is kept for compatibility. videoin_resolution A list of 0/7 * This is kept for compatibility.
PAGE 222
VIVOTEK flexible bit rate control. videoout_codec -, ntsc, pal 0/7 Current output information about video out. 1st element for 1st video-out, 2nd element for 2nd video-out, and so on. The number of element depends on "capability_nvideooout".
PAGE 223
VIVOTEK Integer> 0: Not support 1: Support Bit 0 for CH0, bit 1 for CH1, and so on. audio_alarm <0~Positive 0/7 Integer> 0: Not support audio alarm. 1: Support audio alarm. Bit 0 for CH0, bit 1 for CH1, and so on. audio_linein 0/7 Indicate whether to support external line input. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * It will be replaced by audio_intmic and audio_extmic.
PAGE 224
VIVOTEK image. px: Locate a window in the image with pixels. std: A normalized 0~9999 range. -: Not supported. smartstream_support 0/7 Indicate whether smart stream is supported. smartstream_version 0/7 Number of smart stream version smartstream_nstream 0/7 Number of stream that support smart stream. *only available when "capability_smartstream_support" is 1 smartstream_windomain qvga, px, std, - 0/7 The domain to set an focus window.
PAGE 225
VIVOTEK *only available when "capability_smartstream_support" is 1 smartstream_nwindow_h 0/7 ybrid_manual Maximum number of tracking window of manual in hybrid mode.
PAGE 226
VIVOTEK number (httpversion) is equal or greater than 0301b. This equals "capability_camctrl_c0_ptztunnel". * This is kept for compatibility. camctrl_privilege 0/7 Indicate whether to support “Manage Privilege” of PTZ control in the security page. 1: support both /cgi-bin/camctrl/camctrl.cgi and /cgi-bin/viewer/camctrl.cgi 0: support only /cgi-bin/viewer/camctrl.cgi This is equivalent to"capability_camctrl_c0_privilege". * This is kept for compatibility.
PAGE 227
VIVOTEK version_onvifdaemon 0/7 Indicate ONVIF daemon version version_onviftesttool 0/7 Indicate ONVIF test tool version media_totalspace 0/7 Available memory space (KB) for media. media_snapshot_maxpre 0/7 Maximum snapshot number before event event media_snapshot_maxpost occurred. 0/7 event Maximum snapshot number after event occurred.
PAGE 228
VIVOTEK localstorage_stormgrversi 0/7 Indicate storage manager daemon version 0, 0/7 An 32-bit integer, which indicates the on localstorage_supportedge supportive application of edge storage. If the value of this parameter is larger than 0, it means that the camera supports edge recording function. bit 0 : It supports to record directly to an on-board SD-Card. bit 1~: Currently, they are reserved bit, and the default value is 0.
PAGE 229
VIVOTEK privilege 0/7 Indicate whether to support “Manage Privilege” of PTZ control in the security page in this video input. 1: support both /cgi-bin/camctrl/camctrl.cgi and /cgi-bin/viewer/camctrl.cgi 0: support only /cgi-bin/viewer/camctrl.
PAGE 230
VIVOTEK focusmode auto,onetimeauto,spo 0/7 Focus mode selection: tlight,manual "auto": Camera will automatically adjust the focus position full time to adapt a clear picture. "onetimeauto": Camera will automatically adjust the focus position one time, which follows any PTZ control. "spotlight": Camera will automatically adjust the focus position full time, and to consider a spotlight avoidance situation. "manual": Turn off the automatically focus function.
PAGE 231
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 232
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 233
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" "-":not support * 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 234
VIVOTEK Group: capability_videoin_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) lens_type fisheye, fixed, 0/7 The lens type of this channel. varifocal, changeable, fisheye: Fisheye lens motor, - fixed: Build‐in fixed‐focus lens. varifocal: Build‐in varifocal lens. changeable: changeable lens. Like box‐type camera, users can install any C‐Mount or CS‐Mount lens as they wish.
PAGE 235
VIVOTEK rotationaffect 0/7 When rotation is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here. The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value.
PAGE 236
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 237
VIVOTEK maxframerate A list of 0/7 Indicate frame rate that the video source outputs in current video mode. 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 238
VIVOTEK h264_maxframerate A list of and "-" Maximum fps that the device can encoded with H.264 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 239
VIVOTEK fisheye_mounttype ceiling, wall, floor 0/7 Indicate the supported type.
PAGE 240
VIVOTEK resolutionC4R A list of 0/7 Available resolutions of 4R mode of ceiling and floor mount. resolutionW1P A list of 0/7 Available resolutions of 1P mode of wall mount. resolutionW1R A list of 0/7 Available resolutions of 1R mode of wall mount. resolutionW4R A list of 0/7 Available resolutions of 4R mode of wall mount.
PAGE 241
VIVOTEK wdrpro 0, 1, 2 0/7 Indicate this mode whether support WDR pro. 0: Non-support WDR Pro 1: Support WDR Pro 2: Support WDR Pro and WDR Pro II * We support this parameter when the version number (httpversion) is equal or greater than 0304b. 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.
PAGE 242
VIVOTEK resolution A list of 0/7 Resolution options in this video mode. The last one is the maximum resolution in this video mode. * The element number is defined as "nresolution" in this group. maxresolution A list of 0/7 Represent supported maximum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream". minresolution A list of 0/7 Represent supported minimum resolution of each stream in current video mode.
PAGE 243
VIVOTEK maxfps_h264 A list of and "-" H.264 on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group. * This parameter records the frame rate when "videoin_c_cmosfreq"=60 or "videoin_c_modulation"=ntsc * Only available when 'h264' is listed in "capability_videoin_codec".
PAGE 244
VIVOTEK wdrpro_strength 0, 1 0/7 0: Non-support tuning strength of WDR Pro 1: Support tuning strength of WDR Pro * If "capability_image_c_wdrpro"=1, this may be either 0 or 1. wdrpro_supportlevel 0, 0/7 This contains a list of positive integers, split by comma. If "wdrpro_mode" =1, then the value indicate the support strength level of WDR Pro.
PAGE 245
VIVOTEK "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. For example: "exposurelevel:fixed:6/8/12" which means exposurelevel is fixed to level 6, level 8 and level 12. "-" means no feature is affected.
PAGE 246
VIVOTEK : nonnegative integer - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled.
PAGE 247
VIVOTEK or greater than 0302a. is_strength 0/7 0: Non-support tuning strength of image stabilizer mode. 1: Support tuning strength of image stabilizer mode. * Only available when "capability_image_c_is_mode" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. is_supportlevel 0, 0/7 Indicate the support strength level of image stabilizer mode. * Only available when "capability_image_c_is_mode" is not "-".
PAGE 248
VIVOTEK value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected.
PAGE 249
VIVOTEK name":"Policy":"Description" : 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. - (enabled) : UI is checked. - (notsupport) : the affected function is not available.
PAGE 250
VIVOTEK 3dnr:unchanged:, or others The format is "Affect API name":"Policy":"Description" : 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. - (enabled) : UI is checked.
PAGE 251
VIVOTEK 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":"Description" : 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 252
VIVOTEK 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. 3dnr:unchanged:,or others The format is "Affect API : nonnegative integer name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it.
PAGE 253
VIVOTEK "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 254
VIVOTEK 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". * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
PAGE 255
VIVOTEK : 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. - (enabled) : UI is checked. - (notsupport) : the affected function is not available.
PAGE 256
VIVOTEK 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":"Description" : 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 257
VIVOTEK exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_irisprioritymod -, 0/7 When exposure iris priority mode is e_affect exposurewin.mode.blc:hidd enabled, some features may become en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here.
PAGE 258
VIVOTEK "-" means no feature is affected. * Only available when irispriority is listed in "capability_image_c_ exposure_modetype" and "capability_image_c_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_manualmode_a -, 0/7 When exposure manual mode is ffect exposurewin.mode.blc:hidd enabled, some features may become en:, malfunction or be forced to a given defog:disabled:, value.
PAGE 259
VIVOTEK well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when manual is listed in "capability_image_c_ exposure_modetype" and "capability_image_c_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
PAGE 260
VIVOTEK - (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. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled.
PAGE 261
VIVOTEK -: Not supported. exposure_windomain qvga, px, std, - 0/7 The domain to set an exposure window. qvga: a 320x240 range to represent the whole image. px: Locate a window in the image with pixels. std: A normalized 0~9999 range. -: Not supported. exposure_winnum 0, 0/7 Indicate the number of custom exposure windows. * If no " custom" is listed in "exposure_winmode", this should be 0.
PAGE 262
VIVOTEK * When "exposure_mode"=0, this value must be set to "-". privacymask_wintype rectangle, 0/7 The supported mask window type. polygon, polygon: The window is a 2D polygon 3Drectangle shape. rectangle: The window is a 2D rectangle shape. 3Drectangle: The window is a 3D rectangle shape. privacymask_windomain qvga, px, std, - 0/7 The domain to set an 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.
PAGE 263
VIVOTEK 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. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled.
PAGE 264
VIVOTEK strength level of defog. defog_affect -, 0/7 When defog is enabled, some features wdrpro:unchanged:, may become malfunction or be forced or others to a given value. The affected functions are list here. : nonnegative integer The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it.
PAGE 265
VIVOTEK "-" aespeed 0,1 0/7 0: Non-support AE speed 1: Support AE speed aespeedsupportlevel 0/7 The value indicate the support strength level of aespeed. * Only available when "capability_image_c_aespeed" is 1. gammacurve 0,1 0/7 0: Non-support tuning Gamma curve 1: Support tuning Gamma curve lowlightmode -,0,1 0/7 -: Internal parameter, must not open to user.
PAGE 266
VIVOTEK image library configuration files for specific exchangeable lens. freeze 0/7 0: Non-support image freeze feature 1: Support image freeze feature * We support this parameter when the version number (httpversion) is equal or greater than 0302a. autotrack_support 0/7 0: Non-support auto tracking feature 1: Support auto tracking feature * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
PAGE 267
VIVOTEK 7.26 Customized event script Group: event_customtaskfile_i<0~2> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] 6/6 Custom script identification of this entry. date string[4~20] 6/6 Date of custom script. time string[4~20] 6/6 Time of custom script. 7.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.
PAGE 268
VIVOTEK di 0, 6/6 Indicate the source id of di trigger. This field is required when trigger condition is “di”. One bit represents one digital input. The LSB indicates DI 0. 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.
PAGE 269
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 270
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_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0 action_autotrack_enable 6/6 Enable/disable auto tracking on event triggerd.
PAGE 271
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 272
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 273
VIVOTEK maxretentiontime 6/6 To specify the expired time for automatic clean up, and it only takes effect for video clip generated by recording_i <0~1>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss]S’ , similar with ISO8601 with symbols P Ex. P7D, it means 7 days. P1DT10H, it means 1 days and 10 hours. The parameter takes effect when autocleanup_ maxretentiontime_recording_enabled is enabled.
PAGE 274
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 Start time of the weekly schedule. endtime hh:mm 6/6 End time of the weekly schedule. (00:00~24:00 indicates schedule always on) prefix string[16] 6/6 Indicate the prefix of the filename.
PAGE 275
VIVOTEK 7.31 HTTPS Group: https (capability.protocol.https > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 To enable or disable secure HTTP. policy 6/6 If the value is 1, it will force HTTP connection redirect to HTTPS connection method auto, 6/6 auto =>Create self-signed certificate manual, automatically. install manual =>Create self-signed certificate manually. install =>Create certificate request and install.
PAGE 276
VIVOTEK 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. autocleanup_enabled 6/6 Enable automatic clean up method. deleted.
PAGE 277
VIVOTEK 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. P1DT10H, it means 1 days and 10 hours. The parameter takes effect when autocleanup_ maxretentiontime_recording_enabled is enabled.
PAGE 278
VIVOTEK 7.33 Region of interest Group: roi_c<0~(n-1)> for n channel product and m is the index of video stream which support ePTZ. (capability.eptz > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-1)>_home 1/6 ROI left-top corner coordinate.* If the minimal window size is 64x64, then the "win_i0_home"=(0~resolution_W-64, 0~resolution_H-64), which the resolution is the value in current stream.
PAGE 279
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 280
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 281
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 282
VIVOTEK storage size. number string[128] 6/7 This number is used to register license key for VADP application. Group: vadp_module_i<0~(n-1)> for n VADP package number (capability_vadp_npackage > 0) n denotes the value of "capability_vadp_npackage". NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Indicate if the module is enabled or not. If yes, also add the index of this module to the module_order.
PAGE 283
VIVOTEK begintime hh:mm 6/6 Begin time of the schedule endtime hh:mm 6/6 End time of the schedule VALUE SECURITY Group: vadp_event NAME DESCRIPTION (get/set) ntrigger 0, 6/7 Indicate the number of topics to be transferred to event manager for trigger. triggerlist_i<0~(n-1)>_to string[256] 6/6 pic Indicate the event notification with this topic will be transferred to event manager as trigger. n is equal to ntrigger above. 7.
PAGE 284
VIVOTEK isptz 0~2 1/4 0: disable PTZ commands. 1: enable PTZ commands with PTZ driver. 2: enable PTZ commands with UART tunnel. * Only available when bit7 of capability_ptzenabled is 1 disablemdonptz 1/4 Disable motion detection on PTZ operation. 7.
PAGE 285
VIVOTEK (capability.nuart>0). isptz 0~2 1/4 0: disable PTZ commands. 1: enable PTZ commands with PTZ driver. 2: enable PTZ commands with UART tunnel. * Only available when bit7 of capability_ptzenabled is 1 preset_i<0~(k-1)>_name string[40] 1/4 Name of the preset location. preset_i<0~(k-1)>_zoom capability_ptz_c<0~(n-1) 1/4 Zoom position at each preset location. 1/4 Focus position at each preset location.
PAGE 286
VIVOTEK 7.40 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 287
VIVOTEK >_maxtilt preset_i<0~(k-1)>_zoom capability_ptz_c<0~(n-1) 1/4 Zoom position at each preset location. 1/4 Focus position at each preset location. >_minzoom ~ capability_ptz_c<0~(n-1) >_maxzoom preset_i<0~(k-1)>_focus capability_ptz_c<0~(n-1) >_minfocus ~ capability_ptz_c<0~(n-1) >_maxfocus preset_i<0~(k-1)>_fliped 1/4 Flip side at each preset location.
PAGE 288
VIVOTEK idleaction_enable 1/4 Enable/disable idle action while idle idleaction_type pan,patrol,home,objtrack, 1/4 This field tells what kind of action should prev idleaction_interval be taken while idle. 1~999 1/4 While idle over this time interval, idle action will be taken. 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.
PAGE 289
VIVOTEK 2400,3600,4800,72 00,9600,19200,384 00,57600,115200 databit 5,6,7,8 4/4 Data bits in a character frame. 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.
PAGE 290
VIVOTEK databit 5,6,7,8 4/4 Data bits in a character frame. 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/7 RS485 mode. 7.43 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.
PAGE 291
VIVOTEK (get/set) name 6/7 User-defined lens name SECURITY DESCRIPTION 7.44 Fisheye info Group: fisheyeinfo (capability.fisheye > 0) NAME VALUE (get/set) revisedcenteraxis 6/7 The actual center axis coordinate radius 0, 7.
PAGE 292
VIVOTEK 7.46 PIR behavior define Group: pir (capability.npir > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable 7.47 1/1 Enable/disable PIR Auto tracking setting Group: autotrack_c<0~(n-1)> (capbility_image_c<0~(capability_nvideoin)-1>_autotrack_support > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) objsize_type -1~2 1/4 Type of object size.
PAGE 293
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 294
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 295
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 296
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 297
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 298
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 299
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 300
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 301
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 302
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 303
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. 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.
PAGE 304
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 305
VIVOTEK POST /cgi-bin/operator/uartchannel.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache cache-control : no-cache content-length: 32767 expires: Sun, 9 Jam 1972 00:00:00 GMT User must use GET and POST to establish two channels for downstream and upstream. The x-sessioncookie in GET and POST should be the same to be recognized as a pair for one session. The contents of upstream should be base64 encoded to be able to pass through a proxy server.
PAGE 306
VIVOTEK content-length: 32767 expires: Sun, 9 Jam 1972 00:00:00 GMT User must use GET and POST to establish two channels for downstream and upstream. The x-sessioncookie in GET and POST should be the same to be recognized as a pair for one session. The contents of upstream should be base64 encoded to be able to pass through the proxy server. This channel will help perform real-time event subscription and notification as well as camera control more efficiently.
PAGE 307
VIVOTEK 8.16 Open the Network Stream Note: This request requires Viewer access privileges. Syntax: For HTTP push server (MJPEG): http:///_accessname> For RTSP (MP4), the user needs to input theURL below into an RTSP compatible player. rtsp:///_accessname> “m” is the stream number. For details on streaming protocol, please refer to the “control signaling” and “data format” documents. 8.17 Senddata (capability.
PAGE 308
VIVOTEK Content-Length: \r\n \r\n \r\n Where hexadecimal data is digits from 0 ~ 9, A ~ F. 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.
PAGE 309
VIVOTEK Indicate the media file resolution. Please embrace your input value with single quotes. Ex. resolution=’800x600’ isLocked Optional. Indicate if the file is locked or not. 0: file is not locked. 1: file is locked. 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.
PAGE 310
VIVOTEK http:///cgi-bin/admin/lsctrl.cgi?cmd=delete&label=1&label=4&label=8 Command: update PARAMETER VALUE DESCRIPTION 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.
PAGE 311
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 312
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 313
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. 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 314
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 315
VIVOTEK steps 1 ~ Motor’s moving steps. It works only if function=zoom | focus and direction=forward | backward. is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from "function=getstatus" iris N/A Open iris or not. It works only if function=auto | scan. 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 316
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 317
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 318
VIVOTEK 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.cgi Post data: filename =\r\n \r\n Server will accept the file named to upload this one to camera. 8.25 Update Lens Configuration Note: This request requires Administrator privileges.
PAGE 319
VIVOTEK http:///cgi-bin/admin/update_lens.cgi?delete_lens= PARAMETER value VALUE DESCRIPTION Available lens name. Please refer to: lens_default_i<0~(n-1)>_name lens_user_i<0~(n-1)>_name n is a positive integer. Method: POST Syntax: For upload user-defined lens configuration: http:///cgi-bin/admin/update_lens.
PAGE 320
VIVOTEK 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.sdp?[&stime=][&etime=][&length =][&loctime =][&file=][&tsmode=] PARAMETER VALUE DEFAULT stime N/A Start time. etime N/A End time.
PAGE 321
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 322
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 323
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 324
VIVOTEK 8.29 Camera Control (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET/POST Syntax: (for control API) http:///cgi-bin/camctrl/camctrl.
PAGE 325
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 326
VIVOTEK http:///cgi-bin/camctrl/camctrl.cgi?[] [&...] Example: http://myserver/cgi-bin/camctrl/camctrl.cgi?genpan Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n pan=4117\r\n PARAMETER VALUE DESCRIPTION getversion Get the version of the PTZ control module. getaction idle, Get the current status of the camera.
PAGE 327
VIVOTEK getminpan 0, Get the lower limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmaxpan 0, Get the upper limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getminpanangle Get the lower limit for pan angle. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmaxpanangle Get the upper limit for pan angle.
PAGE 328
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 329
VIVOTEK delpos string[30] Delete preset location from preset list. 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 330
VIVOTEK 8.32 SmartSD (capability_localstorage_smartsd > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/smartsd.
PAGE 331
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 332
VIVOTEK Technical Specifications IB836BA-HT: Vari-focal, P-iris, Remote Focus IB836BA-EHT: Vari-focal, P-iris, Remote Focus, Extreme Weather IB836BA-HF3: Fixed-focal IB836BA-EHF3: Fixed-focal, Extreme Weather System Information CPU Flash RAM Multimedia SoC (System-on-Chip) 1Gb 2Gb Camera Features Image Sensor Maximum Resolution Lens Type Focal Length Aperture Auto-iris Field of View Shutter Time WDR Technology Day/Night Minimum Illumination Pan/Tilt/Zoom Functionalities IR Illuminators On-board Stor
PAGE 333
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 334
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 B digital device, pursuant to Part 15 of the FCC Rules.