manualshive.com logo in svg

Delta Vivotek IB9389-EH-v2, User Manual

Share
Download
Delta Vivotek IB9389-EH-v2 User Manual Download Page 20

 

 

VIVOTEK

 

20 - User's Manual

Software Installation

21. Install the 

Shepherd 

utility, which helps you locate and configure your Network Camera 

in the local network. If your camera comes without the CD, go to VIVOTEK’s website, 

and locate the utility in the Downloads > Software page. 

21-1. Run the Shepherd utility.

21-2. The program will conduct an analysis of your network environment. 

Summary of Contents for Vivotek IB9389-EH-v2

Page 1: ...User s Manual 5MP Outdoor IP66 IK10 Day Night Smart Motion Detection WDR Pro Smart Stream III 50M Smart IR Bullet Network Camera IB9389 EHT v2 IB9389 EH v2 Rev 1 0...

Page 2: ...mepage layout 49 System Logs 52 System Parameters 55 System Maintenance 56 Media Image 59 Media Video 75 Media Video 76 Media Video 77 Media profiles 86 Network General settings 87 Network Streaming p...

Page 3: ...capturing the highest quality images in both low light and high contrast environments The onboard IR can provide illumination in total darkness With the Smart IR feature the firmware automatically ad...

Page 4: ...for various applications including video sharing general security surveillance etc The Configuration chapter suggests ways to best utilize the Network Camera and ensure proper operations For creative...

Page 5: ...ag Quick Installation Guide IMPORTANT 1 The camera is only to be connected to PoE networks without routing to outside plants 2 For PoE connection use only UL listed I T E with PoE output 1 La cam ra n...

Page 6: ...VIVOTEK 6 User s Manual Outer View Inner View Physical Description MicroSD card slot Reset button IR LEDs Sun shield Lens...

Page 7: ...Dynamic Range functionality NOTE Model IB9389 EH v2 IB9389 EHT v2 Rating POE 42 5 57V 0 3 0 23A 12 95W POE 42 5 57V 0 3 0 23A 12 95W Screws IMPORTANT Below are things to notice connecting a ground wi...

Page 8: ...VIVOTEK 8 User s Manual Hardware Installation 0002D10766AD XXXXXX 1 Jot down the camera s MAC address for later reference 2 Use a pencil to mark the drill hole positions on the wall or ceiling...

Page 9: ...VIVOTEK User s Manual 9 3 Route cables through the wall or ceiling and install the wall anchors 4 Use the included screws to secure the wall bracket...

Page 10: ...VIVOTEK 10 User s Manual 5 Disassemble the waterproof cable gland 6 Insert an Ehternet cable through the waterproof components Note the maximum cable diameter 5mm 14mm...

Page 11: ...VIVOTEK User s Manual 11 7 Insert the RJ45 connector to the camera 8 Install the cable gland components...

Page 12: ...VIVOTEK 12 User s Manual 9 Tighten the cable gland claw and hex nut using a hex wrench 10 Install the camera to the wall mount bracket and tighten the hex screws on the sides of the bracket...

Page 13: ...Keep the screw for later use 11 Remove the M3 retention screw before opening the canister 12 Use both of your hands to hold and turn the front and the rear of the canister in opposite directions Open...

Page 14: ...VIVOTEK 14 User s Manual IB9389 EH v2 13 Install a MicroSD card if onboard storage is preferred 64GB 10 I 1...

Page 15: ...VIVOTEK User s Manual 15 14 Replace the desiccant bag to avoid moisture inside the canister 1 2 15 Install the front section of the canister by turing into position IB9389 EHT v2...

Page 16: ...VIVOTEK 16 User s Manual IB9389 EH v2 M3 16 Secure the canister by fastening the M3 screw you previously removed...

Page 17: ...am will search for VIVOTEK Video Receivers Video Servers or Network Cameras on the same LAN Double click on the camera s MAC address to open a web console to the camera LAN PoE Browser Shepherd 18 Loo...

Page 18: ...VIVOTEK 18 User s Manual 19 When the adjustment to the shooting is done tighten the retention screws 3mm Max 90...

Page 19: ...anual 19 20 Install the sun shield by fastening 2 included screws Focus window x 1 2 Focus window x 1 2 Configuration Media Image Focus EHT When using the EHT model enter the firmware menu to get the...

Page 20: ...helps you locate and configure your Network Camera in the local network If your camera comes without the CD go to VIVOTEK s website and locate the utility in the Downloads Software page 21 1 Run the S...

Page 21: ...rmful interference and 2 this device must accept any interference received including interference that may cause undesired operation Pat 6 930 709 MAC 0002D1730202 Ro HS 21 3 The program will search f...

Page 22: ...guration for security concerns 22 1 Since your camera is used for the first time there is no password Enter root as the user name and nothting for the password 22 2 Enter the combination of alphabetic...

Page 23: ...ecial ASCII characters are supported _ and You can use them in the password combination 22 3 Another prompt will request for the password you just configured Enter the password and then you can start...

Page 24: ...d install again Reset Press the recessed reset button Wait for the Network Camera to reboot Restore Press and hold the reset button until the status LED rapidly blinks Note that all settings will be r...

Page 25: ...llustration to connect the Network Camera to a PoE enabled switch via Ethernet cable PoE Switch When using a non PoE switch Use a PoE power injector optional to connect between the Network Camera and...

Page 26: ...twork Camera should prompt as shown below 2 You should be able to see live video from your camera You may also install the 32 channel recording software in a deployment consisting of multiple cameras...

Page 27: ...ease forward the following ports for the Network Camera on the router HTTP port default is 80 RTSP port default is 554 RTP port for video default is 5556 RTCP port for video default is 5557 If you hav...

Page 28: ...80 122 146 57 120 8001 192 168 2 11 80 When properly configured you can access a camera behind the router using the HTTP request as follows http 122 146 57 120 8000 If you change the port numbers on t...

Page 29: ...on LAN If your network environment is not a LAN follow these steps to access the Netwotk Camera 1 Launch your web browser e g Microsoft Internet Explorer or Mozilla Firefox 2 Enter the IP address of t...

Page 30: ...ection please refer to Security on page 106 If you see a dialog box indicating that your security settings prohibit running ActiveX Controls please enable the ActiveX Controls for your browser 1 Choos...

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

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

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

Page 34: ...ol you may try to remove the plug ins that might have been installed on your computer Remove the following folder C Program Files x86 Camera Stream Controller 2 If you forget the root administrator pa...

Page 35: ...rol Area Configuration Area Host Name Resize Buttons Hide Button Profile mode 4 pre configured streaming profiles are provided through here Max view Recording view Live view and App Each mode features...

Page 36: ...esize 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 homepage to 25 of its...

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

Page 38: ...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 39: ...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 40: ...ork 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...

Page 41: ...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 42: ...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 43: ...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 44: ...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 45: ...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 46: ...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 47: ...at the camera must have the access to the Internet Update interval Select to update the time using the NTP server on an hourly daily weekly or monthly basis Time zone Select the appropriate time zone...

Page 48: ...The format is TZ local_timezone date time date time Here date is in the Mm n d format where Mm 1 12 for 12 months n 1 5 1 for the first week and 5 for the last week in the month d 0 6 0 for Sunday an...

Page 49: ...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 50: ...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 51: ...you 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...

Page 52: ...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 53: ...age Email GSM Modem HTTP Digital output VIVOCloud PTZ Deterrent FTP You can install the included VAST recording software which provides an Event Management function group for delivering event messages...

Page 54: ...g is stored in the Network Camera s buffer area and will be overwritten when reaching a certain limit VADP log VADP log contains the information for the onboard VADP packages including memory usage mo...

Page 55: ...VIVOTEK User s Manual 55 System Parameters The View Parameters page lists the entire system s parameters If you need technical assistance please provide the information listed on this page...

Page 56: ...ll 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 yo...

Page 57: ...s below on this page Custom Language Select this option to retain the Custom Language settings VADP Retain the VADP modules 3rd party software stored on the SD card and related settings Focus position...

Page 58: ...Click 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 acci...

Page 59: ...nside the live viewing window and the maximum zoom in will be up to 12 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...

Page 60: ...ous 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 can be appl...

Page 61: ...the sensor to accept infrared light thus helping to improve low light sensitivity Synchronize with digital input If an external IR device is connected that comes with its own light sensor you can use...

Page 62: ...s close to the lens and the IR lights For example if an intruder has a chance of getting near the range of 3 meters Smart IR can effectively reduce the over exposure For a surveillance area at a great...

Page 63: ...the Smart IR s calculation of light level To solve this problem you can place an Exposure Exclude window on an unavoidable object in the Exposure setting window See page 67 for how to do it You can a...

Page 64: ...rightness level which ranges from 0 to 100 Contrast Adjust the image contrast level which ranges from 0 to 100 Saturation Adjust the image saturation level which ranges from 0 to 100 Sharpness Adjust...

Page 65: ...g power 3D Noise Reduction is mostly applied in low light conditions When enabled in a low light condition with fast moving objects trails of after images may occur You may then select a lower strengt...

Page 66: ...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 building s corridor Full view...

Page 67: ...ning of the inclusive window Include Exclude Weighted region Ignored region Include Exclude Center Use the center portion of the screen to determine the exposure level HLC Highlight Compensation Firmw...

Page 68: ...Exposure time and Gain control slide bars to specify a range of shutter time and Gain control values within which the camera can automatically tune to an optimal imaging result You may prefer a short...

Page 69: ...enable the setting and click Close to exit the page You can click Restore to recall the original settings without incorporating the changes When completed with the settings on this page click Save to...

Page 70: ...ct from the bottom of the screen whether you want to perform focus adjustment on the Full view or within a Custom focus window You can create a custom window and click and drag the window to a desired...

Page 71: ...e by referring to the full view Custom You can create a focus window and drag it to a place of interest in your view window Note that it is recommended to use this function only when you have a solid...

Page 72: ...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 73: ...ey are drawn the numbers of pixels on the sides of windows will appear This allows you to calculate if your current configuration fulfills a requirement for instance for recognizing the faces of perso...

Page 74: ...a doorway This application aims to identify a subject passing through a specific area 4 Other factors may include that a person will move in your area of interest The face may not always face the cam...

Page 75: ...ion at 5 megapixels in a 4 3 screen aspect ratio with the WDR function enabled 4 Megapixel 16 9 MAX 30fps WDR Pro This is the full resolution at 4 megapixels in a 16 9 screen aspect ratio with the WDR...

Page 76: ...am 2 is set to the 1280 x 960 Stream 3 The default frame size for Stream 3 is set to the 800 x 600 Click Viewing Window to open the viewing region settings page On this page you can configure the Regi...

Page 77: ...ng region 2 Select a Region of Interest from the drop down list The floating frame the same as the one in the Gloabl View window on the home page will resize accordingly If you want to set up a custom...

Page 78: ...and lower bit rate for remote viewing on mobile phones and a larger video size and a higher bit rate for live viewing on web browsers or recording the stream to an NVR Note that a larger frame size ta...

Page 79: ...P P P P P P I P P P P P P P I Static scene Activities P P P P I P P P P P P P I P P P P P P P I By dynamically prolonging the intervals for I frames insertion to up to 10 seconds the bit rates require...

Page 80: ...art Stream III has two more configurable options Smart Q and Smart FPS NOTE By queuing the old frames from a static scene both the computing efforts and the size of P frames are reduced It is benefici...

Page 81: ...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 still be transmitted in low quality format Manual The Manual m...

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

Page 83: ...rame rate per second performance while the image quality will be compromised If Image quality priority is selected the Network Camera may drop some video frames in order to maintain image quality Smar...

Page 84: ...idth For example in low light conditions where a Fixed quality setting is applied video packet sizes can tremendously increase when noises are produced with electrical gains You may also manually ente...

Page 85: ...lity and for recognizing moving objects in the field of view If the power line frequency is set to 50Hz the frame rates are selectable at 1fps 2fps 3fps 5fps 8fps 10fps 12fps 15fps and up to 25fps If...

Page 86: ...for each of the 3 default profiles Max view Recording Live view and App The related video stream information will display including stream number resolution codec used frame rate etc The Multicast por...

Page 87: ...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 88: ...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 89: ...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 90: ...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 91: ...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 92: ...format Please refer to HTTP streaming on page 94 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 Manua...

Page 93: ...VIVOTEK User s Manual 93...

Page 94: ...llowing warning messages will be displayed To access the Network Camera on the LAN both the HTTP port and secondary HTTP port can be used to access the Network Camera For example when the HTTP port is...

Page 95: ...es 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 http por...

Page 96: ...stream 1 to 3 For example when the access name for stream 1 is set to live1s1 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...

Page 97: ...ne and thus is always odd When the multicast RTP port changes the multicast RTCP port will change accordingly If the multicast RTP video ports are incorrectly assigned the following warning message wi...

Page 98: ...C 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 co...

Page 99: ...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 100: ...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 101: ...ort 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 Cla...

Page 102: ...hem a particular forwarding treatment for example how much bandwidth to reserve for it Below are the setting options of DSCP DiffServ Codepoint Specify the DSCP value for each application 0 63 Note th...

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

Page 104: ...llows the user to save recorded video clips You can utilize VIVOTEK s Shepherd utility to upgrade the firmware via FTP server By default the FTP port is set to 21 It can also be assigned to another po...

Page 105: ...iscovery utility instead Find the Discovery formerly Bonjour Browser from the Mac App Store Discovery is a utility that displays all the Bonjour services on your local network or on Wide Area Bonjour...

Page 106: ...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 107: ...gement privilege as operators or viewers Select or de select the checkboxes and then click Save to enable the settings If you give Viewers the privilege Operators will also have the ability to control...

Page 108: ...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 109: ...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 110: ...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 111: ...py 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 112: ...112 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 113: ...113 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 en...

Page 114: ...been created and installed before you can click on the Save button for the configuration to take effect 12 To begin an encrypted HTTPS session click Home to return to the main page Change the URL addr...

Page 115: ...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 na...

Page 116: ...arily 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 fun...

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

Page 119: ...rk 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 ident...

Page 120: ...s exploit of a website in this case the camera Unauthorized commands are transmitted from a user that the web application trusts using the mechanism of forging a trusted user s own request with a requ...

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

Page 122: ...viewing 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 o...

Page 123: ...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 124: ...reset 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 alon...

Page 125: ...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 126: ...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 127: ...ble with 3rd party software modules known as VADP will be listed Use the arrow buttons to select these triggers Users may implant these modules for different purposes such as triggering motion detecti...

Page 128: ...set up a network storage NAS The media to back up can include snapshot images video or system logs depending on your event settings Once the triggers are configured they will be listed under the VADP...

Page 129: ...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 130: ...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 131: ...client side settings Server address Enter the SFTP server address in either the domain name or IP address Server port By default the FTP server port is set to 22 It can also be assigned to another po...

Page 132: ...ssword or the Public key mode When using SFTP you can authenticate using a public private SSH key pair instead of a password If key authentication is not enabled you need to specify a password instead...

Page 133: ...and upload the public key to the SFTP server A private key is a guarded secret and it can be stored on disk in an encrypted form A passphrase is used in order to decrypt it It is a login password to...

Page 134: ...etting URL Enter the URL of the HTTP server User name Enter the user name if necessary Password Enter the password if necessary To verify if the HTTP settings are correctly configured click Test The r...

Page 135: ...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 136: ...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 137: ...shots from any of the video profiles 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 t...

Page 138: ...profile 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 trigg...

Page 139: ...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 140: ...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 141: ...otek com downloadfile solutions vadp smart motion detection manual_ en pdf Click on Configuration Applications Motion detection The Smart Motion utility will be automatically started If Human detectio...

Page 142: ...to Smart VCA s user documentation for more information Click on Configuration Applications Smart VCA The Smart VCA utility will be automatically started The Smart Motion detection and Smart VCA share...

Page 143: ...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 144: ...tage on the chart Click the Enable shock detector checkbox and click Save to complete the configuration Shock Level You should then go to Event settings to configure the shock detection as a triggerin...

Page 145: ...intelligent video applications such as license plate recognition object counting or as an agent for edge recording etc Once the software package is successfully uploaded the module configuration vadp...

Page 146: ...e end of the row Click on the X button to remove an existing module When prompted by a confirm message Click Yes to proceed Yes No Note that the actual memory consumed while operating the module will...

Page 147: ...age register and activate the license for using VIVOTEK s VADP modules You should acquire the license key elsewhere and manually upload to the network camera Follow the onscreen instruction on VIVOTEK...

Page 148: ...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 149: ...ggered 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 spac...

Page 150: ...tails in the following NAS server Click Add NAS server to open the server setting window and follow the steps below to set up 1 Fill in the information for your server For example 2 Click Test to chec...

Page 151: ...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 152: ...n about folder naming rules please refer to page 135 for details 20190210 20190211 20190212 f you want to enable recording notification please click Event to configure event triggering settings Please...

Page 153: ...he 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 activity before you remove...

Page 154: ...this item and enter the number of days you wish to retain a file For example if you enter 7 days the recorded files will be stored on the SD card for 7 days Click Save to enable your settings Storage...

Page 155: ...r especially when the cyclic recording function is enabled during the transaction stage when a storage space is full and the incoming streaming data is about to overwrite the previously saved videos E...

Page 156: ...ws the user to set up search criteria for recorded data If you do not select any criteria and click Search button all recorded data will be listed in the Search Results column File attributes Select o...

Page 157: ...ich 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 a...

Page 158: ...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 159: ...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 160: ...uest includes internal camera parameters these parameters must be written exactly as they are named in the camera or video server The CGIs are organized in functionally related directories under the c...

