Vivotek SD9161-H User Manual Download Page 144

Page: 144 / 470

VIVOTEK

144 - User's Manual

When the Event Status is

, once an event is triggered by motion detection, the Network Camera will

automatically send snapshots via e-mails.

If you want to stop the event trigger, you can click

to turn it to

OFF

status or click

Delete

to remove

the event setting.

To remove a server setting from the list, select a server name and click

Delete

. Note that you can only

delete a server setting when the server setting is currently not applied to an event setting.

To remove a media setting from the list, select a media name and click

Delete

. Note that you can only

delete a media setting when the media setting is currently not applied to an event setting.

Summary of Contents for SD9161-H

Page 1: ...User s Manual Speed Dome Network Camera 2MP 10x Zoom 30fps Smart Stream II H 265 DIS 3DNR Defog SD9161 H Rev 1 3 ...

Page 2: ...ation 53 System General settings 54 System Homepage layout 57 System Logs 60 System Parameters 63 System Maintenance 64 Media Image 68 Media Video 78 Media Audio 85 Media profiles 86 Network General settings 87 Network Streaming protocols 94 Network DDNS 100 Network SNMP Simple Network Management Protocol 105 Network FTP 106 Security User accounts 107 Security HTTPS Hypertext Transfer Protocol ove...

Page 3: ...154 Storage 159 Storage SD card management 159 Storage NAS management 160 Storage Content management 162 Appendix 165 URL Commands for the Network Camera 165 Technical Specifications 468 Technology License Notice 469 Electromagnetic Compatibility EMC 470 ...

Page 4: ...ompression technology and VIVOTEK s Smart Stream II technology users can enjoy bandwidth savings of up to 80 compared to traditional H 264 systems Incorporating a number of advanced features standard for VIVOTEK cameras including EIS tamper detection MicroSD SDHC SDXC card slot and VIVOTEK s 32 channel recording software the SD9161 H is the ideal solution for your indoor surveillance needs Dependi...

Page 5: ...iguration chapter suggests ways to best utilize the Network Camera and ensure proper operations For creative and professional developers the URL Commands of the Network Camera section serves as a helpful reference to customizing existing homepages or integrating with the current web server Package Contents SD9161 H Top Mount Bracket M4x32 Screws and anchors M2x12 Screw for ground wire T10 star dri...

Page 6: ...oil stains it is recommended to use a spray type decomposing cleaner absolutely avoid reciprocating wipes on the surface After the oil has decomposed spray it with water dry with air and or absorb water with a cotton cloth or a soft cloth dab please avoid wiping Do not use harsh detergents gasoline benzene or acetone etc to clean as they may deform or cause damage to the product Also excessive cle...

Page 7: ...e qu à des réseaux PoE sans routage vers des installations extérieures 2 Pour les raccordements PoE utilisez uniquement un équipement de TI homologué UL avec une sortie PoE Use the camera only with a DC power supply that is UL listed and limited power source LPS certified The power supply should bear the UL listed and LPS marks The power supply should also meet any safety and compliance requiremen...

Page 8: ...ctions PTZ output relay etc and get and set internal parameter values The image and CGI requests are handled by the built in Web server To send URL commands in the address bar of your web browser please remember to disable the Cross Site Request Forgery CSRF protection in Configuration Security Miscellaneous For up to date documentation of URL commands please go to VIVOTEK s website register an ac...

Page 9: ...anual 9 Physical Description Inner View Reset Button Outer View Lens Status LED This drawing shows a camera with its dome cover removed MicroSD card slot Safety wire hook Screw hole for ground wire connection RJ45 port ...

Page 10: ...cable is separately purchased Its pinouts are shown below Name No Color DI_4 1 Brown DI_3 2 Light green DI_2 3 Orange DI_1 4 Yellow DO_2 5 Green DO_1 6 Blue DO 7 Purple Reserved 8 Pink RS485 9 White RS485 10 Gray DI 11 Light blue AUDIO_IN 12 Red AUDIO_GND 13 Black AUDIO_OUT 14 White 1 14 ...

Page 11: ...estore system defaults Note that all settings will be restored to factory defaults SD SDHC SDXC Card Capacity This network camera is compliant with SD SDHC SDXC 16GB 8GB 32GB 64GB and up to 512 1024GB and other preceding standard SD cards 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 DH...

Page 12: ...with Protected Earth AC PE PE DC 0V 1 The DO pin provides 5V output voltage and the max load is 50mA 2 The max voltage for DO pins is 30VDC External power In order to control AC devices the above diagram can be taken in consideration The diagram uses a relay to control the ON OFF condition of the AC device 3 An external relay can be triggered by using DO or by an external power source depending on...

Page 13: ...place the camera on the original package foam block to avoid scratch and damage 2 The camera weighs 1 2kgs Select a rigid mounting location to prevent vibration to the camera 0002D10766AD SDXXXX 1 2 DI DO DI DO Switch ExternalDevice Dry contact and using camera s DO to supply a relay NC NO Relay AC ExternalAC power with Protected Earth PE PE ...

Page 14: ...ombo cable is separtely purchased 2 Avoid touching the circuit boards to prevent damage by electro static discharge 3 Use CAT5e CAT6 cables only NOTE 64GB 10 I 1 3 Install an SD card if onboard storage is preferred 4 Install the dome cover T20 ...

Page 15: ...e included screws If you need to route cables along the ceiling remove the side lid on the bracket A 1 Attach the alignment sticker to a preferred location Drill holes for the mounting screws If preferred drill another cabling hole for passing the cables through the ceiling Ceiling Mount Mount Option A Ø60mm ...

Page 16: ...is secured connect the safety wire to the safety hook on the top of the camera A 4 Attach a ground wire to the black cross head screw and install the screw to the screw hole near the RJ45 port Attach the other end to an appropriate grounding point ...

Page 17: ...VIVOTEK User s Manual 17 A 6 You can use the cable tie and sticky pad to help secure the I O and or power wires A 5 Route cables and connect them to the corresponding connectors ...

Page 18: ...match the camera to the bracket by matching the alignment marks Push the camera up with slightly more force to the bracket and turn clockwise The camera should snap into place A 8 Secure the camera by tightening the T10 anti tamper screw T10 ...

Page 19: ...ded screws Note the alignment mark should be pointing outwards Ø 9 5mm or 3 8 B 2 Drill 4 pilot holes 9 5mm in diameter and 4cm deep into the wall and then hammer in the threaded anchors Note that you should hammer the anchors with hex nuts on them so that the threaded poles will not be deformed If preferred drill another hole for routing cables Default Front AM 21C ...

Page 20: ...emove the hex nuts washers and leave one washer on each of the threaded poles Connect power and or I O wires and if necessary use foam tapes or seal foam to ensure the back end connection is waterproof B 4 Secure the bracket to wall ...

Page 21: ...VIVOTEK User s Manual 21 A3 A7 B 5 The rest of the installation steps are identical to those described in steps A3 to A7 T10 B 6 Secure the camera to bracket by tightening the T10 screw ...

Page 22: ...VIVOTEK 22 User s Manual B 7 Secure the T20 screws from the top of the camera T20 ...

Page 23: ...ed location Drill a hole that is 200mm in diameter The maximum board thickness is 63mm Make sure the ceiling board can stand the weight of the camera 1 2kgs Ø200mm 63mm Up to Ceiling Hole Template Sticker 260mm C 2 Secure the included clamping arms to the sides of the camera When doing this use the included foam block to help avoid scratch and damage x3 ...

Page 24: ...lates until they rest against the ceiling board so that the ceiling board is caught between the clamps and the flang on the other side of the ceiling Do not over tighten the clamps to avoid damages to the ceiling board Clockwise Counter clockwise C 4 Secure the trim ring using a Phillips screwdriver ...

Page 25: ...ead thread thread Shown below are the dimensions of the wall mount bracket and its mounting holes You can find the installation instructions on VIVOTEK s website for other options such as para pet mount http www vivotek com web product accessories aspx ...

Page 26: ... helps you locate and configure your Network Camera in the local network If your camera comes without the CD go to VIVOTEK s website and locate the utility in the Downloads Software page 1 1 Run the Shepherd utility 1 2 The program will conduct an analysis of your network environment ...

Page 27: ... 709 MAC 0002D1730202 Ro HS 1 3 The program will search for all VIVOTEK network devices on the same LAN 1 4 After a brief search the installer window will prompt Click on the MAC and model name that matches the one printed on the product label You can then double click on the address to open a management session with the Network Camera Forceful Password Configuration 2 The first time you log in to...

Page 28: ... for the password you just configured Enter the password and then you can start configure your camera and see the live view 2 2 Enter the combination of alphabetic and numeric characters to fulfill the password strength requirement The default name for the camera administrator is root and can not be changed At least 8 characters and 8 to 64 characters are allowed ...

Page 29: ...he web console enter Configuration Applications Package management and click on Trend Micro IoT Security Turn on the protection to fend off cyber attacks In here you can let the camera automatically update the virus codes or manually update the virus codes ...

Page 30: ...lease forward the following ports for the Network Camera on the router Secondary HTTP port 8080 RTSP port 554 RTP port for audio 5558 RTCP port for audio 5559 RTP port for video 5556 RTCP port for video 5557 If you have changed the port numbers on the Network page please open the ports accordingly on your router For information on how to forward ports on the router please refer to your router s us...

Page 31: ...2 146 57 120 8000 192 168 2 10 80 122 146 57 120 8001 192 168 2 11 80 When properly configured you can access a camera behind the router using the HTTP request as follows http 122 146 57 120 8000 If you change the port numbers on 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...

Page 32: ...an AC or DC 24V power adaptor user supplied You can connect both power sources for redundancy in power supply Power over Ethernet AC 24V 3 5A Adapter Separately purchasedied PoE Switch 15W output and or Internet connection with static IP Choose this connection type if you are required to use a static IP for the Network Camera Please refer to LAN on page 87 for details Internet connection via PPPoE...

Page 33: ...ork Camera utilizes a 32 bit ActiveX plugin You CAN NOT open a management view session with the camera using a 64 bit IE browser If you encounter this problem try execute the Iexplore exe program from C Windows SysWOW64 A 32 bit version of IE browser will be installed On Windows 7 the 32 bit explorer browser can be accessed from here C Program Files x86 Internet Explorer iexplore exe If you experi...

Page 34: ...s not a LAN follow these steps to access the Netwotk Camera 1 Launch your web browser e g Microsoft Internet Explorer or Mozilla Firefox 2 Enter the IP address of the Network Camera in the address field A temporary IP will be generated for the camera Find it in your Network Neighborhood Press Enter 3 Live video will display in your web browser 4 If it is the first time installing the VIVOTEK netwo...

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

Page 36: ...moving your browser cookies will solve this problem 2 If you encounter problems with displaying the configuration menus or UI items try disable the Compatibility View on IE8 or IE9 You may also press the F12 key to open the developer tools utility and then change the Browser Mode to the genuine IE8 or IE9 mode Tips In the event of plug in compatibility issues you may try to uninstall the plug in t...

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

Page 38: ...s limited you will not be able to use a large video size Please set the video and audio streaming parameters as listed below For more information please refer to Stream settings on page 78 Video Mode MPEG 4 Frame size 176 x 144 Maximum frame rate 5 fps Intra frame period 1S Video quality Constant bit rate 40kbps Audio type GSM AMR 12 2kbps 3 As most ISPs and players only allow RTSP streaming throu...

Page 39: ...rol you may try to remove the plug ins that might have been installed on your computer Remove the following folder C Program Files x86 Camera Stream Controller 2 If you forget the root administrator password for the camera you can restore the camera defaults by pressing the reset button for longer than 5 seconds 3 If DHCP is enabled in your network and the camera cannot be accessed run the Shepher...

Page 40: ...onfiguration Area and Live Video Window Live View Window Host Name VIVOTEK INC Logo Camera Control Area Configuration Area Resize Buttons Hide Button Mouse and PTZ Screen Control In addition to the use of a joystick 3 different mouse control modes are supported by the web session 1 Click on image 2 Joystick 3 Area zoom These modes will be described in the following passages ...

Page 41: ...t view station can not cope with the HD video feeds or that an incompatibility issue occurred with the ActiveX control plug ins Zoom In Zoom Out Click and hold down the button to continue turning Click to bring to center of view 1 0x 2 Joystick Click and drag your left mouse button across the screen towards the direction you wish to move A light blue trace will appear The longer the trace the fast...

Page 42: ...djust the Focus and the Focus speed 3 Area zoom The Area zoom allows you to select a view area and zoom in to that particular area of your interest The zoom ratio is proportional to the area you selected on screen The smaller the area the deeper the zoom Note that to zoom out you can use the mouse wheel or the Zoom buttons on the PTZ panel to zoom out To more rapidly zoom out you can click on the ...

Page 43: ... you to manually turn on or turn off the onboard heater PTZ Control Panel Pan Click this button to start the auto pan 360 continuous rotation Stop Click this button to stop the Auto Pan Auto Patrol and Auto Tracking functions Patrol Once the Administrator has determined the list of preset positions including the zoom in action on a particular position click this button to command the camera to pat...

Page 44: ...d be applied to the Network Camera so that only the administrator can configure the Network Camera For more information please refer to Configuration on page 53 Language Click this button to choose a language for the user interface Language options are available in English Deutsch Español Français Italiano 日本語 Português 簡体中文 and 繁體中文 You can also change a language on the Configuration page please ...

Page 45: ... 265 H 264 Protocol and Media Options The transmission protocol and media options for H 265 H 264 video streaming For further configuration please refer to Client Settings on page 48 Time Display the current time For further configuration please refer to Media Image General settings on page 68 Title and Time The video title and time can be stamped on the streaming video For further configuration p...

Page 46: ...your computer Press the Stop MP4 Recording 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 49 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 b...

Page 47: ...he 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 different area you want to magnify drag the navigation screen Start MP4 Recording Click this button to record vid...

Page 48: ...each unicast client connecting to the server takes up additional bandwidth and the Network Camera allows up to ten simultaneous accesses UDP multicast This protocol allows multicast enabled routers to forward network packets to all clients requesting streaming media This helps reduce the network transmission load of the Network Camera while serving multiple clients at the same time Note that to ut...

Page 49: ...e front of the video file name Add date and time suffix to the file name Select this option to append the date and time to the end of the file name of the recorded videos Local Streaming Buffer Time In a busy network fluctuations in available bandwidth can occur Video streaming may lag and may not proceed very smoothly If you enable this option video streams from the camera will be temporarily sto...

Page 50: ...figuration will be available on the Client settings window The joystick should work properly without installing any other driver or software Then you can begin to configure the joystick settings of connected devices Please follow the instructions below to enable joystick settings 1 Click on the Configure buttons button If your joystick is working properly it will be displayed on the drop down list...

Page 51: ...ns 1 Select the number of the button you want to configure from its pull down list For example Assign Preset 1 move to preset 1 position to Button 1 2 Select an action from the Actions menu Click Assign to associate the button with an action 3 Your configuration will be automatically saved 4 To disable an assignment select the number of a button and then click the Delete button The associated acti...

Page 52: ... Click the Calibrate button to open the Game Controllers window located in Microsoft Windows control panel and follow the instructions for trouble shooting NOTE The joystick will appear in the Game Controllers list in the Windows Control panel If you want to check out for your devices go to the following page Start Control Panel Game Controllers Follow the onscreen instructions to calibrate your j...

Page 53: ...ase refer to page 107 Security User Account for how to configure access rights for different users Configuration List Firmware Version Navigation Area Each function on the configuration list will be explained in the following sections Navigation Area provides an instant switch among Home page the monitoring page for live viewing Configuration page and multi language selection ...

Page 54: ... to configure the basic settings for the Network Camera such as the host name and system time It is composed of the following two columns System and System Time System Host name Enter a desired name for the Network Camera The text will be displayed at the top of the main page ...

Page 55: ...hat the camera must have the access to the Internet Update interval Select to update the time using the NTP server on an hourly daily weekly or monthly basis Time zone Select the appropriate time zone from the list You can scroll down on the Time zone menu to find the Customize option and use the POSIX TZ variables For example http www gnu org software libc manual html_node TZ Variable html Here a...

Page 56: ...r The format is TZ local_timezone date time date time Here date is in the Mm n d format where Mm 1 12 for 12 months n 1 5 1 for the first week and 5 for the last week in the month d 0 6 0 for Sunday and 6 for Saturday CST6CDT is the name of the time zone CST is the abbreviation used when DST is off 6 hours is the time difference from GMT CDT is the abbreviation used when DST is on M3 is the third ...

Page 57: ...ing shows the homepage using the default settings Hide Powered by VIVOTEK If you check this item such wording will be removed from the homepage Logo graph Here you can change the logo at the top of your homepage Follow the steps below to upload a new logo 1 Click Custom and the Browse field will appear 2 Select a logo from your files 3 Click Upload to replace the existing logo with a new one 4 Ent...

Page 58: ...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 59: ...rag 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 Below are the options for system integrators or VARs You can use the checkboxes to replace VIVOTEK s company logo the embedded website address or the slogan Powered by VIVOTEK When done use the Sav...

