Vivotek IP9164-HT User Manual Download

Page: 284 / 424

VIVOTEK

284 - User's Manual

150

Group:

capability_daynight_c<0~(n-1)>

n denotes the value of "capability_nvideoin"

PARAMETER

VALUE

SECURITY
(get/set)

DESCRIPTION

support

0/7

Indicate whether the camera supports
day/night mode switch

builtinir

0/7

Indicate whether to support built-in IR
led.
* We replaced this parameter with

“capability_daynight_illuminators_builti
n_support” when

the version number

(httpversion) is equal or greater than
0312a.

builtinwled

0/7

Indicate whether to support built-in
white led.
* We replaced this parameter with

“capability_daynight_illuminators_builti
n_type=whiteled” when the version

number (httpversion) is equal or greater
than 0312a.

externalir

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

0/7

Indicate whether to support optimized
IR control technology.
* We replaced this parameter with

“capability_daynight_illumintators_opti
mizedir” when the version number

(httpversion) is equal or greater than
0312a.

smartir

0/7

Indicate whether to support smart IR.

ircutfilter

0/7

Indicate whether to support IR cut.

lightsensor

0/7

Indicate whether to support light
sensor.

Summary of Contents for IP9164-HT

Page 1: ...User s Manual Box Network Camera 2MP License Plate Capture P iris DC iris H 265 WDR Pro Remote Back Focus Smart Stream III SNV II 3DNR IP9164 HT IP9164 LPC Rev 1 0 ...

Page 2: ...mepage layout 41 System Logs 44 System Parameters 46 System Maintenance 47 Media Image 52 Media Video 67 Media Audio 78 Network General settings 80 Network Streaming protocols 87 Network SNMP Simple Network Management Protocol 98 Network FTP 99 Bonjour 100 Security User accounts 101 Security HTTPS Hypertext Transfer Protocol over SSL 103 Security Access List 110 PTZ PTZ settings 116 PTZ 119 Mechan...

Page 3: ...IP9164 camera is ideal for 24 7 license plate capture producing high detail polished images for reliable license plate recognition of cars travelling up to speeds of 110mph 180km h Equipped with a P iris lens and a headlight filter design the camera is capable of capturing clear high quality video with a resolution of 1920x1080 at a smooth 60 fps in any condition Further by employing VIVOTEK s WDR...

Page 4: ...e It is designed for various applications including video sharing general security surveillance etc The Configuration chapter suggests ways to best utilize the Network Camera and ensure proper operations For creative 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 P...

Page 5: ...oSD Card Slot Audio In Rear Panel Grounding screw IMPORTANT If DC power is preferred it should comply with O P 12VDC 2A min L P S per IEC 60950 1 Si l alimentation CC est préférable elle devrait être conforme avec ce qui suit Sortie 12 VCC 2 A min alimentation limitée à conformité CEI 60950 1 BNC connector IMPORTANT Please contact VIVOTEK s certified dealers for power adapters ...

Page 6: ...ne or acetone etc to clean as they may deform or cause damage to the product Also excessive cleaning could damage the surface 3 Check images for correct field of view pan tilt and zoom focus and adjust as necessary 4 Check and replace the Micro SD memory card as needed Stop edge recording before removing the Micro SD memory card Make sure that the Micro SD memory card is right side up and do not i...

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: ...ser s Manual Hardware Installation 2 Install the lens module to the camera 3 Connect the iris control cable to the socket on the camera 1 Jot down the camera s MAC address for later reference 0002D10766AD XXXXXX 1 ...

Page 9: ...ur camera please notice the specifications as below The screw mount distance A C must be shorter than 5 2mm in case that the bottom of screw mount may hit the IR Cut Filter 4 Install the camera stand to camera 5 Connect an Ethernet cable to the camera A C ...

Page 10: ...The DO pin can provide a 5V output and the max load is 50mA 12345678910 64GB 10 I 1 1 AC DC pw 12V or 24V 2 AC DC pw 3 RS485 4 RS485 5 DI common GND for all DIs 6 DI2 7 DI1 8 DO2 9 DO1 10 DO 5V Pin 1 is on the left Connect the ground wire to a grounded earth rod with a resistance smaller than 4Ω thicker than 18AWG to a ground rod 1 5 meters into the ground The grounding wire is user supplied ...

Page 11: ...with Protected Earth AC PE PE DC 0V 1 The DO pin provides 5V output voltage and the max load is 50mA 2 The max voltage for DO pins is 30VDC External power In order to control AC devices 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...

Page 12: ...h for VIVOTEK Video Receivers Video Servers or Network Cameras on the same LAN Double click on the camera s MAC address to open a web console with the camera Browser LAN Shepherd 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 13: ...anual 13 9 With a live view on screen enter Configuration Image Focus to adjust the image zoom and focus Click on the Auto focus button and let the camera find an optimal focus 8 Remove the sticker on the light sensor ...

Page 14: ...c and RED LED blinks consecutively every 0 15 sec Upgrading firmware 4 Green and RED blink every 0 15 sec Green and RED light on then blink again Restoring defaults 5 RED LED is on Green LED blinks and RED LED is constantly on Status after a reset network connected Green and RED LEDs are constantly on Status after a reset network disconnected You can purchase the AE 237 241 242 enclosure for outdo...

Page 15: ... 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 10 1 Run the Shepherd utility 10 2 The program will conduct an analysis of your network environment ...

Page 16: ...0 3 The program will search for all VIVOTEK network devices on the same LAN 10 4 After a brief search the installer window will prompt Click on the MAC and model name that matches the one printed on the product label You can then double click on the address to open a management session with the Network Camera Forceful Password Configuration 11 The first time you log in to the camera the firmware w...

Page 17: ...pecial ASCII characters are supported _ and You can use them in the password combination 11 2 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 18: ... LED rapidly blinks Note that all settings will be restored to factory default Upon successful restore the status LED will blink green and red during normal operation MicroSD SDHC SDXC Card Capacity This network camera is compliant with SD SDHC SDXC 16GB 8GB 32GB 64GB and other preceding standard SD cards Reset Button Network Deployment General Connection PoE When using a PoE enabled switch The Ne...

Page 19: ... 1 LAN Local Area Network Router IP address 192 168 0 1 WAN Wide Area Network Router IP address from ISP Cable or DSL Modem POWE R COLLIS ION LINK R E CE IVE PAR TITION 1 2 3 4 5 Internet When using a non PoE switch Use a PoE power injector optional to connect between the Network Camera and a non PoE switch PoE Power Injector optional NOTE 1 The camera is only to be connected to PoE networks witho...

Page 20: ...is case if the Local Area Network LAN IP address of your Network Camera is 192 168 0 3 please forward the following ports for the Network Camera on the router HTTP port default is 80 RTSP port default is 554 RTP port for video default is 5556 RTCP port for video default is 5557 If you have changed the port numbers on the Network page please open the ports accordingly on your router For information...

Page 21: ...ration options such as that of streaming ports please refer to Configuration Network Settings VIVOTEK also provides the automatic port forwarding feature as an NAT traversal function with the precondition that your router must sup port the UPnP port forwarding feature ...

Page 22: ...uld prompt as shown below 2 You should be able to see live video from your camera You may also download and install the 32 channel recording software from VIVOTEK s website in a deployment consisting of multiple cameras For its installation details please refer to its related documents ...

Page 23: ...unch your web browser e g Microsoft Internet Explorer or Mozilla Firefox 2 Enter the IP address of the Network Camera in the address field Press Enter 3 Live video will be displayed in your web browser 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 NOTE For Mozill...

Page 24: ...tection please refer to Security on page 101 If you see a dialog box indicating that your security settings prohibit running ActiveX Controls please enable the ActiveX Controls for your browser 1 Choose Tools Internet Options Security Custom Level 2 Look for Download signed ActiveX controls select Enable or Prompt Click OK 3 Refresh your web browser then install the ActiveX control Follow the inst...

Page 25: ... 32 bit IE browser will be opened IMPORTANT 1 The onscreen Java control can malfunction under the following situations A PC con nects to different cameras that are using the same IP address or the 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 dis able the Comp...

Page 26: ...4 please set the RTSP port to 554 For more information please refer to RTSP Streaming on page 88 For example 4 The live video will be displayed in your player For more information on how to configure the RTSP access name please refer to RTSP Streaming on page 88 for details rtsp 192 168 5 151 554 live1s1 sdp 1 Launch the RTSP player 2 Choose File Open URL A URL dialog box will pop up 3 The address...

Page 27: ...will not be able to use a large video size Please set the video streaming parameters as listed below For more information please refer to Stream settings on page 67 Video Mode H 264 Frame size 176 x 144 Maximum frame rate 5 fps Intra frame period 1S Video quality Constant bit rate 40kbps 3 As most ISPs and players only allow RTSP streaming through port number 554 please set the RTSP port to 554 Fo...

Page 28: ...multaneous monitoring and video recording for multiple Network Cameras Please install the recording software then launch the program to add the Network Camera to the Channel list For detailed information about how to use the recording software please refer to the user s manual of the software or download it from http www vivotek com ...

Page 29: ...multiple streams streams 1 and 2 simultaneously You can select any of them for live viewing For more information about multiple streams please refer to page 67 for detailed information Manual Trigger Click to enable disable an event trigger manually Please configure an event setting on the Application page before you enable this function A total of 3 event configuration can be configured For more ...

Page 30: ... cell will resize automatically to fit the monitor Click 100 is to display the original homepage size Click 50 is to resize the homepage to 50 of its original size Click 25 is to resize the homepage to 25 of its original size Live Video Window The following window is displayed when the video mode is set to H 264 or H 265 Video Title The video title can be configured For more information please ref...

Page 31: ...tion on page 116 For more information about how to set up the viewing region of the current video stream please refer to page 116 The viewing region of the curruent video stream The largest frame size PTZ Panel This Network Camera supports digital e PTZ pan tilt zoom control which allows roaming a smaller view frame within a large view frame Please refer to PTZ settiings on page 116 for detailed i...

Page 32: ...ording button to end recording When you exit the web browser video recording stops accordingly To specify the storage destination and file name please refer to MP4 Saving Options on page 35 for details Volume When the Mute function is not activated move the slider bar to adjust the volume on the local computer Mute Turn off the volume on the local computer The button becomes the Audio On button af...

Page 33: ... button to capture 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 Digital Zoom Click and uncheck Disable digital zoom to enable the zoom operation The navigation screen indicates the part of the image being magnified To control the zoom level drag the slider bar To move to a di...

Page 34: ...ch unicast client connecting to the server takes up additional bandwidth and the Network Camera allows up to ten simultaneous accesses UDP multicast This protocol allows multicast enabled routers 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 u...