Page 161: ...cept some privileges and network options 6 admin admin Administrator access rights can fully control the camera s operations 7 N A Internal APIs Unable to be changed by any external interfaces A viewe...

Page 162: ...parameter Where the 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 ofth...

Page 163: ...63 2020 VIVOTEK INC All Right Reserved 31 http 192 168 0 123 cgi bin admin getparam cgi network_ipaddress Response HTTP 1 0 200 OK r n Content Type text html r n Context Length 33 r n r n network ipad...

Page 164: ...ter value return return page PARAMETER DESCRIPTION parameter A full path like videoin_c0_s0_h264_resolution videoin_c0_s0_h264_maxframe etc value The assigned value to the parameter return page Redire...

Page 165: ...that you set and are readable will be returned Example Set the IP address of server to 192 168 0 123 Request http myserver cgi bin admin setparam cgi network_ipaddress 192 168 0 123 Response HTTP 1 0...

Page 166: ...om email address n A string limited 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...

Page 167: ...era should not be restarted when parameters are changed 7 1System Group system NAME VALUE SECURITY get set DESCRIPTION hostname string 64 1 6 Host name of server Network Camera Wireless Network Camera...

Page 168: ...al America Central Time Mexico City Saskatchewan 200 GMT 05 00 Eastern Time New York Toronto 201 GMT 05 00 Bogota Lima Quito Indiana 180 GMT 04 30 Caracas 160 GMT 04 00 Atlantic Time Canada La Paz San...

Page 169: ...ibirsk Astana Dhaka Sri Jayawardenepura 260 GMT 06 30 Rangoon 280 GMT 07 00 Bangkok Hanoi Jakarta Krasnoyarsk 320 GMT 08 00 Beijing Chongging Hong Kong Kuala Lumpur Singapore Taipei 360 GMT 09 00 Osak...

Page 170: ...when the version number httpversion is equal or greater than 0314b tz POSIX TZ string 6 6 POSIX timezone setting We support this parameter when the version number httpversion is equal or greater than...

Page 171: ...rs will be restored to the default value except for a union of the combined results restoreexceptvadp 0 positive integer 7 6 Restore the system parameters to default values except the vadp parameters...

Page 172: ...ut interval Only available when capability_taics_support 1 7 1 1 System Info Subgroup of system info The fields in this group are unchangeable NAME VALUE SECURITY get set DESCRIPTION modelname string...

Page 173: ...on the server customlanguage_coun t 0 positive integer 0 6 Number of custom languages which have been uploaded to the server customlanguage_i 0 maxcount 1 string 0 6 Custom language name 7 2Status Gro...

Page 174: ...n channel products n denotes the value of capability_nvideoin NAME VALUE SECURITY get set DESCRIPTION signal_detect boolean 1 7 Indicates whether the video source is connected or not Only available w...

Page 175: ...Indicate which privileges and above can control PTZ capability_ptzenabled 0 or capability_eptz 0 or capability_fisheye 0 user_i0_name string 64 6 7 User name of root user_i 1 20 _name string 64 6 7 U...

Page 176: ...ort from 80 to 5556 and change RTP port for video from 5556 to 20480 Then set preprocess 9 to stop both service first cgi bin admin setparam cgi network_preprocess 9 network_http_ port 5556 network_rt...

Page 177: ...alled 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 bytes certificate_exist boolean 6 6 Certificate installed flag for TLS c...

Page 178: ...ideo 0 63 6 6 Video channel for DSCP audio 0 63 6 6 Audio channel for DSCP capability_naudioin 0 eventalarm 0 63 6 6 Event alarm channel for DSCP management 0 63 6 6 Management channel for DSCP eventt...

Page 179: ...deoin 1 _accessna me product dependent Not recommended to use this string 32 1 6 Http server push access name for stream N N 1 capability_nmediastream capability_ nvideoin 1 capability_protocol_spush_...

Page 180: ...y_nmediastream capability_protocol_spush_mjpeg 1 and capability_nmediastream 0 The value are shown as video1s1 mjpg c0_s0_accessname channel1stream1 video1s2 mjpg c0_s1_accessname channel1stream2 vide...

Page 181: ...s0_accessname channel1stream1 live1s2 sdp s1_accessname channel1stream2 live1s3 sdp s2_accessname channel1stream3 live1s4 sdp s3_accessname channel1stream4 etc Values start with prefix cgi bin are pro...

Page 182: ...is parameter when the version number httpversion is equal or greater than 0313a 7 6 9 RTSP Multicast Subgroup of network rtsp_s 0 n 1 _multicast n denotes the value of capability_nmediastream capabili...

Page 183: ...rsion number httpversion is equal or greater than 0304a videoport 1025 65535 4 4 Multicast video port audioport product dependent 1025 65535 4 4 Multicast audio port Only available when capability_nau...

Page 184: ...e_bonjour NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable bonjour service feature We support this parameter when the version number httpversion is equal or greater than 0312a service...

Page 185: ...ip address Network address ip address network mask Range address start ip address end ip address 6 6 IPv4 address list ipv6list_i 0 9 string 43 6 6 IPv6 address list 7 8Video Input Not Recommended to...

Page 186: ...lance 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 100...

Page 187: ...httpversion is equal or greater than 0400a irismode fixed indoor outdoor product independent 4 4 Control DC Iris mode outdoor Auto setting DC Iris to get best quality but easy to meet rolling or flic...

Page 188: ...will not be used after the version number httpversion is equal or greater than 0400a flip boolean 4 4 Flip the image We do not support this parameter when capability_nvideoin 1 This parameter will no...

Page 189: ...rt Bit 4 Support zoom operation 0 not support 1 support Bit 5 Support focus operation 0 not support 1 support SD PZ IZ series only Not support this parameter anymore when the version number httpversio...

Page 190: ...hen capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a maxexposure product dependent 1 32000 5 32000 1 8000 5 8000 etc Available...

Page 191: ...not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a 7 8 1 Video Input Setting per Channel Group vi...

Page 192: ...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 indo...

Page 193: ...efinition is 0 EV 2 0 1 EV 1 7 2 EV 1 3 3 EV 1 0 4 EV 0 7 5 EV 0 3 6 EV 0 7 EV 0 3 8 EV 0 7 9 EV 1 0 10 EV 1 3 11 EV 1 7 12 EV 2 0 Only available when capability_image_c 0 n 1 _exposu re_mode 0 exposu...

Page 194: ...0 n 1 _exposu re_mode 0 irismode fixed 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 e...

Page 195: ...lc Not support anymore boolean 4 4 Enable backlight compensation Not support this parameter anymore when the version number httpversion is equal or greater than 0301a It s recommanded to use exposurew...

Page 196: ...malized 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 Only available when capability_videoin_c 0 n 1 _color_ sup...

Page 197: ...onvideo_p osition top bottom 4 4 Text on video string position textonvideo_si ze 20 40 4 4 Text on video font size textonvideo_fo ntpath usr share font Default ttf mnt flash2 upload ttf 4 4 Choose cam...

Page 198: ...t image frame rate from sensor due to sensor generates a frame per exposure time Ex If this is set to 1 5s 1 8000s and camera takes 1 5s on the night then sensor only outputs 5 frame s Only available...

Page 199: ...eo profile Only available when capability_image_c 0 n 1 _exposu re_mode 0 meteringmode auto blc hlc Available value is listed in capability_image_c 0 n 1 _exposure_meteringm ode 4 4 auto The algorithm...

Page 200: ...1 _exposu re_bracketing_mode 1 We support this parameter when the version number httpversion is equal or greater than 0310a s 0 m 1 _en ableeptz boolean 4 4 Indicate whether stream supprts eptz or not...

Page 201: ...250 500 1000 2000 3000 4000 4 4 The time interval between two I frames Intra coded picture The unit is millisecond ms s 0 m 1 _h2 64_ratecontrol mode cbr vbr 4 4 cbr Constant bit rate mode vbr Fixed q...

Page 202: ...64_ratecontrolmode vbr s 0 m 1 _h2 64_cbr_quant 1 5 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality level in cbr_qpercent Only available...

Page 203: ...n_c n _h264_profil e s 0 m 1 _h2 64_smartq_en able boolean 4 4 Enable Smart Q function Only available when capability_videoin_c 0 n 1 _smart q_support is 1 We support this parameter when the version n...

Page 204: ...n capability_videoin_codec Only valid when h265_ratecontrolmode vbr s 0 m 1 _h2 65_qvalue 0 51 4 4 Manual video quality level input The Q value which is used by encoded library directly Only available...

Page 205: ...level in cbr_qpercent Only available when h265 is listed in capability_videoin_codec and h265_ratecontrolmode cbr s 0 m 1 _h2 65_cbr_qperce nt 1 100 4 4 Select customized quality in a normalized full...

Page 206: ..._profile Available values are listed in capability_videoin_c 0 n 1 _h265_profile 1 4 Indicate H265 profiles Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h2 65_smartq_en able...

Page 207: ...ue which is used by encoded library directly Only valid when mjpeg_ratecontrolmode vbr and s 0 m 1 _mjpeg_quant 99 s 0 m 1 _mj peg_qpercent 1 100 4 4 Select customized quality in a normalized full ran...

Page 208: ...rate in constant bit rate mode Only valid when mjpeg_ratecontrolmode cbr s 0 m 1 _mj peg_prioritypo licy framerate imagequality 4 4 Set prioritypolicy Only valid when mjpeg_ratecontrolmode cbr s 0 m 1...

Page 209: ...n capability_image_c 0 n 1 _wdrpro _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 depend...

Page 210: ...el 1 4 low high The higher sensitivity level meas that it is easy to be trigger while scene changed Only available when capability_image_c 0 n 1 _aespee d is 1 and capability_image_c 0 n 1 _aespee dsu...

Page 211: ...am_support 1 and capability_smartstream_version 2 0 Group videoin_c 0 n 1 _s 0 m 1 _h265_smartstream2 capability_smartstream_support 1 capability_smartstream_version 2 0 and h265 is listed in capabili...

Page 212: ...i 0 k 1 capability_smartstream_support 1 capability_smartstream_version 2 0 and h265 is listed in capability_videoin_codec and capability_smartstream_mode_manual 1 n denotes the value of capability_nv...

Page 213: ...nexposure product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c 0 n 1 _exposure_minrange 4 4 Minimum exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 3200...

Page 214: ...ct dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c 0 n 1 _exposure_maxrange 4 4 Exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5...

Page 215: ...The definition is 0 EV 2 0 1 EV 1 7 2 EV 1 3 3 EV 1 0 4 EV 0 7 5 EV 0 3 6 EV 0 7 EV 0 3 8 EV 0 7 9 EV 1 0 10 EV 1 3 11 EV 1 7 12 EV 2 0 Only available when capability_image_c0_exposure_mod e 0 exposu...

Page 216: ...widerange outdoor indoor sodiumauto etc Available values are listed in capability_image_c 0 n 1 _wbmode 4 4 Modes of white balance auto Auto white balance panorama indicates that camera would try to b...

Page 217: ...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 _wbmo de Only...

Page 218: ...c 0 n 1 _exposu re_rangetype is onevalue Normalized range We support this parameter when the version number httpversion is equal or greater than 0302a meteringmode auto blc hlc Available value is list...

Page 219: ...set P Iris 1 Open 100 Close Only valid when piris_mode manual or capability_image_c 0 n 1 _sensor type is smartsensor Only available when capability_image_c 0 n 1 _iristype piris irismode fixed indoo...

Page 220: ...nly available when capability_image_c 0 n 1 _wdrc_ mode is 1 wdrc_strength product dependent 1 100 4 4 The strength of WDR enhanced The bigger value means the stronger strength of WDR enhanced Only av...

Page 221: ...bility_image_c 0 n 1 _aespee d is 1 and capability_image_c 0 n 1 _aespee dsupportsensitivity is 1 flickerless product dependent boolean 4 4 Turn on 1 or turn off 0 the flickerless mode Only available...

Page 222: ...han 0312a We do not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a c 0 n 1 _en able boolean 4 4 E...

Page 223: ...ynight_c 0 capability_ nvideoin 1 _smartir is 1 We replace this parameter with ircutcontrol_c 0 n 1 _sir when the version number httpversion is equal or greater than 0312a We do not support this param...

Page 224: ...cutcontrol_illuminators_builtin_irle d_enabled when the version number httpversion is equal or greater than 0312a We do not support this parameter when capability_nvideoin 1 This parameter will not be...

Page 225: ...httpversion is equal or greater than 0400a bwmode Not recommended to use this boolean 6 6 Switch to B W in night mode if enabled Only available when capability_daynight_c 0 n 1 _ blackwhitemode is 1...

Page 226: ...this visible ir irenhanced blueenhanced product dependent Available values are listed in capability_daynight_ c 0 n 1 _spectrum _mode 6 6 Set spectrum method Only available when capability_daynight_c...

Page 227: ...t this parameter when the version number httpversion is equal or greater than 0312a daymodebegintime 00 00 23 59 6 6 Day mode begin time We support this parameter when the version number httpversion i...

Page 228: ...ntrol_illuminators capability_daynight_c 0 n 1 _support 0 n denotes the value of capability_nvideoin NAME VALUE SECURIT Y get set DESCRIPTION builtin_irled_enabled boolean 6 6 Enable disable built in...

Page 229: ...do _enabled boolean 1 6 Enable disable external led mounted on do 2 capability_ndo Only available when capability_ndo 1 Only available when capability_daynight_illuminators_ext ernal_support 0 and do...

Page 230: ...ing is 1 We replace brightness with brightnesspercent 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...

Page 231: ...place sharpness with sharpnesspercent This parameter will not be used after the version number httpversion is equal or greater than 0400a brightnesspercent 0 100 4 4 Set brightness in the normalized r...

Page 232: ...h we set gamma value to 100 level but not all gamma values are valid Internal module will take the closest valid one For example 1 45 may all be mapped to gamma value 0 45 etc Only available when capa...

Page 233: ...ility_image_c 0 n 1 _defog_ mode is 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 _is_mod e eis_...

Page 234: ...r 4 4 Restore of adjusting white balance of image according to mode settings freeze product dependent boolean 4 4 Enable disable Image freeze while patrolling 0 disable 1 enable Only available when ca...

Page 235: ...ignment 0 100 4 4 Stitch the sensors together into focused position Only available when capability_image_c 0 n 1 _lens_al ignment is 1 lens_ldc_mode boolean 4 4 Enable disable lens distortion correcti...

Page 236: ...cent Only available when bit 0 of capability_image_c 0 n 1 _basicse tting is 1 We replace profile_i0_brightness with profile_i0_brightnesspercent This parameter will not be used after the version numb...

Page 237: ...arpness Not recommended to use this 3 3 100 4 4 5 Less saturation 5 More saturation 100 Use image_c 0 n 1 _saturationpercent Only available when bit 2 of capability_image_c 0 n 1 _basicse tting is 1 W...

Page 238: ...nge 0 Softer 100 Sharper Only available when bit 3 of capability_image_c 0 n 1 _basicse tting is 1 profile_i 0 m 1 _gammacurve 0 100 4 4 0 Fine turned gamma curve by Vivotek 1 Gamma value 0 01 2 Gamma...

Page 239: ...rofile_i 0 m 1 _defog_mode product dependent boolean 4 4 Enable disable defog mode 0 disable 1 enable Only available when capability_image_c 0 n 1 _defog_ mode is 1 profile_i 0 m 1 _defog_strength pro...

Page 240: ...ability_image_c 0 n 1 _exposure_mode 1 NAME VALUE SECURITY get set DESCRIPTION mode auto custom blc hlc center Available values are listed in capability_image_c 0 n 1 _exposure_winmode 4 4 auto Use fu...

Page 241: ...4 4 Left top corner coordinate of the window Only available when qvga is listed in capability_image_c 0 n 1 _exposu re_windomain size 0 320x0 240 4 4 Width and height of the window Only available whe...

Page 242: ...et set DESCRIPTION mode auto custom blc hlc center Available values are listed in capability_image_c 0 n 1 _exposure_winmode 4 4 The mode indicates how to decide the exposure auto Use full view as the...

Page 243: ...available when capability_daynight_c 0 n 1 _sup port 0 home 0 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 _exposu re_windomai...

Page 244: ...dioin NAME VALUE SECURITY get set DESCRIPTION source Not recommended to use this micin linein product dependent 4 4 micin use built in microphone input linein use external microphone input We replace...

Page 245: ...s external microphone The related bit of capability_audio_extmic is equal to 1 mute 0 1 1 4 0 Mute off 1 Mute on gain Not recommended to use this 0 100 4 4 Gain of input audioin_c 0 n 1 _source linein...

Page 246: ...e listed in capability_audioin_ codec 4 4 Set audio codec type for input aac4 Advanced Audio Coding AAC gamr Adaptive Multi Rate AMR g711 G 711 g726 G 726 s0_aac4_bitrate 16000 32000 48000 64000 96000...

Page 247: ...ability_audio_aecmode is manual We support this parameter when the version number httpversion is equal or greater than 0306b alarm_enable boolean 4 4 Enable audio detection alarm_level 1 100 4 4 Audio...

Page 248: ...o time to live value 7 14 Audio Output per Channel Group audioout_c 0 n 1 for n channel products capability_naudioout 0 n denotes the value of capability_naudioout NAME VALUE SECURITY get set DESCRIPT...

Page 249: ...ch Window Group motion_c 0 n 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 motio...

Page 250: ...pversion is equal or greater than 0400a polygon Not recommended to 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 O...

Page 251: ...Only available when qvga is listed in capability_motion_windomain It s recommended to use polygonsd This parameter will not be used after the version number httpversion is equal or greater than 0400a...

Page 252: ...ion number httpversion is equal or greater than 0400a Group motion_c 0 n 1 _profile_i 0 m 1 _win_i 0 k 1 for m profile and n channel product n denotes the value of capability_nvideoin m denotes the va...

Page 253: ...is equal or greater than 0400a polygon Not recommended to 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 avail...

Page 254: ...lity_motion_windomain It s recommended to use polygonsd This parameter will not be used after the version number httpversion is equal or greater than 0400a height Not recommended to use this 0 240 4 4...

Page 255: ...ceeds the threshold for more than duration second s then image too dark detection is triggered bright_enable boolean 4 4 Enable or disable image too bright detection bright_threshold 0 100 4 4 Thresho...

Page 256: ...ce provider provider _passwor dkey string 64 7 6 Your password or key to login to the DDNS service provider 7 19 Express Link Group expresslink PARAMETER VALUE SECURITY get set DESCRIPTION enable bool...

Page 257: ...t 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 level 0 7 6 6 Levels used to distin...

Page 258: ...6 6 Read only authentication type encryptpwrw string 8 128 7 6 Read write passwrd encryptpwro string 8 128 7 6 Read only password encrypttyperw DES 6 6 Read write encryption type encrypttypero DES 6...

Page 259: ...r of configuration area theme_color_videoback ground string 7 1 6 Background color of video area theme_color_case string 7 1 6 Frame color defaultpassword_specia lcharacter _ 6 7 Allowed special chara...

Page 260: ...C All Right Reserved 128 NAME VALUE SECURITY get set DESCRIPTION equal or greater than 0314b defaultpassword_length 8 64 6 7 Allowed password length We support this parameter when the version number h...

Page 261: ...ectangle win_i 0 m 1 _top 0 240 4 4 Top coordinate of window position Only available when capability_image_c 0 n 1 _privacy mask_wintype rectangle win_i 0 m 1 _width 0 320 4 4 Width of privacy mask wi...

Page 262: ...ivacy mask_wintype polygon Only available when std is listed in capability_image_c 0 n 1 _privacy mask_windomain 7 26 3D Privacy Mask Group privacymask3d_c 0 n 1 for n channel products and m privacy m...

Page 263: ...f window position 0 Non flip side 1 Flip side 7 27 Capability Group capability NAME VALUE SECURITY get set DESCRIPTION api_httpversion string This number start with 0301a 0 7 The version of VIVOTEK We...

Page 264: ...r is an alphabetic EX 0302b_1 Major version 03 minor version 02 revision b platform 1 The 4 integer numbers are WebAPI version we use short name httpversion for it in this document The 5th character i...

Page 265: ...means no audio input support naudioout 0 positive integer 0 7 The number of audio output channel nvideoin positive integer 0 7 Number of video inputs nvideoout 0 Positive Integer 0 7 Number of video o...

Page 266: ...0 positive integer 0 7 An 32 bit 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 externa...

Page 267: ...mended to use this 0 positive integer 0 7 An 4 bit integer which indicates the supportive application of remotefocus If the value of this parameter is larger than 0 it means that the camera supports r...

Page 268: ...t stream supports ePTZ or not Bit 1 2nd stream supports ePTZ or not and so on For nvideoin 2 the definition is different First all 32 bits are divided into groups for channel Ex nvideoin 2 bit 0 15 ar...

Page 269: ...support local storage fisheye boolean 0 7 The parameter is used to determine whether the product is fisheye or not tampering boolean 0 7 Indicate whether to support tampering detection tamperingmode...

Page 270: ...umber of media number We support this parameter when the version number httpversion is equal or greater than 0311c storage_dbenabled boolean 0 7 Media files are indexed in database protocol_https bool...

Page 271: ...hether to support IPv6 protocol_pppoe boolean 0 7 Indicate whether to support PPPoE protocol_ieee8021 x boolean 0 7 Indicate whether to support IEEE802 1x protocol_qos_cos boolean 0 7 Indicate whether...

Page 272: ...ility_videoin_c0_mjpeg_maxfra merate This is kept for compatibility videoin_h264_max framerate A list of Integer and 0 7 This equals capability_videoin_c0_h264_maxfra merate This is kept for compatibi...

Page 273: ...lity_audio_aec is 1 We support this parameter when the version number httpversion is equal or greater than 0306b audio_aecaffect maxframerate fixed 1 5 product dependent 0 7 When acoustic echo cancell...

Page 274: ...15 which means the max frame rate is 15fps when acoustic echo cancellation function is enabled means no feature is affected Only available when capability_audio_aec is 1 We support this parameter when...

Page 275: ...audio_lineout boolean 0 7 Indicate whether to support line output audio_michardwar eswitch boolean 0 7 Indicate whether the hardware supports built in external mic switch audio_headphoneo ut Not supp...

Page 276: ...image with pixels std A normalized 0 9999 range Not supported smartstream_supp ort boolean 0 7 Indicate whether smart stream is supported smartstream_versi on integer 0 7 Number of smart stream versi...

Page 277: ...ity_smartstream_support is 1 smartstream_nwin dow_manual positive integer 0 7 Maximum number of tracking window of manual Only available when capability_smartstream_support is 1 smartstream_nwin dow_h...

Page 278: ...equal or greater than 0301b It will be replaced by capability_camctrl_ptztunnel camctrl_ptztunnel boolean 0 7 Indicate whether to support ptztunnel We support this parameter when the version number ht...

Page 279: ...02dot1 1b boolean 0 7 Indicate whether to support wireless 802 11b wireless_s802dot1 1g boolean 0 7 Indicate whether to support wireless 802 11g wireless_s802dot1 1n boolean 0 7 Indicate whether to su...

Page 280: ...CVV TCXX is excepted test_ac boolean 0 7 Indicate whether to support test ac key version_onvifdaem on string 0 7 Indicate ONVIF daemon version version_onviftestto ol string 0 7 Indicate ONVIF test too...

Page 281: ...ofiles We support this parameter when the version number httpversion is equal or greater than 0313a image_iristype Not recommended to use this string 0 7 Indicate iris type piris P Iris dciris DC Iris...

Page 282: ...ecommended to use this 0 positive integer 0 7 The maximum MOD connection numbers Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 We replace this parameter with capab...

Page 283: ...ifetime and Log SD Card feature allows users to obtain the card s remaining lifetime information 0 Non support this feature 1 Support this feature Only Sony Micron SD card can support this function no...

Page 284: ...t Boolean 0 7 Indicate support for security camera We support this parameter when the version number httpversion is equal or greater than 0314a securecam_version string 0 7 Indicate the security camer...

Page 285: ...URITY get set DESCRIPTION ptztunnel boolean 0 7 Indicate whether to support ptztunnel in this video input privilege boolean 0 7 Indicate whether to support Manage Privilege of PTZ control in the secur...

Page 286: ...length is adjusted the zoom will stay in focus when the focal length is adjusted focusmode auto onetimeauto sp otlight manual product dependent 0 7 Focus mode selection auto Camera will automatically...

Page 287: ...or pan position Only available when bit0 of capability_camctrl_c 0 n 1 _buildin pt is 1 maxpan 0 positive integer 0 7 The upper limit for pan position Only available when bit0 of capability_camctrl_c...

Page 288: ...ve integer 0 7 The maximum speed level of zoom motion Only available when the value of capability_camctrl_c 0 n 1 _zoomm odule is 1 minzoom 0 positive integer 0 7 The lower limit for zoom position Onl...

Page 289: ...capability_daynight_c 0 n 1 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION support boolean 0 7 Indicate whether the camera supports day night mode switch built...

Page 290: ...ort optimized IR control technology We replaced this parameter with capability_daynight_illumintators_opti mizedir when the version number httpversion is equal or greater than 0312a smartir boolean 0...

Page 291: ...ual or greater than 0302a ircutsensitivity_supportle vel 0 positive integer 0 7 The value indicate the support strength level of ircutsensitivity Only available when capability_daynight_c 0 n 1 _suppo...

Page 292: ...ort when the version number httpversion is equal or greater than 0312a spectrum_mode visible ir irenhanced blueenhanced product dependent 0 7 Indicate the spectrum mode visible The ideal default setti...

Page 293: ...i the camera automatically switches the current mode when a ditigal input 1 is triggered di2 the camera automatically switches the current mode when a ditigal input 2 is triggered di3 the camera autom...

Page 294: ...type irled IR led whiteled white led not support We support this parameter when the version number httpversion is equal or greater than 0312a external_support boolean 0 7 Indicate whether to support...

Page 295: ...e visible The ideal default setting for visible light ir The ideal default setting for IR light irenhanced This CCM model increases the brightness effect of IR light blueenhanced This CCM model increa...

Page 296: ...ttpversion is equal or greater than 0312a 7 27 6 Capability for Video Input Group capability_videoin_c 0 n 1 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION len...

Page 297: ...deo streams 0 camera do not support this feature We support this parameter when the version number httpversion is equal or greater than 0310a eptz_zoomratio string 0 7 Indicate the support zoom ratio...

Page 298: ...nd user can t change it hidden UI is hidden fixed UI is fixed to one selection or value ranged UI is fixed to multiple selections or values enabled UI is checked notsupport the affected function is no...

Page 299: ...n is equal or greater than 0309b streamcodec positive integer 0 7 Represent supported codec types of each stream This contains a list of positive integers split by comma Each one stands for a stream a...

Page 300: ...as capability_nmediastream minresolution A list of Integer 0 7 Represent supported minimum resolution of each stream in current video mode The element number is defined as capability_nmediastream We...

Page 301: ...ly available when mjpeg is listed in capability_videoin_codec mjpeg_maxbitrate positive integer 0 7 Maximum bitrates of MJPEG The unit is bps means MJPEG does not support bit rate control Only availab...

Page 302: ...th H 265 on resolutions in current video mode means not support One to one mapping to the resolution in resolution The element number is defined as nresolution in this group This parameter may be chan...

Page 303: ...mmended to use capability_videoin_c 0 n 1 _mounttype mounttype ceiling wall floor product dependent Available values are listed in capability_videoin _c 0 n 1 _mou nttype 0 7 Indicate the supported mo...

Page 304: ...er line frequency 50 60Hz can be set by user We support this parameter when the version number httpversion is equal or greater than 0308a smartfps_support boolean 0 7 Indicate whether to support Smart...

Page 305: ...nd floor mount resolutionW1P A list of WxH 0 7 Available resolutions of 1P mode of wall mount resolutionW1R A list of WxH 0 7 Available resolutions of 1R mode of wall mount resolutionW4R A list of WxH...

Page 306: ...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 indicates 1st stream of a channel support ePTZ or not The 2nd bit of...

Page 307: ...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 sensitivity by combining multiple pixels to one The drawback is re...

Page 308: ...n this video mode 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...

Page 309: ...in_codec maxfps_h265 A list of Positive Integer and 0 7 Maximum fps which the device can encoded with H 265 on resolutions in this video mode means not support One to one mapping to the resolution in...

Page 310: ...the version number httpversion is equal or greater than 0311a wdrpro_mode 0 1 2 0 7 0 Non support WDR Pro 1 Support WDR Pro 2 Support WDR Pro and WDR Pro II wdrpro_strength 0 1 0 7 0 Non support tuni...

Page 311: ...I 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 s...

Page 312: ...nt 0 7 When WDR Enhanced is enabled some features may become malfunction or be forced to a given value The affected functions are list here The format is Affect API name Policy Description Policy can...

Page 313: ...port 3D digital noise reduction dnrstrength positive integer 0 7 Indicate the support strength level of 3D digital noise reduction Only available when capability_image_c 0 n 1 _dnr 0 We support this p...

Page 314: ...ater than 0302a is_supportlevel 0 positive integer 0 7 Indicate the support strength level of image stabilizer mode Only available when capability_image_c 0 n 1 _is_mod e is not We support this parame...

Page 315: ...urelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL means no feature is affected Only available when capability_image_c 0 n 1 _is_...

Page 316: ...ermalsensor 0 7 Indicate sensor type rawsensor Raw sensor smartsensor Smart sensor thermalsensor Thermal sensor N A We support this parameter when the version number httpversion is equal or greater th...

Page 317: ...ue is the assigned value videoin_c 0 n 1 _shuttervalue maximum The shutter value can be up to the assigned value videoin_c 0 n 1 _shuttervalue not support Only available when capability_image_c 0 n 1...

Page 318: ...enabled some features may become malfunction or be forced to a given value The affected functions are list here The format is Affect API name Policy Description Policy can be categorized into followi...

Page 319: ...disabled wdrpro disabled exposurelevel hidd en defaultgain fixed x or others x nonnegative integer product dependent 0 7 When exposure shutter priority mode is enabled some features may become malfunc...

Page 320: ...ort this parameter when the version number httpversion is equal or greater than 0302a exposure_irispriority mode_affect exposurewin mode blc hidden defog disabled wdrpro disabled exposurelevel hidd en...

Page 321: ...ble when irispriority is listed in capability_image_c 0 n 1 _ exposure_modetype and capability_image_c 0 n 1 _ exposure_mode is 1 We support this parameter when the version number httpversion is equal...

Page 322: ...d as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL means no feature is affected Only available when qualit...

Page 323: ...r values enabled UI is checked notsupport the affected function is not available Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is...

Page 324: ...gm ode auto blc hlc product dependent 0 7 Available options for videoin_c 0 n 1 _meteringmode Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_hlcmode_s upportwindow boolean...

Page 325: ...sabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer...

Page 326: ...le when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_winnum 0 Positive Integer 0 7 Indicate the number of custom exposure windows If no custom is listed in exposure_winmode this should be 0...

Page 327: ...exposure_mode 0 this value must be set to Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_minrange 1 32000 1 8000 or others product dependent 0 7 Available range for videoin...

Page 328: ...me first stream Only available when capability_image_c 0 n 1 _ exposure_bracketing_mode is 1 We support this parameter when the version number httpversion is equal or greater than 0310a privacymask_wi...

Page 329: ...oduct dependent 0 7 When flickerless is enabled some features may become malfunction or be forced to a given value The affected functions are list here The format is Affect API name Policy Description...

Page 330: ...og If capability_image_c 0 n 1 _defog_ mode 1 this may be either 0 or 1 defog_supportlevel 0 positive integer 0 7 The value indicate the support strength level of defog defog_affect wdrc unchanged con...

Page 331: ...r or string or NULL means no feature is affected When defog 0 this value must be aespeed 0 1 0 7 0 Non support AE speed 1 Support AE speed aespeedsupportlevel positive integer 0 7 The value indicate t...

Page 332: ...it 3 Currently this is a reserved bit and the default value is 0 focuswindomain qvga px std 0 7 The domain to set a focus window qvga a 320x240 range to represent the whole image px Locate a window in...

Page 333: ...ly available when capability_image_c 0 n 1 _sensor type is smartsensor deinterlace_support boolean 0 7 Indicate whether to support deinterlace function We support this parameter when the version numbe...

Page 334: ...or tones correspond to the apparent surface temperatures of the target We support this parameter when the version number httpversion is equal or greater than 0310a palette_mode A list of palette optio...

Page 335: ...detecting the next event trigger boot di pir motion seq recnotify tampering vi volalarm visignal vadp smartsd product dependent 6 6 Indicate the trigger condition boot System boot di Digital input pir...

Page 336: ...to detect the 1st and 3rd windows set mdwin as 5 mdwin0 0 positive integer 6 6 Similar to mdwin The parameter takes effect when profile 1 of motion detection is enabled vi 0 positive integer 6 6 Indic...

Page 337: ...n Friday and Sunday set weekday as 66 begintime hh mm 6 6 Begin time of the weekly schedule endtime hh mm 6 6 End time of the weekly schedule 00 00 24 00 sets schedule as always on lowlightcondition p...

Page 338: ...Only available when capability_supportsd 0 action_cf_backup Boolean 6 6 Enable or disable the function that send media to SD card for backup if network is disconnected Only available when capability_...

Page 339: ...led is 0 action_audioclip_enable boolean 6 6 Enable disable the function the play an audio clip when an event is triggered Only avaliable when capability_audio_audioclip is 1 action_audioclip_media 0...

Page 340: ...Password of the user ftp_address string 128 6 6 FTP server address ftp_username string 64 6 6 Username to log in to the server ftp_passwd string 64 7 6 Password of the user ftp_port 0 65535 6 6 Port t...

Page 341: ...swd string 64 7 6 Password of the user ns_workgroup string 64 6 6 Workgroup for network storage 7 29 1 Server Setting for Event Action of sftp Group server_i 0 4 _sftp Only available when bit 1 of cap...

Page 342: ...oadkeytype ed25519 rsa ecdsa 6 6 The keytype used for key pair ed25519 faster to generate with higher security level some old server might not support rsa slower to generate with slightly lower securi...

Page 343: ...dicate the source of media stream 0 means the first stream 1 means the second stream and etc 2 means the third stream and etc 3 means the fourth stream and etc snapshot_prefix string 16 6 6 Indicate t...

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

Page 345: ...etwork connection enable boolean 6 6 Enable or disable this recording priority 0 1 2 6 6 Indicate the priority of this recording 0 indicates low priority 1 indicates normal priority 2 indicates high p...

Page 346: ...P7D it means 7 days P1DT10H it means 1 days and 10 hours The parameter takes effect when autocleanup_ maxretentiontime_recording_enabled is enabled notify boolean 6 6 0 Disable recording notification...

