manualshive.com logo in svg

Vivotek 4710469351747, User Manual

Share
Download
Vivotek 4710469351747 User Manual Download Page 9

 

 

VIVOTEK

 

User's Manual - 9  

Physical Description  

Inner View

Reset button

Lens

Cabling hole

for DI/DO/audio

combo cable

SD card slot

Built-in Microphone

Lens

Contact pins for IR & 

microphone

Cabling hole

for Ethernet

Ethernet RJ45 

socket

Embedded IR LEDs

LEDs

Outer View

Connector for DI/DO 

combo

Connector for DI/DO 

combo

Summary of Contents for 4710469351747

Page 1: ...User s Manual FE9382 EHV v2 Fisheye Network Camera 6MP Vandal proof 360º Surround View Smart IR 20m Smart Stream III Pixel Calculator PoE IP66 IK10 WDR Pro Rev 1 0 ...

Page 2: ...proof IP66 rated housing ensuring that the camera can withstand shock vibration humidity dust and temperature fluctuations and maintain stable and reliable video capture during vehicle movement 4 Depending on scene being monitored 4 Revision History 4 Read Before Use 5 Package Contents 5 Symbols and Statements in this Document 5 Physical Description 9 LED Definition 10 Hardware Installation 12 Sof...

Page 3: ...9 PTZ Settings 130 Event Event settings 132 Event 132 Add server 138 Add media 145 Applications Motion detection 152 Applications Smart VCA 153 Applications DI and DO 154 Applications Tampering detection 155 Applications Audio detection 156 Applications Shock detection 158 Applications Package management a k a VADP VIVOTEK Application Development Platform 159 Recording Recording settings 162 Stora...

Page 4: ...h as airports shopping malls retail stores offices and more The camera is equipped with a removable IR cut filter and WDR Pro technology empower ing the cameras to maintain optimal image quality around the clock and unparalleled visibility in high contrast lighting environments Moreover the cameras are designed with full EN50155 compliance vandal proof IK10 rated and weather proof IP66 rated housi...

Page 5: ... including video sharing general security surveillance etc The Configuration chapter suggests ways to best utilize the Network Camera and ensure proper operations For creative and professional developers the URL Commands of the Network Camera section serves as a helpful reference to customizing existing homepages or integrating with the current web server Package Contents Symbols and Statements in...

Page 6: ...ck 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 Make sure that the Micro SD memory card is right side up and do not insert it with force otherwise it may be damaged When it is raining or the humidity is high insertion or ejection of the Micro SD me...

Page 7: ...ctions 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 please remember to disable the Cross Site Request Forgery CSRF protection in Configuration Security Miscellaneous For up to date documentation of URL commands please go to VIVOTEK s website register an ac...

Page 8: ...limitée LPS certifiée Le bloc d alimentation doit porter les indications d homologation UL et LPS Il doit également répondre aux exigences en matière de sécurité et de conformité relatives au pays d utilisation Hardware Reset The reset button is used to reset the system or restore the factory default settings Sometimes resetting the system can return the camera to normal operation If the system pr...

Page 9: ...eset button Lens Cabling hole for DI DO audio combo cable SD card slot Built in Microphone Lens Contact pins for IR microphone Cabling hole for Ethernet Ethernet RJ45 socket Embedded IR LEDs LEDs Outer View Connector for DI DO combo Connector for DI DO combo ...

Page 10: ...tbeat 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 firmware 4 Blinking Red every 0 15 sec blinking Green every 0 15 sec Restoring defaults LED Definition Mounting Positions Refer to the diagram on the right for the mounting hole positions and the dimensions of ...

Page 11: ...525 A 3 2 4 octagon box 4 5 6 Cantex 3 4 type FSE 2 Gang Outdoor Indoor electrical box Generic 3 4 conduit box enclosure 3 5 holes A A A A 2 2 2 2 3 3 4 4 5 5 6 6 6 6 The base plate provides mounting holes for a variety of electrical boxes Refer to below for their associated mount hole positions ...

Page 12: ...especially important for an installation consisting of many cameras Network Camera Model No XXXXXX MAC 0002D14BAD55 Pat 6 930 709 This device complies with part 15 of the FCC Rules Operation is subject to the 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 undesired operation Mad...

Page 13: ...card if onboard storage is preferred P N 621071200G 4 Use the alignment sticker to drill mounting holes or a cabling routing hole on a wall or ceiling Route an Ethernet cable through the wall or ceiling Hammer the included anchors into the mounting holes ...

Page 14: ...OTEK 14 User s Manual 5 Hold the camera with both hands and press the snap in tab to separate the base plate from the camera P N 621071200G A holes 6 Secure the base plate to wall using the included screws ...

Page 15: ...IVOTEK User s Manual 15 7 Remove the silicone seal from the routing hole 8 Remove the tip of the silicone seal by pulling it off Insert the RJ45 connector of your Ethernet cable into the penetration cap ...

Page 16: ...VIVOTEK 16 User s Manual 9 Push the penetration cap through the center of the silicone seal 10 Install the silicone seal to its original routing hole ...

Page 17: ...y need to adjust its position 11 Connect the Ethernet connector and secure the top of the silicone seal to the routing hole You may need to adjust its position 12 Pull the cable slightly backward Please do not leave the edge of center hole folded toward the inside of the camera Doing so will compromise its waterproof feature ...

Page 18: ...combo cable for the FE9382 pass the white pin headers through the cabling hole Using a crescent wrench tighten a hex nut and washer to waterproof the combo cable Connect these headers to the connectors on camera 14 Replace the desiccant bag on the camera ...

Page 19: ... 19 15 Secure the camera to the base plate by aligning the snap in tabs Press until the snap in tabs are firmly in place 16 Install the dome cover by aligning the side routing tab with the cabling cut out on the base plate ...

Page 20: ...VIVOTEK 20 User s Manual 17 Secure the dome cover by fastening the T10 anti tamper screws 18 Remove the protective sheet from the dome cover ...

Page 21: ...meras on the same LAN Double click on the camera s MAC address to open a web console with the camera Software Installation 20 Install the Shepherd utility which helps you locate and configure your Network Camera in the local network If your camera comes without the CD go to VIVOTEK s website and locate the utility in the Downloads Software page Shepherd Browser LAN IEEE 802 3af ...

Page 22: ...owing two conditions 1 This device may not cause harmful interference and 2 this device must accept any interference received including interference that may cause undesired operation Pat 6 930 709 MAC 0002D1730202 Ro HS 20 3 The program will search for all VIVOTEK network devices on the same LAN 20 4 After a brief search the installer window will prompt Click on the MAC and model name that matche...

Page 23: ...iguration for security concerns 21 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 21 2 Enter the combination of alphabetic and numeric characters to fulfill the password strength requirement The default name for the camera administrator is root and can not be changed ...

Page 24: ...pecial ASCII characters are supported _ and You can use them in the password combination 21 3 Another prompt will request for the password you just configured Enter the password and then you can start configure your camera and see the live view ...

Page 25: ...he 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 update the virus codes or manually update the virus codes ...

Page 26: ...ces the above diagram can be taken in consideration The diagram uses a relay to control the ON OFF condition of the AC device 3 An external relay can be triggered by using DO or by an external power source depending on the type of relay you use 4 In case of using an individual relay instead of using a relay module for protection against voltage or current spikes a transient voltage suppression dio...

Page 27: ...VIVOTEK User s Manual 27 DI DO DI DO Switch ExternalDevice Dry contact and using camera s DO to supply a relay NC NO Relay AC ExternalAC power with Protected Earth PE PE ...

Page 28: ...ing 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 changed the port numbers on the Network page please open the ports accordingly on your router For information on how to forward ports on the router please refer to your router s user s manual 3 Find out t...

Page 29: ...0 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 Network configuration page please open the ports ac cordingly on your router For example you can open a management session with your router to configure access through the router to the camera withi...

Page 30: ...PoE 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 to a PoE enabled switch via an Ethernet cable When using a non PoE switch If your switch router does not support PoE use a PoE power injector optional to connect between the Network Camera and a non P...

Page 31: ...forget the root administrator password for the camera you can restore the camera defaults by pressing the reset button for longer than 5 seconds 3 If DHCP is enabled in your network and the camera cannot be accessed run the IW2 utility to search the network If the camera has been configured with fixed IP that does not comply with your local network you may see its default IP 169 254 x x If you sti...

Page 32: ...he 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 as shown below Follow the instructions to install the required plug in on your computer Currently the Network Camera utilizes 32 bit ActiveX plugin You CAN NOT open a management view session to the c...

Page 33: ...te and then launch your web browser The onscreen Java control can malfunction under the following situations A PC connects to different cameras that are using the same IP address or the same camera running different firmware versions Removing your browser cookies will solve this problem In the event of plug in compatibility issues you may try to uninstall the plug in that was previ ously installed...

Page 34: ...ned 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 your camera later For more information about how to enable password protection please refer to Security on page 114 2 If you see a dialogue box indicating that your security settings prohibit runnin...

Page 35: ...g on page 101 for details The RTSP players will show the original circular shape image You can access the Regional views via the VAST software See page 102 for an example 1 Launch the RTSP player 2 Choose File Open URL A URL dialog box will prompt 3 The address format is rtsp ip address rtsp port RTSP streaming access name for stream1 to stream4 rtsp 192 168 5 151 554 live1s1 sdp Video 16 38 01 20...

Page 36: ...2 As the the bandwidth on 3G networks is 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 81 Video Mode MPEG 4 Frame size 176 x 144 Maximum frame rate 5 fps Intra frame period 1S Video quality Constant bit rate 40kbps Audio type GSM AMR 12 2kbps 3 As most ISPs and ...

Page 37: ...moving 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 the F12 key to open the developer tools utility and then change the Browser Mode to the genuine IE8 or IE9 mode Tips In the event of plug in compatibility issues you may try to uninstall the plug in t...

Page 38: ...rol 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 password for the camera you can restore the camera defaults by pressing the reset button for longer than 5 seconds 3 If DHCP is enabled in your network and the camera cannot be accessed run the Shepher...

Page 39: ...panoramic 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 Original fisheye view 1P One Panoramic view 1R One Regional view 1P2R One Panoramic and two Regional views Wall mount 2P Two Panoramic views 1P3R One Panoramic and three Regional views Wall mount 1O3R One...

Page 40: ...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 stripe in the 1P display mode Viewers can use the PTZ panel or simply use mouse swipe to quickly move through the 360º panoramic view Mouse control on the Panoramic view is available with the Ceiling mou...

Page 41: ...he 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 simultaneous access to both the left and right sections of a hemisphere Both panoramic views are corrected into a more viewable dewarped image Viewers can use a mouse click and swipe to quickly scroll h...

Page 42: ...here 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 Regional Mode Screen Control Current screen selection Zoom In Zoom Out 1 2 3 Interactive regional FOV indicators Click to bring into center of view Pan or tilt O R R R Tips In a Regional view displaying 10...

Page 43: ...Pan 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 the color polygon moves accordingly ...

Page 44: ...automatically 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 1O3R mode except that the Original circular view is absent from this mode 4R PRO Four Regional Proactive Display mode The 4R PRO mode is similar to the 4R mode except that the quad view windows conse...

Page 45: ...e 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 Click this button to start the automatic horizontal pan 360 continuous rotation Stop Click this button to stop the Auto Pano and Auto Rotate functions Rotate Once the Administrator has configured the ...

Page 46: ...nterface 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 53 Hide Button You can click the hide button to hide the control panel or display the control panel Resize Buttons Click the Auto button the video cell will resize automatically to fit the monitor Click 100 is...

Page 47: ...and 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 button to record video clips in MP4 file format to your computer Press the Stop MP4 Recording button to end recording When you exit the web browser video recording stops accordingly To specify the sto...

Page 48: ...o 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 Video TPC AV H 264 MPEG 4 Protocol and Media Options Video Title Video 13 59 05 2012 07 04 Live Video Window The following window is displayed when the video mode is set to H 265 or H 264 Snapshot Cl...

Page 49: ...e slider bar to adjust the volume on the local computer Mute Turn off the volume on the local computer The button becomes the Audio On button after clicking the Mute button Talk Click this button to talk to people around the Network Camera Audio will project from the external speaker connected to the Network Camera Click this button again to end talking transmission Mic Volume When the Mute functi...

Page 50: ...r the same camera running different firmware versions Removing 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 the F12 key to open the developer tools utility and then change the Browser Mode to the genuine IE8 or IE9 mode Tips ...

Page 51: ...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 to forward network packets to all clients requesting streaming media This helps to reduce the network transmission load of the Network Camera while serving multiple clients at the same time Note that to utilize this...

Page 52: ...g buffer time Due to possible occurrences of unsteady network transmission live streaming may lag and not be very smoothly If you enable this option the live streaming will be stored on the client PC s cache memory for a few seconds before being played on the client computer s live view window This helps produce a smoothlier live streaming If you enter a vlue of 3 000 milliseconds the streaming wi...

Page 53: ...s 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 sections The Navigation Area provides access to all different views from the Home page for live viewing Configuration page and multi language selection ...

Page 54: ... The Network Camera s internal real time clock maintains the date and time even when the power of the system is turned off Synchronize with computer time Select this option to synchronize the date and time of the Network Camera with the local computer The read only date and time of the PC is displayed as updated Manual The administrator can enter the date and time manually Note that the date and t...

Page 55: ... 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 steps below to upload a new logo 1 Click Custom and the Browse field will appear 2 Select a logo from your files 3 Click Upload to replace the existing logo with a new one 4 Enter a website link if ne...

Page 56: ...r you to choose from The new layout will simultaneously appear in the Preview field Click Save to enable the settings Font Color of the Video Title Background Color of the Video Area Frame Color Font Color Background Color of the Control Area Font Color of the Configuration Area Background Color of the Configuration Area Preset patterns ...

Page 57: ...ect 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 the corresponding fields and in the Preview column 6 Click Save to enable the settings 1 2 3 4 Color Selector Custom Pattern ...

Page 58: ...pleted 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 install a log recording tool to receive system log messages from the Network Camera An example is Kiwi Syslog Daemon Visit http www kiwisyslog com kiwi syslog daemon overview System log This column di...

Page 59: ...Cloud 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 function group for delivering event messages via emails GSM short messages onscreen event panel or to trigger an alarm etc For more information refer to the VAST User Manual ...

Page 60: ...rators and administrators in a chronological order The access log is stored in the Network Camera s buffer and older events will be overwritten when the number of events reaches a limit VADP log VADP log contains the information for the onboard VADP packages including memory usage module load and unload information ...

Page 61: ...ew 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 parameter text file to VIVOTEK s technical support ...

Page 62: ...ill see Reboot system now This connection will close After that re access the Network Camera The following message is displayed when the upgrade has succeeded The following message is displayed when you have selected an incorrect firmware file General settings Reboot This feature allows you to reboot the Network Camera which takes about one minute to complete When completed the live video page wil...

Page 63: ... stored on the SD card and related settings If none of the options is selected all settings will be restored to factory default The following message is displayed during the restoring process Import Export files This feature allows you to Export Update daylight saving time rules custom language file and configuration file Export daylight saving time configuration file Click to set the start and en...

Page 64: ...ile In the example below DST begins each year at 2 00 a m on the second Sunday in March and ends at 2 00 a m on the first Sunday in November Update daylight saving time rules Click Browse and specify the XML file to update If incorrect date and time are assigned you will see the following warning message when uploading the file to the Network Camera ...

Page 65: ...rver staus report Click to export the current server status report such as time logs parameters process status memory status file system status network status kernel message and so on Tips If a firmware upgrade is 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 back to work Applicable scenari...

Page 66: ...mestamp 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 Mount types Ceiling Wall and Floor Ceiling The Ceiling mount type automatically delivers upside down images The Ceiling mode supports the following Display modes 1O 1P 1R 2P 1O3R 4R 4R PRO and 1O8...

Page 67: ...ght 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 automatically remove the filter to let Infrared light pass into the sensor during low light conditions Auto mode The Day Night Exposure Profile will not be available if Auto mode is selected The Network ...

