background image

 

 

VIVOTEK

 

136 - User's Manual

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. The image and CGI-requests are handled by the built-in Web server.

2. Style Convention

In URL syntax and in descriptions of CGI parameters, text within angle brackets denotes content that 

is to be replaced with either a value or a string. When replacing the text string, the angle brackets 

should also be replaced. An example of this is the description of the name for the server, denoted with 

<servername> in the URL syntax description below, that is replaced with the string myserver in the URL 

syntax example further down in the page. 

URL syntax is denoted with the word "Syntax:" written in bold face followed by a box with the referenced 

syntax as shown below. For example, name of the server is written as <servername> and is intended to 

be replaced with the name of the actual server. This can either be a name, e.g., "mywebcam" or "thecam.

adomain.net" or the associated IP number for the server, e.g., 192.168.0.220.

Syntax:

http://<servername>/cgi-bin/viewer/video.jpg

Description of returned data is written with "

Return:

" in bold face followed by the returned data in a box. All data is 

returned in HTTP format, i.e., each line is separated with a Carriage Return and Line Feed (CRLF) printed as \r\n.
Return:

HTTP/1.0 <HTTP code> <HTTP text>\r\n

URL syntax examples are written with "

Example:

" in bold face followed by a short description and a light grey box 

with the example.

Example:

 request a single snapshot image

http://mywebserver/cgi-bin/viewer/video.jpg

Summary of Contents for 4712123677002

Page 1: ...Rev 1 0 2MP 8M IR Smart Stream II AEC WiFi Compact Size User s Manual Wireless Cube Network Camera IP8160 W Rev 1 1...

Page 2: ...ystem Parameters 45 System Maintenance 46 Media Image 50 Media Video 59 Media Video 60 Media Audio 68 Network General settings 69 Network Streaming protocols 76 Network SNMP Simple Network Management...

Page 3: ...K s Smart Stream II technology the IP8160 IP8160 W can reduce both bandwidth and storage consumption by up to 50 while retaining the same superb image quality as a Full HD camera Further the camera su...

Page 4: ...perly as intended The Network Camera is a network device and its use should be straightforward for those who have basic networking knowledge It is designed for various applications including video sha...

Page 5: ...ul 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 El...

Page 6: ...VIVOTEK 6 User s Manual Dimension Drawing 66 01 38 85 97 5 75 9 n 6 6...

Page 7: ...down the camera s MAC address for later reference 2 Install lthe camera to bracket by rotating and fastening the fastening ring Tilt the camera to a preferred shooting angle and then fasten the handl...

Page 8: ...VIVOTEK 8 User s Manual Note that the longer edge of the camera stand should be oriented to the camera side 4 Connect the included power between the camera and the power mains...

Page 9: ...ink Red Green every 1 sec Connected to network Refer to the functional description and LED definitions below when configuring the camera 5 Connecting to network There are 3 different ways to connect t...

Page 10: ...work Camera Model No XXXXXX MAC 0002D14BAD55 Pat 6 930 709 This device complies with part 15 of the FCC Rules Operation is subject to the following two conditions 1 this device may not cause harmful i...

Page 11: ...he Connect button Click to connect B 3 Open a web browser enter the camera s default IP 192 168 1 1 B 4 B 5 6 B 4 The camera will search for the other APs within the network Select an AP you prefer yo...

Page 12: ...Identify the camera using its MAC address C 1 C 2 Network Camera Model No XXXXXX MAC 0002D14BAD55 Pat 6 930 709 This device complies with part 15 of the FCC Rules Operation is subject to the followin...

Page 13: ...anual 13 C 3 192 168 1 1 C 4 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...

Page 14: ...C 6 C 7 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...

Page 15: ...n 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 wi...

Page 16: ...1 IP8160 W 0002D1730202 00 02 D1 73 02 02 192 168 5 151 IP8160 W IW2 Browser LAN 6 Open the IW2 utility The utility will search for cameras within the network 7 Double click on the camera to open a we...

Page 17: ...POWE R COLLIS ION LINK R E CE IVE PAR TITION 1 2 3 4 5 Internet 2 In this case if the Local Area Network LAN IP address of your Network Camera is 192 168 0 3 please forward the following ports for the...

Page 18: ...en the ports ac cordingly on your router For example you can open a management session with your router to configure access through the router to the camera within your local network Please consult yo...

Page 19: ...1 IP8160 W Installation Wizard 2 IW2 Network Camera Model No IP8160 W Made in Taiwan This device complies with part 15 of the FCC rules Operation is subject to the following two conditions 1 This devi...

Page 20: ...era 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 multi...

Page 21: ...nch your web browser e g Microsoft Internet Explorer or Mozilla Firefox 2 Enter the IP address of the Network Camera in the address field Press Enter 3 Live video will be displayed in your web browser...

Page 22: ...ection please refer to Security on page 89 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...

Page 23: ...a 32 bit IE browser will be opened IMPORTANT 1 The onscreen Java control can malfunction under the following situations A PC con nects to different cameras that are using the same IP address or the sa...

Page 24: ...ort number 554 please set the RTSP port to 554 For more information please refer to RTSP Streaming on page 77 For example 4 The live video will be displayed in your player For more information on how...

Page 25: ...is limited you will not be able to use a large video size Please set the video streaming parameters as listed below For more information please refer to Stream settings on page 59 Video Mode H 264 Fr...

Page 26: ...vivotek com 1 If you forget the root administrator password for the camera you can restore the camera defaults by pressing the reset button for longer than 7 seconds 2 If DHCP is enabled in your netw...

Page 27: ...information please refer to System on page 38 Camera Control Area Video Stream This Network Camera supports multiple streams streams 1 and 2 simultaneously You can select any of them for live viewing...

Page 28: ...deo cell will resize automatically to fit the monitor Click 100 is to display the original homepage size Click 50 is to resize the homepage to 50 of its original size Click 25 is to resize the homepag...

Page 29: ...ion on page 100 For more information about how to set up the viewing region of the current video stream please refer to page 100 The viewing region of the curruent video stream The largest frame size...

Page 30: ...format to your computer Press the Stop MP4 Recording button to end recording When you exit the web browser video recording stops accordingly To specify the storage destination and file name please ref...

Page 31: ...mage 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 The navigation screen indicates the part of th...

Page 32: ...g to the server takes up additional bandwidth and the Network Camera allows up to ten simultaneous accesses UDP multicast This protocol allows multicast enabled routers to forward network packets to a...

Page 33: ...local hard disk Add date and time suffix to the file name Select this option to append the date and time to the end of the file name Local Streaming Buffer Time In the case of encountering unsteady b...

Page 34: ...ck menu If your joystick is not detected if may be defective 2 Click Calibrate or Configure buttons to configure the joystick related settings If you want to assign Preset actions to your joystick the...

Page 35: ...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...

Page 36: ...not sure of the locations of each button use the Properties window in the Game Controllers utility Tips 3 Click the Assign button to assign an action to the button You can delete an association by sel...

Page 37: ...on item When you click on the first sub item the detailed information for the first sub item will be displayed when you click on the second sub item the detailed information for the second sub item wi...

Page 38: ...inished 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 The text will be displayed at the top of...

Page 39: ...manually Note that the date and time format are yyyy mm dd and hh mm ss Automatic The Network Time Protocol is a protocol which synchronizes computer clocks by periodically querying an NTP Server NTP...

Page 40: ...age using the default settings Follow the steps below to upload a new logo 1 Click Custom and the Browse field will appear 2 Select a logo from your files 3 Click Upload to replace the existing logo w...

Page 41: ...you to choose from The new layout will simultaneously appear in the Preview filed Click Save to enable the settings Font Color of the Video Title Background Color of the Video Area Frame Color Font C...

Page 42: ...ou want to change the color on the right column 3 The palette window will pop up as shown below 4 Drag the slider bar and click on the left square to select a desired color 5 The selected color will b...

Page 43: ...ver 3 When completed click Save to enable the setting You can configure the Network Camera to send the system log file to a remote server as a log backup Before utilizing this feature it is suggested...

Page 44: ...Short message Email GSM Modem HTTP PTZ Digital output You can install the included VAST recording software which provides an Event Management function group for delivering event messages via emails G...

Page 45: ...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 pag...

Page 46: ...ill see Reboot system now This connection will close After that re access the Network Camera The following message is displayed when the upgrade has succeeded The following message is displayed when y...

Page 47: ...ard and related settings If none of the options is selected all settings will be restored to factory default The following message is displayed during the restoring process Import Export files This fe...

Page 48: ...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...

Page 49: ...lick to export the current server status report such as time logs parameters process status memory status file system status network status kernel message and so on Tips If a firmware upgrade is accid...

Page 50: ...live viewing window and the maximum zoom in will be up to 4 times Position of timestamp and video title on image Select to display time stamp and video title on the top or at the bottom of the video s...

Page 51: ...be incongruous with its wide horizontal view With video rotation the camera can more readily cover the field of view on a tall and narrow scene The rotation here indicates clockwise rotation Rotation...

Page 52: ...ditions Night mode In night mode the camera streams video in black and white Schedule mode The Network Camera switches between day mode and night mode based on a specified schedule Enter the start and...

Page 53: ...n slide bars Image Adjustment Brightness Adjust the image brightness level which ranges from 0 to 100 Contrast Adjust the image contrast level which ranges from 0 to 100 Saturation Adjust the image sa...

Page 54: ...apply to Night mode or Schedule mode Please manually enter a range of time if you select the Schedule mode Then check Save to take effect Noise reduction Enable noise reduction Check to enable noise...

Page 55: ...t measurement window s for low light compensation For example where low light objects are posed against an extremely bright background You may want to exclude the bright sunlight shining through a bui...

Page 56: ...y electrical brightness gains The inclusive window refers to the weighed window the exclusive window refers to ignored window It adopts the weighed averages method to calculate the value The inclusive...

Page 57: ...hoose Schedule mode Then check Save to take effect Enable WDR enhanced This function allows users to identify more image details with an extreme contrast from an object of interest with one shadowed s...

Page 58: ...nt to delete the privacy mask window please click the x mark on the side of window name To configure privacy mask windows 1 Click New to add a new window 2 You can use 4 mouse clicks to create a new m...

Page 59: ...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 On this page you can configure the Regio...

Page 60: ...Window Region of Interest Viewing Region Region of Interest Output frame size Stream 1 1920 x 1080 176 x 144 Selectable 1920 x 1080 176 x 144 Selectable Stream 2 1920 x 1080 176 x 144 Selectable 1920...

Page 61: ...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...

Page 62: ...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...

Page 63: ...required for streaming a video can be tremendously reduced When streaming a video of a static scene the Dynamic Intra frame feature can save up to 53 of bandwidth The amount of bandwidth thus saved i...

Page 64: ...ested area The video quality of part of the screen returns to normal when one or more objects move in that area The remainder of the screen where there are no moving objects no pixel changes will stil...

Page 65: ...e Manual mode the non interested area is always transmitted using a low quality format regardless of the activities inside You should also select the Maximum bit rate from the pull down menu as the th...

Page 66: ...e Network Camera will try to maintain the frame rate per second performance while the image quality will be compromised If Image quality priority is selected the Network Camera may drop some video fra...

Page 67: ...rate This limits the maximum refresh frame rate per second Set the frame rate higher for smoother video quality If the power line frequency is set to 50Hz the frame rates are selectable from 1fps to...

Page 68: ...improves voice quality by preventing echo from sounds reflected and recorded by microphone Internal microphone input Select the gain of the external audio input according to ambient conditions Adjust...

Page 69: ...each time the camera is connected to the LAN 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...

Page 70: ...router so that video streams can be sent out from a LAN To utilize of this feature make sure that your router supports UPnPTM and it is activated PPPoE Point to point over Ethernet Select this option...

Page 71: ...rror Router does not support UPnP port forwarding Steps to enable the UPnPTM user interface on your computer Note that you must log on to the computer as a system administrator to install the UPnPTM c...

Page 72: ...es Enabling UPnP port forwarding allows the Network Camera to open a secondary HTTP port on the router not HTTP port meaning that you have to add the secondary HTTP port number to the Network Camera s...

Page 73: ...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 th...

Page 74: ...s format Please refer to HTTP streaming on page 76 for detailed information If you choose PPPoE as the Network Type the PPP0 address will be displayed in the IPv6 information column as shown below Man...

Page 75: ...VIVOTEK User s Manual 75...

Page 76: ...ween 1025 and 65535 If the ports are incorrectly assigned the following warning messages will be displayed To access the Network Camera on the LAN both the HTTP port and secondary HTTP port can be use...

Page 77: ...images will be displayed in your web browser NOTE Microsoft Internet Explorer does not support server push technology therefore you will not be able to access a video stream using http ip address htt...

Page 78: ...For example when the access name for stream 1 is set to live sdp 1 Launch an RTSP player 2 Choose File Open URL A URL dialog box will pop up 3 Type the above URL command in the text box 4 The live vi...

Page 79: ...to open the associated TCP port on routers and firewall Unicast video transmission delivers a stream through point to point transmission multicast on the other hand sends a stream to the multicast gr...

Page 80: ...VIVOTEK 80 User s Manual 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 81: ...AC address This service will examine if the host name is valid and automatically open a port on your router If using DDNS the user has to manually configure UPnP port forwarding Express Link is more c...

Page 82: ...hat before utilizing this function please apply for a dynamic domain account first Safe100 net 1 In the DDNS column select Safe100 net from the drop down list Click I accept after reviewing the terms...

Page 83: ...Register column fill in the Host name Email Key and Confirm Key then click Register After a host name has been successfully created you will see a success message in the DDNS Registration Result colum...

Page 84: ...naged device A network node on a managed network For example routers switches bridges hubs computer hosts printers IP telephones network cameras web server and database Before configuring SNMP setting...

Page 85: ...s 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 sav...

Page 86: ...ntifies a wireless network Access Points and wireless clients attempting to connect to a specific WLAN Wireless Local Area Network must use the same SSID The default setting is default Note The maximu...

Page 87: ...ts The default setting is 64 bits Key format Hexadecimal or ASCII The fault setting is HEX HEX digits consist of the numbers 0 9 and the letters A F ASCII is a code for representing English letters as...

Page 88: ...VIVOTEK 88 User s Manual Wireless WPS Use the Activate button when you also activate the WPS function on a wireless AP to establish a new connection...

Page 89: ...ave the ability to control the Network Camera through the main page Please refer to Configuration on page 37 Allow anonymous viewing If you check this item any client can access the live stream withou...

Page 90: ...munication with the Network Camera a Certificate must be created first There are three ways to create and install a certificate Create self signed certificate 1 Select this option from a pull down men...

Page 91: ...ed 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 p...

Page 92: ...te 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 pr...

Page 93: ...y 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...

Page 94: ...94 User s Manual 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...

Page 95: ...95 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 ena...

Page 96: ...een 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 addre...

Page 97: ...How much time the client has been at the webpage User ID If the administrator has set a password for the webpage the clients have to enter a user name and password to access the live video The user n...

Page 98: ...rily and will automatically try to re link again IE Explore or Quick Time Player Filter Enable access list filtering Check this item and click Save if you want to enable the access list filtering func...

Page 99: ...IP address Always allow the IP address to access this device You can check this item and add the Administrator s IP address in this field to make sure the Administrator can always connect to the devic...

Page 100: ...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 102 Auto pan patrol speed Select the speed from 1 5 slow fa...

Page 101: ...ewing region accordingly Moving Instantly If you check this item the live view window will switch to the new viewing region instantly after you move the floating frame If not selected the process of m...

Page 102: ...e 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 Sele...

Page 103: ...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...

Page 104: ...ggered you can specify what type of action that will be performed You can configure the Network Camera to send snapshots or videos to your email address or FTP site Event To configure an event with re...

Page 105: ...r stimulus which defines when to trigger the Network Camera The trigger source can be configured to use the Network Camera s built in motion detection mechanism or external digital input devices There...

Page 106: ...tem 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 cov...

Page 107: ...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 inc...

Page 108: ...detailed configuration options You can configure either one or all of them Server type Email Select to send the media files via email when a trigger is activated Server name Enter a name for the serv...

Page 109: ...dd server Server type FTP Select to send the media files to an FTP server when a trigger is activated Server name Enter a name for the server setting Server address Enter the domain name or IP address...

Page 110: ...dow as shown below If successful you will also receive a test txt file on the FTP server Click Save server to enable the settings Server type HTTP Select to send the media files to an HTTP server when...

Page 111: ...work Storage If you click the View button for an SD card a Local storage page will prompt so that you can manage the recorded files on SD card For more information about Local storage please refer to...

Page 112: ...rded data Click to go back to the previous level of the directory The format is HH 24r Click to open the file list for that hour The format is File name prefix Minute mm You can set up the file name p...

Page 113: ...shots from any of the video streams Send pre event images The Network Camera has a buffer to temporarily hold data up to a certain limit Enter a number to decide how many images to capture before a tr...

Page 114: ...eam as the source of video clip Pre event recording The Network Camera has a buffer to temporarily hold data up to a certain limit Enter a number to decide the duration of recording before a trigger i...

Page 115: ...ence File name prefix Enter the text that will be appended to the front of the file name For example Click Save media to enable the settings Media type System log Select to send a system log when a tr...

Page 116: ...Status is ON the event configuration above is triggered by motion detection the Network Camera will automatically send snapshots via e mail If you want to stop the event trigger you can click on the O...

Page 117: ...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...

Page 118: ...tem size to trigger an alarm Change the item size according to the live view To delete a window click the X mark on the right of the window name 3 Define the sensitivity to moving objects by moving th...

Page 119: ...s shown below Another three motion detection windows can be configured on this page Larger than the min item size Photos or videos can be captured instantly and configured to be sent to a remote serve...

Page 120: ...m item size is a threshold value that determines how many alerted pixels can trigger an event When the size of an intruding object is larger than the minimum size and its movement persist for 0 3 seco...

Page 121: ...r the difference between current frame and pre saved background exceeds the trigger threshold Conditions such as image too dark too bright or too blurry defocused can also be configured as tampering c...

Page 122: ...to configure Audio detection 1 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 Al...

Page 123: ...Refer to page 68 for Audio settings and page 61 for video streaming settings You can use the Profile window to configure a different Audio detection setting For example a place can be noisy in the day...

Page 124: ...hether the module fits the predefined VADP requirements Please contact our technical support or the vendor of your 3rd party module for the parameters contained within Users can also run VIVOTEK s VAD...

Page 125: ...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 126: ...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 user You can proceed with the...

Page 127: ...dd to open the recording setting window On this page you can define the adaptive recording recording source recording schedule and recording capacity A total of 2 recording settings can be configured...

Page 128: ...ered on Camera A will the server record the full frame rate streaming data otherwise it will only request the I frame data during normal monitoring thus effectively saves bandwidths and storage space...

Page 129: ...ils 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 2 Click Test to che...

Page 130: ...ecycled Enable cyclic recording If you check this item when the maximum capacity is reached the oldest file will be overwritten by the latest one The reserved amount is reserved for the transaction st...

Page 131: ...n about folder naming rules please refer to page 111 for details 20170210 20170211 20170212 f you want to enable recording notification please click Event to configure event triggering settings Please...

Page 132: ...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 no SD card NOTE It is recommended to turn OFF the recording activit...

Page 133: ...his 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 co...

Page 134: ...lt will highlight the selected item A Play window will appear on top for immediate review of the selected file For example Download Click on a search result to highlight the selected item in purple as...

Page 135: ...ch 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 Remove Select the desi...

Page 136: ...r the server denoted with servername in the URL syntax description below that is replaced with the string myserver in the URL syntax example further down in the page URL syntax is denoted with the wor...

Page 137: ...bdir cgi ext parameter value parameter value Example Set digital output 1 to active http mywebserver cgi bin dido setdo cgi do1 1 4 Security Level SECURITY LEVEL SUB DIRECTORY DESCRIPTION 0 anonymous...

Page 138: ...e parameter should be group _ name or group name If you do not specify any parameters all the parameters on the server will be returned If you specify only group the parameters oftherelated group will...

Page 139: ...i parameter value parameter value update value return return page http servername cgi bin admin setparam cgi parameter value parameter value update value return return page PARAMETER VALUE DESCRIPTION...

Page 140: ...work ipaddress 192 168 0 123 r n 7 Available parameters on the server Valid values VALID VALUES DESCRIPTION string n Text strings shorter than n characters The characters are invalid string n m Text s...

Page 141: ...red using the database encoding UTF 8 UTF 16BE or UTF 16 LE coordinate x y coordinate eg 0 0 window size window width and height eg 800x600 W H The format for coordinate in 2D W is the pixel number of...

Page 142: ...to use NTP to synchronize time datetime MMDDhhmmYYYY ss 6 6 Another current time format of the system ntp domain name ip address blank 6 6 NTP server Do not use skip to invoke default server for defau...

Page 143: ...uwait Riyadh Moscow St Petersburg Nairobi 121 GMT 03 00 Iraq 140 GMT 03 30 Tehran 160 GMT 04 00 Abu Dhabi Muscat Baku Tbilisi Yerevan 180 GMT 04 30 Kabul 200 GMT 05 00 Ekaterinburg Islamabad Karachi T...

Page 144: ...teger 7 6 Restore the system parameters to default values after value seconds reset 0 positive integer 7 6 Restart the server after value seconds if value is non negative restoreexceptnet 0 positive i...

Page 145: ...the system 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...

Page 146: ...rsion including model company and version number in the format MODEL BRAND VERSION language_count positive integer 0 7 Number of webpage languages available on the server language_i 0 count 1 string 1...

Page 147: ...num_sip 0 positive integer 6 7 Current number of SIP connections eth_i0 string 1 7 Get network information from mii tool vi_i 0 capability_nvi 1 product dependent boolean 1 7 Virtual input 0 Inactive...

Page 148: ...ing 64 6 7 User name user_i0_pass password 64 7 6 Root password user_i 1 20 _pass password 64 7 6 User password user_i0_privilege view operator admin 6 7 Root privilege user_i 1 20 _ privilege view op...

Page 149: ...address subnet rounter dns1 and dns2 ipaddress ip address 6 6 IP address of server subnet ip address 6 6 Subnet mask router ip address 6 6 Default gateway dns1 ip address 6 6 Primary DNS server dns2 i...

Page 150: ...oup of network qos_cos capability protocol qos cos 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable disable CoS IEEE 802 1p vlanid 1 4095 6 6 VLAN ID video 0 7 6 6 Video channel for...

Page 151: ...et DESCRIPTION port 21 1025 65535 6 6 Local ftp server port enable boolean 6 6 Enable ftp 7 6 5 HTTP Subgroup of network http NAME VALUE SECURITY get set DESCRIPTION port 80 1025 65535 1 6 HTTP port a...

Page 152: ...1025 65535 1 6 RTSP port capability protocol rtsp 1 anonymousviewing boolean 1 6 Enable anoymous streaming viewing authmode disable basic digest 1 6 RTSP authentication mode capability protocol rtsp 1...

Page 153: ...r greater than 0304a audioipaddress product dependent ip address 4 4 Multicast audio IP address We support this parameter when the version number httpversion is equal or greater than 0304a Only availa...

Page 154: ...E VALUE SECURITY get set DESCRIPTION user string 128 6 6 PPPoE account user name pass password 64 7 6 PPPoE account password 7 7IP Filter Group ipfilter NAME VALUE SECURITY get set DESCRIPTION enable...

Page 155: ...lance manually manual 2 cases a if rbgain is not supported this means keep current white balance status b if rbgain is supported rgain and bgain are updated to the current values which is got from whi...

Page 156: ...cklight compensation Not support this parameter anymore when the version number httpversion is equal or greater than 0301a It s recommanded to use exposurewin_c 0 n 1 _mode to switch on off BLC color...

Page 157: ...5s 1 8000s etc Only available when capability_image_c 0 n 1 _exposure_mi nrange Only valid when piris_mode manual or irismode fixed Only available when capability_image_c 0 n 1 _exposure_ra ngetype is...

Page 158: ...0 capability_videoin_c 0 n 1 _nm ode 1 4 4 Indicate the video mode on use whitebalance product dependent auto manual rbgain widerange outdoor indoor sodiumauto etc Available values are listed in capa...

Page 159: ...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 Only v...

Page 160: ...ally adjust the Iris Gain and Shutter Speed by VIVOTEK quality algorithm manual Manually adjust with variable Shutter Iris and Gain We support this parameter when the version number httpversion is equ...

Page 161: ...is smartsensor Only available when capability_image_c 0 n 1 _iristy pe piris enableblc Not support anymore boolean 4 4 Enable backlight compensation Not support this parameter anymore when the versio...

Page 162: ...bility_image_c 0 n 1 _expo sure_rangetype is onevalue Normalized range We support this parameter when the version number httpversion is equal or greater than 0302a color 0 1 4 4 0 monochrome 1 color f...

Page 163: ...Choose camera default font file usr share font Default ttf or user uploaded font file mnt flash2 upload ttf textonvideo_upl oadfilename Depends on the font file name uploaded by user 1 7 Show the uplo...

Page 164: ...axrange Only valid when piris_mode manual or irismode fixed Only available when capability_image_c 0 n 1 _expo sure_rangetype is twovalues shuttervalue product dependent 1 32000 5 32000 1 8000 5 8000...

Page 165: ...t We support this parameter when the version number httpversion is equal or greater than 0302a s 0 m 1 _e nableeptz boolean 4 4 Indicate whether stream supprts eptz or not s 0 m 1 _c odectype Listed a...

Page 166: ...d 4 Detailed 5 Excellent 100 Use the quality level in qpercent 99 Use the quality level in qvalue Only valid when ratecontrolmode vbr s 0 m 1 _h 264_qvalue 0 51 4 4 Manual video quality level input Th...

Page 167: ...normalized full range 1 Worst quality 100 Best quality Only valid when ratecontrolmode cbr and quant 100 Only available when capability_smartstream_version 2 0 s 0 m 1 _h 264_bitrate 20000 capability...

Page 168: ...ter than 0301c s 0 m 1 _h 265_intraperiod 250 500 1000 2000 3000 4000 4 4 The time interval between two I frames Intra coded picture The unit is millisecond ms Only available when h265 is listed in ca...

Page 169: ...s listed in capability_videoin_codec Only valid when ratecontrolmode vbr and quant 100 s 0 m 1 _h 265_maxvbrbitr ate 20000 capability_videoin_c 0 n 1 _h265_maxbitrate 4 4 The maximum allowed bit rate...

Page 170: ...bit rate in constant bit rate mode Only available when h265 is listed in capability_videoin_codec Only valid when ratecontrolmode cbr s 0 m 1 _h 265_prioritypoli cy framerate imagequality 4 4 Set prio...

Page 171: ...ty level in qvalue s 0 m 1 _m jpeg_qvalue 10 200 Only valid when capability_api_httpversion format is XXXXX_1 or XXXXX_3 ex 0301a_1 or 0301a_3 or 1 99 Only valid when capability_api_httpversion format...

Page 172: ...capability_smartstream_version 2 0 s 0 m 1 _m jpeg_cbr_qperc ent 1 100 4 4 Select customized quality in a normalized full range 1 Worst quality 100 Best quality Only valid when ratecontrolmode cbr and...

Page 173: ...e_c 0 n 1 _wdrp ro_strength is 1 wdrc_mode product dependent boolean 4 4 Enable WDR enhanced Only available when capability_image_c 0 n 1 _wdrc _mode is 1 wdrc_strength product dependent 1 100 4 4 The...

Page 174: ..._aesp eed is 1 and capability_image_c 0 n 1 _aesp eedsupportsensitivity is 1 flickerless product dependent boolean 4 4 Turn on 1 or turn off 0 the flickerless mode Only available when capability_image...

Page 175: ...eam2 capability_smartstream_support 1 capability_smartstream_version 2 0 and h265 is listed in capability_videoin_codec n denotes the value of capability_nvideoin m denotes the value of capability_nme...

Page 176: ...t 1 capability_smartstream_version 2 0 and capability_smartstream_mode_manual 1 Group videoin_c 0 n 1 _s 0 m 1 _h265_smartstream2_win_i 0 k 1 capability_smartstream_support 1 capability_smartstream_ve...

Page 177: ...pplied to 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...

Page 178: ...alue product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c 0 n 1 _exposu re_maxrange 4 4 Exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s...

Page 179: ...shutterpriority irispriority qualitypriority manual etc Available options are list in capability_image_c 0 n 1 _exposu re_modetype 4 4 Select exposure mode auto Automatically adjust the Iris Gain and...

Page 180: ...erange Auto Tracing White balance 2000K to 10000K outdoor auto white balance mode specifically for outdoor indoor auto white balance mode specifically for indoor sodiumauto sodium vapor lamps Only ava...

Page 181: ...manual or irismode fixed Normalized range Only available when capability_image_c 0 n 1 _exposure_ra ngetype is twovalues gainvalue 0 100 4 4 Gain value 0 Low 100 High Only available when capability_im...

Page 182: ...d indoor outdoor product dependent 4 4 Control DC Iris mode outdoor Auto setting DC Iris to get best quality but easy to meet rolling or flicker effect in indoor environment indoor Avoid rolling and f...

Page 183: ...verge speed 1 20 level 1 21 40 level 2 41 60 level 3 61 80 level 4 81 100 level 5 Level 1 4 low high The higher speed level meas shorter AE converged time during AE executing Only available when capab...