Page 347: ...f the weekly schedule 00 00 24 00 indicates schedule always on prefix string 16 6 6 Indicate the prefix of the filename dest cf 0 4 6 6 The destination to store the recorded data cf means local storag...

Page 348: ...ort this parameter when the version number httpversion is equal or greater than 0314b 7 32 HTTPS Group https capability_protocol_https 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 To e...

Page 349: ...vivotek com 6 6 Common name in the certificate information validdays 0 825 6 6 Valid period for the certification 7 33 Storage Management Setting Group disk_i 0 n 1 n denotes the value of capability_...

Page 350: ...mended to use this boolean 6 6 Enable automatic clean up method Expired and not locked media files will be deleted For forward compatibility reservations but only group disk_i0_autocleanup is effectiv...

Page 351: ..._size WxH product dependent 1 6 ROI width and height The width value must be multiples of 16 and the height value must be multiples of 8 The minimal window size is 64x64 and then resolution_W resoluti...

Page 352: ...n by setparam cgi 7 35 1 ePTZ Settings for Each Stream Group eptz_c 0 n 1 _s 0 m 1 for n channel product and m is the index of video stream capability_eptz 0 PARAMETER VALUE SECURITY get set DESCRIPTI...

Page 353: ...disable the window win_i0_home W H product dependent 4 4 Left top corner coordinate of the window If the minimal window size is 192x144 then the win_i0_home 0 resolution_W 192 0 resolution_H 144 reso...

Page 354: ...mum number of connected seamless streaming We replace this parameter with seamlessrecording_c 0 n 1 _maxconnecti on when the version number httpversion is equal or greater than 0312a We do not support...

Page 355: ...is equal or greater than 0400a guid 0 2 _number 0 3 1 7 Number of connected seamless streaming with guid 0 k 1 _id Read only We replace this parameter with seamlessrecording_c 0 n 1 _guid 0 2 _n umbe...

Page 356: ...dicate whether seamless recording is recording to local storage or not at present Read only We support this parameter when the version number httpversion is equal or greater than 0312a guid 0 k 1 _id...

Page 357: ...e for uploading VADP modules module_number 0 positive integer 6 7 Record the total module number that already stored in the system module_order string 40 6 6 The execution order of the enabled modules...

Page 358: ...p_npackage NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Indicate if the module is enabled or not If yes also add the index of this module to the module_order name string 40 6 6 Module na...

Page 359: ...s the value of capability_vadp_npackage Only available when capability_vadp_npackage 0 and the version number of vadp_version 1 3 2 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable...

Page 360: ...focusspeed 5 5 1 4 Auto focus speed patrolseq string 120 1 4 For external device The indexes of patrol points separated by patroldwelling string 160 1 4 For external device The dwelling time of each...

Page 361: ...SECURITY get set DESCRIPTION ccdtype string 16 6 7 Internal used read only motortype string 16 6 7 Internal used read only cameraid 0 255 1 4 Camera ID controlling external PTZ camera Note Please set...

Page 362: ...ands with UART tunnel only available when capability_camctrl_c0_rs485 2 preset_i 0 k 1 _name string 40 1 4 Name of the preset location preset_i 0 k 1 _zoom capability_ptz_ c 0 n 1 _min zoom capability...

Page 363: ...ean 1 4 Disable motion detection on PTZ operation defaulthome boolean 1 4 This field tells system to use default home position or not axisz capability_ptz_ c 0 n 1 _min zoom capability_ptz_ c 0 n 1 _m...

Page 364: ...RITY get set DESCRIPTION ccdtype string 16 6 7 Internal used read only motortype string 16 6 7 Internal used read only cameraid 1 255 1 4 Camera ID controlling external PTZ camera Note Please set your...

Page 365: ...ity_ptz_c 0 n 1 _minzoom capability_ptz_c 0 n 1 _maxzoom 1 4 Zoom position at each preset location preset_i 0 k 1 _focus capability_ptz_c 0 n 1 _minfocus capability_ptz_c 0 n 1 _maxfocus 1 4 Focus pos...

Page 366: ...on axisf capability_ptz_c 0 n 1 _minfocus capability_ptz_c 0 n 1 _maxfocus 1 4 Custom home focus position axisflip boolean 1 4 Custom home flip side returnhome boolean 1 4 Enable disable return home w...

Page 367: ...ection the preset tour goes forward preset tour goes in forward order backward preset tour goes in backward order random the presets of the tour will be recalled randomly Only available when capabilit...

Page 368: ...00 38 400 57600 115200 4 4 Set baud rate of COM port databit 5 6 7 8 4 4 Data bits in a character frame paritybit none odd even 4 4 For error checking stopbit 1 2 4 4 1 One stop bit is transmitted to...

Page 369: ...of capability_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 dom...

Page 370: ...7 RS485 mode 7 44 Lens Configuration Group lens for n channel products n denotes the value of capability_nvideoin capability_image_c 0 n 1 _lensconfiguration_support 1 NAME VALUE SECURITY get set DESC...

Page 371: ...coordinate radius 0 positive integer 1 7 The actual center radius 7 46 Fisheye Local Dewarp Setting Group fisheyedewarp_c 0 n 1 capability_fisheyelocaldewarp_c 0 n 1 0 n denotes the value of capabili...

Page 372: ...ge of ceiling floor mount is 0 359 Pan range of wall mount is 90 90 s 0 m 2 _region_r 0 i 1 _tilt 90 90 1 4 Tilt home angle of regional view for 4R mode i is the view index and range from 0 to 3 Tilt...

Page 373: ...The minimum height of tracking target sensitivity 0 2 1 4 Tracking sensitivity 0 Low 1 Medium 2 High 7 49 Wireless Group wireless capability_network_wireless 0 PARAMETER VALUE SECURITY get set DESCRIP...

Page 374: ...wireless_encrypt is wep keyselect 1 4 6 6 Default key number Only valid when wireless_encrypt is wep key1 password 26 6 6 WEP key1 for encryption Only valid when wireless_encrypt is wep key2 password...

Page 375: ...ty_media_streamprofiles_num capability_media_streamprofiles_support 1 PARAMETER VALUE SECURITY get set DESCRIPTION profilename string 1 6 Friendly name of the profile token string 1 7 An unique identi...

Page 376: ...e when capability_naudioin 0 audioconfiguration_so urce c 0 n 1 s0 n denotes the value of capability_naudioin 1 6 The audioconfiguration source for the profile Ex audioconfiguration_source c 0 n 1 s0...

Page 377: ...a_streamprofiles_support 1 n denotes the value of capability_nvideoin NAME VALUE SECURITY get set DESCRIPTION ipaddress ip address 4 4 Multicast metadata IP address port 1025 65535 4 4 Multicast metad...

Page 378: ...means inactive or normal state while 1 means active or triggered state Where trigger time is reset time after state change Ex do1 1 Setting digital output 1 to trigger state Ex do1 0 30 Setting digita...

Page 379: ...ttp myserver cgi bin dido getdi cgi di1 Response HTTP 1 0 200 OK r n Content Type text plain r n Content Length 7 r n r n di1 1 r n 8 3Query Status of the Digital Output capability_ndo 0 Note This req...

Page 380: ...T POST Syntax http servername cgi bin viewer video jpg channel value resolution value quality value streamid value If the request contains invalid parameters a full FOV snapshot will return PARAMETER...

Page 381: ...n binary JPEG image data 8 5Account Management Note This request requires Administrator privileges Method POST Syntax http servername cgi bin admin editaccount cgi method value username name userpass...

Page 382: ...d 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 invalid path it will ignore this parame...

Page 383: ...Firmware Note This request requires Administrator privileges Method POST Syntax http servername cgi bin admin upgrade cgi Post data fimage file name return return page r n r n multipart encoded form d...

Page 384: ...or videosize speedpan value speedtilt value speedzoom value speedapp value Set speeds return return page Example http myserver cgi bin camctrl eCamCtrl cgi channel 0 stream 0 move right http myserver...

Page 385: ...t w h is the scaled area size resolution is the base range of this coordinate system The example shows w h 864 488 which means to zoom in to ratio x2 2 based on 1920x1080 Pay attention to that x y w h...

Page 386: ...dow size The size of plug in ActiveX window in web page resolution window size The resolution of streaming stretch boolean 0 indicates that it usesresolution streaming size as the range of the coordin...

Page 387: ...ositions to recall return return page Redirect to the page return page after the parameter is assigned The return page should be the relative path according to the root of camera If you omit this para...

Page 388: ...http servername cgi bin admin ipfilter cgi type value http servername cgi bin admin ipfilter cgi method add v4 v6 ip ipaddress index val ue return return page http servername cgi bin admin ipfilter c...

Page 389: ...1972 00 00 00 GMT User must use GET and POST to establish two channels for downstream and upstream The x sessioncookie in GET and POST should be the same to be recognized as a pair for one session Th...