Page 60: ...en 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 This col...

Page 61: ...Cloud PTZ Deterrent FTP Camera 01 Camera 02 Camera 03 Camera 04 Camera 06 Camera 05 Camera 07 Camera 08 Camera 09 You can install the included VAST recording software which provides an Event Management function group for delivering event messages via Emails GSM short messages onscreen event panel or to trigger an alarm etc For more information refer to the VAST User Manual ...

Page 62: ... log contains the history of changes made to system parameters such as recording imaging parameters and all other parameters Access log Access log displays the access time and IP address of all viewers including operators 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 ...

Page 63: ...K User s Manual 63 System Parameters The View Parameters page lists the entire system s parameters in an alphabetical order If you need technical assistance please provide the information listed on this page ...

Page 64: ...lick Browse and specify the firmware file 3 Click Upgrade The Network Camera starts to upgrade and will reboot automatically when the upgrade completes If the upgrade is successful you will see Reboot system now This connection will close After that refresh the management session with the Network Camera The following message is displayed when the upgrade has succeeded The following message is disp...

Page 65: ...ve this problem 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 will be displayed in your browser The following message will be displayed during the reboot process If the connection fails after rebooting manually enter the IP address of the Network Camera in the address field to resume the conn...

Page 66: ...t Saving Time settings please refer to Import Export files below on this page Custom Language Select this option to retain the Custom Language settings VADP Retain the VADP modules 3rd party software stored on the SD card and related settings If none of the options is selected all settings will be restored to factory default The following message is displayed during the restoring process Import Ex...

Page 67: ...rver status 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 scenar...

Page 68: ...tamp 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 to display color or black white video streams Power line frequency Set the power line frequency consistent with local utility settings to eliminate image flickering associated with fluorescent lights Note that...

Page 69: ...red 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 Schedule mode The Network Camera switches between day mode and night mode based o...

Page 70: ...t color temperature setting the current color temperature you selected e g from other modes Note that you should use the Save button below to preserve current configuration Otherwise the white balance mode will return to Auto after you leave the configuration page Manual In the manual mode you can manually tune the R gain and Blue gain values by dragging the slide bars Index numbers will be shown ...

Page 71: ...al situations Enable 3D 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 function to the video channel will consume system computing power 3D Noise Reduction is mostly applied in low light conditions When enabled in a ...

Page 72: ... enter the sensor while a higher gain control value generates certain amount of noises Note the following when the Manual mode is selected 1 The Exposure level bar will not be available 2 The IR cut filter setting will switch to Day Mode If it was previously configured into other modes the previous setting remains intact Exposure control Exposure level You can manually set the Exposure level which...

Page 73: ...tivity of the IR cut filter When applying the gain control IR cut filter setting will change accordingly IMPORTANT 1 Because the exposure settings are also available in the Profile setting incorrect configurations such as a very high exposure level will let the camera consider it is operating in the Day mode even when the ambient light is actually low The camera will falsely remove the IR cut filt...

Page 74: ...l settings in the folowing columns Please refer to previous dicussions for detailed information 4 Click Save to enable the setting and click Close to exit the window Exposure Profile Only available when the IR cut filter is not set to the Auto mode If you want to configure another sensor and exposure setting for an individual day night schedule mode please click Profile mode to open the Profile of...

Page 75: ...er in the FOV the camera can more rapidly focus on an object of your interest while scanning through the entire surveillance area Focus window By default the optimal focus is found on a full view window You may designate a custom window within your current field of view to acquire the best focus out of it Full view The focus tuning takes place by referring to the full view Custom You can create a ...

Page 76: ...Fixed in center or Drag to move When using the Fixed in center mode you can move to the area of your interest and then manually change the size and shape of the masking window When using the Drag to move mode you can move to an area of your interest using the PTZ buttons above and then click and drag to draw a masking window The click to move maneuver is not available when you select the Drag to m...

Page 77: ...When the Enabled privacy mask checkbox is deselected no privacy masks will appear on screen Up to 24 privacy mask windows can be configured over the camera s hemispheric coverage If you want to delete a privacy mask window select its name from the pull down menu at the bottom and then click Delete to remove it Privacy mask Current field of view Privacy mask ...

Page 78: ... multiple streams Stream 1 Users can define the Frame sizes compression format image quality etc Stream 2 The default frame size for stream 2 is configured to 1280 x 720 Stream 3 The default frame size for Stream 3 is set to the minimized 640 x 360 for viewing on mobile devices Stream 4 The default frame size for stream 4 is configured to 1920 x 1080 in the H 265 or H 264 mode ...

Page 79: ...re are several parameters through which you can adjust the video performance Video quality and fixed quality refer to the compression rate so a lower value will produce higher quality Converting high quality video may significantly increase the CPU loading and you may encounter streaming disconnection or video loss while capturing a complicated scene In the event of occurance we suggest you custom...

Page 80: ...ic Intra frame period High quality motion codecs such as H 265 utilize the redundancies between video frames to deliver video streams at a balance of quality and bit rate The encoding parameters are summarized and illustrated below The I frames are completely 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 redunda...

Page 81: ...y for the foreground and the background areas Select an operation mode if Smart codec is preferred Auto tracking The Auto mode configures the whole screen into the non interested area The video quality of part of the screen returns 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 qua...

Page 82: ...an awareness of what is happening on the whole screen Hybrid The major difference between the Manual mode and the Hybrid mode is that In the Hybrid mode any objects entering the non interested area will restore the video quality of the moving objects and the area around them The video quality of the associated non interested area is immediately restored to normal to cover the moving objects In the...

Page 83: ...sired quality ranging from Medium to Excellent Maximum bit rate Select a bit rate from the pull down menu The bit rate ranges from 20kbps to a maximum 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 w...

Page 84: ...her 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 the frame rates are selectable from 1fps to 30fps You can also select Customize and manually enter a value The frame rate will decrease if you select a higher resolution Video quality Refer to the previous page setting an average or ...

Page 85: ... db most sensitive or 33db least sensitive Audio type Select audio codec as G 711 or G 726 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 rates of 16 24 32 and 40kbit s When completed with the settings on this page click Save to enable the settings The ne...

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

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

Page 88: ...e 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 t...

Page 89: ...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 90: ...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 91: ... above When IPv6 is enabled by default the network camera will listen to router advertisements and be assigned with a link local IPv6 address accordingly IPv6 Information Click this button to obtain 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 92: ...rmat Please refer to HTTP streaming on page 94 for detailed information If you choose PPPoE as the Network Type the PPP0 address will be displayed in the IPv6 information column as shown below Manually setup the IP address Select this option to manually set up IPv6 settings if your network environment does not have a DHCPv6 server and router advertisements enabled routers If you select this item t...

Page 93: ...VIVOTEK User s Manual 93 ...

Page 94: ...ollowing 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 stream 1 5 This Network camera supports multiple streams simultaneous...

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

Page 96: ...s is listed in the following table Access name for Channel and stream This Network camera supports multiple streams simultaneously The access name is used to differentiate the streaming source If you want to use an RTSP player to access the Network Camera you HAVE TO set the video mode to H 265 or 264 and use the following RTSP URL command to request transmission of the streaming data rtsp ip addr...

Page 97: ... to transmit the data by monitoring the Internet traffic volume By default the RTCP port for video is set to 5557 and the RTCP port for audio is set to 5559 The ports can be changed to values between 1025 and 65535 The RTP port must be an even number and the RTCP port is the RTP port number plus one and thus is always an odd number When the RTP port changes the RTCP port will change accordingly If...

Page 98: ...ccordingly If the multicast RTP video ports are incorrectly assigned the following warning message will be displayed Multicast TTL 1 255 The multicast TTL Time To Live is the value that tells the router the range a packet can be forwarded Each hop decreases TTL by one Initial TTL Scope 0 Restricted to the same host 1 Restricted to the same subnetwork 15 Restricted to the same site 64 Restricted to...

Page 99: ...mera supports two way audio communication so that operators can transmit and receive 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 o...

Page 100: ...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 a ho...

Page 101: ...ore 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 will be...

Page 102: ...he Host name Server 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 Enter ns1 safe100 net as the Server name 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 sett...

Page 103: ... 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 via a web console with the network switches which then us...

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

Page 105: ...Managed device A network node on a managed network For example routers switches bridges hubs computer hosts printers IP telephones network cameras web server and database Before configuring SNMP settings on the this page please enable your NMS first SNMP Configuration Enable SNMPv1 SNMPv2c Select this option and enter the names of Read Write community and Read Only community according to your NMS ...

Page 106: ...rmware disabled the FTP port for security concerns You can manually enable the FTP server service to enable the FTP function You can disable the FTP server function when it is not in use FTP port The FTP server allows the user to save recorded video clips You can utilize VIVOTEK s Shepherd utility to upgrade the firmware via FTP server By default the FTP port is set to 21 It can also be assigned t...

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

Page 108: ...ct the checkboxes and then click Save to enable the settings If you give Viewers the privilege Operators will also have the ability to control the Network Camera through the main page Please refer to Main page functions on page 40 Allow anonymous viewing If you select this item any client can access the live stream without entering a User ID and Password ...

Page 109: ...ommunication 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 Informat...

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

Page 111: ...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 112: ...opy the certificate request from your request prompt and paste it in the CA s signing request window Proceed with the rest of the process as CA s instructions on their webpage 6 Once completed your SSL certificate should be delivered to you via an email or other means Copy the contents of the certificate in the email and paste it in a text HTML hex editor converter such as IDM Computer Solutions U...

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

Page 114: ...nual 9 Save the edit using the crt extension using a file name like CAcert crt 10 Return to the original firmware session use the Browse button to locate the crt certificate file and click Upload to enable the certification ...

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

Page 116: ...r ID column will be empty There are some situations which allow clients access to the live video without a user name and password 1 The administrator does not set up a root password For more information about how to set up a root password and manage user accounts please refer to Security User account on page 107 2 The administrator has set up a root password but set RTSP Authentication to disable ...

Page 117: ...ose IP addresses are on the Access List below can access the Network Camera and exclude the access from those that are not on the list If you choose Deny Type those clients whose IP addresses are on the Access List below will not be allowed to access the Network Camera while those that are not on the list can Then you can Add a rule to the following Access List Please note that the IPv6 access lis...

Page 118: ...IPv4 block 192 168 100 0 22 represents the 1024 IPv4 addresses from 192 168 100 0 to 192 168 103 255 Network This rule allows the user to assign a network address and corresponding subnet mask to the Allow Deny List The routing prefix is written in CIDR Classless Inter Domain Routing notation For example Range This rule allows the user to assign a range of IP addresses to the Allow Deny List Note ...

Page 119: ... an access point or a switch A go between which restricts unauthorized end users from communicating with the authentication server 3 Authentication server usually a RADIUS server Checks the client certificate and decides whether to accept the end user s access request VIVOTEK Network Cameras support two types of EAP methods to perform authentication EAP PEAP and EAP TLS Please follow the steps bel...

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

Page 121: ...us exploit of a website in this case the camera Unauthorized commands are transmitted from a user that the web application trusts using the mechanism of forging a trusted user s own request with a request containing his own cookies etc Different ways can be used for a malicious website to transmit such commands They can be specially crafted image tags hidden forms and JavaScript XMLHttpRequests Th...

Page 122: ...rol 2 Enter a name for a new preset position which can contain up to forty characters Click Add to enable the settings The preset positions will be listed on the User preset locations To add positions you wish please repeat steps 1 2 3 Select the preset positions and click on the Save button at the bottom of the screen 4 Click on the move button to move positions to the Patrol locations window 5 Y...

Page 123: ...onfigured patrols Note that only one patrol can apply at a time Use the ON OFF buttons to enable disable an existing patrol Use the buttons below to create a recorded patrol or a preset patrol Recorded Patrol The recorded patrol allows you to record the process moving along interested points positions in your surveillance area while the camera memorizes every Pan Tilt Zoom Focus commands you gave ...

Page 124: ... your points of interest Zoom and focus are also supported 5 You can use the playback button to review your recorded patrol before you click the Save button When you are satisfied with the recording click Save and Close to leave the configuration page Note that if you start a new recording without saving the previous one the previous recording will be abandoned 1 2 3 4 2 5 NOTE The Joystick mode s...

Page 125: ...r screen control malfunctions it is possible that the CPU of your current view station can not cope with the HD video feeds or that an incompatibility issue occurred with the ActiveX control plug ins The One time focus option enables you to disable the continuous focus actions when zooming in or out in a low light condition You can disable the continuous focus actions and manually change the focus...

Page 126: ...ze image during patrol skips the display of the process when moving from one position to another Only the views of the preset points are displayed Apply previous action if the camera idles for __ 1 999 seconds You can assign an action to be taken when the camera sits idle for a configurable period time For example you can let camera resume a patrol tour The resumed patrol will continue from the la...

Page 127: ...ement caused by external forces Please note that there is no confirm message after using the function and the calibration immediately takes place If after a long use a user finds it is difficult to move camera s field of view to a specific point use this function to restore the camera s orginal coordinates in pan and tilt motions ...

Page 128: ... the object size square box The minimum object size is 30x30 pixels within a 320x420 view window Use the slide bar to tune the sensitivity of the tracking function 2014 3 2 15 28 44 This function stops when the user clicks on any buttons on the PTZ panel or a mouse click takes place on a view window Users can choose to perform other functions such as pan or patrol simply by clicking their buttons ...

Page 129: ...anual control always has a higher priority than Auto tracking such as using a joystick to pan or tilt or using a click on VAST view cell 6 Objects can easily move away from an FOV when the zoom in ratio is high Therefore it is recommended not to zoom in too much on where the Auto tracking is expected to take place Auto tracking is configured by designating the minimum object size Moving objects th...

Page 130: ... an FTP server or e mail address as notifications Click on Help there is an illustration shown in the pop up window explaining that an event can be triggered by many sources such as motion detection or external digital input devices When an event is triggered you can specify what type of action will be performed Event An event is an action initiated by a user defined trigger source In the Event co...

Page 131: ...on detection mechanism or external digital input devices There are several choices of trigger sources as shown on 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 ...

Page 132: ...as an audio input rises above or falls below the alarm level Manual triggers An event can be manually triggered by the manual trigger buttons on the main page VADP It is presumed that you already uploaded and enabled the VADP modules before you can associatee VADP triggers with an Event setting Click on the Set VADP Trigger button to open the VADP setup menu The triggering conditions available wit...

Page 133: ...storage please refer to page 156 Trigger auto tracking Auto tracking starts by the occurrence of another trigger Move to preset location Select a preset location you ve configured Note that please configure Preset locations first For detailed information please refer to page 125 Another checkbox will appear Capture media after moving to the location You can select to record associated snapshot vid...

Page 134: ...ow as a trigger the motion detection may become invalid when the camera s field of view moved away from the detection window You can let camera return to the motion detection position to detect the coming event by re configuring your Home position in PTZ PTZ settings see page 122 or turn the camera to a preset position ...

Page 135: ...elect 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 server User name Enter the user name of the email account if necessary Password Enter the passwo...

Page 136: ... more server options click Add server Server type FTP Select to send the media files to an FTP server when a trigger is activated Server name Enter a name for the server setting Server address Enter the domain name or IP address of the FTP server Server port By default the FTP server port is set to 21 It can also be assigned to another port number between 1025 and 65535 User name Enter the login n...

Page 137: ... on the FTP server Click Save server to enable the settings then click Close to exit the Add server page 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 verify if the HTTP settings a...

Page 138: ... NAS server on page 156 for details Click Save server to enable the settings then click Close to exit the Add server page SD Test Click to test your SD card The system will display a message indicating success or failure If you want to use your SD card for local storage please format it before use Please refer to page 159 for detailed information ...

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

Page 140: ...sh to add more media options click Add media again Media type Video clip Select to send video clips when a trigger is activated Media name Enter a name for the media setting Source Source Select a video stream profile as the source of video clip Pre event recording The Network Camera has a buffer area it temporarily holds data up to a certain limit Enter a number to decide the duration of recordin...

Page 141: ...the maximum file size allowed File name prefix Enter the text that will be appended to the front of the file name For example Click Save media to enable the settings then click Close to exit the Add media page Media type System log Select to send a system log when a trigger is activated Click Save media to enable the settings then click Close to exit the Add media page 1 sec 2 sec 3 sec 4 sec 5 se...

Page 142: ... this item the system will automatically create sub folders named by the date The following is an example of a file destination with recorded video clips Click 20140320 to open the directory Video Clip_59 mp4 Video Clip_58 mp4 2014 03 20 2014 03 20 Click to delete selected items Click to delete all recorded data Click to go back to the previous level of the directory The format is HH 24r Click to ...

Page 143: ...le of the Event setting When completed the settings with steps 1 3 to arrange Schedule Trigger and Action of an event click Save event to enable the settings and click Close to exit the page The following is an example of the Event setting page ...

