Page 1
FD8177-HT Fixed Dome FD8377-HTV, FD8377-EHTV Network Camera User ’s Manual 4MP 30FPS • Day & Night • SNV • Smart Stream III WDR Pro • SNV II • 30M Smart IR • IP66 • IK10 • NEMA 4X Rev. 1.0...
Overview VIVOTEK’s FD8177 and FD8377 is an indoor/outdoor dome network camera equipped with a 4MP sensor enabling resolution of 2688x1520 at 30 fps. Featuring VIVOTEK SNV and WDR Pro technology, the camera is capable of capturing high quality images whether in high contrast or low light environments.
Commands of the Network Camera section serves as a helpful reference to customizing existing homepages or integrating with the current web server. Package Contents ■ FD8177-HT, FD8377-HTV, or FD8377-EHTV ■ L-wrench, desiccant bag (FD8377), screws. ■ Waterproof connector and side-routing bracket (FD8377).
VIVOTEK Symbols and Statements in this Document INFORMATION: provides important messages or advices that might help prevent inconvenient or problem situations. NOTE: Notices provide guidance or advices that are related to the functional integrity of the machine. Tips: Tips are useful information that helps enhance or facilitae an installation, function, or process.
Page 6
VIVOTEK Outer View (FD8377) Dome cover Dimensions (FD8177) FRONT view RIGHT view n 119.00 3- n 4.50 n 138.87 n 90.00 BOTTOM view TOP view Dimensions (FD8377) FRONT view RIGHT view n 154.98 3- n 4.50 n 140.00 BOTTOM view n 93.42...
Page 7
VIVOTEK Inner View (FD8177) IR LEDs Lens Tilt retention Microphone screw sensor Terminal block Status LEDs Reset button SD card slot Pan retention screw RJ45 Ethernet port NOTE: Some of the suffix syntax used in model naming are listed below:...
Page 8
VIVOTEK Inner View (FD8377) IR LEDs Lens Tilt retention screw RJ45 Ethernet Terminal block port SD card slot Reset button Pan retention screw Threaded hole for I/O wires Status LEDs Threaded hole for Ethernet cable IMPORTANT: 802.3at 100~240V LAN/PoE GE LAN...
VIVOTEK Hardware Installation (FD8177) 1. Jot down the camera's MAC address for later reference. XXXXXX 0002D10766AD 2. Remove the dome cover using the T10 L wrench. User's Manual - 9...
Page 10
VIVOTEK 3. When selecting an installation position, note the PIR detection range as illustrated below. 121° 77.3° 4. Attach the alignment sticker to a preferred location, and drill mounting holes. Hammer in the plastic anchors. 10 - User's Manual...
Page 11
DO+ (5V) 12V DC-_IN 10 12V DC+_IN 6. Please visit VIVOTEK’s website to Install the "Shepherd” software utility. The program will search for VIVOTEK Video Receivers, Video Servers or Network Cameras on the same LAN. Double-click on the camera’s MAC address to open a web console with the camera.
Software Installation 7. 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.
Page 13
VIVOTEK 7-3. The program will search for all VIVOTEK network devices on the same LAN. 7-4. After a brief search, the installer window will prompt. Click on the MAC and model name that matches the one printed on the product label. You can then double-click on the address to open a management session with the Network Camera.
Page 14
VIVOTEK 8-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 ~.
Page 15
VIVOTEK 9. Loosen, but not completely remove, the retention screws on the camera to adjust the camera’s shooting direction. You can pan, tilt, or rotate the camera. 350° 80° 350° 10. Tighten the retention screws when you are statisfied with the field of view.
VIVOTEK Hardware Installation (FD8377) 1. Jot down the camera's MAC address for later reference. XXXXXX 0002D10766AD 2. Remove the dome cover using the included T10 L wrench. 16 - User's Manual...
Page 17
VIVOTEK 3. Remove the waterproof cable gland components from the camera. 5~6.3mm DI/DO: 1.8~2.1mm 4. Route an Ethernet cable through the associated threaded hole on the camera. User's Manual - 17...
Page 18
VIVOTEK 5. Install the cable gland components, rubber seal, claw, and sealing nut, to the Ethernet cable. 6. Leave around 11.6cm of cable length within the camera, and fasten the cable gland sealing nut. Connect the Ethernet cable to the camera's RJ45 onnector.
Page 19
VIVOTEK 7. If preferred, insert DI/DO or power wires through the rubber seal, and install cable gland components. This cable gland must be installed whether you have DI/DO wires or not. Otherwise, water or moisture ingress will occur. The terminal block pinouts is shown below:...
Page 20
VIVOTEK 8. Use the alignment sticker to drill mounting holes on the ceiling or wall. If preferred, drill a routing hole. Install the camera by hammer in the wall anchors and drive screws. 9. When fastening the screws, do not completely tighten the screws. Pass cables through the routing holes, and then mount the camera by passing the screw heads through the keyhole slots.
Page 21
VIVOTEK If you prefer routing your cables through the side of the camera, install the side- routing bracket. The 3/4” conduit is user-supplied. 3/4" Please avoid using a conduit with a hex nut larger than 35mm. ≤3/4” Ø< 35mm User's Manual - 21...
Software Installation 11. Install the Shepherd utility, which helps you locate and configure your Network Camera in the local network. If your camera comes without the CD, go to VIVOTEK’s website, and locate the utility in the Downloads > Software page.
Page 23
11-2. The program will conduct an analysis of your network environment. 11-3. The program will search for all VIVOTEK network devices on the same LAN. 11-4. After a brief search, the installer window will prompt. Click on the MAC and model name that matches the one printed on the product label.
Page 24
VIVOTEK Forceful Password Configuration 12. The first time you log in to the camera, the firmware will prompt for a password configuration for security concerns. 12-1. Since your camera is used for the first time, there is no password. Enter “root” as the user name, and nothting for the password.
Page 25
VIVOTEK Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~. You can use them in the password combination. 12-3. Another prompt will request for the password you just configured. Enter the password and then you can start configure your camera and see the live view.
Page 26
VIVOTEK 13. Loosen, but not completely remove, the retention screws on the camera to adjust the camera’s shooting direction. You can pan, tilt, or rotate the camera lens module. 350° 350° 80° 14. According to the live view, adjust the shooting direction.
Page 27
VIVOTEK 16. Install the dome cover. NOTE: The "T" models comes with a motorized focus lens. Use the Focus function to zoom and tune to a best focus. From a web console, open the firmware configuration page. Enter the Configuration > Media > Image > Focus page. You will see a live stream on screen. If pre- ferred, you can zoom in on the scene.
Page 28
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.
Page 29
VIVOTEK Wet contact with external DC power source to supply a relay. Switch DC 0V External DC power External AC power with Protected Earth Relay External Device Dry contact and using camera’s DO+ to supply a relay. Switch External AC power...
Page 30
VIVOTEK LED Definitions Item LED status Description Steady Powered and system booting, or network failed LED off Power off Green LED off Network is disconnected Steady Green LED blinks every 1 Connected to network sec. Green LED blinks every 1 sec. and Upgrading firmware blinks consecutively every 0.15 sec.
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 sin- gle Ethernet cable. Follow the below illustration to connect the Network Camera to a PoE- enabled switch via Ethernet cable.
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.
Page 33
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.
Page 34
For more information with network configuration options (such as that of streaming ports), please refer to Configuration > Network Settings. VIVOTEK also provides the automatic port forwarding feature as an NAT traversal function with the precondition that your router must support the UPnP port forwarding feature.
3. Live video will be displayed in your web browser. 4. If it is the first time installing the VIVOTEK network camera, an information bar will prompt as shown below. Follow the instructions to install the required plug-in on your computer.
Page 36
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 106.
Page 37
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.
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.
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 To utilize this feature, please check the following settings on your Network Camera: 1.
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. If you encounter problems with displaying live view or the onscreen plug-in control, you may try to remove the plug-ins that might have been installed on your computer.
VIVOTEK Main Page This chapter explains the layout of the main page. It is composed of the following sections: VIVOTEK INC. Logo, Host Name, Camera Control Area, Configuration Area, Menu, and Live Video Window. Resize Buttons VIVOTEK INC. Host Name...
Page 42
VIVOTEK Note that the ePTZ navigation control panel is only available when you select to display Stream #3. ePTZ is supported by Stream #3 only. You can select to display only a portion of the FOV, and move the display area to display different portions within the FOV.
Page 43
VIVOTEK Live Video Window ■ The following window is displayed when the video mode is set to H.264: H.264 Protocol and Media Options Video Title Time 2017/03/25 17:08:56 Video (TPC-AV) Title and Time Video 17:08:56 2017/03/25 Zoom Indicator x4.0 Video Control Buttons Video Title: The video title can be configured.
Page 44
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.
Page 45
VIVOTEK Mute: Turn off the Mic volume on the local computer. The button becomes the Mic On button after clicking the Mute button. Full Screen: Click this button to switch to full screen mode. Press the “Esc” key to switch back to normal mode.
VIVOTEK Client Settings This chapter explains how to select the stream transmission mode and saving options on the local computer. When completed with the settings on this page, click Save on the page bottom to enable the settings. H.264 Media Options Select to stream video or audio data or both.
Page 47
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 Start MP4 Recording on the main page.
Page 48
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.
Page 49
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.
Page 50
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.
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.
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.
Page 53
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.
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. Logo graph Here you can change the logo that is placed at the top of your homepage.
Page 55
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 56
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.
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.
Page 58
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. VIVOTEK Network Cameras Internet 3G cell phone HTTP...
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.
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. Click Browse… and locate the firmware file.
Page 61
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 88). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
Page 62
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.
Page 63
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.
VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following columns: General settings, IR control, Image settings, Exposure, Focus, and Privacy mask. The Focus window is available only for models that come with motorized lens.
Page 65
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.
Page 66
VIVOTEK IR cut filter With a removable IR-cut filter, this Network Camera can automatically remove the filter to let Infrared light pass into the sensor during low light conditions. ■ Auto mode (The Day/Night Exposure Profile will not be available if Auto mode is selected) The Network Camera automatically removes the filter by judging the level of ambient light.
Page 67
VIVOTEK IR control Turn on built-in IR illuminator in night mode Select this to turn on the camera’s onboard IR illuminator when the camera detects low light condition and enters the night mode. Turn on external IR illuminator in night mode Select this to turn on the external IR illuminator when the camera detects low light condition and enters the night mode.
Page 68
VIVOTEK Tips: If there is an object in close proximity, the IR lights reflected back from it can mislead the Smart IR’s calculation of light level. To solve this problem, you can place an “Exposure Exclude” window on an unavoidable object in the Exposure setting window.
Page 69
VIVOTEK Image settings On this page, you can tune the White balance and Image adjustment. Sensor Setting 2: For special situations Sensor Setting 1: For normal situations White balance: Adjust the value for the best color temperature. ■ You may follow the steps below to adjust the white balance to the best color temperature.
Page 70
VIVOTEK Noise reduction ■ Enable noise reduction: Check to enable noise reduction in order to reduce noises and flickers in image. This applies to the onboard 3D Noise Reduction feature. Use the slide bar to adjust the reduction strength. Note that applying this function to the video channel will consume system computing power.
Page 71
VIVOTEK Exposure On this page, you can set the Exposure measurement window, Exposure level, Exposure mode, Exposure time, Gain control, and Day/Night mode settings. You can configure two sets of Exposure settings: one for normal situations, the other for special situations, such as the day/night/schedule mode.
Page 72
VIVOTEK The inclusive window refers to the “weighted window“; the exclusive window refers to “ignored window“. It adopts the weighted averages method to calculate the value. The inclusive windows have a higher priority. You can overlap these windows, and, if you place an exclusive window within a larger inclusive window, the exclusive part of the overlapped windows will be deducted from the inclusive window.
Page 73
VIVOTEK ■ AE Speed Adjustment: This function applies when you need to monitor fast changing lighting conditions. For example, the camera may need to monitor a highway lane or entrance of a parking area at night where cars passing by with their lights on can bring fast changes in light levels. The same applies if the camera is installed on a vehicle, and when it needs to adapt to fast changes of light when entering and leaving a tunnel.
Page 74
VIVOTEK Focus (Available on the FD8177-HT, FD8377-HTV and FD8377-EHTV) Focus here refers to the Remote Focus, applicable to Network Cameras that are equipped with a stepping motor lens. The automated focus adjustment function eliminates the needs to physically adjust camera focus. In an outdoor deployment consisting of a large number of cameras, the auto focus function can be very helpful when these cameras become out of focus after days or weeks of operation.
Page 75
VIVOTEK 5. Wait for the scan to complete. After a short while, the clearest image obtained should be displayed and the optimal focus range achieved. Use the arrow marks on the sides to fine-tune the focus if you are not satisfied with the results. You may still need to use the arrow marks to fine-tune the focus depending on the live image on your screen.
Page 76
VIVOTEK Privacy mask Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to address privacy concerns. ■ To 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.
VIVOTEK Media > Video Mode If the 4MP display mode is selected, the WDR Pro function for high contrast environments will not be available. With a slightly reduced 3.6MP resolution, the WDR Pro function is supported. User's Manual - 77...
Page 78
VIVOTEK Stream settings This Network Camera supports multiple streams with frame sizes ranging from 640 x 360 to 2560 x 1440 pixels The definition of multiple streams: ■ Stream 1: Users can define the "Region of Interest" (viewing region) and the "Output Frame Size"...
VIVOTEK Please follow the steps below to set up those settings for a stream: 1. Select a stream for which you want to set up the viewing region. 2. Select a Region of Interest from the drop-down list. The floating frame, the same as the one in the Gloabl View window on the home page, will resize accordingly.
Page 80
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.264 and MJPEG compression standards (Dual Codec) for real-time viewing. If the H.264...
Page 81
VIVOTEK ■ 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.
Page 82
VIVOTEK With the H.264 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 non- interested areas on a screen and therefore reduces the bandwidth consumed.
Page 83
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 84
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...
Page 85
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.
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.
Use fixed IP address: Select this option to manually assign a static IP address to the Network Camera. 1. You can make use of VIVOTEK Installation Wizard 2 on the software CD to easily set up the Network Camera on LAN. Please refer to Software Installation on page 12 for details.
Page 88
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.
Page 89
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 is not supported by your router, you will see the following message: Error: Router does not support UPnP port forwarding.
Page 90
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 is enabled. ► How does UPnP work? UPnP networking technology provides automatic IP configuration and dynamic discovery of devices added to a network.
Page 91
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.
Page 92
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.
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 106 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 95
VIVOTEK URL command -- http://<ip address>:<http port>/<access name for stream 1, 2, 3> 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.
Page 96
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. basic authentication is selected, the password is sent in plain text format, but there can be digest potential risks of it being intercepted.
Page 97
Unrestricted in scope IMPORTANT: The Multicast metadata port is utilized by VIVOTEK VADP modules to transfer video analytics results, PTZ stream, textual data, and event messages between the camera and the client side running and observing the video analysis. If your client side computer is located outside the local network, you may need to open the associated TCP port on routers and firewall.
Page 98
VIVOTEK 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.
Page 99
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 100
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...
Page 101
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.
Page 102
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 103
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.
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.
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.
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”...
Page 107
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.
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 109
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.
Page 110
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.
Page 111
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.
Page 112
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 113
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. User's Manual - 113...
Page 114
VIVOTEK Note that 11. When the certifice file is successfully loaded, its status will be stated as Active. a certificate must have been created and installed before you can click on the “Save" button for the configuration to take effect.
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 116
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).
Page 117
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.
Page 118
Authentication server (usually a RADIUS server): Checks the client certificate and decides whether to accept the end user’s access request. ■ VIVOTEK Network Cameras support two types of EAP methods to perform authentication: EAP- PEAP and EAP-TLS. Please follow the steps below to enable 802.1x settings: 1.
Page 119
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).
VIVOTEK PTZ > PTZ settings (only Applicable to Stream #3) 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.
Page 121
VIVOTEK Home page in the E-PTZ Mode ■ The e-Preset Positions will also be displayed on the home page. Select one from the drop-down list, and the Network Camera will move to the selected position. ■ If you have set up different preset positions for different streams, you can select one of the video streams to display its separate preset positions.
Page 122
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.
Page 123
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.
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 125
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.
Page 126
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.
Page 127
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.
Page 128
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 server to open the server setting window.
Page 129
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.
Page 130
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.
Page 131
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 152 for details. Note that only one NAS server can be configured. Click Save server to enable the settings.
Page 132
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 Click to delete level of the directory selected items Click to delete all...
Page 133
VIVOTEK Add media Add media Click 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.
Page 134
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 prefix Date and time suffix The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings.
Page 135
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.
Page 136
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.
Page 137
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. 20180213...
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.
Page 139
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 124.
Page 140
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 150 for detailed information. NOTE: ►...
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.
VIVOTEK Applications > Tampering detection This section explains how to set up camera tamper detection. With tamper detection, the camera is capable of detecting incidents such as redirection, blocking or defocusing, or even spray paint. Please follow the steps below to set up the camera tamper detection function: 1.
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.
Page 144
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.
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.
Page 147
VIVOTEK To start a module, select the checkcircle in front, and click the Start button. If you should need to remove a module, select the checkcircle in front and then click the Stop button. By then the module status will become OFF, and the X button will appear at the end of the row.
Page 148
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.
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 .
Page 150
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.
Page 151
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.
Page 152
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.
Page 153
VIVOTEK Event f you want to enable recording notification, please click to configure event triggering settings. Please refer to Event > Event settings on page 124 for more details. When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page.
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.
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.
Page 156
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 ■...
Page 157
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:...
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.
Page 159
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.
VIVOTEK 5. Get Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/viewer/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/operator/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/admin/getparam.cgi?[<parameter>] [&<parameter>…] Where the <parameter> should be <group>[_<name>] or <group>[.<name>]. If you do not specify any parameters, all the parameters on the server will be returned.
Page 161
If you omit this parameter, it will redirect to an empty page. (Note: The return page can be a general HTML file(.htm, .html) or a VIVOTEK server script executable (.vspx) file. It cannot be a CGI commandor have any extra parameters.This parameter must be User's Manual - 161...
Page 162
VIVOTEK placed at the end of the parameter list Return: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: <length>\r\n \r\n <parameter pair> where<parameter pair> is <parameter>=<value>\r\n [<parameter pair>] 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...
Page 163
VIVOTEK 7. Available parameters on the server Valid values: VALID VALUES DESCRIPTION string[<n>] 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.
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.
VIVOTEK 7.1system Group: system NAME VALUE SECURITY DESCRIPTION (get/set) hostname string[64] Host name of server (Network Camera, Wireless Network Camera, Video Server, Wireless Video Server). ledoff <boolean> Turn on (0) or turn off (1) all led indicators. date <YYYY/MM/DD>, Current date of system. Set to ‘keep’ to keep keep, date unchanged.
Page 166
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. 0: GMT Casablanca, Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London 40: GMT 01:00 Amsterdam, Berlin, Rome, Stockholm, Vienna, Madrid, Paris 41: GMT 01:00 Warsaw, Budapest, Bern...
Page 167
VIVOTEK Caledonia 480: GMT 12:00 Aucklan, Wellington, Fiji, Kamchatka, Marshall Is. 520: GMT 13:00 Nuku'Alofa daylight_enable <boolean> Enable automaticdaylight saving time in time zone. daylight_dstactualmode <positive integer> Check if current time is under daylight saving time. (Used internally) daylight_auto_begintime string[19] Display the current daylight saving start time.
Page 168
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 Restore the system parameters to default <positive integer>...
Page 169
VIVOTEK 7.1.1 system.info Subgroup of system: info (The fields in this group are unchangeable.) NAME VALUE SECURITY DESCRIPTION (get/set) modelname string[40] Internal model name of the server extendedmodelname string[40] ODM specific model name of server (eg. DCS-5610). If it is not an ODM model, this field will be equal to “modelname”...
Page 170
VIVOTEK xcount-1)> 7.2status Group: status NAME VALUE SECURITY DESCRIPTION (get/set) di_i<0~(capability_ndi-1)> <boolean> 0 => Inactive, normal <product dependent> 1 => Active, triggered (capability.ndi > 0) do_i<0~(capability_ndo-1)> <boolean> 0 => Inactive, normal <product dependent> 1 => Active, triggered (capability.ndo > 0) onlinenum_rtsp 0,<positive...
Page 171
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, 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"...
Page 172
VIVOTEK 7.6 Network Group: network NAME VALUE SECURITY DESCRIPTION (get/set) preprocess <positive integer> 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;...
Page 174
VIVOTEK 7.6.2 QOS Subgroup of network: qos_cos (capability.protocol.qos.cos > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable CoS (IEEE 802.1p) vlanid 1~4095 VLAN ID video Video channel for CoS audio Audio channel for CoS <product dependent> (capability.naudioin > 0)
Page 175
VIVOTEK 7.6.4 FTP Subgroup of network: ftp NAME VALUE SECURITY DESCRIPTION (get/set) port 21, 1025~65535 Local ftp server port. enable <boolean> Enable ftp. 7.6.5 HTTP Subgroup of network: http NAME VALUE SECURITY DESCRIPTION (get/set) port 80, 1025 ~ 65535 HTTP port.
Page 176
VIVOTEK 7.6.7 RTSP Subgroup of network: rtsp (capability.protocol.rtsp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 554, 1025 ~ 65535 RTSP port. (capability.protocol.rtsp=1) anonymousviewing <boolean> Enable anoymous streaming viewing. authmode disable, RTSP authentication mode. basic, (capability.protocol.rtsp=1) digest s<0~(capability_nmediast string[32] RTSP access name for stream N, N= 1~ ream-1)>_accessname...
Page 177
VIVOTEK number (httpversion) is equal or greater than 0304a. audioipaddress <ip address> Multicast audio IP address. <product dependent> * We support this parameter when the version number (httpversion) is equal or greater than 0304a. * Only available when capability_naudioin > 0 metadataipaddress <ip address>...
Page 178
VIVOTEK pass password[64] PPPoE account password. 7.7IP Filter Group: ipfilter NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable access list filtering. admin_enable <boolean> Enable administrator IP address. admin_ip string[43] Administrator IP address. maxconnection 1~10 Maximum number of concurrent streaming connection(s).
Page 179
VIVOTEK 7.8Video input Group: videoin NAME VALUE SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 CMOS frequency. * Only available when capability_videoin_type is 2. whitebalance auto, Modes of white balance. "auto": Auto white balance <product dependent> manual, rbgain, "rbgain": Use rgain and bgain to set white widerange, balance manually.
Page 180
VIVOTEK 6: EV 0 7: EV +0.3 8: EV +0.7 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.0 * Only available when "capability_image_c<0~(n-1)>_exposure_m ode" !=0 irismode fixed, indoor, Control DC-Iris mode. "outdoor": Auto-setting DC-Iris to get best outdoor <product...
Page 181
VIVOTEK (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)
Page 182
VIVOTEK * Only available when "capability_image_c<0~(n-1)>_exposure_m axrange" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposure_ra ngetype" is "twovalues". enablepreview <boolean> Usage for UI of exposure settings. Preview settings of video profile. * Only available when "capability_image_c<0~(n-1)>_exposure_m...
Page 183
VIVOTEK 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 CMOS frequency.
Page 184
VIVOTEK * Only available when "rbgain" is listed "capability_image_c<0~(n-1)>_wbm ode". * Only valid when "videoin_c<0~(n-1)>_whitebalance" != auto * Normalized range. bgain 0~100 Manual set bgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain" is listed "capability_image_c<0~(n-1)>_wbm...
Page 185
Iris, and keep adjusting Gain and Shutter speed automatically. "qualitypriority": Automatically adjust the Iris, Gain and Shutter Speed by 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.
Page 186
VIVOTEK "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 Manual set P-Iris. <product 1: Open <-> 100: Close dependent> * Only valid when "piris_mode"=manual or "capability_image_c<0~(n-1)>_sens...
Page 187
VIVOTEK 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 Gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_...
Page 188
VIVOTEK 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] Enclose caption. imprinttimesta <boolean> Overlay time stamp on video.
Page 189
VIVOTEK <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 190
VIVOTEK sure_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. enablepreview <boolean> 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 <coordinate>...
Page 191
VIVOTEK "capability_videoin_c<0~(n-1)>_sma rtfps_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. s<0~(m-1)>_h <boolean> Enable "Dynamic intra frame period". 264_dintraperio * Only available when d_enable "capability_videoin_c<0~(n-1)>_dint raperiod_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0301c.
Page 192
VIVOTEK 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"= vbr and "quant"= 100. The maximum allowed bit rate in fixed s<0~(m-1)>_h 20000~"capability_videoin_c<0~(n-1 " quality mode. 264_maxvbrbitr )>_h264_maxbitrate When the bit rate exceeds this value, frames will be dropped to restrict the bit rate. * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~5, 100 Set the pre-defined quality level:...
Page 193
VIVOTEK * Only valid when "ratecontrolmode"= s<0~(m-1)>_h framerate,imagequality Set prioritypolicy 264_prioritypoli * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~"capability_videoin_c<0~(n-1)>_h The maximum frame rates of a H264 264_maxframe 264_maxframerate" stream at different resolutions("capability_videoin_c<0~ (n-1)>_resolution") are recorded in "capability_videoin_c<0~(n-1)>_h26 4_maxframerate" s<0~(m-1)>_h...
Page 194
VIVOTEK mode encoded in the same quality. * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_h 1~5, Set the pre-defined quality level: 265_quant 99, 100 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "qpercent"...
Page 195
VIVOTEK bit rate. * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~5, 100 Set the pre-defined quality level: 265_cbr_quant 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent"...
Page 196
VIVOTEK s<0~(m-1)>_h framerate,imagequality Set prioritypolicy 265_prioritypoli * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~"capability_videoin_c<0~(n-1)>_h The maximum frame rates of a H265 265_maxframe 265_maxframerate" stream at different resolutions("capability_videoin_c<0~ (n-1)>_resolution") are recorded in "capability_videoin_c<0~(n-1)>_h26 5_maxframerate"...
Page 197
VIVOTEK 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue" s<0~(m-1)>_m 10~200 Manual video quality level input. The Q jpeg_qvalue (Only valid when value which is used by encoded library "capability_api_httpversion" format is directly. XXXXX_1 or XXXXX_3 ex: 0301a_1 or 0301a_3) * Only valid when "ratecontrolmode"=...
Page 198
VIVOTEK "ratecontrolmode"= cbr. * Only available when "capability_smartstream_version" >= "2.0" s<0~(m-1)>_m 1~100 Select customized quality in a jpeg_cbr_qperc normalized full range. 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"= cbr and "quant"= 100. * Only available when "capability_smartstream_version"...
Page 199
VIVOTEK dependent> * Only available when "capability_image_c<0~(n-1)>_wdrp ro_mode" > 0 wdrpro_strengt 1~100 The strength of WDR Pro. The bigger value means the stronger <product strength of WDR Pro. dependent> * Only available when "capability_image_c<0~(n-1)>_wdrp ro_strength" is 1 wdrc_mode <boolean> Enable WDR enhanced.
Page 200
VIVOTEK vity 1~20: level 1 <product 21~40: level 2 dependent> 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher sensitivity level meas that it is easy to be trigger while scene changed. * Only available when "capability_image_c<0~(n-1)>_aesp...
Page 201
VIVOTEK Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h264_smartstream2 (capability_smartstream_support=1 and capability_smartstream_version>=2.0) Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h265_smartstream2 (capability_smartstream_support=1, capability_smartstream_version>=2.0 and h265 is listed in "capability_videoin_codec") n denotes the value of "capability_nvideoin",m denotes the value of " capability_nmediastream" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or Disable smart codec function...
Page 202
VIVOTEK (capability_smartstream_support=1, capability_smartstream_version>=2.0 and capability_smartstream_mode_manual = 1) Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h265_smartstream2_win_i<0~(k-1)> (capability_smartstream_support=1, capability_smartstream_version>=2.0 and h265 is listed in "capability_videoin_codec" and capability_smartstream_mode_manual = 1) n denotes the value of "capability_nvideoin",m denotes the value of " capability_nmediastream",k denotes the value of "capability_smartstream_nwindow_manual". NAME VALUE...
Page 203
VIVOTEK 7.8.1.1 Alternative video input profiles per channel In addition to the primary setting of video input, there can be alternative profile video input setting for each channel which might be for different scene of light (daytime or nighttime). Group: videoin_c<0~(n-1)>_profile_i<0~(m-1)> for n channel profucts and m profile n denotes the value of "capability_nvideoin"...
Page 204
VIVOTEK * 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 205
Iris, and keep adjusting Gain and Shutter "capability_image_c speed automatically. <0~(n-1)>_exposu "qualitypriority": Automatically adjust the re_modetype") Iris, Gain and Shutter Speed by VIVOTEK quality algorithm. "manual": Manually adjust with variable Shutter, Iris and Gain. User's Manual - 205...
Page 206
VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0302a. *Only available when "capability_image_c0_exposure_mode" is 0 whitebalance auto, Modes of white balance. <product dependent> manual, "auto": Auto white balance "rbgain": Use rgain and bgain to set white...
Page 207
VIVOTEK * Only valid when "videoin_c<0~(n-1)>_whitebalance" != auto * Normalized range. maxgain 0~100 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...
Page 208
VIVOTEK piris_mode manual, indoor, Control P-Iris mode. <product dependent> outdoor,- "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 209
VIVOTEK "capability_image_c<0~(n-1)>_wdrpro_stren gth" is 1 wdrc_mode <boolean> Enable WDR enhanced. <product dependent> * Only available when "capability_image_c<0~(n-1)>_wdrc_mode" is 1 wdrc_strength 1~100 The strength of WDR enhanced. <product dependent> The bigger value means the stronger strength of WDR enhanced. * Only available when "capability_image_c<0~(n-1)>_wdrc_mode"...
Page 210
VIVOTEK "capability_image_c<0~(n-1)>_aespeedsupp ortsensitivity" is 1. flickerless <boolean> Turn on(1) or turn off(0) the flickerless mode <product dependent> * Only available when "capability_image_c<0~(n-1)>_flickerless" is 7.9Time Shift settings Group: timeshift for n channel profucts and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream"...
Page 211
VIVOTEK 7.10 IR cut control Group: ircutcontrol (capability.nvideoinprofile> 0 and capability_daynight_c<0~(n-1)>_support > 0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, Set IR cut control mode day, night, schedule <product dependent> <boolean> Enable/disable Smart IR <product dependent>...
Page 212
VIVOTEK "low,normal,high": if _c<0~(n-1)>_ircut sensitivity_type=op capability_daynight_c<0~(n-1)>_ircutsensiti tions) vity_type=options "1~100": if 1~100 (if capability_daynight capability_daynight_c<0~(n-1)>_ircutsensiti _c<0~(n-1)>_ircut vity_type=normalize sensitivity_type=no rmalize) * Only available when "capability_daynight_c<0~(n-1)> _ircutsensitivity_type" is not "-". 7.11 Image setting per channel Group: image_c<0~(n-1)> for n channel profucts and m profile n denotes the value of "capability_nvideoin"...
Page 213
VIVOTEK * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. saturation -5~5,100 -5: Less saturation <-> 5: More saturation <Not recommended to use this> 100: Use " image_c<n>_saturationpercent" * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicsetting"...
Page 214
* Only available when bit 3 of "capability_image_c<0~(n-1)>_basicsetting" is 1 gammacurve 0~100 0: Fine-turned gamma curve by Vivotek. <product dependent> 1: Gamma value = 0.01 2: Gamma value = 0.02 3: Gamma value = 0.03 100: Gamma value = 1 * Note: Although we set gamma value to 100 level, but not all gamma values are valid.
Page 215
VIVOTEK <product dependent> 0:disable 1:enable * Only available when "capability_image_c<0~(n-1)>_defog_mode" is 1 defog_strength 1~100 Strength of defog <product dependent> * Only available when "capability_image_c<0~(n-1)>_defog_mode" is 1 eis_mode <boolean> Electronic image stabilizer <product dependent> 0:disable 1:enable * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mode".
Page 216
VIVOTEK freeze <boolean> Enable/disable Image freeze while patrolling. <product dependent> 0: disable 1: enable * Only available when "capability_image_c<0~(n-1)>_freeze" is 1 deinterlace_enable <boolean> Enable/disable deinterlace function. 0: disable 1: enable * Only available when "capability_image_c<0~(n-1)>_deinterlace_s upport" is 1. deinterlace_mode spatial,blend...
Page 217
VIVOTEK version number (httpversion) is equal or greater than 0301a. profile_i<0~(m-1)>_begintime hh:mm Begin time of schedule mode. profile_i<0~(m-1)>_endtime hh:mm End time of schedule mode. profile_i<0~(m-1)>_brightness -5~5,100 -5: Darker <-> 5: Bright <Not recommended to use this> 100: Use " image_c<0~(n-1)>_brightnesspercent"...
Page 218
VIVOTEK * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. profile_i<0~(m-1)>_sharpness -3~3,100 -5: Less saturation <-> 5: More saturation <Not recommended to use this> 100: Use " image_c<0~(n-1)>_saturationpercent" * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicsetting"...
Page 219
VIVOTEK profile_i<0~(m-1)>_gammacur 0~100 0: Fine-turned gamma curve by Vivotek. 1: Gamma value = 0.01 2: Gamma value = 0.02 3: Gamma value = 0.03 100: Gamma value = 1 * Note: Although we set gamma value to 100 level, but not all gamma values are valid.
Page 220
VIVOTEK * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mode". profile_i<0~(m-1)>_eis_streng 1~100 Strength of electronic image stabilizer * Only available when 'eis' is listed in <product dependent> "capability_image_c<0~(n-1)>_is_mode". profile_i<0~(m-1)>_dis_mode <boolean> Digital image stabilizer <product dependent> 0:disable 1:enable * Only available when 'dis' is listed in "capability_image_c<0~(n-1)>_is_mode".
Page 221
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 "auto": Use full image view as the only exposure window.
Page 222
VIVOTEK "capability_image_c<0~(n-1)>_exposure_wi ndomain". homepx <0~W,0~H> 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> Width and height of the window.
Page 223
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". (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1 and when custom is listed in "capability_image_c<0~(n-1)>_exposure_winmode" and valid when "exposurewin_c<0~(n-1)>_mode"=custom or "exposurewin_c<0~(n-1)>_mode"=hlc)
Page 224
VIVOTEK ndomain". sizestd <0~9999x0~9999> 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...
Page 225
VIVOTEK volume_external 0~100 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 0: Mute off 1: Mute on...
Page 226
VIVOTEK 48000, * Only available if AAC is supported. 64000, 96000, 128000 s0_gamr_bitrate 4750, AMR encoded bitrate in bps. 5150, 5900, * Only available if AMR is supported. 6700, 7400, 7950, 10200, 12200 s0_g711_mode pcmu, Set G.711 companding algorithm. pcma pcmu: µ-law algorithm...
Page 227
VIVOTEK alarm_level 1~100 Audio detection alarm level profile_i0_enable <boolean> Enable/disable this profile setting profile_i0_policy night, 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.
Page 228
VIVOTEK (httpversion) is equal or greater than 0400a. Group: motion_c<0~(n-1)>_win_i<0~(k-1)> n denotes the value of "capability_nvideoin", k denotes the value of "capability_nmotion". NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable motion detection window. name string[14] Name of motion window.
Page 229
VIVOTEK * 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 Left coordinate of window position.
Page 230
VIVOTEK greater than 0400a. height 0 ~ 240 Height of motion detection window. <Not recommended to use * Only available when this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd...
Page 231
VIVOTEK polygonstd 0 ~ 9999,0 ~ 9999, Coordinate of polygon window position. 0 ~ 9999,0 ~ 9999, (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 0 ~ 9999,0 ~ 9999, * Only available when 0 ~ 9999,0 ~ 9999 "capability_motion_wintype" = polygon. * Only available when std is listed in "capability_motion_windomain...
Page 232
VIVOTEK <Not recommended to use * Only available when this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 233
VIVOTEK * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. 7.17 Tampering detection settings Group: tampering_c<0~(n-1)> for n channel products (capability.tampering > 0) n denotes the value of "capability_nvideoin" NAME VALUE...
Page 234
VIVOTEK 7.18 DDNS Group: ddns (capability.protocol.ddns > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the dynamic DNS. provider CustomSafe100, Safe100 => safe100.net DyndnsDynamic, DyndnsDynamic => dyndns.org (dynamic) DyndnsCustom, DyndnsCustom => dyndns.org Safe100 CustomSafe100 => Custom server using safe100 method <provider>_hostname...
Page 235
VIVOTEK service. 7.21 UPnP port forwarding Group: upnpportforwarding NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP port forwarding service. upnpnatstatus The status of UPnP port forwarding, used internally. 0 = OK, 1 = FAIL, 2 = no IGD router, 3 = no need for port forwarding 7.22 System log...
Page 236
VIVOTEK 7.23 SNMP Group: snmp (capability.protocol.snmp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) <boolean> SNMP v2 enabled. 0 for disable, 1 for enable <boolean> SNMP v3 enabled. 0 for disable, 1 for enable secnamerw string[31] Read/write security name secnamero string[31]...
Page 237
1 => Default logo logo_link string[128] Hyperlink of the logo http://www.vivotek. logo_powerbyvvtk_hidden <boolean> 0 => display the power by vivotek logo 1 => hide the power by vivotek logo custombutton_manualtrig <boolean> Show or hide manual trigger (VI) button in ger_show homepage 0 ->...
Page 238
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 <boolean> Enable privacy mask. win_i<0~(m-1)>_enable <boolean>...
Page 239
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, Coordinate of polygon window position.
Page 240
NAME VALUE SECURITY DESCRIPTION (get/set) api_httpversion <string> The version of VIVOTEK WebAPI with 4 This number start integers plus 1 alphabet, There are composed with 0301a. by "major version", "minor version", "revision","_platform". ex: 0301a_1 Major version Increase the major version when change,...
Page 241
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".
Page 242
VIVOTEK naudiosetting <positive integer> Number of audio settings per channel. <Not support anymore> * 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"...
Page 243
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 <boolean>...
Page 244
VIVOTEK 0307a. eptz 0, <positive For "nvideoin" = 1, the definition is as integer> 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.
Page 245
VIVOTEK tampering <boolean> Indicate whether to support tampering detection. tamperingmode tamper,toodark,toob Available tampering mode list. right,tooblurry * Only available when "capability_tampering" is 1. adaptiverecording <boolean> Indicate whether to support adaptive recording. adaptivestreaming <boolean> Indicate whether to support adaptive streaming. supporttriggertypes...
Page 246
VIVOTEK alable protocol_rtp_multicast_ba <boolean> Indicate whether to support backchannel ckchannel multicast. protocol_rtp_tcp <boolean> Indicate whether to support RTP over TCP. protocol_rtp_http <boolean> Indicate whether to support RTP over HTTP. protocol_spush_mjpeg <boolean> Indicate whether to support server push MJPEG. protocol_snmp <boolean>...
Page 247
VIVOTEK * This is kept for compatibility. videoin_codec mjpeg, h264, h265 Available codec of a device, split by comma. <product The sequence is not limited. dependent> FD8183 supports H.264 and MJPEG, then this is "mjpeg,h264". IP9171 supports H.264, MJPEG and H.265, then this is "mjpeg,h264,h265"...
Page 248
VIVOTEK <product affected functions are list here. dependent> The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it.
Page 249
VIVOTEK <Not support anymore> 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 Internal (Built-in) Microphone. Integer> 0: Not support 1: Support Bit 0 for CH0, bit 1 for CH1, and so on.
Page 250
VIVOTEK audioin_codec aac4, gamr, g711, Available audio codec. We take comma to split g726, - codec without any space. <product dependent> aac4: Advanced Audio Coding (AAC) gamr: Adaptive Multi-Rate (AMR) g711: G.711 g726: G.726 -: Not supported. audioout_codec g711, - Available codec list for SIP.
Page 251
VIVOTEK supported. * Only available when "capability_smartstream_support" is 1 smartstream_mode_hybri <boolean> Indicate whether hybrid(autotracking+ manual) smart stream is supported. * Only available when "capability_smartstream_support" is 1 smartstream_nwindow_a <positive integer> Maximum number of tracking window of utotracking autotracking. * Only available when "capability_smartstream_support"...
Page 252
VIVOTEK * It will be replaced by capability_camctrl_ptztunnel. camctrl_ptztunnel <boolean> Indicate whether to support ptztunnel. * We support this parameter when the version number (httpversion) is equal or greater than 0301b. This equals "capability_camctrl_c0_ptztunnel". * This is kept for compatibility.
Page 253
VIVOTEK wireless_beginchannel 1 ~ 14 Indicate the begin channel of wireless network wireless_endchannel 1 ~ 14 Indicate the end channel of wireless network wireless_encrypt_wep <boolean> Indicate whether to support wireless WEP. wireless_encrypt_wpa <boolean> Indicate whether to support wireless WPA. wireless_encrypt_wpa2 <boolean>...
Page 254
VIVOTEK media_videoclip_maxleng <positive integer> Maximum length (second) of a videoclip. media_videoclip_maxpree <positive integer> Maximum duration (second) after event vent occurred in a videoclip. image_iristype <string> Indicate iris type. <Not recommended to use "piris": P-Iris this> "dciris": DC-Iris "-": No Iris control support ...
Page 255
VIVOTEK localstorage_supportedge An 32-bit integer, which indicates the <positive integer> supportive application of edge storage. If the value of this parameter is larger than 0, it means that the camera supports edge recording function. bit 0 : It supports to record directly to an on-board SD-Card.
Page 256
VIVOTEK layout_redirection <string> Indicate which function will be redirected to the vadp package path. "-": Not supported. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. Group: capability_camctrl_c<0~(n-1)> n denotes the value of "capability_nvideoin"...
Page 257
VIVOTEK zoommodule <boolean> 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...
Page 258
VIVOTEK minpan 0, <positive integer> 0/7 The lower limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" maxpan 0, <positive integer> 0/7 The upper limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" minpanangle <integer>...
Page 259
VIVOTEK minzoom 0, <positive integer> 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, <positive integer> 0/7 The upper limit for zoom position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule" is "1"...
Page 260
VIVOTEK lightsensor <boolean> Indicate whether to support light sensor. blackwhitemode <boolean> Indicate whether to support automatically switch to Black & White display during the night mode. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 261
VIVOTEK Group: capability_videoin_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) The lens type of this channel. lens_type fisheye, fixed, fisheye: Fisheye lens varifocal, changeable, fixed: Build‐in fixed‐focus lens. motor, - varifocal: Build‐in varifocal lens. <product dependent> 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. ‐: N/A * Only available when [httpversion] >= 0301a rotation <boolean>...
Page 262
VIVOTEK rotationaffect When rotation is enabled, some features may <product dependent> 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 - (unchanged) : UI keeps the status as before and user can't change it.
Page 263
VIVOTEK orientation flip,mirror,rotation Indicates the camera supports flip, mirror or <product dependent> rotation. * We support this parameter when the version number (httpversion) is equal or greater than 0309b. streamcodec <positive integer> Represent supported codec types of each stream. This contains a list of positive integers, split by comma.
Page 264
VIVOTEK maxframerate A list of <Integer> Indicate frame rate that the video source outputs in current video mode. One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group. * This parameter may be changed when "videoin_c<n>_cmosfreq"=50 or "videoin_c<n>_modulation"=pal. Ex: 30 fps is changed to 25 fps, 60 fps is changed to 50 fps, and so on. mjpeg_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer>...
Page 265
VIVOTEK h264_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer> and "-" H.264 on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution"...
Page 266
VIVOTEK h265_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer> and "-" 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"...
Page 267
VIVOTEK dintraperiod_support <boolean> 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. * We support this parameter when the version number (httpversion) is equal or greater than 0301c.
Page 268
VIVOTEK 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 Available dewarp types of ceiling and floor mount. typewallmount 1O, 1P, 1R, 4R Available dewarp types of wall mount.
Page 269
VIVOTEK eptz 0, <positive integer> 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.
Page 270
VIVOTEK effectivepixel <WxH> 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 <WxH> The output size of source, equal to the captured size by device, in this video mode.
Page 271
VIVOTEK minresolution A list of <Integer> 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.
Page 272
VIVOTEK maxfps_h264 A list of <Positive Maximum fps which the device can encoded with Integer> 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"...
Page 273
VIVOTEK to proper position vertically or not. wdrpro_mode 0, 1, 2 0: Non-support WDR Pro 1: Support WDR Pro 2: Support WDR Pro and WDR Pro II wdrpro_strength 0, 1 0: Non-support tuning strength of...
Page 274
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"...
Page 275
VIVOTEK exposurelevel:ranged:<x>- - (disabled) : UI turns grey and users <x>, can't select it. exposuremode:fixed:auto - (unchanged) : UI keeps the status as before and user can't change it. <x>: nonnegative integer - (hidden) : UI is hidden. <product dependent>...
Page 276
VIVOTEK > 0. * We support this parameter when the version number (httpversion) is equal or greater than 0306d. dnrtype 2d,3d 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.
Page 277
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 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 278
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: Non-support scene mode...
Page 279
VIVOTEK "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL.
Page 280
VIVOTEK - (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 281
VIVOTEK 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"...
Page 282
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.
Page 283
VIVOTEK lens. sensortype rawsensor, Indicate sensor type. smartsensor, "rawsensor": Raw sensor "smartsensor": Smart sensor "-": N/A * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_mode 0: Non-support exposure control.
Page 284
VIVOTEK * 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". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_gainvaluetype fixed, * One to one mapping to the mode maximum, type in "exposure_modetype".
Page 285
VIVOTEK before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked.
Page 286
VIVOTEK <x>: nonnegative integer <product dependent> "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 287
VIVOTEK e_affect exposurewin.mode.blc:hidd enabled, some features may become en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here. exposurelevel:hidden:, or others The format is "Affect API name":"Policy":"Description" <x>: nonnegative integer <product dependent> "Policy" can be categorized into...
Page 288
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 0302a. exposure_qualitypriority When exposure quality priority mode mode_affect exposurewin.mode.blc:hidd is enabled, some features may become en:, malfunction or be forced to a given defog:disabled:, value.
Page 289
VIVOTEK "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when qualitypriority 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 0305a.
Page 290
VIVOTEK "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 291
VIVOTEK * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1 and hlc is listed in "capability_image_c<0~(n-1)>_ exposure_winmode". exposure_hlcmode_affect When hlc mode is enabled, some or others features may become malfunction or be forced to a given value. The <x>: nonnegative integer affected functions are list here.
Page 292
VIVOTEK "-" means no feature is affected. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1 and hlc is listed in "capability_image_c<0~(n-1)>_ exposure_winmode". * We support this parameter when the version number (httpversion) is equal or greater than 0304a. exposure_wintype ...
Page 293
VIVOTEK "capability_image_c<0~(n-1)>_ exposure_mode" is 1. A list of <Positive Integer> exposure_ntsc_totalrange Available total range for NTSC 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. A list of <Positive Integer> exposure_pal_totalrange Available total range for PAL analog output. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode"...
Page 294
VIVOTEK * When "exposure_mode"=0, this value must be set to "-". * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. privacymask_wintype rectangle, The supported mask window type. polygon, "polygon": The window is a 2D 3Drectangle polygon shape. "rectangle": The window is a 2D rectangle shape.
Page 295
VIVOTEK "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 296
VIVOTEK _mode"=1, this may be either 0 or 1. defog_supportlevel 0, <positive integer> The value indicate the support strength level of defog. defog_affect When defog is enabled, some features wdrpro:unchanged:, may become malfunction or be forced or others to a given value. The affected functions are list here.
Page 297
VIVOTEK * When "defog" = 0, this value must be "-" aespeed 0: Non-support AE speed 1: Support AE speed aespeedsupportlevel <positive integer> The value indicate the support strength level of aespeed. * Only available when "capability_image_c<0~(n-1)>_aesp eed" is 1.
Page 298
VIVOTEK focuswindomain qvga, px, std, - The domain to set a focus window. "qvga": a 320x240 range to represent the whole image. "px": Locate a window in the image with pixels. "std": A normalized 0~9999 range. "-": Not supported. focuswindow_nwindow 0,<positive integer>...
Page 299
VIVOTEK better image quality (than not using the deinterlace function at all). * Only available when capability_image_c<0~(n-1)>_deinte rlace_support is 1 lens_alignment <boolean> Indicate whether to support lens alignment function. * We support this parameter when the version number (httpversion) is equal or greater than 0309b.
Page 300
VIVOTEK 7.29 Event setting Group: event_i<0~2> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. enable 0, 1 Enable or disable this event. priority 0, 1, 2 Indicate the priority of this event: “0”= low priority “1”= normal priority “2”= high priority...
Page 301
VIVOTEK mdwin 0,<positive integer> 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 1 window. For example, to detect the 1 and 3 windows, set mdwin as 5.
Page 302
VIVOTEK weekday 0~127 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.
Page 303
VIVOTEK action_server_i<0~4>_ena <boolean> Enable or disable this server action. action_server_i<0~4>_me NULL, 0~4,101 Index of the attached media. 101 means "Recording Notify" action_server_i<0~4>_dat <boolean> Enable this to create folders by date, time, and efolder hour automatically. action_goto_enable <boolean> Enable/disable ptz goto preset position on event <product dependent>...
Page 304
VIVOTEK 7.30 Server setting for event action Group: server_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry type email, Indicate the server type: ftp, “email” = email server http, “ftp” = FTP server “http” = HTTP server “ns”...
Page 305
VIVOTEK 7.31 Media setting for event action Group: media_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry type snapshot, Media type to send to the server or systemlog, store on the server. videoclip, recordmsg snapshot_source 0~"capability_nmediastream"-1 Indicate the source of media stream.
Page 306
VIVOTEK videoclip_maxduration 1 ~ " Maximum duration of one video clip in capability_media_videoclip_maxlen seconds. gth" videoclip_maxsize 50 ~ " Maximum size of one video clip file in capability_media_videoclip_maxsiz Kbytes. e" 7.32 Recording Group: recording_i<0~1> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry.
Page 308
VIVOTEK dest 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] Folder name. maxsize 100~2000 Unit: Mega bytes. When this condition is reached, recording file is truncated.
Page 309
State or province name in the certificate information. localityname string[128] The locality name in thecertificate information. organizationname string[64] Organization name in the certificate VIVOTEK Inc. information. unit string[64] Organizational unit name in thecertificate VIVOTEK Inc. information. commonname string[64] Common name in the certificate information.
Page 310
VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) enabled <boolean> Enable automatic clean up method. Expired and not locked media files will be deleted. maxretentiontime_recordin <boolean> Enable automatic clean up method for video clip g_enabled generated by recording task. The parameter takes effect when autocleanup_enabled is enabled.
Page 311
VIVOTEK maxretentiontime_others_ <string> To specify the expired time for automatic clean maxage up, and it takes effect for all media files except media files generated by recording task. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss]S’ , similar with ISO8601 with symbols P Ex. P7D, it means 7 days. P1DT10H, it means 1 days and 10 hours.
Page 312
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 <boolean> Indicates multiple of zoom in is “on-screen <Not recommended to use display” or not. this> * Reserved for compatibility, and suggest don't use this since [httpversion] >...
Page 313
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. (capability.eptz > 0 or capability_fisheye = 1) PARAMETER VALUE SECURITY DESCRIPTION (get/set) patrolseq string[120] The patrol sequence of ePTZ. All the patrol position indexes will be separated by ","...
Page 314
(Read only) guid<0~2>_id string[127] The connected seamless streaming ID. (Read only) guid<0~2>_number Number of connected seamless streaming with guid<0~2>_id. (Read only) 7.39 VIVOTEK Application Development Platformsetting Group: vadp NAME VALUE SECURITY DESCRIPTION (get/set) version <string> Indicate the VADP version.
Page 315
Indicate the message that will be show on the running status when mouse over. vvtklicensemec string[40] Indicate the module use VIVOTEK license mechanism Group: vadp_schedule_i<0~(n-1)> for n VADP package number n denotes the value of "capability_vadp_npackage". (Only available when "capability_vadp_npackage" > 0 and the version number of "vadp_version" >= "1.3.2.0")
Page 316
VIVOTEK endtime hh:mm End time of the schedule Group: vadp_event NAME VALUE SECURITY DESCRIPTION (get/set) ntrigger 0,<positive integer> Indicate the number of topics to be transferred to event manager for trigger. triggerlist_i<0~(n-1)>_to string[256] Indicate the event notification with this topic will be transferred to event manager as trigger.
Page 317
VIVOTEK 2: enable PTZ commands with UART tunnel. * Only available when bit7 of capability_ptzenabled is 1 disablemdonptz <boolean> Disable motion detection on PTZ operation. 7.41 camera PTZ control (IZ series) Group: camctrl_c<0~(n-1)> for n channel products (capability_camctrl_c0_zoommodule = 1 and capability_camctrl_c0_buildinpt = 0) n denotes the value of "capability_nvideoin"...
Page 318
VIVOTEK 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] Name of the preset location. preset_i<0~(k-1)>_zoom capability_ptz_c<0~(n-1) Zoom position at each preset location. >_minzoom ~ capability_ptz_c<0~(n-1)
Page 319
VIVOTEK >_maxfocus digitalzoom <boolean> Enable/disable digital zoom zoomenhance <boolean> Enable /disable zoom enhancement returnhome <boolean> Enable/disable return home while idle. returnhomeinterval 1~999 While idle over this time interval, idle action will be taken. idleaction_enable <boolean> Enable/disable idle action while idle...
Page 320
VIVOTEK t,manual * Available values are listed in "capability_camctrl_c<0~ (n-1)>_focusmode" preset_i<0~(k-1)>_name string[40] Name of the preset location. preset_i<0~(k-1)>_pan capability_ptz_c<0~(n-1) Pan position at each preset location. >_minpan ~ capability_ptz_c<0~(n-1) >_maxpan preset_i<0~(k-1)>_tilt capability_ptz_c<0~(n-1) Tilt position at each preset location. >_mintilt ~ capability_ptz_c<0~(n-1) >_maxtilt...
Page 322
VIVOTEK "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. tour_i<0~19>_checklist string[512] The indexes of preset positions, separated by “,”...
Page 323
VIVOTEK 7.43 UART control Group: uart (capability.nuart > 0 and capability.fisheye = 0) NAME VALUE SECURITY DESCRIPTION (get/set) ptzdrivers_i<0~19, string[40] Name of the PTZ driver. 127>_name ptzdrivers_i<0~19, string[128] Full path of the PTZ driver. 127>_location enablehttptunnel <boolean> Enable HTTP tunnel channel to control UART.
Page 324
VIVOTEK 127 (custom), 128 (no driver) 7.44 UART control (SD series) Group: uart_i<0~(n-1)> n is uart port count (capability.nuart > 0 and the bit7 of capability_ptzenabled is 0, the bit4 of capability_ptzenabled is 1) NAME VALUE SECURITY DESCRIPTION (get/set) cameraid 1~255 Camera ID controlling external PTZ camera.
Page 325
VIVOTEK 7.45 Lens configuration Group: lens for n channel products n denotes the value of "capability_nvideoin" (capability.image.c<0~(n-1)>.lensconfiguration.support = 1) NAME VALUE SECURITY DESCRIPTION (get/set) selected <string> Current selected lens profile. e.g. lens_selected=lens_default_i0, it means choosen lens configuration is i0 lens of default group.
Page 326
VIVOTEK 7.46 Fisheye info Group: fisheyeinfo (capability.fisheye > 0) NAME VALUE SECURITY DESCRIPTION (get/set) revisedcenteraxis <coordinate> The actual center axis coordinate radius 0, <positive The actual center radius integer> 7.47 Fisheye local dewarp setting Group: fisheyedewarp_c<0~(n-1)> (capability_fisheyelocaldewarp_c<0~(n-1)> > 0) ...
Page 327
VIVOTEK 7.49 Auto tracking setting Group: autotrack_c<0~(n-1)> (capability_image_c<0~(n-1)>_autotrack_support > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) objsize_type -1~2 Type of object size. -1 : customized width and height 0 : object size = 30 x 30...
Page 328
VIVOTEK 7.50 Wireless Group: wireless (capability_network_wireless > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) ssid string[32] SSID for wireless lan settings. wlmode Infra, Wireless mode. Adhoc Infra: Infrastructure channel 1~11 A list of WLAN channels. 1~13 Countries apply their own regulations to the 10~11 or allowable channels.
Page 329
VIVOTEK key4 password [26] WEP key4 for encryption. * Only valid when "wireless_encrypt" is "wep" algorithm AES, TKIP Algorithm * Only valid when "wireless_encrypt" is "wpa" or "wpa2" presharedkey password [64] WPA/WPA2PSK mode pre-shared key. * Only valid when "wireless_encrypt" is "wpa" or "wpa2"...
Page 330
VIVOTEK 8. Useful Functions Drive the Digital Output (capability.ndo > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/setdo.cgi?do1=<state>[&do2=<state>] [&do3=<state>][&do4=<state>] Where state is 0 or 1; “0” means inactive or normal state, while “1” means active or triggered state.
Page 331
VIVOTEK Query Status of the Digital Input(capability.ndi > 0) Note: This request requires Viewer privileges Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/getdi.cgi?[di0][&di1][&di2][&di3] If no parameter is specified, all of the digital input statuses will be returned. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <length>\r\n \r\n [di0=<state>]\r\n...
Page 332
VIVOTEK Query Status of the Digital Output (capability.ndo > 0) Note: This request requires Viewer privileges Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/getdo.cgi?[do0][&do1][&do2][&do3] If no parameter is specified, all the digital output statuses will be returned. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <length>\r\n \r\n [do0=<state>]\r\n...
Page 333
VIVOTEK Capture Single Snapshot Note: This request requires Normal User privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/video.jpg?[channel=<value>][&resolution=<value>] [&quality=<value>][&streamid=<value>] 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 334
VIVOTEK Account Management Note: This request requires Administrator privileges. Method: POST Syntax: http://<servername>/cgi-bin/admin/editaccount.cgi? method=<value>&username=<name>[&userpass=<value>][&privilege=<value>] [&privilege=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION method 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 336
VIVOTEK System Logs Note: This request require Administrator privileges. Method: GET/POST Syntax: http://<servername>/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: <syslog length>\r\n \r\n <system log information>\r\n Upgrade Firmware Note: This request requires Administrator privileges.
Page 337
VIVOTEK ePTZ Camera Control (capability.eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eCamCtrl.cgi?channel=<value>&stream=<value> [&move=<value>] – Move home, up, down, left, right [&auto=<value>] – Auto pan, patrol [&zoom=<value>] –Zoom in, out [&zooming=<value>&zs=<value>] –Zoom without stopping, used for joystick [&x=<value>&y=<value>&w=<value>&h=<value>&resolution=<value>] - Zoom in, out on a specific area...
Page 338
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. [Area zoom]: it means to zoom in on a specific area, here is an example for a directly moving...
Page 339
VIVOTEK <integer> The direction of movement, used for joystick control. <integer> 0 ~ 7 Set the speed of movement, “0” means stop. <integer> x-coordinate clicked by user. It will be the x-coordinate of center after movement. <integer> y-coordinate clicked by user.
Page 340
VIVOTEK ePTZ Recall (capability.eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/eRecall.cgi?channel=<value>&stream=<value>& recall=<value>[&return=<return page>] 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 341
VIVOTEK delpos <Text string less than Delete preset location from the preset list. 40 characters> return <return page> Redirect to the page <return page> after the parameter is assigned. The <return page> should be the relative path according to the root of camera.
Page 342
VIVOTEK 8.12 UART HTTP Tunnel Channel (capability.nuart > 0) Note: This request requires Operator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/operator/uartchannel.cgi?[channel=<value>] ------------------------------------------------------------------------- GET /cgi-bin/operator/uartchannel.cgi?[channel=<value>] x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------- POST /cgi-bin/operator/uartchannel.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache...
Page 343
VIVOTEK 8.13 Event/Control HTTP Tunnel Channel (capability. evctrlchannel > 0) Note: This request requires Administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/ctrlevent.cgi ------------------------------------------------------------------------- GET /cgi-bin/admin/ctrlevent.cgi x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------- POST /cgi-bin/admin/ ctrlevent.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled...
Page 344
VIVOTEK 8.14 Get SDP of Streams Note: This request requires Viewer access privileges. Method: GET/POST Syntax: http://<servername>/<network_rtsp_s<0~m-1>_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.
Page 345
VIVOTEK 8.16 Senddata (capability.nuart > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/senddata.cgi? [com=<value>][&data=<value>][&flush=<value>] [&wait=<value>] [&read=<value>] PARAMETER VALUE DESCRIPTION 1 ~ <max. com port The target COM/RS485 port number. number> data <hex decimal The <hex decimal data> is a series of digits from 0 ~ 9, A ~ F. Each data>[,<hex decimal...
Page 346
VIVOTEK 8.17 Storage managements (capability.storage.dbenabled > 0) Note: This request requires administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=<cmd_type>[&<parameter>=<value>…] The commands usage and their input arguments are as follows. PARAMETER VALUE DESCRIPTION cmd_type <string> Required. Command to be executed, including search, insert, delete, update, and queryStatus.
Page 347
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 <text> Optional. Indicate the event trigger time. (not the file created time) Format is “YYYY-MM-DD HH:MM:SS”...
Page 348
VIVOTEK label <integer primary key> Required. Identify the designated record. Ex. label=1 isLocked <boolean> Required. Indicate if the file is locked or not. Ex. Update records whose key numbers are 1 and 5 to be locked status. http://<servername>/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.
Page 349
VIVOTEK 8.18 Virtual input (capability.nvi > 0) Note: Change virtual input (manual trigger) status. Method: GET Syntax: http://<servername>/cgi-bin/admin/setvi.cgi?vi0=<value>[&vi1=<value>][&vi2=<value>] [&return=<return page>] PARAMETER VALUE DESCRIPTION vi<num> state[(duration)nstate] Ex: vi0=1 Setting virtual input 0 to trigger state Where "state" is 0, 1. “0”...
Page 350
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<n>_s<m>_allow=1) Note: This request requires Viewer access privileges. Syntax: For HTTP push server (MJPEG): http://<servername>/<network_http_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&reftime=<v alue>&forcechk&minsft=<value>] For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player.
Page 351
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. User's Manual - 351...
Page 353
VIVOTEK function zoom, Function type focus, zoom - Move focus motor auto, focus – Move focus motor scan, auto – Perform auto focus scan – Perform focus scan stop, positioning, stop – Stop current operation getstatus positioning – Position the motors getstatus–Information of motors, return value as below:...
Page 354
VIVOTEK steps 1 ~ <motor_max> Motor’s moving steps. It works only if function=zoom | focus and direction=forward | backward. <motor_max> 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.
Page 356
VIVOTEK function focus, Function type auto, focus – Move focus motor scan, auto – Perform auto focus stop, scan – Perform focus scan stop – Stop current operation positioning, irisopen, positioning – Position the motors irisenable, resetfocus – reset focus position to default resetfocus, irisopen –...
Page 357
VIVOTEK steps 1 ~ <motor_max> Motor’s moving steps. It works only if function=focus and direction=forward | backward. <motor_max> 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.
Page 358
VIVOTEK 8.23 Upload Files Note: This request requires Administrator privileges. Method: POST Syntax: For daylight saving time configuration file: http://<servername>/cgi-bin/admin/upload_dst.cgi Post data: filename =<file name>\r\n \r\n <multipart encoded form data> For language file: http://<servername>/cgi-bin/admin/upload_lan.cgi Post data: filename =<file name>\r\n \r\n <multipart encoded form data>...
Page 359
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://<servername>/cgi-bin/admin/update_lens.cgi?get_currentlens For list all names of lens installed in camera: http://<servername>/cgi-bin/admin/update_lens.cgi?list_lens For choose selected lens configuration: http://<servername>/cgi-bin/admin/update_lens.cgi?choose_lens=<value>...
Page 360
VIVOTEK upload_lens_profile_input = <file name>\r\n \r\n <multipart encoded form data> Server will accept the file named <file name> 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.
Page 361
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://<servername>/cgi-bin/camctrl/fdCamCtrl.cgi?channel=<value>&stream=<value> [&move=<value>] – Move home, up, down, left, right [&zoom=<value>] – Zoom wide, tele [[&speedpan=<value>][&speedtilt=<value>][&speedzoom=<value>]]...
Page 362
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.
Page 363
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://<servername>/cgi-bin/admin/setpm3d.cgi?method=<value>&maskname=<value>&[maskheight=<valu e>&maskwidth=<value>&videosize=<value>&return=<return page>] PARAMETER VALUE DESCRIPTION method Add a 3D privacy mask at current location delete...
Page 364
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://<servername>/cgi-bin/camctrl/camctrl.cgi?[channel=<value>][&camid=<value>] [&move=<value>] – Move home, up, down, left, right [&focus=<value>] – Focus operation [&zoom=<value>] – Zoom in, out [&zooming=<value>&zs=<value>] – Zoom without stopping, used for joystick [&vx=<value>&vy=<value>&vs=<value>] –...
Page 365
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.
Page 366
VIVOTEK * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20. 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.
Page 367
VIVOTEK gettiltangle <integer> Get the current tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getzoom 0, <positive integer> Get the current zoom position. getratio <decimal> Get the current zoom ratio. getfocus 0, <positive integer> Get the current focus position.
Page 368
VIVOTEK getmaxratio <decimal> 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 <decimal> 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...
Page 369
VIVOTEK 8.30 Preset Locations (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/preset.cgi?[channel=<value>] [&addpos=<value>][&delpos=<value>][&return=<return page>] 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 371
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.
Page 372
VIVOTEK 8.32 Connect to AP (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION Apply the wireless settings and connect to AP. 8.33 Get wireless information (capability_network_wireless > 0) Note: This request requires Administrator privileges.
Page 373
VIVOTEK 8.34 Get wireless signal strength (capability_network_wireless > Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/getwlsignalstrength.cgi PARAMETER VALUE DESCRIPTION Get wireless signal strength. 8.35 WPS transaction (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/start_wps.cgi...
Page 374
VIVOTEK 8.36 Peripheral control (capability_peripheral_c<0~(n-1)>_ devicecontrol > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/admin/peripheral.cgi?channel=<value>&operation=set [&washer_mode=<value>] – Set washer mode [&washer_status=<value>] – Set washer status [&washer_dwelltime=<value>] – Set washer clean time [&heater_status=<value>] – Set heater status Example: http://myserver/cgi-bin/admin/peripheral.cgi?channel=0&operation=set&washer_mode=wiper&...
Page 375
VIVOTEK *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 Disable the functionality of washer control system. *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 washer_dwelltime 15~999 Apply washer washer control system operation time (including the time when spraying and wiper actions take place). *Only available when capability_peripheral_c<0~(n-1)>_washer_supp...
Page 376
VIVOTEK Pragma: no-cache\r\n \r\n supportdevice=washer,heater\r\n washer_status=off\r\n PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. supportdevice Get support peripheral device. washer_supportmode Get the support mode of washer control system, its value is the same with "capability_peripheral_ c<0~(n-1)>_washer_mode". *Only available when capability_peripheral_c<0~(n-1)>_washer_supp...
Page 377
VIVOTEK an internal condition.‘trigger’ status will be transfer to ‘auto’ after reach the internal condition. *Only available when capability_peripheral_c<0~(n-1)>_heater_suppo rt=1 8.37 Optimized IR control (capability_daynight_c<0~(n-1)>_optimizedir > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/optimizedir.cgi?function=<value>[&channel=<value>] PARAMETER VALUE...
Page 378
VIVOTEK Example: 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://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=<value>&irmode=manual [&strength=<value>] – Set IR strength PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. ...
Page 379
VIVOTEK "optimizedir_c0_irmode='manual'" 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, Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: Parameter "irmode" must be set as "manual"! ...
Page 380
VIVOTEK http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&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: Must have the "irmode=manual" argument! Syntax: (for querying API) http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=get [&support_irmode] – list all adjustment mode that IR supports [&irmode] – Get current IR mode ...
Page 381
Technical Specifications VIVOTEK Technical Specifications Audio Model FD8177-HT System Information Audio Capability Two-way audio Multimedia SoC (System-on-Chip) Compression G.711, G.726 Flash 128MB Build-in microphone Interface External microphone input External line output 512MB Effective Range 5 meters Camera Features Network Image Sensor 1/3"...
Page 383
Power Input FD8377-EHTV: Maximum Streams 3 simultaneous streams DC 12V, IEEE 802.3at PoE Class 4 S/N Ratio 68 dB FD8377-HTV: Max. 11 W Power Consumption FD8377-EHTV: Max. 23 W Dynamic Range 110 dB Dimensions Ø 155 x 104 mm Adjustable resolution, quality and constant Video Streaming bit rate control;...
Page 385
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.
Page 386
取扱説明書に従って正しい取り扱いをして下さい Liability VIVOTEK Inc. cannot be held responsible for any technical or typographical errors and reserves the right to make changes to the product and manuals without prior notice. VIVOTEK Inc. makes no warranty of any kind with regard to the material contained within this document, including, but not limited to, the implied warranties of merchantability and fitness for any particular purpose.
Need help?
Do you have a question about the FD8377-HTV and is the answer not in the manual?
Questions and answers