VIVOTEK Overview VIVOTEK IB8156/8168 is an ultra-mini bullet network camera, specially designed for indoor applications in which camera appearance is cared, such as luxury stores, antique stores and cloth shops. The IB8156/8168 is equipped with a 1.3- or 2-megapixel sensor and the ability to output 15 (IB8156) or 30 (IB8168) frames per second in H.264 compression.
Commands of the Network Camera section serves as a helpful reference to customizing existing homepages or integrating with the current web server. Package Contents ■ IB8156-C/-G / IB8168-C/-G - the Network ■ Screws / anchors Camera ■ Quick Installation Guide ■...
VIVOTEK Physical Description MicroSD card slot Reset button Lens icro Fastening ring NOTE: 1. The camera can only be powered by Power over Ethernet (PoE). 2. The camera can only be installed in an indoor environment. 3. Install the SD card if local storage is preferred.
Page 6
VIVOTEK Installation Mounting Procedure: 1. Attach the alignment sticker to a preferred location. 2. Drill a 30mm cabling hole if preferred. 3. Install the mount bracket using the self-tapping screws (use anchors with hard surfaces.) 6 - User's Manual...
Page 7
VIVOTEK 4. Pass the Ethernet cable through the cabling hole or along the wall. Below is the installation sample for IB8156-G and IB8168-G. User's Manual - 7...
Page 8
VIVOTEK 5. If the camera is installed upside down, re-install the front cover so that the protruding edge is on top. NOTE: 1. The product is not likely to require connection to an Ethernet network with outside plant routing, including campus environment.
Page 9
VIVOTEK Watching the video: Connect the camera to a PC or laptop. Install and use the IW2 utility to discover your camera on LAN. Double-click on the camera entry to open a web session. 00-02-D1-73-02-02 192.168.5.151 FD8168 0002D1730202 Browser User's Manual - 9...
Page 10
VIVOTEK Hardware Reset Reset Button The reset button is used to reset the system or restore the factory default settings. Sometimes resetting the system can return the camera to normal operation. If the system problems remain after reset, restore the factory settings and install again.
VIVOTEK Network Deployment Power over Ethernet (PoE) When using a PoE-enabled switch The Network Camera is PoE-compliant, allowing transmission of power and data via a sin- gle Ethernet cable. Follow the below illustration to connect the Network Camera to a PoE- enabled switch via Ethernet cable.
Page 12
VIVOTEK Internet connection via a router Before setting up the Network Camera over the Internet, make sure you have a router and follow the steps below. 1. Connect your Network Camera behind a router, the Internet environment is illustrated below.
Page 13
For more information with network configuration options (such as that of streaming ports), please refer to Configuration > Network Settings. VIVOTEK also provides the automatic port forwarding feature as an NAT traversal function with the precondition that your router must support the UPnP port forwarding feature.
After your network environment is analyzed, please click Next to continue the program. 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.
VIVOTEK Ready to Use 1. A browser session with the Network Camera should prompt as shown below. 2. You should be able to see live video from your camera. You may also install the 32-channel recording software from the software CD in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents.
3. The live video will be displayed in your web browser. 4. If it is the first time installing the VIVOTEK network camera, an information bar will pop up as shown below. Follow the instructions to install the required plug-in on your computer.
Page 17
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 72.
Page 18
VIVOTEK IMPORTANT: 1. Currently the Network Camera utilizes 32-bit ActiveX plugin. You CAN NOT open a management/view session with the camera using a 64-bit IE browser. 2. 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.
VIVOTEK Using RTSP Players To view the MPEG-4 streaming media using RTSP players, you can use one of the following players that support RTSP streaming. Quick Time Player VLC Player VLC media player 1. Launch the RTSP player. mpegable Player 2.
VIVOTEK Using 3GPP-compatible Mobile Devices To view the streaming media through 3GPP-compatible mobile devices, make sure the Network Camera can be accessed over the Internet. For more information on how to set up the Network Camera over the Internet, please refer to Setup the Network Camera over the Internet on page To utilize this feature, please check the following settings on your Network Camera: 1.
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. User's Manual - 21...
VIVOTEK Main Page This chapter explains the layout of the main page. It is composed of the following sections: VIVOTEK INC. Logo, Host Name, Camera Control Area, Configuration Area, Menu, and Live Video Window. Resize Buttons VIVOTEK INC. Host Name...
Page 23
VIVOTEK 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). The floating frame allows users to control the e-PTZ function (Electronic Pan/ Tilt/Zoom).
Page 24
VIVOTEK H.264 Protocol and Media Options Video Title Time 2014/01/05 17:08:56 Video (TPC-V) Title and Time Video 17:08:56 2014/01/05 Zoom Indicator x4.0 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Video Settings on page 44.
Page 25
VIVOTEK Video Control Buttons: Depending on the Network Camera model and Network Camera configuration, some buttons may not be available. Snapshot: Click this button to capture and save still images. The captured images will be displayed in a pop-up window. Right-click the image and choose Save Picture As to save it in JPEG (*.jpg) or BMP (*.bmp) format.
Page 26
VIVOTEK ■ The following window is displayed when the video mode is set to MJPEG: Video Title Time 2014/01/05 17:08:56 Video (HTTP-V) Title and Time Video 17:08:56 2014/01/05 Video Control Buttons Video Title: The video title can be configured. For more information, please refer to Media > Image on page 44.
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...
Page 28
VIVOTEK MP4 Saving Options Users can record live video as they are watching it by clicking Start MP4 Recording on the main page. Here, you can specify the storage destination and file name. Folder: Specify a storage destination for the recorded video files.
VIVOTEK Joystick Settings Enable Joystick Connect to the USB plug of the joystick to a USB port on your management computer. Supported by the plug-in in the main page (Microsoft’s DirectX), once the plug-in in the main page is loaded, it will automatically detect if there is any joystick on the computer.
Page 30
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.
VIVOTEK Configuration Click Configuration on the main page to enter the camera setting pages. Note that only Administrators can access the configuration page. The Navigation Area provides access to the Home page (the monitoring page for live viewing), Client settings, Configuration page, and multi-language selection.
VIVOTEK System > General settings This section explains how to configure the basic settings for the Network Camera, such as the host name and system time. It is composed of the following two columns: System, and System Time. When finished with the settings on this page, click Save at the bottom of the page to enable the settings.
Page 33
VIVOTEK System time Time zone : Select the appropriate time zone from the list. If you want to upload Daylight Savings Time rules, please refer to System > Maintenance > Import/ Export files on page 41 for details. Keep current date and time: Select this option to preserve the current date and time of the Network Camera.
Theme Options (the second tab on this page). The settings will be displayed automatically in this Preview field. The following shows the homepage using the default settings: ■ Hide Powered by VIVOTEK: If you check this item, it will be removed from the homepage. Logo graph Here you can change the logo at the top of your homepage.
Page 35
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 36
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.
VIVOTEK System > Logs This section explains how to configure the Network Camera to send the system log to a remote server as backup. Log server settings Follow the steps below to set up the remote log: 1. Select Enable remote log.
Page 38
You can install the included ST7501 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 ST7501 User Manual. VIVOTEK Network Cameras Internet 3G Cell phone HTTP...
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.
Note: Do not power off the Network Camera during the upgrade! Follow the steps below to upgrade the firmware: 1. Download the latest firmware file from the VIVOTEK website. The file is in .pkg file format. 2. Click Browse… and specify the firmware file.
Page 41
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 55). Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).
Page 42
VIVOTEK ® 3. Open the file with Microsoft Notepad and locate your time zone; set the start and end time of DST. When completed, save the file. In the example below, DST begins each year at 2:00 a.m. on the second Sunday in March and ends at 2:00 a.m.
Page 43
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.
VIVOTEK Media > Image This section explains how to configure the image settings of the Network Camera. It is composed of the following five columns: General settings, Image settings, Exposure, and Privacy mask. General settings Video title Show_timestamp_and video_title_in_video_and_snapshots: Enter a name that will be displayed on the title bar of the live video as the picture shown below.
VIVOTEK Image settings On this page, you can tune the White balance and Image adjustment. Sensor Setting 1: For normal situations Sensor Setting 2: For special situations White balance: Adjust the value for the best color temperature. ■ You may follow the steps below to adjust the white balance to the best color temperature.
Page 46
VIVOTEK ■ Enable low light compensation: Select this option in low light mode, and the values of sharpness and brightness will change automatically. This function also benefits from an automated noise reduction feature. ■ WDR Enhanced: When enabled, you can select the strength of the WDR function. The Low, Medium, High options correspond to the level of contrast between the overly-lit area and the shaded areas.
Page 47
VIVOTEK ■ Custom: The inclusive window refers to the “weighed window.” It adopts the weighed averages method to calculate the value. The inclusive windows have a higher priority. An exposure value will then be calculated out of the inclusive window.
Page 48
VIVOTEK ■ Exposure Time: The configurable max. exposure time is tunable according to lighting conditions with values ranging from 1/32000 to 1/5 of a second. ■ Gain Control: Tune the slider bar to set the Gain Control to the best image quality. Higher gain control value will generate a certain amount of noises.
Page 49
VIVOTEK Privacy mask Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to address privacy concerns. 2014/1/9 17:08:56 ■ To set the privacy mask windows, follow the steps below: 1. Click New to add a new window.
VIVOTEK Media > Video Stream settings This Network Camera supports multiple streams with frame sizes ranging from 176 x 144 to 1920 x1080. The definition of multiple streams: ■ Stream 1: The default frame size for Stream 1 is set to the 1920 x 1080 (IB8168) or 1280 x1024 (IB8156) at 30fps.
Page 51
VIVOTEK Click Viewing Window to open the viewing region settings page. On this page, you can configure the Region of Interest and the Output Frame Size for different streams. For example, you can crop only a portion of the image that is of your interest, and thus save the bandwidth needed to transmit the video stream.
Page 52
VIVOTEK Click the stream item to display the detailed information. The maximum frame size will follow your settings in the above Viewing Window sections. This Network Camera provides real-time H.264 and MJPEG compression standards for real-time viewing. If the H.264 mode is selected, the video is streamed via RTSP protocol.
Page 53
VIVOTEK ■ Intra frame period Determine how often for firmware to plant an I frame. The shorter the duration, the more likely you will get better video quality, but at the cost of higher network bandwidth consumption. Select the intra frame period from the following durations: 1/4 second, 1/2 second, 1 second, 2 seconds, 3 seconds, and 4 seconds.
Page 54
VIVOTEK 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.
Use fixed IP address: Select this option to manually assign a static IP address to the Network Camera. 1. You can make use of VIVOTEK Installation Wizard 2 on the software CD to easily set up the Network Camera on LAN. Please refer to Software Installation on page 14 for details.
Page 56
VIVOTEK Primary DNS: The primary domain name server that translates host names into IP addresses. Secondary DNS: Secondary domain name server that backups the Primary DNS. Primary WINS server: The primary WINS server that maintains the database of computer names and IP addresses.
Page 57
VIVOTEK NOTE: ► If the default ports are already used by other devices connected to the same router, the Network Camera will select other ports for the Network Camera. ► If UPnP is not supported by your router, you will see the following message: Error: Router does not support UPnP port forwarding.
Page 58
VIVOTEK 4. In the Networking Services dialog box, select Universal Plug and Play and click OK. 5. Click Next in the following window. 6. Click Finish. UPnP is enabled. ► How does UPnP work? UPnP networking technology provides automatic IP configuration and dynamic discovery of devices added to a network.
Page 59
VIVOTEK Enable IPv6 Select the Enable IPv6 checkbox 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 7 or 8, Mozilla Firefox 13.0 or above.
Page 60
VIVOTEK Please follow the steps below to link to an IPv6 address: 1. Open your web browser. 2. Enter the link-global or link-local IPv6 address in the address bar of your web browser. 3. The format should be: http://[2001:0c08:2500:0002:0202:d1ff:fe04:65f4]/ IPv6 address 4.
Page 61
1025 and 65535. 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.
VIVOTEK Network > Streaming protocols HTTP streaming To utilize HTTP authentication, make sure that your have set a password for the Network Camera first; please refer to Security > User account on page 72 for details. Authentication: Depending on your network security requirements, the Network Camera provides two types of security settings for an HTTP transaction: basic and digest.
Page 63
VIVOTEK URL command -- http://<ip address>:<http port>/<access name for stream 1~3> For example, when the Access name for stream 2 is set to video2.mjpg: 1. Launch Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter.
Page 64
VIVOTEK Authentication: Depending on your network security requirements, the Network Camera provides three types of security settings for streaming via RTSP protocol: disable, basic, and digest. basic authentication is selected, the password is sent in plain text format, but there can be potential risks of it being intercepted.
Page 65
VIVOTEK Multicast settings for stream #: Click the items to display the detailed configuration information. Select the Always multicast option to enable multicast for different 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 66
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 67
DDNS: Dynamic domain name service Enable DDNS: Select this option to enable the DDNS setting. Provider: Select a DDNS provider from the provider drop-down list. VIVOTEK offers Safe100.net, a free dynamic domain name service, to VIVOTEK customers. It is recommended that you register Safe100.net to access VIVOTEK’s Network Cameras from the...
Page 68
4. Select Enable DDNS and click Save to enable the setting. ■ CustomSafe100 VIVOTEK offers documents to establish a CustomSafe100 DDNS server for distributors and system integrators. You can use CustomSafe100 to register a dynamic domain name if your distributor or system integrators offer such services.
Page 69
VIVOTEK Network > QoS (Quality of Service) Quality of Service refers to a resource reservation control mechanism, which guarantees a certain quality to different services on the network. Quality of service guarantees are important if the network capacity is insufficient, especially for real-time streaming multimedia applications. Quality can be defined as, for instance, a maintained level of bit rate, low latency, no packet dropping, etc.
Page 70
VIVOTEK QoS/DSCP (the DiffServ model) DSCP-ECN defines QoS at Layer 3 (Network Layer). The Differentiated Services (DiffServ) model is based on packet marking and router queuing disciplines. The marking is done by adding a field to the IP header, called the DSCP (Differentiated Services Codepoint). This is a 6-bit field that provides 64 different class IDs.
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.
VIVOTEK Security > User Account 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”...
VIVOTEK Security > HTTPS (Hypertext Transfer Protocol over SSL) This section explains how to enable authentication and encrypted communication over SSL (Secure Socket Layer). It helps protect streaming data transmission over the Internet on higher security level. Create and Install Certificate Method Before using HTTPS for communication with the Network Camera, a Certificate must be created first.
Page 74
VIVOTEK 5. Click Save to preserve your configuration, and your current session with the camera will change to the encrypted connection. 6. If your web session does not automatically change to an encrypted HTTPS session, click Home to return to the main page. Change the URL address from “http://” to “https://“ in the address bar and press Enter on your keyboard.
Page 75
VIVOTEK Create certificate request and install 1. Select the option from the Method pull-down menu. 2. Click Create certificate to proceed. 3. The following information will show up in a pop-up window after clicking Create. Then click Save to generate the certificate request.
Page 76
VIVOTEK 5. Look for a trusted certificate authority, such as Symantec’s VeriSign Authentication Services, that issues digital certificates. Sign in and purchase the SSL certification service. Copy the certificate request from your request prompt and paste it in the CA’s signing request window. Proceed with the rest of the process as CA’s instructions on their webpage.
Page 77
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 78
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. 78 - User's Manual...
Page 79
VIVOTEK Note that 11. When the certifice file is successfully loaded, its status will be stated as Active. a certificate must have been created and installed before you can click on the “Save" button for the configuration to take effect.
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 and stream 2). 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 Explore or Quick Time Player).
Page 81
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 Explorer or Quick Time Player).
Page 82
VIVOTEK There are three types of rules: Single: This rule allows the user to add an IP address to the Allowed/Denied list. For example: 192.168.2.1 Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List.
Page 83
Authentication server (usually a RADIUS server): Checks the client certificate and decides whether to accept the end user’s access request. ■ VIVOTEK Network Cameras support two types of EAP methods to perform authentication: EAP- PEAP and EAP-TLS. Please follow the steps below to enable 802.1x settings: 1.
Page 84
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).
VIVOTEK PTZ > PTZ settings This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation. The e-PTZ fucntion allows users to quickly move the focus to a target area for close-up viewing without physically moving the camera. Please refer to below for detailed instruction.
Page 86
VIVOTEK Auto pan/patrol speed: Select the speed from 1~5 (slow/fast) to set up the Auto pan/patrol speed control. When completed with the e-PTZ settings, click Save to enable the settings on this page. Home page in E-PTZ Mode ■ The e-Preset Positions will also be displayed on the home page. Select one from the drop-down list, and the Network Camera will move to the selected e-preset position.
Page 87
VIVOTEK Patrol settings You can select some preset positions for the Network Camera to patrol. Please follow the steps below to set up a patrol schedule: 1. Select the preset locations on the list, and click 2. The selected preset locations will be displayed on the Patrol locations list.
Page 88
VIVOTEK Zoom factor display: You can use the scroll wheel on your mouse to zoom in or zoom out on the live view screen. When this checkbox is selected, the zoom ratio is displayed on the upper-left of the screen when the zoom ratio is changed.
VIVOTEK Event > Event settings This section explains how to configure the Network Camera to responds to particular situations (event). A typical application is that when a motion is detected, the Network Camera sends buffered images to an FTP server or e-mail address as notifications. Click on Help, there is an illustration shown in the pop-up window explaining that an event can be triggered by many sources, such as motion detection or external digital input devices.
Page 90
VIVOTEK ■ Event name: Enter a name for the event setting. ■ Enable this event: Select this option to enable the event setting. ■ Priority: Select the relative importance of this event (High, Normal, or Low). Events with a higher priority setting will be executed first.
Page 91
VIVOTEK ■ Camera tampering detection This option allows the Network Camera to trigger when the camera detects that is is being tampered with. To enable this function, you need to configure the Tampering Detection option first. Please refer to page 106 for detailed information.
Page 92
VIVOTEK 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 back up media files to SD card if the network is disconnected. This function will only be displayed after you configured a networked storage (NAS).
Page 93
VIVOTEK Add server To set an event with recorded video or snapshots, 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 Add server media files to) when a trigger is activated.
Page 94
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 set up the first event server, the new event server will automatically display on the Server list.
Page 95
VIVOTEK ■ Passive mode Most firewalls do not accept new connections initiated from external requests. If the FTP server supports passive mode, select this option to enable passive mode FTP and allow data transmission to pass through the firewall. The firmware default has the Passive mode checkbox selected.
Page 96
VIVOTEK Network storage: Select to send the media files to a network storage location when a trigger is activated. Please refer to NAS server on page 111 for details. Click Save server to enable the settings. ■ SD Test: Click to test your SD card. The system will display a message indicating success or failure. If you want to use your SD card for local storage, please format it before use.
Page 97
VIVOTEK Click 20130820 to open the directory: The format is: HH (24r) Click to open the file list for that hour 2013/08/20 2013/08/20 Click to go back to the previous Click to delete level of the directory selected items Click to delete all...
Page 98
VIVOTEK Add media Add media Click to open the media setting window. You can specify the type of media that will be sent when a trigger is activated. A total of 5 media settings can be configured. There are three choices of media types available: Snapshot, Video Clip, and System log.
Page 99
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_20130713_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings.
Page 100
VIVOTEK ■ Maximum file size Specify the maximum file size allowed. ■ File name prefix Enter the text that will be appended to the front of the file name. For example: Video_20130813_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS Click Save media to enable the settings.
Page 101
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 Save event to enable the settings and click Close to exit Event Settings page.
Page 102
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. Click to upload a file...
VIVOTEK Applications > Motion detection This section explains how to configure the Network Camera to enable motion detection. A total of three motion detection windows can be configured. 2010/12/10 17:08:56 2014/1/5 14:39:12 Motion Detection Setting 1: For normal situations Motion Detection Setting 2:...
Page 104
VIVOTEK 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 defined threshold. Percentage = 30% If you want to configure other motion detection settings for day/night/schedule mode, please click Profile to open the Motion Detection Profile Settings page as shown below.
Page 105
VIVOTEK NOTE: ► How does motion detection work? There are two motion detection parameters: Sensitivity and Percentage. In the illustration above, frame A and frame B are two sequential images. Pixel differences between the two frames are detected and highlighted in gray (frame C) and will be compared with the sensitivity setting. Sensitivity is a value that expresses the sensitivity to moving objects.
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.
Applications > VADP (VIVOTEK Application Development Platform) Users can store and execute VIVOTEK's or 3rd-party software modules onto the camera's flash memory or SD card. These software modules can apply in video analysis for intelligent video applications such as license plate recognition, object counting, or as an agent for edge recording, etc.
Page 108
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.
VIVOTEK Recording > Recording settings This section explains how to configure the recording settings for the Network Camera. Recording Settings Insert your SD card and click here to test NOTE: ► Please remember to format your SD card when using it for the first time. Please refer to page 114 for detailed information.
Page 110
VIVOTEK If you enable adaptive recording and enable time-shift cache stream on Camera A, only when an event is triggered on Camera A will the server record the full frame rate streaming data; otherwise, it will only request the I frame data during normal monitoring, thus effectively save lots of bandwidths and storage space.
Page 111
VIVOTEK 2. Destination You can select the SD card or network storage (NAS) for the recorded video files. NAS server Click Add NAS server to open the server setting window and follow the steps below to set up: 1. Fill in the information for your server.
Page 112
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.
Page 113
VIVOTEK When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page. When the system begins recording, it will send the recorded files to the network storage. The new recording name will appear in the drop-down list on the recording page as shown below.
VIVOTEK Local storage > SD card management This section explains how to manage the local storage on the Network Camera. Here you can view SD card status, and implement SD card control. SD card staus This column shows the status and reserved space of your SD card. Please remember to format the SD card when using for the first time.
VIVOTEK Local storage > Content management This section explains how to manage the content of recorded videos on the Network Camera. Here you can search and view the records and view the searched results. Searching and Viewing the Records This column allows the user to set up search criteria for recorded data. If you do not select any criteria and click Search button, all recorded data will be listed in the Search Results column.
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. Enter a key word to filter the Numbers of entries displayed...
Page 117
VIVOTEK ■ Lock/Unlock: Select the desired search results, 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 ■...
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.
Following are the URL commands for the IB8156 VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 3. General CGI URL Syntax and Parameters When the CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server.
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 4. Security Level SECURITY SUB-DIRECTORY DESCRIPTION LEVEL anonymous Unprotected. 1 [view] anonymous, viewer, 1. Can view, listen, talk to camera. dido, camctrl 2. Can control DI/DO, PTZ of the camera.
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 5. Get Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/viewer/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/operator/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/admin/getparam.cgi?[<parameter>] [&<parameter>…] Where the <parameter> should be <group>[_<name>]. If you do not specify any parameters, all the parameters on the server will be returned.
Page 122
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 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 122 - User's Manual...
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/operator/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/admin/setparam.cgi? <parameter>=<value>...
Page 124
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 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...
URL Command Document for All Series 7. Available parameters on the server This chapter defines all the parameters which can be configured or retrieved from VIVOTEK network camera or video server. The general format of description is listed in the table below...
Page 126
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.1 system Group: system NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) hostname string[64] Mega-Pixel Host name of server. Network Camera ledoff <boolean> Turn on (0) or turn off (1) all led indicators.
Page 127
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series -201: GMT-05:00 Bogota, Lima, Quito, Indiana -180: GMT-04:30 Caracas -160: GMT-04:00 Atlantic Time, Canada, La Paz, Santiago -140: GMT-03:30 Newfoundland -120: GMT-03:00 Brasilia, Buenos Aires, Georgetown, Greenland -80: GMT-02:00 Mid-Atlantic -40: GMT-01:00 Azores, Cape_Verde_IS.
Page 128
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series Ekaterinburg, Islamabad, Karachi, Tashkent 220: GMT 05:30 Calcutta, Chennai, Mumbai, New Delhi 230: GMT 05:45 Kathmandu 240: GMT 06:00 Almaty, Novosibirsk, Astana, Dhaka, Sri Jayawardenepura 260: GMT 06:30 Rangoon...
Page 129
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series -280,-240, support daylight saving time. -241,-200, -201,-160, -140,-120, -80,-40,0, 40,41,80, 81,82,83, 120,140, 380,400,48 updateinterval 0 to Disable automatic time 3600, adjustment, otherwise, it 86400, indicates the seconds between...
Page 130
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to default values except for a union of combined results. restoreexceptlang <Any Value> Restore the system...
Page 131
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.1.1 system.info Subgroup of system: info (The fields in this group are unchangeable.) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) modelname string[40] IB8156 Internal model name of the server...
Page 132
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.2 status Group: status NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) onlinenum_rtsp integer Current number of RTSP connections. onlinenum_httppush integer Current number of HTTP push server connections. eth_i0 <string>...
Page 133
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.4 network Group: network NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) preprocess <positive NULL An 32-bit integer, each bit can be set separately as integer> follows: Bit 0 => HTTP service;...
Page 134
VIVOTEK URL Command Document for All Series URL Command Document for IB8156 dns1 <ip <blank> Primary DNS server. address> dns2 <ip <blank> Secondary DNS server. address> wins1 <ip <blank> Primary WINS server. address> wins2 <ip <blank> Secondary WINS server. address>...
Page 135
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.4.2 QOS Subgroup of network: qos_cos (capability.protocol.qos.cos > 0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable CoS (IEEE 802.1p) vlanid 1~4095 VLAN ID video Video channel for CoS...
Page 136
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.4.4 FTP Subgroup of network: ftp NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) port 21, 1025~65535 Local ftp server port. 7.4.5 HTTP Subgroup of network: http NAME VALUE DEFAULT...
Page 137
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.4.6 HTTPS port Subgroup of network: https (capability.protocol.https > 0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) port 443, 1025 ~ HTTPS port. 65535 7.4.7 RTSP Subgroup of network: rtsp (capability.protocol.rtsp > 0)
Page 138
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 239.128.1.100, and so on. videoport 1025 ~ 65535 5560+n*2 Multicast video port. 1 ~ 255 Mutlicast time to live value. 7.4.8 RTP port Subgroup of network: rtp NAME...
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series <ip address> Network address: <ip address / network mask> Range address:<start ip address - end ip address> ipv6list_i<0~9> String[43] IPv6 address list. <blank> 7.6 video input Group: videoin...
Page 140
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.6.1 video input setting per channel Group: videoin_c<0~(n-1)> for n channel products, and m is stream number NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 CMOS frequency.
Page 141
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series support), 1(support) Bit 1 => Built-in or external camera; 0 (external), 1(built-in) Bit 2 => Support pan operation; 0(not support), 1(support) Bit 3 => Support tilt operation; 0(not support), 1(support) Bit 4 =>...
Page 142
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series s<0~(m-1)>_codectype mjpeg, h264 h264 Video codec type. svc is only supported with stream 0. s<0~(m-1)>_resolution 1.3M CMOS 1280x1024 Video resolution in pixels. => 176x144, 320x256, 640x512, 980x768, 1280x1024 s<0~(m-1)>_h264_intraper...
Page 143
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series (s<0~(m-1)>_h264_quant = 100) s<0~(m-1)>_h264_qvalue 0~51 Manual video quality level input. (s<0~(m-1)>_h264_quant = s<0~(m-1)>_h264_bitrate 1000~4000000 3000000, Set bit rate in bps when 512000(s1) choosing cbr in “ratecontrolmode”. s<0~(m-1)>_h264_maxvbr 1000~400000...
Page 144
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series s<0~(m-1)>_mjpeg_maxfram 1~25, Set maximum frame rate in 26~30 (only for fps (for JPEG). NTSC or 60Hz CMOS) s<0~(m-1)>_mjpeg_qvalue 10~200 Manual video quality level input. (s<0~(m-1)>_mjpeg_quant = s<0~(m-1)>_mjpeg_qpercent 1~100 Set quality by percentage.
Page 145
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 500, 1000, 2000, 4000, 8000, 16000, 32000 Maximum exposure time. maxexposure 5, 15, 25, 30, 50, 60, 100, 120, 240, 250, 480, 500, 1000, 2000, 4000, 8000, 16000, 32000...
Page 146
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.6.2 Video input preview The temporary settings for video preview Group: videoinpreview NAME VALUE DEFAULT SECURIT DESCRIPTION (get/set) exposuremode auto,fixed auto Exposure Mode minexposure 5, 15, 25, 30, 50, 32000 Minimum exposure time.
Page 147
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.7 image setting per channel Group: image_c<0~(n-1)> for n channel products NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) brightness -5 ~ 5 Adjust brightness of image according to mode settings.
Page 148
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series saturation sharpnesspercent 0~100 Adjust sharpness of image by percentage. Softer 0 <-> 100 Sharper gammacurve 0, 45, 50, 60, Gamma curve. 70, 80, 90, 100 lowlightmode <boolean> Enable/disable low light mode.
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.9 Motion detection settings Group: motion_c<0~(n-1)> for n channel product NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean> Enable motion detection. win_i<0~2>_enable <boolean> Enable motion window 1~3. win_i<0~2>_name string[14] <blank>...
Page 150
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series i<0~(m-1)>_win_i<0~4>_top 0 ~ 240 Top coordinate of window position. i<0~(m-1)>_win_i<0~4>_width 0 ~ 320 Width of motion detection window. i<0~(m-1)>_win_i<0~4>_height 0 ~ 240 Height of motion detection window. i<0~(m-1)>_win_i<0~4>_objsize...
Page 151
VIVOTEK URL Command Document for All Series URL Command Document for IB8156 rnameemail the DDNS service provider <provider>_pas string[64] <blank> Your password or key to login to the swordkey DDNS service provider. string[128] <provider>_ser <blank> The server name for safe100.
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.13 UPnP port forwarding Group: upnpportforwarding NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP port forwarding service. upnpnatstatus The status of UPnP port forwarding, used internally.
Page 153
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.15 SNMP Group: snmp (capability.snmp > 0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) SNMP v2 enabled. 0 for disable, 1 for enable SNMP v3 enabled. 0 for disable, 1...
VIVOTEK URL Command Document for All Series URL Command Document for IB8156 vivotek logo 1 => hide the power by vivotek logo theme_option 1~3: One of the default themes. 4: Custom definition. theme_color_font string[7] #000000 Font color theme_color_configfont string[7] #ffffff Font color of configuration area.
Page 155
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series win_i<0~4>_height 0 ~ 240/288 Height of privacy mask window. 7.18 Capability Group: capability NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) api_httpversion 0300a 0300a The HTTP API version. bootuptime <positive Server bootup time.
Page 156
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series nvideosetting <positive Number of video settings integer> per channel. naudiosetting <positive Number of audio settings integer> per channel. nuart Number of UART <positive interfaces. integer> nmotion 0, <positive Number of motion window.
Page 157
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 0(bit 1 ~ 7 are valid), 1(bit 1 ~ 7 are invalid) Bit 9 => Reserved bit, always 1. Examples: PT8133: 0b1111 SD8362: 0b111111 VS8102: 0b10111101 windowless <boolean>...
Page 158
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series protocol_rtp_tcp <boolean> Indicate whether to support RTP over TCP. protocol_rtp_http <boolean> Indicate whether to support RTP over HTTP. protocol_spush_mjpeg <boolean> Indicate whether to support server push MJPEG. protocol_snmp <boolean>...
Page 159
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series videoin_maxframerate <a list of 30,30,30, Available maximum frame available 30,30 list. maximum frame rate separated commas> videoin_mjpeg_maxframerate <a list of 30,30,30, Available maximum frame available 30,30 list. maximum...
Page 160
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series available codec types separated commas) timeshift <boolean> Indicate whether to support time shift caching stream. audio_aec <boolean> Indicate whether to support acoustic echo cancellation. audio_mic <boolean> Indicate whether to support built-in microphone input.
Page 161
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series /cgi-bin/viewer/camctrl.cgi 0: support only /cgi-bin/viewer/camctrl.cgi transmission_mode Indicate transmission mode of the machine: TX = Both server, Rx = receiver box, Both = DVR. network_wire <boolean> Indicate whether to support Ethernet.
Page 162
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series storage_dbenabled <boolean> Media files are indexed in database. nanystream 0, <positive number of any media integer> stream per channel <boolean> Indicate whether to support Intelligent Video analysis <boolean>...
Page 163
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series image_wdrc <Boolean> Indicate whether to support WDRC image_ iristype <string> dciris Indicate iris type. image_ focusassist <Boolean> Indicate whether to support focus assist. localstorage_manageable <boolean> Indicate whether manageable local storage is supported.
Page 164
VIVOTEK URL Command Document for All Series URL Command Document for IB8156 Bit 0 => VADP interface Bit 1 => Capture video raw data Bit 2 => Support encode jpeg Bit 3 => Capture audio raw data Bit 4 => Support event trigger Bit 5 =>...
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.20 Event setting Group: event_i<0~2> PARAMETER VALUE Default SECURITY DESCRIPTION (get/set) name string[40] NULL Identification of this entry. enable 0, 1 Enable or disable this event. priority 0, 1, 2 Indicate the priority of this event: “0”...
Page 166
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series inter 1~999 Interval of snapshots in minutes. This field is used when trigger condition is “seq”. weekday 0~127 Indicate which weekday is scheduled. One bit represents one weekday.
Page 167
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.21 Server setting for event action Group: server_i<0~4> PARAMETER VALUE DEFAULT SECURITY DESCRIPTION (get/set) name string[40] NULL Identification of this entry type email, email Indicate the server type: ftp, “email”...
Page 168
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.22 Media setting for event action Group: media_i<0~4> (media_freespace is used internally.) PARAMETER VALUE DEFAULT SECURITY DESCRIPTION (get/set) name string[40] NULL Identification of this entry type snapshot, snapshot...
Page 169
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.23 Recording Group: recording_i<0~1> PARAMETER VALUE DEFAULT SECURITY DESCRIPTION (get/set) name string[40] NULL Identification of this entry. enable 0, 1 Enable or disable this recording. priority 0, 1, 2...
Page 170
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series weekday 0~127 Indicate which weekday is scheduled. One bit represents one weekday. bit0 (LSB) = Saturday bit1 = Friday bit2 = Thursday bit3 = Wednesday bit4 = Tuesday...
Page 171
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series adaptive_enable Indicate whether the adaptive recording is enabled adaptive_preevent Indicate when is the adaptive recording started before the event trigger point (seconds) adaptive_postevent 0~10 Indicate when is the adaptive...
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series stateorprovincename string[128] Asia State or province name in the certificate information. localityname string[128] Asia The locality name in the certificate information. organizationname string[64] VIVOTEK Organization name in the Inc.
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.27 ePTZ setting Group: eptz_c<0~(n-1)> for n channel product. (capability.eptz > 0) PARAMETER VALUE Default SECURITY DESCRIPTION (get/set) osdzoom <boolean> Indicates multiple of zoom in is “on-screen display” or not smooth <boolean>...
Page 174
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series preset_i<0~19>_size <window size> <blank> Width and height of the preset. (It should be set by ePreset.cgi rather than by setparam.cgi.) 7.28 Exposure window setting per channel Group: exposurewin_c<0~(n-1)> for n channel products...
Page 175
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series blc: Use BLC. i<0~(m-1)>_win_i0_enable <boolean> Enable or disable the window. i<0~(m-1)>_win_i0_policy 0: Indicate exclusive. 1: Indicate inclusive. i<0~(m-1)>_win_i0_home <coordinate> (80, 60) Left-top corner coordinate of the window. i<0~(m-1)>_win_i0_size <window...
Page 176
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 7.30 VIVOTEK Application Development Platform setting Group: vadp NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) version <string> 1.1.0.0 Indicate the VADP version. resource_total_video <integer> Indicate total video resource number of the system.
Page 177
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series module_number <integer> Record the total module number that already stored in the system. module_order <blank> The execution order of string[40] the enabled modules. module_save2sd <boolean> Indicate if the module...
Page 178
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series commands from the system. status <blank> Indicate the running string[40] status of the module. 7.31 GENETEC info Group: genetec NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) image_contrast <integer> Only for genetec...
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 8. Useful Functions 8.1 Capture Single Snapshot Note: This request requires Normal User privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/video.jpg?[channel=<value>][&resolution=<value>] [&quality=<value>][&streamid=<value>] If the user requests a size larger than all stream settings on the server, this request will fail.
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series PARAMETER VALUE DESCRIPTION method Add an account to the server. When using this method, the “username” field is necessary. It will use the default value of other fields if not specified.
VIVOTEK URL Command Document for All Series URL Command Document for IB8156 <system log information>\r\n 8.4 Upgrade Firmware Note: This request requires Administrator privileges. Method: POST Syntax: http://<servername>/cgi-bin/admin/upgrade.cgi Post data: fimage=<file name>[&return=<return page>]\r\n \r\n <multipart encoded form data> Server will accept the file named <file name> to upgrade the firmware and return with <return page>...
Page 182
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=1&vx=2&vy=2&vz=2 http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=1&x=100&y=100& videosize=640x480&resolution=640x480&stretch=0 PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of video source. stream <0~(m-1)> Stream. move home Move to home ROI. Move up. down Move down. left Move left.
Page 183
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series speedtilt -5 ~ 5 Set the tilt speed. speedzoom -5 ~ 5 Set the zoom speed. speedapp 1 ~ 5 Set the auto pan/patrol speed. return <return page>...
Page 184
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 8.7 ePTZ Preset Locations Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/ePreset.cgi?channel=<value>&stream=<value> [&addpos=<value>][&delpos=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source. stream <0~(m-1)>...
Page 185
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series delv6 Delete IPv6 address from access list. <IP address> Single address: <IP address> Network address: <IP address / network mask> Range address:<start IP address - end IP address>...
Page 186
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series See Event/control tunnel spec for detail information 8.10 Get SDP of Streams Note: This request requires Viewer access privileges. Method: GET Syntax: http://<servername>/<network_rtsp_s<0~m-1>_accessname> “m” is the stream number.
Page 187
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 8.12 Storage managements Note: This request requires administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=<cmd_type>[&<parameter>=<value>…] The commands usage and their input arguments are as follows. PARAMETER VALUE DESCRIPTION cmd_type <string>...
Page 188
VIVOTEK URL Command Document for All Series URL Command Document for IB8156 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.
Page 189
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series Command: update PARAMETER VALUE DESCRIPTION label <integer primary key> Required. Identify the designated record. Ex. label=1 isLocked <boolean> Required. Indicate if the file is locked or not. Ex. Update records whose key numbers are 1 and 5 to be locked status.
Page 190
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series Subgroup of stormgr: i<0~(n-1)>: n is the total number of displayed records. Element name Type Description label <Integer Primary Key> A unique integer. triggerType <Text> Indicate the event trigger type.
Page 191
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series <backup>0</backup> </i0> <i1> <label>2</label> <triggerType>di</triggerType> <mediaType>snapshot</mediaType> <destPath>/mnt/auto/NCMF/123/123.jpg</destPath> <resolution>800x600</resolution> <isLocked>0</isLocked> <triggerTime>2009-01-24 12:01:00</triggerTime> <backup>0</backup> </i1> </stormgr> Ex. Local storage status in XML format. <?xml version="1.0" encoding="ISO-8859-1" ?> <stormgr version="0.0.0.1"> <disk>...
Page 192
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series PARAMETER VALUE DESCRIPTION retType xml or javascript Optional. Ex. retype=javascript The default return message is in XML format. Ex. Query local storage status and call for javascript format return message.
Page 193
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 8.13 Virtual input Note: Change virtual input (manual trigger) status. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/setvi.cgi?vi0=<value>[&vi1=<value>][&vi2=<value>] [&return=<return page>] PARAMETER VALUE DESCRIPTION vi<num> state[(duration)nstate] Ex: vi0=1 Setting virtual input 0 to trigger state Where "state"...
Page 194
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series Examples: 1. setvi.cgi?vi0=0(15000)1 2. setvi.cgi?vi0=1 Request 2 will not be accepted during the execution time(15 seconds). 8.14 Open Timeshift Stream Note: This request requires Viewer access privileges. Syntax: For HTTP push server (MJPEG): http://<servername>/<network_http_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&refti...
Page 195
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series feature and if minsft is achievable. If false, return “415 Unsupported Media Type”. minsft <positive How many seconds of cached stream client can integer> accept at least. (Used by forcechk)
Page 196
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 8.16 Upload Files Note: This request requires Administrator privileges. Method: POST Syntax: For daylight saving time configuration file: http://<servername>/cgi-bin/admin/upload_dst.cgi Post data: filename =<file name>\r\n \r\n <multipart encoded form data>...
Page 197
VIVOTEK URL Command Document for IB8156 URL Command Document for All Series 8.17 Media on demand 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://<servername>/mod.sdp?[&stime=<value>][&etime=<value>][&length =<value>][&loctime =<value>][&file=<value>][&tsmode=<value>]...
Following are the URL commands for the IB8168 VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 3. General CGI URL Syntax and Parameters When the CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server.
Page 199
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 4. Security Level SECURITY SUB-DIRECTORY DESCRIPTION LEVEL anonymous Unprotected. 1 [view] anonymous, viewer, 1. Can view, listen, talk to camera. dido, camctrl 2. Can control DI/DO, PTZ of the camera.
Page 200
VIVOTEK URL Command Document for IB8168 URL Command Document for IB8168 URL Command Document for IB8168 URL Command Document for IB8168 URL Command Document for IB8168 URL Command Document for IB8168 URL Command Document for IB8168 URL Command Document for IB8168...
Page 201
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 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 User's Manual - 201...
Page 202
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 6. Set Server Parameter Values Note: The access right depends on the URL directory. Method: GET/POST Syntax: http://<servername>/cgi-bin/anonymous/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/operator/setparam.cgi? <parameter>=<value> [&<parameter>=<value>…][&return=<return page>] http://<servername>/cgi-bin/admin/setparam.cgi? <parameter>=<value>...
Page 203
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 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...
Page 204
URL Command Document for All Series 7. Available parameters on the server This chapter defines all the parameters which can be configured or retrieved from VIVOTEK network camera or video server. The general format of description is listed in the table below...
Page 205
VIVOTEK URL Command Document for IB8168 URL Command Document for IB8168 URL Command Document for IB8168 URL Command Document for IB8168 URL Command Document for All Series 7.1 system Group: system NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) hostname string[64] Mega-Pixel Host name of server.
Page 206
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series -201: GMT-05:00 Bogota, Lima, Quito, Indiana -180: GMT-04:30 Caracas -160: GMT-04:00 Atlantic Time, Canada, La Paz, Santiago -140: GMT-03:30 Newfoundland -120: GMT-03:00 Brasilia, Buenos Aires, Georgetown, Greenland -80: GMT-02:00 Mid-Atlantic -40: GMT-01:00 Azores, Cape_Verde_IS.
Page 207
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series Ekaterinburg, Islamabad, Karachi, Tashkent 220: GMT 05:30 Calcutta, Chennai, Mumbai, New Delhi 230: GMT 05:45 Kathmandu 240: GMT 06:00 Almaty, Novosibirsk, Astana, Dhaka, Sri Jayawardenepura 260: GMT 06:30 Rangoon...
Page 208
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series -140,-120, -80,-40,0, 40,41,80, 81,82,83, 120,140, 380,400,48 updateinterval 0 to Disable automatic time 3600, adjustment, otherwise, it 86400, indicates the seconds between 604800, NTP automatic update 2592000 intervals. restore Restore the system <positive...
Page 209
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series cooperating with others, the system parameters will be restored to default values except for a union of combined results. restoreexceptlang <Any Value> Restore the system parameters to default values except the custom language file the user has uploaded.
Page 210
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 7.1.1 system.info Subgroup of system: info (The fields in this group are unchangeable.) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) modelname string[40] IB8168 Internal model name of the server serialnumber <mac...
Page 211
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 7.2 status Group: status NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) onlinenum_rtsp integer Current number of RTSP connections. onlinenum_httppush integer Current number of HTTP push server connections. eth_i0 <string>...
Page 212
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 7.4 network Group: network NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) preprocess <positive NULL An 32-bit integer, each bit can be set separately as integer> follows: Bit 0 => HTTP service;...
Page 213
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series dns1 <ip <blank> Primary DNS server. address> dns2 <ip <blank> Secondary DNS server. address> wins1 <ip <blank> Primary WINS server. address> wins2 <ip <blank> Secondary WINS server. address>...
Page 214
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 7.4.2 QOS Subgroup of network: qos_cos (capability.protocol.qos.cos > 0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean> Enable/disable CoS (IEEE 802.1p) vlanid 1~4095 VLAN ID video Video channel for CoS...
Page 215
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 7.4.4 FTP Subgroup of network: ftp NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) port 21, 1025~65535 Local ftp server port. 7.4.5 HTTP Subgroup of network: http NAME VALUE DEFAULT...
Page 216
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 7.4.6 HTTPS port Subgroup of network: https (capability.protocol.https > 0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) port 443, 1025 ~ HTTPS port. 65535 7.4.7 RTSP Subgroup of network: rtsp (capability.protocol.rtsp > 0)
Page 217
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 239.128.1.100, and so on. videoport 1025 ~ 65535 5560+n*2 Multicast video port. 1 ~ 255 Mutlicast time to live value. 7.4.8 RTP port Subgroup of network: rtp NAME...
Page 218
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series <ip address> Network address: <ip address / network mask> Range address:<start ip address - end ip address> ipv6list_i<0~9> String[43] IPv6 address list. <blank> 7.6 video input Group: videoin...
Page 219
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 7.6.1 video input setting per channel Group: videoin_c<0~(n-1)> for n channel products, and m is stream number NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) cmosfreq 50, 60 CMOS frequency.
Page 220
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series textonvideo_size 15,25,30 Timestamp and video title font-size minexposure 5, 15, 25, 30, 32000 Minimum exposure time. 50, 60, 100, 120, 240, 250, 480, 500, 1000, 2000, 4000, 8000, 16000,...
Page 221
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series s<0~(m-1)>_h264_priority framerate, framerate The policy to apply when policy imagequality the target bit rate is not sufficient to satisfy current encoded conditions. “framerate” indicates frame rate first. “imagequality” indicates image quality first.
Page 222
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series s<0~(m-1)>_mjpeg_priorit framerate, framerate The policy to apply when ypolicy imagequality the target bit rate is not sufficient to satisfy current encoded conditions. “framerate” indicates frame rate first. “imagequality” indicates image quality first.
Page 223
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 7.6.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).
Page 224
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series flickerless Turn on(1) of turn off(0) the flickerless mod 7.7 image setting per channel Group: image_c<0~(n-1)> for n channel products NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) brightness -5 ~ 5 Adjust brightness of image according to mode settings.
Page 225
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 7.9 Motion detection settings Group: motion_c<0~(n-1)> for n channel product NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean> Enable motion detection. win_i<0~2>_enable <boolean> Enable motion window 1~3. win_i<0~2>_name string[14] <blank>...
Page 226
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series i<0~(m-1)>_win_i<0~4>_top 0 ~ 240 Top coordinate of window position. i<0~(m-1)>_win_i<0~4>_width 0 ~ 320 Width of motion detection window. i<0~(m-1)>_win_i<0~4>_height 0 ~ 240 Height of motion detection window. i<0~(m-1)>_win_i<0~4>_objsize...
Page 227
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series rnameemail the DDNS service provider <provider>_pas string[64] <blank> Your password or key to login to the swordkey DDNS service provider. string[128] <provider>_ser <blank> The server name for safe100.
Page 228
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 7.13 UPnP port forwarding Group: upnpportforwarding NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean> Enable or disable the UPnP port forwarding service. upnpnatstatus The status of UPnP port forwarding, used internally.
Page 229
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 7.15 SNMP Group: snmp (capability.snmp > 0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) SNMP v2 enabled. 0 for disable, 1 for enable SNMP v3 enabled. 0 for disable, 1...
Page 230
Hyperlink of the logo vivotek.co logo_powerbyvvtk_hidden <boolean> 0 => display the power by vivotek logo 1 => hide the power by vivotek logo theme_option 1~3: One of the default themes. 4: Custom definition. theme_color_font string[7] #000000 Font color...
Page 231
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 7.17 Privacy mask Group: privacymask_c<0~(n-1)> for n channel product NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean> Enable privacy mask. win_i<0~4>_enable <boolean> Enable privacy mask window. win_i<0~4>_name string[14] <blank>...
Page 232
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series <positive (manual trigger) integer> Number of digital outputs. <positive integer> naudioin Number of audio inputs. <positive integer> naudioout Number of audio outputs. <positive integer> nvideoin <positive Number of video inputs.
Page 233
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 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) Bit 6 => Support iris operation;...
Page 234
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series protocol_https < boolean > Indicate whether to support HTTP over SSL. protocol_rtsp < boolean > Indicate whether to support RTSP. protocol_sip <boolean> Indicate whether to support SIP. protocol_maxconnection <positive...
Page 235
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series resolution 640x360, separated 1280x720, 1360x768, 1600x904, commas> 1920x1080 videoin_nresolution Available resolutions list. < number of available resolution list> videoin_maxframerate <a list of 30,30,30, Available maximum frame available 30,15,15, list.
Page 236
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series svc) <product dependent> videoin_fov <a list of 1920x1080 Available crop size list. available crop size separated commas> videoin_codec mjpeg, mjpeg,h264 Available codec list. h264 videoin_flexiblebitrate <boolean> Indicate whether to support flexible bitrate.
Page 237
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series HTTP tunnel for UART transfer. camctrl_httptunnel <boolean> The attribute indicates whether sending camera control commands through HTTP tunnel is supported. 0: Not supported 1: Supported camctrl_privilege <boolean> Indicate whether to support “Manage Privilege”...
Page 238
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series wireless WPA2. derivative_brand <boolean> Indicate whether to support the upgrade function for the derivative brand. For example, if the value is true, the VVTK product can be upgraded to VVXX.
Page 239
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series media_snapshot_sizepersecond <positive Maximum size (KB) of one integer> snapshot image. media_snapshot_maxpreevent <positive Maximum snapshot integer> number before event occurred. media_snapshot_maxpostevent <positive Maximum snapshot integer> number after event occurred.
Page 240
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series supportsd <boolean> Indicate whether to support local storage. remotecamctrl_master Indicate whether to <positive support remote auxiliary integer> camera (master side), this value means supporting max number of auxiliary camera.
Page 241
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 7.19 Customized event script Group: event_customtaskfile_i<0~2> PARAMETER VALUE Default SECURITY DESCRIPTION (get/set) name string[40] NULL Custom script identification of this entry. date string[20] NULL Date of custom script.
Page 242
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series mdwin <integer> Indicate the source window id of motion detection. This field is required when trigger condition is “md”. One bit represents one window. The LSB indicates the 1 window.
Page 243
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series action_cf_backup <boolean> Enable the capability of backing up recorded files to the SD card when network is lost. 0: Disabled 1: Enabled action_server_i<0~4>_en 0, 1 Enable or disable this server action.
Page 244
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series email_port 0~65535 Port to connect to the server. email_username string[64] NULL Username to log in to the server. email_passwd string[64] NULL Password of the user. email_senderemail string[128] NULL Email address of the sender.
Page 245
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series videoclip_source 0 ~ 2 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.
Page 246
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series notifyserver 0~31 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.
Page 247
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series dest The destination to store the recorded data. “cf” means local storage (CF or SD card). “0” means the index of the network storage. cffolder string[128] NULL Folder name.
Page 248
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series method auto, Auto auto => Create self-signed manual, certificate automatically. install manual => Create self-signed certificate manually. install => Create certificate request and install. status -3 ~ 1 Specify the https status.
Page 249
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 7.26 Region of interest Group: roi_c<0~(n-1)> for n channel product, and m is the number of streams which support ROI. (capability.eptz > 0) PARAMETER VALUE Default SECURITY DESCRIPTION (get/set) s<0~(m-1)>_home...
Page 250
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series patrolseq string[120] <blank> The patrol sequence of ePTZ. All the patrol position indexes will be separated by "," patroldwelling string[160] <blank> The dwelling time (unit: second) of each patrol point, separated by “,”.
Page 251
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) i<0~(m-1)>_mode auto, custom, auto The mode indicates how to decide the exposure. auto: Use full view as the only one exposure window.
Page 252
(Read only) guid<0~2>_id string[127] <blank> The connected seamless streaming (Read only) guid<0~2>_number Number of connected seamless streaming with guid<0~2>_id. (Read only) 7.30 VIVOTEK Application Development Platform setting Group: vadp NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) version <string> 1.1.0.0 Indicate the VADP version.
Page 253
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series resource_free_do <integer> Indicate free DO resource number of the system. resource_free_memory <integer> 24576 Indicate free memory size for VADP modules. resource_free_storage <integer> Indicate current free storage size for uploading VADP modules.
Page 254
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series of the module. path <blank> Record the storage path of string[40] the module. initscr <blank> The script that will handle string[40] operation commands from the system. status <blank>...
Page 255
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 8. Useful Functions 8.1 Capture Single Snapshot Note: This request requires Normal User privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/video.jpg?[channel=<value>][&resolution=<value>] [&quality=<value>][&streamid=<value>] If the user requests a size larger than all stream settings on the server, this request will fail.
Page 256
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series URL Command Document for IB8168 PARAMETER VALUE DESCRIPTION method Add an account to the server. When using this method, the “username” field is necessary. It will use the default value of other fields if not specified.
Page 257
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series <system log information>\r\n 8.4 Upgrade Firmware Note: This request requires Administrator privileges. Method: POST Syntax: http://<servername>/cgi-bin/admin/upgrade.cgi Post data: fimage=<file name>[&return=<return page>]\r\n \r\n <multipart encoded form data> Server will accept the file named <file name> to upgrade the firmware and return with <return page>...
Page 258
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=1&vx=2&vy=2&vz=2 http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=1&x=100&y=100& videosize=640x480&resolution=640x480&stretch=0 PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of video source. stream <0~(m-1)> Stream. move home Move to home ROI. Move up. down Move down. left Move left.
Page 259
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series speedtilt -5 ~ 5 Set the tilt speed. speedzoom -5 ~ 5 Set the zoom speed. speedapp 1 ~ 5 Set the auto pan/patrol speed. return <return page>...
Page 260
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 8.7 ePTZ Preset Locations Note: This request requires Operator privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/operator/ePreset.cgi?channel=<value>&stream=<value> [&addpos=<value>][&delpos=<value>][&return=<return page>] PARAMETER VALUE DESCRIPTION channel <0~(n-1)> Channel of the video source. stream <0~(m-1)>...
Page 261
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series delv6 Delete IPv6 address from access list. <IP address> Single address: <IP address> Network address: <IP address / network mask> Range address:<start IP address - end IP address>...
Page 262
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series See Event/control tunnel spec for detail information 8.10 Get SDP of Streams Note: This request requires Viewer access privileges. Method: GET Syntax: http://<servername>/<network_rtsp_s<0~m-1>_accessname> “m” is the stream number.
Page 263
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 8.12 Storage managements Note: This request requires administrator privileges. Method: GET and POST Syntax: http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=<cmd_type>[&<parameter>=<value>…] The commands usage and their input arguments are as follows. PARAMETER VALUE DESCRIPTION cmd_type <string>...
Page 264
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 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.
Page 265
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series Command: update PARAMETER VALUE DESCRIPTION label <integer primary key> Required. Identify the designated record. Ex. label=1 isLocked <boolean> Required. Indicate if the file is locked or not. Ex. Update records whose key numbers are 1 and 5 to be locked status.
Page 266
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series Subgroup of stormgr: i<0~(n-1)>: n is the total number of displayed records. Element name Type Description label <Integer Primary Key> A unique integer. triggerType <Text> Indicate the event trigger type.
Page 267
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series <backup>0</backup> </i0> <i1> <label>2</label> <triggerType>di</triggerType> <mediaType>snapshot</mediaType> <destPath>/mnt/auto/NCMF/123/123.jpg</destPath> <resolution>800x600</resolution> <isLocked>0</isLocked> <triggerTime>2009-01-24 12:01:00</triggerTime> <backup>0</backup> </i1> </stormgr> Ex. Local storage status in XML format. <?xml version="1.0" encoding="ISO-8859-1" ?> <stormgr version="0.0.0.1"> <disk>...
Page 268
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series PARAMETER VALUE DESCRIPTION retType xml or javascript Optional. Ex. retype=javascript The default return message is in XML format. Ex. Query local storage status and call for javascript format return message.
Page 269
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 8.13 Virtual input Note: Change virtual input (manual trigger) status. Method: GET/POST Syntax: http://<servername>/cgi-bin/admin/setvi.cgi?vi0=<value>[&vi1=<value>][&vi2=<value>] [&return=<return page>] PARAMETER VALUE DESCRIPTION vi<num> state[(duration)nstate] Ex: vi0=1 Setting virtual input 0 to trigger state Where "state"...
Page 270
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series Examples: 1. setvi.cgi?vi0=0(15000)1 2. setvi.cgi?vi0=1 Request 2 will not be accepted during the execution time(15 seconds). 8.14 Open Timeshift Stream Note: This request requires Viewer access privileges. Syntax: For HTTP push server (MJPEG): http://<servername>/<network_http_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&refti...
Page 271
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series feature and if minsft is achievable. If false, return “415 Unsupported Media Type”. minsft <positive How many seconds of cached stream client can integer> accept at least. (Used by forcechk)
Page 272
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 8.16 Upload Files Note: This request requires Administrator privileges. Method: POST Syntax: For daylight saving time configuration file: http://<servername>/cgi-bin/admin/upload_dst.cgi Post data: filename =<file name>\r\n \r\n <multipart encoded form data>...
Page 273
VIVOTEK URL Command Document for IB8168 URL Command Document for All Series 8.17 Media on demand 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://<servername>/mod.sdp?[&stime=<value>][&etime=<value>][&length =<value>][&loctime =<value>][&file=<value>][&tsmode=<value>]...
Page 276
VIVOTEK Technology License Notice MPEG-4 AAC Technology THIS PRODUCT IS LICENSED UNDER THE MPEG-4 AAC AUDIO PATENT LICENSE. THIS PRODUCT MAY NOT BE DECOMPILED, REVERSE-ENGINEERED OR COPIED, EXCEPT WITH REGARD TO PC SOFTWARE, OF WHICH YOU MAY MAKE SINGLE COPIES FOR ARCHIVAL PURPOSES. FOR MORE INFORMATION, PLEASE REFER TO HTTP://WWW.VIALICENSING.COM.
取扱説明書に従って正しい取り扱いをして下さい Liability VIVOTEK Inc. cannot be held responsible for any technical or typographical errors and reserves the right to make changes to the product and manuals without prior notice. VIVOTEK Inc. makes no warranty of any kind with regard to the material contained within this document, including, but not limited to, the implied warranties of merchantability and fitness for any particular purpose.
Need help?
Do you have a question about the IB8156-C and is the answer not in the manual?
Questions and answers