Page 35: ...o append the date and time to the end of the file name Local Streaming Buffer Time Due to the unsteady bandwidth flow the live streaming may lag and not be very smoothly If you enable this option the live streaming will be stored temporarily on your PC s cache memory for a few seconds before being played on the live viewing window This will help you see the streaming more smoothly If you enter 3 0...

Page 36: ...here are multiple from the Selected joystick menu If your joystick is not detected if may be defective 2 Click Calibrate or Configure buttons to configure the joystick related settings If you want to assign Preset actions to your joystick the preset locations should be configured in advance in the Configuration PTZ page If your joystick is not working properly it may need to be calibrated Click th...

Page 37: ... The number of buttons may differ from different joysticks Please follow the steps below to configure your joystick buttons 1 Choosing one of the actions and click Assign will pop up a dialog Then you can assign this action to a button by pressing the joystick button or select it from the drop down list For example Assign Home move to home position to Button 1 2 Click OK to confirm the configurati...

Page 38: ... not sure of the locations of each button use the Properties window in the Game Controllers utility Tips 3 Click the Assign button to assign an action to the button You can delete an association by selecting a button number and then click the Delete button Repeat the process until you are done with the configuration of all preferred actions The buttons you define should appear on the button list a...

Page 39: ...ion item When you click on the first sub item the detailed information for the first sub item will be displayed when you click on the second sub item the detailed information for the second sub item will be displayed and that of the first sub item will be hidden The following is the interface of the main page Configuration List Firmware Version Navigation Area Each function on the configuration li...

Page 40: ...ault time servers The precondition is that the camera must have the access to the Internet Update interval Select to update the time using the NTP server on an hourly daily weekly or monthly basis Time zone Select the appropriate time zone from the list If you want to upload Daylight Savings Time rules please refer to System Maintenance Import Export files on page 48 for details System General set...

Page 41: ...page 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 that is placed 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 ...

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

Page 43: ...you want to change the color on the right column 3 The palette window will pop up as shown below 4 Drag the slider bar and click on the left square to select a desired color 5 The selected color will 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 44: ...rver 3 When completed click Save to enable the setting You can configure the Network Camera to send the system log file to a remote server as a log backup Before utilizing this feature it is suggested 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...

Page 45: ...sage Email GSM Modem HTTP Digital output VIVOCloud PTZ Deterrent FTP You can install the included VAST recording software which provides an Event Management function group for delivering event messages via emails GSM short messages onscreen event panel or to trigger an alarm etc For more information refer to the VAST User Manual ...

Page 46: ... and administrators in a chronological order The access log is stored in the Network Camera s buffer area and will be overwritten when reaching a certain limit System Parameters The View Parameters page lists the entire system s parameters If you need technical assistance please provide the information listed on this page ...

Page 47: ...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 48: ... modules 3rd party software stored on the SD card and related settings Focus position Retain the lens focus position using the previously saved position parameters Lens configuration If you apply a different lens to the camera you can upload a different configuration file containing an image library for the specific lens module without updating the entire firmware Please contact VIVOTEK s technica...

Page 49: ...rt daylight saving time configuration file Click to set the start and end time of DST Daylight Saving Follow the steps below to export 1 In the Export files column click Export to export the daylight saving time configuration file from the Network Camera 2 A file download dialog will pop up as shown below Click Open to review the XML file or click Save to store the file for editing ...

Page 50: ...e 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 the incorrect date and time are assigned you will see the following warning message when uploading the file to the Network Camera ...

Page 51: ...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 scenario a Power d...

Page 52: ...ve viewing window and the maximum zoom in will be up to 4 times Position of timestamp and video title on image Select to display time stamp and video title on the top or at the bottom of the video stream Timestamp 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 Color Select ...

Page 53: ...ous with its wide horizontal view With video rotation the camera can more readily cover the field of view on a tall and narrow scene The rotation here indicates clockwise rotation Rotation can be applied with flip mirror and physical lens rotation see below settings to adapt to different mounting locations The figures in the illustration are shown in a consecutive order Video orientation Flip vert...

Page 54: ...t thus helping to improve low light sensitivity Synchronize with digital input The Network Camera automatically removes the IR cut filter when a Digital Input is triggerred For example the digital input can come from a housing that is equipped with IR illumination and control circuits such as VIVOTEK s AM 214 Schedule mode The Network Camera switches between day mode and night mode based on a spec...

Page 55: ... The Smart IR function is more beneficial when the spot of intrusions or an object of your interest is close to the lens and the IR lights For example if an intruder has a chance of getting near the range of 3 meters 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 benefit...

Page 56: ...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 56 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 57: ...ent Brightness Adjust the image brightness level which ranges from 0 to 100 Contrast Adjust the image contrast level which ranges from 0 to 100 Saturation Adjust the image saturation level which ranges from 0 to 100 Sharpness Adjust the image sharpness level which ranges from 0 to 100 Gamma curve This option is disabled when the WDR function is enabled Adjust the image sharpness level which ranges...

Page 58: ...on in order to reduce noises and flickers in image This applies to the onboard 3D Noise Reduction feature Use the pull down menu to adjust the reduction strength Note that applying this function to the video channel will consume system computing power 3D Noise Reduction is mostly applied in low light conditions When enabled in a low light condition with fast moving objects trails of after images m...

Page 59: ...e where low light objects are posed against an extremely bright background You may want to exclude the bright sunlight shining through a building s corridor Full view 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 ...

Page 60: ...ds to be compensated by electrical brightness gains The inclusive window refers to the weighed window the exclusive window refers to ignored window It adopts the weighted averages method to calculate the value The inclusive windows have a higher priority You can overlap these windows and if you place an exclusive window within a larger inclusive window the exclusive part of the overlapped windows ...

Page 61: ...he shaded area and the light behind the objects 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 day night schedule mode please click Profile mode to open the Profile of exposure settings page as shown below Activated period Sele...

Page 62: ...umns Please refer to previous dicussions for detailed information 4 Click Save to enable the setting and click Close to exit the page Lens configuration If you apply a different lens to the camera you can upload a different configuration file containing an image library for the specific lens module without updating the entire firmware Please contact VIVOTEK s technical support for the supported Le...

Page 63: ... of cameras the auto focus function can be very helpful when these cameras become out of focus after days or weeks of operation And that can easily result from the effects of natural forces e g shrink and expand due to a wide range of operating temperatures and the vibration caused by wind Focus window x Use the Media Image Focus function to tune for a best image focus on your target area If using...

Page 64: ...TEK 64 User s Manual If using an iCS lens model use the auto focus function for an optimal image The configuration page automaticallly displays different options according to the lens you installed iCS lens ...

Page 65: ...lete After a short while the clearest image obtained should be displayed and the optimal focus range achieved Use the arrow marks on the sides to fine tune the focus if you are not satisfied with the results You may still need to use the arrow marks to fine tune the focus depending on the live image on your screen means moving from wide to tele end and tele to wide Below is the procedure to perfor...

Page 66: ...u can use 4 mouse clicks to create a new masking window 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 Click on the Enable privacy mask checkbox to enable this function Up to 5 privacy mask windows can be configured on the same screen If you want to delete the privacy mask window pleas...

Page 67: ...a Video Mode Resolution and Frame rate With the WDR Pro enabled for the high contrast environment the maximum frame rate is 30fps Without the WDR function you can enjoy a higher frame rate for up to 60fps e g in traffic monitoring ...

Page 68: ...wing region and the Output Frame Size size of the live view window Click Viewing Window to open the viewing region settings page On this page you can configure the Region of Interest and the Output Frame Size for a video stream For example you can crop only a portion of the image that is of your interest and thus save the bandwidth needed to transmit the video stream As shown below the area of you...

Page 69: ...ew Window Region of Interest Output frame size Stream 1 1920 x 1080 640 x 360 Selectable 1920 x 1080 640 x 360 Selectable Stream 2 1920 x 1080 640 x 360 Selectable 1920 x 1080 640 x 360 Selectable Stream 3 1920 x 1080 640 x 360 Selectable 1920 x 1080 640 x 360 Selectable NOTE Please follow the steps below to set up those settings for a stream 1 Select a stream for which you want to set up the view...

Page 70: ...emote viewing on mobile phones and a larger video size and a higher bit rate for live viewing on web browsers or recording the stream to an NVR Note that a larger frame size takes up more bandwidth Maximum frame rate This limits the maximum refresh frame rate per second Configure the frame rate higher for smoother video viewing and for recognizing moving objects in the field of view If the power l...

Page 71: ...Static scene Activities P P P P I P P P P P P P I P P P P P P P I By dynamically prolonging the intervals for I frames insertion to up to 10 seconds the bit rates 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...

Page 72: ...r the encoding returns to normal to deliver real time streaming f1 f1 f1 f1 f5 f5 f5 f5 f9 Comparing with Smart Stream II Smart Stream III has two more configurable options Smart Q and Smart FPS NOTE f1 f1 f1 f1 f5 f5 f5 f5 f9 f1 f1 f3 f4 f5 f6 f7 f8 f9 Motions Occur 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 k...

Page 73: ...s to normal when one or more objects move in that area The remainder of the screen where there are no moving objects no pixel changes will still be transmitted in low quality format Manual The Manual 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 ...

Page 74: ...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 75: ... streams around or within the bit rate limitation you impose Policy If Frame Rate Priority is selected the Network Camera will try to maintain the frame rate per second performance while the image quality will be compromised If Image quality priority is selected the Network Camera may drop some video frames in order to maintain image quality Smart Q Select ON or OFF to enable or disable the featur...

Page 76: ... the Fixed quality configuration can ensure a reasonable and limited use of network bandwidth 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 gain Fixed quality On the other hand if Fixed quality is selected all frames are transmitted with the same quality bandwidth utilization is the...

Page 77: ...er video quality If the power line frequency is set to 50Hz at the 5MP resolution the frame rates are selectable at 1fps 2fps 3fps 5fps 8fps 10fps and 12fps If the power line frequency is set to 60Hz the frame rates are selectable at 1fps 2fps 3fps 5fps 8fps 10fps and 12fps You can also select Customize and manually enter a value The frame rate will decrease if you select a higher resolution Video...

Page 78: ...layed External microphone input Select the gain of the external audio input according to ambient conditions Adjust the gain from 21 db most sensitive or 33 db least sensitive Audio type Select audio codec and the sampling bit rate G 711 also provides good sound quality and requires about 64Kbps Select pcmu μ Law or pcma A Law mode G 726 is a speech codec standard covering voice transmission at rat...

Page 79: ...d 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 wav format are supported The maximum size of the audio file to be uploaded is 2 000Kbytes The voice alert is enable...

Page 80: ... 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 provided by y...

Page 81: ... router so that video streams can be sent out from a LAN To utilize of this feature make sure that your router supports UPnPTM and it is activated PPPoE Point to point over Ethernet Select this option 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 th...

Page 82: ...Error Router does not support UPnP port forwarding Steps to enable the UPnPTM user interface on your computer Note that you must log on to the computer as a system administrator to install the UPnPTM 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 dialog ...

Page 83: ...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 84: ... 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 85: ... format Please refer to HTTP streaming on page 87 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 item t...

Page 86: ...VIVOTEK 86 User s Manual ...

Page 87: ...ber between 1025 and 65535 If the ports are incorrectly assigned the following warning messages will be displayed To access the Network Camera on the LAN both the HTTP port and secondary HTTP port can be 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...

Page 88: ...ges will be displayed in your web browser NOTE Microsoft Internet Explorer does not support server push technology therefore you will not be able to access a video stream using http ip address http port access name for stream 1 2 3 RTSP Streaming To utilize RTSP streaming authentication make sure that you have set a password for controlling the access to video stream first Please refer to Security...

Page 89: ...le when the access name for stream 1 is set to live1s1 sdp 1 Launch an RTSP player 2 Choose File Open URL A URL dialog box will pop up 3 Type the above URL command in the text box 4 The live video will be displayed in your player as shown below RTSP port RTP port for video audio RTCP port for video audio RTSP Real Time Streaming Protocol controls the delivery of streaming media By default the port...

Page 90: ...one and thus is always odd When the multicast RTP port changes the multicast RTCP port will change accordingly If the multicast RTP video ports are incorrectly assigned the following warning message 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 Initial TTL Scope 0 Restricted to the same host 1 Restricted ...

Page 91: ... 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 or H 265 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 34 and Stream settings on page 67 SIP SIP is short for Session Initiation Protocol If necessary you can cha...

Page 92: ...6 Mute Mic Volume Talk Button Video TCP AV Audio is being transmitted to the Network Camera Click to enable audio transmission to the Network Camera click to adjust the volume of microphone click to turn off the audio To stop talking click again ...

Page 93: ...MAC address This service will examine if the host name is valid and automatically open a port on your router If using DDNS the user has to manually configure UPnP port forwarding Express Link is more convenient and easier to set up Please follow the steps below to enable Express Link 1 Make sure that your router supports UPnP port forwarding and it is activated 2 Check Enable express link 3 Enter ...

Page 94: ...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 of the Service Agreement 2 In the Register column fill in the Host name xxxx safe100 net Email Key and Confirm Key and click Register After a host name has been successfully created a success message...

Page 95: ... 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 column 4 Select Enable DDNS and click Save to enable the setting Forget key Click this b...

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

Page 97: ...them a particular forwarding treatment for example how much bandwidth to reserve for it Below are the setting options of DSCP DiffServ Codepoint Specify the DSCP value for each application 0 63 Note that different vendors of network devices might have different methodologies and unique implementations Shown below is a sample corresponding information from a Cisco switch You should enter a DSCP tag...

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

Page 99: ...rmware disabled the FTP port for security concerns You can manually enable the FTP server service to enable the FTP function You can disable the FTP server function when it is not in use FTP port The FTP server 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 t...

Page 100: ...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 101: ...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 102: ...elect 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 Please refer to Configuration on page 39 Allow anonymous viewing If you select this item any client can access the live stream without entering a User ID and Password ...

Page 103: ...mmunication with the Network Camera a Certificate must be created first There are three ways to create and install a certificate Create self signed certificate 1 Select this option from a pull down menu 2 In the first column select 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 Informati...

Page 104: ...ted connection 6 If your web session does not automatically change to an encrypted HTTPS session click Home to return to the main page Change the URL address from http to https in the address bar and press Enter on your keyboard Some Security Alert dialogs will pop up Click OK or Yes to enable HTTPS https 192 168 5 151 index html https ...

Page 105: ...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 106: ...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 107: ... User s Manual 107 7 Open a new edit paste the certificate contents and press ENTER at the end of the contents to add an empty line 8 Convert file format from DOS to UNIX Open File menu Conversions DOS to Unix ...

Page 108: ...nual 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 109: ... 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 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 ...

Page 110: ... How much time the client has been at the webpage User ID If the administrator has set a password for the webpage the clients have to enter a user name and password to access the live video The user name will be displayed in the User ID column If the administrator allows clients to link to the webpage without a user name and password the User ID column will be empty There are some situations that ...

Page 111: ...rarily and will automatically try to re link again IE Explore or Quick Time Player Filter Enable access list filtering Check this item and click Save if you want to enable the access list filtering function Filter type Select Allow or Deny as the filter type If you choose Allow Type only those clients whose IP addresses are on the Access List below can access the Network Camera and the others cann...

Page 112: ... IP address Always allow the IP address to access this device You can check this item and add the Administrator s IP address in this field to make sure the Administrator can always connect to the device IP address range 192 168 2 x will be bolcked There are three types of rules Single This rule allows the user to add an IP address to the Allowed Denied list For example 192 168 2 1 If IPv6 filter i...

Page 113: ...thentication 2 Authenticator an access point or a switch A go between which restricts unauthorized end users from communicating with the authentication server 3 Authentication server usually a RADIUS 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...

Page 114: ...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 115: ...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 116: ...canner via the RS485 interface Digital PTZ Operation E PTZ Operation The e PTZ control settings section will be displayed as shown below For e PTZ related details please refer to page 118 Auto pan patrol speed Select the speed from 1 5 slow fast to set up the Auto pan patrol speed control Zoom factor display If you check this item the zoom indicator will be displayed on the home page when you zoom...

Page 117: ...iewing region accordingly Moving Instantly If you check this item the live view window will switch to the new viewing region instantly after you move the floating frame If not selected the process of moving from one position to another will be shown Click on Image The e PTZ function also supports Click on Image When you click on any point of the Global View Window or Live View Window the viewing r...

Page 118: ...ions list 3 Set the Dwelling time for the preset location during an auto patrol 4 If you want to delete a preset location from the Patrol locations list select it and click Remove 5 Select a location and click to rearrange the patrol order 6 Select patrol locations you want to save in the list and click Save to enable the patrol settings 7 To implement the patrol schedule please go to homepage and...

Page 119: ...en you can configure the PTZ driver and RS485 port with the following settings VIVOTEK provides the following PTZ drivers DynaDome SmartDOME Lilin PIH 7x00 Pelco D and Pelco P protocol If none of the above PTZ drivers is supported by your PTZ scanner please select Custom camera scanner Please refer to the documentation of your PTZ scanner to determine the Camera ID PTZ driver and Port settings The...

Page 120: ...the configuration window A total of 20 preset positions can be configured Please follow the steps below to configure preset positions 1 Adjust the shooting area to the desired position using the buttons on the right side of the window 2 Enter a name for the preset position which allows for up to forty characters Click Add to enable the settings The preset positions will be displayed under the Pres...

Page 121: ...k Camera will move to the selected preset position Click Patrol The Network Camera will patrol along the selected positions repeatedly NOTE Home page in Mechanical PTZ Mode The Preset Positions will also be displayed on the home page Select one from the drop down list and the Network Camera will move to the selected preset position ...

Page 122: ...iggered you can specify what type of action that will be performed You can configure the Network Camera to send snapshots or videos to your email address or FTP site Event To configure an event with reactive measures such as recording video or snapshots it is necessary to configure the server and media settings so that the Network Camera will know what action to take such as which server to send t...

Page 123: ...nism or external digital input devices There are several choices of trigger sources as shown on the next page Select the item to display the detailed configuration 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 information please refer to Motio...

Page 124: ...ement to motion detection or as a method to detect activities not covered by the camera s view VADP It is presumed that you already uploaded and enabled the VADP modules before you can associatee VADP triggers with an Event setting Click on the Set VADP Trigger button to open the VADP setup menu The triggering conditions available with 3rd party software modules known as VADP will be listed Use th...

Page 125: ...a when a trigger is activated Trigger digital output for seconds Select this option to turn on the external digital output device when a trigger is activated Specify the length of the trigger interval in the text box Once the triggers are configured they will be listed under the VADP option ...

Page 126: ... you ve configured Note that please configure Preset locations first For detailed information please refer to page 116 Another checkbox will appear Capture media after moving to the location You can select to record associated snapshot video clip or system event once the event is triggered and the camera moves to the preset location See Add Media in the following discussion Play audio clip A pre l...

Page 127: ...e detailed configuration options You can configure either one or all of them Server type Email Select to send the media files via email when a trigger is activated Server name Enter a name for the server setting Sender email address Enter the email address of the sender Recipient email address Enter the email address of the recipient Server address Enter the domain name or IP address of the email ...

Page 128: ...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 name of the FTP account Pass...

Page 129: ...ndow as shown below If successful you will also receive a test txt file on the FTP server Click Save server to enable the settings Server type HTTP Select to send the media files to an HTTP server when a trigger is activated Server name Enter a name for the server setting URL Enter the URL of the HTTP server User name Enter the user name if necessary Password Enter the password if necessary To ver...

Page 130: ...twork Storage If you click the View button for an SD card a Local storage page will prompt so that you can manage the recorded files on SD card For more information about Local storage please refer to page 153 If you click the View button for a Network storage a file directory window will prompt for you to view recorded data on Network storage For detailed illustration please refer to the next pag...

Page 131: ...orded data Click to go back to the previous level of the directory The format is HH 24r Click to open the file list for that hour The format is File name prefix Minute mm You can set up the file name prefix on Add media page Please refer to next page for detailed information 2020 01 20 2020 01 20 2020 01 20 2020 01 20 ...

Page 132: ...ots from any of the video streams Send pre event images The Network Camera has a buffer to temporarily hold data up to a certain limit Enter a number to decide how many images to capture before a 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 example if ...

Page 133: ...ream as the source of video clip Pre event recording The Network Camera has a buffer to temporarily hold data up to a certain limit Enter a number to decide the duration of recording before a trigger is activated Up to 9 seconds can be set Maximum duration Specify the maximum recording duration in seconds The duration can be up to 10 seconds For example if pre event recording is set to five second...

Page 134: ...dence File name prefix Enter the text that will be appended to the front of the file name For example Click Save media to enable the settings Media type System log Select to send a system log when a trigger is activated Click Save media to enable the settings then click Close to exit the page Video_20200113_100341 Date and time sufﬁx The format is YYYYMMDD_HHMMSS File name preﬁx ...

Page 135: ... Status is ON the event configuration above is triggered by motion detection the Network Camera will automatically send snapshots via e mail If you want to stop the event trigger you can click on the ON button to turn it to OFF status or click the Delete button to remove the event setting To remove a server setting from the list select a server name from the drop down list and click Delete Note th...

Page 136: ...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 technical support 20200213 20200213 Click to upload a file Click to modify the script online ...

