User Manual

ManualsBrandsVivotek ManualsSecurity Cameras720 x 480 Outdoor Thermal Imaging Network Bullet Camera, 19mm Lens

Table Of Contents

User’s Manual

Thermal Imaging • Uncooled VOx Micro Bolometer • IP67 • IK10 •

360x240 or 720x480 • Smart Stream II • 8-14µm Spectral range

Thermal Bullet

Network Camera

TB9330-E, TB9331-E

Rev. 1.0

Summary of content (360 pages)

PAGE 1
TB9330-E, TB9331-E Thermal Bullet Network Camera User ’s Manual Thermal Imaging • Uncooled VOx Micro Bolometer • IP67 • IK10 • 360x240 or 720x480 • Smart Stream II • 8-14µm Spectral range Rev. 1.
PAGE 2
VIVOTEK Table of Contents Overview ��3 Revision History ��4 Read Before Use ��
PAGE 3
VIVOTEK Recording > Recording settings �� 134 Local storage > SD card management �� 139 Local storage > Content management �� 140 Appendix ��
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 ■ TB9330-E, or TB9331-E [8.8mm (63.4° horizontal), 19mm (32° horizontal), 35mm (22° horizontal), 50mm (15.5° horizontal)] ■ ■ ■ ■ L-wrench, screws. Sunshield, sunshield extension bracket, and screws. Quick Installation Guide & alignment sticker. AM-719 Junction box. IMPORTANT: To prevent thermal damage to the sensor, never point the camera at the sun or other high tensity light sources (such as a welding arc.
PAGE 6
VIVOTEK Coverage Table Calculated with Johnson's criteria and vary in different weather conditions. TB9330 Maximum resolution Focal length FOV Human 1.8x0.5m (5x1ft) Vehicle 4x1.5m (13x4ft) 384x256 8.8mm Horizontal 38.3º Vertical 26.1º Detection (1.5 pixels) 262m (859ft) Recognition (6 pixels) 66m (216ft) I d e n t i f i c a t i o n ( 1 2 33m (108ft) pixels) Detection (1.5 pixels) 800m (2,624ft) Recognition (6 pixels) 200m (656ft) Identification (12 100m (328ft) pixels) 19mm 18.3º 12.
PAGE 7
VIVOTEK Physical Description Outer View Sunshield AM-719 Lens SD card slot Reset button Status LED Note that normally you do not need to open the canister of the camera.
PAGE 8
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 IMPORTANT: 802.3at ON 100~240V AC OFF 7 5 3 1 8 6 4 2 LAN/PoE 9 10 GE LAN GE LAN 12/24V 1A or 2A The camera comes with an embedded heater and requires an 802.3at PoE switch or 12V/24V 2A power when operating in a cold weather.
PAGE 9
VIVOTEK Hardware Installation 1. Jot down the camera's MAC address for later reference. XXXXXX 0002D10766AD 2. Remove the small access panel to access the SD card slot and install a MicroSD card. Installl the panel when done. 64GB 10 1 I 3. Use the included alignment sticker to drill holes on the wall, and install the junction box. If preferred, drill a routing hole on the wall.
PAGE 10
VIVOTEK 4. If you need to route cables through a conduit, remove the plastic stopper underneath the junction box. 5. Route cables through the conduit, and install a 3/4" conduit to the junction box. Note that the conduit is user-supplied. Even if you route cables through the center hole, a conduit is still recommended for water-proofing.
PAGE 11
VIVOTEK 6. Install the sunshield first by installing an extension bracket, and then secure the sunshiled to the mount holes on the bracket by driving 2 screws. 7. Connect the safety tether to the anchor point at the back of the camera.
PAGE 12
VIVOTEK 8. If used, connect the AC/DC power, DI/DO, or audio wires to the terminal connectors. AC24V MIC P AC24V DC+ (12V) DC- MICMIC+ AUAU+ NC 485N icro 485P NC DI1DI1+ DO1DO1+ (5V) 9. 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 onnector. 5.5 ~ 12 - User's Manual 6.
PAGE 13
VIVOTEK 10. Secure the camera to the junction box using 4 included screws. x4 11. 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.
PAGE 14
VIVOTEK Software Installation 12. 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. 12-1. Run the Shepherd utility. 12-2. The program will conduct an analysis of your network environment.
PAGE 15
VIVOTEK 12-3. The program will search for all VIVOTEK network devices on the same LAN. 12-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: TB9330-E MAC:0002D1730202 R o HS This device complies with part 15 of the FCC rules.
PAGE 16
VIVOTEK 13-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. Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~. You can use them in the password combination. 13-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 17
VIVOTEK 14. Loosen, but not completely remove, the retention screws on the wall-mount bracket to adjust the camera’s shooting direction. You can pan, tilt, or rotate the camera.
PAGE 18
VIVOTEK 15. Tighten the retention screws when you are statisfied with the field of view.
PAGE 19
VIVOTEK DI/DO Diagram 1. The DO+ pin provides a 5V output, and the max. load is 50mA. 2. The max. voltage for DO- pins is 30VDC (External power). In order to control AC devices, the following diagram can be taken into consideration. This diagram uses a relay to control the ON/OFF condition of the AC device. 3. An external relay can be triggered by using the DO+ or by an external power source, depending on the type of relay you use. 4.
PAGE 20
VIVOTEK Wet contact with external DC power source to supply a relay. DIDO+ DI+ Switch DODC 0V DC External DC power AC NC NO External AC power with Protected Earth PE Relay External Device PE Dry contact and using camera’s DO+ to supply a relay.
PAGE 21
VIVOTEK LED Definitions Item LED status LED Definition 1 2 3 4 5 Steady Red Description Powered and system booting, or network failed Power off Network is disconnected Connected to network Red LED off Green LED off Steady Red and Green LED blinks every 1 sec. Green LED blinks every 1 sec. and RED Upgrading firmware LED blinks consecutively every 0.15 sec. Green and RED blink every 0.15 sec, Green Restoring defaults and RED light on, then blink again.
PAGE 22
VIVOTEK Network Deployment General Connection (PoE) When using a PoE-enabled switch The Network Camera is PoE-compliant, allowing transmission of power and data via a single Ethernet cable. Follow the below illustration to connect the Network Camera to a PoEenabled switch via Ethernet cable. PoE Switch 802.3at 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) 802.3at Non-PoE Switch NOTE: 1.
PAGE 23
VIVOTEK Ready to Use 1. A browser session with the Network Camera should prompt as shown below. 2. You should be able to see live video from your camera. You may also install the 32-channel recording software from the software CD in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents. IMPORTANT: • The "E" models, e.g., TB9330-E, are able to operate in low temperature environments.
PAGE 24
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 25
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 26
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 27
VIVOTEK ► By default, the Network Camera is not password-protected. To prevent unauthorized access, it is highly recommended to set a password for the Network Camera. For more information about how to enable password protection, please refer to Security on page 89. ► If you see a dialog box indicating that your security settings prohibit running ActiveX ® Controls, please enable the ActiveX ® Controls for your browser. 1. Choose Tools > Internet Options > Security > Custom Level. 2.
PAGE 28
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 29
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 30
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 22. To utilize this feature, please check the following settings on your Network Camera: 1.
PAGE 31
VIVOTEK Using VIVOTEK Recording Software The product software CD also contains a VAST recording software, allowing simultaneous monitoring and video recording for multiple Network Cameras. Please install the recording software; then launch the program to add the Network Camera to the Channel list. For detailed information about how to use the recording software, please refer to the user’s manual of the software or download it from http://www.vivotek.com. Tips: 1.
PAGE 32
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 33
VIVOTEK Camera Control Area Palette: This provides temperature imaging modes as color templates for the visualization of temperature differences. The White hot can be ideal for spotting targets, while the Black hot mode is good for situational awareness. 9 palettes are available: White hot, Black hot, Iron, Rain, Rainbow, Aurora, Arctic, Emerald, and Red hot. As soon as a palette is selected, the video feed also changes for stream viewing on a management software.
PAGE 34
VIVOTEK Note that the performance of the thermal imaging can vary depending one scenes. High contrast can be available when the sun has heated many objects. In a cold night, objects in the environment may all be of the same temperature, and little thermal differences can be detected. In a wet or foggy morning, the moisture coating on objects or living creatures can reduce the effects of themal imaging. Video Stream: This Network Camera supports multiple streams (streams 1 to 4) simultaneously.
PAGE 35
VIVOTEK Live Video Window ■ The following window is displayed when the video mode is set to H.264 or H.265: H.264 Protocol and Media Options Video Title Title and Time Zoom Indicator Video (TPC-AV) 2018/03/25 17:08:56 Time Video 17:08:56 2018/03/25 x4.0 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Video Settings on page 56. H.264 or H. 265 Protocol and Media Options: The transmission protocol and media options for H.264 or H.
PAGE 36
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 37
VIVOTEK Mute: Turn off the Mic volume on the local computer. The button becomes the after clicking the Mute button. Mic On button Full Screen: Click this button to switch to full screen mode. Press the “Esc” key to switch back to normal mode. ■ The following window is displayed when the video mode is set to MJPEG: Video Title Title and Time Video (HTTP-V) 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.
PAGE 38
VIVOTEK Client Settings This chapter explains how to select the stream transmission mode and saving options on the local computer. When completed with the settings on this page, click Save on the page bottom to enable the settings. H.265/H.264 Media Options Select to stream video or audio data or both. This is enabled only when the video mode is set to H.264. H.265/H.264 Protocol Options H.264 Protocol Options Depending on your network environment, there are four transmission modes of H.
PAGE 39
VIVOTEK Two way audio Half duplex: Audio is transmitted from one direction at a time, e.g., from a PC holding a web console with the camera. Full duplex: Audio is transmitted in both directions simultaneously. MP4 Saving Options Users can record live video as they are watching it by clicking page. Here, you can specify the storage destination and file name. Start MP4 Recording on the main Folder: Specify a storage destination on your PC for the recorded video files. The location can be changed.
PAGE 40
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 41
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 42
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 43
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 44
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 45
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 46
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 47
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 48
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 49
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 50
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 51
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 52
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 53
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 71). 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 54
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 55
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 56
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, Thermal settings, and Privacy mask. 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 57
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 58
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 Image Adjustment ■ Brightness: Adjust the image brightness level, which ranges from 0% to 100%. For hotter scenes during the day, higher brightness brings up more details; while in the colder night, lower brightness is suitable for details in an environment with a lower temperature.
PAGE 59
VIVOTEK Note that the Preview button has been cancelled, all changes made to image settings is directly shown on screen. 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 setting. You can also click on Profile mode to adjust all settings above in a tabbed window for special lighting conditions.
PAGE 60
VIVOTEK Privacy mask Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to address privacy concerns. 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 61
VIVOTEK Media > Video Stream settings This Network Camera supports multiple streams with frame sizes ranging from 384 x 256 to 960 x 640 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 960 x 640. ■ Stream 3: The default frame size for Stream 3 is set to the 720 x 480.
PAGE 62
VIVOTEK Media > Video ► All the items in the “Region of Interest” should not be larger than the “Output Frame Size“ (current maximum resolution).
PAGE 63
VIVOTEK Click the stream item to display the detailed information. The maximum frame size will follow your settings in the above Viewing Window sections. This Network Camera 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 64
VIVOTEK The frame rate will decrease if you select a higher resolution. ■ Intra frame period Determine how often for firmware to plant an I frame. The shorter the duration, the more likely you will get better video quality, but at the cost of higher network bandwidth consumption. Select the intra frame period from the following durations: 1/4 second, 1/2 second, 1 second, 2 seconds, 3 seconds, and 4 seconds. ■ Smart stream II ■ Dynamic Intra frame period High quality motion codecs, such as H.
PAGE 65
VIVOTEK 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 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.
PAGE 66
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 67
VIVOTEK ■ Bit rate control Constrained bit rate: • A complex scene generally produces a larger file size, meaning that higher bandwidth will be needed for data transmission. The bandwidth utilization is configurable to match a selected level, resulting in mutable video quality performance. The bit rates are selectable at the following rates: 20Kbps, 30Kbps, 40Kbps, 50Kbps, 64Kbps, 128Kbps, 256Kbps, 512Kbps, 768Kbps, 1Mbps, 2Mbps, 3Mbps, 4Mbps, 6Mbps, 8Mbps, 10Mbps, 12Mbps, 14Mbps, ~ to 40Mbps.
PAGE 68
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 69
VIVOTEK Media > Audio Audio Settings Mute: Select this option to disable audio transmission from the Network Camera to all clients. Note that if muted, no audio data will be transmitted even if audio transmission is enabled on the Client Settings page. In that case, the following message is displayed: External microphone input: Select the gain of the external audio input according to ambient conditions. Adjust the gain from 0% to 100%. Audio type: Select audio codec and the sampling bit rate . ■ G.
PAGE 70
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 71
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 72
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 73
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 74
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 75
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 76
VIVOTEK 76 - User's Manual
PAGE 77
VIVOTEK Network > Streaming protocols HTTP streaming To utilize HTTP authentication, make sure that your have set a password for the Network Camera first; please refer to Security > User account on page 89 for details. Authentication: Depending on your network security requirements, the Network Camera provides two types of security settings for an HTTP transaction: basic and digest.
PAGE 78
VIVOTEK URL command -- http://:/ For example, when the Access name for stream 2 is set to video2.mjpg: 1. Launch Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter. 3. The JPEG images will be displayed in your web browser. http://192.168.5.151/video2.
PAGE 79
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 80
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 81
VIVOTEK SIP SIP is short for Session Initiation Protocol. If necessary, you can change the default port number, 5060, to one between 1025 and 65535. Two way audio port: The Network Camera supports two way audio communication so that operators can transmit and receive audio simultaneously. By using the Network Camera’s built-in or external microphone and an external speaker, you can communicate with people around the Network Camera.
PAGE 82
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 83
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 84
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 85
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 86
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 87
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 88
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 89
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 90
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 43). Allow anonymous viewing: If you select this item, any client can access the live stream without entering a User ID and Password.
PAGE 91
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 92
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 93
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 94
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 95
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 96
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 97
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 98
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 99
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 100
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 101
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 102
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 103
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: 2018/05/20 09:57:30 x1.8 For e-PTZ related details, please refer to page 105.
PAGE 104
VIVOTEK Home page in the E-PTZ Mode x3.3 ■ The e-Preset Positions will also be displayed on the home page. Select one from the drop-down list, and the Network Camera will move to the selected position. ■ If you have set up different preset positions for different streams, you can select one of the video streams to display its separate preset positions.
PAGE 105
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 106
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 107
VIVOTEK PTZ Mechanical PTZ Operation Select the “Mechanical” tab to display the RS485 Settings: RS485 Settings Disable: Select this option to disable this function. PTZ camera: Select this option to enable PTZ operation. To utilize this feature, please connect the Network Camera to a PTZ driver or scanner via RS485 serial interface first. Then you can configure the PTZ driver and RS485 port with the following settings.
PAGE 108
VIVOTEK Transparent HTTP Tunnel: If you want to use your own RS-485 device, you can use UART commands to build a Transparent HTTP Tunnel. The UART commands will be sent through HTTP tunnel established between the RS-485 device and the camera. For detailed application notes, please refer to URL Commands started on page 144 or https://vivotek.force.com/Customers/s/ to search for the article.
PAGE 109
VIVOTEK Home page in Mechanical PTZ Mode The 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 preset position. 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 110
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 111
VIVOTEK ■ Event name: Enter a name for the event setting. ■ Enable this event: Select this checkbox to enable the event setting. ■ Priority: Select the relative importance of this event (High, Normal, or Low). Events with a higher priority setting will be executed first. ■ Detect next motion detection or digital input after seconds: Enter the duration in seconds to pause motion detection after a motion is detected. This can prevent event-related actions to take place too frequently. 1.
PAGE 112
VIVOTEK ■ Audio detection A preset threshold can be configured with an external microphone as the trigger to system event. The triggering condition can be an input exceeding or falling below a threshold. Audio detection can take place as a complement to motion detection or as a method to detect activities not covered by the camera's view. ■ Camera tampering detection This option allows the Network Camera to trigger when the camera detects that is is being tampered with.
PAGE 113
VIVOTEK Once the triggers are configured, they will be listed under the VADP option. 3. Action Define the actions to be performed by the Network Camera when a trigger is activated. ■ Trigger digital output for seconds Select this option to turn on the external digital output device when a trigger is activated. Specify the length of the trigger interval in the text box. ■ Backup media if the network is disconnected Select this option to backup media file on SD card if the network is disconnected.
PAGE 114
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 115
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 116
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 117
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 137 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 119 for detailed information.
PAGE 118
VIVOTEK Click 20180120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2018/01/20 2018/01/20 Click to go back to the previous level of the directory Click to delete selected items Click to delete all recorded data 2018/01/20 2018/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 119
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 120
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_20180513_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 121
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_20180513_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 122
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 123
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 124
VIVOTEK Applications > Motion detection This section explains how to configure the Network Camera to enable motion detection. A total of 5 motion detection windows can be configured. Motion Detection Setting 2: For special situations Motion Detection Setting 1: For normal situations Follow the steps below to enable motion detection: 1. Click New to add a new motion detection window. 2. In the Window Name text box, enter a name for the motion detection window.
PAGE 125
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 110. 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 126
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 135 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 127
VIVOTEK Applications > DI and DO Digital input: Select High or Low as the Normal status for the digital input connection. Connect the digital input pin of the Network Camera to an external device to detect the current connection status. Digital output: Select Grounded or Open to define the normal status for the digital output. Connect the digital output pin of the Network Camera to an external device to determine the current status. Set up the event source as DI on Event > Event settings > Trigger.
PAGE 128
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. 1. Enter the tamper trigger duration. (10 sec. ~ 10 min.). The duraction specifies the set of time before the tampering is considered as a real alarm. This helps avoid false alarms by short-lived changes.
PAGE 129
VIVOTEK Applications > Audio detection Audio detection, along with video motion detection, is applicable in the following scenarios: 1. Detection of activities not covered by camera view, e.g., a loud input by gun shots or breaking a door/window. 2. A usually noisy environment, such as a factory, suddenly becomes quiet due to a breakdown of machines. 3. A PTZ camera can be directed to turn to a preset point by the occurrence of audio events. 4.
PAGE 130
VIVOTEK You can use the Profile window to configure a different Audio detection setting. For example, a place can be noisy in the day time and become very quiet in the night. 1. Click on the Enable this profile checkbox. Once the Audio detection window is opened, the current sound input will be interactively indicated by a fluctuating yellow wave diagram. 2. Use a mouse click to drag the Alarm level tab to a preferred location on the slide bar. 3. Select the Day, Night, or Schedule mode check circles.
PAGE 131
VIVOTEK Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) Users can store and execute VIVOTEK's or 3rd-party software modules onto the camera's flash memory or SD card. These software modules can apply in video analysis for intelligent video applications such as license plate recognition, object counting, or as an agent for edge recording, etc. • Once the software package is successfully uploaded, the module configuration (vadp. xml) information is displayed.
PAGE 132
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 133
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 134
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 139 for detailed information. Recording Settings Click Add to open the recording setting window.
PAGE 135
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 136
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 137
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 138
VIVOTEK f you want to enable recording notification, please click Event to configure event triggering settings. Please refer to Event > Event settings on page 110 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 139
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 140
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 141
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 142
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 143
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 144
VIVOTEK 3. General CGI URL Syntax and Parameters CGI parameters are written in lower-case and as one word without any underscores or other separators. When the CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server. The CGIs are organized in functionally-related directories under the cgi-bin directory. The file extension .cgi is required. Syntax: http:///cgi-bin/[/...]/.
PAGE 145
VIVOTEK 5. Get Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http:///cgi-bin/anonymous/getparam.cgi?[] [&…] http:///cgi-bin/viewer/getparam.cgi?[] [&…] http:///cgi-bin/operator/getparam.cgi?[] [&…] http:///cgi-bin/admin/getparam.cgi?[] [&…] Where the should be [_] or [.].
PAGE 146
VIVOTEK http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http:///cgi-bin/anonymous/setparam.cgi? = [&=…][&return=] http:///cgi-bin/viewer/setparam.
PAGE 147
VIVOTEK Content-Type: text/html\r\n Context-Length: \r\n \r\n where is =\r\n [] Only the parameters that you set and are readable will be returned. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123 Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n User's Manual - 147
PAGE 148
VIVOTEK 7. Available parameters on the server Valid values: VALID VALUES DESCRIPTION string[] Text strings shorter than ‘n’ characters. The characters “,’,<,>,& are invalid. string[n~m] Text strings longer than `n’ characters and shorter than `m’ characters. The characters “,’,<,>,& are invalid. password[] The same as string but displays‘*’ instead. Any single integer number in 32-bits. The range is -2147483648~2147483647.
PAGE 149
VIVOTEK W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 available The API is listed in product WebAPIs. non-available The API is not in product WebAPIs. valid The API is listed in product WebAPIs, and is functional. non-valid The API is listed in product WebAPIs, but is malfunction in this status. Any decimal number expressed in 32-bits ranging from 1.18e-38~3.40e+38. NOTE: The camera should not be restarted when parameters are changed.
PAGE 150
VIVOTEK 7.1system Group: system NAME VALUE SECURITY DESCRIPTION (get/set) hostname string[64] 1/6 Host name of server (Network Camera, Wireless Network Camera, Video Server, Wireless Video Server). ledoff 6/6 Turn on (0) or turn off (1) all led indicators. date , 6/6 Current date of system. Set to ‘keep’ to keep time datetime keep, date unchanged. Set to ‘auto’ to use NTP to auto synchronize date. , 6/6 Current time of the system.
PAGE 151
VIVOTEK -140: GMT-03:30 Newfoundland -120: GMT-03:00 Brasilia, Buenos Aires, Georgetown, Greenland -80: GMT-02:00 Mid-Atlantic -40: GMT-01:00 Azores, Cape_Verde_IS.
PAGE 152
VIVOTEK Caledonia 480: GMT 12:00 Aucklan, Wellington, Fiji, Kamchatka, Marshall Is. 520: GMT 13:00 Nuku'Alofa daylight_enable 6/6 Enable automaticdaylight saving time in time zone. daylight_dstactualmode 6/7 Check if current time is under daylight saving time. (Used internally) daylight_auto_begintime string[19] 6/7 Display the current daylight saving start time. daylight_auto_endtime string[19] 6/7 Display the current daylight saving end time.
PAGE 153
VIVOTEK user has uploaded. This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results. restoreexceptvadp 0, 7/6 Restore the system parameters to default values except the vadp parameters and VADP modules that stored in the system. This command can cooperate with other “restoreexceptXYZ” commands.
PAGE 154
VIVOTEK format: language_count 0/7 Number of webpage languages available on the server. language_i<0~(count-1)> string[16] 0/7 Available language lists.
PAGE 155
VIVOTEK 7.2status Group: status NAME VALUE SECURITY DESCRIPTION (get/set) di_i<0~(capability_ndi-1)> 1/7 0 => Inactive, normal 1 => Active, triggered (capability.ndi > 0) do_i<0~(capability_ndo-1)> 1/7 0 => Inactive, normal 1 => Active, triggered (capability.ndo > 0) onlinenum_rtsp 0,
PAGE 156
VIVOTEK 7.3digital input behavior define Group: di_i<0~(n-1)> for n is the value of "capability_ndi" (capability.ndi > 0) NAME VALUE SECURITY DESCRIPTION (get/set) normalstate high, 1/1 low Indicates open circuit or closed circuit (inactive status) 7.4digital output behavior define Group: do_i<0~(n-1)> for n is the value of "capability_ndo" (capability.
PAGE 157
VIVOTEK 7.6network Group: network NAME VALUE SECURITY DESCRIPTION (get/set) preprocess 6/6 An 32-bit integer, each bit can be set separately as follows: Bit 0 => HTTP service; Bit 1=> HTTPS service; Bit 2=> FTP service; Bit 3 => Two way audio and RTSP Streaming service; To stop service before changing its port settings. It’s recommended to set this parameter when change a service port to the port occupied by another service currently. Otherwise, the service may fail.
PAGE 158
VIVOTEK wins1 6/6 Primary WINS server. wins2 6/6 Secondary WINS server. 7.6.1 802.1x Subgroup of network: ieee8021x (capability.protocol.ieee8021x > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable/disable IEEE 802.
PAGE 159
VIVOTEK (capability.naudioin > 0) eventalarm 0~7 6/6 Event/alarm channel for CoS management 0~7 6/6 Management channel for CoS eventtunnel 0~7 6/6 Event/Control channel for CoS Subgroup of network: qos_dscp (capability.protocol.qos.dscp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable/disable DSCP video 0~63 6/6 Video channel for DSCP audio 0~63 6/6 Audio channel for DSCP (capability.
PAGE 160
VIVOTEK 7.6.5 HTTP Subgroup of network: http NAME VALUE SECURITY DESCRIPTION (get/set) port 80, 1025 ~ 65535 1/6 HTTP port. alternateport 1025~65535 6/6 Alternate HTTP port. authmode basic, 1/6 HTTP authentication mode. 1/6 Http server push access name for stream N, digest s<0~(capability_nmediast string[32] ream-1)>_accessname N= 1~ capability.nmediastream. (capability.protocol.spush_mjpeg =1 and capability.nmediastream > 0) The value are shown as video.
PAGE 161
VIVOTEK s<0~(capability_nmediast string[32] 1/6 RTSP access name for stream N, N= 1~ ream-1)>_accessname capability.nmediastream. (capability.protocol.spush_mjpeg =1 and capability.nmediastream > 0) The value are shown as live.sdp = s0_accessname, (stream1) live2.sdp = s1_accessname, (stream2) live3.sdp = s2_accessname, (stream3) live4.sdp = s3_accessname, (stream4) etc. 7.6.7.
PAGE 162
VIVOTEK ttl 1 ~ 255 4/4 Multicasttime to live value. 7.6.8 SIP port Subgroup of network: sip (capability.protocol.sip> 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 1025 ~ 65535 1/6 SIP port. VALUE SECURITY DESCRIPTION 7.6.9 RTP port Subgroup of network: rtp NAME (get/set) videoport 1025 ~ 65535 6/6 Video channel port for RTP. audioport 1025 ~ 65535 6/6 Audio channel port for RTP. metadataport 1025 ~ 65535 6/6 Metadata channel port for RTP. 7.6.
PAGE 163
VIVOTEK 7.7IP Filter Group: ipfilter NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable access list filtering. admin_enable 6/6 Enable administrator IP address. admin_ip string[43] 6/6 Administrator IP address. maxconnection 1~10 6/6 Maximum number of concurrent streaming connection(s). type 0, 1 6/6 Ipfilter policy : 0 => allow 1 => deny ipv4list_i<0~9> Single address:
PAGE 164
VIVOTEK etc b. if "rbgain" is supported, "rgain" and "bgain" are updated to the current values (Available values are which is got from white balance module. Then, listed in act as rbgain mode "capability_image_c "widerange": Auto Tracing White balance <0~(n-1)>_wbmod (2000K to 10000K). e") "outdoor": auto white balance mode specifically for outdoor. "indoor": auto white balance mode specifically for indoor. "sodiumauto": sodium vapor lamps.
PAGE 165
VIVOTEK * Only available when "capability_image_c<0~(n-1)>_iristype"=dci ris enableblc 4/4 Enable backlight compensation. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c<0~(n-1)>_mode" to switch on/off BLC. color 0, 1 4/4 0 =>monochrome 1 => color * Only available when " capability_videoin_c<0~(n-1)>_color_suppor t" is 1. flip 4/4 Flip the image.
PAGE 166
VIVOTEK minexposure <1~32000>, 4/4 Minimum exposure time <5~32000>, 1~32000 => 1s ~ 1/32000s <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc. 5~8000 => 1/5s ~ 1/8000s etc.
PAGE 167
VIVOTEK "capability_image_c<0~(n-1)>_exposure_m ode" !=0 7.8.1 Video input setting per channel Group: videoin_c<0~(n-1)> for n channel products, and m is stream number n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" NAME VALUE SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 4/4 CMOS frequency. * Only available when " capability_videoin_type " is 2 mode 0~ 4/4 Indicate the video mode on use. 4/4 Modes of white balance.
PAGE 168
VIVOTEK 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbm ode". * 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. 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbm ode". * Only valid when "videoin_c<0~(n-1)>_whitebalance" != auto * Normalized range.
PAGE 169
VIVOTEK "capability_image_c<0~(n-1)>_expo sure_mode" !=0 exposuremode auto, 4/4 Select exposure mode. irispriority, "auto": Automatically adjust the Iris, qualitypriority, Gain and Shutter Speed to fit the manual, exposure level. etc "shutterpriority": Manually adjust with variable Shutter Speed, and keep (Available options are list in adjusting Iris, Gain automatically.
PAGE 170
VIVOTEK "indoor": Avoid rolling and flicker effect first. "manual": Manual set P-Iris by "piris_position". "-": not support. (only available when "capability_image_c<0~(n-1)>_sens ortype" is "smartsensor") * Only available when "capability_image_c<0~(n-1)>_iristy pe"=piris piris_position 1~100 1/4
PAGE 171
VIVOTEK sure_rangetype" is "twovalues". mingain 0~100 4/4 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_ mingain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_expo sure_rangetype" is "twovalues". gainvalue 0~100 4/4 Gain value.
PAGE 172
VIVOTEK anymore> Bit 0 => Support camera control function; 0(not support), 1(support) Bit 1 =>Built-in or external camera; 0 (external), 1(built-in) Bit 2 => Support pan operation; 0(not support), 1(support) Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only) text string[64] 1/4 Enclose caption.
PAGE 173
VIVOTEK "capability_image_c<0~(n-1)>_expo sure_rangetype" is "twovalues". maxexposure <1~32000>, 4/4 Maximum exposure time , 1~32000 => 1s ~ 1/32000s dependent> <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc. 5~8000 => 1/5s ~ 1/8000s etc. * Available value is listed in "capability_image_c<0~(n-1)>_expo * This parameter may also restrict sure_maxrange" image frame rate from sensor due to sensor generates a frame per exposure time.
PAGE 174
VIVOTEK * Only available when "capability_image_c<0~(n-1)>_expo sure_maxrange" != "-" and "capability_image_c<0~(n-1)>_expo sure_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. enablepreview 1/4 Usage for UI of exposure settings. Preview settings of video profile. * Only available when "capability_image_c<0~(n-1)>_expo sure_mode" !=0 crop_position 1/7 Crop left-top corner coordinate.
PAGE 175
VIVOTEK *Only available when "capability_image_c<0~(n-1)>_expo sure_bracketing_mode"=1. * We support this parameter when the version number (httpversion) is equal or greater than 0310a. s<0~(m-1)>_e 4/4 nableeptz Indicate whether stream supprts eptz or not s<0~(m-1)>_c Listed at "capability_videoin_codec" odectype Possible values are: mjpeg, 1/4 Codec type for this stream 1/4 Video resolution in pixels. 4/4 Enable "Smart fps" function.
PAGE 176
VIVOTEK The unit is millisecond (ms). s<0~(m-1)>_h cbr, vbr 4/4 cbr: Constant bit rate mode. 264_ratecontrol vbr: Fixed quality mode, all frames are mode encoded in the same quality. s<0~(m-1)>_h 1~5, 264_quant 99, 100 4/4 Set the pre-defined quality level: 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue" * Only valid when "ratecontrolmode"= vbr.
PAGE 177
VIVOTEK 264_cbr_quant 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only available when "ratecontrolmode"= cbr. * Only available when "capability_smartstream_version" >= "2.0" s<0~(m-1)>_h 1~100 4/4 Select customized quality in a 264_cbr_qperce normalized full range. nt 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"= cbr and "quant"= 100. * Only available when "capability_smartstream_version">= "2.
PAGE 178
VIVOTEK 1: main profile 2: high profile s<0~(m-1)>_h 4/4 Enable "Smart Q" function. 264_smartq_en able * Only available when "capability_videoin_c<0~(n-1)>_sma rtq_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. s<0~(m-1)>_h 4/4 Enable "Dynamic intra frame period".
PAGE 179
VIVOTEK * Only available when h265 is listed in "capability_videoin_codec" and "ratecontrolmode"= vbr. s<0~(m-1)>_h 0~51 4/4 265_qvalue Manual video quality level input. The Q value which is used by encoded library directly. * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= vbr and s<0~(m-1)>_h265_quant = 99. s<0~(m-1)>_h 1~100 4/4 265_qpercent Select customized quality in a normalized full range.
PAGE 180
VIVOTEK * Only available when h265 is listed in "capability_videoin_codec" and "ratecontrolmode"= cbr. * Only available when "capability_smartstream_version" >= "2.0" s<0~(m-1)>_h 1~100 4/4 Select customized quality in a 265_cbr_qperce normalized full range. nt 1: Worst quality 100: Best quality * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= cbr and "quant"= 100. * Only available when "capability_smartstream_version" >= "2.
PAGE 181
VIVOTEK "capability_videoin_codec". s<0~(m-1)>_h Available values are listed in " 265_profile capability_videoin_c<0~(n-1)>_h265 1/4 _profile" Indicate H265 profiles * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_h 4/4 Enable "Smart Q" function. 265_smartq_en * Only available when h265 is listed in able "capability_videoin_codec". * Only available when "capability_videoin_c<0~(n-1)>_sma rtq_support" is 1.
PAGE 182
VIVOTEK s<0~(m-1)>_m 1~100 4/4 jpeg_qpercent Select customized quality in a normalized full range. 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"= vbr and s<0~(m-1)>_mjpeg_quant = 100. s<0~(m-1)>_m 20000~"capability_videoin_c<0~(n-1 jpeg_maxvbrbit )>_mjpeg_maxbitrate" 4/4 The maximum allowed bit rate in fixed quality mode. rate When the bit rate exceeds this value, frames will be dropped to restrict the bit rate.
PAGE 183
VIVOTEK s<0~(m-1)>_m 20000~"capability_videoin_c<0~(n-1 jpeg_bitrate )>_mjpeg_maxbitrate" 4/4 The target bit rate in constant bit rate mode.
PAGE 184
VIVOTEK strength of WDR enhanced. * Only available when "capability_image_c<0~(n-1)>_wdrc _mode" is 1 aespeed_mode 4/4 Turning AE converge speed on or off. 1: on * Only available when "capability_image_c<0~(n-1)>_aesp eed" is 1 aespeed_speedl 1~100 4/4 The speed level of AE converge speed.
PAGE 185
VIVOTEK flickerless 4/4 Turn on(1) or turn off(0) the flickerless * Only available when "capability_image_c<0~(n-1)>_flicke rless" is 1. mounttype ceiling, wall, floor 1/6 Hardware installation. * Only available when "capability_videoin_c<0~(n-1)>_mou nttype" != "-".
PAGE 186
VIVOTEK "autotracking": only available when "capability_smartstream_mode_aut otracking" is 1. "manual": only available when "capability_smartstream_mode_ma nual" is 1. "hybrid": only available when "capability_smartstream_mode_hyb rid" is 1. qualitypriority -5,-4,-3,-2,-1,1,2,3,4,5 4/4 The differential value of Q between the regions of interest (ROI) and the areas of non-interest (non-ROI) of the display image. If the value is a positive number, the video quality of ROI is better than the non-ROI areas.
PAGE 187
VIVOTEK 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.1 Alternative video input profiles per channel In addition to the primary setting of video input, there can be alternative profile video input setting for each channel which might be for different scene of light (daytime or nighttime).
PAGE 188
VIVOTEK <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc. 5~8000 => 1/5s ~ 1/8000s etc. * Available value is listed in * This parameter may also restrict image "capability_image_c frame rate from sensor due to sensor <0~(n-1)>_exposu generates a frame per exposure time. Ex: If re_maxrange" this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.
PAGE 189
VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0302a. enableblc 4/4 Enable backlight compensation. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c_mode" to switch on/off BLC. 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.
PAGE 190
VIVOTEK quality algorithm. "manual": Manually adjust with variable Shutter, Iris and Gain. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. *Only available when "capability_image_c0_exposure_mode" != 0 whitebalance auto, 4/4 Modes of white balance. manual, "auto": Auto white balance rbgain, "rbgain": Use rgain and bgain to set white widerange, balance manually. outdoor, "manual": 2 cases: indoor, a.
PAGE 191
VIVOTEK 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbmode". * Only valid when "videoin_c<0~(n-1)>_whitebalance" != auto * Normalized range. maxgain 0~100 4/4 Maximum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_maxgain " != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposure_ra ngetype" is "twovalues".
PAGE 192
VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0302a. 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".
PAGE 193
VIVOTEK wdrpro_strength 1~100 4/4 The strength of WDR Pro. The bigger value means the stronger strength of WDR Pro. * Only available when "capability_image_c<0~(n-1)>_wdrpro_stren gth" is 1 wdrc_mode 4/4 Enable WDR enhanced. * Only available when "capability_image_c<0~(n-1)>_wdrc_mode" is 1 wdrc_strength 1~100 4/4 The strength of WDR enhanced. The bigger value means the stronger strength of WDR enhanced.
PAGE 194
VIVOTEK The higher sensitivity level meas that it is easy to be trigger while scene changed. * Only available when "capability_image_c<0~(n-1)>_aespeed" is 1 and "capability_image_c<0~(n-1)>_aespeedsupp ortsensitivity" is 1. flickerless 4/4 Turn on(1) or turn off(0) the flickerless mode * Only available when "capability_image_c<0~(n-1)>_flickerless" is 1 7.
PAGE 195
VIVOTEK 7.10 IR cut control Group: ircutcontrol (capability.
PAGE 196
VIVOTEK is 1. bwmode 6/6 Switch to B/W in night mode if enabled. * Only available when "capability_daynight_c<0~(n-1)>_ blackwhitemode" is 1. sensitivity low,normal,high,1~ 6/6 Sensitivity of day/night control. 100 There are two value format: "low,normal,high": if capability_daynight_c<0~(n-1)>_ircutsensiti vity_type=options "1~100": if capability_daynight_c<0~(n-1)>_ircutsensiti vity_type=normalize * Only available when "capability_daynight_c<0~(n-1)> _ircutsensitivity_type" is not "-".
PAGE 197
VIVOTEK image_c<0~(n-1)>_contrastpercent" * Only available when bit 1 of "capability_image_c<0~(n-1)>_basicsetting" is 1. * We replace "contrast" with "contrastpercent ". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. saturation -5~5,100 4/4 -5: Less saturation <-> 5: More saturation 100: Use " image_c_saturationpercent" * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicsetting" is 1.
PAGE 198
VIVOTEK "capability_image_c<0~(n-1)>_basicsetting" is 1. contrastpercent 0~100 4/4 Set contrast in the normalized range. 0: Less contrast <-> 100: More contrast * Only available when bit 1 of "capability_image_c<0~(n-1)>_basicsetting" is 1 saturationpercent 0~100 4/4 Set saturation in the normalized range. 0: Less saturation <-> 100: More saturation * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicsetting" is 1. sharpnesspercent 0~100 4/4 Set sharpness in the normalized range.
PAGE 199
VIVOTEK 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 200
VIVOTEK restoreatwb freeze Restore of adjusting white balance of image according to mode settings 4/4 Enable/disable Image freeze while patrolling. 0: disable 1: enable * Only available when "capability_image_c<0~(n-1)>_freeze" is 1 deinterlace_enable 4/4 Enable/disable deinterlace function. 0: disable 1: enable * Only available when "capability_image_c<0~(n-1)>_deinterlace_ support" is 1.
PAGE 201
VIVOTEK lens_ldc_mode 4/4 Enable/disable lens distortion correction. * Only available when "capability_image_c<0~(n-1)>_lens_ldc_sup port" is 1. palette_mode Available value 4/4 Set color palette option. is listed in "capability_im * Only available when age_c<0~(n-1 "capability_image_c<0~(n-1)>_palette_supp )>_palette_m ort" is 1. ode" * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0310a.
PAGE 202
VIVOTEK * We replace "profile_i0_contrast" with "profile_i0_contrastpercent ". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. profile_i<0~(m-1)>_saturation -5~5,100 4/4 -5: Less saturation <-> 5: More saturation 100: Use " image_c<0~(n-1)>_saturationpercent" * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicsetting" is 1. * We replace "profile_i0_saturation" with "profile_i0_saturationpercent".
PAGE 203
VIVOTEK * Only available when bit 1 of "capability_image_c<0~(n-1)>_basicsetting" is 1 profile_i<0~(m-1)>_saturation 0~100 4/4 percent Set saturation in the normalized range. 0: Less saturation <-> 100: More saturation * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicsetting" is 1. profile_i<0~(m-1)>_sharpness 0~100 4/4 percent Set sharpness in the normalized range.
PAGE 204
VIVOTEK profile_i<0~(m-1)>_dnr_stren 1~100 4/4 Strength of 3DNR gth * Only available when "capability_image_c<0~(n-1)>_dnr" is 1 profile_i<0~(m-1)>_defog_mo 4/4 Enable/disable defog mode.
PAGE 205
VIVOTEK 7.12 Exposure window setting per channel Group: exposurewin_c<0~(n-1)> for n channel profucts n denotes the value of "capability_nvideoin" (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1) NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, custom,blc,hlc 4/4 "auto": Use full image view as the only exposure window. * Available values are listed in "custom": Use custom windows.
PAGE 206
VIVOTEK "capability_image_c<0~(n-1)>_exposure_wi ndomain". homepx <0~W,0~H> 4/4 Left-top corner coordinate of the window. W: 0~ The current image width -1 * Only available when px is listed in H: 0~ The current image height -1 "capability_image_c<0~(n-1)>_exposure_wi ndomain". sizepx <0~Wx0~ H> 4/4 Width and height of the window. W: 0~ The current image width -1 * Only available when px is listed in H: 0~ The current image height -1 "capability_image_c<0~(n-1)>_exposure_wi ndomain".
PAGE 207
VIVOTEK Group: exposurewin_c<0~(n-1)>_profile_i<0~(m-1)>_win_i<0~(k-1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the value of "capability_nvideoinprofile", k denotes the value of "capability_image_c<0~(n-1)>_exposure_winnum".
PAGE 208
VIVOTEK ndomain". sizestd <0~9999x0~9999> 4/4 Width and height of the window. * Only available when std is listed in "capability_image_c<0~(n-1)>_exposure_wi ndomain". 7.13 Audio input per channel Group: audioin_c<0~(n-1)> for n channel products (capability.naudioin>0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) source micin, linein dependent> 4/4 micin => use built-in microphone input.
PAGE 209
VIVOTEK 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 _source = linein) this> * Reserved for compatibility, and suggest don't use this since the version number (httpversion) is equal or greater than 0301a.
PAGE 210
VIVOTEK 48000, * Only available if AAC is supported. 64000, 96000, 128000 s0_gamr_bitrate 4750, 4/4 AMR encoded bitrate in bps. 5150, 5900, * Only available if AMR is supported. 6700, 7400, 7950, 10200, 12200 s0_g711_mode pcmu, 4/4 pcma Set G.711 companding algorithm. pcmu: µ-law algorithm pcma: A-law algorithm * Only available if G.711 is supported. s0_g726_bitrate 16000, 4/4 Set G.726 encoded bitrate in bps. 24000, * Only available if G.726 is supported.
PAGE 211
VIVOTEK alarm_level 1~100 4/4 Audio detection alarm level profile_i0_enable 4/4 Enable/disable this profile setting profile_i0_policy night, 4/4 The mode which the profile is applied to. schedule * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a. profile_i0_begintime hh:mm 4/4 Begin time of schedule mode. profile_i0_endtime hh:mm 4/4 End time of schedule mode.
PAGE 212
VIVOTEK 7.16 Motion detection settings Group: motion_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable 4/4 Enable motion detection. win_sensitivity 0 ~ 100 4/4 Sensitivity of all motion detection windows. * The value "0" is reserved for compatibility and will not be used after the version number (httpversion) is equal or greater than 0400a.
PAGE 213
VIVOTEK H: 0~ The current * Only available when px is listed in image height -1 "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. polygon 0 ~ 320,0 ~ 240, 0 4/4 Coordinate of polygon window position. 320,0 ~ 240, 0 ~ * Only available when 320,0 ~ 240 "capability_motion_wintype" = polygon.
PAGE 214
VIVOTEK greater than 0400a. width 0 ~ 320 4/4 Width of motion detection window. "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. height 0 ~ 240 4/4 Height of motion detection window.
PAGE 215
VIVOTEK and will not be used after the version number (httpversion) is equal or greater than 0400a. Group: motion_c<0~(n-1)>_profile_i<0~(m-1)>_win_i<0~(k-1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the vaule of "capability_nmotionprofile", k denotes the value of "capability_nmotion". NAME VALUE SECURITY DESCRIPTION (get/set) enable 4/4 Enable motion detection window. name string[14] 4/4 Name of motion window.
PAGE 216
VIVOTEK 320,0 ~ 240, 0 ~ * Only available when 320,0 ~ 240 "capability_motion_wintype" = polygon. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. left 0 ~ 320 4/4 Left coordinate of window position.
PAGE 217
VIVOTEK * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. height 0 ~ 240 4/4 Height of motion detection window. "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain".
PAGE 218
VIVOTEK second(s), then image too bright detection is triggered. blurry_enable 4/4 Enable or disable image too blurry detection blurry_threshold 0~100 4/4 Threshold of image too blurry detection blurry_duration 1~10 4/4 If image too blurry value exceeds the "threshold" for more than "duration" second(s), then image too blurry detection is triggered. 7.18 DDNS Group: ddns (capability.protocol.
PAGE 219
VIVOTEK url string[64] 6/6 The url user define to link to camera 7.20 UPnP presentation Group: upnppresentation NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable or disable the UPnP presentation service. 7.21 UPnP port forwarding Group: upnpportforwarding NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable or disable the UPnP port forwarding service. upnpnatstatus 0~3 6/7 The status of UPnP port forwarding, used internally.
PAGE 220
VIVOTEK 7: LOG_DEBUG setparamlevel 0~2 6/6 Show log of parameter setting. 0: disable 1: Show log of parameter setting set from external. 2. Show log of parameter setting set from external and internal. 7.23 SNMP Group: snmp (capability.protocol.snmp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) v2 6/6 SNMP v2 enabled. 0 for disable, 1 for enable v3 6/6 SNMP v3 enabled.
PAGE 221
VIVOTEK 7.24 Layout configuration Group: layout NAME VALUE SECURITY DESCRIPTION (get/set) logo_default 1/6 0 => Custom logo 1 => Default logo logo_link string[128] 1/6 Hyperlink of the logo 1/6 0 => display the power by vivotek logo http://www.vivotek.
PAGE 222
VIVOTEK 7.25 Privacy mask Group: privacymask_c<0~(n-1)> for n channel products and m privacy mask window. n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY DESCRIPTION (get/set) enable 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 223
VIVOTEK 0 ~ W,0 ~ H "capability_image_c<0~(n-1)>_privacymask W: 0~ The current _wintype" = polygon. image width -1 H: 0~ The current * Only available when px is listed in image height -1 "capability_image_c<0~(n-1)>_privacymask _windomain". win_i<0~(m-1)>_polygo 0 ~ 9999,0 ~ 9999, 4/4 Coordinate of polygon window position.
PAGE 224
VIVOTEK "capability_ptz_c<0~(n-1)> _maxzoom" win_i<0~(m-1)>_fliped 4/4 Flip side of window position. 0: Non-flip side 1: Flip side 7.27 Capability Group: capability NAME VALUE SECURITY DESCRIPTION (get/set) api_httpversion 0/7 The version of VIVOTEK WebAPI with 4 This number start integers plus 1 alphabet, There are composed with 0301a. by "major version", "minor version", "revision","_platform".
PAGE 225
VIVOTEK 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". Ex: If some APIs in a model does not follow the API definition of 0301a_1, we will fix them and change this API value to 0301b_1. bootuptime 0/7 Server bootup time. nir 0, 0/7 Number of IR interfaces.
PAGE 226
VIVOTEK naudiosetting 0/7 Number of audio settings per channel. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * We replace "naudiosetting" with "naudioin". More details, please refer the parameter description of "volume_internal" and "volume_external". nuart 0, 0/7 Number of UART interfaces. nmotion 0/7 The number of motion window.
PAGE 227
VIVOTEK (only available when RS-485 interface is supported or SD/PZ/PT/PD/video server series) Bit 6 => (only available when bit0 is 1) Reserved bit; always 0. Bit 7 => (only available when bit0 is 1) External or built-in PT; 0(built-in), 1(external) windowless 0/7 Indicate whether to support windowless plug-in. evctrlchannel 0/7 Indicate whether to support HTTP tunnel for event/control transfer. joystick 0/7 Indicate whether to support joystick control.
PAGE 228
VIVOTEK 0307a. eptz 0, 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. Ex: nvideoin = 2, bit 0~15 are the 1st group for 1st channel, bit 16~31 are the 2nd group for 2nd channel.
PAGE 229
VIVOTEK iris 0/7 Indicate whether to support iris control. 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,toob 0/7 right,tooblurry Available tampering mode list. * Only available when "capability_tampering" is 1.
PAGE 230
VIVOTEK simultaneous connections. protocol_maxgenconnecti 0/7 The maximum general streaming connections . 0/7 Indicate whether to support scalable multicast. 0/7 Indicate whether to support backchannel on protocol_rtp_multicast_sc alable protocol_rtp_multicast_ba ckchannel multicast. protocol_rtp_tcp 0/7 Indicate whether to support RTP over TCP. protocol_rtp_http 0/7 Indicate whether to support RTP over HTTP.
PAGE 231
VIVOTEK * This is kept for compatibility. videoin_h264_maxframer A list of ate and "-" 0/7 This equals "capability_videoin_c0_h264_maxframerate". * This is kept for compatibility. videoin_codec mjpeg, h264, h265 0/7 EX: FD8183 supports H.264 and MJPEG, then this is "mjpeg,h264". IP9171 supports H.264, MJPEG and H.
PAGE 232
VIVOTEK 0306b. audio_aecaffect -, 0/7 When acoustic echo cancellation function is maxframerate:fixed enabled, some features may become :15 malfunction or be forced to a given value. The The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden.
PAGE 233
VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0306b. audio_mic 0/7 Indicate whether to support built-in microphone input. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * We replace "audio_mic" with "audio_intmic". audio_intmic <0~Positive 0/7 Integer> Internal (Built-in) Microphone. 0: Not support 1: Support Bit 0 for CH0, bit 1 for CH1, and so on.
PAGE 234
VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0309a. audioin_codec aac4, gamr, g711, 0/7 g726, - Available audio codec. We take comma to split codec without any space. "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 235
VIVOTEK pixels. "std": A normalized 0~9999 range. "-": Not supported. * Only available when "capability_smartstream_support" is 1 smartstream_mode_autot 0/7 racking Indicate whether autotracking smart stream is supported. * Only available when "capability_smartstream_support" is 1 smartstream_mode_man 0/7 ual Indicate whether manual smart stream is supported.
PAGE 236
VIVOTEK 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. camctrl_httptunnel 0/7 Indicate whether to support httptunnel. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301b.
PAGE 237
VIVOTEK * Only available when "capability_network_wireless" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0305a. wireless_s802dot11b 0/7 Indicate whether to support wireless 802.11b+. wireless_s802dot11g 0/7 Indicate whether to support wireless 802.11g. wireless_s802dot11n 0/7 Indicate whether to support wireless 802.11n.
PAGE 238
VIVOTEK version_onviftesttool 0/7 Indicate ONVIF test tool version media_totalspace 0/7 Available memory space (KB) for media. media_snapshot_maxpre 0/7 Maximum snapshot number before event event media_snapshot_maxpost occurred. 0/7 event Maximum snapshot number after event occurred. media_snapshot_maxsize 0/7 Maximum size (KB) of a snapshot.
PAGE 239
VIVOTEK localstorage_modnum 0, 0/7 The maximum MOD connection numbers. * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_modversion 0/7 Indicate MOD daemon version. * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_stormgrversi 0/7 on Indicate storage manager daemon version.
PAGE 240
VIVOTEK stream. The LSB indicates stream 0. Ex: “3” means stream 0 and stream 1 support local dewarp. * Only available when "capability_fisheye" > 0 shockalarm_support 0/7 Indicate whether to support the shock detection. * We support this parameter when the version number (httpversion) is equal or greater than 0306e. layout_redirection 0/7 Indicate which function will be redirected to the vadp package path. "-": Not supported.
PAGE 241
VIVOTEK zoommodule 0/7 Indicate whether to support zoom lens. In our product, only SD series and IZ series use the zoom lens. * Both varifocal and zoom lenses are built with movable elements that permit changing the effective focal length. And the key difference between a varifocal and a zoom lens can be explained by thinking about a lens that has been focused on an object at any focal length.
PAGE 242
VIVOTEK minpan 0, 0/7 The lower limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" maxpan 0, 0/7 The upper limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" minpanangle 0/7 The lower limit for pan angle. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" maxpanangle 0/7 The upper limit for pan angle.
PAGE 243
VIVOTEK minzoom 0, 0/7 The lower limit for zoom position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule" is "1" maxzoom 0, 0/7 The upper limit for zoom position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule" is "1" maxdzoom 0, 0/7 The upper limit for digital zoom position.
PAGE 244
VIVOTEK optimizedir 0/7 Indicate whether to support optimized IR control technology. * We support this parameter when the version number (httpversion) is equal or greater than 0307b. smartir 0/7 Indicate whether to support smart IR. ircutfilter 0/7 Indicate whether to support IR cut. lightsensor 0/7 Indicate whether to support light sensor.
PAGE 245
VIVOTEK extled_interface do,irring 0/7 The device interface of external IR led: "do": digital output "irring": IR ring * Only available when "capability_daynight_c<0~(n-1)>_externalir" is 1 * We support this parameter when the version number (httpversion) is equal or greater than 0304a. mode auto,daynight,di,di2,d 0/7 Indicate the day / night switch mode.
PAGE 246
VIVOTEK lens_type fisheye, fixed, 0/7 The lens type of this channel. varifocal, changeable, "fisheye": Fisheye lens motor, ics,- "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. "motor": Lens with motor to support zoom, focus, etc.
PAGE 247
VIVOTEK rotationaffect 0/7 When rotation is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here. The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value.
PAGE 248
VIVOTEK 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,rotation 0/7 Indicates the camera supports flip, mirror or rotation. * We support this parameter when the version number (httpversion) is equal or greater than 0309b.
PAGE 249
VIVOTEK 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 Indicate frame rate that the video source outputs in current video mode. One to one mapping to the resolution in "resolution".
PAGE 250
VIVOTEK mjpeg_maxbitrate , - 0/7 Maximum bitrates of MJPEG. The unit is bps. "-" means MJPEG does not support bit rate control. * Only available when 'mjpeg' is listed in "capability_videoin_codec". h264_maxframerate A list of and "-" Maximum fps that the device can encoded with H.264 on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution".
PAGE 251
VIVOTEK h265_maxframerate A list of and "-" Maximum fps that the device can encoded with H.265 on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group. * This parameter may be changed when "videoin_c_cmosfreq"=50 or "videoin_c_modulation"=pal. Ex: 30 fps is changed to 25 fps, 60 fps is changed to 50 fps, and so on.
PAGE 252
VIVOTEK mounttype ceiling, wall, floor,- 0/7 Indicate the supported mount type. "-": not support * We support this parameter when the version number (httpversion) is equal or greater than 0309c. dintraperiod_support 0/7 0: Non-support "Dynamic intra frame period" 1: Support "Dynamic intra frame period" "Dynamic intra frame period" can be used to reduce bitrate by reducing the number of I-frame.
PAGE 253
VIVOTEK smartq_support 0/7 Indicate whether to support Smart Q function. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. Group: capability_videoin_c<0~(n-1)>_localdewarp (capability_fisheyelocaldewarp_c<0~(capability_nvideoin)-1> > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) typeceilingmount 1O, 1P, 2P, 1R, 4R 0/7 Available dewarp types of ceiling and floor mount.
PAGE 254
VIVOTEK 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. Ex: nvideoin = 2, bit 0~15 are the 1st group for 1st channel, bit 16~31 are the 2nd group for 2nd channel.
PAGE 255
VIVOTEK effectivepixel 0/7 The visible area of full scene in this video mode. The unit is pixel in source. * If "effectivepixel"<"capability_videoin_c<0~(n-1) >_maxsize", then the visible area is located at the center of full scene. outputsize 0/7 The output size of source, equal to the captured size by device, in this video mode. The unit is pixel. This value is used as a basic coordinate system for many features, like ePTZ, privacy mask, motion, etc.
PAGE 256
VIVOTEK 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 Indicates frame rate that the video source outputs in this video mode. * One to one mapping to the resolution in "resolution".
PAGE 257
VIVOTEK maxfps_h264 A list of and "-" H.264 on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group. * This parameter records the frame rate when "videoin_c<0~(n-1)>_cmosfreq"=60 or "videoin_c<0~(n-1)>_modulation"=ntsc * Only available when 'h264' is listed in "capability_videoin_codec".
PAGE 258
VIVOTEK to proper position vertically or not. wdrpro_mode 0, 1, 2 0/7 0: Non-support WDR Pro 1: Support WDR Pro 2: Support WDR Pro and WDR Pro II wdrpro_strength 0, 1 0/7 0: Non-support tuning strength of WDR Pro 1: Support tuning strength of WDR Pro * If "capability_image_c<0~(n-1)>_wdrp ro"=1, this may be either 0 or 1. wdrpro_supportlevel 0, 0/7 This contains a list of positive integers, split by comma.
PAGE 259
VIVOTEK - (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 260
VIVOTEK exposurelevel:ranged:- - (disabled) : UI turns grey and users , can't select it. exposuremode:fixed:auto - (unchanged) : UI keeps the status as before and user can't change it. : nonnegative integer - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available.
PAGE 261
VIVOTEK > 0. * We support this parameter when the version number (httpversion) is equal or greater than 0306d. dnrtype 2d,3d 0/7 Description about DNR type. * Only available when "capability_image_c<0~(n-1)>_dnr" > 0. * We support this parameter when the version number (httpversion) is equal or greater than 0308a. eis 0,1 0/7 0: Non-support electronic image stabilizer 1: Support electronic image stabilizer is_mode eis, 0/7 Indicate the image stabilizer mode.
PAGE 262
VIVOTEK "capability_image_c<0~(n-1)>_is_m ode" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. is_affect -, 0/7 When Is mode is not "-", some minexposure:hidden:, features may become malfunction or mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here.
PAGE 263
VIVOTEK integer or string or NULL. "-" means no feature is affected. * Only available when "capability_image_c<0~(n-1)>_is_m ode" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. scenemode_support 0,1 0/7 0: Non-support scene mode 1: Support scene mode scenemode_supporttype visibility, noiseless, 0/7 list all the scene mode which are supported in the camera.
PAGE 264
VIVOTEK or greater than 0302a. exposure_mode 0,1 0/7 0: Non-support exposure control. 1: Support exposure control. exposure_modetype auto, 0/7 Available mode of exposure setting. shutterpriority, * Only available when irispriority, "capability_image_c<0~(n-1)>_ manual exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_rangetype onevalue, 0/7 Support interface of exposure range.
PAGE 265
VIVOTEK or greater than 0302a. exposure_gainvaluetype fixed, 0/7 * One to one mapping to the mode maximum, type in "exposure_modetype". - "fixed": The shutter value is the assigned value (videoin_c<0~(n-1)>_gainvalue). "maximum": The shutter value can be up to the assigned value (videoin_c<0~(n-1)>_gainvalue) "-": not support. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1 and "capability_image_c<0~(n-1)>_expo sure_rangetype" is "onevalue".
PAGE 266
VIVOTEK - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected.
PAGE 267
VIVOTEK user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6.
PAGE 268
VIVOTEK : nonnegative integer "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available.
PAGE 269
VIVOTEK mode_affect exposurewin.mode.blc:hidd is enabled, some features may become en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here. exposurelevel:hidden:, or others The format is "Affect API name":"Policy":"Description" : nonnegative integer "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it.
PAGE 270
VIVOTEK 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 0305a. exposure_manualmode_a -, 0/7 When exposure manual mode is ffect exposurewin.mode.blc:hidd enabled, some features may become en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here.
PAGE 271
VIVOTEK "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when manual is listed in "capability_image_c<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_levelrange -, 0/7 "0,12" Available range for "videoin_c<0~(n-1)>_exposurelevel" * When "exposure_mode"=0, this value must be set to "-".
PAGE 272
VIVOTEK be forced to a given value. The : nonnegative integer affected functions are list here. The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values.
PAGE 273
VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0304a. exposure_wintype inclusive, 0/7 The supported exposure window type. exclusive, "inclusive": The image inside a - window is the target area of exposure control. "exclusive": The image inside a window is omitted by exposure control. "-": Not supported. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1.
PAGE 274
VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0301a. exposure_pal_totalrange A list of 0/7 Available total range for PAL analog output. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0301a.
PAGE 275
VIVOTEK (AEB)  1: Support Auto Exposure Bracketing (AEB) Auto Exposure Bracketing (AEB) is a term that is used to signify a process where the camera automatically takes two or more exposures but with different exposure values. * We support this parameter when the version number (httpversion) is equal or greater than 0310a.
PAGE 276
VIVOTEK privacy mask. agc_maxgain "0,100", 0/7 "-" Available range for "videoin_c_maxgain" “0,100” => 0~100 percent "-" means "videoin_c_maxgain" is not available. agc_mingain "0,100", 0/7 "-" Available range for "videoin_c_mingain" “0,100” => 0~100 percent "-" means "videoin_c_mingain" is not available.
PAGE 277
VIVOTEK 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 278
VIVOTEK value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected.
PAGE 279
VIVOTEK 0: Non-support low light mode 1: Support low light mode focusassist 0,1 0/7 0: Non-support focus assist 1: Support focus assist remotefocus 0, 0/7 An 4-bit integer, which indicates the supportive application of remotefocus in this channel. If the value of this parameter is larger than 0, it means that the camera supports remotefocus function in this channel. bit 0 => Indicate whether to support both zoom and focus function. bit 1 => Only support zoom function.
PAGE 280
VIVOTEK or greater than 0302a. autotrack_support 0/7 0: Non-support auto tracking feature 1: Support auto tracking feature * We support this parameter when the version number (httpversion) is equal or greater than 0302a. smartsensor_iristotalrang A list of iris value 0/7 e Available total step for iris value. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
PAGE 281
VIVOTEK 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. * We support this parameter when the version number (httpversion) is equal or greater than 0310a. palette_mode A list of palette options 0/7 Palette options used in thermal surveillance.
PAGE 282
VIVOTEK 7.29 Event setting Group: event_i<0~2> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] 6/6 Identification of this entry. enable 0, 1 6/6 Enable or disable this event. priority 0, 1, 2 6/6 Indicate the priority of this event: “0”= low priority “1”= normal priority “2”= high priority delay 1~999 6/6 Delay in seconds before detecting the next event. trigger boot, 6/6 Indicate the trigger condition: di, "boot" = System boot. pir, "di"= Digital input.
PAGE 283
VIVOTEK mdwin 0, 6/6 Indicate the source window id of motion detection. This field is required when trigger condition is “md”. One bit represents one window. The LSB indicates the 1st window. For example, to detect the 1st and 3rd windows, set mdwin as 5. mdwin0 0, 6/6 Similar to mdwin. The parameter takes effect when profile 1 of motion detection is enabled. vi 0, 6/6 Indicate the source id of vi trigger.
PAGE 284
VIVOTEK weekday 0~127 6/6 Indicate which weekday is scheduled. One bit represents one weekday. bit0 (LSB) = Saturday bit1 = Friday bit2 = Thursday bit3 = Wednesday bit4 = Tuesday bit5 = Monday bit6 = Sunday For example, to detect events on Friday and Sunday, set weekday as 66. begintime hh:mm 6/6 Begin time of the weekly schedule. endtime hh:mm 6/6 End time of the weekly schedule.
PAGE 285
VIVOTEK action_server_i<0~4>_ena 6/6 Enable or disable this server action. 6/6 Index of the attached media. ble action_server_i<0~4>_me NULL, 0~4,101 dia 101 means "Recording Notify" action_server_i<0~4>_dat 6/6 efolder action_goto_enable Enable this to create folders by date, time, and hour automatically. 6/6 Enable/disable ptz goto preset position on event triggered. * Only available when "capability_ptzenabled" > 0.
PAGE 286
VIVOTEK 7.30 Server setting for event action Group: server_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] 6/6 Identification of this entry type email, 6/6 Indicate the server type: ftp, “email” = email server http, “ftp” = FTP server ns “http” = HTTP server “ns” = network storage http_url string[128] 6/6 URL of the HTTP server to upload. http_username string[64] 6/6 Username to log in to the server. http_passwd string[64] 7/6 Password of the user.
PAGE 287
VIVOTEK 7.31 Media setting for event action Group: media_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] 6/6 Identification of this entry type snapshot, 6/6 Media type to send to the server or systemlog, store on the server. videoclip, recordmsg snapshot_source 0~"capability_nmediastream"-1 6/6 Indicate the source of media stream. 0 means the first stream. 1 means the second stream and etc. 2 means the third stream and etc. 3 means the fourth stream and etc.
PAGE 288
VIVOTEK videoclip_maxduration 1~" 6/6 capability_media_videoclip_maxlen Maximum duration of one video clip in seconds. gth" videoclip_maxsize 50 ~ " 6/6 capability_media_videoclip_maxsiz Maximum size of one video clip file in Kbytes. e" 7.32 Recording Group: recording_i<0~1> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] 6/6 Identification of this entry.
PAGE 289
VIVOTEK limitsize 6/6 0: Entire free space mechanism 1: Limit recording size mechanism cyclic 6/6 0: Disable cyclic recording 1: Enable cyclic recording notify 6/6 0: Disable recording notification 1: Enable recording notification notifyserver 0~31 6/6 Indicate which notification server is scheduled. One bit represents one application server (server_i0~i4). bit0 (LSB) = server_i0. bit1 = server_i1. bit2 = server_i2. bit3 = server_i3. bit4 = server_i4.
PAGE 290
VIVOTEK dest cf, 6/6 0~4 The destination to store the recorded data. “cf” means local storage (CF or SD card). “0” means the index of the network storage. cffolder string[128] 6/6 Folder name. maxsize 100~2000 6/6 Unit: Mega bytes. When this condition is reached, recording file is truncated. maxduration 60~3600 6/6 Unit: Second When this condition is reached, recording file is truncated.
PAGE 291
VIVOTEK stateorprovincename string[128] 6/6 State or province name in the certificate information. localityname string[128] 6/6 The locality name in thecertificate information. organizationname string[64] 6/6 Organization name in the certificate VIVOTEK Inc. unit string[64] information. 6/6 VIVOTEK Inc. commonname string[64] Organizational unit name in thecertificate information. 6/6 Common name in the certificate information. 6/6 Valid period for the certification. www.vivotek.
PAGE 292
VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) enabled 6/6 Enable automatic clean up method. Expired and not locked media files will be deleted. maxretentiontime_recordin 6/6 g_enabled Enable automatic clean up method for video clip generated by recording task. The parameter takes effect when autocleanup_enabled is enabled.
PAGE 293
VIVOTEK maxretentiontime_others_ 6/6 maxage 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. The parameter takes effect when autocleanup_maxretentiontime_others_enabled is enabled. 7.
PAGE 294
VIVOTEK 7.36 ePTZ setting Group: eptz_c<0~(n-1)> for n channel product. (capability.eptz > 0 or capability_fisheye = 1) PARAMETER VALUE SECURITY DESCRIPTION (get/set) osdzoom 1/4 * Reserved for compatibility, and suggest don't use this since [httpversion] > 0302a * We replace "eptz_c<0~(n-1)>_osdzoom" with " videoin_c<0~(n-1)>_zoomratiodisplay".
PAGE 295
VIVOTEK Group: eptz_c<0~(n-1)>_s<0~(m-1)> for n channel product and m is the index of video stream which support ePTZ if capability_eptz > 0; m is the index of stream number if capability_fisheye = 1. (capability.eptz > 0 or capability_fisheye = 1) PARAMETER VALUE SECURITY DESCRIPTION (get/set) patrolseq string[120] 1/4 The patrol sequence of ePTZ.
PAGE 296
VIVOTEK win_i0_size 4/4 Width and height of the window. * The minimal window size is 192x144 7.38 Seamless recording setting Group: seamlessrecording (capability.localstorage.seamless> 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) diskmode seamless, 1/6 manageable “seamless” indicates enable seamless recording. “manageable” indicates disable seamless recording. maxconnection 3 1/7 Maximum number of connected seamless streaming.
PAGE 297
VIVOTEK card when user want to upload it. If the value is false, save module to the internal storage space and it will occupy storage size. number string[128] 6/7 This number is used to register license key for VADP application. Group: vadp_module_i<0~(n-1)> for n VADP package number (capability_vadp_npackage > 0) n denotes the value of "capability_vadp_npackage". NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Indicate if the module is enabled or not.
PAGE 298
VIVOTEK (get/set) enable 6/6 Enable or disable the schedule mode to control the execution of the VADP package begintime hh:mm 6/6 Begin time of the schedule endtime hh:mm 6/6 End time of the schedule VALUE SECURITY Group: vadp_event NAME DESCRIPTION (get/set) ntrigger 0, 6/7 Indicate the number of topics to be transferred to event manager for trigger.
PAGE 299
VIVOTEK capability_nuart"-1 (capability.nuart>0). cameraid 0~255 1/4 Camera ID controlling external PTZ camera. isptz 0~2 1/4 0: disable PTZ commands. 1: enable PTZ commands with PTZ driver. 2: enable PTZ commands with UART tunnel. * Only available when bit7 of capability_ptzenabled is 1 disablemdonptz 1/4 Disable motion detection on PTZ operation. 7.
PAGE 300
VIVOTEK (n-1)>_focusmode" uart 0 ~ "capability_nuart"-1 1/4 Select corresponding uart (capability.nuart>0). isptz 0~2 1/4 0: disable PTZ commands. 1: enable PTZ commands with PTZ driver. 2: enable PTZ commands with UART tunnel. * Only available when bit7 of capability_ptzenabled is 1 preset_i<0~(k-1)>_name string[40] 1/4 Name of the preset location. preset_i<0~(k-1)>_zoom capability_ptz_c<0~(n-1) 1/4 Zoom position at each preset location. 1/4 Focus position at each preset location.
PAGE 301
VIVOTEK >_maxzoom axisf capability_ptz_c<0~(n-1) 1/4 Custom home focus position. >_minfocus ~ capability_ptz_c<0~(n-1) >_maxfocus 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 302
VIVOTEK zoomspeed -5 ~ 5 1/4 Zoom speed autospeed -5 ~ 5 1/4 Auto pan speed focusspeed -5 ~ 5 1/4 Auto focus speed focusmode auto,onetimeauto,spotligh 1/4 Indicate the focus control mode. t,manual * Available values are listed in "capability_camctrl_c<0~ (n-1)>_focusmode" preset_i<0~(k-1)>_name string[40] 1/4 Name of the preset location. preset_i<0~(k-1)>_pan capability_ptz_c<0~(n-1) 1/4 Pan position at each preset location. 1/4 Tilt position at each preset location.
PAGE 303
VIVOTEK home position or not. axisx capability_ptz_c<0~(n-1) 1/4 Custom home pan position. 1/4 Custom home tilt position. 1/4 Custom home zoom position. 1/4 Custom home focus position.
PAGE 304
VIVOTEK "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. * We support this parameter when the version number (httpversion) is equal or greater than 0307a.
PAGE 305
VIVOTEK paritybit none, 4/4 For error checking. 4/4 "1": One stop bit is transmitted to indicate the odd, even stopbit 1,2 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/4 RS485 or RS232.
PAGE 306
VIVOTEK 15200 databit 5,6,7,8 4/4 Data bits in a character frame. paritybit none, 4/4 For error checking. 4/4 "1": One stop bit is transmitted to indicate the odd, even stopbit 1,2 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 307
VIVOTEK Group: lens_default_i<0~(n-1)> n denotes the value of "lens_default_totalnumbers" NAME VALUE SECURITY DESCRIPTION (get/set) name 6/7 Default lens name SECURITY DESCRIPTION Group: lens_user_i<0~(n-1)> n denotes the value of "lens_user_totalnumbers" NAME VALUE (get/set) name 6/7 User-defined lens name SECURITY DESCRIPTION 7.46 Fisheye info Group: fisheyeinfo (capability.
PAGE 308
VIVOTEK s<0~(m-2)>_region_tilt -90~90 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_zoo 100~300 m 7.48 1/4 Zoom home ratio of regional view PIR behavior define Group: pir (capability.npir > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable 7.
PAGE 309
VIVOTEK 7.50 Wireless Group: wireless (capability_network_wireless > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) ssid string[32] 6/6 SSID for wireless lan settings. wlmode Infra, 6/6 Wireless mode. Adhoc channel Infra: Infrastructure 1~11 or 1~13 or 6/6 A list of WLAN channels. Countries apply their own regulations to the 10~11 or allowable channels.
PAGE 310
VIVOTEK key4 password [26] 6/6 WEP key4 for encryption. * Only valid when "wireless_encrypt" is "wep" algorithm AES, TKIP 6/6 Algorithm * Only valid when "wireless_encrypt" is "wpa" or "wpa2" presharedkey password [64] 6/6 WPA/WPA2PSK mode pre-shared key. * Only valid when "wireless_encrypt" is "wpa" or "wpa2" 7.
PAGE 311
VIVOTEK 8. Useful Functions 8.1 Drive the Digital Output (capability.ndo > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http:///cgi-bin/dido/setdo.cgi?do1=[&do2=] [&do3=][&do4=] Where state is 0 or 1; “0” means inactive or normal state, while “1” means active or triggered state.
PAGE 312
VIVOTEK 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.3 Query Status of the Digital Output (capability.ndo > 0) Note: This request requires Viewer privileges Method: GET/POST Syntax: http:///cgi-bin/dido/getdo.cgi?[do0][&do1][&do2][&do3] If no parameter is specified, all the digital output statuses will be returned. Return: HTTP/1.0 200 OK\
PAGE 313
VIVOTEK \r\n do1=1\r\n 8.4 Capture Single Snapshot Note: This request requires Normal User privileges. Method: GET/POST Syntax: http:///cgi-bin/viewer/video.jpg?[channel=][&resolution=] [&quality=][&streamid=] If the user requests a size larger than all stream settings on the server, this request will fail. PARAMETER VALUE DESCRIPTION channel 0~(capability_nvideoin -1) The channel number of the video source.
PAGE 314
VIVOTEK 8.5 Account 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 315
VIVOTEK 8.6 System Logs Note: This request require Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/syslog.cgi Server will return the most up-to-date system log. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: \r\n \r\n \r\n 8.7 Upgrade Firmware Note: This request requires Administrator privileges. Method: POST Syntax: http:///cgi-bin/admin/upgrade.
PAGE 316
VIVOTEK 8.8 ePTZ Camera Control (capability.eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http:///cgi-bin/camctrl/eCamCtrl.
PAGE 317
VIVOTEK http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed. To stop a continuous movement, you have to use the command as below: http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zoom=stop&zs=0 2.
PAGE 318
VIVOTEK vx The direction of movement, used for joystick control. vy vs 0~7 Set the speed of movement, “0” means stop. x x-coordinate clicked by user. It will be the x-coordinate of center after movement. y y-coordinate clicked by user. It will be the y-coordinate of center after movement. videosize The size of plug-in (ActiveX)window in web page resolution The resolution of streaming.
PAGE 319
VIVOTEK 8.9 ePTZ Recall (capability.eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http:///cgi-bin/camctrl/eRecall.cgi?channel=&stream=& recall=[&return=] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source. stream <0~(m-1)> Stream. recall Text string less than 40 One of the present positions to recall.
PAGE 320
VIVOTEK 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. * If the is invalid path, it will ignore this parameter. 8.11 IP Filtering for ONVIF Syntax: http:///cgi-bin/admin/ipfilter.
PAGE 321
VIVOTEK 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 322
VIVOTEK 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 323
VIVOTEK 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. When using scalable multicast, Get SDP file which contains the multicast information via HTTP. 8.
PAGE 324
VIVOTEK 8.16 Senddata (capability.nuart > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http:///cgi-bin/viewer/senddata.cgi? [com=][&data=][&flush=] [&wait=] [&read=] PARAMETER VALUE DESCRIPTION com 1 ~ data is a series of digits from 0 ~ 9, A ~ F. Each data>[,
PAGE 325
VIVOTEK 8.17 Storage managements (capability.storage.dbenabled > 0) Note: This request requires administrator privileges. Method: GET and POST Syntax: http:///cgi-bin/admin/lsctrl.cgi?cmd=[&=…] The commands usage and their input arguments are as follows. PARAMETER VALUE DESCRIPTION cmd_type Required. Command to be executed, including search, insert, delete, update, and queryStatus.
PAGE 326
VIVOTEK Indicate if the file is locked or not. 0: file is not locked. 1: file is locked. A locked file would not be removed from UI or cyclic storage. triggerTime Optional. Indicate the event trigger time. (not the file created time) Format is “YYYY-MM-DD HH:MM:SS” Please embrace your input value with single quotes. Ex. triggerTime=’2008-01-01 00:00:00’ If you want to search for a time period, please apply “TO” operation. Ex.
PAGE 327
VIVOTEK label Required. Identify the designated record. Ex. label=1 isLocked Required. Indicate if the file is locked or not. Ex. Update records whose key numbers are 1 and 5 to be locked status. http:///cgi-bin/admin/lsctrl.cgi?cmd=update&isLocked=1&label=1&label=5 Ex. Update records whose key numbers are 2 and 3 to be unlocked status. http:///cgi-bin/admin/lsctrl.
PAGE 328
VIVOTEK 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] Ex: vi0=1 Setting virtual input 0 to trigger state Where "state" is 0, 1.
PAGE 329
VIVOTEK 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. Syntax: For HTTP push server (MJPEG): http:///_accessname>?maxsft=[&tsmode=&reftime=&forcechk&minsft=] For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player.
PAGE 330
VIVOTEK Return Code Description 400 Bad Request Request is rejected because some parameter values are illegal. 415 Unsupported Media Type Returned, if forcechk appears,when minsft is not achievable or the timeshift feature of the target stream is not enabled.
PAGE 331
VIVOTEK 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 332
VIVOTEK function zoom, Function type focus, zoom - Move focus motor auto, focus – Move focus motor scan, auto – Perform auto focus stop, scan – Perform focus scan positioning, stop – Stop current operation getstatus positioning – Position the motors getstatus–Information of motors, return value as below: remote_focus_zoom_motor_max: Maximum steps of zoom motor remote_focus_focus_motor_max: Maximum steps of focus motor remote_focus_zoom_motor_start: Start point of zoom motor remote_focus_zoom_
PAGE 333
VIVOTEK steps 1 ~ Motor’s moving steps. It works only if function=zoom | focus and direction=forward | backward. is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from "function=getstatus" * This parameter is for additional fine-tune, the value is from 1 to 30. iris N/A Open iris or not. It works only if function=auto | scan. 8.21 BackFocus (capability_image_c<0~(n-1)>_remotefocus=4) Note: This request requires Administrator privileges.
PAGE 334
VIVOTEK function focus, Function type auto, focus – Move focus motor scan, auto – Perform auto focus stop, scan – Perform focus scan positioning, stop – Stop current operation irisopen, positioning – Position the motors irisenable, resetfocus – reset focus position to default resetfocus, irisopen – Fully open iris. It will maintain this status until sending getstatus irisenable cgi.
PAGE 335
VIVOTEK steps 1 ~ Motor’s moving steps. It works only if function=focus and direction=forward | backward. is refer to remote_focus_focus_motor_max which replied from "function=getstatus" * This parameter is for additional fine-tune, the value is from 1 to 30. iris N/A Open iris or not. It works only if function=auto | scan. 8.22 Export Files Note: This request requires Administrator privileges.
PAGE 336
VIVOTEK 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/upload_backup.
PAGE 337
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.cgi?list_lens For choose selected lens configuration: http:///cgi-bin/admin/update_lens.
PAGE 338
VIVOTEK 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 339
VIVOTEK 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 340
VIVOTEK zoom wide Zoom larger view with current speed. tele Zoom further with current speed. speedpan -5 ~ 5 Set the pan speed of current command. speedtilt -5 ~ 5 Set the tilt speed of current command. speedzoom -5 ~ 5 Set the zoom speed of current command. zooming wide or tele Zoom without stopping for larger view or further view with zs speed, used for joystick control. zs 0~6 Set the speed of zooming, “0” means stop. vx -6 ~ 6 The direction of movement, used for joystick control.
PAGE 341
VIVOTEK 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 342
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 343
VIVOTEK 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. tele Zoom further with current speed. stop Stop zoom. wide or tele Zoom without stopping for larger view or further view with zs speed, zoom zooming used for joystick control.
PAGE 344
VIVOTEK * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20. cam getsetpreset Adds a named preset at current position, and return the preset index. * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20. return Redirect to the page after the parameter is assigned. The should be the relative path according to the root of camera.
PAGE 345
VIVOTEK "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" gettiltangle Get the current tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getzoom 0, Get the current zoom position. getratio Get the current zoom ratio. getfocus 0, Get the current focus position. getminspeedlv 0, Get the minimum speed level of the PTZ control.
PAGE 346
VIVOTEK getmaxdzoom 0, Get the upper limit for digital zoom position. getmaxratio Get the maximum ratio of optical zoom. * We support this parameter when the version number (getversion) is equal or greater than 5.0.0.14 getmaxdratio Get the maximum ratio of digital zoom. * We support this parameter when the version number (getversion) is equal or greater than 5.0.0.14 getminfocus 0, Get the lower limit for focus position.
PAGE 347
VIVOTEK 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. delpos string[30] Delete preset location from preset list.
PAGE 348
VIVOTEK 8.31 SmartSD (capability_localstorage_smartsd > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/smartsd.
PAGE 349
VIVOTEK function getstatus Function type getstauts : Information of smartSD internal status return value as below: smartsd_lifetime_num: Accumulated amount of data that has been written smartsd_lifetime_den: Card-guaranteed amount of data that can be written smartsd_lifetime_rate: The ratio of smartsd_lifetime_num to smartsd_lifetime_den. It means the accumulated percentage amount of flash block has been written. The range is from 0 to 100 (unit: %).
PAGE 350
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 351
VIVOTEK 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 352
VIVOTEK http://myserver/cgi-bin/admin/peripheral.cgi?channel=0&operation=set&washer_mode=wiper& washer_status=on Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "washer_mode : OK\r\n" "washer_status : FAIL\r\n" PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. washer_mode wiper Apply the wiper to the mode of washer control system.
PAGE 353
VIVOTEK capability_peripheral_c<0~(n-1)>_heater_suppo rt=1 trigger heater component is work in force heater once. *Only available when capability_peripheral_c<0~(n-1)>_heater_suppo rt=1 Syntax: (for querying API) http:///cgi-bin/admin/peripheral.
PAGE 354
VIVOTEK "capability_peripheral_c<0~(n-1)>_washer_mod e" washer_status N/A Get the current status of washer control module. The status is 'off' as default, which means the washer is stopped; and the status 'on' means the washer is running. *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 washer_dwelltime N/A Get the current washer clean period of washer control system.
PAGE 355
VIVOTEK 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": Camera will automatically adjust the IR zone one onetimeauto time only.
PAGE 356
VIVOTEK 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 357
VIVOTEK Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=settoall&irmode=manual&strength=100 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irstrength='100,100,100,100,100'" "optimizedir_c0_irmode='manual'" Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&irmode=auto&strength=50,70,50,50, 50 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: Parameter "irmo
PAGE 358
VIVOTEK 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. irnum N/A Get the number of IR that camera supports. Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=get&irmode 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'" 358 - User's Manu
PAGE 359
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 360
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.