Page 390: ...to be recognized as a pair for one session The contents of upstream should be base64 encoded to be able to pass through the proxy server This channel will help perform real time event subscription and...

Page 391: ...eam Note This request requires Viewer access privileges Syntax For HTTP push server MJPEG http servername network_http_s 0 m 1 _accessname For RTSP MP4 the user needs to input theURL below into an RTS...

Page 392: ...decimal data is digits from 0 9 A F 8 16 Storage Managements capability_storage_dbenabled 0 Method GET and POST Note This request requires administrator privileges In the past time all the recorded fi...

Page 393: ...ue with single quotes Ex destPath mnt auto CF NCMF abc mp4 resolution text Optional Indicate the media file resolution Please embrace your input value with single quotes Ex resolution 800x600 isLocked...

Page 394: ...00 00 00 and 2008 01 01 23 59 59 http servername cgi bin admin lsctrl cgi cmd search triggerType motion OR di OR seq triggerTime 2008 01 01 00 00 00 TO 2008 01 01 23 59 59 Command queryStatus PARAMETE...

Page 395: ...arameter it will redirect to an empty page If the return page is invalid path it will ignore this parameter Return Code Description 200 The request is successfully executed 400 The request cannot be a...

Page 396: ...rmal Full FPS all the time adaptive Default send only I frame for MP4 and H 264 and send 1 FPS for MJPEG If DI or motion window are triggered the streaming is changed to send full FPS for 10 seconds N...

Page 397: ...gi bin admin remotefocus cgi channel value function value direct ion value position value steps value iris PARAMETER VALUE DESCRIPTION channel 0 capability_nvideoin 1 Channel of the video source funct...

Page 398: ...cus_zoom_motor_end or remote_focus_focus_motor_end replied from function getstatus steps 1 30 Motor s moving steps It works only if function zoom or function focus and direction forward and direction...

Page 399: ...tor Current position of focus motor remote_focus_zoom_enable Current function of zoom motor remote_focus_focus_enable Current function of focus motor remote_focus_iris_open The current status of iris...

Page 400: ...s moving direction It works only if function focus position motor_start motor_end Motor s position It works only if function focus and direction direct motor_start remote_focus_zoom_motor_start or re...

Page 401: ...n The current status of iris 0 irisenable 1 irisopen Current function of zoom focus motor return value as below 0 no service 1 zooming 2 focusing 3 auto focus 4 focus scan 5 positioning both zoom moto...

Page 402: ...r daylight saving time configuration file This CGI is not supported when the version number httpversion is equal or greater than 0314b please use system_tz as a replacement http servername cgi bin adm...

Page 403: ...gi bin admin update_lens cgi list_lens For choose selected lens configuration http servername cgi bin admin update_lens cgi choose_lens value You need to reboot manually after you choose another lens...

Page 404: ...od sdp stime value etime value length value loctime value file value tsmode value PARAMETER VALUE DEFAULT DESCRIPTION stime YYYYMMDD_HHMMSS MMM N A Start time etime YYYYMMDD_HHMMSS MMM N A End time le...

Page 405: ...020 VIVOTEK INC All Right Reserved 273 X V V X Play recordings for length seconds which ends at etime rtsp 10 10 1 2 mod sdp etime 20110312_040400 000 length 120 X X X V Play file file rtsp 10 10 1 2...

Page 406: ...privacy mask edit Edit 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 siz...

Page 407: ...nation x y based on resolution or videosize speedpan value speedtilt value speedzoom value speedapp value speedl ink value Set speeds return return page Example http myserver cgi bin camctrl camctrl c...

Page 408: ...view or further view with zs speed used for joystick control zs 0 8 SD8362 Set the speed of zooming 0 means stop vx integer excluding 0 The slope of movement vy vx used for joystick control vy integer...

Page 409: ...upport this function when the version number of the PTZ control module is equal or greater than 5 0 0 20 Syntax for query API http servername cgi bin camctrl camctrl cgi parameter parameter Example ht...

Page 410: ...ximum speed level of pan tilt moving Only available when capability_camctrl_c 0 n 1 _buildinpt 0 getmaxzspeedlv 0 positive integer Get the maximum speed level of zoom moving getmaxfspeedlv 0 positive...

Page 411: ...osition getmaxratio decimal Get the maximum ratio of optical zoom We support this parameter when the version number getversion is equal or greater than 5 0 0 14 getmaxdratio decimal Get the maximum ra...

Page 412: ...ist channel 0 capability_nvideoin 1 Channel of the video source delpos string 30 Delete preset location from preset list return return page Redirect to the page return page after the parameter is assi...

Page 413: ...nded 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 0 to 100 unit The SD car...

Page 414: ...es Administrator privileges Method GET POST Syntax http servername cgi bin admin getwirelessinfo cgi PARAMETER VALUE DESCRIPTION N A N A Get wireless information Camera will return following informati...

Page 415: ...eral Control capability_peripheral_c 0 n 1 _ devicecontrol 0 Note This request requires Administrator privileges Method GET POST Syntax for control API http servername cgi bin admin peripheral cgi cha...

Page 416: ...he time when spraying and wiper actions take place heater_status auto automatic control the heater component to keep the device in a workable environment trigger heater component is work in force heat...

Page 417: ...us 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 washer_dwelltime N A Get the current...

Page 418: ...ime only getstatus Information of optimized IR control status and return value as below optimizedir_c 0 n 1 _irmode Indicate the IR current mode available value is auto and manual mode optimizedir_c 0...

Page 419: ...nel 0 capability_nvideoin 1 Channel of the video source operation set settoall set set the strength of each IR LED separately settoall use fixed strength for all IR LED irmode auto manual Irmode needs...

Page 420: ...mizedir_c0_irmode manual Example http myserver cgi bin admin optimizedir cgi channel 0 operation set irmode auto strength 50 70 50 50 50 Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma...

Page 421: ...rnum N A Get the number of IR that camera supports Example http myserver cgi bin admin optimizedir cgi channel 0 operation get irmode Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no...

Page 422: ...bin admin thermalctrl cgi operation set action shuttercompensate Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n ERROR fail PARAMETER VALUE DESCRIPTION action shutterco...

Page 423: ...ecording Stop an ongoing recording play Play an audio clip stopplayback Stop to playback of an audio clip remove Delete a clip download Download a clip to the client Recording time is limited to 60 se...

Page 424: ...e we will use the default value PARAMETER VALUE DESCRIPTION operation Set Set formatting parameters and start formatting fstype fat32 ext4 fat32 High compatibility for PC but low stability for Data ex...

Page 425: ...locking mode Example Request of get formatting progress 0 100 http myserver cgi bin admin format_sdcard cgi operation get Response of success HTTP 1 1 200 OK r n Content Type text plain r n Content Le...

Page 426: ...e identifier for each profile x is within 0 capability_media_streamprofiles_num 1 port is the rtsp port Please refer to the streamprofile group for requesting the stream profile token value for each p...

Page 427: ...t information via HTTP PARAMETER VALUE DESCRIPTION pimssm 1 1 Enable the feature of Protocol Independent Multicast Source Specific Multicast This field is only required when using PIM SSM feature Only...

Page 428: ...ltipart form data HTTP headers with its name parameter or name uploadKeyFile will be describing the request body see examples below Required when operation manualmode address sftp server address or ho...

Page 429: ...low security level A keytype will be automatically selected if the parameter is not provided The selected order will be ed25519 rsa ecdsa until successful pairing an error message will return if all...

Page 430: ...7e1309282ed0f1a Accept Encoding gzip deflate Host 172 16 219 217 Content Length 6123 Connection Keep Alive Pragma no cache Cookie webptzmode continuous activatedmode digital g_mode 1 viewsizemode Auto...

Page 431: ...Pm9IM6OJPDy Netcu6YEl3ULa6XHkYldqezJDnUfCBHe3OKjhue2FTBRmM2 j9Zl DkUrO7lQz7X88T w5 rI2OnDIm3szOhzMCYPtHxf8ygMKXI DKp3OR2 cu6ayGhb DezpoSyTjL1fTFINQAymDtP5tbomfESjFDW1fmfD9h1FivqYEy7017djPWrq8mjH N6nAh...

Page 432: ...able when bit 1 of capability_protocol_ftp_server is 1 Syntax for control API http servername cgi bin admin sftpserver cgi operation value PARAMETER VALUE DESCRIPTION operation updatehostkey updatehos...

Page 433: ...This field is required If updatehostkey is not yet finished you will receive error message Example of get host key Request http servername cgi bin admin sftpserver cgi operation gethostkey Response o...

Page 434: ...Notices from HEVC Advance THIS PRODUCT IS SOLD WITH A LIMITED LICENSE AND IS AUTHORIZED TO BE USED ONLY IN CONNECTION WITH HEVC CONTENT THAT MEETS EACH OF THE THREE FOLLOWING QUALIFICATIONS 1 HEVC CON...

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

No comments

Brands by name

Popular brands

Load more brands