CC9160-H CC9160-H(HS) Compact Cube / Height Strip Network Camera User ’s Manual 2MP • Seamless Recording • Panoramic View • Color Coded Height Levels Smart Stream III • Microphone Rev. 1.
VIVOTEK Table of Contents Overview �������������������������������������������������������������������������������������������������������������������������������������������������������������������� 3 Revision History ����������������������������������������������������������������������������������������������������������������������������������������������������� 4 Read Before Use ����������������������������������������������������������������������������������������������������������������������������
VIVOTEK Applications > Audio detection ��������������������������������������������������������������������������������������������������������������� 142 Applications > Package management - a.k.a.
VIVOTEK Revision History ■ Rev. 1.0: Initial release. Read Before Use The use of surveillance devices may be prohibited by law in your country. The Network Camera is not only a high-performance web-ready camera but can also be part of a flexible surveillance system. It is the user’s responsibility to ensure that the operation of such devices is legal before installing this unit for its intended use.
VIVOTEK Package Contents ■ ■ ■ ■ CC9160-H or CC9160-H(HS) Screw pack, tilt bracket (CC9160-H) Quick Installation Guide. Terminal block. Symbols and Statements in this Document i INFORMATION: provides important messages or advices that might help prevent inconvenient or problem situations. NOTE: Notices provide guidance or advices that are related to the functional integrity of the machine. Tips: Tips are useful information that helps enhance or facilitae an installation, function, or process.
VIVOTEK Physical Description - CC9160-H Outer View Reset button Lens LED Microphone Inner View DI/DO terminal blok RJ45 Ethernet port 6 - User's Manual
VIVOTEK Physical Description - CC9160-H(HS) Camera View Coverage Vertical: 100º Horizontal: 180º Top View Side View Installation Concerns Install the camera following the height decals. A routing hole is placed behind the 5 feet height level. When the acryllic stips are removed, use a pencil to mark the mounting holes inside the bracket. 866.
VIVOTEK 1.6~1.8m 3m 2m Recognition Perception The camera is designed to capture human activities in a near-heminspheric field of view, at a place such as the entrance to a business facility. Due to the optical characteristics of wide-angle lens, image quality decreases as distance from an object increases. It is therefore recommended to install the camera within 3 meters or closer to the objects of your interest. The focus center should also be aligned with objects of importance, say, human faces.
VIVOTEK NOTE: Some of the suffix syntax used in model naming are listed below: E w/ heater for extreme weather Fx Focal length w/ number T w/ Remote focus lens R w/ PoE repeater H w/ High Dynamic Range functionality User's Manual - 9
VIVOTEK Hardware Installation - CC9160-H 1. Jot down the camera's MAC address for later reference. XXXXXX 0002D10766AD Select a position for mounting your camera. Side View Vertical: 100º Horizontal: 180º Top View 15º 1.6~1.
VIVOTEK It is recommended to use an Ethernet cable without the connector jacket. 2. Insert an Ehternet cable to the bottom of the mount bracket. Secure the connector from the bottom using an included screw.
VIVOTEK If you need to connect a DI or DO connection, refer to below drawing for pinouts. Use a small flat-blade screwdriver to push and insert wires. DO- DI- DO+ DI+ 3.5 a DO- D I- 3. You can either install the bracket to wall or a single gang box.
VIVOTEK You can also attach a tilt bracket to the back of the mount bracket. 15º - OR - If preferred, use the cable clips to hold the Ethernet or DI/DO wires in place.
VIVOTEK 4. Slide the camera from top to bottom agrainst the bracket. The RJ45 connector should be connected. 5. Use the bottom cover that comes with adhesive to seal the bottom of your device.
VIVOTEK 6. Please visit VIVOTEK’s website to Install the "Shepherd” software utility. The program will search for VIVOTEK Video Receivers, Video Servers or Network Cameras on the same LAN. Double-click on the camera’s MAC address to open a web console to the camera.
VIVOTEK Software Installation 7. 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. 7-1. Run the Shepherd utility. 7-2. The program will conduct an analysis of your network environment.
VIVOTEK 7-3. The program will search for all VIVOTEK network devices on the same LAN. 7-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. Network Camera Model No: CC9160-H MAC:0002D1730202 R o HS This device complies with part 15 of the FCC rules.
VIVOTEK Forceful Password Configuration 8. The first time you log in to the camera, the firmware will prompt for a password configuration for security concerns. 8-1. Since your camera is used for the first time, there is no password. Enter “root” as the user name, and nothting for the password. 8-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.
VIVOTEK Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~. You can use them in the password combination. 8-3. Another prompt will request for the password you just configured. Enter the password and then you can start configure your camera and see the live view.
VIVOTEK Hardware Installation - CC9160-H(HS) 1. Jot down the camera's MAC address for later reference. XXXXXX 0002D10766AD 2. Use a pencil and a roll ruler to mark the positions of mounting holes and the routing hole.
VIVOTEK 3. Remove the top and bottom covers. Note that you should be careful when handling the acryllic strips. 4. Remove the acryllic strips.
VIVOTEK If you need to connect DI/DO wires, see the drawings below for pinouts. Use a small flat-blade screwdriver to insert the wires. DO- DI- DO+ DI+ 5. Use a pencil to mark the routing holes and routing hole for passing an Ethernet cable. Drill holes and hammer in the plastic anchors.
VIVOTEK 6. When the camera is mounted to wall, connect a CAT5e Ethernet cable to its LAN port, and pass the other end through the routing hole. RJ-45 port 7. Insert the lower acryllic strip, secure the bottom cover. Inser the upper acryllic strip, and then secure the top cover. When inserting the acryllic strips, avoid hitting the lens module.
VIVOTEK 8. Please visit VIVOTEK’s website to Install the "Shepherd” software utility. The program will search for VIVOTEK Video Receivers, Video Servers or Network Cameras on the same LAN. Double-click on the camera’s MAC address to open a web console to the camera.
VIVOTEK Software Installation 9. 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. 9-1. Run the Shepherd utility. 9-2. The program will conduct an analysis of your network environment.
VIVOTEK 9-3. The program will search for all VIVOTEK network devices on the same LAN. 9-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. Network Camera Model No: CC9160-H MAC:0002D1730202 R o HS This device complies with part 15 of the FCC rules.
VIVOTEK Forceful Password Configuration 10. The first time you log in to the camera, the firmware will prompt for a password configuration for security concerns. 10-1. Since your camera is used for the first time, there is no password. Enter “root” as the user name, and nothting for the password. 10-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.
VIVOTEK Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~. You can use them in the password combination. 10-3. Another prompt will request for the password you just configured. Enter the password and then you can start configure your camera and see the live view.
VIVOTEK Hardware Reset The reset button is used to reset the system or restore the factory default settings. Sometimes resetting the system can return the camera to normal operation. If the system problems remain after reset, restore the factory settings and install again. Reset: Press the recessed reset button. Wait for the Network Camera to reboot. Restore: Press and hold the reset button until the status LED rapidly blinks. Note that all settings will be restored to factory default.
VIVOTEK Network Deployment General Connection (PoE) When using a PoE-enabled switch The Network Camera is PoE-compliant, allowing transmission of power and data via a single Ethernet cable. Follow the below illustration to connect the Network Camera to a PoEenabled switch via Ethernet cable. 802.3af PoE Switch When using a non-PoE switch Use a PoE power injector (optional) to connect between the Network Camera and a nonPoE switch. PoE Power Injector (optional) Non-PoE Switch NOTE: 1.
VIVOTEK Ready to Use 1. A browser session to the Network Camera should prompt as shown below. 2. You should be able to see live video from your camera. You may also install the 32-channel recording software in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents.
VIVOTEK Internet connection via a router Before setting up the Network Camera over the Internet, make sure you have a router and follow the steps below. 1. Connect your Network Camera behind a router, the Internet environment is illustrated below. Regarding how to obtain your IP address, please refer to Software Installation on page 20 for details. WAN (Wide Area Network ) Internet Router IP address : from ISP POWER COLLISION 1 2 3 4 5 IP address : 192.168.0.3 Subnet mask : 255.255.255.
VIVOTEK For example, your router and IP settings may look like this: Device IP Address: internal port IP Address: External Port (Mapped port on the router) Public IP of router 122.146.57.120 LAN IP of router 192.168.2.1 Camera 1 192.168.2.10:80 122.146.57.120:8000 Camera 2 192.168.2.11:80 122.146.57.120:8001 ... ... ...
VIVOTEK Accessing the Network Camera This chapter explains how to access the Network Camera through web browsers, RTSP players, 3GPP-compatible mobile devices, and VIVOTEK recording software. Using Web Browsers Use Installation Wizard 2 (IW2) to access the Network Cameras on LAN. If your network environment is not a LAN, follow these steps to access the Netwotk Camera: 1. Launch your web browser (e.g., Microsoft® Internet Explorer or Mozilla Firefox). 2.
VIVOTEK ► By default, the Network Camera is not password-protected. To prevent unauthorized access, it is highly recommended to set a password for the Network Camera. For more information about how to enable password protection, please refer to Security on page 104. ► If you see a dialog box indicating that your security settings prohibit running ActiveX ® Controls, please enable the ActiveX ® Controls for your browser. 1. Choose Tools > Internet Options > Security > Custom Level. 2.
VIVOTEK IMPORTANT: • Currently the Network Camera utilizes a 32-bit ActiveX plugin. You CAN NOT open a management/view session with the camera using a 64-bit IE browser. • If you encounter this problem, try execute the Iexplore.exe program from C:\Windows\ SysWOW64. A 32-bit version of IE browser will be installed. • On Windows 7, the 32-bit explorer browser can be accessed from here: C:\Program Files (x86)\Internet Explorer\iexplore.
VIVOTEK Using RTSP Players To view the streaming media using RTSP players, you can use one of the following players that support RTSP streaming. VLC media player VLC media player 1. Launch the RTSP player. mpegable Player 2. Choose File > Open URL. A URL dialog box will pop up. 3. The pvPlayer address format is rtsp://:/ As most ISPs and players only allow RTSP streaming through port number 554, please set the RTSP port to 554.
VIVOTEK Using 3GPP-compatible Mobile Devices To view the streaming media through 3GPP-compatible mobile devices, make sure the Network Camera can be accessed over the Internet. For more information on how to set up the Network Camera over the Internet, please refer to Setup the Network Camera over the Internet on page 30. To utilize this feature, please check the following settings on your Network Camera: 1.
VIVOTEK Using VIVOTEK Recording Software Visit our website for download the VAST recording software that provides simultaneous monitoring and video recording for multiple Network Cameras. Please install the recording software; then launch the program to add the Network Camera to the Channel list. For detailed information about how to use the recording software, please refer to the user’s manual of the software or download it from http://www.vivotek.com. Tips: 1.
VIVOTEK Main Page This chapter explains the layout of the main page. It is composed of the following sections: VIVOTEK INC. Logo, Host Name, Camera Control Area, Configuration Area, Menu, and Live Video Window. Resize Buttons VIVOTEK INC. Logo Host Name Configuration Area Hide Button Live View Window VIVOTEK INC. Logo Click this logo to visit the VIVOTEK website. Host Name The host name can be customized to fit your needs.
VIVOTEK Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 45. Configuration: Click this button to access the configuration page of the Network Camera. It is suggested that a password be applied to the Network Camera so that only the administrator can configure the Network Camera. For more information, please refer to Configuration on page 50.
VIVOTEK PTZ Panel: This Network Camera supports “digital“ (e-PTZ) pan/tilt/zoom control, which allows roaming a smaller view frame within a large view frame. Please refer to PTZ settiings on page 119 for detailed information. Global view and the PTZ panel are available with the 3rd or the last video profile. Global View: Global view is available with the 3rd or the last video profile. Click on this item to display the Global View window.
VIVOTEK Video Control Buttons: Depending on the Network Camera model and Network Camera configuration, some buttons may not be available. Snapshot: Click this button to capture and save still images. The captured images will be displayed in a pop-up window. Right-click the image and choose Save Picture As to save it in JPEG (*.jpg) or BMP (*.bmp) format. Digital Zoom: Click and uncheck “Disable digital zoom” to enable the zoom operation.
VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Title and Time Video (HTTP-V) 2021/03/25 17:08:56 Time Video 17:08:56 2021/03/25 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 66. Time: Display the current time. For more information, please refer to Media > Image on page 66. Title and Time: Video title and time can be stamped on the streaming video.
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 Protocol Options H.264 Protocol Options Depending on your network environment, there are four transmission modes of H.264 streaming: UDP unicast: This protocol allows for more real-time audio and video streams.
VIVOTEK MP4 Saving Options Users can record live video as they are watching it by clicking page. Here, you can specify the storage destination and file name. Start MP4 Recording on the main Folder: Specify a storage destination on your PC for the recorded video files. The location can be changed. File name prefix: Enter the text that will be appended to the front of the video file name. A specified folder will be automatically created on your local hard disk.
VIVOTEK Joystick settings Enable Joystick Connect a joystick to a USB port on your management computer. Supported by the plug-in (Microsoft’s DirectX), once the plug-in for the web console is loaded, it will automatically detect if there is any joystick on the computer. The joystick should work properly without installing any other driver or software. Then you can begin to configure the joystick settings of connected devices. Please follow the instructions below to enable joystick settings. 1.
VIVOTEK Buttons Configuration In the Button Configuration window, the left column shows the actions you can assign, and the right column shows the functional buttons and assigned actions. The number of buttons may differ from different joysticks. Please follow the steps below to configure your joystick buttons: 1. Choosing one of the actions and click Assign will pop up a dialog. Then you can assign this action to a button by pressing the joystick button or select it from the drop-down list.
VIVOTEK Buttons Configuration Click the Configure Buttons button, a window will prompt as shown below. Please follow the steps below to configure your joystick buttons: 1. Select a button number from the Button # pull-down menu. Tips: If you are not sure of the locations of each button, use the Properties window in the Game Controllers utility. 2. Select a corresponding action, such as Patrol or Preset#. 3. Click the Assign button to assign an action to the button.
VIVOTEK 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.
VIVOTEK System > General settings This section explains how to configure the basic settings for the Network Camera, such as the host name and system time. It is composed of the following two columns: System, and System Time. When finished with the settings on this page, click Save at the bottom of the page to enable the settings. System Host name: Enter a desired name for the Network Camera.
VIVOTEK System time Keep current date and time: Select this option to preserve the current date and time of the Network Camera. The Network Camera’s internal real-time clock maintains the date and time even when the power of the system is turned off. Synchronize with computer time: Select this option to synchronize the date and time of the Network Camera with the local computer. The read-only date and time of the PC is displayed as updated. Manual: The administrator can enter the date and time manually.
VIVOTEK Western Argentina Summer Time (WARST) is 3 hours behind the prime meridian all year. There is a dummy fall-back transition on December 31 at 25:00 daylight saving time (i.e., 24:00 standard time, equivalent to January 1 at 00:00 standard time), and a simultaneous spring-forward transition on January 1 at 00:00 standard time, so daylight saving time is in effect all year and the initial WART is a placeholder. The format is TZ = local_timezone,date/time,date/time. Here, date is in the Mm.n.
VIVOTEK System > Homepage layout This section explains how to set up your own customized homepage layout. General settings This column shows the settings of your hompage layout. You can manually select the background and font colors in 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.
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.
VIVOTEK ■ Follow the steps below to set up the customized homepage: 1. Click Custom on the left column. 2. Click the field where you want to change the color on the right column. Color Selector Custom Pattern 3. The palette window will pop up as shown below. 2 3 1 4 4. Drag the slider bar and click on the left square to select a desired color. 5. The selected color will be displayed in the corresponding fields and in the Preview column. 6. Click Save to enable the settings.
VIVOTEK System > Logs This section explains how to configure the Network Camera to send the system log to a remote server as backup. Log server settings Follow the steps below to set up the remote log: 1. Select Enable remote log. 2. In the IP address text box, enter the IP address of the remote server. 2. In the port text box, enter the port number of the remote server. 3. When completed, click Save to enable the setting.
VIVOTEK 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 Access log Access log displays the access time and IP address of all viewers (including operators and administrators) in a chronological order. The access log is stored in the Network Camera’s buffer area and will be overwritten when reaching a certain limit. Set Parameter log VADP log contains the history of changes made to system parameters such as recording, imaging parameters, and all other parameters.
VIVOTEK System > Parameters The View Parameters page lists the entire system’s parameters. If you need technical assistance, please provide the information listed on this page.
VIVOTEK System > Maintenance This chapter explains how to restore the Network Camera to factory default, upgrade firmware version, etc. General settings > Upgrade firmware This feature allows you to upgrade the firmware of your Network Camera. It takes a few minutes to complete the process. 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.
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 86). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page). Custom Language: Select this option to retain the Custom Language settings.
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. Export configuration file: Click to export all parameters for the device and user-defined scripts.
VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following columns: General settings, Image settings, Exposure, and Privacy mask. The Focus window is available only for models that come with motorized lens. General settings Video title Show_timestamp_and video_title_in_video_and_snapshots: Enter a name that will be displayed on the title bar of the live video as the picture shown below.
VIVOTEK Video orientation: Flip - vertically reflect the display of the live video; Mirror - horizontally reflect the display of the live video. Select both options if the Network Camera is installed upside-down (e.g., on the ceiling) to correct the image orientation. Please note that if you have preset locations, those locations will be cleared after flip/mirror setting. Rotate - Normal Flip Mirror Rotate 90° clockwise The rotation here indicates clockwise rotation.
VIVOTEK Image settings On this page, you can tune the White balance and Image adjustment. Sensor Setting 2: For special situations Sensor Setting 1: For normal situations White balance: Adjust the value for the best color temperature. ■ You may follow the steps below to adjust the white balance to the best color temperature. 1. Place a sheet of paper of white or cooler-color temperature color, such as blue, in front of the lens, then allow the Network Camera to automatically adjust the color temperature.
VIVOTEK Noise reduction ■ Enable noise reduction: Check to enable noise reduction in order to reduce noises and flickers in image. This applies to the onboard 3D Noise Reduction feature. Use the slide bar to adjust the reduction strength. Note that applying this function to the video channel will consume system computing power. 3D Noise Reduction is mostly applied in low-light conditions. When enabled in a low-light condition with fast moving objects, trails of after-images may occur.
VIVOTEK Exposure On this page, you can set the Exposure measurement window, Exposure level, Exposure mode, Exposure time, Gain control, and Day/Night mode settings. You can configure two sets of Exposure settings: one for normal situations, the other for special situations, such as the day/night/schedule mode.
VIVOTEK The inclusive window refers to the “weighted window“; the exclusive window refers to “ignored window“. It adopts the weighted averages method to calculate the value. The inclusive windows have a higher priority. You can overlap these windows, and, if you place an exclusive window within a larger inclusive window, the exclusive part of the overlapped windows will be deducted from the inclusive window. An exposure value will then be calculated out of the remaining of the inclusive window.
VIVOTEK Exposure control: ■ Exposure level: You can manually set the Exposure level, which ranges from -2.0 to +2.0 (dark to bright). You can click and drag the semi-circular pointers on the Exposure time and Gain control slide bars to specify a range of shutter time and Gain control values within which the camera can automatically tune to an optimal imaging result.
VIVOTEK You can click Restore to recall the original settings without incorporating the changes. When completed with the settings on this page, click Save to enable the settings. If you want to configure another sensor setting for day/night/schedule mode, please click Profile to open the Profile of exposure settings page as shown below. Activated period: Select the mode this profile to apply to: Day mode, Night mode, or Schedule mode. Please manually enter a range of time if you choose Schedule mode.
VIVOTEK Privacy mask Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to address privacy concerns. 4x ■ To configure privacy mask windows, 1. Click New to add a new window. 2. You can use 4 mouse clicks to create a new masking window, which is recommended to be at least twice the size of the object (height and width) you want to cover. 3. Enter a Window Name and click Save to enable the setting. 4.
VIVOTEK Media > Video Stream settings This Network Camera supports multiple streams with frame sizes ranging from 480 x 272 to 1920 x 1080 pixels The definition of multiple streams: ■ Stream 1: Users can define the "Region of Interest" (viewing region) and the "Output Frame Size" (size of the live view window). ■ Stream 2: Users can define the "Region of Interest" (viewing region) and the "Output Frame Size" (size of the live view window).
VIVOTEK Please follow the steps below to set up those settings for a stream: 1. Select a stream for which you want to set up the viewing region. 2. Select a Region of Interest from the drop-down list. The floating frame, the same as the one in the Gloabl View window on the home page, will resize accordingly. If you want to set up a customized viewing region, you can also resize and drag the floating frame to a desired position with your mouse. 3.
VIVOTEK Click the stream item to display the detailed information. The maximum frame size will follow your settings in the above Viewing Window sections. This Network Camera provides real-time H.265, H.264 and MJPEG compression standards (Triple Codec) for real-time viewing. If the H.265 or H.264 mode is selected, the video is streamed via RTSP protocol.
VIVOTEK The frame rate will decrease if you select a higher resolution. ■ Intra frame period Determine how often for firmware to plant an I frame. The shorter the duration, the more likely you will get better video quality, but at the cost of higher network bandwidth consumption. Select the intra frame period from the following durations: 1/4 second, 1/2 second, 1 second, 2 seconds, 3 seconds, and 4 seconds. ■ Smart stream III ■ Dynamic Intra frame period High quality motion codecs, such as H.
VIVOTEK With the H.265 codec in an optimal scenario and when Dynamic Intra frame is combined with the Smart Stream function, an 80% of bandwidth saving can be achieved compared with using H.264 without enabling these bandwidth-saving features. ■ Smart FPS In a static scene, the algorithm puts old frames in queue when no motions occur in scene. When motions occur, the encoding returns to normal to deliver real-time streaming. f1 f1 f1 f1 f5 f5 f5 f5 f9 f5 f6 f7 f8 f9 Motions Occur.
VIVOTEK • Smart codec: Smart codec effectively reduces the quality of the whole or the noninterested areas on a screen and therefore reduces the bandwidth consumed. You can manually specify the video quality for the foreground and the background areas. Select an operation mode if Smart codec is preferred. - Auto tracking: The Auto mode configures the whole screen into the non-interested area. The video quality of part of the screen returns to normal when one or more objects move in that area.
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.
VIVOTEK ■ Bit rate control Constrained bit rate: • A complex scene generally produces a larger file size, meaning that higher bandwidth will be needed for data transmission. The bandwidth utilization is configurable to match a selected level, resulting in mutable video quality performance. The bit rates are selectable at the following rates: 20Kbps, 30Kbps, 40Kbps, 50Kbps, 64Kbps, 128Kbps, 256Kbps, 512Kbps, 768Kbps, 1Mbps, 2Mbps, 3Mbps, 4Mbps, 6Mbps, 8Mbps, 10Mbps, 12Mbps, 14Mbps, ~ to 80Mbps.
VIVOTEK Fixed quality: On the other hand, if Fixed quality is selected, all frames are transmitted with the same quality; bandwidth utilization is therefore unpredictable. The video quality can be adjusted to the following settings: Medium, Standard, Good, Detailed, and Excellent. You can also select Customize and manually enter a value.
VIVOTEK If the JPEG mode is selected, the Network Camera sends consecutive JPEG images to the client, producing a moving effect similar to a filmstrip. Every single JPEG image transmitted guarantees the same image quality, which in turn comes at the expense of variable bandwidth usage. Because the media contents are a combination of JPEG images, no audio data is transmitted to the client.
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. In that case, the following message is displayed: Internal microphone input gain: Select the gain of the internal audio input according to ambient conditions. Adjust the gain from 0% (least) to 100% (most).
VIVOTEK Media profiles You can configure a different video stream for each of the 3 default profiles, Max. view, Recording, Live view, and App. The related video stream information will display, including stream number, resolution, codec used, frame rate, etc. The Multicast port number, and address for video, audio, and Metadata configuration will also be listed.
VIVOTEK Network > General settings This section explains how to configure a wired network connection for the Network Camera. Network Type LAN Select this option when the Network Camera is deployed on a local area network (LAN) and is intended to be accessed by local computers. The default setting for the Network Type is LAN. Please rememer to click on the Save button when you complete the Network setting.
VIVOTEK Primary DNS: The primary domain name server that translates hostnames into IP addresses. Secondary DNS: Secondary domain name server that backups the Primary DNS. Primary WINS server: The primary WINS server that maintains the database of computer names and IP addresses. Secondary WINS server: The secondary WINS server that maintains the database of computer names and IP addresses.
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 TM is not supported by your router, you will see the following message: Error: Router does not support UPnP port forwarding. ► Steps to enable the UPnP TM user interface on your computer: Note that you must log on to the computer as a system administrator to install the UPnP TM components. 1.
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 TM is enabled. ► How does UPnP TM work? UPnP TM networking technology provides automatic IP configuration and dynamic discovery of devices added to a network. Services and capabilities offered by networked devices, such as printing and file sharing, are available among each other without the need for cumbersome network configuration.
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. When IPv6 is enabled, by default, the network camera will listen to router advertisements and be assigned with a link-local IPv6 address accordingly. IPv6 Information: Click this button to obtain the IPv6 information as shown below.
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. Press Enter on the keyboard or click Refresh button to refresh the webpage.
VIVOTEK User's Manual - 91
VIVOTEK Network > Streaming protocols NOTE: The metadata information can only be transmitted through the HTTP main port. Metadata is not available through the secondary HTTP port. 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 104 for details.
VIVOTEK URL command -- http://:/ For example, when the Access name for stream 2 is set to video1s2.mjpg: 1. Launch Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter. 3. The JPEG images will be displayed in your web browser. http://192.168.5.151/video1s2.
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. If basic authentication is selected, the password is sent in plain text format, but there can be potential risks of it being intercepted. If digest authentication is selected, user credentials are encrypted using MD5 algorithm, thus providing better protection against unauthorized access.
VIVOTEK Multicast settings for streams: Click the items to display the detailed configuration information. Select the Always multicast option to enable multicast for video streams. Unicast video transmission delivers a stream through point-to-point transmission; multicast, on the other hand, sends a stream to the multicast group address and allows multiple clients to acquire the stream at the same time by requesting a copy from the multicast group address.
VIVOTEK Network > DDNS This section explains how to configure the dynamic domain name service for the Network Camera. DDNS is a service that allows your Network Camera, especially when assigned with a dynamic IP address, to have a fixed host and domain name. Express link Express Link is a free service provided by VIVOTEK server, which allows users to register a domain name for a network device. One URL can only be mapped to one MAC address.
VIVOTEK Manual setup 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. Additionally, we offer other DDNS providers, such as Dyndns.org(Dynamic), Dyndns. org(Custom), TZO.com, DHS.
VIVOTEK [Register] Successfully Your account information has been mailed to registered e-mail address 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. 1. In the DDNS column, select CustomSafe100 from the drop-down list. 2.
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.
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. It gives an indication of how a given packet is to be forwarded, known as the Per Hop Behavior (PHB).
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. ■ The SNMP consists of the following three key components: 1.
VIVOTEK Network > FTP The newer firmware disabled the FTP port for security concerns. You can manually enable the FTP server service to enable the FTP function. You can disable the FTP server function when it is not in use. FTP port: The FTP server allows the user to save recorded video clips. You can utilize VIVOTEK's Shepherd utility to upgrade the firmware via FTP server. By default, the FTP port is set to 21. It can also be assigned to another port number between 1025 and 65535.
VIVOTEK Bonjour To access the camera from a Mac computer, go to Safari, click on Bonjour and select the camera from a drop-down list. You can go to Safari > Preferences to enter your user name and password, and provide the root password the first time you access the camera. The camera main page will open in your browser. Some later iOSes may come without the Bonjour option. Install the Discovery utility instead. Find the Discovery (formerly Bonjour Browser) from the Mac App Store.
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. The administrator can create up to 20 user accounts. To create a new user, 1. Click to unfold the pull-down menu. Select New user. 2.
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 50).
VIVOTEK Security > HTTPS (Hypertext Transfer Protocol over SSL) This section explains how to enable authentication and encrypted communication over SSL (Secure Socket Layer). It helps protect streaming data transmission over the Internet on higher security level. Create and Install Certificate Method Before using HTTPS for communication with the Network Camera, a Certificate must be created first.
VIVOTEK 5. Click Save to preserve your configuration, and your current session with the camera will change to the encrypted connection. 6. If your web session does not automatically change to an encrypted HTTPS session, click Home to return to the main page. Change the URL address from “http://” to “https://“ in the address bar and press Enter on your keyboard. Some Security Alert dialogs will pop up. Click OK or Yes to enable HTTPS. https:// https://192.168.5.151/index.
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. 4. The Certificate request window will prompt. If you see the following Information bar, click OK and click on the Information bar at the top of the page to allow pop-ups.
VIVOTEK 5. Look for a trusted certificate authority, such as Symantec’s VeriSign Authentication Services, that issues digital certificates. Sign in and purchase the SSL certification service. Copy the certificate request from your request prompt and paste it in the CA’s signing request window. Proceed with the rest of the process as CA’s instructions on their webpage. 6. Once completed, your SSL certificate should be delivered to you via an email or other means.
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.
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.
VIVOTEK 11. When the certifice file is successfully loaded, its status will be stated as Active. Note that a certificate must have been created and installed before you can click on the “Save" button for the configuration to take effect. 12.To begin an encrypted HTTPS session, click Home to return to the main page. Change the URL address from “http://” to “https://“ in the address bar and press Enter on your keyboard. Some Security Alert dialogs will pop up. Click OK or Yes to enable HTTPS.
VIVOTEK Security > Access List This section explains how to control access permission by verifying the client PC’s IP address. General Settings Maximum number of concurrent streaming connection(s) limited to: Simultaneous live viewing for 1~10 clients (including stream 1 to stream 3). The default value is 10. If you modify the value and click Save, all current connections will be disconnected and automatically attempt to re-link (IE Explorer or Quick Time Player).
VIVOTEK ■ Refresh: Click this button to refresh all current connections. ■ Add to deny list: You can select entries from the Connection Status list and add them to the Deny List to deny access. Please note that those checked connections will only be disconnected temporarily and will automatically try to re-link again (IE Explore or Quick Time Player). If you want to enable the denied list, please check Enable access list filtering and click Save in the first column.
VIVOTEK There are three types of rules: Single: This rule allows the user to add an IP address to the Allowed/Denied list. For example: 192.168.2.1 Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List. The address and network mask are written in CIDR format. For example: IP address range 192.168.2.x will be bolcked. If IPv6 filter is preferred, you will be prompted by the following window.
VIVOTEK Security > IEEE 802.1X Enable this function if your network environment uses IEEE 802.1x, which is a port-based network access control. The network devices, intermediary switch/access point/hub, and RADIUS server must support and enable 802.1x settings. The 802.1x standard is designed to enhance the security of local area networks, which provides authentication to network devices (clients) attached to a network port (wired or wireless).
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). 2. A Network Camera requests access to the protected LAN using 802.
VIVOTEK Security > Miscellaneous The embedded TrendMicro utitlity provides the protection against Cross-Site Request Forgery. Cross-site request forgery is also known as one-click attack or session riding and is abbreviated as CSRF. CSRF is a type of malicious exploit of a website, in this case, the camera. Unauthorized commands are transmitted from a user that the web application trusts, using the mechanism of forging a trusted user's own request with a request containing his own cookies, etc.
VIVOTEK PTZ > PTZ settings This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation (available in the 3rd, Live, or the last video profile). Digital: Control the e-PTZ operation. Within a field of view,it allows users to quickly move the focus to a target area for close-up viewing without physically moving the camera. Digital PTZ Operation (E-PTZ Operation) The e-PTZ control settings section will be displayed as shown below: 2015/05/20 09:57:30 x1.8 x1.
VIVOTEK Home page in the E-PTZ Mode ■ The e-Preset Positions will also be displayed on the home page. Select one from the drop-down list, and the Network Camera will move to the selected position. ■ If you have set up different preset positions for different streams, you can select one of the video streams to display its separate preset positions. Global View In addition to using the e-PTZ control panel, you can also use the mouse to drag or resize the floating frame to pan/tilt/zoom the viewing region.
VIVOTEK Patrol settings You can select some preset positions for the Network Camera to patrol. Please follow the steps below to set up a patrol schedule: 1. Select the preset locations on the list, and click . 2. The selected preset locations will be displayed on the Patrol locations list. 3. Set the Dwelling time for the preset location during an auto patrol. 4. If you want to delete a preset location from the Patrol locations list, select it and click Remove. 5.
VIVOTEK NOTE: • • The Preset Positions will also be displayed on the Home page. Select one from the Go to menu, and the Network Camera will move to the selected preset position. Click Patrol: The Network Camera will patrol along the selected positions repeatedly.
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.
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. seconds: Enter the duration in seconds to pause ■ Detect next motion detection or digital input after motion detection after a motion is detected. This can prevent event-related actions to take place too frequently. 1.
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. ■ Camera tampering detection This option allows the Network Camera to trigger when the camera detects that is is being tampered with.
VIVOTEK 3. Action Define the actions to be performed by the Network Camera when a trigger is activated. ■ Push notification You can configure VIVOCloud to be receiving different types of camera alarms, such as Motion detection, Audio detection, Tampering, DI, and select the associated actions as recording video or Push notification. Notifications also include device offline and online messages.
VIVOTEK Add server It is necessary to configure the server and media settings so that the Network Camera will know what action to take (such as which server to send the media files to) when a trigger is activated. Click Add server to open the server setting window. You can specify where the notification messages are sent to when a trigger is activated. A total of 5 server settings can be configured. There are four choices of server types available: Email, FTP, HTTP, and Network storage.
VIVOTEK To verify if the email settings are correctly configured, click Test. The result will be shown in a pop-up window. If successful, you will also receive an email indicating the result. Click Save server to enable the settings. Note that after you configure the first event server, the new event server will automatically display on the Server list. If you wish to add other server options, click Add server. Server type - FTP Select to send the media files to an FTP server when a trigger is activated.
VIVOTEK ■ Passive mode Most firewalls do not accept new connections initiated from external requests. If the FTP server supports passive mode, select this option to enable passive mode FTP and allow data transmission to pass through the firewall. The firmware default has the Passive mode checkbox selected. To verify if the FTP settings are correctly configured, click Test. The result will be shown in a pop-up window as shown below. If successful, you will also receive a test.txt file on the FTP server.
VIVOTEK Server type - HTTP Select to send the media files to an HTTP server when a trigger is activated. ■ Server name: Enter a name for the server setting. ■ URL: Enter the URL of the HTTP server. ■ User name: Enter the user name if necessary. ■ Password: Enter the password if necessary. To verify if the HTTP settings are correctly configured, click Test. The result will be shown in a popup window as shown below. If successful, you will receive a test.txt file on the HTTP server.
VIVOTEK Network storage: Select to send the media files to a networked storage when a trigger is activated. Please refer to NAS server on page 149 for details. Note that only one NAS server can be configured. Click Save server to enable the settings. ■ SD Test: Click to test your SD card. The system will display a message indicating the result as a success or a failure. If you want to use your SD card for local storage, please format it before use. Please refer to page 133 for detailed information.
VIVOTEK Click 20210120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2021/01/20 2021/01/20 Click to go back to the previous level of the directory Click to delete selected items Click to delete all recorded data 2021/01/20 2021/01/20 The format is: File name prefix + Minute (mm) You can set up the file name prefix on Add media page. Please refer to next page for detailed information.
VIVOTEK Add media Click Add media 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. Select the item to display the detailed configuration options. You can configure either one or all of them. Media type - Snapshot Select to send snapshots when a trigger is activated.
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_20210513_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings. Note that after you set up the first media server, a new column for media server will automatically display on the Media list. If you wish to add more media options, click Add media.
VIVOTEK ■ Maximum file size Specify the maximum file size allowed. Some users may need to stitch the video clips together when searching and packing up forensic evidence. ■ File name prefix Enter the text that will be appended to the front of the file name. For example: Video_20210513_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings. Media type - System log Select to send a system log when a trigger is activated.
VIVOTEK In the Event settings column, the Servers and Medias you configured will be listed; please make sure the Event -> Status is indicated as ON, in order to enable the event triggering action. When completed, click the Save event button to enable the settings and click Close to exit Event Settings page. The new Event / Server settings / Media will appear in the event drop-down list on the Event setting page.
VIVOTEK Applications > Motion detection This section explains how to configure the Network Camera to enable motion detection. A total of 5 motion detection windows can be configured. Motion Detection Setting 1: For normal situations Follow the steps below to enable motion detection: 1. Click New to add a new motion detection window. 2. In the Window Name text box, enter a name for the motion detection window. ■ Use 4 mouse clicks to designate a detection window.
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 123. A green bar indicates that even though motions have been detected, the event has not been triggered because the image variations still fall under the preset threshold. Larger than the min.
VIVOTEK This motion detection window will also be displayed on the Event Settings page. You can go to Event > Event settings > Trigger to select it as a trigger source. Please refer to page 123 for detailed information. NOTE: ► How does motion detection work? A C Min. item size Alerted pixels < Min. item size B D Min. item size Alerted pixels > Min. item size There are two motion detection parameters: Sensitivity and Min. Item Size.
VIVOTEK Applications > DI and DO Digital input: Select High or Low as the Normal status for the digital input connection. 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. Set up the event source as DI on Event > Event settings > Trigger.
VIVOTEK Applications > Tampering detection This section explains how to set up camera tamper detection. With tamper detection, the camera is capable of detecting incidents such as redirection, blocking or defocusing, or even spray paint. Please follow the steps below to set up the camera tamper detection function: 1. Click to select the checkbox before tampering conditions: Tampering detection, Image too dark, Image too bright, and Image too blurry. Enter the tamper trigger duration. (10 sec. ~ 10 min.).
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. 3. A PTZ camera can be directed to turn to a preset point by the occurrence of audio events. 4.
VIVOTEK Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) The IB9365-HT is the first camera line to come embedded with the Smart Motion Detection feature. The Smart Motion detection, with Human detection and tunable time filter, can eliminate the defects of traditional motion detection and facilitate the configuration at a surveillance site. To learn more about this feature, download its User Guide in: http://download.vivotek.
VIVOTEK To utilize a software module, acquire the software package and click Browse and Upload buttons. The screen message for a successful upload is shown below: To start a module, select the checkcircle in front, and click the Start button. 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. Click on the X button to remove an existing module.
VIVOTEK On the License page, register and activate the license for using VIVOTEK's VADP modules. You should acquire the license key elsewhere, and manually upload to the network camera. Follow the onscreen instruction on VIVOTEK's website for the registration procedure.
VIVOTEK Recording > Recording settings This section explains how to configure the recording settings for the Network Camera. Recording Settings Insert your SD card and click here to test NOTE: ► Please remember to format your SD card via the camera’s web console (in the Local storage . SD card management page) when using it for the first time. Please refer to page 151 for detailed information. Recording Settings Click Add to open the recording setting window.
VIVOTEK If you enable adaptive recording on a camera, only when an event is triggered on Camera A will the server record the full frame rate streaming data; otherwise, it will only request the I frame data during normal monitoring, thus effectively saves bandwidths and storage space. NOTE: ► To enable adaptive recording, please make sure you’ve set up the trigger source such as Motion Detection, DI Device, or Manual Trigger.
VIVOTEK 2. Destination You can select the SD card or networked storage (NAS) for the recorded video files. If you have not configured a NAS server, see details in the following. NAS server Click Add NAS server to open the server setting window and follow the steps below to set up: 1. Fill in the information for your server. For example: 3 Network storage path (\\server name or IP address\folder name) 1 2 4 User name and password for your server 2. Click Test to check the setting.
VIVOTEK If successful, you will receive a test.txt file on the network storage server. 3. Enter a server name. 4. Click Save to complete the settings and click Close to exit the page. ■ Capacity: You can choose either the entire free space available or limit the reserved space. The recording size limit must be larger than the reserved amount for cyclic recording. The reserved space is a small amount of space used only for the transaction stage when the capacity is about to be used up or recycled.
VIVOTEK f you want to enable recording notification, please click Event to configure event triggering settings. Please refer to Event > Event settings on page 123 for more details. When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page. When the system begins recording, it will send the recorded files to the network storage. The new recording name will appear in the drop-down list on the recording page as shown below.
VIVOTEK Storage 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. Camera filesystem takes up several megabytes of memory space. The storage space cannot be used for recording. Using an SD card that already contains data recorded by another device should not be used in this camera. Please do not modify or change the folder names in the SD card.
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. For example, if you enter “7 days”, the recorded files will be stored on the SD card for 7 days. Click Save to enable your settings.
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. Click Mount to complete the settings. NAS management ■ Minimum reserved storage space: The reserved space can be used as a safe buffer especially when the cyclic recording function is enabled, during the transaction stage when a storage space is full and the incoming streaming data is about to overwrite the previously saved videos.
VIVOTEK Storage > Content management This section explains how to manage the content of recorded videos on the Network Camera. Here you can search and view the records and view the searched results. Searching and Viewing the Records This column allows the user to set up search criteria for recorded data. If you do not select any criteria and click Search button, all recorded data will be listed in the Search Results column. ■ File attributes: Select one or more items as your search criteria.
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 ■ Play: Click on a search result which will highlight the selected item. A Play window will appear on top for immediate review of the selected file.
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: C l i c k t o switch pages ■ Remove: Select the desired search results, then click this button to delete the files.
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. The HTTP-based camera interface provides the functionality to request a single image, control camera functions (PTZ, output relay etc.), and get and set internal parameter values.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 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. The CGIs are organized in functionally-related directories under the cgi-bin directory. The file extension .cgi is required.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 4. Security Level SECURITY LEVEL SUB-DIRECTORY DESCRIPTION 0 anonymous Unprotected. 1 [view] viewer Can view, listen, and talk to camera. 4 [operator] operator Operator access rights can modify most of the camera’s parameters except some privileges and network options. 6 [admin] admin Administrator access rights can fully control the camera’s operations. 7 N/A Internal APIs. Unable to be changed by any external interfaces.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 5. Get Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http:///cgi-bin/anonymous/getparam.cgi?[] [&…] http:///cgi-bin/viewer/getparam.cgi?[] [&…] http:///cgi-bin/operator/getparam.cgi?[] [&…] http:///cgi-bin/admin/getparam.
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n 31 User's Manual - 161
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http:///cgi-bin/anonymous/setparam.cgi? = [&=…][&return=] http:///cgi-bin/viewer/setparam.cgi? = [&=…][&return=] http:///cgi-bin/operator/setparam.
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK [] Only the parameters that you set and are readable will be returned. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123 Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n 33 User's Manual - 163
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7. Available Parameters on the Server Valid values: VALID VALUES DESCRIPTION string[] 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. password[] The same as string but displays‘*’ instead. Any single integer number in 32-bits. The range is -2147483648~2147483647.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved VALID VALUES DESCRIPTION The format for resolution. W is the pixel number of width. H is the pixel number of height. Ex: 1920x1080, 2048x1536 available The API is listed in product WebAPIs. non-available The API is not in product WebAPIs. valid The API is listed in product WebAPIs, and is functional. non-valid The API is listed in product WebAPIs, but is malfunction in this status.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 6/6 Indicate timezone and area.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 120: GMT 03:00 Baghdad, Kuwait, Riyadh, Moscow, St.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION time zone. daylight_auto_begintim string[19] 6/7 e daylight_auto_endtime Display the current daylight saving start time. string[19] 6/7 Display the current daylight saving end time. daylight_timezones string 6/6 List time zone index which support daylight saving time.
© 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) VIVOTEK DESCRIPTION settings. This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to default values except for a union of combined results. restoreexceptlang 0, 7/6 Restore the system parameters to default values except the custom language file the user has uploaded.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION cus" != 0. restoreexceptlen 0, 7/6 Restore the system parameters to default values except lens profile. 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. * Only available when "capability_image_c<0~(n-1)>_lensconfig uration_support" != 0.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 0, 0/6 Maximum number of custom languages supported on the server. customlanguage_coun 0, 0/6 Number of custom languages which have been uploaded to the server. customlanguage_i<0~ (maxcount-1)> 0/6 Custom language name.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) onlinenum_httppush 0, onlinenum_sip Current number of HTTP push server connections. 0, eth_i0 mii-tool. vi_i<0~(capability_nvi-1)> 1/7 Virtual input 0 => Inactive 1 => Active (capability_nvi > 0) 7.2.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) normalstate open, 1/1 grounded Indicate open circuit or closed circuit (inactive status) 7.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION Bit 2=> FTP service; Bit 3 => Two way audio and RTSP Streaming service; To stop service before changing its port settings. It’s recommended to set this parameter when change a service port to the port occupied by another service currently. Otherwise, the service may fail. Stopped service will auto-start after changing port settings.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION wins2 6/6 Secondary WINS server. 7.6.1 802.1x Subgroup of network: ieee8021x (capability_protocol_ieee8021x > 0) NAME VALUE SECURITY (get/set) DESCRIPTION enable 6/6 Enable/disable IEEE 802.
VIVOTEK © 2020 VIVOTEK INC.
© 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) port 21, 1025~65535 6/6 Local ftp server port. enable 6/6 Enable ftp. VIVOTEK 7.6.5 HTTP Subgroup of network: http NAME VALUE SECURITY (get/set) DESCRIPTION port 80, 1025 ~ 1/6 HTTP port. 65535 alternateport 1025~65535 6/6 Alternate HTTP port. authmode basic, digest 1/6 HTTP authentication mode.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.6.6 HTTP per Channel Subgroup of network: http_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY (get/set) DESCRIPTION s<0~(capability_nmedia string[32] 1/6 Http server push access name for channel N and stream M, N= 1~ stream-1)>_accessname capability_nvideoin, M= 1~ capability_nmediastream.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION port 554, 1025 ~ 65535 1/6 RTSP port. (capability_protocol_rtsp=1) authmode disable, 1/6 basic, digest s<0~(capability_nmed string[32] RTSP authentication mode. (capability_protocol_rtsp=1) 1/6 RTSP access name for channel and iastream*capability_n videoin)-1)>_accessna stream.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION (channel1stream3) live1s4.sdp = c0_s3_accessname, (channel1stream4) etc. * Values start with prefix “cgi-bin” are prohibited. For example, “c, cg, cgi, cgi-, cgi-b, cgi-bi, cgi-bin” are not allowed. * We modify the value of RTSP access name after version number(httpversion) is 0311c pimssm_enable 7/6 To enable the feature of Protocol Independent Multicast - Source Specific Multicast.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 0304a. audioipaddress address> Multicast audio IP address. * We support this parameter when the version number (httpversion) is equal or greater than 0304a. * Only available when capability_naudioin > 0 metadataipaddres Multicast metadata IP address. * We support this parameter when the version number (httpversion) is equal or greater than 0304a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION metadataport 1025 ~ 65535 6/6 Metadata channel port for RTP. 7.6.12 PPPoE Subgroup of network: pppoe (capability_protocol_pppoe > 0) NAME VALUE SECURITY DESCRIPTION (get/set) user string[128] 6/6 PPPoE account user name. pass password[64] 7/6 PPPoE account password. 7.6.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION enable 6/6 Enable access list filtering. admin_enable 6/6 Enable administrator IP address. admin_ip string[43] 6/6 Administrator IP address. maxconnection 1~ 6/6 Maximum number of (s). 6/6 Ipfilter policy : "capability_protoc ol_maxconnection" type 0, 1 0 => allow 1 => deny ipv4list_i<0~9> Single address:
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION panorama, "auto": Auto white balance manual, rbgain, "panorama": indicates that camera would try to balance the white widerange, balance effect of every sensor. outdoor, indoor, "rbgain": Use rgain and bgain to set white balance manually. sodiumauto, "manual": 2 cases: etc a. if "rbgain" is not supported, this means keep current white balance (Available values status.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 2: EV -1.3 3: EV -1.0 4: EV -0.7 5: EV -0.3 6: EV 0 7: EV +0.3 8: EV +0.7 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.0 * Only available when "capability_image_c<0~(n-1)>_exposu re_mode" !=0 * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION anymore when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c<0~(n-1)>_mode" to switch on/off BLC. color 0, 1 4/4 0 =>monochrome 1 => color * Only available when " capability_videoin_c<0~(n-1)>_color_ support" is 1. * We do not support this parameter when "capability_nvideoin > 1".
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, etc. 1~8000 => 1s ~ 1/8000s 5~8000 => 1/5s ~ 1/8000s etc.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. enablepreview 1/4 Usage for UI of exposure settings. Preview settings of video profile.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION widerange, balance effect of every sensor. outdoor, indoor, "rbgain": Use rgain and bgain to set white balance manually. sodiumauto, "manual": 2 cases: etc a. if "rbgain" is not supported, this means keep current white balance (Available values are listed status. in "capability_image_c<0~(n- b.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION * Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbmo de". * Only valid when "videoin_c<0~(n-1)>_whitebalance" ! = auto * Normalized range. exposurelevel 0~12 4/4 Exposure level "0,12": This range takes the concept from DC's exposure tuning options. The definition is: 0: EV -2.0 1: EV -1.7 2: EV -1.3 3: EV -1.0 4: EV -0.7 5: EV -0.3 6: EV 0 7: EV +0.3 8: EV +0.7 9: EV +1.0 10: EV +1.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION in variable Iris, and keep adjusting Gain "capability_image_c<0~(n1)>_exposure_modetype") 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.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION * Only available when "capability_image_c<0~(n-1)>_iristype "=piris piris_position 1~100 1/4 Manual set P-Iris.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION ngain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". gainvalue 0~100 4/4 Gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_m axgain" != "-" and "capability_image_c<0~(n-1)>_exposu re_rangetype" is "onevalue". * Normalized range.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION 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) * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0309a. text string[64] 1/4 Enclose caption.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". maxexposure <1~32000>, 4/4 Maximum exposure time <5~32000>, <1~8000>, 1~32000 => 1s ~ 1/32000s 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc. * Available value is listed 5~8000 => 1/5s ~ 1/8000s etc.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) 1)>_exposure_maxrange" DESCRIPTION exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s. * Only available when "capability_image_c<0~(n-1)>_exposu re_maxrange" != "-" and "capability_image_c<0~(n-1)>_exposu re_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION the version number (httpversion) is equal or greater than 0302a. bracketing_lev 1~100 4/4 el The total available lists (capability_image_c<0~(n-1)>_ex posure_bracketing_range) will be normalized to 1~100 scale. For example, the total available list is 7. (2x,3x,4x,5x,6x,7x,8x) 1 ~ 14 that correspond with 2x. 15 ~ 30 that correspond with 3x.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) e DESCRIPTION "capability_videoin_c<0~(n-1)>_smart fps_support" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309a. s<0~(m-1)>_h2 4/4 64_dintraperio d_enable Enable "Dynamic intra frame period". * Only available when "capability_videoin_c<0~(n-1)>_dintra period_support" is 1.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) 64_qpercent DESCRIPTION normalized full range. 1: Worst quality 100: Best quality * Only valid when "h264_ratecontrolmode"= vbr and "quant"= 100. s<0~(m-1)>_h2 20000~"capability_videoin 64_maxvbrbitr ate 4/4 _c<0~(n-1)>_h264_maxbit rate" The maximum allowed bit rate in fixed quality mode. When the bit rate exceeds this value, frames will be dropped to restrict the bit rate.
VIVOTEK © 2020 VIVOTEK INC.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION 65_ratecontrol vbr: Fixed quality mode, all frames are mode encoded in the same quality. * Only available when h265 is listed in "capability_videoin_codec".
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE ate rate" SECURITY( get/set) DESCRIPTION When the bit rate exceeds this value, frames will be dropped to restrict the bit rate. * Only available when h265 is listed in "capability_videoin_codec".
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION 65_prioritypoli * Only available when h265 is listed in cy "capability_videoin_codec".
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION 5: Excellent 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue" s<0~(m-1)>_mj 10~200 peg_qvalue 4/4 Manual video quality level input. The (Only valid when "capability_api_httpversio Q value which is used by encoded library directly.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only valid when "mjpeg_ratecontrolmode"= cbr. s<0~(m-1)>_mj 1~100 4/4 peg_cbr_qperc ent Select customized quality in a normalized full range. 1: Worst quality 100: Best quality * Only valid when "mjpeg_ratecontrolmode"= cbr and "quant"= 100.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION wdrpro_mode 0, 1, 2 4/4 0: Disable WDR Pro. 1: Enable WDR Pro. * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode" = 1 2: Enable WDR Pro II. * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode" = 2 wdrpro_streng 1~100 4/4 The strength of WDR Pro. th
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY( get/set) DESCRIPTION 81~100: level 5 Level 1~4(low ~ high) The higher speed level meas shorter AE converged time during AE executing. * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1 aespeed_sensi 1~100 4/4 The sensitivity of AE converge speed.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY( get/set) DESCRIPTION s<0~(m-2)>_fis ‘1O, 1P, 2P, 1R, 4R’ for 1/4 Local dewarp mode. heyedewarpm ode ceiling/floor mount ‘1O, 1P, 1R, 4R’ for wall “1O” is original mode (disable). Supported dewarp mode is different
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION display image. If the value is a positive number, the video quality of ROI is better than the non-ROI areas. The level is from 1 to 5. Level 5 is the maximum level of the quality difference between the ROI and non-ROI areas. If the value is a negative number, the video quality of non-ROI areas is better than the ROI. The level is from -1 to -5.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION enable 4/4 Enable/disable this profile setting policy night, 4/4 The mode which the profile is applied schedule to. * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a. * "policy=night" is only available when "capability_daynight_c<0~(n-1)>_sup port > 0". begintime hh:mm 4/4 Begin time of schedule mode.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION "capability_image_c<0~(n- sensor generates a frame per 1)>_exposure_maxrange" 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.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION anymore when the version number (httpversion) is equal or greater than 0301a. * It's recommanded to use "exposurewin_c_mode" to switch on/off BLC. exposurelevel 0~12 4/4 Exposure level "0,12": This range takes the concept from DC's exposure tuning options. The definition is: 0: EV -2.0 1: EV -1.7 2: EV -1.3 3: EV -1.0 4: EV -0.7 5: EV -0.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION "capability_image_c<0~(n- and Shutter speed automatically. 1)>_exposure_modetype") "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.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "capability_image_c<0~(n-1)>_wbmo de" !="-" rgain 0~100 4/4 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)>_wbmo de". * Only valid when "videoin_c<0~(n-1)>_whitebalance" ! = auto * Normalized range. bgain 0~100 4/4 Manual set bgain value of gain control setting.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION mingain 0~100 4/4 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_mi ngain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposu re_rangetype" is "twovalues". gainvalue 0~100 4/4 Gain value.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION or flicker effect in indoor environment. "indoor": Avoid rolling and flicker effect first. "manual": Manual set P-Iris by "piris_position". "-": not support (only available when "capability_image_c<0~(n-1)>_sensor type" is "smartsensor") * Only available when "capability_image_c<0~(n-1)>_iristype "=piris piris_position Manual set P-Iris.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION _mode" = 1 2: Enable WDR Pro II. * Only valid when "capability_image_c<0~(n-1)>_wdrpro _mode" = 2 wdrpro_streng 1~100 4/4 The strength of WDR Pro. th * Only available when "capability_image_c<0~(n-1)>_wdrpro _strength" is 1 wdrc_mode 4/4 dependent> wdrc_strength Enable WDR enhanced.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION executing. * Only available when "capability_image_c<0~(n-1)>_aespee d" is 1 aespeed_sensi 1~100 4/4 The sensitivity of AE converge speed. tivity 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.
VIVOTEK ttl © 2020 VIVOTEK INC. All Right Reserved 1 ~ 255 4/4 Multicast video time to live value. 7.9 Time Shift Settings Group: timeshift for n channel products and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" (capability_timeshift > 0) NAME VALUE SECURITY (get/set) DESCRIPTION enable 4/4 Enable time shift streaming.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE night, di, “ircutcontrol_c0_mode” when the version number (httpversion) is equal schedule…etc or greater than 0312a. * Available values are listed in * We do not support this parameter when "capability_nvideoin > 1".
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) use this> DESCRIPTION dtime” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION enablewled 6/6 Enable/disable built-in White led nvideoin"-1>_builtinwled > 0". * We replace this parameter with "ircutcontrol_illuminators_builtin_whi teled_enabled" when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin > 1".
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION ensitivity_type=normalize * Only available when "capability_daynight_c<0~(n-1)> _ircutsensitivity_type" is not "-". * We replace this parameter with ircutcontrol_c<0~(n-1)>_sensitivity” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin > 1".
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved (get/set) mode auto, 6/6 Set IR cut control mode day, night, * We support this parameter when the version number (httpversion) is di, equal or greater than 0312a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved There are two value format: "low,normal,high": if capability_daynight_c<0~(n-1)>_ircuts ensitivity_type=options "1~100": if capability_daynight_c<0~(n-1)>_ircuts ensitivity_type=normalize * Only available when "capability_daynight_c<0~(n-1)> _ircutsensitivity_type" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0312a. 7.10.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved * We support this parameter when the version number (httpversion) is equal or greater than 0312a. external_do_enabled 1/6 Enable/disable external led mounted on do1 * Only available when "capability_daynight_illuminators_ext ernal_support > 0" and "do" is listed in "capability_daynight_illuminators_ext ernal_interface". * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved _spectrum_mode" . 7.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION tting" is 1. * We replace "saturation" with "saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. sharpness -3~3,100 4/4 3: Sharper 100: Use " image_c<0~(n-1)>_sharpnesspercent" * Only available when bit 3 of use this> "capability_image_c<0~(n-1)>_basicse tting" is 1.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION sharpnesspercent 0~100 4/4 Set sharpness in the normalized range. 0: Softer <-> 100: Sharper * Only available when bit 3 of "capability_image_c<0~(n-1)>_basicse tting" is 1 gammacurve 0~100 4/4 0: Fine-turned gamma curve by Vivotek. 1: Gamma value = 0.01 2: Gamma value = 0.02 3: Gamma value = 0.03 ...
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION dnr_strength 1~100 4/4 Strength of 3DNR * Only available when "capability_image_c<0~(n-1)>_dnr" is 1 defog_mode 4/4 Enable/disable defog mode.
VIVOTEK © 2020 VIVOTEK INC.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * Only available when "capability_image_c<0~(n-1)>_deinter lace_support" is 1. xoffset 0~100 4/4 Adjusting the image to proper position horizontally. * Only available when the bit 4 of capability_image_c<0~(n-1)>_basicset ting is 1. yoffset 0~100 4/4 Adjusting the image to proper position vertically. * Only available when the bit 5 of capability_image_c<0~(n-1)>_basicset ting is 1.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION (httpversion) is equal or greater than 0301a. * "policy=night" is only available when "capability_daynight_c<0~(n-1)>_sup port > 0". profile_i<0~(m-1)> hh:mm 4/4 Begin time of schedule mode. hh:mm 4/4 End time of schedule mode.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION _saturation saturation _saturationpercent" use this> * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicse tting" is 1. * We replace "profile_i0_saturation" with "profile_i0_saturationpercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * Only available when bit 1 of "capability_image_c<0~(n-1)>_basicse tting" is 1 profile_i<0~(m-1)> 0~100 4/4 _saturationpercent Set saturation in the normalized range. 0: Less saturation <-> 100: More saturation * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicse tting" is 1. profile_i<0~(m-1)> 0~100 4/4 _sharpnesspercent Set sharpness in the normalized range.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION profile_i<0~(m-1)> 4/4 Enable/disable hightlight mask. _hlm _hlm" is dependent> 1 profile_i<0~(m-1)> 4/4 3D noise reduction.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * Only available when 'dis' is listed in "capability_image_c<0~(n-1)>_is_mod e". profile_i<0~(m-1)> 1~100 4/4 Strength of digital image stabilizer _dis_strength _is_mod dependent> e". 7.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1 and when custom is listed in "capability_image_c<0~(n-1)>_exposure_winmode" and valid when "exposurewin_c<0~(n-1)>_mode"=custom or "exposurewin_c<0~(n-1)>_mode"=hlc) NAME VALUE SECURITY (get/set) DESCRIPTION enable 4/4 Enable or disable the window. policy 0~1 4/4 0: Indicate exclusive. 1: Indicate inclusive.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION * Only available when std is listed in "capability_image_c<0~(n-1)>_exposu re_windomain". sizestd <0~9999x0~9999> 4/4 Width and height of the window. * Only available when std is listed in "capability_image_c<0~(n-1)>_exposu re_windomain".
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1 and when custom is listed in "capability_image_c<0~(n-1)>_exposure_winmode" and valid when "exposurewin_c<0~(n-1)>_mode"=custom or "exposurewin_c<0~(n-1)>_mode"=hlc) NAME VALUE SECURITY (get/set) DESCRIPTION enable 4/4 Enable or disable the window. policy 0~1 4/4 0: Indicate exclusive. 1: Indicate inclusive.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION homestd <0~9999,0~9999> 4/4 Left-top corner coordinate of the window. * Only available when std is listed in "capability_image_c<0~(n-1)>_exposu re_windomain". sizestd <0~9999x0~9999> 4/4 Width and height of the window. * Only available when std is listed in "capability_image_c<0~(n-1)>_exposu re_windomain". 7.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 0: Minimum 100: Maximum * Only available when the channel supports internal microphone (The related bit of "capability_audio_intmic" is equal to 1). volume_external 0~100 4/4 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).
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION * Reserved for compatibility, and suggest don't use this since the version number (httpversion) is equal or greater than 0301a. * We replace "boostmic" with "volume_internal" and "volume_external". More details, please refer the parameter description of "volume_internal" and "volume_external".
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 4/4 Set G.726 bit streaming packing 32000, 40000 s0_g726_bitstreamp little, big ackingmode mode. little: Little-endian bitstream format. big: Big-endian bitstream format. * Only available if G.726 is supported. s0_g726_vlcmode 0, 1 4/4 Enable vlcmode for G.726. 0: Standard mode. 1: Solve compatibility problem with VLC player. * Only available if G.726 is supported.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.13.1. Multicast Settings for Audio Streaming Group: audioin_c<0~(n-1)>_s0_multicast (capability_naudioin > 0 and capability_media_streamprofiles_support = 1) n denotes the value of "capability_naudioin" NAME VALUE SECURITY( get/set) DESCRIPTION ipaddress 4/4 Multicast audio IP address. port 1025 ~ 65535 4/4 Multicast audio port. ipversion IPv4, IPv6 4/4 The version of internet protocol.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION record. 7.16 Motion Detection Settings Group: motion_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable 4/4 Enable motion detection. win_sensitivity 0 ~ 100 4/4 Sensitivity of all motion detection windows.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) the version number (httpversion) is equal or greater than 0400a. polygonpx 0 ~ W,0 ~ H, 0 ~ W,0 4/4 Coordinate of polygon window ~ H, 0 ~ W,0 ~ H, 0 ~ W,0 ~ H position. (4 points: x0,y0,x1,y1,x2,y2,x3,y3) W: 0~ The current * Only available when image width -1 H: 0~ The current "capability_motion_wintype" = polygon.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) top 0 ~ 240 4/4 Top coordinate of window position. * Only available when "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.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable 4/4 Enable profile 1 ~ (m-1). policy night, 4/4 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. * "policy=night" is only available when "capability_daynight_c<0~(n-1)>_support > 0". begintime hh:mm 4/4 Begin time of schedule mode. endtime hh:mm 4/4 End time of schedule mode.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) to use this> "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 ~ 4/4 Coordinate of polygon window position. W,0 ~ H, 0 ~ W,0 ~ H, 0 ~ W,0 ~ H (4 points: x0,y0,x1,y1,x2,y2,x3,y3) * Only available when W: 0~ The current "capability_motion_wintype" = polygon.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) to use this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. width 0 ~ 320 4/4 Width of motion detection window. * Only available when "capability_motion_wintype" = rectangle.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION threshold 0~100 4/4 Threshold of tamper detection. duration 10~600 4/4 If tampering value exceeds the "threshold" for more than "duration" second(s), then tamper detection is triggered. ignorewidth 0, dark_enable Indicate the width to offset to start to analysis the image.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION enable 6/6 Enable or disable the dynamic DNS. provider DyndnsDynamic, 6/6 DyndnsDynamic => dyndns.org DyndnsCustom, Safe100 (dynamic) DyndnsCustom => dyndns.org Safe100 => safe100.net _hostnam string[128] 6/6 Your DDNS hostname.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable or disable the UPnP port forwarding service. upnpnatstatus 0~3 6/7 The status of UPnP port forwarding, used internally. 0 = OK, 1 = FAIL, 2 = no IGD router, 3 = no need for port forwarding 7.22 System Log Group: syslog NAME VALUE SECURITY DESCRIPTION (get/set) enableremotelog 6/6 Enable remote log. serverip 6/6 Log server IP address.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION v2 6/6 SNMP v2 enabled. 0 for disable, 1 for enable v3 6/6 SNMP v3 enabled.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE custombutton_manualtr SECURITY (get/set) DESCRIPTION 1/6 Show or hide manual trigger (VI) igger_show button in homepage 0 -> Hidden 1 -> Visible theme_option 1~4 1/6 1~3: One of the default themes. 4: Custom definition. theme_color_font string[7] 1/6 Font color theme_color_configfont string[7] 1/6 Font color of configuration area. theme_color_titlefont string[7] 1/6 Font color of video title.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION equal or greater than 0314b. defaultpassword_length 8 ~ 64 6/7 Allowed password length. * We support this parameter when the version number (httpversion) is equal or greater than 0314b.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.25 Privacy Mask Group: privacymask_c<0~(n-1)> for n channel products and m privacy mask window. n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY (get/set) DESCRIPTION enable 4/4 Enable privacy mask. win_i<0~(m-1)>_enable 4/4 Enable privacy mask window. win_i<0~(m-1)>_name string[14] 4/4 Name of the privacy mask window.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 0 ~ W,0 ~ H, (4 points: x0,y0,x1,y1,x2,y2,x3,y3) 0 ~ W,0 ~ H W: 0~ The * Only available when "capability_image_c<0~(n-1)>_privacy current image mask_wintype" = polygon. width -1 H: 0~ The current * Only available when px is listed in "capability_image_c<0~(n-1)>_privacy image height -1 mask_windomain".
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION buildinpt" is "1" win_i<0~(m-1)>_tilt "capability_ptz_c<0~(n-1) 4/4 >_mintilt" ~ "capability_ptz_c<0~(n-1) win_i<0~(m-1)>_zoom Tilt position of window position. * Only available when bit1 of >_maxtilt" "capability_camctrl_c<0~(n-1)>_ buildinpt" is "1" "capability_ptz_c<0~(n-1) 4/4 Zoom position of window >_minzoom" ~ "capability_ptz_c<0~(n-1) position.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION interfaces. Revision Increase the revision when fix bugs without change any features of the output. _platform This is a constant, it is used to distinguish between different platforms API version format: MMmmr_k Where "MM" is the major version, "mm" is the minor version and "r" is the revision. 'M' and 'm' and 'k' are decimal digit from 0 to 9, while 'r' is an alphabetic.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION nvideoin"-1>_externalir for external IR) * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. npir 0, 0/7 Number of PIRs. 0/7 Number of digital inputs. 0/7 Number of virtual inputs (manual ndi 0, nvi 0, trigger) ndo 0, 0/7 Number of digital outputs.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION nmotion 0/7 The number of motion window. nmotionprofile 0, 0/7 Number of motion profiles. nevent 0, 0/7 Number of event. * We support this parameter when the version number (httpversion) is equal or greater than 0311c. nrecording 0, 0/7 Number of recording.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION server series) Bit 6 => (only available when bit0 is 1) Reserved bit; always 0. Bit 7 => (only available when bit0 is 1) External or built-in PT; 0(built-in), 1(external) windowless 0/7 Indicate whether to support windowless plug-in. evctrlchannel 0/7 Indicate whether to support HTTP tunnel for event/control transfer.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE presettourdirection SECURITY (get/set) DESCRIPTION 0/7 Indicate whether to support preset tour direction function. It means users can choose which direction the preset tour goes. * We support this parameter when the version number (httpversion) is equal or greater than 0307a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION channel. For some dual-stream products, both streams support ePTZ. nanystream 0, 0/7 number of any media stream per channel iva 0/7 Indicate whether to support Intelligent Video analysis whitelight 0/7 Indicate whether to support white
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "tampering" = Tamper detection. "vi" = Virtual input (Manual trigger) "vadp" = VADP trigger. "di"= Digital input. "volalarm" = Audio detection. "temperature" = Temperature detection. "pir" = PIR detection. "visignal" = Video input signal loss. "backup" = Backing up recorded files. "smartsd" = Lifetime detection of SD card. "shockalarm" = Shock detection. "virestore" = Video input signal restore.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION protocol_rtp_multi 0/7 Indicate whether to support scalable cast_scalable protocol_rtp_multi multicast. 0/7 cast_backchannel protocol_rtp_tcp Indicate whether to support backchannel multicast. 0/7 Indicate whether to support RTP over TCP. protocol_rtp_http 0/7 Indicate whether to support RTP over HTTP.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 1 => Progressive CCD 2 => CMOS videoin_nresolutio 0/7 n videoin_resolution This equals "capability_videoin_c0_nresolution". * This is kept for compatibility. A list of 0/7 This equals "capability_videoin_c0_resolution". * This is kept for compatibility. videoin_maxframer A list of 0/7 ate This equals "capability_videoin_c0_maxframerate ".
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 0/7 Indicate whether to support time shift by commas timeshift caching stream. audio_aec 0/7 Indicate whether to support acoustic echo cancellation. audio_aecmode auto, 0/7 manual Indicate the acoustic echo cancellation control mode. "auto": control by camera automatically. "manual": Manually turn on/off the control mode.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION - (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. "Description" can be a nonnegative integer or string or NULL.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 0: Not support 1: Support Bit 0 for CH0, bit 1 for CH1, and so on. audio_alarm <0~Positive Integer> 0/7 0: Not support audio alarm. 1: Support audio alarm. Bit 0 for CH0, bit 1 for CH1, and so on. audio_linein 0/7 Indicate whether to support external line input. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "g726": G.726 "-": Not supported. audioout_codec g711, - 0/7 "-": Not supported. motion_wintype rectangle, polygon,- Available codec list for SIP. 0/7 The supported motion window type. "polygon": The window is a 2D polygon shape. "rectangle": The window is a 2D rectangle shape. "-": Not supported. motion_windomai qvga, px, std, - 0/7 n The domain to set an motion window.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) e_autotracking DESCRIPTION stream is supported. * Only available when "capability_smartstream_support" is 1 smartstream_mod 0/7 e_manual Indicate whether manual smart stream is supported. * Only available when "capability_smartstream_support" is 1 smartstream_mod 0/7 e_hybrid Indicate whether hybrid(autotracking+ manual) smart stream is supported.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION Bit 7 => Support digital signature of package Bit 8 => Support snapshot Bit 9 => Support upload encrypted package vadp_npackage 0/7 Indicate the maximum number of VADP package that can be uploaded to the device. camctrl_httptunnel
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION tunnel for UART transfer. transmission_mod Tx, 0/7 Indicate transmission mode of the e Rx, Both network_wire 0/7 Indicate whether to support Ethernet. network_wireless 0/7 Indicate whether to support wireless. network_dualmod 0/7 Indicate whether network dual mode machine: TX = server, Rx = receiver box, Both = DVR. e is supported.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION equal or greater than 0305a. wireless_apmode_ 0/7 ssidprefix 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.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION media_videoclip_ 0/7 Maximum length (second) of a maxlength media_videoclip_ videoclip. 0/7 maxpreevent Maximum duration (second) after event occurred in a videoclip. media_streamprofi les_support 0/7 Indicates support of stream profile feature. * We support this parameter when the version number (httpversion) is equal or greater than 0313a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION localstorage_mana 0/7 Indicate whether manageable local geable storage is supported. * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_seaml 0, ess 0/7 Indicate whether seamless recording is supported. One bit represents one channel. Ex: “3” means channel 0 and channel1 support seamless recording .
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION than 0, it means that the camera supports edge recording function. bit 0 : It supports to record directly to an on-board SD-Card. bit 1~: Currently, they are reserved bit, and the default value is 0. * Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1. localstorage_slcon 0, 0/7 num The maximum seamless connection number for each channel.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * Only available when "capability_fisheye" > 0 shockalarm_suppo 0/7 rt Indicate whether to support the shock detection. * We support this parameter when the version number (httpversion) is equal or greater than 0306e. layout_redirection 0/7 Indicate which function will be redirected to the vadp package path. "-": Not supported.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION the version number (httpversion) is equal or greater than 0314b. 7.27.1 Capability for Camctrl Group: capability_camctrl_c<0~(n-1)> n denotes the value of "capability_nvideoin" (capability_ptzenabled > 0) * We support this group when the version number (httpversion) is equal or greater than 0303b.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION zoommodule 0/7 Indicate whether to support zoom lens. In our product, only SD series and IZ series use the zoom lens. * Both varifocal and zoom lenses are built with movable elements that permit changing the effective focal length. And the key difference between a varifocal and a zoom lens can be explained by thinking about a lens that has been focused on an object at any focal length.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.27.2 Capability for PTZ Group: capability_ptz_c<0~(n-1)> n denotes the value of "capability_nvideoin" (capability_ptzenabled > 0 and capability_camctrl_c<0~(n-1)>_zoommodule !=0) * We support this group when the version number (httpversion) is equal or greater than 0303b. PARAMETER VALUE SECURITY (get/set) panspeedlv 0, 0/7 DESCRIPTION The maximum speed level of pan motion.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) maxtilt 0, 0/7 DESCRIPTION The upper limit for tilt position. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" mintiltangle 0/7 The lower limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1" maxtiltangle 0/7 The upper limit for tilt angle.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) minfocus 0, 0/7 DESCRIPTION The lower limit for focus position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoomm odule" is "1" maxfocus 0, 0/7 The upper limit for focus position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoomm odule" is "1" 7.27.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) externalir 0/7 Indicate whether to support external IR led. * We replaced this parameter with “capability_daynight_illuminators_exter nal_support” when the version number (httpversion) is equal or greater than 0312a. optimizedir 0/7 Indicate whether to support optimized IR control technology.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) ircutsensitivity_type 0/7 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)>_suppo rt" is 1.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) spectrum_support 0/7 Indicate whether to support proposed a brightness enhancement method based on CCM(Color Correction Matrix) model to improve the brightness effect of the images if the IR and blue light exists.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) mode auto,daynight,di,di2, 0/7 Indicate the day / night switch mode. di3,di4,schedule, the level of ambient light detected. "daynight": support day mode and night mode. In day mode, the camera streams color video. In night mode, the camera streams black and white video in low light environments.
VIVOTEK optimizedir © 2020 VIVOTEK INC. All Right Reserved 0/7 Indicate whether to support optimized IR control technology. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. builtin_support 0/7 Indicate whether to support built-in led. * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved spectrum_support 0/7 Indicate whether to support proposed a brightness enhancement method based on CCM(Color Correction Matrix) model to improve the brightness effect of the images if the IR and blue light exists. * Only available when "capability_daynight_c<0~(n-1)>_support" is 1 * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
VIVOTEK device © 2020 VIVOTEK INC. All Right Reserved sd, nas 0/7 Indicate the supported storage devices. * Only available when "capability_storage_dbenabled" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. * Note: If “nas” storage is supported, the media storage path format is “\\date\hour”. “\date\hour” format is “\YYYYMMDD\hh”. modnum 0, 0/7 The maximum MOD connection numbers.
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK PARAMETER VALUE SECURITY (get/set) DESCRIPTION color_support 0/7 1 : camera can select to display color or black/white video streams. 0: camera do not support this feature. * We support this parameter when the version number (httpversion) is equal or greater than 0310a. eptz_zoomratio 0/7 Indicate the support zoom ratio of eptz.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION rotationaffect - 0/7 When rotation is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here. The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION rotationangle 0/7 The different angles which camera supports for rotation. * Only avaliable when "capability_videoin_c<0~(n-1)>_rotation" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0309b. orientation streamcodec flip,mirror,rotatio 0/7 Indicates the camera supports flip, mirror or n
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION resolution A list of 0/7 Resolution options in current video mode. These options are the possible options for "videoin_c_s_resolution". The last one is the maximum resolution in current mode. maxresolution A list of 0/7 Represent supported maximum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream".
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) mjpeg_maxframerate A list of and "-" DESCRIPTION Maximum fps that the device can encoded with MJPEG on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group. * This parameter may be changed when "videoin_c_cmosfreq"=50 or "videoin_c_modulation"=pal.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) h264_maxbitrate 0/7 DESCRIPTION Maximum bitrates of H.264. The unit is bps. * Only available when 'h264' is listed in "capability_videoin_codec". h264_profile baseline,main,hig 0/7 Indicate H264 profiles h * Only available when 'h264' is listed in "capability_videoin_codec". * We support this parameter when the version number (httpversion) is equal or greater than 0309a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE fisheye_mounttype ceiling, wall, floor 0/7
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION cameraunit_name CU8131, 0/7 A "camera unit" name of a split-type camera system, which the camera unit and the CU8171, CU8161-H, video core are separated. -: If the camera is not a split-type camera CU8162-H, system, the value of this parameter is "-". CU8163-H, CU8361-H, * We support this parameter when the version number (httpversion) is equal or ..., greater than 0302b.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) typewallmount 1O, 1P, 1R, 4R 0/7 Available dewarp types of wall mount. resolutionC1P A list of 0/7 Available resolutions of 1P mode of ceiling and floor mount. resolutionC2P A list of 0/7 Available resolutions of 2P mode of ceiling and floor mount. resolutionC1R A list of 0/7 Available resolutions of 1R mode of ceiling and floor mount.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) eptz 0, 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. 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.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) outputsize 0/7 The output size of source, equal to the captured size by device, in this video mode. The unit is pixel. This value is used as a basic coordinate system for many features, like ePTZ, privacy mask, motion, etc. * Source (most for image sensor) may perform scale or binning, etc on image data, and output data with smaller size. This parameter is designed to represent this.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) minresolution A list of 0/7 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. maxframerate A list of Indicates frame rate that the video source outputs in this video mode.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) maxfps_h264 A list of and "-" Maximum fps which the device can encoded with H.264 on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION Bit 0 => Supports Brightness or not. Bit 1 => Supports Contrast or not. Bit 2 => Supports Saturation or not. Bit 3 => Supports Sharpness or not. Bit 4 => Supports adjusting the image to proper position horizontally or not. Bit 5 => Supports adjusting the image to proper position vertically or not.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE :fixed:auto, exposurelevel:hidd en:, exposurelevel:fixed :, exposurelevel:fixed :/, exposuremode:fixe d:auto, gammacurve:disabl ed:, exposurewin.mode .blc:hidden:, exposurewin.mode .hlc:hidden:, exposuretime:hidd en:, gaincontrol:hidden: , flickerless:unchang ed:, wdrc:enabled:, wdrc:enabled:only once, wdrc:unchanged:, : nonnegative integer SECURITY (get/set) DESCRIPTION be forced to a given value.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * When "wdrpro"=0, this value must be "-" wdrpro_description 0/7 Description about WDR Pro mode. * Only available when "capability_image_c<0~(n-1)>_wdrpro _mode" > 0 wdrc_mode 0, 1 0/7 0: Non-support WDR Enhanced 1: Support WDR Enhanced wdrc_supportlevel 0, 0/7 Indicate the support strength level of WDR Enhanced.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. For example: "exposurelevel:fixed:6/8/12" which means exposurelevel is fixed to level 6, level 8 and level 12. "-" means no feature is affected.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) DESCRIPTION "-": not support * We support this parameter when the version number (httpversion) is equal or greater than 0302a. is_strength 0/7 0: Non-support tuning strength of image stabilizer mode. 1: Support tuning strength of image stabilizer mode. * Only available when "capability_image_c<0~(n-1)>_is_mod e" is not "-".
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc: disabled:" which means blc exposure window is disabled.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION wbmode auto, panorama, manual, rbgain, widerange, outdoor,indoor, sodiumauto, 0/7 Available white balance mode. "-" means white balance is not supported. iristype piris, dciris, - 0/7 Indicate iris type. "piris": P-Iris "dciris": DC-Iris "-": No Iris control support * Note: For some cameras, this value may be varied depending on mounted lens.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION constant value. "twovalues": Need two parameters to indicate the exposure range. * 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 0302a. exposure_shuttervalu etype fixed, maximum, - 0/7 * One to one mapping to the mode type in "exposure_modetype".
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "capability_image_c<0~(n-1)>_ exposure_mode" is 1 and "capability_image_c<0~(n-1)>_exposu re_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_automode_ affect 316 - User's Manual -, exposurewin.mode .
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when auto is listed in "capability_image_c<0~(n-1)>_ exposure_modetype" and "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "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.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL.
VIVOTEK NAME © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) dependent> exposure_manualmod -, e_affect exposurewin.mode .blc:hidden:, defog:disabled:, wdrpro:disabled:, exposurelevel:hidd 320 - User's Manual DESCRIPTION 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. - (notsupport) : the affected function is not available.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) en:, icrmode.auto:nots upport: or others : nonnegative integer exposure_levelrange -, DESCRIPTION name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) "0,12" DESCRIPTION "videoin_c<0~(n-1)>_exposurelevel" * When "exposure_mode"=0, this value must be set to "-". * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_winmode auto, custom, blc, hlc, center, 0/7 Available options for "exposurewin_c<0~(n-1)>_mode" * "-" means group: exposurewin is not supported. * When exposure_mode="0", this value must be set to "-".
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION window is omitted by exposure control. "-": Not supported. * Only available when "capability_image_c<0~(n-1)>_ exposure_mode" is 1. exposure_windomain qvga, px, std, - 0/7 The domain to set an exposure 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.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0301a. exposure_maxrange "1,32000", "1,8000", -, or others 0/7 Available range for "videoin_c_maxexposure" "1,32000" => 1s ~ 1/32000s "1,8000" => 1s ~ 1/8000s etc. "-" means maximum exposure time is not available.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION two or more exposures but with different exposure values. * 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 0310a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) "-" DESCRIPTION "videoin_c_maxgain" “0,100” => 0~100 percent "-" means "videoin_c_maxgain" is not available. agc_mingain "0,100", "-" 0/7 Available range for "videoin_c_mingain" “0,100” => 0~100 percent "-" means "videoin_c_mingain" is not available. flickerless 0,1 0/7 0: Non-support flickerless 1: Support flickerless flickerlessaffect -, minexposure.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 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" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 1: Support low light mode focusassist 0,1 0/7 0: Non-support focus assist 1: Support focus assist remotefocus 0, 0/7 An 4-bit integer, which indicates the supportive application of remotefocus in this channel. If the value of this parameter is larger than 0, it means that the camera supports remotefocus function in this channel.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION * We support this parameter when the version number (httpversion) is equal or greater than 0302a. autotrack_support 0/7 0: Non-support auto tracking feature 1: Support auto tracking feature * We support this parameter when the version number (httpversion) is equal or greater than 0302a. smartsensor_iristotalr ange A list of iris value 0/7 Available total step for iris value.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION "capability_image_c<0~(n-1)>_lens_al ignment" is 1. lens_ldc_support 0/7 Indicate whether to support lens distortion correction function. * We support this parameter when the version number (httpversion) is equal or greater than 0309d. palette_support 0/7 Indicate support color palettes or not.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.28 Event Setting Group: event_i<0~(n-1)> n denotes the value of "capability_nevent" (capability_nevent > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] 6/6 Identification of this entry. enable 0, 1 6/6 Enable or disable this event. priority 0, 1, 2 6/6 Indicate the priority of this event: “0”= low priority “1”= normal priority “2”= high priority delay 1~999 6/6 Delay in seconds before detecting the next event.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) di 0, Indicate the source id of di trigger. This field is required when trigger condition is “di”. One bit represents one digital input. The LSB indicates DI 0. * Only available when "capability_ndi" > 0 mdwin 0, Indicate the source window id of motion detection. This field is required when trigger condition is “md”. One bit represents one window.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) valevel0 0,1 6/6 Select audio detection profile event. 0: not select 1: select inter 1~999 6/6 Interval of snapshots in minutes. This field is used when trigger condition is “seq”. weekday 0~127 6/6 Indicate which weekday is scheduled. One bit represents one weekday.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_cf_folder string[128] 6/6 foldername Path to store media. * Only available when "capability_supportsd" > 0 string[128] 6/6 Path to store media. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. action_cf_media NULL, 0~4,101 6/6 Index of the attached media.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) action_goto_sync 6/6 Capture media after moving to the location. * Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0, or capability_camctrl_c0_zoommodule > 0 action_autotrack_enable 6/6 Enable/disable auto tracking on event triggerd.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.29 Server Setting for Event Action Group: server_i<0~4> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] 6/6 Identification of this entry type email, 6/6 Indicate the server type: ftp, http, “email” = email server “ftp” = FTP server ns, “http” = HTTP server sftp “ns” = network storage “sftp” = secure FTP * “sftp” is only available when bit 1 of “capability_protocol_ftp_client” is 1.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) ns_location string[128] 6/6 Location to upload or store the media. * For httpversion is equal or greater than 0312a: The media storage path format is “\\date\hour”. (Only available when “nas” is included in “capability_storage_management_device”) * For httpversion smaller than 0312a: The media storage format is “\date\hour”. * Note: “\date\hour” format is “\YYYYMMDD\hh”.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved fingerprint_enable boolean 6/6 Verify server fingerprint to avoid connect to fake server. fingerprint_content string[128] 6/6 Server fingerprint(MD5). You can get it by calculate server host key(public) md5. publickey_pairmode auto, 6/6 "autopair": Autopair mode is selected download, upload for this event server. "downloadkey": Download key pair mode is selected for this event server.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) snapshot_channel 0~"capability_nvideoin"-1 6/6 Indicate the source of media channel. 0 means the first channel. 1 means the second channel. 2 means the third channel. 3 means the fourth channel. * We support this parameter when the version number (httpversion) is equal or greater than 0311c. snapshot_source 0~"capability_nmediastream 6/6 Indicate the source of media "-1 stream.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) videoclip_channel 0~"capability_nvideoin"-1 6/6 Indicate the source of media channel. 0 means the first channel. 1 means the second channel. 2 means the third channel. 3 means the fourth channel. * We support this parameter when the version number (httpversion) is equal or greater than 0311c. videoclip_source 0~"capability_nmediastream 6/6 Indicate the source of media "-1 stream.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.31 Recording Group: recording_i<0~(n-1)> n denotes the value of "capability_nrecording" (capability_nrecording > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] 6/6 Identification of this entry. trigger schedule, 6/6 The event trigger type networkfail schedule: The event is triggered by schedule networkfail: The event is triggered by the failure of network connection. enable 6/6 Enable or disable this recording.
VIVOTEK PARAMETER © 2020 VIVOTEK INC. All Right Reserved VALUE maxretentiontime SECURITY DESCRIPTION (get/set) 6/6 To specify the expired time for automatic clean up, and it only takes effect for video clip generated by recording_i <0~1>. Format is “‘P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss] S’ , similar with ISO8601 with symbols P Ex. P7D, it means 7 days. P1DT10H, it means 1 days and 10 hours. The parameter takes effect when autocleanup_ maxretentiontime_recording_enabled is enabled.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) weekday 0~127 6/6 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. begintime hh:mm 6/6 Start time of the weekly schedule. endtime hh:mm 6/6 End time of the weekly schedule.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY DESCRIPTION (get/set) adaptive_enable 6/6 Indicate whether the adaptive recording is enabled adaptive_preevent 0~9 6/6 Indicate when is the adaptive recording started before the event trigger point (seconds) adaptive_postevent 0~10 6/6 Indicate when is the adaptive recording stopped after the event trigger point (seconds) recordingjob_Sourc string[64] 6/6 eToken_Token Indicate the source for media profile.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION stateorprovincen string[128] 6/6 State or province name in the ame localityname certificate information. string[128] 6/6 The locality name in thecertificate information. organizationname string[64] 6/6 VIVOTEK Inc. unit string[64] information. 6/6 VIVOTEK Inc. commonname string[64] 0 ~ 825 Organizational unit name in thecertificate information. 6/6 www.vivotek.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION autocleanup_mode targetbase, 6/6 Specify the automatic clean up method sourcebase for storage devices, where “targetbase” indicate the automatic clean up is based on the attached devices such as nas or sd card, whereas “sourcebase” indicate automatic clean up is based on the selected recording track. * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.34 Region of Interest Group: roi_c<0~(n-1)> for n channel product and m is the index of video stream which support ePTZ. (capability_eptz > 0) PARAMETER VALUE SECURITY (get/set) DESCRIPTION s<0~(m-1)>_home 1/6 ROI left-top corner coordinate.* If the minimal window size is 64x64, then the "win_i0_home"=(0~resolution_W-64, 0~resolution_H-64), which the resolution is the value in current stream.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION tiltspeed -5 ~ 5 1/7 Tilt speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.) panspeed -5 ~ 5 1/7 Pan speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.) zoomspeed -5 ~ 5 1/7 Zoom speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.) autospeed 1~5 1/7 Auto pan/patrol speed (It should be set by eCamCtrl.cgi rather than by setparam.cgi.) 7.35.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION preset_i<0~19>_size 1/7 Width and height of the preset. (It should be set by ePreset.cgi rather than by setparam.cgi.) 7.36 Focus Window Setting Group: focuswindow_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin".
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION diskmode seamless, 1/6 “seamless” indicates enable seamless manageable recording. “manageable” indicates disable seamless recording. * We replace this parameter with “seamlessrecording_c<0~(n-1)>_diskmode” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin > 1".
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION guid<0~2>_id string[127] 1/7 The connected seamless streaming ID. (Read only) * We replace this parameter with “seamlessrecording_c<0~(n-1)>_guid<0~2>_i d” when the version number (httpversion) is equal or greater than 0312a. * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved diskmode seamless, 1/6 manageable “seamless” indicates enable seamless recording. “manageable” indicates disable seamless recording. * We support this parameter when the version number (httpversion) is equal or greater than 0312a. maxconnection 3 1/7 Maximum number of connected seamless streaming. * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.38 VIVOTEK Application Development Platform Setting Group: vadp NAME VALUE SECURITY DESCRIPTION (get/set) version 6/7 Indicate the VADP version. resource_total_memory 0, resource_total_storage 0, resource_free_memory 0,
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Maximum of n=10 hyperlink is supported. NAME VALUE SECURITY DESCRIPTION (get/set) moduleidx 0, title string[40] 1/7 Name of the vadp hyperlink. url string[120] 1/7 The URL address of vadp hyperlink. status string[40] 1/7 Value of “on” indicates a valid connection of vadp hyperlink. Value of “off” indicates a invalid connection of vadp hyperlink. 7.38.2.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION initscr string[40] 6/6 The script that will handle operation commands from the system. status string[40] 6/6 Indicate the running status of the module. statmsg string[128] 6/6 Indicate the message that will be show on the running status when mouse over. vvtklicensemec string[40] 6/7 Indicate the module use VIVOTEK license mechanism 7.38.3.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.39 Camera PTZ Control Group: camctrl (capability_camctrl_ptztunnel > 0) NAME VALUE SECURITY (get/set) DESCRIPTION enableptztunnel 1/4 Enable PTZ tunnel for camera control.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION driver. 2: enable PTZ commands with UART tunnel. * only available when capability_camctrl_c0_rs485=2 disablemdonptz 1/4 Disable motion detection on PTZ operation. 7.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION 1/4 Select corresponding uart nual * Available values are listed in "capability_cam ctrl_c<0~(n-1)> _focusmode" uart 0~ "capability_nua rt"-1 (capability_nuart>0). * only available when capability_camctrl_c0_rs485=2 isptz 0~2 1/4 0: disable PTZ commands. 1: enable PTZ commands with PTZ driver. 2: enable PTZ commands with UART tunnel.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE setting fixcurrent SECURITY (get/set) DESCRIPTION essential and should be grouped with “preset_i<0~(k-1)>_name.” * We support this parameter when the version number (httpversion) is equal or greater than 0305b.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION should be taken while idle. idleaction_interval 1~999 1/4 While idle over this time interval, idle action will be taken. PLEASE REFER TO PTZ CONTROL API 7.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION preset_i<0~(k-1)>_name string[40] 1/4 Name of the preset location. preset_i<0~(k-1)>_pan 1/4 Pan position at each preset * Available values are listed in "capability_camctrl_c <0~(n-1)>_focusmod e" capability_ptz_c<0~( n-1)>_minpan ~ capability_ptz_c<0~( location.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION disablemdonptz 1/4 Disable motion detection on PTZ operation. defaulthome 1/4 This field tells system to use default home position or not. axisx capability_ptz_c<0~( 1/4 Custom home pan position. 1/4 Custom home tilt position. 1/4 Custom home zoom position. 1/4 Custom home focus position.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION Set -1 to disable all the tour groups. tour_i<0~19>_name string[40] 1/4 Name of the tour. tour_i<0~19>_type 1/4 0 = Recorded tour 1 = Preset tour tour_i<0~19>_speed -5 ~ 5 1/4 Preset tour: pan and tilt speed when moving between presets. Recorded tour: unnecessary. tour_i<0~19>_direction forward,backward,ra 1/4 ndom User can choose which direction the preset tour goes.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Group: uart (capability_nuart > 0 and capability_fisheye = 0) NAME VALUE SECURITY (get/set) DESCRIPTION ptzdrivers_i<0~19, string[40] 1/4 Name of the PTZ driver. string[128] 1/4 Full path of the PTZ driver. 1/4 Enable HTTP tunnel channel to control 127>_name ptzdrivers_i<0~19, 127>_location enablehttptunnel UART.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION speedlink_i<0~4>_c string[40] 1/4 Additional PTZ command list. md ptzdriver * only available when capability_camctrl_c0_rs485=2 0~19, 1/4 127 (custom), 128 (no driver) The PTZ driver is used by this COM port. * only available when capability_camctrl_c0_rs485=2 7.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE SECURITY (get/set) DESCRIPTION stopbit 1,2 4/4 "1": One stop bit is transmitted to indicate the end of a byte. "2": Two stop bits are transmitted to indicate the end of a byte. If you want to transfer the stopbit for 150% of the normal time used to transfer one bit, the uart_i<0~(n-1)>_stopbit should be set as 2 and the uart_i<0~(n-1)>_databit set as 5 as well. uartmode rs485 4/7 RS485 mode. 7.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Group: lens_default_i<0~(n-1)> n denotes the value of "lens_default_totalnumbers" NAME VALUE SECURITY (get/set) DESCRIPTION name 6/7 Default lens name Group: lens_user_i<0~(n-1)> n denotes the value of "lens_user_totalnumbers" NAME VALUE SECURITY (get/set) DESCRIPTION name 6/7 User-defined lens name 7.45 Fisheye Info.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved NAME VALUE s<0~(m-2)>_region_t -90~90 SECURITY (get/set) DESCRIPTION 1/4 Tilt home angle of regional view (for ilt 1R mode) Tilt range of ceiling/floor mount is [0~90]. Tilt range of wall mount is [-90~90].
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION objsize_type -1~2 1/4 Type of object size. -1 : customized width and height 0 : object size = 30 x 30 1 : object size = 10 x 20 2 : object size = 10 x 10 objsize_customized_w 10~320 1/4 The minimum width of tracking target. 1/4 The minimum height of tracking target. 1/4 Tracking sensitivity. idth objsize_customized_h 10~240 eight sensitivity 0~2 0: Low 1: Medium 2: High 7.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE SECURITY (get/set) DESCRIPTION encrypt none, 6/6 Encryption method: wep, wpa, none: NONE, wep: WEP, wpa2 wpa: WPA, wpa2: WPA2PSK authmode OPEN, SHARED 6/6 Authentication mode. * Only valid when "wireless_encrypt" is "wep" keylength 64, 128 6/6 Key length in bits. * Only valid when "wireless_encrypt" is "wep" keyformat HEX, ASCII 6/6 Key1 ~ key4 presentation format.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 7.50 Shock Detection Group: shock_c<0~(n-1)> for n channel products n denotes the value of "capability_nvideoin" (capability_shockalarm_support > 0) PARAMETER VALUE SECURITY (get/set) DESCRIPTION alarm_enable 4/4 Enable shock detection's alarm. alarm_level 1~100 4/4 The value indicate the support strength level of shock detection's alarm. 7.51 Stream Profiles Group: streamprofile_i<0~(n-1)> for n profiles product.
VIVOTEK PARAMETER © 2020 VIVOTEK INC. All Right Reserved VALUE SECURITY (get/set) videoconfiguration_so c<0~(n-1)>s<0~(m-1) 1/6 urce > * n denotes the value of “capability_nvideoin, and m denotes the value of “capability_nmediastr eam” audioconfiguration_en able 1/6 DESCRIPTION The videoconfiguration source for the profile. Ex. videoconfiguration_source= c<0~(n-1)>s<0~(m-1)> indicates video stream of channel n stream m is selected for the profile.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Group: metadata_c<0~(n-1)>_s0_multicast (capability_media_streamprofiles_support = 1) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY( get/set) DESCRIPTION ipaddress 4/4 Multicast metadata IP address. port 1025 ~ 65535 4/4 Multicast metadata port. ipversion IPv4, IPv6 4/4 The version of internet protocol. ttl 1 ~ 255 4/4 Multicast metadata time to live value.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8. Useful Functions 8.1 Drive the Digital Output (capability_ndo > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http:///cgi-bin/dido/setdo.cgi?do1= [&do2=] [&do3=][&do4=] Where state is 0 or 1; “0” means inactive or normal state, while “1” means active or triggered state, and trigger time is indicated in seconds.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: \r\n \r\n [di0=]\r\n [di1=]\r\n [di2=]\r\n [di3=]\r\n where can be 0 or 1. Example: Query the status of digital input 1 . Request: http://myserver/cgi-bin/dido/getdi.cgi?di1 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n di1=1\r\n 8.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved [do1=]\r\n [do2=]\r\n [do3=]\r\n where can be 0 or 1. Example: Query the status of digital output 1. Request: http://myserver/cgi-bin/dido/getdo.cgi?do1 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n do1=1\r\n 8.4 Capture Single Snapshot Note: This request requires Normal User privileges. Method: GET/POST Syntax: http:///cgi-bin/viewer/video.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION quality 1~5 The quality of the image. streamid 0~( capability_nmediastream -1) The stream number. Default: Returns snapshot of maxmum resolution for current channel. The server will return the most up-to-date snapshot of the selected channel and stream in JPEG format. The size and quality of the image will be set according to the video settings on the server. Return: HTTP/1.0 200 OK\r\n Content-Type: image/jpeg\r\n [Content
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION username The name of the user to add, delete, or edit. userpass The password of the new user to add or that of the old user to modify. The default value is an empty string. privilege view The privilege of the user to add or to modify. operator “view”: Viewer privilege. “operator”: Operator privilege. admin return “admin”: Administrator privilege.
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK ERROR: Update user's privilege fail! 8.6 Upgrade Firmware Note: This request requires Administrator privileges. Method: POST Syntax: http:///cgi-bin/admin/upgrade.cgi Post data: fimage=[&return=]\r\n \r\n Server will accept the file named to upgradethe firmware and return with if indicated.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.7 ePTZ Camera Control (capability_eptz > 0 and Capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http:///cgi-bin/camctrl/eCamCtrl.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved b. continuous movement If you trigger a continuous movement, you have to handle the stop time by yourself. A continuous movement is convenient to integrate a joystick control. http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=tele&zs=1 http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION y movement w The scaled area size h resolution The resolution of streaming. vx The direction of movement, used for joystick control. vy vs 0~7 Set the speed of movement, “0” means stop. x x-coordinate clicked by user. It will be the x-coordinate of center after movement. y y-coordinate clicked by user.
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK 8.8 ePTZ Recall (capability_eptz > 0 and capability_fisheye = 0) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http:///cgi-bin/camctrl/eRecall.cgi?channel=&stream=& recall=[&return=] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source. stream <0~(m-1)> Stream. recall Text string less than 40 characters One of the present positions to recall.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION addpos delpos return Redirect to the page after the parameter is assigned. The should be the relative path according to the root of camera. If you omit this parameter, it will redirect to an empty page.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Syntax: http:///cgi-bin/operator/uartchannel.cgi?[channel=] ------------------------------------------------------------------------GET /cgi-bin/operator/uartchannel.cgi?[channel=] x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------POST /cgi-bin/operator/uartchannel.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved ------------------------------------------------------------------------GET /cgi-bin/admin/ctrlevent.cgi x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache ------------------------------------------------------------------------POST /cgi-bin/admin/ ctrlevent.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved network_rtsp_s2_accessname = live2s1.sdp network_rtsp_s3_accessname = live2s2.sdp etc. * Note: RTSP access name format is modified to “lives.sdp” after version number(httpversion) is 0311c. Please refer to the “subgroup of network: rtsp” for setting the accessname of SDP. You can get the SDP by HTTP GET. When using scalable multicast, Get SDP file which contains the multicast information via HTTP. 8.
VIVOTEK data © 2020 VIVOTEK INC. All Right Reserved is a series of digits from 0 ~ 9, A ~ data>[,] milliseconds. flush yes,no yes: Receive data buffer of the COM port will be cleared before read. no: Do not clear the receive data buffer. wait 1 ~ 65535 Wait time in milliseconds before read data. read 1 ~ 128 The data length in bytes to read. The read data will be in the return page.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Command: search PARAMETER VALUE DESCRIPTION label Optional. The integer primary key column will automatically be assigned a unique integer. triggerType Optional. Indicate the event trigger type. Please embrace your input value with single quotes. Ex. triggerType=’vi’ mediaType Optional. Indicate the file media type. Ex. mediaType=videoclip * logical “OR” is not supported for this parameter.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION limit Optional. Limit the maximum number of returned search records. offset Optional. Specifies how many rows to skip at the beginning of the matched records. Note that the offset keyword is used after limit keyword. To increase the flexibility of search command, you may use “OR” connectors for logical “OR” search operations.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION state while “1” means active or triggered state. Where "nstate" is next state after duration. Ex: vi0=0(200)1 Setting virtual input 0 to normal state, waiting 200 milliseconds, setting it to trigger state. Note that when the virtual input is waiting for next state, it cannot accept new requests. return Redirect to the page after the parameter is assigned.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http:///_accessname>?maxsft=[&tsmode=&reft ime=&forcechk&minsft=] For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player. rtsp:///_accessname>?maxsft=[&tsmode=&refti me=&forcechk&minsft=] “n” is the channel index. “m” is the timeshift stream index.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Return Code Description 400 Bad Request Request is rejected because some parameter values are illegal. 415 Unsupported Media Type Returned, if forcechk appears,when minsft is not achievable or the timeshift feature of the target stream is not enabled. 8.19 RemoteFocus (capability_image_c<0~(n-1)>_remotefocus=1) Note: This request requires Administrator privileges. Method: GET/POST Syntax: (for control API) http:///cgi-bin/admin/remotefocus.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION position ~ Motor’s position. It works only if function=zoom or function= focus and direction=direct. : remote_focus_zoom_motor_start or remote_focus_focus_motor_start, : remote_focus_zoom_motor_end or remote_focus_focus_motor_end replied from "function=getstatus" steps 1 ~ 30 Motor’s moving steps.
VIVOTEK © 2020 VIVOTEK INC.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION function focus, focus – Move focus motor auto, scan, auto – Perform auto focus scan – Perform focus scan stop, stop – Stop current operation positioning, irisopen, positioning – Position the motors resetfocus – reset focus position to default irisenable, irisopen – Fully open iris. It will maintain fully open iris resetfocus status until sending function=irisenable cgi.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved function getstatus Information of motors, return value as below: remote_focus_focus_motor_max: Maximum steps of focus motor remote_focus_focus_motor_start: Start point of effective focal length remote_focus_focus_motor_end: End point of effective focal length remote_focus_focus_motor: Current position of focus motor remote_focus_focus_enable: Current function of focus motor remote_focus_iris_open: The current status of iris.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved currentlanguage 0~20 Available language lists. Please refer to: system_info_language_i0 ~ system_info_language_i19. For setting backup file: http:///cgi-bin/admin/export_backup.cgi?backup 8.22 Upload Files Note: This request requires Administrator privileges.
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK Server will accept the file named to upload this one to camera. 8.23 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:///cgi-bin/admin/update_lens.cgi?get_currentlens For list all names of lens installed in camera: http:///cgi-bin/admin/update_lens.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved For upload user-defined lens configuration: http:///cgi-bin/admin/update_lens.cgi?upload_lens Post data: upload_lens_profile_input = \r\n \r\n Server will accept the file named to upload the lens profile to camera. 8.24 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.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved X V V X Play recordings for length seconds which ends at etime rtsp://10.10.1.2/mod.sdp?etime=20110312_040400.000&length=120 X X X V Play file file rtsp://10.10.1.2/mod.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.25 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:///cgi-bin/admin/setpm3d.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.26 Camera Control (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET/POST Syntax: (for control API) http:///cgi-bin/camctrl/camctrl.
VIVOTEK PARAMETER © 2020 VIVOTEK INC. All Right Reserved VALUE DESCRIPTION down Move camera down. left Move camera left. right Move camera right. 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. auto pan Auto pan. patrol Auto patrol. stop Stop camera. wide Zoom larger view with current speed.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION focus auto Auto focus. far Focus on further distance. near Focus on closer distance. sync Applies the selected focus mode in focusseting camctrl_c<0~(n-1)>_focusmode to this preset. fixcurrent Applies the current focus position to this preset. * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION getpanangle Get the current pan angle. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" gettilt 0, Get the current tilt position. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" gettiltangle Get the current tilt angle.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmintiltangle Get the lower limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getmaxtiltangle Get the upper limit for tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getminzoom 0, Get the lower limit for zoom position.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.28 Preset Locations (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Operator privileges. Method: GET/POST Syntax: http:///cgi-bin/operator/preset.cgi?[channel=] [&addpos=][&delpos=][&return=] PARAMETER VALUE DESCRIPTION addpos string[30] Add one preset location to the preset list. channel 0~"capability_nvideoin"-1 Channel of the video source.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 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 smartsd_lifetime_den: Card-guaranteed amount of data that can be written smartsd_lifetime_rate: The ratio of smartsd_lifetime_num to smartsd_lifetime_den. It means the accumulated percentage amount of flash block has been written.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Syntax: http:///cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION N/A N/A Apply the wireless settings and connect to AP. 8.31 Get Wireless Information (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/getwirelessinfo.cgi PARAMETER VALUE DESCRIPTION N/A N/A Get wireless information. Camera will return following information. 1.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved PARAMETER VALUE DESCRIPTION N/A N/A Get wireless signal strength. 8.33 WPS Transaction (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/start_wps.cgi PARAMETER VALUE DESCRIPTION N/A N/A Start WPS transaction. 8.34 Peripheral Control (capability_peripheral_c<0~(n-1)>_ devicecontrol > 0) Note: This request requires Administrator privileges.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved "washer_mode : OK\r\n" "washer_status : FAIL\r\n" PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. washer_mode wiper Apply the wiper to the mode of washer control system. washer Apply the washer to the mode of washer control system. on Enable the functionality of washer control system. off Disable the functionality of washer control system.
© 2020 VIVOTEK INC. All Right Reserved 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 N/A Get support peripheral device. washer_supportmode N/A Get the support mode of washer control system. washer_mode N/A Get the current mode of washer control system.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 8.35 Optimized IR control (capability_daynight_c<0~(n-1)>_optimizedir > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/optimizedir.cgi?function=[&channel=] PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. function getstatus, onetimeauto "onetimeauto": Camera will automatically adjust the IR zone one time only.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved 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:///cgi-bin/admin/optimizedir.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=settoall&irmode=manual&str ength=100 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n "optimizedir_c0_irstrength='100,100,100,100,100'" "optimizedir_c0_irmode='manual'" Example: http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&irmode=auto&strength= 50,70,50,50,50 Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http:///cgi-bin/admin/optimizedir.cgi?channel=&operation=get [&support_irmode] – list all adjustment mode that IR supports [&irmode] – Get current IR mode [&irnum] – Get the number of IR zone PARAMETER VALUE DESCRIPTION channel 0~"capability_nvideoin"-1 Channel of the video source. support_irmode N/A List all adjustment mode that IR supports irmode N/A Get the current IR control mode.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved \r\n OK Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: time out Example: http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n ERROR: fail PARAMETER VALUE DESCRIPTION action shuttercompensate Camera will
© 2020 VIVOTEK INC. All Right Reserved VIVOTEK Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n version=1120B15 8.37 Audio Clip Control (capability_audio_audioclip=1) Note: This request requires Administrator privileges. Method: GET/POST Syntax: (for control API) http:///cgi-bin/admin/audioclip.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved clipname Name of the audio clip. clipindex 0, 1 Number of the audio clip. 8.38 Format SD card Note: This request requires Administrator privileges. Method: GET/POST Syntax: (for control API) http:///cgi-bin/admin/format_sdcard.cgi?operation=set[&=] If the user requests a size larger than all stream settings on the server, this request will fail.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Response of formatting fail: HTTP/1.1 200 OK\r\n Content-Type: text/plain\r\n Content-Length: \r\n \r\n Syntax: (for query API) http:///cgi-bin/admin/ format_sdcard.cgi?operation=get PARAMETER VALUE DESCRIPTION Get Get formatting progress(0~100) or result(error message) *It is unnecessary when using the blocking mode.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved ERROR: The device does not exist or is busy ERROR: Formatted successfully, but cannot create database 8.39 Methods for Accessing Streaming 8.39.1 Get Stream URI (capability_media_streamprofiles_support = 1) Note: This request requires Viewer access privileges. Syntax: For RTSP, the user needs to input the URL below into a RTSP compatible player. rtsp://:/media2/stream.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Note: This request requires Viewer access privileges. Method: GET/POST Syntax: http://:/media2/_profilename>.sdp?[= ] “n” is the maximum stream profile number (capability_media_streamprofiles_num) “streamprofile_i_profilename” is a friendly name for certain profile, x is within 0~(capability_media_streamprofiles_num)-1. port is the http port.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved http:///cgi-bin/admin/sftpclient.cgi?operation=[¶meter=] PARAMETER VALUE DESCRIPTION operation automode, manualmode "automode": Key pair will be generated, and automatically copy public key to server. "manualmode": Key should be downloaded or uploaded by user. * This field is required. key download, upload "download": Download public key. "upload": Upload private key.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved * Only valid when operation=manualmode and key=upload. passphrase_content <128-bit hash value > Passphrase * Only valid when operation=manualmode and key=upload. location string[128] sftp server file location name string[40] Username for server_i_name * The default value is sftp. keytype ed25519, rsa, ecdsa "ed25519": faster to generate with higher security level, some old server might not support.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved value>&keytype=test Response of failure: HTTP/1.1 200 OK\r\n Content-Type: text/plain\r\n Content-Length: \r\n \r\n ERROR: Invalid keytype Example of upload private key: POST http://172.16.219.217/cgi-bin/admin/sftpclient.cgi HTTP/1.1 Accept: text/html, application/xhtml+xml, */* Accept-Language: zh-TW User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; rv:11.
VIVOTEK © 2020 VIVOTEK INC.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved * This field is required. Example of scanning SFTP server host key: Request: http:///cgi-bin/admin/sftpclient.cgi?operation=getserverhostkey&address= Response of success: HTTP/1.1 200 OK\r\n Content-Type: text/plain\r\n Content-Length: \r\n \r\n 8.40.2 SFTP Server Setting * Only available when bit 1 of "capability_protocol_ftp_server" is 1.
VIVOTEK © 2020 VIVOTEK INC. All Right Reserved Syntax: (for query API) http:///cgi-bin/admin/sftpserver.cgi?operation= PARAMETER VALUE DESCRIPTION operation gethostkey "gethostkey": Get host key for SFTP server. * This field is required. * If “updatehostkey” is not yet finished, you will receive error message. Example of get host key: Request: http:///cgi-bin/admin/sftpserver.cgi?operation=gethostkey Response of success HTTP/1.1 200 OK\r\n Content-Type: text/plain\r\n
VIVOTEK Technology License Notice AMR-NB Standard THIS PRODUCT IS LICENSED UNDER THE AMR-NB STANDARD PATENT LICENSE AGREEMENT. WITH RESPECT TO THE USE OF THIS PRODUCT, THE FOLLOWING LICENSORS’ PATENTS MAY APPLY: TELEFONAKIEBOLAGET ERICSSON AB: US PAT. 6192335; 6275798; 6029125; 6424938; 6058359. NOKIA CORPORATION: US PAT. 5946651; 6199035. VOICEAGE CORPORATION: AT PAT. 0516621; BE PAT. 0516621; CA PAT. 2010830; CH PAT. 0516621; DE PAT. 0516621; DK PAT. 0516621; ES PAT. 0516621; FR PAT. 0516621; GB PAT.
VIVOTEK Electromagnetic Compatibility (EMC) FCC Statement This device compiles with FCC Rules Part 15. Operation is subject to the following two conditions. ■ This device may not cause harmful interference, and ■ This device must accept any interference received, including interference that may cause undesired operation. This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to Part 15 of the FCC Rules.