Page 68: ...e 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 settings If you want to configure another sensor setting for a specific lighting condition in day night schedule mode please click Profile to open the Profile settings page as shown below Please follow the ...

Page 69: ...e camera detects low light condition and enters the night mode Turn on external illuminator in night mode Select Digital output to turn on an external IR illuminator if it is added to your application Anti overexposure When enabled the camera automatically adjusts the IR projection to adjacent objects in order to avoid over exposure in the night mode ...

Page 70: ... spot of intrusions or an object of your interest is close to the lens and the IR lights For example if an intruder has a chance of getting near the range of 3 meters Smart IR can effectively reduce the over exposure For a surveillance area at a greater distance e g 5 meters or farther away the Smart IR function may not bring as significant benefits as in close range Smart IR Auto IR adjust ...

Page 71: ...d the Smart IR s calculation of light level To solve this problem you can place an Exposure Exclude window on an unavoidable object in the Exposure setting window See page 75 for how to do it You can also configure the Exposure Exclude window in a night mode Profile setting so that your day time setting is not affected Exclude x ...

Page 72: ...o adjust their lighting intensity Observe the effects at night and tune for the best imaging results Use the One time adjust button to come up with a recommended coverage Camera firmware will automatically increase or decrease the lighting intensity of individual zones For example if one zone is close to a wall and the excessive lighting is reflected from the wall the intensity of that zone will b...

Page 73: ...djust 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 the Network Camera to automatically adjust the color temperature 3 Check the Fix current value to confirm the setting when the camera automatically measured and adjusted the white balance Manual This...

Page 74: ...h 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 You can also click on the Profile mode to adjust all settings above in a tabbed window for special lighting conditions at a specific period of time Enable to apply these settings at Select the mode thi...

Page 75: ...here 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 offer appropriate light compensation Custom This option allows you to manually add customized windows as inclusive or exclusive regions A total of 10 windows can be configured Please refer to the nex...

Page 76: ...Under some circumstances when there is a difference between the video capture frequency and local AC power frequency NTSC or PAL the mismatch causes color shifts or flickering images If the above mismatch occurs select the Flickerless checkbox and the range of Exposure time the shutter time will be limited to a range in order to match the AC power frequency When selected the exposure time will be ...

Page 77: ...lose 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 settings If you want to configure another sensor setting for a specific lighting condition for a specific period of time in a day please click Profile mode to open the Profile of exposure settings page as shown below En...

Page 78: ...ext 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 cover 3 Enter a Window Name and click Save to enable the setting 4 Check Enable privacy mask to enable this function Up to 5 privacy mask windows can be configured on the same screen To delete a mas...

Page 79: ...drawn the numbers of pixels on the sides of windows will appear This allows you to calculate if your current configuration fulfills a requirement for instance for recognizing the faces of persons passing through a location A facial recognition usually requires around 130 pixels per meter or higher Pixel Calculator 1 2 The pixels thus calculated are listed at the lower screen on a per stream basis ...

Page 80: ...f 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 camera 5 Details can be affected by weak lighting or the view angle Therefore higher the pixels higher the chance you can identify the subject 6 The pixel calculator visual tool looks like the following...

Page 81: ...ccording to the size of monitored device 3 Select the Maximum frame rate The parameters of a fixed focal lens multiple streams Region of Interest Stream 1 2048 X 2048 384 x 384 Stream 2 2048 X 2048 384 x 384 Stream 3 1024 X 1024 384 x 384 To begin the configuration first select a video channel To change the frame size frame rate and other related settings click on video settings for a video stream...

Page 82: ...e 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 view the client can be configured to receive a 1R Regional view Resolution Frame size You can set up different video resolutions for different viewing devices For example set a smaller frame size an...

Page 83: ...20fps 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 a value Intra frame period Determine how often to plant an I frame The shorter the duration the more likely you will get better video quality but at the cost of higher network bandwidth consumption S...

Page 84: ... 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 saved is also determined by the activities in the field of view If activities occur in the scene firmware automatically shortens the I frame insertion intervals in order to maintain image quality In th...

Page 85: ...mart 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 beneficial for keeping up with the frame rate requirements A default frame difference threshold 1 is embedded in firmware for returning from Smart FPS to normal encoding when motions occur Smart FPS In a sta...

Page 86: ...e 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 3 ROI windows Region of Interest with Foreground quality on the screen Areas not included in any ROI windows will be considered as the non interested areas The details in the ROI areas will be trans...

Page 87: ...he 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 threshold to contain the bandwidth consumption for both the high and low quality video sections in a smart stream Quality priority Use the slide bar to tune the quality contrast between the ROI and non...

Page 88: ...frame rate per second performance while the image quality will be compromised If Image quality priority is selected the Network Camera may drop some video frames in order to maintain image quality Smart Q Select ON or OFF to enable or disable the feature Smart Q is scene aware The Smart Q reduces frame size and bit rate consumption through the following Dynamically adjusting the image quality for ...

Page 89: ...width 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 enter a bit rate number by selecting the Customized option Fixed quality On the other hand if Fixed quality is selected all frames are transmitted with the same quality bandwidth utilization is therefore...

Page 90: ...her 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 60Hz the frame rates are selectable at 1fps 2fps 3fps 5fps 8fps 10fps and up to 30fps You can also select Customize and manually enter a value The frame rate will decrease if you select a higher res...

Page 91: ...internal audio input according to ambient conditions Adjust the gain from 0 least to 100 most External microphone input gain FE9382 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 as G 711 or G 726 and the bit rate G 711 provides good sound quality and requires about 64Kbps Select pcmu μ Law or pcma ...

Page 92: ...an audio clip if available Because the memory space is limited a recording count down will be available on screen You can also upload an audio file to the camera s flash memory With amplified speakers you can playback the audio e g to deter an intruder A maximum of 2 audio clips in the wav format are supported The maximum size of the audio file to be uploaded is 2 000Kbytes The voice alert is enab...

Page 93: ...am for each of the 3 default profiles Max view Recording and Live view The related video stream information will display including stream number resolution codec used frame rate etc The Multicast port number and address for video audio and Metadata configuration will also be listed ...

Page 94: ...server each time the camera is connected to the LAN Use fixed IP address Select this option to manually assign a static IP address to the Network Camera 1 You can make use of VIVOTEK Installation Wizard 2 on the software CD to easily set up the Network Camera on LAN Please refer to Software Installation on page 21 for details 2 Enter the Static IP Subnet mask Default router and Primary DNS provide...

Page 95: ...ly 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 configure your Network Camera to make it accessible from anywhere as long as there is an Internet connection Note that to utilize this feature it requires an account provided by your ISP Follow the ste...

Page 96: ... 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 UPnPTM components 1 Go to Start click Control Panel then click Add or Remove Programs 2 In the Add or Remove Programs dialog box click Add Remove Windows Components 3 In the Windows Components Wizard di...

Page 97: ...ces 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 public address in order to access the Network Camera from the Internet For example when the HTTP port is set to 80 and the secondary HTTP port is set to 8080 refer to the list below for the Network ...

Page 98: ... 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 the IPv6 information as shown below If your IPv6 settings are successful the IPv6 address list will be listed in the pop up window The IPv6 address will be displayed as follows Link global IPv6 address...

Page 99: ...ess format Please refer to HTTP streaming on page 100 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 Manually setup the IP address Select this option to manually set up IPv6 settings if your network environment does not have DHCPv6 server and router advertisements enabled routers If you check this it...

Page 100: ...d 65535 If the ports are incorrectly assigned the following warning messages will be displayed To access the Network Camera on the LAN both the HTTP port and secondary HTTP port can be used to access the Network Camera For example when the HTTP port is set to 80 and the secondary HTTP port is set to 8080 refer to the list below for the Network Camera s IP address Access name for Channel and stream...

Page 101: ...TANT Microsoft Internet Explorer does not support server push technology therefore using http ip address http port access name for stream 1 4 will fail to access the Network Camera Users can only use URL commands to request the stream 5 For more information about URL commands please refer to page 173 RTSP Streaming To utilize RTSP streaming authentication make sure that you have set a password for...

Page 102: ... 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 want to use an RTSP player to access the Network Camera you HAVE TO set the video mode to H 265 or 264 and use the following RTSP URL command to request transmission of the streaming data rtsp ip address rtsp port access name fo...

Page 103: ... 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 1025 and 65535 The RTP port must be an even number and the RTCP port is the RTP port number plus one and thus is always an odd number When the RTP port changes the RTCP port will change accordingly If...

Page 104: ...accordingly 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 router the range a packet can be forwarded Each hop decreases TTL by one Initial TTL Scope 0 Restricted to the same host 1 Restricted to the same subnetwork 15 Restricted to the same site 64 Restricted t...

Page 105: ...h people around the Network Camera Note that as JPEG only transmits a series of JPEG images to the client to enable the two way audio function make sure the video mode is set to H 264 on the Media Video Stream settings page and the media option is set to Media Video Stream settings on the Client Settings page Please refer to Client Settings on page 51 and Stream settings on page 81 Audio transmitt...

Page 106: ...u 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 that before utilizing this function please apply for a dynamic domain account first Safe100 net 1 In the DDNS column select Safe100 net from the drop down list Click I accept after reviewing the terms...

Page 107: ...ch 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 successfully created you will see a success message in the DDNS Registration Result column 3 Click Copy and all for the registered information will be uploaded to the corresponding fields in the DDNS co...

Page 108: ... If 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 allows users to register a domain name for a network device One URL can only be mapped to one MAC address This service will examine if the host name is valid and automatically open a port on your rout...

Page 109: ...The network video devices used in the network must be QoS enabled QoS models CoS the VLAN 802 1p model IEEE802 1p defines a QoS model at OSI Layer 2 Data Link Layer which is called CoS Class of Service It adds a 3 bit value to the VLAN MAC header which indicates the frame priority level from 0 lowest to 7 highest The priority is set up on the network switches which then use different queuing disci...

Page 110: ...rovides 64 different class IDs It gives an indication of how a given packet is to be forwarded known as the Per Hop Behavior PHB The PHB describes a particular service level in terms of bandwidth queueing theory and dropping discarding the packet decisions Routers at each network node classify packets according to their DSCP value and give them a particular forwarding treatment for example how muc...

Page 111: ...Managed 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 settings on the this page please enable your NMS first SNMP Configuration Enable SNMPv1 SNMPv2c Select this option and enter the names of Read Write community and Read Only community according to your NMS ...

Page 112: ...allows 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 port number between 1025 and 65535 SFTP This is the embedded SFTP server Host Key A host key is the SFTP server s public key Ensuring the SFTP server is validated is an important aspect of the SFTP pro...

Page 113: ...Discovery 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 domains The utility is previously called Bonjour Browser it is now distributed on the Mac App Store Discovery requires macOS 10 12 or higher For older versions of Mac OS you can download the old vers...

Page 114: ...lower case characters until the password strength is good enough 3 Select the privilege level for the new user account Click Add to enable the setting The privilege levels are listed below Administrator Full control Operator Control DO white light illuminator snapshot and PTZ unable to enter the camera Configuration page Viewer Control DO white light illuminator view listen PTZ and talk through th...

Page 115: ...iewers Select or de select the checkboxes and then click Save to enable the settings If you give Viewers the privilege Operators will also have the ability to control the Network Camera through the main page Allow anonymous viewing If you select this item any client can access the live stream without entering a User ID and Password ...

Page 116: ...TPS 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 Check Enable HTTPS secure connection then select a connection option HTTP HTTPS or HTTPS only 3 Click Create certificate to generate a certificate 4 The Certificate Information will automatically be dis...

Page 117: ...e 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 address bar and press Enter on your keyboard Some Security Alert dialogs will pop up Click OK or Yes to enable HTTPS https ...

Page 118: ...ate 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 prompt If you see the following Information bar click OK and click on the Information bar at the top of the page to allow pop ups ...

Page 119: ...opy 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 certificate should be delivered to you via an email or other means Copy the contents of the certificate in the email and paste it in a text HTML hex editor converter such as IDM Computer Solutions U...

Page 120: ... 120 User s Manual 7 Open a new edit paste the certificate contents and press ENTER at the end of the contents to add an empty line 8 Convert file format from DOS to UNIX Open File menu Conversions DOS to Unix ...

Page 121: ... 121 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 enable the certification ...

Page 122: ...been created and installed before you can click on the Save button for the configuration to take effect 12 To begin an encrypted HTTPS session click Home to return to the main page Change the URL ad dress from http to https in the address bar and press Enter on your keyboard Some Security Alert dialogs will pop up Click OK or Yes to enable HTTPS ...

Page 123: ...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 password and manage user accounts please refer to Security User account on page 114 2 The administrator has set up a root password but set RTSP Authentication to disable For more information about RTSP Au...

Page 124: ...se 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 Access List below will not be allowed to access the Network Camera and the others can access Then you can Add a rule to the following Access List Please note that the IPv6 access list column will no...

Page 125: ...IPv4 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 Allow Deny List The routing prefix is written in CIDR Classless Inter Domain Routing notation For example Range This rule allows the user to assign a range of IP addresses to the Allow Deny List Note ...

Page 126: ...tor 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 certificate and decides whether to accept the end user s access request VIVOTEK Network Cameras support two types of EAP methods to perform authentication EAP PEAP and EAP TLS Please follow the steps ...

Page 127: ...using 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 Network Camera and returns an acceptance or rejection back to the switch 3 The switch also forwards the RADIUS Server s certificate to the Network Camera 4 Assuming all certificates are validated the...

Page 128: ...us 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 request containing his own cookies etc Different ways can be used for a malicious website to transmit such commands They can be specially crafted image tags hidden forms and JavaScript XMLHttpRequests Th...

Page 129: ...sheye 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 view Users can then move the view in different directions or zoom in or zoom out on the screen P4 P3 P1 P5 P6 P7 P2 083236 4 Regional Views ...

Page 130: ... in the hemisphere covered by the fisheye lens A total of 20 preset positions can be configured Please follow the steps below to configure preset positions 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 ...

Page 131: ...s To add more positions you wish please repeat steps 1 3 5 Select the preset positions by their checkboxes 6 Click on the move button to move positions 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 screen Select a preferred Rotate speed or move the pres...

Page 132: ... 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 external digital input devices When an event is triggered you can specify what type of action that will be performed Event An event is an action initiated by a user defined trigger source In the Event ...

Page 133: ...o use the Network Camera s built in motion detection mechanism or external digital inputs There are several choices of trigger sources as shown below Select each item to display its related options Video motion detection This option makes use of the built in motion detection mechanism as a trigger source To enable this function you need to configure a Motion Detection Window first For more informa...

Page 134: ... 3 events before using this function Audio detection A preset threshold can be configured with an external microphone as the trigger to system event The triggering condition can be an input exceeding or falling below a threshold Audio detection can take place as a complement to motion detection or as a method to detect activities not covered by the camera s view Shock detection A shock acceleromet...

Page 135: ...er button to open the VADP setup menu The triggering conditions available with 3rd party software modules known as VADP will be listed Use the arrow buttons to select these triggers Users may implant these modules for different purposes such as triggering motion detection or applications related to video analysis etc Please refer to page 159 for the configuration options with VADP modules ...

Page 136: ...nected Select this option to backup media file on SD card if the network is disconnected Please note that this function 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 164 To configure an event with video recording or snapshots it is necessary to configure provide servers and storage media ...

Page 137: ...e loaded audio clip can be configured to be played when one triggering condition is met For example playing a warning message to deter an intruder You should have recorded or uploaded an audio file in the Configuration Media Audio Audio clips page ...

Page 138: ...nd 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 Enter a valid email address as the recipient address Server address Enter the domain name or IP address of the email server User name Enter the user name of the email account if necessary Password Ent...

Page 139: ...more 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 domain name or IP address of the FTP server Server port By default the FTP server port is set to 21 It can also be assigned to another port number between 1025 and 65535 User name Enter the login na...

Page 140: ...t 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 number between 1025 and 65535 Host key MD5 You have the option to use public private key authentication instead of a username and password to connect to the server This option requires that you have a pr...