Page 144: ...F status or click Delete to remove the event setting To remove a server setting from the list select a server name and click Delete Note that you can only delete a server setting when the server setting is currently not applied to an event setting To remove a media setting from the list select a media name and click Delete Note that you can only delete a media setting when the media setting is cur...

Page 145: ...r of screen for your reference in semi transparent red An intruding object must be larger than the 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 fa...

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

Page 147: ...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 148: ... You may then configure the Normal status non trigger status as High or Low Digital output Select High or Low to define normal status for the digital output Connect an output line to an external device the Network Camera will report the current signal status You may then configure the Normal status non trigger status as High or Low Set up the event source as DI on Event Event settings Trigger Plea...

Page 149: ... 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 150: ... Refer to page 85 for Audio settings and page 79 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 151: ...hether the module fits the predefined VADP requirements Please contact technical support or the vendor of your 3rd party module for the parameters contained within Users can also run VIVOTEK s VADP packages as a means to access updated functionality instead of replacing the entire firmware Note that for some cameras the flash is too small to hold VADP packages These cameras will have its Save to S...

Page 152: ... 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 153: ...page register and activate the license for using VIVOTEK s VADP modules You should acquire the license key elsewhere and manually upload to the network camera Follow the onscreen instruction on VIVOTEK s website for the registration procedure ...

Page 154: ...adaptive recording recording source recording schedule and recording capacity A total of 2 recording settings can be configured Recording name Enter a name for the recording setting Enable this recording Select this option to enable video recording With adaptive recording Select this option will activate the frame rate control according to alarm trigger The frame control means that when there is a...

Page 155: ...will be executed first Source Select a stream as the recording source To enable recording notification please configure Event settings first Please refer to page 130 Please follow steps 1 2 below to set up the recording 1 Trigger Select a trigger source Schedule The server will start to record files on the local storage or to a networked storage device NAS Network fail Since the time when the netw...

Page 156: ...er 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 4 Network storage path server name or IP address folder name User name and password for your server 3 ...

Page 157: ...tions that might occur during the transaction stage when the video feeds are about to fill up the storage space and new data is still coming This value must be larger than 15 MBytes Enable cyclic recording If you check this item when the maximum capacity is reached the oldest files will be overwritten by the latest ones File name prefix Enter the text that will be appended to the front of the file...

Page 158: ...w To remove a recording setting from the list select it and click Delete Video Name Click to open the Recording settings page to modify its details ON Status Click to manually adjust the Status ON start recording OFF stop recording NAS or SD Destination Click to open the file list of recordings as shown below For more information about folder naming rules please refer to page 142 or page 119 for d...

Page 159: ...atus and reserved space of your SD card Please remember to format the SD card when using for the first time no SD card NOTE It is recommended to turn OFF the recording activity before you remove an SD card from the camera The lifespan of an SD card is limited Regular replacement of the SD card can be necessary Camera filesystem takes up several megabytes of memory space The storage space cannot be...

Page 160: ... this item and enter the number of days you wish to retain a file For example if you enter 7 days the recorded files will be stored on the SD card for 7 days Click Save to enable your settings Storage NAS management NAS Setup Click NAS management tab to open the server setting window and follow the steps below to set up 1 Fill in the information for the access to the shared networked storage For e...

Page 161: ...er especially when the cyclic recording function is enabled during the transaction stage when a storage space is full and the incoming streaming data is about to overwrite the previously saved videos Enable cyclic storage Allows previous recordings to be overwritten by new recordings Enable automatic disk cleanup Allows you to specify how long the recording files will be kept on the NAS storage Ma...

Page 162: ...ows the user to set up search criteria for recorded data If you do not select any criteria and click Search button all recorded data will be listed in the Search Results column File attributes Select one or more items as your search criteria Trigger time Manually enter the time range you want to search for contents created at a specific point in time Click Search and the recorded data correspondin...

Page 163: ...which 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 function only applies to JPEG format files such as snapshots You can se...

Page 164: ...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 165: ...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 166: ...VIVOTEK 166 User s Manual www vivotek com URL COMMAND LIST FOR ONEFW Version 3 2d 2020 09 01 ...

Page 167: ...is trademarks of VIVOTEK INC and may be used to identify VIVOTEK products only VIVOTEK Other product and company names contained herein may be trademarks of their respective owners No part of this publication may be reproduced or utilized in any form or by any means electronic or mechanical including photocopying and microfilm without permission in writing from VIVOTEK INC ...

Page 168: ...Status 41 7 2 1 Status per Channel 42 7 3 Digital Input Behavior Define 42 7 4 Digital Output Behavior Define 42 7 5 Security 43 7 6 Network 43 7 6 1 802 1x 45 7 6 2 QOS 45 7 6 3 IPV6 46 7 6 4 FTP 46 7 6 5 HTTP 47 7 6 6 HTTP per Channel 48 7 6 7 HTTS Port 48 7 6 8 RTSP 48 7 6 9 RTSP Multicast 50 7 6 10 SIP Port 51 7 6 11 RTP Port 51 7 6 12 PPPoE 52 7 6 13 Bonjour 52 7 6 14 SFTP server 52 7 7 IP Fi...

Page 169: ... DDNS 123 7 19 Express Link 124 7 20 UPnP Presentation 124 7 21 UPnP Port Forwarding 124 7 22 System Log 125 7 23 SNMP 125 7 24 Layout Configuration 126 7 25 Privacy Mask 129 7 26 3D Privacy Mask 130 7 27 Capability 131 7 27 1 Capability for Camctrl 153 7 27 2 Capability for PTZ 155 7 27 3 Capability for IR Led 157 7 27 4 Capability for IR Illuminators 161 7 27 5 Capability for Storage Management ...

Page 170: ... 7 42 UART Control 235 7 43 UART Control SD Series 237 7 44 Lens Configuration 238 7 45 Fisheye Info 239 7 46 Fisheye Local Dewarp Setting 239 7 47 PIR Behavior Define 240 7 48 Auto Tracking Setting 240 7 49 Wireless 241 7 50 Shock Detection 243 7 51 Stream Profiles 243 7 52 Multicast Settings for Metadata Streaming 244 8 Useful Functions 246 8 1 Drive the Digital Output capability_ndo 0 246 8 2 Q...

Page 171: ...a Control capability_camctrl_c 0 n 1 _zoommodule 1 275 8 27 Recall capability_camctrl_c 0 n 1 _zoommodule 1 279 8 28 Preset Locations capability_camctrl_c 0 n 1 _zoommodule 1 280 8 29 SmartSD capability_localstorage_smartsd 0 280 8 30 Connect to AP capability_network_wireless 0 281 8 31 Get Wireless Information capability_network_wireless 0 282 8 32 Get Wireless Signal Strength capability_network_...

Page 172: ...apability_nir d add capability_image_c n _defog_mode capability_image_c n _defog_strength capability_image_c n _defog_supportlevel capability_image_c n _defog_affect e remove capability_image_c n _defog capability_image_c n _defogaffect f add capabiliy_fisheyelocaldewarp_c n g add capability_videoin_c0_fisheye_mounttype h add capability_image_c n _lensconfiguration_support i add capability_videoin...

Page 173: ...el 2 Remove camctrl_enablehttptunnel parameter 3 Modify the description of capability_videoin_c 0 n 1 _mode 0 m 1 _defaultsetting _s 0 j 1 group 4 Modify the description of capability_fisheye 5 Modify the description of capability_smartstream group V1 3a 2015 09 01 Kelly 1 Add vadp_schedule group 2 Modify the value type of capability_image_c 0 n 1 _wdrpro_description capability_image_c 0 n 1 _wdrp...

Page 174: ..._c 0 n 1 _dis_mode image_c 0 n 1 _dis_strength image_c 0 n 1 _freeze capability_thermal_controlmode capability_daynight_c 0 n 1 _blackwhitemode capability_daynight_c 0 n 1 _ircutsensitivity_type capability_daynight_c 0 n 1 _ircutsensitivity_supportlevel capability_image_c 0 n 1 _is_mode capability_image_c 0 n 1 _is_strength capability_image_c 0 n 1 _is_supportlevel capability_image_c 0 n 1 _is_aff...

Page 175: ..._cbr_qpercent capability_videoin_c 0 n 1 _cameraunit_name capability_localstorage_smartsd capability_image_c 0 n 1 _autotrack_support 3 Modify the security level of videoin_c 0 n 1 _zoomratiodisplay to 1 4 4 Modify the security level of uart_i 0 n 1 _uartmode to 4 7 5 Modify the description of auto tracking group 6 Modify the best term for DGOP Dynamic intra frame period 7 Rename xxx_dgop_xxx to x...

Page 176: ...fy the descriptions of remotefocus 2 Remove capability_image_c 0 n 1 _backfocus parameter V1 6a 2016 01 14 Kelly 1 Modify the value of privacymask3d_c 0 n 1 _color parameter 2 Remove camctrl_c 0 n 1 _osdzoom parameter 3 Modify the description of SmartSD cgi in chapter 8 V1 7a 2016 01 29 Kelly 1 Modify autotrack group to channel base V1 8a 2016 03 28 Kelly 1 Modify the descriptions of these paramet...

Page 177: ...parameters action_goto_sync action_autotrack_enable capability_image_c 0 n 1 _wdrpro_affect capability_image_c 0 n 1 _wdrc_affect videoin_c 0 n 1 _aespeedsupportsensitivity videoin_c 0 n 1 _profile_i0_aespeedsupportsensitivity V1 8c 2016 05 10 Kelly 1 Modify the value range description of these parameters videoin_c 0 n 1 _s 0 m 1 _resolution videoin_c 0 n 1 _s 0 m 1 _mjpeg_qvalue ircutcontrol_extl...

Page 178: ... parameters capability_peripheral_c 0 n 1 _watersprary_support capability_peripheral_c 0 n 1 _wiper_support 7 Add camclean group and cgi washerctrl cgi V1 9b 2016 08 03 Sarah 1 Modify the description of ircutcontrol group V1 9c 2016 08 24 Sarah 1 Add these parameters capability_ peripheral_c 0 n 1 _shockdetection_support camctrl_preset_i 0 capability_npreset 1 _focussetting 2 Add shock group 3 Add...

Page 179: ..._privatekeypassword ddns_ provider _passwordkey server_i 0 4 _http_passwd server_i 0 4 _ftp_passwd server_i 0 4 _email_passwd server_i 0 4 _ns_passwd snmp_authpwrw snmp_authpwro snmp_encryptpwrw snmp_encryptpwro security_use_i0_pass 3 Add these parameters network_ftp_enable event_i 0 2 _action_cutsom 0 2 _enable event_i 0 2 _action_cutsom 0 2 _name 4 Modify the cgi descriptions of camea control pr...

Page 180: ... V2 2a 2017 02 07 Kelly 1 Modify the description of these parameters capability_videoout_codec event_i 0 2 _di capability_ptzenabled 2 Add these parameters capability_image_c 0 n 1 _dnrstrength capability_shockalarm_support capability_presettourdirection capability_daynight_c 0 n 1 _optimizedir camctrl_c0_tour_i 0 19 _direction V2 2b 2017 03 16 Kelly 1 Remove the unused baudrate 110 3600 7200 in u...

Page 181: ... these parameters capability_supporttriggertypes capability_image_c 0 n 1 _basicsetting capability_image_c 0 n 1 _exposure_modetype capability_image_c 0 n 1 _exposure_shuttervaluetype capability_image_c 0 n 1 _exposure_gainvaluetype capability_image_c 0 n 1 _exposure_levelrange capability_image_c 0 n 1 _exposure_winmode capability_image_c 0 n 1 _exposure_windomain capability_image_c 0 n 1 _exposur...

Page 182: ...blepreview event_i 0 2 _action_cf_enable event_i 0 2 _action_cf_folder event_i 0 2 _action_cf_media event_i 0 2 _action_cf_datefolder event_i 0 2 _action_cf_backup chap 8 5 Account management chap 8 20 Remotefocus chap 8 21 Backfocus 2 Modify the the security level of these parameters videoin_c 0 n 1 _s 0 m 1 _ratiocorrect 3 Add optimizedir cgi V2 4a 2017 08 03 Kelly 1 Modify the description of th...

Page 183: ... _h264_cbr_qpercent videoin_c 0 n 1 _s 0 m 1 _h265_cbr_quant videoin_c 0 n 1 _s 0 m 1 _h265_cbr_qpercent videoin_c 0 n 1 _s 0 m 1 _mjpeg_cbr_quant videoin_c 0 n 1 _s 0 m 1 _mjpeg_cbr_qpercent V2 4c 2017 12 5 Kelly 1 Modify the description of these parameters videoin_c 0 n 1 _s 0 m 1 _smartfps_enable videoin_c 0 n 1 _s 0 m 1 _h264_smartq_enable videoin_c 0 n 1 _s 0 m 1 _h265_smartq_enable videoin_c...

Page 184: ...capability_daynight_c n _builtinwled 5 Modify the security level of system_info_serialnumber V2 5b 2018 03 26 Kelly 1 Modify the security level of system_info_serialnumber 2 Modify the description of these parameters image_c 0 n 1 _lens_ldc_mode capability_daynight_c 0 n 1 _builtinwled capability_smartstream_version 3 Modify the value type of these parameters capability_daynight_c 0 n 1 _mode capa...

Page 185: ...parameters capability_image_c 0 n 1 _wbmode videoin_c 0 n 1 _whitebalance videoin_c 0 n 1 _profile_i0_whitebalance 4 Add these parameters for WebAPI version 0311a capability_daynight_c 0 n 1 _spectrum_support capability_daynight_c 0 n 1 _spectrum_mode ircutcontrol_spectrum_mode capability_image_c 0 n 1 _exposure_meteringmode videoin_c 0 n 1 _meteringmode videoin_c 0 n 1 _profile_i0_meteringmode ca...

Page 186: ...el 5 Modify the value type of these parameters for WebAPI version 0311c ipfilter_maxconnection capability_localstorage_seamless network_http_s 0 m 1 _accessname network_rtsp_s 0 m 1 _accessname videoin_c 0 n 1 _s 0 m 1 _mjpeg_qvalue chap 8 20 Remotefocus 6 Modify the description of these parameters for WebAPI version 0311c audioin group event group recording group media group capability_daynight_c...

Page 187: ... 1 _mjpeg group 4 Add these parameters for WebAPI version 0311c event_i 0 n 1 _tampering V2 7d 2019 01 09 Grace 1 Remove these parameters capability_daynight_illuminators group ircutcontrol_illuminators group seamlessrecording_c 0 n 1 group timeshift_c 0 n 1 _enable Ircutcontrol_c 0 n 1 V2 8a 2019 03 06 Grace 1 Modify for querying API to for query API 2 Add thermal control CGI V2 9a 2019 05 21 Gra...

Page 188: ...rname timeshift_c 0 n 1 _enable capability_daynight_illuminator group ircutcontrol_c 0 n 1 group ircutcontrol_illuminators group seamlessrecording_c 0 n 1 group network_service_bonjour group 5 Remove description of nonexisted parameters of capability_peripheral group 6 Remove syslog cgi 2 9b 2019 09 09 Grace 1 Add descriptions for network_bonjour and seamlessrecording_c 0 n 1 group 2 Modify descri...

Page 189: ... Add channel support for remotefocus cgi 3 Add fisheyedewarp_c 0 n 1 _s 0 m 1 _region_r 0 i 1 _pan fisheyedewarp_c 0 n 1 _s 0 m 1 _region_r 0 i 1 _tilt fisheyedewarp_c 0 n 1 _s 0 m 1 _region_r 0 i 1 _zoo m 3 0b 2019 12 9 Grace 1 Parameter groups without channel informations are not supported for capability_nvideoin 1 3 0c 2020 3 11 Grace 1 Add Format SD card CGI 2 Add trigger time for setdo CGI 3 ...

Page 190: ...ge_management_device server_i 0 4 _ns_location for more details 4 Modify Get SDP of Streams section to support multi channel 3 1c 2020 6 10 Grace 1 videoin_c 0 n 1 _i 0 n 1 _profile_policy audioin_c0_i 0 n 1 _profile_policy image_ c 0 n 1 _i 0 n 1 _profile_policy does not support night mode when capability_daynight_c 0 n 1 _support 0 2 Logical OR is not supported when using mediaType for lsctrl cg...

Page 191: ...p_profiletoken 2 Add error messages for editaccount cgi 3 2b 2020 08 19 Grace 1 Add these parameters for WebAPI version 0314b recording_ i 0 n 1 _recordingjob_SourceToken_Token 3 2c 2020 08 26 Grace 1 Remove the support of exportDst cgi and upload_dst cgi for WebAPI version 0314b 3 2d 2020 9 1 Grace 1 lsctrl cgi changes to read only ...

Page 192: ... through URLs This document provides the supersets of URL commands for VIVOTEK products This section specifies the external HTTP based application programming interface The HTTP based camera interface provides the functionality to request a single image to control camera functions PTZ output relay etc and to get and set internal parameter values The image and CGI requests are handled by the built ...

