User Manual

ManualsBrandsVivotek ManualsIP NDAA Cameras5 Megapixel Day/Night Outdoor IR Network Bullet Camera, 3.6mm Lens

Table Of Contents

User’s Manual

5MP/2MP • Outdoor • IP66 • IK10 • Day & Night

WDR Pro • Smart Stream III • 30M Smart IR

Bullet Network Camera

IB9360-H

IB9380-H

Rev. 1.0

Summary of content (398 pages)

PAGE 1
IB9360-H IB9380-H Bullet Network Camera User ’s Manual 5MP/2MP • Outdoor • IP66 • IK10 • Day & Night WDR Pro • Smart Stream III • 30M Smart IR Rev. 1.
PAGE 2
VIVOTEK Table of Contents Overview �� 3 Revision History �� 4 Read Before Use ��
PAGE 3
VIVOTEK Technology License Notice �� 397 Electromagnetic Compatibility (EMC) �� 398 Overview The IB9360 and IB9380 is an outdoor bullet network camera capable of 1920 x 1080 at 30 fps, or 2560 x 1920 resolution at 20 fps.
PAGE 4
VIVOTEK Revision History ■ Rev. 1.0: Initial release. Read Before Use The use of surveillance devices may be prohibited by law in your country. The Network Camera is not only a high-performance web-ready camera but can also be part of a flexible surveillance system. It is the user’s responsibility to ensure that the operation of such devices is legal before installing this unit for its intended use.
PAGE 5
VIVOTEK Package Contents ■ ■ ■ ■ ■ IB9360-H or IB9380-H Screw pack and side lid. Alignment sticker. Quick Installation Guide. Waterproof cable gland. WARNING: 1. IR lights emit from this product. 2. Use appropriate shielding or eye protection. 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.
PAGE 6
VIVOTEK Physical Description Outer View RJ45 Ethernet connector Fastening ring Lens IR LEDs Inner View Reset button MicroSD card slot 6 - User's Manual
PAGE 7
VIVOTEK NOTE: Some of the suffix syntax used in model naming are listed below: E w/ heater for extreme weather Fx Focal length w/ number T w/ Remote focus lens R w/ PoE repeater H w/ High Dynamic Range functionality User's Manual - 7
PAGE 8
VIVOTEK Hardware Installation 1. Jot down the camera's MAC address for later reference. XXXXXX 0002D10766AD 2. Open the small hatch cover by loosening the T10 anti-tamper screws. Install a MicroSD card if onboard storage is preferred.
PAGE 9
VIVOTEK 3. Use the alignment sticker to drill mounting holes on the wall or ceiling. Drill a cabling routing hole if preferred. Ø ≥25mm 4. Route an Ethernet cable through the cabling hole.
PAGE 10
VIVOTEK 5. Pass an Ethernet cable through the waterproof cable gland components, and through the rubber seal as shown below. Connect the Ethernet cable to the camera's RJ45 connector. 5.5 ~ 6. Install the seal ring and tighten the waterproof components. 10 - User's Manual 6.
PAGE 11
VIVOTEK 7. Install the camera to wall using the included screws. Note that if a routing hole through the wall is not possible, you can also route the cable through the side opening. < 10 kgf-cm Note that it is always a good practice to form a drip loop of cables. Moisture condensation or dripping water can eventually cause problems without the drip loop.
PAGE 12
VIVOTEK 8. Connect a ground wire to the grounding position at the back of the camera using the included screw. 20AWG 9. Remove the protective sheet from the front of the lens.
PAGE 13
VIVOTEK 10. Please visit VIVOTEK’s website to Install the "Shepherd” software utility. The program will search for VIVOTEK Video Receivers, Video Servers or Network Cameras on the same LAN. Double-click on the camera’s MAC address to open a web console to the camera. Shepherd LAN IEEE 802.
PAGE 14
VIVOTEK Software Installation 11. Install the Shepherd utility, which helps you locate and configure your Network Camera in the local network. If your camera comes without the CD, go to VIVOTEK’s website, and locate the utility in the Downloads > Software page. 11-1. Run the Shepherd utility. 11-2. The program will conduct an analysis of your network environment.
PAGE 15
VIVOTEK 11-3. The program will search for all VIVOTEK network devices on the same LAN. 11-4. After a brief search, the installer window will prompt. Click on the MAC and model name that matches the one printed on the product label. You can then double-click on the address to open a management session with the Network Camera. Network Camera Model No: IB9360-H MAC:0002D1730202 R o HS This device complies with part 15 of the FCC rules.
PAGE 16
VIVOTEK Forceful Password Configuration 12. The first time you log in to the camera, the firmware will prompt for a password configuration for security concerns. 12-1. Since your camera is used for the first time, there is no password. Enter “root” as the user name, and nothting for the password. 12-2. Enter the combination of alphabetic and numeric characters to fulfill the password strength. requirement. The default name for the camera administrator is “root”, and can not be changed.
PAGE 17
VIVOTEK Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~. You can use them in the password combination. 12-3. Another prompt will request for the password you just configured. Enter the password and then you can start configure your camera and see the live view.
PAGE 18
VIVOTEK 13. Loosen the fastening ring. 14. Pan, tilt, or rotate the camera until an optimal field of view is found.
PAGE 19
VIVOTEK 15. Fasten the fastening ring when you are satisfied with the field of view.
PAGE 20
VIVOTEK Hardware Reset The reset button is used to reset the system or restore the factory default settings. Sometimes resetting the system can return the camera to normal operation. If the system problems remain after reset, restore the factory settings and install again. Reset: Press the recessed reset button. 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 21
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 an 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 22
VIVOTEK Ready to Use 1. A browser session to the Network Camera should prompt as shown below. 2. You should be able to see live video from your camera. You may also install the 32-channel recording software from the software CD in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents.
PAGE 23
VIVOTEK Internet connection via a router Before setting up the Network Camera over the Internet, make sure you have a router and follow the steps below. 1. Connect your Network Camera behind a router, the Internet environment is illustrated below. Regarding how to obtain your IP address, please refer to Software Installation on page 20 for details. WAN (Wide Area Network ) Internet Router IP address : from ISP POWER COLLISION 1 2 3 4 5 IP address : 192.168.0.3 Subnet mask : 255.255.255.
PAGE 24
VIVOTEK For example, your router and IP settings may look like this: Device IP Address: internal port IP Address: External Port (Mapped port on the router) Public IP of router 122.146.57.120 LAN IP of router 192.168.2.1 Camera 1 192.168.2.10:80 122.146.57.120:8000 Camera 2 192.168.2.11:80 122.146.57.120:8001 ... ... ...
PAGE 25
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 26
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 95. ► 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 27
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 28
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 29
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 21. To utilize this feature, please check the following settings on your Network Camera: 1.
PAGE 30
VIVOTEK Using VIVOTEK Recording Software VIVOTEK also provides 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 31
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. VIVOTEK INC. Logo Resize Buttons 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 32
VIVOTEK Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 36. 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 41.
PAGE 33
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 110 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 34
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 35
VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Title and Time Video (HTTP-V) 2018/07/25 17:08:56 Time Video 17:08:56 2018/07/25 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 59. Time: Display the current time. For more information, please refer to Media > Image on page 59. Title and Time: Video title and time can be stamped on the streaming video.
PAGE 36
VIVOTEK Client Settings This chapter explains how to select the stream transmission mode and saving options on the local computer. When completed with the settings on this page, click Save on the page bottom to enable the settings. H.265/H.264 Protocol Options H.264 Protocol Options Depending on your network environment, there are four transmission modes of H.264 streaming: UDP unicast: This protocol allows for more real-time audio and video streams.
PAGE 37
VIVOTEK 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. File name prefix: Enter the text that will be appended to the front of the video file name. A specified folder will be automatically created on your local hard disk.
PAGE 38
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 39
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 40
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 41
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 42
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 43
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 44
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 45
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 46
VIVOTEK ■ Follow the steps below to set up the customized homepage: 1. Click Custom on the left column. 2. Click the field where you want to change the color on the right column. Color Selector Custom Pattern 3. The palette window will pop up as shown below. 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 47
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 48
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 49
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 50
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 51
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 78). 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 52
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 53
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 54
VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following columns: General settings, IR control, Image settings, Exposure, Focus, 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 55
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 56
VIVOTEK IR cut filter With a removable IR-cut filter, this Network Camera can automatically remove the filter to let Infrared light pass into the sensor during low light conditions. ■ Auto mode (The Day/Night Exposure Profile will not be available if Auto mode is selected) The Network Camera automatically removes the filter by judging the level of ambient light.
PAGE 57
VIVOTEK IR control Turn on built-in IR illuminator in night mode Select this to turn on the camera’s onboard IR illuminator when the camera detects low light condition and enters the night mode. Anti-overexposure: When enabled, the camera automatically adjusts the IR projection to adjacent objects in order to avoid over-exposure in the night mode. The Smart IR function is more beneficial when the spot of intrusions or an object of your interest is close to the lens and the IR lights.
PAGE 58
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 62 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 59
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 60
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 slide bar 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 61
VIVOTEK Exposure On this page, you can set the Exposure measurement window, Exposure level, Exposure mode, Exposure time, Gain control, and Day/Night mode settings. You can configure two sets of Exposure settings: one for normal situations, the other for special situations, such as the day/night/schedule mode.
PAGE 62
VIVOTEK The inclusive window refers to the “weighted window“; the exclusive window refers to “ignored window“. It adopts the weighted averages method to calculate the value. The inclusive windows have a higher priority. You can overlap these windows, and, if you place an exclusive window within a larger inclusive window, the exclusive part of the overlapped windows will be deducted from the inclusive window. An exposure value will then be calculated out of the remaining of the inclusive window.
PAGE 63
VIVOTEK Exposure control: ■ Exposure level: You can manually set the Exposure level, which ranges from -2.0 to +2.0 (dark to bright). You can click and drag the semi-circular pointers on the Exposure time and Gain control slide bars to specify a range of shutter time and Gain control values within which the camera can automatically tune to an optimal imaging result.
PAGE 64
VIVOTEK You can click Restore to recall the original settings without incorporating the changes. When completed with the settings on this page, click Save to enable the settings. If you want to configure another sensor setting for day/night/schedule mode, please click Profile to open the Profile of exposure settings page as shown below. Activated period: Select the mode this profile to apply to: Day mode, Night mode, or Schedule mode. Please manually enter a range of time if you choose Schedule mode.
PAGE 65
VIVOTEK Privacy mask Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to address privacy concerns. 4x ■ To configure privacy mask windows, 1. Click New to add a new window. 2. You can use 4 mouse clicks to create a new masking window, which is recommended to be at least twice the size of the object (height and width) you want to cover. 3. Enter a Window Name and click Save to enable the setting. 4.
PAGE 66
VIVOTEK Media > Video Mode (IB9380-H) The applicable video modes include: ■ 5MP (max. 20fps)(WDR Pro): This is the full resolution at 5 megapixels in a 4:3 screen aspect ratio, with the WDR function enabled. ■ 4MP (16:9) (max. 20fps)(WDR Pro): At the 16:9 aspect ratio, the usable resolution is slightly reduced to 4MP, with the WDR function enabled. ■ 4MP (16:9) (max. 30fps): This mode comes with the 4MP resolution without the WDR function.
PAGE 67
VIVOTEK Media > Video Stream settings This Network Camera supports multiple streams with frame sizes ranging from 480 x 352 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 640 x 480. ■ Stream 3: The default frame size for Stream 3 is set to the 2560 x 1920.
PAGE 68
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 69
VIVOTEK Click the stream item to display the detailed information. The maximum frame size will follow your settings in the above Viewing Window sections. This Network Camera provides real-time H.265, H.264 and MJPEG compression standards (Triple Codec) for real-time viewing. If the H.265 or H.264 mode is selected, the video is streamed via RTSP protocol.
PAGE 70
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 III ■ Dynamic Intra frame period High quality motion codecs, such as H.
PAGE 71
VIVOTEK With the H.265 codec in an optimal scenario and when Dynamic Intra frame is combined with the Smart Stream function, an 80% of bandwidth saving can be achieved compared with using H.264 without enabling these bandwidth-saving features. ■ Smart FPS In a static scene, the algorithm puts old frames in queue when no motions occur in scene. When motions occur, the encoding returns to normal to deliver real-time streaming. f1 f1 f1 f1 f5 f5 f5 f5 f9 f5 f6 f7 f8 f9 Motions Occur.
PAGE 72
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 73
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 74
VIVOTEK ■ Bit rate control Constrained bit rate: • A complex scene generally produces a larger file size, meaning that higher bandwidth will be needed for data transmission. The bandwidth utilization is configurable to match a selected level, resulting in mutable video quality performance. The bit rates are selectable at the following rates: 20Kbps, 30Kbps, 40Kbps, 50Kbps, 64Kbps, 128Kbps, 256Kbps, 512Kbps, 768Kbps, 1Mbps, 2Mbps, 3Mbps, 4Mbps, 6Mbps, 8Mbps, 10Mbps, 12Mbps, 14Mbps, ~ to 80Mbps.
PAGE 75
VIVOTEK Fixed quality: On the other hand, if Fixed quality is selected, all frames are transmitted with the same quality; bandwidth utilization is therefore unpredictable. The video quality can be adjusted to the following settings: Medium, Standard, Good, Detailed, and Excellent. You can also select Customize and manually enter a value.
PAGE 76
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 77
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 78
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 79
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 80
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 81
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 82
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 83
VIVOTEK User's Manual - 83
PAGE 84
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 95 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 85
VIVOTEK URL command -- http://:/ For example, when the Access name for stream 2 is set to video1s2.mjpg: 1. Launch Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter. 3. The JPEG images will be displayed in your web browser. http://192.168.5.151/video1s2.
PAGE 86
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 87
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 88
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 89
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 90
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 91
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 92
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 93
VIVOTEK Network > SNMP (Simple Network Management Protocol) This section explains how to use the SNMP on the network camera. The Simple Network Management Protocol is an application layer protocol that facilitates the exchange of management information between network devices. It helps network administrators to remotely manage network devices and find, solve network problems with ease. ■ The SNMP consists of the following three key components: 1.
PAGE 94
VIVOTEK Network > FTP The newer firmware disabled the FTP port for security concerns. You can manually enable the FTP server service to enable the FTP function. You can disable the FTP server function when it is not in use. FTP port: The FTP server allows the user to save recorded video clips. You can utilize VIVOTEK's Shepherd utility to upgrade the firmware via FTP server. By default, the FTP port is set to 21. It can also be assigned to another port number between 1025 and 65535.
PAGE 95
VIVOTEK Security > User accounts This section explains how to enable password protection and create multiple accounts. Account management The administrator account name is “root”, which is permanent and can not be deleted. If you want to add more accounts in the Account management window, please apply the password for the “root” account first. The administrator can create up to 20 user accounts. To create a new user, 1. Click to unfold the pull-down menu. Select New user. 2.
PAGE 96
VIVOTEK Privilege management Digital Output & PTZ control: You can modify the management privilege as operators or viewers. Select or de-select the checkboxes, and then click Save to enable the settings. If you give Viewers the privilege, Operators will also have the ability to control the Network Camera through the main page. (Please refer to Configuration on page 41). Allow anonymous viewing: If you select this item, any client can access the live stream without entering a User ID and Password.
PAGE 97
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 98
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 99
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 100
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 101
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 102
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 103
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 104
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 105
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 106
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 107
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 108
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 109
VIVOTEK Security > Miscellaneous The embedded TrendMicro utitlity provides the protection against Cross-Site Request Forgery. Cross-site request forgery is also known as one-click attack or session riding and is abbreviated as CSRF. CSRF is a type of malicious exploit of a website, in this case, the camera. Unauthorized commands are transmitted from a user that the web application trusts, using the mechanism of forging a trusted user's own request with a request containing his own cookies, etc.
PAGE 110
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 112.
PAGE 111
VIVOTEK Home page in the E-PTZ Mode ■ The e-Preset Positions will also be displayed on the home page. Select one from the drop-down list, and the Network Camera will move to the selected position. ■ If you have set up different preset positions for different streams, you can select one of the video streams to display its separate preset positions. Global View In addition to using the e-PTZ control panel, you can also use the mouse to drag or resize the floating frame to pan/tilt/zoom the viewing region.
PAGE 112
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 113
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 114
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 115
VIVOTEK ■ Event name: Enter a name for the event setting. ■ Enable this event: Select this checkbox to enable the event setting. ■ Priority: Select the relative importance of this event (High, Normal, or Low). Events with a higher priority setting will be executed first. seconds: Enter the duration in seconds to pause ■ Detect next motion detection or digital input after motion detection after a motion is detected. This can prevent event-related actions to take place too frequently. 1.
PAGE 116
VIVOTEK ■ Camera tampering detection This option allows the Network Camera to trigger when the camera detects that is is being tampered with. To enable this function, you need to configure the Tampering Detection option first. Please refer to page 131 for detailed information. ■ Manual Triggers This option allows users to enable event triggers manually by clicking the on/off button on the homepage. Please configure 1 to 3 associated events before using this function.
PAGE 117
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. ■ Backup media if the network is disconnected Select this option to backup media file on SD card if the network is disconnected. This function will only be displayed after you set up a network storage (NAS). The media to back up can include snapshot images, video, or system logs depending on your event settings.
PAGE 118
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 119
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 120
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 121
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 138 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 123 for detailed information.
PAGE 122
VIVOTEK Click 20190120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2019/01/20 2019/01/20 Click to go back to the previous level of the directory Click to delete selected items Click to delete all recorded data 2019/01/20 2019/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 123
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 124
VIVOTEK ■ Add date and time suffix to the file name Select this option to add a date/time suffix to the file name. For example: Snapshot_20190513_100341 File name preﬁx Date and time sufﬁx The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings. Note that after you set up the first media server, a new column for media server will automatically display on the Media list. If you wish to add more media options, click Add media.
PAGE 125
VIVOTEK ■ Maximum file size Specify the maximum file size allowed. Some users may need to stitch the video clips together when searching and packing up forensic evidence. ■ File name prefix Enter the text that will be appended to the front of the file name. For example: Video_20190513_100341 File name preﬁx Date and time sufﬁx 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 126
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 127
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 128
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 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. ■ Use 4 mouse clicks to designate a detection window.
PAGE 129
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 114. 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 130
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 114 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 131
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 132
VIVOTEK Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) The IB9365-HT is the first camera line to come embedded with the Smart Motion Detection feature. The Smart Motion detection, with Human detection and tunable time filter, can eliminate the defects of traditional motion detection and facilitate the configuration at a surveillance site. To learn more about this feature, download its User Guide in: http://download.vivotek.
PAGE 133
VIVOTEK To utilize a software module, acquire the software package and click Browse and Upload buttons. The screen message for a successful upload is shown below: To start a module, select the checkcircle in front, and click the Start button. If you should need to remove a module, select the checkcircle in front and then click the Stop button. 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.
PAGE 134
VIVOTEK On the License page, register and activate the license for using VIVOTEK's VADP modules. You should acquire the license key elsewhere, and manually upload to the network camera. Follow the onscreen instruction on VIVOTEK's website for the registration procedure.
PAGE 135
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 140 for detailed information. Recording Settings Click Add to open the recording setting window.
PAGE 136
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 137
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 138
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. The reserved space is a small amount of space used only for the transaction stage when the capacity is about to be used up or recycled.
PAGE 139
VIVOTEK f you want to enable recording notification, please click Event to configure event triggering settings. Please refer to Event > Event settings on page 114 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 140
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 141
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 142
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 143
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 144
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 145
© 2019 VIVOTEK INC. All Right Reserved VIVOTEK 2. Style Convention In URL syntax and in descriptions of CGI parameters, a text within angle brackets denotes a content that is to be replaced with either a value or a string. When replacing the text string, the angle brackets shall also be replaced. An example of this is the description of the name for the server, denoted with in the URL syntax description below, which is replaced with the string myserver in the URL syntax example, also below.
PAGE 146
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 3. General CGI URL Syntax and Parameters CGI parameters are written in lower-case and as one word without any underscores or other separators. When the CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server. The CGIs are organized in functionally-related directories under the cgi-bin directory. The file extension .cgi is required.
PAGE 147
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 4. Security Level SECURITY LEVEL SUB-DIRECTORY DESCRIPTION 0 anonymous Unprotected. 1 [view] viewer Can view, listen, and talk to camera. 4 [operator] operator Operator access rights can modify most of the camera’s parameters except some privileges and network options. 6 [admin] admin Administrator access rights can fully control the camera’s operations. 7 N/A Internal APIs. Unable to be changed by any external interfaces.
PAGE 148
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 5. Get Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http:///cgi-bin/anonymous/getparam.cgi?[] [&…] http:///cgi-bin/viewer/getparam.cgi?[] [&…] http:///cgi-bin/operator/getparam.cgi?[] [&…] http:///cgi-bin/admin/getparam.
PAGE 149
© 2019 VIVOTEK INC. All Right Reserved VIVOTEK http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n 26 User's Manual - 149
PAGE 150
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http:///cgi-bin/anonymous/setparam.cgi? = [&=…][&return=] http:///cgi-bin/viewer/setparam.cgi? = [&=…][&return=] http:///cgi-bin/operator/setparam.
PAGE 151
© 2019 VIVOTEK INC. All Right Reserved VIVOTEK [] Only the parameters that you set and are readable will be returned. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123 Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n 28 User's Manual - 151
PAGE 152
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7. Available Parameters on the Server Valid values: VALID VALUES DESCRIPTION string[] Text strings shorter than ‘n’ characters. The characters “,’,<,>,& are invalid. string[n~m] Text strings longer than `n’ characters and shorter than `m’ characters. The characters “,’,<,>,& are invalid. password[] The same as string but displays‘*’ instead. Any single integer number in 32-bits. The range is -2147483648~2147483647.
PAGE 153
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved VALID VALUES DESCRIPTION The format for resolution. W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 available The API is listed in product WebAPIs. non-available The API is not in product WebAPIs. valid The API is listed in product WebAPIs, and is functional. non-valid The API is listed in product WebAPIs, but is malfunction in this status.
PAGE 156
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME SECURITY (get/set) DESCRIPTION daylight_auto_begintim string[19] e 6/7 Display the current daylight saving start time. daylight_auto_endtime string[19] 6/7 Display the current daylight saving end time. daylight_timezones string 6/6 List time zone index which support daylight saving time.
PAGE 157
© 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) VIVOTEK DESCRIPTION values except the custom language file the user has uploaded. This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.
PAGE 158
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * Only available when "capability_image_c<0~(n-1)>_lensconfig uration_support" != 0. 7.1.1 System.Info Subgroup of system: info (The fields in this group are unchangeable.) NAME VALUE SECURITY (get/set) DESCRIPTION modelname string[40] 0/7 Internal model name of the server extendedmodelname string[40] 0/7 ODM specific model name of server (eg. DCS-5610).
PAGE 159
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 0, 0/6 Maximum number of custom languages supported on the server. customlanguage_coun 0, 0/6 Number of custom languages which have been uploaded to the server. customlanguage_i<0~ (maxcount-1)> 0/6 Custom language name. language_i7 : 简体中文 language_i8 : 繁體中文 customlanguage_max count string 7.
PAGE 160
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.2.1 Status per Channel Group: status_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) signal_detect 1/7 Indicates whether the video source is connected or not. * Only available when capability_videoin_type is 0 or 1. signal_type ntsc,pal 1/7 The actual modulation type. * Only available when capability_videoin_type is 0 or 1. 7.
PAGE 162
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION Ex: Change HTTP port from 80 to 5556, and change RTP port for video from 5556 to 20480. Then, set preprocess=9 to stop both service first. ”/cgi-bin/admin/setparam.cgi? network_preprocess=9&network_http_ port=5556& network_rtp_videoport=20480” type lan, pppoe 6/6 Network connection type. resetip 6/6 1 => Get ipaddress, subnet, router, dns1, dns2 from DHCP server at next reboot.
PAGE 163
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION privatekeypassword string[200] 7/6 Password for PEAP ca_exist 6/6 CA installed flag ca_time 0, 6/7 CA installed time. Represented in EPOCH ca_size 0, 6/7 CA file size (in bytes) certificate_exist 6/6 Certificate installed flag (for TLS) certificate_time 0, 6/7 Certificate installed time.
PAGE 164
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) audio 0~63 6/6 Audio channel for DSCP (capability_naudioin > 0) eventalarm 0~63 6/6 Event/alarm channel for DSCP management 0~63 6/6 Management channel for DSCP eventtunnel 0~63 6/6 Event/Control channel for DSCP 7.6.3 IPV6 Subgroup of network: ipv6 (capability_protocol_ipv6 > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable IPv6.
PAGE 165
© 2019 VIVOTEK INC. All Right Reserved VIVOTEK 7.6.5 HTTP Subgroup of network: http NAME VALUE SECURITY (get/set) DESCRIPTION port 80, 1025 ~ 65535 1/6 HTTP port. alternateport 1025~65535 6/6 Alternate HTTP port. authmode basic, digest 1/6 HTTP authentication mode. s<0~(capability_nmed iastream-1)>_accessn ame string[32] 1/6 Http server push access name for stream N, N= 1~ capability_nmediastream.
PAGE 166
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION s<0~(capability_nmedia stream-1)>_accessname string[32] 1/6 Http server push access name for channel N and stream M, N= 1~ capability_nvideoin, M= 1~ capability_nmediastream. (capability_protocol_spush_mjpeg =1 and capability_nmediastream > 0) The value are shown as video1s1.mjpg = c0_s0_accessname, (channel1stream1) video1s2.mjpg = c0_s1_accessname, (channel1stream2) video2s1.
PAGE 167
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.6.8 RTSP Subgroup of network: rtsp (capability_protocol_rtsp > 0) NAME VALUE SECURITY (get/set) DESCRIPTION port 554, 1025 ~ 65535 1/6 RTSP port. (capability_protocol_rtsp=1) anonymousviewing 1/6 Enable anoymous streaming viewing. authmode disable, basic, digest 1/6 RTSP authentication mode.
PAGE 168
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "network_rtsp_s<0~(n-1)>_multicast_ipaddress" with " network_rtsp_s<0~(n-1)>_multicast_videoipadd ress ". * Reserved for compatibility, and suggest don't use this since [httpversion] > 0304a videoipaddress 4/4 Multicast video IP address. * We support this parameter when the version number (httpversion) is equal or greater than 0304a.
PAGE 169
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.6.11 RTP Port Subgroup of network: rtp NAME VALUE SECURITY (get/set) DESCRIPTION videoport 1025 ~ 65535 6/6 Video channel port for RTP. audioport 1025 ~ 65535 6/6 Audio channel port for RTP. metadataport 1025 ~ 65535 6/6 Metadata channel port for RTP. 7.6.12 PPPoE Subgroup of network: pppoe (capability_protocol_pppoe > 0) NAME VALUE SECURITY DESCRIPTION (get/set) user string[128] 6/6 PPPoE account user name.
PAGE 170
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION string[43] 6/6 IPv6 address list. NAME VALUE SECURITY (get/set) DESCRIPTION cmosfreq 50, 60 4/4 CMOS frequency. * Only available when capability_videoin_type is 2. whitebalance auto, panorama, manual, rbgain, widerange, outdoor, indoor, sodiumauto, etc 4/4 Modes of white balance.
PAGE 171
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "sodiumauto": sodium vapor lamps. * Only available when "capability_image_c<0~(n-1)>_wbmo de" !="-" exposurelevel 0~12 4/4 Exposure level "0,12": This range takes the concept from DC's exposure tuning options. The definition is: 0: EV -2.0 1: EV -1.7 2: EV -1.3 3: EV -1.0 4: EV -0.7 5: EV -0.3 6: EV 0 7: EV +0.3 8: EV +0.7 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.
PAGE 172
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c<0~(n-1)>_mode" to switch on/off BLC. color 0, 1 4/4 0 =>monochrome 1 => color * Only available when " capability_videoin_c<0~(n-1)>_color_ support" is 1. flip 4/4 Flip the image. mirror 4/4 Mirror the image.
PAGE 173
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION imprinttimestamp 4/4 Overlay time stamp on video. minexposure <1~32000>, <5~32000>, <1~8000>, <5~8000>, etc. 4/4 Minimum exposure time 1~32000 => 1s ~ 1/32000s 5~32000 => 1/5s ~ 1/32000s 1~8000 => 1s ~ 1/8000s 5~8000 => 1/5s ~ 1/8000s etc.
PAGE 174
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". enablepreview 174 - User's Manual 1/4 Usage for UI of exposure settings. Preview settings of video profile.
PAGE 175
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 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( get/set) DESCRIPTION cmosfreq 50, 60 4/4 CMOS frequency. * Only available when " capability_videoin_type " is 2 mode 0~ "capability_videoin_c<0~( n-1)>_nmode"-1 4/4 Indicate the video mode on use.
PAGE 176
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION de" !="-" rgain 0~100 4/4 Manual set rgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbmo de". * Only valid when "videoin_c<0~(n-1)>_whitebalance" ! = auto * Normalized range. bgain 0~100 4/4 Manual set bgain value of gain control setting.
PAGE 177
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.0 * Only available when "capability_image_c<0~(n-1)>_exposu re_mode" !=0 exposuremode auto, shutterpriority, irispriority, qualitypriority, manual, etc 4/4 Select exposure mode. "auto": Automatically adjust the Iris, Gain and Shutter Speed to fit the exposure level.
PAGE 178
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION * Only available when "capability_image_c<0~(n-1)>_iristype "=dciris piris_mode manual, indoor, outdoor,- 1/4 Control P-Iris mode. "outdoor": Auto-setting P-Iris to get best 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.
PAGE 179
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_m axgain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". mingain 0~100 4/4 Minimum gain value.
PAGE 180
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION * Only available when " capability_videoin_c<0~(n-1)>_color_ support" is 1. flip 4/4 Flip the image. mirror 4/4 Mirror the image. rotate 0,90,180,270 1/4 The rotation angle of image.
PAGE 181
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION ploadfilename name uploaded by user minexposure <1~32000>, <5~32000>, <1~8000>, <5~8000>, etc. 4/4 Minimum exposure time 1~32000 => 1s ~ 1/32000s 5~32000 => 1/5s ~ 1/32000s 1~8000 => 1s ~ 1/8000s 5~8000 => 1/5s ~ 1/8000s etc.
PAGE 182
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". shuttervalue <1~32000>, <5~32000>, <1~8000>, <5~8000>, etc. 4/4 Exposure time 1~32000 => 1s ~ 1/32000s 5~32000 => 1/5s ~ 1/32000s 1~8000 => 1s ~ 1/8000s 5~8000 => 1/5s ~ 1/8000s etc. * This parameter may also restrict image frame rate from sensor due to sensor generates a frame per exposure time.
PAGE 183
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION * We support this parameter when the version number (httpversion) is equal or greater than 0311a. crop_position (x,y) 1/7 Crop left-top corner coordinate. crop_size (WxH) 1/7 Crop width and height. (width must be 16x or 32x and height must be 8x) zoomratiodispl ay 1/4 Indicates multiple of zoom in is “on-screen display” or not.
PAGE 184
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION solution "capability_videoin_c<0~( n-1)>_resolution". 4/4 Enable "Smart fps" function. * Only available when "capability_videoin_c<0~(n-1)>_smart fps_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. s<0~(m-1)>_h2 64_dintraperio d_enable 4/4 Enable "Dynamic intra frame period".
PAGE 185
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION "qpercent" 99: Use the quality level in "qvalue" * Only valid when "h264_ratecontrolmode"= vbr. s<0~(m-1)>_h2 0~51 64_qvalue 4/4 Manual video quality level input. The Q value which is used by encoded library directly. * Only valid when "h264_ratecontrolmode"= vbr and s<0~(m-1)>_h264_quant = 99. s<0~(m-1)>_h2 1~100 64_qpercent 4/4 Select customized quality in a normalized full range.
PAGE 186
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION "2.0" s<0~(m-1)>_h2 1~100 64_cbr_qperce nt 4/4 Select customized quality in a normalized full range. 1: Worst quality 100: Best quality * Only valid when "h264_ratecontrolmode"= cbr and "quant"= 100. * Only available when "capability_smartstream_version">= "2.0" s<0~(m-1)>_h2 20000~"capability_videoin 4/4 64_bitrate _c<0~(n-1)>_h264_maxbit rate" The target bit rate in constant bit rate mode.
PAGE 187
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) 65_dintraperio d_enable DESCRIPTION * Only available when "capability_videoin_c<0~(n-1)>_dintra period_support" is 1 and h265 is listed in "capability_videoin_codec". * We support this parameter when the version number (httpversion) is equal or greater than 0301c. s<0~(m-1)>_h2 250, 500, 1000, 2000, 65_intraperiod 3000, 4000 4/4 The time interval between two I-frames (Intra coded picture). The unit is millisecond (ms).
PAGE 188
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION s<0~(m-1)>_h265_quant = 99. s<0~(m-1)>_h2 1~100 65_qpercent 4/4 Select customized quality in a normalized full range. 1: Worst quality 100: Best quality * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "h265_ratecontrolmode"= vbr and "quant"= 100.
PAGE 189
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION 100: Best quality * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "h265_ratecontrolmode"= cbr and "quant"= 100. * Only available when "capability_smartstream_version" >= "2.0" s<0~(m-1)>_h2 20000~"capability_videoin 4/4 65_bitrate _c<0~(n-1)>_h265_maxbit rate" The target bit rate in constant bit rate mode. * Only available when h265 is listed in "capability_videoin_codec".
PAGE 190
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION "capability_videoin_c<0~(n-1)>_smart q_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. s<0~(m-1)>_mj cbr, vbr peg_ratecontr olmode 4/4 cbr: Constant bit rate mode. vbr: Fixed quality mode, all frames are encoded in the same quality. s<0~(m-1)>_mj 1~5, peg_quant 99, 100 4/4 * Only valid when "mjpeg_ratecontrolmode"= vbr.
PAGE 191
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION 100: Best quality * Only valid when "mjpeg_ratecontrolmode"= vbr and s<0~(m-1)>_mjpeg_quant = 100. s<0~(m-1)>_mj 20000~"capability_videoin 4/4 peg_maxvbrbit _c<0~(n-1)>_mjpeg_maxbi rate trate" The maximum allowed bit rate in fixed quality mode. When the bit rate exceeds this value, frames will be dropped to restrict the bit rate.
PAGE 193
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) dependent> DESCRIPTION strength of WDR enhanced. * Only available when "capability_image_c<0~(n-1)>_wdrc_ mode" is 1 aespeed_mod e 4/4 Turning AE converge speed on or off. 0: off 1: on * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1 aespeed_spee dlevel 1~100 4/4 The speed level of AE converge speed.
PAGE 194
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION "capability_image_c<0~(n-1)>_aespee dsupportsensitivity" is 1. flickerless 4/4 Turn on(1) or turn off(0) the flickerless mode * Only available when "capability_image_c<0~(n-1)>_flickerl ess" is 1. mounttype ceiling, wall, floor 1/6 Hardware installation. * Only available when "capability_videoin_c<0~(n-1)>_moun ttype" != "-".
PAGE 195
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION enable 4/4 Enable or Disable smart codec function mode autotracking,manual,hybri d 4/4 Set Smart stream mode "autotracking": only available when "capability_smartstream_mode_autot racking" is 1. "manual": only available when "capability_smartstream_mode_man ual" is 1. "hybrid": only available when "capability_smartstream_mode_hybri d" is 1.
PAGE 196
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved denotes the value of "capability_smartstream_nwindow_manual". NAME VALUE SECURITY (get/set) DESCRIPTION enable 4/4 Enable or disable the window. home 0~320,0~240 4/4 Left-top corner coordinate of the window. size 0~320x0~240 4/4 Width and height of the window 7.8.1.
PAGE 197
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". maxexposure <1~32000>, <5~32000>, <1~8000>, <5~8000>, etc. 4/4 Maximum exposure time 1~32000 => 1s ~ 1/32000s 5~32000 => 1/5s ~ 1/32000s 1~8000 => 1s ~ 1/8000s 5~8000 => 1/5s ~ 1/8000s etc. * This parameter may also restrict image frame rate from sensor due to sensor generates a frame per exposure time.
PAGE 198
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION the night, then sensor only outputs 5 frame/s. * Only available when "capability_image_c<0~(n-1)>_exposu re_maxrange" != "-" and "capability_image_c<0~(n-1)>_exposu re_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. enableblc 4/4 Enable backlight compensation.
PAGE 199
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "capability_image_c0_exposure_mod e" != 0 exposuremode auto, shutterpriority, irispriority, qualitypriority, manual, etc 4/4 Select exposure mode. "auto": Automatically adjust the Iris, Gain and Shutter Speed to fit the exposure level. "shutterpriority": Manually adjust with variable Shutter Speed, and keep adjusting Iris, Gain automatically.
PAGE 200
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) 1)>_wbmode") DESCRIPTION current values which is got from white balance module. Then, act as rbgain mode "widerange": Auto Tracing White balance (2000K to 10000K). "outdoor": auto white balance mode specifically for outdoor. "indoor": auto white balance mode specifically for indoor. "sodiumauto": sodium vapor lamps.
PAGE 201
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_m axgain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". mingain 0~100 4/4 Minimum gain value.
PAGE 202
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) hlc DESCRIPTION "blc": This metering method increases the weight of dark area. "hlc": The metering method can detect strong light and make affected area clear. * We support this parameter when the version number (httpversion) is equal or greater than 0311a. * Available value is listed in "capability_image_c<0~(n1)>_exposure_meteringm ode" piris_mode manual, indoor, outdoor,- 1/4 Control P-Iris mode.
PAGE 203
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION environment. "indoor": Avoid rolling and flicker effect first. "fixed": Open the iris to maximum. * Only available when "capability_image_c<0~(n-1)>_iristype "=dciris wdrpro_mode 4/4 Enable WDR pro * Only available when "capability_image_c<0~(n-1)>_wdrpro _mode" > 0 wdrpro_streng th 1~100 4/4 The strength of WDR Pro.
PAGE 204
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) dependent> DESCRIPTION 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher speed level meas shorter AE converged time during AE executing. * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1 aespeed_sensi tivity 1~100 4/4 The sensitivity of AE converge speed.
PAGE 205
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.9Time Shift Settings Group: timeshift for n channel products and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" (capability_timeshift > 0) NAME VALUE SECURITY (get/set) DESCRIPTION enable 4/4 Enable time shift streaming. c<0~(n-1)>_s< 0~(m-1)>_allo w 4/4 Enable time shift streaming for specific stream. 7.
PAGE 208
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION saturation 100: Use " image_c_saturationpercent" * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicse tting" is 1. * We replace "saturation" with "saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
PAGE 209
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 0: Less saturation <-> 100: More saturation * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicse tting" is 1. sharpnesspercent 0~100 4/4 Set sharpness in the normalized range. 0: Softer <-> 100: Sharper * Only available when bit 3 of "capability_image_c<0~(n-1)>_basicse tting" is 1 gammacurve 0~100 4/4 0: Fine-turned gamma curve by Vivotek. 1: Gamma value = 0.
PAGE 210
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION 0:disable 1:enable * Only available when "capability_image_c<0~(n-1)>_dnr" is 1 dnr_strength 1~100 4/4 Strength of 3DNR * Only available when "capability_image_c<0~(n-1)>_dnr" is 1 defog_mode 4/4 Enable/disable defog mode.
PAGE 212
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION ting is 1. yoffset 0~100 4/4 Adjusting the image to proper position vertically. * Only available when the bit 5 of capability_image_c<0~(n-1)>_basicset ting is 1. lens_alignment 0~100 4/4 Stitch the sensors together into focused position. * Only available when "capability_image_c<0~(n-1)>_lens_al ignment" is 1. lens_ldc_mode 4/4 Enable/disable lens distortion correction.
PAGE 213
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION profile_i<0~(m-1)> _endtime hh:mm 4/4 End time of schedule mode. profile_i<0~(m-1)> _brightness -5~5,100 4/4 -5: Darker <-> 5: Bright 100: Use " image_c<0~(n-1)>_brightnesspercent" _begintime * Only available when bit 0 of "capability_image_c<0~(n-1)>_basicse tting" is 1 * We replace "profile_i0_brightness" with "profile_i0_brightnesspercent".
PAGE 214
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION tting" is 1. * We replace "profile_i0_saturation" with "profile_i0_saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
PAGE 215
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION saturation * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicse tting" is 1. profile_i<0~(m-1)> _sharpnesspercent 0~100 4/4 Set sharpness in the normalized range. 0: Softer <-> 100: Sharper * Only available when bit 3 of "capability_image_c<0~(n-1)>_basicse tting" is 1 profile_i<0~(m-1)> _gammacurve 0~100 4/4 0: Fine-turned gamma curve by Vivotek. 1: Gamma value = 0.01 2: Gamma value = 0.
PAGE 216
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 1:enable * Only available when "capability_image_c<0~(n-1)>_dnr" is 1 profile_i<0~(m-1)> _dnr_strength 1~100 4/4 Strength of 3DNR * Only available when "capability_image_c<0~(n-1)>_dnr" is 1 profile_i<0~(m-1)> _defog_mode 4/4 Enable/disable defog mode.
PAGE 217
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "capability_image_c<0~(n-1)>_is_mod e". 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<0~(n-1)>_exposure_mode"=1) NAME VALUE SECURITY (get/set) DESCRIPTION mode auto, custom,blc,hlc,center 4/4 "auto": Use full image view as the only exposure window.
PAGE 218
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION listed in "capability_image_c<0~(n-1)>_exposu re_wintype". home <0~320,0~240> 4/4 Left-top corner coordinate of the window. * Only available when qvga is listed in "capability_image_c<0~(n-1)>_exposu re_windomain". size <0~320x0~240> 4/4 Width and height of the window. * Only available when qvga is listed in "capability_image_c<0~(n-1)>_exposu re_windomain".
PAGE 220
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION * Only available when exclusive is listed in "capability_image_c<0~(n-1)>_exposu re_wintype". home <0~320,0~240> 4/4 Left-top corner coordinate of the window. * Only available when qvga is listed in "capability_image_c<0~(n-1)>_exposu re_windomain". size <0~320x0~240> 4/4 Width and height of the window. * Only available when qvga is listed in "capability_image_c<0~(n-1)>_exposu re_windomain".
PAGE 221
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.13 Audio Input per Channel Group: audioin_c<0~(n-1)> (capability_naudioin>0) n denotes the value of "capability_naudioin" NAME VALUE SECURITY (get/set) DESCRIPTION source micin, linein 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 222
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION volume_external 0~100 4/4 Volume when take external microphone as input source. 0: Minimum 100: Maximum * Only available when the channel supports 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 Gain of input.
PAGE 223
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION description of "volume_internal" and "volume_external". s0_codectype aac4, gamr, g711, g726 (Available codec are listed in "capability_audioin_ codec") 4/4 Set audio codec type for input. aac4: Advanced Audio Coding (AAC) gamr: Adaptive Multi-Rate (AMR) g711: G.711 g726: G.726 s0_aac4_bitrate 16000, 32000, 48000, 64000, 96000, 128000 4/4 Set AAC4 bitrate in bps. * Only available if AAC is supported.
PAGE 224
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION s0_g726_vlcmode 0, 1 4/4 Enable vlcmode for G.726. 0: Standard mode. 1: Solve compatibility problem with VLC player. * Only available if G.726 is supported. aec_enable 4/4 Enable acoustic echo cancellation. * Only available when "capability_audio_aecmode" is "manual". * We support this parameter when the version number (httpversion) is equal or greater than 0306b.
PAGE 225
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.15 Play an Audio Clip Group: audioclip_i<0~1> (capability_audio_audioclip=1) NAME VALUE SECURITY (get/set) DESCRIPTION name string[40] 1/4 Specify the audio clip name that can be played when an event occurs. size 0, 1/4 The size of audio clip. prerecord_seconds 1~10 1/4 Indicates the seconds that can be waited before audio clip start to record. 7.
PAGE 226
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) polygon. * Only available when std is listed in "capability_motion_windomain" objsize 1 ~ 100 4/4 Percent of motion detection window. sensitivity 0 ~ 100 4/4 Sensitivity of motion detection window. * We replace "sensitivity" with "win_sensitivity". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
PAGE 227
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) to use this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. top 0 ~ 240 4/4 Top coordinate of window position. * Only available when "capability_motion_wintype" = rectangle.
PAGE 228
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0400a. Group: motion_c<0~(n-1)>_profile_i<0~(m-1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the vaule of " capability_nmotionprofile ", (capability_nmotionprofile > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable 4/4 Enable profile 1 ~ (m-1).
PAGE 229
© 2019 VIVOTEK INC. All Right Reserved NAME VALUE VIVOTEK SECURITY DESCRIPTION (get/set) 0 ~ 9999,0 ~ 9999, 0 ~ 9999,0 ~ 9999 * Only available when "capability_motion_wintype" = polygon. * Only available when std is listed in "capability_motion_windomain objsize 1 ~ 100 4/4 Percent of motion detection window. sensitivity 0 ~ 100 4/4 Sensitivity of motion detection window. * We replace "sensitivity" with "win_sensitivity".
PAGE 230
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. top 0 ~ 240 4/4 Top coordinate of window position. * Only available when "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain".
PAGE 231
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.17 Tampering Detection Settings Group: tampering_c<0~(n-1)> for n channel products (capability_tampering > 0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY (get/set) DESCRIPTION enable 4/4 Enable or disable tamper detection. threshold 0~100 4/4 Threshold of tamper detection. duration 10~600 4/4 If tampering value exceeds the "threshold" for more than "duration" second(s), then tamper detection is triggered.
PAGE 232
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.18 DDNS Group: ddns (capability_protocol_ddns > 0) NAME VALUE SECURITY (get/set) DESCRIPTION enable 6/6 Enable or disable the dynamic DNS. provider DyndnsDynamic, DyndnsCustom, Safe100 6/6 DyndnsDynamic => dyndns.org (dynamic) DyndnsCustom => dyndns.org Safe100 => safe100.net _hostnam string[128] e 6/6 Your DDNS hostname.
PAGE 233
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.21 UPnP Port Forwarding Group: upnpportforwarding NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable or disable the UPnP port forwarding service. upnpnatstatus 0~3 6/7 The status of UPnP port forwarding, used internally. 0 = OK, 1 = FAIL, 2 = no IGD router, 3 = no need for port forwarding NAME VALUE SECURITY DESCRIPTION (get/set) enableremotelog 6/6 Enable remote log.
PAGE 234
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.23 SNMP Group: snmp (capability_protocol_snmp > 0) NAME VALUE SECURITY (get/set) DESCRIPTION v2 6/6 SNMP v2 enabled. 0 for disable, 1 for enable v3 6/6 SNMP v3 enabled.
PAGE 235
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.24 Layout Configuration Group: layout NAME VALUE SECURITY (get/set) DESCRIPTION logo_default 1/6 0 => Custom logo 1 => Default logo logo_link string[128] http://www.vivot ek.
PAGE 236
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.25 Privacy Mask Group: privacymask_c<0~(n-1)> for n channel products and m privacy mask window. n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY (get/set) DESCRIPTION enable 4/4 Enable privacy mask. win_i<0~(m-1)>_enable 4/4 Enable privacy mask window. win_i<0~(m-1)>_name string[14] 4/4 Name of the privacy mask window.
PAGE 237
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE npx 0 ~ W,0 ~ H, 0 ~ W,0 ~ H, 0 ~ W,0 ~ H W: 0~ The current image width -1 H: 0~ The current image height -1 win_i<0~(m-1)>_polygo nstd 0 ~ 9999,0 ~ 9999, 0 ~ 9999,0 ~ 9999, 0 ~ 9999,0 ~ 9999, 0 ~ 9999,0 ~ 9999 SECURITY (get/set) DESCRIPTION position. (4 points: x0,y0,x1,y1,x2,y2,x3,y3) * Only available when "capability_image_c<0~(n-1)>_privacy mask_wintype" = polygon.
PAGE 238
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION >_maxpan" "capability_camctrl_c<0~(n-1)>_ buildinpt" is "1" win_i<0~(m-1)>_tilt "capability_ptz_c<0~(n-1) 4/4 >_mintilt" ~ "capability_ptz_c<0~(n-1) >_maxtilt" Tilt position of window position. * Only available when bit1 of "capability_camctrl_c<0~(n-1)>_ buildinpt" is "1" win_i<0~(m-1)>_zoom "capability_ptz_c<0~(n-1) 4/4 >_minzoom" ~ "capability_ptz_c<0~(n-1) >_maxzoom" Zoom position of window position.
PAGE 239
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.27 Capability Group: capability NAME VALUE SECURITY (get/set) DESCRIPTION api_httpversion This number start with 0301a. 0/7 The version of VIVOTEK WebAPI with 4 integers plus 1 alphabet, There are composed by "major version", "minor version", "revision","_platform".
PAGE 240
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION '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 241
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION naudioin 0, 0/7 The number of audio input channel. 0 means no audio input support. naudioout 0, 0/7 The number of audio output channel nvideoin 0/7 Number of video inputs. nvideoout 0, 0/7 Number of video out interface. nvideoinprofile 0/7 Number of video input profiles.
PAGE 243
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) recommended to use this> npreset DESCRIPTION remotefocus. If the value of this parameter is larger than 0, it means that the camera supports remotefocus function. bit 0 => Indicate whether to support both zoom and focus function. bit 1 => Only support zoom function. bit 2 => Only support focus function. bit 3 => Currently, this is a reserved bit, and the default value is 0. * It's strongly non-recommended to use this.
PAGE 244
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION For nvideoin >= 2, the definition is different: First all 32 bits are divided into groups for channel. 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.
PAGE 245
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION supportsd 0/7 Indicate whether to support local storage. fisheye 0/7 The parameter is used to determine whether the product is fisheye or not. tampering 0/7 Indicate whether to support tampering detection. tamperingmode tamper,toodark,toobri ght,tooblurry 0/7 Available tampering mode list. * Only available when "capability_tampering" is 1.
PAGE 246
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * Only available when [httpversion] >= 0301a media_num 0, 0/7 Number of media number. * We support this parameter when the version number (httpversion) is equal or greater than 0311c. storage_dbenabled 0/7 Media files are indexed in database. protocol_https < boolean > 0/7 Indicate whether to support HTTP over SSL.
PAGE 247
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION protocol_qos_cos 0/7 Indicate whether to support CoS. 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_nresolutio n 0/7 This equals "capability_videoin_c0_nresolution". * This is kept for compatibility.
PAGE 248
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE ec Integer> videoin_flexiblebitr ate SECURITY (get/set) DESCRIPTION "capability_videoin_c0_streamcodec". * This is kept for compatibility. 0/7 Indicate whether to support flexible bit rate control. videoout_codec A list of the available 0/7 codec types separated by commas Available codec list. "-": not supported timeshift 0/7 Indicate whether to support time shift caching stream.
PAGE 249
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION - (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 250
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "audio_intmic". audio_intmic <0~Positive Integer> 0/7 Internal (Built-in) Microphone. 0: Not support 1: Support Bit 0 for CH0, bit 1 for CH1, and so on. audio_extmic <0~Positive Integer> 0/7 External Microphone. 0: Not support 1: Support Bit 0 for CH0, bit 1 for CH1, and so on. audio_alarm <0~Positive Integer> 0/7 0: Not support audio alarm. 1: Support audio alarm.
PAGE 251
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION audioin_codec aac4, gamr, g711, g726, 0/7 Available audio codec. We take comma to split codec without any space. "aac4": Advanced Audio Coding (AAC) "gamr": Adaptive Multi-Rate (AMR) "g711": G.711 "g726": G.726 "-": Not supported. audioout_codec g711, 0/7 Available codec list for SIP. "-": Not supported.
PAGE 252
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION with pixels. "std": A normalized 0~9999 range. "-": Not supported. * Only available when "capability_smartstream_support" is 1 smartstream_mod e_autotracking 0/7 Indicate whether autotracking smart stream is supported. * Only available when "capability_smartstream_support" is 1 smartstream_mod e_manual 0/7 Indicate whether manual smart stream is supported.
PAGE 253
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION Bit 1 => Capture video raw data Bit 2 => Support encode jpeg Bit 3 => Capture audio raw data Bit 4 => Support event trigger Bit 5 => Support license registration Bit 6 => Support shared memory API Bit 7 => Support digital signature of package Bit 8 => Support snapshot vadp_npackage 0/7 Indicate the maximum number of VADP package that can be uploaded to the device.
PAGE 254
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION This is equivalent to"capability_camctrl_c0_privilege". * This is kept for compatibility. uart_httptunnel 0/7 Indicate whether to support HTTP tunnel for UART transfer. transmission_mod e Tx, Rx, Both 0/7 Indicate transmission mode of the machine: TX = server, Rx = receiver box, Both = DVR. network_wire 0/7 Indicate whether to support Ethernet.
PAGE 255
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * Only available when "capability_network_wireless" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0305a. wireless_apmode_ ssidprefix 0/7 Indicate the prefix of broadcasted SSID when camera is in wireless AP mode. * Only available when "capability_wireless_apmode_enable" is "1".
PAGE 256
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION media_videoclip_ maxlength 0/7 Maximum length (second) of a videoclip. media_videoclip_ maxpreevent 0/7 Maximum duration (second) after event occurred in a videoclip. image_iristype 0/7 Indicate iris type.  "piris": P-Iris  "dciris": DC-Iris  "-": No Iris control support * When "capability_iris"=0, this value must be "-".
PAGE 257
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION support seamless recording . * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_modn um 0, 0/7 The maximum MOD connection numbers. * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_modv ersion 0/7 Indicate MOD daemon version.
PAGE 258
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION localstorage_smart sd 0/7 The "Lifetime and Log SD Card" feature allows users to obtain the card's remaining lifetime information. 0: Non-support this feature 1: Support this feature * Only Sony SD card can support this function now. * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1.
PAGE 259
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Group: capability_camctrl_c<0~(n-1)> n denotes the value of "capability_nvideoin" (capability_ptzenabled > 0) * We support this group when the version number (httpversion) is equal or greater than 0303b. PARAMETER VALUE SECURITY (get/set) DESCRIPTION ptztunnel 0/7 Indicate whether to support ptztunnel in this video input.
PAGE 260
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) focusmode auto,onetimeauto,sp 0/7 otlight,manual DESCRIPTION Focus mode selection: "auto": Camera will automatically adjust the focus position full time to adapt a clear picture. "onetimeauto": Camera will automatically adjust the focus position one time, which follows any PTZ control.
PAGE 261
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) minpan 0, 0/7 The lower limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" maxpan 0, 0/7 The upper limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" minpanangle 0/7 The lower limit for pan angle.
PAGE 262
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION maxtiltangle 0/7 The upper limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" zoomspeedlv 0, 0/7 The maximum speed level of zoom motion. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoomm odule" is "1" minzoom 0, 0/7 The lower limit for zoom position.
PAGE 263
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Group: capability_daynight_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) support 0/7 Indicate whether the camera supports day/night mode switch builtinir 0/7 Indicate whether to support built-in IR led. builtinwled 0/7 Indicate whether to support built-in white led. externalir 0/7 Indicate whether to support external IR led.
PAGE 264
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) 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<0~(n-1)>_suppo rt" is 1.
PAGE 265
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) spectrum_support 0/7 Indicate whether to support proposed a brightness enhancement method based on CCM(Color Correction Matrix) model to improve the brightness effect of the images if the IR and blue light exists. * Only available when "capability_daynight_c<0~(n-1)>_suppo rt" is 1 spectrum_mode visible,ir,irenhanced, 0/7 blueenhanced Indicate the spectrum mode.
PAGE 266
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE mode auto,daynight,di,di2, 0/7 di3,di4,schedule, 266 - User's Manual SECURITY DESCRIPTION (get/set) Indicate the day / night switch mode. "auto": The Camera automatically judges the current operation mode by the level of ambient light detected. "daynight": support day mode and night mode. In day mode, the camera streams color video. In night mode, the camera streams black and white video in low light environments.
PAGE 267
© 2019 VIVOTEK INC. All Right Reserved VIVOTEK Group: capability_videoin_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY (get/set) DESCRIPTION lens_type fisheye, fixed, varifocal, changeable, motor, ics, 0/7 The lens type of this channel. "fisheye": Fisheye lens "fixed": Build-in fixed-focus lens. "varifocal": Build-in varifocal lens. "changeable": changeable lens. Like box-type camera, users can install any C-Mount or CS-Mount lens as they wish.
PAGE 268
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION rotationaffect 0/7 When rotation is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here. The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it.
PAGE 269
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION rotationangle 0/7 The different angles which camera supports for rotation. * Only avaliable when "capability_videoin_c<0~(n-1)>_rotation" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309b. orientation flip,mirror,rotatio 0/7 n Indicates the camera supports flip, mirror or rotation.
PAGE 270
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION resolution A list of 0/7 Resolution options in current video mode. These options are the possible options for "videoin_c_s_resolution". The last one is the maximum resolution in current mode. maxresolution A list of 0/7 Represent supported maximum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream".
PAGE 271
© 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) VIVOTEK DESCRIPTION mjpeg_maxframerate A list of and "-" Maximum fps that the device can encoded with MJPEG on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group. * This parameter may be changed when "videoin_c_cmosfreq"=50 or "videoin_c_modulation"=pal.
PAGE 272
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION h264_maxbitrate 0/7 Maximum bitrates of H.264. The unit is bps. * Only available when 'h264' is listed in "capability_videoin_codec". h264_profile baseline,main,hig 0/7 h Indicate H264 profiles * Only available when 'h264' is listed in "capability_videoin_codec". * We support this parameter when the version number (httpversion) is equal or greater than 0309a.
PAGE 274
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION cameraunit_name CU8131, CU8171, CU8161-H, CU8162-H, CU8163-H, CU8361-H, ..., 0/7 A "camera unit" name of a split-type camera system, which the camera unit and the video core are separated. -: If the camera is not a split-type camera system, the value of this parameter is "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302b.
PAGE 275
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) resolutionC1P A list of 0/7 Available resolutions of 1P mode of ceiling and floor mount. resolutionC2P A list of 0/7 Available resolutions of 2P mode of ceiling and floor mount. resolutionC1R A list of 0/7 Available resolutions of 1R mode of ceiling and floor mount. resolutionC4R A list of 0/7 Available resolutions of 4R mode of ceiling and floor mount.
PAGE 276
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) eptz 0, 0/7 Indicate this mode whether support eptz. For "nvideoin" = 1, the definition is as following: A 32-bits integer, each bit can be set separately as follows: Bit 0 => 1st stream supports ePTZ or not. Bit 1 => 2nd stream supports ePTZ or not, and so on. For nvideoin >= 2, the definition is different: First all 32 bits are divided into groups for channel.
PAGE 277
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) outputsize 0/7 The output size of source, equal to the captured size by device, in this video mode. The unit is pixel. This value is used as a basic coordinate system for many features, like ePTZ, privacy mask, motion, etc. * Source (most for image sensor) may perform scale or binning, etc on image data, and output data with smaller size. This parameter is designed to represent this.
PAGE 278
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) minresolution A list of 0/7 Represent supported minimum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream". * We support this parameter when the version number (httpversion) is equal or greater than 0304b. maxframerate A list of 0/7 Indicates frame rate that the video source outputs in this video mode.
PAGE 279
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxfps_h264 A list of and "-" 0/7 Maximum fps which the device can encoded with H.264 on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group.
PAGE 280
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION Bit 1 => Supports Contrast or not. Bit 2 => Supports Saturation or not. Bit 3 => Supports Sharpness or not. Bit 4 => Supports adjusting the image to proper position horizontally or not. Bit 5 => Supports adjusting the image to proper position vertically or not. hlm 0/7 Hightlight Mask: The function will strengthen the image contrast and mask the specified zone of image if any strong spot-light exists.
PAGE 281
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) exposurewin.mode .blc:disabled:, aespeed:disabled:, exposurelevel:hidd en:, exposurelevel:fixed :, exposurelevel:fixed :/, exposurelevel:rang ed:-, exposuremode:fixe d:auto : nonnegative integer DESCRIPTION affected functions are list here.
PAGE 282
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "capability_image_c<0~(n-1)>_wdrpro _mode" > 0 wdrc_mode 0, 1 0/7 0: Non-support WDR Enhanced 1: Support WDR Enhanced wdrc_supportlevel 0, 0/7 Indicate the support strength level of WDR Enhanced. wdrc_affect -, exposurewin.mode :fixed:auto, exposurewin.mode .
PAGE 283
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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. * When "wdrc"=0, this value must be "-" dnr 0,1 0/7 0: Non-support 3D digital noise reduction 1: Support 3D digital noise reduction dnrstrength 0/7 Indicate the support strength level of 3D digital noise reduction.
PAGE 284
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION is_strength 0/7 0: Non-support tuning strength of image stabilizer mode. 1: Support tuning strength of image stabilizer mode. * Only available when "capability_image_c<0~(n-1)>_is_mod e" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. is_supportlevel 0, 0/7 Indicate the support strength level of image stabilizer mode.
PAGE 285
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc: disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL.
PAGE 286
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION widerange, outdoor,indoor, sodiumauto, iristype piris, dciris, - 0/7 Indicate iris type. "piris": P-Iris "dciris": DC-Iris "-": No Iris control support * Note: For some cameras, this value may be varied depending on mounted lens. sensortype rawsensor, smartsensor, thermalsensor, - 0/7 Indicate sensor type.
PAGE 287
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_shuttervalu etype fixed, maximum, - 0/7 * One to one mapping to the mode type in "exposure_modetype". "fixed": The shutter value is the assigned value (videoin_c<0~(n-1)>_shuttervalue).
PAGE 288
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_automode_ affect -, exposurewin.mode .blc:hidden:, defog:disabled:, wdrpro:disabled:, exposurelevel:hidd en:, or others : nonnegative integer 0/7 When exposure auto mode is enabled, some features may become malfunction or be forced to a given value.
PAGE 289
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * Only available when auto is listed in "capability_image_c<0~(n-1)>_ exposure_modetype" and "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_shutterprior -, itymode_affect exposurewin.mode .
PAGE 290
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when shutterpriority is listed in "capability_image_c<0~(n-1)>_ exposure_modetype" and "capability_image_c<0~(n-1)>_ exposure_mode" is 1.
PAGE 291
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "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 292
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6.
PAGE 293
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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.
PAGE 294
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_winmode auto, custom, blc, hlc, center, 0/7 Available options for "exposurewin_c<0~(n-1)>_mode" * "-" means group: exposurewin is not supported. * When exposure_mode="0", this value must be set to "-". * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1.
PAGE 295
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION - (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 296
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_windomain qvga, px, std, - 0/7 The domain to set an exposure window. "qvga": a 320x240 range to represent the whole image. "px": Locate a window in the image with pixels. "std": A normalized 0~9999 range. "-": Not supported. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1.
PAGE 297
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION equal or greater than 0301a. exposure_maxrange "1,32000", "1,8000", -, or others 0/7 Available range for "videoin_c_maxexposure" "1,32000" => 1s ~ 1/32000s "1,8000" => 1s ~ 1/8000s etc. "-" means maximum exposure time is not available. * When "exposure_mode"=0, this value must be set to "-". * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1.
PAGE 298
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0310a. exposure_bracketing_ range A list of ratio For example: 2x,3x,4x 0/7 The input parameter decides how much ratio of exposure compensation will be expanded on the next stream, which is based on the original exposure time (first stream).
PAGE 299
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION agc_mingain "0,100", "-" 0/7 Available range for "videoin_c_mingain" “0,100” => 0~100 percent "-" means "videoin_c_mingain" is not available.
PAGE 300
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * When "flickerless" = 0, this value must be "-" defog_mode 0,1 0/7 0: Non-support defog 1: Support defog defog_strength 0, 1 0/7 0: Non-support tuning strength of defog 1: Support tuning strength of defog * If "capability_image_c<0~(n-1)>_defog_ mode"=1, this may be either 0 or 1.
PAGE 301
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "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 302
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) integer> DESCRIPTION supportive application of remotefocus in this channel. If the value of this parameter is larger than 0, it means that the camera supports remotefocus function in this channel. bit 0 => Indicate whether to support both zoom and focus function. bit 1 => Only support zoom function. bit 2 => Only support focus function. bit 3 => Currently, this is a reserved bit, and the default value is 0.
PAGE 303
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 1: Support auto tracking feature * We support this parameter when the version number (httpversion) is equal or greater than 0302a. smartsensor_iristotalr ange A list of iris value 0/7 Available total step for iris value. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
PAGE 304
VIVOTEK NAME © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION * We support this parameter when the version number (httpversion) is equal or greater than 0309d. palette_support 0/7 Indicate support color palettes or not. Thermal cameras provide a choice of color palettes on the camera, that help quickly distinguish thermal variations and patterns in an image. The color tones correspond to the apparent surface temperatures of the target.
PAGE 305
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.28 Customized Event Script Group: event_customtaskfile_i<0~2> PARAMETER VALUE SECURITY (get/set) DESCRIPTION name string[40] 6/6 Custom script identification of this entry. date string[4~20] 6/6 Date of custom script. time string[4~20] 6/6 Time of custom script. 7.
PAGE 306
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) trigger boot, di, pir, motion, seq, recnotify, tampering, vi, volalarm, visignal, vadp, smartsd 6/6 Indicate the trigger condition: "boot" = System boot. "di"= Digital input. "pir"= PIR detection. "motion" = Video motion detection. "seq" = Periodic condition. "visignal" = Video input signal loss. "recnotify" = Recording notification. "tampering" = Tamper detection.
PAGE 307
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) vi 0, 6/6 Indicate the source id of vi trigger. This field is required when trigger condition is “vi”. One bit represents one digital input. The LSB indicates VI 0. vadp 0, 6/6 Indicate the source id of vadp event notification. Each bit corresponds to one vadp source, and the LSB indicates source id 0.
PAGE 308
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) endtime hh:mm 6/6 End time of the weekly schedule. (00:00 ~ 24:00 sets schedule as always on) lowlightcondition 0, 1 6/6 Switch on white light LED in low light condition 0 => Do action at all times 1 => Do action in low-light conditions action_do_i<0~(ndo-1)>_ enable 6/6 Enable or disable trigger digital output.
PAGE 309
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_server_i<0~4>_m NULL, 0~4,101 edia 6/6 Index of the attached media. 101 means "Recording Notify" action_server_i<0~4>_da tefolder 6/6 Enable this to create folders by date, time, and hour automatically. action_goto_enable 6/6 Enable/disable ptz goto preset position on event triggered. * Only available when "capability_ptzenabled" > 0.
PAGE 310
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) tampering 0, 6/6 Indicate the source channel id of tampering detection. A 4-bit integer, each bit represents each channel. bit 0 => tampering detection for first channel. bit 1 => tampering detection for second channel. bit 2 => tampering detection for third channel. bit 3 => tampering detection for fourth channel.
PAGE 311
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) ftp_location string[128] 6/6 Location to upload or store the media. ftp_passive 6/6 Enable or disable passive mode. 0 = disable passive mode 1 = enable passive mode email_address string[128] 6/6 Email server address. email_sslmode 6/6 Enable support SSL. email_port 0~65535 6/6 Port to connect to the server.
PAGE 312
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.31 Media Setting for Event Action Group: media_i<0~(n-1)> n denotes the value of "capability_media_num" (capability_media_num > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) Name string[40] 6/6 Identification of this entry Type snapshot, systemlog, videoclip, recordmsg 6/6 Media type to send to the server or store on the server. snapshot_channel 0~"capability_nvideoin"-1 6/6 Indicate the source of media channel. 0 means the first channel.
PAGE 313
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) snapshot_datesuffix 0, 1 6/6 snapshot_preevent 0~" 6/6 capability_media_snapshot_ maxpreevent" Indicates the number of pre-event images. snapshot_postevent 0~" 6/6 capability_media_snapshot_ maxpostevent" Indicates the number of post-event images. videoclip_channel 0~"capability_nvideoin"-1 Indicate the source of media channel. 0 means the first channel. 1 means the second channel.
PAGE 314
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE videoclip_maxsize 50 ~ " 6/6 capability_media_videoclip_ maxsize" 314 - User's Manual SECURITY DESCRIPTION (get/set) Maximum size of one video clip file in Kbytes.
PAGE 315
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.32 Recording Group: recording_i<0~(n-1)> n denotes the value of "capability_nrecording" (capability_nrecording > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] 6/6 Identification of this entry. trigger schedule, networkfail 6/6 The event trigger type schedule: The event is triggered by schedule networkfail: The event is triggered by the failure of network connection. enable 6/6 Enable or disable this recording.
PAGE 316
VIVOTEK PARAMETER © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY DESCRIPTION (get/set) maxretentiontime 6/6 To specify the expired time for automatic clean up, and it only takes effect for video clip generated by recording_i <0~1>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss] S’ , similar with ISO8601 with symbols P Ex. P7D, it means 7 days. P1DT10H, it means 1 days and 10 hours. The parameter takes effect when autocleanup_ maxretentiontime_recording_enabled is enabled.
PAGE 317
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) weekday 0~127 6/6 Indicate which weekday is scheduled. One bit represents one weekday. bit0 (LSB) = Saturday bit1 = Friday bit2 = Thursday bit3 = Wednesday bit4 = Tuesday bit5 = Monday bit6 = Sunday For example, to detect events on Friday and Sunday, set weekday as 66. begintime hh:mm 6/6 Start time of the weekly schedule. endtime hh:mm 6/6 End time of the weekly schedule.
PAGE 318
VIVOTEK PARAMETER © 2019 VIVOTEK INC. All Right Reserved VALUE SECURITY DESCRIPTION (get/set) adaptive_preevent 0~9 6/6 Indicate when is the adaptive recording started before the event trigger point (seconds) adaptive_postevent 0~10 6/6 Indicate when is the adaptive recording stopped after the event trigger point (seconds) 7.33 HTTPS Group: https (capability_protocol_https > 0) NAME VALUE SECURITY (get/set) DESCRIPTION enable 6/6 To enable or disable secure HTTP.
PAGE 319
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION unit string[64] VIVOTEK Inc. 6/6 Organizational unit name in thecertificate information. commonname string[64] www.vivotek.com 6/6 Common name in the certificate information. validdays 0 ~ 3650 6/6 Valid period for the certification. 7.34 Storage Management Setting Group: disk_i<0~(n-1)> n is the total number of storage devices.
PAGE 320
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Group: autocleanup (capability_localstorage_supportedge > 0) PARAMETER VALUE SECURITY (get/set) DESCRIPTION enabled 6/6 Enable automatic clean up method. Expired and not locked media files will be deleted. maxretentiontime_record ing_enabled 6/6 Enable automatic clean up method for video clip generated by recording task. The parameter takes effect when autocleanup_enabled is enabled.
PAGE 321
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE maxretentiontime_others _maxage SECURITY (get/set) DESCRIPTION 6/6 To specify the expired time for automatic clean up, and it takes effect for all media files except media files generated by recording task. 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.
PAGE 322
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION s<0~(m-1)>_size 1/6 ROI width and height. The width value must be multiples of 16 and the height value must be multiples of 8 * The minimal window size is 64x64, and then resolution_W, resolution_H is the value in current stream. * If the stream doesn’t support ePTZ, the permissions of this parameter must be set as 1/7. 7.
PAGE 323
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION zoomspeed -5 ~ 5 1/4 Zoom speed * Only available when "capability_fisheye" is 1 1/7 Zoom speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.) 1/4 Auto pan/patrol speed * Only available when "capability_fisheye" is 1 1/7 Auto pan/patrol speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.
PAGE 324
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION preset_i<0~19>_pos 1/4 Left-top corner coordinate of the preset. * Only available when "capability_fisheye" is 1 1/7 Left-top corner coordinate of the preset. (It should be set by ePreset.cgi rather than by setparam.cgi.) 1/4 Width and height of the preset. * Only available when "capability_fisheye" is 1 1/7 Width and height of the preset. (It should be set by ePreset.
PAGE 325
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.38 Seamless Recording Setting Group: seamlessrecording (capability_localstorage_seamless> 0) PARAMETER VALUE SECURITY (get/set) DESCRIPTION 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 326
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.39 VIVOTEK Application Development Platform Setting Group: vadp NAME VALUE SECURITY DESCRIPTION (get/set) version 6/7 Indicate the VADP version. resource_total_memory 0, 6/7 Indicate total available memory size for VADP modules. resource_total_storage 0, 6/7 Indicate total size of the internal storage space for storing VADP modules.
PAGE 327
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Group: vadp_module_i<0~(n-1)> for n VADP package number (capability_vadp_npackage > 0) n denotes the value of "capability_vadp_npackage". NAME VALUE SECURITY (get/set) DESCRIPTION enable 6/6 Indicate if the module is enabled or not. If yes, also add the index of this module to the module_order. name string[40] 6/6 Module name extendedname string[40] 6/6 Extended module name.
PAGE 328
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION enable 6/6 Enable or disable the schedule mode to control the execution of the VADP package begintime hh:mm 6/6 Begin time of the schedule endtime hh:mm 6/6 End time of the schedule NAME VALUE SECURITY (get/set) DESCRIPTION ntrigger 0, 6/7 Indicate the number of topics to be transferred to event manager for trigger.
PAGE 329
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION The dwelling time of each patrol point, separated by “,” preset_i<0~(k-1)>_nam e string[40] 1/4 Name of the preset location. preset_i<0~(k-1)>_ dwelling 0 ~ 999 1/4 The dwelling time of each preset location uart 0~" capability_nuar t"-1 1/4 Select corresponding uart (capability_nuart>0). cameraid 0~255 1/4 Camera ID controlling external PTZ camera. isptz 0~2 1/4 0: disable PTZ commands.
PAGE 330
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION All Camera IDs on the same controlling system (NVR or rs485 keyboard) have to be distinct. Therefore, once you send a controlling signal, each camera will only accept the inputs with the corresponding ID.
PAGE 331
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION xzoom preset_i<0~(k-1)>_focus capability_ptz_ 1/4 c<0~(n-1)>_min focus ~ capability_ptz_ c<0~(n-1)>_ma xfocus Focus position at each preset location. preset_i<0~(k-1)>_ dwelling 0 ~ 999 1/4 The dwelling time of each preset location preset_i<0~(k-1)>_focus setting sync, fixcurrent 1/4 The focus mode of each preset, which is essential and should be grouped with “preset_i<0~(k-1)>_name.
PAGE 332
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION xfocus digitalzoom 1/4 Enable/disable digital zoom zoomenhance 1/4 Enable /disable zoom enhancement returnhome 1/4 Enable/disable return home while idle. returnhomeinterval 1~999 1/4 While idle over this time interval, idle action will be taken.
PAGE 334
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) n-1)>_minpan ~ capability_ptz_c<0~( n-1)>_maxpan DESCRIPTION location. preset_i<0~(k-1)>_tilt capability_ptz_c<0~( n-1)>_mintilt ~ capability_ptz_c<0~( n-1)>_maxtilt 1/4 Tilt position at each preset location. preset_i<0~(k-1)>_zoom capability_ptz_c<0~( n-1)>_minzoom ~ capability_ptz_c<0~( n-1)>_maxzoom 1/4 Zoom position at each preset location.
PAGE 335
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION n-1)>_maxpan axisy capability_ptz_c<0~( n-1)>_mintilt ~ capability_ptz_c<0~( n-1)>_maxtilt 1/4 Custom home tilt position. axisz capability_ptz_c<0~( n-1)>_minzoom ~ capability_ptz_c<0~( n-1)>_maxzoom 1/4 Custom home zoom position. axisf capability_ptz_c<0~( n-1)>_minfocus ~ capability_ptz_c<0~( n-1)>_maxfocus 1/4 Custom home focus position. axisflip 1/4 Custom home flip side.
PAGE 336
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION Recorded tour: unnecessary. tour_i<0~19>_direction forward,backward,ra ndom 1/4 User can choose which direction the preset tour goes. "forward": preset tour goes in forward order. "backward": preset tour goes in backward order. "random": the presets of the tour will be recalled randomly. * Only available when "capability_presettourdirection" is 1.
PAGE 337
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.43 UART Control Group: uart (capability_nuart > 0 and capability_fisheye = 0) NAME VALUE SECURITY (get/set) DESCRIPTION ptzdrivers_i<0~19, 127>_name string[40] 1/4 Name of the PTZ driver. ptzdrivers_i<0~19, 127>_location string[128] 1/4 Full path of the PTZ driver. enablehttptunnel 1/4 Enable HTTP tunnel channel to control UART.
PAGE 338
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION speedlink_i<0~4>_n ame string[40] 1/4 Additional PTZ command name. speedlink_i<0~4>_c md string[40] 1/4 Additional PTZ command list. ptzdriver 0~19, 127 (custom), 128 (no driver) 1/4 The PTZ driver is used by this COM port. 7.
PAGE 339
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION stopbit 1,2 4/4 "1": One stop bit is transmitted to indicate the end of a byte. "2": Two stop bits are transmitted to indicate the end of a byte. If you want to transfer the stopbit for 150% of the normal time used to transfer one bit, the uart_i<0~(n-1)>_stopbit should be set as 2 and the uart_i<0~(n-1)>_databit set as 5 as well. uartmode rs485 4/7 RS485 mode. 7.
PAGE 340
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Group: lens_default_i<0~(n-1)> n denotes the value of "lens_default_totalnumbers" NAME VALUE SECURITY (get/set) DESCRIPTION name 6/7 Default lens name Group: lens_user_i<0~(n-1)> n denotes the value of "lens_user_totalnumbers" NAME VALUE SECURITY (get/set) DESCRIPTION name 6/7 User-defined lens name 7.46 Fisheye Info.
PAGE 341
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION [0~359]. Pan range of wall mount is [-90~90]. s<0~(m-2)>_region_t -90~90 ilt 1/4 Tilt home angle of regional view Tilt range of ceiling/floor mount is [0~90]. Tilt range of wall mount is [-90~90]. s<0~(m-2)>_region_ zoom 1/4 Zoom home ratio of regional view 100~300 PLEASE REFER TO FISHEYE LOCAL DEWARP API 7.
PAGE 342
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 7.50 Wireless Group: wireless (capability_network_wireless > 0) PARAMETER VALUE SECURITY (get/set) DESCRIPTION ssid string[32] 6/6 SSID for wireless lan settings. wlmode Infra, Adhoc 6/6 Wireless mode. Infra: Infrastructure channel 1~11 1~13 10~11 10~13 1~14 6/6 A list of WLAN channels. Countries apply their own regulations to the allowable channels.
PAGE 343
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION key1 password [26] 6/6 WEP key1 for encryption. * Only valid when "wireless_encrypt" is "wep" key2 password [26] 6/6 WEP key2 for encryption. * Only valid when "wireless_encrypt" is "wep" key3 password [26] 6/6 WEP key3 for encryption. * Only valid when "wireless_encrypt" is "wep" key4 password [26] 6/6 WEP key4 for encryption.
PAGE 344
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8. Useful Functions 8.1Drive the Digital Output (capability_ndo > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: [&do2=] [&do3=][&do4=] Where state is 0 or 1; “0” means inactive or normal state, while “1” means active or triggered state.
PAGE 345
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved [di3=]\r\n where can be 0 or 1. Example: Query the status of digital input 1 . Request: http://myserver/cgi-bin/dido/getdi.cgi?di1 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n di1=1\r\n 8.3Query Status of the Digital Output (capability_ndo > 0) Note: This request requires Viewer privileges Method: GET/POST Syntax: http:///cgi-bin/dido/getdo.
PAGE 346
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n do1=1\r\n 8.4Capture 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.
PAGE 347
© 2019 VIVOTEK INC. All Right Reserved VIVOTEK 8.5Account Management Note: This request requires Administrator privileges. Method: 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 348
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.6System Log 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.7Upgrade Firmware Note: This request requires Administrator privileges. Method: POST Syntax: http:///cgi-bin/admin/upgrade.
PAGE 349
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.8ePTZ 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 350
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved b. continuous movement If you trigger a continuous movement, you have to handle the stop time by yourself. A continuous movement is convenient to integrate a joystick control. http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=tele&zs=1 http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed.
PAGE 351
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION y movement w The scaled area size h resolution The resolution of streaming. vx The direction of movement, used for joystick control. vy vs 0~7 Set the speed of movement, “0” means stop. x x-coordinate clicked by user. It will be the x-coordinate of center after movement. y y-coordinate clicked by user.
PAGE 352
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.9ePTZ Recall (capability_eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http:///cgi-bin/camctrl/eRecall.cgi?channel=&stream=& recall=[&return=] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source. stream <0~(m-1)> Stream. recall Text string less than 40 characters One of the present positions to recall.
PAGE 353
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION addpos delpos return Redirect to the page after the parameter is assigned. The should be the relative path according to the root of camera. If you omit this parameter, it will redirect to an empty page.
PAGE 354
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.12 UART HTTP Tunnel Channel (capability_nuart > 0) Note: This request requires Operator privileges. Method: GET and POST Syntax: http:///cgi-bin/operator/uartchannel.cgi?[channel=] ------------------------------------------------------------------------GET /cgi-bin/operator/uartchannel.
PAGE 355
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.13 Event/Control HTTP Tunnel Channel (capability_evctrlchannel > 0) Note: This request requires Administrator privileges. Method: GET and POST Syntax: http:///cgi-bin/admin/ctrlevent.cgi ------------------------------------------------------------------------GET /cgi-bin/admin/ctrlevent.
PAGE 356
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.14 Get SDP of Streams Note: This request requires Viewer access privileges. Method: GET/POST Syntax: http:///_accessname> “m” is the stream number. “network_accessname_<0~(m-1)>” is the accessname for stream “1” to stream “m”. Please refer to the “subgroup of network: rtsp” for setting the accessname of SDP. You can get the SDP by HTTP GET.
PAGE 357
© 2019 VIVOTEK INC. All Right Reserved VIVOTEK 8.16 Send Data (capability_nuart > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http:///cgi-bin/viewer/senddata.cgi? [com=][&data=][&flush=] [&wait=] [&read=] PARAMETER VALUE DESCRIPTION com 1 ~ The target COM/RS485 port number. data is a series of digits from 0 ~ 9, A ~ data>[,
PAGE 358
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.17 Storage Managements (capability_stroage.dbenabled > 0) Note: This request requires administrator privileges. Method: GET and POST Syntax: http:///cgi-bin/admin/lsctrl.cgi?cmd=[&=…] The commands usage and their input arguments are as follows. PARAMETER VALUE DESCRIPTION cmd_type Required. Command to be executed, including search, insert, delete, update, and queryStatus.
PAGE 359
© 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE VIVOTEK DESCRIPTION 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 360
VIVOTEK PARAMETER © 2019 VIVOTEK INC. All Right Reserved VALUE DESCRIPTION Ex. label=1 Ex. Delete records whose key numbers are 1, 4, and 8. 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.
PAGE 361
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.18 Virtual Input (capability_nvi > 0) Note: Change virtual input (manual trigger) status. Method: GET Syntax: http:///cgi-bin/admin/setvi.cgi?vi0=[&vi1=][&vi2=] [&return=] PARAMETER VALUE DESCRIPTION vi state[(duration)nstate] Where "state" is 0, 1. “0” means inactive or normal state while “1” means active or triggered state. Where "nstate" is next state after duration.
PAGE 362
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Examples: setvi.cgi?vi0=0(15000)1 setvi.cgi?vi0=1 Request 2 will not be accepted during the execution time(15 seconds). 8.19 Open Timeshift Stream (capability_timeshift > 0, timeshift_enable=1, timeshift_c_s_allow=1) Note: This request requires Viewer access privileges.
PAGE 363
© 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DEFAULT VIVOTEK DESCRIPTION ignored. reftime mm:ss The time camera receives the request. Reference time for maxsft and minsft. (This provides more precise time control to eliminate the inaccuracy due to network latency.) Ex: Request the streaming from 12:20 rtsp://10.0.0.1/live.sdp?maxsft=10&reftime=12:30 forcechk N/A N/A Check if the requested stream enables timeshift, feature and if minsft is achievable.
PAGE 364
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.20 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 365
© 2019 VIVOTEK INC. All Right Reserved VIVOTEK PARAMETER VALUE DESCRIPTION function Function type zoom - Move focus motor focus – Move focus motor auto – Perform auto focus scan – Perform focus scan stop – Stop current operation positioning – Position the motors irisopen – Fully open iris. It will maintain fully open iris status until sending function=irisenable cgi. irisenable – return back to user setting status of iris.
PAGE 366
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION direction direct, forward, backward Motor’s moving direction. It works only if function=zoom or function=focus. position 0~ Motor’s position. It works only if function=zoom or function= focus and direction=direct. is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from "function=getstatus" steps 1 ~ Motor’s moving steps.
PAGE 367
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.21 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 368
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function focus, auto, scan, stop, positioning, irisopen, irisenable, resetfocus, getstatus Function type focus – Move focus motor auto – Perform auto focus scan – Perform focus scan stop – Stop current operation positioning – Position the motors resetfocus – reset focus position to default irisopen – Fully open iris. It will maintain fully open iris status until sending function=irisenable cgi.
PAGE 369
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION position 0~ Motor’s position. It works only if function=focus and direction=direct. is refer to remote_focus_focus_motor_max which replied from "function=getstatus" steps 1 ~ Motor’s moving steps. It works only if function=focus and direction=forward or direction=backward.
PAGE 370
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.23 Upload Files Note: This request requires Administrator privileges. Method: POST Syntax: For daylight saving time configuration file: http:///cgi-bin/admin/upload_dst.cgi Post data: filename =\r\n \r\n For language file: http:///cgi-bin/admin/upload_lan.cgi Post data: filename =\r\n \r\n For setting backup file: http:///cgi-bin/admin/uploa
PAGE 371
© 2019 VIVOTEK INC. All Right Reserved VIVOTEK 8.24 Update Lens Configuration (capability_image_c<0~(n-1)>_lensconfiguration_support > 0) Note: This request requires Administrator privileges. Method: GET Syntax: For list a name of lens currently used: http:///cgi-bin/admin/update_lens.cgi?get_currentlens For list all names of lens installed in camera: http:///cgi-bin/admin/update_lens.
PAGE 372
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved Post data: upload_lens_profile_input = \r\n \r\n Server will accept the file named to upload the lens profile to camera. 8.25 Media on Demand (capability_localstorage.modnum > 0) Media on demand allows users to select and receive/watch/listen to metadata/video/audio contents on demand. Note: This request requires Viewer access privileges. Syntax: rtsp:///mod.
PAGE 374
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.26 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 375
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION left Move left. right Move right. 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.
PAGE 376
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.27 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 377
© 2019 VIVOTEK INC. All Right Reserved VIVOTEK 8.28 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 378
VIVOTEK PARAMETER © 2019 VIVOTEK INC. All Right Reserved VALUE DESCRIPTION down Move camera down. left Move camera left. right Move camera right. speedpan -5 ~ 5 Set the pan speed. speedtilt -5 ~ 5 Set the tilt speed. speedzoom -5 ~ 5 Set the zoom speed. speedfocus -5 ~ 5 Set the focus speed. speedapp -5 ~ 5 Set the auto pan/patrol speed. auto pan Auto pan. patrol Auto patrol. stop Stop camera. wide Zoom larger view with current speed.
PAGE 379
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION focus auto Auto focus. far Focus on further distance. near Focus on closer distance. sync Applies the selected focus mode in camctrl_c<0~(n-1)>_focusmode to this preset. fixcurrent Applies the current focus position to this preset. focusseting * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20.
PAGE 380
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION getpanangle Get the current pan angle. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" gettilt 0, Get the current tilt position. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" gettiltangle getzoom 0, Get the current zoom position.
PAGE 381
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmintiltangle Get the lower limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmaxtiltangle Get the upper limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getminzoom 0, Get the lower limit for zoom position.
PAGE 382
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.30 Preset Locations (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Operator privileges. Method: GET/POST Syntax: http:///cgi-bin/operator/preset.cgi?[channel=] [&addpos=][&delpos=][&return=] PARAMETER VALUE DESCRIPTION addpos string[30] Add one preset location to the preset list. channel 0~"capability_nvideoin"-1 Channel of the video source.
PAGE 383
© 2019 VIVOTEK INC. All Right Reserved VIVOTEK 8.31 SmartSD (capability_localstorage_smartsd > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/smartsd.
PAGE 384
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function getstatus Function type getstauts : Information of smartSD internal status return value as below: smartsd_lifetime_num: Accumulated amount of data that has been written smartsd_lifetime_den: Card-guaranteed amount of data that can be written smartsd_lifetime_rate: The ratio of smartsd_lifetime_num to smartsd_lifetime_den. It means the accumulated percentage amount of flash block has been written.
PAGE 385
© 2019 VIVOTEK INC. All Right Reserved VIVOTEK 8.32 Connect to AP (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION N/A N/A Apply the wireless settings and connect to AP. 8.33 Get Wireless Information (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/getwirelessinfo.
PAGE 386
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.34 Get Wireless Signal Strength (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/getwlsignalstrength.cgi PARAMETER VALUE DESCRIPTION N/A N/A Get wireless signal strength. 8.35 WPS Transaction (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/start_wps.
PAGE 387
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.36 Peripheral Control (capability_peripheral_c<0~(n-1)>_ devicecontrol > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: (for control API) http:///cgi-bin/admin/peripheral.
PAGE 388
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION _support=1 washer_status washer_dwelltime on Enable the functionality of washer control system. *Only available when capability_peripheral_c<0~(n-1)>_washer _support=1 off Disable the functionality of washer control system. *Only available when capability_peripheral_c<0~(n-1)>_washer _support=1 15~999 Apply washer washer control system operation time (including the time when spraying and wiper actions take place).
PAGE 389
© 2019 VIVOTEK INC. All Right Reserved VIVOTEK [&heater_status] – Get heater status Example: http://myserver/cgi-bin/admin/peripheral.cgi?channel=0&operation=get&supportdevice&washer_ status Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n supportdevice=washer,heater\r\n washer_status=off\r\n PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. supportdevice N/A Get support peripheral device.
PAGE 390
VIVOTEK PARAMETER © 2019 VIVOTEK INC. All Right Reserved VALUE DESCRIPTION *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 heater_supportstatus N/A Get the support status of heater control system. *Only available when capability_peripheral_c<0~(n-1)>_heater_suppo rt=1 heater_status Get the current heater status.
PAGE 391
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.37 Optimized IR control (capability_daynight_c<0~(n-1)>_optimizedir > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/optimizedir.cgi?function=[&channel=] PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. function getstatus, onetimeauto "onetimeauto": Camera will automatically adjust the IR zone one time only.
PAGE 392
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved http://myserver/cgi-bin/admin/optimizedir.cgi?function=getstatus Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irmode='auto'" "optimizedir_c0_irnum='5'" "optimizedir_c0_irstrength='1,97,100,100,100'" "optimizedir_c0_irstatus='normal'" Syntax: (for control API) http:///cgi-bin/admin/optimizedir.
PAGE 393
© 2019 VIVOTEK INC. All Right Reserved VIVOTEK Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=settoall&irmode=manual&str ength=100 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irstrength='100,100,100,100,100'" "optimizedir_c0_irmode='manual'" Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&irmode=auto&strength= 50,70,50,50,50 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no
PAGE 394
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved http:///cgi-bin/admin/optimizedir.cgi?channel=&operation=get [&support_irmode] – list all adjustment mode that IR supports [&irmode] – Get current IR mode [&irnum] – Get the number of IR zone PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. support_irmode N/A List all adjustment mode that IR supports irmode N/A Get the current IR control mode.
PAGE 395
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved 8.38 Lens Thermal Control (capabiltiy_image_c<0~(n-1)>_sensortype=thermalsensor) Note: This request requires Administrator privileges. Method: GET/POST Syntax: (for control API) http:///cgi-bin/admin/thermalctrl.cgi?operation=set &action= Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n OK Example: http://myserver
PAGE 396
VIVOTEK © 2019 VIVOTEK INC. All Right Reserved \r\n ERROR: fail PARAMETER VALUE DESCRIPTION action shuttercompensate Camera will do shutter compensate. Syntax: (for query API) http:///cgi-bin/admin/thermalctrl.cgi?operation=get&version= PARAMETER VALUE DESCRIPTION version N/A Indicate lensctrl thermal version Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?function=get&version Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n version
PAGE 397
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 398
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.