Page 137: ...em size to trigger an alarm Change the item size according to the live view To delete a window click the X mark on the right of the window name 3 Define the sensitivity to moving objects by moving the Sensitivity slide bar Note that a high sensitivity is prone to produce false alarms such as the fast changes of light such as day night mode switch turning lights on off A movement must persist longe...

Page 138: ...as shown below Another three motion detection windows can be configured on this page Larger than the min item size Photos or videos can be captured instantly and configured to be sent to a remote server via an Email or FTP server For more information on how to configure an event setting please refer to Event settings on page 122 Please follow the steps beolw to set up a profile 1 Create a new moti...

Page 139: ...um item size is a threshold value that determines how many alerted pixels can trigger an event When the size of an intruding object is larger than the minimum size and its movement persist for 0 3 second the motion is judged to exceed the defined threshold and the motion window will be outlined in red With a large minimum item size the size of moving object in frame C is considered as smaller than...

Page 140: ...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 123 for detailed information ...

Page 141: ...aved 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 Too bright shining a flash light The average lighting level of the scene is taken into consideration Too dark covering the objective or spraying paint Too blu...

Page 142: ... 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 143: ... Refer to page 78 for Audio settings and page 70 for video streaming settings You can use the Profile window to configure a different Audio detection setting For example a place can be noisy in the day 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 144: ...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 109 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 145: ...whether the module fits the predefined VADP requirements Please contact our technical support or the vendor of your 3rd party module for the parameters contained within Users can also run VIVOTEK s VADP packages as a means to access updated functionality instead of replacing the entire firmware Note that for some cameras the flash is too small to hold VADP packages These cameras will have its Save...

Page 146: ... By then the module status will become OFF and the X button will appear at the end of the row Click on the X button to remove an existing module When prompted by a confirm message Click Yes to proceed 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 147: ...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 148: ...ing 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 Recording name Enter a name for the recording setting Enable this recording Select this option to enable video recording With adaptive recording Select this option will activate the frame rate control according to alarm t...

Page 149: ...ed on Camera A will the server record the full frame rate streaming data otherwise it will only request the I frame data during normal monitoring thus effectively saves bandwidths and storage space 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 t...

Page 150: ...etails in the following NAS server Click Add NAS server to open the server setting window and follow the steps below to set up 1 Fill in the information for your server For example 2 Click Test to check the setting The result will be shown in the pop up window 1 2 3 4 Network storage path server name or IP address folder name User name and password for your server ...

Page 151: ...maximum capacity is reached the oldest file will be overwritten by the latest one The reserved amount is reserved for the transaction stage when the storage space is about to be full and new data arrives The minimum for the Reserved space must be larger than 15 MegaBytes Recording file management You can manually assign the Maximum duration and the Maximum file size for each recording footage You ...

Page 152: ...n about folder naming rules please refer to page 130 for details 20200210 20200211 20200212 If you want to enable recording notification please click Event to configure event triggering settings Please refer to Event Event settings on page 122 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 recor...

Page 153: ...his column shows the status and reserved space of your SD card Please remember to format the SD card when using for the first time no SD card NOTE It is recommended to turn OFF the recording 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 ...

Page 154: ... Enable automatic disk cleanup Check 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 NAS management On the NAS setup page you can configure your NAS Networked Storage configuration test mount or unmount the networked storage You can use the Test button to ...

Page 155: ...1GB for a network share Enable cyclic storage Check this item if you want to enable cyclic recording When the maximum capacity is reached the oldest file will be overwritten by the latest one Enable automatic disk cleanup Check 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 network share for 7 days Click Sav...

Page 156: ...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 157: ...hich will highlight the selected item A Play window will appear on top for immediate review of the selected file For example Download Click on a search result to highlight the selected item in purple 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 158: ...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 159: ...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 160: ...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 161: ...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 162: ...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 163: ...163 2019 VIVOTEK INC All Right Reserved 29 http 192 168 0 123 cgi bin admin getparam cgi network_ipaddress Response HTTP 1 0 200 OK r n Content Type text html r n Context Length 33 r n r n network ipaddress 192 168 0 123 r n ...

Page 164: ...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 165: ... that you set and are readable will be returned Example Set the IP address of server to 192 168 0 123 Request http myserver cgi bin admin setparam cgi network_ipaddress 192 168 0 123 Response HTTP 1 0 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 166: ...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 167: ...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 168: ...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 169: ... Astana Dhaka Sri Jayawardenepura 260 GMT 06 30 Rangoon 280 GMT 07 00 Bangkok Hanoi Jakarta Krasnoyarsk 320 GMT 08 00 Beijing Chongging Hong Kong Kuala Lumpur Singapore Taipei 360 GMT 09 00 Osaka 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 170: ...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 171: ...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 172: ...7 ODM specific model name of server eg DCS 5610 If it is not an ODM model this field will be equal to modelname serialnumber mac address 1 7 12 characters MAC address without hyphens firmwareversion 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 173: ...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 174: ...e ntsc pal 1 7 The actual modulation type Only available when capability_videoin_type is 0 or 1 7 3Digital Input Behavior Define Group di_i 0 n 1 for n is the value of capability_ndi capability_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 val...

Page 175: ...y_ndo 0 privilege_camctrl view operator admin 1 6 Indicate which privileges and above can control PTZ capability_ptzenabled 0 or capability_eptz 0 user_i0_name string 64 6 7 User name of root user_i 1 20 _name string 64 6 7 User name user_i0_pass password 64 7 6 Root password user_i 1 20 _pass password 64 7 6 User password user_i0_privilege view operator admin 6 7 Root privilege user_i 1 20 _ priv...

Page 176: ... It s recommended to set this parameter when change a service port to the port occupied by another service currently Otherwise the service may fail Stopped service will auto start after changing port settings Ex Change HTTP port from 80 to 5556 and change RTP port for video from 5556 to 20480 Then set preprocess 9 to stop both service first cgi bin admin setparam cgi network_preprocess 9 network_h...

Page 177: ...eap eap tls 6 6 Selected EAP method identity_peap string 64 6 6 PEAP identity identity_tls string 64 6 6 TLS identity password string 200 7 6 Password for TLS privatekeypassword string 200 7 6 Password for PEAP ca_exist boolean 6 6 CA installed flag ca_time 0 positive integer 6 7 CA installed time Represented in EPOCH ca_size 0 positive integer 6 7 CA file size in bytes certificate_exist boolean 6...

Page 178: ...apability_protocol_qos_dscp 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable disable DSCP video 0 63 6 6 Video channel for DSCP audio 0 63 6 6 Audio channel for DSCP capability_naudioin 0 eventalarm 0 63 6 6 Event alarm channel for DSCP management 0 63 6 6 Management channel for DSCP eventtunnel 0 63 6 6 Event Control channel for DSCP 7 6 3 IPV6 Subgroup of network ipv6 capabili...

Page 179: ...ation mode s 0 capability_nmed iastream 1 _accessn ame product dependent Not recommended to use this string 32 1 6 Http server push access name for stream N N 1 capability_nmediastream capability_protocol_spush_mjpeg 1 and capability_nmediastream 0 The value are shown as video1s1 mjpg c0_s0_accessname channel1stream1 video1s2 mjpg c0_s1_accessname channel1stream2 video1s3 mjpg c0_s2_accessname cha...

Page 180: ...32 1 6 Http server push access name for channel N and stream M N 1 capability_nvideoin M 1 capability_nmediastream capability_protocol_spush_mjpeg 1 and capability_nmediastream 0 The value are shown as video1s1 mjpg c0_s0_accessname channel1stream1 video1s2 mjpg c0_s1_accessname channel1stream2 video2s1 mjpg c1_s0_accessname channel2stream1 video2s2 mjpg c1_s1_accessname channel2stream2 etc We sup...

Page 181: ...tream capability_n videoin 1 _accessna me product dependent string 32 1 6 RTSP access name for channel stream N N 1 capability_nmediastream capability_protocol_spush_mjpeg 1 and capability_nmediastream 0 The value are shown as live1s1 sdp c0_s0_accessname channel1stream1 live1s2 sdp c0_s1_accessname channel1stream2 live1s3 sdp c0_s2_accessname channel1stream3 live1s4 sdp c0_s3_accessname channel1s...

Page 182: ...address 4 4 Multicast video IP address We support this parameter when the version number httpversion is equal or greater than 0304a audioipaddress product dependent ip address 4 4 Multicast audio IP address We support this parameter when the version number httpversion is equal or greater than 0304a Only available when capability_naudioin 0 metadataipaddres s ip address 4 4 Multicast metadata IP ad...

Page 183: ...25 65535 6 6 Metadata channel port for RTP 7 6 12 PPPoE Subgroup of network pppoe capability_protocol_pppoe 0 NAME VALUE SECURITY get set DESCRIPTION user string 128 6 6 PPPoE account user name pass password 64 7 6 PPPoE account password 7 6 13 Bonjour Subgroup of network service_bonjour NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable bonjour service feature We support this param...

Page 184: ...st filtering admin_enable boolean 6 6 Enable administrator IP address admin_ip string 43 6 6 Administrator IP address maxconnection 1 capability_protoc ol_maxconnection 6 6 Maximum number of s type 0 1 6 6 Ipfilter policy 0 allow 1 deny ipv4list_i 0 9 Single address ip address Network address ip address network mask Range address start ip address end ip address 6 6 IPv4 address list ipv6list_i 0 9...

Page 185: ...hat camera would try to balance the white balance effect of every sensor rbgain Use rgain and bgain to set white balance manually manual 2 cases a if rbgain is not supported this means keep current white balance status b if rbgain is supported rgain and bgain are updated to the current values which is got from white balance module Then act as rbgain mode widerange Auto Tracing White balance 2000K ...

Page 186: ...e fixed indoor outdoor product independent 4 4 Control DC Iris mode outdoor Auto setting DC Iris to get best quality but easy to meet rolling or flicker effect in indoor environment indoor Avoid rolling and flicker effect first fixed Open the iris to maximum Only available when capability_image_c 0 n 1 _iristype dciris enableblc Not support anymore boolean 4 4 Enable backlight compensation Not sup...

Page 187: ... positive integer 1 7 A 32 bit integer each bit can be set separately as follows Bit 0 Support camera control function 0 not support 1 support Bit 1 Built in or external camera 0 external 1 built in Bit 2 Support pan operation 0 not support 1 support Bit 3 Support tilt operation 0 not support 1 support Bit 4 Support zoom operation 0 not support 1 support Bit 5 Support focus operation 0 not support...

Page 188: ...isted in capability_image_ c 0 n 1 _exposu re_maxrange 4 4 Maximum exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc This parameter may also restrict 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...

Page 190: ...diumauto etc Available values are listed in capability_image_c 0 n 1 _wbmode 4 4 Modes of white balance auto Auto white balance panorama indicates that camera would try to balance the white balance effect of every sensor rbgain Use rgain and bgain to set white balance manually manual 2 cases a if rbgain is not supported this means keep current white balance status b if rbgain is supported rgain an...