Page 193: ...elow The name of the server is written as servername This is intended to be replaced with the name of the actual server This can either be a name e g mywebcam or thecam adomain net or the associated IP number for the server e g 192 168 0 220 Special notes will be marked in RED Syntax http servername cgi bin viewer video jpg Description of returned data is written with Return in bold face followed ...

Page 194: ...quest includes internal camera parameters these parameters must be written exactly as they are named in the camera or video server The CGIs are organized in functionally related directories under the cgi bin directory The file extension cgi is required Syntax http servername cgi bin subdir subdir cgi ext parameter value parameter value Example Set digital output 1 to active http mywebserver cgi bi...

Page 195: ...xcept some privileges and network options 6 admin admin Administrator access rights can fully control the camera s operations 7 N A Internal APIs Unable to be changed by any external interfaces A viewer account can access all APIs with security level 0 and 1 An operator account can access all APIs with security level 0 1 or 4 An admin account can access all APIs except internal APIs Access managem...

Page 196: ...r parameter Where the parameter should be group _ name or group name If you do not specify any parameters all the parameters on the server will be returned If you specify only group the parameters oftherelated group will be returned When querying parameter values the current parameter values are returned A successful control request returns parameter pairs as follows Return HTTP 1 0 200 OK r n Con...

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

Page 198: ...eter value return return page PARAMETER DESCRIPTION parameter A full path like videoin_c0_s0_h264_resolution videoin_c0_s0_h264_maxframe etc value The assigned value to the parameter return page Redirect to the page return page after the parameter is assigned The return page can be a full URL path or relative path according to the current path If you omit this parameter it will redirect to an empt...

Page 199: ... 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 200: ...com email address n A string limited to an email address shorter than n characters eg joe www ibm com ip address A string limited to an IP address eg 192 168 1 1 mac address A string limited to contain a MAC address without hyphens or colons boolean A boolean value of 1 or 0 represents Yes or No True or False Enable or Disable value1 value2 value3 Enumeration Only given values are valid blank A bl...

Page 201: ...mera should not be restarted when parameters are changed 7 1System Group system NAME VALUE SECURITY get set DESCRIPTION hostname string 64 1 6 Host name of server Network Camera Wireless Network Camera Video Server Wireless Video Server ledoff boolean 6 6 Turn on 0 or turn off 1 all led indicators date YYYY MM DD keep auto 6 6 Current date of system Set to keep to keep date unchanged Set to auto t...

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

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

Page 204: ...r when the version number httpversion is equal or greater than 0314b tz POSIX TZ string 6 6 POSIX timezone setting We support this parameter when the version number httpversion is equal or greater than 0314b restore 0 positive integer 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 ...

Page 205: ...ers will be restored to the default value except for a union of the combined results restoreexceptvadp 0 positive integer 7 6 Restore the system parameters to default values except the vadp parameters and VADP modules that stored 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 exc...

Page 206: ...out interval Only available when capability_taics_support 1 7 1 1 System Info Subgroup of system info The fields in this group are unchangeable NAME VALUE SECURITY get set DESCRIPTION modelname string 40 0 7 Internal model name of the server extendedmodelname string 40 0 7 ODM specific model name of server eg DCS 5610 If it is not an ODM model this field will be equal to modelname serialnumber mac...

Page 207: ...pported on the server customlanguage_coun t 0 positive integer 0 6 Number of custom languages which have been uploaded to the server customlanguage_i 0 maxcount 1 string 0 6 Custom language name 7 2Status Group status NAME VALUE SECURITY get set DESCRIPTION di_i 0 capability_ndi 1 product dependent boolean 1 7 0 Inactive normal 1 Active triggered capability_ndi 0 do_i 0 capability_ndo 1 product de...

Page 208: ...r n channel products n denotes the value of capability_nvideoin NAME VALUE SECURITY get set DESCRIPTION signal_detect boolean 1 7 Indicates whether the video source is connected or not Only available when capability_videoin_type is 0 or 1 signal_type ntsc pal 1 7 The actual modulation type Only available when capability_videoin_type is 0 or 1 7 3Digital Input Behavior Define Group di_i 0 n 1 for n...

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

Page 210: ...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 subnet router dns1 dns2 from DHCP server at next reboot 0 Use preset ipaddress subnet rounter dns1 and...

Page 211: ...talled 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 positive integer 6 7 Certificate file size in bytes privatekey_exist boolean 6 6 Private key ...

Page 212: ...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 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable IPv6 addonipaddress ip a...

Page 213: ...ideoin 1 _accessna me product dependent Not recommended to use this string 32 1 6 Http server push access name for stream N N 1 capability_nmediastream capability_ nvideoin 1 capability_protocol_spush_mjpeg 1 and capability_nmediastream 0 The value are shown as video1s1 mjpg c0_s0_accessname channel1stream1 video1s2 mjpg c0_s1_accessname channel1stream2 video1s3 mjpg c0_s2_accessname channel1strea...

Page 214: ...ty_nmediastream capability_protocol_spush_mjpeg 1 and capability_nmediastream 0 The value are shown as video1s1 mjpg c0_s0_accessname channel1stream1 video1s2 mjpg c0_s1_accessname channel1stream2 video2s1 mjpg c1_s0_accessname channel2stream1 video2s2 mjpg c1_s1_accessname channel2stream2 etc We support this parameter when the version number httpversion is equal or greater than 0311c 7 6 7 HTTS P...

Page 215: ... s0_accessname channel1stream1 live1s2 sdp s1_accessname channel1stream2 live1s3 sdp s2_accessname channel1stream3 live1s4 sdp s3_accessname channel1stream4 etc Values start with prefix cgi bin are prohibited For example c cg cgi cgi cgi b cgi bi cgi bin are not allowed We modify the value of RTSP access name after version number httpversion is 0311c c 0 capability_nvide oin 1 _s 0 capabilit y_nme...

Page 216: ...his parameter when the version number httpversion is equal or greater than 0313a 7 6 9 RTSP Multicast Subgroup of network rtsp_s 0 n 1 _multicast n denotes the value of capability_nmediastream capability_nvideoin NAME VALUE SECURITY get set DESCRIPTION alwaysmulticast boolean 4 4 Enable always multicast ipaddress ip address 4 4 Multicast video IP address We replace network_rtsp_s 0 n 1 _multicast_...

Page 217: ...ersion number httpversion is equal or greater than 0304a videoport 1025 65535 4 4 Multicast video port audioport product dependent 1025 65535 4 4 Multicast audio port Only available when capability_naudioin 0 metadataport 1026 6553 4 4 4 Multicast metadata port ttl 1 255 4 4 Multicasttime to live value 7 6 10 SIP Port Subgroup of network sip capability_protocol_sip 0 NAME VALUE SECURITY get set DE...

Page 218: ...ce_bonjour NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable bonjour service feature We support this parameter when the version number httpversion is equal or greater than 0312a servicename string 6 6 A friendly name for bonjour service We support this parameter when the version number httpversion is equal or greater than 0312a 7 6 14 SFTP server Only available when bit 1 of capabi...

Page 219: ...s ip address Network address ip address network mask Range address start ip address end ip address 6 6 IPv4 address list ipv6list_i 0 9 string 43 6 6 IPv6 address list 7 8Video Input Not Recommended to use Group videoin We do not support this parameter when capability_nvideoin 1 NAME VALUE SECURITY get set DESCRIPTION cmosfreq 50 60 4 4 CMOS frequency Only available when capability_videoin_type is...

Page 220: ...alance 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_image_c 0 n 1 _wbmo de...

Page 221: ...r httpversion is equal or greater than 0400a irismode fixed indoor outdoor product independent 4 4 Control DC Iris mode outdoor Auto setting DC Iris to get best quality but easy to meet rolling or flicker effect in indoor environment indoor Avoid rolling and flicker effect first fixed Open the iris to maximum Only available when capability_image_c 0 n 1 _iristype dciris We do not support this para...

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

Page 223: ...ort Bit 4 Support zoom operation 0 not support 1 support Bit 5 Support focus operation 0 not support 1 support SD PZ IZ series only Not support this parameter anymore when the version number httpversion is equal or greater than 0309a text string 64 1 4 Enclose caption We do not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion is...

Page 224: ...when capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a maxexposure product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_ c 0 n 1 _exposu re_maxrange 4 4 Maximum exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc This parameter may also ...

Page 225: ... not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a 7 8 1 Video Input Setting per Channel Group videoin_c 0 n 1 for n channel products and m is stream number n denotes the value of capability_nvideoin m denotes the value of capability_nmediastream NAME VALUE SECURITY get set DESCRIPTION cmosfreq ...

Page 226: ...d 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_image_c 0 n 1 _wbmo de rgain 0 100 4 4 Manual set rgain value of gain control setting 0...

Page 227: ...definition is 0 EV 2 0 1 EV 1 7 2 EV 1 3 3 EV 1 0 4 EV 0 7 5 EV 0 3 6 EV 0 7 EV 0 3 8 EV 0 7 9 EV 1 0 10 EV 1 3 11 EV 1 7 12 EV 2 0 Only available when capability_image_c 0 n 1 _exposu re_mode 0 exposuremode product dependent auto shutterpriority irispriority qualitypriority manual etc Available options are list 4 4 Select exposure mode auto Automatically adjust the Iris Gain and Shutter Speed to ...

Page 228: ... 0 n 1 _exposu re_mode 0 irismode fixed indoor outdoor product dependent 4 4 Control DC Iris mode outdoor Auto setting DC Iris to get best quality but easy to meet rolling or flicker effect in indoor environment indoor Avoid rolling and flicker effect first fixed Open the iris to maximum Only available when capability_image_c 0 n 1 _iristype dciris piris_mode product dependent manual indoor outdoo...

Page 229: ...blc Not support anymore boolean 4 4 Enable backlight compensation Not support this parameter anymore when the version number httpversion is equal or greater than 0301a It s recommanded to use exposurewin_c 0 n 1 _mode to switch on off BLC maxgain 0 100 4 4 Maximum gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_m axgain Only valid when piris_mode manual or irismode fixe...

Page 230: ...rmalized range We support this parameter when the version number httpversion is equal or greater than 0302a color 0 1 4 4 0 monochrome 1 color Only available when capability_videoin_c 0 n 1 _color_ support is 1 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 0 n 1 _rotati on 1...

Page 231: ...tonvideo_p osition top bottom 4 4 Text on video string position textonvideo_si ze 20 40 4 4 Text on video font size textonvideo_fo ntpath usr share font Default ttf mnt flash2 upload ttf 4 4 Choose camera default font file usr share font Default ttf or user uploaded font file mnt flash2 upload ttf textonvideo_u ploadfilename Depends on the font file name uploaded by user 1 7 Show the uploaded font...

Page 232: ...ct image frame rate from sensor due to sensor generates a frame per exposure time Ex If this is set to 1 5s 1 8000s and camera takes 1 5s on the night then sensor only outputs 5 frame s Only available when capability_image_c 0 n 1 _exposu re_maxrange Only valid when piris_mode manual or irismode fixed Only available when capability_image_c 0 n 1 _exposu re_rangetype is twovalues shuttervalue produ...

Page 233: ...deo profile Only available when capability_image_c 0 n 1 _exposu re_mode 0 meteringmode auto blc hlc Available value is listed in capability_image_c 0 n 1 _exposure_meteringm ode 4 4 auto The algorithm chooses the best metering strategy blc This metering method increases the weight of dark area hlc The metering method can detect strong light and make affected area clear We support this parameter w...

Page 234: ... 1 _exposu re_bracketing_mode 1 We support this parameter when the version number httpversion is equal or greater than 0310a s 0 m 1 _en ableeptz boolean 4 4 Indicate whether stream supprts eptz or not s 0 m 1 _co dectype Listed at capability_videoin_codec Possible values are mjpeg h264 h265 product dependent 1 4 Codec type for this stream s 0 m 1 _re solution Available options are list in capabil...

Page 235: ... 250 500 1000 2000 3000 4000 4 4 The time interval between two I frames Intra coded picture The unit is millisecond ms s 0 m 1 _h2 64_ratecontrol mode cbr vbr 4 4 cbr Constant bit rate mode vbr Fixed quality mode all frames are encoded in the same quality s 0 m 1 _h2 64_quant 1 5 99 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality leve...

Page 236: ...264_ratecontrolmode vbr s 0 m 1 _h2 64_cbr_quant 1 5 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality level in cbr_qpercent Only available when h264_ratecontrolmode cbr s 0 m 1 _h2 64_cbr_qperce nt 1 100 4 4 Select customized quality in a normalized full range 1 Worst quality 100 Best quality Only valid when h264_ratecontrolmode cbr an...

Page 237: ...in_c n _h264_profil e s 0 m 1 _h2 64_smartq_en able boolean 4 4 Enable Smart Q function Only available when capability_videoin_c 0 n 1 _smart q_support is 1 We support this parameter when the version number httpversion is equal or greater than 0309a s 0 m 1 _h2 65_dintraperio d_enable boolean 4 4 Enable Dynamic intra frame period Only available when capability_videoin_c 0 n 1 _dintra period_suppor...

Page 238: ...in capability_videoin_codec Only valid when h265_ratecontrolmode vbr s 0 m 1 _h2 65_qvalue 0 51 4 4 Manual video quality level input The Q value which is used by encoded library directly Only available when h265 is listed in capability_videoin_codec Only valid when h265_ratecontrolmode vbr and s 0 m 1 _h265_quant 99 s 0 m 1 _h2 65_qpercent 1 100 4 4 Select customized quality in a normalized full r...

Page 239: ... level in cbr_qpercent Only available when h265 is listed in capability_videoin_codec and h265_ratecontrolmode cbr s 0 m 1 _h2 65_cbr_qperce nt 1 100 4 4 Select customized quality in a normalized full range 1 Worst quality 100 Best quality Only available when h265 is listed in capability_videoin_codec Only valid when h265_ratecontrolmode cbr and quant 100 s 0 m 1 _h2 65_bitrate 20000 capability_vi...

Page 240: ...5_profile Available values are listed in capability_videoin_c 0 n 1 _h265_profile 1 4 Indicate H265 profiles Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h2 65_smartq_en able boolean 4 4 Enable Smart Q function Only available when h265 is listed in capability_videoin_codec Only available when capability_videoin_c 0 n 1 _smart q_support is 1 We support this parameter when...

Page 241: ...lue which is used by encoded library directly Only valid when mjpeg_ratecontrolmode vbr and s 0 m 1 _mjpeg_quant 99 s 0 m 1 _mj peg_qpercent 1 100 4 4 Select customized quality in a normalized full range 1 Worst quality 100 Best quality Only valid when mjpeg_ratecontrolmode vbr and s 0 m 1 _mjpeg_quant 100 s 0 m 1 _mj peg_maxvbrbit rate 20000 capability_videoin _c 0 n 1 _mjpeg_maxbi trate 4 4 The ...

Page 242: ... rate in constant bit rate mode Only valid when mjpeg_ratecontrolmode cbr s 0 m 1 _mj peg_prioritypo licy framerate imagequality 4 4 Set prioritypolicy Only valid when mjpeg_ratecontrolmode cbr s 0 m 1 _mj peg_maxframe 1 capability_videoin_c 0 n 1 _mjpeg_maxframer ate 1 4 The maximum frame rates of a mjpeg stream at different resolutions capability_videoin_c 0 n 1 _resolution are recorded in capab...

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

Page 244: ...vel 1 4 low high The higher sensitivity level meas that it is easy to be trigger while scene changed Only available when capability_image_c 0 n 1 _aespee d is 1 and capability_image_c 0 n 1 _aespee dsupportsensitivity is 1 flickerless product dependent boolean 4 4 Turn on 1 or turn off 0 the flickerless mode Only available when capability_image_c 0 n 1 _flickerl ess is 1 mounttype ceiling wall flo...

Page 245: ...eam_support 1 and capability_smartstream_version 2 0 Group videoin_c 0 n 1 _s 0 m 1 _h265_smartstream2 capability_smartstream_support 1 capability_smartstream_version 2 0 and h265 is listed in capability_videoin_codec n denotes the value of capability_nvideoin m denotes the value of capability_nmediastream NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable or Disable smart codec fun...

Page 246: ..._i 0 k 1 capability_smartstream_support 1 capability_smartstream_version 2 0 and h265 is listed in capability_videoin_codec and capability_smartstream_mode_manual 1 n denotes the value of capability_nvideoin m denotes the value of capability_nmediastream k denotes the value of capability_smartstream_nwindow_manual NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable or disable the win...

Page 247: ...inexposure product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c 0 n 1 _exposure_minrange 4 4 Minimum exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc Only available when capability_image_c 0 n 1 _exposu re_minrange Only valid when piris_mode manual or irismode fixed Only available when capability_image_...

Page 248: ...uct dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c 0 n 1 _exposure_maxrange 4 4 Exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc This parameter may also restrict image frame rate from sensor due to sensor generates a frame per exposure time Ex If this is set to 1 5s 1 8000s and camera takes 1 5s on the ni...

