Manual

ManualsBrandsVivotek ManualsBullet Cameras2 MP Outdoor Network Bullet Camera 3.6 mm Lens

Table Of Contents

Rev. 1.0

2MP • 12M IR • Smart Stream II • Video Rotation

WiFi • IP66 • UV Protection

User’s Manual

Wireless Bullet

Network Camera

IB8360-W

Rev. 1.0:

Summary of content (352 pages)

PAGE 1
IB8360-W Wireless Bullet Network Camera User ’s Manual 2MP • 12M IR • Smart Stream II • Video Rotation WiFi • IP66 • UV Protection Rev. 1.0: Rev. 1.
PAGE 2
VIVOTEK Table of Contents Overview ��3 Revision History ��3 Read Before Use ��
PAGE 3
VIVOTEK URL Commands for the Network Camera �� 141 Technical Specifications �� 347 Technology License Notice �� 349 Electromagnetic Compatibility (EMC) ��
PAGE 4
VIVOTEK 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. It is important to first verify that all contents received are complete according to the Package Contents listed below.
PAGE 5
VIVOTEK 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. WARNING: or IMPORTANT:: These statements indicate situations that can be dangerous or hazardous to the machine or you.
PAGE 6
VIVOTEK Dimension Drawing 98.33 163.73 74.98 NOTE: • Use the camera only with a DC power supply that is UL listed, and limited power source (LPS) certified. The power supply should bear the UL listed and LPS marks. The power supply must also meet any safety and compliance requirements for the country of use. • When installing the camera, do not use excessive force.
PAGE 7
VIVOTEK Hardware Installation 1. Jot down the camera's MAC address for later reference. XXXXXX 0002D10766AD 2. Find an appropriate position. Drill holes on the wall for the included plastic anchors. Install the camera by driving screws through the mounting holes on the bracket. The anchors may not be necessary if you install the camera on a wooden wall or calcium silicate board. If preferred, drill a routing hole on the wall for routing the power cord.
PAGE 8
VIVOTEK 3. Install a MicroSD card if onboard storage is preferred. The card slot is accessed through a rubber seal. Use a small Phillips screwdriver to open the seal. Please properly fasten the seal and screw after the installation to ensure it is waterproof. 64GB 10 1 I 4. Connect the included power adaptor between the camera and the power mains.
PAGE 9
VIVOTEK IMPORTANT: Refer to the functional description and LED definitions below when configuring the camera. WPS Button Usage Function Reset - press less than 3 seconds, WPS - press 3 to 5 secs, Restore default - press longer than 7 secs. LED Behavior White - operating in AP mode (default status). Off then Red, then White. Flashing Blue for 2 mins, then Red, then Green. Flashing Red and Green LED Definitions LED Color Steady Red All LED off Blink Red / Green every 0.
PAGE 10
VIVOTEK NOTE: 1. WPS may not work if your AP is configured with a "hidden" SSID. 2. If no WPS-enabled AP is detected, the camera will repeat trying to connect by every 20 seconds. If the camera still can not detect an AP after 2 minutes, the wireless setup will be cancelled. 3.If a camera is assigned with a fiex IP outside the AP's network segment, wireless configuration will fail. B: WiFi w/o WPS B-1. When your device has wireless connectivity, e.g., a notebook.
PAGE 11
VIVOTEK B-2. Select the camera and right-click to display the Connect button. Click to connect. B-3. Open a web browser, enter the camera's default IP: 192.168.1.1. B-2 B-3 192.168.1.1 B-4. The camera will search for the other APs within the network. Select an AP you prefer your camera to connect to. B-5. Enter the credentials for log in to your AP. Please move to Step 6.
PAGE 12
VIVOTEK C: C-1. You can also use your cell phone to connect the camera. Open your Wi-Fi setting page. C-2. You should be able to find the camera displayed as "VVTK and the last 3 octets of the MAC address." Identify the camera using its MAC address. C-1 C-2 MAC 4B:AD:55 Network Camera Model No: XXXXXX MAC: 0002D14BAD55 This device complies with part 15 of the FCC Rules.
PAGE 13
VIVOTEK C-3. Open a web browser window. Enter the camera's default IP: 192.168.1.1. C-4. The camera will search for the other APs within the network. Select an AP you prefer your camera to connect to. C-3 192.168.1.
PAGE 14
VIVOTEK C-5. Enter the credentials for log in to your AP. C-6. When the camera is connected to an AP, it enters the client mode. You should then install and open the iViewer utility from your app store. C-7. Add the camera to your iView utility.
PAGE 15
VIVOTEK C-8. You can click on Add from List. The iViewer will search within your current network for the camera. C-9. Once found, you can add the camera into your configuration. Please refer to the documentation that came with iViewer for information.
PAGE 16
VIVOTEK 6. Open the Shepherd utility. The utility will search for cameras within the network. 7. Double-click on the camera to open a web console with the camera. You can now start viewing the live stream.
PAGE 17
VIVOTEK Forceful Password Configuration The first time you log in to the camera, the firmware will prompt for a password configuration for security concerns. Enter the combination of alphabetic and numeric characters to fulfill the password strength. requirement. The default name for the camera administrator is “root”, and can not be changed. Some, but not all special ASCII characters are supported: !, $, %, -, ., @, ^, _, and ~. You can use them in the password combination.
PAGE 18
VIVOTEK Another prompt will request for the password you configured. Enter the password and then you can start configure your camera and see the live view.
PAGE 19
VIVOTEK SD/SDHC/SDXC Card Capacity This network camera is compliant with SD/SDHC/SDXC 16GB / 8GB / 32GB / 64GB and other preceding standard SD cards. 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 21 for details.
PAGE 20
VIVOTEK Internet connection via PPPoE (Point-to-Point over Ethernet) Choose this connection type if you are connected to the Internet via a DSL Line. Please refer to PPPoE on page 73 for details. Configure the router, virtual server or firewall, so that the router can forward any data coming into a pre-configured port number to a network camera on the private network, and allow data from the camera to be transmitted to the outside of the network over the same path. From Forward to 122.146.57.120:8000 192.
PAGE 21
VIVOTEK Software Installation Installation the Shepherd utility, a software included in the product CD, helps you set up your Network Camera on the LAN. If your camera comes without the CD, go to VIVOTEK’s website, and locate the utility in the Downloads > Software page. 1. Run the Shepherd utility. 2. The program will conduct an analysis of your network environment.
PAGE 22
VIVOTEK 3. The program will search for all VIVOTEK network devices on the same LAN. 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: IP8360-W MAC:0002D1730202 R o HS This device complies with part 15 of the FCC rules.
PAGE 23
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.
PAGE 24
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 92. ► 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.
PAGE 25
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.
PAGE 26
VIVOTEK Using RTSP Players To view the streaming media using RTSP players, you can use one of the following players that support RTSP streaming. Quick Time Player VLC media player VLC media player 1. Launch the RTSP player. mpegable Player 2. Choose File > Open URL. A URL dialog box will pop up. 3.
PAGE 27
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 19. To utilize this feature, please check the following settings on your Network Camera: 1.
PAGE 28
VIVOTEK Using VIVOTEK Recording Software The product software CD also contains a VAST recording software, allowing 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.
PAGE 29
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 Camera Control 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.
PAGE 30
VIVOTEK Configuration Area Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 34. 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 39.
PAGE 31
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 105 for detailed information. Global View: Click on this item to display the Global View window. The Global View window contains a full view image (the largest frame size of the captured video) and a floating frame (the viewing region of the current video stream).
PAGE 32
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.
PAGE 33
VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Title and Time Video (HTTP-V) 2017/03/25 17:08:56 Time Video 17:08:56 2017/03/25 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 57. Time: Display the current time. For more information, please refer to Media > Image on page 57. Title and Time: Video title and time can be stamped on the streaming video.
PAGE 34
VIVOTEK Client Settings This chapter explains how to select the stream transmission mode and saving options on the local computer. When completed with the settings on this page, click Save on the page bottom to enable the settings. H.264 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.
PAGE 35
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.
PAGE 36
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.
PAGE 37
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.
PAGE 38
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.
PAGE 39
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.
PAGE 40
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.
PAGE 41
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.
PAGE 42
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.
PAGE 43
VIVOTEK Theme Options Here you can change the color of your homepage layout. There are three types of preset patterns for you to choose from. The new layout will simultaneously appear in the Preview filed. Click Save to enable the settings.
PAGE 44
VIVOTEK ■ Follow the steps below to set up the customed homepage: 1. Click Custom on the left column. 2. Click the field where you want to change the color on the right column. Color Selector Custom Pattern 3. The palette window will pop up as shown below. 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.
PAGE 45
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.
PAGE 46
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.
PAGE 47
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. 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.
PAGE 48
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. WARNING: 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.
PAGE 49
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 73). 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.
PAGE 50
VIVOTEK 3. Open the file with Microsoft® Notepad and locate your time zone; set the start and end time of DST. When completed, save the file. In the example below, DST begins each year at 2:00 a.m. on the second Sunday in March and ends at 2:00 a.m. on the first Sunday in November. Update daylight saving time rules: Click Browse… and specify the XML file to update. If the incorrect date and time are assigned, you will see the following warning message when uploading the file to the Network Camera.
PAGE 51
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.
PAGE 52
VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following four columns: General settings, Picture settings, Exposure, Focus, 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.
PAGE 53
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.
PAGE 54
VIVOTEK Smart IR When enabled, the camera automatically adjust the IR projection to adjacent objects in order to avoid over-exposure in the night mode. The Smart IR function is more beneficial when the spot of intrusions or an object of your interest is close to the lens and the IR lights. For example, if an intruder has a chance of getting near the range of 3 meters, Smart IR can effectively reduce the over-exposure. For a surveillance area at a greater distance, e.g.
PAGE 55
VIVOTEK Tips: If there is an object in close proximity, the IR lights reflected back from it can mislead the Smart IR’s calculation of light level. To solve this issue, you can place an “Exposure Exclude” window on an unavoidable object in the Exposure setting window. See page 60 for how to do it. You can also configure the “Exposure Exclude” window in a night mode “Profile” setting so that your day time setting is not affected.
PAGE 56
VIVOTEK IR cut filter This Network Camera can automatically adapts to different lighting conditions. ■ Auto mode The Network Camera automatically switch between day mode and night mode by judging the level of ambient light. ■ Day mode In day mode, the camera streams video in color. In day mode, the camera does not switch to night mode regardless of ambient light conditions. ■ Night mode In night mode, the camera streams video in black and white.
PAGE 57
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.
PAGE 58
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 pull-down menu 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.
PAGE 59
VIVOTEK Exposure On this page, you can configure the Exposure measurement window, Exposure level, Exposure mode, Exposure time, Gain control, and Day/Night mode settings. You can configure two sets of Exposure settings: one for normal situations, the other for special situations, such as the day/night/ schedule mode. Sensor Setting 2: For special situations Sensor Setting 1: For normal situations Measurement Window: This function allows users to set measurement window(s) for low light compensation.
PAGE 60
VIVOTEK The inclusive window refers to the “weighed 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.
PAGE 61
VIVOTEK ■ AE Speed Adjustment: This function (Automatic Exposure) applies when you need to monitor fast changing lighting conditions. For example, the camera may need to monitor a highway lane or entrance of a parking area at night where cars passing by with their lights on can bring fast changes in light levels. The same applies if the camera is installed on a vehicle, and when it needs to adapt to fast changes of light when entering and leaving a tunnel.
PAGE 62
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.
PAGE 63
VIVOTEK Media > Video This Network Camera supports multiple streams with frame sizes ranging from 176 x 144 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: The default frame size for Stream 2 is set to the 1280 x 720. ■ Stream 3: The default frame size for Stream 3 is set to the 1920 x 1080. Click Viewing Window to open the viewing region settings page.
PAGE 64
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 Global 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.
PAGE 65
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 offers real-time H.264 and MJPEG compression standards (Dual Codec) for real-time viewing. If the H.264 mode is selected, the video is streamed via RTSP protocol. There are several parameters through which you can adjust the video performance: ■ Frame size You can set up different video resolutions for different viewing devices.
PAGE 66
VIVOTEK ■ Maximum frame rate This limits the maximum refresh frame rate per second. Set the frame rate higher for smoother video quality and for recognizing moving objects in the field of view. If the deault 1080P frame size is selected and the power line frequency is set to 50Hz , the frame rates are selectable at 1fps, 2fps, 3fps, 5fps, 8fps, 10fps, 12fps, 15fps, and up to 25fps.
PAGE 67
VIVOTEK ■ Smart stream II ■ Dynamic Intra frame period High quality motion codecs, such as H.264, utilize the redundancies between video frames to deliver video streams at a balance of quality and bit rate. The encoding parameters are summarized and illustrated below. The I-frames are completely self-referential and they are largest in size. The P-frames are predicted frames. The encoder refers to the previous I- or P-frames for redundant image information. H.
PAGE 68
VIVOTEK With the H.264 codec in an optimal scenario and when Dynamic Intra frame is combined with the Smart Stream function, an 80% of bandwidth saving can be achieved compared with using H.264 without enabling these bandwidth-saving features. • Smart codec: 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.
PAGE 69
VIVOTEK As the result, the lower screen is constantly displayed in high details, while the upper half is transmitted using a lower-quality format. Although the upper half is transmitted using a lower quality format, you still have an awareness of what is happening on the whole screen.
PAGE 70
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 40Mbps.
PAGE 71
VIVOTEK If the JPEG mode is selected, the Network Camera sends consecutive JPEG images to the client, producing a moving effect similar to a filmstrip. Every single JPEG image transmitted guarantees the same image quality, which in turn comes at the expense of variable bandwidth usage. Because the media contents are a combination of JPEG images, no audio data is transmitted to the client.
PAGE 72
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.
PAGE 73
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.
PAGE 74
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.
PAGE 75
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.
PAGE 76
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.
PAGE 77
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 the Refresh button to refresh the webpage.
PAGE 78
VIVOTEK 78 - User's Manual
PAGE 79
VIVOTEK Network > Streaming protocols HTTP 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 92 for details. Authentication: Depending on your network security requirements, the Network Camera provides two types of security settings for an HTTP transaction: basic and digest. If basic authentication is selected, the password is sent in plain text format and there can be potential risks of being intercepted.
PAGE 80
VIVOTEK URL command -- http://:/ For example, when the Access name for stream 2 is set to video2.mjpg: 1. Launch Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter. 3. The JPEG images will be displayed in your web browser. http://192.168.5.151/video2.
PAGE 81
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.
PAGE 82
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.
PAGE 83
VIVOTEK SIP SIP is short for Session Initiation Protocol. If necessary, you can change the default port number, 5060, to one between 1025 and 65535.
PAGE 84
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.
PAGE 85
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.
PAGE 86
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.
PAGE 87
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.
PAGE 88
VIVOTEK Network > FTP The newer firmware may disable the FTP port for security concerns. You can manually enable the FTP server service to enable the FTP function. FTP port: The FTP server allows the user to save recorded video clips. You can utilize VIVOTEK's Installation Wizard 2 to upgrade the firmware via FTP server. By default, the FTP port is set to 21. It can also be assigned to another port number between 1025 and 65535.
PAGE 89
VIVOTEK Wireless > WLAN Although the wireless connection is made before you can access the camera’s configuration page, you can enter the WLAN settings if configuration change should be made, e.g., connecting to a different AP. Search your AP: Press this button to search for the nearby AP when the need arises for changing the wireless connection. Below are more information about encryption and other wireless-related settings.
PAGE 90
VIVOTEK 2. WEP (Wired Equivalent Privacy): This allows communication only with other devices with identical WEP settings. ■ Authentication Mode: Choose one of the following modes. The default setting is “Open”. Open – Communicates the key across the network. Shared – Allows communication only with other devices with identical WEP settings. ■ Key length: The administrator can set the key length to 64 or 128 bits. The default setting is “64 bits”. ■ Key format: Hexadecimal or ASCII.
PAGE 91
VIVOTEK Wireless > WPS Use the Activate button when you also activate the WPS function on a wireless AP to establish a new connection.
PAGE 92
VIVOTEK Security > User accounts This section explains how to enable password protection and create multiple accounts. Root Password The administrator account name is “root”, which is permanent and can not be deleted. If you want to add more accounts in the Manage User column, please apply the password for the “root” account first. 1. Type the password identically in both text boxes, then click Save to enable password protection. 2.
PAGE 93
VIVOTEK Security > HTTPS (Hypertext Transfer Protocol over SSL/TLS) This section explains how to enable authentication and encrypted communication over SSL (Secure Socket Layer) and TLS (Transport Layer Security). It helps protect streaming data transmission over the Internet on higher security level. Create and Install Certificate Method Before using HTTPS for communication with the Network Camera, a Certificate must be created first.
PAGE 94
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.
PAGE 95
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.
PAGE 96
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.
PAGE 97
VIVOTEK 7. Open a new edit, paste the certificate contents, and press ENTER at the end of the contents to add an empty line. 8. Convert file format from DOS to UNIX. Open File menu > Conversions > DOS to Unix.
PAGE 98
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.
PAGE 99
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.
PAGE 100
VIVOTEK Security > Access List This section explains how to control access permission by verifying the client PC’s IP address. General Settings Maximum number of concurrent streaming connection(s) limited to: Simultaneous live viewing for 1~10 clients (including stream 1 to stream 3). The default value is 10. If you modify the value and click Save, all current connections will be disconnected and automatically attempt to re-link (IE Explorer or Quick Time Player).
PAGE 101
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.
PAGE 102
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.
PAGE 103
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).
PAGE 104
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.
PAGE 105
VIVOTEK PTZ > PTZ settings This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation. Digital: Control the e-PTZ operation. Within a field of view,it allows users to quickly move the focus to a target area for close-up viewing without physically moving the camera. Digital PTZ Operation (E-PTZ Operation) The e-PTZ control settings section will be displayed as shown below: For e-PTZ related details, please refer to page 107.
PAGE 106
VIVOTEK Home page in the E-PTZ Mode X2.1 ■ The e-Preset Positions will also be displayed on the home page. Select one from the drop-down list, and the Network Camera will move to the selected position. ■ If you have set up different preset positions for different streams, you can select one of the video streams to display its separate preset positions.
PAGE 107
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.
PAGE 108
VIVOTEK NOTE: ► The Preset Positions will also be displayed on the Home page. Select one from the Go to menu, and the Network Camera will move to the selected preset position. ► Click Patrol: The Network Camera will patrol along the selected positions repeatedly.
PAGE 109
VIVOTEK Event > Event settings This section explains how to configure the Network Camera to respond to particular situations (event). A typical application is that when a motion is detected, the Network Camera sends buffered images to an FTP server or e-mail address as notifications. Click on Help, there is an illustration shown in the pop-up window explaining that an event can be triggered by many sources, such as motion detection or external digital input devices.
PAGE 110
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.
PAGE 111
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.
PAGE 112
VIVOTEK Once the triggers are configured, they will be listed under the VADP option. 3. Action Define the actions to be performed by the Network Camera when a trigger is activated. ■ Backup media if the network is disconnected Select this option to backup media file on SD card if the network is disconnected. This function will only be displayed after you set up a network storage (NAS). The media to back up can include snapshot images, video, or system logs depending on your event settings.
PAGE 113
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.
PAGE 114
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.
PAGE 115
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.
PAGE 116
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 135 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 118 for detailed information.
PAGE 117
VIVOTEK Click 20170120 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2017/01/20 2017/01/20 Click to go back to the previous level of the directory Click to delete selected items Click to delete all recorded data 2017/01/20 2017/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.
PAGE 118
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.
PAGE 119
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_20170513_100341 File name preﬁx Date and time sufﬁx 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.
PAGE 120
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_20170513_100341 File name preﬁx Date and time sufﬁx 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.
PAGE 121
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.
PAGE 122
VIVOTEK Customized Script This function allows you to upload a sample script (.xml file) to the camera, which will save your time on configuring the settings. Please note that there is a limited number of customized scripts you can upload; if the current amount of customized scripts has reached the limit, an alert message will prompt. If you need more information, please contact VIVOTEK technical support.
PAGE 123
VIVOTEK Applications > Motion detection This section explains how to configure the Network Camera to enable motion detection. A total of 5 motion detection windows can be configured. Motion Detection Setting 2: For special situations Motion Detection Setting 1: For normal situations Follow the steps below to enable motion detection: 1. Click New to add a new motion detection window. 2. In the Window Name text box, enter a name for the motion detection window.
PAGE 124
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 109. 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.
PAGE 125
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 133 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.
PAGE 126
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.).
PAGE 127
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.
PAGE 128
VIVOTEK You can use the Profile window to configure a different Audio detection setting. For example, a place can be noisy in the day time and become very quiet in the night. 1. Click on the Enable this profile checkbox. Once the Audio detection window is opened, the current sound input will be interactively indicated by a fluctuating yellow wave diagram. 2. Use a mouse click to drag the Alarm level tab to a preferred location on the slide bar. 3. Select the Day, Night, or Schedule mode check circles.
PAGE 129
VIVOTEK Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) Users can store and execute VIVOTEK's or 3rd-party software modules onto the camera's flash memory or SD card. These software modules can apply in video analysis for intelligent video applications such as license plate recognition, object counting, or as an agent for edge recording, etc. • Once the software package is successfully uploaded, the module configuration (vadp. xml) information is displayed.
PAGE 130
VIVOTEK To start a module, select the checkcircle in front, and click the Start button. If you should need to remove a module, select the checkcircle in front and then click the Stop button. By then the module status will become OFF, and the X button will appear at the end of the row. Click on the X button to remove an existing module. When prompted by a confirm message, Click Yes to proceed.
PAGE 131
VIVOTEK On the License page, use the Manual or Automatic to register and activate the license for using VIVOTEK's VADP modules. The Automatic method requires an Internet connection. Without Internet connection, 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. You can proceed with the following link to download a license key: http://www.vivotek. com/vadp_requestactivation.
PAGE 132
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 137 for detailed information. Recording Settings Click Add to open the recording setting window.
PAGE 133
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.
PAGE 134
VIVOTEK 2. Destination You can select the SD card or network storage (NAS) for the recorded video files. If you have not configured a NAS server, see details in the following. NAS server Click Add NAS server to open the server setting window and follow the steps below to configure: 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.
PAGE 135
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.
PAGE 136
VIVOTEK f you want to enable recording notification, please click Event to configure event triggering settings. Please refer to Event > Event settings on page 109 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.
PAGE 137
VIVOTEK Local storage > SD card management NOTE: • • • • • It is recommended to turn OFF the recording activities 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.
PAGE 138
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.
PAGE 139
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: One click on a search result will highlight the selected item. A Play window will appear on top for immediate review of the selected file.
PAGE 140
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: Click to switch pages ■ Remove: Select the desired search results, then click this button to delete the files.
PAGE 141
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.
PAGE 142
VIVOTEK 3. General CGI URL Syntax and Parameters CGI parameters are written in lower-case and as one word without any underscores or other separators. When the CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server. The CGIs are organized in functionally-related directories under the cgi-bin directory. The file extension .cgi is required. Syntax: http:///cgi-bin/[/...]/.
PAGE 143
VIVOTEK 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.cgi?[] [&…] Where the should be [_] or [.].
PAGE 144
VIVOTEK http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http:///cgi-bin/anonymous/setparam.cgi? = [&=…][&update=][&return=] http:///cgi-bin/viewer/setparam.
PAGE 145
VIVOTEK placed at the end of the parameter list Return: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: \r\n \r\n where is =\r\n [] 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
PAGE 146
VIVOTEK joe@www.ibm.com). A string limited to an IP address (eg. 192.168.1.1). A string limited to contain a MAC address without hyphens or colons. A boolean value of 1 or 0 represents [Yes or No], [True or False], [Enable or Disable]. , Enumeration. Only given values are valid. , , … blank A blank string. everything inside <> A description integer primary key SQLite data type. A 32-bit signed integer.
PAGE 147
VIVOTEK 7.1system Group: system NAME VALUE SECURITY DESCRIPTION (get/set) hostname string[64] 1/6 Host name of server (Network Camera, Wireless Network Camera, Video Server, Wireless Video Server). ledoff 6/6 Turn on (0) or turn off (1) all led indicators. date , 6/6 Current date of system. Set to ‘keep’ to keep time datetime keep, date unchanged. Set to ‘auto’ to use NTP to auto synchronize date. , 6/6 Current time of the system.
PAGE 148
VIVOTEK -140: GMT-03:30 Newfoundland -120: GMT-03:00 Brasilia, Buenos Aires, Georgetown, Greenland -80: GMT-02:00 Mid-Atlantic -40: GMT-01:00 Azores, Cape_Verde_IS.
PAGE 149
VIVOTEK Caledonia 480: GMT 12:00 Aucklan, Wellington, Fiji, Kamchatka, Marshall Is. 520: GMT 13:00 Nuku'Alofa daylight_enable 6/6 Enable automaticdaylight saving time in time zone. daylight_dstactualmode 6/7 Check if current time is under daylight saving time. (Used internally) daylight_auto_begintime string[19] 6/7 Display the current daylight saving start time. daylight_auto_endtime string[19] 6/7 Display the current daylight saving end time.
PAGE 150
VIVOTEK user has uploaded. This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results. restoreexceptvadp 0, 7/6 Restore the system parameters to default values except the vadp parameters and VADP modules that stored in the system. This command can cooperate with other “restoreexceptXYZ” commands.
PAGE 151
VIVOTEK 7.1.1 system.info Subgroup of system: info (The fields in this group are unchangeable.) NAME VALUE SECURITY DESCRIPTION (get/set) modelname string[40] 0/7 Internal model name of the server extendedmodelname string[40] 0/7 ODM specific model name of server (eg. DCS-5610). If it is not an ODM model, this field will be equal to “modelname” serialnumber 0/7 12 characters MAC address (without hyphens).
PAGE 152
VIVOTEK xcount-1)> 7.2status Group: status NAME VALUE SECURITY DESCRIPTION (get/set) di_i<0~(capability_ndi-1)> 1/7 0 => Inactive, normal 1 => Active, triggered (capability.ndi > 0) do_i<0~(capability_ndo-1)> 1/7 0 => Inactive, normal 1 => Active, triggered (capability.ndo > 0) onlinenum_rtsp 0,
PAGE 153
VIVOTEK 7.5security Group: security NAME VALUE SECURITY DESCRIPTION (get/set) privilege_do view, operator, 1/6 admin Indicate which privileges and above can control digital output (capability.ndo > 0) privilege_camctrl view, operator, 1/6 admin Indicate which privileges and above can control PTZ (capability.ptzenabled > 0 or capability.
PAGE 154
VIVOTEK port occupied by another service currently. Otherwise, the service may fail. Stopped service will auto-start after changing port settings. Ex: Change HTTP port from 80 to 5556, and change RTP port for video from 5556 to 20480. Then, set preprocess=9 to stop both service first. ”/cgi-bin/admin/setparam.cgi? network_preprocess=9&network_http_port= 5556& network_rtp_videoport=20480” type lan, 6/6 Network connection type.
PAGE 155
VIVOTEK ca_time 0, ca_size 0, certificate_exist 6/6 Certificate installed flag (for TLS) certificate_time 0,
PAGE 156
VIVOTEK 7.6.3 IPV6 Subgroup of network: ipv6 (capability.protocol.ipv6 > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable IPv6. addonipaddress 6/6 IPv6 IP address. addonprefixlen 0~128 6/6 IPv6 prefix length. addonrouter 6/6 IPv6 router address. addondns 6/6 IPv6 DNS address. allowoptional 6/6 Allow manually setup of IP address setting. VALUE SECURITY DESCRIPTION 7.6.
PAGE 157
VIVOTEK etc. anonymousviewing 1/6 Enable anonymous streaming viewing. 7.6.6 HTTPS port Subgroup of network: https (capability.protocol.https > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 443, 1025 ~ 65535 1/6 HTTPS port. 7.6.7 RTSP Subgroup of network: rtsp (capability.protocol.rtsp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) port 554, 1025 ~ 65535 1/6 RTSP port. (capability.protocol.rtsp=1) anonymousviewing 1/6 Enable anoymous streaming viewing.
PAGE 158
VIVOTEK 7.6.7.1 RTSP multicast Subgroup of network_rtsp_s<0~(n-1)>: multicast n is stream count NAME VALUE SECURITY DESCRIPTION (get/set) alwaysmulticast 4/4 Enable always multicast. ipaddress 4/4 Multicast video IP address. * We replace "network_rtsp_s<0~(n-1)>_multicast_ipaddress" with " network_rtsp_s<0~(n-1)>_multicast_videoipaddre ss ".
PAGE 159
VIVOTEK 7.6.9 RTP port Subgroup of network: rtp NAME VALUE SECURITY DESCRIPTION (get/set) videoport 1025 ~ 65535 6/6 Video channel port for RTP. (capability.protocol.rtp_unicast=1) audioport 1025 ~ 65535 6/6 Audio channel port for RTP. (capability.protocol.rtp_unicast=1) metadataport 1025 ~ 65535 6/6 Metadata channel port for RTP. 7.6.10 PPPoE Subgroup of network: pppoe (capability.protocol.
PAGE 160
VIVOTEK address> ipv6list_i<0~9> string[43] 6/6 IPv6 address list. VALUE SECURITY DESCRIPTION 7.8Video input Group: videoin NAME (get/set) cmosfreq 50, 60 4/4 CMOS frequency. (capability.videoin.type=2) whitebalance auto, 4/4 Modes of white balance. manual, "auto": Auto white balance rbgain, "rbgain": Use rgain and bgain to set white widerange, balance manually. outdoor, "manual": 2 cases: indoor, a.
PAGE 161
VIVOTEK 5: EV -0.3 6: EV 0 7: EV +0.3 8: EV +0.7 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.0 irismode fixed, indoor, 4/4 Control DC-Iris mode. outdoor "outdoor": Auto-setting DC-Iris to get best in indoor environment. "indoor": Avoid rolling and flicker effect first. "fixed": Open the iris to maximum.
PAGE 162
VIVOTEK Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only) text string[64] 1/4 Enclose caption. imprinttimestamp 4/4 Overlay time stamp on video. minexposure <1~32000>, 4/4 Minimum exposure time <5~32000>, 1~32000 => 1s ~ 1/32000s <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc.
PAGE 163
VIVOTEK axrange" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Only available when "capability_image_c<0~(n-1)>_exposure_ra ngetype" is "twovalues". enablepreview 1/4 Usage for UI of exposure settings. Preview settings of video profile. 7.8.
PAGE 164
VIVOTEK * Only available when "capability_image_c<0~(n-1)>_wbm ode" !="-" 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)>_wbm ode". * 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. 0: Weak <-> 100: Strong * Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbm ode".
PAGE 165
VIVOTEK 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.0 exposuremode auto, 4/4 Select exposure mode. irispriority, "auto": Automatically adjust the Iris, qualitypriority, Gain and Shutter Speed to fit the manual, exposure level. etc "shutterpriority": Manually adjust with variable Shutter Speed, and keep (Available options are list in adjusting Iris, Gain automatically.
PAGE 166
VIVOTEK effect first. "manual": Manual set P-Iris by "piris_position". "-": not support. (only available when "capability_image_c<0~(n-1)>_sens ortype" is "smartsensor") * Only available when "capability_image_c<0~(n-1)>_iristy pe"=piris piris_position 1~100 1/4
PAGE 167
VIVOTEK mingain 0~100 4/4 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_ mingain" != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_expo sure_rangetype" is "twovalues". gainvalue 0~100 4/4 Gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_ maxgain" != "-" and "capability_image_c<0~(n-1)>_expo sure_rangetype" is "onevalue".
PAGE 168
VIVOTEK Bit 2 => Support pan operation; 0(not support), 1(support) Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 => Support zoom operation; 0(not support), 1(support) Bit 5 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only) text string[64] 1/4 Enclose caption. imprinttimesta 4/4 Overlay time stamp on video. top, bottom 4/4 Text on video string position 20~40 4/4 Text on video font size textonvideo_fon /usr/share/font/Default.
PAGE 169
VIVOTEK dependent> <1~8000>, 5~32000 => 1/5s ~ 1/32000s <5~8000>, 1~8000 => 1s ~ 1/8000s etc. 5~8000 => 1/5s ~ 1/8000s etc. * Available value is listed in "capability_image_c<0~(n-1)>_expo * This parameter may also restrict sure_maxrange" image frame rate from sensor due to sensor generates a frame per exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.
PAGE 170
VIVOTEK "capability_image_c<0~(n-1)>_expo sure_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. enablepreview 1/4 Usage for UI of exposure settings. Preview settings of video profile. crop_position 1/7 Crop left-top corner coordinate. 1/7 Crop width and height.
PAGE 171
VIVOTEK * We support this parameter when the version number (httpversion) is equal or greater than 0301c. s<0~(m-1)>_h 250, 500, 1000, 2000, 3000, 4000 4/4 264_intraperiod The time interval between two I-frames (Intra coded picture). The unit is millisecond (ms). s<0~(m-1)>_h cbr, vbr 4/4 cbr: Constant bit rate mode. 264_ratecontrol vbr: Fixed quality mode, all frames are mode encoded in the same quality.
PAGE 172
VIVOTEK bit rate. * Only valid when "ratecontrolmode"= vbr s<0~(m-1)>_h 1~5, 100 4/4 264_cbr_quant Set the pre-defined quality level: 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only available when "ratecontrolmode"= cbr. * Only available when "capability_smartstream_version"=2. 0 s<0~(m-1)>_h 1~100 4/4 Select customized quality in a 264_cbr_qperce normalized full range.
PAGE 173
VIVOTEK (n-1)>_resolution") are recorded in "capability_videoin_c<0~(n-1)>_h26 4_maxframerate" s<0~(m-1)>_h 0~2 1/4 264_profile Indicate H264 profiles 0: baseline 1: main profile 2: high profile s<0~(m-1)>_h 4/4 Enable "Dynamic intra frame period". 265_dintraperio * Only available when d_enable "capability_videoin_c<0~(n-1)>_dint raperiod_support" is 1 and h265 is listed in "capability_videoin_codec".
PAGE 174
VIVOTEK "ratecontrolmode"= vbr. s<0~(m-1)>_h 0~51 4/4 265_qvalue Manual video quality level input. The Q value which is used by encoded library directly. * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= vbr and s<0~(m-1)>_h265_quant = 99. s<0~(m-1)>_h 1~100 4/4 265_qpercent Select customized quality in a normalized full range. 1: Worst quality 100: Best quality * Only available when h265 is listed in "capability_videoin_codec".
PAGE 175
VIVOTEK "ratecontrolmode"= cbr. * Only available when "capability_smartstream_version"="2 .0" s<0~(m-1)>_h 1~100 4/4 Select customized quality in a 265_cbr_qperce normalized full range. nt 1: Worst quality 100: Best quality * Only available when h265 is listed in "capability_videoin_codec". * Only valid when "ratecontrolmode"= cbr and "quant"= 100. * Only available when "capability_smartstream_version"="2 .
PAGE 176
VIVOTEK 1: main profile 2: high profile * Only available when h265 is listed in "capability_videoin_codec". s<0~(m-1)>_m cbr, vbr 4/4 cbr: Constant bit rate mode. jpeg_ratecontro vbr: Fixed quality mode, all frames are lmode encoded in the same quality. s<0~(m-1)>_m 1~5, jpeg_quant 99, 100 4/4 * Only valid when "ratecontrolmode"= vbr.
PAGE 177
VIVOTEK jpeg_maxvbrbit )>_mjpeg_maxbitrate" quality mode. rate When the bit rate exceeds this value, frames will be dropped to restrict the bit rate. * Only valid when "ratecontrolmode"= vbr s<0~(m-1)>_m 1~5, 100 4/4 jpeg_cbr_quant Set the pre-defined quality level: 1: Medium 2: Standard 3: Good 4: Detailed 5: Excellent 100: Use the quality level in "cbr_qpercent" * Only available when "ratecontrolmode"= cbr. * Only available when "capability_smartstream_version"="2 .
PAGE 178
VIVOTEK jpeg_maxframe mjpeg_maxframerate" stream at different resolutions("capability_videoin_c<0~ (n-1)>_resolution") are recorded in "capability_videoin_c<0~(n-1)>_mjp eg_maxframerate" wdrpro_mode 4/4 Enable WDR pro * Only available when "capability_image_c<0~(n-1)>_wdrp ro_mode" > 0 wdrpro_strengt 1~100 4/4 The strength of WDR Pro. h The bigger value means the stronger
PAGE 179
VIVOTEK The higher speed level meas shorter AE converged time during AE executing. * Only available when "capability_image_c<0~(n-1)>_aesp eed" is 1 aespeed_sensiti 1~100 4/4 The sensitivity of AE converge speed. vity 1~20: level 1 41~60: level 3 61~80: level 4 81~100: level 5 Level 1~4(low ~ high) The higher sensitivity level meas that it is easy to be trigger while scene changed.
PAGE 180
VIVOTEK sheyedewarpmo mount “1O” is original mode (disable). de ‘1O, 1P, 1R, 4R’ for wall mount Supported dewarp mode is different by mount type.
PAGE 181
VIVOTEK non-ROI areas. The level is from 1 to 5. Level 5 is the maximum level of the quality difference between the ROI and non-ROI areas. If the value is a negative number, the video quality of non-ROI areas is better than the ROI. The level is from -1 to -5. Level -5 is the maximum level of the quality difference between the ROI and non-ROI areas. Group: videoin_c<0~(n-1)>_s<0~(m-1)>_h264_smartstream2_win_i<0~(k-1)> (capability_smartstream_support=1, capability_smartstream_version=2.
PAGE 182
VIVOTEK 7.8.1.1 Alternative video input profiles per channel In addition to the primary setting of video input, there can be alternative profile video input setting for each channel which might be for different scene of light (daytime or nighttime). Group: videoin_c<0~(n-1)>_profile_i<0~(m-1)> for n channel profucts and m profile n denotes the value of "capability_nvideoin" and m denotes the value of "capability_nvideoinprofile" (capability.
PAGE 183
VIVOTEK * Available value is listed in * This parameter may also restrict image "capability_image_c frame rate from sensor due to sensor <0~(n-1)>_exposu generates a frame per exposure time. Ex: If re_maxrange" this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.
PAGE 184
VIVOTEK * Not support this parameter 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.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.
PAGE 185
VIVOTEK 0302a. whitebalance auto, 4/4 Modes of white balance. manual, "auto": Auto white balance rbgain, "rbgain": Use rgain and bgain to set white widerange, balance manually. outdoor, "manual": 2 cases: indoor, a. if "rbgain" is not supported, this means sodiumauto, keep current white balance status. etc b. if "rbgain" is supported, "rgain" and "bgain" are updated to the current values (Available values are which is got from white balance module.
PAGE 186
VIVOTEK 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_maxgain " != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range. * Only available when "capability_image_c<0~(n-1)>_exposure_ra ngetype" is "twovalues". mingain 0~100 4/4 Minimum gain value. 0: Low <-> 100: High * Only available when "capability_image_c<0~(n-1)>_agc_mingain " != "-" * Only valid when "piris_mode"=manual or "irismode"=fixed * Normalized range.
PAGE 187
VIVOTEK "indoor": Avoid rolling and flicker effect first. "manual": Manual set P-Iris by "piris_position". "-": not support (only available when "capability_image_c<0~(n-1)>_sensortype" is "smartsensor") * Only available when "capability_image_c<0~(n-1)>_iristype"=piri s piris_position 1~100 1/4 Manual set P-Iris.
PAGE 188
VIVOTEK "capability_image_c<0~(n-1)>_wdrc_mode" is 1 wdrc_strength 1~100 4/4 The strength of WDR enhanced. The bigger value means the stronger strength of WDR enhanced. * Only available when "capability_image_c<0~(n-1)>_wdrc_mode" is 1 aespeed_mode 4/4 Turning AE converge speed on or off.
PAGE 189
VIVOTEK * Only available when "capability_image_c<0~(n-1)>_flickerless" is 1 7.9Time Shift settings Group: timeshift for n channel profucts and m stream n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream" (capability.timeshift > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable 4/4 Enable time shift streaming. c<0~(n-1)>_s<0~(m-1) 4/4 Enable time shift streaming for specific >_allow stream. 7.
PAGE 190
VIVOTEK n"-1>_externalir > 0) extledmode do, irring 6/6 Turn on an external IR led which is mounted do * Available values (digital output) device or is a IR ring device. are listed in * Only available when "capability_daynight "capability_daynight_c<0~"capability_nvideoi _c<0~(n-1)>_extle n"-1>_externalir" is 1. d_interface" * Only valid when "ircutcontrol_enableextled" is 1. bwmode 6/6 Switch to B/W in night mode if enabled.
PAGE 191
VIVOTEK 7.11 Image setting per channel Group: image_c<0~(n-1)> for n channel profucts and m profile n denotes the value of "capability_nvideoin" and m denotes the value of "capability_nvideoinprofile" NAME VALUE SECURITY DESCRIPTION (get/set) brightness -5~5,100 4/4 -5: Darker <-> 5: Bright 100: Use " image_c_brightnesspercent" * Only available when bit 0 of "capability_image_c<0~(n-1)>_basicsetting" is 1 * We replace "brightness" with "brightnesspercent".
PAGE 192
VIVOTEK "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: Softer <-> 3: Sharper 100: Use " image_c<0~(n-1)>_sharpnesspercent" * Only available when bit 3 of "capability_image_c<0~(n-1)>_basicsetting" is 1. * We replace "sharpness" with "sharpnesspercent". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
PAGE 193
VIVOTEK 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 ... 100: Gamma value = 1 * Note: Although we set gamma value to 100 level, but not all gamma values are valid. Internal module will take the closest valid one. For example, 1~45 may all be mapped to gamma value = 0.45, etc.
PAGE 194
VIVOTEK 1:enable * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mode". eis_strength 1~100 4/4 Strength of electronic image stabilizer * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mode". dis_mode 4/4 Digital image stabilizer 0:disable 1:enable * Only available when 'dis' is listed in "capability_image_c<0~(n-1)>_is_mode".
PAGE 195
VIVOTEK profile_i<0~(m-1)>_begintime hh:mm 4/4 Begin time of schedule mode. profile_i<0~(m-1)>_endtime hh:mm 4/4 End time of schedule mode. profile_i<0~(m-1)>_brightness -5~5,100 4/4 -5: Darker <-> 5: Bright 100: Use " image_c<0~(n-1)>_brightnesspercent" * Only available when bit 0 of "capability_image_c<0~(n-1)>_basicsetting" is 1 * We replace "profile_i0_brightness" with "profile_i0_brightnesspercent".
PAGE 196
VIVOTEK greater than 0400a. profile_i<0~(m-1)>_sharpness -3~3,100 4/4 -5: Less saturation <-> 5: More saturation 100: Use " image_c<0~(n-1)>_saturationpercent" * Only available when bit 2 of "capability_image_c<0~(n-1)>_basicsetting" 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.
PAGE 197
VIVOTEK 2: Gamma value = 0.02 3: Gamma value = 0.03 ... 100: Gamma value = 1 * Note: Although we set gamma value to 100 level, but not all gamma values are valid. Internal module will take the closest valid one. For example, 1~45 may all be mapped to gamma value = 0.45, etc. * Only available when "capability_image_c<0~(n-1)>_gammacurve " is 1 profile_i<0~(m-1)>_lowlightm 4/4 Enable/disable low light mode.
PAGE 198
VIVOTEK profile_i<0~(m-1)>_eis_streng 1~100 4/4 Strength of electronic image stabilizer th * Only available when 'eis' is listed in "capability_image_c<0~(n-1)>_is_mode". profile_i<0~(m-1)>_dis_mode 4/4 Digital image stabilizer 0:disable 1:enable * Only available when 'dis' is listed in "capability_image_c<0~(n-1)>_is_mode".
PAGE 199
VIVOTEK 7.12 Exposure window setting per channel Group: exposurewin_c<0~(n-1)> for n channel profucts n denotes the value of "capability_nvideoin" (Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1) NAME VALUE SECURITY DESCRIPTION (get/set) mode auto, custom,blc,hlc 4/4 "auto": Use full image view as the only exposure window. * Available values are listed in "custom": Use custom windows.
PAGE 200
VIVOTEK ndomain". homepx <0~W,0~H> 4/4 Left-top corner coordinate of the window. W: 0~ The current image width -1 * Only available when px is listed in H: 0~ The current image height -1 "capability_image_c<0~(n-1)>_exposure_wi ndomain". sizepx <0~Wx0~ H> 4/4 Width and height of the window. W: 0~ The current image width -1 * Only available when px is listed in H: 0~ The current image height -1 "capability_image_c<0~(n-1)>_exposure_wi ndomain".
PAGE 201
VIVOTEK Group: exposurewin_c<0~(n-1)>_profile_i<0~(m-1)>_win_i<0~(k-1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the value of "capability_nvideoinprofile", k denotes the value of "capability_image_c<0~(n-1)>_exposure_winnum".
PAGE 202
VIVOTEK * Only available when std is listed in "capability_image_c<0~(n-1)>_exposure_wi ndomain". 7.13 Audio input per channel Group: audioin_c<0~(n-1)> for n channel products (capability.naudioin>0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) source micin, linein dependent> 4/4 micin => use built-in microphone input. linein => use external microphone input.
PAGE 203
VIVOTEK 0: Minimum 100: Maximum * Only available when the channel supports external microphone (The related bit of "capability_audio_extmic" is equal to 1). mute 0, 1 1/4 0: Mute off 1: Mute on gain 0~100 4/4 _source = linein) this> * Reserved for compatibility, and suggest don't use this since the version number (httpversion) is equal or greater than 0301a. * We replace "gain" with "volume_internal" and "volume_external".
PAGE 204
VIVOTEK 96000, 128000 s0_gamr_bitrate 4750, 4/4 AMR encoded bitrate in bps. 5150, 5900, * Only available if AMR is supported. 6700, 7400, 7950, 10200, 12200 s0_g711_mode pcmu, 4/4 pcma Set G.711 companding algorithm. pcmu: µ-law algorithm pcma: A-law algorithm * Only available if G.711 is supported. s0_g726_bitrate 16000, 4/4 Set G.726 encoded bitrate in bps. 24000, * Only available if G.726 is supported. 32000, 40000 s0_g726_bitstreampackin little, big 4/4 gmode Set G.
PAGE 205
VIVOTEK profile_i0_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. profile_i0_begintime hh:mm 4/4 Begin time of schedule mode. profile_i0_endtime hh:mm 4/4 End time of schedule mode. profile_i0_alarm_level 1~100 4/4 Audio detection alarm level 7.
PAGE 206
VIVOTEK * 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. H, 0 ~ W,0 ~ H * Only available when W: 0~ The current "capability_motion_wintype" = polygon. image width -1 H: 0~ The current * Only available when px is listed in image height -1 "capability_motion_windomain".
PAGE 207
VIVOTEK this> "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. width 0 ~ 320 4/4 Width of motion detection window. "capability_motion_wintype" = rectangle. * Only available when qvga is listed in "capability_motion_windomain".
PAGE 208
VIVOTEK * Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a. begintime hh:mm 4/4 Begin time of schedule mode. endtime hh:mm 4/4 End time of schedule mode. win_sensitivity 0 ~ 100 4/4 Sensitivity of all motion detection windows. * The value "0" is reserved for compatibility and will not be used after the version number (httpversion) is equal or greater than 0400a.
PAGE 209
VIVOTEK image height -1 "capability_motion_windomain". * It's recommended to use polygonsd * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a. polygon 0 ~ 320,0 ~ 240, 0 4/4 Coordinate of polygon window position. 320,0 ~ 240, 0 ~ * Only available when 320,0 ~ 240 "capability_motion_wintype" = polygon.
PAGE 210
VIVOTEK width 0 ~ 320 4/4 Width of motion detection window. "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. height 0 ~ 240 4/4 Height of motion detection window.
PAGE 211
VIVOTEK 7.15 Tampering detection settings Group: tampering_c<0~(n-1)> for n channel products (capability.tampering > 0) n denotes the value of "capability_nvideoin" NAME VALUE SECURITY DESCRIPTION (get/set) enable 4/4 Enable or disable tamper detection. 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.
PAGE 212
VIVOTEK 7.16 DDNS Group: ddns (capability.protocol.ddns > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Enable or disable the dynamic DNS. provider CustomSafe100, 6/6 Safe100 => safe100.net DyndnsDynamic, DyndnsDynamic => dyndns.org (dynamic) DyndnsCustom, DyndnsCustom => dyndns.org Safe100 CustomSafe100 => Custom server using safe100 method _hostname string[128] 6/6 Your DDNS hostname.
PAGE 213
VIVOTEK service. 7.19 UPnP port forwarding Group: upnpportforwarding 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.20 System log Group: syslog NAME VALUE SECURITY DESCRIPTION (get/set) enableremotelog 6/6 Enable remote log.
PAGE 214
VIVOTEK 7.21 SNMP Group: snmp (capability.protocol.snmp > 0) NAME VALUE SECURITY DESCRIPTION (get/set) v2 6/6 SNMP v2 enabled. 0 for disable, 1 for enable v3 6/6 SNMP v3 enabled.
PAGE 215
VIVOTEK 7.22 Layout configuration Group: layout NAME VALUE SECURITY DESCRIPTION (get/set) logo_default 1/6 0 => Custom logo 1 => Default logo logo_link string[128] 1/6 Hyperlink of the logo 1/6 0 => display the power by vivotek logo http://www.vivotek.
PAGE 216
VIVOTEK 7.23 Privacy mask Group: privacymask_c<0~(n-1)> for n channel products and m privacy mask window. n denotes the value of "capability_nvideoin" and m denotes the value of "capability_videoin_c<0~(n-1)>_nprivacymask" NAME VALUE SECURITY DESCRIPTION (get/set) enable 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.
PAGE 217
VIVOTEK 0 ~ W,0 ~ H "capability_image_c<0~(n-1)>_privacymask W: 0~ The current _wintype" = polygon. image width -1 H: 0~ The current * Only available when px is listed in image height -1 "capability_image_c<0~(n-1)>_privacymask _windomain". win_i<0~(m-1)>_polygo 0 ~ 9999,0 ~ 9999, 4/4 Coordinate of polygon window position.
PAGE 218
VIVOTEK "capability_ptz_c<0~(n-1)> _maxzoom" win_i<0~(m-1)>_fliped 4/4 Flip side of window position. 0: Non-flip side 1: Flip side 7.25 Capability Group: capability NAME VALUE SECURITY DESCRIPTION (get/set) api_httpversion 0/7 The version of VIVOTEK WebAPI with 4 This number start integers plus 1 alphabet, There are composed with 0301a. by "major version", "minor version", "revision","_platform".
PAGE 219
VIVOTEK EX: 0302b_1 => Major version = 03, minor version = 02, revision = b, platform = 1 The 4 integer numbers are WebAPI version, we use short name: [httpversion] for it in this document. The 5th character is model-based version for API bug-fix and it's default to "a". Ex: If some APIs in a model does not follow the API definition of 0301a_1, we will fix them and change this API value to 0301b_1. bootuptime 0/7 Server bootup time. nir 0, 0/7 Number of IR interfaces.
PAGE 220
VIVOTEK naudiosetting 0/7 Number of audio settings per channel. * Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a. * We replace "naudiosetting" with "naudioin". More details, please refer the parameter description of "volume_internal" and "volume_external". nuart 0, 0/7 Number of UART interfaces. nmotion 0/7 The number of motion window.
PAGE 221
VIVOTEK event/control transfer. joystick 0/7 Indicate whether to support joystick control. remotefocus 0, 0/7 An 4-bit integer, which indicates the supportive If the value of this parameter is larger than 0, it means that the camera supports remotefocus function. bit 0 => Indicate whether to support both zoom and focus function. bit 1 => Only support zoom function. bit 2 => Only support focus function.
PAGE 222
VIVOTEK channel, bit 10~19 are the 2nd group for 2nd channel, bit 20~31 are the 3rd group for 3rd channel. Then, the 1st bit of the group indicates 1st stream of a channel support ePTZ or not. The 2nd bit of the group indicates 2nd stream of a channel support ePTZ or not, and so on. * For most products, the last stream of a channel will not support ePTZ. It is reserved for full view of the channel. For some dual-stream products, both streams support ePTZ.
PAGE 223
VIVOTEK dependent> "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 * Only available when [httpversion] >= 0301a storage_dbenabled 0/7 Media files are indexed in database.
PAGE 224
VIVOTEK 2 => CMOS videoin_nresolution 0/7 This equals "capability_videoin_c0_nresolution". * This is kept for compatibility. videoin_resolution A list of 0/7 * This is kept for compatibility. videoin_maxframerate A list of 0/7 This equals "capability_videoin_c0_maxframerate". * This is kept for compatibility.
PAGE 225
VIVOTEK element depends on "capability_nvideooout". "-": Video-out is not available ntsc: NTSC analog output pal: PAL analog output Ex: "nvideoout"=0, "videoout_codec"="nvideoout"=1 with NTSC, "videoout_codec"=ntsc "nvideoout"=1 with PAL, "videoout_codec"=pal "nvideoout"=2 with both NTSC, "videoout_codec"=ntsc,ntsc * For camera, this feature is controlled by physical jump on device. No WebAPI to control it. This value is set only on camera power-on and maintains the status.
PAGE 226
VIVOTEK name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (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.
PAGE 227
VIVOTEK the version number (httpversion) is equal or greater than 0301a. * We replace "audio_mic" with "audio_intmic". audio_intmic <0~Positive 0/7 Integer> Internal (Built-in) Microphone. 0: Not support 1: Support Bit 0 for CH0, bit 1 for CH1, and so on. audio_extmic <0~Positive 0/7 Integer> External Microphone. 0: Not support 1: Support Bit 0 for CH0, bit 1 for CH1, and so on. audio_alarm <0~Positive 0/7 Integer> 0: Not support audio alarm. 1: Support audio alarm.
PAGE 228
VIVOTEK motion_wintype rectangle, polygon 0/7 The supported motion window type. polygon: The window is a 2D polygon shape. rectangle: The window is a 2D rectangle shape. motion_windomain qvga, px, std, - 0/7 The domain to set an motion window. qvga: a 320x240 range to represent the whole image. px: Locate a window in the image with pixels. std: A normalized 0~9999 range. -: Not supported.
PAGE 229
VIVOTEK * Only available when "capability_smartstream_support" is 1 smartstream_nwindow_m 0/7 anual Maximum number of tracking window of manual. * Only available when "capability_smartstream_support" is 1 smartstream_nwindow_h 0/7 ybrid_autotracking Maximum number of tracking window of autotracking in hybrid mode.
PAGE 230
VIVOTEK * This is kept for compatibility. camctrl_privilege 0/7 Indicate whether to support “Manage Privilege” of PTZ control in the security page. 1: support both /cgi-bin/camctrl/camctrl.cgi and /cgi-bin/viewer/camctrl.cgi 0: support only /cgi-bin/viewer/camctrl.cgi This is equivalent to"capability_camctrl_c0_privilege". * This is kept for compatibility. uart_httptunnel 0/7 Indicate whether to support HTTP tunnel for UART transfer.
PAGE 231
VIVOTEK * Only available when "capability_network_wireless" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0305a. wireless_apmode_ssidpref 0/7 ix Indicate the prefix of broadcasted SSID when camera is in wireless AP mode. * Only available when "capability_wireless_apmode_enable" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0305a.
PAGE 232
VIVOTEK "-". * Note: For some box-type cameras, this value may be varied depending on mounted lens. * We replace "capability_image_iristype" with "capability_image_c0_iristype". * Reserved for compatibility, and suggest don't use this since [httpversion] > 0301a image_focusassist 0/7 Indicate whether to support focus assist. with "capability_image_c0_ focusassist".
PAGE 233
VIVOTEK remotecamctrl_master 0, Indicate whether to support remote auxiliary camera (master side), this value means supporting max number of auxiliary camera. remotecamctrl_slave 0/7 Indicate whether to support remote camera control (slave side). fisheyelocaldewarp_c<0~ 0, integer> 0/7 Indicate the supported streams of local dewarp. One bit represents one supported stream. The LSB indicates stream 0.
PAGE 234
VIVOTEK 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.
PAGE 235
VIVOTEK minpan 0, 0/7 The lower limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" maxpan 0, 0/7 The upper limit for pan position. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" minpanangle 0/7 The lower limit for pan angle. *Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" maxpanangle 0/7 The upper limit for pan angle.
PAGE 236
VIVOTEK minzoom 0, 0/7 The lower limit for zoom position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule" is "1" maxzoom 0, 0/7 The upper limit for zoom position. *Only available when the value of "capability_camctrl_c<0~(n-1)>_zoommodule" is "1" maxdzoom 0, 0/7 The upper limit for digital zoom position.
PAGE 237
VIVOTEK blackwhitemode 0/7 Indicate whether to support automatically switch to Black & White display during the night mode. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. ircutsensitivity_type 0/7 Indicate the cgi interface of "ircutcontrol_sensitivity". "options": the value of "ircutcontrol_sensitivity" parameter is "low, normal,high".
PAGE 238
VIVOTEK Group: capability_videoin_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) lens_type fisheye, fixed, 0/7 The lens type of this channel. varifocal, changeable, fisheye: Fisheye lens motor, - fixed: Build‐in fixed‐focus lens. varifocal: Build‐in varifocal lens. changeable: changeable lens. Like box‐type camera, users can install any C‐Mount or CS‐Mount lens as they wish.
PAGE 239
VIVOTEK 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. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value.
PAGE 240
VIVOTEK streamcodec 0/7 Represent supported codec types of each stream. This contains a list of positive integers, split by comma. Each one stands for a stream, and the definition is as following: Bit 0: Support MPEG4. Bit 1: Support MJPEG Bit 2: Support H.264 Bit 3: Support H.265 mode 0, 0/7 Indicate current video mode. nmode 0/7 Indicate how many video modes supported by this channel.
PAGE 241
VIVOTEK maxframerate A list of 0/7 Indicate frame rate that the video source outputs in current video mode. One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group. * This parameter may be changed when "videoin_c_cmosfreq"=50 or "videoin_c_modulation"=pal. Ex: 30 fps is changed to 25 fps, 60 fps is changed to 50 fps, and so on.
PAGE 242
VIVOTEK h264_maxframerate A list of and "-" Maximum fps that the device can encoded with H.264 on resolutions in current video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group. * This parameter may be changed when "videoin_c_cmosfreq"=50 or "videoin_c_modulation"=pal. Ex: 30 fps is changed to 25 fps, 60 fps is changed to 50 fps, and so on.
PAGE 243
VIVOTEK fisheye_mounttype ceiling, wall, floor 0/7 Indicate the supported type.
PAGE 244
VIVOTEK resolutionC4R A list of 0/7 Available resolutions of 4R mode of ceiling and floor mount. resolutionW1P A list of 0/7 Available resolutions of 1P mode of wall mount. resolutionW1R A list of 0/7 Available resolutions of 1R mode of wall mount. resolutionW4R A list of 0/7 Available resolutions of 4R mode of wall mount.
PAGE 245
VIVOTEK wdrpro 0, 1, 2 0/7 Indicate this mode whether support WDR pro. 0: Non-support WDR Pro 1: Support WDR Pro 2: Support WDR Pro and WDR Pro II * We support this parameter when the version number (httpversion) is equal or greater than 0304b. effectivepixel 0/7 The visible area of full scene in this video mode. The unit is pixel in source. * If "effectivepixel"<"capability_videoin_c<0~(n-1) >_maxsize", then the visible area is located at the center of full scene.
PAGE 246
VIVOTEK resolution A list of 0/7 Resolution options in this video mode. The last one is the maximum resolution in this video mode. * The element number is defined as "nresolution" in this group. maxresolution A list of 0/7 Represent supported maximum resolution of each stream in current video mode. * The element number is defined as "capability_nmediastream". minresolution A list of 0/7 Represent supported minimum resolution of each stream in current video mode.
PAGE 247
VIVOTEK maxfps_h264 A list of and "-" H.264 on resolutions in this video mode. "-" means not support. * One to one mapping to the resolution in "resolution". * The element number is defined as "nresolution" in this group. * This parameter records the frame rate when "videoin_c<0~(n-1)>_cmosfreq"=60 or "videoin_c<0~(n-1)>_modulation"=ntsc * Only available when 'h264' is listed in "capability_videoin_codec".
PAGE 248
VIVOTEK wdrpro_strength 0, 1 0/7 0: Non-support tuning strength of WDR Pro 1: Support tuning strength of WDR Pro * If "capability_image_c<0~(n-1)>_wdrp ro"=1, this may be either 0 or 1. wdrpro_supportlevel 0, 0/7 This contains a list of positive integers, split by comma. If "wdrpro_mode" =1, then the value indicate the support strength level of WDR Pro.
PAGE 249
VIVOTEK "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. 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.
PAGE 250
VIVOTEK : nonnegative integer - (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.blc:disabled:" which means blc exposure window is disabled.
PAGE 251
VIVOTEK 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_m ode" is not "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302a. is_supportlevel 0, 0/7 Indicate the support strength level of image stabilizer mode.
PAGE 252
VIVOTEK value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected.
PAGE 253
VIVOTEK name":"Policy":"Description" : nonnegative integer "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. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available.
PAGE 254
VIVOTEK 3dnr:unchanged:, or others The format is "Affect API name":"Policy":"Description" : nonnegative integer "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. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked.
PAGE 255
VIVOTEK mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here. 3dnr:unchanged:, or others The format is "Affect API name":"Policy":"Description" : nonnegative integer "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden.
PAGE 256
VIVOTEK scenemode_lpcstreet_aff -, 0/7 When scene mode is enabled, some ect minexposure:hidden:, features may become malfunction or mingain:hidden:, be forced to a given value. The wdrpro:unchanged:, affected functions are list here. 3dnr:unchanged:,or others The format is "Affect API : nonnegative integer name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it.
PAGE 257
VIVOTEK "capability_image_c<0~(n-1)>_ scenemode_support" is 1 wbmode auto, 0/7 Available white balance mode. manual, "-" means white balance is not rbgain, supported. widerange, outdoor,indoor, sodiumauto, iristype piris, 0/7 Indicate iris type. dciris, "piris": P-Iris - "dciris": DC-Iris "-": No Iris control support * Note: For some cameras, this value may be varied depending on mounted lens. sensortype rawsensor, 0/7 Indicate sensor type.
PAGE 258
VIVOTEK exposure_shuttervaluetyp fixed, 0/7 * One to one mapping to the mode e maximum, type in "exposure_modetype". - "fixed": The shutter value is the assigned value (videoin_c<0~(n-1)>_shuttervalue). "maximum": The shutter value can be up to the assigned value (videoin_c<0~(n-1)>_shuttervalue). "-": not support. * Only available when "capability_image_c<0~(n-1)>_expo sure_rangetype" is "onevalue". * We support this parameter when the version number (httpversion) is equal or greater than 0302a.
PAGE 259
VIVOTEK : nonnegative integer "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. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available.
PAGE 260
VIVOTEK en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here. exposurelevel:hidden:, or others The format is "Affect API name":"Policy":"Description" : nonnegative integer "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden.
PAGE 261
VIVOTEK "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_irisprioritymod -, 0/7 When exposure iris priority mode is e_affect exposurewin.mode.blc:hidd enabled, some features may become en:, malfunction or be forced to a given defog:disabled:, value. The affected functions are list wdrpro:disabled:, here.
PAGE 262
VIVOTEK integer or string or NULL. "-" means no feature is affected. * Only available when irispriority is listed in "capability_image_c<0~(n-1)>_ exposure_modetype" and "capability_image_c<0~(n-1)>_ exposure_mode" is 1. * We support this parameter when the version number (httpversion) is equal or greater than 0302a. exposure_qualitypriority -, 0/7 When exposure quality priority mode mode_affect exposurewin.mode.
PAGE 263
VIVOTEK which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when qualitypriority is listed in "capability_image_c<0~(n-1)>_ exposure_modetype" and "capability_image_c<0~(n-1)>_ exposure_mode" is 1.
PAGE 264
VIVOTEK - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected.
PAGE 265
VIVOTEK * Only available when hlc is listed in "capability_image_c<0~(n-1)>_ exposure_winmode". exposure_hlcmode_affect -, or others 0/7 When hlc mode is enabled, some features may become malfunction or be forced to a given value. The : nonnegative integer affected functions are list here. The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it.
PAGE 266
VIVOTEK * Only available when manual is listed in "capability_image_c<0~(n-1)>_ exposure_modetype" and hlc is listed in "capability_image_c<0~(n-1)>_ exposure_winmode". * We support this parameter when the version number (httpversion) is equal or greater than 0304a. exposure_wintype inclusive, 0/7 The supported exposure window type. exclusive, inclusive: The image inside a window is - the target area of exposure control. exclusive: The image inside a window is omitted by exposure control.
PAGE 267
VIVOTEK etc. "-" means maximum exposure time is not available. * When "exposure_mode"=0, this value must be set to "-". exposure_minrange "1,32000", 0/7 Available range for "1,8000", "videoin_c_minexposure" -, "1,32000" => 1s ~ 1/32000s or others "1,8000" => 1s ~ 1/8000s etc. "-" means minimum exposure time is not available. * When "exposure_mode"=0, this value must be set to "-". privacymask_wintype rectangle, 0/7 The supported mask window type.
PAGE 268
VIVOTEK "-" means "videoin_c_mingain" is not available. flickerless 0,1 0/7 0: Non-support flickerless 1: Support flickerless flickerlessaffect -, 0/7 When flickerless is enabled, some minexposure:hidden:, features may become malfunction or mingain:hidden:, be forced to a given value. The or others affected functions are list here.
PAGE 269
VIVOTEK "-" means no feature is affected. * When "flickerless" = 0, this value must be "-" defog_mode 0,1 0/7 0: Non-support defog 1: Support defog defog_strength 0, 1 0/7 0: Non-support tuning strength of defog 1: Support tuning strength of defog * If "capability_image_c<0~(n-1)>_defog _mode"=1, this may be either 0 or 1. defog_supportlevel 0, 0/7 The value indicate the support strength level of defog.
PAGE 270
VIVOTEK hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected.
PAGE 271
VIVOTEK than 0, it means that the camera supports remotefocus function in this channel. bit 0 => Indicate whether to support both zoom and focus function. bit 1 => Only support zoom function. bit 2 => Only support focus function. bit 3 => Currently, this is a reserved bit, and the default value is 0. focuswindomain qvga, px, std, - 0/7 The domain to set an focus window. qvga: a 320x240 range to represent the whole image. px: Locate a window in the image with pixels.
PAGE 272
VIVOTEK version number (httpversion) is equal or greater than 0302a. * Only available when "capability_image_c<0~(n-1)>_sens ortype" is "smartsensor" Group: capability_peripheral_c<0~(n-1)> n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) devicecontrol 0/7 Indicate whether to support the peripheral device control. * We support this parameter when the version number (httpversion) is equal or greater than 0305c.
PAGE 273
VIVOTEK 7.26 Customized event script Group: event_customtaskfile_i<0~2> PARAMETER VALUE SECURITY DESCRIPTION (get/set) name string[40] 6/6 Custom script identification of this entry. date string[4~20] 6/6 Date of custom script. time string[4~20] 6/6 Time of custom script. 7.27 Event setting Group: event_i<0~2> 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.
PAGE 274
VIVOTEK di 0, 6/6 Indicate the source id of di trigger. This field is required when trigger condition is “di”. One bit represents one digital input. The LSB indicates DI 0. mdwin 0, 6/6 Indicate the source window id of motion detection. This field is required when trigger condition is “md”. One bit represents one window. The LSB indicates the 1st window. For example, to detect the 1st and 3rd windows, set mdwin as 5.
PAGE 275
VIVOTEK 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 Begin time of the weekly schedule. endtime hh:mm 6/6 End time of the weekly schedule.
PAGE 276
VIVOTEK action_goto_name string[40] 6/6 Specify the preset name that ptz goto on event triggered. * Only available when capability_ptzenabled > 0. action_goto_sync 6/6 Capture media after moving to the location.
PAGE 277
VIVOTEK email_sslmode 6/6 Enable support SSL. email_port 0~65535 6/6 Port to connect to the server. email_username string[64] 6/6 Username to log in to the server. email_passwd string[64] 7/6 Password of the user. email_senderemail string[128] 6/6 Email address of the sender. email_recipientemail string[640] 6/6 Email address of the recipient. ns_location string[128] 6/6 Location to upload or store the media.
PAGE 278
VIVOTEK snapshot_preevent 0~" 6/6 capability_media_snapshot_maxpr Indicates the number of pre-event images. eevent" snapshot_postevent 0~" 6/6 capability_media_snapshot_maxpo Indicates the number of post-event images. stevent" videoclip_source 0~"capability_nmediastream"-1 6/6 Indicate the source of media stream. 0 means the first stream. 1 means the second stream and etc. 2 means the third stream and etc. 3 means the fourth stream and etc.
PAGE 279
VIVOTEK 7.30 Recording Group: recording_i<0~1> 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. priority 0, 1, 2 6/6 Indicate the priority of this recording: “0” indicates low priority.
PAGE 280
VIVOTEK notifyserver 0~31 6/6 Indicate which notification server is scheduled. One bit represents one application server (server_i0~i4). bit0 (LSB) = server_i0. bit1 = server_i1. bit2 = server_i2. bit3 = server_i3. bit4 = server_i4. For example, enable server_i0, server_i2, and server_i4 as notification servers; the notifyserver value is 21. weekday 0~127 6/6 Indicate which weekday is scheduled. One bit represents one weekday.
PAGE 281
VIVOTEK maxduration 60~3600 6/6 Unit: Second When this condition is reached, recording file is truncated. 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) 7.31 HTTPS Group: https (capability.protocol.
PAGE 282
VIVOTEK commonname string[64] 6/6 Common name in the certificate information. 6/6 Valid period for the certification. www.vivotek.com validdays 0 ~ 3650 7.32 Storage management setting Group: disk_i<0~(n-1)> n is the total number of storage devices. (capability.storage.dbenabled > 0) Currently it’s only for local storage (SD, CF card), so n is equal to 1. PARAMETER VALUE SECURITY DESCRIPTION (get/set) cyclic_enabled 6/6 Enable cyclic storage method.
PAGE 283
VIVOTEK maxretentiontime_recordin 6/6 g_enabled Enable automatic clean up method for video clip generated by recording task. The parameter takes effect when autocleanup_enabled is enabled. maxretentiontime_recordin 6/6 g_i <0~1>_maxage 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.
PAGE 284
VIVOTEK 7.33 Region of interest Group: roi_c<0~(n-1)> for n channel product and m is the index of video stream which support ePTZ. (capability.eptz > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) s<0~(m-1)>_home 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.
PAGE 285
VIVOTEK 7.34 ePTZ setting Group: eptz_c<0~(n-1)> for n channel product. (capability.eptz > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) osdzoom 1/4 * Reserved for compatibility, and suggest don't use this since [httpversion] > 0302a * We replace "eptz_c<0~(n-1)>_osdzoom" with " videoin_c<0~(n-1)>_zoomratiodisplay".
PAGE 286
VIVOTEK Group: eptz_c<0~(n-1)>_s<0~(m-1)> for n channel product and m is the index of video stream which support ePTZ. (capability.eptz > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) patrolseq string[120] 1/4 The patrol sequence of ePTZ. All the patrol position indexes will be separated by "," patroldwelling string[160] 1/4 The dwelling time (unit: second) of each patrol point, separated by “,”. preset_i<0~19>_name string[40] 1/4 Name of ePTZ preset.
PAGE 287
VIVOTEK 7.36 Seamless recording setting Group: seamlessrecording (capability.localstorage.seamless> 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) diskmode seamless, 1/6 manageable “seamless” indicates enable seamless recording. “manageable” indicates disable seamless recording. maxconnection 3 1/7 Maximum number of connected seamless streaming. enable 1/7 Indicate whether seamless recording is recording to local storage or not at present.
PAGE 288
VIVOTEK number string[128] 6/7 This number is used to register license key for VADP application. Group: vadp_module_i<0~(n-1)> for n VADP package number (capability_vadp_npackage > 0) n denotes the value of "capability_vadp_npackage". NAME VALUE SECURITY DESCRIPTION (get/set) enable 6/6 Indicate if the module is enabled or not. If yes, also add the index of this module to the module_order. name string[40] 6/6 Module name extendedname string[40] 6/6 Extended module name.
PAGE 289
VIVOTEK endtime hh:mm 6/6 VALUE SECURITY End time of the schedule Group: vadp_event NAME DESCRIPTION (get/set) ntrigger 0, 6/7 Indicate the number of topics to be transferred to event manager for trigger. triggerlist_i<0~(n-1)>_to string[256] 6/6 pic Indicate the event notification with this topic will be transferred to event manager as trigger. n is equal to ntrigger above. 7.38 camera PTZ control Group: camctrl (capability.camctrl.
PAGE 290
VIVOTEK 2: enable PTZ commands with UART tunnel. * Only available when bit7 of capability_ptzenabled is 1 disablemdonptz 1/4 Disable motion detection on PTZ operation. 7.
PAGE 291
VIVOTEK 1: enable PTZ commands with PTZ driver. 2: enable PTZ commands with UART tunnel. * Only available when bit7 of capability_ptzenabled is 1 preset_i<0~(k-1)>_name string[40] 1/4 Name of the preset location. preset_i<0~(k-1)>_zoom capability_ptz_c<0~(n-1) 1/4 Zoom position at each preset location. 1/4 Focus position at each preset location.
PAGE 292
VIVOTEK >_maxfocus digitalzoom 1/4 Enable/disable digital zoom zoomenhance 1/4 Enable /disable zoom enhancement 7.
PAGE 293
VIVOTEK >_maxpan preset_i<0~(k-1)>_tilt capability_ptz_c<0~(n-1) 1/4 Tilt position at each preset location. 1/4 Zoom position at each preset location. 1/4 Focus position at each preset location.
PAGE 294
VIVOTEK axisf capability_ptz_c<0~(n-1) 1/4 Custom home focus position. >_minfocus ~ capability_ptz_c<0~(n-1) >_maxfocus axisflip 1/4 Custom home flip side. returnhome 1/4 Enable/disable return home while idle. returnhomeinterval 1~999 1/4 While idle over this time interval, idle action will be taken.
PAGE 295
VIVOTEK 7.41 UART control Group: uart (capability.nuart > 0 and capability.fisheye = 0) NAME VALUE SECURITY DESCRIPTION (get/set) ptzdrivers_i<0~19, string[40] 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 UART. 127>_name ptzdrivers_i<0~19, 127>_location enablehttptunnel Group: uart_i<0~(n-1)> n is uart port count (capability.nuart > 0 and capability.
PAGE 296
VIVOTEK 7.42 UART control (SD series) Group: uart_i<0~(n-1)> n is uart port count (capability.nuart > 0 and the bit7 of capability_ptzenabled is 0, the bit4 of capability_ptzenabled is 1) NAME VALUE SECURITY DESCRIPTION (get/set) cameraid 1~255 4/4 Camera ID controlling external PTZ camera. Note: Please set your speed dome to the appropriate baud rate, and Camera ID, e.g. 2400bps, camera ID 1,2,3,,,,etc. All Camera IDs on the same controlling system (NVR or rs485 keyboard) have to be distinct.
PAGE 297
VIVOTEK 7.43 Lens configuration Group: lens for n channel products n denotes the value of "capability_nvideoin" (capability.image.c<0~(n-1)>.lensconfiguration.support = 1) NAME VALUE SECURITY DESCRIPTION (get/set) selected 6/7 Current selected lens profile. e.g. lens_selected=lens_default_i0, it means choosen lens configuration is i0 lens of default group.
PAGE 298
VIVOTEK 7.44 Fisheye info Group: fisheyeinfo (capability.fisheye > 0) NAME VALUE SECURITY DESCRIPTION (get/set) revisedcenteraxis 6/7 The actual center axis coordinate radius 0, 7.
PAGE 299
VIVOTEK 7.46 PIR behavior define Group: pir (capability.npir > 0) NAME VALUE SECURITY DESCRIPTION (get/set) enable 7.47 1/1 Enable/disable PIR Auto tracking setting Group: autotrack_c<0~(n-1)> (capability_image_c<0~(n-1)>_autotrack_support > 0) n denotes the value of "capability_nvideoin" PARAMETER VALUE SECURITY DESCRIPTION (get/set) objsize_type -1~2 1/4 Type of object size.
PAGE 300
VIVOTEK 7.48 Wireless Group: wireless (capability_network_wireless > 0) PARAMETER VALUE SECURITY DESCRIPTION (get/set) ssid string[32] 6/6 SSID for wireless lan settings. wlmode Infra, 6/6 Wireless mode. Adhoc channel Infra: Infrastructure 1~11 or 1~13 or 6/6 A list of WLAN channels. Countries apply their own regulations to the 10~11 or allowable channels.
PAGE 301
VIVOTEK key4 password [26] 6/6 WEP key4 for encryption. * Only valid when "wireless_encrypt" is "wep" algorithm AES, TKIP 6/6 Algorithm * Only valid when "wireless_encrypt" is "wpa" or "wpa2" presharedkey password [64] 6/6 WPA/WPA2PSK mode pre-shared key. * Only valid when "wireless_encrypt" is "wpa" or "wpa2" 7.
PAGE 302
VIVOTEK 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.
PAGE 303
VIVOTEK Example: Query the status of digital input 1 . Request: http://myserver/cgi-bin/dido/getdi.cgi?di1 Response: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: 7\r\n \r\n di1=1\r\n 8.3 Query Status of the Digital Output (capability.ndo > 0) Note: This request requires Viewer privileges Method: GET/POST Syntax: http:///cgi-bin/dido/getdo.cgi?[do0][&do1][&do2][&do3] If no parameter is specified, all the digital output statuses will be returned. Return: HTTP/1.0 200 OK\
PAGE 304
VIVOTEK \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.jpg?[channel=][&resolution=] [&quality=][&streamid=] If the user requests a size larger than all stream settings on the server, this request will fail. PARAMETER VALUE DEFA DESCRIPTION ULT channel 0~(n-1) 0 The channel number of the video source. resolution IP8165: 0 The resolution of the image.
PAGE 305
VIVOTEK 8.5 Account Management Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/editaccount.cgi? method=&username=[&userpass=][&privilege=] [&privilege=][…][&return=] PARAMETER VALUE DESCRIPTION method Add Add an account to the server. When using this method, the“username” field is necessary. It will use the default value of other fields if not specified.
PAGE 306
VIVOTEK 8.6 System Logs Note: This request require Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/syslog.cgi Server will return the most up-to-date system log. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: \r\n \r\n \r\n 8.7 Upgrade Firmware Note: This request requires Administrator privileges. Method: POST Syntax: http:///cgi-bin/admin/upgrade.
PAGE 307
VIVOTEK 8.8 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.
PAGE 308
VIVOTEK http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5 zooming is used to indicate the moving direction, and zs is used to indicate the speed. To stop a continuous movement, you have to use the command as below: http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zoom=stop&zs=0 2.
PAGE 309
VIVOTEK 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. It will be the y-coordinate of center after movement. videosize The size of plug-in (ActiveX)window in web page resolution The resolution of streaming.
PAGE 310
VIVOTEK 8.9 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 One of the present positions to recall.
PAGE 311
VIVOTEK 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. * If the is invalid path, it will ignore this parameter. 8.11 IP Filtering Note: This request requires Administrator access privileges.
PAGE 312
VIVOTEK 8.12 IP Filtering for ONVIF Syntax: http:///cgi-bin/admin/ipfilter.cgi?type[=] http:///cgi-bin/admin/ipfilter.cgi?method=add&ip=[&index=][&ret urn=] http:///cgi-bin/admin/ipfilter.cgi?method=del&index=[&return=] PARAMETER VALUE DESCRIPTION type NULL Get IP filter type allow, deny Set IP filter type addv4 Add IPv4 address into access list.
PAGE 313
VIVOTEK 8.13 UART HTTP Tunnel Channel (capability.nuart > 0) Note: This request requires Operator privileges. Method: GET and POST Syntax: http:///cgi-bin/operator/uartchannel.cgi?[channel=] ------------------------------------------------------------------------GET /cgi-bin/operator/uartchannel.
PAGE 314
VIVOTEK 8.14 Event/Control HTTP Tunnel Channel (capability. evctrlchannel > 0) Note: This request requires Administrator privileges. Method: GET and POST Syntax: http:///cgi-bin/admin/ctrlevent.cgi ------------------------------------------------------------------------GET /cgi-bin/admin/ctrlevent.
PAGE 315
VIVOTEK 8.15 Get SDP of Streams Note: This request requires Viewer access privileges. Method: GET/POST Syntax: http:///_accessname> “m” is the stream number. “network_accessname_<0~(m-1)>” is the accessname for stream “1” to stream “m”. Please refer to the “subgroup of network: rtsp” for setting the accessname of SDP. You can get the SDP by HTTP GET. When using scalable multicast, Get SDP file which contains the multicast information via HTTP. 8.
PAGE 316
VIVOTEK 8.17 Senddata (capability.nuart > 0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http:///cgi-bin/viewer/senddata.cgi? [com=][&data=][&flush=] [&wait=] [&read=] PARAMETER VALUE DESCRIPTION com 1 ~ data is a series of digits from 0 ~ 9, A ~ F. Each data>[,
PAGE 317
VIVOTEK 8.18 Storage managements (capability.storage.dbenabled > 0) Note: This request requires administrator privileges. Method: GET and POST Syntax: http:///cgi-bin/admin/lsctrl.cgi?cmd=[&=…] The commands usage and their input arguments are as follows. PARAMETER VALUE DESCRIPTION cmd_type Required. Command to be executed, including search, insert, delete, update, and queryStatus.
PAGE 318
VIVOTEK Indicate if the file is locked or not. 0: file is not locked. 1: file is locked. A locked file would not be removed from UI or cyclic storage. triggerTime Optional. Indicate the event trigger time. (not the file created time) Format is “YYYY-MM-DD HH:MM:SS” Please embrace your input value with single quotes. Ex. triggerTime=’2008-01-01 00:00:00’ If you want to search for a time period, please apply “TO” operation. Ex.
PAGE 319
VIVOTEK label Required. Identify the designated record. Ex. label=1 isLocked Required. Indicate if the file is locked or not. Ex. Update records whose key numbers are 1 and 5 to be locked status. http:///cgi-bin/admin/lsctrl.cgi?cmd=update&isLocked=1&label=1&label=5 Ex. Update records whose key numbers are 2 and 3 to be unlocked status. http:///cgi-bin/admin/lsctrl.
PAGE 320
VIVOTEK return state after duration. cannot accept new requests. 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. * If the is invalid path, it will ignore this parameter. Return Code Description 200 The request is successfully executed. 400 The request cannot be assigned, ex. incorrect parameters.
PAGE 321
VIVOTEK 8.20 Open Timeshift Stream (capability.timeshift > 0, timeshift_enable=1, timeshift_c_s_allow=1) Note: This request requires Viewer access privileges. Syntax: For HTTP push server (MJPEG): http:///_accessname>?maxsft=[&tsmode=&reftime=&forcechk&minsft=] For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player.
PAGE 322
VIVOTEK Return Code Description 400 Bad Request Request is rejected because some parameter values are illegal. 415 Unsupported Media Type Returned, if forcechk appears,when minsft is not achievable or the timeshift feature of the target stream is not enabled.
PAGE 323
VIVOTEK 8.21 RemoteFocus (capability_image_c<0~(n-1)>_remotefocus=1) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/remotefocus.
PAGE 324
VIVOTEK function zoom, Function type focus, zoom - Move focus motor auto, focus – Move focus motor scan, auto – Perform auto focus stop, scan – Perform focus scan positioning, stop – Stop current operation getstatus positioning – Position the motors getstatus–Information of motors, return value as below: remote_focus_zoom_motor_max: Maximum steps of zoom motor remote_focus_focus_motor_max: Maximum steps of focus motor remote_focus_zoom_motor_start: Start point of zoom motor remote_focus_zoom_
PAGE 325
VIVOTEK steps 1 ~ Motor’s moving steps. It works only if function=zoom | focus and direction=forward | backward. is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from "function=getstatus" iris N/A Open iris or not. It works only if function=auto | scan. 8.22 BackFocus (capability_image_c<0~(n-1)>_remotefocus=4) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/remotefocus.
PAGE 326
VIVOTEK function focus, Function type auto, focus – Move focus motor scan, auto – Perform auto focus stop, scan – Perform focus scan positioning, stop – Stop current operation irisopen, positioning – Position the motors irisenable, resetfocus – reset focus position to default resetfocus, irisopen – Fully open iris. It will maintain this status until sending getstatus irisenable cgi.
PAGE 327
VIVOTEK steps 1 ~ Motor’s moving steps. It works only if function=focus and direction=forward | backward. is refer to remote_focus_focus_motor_max which replied from "function=getstatus" iris N/A Open iris or not. It works only if function=auto | scan. 8.23 Export Files Note: This request requires Administrator privileges. Method: GET Syntax: For daylight saving time configuration file: http:///cgi-bin/admin/exportDst.
PAGE 328
VIVOTEK 8.24 Upload Files Note: This request requires Administrator privileges. Method: POST Syntax: For daylight saving time configuration file: http:///cgi-bin/admin/upload_dst.cgi Post data: filename =\r\n \r\n For language file: http:///cgi-bin/admin/upload_lan.cgi Post data: filename =\r\n \r\n For setting backup file: http:///cgi-bin/admin/upload_backup.
PAGE 329
VIVOTEK 8.25 Update Lens Configuration 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.cgi?list_lens For choose selected lens configuration: http:///cgi-bin/admin/update_lens.
PAGE 330
VIVOTEK Server will accept the file named to upload the lens profile to camera. 8.26 Media on demand (capability.localstorage.modnum > 0) Media on demand allows users to select and receive/watch/listen to metadata/video/audio contents on demand. Note: This request requires Viewer access privileges. Syntax: rtsp:///mod.
PAGE 331
VIVOTEK 8.27 Fisheye local dewarp camera control (capability.fisheye > 0 and capability.fisheyelocaldewarp.c0 > 0, only support in 1R mode) Note: This request requires camctrl privileges. Method: GET/POST Syntax: http:///cgi-bin/camctrl/fdCamCtrl.
PAGE 332
VIVOTEK zoom wide Zoom larger view with current speed. tele Zoom further with current speed. speedpan -5 ~ 5 Set the pan speed of current command. speedtilt -5 ~ 5 Set the tilt speed of current command. speedzoom -5 ~ 5 Set the zoom speed of current command. zooming wide or tele Zoom without stopping for larger view or further view with zs speed, used for joystick control. zs 0~6 Set the speed of zooming, “0” means stop. vx -6 ~ 6 The direction of movement, used for joystick control.
PAGE 333
VIVOTEK 8.28 3D Privacy Mask (capability_image_c<0~(n-1)>_privacymask_wintype = 3Drectangle) n denotes the value of "capability_nvideoin" Note: This request requires admin user privilege Method: GET/POST Syntax: http:///cgi-bin/admin/setpm3d.
PAGE 334
VIVOTEK 8.29 Camera Control (capability_camctrl_c<0~(n-1)>_zoommodule = 1) Note: This request requires Viewer privileges. Method: GET/POST Syntax: (for control API) http:///cgi-bin/camctrl/camctrl.
PAGE 335
VIVOTEK speedpan -5 ~ 5 Set the pan speed. speedtilt -5 ~ 5 Set the tilt speed. speedzoom -5 ~ 5 Set the zoom speed. speedfocus -5 ~ 5 Set the focus speed. speedapp -5 ~ 5 Set the auto pan/patrol speed. auto pan Auto pan. patrol Auto patrol. stop Stop camera. wide Zoom larger view with current speed. tele Zoom further with current speed. stop Stop zoom. wide or tele Zoom without stopping for larger view or further view with zs speed, zoom zooming used for joystick control.
PAGE 336
VIVOTEK * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20. cam getsetpreset Adds a named preset at current position, and return the preset index. * We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20. return Redirect to the page after the parameter is assigned. The should be the relative path according to the root of camera.
PAGE 337
VIVOTEK gettiltangle Get the current tilt angle. *Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1" getzoom 0, Get the current zoom position. getratio Get the current zoom ratio. getfocus 0, Get the current focus position. getminspeedlv 0, Get the minimum speed level of the PTZ control. Normally, the speed level is ‘0,’ which denotes halting a continuous movement.
PAGE 338
VIVOTEK getmaxratio Get the maximum ratio of optical zoom. * We support this parameter when the version number (getversion) is equal or greater than 5.0.0.14 getmaxdratio Get the maximum ratio of digital zoom. * We support this parameter when the version number (getversion) is equal or greater than 5.0.0.14 getminfocus 0, Get the lower limit for focus position. getmaxfocus 0, Get the upper limit for focus position. 8.
PAGE 339
VIVOTEK 8.31 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. delpos string[30] Delete preset location from preset list.
PAGE 340
VIVOTEK 8.32 SmartSD (capability_localstorage_smartsd > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/smartsd.
PAGE 341
VIVOTEK function getstatus Function type getstauts : Information of smartSD internal status return value as below: smartsd_lifetime_num: Accumulated amount of data that has been written smartsd_lifetime_den: Card-guaranteed amount of data that can be written smartsd_lifetime_rate: The ratio of smartsd_lifetime_num to smartsd_lifetime_den. It means the accumulated percentage amount of flash block has been written. The range is from 0 to 100 (unit: %).
PAGE 342
VIVOTEK 8.33 Connet to AP (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/connect_ap.cgi PARAMETER VALUE DESCRIPTION N/A N/A Apply the wireless settings and connect to AP. 8.34 Get wireless information (capability_network_wireless > 0) Note: This request requires Administrator privileges. Method: GET/POST Syntax: http:///cgi-bin/admin/getwirelessinfo.
PAGE 343
VIVOTEK PARAMETER VALUE DESCRIPTION N/A N/A Get wireless signal strength. 8.36 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.37 Peripheral control (capability_peripheral_c<0~(n-1)>_ devicecontrol > 0) Note: This request requires Administrator privileges.
PAGE 344
VIVOTEK 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. *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 washer Apply the washer to the mode of washer control system. *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 washer_status on Enable the functionality of washer control system.
PAGE 345
VIVOTEK [&washer_mode] – Get washer mode [&washer_status] – Get washer status [&washer_dwelltime] – Get washer clean time [&heater_supportstatus] – Get heater support control status [&heater_status] – Get heater status Example: http://myserver/cgi-bin/admin/peripheral.cgi?channel=0&operation=get&supportdevice&washer_status Response: HTTP/1.0 200 OK\r\n Cache-control: no-cache\r\n Pragma: no-cache\r\n \r\n supportdevice=washer,heater\r\n washer_status=off\r\n PARAMETER VALUE DESCRIPTION channel 0~"cap
PAGE 346
VIVOTEK *Only available when capability_peripheral_c<0~(n-1)>_washer_supp ort=1 heater_supportstatus N/A Get the support status of heater control system. *Only available when capability_peripheral_c<0~(n-1)>_heater_suppo rt=1 heater_status N/A Get the current heater status. Normally itwill be 'auto', it means the heater device is control by internal algorithm to keep in a suitable environment; Otherwise is 'trigger', it means the heater device is force enable to heat to an internal condition.
PAGE 347
VIVOTEK Technical Specifications Model IB8360: PoE, 12M IR, IP66 IB8360-W: WiFi, 12M IR, IP66 System Information CPU Multimedia SoC (System-on-Chip) Flash 128MB RAM 256MB Protocols IB8360: IPv4, IPv6, TCP/IP, HTTP, HTTPS, UPnP, RTSP/ RTP/RTCP, IGMP, SMTP, FTP, DHCP, NTP, DNS, DDNS, PPPoE, CoS, QoS, SNMP, 802.
PAGE 348
VIVOTEK Technical Specifications Dimensions 74.47 mm 99.22 mm 163.53 mm All specifications are subject to change without notice. Copyright © VIVOTEK INC. All rights reserved. Ver. 4 6F, No.192, Lien-Cheng Rd., Chung-Ho, New Taipei City, 235, Taiwan, R.O.C. | T: +886-2-82455282 | F: +886-2-82455532 | E: sales@vivotek.com | W: www.vivotek.
PAGE 349
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.
PAGE 350
VIVOTEK Liability/ Disclaimer Please inform your local VIVOTEK office of any inaccuracies or omissions. VIVOTEK cannot be held responsible for any technical or typographical errors and reserves the right to make changes to the product and manuals without prior notice. VIVOTEK makes no warranty of any kind with regard to the material contained within this document, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose.
PAGE 351
VIVOTEK Support Should you require any technical assistance, please contact your VIVOTEK reseller/ distributor. VIVOTEK distributor contact information could be found on Where to Buy section at VIVOTEK website. To enhance customer satisfaction, your reseller/ distributor will reach us in a timely manner if the issue is not solved with first response. We encourage you to take advantage of the many online resources VIVOTEK offers.
PAGE 352
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.