Page 184: ...tcontrol capability nvideoinprofile 0 and capability_daynight_c 0 n 1 _support 0 n denotes the value of capability_nvideoin NAME VALUE SECURITY get set DESCRIPTION mode auto day night di schedule prod...

Page 185: ...boolean 6 6 Switch to B W in night mode if enabled Only available when capability_daynight_c 0 n 1 _ blackwhitemode is 1 sensitivity low normal high if capability_daynight _c 0 n 1 _ircut sensitivity_...

Page 186: ...spercent This parameter will not be used after the version number httpversion is equal or greater than 0400a contrast Not recommended to use this 5 5 100 4 4 5 Less contrast 5 More contrast 100 Use im...

Page 187: ...00a brightnesspercent 0 100 4 4 Set brightness in the normalized range 0 Darker 100 Bright Only available when bit 0 of capability_image_c 0 n 1 _basicsetting is 1 contrastpercent 0 100 4 4 Set contra...

Page 188: ...e disable low light mode Only available when capability_image_c 0 n 1 _lowlightmode is 1 dnr_mode product dependent boolean 4 4 3D noise reduction 0 disable 1 enable Only available when capability_ima...

Page 189: ...nly available when capability_image_c 0 n 1 _scenemode_ support is 1 scene_mode product dependent visibility noiseless lpcparkinglot lpcstreet product dependent 4 4 Value of scene mode Only available...

Page 190: ...0 m 1 _contrast Not recommended to use this 5 5 100 4 4 5 Less contrast 5 More contrast 100 Use image_c 0 n 1 _contrastpercent Only available when bit 1 of capability_image_c 0 n 1 _basicsetting is 1...

Page 191: ...ht Only available when bit 0 of capability_image_c 0 n 1 _basicsetting is 1 profile_i 0 m 1 _contrastpe rcent 0 100 4 4 Set contrast in the normalized range 0 Less contrast 100 More contrast Only avai...

Page 192: ...endent boolean 4 4 3D noise reduction 0 disable 1 enable Only available when capability_image_c 0 n 1 _dnr is 1 profile_i 0 m 1 _dnr_stren gth product dependent 1 100 4 4 Strength of 3DNR Only availab...

Page 193: ...h product dependent 1 100 4 4 Strength of digital image stabilizer Only available when dis is listed in capability_image_c 0 n 1 _is_mode profile_i 0 m 1 _scene_ena ble product dependent boolean 4 4 E...

Page 194: ...area Group exposurewin_c 0 n 1 _win_i 0 k 1 n denotes the value of capability_nvideoin k denotes the value of capability_image_c 0 n 1 _exposure_winnum Only available when custom is listed in capabili...

Page 195: ...th and height of the window Only available when std is listed in capability_image_c 0 n 1 _exposure_wi ndomain Group exposurewin_c 0 n 1 _profile_i 0 m 1 for n channel profuct and m profile n denotes...

Page 196: ...320 0 240 4 4 Left top corner coordinate of the window Only available when qvga is listed in capability_image_c 0 n 1 _exposure_wi ndomain size 0 320x0 240 4 4 Width and height of the window Only ava...

Page 197: ...l or greater than 0301a We replace source with input More details please refer the parameter description of input input intmic extmic product dependent 4 4 intmic Internal built in microphone Only ava...

Page 198: ..._internal and volume_external boostmic Not recommended to use this 0 100 4 4 Enable microphone boost Gain of input audioin_c 0 n 1 _source micin Reserved for compatibility and suggest don t use this s...

Page 199: ...t G 726 bit streaming packing mode little Little endian bitstream format big Big endian bitstream format Only available if G 726 is supported s0_g726_vlcmode 0 1 4 4 Enable vlcmode for G 726 0 Standar...

Page 200: ...n windows The value 0 is reserved for compatibility and will not be used after the version number httpversion is equal or greater than 0400a Group motion_c 0 n 1 _win_i 0 k 1 n denotes the value of ca...

Page 201: ...use this 0 320 0 240 0 320 0 240 0 320 0 240 0 320 0 240 4 4 Coordinate of polygon window position 4 points x0 y0 x1 y1 x2 y2 x3 y3 Only available when capability_motion_wintype polygon Only available...

Page 202: ...the version number httpversion is equal or greater than 0400a height Not recommended to use this 0 240 4 4 Height of motion detection window Only available when capability_motion_wintype rectangle Onl...

Page 203: ...nable motion detection window name string 14 4 4 Name of motion window polygonstd 0 9999 0 9999 0 9999 0 9999 0 9999 0 9999 0 9999 0 9999 4 4 Coordinate of polygon window position 4 points x0 y0 x1 y1...

Page 204: ...e used after the version number httpversion is equal or greater than 0400a left Not recommended to use this 0 320 4 4 Left coordinate of window position Only available when capability_motion_wintype r...

Page 205: ...e polygonsd This parameter will not be used after the version number httpversion is equal or greater than 0400a height Not recommended to use this 0 240 4 4 Height of motion detection window Only avai...

Page 206: ...k detection dark_threshold 0 100 4 4 Threshold of image too dark detection dark_duration 1 10 4 4 If image too dark value exceeds the threshold for more than duration second s then image too dark dete...

Page 207: ...service provider provider _passwordkey string 64 7 6 Your password or key to login to the DDNS service provider provider _servername string 128 6 6 The server name for safe100 This field only exists i...

Page 208: ...roup syslog NAME VALUE SECURITY get set DESCRIPTION enableremotelog boolean 6 6 Enable remote log serverip IP address 6 6 Log server IP address serverport 514 1025 65535 6 6 Server port used for log l...

Page 209: ...e authentication password authpwro string 8 128 7 6 Read only authentication password authtyperw MD5 SHA 6 6 Read write authentication type authtypero MD5 SHA 6 6 Read only authentication type encrypt...

Page 210: ...or hide manual trigger VI button in homepage 0 Hidden 1 Visible theme_option 1 4 1 6 1 3 One of the default themes 4 Custom definition theme_color_font string 7 1 6 Font color theme_color_configfont...

Page 211: ...of window position Only available when capability_image_c 0 n 1 _privacymask _wintype rectangle win_i 0 m 1 _width 0 320 4 4 Width of privacy mask window Only available when capability_image_c 0 n 1 _...

Page 212: ...lity_image_c 0 n 1 _privacymask_wintype 3Drectangle n denotes the value of capability_nvideoin and m denotes the value of capability_videoin_c 0 n 1 _nprivacymask NAME VALUE SECURITY get set DESCRIPTI...

Page 213: ...change remove the old features interfaces or the firmware has substantially change in architecture and not able to roll back to previous version This may cause incompatibility with supporting software...

Page 214: ...capability_daynight_c 0 capability_nvideoi n 1 _externalir for external IR Not support this parameter anymore when the version number httpversion is equal or greater than 0301a npir 0 positive integer...

Page 215: ...eger each bit can be set separately as follows Bit 0 Support camera control function 0 not support 1 support Bit 1 Built in or external video source 0 external 1 built in Bit 2 Support pan operation 0...

Page 216: ...s strongly non recommended to use this This is reserved for compatibility and will not be used after the version number httpversion is equal or greater than 0400a We replace capability_remotefocus wit...

Page 217: ...pport iris control supportsd boolean 0 7 Indicate whether to support local storage fisheye boolean 0 7 The parameter is used to determine whether the product is fisheye or not tampering boolean 0 7 In...

Page 218: ...The maximum general streaming connections protocol_rtp_multicast_sc alable boolean 0 7 Indicate whether to support scalable multicast protocol_rtp_multicast_ba ckchannel boolean 0 7 Indicate whether t...

Page 219: ...h264_maxframer ate A list of Integer and 0 7 This equals capability_videoin_c0_h264_maxframerate This is kept for compatibility videoin_codec mjpeg h264 h265 product dependent 0 7 Available codec of a...

Page 220: ...timeshift boolean 0 7 Indicate whether to support time shift caching stream audio_aec boolean 0 7 Indicate whether to support acoustic echo cancellation audio_aecmode auto manual 0 7 Indicate the acou...

Page 221: ...in 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 nonne...

Page 222: ...upport this parameter anymore when the version number httpversion is equal or greater than 0301a It will be replaced by audio_intmic and audio_extmic audio_lineout boolean 0 7 Indicate whether to supp...

Page 223: ...ability_smartstream_support is 1 smartstream_windomain 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 s...

Page 224: ...be set separately as follows 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 Support license registration Bit...

Page 225: ...ualmode boolean 0 7 Indicate whether network dual mode is supported Only available when capability_network_wireless is 1 We support this parameter when the version number httpversion is equal or great...

Page 226: ...sion_onvifdaemon string 0 7 Indicate ONVIF daemon version version_onviftesttool string 0 7 Indicate ONVIF test tool version media_totalspace positive integer 0 7 Available memory space KB for media me...

Page 227: ...alstorage_modnum 0 positive integer 0 7 The maximum MOD connection numbers localstorage_modversion string 0 7 Indicate MOD daemon version localstorage_stormgrversi on string 0 7 Indicate storage manag...

Page 228: ...camctrl_c 0 n 1 n denotes the value of capability_nvideoin capability_ptzenabled 0 We support this group when the version number httpversion is equal or greater than 0303b PARAMETER VALUE SECURITY get...

Page 229: ...osition full time to adapt a clear picture onetimeauto Camera will automatically adjust the focus position one time which follows any PTZ control spotlight Camera will automatically adjust the focus p...

Page 230: ...maximum speed level of tilt motion Only available when bit1 of capability_camctrl_c 0 n 1 _buildinpt is 1 mintilt 0 positive integer 0 7 The lower limit for tilt position Only available when bit1 of c...

Page 231: ...is 1 minfocus 0 positive integer 0 7 The lower limit for focus position Only available when the value of capability_camctrl_c 0 n 1 _zoommodule is 1 maxfocus 0 positive integer 0 7 The upper limit fo...

Page 232: ...1 _support is 1 We support this parameter when the version number httpversion is equal or greater than 0302a ircutsensitivity_supportlevel 0 positive integer 0 7 The value indicate the support streng...

Page 233: ...t dependent 0 7 The lens type of this channel fisheye Fisheye lens fixed Build in fixed focus lens varifocal Build in varifocal lens changeable changeable lens Like box type camera users can install a...

Page 234: ...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 describe...

Page 235: ...privacy mask per channel nresolution positive integer 0 7 The maximum resolution options listed in resolution in current video mode resolution A list of WxH product dependent 0 7 Resolution options in...

Page 236: ...teger and 0 7 Maximum fps that the device can encoded with MJPEG on resolutions in current video mode means not support One to one mapping to the resolution in resolution The element number is defined...

Page 237: ...ger 0 7 Maximum bitrates of H 264 The unit is bps Only available when h264 is listed in capability_videoin_codec h265_maxframerate A list of Positive Integer and 0 7 Maximum fps that the device can en...

Page 238: ...era unit name of a split type camera system which the camera unit and the video core are separated If the camera is not a split type camera system the value of this parameter is We support this parame...

Page 239: ...0 7 Indicate this mode whether support eptz For nvideoin 1 the definition is as following A 32 bits integer each bit can be set separately as follows Bit 0 1st stream supports ePTZ or not Bit 1 2nd st...

Page 240: ...source equal to the captured size by device in this video mode The unit is pixel This value is used as a basic coordinate system for many features like ePTZ privacy mask motion etc Source most for im...

Page 241: ...ersion is equal or greater than 0304b maxframerate A list of Positive Integer 0 7 Indicates frame rate that the video source outputs in this video mode One to one mapping to the resolution in resoluti...

Page 242: ...e 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 6...

Page 243: ...in mode fixed au to exposurewin mode blc disab led aespeed disabled exposurelevel hidden exposurelevel fixed x exposurelevel fixed x x exposurelevel ranged x x exposuremode fixed auto x nonnegative in...

Page 244: ...le when capability_image_c 0 n 1 _wdrp ro_mode 0 wdrc_mode 0 1 0 7 0 Non support WDR Enhanced 1 Support WDR Enhanced wdrc_supportlevel 0 positive integer 0 7 Indicate the support strength level of WDR...

Page 245: ...ch 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 l...

Page 246: ...pability_image_c 0 n 1 _is_m ode is not We support this parameter when the version number httpversion is equal or greater than 0302a is_affect minexposure hidden mingain hidden wdrpro unchanged 3dnr u...

Page 247: ...mage_c 0 n 1 _is_m ode is not We support this parameter when the version number httpversion is equal or greater than 0302a scenemode_support 0 1 0 7 0 Non support scene mode 1 Support scene mode scene...

Page 248: ...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 lev...

Page 249: ...tsupport 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...

Page 250: ...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 describe...

Page 251: ...changed 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 252: ...rtsensor Smart sensor We support this parameter when the version number httpversion is equal or greater than 0302a exposure_mode 0 1 0 7 0 Non support exposure control 1 Support exposure control expos...

Page 253: ...0 7 One to one mapping to the mode type in exposure_modetype fixed The shutter value is the assigned value videoin_c 0 n 1 _gainvalue maximum The shutter value can be up to the assigned value videoin...

Page 254: ...ierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6...

Page 255: ...e 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...

Page 256: ...t 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 use...

Page 257: ...eger product dependent 0 7 When exposure quality priority mode is enabled some features may become malfunction or be forced to a given value The affected functions are list here The format is Affect A...

Page 258: ...rsion is equal or greater than 0305a exposure_manualmode_a ffect exposurewin mode blc hidd en defog disabled wdrpro disabled exposurelevel hidden or others x nonnegative integer product dependent 0 7...

Page 259: ...e when manual 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 grea...

Page 260: ...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...

Page 261: ...0 7 The domain to set an exposure window qvga a 320x240 range to represent the whole image px Locate a window in the image with pixels std A normalized 0 9999 range Not supported exposure_winnum 0 Po...

Page 262: ...mask window type polygon The window is a 2D polygon shape rectangle The window is a 2D rectangle shape 3Drectangle The window is a 3D rectangle shape privacymask_windomain qvga px std 0 7 The domain...

Page 263: ...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 sel...

Page 264: ...ro unchanged or others x nonnegative integer product dependent 0 7 When defog is enabled some features may become malfunction or be forced to a given value The affected functions are list here The for...

Page 265: ...d Only available when capability_image_c 0 n 1 _aesp eed is 1 aespeedsupportsensitivity 0 1 0 7 0 Non support tuning the sensitivity of AE converge speed 1 Support tuning the sensitivity of AE converg...

Page 266: ...opra nge lowrange product dependent 0 7 Available range for focuswindow We support this parameter when the version number httpversion is equal or greater than 0305d Not supported lensconfiguration_sup...

