Vivotek IT9380-H User Manual

Vivotek IT9380-H User Manual

Turret dome camera
Hide thumbs Also See for IT9380-H:

Advertisement

Quick Links

IT9360-H, IT9380-H
IT9388-HT
User 's Manual
5MP/2MP • Outdoor • IP66 • IK10 • Day & Night • Remote Focus (T) •
WDR Pro • Smart Stream III • 30M Smart IR
Turret Dome Camera
Rev. 1.0

Advertisement

Table of Contents
loading

Summary of Contents for Vivotek IT9380-H

  • Page 1 IT9360-H, IT9380-H IT9388-HT Turret Dome Camera User ’s Manual 5MP/2MP • Outdoor • IP66 • IK10 • Day & Night • Remote Focus (T) • WDR Pro • Smart Stream III • 30M Smart IR Rev. 1.0...
  • Page 2: Table Of Contents

    Applications > Motion detection.......................... 138 Applications > Tampering detection ........................141 Applications > Audio detection ......................... 142 Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) ..... 144 Recording > Recording settings ........................147 Local storage > SD card management ....................... 152 Local storage >...
  • Page 3: Overview

    WDR function enabled, the frame rate is slightly reduced to 20fps. The firmware comes with another 4MP resolution mode with a 30fps frame rate. With the most updated VIVOTEK WDR Pro technology, the camera series is capable of capturing the highest quality images in both low light and high contrast environments.
  • Page 4: Revision History

    3. If powered by a power adapter, the adapter should be properly grounded. 4. Maintenance and repair work must always be carried out by qualified technical personnel. 5. Disconnect power from the unit when performing a maintenance task. 6. Please contact VIVOTEK's certified dealers for power adapters. 4 - User's Manual...
  • Page 5: Package Contents

    VIVOTEK Package Contents ■ IT9360-H / IT9380-H / IT9388-HT ■ Mount bracket ■ Alignment sticker ■ Screws. ■ Waterproof cable housing ■ T10 torx wrench. ■ Quick Installation Guide. WARNING: 1. IR lights emit from ths product. 2. Use live view to verify if the IR lights are in the night mode.
  • Page 6: Physical Description

    VIVOTEK Physical Description Outer View Mount bracket (base plate) Lens IR LEDs Microphone IT9388T Inner View Reset SD card slot button SD card slot Reset button 6 - User's Manual...
  • Page 7 VIVOTEK IMPORTANT: Many copper coated aluminum (CCA) and other non-standard conductors cabling products are masqueraded as CAT5E or CAT6 cables. Please avoid using these CCA products especially when cascading PoE cameras. It is a must to use Ethernet cables compliant with the 3P/ETL standard.
  • Page 8 VIVOTEK NOTE: Some of the suffix syntax used in model naming are listed below: w/ heater for extreme weather Focal length w/ number w/ Remote focus lens w/ PoE repeater w/ High Dynamic Range functionality Manual focus lens IMPORTANT: Power consumption: Consumption &...
  • Page 9: Hardware Installation

    VIVOTEK Hardware Installation 1. Jot down the camera's MAC address for later reference. XXXXXX 0002D10766AD Below are the tilt, pan, and rotation limitations. 180° 180° User's Manual - 9...
  • Page 10 VIVOTEK 2. Remove the camera main body from the base plate using the T10 torx wrench. You need only to loosen, but not completely remove the T10 screw. 10 - User's Manual...
  • Page 11 VIVOTEK 3. Loosen the 3 screws from on the main body. 4. Install a MicroSD card if onboard storage is preferred. IT9388T IT9360, IT9380 Reset button Reset button User's Manual - 11...
  • Page 12 VIVOTEK Avoid touching the circuit board to prevent the damage from electro-static discharge. If available, it is recommended to wear an anti-static wrist band. 4-1. Open the SD card socket lid by sliding it backward and flip open the lid.
  • Page 13 VIVOTEK 4-2. Insert a MicroSD card into the socket on the lid, with its gold fingers facing down. Close the lid. Gold fingers facing downward 4-3. Slide the lid forward. A click sound should be heard to indicate that the lid and the card is secured in place.
  • Page 14 VIVOTEK 4-4. Replace the desiccant bag on the inside of the top cover. 5. Tighten the 3 T10 srews to secure camera top cover. 14 - User's Manual...
  • Page 15 VIVOTEK 6. Use the included alignment sticker to drill holes for mounting screws and a cabling hole if applicable. Alignment Sticker P/N:621063800G 7. If a cabling through hole is preferred, it should have a diameter larger than 25mm. Pull a CAT5e Ethernet cable through the hole.
  • Page 16 VIVOTEK 8. Disassemble the cable gland and install the waterproof seal components to the Ethernet cable. 9. Connect the Ethernet cable to the camera's RJ45 female socket. Tighten up the waterproof components. Make sure they are adequately installed to prevent damage by moisture.
  • Page 17 VIVOTEK It is a good practice to form a drip loop on the back-end cable. Leakage or moisture can gather in condensation into water drops and run along the cable. A drip loop ensures no water gets to the camera.
  • Page 18 VIVOTEK Shown below are the different alignment stickers. IT9360/9380 IT9388T Alignment Sticker Alignment Sticker P/N:621063800G P/N:621063900G 11. Match the outer shroud with the camera's main body. 18 - User's Manual...
  • Page 19 VIVOTEK 12. Install the camera to the base plate. It is easier to install by matching the groove on the outer shroud with the inner rim on the base plate. groove groove 13. Tighten the T10 retention screw. User's Manual - 19...
  • Page 20: Software Installation

    Software Installation 14. 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 21 VIVOTEK 14-3. The program will search for all VIVOTEK network devices on the same LAN. 14-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 22 VIVOTEK Forceful Password Configuration 15. The first time you log in to the camera, the firmware will prompt for a password configuration for security concerns. Protecting your camera with a password can deter the majority of cyber attacks. 15-1. Enter the combination of alphabetic and numeric characters to fulfill the password strength.
  • Page 23 VIVOTEK 15-2. Another prompt will request for the password you just configured. Enter the password and then you can start configure your camera and see the live view. 16. Remove the protective sheet from the lens. User's Manual - 23...
  • Page 24 VIVOTEK IMPORTANT: Pan the camera first. You may clog the cable if tilting the camera first. Tilt the camera back to its upright position, and try again if you can not turn the camera towards a preferred orientation. 17. With a live view, pan, tilt, or rotate the camera to acquire an optimal field of view.
  • Page 25 VIVOTEK 18. When done, tighten the retention screw on the camera. User's Manual - 25...
  • Page 26 Configuration > Media > Image > Focus NOTE: The IT9360-H and IT9380-H are the fixed- lens model, and do not support the Zoom and Auto Focus function. The "T" models comes with a motorized focus lens.
  • Page 27 VIVOTEK LED Definitions There are no LEDs on this model. Hardware Reset The reset button is used to reset the system or restore the factory default settings. Sometimes resetting the system can return the camera to normal operation. If the system problems remain after reset, restore the factory settings and install again.
  • Page 28: Network Deployment

    VIVOTEK Network Deployment General Connection (PoE) When using a PoE-enabled switch The Network Camera is PoE-compliant, allowing transmission of power and data via a sin- gle Ethernet cable. Follow the below illustration to connect the Network Camera to a PoE- enabled switch via Ethernet cable.
  • Page 29: 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 VAST recording software from our website in a deployment consisting of multiple cameras.
  • Page 30 VIVOTEK Internet connection via a router Before setting up the Network Camera over the Internet, make sure you have a router and follow the steps below. 1. Connect your Network Camera behind a router, the Internet environment is illustrated below.
  • Page 31 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 32: Accessing The Network Camera

    3. Live video will be displayed in your web browser. 4. If it is the first time installing the VIVOTEK network camera, an information bar will prompt as shown below. Follow the instructions to install the required plug-in on your computer.
  • Page 33 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 105.
  • Page 34 VIVOTEK IMPORTANT: • Currently the Network Camera utilizes a 32-bit ActiveX plugin. You CAN NOT open a management/view session with the camera using a 64-bit IE browser. • If you encounter this problem, try execute the Iexplore.exe program from C:\Windows\ SysWOW64.
  • Page 35: Using Rtsp Players

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

    VIVOTEK Using 3GPP-compatible Mobile Devices To view the streaming media through 3GPP-compatible mobile devices, make sure the Network Camera can be accessed over the Internet. For more information on how to set up the Network Camera over the Internet, please refer to Setup the Network Camera over the Internet on page To utilize this feature, please check the following settings on your Network Camera: 1.
  • Page 37: 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 38: Main Page

    VIVOTEK Main Page This chapter explains the layout of the main page. It is composed of the following sections: VIVOTEK INC. Logo, Host Name, Camera Control Area, Configuration Area, Menu, and Live Video Window. Resize Buttons VIVOTEK INC. Host Name...
  • Page 39 VIVOTEK Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 43. Configuration: Click this button to access the configuration page of the Network Camera. It is suggested that a password be applied to the Network Camera so that only the administrator can configure the Network Camera.
  • Page 40 VIVOTEK PTZ Panel: This Network Camera supports “digital“ (e-PTZ) pan/tilt/zoom control, which allows roaming a smaller view frame within a large view frame. Please refer to PTZ settiings on page 120 for detailed information. Global View: Click on this item to display the Global View window. The Global View window contains a full view image (the largest frame size of the captured video) and a floating frame (the viewing region of the current video stream).
  • Page 41 VIVOTEK Video Control Buttons: Depending on the Network Camera model and Network Camera configuration, some buttons may not be available. Snapshot: Click this button to capture and save still images. The captured images will be displayed in a pop-up window. Right-click the image and choose Save Picture As to save it in JPEG (*.jpg) or BMP (*.bmp) format.
  • Page 42 VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Time 2019/01/25 17:08:56 Video (HTTP-V) Title and Time Video 17:08:56 2019/01/25 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 66.
  • Page 43: Client Settings

    VIVOTEK Client Settings This chapter explains how to select the stream transmission mode and saving options on the local computer. When completed with the settings on this page, click Save on the page bottom to enable the settings. H.265/H.264 Media Options Select to stream video or audio data or both.
  • Page 44 VIVOTEK MP4 Saving Options Users can record live video as they are watching it by clicking Start MP4 Recording on the main page. Here, you can specify the storage destination and file name. Folder: Specify a storage destination on your PC for the recorded video files. The location can be changed.
  • Page 45 VIVOTEK Joystick settings Enable Joystick Connect a joystick to a USB port on your management computer. Supported by the plug-in (Microsoft’s DirectX), once the plug-in for the web console is loaded, it will automatically detect if there is any joystick on the computer. The joystick should work properly without installing any other driver or software.
  • Page 46 VIVOTEK Buttons Configuration In the Button Configuration window, the left column shows the actions you can assign, and the right column shows the functional buttons and assigned actions. The number of buttons may differ from different joysticks. Please follow the steps below to configure your joystick buttons: 1.
  • Page 47 VIVOTEK Buttons Configuration Click the Configure Buttons button, a window will prompt as shown below. Please follow the steps below to configure your joystick buttons: 1. Select a button number from the Button # pull-down menu. Tips: If you are not sure of the locations of each button, use the Properties window in the Game Controllers utility.
  • Page 48: Configuration

    Click Configuration on the main page to enter the camera setting pages. Note that only Administrators can access the configuration page. VIVOTEK provides an easy-to-use user interface that helps you set up your network camera with minimal effort. In order to simplify the user interface, detailed information will be hidden unless you click on the function item.
  • Page 49: System > General Settings

    VIVOTEK System > General settings This section explains how to configure the basic settings for the Network Camera, such as the host name and system time. It is composed of the following two columns: System, and System Time. When finished with the settings on this page, click Save at the bottom of the page to enable the settings.
  • Page 50 VIVOTEK System time Keep current date and time: Select this option to preserve the current date and time of the Network Camera. The Network Camera’s internal real-time clock maintains the date and time even when the power of the system is turned off.
  • Page 51: System > Homepage Layout

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

    VIVOTEK System > Logs This section explains how to configure the Network Camera to send the system log to a remote server as backup. Log server settings Follow the steps below to set up the remote log: 1. Select Enable remote log.
  • Page 55 You can install the included VAST recording software, which provides an Event Management function group for delivering event messages via emails, GSM short messages, onscreen event panel, or to trigger an alarm, etc. For more information, refer to the VAST User Manual. VIVOTEK Network Cameras Internet 3G Cell phone HTTP...
  • Page 56: System > Parameters

    VIVOTEK Access log Access log displays the access time and IP address of all viewers (including operators and administrators) in a chronological order. The access log is stored in the Network Camera’s buffer area and will be overwritten when reaching a certain limit.
  • Page 57: System > Maintenance

    Note: Do not power off the Network Camera during the upgrade! Follow the steps below to upgrade the firmware: 1. Download the latest firmware file from the VIVOTEK website. The file is in .pkg file format. 2. Click Browse… and locate the firmware file.
  • Page 58 VIVOTEK General settings > Restore This feature allows you to restore the Network Camera to factory default settings. Network: Select this option to retain the Network Type settings (please refer to Network Type on page 88). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
  • Page 59 VIVOTEK ® 3. Open the file with Microsoft Notepad and locate your time zone; set the start and end time of DST. When completed, save the file. In the example below, DST begins each year at 2:00 a.m. on the second Sunday in March and ends at 2:00 a.m.
  • Page 60 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 61: Media > Image

    VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following columns: General settings, IR control, Image settings, Exposure, Focus, and Privacy mask. The Focus window is available only for models that come with motorized lens.
  • Page 62 VIVOTEK Video orientation: Flip - vertically reflect the display of the live video; Mirror - horizontally reflect the display of the live video. Select both options if the Network Camera is installed upside-down (e.g., on the ceiling) to correct the image orientation. Please note that if you have preset locations, those locations will be cleared after flip/mirror setting.
  • Page 63 VIVOTEK IR cut filter With a removable IR-cut filter, this Network Camera can automatically remove the filter to let Infrared light pass into the sensor during low light conditions. ■ Auto mode (The Day/Night Exposure Profile will not be available if Auto mode is selected) The Network Camera automatically removes the filter by judging the level of ambient light.
  • Page 64 VIVOTEK IR control Turn on built-in IR illuminator in night mode Select this to turn on the camera’s onboard IR illuminator when the camera detects low light condition and enters the night mode. Smart IR Anti-overexposure: When enabled, the camera automatically adjusts the IR projection to adjacent objects in order to avoid over-exposure in the night mode.
  • Page 65 VIVOTEK Tips: If there is an object in close proximity, the IR lights reflected back from it can mislead the Smart IR’s calculation of light level. To solve this problem, you can place an “Exposure Exclude” window on an unavoidable object in the Exposure setting window.
  • Page 66 VIVOTEK Image settings On this page, you can tune the White balance and Image adjustment. Sensor Setting 2: For special situations Sensor Setting 1: For normal situations White balance: Adjust the value for the best color temperature. ■ You may follow the steps below to adjust the white balance to the best color temperature.
  • Page 67 VIVOTEK Noise reduction ■ Enable noise reduction: Check to enable noise reduction in order to reduce noises and flickers in image. This applies to the onboard 3D Noise Reduction feature. Use the slide bar to adjust the reduction strength. Note that applying this function to the video channel will consume system computing power.
  • Page 68 VIVOTEK Exposure On this page, you can set the Exposure measurement window, Exposure level, Exposure mode, Exposure time, Gain control, and Day/Night mode settings. You can configure two sets of Exposure settings: one for normal situations, the other for special situations, such as the day/night/schedule mode.
  • Page 69 VIVOTEK The inclusive window refers to the “weighted window“; the exclusive window refers to “ignored window“. It adopts the weighted averages method to calculate the value. The inclusive windows have a higher priority. You can overlap these windows, and, if you place an exclusive window within a larger inclusive window, the exclusive part of the overlapped windows will be deducted from the inclusive window.
  • Page 70 VIVOTEK Exposure control: (not configurable when WDR is enabled) ■ Exposure level: You can manually set the Exposure level, which ranges from -2.0 to +2.0 (dark to bright). You can click and drag the semi-circular pointers on the Exposure time and Gain control slide bars to specify a range of shutter time and Gain control values within which the camera can automatically tune to an optimal imaging result.
  • Page 71 VIVOTEK You can click Restore to recall the original settings without incorporating the changes. When completed with the settings on this page, click Save to enable the settings. If you want to configure another sensor setting for day/night/schedule mode, please click Profile to open the Profile of exposure settings page as shown below.
  • Page 72 VIVOTEK Focus (T model) Focus here refers to the Remote Focus, applicable to Network Cameras that are equipped with a stepping motor lens. The automated focus adjustment function eliminates the needs to physically adjust camera focus. In an outdoor deployment consisting of a large number of cameras, the auto focus function can be very helpful when these cameras become out of focus after days or weeks of operation.
  • Page 73 VIVOTEK 5. Wait for the scan to complete. After a short while, the clearest image obtained should be displayed and the optimal focus range achieved. Use the arrow marks on the sides to fine-tune the focus if you are not satisfied with the results. You may still need to use the arrow marks to fine-tune the focus depending on the live image on your screen.
  • Page 74 VIVOTEK Privacy mask Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to address privacy concerns. ■ To configure privacy mask windows, 1. Click New to add a new window. 2. You can use 4 mouse clicks to create a new masking window, which is recommended to be at least twice the size of the object (height and width) you want to cover.
  • Page 75: Media > Video

    VIVOTEK Media > Video Mode The applicable video modes include: ■ 5 Megapixel (4:3) (max. 30fps): This is the full resolution at 5 megapixels in a 4:3 screen aspect ratio. ■ 4 Megapixel (16:9) (max. 20fps): At the 16:9 aspect ratio and with the WDR Pro function, the usable resolution is slightly reduced to 4MP.
  • Page 76: Media > Video

    VIVOTEK Media > Video Stream settings This Network Camera supports multiple streams with frame sizes ranging from 480 x 352 to 2560 x 1920 pixels The definition of multiple streams: ■ Stream 1: Users can define the "Region of Interest" (viewing region) and the "Output Frame Size"...
  • Page 77: Media > Video

    VIVOTEK Please follow the steps below to set up those settings for a stream: 1. Select a stream for which you want to set up the viewing region. 2. Select a Region of Interest from the drop-down list. The floating frame, the same as the one in the Gloabl View window on the home page, will resize accordingly.
  • Page 78 VIVOTEK Click the stream item to display the detailed information. The maximum frame size will follow your settings in the above Viewing Window sections. This Network Camera provides real-time H.265, H.264 and MJPEG compression standards (Triple Codec) for real-time viewing. If the H.265...
  • Page 79 VIVOTEK The frame rate will decrease if you select a higher resolution. ■ Intra frame period Determine how often for firmware to plant an I frame. The shorter the duration, the more likely you will get better video quality, but at the cost of higher network bandwidth consumption. Select the intra frame period from the following durations: 1/4 second, 1/2 second, 1 second, 2 seconds, 3 seconds, and 4 seconds.
  • Page 80 VIVOTEK With the H.265 codec in an optimal scenario and when Dynamic Intra frame is combined with the Smart Stream function, an 80% of bandwidth saving can be achieved comparing with using H.264 without enabling these bandwidth-saving features. ■ Smart FPS In a static scene, the algorithm puts old frames in queue when no motions occur in scene.
  • Page 81 VIVOTEK • 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. You can manually specify the video quality for the foreground and the background areas.
  • Page 82 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 83 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 84 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 85 VIVOTEK If the JPEG mode is selected, the Network Camera sends consecutive JPEG images to the client, producing a moving effect similar to a filmstrip. Every single JPEG image transmitted guarantees the same image quality, which in turn comes at the expense of variable bandwidth usage. Because the media contents are a combination of JPEG images, no audio data is transmitted to the client.
  • Page 86: 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 87: 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 26 for details.
  • Page 88 VIVOTEK Primary DNS: The primary domain name server that translates hostnames into IP addresses. Secondary DNS: Secondary domain name server that backups the Primary DNS. Primary WINS server: The primary WINS server that maintains the database of computer names and IP addresses.
  • Page 89 VIVOTEK NOTE: ► If the default ports are already used by other devices connected to the same router, the Network Camera will select other ports for the Network Camera. ► If UPnP is not supported by your router, you will see the following message: Error: Router does not support UPnP port forwarding.
  • Page 90 VIVOTEK 4. In the Networking Services dialog box, select Universal Plug and Play and click OK. 5. Click Next in the following window. 6. Click Finish. UPnP is enabled. ► How does UPnP work? UPnP networking technology provides automatic IP configuration and dynamic discovery of devices added to a network.
  • Page 91 VIVOTEK Enable IPv6 Select this option and click Save to enable IPv6 settings. Please note that this only works if your network environment and hardware equipment support ® IPv6. The browser should be Microsoft Internet Explorer 6.5, Mozilla Firefox 3.0 or above.
  • Page 92 VIVOTEK Please follow the steps below to link to an IPv6 address: 1. Open your web browser. 2. Enter the link-global or link-local IPv6 address in the address bar of your web browser. 3. The format should be: http://[2001:0c08:2500:0002:0202:d1ff:fe04:65f4]/ IPv6 address 4.
  • Page 93 VIVOTEK User's Manual - 93...
  • Page 94: 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 105 for details. Authentication: Depending on your network security requirements, the Network Camera provides two types of security settings for an HTTP transaction: basic and digest.
  • Page 95 VIVOTEK URL command -- http://<ip address>:<http port>/<access name for stream 1, 2, 3> For example, when the Access name for stream 2 is set to video1s2.mjpg: 1. Launch Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter.
  • Page 96 VIVOTEK Authentication: Depending on your network security requirements, the Network Camera provides three types of security settings for streaming via RTSP protocol: disable, basic, and digest. basic authentication is selected, the password is sent in plain text format, but there can be digest potential risks of it being intercepted.
  • Page 97 Unrestricted in scope IMPORTANT: The Multicast metadata port is utilized by VIVOTEK VADP modules to transfer video analytics results, PTZ stream, textual data, and event messages between the camera and the client side running and observing the video analysis. If your client side computer is located outside the local network, you may need to open the associated TCP port on routers and firewall.
  • Page 98 IP address, to have a fixed host and domain name. Express link Express Link is a free service provided by VIVOTEK server, which allows users to register a domain name for a network device. One URL can only be mapped to one MAC address.
  • Page 99 DDNS: Dynamic domain name service Enable DDNS: Select this option to enable the DDNS setting. Provider: Select a DDNS provider from the provider drop-down list. VIVOTEK offers Safe100.net, a free dynamic domain name service, to VIVOTEK customers. It is recommended that you register Safe100.net to access VIVOTEK’s Network Cameras from the...
  • Page 100 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 101 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 102 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 103: 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 104: 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 105: 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”...
  • Page 106 VIVOTEK Privilege management Allow anonymous viewing: If you select this item, any client can access the live stream without entering a User ID and Password. 106 - User's Manual...
  • Page 107: Security > Https (Hypertext Transfer Protocol Over Ssl)

    VIVOTEK Security > HTTPS (Hypertext Transfer Protocol over SSL) This section explains how to enable authentication and encrypted communication over SSL (Secure Socket Layer). It helps protect streaming data transmission over the Internet on higher security level. Create and Install Certificate Method Before using HTTPS for communication with the Network Camera, a Certificate must be created first.
  • Page 108 VIVOTEK 5. Click Save to preserve your configuration, and your current session with the camera will change to the encrypted connection. 6. If your web session does not automatically change to an encrypted HTTPS session, click Home to return to the main page. Change the URL address from “http://” to “https://“ in the address bar and press Enter on your keyboard.
  • Page 109 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 110 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 111 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 112 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. 112 - User's Manual...
  • Page 113 VIVOTEK Note that 11. When the certifice file is successfully loaded, its status will be stated as Active. a certificate must have been created and installed before you can click on the “Save" button for the configuration to take effect.
  • Page 114: Security > Access List

    VIVOTEK Security > Access List This section explains how to control access permission by verifying the client PC’s IP address. General Settings Maximum number of concurrent streaming connection(s) limited to: Simultaneous live viewing for 1~10 clients (including stream 1 to stream 3). The default value is 10. If you modify the value and click Save, all current connections will be disconnected and automatically attempt to re-link (IE Explorer or Quick Time Player).
  • Page 115 VIVOTEK ■ Refresh: Click this button to refresh all current connections. ■ Add to deny list: You can select entries from the Connection Status list and add them to the Deny List to deny access. Please note that those checked connections will only be disconnected temporarily and will automatically try to re-link again (IE Explore or Quick Time Player).
  • Page 116 VIVOTEK There are three types of rules: Single: This rule allows the user to add an IP address to the Allowed/Denied list. For example: 192.168.2.1 Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List.
  • Page 117 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 118 VIVOTEK 3. When all settings are complete, move the Network Camera to the protected LAN by connecting it to an 802.1x enabled switch. The devices will then start the authentication automatically. NOTE: ► The authentication process for 802.1x: 1. The Certificate Authority (CA) provides the required signed certificates to the Network Camera (the supplicant) and the RADIUS Server (the authentication server).
  • Page 119 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 120: Ptz > Ptz Settings

    VIVOTEK PTZ > PTZ settings This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation. Digital: Control the e-PTZ operation. Within a field of view,it allows users to quickly move the focus to a target area for close-up viewing without physically moving the camera.
  • Page 121 VIVOTEK Home page in the E-PTZ Mode ■ The e-Preset Positions will also be displayed on the home page. Select one from the drop-down list, and the Network Camera will move to the selected position. ■ If you have set up different preset positions for different streams, you can select one of the video streams to display its separate preset positions.
  • Page 122 VIVOTEK Patrol settings You can select some preset positions for the Network Camera to patrol. Please follow the steps below to set up a patrol schedule: 1. Select the preset locations on the list, and click 2. The selected preset locations will be displayed on the Patrol locations list.
  • Page 123 VIVOTEK NOTE: • The Preset Positions will also be displayed on the Home page. Select one from the Go to menu, and the Network Camera will move to the selected preset position. • Click Patrol: The Network Camera will patrol along the selected positions repeatedly.
  • Page 124: Event > Event Settings

    VIVOTEK Event > Event settings This section explains how to configure the Network Camera to respond to particular situations (event). A typical application is that when a motion is detected, the Network Camera sends buffered images to an FTP server or e-mail address as notifications. Click on Help, there is an illustration shown in the pop-up window explaining that an event can be triggered by many sources, such as motion detection or external digital input devices.
  • Page 125 VIVOTEK ■ Event name: Enter a name for the event setting. ■ Enable this event: Select this checkbox to enable the event setting. ■ Priority: Select the relative importance of this event (High, Normal, or Low). Events with a higher priority setting will be executed first.
  • Page 126 VIVOTEK ■ Audio detection A preset threshold can be configured with an external microphone as the trigger to system event. The triggering condition can be an input exceeding or falling below a threshold. Audio detection can take place as a complement to motion detection or as a method to detect activities not covered by the camera's view.
  • Page 127 VIVOTEK Once the triggers are configured, they will be listed under the VADP option. 3. Action Define the actions to be performed by the Network Camera when a trigger is activated. ■ Backup media if the network is disconnected Select this option to backup media file on SD card if the network is disconnected. This function will only be displayed after you set up a network storage (NAS).
  • Page 128 VIVOTEK Add server It is necessary to configure the server and media settings so that the Network Camera will know what action to take (such as which server to send the media files to) when a trigger is activated. Click server to open the server setting window.
  • Page 129 VIVOTEK To verify if the email settings are correctly configured, click Test. The result will be shown in a pop-up window. If successful, you will also receive an email indicating the result. Click Save server to enable the settings. Note that after you configure the first event server, the new event server will automatically display on the Server list.
  • Page 130 VIVOTEK ■ Passive mode Most firewalls do not accept new connections initiated from external requests. If the FTP server supports passive mode, select this option to enable passive mode FTP and allow data transmission to pass through the firewall. The firmware default has the Passive mode checkbox selected.
  • Page 131 VIVOTEK Network storage: Select to send the media files to a networked storage when a trigger is activated. Please refer to NAS server on page 150 for details. Note that only one NAS server can be configured. Click Save server to enable the settings.
  • Page 132 VIVOTEK Click 20190120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2019/01/20 2019/01/20 Click to go back to the previous Click to delete level of the directory selected items Click to delete all...
  • Page 133 VIVOTEK Add media Add media Click to open the media setting window. You can specify the type of media that will be sent when a trigger is activated. A total of 5 media settings can be configured. There are three choices of media types available: Snapshot, Video Clip, and System log.
  • Page 134 VIVOTEK ■ Add date and time suffix to the file name Select this option to add a date/time suffix to the file name. For example: Snapshot_20190513_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings.
  • Page 135 VIVOTEK ■ Maximum file size Specify the maximum file size allowed. Some users may need to stitch the video clips together when searching and packing up forensic evidence. ■ File name prefix Enter the text that will be appended to the front of the file name.
  • Page 136 VIVOTEK In the Event settings column, the Servers and Medias you configured will be listed; please make sure the Event -> Status is indicated as ON, in order to enable the event triggering action. When completed, click the Save event button to enable the settings and click Close to exit Event Settings page.
  • Page 137 Please note that there is a limited number of customized scripts you can upload; if the current amount of customized scripts has reached the limit, an alert message will prompt. If you need more information, please contact VIVOTEK technical support. 20180213...
  • Page 138: 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 1: For normal situations Follow the steps below to enable motion detection: 1.
  • Page 139 VIVOTEK Photos or videos can be captured instantly and configured to be sent to a remote server (via an Email or FTP server). For more information on how to configure an event setting, please refer to Event settings on page 116.
  • Page 140 VIVOTEK This motion detection window will also be displayed on the Event Settings page. You can go to Event > Event settings > Trigger to select it as a trigger source. Please refer to page 125 for detailed information. NOTE: ►...
  • 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 > Package Management - A.k.a., Vadp (Vivotek Application Development Platform)

    Users can store and execute VIVOTEK's or 3rd-party software modules onto the camera's flash memory or SD card. These software modules can apply in video analysis for intelligent video applications such as license plate recognition, object counting, or as an agent for edge recording, etc.
  • Page 145 VIVOTEK To utilize a software module, acquire the software package and click Browse and Upload buttons. The screen message for a successful upload is shown below: To start a module, select the checkcircle in front, and click the Start button.
  • 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 via the camera’s web console (in the Local storage .
  • Page 148 VIVOTEK If you enable adaptive recording on a camera, only when an event is triggered on Camera A will the server record the full frame rate streaming data; otherwise, it will only request the I frame data during normal monitoring, thus effectively saves bandwidths and storage space.
  • Page 149 VIVOTEK 2. Destination You can select the SD card or network storage (NAS) for the recorded video files. If you have not configured a NAS server, see details in the following. NAS server Click Add NAS server to open the server setting window and follow the steps below to set up: 1.
  • Page 150 VIVOTEK If successful, you will receive a test.txt file on the networked storage. 3. Enter a server name. 4. Click Save to complete the settings and click Close to exit the page. ■ Capacity: You can choose either the entire free space available or limit the reserved space. The recording size limit must be larger than the reserved amount for cyclic recording.
  • Page 151 VIVOTEK Event f you want to enable recording notification, please click to configure event triggering settings. Please refer to Event > Event settings on page 124 for more details. When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page.
  • 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 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 VIVOTEK http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/operator/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/admin/setparam.cgi? <parameter>=<value>...
  • Page 160 VIVOTEK 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 Response: HTTP/1.0 200 OK\r\n...
  • 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 <WxH> The format for resolution. 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 Paz, Santiago -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...
  • Page 165 VIVOTEK Melbourne, Sydney, Guam, Vladivostok 440: GMT 11:00 Magadan, Solomon Is., New 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.
  • Page 166 VIVOTEK parameters will be restored to default values except for a union of combined results. restoreexceptlang Restore the system parameters to default <positive integer> values except the custom language file the user has uploaded. This command can cooperate with other “restoreexceptXYZ”...
  • Page 167 VIVOTEK * Only available when "capability_image_c<0~(n-1)>_lensconfigu ration_support" != 0. 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.
  • Page 168 VIVOTEK integer> supported on the server. customlanguage_count 0,<positive Number of custom languages which have integer> been uploaded to the server. customlanguage_i<0~(ma string Custom language name. xcount-1)> 7.2status Group: status NAME VALUE SECURITY DESCRIPTION (get/set) di_i<0~(capability_ndi-1)> <boolean> 0 => Inactive, normal <product dependent>...
  • Page 169 VIVOTEK 7.2.1 status per channel Group: status_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) signal_detect <boolean> Indicates whether the video source is connected or not. * Only available when capability_videoin_type is 0 or 1.
  • Page 170 VIVOTEK admin control PTZ (capability_ptzenabled > 0 or capability_eptz > 0) user_i0_name string[64] User name of root user_i<1~20>_name string[64] User name user_i0_pass password[64] Root password user_i<1~20>_pass password[64] User password user_i0_privilege view, Root privilege operator, admin user_i<1~20>_ privilege view, User privilege...
  • Page 171 VIVOTEK ”/cgi-bin/admin/setparam.cgi? network_preprocess=9&network_http_port =5556& network_rtp_videoport=20480” type lan, Network connection type. pppoe resetip <boolean> 1 => Get ipaddress, subnet, router, dns1, dns2 from DHCP server at next reboot. 0 => Use preset ipaddress, subnet, rounter, dns1, and dns2. ipaddress <ip address>...
  • Page 172 VIVOTEK privatekey_exist <boolean> Private key installed flag (for TLS) privatekey_time 0,<positive Private key installed time. Represented in integer> EPOCH privatekey_size 0,<positive Private key file size (in bytes) integer> 7.6.2 QOS Subgroup of network: qos_cos (capability_protocol_qos_cos > 0) NAME VALUE SECURITY...
  • Page 173 VIVOTEK addonrouter <ip address> IPv6 router address. addondns <ip address> IPv6 DNS address. allowoptional <boolean> Allow manually setup of IP address setting. 7.6.4 FTP Subgroup of network: ftp NAME VALUE SECURITY DESCRIPTION (get/set) port 21, 1025~65535 Local ftp server port.
  • Page 174 VIVOTEK anonymousviewing <boolean> Enable anonymous streaming viewing. 7.6.5.1 HTTP per channel Subgroup of network: http_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) s<0~(capability_nmediast string[32] Http server push access name for channel N ream-1)>_accessname...
  • Page 175 VIVOTEK 7.6.7 RTSP Subgroup of network: rtsp (capability_protocol_rtsp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 554, 1025 ~ 65535 RTSP port. (capability_protocol_rtsp=1) anonymousviewing <boolean> Enable anoymous streaming viewing. authmode disable, RTSP authentication mode. basic, (capability_protocol_rtsp=1) digest s<0~(capability_nmediast string[32] RTSP access name for channel/stream N, N= ream*capability_nvideoin 1~ capability_nmediastream.
  • Page 176 VIVOTEK network_rtsp_s<0~(n-1)>_multicast_videoipaddress ". * Reserved for compatibility, and suggest don't use this since [httpversion] > 0304a videoipaddress <ip address> Multicast video IP address. * We support this parameter when the version number (httpversion) is equal or greater than 0304a. audioipaddress <ip address>...
  • Page 177 VIVOTEK 7.6.11 PPPoE Subgroup of network: pppoe (capability_protocol_pppoe > 0) NAME VALUE SECURITY DESCRIPTION (get/set) user string[128] PPPoE account user name. pass password[64] PPPoE account password. 7.7IP Filter Group: ipfilter NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable access list filtering.
  • Page 178 VIVOTEK 7.8Video input Group: videoin NAME VALUE SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 CMOS frequency. * Only available when capability_videoin_type is 2. whitebalance auto, Modes of white balance. "auto": Auto white balance <product dependent> panorama, manual, "panorama": indicates that camera would...
  • Page 179 VIVOTEK 2: EV -1.3 3: EV -1.0 4: EV -0.7 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 * Only available when "capability_image_c<0~(n-1)>_exposure_ mode" !=0...
  • Page 180 VIVOTEK rotate 0,90,180,270 The rotation angle of image. Support only in Rotation mode. * Only available when " capability_videoin_c<0~(n-1)>_rotation"=1 ptzstatus 0,<positive A 32-bit integer, each bit can be set <Not support anymore> integer> separately as follows: Bit 0 => Support camera control function;...
  • Page 181 VIVOTEK etc. 5~8000 => 1/5s ~ 1/8000s etc. * 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 182 VIVOTEK 7.8.1 Video input setting per channel Group: videoin_c<0~(n-1)> for n channel products, and m is stream number n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" NAME VALUE SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 CMOS frequency.
  • Page 183 VIVOTEK mode" !="-" rgain 0~100 Manual set rgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wb mode". * Only valid when "videoin_c<0~(n-1)>_whitebalance " != auto * Normalized range. bgain...
  • Page 184 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 185 VIVOTEK piris_mode manual, indoor, outdoor,- Control P-Iris mode. <product "outdoor": Auto-setting P-Iris to dependent> get best quality, but easy to meet rolling or flicker effect in indoor environment. "indoor": Avoid rolling and flicker effect first. "manual": Manual set P-Iris by "piris_position".
  • Page 186 VIVOTEK * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exp osure_rangetype" is "twovalues". 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...
  • Page 187 VIVOTEK rotate 0,90,180,270 The rotation angle of image. Support only in Rotation mode (capability_videoin_c<0~(n-1)>_rot ation=1) ptzstatus 0,<positive integer> A 32-bit integer, each bit can be set <Not support separately as follows: anymore> Bit 0 => Support camera control function; 0(not support), 1(support) Bit 1 =>Built-in or external...
  • Page 188 VIVOTEK sure_minrange" "capability_image_c<0~(n-1)>_exp osure_minrange" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exp osure_rangetype" is "twovalues". maxexposure <1~32000>, Maximum exposure time <product <5~32000>, 1~32000 => 1s ~ 1/32000s dependent> <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>,...
  • Page 189 VIVOTEK sure_maxrange" image frame rate from sensor due to sensor generates a frame per exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s. * Only available when "capability_image_c<0~(n-1)>_exp...
  • Page 190 VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0302a. bracketing_level 1~100 The total available lists  (capability_image_c<0~ (n-1)>_exposure_brack eting_range) will be normalized to 1~100 scale. * For example, the total  available list is 7.
  • Page 191 VIVOTEK resolution" s<0~(m-1)>_s <boolean> Enable "Smart fps" function. martfps_enable * Only available when "capability_videoin_c<0~(n-1)>_sm artfps_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. s<0~(m-1)>_h <boolean> Enable "Dynamic intra frame period".
  • Page 192 VIVOTEK s<0~(m-1)>_h264_quant = 99. s<0~(m-1)>_h 1~100 Select customized quality in a 264_qpercent normalized full range. 1: Worst quality 100: Best quality * Only valid when "h264_ratecontrolmode"= vbr and "quant"= 100. The maximum allowed bit rate in  s<0~(m-1)>_h 20000~"capability_videoin_c<0~(n-1 " fixed quality mode.  264_maxvbrbitr )>_h264_maxbitrate When the bit rate exceeds this value,  frames will be dropped to restrict  the bit rate. ...
  • Page 193 VIVOTEK "capability_smartstream_version">   = "2.0" s<0~(m-1)>_h 20000~"capability_videoin_c<0~(n-1 The target bit rate in constant bit rate 264_bitrate )>_h264_maxbitrate" mode. *  Only valid when   "h264_ratecontrolmode"= cbr s<0~(m-1)>_h framerate,imagequality Set prioritypolicy 264_prioritypoli *  Only valid when   "h264_ratecontrolmode"= cbr s<0~(m-1)>_h 1~"capability_videoin_c<0~(n-1)>_h The maximum frame rates of a H264 264_maxframe 264_maxframerate"...
  • Page 194 VIVOTEK * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_h cbr, vbr cbr: Constant bit rate mode. vbr: Fixed quality mode, all frames 265_ratecontrol mode are encoded in the same quality. * Only available when h265 is listed in "capability_videoin_codec".
  • Page 195 VIVOTEK "h265_ratecontrolmode"= vbr and "quant"= 100. s<0~(m-1)>_h 20000~"capability_videoin_c<0~(n-1 The maximum allowed bit rate in " 265_maxvbrbitr fixed quality mode. )>_h265_maxbitrate When the bit rate exceeds this value, frames will be dropped to restrict the bit rate. * Only available when h265 is listed in "capability_videoin_codec".
  • Page 196 VIVOTEK s<0~(m-1)>_h 20000~"capability_videoin_c<0~(n-1 The target bit rate in constant bit rate 265_bitrate )>_h265_maxbitrate" mode. * Only available when h265 is listed in "capability_videoin_codec". *  Only valid when   "h265_ratecontrolmode"= cbr s<0~(m-1)>_h framerate,imagequality Set prioritypolicy 265_prioritypoli * Only available when h265 is listed in "capability_videoin_codec".
  • Page 197 VIVOTEK jpeg_quant 99, 100 "mjpeg_ratecontrolmode"= vbr. Set the pre-defined quality level: 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue" s<0~(m-1)>_m 10~200 Manual video quality level input. The...
  • Page 198 VIVOTEK 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only valid when "mjpeg_ratecontrolmode"= cbr. * Only available when "capability_smartstream_version" >= "2.0" s<0~(m-1)>_m 1~100 Select customized quality in a jpeg_cbr_qperc normalized full range. 1: Worst quality...
  • Page 199 VIVOTEK CIF(352x288)->(384x288) For NTSC: D1/4CIF(720/704x480) -> (640x480) CIF(352x240)->(320x240) * Only available when capability_videoin_type is 0 or 1. wdrpro_mode <boolean> Enable WDR pro <product dependent> * Only available when "capability_image_c<0~(n-1)>_wdr pro_mode" > 0 wdrpro_strengt 1~100 The strength of WDR Pro. The bigger value means the stronger <product...
  • Page 200 VIVOTEK 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher speed level meas shorter AE converged time during AE executing. * Only available when "capability_image_c<0~(n-1)>_aes peed" is 1 aespeed_sensiti 1~100 The sensitivity of AE converge speed.
  • Page 201 VIVOTEK   sheyedewarpmo mount “1O” is original mode (disable).   ‘1O, 1P, 1R, 4R’ for wall mount Supported dewarp mode is different <product <product dependent> by mount type. dependent> (videoin_c<0~(n-1)>_mounttype) Supported mode list could be extracted from (capability_videoin_c<0~(n-1)>_loc aldewarp_typeceilingmount) and (capability_videoin_c<0~(n-1)>_loc...
  • Page 202 VIVOTEK If the value is a positive number, the video quality of ROI is better than the non-ROI areas. The level is from 1 to 5. Level 5 is the maximum level of the quality difference between the ROI and non-ROI areas.
  • Page 203 VIVOTEK 7.8.1.1 Alternative video input profiles per channel In addition to the primary setting of video input, there can be alternative profile video input setting for each channel which might be for different scene of light (daytime or nighttime). Group: videoin_c<0~(n-1)>_profile_i<0~(m-1)> for n channel products and m profile n denotes the value of "capability_nvideoin"...
  • Page 204 VIVOTEK * Available value is listed in * This parameter may also restrict image "capability_image_c frame rate from sensor due to sensor <0~(n-1)>_exposu generates a frame per exposure time. Ex: If re_maxrange" this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.
  • Page 205 Iris, and keep adjusting Gain and Shutter "capability_image_c speed automatically. <0~(n-1)>_exposu "qualitypriority": Automatically adjust the re_modetype") Iris, Gain and Shutter Speed by VIVOTEK quality algorithm. "manual": Manually adjust with variable Shutter, Iris and Gain. User's Manual - 205...
  • Page 206 VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0302a. *Only available when "capability_image_c0_exposure_mode" != 0 whitebalance auto, Modes of white balance. "auto": Auto white balance <product dependent> panorama, manual, "panorama": indicates that camera would...
  • Page 207 VIVOTEK bgain 0~100 Manual set bgain value of gain control setting. 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbmode". * Only valid when "videoin_c<0~(n-1)>_whitebalance" != auto * Normalized range. maxgain 0~100 Maximum gain value.
  • Page 208 VIVOTEK "capability_image_c<0~(n-1)>_exposure_r angetype" is "onevalue". * Normalized range. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. meteringmode auto, "auto": The algorithm chooses the best blc, metering strategy. "blc": This metering method increases the weight of dark area.
  • Page 209 VIVOTEK 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 dependent> effect in indoor environment. "indoor": Avoid rolling and flicker effect first. "fixed": Open the iris to maximum.
  • Page 210 VIVOTEK 21~40: level 2 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher speed level meas shorter AE converged time during AE executing. * Only available when "capability_image_c<0~(n-1)>_aespeed" is   aespeed_sensitivity 1~100 The sensitivity of AE converge speed.
  • Page 211 VIVOTEK 7.9Time Shift settings Group: timeshift for n channel products and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" (capability_timeshift > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable time shift streaming. * We replace this parameter with "...
  • Page 212 VIVOTEK <product dependent> * Only available when <Not recommended to use "capability_daynight_c<0~"capability_nvide this> oin"-1>_smartir" is 1 * We replace this parameter with "ircutcontrol_c<0~(n-1)>_sir" when the version number (httpversion) is equal or greater than 0311c. daymodebegintime 00:00~23:59 Day mode begin time <Not recommended to use...
  • Page 213 VIVOTEK _builtin_type" * We replace this parameter with "ircutcontrol_illuminators_builtin_whiteled_ enabled" when the version number (httpversion) is equal or greater than 0311c. bwmode <boolean> Switch to B/W in night mode if enabled. <Not recommended to use * Only available when this>...
  • Page 214 VIVOTEK _illuminators _spectrum_mode". 7.10.1 IR cut control setting per channel Group: ircutcontrol_c<0~(n-1)> for n channel products (capability_daynight_c<0~(n-1)>_support > 0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, Set IR cut control mode day, * We support this parameter when the...
  • Page 215 VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0311c. sensitivity low,normal,high,1~ Sensitivity of day/night control. There are two value format: "low,normal,high": if capability_daynight_c<0~(n-1)>_ircutsensi tivity_type=options "1~100": if capability_daynight_c<0~(n-1)>_ircutsensi tivity_type=normalize * Only available when "capability_daynight_c<0~(n-1)>...
  • Page 216 VIVOTEK 7.10.2 IR cut control Illuminators Group: ircutcontrol_illuminators (capability_daynight_c<0~(n-1)>_support > 0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) builtin_irled_enabled <boolean> Enable/disable built-in IR led * Only available when "capability_daynight_illuminators_builtin_su pport > 0" and "irled" is listed in "capability_daynight_ illuminators...
  • Page 217 VIVOTEK are listed in "capability_daynight_illuminators_external_i nterface". * We support this parameter when the version number (httpversion) is equal or greater than 0311c. spectrum_mode visible, Set spectrum method . * We support this parameter when the irenhanced, version number (httpversion) is equal or blueenhanced greater than 0311c.
  • Page 218 VIVOTEK 7.11 Image setting per channel Group: image_c<0~(n-1)> for n channel products 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 219 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 220 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 221 VIVOTEK " is 1 eis_mode <boolean> Electronic image stabilizer <product dependent> 0:disable 1:enable * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mode". eis_strength 1~100 Strength of electronic image stabilizer <product dependent> * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mode".
  • Page 222 VIVOTEK deinterlacing techniques: Spatical mode provides the best image quality, while Blend mode provides better image quality (than not using the deinterlace function at all). * Only available when "capability_image_c<0~(n-1)>_deinterlace_ support" is 1. xoffset 0~100 Adjusting the image to proper position horizontally.
  • Page 223 VIVOTEK version number (httpversion) is equal or greater than 0301a. profile_i<0~(m-1)>_begintime hh:mm Begin time of schedule mode. profile_i<0~(m-1)>_endtime hh:mm End time of schedule mode. profile_i<0~(m-1)>_brightness -5~5,100 -5: Darker <-> 5: Bright <Not recommended to use this> 100: Use " image_c<0~(n-1)>_brightnesspercent"...
  • Page 224 VIVOTEK * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. profile_i<0~(m-1)>_sharpness -3~3,100 -5: Less saturation <-> 5: More saturation <Not recommended to use this> 100: Use " image_c<0~(n-1)>_saturationpercent" * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicsetting"...
  • Page 225 VIVOTEK profile_i<0~(m-1)>_gammacur 0~100 0: Fine-turned gamma curve by Vivotek. 1: Gamma value = 0.01 2: Gamma value = 0.02 3: Gamma value = 0.03 100: Gamma value = 1 * Note: Although we set gamma value to 100 level, but not all gamma values are valid.
  • Page 226 VIVOTEK profile_i<0~(m-1)>_eis_mode <boolean> Electronic image stabilizer <product dependent> 0:disable 1:enable * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mode". profile_i<0~(m-1)>_eis_streng 1~100 Strength of electronic image stabilizer * Only available when 'eis' is listed in <product dependent> "capability_image_c<0~(n-1)>_is_mode". profile_i<0~(m-1)>_dis_mode <boolean> Digital image stabilizer <product dependent>...
  • Page 227 VIVOTEK (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1 and when custom is listed in "capability_image_c<0~(n-1)>_exposure_winmode" and valid when "exposurewin_c<0~(n-1)>_mode"=custom or "exposurewin_c<0~(n-1)>_mode"=hlc) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the window. policy 0: Indicate exclusive. 1: Indicate inclusive. * Only available when exclusive is listed in "capability_image_c<0~(n-1)>_exposure_...
  • Page 228 VIVOTEK windomain". Group: exposurewin_c<0~(n-1)>_profile_i<0~(m-1)> for n channel profuct and m profile, n denotes the value of "capability_nvideoin", m denotes the value of "capability_nvideoinprofile", (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1) NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, custom,blc,hlc,center The mode indicates how to decide the exposure.
  • Page 229 VIVOTEK * Only available when qvga is listed in "capability_image_c<0~(n-1)>_exposure_ windomain". size <0~320x0~240> Width and height of the window. * Only available when qvga is listed in "capability_image_c<0~(n-1)>_exposure_ windomain". homepx <0~W,0~H> Left-top corner coordinate of the window. W: 0~ The current image width -1...
  • Page 230 VIVOTEK 7.13 Audio input per channel Group: audioin_c<0~(n-1)> (capability_naudioin>0) n denotes the value of "capability_naudioin" NAME VALUE SECURITY DESCRIPTION (get/set) source micin, linein micin => use built-in microphone input. <Not recommended to use <product linein => use external microphone input.
  • Page 231 VIVOTEK external microphone (The related bit of "capability_audio_extmic" is equal to 1). mute 0, 1 0: Mute off 1: Mute on gain 0~100 Gain of input. <Not recommended to use (audioin_c<0~(n-1)>_source = linein) this> * Reserved for compatibility, and suggest don't use this since the version number (httpversion) is equal or greater than 0301a.
  • Page 232 VIVOTEK 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. s0_g726_bitrate 16000, Set G.726 encoded bitrate in bps.
  • Page 233 VIVOTEK greater than 0301a. profile_i0_begintime hh:mm Begin time of schedule mode. profile_i0_endtime hh:mm End time of schedule mode. profile_i0_alarm_level 1~100 Audio detection alarm level 7.14 Audio out per channel Group: audioout_c<0~(n-1)> for n channel products (capability_audio_audioclip=1) n denotes the value of "capability_nvideoin"...
  • Page 234 VIVOTEK 7.16 Motion detection settings Group: motion_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable motion detection. win_sensitivity 0 ~ 100 Sensitivity of all motion detection windows. * The value "0" is reserved for compatibility and will not be used after the version number (httpversion) is equal or greater than 0400a.
  • Page 235 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 236 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 237 VIVOTEK (httpversion) is equal or greater than 0400a.   Group: motion_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 vaule of "capability_nmotionprofile", k denotes the value of "capability_nmotion". NAME VALUE SECURITY DESCRIPTION...
  • Page 238 VIVOTEK this> 320,0 ~ 240, 0 ~ * Only available when 320,0 ~ 240 "capability_motion_wintype" = polygon. * 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 239 VIVOTEK * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. height 0 ~ 240 Height of motion detection window. <Not recommended to use * Only available when   this> "capability_motion_wintype" = rectangle.
  • Page 240 VIVOTEK triggered. blurry_enable <boolean> Enable or disable image too blurry detection blurry_threshold 0~100 Threshold of image too blurry detection blurry_duration 1~10 If image too blurry value exceeds the "threshold" for more than "duration" second(s), then image too blurry detection is triggered.
  • Page 241 VIVOTEK 7.20 UPnP presentation Group: upnppresentation NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP presentation service. 7.21 UPnP port forwarding Group: upnpportforwarding NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP port forwarding service.
  • Page 242 VIVOTEK 0: disable 1: Show log of parameter setting set from external. 2. Show log of parameter setting set from external and internal. 7.23 SNMP Group: snmp (capability_protocol_snmp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) <boolean> SNMP v2 enabled. 0 for disable, 1 for enable <boolean>...
  • Page 243 1 => Default logo logo_link string[128] Hyperlink of the logo http://www.vivotek. logo_powerbyvvtk_hidden <boolean> 0 => display the power by vivotek logo 1 => hide the power by vivotek logo custombutton_manualtrig <boolean> Show or hide manual trigger (VI) button in ger_show homepage 0 ->...
  • Page 244 VIVOTEK 7.25 Privacy mask Group: privacymask_c<0~(n-1)> for n channel products and m privacy mask window. n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable privacy mask. win_i<0~(m-1)>_enable <boolean>...
  • Page 245 VIVOTEK 0 ~ W,0 ~ H "capability_image_c<0~(n-1)>_privacymas W: 0~ The current k_wintype" = polygon. image width -1 H: 0~ The current * Only available when px is listed in image height -1 "capability_image_c<0~(n-1)>_privacymas k_windomain". win_i<0~(m-1)>_polygo 0 ~ 9999,0 ~ 9999, Coordinate of polygon window position.
  • Page 246 Group: capability 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 with 0301a. composed by "major version", "minor version", "revision","_platform". ex: 0301a_1 Major version Increase the major version when change,...
  • Page 247 VIVOTEK 9, while 'r' is an alphabetic. EX: 0302b_1 => Major version = 03, minor version = 02, revision = b, platform = 1 The 4 integer numbers are WebAPI version, we use short name: [httpversion] for it in this document.
  • Page 248 VIVOTEK nmediastream <positive integer> Number of media stream per channels. naudiosetting <positive integer> Number of audio settings per channel. <Not support anymore> * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * We replace "naudiosetting" with "naudioin".
  • Page 249 VIVOTEK supported or SD/PZ/PT/PD/video server series) Bit 5 => (only available when bit0 is 1) Support focus operation; 0(not support), 1(support) (only available when RS-485 interface is supported or SD/PZ/PT/PD/video server series) Bit 6 => (only available when bit0 is 1) Reserved bit;...
  • Page 250 VIVOTEK presettourdirection <boolean> Indicate whether to support preset tour direction function. It means users can choose which direction the preset tour goes. * We support this parameter when the version number (httpversion) is equal or greater than 0307a. eptz 0, <positive For "nvideoin"...
  • Page 251 VIVOTEK <Not recommended to use * We replace this parameter with this> "capability_daynight_c<0~(n-1)>_builtinwl ed" when the version number (httpversion) is equal or greater than 0309d. iris <boolean> Indicate whether to support iris control. supportsd <boolean> Indicate whether to support local storage.
  • Page 252 VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0311c. storage_dbenabled <boolean> Media files are indexed in database. protocol_https < boolean > Indicate whether to support HTTP over SSL. protocol_rtsp < boolean >...
  • Page 253 VIVOTEK * This is kept for compatibility. videoin_resolution A list of <WxH> This equals <product "capability_videoin_c0_resolution". dependent> * This is kept for compatibility. videoin_maxframerate A list of <Integer> This equals "capability_videoin_c0_maxframerate". * This is kept for compatibility. videoin_mjpeg_maxframe A list of <Integer>...
  • Page 254 VIVOTEK timeshift <boolean> Indicate whether to support time shift caching stream. audio_aec <boolean> Indicate whether to support acoustic echo cancellation. audio_aecmode auto, Indicate the acoustic echo cancellation manual control mode. "auto": control by camera automatically. "manual": Manually turn on/off the control mode.
  • Page 255 VIVOTEK "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. For example: "maxframerate:fixed:15"...
  • Page 256 VIVOTEK the version number (httpversion) is equal or greater than 0301a. * It will be replaced by audio_intmic and audio_extmic. audio_lineout <boolean> Indicate whether to support line output. audio_michardwareswitch <boolean> Indicate whether the hardware supports built-in/external mic switch audio_headphoneout <boolean>...
  • Page 257 VIVOTEK "px": Locate a window in the image with pixels. "std": A normalized 0~9999 range. "-": Not supported. smartstream_support <boolean> Indicate whether smart stream is supported. smartstream_version <integer> Number of smart stream version. * Only available when "capability_smartstream_support" is 1 smartstream_nstream <positive integer>...
  • Page 258 VIVOTEK * Only available when "capability_smartstream_support" is 1 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.
  • Page 259 VIVOTEK and /cgi-bin/viewer/camctrl.cgi 0: support only /cgi-bin/viewer/camctrl.cgi This is equivalent to"capability_camctrl_c0_privilege". * This is kept for compatibility. uart_httptunnel <boolean> Indicate whether to support HTTP tunnel for UART transfer. transmission_mode Indicate transmission mode of the machine: TX = server, Rx = receiver box, Both = DVR.
  • Page 260 VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0305a. wireless_apmode_ssidpref <string> Indicate the prefix of broadcasted SSID when 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.
  • Page 261 VIVOTEK value may be varied depending on mounted lens. * We replace "capability_image_iristype" with "capability_image_c0_iristype". * Reserved for compatibility, and suggest don't use this since [httpversion] > 0301a image_focusassist <boolean> Indicate whether to support focus assist. <Not recommended to use * We replace "capability_image_ focusassist...
  • Page 262 VIVOTEK the default value is 0. * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_slconnum 0,<positive integer> The maximum seamless connection number for each channel. * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_smartsd <boolean>...
  • Page 263 VIVOTEK Group: capability_camctrl_c<0~(n-1)> n denotes the value of "capability_nvideoin" (capability_ptzenabled > 0) * We support this group when the version number (httpversion) is equal or greater than 0303b. PARAMETER VALUE SECURITY DESCRIPTION (get/set) ptztunnel <boolean> Indicate whether to support ptztunnel in this video input.
  • Page 264 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 265 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 266 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)>_zoommodul e" 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)>_zoommodul...
  • Page 267 VIVOTEK optimizedir <boolean> Indicate whether to support optimized IR <Not recommended to use control technology. this> * We replace this parameter with " capability_daynight_illuminators_optimizedir " when the version number (httpversion) is equal or greater than 0311c. smartir <boolean> Indicate whether to support smart IR.
  • Page 268 VIVOTEK ircutsensitivity_supportlevel 0, The value indicate the support strength level of <positive integer> ircutsensitivity. * Only available when "capability_daynight_c<0~(n-1)>_support" is 1 and "capability_daynight_c<0~(n-1)>_ircutsensiti vity_type" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 269 VIVOTEK spectrum_mode visible,ir,irenhanced,b Indicate the spectrum mode. <Not recommended to use lueenhanced this> <product dependent> "visible": The ideal default setting for visible light. "ir": The ideal default setting for IR light. "irenhanced": This CCM model increases the brightness effect of IR light.
  • Page 270 VIVOTEK mode auto,daynight,di,di2,d Indicate the day / night switch mode. i3,di4,schedule,- "auto": The Camera automatically judges the <product dependent> current operation mode by the level of ambient light detected. "daynight": support day mode and night mode.   In day mode, the camera streams color video.
  • Page 271 VIVOTEK builtin_support <boolean> Indicate whether to support built-in led. * We support this parameter when the version number (httpversion) is equal or greater than 0311c. builtin_type irled,whiteled,- Indicate whether to support built-in led type. <product dependent> "irled": IR led "whiteled": white led "-": not support...
  • Page 272 VIVOTEK spectrum_mode visible,ir,irenhanced,b Indicate the spectrum mode. lueenhanced "visible": The ideal default setting for visible <product dependent> light. "ir": The ideal default setting for IR light. "irenhanced": This CCM model increases the brightness effect of IR light. "blueenhanced": This CCM model increases the brightness effect of blue light.
  • Page 273 VIVOTEK color_support <boolean> 1 : camera can select to display color or black/white video streams. 0: camera do not support this feature. * We support this parameter when the version  number (httpversion) is equal or greater than  0310a.  eptz_zoomratio <string>  Indicate the support zoom ratio of eptz. ‐ : not support ePTZ  " " * We support this parameter when the version ...
  • Page 274 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 it.
  • Page 275 VIVOTEK rotationangle <string> The different angles which camera supports for rotation. *  Only avaliable when " " capability_videoin_c<0~(n-1)>_rotation * We support this parameter when the version number (httpversion) is equal or greater than 0309b. orientation flip,mirror,rotation Indicates the camera supports flip, mirror or <product dependent>...
  • Page 276 VIVOTEK minresolution A list of <Integer> Represent supported minimum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream". * We support this parameter when the version number (httpversion) is equal or greater than 0304b.
  • Page 277 VIVOTEK mjpeg_maxbitrate <positive integer>, - 0/7 Maximum bitrates of MJPEG. The unit is bps. "-" means MJPEG does not support bit rate control. * Only available when 'mjpeg' is listed in "capability_videoin_codec". h264_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer>...
  • Page 278 VIVOTEK h265_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer> and "-" H.265 on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution"...
  • Page 279 VIVOTEK mounttype ceiling, wall, floor,- Indicate the supported mount type. <product dependent> "-": not support * Available values are listed in " * We support this parameter when the version capability_videoin_c< number (httpversion) is equal or greater than 0~(n-1)>_mounttype 0309c.
  • Page 280 VIVOTEK smartq_support <boolean> Indicate whether to support Smart Q function.   * We support this parameter when the version number (httpversion) is equal or greater than 0309a. Group: capability_videoin_c<0~(n-1)>_localdewarp (capability_fisheyelocaldewarp_c<0~(capability_nvideoin)-1> > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE...
  • Page 281 VIVOTEK eptz 0, <positive integer> 0/7 Indicate this mode whether support eptz. For "nvideoin" = 1, the definition is as following: A 32-bits integer, each bit can be set separately as follows: Bit 0 => 1st stream supports ePTZ or not.
  • Page 282 VIVOTEK effectivepixel <WxH> The visible area of full scene in this video mode. The unit is pixel in source. * If "effectivepixel"<"capability_videoin_c<0~(n- 1)>_maxsize", then the visible area is located at the center of full scene. outputsize <WxH> The output size of source, equal to the captured size by device, in this video mode.
  • Page 283 VIVOTEK maxresolution A list of <Integer> Represent supported maximum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream". minresolution A list of <Integer> Represent supported minimum resolution of each stream in current video mode.
  • Page 284 VIVOTEK maxfps_h264 A list of <Positive Maximum fps which the device can encoded Integer> and "-" with 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 285 VIVOTEK Bit 5 => Supports adjusting the image to proper position vertically or not.   Hightlight Mask:  <boolean> The function will strengthen the image contrast and mask the specified zone of image if any strong spot-light exists. * We support this parameter when the version number (httpversion) is equal or greater than 0311a.
  • Page 286 VIVOTEK exposurelevel:fixed:<x>/<x "Policy" can be categorized into >, following groups: exposurelevel:ranged:<x>- - (disabled) : UI turns grey and users <x>, can't select it. exposuremode:fixed:auto - (unchanged) : UI keeps the status as before and user can't change it. <x>: nonnegative integer - (hidden) : UI is hidden.
  • Page 287 VIVOTEK wdrc_supportlevel 0, <positive integer> Indicate the support strength level of WDR Enhanced. wdrc_affect     When WDR Enhanced is enabled, exposurewin.mode:fixed:au some features may become malfunction or be forced to a given exposurewin.mode.blc:disab value. The affected functions are list led:, here.
  • Page 288 VIVOTEK means exposurelevel is fixed to level 6, level 8 and level 12. "-" means no feature is affected. * When "wdrc"=0, this value must be "-"        0: Non-support 3D digital noise reduction 1: Support 3D digital noise reduction dnrstrength <positive integer>...
  • Page 289 VIVOTEK image stabilizer mode. 1: Support tuning strength of image stabilizer mode. * Only available when "capability_image_c<0~(n-1)>_is_ mode" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. is_supportlevel 0, <positive integer>...
  • Page 290 VIVOTEK selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6"...
  • Page 291 VIVOTEK widerange, outdoor,indoor, sodiumauto,   <product dependent> iristype   piris,   Indicate iris type. dciris, "piris": P-Iris   "dciris": DC-Iris "-": No Iris control support * Note: For some cameras, this value may be varied depending on mounted lens.  ...
  • Page 292 VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_shuttervaluetyp fixed, * One to one mapping to the mode maximum, type in "exposure_modetype". "fixed": The shutter value is the assigned value (videoin_c<0~(n-1)>_shuttervalue) "maximum": The shutter value can...
  • Page 293 VIVOTEK equal or greater than 0302a. exposure_automode_affe When exposure auto mode is exposurewin.mode.blc:hidd enabled, some features may become en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here. exposurelevel:hidden:, or others The format is "Affect API name":"Policy":"Description"...
  • Page 294 VIVOTEK * Only available when auto 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. exposure_shutterpriority When exposure shutter priority mode mode_affect exposurewin.mode.blc:hidd...
  • Page 295 VIVOTEK means exposurelevel is fixed to level "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when shutterpriority 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 296 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 "Description" can be a nonnegative integer or string or NULL.
  • Page 297 VIVOTEK - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available.
  • Page 298 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 299 VIVOTEK     exposure_levelrange Available range for "0,12"   "videoin_c<0~(n-1)>_exposureleve l" * When "exposure_mode"=0, this value must be set to "-". * Only available when "capability_image_c<0~(n-1)>_   exposure_mode" is 1. exposure_winmode   auto,   Available options for custom, "exposurewin_c<0~(n-1)>_mode" blc, hlc, * "-"...
  • Page 300 VIVOTEK name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden.
  • Page 301 VIVOTEK     exposure_wintype inclusive, The supported exposure window exclusive, type.   "inclusive": The image inside a window is the target area of exposure control. "exclusive": The image inside a window is omitted by exposure control. "-": Not supported. * Only available when "capability_image_c<0~(n-1)>_...
  • Page 302 VIVOTEK equal or greater than 0301a. A list of <Positive Integer> exposure_pal_totalrange Available total range for PAL analog output. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when  the version number (httpversion) is  equal or greater than 0301a.     exposure_maxrange "1,32000", Available range for "1,8000", "videoin_c<n>_maxexposure" "1,32000" => 1s ~ 1/32000s or others   "1,8000" => 1s ~ 1/8000s  ...
  • Page 303 VIVOTEK Exposure Bracketing (AEB) Auto Exposure Bracketing (AEB) is a term that is used to signify a process where the camera automatically takes two or more exposures but with different exposure values.   * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1.
  • Page 304 VIVOTEK with pixels. "std": A normalized 0~9999 range. "-": Not supported. <Positive Integer> privacymask_ncolor Available total color numbers of privacy mask. agc_maxgain   "0,100",   Available range for   "-" "videoin_c<n>_maxgain" “0,100” => 0~100 percent "-" means "videoin_c<n>_maxgain" is not available.
  • Page 305 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 "Description" can be a nonnegative integer or string or NULL.
  • Page 306 VIVOTEK can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values.
  • Page 307 VIVOTEK * Only available when "capability_image_c<0~(n-1)>_aes peed" is 1.       gammacurve 0: Non-support tuning Gamma curve   1: Support tuning Gamma curve Internal parameter, must not open  lowlightmode   -,0,1     to user. 0: Non-support low light mode 1: Support low light mode  ...
  • Page 308 VIVOTEK equal or greater than 0305d. *-: Not supported. lensconfiguration_support Indicate whether to support different image library configuration files for specific exchangeable lens. freeze <boolean> 0: Non-support image freeze feature 1: Support image freeze feature * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 309 VIVOTEK lens_alignmentlevel <positive integer> The value indicate the support level of alignment. * Only available when "capability_image_c<0~(n-1)>_lens _alignment" is 1. lens_ldc_support <boolean> Indicate whether to support lens distortion correction function. * We support this parameter when the version number (httpversion) is equal or greater than 0309d.
  • Page 310 VIVOTEK devicecontrol <boolean> Indicate whether to support the peripheral device control. * We support this parameter when the version number (httpversion) is equal or greater than 0305c. 7.28 Customized event script Group: event_customtaskfile_i<0~2> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Custom script identification of this entry.
  • Page 311 VIVOTEK trigger boot, Indicate the trigger condition: "boot" = System boot. pir, "di"= Digital input. motion, "pir"= PIR detection. seq, "motion" = Video motion detection. recnotify, "seq" = Periodic condition. tampering, "visignal" = Video input signal loss. "recnotify" = Recording notification.
  • Page 312 VIVOTEK vadp 0,<positive integer> Indicate the source id of vadp event <product dependent> notification. Each bit corresponds to one vadp source, and the LSB indicates source id 0. For example, to detect event from any one of source id 0, 1 and 3, set vadp to 11.
  • Page 313 VIVOTEK action_do_i<0~(ndo-1)>_ 1~999 Duration of the digital output trigger in duration seconds. * Only available when "capability_ndo" > 0 action_cf_enable <Boolean> Enable or disable sending media to SD card. * Only available when "capability_supportsd" > 0 action_cf_folder string[128] Path to store media.
  • Page 314 VIVOTEK 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 > 0 action_autotrack_enable <boolean> Enable/disable auto tracking on event triggerd.
  • Page 315 VIVOTEK 7.30 Server setting for event action Group: server_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry type email, Indicate the server type: ftp, “email” = email server http, “ftp” = FTP server “http” = HTTP server “ns”...
  • Page 316 VIVOTEK 7.31 Media setting for event action Group: media_i<0~(n-1)> n denotes the value of "capability_media_num" (capability_media_num > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) Name string[40] Identification of this entry Type snapshot, Media type to send to the server or systemlog, store on the server.
  • Page 317 VIVOTEK videoclip_channel 0~"capability_nvideoin"-1 Indicate the source of media channel. 0 means the first channel. 1 means the second channel. 2 means the third channel. 3 means the fourth channel. * We support this parameter when the version number (httpversion) is equal or greater than 0311c.
  • Page 318 VIVOTEK 7.32 Recording Group: recording_i<0~(n-1)> n denotes the value of "capability_nrecording" (capability_nrecording > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. trigger schedule, The event trigger type networkfail schedule: The event is triggered by schedule networkfail: The event is triggered by the failure of network connection.
  • Page 319 VIVOTEK maxretentiontime <string> To specify the expired time for automatic clean up, and it only takes effect for video clip generated by recording_i <0~1>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss]S’ , similar with ISO8601 with symbols P Ex. P7D, it means 7 days. P1DT10H, it means 1 days and 10 hours.
  • Page 320 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 321 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 322 VIVOTEK 7.34 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 323 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 324 VIVOTEK 7.35 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 or capability_fisheye = 1) PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-1)>_home <W,H> ROI left-top corner coordinate.* If the minimal <product dependent>...
  • Page 325 VIVOTEK 7.36 ePTZ setting Group: eptz_c<0~(n-1)> for n channel product. (capability_eptz > 0 or capability_fisheye = 1) PARAMETER VALUE SECURITY DESCRIPTION (get/set) osdzoom <boolean> Indicates multiple of zoom in is “on-screen <Not recommended to use display” or not. this> * Reserved for compatibility, and suggest don't use this since [httpversion] >...
  • Page 326 VIVOTEK rotatespeed 1 ~ 5 Rotate speed (only for Fisheye series) * Only available when "capability_fisheye" is 1 "capability_fisheyelocaldewarp_c<0~(n-1)>" is 0 Group: eptz_c<0~(n-1)>_s<0~(m-1)> for n channel product and m is the index of video stream which support ePTZ if capability_eptz > 0; m is the index of stream number if capability_fisheye = 1.
  • Page 327 VIVOTEK 7.37 Focus Window setting Group: focuswindow_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin". (capability_image_c<0~(n-1)>_focuswindow_nwindow > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) win_i0_enable <boolean> Enable or disable the window. win_i0_home <W,H> Left-top corner coordinate of the window.
  • Page 328 VIVOTEK 7.38 Seamless recording setting Group: seamlessrecording (capability_localstorage_seamless> 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) diskmode seamless, “seamless” indicates enable seamless <Not recommended to use manageable recording. this> “manageable” indicates disable seamless recording. * We replace this parameter with " seamlessrecording_c<0~(n-1)>_diskmode"...
  • Page 329 VIVOTEK guid<0~2>_number Number of connected seamless streaming with <Not recommended to use guid<0~(k-1)>_id. this> (Read only) * We replace this parameter with " seamlessrecording_c<0~(n-1)>_" when the version number (httpversion) is equal or greater than 0311c. 7.38.1 Seamless recording setting per channel Group: seamlessrecording_c<0~(n-1)>...
  • Page 330 VIVOTEK 7.39 VIVOTEK Application Development Platformsetting Group: vadp NAME VALUE SECURITY DESCRIPTION (get/set) version <string> Indicate the VADP version. resource_total_memory 0,<positive integer> Indicate total available memory size for VADP modules. resource_total_storage 0,<positive integer> Indicate total size of the internal storage space for storing VADP modules.
  • Page 331 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 332 VIVOTEK 7.40 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 333 VIVOTEK 7.41 camera PTZ control (IZ series) Group: camctrl_c<0~(n-1)> for n channel products (capability_camctrl_c0_zoommodule = 1 and capability_camctrl_c0_buildinpt = 0) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset" NAME VALUE SECURITY DESCRIPTION (get/set) ccdtype string[16]...
  • Page 334 VIVOTEK 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 preset_i<0~(k-1)>_ 0 ~ 999 The dwelling time of each preset location dwelling preset_i<0~(k-1)>_focus...
  • Page 335 VIVOTEK action will be taken. idleaction_enable <boolean> Enable/disable idle action while idle idleaction_type home This field tells what kind of action should be taken while idle. idleaction_interval 1~999 While idle over this time interval, idle action will be taken. 7.42 camera PTZ control (SD series) Group: camctrl_c<0~(n-1)>...
  • Page 336 VIVOTEK preset_i<0~(k-1)>_pan capability_ptz_c<0~(n-1) Pan position at each preset location. >_minpan ~ capability_ptz_c<0~(n-1) >_maxpan preset_i<0~(k-1)>_tilt capability_ptz_c<0~(n-1) Tilt position at each preset location. >_mintilt ~ capability_ptz_c<0~(n-1) >_maxtilt 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.
  • Page 337 VIVOTEK >_minzoom ~ capability_ptz_c<0~(n-1) >_maxzoom axisf capability_ptz_c<0~(n-1) Custom home focus position. >_minfocus ~ capability_ptz_c<0~(n-1) >_maxfocus axisflip <boolean> Custom home flip side. returnhome <boolean> Enable/disable return home while idle. returnhomeinterval 1~999 While idle over this time interval, idle action will be taken.
  • Page 338 VIVOTEK tour_i<0~19>_checklist string[512] The indexes of preset positions, separated by “,” tour_i<0~19>_dwelltime string[512] Preset tour: time to wait before moving to the next preset position, separated by “,” Recorded tour: number of seconds to wait before continuing a loop tour.
  • Page 339 VIVOTEK rs232 customdrvcmd_i<0~9> string[128] PTZ command for custom camera. speedlink_i<0~4>_name string[40] Additional PTZ command name. speedlink_i<0~4>_cmd string[40] Additional PTZ command list. ptzdriver 0~19, The PTZ driver is used by this COM port. 127 (custom), 128 (no driver) 7.44 UART control (SD series) Group: uart_i<0~(n-1)>...
  • Page 340 VIVOTEK the uart_i<0~(n-1)>_stopbit should be set as 2 and the uart_i<0~(n-1)>_databit set as 5 as well. uartmode rs485 RS485 mode. 7.45 Lens configuration Group: lens for n channel products n denotes the value of "capability_nvideoin" (capability_image_c<0~(n-1)>_lensconfiguration_support = 1) NAME VALUE...
  • Page 341 VIVOTEK name <string> User-defined lens name 7.46 Fisheye info Group: fisheyeinfo (capability_fisheye > 0) NAME VALUE SECURITY DESCRIPTION (get/set) revisedcenteraxis <coordinate> The actual center axis coordinate radius 0, <positive The actual center radius integer> 7.47 Fisheye local dewarp setting  ...
  • Page 342 VIVOTEK 7.48 PIR behavior define Group: pir (capability_npir > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable PIR 7.49 Auto tracking setting Group: autotrack_c<0~(n-1)> (capability_image_c<0~(n-1)>_autotrack_support > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) objsize_type -1~2 Type of object size.
  • Page 343 VIVOTEK channel 1~11 A list of WLAN channels. 1~13 Countries apply their own regulations to the 10~11 or allowable channels. 10~13 or 1~11: USA and Canada 1~14 1~13: Europe 10~11: Spain 10~13: France 1~14: Japan * Only valid when "wireless_wlmode" is "Adhoc"...
  • Page 344 VIVOTEK 7.51 Shock detection Group: shock_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" (capability_shockalarm_support > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) alarm_enable <boolean> Enable shock detection's alarm. alarm_level 1~100 The value indicate the support strength level of shock detection's alarm.
  • Page 345 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 346 VIVOTEK Example: Query the status of digital input 1 . Request: http://myserver/cgi-bin/dido/getdi.cgi?di1 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n di1=1\r\n Query Status of the Digital Output (capability_ndo > 0) Note: This request requires Viewer privileges Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/getdo.cgi?[do0][&do1][&do2][&do3]...
  • Page 347 VIVOTEK \r\n do1=1\r\n Capture Single Snapshot Note: This request requires Normal User privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/video.jpg?[channel=<value>][&resolution=<value>] [&quality=<value>][&streamid=<value>] If the user requests a size larger than all stream settings on the server, this request will fail. PARAMETER VALUE DESCRIPTION channel 0~(capability_nvideoin -1) The channel number of the video source.
  • Page 348 VIVOTEK Account Management Note: This request requires Administrator privileges. Method: POST Syntax: http://<servername>/cgi-bin/admin/editaccount.cgi? method=<value>&username=<name>[&userpass=<value>][&privilege=<value>] [&privilege=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION method Add an account to the server. When using this method, the“username” field is necessary. It will use the default value of other fields if not specified.
  • Page 349 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 350 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 351 VIVOTEK http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=tele&zs=1 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 352 VIVOTEK resolution <window size> The resolution of streaming. <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.
  • Page 353 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 354 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. If you omit this parameter, it will redirect to an empty page.
  • Page 355 VIVOTEK 8.12 UART HTTP Tunnel Channel (capability_nuart > 0) Note: This request requires Operator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/operator/uartchannel.cgi?[channel=<value>] ------------------------------------------------------------------------- GET /cgi-bin/operator/uartchannel.cgi?[channel=<value>] x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------- POST /cgi-bin/operator/uartchannel.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache...
  • Page 356 VIVOTEK 8.13 Event/Control HTTP Tunnel Channel (capability_ evctrlchannel > 0) Note: This request requires Administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/ctrlevent.cgi ------------------------------------------------------------------------- GET /cgi-bin/admin/ctrlevent.cgi x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------- POST /cgi-bin/admin/ ctrlevent.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled...
  • Page 357 VIVOTEK 8.14 Get SDP of Streams Note: This request requires Viewer access privileges. Method: GET/POST Syntax: http://<servername>/<network_rtsp_s<0~m-1>_accessname> “m” is the stream number. “network_accessname_<0~(m-1)>” is the accessname for stream “1” to stream “m”. Please refer to the “subgroup of network: rtsp” for setting the accessname of SDP.
  • Page 358 VIVOTEK 8.16 Senddata (capability_nuart > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/senddata.cgi? [com=<value>][&data=<value>][&flush=<value>] [&wait=<value>] [&read=<value>] PARAMETER VALUE DESCRIPTION 1 ~ <max. com port The target COM/RS485 port number. number> data <hex decimal The <hex decimal data> is a series of digits from 0 ~ 9, A ~ F.
  • Page 359 VIVOTEK 8.17 Storage managements (capability_storage.dbenabled > 0) Note: This request requires administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=<cmd_type>[&<parameter>=<value>…] The commands usage and their input arguments are as follows. PARAMETER VALUE DESCRIPTION cmd_type <string> Required. Command to be executed, including search, insert, delete, update, and queryStatus.
  • Page 360 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 361 VIVOTEK label <integer primary key> Required. Identify the designated record. Ex. label=1 isLocked <boolean> Required. Indicate if the file is locked or not. Ex. Update records whose key numbers are 1 and 5 to be locked status. http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=update&isLocked=1&label=1&label=5 Ex. Update records whose key numbers are 2 and 3 to be unlocked status.
  • Page 362 VIVOTEK 8.18 Virtual input (capability_nvi > 0) Note: Change virtual input (manual trigger) status. Method: GET Syntax: http://<servername>/cgi-bin/admin/setvi.cgi?vi0=<value>[&vi1=<value>][&vi2=<value>] [&return=<return page>] PARAMETER VALUE DESCRIPTION vi<num> state[(duration)nstate] Ex: vi0=1 Setting virtual input 0 to trigger state Where "state" is 0, 1. “0”...
  • Page 363 VIVOTEK Request 2 will not be accepted during the execution time(15 seconds). 8.19 Open Timeshift Stream (capability_timeshift > 0, timeshift_enable=1, timeshift_c<n>_s<m>_allow=1) Note: This request requires Viewer access privileges. Syntax: For HTTP push server (MJPEG): http://<servername>/<network_http_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&reftime =<value>&forcechk&minsft=<value>] For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player.
  • Page 364 VIVOTEK forcechk Check if the requested stream enables timeshift, feature and if minsft is achievable. If false, return “415 Unsupported Media Type”. minsft <positive How many seconds of cached stream client can accept at integer> least. (Used by forcechk) The value must be a positive integer. (>0)
  • Page 365 VIVOTEK 8.20 RemoteFocus (capability_image_c<0~(n-1)>_remotefocus=1) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/remotefocus.cgi?function=<value>[&direction=<value>] [&position=<value>][&steps=<value>][&iris] PARAMETER VALUE DESCRIPTION User's Manual - 365...
  • Page 366 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 irisopen, positioning – Position the motors irisenable, irisopen –...
  • Page 367 VIVOTEK position 0~<motor_max> Motor’s position. It works only if function=zoom or function= focus and direction=direct. <motor_max> is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from "function=getstatus" steps 1 ~ <motor_max> Motor’s moving steps. It works only if function=zoom or function=focus and  ...
  • Page 368 VIVOTEK 8.21 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 368 - User's Manual...
  • Page 369 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 370 VIVOTEK steps 1 ~ <motor_max> Motor’s moving steps. It works only if function=focus and direction=forward or   direction=backward. <motor_max> is refer to remote_focus_focus_motor_max which replied from "function=getstatus" * This parameter is for additional fine-tune, the value is from 1 to iris Open iris or not.
  • Page 371 VIVOTEK 8.23 Upload Files Note: This request requires Administrator privileges. Method: POST Syntax: For daylight saving time configuration file: http://<servername>/cgi-bin/admin/upload_dst.cgi Post data: filename =<file name>\r\n \r\n <multipart encoded form data> For language file: http://<servername>/cgi-bin/admin/upload_lan.cgi Post data: filename =<file name>\r\n \r\n <multipart encoded form data>...
  • Page 372 VIVOTEK 8.24 Update Lens Configuration (capability_image_c<0~(n-1)>_lensconfiguration_support > 0) Note: This request requires Administrator privileges. Method: GET Syntax: For list a name of lens currently used: http://<servername>/cgi-bin/admin/update_lens.cgi?get_currentlens For list all names of lens installed in camera: http://<servername>/cgi-bin/admin/update_lens.cgi?list_lens For choose selected lens configuration: http://<servername>/cgi-bin/admin/update_lens.cgi?choose_lens=<value>...
  • Page 373 VIVOTEK upload_lens_profile_input = <file name>\r\n \r\n <multipart encoded form data> Server will accept the file named <file name> to upload the lens profile to camera. 8.25 Media on demand (capability_localstorage.modnum > 0) Media on demand allows users to select and receive/watch/listen to metadata/video/audio contents on demand.
  • Page 374 VIVOTEK 8.26 Fisheye local dewarp camera control (capability_fisheye > 0 and capability_fisheyelocaldewarp.c0 > 0, only support in 1R mode) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/camctrl/fdCamCtrl.cgi?channel=<value>&stream=<value> [&move=<value>] – Move home, up, down, left, right [&zoom=<value>] – Zoom wide, tele [[&speedpan=<value>][&speedtilt=<value>][&speedzoom=<value>]]...
  • Page 375 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 376 VIVOTEK 8.27 3D Privacy Mask (capability_image_c<0~(n-1)>_privacymask_wintype = 3Drectangle) n denotes the value of "capability_nvideoin" Note: This request requires admin user privilege Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/setpm3d.cgi?method=<value>&maskname=<value>&[maskheight=<valu e>&maskwidth=<value>&videosize=<value>&return=<return page>] PARAMETER VALUE DESCRIPTION method Add a 3D privacy mask at current location delete...
  • Page 377 VIVOTEK 8.28 Camera Control (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/camctrl/camctrl.cgi?[channel=<value>][&camid=<value>] [&move=<value>] – Move home, up, down, left, right [&focus=<value>] – Focus operation [&zoom=<value>] – Zoom in, out [&zooming=<value>&zs=<value>] – Zoom without stopping, used for joystick [&vx=<value>&vy=<value>&vs=<value>] –...
  • Page 378 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 379 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 380 VIVOTEK getratio <decimal> Get the current zoom ratio. getfocus 0, <positive integer> Get the current focus position. getminspeedlv 0, <positive integer> Get the minimum speed level of the PTZ control. Normally, the speed level is ‘0,’ which denotes halting a continuous movement.
  • Page 381 VIVOTEK 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 getminfocus 0, <positive integer> Get the lower limit for focus position. getmaxfocus 0, <positive integer>...
  • Page 382 VIVOTEK delpos string[30] Delete preset location from preset list. 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. If you omit this parameter, it will redirect to an empty page.
  • Page 383 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 384 VIVOTEK Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION Apply the wireless settings and connect to AP. 384 - User's Manual...
  • Page 385 VIVOTEK 8.33 Get wireless information (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/getwirelessinfo.cgi PARAMETER VALUE DESCRIPTION Get wireless information. Camera will return following information. 1. Wireless channel 2. Link quality 3. Signal level 4. Noise level 5.
  • Page 386 VIVOTEK 8.35 WPS transaction (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/start_wps.cgi PARAMETER VALUE DESCRIPTION Start WPS transaction. 8.36 Peripheral control (capability_peripheral_c<0~(n-1)>_ devicecontrol > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: (for control API) http://<servername>/cgi-bin/admin/peripheral.cgi?channel=<value>&operation=set...
  • Page 387 VIVOTEK washer_mode wiper Apply the wiper to the mode of washer control system. *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 washer Apply the washer to the mode of washer control system. *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 washer_status Enable the functionality of washer control system.
  • Page 388 VIVOTEK [&washer_dwelltime] – Get washer clean time [&heater_supportstatus] – Get heater support control status [&heater_status] – Get heater status Example: http://myserver/cgi-bin/admin/peripheral.cgi?channel=0&operation=get&supportdevice&washer_status Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n supportdevice=washer,heater\r\n washer_status=off\r\n PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source.
  • Page 389 VIVOTEK ort=1 heater_supportstatus Get the support status of heater control system. *Only available when capability_peripheral_c<0~(n-1)>_heater_suppo rt=1 heater_status Get the current heater status. Normally it will be 'auto', it means the heater device is control by internal algorithm to keep in a suitable environment;...
  • Page 390 VIVOTEK 8.37 Optimized IR control (capability_daynight_c<0~(n-1)>_optimizedir > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/optimizedir.cgi?function=<value>[&channel=<value>]   PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. "onetimeauto": Camera will automatically adjust the IR zone one function getstatus, onetimeauto time only.
  • Page 391 VIVOTEK http://myserver/cgi-bin/admin/optimizedir.cgi?function=getstatus    Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irmode='auto'" "optimizedir_c0_irnum='5'" "optimizedir_c0_irstrength='1,97,100,100,100'" "optimizedir_c0_irstatus='normal'"   Syntax: (for control API) http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=<value>&irmode=manual   [&strength=<value>] – Set IR strength PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source.   operation set, ...
  • Page 392 VIVOTEK   Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=settoall&irmode=manual&st rength=100     Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irstrength='100,100,100,100,100'" "optimizedir_c0_irmode='manual'"   Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&irmode=auto&strength =50,70,50,50,50     Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: Parameter "irmode" must be set as "manual"!  ...
  • Page 393 VIVOTEK PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. support_irmode List all adjustment mode that IR supports irmode Get the current IR control mode.   irnum Get the number of IR that camera supports.   Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=get&irmode  ...
  • Page 394 VIVOTEK Technology License Notice AMR-NB Standard THIS PRODUCT IS LICENSED UNDER THE AMR-NB STANDARD PATENT LICENSE AGREEMENT. WITH RESPECT TO THE USE OF THIS PRODUCT, THE FOLLOWING LICENSORS’ PATENTS MAY APPLY: TELEFONAKIEBOLAGET ERICSSON AB: US PAT. 6192335; 6275798; 6029125; 6424938; 6058359. NOKIA CORPORATION: US PAT.
  • Page 395 取扱説明書に従って正しい取り扱いをして下さい Liability VIVOTEK Inc. cannot be held responsible for any technical or typographical errors and reserves the right to make changes to the product and manuals without prior notice. VIVOTEK Inc. makes no warranty of any kind with regard to the material contained within this document, including, but not limited to, the implied warranties of merchantability and fitness for any particular purpose.

This manual is also suitable for:

It9360-hIt9388-htIt9380-hf2It9360-hf3

Table of Contents