Vivotek IB836BA-EHF3 User Manual Download

Page: 202 / 334

VIVOTEK

202 - User's Manual

5150,
5900,
6700,
7400,
7950,
10200,
12200

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

* Only available if G.726 is supported

s0_g726_bitstreampackin
gmode

little, big

4/4

Set G.726 bit streaming packing mode.
little: Little-endian bitstream format.
big: Big-endian bitstream format.

* Only available if G.726 is supported.

s0_g726_vlcmode

0, 1

4/4

Enable vlcmode for G.726.
0: Standard mode.
1: Solve compatibility problem with VLC
player.

* Only available if G.726 is supported.

alarm_enable <boolean>

4/4

Enable audio detection

alarm_level

1~100

4/4

Audio detection alarm level

profile_i0_enable

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 schedule mode.

Summary of Contents for IB836BA-EHF3

Page 1: ...User s Manual 2MP WDR Day Night 30M IR IP66 IK10 Extreme Weather Defog Bullet Network Camera IB836BA EHT IB836BA EHF3 IB836BA HT IB836BA HF3 Rev 1 2 ...

Page 2: ...ge layout 38 System Logs 41 System Parameters 43 System Maintenance 44 Media Image 48 Media Video 61 Media Video 62 Media Audio 70 Network General settings 71 Network Streaming protocols 79 Network SNMP Simple Network Management Protocol 88 Security User accounts 89 Security HTTPS Hypertext Transfer Protocol over SSL 90 Security Access List 97 PTZ PTZ settings 102 Event Event settings 106 Applicat...

Page 3: ...mote focus with built in stepping motors and P iris to provide precise and remote adjustments Meeting the demands of outdoor and harsh conditions the IB836BA H series also comes with an IP66 and IK10 rated housing that allows the camera body to withstand rain dust and against acts of vandalism or other impacts The IB836BA H is designed to operate under a wide operating temperature in extremely col...

Page 4: ... note of the warnings in the Quick Installation Guide before the Network Camera is installed then carefully read and follow the instructions in the Installation chapter to avoid damage due to faulty assembly and installation This also ensures the product is used properly as intended The Network Camera is a network device and its use should be straightforward for those who have basic networking kno...

Page 5: ...s WARNING or IMPORTANT These statements indicate situations that can be dangerous or hazardous to the machine or you Electrical Hazard This statement appears when high voltage electrical hazards might occur to an operator Physical Description Front Panel Motorized or fixed lens The T models have auto focus motorized lens Some of the suffix syntax used in model naming are listed below E w heater fo...

Page 6: ... preferred location 2 Drill holes for mounting screws and a cabling hole 3 Loosen the anti tamper screws to open the top cover 4 Insert an SD card user supplied 5 Replace the desiccant bag whenever you open the top cover This ensures the components are free from the moisture M 3 4 icro 5 TM ...

Page 7: ...VIVOTEK User s Manual 7 6 Secure the Network Camera to a wall or ceiling Wall Mount Ceiling Mount 6 7 7 Secure the sun shield to camera ...

Page 8: ...Pass the cable through the seal dome and squeeze the rubber seal through an RJ45 connector 8 2 You can then pass the cable through the cable gland body 8 3 Fasten up these components Make sure enough pressure is exerted on the rubber seal 8 4 Connect the Ethernet cable to the RJ45 connector with a seal ring Fasten the cable housing 8 ...

Page 9: ...ssage is waterproof using sealant foam heat shrink tubing or putties Make sure the interfaces e g DC connectors and terminal connectors if unused are also wrapped up using waterproof putties You can also purchase the AM 714 junction box to place all cabling connections within the protection of the box ...

Page 10: ...the camera 11 Connect the other interfaces such as I O wires 10 Loosen the fastening ring on the mount bracket using a hex wrench and aim the camera at the area of your interest When done tighten the fastening ring Fastening ring 10 15 With a live view is displayed on your laptop adjust the zoom and focus to obtain an optimal image Check the live view to ensure the image is in focus The T models c...

Page 11: ...Green LED blinks every 1 sec Connected to network 3 Green LED blinks every 1 sec 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 res...

Page 12: ...etwork Camera to reboot Restore Press and hold the reset button until the status 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 SD 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 Conne...

Page 13: ...illustration to connect the Network Camera to a PoE enabled switch via Ethernet cable PoE Switch When using a non PoE switch Use a PoE power injector optional to connect between the Network Camera and a non PoE switch Non PoE Switch PoE Power Injector optional NOTE 1 The camera is only to be connected to PoE networks without routing to outside plants 2 For PoE connection use only UL listed I T E w...

Page 14: ...lease 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 on how to forward ports on the router please refer to your router s user s manual 3 Fin...

Page 15: ...122 146 57 120 8000 If you change the port numbers on the Network configuration page please open the ports accordingly on your router For example you can open a management session with your router to configure access through the router to the camera within your local network Please consult your network administrator for router configuration if you have troubles with the configuration For more info...

Page 16: ... network devices on the same LAN 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 0002D1730202 00 02 D1 73 02 02 192 168 5 151 IB836BA Installation Wizard 2 IW2 Network Camera Model No IB836BA Made in Taiwan This devi...

Page 17: ...eployment consisting of multiple cameras For its installation details please refer to its related documents IB836BA The E models e g IB836BA EHF3 IB836BA EHT are able to operate in low temperature environments However when starting these cameras in a very low termperature condition e g 40ºC the embedded heater may take half an hour to warm up the camera When the temperature within the canister rea...

Page 18: ...window Perform the Auto Focus function for best image However if you have cascaded cameras do this one by one Do not perform this function simultaneously on multiple cameras because the motorized lens also consume considerable amount of power and may cause the last camera on the line to hang ...

Page 19: ...nch 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 Mozilla...

Page 20: ...tection please refer to Security on page 89 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 instr...

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

Page 22: ...54 please set the RTSP port to 554 For more information please refer to RTSP Streaming on page 80 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 80 for details rtsp 192 168 5 151 554 live sdp 1 Launch the RTSP player 2 Choose File Open URL A URL dialog box will pop up 3 The address f...

Page 23: ...s is limited you will not be able to use a large video size Please set the video streaming parameters as listed below For more information please refer to Stream settings on page 61 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 RT...

Page 24: ...ad it from http www vivotek com 1 If you forget the root administrator password for the camera you can restore the camera defaults by pressing the reset button for longer than 5 seconds 2 If DHCP is enabled in your network and the camera cannot be accessed run the IW2 utility to search the network If the camera has been configured with fixed IP that does not comply with your local network you may ...

Page 25: ...iple 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 61 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 info...

Page 26: ...n the video 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 Video Title The video title can be configured For more information please r...

Page 27: ...tion on page 102 For more information about how to set up the viewing region of the current video stream please refer to page 102 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 102 for detailed i...

Page 28: ...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 31 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 29: ... 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 30: ...ng to the server takes up additional bandwidth and the Network Camera allows up to ten simultaneous accesses UDP multicast This protocol allows multicast enabled routers to forward network packets to all clients requesting streaming media This helps to reduce the network transmission load of the Network Camera while serving multiple clients at the same time Note that to utilize this feature the Ne...

Page 31: ...and time to the end of the file name Local Streaming Buffer Time In the case of encountering unsteady bandwidth live streaming may lag and video streaming may 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 milli seconds before being played on the live viewing window This will help you see the streaming more smoothly ...

Page 32: ...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 33: ... 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 34: ... 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 35: ...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 36: ...finished with the settings on this page click Save at the bottom of the page to enable the settings System Host name Enter a desired name for the Network Camera The text will be displayed at the top of the main page and also on the view cells of the ST7501 and VAST management software Turn off the LED indicators If you do not want others to notice the network camera is in operation you can select ...

Page 37: ... manually Note that the date and time format are yyyy mm dd and hh mm ss Automatic The Network Time Protocol is a protocol which synchronizes computer clocks by periodically querying an NTP Server NTP server Assign the IP address or domain name of the time server Leaving the text box blank connects the Network Camera to the default time servers The precondition is that the camera must have the acc...

Page 38: ...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 39: ...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 40: ...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 41: ...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 42: ...e Short message Email GSM Modem HTTP PTZ Digital output 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 43: ... 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 44: ...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 45: ... the lens focus position using the previously saved position parameters If none of the options is selected all settings will be restored to factory default The following message is displayed during the restoring process Import Export files This feature allows you to Export Update daylight saving time rules custom language file configuration file and server status report Export daylight saving time...

Page 46: ...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 47: ...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 48: ...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 49: ... exterior design of a building The interior of a building can be shaped as a narrow rectangular space such as a corridor The conventional HD image such as that of a 16 9 aspect ratio will be incongruous 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 appli...

Page 50: ...s close to the lens and the IR lights For example if an intruder has a chance of getting near the range of 3 meters Smart IR can effectively reduce the over exposure For a surveillance area at a greater distance e g 5 meters the Smart IR function may not bring as significant benefits as in close range Smart IR When enabled the camera automatically adjusts the IR projection to adjacent objects in o...