Page 191: ...n videoin_c 0 n 1 _whitebalance auto Normalized range bgain 0 100 4 4 Manual set bgain value of gain control setting 0 Weak 100 Strong Only available when rbgain is listed in capability_image_c 0 n 1 _wbmo de Only valid when videoin_c 0 n 1 _whitebalance auto Normalized range exposurelevel 0 12 4 4 Exposure level 0 12 This range takes the concept from DC s exposure tuning options The definition is...

Page 192: ...ter Speed and keep adjusting Iris Gain automatically irispriority Manually adjust with variable Iris and keep adjusting Gain and Shutter speed automatically qualitypriority Automatically adjust the 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...

Page 193: ...upport only available when capability_image_c 0 n 1 _sensor type is smartsensor Only available when capability_image_c 0 n 1 _iristype piris piris_position product dependent 1 100 1 4 Manual set P Iris 1 Open 100 Close Only valid when piris_mode manual or capability_image_c 0 n 1 _sensor type is smartsensor Only available when capability_image_c 0 n 1 _iristype piris enableblc Not support anymore ...

Page 194: ...imum 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 capability_image_c 0 n 1 _exposu re_rangetype is onev...

Page 195: ...t in or external camera 0 external 1 built in Bit 2 Support pan operation 0 not support 1 support Bit 3 Support tilt operation 0 not support 1 support Bit 4 Support zoom operation 0 not support 1 support Bit 5 Support focus operation 0 not support 1 support SD PZ IZ series only text string 64 1 4 Enclose caption imprinttimesta mp boolean 4 4 Overlay time stamp on video textonvideo_p osition top bo...

Page 196: ...rismode fixed Only available when capability_image_c 0 n 1 _exposu re_rangetype is twovalues maxexposure product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c 0 n 1 _exposure_maxrange 4 4 Maximum exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc This parameter may also restrict image frame rate from senso...

Page 197: ...00s and camera takes 1 5s on the night then sensor only outputs 5 frame s Only available when capability_image_c 0 n 1 _exposu re_maxrange and capability_image_c 0 n 1 _exposu re_rangetype is onevalue We support this parameter when the version number httpversion is equal or greater than 0302a enablepreview boolean 1 4 Usage for UI of exposure settings Preview settings of video profile Only availab...

Page 198: ...r than 0302a bracketing_lev el 1 100 4 4 The total available lists capability_image_c 0 n 1 _ex posure_bracketing_range will be normalized to 1 100 scale For example the total available list is 7 2x 3x 4x 5x 6x 7x 8x 1 14 that correspond with 2x 15 30 that correspond with 3x Only available when capability_image_c 0 n 1 _exposu re_bracketing_mode 1 We support this parameter when the version number ...

Page 199: ...ater than 0309a s 0 m 1 _h2 64_dintraperio d_enable boolean 4 4 Enable Dynamic intra frame period Only available when capability_videoin_c 0 n 1 _dintra period_support is 1 We support this parameter when the version number httpversion is equal or greater than 0301c s 0 m 1 _h2 64_intraperiod 250 500 1000 2000 3000 4000 4 4 The time interval between two I frames Intra coded picture The unit is mill...

Page 200: ...ll range 1 Worst quality 100 Best quality Only valid when h264_ratecontrolmode vbr and quant 100 s 0 m 1 _h2 64_maxvbrbitr ate 20000 capability_videoin _c 0 n 1 _h264_maxbit rate 4 4 The maximum allowed bit rate in fixed quality mode When the bit rate exceeds this value frames will be dropped to restrict the bit rate Only valid when h264_ratecontrolmode vbr s 0 m 1 _h2 64_cbr_quant 1 5 100 4 4 Set...

Page 201: ...The maximum frame rates of a H264 stream at different resolutions capability_videoin_c 0 n 1 _resolution are recorded in capability_videoin_c 0 n 1 _h264 _maxframerate s 0 m 1 _h2 64_profile 0 2 1 4 Indicate H264 profiles 0 baseline 1 main profile 2 high profile s 0 m 1 _h2 64_smartq_en able boolean 4 4 Enable Smart Q function Only available when capability_videoin_c 0 n 1 _smart q_support is 1 We...

Page 202: ... capability_videoin_codec s 0 m 1 _h2 65_quant 1 5 99 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality level in qpercent 99 Use the quality level in qvalue Only available when h265 is listed in capability_videoin_codec and h265_ratecontrolmode vbr s 0 m 1 _h2 65_qvalue 0 51 4 4 Manual video quality level input The Q value which is used...

Page 203: ... capability_videoin_codec Only valid when h265_ratecontrolmode vbr s 0 m 1 _h2 65_cbr_quant 1 5 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality level in cbr_qpercent Only available when h265 is listed in capability_videoin_codec and h265_ratecontrolmode cbr s 0 m 1 _h2 65_cbr_qperce nt 1 100 4 4 Select customized quality in a normaliz...

Page 204: ..._c 0 n 1 _resolution are recorded in capability_videoin_c 0 n 1 _h265 _maxframerate Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h2 65_profile Available values are listed in capability_videoin_c 0 n 1 _h265_profile 1 4 Indicate H265 profiles Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h2 65_smartq_en able boolean 4 4 Enable Smart Q function On...

Page 205: ...when capability_api_httpversio n format is XXXXX_2 ex 0301a_2 product dependent 4 4 Manual video quality level input The Q value which is used by encoded library directly Only valid when mjpeg_ratecontrolmode vbr and s 0 m 1 _mjpeg_quant 99 s 0 m 1 _mj peg_qpercent 1 100 4 4 Select customized quality in a normalized full range 1 Worst quality 100 Best quality Only valid when mjpeg_ratecontrolmode ...

Page 206: ...jpeg_ratecontrolmode cbr and quant 100 s 0 m 1 _mj peg_bitrate 20000 capability_videoin _c 0 n 1 _mjpeg_maxbi trate 4 4 The target bit rate in constant bit rate mode Only valid when mjpeg_ratecontrolmode cbr s 0 m 1 _mj peg_prioritypo licy framerate imagequality 4 4 Set prioritypolicy Only valid when mjpeg_ratecontrolmode cbr s 0 m 1 _mj peg_maxframe 1 capability_videoin_c 0 n 1 _mjpeg_maxframer a...

Page 207: ...pro_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_strength product dependent 1 100 4 4 The strength of WDR enhanced The bigger value ...

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

Page 209: ...rp_typeceilingmount and capability_videoin_c 0 n 1 _locald ewarp_typewallmount Only available when capability_fisheyelocaldewarp_c 0 capability_nvideoin 1 0 Group videoin_c 0 n 1 _s 0 m 1 _h264_smartstream2 capability_smartstream_support 1 and capability_smartstream_version 2 0 Group videoin_c 0 n 1 _s 0 m 1 _h265_smartstream2 capability_smartstream_support 1 capability_smartstream_version 2 0 and...

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

Page 211: ... which the profile is applied to Not support policy day anymore when the version number httpversion is equal or greater than 0301a begintime hh mm 4 4 Begin time of schedule mode endtime hh mm 4 4 End time of schedule mode minexposure 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 3...

Page 212: ...smode fixed Only available when capability_image_c 0 n 1 _exposu re_rangetype is twovalues shuttervalue product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_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 ...

Page 213: ...to switch on off BLC exposurelevel 0 12 4 4 Exposure level 0 12 This range takes the concept from DC s exposure tuning options The definition is 0 EV 2 0 1 EV 1 7 2 EV 1 3 3 EV 1 0 4 EV 0 7 5 EV 0 3 6 EV 0 7 EV 0 3 8 EV 0 7 9 EV 1 0 10 EV 1 3 11 EV 1 7 12 EV 2 0 Only available when capability_image_c0_exposure_mod e 0 exposuremode product dependent auto shutterpriority irispriority qualitypriority...

Page 214: ...able when capability_image_c0_exposure_mod e 0 whitebalance product dependent auto panorama manual rbgain widerange outdoor indoor sodiumauto etc Available values are listed in capability_image_c 0 n 1 _wbmode 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 and bgain to set white balanc...

Page 215: ...in 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_image_c 0 n 1 _wbmo de Only valid when videoin_c 0 n 1 _whitebalance auto Normalized range maxgain 0 100 4 4 Maximum gain value 0 Low 100 High Only av...

Page 216: ... 100 4 4 Gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_m axgain and capability_image_c 0 n 1 _exposu re_rangetype is onevalue Normalized range We support this parameter when the version number httpversion is equal or greater than 0302a meteringmode auto blc hlc Available value is listed in capability_image_c 0 n 1 _exposure_meteringm ode 4 4 auto The algorithm chooses...

Page 217: ...sensor Only available when capability_image_c 0 n 1 _iristype piris piris_position product dependent 1 100 1 4 Manual set P Iris 1 Open 100 Close Only valid when piris_mode manual or capability_image_c 0 n 1 _sensor type is smartsensor Only available when capability_image_c 0 n 1 _iristype piris irismode fixed indoor outdoor product dependent 4 4 Control DC Iris mode outdoor Auto setting DC Iris t...

Page 218: ... _wdrpro _strength is 1 wdrc_mode product dependent boolean 4 4 Enable WDR enhanced Only available when capability_image_c 0 n 1 _wdrc_ mode is 1 wdrc_strength product dependent 1 100 4 4 The strength of WDR enhanced The bigger value means the stronger strength of WDR enhanced Only available when capability_image_c 0 n 1 _wdrc_ mode is 1 aespeed_mod e product dependent boolean 4 4 Turning AE conve...

Page 219: ...nt 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 d is 1 and capability_image_c 0 n 1 _aespee dsupportsensitivity is 1 flickerless product dependent boolean 4 4 Turn on 1 or ...

Page 220: ...ALUE SECURITY get set DESCRIPTION enable Not supported anymore boolean 4 4 Enable time shift streaming We replace this parameter with timeshift_c 0 n 1 _enable when the version number httpversion is equal or greater than 0312a c 0 n 1 _en able boolean 4 4 Enable time shift streaming We support this parameter when the version number httpversion is equal or greater than 0312a c 0 n 1 _s 0 m 1 _allo ...

Page 221: ... is equal or greater than 0312a sir product dependent Not recommended to use this boolean 6 6 Enable disable Smart IR Only available when capability_daynight_c 0 capability_ nvideoin 1 _smartir is 1 We replace this parameter with ircutcontrol_c 0 n 1 _sir when the version number httpversion is equal or greater than 0312a daymodebegintime Not recommended to use this 00 00 23 59 6 6 Day mode begin t...

Page 222: ...e external IR led Only available when capability_daynight_illuminators_ext ernal_support 0 We replace this parameter with ircutcontrol_illuminators_external_d o_enabled when the version number httpversion is equal or greater than 0312a enablewled Not recommended to use this boolean 6 6 Enable disable built in White led Only available when capability_daynight_illuminators_buil tin_support 0 and whi...

Page 223: ...ility_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 spectrum_mode Not recommended to use this visible ir irenhanced blueenhanced product dependent Available values are listed in capabil...

Page 224: ...ameter when the version number httpversion is equal or greater than 0312a sir product dependent boolean 6 6 Enable disable Smart IR Only available when capability_daynight_c 0 capability_ nvideoin 1 _smartir is 1 We support this parameter when the version number httpversion is equal or greater than 0312a daymodebegintime 00 00 23 59 6 6 Day mode begin time We support this parameter when the versio...

Page 225: ...tivity_type normalize Only available when capability_daynight_c 0 n 1 _ircutsensitivity_type is not We support this parameter when the version number httpversion is equal or greater than 0312a 7 10 2 IR cut control Illuminators Group ircutcontrol_illuminators capability_daynight_c 0 n 1 _support 0 n denotes the value of capability_nvideoin NAME VALUE SECURIT Y get set DESCRIPTION builtin_irled_ena...

Page 226: ...uminators_ext ernal_support 0 and do is listed in capability_daynight_illuminators_ext ernal_interface We support this parameter when the version number httpversion is equal or greater than 0312a external_do 2 capabili ty_ndo _enabled boolean 1 6 Enable disable external led mounted on do 2 capability_ndo Only available when capability_ndo 1 Only available when capability_daynight_illuminators_ext ...

Page 227: ...ME VALUE SECURITY get set DESCRIPTION brightness Not recommended to use this 5 5 100 4 4 5 Darker 5 Bright 100 Use image_c n _brightnesspercent Only available when bit 0 of capability_image_c 0 n 1 _basicse tting is 1 We replace brightness with brightnesspercent This parameter will not be used after the version number httpversion is equal or greater than 0400a contrast Not recommended to use this ...

Page 228: ... than 0400a sharpness Not recommended to use this 3 3 100 4 4 3 Softer 3 Sharper 100 Use image_c 0 n 1 _sharpnesspercent Only available when bit 3 of capability_image_c 0 n 1 _basicse tting is 1 We replace sharpness with sharpnesspercent This parameter will not be used after the version number httpversion is equal or greater than 0400a brightnesspercent 0 100 4 4 Set brightness in the normalized r...

Page 229: ...urve product dependent 0 100 4 4 0 Fine turned gamma curve by Vivotek 1 Gamma value 0 01 2 Gamma value 0 02 3 Gamma value 0 03 100 Gamma value 1 Note Although we set gamma value to 100 level but not all gamma values are valid Internal module will take the closest valid one For example 1 45 may all be mapped to gamma value 0 45 etc Only available when capability_image_c 0 n 1 _gamm acurve is 1 lowl...

Page 230: ...available when capability_image_c 0 n 1 _defog_ mode is 1 defog_strength product dependent 1 100 4 4 Strength of defog Only available when capability_image_c 0 n 1 _defog_ mode is 1 eis_mode product dependent boolean 4 4 Electronic image stabilizer 0 disable 1 enable Only available when eis is listed in capability_image_c 0 n 1 _is_mod e eis_strength product dependent 1 100 4 4 Strength of electro...

Page 231: ...1 _scenemode_ supporttype 4 4 Value of scene mode Only available when capability_image_c 0 n 1 _scene mode_support is 1 restoreatwb positive integer 4 4 Restore of adjusting white balance of image according to mode settings freeze product dependent boolean 4 4 Enable disable Image freeze while patrolling 0 disable 1 enable Only available when capability_image_c 0 n 1 _freeze is 1 deinterlace_enabl...

Page 232: ...s 1 yoffset 0 100 4 4 Adjusting the image to proper position vertically Only available when the bit 5 of capability_image_c 0 n 1 _basicset ting is 1 lens_alignment 0 100 4 4 Stitch the sensors together into focused position Only available when capability_image_c 0 n 1 _lens_al ignment is 1 lens_ldc_mode boolean 4 4 Enable disable lens distortion correction Only available when capability_image_c 0...

Page 233: ... schedule mode profile_i 0 m 1 _endtime hh mm 4 4 End time of schedule mode profile_i 0 m 1 _brightness Not recommended to use this 5 5 100 4 4 5 Darker 5 Bright 100 Use image_c 0 n 1 _brightnesspercent Only available when bit 0 of capability_image_c 0 n 1 _basicse tting is 1 We replace profile_i0_brightness with profile_i0_brightnesspercent This parameter will not be used after the version number...

Page 234: ...sicse tting is 1 We replace profile_i0_saturation with profile_i0_saturationpercent This parameter will not be used after the version number httpversion is equal or greater than 0400a profile_i 0 m 1 _sharpness Not recommended to use this 3 3 100 4 4 5 Less saturation 5 More saturation 100 Use image_c 0 n 1 _saturationpercent Only available when bit 2 of capability_image_c 0 n 1 _basicse tting is ...

Page 235: ...nge 0 Less saturation 100 More saturation Only available when bit 2 of capability_image_c 0 n 1 _basicse tting is 1 profile_i 0 m 1 _sharpnesspercent 0 100 4 4 Set sharpness in the normalized range 0 Softer 100 Sharper Only available when bit 3 of capability_image_c 0 n 1 _basicse tting is 1 profile_i 0 m 1 _gammacurve 0 100 4 4 0 Fine turned gamma curve by Vivotek 1 Gamma value 0 01 2 Gamma value...

Page 236: ...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 product dependent 1 100 4 4 Strength of 3DNR Only available when capability_image_c 0 n 1 _dnr is 1 profile_i 0 m 1 _defog_mode product dependent boolean 4 4 Enable disable defog mode 0 disable 1 enable Only available when capability_image_c 0 n 1 _defog_ mode is 1 profile_i 0 m ...

Page 237: ...ly available when eis is listed in capability_image_c 0 n 1 _is_mod e profile_i 0 m 1 _dis_mode product dependent boolean 4 4 Digital image stabilizer 0 disable 1 enable Only available when dis is 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 _...

Page 238: ...igh Light Compensation and to perform the masking of bright light area center Use Center window as metering area and give the necessary light compensation Group exposurewin_c 0 n 1 _win_i 0 k 1 n denotes the value of capability_nvideoin k denotes the value of 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 capabil...

Page 239: ...bility_image_c 0 n 1 _exposu re_windomain sizepx 0 Wx0 H W 0 The current image width 1 H 0 The current image height 1 4 4 Width and height of the window Only available when px is listed in capability_image_c 0 n 1 _exposu 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 9999x...

Page 240: ...dow as metering area and give the necessary light compensation Group exposurewin_c 0 n 1 _profile_i 0 m 1 _win_i 0 k 1 for m profile and n channel product n denotes the value of capability_nvideoin m denotes the value of capability_nvideoinprofile k denotes the value of 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...

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

Page 242: ... is equal or greater than 0301a We replace source with input More details please refer the parameter description of input input intmic extmic product dependent 4 4 intmic Internal built in microphone Only available when capability_audio_intmic 1 extmic External microphone input Only available when capability_audio_extmic 1 Note If physical microphone switch is showed on product this value is updat...

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

Page 244: ...Set AAC4 bitrate in bps Only available if AAC is supported s0_gamr_bitrate 4750 5150 5900 6700 7400 7950 10200 12200 4 4 AMR encoded bitrate in bps Only available if AMR is supported s0_g711_mode pcmu pcma 4 4 Set G 711 companding algorithm pcmu µ law algorithm pcma A law algorithm Only available if G 711 is supported s0_g726_bitrate 16000 24000 32000 40000 4 4 Set G 726 encoded bitrate in bps Onl...

Page 245: ...etection alarm_level 1 100 4 4 Audio detection alarm level profile_i0_enable boolean 4 4 Enable disable this profile setting profile_i0_policy night schedule 4 4 The mode which the profile is applied to Not support policy day anymore when the version number httpversion is equal or greater than 0301a profile_i0_begintime hh mm 4 4 Begin time of schedule mode profile_i0_endtime hh mm 4 4 End time of...

Page 246: ...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 247: ...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 248: ...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 249: ... 1 m 1 policy night schedule 4 4 The mode which the profile is applied to Not support policy day anymore when the version number httpversion is equal or greater than 0301a begintime hh mm 4 4 Begin 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 250: ...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 251: ...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 252: ...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 253: ...6 DyndnsDynamic dyndns org dynamic DyndnsCustom dyndns org Safe100 safe100 net provider _hostnam e string 128 6 6 Your DDNS hostname provider _usernam eemail string 64 6 6 Your user name or email to 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 D...

Page 254: ...sable the UPnP port forwarding service upnpnatstatus 0 3 6 7 The status of UPnP port forwarding used internally 0 OK 1 FAIL 2 no IGD router 3 no need for port forwarding 7 22 System Log Group syslog 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 ...

Page 255: ...e secnamerw string 31 6 6 Read write security name secnamero string 31 6 6 Read only security name authpwrw string 8 128 7 6 Read write authentication password authpwro string 8 128 7 6 Read only 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 ...

Page 256: ..._show boolean 1 6 Show or hide manual trigger VI button in homepage 0 Hidden 1 Visible theme_option 1 4 1 6 1 3 One of the default themes 4 Custom definition theme_color_font string 7 1 6 Font color 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...

Page 257: ...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 258: ...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 259: ... 1 _fliped boolean 4 4 Flip side of window position 0 Non flip side 1 Flip side 7 27 Capability Group capability NAME VALUE SECURITY get set DESCRIPTION api_httpversion string This number start with 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 260: ... decimal digit from 0 to 9 while r is an alphabetic EX 0302b_1 Major version 03 minor version 02 revision b platform 1 The 4 integer numbers are WebAPI version we use short name httpversion for it in 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 261: ...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 262: ...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 263: ...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 264: ...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 265: ...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 266: ...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 267: ... support IPv6 protocol_pppoe boolean 0 7 Indicate whether to support PPPoE protocol_ieee8021 x boolean 0 7 Indicate whether to support IEEE802 1x protocol_qos_cos boolean 0 7 Indicate whether to 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 268: ...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 269: ...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 270: ...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 271: ...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 272: ...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 273: ... mode Only available when capability_smartstream_support is 1 vadp_supportfeatu re positive integer 0 7 An 32 bit integer each bit can be set separately as follows Bit 0 VADP interface Bit 1 Capture 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 274: ...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 275: ...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 276: ...umber before event occurred media_snapshot_ maxpostevent positive integer 0 7 Maximum snapshot number after event occurred media_snapshot_ maxsize positive integer 0 7 Maximum size KB of a snapshot 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 in...

Page 277: ... when capability_supportsd is 1 or capability_storage_dbenabled is 1 localstorage_seaml ess 0 positive integer 0 7 Indicate whether seamless recording is supported One bit represents one channel Ex 3 means channel 0 and channel1 support seamless recording Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 localstorage_modn um Not recommended to use this 0 positive i...

Page 278: ...supports to record directly to an on board SD Card bit 1 Currently they are reserved bit and the default value is 0 Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 localstorage_slcon num 0 positive integer 0 7 The maximum seamless connection number for each channel Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 localstorage_sma...

Page 279: ...l dewarp Only available when capability_fisheye 0 shockalarm_suppo rt boolean 0 7 Indicate whether to support the shock detection We support this parameter when the version number httpversion is equal or greater than 0306e layout_redirection string 0 7 Indicate which function will be redirected to the vadp package path Not supported We support this parameter when the version number httpversion is ...

Page 280: ...5 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 movable elements that permit changing the effective focal length And the key difference ...

Page 281: ...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 282: ... _buildin pt is 1 maxpanangle integer 0 7 The upper limit for pan angle Only available when bit0 of capability_camctrl_c 0 n 1 _buildin pt is 1 tiltspeedlv 0 positive integer 0 7 The maximum speed 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 283: ...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 284: ...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 285: ... of ircutcontrol_sensitivity parameter is low normal high normalize the value of ircutcontrol_sensitivity parameter is 1 100 not support Only available when capability_daynight_c 0 n 1 _suppo rt is 1 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 286: ...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 287: ...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 288: ...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 289: ... support this parameter when the version number httpversion is equal or greater than 0312a external_interface do do2 do3 do4 product dependent 0 7 The device interface of external led do digital output 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 spectrum_support boolean 0 7 Indicate wh...

Page 290: ...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 291: ...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 292: ...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 293: ...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 294: ...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 295: ...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 296: ...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 297: ...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 298: ...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 299: ...resolutionC4R A list of WxH 0 7 Available resolutions of 4R mode of ceiling and floor mount resolutionW1P A list of WxH 0 7 Available resolutions of 1P mode of wall mount resolutionW1R A list of WxH 0 7 Available resolutions of 1R mode of wall mount resolutionW4R A list of WxH 0 7 Available resolutions of 4R mode of wall mount Group capability_videoin_c 0 n 1 _mode 0 m 1 n denotes the value of cap...

Page 300: ...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 301: ... Indicate binning is used or not in this video mode 0 No binning 1 2x2 binning 3 3x3 binning Binning is a technology to increase light sensitivity by combining multiple pixels to one The drawback is 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 302: ...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 303: ...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 304: ...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 305: ... it unchanged UI keeps the status as before and user can t change it hidden UI is hidden fixed UI is fixed to one selection or value ranged UI is fixed to multiple selections or values enabled UI is 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 306: ...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 307: ...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 308: ...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 309: ...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 310: ...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 311: ...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 312: ...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 313: ...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 314: ...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 315: ...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 316: ...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 317: ...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 318: ...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 319: ... exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL 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 320: ... n 1 _ exposure_mode is 1 exposure_winnum 0 Positive Integer 0 7 Indicate the number of custom exposure windows If no custom is listed in exposure_winmode this should be 0 Only available when 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 321: ...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 322: ...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 323: ...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 324: ... n 1 _defog_ mode 1 this may be either 0 or 1 defog_supportlevel 0 positive integer 0 7 The value indicate the support strength level of defog defog_affect wdrc unchanged contrast hidden or others x 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 325: ...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 326: ...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 327: ...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 328: ...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 329: ...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 330: ...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 331: ...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 332: ...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 333: ...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 334: ...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 335: ...assive mode email_address string 128 6 6 Email server address email_sslmode boolean 6 6 Enable support SSL email_port 0 65535 6 6 Port to connect to the server email_username string 64 6 6 Username to 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...

Page 336: ...eoin 1 6 6 Indicate the source of media channel 0 means the first channel 1 means the second channel 2 means the third channel 3 means the fourth channel We support this parameter when the version number httpversion is equal or greater than 0311c snapshot_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 th...

Page 337: ...l 0 means the first channel 1 means the second channel 2 means the third channel 3 means the fourth channel We support this parameter when the version number httpversion is equal or greater than 0311c videoclip_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 str...

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

Page 339: ...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 340: ... P7D it means 7 days P1DT10H it means 1 days and 10 hours The parameter takes effect when autocleanup_ maxretentiontime_recording_enabled is enabled notify boolean 6 6 0 Disable recording notification 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 341: ...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 342: ...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 343: ...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 344: ...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 345: ...imal window size is 64x64 then the win_i0_home 0 resolution_W 64 0 resolution_H 64 which the resolution is the value in current stream If the stream doesn t support ePTZ the permissions of this parameter must be set as 1 7 s 0 m 1 _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...

Page 346: ...oom with videoin_c 0 n 1 _zoomratiodisplay smooth boolean 1 4 Enable the ePTZ move smoothly feature tiltspeed 5 5 1 4 Tilt speed Only available when capability_fisheye is 1 1 7 Tilt speed It should be set by eCamCtrl cgi rather than by setparam cgi panspeed 5 5 1 4 Pan speed Only available when capability_fisheye is 1 1 7 Pan speed It should be set by eCamCtrl cgi rather than by setparam cgi zooms...

Page 347: ...TER VALUE SECURITY get set DESCRIPTION patrolseq string 120 1 4 The patrol sequence of ePTZ All the patrol position indexes will be separated by patroldwelling string 160 1 4 The dwelling time unit second of each patrol point separated by preset_i 0 19 _name string 40 1 4 Name of ePTZ preset Only available when capability_fisheye is 1 1 7 Name of ePTZ preset It should be set by ePreset cgi rather ...

Page 348: ...nwindow 0 PARAMETER VALUE SECURITY get set DESCRIPTION win_i0_enable boolean 4 4 Enable or disable the window win_i0_home W H product dependent 4 4 Left top corner coordinate of the window If the minimal window size is 192x144 then the win_i0_home 0 resolution_W 192 0 resolution_H 144 resolution_W and resolution_H based on capability_image_ c 0 n 1 _focuswindow_range win_i0_size WxH product depend...

Page 349: ... 0312a maxconnection 3 1 7 Maximum number of connected seamless streaming We replace this parameter with seamlessrecording_c 0 n 1 _maxconnecti on when the version number httpversion is equal or greater than 0312a enable boolean 1 7 Indicate whether seamless recording is recording to local storage or not at present Read only We replace this parameter with seamlessrecording_c 0 n 1 _triggerrecord w...

Page 350: ...y_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 recording We support this parameter when the version number httpversion is equal or greater than 0312a maxconnection 3 1 7 Maximum number of connected seamless streaming We support this paramet...

Page 351: ...tion Development Platform Setting Group vadp NAME VALUE SECURITY get set DESCRIPTION version string 6 7 Indicate the VADP version resource_total_memory 0 positive integer 6 7 Indicate total available memory size for VADP modules resource_total_storage 0 positive integer 6 7 Indicate total size of the internal storage space for storing VADP modules resource_free_memory 0 positive integer 6 7 Indica...

Page 352: ...NAME VALUE SECURITY get set DESCRIPTION saved to SD card when user want to upload it If the value is false save module to the internal storage space and it will occupy storage size number string 128 6 7 This number is used to register license key for VADP application ...

Page 353: ... The provider of the module vendorurl string 120 6 6 URL of the vendor version string 40 6 6 Version of the module license string 40 6 6 Indicate the license status of the module licmsg string 128 6 6 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 354: ...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 355: ...he dwelling time of each preset location only available when capability_camctrl_c0_rs485 2 uart 0 capability_nuar t 1 1 4 Select corresponding uart capability_nuart 0 only available when capability_camctrl_c0_rs485 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 ava...

Page 356: ...PTZ camera Note Please set your speed dome to the appropriate baud rate and Camera ID e g 2400bps camera ID 1 2 3 etc All Camera IDs on the same controlling system NVR or rs485 keyboard have to be distinct Therefore once you send a controlling signal each camera will only accept the inputs with the corresponding ID panspeed 5 5 1 4 Pan speed tiltspeed 5 5 1 4 Tilt speed zoomspeed 5 5 1 4 Zoom spee...

Page 357: ... 4 Zoom position at each preset location preset_i 0 k 1 _focus capability_ptz_ c 0 n 1 _min focus capability_ptz_ c 0 n 1 _ma xfocus 1 4 Focus position at each preset location preset_i 0 k 1 _ dwelling 0 999 1 4 The dwelling time of each preset location only available 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 essenti...

Page 358: ...m position axisf capability_ptz_ c 0 n 1 _min focus capability_ptz_ c 0 n 1 _ma xfocus 1 4 Custom home focus position digitalzoom boolean 1 4 Enable disable digital zoom zoomenhance boolean 1 4 Enable disable zoom enhancement returnhome boolean 1 4 Enable disable return home while idle returnhomeinterval 1 999 1 4 While idle over this time interval idle action will be taken idleaction_enable boole...

Page 359: ...your speed dome to the appropriate baud rate and Camera ID e g 2400bps camera ID 1 2 3 etc All Camera IDs on the same controlling system NVR or rs485 keyboard have to be distinct Therefore once you send a controlling signal each camera will only accept the inputs with the corresponding 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 pa...

Page 360: ... location preset_i 0 k 1 _focus setting sync fixcurrent 1 4 The focus mode of each preset which is essential and should be grouped with preset_i 0 k 1 _name We support this parameter when the version number httpversion is equal or greater than 0305b preset_i 0 k 1 _fliped boolean 1 4 Flip side at each preset location patrol_i 0 39 _name string 40 1 4 For internal device The name of patrol location...

Page 361: ... 1 4 While idle over this time interval idle action will be taken digitalzoom boolean 1 4 Enable disable digital zoom idleaction_enable boolean 1 4 Enable disable idle action while idle idleaction_type pan patrol tour home objtrack prev 1 4 This field tells what kind of action should be taken while idle idleaction_interval 1 999 1 4 While idle over this time interval idle action will be taken zoom...

Page 362: ...d order random the presets of the tour will be recalled randomly Only available when capability_presettourdirection is 1 We support this parameter when the version number httpversion is equal or greater than 0307a tour_i 0 19 _checklist string 512 1 4 The indexes of preset positions separated by tour_i 0 19 _dwelltim e string 512 1 4 Preset tour time to wait before moving to the next preset positi...

Page 363: ...CURITY get set DESCRIPTION baudrate 300 600 1200 2400 4800 9600 19200 38 400 57600 115200 4 4 Set baud rate of COM port databit 5 6 7 8 4 4 Data bits in a character frame paritybit none odd even 4 4 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 ...

Page 364: ... n 1 n is uart port count capability_nuart 0 and the bit7 of capability_ptzenabled is 0 the bit4 of capability_ptzenabled is 1 NAME VALUE SECURITY get set DESCRIPTION cameraid 1 255 4 4 Camera ID controlling external PTZ camera Note Please set your speed dome to the appropriate baud rate and Camera ID e g 2400bps camera ID 1 2 3 etc All Camera IDs on the same controlling system NVR or rs485 keyboa...

Page 365: ... 7 RS485 mode 7 45 Lens Configuration Group lens for n channel products n denotes the value of capability_nvideoin capability_image_c 0 n 1 _lensconfiguration_support 1 NAME VALUE SECURITY get set DESCRIPTION selected string 6 7 Current selected lens profile e g lens_selected lens_default_i0 it means choosen lens configuration is i0 lens of default group Group lens_default NAME VALUE SECURITY get ...

Page 366: ...er axis coordinate radius 0 positive integer 6 7 The actual center radius 7 47 Fisheye Local Dewarp Setting Group fisheyedewarp_c 0 n 1 capability_fisheyelocaldewarp_c 0 n 1 0 n denotes the value of capability_nvideoin m denotes the value of capability_nmediastream NAME VALUE SECURITY get set DESCRIPTION panspeed 5 5 integer 1 4 Pan speed of regional view tiltspeed 5 5 integer 1 4 Tilt speed of re...

Page 367: ...oup pir capability_npir 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 1 1 Enable disable PIR 7 49 Auto Tracking Setting Group autotrack_c 0 n 1 capability_image_c 0 n 1 _autotrack_support 0 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...

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

Page 369: ...WEP key4 for encryption Only valid when wireless_encrypt is wep algorithm AES TKIP 6 6 Algorithm Only valid when wireless_encrypt is wpa or wpa2 presharedkey password 64 6 6 WPA WPA2PSK mode pre shared key 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 PARAMET...

Page 370: ...1 0 Inactive normal state 1 Active triggered state Example Drive the digital output 1 to triggered state and redirect to an empty page http myserver cgi bin dido setdo cgi do1 1 8 2Query Status of the Digital Input capability_ndi 0 Note This request requires Viewer privileges Method GET POST Syntax http servername cgi bin dido getdi cgi di0 di1 di2 di3 If no parameter is specified all of the digit...

Page 371: ...tus 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 1 0 200 OK r n Content Type text plain r n Content Length length r n r n do0 state r n do1 state r n do2 state r n do3 state r n where state can...

Page 372: ...0 capability_nvideoin 1 The channel number of the video source resolution Available options are list in capability_videoin_c 0 n 1 _resolution Besides available options is referred to capability_videoin_c 0 n 1 _maxresolution and capability_videoin_c 0 n 1 _minresolution The resolution of the image quality 1 5 The quality of the image streamid 0 capability_nmediastream 1 The stream number The serv...

Page 373: ...edit Modify the account password and privilege When using this method the username field is necessary and other fields are optional If not specified it will keep the original settings username name The name of the user to add delete or edit userpass value The password of the new user to add or that of the old user to modify The default value is an empty string privilege view The privilege of the u...

Page 374: ...is request requires Administrator privileges Method POST Syntax http servername cgi bin admin upgrade cgi Post data fimage file name return return page r n r n multipart encoded form data Server will accept the file named file name to upgradethe firmware and return with return page if indicated ...

Page 375: ...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 376: ...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 377: ...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 378: ...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 379: ...ameter 8 10 IP Filtering for ONVIF Syntax product dependent http servername cgi bin admin ipfilter cgi type value http servername cgi bin admin ipfilter cgi method add v4 v6 ip ipaddress index val ue 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 me...

Page 380: ...nel cgi x sessioncookie string 22 content type application x vvtk tunnelled pragma no cache cache control no cache content length 32767 expires Sun 9 Jam 1972 00 00 00 GMT User must use GET and POST to 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...

Page 381: ... content type application x vvtk tunnelled pragma no cache cache control no cache content length 32767 expires Sun 9 Jam 1972 00 00 00 GMT User must use GET and POST to establish two channels for 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 the p...

Page 382: ...g the accessname of SDP You can get the SDP by HTTP GET When using scalable multicast Get SDP file which contains the multicast information via HTTP 8 14 Open the Network Stream Note This request requires Viewer access privileges Syntax For HTTP push server MJPEG http servername network_http_s 0 m 1 _accessname For RTSP MP4 the user needs to input theURL below into an RTSP compatible player rtsp s...

Page 383: ...mal data hex decimal data The hex decimal data is a series of digits from 0 9 A F Each comma separates the commands by 200 milliseconds flush yes no yes Receive data buffer of the COM port will be cleared before read no Do not clear the receive data buffer wait 1 65535 Wait time in milliseconds before read data read 1 128 The data length in bytes to read The read data will be in the return page Re...

Page 384: ... integer primary key Optional The integer primary key column will automatically be assigned a unique integer triggerType text Optional Indicate the event trigger type Please embrace your input value with single quotes Ex mediaType motion Support trigger types are product dependent mediaType text Optional Indicate the file media type Please embrace your input value with single quotes Ex mediaType v...

Page 385: ... of Jan 1st 2008to the end of Jan 1st 2008 limit positive integer Optional Limit the maximum number of returned search records offset positive integer Optional Specifies how many rows to skip at the beginning of the matched records Note that the offset keyword is used after limit keyword To increase the flexibility of search command you may use OR connectors for logical OR search operations Moreov...

Page 386: ...ked 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 label 2 label 3 Command queryStatus PARAMETER VALUE DESCRIPTION retType xml or javascript Optional Ex retype ...

Page 387: ... milliseconds setting it to trigger state Note that when the virtual input is waiting for next state it cannot accept new requests return return page Redirect to the page return page after the 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 ignor...

Page 388: ...name network_rtsp_s m _accessname maxsft value tsmode value refti me value forcechk minsft value n is the channel index m is the timeshift stream index For details on timeshift stream please refer to 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 ada...

Page 389: ...t 10 reftime 12 30 forcechk N A N A Check if the requested stream enables timeshift feature and if minsft is achievable If false return 415 Unsupported Media Type minsft positive integer 0 How many 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 ...

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

Page 391: ...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 Curren...

Page 392: ...tor_max is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from function getstatus steps 1 motor_max Motor s moving steps It works only if function zoom or function 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 additio...

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

Page 394: ... of iris getstatus Information of motors return value as below remote_focus_focus_motor_max Maximum steps of focus motor remote_focus_focus_motor_start Start point of effective focal length remote_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 395: ...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 396: ... admin upload_dst cgi Post data filename file name r n r n multipart encoded form data For language file http servername cgi bin admin upload_lan cgi Post data filename file name r n r n multipart 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 u...

Page 397: ...vername cgi bin admin update_lens cgi choose_lens value You need to reboot manually after you choose another lens configuration For choose selected lens configuration and reboot camera http servername 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 val...

Page 398: ... PARAMETER VALUE DEFAULT DESCRIPTION stime YYYYMMDD_HHMMSS MMM N A Start time etime YYYYMMDD_HHMMSS MMM N A End time length positive integer N A The length of media of interest The unit is second 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 s...

Page 399: ...VIVOTEK User s Manual 399 2019 VIVOTEK INC All Right Reserved 265 rtsp 10 10 1 2 mod sdp etime 20110312_040400 000 length 120 X X X V Play file file rtsp 10 10 1 2 mod sdp filename mnt link0 ...

Page 400: ...solution value stretch value Click on image Move the center of image to the coordination x y based on resolution or videosize of 1O mode return return page Example http myserver cgi bin camctrl fdCamCtrl cgi channel 0 stream 0 move right http myserver cgi bin camctrl fdCamCtrl cgi channel 0 stream 0 zoom tele http myserver cgi bin camctrl fdCamCtrl cgi channel 0 stream 0 move top speedtilt 1 http ...

Page 401: ...ger x coordinate clicked by user It will be the x coordinate of center after movement y integer y coordinate clicked by user It will be the y coordinate of center after movement videosize window size The size of plug in ActiveX window in web page of 1O content resolution window size The resolution of streaming of 1O content stretch boolean 0 indicates that it uses resolution streaming size as the ...

Page 402: ... privacy mask edit Edit a 3D privacy mask maskname string 40 3D privacy mask name maskheight integer 3D privacy mask height maskwidth integer 3D privacy mask width videosize window size Optimal The 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 403: ...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 404: ... view or further view with zs speed used for joystick control zs 0 8 SD8362 Set the speed of zooming 0 means stop vx integer excluding 0 The slope of movement vy vx used for joystick control vy integer 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 405: ...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 406: ...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 407: ...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 408: ...n page PARAMETER VALUE DESCRIPTION addpos string 30 Add one preset location to the preset list channel 0 capability_nvideoin 1 Channel of the video source delpos string 30 Delete preset location from 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 i...

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

Page 410: ...itten The range is from 0 to 100 unit The SD card is recommended to be replaced if the percentage reaches above 90 smartsd_spare_block_rate Usage rate of spare blocks It means the usage percentage of 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 Lif...

Page 411: ...VALUE DESCRIPTION N A N A Apply the wireless settings and connect to AP 8 32 Get Wireless Information capability_network_wireless 0 Note This request requires Administrator privileges Method GET POST 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 Signa...

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

Page 413: ...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 414: ...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 415: ...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 416: ...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 417: ...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 418: ...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 419: ...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 37 Lens Thermal Control capabiltiy_image_c 0 n 1 _sensortype thermalsensor Note This request requires Administrator privileges Method GET POST Syntax for co...

Page 420: ... bin admin thermalctrl cgi operation set action shuttercompensate Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n ERROR fail PARAMETER VALUE DESCRIPTION action 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 421: ...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 423: ... Notices from HEVC Advance THIS PRODUCT IS SOLD WITH A LIMITED LICENSE AND IS AUTHORIZED TO BE USED ONLY IN CONNECTION WITH HEVC CONTENT THAT MEETS EACH OF THE THREE FOLLOWING QUALIFICATIONS 1 HEVC 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 424: ...e by one or more of the following measures Reorient or relocate the receiving antenna Increase the separation between the equipment and receiver Connect the equipment into an outlet on a circuit different from that to which the receiver is connected Consult the dealer or an experienced radio TV technician for help Shielded interface cables must be used in order to comply with emission limits CE Ma...

Search results

Summary of Contents for IP9164-HT

Reviews:

Related manuals for IP9164-HT

Brands by name

Popular brands

Vivotek IP9164-HT, User Manual

Search results

Summary of Contents for IP9164-HT

Reviews:

Related manuals for IP9164-HT

Brands by name

Popular brands