Page 249: ...s The definition is 0 EV 2 0 1 EV 1 7 2 EV 1 3 3 EV 1 0 4 EV 0 7 5 EV 0 3 6 EV 0 7 EV 0 3 8 EV 0 7 9 EV 1 0 10 EV 1 3 11 EV 1 7 12 EV 2 0 Only available when capability_image_c0_exposure_mod e 0 exposuremode product dependent auto shutterpriority irispriority qualitypriority manual etc Available options are list in 4 4 Select exposure mode auto Automatically adjust the Iris Gain and Shutter Speed ...

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

Page 251: ... n 1 _whitebalance auto Normalized range bgain 0 100 4 4 Manual set bgain value of gain control setting 0 Weak 100 Strong Only available when rbgain is listed in capability_image_c 0 n 1 _wbmo de Only valid when videoin_c 0 n 1 _whitebalance auto Normalized range maxgain 0 100 4 4 Maximum gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_m axgain Only valid when piris_mod...

Page 252: ..._c 0 n 1 _exposu re_rangetype is onevalue Normalized range We support this parameter when the version number httpversion is equal or greater than 0302a meteringmode auto blc hlc Available value is listed in capability_image_c 0 n 1 _exposure_meteringm ode 4 4 auto The algorithm chooses the best metering strategy blc This metering method increases the weight of dark area hlc The metering method can...

Page 253: ...l set P Iris 1 Open 100 Close Only valid when piris_mode manual or capability_image_c 0 n 1 _sensor type is smartsensor Only available when capability_image_c 0 n 1 _iristype piris irismode fixed indoor outdoor product dependent 4 4 Control DC Iris mode outdoor Auto setting DC Iris to get best quality but easy to meet rolling or flicker effect in indoor environment indoor Avoid rolling and flicker...

Page 254: ...Only available when capability_image_c 0 n 1 _wdrc_ mode is 1 wdrc_strength product dependent 1 100 4 4 The strength of WDR enhanced The bigger value means the stronger strength of WDR enhanced Only available when capability_image_c 0 n 1 _wdrc_ mode is 1 aespeed_mod e product dependent boolean 4 4 Turning AE converge speed on or off 0 off 1 on Only available when capability_image_c 0 n 1 _aespee ...

Page 255: ...ability_image_c 0 n 1 _aespee d is 1 and capability_image_c 0 n 1 _aespee dsupportsensitivity is 1 flickerless product dependent boolean 4 4 Turn on 1 or turn off 0 the flickerless mode Only available when capability_image_c 0 n 1 _flickerl ess is 1 7 8 2 Multicast Settings for Video Streaming Group videoin_c 0 n 1 _s 0 m 1 _multicast capability_media_streamprofiles_support 1 n denotes the value o...

Page 256: ...than 0312a We do not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a c 0 n 1 _en able boolean 4 4 Enable time shift streaming We support this parameter when the version number httpversion is equal or greater than 0312a c 0 n 1 _s 0 m 1 _allo w boolean 4 4 Enable time shift streaming for specific s...

Page 257: ...aynight_c 0 capability_ nvideoin 1 _smartir is 1 We replace this parameter with ircutcontrol_c 0 n 1 _sir when the version number httpversion is equal or greater than 0312a We do not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a daymodebegintime Not recommended to use this 00 00 23 59 6 6 Day mo...

Page 258: ...rcutcontrol_illuminators_builtin_irle d_enabled when the version number httpversion is equal or greater than 0312a We do not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a enableextled Not recommended to use this boolean 1 6 Enable disable external IR led Only available when capability_daynight_c...

Page 259: ...r httpversion is equal or greater than 0400a bwmode Not recommended to use this boolean 6 6 Switch to B W in night mode if enabled Only available when capability_daynight_c 0 n 1 _ blackwhitemode is 1 We replace this parameter with ircutcontrol_c 0 n 1 _bwmode when the version number httpversion is equal or greater than 0312a We do not support this parameter when capability_nvideoin 1 This paramet...

Page 260: ...e this visible ir irenhanced blueenhanced product dependent Available values are listed in capability_daynight_ c 0 n 1 _spectrum _mode 6 6 Set spectrum method Only available when capability_daynight_c 0 n 1 _spec trum_support is 1 We replace this parameter with ircutcontrol_illuminators_spectrum_ mode when the version number httpversion is equal or greater than 0312a We do not support this parame...

Page 261: ...rt this parameter when the version number httpversion is equal or greater than 0312a daymodebegintime 00 00 23 59 6 6 Day mode begin time We support this parameter when the version number httpversion is equal or greater than 0312a daymodeendtime 00 00 23 59 6 6 Day mod end time We support this parameter when the version number httpversion is equal or greater than 0312a bwmode boolean 6 6 Switch to...

Page 262: ...ontrol_illuminators capability_daynight_c 0 n 1 _support 0 n denotes the value of capability_nvideoin NAME VALUE SECURIT Y get set DESCRIPTION builtin_irled_enabled boolean 6 6 Enable disable built in IR led Only available when capability_daynight_illuminators_buil tin_support 0 and irled is listed in capability_daynight_ illuminators _builtin_type We support this parameter when the version number...

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

Page 264: ...ting is 1 We replace brightness with brightnesspercent This parameter will not be used after the version number httpversion is equal or greater than 0400a contrast Not recommended to use this 5 5 100 4 4 5 Less contrast 5 More contrast 100 Use image_c 0 n 1 _contrastpercent Only available when bit 1 of capability_image_c 0 n 1 _basicse tting is 1 We replace contrast with contrastpercent This param...

Page 265: ...eplace sharpness with sharpnesspercent This parameter will not be used after the version number httpversion is equal or greater than 0400a brightnesspercent 0 100 4 4 Set brightness in the normalized range 0 Darker 100 Bright Only available when bit 0 of capability_image_c 0 n 1 _basicse tting is 1 contrastpercent 0 100 4 4 Set contrast in the normalized range 0 Less contrast 100 More contrast Onl...

Page 266: ...gh we set gamma value to 100 level but not all gamma values are valid Internal module will take the closest valid one For example 1 45 may all be mapped to gamma value 0 45 etc Only available when capability_image_c 0 n 1 _gamm acurve is 1 lowlightmode product dependent boolean 4 4 Enable disable low light mode Only available when capability_image_c 0 n 1 _lowligh tmode is 1 hlm product dependent ...

Page 267: ...bility_image_c 0 n 1 _defog_ mode is 1 eis_mode product dependent boolean 4 4 Electronic image stabilizer 0 disable 1 enable Only available when eis is listed in capability_image_c 0 n 1 _is_mod e eis_strength product dependent 1 100 4 4 Strength of electronic image stabilizer Only available when eis is listed in capability_image_c 0 n 1 _is_mod e dis_mode product dependent boolean 4 4 Digital ima...

Page 268: ...er 4 4 Restore of adjusting white balance of image according to mode settings freeze product dependent boolean 4 4 Enable disable Image freeze while patrolling 0 disable 1 enable Only available when capability_image_c 0 n 1 _freeze is 1 deinterlace_enable boolean 4 4 Enable disable deinterlace function 0 disable 1 enable Only available when capability_image_c 0 n 1 _deinter lace_support is 1 deint...

Page 269: ...lignment 0 100 4 4 Stitch the sensors together into focused position Only available when capability_image_c 0 n 1 _lens_al ignment is 1 lens_ldc_mode boolean 4 4 Enable disable lens distortion correction Only available when capability_image_c 0 n 1 _lens_ld c_support is 1 palette_mode Available value is listed in capability_image_c 0 n 1 _palette_mo de 1 4 Set color palette option Only available w...

Page 270: ...rcent Only available when bit 0 of capability_image_c 0 n 1 _basicse tting is 1 We replace profile_i0_brightness with profile_i0_brightnesspercent This parameter will not be used after the version number httpversion is equal or greater than 0400a profile_i 0 m 1 _contrast Not recommended to use this 5 5 100 4 4 5 Less contrast 5 More contrast 100 Use image_c 0 n 1 _contrastpercent Only available w...

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

Page 272: ...ange 0 Softer 100 Sharper Only available when bit 3 of capability_image_c 0 n 1 _basicse tting is 1 profile_i 0 m 1 _gammacurve 0 100 4 4 0 Fine turned gamma curve by Vivotek 1 Gamma value 0 01 2 Gamma value 0 02 3 Gamma value 0 03 100 Gamma value 1 Note Although we set gamma value to 100 level but not all gamma values are valid Internal module will take the closest valid one For example 1 45 may ...

Page 273: ...profile_i 0 m 1 _defog_mode product dependent boolean 4 4 Enable disable defog mode 0 disable 1 enable Only available when capability_image_c 0 n 1 _defog_ mode is 1 profile_i 0 m 1 _defog_strength product dependent 1 100 4 4 Strength of defog Only available when capability_image_c 0 n 1 _defog_ mode is 1 profile_i 0 m 1 _eis_mode product dependent boolean 4 4 Electronic image stabilizer 0 disable...

Page 274: ...pability_image_c 0 n 1 _exposure_mode 1 NAME VALUE SECURITY get set DESCRIPTION mode auto custom blc hlc center Available values are listed in capability_image_c 0 n 1 _exposure_winmode 4 4 auto Use full image view as the only exposure window custom Use custom windows blc Use BLC Back Light Compensation and the only exposure window is located at the center of view hlc Use HLC High Light Compensati...

Page 275: ...0 4 4 Left top corner coordinate of the window Only available when qvga is listed in capability_image_c 0 n 1 _exposu re_windomain size 0 320x0 240 4 4 Width and height of the window Only available when qvga is listed in capability_image_c 0 n 1 _exposu re_windomain 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 availab...

Page 276: ...get set DESCRIPTION mode auto custom blc hlc center Available values are listed in capability_image_c 0 n 1 _exposure_winmode 4 4 The mode indicates how to decide the exposure auto Use full view as the only one exposure window custom Use inclusive and exclusive window blc Use BLC Back Light Compensation and the only exposure window is located at the center of view hlc Use HLC High Light Compensati...

Page 277: ...y available when capability_daynight_c 0 n 1 _sup port 0 home 0 320 0 240 4 4 Left top corner coordinate of the window Only available when qvga is listed in capability_image_c 0 n 1 _exposu re_windomain size 0 320x0 240 4 4 Width and height of the window Only available when qvga is listed in capability_image_c 0 n 1 _exposu re_windomain homepx 0 W 0 H W 0 The current image width 1 H 0 The current ...

Page 278: ...udioin NAME VALUE SECURITY get set DESCRIPTION source Not recommended to use this micin linein product dependent 4 4 micin use built in microphone input linein use external microphone input We replace this parameter with audioin_c 0 n 1 _input when the version number httpversion is equal or greater than 0301a input intmic extmic product dependent 4 4 intmic Internal built in microphone Only availa...

Page 279: ...ts external microphone The related bit of capability_audio_extmic is equal to 1 mute 0 1 1 4 0 Mute off 1 Mute on gain Not recommended to use this 0 100 4 4 Gain of input audioin_c 0 n 1 _source linein Reserved for compatibility and suggest don t use this since the version number httpversion is equal or greater than 0301a We replace gain with volume_internal and volume_external More details please...

Page 280: ...e listed in capability_audioin_ codec 4 4 Set audio codec type for input aac4 Advanced Audio Coding AAC gamr Adaptive Multi Rate AMR g711 G 711 g726 G 726 s0_aac4_bitrate 16000 32000 48000 64000 96000 128000 4 4 Set AAC4 bitrate in bps Only available if AAC is supported s0_gamr_bitrate 4750 5150 5900 6700 7400 7950 10200 12200 4 4 AMR encoded bitrate in bps Only available if AMR is supported s0_g7...

Page 281: ...pability_audio_aecmode is manual We support this parameter when the version number httpversion is equal or greater than 0306b alarm_enable boolean 4 4 Enable audio detection alarm_level 1 100 4 4 Audio detection alarm level profile_i0_enable boolean 4 4 Enable disable this profile setting profile_i0_policy night schedule product dependent 4 4 The mode which the profile is applied to Not support po...

Page 282: ...io time to live value 7 14 Audio Output per Channel Group audioout_c 0 n 1 for n channel products capability_naudioout 0 n denotes the value of capability_naudioout NAME VALUE SECURITY get set DESCRIPTION volume 0 100 4 4 Adjusting audio volume 7 15 Play an Audio Clip Group audioclip_i 0 1 capability_audio_audioclip 1 NAME VALUE SECURITY get set DESCRIPTION name string 40 1 4 Specify the audio cli...

Page 283: ...ach Window Group motion_c 0 n 1 _win_i 0 k 1 n denotes the value of capability_nvideoin k denotes the value of capability_nmotion NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable 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 ...

Page 284: ...tpversion is equal or greater than 0400a polygon Not recommended to use this 0 320 0 240 0 320 0 240 0 320 0 240 0 320 0 240 4 4 Coordinate of polygon window position 4 points x0 y0 x1 y1 x2 y2 x3 y3 Only available when capability_motion_wintype polygon Only available when qvga is listed in capability_motion_windomain It s recommended to use polygonsd This parameter will not be used after the vers...

Page 285: ...e 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 height Not recommended to use this 0 240 4 4 Height of motion detection window Only available when capability_motion_wintype rectangle Only available when qvga is listed in capability_motion_windoma...

Page 286: ...sion number httpversion is equal or greater than 0400a Group motion_c 0 n 1 _profile_i 0 m 1 _win_i 0 k 1 for m profile and n channel product n denotes the value of capability_nvideoin m denotes the vaule of capability_nmotionprofile k denotes the value of capability_nmotion NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable motion detection window name string 14 4 4 Name of motion ...

Page 287: ... is equal or greater than 0400a polygon Not recommended to use this 0 320 0 240 0 320 0 240 0 320 0 240 0 320 0 240 4 4 Coordinate of polygon window position 4 points x0 y0 x1 y1 x2 y2 x3 y3 Only available when capability_motion_wintype polygon 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 numbe...

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

Page 289: ...xceeds the threshold for more than duration second s then image too dark detection is triggered bright_enable boolean 4 4 Enable or disable image too bright detection bright_threshold 0 100 4 4 Threshold of image too bright detection bright_duration 1 10 4 4 If image too bright value exceeds the threshold for more than duration second s then image too bright detection is triggered blurry_enable bo...

Page 290: ...ice provider provider _passwor dkey string 64 7 6 Your password or key to login to the DDNS service provider 7 19 Express Link Group expresslink PARAMETER VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable or disable express link state onlycheck onlyoffline checkonline badnetwork 6 6 Camera will check the status of network environment and express link URL url string 64 6 6 The url user d...

Page 291: ...et set DESCRIPTION enableremotelog boolean 6 6 Enable remote log serverip IP address 6 6 Log server IP address serverport 514 1025 65535 6 6 Server port used for log level 0 7 6 6 Levels used to distinguish the importance of the information 0 LOG_EMERG 1 LOG_ALERT 2 LOG_CRIT 3 LOG_ERR 4 LOG_WARNING 5 LOG_NOTICE 6 LOG_INFO 7 LOG_DEBUG setparamlevel 0 2 6 6 Show log of parameter setting 0 disable 1 ...

Page 292: ...A 6 6 Read only authentication type encryptpwrw string 8 128 7 6 Read write passwrd encryptpwro string 8 128 7 6 Read only password encrypttyperw DES 6 6 Read write encryption type encrypttypero DES 6 6 Read only encryption type rwcommunity string 31 6 6 Read write community rocommunity string 31 6 6 Read only community syslocation string 128 6 6 System location syscontact string 128 6 6 System co...

Page 293: ...or of configuration area theme_color_videoback ground string 7 1 6 Background color of video area theme_color_case string 7 1 6 Frame color defaultpassword_specia lcharacter _ 6 7 Allowed special characters We support this parameter when the version number httpversion is equal or greater than 0314b defaultpassword_type positive integer 6 7 Required character type for password An 32 bit integer eac...

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

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

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

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

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

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

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

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

Page 302: ...st stream supports ePTZ or not Bit 1 2nd stream supports ePTZ or not and so on For nvideoin 2 the definition is different First all 32 bits are divided into groups for channel Ex nvideoin 2 bit 0 15 are the 1st group for 1st channel bit 16 31 are the 2nd group for 2nd channel nvideoin 3 bit 0 9 are the 1st group for 1st channel bit 10 19 are the 2nd group for 2nd channel bit 20 31 are the 3rd grou...

Page 303: ...o support local storage fisheye boolean 0 7 The parameter is used to determine whether the product is fisheye or not tampering boolean 0 7 Indicate whether to support tampering detection tamperingmode tamper toodark toobri ght tooblurry 0 7 Available tampering mode list Only available when capability_tampering is 1 adaptiverecording boolean 0 7 Indicate whether to support adaptive recording adapti...

Page 304: ...Number of media number We support this parameter when the version number httpversion is equal or greater than 0311c storage_dbenabled boolean 0 7 Media files are indexed in database protocol_https boolean 0 7 Indicate whether to support HTTP over SSL protocol_rtsp boolean 0 7 Indicate whether to support RTSP protocol_sip boolean 0 7 Indicate whether to support SIP protocol_maxconn ection positive ...