Page 141: ...assword 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 The administrator of the SFTP server will need to manually add the corresponding public key to the SFTP server If key authentication is not preferred you can specify a username and password in the s...

Page 142: ...e 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 the SSH server the passphrase is only used to decrypt the private key on the local system The passphrase is not transmitted over the network When using SFTP you can authenticate using a public privat...

Page 143: ...he 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 in a pop up window as below If successful you will receive a test txt file on the HTTP server Click Save server to enable the settings and click Close to exit the Add server page ...

Page 144: ... NAS server on page 164 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 success or failure If you want to use your SD card for local storage please format it before use Please refer to page 167 for detailed information ...

Page 145: ...om which the snapshots will be taken 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 a trigger is activated Up to 7 images can be generated Send post event images Enter a number to decide how many images to capture after a trigger is activated Up to 7 images can be generated For ex...

Page 146: ...wish 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 video clip from the stream number Pre event recording The Network Camera has a buffer area it temporarily holds data up to a certain limit Enter a number to decide the duration of recording before a tri...

Page 147: ...pecify 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 Add media page Media type System log Select to send a system log when a trigger is activated Click Save media to enable the settings then click Close to exit the Add media page 1 sec 2 sec 3 sec 4 s...

Page 148: ...his 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 mp4 2020 03 20 2020 03 20 Click to delete selected items Click to delete all recorded data Click to go back to the previous level of the directory The format is HH 24r Click to open the file list for ...

Page 149: ...le 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 following is an example of the Event setting page ...

Page 150: ... a server setting from the list select a server name and click Delete Note that you can only delete a server when it is not involved in an Event setting To remove a media setting from the list select a media name and click Delete Note that you can only delete a media when it is not involved in an Event setting Audio clip This panel displays the audio clips you previously uploaded to the camera You...

Page 151: ... sample script xml file to the webpage which will save your time on configuring the settings Please note that there is a limited number of customized scripts you can upload if the current amount of customized scripts has reached the limit an alert message will prompt If you need more information please contact VIVOTEK s technical support ...

Page 152: ...votek 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 detection is applied make sure you measured the height of your camera at the installation site It is important for a correct video analysis You should enter the installation height in the Motion detection Se...

Page 153: ... more information http download vivotek com downloadfile solutions vadp smart vca manual_en pdf Click on Configuration Applications Smart VCA The Smart VCA utility will be automatically started The Smart Motion detection and Smart VCA share the same utility window If Smart VCA is applied make sure you measured the height of your camera at the installation site It is important for a correct video a...

Page 154: ...era to an external device to detect the current connection status Digital output Select Grounded or Open to define the normal status for the digital output Connect the digital output pin of the Network Camera to an external device to determine the current status Set up the event source as DI on Event Event settings Trigger Please refer to page 133 for detailed information ...

Page 155: ...or 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 conditions The Trigger threshold determines how sensitive your is tamper detection setting Lower the threshold number easier to trigger Too bright shining a flash light The average lighting level of t...

Page 156: ... 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 Alarm level tab to a preferred location on the slide bar 3 Select the Enable audio detection checkbox and click Save to enable the feature 1 Note that the volume numbers 0 100 on the side of wave diagr...

Page 157: ... Refer to page 91 for Audio settings and page 81 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 time and become very quiet in the night 1 Click on the Enable this profile checkbox Once the Audio detection window is opened the current sound input will be interactively indicated by a fluctuating...

Page 158: ...ntage 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 triggering source See page 132 for Event configuration The measurement range of the sensor is 16G For every one G force g 9 8 m s perceived the sensor acquires a reading of 512 The value acquired by a 2 G acc...

Page 159: ...uirements 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 fo...

Page 160: ... 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 Yes No Note that the actual memory consumed while operating the module will be indicated on the Memory status field This helps determine whether a running module has consumed too much of system resou...

Page 161: ...page 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 s website for the registration procedure ...

Page 162: ...ecording 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 setting records a video stream from one channel i e from a single lens module 2 Please remember to format your SD card when used for the first time Please refer to page 167 for detailed information N...

Page 163: ...Media Video Stream settings Please refer to page 81 for detailed instruction To enable recording notification please configure Event settings first Please refer to page 132 Time Bandwidth Bandwidth Activity Adaptive Streaming for Dynamic Frame Rate Control I frame Full frame rate I frame Continuous recording To enable adaptive recording please make sure you ve set up the triggering sources such as...

Page 164: ...e 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 set up the recording 1 Trigger Select a trigger source Schedule The server will start to record files on the local storage or network attached storage NAS Network fail Since network fail the server wi...

Page 165: ...The 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 about to overwrite the previously saved videos File name prefix Enter the text that will be appended to the front of the file name 2 Click Test to check the setting The result will be shown in the pop u...

Page 166: ...ase refer to Event Event settings on page 132 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 recording it will send the recorded files to the network storage or SD card The new recording name will appear on the recording page as shown below To remove an existing recording setting from the list s...

Page 167: ...atus 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 card from the camera The lifespan of an SD card is limited Regular replacement of the SD card can be necessary Camera filesystem takes up several megabytes of memory space The storage space cannot be...

Page 168: ... 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 NAS management NAS Setup Click NAS management tab to open the server setting window and follow the steps below to set up 1 Fill in the information for the access to the shared networked storage For e...

Page 169: ...er 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 Enable cyclic storage Allows previous recordings to be overwritten by new recordings Enable automatic disk cleanup Allows you to specify how long the recording files will be kept on the NAS storage Ma...

Page 170: ...ows 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 one or more items as your search criteria Trigger time Manually enter the time range you want to search for contents created at a specific point in time Click Search and the recorded data correspondin...

Page 171: ...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 as shown above Then click the Download button and a file download window will pop up for you to save the file JPEGs to AVI This functions only applies to JPEG format files such as snapshots You can se...

Page 172: ...rch 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 desired search results then click this button to delete the files Click to switch pages ...

Page 173: ...or the server denoted with servername in the URL syntax description below that is replaced with the string myserver in the URL syntax example further down in the page URL syntax is denoted with the word Syntax written in bold face followed by a box with the referenced syntax as shown below For example name of the server is written as servername and is intended to be replaced with the name of the a...

Page 174: ...quest 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 cgi bin directory The file extension cgi is required Syntax http servername cgi bin subdir subdir cgi ext parameter value parameter value Example Set digital output 1 to active http mywebserver cgi bi...

Page 175: ...xcept 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 viewer account can access all APIs with security level 0 and 1 An operator account can access all APIs with security level 0 1 or 4 An admin account can access all APIs except internal APIs Access managem...

Page 176: ...r 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 oftherelated group will be returned When querying parameter values the current parameter values are returned A successful control request returns parameter pairs as follows Return HTTP 1 0 200 OK r n Con...

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

Page 178: ...eter 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 Redirect to the page return page after the parameter is assigned The return page can be a full URL path or relative path according to the current path If you omit this parameter it will redirect to an empt...

Page 179: ... 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 200 OK r n Content Type text html r n Context Length 33 r n r n network ipaddress 192 168 0 123 r n ...

Page 180: ...com 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 a MAC address without hyphens or colons boolean A boolean value of 1 or 0 represents Yes or No True or False Enable or Disable value1 value2 value3 Enumeration Only given values are valid blank A bl...

Page 181: ...mera 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 Video Server Wireless Video Server ledoff boolean 6 6 Turn on 0 or turn off 1 all led indicators date YYYY MM DD keep auto 6 6 Current date of system Set to keep to keep date unchanged Set to auto t...

Page 182: ...ntral Time Mexico City Saskatchewan 200 GMT 05 00 Eastern Time New York Toronto 201 GMT 05 00 Bogota Lima Quito Indiana 180 GMT 04 30 Caracas 160 GMT 04 00 Atlantic Time Canada La Paz Santiago 140 GMT 03 30 Newfoundland 120 GMT 03 00 Brasilia Buenos Aires Georgetown Greenland 80 GMT 02 00 Mid Atlantic 40 GMT 01 00 Azores Cape_Verde_IS 0 GMT Casablanca Greenwich Mean Time Dublin Edinburgh Lisbon Lo...

Page 183: ... Astana Dhaka Sri Jayawardenepura 260 GMT 06 30 Rangoon 280 GMT 07 00 Bangkok Hanoi Jakarta Krasnoyarsk 320 GMT 08 00 Beijing Chongging Hong Kong Kuala Lumpur Singapore Taipei 360 GMT 09 00 Osaka Sapporo Tokyo Seoul Yakutsk 380 GMT 09 30 Adelaide Darwin 400 GMT 10 00 Brisbane Canberra Melbourne Sydney Guam Vladivostok 440 GMT 11 00 Magadan Solomon Is New Caledonia 480 GMT 12 00 Aucklan Wellington ...

Page 184: ...conds reset 0 positive integer 7 6 Restart the server after value seconds if value is non negative restoreexceptnet 0 positive integer 7 6 Restore the system parameters to default values except ipaddress subnet router dns1 dns2 pppoe This command can cooperate with other restoreexceptXYZ commands When cooperating with others the system parameters will be restored to the default value except for a ...

Page 185: ...ooperating with others the system parameters will be restored to the default value except for a union of the combined results restoreexceptfocusvalu e 0 positive integer 7 6 Restore the system parameters to default values except zoom and focus value This command can cooperate with other restoreexceptXYZ commands When cooperating with others the system parameters will be restored to the default val...

Page 186: ...7 ODM specific model name of server eg DCS 5610 If it is not an ODM model this field will be equal to modelname serialnumber mac address 1 7 12 characters MAC address without hyphens firmwareversion string 40 0 7 Firmware version including model company and version number in the format MODEL BRAND VERSION language_count positive integer 0 7 Number of webpage languages available on the server langu...

Page 187: ...E VALUE SECURITY get set DESCRIPTION di_i 0 capability_ndi 1 product dependent boolean 1 7 0 Inactive normal 1 Active triggered capability_ndi 0 do_i 0 capability_ndo 1 product dependent boolean 1 7 0 Inactive normal 1 Active triggered capability_ndo 0 onlinenum_rtsp 0 positive integer 6 7 Current number of RTSP connections onlinenum_httppush 0 positive integer 6 7 Current number of HTTP push serv...

Page 188: ...r 1 7 3Digital Input Behavior Define Group di_i 0 n 1 for n is the value of capability_ndi capability_capability_ndi 0 NAME VALUE SECURITY get set DESCRIPTION normalstate high low 1 1 Indicates open circuit or closed circuit inactive status 7 4Digital Output Behavior Define Group do_i 0 n 1 for n is the value of capability_ndo capability_ndo 0 NAME VALUE SECURITY get set DESCRIPTION normalstate op...

Page 189: ...6 User password user_i0_privilege view operator admin 6 7 Root privilege user_i 1 20 _ privilege view operator admin 6 6 User privilege 7 6Network Group network NAME VALUE SECURITY get set DESCRIPTION preprocess positive integer 6 6 An 32 bit integer each bit can be set separately as follows Bit 0 HTTP service Bit 1 HTTPS service Bit 2 FTP service Bit 3 Two way audio and RTSP Streaming service To ...

Page 190: ...ns2 from DHCP server at next reboot 0 Use preset ipaddress subnet rounter dns1 and dns2 ipaddress ip address 6 6 IP address of server subnet ip address 6 6 Subnet mask router ip address 6 6 Default gateway dns1 ip address 6 6 Primary DNS server dns2 ip address 6 6 Secondary DNS server wins1 ip address 6 6 Primary WINS server wins2 ip address 6 6 Secondary WINS server 7 6 1 802 1x Subgroup of netwo...

Page 191: ...ekey_exist boolean 6 6 Private key installed flag for TLS privatekey_time 0 positive integer 6 7 Private key installed time Represented in EPOCH privatekey_size 0 positive integer 6 7 Private key file size in bytes 7 6 2 QOS Subgroup of network qos_cos capability_protocol_qos_cos 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable disable CoS IEEE 802 1p vlanid 1 4095 6 6 VLAN ID v...

Page 192: ... VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable IPv6 addonipaddress ip address 6 6 IPv6 IP address addonprefixlen 0 128 6 6 IPv6 prefix length addonrouter ip address 6 6 IPv6 router address addondns ip address 6 6 IPv6 DNS address allowoptional boolean 6 6 Allow manually setup of IP address setting 7 6 4 FTP Subgroup of network ftp NAME VALUE SECURITY get set DESCRIPTION port 21 1025...

Page 193: ...m1 video1s2 mjpg c0_s1_accessname channel1stream2 video1s3 mjpg c0_s2_accessname channel1stream3 video1s4 mjpg c0_s3_accessname channel1stream4 etc We replace this parameter with network_http_c 0 capability_nvideoin 1 _s 0 capability_nmediastream 1 _ accessname when the version number httpversion is equal or greater than 0311c 7 6 6 HTTP per Channel Subgroup of network http_c 0 n 1 for n channel p...

Page 194: ... number httpversion is equal or greater than 0311c 7 6 7 HTTS Port Subgroup of network https capability_protocol_https 0 NAME VALUE SECURITY get set DESCRIPTION port 443 1025 65535 1 6 HTTPS port 7 6 8 RTSP Subgroup of network rtsp capability_protocol_rtsp 0 NAME VALUE SECURITY get set DESCRIPTION port 554 1025 65535 1 6 RTSP port capability_protocol_rtsp 1 authmode disable basic digest 1 6 RTSP a...

Page 195: ...gi b cgi bi cgi bin are not allowed We modify the value of RTSP access name after version number httpversion is 0311c c 0 capability_nvide oin 1 _s 0 capabilit y_nmediastream 1 _accessname product dependent string 32 1 6 RTSP access name for channel N stream M N 1 capability_nvideoin M 1 capability_nmediastream The value are shown as live1s1 sdp c0_s0_accessname channel1stream1 live1s2 sdp c0_s1_a...

Page 196: ...ION alwaysmulticast boolean 4 4 Enable always multicast ipaddress ip address 4 4 Multicast video IP address We replace network_rtsp_s 0 n 1 _multicast_ipaddress with network_rtsp_s 0 n 1 _multicast_videoipadd ress Reserved for compatibility and suggest don t use this since httpversion 0304a videoipaddress ip address 4 4 Multicast video IP address We support this parameter when the version number h...

Page 197: ...1 255 4 4 Multicasttime to live value 7 6 10 SIP Port Subgroup of network sip capability_protocol_sip 0 NAME VALUE SECURITY get set DESCRIPTION port 1025 65535 1 6 SIP port 7 6 11 RTP Port Subgroup of network rtp NAME VALUE SECURITY get set DESCRIPTION videoport 1025 65535 6 6 Video channel port for RTP audioport 1025 65535 6 6 Audio channel port for RTP metadataport 1025 65535 6 6 Metadata channe...

Page 198: ...ng 6 6 A friendly name for bonjour service We support this parameter when the version number httpversion is equal or greater than 0312a 7 7IP Filter Group ipfilter NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable access list filtering admin_enable boolean 6 6 Enable administrator IP address admin_ip string 43 6 6 Administrator IP address maxconnection 1 capability_protoc ol_maxcon...

Page 199: ...e used after the version number httpversion is equal or greater than 0400a whitebalance product dependent auto panorama manual rbgain widerange outdoor indoor sodiumauto etc Available values are listed in capability_image_ c 0 n 1 _wbmo de 4 4 Modes of white balance auto Auto white balance panorama indicates that camera would try to balance the white balance effect of every sensor rbgain Use rgain...

Page 200: ... 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 exposurelevel 0 12 4 4 Exposure level 0 12 This range takes the concept from DC s exposure tuning options The definition is 0 EV 2 0 1 EV 1 7 2 EV 1 3 3 EV 1 0 4 EV 0 7 5 EV 0 3 6 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...

Page 201: ...pability_image_c 0 n 1 _iristype dciris 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 enableblc Not support anymore boolean 4 4 Enable backlight compensation Not support this parameter anymore when the version number httpversion is equal or greater than 0301a It s recommanded to use ex...

