Page 1 SD9374-EHL Speed Dome Network Camera User ’s Manual 4MP • 36x Zoom • 30fps • NEMA 4x • 250m IR • Smart Stream III IP66 • Extreme Weatherproof Rev. 1.0...
Page 2: Table Of Contents
Ready to Use ............................27 Accessing the Network Camera 28 Using Web Browsers ..........................28 Using RTSP Players ..........................30 Using 3GPP-compatible Mobile Devices ....................31 Using VIVOTEK Recording Software ....................32 Main Page 33 Client Settings 40 Configuration 45 System > General settings ........................46 System >...
Page 3: Read Before Use
VIVOTEK Applications > VADP (VIVOTEK Application Development Platform) ............... 144 Recording > Recording settings ........................147 Local storage > SD card management ....................... 152 Local storage > Content management ....................... 153 Appendix 156 URL Commands for the Network Camera ......................156 Technical Specifications .............................
Page 4: Overview4
As with all VIVOTEK true day/night cameras, the camera features a removable IR-cut filter, maintaining clear images 24 hours a day. Audio detection is included by recognizing changes in ambient noise.
Page 5: Package Contents
AC 24V & DC 24V Max. 96W (heater and fan on); Max. 45W (heater and fan off) High power PoE Max. 70W (heater and fan on); Max. 39W (heater and fan off), using VIVOTEK's AP-GIC-011A-095 WARNING: These devices(IR LED) emit highly concentrated infrared light, which view angle(range) is To avoid risk of eye injury, please do smoothly varied depending on operation mode.
Page 6: Physical Description
VIVOTEK Physical Description Outer View Lens IR LEDs Reset button Status LEDs MicroSD card slot 6 - User's Manual...
Page 7 VIVOTEK Inner View Safety wire hook I/O combo connector LAN connector Alignment marks DI/DO Diagram Dry contact with external DC power source to supply a relay. Dry contact is the safest connection to protect devices. Switch Photo Coupler External DC power...
Page 8 VIVOTEK Wet contact with external DC power source to supply a relay. Switch DC 0V External DC power External AC power with Protected Earth Relay External Device 1. The DO+ pin provides 5V output voltage, and the max. load is 50mA.
Page 9 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 10: 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 the threaded anchors.
Page 11 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 12 VIVOTEK 7. Secure the bracket to wall. The cable length hanging on the outside of the bracket should be 15cm. 15cm 8. Remove the cable gland from the LAN port. If I/O wires or 24V power are preferred, use the T20 L-wrench to remove the top cover on the I/O connectors.
Page 13 VIVOTEK 9. Install the safety wire bracket, and hook up the safety wire between the bracket and the cam- era. Also connect a ground wire to one of the screws on the safety wire bracket. 10. Install the components of the waterproof cable gland to the Ethernet and I/O combo cables.
Page 14 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 15 Make sure all waterproof cable glands have been properly installed. Water leakage will cause irrepairable damage to the camera. 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.
Page 16 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 16 - User's Manual...
Page 17 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. User's Manual - 17...
Page 18 VIVOTEK 16. Secure the connection using the T25 L-wrench from the top. 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.
Page 19 VIVOTEK I/O Combo Cable Specifications The 24V DC socket dimensions are shown on the left. The DC socket should comply with a DC jack of the following parameters: Connector: Straight Round Barrel 5.5x2.1 DC straight round barrel Pin Size /DC Plug dimensions: 2.1 x 5.5 x 10 mm...
Page 20 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 20 - User's Manual...
Page 21: 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 22 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 23 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 79 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 80 for details.
Page 24: Software Installation
Software Installation 17. Install the Shepherd utility, which helps you locate and configure your Network Camera in the local network. If your camera comes without the CD, go to VIVOTEK’s website, and locate the utility in the Downloads > Software page.
Page 25 VIVOTEK 17-3. The program will search for all VIVOTEK network devices on the same LAN. 17-4. After a brief search, the installer window will prompt. Click on the MAC and model name that matches the one printed on the product label. You can then double-click on the address to open a management session with the Network Camera.
Page 26 VIVOTEK 18-2. Enter the combination of alphabetic and numeric characters to fulfill the password strength. requirement. The default name for the camera administrator is “root”, and can not be changed. Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~.
Page 27: Ready To Use
VIVOTEK Ready to Use 1. A browser session to the Network Camera should prompt as shown below. 2. You should be able to see live video from your camera. You may also install the 32-channel recording software from the software CD in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents.
Page 28: Accessing The Network Camera 28
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 29 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 98.
Page 30: 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 31: Using 3Gpp-Compatible Mobile Devices
Quick Time player only supports the playback of H.265 or H.264 stream, and not the MJPEG stream. In terms of audio codec, Quick Time only supports AAC. Since this camera supports G.711 codec, audio is not available on Quick Time. VLC player supports H.265/H.264/MPEG-4/MJPEG, and all audio codecs supported by VIVOTEK’s cam- eras. User's Manual - 31...
Page 32: Using Vivotek Recording Software
Network Camera to the Channel list. For detailed information about how to use the recording software, please refer to the user’s manual of the software or download it from http://www.vivotek.com. Tips: 1. If you encounter problems with displaying live view or the onscreen plug-in control, you may try to remove the plug-ins that might have been installed on your computer.
Page 33: Main Page 33
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. Resize Buttons VIVOTEK INC. Logo Host Name...
Page 34 VIVOTEK PTZ control mode: Joystick The Joystick mode simulates joystick control using your mouse. Click, hold down mouse button, and drag your mouse target cursor to the direction you want, the lens will move to that direction. You can click and hold down the mouse button to continue scanning.
Page 35 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 46. Camera Control Area Video Stream: This Network Camera supports multiple streams (stream 1 ~ 4) simultaneously. You can select either one for live viewing.
Page 36 VIVOTEK Please refer to PTZ > Auto tracking on page 120 and further for tracking configuration details. 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.
Page 37 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 38 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 39 VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Time Video (HTTP-V) 2019/03/10 17:08:56 Title and Time Video 17:08:56 2019/03/10 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 57.
Page 40: Client Settings 40
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 41 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 42 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 43 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 44 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 45: Configuration 45
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 98 Security > User Account for how to configure access rights for different users.
Page 46: 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 47: 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 48 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 49 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 50: 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 51 You can install the included VAST recording software, which provides an Event Management function group for delivering event messages via emails, GSM short messages, onscreen event panel, or to trigger an alarm, etc. For more information, refer to the VAST User Manual. VIVOTEK Network Cameras Internet 3G Cell phone...
Page 52: System > Parameters
VIVOTEK System > Parameters The View Parameters page lists the entire system’s parameters in an alphabetical order. If you need technical assistance, please provide the information listed on this page. 52 - User's Manual...
Page 53: 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 54 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 79). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
Page 55 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 56 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 57: 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 58 VIVOTEK Day/Night Settings IR cut filter With a removable IR-cut filter, this Network Camera can automatically remove the filter to let IR light enter the light sensor during low light conditions. ■ Auto mode The Network Camera automatically removes the filter by judging the level of ambient light.
Page 59 VIVOTEK IR control Turn on external IR illuminator in night mode Select this to turn on the external IR illuminator when the camera detects low light condition and enters the night mode. A Digital Output connection to external IR is needed.
Page 60 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 61 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 62 VIVOTEK Measurement Window: This function allows users to set measurement window(s) for low light compensation. For example, where low-light objects are posed against an extremely bright background. You may want to exclude the bright sunlight shining through a building's corridor.
Page 63 VIVOTEK Manual: Note that WDR and Defog functions will be disabled using the Manual mode setting. NOTE: • When Iris Priority is selected for the Exposure mode, the tunable aperture size is related to zoom ratio. When using different zoom ratios, the range of aperture sizes can be different. When zoom ratio is 0x, the range of iris sizes is F1.6~F14.
Page 64 VIVOTEK Due to the imaging characteristics, some the related imaging functions will be disabled when the Exposure mode is changed. See the table below for details: Exposure mode default gain Auto Shutter priority BLC - hidden Defog - WDR Pro -...
Page 65 VIVOTEK Focus Focus here refers to the Remote Focus, is applicable to Network Cameras that are equipped with stepping motor lens. Focus window Chances are while moving the lens around the surveillance area, focusing can be slow when zooming in on a complex scene with no distinctive objects especially in the center of the field of view.
Page 66 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 67 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 68: 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 69 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 70: Smart Stream Iii
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 71 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 72 VIVOTEK NOTE: Comparing with Smart Stream II, Smart Stream III has two more configurable options: Smart Q, and Smart FPS. • Smart codec: Smart codec effectively reduces the quality of the whole or the non- interested areas on a screen and therefore reduces the bandwidth consumed.
Page 73 VIVOTEK As the result, the lower screen is constantly displayed in high details, while the upper half is transmitted using a lower-quality format. Although the upper half is transmitted using a lower quality format, you still have an awareness of what is happening on the whole screen.
Page 74 VIVOTEK Bit rate control ■ Constrained bit rate: A complex scene generally produces a larger file size, meaning that higher bandwidth will be needed for data transmission. The bandwidth utilization is configurable to match a selected level, resulting in mutable video quality performance. The bit rates...
Page 75 VIVOTEK Fixed quality: On the other hand, if Fixed quality is selected, all frames are transmitted with the same quality; bandwidth utilization is therefore unpredictable. The video quality can be adjusted to the following settings: Medium, Standard, Good, Detailed, and Excellent.
Page 76 VIVOTEK If the JPEG mode is selected, the Network Camera sends consecutive JPEG images to the client, producing a moving effect similar to a filmstrip. Every single JPEG image transmitted guarantees the same image quality, which in turn comes at the expense of variable bandwidth usage. Because the media contents are a combination of JPEG images, no audio data is transmitted to the client.
Page 77: 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 78 VIVOTEK Audio clips ■ Output gain: Use the slide bar to change the audio output gains value. ■ Audio clip: When the camera's audio input is connected to a microphone, you can record a short period of audio recordings (1 to 10 seconds). You can also use the camera's embedded microphone to record an audio clip, if available.
Page 79: 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 24 for details.
Page 80 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 81 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 82 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 83 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 84 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 85 VIVOTEK User's Manual - 85...
Page 86: 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 98 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 87 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 video1s2.mjpg: 1. Launch the Mozilla Firefox browser. 2. Type the above URL command in the address bar. Press Enter.
Page 88 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 89 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 90 VIVOTEK SIP is short for Session Initiation Protocol. If necessary, you can change the default port number, 5060, to one between 1025 and 65535. Two way audio port: The Network Camera supports two way audio communication so that operators can transmit and receive audio simultaneously.
Page 91: 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 92 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 93 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 94 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 95 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 96: 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 97: Network > Ftp
FTP function. You can disable the FTP server function when it is not in use. FTP port: The FTP server allows the user to save recorded video clips. You can utilize VIVOTEK's Shepherd utility to upgrade the firmware via FTP server. By default, the FTP port is set to 21. It can also be assigned to another port number between 1025 and 65535.
Page 98: Security > User Accounts
VIVOTEK Security > User accounts This section explains how to enable password protection and create multiple accounts. Account management The administrator account name is “root”, which is permanent and can not be deleted. If you want to add more accounts in the Account management window, please apply the password for the “root” account first.
Page 99 VIVOTEK Privilege management Digital Output & PTZ control: You can modify the management privilege as operators or viewers. Select or de-select the checkboxes, and then click Save to enable the settings. If you give Viewers the privilege, Operators will also have the ability to control the Network Camera through the main page. (Please refer to Configuration on page 33).
Page 100: Security > Https (Hypertext Transfer Protocol Over Ssl/Tls)
VIVOTEK Security > HTTPS (Hypertext Transfer Protocol over SSL/TLS) 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 101 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 102 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 103 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 104 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 105 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 - 105...
Page 106 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 107: 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 108 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 109 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 110 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 111 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 112 VIVOTEK Security > Miscellaneous The embedded TrendMicro utitlity provides the protection against Cross-Site Request Forgery. Cross-site request forgery is also known as one-click attack or session riding and is abbreviated as CSRF. CSRF is a type of malicious exploit of a website, in this case, the camera.
Page 113: 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 114 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 115 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 116 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 117 VIVOTEK Misc. settings: Use the checkboxes and the pull-down menus for the camera to automatically resume the previous action or return to the home position after the camera has stayed idle for a period of time. PTZ control panel operation mode: This determines how your mouse and PTZ control panel works on a live view window.
Page 118 VIVOTEK Focus mode: This determines how focus takes place when camera lens is ordered to aim at different areas or preset points, or zoom in or out on a scene. Auto: Firmware automatically adapts to different environments regarding the distances of objects in scene, and generates the best focus results.
Page 119 VIVOTEK Positions on the Home page The Preset positions will also be displayed on the home page. Select one from the Go to drop-down list, and the Network Camera will move to the selected position. button: Click this button to start the 360° horizontal auto pan.
Page 120 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 121 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 122: 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 123 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 124 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 125 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 126 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 127 VIVOTEK Add server Click Add server to unfold the server setting window. You can specify where the notification messages are sent to when a trigger is activated. A total of 5 server settings can be configured. There are four choices of server types available: Email, FTP, HTTP, and Network storage. Select the item to display the detailed configuration options.
Page 128 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 129 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 130 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 149 for details. Click Save server to enable the settings, then click Close to exit the Add server page.
Page 131 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 132 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_20190320_100341 File name preﬁx Date and time sufﬁx The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings, then click Close to exit the Add media page.
Page 133 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 134 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 135 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 136 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. 2019/03/20...
Page 137: 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 138 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 122.
Page 139 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 123 for detailed informatio. NOTE: ►...
Page 140: 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 141: Applications > Tampering Detection
VIVOTEK Applications > Tampering detection This section explains how to set up camera tamper detection. With tamper detection, the camera is capable of detecting incidents such as redirection, blocking or defocusing, or even spray paint. Please follow the steps below to set up the camera tamper detection function: 1.
Page 142: 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 143 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 144: 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 145 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 146 VIVOTEK On the License page, register and activate the license for using VIVOTEK's VADP modules. You should acquire the license key elsewhere, and manually upload to the network camera. Follow the onscreen instruction on VIVOTEK's website for the registration procedure.
Page 147: 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 152 for detailed information.
Page 148 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 149 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 150 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 151 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 152: 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 153: 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 154 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 155 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 156: Appendix
VIVOTEK Appendix URL Commands for the Network Camera 1. Overview For some customers who already have their own web site or web control application, the Network Camera/Video Server can be easily integrated through URL syntax. This section specifies the external HTTP-based application programming interface.
Page 157 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 158 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 159 If you omit this parameter, it will redirect to an empty page. (Note: The return page can be a general HTML file(.htm, .html) or a VIVOTEK server script executable (.vspx) file. It cannot be a CGI commandor have any extra parameters.This parameter must be User's Manual - 159...
Page 160 VIVOTEK placed at the end of the parameter list Return: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: <length>\r\n \r\n <parameter pair> where<parameter pair> is <parameter>=<value>\r\n [<parameter pair>] Only the parameters that you set and are readable will be returned. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123...
Page 161 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 162 VIVOTEK W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 available The API is listed in product WebAPIs. non-available The API is not in product WebAPIs. valid The API is listed in product WebAPIs, and is functional.
Page 163 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 164 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 165 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 166 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 167 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 168 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 169 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 170 VIVOTEK port occupied by another service currently. Otherwise, the service may fail. Stopped service will auto-start after changing port settings. Change HTTP port from 80 to 5556, and change RTP port for video from 5556 to 20480. Then, set preprocess=9 to stop both service first.
Page 171 VIVOTEK ca_time 0,<positive CA installed time. Represented in EPOCH integer> ca_size 0,<positive CA file size (in bytes) integer> certificate_exist <boolean> Certificate installed flag (for TLS) certificate_time 0,<positive Certificate installed time. Represented in integer> EPOCH certificate_size 0,<positive Certificate file size (in bytes) integer>...
Page 172 VIVOTEK 7.6.3 IPV6 Subgroup of network: ipv6 (capability.protocol.ipv6 > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable IPv6. addonipaddress <ip address> IPv6 IP address. addonprefixlen 0~128 IPv6 prefix length. addonrouter <ip address> IPv6 router address. addondns <ip address> IPv6 DNS address.
Page 173 VIVOTEK etc. anonymousviewing <boolean> Enable anonymous streaming viewing. 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...
Page 174 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 video IP address. * We replace "network_rtsp_s<0~(n-1)>_multicast_ipaddress" with " network_rtsp_s<0~(n-1)>_multicast_videoipaddre ss ". * Reserved for compatibility, and suggest don't use this since [httpversion] >...
Page 175 VIVOTEK 7.6.9 RTP port Subgroup of network: rtp NAME VALUE SECURITY DESCRIPTION (get/set) videoport 1025 ~ 65535 Video channel port for RTP. (capability.protocol.rtp_unicast=1) audioport 1025 ~ 65535 Audio channel port for RTP. (capability.protocol.rtp_unicast=1) metadataport 1025 ~ 65535 Metadata channel port for RTP.
Page 176 VIVOTEK address> ipv6list_i<0~9> string[43] IPv6 address list. 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. "auto": Auto white balance <product dependent> manual, "rbgain": Use rgain and bgain to set white...
Page 177 VIVOTEK 5: EV -0.3 6: EV 0 7: EV +0.3 8: EV +0.7 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.0 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 178 VIVOTEK Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only) text string[64] Enclose caption. imprinttimestamp <boolean> Overlay time stamp on video.
Page 179 VIVOTEK axrange" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposure_ra ngetype" is "twovalues". enablepreview <boolean> Usage for UI of exposure settings. Preview settings of video profile. 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 180 VIVOTEK * Only available when "capability_image_c<0~(n-1)>_wbm ode" !="-" rgain 0~100 Manual set rgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain" is listed "capability_image_c<0~(n-1)>_wbm ode". * Only valid when "videoin_c<0~(n-1)>_whitebalance" != auto * Normalized range.
Page 181 Iris, and keep adjusting Gain and Shutter speed automatically. "qualitypriority": Automatically adjust the Iris, Gain and Shutter Speed by VIVOTEK quality algorithm. "manual": Manually adjust with variable Shutter, Iris and Gain. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 182 VIVOTEK effect first. "manual": Manual set P-Iris by "piris_position". "-": not support. (only available when "capability_image_c<0~(n-1)>_sens ortype" is "smartsensor") * Only available when "capability_image_c<0~(n-1)>_iristy pe"=piris piris_position 1~100 Manual set P-Iris. <product 1: Open <-> 100: Close dependent> * Only valid when "piris_mode"=manual or...
Page 183 VIVOTEK mingain 0~100 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_ mingain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_expo sure_rangetype" is "twovalues". gainvalue 0~100 Gain value.
Page 184 VIVOTEK Bit 2 => Support pan operation; 0(not support), 1(support) Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only) text string[64] Enclose caption.
Page 185 VIVOTEK dependent> <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc. 5~8000 => 1/5s ~ 1/8000s etc. * Available value is listed in "capability_image_c<0~(n-1)>_expo * This parameter may also restrict sure_maxrange" image frame rate from sensor due to sensor generates a frame per exposure time.
Page 186 VIVOTEK "capability_image_c<0~(n-1)>_expo sure_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. enablepreview <boolean> Usage for UI of exposure settings. Preview settings of video profile. crop_position <coordinate> Crop left-top corner coordinate.
Page 187 VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0301c. s<0~(m-1)>_h 250, 500, 1000, 2000, 3000, 4000 The time interval between two 264_intraperiod I-frames (Intra coded picture). The unit is millisecond (ms). cbr: Constant bit rate mode.
Page 188 VIVOTEK bit rate. * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~5, 100 Set the pre-defined quality level: 264_cbr_quant 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only available when "ratecontrolmode"= cbr.
Page 189 VIVOTEK (n-1)>_resolution") are recorded in "capability_videoin_c<0~(n-1)>_h26 4_maxframerate" s<0~(m-1)>_h Indicate H264 profiles 264_profile 0: baseline 1: main profile 2: high profile s<0~(m-1)>_h <boolean> Enable "Dynamic intra frame period". 265_dintraperio * Only available when d_enable "capability_videoin_c<0~(n-1)>_dint raperiod_support" is 1 and h265 is listed in "capability_videoin_codec".
Page 190 VIVOTEK "ratecontrolmode"= vbr. s<0~(m-1)>_h 0~51 Manual video quality level input. The Q 265_qvalue value which is used by encoded library directly. * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= vbr and s<0~(m-1)>_h265_quant = s<0~(m-1)>_h...
Page 191 VIVOTEK "ratecontrolmode"= cbr. * Only available when "capability_smartstream_version"="2 .0" s<0~(m-1)>_h 1~100 Select customized quality in a 265_cbr_qperce normalized full range. 1: Worst quality 100: Best quality * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= cbr and "quant"= 100.
Page 192 VIVOTEK 1: main profile 2: high profile * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_m cbr, vbr cbr: Constant bit rate mode. jpeg_ratecontro vbr: Fixed quality mode, all frames are lmode encoded in the same quality. s<0~(m-1)>_m 1~5, * Only valid when "ratecontrolmode"=...
Page 193 VIVOTEK jpeg_maxvbrbit )>_mjpeg_maxbitrate" quality mode. rate When the bit rate exceeds this value, frames will be dropped to restrict the bit rate. * Only valid when "ratecontrolmode"= s<0~(m-1)>_m 1~5, 100 Set the pre-defined quality level: jpeg_cbr_quant 1: Medium 2: Standard...
Page 194 VIVOTEK jpeg_maxframe mjpeg_maxframerate" stream at different resolutions("capability_videoin_c<0~ (n-1)>_resolution") are recorded in "capability_videoin_c<0~(n-1)>_mjp eg_maxframerate" wdrpro_mode <boolean> Enable WDR pro <product dependent> * Only available when "capability_image_c<0~(n-1)>_wdrp ro_mode" > 0 wdrpro_strengt 1~100 The strength of WDR Pro. The bigger value means the stronger <product...
Page 195 VIVOTEK The higher speed level meas shorter AE converged time during AE executing. * Only available when "capability_image_c<0~(n-1)>_aesp eed" is 1 aespeed_sensiti 1~100 The sensitivity of AE converge speed. vity 1~20: level 1 <product 21~40: level 2 dependent> 41~60: level 3...
Page 196 VIVOTEK sheyedewarpmo mount “1O” is original mode (disable). ‘1O, 1P, 1R, 4R’ for wall mount Supported dewarp mode is different by <product <product dependent> mount type. dependent> (videoin_c<0~(n-1)>_mounttype) Supported mode list could be extracted from (capability_videoin_c<0~(n-1)>_local dewarp_typeceilingmount) and (capability_videoin_c<0~(n-1)>_local...
Page 197 VIVOTEK 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. If the value is a negative number, the video quality of non-ROI areas is better than the ROI.
Page 198 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 199 VIVOTEK * Available value is listed in * This parameter may also restrict image "capability_image_c frame rate from sensor due to sensor <0~(n-1)>_exposu generates a frame per exposure time. Ex: If re_maxrange" this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.
Page 200 "capability_image_c speed automatically. "qualitypriority": Automatically adjust the <0~(n-1)>_exposu re_modetype") Iris, Gain and Shutter Speed by VIVOTEK quality algorithm. "manual": Manually adjust with variable Shutter, Iris and Gain. * We support this parameter when the version number (httpversion) is equal or greater than...
Page 201 VIVOTEK 0302a. whitebalance auto, Modes of white balance. <product dependent> manual, "auto": Auto white balance rbgain, "rbgain": Use rgain and bgain to set white widerange, balance manually. outdoor, "manual": 2 cases: indoor, a. if "rbgain" is not supported, this means sodiumauto, keep current white balance status.
Page 202 VIVOTEK 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_maxgain " != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposure_ra ngetype" is "twovalues". mingain 0~100 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_mingain...
Page 203 VIVOTEK "indoor": Avoid rolling and flicker effect first. "manual": Manual set P-Iris by "piris_position". "-": not support (only available when "capability_image_c<0~(n-1)>_sensortype" is "smartsensor") * Only available when "capability_image_c<0~(n-1)>_iristype"=piri piris_position 1~100 Manual set P-Iris. <product dependent> 1: Open <-> 100: Close * Only valid when "piris_mode"=manual or...
Page 204 VIVOTEK "capability_image_c<0~(n-1)>_wdrc_mode" is 1 wdrc_strength 1~100 The strength of WDR enhanced. <product dependent> The bigger value means the stronger strength of WDR enhanced. * Only available when "capability_image_c<0~(n-1)>_wdrc_mode" is 1 aespeed_mode <boolean> Turning AE converge speed on or off. ...
Page 205 VIVOTEK <product dependent> * Only available when "capability_image_c<0~(n-1)>_flickerless" is 7.9Time Shift settings Group: timeshift for n channel profucts and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" (capability.timeshift > 0) NAME VALUE SECURITY DESCRIPTION...
Page 206 VIVOTEK n"-1>_externalir > 0) extledmode do, irring Turn on an external IR led which is mounted do * Available values (digital output) device or is a IR ring device. are listed in * Only available when "capability_daynight "capability_daynight_c<0~"capability_nvideoi _c<0~(n-1)>_extle n"-1>_externalir" is 1.
Page 207 VIVOTEK 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" NAME VALUE SECURITY DESCRIPTION (get/set) brightness -5~5,100 -5: Darker <-> 5: Bright <Not recommended to use this>...
Page 208 VIVOTEK "saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. sharpness -3~3,100 -3: Softer <-> 3: Sharper <Not recommended to use this> 100: Use " image_c<0~(n-1)>_sharpnesspercent" * Only available when bit 3 of "capability_image_c<0~(n-1)>_basicsetting"...
Page 209 VIVOTEK is 1 gammacurve 0~100 0: Fine-turned gamma curve by Vivotek. <product dependent> 1: Gamma value = 0.01 2: Gamma value = 0.02 3: Gamma value = 0.03 100: Gamma value = 1 * Note: Although we set gamma value to 100 level, but not all gamma values are valid.
Page 210 VIVOTEK 1:enable * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mode". eis_strength 1~100 Strength of electronic image stabilizer <product dependent> * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mode". dis_mode <boolean> Digital image stabilizer <product dependent> 0:disable 1:enable * Only available when 'dis' is listed in "capability_image_c<0~(n-1)>_is_mode".
Page 211 VIVOTEK profile_i<0~(m-1)>_begintime hh:mm Begin time of schedule mode. profile_i<0~(m-1)>_endtime hh:mm End time of schedule mode. profile_i<0~(m-1)>_brightness -5~5,100 -5: Darker <-> 5: Bright <Not recommended to use this> 100: Use " image_c<0~(n-1)>_brightnesspercent" * Only available when bit 0 of "capability_image_c<0~(n-1)>_basicsetting" is 1 * We replace "profile_i0_brightness"...
Page 212 0~100 Set sharpness in the normalized range. percent 0: Softer <-> 100: Sharper * Only available when bit 3 of "capability_image_c<0~(n-1)>_basicsetting" is 1 profile_i<0~(m-1)>_gammacur 0~100 0: Fine-turned gamma curve by Vivotek. 1: Gamma value = 0.01 212 - User's Manual...
Page 213 VIVOTEK 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. Internal module will take the closest valid one.
Page 214 VIVOTEK profile_i<0~(m-1)>_eis_streng 1~100 Strength of electronic image stabilizer * Only available when 'eis' is listed in <product dependent> "capability_image_c<0~(n-1)>_is_mode". profile_i<0~(m-1)>_dis_mode <boolean> Digital image stabilizer <product dependent> 0:disable 1:enable * Only available when 'dis' is listed in "capability_image_c<0~(n-1)>_is_mode". profile_i<0~(m-1)>_dis_streng 1~100 Strength of digital image stabilizer * Only available when 'dis' is listed in <product dependent>...
Page 215 VIVOTEK 7.12 Exposure window setting per channel Group: exposurewin_c<0~(n-1)> for n channel profucts n denotes the value of "capability_nvideoin" (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1) NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, custom,blc,hlc "auto": Use full image view as the only exposure window.
Page 216 VIVOTEK ndomain". homepx <0~W,0~H> Left-top corner coordinate of the window. W: 0~ The current image width -1 * Only available when px is listed in H: 0~ The current image height -1 "capability_image_c<0~(n-1)>_exposure_wi ndomain". sizepx <0~Wx0~ H> Width and height of the window.
Page 217 VIVOTEK Group: exposurewin_c<0~(n-1)>_profile_i<0~(m-1)>_win_i<0~(k-1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the value of "capability_nvideoinprofile", k denotes the value of "capability_image_c<0~(n-1)>_exposure_winnum". (Only available when custom is listed in "capability_image_c<0~(n-1)>_exposure_winmode" and valid when "exposurewin_c<0~(n-1)>_mode"=custom or "exposurewin_c<0~(n-1)>_mode"=hlc)
Page 218 VIVOTEK * Only available when std is listed in "capability_image_c<0~(n-1)>_exposure_wi ndomain". 7.13 Audio input per channel Group: audioin_c<0~(n-1)> for n channel products (capability.naudioin>0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) source micin, linein micin => use built-in microphone input.
Page 219 VIVOTEK 0: Minimum 100: Maximum * Only available when the channel supports external microphone (The related bit of "capability_audio_extmic" is equal to 1). mute 0, 1 0: Mute off 1: Mute on gain 0~100 Gain of input. <Not recommended to use (audioin_c<0~(n-1)>_source = linein)
Page 220 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 221 VIVOTEK profile_i0_policy night, The mode which the profile is applied to. schedule * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a. profile_i0_begintime hh:mm Begin time of schedule mode. profile_i0_endtime hh:mm End time of schedule mode.
Page 222 VIVOTEK * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. polygonpx 0 ~ W,0 ~ H, 0 ~ Coordinate of polygon window position. <Not recommended to use W,0 ~ H, 0 ~ W,0 ~ (4 points: x0,y0,x1,y1,x2,y2,x3,y3) this>...
Page 223 VIVOTEK this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. width 0 ~ 320 Width of motion detection window.
Page 224 VIVOTEK * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a. begintime hh:mm Begin time of schedule mode. endtime hh:mm End time of schedule mode. win_sensitivity 0 ~ 100 Sensitivity of all motion detection windows.
Page 225 VIVOTEK image height -1 "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. polygon 0 ~ 320,0 ~ 240, 0 Coordinate of polygon window position.
Page 226 VIVOTEK width 0 ~ 320 Width of motion detection window. <Not recommended to use * Only available when this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
Page 227 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 228 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 229 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 230 (get/set) logo_default <boolean> 0 => Custom logo 1 => Default logo logo_link string[128] Hyperlink of the logo http://www.vivotek. logo_powerbyvvtk_hidden <boolean> 0 => display the power by vivotek logo 1 => hide the power by vivotek logo 230 - User's Manual...
Page 231 VIVOTEK custombutton_manualtrig <boolean> Show or hide manual trigger (VI) button in ger_show homepage 0 -> Hidden 1 -> Visible theme_option 1~3: One of the default themes. 4: Custom definition. theme_color_font string[7] Font color theme_color_configfont string[7] Font color of configuration area.
Page 232 VIVOTEK "capability_image_c<0~(n-1)>_privacymask _wintype" = rectangle. win_i<0~(m-1)>_height 0 ~ 240 Height of privacy mask window. * Only available when "capability_image_c<0~(n-1)>_privacymask _wintype" = rectangle. win_i<0~(m-1)>_polygo 0 ~ 320,0 ~ 240, Coordinate of polygon window position. 0 ~ 320,0 ~ 240, (4 points: x0,y0,x1,y1,x2,y2,x3,y3)
Page 233 VIVOTEK 7.24 3D Privacy mask Group: privacymask3d_c<0~(n-1)> for n channel products and m privacy mask window. (capability_image_c<0~(n-1)>_privacymask_wintype = 3Drectangle) n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable the 3D privacy mask color 0~"...
Page 234 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 235 VIVOTEK document. The 5th character is model-based version for API bug-fix and it's default to "a". Ex: If some APIs in a model does not follow the API definition of 0301a_1, we will fix them and change this API value to 0301b_1.
Page 236 VIVOTEK More details, please refer the parameter description of "volume_internal" and "volume_external". nuart Number of UART interfaces. <positive integer> nmotion <positive integer> The number of motion window. nmotionprofile 0, <positive Number of motion profiles. integer> ptzenabled 0, <positive An 32-bit integer, each bit can be set integer>...
Page 237 VIVOTEK it means that the camera supports remotefocus function. bit 0 => Indicate whether to support both zoom and focus function. bit 1 => Only support zoom function. bit 2 => Only support focus function. bit 3 => Currently, this is a reserved bit, and the default value is 0.
Page 238 VIVOTEK channel support ePTZ or not, and so on. * For most products, the last stream of a channel will not support ePTZ. It is reserved for full view of the channel. For some dual-stream products, both streams support ePTZ.
Page 239 VIVOTEK "visignal" = Video input signal loss. "backup" = Backing up recorded files "smartsd" = Lifetime detection of SD card "shockalarm" = Shock detection * Only available when [httpversion] >= 0301a storage_dbenabled <boolean> Media files are indexed in database. protocol_https <...
Page 240 VIVOTEK videoin_resolution A list of <WxH> This equals <product "capability_videoin_c0_resolution". dependent> * This is kept for compatibility. videoin_maxframerate A list of <Integer> This equals "capability_videoin_c0_maxframerate". * This is kept for compatibility. videoin_mjpeg_maxframe A list of <Integer> This equals rate and "-"...
Page 241 VIVOTEK "nvideoout"=0, "videoout_codec"=- "nvideoout"=1 with NTSC, "videoout_codec"=ntsc "nvideoout"=1 with PAL, "videoout_codec"=pal "nvideoout"=2 with both NTSC, "videoout_codec"=ntsc,ntsc * For camera, this feature is controlled by physical jump on device. No WebAPI to control it. This value is set only on camera power-on and maintains the status.
Page 242 VIVOTEK - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values.
Page 243 VIVOTEK Bit 0 for CH0, bit 1 for CH1, and so on. audio_extmic <0~Positive External Microphone. Integer> 0: Not support 1: Support Bit 0 for CH0, bit 1 for CH1, and so on. audio_alarm <0~Positive 0: Not support audio alarm.
Page 244 VIVOTEK motion_windomain qvga, px, std, - The domain to set an motion window. qvga: a 320x240 range to represent the whole image. px: Locate a window in the image with pixels. std: A normalized 0~9999 range. -: Not supported. smartstream_support <boolean>...
Page 245 VIVOTEK smartstream_nwindow_h <positive integer> Maximum number of tracking window of ybrid_autotracking autotracking in hybrid mode. * Only available when "capability_smartstream_support" is 1 smartstream_nwindow_h <positive integer> Maximum number of tracking window of ybrid_manual manual in hybrid mode. * Only available when "capability_smartstream_support"...
Page 246 VIVOTEK 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. transmission_mode Indicate transmission mode of the machine: TX = server, Rx = receiver box, Both = DVR. Both network_wire <boolean>...
Page 247 VIVOTEK camera is in wireless AP mode. * Only available when "capability_wireless_apmode_enable" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0305a. derivative_brand <boolean> Indicate whether to support the upgrade function for the derivative brand. For example, if the value is true, the VVTK product can be upgraded to VVXX.
Page 248 VIVOTEK use this since [httpversion] > 0301a image_focusassist <boolean> Indicate whether to support focus assist. <Not recommended to use * We replace "capability_image_ focusassist " this> with "capability_image_c0_ focusassist". * Reserved for compatibility, and suggest don't use this since [httpversion] > 0301a localstorage_manageable <boolean>...
Page 249 VIVOTEK fisheyelocaldewarp_c<0~ 0, <positive Indicate the supported streams of local (capability_nvideoin)-1> integer> dewarp. One bit represents one supported <product dependent> stream. The LSB indicates stream 0. Ex: “3” means stream 0 and stream 1 support local dewarp. * Only available when "capability_fisheye" > 0 Group: capability_camctrl_c<0~(n-1)>...
Page 250 VIVOTEK focusmode auto,onetimeauto,spo Focus mode selection: tlight,manual "auto": Camera will automatically adjust the <product dependent> focus position full time to adapt a clear picture. "onetimeauto": Camera will automatically adjust the focus position one time, which follows any PTZ control. "spotlight": Camera will automatically adjust the focus position full time, and to consider a spotlight avoidance situation.
Page 251 VIVOTEK maxpanangle <integer> The upper limit for pan angle. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" tiltspeedlv 0, <positive integer> 0/7 The maximum speed level of tilt motion. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" mintilt 0, <positive integer> 0/7 The lower limit for tilt position.
Page 252 VIVOTEK focusspeedlv 0, <positive integer> 0/7 The maximum speed level of focus motion. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule" is "1" minfocus 0, <positive integer> 0/7 The lower limit for focus position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule"...
Page 253 VIVOTEK ircutsensitivity_type <string> Indicate the cgi interface of "ircutcontrol_sensitivity". "options": the value of "ircutcontrol_sensitivity" parameter is "low, normal,high". "normalize": the value of "ircutcontrol_sensitivity" parameter is "1~100" "-":not support * Only available when "capability_daynight_c<0~(n-1)>_support" is * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 254 VIVOTEK Group: capability_videoin_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) The lens type of this channel. lens_type fisheye, fixed, fisheye: Fisheye lens varifocal, changeable, fixed: Build‐in fixed‐focus lens. motor, - varifocal: Build‐in varifocal lens. <product dependent> changeable: changeable lens. Like box‐type camera, users can install any C‐Mount or CS‐Mount lens as they wish. motor: Lens with motor to support zoom, focus, etc. ‐: N/A * Only available when [httpversion] >= 0301a rotation <boolean>...
Page 255 VIVOTEK rotationaffect When rotation is enabled, some features may <product dependent> become malfunction or be forced to a given value. The affected functions are list here. The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select - (unchanged) : UI keeps the status as before and user can't change it.
Page 256 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 257 VIVOTEK maxframerate A list of <Integer> Indicate frame rate that the video source outputs in current video mode. One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group. * This parameter may be changed when "videoin_c<n>_cmosfreq"=50 or "videoin_c<n>_modulation"=pal. Ex: 30 fps is changed to 25 fps, 60 fps is changed to 50 fps, and so on. mjpeg_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer>...
Page 258 VIVOTEK h264_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer> and "-" H.264 on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution"...
Page 259 VIVOTEK fisheye_mounttype ceiling, wall, floor Indicate the supported type. <product dependent> <product dependent> wall mount: 180° panoramic view ceiling mount: 360° surround view without blind spots floor mount: 360° surround view without blind spots Only available when "capability_fisheye" > 0 dintraperiod_support <boolean>...
Page 260 VIVOTEK resolutionC4R A list of <WxH> Available resolutions of 4R mode of ceiling and floor mount. resolutionW1P A list of <WxH> Available resolutions of 1P mode of wall mount. resolutionW1R A list of <WxH> Available resolutions of 1R mode of wall mount.
Page 261 VIVOTEK wdrpro 0, 1, 2 Indicate this mode whether support WDR pro. 0: Non-support WDR Pro 1: Support WDR Pro 2: Support WDR Pro and WDR Pro II * We support this parameter when the version number (httpversion) is equal or greater than 0304b.
Page 262 VIVOTEK resolution A list of <WxH> Resolution options in this video mode. The last one is the maximum resolution in this video mode. * The element number is defined as "nresolution" in this group. maxresolution A list of <Integer> Represent supported maximum resolution of each stream in current video mode.
Page 263 VIVOTEK maxfps_h264 A list of <Positive Maximum fps which the device can encoded with Integer> and "-" H.264 on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution"...
Page 264 VIVOTEK wdrpro_strength 0, 1 0: Non-support tuning strength of WDR Pro 1: Support tuning strength of WDR Pro * If "capability_image_c<0~(n-1)>_wdrp ro"=1, this may be either 0 or 1. wdrpro_supportlevel 0, <positive integer> This contains a list of positive integers, split by comma.
Page 265 VIVOTEK "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL.
Page 266 VIVOTEK <x>: nonnegative integer - (hidden) : UI is hidden. <product dependent> - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked.
Page 267 VIVOTEK or greater than 0302a. is_strength <boolean> 0: Non-support tuning strength of image stabilizer mode. 1: Support tuning strength of image stabilizer mode. * Only available when "capability_image_c<0~(n-1)>_is_m ode" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 268 VIVOTEK value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled.
Page 269 VIVOTEK name":"Policy":"Description" <x>: nonnegative integer <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden.
Page 270 VIVOTEK 3dnr:unchanged:, or others The format is "Affect API name":"Policy":"Description" <x>: nonnegative integer <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it.
Page 271 VIVOTEK <product dependent> mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here. 3dnr:unchanged:, or others The format is "Affect API name":"Policy":"Description" <x>: nonnegative integer <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it.
Page 272 VIVOTEK scenemode_lpcstreet_aff When scene mode is enabled, some minexposure:hidden:, features may become malfunction or <product dependent> mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here. 3dnr:unchanged:,or others The format is "Affect API <x>: nonnegative integer name":"Policy":"Description"...
Page 273 VIVOTEK "capability_image_c<0~(n-1)>_ scenemode_support" is 1 wbmode auto, Available white balance mode. manual, "-" means white balance is not rbgain, supported. widerange, outdoor,indoor, sodiumauto, <product dependent> iristype piris, Indicate iris type. dciris, "piris": P-Iris ...
Page 274 VIVOTEK exposure_shuttervaluetyp fixed, * One to one mapping to the mode maximum, type in "exposure_modetype". "fixed": The shutter value is the assigned value (videoin_c<0~(n-1)>_shuttervalue). "maximum": The shutter value can be up to the assigned value (videoin_c<0~(n-1)>_shuttervalue). "-": not support. * Only available when "capability_image_c<0~(n-1)>_expo...
Page 275 VIVOTEK <x>: nonnegative integer <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden.
Page 276 VIVOTEK en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here. exposurelevel:hidden:, or others The format is "Affect API name":"Policy":"Description" <x>: nonnegative integer <product dependent> "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it.
Page 277 VIVOTEK "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_irisprioritymod When exposure iris priority mode is e_affect exposurewin.mode.blc:hidd enabled, some features may become en:, malfunction or be forced to a given defog:disabled:, value.
Page 278 VIVOTEK integer or string or NULL. "-" means no feature is affected. * Only available when irispriority is listed in "capability_image_c<0~(n-1)>_ exposure_modetype" and "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
Page 279 VIVOTEK which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected.
Page 280 VIVOTEK - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6"...
Page 281 VIVOTEK * Only available when hlc is listed in "capability_image_c<0~(n-1)>_ exposure_winmode". exposure_hlcmode_affect When hlc mode is enabled, some or others features may become malfunction or be forced to a given value. The <x>: nonnegative integer affected functions are list here.
Page 282 VIVOTEK * Only available when manual is listed in "capability_image_c<0~(n-1)>_ exposure_modetype" and hlc is listed in "capability_image_c<0~(n-1)>_ exposure_winmode". * We support this parameter when the version number (httpversion) is equal or greater than 0304a. exposure_wintype inclusive, The supported exposure window type.
Page 283 VIVOTEK <product dependent> etc. "-" means maximum exposure time is not available. * When "exposure_mode"=0, this value must be set to "-". exposure_minrange "1,32000", Available range for "1,8000", "videoin_c<n>_minexposure" "1,32000" => 1s ~ 1/32000s or others ...
Page 284 VIVOTEK "-" means "videoin_c<n>_mingain" is not available. flickerless 0: Non-support flickerless 1: Support flickerless flickerlessaffect When flickerless is enabled, some minexposure:hidden:, features may become malfunction or mingain:hidden:, be forced to a given value. The or others affected functions are list here.
Page 285 VIVOTEK "-" means no feature is affected. * When "flickerless" = 0, this value must be "-" defog_mode 0: Non-support defog 1: Support defog defog_strength 0, 1 0: Non-support tuning strength of defog 1: Support tuning strength of defog * If "capability_image_c<0~(n-1)>_defog...
Page 286 VIVOTEK hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL.
Page 287 VIVOTEK than 0, it means that the camera supports remotefocus function in this channel. bit 0 => Indicate whether to support both zoom and focus function. bit 1 => Only support zoom function. bit 2 => Only support focus function.
Page 288 VIVOTEK version number (httpversion) is equal or greater than 0302a. * Only available when "capability_image_c<0~(n-1)>_sens ortype" is "smartsensor" Group: capability_peripheral_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) devicecontrol <boolean> Indicate whether to support the peripheral device control.
Page 289 VIVOTEK 7.26 Customized event script Group: event_customtaskfile_i<0~2> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Custom script identification of this entry. date string[4~20] Date of custom script. time string[4~20] Time of custom script. 7.27 Event setting Group: event_i<0~2> PARAMETER VALUE SECURITY...
Page 290 VIVOTEK 0,<positive integer> Indicate the source id of di trigger. This field is required when trigger condition is “di”. One bit represents one digital input. The LSB indicates DI 0. mdwin 0,<positive integer> Indicate the source window id of motion detection.
Page 291 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 292 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_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0, or capability_camctrl_c0_zoommodule >...
Page 293 VIVOTEK email_sslmode <boolean> Enable support SSL. 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.
Page 294 VIVOTEK snapshot_preevent 0~" Indicates the number of pre-event capability_media_snapshot_maxpr images. eevent" snapshot_postevent 0~" Indicates the number of post-event capability_media_snapshot_maxpo images. 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.
Page 295 VIVOTEK source 0~"capability_nmediastream"-1 6/6 Indicate the source of media stream. 0 means the first stream. 1 means the second stream and so on. 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>.
Page 296 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 297 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 298 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 299 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 300 VIVOTEK 7.33 Region of interest Group: roi_c<0~(n-1)> for n channel product and m is the index of video stream which support ePTZ. (capability.eptz > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-1)>_home <W,H> ROI left-top corner coordinate.* If the minimal <product dependent>...
Page 301 VIVOTEK Tilt speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.) panspeed -5 ~ 5 Pan speed * Only available when "capability_fisheye" is 1 Pan speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.) zoomspeed -5 ~ 5 Zoom speed * Only available when "capability_fisheye"...
Page 302 VIVOTEK Left-top corner coordinate of the preset. (It should be set by ePreset.cgi rather than by setparam.cgi.) preset_i<0~19>_size <WxH> Width and height of the preset. <product dependent> * Only available when "capability_fisheye" is 1 Width and height of the preset.
Page 303 VIVOTEK 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. resource_total_memory 0,<positive integer>...
Page 304 Indicate the message that will be show on the running status when mouse over. vvtklicensemec string[40] Indicate the module use VIVOTEK license mechanism Group: vadp_schedule_i<0~(n-1)> for n VADP package number n denotes the value of "capability_vadp_npackage". (Only available when "capability_vadp_npackage" > 0 and the version number of "vadp_version" >= "1.3.2.0")
Page 305 VIVOTEK 7.38 camera PTZ control Group: camctrl (capability.camctrl.ptztunnel > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enableptztunnel <boolean> Enable PTZ tunnel for camera control. Group: camctrl_c<0~(n-1)> for n channel products (capability.ptzenabled > 0) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset"...
Page 306 VIVOTEK 7.39 camera PTZ control (IZ series) Group: camctrl_c<0~(n-1)> for n channel products (capability_camctrl_c0_zoommodule = 1 and capability_camctrl_c0_buildinpt = 0) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset" NAME VALUE SECURITY DESCRIPTION (get/set) ccdtype string[16]...
Page 307 VIVOTEK * Only available when bit7 of capability_ptzenabled is 1 preset_i<0~(k-1)>_name string[40] Name of the preset location. preset_i<0~(k-1)>_zoom capability_ptz_c<0~(n-1) Zoom position at each preset location. >_minzoom ~ capability_ptz_c<0~(n-1) >_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...
Page 308 VIVOTEK 7.40 camera PTZ control (SD series) Group: camctrl_c<0~(n-1)> for n channel products (the bit7 of capability_ptzenabled is 0 and the bit4 of capability_ptzenabled is 1) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset" NAME...
Page 309 VIVOTEK >_maxtilt preset_i<0~(k-1)>_zoom capability_ptz_c<0~(n-1) Zoom position at each preset location. >_minzoom ~ capability_ptz_c<0~(n-1) >_maxzoom preset_i<0~(k-1)>_focus capability_ptz_c<0~(n-1) Focus position at each preset location. >_minfocus ~ capability_ptz_c<0~(n-1) >_maxfocus preset_i<0~(k-1)>_focus sync, The focus mode of each preset, which is setting fixcurrent essential and should be grouped with “preset_i<0~(k-1)>_name.”...
Page 310 VIVOTEK axisflip <boolean> Custom home flip side. returnhome <boolean> Enable/disable return home while idle. returnhomeinterval 1~999 While idle over this time interval, idle action will be taken. digitalzoom <boolean> Enable/disable digital zoom idleaction_enable <boolean> Enable/disable idle action while idle idleaction_type...
Page 311 VIVOTEK 7.41 UART control Group: uart (capability.nuart > 0 and capability.fisheye = 0) NAME VALUE SECURITY DESCRIPTION (get/set) ptzdrivers_i<0~19, string[40] Name of the PTZ driver. 127>_name ptzdrivers_i<0~19, string[128] Full path of the PTZ driver. 127>_location enablehttptunnel <boolean> Enable HTTP tunnel channel to control UART.
Page 312 VIVOTEK 7.42 UART control (SD series) Group: uart_i<0~(n-1)> n is uart port count (capability.nuart > 0 and the bit7 of capability_ptzenabled is 0, the bit4 of capability_ptzenabled is 1) NAME VALUE SECURITY DESCRIPTION (get/set) cameraid 1~255 Camera ID controlling external PTZ camera.
Page 313 VIVOTEK 7.43 Lens configuration Group: lens for n channel products n denotes the value of "capability_nvideoin" (capability.image.c<0~(n-1)>.lensconfiguration.support = 1) NAME VALUE SECURITY DESCRIPTION (get/set) selected <string> Current selected lens profile. e.g. lens_selected=lens_default_i0, it means choosen lens configuration is i0 lens of default group.
Page 314 VIVOTEK 7.44 Fisheye info Group: fisheyeinfo (capability.fisheye > 0) NAME VALUE SECURITY DESCRIPTION (get/set) revisedcenteraxis <coordinate> The actual center axis coordinate radius 0, <positive The actual center radius integer> 7.45 Fisheye local dewarp setting Group: fisheyedewarp_c<0~(n-1)> (capability_fisheyelocaldewarp_c<0~(n-1)> > 0) ...
Page 315 VIVOTEK 7.47 Auto tracking setting Group: autotrack_c<0~(n-1)> (capability_image_c<0~(n-1)>_autotrack_support > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) objsize_type -1~2 Type of object size. -1 : customized width and height 0 : object size = 30 x 30...
Page 316 VIVOTEK encrypt none, Encryption method: wep, none: NONE, wpa, wep: WEP, wpa2 wpa: WPA, wpa2: WPA2PSK authmode OPEN, SHARED Authentication mode. * Only valid when "wireless_encrypt" is "wep" keylength 64, 128 Key length in bits. * Only valid when "wireless_encrypt" is "wep"...
Page 317 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 318 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 319 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 320 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 321 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 322 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 323 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 324 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 325 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 326 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 327 VIVOTEK delpos <Text string less than Delete preset location from the preset list. 40 characters> return <return page> Redirect to the page <return page> after the parameter is assigned. The <return page> should be the relative path according to the root of camera.
Page 328 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 329 VIVOTEK ------------------------------------------------------------------------- POST /cgi-bin/operator/uartchannel.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache cache-control : no-cache content-length: 32767 expires: Sun, 9 Jam 1972 00:00:00 GMT User must use GET and POST to establish two channels for downstream and upstream. The x-sessioncookie in GET and POST should be the same to be recognized as a pair for one session.
Page 330 VIVOTEK cache-control : no-cache content-length: 32767 expires: Sun, 9 Jam 1972 00:00:00 GMT User must use GET and POST to establish two channels for downstream and upstream. The x-sessioncookie in GET and POST should be the same to be recognized as a pair for one session. The contents of upstream should be base64 encoded to be able to pass through the proxy server.
Page 331 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 332 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 333 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 334 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 335 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 336 VIVOTEK Request 2 will not be accepted during the execution time(15 seconds). 8.20 Open Timeshift Stream (capability.timeshift > 0, timeshift_enable=1, timeshift_c<n>_s<m>_allow=1) Note: This request requires Viewer access privileges. Syntax: For HTTP push server (MJPEG): http://<servername>/<network_http_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&reftime=<v alue>&forcechk&minsft=<value>] For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player.
Page 337 VIVOTEK Return Code Description 400 Bad Request Request is rejected because some parameter values are illegal. 415 Unsupported Media Type Returned, if forcechk appears,when minsft is not achievable or the timeshift feature of the target stream is not enabled. 8.21 RemoteFocus (capability_image_c<0~(n-1)>_remotefocus=1)
Page 338 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 339 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 340 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 340 - User's Manual...
Page 341 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 342 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 343 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 344 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 345 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 346 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 347 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 348 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 349 VIVOTEK 8.29 Camera Control (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/camctrl/camctrl.cgi?[channel=<value>][&camid=<value>] [&move=<value>] – Move home, up, down, left, right [&focus=<value>] – Focus operation [&zoom=<value>] – Zoom in, out [&zooming=<value>&zs=<value>] – Zoom without stopping, used for joystick [&vx=<value>&vy=<value>&vs=<value>] –...
Page 350 VIVOTEK speedpan -5 ~ 5 Set the pan speed. speedtilt -5 ~ 5 Set the tilt speed. speedzoom -5 ~ 5 Set the zoom speed. speedfocus -5 ~ 5 Set the focus speed. speedapp -5 ~ 5 Set the auto pan/patrol speed.
Page 351 VIVOTEK * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20. getsetpreset Adds a named preset at current position, and return the preset index. * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20.
Page 352 VIVOTEK gettiltangle <integer> Get the current tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getzoom 0, <positive integer> Get the current zoom position. getratio <decimal> Get the current zoom ratio. getfocus 0, <positive integer> Get the current focus position.
Page 353 VIVOTEK getmaxratio <decimal> Get the maximum ratio of optical zoom. * We support this parameter when the version number (getversion) is equal or greater than 5.0.0.14 getmaxdratio <decimal> Get the maximum ratio of digital zoom. * We support this parameter when the version number (getversion) is equal or greater than 5.0.0.14...
Page 354 VIVOTEK 8.31 Preset Locations (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/preset.cgi?[channel=<value>] [&addpos=<value>][&delpos=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION addpos string[30] Add one preset location to the preset list. channel 0~"capability_nvideoin"-1 Channel of the video source. delpos string[30] Delete preset location from preset list.
Page 355 VIVOTEK 8.32 SmartSD (capability_localstorage_smartsd > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/smartsd.cgi?function=<value> PARAMETER VALUE DESCRIPTION User's Manual - 355...
Page 356 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 357 VIVOTEK 8.33 Connet to AP (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION Apply the wireless settings and connect to AP. 8.34 Get wireless information (capability_network_wireless > 0) Note: This request requires Administrator privileges.
Page 358 VIVOTEK 8.35 Get wireless signal strength (capability_network_wireless > Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/getwlsignalstrength.cgi PARAMETER VALUE DESCRIPTION Get wireless signal strength. 8.36 WPS transaction (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/start_wps.cgi...
Page 359 VIVOTEK http://myserver/cgi-bin/admin/peripheral.cgi?channel=0&operation=set&washer_mode=wiper& washer_status=on Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "washer_mode : OK\r\n" "washer_status : FAIL\r\n" PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. washer_mode wiper Apply the wiper to the mode of washer control system.
Page 360 VIVOTEK capability_peripheral_c<0~(n-1)>_heater_suppo rt=1 trigger heater component is work in force heater once. *Only available when capability_peripheral_c<0~(n-1)>_heater_suppo rt=1 Syntax: (for querying API) http://<servername>/cgi-bin/admin/peripheral.cgi?channel=<value>&operation=get [&supportdevice] –Get support peripheral device [&washer_supportmode] – Get washer support modes [&washer_mode] – Get washer mode [&washer_status] – Get washer status [&washer_dwelltime] –...
Page 361 VIVOTEK "capability_peripheral_c<0~(n-1)>_washer_mod e" washer_status Get the current status of washer control module. The status is 'off' as default, which means the washer is stopped; and the status 'on' means the washer is running. *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 washer_dwelltime Get the current washer clean period of washer control system.
Page 362: Technical Specifications
VIVOTEK Technology License Notice Notices from HEVC Advance: THIS PRODUCT IS SOLD WITH A LIMITED LICENSE AND IS AUTHORIZED TO BE USED ONLY IN CONNECTION WITH HEVC CONTENT THAT MEETS EACH OF THE THREE FOLLOWING QUALIFICATIONS: (1) HEVC CONTENT ONLY FOR PERSONAL USE; (2) HEVC CONTENT THAT IS NOT OFFERED FOR SALE;...
Page 363 　　　　　　　　　VCCI-B Liability VIVOTEK Inc. cannot be held responsible for any technical or typographical errors and reserves the right to make changes to the product and manuals without prior notice. VIVOTEK Inc. makes no warranty of any kind with regard to the material contained within this document, including, but not limited to, the implied warranties of merchantability and fitness for any particular purpose.

Vivotek Supreme SD9374-EHL User Manual

Quick Links

Related Manuals for Vivotek Supreme SD9374-EHL

Summary of Contents for Vivotek Supreme SD9374-EHL

Table of Contents