Page 51: ...r to accept infrared light 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 Exclude x Tips If there is an object in close proximity the IR l...

Page 52: ...me for the day mode Note that the time format is hh mm and is expressed in 24 hour clock time By default the start and end time of day mode are set to 07 00 and 18 00 Light sensor sensitivity Tune the responsiveness of the IR filter to lighting conditions as Low Normal or High When completed with the settings on this page click Save to enable the settings ...

Page 53: ...ain slide bars Image Adjustment 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 Adjust the image sharpness level which ranges from 0 to 0 45 You may let f...

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

Page 55: ...measurement window s for low light compensation For example where low light objects are posed against an extremely bright background You may want to exclude the bright sunlight shining through 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 ...

Page 56: ...ndow refers to ignored window It adopts the weighed 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 will be deducted from the inclusive window An exposure value will then be calculated out of the remaining of the inclus...

Page 57: ...you want to configure another sensor setting for day night schedule mode please click Profile to open the Profile of exposure settings page as shown below Activated period Select the mode this profile to apply to Day mode Night mode or Schedule mode Please manually enter a range of time if you choose Schedule mode Then check Save to take effect AE Speed Adjustment This function applies when you ne...

Page 58: ...nction 1 Select from the bottom of the screen whether you want to perform focus adjustment on the Full view or within a Custom focus window You can create a custom window and click and drag the window to a desired position on screen 2 It is recommended to Reset to the default back focus position of the sensor board 3 You can use the Open iris checkbox default to increase the iris size for a better...

Page 59: ...s window and drag it to a place of interest in your view window Note that it is recommended to use this function only when you have a solid object in your view window that is showing a consistent color or texture This function will not take effect if you set the focus window on a distant background 5 Wait for the scan to complete After a short while the clearest image obtained should be displayed ...

Page 60: ...You 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 NOTE Up to 5 privacy mask windows can be set up on the same screen If you want to delete the privacy mask window pl...

Page 61: ... Stream 3 is set to the 640 x 480 Stream 4 The default frame size for Stream 3 is set to the 2560 x 1920 and the Viewing Window function is not available for stream 4 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 int...

Page 62: ...indow Region of Interest Output frame size Stream 1 2560 X 1920 176 x 144 Selectable 2560 X 1920 176 x 144 Selectable Stream 2 2560 X 1920 176 x 144 Selectable 2560 X 1920 176 x 144 Selectable Stream 3 2560 X 1920 176 x 144 Selectable 2560 X 1920 176 x 144 Selectable Stream 4 Fixed Fixed NOTE Please follow the steps below to set up those settings for a stream 1 Select a stream for which you want t...

Page 63: ...rame size and lower bit rate for remote viewing on mobile phones and a larger video size and a higher bit rate for live viewing on web browsers or recording the stream to an NVR Note that a larger frame size takes up more bandwidth Maximum frame rate This limits the maximum refresh frame rate per second Set the frame rate higher for smoother video quality and for recognizing moving objects in the ...

Page 64: ...etely self referential and they are largest in size The P frames are predicted frames The encoder refers to the previous I or P frames for redundant image information 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 ...

Page 65: ...ction the bandwidth for streaming a medium traffic scene can be reduced to 2 3Mb s and during the no traffic period of time down to 500kb s P I P P P P P P P P P P P P P P P P P P P I P I P P P P P P P I P P P P P P P I Static scene Activities P P P Dynamic Intra Frame w static scenes Dynamic Intra Frame w activities in scenes ...

Page 66: ...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 67: ... In the 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 an...

Page 68: ...of 40Mbps The bit rate then becomes the Average or Upper bound bit rate number The Network Camera will strive to deliver video 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...

Page 69: ...nes and a larger video size and a higher bit rate for live viewing on web browsers Note that a larger frame size takes up more bandwidth Maximum frame rate This limits the maximum refresh frame rate per second Set the frame rate higher for smoother video quality If the power line frequency is set to 50Hz the frame rates are selectable from 1fps to 25fps If the power line frequency is set to 60Hz t...

Page 70: ...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 71: ... 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 16 for details 2 Enter the Static IP Subnet mask Default router and Primary DNS provided by y...

Page 72: ... 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 73: ...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 74: ...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 75: ... 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 76: ... format Please refer to HTTP streaming on page 79 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 77: ... audio simultaneously By using the Network Camera s built in or external microphone and an external speaker you can communicate with people around the Network Camera Note that as JPEG only transmits a series of JPEG images to the client to enable the two way audio function make sure the video mode is set to H 264 on the Media Video Stream settings page and the media option is set to Media Video St...

Page 78: ...erver By default the FTP port is set to 21 It also can be assigned to another port number between 1025 and 65535 2011 03 09 17 08 56 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 79: ...er 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 80: ...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 or 4 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 Sec...

Page 81: ... when the access name for stream 1 is set to live 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 numb...

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

Page 88: ...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 89: ...have the ability to control the Network Camera through the main page Please refer to Configuration on page 35 Allow anonymous viewing If you check this item any client can access the live stream without entering a User ID and Password Account Management Administrators can create up to 20 user accounts 1 Input the new user s name and password 2 Select the privilege level for the new user account Cl...

Page 90: ...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 91: ...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 92: ...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 93: ...py the certificate request from your request prompt and paste it in the CA s signing request window Proceed with the rest of the process as CA s instructions on their webpage 6 Once completed your SSL 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 Ul...

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

Page 95: ... 95 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 96: ...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 97: ...e 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 98: ...arily and will automatically try to re link again IE Explore or Quick Time Player Filter Enable access list filtering Check this item and click Save if you want to enable the access list filtering 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 canno...

Page 99: ... 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 100: ...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 101: ...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 102: ...Z Operation The e PTZ control settings section will be displayed as shown below For e PTZ related details please refer to page 104 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 in out the live viewing window as the picture shown on t...

Page 103: ...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 104: ...he Patrol locations list 3 Set the Dwelling time for the preset location during an auto patrol 4 If you want to delete a preset location from the Patrol locations list select it and click Remove 5 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 ...

Page 105: ...t Positions will also be displayed on the Home page Select one from the Go to menu and the Network Camera will move to the selected preset position Click Patrol The Network Camera will patrol along the selected positions repeatedly NOTE ...

Page 106: ...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 107: ...anism 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 Moti...

Page 108: ...stem event The triggering condition can be an input exceeding or falling below a threshold Audio detection can take place as a complement to motion detection or as a method to detect activities not covered by the camera s view 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...

Page 109: ...vated Specify the length of the trigger interval in the text box Backup media if the network is disconnected Select this option to backup media file on SD card if the network is disconnected This function will only be displayed after you set up a network storage NAS The media to back up can include snapshot images video or system logs depending on your event settings Once the triggers are configur...

Page 110: ...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 111: ...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 112: ...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 113: ...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 135 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 114: ...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 2015 01 20 2015 01 20 2015 01 20 2015 01 20 ...

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

Page 116: ...eam 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 seconds...

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

Page 118: ... 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 119: ...n 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 20150213 20150213 Click to upload a file Click to modify the script online ...

Page 120: ...Item 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 lon...

Page 121: ...as shown below Another three motion detection windows can be configured on this page Please follow the steps beolw to set up a profile 1 Create a new motion detection window 2 Click the Profile mode tab 3 Select the applicable Schedule mode Please manually enter a time range 4 Click Save to enable the settings and click Close to exit the page Larger than the min item size Photos or videos can be c...

Page 122: ...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 123: ...rk Camera 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 107 for detailed information ...

Page 124: ...or the difference between current frame and pre saved background exceeds the trigger threshold Conditions such as image too dark too bright or too blurry defocused can also be configured as tampering conditions The Trigger threshold determines how sensitive your is tamper detection setting Lower the threshold number easier to trigger Too bright shining a flash light The average lighting level of t...

Page 125: ... 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 126: ... Refer to page 70 for Audio settings and page 63 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 127: ...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 128: ... 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 129: ...Internet connection 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 user You can proced with the following link to download a license key http www vivotek com vadp_requestactivation aspx application VCA When the license key is downloaded to your computer upload the key to the ...

Page 130: ...Add to open the recording setting window On this page you can define the adaptive recording recording source recording schedule and recording capacity A total of 2 recording settings can be configured 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 contro...

Page 131: ...iggered 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 ...

Page 132: ...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 133: ...ximum 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 ma...

Page 134: ...on about folder naming rules please refer to page 113 for details 20150210 20150211 20150212 f you want to enable recording notification please click Event to configure event triggering settings Please refer to Event Event settings on page 106 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 135: ...s 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 storage space c...

Page 136: ...This section explains how to manage the content of recorded videos on the Network Camera Here you can search and view the records and view the searched results Searching and Viewing the Records This column allows 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 attribute...

Page 137: ...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 138: ...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 139: ...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 140: ...ubdir cgi ext parameter value parameter value Example Set digital output 1 to active http mywebserver cgi bin dido setdo cgi do1 1 4 Security Level SECURITY LEVEL SUB DIRECTORY DESCRIPTION 0 anonymous Unprotected 1 view anonymous viewer dido camctrl 1 Can view listen talk to camera 2 Can control DI DO PTZ of the camera 4 operator anonymous viewer dido camctrl operator Operator access rights can mo...

Page 141: ...he 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 Content Type text html...

Page 142: ...gi parameter value parameter value update value return return page http servername cgi bin admin setparam cgi parameter value parameter value update value return return page PARAMETER VALUE DESCRIPTION group _ name value to assigned Assign value to the parameter group _ name update boolean Set to 1 to update all fields no need to update parameter in each group return return page Redirect to the pa...

Page 143: ...parameter pair is parameter value r n parameter pair Only the parameters 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 144: ...ed 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 blank string everything inside A des...

Page 145: ...uct WebAPIs non available The API is not in product WebAPIs valid The API is listed in product WebAPIs and is functional non valid The API is listed in product WebAPIs but is malfunction in this status decimal Any decimal number expressed in 32 bits ranging from 1 18e 38 3 40e 38 NOTE The camera should not be restarted when parameters are changed ...

Page 146: ... to use NTP to synchronize time datetime MMDDhhmmYYYY ss 6 6 Another current time format of the system ntp domain name ip address blank 6 6 NTP server Do not use skip to invoke default server for default value timezoneindex 489 529 6 6 Indicate timezone and area 480 GMT 12 00 Eniwetok Kwajalein 440 GMT 11 00 Midway Island Samoa 400 GMT 10 00 Hawaii 360 GMT 09 00 Alaska 320 GMT 08 00 Las Vegas San_...

Page 147: ...Kuwait Riyadh Moscow St Petersburg Nairobi 121 GMT 03 00 Iraq 140 GMT 03 30 Tehran 160 GMT 04 00 Abu Dhabi Muscat Baku Tbilisi Yerevan 180 GMT 04 30 Kabul 200 GMT 05 00 Ekaterinburg Islamabad Karachi Tashkent 220 GMT 05 30 Calcutta Chennai Mumbai New Delhi 230 GMT 05 45 Kathmandu 240 GMT 06 00 Almaty Novosibirsk Astana Dhaka Sri Jayawardenepura 260 GMT 06 30 Rangoon 280 GMT 07 00 Bangkok Hanoi Jak...

Page 148: ...nteger 7 6 Restore the system parameters to default values after value seconds 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 ...

Page 149: ... in the system 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 union of the combined results restoreexceptfocusvalue 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 Wh...

Page 150: ...ncluding 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 language_i 0 count 1 string 16 language_i0 English language_i1 Deutsch language_i2 Español language_i3 Français language_i4 Italiano language_i5 日本語 language_i6 Português language_i7 简体中文 language_i8 繁體中文 0 7 Available language lists...

Page 151: ...enum_sip 0 positive integer 6 7 Current number of SIP connections eth_i0 string 1 7 Get network information from mii tool vi_i 0 capability_nvi 1 product dependent boolean 1 7 Virtual input 0 Inactive 1 Active capability nvi 0 7 3digital input behavior define Group di_i 0 n 1 for n is the value of capability_ndi capability ndi 0 NAME VALUE SECURITY get set DESCRIPTION normalstate high low 1 1 Indi...

Page 152: ...mctrl 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 6 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 _ privilege view operator ...

Page 153: ...se 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_http_port 5556 network_rtp_videoport 20480 type lan pppoe 6 6 Network connection type resetip boolean 6 6 1 Get ipaddress sub...

Page 154: ...ssword for TLS privatekeypassword string 200 6 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 6 Certificate installed flag for TLS certificate_time 0 positive integer 6 7 Certificate installed time Represented in EPOCH certificate_size 0...

Page 155: ...os 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 capability protocol ipv6 0 N...

Page 156: ...ty_nmediast ream 1 _accessname product dependent 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 video mjpg s0_accessname stream1 video2 mjpg s1_accessname stream2 video3 mjpg s2_accessname stream3 video4 mjpg s3_accessname stream4 etc anonymousviewing boolean 1 6 Enable anony...

Page 157: ...peg 1 and capability nmediastream 0 The value are shown as live sdp s0_accessname stream1 live2 sdp s1_accessname stream2 live3 sdp s2_accessname stream3 live4 sdp s3_accessname stream4 etc 7 6 7 1 RTSP multicast Subgroup of network_rtsp_s 0 n 1 multicast n is stream count NAME VALUE SECURITY get set DESCRIPTION alwaysmulticast boolean 4 4 Enable always multicast ipaddress ip address 4 4 Multicast...

Page 158: ... audio port Only available when capability_naudioin 0 metadataport 1026 65534 4 4 Multicast metadata port ttl 1 255 4 4 Multicasttime to live value 7 6 8 SIP port Subgroup of network sip capability protocol sip 0 NAME VALUE SECURITY get set DESCRIPTION port 1025 65535 1 6 SIP port 7 6 9 RTP port Subgroup of network rtp NAME VALUE SECURITY get set DESCRIPTION videoport 1025 65535 6 6 Video channel ...

Page 159: ...olean 6 6 Enable administrator IP address admin_ip string 43 6 6 Administrator IP address maxconnection 1 10 6 6 Maximum number of concurrent streaming connection 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 string 43 6 6 IPv6 address ...

Page 160: ...n 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 to 10000K outdoor auto white balance mode specifically for outdoor indoor auto white balance mode specifically for indoor sodiumauto sodium vapor lamps Onl...

Page 161: ...e version number httpversion is equal or greater than 0301a It s recommanded to use exposurewin_c n _mode to switch on off BLC color 0 1 4 4 0 monochrome 1 color flip boolean 4 4 Flip the image mirror boolean 4 4 Mirror the image rotate 0 90 180 270 1 4 The rotation angle of image Support only in Rotation mode capability videoin c n rotation 1 ptzstatus 0 positive integer 1 7 A 32 bit integer each...

Page 162: ... when piris_mode manual or irismode fixed Only available when capability_image_c n _exposure_rangetyp e is twovalues maxexposure product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c n _exposure_ma xrange 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 ...

Page 163: ...ependent auto manual rbgain widerange outdoor indoor sodiumauto etc Available values are listed in capability_image_c n _wbmode 4 4 Modes of white balance auto Auto white balance 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 ...

Page 164: ...n_c n _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 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 exposuremode product dependent auto shutterpriority irispriority manual etc Available options are list in 4 4 Select...

Page 165: ...lling and flicker effect first fixed Open the iris to maximum Only available when capability_image_c n _iristype dc iris piris_mode product dependent manual indoor outdoor 1 4 Control P Iris mode outdoor Auto setting P Iris to get best quality but easy to meet rolling or flicker effect in indoor environment indoor Avoid rolling and flicker effect first manual Manual set P Iris by piris_position no...

Page 166: ... maxgain 0 100 4 4 Maximum gain value 0 Low 100 High Only available when capability_image_c n _agc_maxgai n Only valid when piris_mode manual or irismode fixed Normalized range Only available when capability_image_c n _exposure_ra ngetype is twovalues mingain 0 100 4 4 Minimum gain value 0 Low 100 High Only available when capability_image_c n _agc_mingai n Only valid when piris_mode manual or iris...

Page 167: ...ation 1 ptzstatus 0 positive integer 1 7 A 32 bit integer each bit can be set separately as follows Bit 0 Support camera control function 0 not support 1 support Bit 1 Built in or external camera 0 external 1 built in Bit 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 oper...

Page 168: ...000s 5 8000 1 5s 1 8000s etc Only available when capability_image_c n _exposure_m inrange Only valid when piris_mode manual or irismode fixed Only available when capability_image_c n _exposure_ra ngetype is twovalues maxexposure product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c n _exposure_ maxrange 4 4 Maximum exposure time 1 32000 1s 1 32000s 5 3...

Page 169: ...me per exposure time Ex If this is set to 1 5s 1 8000s and camera takes 1 5s on the night then sensor only outputs 5 frame s Only available when capability_image_c n _exposure_m axrange and capability_image_c n _exposure_ra ngetype 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 Pre...

Page 170: ...minresolution 1 4 Video resolution in pixels s 0 m 1 _h 264_dintraperio d_enable boolean 4 4 Enable Dynamic intra frame period Only available when capability_videoin_c 0 n 1 _dint raperiod_support is 1 We support this parameter when the version number httpversion is equal or greater than 0301c s 0 m 1 _h 264_intraperiod 250 500 1000 2000 3000 4000 4 4 The time interval between two I frames Intra c...

Page 171: ...quality 100 Best quality Only valid when ratecontrolmode vbr and quant 100 s 0 m 1 _h 264_maxvbrbitr ate 20000 capability_videoin_c n _h2 64_maxbitrate 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 ratecontrolmode vbr s 0 m 1 _h 264_cbr_quant 1 5 100 4 4 Set the pre defined quality level 1...

Page 172: ...1 _h 264_maxframe 1 capability_videoin_c n _h264_m axframerate 1 4 The maximum frame rates of a H264 stream at different resolutions capability_videoin_c0_re solution are recorded in capability_videoin_c n _h264_maxf ramerate s 0 m 1 _h 264_profile 0 2 1 4 Indicate H264 profiles 0 baseline 1 main profile 2 high profile s 0 m 1 _h 265_dintraperio d_enable boolean 4 4 Enable Dynamic intra frame peri...

Page 173: ...od 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 ratecontrolmode vbr s 0 m 1 _h 265_qvalue 0 51 4 4 Manual video quality level input The Q value which is used by encoded library directly Only available when h265 is listed in capability_videoin_codec Only valid when ratecontrolmode v...

Page 174: ...re 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 ratecontrolmode cbr Only available when capability_smartstream_version 2 0 s 0 m 1 _h 265_cbr_qperce nt 1 100 4 4 Select customized quality in a normalized full range 1 Worst quality 100 Best quality Only available w...

Page 175: ...stream at different resolutions capability_videoin_c0_re solution are recorded in capability_videoin_c n _h265_maxf ramerate Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h 265_profile 0 2 1 4 Indicate H265 profiles 0 baseline 1 main profile 2 high profile Only available when h265 is listed in capability_videoin_codec s 0 m 1 _m jpeg_ratecontro lmode cbr vbr 4 4 cbr Const...

Page 176: ...nd s 0 m 1 _mjpeg_quant 99 s 0 m 1 _m jpeg_qpercent 1 100 4 4 Select customized quality in a normalized full range 1 Worst quality 100 Best quality Only valid when ratecontrolmode vbr and s 0 m 1 _mjpeg_quant 100 s 0 m 1 _m jpeg_maxvbrbit rate 20000 capability_videoin_c n _mj peg_maxbitrate 4 4 The maximum allowed bit rate in fixed quality mode When the bit rate exceeds this value frames will be d...

Page 177: ... 0 m 1 _m jpeg_prioritypoli cy framerate imagequality 4 4 Set prioritypolicy Only valid when ratecontrolmode cbr s 0 m 1 _m jpeg_maxframe 1 capability_videoin_c n _mjpeg_ maxframerate 1 4 The maximum frame rates of a mjpeg stream at different resolutions capability_videoin_c0_re solution are recorded in capability_videoin_c n _mjpeg_ma xframerate wdrpro_mode product dependent boolean 4 4 Enable WD...

Page 178: ...ity_image_c n _aespeed is 1 aespeed_speedl evel product dependent 1 100 4 4 The speed level of AE converge speed 1 20 level 1 21 40 level 2 41 60 level 3 61 80 level 4 81 100 level 5 Level 1 4 low high The higher speed level meas shorter AE converged time during AE executing Only available when capability_image_c n _aespeed is 1 aespeed_sensiti vity product dependent 1 100 4 4 The sensitivity of A...

Page 179: ...dent 0 1 1 6 0 Not to add watermarks on images 1 Add watermarks on images Only available when capability_fisheye 0 s 0 m 2 _fi sheyedewarpmo de product dependent 1O 1P 2P 1R 4R for ceiling floor mount 1O 1P 1R 4R for wall mount product dependent 1 4 Local dewarp mode 1O is original mode disable Supported dewarp mode is different by mount type videoin_c n _mounttype Supported mode list could be ext...

Page 180: ...tream_mode_hybri d is 1 qualitypriority 5 4 3 2 1 1 2 3 4 5 4 4 The differential value of Q between the regions of interest ROI and the areas of non interest non ROI of the display image If the value is a positive number the video quality of ROI is better than the non ROI areas The level is from 1 to 5 Level 5 is the maximum level of the quality difference between the ROI and non ROI areas If the ...

Page 181: ...ent scene of light daytime or nighttime Group videoin_c 0 n 1 _profile_i 0 m 1 for n channel profucts and m profile n denotes the value of capability_nvideoin and m denotes the value of capability_nvideoinprofile capability nvideoinprofile 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable disable this profile setting policy night schedule 4 4 The mode which the profile is applied...

Page 182: ...nd camera takes 1 5s on the night then sensor only outputs 5 frame s Only available when capability_image_c n _exposure_maxrang e Only valid when piris_mode manual or irismode fixed Only available when capability_image_c n _exposure_rangetyp e is twovalues shuttervalue product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c n _exposure_ma xrange 4 4 Expo...

Page 183: ...ecommanded to use exposurewin_c n _mode to switch on off BLC exposurelevel 0 12 4 4 Exposure level 0 12 This range takes the concept 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 exposuremode product dependent auto shutterpriority irispriority manual etc Available options are...

Page 184: ...eep 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 to 10000K outdoor auto white balance mode specifically for outdoor indoor auto white balance mode specifically for indoor sodiumauto sodium vapor lamps Only available when capability_ima...

Page 185: ...s mingain 0 100 4 4 Minimum gain value 0 Low 100 High Only available when capability_image_c n _agc_mingain Only valid when piris_mode manual or irismode fixed Normalized range Only available when capability_image_c n _exposure_rangetyp e is twovalues gainvalue 0 100 4 4 Gain value 0 Low 100 High Only available when capability_image_c n _agc_maxgain and capability_image_c n _exposure_rangetyp e is...

Page 186: ...hen capability_image_c n _iristype piris irismode fixed indoor outdoor product dependent 4 4 Control DC Iris mode outdoor Auto setting DC Iris to get best quality but easy to meet rolling or flicker effect in indoor environment indoor Avoid rolling and flicker effect first fixed Open the iris to maximum Only available when capability_image_c n _iristype dciris wdrpro_mode product dependent boolean...

Page 187: ...80 level 4 81 100 level 5 Level 1 4 low high The higher speed level meas shorter AE converged time during AE executing Only available when capability_image_c n _aespeed is 1 aespeed_sensitivity 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...

Page 188: ...ALUE SECURITY get set DESCRIPTION mode auto day night di schedule product dependent 6 6 Set IR cut control mode sir product dependent boolean 6 6 Enable disable Smart IR Only available when capability_daynight_c 0 capability_nvideoi n 1 _smartir is 1 daymodebegintime 00 00 23 59 6 6 Day mode begin time daymodeendtime 00 00 23 59 6 6 Day mod end time disableirled boolean 6 6 Enable disable built in...

Page 189: ...ed sensitivity low normal high if capability_daynight _c n _ircutsensitiv ity_type options 1 100 if capability_daynight _c n _ircutsensitiv ity_type normalize 6 6 Sensitivity of day night control There are two value format low normal high if capability_daynight_c n _ircutsensitivity_ty pe options 1 100 if capability_daynight_c n _ircutsensitivity_ty pe normalize Only available when capability_dayn...

Page 190: ...sion number httpversion is equal or greater than 0400a contrast Not recommended to use this 5 5 100 4 4 5 Less contrast 5 More contrast 100 Use image_c n _contrastpercent Only available when bit 1 of capability_image_c n _basicsetting is 1 We replace contrast with contrastpercent This parameter will not be used after the version number httpversion is equal or greater than 0400a saturation Not reco...

Page 191: ...nt 0 100 4 4 Set contrast in the normalized range 0 Less contrast 100 More contrast Only available when bit 1 of capability_image_c n _basicsetting is 1 saturationpercent 0 100 4 4 Set saturation in the normalized range 0 Less saturation 100 More saturation Only available when bit 2 of capability_image_c n _basicsetting is 1 sharpnesspercent 0 100 4 4 Set sharpness in the normalized range 0 Softer...

Page 192: ...disable defog mode 0 disable 1 enable Only available when capability_image_c n _defog_mode is 1 defog_strength product dependent 1 100 4 4 Strength of defog Only available when capability_image_c n _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 n _is_mode eis_strength product dependent 1...

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

Page 194: ...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 n _saturationpercent Only available when bit 2 of capability_image_c n _basicsetting is 1 We replace profile_i0_saturation with profile_i0_saturationpercent This p...

Page 195: ...3 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 n _gammacurve is 1 profile_i 0 m 1 _lowlightm ode product dependent boolean 4 4 Enable disable low light mode Only available when capability_image_c n _l...

Page 196: ..._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 n _is_mode profile_i 0 m 1 _dis_streng th product dependent 1 100 4 4 Strength of digital image stabilizer Only available when dis is listed in capability_image_c n _is_mode profile_i 0 m 1 _scene_ena ble product dependent boolean 4 4 Enable disable s...

Page 197: ...c 0 n 1 _win_i 0 k 1 n denotes the value of capability_nvideoin k denotes the value of capability_image_c n _exposure_winnum Only available when custom is listed in capability_image_c n _exposure_winmode and valid when exposurewin_c n _mode custom or exposurewin_c n _mode hlc NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable or disable the window policy 0 1 4 4 0 Indicate exclusive...

Page 198: ... 0 n 1 _profile_i 0 m 1 for n channel profuct and m profile n denotes the value of capability_nvideoin m denotes the value of capability_nvideoinprofile Only available when capability_image_c n _exposure_mode 1 NAME VALUE SECURITY get set DESCRIPTION mode auto custom blc hlc Available values are listed in capability_image_c n _exposu re_winmode 4 4 The mode indicates how to decide the exposure aut...

Page 199: ...i n size 0 320x0 240 4 4 Width and height of the window Only available when qvga is listed in capability_image_c n _exposure_windomai n homepx 0 W 0 H W 0 The current image width 1 H 0 The current image height 1 4 4 Left top corner coordinate of the window Only available when px is listed in capability_image_c n _exposure_windomai n sizepx 0 Wx0 H W 0 The current image width 1 H 0 The current imag...

Page 200: ... 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 updated during booting to fit switch status volume_internal 0 100 4 4 Volume when tak...

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

Page 202: ...big Big endian bitstream format Only available if G 726 is supported s0_g726_vlcmode 0 1 4 4 Enable vlcmode for G 726 0 Standard mode 1 Solve compatibility problem with VLC player Only available if G 726 is supported alarm_enable boolean 4 4 Enable audio detection alarm_level 1 100 4 4 Audio detection alarm level profile_i0_enable boolean 4 4 Enable disable this profile setting profile_i0_policy n...

Page 203: ...nable boolean 4 4 Enable motion detection window name string 14 4 4 Name of motion window polygonstd 0 9999 0 9999 0 9999 0 9999 0 9999 0 9999 0 9999 0 9999 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 std is listed in capability_motion_windomain objsize 1 100 4 4 Percent of motion detection win...

Page 204: ...ain It s recommended to use polygonsd This parameter will not be used after the version number httpversion is equal or greater than 0400a left Not recommended to use this 0 320 4 4 Left coordinate 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 u...

Page 205: ...a 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 Group motion_c 0 n 1 _profile_i 0 m 1 for m profile and n channel product n denotes the value of capability_nvideoin m denotes the vaule of capability_nmotionprofile capability_nmotionprofile 0 NAME VALUE SECURITY get set D...

Page 206: ...available when capability_motion_wintype polygon Only available when std is listed in capability_motion_windomain objsize 1 100 4 4 Percent of motion detection window sensitivity Not recommended to use this 0 100 4 4 Sensitivity of motion detection window We replace sensitivity with win_sensitivity This parameter will not be used after the version number httpversion is equal or greater than 0400a ...

Page 207: ...ion_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 top Not recommended to use this 0 240 4 4 Top coordinate of window position Only available when capability_motion_wintype rectangle Only available when qvga is listed in capabili...

Page 208: ... NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable or disable tamper detection threshold 0 100 4 4 Threshold of tamper detection duration 10 600 4 4 If tampering value exceeds the threshold for more than duration second s then tamper detection is triggered ignorewidth 0 positive integer 1 7 Indicate the width to offset to start to analysis the image dark_enable boolean 4 4 Enable o...

Page 209: ... NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable or disable the dynamic DNS provider CustomSafe100 DyndnsDynamic DyndnsCustom Safe100 6 6 Safe100 safe100 net DyndnsDynamic dyndns org dynamic DyndnsCustom dyndns org CustomSafe100 Custom server using safe100 method provider _hostname string 128 6 6 Your DDNS hostname provider _usernameem ail string 64 6 6 Your user name or email to...

Page 210: ...ing 64 6 6 The url user define to link to camera 7 18 UPnP presentation Group upnppresentation NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable or disable the UPnP presentation service 7 19 UPnP port forwarding Group upnpportforwarding NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable or disable the UPnP port forwarding service upnpnatstatus 0 3 6 7 The status of U...

Page 211: ...OG_DEBUG setparamlevel 0 2 6 6 Show log of parameter setting 0 disable 1 Show log of parameter setting set from external 2 Show log of parameter setting set from external and internal 7 21 SNMP Group snmp capability protocol snmp 0 NAME VALUE SECURITY get set DESCRIPTION v2 boolean 6 6 SNMP v2 enabled 0 for disable 1 for enable v3 boolean 6 6 SNMP v3 enabled 0 for disable 1 for enable secnamerw st...

Page 212: ...ITY get set DESCRIPTION logo_default boolean 1 6 0 Custom logo 1 Default logo logo_link string 128 http www vivotek com 1 6 Hyperlink of the logo logo_powerbyvvtk_hidden boolean 1 6 0 display the power by vivotek logo 1 hide the power by vivotek logo custombutton_manualtrig ger_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...

Page 213: ...left 0 320 4 4 Left coordinate of window position Only available when capability_image_c n _privacymask_wintype rectangle win_i 0 m 1 _top 0 240 4 4 Top coordinate of window position Only available when capability_image_c n _privacymask_wintype rectangle win_i 0 m 1 _width 0 320 4 4 Width of privacy mask window Only available when capability_image_c n _privacymask_wintype rectangle win_i 0 m 1 _he...

Page 214: ...mage_c n _privacymask_wintype polygon Only available when std is listed in capability_image_c n _privacymask_windomai n 7 24 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 _nprivacymask NAME VALUE SE...

Page 215: ...ring 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 change remove the old features interfaces or the firmware has substantially change in architecture and not able to roll back to previous version This may cause incompatibilit...

Page 216: ...tuptime positive integer 0 7 Server bootup time nir Not support anymore 0 positive integer 0 7 Number of IR interfaces Recommand to use capability_daynight_c 0 capability_nvideoi n 1 _builtinir for built in IR and capability_daynight_c 0 capability_nvideoi n 1 _externalir for external IR Not support this parameter anymore when the version number httpversion is equal or greater than 0301a npir 0 po...

Page 217: ... nuart 0 positive integer 0 7 Number of UART interfaces nmotion positive integer 0 7 The number of motion window nmotionprofile 0 positive integer 0 7 Number of motion profiles 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 Built in or external video source 0 external 1 built in Bit 2...

Page 218: ...port both zoom and focus function bit 1 Only support zoom function bit 2 Only support focus function bit 3 Currently this is a reserved bit and the default value is 0 It s strongly non recommended to use this This is reserved for compatibility and will not be used after the version number httpversion is equal or greater than 0400a We replace capability_remotefocus with capability_image_c0_remotefo...

Page 219: ...nnel iva boolean 0 7 Indicate whether to support Intelligent Video analysis whitelight boolean 0 7 Indicate whether to support white light led iris boolean 0 7 Indicate whether to support iris control supportsd boolean 0 7 Indicate whether to 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 ...

Page 220: ... 7 Indicate whether to support SIP protocol_maxconnection positive integer 0 7 The maximum number of allowed simultaneous connections protocol_maxgenconnecti on positive integer 0 7 The maximum general streaming connections protocol_rtp_multicast_sc alable boolean 0 7 Indicate whether to support scalable multicast protocol_rtp_multicast_ba ckchannel boolean 0 7 Indicate whether to support backchan...

Page 221: ...erate This is kept for compatibility videoin_mjpeg_maxframe rate A list of Integer and 0 7 This equals capability_videoin_c0_mjpeg_maxframerate This is kept for compatibility videoin_h264_maxframer ate A list of Integer and 0 7 This equals capability_videoin_c0_h264_maxframerate This is kept for compatibility videoin_codec mjpeg h264 h265 product dependent 0 7 Available codec of a device split by ...

Page 222: ...d by physical jump on device No WebAPI to control it This value is set only on camera power on and maintains the status Only available when httpversion 0301a timeshift boolean 0 7 Indicate whether to support time shift caching stream audio_aec boolean 0 7 Indicate whether to support acoustic echo cancellation audio_mic Not support anymore boolean 0 7 Indicate whether to support built in microphone...

Page 223: ...rts built in external mic switch audio_headphoneout Not support anymore boolean 0 7 Indicate whether to support headphone output Not support this parameter anymore when the version number httpversion is equal or greater than 0301a 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...

Page 224: ..._autot racking boolean 0 7 Indicate whether autotracking smart stream is supported only available when capability_smartstream_support is 1 smartstream_mode_man ual boolean 0 7 Indicate whether manual smart stream is supported only available when capability_smartstream_support is 1 smartstream_mode_hybri d boolean 0 7 Indicate whether hybrid autotracking manual smart stream is supported only availa...

Page 225: ...of VADP package that can be uploaded to the device thermal_support boolean 0 7 Indicate whether to support thermal IC thermal_controlmode auto customheater 0 7 Indicate the thermal control mode auto control by camera automatically customheater the threshold of heater can be sepcified by user only available when capability_thermal_support is 1 We support this parameter when the version number httpv...

Page 226: ...ork_wireless boolean 0 7 Indicate whether to support wireless wireless_s802dot11b boolean 0 7 Indicate whether to support wireless 802 11b wireless_s802dot11g boolean 0 7 Indicate whether to support wireless 802 11g wireless_s802dot11n boolean 0 7 Indicate whether to support wireless 802 11n wireless_beginchannel 1 14 0 7 Indicate the begin channel of wireless network wireless_endchannel 1 14 0 7 ...

Page 227: ...age_iristype Not recommended to use this string 0 7 Indicate iris type piris P Iris dciris DC Iris No Iris control support When capability_iris 0 this value must be Note For some box type cameras this value may be varied depending on mounted lens We replace capability_image_iristype with capability_image_c0_iristype Reserved for compatibility and suggest don t use this since httpversion 0301a imag...

Page 228: ...feature Only Sony SD card can support this function now remotecamctrl_master 0 positive integer 0 7 Indicate whether to support remote auxiliary camera master side this value means supporting max number of auxiliary camera remotecamctrl_slave boolean 0 7 Indicate whether to support remote camera control slave side fisheyelocaldewarp_c 0 capability_nvideoin 1 product dependent 0 positive integer 0 ...

Page 229: ...ger 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 between a varifocal and a zoom lens can be...

Page 230: ...er than 0304a Group capability_ptz_c 0 n 1 n denotes the value of capability_nvideoin capability_ptzenabled 0 and capability_camctrl_c 0 n 1 _zoommodule 0 We support this group when the version number httpversion is equal or greater than 0303b PARAMETER VALUE SECURITY get set DESCRIPTION panspeedlv 0 positive integer 0 7 The maximum speed level of pan motion Only available when bit0 of capability_...

Page 231: ...limit for tilt angle Only available when bit1 of capability_camctrl_c 0 n 1 _buildinpt is 1 maxtiltangle integer 0 7 The upper limit for tilt angle Only available when bit1 of capability_camctrl_c 0 n 1 _buildinpt is 1 zoomspeedlv 0 positive integer 0 7 The maximum speed level of zoom motion Only available when the value of capability_camctrl_c 0 n 1 _zoommodule is 1 minzoom 0 positive integer 0 7...

Page 232: ...n 1 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION support boolean 0 7 Indicate whether the camera supports day night mode switch builtinir boolean 0 7 Indicate whether to support built in IR led externalir boolean 0 7 Indicate whether to support external IR led smartir boolean 0 7 Indicate whether to support smart IR ircutfilter boolean 0 7 Indicate whethe...

Page 233: ...an 0302a ircutsensitivity_supportlevel 0 positive integer 0 7 The value indicate the support strength level of ircutsensitivity Only available when capability_daynight_c n _support is 1 and capability_daynight_c n _ircutsensitivity_typ e is not We support this parameter when the version number httpversion is equal or greater than 0302a extled_interface do irring product dependent 0 7 The device in...

Page 234: ...ct dependent 0 7 The lens type of this channel fisheye Fisheye lens fixed Build in fixed focus lens varifocal Build in varifocal lens changeable changeable lens Like box type camera users can install any C Mount or CS Mount lens as they wish motor Lens with motor to support zoom focus etc N A Only available when httpversion 0301a rotation boolean 0 7 Indicate current mode whether support video rot...

Page 235: ...n 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 fixed 6 which means exposurelevel is fixed to l...

Page 236: ... privacy mask per channel nresolution positive integer 0 7 The maximum resolution options listed in resolution in current video mode resolution A list of WxH product dependent 0 7 Resolution options in current video mode These options are the possible options for videoin_c n _s m _resolution The last one is the maximum resolution in current mode maxresolution A list of Integer 0 7 Represent suppor...

Page 237: ...nteger and 0 7 Maximum fps that the device can encoded with MJPEG 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 avai...

Page 238: ...eger 0 7 Maximum bitrates of H 264 The unit is bps Only available when h264 is listed in capability_videoin_codec h265_maxframerate A list of Positive Integer and 0 7 Maximum fps that the device can encoded with 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 ma...

Page 239: ...mera unit name of a split type camera system which the camera unit and the video core are separated If the camera is not a split type camera system the value of this parameter is We support this parameter when the version number httpversion is equal or greater than 0302b Group capability_videoin_c 0 n 1 _localdewarp capability_fisheyelocaldewarp_c 0 capability_nvideoin 1 0 n denotes the value of c...

Page 240: ... 7 Indicate this mode whether support eptz For nvideoin 1 the definition is as following A 32 bits integer each bit can be set separately as follows Bit 0 1st 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 a...

Page 241: ...source equal to the captured size by device in this video mode The unit is pixel This value is used as a basic coordinate system for many features like ePTZ privacy mask motion etc Source most for image sensor may perform scale or binning etc on image data and output data with smaller size This parameter is designed to represent this binning 0 1 3 0 7 Indicate binning is used or not in this video ...

Page 242: ...ber httpversion is equal or greater than 0304b maxframerate A list of Positive Integer 0 7 Indicates frame rate that the video source outputs 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 n _cmosfreq 60 or videoin_c n _modulation ntsc maxfps_mjpeg A list of Positi...

Page 243: ...de 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 n _cmosfreq 60 or videoin_c n _modulation ntsc Only available when h265 is listed in capability_videoin_codec description string 128 0 7 Description about this mode Group capability_image_c 0 n 1 n denotes the value ...

Page 244: ... mode fixed au to exposurewin mode blc disab led aespeed disabled exposurelevel hidden exposurelevel fixed x exposurelevel fixed x x exposurelevel ranged x x exposuremode fixed auto x nonnegative integer product dependent 0 7 When WDR Pro 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 Descripti...

Page 245: ...ble when capability_image_c 0 n 1 _wdrp ro_mode 0 wdrc_mode 0 1 0 7 0 Non support WDR Enhanced 1 Support WDR Enhanced wdrc_supportlevel 0 positive integer 0 7 Indicate the support strength level of WDR Enhanced wdrc_affect exposurewin mode fixed au to exposurewin mode blc disab led aespeed disabled exposurelevel hidden exposurelevel fixed x exposurelevel fixed x x exposurelevel ranged x x exposure...

Page 246: ...ich means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL For example exposurelevel fixed 6 8 12 which means exposurelevel is fixed to level 6 level 8 and level 12 means no feature is affected When wdrc 0 this value must be dnr 0 1 0 7 0 Non support 3D digital noise reduction 1 Support 3D digital noise reduction eis 0 1 0 7 0 Non support electronic imag...

Page 247: ...apability_image_c n _is_mode is not We support this parameter when the version number httpversion is equal or greater than 0302a is_affect minexposure hidden mingain hidden wdrpro unchanged 3dnr unchanged or others 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 functions are list here The format is Aff...

Page 248: ...lity_image_c n _is_mode 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_supporttype product dependent visibility noiseless lpcparkinglot lpcstreet product dependent 0 7 list all the scene mode which are supported in the camera Only available when capability_image_c ...

Page 249: ...ribed 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 visibility is listed in capability_image_c n _ scenemode_supporttype and capabilit...

Page 250: ...ed 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 vi...

Page 251: ...idden 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 fixed 6 which means exposurelevel is fixed ...

Page 252: ... 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 exposurewin mode blc disabled which means blc exposure window is disabled API name can be on...

Page 253: ...tsensor Smart sensor 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 We support this parameter when the version number httpversion is equal or greater than 030...

Page 254: ...m 0 7 One to one mapping to the mode type in exposure_modetype fixed The shutter value is the assigned value videoin_c n _gainvalue maximum The shutter value can be up to the assigned value videoin_c n _gainvalue not support Only available when capability_image_c n _exposure_ra ngetype is onevalue We support this parameter when the version number httpversion is equal or greater than 0302a exposure...

Page 255: ... 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 auto is listed in capability_image_c n _ exposure_modetype and capability_image_c n _ e...

Page 256: ...den 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 fixed 6 which means exposureleve...

Page 257: ...t 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 or values enabled UI is checked notsupport the affected function is not available Affect API name can ...

Page 258: ... 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 UI...

Page 259: ...ideoin_c n _exposurelevel When exposure_mode 0 this value must be set to exposure_winmode auto custom blc hlc product dependent 0 7 Available options for exposurewin_c n _mode means group exposurewin is not supported When exposure_mode 0 this value must be set to exposure_hlcmode_suppo rtwindow boolean 0 7 Indicate whether to support exposure window in hlc mode exposure_hlcmode_affect or others x ...

Page 260: ...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 manual is listed in capability_image_c n _ exposure_modetype and capability_image_c n _ exposure_winmode is hlc We support this parameter when the version number httpversion ...

Page 261: ...ilable total range for NTSC analog output Only available when httpversion 0301a exposure_pal_totalrange A list of Positive Integer 0 7 Available total range for PAL analog output Only available when httpversion 0301a exposure_maxrange 1 32000 1 8000 or others product dependent 0 7 Available range for videoin_c n _maxexposure 1 32000 1s 1 32000s 1 8000 1s 1 8000s etc means maximum exposure time is ...

Page 262: ...olor Positive Integer 0 7 Available total color numbers of privacy mask agc_maxgain 0 100 0 7 Available range for videoin_c n _maxgain 0 100 0 100 percent means videoin_c n _maxgain is not available agc_mingain 0 100 0 7 Available range for videoin_c n _mingain 0 100 0 100 percent means videoin_c n _mingain is not available flickerless 0 1 0 7 0 Non support flickerless 1 Support flickerless flicke...

Page 263: ...s 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 When flickerless 0 this value must be defog_mode 0 1 0 7 0 Non support defog 1 Support defog defog_strength 0 1 0 7 0 Non suppo...

Page 264: ...nchanged 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 exposurewin mode blc disabled which means blc exposure window is disabled API name can be one ...

Page 265: ...efocus 0 positive integer 0 7 An 4 bit integer which indicates the supportive application of remotefocus in this channel If the value of this parameter is larger than 0 it means that the camera supports remotefocus function in this channel 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 rese...

Page 266: ...iris value 0 7 Available total step for iris value We support this parameter when the version number httpversion is equal or greater than 0302a Only available when capability_image_c 0 n 1 _sens ortype is smartsensor Group capability_peripheral_c 0 n 1 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION waterspray_support boolean 0 7 0 Non support water spray fe...

Page 267: ...priority 0 1 2 6 6 Indicate the priority of this event 0 low priority 1 normal priority 2 high priority delay 1 999 6 6 Delay in seconds before detecting the next event trigger boot di pir motion seq recnotify tampering vi volalarm visignal vadp smartsd product dependent 6 6 Indicate the trigger condition boot System boot di Digital input pir PIR detection motion Video motion detection seq Periodi...

Page 268: ... detection is enabled vi 0 positive integer 6 6 Indicate the source id of vi trigger This field is required when trigger condition is vi One bit represents one digital input The LSB indicates VI 0 vadp product dependent 0 positive integer 6 6 Indicate the source id of vadp event notification Each bit corresponds to one vadp source and the LSB indicates source id 0 For example to detect event from ...

Page 269: ... 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 action_cf_folder string 128 6 6 Path to store media action_cf_media NULL 0 4 101 6 6 Index of the attached media 101 means Recording Notify action_cf_datefolder boolean 6 6 Enable this to create folders by date time and hour automatically action_cf_backup ...

Page 270: ...ER 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 email email server ftp FTP server http HTTP server ns network storage http_url string 128 6 6 URL of the HTTP server to upload http_username string 64 6 6 Username to log in to the server http_passwd string 64 6 6 Password of the user ftp_address string 128 6 6 ...

Page 271: ...ia_i 0 4 PARAMETER VALUE SECURITY get set DESCRIPTION name string 40 6 6 Identification of this entry type snapshot systemlog videoclip recordmsg 6 6 Media type to send to the server or store on the server 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 the third stream and etc 3 means the fourth...

Page 272: ... gth 6 6 Maximum duration of one video clip in seconds videoclip_maxsize 50 capability_media_videoclip_maxsiz e 6 6 Maximum size of one video clip file in Kbytes 7 30 Recording Group recording_i 0 1 PARAMETER VALUE SECURITY get set DESCRIPTION name string 40 6 6 Identification of this entry trigger schedule networkfail 6 6 The event trigger type schedule The event is triggered by schedule networkf...

Page 273: ...ecording_enabled is enabled limitsize boolean 6 6 0 Entire free space mechanism 1 Limit recording size mechanism cyclic boolean 6 6 0 Disable cyclic recording 1 Enable cyclic recording 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 L...

Page 274: ... size reserveamount 0 15000000 6 6 The reserved amount in Mbytes when choosing cyclic recording mechanism 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 string 128 6 6 Folder name maxsize 100 2000 6 6 Unit Mega bytes When this condition is reached recording file is truncated maxduration 60 3600 6 6 U...

Page 275: ...e https status 3 Certificate not installed 2 Invalid public key 1 Waiting for certificate 0 Not installed 1 Active countryname string 2 6 6 Country name in the certificate information stateorprovincename string 128 6 6 State or province name in the certificate information localityname string 128 6 6 The locality name in thecertificate information organizationname string 64 VIVOTEK Inc 6 6 Organiza...

Page 276: ... 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 this Please refers autocleanup group This parameter will not be used after the version number ...

Page 277: ...enabled maxretentiontime_others_e nabled boolean 6 6 Enable automatic clean up method for all media files except media files generated by recording task The parameter takes effect when autocleanup_enabled is enabled maxretentiontime_others_ maxage string 6 6 To specify the expired time for automatic clean up and it takes effect for all media files except media files generated by recording task For...

Page 278: ...nimal 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 64x6...

Page 279: ...CamCtrl 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 zoomspeed 5 5 1 4 Zoom speed Only available when capability_fisheye is 1 1 7 Zoom speed It should be set by eCamCtrl cgi rather than by setparam cgi autospeed 1 5 1 4 Auto pan patrol speed Only available when capab...

Page 280: ...than by setparam cgi preset_i 0 19 _size WxH product dependent 1 4 Width and height of the preset Only available when capability_fisheye is 1 1 7 Width and height of the preset It should be set by ePreset cgi rather than by setparam cgi 7 35 Focus Window setting Group focuswindow_c 0 n 1 for n channel products n denotes the value of capability_nvideoin capability_image_c 0 n 1 _remotefocus 1 or ca...

Page 281: ...rmsetting 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 Indicate free memory size for ...

Page 282: ...ring 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 from the system status string 40 6 6 Ind...

Page 283: ...l 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 the value of capability_npreset NAME VALUE SECURITY get set DESCRIPTION panspeed 5 5 1 4 Pan speed tiltspeed 5 5 1 4 Tilt speed zoomspeed 5 5 1 4 Zoom speed focusspeed 5 5 1 4 Auto focus speed patrolseq string 120 1 4 For external device The indexes of ...

Page 284: ... read only motortype string 16 6 7 Internal used read only cameraid 0 255 1 4 Camera ID controlling external PTZ camera Note Please set 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 ...

Page 285: ...on preset_i 0 k 1 _ dwelling 0 999 1 4 The dwelling time of each preset location patrolseq string 120 1 4 For external device The indexes of patrol points separated by patroldwelling string 160 1 4 For external device The dwelling time of each patrol point separated by disablemdonptz boolean 1 4 Disable motion detection on PTZ operation defaulthome boolean 1 4 This field tells system to use defaul...

Page 286: ...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 pan speed focusspeed 5 5 1 4 Auto focus speed focusmode auto onetimeauto spotligh t manual Available val...

Page 287: ...isable motion detection on PTZ operation defaulthome boolean 1 4 This field tells system to use default home position or not axisx capability_ptz_c 0 n 1 _minpan capability_ptz_c 0 n 1 _maxpan 1 4 Custom home pan position axisy capability_ptz_c 0 n 1 _mintilt capability_ptz_c 0 n 1 _maxtilt 1 4 Custom home tilt position axisz capability_ptz_c 0 n 1 _minzoom capability_ptz_c 0 n 1 _maxzoom 1 4 Cust...

Page 288: ...hen moving between presets Recorded tour unnecessary tour_i 0 19 _checklist string 512 1 4 The indexes of preset positions separated by tour_i 0 19 _dwelltime string 512 1 4 Preset tour time to wait before moving to the next preset position separated by Recorded tour number of seconds to wait before continuing a loop tour 7 41 UART control Group uart capability nuart 0 and capability fisheye 0 NAM...

Page 289: ...he PTZ driver is used by this COM port 7 42 UART control SD series Group uart_i 0 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 came...

Page 290: ...elected 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 set DESCRIPTION totalnumbers 0 positive integer 6 7 Totoal support number of the default lens profiles Group lens_user NAME VALUE SECURITY get set DESCRIPTION totalnumbers 0 positive integer 6 7 Totoal support number of the user lens prof...

Page 291: ...ME 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 regional view zoomspeed 5 5 integer 1 4 Zoom speed of regional s 0 m 2 _panorama_ panstart 0 359 integer 1 4 Initial pan position of panorama view only available for 1P and 2P mode at ceiling or floor mount s 0 m 2 _region_pan 90 359 integer 1 4 Pan home angle of region...

Page 292: ...utotrack_support 0 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION objsize_type 1 2 1 4 Type of object size 1 customized width and height 0 object size 30 x 30 1 object size 10 x 20 2 object size 10 x 10 objsize_customized_width 10 320 1 4 The minimum width of tracking target objsize_customized_height 10 240 1 4 The minimum height of tracking target sensitiv...

Page 293: ...e cgi bin dido setdo cgi do1 state do2 state do3 state do4 state Where state is 0 or 1 0 means inactive or normal state while 1 means active or triggered state PARAMETER VALUE DESCRIPTION do num 0 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 ...

Page 294: ...er is specified all of the digital input 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 di0 state r n di1 state r n di2 state r n di3 state r n where state can be 0 or 1 Example Query the status of digital input 1 Request http myserver cgi bin dido getdi cgi di1 Response HTTP 1 0 200 OK r n Content Type text plain r n Content Length 7...

Page 295: ...ter 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 be 0 or 1 Example Query the status of digital output 1 Request http myserver cgi bin dido getdo cgi do1 Response HTTP 1 0 200 OK r n Content Type text plain r n Content Length 7...

Page 296: ... DEFA ULT DESCRIPTION channel 0 n 1 0 The channel number of the video source resolution IP8165 160 640 120 360 IP8155 160 1280 120 1024 0 The resolution of the image quality 1 5 3 The quality of the image streamid 0 m 1 2 The stream number The server will return the most up to date snapshot of the selected channel and stream in JPEG format The size and quality of the image will be set according to...

Page 297: ...ers are ignored 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 value The p...

Page 298: ...00 OK r n Content Type text plain r n Content Length syslog length r n r n system log information r n 8 7 Upgrade Firmware Note This request requires Administrator privileges Method POST Syntax http servername cgi bin admin upgrade cgi Post data fimage file name return return page r n r n multipart encoded form data Server will accept the file named file name to upgradethe firmware and return with...

Page 299: ...ctrl 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 operation there are two ways to control it scale zoom and area zoom 1 Scale zoom contains two control method relative movement and continuous move...

Page 300: ... 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 resolution 1920x1080 PARAMETER VALUE DESCRIPTION channel 0 n 1 Channel of video source stream 0 m 1 Stream move home Move to home ROI up Move up down Move down left Move left right Move right auto pan Aut...

Page 301: ...ctiveX 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 speedapp 1 5 Set the auto pan patrol ...

Page 302: ...o 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 8 10 ePTZ Preset Locations capability eptz 0 and capability_fisheye 0 Note This request requires Operator privileges Method GET POST Syntax http servername cgi bin operator ePreset cgi channel value stream value addpos value delpos value return return page PA...

Page 303: ... method del v4 v6 index value return return page PARAMETER VALUE DESCRIPTION type NULL Get IP filter type allow deny Set IP filter type method addv4 Add IPv4 address into access list addv6 Add IPv6 address into access list delv4 Delete IPv4 address from access list delv6 Delete IPv6 address from access list ip IP address Single address IP address Network address IP address network mask Range addre...

Page 304: ...dress from access list ip IP address Single address IP address Network address IP address network mask Range address start IP address end IP address index value The start position to add or to delete return 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 ...

Page 305: ...through a proxy server This channel will help to transfer the raw data of UART over the network Please see UART tunnel spec for detail information PARAMETER VALUE DESCRIPTION channel 0 n 1 The channel number of UART 8 14 Event Control HTTP Tunnel Channel capability evctrlchannel 0 Note This request requires Administrator privileges Method GET and POST Syntax http servername cgi bin admin ctrlevent...

Page 306: ...nd notification as well as camera control more efficiently The event and control formats are described in another document See Event control tunnel spec for detail information 8 15 Get SDP of Streams Note This request requires Viewer access privileges Method GET POST Syntax http servername network_rtsp_s 0 m 1 _accessname m is the stream number network_accessname_ 0 m 1 is the accessname for strea...

Page 307: ...ires Viewer privileges Method GET POST Syntax http servername cgi bin viewer senddata cgi com value data value flush value wait value read value PARAMETER VALUE DESCRIPTION com 1 max com port number The target COM RS485 port number data hex decimal data hex decimal data The hex decimal data is a series of digits from 0 9 A F Each comma separates the commands by 200 milliseconds flush yes no yes Re...

Page 308: ...rt delete update and queryStatus Command search PARAMETER VALUE DESCRIPTION label integer primary key Optional The integer primary key column will automatically be assigned a unique integer triggerType text Optional Indicate the event trigger type Please embrace your input value with single quotes Ex mediaType motion Support trigger types are product dependent mediaType text Optional Indicate the ...

Page 309: ... 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 Moreover to search for a spe...

Page 310: ...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 javascript The default return message is in XML format Ex Query l...

Page 311: ...en the virtual input is waiting for next state it cannot accept new requests return return page Redirect to the page return page after the request is completely assigned The return page can be a full URL path or relative path according the current path If you omit this parameter it will redirect to an empty page Return Code Description 200 The request is successfully executed 400 The request canno...

Page 312: ...ve integer 0 Request cached stream at most how many seconds ago tsmode normal adaptive normal Streaming mode normal Full FPS all the time adaptive Default send only I frame for MP4 and H 264 and send 1 FPS for MJPEG If DI or motion window are triggered the streaming is changed to send full FPS for 10 seconds Note this parameter also works on non timeshift streams reftime mm ss The time camera rece...

Page 313: ... when minsft is not achievable or the timeshift feature of the target stream is not enabled 8 21 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 PARAMETER VALUE DESCRIPTION ...

Page 314: ...nd point of effective focal length remote_focus_zoom_motor Current position of zoom motor remote_focus_focus_motor Current position of focus motor remote_focus_zoom_enable Current function of zoom motor remote_focus_focus_enable Current function of focus motor remote_focus_iris_open The current status of iris 0 irisenable 1 irisopen Current function of zoom focus motor return value as below 0 no s...

Page 315: ...ote_focus_zoom_motor_max which replied from function getstatus iris N A Open iris or not It works only if function auto scan 8 22 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 316: ..._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 current status of iris 0 irisenable 1 irisopen Current function of zoom focus motor return value as below 0 no service 1 zooming 2...

Page 317: ...ime configuration file http servername cgi bin admin exportDst cgi For language file http servername cgi bin admin export_language cgi currentlanguage value PARAMETER VALUE DESCRIPTION currentlanguage 0 20 Available language lists Please refer to system_info_language_i0 system_info_language_i19 For setting backup file http servername cgi bin admin export_backup cgi backup 8 24 Upload Files Note Th...

Page 318: ... requires Administrator privileges Method GET Syntax For list a name of lens currently used http servername cgi bin admin update_lens cgi get_currentlens For list all names of lens installed in camera http servername cgi bin admin update_lens cgi list_lens For choose selected lens configuration http servername cgi bin admin update_lens cgi choose_lens value You need to reboot manually after you ch...

Page 319: ...er to lens_default_i 0 n 1 _name lens_user_i 0 n 1 _name n is a positive integer Method POST Syntax For upload user defined lens configuration http servername cgi bin admin update_lens cgi upload_lens Post data upload_lens_profile_input file name r n r n multipart encoded form data Server will accept the file named file name to upload the lens profile to camera ...

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

Page 321: ...n 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 myserver cgi bin camctrl fdCamCtrl c...

Page 322: ...r 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 ra...

Page 323: ... 3D 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 fo...

Page 324: ...on image Move the center of image to the coordination x y based on resolution or videosize speedpan value speedtilt value speedzoom value speedapp value speedlink val ue 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...

Page 325: ...ate 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 resolution window size The resolution of streaming stretch boolean 0 indicates that it uses resolution streaming size as the range of the coordinate system 1 indicate...

Page 326: ...of capability_camctrl_c 0 n 1 _buildinpt is 1 gettilt 0 positive integer Get the current tilt position Only available when bit1 of capability_camctrl_c 0 n 1 _buildinpt is 1 gettiltangle integer Get the current tilt angle Only available when bit1 of capability_camctrl_c 0 n 1 _buildinpt is 1 getzoom 0 positive integer Get the current zoom position getratio decimal Get the current zoom ratio getfoc...

Page 327: ...e when bit1 of capability_camctrl_c 0 n 1 _buildinpt is 1 getmintiltangle integer Get the lower limit for tilt angle Only available when bit1 of capability_camctrl_c 0 n 1 _buildinpt is 1 getmaxtiltangle integer Get the upper limit for tilt angle Only available when bit1 of capability_camctrl_c 0 n 1 _buildinpt is 1 getminzoom 0 positive integer Get the lower limit for zoom position getmaxzoom 0 p...

Page 328: ...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 empty page 8 31 Preset Locations capability_camctrl_c 0 n 1 _zoommodule 1 Note This request requires Operator privileges Method GET POST Syntax http servername cgi bin operator preset cgi channel val...

Page 329: ... location from preset list return 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 empty page ...

Page 330: ...r s Manual 8 32 SmartSD capability_localstorage_smartsd 0 Note This request requires Administrator privileges Method GET POST Syntax http servername cgi bin admin smartsd cgi function value PARAMETER VALUE DESCRIPTION ...

Page 331: ...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 Life Information1 is updated smartsd_num_of_s...

Page 332: ...DHCP NTP DNS DDNS PPPoE CoS QoS SNMP 802 1X UDP ICMP ARP SSL TLS Interface 10Base T 100 BaseTX Ethernet RJ 45 It is highly recommended to use standard Cat 5e Cat 6 cables which are compliant with the 3P ETL standard ONVIF Supported specification available at www onvif org Intelligent Video Video Motion Detection Five window video motion detection VCA Line crossing detection field detection loiteri...

Page 333: ...21 DE PAT 0516621 DK PAT 0516621 ES PAT 0516621 FR PAT 0516621 GB PAT 0516621 GR PAT 0516621 IT PAT 0516621 LI PAT 0516621 LU PAT 0516621 NL PAT 0516621 SE PAT 0516621 US PAT 5444816 AT PAT 819303 AT E 198805T1 AU PAT 697256 BE PAT 819303 BR PAT 9604838 7 CA PAT 2216315 CH PAT 819303 CN PAT ZL96193827 7 DE PAT 819303 DE69611607T2 DK PAT 819303 ES PAT 819303 EP PAT 819303 FR PAT 819303 GB PAT 81930...

Page 334: ...nt off and on the user is encouraged to try to correct the interference 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 inter...

Search results

Summary of Contents for IB836BA-EHF3

Reviews:

Related manuals for IB836BA-EHF3

Brands by name

Popular brands

Vivotek IB836BA-EHF3, User Manual

Search results

Summary of Contents for IB836BA-EHF3

Reviews:

Related manuals for IB836BA-EHF3

Brands by name

Popular brands