Page 202: ...this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a rotate 0 90 180 270 1 4 The rotation angle of image Support only in Rotation mode Only available when capability_videoin_c 0 n 1 _rotatio n 1 We do not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number...

Page 203: ...er when capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a imprinttimestamp boolean 4 4 Overlay time stamp on video 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 minexposure product dependent 1 32000 5 32000 1 8000 ...

Page 204: ...32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc This parameter may also restrict 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 when capability_image_c 0 n 1 _exposu re_maxrange Only valid when piris_mode manual or ...

Page 205: ...stream NAME VALUE SECURITY get set DESCRIPTION cmosfreq 50 60 4 4 CMOS frequency Only available when capability_videoin_type is 2 mode 0 capability_videoin_c 0 n 1 _nmode 1 4 4 Indicate the video mode on use whitebalance product dependent auto panorama manual rbgain widerange outdoor indoor sodiumauto etc Available values are listed in capability_image_c 0 n 1 _wbmode 4 4 Modes of white balance au...

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

Page 207: ...lable options are list in capability_image_c 0 n 1 _exposure_modetype 4 4 Select exposure mode auto Automatically adjust the Iris Gain and Shutter Speed to fit the exposure level shutterpriority Manually adjust with variable Shutter Speed and keep adjusting Iris Gain automatically irispriority Manually adjust with variable Iris and keep adjusting Gain and Shutter speed automatically qualitypriorit...

Page 208: ... capability_image_c 0 n 1 _iristype dciris piris_mode product dependent manual indoor outdoor 1 4 Control P Iris mode outdoor Auto setting P Iris to get best quality but easy to meet rolling or flicker effect in indoor environment indoor Avoid rolling and flicker effect first manual Manual set P Iris by piris_position not support only available when capability_image_c 0 n 1 _sensor type is smartse...

Page 209: ...tch on off BLC maxgain 0 100 4 4 Maximum gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_m axgain Only valid when piris_mode manual or irismode fixed Normalized range Only available when capability_image_c 0 n 1 _exposu re_rangetype is twovalues mingain 0 100 4 4 Minimum gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_mi ngain Only valid when...

Page 210: ...he image mirror boolean 4 4 Mirror the image rotate 0 90 180 270 1 4 The rotation angle of image Support only in Rotation mode capability_videoin_c 0 n 1 _rotati on 1 ptzstatus Not support anymore 0 positive integer 1 7 A 32 bit integer each bit can be set separately as follows Bit 0 Support camera control function 0 not support 1 support Bit 1 Built in or external camera 0 external 1 built in Bit...

Page 211: ...xposure 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 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc Only available when capability_image_c 0 n 1 _exposu re_minrange Only valid when piris_mode manual or irismode fixed Only available when capability_image_c 0...

Page 212: ... 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 8000 1 5s 1 8000s etc This parameter may also restrict 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 whe...

Page 213: ...l or greater than 0311a crop_position coordinate x y 1 7 Crop left top corner coordinate crop_size window size WxH 1 7 Crop width and height width must be 16x or 32x and height must be 8x zoomratiodispl ay boolean 1 4 Indicates multiple of zoom in is on screen display or not We support this parameter when the version number httpversion is equal or greater than 0302a bracketing_lev el 1 100 4 4 The...

Page 214: ... capability_videoin_c 0 n 1 _maxresolution and capability_videoin_c 0 n 1 _minresolution 1 4 Video resolution in pixels s 0 m 1 _s martfps_enabl e boolean 4 4 Enable Smart fps function Only available when capability_videoin_c 0 n 1 _smart fps_support is 1 We support this parameter when the version number httpversion is equal or greater than 0309a s 0 m 1 _h2 64_dintraperio d_enable boolean 4 4 Ena...

Page 215: ...rolmode vbr s 0 m 1 _h2 64_qvalue 0 51 4 4 Manual video quality level input The Q value which is used by encoded library directly Only valid when h264_ratecontrolmode vbr and s 0 m 1 _h264_quant 99 s 0 m 1 _h2 64_qpercent 1 100 4 4 Select customized quality in a normalized full range 1 Worst quality 100 Best quality Only valid when h264_ratecontrolmode vbr and quant 100 s 0 m 1 _h2 64_maxvbrbitr a...

Page 216: ...n 1 _h264_maxbit rate 4 4 The target bit rate in constant bit rate mode Only valid when h264_ratecontrolmode cbr s 0 m 1 _h2 64_prioritypoli cy framerate imagequality 4 4 Set prioritypolicy Only valid when h264_ratecontrolmode cbr s 0 m 1 _h2 64_maxframe 1 capability_videoin_c 0 n 1 _h264_maxframera te 1 4 The maximum frame rates of a H264 stream at different resolutions capability_videoin_c 0 n 1...

Page 217: ...d 250 500 1000 2000 3000 4000 4 4 The time interval between two I frames Intra coded picture The unit is millisecond ms Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h2 65_ratecontrol mode cbr vbr 4 4 cbr Constant bit rate mode vbr Fixed quality mode all frames are encoded in the same quality Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h2 65_qu...

Page 218: ...pability_videoin_codec Only valid when h265_ratecontrolmode vbr and quant 100 s 0 m 1 _h2 65_maxvbrbitr ate 20000 capability_videoin _c 0 n 1 _h265_maxbit rate 4 4 The maximum allowed bit rate in fixed quality mode When the bit rate exceeds this value frames will be dropped to restrict the bit rate Only available when h265 is listed in capability_videoin_codec Only valid when h265_ratecontrolmode ...

Page 219: ...br s 0 m 1 _h2 65_prioritypoli cy framerate imagequality 4 4 Set prioritypolicy Only available when h265 is listed in capability_videoin_codec Only valid when h265_ratecontrolmode cbr s 0 m 1 _h2 65_maxframe 1 capability_videoin_c 0 n 1 _h265_maxframera te 1 4 The maximum frame rates of a H265 stream at different resolutions capability_videoin_c 0 n 1 _resolution are recorded in capability_videoin...

Page 220: ...100 4 4 Only valid when mjpeg_ratecontrolmode vbr Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality level in qpercent 99 Use the quality level in qvalue s 0 m 1 _mj peg_qvalue 10 200 Only valid when capability_api_httpversio n format is XXXXX_1 or XXXXX_3 or XXXXX_4 ex 0301a_1 or 0301a_3 or 0301a_4 or 1 99 Only valid when capability_api_httpver...

Page 221: ...be dropped to restrict the bit rate Only valid when mjpeg_ratecontrolmode vbr s 0 m 1 _mj peg_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 valid when mjpeg_ratecontrolmode cbr s 0 m 1 _mj peg_cbr_qperc ent 1 100 4 4 Select customized quality in a normalized full range 1 Worst quality 100 Bes...

Page 222: ...ange resolution to fit 4 3 ratio For PAL D1 4CIF 720 704x576 768x576 CIF 352x288 384x288 For NTSC D1 4CIF 720 704x480 640x480 CIF 352x240 320x240 Only available when capability_videoin_type is 0 or 1 wdrpro_mode product dependent 0 1 2 4 4 0 Disable WDR Pro 1 Enable WDR Pro Only valid when capability_image_c 0 n 1 _wdrpro _mode 1 2 Enable WDR Pro II Only valid when capability_image_c 0 n 1 _wdrpro...

Page 223: ...le when capability_image_c 0 n 1 _aespee d is 1 aespeed_spee dlevel product dependent 1 100 4 4 The speed level of AE converge speed 1 20 level 1 21 40 level 2 41 60 level 3 61 80 level 4 81 100 level 5 Level 1 4 low high The higher speed level meas shorter AE converged time during AE executing Only available when capability_image_c 0 n 1 _aespee d is 1 aespeed_sensi tivity product dependent 1 100...

Page 224: ... 1 Add watermarks on images Only available when capability_fisheye 0 s 0 m 2 _fis heyedewarpm ode product dependent 1O 1P 2P 1R 4R for ceiling floor mount 1O 1P 1R 4R for wall mount product dependent 1 4 Local dewarp mode 1O is original mode disable Supported dewarp mode is different by mount type videoin_c 0 n 1 _mounttype Supported mode list could be extracted from capability_videoin_c 0 n 1 _lo...

Page 225: ... differential value of Q between the regions of interest ROI and the areas of non interest non ROI of the display image If the value is a positive number the video quality of ROI is better than the non ROI areas The level is from 1 to 5 Level 5 is the maximum level of the quality difference between the ROI and non ROI areas If the value is a negative number the video quality of non ROI areas is be...

Page 226: ...daytime or nighttime Group videoin_c 0 n 1 _profile_i 0 m 1 for n channel products and m profile n denotes the value of capability_nvideoin and m denotes the value of capability_nvideoinprofile capability_nvideoinprofile 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable disable this profile setting policy night schedule 4 4 The mode which the profile is applied to Not support pol...

Page 227: ...rame 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 when capability_image_c 0 n 1 _exposu re_maxrange Only valid when piris_mode manual or irismode fixed Only available when capability_image_c 0 n 1 _exposu re_rangetype is twovalues shuttervalue product depende...

Page 228: ...ort this parameter when the version number httpversion is equal or greater than 0302a enableblc Not support anymore boolean 4 4 Enable backlight compensation Not support this parameter anymore when the version number httpversion is equal or greater than 0301a It s recommanded to use exposurewin_c n _mode to switch on off BLC exposurelevel 0 12 4 4 Exposure level 0 12 This range takes the concept f...

Page 229: ...able Iris and keep adjusting Gain and Shutter speed automatically qualitypriority Automatically adjust the Iris Gain and Shutter Speed by VIVOTEK quality algorithm manual Manually adjust with variable Shutter Iris and Gain We support this parameter when the version number httpversion is equal or greater than 0302a Only available when capability_image_c0_exposure_mod e 0 whitebalance product depend...

Page 230: ...for outdoor indoor auto white balance mode specifically for indoor sodiumauto sodium vapor lamps Only available when capability_image_c 0 n 1 _wbmo de rgain 0 100 4 4 Manual set rgain value of gain control setting 0 Weak 100 Strong Only available when rbgain is listed in capability_image_c 0 n 1 _wbmo de Only valid when videoin_c 0 n 1 _whitebalance auto Normalized range bgain 0 100 4 4 Manual set...

Page 231: ..._rangetype is twovalues mingain 0 100 4 4 Minimum gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_mi ngain Only valid when piris_mode manual or irismode fixed Normalized range Only available when capability_image_c 0 n 1 _exposu re_rangetype is twovalues gainvalue 0 100 4 4 Gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_m axgain and capabili...

Page 232: ...nual indoor outdoor 1 4 Control P Iris mode outdoor Auto setting P Iris to get best quality but easy to meet rolling or flicker effect in indoor environment indoor Avoid rolling and flicker effect first manual Manual set P Iris by piris_position not support only available when capability_image_c 0 n 1 _sensor type is smartsensor Only available when capability_image_c 0 n 1 _iristype piris piris_po...

Page 233: ... 2 Enable WDR Pro II Only valid when capability_image_c 0 n 1 _wdrpro _mode 2 wdrpro_streng th product dependent 1 100 4 4 The strength of WDR Pro The bigger value means the stronger strength of WDR Pro Only available when capability_image_c 0 n 1 _wdrpro _strength is 1 wdrc_mode product dependent boolean 4 4 Enable WDR enhanced Only available when capability_image_c 0 n 1 _wdrc_ mode is 1 wdrc_st...

Page 234: ...ed time during AE executing Only available when capability_image_c 0 n 1 _aespee d is 1 aespeed_sensi tivity product dependent 1 100 4 4 The sensitivity of AE converge speed 1 20 level 1 21 40 level 2 41 60 level 3 61 80 level 4 81 100 level 5 Level 1 4 low high The higher sensitivity level meas that it is easy to be trigger while scene changed Only available when capability_image_c 0 n 1 _aespee ...

Page 235: ...ol ttl 1 255 4 4 Multicast video time to live value 7 9Time Shift Settings Group timeshift for n channel products and m stream n denotes the value of capability_nvideoin m denotes the value of capability_nmediastream capability_timeshift 0 NAME VALUE SECURITY get set DESCRIPTION enable Not recommended to use boolean 4 4 Enable time shift streaming We replace this parameter with timeshift_c 0 n 1 _...

Page 236: ...lable values are listed in capability_daynight_ c 0 n 1 _mode product dependent 6 6 Set IR cut control mode We replace this parameter with ircutcontrol_c0_mode 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 used after the version number httpversion is equal or greater than 0400a sir product d...

Page 237: ...0 23 59 6 6 Day mod end time We replace this parameter with ircutcontrol_c 0 n 1 _daymodeen dtime 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 used after the version number httpversion is equal or greater than 0400a disableirled Not recommended to use this boolean 6 6 Enable disable built i...

Page 238: ...version number httpversion is equal or greater than 0400a enablewled Not recommended to use this boolean 6 6 Enable disable built in White led Only available when capability_daynight_c 0 capability_ nvideoin 1 _builtinwled 0 We replace this parameter with ircutcontrol_illuminators_builtin_whi teled_enabled when the version number httpversion is equal or greater than 0312a We do not support this pa...

Page 239: ...capability_daynight_c 0 n 1 _ircuts ensitivity_type normalize Only available when capability_daynight_c 0 n 1 _ircutsensitivity_type is not We replace this parameter with ircutcontrol_c 0 n 1 _sensitivity 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 used after the version number httpversion...

Page 240: ...apability_daynight_c 0 n 1 _support 0 n denotes the value of capability_nvideoin NAME VALUE SECURIT Y get set DESCRIPTION mode auto day night di schedule etc Available values are listed in capability_daynig ht_c 0 n 1 _mo de product dependent 6 6 Set IR cut control mode We support this parameter when the version number httpversion is equal or greater than 0312a sir product dependent boolean 6 6 En...

Page 241: ...the version number httpversion is equal or greater than 0312a sensitivity low normal high 1 100 6 6 Sensitivity of day night control There are two value format low normal high if capability_daynight_c 0 n 1 _ircuts ensitivity_type options 1 100 if capability_daynight_c 0 n 1 _ircuts ensitivity_type normalize Only available when capability_daynight_c 0 n 1 _ircutsensitivity_type is not We support t...

Page 242: ...buil tin_support 0 and whiteled is listed in capability_daynight_ illuminators _builtin_type We support this parameter when the version number httpversion is equal or greater than 0312a external_do_enabled boolean 1 6 Enable disable external led mounted on do1 Only available when capability_daynight_illuminators_ext ernal_support 0 and do is listed in capability_daynight_illuminators_ext ernal_int...

Page 243: ...ion number httpversion is equal or greater than 0312a Only available when capability_daynight_illuminators_ spectrum _support 0 7 11 Image Setting per Channel Group image_c 0 n 1 for n channel products and m profile n denotes the value of capability_nvideoin and m denotes the value of capability_nvideoinprofile NAME VALUE SECURITY get set DESCRIPTION brightness Not recommended to use this 5 5 100 ...

Page 244: ...4 4 5 Less saturation 5 More saturation 100 Use image_c n _saturationpercent Only available when bit 2 of capability_image_c 0 n 1 _basicse tting is 1 We replace saturation with saturationpercent This parameter will not be used after the version number httpversion is equal or greater than 0400a sharpness Not recommended to use this 3 3 100 4 4 3 Softer 3 Sharper 100 Use image_c 0 n 1 _sharpnessper...

Page 245: ...malized range 0 Less saturation 100 More saturation Only available when bit 2 of capability_image_c 0 n 1 _basicse tting is 1 sharpnesspercent 0 100 4 4 Set sharpness in the normalized range 0 Softer 100 Sharper Only available when bit 3 of capability_image_c 0 n 1 _basicse tting is 1 gammacurve product dependent 0 100 4 4 0 Fine turned gamma curve by Vivotek 1 Gamma value 0 01 2 Gamma value 0 02 ...

Page 246: ...ent boolean 4 4 3D noise reduction 0 disable 1 enable Only available when capability_image_c 0 n 1 _dnr is 1 dnr_strength product dependent 1 100 4 4 Strength of 3DNR Only available when capability_image_c 0 n 1 _dnr is 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 defog_strength product depend...