Page 305: ...whether to support IPv6 protocol_pppoe boolean 0 7 Indicate whether to support PPPoE protocol_ieee8021 x boolean 0 7 Indicate whether to support IEEE802 1x protocol_qos_cos boolean 0 7 Indicate whether to support CoS protocol_qos_dscp boolean 0 7 Indicate whether to support QoS DSCP protocol_ddns boolean 0 7 Indicate whether to support DDNS protocol_ftp_serve r positive integer 0 7 An 32 bit integ...

Page 306: ...bility_videoin_c0_mjpeg_maxfra merate This is kept for compatibility videoin_h264_max framerate A list of Integer and 0 7 This equals capability_videoin_c0_h264_maxfra merate This is kept for compatibility videoin_codec mjpeg h264 h265 product dependent 0 7 Available codec of a device split by comma The sequence is not limited EX FD8183 supports H 264 and MJPEG then this is mjpeg h264 IP9171 suppo...

Page 307: ...ility_audio_aec is 1 We support this parameter when the version number httpversion is equal or greater than 0306b audio_aecaffect maxframerate fixed 1 5 product dependent 0 7 When acoustic echo cancellation function 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 catego...

Page 308: ... 15 which means the max frame rate is 15fps when acoustic echo cancellation function is enabled means no feature is affected Only available when capability_audio_aec is 1 We support this parameter when the version number httpversion is equal or greater than 0306b audio_mic Not support anymore boolean 0 7 Indicate whether to support built in microphone input Not support this parameter anymore when ...

Page 309: ...c audio_lineout boolean 0 7 Indicate whether to support line output audio_michardwar eswitch boolean 0 7 Indicate whether the hardware supports built in external mic switch audio_headphoneo ut Not 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 audio_audioclip boolean 0 7 ...

Page 310: ...e image with pixels std A normalized 0 9999 range Not supported smartstream_supp ort boolean 0 7 Indicate whether smart stream is supported smartstream_versi on integer 0 7 Number of smart stream version Only available when capability_smartstream_support is 1 smartstream_nstre am positive integer 0 7 Number of stream that support smart stream Only available when capability_smartstream_support is 1...

Page 311: ...lity_smartstream_support is 1 smartstream_nwin dow_manual positive integer 0 7 Maximum number of tracking window of manual Only available when capability_smartstream_support is 1 smartstream_nwin dow_hybrid_autotr acking positive integer 0 7 Maximum number of tracking window of autotracking in hybrid mode Only available when capability_smartstream_support is 1 smartstream_nwin dow_hybrid_manu al p...

Page 312: ... equal or greater than 0301b It will be replaced by capability_camctrl_ptztunnel camctrl_ptztunnel boolean 0 7 Indicate whether to support ptztunnel We support this parameter when the version number httpversion is equal or greater than 0301b This equals capability_camctrl_c0_ptztunnel This is kept for compatibility camctrl_privilege boolean 0 7 Indicate whether to support Manage Privilege of PTZ c...

Page 313: ...802dot1 1b boolean 0 7 Indicate whether to support wireless 802 11b wireless_s802dot1 1g boolean 0 7 Indicate whether to support wireless 802 11g wireless_s802dot1 1n boolean 0 7 Indicate whether to support wireless 802 11n wireless_begincha nnel 1 14 0 7 Indicate the begin channel of wireless network wireless_endchann el 1 14 0 7 Indicate the end channel of wireless network wireless_encrypt_ wep ...

Page 314: ...TCVV TCXX is excepted test_ac boolean 0 7 Indicate whether to support test ac key version_onvifdaem on string 0 7 Indicate ONVIF daemon version version_onviftestto ol string 0 7 Indicate ONVIF test tool version version_genetec string 0 7 Indicate Genetec daemon version We support this parameter when the version number httpversion is equal or greater than 0312a media_totalspace positive integer 0 7...

Page 315: ...rofiles We support this parameter when the version number httpversion is equal or greater than 0313a image_iristype Not recommended to use this string 0 7 Indicate iris type piris P Iris dciris DC Iris 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 capabili...

Page 316: ...recommended to use this 0 positive integer 0 7 The maximum MOD connection numbers Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 We replace this parameter with capability_storage_management_mo dnum when the version number httpversion is equal or greater than 0312a localstorage_modv ersion string 0 7 Indicate MOD daemon version Only available when capability_supp...

Page 317: ...Lifetime and Log SD Card feature allows users to obtain the card s remaining lifetime information 0 Non support this feature 1 Support this feature Only Sony Micron SD card can support this function now Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 remotecamctrl_ma ster 0 positive integer 0 7 Indicate whether to support remote auxiliary camera master side this ...

Page 318: ... t Boolean 0 7 Indicate support for security camera We support this parameter when the version number httpversion is equal or greater than 0314a securecam_version string 0 7 Indicate the security camera feature phases Only available when capability_securecam_support 1 We support this parameter when the version number httpversion is equal or greater than 0314a taics_support boolean 0 7 Support the ...

Page 319: ...CURITY get set DESCRIPTION ptztunnel boolean 0 7 Indicate whether to support ptztunnel in this video input privilege boolean 0 7 Indicate whether to support Manage Privilege of PTZ control in the security page in this video input 1 support both cgi bin camctrl camctrl cgi and cgi bin viewer camctrl cgi 0 support only cgi bin viewer camctrl cgi rs485 boolean 0 7 An 32 bit integer each bit can be se...

Page 320: ...l length is adjusted the zoom will stay in focus when the focal length is adjusted focusmode auto onetimeauto sp otlight manual product dependent 0 7 Focus mode selection auto Camera will automatically adjust the focus position full time to adapt a clear picture onetimeauto Camera will automatically adjust the focus position one time which follows any PTZ control spotlight Camera will automaticall...

Page 321: ...for pan position Only available when bit0 of capability_camctrl_c 0 n 1 _buildin pt is 1 maxpan 0 positive integer 0 7 The upper limit for pan position Only available when bit0 of capability_camctrl_c 0 n 1 _buildin pt is 1 minpanangle integer 0 7 The lower limit for pan angle Only available when bit0 of capability_camctrl_c 0 n 1 _buildin pt is 1 maxpanangle integer 0 7 The upper limit for pan an...

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

Page 323: ... capability_daynight_c 0 n 1 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION support boolean 0 7 Indicate whether the camera supports day night mode switch builtinir boolean 0 7 Indicate whether to support built in IR led We replaced this parameter with capability_daynight_illuminators_builti n_support when the version number httpversion is equal or greater ...

Page 324: ...port optimized IR control technology We replaced this parameter with capability_daynight_illumintators_opti mizedir when the version number httpversion is equal or greater than 0312a smartir boolean 0 7 Indicate whether to support smart IR ircutfilter boolean 0 7 Indicate whether to support IR cut lightsensor boolean 0 7 Indicate whether to support light sensor blackwhitemode boolean 0 7 Indicate ...

Page 325: ...qual or greater than 0302a ircutsensitivity_supportle vel 0 positive integer 0 7 The value indicate the support strength level of ircutsensitivity Only available when capability_daynight_c 0 n 1 _suppo rt is 1 and capability_daynight_c 0 n 1 _ircuts ensitivity_type is not We support this parameter when the version number httpversion is equal or greater than 0302a extled_interface do product depend...

Page 326: ...port when the version number httpversion is equal or greater than 0312a spectrum_mode visible ir irenhanced blueenhanced product dependent 0 7 Indicate the spectrum mode visible The ideal default setting for visible light ir The ideal default setting for IR light irenhanced This CCM model increases the brightness effect of IR light blueenhanced This CCM model increases the brightness effect of blu...

Page 327: ...di the camera automatically switches the current mode when a ditigal input 1 is triggered di2 the camera automatically switches the current mode when a ditigal input 2 is triggered di3 the camera automatically switches the current mode when a ditigal input 3 is triggered di4 the camera automatically switches the current mode when a ditigal input 4 is triggered schedule The Camera switches between ...

Page 328: ...d type irled IR led whiteled white led not support We support this parameter when the version number httpversion is equal or greater than 0312a external_support boolean 0 7 Indicate whether to support external led We support this parameter when the version number httpversion is equal or greater than 0312a external_interface do do2 do3 do4 product dependent Available values are do do 2 capability_n...

Page 329: ...de visible The ideal default setting for visible light ir The ideal default setting for IR light irenhanced This CCM model increases the brightness effect of IR light blueenhanced This CCM model increases the brightness effect of blue light Only available when capability_daynight_c 0 n 1 _support is 1 and capability_daynight_illuminators_spectru m_support is 1 We support this parameter when the ve...

Page 330: ...httpversion is equal or greater than 0312a 7 27 6 Capability for Video Input Group capability_videoin_c 0 n 1 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION lens_type fisheye fixed varifocal changeable motor ics product dependent 0 7 The lens type of this channel fisheye Fisheye lens fixed Build in fixed focus lens varifocal Build in varifocal lens changeab...

Page 331: ...ideo streams 0 camera do not support this feature We support this parameter when the version number httpversion is equal or greater than 0310a eptz_zoomratio string 0 7 Indicate the support zoom ratio of eptz not support ePTZ We support this parameter when the version number httpversion is equal or greater than 0310a rotation boolean 0 7 Indicate current mode whether support video rotation ...

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

Page 333: ...on is equal or greater than 0309b streamcodec positive integer 0 7 Represent supported codec types of each stream This contains a list of positive integers split by comma Each one stands for a stream and the definition is as following Bit 0 Support MPEG4 Bit 1 Support MJPEG Bit 2 Support H 264 Bit 3 Support H 265 mode 0 positive integer 0 7 Indicate current video mode nmode positive integer 0 7 In...

Page 334: ...d as capability_nmediastream minresolution A list of Integer 0 7 Represent supported minimum resolution of each stream in current video mode The element number is defined as capability_nmediastream We support this parameter when the version number httpversion is equal or greater than 0304b maxframerate A list of Integer 0 7 Indicate frame rate that the video source outputs in current video mode On...

Page 335: ...nly available when mjpeg is listed in capability_videoin_codec mjpeg_maxbitrate positive integer 0 7 Maximum bitrates of MJPEG The unit is bps means MJPEG does not support bit rate control Only available when mjpeg is listed in capability_videoin_codec h264_maxframerate A list of Positive Integer and 0 7 Maximum fps that the device can encoded with H 264 on resolutions in current video mode means ...

Page 336: ...ith H 265 on resolutions in current video mode means not support One to one mapping to the resolution in resolution The element number is defined as nresolution in this group This parameter may be changed when videoin_c n _cmosfreq 50 or videoin_c n _modulation pal Ex 30 fps is changed to 25 fps 60 fps is changed to 50 fps and so on Only available when h265 is listed in capability_videoin_codec h2...

Page 337: ...ommended to use capability_videoin_c 0 n 1 _mounttype mounttype ceiling wall floor product dependent Available values are listed in capability_videoin _c 0 n 1 _mou nttype 0 7 Indicate the supported mount type not support We support this parameter when the version number httpversion is equal or greater than 0309c dintraperiod_support boolean 0 7 0 Non support Dynamic intra frame period 1 Support D...

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

Page 339: ...and floor mount resolutionW1P A list of WxH 0 7 Available resolutions of 1P mode of wall mount resolutionW1R A list of WxH 0 7 Available resolutions of 1R mode of wall mount resolutionW4R A list of WxH 0 7 Available resolutions of 4R mode of wall mount panorama_pancontrol Boolean 0 7 Indicate whether to support localdewarp panorama pan control We support this parameter when the version number http...

Page 340: ...r 1st channel bit 10 19 are the 2nd group for 2nd channel bit 20 31 are the 3rd group for 3rd channel Then the 1st bit of the group indicates 1st stream of a channel support ePTZ or not The 2nd bit of the group indicates 2nd stream of a channel support ePTZ or not and so on We support this parameter when the version number httpversion is equal or greater than 0304b wdrpro 0 1 2 0 7 Indicate this m...

Page 341: ... Indicate binning is used or not in this video mode 0 No binning 1 2x2 binning 3 3x3 binning Binning is a technology to increase light sensitivity by combining multiple pixels to one The drawback is reduced resolution We design this parameter to disclose this information nresolution positive integer 0 7 How many resolution options in this video mode resolution A list of WxH 0 7 Resolution options ...

Page 342: ...in this video mode One to one mapping to the resolution in resolution The element number is defined as nresolution in this group This parameter records the frame rate when videoin_c 0 n 1 _cmosfreq 60 or videoin_c 0 n 1 _modulation ntsc maxfps_mjpeg A list of Positive Integer and 0 7 Maximum fps which the device can encoded with MJPEG on resolutions in this video mode means not support One to one ...

Page 343: ...oin_codec maxfps_h265 A list of Positive Integer and 0 7 Maximum fps which the device can encoded with H 265 on resolutions in this video mode means not support One to one mapping to the resolution in resolution The element number is defined as nresolution in this group This parameter records the frame rate when videoin_c 0 n 1 _cmosfreq 60 or videoin_c 0 n 1 _modulation ntsc Only available when h...

Page 344: ...n the version number httpversion is equal or greater than 0311a wdrpro_mode 0 1 2 0 7 0 Non support WDR Pro 1 Support WDR Pro 2 Support WDR Pro and WDR Pro II wdrpro_strength 0 1 0 7 0 Non support tuning strength of WDR Pro 1 Support tuning strength of WDR Pro If capability_image_c 0 n 1 _wdrpro 1 this may be either 0 or 1 wdrpro_supportlevel 0 positive integer 0 7 This contains a list of positive...

Page 345: ...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 onlyonce when wdrpro is enabled wdrc is checked when wdrpro is disable wdrc is unchecked Affect API name ca...

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

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

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

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

Page 350: ...hermalsensor 0 7 Indicate sensor type rawsensor Raw sensor smartsensor Smart sensor thermalsensor Thermal sensor N A We support this parameter when the version number httpversion is equal or greater 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 se...

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

Page 352: ...s 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 i...

Page 353: ... disabled wdrpro disabled exposurelevel hidd en defaultgain fixed x or others x nonnegative integer product dependent 0 7 When exposure shutter priority mode is enabled some features may become 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 use...

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

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

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

Page 357: ...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 level 6 Description can be a nonnegative integer or string or NULL means no feature is af...

Page 358: ...ngm ode auto blc hlc product dependent 0 7 Available options for videoin_c 0 n 1 _meteringmode Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_hlcmode_s upportwindow boolean 0 7 Indicate whether to support exposure window in hlc mode Only available when capability_image_c 0 n 1 _ exposure_mode is 1 and hlc is listed in capability_image_c 0 n 1 _ exposure_winmode exposure...

Page 359: ...isabled 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 capability_image_c 0 n 1 _ exposure_mode is 1 and hlc is listed in capability_image_c 0 n 1 _ exposure_winmode We support this para...

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

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

Page 362: ...ime first stream Only available when capability_image_c 0 n 1 _ exposure_bracketing_mode is 1 We support this parameter when the version number httpversion is equal or greater than 0310a privacymask_wintype rectangle polygon 3Drectangle 0 7 The supported mask window type polygon The window is a 2D polygon shape rectangle The window is a 2D rectangle shape 3Drectangle The window is a 3D rectangle s...

Page 363: ...roduct dependent 0 7 When flickerless is enabled some features may become malfunction or be forced to a given value The affected functions are list here The format is Affect API name Policy Description 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 fixe...

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

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

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

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

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

Page 369: ... 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 Periodic condition visignal Video input signal loss recnotify Recording notification tampering Tamper detection vi Virtual input Manual trigger volala...

Page 370: ... to detect the 1st and 3rd windows set mdwin as 5 mdwin0 0 positive integer 6 6 Similar to mdwin The parameter takes effect when profile 1 of motion detection is enabled vi 0 positive integer 6 6 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 ...

Page 371: ...on Friday and Sunday set weekday as 66 begintime hh mm 6 6 Begin time of the weekly schedule endtime hh mm 6 6 End time of the weekly schedule 00 00 24 00 sets schedule as always on lowlightcondition product dependent 0 1 6 6 Switch on white light LED in low light condition 0 Do action at all times 1 Do action in low light conditions action_do_i 0 ndo 1 _ enable boolean 6 6 Enable or disable trigg...

Page 372: ...y Only available when capability_supportsd 0 action_cf_backup Boolean 6 6 Enable or disable the function that send media to SD card for backup if network is disconnected Only available when capability_supportsd 0 action_server_i 0 4 _en able boolean 6 6 Enable or disable this server action action_server_i 0 4 _m edia NULL 0 4 101 6 6 Index of the attached media 101 means Recording Notify action_se...

Page 373: ...bled is 0 action_audioclip_enable boolean 6 6 Enable disable the function the play an audio clip when an event is triggered Only avaliable when capability_audio_audioclip is 1 action_audioclip_media 0 positive integer 6 6 Indicate the source id of audioclip event notification Only avaliable when capability_audio_audioclip is 1 tampering 0 positive integer 6 6 Indicate the source channel id of tamp...

Page 374: ... Password of the user ftp_address string 128 6 6 FTP server address ftp_username string 64 6 6 Username to log in to the server ftp_passwd string 64 7 6 Password of the user ftp_port 0 65535 6 6 Port to connect to the server ftp_location string 128 6 6 Location to upload or store the media ftp_passive boolean 6 6 Enable or disable passive mode 0 disable passive mode 1 enable passive mode email_add...

Page 375: ...sswd string 64 7 6 Password of the user ns_workgroup string 64 6 6 Workgroup for network storage 7 29 1 Server Setting for Event Action of sftp Group server_i 0 4 _sftp Only available when bit 1 of capability_protocol_ftp_client is 1 PARAMETER VALUE SECURITY get set DESCRIPTION address string 128 6 6 Server address loginmode passwd publickey 6 6 authentication method passwd password authentication...

Page 376: ...loadkeytype ed25519 rsa ecdsa 6 6 The keytype used for key pair ed25519 faster to generate with higher security level some old server might not support rsa slower to generate with slightly lower security level than ed25519 ecdsa low security level publickey_passphrase_enable boolean 6 6 The private key file be encrypted or not publickey_passphrase_content string 128 7 6 The encryption passphrase 7...

Page 377: ...ndicate the source of media stream 0 means the first stream 1 means the second stream and etc 2 means the third stream and etc 3 means the fourth stream and etc snapshot_prefix string 16 6 6 Indicate the prefix of the filename media_i0 Snapshot1_ media_i1 Snapshot2_ media_i2 Snapshot3_ media_i3 Snapshot4_ media_i4 Snapshot5_ snapshot_datesuffix 0 1 6 6 Add date and time suffix to filename 1 Add da...

Page 378: ...he first stream 1 means the second stream and etc 2 means the third stream and etc 3 means the fourth stream and etc videoclip_prefix string 16 6 6 Indicate the prefix of the filename videoclip_preevent 0 capability_media_videoclip_ maxpreevent 6 6 Indicates the time for pre event recording in seconds videoclip_maxduration 1 capability_media_videoclip_ maxlength 6 6 Maximum duration of one video c...

Page 379: ...network connection enable boolean 6 6 Enable or disable this recording priority 0 1 2 6 6 Indicate the priority of this recording 0 indicates low priority 1 indicates normal priority 2 indicates high priority channel 0 capability_nvideoin 1 6 6 Indicate the source of recording channel 0 means the first channel 1 means the second channel 2 means the third channel 3 means the fourth channel We suppo...

Page 380: ... P7D it means 7 days P1DT10H it means 1 days and 10 hours The parameter takes effect when autocleanup_ maxretentiontime_recording_enabled is enabled notify boolean 6 6 0 Disable recording notification 1 Enable recording notification notifyserver 0 31 6 6 Indicate which notification server is scheduled One bit represents one application server server_i0 i4 bit0 LSB server_i0 bit1 server_i1 bit2 ser...

Page 381: ...of the weekly schedule 00 00 24 00 indicates schedule always on prefix string 16 6 6 Indicate the prefix of the filename dest cf 0 4 6 6 The destination to store the recorded data cf means local storage CF or SD card 0 means the index of the network storage cffolder Not recommended to use this string 128 6 6 Folder name foldername string 128 6 6 Folder name We support this parameter when the versi...

Page 382: ...port this parameter when the version number httpversion is equal or greater than 0314b 7 32 HTTPS Group https capability_protocol_https 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 To enable or disable secure HTTP policy Boolean 6 6 If the value is 1 it will force HTTP connection redirect to HTTPS connection method auto manual install 6 6 auto Create self signed certificate automat...

Page 383: ...w vivotek com 6 6 Common name in the certificate information validdays 0 825 6 6 Valid period for the certification 7 33 Storage Management Setting Group disk_i 0 n 1 n denotes the value of capability_storage_management_ndevice capability_storage_management_ndevice 0 PARAMETER VALUE SECURITY get set DESCRIPTION cyclic_enabled boolean 6 6 Enable cyclic storage method cyclic_reserve 10 99 6 6 The re...

Page 384: ...mmended to use this boolean 6 6 Enable automatic clean up method Expired and not locked media files will be deleted For forward compatibility reservations but only group disk_i0_autocleanup is effective Not recommended to use this Please refers autocleanup group This parameter will not be used after the version number httpversion is equal or greater than 0400a autocleanup_maxage Not recommended to...

Page 385: ... _size WxH product dependent 1 6 ROI width and height The width value must be multiples of 16 and the height value must be multiples of 8 The minimal window size is 64x64 and then resolution_W resolution_H is the value in current stream If the stream doesn t support ePTZ the permissions of this parameter must be set as 1 7 7 35 ePTZ Setting Group eptz_c 0 n 1 for n channel product capability_eptz ...

Page 386: ...an by setparam cgi 7 35 1 ePTZ Settings for Each Stream Group eptz_c 0 n 1 _s 0 m 1 for n channel product and m is the index of video stream capability_eptz 0 PARAMETER VALUE SECURITY get set DESCRIPTION patrolseq string 120 1 4 The patrol sequence of ePTZ All the patrol position indexes will be separated by patroldwelling string 160 1 4 The dwelling time unit second of each patrol point separated...

Page 387: ...r disable the window win_i0_home W H product dependent 4 4 Left top corner coordinate of the window If the minimal window size is 192x144 then the win_i0_home 0 resolution_W 192 0 resolution_H 144 resolution_W and resolution_H based on capability_image_ c 0 n 1 _focuswindow_range win_i0_size WxH product dependent 4 4 Width and height of the window The minimal window size is 192x144 and resolution_...

Page 388: ...imum number of connected seamless streaming We replace this parameter with seamlessrecording_c 0 n 1 _maxconnecti on when the version number httpversion is equal or greater than 0312a We do not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a enable boolean 1 7 Indicate whether seamless recording i...

Page 389: ...n is equal or greater than 0400a guid 0 2 _number 0 3 1 7 Number of connected seamless streaming with guid 0 k 1 _id Read only We replace this parameter with seamlessrecording_c 0 n 1 _guid 0 2 _n umber when the version number httpversion is equal or greater than 0312a We do not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion i...

Page 390: ...ndicate whether seamless recording is recording to local storage or not at present Read only We support this parameter when the version number httpversion is equal or greater than 0312a guid 0 k 1 _id string 127 1 7 The connected seamless streaming ID Read only k denotes the value of seamlessrecording_c 0 n 1 _maxco nnection We support this parameter when the version number httpversion is equal or...

Page 391: ...ze for uploading VADP modules module_number 0 positive integer 6 7 Record the total module number that already stored in the system module_order string 40 6 6 The execution order of the enabled modules module_save2sd boolean 6 6 Indicate if the module should be saved to SD card when user want to upload it If the value is false save module to the internal storage space and it will occupy storage si...

Page 392: ...dp_npackage NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Indicate if the module is enabled or not If yes also add the index of this module to the module_order name string 40 6 6 Module name extendedname string 40 6 6 Extended module name If this value is not blank it will be shown on the VADP UI first instead of vadp_module_i n _name url string 120 6 6 Define the URL string after the...

Page 393: ...es the value of capability_vadp_npackage Only available when capability_vadp_npackage 0 and the version number of vadp_version 1 3 2 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable or disable the schedule mode to control the execution of the VADP package begintime hh mm 6 6 Begin time of the schedule endtime hh mm 6 6 End time of the schedule 7 38 4 VADP Event Settings Group va...

Page 394: ...d focusspeed 5 5 1 4 Auto focus speed patrolseq string 120 1 4 For external device The indexes of patrol points separated by patroldwelling string 160 1 4 For external device The dwelling time of each patrol point separated by only available when capability_camctrl_c0_rs485 2 preset_i 0 k 1 _nam e string 40 1 4 Name of the preset location preset_i 0 k 1 _ dwelling 0 999 1 4 The dwelling time of ea...

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

Page 396: ...mands with UART tunnel only available when capability_camctrl_c0_rs485 2 preset_i 0 k 1 _name string 40 1 4 Name of the preset location preset_i 0 k 1 _zoom capability_ptz_ c 0 n 1 _min zoom capability_ptz_ c 0 n 1 _ma xzoom 1 4 Zoom position at each preset location preset_i 0 k 1 _focus capability_ptz_ c 0 n 1 _min focus capability_ptz_ c 0 n 1 _ma xfocus 1 4 Focus position at each preset locatio...

Page 397: ...lean 1 4 Disable motion detection on PTZ operation defaulthome boolean 1 4 This field tells system to use default home position or not axisz capability_ptz_ c 0 n 1 _min zoom capability_ptz_ c 0 n 1 _ma xzoom 1 4 Custom home zoom position axisf capability_ptz_ c 0 n 1 _min focus capability_ptz_ c 0 n 1 _ma xfocus 1 4 Custom home focus position digitalzoom boolean 1 4 Enable disable digital zoom zo...

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

Page 399: ...lity_ptz_c 0 n 1 _minzoom capability_ptz_c 0 n 1 _maxzoom 1 4 Zoom position at each preset location preset_i 0 k 1 _focus capability_ptz_c 0 n 1 _minfocus capability_ptz_c 0 n 1 _maxfocus 1 4 Focus position at each preset location preset_i 0 k 1 _focus setting sync fixcurrent 1 4 The focus mode of each preset which is essential and should be grouped with preset_i 0 k 1 _name We support this parame...

Page 400: ...ion axisf capability_ptz_c 0 n 1 _minfocus capability_ptz_c 0 n 1 _maxfocus 1 4 Custom home focus position axisflip boolean 1 4 Custom home flip side returnhome boolean 1 4 Enable disable return home while idle returnhomeinterval 1 999 1 4 While idle over this time interval idle action will be taken digitalzoom boolean 1 4 Enable disable digital zoom idleaction_enable boolean 1 4 Enable disable id...

Page 401: ...rection the preset tour goes forward preset tour goes in forward order backward preset tour goes in backward order random the presets of the tour will be recalled randomly Only available when capability_presettourdirection is 1 We support this parameter when the version number httpversion is equal or greater than 0307a tour_i 0 19 _checklist string 512 1 4 The indexes of preset positions separated...

Page 402: ...200 38 400 57600 115200 4 4 Set baud rate of COM port databit 5 6 7 8 4 4 Data bits in a character frame paritybit none odd even 4 4 For error checking stopbit 1 2 4 4 1 One stop bit is transmitted to indicate the end of a byte 2 Two stop bits are transmitted to indicate the end of a byte If you want to transfer the stopbit for 150 of the normal time used to transfer one bit the uart_i 0 n 1 _stop...

Page 403: ... of capability_ptzenabled is 0 the bit4 of capability_ptzenabled is 1 NAME VALUE SECURITY get set DESCRIPTION cameraid 1 255 4 4 Camera ID controlling external PTZ camera Note Please set your speed dome to the appropriate baud rate and Camera ID e g 2400bps camera ID 1 2 3 etc All Camera IDs on the same controlling system NVR or rs485 keyboard have to be distinct Therefore once you send a controll...

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

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

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

Page 407: ... The minimum height of tracking target sensitivity 0 2 1 4 Tracking sensitivity 0 Low 1 Medium 2 High 7 49 Wireless Group wireless capability_network_wireless 0 PARAMETER VALUE SECURITY get set DESCRIPTION ssid string 32 6 6 SSID for wireless lan settings wlmode Infra Adhoc 6 6 Wireless mode Infra Infrastructure channel 1 11 or 1 13 or 10 11 or 10 13 or 1 14 6 6 A list of WLAN channels Countries a...

Page 408: ...n wireless_encrypt is wep keyselect 1 4 6 6 Default key number Only valid when wireless_encrypt is wep key1 password 26 6 6 WEP key1 for encryption Only valid when wireless_encrypt is wep key2 password 26 6 6 WEP key2 for encryption Only valid when wireless_encrypt is wep key3 password 26 6 6 WEP key3 for encryption Only valid when wireless_encrypt is wep key4 password 26 6 6 WEP key4 for encrypti...

Page 409: ...ity_media_streamprofiles_num capability_media_streamprofiles_support 1 PARAMETER VALUE SECURITY get set DESCRIPTION profilename string 1 6 Friendly name of the profile token string 1 7 An unique identifier of the profile fixed boolean 1 7 The value indicates whether the profile can be deleted or not Ex fixed 1 indicates the profile cannot be deleted occupied boolean 1 6 Indicates the action of cre...

Page 410: ...le when capability_naudioin 0 audioconfiguration_so urce c 0 n 1 s0 n denotes the value of capability_naudioin 1 6 The audioconfiguration source for the profile Ex audioconfiguration_source c 0 n 1 s0 indicates audio stream of channel n and stream 1 is selected for the profile Only available when capability_naudioin 0 metadataconfiguratio n_enable boolean 1 6 To enable the selected metadataconfigu...

Page 411: ...ia_streamprofiles_support 1 n denotes the value of capability_nvideoin NAME VALUE SECURITY get set DESCRIPTION ipaddress ip address 4 4 Multicast metadata IP address port 1025 65535 4 4 Multicast metadata port ipversion IPv4 IPv6 4 4 The version of internet protocol ttl 1 255 4 4 Multicast metadata time to live value ...

Page 412: ... means inactive or normal state while 1 means active or triggered state Where trigger time is reset time after state change Ex do1 1 Setting digital output 1 to trigger state Ex do1 0 30 Setting digital output 1 to normal state waiting 30 seconds setting it to trigger state Example Drive the digital output 1 to triggered state reset do0 after 20 seconds and redirect to an empty page http myserver ...

Page 413: ...http myserver cgi bin dido getdi cgi di1 Response HTTP 1 0 200 OK r n Content Type text plain r n Content Length 7 r n r n di1 1 r n 8 3Query Status of the Digital Output capability_ndo 0 Note This request requires Viewer privileges Method GET POST Syntax http servername cgi bin dido getdo cgi do0 do1 do2 do3 If no parameter is specified all the digital output statuses will be returned Return HTTP...

Page 414: ...ET POST Syntax http servername cgi bin viewer video jpg channel value resolution value quality value streamid value If the request contains invalid parameters a full FOV snapshot will return PARAMETER VALUE DESCRIPTION channel 0 capability_nvideoin 1 The channel number of the video source Default 0 resolution Available options are list in capability_videoin_c 0 n 1 _resolution Besides available op...

Page 415: ... n binary JPEG image data 8 5Account Management Note This request requires Administrator privileges Method POST Syntax http servername cgi bin admin editaccount cgi method value username name userpass value privilege value return return page PARAMETER VALUE DESCRIPTION method add Add an account to the server When using this method the username field is necessary It will use the default value of ot...

Page 416: ...ed The return page should be the relative path according to the root of camera If you omit this parameter it will redirect to an empty page If the return page is invalid path it will ignore this parameter Note 1 Rules of password settings is defined by layout_defaultpassword group Example Request http myserver cgi bin admin editaccount cgi method add username test userpass 123 privi lege view Resp...

Page 417: ... 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 return page if indicated ...

Page 418: ...n or videosize speedpan value speedtilt value speedzoom value speedapp value Set speeds return return page Example http myserver cgi bin camctrl eCamCtrl cgi channel 0 stream 0 move right http myserver cgi bin camctrl eCamCtrl cgi channel 0 stream 1 vx 2 vy 2 vz 2 http myserver cgi bin camctrl eCamCtrl cgi channel 0 stream 1 x 100 y 100 videosize 640x480 resolution 640x480 stretch 0 In zoom operat...

Page 419: ...nt w h is the scaled area size resolution is the base range of this coordinate system The example shows w h 864 488 which means to zoom in to ratio x2 2 based on 1920x1080 Pay attention to that x y w h are essential parameters in an area zoom case and the stream index is counted from 0 as the first stream http IPAddr cgi bin camctrl eCamCtrl cgi channel 0 stream 0 x 912 y 297 w 864 h 488 r esoluti...

Page 420: ...ndow size The size of plug in ActiveX window in web page resolution window size The resolution of streaming stretch boolean 0 indicates that it usesresolution streaming size as the range of the coordinate system 1 indicates that it usesvideosize plug in size as the range of the coordinate system speedpan 5 5 Set the pan speed speedtilt 5 5 Set the tilt speed speedzoom 5 5 Set the zoom speed speeda...

Page 421: ...positions to recall return return page Redirect to the page return page after the parameter is assigned The return page should be the relative path according to the root of camera If you omit this parameter it will redirect to an empty page If the return page is invalid path it will ignore this parameter 8 9ePTZ Preset Locations capability_eptz 0 and capability_fisheye 0 Note This request requires...

Page 422: ...t http servername cgi bin admin ipfilter cgi type value http servername cgi bin admin ipfilter cgi method add v4 v6 ip ipaddress index val ue return return page http servername cgi bin admin ipfilter cgi method del v4 v6 index value return retu rn page PARAMETER VALUE DESCRIPTION type NULL Get IP filter type allow deny Set IP filter type method addv4 Add IPv4 address into access list addv6 Add IPv...

Page 423: ...m 1972 00 00 00 GMT User must use GET and POST to establish two channels for downstream and upstream The x sessioncookie in GET and POST should be the same to be recognized as a pair for one session The contents of upstream should be base64 encoded to be able to pass through a proxy server This channel will help to transfer the raw data of UART over the network Please see UART tunnel spec for deta...

Page 424: ... to be recognized as a pair for one session The contents of upstream should be base64 encoded to be able to pass through the proxy server This channel will help perform real time event subscription and notification as well as camera control more efficiently The event and control formats are described in another document See Event control tunnel spec for detail information 8 13 Get SDP of Streams N...

Page 425: ...ream Note This request requires Viewer access privileges Syntax For HTTP push server MJPEG http servername network_http_s 0 m 1 _accessname For RTSP MP4 the user needs to input theURL below into an RTSP compatible player rtsp servername network_rtsp_s 0 m 1 _accessname m is the stream number For details on streaming protocol please refer to the control signaling and data format documents 8 15 Send...

Page 426: ...adecimal data is digits from 0 9 A F 8 16 Storage Managements capability_storage_dbenabled 0 Method GET and POST Note This request requires administrator privileges In the past time all the recorded files could be searched updated deleted independently However this implementation provides no abstraction of recorded video clips and which is not easy to use Thus edge storage API try to provide a hig...

Page 427: ...lue with single quotes Ex destPath mnt auto CF NCMF abc mp4 resolution text Optional Indicate the media file resolution Please embrace your input value with single quotes Ex resolution 800x600 isLocked boolean Optional Indicate if the file is locked or not 0 file is not locked 1 file is locked A locked file would not be removed from UI or cyclic storage triggerTime text Optional Indicate the event...

Page 428: ... 00 00 00 and 2008 01 01 23 59 59 http servername cgi bin admin lsctrl cgi cmd search triggerType motion OR di OR seq triggerTime 2008 01 01 00 00 00 TO 2008 01 01 23 59 59 Command queryStatus PARAMETER VALUE DESCRIPTION retType xml or javascript Optional Ex retype javascript The default return message is in XML format Ex Query local storage status and call for javascript format return message htt...

Page 429: ...parameter it will redirect to an empty page If the return page is invalid path it will ignore this parameter Return Code Description 200 The request is successfully executed 400 The request cannot be assigned ex incorrect parameters Examples setvi cgi vi0 0 10000 1 15000 0 20000 1 No multiple duration setvi cgi vi3 0 VI index is out of range setvi cgi vi 1 No VI index is specified 503 The resource...

Page 430: ...ormal 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 tsmode must exactly match well defined wording normal adaptive unknown parameters are always ignored reftime mm ss The time camera receives the ...

Page 431: ...cgi bin admin remotefocus cgi channel value function value direct ion value position value steps value iris PARAMETER VALUE DESCRIPTION channel 0 capability_nvideoin 1 Channel of the video source function zoom focus auto scan stop positioning irisopen irisenable zoom Move focus motor focus Move focus motor auto Perform auto focus scan Perform focus scan stop Stop current operation positioning Posi...

Page 432: ...ocus_zoom_motor_end or remote_focus_focus_motor_end replied from function getstatus steps 1 30 Motor s moving steps It works only if function zoom or function focus and direction forward and direction backward Motor will stop when it reaches to motor_start or motor_end This parameter is for additional fine tune the value is from 1 to 30 iris N A Open iris or not It works only if function auto or f...

Page 433: ...otor 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 service 1 zooming 2 focusing 3 auto focus 4 focus scan 5 positioning both zoom motor and focus motor 12 reset f...

Page 434: ...r s moving direction It works only if function focus position motor_start motor_end Motor s position It works only if function focus and direction direct motor_start remote_focus_zoom_motor_start or remote_focus_focus_motor_start motor_end remote_focus_zoom_motor_end or remote_focus_focus_motor_end replied from function getstatus steps 1 30 Motor s moving steps It works only if function focus and ...

Page 435: ...en The current status of iris 0 irisenable 1 irisopen Current function of zoom focus motor return value as below 0 no service 1 zooming 2 focusing 3 auto focus 4 focus scan 5 positioning both zoom motor and focus motor 12 reset focus 8 21 Export Files Note This request requires Administrator privileges Method GET Syntax For daylight saving time configuration file This CGI is not supported when the...

Page 436: ...or daylight saving time configuration file This CGI is not supported when the version number httpversion is equal or greater than 0314b please use system_tz as a replacement http servername cgi bin admin upload_dst cgi Post data filename file name r n r n multipart encoded form data For language file http servername cgi bin admin upload_lan cgi Post data filename file name r n r n multipart encode...

Page 437: ...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 choose another lens configuration For choose selected lens configuration and reboot camera http servername cgi bin admin update_lens cgi choose_reboot_lens value The camera will reboot after using this cgi For delete se...

Page 438: ...mod sdp stime value etime value length value loctime value file value tsmode value PARAMETER VALUE DEFAULT DESCRIPTION stime YYYYMMDD_HHMMSS MMM N A Start time etime YYYYMMDD_HHMMSS MMM N A End time length positive integer N A The length of media of interest The unit is second loctime boolean 0 Specify if start end time is local time format 1 for local time 0 for UTC 0 file string N A The media fi...

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

Page 440: ... privacy mask edit Edit a 3D privacy mask maskname string 40 3D privacy mask name maskheight integer 3D privacy mask height maskwidth integer 3D privacy mask width videosize window size Optimal The size of plug in ActiveX window in web page is the size of the privacy window size This field is not necessary it will use the default value if not specified 320x180 for 16 9 resolution and 320x240 for 4...

Page 441: ...ination x y based on resolution or videosize speedpan value speedtilt value speedzoom value speedapp value speedl ink value Set speeds return return page Example http myserver cgi bin camctrl camctrl cgi channel 0 camid 1 move right http myserver cgi bin camctrl camctrl cgi channel 0 camid 1 zoom tele http myserver cgi bin camctrl camctrl cgi channel 0 camid 1 x 300 y 200 resolution 704x 480 video...

Page 442: ... view or further view with zs speed used for joystick control zs 0 8 SD8362 Set the speed of zooming 0 means stop vx integer excluding 0 The slope of movement vy vx used for joystick control vy integer vs 0 127 Set the speed of movement 0 means stop x integer x coordinate clicked by user It will be the x coordinate of center after movement y integer y coordinate clicked by user It will be the y co...

Page 443: ...support this function when the version number of the PTZ control module is equal or greater than 5 0 0 20 Syntax for query API http servername cgi bin camctrl camctrl cgi parameter parameter Example http myserver cgi bin camctrl camctrl cgi getpan Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n pan 4117 r n PARAMETER VALUE DESCRIPTION getversion string Get the versi...

Page 444: ...aximum speed level of pan tilt moving Only available when capability_camctrl_c 0 n 1 _buildinpt 0 getmaxzspeedlv 0 positive integer Get the maximum speed level of zoom moving getmaxfspeedlv 0 positive integer Get the maximum speed level of focus moving getminpan 0 positive integer Get the lower limit for pan position Only available when bit0 of capability_camctrl_c 0 n 1 _buildinpt is 1 getmaxpan ...

Page 445: ...position getmaxratio decimal Get the maximum ratio of optical zoom We support this parameter when the version number getversion is equal or greater than 5 0 0 14 getmaxdratio decimal Get the maximum ratio of digital zoom We support this parameter when the version number getversion is equal or greater than 5 0 0 14 getminfocus 0 positive integer Get the lower limit for focus position getmaxfocus 0 ...

Page 446: ...list channel 0 capability_nvideoin 1 Channel of the video source delpos string 30 Delete preset location from preset list return return page Redirect to the page return page after the parameter is assigned The return page should be the relative path according to the root of camera If you omit this parameter it will redirect to an empty page If the return page is invalid path it will ignore this pa...

Page 447: ...ended to be replaced if the percentage reaches above 90 smartsd_spare_block_rate Usage rate of spare blocks It means the usage percentage of total spare block The range is from 0 to 100 unit The SD card is recommended to be replaced if the percentage reaches above 90 smartsd_data_size_per_unit Size in sectors of data to be written when Life Information1 is updated smartsd_num_of_sudden_power_failu...

Page 448: ...res Administrator privileges Method GET POST Syntax http servername cgi bin admin getwirelessinfo cgi PARAMETER VALUE DESCRIPTION N A N A Get wireless information Camera will return following information 1 Wireless channel 2 Link quality 3 Signal level 4 Noise level 5 SNR 6 TX Rate 7 RX Rate 8 32 Get Wireless Signal Strength capability_network_wireless 0 Note This request requires Administrator pr...

Page 449: ...heral Control capability_peripheral_c 0 n 1 _ devicecontrol 0 Note This request requires Administrator privileges Method GET POST Syntax for control API http servername cgi bin admin peripheral cgi channel value operation set washer_mode value Set washer mode washer_status value Set washer status washer_dwelltime value Set washer clean time heater_status value Set heater status Example http myserv...

Page 450: ...the time when spraying and wiper actions take place heater_status auto automatic control the heater component to keep the device in a workable environment trigger heater component is work in force heater once Syntax for query API http servername cgi bin admin peripheral cgi channel value operation get supportdevice Get support peripheral device washer_supportmode Get washer support modes washer_mo...

Page 451: ...tus N A Get the current status of washer control module The status is off as default which means the washer is stopped and the status on means the washer is running washer_dwelltime N A Get the current washer clean period of washer control system heater_supportstatus N A Get the support status of heater control system heater_status N A Get the current heater status Normally it will be auto it mean...

Page 452: ...time only getstatus Information of optimized IR control status and return value as below optimizedir_c 0 n 1 _irmode Indicate the IR current mode available value is auto and manual mode optimizedir_c 0 n 1 _irnum The number of IR that camera supports optimizedir_c 0 n 1 _irstrength Only available when irmode is set as manual It s a set of integers which indicate the strength of each IR LED e g 23 ...

Page 453: ...nnel 0 capability_nvideoin 1 Channel of the video source operation set settoall set set the strength of each IR LED separately settoall use fixed strength for all IR LED irmode auto manual Irmode needs to be set as manual for adjusting IR LED strength strength 1 100 If the operation is set as set the number of strength values need to be the same as it of irnum However it needs only one value for s...

Page 454: ...imizedir_c0_irmode manual Example http myserver cgi bin admin optimizedir cgi channel 0 operation set irmode auto strength 50 70 50 50 50 Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n ERROR Parameter irmode must be set as manual Example http myserver cgi bin admin optimizedir cgi channel 0 operation set strength 50 70 50 50 50 Response HTTP 1 0 200 OK r n Cache co...

Page 455: ...irnum N A Get the number of IR that camera supports Example http myserver cgi bin admin optimizedir cgi channel 0 operation get irmode Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n optimizedir_c0_irmode auto 8 36 Lens Thermal Control capabiltiy_image_c 0 n 1 _sensortype thermalsensor Note This request requires Administrator privileges Method GET POST Syntax for co...

Page 456: ... bin admin thermalctrl cgi operation set action shuttercompensate Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n ERROR fail PARAMETER VALUE DESCRIPTION action shuttercompensate Camera will do shutter compensate Syntax for query API http servername cgi bin admin thermalctrl cgi operation get version value PARAMETER VALUE DESCRIPTION version N A Indicate lensctrl the...

Page 457: ...recording Stop an ongoing recording play Play an audio clip stopplayback Stop to playback of an audio clip remove Delete a clip download Download a clip to the client Recording time is limited to 60 seconds name string Name of the audio clip The audio clip the action applies to We support two interfaces name or index to specify the media clip to be played index 0 1 Number of the audio clip The aud...

Page 458: ...ue we will use the default value PARAMETER VALUE DESCRIPTION operation Set Set formatting parameters and start formatting fstype fat32 ext4 fat32 High compatibility for PC but low stability for Data ext4 Low compatibility for PC but high stability for Data fullformat 0 1 1 Completely clean data fat32 support only blockingmo de blocking blocking Send an HTTP response at the end of the format nonblo...

Page 459: ...blocking mode Example Request of get formatting progress 0 100 http myserver cgi bin admin format_sdcard cgi operation get Response of success HTTP 1 1 200 OK r n Content Type text plain r n Content Length Success Message Length r n r n Success Message List of success message 0 100 and 100 represents formatting completed List of error message ERROR You cannot format an SD card repeatedly ERROR For...

Page 460: ...ue identifier for each profile x is within 0 capability_media_streamprofiles_num 1 port is the rtsp port Please refer to the streamprofile group for requesting the stream profile token value for each profile PARAMETER VALUE DESCRIPTION pimssm 1 1 Enable the feature of Protocol Independent Multicast Source Specific Multicast This field is only required when using PIM SSM feature Only valid when net...

Page 461: ...st information via HTTP PARAMETER VALUE DESCRIPTION pimssm 1 1 Enable the feature of Protocol Independent Multicast Source Specific Multicast This field is only required when using PIM SSM feature Only valid when network_rtsp_pimssm_enable 1 Note 1 This method is only valid when always multicast is enabled i e streamprofile_i x _alwaysmulticast 1 2 If the requested certain streamprofile_i x _profi...

Page 462: ...ultipart form data HTTP headers with its name parameter or name uploadKeyFile will be describing the request body see examples below Required when operation manualmode address sftp server address or hostname sftp server address or hostname This field is required port sftp port sftp port index 0 4 Event setting server index This field is required username string 64 Sftp server username This field i...

Page 463: ...a low security level A keytype will be automatically selected if the parameter is not provided The selected order will be ed25519 rsa ecdsa until successful pairing an error message will return if all keytype failed Required when operation download Example of download key Request http servername cgi bin admin sftpclient cgi operation manualmode key download index 1 address ip username xxx fingerpr...

Page 464: ... 7e1309282ed0f1a Accept Encoding gzip deflate Host 172 16 219 217 Content Length 6123 Connection Keep Alive Pragma no cache Cookie webptzmode continuous activatedmode digital g_mode 1 viewsizemode Auto 4x3 false lan 8 Authorization Basic cm9vdDpGREQwMDAwMA 7e1309282ed0f1a Content Disposition form data name parameter operation manualmode key upload index 1 7e1309282ed0f1a Content Disposition form d...

Page 465: ... Pm9IM6OJPDy Netcu6YEl3ULa6XHkYldqezJDnUfCBHe3OKjhue2FTBRmM2 j9Zl DkUrO7lQz7X88T w5 rI2OnDIm3szOhzMCYPtHxf8ygMKXI DKp3OR2 cu6ayGhb DezpoSyTjL1fTFINQAymDtP5tbomfESjFDW1fmfD9h1FivqYEy7017djPWrq8mjH N6nAhlaLVVuTVJ xxaJAzYiQwMdwWY8SGUq062ksDvfixYCQfhXUd629oEX82fJU 8OxF8CM0WEHFCIotJVbFjDyT5lP4qln5EMeMlPE8jrmUKEEV AJw9AbaqvCYUNaH EVZ7nlYjrnQqMCktYlO Um8vSiVsOaMFLUdiYJwj2pzyceTzyW19 KEo 8ufOFD LaSp5EGH6l...

Page 466: ...lable when bit 1 of capability_protocol_ftp_server is 1 Syntax for control API http servername cgi bin admin sftpserver cgi operation value PARAMETER VALUE DESCRIPTION operation updatehostkey updatehostkey Re generate host key for SFTP server It might take several seconds to generate key you can use gethostkey after key is generated This field is required Example of re generate host key Request ht...

Page 467: ...r This field is required If updatehostkey is not yet finished you will receive error message Example of get host key Request http servername cgi bin admin sftpserver cgi operation gethostkey Response of success HTTP 1 1 200 OK r n Content Type text plain r n Content Length Success Message Length r n r n MD5 a5 8a 7d e2 2a f8 c9 a0 ee 93 93 b8 0a 7a 18 97 RSA MD5 7a f4 07 48 e3 70 d5 89 15 36 6f d5...

Page 468: ...iewing for up to 10 clients Protocols IPv4 IPv6 TCP IP HTTP HTTPS UPnP RTSP RTP RTCP IGMP SMTP FTP DHCP NTP DNS DDNS PPPoE CoS QoS SNMP 802 1X NTCIP ARP SSL TLS ICMP Interface 10 Base T 100 BaseTX 1000 BaseTX Ethernet RJ 45 It is highly recommended to use standard CAT5e CAT6 cables which are compliant with the 3P ETL standard ONVIF Supported specification available at www onvif org Intelligent Vid...

Page 469: ... 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 819303 IT PAT 819303 JP PAT APP 8 529817 NL PAT 819303 SE PAT 819303 US PAT 5664053 THE LIST MAY BE UPDATED FROM TIME TO TIME BY LICENSORS AND A ...

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

Search results

Summary of Contents for SD9161-H

Reviews:

Related manuals for SD9161-H

Brands by name

Popular brands

Vivotek SD9161-H, User Manual

Search results

Summary of Contents for SD9161-H

Reviews:

Related manuals for SD9161-H

Brands by name

Popular brands