Vivotek VS8801 User Manual

Vivotek VS8801 User Manual

Video server
Hide thumbs Also See for VS8801:

Advertisement

Rev. 1.3

Advertisement

Table of Contents
loading

Summary of Contents for Vivotek VS8801

  • Page 1 Rev. 1.3...
  • Page 2: Table Of Contents

    Ready to Use ....................13 Accessing the Video Server ..................14 Using Web Browsers ..................14 Using RTSP Players ..................16 Using 3GPP-compatible Mobile Devices ............17 Using VIVOTEK Recording Software ...............18 Main Page ........................19 Client settings ......................22 Configuration ......................25 System ......................26 Security ......................
  • Page 3 VIVOTEK Technology License Notice ................177 Electromagnetic Compatibility (EMC) .............178 User's Manual - 3...
  • Page 4: Revision History

    * Added the Quad View setting options. * Added the joystick configuration options. 3. Rev. 1.2: Added description for VS8801 stating that it does not support the SD card local storage. 4. Rev. 1.3: Updated the URL commands. 4 - User's Manual...
  • Page 5: Overview

    The H.264 compression format drastically reduces the file sizes and conserves valuable bandwidth and storage space. The VS8401 supports simultaneous dual streams, while the VS8801 supports single stream to be transmitted in H.264, MPEG-4 and MJPEG formats for versatile applications. The stream can also be individually configured with frame rates, resolution, and image quality so as to meet different platforms or bandwidth constraints.
  • Page 6: Physical Description

    VIVOTEK Physical Description Front Panel ■ VS8801 BNC Video Input RCA Audio Input ■ VS8401 USB & SD card USB function functions is not available are not available BNC Video Input on this unit. on this unit. RCA Audio Input Back Panel ■...
  • Page 7 VIVOTEK General I/O Terminal Block This video server provides a general I/O terminal block which is used to connect external input / output devices. The pin definitions are described below. ■ VS8801 USB & SD card USB function functions is not available are not available on this unit.
  • Page 8: Status Led

    VIVOTEK DI/DO Diagram Please refer to the following illustration for the connection method. Sensors/detectors Digital Inputs Digital Outputs USB function is not available on this unit. Alarms DC Power Power Source NOTE: ► External alarms or other devices that connect to the digital outputs require external power supply, e.g., DC power from a power adapter.
  • Page 9 Blinking Red every 0.15 sec. + Blinking Green every Upgrading Firmware 1 sec. Blinking Red every 0.15 sec. + Blinking Green every Restoring default 0.15 sec. Hardware Reset ■ VS8801 USB & SD card USB function functions is not available are not available on this unit.
  • Page 10: Network Deployment

    VIVOTEK Network Deployment Setting up the Video Server over the Internet This section explains how to configure the video server to an Internet connection. 1. Make video connection from the camera to the BNC video input. 2. Make audio connection from the Line-Out audio source to the RCA audio input.
  • Page 11 VIVOTEK Internet connection via a router Before setting up the video server over the Internet, make sure you have a router and follow the steps below. 1. Connect your video server behind a router, the Internet environment is illustrated below.
  • Page 12: 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. 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 13: Ready To Use

    VIVOTEK Ready to Use 1. A browser session with the Video Server should prompt as shown below. 2. You should be able to see live video from your camera. You may also install the 32-channel recording software from the software CD in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents.
  • Page 14: Accessing The Video Server

    3. The live video will be displayed in your web browser. 4. If it is the first time installing the VIVOTEK video server, an information bar will pop up as shown below. Follow the instructions to install the required plug-ins on your computer.
  • Page 15 VIVOTEK ® 2. Look for Download signed ActiveX controls; select Enable or Prompt. Click OK. ® 3. Refresh your web browser, then install the Active X control. Follow the instructions to complete installation. User's Manual - 15...
  • Page 16: Using Rtsp Players

    VIVOTEK Using RTSP Players To view the MPEG-4 streaming media using RTSP players, you can use one of the following players that support RTSP streaming. Quick Time Player Real Player VLC media player 1. Launch the RTSP player. mpegable Player 2.
  • Page 17: Using 3Gpp-Compatible Mobile Devices

    VIVOTEK Using 3GPP-compatible Mobile Devices To view the streaming media through 3GPP-compatible mobile devices, make sure the video server can be accessed over the Internet. For more information on how to set up the video server over the Internet, please refer to Setup the video server over the Internet on page 10.
  • Page 18: 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 video servers. Please install the recording software; then launch the program to add the video server to the Channel list. For detailed information about how to use the recording software, please refer to the user’s manual of the software or download it from...
  • Page 19: Main Page

    26. Camera Control Area Video Stream: VS8401 supports 4 channels for video live viewing, as VS8801 supports 8 channels. Each channel allows you to view only one stream. There are channel1,2,3,4,(5,6,7,8),and Quad View for you to choose. For more information about video settings, please refer to page 56 for detailed information.
  • Page 20 DI/O Control Area Digital output: There are 4 (VS8401) or 8 (VS8801) digital output switches; click to turn the digital output device on or off. Switch 1 is for channel 1 digital output control, switch 2 is for channel 2 digital output control, and so on.
  • Page 21 VIVOTEK Title and Time: The video title and time can be stamped on the streaming video. For further configuration, please refer to Video settings on page 56. Video and Audio Control Buttons: Depending on the video server model and video server configuration, some buttons may not be available.
  • Page 22: Client Settings

    VIVOTEK Client settings This chapter explains how to select the stream transmission mode and saving options on the local computer. When completed with the settings on this page, click Save on the page bottom to enable the settings. H.264 / MPEG-4 media options Select to stream video or audio data or both.
  • Page 23 VIVOTEK MP4 saving options Users can record live video as they are watching it by clicking Start MP4 Recording on the main page. Here, you can specify the storage destination and file name. Folder: Specify a storage destination for the recorded video files.
  • Page 24 VIVOTEK Joystick settings Calibrate: Make sure a joystick is already attached to your COM port or USB port on your client computer. Click on the Calibrate button and the Windows Game Controller function will be started. If properly connected, your operating system should have already detected the joystick. Follow the onscreen instructions to calibrate your joystick.
  • Page 25: Configuration

    Click Configuration on the main page to enter the camera setting pages. Note that only Administrators can access the configuration page. VIVOTEK offers an easy-to-use user interface that helps you set up your video server with minimal effort. To simplify the setting procedure, two types of user interfaces are available: Advanced Mode for professional users and Basic Mode for entry-level users.
  • Page 26: System

    VIVOTEK Advanced mode Configuration List Click to switch to Basic Mode Firmware Version Each function on the configuration list will be explained in the following sections. Those functions that are displayed only in Advanced Mode are marked with Advanced mode . If you want to set up advanced...
  • Page 27 VIVOTEK System time Keep current date and time: Select this option to preserve the current date and time of the Video server. The video server’s internal real-time clock maintains the date and time even when the power of the system is turned off.
  • Page 28: Security

    VIVOTEK Security 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 29: Https (Hypertext Transfer Protocol Over Ssl)

    VIVOTEK HTTPS (Hypertext Transfer Protocol over SSL) Advanced Mode 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. Enable HTTPS Check this item to enable HTTPS communication, then select a connection option: "HTTP & HTTPS"...
  • Page 30 VIVOTEK 4. The Certificate Information will automatically de displayed in the third column as shown below. You can click Property to view detailed information about the certificate. 5. Click Home to return to the main page. Change the address from “http://” to “https://“ in the address bar and press Enter on your keyboard.
  • Page 31 VIVOTEK Create self-signed certificate manually 1. Select this option. 2. Click Create to open the Create Certificate page, then click Save to generate the certificate. 3. The Certificate Information will automatically be displayed in the third column as shown below. You can click Property to see detailed information about the certificate.
  • Page 32 VIVOTEK 3. If you see the following Information bar, click OK and click on the Information bar at the top of the page to allow pop-ups. 4. The pop-up window shows an example of a certificate request. 32 - User's Manual...
  • Page 33 VIVOTEK 5. Look for a trusted certificate authority that issues digital certificates. Enroll the video server. Wait for the certificate authority to issue a SSL certificate; click Browse... to search for the issued certificate, then click Upload in the second column.
  • Page 34: Snmp (Simple Network Management Protocol)

    VIVOTEK SNMP (Simple Network Management Protocol) Advanced Mode This section explains how to use the SNMP on the video server. 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 35: Network

    Use fixed IP address: Select this option to manually assign a static IP address to the video server. 1. You can make use of VIVOTEK Installation Wizard 2 on the software CD to easily set up the Network Camera on LAN. Please refer to Software Installation on page 12 for details.
  • Page 36 VIVOTEK Primary DNS: The primary domain name server that translates hostnames into IP addresses. Secondary DNS: Secondary domain name server that backups the Primary DNS. Primary WINS server: The primary WINS server that maintains the database of computer name and IP address.
  • Page 37 VIVOTEK NOTE: ► If the default ports are already used by other devices connected to the same router, the video server will select other ports for the video server. ► If UPnP is not supported by your router, you will see the following message: Error: Router does not support UPnP port forwarding.
  • Page 38 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 39 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 40 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 41 Authentication server (usually a RADIUS server): Checks the client certificate and decides whether to accept the end user’s access request. ■ VIVOTEK video servers 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 42 VIVOTEK 3. When all settings are complete, move the video server to the protected LAN by connecting it to an 802.1x enabled switch. The devices will then start the authentication automatically. NOTE: ► The authentication process for 802.1x: 1. The Certificate Authority (CA) provides the required signed certificates to the video server (the supplicant) and the RADIUS Server (the authentication server).
  • Page 43 VIVOTEK QoS (Quality of Service) Advanced Mode 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 44 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 45 Access name for channel 1~4/8: VS8401 supports 4 channels for video live viewing, as VS8801 supports 8 channels. Each channel allows you to view only one stream. The access name is used to differentiate the streaming source. Users can go to Configuration > Audio and video > Video settings to set up the video quality of linked streams.
  • Page 46 VIVOTEK URL command -- http://<ip address>:<http port>/<access name for channel 1 ~ 4/8> For example, when the Access name for stream 2 is set to video2.mjpg: 1. Launch Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter.
  • Page 47 To stop talking, click again. 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 48 Basic Digest Access name for channel 1 ~4/8: VS8401 supports 4 channels for video live viewing, as VS8801 supports 8 channels. Each channel allows you to view only one stream. The access name is used to differentiate the streaming source.
  • Page 49 VIVOTEK RTSP port /RTP port for video, audio/ RTCP port for video, audio ■ RTSP (Real-Time Streaming Protocol) controls the delivery of streaming media. By default, the port number is set to 554. ■ The RTP (Real-time Transport Protocol) is used to deliver video and audio data to the clients. By default, the RTP port for video is set to 5556 and the RTP port for audio is set to 5558.
  • Page 50: Express Link

    VIVOTEK Express link Express link is a free service provided by VIVOTEK server, which allows users to register an domain name for a network device. One URL can only be mapped to one Mac address. This service will check out if the host name is valid and automatically open a port on your router.
  • Page 51: Ddns

    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 video servers from the Internet.
  • Page 52 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 53: Access List

    VIVOTEK Access list Advanced Mode This section explains how to control access permission by verifying the client PC’s IP address. General settings Maximum number of concurrent streaming connection(s) limited to: Simultaneous live viewing for 1~10 clients (including stream 1 and stream 2). 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 Explore or Quick Time Player).
  • Page 54 VIVOTEK ■ Refresh: Click this button to refresh all current connections. ■ Add to deny list: You can select entries from the Connection Status list and add them to the Deny List to deny access. Please note that those checked connections will only be disconnected temporarily and will automatically try to re-link again (IE Explore or Quick Time Player).
  • Page 55: Digital I/O

    VIVOTEK Digital I/O This section explains how to change digital input and digital output settings. Digital input settings You can select High or Low to define normal status for the digital input. The video server will report the current status.
  • Page 56: Audio And Video

    VIVOTEK Audio and video This section explains how to cofigure the audio and video settings of the video server. Overview This table shows all stream settings of each channel. Video settings Channel: In the drop-down list, there are channel 1~4/8, select one to set video settings on it in the column below.
  • Page 57 This function can work seamlessly with VIVOTEK’s ST7501 recording software. When an event occurs, the recording software can request time shift cache stream from the camera, which allows the user to retrieve pre-event video data.
  • Page 58 VIVOTEK Advanced Mode Image settings Click Image Settings to open the Image Settings page. On this page, you can tune the White balance, Brightness, Saturation, Contrast, and Sharpness settings for the video. Please choose the Channel first. Image adjustment ■ Brightness: To adjust the image brightness level, please drag the slider bar to the right (+) to increase the effect, or to the left (-) to reduce the effect.
  • Page 59 VIVOTEK ■ Enable deinterlace: Check to enable deinterlace, and choose Adaptive mode or Blend mode in the drop-down list. Adaptive mode provides the best image quality, while Blend mode provides better image quality (than not using the deinterlace function at all). Note that applying this function to all channels at the same time will consume quite a lot computing power.
  • Page 60 VIVOTEK ■ To set the privacy mask windows, follow the steps below: 1. Click New to add a new window. 2. Use the mouse to size and drag-drop the window, which is recommended to be at least twice the size of the object (height and width) you want to cover.
  • Page 61 VIVOTEK NOTE: ► Aspect ratio correction doesn’t support QCIF. ► When aspect ratio correction takes effect, the frame size for D1 will be adjusted to 640x480. This video server offers real-time H.264, MPEG-4, and MJPEG compression standards (Triple Codec) for real-time viewing.
  • Page 62 VIVOTEK JPEG mode is selected, the video server continuously sends 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 63 VIVOTEK ■ Available FPS Check Check frame rate to display the current available frame rate status (Available FPS). Available FPS provides the information of the unused encoding capability with available frame rate in different frame size. The embedded Soc (System-on-Chip) has limited encoding capability, so you may set the video quality according to the available FPS.
  • Page 64: Audio Settings

    VIVOTEK the frame rate that cannot be reached is marked in red color. Audio settings Mute: Select this option to disable audio transmission from the video server to all clients. Note that if mute mode is turned on, no audio data will be transmitted even if audio transmission is enabled on the Client Settings page.
  • Page 65: Motion Detection

    VIVOTEK Motion detection This section explains how to configure the Video Server to enable motion detection. A total of three motion detection windows can be configured for each channel. Follow the steps below to enable motion detection: 1. Select Channel.
  • Page 66 VIVOTEK A green bar indicates that even though motions have been detected, the event has not been triggered because the image variations still fall under the defined threshold. Percentage = 30% This motion detection window will also be displayed on the Event Settings page. You can go to Application >...
  • Page 67: Camera Tampering Detection

    VIVOTEK Percentage is a value that expresses the proportion of “alerted pixels” to all pixels in the motion detection window. In this case, 50% of pixels are identified as “alerted pixels”. When the percentage is set to 30%, the motions are judged to exceed the defined threshold; therefore, the motion window will be outlined in red.
  • Page 68: Camera Control

    Transparent HTTP Tunnel. The UART commands will be sent through HTTP tunnel established between the RS-485 device and the linked camera. For detailed application notes, please refer to URL Commands on page 105 or http://www.vivotek.com/downloadfiles/support/faq/172_document_2.pdf. 68 - User's Manual...
  • Page 69: Preset Positions

    VIVOTEK Preset positions If you select DynaDome/SmartDOME, Lilin PIH-7x00, or Pelco D, Pelco P protocol, Samsung scc643 protocol protocol as the PTZ driver and click the Save button, the Preset Position button will be enabled. Click Preset Position to open the settings page. You can also select preset positions for the camera to patrol.
  • Page 70 VIVOTEK ■ Home location settings: You can configure the Home location by clicking on Set current position as home. Click on Restore home position to default, and the Home position will be set as the center position. ■ The Camera Control Panel and Preset positions will be displayed on the home page: ■...
  • Page 71 VIVOTEK Camera ID settings VIVOTEK offers five PTZ drivers: DynaDome/SmartDOME, Lilin PIH-7x00, Pelco D protocol, Pelco P protocol, and Samsung scc643 protocol. If none of the above PTZ drivers is supported by your PTZ scanner, please select Custom camera (scanner). Please refer to the user’s manual of your PTZ scanner to determine the Camera ID, PTZ driver, and Port settings.
  • Page 72 VIVOTEK Patrol settings You can select some preset positions for the Network Camera to patrol. Please follow the steps below to set up a patrol schedule: 1. Select Channel in the drop-down list. 2. Select the preset locations on the list, and click 3.
  • Page 73 VIVOTEK Custom Command If Custom Camera (scanner) is selected as the PTZ driver, the Preset Position and PTZ Control Panel on the main page will be disabled. You will need to configure command buttons to control the PTZ scanner. Click Custom Command to open the Custom Command page to set the commands in the Control Settings session.
  • Page 74 VIVOTEK ►The command buttons will be displayed on the main page: 74 - User's Manual...
  • Page 75: Homepage Layout

    Theme Options (the third column on this page). The settings will be displayed automatically in this Preview field. The following shows the homepage using the default settings: ■ Hide Powered by VIVOTEK: If you check this item, it will be removed from the homepage. Logo Here you can change the logo at the top of your homepage.
  • Page 76 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 77 VIVOTEK ■ Follow the steps below to set up the customed homepage: 1. Click Custom on the left column. 2. Click the field where you want to change the color on the right column. Color Selector Custom Pattern 3. The palette window will pop up as shown below.
  • Page 78: Application

    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 pop up. If you need more information, please contact VIVOTEK’s technical support. 20110224...
  • Page 79 VIVOTEK Event settings In the Event settings column, click Add to open the Event settings page. On this page, you can arrange three elements -- Trigger, Schedule, and Action to set an event. A total of 3 event settings can be configured.
  • Page 80 VIVOTEK ■ System boot This option triggers the video server when the power to the video server is disconnected. ■ Video motion detection This option makes use of the built-in motion detection mechanism as a trigger source. To enable this function, you need to configure a Motion Detection Window first.
  • Page 81 VIVOTEK ■ Periodically This option allows the video server to trigger periodically for every other defined minute. Up to 999 minutes are allowed. ■ Digital input This option allows the video server to use an external digital input device or sensor as a trigger source.
  • Page 82 VIVOTEK Action Define the actions to be performed by the video server when a trigger is activated. ■ Trigger digital output for seconds Check the desired DO to turn on the external digital output device when a trigger is activated. Specify the length (seconds) of the trigger interval in the text box.
  • Page 83 VIVOTEK Here is an example of the Event settings page: When completed, click Save to enable the settings and click Close to exit Event Settings page. The new Event settings / Server settings / Media settings will appear in the event drop-down list on the Application page.
  • Page 84 VIVOTEK Here is an example of the Application page with an event setting: When the Event Status is ON, once an event is triggered by motion detection, the video server will automatically send snapshots via e-mail. status or click Delete to remove...
  • Page 85: Server Settings

    VIVOTEK Server settings Click Server on Event Settings page to open the Server Setting page. On this page, you can specify where the notification messages are sent when a trigger is activated. A total of 5 server settings can be configured.
  • Page 86 VIVOTEK FTP: Select to send the media files to an FTP server when a trigger is activated. ■ Server address: Enter the domain name or IP address of the FTP server. ■ Server port By default, the FTP server port is set to 21. It can also be assigned to another port number between 1025 and 65535.
  • Page 87 VIVOTEK HTTP: Select to send the media files to an HTTP server when a trigger is activated. ■ URL: Enter the URL of the HTTP server. ■ User name: Enter the user name if necessary. ■ Password: Enter the password if necessary.
  • Page 88: Media Settings

    VIVOTEK Media settings Click Media on the Event Settings page to open the Media Settings page. On this page, you can specify the type of media that will be sent when a trigger is activated. A total of 5 media settings can be configured.
  • Page 89 VIVOTEK Video clip: Select to send video clips when a trigger is activated. ■ Channel: The video source. The stream source will be identical to the preset time shift caching stream. For more information about time shift caching stream, please refer to page 57.
  • Page 90 VIVOTEK You can continue to select a server and media type for the event. Please go back to page 79 for detailed information. ■ Enable customized folder: Create folders by date, time, and hour automatically: If you check this item, the system will generate folders automatically by date.
  • Page 91 VIVOTEK Click 20110120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2011/01/20 2011/01/20 Click to go back to the previous Click to delete level of the directory selected items Click to delete all...
  • Page 92: Recording > Recording Settings

    VIVOTEK Recording > Recording settings Advanced Mode This section explains how to configure the recording settings for the Video Server. Recording Settings Insert your SD card and click here to test (VS8401 only) NOTE: ► Please remember to format your SD card when using it for the first time. Please refer to page 109 for detailed information.
  • Page 93 VIVOTEK If you enalbe the adaptive recording and enable time-shift cache stream on Camera A, only when an event takes place on Camera A will the server records the streaming data at the full frame rate. This methodology only requires transferring the Intra frame data during normal operation, and full-frame-rate videos in the occurrences of events, and thus saving users of network bandwidth and storage space.
  • Page 94 VIVOTEK Please follow steps 1 to 2 below to set up a recording setting: 1. Trigger Select a triggering condition: For example, event triggers might not make sense in a place full of human traffic during the office hours. You may want to enable the triggering conditions during the night.
  • Page 95 VIVOTEK ■ 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. The reserved space is used for cyclic recording to prevent malfunctions that might occur during the transaction stage when the video feeds are about to fill up the storage space.
  • Page 96: Local Storage > Sd Card Management (For Vs8401 Only)

    VIVOTEK Local storage > SD card management (for VS8401 only) This section explains how to manage the local storage on the Network Camera. Here you can view SD card status, and implement SD card control. SD card staus This column shows the status and reserved space of your SD card. Please remember to format the SD card when using for the first time.
  • Page 97: Local Storage > Content Management

    VIVOTEK Local storage > Content management This section explains how to manage the content of recorded videos on the Network Camera. Here you can search and view the records and view the searched results. Searching and Viewing the Records This column allows the user to set up search criteria for recorded data. If you do not select any criteria and click Search button, all recorded data will be listed in the Search Results cloumn.
  • Page 98 VIVOTEK ■ View: Click on a search result which will highlight the selected item in purple as shown above. Click the View button and a media window will pop up to play back the selected file. For example: Click to adjust the image size ■...
  • Page 99: System Log

    VIVOTEK System log Advanced Mode This section explains how to configure the video server to send the system log to the remote server as backup. Remote log You can configure the video server to send the system log file to a remote server as a log backup.
  • Page 100: View Parameters

    VIVOTEK View parameters Advanced Mode The View Parameters page lists the entire system’s parameters in alphabetical order. If you need technical assistance, please provide the information listed on this page. 100 - User's Manual...
  • Page 101: Maintenance

    VIVOTEK Maintenance This chapter explains how to restore the video server to factory default, upgrade firmware version, etc. Reboot This feature allows you to reboot the video server, which takes about one minute to complete. When completed, the live video page will be displayed in your browser. The following message will be displayed during the reboot process.
  • Page 102 VIVOTEK Export / Upload Files Advanced Mode This feature allows you to Export / Upload daylight saving time rules, custom language files, and setting backup files. Export daylight saving time configuration file: Click to set the start and end time of DST.
  • Page 103 Note: Do not power off the video server 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 104 VIVOTEK The following message is displayed when the upgrade has succeeded. Reboot system now!! This connection will close. The following message is displayed when you have selected an incorrect firmware file. Starting firmware upgrade... Do not power down the server during the upgrade.
  • Page 105: Appendix

    VIVOTEK Appendix URL Commands for the Network Camera/Video Server 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 106: General Cgi Url Syntax And Parameters

    VIVOTEK URL Command Document for VS8401-VVTK 3. General CGI URL Syntax and Parameters When the CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server. The CGIs are organized in functionally-related directories under the cgi-bin directory.
  • Page 107: Security Level

    VIVOTEK URL Command Document for VS8401-VVTK 4. Security Level SECURITY SUB-DIRECTORY DESCRIPTION LEVEL anonymous Unprotected. 1 [view] anonymous, viewer, 1. Can view, listen, talk to camera. dido, camctrl 2. Can control DI/DO, PTZ of the camera. 4 [operator] anonymous, viewer, Operator access rights can modify most of the camera’s...
  • Page 108 VIVOTEK URL Command Document for VS8401-VVTK 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>]. If you do not specify any parameters, all the parameters on the server will be returned.
  • Page 109 VIVOTEK URL Command Document for VS8401-VVTK Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network_ipaddress=192.168.0.123\r\n User's Manual - 109...
  • Page 110: Set Server Parameter Values

    VIVOTEK URL Command Document for VS8401-VVTK 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/operator/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/admin/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] PARAMETER...
  • Page 111 VIVOTEK URL Command Document for VS8401-VVTK Only the parameters that you set and are readable will be returned. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123 Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network_ipaddress=192.168.0.123\r\n User's Manual - 111...
  • Page 112: Available Parameters On The Server

    URL Command Document for VS8401-VVTK 7. Available parameters on the server This chapter defines all the parameters which can be configured or retrieved from VIVOTEK network camera or video server. The general format of description is listed in the table below...
  • Page 113 VIVOTEK URL Command Document for VS8401-VVTK Group: system NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) hostname string[40] “Video Host name of server Server” (Network Camera, Wireless Network Camera, Video Server, Wireless Video Server). ledoff <boolean> Turn on (0) or turn off (1) all led indicators.
  • Page 114 VIVOTEK URL Command Document for VS8401-VVTK Midway Island, Samoa -400: GMT-10:00 Hawaii -360: GMT-09:00 Alaska -320: GMT-08:00 Las Vegas, San_Francisco, Vancouver -280: GMT-07:00 Mountain Time, Denver -281: GMT-07:00 Arizona -240: GMT-06:00 Central America, Central Time, Mexico City, Saskatchewan -200: GMT-05:00...
  • Page 115 VIVOTEK URL Command Document for VS8401-VVTK -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 80: GMT 02:00...
  • Page 116 VIVOTEK URL Command Document for VS8401-VVTK Tbilisi, Yerevan 180: GMT 04:30 Kabul 200: GMT 05:00 Ekaterinburg, Islamabad, Karachi, Tashkent 220: GMT 05:30 Calcutta, Chennai, Mumbai, New Delhi 230: GMT 05:45 Kathmandu 240: GMT 06:00 Almaty, Novosibirsk, Astana, Dhaka, Sri Jayawardenepura...
  • Page 117 VIVOTEK URL Command Document for VS8401-VVTK Magadan, Solomon Is., New Caledonia 480: GMT 12:00 Auckland, Wellington, Fiji, Kamchatka, Marshall Is. 520: GMT 13:00 Nuku’alofa daylight_enable <boolean> Enable automatic daylight saving time in time zone. daylight_auto_begintime string[19] NONE Display the current daylight saving start time.
  • Page 118 VIVOTEK URL Command Document for VS8401-VVTK <value> seconds. reset Restart the server <positive integer> after <value> seconds if <value> is non-negative. restoreexceptnet <Any value> Restore the system parameters to default values except (ipaddress, subnet, router, dns1, dns2, pppoe). This command can cooperate with other “restoreexceptXYZ”...
  • Page 119 VIVOTEK URL Command Document for VS8401-VVTK parameters to default values except the custom language file the user has uploaded. This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.
  • Page 120 VIVOTEK URL Command Document for VS8401-VVTK Deutsch, Español, Français, Italiano, 日本語, Português, 简体中文, 繁體中文 customlanguage_maxcount <integer> Maximum number of custom languages supported on the server. customlanguage_count <integer> Number of custom languages which have been uploaded to the server. customlanguage_i<0~(max string Custom language name.
  • Page 121 VIVOTEK URL Command Document for VS8401-VVTK 0 => Inactive 1 => Active (capability.nvi > 0) 7.3 digital input behavior define Group: di_i<0~(ndi-1)> (capability.ndi > 0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) normalstate high, high Indicates open circuit or closed circuit (inactive status) 7.4 digital output behavior define...
  • Page 122 VIVOTEK URL Command Document for VS8401-VVTK operator, admin user_i<1~20>_ viewer, <blank> User privilege privilege operator, admin 7.6 network Group: network NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) preprocess <positive NULL An 32-bit integer, each bit can be set separately as integer>...
  • Page 123 VIVOTEK URL Command Document for VS8401-VVTK ipaddress <ip 192.168.0.9 IP address of server. address> subnet <ip <blank> Subnet mask. address> router <ip <blank> Default gateway. address> dns1 <ip <blank> Primary DNS server. address> dns2 <ip <blank> Secondary DNS server. address>...
  • Page 124 VIVOTEK URL Command Document for VS8401-VVTK Represented in EPOCH privatekey_size <integer> Private key file size (in bytes) 7.6.2 QOS Subgroup of network: qos_cos (capability.protocol.qos.cos > 0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable CoS (IEEE 802.1p) vlanid 1~4095...
  • Page 125 VIVOTEK URL Command Document for VS8401-VVTK address setting. 7.6.4 FTP Subgroup of network: ftp NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) port 21, 1025~65535 Local ftp server port. 7.6.5 HTTP Subgroup of network: http NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) port 80, 1025 ~ HTTP port.
  • Page 126 VIVOTEK URL Command Document for VS8401-VVTK Besides, we map the first stream of each channel: network_http_c<0~(n-1)>_s0_accessname to network_http_s<0~(n-1)>_accessname and map the second stream of each channel: network_http_c<0~(n-1)>_s1_accessname to network_http_s<n~(n*2-1)>_accessname and so on. Take VS8401 as an example, channel 1 stream 1: network_http_c0_s0_accessname is mapped to network_http_s0_accessname and channel 1 stream 2: network_http_c0_s1_accessname is mapped to network_http_s4_accessname.
  • Page 127 VIVOTEK URL Command Document for VS8401-VVTK and so on. s1_accessname string[32] “live1-2.sdp” RTSP access name for channel c for c = 1. stream 2. “live2-2.sdp” (capability.protocol.rtsp=1 and for c = 2, capability.nmediastream > 1) and so on. For compatibility, network_rtsp_s<0~(t-1)>_accessname are reserved, t = n*m for n channel products, and m is stream number per channel.
  • Page 128 VIVOTEK URL Command Document for VS8401-VVTK channel 2 stream 2, and so on. For stream 3 of all channels: 239.128.1.(99+n*2) for channel 1 stream 3. 239.128.1.(100+n*2) for channel 2 stream 3, and so on. videoport 1025 ~ 65535 For stream 1 of all Multicast video port.
  • Page 129: Sip Port

    VIVOTEK URL Command Document for VS8401-VVTK 7.6.8 SIP port Subgroup of network: sip (capability.protocol.sip> 0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) port 1025 ~ 65535 5060 SIP port. 7.6.9 RTP port Subgroup of network: rtp NAME VALUE DEFAULT SECURIT DESCRIPTION...
  • Page 130 VIVOTEK URL Command Document for VS8401-VVTK 0 => allow 1 => deny ipv4list_i<0~9> Single address: IPv4 address list. <blank> <ip address> Network address: <ip address / network mask> Range address:<start ip address - end ip address> ipv6list_i<0~9> String[44] IPv6 address list.
  • Page 131 VIVOTEK URL Command Document for VS8401-VVTK operation; 0(not support), 1(support) Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 => Support focus operation; 0(not support), 1(support) text string[16] <blank> Enclose caption. imprinttimestamp <boolean> Overlay time stamp and enclose caption on video.
  • Page 132 VIVOTEK URL Command Document for VS8401-VVTK 1 = worst quality, 5 = best quality. s<0~(m-1)>_mpeg4_qvalue 1~31 Manual video quality level input. (s<0~(m-1)>_mpeg4_quant = 0, 99) *Note: This is reserved for campatibility, and we recommend changing to use “s<0~(m-1)>_mpeg4_qperce nt”. s<0~(m-1)>_mpeg4_qpercent 1~100 Set quality by percentage.
  • Page 133 VIVOTEK URL Command Document for VS8401-VVTK campatibility, and we recommend changing to use “s<0~(m-1)>_h264_qpercen t”. s<0~(m-1)>_h264_qpercent 1~100 Set quality by percentage. 1: Worst quality 100: Best quality (s<0~(m-1)>_h264_quant = 100) s<0~(m-1)>_h264_bitrate 1000~4000000 512000 Set bit rate in bps when choosing cbr in “ratecontrolmode”.
  • Page 134 VIVOTEK URL Command Document for VS8401-VVTK fps (for JPEG). 7.9 Image setting per channel Group: image_c<0~(n-1)> for n channel products NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) brightness -5 ~ 5, 100 Adjust brightness of image according to mode settings. 100 means using “brightnesspercent”.
  • Page 135 VIVOTEK URL Command Document for VS8401-VVTK changing to use “sharpnesspercent”. brightnesspercent 0 ~ 100 Adjust brightness of image by percentage. Darker 0 <-> 100 Brighter saturationpercent 0 ~ 100 Adjust saturation of image by percentage. Less 0 <-> 100 More saturation...
  • Page 136: Motion Detection Settings

    VIVOTEK URL Command Document for VS8401-VVTK 7.10 Audio input per channel Group: audioin_c<0~(n-1)> for n channel products (capability.audioin>0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) mute 0, 1 Enable audio mute. gain 0~15 Gain of input. s0_g711_mode pcmu, pcmu Set G.711 mode.
  • Page 137 VIVOTEK URL Command Document for VS8401-VVTK win_i<0~2>_sensitivity 0 ~ 100 Sensitivity of motion detection window. 7.13 Tempering detection settings Group: tampering_c<0~(n-1)> for n channel product (capability.tampering > 0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable tamper detection.
  • Page 138 VIVOTEK URL Command Document for VS8401-VVTK 7.15 UPnP presentation Group: upnppresentation NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP presentation service. 7.16 UPnP port forwarding Group: upnpportforwarding NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean>...
  • Page 139 VIVOTEK URL Command Document for VS8401-VVTK by express link. 7.18 System log Group: syslog NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enableremotelog <boolean> Enable remote log. serverip <IP address> <blank> Log server IP address. serverport 514, 1025~65535 514 Server port used for log.
  • Page 140 VIVOTEK URL Command Document for VS8401-VVTK is UART (capability.nuart>0). count cameraid 0~255 Camera ID controlling external PTZ camera. hometype <boolean> The attribute defines whether the HOME command emulation is enabled. 0: Use the preset position 0 as the home position 1: Use HOME command (if the camera supports it.)
  • Page 141 VIVOTEK URL Command Document for VS8401-VVTK (get/set) baudrate 110,300,600,120 9600 Set baud rate of COM port. 0,2400,3600,480 0,7200,9600,192 00,38400,57600, 115200 databit 5,6,7,8 Data bits in a character frame. paritybit none, none For error checking. odd, even stopbit 2-1.5 , data bit is 5...
  • Page 142 Hyperlink of the logo vivotek.co logo_powerbyvvtk_hidden <boolean> 0 => display the power by vivotek logo 1 => hide the power by vivotek logo theme_option 1~3: One of the default themes. 4: Custom definition. theme_color_font string[7] #ffffff Font color...
  • Page 143: Privacy Mask

    VIVOTEK URL Command Document for VS8401-VVTK theme_color_videobackground string[7] #565656 Background color of video area. theme_color_case string[7] #323232 Frame color custombutton_manualtrigger_s <boolean> Show or hide manual trigger (VI) button in homepage 0 -> Hidden 1 -> Visible 7.23 Privacy mask Group: privacymask_c<0~(n-1)> for n channel product...
  • Page 144 VIVOTEK URL Command Document for VS8401-VVTK npir Number of PIRs. <positive integer> Number of digital inputs. <positive integer> Number of virtual inputs <positive (manual trigger) integer> Number of digital outputs. <positive integer> naudioin Number of audio inputs. <positive integer> naudioout Number of audio outputs.
  • Page 145 VIVOTEK URL Command Document for VS8401-VVTK Bit 1 => Built-in or external camera; 0(external), 1(built-in) Bit 2 => Support pan operation, 0(not support), 1(support) Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 =>...
  • Page 146 VIVOTEK URL Command Document for VS8401-VVTK The rest may be deduced by analogy lens_pan 0, <positive A 32-bit integer, each bit integer> can be set separately as follows: Bit 0 => Support pan. Bit 1 => Support pan in UI.
  • Page 147 VIVOTEK URL Command Document for VS8401-VVTK integer> can be set separately as follows: Bit 0 => Support iris. Bit 1 => Support iris in UI. Bit 2 => External or build-in iris function; 0(build-in), 1(external). Bit 3 => Support auto iris in npreset 0, <positive...
  • Page 148 VIVOTEK URL Command Document for VS8401-VVTK protocol_ieee8021x <boolean> Indicate whether to support IEEE802.1x. protocol_qos_cos <boolean> Indicate whether to support CoS. protocol_qos_dscp <boolean> Indicate whether to support QoS/DSCP. protocol_ddns <boolean> Indicate whether to support DDNS. videoin_type 0, 1, 2 0 => Interlaced CCD 1 =>...
  • Page 149 VIVOTEK URL Command Document for VS8401-VVTK headphone output. audioin_codec aac4, gamr, g711 Available codec list for g711 audio input. uart_httptunnel <boolean> Indicate whether to support HTTP tunnel for UART transfer. camctrl_httptunnel <boolean> The attribute indicates whether sending camera control commands through HTTP tunnel is supported.
  • Page 150 VIVOTEK URL Command Document for VS8401-VVTK event/control transfer. joystick <boolean> Indicate whether to support joystick control. storage_dbenabled <boolean> Media files are indexed in database. nanystream 0, <positive number of any media integer> stream per channel <boolean> Indicate whether to support...
  • Page 151 VIVOTEK URL Command Document for VS8401-VVTK 7.26 Event setting Group: event_i<0~2> PARAMETER VALUE Default SECURITY DESCRIPTION (get/set) name string[40] NULL Identification of this entry. enable 0, 1 Enable or disable this event. priority 0, 1, 2 Indicate the priority of this event: “0”...
  • Page 152 VIVOTEK URL Command Document for VS8401-VVTK tampering 0 ~ 255 Indicate the source of the tampering detection. Each bit represents one channel, and the LSB indicates channel 1. visignal 0 ~ 255 Indicate the source of video input signal loss. Each bit represents one channel, and the LSB indicates channel 1.
  • Page 153 VIVOTEK URL Command Document for VS8401-VVTK action_do_i<0~(ndo-1)> 0, 1 Enable or disable trigger digital _enable output. action_do_i<0~(ndo-1)> 1~999 Duration of the digital output trigger _duration in seconds. action_do_i<0~(ndo-1)> 0~999 The delay time needed before _delay triggering the digital output (in seconds) action_goto_c<0~(nvideo...
  • Page 154 VIVOTEK URL Command Document for VS8401-VVTK action_server_i<0~4>_fo string[40] %Y%M%D% The template of the folder name to be ldername created. Slashes can be used in the template, and following placeholders can also be used: %Y: Year (e.g. 2010) %M: Month %D: Date %H: Hour 7.27 Server setting for event action...
  • Page 155 VIVOTEK URL Command Document for VS8401-VVTK email_senderemail string[128] NULL Email address of the sender. email_recipientemail string[128] NULL Email address of the recipient. ns_location string[128] NULL Location to upload or store the media. ns_username string[64] NULL Username to log in to the server.
  • Page 156 VIVOTEK URL Command Document for VS8401-VVTK videoclip_source <integer> 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 157 VIVOTEK URL Command Document for VS8401-VVTK cyclic 0: Disable cyclic recording 1: Enable cyclic recording notify 0: Disable recording notification 1: Enable recording notification notifyserver 0~31 Indicate which notification server is scheduled. One bit represents one application server (server_i0~i4). bit0 (LSB) = server_i0.
  • Page 158 VIVOTEK URL Command Document for VS8401-VVTK reserveamount 0~15000000 The reserved amount in Mbytes when choosing cyclic recording mechanism. dest The destination to store the recorded data. “cf” means local storage (CF or SD card). “0” means the index of the network storage.
  • Page 159 VIVOTEK URL Command Document for VS8401-VVTK request and install. status -3 ~ 1 Specify the https status. -3 = Certificate not installed -2 = Invalid public key -1 = Waiting for certificate 0 = Not installed 1 = Active countryname...
  • Page 160: Drive The Digital Output

    VIVOTEK URL Command Document for VS8401-VVTK 8. Useful Functions 8.1 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 161 VIVOTEK URL Command Document for VS8401-VVTK where <state> can be 0 or 1. Example: Query the status of digital input 1 . Request: http://myserver/cgi-bin/dido/getdi.cgi?di1 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n di1=1\r\n 8.3 Query Status of the Digital Output (capability.ndo >...
  • Page 162: Capture Single Snapshot

    VIVOTEK URL Command Document for VS8401-VVTK Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n do1=1\r\n 8.4 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.
  • Page 163: Account Management

    VIVOTEK URL Command Document for VS8401-VVTK 8.5 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 164: System Logs

    VIVOTEK URL Command Document for VS8401-VVTK 8.6 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 8.7 Upgrade Firmware...
  • Page 165 VIVOTEK URL Command Document for VS8401-VVTK 8.8 Camera Control (capability.ptzenabled) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/camctrl.cgi?[channel=<value>][&camid=<value>] [&move=<value>] – Move home, up, down, left, right [&focus=<value>] – Focus operation [&iris=<value>] – Iris operation [&auto=<value>] – Auto pan, patrol [&zoom=<value>]...
  • Page 166 VIVOTEK URL Command Document for VS8401-VVTK speedtilt -5 ~ 5 Set the tilt speed. speedzoom -5 ~ 5 Set the zoom speed. speedfocus -5 ~ 5 Set the focus speed. speedapp -5 ~ 5 Set the auto pan/patrol speed. auto Auto pan.
  • Page 167 VIVOTEK URL Command Document for VS8401-VVTK speedlink 0 ~ 4 Issue speed link command. gaptime 0~32768 The gaptime between two consecutive ptz commands for device. (unit: ms) Redirect to the page <return page> after the parameter is return <return page>...
  • Page 168 VIVOTEK URL Command Document for VS8401-VVTK 8.10 Preset Locations (capability.ptzenabled) Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/preset.cgi?[channel=<value>] [&addpos=<value>][&delpos=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION addpos <Text string less than Add one preset location to the preset list. 30 characters>...
  • Page 169 VIVOTEK URL Command Document for VS8401-VVTK adddeny Add denied IP address range to the server. Start and end parameters must be specified. If the index parameter is specified, it will try to add starting from the index position. deleteallow Remove allowed IP address range from server. If start and end parameters are specified, it will try to remove the matched IP address.
  • Page 170 VIVOTEK URL Command Document for VS8401-VVTK <IP address> Single address: <IP address> Network address: <IP address / network mask> Range address:<start IP address - end IP address> index <value> The start position to add or to delete. return <return page>...
  • Page 171 VIVOTEK URL Command Document for VS8401-VVTK PARAMETER VALUE DESCRIPTION channel 0 ~ (n-1) The channel number of UART. 8.13 Event/Control HTTP Tunnel Channel (capability. evctrlchannel > 0) Note: This request requires Administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/ctrlevent.cgi ------------------------------------------------------------------------- GET /cgi-bin/admin/ctrlevent.cgi...
  • Page 172 VIVOTEK URL Command Document for VS8401-VVTK 8.14 Get SDP of Streams Note: This request requires Viewer access privileges. Method: GET/POST Syntax: http://<servername>/<network_rtsp_s<0~m-1>_accessname> “m” is the stream number. “network_accessname_<0~(m-1)>” is the accessname for stream “1” to stream “m”. Please refer to the “subgroup of network: rtsp”...
  • Page 173 VIVOTEK URL Command Document for VS8401-VVTK 8.16 Senddata (capability.nuart > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/senddata.cgi? [com=<value>][&data=<value>][&flush=<value>] [&wait=<value>] [&read=<value>] PARAMETER VALUE DESCRIPTION 1 ~ <max. com port The target COM/RS485 port number. number> data <hex decimal The <hex decimal data>...
  • Page 174 VIVOTEK URL Command Document for VS8401-VVTK 8.17 Storage managements (capability.storage.dbenabled > 0) Note: This request requires administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=<cmd_type>[&<parameter>=<value>…] The commands usage and their input arguments are as follows. PARAMETER VALUE DESCRIPTION cmd_type <string> Required.
  • Page 175 VIVOTEK URL Command Document for VS8401-VVTK isLocked <boolean> Optional. Indicate if the file is locked or not. 0: file is not locked. 1: file is locked. A locked file would not be removed from UI or cyclic storage. triggerTime <text>...
  • Page 176: Technical Specifications

    VIVOTEK URL Command Document for VS8401-VVTK 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 177 VIVOTEK URL Command Document for VS8401-VVTK Where "state" is 0, 1. “0” Ex: vi0=0(200)1 means inactive or Setting virtual input 0 to normal state, waiting 200 normal state while “1” milliseconds, setting it to trigger state. means active or Note that when the virtual input is waiting for next triggered state.
  • Page 178 VIVOTEK URL Command Document for VS8401-VVTK 8.19 Open Timeshift Stream (capability.timeshift > 0, timeshift_enable=1, timeshift_c<n>_s<m>_allow=1) Note: This request requires Viewer access privileges. Syntax: For HTTP push server (MJPEG): http://<servername>/<network_http_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&refti me=<value>&forcechk&minsft=<value>] For RTSP (MP4 and H264), the user needs to input the URL below into an RTSP compatible player.
  • Page 179 VIVOTEK URL Command Document for VS8401-VVTK minsft <positive How many seconds of cached stream client can integer> accept at least. (Used by forcechk) Return Code Description 400 Bad Request Request is rejected because some parameter values are illegal. 415 Unsupported Media Type Returned, if forcechk appears, when minsft is not achievable or the timeshift feature of the target stream is not enabled.
  • Page 180 VIVOTEK URL Command Document for VS8801-VVTK 3. General CGI URL Syntax and Parameters When the CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server. The CGIs are organized in functionally-related directories under the cgi-bin directory.
  • Page 181 VIVOTEK URL Command Document for VS8801-VVTK 4. Security Level SECURITY SUB-DIRECTORY DESCRIPTION LEVEL anonymous Unprotected. 1 [view] anonymous, viewer, 1. Can view, listen, talk to camera. dido, camctrl 2. Can control DI/DO, PTZ of the camera. 4 [operator] anonymous, viewer, Operator access rights can modify most of the camera’s...
  • Page 182 VIVOTEK URL Command Document for VS8801-VVTK 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>]. If you do not specify any parameters, all the parameters on the server will be returned.
  • Page 183 VIVOTEK URL Command Document for VS8801-VVTK Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network_ipaddress=192.168.0.123\r\n User's Manual - 183...
  • Page 184 VIVOTEK URL Command Document for VS8801-VVTK 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/operator/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/admin/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] PARAMETER...
  • Page 185 VIVOTEK URL Command Document for VS8801-VVTK Only the parameters that you set and are readable will be returned. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123 Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network_ipaddress=192.168.0.123\r\n User's Manual - 185...
  • Page 186 URL Command Document for VS8801-VVTK 7. Available parameters on the server This chapter defines all the parameters which can be configured or retrieved from VIVOTEK network camera or video server. The general format of description is listed in the table below...
  • Page 187 VIVOTEK URL Command Document for VS8801-VVTK 7.1 system Group: system NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) hostname string[40] “Video Host name of server Server” (Network Camera, Wireless Network Camera, Video Server, Wireless Video Server). ledoff <boolean> Turn on (0) or turn off (1) all led indicators.
  • Page 188 VIVOTEK URL Command Document for VS8801-VVTK Eniwetok, Kwajalein -440: GMT-11:00 Midway Island, Samoa -400: GMT-10:00 Hawaii -360: GMT-09:00 Alaska -320: GMT-08:00 Las Vegas, San_Francisco, Vancouver -280: GMT-07:00 Mountain Time, Denver -281: GMT-07:00 Arizona -240: GMT-06:00 Central America, Central Time, Mexico City,...
  • Page 189 VIVOTEK URL Command Document for VS8801-VVTK 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,...
  • Page 190 VIVOTEK URL Command Document for VS8801-VVTK 160: GMT 04:00 Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan 180: GMT 04:30 Kabul 200: GMT 05:00 Ekaterinburg, Islamabad, Karachi, Tashkent 220: GMT 05:30 Calcutta, Chennai, Mumbai, New Delhi 230: GMT 05:45 Kathmandu 240: GMT 06:00...
  • Page 191 VIVOTEK URL Command Document for VS8801-VVTK Melbourne, Sydney, Guam, Vladivostok 440: GMT 11:00 Magadan, Solomon Is., New Caledonia 480: GMT 12:00 Auckland, Wellington, Fiji, Kamchatka, Marshall Is. 520: GMT 13:00 Nuku’alofa daylight_enable <boolean> Enable automatic daylight saving time in time zone.
  • Page 192 VIVOTEK URL Command Document for VS8801-VVTK restore Restore the system <positive integer> parameters to default values after <value> seconds. reset Restart the server <positive integer> after <value> seconds if <value> is non-negative. restoreexceptnet <Any value> Restore the system parameters to...
  • Page 193 VIVOTEK URL Command Document for VS8801-VVTK union of combined results. restoreexceptlang <Any Value> Restore the system parameters to default values except the custom language file the user has uploaded. This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with...
  • Page 194 VIVOTEK URL Command Document for VS8801-VVTK available on the server. language_i<0~(count-1)> string[16] English, Available language lists. Deutsch, Español, Français, Italiano, 日本語, Português, 简体中文, 繁體中文 customlanguage_maxcount <integer> Maximum number of custom languages supported on the server. customlanguage_count <integer> Number of custom languages which have been uploaded to the server.
  • Page 195 VIVOTEK URL Command Document for VS8801-VVTK mii-tool. vi_i<0~(nvi-1)> <boolean> Virtual input 0 => Inactive 1 => Active (capability.nvi > 0) 7.3 digital input behavior define Group: di_i<0~(ndi-1)> (capability.ndi > 0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) normalstate high, high Indicates open circuit or...
  • Page 196 VIVOTEK URL Command Document for VS8801-VVTK user_i<1~20>_pass password[64] <blank> User password user_i0_privilege viewer, admin Root privilege operator, admin user_i<1~20>_ viewer, <blank> User privilege privilege operator, admin 7.6 network Group: network NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) preprocess <positive NULL An 32-bit integer, each bit can be set separately as integer>...
  • Page 197 VIVOTEK URL Command Document for VS8801-VVTK 0 => Use preset ipaddress, subnet, rounter, dns1, and dns2. ipaddress <ip 192.168.0.9 IP address of server. address> subnet <ip <blank> Subnet mask. address> router <ip <blank> Default gateway. address> dns1 <ip <blank> Primary DNS server.
  • Page 198 VIVOTEK URL Command Document for VS8801-VVTK TLS) privatekey_time <integer> Private key installed time. Represented in EPOCH privatekey_size <integer> Private key file size (in bytes) 7.6.2 QOS Subgroup of network: qos_cos (capability.protocol.qos.cos > 0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean>...
  • Page 199 VIVOTEK URL Command Document for VS8801-VVTK addondns <ip address> <blank> IPv6 DNS address. allowoptional <boolean> Allow manually setup of IP address setting. 7.6.4 FTP Subgroup of network: ftp NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) port 21, 1025~65535 Local ftp server port.
  • Page 200 VIVOTEK URL Command Document for VS8801-VVTK products, and m is stream number per channel. *Note: We can get n by (capability.nvideoin), and get m by (capability.nmediastream). Besides, we map the first stream of each channel: network_http_c<0~(n-1)>_s0_accessname to network_http_s<0~(n-1)>_accessname and map the second stream of each channel: network_http_c<0~(n-1)>_s1_accessname to network_http_s<n~(n*2-1)>_accessname and so on.
  • Page 201 VIVOTEK URL Command Document for VS8801-VVTK “live3.sdp” for c = 3, and so on. s1_accessname string[32] “live1-2.sdp” RTSP access name for channel c for c = 1. stream 2. “live2-2.sdp” (capability.protocol.rtsp=1 and for c = 2, capability.nmediastream > 1) and so on.
  • Page 202 VIVOTEK URL Command Document for VS8801-VVTK channel 1 stream 2. 239.128.1.(100+n) for channel 2 stream 2, and so on. For stream 3 of all channels: 239.128.1.(99+n*2) for channel 1 stream 3. 239.128.1.(100+n*2) for channel 2 stream 3, and so on.
  • Page 203 VIVOTEK URL Command Document for VS8801-VVTK 7.6.8 SIP port Subgroup of network: sip (capability.protocol.sip> 0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) port 1025 ~ 65535 5060 SIP port. 7.6.9 RTP port Subgroup of network: rtp NAME VALUE DEFAULT SECURIT DESCRIPTION...
  • Page 204 VIVOTEK URL Command Document for VS8801-VVTK type 0, 1 Ipfilter policy : 0 => allow 1 => deny ipv4list_i<0~9> Single address: IPv4 address list. <blank> <ip address> Network address: <ip address / network mask> Range address:<start ip address - end ip address>...
  • Page 205 VIVOTEK URL Command Document for VS8801-VVTK Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 => Support focus operation; 0(not support), 1(support) text string[16] <blank> Enclose caption. imprinttimestamp <boolean>...
  • Page 206 VIVOTEK URL Command Document for VS8801-VVTK manual input setting. 1 = worst quality, 5 = best quality. s<0~(m-1)>_mpeg4_qvalue 1~31 Manual video quality level input. (s<0~(m-1)>_mpeg4_quant = 0, 99) *Note: This is reserved for campatibility, and we recommend changing to use “s<0~(m-1)>_mpeg4_qperce...
  • Page 207 VIVOTEK URL Command Document for VS8801-VVTK *Note: This is reserved for campatibility, and we recommend changing to use “s<0~(m-1)>_h264_qpercen t”. s<0~(m-1)>_h264_qpercent 1~100 Set quality by percentage. 1: Worst quality 100: Best quality (s<0~(m-1)>_h264_quant = 100) s<0~(m-1)>_h264_bitrate 1000~4000000 512000 Set bit rate in bps when choosing cbr in “ratecontrolmode”.
  • Page 208 VIVOTEK URL Command Document for VS8801-VVTK s<0~(m-1)>_mjpeg_maxfram 1~30 Set maximum frame rate in fps (for JPEG). 7.9 Image setting per channel Group: image_c<0~(n-1)> for n channel products NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) brightness -5 ~ 5, 100 Adjust brightness of image according to mode settings.
  • Page 209 VIVOTEK URL Command Document for VS8801-VVTK campatibility, and we recommend changing to use “sharpnesspercent”. brightnesspercent 0 ~ 100 Adjust brightness of image by percentage. Darker 0 <-> 100 Brighter saturationpercent 0 ~ 100 Adjust saturation of image by percentage. Less 0 <-> 100 More saturation...
  • Page 210 VIVOTEK URL Command Document for VS8801-VVTK Saving value to “ saturation”, “contrast”, or “sharpness” has the same behavior. 7.10 Audio input per channel Group: audioin_c<0~(n-1)> for n channel products (capability.audioin>0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) mute 0, 1 Enable audio mute.
  • Page 211 VIVOTEK URL Command Document for VS8801-VVTK window. win_i<0~2>_sensitivity 0 ~ 100 Sensitivity of motion detection window. 7.13 Tempering detection settings Group: tampering_c<0~(n-1)> for n channel product (capability.tampering > 0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable tamper detection.
  • Page 212 VIVOTEK URL Command Document for VS8801-VVTK is customsafe100) 7.15 UPnP presentation Group: upnppresentation NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP presentation service. 7.16 UPnP port forwarding Group: upnpportforwarding NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean>...
  • Page 213 VIVOTEK URL Command Document for VS8801-VVTK string[64] <blank> The URL to connect to this camera by express link. 7.18 System log Group: syslog NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enableremotelog <boolean> Enable remote log. serverip <IP address> <blank> Log server IP address.
  • Page 214 VIVOTEK URL Command Document for VS8801-VVTK uart 0 ~ (m-1), m Select corresponding uart is UART (capability.nuart>0). count cameraid 0~255 Camera ID controlling external PTZ camera. hometype <boolean> The attribute defines whether the HOME command emulation is enabled. 0: Use the preset position 0 as the...
  • Page 215 VIVOTEK URL Command Document for VS8801-VVTK NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) baudrate 110,300,600,120 9600 Set baud rate of COM port. 0,2400,3600,480 0,7200,9600,192 00,38400,57600, 115200 databit 5,6,7,8 Data bits in a character frame. paritybit none, none For error checking. odd,...
  • Page 216 Hyperlink of the logo vivotek.co logo_powerbyvvtk_hidden <boolean> 0 => display the power by vivotek logo 1 => hide the power by vivotek logo theme_option 1~3: One of the default themes. 4: Custom definition. theme_color_font string[7] #ffffff Font color...
  • Page 217 VIVOTEK URL Command Document for VS8801-VVTK configuration area. theme_color_videobackground string[7] #565656 Background color of video area. theme_color_case string[7] #323232 Frame color custombutton_manualtrigger_s <boolean> Show or hide manual trigger (VI) button in homepage 0 -> Hidden 1 -> Visible 7.23 Privacy mask Group: privacymask_c<0~(n-1)>...
  • Page 218 VIVOTEK URL Command Document for VS8801-VVTK integer> built-in IR and extir for external IR) npir Number of PIRs. <positive integer> Number of digital inputs. <positive integer> Number of virtual inputs <positive (manual trigger) integer> Number of digital outputs. <positive integer>...
  • Page 219 VIVOTEK URL Command Document for VS8801-VVTK control function; 0(not support), 1(support) Bit 1 => Built-in or external camera; 0(external), 1(built-in) Bit 2 => Support pan operation, 0(not support), 1(support) Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 => Support zoom operation;...
  • Page 220 VIVOTEK URL Command Document for VS8801-VVTK Bit 1 => stream 2 supports ePTZ or not. The rest may be deduced by analogy lens_pan 0, <positive A 32-bit integer, each bit integer> can be set separately as follows: Bit 0 => Support pan.
  • Page 221 VIVOTEK URL Command Document for VS8801-VVTK in UI. lens_iris 0, <positive A 32-bit integer, each bit integer> can be set separately as follows: Bit 0 => Support iris. Bit 1 => Support iris in UI. Bit 2 => External or build-in iris function;...
  • Page 222 VIVOTEK URL Command Document for VS8801-VVTK protocol_pppoe <boolean> Indicate whether to support PPPoE. protocol_ieee8021x <boolean> Indicate whether to support IEEE802.1x. protocol_qos_cos <boolean> Indicate whether to support CoS. protocol_qos_dscp <boolean> Indicate whether to support QoS/DSCP. protocol_ddns <boolean> Indicate whether to support DDNS.
  • Page 223 VIVOTEK URL Command Document for VS8801-VVTK line output. audio_headphoneout <boolean> Indicate whether to support headphone output. audioin_codec aac4, gamr, g711 Available codec list for g711 audio input. uart_httptunnel <boolean> Indicate whether to support HTTP tunnel for UART transfer. camctrl_httptunnel <boolean>...
  • Page 224 VIVOTEK URL Command Document for VS8801-VVTK evctrlchannel <boolean> Indicate whether to support HTTP tunnel for event/control transfer. joystick <boolean> Indicate whether to support joystick control. storage_dbenabled <boolean> Media files are indexed in database. nanystream 0, <positive number of any media integer>...
  • Page 225 VIVOTEK URL Command Document for VS8801-VVTK time string[17] NULL Time of custom script. 7.26 Event setting Group: event_i<0~2> PARAMETER VALUE Default SECURITY DESCRIPTION (get/set) name string[40] NULL Identification of this entry. enable 0, 1 Enable or disable this event. priority...
  • Page 226 VIVOTEK URL Command Document for VS8801-VVTK tampering 0 ~ 255 Indicate the source of the tampering detection. Each bit represents one channel, and the LSB indicates channel 1. visignal 0 ~ 255 Indicate the source of video input signal loss. Each bit represents one channel, and the LSB indicates channel 1.
  • Page 227 VIVOTEK URL Command Document for VS8801-VVTK action_do_i<0~(ndo-1)> 0, 1 Enable or disable trigger digital _enable output. action_do_i<0~(ndo-1)> 1~999 Duration of the digital output trigger _duration in seconds. action_do_i<0~(ndo-1)> 0~999 The delay time needed before _delay triggering the digital output (in seconds) action_goto_c<0~(nvideo...
  • Page 228 VIVOTEK URL Command Document for VS8801-VVTK 7.27 Server setting for event action Group: server_i<0~4> PARAMETER VALUE DEFAULT SECURITY DESCRIPTION (get/set) name string[40] NULL Identification of this entry type email, email Indicate the server type: ftp, “email” = email server http, “ftp”...
  • Page 229 VIVOTEK URL Command Document for VS8801-VVTK 7.28 Media setting for event action Group: media_i<0~4> (media_freespace is used internally.) PARAMETER VALUE DEFAULT SECURITY DESCRIPTION (get/set) name string[40] NULL Identification of this entry type snapshot, snapshot Media type to send to the server or systemlog, store on the server.
  • Page 230 VIVOTEK URL Command Document for VS8801-VVTK videoclip_maxduration 1 ~ 20 Maximum duration of one video clip in seconds. videoclip_maxsize 50 ~ 5000 1000 Maximum size of one video clip file in Kbytes. videoclip_channel 0 ~ 7 Indicates the channel of media source.
  • Page 231 VIVOTEK URL Command Document for VS8801-VVTK organizationname string[64] Vivotek.Inc Organization name in the certificate information. unit string[32] Vivotek.Inc Organizational unit name in the certificate information. commonname string[64] www.vivotek Common name in the certificate .com information. validdays 0 ~ 3650 3650 Valid period for the certification.
  • Page 232 VIVOTEK URL Command Document for VS8801-VVTK 8. Useful Functions 8.1 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 233 VIVOTEK URL Command Document for VS8801-VVTK where <state> can be 0 or 1. Example: Query the status of digital input 1 . Request: http://myserver/cgi-bin/dido/getdi.cgi?di1 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n di1=1\r\n 8.3 Query Status of the Digital Output (capability.ndo >...
  • Page 234 VIVOTEK URL Command Document for VS8801-VVTK Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n do1=1\r\n 8.4 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.
  • Page 235 VIVOTEK URL Command Document for VS8801-VVTK 8.5 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 236 VIVOTEK URL Command Document for VS8801-VVTK 8.6 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 8.7 Upgrade Firmware...
  • Page 237 VIVOTEK URL Command Document for VS8801-VVTK 8.8 Camera Control (capability.ptzenabled) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/camctrl.cgi?[channel=<value>][&camid=<value>] [&move=<value>] – Move home, up, down, left, right [&focus=<value>] – Focus operation [&iris=<value>] – Iris operation [&auto=<value>] – Auto pan, patrol [&zoom=<value>]...
  • Page 238 VIVOTEK URL Command Document for VS8801-VVTK speedtilt -5 ~ 5 Set the tilt speed. speedzoom -5 ~ 5 Set the zoom speed. speedfocus -5 ~ 5 Set the focus speed. speedapp -5 ~ 5 Set the auto pan/patrol speed. auto Auto pan.
  • Page 239 VIVOTEK URL Command Document for VS8801-VVTK speedlink 0 ~ 4 Issue speed link command. gaptime 0~32768 The gaptime between two consecutive ptz commands for device. (unit: ms) return <return page> Redirect to the page <return page> after the parameter is assigned.
  • Page 240 VIVOTEK URL Command Document for VS8801-VVTK 8.10 Preset Locations (capability.ptzenabled) Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/preset.cgi?[channel=<value>] [&addpos=<value>][&delpos=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION addpos <Text string less than Add one preset location to the preset list. 30 characters>...
  • Page 241 VIVOTEK URL Command Document for VS8801-VVTK adddeny Add denied IP address range to the server. Start and end parameters must be specified. If the index parameter is specified, it will try to add starting from the index position. deleteallow Remove allowed IP address range from server. If start and end parameters are specified, it will try to remove the matched IP address.
  • Page 242 VIVOTEK URL Command Document for VS8801-VVTK <IP address> Single address: <IP address> Network address: <IP address / network mask> Range address:<start IP address - end IP address> index <value> The start position to add or to delete. return <return page>...
  • Page 243 VIVOTEK URL Command Document for VS8801-VVTK PARAMETER VALUE DESCRIPTION channel 0 ~ (n-1) The channel number of UART. 8.13 Event/Control HTTP Tunnel Channel (capability. evctrlchannel > 0) Note: This request requires Administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/ctrlevent.cgi ------------------------------------------------------------------------- GET /cgi-bin/admin/ctrlevent.cgi...
  • Page 244 VIVOTEK URL Command Document for VS8801-VVTK 8.14 Get SDP of Streams Note: This request requires Viewer access privileges. Method: GET/POST Syntax: http://<servername>/<network_rtsp_s<0~m-1>_accessname> “m” is the stream number. “network_accessname_<0~(m-1)>” is the accessname for stream “1” to stream “m”. Please refer to the “subgroup of network: rtsp”...
  • Page 245 VIVOTEK URL Command Document for VS8801-VVTK 8.16 Senddata (capability.nuart > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/senddata.cgi? [com=<value>][&data=<value>][&flush=<value>] [&wait=<value>] [&read=<value>] PARAMETER VALUE DESCRIPTION 1 ~ <max. com port The target COM/RS485 port number. number> data <hex decimal The <hex decimal data>...
  • Page 246 VIVOTEK URL Command Document for VS8801-VVTK 8.17 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 247 VIVOTEK URL Command Document for VS8801-VVTK The resource is unavailable, ex. Virtual input is waiting for next state. Examples: 1. setvi.cgi?vi0=0(15000)1 2. setvi.cgi?vi0=1 Request 2 will not be accepted during the execution time(15 seconds). 8.18 Open Timeshift Stream (capability.timeshift > 0, timeshift_enable=1, timeshift_c<n>_s<m>_allow=1)
  • Page 248 VIVOTEK URL Command Document for VS8801-VVTK request. Ex: Request the streaming from 12:20 rtsp://10.0.0.1/live.sdp?maxsft=10&reftime=12:30 forcechk Check if the requested stream enables timeshift, feature and if minsft is achievable. If false, return “415 Unsupported Media Type”. minsft <positive How many seconds of cached stream client can integer>...
  • Page 249 12V 2A Remove 8 7 6 5 4 3 2 1 RESET Copyright 2011 VIVOTEK INC. All rights reserved. Distributed by: VIVOTEK INC. 6F, No.192, Lien-Cheng Rd., Chung-Ho, New Taipei City, 235, Taiwan, R.O.C. |T: +886-2-82455282| F: +886-2-82455532| E: sales@vivotek.com VIVOTEK USA, INC.
  • Page 250: Technology License Notice

    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 251: Electromagnetic Compatibility (Emc)

    があいます。この場合には使用者が適切な対策を講ずるよう要求されるこたがあります。 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.

This manual is also suitable for:

Vs8401

Table of Contents