Vivotek FE9191 User Manual
  1. Manuals
  2. Brands
  3. Vivotek Manuals
  4. Security Camera
  5. FE9191
  6. User manual

Vivotek FE9191 User Manual

Fisheye fixed dome network camera
Hide thumbs
Table of Contents

Advertisement

Quick Links

FE9191
FE9391-EV
User 's Manual
12MP • Vandal-proof • 360 º Surround View • 20M IR • Smart IR II
Smart Stream II • Pixel Calculator • PoE
Fisheye Fixed Dome
Network Camera
Rev. 1.0

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the FE9191 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Vivotek FE9191

Summary of Contents for Vivotek FE9191

  • Page 1 FE9191 FE9391-EV Fisheye Fixed Dome Network Camera User ’s Manual 12MP • Vandal-proof • 360 º Surround View • 20M IR • Smart IR II Smart Stream II • Pixel Calculator • PoE Rev. 1.0...

  • Page 2: Table Of Contents

    Read Before Use ............................. 5 Package Contents ............................5 Symbols and Statements in this Document ..................... 5 Physical Description - FE9191 (Indoor Camera) .................... 6 Physical Description - FE9391-EV (Outdoor Camera) ..................8 LED Definition - both models ........................... 9 Hardware Installation - FE9191 ........................
  • Page 3 Applications > DI and DO ..........................146 Applications > Tampering detection ........................147 Applications > Audio detection ......................... 148 Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) ..... 150 Recording > Recording settings ........................153 Local storage > SD card management ....................... 158 Local storage >...

  • Page 4: Overview

    IR image, reducing glaring hotspots and/or underexposed dark spots. The FE9191 and FE9391-EV will also be the frst to include a new wave of advanced Video Con- tent Analyses (VCA). Available in 4Q 2017, these will include better object detection in order to reduce false alarms.

  • Page 5: Read Before Use

    For creative and professional developers, the URL Commands of the Network Camera section serves as a helpful reference to customizing existing homepages or integrating with the current web server. Package Contents ■ FE9391-EV or FE9191 ■ Quick Installation Guide ■ Mounting bracket ■ Mounting plate / star driver (ourdoor model) ■...

  • Page 6: Physical Description - Fe9191 (Indoor Camera)

    VIVOTEK Physical Description - FE9191 (Indoor Camera) Inner View Lens DI/DO & Audio Headers Microphone Microphone Contacts Ethernet 10/100 RJ45 Socket DI/DO & Audio Headers Cabling Cutout Status LEDs Reset Button MicroSD/SDHC/SDXC Card Slot 6 - User's Manual...
  • Page 7 Outer View Dome Cover Built-in Microphone Side lid Release button IMPORTANT: FE9191 083236 Record the MAC address under the camera base before installing the camera. Mounting Positions Refer to the diagram on the right for the mounting hole positions and the dimen- sions of the base plate.

  • Page 8: Physical Description - Fe9391-Ev (Outdoor Camera)

    VIVOTEK Physical Description - FE9391-EV (Outdoor Camera) Inner View Lens Contacts for IR units (B) Contacts Contacts Header (J7) Header (J3) Ethernet 10/100 RJ45 Socket Contacts for IR units (B) DI/DO & Audio combo headers Reset Button Status LEDs MicroSD/SDHC/SDXC Card Slot...

  • Page 9: Led Definition - Both Models

    VIVOTEK Outer View Vandal-proof Dome Cover Built-in Microphone IR lights hidden beneath panel IMPORTANT: 083236 Record the MAC address under the camera base before installing the camera. LED Definition - both models Item LED Status Description Steady Power on and system booting...

  • Page 10: Mounting Positions

    VIVOTEK Mounting Positions Refer to the diagram on the right for the mounting hole positions and the dimensions of the base plate. Camera Base Plate Mounting Positions Camera Mounting Plate Mounting Positions M3X0.5 TH 30° 13° 47° 13° 47° 13°...

  • Page 11: Hardware Installation - Fe9191

    VIVOTEK Hardware Installation - FE9191 Opening Dome Cover 1. Jot down the camera’s MAC address for later reference. It is especially important if you install multiple cameras at one site. Network Camera Model No: XXXXXX MAC: 0002D14BAD55 This device complies with part 15 of the FCC Rules. Operation is subject to...
  • Page 12 VIVOTEK 3. Install an SD card if edge recording is preferred. 4. Connect the power, audio, and I/O combo cable. Connect the white header connectors to J7 and J12 connectors on the camera. The camera can also be powered by a DC12V power source.
  • Page 13 VIVOTEK Connecting Cables 5. Connect the Ethernet cable. The Ethernet cable is user-supplied. 6. Use an included cable tie to secure the Ethernet cable to the vertical mounting tab located on the edge of the cabling cutout. 7. Cut the extra length from the cable tie.
  • Page 14 VIVOTEK Ceiling or Wall Mount 8 Attach the supplied alignment sticker for the camera base to the a ceiling or wall. 9. Drill pilot holes into the ceiling. Then hammer the supplied plastic anchors into the holes. If preferred, drill a cabling hole on the ceiling/wall, and feed the cables through the hole.
  • Page 15 VIVOTEK NOTE: You may also install the camera to a U.S. standard 4 in. junction box. You can align the camera’s curved slots with the mounting holes on a junction box. Use diagonal mounting positions on the camera to match those on a junction box.
  • Page 16 VIVOTEK Attach the Dome Cover 11. Install the plastic dome cover by aligning the snap-fit tabs on the dome cover with the slotted tabs on the camera base. Install the dome cover by pressing it evenly to the camera base.

  • Page 17: Hardware Installation - Fe9391-Ev

    VIVOTEK Hardware Installation - FE9391-EV Opening Dome Cover 1. Jot down the camera’s MAC address for later reference. This is especially important if you in- stall many cameras in your surveillance deployment. Network Camera Model No: XXXXXX MAC: 0002D14BAD55 This device complies with part 15 of the FCC Rules. Operation is subject to...
  • Page 18 VIVOTEK Prepare the wiring, and drill a cabling hole with the aid of the included alignment sticker. 4. Remove the stoppers and route cables through the openings. Rubber Stopper on the hole for Power & IO Cables Rubber Seal Plug on the...
  • Page 19 VIVOTEK Connecting RJ45 Ethernet Cable RJ45 Cable Dimension (unit: mm) Rubber Seal Plug Recommended cable gauge: 5 to 8mm Assembly Steps 5. Drill a hole on the rubber seal plug and insert an Ethernet cable through the opening. Strip part of the sheath from the Ethernet cable.
  • Page 20 VIVOTEK 7. Feed the Ethernet cable from the bottom of the camera and through the hole. Attach the rub- ber seal plug for water proofing. 8. Use the included cable tie to fasten the top of the rubber seal so that the position of the Ether- net cable will not alter.
  • Page 21 VIVOTEK 9. If the DI/DO combo cable is preferred, install the supplied rubber washer to the cable as shown in the picture. Feed the cable from the bottom of the camera and tighten the plastic nut for waterproofing. If you are not powering the camera over a PoE switch, use the DC 12V connector on the DI/DO combo cable.
  • Page 22 VIVOTEK There are two installation options: A. Direct installation B. Using the mount bracket. A-1. Attach the supplied alignment sticker for camera base to the ceiling/wall. Using the three circles on the sticker, drill three pilot holes into the ceiling. Then hammer the three supplied plastic anchors into the holes.
  • Page 23 VIVOTEK A-2. Secure the camera base to the ceiling/wall with three supplied screws. A-3. Connect the white headers of the DI/DO combo cable to the J3 and J7 headers on the camera. User's Manual - 23...
  • Page 24 VIVOTEK A-4. Attach the dome cover. Secure the four screws using the supplied T10 stardriver. Make sure all camera parts are securely installed. IMPORTANT: Arrange the cables neatly to avoid getting in the way when the dome cover is attached.
  • Page 25 VIVOTEK Installation Type B: Using the mount bracket. B-1. Attach the supplied alignment sticker for the supplied mounting plate to the ceiling or wall. Note that there are two different alignment stickers. Using the three circles on the sticker, drill three holes into the ceiling. Then hammer the three supplied plastic anchors into the holes.
  • Page 26 VIVOTEK B-2. Arrange and feed the cables through the side of the mount bracket. Secure the mount bracket to the ceiling or wall using the supplied screws. B-3. Install the camera to the mount bracket. Align the double-sided keyhole slot with the larg- est rivet head on the mount bracket.
  • Page 27 VIVOTEK B-4. A small mount hole will be revealed through the keyhole slot. Secure the camera by tight- ening a flat-head screw. B-5. Install the dome cover using the T10 star driver. User's Manual - 27...
  • Page 28 VIVOTEK Skip to step 11. U.S. standard 4” junction box. You may also use the diagonal holes on the mounting plate, marked as A, B, or C, to install the camera to a U.S. standard 4 in. junction box. 28 - User's Manual...
  • Page 29 VIVOTEK General Connection (without PoE) 11. If using the DI/DO combo cable. 11-1. Connect RJ45 Ethernet cable to a switch. 11-2. Connect the power cable from the Network Camera to a power outlet. 11-3. If you have external devices such as sensors and alarms, make the connection from the general I/O terminal block.

  • Page 30: Software Installation

    Software Installation 12. 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 31: Network Camera

    VIVOTEK 12-3. The program will search for all VIVOTEK network devices on the same LAN. 12-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 32 VIVOTEK 13-2. Enter the combination of alphabetic and numeric characters to fulfill the password strength. requirement. The default name for the camera administrator is “root”, and can not be changed. Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~.

  • Page 33: Ready To Use

    VIVOTEK Ready to Use 1. A browser console with the Network Camera should prompt as shown below. 2. You should be able to see live video from your camera. You may also install the 32-channel recording software, VAST, in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents.
  • Page 34 VIVOTEK DI/DO Diagram not used +3.3V Switch Source External BJT transistor power source Relay External device Switch Source BJT transistor Relay External device 1. The DO+ pin (5V) provides 5V±10% output voltages, and the max. load is 50mA. 2. The max. voltage for the DO- pins is 30VDC (External power).

  • Page 35: Network Deployment

    VIVOTEK Network Deployment Setting up the Network Camera over the Internet There are several ways to set up the Network Camera over the Internet. The first way is to set up the Network Camera behind a router. The second way is to utilize a static...
  • Page 36 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 for- warding feature as an NAT traversal function with the precondition that your router must support the UPnP port forwarding feature.
  • Page 37 VIVOTEK Internet connection with static IP Choose this connection type if you are required to use a static IP for the Network Camera. Please refer to LAN configuration on page 92 for details. Internet connection via PPPoE (Point-to-Point over Ethernet) Choose this connection type if you are connected to the Internet via a DSL Line.
  • Page 38 VIVOTEK 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. Remove the following folder: C:\Program Files (x86)\Camera Stream Controller\.

  • Page 39: Accessing The Network Camera

    3. The live video will be displayed in your web browser. 4. If it is the first time installing the VIVOTEK network camera, an information bar will prompt as shown below. Follow the instructions to install the required plug-in on your computer.
  • Page 40 VIVOTEK NOTE: For Mozilla Firefox users, your browser will use Quick Time to stream live video. If you do not have QuickTime on your computer, please download QuickTime from Apple Inc's website, and then launch your web browser. Tips: 1. The onscreen Java control can malfunction under the following situations: A PC connects to different cameras that are using the same IP address (or the same camera running different firmware versions).
  • Page 41 VIVOTEK NOTE: 1. By default, your Network Camera is not password-protected. To prevent unauthorized access, it is highly recommended to configure a password for your camera later. For more information about how to enable password protection, please refer to Security on page 112.

  • Page 42: Using Rtsp Players

    VLC player supports H.264/MPEG-4/ MJPEG, and all audio codecs supported by VIVOTEK’s cameras. The RTSP players will show the original circular-shape image. You can access the Regional views via the ST7501 or VAST software. See page 100 for an example.

  • Page 43: Using 3Gpp-Compatible Mobile Devices

    Quick Time player only supports the playback of H.265 or H.264 stream, and not the MJPEG stream. In terms of audio codec, Quick Time only supports AAC. Since this camera supports G.711 codec, audio is not available on Quick Time. VLC player supports H.265/H.264/MPEG-4/MJPEG, and all audio codecs supported by VIVOTEK’s cam- eras. User's Manual - 43...

  • Page 44: 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. 44 - User's Manual...

  • Page 45: Main Page

    VIVOTEK Main Page This chapter explains the screen elements on the main page. It is composed of the following sections: VIVOTEK INC. Logo, Host Name, Camera Control Area, Configuration Area, and Live Video Window. VIVOTEK logo Resize Buttons Configuration Area...
  • Page 46 VIVOTEK (Original) Display mode: 1O View (Original View) When mounted on a ceiling, the fisheye camera can cover an approximate of 64 m² surveillance area (installed at a height of approximately 3 meters), while still keeping details in videos with recognizable facial features of people trafficking through the area.
  • Page 47 Both panoramic views are corrected into a more viewable dewarped image. Viewers can use a mouse click and swipe to quickly scroll horizontally through the surveillance area. * Note that the dividing line falls approximately on the center of the VIVOTEK logo on the camera. 2P View (Panoramic View)
  • Page 48 VIVOTEK 1O3R (One Original & Three Regional) Display mode: The 1O3R mode provides access to multiple live view sections within the hemisphere and the reference to their relative positions on an Original circular view. The FOV indicators (#1 ~ #3) interact with your current operation as you may zoom in/out or move the live view window to a different place.
  • Page 49 VIVOTEK (Four Regional) Display mode: The view control and look and feel are identical to that as described in the 1O3R mode except that the Original circular view is absent from this mode. 4R PRO (Four Regional Proactive) Display mode: The 4R PRO mode is similar to the 4R mode except that the quad view windows consecutively rotate in correspondence to the change of view area in one window.
  • Page 50 VIVOTEK Video Stream: This Network Camera supports multiple streams (stream #1 ~ #4) simultaneously. You can select any one of them for live viewing. For more information about multiple streams, please refer to page 84 for detailed information. Manual Trigger: Click to manually enable or disable an event trigger. Please configure an event setting before enabling this function.
  • Page 51 VIVOTEK Pan /Tilt /Zoom speed: Adjust the speed of these controls when exerted: Pan speed Tilt speed Zoom speed Panoramic speed Slower Faster Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 55.
  • Page 52 VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Time Video (HTTP-V) 2015/03/10 17:08:56 Title and Time Video 17:08:56 2015/03/10 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 69.
  • Page 53 VIVOTEK Live Video Window ■ The following window is displayed when the video mode is set to H.265 or H.264: H.265/H.264 Protocol and Media Options Time Video Title Video (TPC-AV) Video 13:59:05 2017/05/04 Title and Time Video 13:59:05 2017/05/04 Video and Audio Control Buttons Video Title: The video title can be configured.
  • Page 54 VIVOTEK Start MP4 Recording: Click this button to record video clips in MP4 file format to your computer. Press the Stop MP4 Recording button to end recording. When you exit the web browser, video recording stops accordingly. To specify the storage destination and file name, please refer to MP4 Saving Options on page 56 for details.

  • Page 55: 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 56: Mp4 Saving Options

    VIVOTEK Two way audio Half duplex: Audio is transmitted from one direction at a time, e.g., from a PC holding a web console with the camera. Full duplex: Audio is transmitted in both directions simultaneously. MP4 Saving Options Users can record live video as they are watching it by clicking the “Start MP4 Recording”...

  • Page 57: 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 58: System > General Settings

    VIVOTEK System > General settings This section explains how to configure the basic settings for the Network Camera, such as the host name and system time. It is composed of the following two columns: System and System Time. System Host name: Enter a desired name for the Network Camera. The name will be displayed at the top center of the main page.

  • Page 59: 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 at the top of your homepage.
  • Page 60 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 61 VIVOTEK ■ Follow the steps below to set up a custom homepage: 1. Click Custom on the left column. 2. Click to select a color on on the right column. Color Selector Custom Pattern 3. The palette window will pop up as shown below.

  • Page 62: System > Logs

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

  • Page 64: System > Parameters

    The View Parameters page lists the entire system’s parameters in an alphabetical order. If you need technical assistance, use a text-editor program to copy and save the parameters listed on this page. Send the parameter text file to VIVOTEK’s technical support. 64 - User's Manual...

  • Page 65: System > Maintenance

    Note: Do not power off the Network Camera during the upgrade! Follow the steps below to upgrade the firmware: 1. Download the latest firmware file from the VIVOTEK website. The file is in .pkg file format. 2. Click Browse… and specify the firmware file.
  • Page 66 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 92). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
  • Page 67 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 68 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 69: Media > Image

    VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following tabbed windows: General settings, Image settings, Exposure, and Privacy mask, and Pixel Calculator. General settings Video title: Enter a name that will be displayed on the title bar of the live video as well as the view cell on the ST7501 and VAST recording software.
  • Page 70 VIVOTEK Color: Select to display color or black/white video streams. Power line frequency: Set the power line frequency consistent with local utility settings to eliminate image flickering associated with fluorescent lights. Video orientation: Flip - vertically reflect the display of the live video; Mirror - horizontally reflect the display of the live video.
  • Page 71 VIVOTEK ■ Synchronize with digital input The Network Camera automatically removes the IR cut filter when a digital input is triggered, for example, when the camera is accompanied by an external IR light that comes with its own sensor and provides a signal to the camera.

  • Page 72: Media > Ir Control

    VIVOTEK Media > IR control The IR (Infrared lilght) related functions are available for the FE9391-EV. IR illuminators 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.
  • Page 73 VIVOTEK Tips: If there is an object in close proximity, the IR lights reflected back from it can mislead the Anti- overexposure’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 74: Smart

    VIVOTEK Smart IR Smart IR is designed for applications where the IR fisheye camera is installed at a less-than-ideal position. For example, the fisheye can be installed next to a wall or column, which in turn may reflect the IR lights at night, causing over-exposure and blurring part of the image.

  • Page 75: Ir Zone Adjustment

    IMPORTANT: Zone 2 is the default front, indicated by the VIVOTEK camera logo on the dome cover. Zone 2 Zone 5 Zone 1...

  • Page 76: Image Settings

    VIVOTEK Image settings On this page, you can tune the White balance, Image adjustment and related parameters. You can configure two sets of preferred settings: one for normal situations, the other for special situations, such as a schedule mode. Quality: select from the pull-down menu the image quality of the current live view.
  • Page 77 VIVOTEK ■ Sharpness: Adjust the image sharpness level, which ranges from 0% to 100%. ■ Gamma curve: Adjust the image sharpness level, which ranges from 0.45 to 1, from Detailed to Contrast. You may let firmware Optimize your display or select the Manual mode, and pull the slide bar pointer to change the preferred level of Gamma correction towards higher contrast or towards the higher luminance for detailed expression for both dark and lighted areas of an image.

  • Page 78: Exposure

    VIVOTEK Exposure On this page, you can configure the Exposure measurement window, Exposure level, Exposure mode, Exposure time, Gain control, and Day/Night mode settings. Quality: select the pull-down menu to configure the image quality of the current display. Measurement Window: This function allows users to configure measurement window(s) for low light compensation.
  • Page 79 VIVOTEK The inclusive window refers to the “weighted window“; the exclusive window refers to the “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 80 VIVOTEK ■ Gain control: Tune the slide bar to set the Gain Control to the best image quality. Higher gain control value will generate a certain amount of noises, and that the gain control, lighting levels, and picture performance are closely related.

  • Page 81: Privacy Mask

    VIVOTEK Privacy mask Click Privacy Mask to open the configuration page. On this page, you can block out certain sensitive zones to address privacy concerns. ■ To configure the privacy mask windows, follow the steps below: 1. Click New to add a new window. A text box will appear allowing you to enter a name for the mask.

  • Page 82: Pixel Calculator

    VIVOTEK Pixel Calculator Click the Add button at the lower screen to create a pixel calculator window. Place your cursor on the window to move it to an area of your interest, and change the size of window to fit the area of interest.
  • Page 83 VIVOTEK Take the following into consideration when using this feature: 1. Operational requirement: Identify a human or a human face. 2. Why human face? There are less variances in the size of a face than that for limbs and body. Human face is normally 16cm wide.

  • Page 84: Media > Video

    VIVOTEK Media > Video Stream settings Please follow the steps below to set up those settings for an individual stream: 1. Select a stream to configure its viewing region. 2. Choose a proper Frame Size from the drop-down list according to the size of monitored device.
  • Page 85 VIVOTEK Click the stream item to display the detailed information. This Network Camera offers real-time H.265, H.264 and MJPEG compression standards (triple Codec) for real-time viewing. If the H.265 H.264 mode is selected, the video is streamed via RTSP protocol. There are several parameters for you to adjust the video performance: ■...
  • Page 86 VIVOTEK ■ Intra frame period Determine how often 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 87 VIVOTEK With the H.264 codec in an optimal scenario and when Dynamic Intra frame is combined with the Smart Stream function, an 80% of bandwidth saving can be achieved compared with using H.264 without enabling these bandwidth-saving features. Smart codec effectively reduces the quality of the whole FOV or the non-interested areas ■...
  • Page 88 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 89 VIVOTEK it rate control ■ B Constrained bit rate: A complex scene generally produces a larger file size, meaning that higher bandwidth will be needed for data transmission. The bandwidth utilization is configurable to match a selected level, resulting in mutable video quality performance. The bit rates are selectable...
  • Page 90 VIVOTEK JPEG mode is selected, the Network Camera continuously sends JPEG images to the client, producing a moving effect similar to a filmstrip. Every single JPEG image transmitted guarantees the same image quality, which in turn comes at the expense of variable bandwidth usage. Because the media contents are a combination of JPEG images, no audio data is transmitted to the client.

  • Page 91: 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 mute mode is turned on, no audio data will be transmitted even if audio transmission is enabled on the Client Settings page.

  • Page 92: 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 30 for details.
  • Page 93 VIVOTEK Primary DNS: The primary domain name server that translates hostnames into IP addresses. Secondary DNS: Secondary domain name server that backups the Primary DNS. Primary WINS server: The primary WINS server that maintains the database of computer name and IP address.
  • Page 94 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 95 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 96 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 97 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 98: 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 112 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 99 VIVOTEK URL command -- http://<ip address>:<http port>/<access name for stream 1 ~ 4> For example, when the Access name for stream 2 is set to video2.mjpg: 1. Launch Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter.
  • Page 100 VIVOTEK Authentication: Depending on your network security requirements, the Network Camera provides three types of security settings for streaming via RTSP protocol: disable, basic, and digest. basic authentication is selected, the password is sent in plain text format, but there can be potential digest risks of it being intercepted.
  • Page 101 VIVOTEK RTSP port /RTP port for video, audio/ RTCP port for video, audio ■ RTSP (Real-Time Streaming Protocol) controls the delivery of streaming media. By default, the port number is set to 554. ■ The RTP (Real-time Transport Protocol) is used to deliver video and audio data to the clients. By default, the RTP port for video is set to 5556 and the RTP port for audio is set to 5558.
  • Page 102 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 103 VIVOTEK SIP is short for Session Initiation Protocol. If necessary, you can change the default port number, 5060, to one between 1025 and 65535. Two way audio port: By default, the two way audio port is set to 5060. Also, it can also be assigned to another port number between 1025 and 65535.
  • Page 104 VIVOTEK Audio is being transmitted to the Network Camera 2011/03/09 17:08:56 Video (TCP-AV) Mute Talk Button Mic Volume Click to enable audio transmission to the Network Camera; click to adjust the volume of microphone; click to turn off the audio. To stop talking, click again.
  • Page 105 DDNS: Dynamic domain name service Enable DDNS: Select this option to enable the DDNS setting. Provider: Select a DDNS provider from the provider drop-down list. VIVOTEK offers Safe100.net, a free dynamic domain name service, to VIVOTEK customers. It is recommended that you register Safe100.net to access VIVOTEK’s Network Cameras from the Internet.
  • Page 106 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 107 VIVOTEK Express link Express Link is a free service provided by VIVOTEK server, which allows users to register a domain name for a network device. One URL can only be mapped to one MAC address. This service will examine if the host name is valid and automatically open a port on your router. If using DDNS, the user has to manually configure UPnP port forwarding.

  • Page 108: Network > Qos (Quality Of Service)

    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 109 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 110: 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 111: Network > Ftp

    FTP function. FTP port: The FTP server allows the user to save recorded video clips. You can utilize VIVOTEK's Installation Wizard 2 to upgrade the firmware via FTP server. By default, the FTP port is set to 21. It can also be assigned to another port number between 1025 and 65535.

  • Page 112: Security > User Accounts

    VIVOTEK Security > User accounts This section explains how to enable password protection and create multiple accounts. Account management The administrator account name is “root”, which is permanent and can not be deleted. If you want to add more accounts in the Account management window, please apply the password for the “root” account first.
  • Page 113 VIVOTEK Privilege management Digital Output & PTZ control: You can modify the management privilege as operators or viewers. Select or de-select the checkboxes, and then click Save to enable the settings. If you give Viewers the privilege, Operators will also have the ability to control the Network Camera through the main page. (Please refer to Configuration on page 57).

  • Page 114: Security > Https (Hypertext Transfer Protocol Secure)

    VIVOTEK Security > HTTPS (Hypertext Transfer Protocol Secure) This section explains how to enable authentication and encrypted communication. 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 115 VIVOTEK 5. Click Save to preserve your configuration, and your current session with the camera will change to the encrypted connection. 6. If your web session does not automatically change to an encrypted HTTPS session, click Home to re- turn to the main page. Change the URL address from “http://” to “https://“ in the address bar and press Enter on your keyboard.
  • Page 116 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 117 VIVOTEK 5. Look for a trusted certificate authority, such as Symantec’s VeriSign Authentication Services, that issues digital certificates. Sign in and purchase the secure 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 118 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 119 VIVOTEK 9. Save the edit using the “.crt” extension, using a file name like “CAcert.crt.” 10. Return to the original firmware session, use the Browse button to locate the crt certificate file, and click Upload to enable the certification. User's Manual - 119...
  • Page 120 VIVOTEK Note that a 11. When the certifice file is successfully loaded, its status will be stated as Active. certificate must have been created and installed before you can click on the “Save" button for the configuration to take effect.

  • Page 121: 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, #2, and #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 122 VIVOTEK ■ Disconnect: If you want to break off the current connections, please select them and click this button. Please note that those checked connections will only be disconnected temporarily and will automatically try to re-link again (IE Explorer or Quick Time Player).
  • Page 123 VIVOTEK Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List. The routing prefix is written in CIDR (Classless Inter-Domain Routing) notation. For example: accesses from IP address 192.168.2.x will be bolcked.

  • Page 124: Security > Ieee 802.1X

    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 125 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 126: Ptz > Ptz Settings

    VIVOTEK PTZ > PTZ settings This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation. The fisheye PTZ function allows users to move among regional views for close-up viewing. The PTZ view takes effect when the current field of view is not the circular Original view or the Panoramic view.
  • Page 127 VIVOTEK PTZ Settings Zoom Out Zoom In Preset positions and rotation settings In the PTZ settings page, you can create preset positions in the hemisphere covered by the fisheye lens. A total of 20 preset positions can be configured. Please follow the steps below to configure preset positions and arrange them in a rotational tour through different positions.
  • Page 128 VIVOTEK 4. Click Add to enable the settings. The preset positions will be listed on the User preset locations. (To add more positions you wish, please repeat steps 1~3.) 5. Select the preset positions by their checkboxes. 6. Click on the move button (>>) to move positions to the Patrol locations window.

  • Page 129: 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 130 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 131 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 132 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. ■ Trigger digital output for seconds Select this option to turn on the digital output signals (via the DO connectors on the main assembly) when a trigger is activated.

  • Page 133: Add Server

    VIVOTEK Add server Click Add server to unfold the server setting window. You can specify how the notification messages are delivered when a trigger is activated. A total of 5 server settings can be configured. There are four choices of server types available: Email, FTP, HTTP, and Network storage. Select the item to display the detailed configuration options.
  • Page 134 VIVOTEK To verify if the email settings are correctly configured, click Test. The result will be shown in a pop-up window. If successful, you will also receive an email indicating the result. Click Save server to enable the settings, then click Close to exit the Add server page.
  • Page 135 VIVOTEK ■ Passive mode Most firewalls do not accept new connections initiated from external requests. If the FTP server supports passive mode, select this option to enable passive mode FTP and allow data transmission to pass through the firewall. To verify if the FTP settings are correctly configured, click Test. The result will be shown in a pop-up window as shown below.
  • Page 136 VIVOTEK Network storage: Select to send the media files to a network storage location when a trigger is activated. Please refer to NAS server on page 155 for details. Click Save server to enable the settings, then click Close to exit the Add server page.

  • Page 137: Add Media

    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 138 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_20160720_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings, then click Close to exit the Add media page.
  • Page 139 VIVOTEK ■ Maximum duration Specify the maximum recording duration in seconds. Up to 10 seconds of video can be recorded. For example, if pre-event recording is set to 5 seconds and the maximum duration is set to 10 seconds, the Network Camera continues to record for another 4 seconds after a trigger is activated.
  • Page 140 VIVOTEK ■ View: Click this button to open a file list window. This function is only for SD card and Network Storage. If you click View button of SD card, a Local storage page will pop up for you to manage recorded files on SD card.
  • Page 141 VIVOTEK Here is an example of the Event setting: When completed the settings with steps 1~3 to arrange Schedule, Trigger, and Action of an event, click Save event to enable the settings and click Close to exit the page. The following is an example of the Event setting page:...
  • Page 142 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’s technical support. Click to upload a file...

  • Page 143: Applications > Motion Detection

    VIVOTEK Applications > Motion detection This section explains how to configure the Network Camera to enable motion detection. A total of 5 motion detection windows can be configured. Motion Detection Setting 2: For special situations Motion Detection Setting 1: For normal situations...
  • Page 144 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 129.
  • Page 145 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 129 for detailed information. NOTE: ►...

  • Page 146: Applications > Di And Do

    VIVOTEK Applications > DI and DO Digital input: Select High or Low as the Normal status for the digital input. Connect the digital input pin of the Network Camera to an external device to detect the current connection status. Digital output: Select Grounded or Open to define the normal status for the digital output. Connect the digital output pin of the Network Camera to an external device to determine the current status.

  • Page 147: 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 the spray paint. Please follow the steps below to set up the camera tamper detection function: 1.

  • Page 148: 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 149 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 150: Applications > Package Management - A.k.a., Vadp (Vivotek Application Development Platform)

    VADP requirements. Please contact our technical support or the vendor of your 3rd-party module for the parameters contained within. • Users can also run VIVOTEK's VADP packages as a means to access updated functionality instead of replacing the entire firmware. •...
  • Page 151 VIVOTEK To start a module, select the checkcircle in front, and click the Start button. If you should need to remove a module, select the checkcircle in front and then click the Stop button. By then the module status will become OFF, and the X button will appear at the end of the row.
  • Page 152 VIVOTEK On the License page, register and activate the license for using VIVOTEK's VADP modules. 152 - User's Manual...

  • Page 153: 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: 1. Each Recording setting records a video stream from one channel, i.e., from a single lens module.
  • Page 154 VIVOTEK ■ Recording name: Enter a name for the recording setting. ■ Enable this recording: Select this option to enable video recording. ■ With adaptive recording: Select this option will activate the frame rate control according to alarm trigger. The frame control means that when there is a triggered alarm/event, the frame rate will raise up to the value you’ve set...
  • Page 155 VIVOTEK Please follow steps 1~2 below to set up the recording: 1. Trigger Select a trigger source. ■ Schedule: The server will start to record files on the local storage or network attached storage (NAS). ■ Network fail: Since network fail, the server will start to record files onto the local storage (SD card).
  • Page 156 VIVOTEK 2. Click Test to check the setting. The result will be shown in the pop-up window. If successful, you will receive a test.txt file on the networked storage server. 3. Enter a server name. 4. Click Save to complete the settings and click Close to exit the page.
  • Page 157 VIVOTEK ■ Enable cyclic recording: If you check this item, when the maximum capacity is reached, the oldest file will be overwritten by the latest one. Recording file management ■ Maximum duration: This determines the length of each recorded video, applicable from 1 to 60 minutes.

  • Page 158: 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 159: 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 160 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 161 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 162: Appendix

    VIVOTEK Appendix URL Commands for the Network Camera 1. Overview For some customers who already have their own web site or web control application, the Network Camera/Video Server can be easily integrated through URL syntax. This section specifies the external HTTP-based application programming interface.

  • Page 163: General Cgi Url Syntax And Parameters

    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 164: Get Server Parameter Values

    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 165: Set Server Parameter Values

    If you omit this parameter, it will redirect to an empty page. (Note: The return page can be a general HTML file(.htm, .html) or a VIVOTEK server script executable (.vspx) file. It cannot be a CGI commandor have any extra parameters.This parameter must be User's Manual - 165...
  • Page 166 VIVOTEK placed at the end of the parameter list Return: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: <length>\r\n \r\n <parameter pair> where<parameter pair> is <parameter>=<value>\r\n [<parameter pair>] Only the parameters that you set and are readable will be returned. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123...

  • Page 167: Available Parameters On The Server

    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 168 VIVOTEK W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 available The API is listed in product WebAPIs. non-available The API is not in product WebAPIs. valid The API is listed in product WebAPIs, and is functional.
  • Page 169 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 170 VIVOTEK -140: GMT-03:30 Newfoundland -120: GMT-03:00 Brasilia, Buenos Aires, Georgetown, Greenland -80: GMT-02:00 Mid-Atlantic -40: GMT-01:00 Azores, Cape_Verde_IS. 0: GMT Casablanca, Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London 40: GMT 01:00 Amsterdam, Berlin, Rome, Stockholm, Vienna, Madrid, Paris 41: GMT 01:00 Warsaw, Budapest, Bern...
  • Page 171 VIVOTEK Caledonia 480: GMT 12:00 Aucklan, Wellington, Fiji, Kamchatka, Marshall Is. 520: GMT 13:00 Nuku'Alofa daylight_enable <boolean> Enable automaticdaylight saving time in time zone. daylight_dstactualmode <positive integer> Check if current time is under daylight saving time. (Used internally) daylight_auto_begintime string[19] Display the current daylight saving start time.
  • Page 172 VIVOTEK user has uploaded. This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results. restoreexceptvadp Restore the system parameters to default <positive integer>...
  • Page 173 VIVOTEK 7.1.1 system.info Subgroup of system: info (The fields in this group are unchangeable.) NAME VALUE SECURITY DESCRIPTION (get/set) modelname string[40] Internal model name of the server extendedmodelname string[40] ODM specific model name of server (eg. DCS-5610). If it is not an ODM model, this field will be equal to “modelname”...
  • Page 174 VIVOTEK xcount-1)> 7.2status Group: status NAME VALUE SECURITY DESCRIPTION (get/set) di_i<0~(capability_ndi-1)> <boolean> 0 => Inactive, normal <product dependent> 1 => Active, triggered (capability.ndi > 0) do_i<0~(capability_ndo-1)> <boolean> 0 => Inactive, normal <product dependent> 1 => Active, triggered (capability.ndo > 0) onlinenum_rtsp 0,<positive...
  • Page 175 VIVOTEK 7.3digital input behavior define Group: di_i<0~(n-1)> for n is the value of "capability_ndi" (capability.ndi > 0) NAME VALUE SECURITY DESCRIPTION (get/set) normalstate high, Indicates open circuit or closed circuit (inactive status) 7.4digital output behavior define Group: do_i<0~(n-1)> for n is the value of "capability_ndo"...
  • Page 176 VIVOTEK 7.6network Group: network NAME VALUE SECURITY DESCRIPTION (get/set) preprocess <positive integer> An 32-bit integer, each bit can be set separately as follows: Bit 0 => HTTP service; Bit 1=> HTTPS service; Bit 2=> FTP service; Bit 3 => Two way audio and RTSP Streaming service;...
  • Page 177 VIVOTEK wins1 <ip address> Primary WINS server. wins2 <ip address> Secondary WINS server. 7.6.1 802.1x Subgroup of network: ieee8021x (capability.protocol.ieee8021x > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable IEEE 802.1x eapmethod eap-peap, eap-tls Selected EAP method identity_peap string[64]...
  • Page 178 VIVOTEK <product dependent> (capability.naudioin > 0) eventalarm Event/alarm channel for CoS management Management channel for CoS eventtunnel Event/Control channel for CoS Subgroup of network: qos_dscp (capability.protocol.qos.dscp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable DSCP video 0~63 Video channel for DSCP...
  • Page 179 VIVOTEK 7.6.5 HTTP Subgroup of network: http NAME VALUE SECURITY DESCRIPTION (get/set) port 80, 1025 ~ 65535 HTTP port. alternateport 1025~65535 Alternate HTTP port. authmode basic, HTTP authentication mode. digest s<0~(capability_nmediast string[32] Http server push access name for stream N, ream-1)>_accessname...
  • Page 180 VIVOTEK s<0~(capability_nmediast string[32] RTSP access name for stream N, N= 1~ ream-1)>_accessname capability.nmediastream. <product dependent> (capability.protocol.spush_mjpeg =1 and capability.nmediastream > 0) The value are shown as live.sdp = s0_accessname, (stream1) live2.sdp = s1_accessname, (stream2) live3.sdp = s2_accessname, (stream3) live4.sdp = s3_accessname, (stream4) etc.
  • Page 181 VIVOTEK 1 ~ 255 Multicasttime to live value. 7.6.8 SIP port Subgroup of network: sip (capability.protocol.sip> 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 1025 ~ 65535 SIP port. 7.6.9 RTP port Subgroup of network: rtp NAME VALUE SECURITY DESCRIPTION (get/set)
  • Page 182 VIVOTEK 7.7IP Filter Group: ipfilter NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable access list filtering. admin_enable <boolean> Enable administrator IP address. admin_ip string[43] Administrator IP address. maxconnection 1~10 Maximum number of concurrent streaming connection(s). type 0, 1 Ipfilter policy : 0 =>...

  • Page 183: Video Input

    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> manual, rbgain, "rbgain": Use rgain and bgain to set white widerange, balance manually.
  • Page 184 VIVOTEK 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_m ode" !=0 irismode fixed, indoor, Control DC-Iris mode. "outdoor": Auto-setting DC-Iris to get best outdoor <product...
  • Page 185 VIVOTEK (external), 1(built-in) Bit 2 => Support pan operation; 0(not support), 1(support) Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only)
  • Page 186 VIVOTEK * Only available when "capability_image_c<0~(n-1)>_exposure_m axrange" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposure_ra ngetype" is "twovalues". enablepreview <boolean> Usage for UI of exposure settings. Preview settings of video profile. * Only available when "capability_image_c<0~(n-1)>_exposure_m...
  • Page 187 VIVOTEK balance (2000K to 10000K). "outdoor": auto white balance mode specifically for outdoor. "indoor": auto white balance mode specifically for indoor. "sodiumauto": sodium vapor lamps. * Only available when "capability_image_c<0~(n-1)>_wbm ode" !="-" rgain 0~100 Manual set rgain value of gain control setting.
  • Page 188 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 189 VIVOTEK rolling or flicker effect in indoor environment. "indoor": Avoid rolling and flicker effect first. "fixed": Open the iris to maximum. * Only available when "capability_image_c<0~(n-1)>_iristy pe"=dciris piris_mode manual, indoor, outdoor,- Control P-Iris mode. <product "outdoor": Auto-setting P-Iris to get dependent>...
  • Page 190 VIVOTEK maxgain 0~100 Maximum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_ maxgain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_expo sure_rangetype" is "twovalues". mingain 0~100 Minimum gain value.
  • Page 191 VIVOTEK 1 => color flip <boolean> Flip the image. mirror <boolean> Mirror the image. rotate 0,90,180,270 The rotation angle of image. Support only in Rotation mode (capability_videoin_c<0~(n-1)>_rota tion=1) ptzstatus 0,<positive integer> A 32-bit integer, each bit can be set <Not support separately as follows: anymore>...
  • Page 192 VIVOTEK etc. * Available value is listed in "capability_image_c<0~(n-1)>_expo * Only available when sure_minrange" "capability_image_c<0~(n-1)>_expo sure_minrange" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_expo sure_rangetype" is "twovalues". maxexposure <1~32000>, Maximum exposure time <product <5~32000>, 1~32000 =>...
  • Page 193 VIVOTEK etc. * Available value is listed in "capability_image_c<0~(n-1)>_expo * This parameter may also restrict sure_maxrange" image frame rate from sensor due to sensor generates a frame per exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.
  • Page 194 VIVOTEK h264,h265 <product dependent> s<0~(m-1)>_re Available options are list in Video resolution in pixels. solution "capability_videoin_c<0~(n-1)>_reso lution". Besides, available options is referred "capability_videoin_c<0~(n-1)>_ma xresolution" and "capability_videoin_c<0~(n-1)>_min resolution" s<0~(m-1)>_h <boolean> Enable "Dynamic intra frame period". 264_dintraperio * Only available when d_enable "capability_videoin_c<0~(n-1)>_dint...
  • Page 195 VIVOTEK directly. * Only valid when "ratecontrolmode"= vbr and s<0~(m-1)>_h264_quant = s<0~(m-1)>_h 1~100 Select customized quality in a 264_qpercent normalized full range. 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"= vbr and "quant"= 100. The maximum allowed bit rate in fixed  s<0~(m-1)>_h 20000~"capability_videoin_c<0~(n-1 "...
  • Page 196 VIVOTEK cbr and "quant"= 100. * Only available when "capability_smartstream_version"=2.   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 "ratecontrolmode"=   s<0~(m-1)>_h framerate,imagequality Set prioritypolicy 264_prioritypoli *  Only valid when "ratecontrolmode"=  ...
  • Page 197 VIVOTEK * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_h 1~5, Set the pre-defined quality level: 265_quant 99, 100 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue"...
  • Page 198 VIVOTEK * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~5, 100 Set the pre-defined quality level: 265_cbr_quant 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent"...
  • Page 199 VIVOTEK 265_prioritypoli * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= s<0~(m-1)>_h 1~"capability_videoin_c<0~(n-1)>_h The maximum frame rates of a H265 265_maxframe 265_maxframerate" stream at different resolutions("capability_videoin_c<0~ (n-1)>_resolution") are recorded in "capability_videoin_c<0~(n-1)>_h26 5_maxframerate" * Only available when h265 is listed in "capability_videoin_codec".
  • Page 200 VIVOTEK ex: 0301a_1 or 0301a_3) * Only valid when "ratecontrolmode"= or 1~99 vbr and s<0~(m-1)>_mjpeg_quant = (Only valid when "capability_api_httpversion" format is XXXXX_2, ex: 0301a_2) <product dependent> s<0~(m-1)>_m 1~100 Select customized quality in a jpeg_qpercent normalized full range. 1: Worst quality 100: Best quality * Only valid when "ratecontrolmode"=...
  • Page 201 VIVOTEK 100: Best quality * Only valid when "ratecontrolmode"= cbr and "quant"= 100. * Only available when "capability_smartstream_version"="2 .0" s<0~(m-1)>_m 20000~"capability_videoin_c<0~(n-1 The target bit rate in constant bit rate jpeg_bitrate )>_mjpeg_maxbitrate" mode. * Only valid when "ratecontrolmode"= s<0~(m-1)>_m framerate,imagequality Set prioritypolicy jpeg_prioritypoli * Only valid when "ratecontrolmode"=...
  • Page 202 VIVOTEK "capability_image_c<0~(n-1)>_wdrp ro_strength" is 1 wdrc_mode <boolean> Enable WDR enhanced. <product * Only available when dependent> "capability_image_c<0~(n-1)>_wdrc _mode" is 1 wdrc_strength 1~100 The strength of WDR enhanced. <product The bigger value means the stronger dependent> strength of WDR enhanced. * Only available when "capability_image_c<0~(n-1)>_wdrc...
  • Page 203 VIVOTEK it is easy to be trigger while scene changed. * Only available when "capability_image_c<0~(n-1)>_aesp eed" is 1 and "capability_image_c<0~(n-1)>_aesp eedsupportsensitivity" is 1. flickerless <boolean> Turn on(1) or turn off(0) the flickerless <product mode dependent> * Only available when "capability_image_c<0~(n-1)>_flicke rless"...
  • Page 204 VIVOTEK Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h264_smartstream2 (capability_smartstream_support=1 and capability_smartstream_version=2.0) Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h265_smartstream2 (capability_smartstream_support=1, capability_smartstream_version=2.0 and h265 is listed in "capability_videoin_codec") n denotes the value of "capability_nvideoin",m denotes the value of " capability_nmediastream" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or Disable smart codec function...
  • Page 205 VIVOTEK (capability_smartstream_support=1, capability_smartstream_version=2.0 and capability_smartstream_mode_manual = 1) Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h265_smartstream2_win_i<0~(k-1)> (capability_smartstream_support=1, capability_smartstream_version=2.0 and h265 is listed in "capability_videoin_codec" and capability_smartstream_mode_manual = 1) n denotes the value of "capability_nvideoin",m denotes the value of " capability_nmediastream",k denotes the value of "capability_smartstream_nwindow_manual". NAME VALUE...
  • Page 206 VIVOTEK "capability_image_c "capability_image_c<0~(n-1)>_exposure_mi <0~(n-1)>_exposu nrange" != "-" re_minrange" * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposure_ra ngetype" is "twovalues". maxexposure <1~32000>, Maximum exposure time <product dependent> <5~32000>, 1~32000 => 1s ~ 1/32000s <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>,...
  • Page 207 VIVOTEK 1/5s on the night, then sensor only outputs 5 frame/s. * Only available when "capability_image_c<0~(n-1)>_exposure_m axrange" != "-" and "capability_image_c<0~(n-1)>_exposure_ra ngetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 208 "capability_image_c speed automatically. <0~(n-1)>_exposu "qualitypriority": Automatically adjust the re_modetype") Iris, Gain and Shutter Speed by VIVOTEK quality algorithm. "manual": Manually adjust with variable Shutter, Iris and Gain. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 209 VIVOTEK 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)>_wbmode". * Only valid when "videoin_c<0~(n-1)>_whitebalance" != auto * Normalized range. bgain 0~100 Manual set bgain value of gain control setting.
  • Page 210 VIVOTEK gainvalue 0~100 Gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_maxgain " != "-" and "capability_image_c<0~(n-1)>_exposure_ra ngetype" is "onevalue". * Normalized range. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 211 VIVOTEK "fixed": Open the iris to maximum. * Only available when "capability_image_c<0~(n-1)>_iristype"=dci wdrpro_mode <boolean> Enable WDR pro <product dependent> * Only available when "capability_image_c<0~(n-1)>_wdrpro_mod e" > 0 wdrpro_strength 1~100 The strength of WDR Pro. <product dependent> The bigger value means the stronger strength of WDR Pro.
  • Page 212 VIVOTEK * Only available when "capability_image_c<0~(n-1)>_aespeed" is 1   aespeed_sensitivity 1~100 The sensitivity of AE converge speed. <product dependent> 1~20: level 1 21~40: level 2 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher sensitivity level meas that it is easy to be trigger while scene changed.
  • Page 213 VIVOTEK 7.10 IR cut control Group: ircutcontrol (capability.nvideoinprofile> 0 and capability_daynight_c<0~(n-1)>_support > 0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, Set IR cut control mode day, night, schedule <product dependent> <boolean> Enable/disable Smart IR <product dependent>...
  • Page 214 VIVOTEK "low,normal,high": if _c<0~(n-1)>_ircut sensitivity_type=op capability_daynight_c<0~(n-1)>_ircutsensiti tions) vity_type=options "1~100": if 1~100 (if capability_daynight capability_daynight_c<0~(n-1)>_ircutsensiti _c<0~(n-1)>_ircut vity_type=normalize sensitivity_type=no rmalize) * Only available when "capability_daynight_c<0~(n-1)> _ircutsensitivity_type" is not "-". 7.11 Image setting per channel Group: image_c<0~(n-1)> for n channel profucts and m profile n denotes the value of "capability_nvideoin"...
  • Page 215 VIVOTEK * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. saturation -5~5,100 -5: Less saturation <-> 5: More saturation <Not recommended to use this> 100: Use " image_c<n>_saturationpercent" * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicsetting"...
  • Page 216 * Only available when bit 3 of "capability_image_c<0~(n-1)>_basicsetting" is 1 gammacurve 0~100 0: Fine-turned gamma curve by Vivotek. <product dependent> 1: Gamma value = 0.01 2: Gamma value = 0.02 3: Gamma value = 0.03 100: Gamma value = 1 * Note: Although we set gamma value to 100 level, but not all gamma values are valid.
  • Page 217 VIVOTEK <product dependent> 0:disable 1:enable * Only available when "capability_image_c<0~(n-1)>_defog_mode" is 1 defog_strength 1~100 Strength of defog <product dependent> * Only available when "capability_image_c<0~(n-1)>_defog_mode" is 1 eis_mode <boolean> Electronic image stabilizer <product dependent> 0:disable 1:enable * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mode".
  • Page 218 VIVOTEK freeze <boolean> Enable/disable Image freeze while patrolling. <product dependent> 0: disable 1: enable * Only available when "capability_image_c<0~(n-1)>_freeze" is 1 deinterlace_enable <boolean> Enable/disable deinterlace function. 0: disable 1: enable * Only available when "capability_image_c<0~(n-1)>_deinterlace_s upport" is 1. deinterlace_mode spatial,blend...
  • Page 219 VIVOTEK image_c<0~(n-1)>_brightnesspercent" * Only available when bit 0 of "capability_image_c<0~(n-1)>_basicsetting" is 1 * We replace "profile_i0_brightness" with "profile_i0_brightnesspercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. profile_i<0~(m-1)>_contrast -5~5,100 -5: Less contrast <-> 5: More contrast <Not recommended to use this>...
  • Page 220 * Only available when bit 3 of "capability_image_c<0~(n-1)>_basicsetting" is 1 profile_i<0~(m-1)>_gammacur 0~100 0: Fine-turned gamma curve by Vivotek. 1: Gamma value = 0.01 2: Gamma value = 0.02 3: Gamma value = 0.03 100: Gamma value = 1 220 - User's Manual...
  • Page 221 VIVOTEK * Note: Although we set gamma value to 100 level, but not all gamma values are valid. Internal module will take the closest valid one. For example, 1~45 may all be mapped to gamma value = 0.45, etc. * Only available when "capability_image_c<0~(n-1)>_gammacurve...
  • Page 222 VIVOTEK <product dependent> 0:disable 1:enable * Only available when 'dis' is listed in "capability_image_c<0~(n-1)>_is_mode". profile_i<0~(m-1)>_dis_streng 1~100 Strength of digital image stabilizer * Only available when 'dis' is listed in <product dependent> "capability_image_c<0~(n-1)>_is_mode". profile_i<0~(m-1)>_scene_ena <boolean> Enable/disable scene mode 0: disable <product dependent>...
  • Page 223 VIVOTEK 7.12 Exposure window setting per channel Group: exposurewin_c<0~(n-1)> for n channel profucts n denotes the value of "capability_nvideoin" (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1) NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, custom,blc,hlc "auto": Use full image view as the only exposure window.
  • Page 224 VIVOTEK "capability_image_c<0~(n-1)>_exposure_wi ndomain". homepx <0~W,0~H> Left-top corner coordinate of the window. W: 0~ The current image width -1 * Only available when px is listed in H: 0~ The current image height -1 "capability_image_c<0~(n-1)>_exposure_wi ndomain". sizepx <0~Wx0~ H> Width and height of the window.
  • Page 225 VIVOTEK Group: exposurewin_c<0~(n-1)>_profile_i<0~(m-1)>_win_i<0~(k-1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the value of "capability_nvideoinprofile", k denotes the value of "capability_image_c<0~(n-1)>_exposure_winnum". (Only available when "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)
  • Page 226 VIVOTEK ndomain". sizestd <0~9999x0~9999> Width and height of the window. * Only available when std is listed in "capability_image_c<0~(n-1)>_exposure_wi ndomain". 7.13 Audio input per channel Group: audioin_c<0~(n-1)> for n channel products (capability.naudioin>0) n denotes the value of "capability_nvideoin" NAME VALUE...
  • Page 227 VIVOTEK volume_external 0~100 Volume when take external microphone as input source. 0: Minimum 100: Maximum * Only available when the channel supports external microphone (The related bit of "capability_audio_extmic" is equal to 1). mute 0, 1 0: Mute off 1: Mute on...
  • Page 228 VIVOTEK 48000, * Only available if AAC is supported. 64000, 96000, 128000 s0_gamr_bitrate 4750, AMR encoded bitrate in bps. 5150, 5900, * Only available if AMR is supported. 6700, 7400, 7950, 10200, 12200 s0_g711_mode pcmu, Set G.711 companding algorithm. pcma pcmu: µ-law algorithm...

  • Page 229: Motion Detection Settings

    VIVOTEK alarm_level 1~100 Audio detection alarm level profile_i0_enable <boolean> Enable/disable this profile setting profile_i0_policy night, The mode which the profile is applied to. schedule * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a.
  • Page 230 VIVOTEK this> * We replace "sensitivity" with "win_sensitivity". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. polygonpx 0 ~ W,0 ~ H, 0 ~ Coordinate of polygon window position.  ...
  • Page 231 VIVOTEK 0 ~ 240 Top coordinate of window position. <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 232 VIVOTEK policy night, The mode which the profile is applied to. schedule * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a. begintime hh:mm Begin time of schedule mode. endtime hh:mm End time of schedule mode.
  • Page 233 VIVOTEK   image width -1 H: 0~ The current * Only available when px is listed in 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.
  • Page 234 VIVOTEK version number (httpversion) is equal or greater than 0400a. 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".
  • Page 235 VIVOTEK 7.15 Tampering detection settings Group: tampering_c<0~(n-1)> for n channel products (capability.tampering > 0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable tamper detection. threshold 0~100 Threshold of tamper detection. duration 10~600 If tampering value exceeds the "threshold"...
  • Page 236 VIVOTEK 7.16 DDNS Group: ddns (capability.protocol.ddns > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the dynamic DNS. provider CustomSafe100, Safe100 => safe100.net DyndnsDynamic, DyndnsDynamic => dyndns.org (dynamic) DyndnsCustom, DyndnsCustom => dyndns.org Safe100 CustomSafe100 => Custom server using safe100 method <provider>_hostname...

  • Page 237: System Log

    VIVOTEK 7.18 UPnP presentation Group: upnppresentation NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP presentation service. 7.19 UPnP port forwarding Group: upnpportforwarding NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP port forwarding service.
  • Page 238 VIVOTEK 0: disable 1: Show log of parameter setting set from external. 2. Show log of parameter setting set from external and internal. 7.21 SNMP Group: snmp (capability.protocol.snmp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) <boolean> SNMP v2 enabled. 0 for disable, 1 for enable <boolean>...
  • Page 239 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 240 VIVOTEK 7.23 Privacy mask Group: privacymask_c<0~(n-1)> for n channel products and m privacy mask window. n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY DESCRIPTION (get/set) enable <boolean> Enable privacy mask. win_i<0~(m-1)>_enable <boolean>...
  • Page 241 VIVOTEK 0 ~ W,0 ~ H "capability_image_c<0~(n-1)>_privacymask W: 0~ The current _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)>_privacymask _windomain". win_i<0~(m-1)>_polygo 0 ~ 9999,0 ~ 9999, Coordinate of polygon window position.
  • Page 242 NAME VALUE SECURITY DESCRIPTION (get/set) api_httpversion <string> The version of VIVOTEK WebAPI with 4 This number start integers plus 1 alphabet, There are composed with 0301a. by "major version", "minor version", "revision","_platform". ex: 0301a_1 Major version Increase the major version when change,...
  • Page 243 VIVOTEK 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. The 5th character is model-based version for API bug-fix and it's default to "a".
  • Page 244 VIVOTEK 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". More details, please refer the parameter description of "volume_internal"...
  • Page 245 VIVOTEK Bit 7 => (only available when bit0 is 1) External or built-in PT; 0(built-in), 1(external) windowless <boolean> Indicate whether to support windowless plug-in. evctrlchannel <boolean> Indicate whether to support HTTP tunnel for event/control transfer. joystick <boolean> Indicate whether to support joystick control.
  • Page 246 VIVOTEK Bit 0 => 1st stream supports ePTZ or not. Bit 1 => 2nd stream supports ePTZ or not, and so on. For nvideoin >= 2, the definition is different: First all 32 bits are divided into groups for channel.
  • Page 247 VIVOTEK adaptiverecording <boolean> Indicate whether to support adaptive recording. adaptivestreaming <boolean> Indicate whether to support adaptive streaming. supporttriggertypes seq,boot,motion,net list all the trigger types which are supported in workfail,recnotify,ta the camera: mpering,vi,vadp,di, "seq" = Periodic condition volalarm,temperatu "boot" = System boot re,pir, visignal, "motion"...
  • Page 248 VIVOTEK protocol_spush_mjpeg <boolean> Indicate whether to support server push MJPEG. protocol_snmp <boolean> Indicate whether to support SNMP. protocol_ipv6 <boolean> Indicate whether to support IPv6. protocol_pppoe <boolean> Indicate whether to support PPPoE. protocol_ieee8021x <boolean> Indicate whether to support IEEE802.1x. protocol_qos_cos <boolean>...
  • Page 249 VIVOTEK FD8183 supports H.264 and MJPEG, then this is "mjpeg,h264". IP9171 supports H.264, MJPEG and H.265, then this is "mjpeg,h264,h265" videoin_streamcodec A list of <Positive This equals Integer> "capability_videoin_c0_streamcodec". * This is kept for compatibility. videoin_flexiblebitrate <boolean> Indicate whether to support flexible bit rate control.
  • Page 250 VIVOTEK 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. - (fixed) : UI is fixed to one selection or value.
  • Page 251 VIVOTEK audio_intmic <0~Positive Internal (Built-in) Microphone. Integer> 0: Not support 1: Support Bit 0 for CH0, bit 1 for CH1, and so on. audio_extmic <0~Positive External Microphone. Integer> 0: Not support 1: Support Bit 0 for CH0, bit 1 for CH1, and so on.
  • Page 252 VIVOTEK polygon: The window is a 2D polygon shape. rectangle: The window is a 2D rectangle shape. motion_windomain qvga, px, std, - The domain to set an motion window. qvga: a 320x240 range to represent the whole image. px: Locate a window in the image with pixels.
  • Page 253 VIVOTEK anual manual. * 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 254 VIVOTEK 1: support both /cgi-bin/camctrl/camctrl.cgi and /cgi-bin/viewer/camctrl.cgi 0: support only /cgi-bin/viewer/camctrl.cgi This is equivalent to"capability_camctrl_c0_privilege". * This is kept for compatibility. uart_httptunnel <boolean> Indicate whether to support HTTP tunnel for UART transfer. transmission_mode Indicate transmission mode of the machine: TX = server, Rx = receiver box, Both = DVR.
  • Page 255 VIVOTEK 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 256 VIVOTEK * 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 " this> with "capability_image_c0_ focusassist".
  • Page 257 VIVOTEK is 1 or "capability_storage_dbenabled" is 1. localstorage_smartsd <boolean> The "Lifetime and Log SD Card" feature allows users to obtain the card's remaining lifetime information. 0: Non-support this feature 1: Support this feature * Only Sony SD card can support this function now.
  • Page 258 VIVOTEK privilege <boolean> Indicate whether to support “Manage Privilege” of PTZ control in the security page in this video input. 1: support both /cgi-bin/camctrl/camctrl.cgi and /cgi-bin/viewer/camctrl.cgi 0: support only /cgi-bin/viewer/camctrl.cgi rs485 <boolean> An 32-bit integer, each bit can be set separately as follows: Bit 0 =>...
  • Page 259 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 260 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 261 VIVOTEK focusspeedlv 0, <positive integer> 0/7 The maximum speed level of focus motion. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule" is "1" minfocus 0, <positive integer> 0/7 The lower limit for focus position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule"...
  • Page 262 VIVOTEK ircutsensitivity_type <string> Indicate the cgi interface of "ircutcontrol_sensitivity". "options": the value of "ircutcontrol_sensitivity" parameter is "low, normal,high". "normalize": the value of "ircutcontrol_sensitivity" parameter is "1~100" "-":not support * Only available when "capability_daynight_c<0~(n-1)>_support" is * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
  • Page 263 VIVOTEK Group: capability_videoin_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) The lens type of this channel.  lens_type fisheye, fixed, fisheye: Fisheye lens  varifocal, changeable, fixed: Build‐in fixed‐focus lens.  motor, - varifocal: Build‐in varifocal lens.  <product dependent> changeable: changeable lens. Like box‐type  camera, users can install any C‐Mount or  CS‐Mount lens as they wish.  motor: Lens with motor to support zoom, focus,  etc.  ‐: N/A    * Only available when [httpversion] >= 0301a rotation <boolean>...
  • Page 264 VIVOTEK rotationaffect When rotation is enabled, some features may <product dependent> become malfunction or be forced to a given value. The affected functions are list here. The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select - (unchanged) : UI keeps the status as before and user can't change it.
  • Page 265 VIVOTEK streamcodec <positive integer> Represent supported codec types of each stream. This contains a list of positive integers, split by comma. Each one stands for a stream, and the definition is as following: Bit 0: Support MPEG4. Bit 1: Support MJPEG Bit 2: Support H.264...
  • Page 266 VIVOTEK maxframerate A list of <Integer> Indicate frame rate that the video source outputs in current video mode. One to one mapping to the resolution in  "resolution".    * The element number is defined as  "nresolution" in this group.  * This parameter may be changed when  "videoin_c<n>_cmosfreq"=50 or  "videoin_c<n>_modulation"=pal.  Ex: 30 fps is changed to 25 fps, 60 fps is changed  to 50 fps, and so on. mjpeg_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer>...
  • Page 267 VIVOTEK h264_maxframerate A list of <Positive Maximum fps that the device can encoded with Integer> and "-" H.264 on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution"...
  • Page 268 VIVOTEK fisheye_mounttype ceiling, wall, floor Indicate the supported type. <product dependent> <product dependent> wall mount: 180° panoramic view ceiling mount: 360° surround view without blind spots floor mount: 360° surround view without blind spots Only available when "capability_fisheye" > 0 dintraperiod_support <boolean>...
  • Page 269 VIVOTEK typewallmount 1O, 1P, 1R, 4R Available dewarp types of wall mount. resolutionC1P A list of <WxH> Available resolutions of 1P mode of ceiling and floor mount. resolutionC2P A list of <WxH> Available resolutions of 2P mode of ceiling and floor mount.
  • Page 270 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 271 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 272 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 273 VIVOTEK maxfps_h264 A list of <Positive Maximum fps which the device can encoded with Integer> and "-" H.264 on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution"...
  • Page 274 VIVOTEK   to proper position vertically or not. wdrpro_mode   0, 1, 2     0: Non-support WDR Pro 1: Support WDR Pro   2: Support WDR Pro and WDR Pro II wdrpro_strength 0, 1 0: Non-support tuning strength of...
  • Page 275 VIVOTEK - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6"...
  • Page 276 VIVOTEK 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. <product dependent>...
  • Page 277 VIVOTEK > 0. * We support this parameter when the version number (httpversion) is equal or greater than 0306d. dnrtype 2d,3d Description about DNR type. * Only available when "capability_image_c<0~(n-1)>_dnr" > 0. * We support this parameter when the version number (httpversion) is equal or greater than 0308a.
  • Page 278 VIVOTEK "capability_image_c<0~(n-1)>_is_m ode" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. is_affect When Is mode is not "-", some minexposure:hidden:, features may become malfunction or mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here.
  • Page 279 VIVOTEK integer or string or NULL. "-" means no feature is affected. * Only available when "capability_image_c<0~(n-1)>_is_m ode" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. scenemode_support 0: Non-support scene mode...
  • Page 280 VIVOTEK "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL.
  • Page 281 VIVOTEK - (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" which means exposurelevel is fixed to level 6.
  • Page 282 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 283 VIVOTEK value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled.
  • Page 284 VIVOTEK   lens. sensortype rawsensor, Indicate sensor type. smartsensor, "rawsensor": Raw sensor "smartsensor": Smart sensor "-": N/A * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_mode       0: Non-support exposure control.
  • Page 285 VIVOTEK * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1 and "capability_image_c<0~(n-1)>_expo sure_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_gainvaluetype fixed, * One to one mapping to the mode maximum, type in "exposure_modetype".
  • Page 286 VIVOTEK 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. - (enabled) : UI is checked.
  • Page 287 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 288 VIVOTEK e_affect 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" <x>: nonnegative integer <product dependent> "Policy" can be categorized into...
  • Page 289 VIVOTEK 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_qualitypriority When exposure quality priority mode mode_affect exposurewin.mode.blc:hidd is enabled, some features may become en:, malfunction or be forced to a given defog:disabled:, value.
  • Page 290 VIVOTEK "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when qualitypriority 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 0305a.
  • Page 291 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. "-" means no feature is affected.
  • Page 292 VIVOTEK * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1 and hlc is listed in "capability_image_c<0~(n-1)>_ exposure_winmode". exposure_hlcmode_affect When hlc mode is enabled, some or others features may become malfunction or be forced to a given value. The <x>: nonnegative integer affected functions are list here.
  • Page 293 VIVOTEK "-" means no feature is affected. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1 and hlc is listed in "capability_image_c<0~(n-1)>_ exposure_winmode". * We support this parameter when the version number (httpversion) is equal or greater than 0304a. exposure_wintype  ...
  • Page 294 VIVOTEK "capability_image_c<0~(n-1)>_ exposure_mode" is 1.   A list of <Positive Integer> exposure_ntsc_totalrange Available total range for NTSC 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. 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"...
  • Page 295 VIVOTEK * When "exposure_mode"=0, this value must be set to "-". * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. privacymask_wintype rectangle, The supported mask window type. polygon, "polygon": The window is a 2D 3Drectangle polygon shape. "rectangle": The window is a 2D rectangle shape.
  • Page 296 VIVOTEK "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. - (fixed) : UI is fixed to one selection or value.
  • Page 297 VIVOTEK _mode"=1, this may be either 0 or 1. defog_supportlevel 0, <positive integer> The value indicate the support strength level of defog. defog_affect When defog is enabled, some features wdrpro:unchanged:, may become malfunction or be forced or others to a given value. The affected functions are list here.
  • Page 298 VIVOTEK * When "defog" = 0, this value must be "-" aespeed 0: Non-support AE speed 1: Support AE speed aespeedsupportlevel <positive integer> The value indicate the support strength level of aespeed. * Only available when "capability_image_c<0~(n-1)>_aesp eed" is 1.
  • Page 299 VIVOTEK focuswindomain qvga, px, std, - The domain to set a focus window. "qvga": a 320x240 range to represent the whole image. "px": Locate a window in the image with pixels. "std": A normalized 0~9999 range. "-": Not supported. focuswindow_nwindow 0,<positive integer>...
  • Page 300 VIVOTEK better image quality (than not using the deinterlace function at all). * Only available when capability_image_c<0~(n-1)>_deinte rlace_support is 1 Group: capability_peripheral_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) devicecontrol <boolean> Indicate whether to support the peripheral device control.

  • Page 301: Event Setting

    VIVOTEK 7.27 Event setting Group: event_i<0~2> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry. enable 0, 1 Enable or disable this event. priority 0, 1, 2 Indicate the priority of this event: “0”= low priority “1”= normal priority “2”= high priority...
  • Page 302 VIVOTEK mdwin 0,<positive integer> Indicate the source window id of motion detection. This field is required when trigger condition is “md”. One bit represents one window. The LSB indicates the 1 window. For example, to detect the 1 and 3 windows, set mdwin as 5.
  • Page 303 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 304 VIVOTEK action_server_i<0~4>_ena <boolean> Enable or disable this server action. action_server_i<0~4>_me NULL, 0~4,101 Index of the attached media. 101 means “Recording Notify” action_server_i<0~4>_dat <boolean> Enable this to create folders by date, time, and efolder hour automatically. action_goto_enable <boolean> Enable/disable ptz goto preset position on event <product dependent>...
  • Page 305 VIVOTEK 7.28 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 306 VIVOTEK 7.29 Media setting for event action Group: media_i<0~4> 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. videoclip, recordmsg snapshot_source 0~"capability_nmediastream"-1 Indicate the source of media stream.
  • Page 307 VIVOTEK videoclip_maxduration 1 ~ " Maximum duration of one video clip in capability_media_videoclip_maxlen seconds. gth" videoclip_maxsize 50 ~ " Maximum size of one video clip file in capability_media_videoclip_maxsiz Kbytes. e" 7.30 Recording Group: recording_i<0~1> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] Identification of this entry.
  • Page 308 VIVOTEK limitsize <boolean> 0: Entire free space mechanism 1: Limit recording size mechanism cyclic <boolean> 0: Disable cyclic recording 1: Enable cyclic recording notify <boolean> 0: Disable recording notification 1: Enable recording notification notifyserver 0~31 Indicate which notification server is scheduled.
  • Page 309 VIVOTEK dest The destination to store the recorded data. “cf” means local storage (CF or SD card). “0” means the index of the network storage. cffolder string[128] Folder name. maxsize 100~2000 Unit: Mega bytes. When this condition is reached, recording file is truncated.
  • Page 310 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 311 VIVOTEK PARAMETER VALUE SECURITY DESCRIPTION (get/set) enabled <boolean> Enable automatic clean up method. Expired and not locked media files will be deleted. maxretentiontime_recordin <boolean> Enable automatic clean up method for video clip g_enabled generated by recording task. The parameter takes effect when autocleanup_enabled is enabled.

  • Page 312: Region Of Interest

    VIVOTEK maxretentiontime_others_ <string> To specify the expired time for automatic clean maxage up, and it takes effect for all media files except media files generated by recording task. 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 313: Eptz Setting

    VIVOTEK 7.34 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 314 VIVOTEK Group: eptz_c<0~(n-1)>_s<0~(m-1)> for n channel product and m is the index of video stream which support ePTZ. (capability.eptz > 0 or capability_fisheye = 1) PARAMETER VALUE SECURITY DESCRIPTION (get/set) patrolseq string[120] The patrol sequence of ePTZ. All the patrol position indexes will be separated by ","...
  • Page 315 VIVOTEK 7.35 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 316 VIVOTEK 7.37 VIVOTEK Application Development Platformsetting Group: vadp NAME VALUE SECURITY DESCRIPTION (get/set) version <string> Indicate the VADP version. resource_total_memory 0,<positive integer> 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 317 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 318 VIVOTEK 7.38 camera PTZ control Group: camctrl (capability.camctrl.ptztunnel > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enableptztunnel <boolean> Enable PTZ tunnel for camera control. Group: camctrl_c<0~(n-1)> for n channel products (capability.ptzenabled > 0) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset"...
  • Page 319 VIVOTEK 7.39 camera PTZ control (IZ series) Group: camctrl_c<0~(n-1)> for n channel products (capability_camctrl_c0_zoommodule = 1 and capability_camctrl_c0_buildinpt = 0) n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset" NAME VALUE SECURITY DESCRIPTION (get/set) ccdtype string[16]...
  • Page 320 VIVOTEK * Only available when bit7 of capability_ptzenabled is 1 preset_i<0~(k-1)>_name string[40] Name of the preset location. preset_i<0~(k-1)>_zoom capability_ptz_c<0~(n-1) Zoom position at each preset location. >_minzoom ~ capability_ptz_c<0~(n-1) >_maxzoom preset_i<0~(k-1)>_focus capability_ptz_c<0~(n-1) Focus position at each preset location. >_minfocus ~ capability_ptz_c<0~(n-1) >_maxfocus...
  • Page 321 VIVOTEK returnhomeinterval 1~999 While idle over this time interval, idle 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.
  • Page 322 VIVOTEK preset_i<0~(k-1)>_name string[40] Name of the preset location. 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.
  • Page 323 VIVOTEK axisz capability_ptz_c<0~(n-1) Custom home zoom position. >_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 324 VIVOTEK greater than 0307a. 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 325 VIVOTEK 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.42 UART control (SD series) Group: uart_i<0~(n-1)> n is uart port count (capability.nuart >...
  • Page 326 VIVOTEK 7.43 Lens configuration Group: lens for n channel products n denotes the value of "capability_nvideoin" (capability.image.c<0~(n-1)>.lensconfiguration.support = 1) NAME VALUE SECURITY DESCRIPTION (get/set) selected <string> Current selected lens profile. e.g. lens_selected=lens_default_i0, it means choosen lens configuration is i0 lens of default group.
  • Page 327 VIVOTEK 7.44 Fisheye info Group: fisheyeinfo (capability.fisheye > 0) NAME VALUE SECURITY DESCRIPTION (get/set) revisedcenteraxis <coordinate> The actual center axis coordinate radius 0, <positive The actual center radius integer> 7.45 Fisheye local dewarp setting   Group: fisheyedewarp_c<0~(n-1)> (capability_fisheyelocaldewarp_c<0~(n-1)> > 0)  ...
  • Page 328 VIVOTEK 7.47 Auto tracking setting Group: autotrack_c<0~(n-1)> (capability_image_c<0~(n-1)>_autotrack_support > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) objsize_type -1~2 Type of object size. -1 : customized width and height 0 : object size = 30 x 30...

  • Page 329: Shock Detection

    VIVOTEK encrypt none, Encryption method: wep, none: NONE, wpa, wep: WEP, wpa2 wpa: WPA, wpa2: WPA2PSK authmode OPEN, SHARED Authentication mode. * Only valid when "wireless_encrypt" is "wep" keylength 64, 128 Key length in bits. * Only valid when "wireless_encrypt" is "wep"...

  • Page 330: Drive The Digital Output

    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 331 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 332: Capture Single Snapshot

    VIVOTEK \r\n do1=1\r\n Capture Single Snapshot Note: This request requires Normal User privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/video.jpg?[channel=<value>][&resolution=<value>] [&quality=<value>][&streamid=<value>] If the user requests a size larger than all stream settings on the server, this request will fail. PARAMETER VALUE DEFA DESCRIPTION...

  • Page 333: Account Management

    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 334: System Logs

    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 335 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 336 VIVOTEK http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed. To stop a continuous movement, you have to use the command as below: http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zoom=stop&zs=0 2. [Area zoom]: it means to zoom in on a specific area, here is an example for a directly moving...
  • Page 337 VIVOTEK <integer> The direction of movement, used for joystick control. <integer> 0 ~ 7 Set the speed of movement, “0” means stop. <integer> x-coordinate clicked by user. It will be the x-coordinate of center after movement. <integer> y-coordinate clicked by user.
  • Page 338 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 339 VIVOTEK 8.10 ePTZ Preset Locations(capability.eptz > 0 and capability_fisheye = 0) Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/ePreset.cgi?channel=<value>&stream=<value> [&addpos=<value>][&delpos=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source. stream <0~(m-1)> Stream. addpos <Text string less than Add one preset location to the preset list.
  • Page 340 VIVOTEK delv6 Delete IPv6 address from access list. <IP address> Single address: <IP address> Network address: <IP address / network mask> Range address:<start IP address - end IP address> index <value> The start position to add or to delete. return <return page>...
  • Page 341 VIVOTEK PARAMETER VALUE DESCRIPTION channel 0 ~ (n-1) The channel number of UART. 8.13 Event/Control HTTP Tunnel Channel (capability. evctrlchannel > 0) Note: This request requires Administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/ctrlevent.cgi ------------------------------------------------------------------------- GET /cgi-bin/admin/ctrlevent.cgi x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled...
  • Page 342 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 343 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. Each data>[,<hex decimal...
  • Page 344 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 345 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 346 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 347 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 348 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=<v alue>&forcechk&minsft=<value>] For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player.
  • Page 349 VIVOTEK Return Code Description 400 Bad Request Request is rejected because some parameter values are illegal. 415 Unsupported Media Type Returned, if forcechk appears,when minsft is not achievable or the timeshift feature of the target stream is not enabled. User's Manual - 349...
  • Page 350 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 350 - User's Manual...
  • Page 351 VIVOTEK function zoom, Function type focus, zoom - Move focus motor auto, focus – Move focus motor scan, auto – Perform auto focus scan – Perform focus scan stop, positioning, stop – Stop current operation getstatus positioning – Position the motors getstatus–Information of motors, return value as below:...
  • Page 352 VIVOTEK steps 1 ~ <motor_max> Motor’s moving steps. It works only if function=zoom | focus and direction=forward |   backward. <motor_max> is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from "function=getstatus" * This parameter is for additional fine-tune, the value is from 1 to 30.
  • Page 353 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 User's Manual - 353...
  • Page 354 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 355 VIVOTEK steps 1 ~ <motor_max> Motor’s moving steps.   It works only if function=focus and direction=forward | backward. <motor_max> is refer to remote_focus_focus_motor_max which replied from "function=getstatus" * This parameter is for additional fine-tune, the value is from 1 to 30.
  • Page 356 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 357 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 358 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 359 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 360 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 361 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 362: Camera Control

    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 363 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 364 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 365 VIVOTEK gettiltangle <integer> Get the current tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getzoom 0, <positive integer> Get the current zoom position. getratio <decimal> Get the current zoom ratio. getfocus 0, <positive integer> Get the current focus position.
  • Page 366 VIVOTEK getmaxratio <decimal> Get the maximum ratio of optical zoom. * We support this parameter when the version number (getversion) is equal or greater than 5.0.0.14 getmaxdratio <decimal> Get the maximum ratio of digital zoom. * We support this parameter when the version number (getversion) is equal or greater than 5.0.0.14...

  • Page 367: Preset Locations

    VIVOTEK 8.30 Preset Locations (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/preset.cgi?[channel=<value>] [&addpos=<value>][&delpos=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION addpos string[30] Add one preset location to the preset list. channel 0~"capability_nvideoin"-1 Channel of the video source. delpos string[30] Delete preset location from preset list.
  • Page 368 VIVOTEK 8.31 SmartSD (capability_localstorage_smartsd > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/smartsd.cgi?function=<value> PARAMETER VALUE DESCRIPTION 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...
  • Page 369 VIVOTEK 8.32 Connect to AP (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION Apply the wireless settings and connect to AP. 8.33 Get wireless information (capability_network_wireless > 0) Note: This request requires Administrator privileges.
  • Page 370 VIVOTEK 8.34 Get wireless signal strength (capability_network_wireless > Note: This request requires Administrator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/getwlsignalstrength.cgi PARAMETER VALUE DESCRIPTION Get wireless signal strength. 8.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...
  • Page 371 VIVOTEK 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 [&washer_mode=<value>] – Set washer mode [&washer_status=<value>] – Set washer status [&washer_dwelltime=<value>] – Set washer clean time [&heater_status=<value>] – Set heater status Example: http://myserver/cgi-bin/admin/peripheral.cgi?channel=0&operation=set&washer_mode=wiper&...
  • Page 372 VIVOTEK *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 Disable the functionality of washer control system. *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 washer_dwelltime 15~999 Apply washer washer control system operation time (including the time when spraying and wiper actions take place). *Only available when capability_peripheral_c<0~(n-1)>_washer_supp...
  • Page 373 VIVOTEK 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. supportdevice Get support peripheral device. washer_supportmode Get the support mode of washer control system, its value is the same with "capability_peripheral_ c<0~(n-1)>_washer_mode". *Only available when capability_peripheral_c<0~(n-1)>_washer_supp...
  • Page 374 VIVOTEK an internal condition.‘trigger’ status will be transfer to ‘auto’ after reach the internal condition. *Only available when capability_peripheral_c<0~(n-1)>_heater_suppo rt=1 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...
  • Page 375 VIVOTEK Example: 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.  ...
  • Page 376 VIVOTEK "optimizedir_c0_irmode='manual'"   Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=settoall&irmode=manual&strength=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,     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 377 VIVOTEK http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&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: Must have the "irmode=manual" argument!   Syntax: (for querying API) http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=get   [&support_irmode] – list all adjustment mode that IR supports [&irmode] – Get current IR mode  ...

  • Page 378: Technical Specifications

    Casing FE9391-EV: IP66, IK10 Video Streaming configurable video cropping for bandwidth saving, Smart Stream II FE9191: CE, LVD, VCCI, C-Tick, UL, FCC Class B Safety Certifications Adjustable image size, quality and bit FE9391-EV: CE, LVD, VCCI, C-Tick, UL, rate, time stamp, text overlay, flip & mirror,...
  • Page 379 All specifications are subject to change without notice. Copyright © VIVOTEK INC. All rights reserved. Ver. 10 6F, No.192, Lien-Cheng Rd., Chung-Ho, New Taipei City, 235, Taiwan, R.O.C. | T: +886-2-82455282 | F: +886-2-82455532 | E: sales@vivotek.com | W: www.vivotek.com...

  • Page 380: Technology License Notice

    VIVOTEK Technology License Notice Notices from HEVC Advance: THIS PRODUCT IS SOLD WITH A LIMITED LICENSE AND IS AUTHORIZED TO BE USED ONLY IN CONNECTION WITH HEVC CONTENT THAT MEETS EACH OF THE THREE FOLLOWING QUALIFICATIONS: (1) HEVC CONTENT ONLY FOR PERSONAL USE; (2) HEVC CONTENT THAT IS NOT OFFERED FOR SALE;...
  • Page 381 Support Should you require any technical assistance, please contact your VIVOTEK reseller/distributor. VIVOTEK distributor contact information could be found on Where to Buy section at VIVOTEK website. To enhance customer satisfaction, your reseller/ distributor will reach us in a timely manner if the issue is not solved with first response.

  • Page 382: Electromagnetic Compatibility (Emc)

    取扱説明書に従って正しい取り扱いをして下さい Liability VIVOTEK Inc. cannot be held responsible for any technical or typographical errors and reserves the right to make changes to the product and manuals without prior notice. VIVOTEK Inc. makes no warranty of any kind with regard to the material contained within this document, including, but not limited to, the implied warranties of merchantability and fitness for any particular purpose.

This manual is also suitable for:

Fe9391-ev

Table of Contents