Page 1 CC8160 Compact Cube Network Camera User ’s Manual 2MP • 180° Panoramic View • Smart Stream II • Rev. 1.0...
Page 2: Table Of Contents
Ready to Use ............................15 Accessing the Network Camera 16 Using Web Browsers ..........................16 Using RTSP Players ..........................19 Using 3GPP-compatible Mobile Devices ....................20 Using VIVOTEK Recording Software ....................21 Main Page 22 Client Settings 27 H.264 Media Options ..........................27 H.264 Protocol Options ........................27 MP4 Saving Options ..........................28...
Page 3: Revision History
Applications > Motion detection...........................111 Applications > Tampering detection ........................114 Applications > Audio detection ......................... 115 Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) ..... 117 Recording > Recording settings ........................120 Appendix 125 URL Commands for the Network Camera ......................125 1.
Page 4: Overview4
The trademark "VIVOTEK" or any other trademarks, service marks, trade names, distinctive logos, pictures, or designs as designated by VIVOTEK and as used on or in connection with the Product are the sole properties of VIVOTEK ("VIVOTEK Trademarks and Trade Names").
Page 5: Read Before Use
Camera section serves as a helpful reference to customizing existing homepages or integrating with the current web server. Package Contents ■ CC8160 - the Network Camera ■ Quick Installation Guide / Warranty Card ■ Screws Symbols and Statements in this Document INFORMATION: provides important messages or advices that might help prevent inconvenient or problem situations.
Page 6: Physical Description
VIVOTEK Physical Description Reset button Lens Microphone RJ-45 release hole Camera bracket 6 - User's Manual...
Page 7 VIVOTEK Considerations Camera View Coverage Side View Vertical: Horizontal: 100º 180º Top View Installation Concern 15º 1.6~1.8m Recognition Perception The camera is designed to capture human activities in a near-hemispheric field of view, at a place such as a cashier or bank counter. Due to the optical characteristics of wide-angle lens, image quality decreases as distance from an object increases.
Page 8 VIVOTEK Reset Button Hardware Reset The reset button is used to reset the system or restore the factory default settings. Sometimes resetting the system can return the camera to normal operation. If the system problems remain after a reset, press the reset button longer to restore the factory settings and install again.
Page 9: Hardware Installation
VIVOTEK Hardware Installation Connecting Ethernet Cable 1. Insert your Ethernet cable through the opening at the bottom of the camera bracket. 2. If using a round cable: When the RJ-45 plug is fully inserted, use the round-head screw with a washer to secure its position from the bottom of the bracket.
Page 10 VIVOTEK Mounting the Network Camera - Wall Mount 1. You can install the camera to a vertical surface by driving screws through the holes shown below. 2. You may also install the bracket to a 4” x 2” utility box (as outlet or switch socket).
Page 11 VIVOTEK LED Definitions Item LED status Description Steady Red Power is on and system booting Red LED off Powered down Red blinks every 1 second. Network works (heartbeat). On for 1 second, and Off for Note that on this model, LED blinking may not be very another.
Page 12: Network Deployment 12
VIVOTEK Network Deployment Setting up the Network Camera over the Internet The first way is to set There are several ways to set up the Network Camera over the Internet. The second way is to utilize a static up the Network Camera behind a router.
Page 13 VIVOTEK Internet connection with static IP Choose this connection type if you are required to use a static IP for the Network Camera. Please refer to LAN configuration on page 55 for details. Internet connection via PPPoE (Point-to-Point over Ethernet) Choose this connection type if you are connected to the Internet via a DSL Line.
Page 14: Software Installation
After your network environment is analyzed, please click Next to continue the program. 3. The program will search for all VIVOTEK network devices on the same LAN. 4. After a brief search, the main installer window will pop up. Double-click on the MAC address that matches the one printed on the camera label or the S/N number on the package box label to open a browser management session with the Network Camera.
Page 15: Ready To Use
VIVOTEK Ready to Use 1. A browser session with the Network Camera should prompt as shown below. 2. You should be able to see live video from your camera. You may also install the 32-channel recording software from the software CD in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents.
Page 16: Accessing The Network Camera 16
3. The 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 17 VIVOTEK NOTE: For Mozilla Firefox or Netscape users, your browser will use Quick Time to stream live video. If you do not have Quick Time on your computer, please download Quick Time from Apple Inc's website, and then launch your web browser.
Page 18 VIVOTEK NOTE: 1. By default, your Network Camera is not password-protected. To prevent unauthorized access, it is highly recommended to configure a password for your camera later. For more information about how to enable password protection, please refer to Security on page 77.
Page 19: Using Rtsp Players
VIVOTEK Using RTSP Players To view the H.264 streaming media using RTSP players, you can use one of the following players that support RTSP streaming. Quick Time Player VLC Player 1. Launch the RTSP player. 2. Choose File > Open URL. A URL dialog box will prompt.
Page 20: Using 3Gpp-Compatible Mobile Devices
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.
Page 21: Using Vivotek Recording Software
VIVOTEK Using VIVOTEK Recording Software The product software CD also contains recording software, allowing simultaneous monitoring and video recording for multiple Network Cameras. Please install the recording software; then launch the program to add the Network Camera to the Channel list. For detailed information about how to use the recording software, please refer to the user’s manual of the software or...
Page 22: Main Page 22
VIVOTEK Main Page This chapter explains the screen elements on the main page. It is composed of the following sections: VIVOTEK INC. Logo, Host Name, Camera Control Area, Configuration Area, and Live Video Window. VIVOTEK logo Configuration Resize Buttons Area...
Page 23 VIVOTEK Control Panel Video Stream: This Network Cmera supports dual stream display (stream #1 and #2) simultaneously. You can select any one of them for live viewing. For more information about multiple streams, please refer to page 50 for detailed information.
Page 24 VIVOTEK Once started, you can use the Stop button to stop the current action. A click on the screen can also stop the tracking action. Another key concept is that the camera only detect movements within the current field of view.
Page 25 VIVOTEK Video Title: The video title can be configured. For more information, please refer to Video settings on page 50. H.264 Protocol and Media Options: The transmission protocol (TCP or UDP, etc.)and media options for H.264 video streaming. For further configuration, please refer to Client Settings on page 27.
Page 26 VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Time Video (HTTP-V) 2017/03/10 17:08:56 Title and Time Video 17:08:56 2017/03/10 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 45.
Page 27: Client Settings 27
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 28: Mp4 Saving Options
VIVOTEK MP4 Saving Options Users can record live video as they are watching it by clicking the “Start MP4 Recording” button on the main page. Here, you can specify the storage destination and file name. Folder: Specify a storage destination for the recorded video files.
Page 29 VIVOTEK Joystick Settings Enable Joystick Connect to the USB plug of the joystick to a USB port on your management computer. Once a USB joystick is connected, the related joystick configuration will be available on the Client settings window. The joystick should work properly without installing any other driver or software.
Page 30 VIVOTEK Buttons Configuration In the Joystick Settings window, you can use the combinations of pull-down menus, Actions and Button number, to assign joystick buttons with different functions. The number of buttons may differ from the joystick you attached. Please follow the steps below to configure your joystick buttons: 1.
Page 31 VIVOTEK NOTE: • If you want to assign Preset actions to your joystick, the PTZ preset locations should be configured in advance. • If your joystick is not working properly, it may need to be calibrated. Click the Calibrate button to open the Game Controllers window located in Microsoft Windows control panel and follow the instructions for trouble shooting.
Page 32: Configuration 32
Click Configuration on the main page to enter the camera setting pages. Note that only Administrators can access the configuration page. VIVOTEK provides an easy-to-use user interface that helps you set up your network camera with minimal effort. In order to simplify the user interface, detailed information will be hidden unless you click on the function item.
Page 33: System > General Settings
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 34 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.
Page 35: System > Homepage Layout
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 36 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 37 VIVOTEK ■ Follow the steps below to set up the customed homepage: 1. Click Custom on the left column. 2. Click the field where you want to change the color on the right column. Color Selector Custom Pattern 3. The palette window will pop up as shown below.
Page 38: System > Logs
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 39 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...
Page 40: System > Parameters
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.
Page 41: System > Maintenance
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 42 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 55). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
Page 43 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 44 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.
Page 45: Media > Image
VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following four columns: General settings, Picture settings, Exposure, Focus, and Privacy mask. The Focus window is available only for models that come with motorized lens.
Page 46 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 47 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 48 VIVOTEK Noise reduction ■ Enable noise reduction: Check to enable noise reduction in order to reduce noises and flickers in image. This applies to the onboard 3D Noise Reduction feature. Use the pull-down menu to adjust the reduction strength. Note that applying this function to the video channel will consume system computing power.
Page 49: Exposure
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 50 VIVOTEK The inclusive window refers to the “weighed window“; the exclusive window refers to “ignored window“. It adopts the weighed averages method to calculate the value. The inclusive windows have a higher priority. You can overlap these windows, and, if you place an exclusive window within a larger inclusive window, the exclusive part of the overlapped windows will be deducted from the inclusive window.
Page 51 VIVOTEK ■ AE Speed Adjustment: This function (Automatic Exposure) 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 52 VIVOTEK Privacy mask Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to address privacy concerns. 2010/12/09 17:08:56 ■ To configure privacy mask windows, 1. Click New to add a new window.
Page 53: Media > Video
VIVOTEK Media > Video This Network Camera supports multiple streams with frame sizes ranging from 176 x 144 to 1920 x 1080 pixels. The definition of multiple streams: ■ Stream 1: Users can define the "Region of Interest" (viewing region) and the "Output Frame Size" (size of the live view window).
Page 54: Media > Video
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 55 VIVOTEK Click the stream item to display the detailed information. The maximum frame size will follow your settings in the above Viewing Window sections. This Network Camera offers real-time H.264 and MJPEG compression standards (Dual Codec) for real- time viewing. If the H.264...
Page 56 VIVOTEK The frame rate will decrease if you select a higher resolution. ■ Intra frame period Determine how often for firmware to plant an I frame. The shorter the duration, the more likely you will get better video quality, but at the cost of higher network bandwidth consumption. Select the intra frame period from the following durations: 1/4 second, 1/2 second, 1 second, 2 seconds, 3 seconds, and 4 seconds.
Page 57 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 58 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 59 VIVOTEK ■ B it rate control Constrained bit rate: A complex scene generally produces a larger file size, meaning that higher bandwidth will be needed for data transmission. The bandwidth utilization is configurable to match a selected level, resulting in mutable video quality performance. The bit rates are selectable...
Page 60 VIVOTEK If the JPEG mode is selected, the Network Camera sends consecutive JPEG images to the client, producing a moving effect similar to a filmstrip. Every single JPEG image transmitted guarantees the same image quality, which in turn comes at the expense of variable bandwidth usage. Because the media contents are a combination of JPEG images, no audio data is transmitted to the client.
Page 61: Media > Audio
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.
Page 62: Network > General Settings
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 14 for details.
Page 63 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 64 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 65 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? networking technology provides automatic IP configuration and dynamic discovery of devices UPnP added to a network.
Page 66 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 Internet Explorer 6.5, Mozilla Firefox 3.0 or above. ® browser should be Microsoft When IPv6 is enabled, by default, the network camera will listen to router advertisements and be assigned with a link-local IPv6 address accordingly.
Page 67 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.
Page 68 VIVOTEK 68 - User's Manual...
Page 69: Network > Streaming Protocols
VIVOTEK Network > Streaming protocols HTTP 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 80 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 70 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 71 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 potential risks of it being intercepted.
Page 72 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 73 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. This service will examine if the host name is valid and automatically open a port on your router.
Page 74 DDNS: Dynamic domain name service Enable DDNS: Select this option to enable the DDNS setting. Provider: Select a DDNS provider from the provider drop-down list. VIVOTEK offers Safe100.net, a free dynamic domain name service, to VIVOTEK customers. It is recommended that you register Safe100.net to access VIVOTEK’s Network Cameras from the Internet.
Page 75 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 76 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 77: Application 77
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.
Page 78: Network > Snmp (Simple Network Management Protocol)
VIVOTEK Network > SNMP (Simple Network Management Protocol) This section explains how to use the SNMP on the network camera. The Simple Network Management Protocol is an application layer protocol that facilitates the exchange of management information between network devices. It helps network administrators to remotely manage network devices and find, solve network problems with ease.
Page 79: Network > Ftp
FTP function. FTP port: The FTP server allows the user to save recorded video clips. You can utilize VIVOTEK's Installation Wizard 2 to upgrade the firmware via FTP server. By default, the FTP port is set to 21. It can also be assigned to another port number between 1025 and 65535.
Page 80: Security > User Accounts
VIVOTEK Security > User accounts This section explains how to enable password protection and create multiple accounts. Root Password The administrator account name is “root”, which is permanent and can not be deleted. If you want to add more accounts in the Manage User column, please apply the password for the “root” account first.
Page 81: Security > Https (Hypertext Transfer Protocol Over Ssl)
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 82 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 re- turn to the main page. Change the URL address from “http://” to “https://“ in the address bar and press Enter on your keyboard.
Page 83 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 84 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 85 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 86 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. 86 - User's Manual...
Page 87 VIVOTEK Note that a 11. When the certifice file is successfully loaded, its status will be stated as Active. certificate must have been created and installed before you can click on the “Save" button for the configuration to take effect.
Page 88: Security > Access List
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 89 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 90 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 91 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 92 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).
Page 93: Ptz > Ptz Settings
VIVOTEK PTZ > PTZ settings This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation. Digital: Control the e-PTZ operation. Within a field of view,it allows users to quickly move the focus to a target area for close-up viewing without physically moving the camera.
Page 94 VIVOTEK Home page in the E-PTZ Mode X2.1 ■ 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 95 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 96 VIVOTEK NOTE: ► The Preset Positions will also be displayed on the Home page Select one from the Go to menu, and the Network Camera will move to the selected preset position ► Click Patrol: The Network Camera will patrol along the selected positions repeatedly...
Page 97: Event > Event Settings
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 98 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 99 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 100 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. 100 - User's Manual...
Page 101 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 to open the server setting window.
Page 102 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 103 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 104 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 122 for details. Note that only one NAS server can be configured. Click Save server to enable the settings.
Page 105 VIVOTEK Click 20170120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2017/01/20 2017/01/20 Click to go back to the previous Click to delete level of the directory selected items Click to delete all...
Page 106 VIVOTEK Add media Click Add media to open the media setting window. You can specify the type of media that will be sent when a trigger is activated. A total of 5 media settings can be configured. There are three choices of media types available: Snapshot, Video Clip, and System log.
Page 107 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_20170513_100341 File name preﬁx Date and time sufﬁx The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings.
Page 108 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 109 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 110 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. 20170213...
Page 111: Applications > Motion Detection
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 112 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 97.
Page 113 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 98 for detailed information. NOTE: ►...
Page 114: Applications > Tampering Detection
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.
Page 115: Applications > Audio Detection
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 116 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.
Page 117: Applications > Package Management - A.k.a., Vadp (Vivotek Application Development Platform)
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. 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 118 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 119 VIVOTEK On the License page, use the Manual mehtod to register and activate the license for using VIVOTEK's VADP modules. You should acquire the license key elsewhere, and manually upload to the network camera. Follow the onscreen instruction on VIVOTEK's website for the registration procedure.
Page 120: Recording > Recording Settings
VIVOTEK Recording > Recording settings This section explains how to configure the recording settings for the Network Camera. Recording Settings Recording Settings Click Add to open the recording setting window. On this page, you can define the adaptive recording, recording source, recording schedule, and recording capacity. A total of 2 recording settings can be configured.
Page 121 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 122 VIVOTEK 2. Destination You can select a 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 configure: 1.
Page 123 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 124 VIVOTEK Event f you want to enable recording notification, please click to configure event triggering settings. Please refer to Event > Event settings on page 97 for more details. When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page.
Page 125: Appendix
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 126 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.
Page 127 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 128 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 128 - User's Manual...
Page 129 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 130 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.
Page 131 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.
Page 132 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 133 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 134 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 135 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 136 VIVOTEK format:<MODEL-BRAND-VERSION> language_count <positive integer> Number of webpage languages available on the server. language_i<0~(count-1)> string[16] Available language lists. language_i0 : English language_i1 : Deutsch language_i2 : Español language_i3 : Français language_i4 : Italiano language_i5 : 日本語 language_i6 : Português language_i7 : 简体...
Page 137 VIVOTEK 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 138 VIVOTEK 7.5security Group: security NAME VALUE SECURITY DESCRIPTION (get/set) privilege_do view, operator, Indicate which privileges and above can admin control digital output (capability.ndo > 0) privilege_camctrl view, operator, Indicate which privileges and above can admin control PTZ (capability.ptzenabled > 0 or capability.eptz >...
Page 139 VIVOTEK 7.6network 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 140 VIVOTEK dns2 <ip address> Secondary DNS server. wins1 <ip address> Primary WINS server. wins2 <ip address> Secondary WINS server. 7.6.1 802.1x Subgroup of network: ieee8021x (capability.protocol.ieee8021x > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable IEEE 802.1x eapmethod eap-peap, eap-tls...
Page 141 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 142 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 143 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 144 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 145 VIVOTEK 7.6.10 PPPoE Subgroup of network: pppoe (capability.protocol.pppoe > 0) NAME VALUE SECURITY DESCRIPTION (get/set) user string[128] PPPoE account user name. pass password[64] PPPoE account password. 7.7IP Filter Group: ipfilter NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable access list filtering.
Page 146 VIVOTEK 7.8Video input Group: videoin NAME VALUE SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 CMOS frequency. (capability.videoin.type=2) whitebalance auto, Modes of white balance. <product dependent> manual, "auto": Auto white balance rbgain, "rbgain": Use rgain and bgain to set white widerange, balance manually.
Page 147 VIVOTEK 7: EV +0.3 8: EV +0.7 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.0 irismode fixed, indoor, Control DC-Iris mode. outdoor "outdoor": Auto-setting DC-Iris to get best <product quality, but easy to meet rolling or flicker effect independent>...
Page 148 VIVOTEK 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. imprinttimestamp <boolean> Overlay time stamp on video. minexposure <1~32000>, Minimum exposure time <product dependent> <5~32000>, 1~32000 =>...
Page 149 VIVOTEK "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. 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"...
Page 150 VIVOTEK ode" !="-" rgain 0~100 Manual set rgain value of gain control setting. 0: Weak <-> 100: Strong * 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.
Page 151 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 152 VIVOTEK "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 ortype" is "smartsensor"...
Page 153 VIVOTEK * 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 154 VIVOTEK 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 155 VIVOTEK 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. Ex: If this is set to 1/5s...
Page 156 VIVOTEK * 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. crop_position <coordinate> Crop left-top corner coordinate. (x,y) crop_size <window size>...
Page 157 VIVOTEK or greater than 0301c. s<0~(m-1)>_h 250, 500, 1000, 2000, 3000, 4000 The time interval between two 264_intraperiod I-frames (Intra coded picture). The unit is millisecond (ms). s<0~(m-1)>_h cbr, vbr cbr: Constant bit rate mode. 264_ratecontrol vbr: Fixed quality mode, all frames are mode encoded in the same quality.
Page 158 VIVOTEK * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~5, 100 Set the pre-defined quality level: 264_cbr_quant 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only available when "ratecontrolmode"= cbr. * Only available when "capability_smartstream_version"=2.
Page 159 VIVOTEK 4_maxframerate" s<0~(m-1)>_h Indicate H264 profiles 264_profile 0: baseline 1: main profile 2: high profile s<0~(m-1)>_h <boolean> Enable "Dynamic intra frame period". 265_dintraperio * Only available when d_enable "capability_videoin_c<0~(n-1)>_dint raperiod_support" is 1 and h265 is listed in "capability_videoin_codec". * We support this parameter when the version number (httpversion) is equal or greater than 0301c.
Page 160 VIVOTEK 265_qvalue value which is used by encoded library directly. * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= vbr and s<0~(m-1)>_h265_quant = s<0~(m-1)>_h 1~100 Select customized quality in a 265_qpercent normalized full range. 1: Worst quality...
Page 161 VIVOTEK "capability_smartstream_version"="2 .0" s<0~(m-1)>_h 1~100 Select customized quality in a 265_cbr_qperce normalized full range. 1: Worst quality 100: Best quality * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= cbr and "quant"= 100. * Only available when "capability_smartstream_version"="2...
Page 162 VIVOTEK * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_m cbr, vbr cbr: Constant bit rate mode. jpeg_ratecontro vbr: Fixed quality mode, all frames are lmode encoded in the same quality. s<0~(m-1)>_m 1~5, * Only valid when "ratecontrolmode"= jpeg_quant 99, 100 vbr.
Page 163 VIVOTEK frames will be dropped to restrict the bit rate. * Only valid when "ratecontrolmode"= s<0~(m-1)>_m 1~5, 100 Set the pre-defined quality level: jpeg_cbr_quant 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent"...
Page 164 VIVOTEK (n-1)>_resolution") are recorded in "capability_videoin_c<0~(n-1)>_mjp eg_maxframerate" wdrpro_mode <boolean> Enable WDR pro <product 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.
Page 165 VIVOTEK executing. * Only available when "capability_image_c<0~(n-1)>_aesp eed" is 1 aespeed_sensiti 1~100 The sensitivity of AE converge speed. 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)
Page 166 VIVOTEK <product <product dependent> mount type. dependent> (videoin_c<0~(n-1)>_mounttype) Supported mode list could be extracted from (capability_videoin_c<0~(n-1)>_local dewarp_typeceilingmount) and (capability_videoin_c<0~(n-1)>_local dewarp_typewallmount) * Only available when "capability_fisheyelocaldewarp_c<0~( capability_nvideoin)-1>" > 0 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 "...
Page 167 VIVOTEK quality difference between the ROI and non-ROI areas. If the value is a negative number, the video quality of non-ROI areas is better than the ROI. The level is from -1 to -5. Level -5 is the maximum level of the quality difference between the ROI and non-ROI areas.
Page 168 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 169 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 170 "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. * We support this parameter when the version number (httpversion) is equal or greater than...
Page 171 VIVOTEK 0302a. whitebalance auto, Modes of white balance. <product dependent> manual, "auto": Auto white balance rbgain, "rbgain": Use rgain and bgain to set white widerange, balance manually. outdoor, "manual": 2 cases: indoor, a. if "rbgain" is not supported, this means sodiumauto, keep current white balance status.
Page 172 VIVOTEK 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_maxgain " != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposure_ra ngetype" is "twovalues". mingain 0~100 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_mingain...
Page 173 VIVOTEK "indoor": Avoid rolling and flicker effect first. "manual": Manual set P-Iris by "piris_position". "-": not support (only available when "capability_image_c<0~(n-1)>_sensortype" is "smartsensor") * Only available when "capability_image_c<0~(n-1)>_iristype"=piri piris_position 1~100 Manual set P-Iris. <product dependent> 1: Open <-> 100: Close * Only valid when "piris_mode"=manual or...
Page 174 VIVOTEK "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" is 1 aespeed_mode <boolean> Turning AE converge speed on or off. ...
Page 175 VIVOTEK <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" (capability.timeshift > 0) NAME VALUE SECURITY DESCRIPTION...
Page 176 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 177 VIVOTEK 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" and m denotes the value of "capability_nvideoinprofile"...
Page 178 VIVOTEK 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" is 1. * We replace "saturation" with "saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 179 * 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 180 VIVOTEK "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". eis_strength 1~100 Strength of electronic image stabilizer <product dependent>...
Page 181 VIVOTEK * Only available when "capability_image_c<0~(n-1)>_freeze" is 1 profile_i<0~(m-1)>_enable <boolean> Enable/disable this profile setting profile_i<0~(m-1)>_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 182 VIVOTEK * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicsetting" is 1. * We replace "profile_i0_saturation" with "profile_i0_saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. profile_i<0~(m-1)>_sharpness -3~3,100 -5: Less saturation <-> 5: More saturation <Not recommended to use this>...
Page 183 * Only available when bit 3 of "capability_image_c<0~(n-1)>_basicsetting" is 1 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 184 VIVOTEK ength * Only available when <product dependent> "capability_image_c<0~(n-1)>_defog_mode" is 1 profile_i<0~(m-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". profile_i<0~(m-1)>_eis_streng 1~100 Strength of electronic image stabilizer * Only available when 'eis' is listed in <product dependent>...
Page 185 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 186 VIVOTEK 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 187 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 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 188 VIVOTEK * Only available when std is listed in "capability_image_c<0~(n-1)>_exposure_wi ndomain". 7.13 Audio input per channel Group: audioin_c<0~(n-1)> for n channel products (capability.naudioin>0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) source micin, linein micin => use built-in microphone input.
Page 189 VIVOTEK 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 gain 0~100 Gain of input. <Not recommended to use (audioin_c<0~(n-1)>_source = linein)
Page 190 VIVOTEK 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 pcma: A-law algorithm * Only available if G.711 is supported.
Page 191 VIVOTEK version number (httpversion) is equal or greater than 0301a. profile_i0_begintime hh:mm Begin time of schedule mode. profile_i0_endtime hh:mm End time of schedule mode. profile_i0_alarm_level 1~100 Audio detection alarm level 7.14 Motion detection settings Group: motion_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin"...
Page 192 VIVOTEK polygonpx 0 ~ W,0 ~ H, 0 ~ Coordinate of polygon window position. <Not recommended to use W,0 ~ H, 0 ~ W,0 ~ (4 points: x0,y0,x1,y1,x2,y2,x3,y3) this> H, 0 ~ W,0 ~ H * Only available when W: 0~ The current "capability_motion_wintype"...
Page 193 VIVOTEK "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. width 0 ~ 320 Width of motion detection window. <Not recommended to use * Only available when ...
Page 194 VIVOTEK begintime hh:mm Begin time of schedule mode. endtime hh:mm End time of schedule mode. win_sensitivity 0 ~ 100 Sensitivity of all motion detection windows. * The value "0" is reserved for compatibility and will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 195 VIVOTEK * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. polygon 0 ~ 320,0 ~ 240, 0 Coordinate of polygon window position. <Not recommended to use ~ 320,0 ~ 240, 0 ~ (4 points: x0,y0,x1,y1,x2,y2,x3,y3) this>...
Page 196 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. height 0 ~ 240 Height of motion detection window.
Page 197 VIVOTEK 7.15 Tampering detection settings Group: tampering_c<0~(n-1)> for n channel products (capability.tampering > 0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable tamper detection. threshold 0~100 Threshold of tamper detection. duration 10~600 If tampering value exceeds the "threshold"...
Page 198 VIVOTEK 7.16 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 199 VIVOTEK service. 7.19 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.20 System log...
Page 200 (get/set) logo_default <boolean> 0 => Custom logo 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 200 - User's Manual...
Page 201 VIVOTEK custombutton_manualtrig <boolean> Show or hide manual trigger (VI) button in ger_show homepage 0 -> Hidden 1 -> Visible theme_option 1~3: One of the default themes. 4: Custom definition. theme_color_font string[7] Font color theme_color_configfont string[7] Font color of configuration area.
Page 202 VIVOTEK "capability_image_c<0~(n-1)>_privacymask _wintype" = rectangle. win_i<0~(m-1)>_height 0 ~ 240 Height of privacy mask window. * Only available when "capability_image_c<0~(n-1)>_privacymask _wintype" = rectangle. win_i<0~(m-1)>_polygo 0 ~ 320,0 ~ 240, Coordinate of polygon window position. 0 ~ 320,0 ~ 240, (4 points: x0,y0,x1,y1,x2,y2,x3,y3)
Page 203 VIVOTEK 7.24 3D Privacy mask Group: privacymask3d_c<0~(n-1)> for n channel products and m privacy mask window. (capability_image_c<0~(n-1)>_privacymask_wintype = 3Drectangle) 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 the 3D privacy mask color 0~"...
Page 204 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 205 VIVOTEK document. The 5th character is model-based version for API bug-fix and it's default to "a". Ex: If some APIs in a model does not follow the API definition of 0301a_1, we will fix them and change this API value to 0301b_1.
Page 206 VIVOTEK More details, please refer the parameter description of "volume_internal" and "volume_external". nuart Number of UART interfaces. <positive integer> nmotion <positive integer> The number of motion window. nmotionprofile 0, <positive Number of motion profiles. integer> ptzenabled 0, <positive An 32-bit integer, each bit can be set integer>...
Page 207 VIVOTEK it means that the camera supports remotefocus function. bit 0 => Indicate whether to support both zoom and focus function. bit 1 => Only support zoom function. bit 2 => Only support focus function. bit 3 => Currently, this is a reserved bit, and the default value is 0.
Page 208 VIVOTEK channel support ePTZ or not, and so on. * For most products, the last stream of a channel will not support ePTZ. It is reserved for full view of the channel. For some dual-stream products, both streams support ePTZ.
Page 209 VIVOTEK "visignal" = Video input signal loss. "backup" = Backing up recorded files "smartsd" = Lifetime detection of SD card "shockalarm" = Shock detection * Only available when [httpversion] >= 0301a storage_dbenabled <boolean> Media files are indexed in database. protocol_https <...
Page 210 VIVOTEK videoin_resolution A list of <WxH> This equals <product "capability_videoin_c0_resolution". dependent> * This is kept for compatibility. videoin_maxframerate A list of <Integer> This equals "capability_videoin_c0_maxframerate". * This is kept for compatibility. videoin_mjpeg_maxframe A list of <Integer> This equals rate and "-"...
Page 211 VIVOTEK "nvideoout"=0, "videoout_codec"=- "nvideoout"=1 with NTSC, "videoout_codec"=ntsc "nvideoout"=1 with PAL, "videoout_codec"=pal "nvideoout"=2 with both NTSC, "videoout_codec"=ntsc,ntsc * For camera, this feature is controlled by physical jump on device. No WebAPI to control it. This value is set only on camera power-on and maintains the status.
Page 212: Technical Specifications
VIVOTEK * It will be replaced by audio_intmic and audio_extmic. audio_lineout <boolean> Indicate whether to support line output. audio_michardwareswitch <boolean> Indicate whether the hardware supports built-in/external mic switch audio_headphoneout <boolean> Indicate whether to support headphone <Not support anymore> output. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.
Page 213: Technology License Notice
VIVOTEK image. px: Locate a window in the image with pixels. std: A normalized 0~9999 range. -: Not supported. *only available when "capability_smartstream_support" is 1 smartstream_mode_autot <boolean> Indicate whether autotracking smart stream is racking supported. *only available when "capability_smartstream_support" is 1 smartstream_mode_man <boolean>...
Page 214: Electromagnetic Compatibility (Emc)
VIVOTEK Bit 4 => Support event trigger Bit 5 => Support license registration Bit 6 => Support shared memory API Bit 7 => Support digital signature of package Bit 8 => Support snapshot vadp_npackage <positive integer> Indicate the maximum number of VADP package that can be uploaded to the device.
Page 215 VIVOTEK *only available when "capability_network_wireless" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0305a. wireless_s802dot11b <boolean> Indicate whether to support wireless 802.11b+. wireless_s802dot11g <boolean> Indicate whether to support wireless 802.11g. wireless_s802dot11n <boolean>...
Page 216 VIVOTEK version_onvifdaemon <string> Indicate ONVIF daemon version version_onviftesttool <string> Indicate ONVIF test tool version media_totalspace <positive integer> Available memory space (KB) for media. media_snapshot_maxpre <positive integer> Maximum snapshot number before event event occurred. media_snapshot_maxpost <positive integer> Maximum snapshot number after event event occurred.
Page 217 VIVOTEK localstorage_stormgrversi <string> Indicate storage manager daemon version 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.
Page 218 VIVOTEK privilege <boolean> Indicate whether to support “Manage Privilege” of PTZ control in the security page in this video input. 1: support both /cgi-bin/camctrl/camctrl.cgi and /cgi-bin/viewer/camctrl.cgi 0: support only /cgi-bin/viewer/camctrl.cgi rs485 <boolean> An 32-bit integer, each bit can be set separately as follows: Bit 0 =>...
Page 219 VIVOTEK focusmode auto,onetimeauto,spo Focus mode selection: tlight,manual "auto": Camera will automatically adjust the <product dependent> focus position full time to adapt a clear picture. "onetimeauto": Camera will automatically adjust the focus position one time, which follows any PTZ control. "spotlight": Camera will automatically adjust the focus position full time, and to consider a spotlight avoidance situation.
Page 220 VIVOTEK maxpanangle <integer> The upper limit for pan angle. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" tiltspeedlv 0, <positive integer> 0/7 The maximum speed level of tilt motion. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" mintilt 0, <positive integer> 0/7 The lower limit for tilt position.
Page 221 VIVOTEK focusspeedlv 0, <positive integer> 0/7 The maximum speed level of focus motion. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule" is "1" minfocus 0, <positive integer> 0/7 The lower limit for focus position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule"...
Page 222 VIVOTEK ircutsensitivity_type <string> Indicate the cgi interface of "ircutcontrol_sensitivity". "options": the value of "ircutcontrol_sensitivity" parameter is "low, normal,high". "normalize": the value of "ircutcontrol_sensitivity" parameter is "1~100" "-":not support * Only available when "capability_daynight_c<0~(n-1)>_support" is * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 223 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, motor, - fixed: Build‐in fixed‐focus lens. <product dependent> varifocal: Build‐in varifocal lens. changeable: changeable lens. Like box‐type camera, users can install any C‐Mount or CS‐Mount lens as they wish. motor: Lens with motor to support zoom, focus, etc. ‐: N/A * Only available when [httpversion] >= 0301a rotation <boolean>...
Page 224 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 225 VIVOTEK streamcodec <positive integer> Represent supported codec types of each stream. This contains a list of positive integers, split by comma. Each one stands for a stream, and the definition is as following: Bit 0: Support MPEG4. Bit 1: Support MJPEG Bit 2: Support H.264...
Page 226 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 227 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 228 VIVOTEK fisheye_mounttype ceiling, wall, floor Indicate the supported type. <product dependent> <product dependent> wall mount: 180° panoramic view ceiling mount: 360° surround view without blind spots floor mount: 360° surround view without blind spots Only available when "capability_fisheye" > 0 dintraperiod_support <boolean>...
Page 229 VIVOTEK resolutionC4R A list of <WxH> Available resolutions of 4R mode of ceiling and floor mount. resolutionW1P A list of <WxH> Available resolutions of 1P mode of wall mount. resolutionW1R A list of <WxH> Available resolutions of 1R mode of wall mount.
Page 230 VIVOTEK wdrpro 0, 1, 2 Indicate this mode whether support WDR pro. 0: Non-support WDR Pro 1: Support WDR Pro 2: Support WDR Pro and WDR Pro II * We support this parameter when the version number (httpversion) is equal or greater than 0304b.
Page 231 VIVOTEK resolution A list of <WxH> Resolution options in this video mode. The last one is the maximum resolution in this video mode. * The element number is defined as "nresolution" in this group. maxresolution A list of <Integer> Represent supported maximum resolution of each stream in current video mode.
Page 232 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 233 VIVOTEK wdrpro_strength 0, 1 0: Non-support tuning strength of WDR Pro 1: Support tuning strength of WDR Pro * If "capability_image_c<0~(n-1)>_wdrp ro"=1, this may be either 0 or 1. wdrpro_supportlevel 0, <positive integer> This contains a list of positive integers, split by comma.
Page 234 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 235 VIVOTEK <x>: nonnegative integer - (hidden) : UI is hidden. <product dependent> - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked.
Page 236 VIVOTEK or greater than 0302a. is_strength <boolean> 0: Non-support tuning strength of image stabilizer mode. 1: Support tuning strength of image stabilizer mode. * Only available when "capability_image_c<0~(n-1)>_is_m ode" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 237 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 238 VIVOTEK name":"Policy":"Description" <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 239 VIVOTEK 3dnr:unchanged:, or others The format is "Affect API name":"Policy":"Description" <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.
Page 240 VIVOTEK <product dependent> mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here. 3dnr:unchanged:, or others The format is "Affect API name":"Policy":"Description" <x>: nonnegative integer <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it.
Page 241 VIVOTEK scenemode_lpcstreet_aff When scene mode is enabled, some minexposure:hidden:, features may become malfunction or <product dependent> mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here. 3dnr:unchanged:,or others The format is "Affect API <x>: nonnegative integer name":"Policy":"Description"...
Page 242 VIVOTEK "capability_image_c<0~(n-1)>_ scenemode_support" is 1 wbmode auto, Available white balance mode. manual, "-" means white balance is not rbgain, supported. widerange, outdoor,indoor, sodiumauto, <product dependent> iristype piris, Indicate iris type. dciris, "piris": P-Iris ...
Page 243 VIVOTEK exposure_shuttervaluetyp fixed, * One to one mapping to the mode maximum, type in "exposure_modetype". "fixed": The shutter value is the assigned value (videoin_c<0~(n-1)>_shuttervalue). "maximum": The shutter value can be up to the assigned value (videoin_c<0~(n-1)>_shuttervalue). "-": not support. * Only available when "capability_image_c<0~(n-1)>_expo...
Page 244 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 245 VIVOTEK en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here. exposurelevel:hidden:, or others The format is "Affect API name":"Policy":"Description" <x>: nonnegative integer <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it.
Page 246 VIVOTEK "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_irisprioritymod When exposure iris priority mode is e_affect exposurewin.mode.blc:hidd enabled, some features may become en:, malfunction or be forced to a given defog:disabled:, value.
Page 247 VIVOTEK integer or string or NULL. "-" means no feature is affected. * Only available when irispriority is listed in "capability_image_c<0~(n-1)>_ exposure_modetype" and "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 248 VIVOTEK which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected.
Page 249 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 250 VIVOTEK or others features may become malfunction or be forced to a given value. The <x>: nonnegative integer affected functions are list here. <product 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.
Page 251 VIVOTEK exposure_winmode" is hlc. * We support this parameter when the version number (httpversion) is equal or greater than 0304a. exposure_wintype inclusive, The supported exposure window type. exclusive, inclusive: The image inside a window is the target area of exposure control.
Page 252 VIVOTEK * When "exposure_mode"=0, this value must be set to "-". exposure_minrange "1,32000", Available range for "1,8000", "videoin_c<n>_minexposure" "1,32000" => 1s ~ 1/32000s or others "1,8000" => 1s ~ 1/8000s <product dependent> etc. "-" means minimum exposure time is not available.
Page 253 VIVOTEK flickerlessaffect When flickerless is enabled, some minexposure:hidden:, features may become malfunction or mingain:hidden:, be forced to a given value. The or others affected functions are list here. <x>: nonnegative integer The format is "Affect API <product dependent> name":"Policy":"Description" "Policy" can be categorized into...
Page 254 VIVOTEK 1: Support defog defog_strength 0, 1 0: Non-support tuning strength of defog 1: Support tuning strength of defog * If "capability_image_c<0~(n-1)>_defog _mode"=1, this may be either 0 or 1. defog_supportlevel 0, <positive integer> The value indicate the support strength level of defog.
Page 255 VIVOTEK well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * When "defog" = 0, this value must be "-" aespeed...
Page 256 VIVOTEK bit 0 => Indicate whether to support both zoom and focus function. bit 1 => Only support zoom function. bit 2 => Only support focus function. bit 3 => Currently, this is a reserved bit, and the default value is 0.
Page 257 VIVOTEK ortype" is "smartsensor" Group: capability_peripheral_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) devicecontrol <boolean> Indicate whether to support the peripheral device control. * We support this parameter when the version number (httpversion) is equal or greater than 0305c.
Page 258 VIVOTEK 7.27 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 259 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 260 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 261 VIVOTEK action_custom<0~2>_nam string[32] Indicate the name for this custom action. <product dependent> action_goto_enable <boolean> Enable/disable ptz goto preset position on event <product dependent> triggered. * Only available when capability_ptzenabled > action_goto_name string[40] Specify the preset name that ptz goto on event <product dependent>...
Page 262 VIVOTEK ftp_location string[128] Location to upload or store the media. ftp_passive <boolean> Enable or disable passive mode. 0 = disable passive mode 1 = enable passive mode email_address string[128] Email server address. email_sslmode <boolean> Enable support SSL. email_port 0~65535 Port to connect to the server.
Page 263 VIVOTEK snapshot_datesuffix 0, 1 Add date and time suffix to filename: 1 = Add date and time suffix. 0 = Do not add. snapshot_preevent 0~" Indicates the number of pre-event capability_media_snapshot_maxpr images. eevent" snapshot_postevent 0~" Indicates the number of post-event capability_media_snapshot_maxpo images.
Page 264 VIVOTEK 7.30 Recording Group: recording_i<0~1> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. trigger schedule, The event trigger type networkfail schedule: The event is triggered by schedule networkfail: The event is triggered by the failure of network connection.
Page 265 VIVOTEK notifyserver 0~31 Indicate which notification server is scheduled. One bit represents one application server (server_i0~i4). bit0 (LSB) = server_i0. bit1 = server_i1. bit2 = server_i2. bit3 = server_i3. bit4 = server_i4. For example, enable server_i0, server_i2, and server_i4 as notification servers; the notifyserver value is 21.
Page 266 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. 266 - User's Manual...
Page 267 VIVOTEK commonname string[64] Common name in the certificate information. www.vivotek.com validdays 0 ~ 3650 Valid period for the certification. 7.32 Storage management setting Group: disk_i<0~(n-1)> n is the total number of storage devices. (capability.storage.dbenabled > 0) Currently it’s only for local storage (SD, CF card), so n is equal to 1.
Page 268 VIVOTEK 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. maxretentiontime_recordin <string> To specify the expired time for automatic clean g_i <0~1>_maxage up, and it only takes effect for video clip generated by recording_i <0~1>.
Page 269 VIVOTEK 7.33 Region of interest Group: roi_c<0~(n-1)> for n channel product and m is the index of video stream which support ePTZ. (capability.eptz > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-1)>_home <W,H> ROI left-top corner coordinate.* If the minimal <product dependent>...
Page 270 VIVOTEK 7.34 ePTZ setting Group: eptz_c<0~(n-1)> for n channel product. (capability.eptz > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) osdzoom <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 271 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) PARAMETER VALUE SECURITY DESCRIPTION (get/set) patrolseq string[120] The patrol sequence of ePTZ. All the patrol position indexes will be separated by ","...
Page 272 (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.37 VIVOTEK Application Development Platformsetting Group: vadp NAME VALUE SECURITY DESCRIPTION (get/set) version <string> Indicate the VADP version.
Page 273 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 274 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 275 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.39 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 276 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 277 VIVOTEK >_maxfocus digitalzoom <boolean> Enable/disable digital zoom zoomenhance <boolean> Enable /disable zoom enhancement 7.40 camera PTZ control (SD series) Group: camctrl_c<0~(n-1)> for n channel products (the bit7 of capability_ptzenabled is 0 and the bit4 of capability_ptzenabled is 1) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset"...
Page 278 VIVOTEK >_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 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) >_maxzoom preset_i<0~(k-1)>_focus capability_ptz_c<0~(n-1) Focus position at each preset location. >_minfocus ~ capability_ptz_c<0~(n-1) >_maxfocus preset_i<0~(k-1)>_focus sync,...
Page 279 VIVOTEK axisf capability_ptz_c<0~(n-1) Custom home focus position. >_minfocus ~ capability_ptz_c<0~(n-1) >_maxfocus axisflip <boolean> Custom home flip side. returnhome <boolean> Enable/disable return home while idle. returnhomeinterval 1~999 While idle over this time interval, idle action will be taken. digitalzoom <boolean> Enable/disable digital zoom idleaction_enable <boolean>...
Page 280 VIVOTEK 7.41 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 281 VIVOTEK 7.42 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 282 VIVOTEK 7.43 Lens configuration Group: lens for n channel products n denotes the value of "capability_nvideoin" (capability.image.c<0~(n-1)>.lensconfiguration.support = 1) NAME VALUE SECURITY DESCRIPTION (get/set) selected <string> Current selected lens profile. e.g. lens_selected=lens_default_i0, it means choosen lens configuration is i0 lens of default group.
Page 283 VIVOTEK 7.44 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.45 Fisheye local dewarp setting Group: fisheyedewarp_c<0~(n-1)> (capability_fisheyelocaldewarp_c<0~(n-1)> > 0) ...
Page 284 VIVOTEK 7.46 PIR behavior define Group: pir (capability.npir > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable PIR 7.47 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.
Page 285 VIVOTEK 7.48 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 286 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 287 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 288 VIVOTEK Example: Query the status of digital input 1 . Request: http://myserver/cgi-bin/dido/getdi.cgi?di1 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n di1=1\r\n 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]...
Page 289 VIVOTEK \r\n do1=1\r\n 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 DEFA DESCRIPTION...
Page 290 VIVOTEK Account Management Note: This request requires Administrator privileges. Method: GET/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 291 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 292 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 293 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 294 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 295 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 296 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 297 VIVOTEK 8.12 IP Filtering for ONVIF Syntax:<product dependent> http://<servername>/cgi-bin/admin/ipfilter.cgi?type[=<value>] http://<servername>/cgi-bin/admin/ipfilter.cgi?method=add<v4/v6>&ip=<ipaddress>[&index=<value>][&ret urn=<return page>] http://<servername>/cgi-bin/admin/ipfilter.cgi?method=del<v4/v6>&index=<value>[&return=<return page>] PARAMETER VALUE DESCRIPTION type NULL Get IP filter type allow, deny Set IP filter type method addv4 Add IPv4 address into access list. addv6 Add IPv6 address into access list.
Page 298 VIVOTEK 8.13 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 299 VIVOTEK 8.14 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 300 VIVOTEK 8.15 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 301 VIVOTEK 8.17 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 302 VIVOTEK 8.18 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 303 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 304 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 305 VIVOTEK 8.19 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 306 VIVOTEK Request 2 will not be accepted during the execution time(15 seconds). 8.20 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 307 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 - 307...
Page 308 VIVOTEK 308 - User's Manual...
Page 309 VIVOTEK 8.21 RemoteFocus (capability_image_c<0~(n-1)>_remotefocus=1) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/remotefocus.cgi?function=<value>[&direction=<value>] [&position=<value>][&steps=<value>][&iris] PARAMETER VALUE DESCRIPTION User's Manual - 309...
Page 310 VIVOTEK function zoom, Function type focus, zoom - Move focus motor auto, focus – Move focus motor scan, auto – Perform auto focus stop, scan – Perform focus scan positioning, stop – Stop current operation getstatus positioning – Position the motors getstatus–Information of motors, return value as below:...
Page 311 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" iris Open iris or not. It works only if function=auto | scan.
Page 312 VIVOTEK 8.22 BackFocus (capability_image_c<0~(n-1)>_remotefocus=4) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/remotefocus.cgi?function=<value>[&direction=<value>] [&position=<value>][&steps=<value>][&iris] PARAMETER VALUE DESCRIPTION 312 - User's Manual...
Page 313 VIVOTEK function focus, Function type auto, focus – Move focus motor scan, auto – Perform auto focus stop, scan – Perform focus scan positioning, stop – Stop current operation irisopen, positioning – Position the motors irisenable, resetfocus – reset focus position to default resetfocus, irisopen –...
Page 314 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" iris Open iris or not. It works only if function=auto | scan. 8.23 Export Files Note: This request requires Administrator privileges.
Page 315 VIVOTEK 8.24 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 316 VIVOTEK 8.25 Update Lens Configuration 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> You need to reboot manually after you choose another lens configuration.
Page 317 VIVOTEK <multipart encoded form data> Server will accept the file named <file name> to upload the lens profile to camera. 8.26 Media on demand (capability.localstorage.modnum > 0) Media on demand allows users to select and receive/watch/listen to metadata/video/audio contents on demand.
Page 318 VIVOTEK 8.27 Fisheye local dewarp camera control (capability.fisheye > 0 and capability.fisheyelocaldewarp.c0 > 0, only support in 1R mode) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<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 319 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 320 VIVOTEK 8.28 3D Privacy Mask (capability_image_c<0~(n-1)>_privacymask_wintype = 3Drectangle) n denotes the value of "capability_nvideoin" Note: This request requires admin user privilege Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/setpm3d.cgi?method=<value>&name=<value>&[maskheight=<value>& maskwidth=<value>&videosize=<value>&return=<return page>] PARAMETER VALUE DESCRIPTION method Add a 3D privacy mask at current location delete...
Page 321 VIVOTEK 8.29 Camera Control (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET/POST Syntax: (for control API) http://<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 322 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 323 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 324 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 325 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 326 VIVOTEK 8.31 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 327 VIVOTEK 8.32 SmartSD (capability_localstorage_smartsd > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/smartsd.cgi?function=<value> PARAMETER VALUE DESCRIPTION User's Manual - 327...
Page 328 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 329 VIVOTEK 8.33 Connet 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.34 Get wireless information (capability_network_wireless > 0) Note: This request requires Administrator privileges.
Page 330 VIVOTEK 8.35 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.36 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 331 VIVOTEK http://myserver/cgi-bin/admin/peripheral.cgi?channel=0&operation=set&washer_mode=wiper& washer_status=on Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "washer_mode : OK\r\n" "washer_status : FAIL\r\n" PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. washer_mode wiper Apply the wiper to the mode of washer control system.
Page 332 VIVOTEK capability_peripheral_c<0~(n-1)>_heater_suppo rt=1 trigger heater component is work in force heater once. *Only available when capability_peripheral_c<0~(n-1)>_heater_suppo rt=1 Syntax: (for querying API) http://<servername>/cgi-bin/admin/peripheral.cgi?channel=<value>&operation=get [&supportdevice] –Get support peripheral device [&washer_supportmode] – Get washer support modes [&washer_mode] – Get washer mode [&washer_status] – Get washer status [&washer_dwelltime] –...
Page 333 VIVOTEK "capability_peripheral_c<0~(n-1)>_washer_mod e" washer_status Get the current status of washer control module. The status is 'off' as default, which means the washer is stopped; and the status 'on' means the washer is running. *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 washer_dwelltime Get the current washer clean period of washer control system.
Page 334 All specifications are subject to change without notice. Copyright © VIVOTEK INC. All rights reserved. Ver. 4 6F, No.192, Lien-Cheng Rd., Chung-Ho, New Taipei City, 235, Taiwan, R.O.C. | T: +886-2-82455282 | F: +886-2-82455532 | E: sales@vivotek.com | W: www.vivotek.com...
Page 335 VIVOTEK Technology License Notice H.264 THIS PRODUCT IS LICENSED UNDER THE AVC PATENT PORTFOLIO LICENSE FOR THE PERSONAL AND NON-COMMERCIAL USE OF A CONSUMER TO (i) ENCODE VIDEO IN COMPLIANCE WITH THE AVC STANDARD ("AVC VIDEO") AND/OR (ii) DECODE AVC VIDEO...
Page 336 取扱説明書に従って正しい取り扱いをして下さい 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.

Vivotek CC8160 User Manual

Quick Links

Need help?

Questions and answers

Related Manuals for Vivotek CC8160

Summary of Contents for Vivotek CC8160

Table of Contents