Page 267: ...l We support this parameter when the version number httpversion is equal or greater than 0305c washer_support boolean 0 7 Indicate whether to support the washer system which can clean the protective w...

Page 268: ...riority 0 1 2 6 6 Indicate the priority of this event 0 low priority 1 normal priority 2 high priority delay 1 999 6 6 Delay in seconds before detecting the next event trigger boot di pir motion seq r...

Page 269: ...detection is enabled vi 0 positive integer 6 6 Indicate the source id of vi trigger This field is required when trigger condition is vi One bit represents one digital input The LSB indicates VI 0 vadp...

Page 270: ...digital output trigger in seconds Only available when capability_ndo 0 action_cf_enable Boolean 6 6 Enable or disable sending media to SD card action_cf_folder string 128 6 6 Path to store media actio...

Page 271: ...event action Group server_i 0 4 PARAMETER VALUE SECURITY get set DESCRIPTION name string 40 6 6 Identification of this entry type email ftp http ns 6 6 Indicate the server type email email server ftp...

Page 272: ...rkgroup for network storage 7 29 Media setting for event action Group media_i 0 4 PARAMETER VALUE SECURITY get set DESCRIPTION name string 40 6 6 Identification of this entry type snapshot systemlog v...

Page 273: ...ans the first stream 1 means the second stream and etc 2 means the third stream and etc 3 means the fourth stream and etc videoclip_prefix string 16 6 6 Indicate the prefix of the filename videoclip_p...

Page 274: ...y_nmediastream 1 6 6 Indicate the source of media stream 0 means the first stream 1 means the second stream and so on maxretentiontime string 6 6 To specify the expired time for automatic clean up and...

Page 275: ...to detect events on Friday and Sunday set weekday as 66 begintime hh mm 6 6 Start time of the weekly schedule endtime hh mm 6 6 End time of the weekly schedule 00 00 24 00 indicates schedule always on...

Page 276: ...value is 1 it will force HTTP connection redirect to HTTPS connection method auto manual install 6 6 auto Create self signed certificate automatically manual Create self signed certificate manually in...

Page 277: ...ard compatibility reservations but only group disk_i0_autocleanup is effective Not recommended to use this Please refers autocleanup group This parameter will not be used after the version number http...

Page 278: ...10 hours The parameter takes effect when autocleanup_ maxretentiontime_recording_enabled is enabled maxretentiontime_others_e nabled boolean 6 6 Enable automatic clean up method for all media files e...

Page 279: ...imal 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 If the stream doesn t support ePTZ the permissions of this parame...

Page 280: ...pability_fisheye is 1 1 7 Tilt speed It should be set by eCamCtrl cgi rather than by setparam cgi panspeed 5 5 1 4 Pan speed Only available when capability_fisheye is 1 1 7 Pan speed It should be set...

Page 281: ...t top corner coordinate of the preset It should be set by ePreset cgi rather than by setparam cgi preset_i 0 19 _size WxH product dependent 1 4 Width and height of the preset Only available when capab...

Page 282: ...g Group vadp NAME VALUE SECURITY get set DESCRIPTION version string 6 7 Indicate the VADP version resource_total_memory 0 positive integer 6 7 Indicate total available memory size for VADP modules res...

Page 283: ...version string 40 6 6 Version of the module license string 40 6 6 Indicate the license status of the module licmsg string 128 6 6 Indicate the message that will be show on license status when mouse ov...

Page 284: ...cts capability ptzenabled 0 n denotes the value of capability_nvideoin and k denotes the value of capability_npreset NAME VALUE SECURITY get set DESCRIPTION panspeed 5 5 1 4 Pan speed tiltspeed 5 5 1...

Page 285: ...0 255 1 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 sy...

Page 286: ...0 k 1 _focus setting sync fixcurrent 1 4 The focus mode of each preset which is essential and should be grouped with preset_i 0 k 1 _name We support this parameter when the version number httpversion...

Page 287: ...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 Ther...

Page 288: ...his parameter when the version number httpversion is equal or greater than 0305b preset_i 0 k 1 _fliped boolean 1 4 Flip side at each preset location patrol_i 0 39 _name string 40 1 4 For internal dev...

Page 289: ...e idle idleaction_interval 1 999 1 4 While idle over this time interval idle action will be taken zoomenhance boolean 1 4 Enable disable zoom enhancement tour_index 1 0 19 1 4 Index of the enabled tou...

Page 290: ...ility fisheye 0 NAME VALUE SECURITY get set DESCRIPTION baudrate 110 300 600 1200 2400 3600 4800 72 00 9600 19200 384 00 57600 115200 4 4 Set baud rate of COM port databit 5 6 7 8 4 4 Data bits in a c...

Page 291: ...e 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 Therefore once you send a controlli...

Page 292: ...ult group Group lens_default NAME VALUE SECURITY get set DESCRIPTION totalnumbers 0 positive integer 6 7 Totoal support number of the default lens profiles Group lens_user NAME VALUE SECURITY get set...

Page 293: ...TION panspeed 5 5 integer 1 4 Pan speed of regional view tiltspeed 5 5 integer 1 4 Tilt speed of regional view zoomspeed 5 5 integer 1 4 Zoom speed of regional s 0 m 2 _panorama_ panstart 0 359 intege...

Page 294: ...upport 0 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION objsize_type 1 2 1 4 Type of object size 1 customized width and height 0 object size 30 x 30 1 object s...

Page 295: ...hoc encrypt none wep wpa wpa2 6 6 Encryption method none NONE wep WEP wpa WPA wpa2 WPA2PSK authmode OPEN SHARED 6 6 Authentication mode Only valid when wireless_encrypt is wep keylength 64 128 6 6 Key...

Page 296: ...SK mode pre shared key Only valid when wireless_encrypt is wpa or wpa2 7 49 Shock detection Group shock_c 0 n 1 for n channel products n denotes the value of capability_nvideoin capability_peripheral_...

Page 297: ...mal state 1 Active triggered state Example Drive the digital output 1 to triggered state and redirect to an empty page http myserver cgi bin dido setdo cgi do1 1 8 2 Query Status of the Digital Input...

Page 298: ...ivileges Method GET POST Syntax http servername 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 r n Content...

Page 299: ...VALUE DEFA ULT DESCRIPTION channel 0 n 1 0 The channel number of the video source resolution IP8165 160 640 120 360 IP8155 160 1280 120 1024 0 The resolution of the image quality 1 5 3 The quality of...

Page 300: ...the account password and privilege When using this method the username field is necessary and other fields are optional If not specified it will keep the original settings username name The name of th...

Page 301: ...0 OK r n Content Type text plain r n Content Length syslog length r n r n system log information r n 8 7 Upgrade Firmware Note This request requires Administrator privileges Method POST Syntax http se...

Page 302: ...trl eCamCtrl cgi channel 0 stream 0 move right 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 vi...

Page 303: ...y w h are essential parameters in an area zoom case and the stream index is counted from 0 as the first stream http IPAddr cgi bin camctrl eCamCtrl cgi channel 0 stream 0 x 912 y 297 w 864 h 488 resol...

Page 304: ...tion of streaming stretch boolean 0 indicates that it usesresolution streaming size as the range of the coordinate system 1 indicates that it usesvideosize plug in size as the range of the coordinate...

Page 305: ...n page after the parameter is assigned The return page should be the relative path according to the root of camera If you omit this parameter it will redirect to an empty page If the return page is in...

Page 306: ...ndex value ret urn return page http servername cgi bin admin ipfilter cgi method del v4 v6 index value return return page PARAMETER VALUE DESCRIPTION type NULL Get IP filter type allow deny Set IP fil...