Page 247: ...t 1 100 4 4 Strength of digital image stabilizer Only available when dis is listed in capability_image_c 0 n 1 _is_mod e scene_mode product dependent visibility noiseless lpcparkinglot lpcstreet lpchighway auto deblur lpcfreeway product dependent Available values are listed in capability_image_c 0 n 1 _scenemode_ supporttype 4 4 Value of scene mode Only available when capability_image_c 0 n 1 _sce...

Page 248: ...d mode provides better image quality than not using the deinterlace function at all Only available when capability_image_c 0 n 1 _deinter lace_support is 1 xoffset 0 100 4 4 Adjusting the image to proper position horizontally Only available when the bit 4 of capability_image_c 0 n 1 _basicset ting is 1 yoffset 0 100 4 4 Adjusting the image to proper position vertically Only available when the bit ...

Page 249: ... 1 _enable boolean 4 4 Enable disable this profile setting profile_i 0 m 1 _policy night schedule 4 4 The mode which the profile is applied to Not support policy day anymore when the version number httpversion is equal or greater than 0301a profile_i 0 m 1 _begintime hh mm 4 4 Begin time of schedule mode profile_i 0 m 1 _endtime hh mm 4 4 End time of schedule mode profile_i 0 m 1 _brightness Not r...

Page 250: ...ot be used after the version number httpversion is equal or greater than 0400a profile_i 0 m 1 _saturation Not recommended to use this 5 5 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 We replace profile_i0_saturation with profile_i0_saturationpercent This parameter will not be used aft...

Page 251: ...le_i 0 m 1 _contrastpercent 0 100 4 4 Set contrast in the normalized range 0 Less contrast 100 More contrast Only available when bit 1 of capability_image_c 0 n 1 _basicse tting is 1 profile_i 0 m 1 _saturationpercent 0 100 4 4 Set saturation in the normalized range 0 Less saturation 100 More saturation Only available when bit 2 of capability_image_c 0 n 1 _basicse tting is 1 profile_i 0 m 1 _shar...

Page 252: ...able low light mode Only available when capability_image_c 0 n 1 _lowligh tmode is 1 profile_i 0 m 1 _hlm product dependent boolean 4 4 Enable disable hightlight mask Only available when capability_image_c 0 n 1 _hlm is 1 profile_i 0 m 1 _dnr_mode product dependent boolean 4 4 3D noise reduction 0 disable 1 enable Only available when capability_image_c 0 n 1 _dnr is 1 profile_i 0 m 1 _dnr_strength...

Page 253: ...y_image_c 0 n 1 _is_mod e profile_i 0 m 1 _dis_mode product dependent boolean 4 4 Digital image stabilizer 0 disable 1 enable Only available when dis is listed in capability_image_c 0 n 1 _is_mod e profile_i 0 m 1 _dis_strength product dependent 1 100 4 4 Strength of digital image stabilizer Only available when dis is listed in capability_image_c 0 n 1 _is_mod e 7 12 Exposure Window Setting per Ch...

Page 254: ...innum Only available when capability_image_c 0 n 1 _exposure_mode 1 and when custom is listed in capability_image_c 0 n 1 _exposure_winmode and valid when exposurewin_c 0 n 1 _mode custom or exposurewin_c 0 n 1 _mode hlc NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable or disable the window policy 0 1 4 4 0 Indicate exclusive 1 Indicate inclusive Only available when exclusive is l...

Page 255: ... Only available when std is listed in capability_image_c 0 n 1 _exposu re_windomain sizestd 0 9999x0 9999 4 4 Width and height of the window Only available when std is listed in capability_image_c 0 n 1 _exposu re_windomain Group exposurewin_c 0 n 1 _profile_i 0 m 1 for n channel profuct and m profile n denotes the value of capability_nvideoin m denotes the value of capability_nvideoinprofile Only...

Page 256: ... capability_image_c 0 n 1 _exposure_winnum Only available when capability_image_c 0 n 1 _exposure_mode 1 and when custom is listed in capability_image_c 0 n 1 _exposure_winmode and valid when exposurewin_c 0 n 1 _mode custom or exposurewin_c 0 n 1 _mode hlc NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable or disable the window policy 0 1 4 4 0 Indicate exclusive 1 Indicate inclusi...

Page 257: ... re_windomain homestd 0 9999 0 9999 4 4 Left top corner coordinate of the window Only available when std is listed in capability_image_c 0 n 1 _exposu re_windomain sizestd 0 9999x0 9999 4 4 Width and height of the window Only available when std is listed in capability_image_c 0 n 1 _exposu re_windomain 7 13 Audio Input per Channel Group audioin_c 0 n 1 capability_naudioin 0 n denotes the value of ...

Page 258: ...ity_audio_extmic 1 Note If physical microphone switch is showed on product this value is updated during booting to fit switch status volume_internal 0 100 4 4 Volume when take internal microphone as input source 0 Minimum 100 Maximum Only available when the channel supports internal microphone The related bit of capability_audio_intmic is equal to 1 volume_external 0 100 4 4 Volume when take exter...

Page 259: ...ommended to use this 0 100 4 4 Enable microphone boost Gain of input audioin_c 0 n 1 _source micin Reserved for compatibility and suggest don t use this since the version number httpversion is equal or greater than 0301a We replace boostmic with volume_internal and volume_external More details please refer the parameter description of volume_internal and volume_external s0_codectype aac4 gamr g711...

Page 260: ...00 4 4 Set G 726 encoded bitrate in bps Only available if G 726 is supported s0_g726_bitstreamp ackingmode little big 4 4 Set G 726 bit streaming packing mode little Little endian bitstream format big Big endian bitstream format Only available if G 726 is supported s0_g726_vlcmode 0 1 4 4 Enable vlcmode for G 726 0 Standard mode 1 Solve compatibility problem with VLC player Only available if G 726...

Page 261: ... time of schedule mode profile_i0_alarm_lev el 1 100 4 4 Audio detection alarm level 7 13 1 Multicast Settings for Audio Streaming Group audioin_c 0 n 1 _s0_multicast capability_naudioin 0 and capability_media_streamprofiles_support 1 n denotes the value of capability_naudioin NAME VALUE SECURITY get set DESCRIPTION ipaddress ip address 4 4 Multicast audio IP address port 1025 65535 4 4 Multicast ...

Page 262: ...16 Motion Detection Settings Group motion_c 0 n 1 for n channel products n denotes the value of capability_nvideoin NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable motion detection win_sensitivity 0 100 4 4 Sensitivity of all motion detection windows The value 0 is reserved for compatibility and will not be used after the version number httpversion is equal or greater than 0400a ...

Page 263: ...px Not recommended to use this 0 W 0 H 0 W 0 H 0 W 0 H 0 W 0 H W 0 The current image width 1 H 0 The current image height 1 4 4 Coordinate of polygon window position 4 points x0 y0 x1 y1 x2 y2 x3 y3 Only available when capability_motion_wintype polygon Only available when px is listed in capability_motion_windomain It s recommended to use polygonsd This parameter will not be used after the version...

Page 264: ...ordinate of window position Only available when capability_motion_wintype rectangle Only available when qvga is listed in capability_motion_windomain It s recommended to use polygonsd This parameter will not be used after the version number httpversion is equal or greater than 0400a width Not recommended to use this 0 320 4 4 Width of motion detection window Only available when capability_motion_w...

Page 265: ... 1 m 1 policy night schedule 4 4 The mode which the profile is applied to Not support policy day anymore when the version number httpversion is equal or greater than 0301a begintime hh mm 4 4 Begin time of schedule mode endtime hh mm 4 4 End time of schedule mode win_sensitivity 0 100 4 4 Sensitivity of all motion detection windows The value 0 is reserved for compatibility and will not be used aft...

Page 266: ...se this 0 W 0 H 0 W 0 H 0 W 0 H 0 W 0 H W 0 The current image width 1 H 0 The current image height 1 4 4 Coordinate of polygon window position 4 points x0 y0 x1 y1 x2 y2 x3 y3 Only available when capability_motion_wintype polygon Only available when px is listed in capability_motion_windomain It s recommended to use polygonsd This parameter will not be used after the version number httpversion is ...

Page 267: ...domain It s recommended to use polygonsd This parameter will not be used after the version number httpversion is equal or greater than 0400a width Not recommended to use this 0 320 4 4 Width of motion detection window Only available when capability_motion_wintype rectangle Only available when qvga is listed in capability_motion_windomain It s recommended to use polygonsd This parameter will not be...

Page 268: ...orewidth 0 positive integer 1 7 Indicate the width to offset to start to analysis the image dark_enable boolean 4 4 Enable or disable image too dark detection dark_threshold 0 100 4 4 Threshold of image too dark detection dark_duration 1 10 4 4 If image too dark value exceeds the threshold for more than duration second s then image too dark detection is triggered bright_enable boolean 4 4 Enable o...

Page 269: ...amic dyndns org dynamic DyndnsCustom dyndns org Safe100 safe100 net provider _hostnam e string 128 6 6 Your DDNS hostname provider _usernam eemail string 64 6 6 Your user name or email to login to the DDNS service 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 ...

Page 270: ...tus 0 3 6 7 The status of UPnP port forwarding used internally 0 OK 1 FAIL 2 no IGD router 3 no need for port forwarding 7 22 System Log Group syslog NAME VALUE SECURITY get set DESCRIPTION enableremotelog boolean 6 6 Enable remote log serverip IP address 6 6 Log server IP address serverport 514 1025 65535 6 6 Server port used for log level 0 7 6 6 Levels used to distinguish the importance of the ...

Page 271: ...mero string 31 6 6 Read only security name authpwrw string 8 128 7 6 Read write authentication password authpwro string 8 128 7 6 Read only authentication password authtyperw MD5 SHA 6 6 Read write authentication type authtypero MD5 SHA 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 ...

Page 272: ...how or hide manual trigger VI button in homepage 0 Hidden 1 Visible theme_option 1 4 1 6 1 3 One of the default themes 4 Custom definition theme_color_font string 7 1 6 Font color theme_color_configfont string 7 1 6 Font color of configuration area theme_color_titlefont string 7 1 6 Font color of video title theme_color_controlba ckground string 7 1 6 Background color of control area theme_color_c...

Page 273: ...k_wintype rectangle win_i 0 m 1 _top 0 240 4 4 Top coordinate of window position Only available when capability_image_c 0 n 1 _privacy mask_wintype rectangle win_i 0 m 1 _width 0 320 4 4 Width of privacy mask window Only available when capability_image_c 0 n 1 _privacy mask_wintype rectangle win_i 0 m 1 _height 0 240 4 4 Height of privacy mask window Only available when capability_image_c 0 n 1 _p...

Page 274: ...n capability_image_c 0 n 1 _privacy mask_wintype polygon Only available when std is listed in capability_image_c 0 n 1 _privacy mask_windomain 7 26 3D Privacy Mask Group privacymask3d_c 0 n 1 for n channel products and m privacy mask window capability_image_c 0 n 1 _privacymask_wintype 3Drectangle n denotes the value of capability_nvideoin and m denotes the value of capability_videoin_c 0 n 1 _npr...

Page 275: ... 1 _fliped boolean 4 4 Flip side of window position 0 Non flip side 1 Flip side 7 27 Capability Group capability NAME VALUE SECURITY get set DESCRIPTION api_httpversion string This number start with 0301a 0 7 The version of VIVOTEK WebAPI with 4 integers plus 1 alphabet There are composed by major version minor version revision _platform ex 0301a_1 Major version Increase the major version when cha...

Page 276: ... decimal digit from 0 to 9 while r is an alphabetic EX 0302b_1 Major version 03 minor version 02 revision b platform 1 The 4 integer numbers are WebAPI version we use short name httpversion for it in this document The 5th character is model based version for API bug fix and it s default to a Ex If some APIs in a model does not follow the API definition of 0301a_1 we will fix them and change this A...

Page 277: ...er of audio input channel 0 means no audio input support naudioout 0 positive integer 0 7 The number of audio output channel nvideoin positive integer 0 7 Number of video inputs nvideoout 0 Positive Integer 0 7 Number of video out interface nvideoinprofile positive integer 0 7 Number of video input profiles nmediastream positive integer 0 7 Number of media stream per channels naudiosetting Not sup...

Page 278: ...ter than 0309a ptzenabled 0 positive integer 0 7 An 32 bit integer each bit can be set separately as follows Bit 0 Support camera control function 0 not support 1 support Bit 1 only available when bit0 is 1 Built in or external video source 0 external 1 built in Bit 2 only available when bit0 is 1 Support pan operation 0 not support 1 support Bit 3 only available when bit0 is 1 Support tilt operat...

Page 279: ...otefocus Not recommended to use this 0 positive integer 0 7 An 4 bit integer which indicates the supportive application of remotefocus If the value of this parameter is larger than 0 it means that the camera supports remotefocus function bit 0 Indicate whether to support both zoom and focus function bit 1 Only support zoom function bit 2 Only support focus function bit 3 Currently this is a reserv...

Page 280: ...st 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 are the 1st group for 1st channel bit 16 31 are the 2nd group for 2nd channel nvideoin 3 bit 0 9 are the 1st group for 1st channel bit 10 19 are the 2nd group for 2nd channel bit 20 31 are the 3rd grou...

Page 281: ...o 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 tamper toodark toobri ght tooblurry 0 7 Available tampering mode list Only available when capability_tampering is 1 adaptiverecording boolean 0 7 Indicate whether to support adaptive recording adapti...

Page 282: ...Number 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 boolean 0 7 Indicate whether to support HTTP over SSL protocol_rtsp boolean 0 7 Indicate whether to support RTSP protocol_sip boolean 0 7 Indicate whether to support SIP protocol_maxconn ection positive ...

Page 283: ... support IPv6 protocol_pppoe boolean 0 7 Indicate whether to support PPPoE protocol_ieee8021 x boolean 0 7 Indicate whether to support IEEE802 1x protocol_qos_cos boolean 0 7 Indicate whether to support CoS protocol_qos_dscp boolean 0 7 Indicate whether to support QoS DSCP protocol_ddns boolean 0 7 Indicate whether to support DDNS videoin_type 0 1 2 0 7 0 Interlaced CCD 1 Progressive CCD 2 CMOS vi...

Page 284: ...265 then this is mjpeg h264 h265 videoin_streamcod ec A list of Positive Integer 0 7 This equals capability_videoin_c0_streamcodec This is kept for compatibility videoin_flexiblebitr ate boolean 0 7 Indicate whether to support flexible bit rate control videoout_codec A list of the available codec types separated by commas product dependent 0 7 Available codec list not supported timeshift boolean 0...

Page 285: ...n be categorized into following groups disabled UI turns grey and users can t select it unchanged UI keeps the status as before and user can t change it hidden UI is hidden fixed UI is fixed to one selection or value ranged UI is fixed to multiple selections or values enabled UI is checked notsupport the affected function is not available Affect API name can be described in hierarchy such as expos...

Page 286: ...ion number httpversion is equal or greater than 0301a We replace audio_mic with audio_intmic audio_intmic 0 Positive Integer 0 7 Internal Built in Microphone 0 Not support 1 Support Bit 0 for CH0 bit 1 for CH1 and so on audio_extmic 0 Positive Integer 0 7 External Microphone 0 Not support 1 Support Bit 0 for CH0 bit 1 for CH1 and so on audio_alarm 0 Positive Integer 0 7 0 Not support audio alarm 1...

Page 287: ...io clip function We support this parameter when the version number httpversion is equal or greater than 0309a audioin_codec aac4 gamr g711 g726 product dependent 0 7 Available audio codec We take comma to split codec without any space aac4 Advanced Audio Coding AAC gamr Adaptive Multi Rate AMR g711 G 711 g726 G 726 Not supported audioout_codec g711 product dependent 0 7 Available codec list for SI...

Page 288: ...a a 320x240 range to represent the whole image px Locate a window in the image with pixels std A normalized 0 9999 range Not supported Only available when capability_smartstream_support is 1 smartstream_mod e_autotracking boolean 0 7 Indicate whether autotracking smart stream is supported Only available when capability_smartstream_support is 1 smartstream_mod e_manual boolean 0 7 Indicate whether ...

Page 289: ... mode Only available when capability_smartstream_support is 1 vadp_supportfeatu re positive integer 0 7 An 32 bit integer each bit can be set separately as follows Bit 0 VADP interface Bit 1 Capture video raw data Bit 2 Support encode jpeg Bit 3 Capture audio raw data Bit 4 Support event trigger Bit 5 Support license registration Bit 6 Support shared memory API Bit 7 Support digital signature of p...

Page 290: ...ly cgi bin viewer camctrl cgi This is equivalent to capability_camctrl_c0_privilege This is kept for compatibility uart_httptunnel boolean 0 7 Indicate whether to support HTTP tunnel for UART transfer transmission_mod e Tx Rx Both 0 7 Indicate transmission mode of the machine TX server Rx receiver box Both DVR network_wire boolean 0 7 Indicate whether to support Ethernet network_wireless boolean 0...

Page 291: ...ireless_encrypt_ wpa2 boolean 0 7 Indicate whether to support wireless WPA2 wireless_apmode_ enable boolean 0 7 Indicate whether wireless AP mode is supported Only available when capability_network_wireless is 1 We support this parameter when the version number httpversion is equal or greater than 0305a wireless_apmode_ ssidprefix string 0 7 Indicate the prefix of broadcasted SSID when camera is i...

Page 292: ...ive integer 0 7 Maximum snapshot number after event occurred media_snapshot_ maxsize positive integer 0 7 Maximum size KB of a snapshot media_videoclip_ maxsize positive integer 0 7 Maximum size KB of a videoclip media_videoclip_ maxlength positive integer 0 7 Maximum length second of a videoclip media_videoclip_ maxpreevent positive integer 0 7 Maximum duration second after event occurred in a vi...

Page 293: ...ist We replace capability_image_ focusassist with capability_image_c0_ focusassist Reserved for compatibility and suggest don t use this since httpversion 0301a localstorage_mana geable boolean 0 7 Indicate whether manageable local storage is supported Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 localstorage_seaml ess 0 positive integer 0 7 Indicate whether s...

Page 294: ...bility_supportsd is 1 or capability_storage_dbenabled is 1 localstorage_suppo rtedge 0 positive integer 0 7 An 32 bit integer which indicates the supportive application of edge storage If the value of this parameter is larger than 0 it means that the camera supports edge recording function bit 0 It supports to record directly to an on board SD Card bit 1 Currently they are reserved bit and the def...

Page 295: ...slave side fisheyelocaldewarp _c 0 capability_n videoin 1 product dependent 0 positive integer 0 7 Indicate the supported streams of local dewarp One bit represents one supported stream The LSB indicates stream 0 Ex 3 means stream 0 and stream 1 support local dewarp Only available when capability_fisheye 0 shockalarm_suppo rt boolean 0 7 Indicate whether to support the shock detection We support t...

Page 296: ...r each bit can be set separately as follows Bit 0 support rs485 in Bit 1 support rs485 out buildinpt boolean 0 7 An 32 bit integer each bit can be set separately as follows Bit 0 support build in pan Bit 1 support build in tilt zoommodule boolean 0 7 Indicate whether to support zoom lens In our product only SD series and IZ series use the zoom lens Both varifocal and zoom lenses are built with mov...

Page 297: ...ce situation manual Turn off the automatically focus function For user to control the focus position manually as their purpose Only available when capability_camctrl_c 0 n 1 _zoommo dule is 1 We support this parameter when the version number httpversion is equal or greater than 0304a Group capability_ptz_c 0 n 1 n denotes the value of capability_nvideoin capability_ptzenabled 0 and capability_camc...

Page 298: ... _buildin pt is 1 maxpanangle integer 0 7 The upper limit for pan angle Only available when bit0 of capability_camctrl_c 0 n 1 _buildin pt is 1 tiltspeedlv 0 positive integer 0 7 The maximum speed level of tilt motion Only available when bit1 of capability_camctrl_c 0 n 1 _buildin pt is 1 mintilt 0 positive integer 0 7 The lower limit for tilt position Only available when bit1 of capability_camctr...

Page 299: ...axzoom 0 positive integer 0 7 The upper limit for zoom position Only available when the value of capability_camctrl_c 0 n 1 _zoomm odule is 1 maxdzoom 0 positive integer 0 7 The upper limit for digital zoom position Only available when the value of capability_camctrl_c 0 n 1 _zoomm odule is 1 focusspeedlv 0 positive integer 0 7 The maximum speed level of focus motion Only available when the value ...

Page 300: ...is parameter with capability_daynight_illuminators_builti n_type whiteled when the version number httpversion is equal or greater than 0312a externalir boolean 0 7 Indicate whether to support external IR led We replaced this parameter with capability_daynight_illuminators_exter nal_support when the version number httpversion is equal or greater than 0312a optimizedir boolean 0 7 Indicate whether t...

Page 301: ... of ircutcontrol_sensitivity parameter is low normal high normalize the value of ircutcontrol_sensitivity parameter is 1 100 not support Only available when capability_daynight_c 0 n 1 _suppo rt is 1 We support this parameter when the version number httpversion is equal or greater than 0302a ircutsensitivity_supportle vel 0 positive integer 0 7 The value indicate the support strength level of ircu...

Page 302: ...lluminators_exter nal_interface when the version number httpversion is equal or greater than 0312a spectrum_support boolean 0 7 Indicate whether to support proposed a brightness enhancement method based on CCM Color Correction Matrix model to improve the brightness effect of the images if the IR and blue light exists Only available when capability_daynight_c 0 n 1 _suppo rt is 1 We replaced this p...

Page 303: ...light ir The ideal default setting for IR light irenhanced This CCM model increases the brightness effect of IR light blueenhanced This CCM model increases the brightness effect of blue light Only available when capability_daynight_c 0 n 1 _suppo rt is 1 and capability_daynight_c 0 n 1 _spectr um_support is 1 We replaced this parameter with capability_daynight_illuminators_spect rum_mode when the ...

Page 304: ...input 1 is triggered di2 the camera automatically switches the current mode when a ditigal input 2 is triggered di3 the camera automatically switches the current mode when a ditigal input 3 is triggered di4 the camera automatically switches the current mode when a ditigal input 4 is triggered schedule The Camera switches between day mode and night mode based on a specified schedule not support We ...

Page 305: ...is equal or greater than 0312a external_interface do do2 do3 do4 product dependent Available values are do do 2 capability_nd o 0 7 The device interface of external led do digital output 1 do2 digital output 2 do3 digital output 3 do4 digital output 4 We support this parameter when the version number httpversion is equal or greater than 0312a Only available when capability_daynight_illuminators_ e...

Page 306: ...eter when the version number httpversion is equal or greater than 0312a Group capability_storage_management PARAMETER VALUE SECURITY get set DESCRIPTION ndevice positive integer 0 7 Indicate the number of storage devices We support this parameter when the version number httpversion is equal or greater than 0312a device sd nas product dependent 0 7 Indicate the supported storage devices Only availa...

Page 307: ...rt zoom focus etc ics An i CS lens is an intelligent CS mount lens that contains information about among other things its own geometrical distortion and the exact position of its zoom focus and iris opening N A Only available when httpversion 0301a color_support boolean 0 7 1 camera can select to display color or black white video streams 0 camera do not support this feature We support this parame...

Page 308: ...and user can t change it hidden UI is hidden fixed UI is fixed to one selection or value ranged UI is fixed to multiple selections or values enabled UI is checked notsupport the affected function is not available Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixe...

Page 309: ...on 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 and the definition is as following Bit 0 Support MPEG4 Bit 1 Support MJPEG Bit 2 Support H 264 Bit 3 Support H 265 mode 0 positive integer 0 7 Indicate current video mode nmode positive integer 0 7 In...

Page 310: ...d 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 support this parameter when the version number httpversion is equal or greater than 0304b maxframerate A list of Integer 0 7 Indicate frame rate that the video source outputs in current video mode On...

Page 311: ...nly 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 available when mjpeg is listed in capability_videoin_codec h264_maxframerate A list of Positive Integer and 0 7 Maximum fps that the device can encoded with H 264 on resolutions in current video mode means ...

Page 312: ...ith 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 changed when videoin_c n _cmosfreq 50 or videoin_c n _modulation pal Ex 30 fps is changed to 25 fps 60 fps is changed to 50 fps and so on Only available when h265 is listed in capability_videoin_codec h2...

Page 313: ...ommended 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 mount type not support We support this parameter when the version number httpversion is equal or greater than 0309c dintraperiod_support boolean 0 7 0 Non support Dynamic intra frame period 1 Support D...

Page 314: ...cy 50 60Hz can be set by user We support this parameter when the version number httpversion is equal or greater than 0308a smartfps_support boolean 0 7 Indicate whether to support Smart fps function We support this parameter when the version number httpversion is equal or greater than 0309a smartq_support boolean 0 7 Indicate whether to support Smart Q function We support this parameter when the v...

Page 315: ...esolutionW1P 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 0 7 Available resolutions of 4R mode of wall mount panorama_pancontrol Boolean 0 7 Indicate whether to support localdewarp panorama pan control We support this parameter when the version number httpversion is equal ...

Page 316: ...r 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 the group indicates 2nd stream of a channel support ePTZ or not and so on We support this parameter when the version number httpversion is equal or greater than 0304b wdrpro 0 1 2 0 7 Indicate this m...

Page 317: ... 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 reduced resolution We design this parameter to disclose this information nresolution positive integer 0 7 How many resolution options in this video mode resolution A list of WxH 0 7 Resolution options ...

Page 318: ...in 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 or videoin_c 0 n 1 _modulation ntsc maxfps_mjpeg A list of Positive Integer and 0 7 Maximum fps which the device can encoded with MJPEG on resolutions in this video mode means not support One to one ...

Page 319: ...n_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 resolution The element number is defined as nresolution in this group This parameter records the frame rate when videoin_c 0 n 1 _cmosfreq 60 or videoin_c 0 n 1 _modulation ntsc Only available when h26...

Page 320: ...ual or greater than 0311a wdrpro_mode 0 1 2 0 7 0 Non support WDR Pro 1 Support WDR Pro 2 Support WDR Pro and WDR Pro II wdrpro_strength 0 1 0 7 0 Non support tuning strength of WDR Pro 1 Support tuning strength of WDR Pro If capability_image_c 0 n 1 _wdrpro 1 this may be either 0 or 1 wdrpro_supportlevel 0 positive integer 0 7 This contains a list of positive integers split by comma If wdrpro_mod...

Page 321: ... it unchanged UI keeps the status as before and user can t change it hidden UI is hidden fixed UI is fixed to one selection or value ranged UI is fixed to multiple selections or values enabled UI is checked notsupport the affected function is not available onlyonce when wdrpro is enabled wdrc is checked when wdrpro is disable wdrc is unchecked Affect API name can be described in hierarchy such as ...

Page 322: ...ed is enabled some features may become malfunction or be forced to a given value The affected functions are list here The format is Affect API name Policy Description Policy can be categorized into following groups disabled UI turns grey and users can t select it unchanged UI keeps the status as before and user can t change it hidden UI is hidden fixed UI is fixed to one selection or value ranged ...

Page 323: ...al noise reduction dnrstrength positive integer 0 7 Indicate the support strength level of 3D digital noise reduction Only available when capability_image_c 0 n 1 _dnr 0 We support this parameter when the version number httpversion is equal or greater than 0306d dnrtype 2d 3d 0 7 Description about DNR type Only available when capability_image_c 0 n 1 _dnr 0 We support this parameter when the versi...

Page 324: ...rtlevel 0 positive integer 0 7 Indicate the support strength level of image stabilizer mode Only available when capability_image_c 0 n 1 _is_mod e is not We support this parameter when the version number httpversion is equal or greater than 0302a is_affect x nonnegative integer product dependent 0 7 When Is mode is not some features may become malfunction or be forced to a given value The affected...

Page 325: ...el is fixed to level 6 Description can be a nonnegative integer or string or NULL means no feature is affected Only available when capability_image_c 0 n 1 _is_mod e is not We support this parameter when the version number httpversion is equal or greater than 0302a scenemode_support 0 1 0 7 0 Non support scene mode 1 Support scene mode scenemode_supportty pe product dependent visibility noiseless ...

Page 326: ...or type rawsensor Raw sensor smartsensor Smart sensor thermalsensor Thermal sensor N A We support this parameter when the version number httpversion is equal or greater than 0302a exposure_mode 0 1 0 7 0 Non support exposure control 1 Support exposure control exposure_modetype auto shutterpriority irispriority manual product dependent 0 7 Available mode of exposure setting Only available when capa...

Page 327: ...alue videoin_c 0 n 1 _shuttervalue maximum The shutter value can be up to the assigned value videoin_c 0 n 1 _shuttervalue not support Only available when capability_image_c 0 n 1 _ exposure_mode is 1 and capability_image_c 0 n 1 _exposu re_rangetype is onevalue We support this parameter when the version number httpversion is equal or greater than 0302a exposure_gainvaluety pe fixed maximum 0 7 On...

Page 328: ...ome malfunction or be forced to a given value The affected functions are list here The format is Affect API name Policy Description Policy can be categorized into following groups disabled UI turns 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 selections ...

Page 329: ...relevel hidd en defaultgain fixed x or others x nonnegative integer product dependent 0 7 When exposure shutter priority mode is enabled some features may become malfunction or be forced to a given value The affected functions are list here The format is Affect API name Policy Description Policy can be categorized into following groups disabled UI turns grey and users can t select it unchanged UI ...

Page 330: ...he version number httpversion is equal or greater than 0302a exposure_irispriority mode_affect exposurewin mode blc hidden defog disabled wdrpro disabled exposurelevel hidd en defaultgain fixed x or others x nonnegative integer product dependent 0 7 When exposure iris priority mode is enabled some features may become malfunction or be forced to a given value The affected functions are list here Th...

Page 331: ...y is listed in capability_image_c 0 n 1 _ exposure_modetype and capability_image_c 0 n 1 _ exposure_mode is 1 We support this parameter when the version number httpversion is equal or greater than 0302a exposure_qualityprior itymode_affect exposurewin mode blc hidden defog disabled wdrpro disabled exposurelevel hidd en defaultgain fixed x or others x nonnegative integer product dependent 0 7 When ...

Page 332: ...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 qualitypriority is listed in capability_image_c 0 n 1 _ exposure_modetype and capability_image_c 0 n 1 _ exposure_mode is 1 We support this parameter when the version number httpversion is equal or greater than 0305a exposure_man...

Page 333: ...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 disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL means no feature is affected Only available when manua...

Page 334: ...ct dependent 0 7 Available options for videoin_c 0 n 1 _meteringmode Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_hlcmode_s upportwindow boolean 0 7 Indicate whether to support exposure window in hlc mode Only available when capability_image_c 0 n 1 _ exposure_mode is 1 and hlc is listed in capability_image_c 0 n 1 _ exposure_winmode exposure_hlcmode_af fect sir hidde...

Page 335: ... exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL means no feature is affected Only available when capability_image_c 0 n 1 _ exposure_mode is 1 and hlc is listed in capability_image_c 0 n 1 _ exposure_winmode We support this parameter when the version ...

Page 336: ... n 1 _ exposure_mode is 1 exposure_winnum 0 Positive Integer 0 7 Indicate the number of custom exposure windows If no custom is listed in exposure_winmode this should be 0 Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_ntsc_totalra nge A list of Positive Integer 0 7 Available total range for NTSC analog output Only available when capability_image_c 0 n 1 _ exposure_mode...

Page 337: ...ust be set to Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_minrange 1 32000 1 8000 or others product dependent 0 7 Available range for videoin_c n _minexposure 1 32000 1s 1 32000s 1 8000 1s 1 8000s etc means minimum exposure time is not available When exposure_mode 0 this value must be set to Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_b...

Page 338: ...lable when capability_image_c 0 n 1 _ exposure_bracketing_mode is 1 We support this parameter when the version number httpversion is equal or greater than 0310a privacymask_wintype rectangle polygon 3Drectangle 0 7 The supported mask window type polygon The window is a 2D polygon shape rectangle The window is a 2D rectangle shape 3Drectangle The window is a 3D rectangle shape privacymask_windom ai...

Page 339: ...lickerless is enabled some features may become malfunction or be forced to a given value The affected functions are list here The format is Affect API name Policy Description Policy can be categorized into following groups disabled UI turns grey and users can t select it unchanged UI keeps the status as before and user can t change it hidden UI is hidden fixed UI is fixed to one selection or value...

Page 340: ... n 1 _defog_ mode 1 this may be either 0 or 1 defog_supportlevel 0 positive integer 0 7 The value indicate the support strength level of defog defog_affect wdrc unchanged contrast hidden or others x nonnegative integer product dependent 0 7 When defog is enabled some features may become malfunction or be forced to a given value The affected functions are list here The format is Affect API name Pol...

Page 341: ...ans no feature is affected When defog 0 this value must be aespeed 0 1 0 7 0 Non support AE speed 1 Support AE speed aespeedsupportlevel positive integer 0 7 The value indicate the support strength level of aespeed Only available when capability_image_c 0 n 1 _aespee d is 1 aespeedsupportsensit ivity 0 1 0 7 0 Non support tuning the sensitivity of AE converge speed 1 Support tuning the sensitivity...

Page 342: ...served bit and the default value is 0 focuswindomain qvga px std 0 7 The domain to set a focus window qvga a 320x240 range to represent the whole image px Locate a window in the image with pixels std A normalized 0 9999 range Not supported focuswindow_nwindo w 0 positive integer 0 7 Number of focus window focuswindow_range leftrange rightran ge toprange lowran ge product dependent 0 7 Available ra...

Page 343: ...ge_c 0 n 1 _sensor type is smartsensor deinterlace_support boolean 0 7 Indicate whether to support deinterlace function We support this parameter when the version number httpversion is equal or greater than 0308a deinterlace_mode spatial blend 0 7 Spatical mode provides the best image quality while Blend mode provides better image quality than not using the deinterlace function at all Only availab...

Page 344: ...e color tones correspond to the apparent surface temperatures of the target We support this parameter when the version number httpversion is equal or greater than 0310a palette_mode A list of palette options 0 7 Palette options used in thermal surveillance Only available when capability_image_c 0 n 1 _palette _support 1 We support this parameter when the version number httpversion is equal or grea...

Page 345: ...f custom script time string 4 20 6 6 Time of custom script 7 29 Event Setting Group event_i 0 n 1 n denotes the value of capability_nevent capability_nevent 0 PARAMETER VALUE SECURITY get set DESCRIPTION name string 40 6 6 Identification of this entry enable 0 1 6 6 Enable or disable this event priority 0 1 2 6 6 Indicate the priority of this event 0 low priority 1 normal priority 2 high priority ...

Page 346: ...detection virestore Video input signal restore vadp VADP trigger smartsd is only valid when smart SD card is inserted triggerstatus string 40 6 6 The status for event trigger di 0 positive integer 6 6 Indicate the source id of di trigger This field is required when trigger condition is di One bit represents one digital input The LSB indicates DI 0 Only available when capability_ndi 0 mdwin 0 posit...

Page 347: ...tect event from any one of source id 0 1 and 3 set vadp to 11 Only available when vadp is listed in capability_supporttriggertypes valevel 0 1 6 6 Select audio detection event 0 not select 1 select valevel0 0 1 6 6 Select audio detection profile event 0 not select 1 select inter 1 999 6 6 Interval of snapshots in minutes This field is used when trigger condition is seq weekday 0 127 6 6 Indicate w...

Page 348: ...f the digital output trigger in seconds Only available when capability_ndo 0 action_cf_enable Boolean 6 6 Enable or disable sending media to SD card Only available when capability_supportsd 0 action_cf_folder Not recommended to use this string 128 6 6 Path to store media Only available when capability_supportsd 0 foldername string 128 6 6 Path to store media We support this parameter when the vers...

Page 349: ...tz goto preset position on event triggered Only available when capability_ptzenabled 0 action_goto_name product dependent string 40 6 6 Specify the preset name that ptz goto on event triggered Only available when capability_ptzenabled 0 action_goto_sync product dependent boolean 6 6 Capture media after moving to the location Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 o...

Page 350: ...econd channel bit 2 tampering detection for third channel bit 3 tampering detection for fourth channel We support this parameter when the version number httpversion is equal or greater than 0311c 7 30 Server Setting for Event Action Group server_i 0 4 PARAMETER VALUE SECURITY get set DESCRIPTION name string 40 6 6 Identification of this entry type email ftp http ns 6 6 Indicate the server type ema...

Page 351: ...email_username string 64 6 6 Username to log in to the server email_passwd string 64 7 6 Password of the user email_senderemail string 128 6 6 Email address of the sender email_recipientemail string 640 6 6 Email address of the recipient ns_location string 128 6 6 Location to upload or store the media ns_username string 64 6 6 Username to log in to the server ns_passwd string 64 7 6 Password of th...

Page 352: ...ndicate 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 the prefix of the filename media_i0 Snapshot1_ media_i1 Snapshot2_ media_i2 Snapshot3_ media_i3 Snapshot4_ media_i4 Snapshot5_ snapshot_datesuffix 0 1 6 6 Add date and time suffix to filename 1 Add da...

Page 353: ...source 0 capability_nmediastream 1 6 6 Indicate 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 videoclip_prefix string 16 6 6 Indicate the prefix of the filename videoclip_preevent 0 capability_media_videoclip_ maxpreevent 6 6 Indicates the time for pre event recording in seconds videoclip_max...

Page 354: ...network 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 priority channel 0 capability_nvideoin 1 6 6 Indicate the source of recording channel 0 means the first channel 1 means the second channel 2 means the third channel 3 means the fourth channel We suppo...

Page 355: ... 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 1 Enable recording notification notifyserver 0 31 6 6 Indicate which notification server is scheduled One bit represents one application server server_i0 i4 bit0 LSB server_i0 bit1 server_i1 bit2 ser...

Page 356: ...of 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 storage CF or SD card 0 means the index of the network storage cffolder Not recommended to use this string 128 6 6 Folder name foldername string 128 6 6 Folder name We support this parameter when the versi...

Page 357: ...PTION enable boolean 6 6 To enable or disable secure HTTP policy Boolean 6 6 If the value is 1 it will force HTTP connection redirect to HTTPS connection method auto manual install 6 6 auto Create self signed certificate automatically manual Create self signed certificate manually install Create certificate request and install status 3 1 6 6 Specify the https status 3 Certificate not installed 2 I...

Page 358: ...R VALUE SECURITY get set DESCRIPTION cyclic_enabled boolean 6 6 Enable cyclic storage method cyclic_reserve 10 99 6 6 The reserved percentage of this disk We support this parameter when the version number httpversion is equal or greater than 0312a type sd nas product dependent 6 7 The storage device type We support this parameter when the version number httpversion is equal or greater than 0312a a...

Page 359: ...ffective Not recommended to use this Please refers autocleanup group This parameter will not be used after the version number httpversion is equal or greater than 0400a autocleanup_maxage Not recommended to use this positive integer 6 6 To specify the expired days for automatic clean up For forward compatibility reservations but only group disk_i0_autocleanup is effective Not recommended to use th...

Page 360: ... _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 resolution_H is the value in current stream If the stream doesn t support ePTZ the permissions of this parameter must be set as 1 7 7 36 ePTZ Setting Group eptz_c 0 n 1 for n channel product capability_eptz ...

Page 361: ...eye is 1 1 7 Zoom speed It should be set by eCamCtrl cgi rather than by setparam cgi autospeed 1 5 1 4 Auto pan patrol speed Only available when capability_fisheye is 1 1 7 Auto pan patrol speed It should be set by eCamCtrl cgi rather than by setparam cgi rotatespeed 1 5 1 4 Rotate speed only for Fisheye series Only available when capability_fisheye is 1 and capability_fisheyelocaldewarp_c 0 n 1 i...

Page 362: ...19 _pos W H product dependent 1 4 Left top corner coordinate of the preset Only available when capability_fisheye is 1 1 7 Left top corner coordinate of the preset It should be set by ePreset cgi rather than by setparam cgi preset_i 0 19 _size WxH product dependent 1 4 Width and height of the preset Only available when capability_fisheye is 1 1 7 Width and height of the preset It should be set by ...

Page 363: ...ution_H is based on capability_image_ c 0 n 1 _focuswindow_range 7 38 Seamless Recording Setting Not recommended to use Group seamlessrecording capability_localstorage_seamless 0 We do not support this parameter when capability_nvideoin 1 PARAMETER VALUE SECURITY get set DESCRIPTION diskmode seamless manageable 1 6 seamless indicates enable seamless recording manageable indicates disable seamless ...

Page 364: ...ng is recording to local storage or not at present Read only We replace this parameter with seamlessrecording_c 0 n 1 _triggerrecord 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 used after the version number httpversion is equal or greater than 0400a guid 0 2 _id string 127 1 7 The connecte...

Page 365: ...ion number httpversion is equal or greater than 0400a 7 38 1 Seamless recording setting per channel Group seamlessrecording_c 0 n 1 for n channel products n denotes the value of capability_nvideoin capability_localstorage_seamless 0 PARAMETER VALUE SECURITY get set DESCRIPTION diskmode seamless manageable 1 6 seamless indicates enable seamless recording manageable indicates disable seamless record...

Page 366: ...a guid 0 k 1 _number 0 3 1 7 Number of connected seamless streaming with guid 0 k 1 _id Read only k denotes the value of seamlessrecording_c 0 n 1 _maxco nnection We support this parameter when the version number httpversion is equal or greater than 0312a 7 39 VIVOTEK Application Development Platform Setting Group vadp NAME VALUE SECURITY get set DESCRIPTION version string 6 7 Indicate the VADP ve...

Page 367: ...er want to upload it If the value is false save module to the internal storage space and it will occupy storage size number string 128 6 7 This number is used to register license key for VADP application status string 40 6 7 Indicate the hardware restore status Group vadp_hyperlink_i 0 n 1 Maximum of n 10 hyperlink is supported NAME VALUE SECURITY get set DESCRIPTION moduleidx 0 positive integer 1...

Page 368: ... The provider of the module vendorurl string 120 6 6 URL of the vendor version string 40 6 6 Version of the module license string 40 6 6 Indicate the license status of the module licmsg string 128 6 6 Indicate the message that will be show on license status when mouse over path string 40 6 6 Record the storage path of the module initscr string 40 6 6 The script that will handle operation commands ...

Page 369: ...ication with this topic will be transferred to event manager as trigger n is equal to ntrigger above 7 40 Camera PTZ Control Group camctrl capability_camctrl_ptztunnel 0 NAME VALUE SECURITY get set DESCRIPTION enableptztunnel boolean 1 4 Enable PTZ tunnel for camera control Group camctrl_c 0 n 1 for n channel products capability_ptzenabled 0 n denotes the value of capability_nvideoin and k denotes...

Page 370: ... 2 cameraid 0 255 1 4 Camera ID controlling external PTZ camera isptz 0 2 1 4 0 disable PTZ commands 1 enable PTZ commands with PTZ driver 2 enable PTZ commands with UART tunnel only available when capability_camctrl_c0_rs485 2 disablemdonptz boolean 1 4 Disable motion detection on PTZ operation 7 41 Camera PTZ Control IZ Series Group camctrl_c 0 n 1 for n channel products capability_camctrl_c0_zo...

Page 371: ...esponding ID panspeed 5 5 1 4 Pan speed tiltspeed 5 5 1 4 Tilt speed zoomspeed 5 5 1 4 Zoom speed autospeed 5 5 1 4 Auto pan speed focusspeed 5 5 1 4 Auto focus speed focusmode auto onetimeau to spotlight ma nual Available values are listed in capability_cam ctrl_c 0 n 1 _focusmode 1 4 Indicate the focus control mode uart 0 capability_nua rt 1 1 4 Select corresponding uart capability_nuart 0 only ...

Page 372: ...lable when capability_camctrl_c0_rs485 2 preset_i 0 k 1 _focus setting sync fixcurrent 1 4 The focus mode of each preset which is essential and should be grouped with preset_i 0 k 1 _name We support this parameter when the version number httpversion is equal or greater than 0305b patrolseq string 120 1 4 For external device The indexes of patrol points separated by patroldwelling string 160 1 4 Fo...

Page 373: ...leaction_enable boolean 1 4 Enable disable idle action while idle idleaction_type home 1 4 This field tells what kind of action should be taken while idle idleaction_interval 1 999 1 4 While idle over this time interval idle action will be taken PLEASE REFER TO PTZ CONTROL API 7 42 Camera PTZ Control SD Series Group camctrl_c 0 n 1 for n channel products the bit7 of capability_ptzenabled is 0 and ...

Page 374: ...5 1 4 Zoom speed autospeed 5 5 1 4 Auto pan speed focusspeed 5 5 1 4 Auto focus speed focusmode auto onetimeauto sp otlight manual Available values are listed in capability_camctrl_c 0 n 1 _focusmod e 1 4 Indicate the focus control mode preset_i 0 k 1 _name string 40 1 4 Name of the preset location preset_i 0 k 1 _pan capability_ptz_c 0 n 1 _minpan capability_ptz_c 0 n 1 _maxpan 1 4 Pan position a...

Page 375: ... at each preset location patrol_i 0 39 _name string 40 1 4 For internal device The name of patrol location patrol_i 0 39 _ dwelling 0 999 1 4 For internal device The dwelling time of each patrol location disablemdonptz boolean 1 4 Disable motion detection on PTZ operation defaulthome boolean 1 4 This field tells system to use default home position or not axisx capability_ptz_c 0 n 1 _minpan capabi...

Page 376: ...e idleaction_interval 1 999 1 4 While idle over this time interval idle action will be taken zoomenhance boolean 1 4 Enable disable zoom enhancement tour_index 1 0 19 1 4 Index of the enabled tour group from 0 to 19 Set 1 to disable all the tour groups tour_i 0 19 _name string 40 1 4 Name of the tour tour_i 0 19 _type boolean 1 4 0 Recorded tour 1 Preset tour tour_i 0 19 _speed 5 5 1 4 Preset tour...

Page 377: ...ore continuing a loop tour PLEASE REFER TO PTZ CONTROL API 7 43 UART Control Group uart capability_nuart 0 and capability_fisheye 0 NAME VALUE SECURITY get set DESCRIPTION ptzdrivers_i 0 19 127 _name string 40 1 4 Name of the PTZ driver ptzdrivers_i 0 19 127 _location string 128 1 4 Full path of the PTZ driver enablehttptunnel boolean 1 4 Enable HTTP tunnel channel to control UART Group uart_i 0 n...

Page 378: ...i 0 9 string 128 1 4 PTZ command for custom camera only available when capability_camctrl_c0_rs485 2 speedlink_i 0 4 _n ame string 40 1 4 Additional PTZ command name only available when capability_camctrl_c0_rs485 2 speedlink_i 0 4 _c md string 40 1 4 Additional PTZ command list only available when capability_camctrl_c0_rs485 2 ptzdriver 0 19 127 custom 128 no driver 1 4 The PTZ driver is used by ...

Page 379: ... 38400 57600 1 15200 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 indicate the end of a byte 2 Two stop bits are transmitted to indicate the end of a byte If you want to transfer the stopbit for 150 of the normal time used to transfer one bit the uart_i 0 n 1 _stopbit...

Page 380: ...UE SECURITY get set DESCRIPTION totalnumbers 0 positive integer 6 7 Totoal support number of the user lens profiles Group lens_default_i 0 n 1 n denotes the value of lens_default_totalnumbers NAME VALUE SECURITY get set DESCRIPTION name string 6 7 Default lens name Group lens_user_i 0 n 1 n denotes the value of lens_user_totalnumbers NAME VALUE SECURITY get set DESCRIPTION name string 6 7 User def...

Page 381: ...2P mode at ceiling or floor mount s 0 m 2 _region_ pan 90 359 1 4 Pan home angle of regional view for 1R mode Pan range of ceiling floor mount is 0 359 Pan range of wall mount is 90 90 s 0 m 2 _region_t ilt 90 90 1 4 Tilt home angle of regional view for 1R mode Tilt range of ceiling floor mount is 0 90 Tilt range of wall mount is 90 90 s 0 m 2 _region_ zoom 100 300 1 4 Zoom home ratio of regional ...

Page 382: ...et set DESCRIPTION enable boolean 1 1 Enable disable PIR 7 49 Auto Tracking Setting Group autotrack_c 0 n 1 capability_image_c 0 n 1 _autotrack_support 0 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION objsize_type 1 2 1 4 Type of object size 1 customized width and height 0 object size 30 x 30 1 object size 10 x 20 2 object size 10 x 10 objsize_customized_w ...

Page 383: ... 1 11 USA and Canada 1 13 Europe 10 11 Spain 10 13 France 1 14 Japan Only valid when wireless_wlmode is Adhoc encrypt none wep wpa wpa2 6 6 Encryption method none NONE wep WEP wpa WPA wpa2 WPA2PSK authmode OPEN SHARED 6 6 Authentication mode Only valid when wireless_encrypt is wep keylength 64 128 6 6 Key length in bits Only valid when wireless_encrypt is wep keyformat HEX ASCII 6 6 Key1 key4 pres...

Page 384: ...y Only valid when wireless_encrypt is wpa or wpa2 7 51 Shock Detection Group shock_c 0 n 1 for n channel products n denotes the value of capability_nvideoin capability_shockalarm_support 0 PARAMETER VALUE SECURITY get set DESCRIPTION alarm_enable boolean 4 4 Enable shock detection s alarm alarm_level 1 100 4 4 The value indicate the support strength level of shock detection s alarm 7 52 Stream Pro...

Page 385: ...s to be deleted alwaysmulticast boolean 1 6 Enable always multicast videoconfiguration_en able boolean 1 6 To enable the selected videoconfiguration source for this profile videoconfiguration_so urce c 0 n 1 s 0 m 1 n denotes the value of capability_nvideoin and m denotes the value of capability_nmediastr eam 1 6 The videoconfiguration source for the profile Ex videoconfiguration_source c 0 n 1 s ...

Page 386: ...e for the profile metadataconfiguratio n_source c 0 n 1 s0 n denotes the value of capability_nvideoin 1 6 The metadataconfiguration source for the profile Ex metadataconfiguration_source c 0 n 1 s0 indicates metadata stream of channel n and stream 1 is selected for the profile 7 53 Multicast Settings for Metadata Streaming Group metadata_c 0 n 1 _s0_multicast capability_media_streamprofiles_suppor...

Page 387: ... 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 digital output 1 to normal state waiting 30 seconds setting it to trigger state Example Drive the digital output 1 to triggered state reset do0 after 20 seconds and redirect to an empty page http myserver ...

Page 388: ...http 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 request requires Viewer privileges Method GET POST Syntax http servername cgi bin dido getdo cgi do0 do1 do2 do3 If no parameter is specified all the digital output statuses will be returned Return HTTP...

Page 389: ...ET 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 VALUE DESCRIPTION channel 0 capability_nvideoin 1 The channel number of the video source Default 0 resolution Available options are list in capability_videoin_c 0 n 1 _resolution Besides available op...

Page 390: ...y 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 value privilege value privilege value return return page PARAMETER VALUE DESCRIPTION method add Add an account to the server When using this method the username field is necessary It will use the default val...

Page 391: ...ator admin 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 parameter it will redirect to an empty page If the return page is invalid path it will ignore this parameter 8 6Upgrade Firmware Note This request requires Administrator privileges Method POST Syntax http servern...

Page 392: ...n 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 cgi bin camctrl eCamCtrl cgi channel 0 stream 1 vx 2 vy 2 vz 2 http myserver cgi bin camctrl eCamCtrl cgi channel 0 stream 1 x 100 y 100 videosize 640x480 resolution 640x480 stretch 0 In zoom operat...

Page 393: ...nt 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 are essential parameters in an area zoom case and the stream index is counted from 0 as the first stream http IPAddr cgi bin camctrl eCamCtrl cgi channel 0 stream 0 x 912 y 297 w 864 h 488 r esoluti...

Page 394: ...ndow 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 coordinate system 1 indicates that it usesvideosize plug in size as the range of the coordinate system speedpan 5 5 Set the pan speed speedtilt 5 5 Set the tilt speed speedzoom 5 5 Set the zoom speed speeda...

Page 395: ...positions 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 parameter it will redirect to an empty page If the return page is invalid path it will ignore this parameter 8 9ePTZ Preset Locations capability_eptz 0 and capability_fisheye 0 Note This request requires...

Page 396: ...t 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 cgi method del v4 v6 index value return retu rn page PARAMETER VALUE DESCRIPTION type NULL Get IP filter type allow deny Set IP filter type method addv4 Add IPv4 address into access list addv6 Add IPv...

Page 397: ...m 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 The contents of upstream should be base64 encoded to be able to pass through a proxy server This channel will help to transfer the raw data of UART over the network Please see UART tunnel spec for deta...

Page 398: ... 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 notification as well as camera control more efficiently The event and control formats are described in another document See Event control tunnel spec for detail information 8 13 Get SDP of Streams Note This request requires Viewer access pri...

Page 399: ...d Data capability_nuart 0 Note This request requires Viewer privileges Method GET POST Syntax http servername cgi bin viewer senddata cgi com value data value flush value wait value read value PARAMETER VALUE DESCRIPTION com 1 max com port number The target COM RS485 port number data hex decimal data hex decimal data The hex decimal data is a series of digits from 0 9 A F Each comma separates the ...

Page 400: ...their input arguments are as follows PARAMETER VALUE DESCRIPTION cmd_type string Required Command to be executed including search insert delete update and queryStatus Command search PARAMETER VALUE DESCRIPTION label integer primary key Optional The integer primary key column will automatically be assigned a unique integer triggerType text Optional Indicate the event trigger type Please embrace you...

Page 401: ... SS Please embrace your input value with single quotes Ex triggerTime 2008 01 01 00 00 00 If you want to search for a time period please apply TO operation Ex triggerTime 2008 01 01 00 00 00 TO 2008 01 01 23 59 59 is to search for records from the start of Jan 1st 2008to the end of Jan 1st 2008 limit positive integer Optional Limit the maximum number of returned search records offset positive inte...

Page 402: ...y key Required Identify the designated record Ex label 1 isLocked boolean Required Indicate if the file is locked or not Ex Update records whose key numbers are 1 and 5 to be locked status http servername cgi bin admin lsctrl cgi cmd update isLocked 1 label 1 label 5 Ex Update records whose key numbers are 2 and 3 to be unlocked status http servername cgi bin admin lsctrl cgi cmd update isLocked 0...

Page 403: ...iseconds setting it to trigger state Note that when the virtual input is waiting for next state it cannot accept new requests return return page Redirect to the page return page after the parameter is assigned The return page should be the relative path according to the root of camera If you omit this parameter it will redirect to an empty page If the return page is invalid path it will ignore thi...

Page 404: ...ork_rtsp_s m _accessname maxsft value tsmode value refti me value forcechk minsft value n is the channel index m is the timeshift stream index For details on timeshift stream please refer to the TimeshiftCaching documents PARAMETER VALUE DEFAULT DESCRIPTION maxsft positive integer 0 Request cached stream at most how many seconds ago The value must be a positive integer 0 tsmode normal adaptive nor...

Page 405: ...ve integer 0 How many seconds of cached stream client can accept at least Used by forcechk The value must be a positive integer 0 Return Code Description 400 Bad Request Request is rejected because some parameter values are illegal 415 Unsupported Media Type Returned if forcechk appears when minsft is not achievable or the timeshift feature of the target stream is not enabled 8 19 RemoteFocus capa...

Page 406: ... steps of zoom motor remote_focus_focus_motor_max Maximum steps of focus motor remote_focus_zoom_motor_start Start point of zoom motor remote_focus_zoom_motor_end End point of zoom motor remote_focus_focus_motor_start Start point of effective focal length remote_focus_focus_motor_end End point of effective focal length remote_focus_zoom_motor Current position of zoom motor remote_focus_focus_motor...

Page 407: ...if function zoom or function focus and direction forward and direction backward motor_max is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from function getstatus This parameter is for additional fine tune the value is from 1 to 30 iris N A Open iris or not It works only if function auto or function scan 8 20 BackFocus capability_image_c 0 n 1 _remotefocus 4 No...

Page 408: ... of iris getstatus Information of motors return value as below remote_focus_focus_motor_max Maximum steps of focus motor remote_focus_focus_motor_start Start point of effective focal length remote_focus_focus_motor_end End point of effective focal length remote_focus_focus_motor Current position of focus motor remote_focus_focus_enable Current function of focus motor remote_focus_iris_open The cur...

Page 409: ...ed from function getstatus This parameter is for additional fine tune the value is from 1 to 30 iris N A Open iris or not It works only if function auto or function scan 8 21 Export Files Note This request requires Administrator privileges Method GET Syntax For daylight saving time configuration file http servername cgi bin admin exportDst cgi For language file http servername cgi bin admin export...

Page 410: ...ed form data For language file http servername cgi bin admin upload_lan cgi Post data filename file name r n r n multipart encoded form data For setting backup file http servername cgi bin admin upload_backup cgi Post data filename file name r n r n multipart encoded form data Server will accept the file named file name to upload this one to camera 8 23 Update Lens Configuration capability_image_c...

Page 411: ...figuration and reboot camera http servername cgi bin admin update_lens cgi choose_reboot_lens value The camera will reboot after using this cgi For delete selected lens configuration http servername cgi bin admin update_lens cgi delete_lens value PARAMETER VALUE DESCRIPTION value string Available lens name Please refer to lens_default_i 0 n 1 _name lens_user_i 0 n 1 _name n is a positive integer M...

Page 412: ... The length of media of interest The unit is second loctime boolean 0 Specify if start end time is local time format 1 for local time 0 for UTC 0 file string N A The media file to be played tsmode positive integer N A Timeshift mode the unit is second Ex stime etime length file Description V V X X Play recordings between stime and etime rtsp 10 10 1 2 mod sdp stime 20110312_040400 000 etime 2011_0...

Page 413: ... 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 size of plug in ActiveX window in web page is the size of the privacy window size This field is not necessary it will use the default value if not specified 320x180 for 16 9 resolution and 320x240 for 4...

Page 414: ...ination 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 cgi channel 0 camid 1 move right http myserver cgi bin camctrl camctrl cgi channel 0 camid 1 zoom tele http myserver cgi bin camctrl camctrl cgi channel 0 camid 1 x 300 y 200 resolution 704x 480 video...

Page 415: ... 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 vs 0 127 Set the speed of movement 0 means stop x integer x coordinate clicked by user It will be the x coordinate of center after movement y integer y coordinate clicked by user It will be the y co...

Page 416: ...support 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 http myserver cgi bin camctrl camctrl cgi getpan Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n pan 4117 r n PARAMETER VALUE DESCRIPTION getversion string Get the versi...

Page 417: ...aximum 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 integer Get the maximum speed level of focus moving getminpan 0 positive integer Get the lower limit for pan position Only available when bit0 of capability_camctrl_c 0 n 1 _buildinpt is 1 getmaxpan ...

Page 418: ...position 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 ratio of digital zoom We support this parameter when the version number getversion is equal or greater than 5 0 0 14 getminfocus 0 positive integer Get the lower limit for focus position getmaxfocus 0 ...

Page 419: ...list 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 assigned The return page should be the relative path according to the root of camera If you omit this parameter it will redirect to an empty page If the return page is invalid path it will ignore this pa...

Page 420: ...ended 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 card is recommended to be replaced if the percentage reaches above 90 smartsd_data_size_per_unit Size in sectors of data to be written when Life Information1 is updated smartsd_num_of_sudden_power_failu...

Page 421: ...res 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 information 1 Wireless channel 2 Link quality 3 Signal level 4 Noise level 5 SNR 6 TX Rate 7 RX Rate 8 32 Get Wireless Signal Strength capability_network_wireless 0 Note This request requires Administrator pr...

Page 422: ...heral 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 channel value operation set washer_mode value Set washer mode washer_status value Set washer status washer_dwelltime value Set washer clean time heater_status value Set heater status Example http myserv...

Page 423: ...the 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 heater once Syntax for query API http servername cgi bin admin peripheral cgi channel value operation get supportdevice Get support peripheral device washer_supportmode Get washer support modes washer_mo...

Page 424: ...tus 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 washer clean period of washer control system heater_supportstatus N A Get the support status of heater control system heater_status N A Get the current heater status Normally it will be auto it mean...

Page 425: ...time 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 n 1 _irnum The number of IR that camera supports optimizedir_c 0 n 1 _irstrength Only available when irmode is set as manual It s a set of integers which indicate the strength of each IR LED e g 23 ...

Page 426: ...nnel 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 to be set as manual for adjusting IR LED strength strength 1 100 If the operation is set as set the number of strength values need to be the same as it of irnum However it needs only one value for s...

Page 427: ...imizedir_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 no cache r n r n ERROR Parameter irmode must be set as manual Example http myserver cgi bin admin optimizedir cgi channel 0 operation set strength 50 70 50 50 50 Response HTTP 1 0 200 OK r n Cache co...

Page 428: ...irnum 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 cache r n r n optimizedir_c0_irmode auto 8 36 Lens Thermal Control capabiltiy_image_c 0 n 1 _sensortype thermalsensor Note This request requires Administrator privileges Method GET POST Syntax for co...

Page 429: ... 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 shuttercompensate Camera will do shutter compensate Syntax for query API http servername cgi bin admin thermalctrl cgi operation get version value PARAMETER VALUE DESCRIPTION version N A Indicate lensctrl the...

Page 430: ...recording 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 seconds name string Name of the audio clip The audio clip the action applies to We support two interfaces name or index to specify the media clip to be played index 0 1 Number of the audio clip The aud...

Page 431: ...ue 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 ext4 Low compatibility for PC but high stability for Data fullformat 0 1 1 Completely clean data fat32 support only blockingmo de blocking blocking Send an HTTP response at the end of the format nonblo...

Page 432: ...blocking 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 Length Success Message Length r n r n Success Message List of success message 0 100 and 100 represents formatting completed List of error message ERROR You cannot format an SD card repeatedly ERROR For...

Page 433: ...rofiles_num 1 port is the rtsp port Please refer to the streamprofile group for requesting the stream profile token value for each profile Example Request the streaming of streamprofile_i0_token profile200 rtsp 192 168 1 1 554 media2 stream sdp profile profile200 Note If the requested certain profile streamprofile_i x _occupied 0 which indicates stream profile x has not been created the above meth...

Page 434: ...e multicast information via HTTP Note 1 This method is only valid when always multicast is enabled i e streamprofile_i x _alwaysmulticast 1 2 If the requested certain streamprofile_i x _profilename is empty which indicates stream profile x doesn t have a valid SDP file the above method of requesting SDP file will fail 3 If there existed two or more streamprofile_i x _profilename which have the sam...

Page 435: ... 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 CONTENT ONLY FOR PERSONAL USE 2 HEVC CONTENT THAT IS NOT OFFERED FOR SALE AND 3 HEVC CONTENT THAT IS CREATED BY THE OWNER OF THE PRODUCT THIS PRODUCT MAY NOT BE USED IN CONNECTION WITH HEVC ENCODED CONT...

Page 436: ...y cause harmful interference to radio communications Operation of this equipment in a residential area is likely to cause harmful interference in which case the user will be required to correct the interference at his own expense CE Mark Warning This is a Class A product In a domestic environment this product may cause radio interference in which case the user may be required to take adequate meas...

Reviews:

No comments

Brands by name

Popular brands

Load more brands