background image

 

 

VIVOTEK

 

18 - User's Manual

Browser

LAN

Shepherd

10. Please visit VIVOTEK’s website to Install the "Shepherd” software utility. The program 

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.   

Software Installation

11. 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. 

Summary of Contents for Vivotek IB9369

Page 1: ...User s Manual 2MP IP66 Day Night Smart Motion Detection Seamless Recording H 265 WDR Smart Stream III SD Card Life Expectancy 30M Smart IR Bullet Network Camera IB9369 Rev 1 0...

Page 2: ...System Homepage layout 51 System Logs 54 System Parameters 57 System Maintenance 58 Media Image 61 Media Video 75 Media Video 76 Media Audio 85 Media profiles 86 Network General settings 87 Network St...

Page 3: ...ion is the Human detection Based on a human silhouette database and the rapid responses via an artificial neural network technology the Smart engine instantly recognizes human appearances in a video s...

Page 4: ...res the product is used properly as intended The Network Camera is a network device and its use should be straightforward for those who have basic networking knowledge It is designed for various appli...

Page 5: ...essive cleaning could damage the surface 3 Check images for correct field of view pan tilt and zoom focus and adjust as necessary 4 Check and replace the Micro SD memory card as needed Stop edge recor...

Page 6: ...tions PTZ output relay etc and get and set internal parameter values The image and CGI requests are handled by the built in Web server To send URL commands in the address bar of your web browser pleas...

Page 7: ...ick Installation Guide Waterproof cable gland 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 ou...

Page 8: ...ket Many copper coated aluminum CCA and other non standard conductors cabling products are masqueraded as CAT5E or CAT6 cables Please avoid using these CCA products especially when cascading PoE camer...

Page 9: ...VIVOTEK User s Manual 9 Inner View LEDs Reset button MicroSD card slot...

Page 10: ...eather Fx Focal length w number T w Remote focus lens R w PoE repeater H w High Dynamic Range functionality M Manual focus lens NOTE IMPORTANT 1 2 3 4 6 5 8 7 10 LAN PoE 100 240V AC ON OFF 9 GE LAN GE...

Page 11: ...d S sensor The height information enables the horizontal and vertical keystone corrections of the field of view Measure the distance between camera lens and the ground Installation height Measured to...

Page 12: ...TEK 12 User s Manual 2 Remove the panel cover by loosening 2 T10 screws Install an SD card if onboard storage is preferred Below is the mounting hole positions Reset button T10 64 GB 10 I 1 4 0 0 2 Kg...

Page 13: ...e if applicable Pull a CAT5e Ethernet cable through the hole Secure the camera to wall or ceiling using the included screws 25mm Cable molding Layer Self fusing tape or electric tape 2cm 2cm 1 Stretch...

Page 14: ...l 5 5 6 4mm 5 Pass the cable through the rubber seal and cable gland components as shown below 6 Assemble and fasten the cable gland and then connect the Ethernet cable to the RJ45 socket Use a rubber...

Page 15: ...nurled washers 7 Connect a ground wire to the grounding position at the back of the camera Use an AWG 20 wire 7 Install the camera to wall or ceiling by fastening the included screws You can also rout...

Page 16: ...r s Manual PoE 8 Connect the Ethernet to a PoE power source It is always a good practice to form a drip loop when routing the cable A drip loop can ensure water dripping along the cable does not get i...

Page 17: ...VIVOTEK User s Manual 17 9 Remove the protective sheet in front of the lens...

Page 18: ...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 Software Installation 11 Install the Shepherd utility which helps you loc...

Page 19: ...o conditions 1 This device may not cause harmful interference and 2 this device must accept any interference received including interference that may cause undesired operation Pat 6 930 709 MAC 0002D1...

Page 20: ...iguration for security concerns 12 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 12 2 Enter a combination of alphabetic...

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

Page 22: ...K 22 User s Manual 13 Loosen but not completely remove the fasten ring on the mounting bracket 14 Loosen the anti tamper screw on the bracket and then rotate or tilt to adjust the camera shooting dire...

Page 23: ...VIVOTEK User s Manual 23 15 Tighten the screw and the fasten ring 10 0 0 3 Kgf cm 10 0 0 3 Kgf cm Do not loosen the other screws on the camera chassis...

Page 24: ...D LEDs are constantly on Status after a reset network disconnected The reset button is used to reset the system or restore the factory default settings Sometimes resetting the system can return the ca...

Page 25: ...ransmission of power and data via a sin gle Ethernet cable Follow the below illustration to connect the Network Camera to a PoE enabled switch via Ethernet cable PoE Switch When using a non PoE switch...

Page 26: ...e web console enter Configuration Applications Package management and click on Trend Micro IoT Security Turn on the protection to fend off cyber attacks In here you can let the camera automatically up...

Page 27: ...a should prompt as shown below 2 You should be able to see live video from your camera You may also install the 32 channel recording software from VIVOTEK s website in a deployment consisting of multi...

Page 28: ...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 29: ...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 30: ...ot administrator password for the camera you can restore the camera defaults by pressing the reset button for longer than 5 seconds 3 If DHCP is enabled in your network and the camera cannot be access...

Page 31: ...e Network Camera in the address field Press Enter 3 The live video will be displayed in your web browser 4 If it is the first time installing the VIVOTEK network camera an information bar will prompt...

Page 32: ...oving your browser cookies will solve this problem 2 If you encounter problems with displaying the configuration menus or UI items try disable the Compatibility View on IE8 or IE9 You may also press t...

Page 33: ...ed ActiveX controls select Enable or Prompt Click OK NOTE 1 By default your Network Camera is not password protected To prevent unauthorized access it is highly recommended to configure a password for...

Page 34: ...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 35: ...limited you will not be able to use a large video size Please set the video and audio streaming parameters as listed below For more information please refer to Stream settings on page 75 Video Mode M...

Page 36: ...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 password for...

Page 37: ...ultiple streams streams 1 and 2 simultaneously You can select any of them for live viewing For more information about multiple streams please refer to page 75 for detailed information Manual Trigger C...

Page 38: ...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 39: ...work Camera model and Network Camera configuration some buttons may not be available Snapshot Click this button to capture and save still images The captured images will be displayed in a pop up windo...

Page 40: ...tton after clicking the Mute button Talk Click this button to talk to people around the Network Camera Audio will project from the external speaker connected to the Network Camera Click this button ag...

Page 41: ...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 42: ...This protocol allows multicast enabled routers to forward network packets to all clients requesting streaming media This helps to reduce the network transmission load of the Network Camera while servi...

Page 43: ...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 44: ...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 45: ...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 46: ...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 47: ...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 48: ...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 49: ...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 50: ...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 51: ...homepage using the default settings Hide Powered by VIVOTEK If you check this item it will be removed from the homepage Logo graph Here you can change the logo at the top of your homepage Follow the s...

Page 52: ...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 53: ...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 54: ...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 55: ...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 56: ...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 57: ...VIVOTEK User s Manual 57 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 58: ...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 59: ...is 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 Retain the l...

Page 60: ...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 61: ...f timestamp and video title on image Select to display time stamp and video title on the top or at the bottom of the video stream Timestamp and video title font size Select the font size for the time...

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

Page 64: ...n is more beneficial when the spot of intrusions or an object of your interest is close to the lens and the IR lights For example if an intruder has a chance of getting near the range of 3 meters Smar...

Page 65: ...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 72 for how to do it You can a...

Page 66: ...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 67: ...pply to Day mode Night mode or Schedule mode Please manually enter a range of time if you choose the Schedule mode Then check Save to take effect Noise reduction Enable noise reduction Check to enable...

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

Page 69: ...automatically determines an optimal exposure level Flickerless Under some circumstances when there is a difference between the video capture frequency and local AC power frequency NTSC or PAL the mism...

Page 70: ...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 shorter shutter time to better capture moving objec...

Page 71: ...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 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: ...rawn 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 persons passi...

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: ...define the Region of Interest viewing region and the Output Frame Size size of the live view window Click Viewing Window to open the viewing region settings page On this page you can configure the Re...

Page 76: ...t 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 customized viewing regi...

Page 77: ...re a smaller frame size 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 tha...

Page 78: ...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 79: ...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 80: ...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 81: ...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 82: ...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 83: ...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 84: ...moother video quality If the power line frequency is set to 50Hz the frame rates are selectable at 1fps 2fps 3fps 5fps 8fps 10fps 15fps and up to 25fps If the power line frequency is set to 60Hz the f...

Page 85: ...ing message is displayed Internal microphone input Select the gain of the external audio input according to ambient conditions Adjust the gain from 0 to 100 Audio type Select audio codec and the sampl...

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: ...is listed in the following table Access name for Channel and stream This Network camera supports multiple streams simultaneously The access name is used to differentiate the streaming source If you w...

Page 97: ...to transmit the data by monitoring the Internet traffic volume By default the RTCP port for video is set to 5557 and the RTCP port for audio is set to 5559 The ports can be changed to values between 1...

Page 98: ...cordingly If the multicast RTP video ports are incorrectly assigned the following warning message will be displayed Multicast TTL 1 255 The multicast TTL Time To Live is the value that tells the route...

Page 99: ...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 100: ...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 101: ...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 102: ...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 103: ...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 104: ...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 105: ...mware disabled the FTP port for security concerns You can manually enable the FTP server service to enable the FTP function You can disable the FTP server function when it is not in use FTP port The F...

Page 106: ...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 107: ...e 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 Administrator Full c...

Page 108: ...trol You can modify the management 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...

Page 109: ...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 110: ...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 111: ...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 112: ...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 113: ...User s Manual 113 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 114: ...ual 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 115: ...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 116: ...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 117: ...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 118: ...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 119: ...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 server Checks the client cert...

Page 120: ...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 121: ...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 request contai...

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

Page 123: ...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 124: ...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 125: ...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 126: ...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 127: ...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 128: ...ADP triggers with an Event setting Click on the Set VADP Trigger button to open the VADP setup menu The triggering conditions available with 3rd party software modules known as VADP will be listed Use...

Page 129: ...after you set up a network storage NAS The media to back up can include snapshot images video or system logs depending on your event settings Configure CameraLink You can associate or link with anothe...

Page 130: ...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 131: ...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 132: ...dow as shown below If successful you will also receive a test txt file on the FTP server Click Save server to enable the settings Server type HTTP Select to send the media files to an HTTP server when...

Page 133: ...to use public private key authentication instead of a username and password to connect to the server This option requires that you have a private public SSH key pair and that the public key is in pla...

Page 134: ...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 135: ...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 136: ...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 137: ...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 138: ...ots from any of the video profiles Send pre event images The Network Camera has a buffer area it temporarily holds data up to a certain limit Enter a number to decide how many images to capture before...

Page 139: ...ish to add more media options click Add media Media type Video clip Select to send video clips when a trigger is activated Media name Enter a name for the media setting Source Select the source of vid...

Page 140: ...is item the system will generate folders automatically by date The following is an example of a file destination with video clips Click 20200320 to open the directory Video Clip_59 mp4 Video Clip_58 m...

Page 141: ...e of the Event setting When completed the settings with steps 1 3 to arrange Schedule Trigger and Action of an event click Save event to enable the settings and click Close to exit the page The follow...

Page 142: ...k ON to turn it to OFF status or click Delete to remove a previously configured event setting To remove a server setting from the list select a server name and click Delete Note that you can only dele...

Page 143: ...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 144: ...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 145: ...irements Please contact our technical support or the vendor of your 3rd party module for the parameters contained within Users can also run VIVOTEK s VADP packages as a means to access updated functio...

Page 146: ...By then the module status will become OFF and the X button will appear at the end of the row Click on the X button to remove an existing module When prompted by a confirm message Click Yes to proceed...

Page 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 136 for details 20190210 20190211 20190212 f you want to enable recording notification please click Event to configure event triggering settings Please...

Page 153: ...tus 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 an SD...

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: ...hich 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...

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 2019 VIVOTEK INC All Right Reserved 29 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: ...tral 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 Santiago 140 GMT...

Page 169: ...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 Osaka Sappo...

Page 170: ...onds reset 0 positive integer 7 6 Restart the server after value seconds if value is non negative restoreexceptnet 0 positive integer 7 6 Restore the system parameters to default values except ipaddre...

Page 171: ...operating with others the system parameters will be restored to the default value except for a union of the combined results restoreexceptfocusvalu e 0 positive integer 7 6 Restore the system paramete...

Page 172: ...7 ODM specific model name of server eg DCS 5610 If it is not an ODM model this field will be equal to modelname serialnumber mac address 1 7 12 characters MAC address without hyphens firmwareversion...

Page 173: ...E SECURITY get set DESCRIPTION di_i 0 capability_ndi 1 product dependent boolean 1 7 0 Inactive normal 1 Active triggered capability_ndi 0 do_i 0 capability_ndo 1 product dependent boolean 1 7 0 Inact...

Page 174: ...ntsc pal 1 7 The actual modulation type Only available when capability_videoin_type is 0 or 1 7 3Digital Input Behavior Define Group di_i 0 n 1 for n is the value of capability_ndi capability_capabil...

Page 175: ..._ndo 0 privilege_camctrl view operator admin 1 6 Indicate which privileges and above can control PTZ capability_ptzenabled 0 or capability_eptz 0 user_i0_name string 64 6 7 User name of root user_i 1...

Page 176: ...It s recommended to set this parameter when change a service port to the port occupied by another service currently Otherwise the service may fail Stopped service will auto start after changing port s...

Page 177: ...ap eap tls 6 6 Selected EAP method identity_peap string 64 6 6 PEAP identity identity_tls string 64 6 6 TLS identity password string 200 7 6 Password for TLS privatekeypassword string 200 7 6 Password...

Page 178: ...pability_protocol_qos_dscp 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable disable DSCP video 0 63 6 6 Video channel for DSCP audio 0 63 6 6 Audio channel for DSCP capability_naudi...

Page 179: ...tion mode s 0 capability_nmed iastream 1 _accessn ame product dependent Not recommended to use this string 32 1 6 Http server push access name for stream N N 1 capability_nmediastream capability_proto...

Page 180: ...2 1 6 Http server push access name for channel N and stream M N 1 capability_nvideoin M 1 capability_nmediastream capability_protocol_spush_mjpeg 1 and capability_nmediastream 0 The value are shown as...

Page 181: ...ream capability_n videoin 1 _accessna me product dependent string 32 1 6 RTSP access name for channel stream N N 1 capability_nmediastream capability_protocol_spush_mjpeg 1 and capability_nmediastream...

Page 182: ...ddress 4 4 Multicast video IP address We support this parameter when the version number httpversion is equal or greater than 0304a audioipaddress product dependent ip address 4 4 Multicast audio IP ad...

Page 183: ...5 65535 6 6 Metadata channel port for RTP 7 6 12 PPPoE Subgroup of network pppoe capability_protocol_pppoe 0 NAME VALUE SECURITY get set DESCRIPTION user string 128 6 6 PPPoE account user name pass pa...

Page 184: ...t filtering admin_enable boolean 6 6 Enable administrator IP address admin_ip string 43 6 6 Administrator IP address maxconnection 1 capability_protoc ol_maxconnection 6 6 Maximum number of s type 0 1...

Page 185: ...at camera would try to balance the white balance effect of every sensor rbgain Use rgain and bgain to set white balance manually manual 2 cases a if rbgain is not supported this means keep current whi...

Page 186: ...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 flicker effect in indoor environment indoor Avoid rollin...

Page 187: ...positive integer 1 7 A 32 bit integer each bit can be set separately as follows Bit 0 Support camera control function 0 not support 1 support Bit 1 Built in or external camera 0 external 1 built in Bi...

Page 188: ...sted in capability_image_ c 0 n 1 _exposu re_maxrange 4 4 Maximum exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc This parameter may also restrict ima...

Page 189: ...VIVOTEK User s Manual 189 2019 VIVOTEK INC All Right Reserved 55 NAME VALUE SECURITY get set DESCRIPTION capability_image_c 0 n 1 _exposu re_mode 0...

Page 190: ...iumauto 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 balance the white balance eff...

Page 191: ...videoin_c 0 n 1 _whitebalance auto Normalized range bgain 0 100 4 4 Manual set bgain value of gain control setting 0 Weak 100 Strong Only available when rbgain is listed in capability_image_c 0 n 1 _...

Page 192: ...er Speed and keep adjusting Iris Gain automatically irispriority Manually adjust with variable Iris and keep adjusting Gain and Shutter speed automatically qualitypriority Automatically adjust the Iri...

Page 193: ...pport only available when capability_image_c 0 n 1 _sensor type is smartsensor Only available when capability_image_c 0 n 1 _iristype piris piris_position product dependent 1 100 1 4 Manual set P Iris...

Page 194: ...mum gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_mi ngain Only valid when piris_mode manual or irismode fixed Normalized range Only available when capability_image_c 0 n...

Page 195: ...in or external camera 0 external 1 built in Bit 2 Support pan operation 0 not support 1 support Bit 3 Support tilt operation 0 not support 1 support Bit 4 Support zoom operation 0 not support 1 suppo...

Page 196: ...ismode fixed Only available when capability_image_c 0 n 1 _exposu re_rangetype is twovalues maxexposure product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_imag...

Page 197: ...0s and camera takes 1 5s on the night then sensor only outputs 5 frame s Only available when capability_image_c 0 n 1 _exposu re_maxrange and capability_image_c 0 n 1 _exposu re_rangetype is onevalue...

Page 198: ...than 0302a bracketing_lev el 1 100 4 4 The total available lists capability_image_c 0 n 1 _ex posure_bracketing_range will be normalized to 1 100 scale For example the total available list is 7 2x 3x...

Page 199: ...ter than 0309a s 0 m 1 _h2 64_dintraperio d_enable boolean 4 4 Enable Dynamic intra frame period Only available when capability_videoin_c 0 n 1 _dintra period_support is 1 We support this parameter wh...

Page 200: ...l range 1 Worst quality 100 Best quality Only valid when h264_ratecontrolmode vbr and quant 100 s 0 m 1 _h2 64_maxvbrbitr ate 20000 capability_videoin _c 0 n 1 _h264_maxbit rate 4 4 The maximum allowe...

Page 201: ...he maximum frame rates of a H264 stream at different resolutions capability_videoin_c 0 n 1 _resolution are recorded in capability_videoin_c 0 n 1 _h264 _maxframerate s 0 m 1 _h2 64_profile 0 2 1 4 In...

Page 202: ...capability_videoin_codec s 0 m 1 _h2 65_quant 1 5 99 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 qpercent 99 Use the qualit...

Page 203: ...capability_videoin_codec Only valid when h265_ratecontrolmode vbr s 0 m 1 _h2 65_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 q...

Page 204: ...c 0 n 1 _resolution are recorded in capability_videoin_c 0 n 1 _h265 _maxframerate Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h2 65_profile Available values are listed in...

Page 205: ...hen capability_api_httpversio n format is XXXXX_2 ex 0301a_2 product dependent 4 4 Manual video quality level input The Q value which is used by encoded library directly Only valid when mjpeg_ratecont...

Page 206: ...peg_ratecontrolmode cbr and quant 100 s 0 m 1 _mj peg_bitrate 20000 capability_videoin _c 0 n 1 _mjpeg_maxbi trate 4 4 The target bit rate in constant bit rate mode Only valid when mjpeg_ratecontrolmo...

Page 207: ...ro_streng th product dependent 1 100 4 4 The strength of WDR Pro The bigger value means the stronger strength of WDR Pro Only available when capability_image_c 0 n 1 _wdrpro _strength is 1 wdrc_mode p...

Page 208: ...d is 1 aespeed_sensi tivity product dependent 1 100 4 4 The sensitivity of AE converge speed 1 20 level 1 21 40 level 2 41 60 level 3 61 80 level 4 81 100 level 5 Level 1 4 low high The higher sensiti...

Page 209: ...p_typeceilingmount and capability_videoin_c 0 n 1 _locald ewarp_typewallmount Only available when capability_fisheyelocaldewarp_c 0 capability_nvideoin 1 0 Group videoin_c 0 n 1 _s 0 m 1 _h264_smartst...

Page 210: ...vel is from 1 to 5 Level 5 is the maximum level of the quality difference between the ROI and non ROI areas Group videoin_c 0 n 1 _s 0 m 1 _h264_smartstream2_win_i 0 k 1 capability_smartstream_support...

Page 211: ...which the profile is applied to Not support policy day anymore when the version number httpversion is equal or greater than 0301a begintime hh mm 4 4 Begin time of schedule mode endtime hh mm 4 4 End...

Page 212: ...mode fixed Only available when capability_image_c 0 n 1 _exposu re_rangetype is twovalues shuttervalue product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image...

Page 213: ...o switch on off BLC exposurelevel 0 12 4 4 Exposure level 0 12 This range takes the concept from DC s exposure tuning options The definition is 0 EV 2 0 1 EV 1 7 2 EV 1 3 3 EV 1 0 4 EV 0 7 5 EV 0 3 6...

Page 214: ...ble when capability_image_c0_exposure_mod e 0 whitebalance product dependent auto panorama manual rbgain widerange outdoor indoor sodiumauto etc Available values are listed in capability_image_c 0 n 1...

Page 215: ...n is listed in capability_image_c 0 n 1 _wbmo de Only valid when videoin_c 0 n 1 _whitebalance auto Normalized range bgain 0 100 4 4 Manual set bgain value of gain control setting 0 Weak 100 Strong On...

Page 216: ...100 4 4 Gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_m axgain and capability_image_c 0 n 1 _exposu re_rangetype is onevalue Normalized range We support this parameter wh...

Page 217: ...ensor Only available when capability_image_c 0 n 1 _iristype piris piris_position product dependent 1 100 1 4 Manual set P Iris 1 Open 100 Close Only valid when piris_mode manual or capability_image_c...

Page 218: ..._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 dependent 1 100 4 4 The strength...

Page 219: ...t 1 100 4 4 The sensitivity of AE converge speed 1 20 level 1 21 40 level 2 41 60 level 3 61 80 level 4 81 100 level 5 Level 1 4 low high The higher sensitivity level meas that it is easy to be trigge...

Page 220: ...LUE SECURITY get set DESCRIPTION enable Not supported anymore boolean 4 4 Enable time shift streaming We replace this parameter with timeshift_c 0 n 1 _enable when the version number httpversion is eq...

Page 221: ...is equal or greater than 0312a sir product dependent Not recommended to use this boolean 6 6 Enable disable Smart IR Only available when capability_daynight_c 0 capability_ nvideoin 1 _smartir is 1 We...

Page 222: ...external IR led Only available when capability_daynight_illuminators_ext ernal_support 0 We replace this parameter with ircutcontrol_illuminators_external_d o_enabled when the version number httpvers...

Page 223: ...lity_daynight_c 0 n 1 _ircuts ensitivity_type normalize Only available when capability_daynight_c 0 n 1 _ircutsensitivity_type is not We replace this parameter with ircutcontrol_c 0 n 1 _sensitivity w...

Page 224: ...meter when the version number httpversion is equal or greater than 0312a sir product dependent boolean 6 6 Enable disable Smart IR Only available when capability_daynight_c 0 capability_ nvideoin 1 _s...

Page 225: ...ivity_type normalize Only available when capability_daynight_c 0 n 1 _ircutsensitivity_type is not We support this parameter when the version number httpversion is equal or greater than 0312a 7 10 2 I...

Page 226: ...minators_ext ernal_support 0 and do is listed in capability_daynight_illuminators_ext ernal_interface We support this parameter when the version number httpversion is equal or greater than 0312a exter...

Page 227: ...E VALUE SECURITY get set DESCRIPTION brightness Not recommended to use this 5 5 100 4 4 5 Darker 5 Bright 100 Use image_c n _brightnesspercent Only available when bit 0 of capability_image_c 0 n 1 _ba...

Page 228: ...than 0400a sharpness Not recommended to use this 3 3 100 4 4 3 Softer 3 Sharper 100 Use image_c 0 n 1 _sharpnesspercent Only available when bit 3 of capability_image_c 0 n 1 _basicse tting is 1 We rep...

Page 229: ...rve product dependent 0 100 4 4 0 Fine turned gamma curve by Vivotek 1 Gamma value 0 01 2 Gamma value 0 02 3 Gamma value 0 03 100 Gamma value 1 Note Although we set gamma value to 100 level but not al...

Page 230: ...vailable when capability_image_c 0 n 1 _defog_ mode is 1 defog_strength product dependent 1 100 4 4 Strength of defog Only available when capability_image_c 0 n 1 _defog_ mode is 1 eis_mode product de...

Page 231: ..._scenemode_ supporttype 4 4 Value of scene mode Only available when capability_image_c 0 n 1 _scene mode_support is 1 restoreatwb positive integer 4 4 Restore of adjusting white balance of image acco...

Page 232: ...1 yoffset 0 100 4 4 Adjusting the image to proper position vertically Only available when the bit 5 of capability_image_c 0 n 1 _basicset ting is 1 lens_alignment 0 100 4 4 Stitch the sensors togethe...

Page 233: ...schedule mode profile_i 0 m 1 _endtime hh mm 4 4 End time of schedule mode profile_i 0 m 1 _brightness Not recommended to use this 5 5 100 4 4 5 Darker 5 Bright 100 Use image_c 0 n 1 _brightnesspercen...

Page 234: ...icse tting is 1 We replace profile_i0_saturation with profile_i0_saturationpercent This parameter will not be used after the version number httpversion is equal or greater than 0400a profile_i 0 m 1 _...

Page 235: ...ge 0 Less saturation 100 More saturation Only available when bit 2 of capability_image_c 0 n 1 _basicse tting is 1 profile_i 0 m 1 _sharpnesspercent 0 100 4 4 Set sharpness in the normalized range 0 S...

Page 236: ...oise reduction 0 disable 1 enable Only available when capability_image_c 0 n 1 _dnr is 1 profile_i 0 m 1 _dnr_strength product dependent 1 100 4 4 Strength of 3DNR Only available when capability_image...

Page 237: ...y available when eis is listed in capability_image_c 0 n 1 _is_mod e profile_i 0 m 1 _dis_mode product dependent boolean 4 4 Digital image stabilizer 0 disable 1 enable Only available when dis is list...

Page 238: ...gh Light Compensation and to perform the masking of bright light area center Use Center window as metering area and give the necessary light compensation Group exposurewin_c 0 n 1 _win_i 0 k 1 n denot...

Page 239: ...ility_image_c 0 n 1 _exposu re_windomain sizepx 0 Wx0 H W 0 The current image width 1 H 0 The current image height 1 4 4 Width and height of the window Only available when px is listed in capability_i...

Page 240: ...ow as metering area and give the necessary light compensation Group exposurewin_c 0 n 1 _profile_i 0 m 1 _win_i 0 k 1 for m profile and n channel product n denotes the value of capability_nvideoin m d...

Page 241: ...Left top corner coordinate of the window Only available when px is listed in capability_image_c 0 n 1 _exposu re_windomain sizepx 0 Wx0 H W 0 The current image width 1 H 0 The current image height 1 4...

Page 242: ...is equal or greater than 0301a We replace source with input More details please refer the parameter description of input input intmic extmic product dependent 4 4 intmic Internal built in microphone O...

Page 243: ...n 1 _source linein Reserved for compatibility and suggest don t use this since the version number httpversion is equal or greater than 0301a We replace gain with volume_internal and volume_external M...

Page 244: ...Set AAC4 bitrate in bps Only available if AAC is supported s0_gamr_bitrate 4750 5150 5900 6700 7400 7950 10200 12200 4 4 AMR encoded bitrate in bps Only available if AMR is supported s0_g711_mode pcmu...

Page 245: ...tection alarm_level 1 100 4 4 Audio detection alarm level profile_i0_enable boolean 4 4 Enable disable this profile setting profile_i0_policy night schedule 4 4 The mode which the profile is applied t...

Page 246: ...6 Motion Detection Settings Group motion_c 0 n 1 for n channel products n denotes the value of capability_nvideoin NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable motion detection wi...

Page 247: ...x Not recommended to use this 0 W 0 H 0 W 0 H 0 W 0 H 0 W 0 H W 0 The current image width 1 H 0 The current image height 1 4 4 Coordinate of polygon window position 4 points x0 y0 x1 y1 x2 y2 x3 y3 On...

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

Page 249: ...1 m 1 policy night schedule 4 4 The mode which the profile is applied to Not support policy day anymore when the version number httpversion is equal or greater than 0301a begintime hh mm 4 4 Begin tim...

Page 250: ...e this 0 W 0 H 0 W 0 H 0 W 0 H 0 W 0 H W 0 The current image width 1 H 0 The current image height 1 4 4 Coordinate of polygon window position 4 points x0 y0 x1 y1 x2 y2 x3 y3 Only available when capab...

Page 251: ...omain It s recommended to use polygonsd This parameter will not be used after the version number httpversion is equal or greater than 0400a width Not recommended to use this 0 320 4 4 Width of motion...

Page 252: ...rewidth 0 positive integer 1 7 Indicate the width to offset to start to analysis the image dark_enable boolean 4 4 Enable or disable image too dark detection dark_threshold 0 100 4 4 Threshold of imag...

Page 253: ...DyndnsDynamic dyndns org dynamic DyndnsCustom dyndns org Safe100 safe100 net provider _hostnam e string 128 6 6 Your DDNS hostname provider _usernam eemail string 64 6 6 Your user name or email to lo...

Page 254: ...able the UPnP port forwarding service upnpnatstatus 0 3 6 7 The status of UPnP port forwarding used internally 0 OK 1 FAIL 2 no IGD router 3 no need for port forwarding 7 22 System Log Group syslog NA...

Page 255: ...secnamerw string 31 6 6 Read write security name secnamero string 31 6 6 Read only security name authpwrw string 8 128 7 6 Read write authentication password authpwro string 8 128 7 6 Read only authe...

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

Page 257: ..._wintype rectangle 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 priva...

Page 258: ...capability_image_c 0 n 1 _privacy 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 cha...

Page 259: ...1 _fliped boolean 4 4 Flip side of 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 03...

Page 260: ...decimal digit from 0 to 9 while 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 t...

Page 261: ...r of audio input channel 0 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 In...

Page 262: ...er than 0309a ptzenabled 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...

Page 263: ...tefocus Not recommended 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...

Page 264: ...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 265: ...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 266: ...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 267: ...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 to suppor...

Page 268: ...65 then this is mjpeg h264 h265 videoin_streamcod ec A list of Positive Integer 0 7 This equals capability_videoin_c0_streamcodec This is kept for compatibility videoin_flexiblebitr ate boolean 0 7 In...

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

Page 270: ...on number httpversion is equal or greater than 0301a We replace audio_mic with audio_intmic audio_intmic 0 Positive Integer 0 7 Internal Built in Microphone 0 Not support 1 Support Bit 0 for CH0 bit 1...

Page 271: ...o clip function We support this parameter when the version number httpversion is equal or greater than 0309a audioin_codec aac4 gamr g711 g726 product dependent 0 7 Available audio codec We take comma...

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

Page 273: ...mode Only available when capability_smartstream_support is 1 vadp_supportfeatu re positive integer 0 7 An 32 bit integer each bit can be set separately as follows Bit 0 VADP interface Bit 1 Capture vi...

Page 274: ...y cgi bin viewer camctrl cgi This is equivalent to capability_camctrl_c0_privilege This is kept for compatibility uart_httptunnel boolean 0 7 Indicate whether to support HTTP tunnel for UART transfer...

Page 275: ...reless_encrypt_ wpa2 boolean 0 7 Indicate whether to support wireless WPA2 wireless_apmode_ enable boolean 0 7 Indicate whether wireless AP mode is supported Only available when capability_network_wir...

Page 276: ...mber before event occurred media_snapshot_ maxpostevent positive integer 0 7 Maximum snapshot number after event occurred media_snapshot_ maxsize positive integer 0 7 Maximum size KB of a snapshot med...

Page 277: ...when capability_supportsd is 1 or capability_storage_dbenabled is 1 localstorage_seaml ess 0 positive integer 0 7 Indicate whether seamless recording is supported One bit represents one channel Ex 3 m...

Page 278: ...upports to record directly to an on board SD Card bit 1 Currently they are reserved bit and the default value is 0 Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 lo...

Page 279: ...dewarp Only available when capability_fisheye 0 shockalarm_suppo rt boolean 0 7 Indicate whether to support the shock detection We support this parameter when the version number httpversion is equal...

Page 280: ...out buildinpt boolean 0 7 An 32 bit integer each bit can be set separately as follows Bit 0 support build in pan Bit 1 support build in tilt zoommodule boolean 0 7 Indicate whether to support zoom le...

Page 281: ...e situation manual Turn off the automatically focus function For user to control the focus position manually as their purpose Only available when capability_camctrl_c 0 n 1 _zoommo dule is 1 We suppor...

Page 282: ..._buildin pt is 1 maxpanangle integer 0 7 The upper limit for pan angle Only available when bit0 of capability_camctrl_c 0 n 1 _buildin pt is 1 tiltspeedlv 0 positive integer 0 7 The maximum speed leve...

Page 283: ...xzoom 0 positive integer 0 7 The upper limit for zoom position Only available when the value of capability_camctrl_c 0 n 1 _zoomm odule is 1 maxdzoom 0 positive integer 0 7 The upper limit for digital...

Page 284: ...s parameter with capability_daynight_illuminators_builti n_type whiteled when the version number httpversion is equal or greater than 0312a externalir boolean 0 7 Indicate whether to support external...

Page 285: ...of ircutcontrol_sensitivity parameter is low normal high normalize the value of ircutcontrol_sensitivity parameter is 1 100 not support Only available when capability_daynight_c 0 n 1 _suppo rt is 1 W...

Page 286: ...luminators_exter nal_interface when the version number httpversion is equal or greater than 0312a spectrum_support boolean 0 7 Indicate whether to support proposed a brightness enhancement method base...

Page 287: ...ight ir The ideal default setting for IR light irenhanced This CCM model increases the brightness effect of IR light blueenhanced This CCM model increases the brightness effect of blue light Only avai...

Page 288: ...nput 1 is triggered di2 the camera automatically switches the current mode when a ditigal input 2 is triggered di3 the camera automatically switches the current mode when a ditigal input 3 is triggere...

Page 289: ...support this parameter when the version number httpversion is equal or greater than 0312a external_interface do do2 do3 do4 product dependent 0 7 The device interface of external led do digital output...

Page 290: ...ter when the version number httpversion is equal or greater than 0312a Group capability_storage_management PARAMETER VALUE SECURITY get set DESCRIPTION ndevice positive integer 0 7 Indicate the number...

Page 291: ...t zoom focus etc ics An i CS lens is an intelligent CS mount lens that contains information about among other things its own geometrical distortion and the exact position of its zoom focus and iris op...

Page 292: ...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 293: ...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 294: ...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 295: ...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 296: ...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 297: ...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 298: ...y 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 fps function We...

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

Page 300: ...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 301: ...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 302: ...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 303: ..._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 re...

Page 304: ...al 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 tuning strength of WDR Pro 1 Support tunin...

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

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

Page 307: ...l 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 parameter when...

Page 308: ...tlevel 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 parameter when the version numb...

Page 309: ...l 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_mod e is not We support this parameter wh...

Page 310: ...r 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 than 0302a exposure_mode 0 1 0 7...

Page 311: ...lue 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 _ exposure_mode is 1...

Page 312: ...me malfunction or be forced to a given value The affected functions are list here The format is Affect API name Policy Description Policy can be categorized into following groups disabled UI turns gre...

Page 313: ...elevel 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 malfunction or be forced to a given val...

Page 314: ...e version number httpversion is equal or greater than 0302a exposure_irispriority mode_affect exposurewin mode blc hidden defog disabled wdrpro disabled exposurelevel hidd en defaultgain fixed x or ot...

Page 315: ...is listed in capability_image_c 0 n 1 _ exposure_modetype and capability_image_c 0 n 1 _ exposure_mode is 1 We support this parameter when the version number httpversion is equal or greater than 0302...

Page 316: ...relevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL means no feature is affected Only available when qualitypriority is listed in c...

Page 317: ...otsupport the affected function is not available Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one wor...

Page 318: ...t 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 0 7 Indicate whether to su...

Page 319: ...exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL mean...

Page 320: ...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 Only available when capabilit...

Page 321: ...st 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_c n _minexposure 1 32000 1s...

Page 322: ...able 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_wintype rectangle polygon 3D...

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

Page 324: ...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 contrast hidden or others x no...

Page 325: ...ns 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 the support strength lev...

Page 326: ...erved 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 the image with pixels std A...

Page 327: ...e_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 number httpversion is equal or greater...

Page 328: ...color 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 o...

Page 329: ...custom script time string 4 20 6 6 Time of custom script 7 29 Event Setting Group event_i 0 n 1 n denotes the value of capability_nevent capability_nevent 0 PARAMETER VALUE SECURITY get set DESCRIPTI...

Page 330: ...etection virestore Video input signal restore vadp VADP trigger smartsd is only valid when smart SD card is inserted triggerstatus string 40 6 6 The status for event trigger di 0 positive integer 6 6...

Page 331: ...ect event from any one of source id 0 1 and 3 set vadp to 11 Only available when vadp is listed in capability_supporttriggertypes valevel 0 1 6 6 Select audio detection event 0 not select 1 select val...

Page 332: ...the digital output trigger in seconds Only available when capability_ndo 0 action_cf_enable Boolean 6 6 Enable or disable sending media to SD card Only available when capability_supportsd 0 action_cf...

Page 333: ...z goto preset position on event triggered Only available when capability_ptzenabled 0 action_goto_name product dependent string 40 6 6 Specify the preset name that ptz goto on event triggered Only ava...

Page 334: ...cond channel bit 2 tampering detection for third channel bit 3 tampering detection for fourth channel We support this parameter when the version number httpversion is equal or greater than 0311c 7 30...

Page 335: ...ssive mode email_address string 128 6 6 Email server address email_sslmode boolean 6 6 Enable support SSL email_port 0 65535 6 6 Port to connect to the server email_username string 64 6 6 Username to...

Page 336: ...oin 1 6 6 Indicate the source of media channel 0 means the first channel 1 means the second channel 2 means the third channel 3 means the fourth channel We support this parameter when the version numb...

Page 337: ...0 means the first channel 1 means the second channel 2 means the third channel 3 means the fourth channel We support this parameter when the version number httpversion is equal or greater than 0311c...

Page 338: ...38 User s Manual 2019 VIVOTEK INC All Right Reserved 204 PARAMETER VALUE SECURITY get set DESCRIPTION videoclip_maxsize 50 capability_media_videoclip_ maxsize 6 6 Maximum size of one video clip file i...

Page 339: ...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 340: ...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 341: ...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 342: ...TION enable boolean 6 6 To enable or disable secure HTTP policy Boolean 6 6 If the value is 1 it will force HTTP connection redirect to HTTPS connection method auto manual install 6 6 auto Create self...

Page 343: ...VALUE SECURITY get set DESCRIPTION cyclic_enabled boolean 6 6 Enable cyclic storage method cyclic_reserve 10 99 6 6 The reserved percentage of this disk We support this parameter when the version num...

Page 344: ...fective Not recommended to use this Please refers autocleanup group This parameter will not be used after the version number httpversion is equal or greater than 0400a autocleanup_maxage Not recommend...

Page 345: ...mal window size is 64x64 then the win_i0_home 0 resolution_W 64 0 resolution_H 64 which the resolution is the value in current stream If the stream doesn t support ePTZ the permissions of this paramet...

Page 346: ...om with videoin_c 0 n 1 _zoomratiodisplay smooth boolean 1 4 Enable the ePTZ move smoothly feature tiltspeed 5 5 1 4 Tilt speed Only available when capability_fisheye is 1 1 7 Tilt speed It should be...

Page 347: ...ER VALUE SECURITY get set DESCRIPTION patrolseq string 120 1 4 The patrol sequence of ePTZ All the patrol position indexes will be separated by patroldwelling string 160 1 4 The dwelling time unit sec...

Page 348: ...window 0 PARAMETER VALUE SECURITY get set DESCRIPTION win_i0_enable boolean 4 4 Enable or disable the window win_i0_home W H product dependent 4 4 Left top corner coordinate of the window If the minim...

Page 349: ...0312a maxconnection 3 1 7 Maximum 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 greate...

Page 350: ..._nvideoin capability_localstorage_seamless 0 PARAMETER VALUE SECURITY get set DESCRIPTION diskmode seamless manageable 1 6 seamless indicates enable seamless recording manageable indicates disable sea...

Page 351: ...ion Development Platform Setting Group vadp NAME VALUE SECURITY get set DESCRIPTION version string 6 7 Indicate the VADP version resource_total_memory 0 positive integer 6 7 Indicate total available m...

Page 352: ...AME VALUE SECURITY get set DESCRIPTION saved to SD card when user want to upload it If the value is false save module to the internal storage space and it will occupy storage size number string 128 6...

Page 353: ...The provider of the module vendorurl string 120 6 6 URL of the vendor version string 40 6 6 Version of the module license string 40 6 6 Indicate the license status of the module licmsg string 128 6 6...

Page 354: ...cation with this topic will be transferred to event manager as trigger n is equal to ntrigger above 7 40 Camera PTZ Control Group camctrl capability_camctrl_ptztunnel 0 NAME VALUE SECURITY get set DES...

Page 355: ...e dwelling time of each preset location only available when capability_camctrl_c0_rs485 2 uart 0 capability_nuar t 1 1 4 Select corresponding uart capability_nuart 0 only available when capability_cam...

Page 356: ...TZ camera Note Please set your speed dome to the appropriate baud rate and Camera ID e g 2400bps camera ID 1 2 3 etc All Camera IDs on the same controlling system NVR or rs485 keyboard have to be dist...

Page 357: ...4 Zoom position at each preset location preset_i 0 k 1 _focus capability_ptz_ c 0 n 1 _min focus capability_ptz_ c 0 n 1 _ma xfocus 1 4 Focus position at each preset location preset_i 0 k 1 _ dwelling...

Page 358: ...position axisf capability_ptz_ c 0 n 1 _min focus capability_ptz_ c 0 n 1 _ma xfocus 1 4 Custom home focus position digitalzoom boolean 1 4 Enable disable digital zoom zoomenhance boolean 1 4 Enable...

Page 359: ...our speed dome to the appropriate baud rate and Camera ID e g 2400bps camera ID 1 2 3 etc All Camera IDs on the same controlling system NVR or rs485 keyboard have to be distinct Therefore once you sen...

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

Page 361: ...1 4 While idle over this time interval idle action will be taken digitalzoom boolean 1 4 Enable disable digital zoom idleaction_enable boolean 1 4 Enable disable idle action while idle idleaction_type...

Page 362: ...order random the presets of the tour will be recalled randomly Only available when capability_presettourdirection is 1 We support this parameter when the version number httpversion is equal or greate...

Page 363: ...URITY get set DESCRIPTION baudrate 300 600 1200 2400 4800 9600 19200 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 Fo...

Page 364: ...n 1 n is uart port count capability_nuart 0 and the bit7 of capability_ptzenabled is 0 the bit4 of capability_ptzenabled is 1 NAME VALUE SECURITY get set DESCRIPTION cameraid 1 255 4 4 Camera ID contr...

Page 365: ...7 RS485 mode 7 45 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 366: ...r axis coordinate radius 0 positive integer 6 7 The actual center radius 7 47 Fisheye Local Dewarp Setting Group fisheyedewarp_c 0 n 1 capability_fisheyelocaldewarp_c 0 n 1 0 n denotes the value of ca...

Page 367: ...up pir capability_npir 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 1 1 Enable disable PIR 7 49 Auto Tracking Setting Group autotrack_c 0 n 1 capability_image_c 0 n 1 _autotrack_support 0...

Page 368: ...own regulations to the allowable channels 1 11 USA and Canada 1 13 Europe 10 11 Spain 10 13 France 1 14 Japan Only valid when wireless_wlmode is Adhoc encrypt none wep wpa wpa2 6 6 Encryption method...

Page 369: ...EP key4 for encryption Only valid when wireless_encrypt is wep algorithm AES TKIP 6 6 Algorithm Only valid when wireless_encrypt is wpa or wpa2 presharedkey password 64 6 6 WPA WPA2PSK mode pre shared...

Page 370: ...0 Inactive normal state 1 Active triggered state Example Drive the digital output 1 to triggered state and redirect to an empty page http myserver cgi bin dido setdo cgi do1 1 8 2Query Status of the...

Page 371: ...us of the Digital Output capability_ndo 0 Note This request requires Viewer privileges Method GET POST Syntax http servername cgi bin dido getdo cgi do0 do1 do2 do3 If no parameter is specified all th...

Page 372: ...capability_nvideoin 1 The channel number of the video source resolution Available options are list in capability_videoin_c 0 n 1 _resolution Besides available options is referred to capability_videoi...

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

Page 374: ...s request requires Administrator privileges Method POST Syntax http servername cgi bin admin upgrade cgi Post data fimage file name return return page r n r n multipart encoded form data Server will a...

Page 375: ...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 376: ...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 377: ...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 378: ...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 379: ...meter 8 10 IP Filtering for ONVIF Syntax product dependent 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 r...

Page 380: ...el cgi x sessioncookie string 22 content type application x vvtk tunnelled pragma no cache cache control no cache content length 32767 expires Sun 9 Jam 1972 00 00 00 GMT User must use GET and POST to...

Page 381: ...content type application x vvtk tunnelled pragma no cache cache control no cache content length 32767 expires Sun 9 Jam 1972 00 00 00 GMT User must use GET and POST to establish two channels for downs...

Page 382: ...the accessname of SDP You can get the SDP by HTTP GET When using scalable multicast Get SDP file which contains the multicast information via HTTP 8 14 Open the Network Stream Note This request requi...

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

Page 384: ...integer primary key Optional The integer primary key column will automatically be assigned a unique integer triggerType text Optional Indicate the event trigger type Please embrace your input value wi...

Page 385: ...of Jan 1st 2008to the end of Jan 1st 2008 limit positive integer Optional Limit the maximum number of returned search records offset positive integer Optional Specifies how many rows to skip at the be...

Page 386: ...ed or not Ex Update records whose key numbers are 1 and 5 to be locked status http servername cgi bin admin lsctrl cgi cmd update isLocked 1 label 1 label 5 Ex Update records whose key numbers are 2 a...

Page 387: ...milliseconds setting it to trigger state Note that when the virtual input is waiting for next state it cannot accept new requests return return page Redirect to the page return page after the paramete...

Page 388: ...ame network_rtsp_s m _accessname maxsft value tsmode value refti me value forcechk minsft value n is the channel index m is the timeshift stream index For details on timeshift stream please refer to t...

Page 389: ...10 reftime 12 30 forcechk N A N A Check if the requested stream enables timeshift feature and if minsft is achievable If false return 415 Unsupported Media Type minsft positive integer 0 How many sec...

Page 390: ...Reserved 256 8 19 RemoteFocus capability_image_c 0 n 1 _remotefocus 1 Note This request requires Administrator privileges Method GET POST Syntax http servername cgi bin admin remotefocus cgi function...

Page 391: ...f zoom motor remote_focus_focus_motor_max Maximum steps of focus motor remote_focus_zoom_motor_start Start point of zoom motor remote_focus_zoom_motor_end End point of zoom motor remote_focus_focus_mo...

Page 392: ...or_max is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from function getstatus steps 1 motor_max Motor s moving steps It works only if function zoom or function f...

Page 393: ...8 20 BackFocus capability_image_c 0 n 1 _remotefocus 4 Note This request requires Administrator privileges Method GET POST Syntax http servername cgi bin admin remotefocus cgi function value direction...

Page 394: ...of iris getstatus Information of motors return value as below remote_focus_focus_motor_max Maximum steps of focus motor remote_focus_focus_motor_start Start point of effective focal length remote_focu...

Page 395: ...d from function getstatus This parameter is for additional fine tune the value is from 1 to 30 iris N A Open iris or not It works only if function auto or function scan 8 21 Export Files Note This req...

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

Page 397: ...ername cgi bin admin update_lens cgi choose_lens value You need to reboot manually after you choose another lens configuration For choose selected lens configuration and reboot camera http servername...

Page 398: ...PARAMETER VALUE DEFAULT DESCRIPTION stime YYYYMMDD_HHMMSS MMM N A Start time etime YYYYMMDD_HHMMSS MMM N A End time length positive integer N A The length of media of interest The unit is second locti...

Page 399: ...VIVOTEK User s Manual 399 2019 VIVOTEK INC All Right Reserved 265 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 mod sdp filename mnt link0...

Page 400: ...olution value stretch value Click on image Move the center of image to the coordination x y based on resolution or videosize of 1O mode return return page Example http myserver cgi bin camctrl fdCamCt...

Page 401: ...er x coordinate clicked by user It will be the x coordinate of center after movement y integer y coordinate clicked by user It will be the y coordinate of center after movement videosize window size T...

Page 402: ...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 403: ...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 404: ...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 405: ...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 406: ...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 407: ...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 408: ...page PARAMETER VALUE DESCRIPTION addpos string 30 Add one preset location to the preset list channel 0 capability_nvideoin 1 Channel of the video source delpos string 30 Delete preset location from p...

Page 409: ...409 2019 VIVOTEK INC All Right Reserved 275 8 30 SmartSD capability_localstorage_smartsd 0 Note This request requires Administrator privileges Method GET POST Syntax http servername cgi bin admin smar...

Page 410: ...tten The range is from 0 to 100 unit The SD card is recommended to be replaced if the percentage reaches above 90 smartsd_spare_block_rate Usage rate of spare blocks It means the usage percentage of t...

Page 411: ...ALUE DESCRIPTION N A N A Apply the wireless settings and connect to AP 8 32 Get Wireless Information capability_network_wireless 0 Note This request requires Administrator privileges Method GET POST S...

Page 412: ...9 VIVOTEK INC All Right Reserved 278 8 33 Get Wireless Signal Strength capability_network_wireless 0 Note This request requires Administrator privileges Method GET POST Syntax http servername cgi bin...

Page 413: ...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 414: ...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 415: ...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 416: ...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 417: ...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 418: ...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 419: ...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 420: ...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 421: ...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 422: ...VIVOTEK 422 User s Manual 2019 VIVOTEK INC All Right Reserved 288 clipname string Name of the audio clip clipindex 0 1 Number of the audio clip End of document...

Page 423: ...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 424: ...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: