Vivotek TS6346-EHL User Manual
Vivotek TS6346-EHL User Manual

Vivotek TS6346-EHL User Manual

Speed dome network camera
Table of Contents

Advertisement

Quick Links

TS6346-EHL
User 's Manual
2MP • 20x/30x Zoom • 60fps • NEMA 4x • 150m IR
IP67 • Extreme Weatherproof
Speed Dome
Network Camera
Rev. 1.0

Advertisement

Table of Contents
loading

Summary of Contents for Vivotek TS6346-EHL

  • Page 1 TS6346-EHL Speed Dome Network Camera User ’s Manual 2MP • 20x/30x Zoom • 60fps • NEMA 4x • 150m IR IP67 • Extreme Weatherproof Rev. 1.0...
  • Page 2: Table Of Contents

    Applications > Motion detection......................123 Applications > DI and DO ........................126 Applications > Audio detection ......................127 Applications > VADP (VIVOTEK Application Development Platform) ..........129 Recording > Recording settings ......................132 Local storage > SD card management ....................137 Local storage > Content management ....................138...
  • Page 3 VIVOTEK Appendix  141 URL Commands for the Network Camera ......................141 Technical Specifications ............................. 327 Technology License Notice ..........................328 Electromagnetic Compatibility (EMC) ......................... 329 User's Manual - 3...
  • Page 4: Revision History

    Offering 1080p Full HD resolution and adopting a 30x optical zoom lens and purpose-designed VAIR (Vari-Angle IR), the TS6346-EHL is able to capture fine details at top-notch quality, no matter what time of day or night. Further strengthening this camera performance in the field, IP67- and NEMA 4X-rated housing protects the camera body against rain, dust and corrosion and allows for a wide operating temperature range of between -50°C and 55°C.
  • 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 ■ TS6346-EHL ■ Wall Mount Bracket / Screws ■ Screws / Alignment Sticker / T20 and T25 L-wrench ■ Quick Installation Guide ■...
  • Page 6: Physical Description

    VIVOTEK Physical Description Outer View SD card slot Lens IR LEDs Inner View Safety wire hook LAN connector I/O combo connector Alignment marks 6 - User's Manual...
  • Page 7 VIVOTEK Status LED Item LED status Description Steady Power on and system booting LED OFF Power off Steady & Green blinking every 1 sec. Network normal (heartbeat) Steady & Green LED OFF Network failed blinking every 0.15 sec. & Green...
  • Page 8 VIVOTEK DI/DO Diagram Switch Source External BJT transistor power source Relay External device Switch Source BJT transistor Relay External device 1. The DO+ pin provides 12V output voltage, and the max. load is 50mA. 2. The max. voltage for DO- pins is 80VDC (External power).
  • Page 9: Hardware Installation

    VIVOTEK Hardware Installation 1. Jot down the camera's MAC address for later reference. 2. The camera weighs 6kg. Select a rigid mounting location to prevent vibration to the camera. Attach the alignment sticker to the wall. 3. Drill 4 pilot holes (9.5mm in diameter and 4cm deep) into the wall, and then hammer in threaded anchors.
  • Page 10 VIVOTEK 5. Connect power or I/O wires, and use foam tapes or seal foam to ensure the back-end connection is waterproof. 6. Route your I/O combo and Ethernet cables along the routing guide poles to form drip loops. LAN I/O combo...
  • Page 11 VIVOTEK 7. Secure the bracket to wall. The cable length hanging on the outside of the bracket should be 15cm. 8. Remove the cable gland from the LAN port. If I/O wires or 48V power are preferred, use the T20 L-wrench to remove 15cm the top cover on the I/O connectors.
  • Page 12 VIVOTEK 9. Hook up the safety wire between the bracket and the camera. 10. Install the components of the waterproof cable gland to the Ethernet and I/O combo cables. Make sure the outer jacket of the combo cable is flush with the ca- bling hole.
  • Page 13 VIVOTEK 11. Connect the I/O wire headers to camera and then secure the top cover. 12. Connect the Ethernet cable (along with its cable gland) to the camera. NOTE: To disconnect a LAN cable, loosen the cable gland and pull the cable against the socket wall towards the side of the locking tab.
  • Page 14 VIVOTEK 13. Connect the included ground wire. An example is shown below using VIVOTEK’s AT-CAB cabinet. Connect the ground wire to the copper screw hole on the cabinet door. Camera ground wire 14 - User's Manual...
  • Page 15 VIVOTEK Connect all ground wires (including those from the surge protectors) to one position on the cabinet door, to the terminal block, and then to the external ground. External ground Ground AWG 8 User's Manual - 15...
  • Page 16 VIVOTEK 14. Install the camera to bracket by aligning the mark on bracket with the #1 marking on the cam- era. 15. Turn the camera clockwise. The camera should be locked in place. 16 - User's Manual...
  • Page 17 VIVOTEK 16. Secure the connection using the T25 L-wrench from the top. User's Manual - 17...
  • Page 18 VIVOTEK Pendant Mount The camera can also be mounted through a pendant mount combination as shown below. 3/4” The rest of the installation prcedure is the same as described above. AM-118 AM-116/117 AM-529 IMPORTANT: These devices(IR LED) emit highly concentrated infrared light, which view angle(range) is smoothly varied depending on operation mode.
  • Page 19 VIVOTEK Mechanical Dimensions Shown below are the dimensions of the wall mount bracket and its mounting holes: You can find the installation instructions on VIVOTEK’s website for other options such as para- pet mount: http://www.vivotek.com/web/product/accessories.aspx User's Manual - 19...
  • Page 20: Network Deployment

    VIVOTEK Network Deployment Setting up the Network Camera over the Internet There are several ways to set up the Network Camera over the Internet. The first way is to set up the Network Camera behind a router. The second way is to utilize a static...
  • Page 21 For more information with network configuration options (such as that of streaming ports), please refer to Configuration > Network Settings. VIVOTEK also provides the automatic port forwarding feature as an NAT traversal function with the precondition that your router must support the UPnP port forwarding feature.
  • Page 22 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 on page 69 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. Please refer to PPPoE on page 70 for details.
  • Page 23: 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 prompt. Double-click on the MAC and model name which matches the product label on your device to connect to the Network Camera via a web browser.
  • Page 24: Ready To Use

    CD in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents. TS6346-EHL IMPORTANT: • Currently the Network Camera utilizes a 32-bit ActiveX plugin You CAN NOT open a management/view session with the camera using a 64-bit IE browser •...
  • Page 25: Accessing The Network Camera 25

    3. Live video will display in your web browser. 4. If it is the first time installing the VIVOTEK network camera, an information bar will pop up as shown below. Follow the instructions to install the required plug-in on your computer.
  • Page 26 VIVOTEK ► By default, the Network Camera is not password-protected. To prevent unauthorized access, it is highly recommended to set a password for the Network Camera. For more information about how to enable password protection, please refer to Security on page 87.
  • Page 27: Using Rtsp Players

    VIVOTEK Using RTSP Players To view the H.265/H.264 streaming media using RTSP players, you can use one of the following players that support RTSP streaming. Quick Time Player VLC Media Player VLC media player 1. Launch the RTSP player. 2. Choose File > Open URL. An URL dialog box will pop up.
  • Page 28: 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 29: 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 30: Main Page 30

    VIVOTEK Main Page This chapter explains the layout of the main page. It is composed of the following sections: VIVOTEK INC. Logo, Host Name, Camera Control Area, Configuration Area, and Live Video Window. VIVOTEK INC. Resize Buttons Host Name TS6346-EHL...
  • Page 31 VIVOTEK VIVOTEK INC. Logo Click this logo to visit the VIVOTEK website. Host Name The host name can be customized to fit your needs. For more information, please refer to System on page 42. Camera Control Area Video Stream: This Network Camera supports multiple streams (stream 1 ~ 4) simultaneously. You can select either one for live viewing.
  • Page 32 VIVOTEK Pan /Tilt /Zoom /Focus speed: Adjust the speed of Pan/ Tilt/ Zoom/ Focus: Pan speed Tilt speed Zoom speed Focus speed Slower Faster Note that mouse screen control is also supported. You can refer to page 100 for related information.
  • Page 33 VIVOTEK Resize Buttons Click the Auto button, the video cell will resize automatically to fit the monitor. Click 100% is to display the original homepage size. Click 50% is to resize the homepage to 50% of its original size. Click 25% is to resize the homepage to 25% of its original size.
  • Page 34 VIVOTEK Snapshot: Click this button to capture and save still images. The captured images will be displayed in a pop-up window. Right-click the image and choose Save Picture As to save it in JPEG (*.jpg) or BMP (*.bmp) format. Digital Zoom: Click and deselect the “Disable digital zoom” to enable the zoom operation. The navigation screen indicates the part of the image being magnified.
  • Page 35 VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Time Video (HTTP-V) 2016/03/10 17:08:56 Title and Time Video 17:08:56 2016/03/10 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 52.
  • Page 36: Client Settings 36

    VIVOTEK Client Settings This chapter explains how to select the stream transmission mode and saving options on the local computer. When completed with the settings on this page, click Save on the page bottom to enable the settings. H.265/H.264 Media Options Select to stream video or audio data or both.
  • Page 37 VIVOTEK Two way audio Half duplex: Audio is transmitted from one direction at a time, e.g., from a PC holding a web console with the camera. Full duplex: Audio is transmitted in both directions simultaneously. MP4 Saving Options Users can record live video as they are watching it by clicking the button - Start MP4 Recording - on the main page.
  • Page 38 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 39 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 40 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 41: Configuration 41

    VIVOTEK Configuration Click Configuration on the main page to enter the camera setting pages. Note that only Administrators can access the configuration page. Please refer to page 87 Security > User Account for how to configure access rights for different users.
  • Page 42: 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. System Host name: Enter a desired name for the Network Camera. The text will be displayed at the top of the main page.
  • Page 43: 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, such wording will be removed from the homepage. Logo graph Here you can change the logo at the top of your homepage.
  • Page 44 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 45 6. Click Save to enable the settings. Below are the options for system integrators or VARs. You can use the checkboxes to replace VIVOTEK’s company logo, the embedded website address or the slogan “Powered by VIVOTEK.“ When done, use the Save button to complete the configuration.
  • Page 46: System > Logs

    VIVOTEK System > Logs This section explains how to configure the Network Camera to send the system log to the remote server as backup. Log server settings Follow the steps below to set up the remote log: 1. Select Enable remote log.
  • Page 47: 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 48: 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 specify the firmware file.
  • Page 49 VIVOTEK General settings > Restore This feature allows you to restore the Network Camera’s factory defaults. Network: Select this option to retain the Network Type settings (please refer to Network Type on page 69). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
  • Page 50 VIVOTEK ® 3. Open and edit the file using Microsoft Notepad and locate your time zone in the strings; 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 51 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 52: 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, and Privacy mask. General settings Video title Show_timestamp and video title in videos_and_snapshots: Enter a name that will be displayed on the title bar of the live video as the picture shown below.
  • Page 53 The Network Camera automatically removes the IR cut filter when a Digital Input is triggerred. For example, the digital input can come from a housing that is equipped with IR illumination and control circuits such as VIVOTEK’s AM-214. ■ Schedule mode The Network Camera switches between day mode and night mode based on a specified schedule.
  • Page 54 VIVOTEK Image settings On this page, you can tune the White balance and Image adjustment settings. Sensor Setting 1: For normal situations White balance: Adjust the value for the best color temperature. ■ Select one of the white balance modes: 1.
  • Page 55 VIVOTEK Enable 3D 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 56 VIVOTEK Exposure control: ■ Exposure level: You can manually set the Exposure level, which ranges from -2.0 to +2.0 (dark to bright). You can also select other values from the Exposure mode menus and select a preferred scenario or manually configure the associated settings. You may prefer a shorter shutter time to better capture moving objects, while a faster shutter reduces light and needs to be compensated by electrical brightness gains.
  • Page 57 VIVOTEK ■ Maximum gain control: Select a maximum value for the electronic gain from the slide bar. The gain value also has its effect on the sensitivity of the IR cut filter. When applying the gain control, IR cut filter setting will change accordingly.
  • Page 58 VIVOTEK Exposure Profile: (Only available when the IR cut filter is not set to the Auto mode) If you want to configure another sensor and exposure setting for an individual day/night/schedule mode, please click Profile mode to open the Profile of exposure settings page as shown below.
  • Page 59 VIVOTEK Privacy mask On this page, you can block out sensitive view areas to address privacy concerns. NOTE: 1. The navigation buttons here also support the continuous move. You can click and hold down the button to move across the screen until you release the button.
  • Page 60 VIVOTEK NOTE: • The camera supports "3D Privacy Mask." Privacy masks should stay at the same positions regardless of how the camera lens may move. • When the "Enabled privacy mask" checkbox is deselected, no privacy masks will appear on screen.
  • Page 61: Media > Video

    VIVOTEK Media > Video Stream settings This Network Camera supports multiple streams with frame sizes ranging from 384 x 216 to 1920 x 1080 pixels. The definition of multiple streams: ■ Stream 1: Users can define the Frame sizes, compression format, image quality, etc.
  • Page 62 VIVOTEK Click the stream item to display the detailed information. . This Network Camera offers real-time H.265, H.264, and MJPEG compression standards (Multiple Codec) for real-time viewing. If the H.265 / H.264 mode is selected, the video is streamed via RTSP protocol.
  • Page 63 VIVOTEK ■ Frame size You can set up different video resolution for different viewing devices. For example, set a smaller frame size and lower bit rate for remote viewing on mobile phones and a larger video size and a higher bit rate for live viewing on web browsers.
  • Page 64 VIVOTEK Dynamic Intra Frame w/ static scenes Static scene P P P P P P P P P P P P P P P P P P P I Dynamic Intra Frame w/ activities in scenes P P P P P P P I...
  • Page 65 VIVOTEK non-interested ROI_0 ROI_0 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 66 VIVOTEK - Quality priority: Use the slide bar to tune the quality contrast between the ROI and non- interested areas. The farther the slide bar button is to the right, the higher the image quality of the ROI areas. On the contrary, the farther the slide bar button to the left, the higher the image quality of the non-interested area.
  • Page 67 VIVOTEK JPEG If the 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 68: 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 69: 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 23 for details.
  • Page 70 VIVOTEK Primary DNS: The primary domain name server that translates host names into IP addresses. Secondary DNS: Secondary domain name server that backs up the Primary DNS. Primary WINS server: The primary WINS server that maintains the database of computer names and IP addresses.
  • Page 71 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 72 VIVOTEK 4. In the Networking Services dialog box, select Universal Plug and Play and click OK. 5. Click Next in the following window. 6. Click Finish. UPnP is enabled. ► How does UPnP work? UPnP networking technology provides automatic IP configuration and dynamic discovery of devices added to a network.
  • Page 73 VIVOTEK Enable IPv6 Select this option and click Save to enable IPv6 settings. Please note that this only works if your network environment and hardware equipment support IPv6. The ® browser should be Microsoft Internet Explorer 6.5, Mozilla Firefox 3.0 or above.
  • Page 74 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 75 VIVOTEK Port HTTPS port: By default, the HTTPS port is set to 443. It can also be assigned to another port number between 1025 and 65535. Two way audio port: By default, the two way audio port is set to 5060. Also, it can also be assigned to another port number between 1025 and 65535.
  • Page 76 To stop talking, click again. FTP port: The FTP server allows the user to save recorded video clips. You can utilize VIVOTEK's Installation Wizard 2 to upgrade the firmware via FTP server. By default, the FTP port is set to 21. It also can be assigned to another port number between 1025 and 65535.
  • Page 77: Network > Streaming Protocols

    VIVOTEK Network > Streaming protocols HTTP streaming To utilize HTTP authentication, make sure that your have set a password for the Network Camera first; please refer to Security > User account on page 87 for details. Authentication: Depending on your network security requirements, the Network Camera provides two types of security settings for an HTTP transaction: basic and digest.
  • Page 78 VIVOTEK URL command -- http://<ip address>:<http port>/<access name for stream 1, 2, 3, 4, or 5> For example, when the Access name for stream 2 is set to video2.mjpg: 1. Launch the Mozilla Firefox browser. 2. Type the above URL command in the address bar. Press Enter.
  • Page 79 VIVOTEK Authentication: Depending on your network security requirements, the Network Camera provides three types of security settings for streaming via RTSP protocol: disable, basic, and digest. basic authentication is selected, the password is sent in plain text format, but there can be potential digest risks of it being intercepted.
  • Page 80 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 81: Network > Ddns

    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 82 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 83 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 84 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 85 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 86: 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 87: Security > User Account

    VIVOTEK Security > User Account 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 88: 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 89 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 90 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 91 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 92 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 93 VIVOTEK 9. Save the edit using the “.crt” extension, using a file name like “CAcert.crt.” 10. Return to the original firmware session, use the Browse button to locate the crt certificate file, and click Upload to enable the certification. User's Manual - 93...
  • Page 94 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 95: 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 all streams). 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 96 VIVOTEK ■ Disconnect: If you want to break off the current connections, please select them and click this button. Please note that those checked connections will only be disconnected temporarily and they will automatically retry a connection (IE Explore or Quick Time Player).
  • Page 97 VIVOTEK Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List in the CIDR format, e.g. 192.168.xx.xx/24. For example: IP address 192.168.2.x will be blocked. Range: This rule allows the user to assign a range of IP addresses to the Allow/Deny List.
  • Page 98 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 99 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: ► Below is the authentication process for 802.1x: 1.
  • Page 100: Ptz > Ptz Settings

    You can also restore the home posiotion to the factory default, which is approximately 45 degree looking down with the lens lined up with the VIVOTEK logo. Patrol list This column displays the configured patrols.
  • Page 101 VIVOTEK Recorded Patrol The recorded patrol allows you to record the process moving along interested points (positions) in your surveillance area while the camera memorizes every Pan/Tilt/Zoom/Focus commands you gave in the process. You can then save the process as a recorded patrol. Due to the limitation on system memory, you can configure 4 recorded patrols, each with a length of 2 minutes.
  • Page 102 VIVOTEK To create a recorded patrol, 1. Enter a name for the patrol. 2. Use mouse clicks or the PTZ panel to select a field of view as your start point. 3. Select the Pan/Tilt/Zoom/Focus speed, and the PTZ control mode.
  • Page 103 VIVOTEK Preset Patrol NOTE: The navigation buttons here also support the continuous move. You can click and hold down the button to move across the screen until you release the button. Preset positions and patrol settings In the PTZ settings page, you can configure preset positions for the camera to travel through. A total of 256 preset positions can be configured.
  • Page 104 The same applies to arrow keys, Zoom, and Focus buttons on the PTZ panel. If you select Click to move, every single mouse click takes effect for once without the ensuing move. TS6346-EHL Zoom Out Zoom In...
  • Page 105 VIVOTEK another. Only the preset points are displayed. Apply previous action if the camera idles for __(1~999) seconds: You can assign an action to be taken when the camera sits idle for a configurable period time. For example, you can let camera resume a patrol tour.
  • Page 106 VIVOTEK Auto tracking In this window, you can modify the minimum object size as the triggering factor while performing the Auto Tracking function. You can move the camera view to an area of your interest, estimate, and define the possible size of objects. For example, you can designate the object size such as that of a human trespasser.
  • Page 107 VIVOTEK Auto tracking is configured by designating the minimum object size. Moving objects that enter the current region of view will trigger the tracking action. Auto tracking, if applied, is designed to track an intruder in a place where human traffic is not heavy, such as a warehouse or a load area.
  • Page 108: Event > Event Settings

    VIVOTEK Event > Event settings This section explains how to configure the Network Camera to responds 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 109 VIVOTEK ■ Event name: Enter a name for the event setting. ■ Enable this event: Select this option 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 110 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 111 VIVOTEK 3. Action Define the actions to be performed by the Network Camera when a trigger is activated. ■ Trigger digital output for seconds Select this option to turn on the external digital output device when a trigger is activated. Specify the length of the trigger interval in the text box.
  • Page 112 VIVOTEK NOTE: If you configured a motion detection window as a trigger, the motion detection may become invalid when the camera’s field of view moved away from the detection window. You can let camera return to the motion detection position to detect the coming event by re-configuring your Home position in PTZ >...
  • Page 113 VIVOTEK Add server Click Add server to unfold the server setting window. You can specify where the notification messages are sent when a trigger is activated. A total of 5 server settings can be configured. There are four choices of server types available: Email, FTP, HTTP, and Network storage. Select the item to display the detailed configuration options.
  • Page 114 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, then click Close to exit the Add server page.
  • Page 115 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. To verify if the FTP settings are correctly configured, click Test. The result will be shown in a pop-up window as shown below.
  • Page 116 VIVOTEK Network storage: Select to send the media files to a network storage location when a trigger is activated. Please refer to NAS server on page 134 for details. Click Save server to enable the settings, then click Close to exit the Add server page.
  • Page 117 VIVOTEK Add media Add media Click to open the media setting window. You can specify the type of media that will be sent and preserved 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 118 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_20110320_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings, then click Close to exit the Add media page.
  • Page 119 VIVOTEK ■ Maximum duration Specify the maximum recording duration in seconds. Up to 20 seconds can be set. For example, if pre-event recording is set to 5 seconds and the maximum duration is set to 10 seconds, the Network Camera continues to record for another 4 seconds after a trigger is activated.
  • Page 120 VIVOTEK ■ View: Click this button to open a file list window. This function only apllies when an SD card and networked storage are available. If you click View button of SD card, a Local storage page will pop up for you to manage recorded files on SD card.
  • Page 121 VIVOTEK Here is an example of the Event setting: When completed the settings with steps 1~3 to arrange Schedule, Trigger, and Action of an event, click Save event to enable the settings and click Close to exit the page. The following is an example of the Event setting page:...
  • Page 122 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. 2014/03/20...
  • Page 123: 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 124 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 108.
  • Page 125 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 109 for detailed informatio. NOTE: ►...
  • Page 126: Applications > Di And Do

    VIVOTEK Applications > DI and DO Digital input: Select High or Low to define normal status for the digital input. Connect a digital input from a sensor device to the camera, the Network Camera will report the current signal status. You may then configure the Normal status (non-trigger status) as High or Low.
  • Page 127: 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 128 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 129: Applications > Vadp (Vivotek Application Development Platform)

    VADP requirements. Please contact technical support or the vendor of your 3rd-party module for the parameters contained within. • Users can also run VIVOTEK's VADP packages as a means to access updated functionality instead of replacing the entire firmware. •...
  • Page 130 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 131 Follow the onscreen instruction on VIVOTEK's website for the registration procedure. You can proced with the following link to download a license key: http://www.vivotek.com/vadp- introduction/ or http://w3.vivotek.com/login.aspx. When the license key is downloaded to your computer, upload the key to the camera.
  • Page 132: Recording > Recording Settings

    VIVOTEK Recording > Recording settings This section explains how to configure the recording settings for the Network Camera. Recording Settings Insert your SD card and click here to test NOTE: ► Please remember to format your SD card when using it for the first time. Please refer to page 137 for detailed information.
  • Page 133 VIVOTEK If you enable adaptive recording and enable time-shift cache stream on Camera A, only when an event is triggered on Camera A will the server record video streams in the full frame rate; otherwise, it will only request the I frame data during normal monitoring, thus effectively save lots of bandwidth and storage.
  • Page 134 VIVOTEK 2. Destination You can select the SD card or network attached storage (NAS) for recording video files. NAS server Click Add NAS server to open the server setting window and follow the steps below to set up: 1. Fill in the information for your server.
  • Page 135 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 select either the entire storage space available or specify a reserved space. The recording size limit must be larger than the reserved space for cyclic recording.
  • Page 136 VIVOTEK this page. When the system begins recording, it will send the recorded files to a networked storage or SD card. The new recording name will appear on the recording page as shown below. To remove a recording setting from the list, select it and click Delete.
  • Page 137: Local Storage > Sd Card Management

    VIVOTEK Local storage > SD card management NOTE: • It is recommended to turn OFF the recording activity before you remove an SD card from the camera. • The lifespan of an SD card is limited. Regular replacement of the SD card can be necessary.
  • Page 138: Local Storage > Content Management

    VIVOTEK SD card control ■ Enable cyclic storage: Check this item if you want to enable cyclic recording. When the maximum capacity is reached, the oldest file will be overwritten by the latest one. ■ Enable automatic disk cleanup: Check this item and enter the number of days you wish to retain a file.
  • Page 139 VIVOTEK Search Results The following is an example of search results. There are four columns: Trigger time, Media type, Trigger type, and Locked. Click to sort the search results in either direction. Numbers of entries displayed on one page Click to open a live view ■...
  • Page 140 VIVOTEK ■ Lock/Unlock: Select the checkbox in front of a desired search result, then click this button. The selected items will become Locked, which will not be deleted during cyclic recording. You can click again to unlock the selections. For example:...
  • Page 141 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 142 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 143 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 144 VIVOTEK http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n 144 - User's Manual...
  • Page 145 (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 placed at the end of the parameter list Return: HTTP/1.0 200 OK\r\n...
  • Page 146 VIVOTEK 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 Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n...
  • Page 147 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 148 VIVOTEK W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 NOTE: The camera should not be restarted when parameters are changed. 148 - User's Manual...
  • Page 149 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 150 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 151 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 152 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 153 VIVOTEK 7.1.1 system.info Subgroup of system: info (The fields in this group are unchangeable.) NAME VALUE SECURITY DESCRIPTION (get/set) modelname string[40] Internal model name of the server extendedmodelname string[40] ODM specific model name of server (eg. DCS-5610). If it is not an ODM model, this field will be equal to “modelname”...
  • Page 154 VIVOTEK xcount-1)> 7.2status Group: status NAME VALUE SECURITY DESCRIPTION (get/set) di_i<0~(capability_ndi-1)> <boolean> 0 => Inactive, normal <product dependent> 1 => Active, triggered (capability.ndi > 0) do_i<0~(capability_ndo-1)> <boolean> 0 => Inactive, normal <product dependent> 1 => Active, triggered (capability.ndo > 0) onlinenum_rtsp 0,<positive...
  • Page 155 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 156 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 157 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 158 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 159 VIVOTEK 7.6.4 FTP Subgroup of network: ftp NAME VALUE SECURITY DESCRIPTION (get/set) port 21, 1025~65535 Local ftp server port. 7.6.5 HTTP Subgroup of network: http NAME VALUE SECURITY DESCRIPTION (get/set) port 80, 1025 ~ 65535 HTTP port. alternateport 1025~65535 Alternate HTTP port.
  • Page 160 VIVOTEK 7.6.6 HTTPS port Subgroup of network: https (capability.protocol.https > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 443, 1025 ~ 65535 HTTPS port. 7.6.7 RTSP Subgroup of network: rtsp (capability.protocol.rtsp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 554, 1025 ~ 65535 RTSP port.
  • Page 161 VIVOTEK 7.6.7.1 RTSP multicast Subgroup of network_rtsp_s<0~(n-1)>: multicast n is stream count NAME VALUE SECURITY DESCRIPTION (get/set) alwaysmulticast <boolean> Enable always multicast. ipaddress <ip address> Multicast IP address. videoport 1025 ~ 65535 Multicast video port. audioport 1025 ~ 65535 Multicast audio port.
  • Page 162 VIVOTEK pass password[64] PPPoE account password. 7.7IP Filter Group: ipfilter NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable access list filtering. admin_enable <boolean> Enable administrator IP address. admin_ip string[43] Administrator IP address. maxconnection 1~10 Maximum number of concurrent streaming connection(s).
  • Page 163 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": Use rgain and bgain to set white rbgain, widerange, balance manually.
  • Page 164 VIVOTEK 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 165 VIVOTEK 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 => 1s ~ 1/32000s <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>,...
  • Page 166 VIVOTEK "capability_image_c<n>_exposure_rangetyp e" 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 167 VIVOTEK 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c<n>_wbmode". * Only valid when "videoin_c<n>_whitebalance" != auto * Normalized range. bgain 0~100 Manual set bgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain"...
  • Page 168 VIVOTEK "capability_image_c<n>_exposure_m Gain. odetype") "irispriority": Adjust with variable Iris, auto Gain and Shutter speed. "manual": Adjust with variable Shutter, Iris and Gain. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. irismode fixed, indoor, outdoor Control DC-Iris mode.
  • Page 169 VIVOTEK ortype" is "smartsensor" * Only available when "capability_image_c<n>_iristype"=pi enableblc <boolean> Enable backlight compensation <Not support * Not support this parameter anymore anymore> when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c<n>_mode" to switch on/off BLC.
  • Page 170 VIVOTEK * Only available when "capability_image_c<n>_agc_maxgai n" != "-" and "capability_image_c<n>_exposure_ra ngetype" is "onevalue". * Normalized range. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. color 0, 1 0 =>monochrome 1 => color flip <boolean>...
  • Page 171 VIVOTEK textonvideo_fon /usr/share/font/Default.ttf, Choose camera default font file tpath /mnt/flash2/upload.ttf (/usr/share/font/Default.ttf) or user uploaded font file(/mnt/flash2/upload.ttf). textonvideo_upl Depends on the font file name Show the uploaded font file name. oadfilename uploaded by user minexposure <1~32000>, Minimum exposure time <product <5~32000>, 1~32000 =>...
  • Page 172 VIVOTEK * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<n>_exposure_ra ngetype" is "twovalues". shuttervalue <1~32000>, Exposure time <product <5~32000>, 1~32000 => 1s ~ 1/32000s dependent> <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc.
  • Page 173 VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0302a. s<0~(m-1)>_e <boolean> Indicate whether stream supprts eptz nableeptz or not s<0~(m-1)>_c Listed at "capability_videoin_codec" Codec type for this stream odectype Possible values are: mjpeg, h264,h265 <product dependent>...
  • Page 174 VIVOTEK directly. * Only valid when "ratecontrolmode"= vbr and s<0~(m-1)>_h264_quant = s<0~(m-1)>_h 1~100 Select customized quality in a 264_qpercent normalized full range. 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"= vbr and "quant"= 100. The maximum allowed bit rate in fixed  s<0~(m-1)>_h 20000~"capability_videoin_c<n>_h2 "...
  • Page 175 VIVOTEK cbr and "quant"= 100. * Only available when "capability_smartstream_version"=2.   s<0~(m-1)>_h 20000~"capability_videoin_c<n>_h2 The target bit rate in constant bit rate 264_bitrate 64_maxbitrate" mode. *  Only valid when "ratecontrolmode"=   s<0~(m-1)>_h framerate,imagequality Set prioritypolicy 264_prioritypoli *  Only valid when "ratecontrolmode"=  ...
  • Page 176 VIVOTEK * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_h 1~5, Set the pre-defined quality level: 265_quant 99, 100 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue"...
  • Page 177 VIVOTEK * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~5, 100 Set the pre-defined quality level: 265_cbr_quant 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent"...
  • Page 178 VIVOTEK 265_prioritypoli * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~"capability_videoin_c<n>_h265_m The maximum frame rates of a H265 265_maxframe axframerate" stream at different resolutions("capability_videoin_c0_re solution ") are recorded in "capability_videoin_c<n>_h265_maxf ramerate" * Only available when h265 is listed in "capability_videoin_codec".
  • Page 179 VIVOTEK ex: 0301a_1) * Only valid when "ratecontrolmode"= or 1~99 vbr and s<0~(m-1)>_mjpeg_quant = (Only valid when "capability_api_httpversion" format is XXXXX_2, ex: 0301a_2) <product dependent> s<0~(m-1)>_m 1~100 Select customized quality in a jpeg_qpercent normalized full range. 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"=...
  • Page 180 VIVOTEK 100: Best quality * Only valid when "ratecontrolmode"= cbr and "quant"= 100. * Only available when "capability_smartstream_version"="2 .0" s<0~(m-1)>_m 20000~"capability_videoin_c<n>_mj The target bit rate in constant bit rate jpeg_bitrate peg_maxbitrate" mode. * Only valid when "ratecontrolmode"= s<0~(m-1)>_m framerate,imagequality Set prioritypolicy jpeg_prioritypoli * Only valid when "ratecontrolmode"=...
  • Page 181 VIVOTEK * Only available when "capability_image_c<n>_wdrc_mode " is 1 aespeed_mode <boolean> Turning AE converge speed on or off.   <product 0: off dependent> 1: on * Only available when "capability_image_c<n>_aespeed" is aespeed_speedl 1~100 The speed level of AE converge speed.
  • Page 182 VIVOTEK     mounttype ceiling, wall, floor wall mount: 180° panoramic view <product ceiling mount: 360° surround view dependent> without blind spots floor mount: 360° surround view without blind spots * Only available when "capability_fisheye" > 0   enablewatermar 0, 1...
  • Page 183 VIVOTEK of non-interest (non-ROI) of the display image. If the value is a positive number, the video quality of ROI is better than the non-ROI areas. 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 184 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 185 VIVOTEK * Available value is listed in * This parameter may also restrict image "capability_image_c frame rate from sensor due to sensor <n>_exposure_ma generates a frame per exposure time. Ex: If xrange" this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.
  • Page 186 VIVOTEK <Not support anymore> * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c<n>_mode" to switch on/off BLC. exposurelevel 0~12 Exposure level "0,12": This range takes the concept from DC's exposure tuning options.
  • Page 187 VIVOTEK widerange, balance manually. outdoor, "manual": 2 cases: indoor, a. if "rbgain" is not supported, this means sodiumauto, keep current white balance status. b. if "rbgain" is supported, "rgain" and "bgain" are updated to the current values (Available values are which is got from white balance module.
  • Page 188 VIVOTEK "irismode"=fixed * Normalized range. * Only available when "capability_image_c<n>_exposure_rangetyp e" is "twovalues". mingain 0~100 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<n>_agc_mingain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range.
  • Page 189 VIVOTEK "capability_image_c<n>_iristype"=piris piris_position 1~100 Manual set P-Iris. <product dependent> 1: Open <-> 100: Close * Only vaild when "piris_mode"=manual or "capability_image_c<0~(n-1)>_sensortype" is "smartsensor" * Only available when "capability_image_c<n>_iristype"=piris irismode fixed, indoor, Control DC-Iris mode. "outdoor": Auto-setting DC-Iris to get best outdoor <product...
  • Page 190 VIVOTEK "capability_image_c<n>_aespeed" is 1 aespeed_speedlevel 1~100 The speed level of AE converge speed.   <product dependent> 1~20: level 1 21~40: level 2 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher speed level meas shorter AE converged time during AE executing.
  • Page 191 VIVOTEK 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 (get/set) enable <boolean> Enable time shift streaming. c<0~(n-1)>_s<0~(m-1) <boolean>...
  • Page 192 VIVOTEK capability_daynight There are two value format: _c<n>_ircutsensitiv "low,normal,high": if ity_type=options) capability_daynight_c<n>_ircutsensitivity_ty pe=options 1~100 (if capability_daynight "1~100": if _c<n>_ircutsensitiv capability_daynight_c<n>_ircutsensitivity_ty ity_type=normalize pe=normalize 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 193 VIVOTEK <Not recommended to use this> 100: Use " image_c<n>_saturationpercent" * Only available when bit 2 of "capability_image_c<n>_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 194 VIVOTEK "capability_image_c<n>_basicsetting" is 1 gammacurve 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 195 VIVOTEK dis_mode <boolean> Digital image stabilizer <product dependent> 0:disable 1:enable * Only available when 'dis' is listed in "capability_image_c<n>_is_mode". dis_strength 1~100 Strength of digital image stabilizer <product dependent> * Only available when 'dis' is listed in "capability_image_c<n>_is_mode". scene_enable <boolean> Enable/disable scene mode <product dependent>...
  • Page 196 VIVOTEK "capability_image_c<n>_basicsetting" is 1 * We replace "profile_i0_brightness" with "profile_i0_brightnesspercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. profile_i<0~(m-1)>_contrast -5~5,100 -5: Less contrast <-> 5: More contrast <Not recommended to use this>...
  • Page 197 0: Softer <-> 100: Sharper * Only available when bit 3 of "capability_image_c<n>_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 198 VIVOTEK profile_i<0~(m-1)>_dnr_stren 1~100 Strength of 3DNR * Only available when <product dependent> "capability_image_c<n>_dnr" is 1 profile_i<0~(m-1)>_defog_mo <boolean> Enable/disable defog mode. 0:disable <product dependent> 1:enable * Only available when "capability_image_c<n>_defog_mode" is 1 profile_i<0~(m-1)>_defog_str 1~100 Strength of defog ength * Only available when <product dependent>...
  • Page 199 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<n>_exposure_mode"=1) NAME VALUE SECURITY DESCRIPTION (get/set) "auto": Use full image view as the only mode auto, custom,blc exposure window.
  • Page 200 VIVOTEK sizepx <0~Wx0~ H> Width and height of the window. W: 0~ The current image width -1 * Only available when px is listed in H: 0~ The current image height -1 "capability_image_c<n>_exposure_windomai n". homestd <0~9999,0~9999> Left-top corner coordinate of the window.
  • Page 201 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<n>_exposure_winnum". (Only valid when exposurewin_c<n>_mode=custom) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the window.
  • Page 202 VIVOTEK * Only available when std is listed in "capability_image_c<n>_exposure_windomai n". 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 203 VIVOTEK 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) this>...
  • Page 204 VIVOTEK 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 205 VIVOTEK 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 206 VIVOTEK   <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" = polygon.   image width -1 H: 0~ The current...
  • Page 207 VIVOTEK * 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 208 VIVOTEK 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 209 VIVOTEK 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> 320,0 ~ 240, 0 ~...
  • Page 210 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 211 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 212 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 213 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 214 VIVOTEK 7.21 SNMP Group: snmp (capability.protocol.snmp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) <boolean> SNMP v2 enabled. 0 for disable, 1 for enable <boolean> SNMP v3 enabled. 0 for disable, 1 for enable secnamerw string[31] Read/write security name secnamero string[31]...
  • Page 215 1 => Default logo logo_link string[128] Hyperlink of the logo http://www.vivotek. logo_powerbyvvtk_hidden <boolean> 0 => display the power by vivotek logo 1 => hide the power by vivotek logo custombutton_manualtrig <boolean> Show or hide manual trigger (VI) button in ger_show homepage 0 ->...
  • Page 216 VIVOTEK 7.23 Privacy mask Group: privacymask_c<0~(n-1)> for n channel products and m privacy mask window. n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable privacy mask. win_i<0~(m-1)>_enable <boolean>...
  • Page 217 VIVOTEK ~ W,0 ~ H "capability_image_c<n>_privacymask_wintype" W: 0~ The = polygon. current image width -1 * Only available when px is listed in H: 0~ The "capability_image_c<n>_privacymask_windomai current image height -1 win_i<0~(m-1)>_polygonstd 0 ~ 9999,0 ~ Coordinate of polygon window position.
  • Page 218 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 219 VIVOTEK while 'r' is an alphabetic. EX: 0302b_1 => Major version = 03, minor version = 02, revision = b, platform = 1 The 4 integer numbers are WebAPI version, we use short name: [httpversion] for it in this document.
  • Page 220 VIVOTEK nmediastream <positive integer> Number of media stream per channels. naudiosetting <positive integer> Number of audio settings per channel. <Not support anymore> * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * We replace "naudiosetting" with "naudioin".
  • Page 221 VIVOTEK evctrlchannel <boolean> Indicate whether to support HTTP tunnel for event/control transfer. joystick <boolean> Indicate whether to support joystick control. remotefocus 0,<positive integer> An 4-bit integer, which indicates the supportive <Not recommended to use application of remotefocus. this> If the value of this parameter is larger than 0, it means that the camera supports remotefocus function.
  • Page 222 VIVOTEK channel, bit 10~19 are the 2nd group for 2nd channel, bit 20~31 are the 3rd group for 3rd channel. Then, the 1st bit of the group indicates 1st stream of a channel support ePTZ or not. The 2nd bit of the group indicates 2nd stream of a channel support ePTZ or not, and so on.
  • Page 223 VIVOTEK "vi" = Virtual input (Manual trigger) "vadp" = VADP trigger "di"= Digital input "volalarm" = Audio detection "temperature" = Temperature detection "pir" = PIR detection "visignal" = Video input signal loss. "backup" = Backing up recorded files * Only available when [httpversion] >= 0301a storage_dbenabled <boolean>...
  • Page 224 VIVOTEK videoin_nresolution <positive integer> This equals "capability_videoin_c0_nresolution". * This is kept for compatibility. 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.
  • Page 225 VIVOTEK ntsc: NTSC analog output pal: PAL analog output "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.
  • Page 226 VIVOTEK audio_linein <boolean> Indicate whether to support external line <Not support anymore> input. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * It will be replaced by audio_intmic and audio_extmic. audio_lineout <boolean>...
  • Page 227 VIVOTEK smartstream_nstream <positive integer> Number of stream that support smart stream. *only available when "capability_smartstream_support" is 1 smartstream_windomain qvga, px, std, - The domain to set an focus window. qvga: a 320x240 range to represent the whole image. px: Locate a window in the image with pixels.
  • Page 228 VIVOTEK vadp_supportfeature <positive integer> An 32-bit integer, each bit can be set separately as follows: Bit 0 => VADP interface Bit 1 => Capture video raw data Bit 2 => Support encode jpeg Bit 3 => Capture audio raw data Bit 4 =>...
  • Page 229 VIVOTEK camctrl_privilege <boolean> Indicate whether to support “Manage Privilege” of PTZ control in the security page. 1: support both /cgi-bin/camctrl/camctrl.cgi and /cgi-bin/viewer/camctrl.cgi 0: support only /cgi-bin/viewer/camctrl.cgi This is equivalent to"capability_camctrl_c0_privilege". * This is kept for compatibility. uart_httptunnel <boolean> Indicate whether to support HTTP tunnel for UART transfer.
  • Page 230 VIVOTEK media_snapshot_maxpost <positive integer> Maximum snapshot number after event event occurred. media_snapshot_maxsize <positive integer> Maximum size (KB) of a snapshot. media_videoclip_maxsize <positive integer> Maximum size (KB) of a videoclip. media_videoclip_maxleng <positive integer> Maximum length (second) of a videoclip. media_videoclip_maxpree <positive integer>...
  • Page 231 VIVOTEK recording function. bit 0 : It supports to record directly to an on-board SD-Card. bit 1~: Currently, they are reserved bit, and the default value is 0. localstorage_slconnum 0,<positive integer> The maximum seamless connection number. localstorage_smartsd <boolean> The "Lifetime and Log SD Card" feature allows users to obtain the card's remaining lifetime information.
  • Page 232 VIVOTEK rs485 <boolean> An 32-bit integer, each bit can be set separately as follows: Bit 0 => support rs485-in Bit 1 => support rs485-out buildinpt <boolean> An 32-bit integer, each bit can be set separately as follows: Bit 0 => support build-in pan Bit 1 =>...
  • Page 233 VIVOTEK minpanangle <integer> The lower limit for pan angle. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" 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.
  • Page 234 VIVOTEK maxdzoom 0, <positive integer> 0/7 The upper limit for digital zoom position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule" is "1" 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"...
  • Page 235 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" * Only available when "capability_daynight_c<n>_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 236 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 237 VIVOTEK mjpeg_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer> and "-" MJPEG on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution"...
  • Page 238 VIVOTEK h264_maxbitrate <positive integer> Maximum bitrates of H.264. The unit is bps. * Only available when 'h264' is listed in "capability_videoin_codec". h265_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer> and "-" H.265 on resolutions in current video mode.
  • Page 239 VIVOTEK cameraunit_name CU8131, A "camera unit" name of a split-type camera CU8171, system, which the camera unit and the video CU8161-H, core are separated. CU8162-H, -: If the camera is not a split-type camera CU8163-H, system, the value of this parameter is "-".
  • Page 240 VIVOTEK effectivepixel <WxH> The visible area of full scene in this video mode. The unit is pixel in source. * If "effectivepixel"<"capability_videoin_c<n>_max size", then the visible area is located at the center of full scene. outputsize <WxH> The output size of source, equal to the captured size by device, in this video mode.
  • Page 241 VIVOTEK maxframerate A list of <Positive Indicates frame rate that the video source Integer> outputs in this video mode. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group.
  • Page 242 VIVOTEK maxfps_h265 A list of <Positive Maximum fps which the device can encoded with Integer> and "-" H.265 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 243 VIVOTEK number indicate the support strength level of WDR Pro, and the scecond number indicate the support strength level of WDR Pro II. wdrpro_affect When WDR Pro or WDR Enhanced is exposurewin.mode:fixed:au enabled, some features may become malfunction or be forced to a given exposurewin.mode.blc:disab...
  • Page 244 VIVOTEK wdrpro_description <string> Description about WDR Pro mode. * Only available when "capability_image_c<0~(n-1)>_wdrp ro_mode" > 0       wdrc_mode 0, 1 0: Non-support WDR Enhanced 1: Support WDR Enhanced   wdrc_supportlevel 0, <positive integer> Indicate the support strength level of WDR Enhanced.
  • Page 245 VIVOTEK "-" means no feature is affected. * When "wdrpro"=0 and "wdrc"=0, this must be "-"         0: Non-support 3D digital noise reduction 1: Support 3D digital noise reduction   0: Non-support electronic image stabilizer 1: Support electronic image stabilizer...
  • Page 246 VIVOTEK minexposure:hidden:, features may become malfunction or mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here. 3dnr:unchanged:, or others The format is "Affect API name":"Policy":"Value" <x>: nonnegative integer <product dependent> "Policy" can be categorized into...
  • Page 247 VIVOTEK 1: Support scene mode scenemode_supporttype visibility, list all the scene mode which are <product dependent> noiseless, supported in the camera. lpcparkinglot, lpcstreet * Only available when <product dependent> "capability_image_c<n>_ scenemode_support" is 1 scenemode_visibility_affe When scene mode is enabled, some...
  • Page 248 VIVOTEK "-" means no feature is affected. * Only available when visibility is listed in "capability_image_c<n>_ scenemode_supporttype" and "capability_image_c<n>_ scenemode_support" is 1 scenemode_noiseless_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.
  • Page 249 VIVOTEK * Only available when visibility is listed in "capability_image_c<n>_ scenemode_supporttype " and "capability_image_c<n>_ scenemode_support" is 1 scenemode_lpcparkinglot When scene mode is enabled, some _affect 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.
  • Page 250 VIVOTEK in "capability_image_c<n>_ scenemode_supporttype " and "capability_image_c<n>_ scenemode_support" is 1 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...
  • Page 251 VIVOTEK scenemode_supporttype " and "capability_image_c<n>_ 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 252 VIVOTEK or greater than 0302a. 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<n>_shuttervalue). "maximum": The shutter value can be up to the assigned value (videoin_c<n>_shuttervalue).
  • Page 253 VIVOTEK name":"Policy":"Value" <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 254 VIVOTEK wdrpro:disabled:, here. exposurelevel:hidden:, or others The format is "Affect API name":"Policy":"Value" <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 255 VIVOTEK e_affect exposurewin.mode.blc:hidd some features may become en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here. exposurelevel:hidden:, or others The format is "Affect API name":"Policy":"Value" <x>: nonnegative integer <product dependent> "Policy" can be categorized into...
  • Page 256 VIVOTEK version number (httpversion) is equal or greater than 0302a. exposure_manualmode_a When exposure mode is enabled, ffect exposurewin.mode.blc:hidd some features may become en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here. exposurelevel:hidden:, or others The format is "Affect API...
  • Page 257 VIVOTEK "capability_image_c<n>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_levelrange     Available range for "0,12"   "videoin_c<n>_exposurelevel" * When "exposure_mode"=0, this must be set to "-".  ...
  • Page 258 VIVOTEK 0301a A list of <Positive Integer> exposure_pal_totalrange Available total range for PAL analog output * Only available when [httpversion] >=  0301a exposure_maxrange   "1,32000",   Available range for "1,8000", "videoin_c<n>_maxexposure" "1,32000" => 1s ~ 1/32000s or others   "1,8000" => 1s ~ 1/8000s <product dependent>   etc. "-" means maximum exposure time is not available.
  • Page 259 VIVOTEK privacy mask. agc_maxgain   "0,100",   Available range for "-"   "videoin_c<n>_maxgain" “0,100” => 0~100 percent "-" means "videoin_c<n>_maxgain" is not available.       agc_mingain "0,100", Available range for "-"   "videoin_c<n>_mingain" “0,100” => 0~100 percent "-" means "videoin_c<n>_mingain" is  ...
  • Page 260 VIVOTEK which means exposurelevel is fixed to level 6. "Value" can be a nonnegative integer or NULL. "-" means no feature is affected. * When "flickerless" = 0, this must be "-" defog_mode 0: Non-support defog 1: Support defog defog_strength...
  • Page 261 VIVOTEK selections or values. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6.
  • Page 262 VIVOTEK 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. focuswindomain qvga, px, std, - The domain to set an focus window.
  • Page 263 VIVOTEK Group: capability_peripheral_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) waterspray_support <boolean> 0: Non-support water spray feature 1: Support water spray feature * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 264 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 265 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 266 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 267 VIVOTEK action_goto_name string[40] Specify the preset name that ptz goto on event <product dependent> triggered. * Only available when capability_ptzenabled > action_goto_sync <boolean> Capture media after moving to the location. <product dependent> * Only avaliable when the bit4 of capability_ptzenable is 1 and the bit7 of...
  • Page 268 VIVOTEK email_port 0~65535 Port to connect to the server. email_username string[64] Username to log in to the server. email_passwd string[64] Password of the user. email_senderemail string[128] Email address of the sender. email_recipientemail string[640] Email address of the recipient. ns_location string[128] Location to upload or store the media.
  • Page 269 VIVOTEK snapshot_postevent 0~" Indicates the number of post-event capability_media_snapshot_maxpo images. stevent" videoclip_source 0~"capability_nmediastream -1" Indicate the source of media stream. 0 means the first stream. 1 means the second stream and etc. 2 means the third stream and etc. 3 means the fourth stream and etc.
  • Page 270 VIVOTEK maxretentiontime <string> To specify the expired time for automatic clean up, and it only takes effect for video clip generated by recording_i <0~1>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss]S’ , similar with ISO8601 with symbols P Ex. P7D, it means 7 days. P1DT10H, it means 1 days and 10 hours.
  • Page 271 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 272 State or province name in the certificate information. localityname string[128] The locality name in thecertificate information. organizationname string[64] Organization name in the certificate VIVOTEK Inc. information. unit string[64] Organizational unit name in thecertificate VIVOTEK Inc. information. commonname string[64] Common name in the certificate information.
  • Page 273 VIVOTEK 7.32 Storage management setting Group: disk_i<0~(n-1)> n is the total number of storage devices. (capability.storage.dbenabled > 0) Currently it’s only for local storage (SD, CF card), so n is equal to 1. PARAMETER VALUE SECURITY DESCRIPTION (get/set) cyclic_enabled <boolean>...
  • Page 274 VIVOTEK 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>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss]S’ , similar with ISO8601 with symbols P Ex. P7D, it means 7 days. P1DT10H, it means 1 days and 10 hours.
  • Page 275 VIVOTEK 7.33 Region of interest Group: roi_c<0~(n-1)> for n channel product. (capability.eptz > 0) m denotes the value of "capability_nmediastream". PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-2)>_home <W,H> ROI left-top corner coordinate.* If the minimal <product dependent> window size is 64x64, then the "win_i0_home"=(0~resolution_W-64,...
  • Page 276 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 277 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) patrolseq string[120] The patrol sequence of ePTZ. All the patrol position indexes will be separated by "," patroldwelling string[160] The dwelling time (unit: second) of each patrol point, separated by “,”. preset_i<0~19>_name string[40] Name of ePTZ preset.
  • Page 278 (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 279 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" is equal or greater than 1.3.2.0)
  • Page 280 VIVOTEK control the execution of the VADP package begintime hh:mm Begin time of the schedule 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.
  • Page 281 VIVOTEK cameraid 0~255 Camera ID controlling external PTZ camera. isptz 0 ~ 2 0: disable PTZ commands. 1: enable PTZ commands with PTZ driver. 2: enable PTZ commands with UART tunnel. * Only available when bit7 of capability_ptzenabled is 1 disablemdonptz <boolean>...
  • Page 282 VIVOTEK >_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)>_fliped <boolean> Flip side at each preset location. patrol_i<0~39>_name string[40] (For internal device) The name of patrol location patrol_i<0~39>_ dwelling...
  • Page 283 VIVOTEK digitalzoom <boolean> Enable/disable digital zoom idleaction_enable <boolean> Enable/disable idle action while idle idleaction_type pan,patrol,home,objtrack, This field tells what kind of action should prev be taken while idle. idleaction_interval 1~999 While idle over this time interval, idle action will be taken.
  • Page 284 VIVOTEK 7.40 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 285 VIVOTEK 7.41 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 286 VIVOTEK 7.42 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 287 VIVOTEK 7.43 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.44 Fisheye local dewarp setting   Group: fisheyedewarp_c<0~(n-1)> (capability_fisheyelocaldewarp_c<0~(capability_nvideoin)-1> > 0)  ...
  • Page 288 VIVOTEK 7.45 PIR behavior define Group: pir (capability.npir > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable PIR 7.46 Auto tracking setting Group: autotrack_c<0~(n-1)> (capbility_image_c<0~(capability_nvideoin)-1>_autotrack_support > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) objsize_type -1~2 Type of object size.
  • Page 289 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 290 VIVOTEK Query Status of the Digital Input(capability.ndi > 0) Note: This request requires Viewer privileges Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/getdi.cgi?[di0][&di1][&di2][&di3] If no parameter is specified, all of the digital input statuses will be returned. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <length>\r\n \r\n [di0=<state>]\r\n...
  • Page 291 VIVOTEK Query Status of the Digital Output (capability.ndo > 0) Note: This request requires Viewer privileges Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/getdo.cgi?[do0][&do1][&do2][&do3] If no parameter is specified, all the digital output statuses will be returned. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <length>\r\n \r\n [do0=<state>]\r\n...
  • Page 292 VIVOTEK Capture Single Snapshot Note: This request requires Normal User privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/video.jpg?[channel=<value>][&resolution=<value>] [&quality=<value>][&streamid=<value>] If the user requests a size larger than all stream settings on the server, this request will fail. PARAMETER VALUE DEFA DESCRIPTION channel 0~(n-1) The channel number of the video source.
  • Page 293 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 294 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 295 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 296 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 297 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 298 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 299 VIVOTEK return <return page> Redirect to the page <return page>after the parameter is assigned. The <return page>can be a full URL path or relative path according to the current path. 8.11 IP Filtering Note: This request requires Administrator access privileges.
  • Page 300 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 301 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 302 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 303 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 304 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 305 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 306 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 307 VIVOTEK Command: update PARAMETER VALUE DESCRIPTION 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.
  • Page 308 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 309 VIVOTEK 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 310 VIVOTEK 400 Bad Request Request is rejected because some parameter values are illegal. 415 Unsupported Media Type Returned, if forcechk appears,when minsft is not achievable or the timeshift feature of the target stream is not enabled. 8.21 RemoteFocus (capability_image_c<0~(n-1)>_remotefocus=1) Note: This request requires Administrator privileges.
  • Page 311 VIVOTEK function zoom, Function type focus, zoom - Move focus motor auto, focus – Move focus motor scan, auto – Perform auto focus scan – Perform focus scan stop, positioning, stop – Stop current operation getstatus positioning – Position the motors getstatus–Information of motors, return value as below:...
  • Page 312 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 313 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 User's Manual - 313...
  • Page 314 VIVOTEK function focus, Function type auto, focus – Move focus motor scan, auto – Perform auto focus stop, scan – Perform focus scan stop – Stop current operation positioning, irisopen, positioning – Position the motors irisenable, resetfocus – reset focus position to default resetfocus, irisopen –...
  • Page 315 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 316 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 317 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 318 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 319 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 320 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 321 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 322 VIVOTEK 8.29 Camera Control (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/camctrl.cgi?[channel=<value>][&camid=<value>] [&move=<value>] – Move home, up, down, left, right [&focus=<value>] – Focus operation [&auto=<value>] – Auto pan, patrol [&zoom=<value>] – Zoom in, out [&zooming=<value>&zs=<value>] – Zoom without stopping, used for joystick [&vx=<value>&vy=<value>&vs=<value>] –...
  • Page 323 VIVOTEK speedzoom -5 ~ 5 Set the zoom speed. speedfocus -5 ~ 5 Set the focus speed. speedapp -5 ~ 5 Set the auto pan/patrol speed. auto Auto pan. patrol Auto patrol. stop Stop camera. zoom wide Zoom larger view with current speed.
  • Page 324 VIVOTEK 8.30 Recall (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET Syntax: http://<servername>/cgi-bin/viewer/recall.cgi? recall=<value>[&channel=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION recall string[30] One of the present positions to recall. channel 0~(capability_nvideoin-1) Channel of the video source. return <return page>...
  • Page 325 VIVOTEK return <return page> Redirect to the page <return page> after the parameter is assigned. The <return page> can be a full URL path or relative path according to the current path. If you omit this parameter, it will redirect to an empty page.
  • Page 326 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 327 VIVOTEK Technical Specifications Technical Specifications 10 Base-T/100 Base-TX/1000 Base-T Ethernet (RJ-45) Model TS6346-EHL *It is highly recommended to use standard CAT5e Interface System Information & CAT6 cables which are compliant with the 3P/ETL standard. Multimedia SoC (System-on-Chip) ONVIF Supported, specification available at www.onvif.org...
  • Page 328 VIVOTEK Technology License Notice MPEG-4 AAC Technology THIS PRODUCT IS LICENSED UNDER THE MPEG-4 AAC AUDIO PATENT LICENSE. THIS PRODUCT MAY NOT BE DECOMPILED, REVERSE-ENGINEERED OR COPIED, EXCEPT WITH REGARD TO PC SOFTWARE, OF WHICH YOU MAY MAKE SINGLE COPIES FOR ARCHIVAL PURPOSES. FOR MORE INFORMATION, PLEASE REFER TO HTTP://WWW.VIALICENSING.COM.
  • Page 329 取扱説明書に従って正しい取り扱いをして下さい 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.

Table of Contents