Page 307: ...v4 Add IPv4 address into access list addv6 Add IPv6 address into access list delv4 Delete IPv4 address from access list delv6 Delete IPv6 address from access list ip IP address Single address IP addre...

Page 308: ...ie string 22 content type application x vvtk tunnelled pragma no cache cache control no cache content length 32767 expires Sun 9 Jam 1972 00 00 00 GMT User must use GET and POST to establish two chann...

Page 309: ...tion x vvtk tunnelled pragma no cache cache control no cache content length 32767 expires Sun 9 Jam 1972 00 00 00 GMT User must use GET and POST to establish two channels for downstream and upstream T...

Page 310: ...DP You can get the SDP by HTTP GET When using scalable multicast Get SDP file which contains the multicast information via HTTP 8 16 Open the Network Stream Note This request requires Viewer access pr...

Page 311: ...data The hex decimal data is a series of digits from 0 9 A F Each comma separates the commands by 200 milliseconds flush yes no yes Receive data buffer of the COM port will be cleared before read no D...

Page 312: ...mary key column will automatically be assigned a unique integer triggerType text Optional Indicate the event trigger type Please embrace your input value with single quotes Ex mediaType motion Support...

Page 313: ...Optional Specifies how many rows to skip at the beginning of the matched records Note that the offset keyword is used after limit keyword To increase the flexibility of search command you may use OR...

Page 314: ...efault return message is in XML format Ex Query local storage status and call for javascript format return message http servername cgi bin admin lsctrl cgi cmd queryStatus retType javascript 8 19 Virt...

Page 315: ...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 Examples setvi cgi vi0 0 1000...

Page 316: ...xsft positive integer 0 Request cached stream at most how many seconds ago tsmode normal adaptive normal Streaming mode normal Full FPS all the time adaptive Default send only I frame for MP4 and H 26...

Page 317: ...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 featur...

Page 318: ...bility_image_c 0 n 1 _remotefocus 1 Note This request requires Administrator privileges Method GET POST Syntax http servername cgi bin admin remotefocus cgi function value direction value position val...

Page 319: ...d point of effective focal length remote_focus_zoom_motor Current position of zoom motor remote_focus_focus_motor Current position of focus motor remote_focus_zoom_enable Current function of zoom moto...

Page 320: ...te_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 req...

Page 321: ...focus_focus_motor_start Start point of effective focal length remote_focus_focus_motor_end End point of effective focal length remote_focus_focus_motor Current position of focus motor remote_focus_foc...

Page 322: ...23 Export Files Note This request requires Administrator privileges Method GET Syntax For daylight saving time configuration file http servername cgi bin admin exportDst cgi For language file http ser...

Page 323: ...Post data filename file name r n r n multipart encoded form data For language file http servername cgi bin admin upload_lan cgi Post data filename file name r n r n multipart encoded form data For se...

Page 324: ...manually after you choose another lens configuration For choose selected lens configuration and reboot camera http servername cgi bin admin update_lens cgi choose_reboot_lens value The camera will reb...

Page 325: ...d time length positive integer N A The length of media of interest The unit is second loctime boolean 0 Specify if start end time is local time format 1 for local time 0 for UTC 0 file string N A The...

Page 326: ...image Move the center of image to the coordination x y based on resolution or videosize of 1O mode return return page Example http myserver cgi bin camctrl fdCamCtrl cgi channel 0 stream 0 move right...

Page 327: ...r It will be the x coordinate of center after movement y integer y coordinate clicked by user It will be the y coordinate of center after movement videosize window size The size of plug in ActiveX win...

Page 328: ...a 3D privacy mask maskname string 40 3D privacy mask name maskheight integer 3D privacy mask height maskwidth integer 3D privacy mask width videosize window size Optimal The size of plug in ActiveX wi...

Page 329: ...alue speedtilt value speedzoom value speedapp value speedlink val ue Set speeds return return page Example http myserver cgi bin camctrl camctrl cgi channel 0 camid 1 move right http myserver cgi bin...

Page 330: ...ol vy integer vs 0 127 Set the speed of movement 0 means stop x integer x coordinate clicked by user It will be the x coordinate of center after movement y integer y coordinate clicked by user It will...

Page 331: ...servername cgi bin camctrl camctrl cgi parameter parameter Example http myserver cgi bin camctrl camctrl cgi genpan Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n pan...

Page 332: ...ger Get the upper limit for pan position Only available when bit0 of capability_camctrl_c 0 n 1 _buildinpt is 1 getminpanangle integer Get the lower limit for pan angle Only available when bit0 of cap...

Page 333: ...for focus position 8 30 Recall capability_camctrl_c 0 n 1 _zoommodule 1 Note This request requires Viewer privileges Method GET Syntax http servername cgi bin viewer recall cgi recall value channel v...

Page 334: ...E 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 return re...

Page 335: ...anual 335 8 32 SmartSD capability_localstorage_smartsd 0 Note This request requires Administrator privileges Method GET POST Syntax http servername cgi bin admin smartsd cgi function value PARAMETER V...

Page 336: ...it The SD card is recommended to be replaced if the percentage reaches above 90 smartsd_spare_block_rate Usage rate of spare blocks It means the usage percentage of total spare block The range is from...

Page 337: ...rk_wireless 0 Note This request requires Administrator privileges Method GET POST Syntax http servername cgi bin admin getwirelessinfo cgi PARAMETER VALUE DESCRIPTION N A N A Get wireless information...

Page 338: ...1 _ devicecontrol 0 Note This request requires Administrator privileges Method GET POST Syntax for control API http servername cgi bin admin peripheral cgi channel value operation set washer_mode valu...

Page 339: ...rol system Only available when capability_peripheral_c 0 n 1 _washer_supp ort 1 washer_dwelltime 15 999 Apply washer washer control system operation time including the time when spraying and wiper act...

Page 340: ...vice N A Get support peripheral device washer_supportmode N A Get the support mode of washer control system its value is the same with capability_peripheral_ c 0 n 1 _washer_mode Only available when c...

Page 341: ...o 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 mea...

Page 342: ...plex Compression G 711 G 726 Interface Built in microphone Built in speaker Effective Range 5 meters Network Users Live viewing for up to 10 clients Protocols IP8160 IPv4 IPv6 TCP IP HTTP HTTPS UPnP R...

Page 343: ...USB connector adapter Others Quick installation guide warranty card stand with screw kit USB connector adapter IP8160 W Dimensions 66 mm IP8160 IP8160 W 66 mm 75 9 mm 75 9 mm 97 5 mm 97 5 mm All spec...

Page 344: ...CA PAT 2216315 CH PAT 819303 CN PAT ZL96193827 7 DE PAT 819303 DE69611607T2 DK PAT 819303 ES PAT 819303 EP PAT 819303 FR PAT 819303 GB PAT 819303 IT PAT 819303 JP PAT APP 8 529817 NL PAT 819303 SE PAT...

Page 345: ...n this document In particular and without limitation these intellectual property rights may include one or more of the patents or pending patent applications in the Taiwan United Sates and other count...

Page 346: ...such as brochure firmware software update VIVOTEK Support Including Top FAQ Technical Videos and Security Hardening Guide with efficient on line assistance VIVOTEK Customer Community To obtain assist...

Page 347: ...dio or television reception which can be determined by turning the equipment off and on the user is encouraged to try to correct the interference by one or more of the following measures Reorient or r...

Reviews: