background image

 

 

VIVOTEK

 

178 - User's Manual

0302a. 

whitebalance 

<product dependent>

auto,  
manual,  
rbgain,  
widerange, 
outdoor, 
indoor, 
sodiumauto, 
etc 

(Available values are 
listed in 
"capability_image_c
<0~(n-1)>_wbmod
e")

4/4 

Modes of white balance. 

"auto"

: Auto white balance 

"rbgain"

: Use rgain and bgain to set white 

balance 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 white balance module. Then, 
act as rbgain mode 

"widerange"

: 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 available when 
"capability_image_c<0~(n-1)>_wbmode" !="
-"

rgain 

0~100 

4/4 

Manual set rgain value of gain control setting.
0: Weak <-> 100: Strong 

* Only available when "rbgain" is listed in 
"capability_image_c<0~(n-1)>_wbmode". 
* Only valid when 
"videoin_c<0~(n-1)>_whitebalance" != auto 
* Normalized range. 

bgain 

0~100 

4/4 

Manual set bgain value of gain control setting.
0: Weak <-> 100: Strong 

* Only available when "rbgain" is listed in 
"capability_image_c<0~(n-1)>_wbmode". 
* Only valid when 
"videoin_c<0~(n-1)>_whitebalance" != auto 
* Normalized range. 

maxgain 

0~100 

4/4 

Maximum gain value. 

Summary of Contents for IB8360

Page 1: ...Rev 1 0 2MP 12M IR Smart Stream II Video Rotation IP66 UV Protection User s Manual Bullet Network Camera IB8360 Rev 1 0...

Page 2: ...stem Maintenance 43 Media Image 47 Media Video 58 Media Video 59 Network General settings 67 Network Streaming protocols 74 Network SNMP Simple Network Management Protocol 83 Network FTP 84 Security U...

Page 3: ...s Smart Stream II technology the IB8360 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 supports two...

Page 4: ...carefully read and follow the instructions in the Installation chapter to avoid damage due to faulty assembly and installation This also ensures the product is used properly as intended The Network Ca...

Page 5: ...machine Tips Tips are useful information that helps enhance or facilitae an installation function or process WARNING or IMPORTANT These statements indicate situations that can be dangerous or hazardou...

Page 6: ...VIVOTEK 6 User s Manual Dimension Drawing 74 98 163 73 98 33...

Page 7: ...0766AD XXXXXX 1 Jot down the camera s MAC address for later reference 25mm 2 Use a pencil to mark the positions where you will drill the mounting holes If a cabling hole is preferred the diameter of t...

Page 8: ...e bracket The anchors may not be necessary if you install the camera on a wooden wall or calcium silicate board If preferred drill a routing hole on the wall for routing the Ethernet cable If you need...

Page 9: ...d span or switch 5 Install a MicroSD card if onboard storage is preferred The card slot is accessed through a rubber seal Use a small Phillips screwdriver to open the seal Please properly fasten the s...

Page 10: ...ashing Red and Green LED Color Indication Steady Red Power on and system booting All LED off Power off Blink Red Green every 0 15 sec Upgrading F W Blink Orange every 0 15 sec Restoring default Steady...

Page 11: ...7 Open the Shepherd utility The utility will search for cameras within the network 8 Double click on the camera to open a web console with the camera You can now start viewing the live stream Shepherd...

Page 12: ...ssword configuration for security concerns Enter the combination of alphabetic and numeric characters to fulfill the password strength requirement The default name for the camera administrator is root...

Page 13: ...VIVOTEK User s Manual 13 Another prompt will request for the password you configured Enter the password and then you can start configure your camera and see the live view...

Page 14: ...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 15: ...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 16: ...ncluded in the product CD helps you set up your Network Camera on the LAN If your camera comes without the CD please visit VIVOTEK s website and locate the utility in the Downloads Software page 1 Run...

Page 17: ...IB8360 Made in Taiwan 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 interference and 2 this device must a...

Page 18: ...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 19: ...ection please refer to Security on page 85 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 20: ...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 21: ...ort number 554 please set the RTSP port to 554 For more information please refer to RTSP Streaming on page 75 For example 4 The live video will be displayed in your player For more information on how...

Page 22: ...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 58 Video Mode H 264 Fr...

Page 23: ...tek 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 network a...

Page 24: ...information please refer to System on page 35 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 25: ...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 26: ...tion on page 98 For more information about how to set up the viewing region of the current video stream please refer to page 98 The viewing region of the curruent video stream The largest frame size P...

Page 27: ...g the slider bar To move to a different area you want to magnify drag the navigation screen Pause Pause the transmission of the streaming media The button becomes the Resume button after clicking the...

Page 28: ...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 29: ...Camera allows up to ten simultaneous accesses UDP multicast This protocol allows multicast enabled routers to forward network packets to all clients requesting streaming media This helps to reduce th...

Page 30: ...r 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...

Page 31: ...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 32: ...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 33: ...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 34: ...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 35: ...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 36: ...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 37: ...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 38: ...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 39: ...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 40: ...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 41: ...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 42: ...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 43: ...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 44: ...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 45: ...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 46: ...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 47: ...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 48: ...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 49: ...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 50: ...the range of 3 meters Smart IR can effectively reduce the over exposure For a surveillance area at a greater distance e g 5 meters the Smart IR function may not bring as significant benefits as in th...

Page 51: ...s calculation of light level To solve this issue you can place an Exposure Exclude window on an unavoidable object in the Exposure setting window See page 55 for how to do it You can also configure th...

Page 52: ...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 53: ...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 54: ...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 55: ...y electrical brightness gains The inclusive window refers to the weighed window the exclusive window refers to ignored window It adopts the weighted averages method to calculate the value The inclusiv...

Page 56: ...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 57: ...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 58: ...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 59: ...w 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 192...

Page 60: ...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 61: ...conds 3 seconds and 4 seconds Maximum frame rate This limits the maximum refresh frame rate per second Set the frame rate higher for smoother video quality and for recognizing moving objects in the fi...

Page 62: ...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 63: ...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 64: ...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 65: ...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 66: ...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 67: ...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 68: ...amera so that whenever a Network Camera is presented to the LAN the shortcuts to connected Network Cameras will be listed in My Network Places You can click the shortcut to link to the web browser Cur...

Page 69: ...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 70: ...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 71: ...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 72: ...s format Please refer to HTTP streaming on page 74 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 73: ...VIVOTEK User s Manual 73...

Page 74: ...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 75: ...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 76: ...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 77: ...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 78: ...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 79: ...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 80: ...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 81: ...for QoS The network video devices used in the network must be QoS enabled QoS models CoS the VLAN 802 1p model IEEE802 1p defines a QoS model at OSI Layer 2 Data Link Layer which is called CoS Class...

Page 82: ...ovides 64 different class IDs It gives an indication of how a given packet is to be forwarded known as the Per Hop Behavior PHB The PHB describes a particular service level in terms of bandwidth queue...

Page 83: ...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 84: ...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 85: ...ower case characters until the password strength is good enough 3 Select the privilege level for the new user account Click Add to enable the setting The privilege levels are listed below Administrato...

Page 86: ...sing HTTPS for communication 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 fr...

Page 87: ...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 88: ...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 89: ...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 90: ...90 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 91: ...91 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 92: ...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 93: ...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 94: ...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 95: ...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 96: ...entication 2 Authenticator an access point or a switch A go between which restricts unauthorized end users from communicating with the authentication server 3 Authentication server usually a RADIUS se...

Page 97: ...k Camera the supplicant and the RADIUS Server the authentication server 2 A Network Camera requests access to the protected LAN using 802 1X via a switch the authenticator The client offers its identi...

Page 98: ...Operation The e PTZ control settings section will be displayed as shown below For e PTZ related details please refer to page 100 Auto pan patrol speed Select the speed from 1 5 slow fast to set up th...

Page 99: ...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 100: ...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 101: ...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 102: ...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 103: ...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 104: ...configure 1 to 3 associated events before using this function VADP It is presumed that you already uploaded and enabled the VADP modules before you can associatee VADP triggers with an Event setting C...

Page 105: ...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 106: ...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 107: ...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 108: ...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 109: ...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 110: ...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 111: ...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 112: ...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 113: ...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 114: ...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 115: ...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 116: ...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 117: ...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 118: ...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 119: ...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 120: ...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 121: ...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 122: ...VIVOTEK 122 User s Manual On the License page register and activate the license for using VIVOTEK s VADP modules Follow the onscreen instruction on VIVOTEK s website for the registration procedure...

Page 123: ...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 124: ...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 125: ...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 126: ...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 127: ...n about folder naming rules please refer to page 109 for details 20170210 20170211 20170212 f you want to enable recording notification please click Event to configure event triggering settings Please...

Page 128: ...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 129: ...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 130: ...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 131: ...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 132: ...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 133: ...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 134: ...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 135: ...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 136: ...arameter pair is parameter value r n parameter pair Only the parameters that you set and are readable will be returned Example Set the IP address of server to 192 168 0 123 Request http myserver cgi b...

Page 137: ...d to an email address shorter than n characters eg joe www ibm com ip address A string limited to an IP address eg 192 168 1 1 mac address A string limited to contain a MAC address without hyphens or...

Page 138: ...ct WebAPIs non available The API is not in product WebAPIs valid The API is listed in product WebAPIs and is functional non valid The API is listed in product WebAPIs but is malfunction in this status...

Page 139: ...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 140: ...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 141: ...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 142: ...eger 7 6 Restore the system parameters to default values except zoom and focus value This command can cooperate with other restoreexceptXYZ commands When cooperating with others the system parameters...

Page 143: ..._i2 Espa ol language_i3 Fran ais language_i4 Italiano language_i5 language_i6 Portugu s language_i7 language_i8 0 7 Available language lists customlanguage_maxcoun t 0 positive integer 0 6 Maximum num...

Page 144: ...h server connections onlinenum_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...

Page 145: ...closed circuit inactive status 7 5security Group security NAME VALUE SECURITY get set DESCRIPTION privilege_do view operator admin 1 6 Indicate which privileges and above can control digital output ca...

Page 146: ...il Stopped service will auto start after changing port settings Ex Change HTTP port from 80 to 5556 and change RTP port for video from 5556 to 20480 Then set preprocess 9 to stop both service first cg...

Page 147: ...keypassword string 200 7 6 Password for PEAP ca_exist boolean 6 6 CA installed flag ca_time 0 positive integer 6 7 CA installed time Represented in EPOCH ca_size 0 positive integer 6 7 CA file size in...

Page 148: ...s dscp 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable disable DSCP video 0 63 6 6 Video channel for DSCP audio 0 63 6 6 Audio channel for DSCP capability naudioin 0 eventalarm 0 6...

Page 149: ...e s 0 capability_nmediast ream 1 _accessname product dependent string 32 1 6 Http server push access name for stream N N 1 capability nmediastream capability protocol spush_mjpeg 1 and capability nmed...

Page 150: ...eg 1 and capability nmediastream 0 The value are shown as live sdp s0_accessname stream1 live2 sdp s1_accessname stream2 live3 sdp s2_accessname stream3 live4 sdp s3_accessname stream4 etc 7 6 7 1 RTS...

Page 151: ...audio port Only available when capability_naudioin 0 metadataport 1026 65534 4 4 Multicast metadata port ttl 1 255 4 4 Multicasttime to live value 7 6 8 SIP port Subgroup of network sip capability pro...

Page 152: ...ean 6 6 Enable administrator IP address admin_ip string 43 6 6 Administrator IP address maxconnection 1 10 6 6 Maximum number of concurrent streaming connection s type 0 1 6 6 Ipfilter policy 0 allow...

Page 153: ...bgain 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 white balance module Then act as rbgain...

Page 154: ...is 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 0 1 4 4 0 monochrome 1 color flip b...

Page 155: ...ge_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 twovalues maxexposure product dependent 1 32000...

Page 156: ...cate the video mode on use whitebalance product dependent auto manual rbgain widerange outdoor indoor sodiumauto etc Available values are listed in capability_image_c 0 n 1 _wbm ode 4 4 Modes of white...

Page 157: ...nge 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 valid when videoin_c 0 n 1 _whitebal...

Page 158: ...Shutter Speed by VIVOTEK quality algorithm manual Manually adjust with variable Shutter Iris and Gain We support this parameter when the version number httpversion is equal or greater than 0302a irism...

Page 159: ...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 version number httpversion is equal or greater than 0...

Page 160: ...e 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 flip boolean 4 4 Flip the image mirror boolean 4 4 Mi...

Page 161: ...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 uploaded font file name minexposure product dependent 1 32000...

Page 162: ...nly available when capability_image_c 0 n 1 _expo sure_rangetype is twovalues shuttervalue product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c 0 n 1 _ex...

Page 163: ...s 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 at capability_videoin_codec Possible values are mjpeg h264 h265 pr...

Page 164: ...lity 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 The Q value which is used by encoded libra...

Page 165: ...y 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_videoin_c 0 n 1 _h264_maxbitrate 4 4...

Page 166: ...4 The time interval between two I frames Intra coded picture The unit is millisecond ms Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h 265_ratecontrol mode cbr vbr 4 4 cbr C...

Page 167: ...ntrolmode 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 in fixed quality mode When the bit rate exceeds this value...

Page 168: ...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 prioritypolicy Only available when h265...

Page 169: ...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 is XXXXX_2 ex 0301a_2 product dependent 4 4 Manual video q...

Page 170: ...ized quality in a 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 _m jpeg_bitrat...

Page 171: ...ode 0 wdrpro_strengt h product dependent 1 100 4 4 The strength of WDR Pro The bigger value means the stronger strength of WDR Pro Only available when capability_image_c 0 n 1 _wdrp ro_strength is 1 w...

Page 172: ...1 20 level 1 21 40 level 2 41 60 level 3 61 80 level 4 81 100 level 5 Level 1 4 low high The higher sensitivity level meas that it is easy to be trigger while scene changed Only available when capabil...

Page 173: ...ount Only available when capability_fisheyelocaldewarp_c 0 capability_nvideoin 1 0 Group videoin_c 0 n 1 _s 0 m 1 _h264_smartstream2 capability_smartstream_support 1 and capability_smartstream_version...

Page 174: ...etween the ROI and non ROI areas Group videoin_c 0 n 1 _s 0 m 1 _h264_smartstream2_win_i 0 k 1 capability_smartstream_support 1 capability_smartstream_version 2 0 and capability_smartstream_mode_manua...

Page 175: ...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 176: ...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 177: ...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 178: ...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 179: ...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 180: ...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 181: ...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 182: ...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 183: ...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 184: ...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 185: ...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 186: ...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 187: ...4 Enable disable scene mode 0 disable 1 enable Only available when capability_image_c 0 n 1 _scenemode_ support is 1 scene_mode product dependent visibility noiseless lpcparkinglot lpcstreet product d...

Page 188: ...ability_image_c 0 n 1 _basicsetting is 1 profile_i 0 m 1 _enable boolean 4 4 Enable disable this profile setting profile_i 0 m 1 _policy night schedule 4 4 The mode which the profile is applied to Not...

Page 189: ...1 _saturationpercent Only available when bit 2 of capability_image_c 0 n 1 _basicsetting is 1 We replace profile_i0_saturation with profile_i0_saturationpercent This parameter will not be used after...

Page 190: ..._basicsetting is 1 profile_i 0 m 1 _sharpness percent 0 100 4 4 Set sharpness in the normalized range 0 Softer 100 Sharper Only available when bit 3 of capability_image_c 0 n 1 _basicsetting is 1 pro...

Page 191: ...ty_image_c 0 n 1 _defog_mode is 1 profile_i 0 m 1 _eis_mode product dependent boolean 4 4 Electronic image stabilizer 0 disable 1 enable Only available when eis is listed in capability_image_c 0 n 1 _...

Page 192: ..._ exposure_winmode 4 4 auto Use full image view as the only exposure window custom Use custom windows blc Use BLC Back Light Compensation and the only exposure window is located at the center of view...

Page 193: ...t of the window Only available when px is listed in capability_image_c 0 n 1 _exposure_wi ndomain homestd 0 9999 0 9999 4 4 Left top corner coordinate of the window Only available when std is listed i...

Page 194: ...capability_image_c 0 n 1 _exposure_winmode and valid when exposurewin_c 0 n 1 _mode custom or exposurewin_c 0 n 1 _mode hlc NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable or disabl...

Page 195: ...en px is listed in capability_image_c 0 n 1 _exposure_wi ndomain homestd 0 9999 0 9999 4 4 Left top corner coordinate of the window Only available when std is listed in capability_image_c 0 n 1 _expos...

Page 196: ...refer the parameter description of input input intmic extmic product dependent 4 4 intmic Internal built in microphone Only available when capability_audio_intmic 1 extmic External microphone input On...

Page 197: ...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 since the version number httpversion is equal or greater than 0301a...

Page 198: ...ilable if G 726 is supported s0_g726_vlcmode 0 1 4 4 Enable vlcmode for G 726 0 Standard mode 1 Solve compatibility problem with VLC player Only available if G 726 is supported aec_enable boolean 4 4...

Page 199: ...1 _win_i 0 k 1 n denotes the value of capability_nvideoin k denotes the value of capability_nmotion NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable motion detection window name stri...

Page 200: ...ly available when capability_motion_wintype polygon Only available when qvga is listed in capability_motion_windomain It s recommended to use polygonsd This parameter will not be used after the versio...

Page 201: ...tection window Only available when capability_motion_wintype rectangle Only available when qvga is listed in capability_motion_windomain It s recommended to use polygonsd This parameter will not be us...

Page 202: ...9999 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 when std is listed in capability_motion_windomain o...

Page 203: ...rdinate of window position Only available when capability_motion_wintype rectangle Only available when qvga is listed in capability_motion_windomain It s recommended to use polygonsd This parameter wi...

Page 204: ...er 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 Only available when...

Page 205: ...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 206: ...sernameem ail string 64 6 6 Your user name or email to login to the DDNS service provider provider _passwordkey string 64 7 6 Your password or key to login to the DDNS service provider provider _serve...

Page 207: ...0 3 6 7 The status of UPnP port forwarding used internally 0 OK 1 FAIL 2 no IGD router 3 no need for port forwarding 7 20 System log Group syslog NAME VALUE SECURITY get set DESCRIPTION enableremotelo...

Page 208: ...6 Read only security name authpwrw string 8 128 7 6 Read write authentication password authpwro string 8 128 7 6 Read only authentication password authtyperw MD5 SHA 6 6 Read write authentication type...

Page 209: ...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 210: ...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 211: ...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 212: ...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 213: ...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 214: ...it integer each bit can be set separately as follows Bit 0 Support camera control function 0 not support 1 support Bit 1 only available when bit0 is 1 Built in or external video source 0 external 1 bu...

Page 215: ...focus function bit 1 Only support zoom function bit 2 Only support focus function bit 3 Currently this is a reserved bit and the default value is 0 It s strongly non recommended to use this This is r...

Page 216: ...not and so on For most products the last stream of a channel will not support ePTZ It is reserved for full view of the channel For some dual stream products both streams support ePTZ nanystream 0 pos...

Page 217: ...nal loss backup Backing up recorded files smartsd Lifetime detection of SD card shockalarm Shock detection visignal Video input signal restore Only available when httpversion 0301a storage_dbenabled b...

Page 218: ...essive CCD 2 CMOS videoin_nresolution positive integer 0 7 This equals capability_videoin_c0_nresolution This is kept for compatibility videoin_resolution A list of WxH product dependent 0 7 This equa...

Page 219: ...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 acoustic echo cancellation control mode auto...

Page 220: ...e word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL For example maxframerate fixed 15 which means the...

Page 221: ...ll be replaced by audio_intmic and audio_extmic audio_lineout boolean 0 7 Indicate whether to support line output audio_michardwareswitch boolean 0 7 Indicate whether the hardware supports built in ex...

Page 222: ...range to represent the whole image px Locate a window in the image with pixels std A normalized 0 9999 range Not supported Only available when capability_smartstream_support is 1 smartstream_mode_aut...

Page 223: ...Support event trigger Bit 5 Support license registration Bit 6 Support shared memory API Bit 7 Support digital signature of package Bit 8 Support snapshot vadp_npackage positive integer 0 7 Indicate...

Page 224: ...1 We support this parameter when the version number httpversion is equal or greater than 0305a wireless_s802dot11b boolean 0 7 Indicate whether to support wireless 802 11b wireless_s802dot11g boolean...

Page 225: ...7 Indicate ONVIF test tool version media_totalspace positive integer 0 7 Available memory space KB for media media_snapshot_maxpre event positive integer 0 7 Maximum snapshot number before event occur...

Page 226: ...integer 0 7 The maximum MOD connection numbers Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 localstorage_modversion string 0 7 Indicate MOD daemon version Only av...

Page 227: ...emote camera control slave side fisheyelocaldewarp_c 0 capability_nvideoin 1 product dependent 0 positive integer 0 7 Indicate the supported streams of local dewarp One bit represents one supported st...

Page 228: ...er each bit can be set separately as follows Bit 0 support build in pan Bit 1 support build in tilt zoommodule boolean 0 7 Indicate whether to support zoom lens In our product only SD series and IZ se...

Page 229: ...r httpversion is equal or greater than 0304a Group capability_ptz_c 0 n 1 n denotes the value of capability_nvideoin capability_ptzenabled 0 and capability_camctrl_c 0 n 1 _zoommodule 0 We support thi...

Page 230: ...imit for tilt angle Only available when bit1 of capability_camctrl_c 0 n 1 _buildinpt is 1 maxtiltangle integer 0 7 The upper limit for tilt angle Only available when bit1 of capability_camctrl_c 0 n...

Page 231: ...ON support boolean 0 7 Indicate whether the camera supports day night mode switch builtinir boolean 0 7 Indicate whether to support built in IR led externalir boolean 0 7 Indicate whether to support e...

Page 232: ...2a ircutsensitivity_supportlevel 0 positive integer 0 7 The value indicate the support strength level of ircutsensitivity Only available when capability_daynight_c 0 n 1 _support is 1 and capability_d...

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: ...H CU8163 H CU8361 H product dependent 0 7 A camera 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 v...

Page 239: ...C4R A list of WxH 0 7 Available resolutions of 4R mode of ceiling and floor mount resolutionW1P A list of WxH 0 7 Available resolutions of 1P mode of wall mount resolutionW1R A list of WxH 0 7 Availab...

Page 240: ...2nd group for 2nd channel nvideoin 3 bit 0 9 are the 1st group for 1st channel bit 10 19 are the 2nd group for 2nd channel bit 20 31 are the 3rd group for 3rd channel Then the 1st bit of the group ind...

Page 241: ...e This parameter is designed to represent this binning 0 1 3 0 7 Indicate binning is used or not in this video mode 0 No binning 1 2x2 binning 3 3x3 binning Binning is a technology to increase light s...

Page 242: ...resolution in resolution The element number is defined as nresolution in this group This parameter records the frame rate when videoin_c 0 n 1 _cmosfreq 60 or videoin_c 0 n 1 _modulation ntsc maxfps_...

Page 243: ...not support One to one mapping to the resolution in resolution The element number is defined as nresolution in this group This parameter records the frame rate when videoin_c 0 n 1 _cmosfreq 60 or vi...

Page 244: ...R Pro and the scecond number indicate the support strength level of WDR Pro II wdrpro_affect exposurewin mode fixed au to exposurewin mode blc disab led aespeed disabled exposurelevel hidden exposurel...

Page 245: ...is affected When wdrpro 0 this value must be wdrpro_description string 0 7 Description about WDR Pro mode Only available when capability_image_c 0 n 1 _wdrp ro_mode 0 wdrc_mode 0 1 0 7 0 Non support W...

Page 246: ...chy 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 Descr...

Page 247: ...dis 0 7 Indicate the image stabilizer mode eis electronic image stabilizer dis digital image stabilizer not support We support this parameter when the version number httpversion is equal or greater t...

Page 248: ...me Policy Description Policy can be categorized into following groups disabled UI turns grey and users can t select it unchanged UI keeps the status as before and user can t change it hidden UI is hid...

Page 249: ...scenemode_support is 1 scenemode_visibility_affe ct product dependent minexposure hidden mingain hidden wdrpro unchanged 3dnr unchanged or others x nonnegative integer product dependent 0 7 When scene...

Page 250: ..._ scenemode_support is 1 scenemode_noiseless_aff ect product dependent minexposure hidden mingain hidden wdrpro unchanged 3dnr unchanged or others x nonnegative integer product dependent 0 7 When sce...

Page 251: ...mode_supporttype and capability_image_c 0 n 1 _ scenemode_support is 1 scenemode_lpcparkinglot _affect product dependent minexposure hidden mingain hidden wdrpro unchanged 3dnr unchanged or others x n...

Page 252: ...ted in capability_image_c 0 n 1 _ scenemode_supporttype and capability_image_c 0 n 1 _ scenemode_support is 1 scenemode_lpcstreet_aff ect product dependent minexposure hidden mingain hidden wdrpro unc...

Page 253: ...l is fixed to level 6 Description can be a nonnegative integer or sting or NULL means no feature is affected Only available when visibility is listed in capability_image_c 0 n 1 _ scenemode_supporttyp...

Page 254: ...t this parameter when the version number httpversion is equal or greater than 0302a exposure_rangetype onevalue twovalues 0 7 Support interface of exposure range onevalue The parameter is a constant v...

Page 255: ...support Only available when capability_image_c 0 n 1 _ exposure_mode is 1 and capability_image_c 0 n 1 _expo sure_rangetype is onevalue We support this parameter when the version number httpversion is...

Page 256: ...s fixed to level 6 Description can be a nonnegative integer or string or NULL means no feature is affected Only available when auto is listed in capability_image_c 0 n 1 _ exposure_modetype and capabi...

Page 257: ...t API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means ex...

Page 258: ...keeps the status as before and user can t change it hidden UI is hidden fixed UI is fixed to one selection or value ranged UI is fixed to multiple selections or values enabled UI is checked notsupport...

Page 259: ...The affected functions are list here The format is Affect API name Policy Description Policy can be categorized into following groups disabled UI turns grey and users can t select it unchanged UI keep...

Page 260: ...idden or others x nonnegative integer product dependent 0 7 When exposure manual mode is enabled some features may become malfunction or be forced to a given value The affected functions are list here...

Page 261: ...ort this parameter when the version number httpversion is equal or greater than 0302a exposure_levelrange 0 12 0 7 Available range for videoin_c 0 n 1 _exposurelevel When exposure_mode 0 this value mu...

Page 262: ...tegorized into following groups disabled UI turns grey and users can t select it unchanged UI keeps the status as before and user can t change it hidden UI is hidden fixed UI is fixed to one selection...

Page 263: ...of exposure control exclusive The image inside a window is omitted by exposure control Not supported Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_windomain qvga px std 0...

Page 264: ...en capability_image_c 0 n 1 _ exposure_mode is 1 We support this parameter when the version number httpversion is equal or greater than 0301a exposure_maxrange 1 32000 1 8000 or others product depende...

Page 265: ...lized 0 9999 range Not supported privacymask_ncolor Positive Integer 0 7 Available total color numbers of privacy mask agc_maxgain 0 100 0 7 Available range for videoin_c n _maxgain 0 100 0 100 percen...

Page 266: ...ot available Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixe...

Page 267: ...o following groups disabled UI turns grey and users can t select it unchanged UI keeps the status as before and user can t change it hidden UI is hidden fixed UI is fixed to one selection or value ran...

Page 268: ...0 7 0 Non support tuning Gamma curve 1 Support tuning Gamma curve lowlightmode 0 1 0 7 Internal parameter must not open to user 0 Non support low light mode 1 Support low light mode focusassist 0 1 0...

Page 269: ...pport image freeze feature 1 Support image freeze feature We support this parameter when the version number httpversion is equal or greater than 0302a autotrack_support boolean 0 7 0 Non support auto...

Page 270: ...SECURITY get set DESCRIPTION devicecontrol boolean 0 7 Indicate whether to support the peripheral device control We support this parameter when the version number httpversion is equal or greater than...

Page 271: ...signal vadp smartsd product dependent 6 6 Indicate the trigger condition boot System boot di Digital input pir PIR detection motion Video motion detection seq Periodic condition visignal Video input s...

Page 272: ...s field is required when trigger condition is vi One bit represents one digital input The LSB indicates VI 0 vadp product dependent 0 positive integer 6 6 Indicate the source id of vadp event notifica...

Page 273: ...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 274: ...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 275: ...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 276: ...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 277: ...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 278: ...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 279: ...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 280: ...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 281: ...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 282: ...e If the minimal window size is 64x64 then the win_i0_home 0 resolution_W 64 0 resolution_H 64 which the resolution is the value in current stream If the stream doesn t support ePTZ the permissions of...

Page 283: ...able when capability_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 sh...

Page 284: ...is 1 1 7 Left 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 availabl...

Page 285: ...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 286: ...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 287: ...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 288: ...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 289: ...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 290: ...and the bit4 of capability_ptzenabled is 1 n denotes the value of capability_nvideoin and k denotes the value of capability_npreset NAME VALUE SECURITY get set DESCRIPTION ccdtype string 16 6 7 Inter...

Page 291: ...ability_ptz_c 0 n 1 _maxfocus 1 4 Focus position at each preset location preset_i 0 k 1 _focus setting sync fixcurrent 1 4 The focus mode of each preset which is essential and should be grouped with p...

Page 292: ...Enable disable idle action while idle idleaction_type pan patrol home objtrack prev 1 4 This field tells what kind of action should be taken while idle idleaction_interval 1 999 1 4 While idle over th...

Page 293: ...t before continuing a loop tour 7 41 UART control Group uart capability nuart 0 and capability fisheye 0 NAME VALUE SECURITY get set DESCRIPTION ptzdrivers_i 0 19 127 _name string 40 1 4 Name of the P...

Page 294: ...bility_ptzenabled is 0 the bit4 of capability_ptzenabled is 1 NAME VALUE SECURITY get set DESCRIPTION cameraid 1 255 4 4 Camera ID controlling external PTZ camera Note Please set your speed dome to th...

Page 295: ...i0 lens of default 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 SE...

Page 296: ...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 297: ...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 298: ...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 299: ...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 300: ...cgi bin dido setdo cgi do1 state do2 state do3 state do4 state Where state is 0 or 1 0 means inactive or normal state while 1 means active or triggered state PARAMETER VALUE DESCRIPTION do num 0 1 0...

Page 301: ...r is specified all of the digital input statuses will be returned Return HTTP 1 0 200 OK r n Content Type text plain r n Content Length length r n r n di0 state r n di1 state r n di2 state r n di3 sta...

Page 302: ...er is specified all the digital output statuses will be returned Return HTTP 1 0 200 OK r n Content Type text plain r n Content Length length r n r n do0 state r n do1 state r n do2 state r n do3 stat...

Page 303: ...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 the im...

Page 304: ...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 305: ...uire Administrator privileges Method GET POST Syntax http servername cgi bin admin syslog cgi Server will return the most up to date system log Return HTTP 1 0 200 OK r n Content Type text plain r n C...

Page 306: ...dministrator 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...

Page 307: ...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 308: ...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 309: ...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 310: ...PARAMETER VALUE DESCRIPTION channel 0 n 1 Channel of the video source stream 0 m 1 Stream recall Text string less than 40 characters One of the present positions to recall return return page Redirect...

Page 311: ...el 0 n 1 Channel of the video source stream 0 m 1 Stream addpos Text string less than 40 characters Add one preset location to the preset list delpos Text string less than 40 characters Delete preset...

Page 312: ...eny Set IP filter type method addv4 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 I...

Page 313: ...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 314: ...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 315: ...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 316: ...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 317: ...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 318: ...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 319: ...ffset positive integer 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 c...

Page 320: ...dmin lsctrl cgi cmd update isLocked 1 label 1 label 5 Ex Update records whose key numbers are 2 and 3 to be unlocked status http servername cgi bin admin lsctrl cgi cmd update isLocked 0 label 2 label...

Page 321: ...that when the virtual input is waiting for next state it cannot accept new requests return return page Redirect to the page return page after the parameter is assigned The return page should be the r...

Page 322: ...METER VALUE DEFAULT DESCRIPTION maxsft 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...

Page 323: ...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 324: ...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 325: ...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 326: ...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 327: ...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 328: ...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 329: ...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 330: ...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 331: ...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 332: ...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 333: ...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 334: ...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 335: ...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 336: ...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 337: ...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 338: ...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 339: ...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 340: ...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 341: ...t means the accumulated percentage amount of flash block has been written The range is from 0 to 100 unit The SD card is recommended to be replaced if the percentage reaches above 90 smartsd_spare_blo...

Page 342: ...N A Apply the wireless settings and connect to AP 8 34 Get wireless information capability_network_wireless 0 Note This request requires Administrator privileges Method GET POST Syntax http servername...

Page 343: ...T Syntax http servername cgi bin admin getwlsignalstrength cgi PARAMETER VALUE DESCRIPTION N A N A Get wireless signal strength 8 36 WPS transaction capability_network_wireless 0 Note This request req...

Page 344: ...r cgi bin admin peripheral cgi channel 0 operation set washer_mode wiper washer_status on Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n washer_mode OK r n washer_stat...

Page 345: ...nt Only available when capability_peripheral_c 0 n 1 _heater_suppo rt 1 trigger heater component is work in force heater once Only available when capability_peripheral_c 0 n 1 _heater_suppo rt 1 Synta...

Page 346: ...c 0 n 1 _washer_mod e washer_status N A Get the current status of washer control module The status is off as default which means the washer is stopped and the status on means the washer is running Onl...

Page 347: ...TEK User s Manual 347 an internal condition trigger status will be transfer to auto after reach the internal condition Only available when capability_peripheral_c 0 n 1 _heater_suppo rt 1 End of docum...

Page 348: ...IPv6 TCP IP HTTP HTTPS UPnP RTSP RTP RTCP IGMP SMTP FTP DHCP NTP DNS DDNS PPPoE CoS QoS SNMP 802 1X SSL TLS ARP CIFS SMB IB8360 W IPv4 IPv6 TCP IP HTTP HTTPS UPnP RTSP RTP RTCP IGMP SMTP FTP DHCP NTP...

Page 349: ...ons are subject to change without notice Copyright VIVOTEK INC All rights reserved Ver 4 6F No 192 Lien Cheng Rd Chung Ho New Taipei City 235 Taiwan R O C T 886 2 82455282 F 886 2 82455532 E sales viv...

Page 350: ...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 351: ...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 352: ...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 353: ...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: