background image

 

 

VIVOTEK

 

User's Manual - 143  

Applications > Package management - a.k.a., VADP (VIVOTEK 

Application Development Platform) 

Users can store and execute VIVOTEK's or 3rd-party software modules onto the camera's 

flash memory or SD card. These software modules can apply in video analysis for intelligent 

video applications such as license plate recognition, object counting, or as an agent for edge 

recording, etc. 

• 

Once the software package is successfully uploaded, the module configuration (vadp.xml) 

information is displayed. When uploading a module, the camera will examine whether the 

module fits the predefined VADP requirements. Please contact our technical support or the 

vendor of your 3rd-party module for the parameters contained within.   

•  Users can also run VIVOTEK's VADP packages as a means to access updated functionality 

instead of replacing the entire firmware. 

• 

Note that for some cameras the flash is too small to hold VADP packages. These cameras 

will have its "Save to SD card" checkbox selected and grayed-out for all time. 

• 

The file system of SD card (FAT32) does not support soft (symbolic) link. It will return failure 

if your module tries to create soft links on SD card.

To utilize a software module, acquire the software package and click 

Browse

 and 

Upload

 

buttons. The screen message for a successful upload is shown below:  

Note that the IoT Security package is 

started from here. Click to enter the 

configuration page.  

Summary of Contents for FE9192-H

Page 1: ...User s Manual Fisheye Network Camera 12MP Recess mount 360 Surround View Smart Stream Pixel Calculator PoE FE9192 H Rev 1 0...

Page 2: ...Using RTSP Players 28 Using 3GPP compatible Mobile Devices 29 Using VIVOTEK Recording Software 30 Main Page 31 Client Settings 42 H 265 H 264 Protocol Options 42 H 265 H 264 Protocol Options 42 MP4 S...

Page 3: ...119 Event 119 Add server 124 Add media 131 Applications Motion detection 137 Applications Smart VCA 138 Applications Tampering detection 139 Applications Audio detection 140 Applications Shock detecti...

Page 4: ...mera is equipped with a removable IR cut filter and WDR Pro technology empowering the cameras to maintain optimal image quality around the clock and unparalleled visibility in high contrast lighting e...

Page 5: ...se who have basic networking knowledge It is designed for various applications including video sharing general security surveillance etc The Configuration chapter suggests ways to best utilize the Net...

Page 6: ...k 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 recording before removing the Micro SD memory card M...

Page 7: ...PORTANT 1 The camera is only to be connected to PoE networks without routing to outside plants 2 For PoE connection use only UL listed I T E with PoE output 1 La cam ra ne doit tre raccord e qu des r...

Page 8: ...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 9: ...store the factory settings and install again Reset Press and release the recessed reset button with a straightened paper clip Wait for the Network Camera to reboot Restore Press and hold the recessed...

Page 10: ...VIVOTEK 10 User s Manual Physical Description Inner View Dome cover Lens Microphone Spring retainer Ethernet 10 100 RJ45 Socket MicroSD SDHC SDXC Card Slot Reset Button Status LEDs Top alignment mark...

Page 11: ...heartbeat Steady Red Green LED off Network disconnected 3 Blinking Red every 0 15 sec Blinking Green every 1 sec Red LED on for 0 15 sec and Green LED on for 1 sec and off for another Upgrading firmwa...

Page 12: ...les Operation is subject to the following two conditions 1 this device may not cause harmful interference and 2 this device must accept any interference received including interference that may cause...

Page 13: ...et cable through the hole with PoE power Connect the Ethernet cable to the camera and install a MicroSD card if onboard storage is preferred 4 Flip the spring retainer arms to the rear side Be careful...

Page 14: ...l 5 The retainer arms will spring back to hold the camera in place The FE9192 H share the same mechanical design with the FD9182 Do not turn the lens module It is not necessary for a fisheye camera to...

Page 15: ...ignment mark Turn the cover clockwise to secure the cover 7 Install the Shepherd software utility from VIVOTEK s website The program will search for VIVOTEK Video Receivers Video Servers or Network Ca...

Page 16: ...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 8 1 Run the Sh...

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

Page 18: ...guration for security concerns 9 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 9 2 Enter the combination of alphabetic a...

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

Page 20: ...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 21: ...ng ports for the Network Camera on the router Secondary HTTP port 8080 RTSP port 554 RTP port for audio 5558 RTCP port for audio 5559 RTP port for video 5556 RTCP port for video 5557 If you have chang...

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

Page 23: ...oE When using a PoE enabled switch The Network Camera is PoE compliant allowing transmission of power and data via a single Ethernet cable Follow the below illustration to connect the Network Camera t...

Page 24: ...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 accessed run the IW2 or Shepherd utility to search the...

Page 25: ...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 26: ...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 27: ...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 28: ...554 please set the RTSP port to 554 For more information please refer to RTSP Streaming on page 89 For example 4 The live video will be displayed in your player For more information on how to configu...

Page 29: ...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 70 Video Mode M...

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

Page 31: ...noramic views and to manipulate the details within the following display modes are provided Host name Resize Buttons VIVOTEK logo Configuration Area Live View window Camera Control Panel 1O One Origin...

Page 32: ...iew Original View 180 Hemispheric Swipe to scroll horizontally 1P Single Panoramic Display mode With image correction algorithms in firmware the hemispheric image is transformed into a rectilinear str...

Page 33: ...e view in all directions 1R View Single Regional View Zoom in out all directional navigation control Zoom In Zoom Out 2P Dual Panoramic View Display mode Similar to 1P the 2P display mode provides sim...

Page 34: ...ere using identical methods as previously described in the 1R mode You can also change the locations of Regional views by dragging the FOV indicators on the Original circular view 1O3R Original Region...

Page 35: ...an or tilt O R When you select a regional view its relative position in the FOV will be indicated by a semi transparent color polygon on the the circular original view When you move your regional view...

Page 36: ...utomatically save your view section layout 1 2 3 4 5 6 7 8 1 2 3 4 5 6 7 8 O R R R R R R R R 4R Four Regional Display mode The view control and look and feel are identical to that as described in the...

Page 37: ...System Homepage Layout General settings Customized button to deselect the show manual trigger button checkbox Digital Output Click to turn the digital output device on or off PTZ Control Panel Pano C...

Page 38: ...user interface Language options are available in English Deutsch Espa ol Fran ais Italiano Portugu s and You can also change a language on the Configuration page please refer to page 44 Hide Button Yo...

Page 39: ...nd save still images The captured images will be displayed in a pop up window Right click the image and choose Save Picture As to save it in JPEG jpg or BMP bmp format Start MP4 Recording Click this b...

Page 40: ...Control Buttons Depending on the Network Camera model and Network Camera configuration some buttons may not be available Video 13 59 05 2012 07 04 Title and Time Time Video and Audio Control Buttons...

Page 41: ...MP4 Saving Options on page 43 for details Volume When the Mute function is not activated move the slider bar to adjust the volume on the local computer Mute Turn off the volume on the local computer...

Page 42: ...each unicast client connecting to the server takes up additional bandwidth and the Network Camera allows up to ten simultaneous accesses UDP multicast This protocol allows multicast enabled routers t...

Page 43: ...e name Select this option to append the date and time to the end of the file name Local streaming buffer time Due to possible occurrences of unsteady network transmission live streaming may lag and no...

Page 44: ...the configuration page The following is the interface of the main page Configuration List Firmware Version Navigation Area Each function on the configuration list will be explained in the following s...

Page 45: ...r the Network Camera such as the host name and system time It is composed of the following two columns System and System Time System Host name Enter a desired name for the Network Camera The name will...

Page 46: ...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 47: ...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 48: ...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 49: ...you to choose from The new layout will simultaneously appear in the Preview field Click Save to enable the settings Font Color Font Color of the Video Title Background Color of the Video Area Frame C...

Page 50: ...ct a color on 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 be displayed in...

Page 51: ...leted 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 that the user i...

Page 52: ...loud PTZ Deterrent FTP Camera 01 Camera 02 Camera 03 Camera 04 Camera 06 Camera 05 Camera 07 Camera 08 Camera 09 You can install the included VAST recording software which provides an Event Management...

Page 53: ...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 54: ...w Parameters page lists the entire system s parameters in an alphabetical order If you need technical assistance use a text editor program to copy and save the parameters listed on this page Send the...

Page 55: ...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 56: ...light Saving Time settings please refer to Import Export files below on this page Custom Language Select this option to retain the Custom Language settings VADP Retain the VADP modules 3rd party softw...

Page 57: ...sage and so on Tips If a firmware upgrade is accidentally disrupted say by a power outage you still have a last resort method to restore normal operation See the following for how to bring the camera...

Page 58: ...and video title font size Select the font size for the time stamp and title Video font ttf You can select a True Type font file for the display of textual messages on video Mount type There are 3 Mou...

Page 59: ...ht mode Select this checkbox to enable the Network Camera to automatically switch to Black White display during the night mode IR cut filter With a removable IR cut filter this Network Camera can auto...

Page 60: ...set to 07 00 and 18 00 Sensitivity Tune the responsiveness of the IR filter to lighting conditions as Low Normal or High When completed with the settings on this page click Save to enable the setting...

Page 61: ...just the white balance to the best color temperature 1 Set the White balance to Auto 2 Place a sheet of white paper or a color of a cool color temperature such as blue in front of the lens then allow...

Page 62: ...level or disable the function You can click Restore to recall the original settings without incorporating the changes When completed with the settings on this page click Save to enable the setting Yo...

Page 63: ...ere low light objects are posed against an extremely bright background You may want to exclude the bright sunlight shining through a building s corridor Full view Calculate the full range of view and...

Page 64: ...second For cameras that come with fixed iris lens setting the exposure time to longer than 1 120 second may introduce too much lights to the lens Users can use this option to observe whether the resul...

Page 65: ...nvironment Use the checkbox to enable the function and use the slide bar to select the strength of the WDR Pro functionality depending on the lighting condition at the installation site You can select...

Page 66: ...etting 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 enable the s...

Page 67: ...xt box will appear allowing you to enter a name for the mask 2 Use four mouse clicks to mark a square area which is recommended to be at least twice the size of the object height and width you want to...

Page 68: ...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 69: ...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 70: ...lect the Maximum frame rate The parameters of a fixed focal lens multiple streams Region of Interest Stream 1 2944 X 2944 768 x 768 Stream 2 2944 X 2944 768 x 768 Stream 3 2944 X 2944 768 x 768 To beg...

Page 71: ...computing efforts for dewarping the original round shape image need to occur on the camera itself This may be necessary for some 3rd party software applications For example instead of a 1O all around...

Page 72: ...0fps and 25fps If the power line frequency is set to 60Hz the frame rates are selectable at 1fps 2fps 3fps 5fps 8fps 10fps 15fps 20fps 25fps and 30fps You can also select Customize and manually enter...

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

Page 74: ...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 75: ...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 mode allows you to configure...

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

Page 77: ...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 78: ...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 79: ...er video quality If the power line frequency is set to 50Hz at the 5MP resolution the frame rates are selectable at 1fps 2fps 3fps 5fps 8fps 10fps and up to 25fps If the power line frequency is set to...

Page 80: ...g message is displayed Internal microphone input gain Select the gain of the internal audio input according to ambient conditions Adjust the gain from 0 least to 100 most Audio type Select audio codec...

Page 81: ...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 82: ...erver 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 Wizar...

Page 83: ...y 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 to co...

Page 84: ...Router does not support UPnP port forwarding Below are 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 UPn...

Page 85: ...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 86: ...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 87: ...ss format Please refer to HTTP streaming on page 88 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 Ma...

Page 88: ...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 89: ...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 90: ...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 91: ...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 92: ...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 93: ...register Safe100 net to access VIVOTEK s Network Cameras from the Internet Additionally we offer other DDNS providers such as Dyndns org Dynamic Dyndns org Custom Safe100 net and CustomSafe100 Note t...

Page 94: ...h services 1 In the DDNS column select CustomSafe100 from the drop down list 2 In the Register column fill in the Host name Email Key and Confirm Key then click Register After a host name has been suc...

Page 95: ...f the host name is valid it will display a message as shown below https vivotek test3454 2bthere net 2010 12 10 17 08 56 Express link Express Link is a free service provided by VIVOTEK server which al...

Page 96: ...he network video devices used in the network must be QoS enabled QoS models CoS the VLAN 802 1p model IEEE802 1p defines a QoS model at OSI Layer 2 Data Link Layer which is called CoS Class of Service...

Page 97: ...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 98: ...naged device A network node on a managed network For example routers switches bridges hubs computer hosts printers IP telephones network cameras web server and database Before configuring SNMP setting...

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

Page 100: ...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 101: ...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 102: ...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 103: ...PS for communication with the Network Camera a Certificate must be created first There are three ways to create and install a certificate Create self signed certificate 1 Select the first option 2 Che...

Page 104: ...to the encrypted connection 6 If your web session does not automatically change to an encrypted HTTPS session click Home to re turn to the main page Change the URL address from http to https in the a...

Page 105: ...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 106: ...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 107: ...User s Manual 107 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 108: ...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 109: ...een created and installed before you can click on the Save button for the configuration to take effect 12 To begin an encrypted HTTPS session click Home to return to the main page Change the URL ad dr...

Page 110: ...e some situations which allow clients access to the live video without a user name and password 1 The administrator does not set up a root password For more information about how to set up a root pass...

Page 111: ...e clients whose IP addresses are on the Access List below can access the Network Camera and the others cannot access On the contrary if you choose Deny Type those clients whose IP addresses are on the...

Page 112: ...Pv4 block 192 168 100 0 22 represents the 1024 IPv4 addresses from 192 168 100 0 to 192 168 103 255 Network This rule allows the user to assign a network address and corresponding subnet mask to the A...

Page 113: ...or 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 c...

Page 114: ...sing 802 1X via a switch the authenticator The client offers its identity and client certificate which is then forwarded by the switch to the RADIUS Server which uses an algorithm to authenticate the...

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

Page 116: ...e fisheye PTZ function allows users to move among regional views for close up viewing The PTZ view takes effect when the current field of view is not the round shape original view or the panoramic vie...

Page 117: ...tions and arrange them in a rotational tour through different positions 1 First select a video stream on which the PTZ settings will take place 1 1 1 1 Zoom In Zoom Out 2 3 5 6 7 8 9 1 4 2 Adjust the...

Page 118: ...s to the Patrol locations window 7 You may select some or all of the imported positions as the stop points during the tour 8 Select a preset position when you need to move to a specific place on scree...

Page 119: ...FTP server or e mail address as notifications Click on Help there is an illustration shown in the pop up window explaining that an event can be triggered by many sources such as motion detection or ex...

Page 120: ...ditions take effect 2 Trigger This is the cause or stimulus which defines what will trigger the event The trigger source can be config ured to use the Network Camera s built in motion detection mechan...

Page 121: ...Trigger This option allows user to enable event triggers manually by clicking the on off button on the homepage Please configure 1 3 events before using this function Audio detection A preset thresho...

Page 122: ...d Use the arrow buttons to select these triggers Users may implant these modules for different purposes such as triggering motion detection or applications related to video analysis etc Please refer t...

Page 123: ...unction will only apply after you set up the connection to network attched storage NAS For more information about how to set up network storage please refer to page 148 To configure an event with vide...

Page 124: ...d the media files via email when a trigger is activated Server name Enter a name for the server setting Sender email address Enter a valid email address as the sender address Recipient email address E...

Page 125: ...ore server options click Add 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...

Page 126: ...side settings Server address Enter the SFTP server address in either the domain name or IP address Server port By default the FTP server port is set to 22 It can also be assigned to another port numb...

Page 127: ...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 128: ...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 129: ...e URL of the HTTP server User name Enter the user name if necessary Password Enter the password if necessary To verify if the HTTP settings are correctly configured click Test The result will be shown...

Page 130: ...NAS server on page 148 for details Click Save server to enable the settings then click Close to exit the Add server page SD Test Click to test your SD card The system will display a message indicating...

Page 131: ...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 132: ...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 133: ...ecify the maximum file size allowed File name prefix Enter the text that will be appended to the front of the file name For example Click Save media to enable the settings then click Close to exit the...

Page 134: ...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 135: ...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 136: ...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 137: ...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 138: ...to Smart VCA s user documentation for more information Click on Configuration Applications Smart VCA The Smart VCA utility will be automatically started The Smart Motion detection and Smart VCA share...

Page 139: ...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 140: ...to configure Audio detection 1 Once the Audio detection window is opened the current sound input will be interactively indicated by a fluctuating yellow wave diagram 2 Use a mouse click to drag the Al...

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

Page 142: ...tage on the chart Click the Enable shock detector checkbox and click Save to complete the configuration Shock Level You should then go to Event settings to configure the shock detection as a triggerin...

Page 143: ...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 144: ...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 145: ...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 146: ...cording 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 1 Each Recording...

Page 147: ...edia Video Stream settings Please refer to page 70 for detailed instruction To enable recording notification please configure Event settings first Please refer to page 119 Time Bandwidth Bandwidth Act...

Page 148: ...access to the shared networked storage For example 1 2 4 Network storage path server name or IP address folder name User name and password for your server 3 1 2 3 4 Please follow steps 1 2 below to s...

Page 149: ...he reserved space can be used as a safe buffer especially when the cyclic recording function is enabled during the transaction stage when a storage space is full and the incoming streaming data is abo...

Page 150: ...ase refer to Event Event settings on page 119 for more details When completed select Enable this recording Click Save to enable the setting and click Close to exit this page When the system begins rec...

Page 151: ...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 152: ...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 153: ...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 154: ...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 155: ...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 156: ...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 157: ...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 158: ...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 159: ...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 160: ...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 161: ...61 2020 VIVOTEK INC All Right Reserved 31 http 192 168 0 123 cgi bin admin getparam cgi network_ipaddress Response HTTP 1 0 200 OK r n Content Type text html r n Context Length 33 r n r n network ipad...

Page 162: ...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 163: ...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 164: ...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 165: ...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 166: ...al America Central Time Mexico City Saskatchewan 200 GMT 05 00 Eastern Time New York Toronto 201 GMT 05 00 Bogota Lima Quito Indiana 180 GMT 04 30 Caracas 160 GMT 04 00 Atlantic Time Canada La Paz San...

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

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

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

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

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

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

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

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

Page 175: ...alled flag ca_time 0 positive integer 6 7 CA installed time Represented in EPOCH ca_size 0 positive integer 6 7 CA file size in bytes certificate_exist boolean 6 6 Certificate installed flag for TLS c...

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

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

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

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

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

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

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

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

Page 184: ...lance status b if rbgain is supported rgain and bgain are updated to the current values which is got from white balance module Then act as rbgain mode widerange Auto Tracing White balance 2000K to 100...

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

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

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

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

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

Page 190: ...to the current values which is got from white balance module Then act as rbgain mode widerange Auto Tracing White balance 2000K to 10000K outdoor auto white balance mode specifically for outdoor indo...

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

Page 192: ...0 n 1 _exposu re_mode 0 irismode fixed indoor outdoor product dependent 4 4 Control DC Iris mode outdoor Auto setting DC Iris to get best quality but easy to meet rolling or flicker effect in indoor e...

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

Page 194: ...malized range We support this parameter when the version number httpversion is equal or greater than 0302a color 0 1 4 4 0 monochrome 1 color Only available when capability_videoin_c 0 n 1 _color_ sup...

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

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

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

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

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

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

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

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

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

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

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

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

Page 207: ...n capability_image_c 0 n 1 _wdrpro _strength is 1 wdrc_mode product dependent boolean 4 4 Enable WDR enhanced Only available when capability_image_c 0 n 1 _wdrc_ mode is 1 wdrc_strength product depend...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Page 228: ...ing is 1 We replace brightness with brightnesspercent This parameter will not be used after the version number httpversion is equal or greater than 0400a contrast Not recommended to use this 5 5 100 4...

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

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

Page 231: ...ility_image_c 0 n 1 _defog_ mode is 1 eis_mode product dependent boolean 4 4 Electronic image stabilizer 0 disable 1 enable Only available when eis is listed in capability_image_c 0 n 1 _is_mod e eis_...

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

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

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

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

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

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

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

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

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

Page 241: ...available when capability_daynight_c 0 n 1 _sup port 0 home 0 320 0 240 4 4 Left top corner coordinate of the window Only available when qvga is listed in capability_image_c 0 n 1 _exposu re_windomai...

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

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

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

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

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

Page 247: ...ch Window Group motion_c 0 n 1 _win_i 0 k 1 n denotes the value of capability_nvideoin k denotes the value of capability_nmotion NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable motio...

Page 248: ...pversion is equal or greater than 0400a polygon Not recommended to use this 0 320 0 240 0 320 0 240 0 320 0 240 0 320 0 240 4 4 Coordinate of polygon window position 4 points x0 y0 x1 y1 x2 y2 x3 y3 O...

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

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

Page 251: ...is equal or greater than 0400a polygon Not recommended to use this 0 320 0 240 0 320 0 240 0 320 0 240 0 320 0 240 4 4 Coordinate of polygon window position 4 points x0 y0 x1 y1 x2 y2 x3 y3 Only avail...

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

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

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

Page 255: ...t set DESCRIPTION enableremotelog boolean 6 6 Enable remote log serverip IP address 6 6 Log server IP address serverport 514 1025 65535 6 6 Server port used for log level 0 7 6 6 Levels used to distin...

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

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

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

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

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

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

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

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

Page 264: ...0 positive integer 0 7 An 32 bit integer each bit can be set separately as follows Bit 0 Support camera control function 0 not support 1 support Bit 1 only available when bit0 is 1 Built in or externa...

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

Page 266: ...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 267: ...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 268: ...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 269: ...hether to support IPv6 protocol_pppoe boolean 0 7 Indicate whether to support PPPoE protocol_ieee8021 x boolean 0 7 Indicate whether to support IEEE802 1x protocol_qos_cos boolean 0 7 Indicate whether...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Page 296: ...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 297: ...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 298: ...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 299: ...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 300: ...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 301: ...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 302: ...er line frequency 50 60Hz can be set by user We support this parameter when the version number httpversion is equal or greater than 0308a smartfps_support boolean 0 7 Indicate whether to support Smart...

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

Page 304: ...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 305: ...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 306: ...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 307: ...in_codec maxfps_h265 A list of Positive Integer and 0 7 Maximum fps which the device can encoded with H 265 on resolutions in this video mode means not support One to one mapping to the resolution in...

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

Page 309: ...I turns grey and users can t select it unchanged UI keeps the status as before and user can t change it hidden UI is hidden fixed UI is fixed to one selection or value ranged UI is fixed to multiple s...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Page 342: ...e first stream 1 means the second stream and etc 2 means the third stream and etc 3 means the fourth stream and etc videoclip_prefix string 16 6 6 Indicate the prefix of the filename videoclip_preeven...

Page 343: ...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 344: ...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 345: ...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 346: ...ort this parameter when the version number httpversion is equal or greater than 0314b 7 32 HTTPS Group https capability_protocol_https 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 To e...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Page 380: ...d The return page should be the relative path according to the root of camera If you omit this parameter it will redirect to an empty page If the return page is invalid path it will ignore this parame...

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

Page 382: ...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 383: ...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 384: ...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 385: ...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 386: ...http servername cgi bin admin ipfilter cgi type value http servername cgi bin admin ipfilter cgi method add v4 v6 ip ipaddress index val ue return return page http servername cgi bin admin ipfilter c...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Page 404: ...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 405: ...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 406: ...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 407: ...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 408: ...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 409: ...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 410: ...ist channel 0 capability_nvideoin 1 Channel of the video source delpos string 30 Delete preset location from preset list return return page Redirect to the page return page after the parameter is assi...

Page 411: ...nded to be replaced if the percentage reaches above 90 smartsd_spare_block_rate Usage rate of spare blocks It means the usage percentage of total spare block The range is from 0 to 100 unit The SD car...

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

Page 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: ...e we will use the default value PARAMETER VALUE DESCRIPTION operation Set Set formatting parameters and start formatting fstype fat32 ext4 fat32 High compatibility for PC but low stability for Data ex...

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

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

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

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

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

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

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

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

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

Page 432: ...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 433: ...nd if not installed and used in accordance with the installation manual may cause harmful interference to radio communications Operation of this equipment in a residential area is likely to cause harm...

Reviews: