manualshive.com logo in svg

DELTA GROUP Vivotek FD9189-H-V2, User Manual

The user manual for the advanced DELTA GROUP Vivotek FD9189-H-V2 camera can be easily downloaded for free from manualshive.com. Gain a comprehensive understanding of this cutting-edge product with detailed instructions and features, ensuring a seamless experience while enhancing your security system setup.

Share
Download
background image

 

 

VIVOTEK

 

204 - User's Manual

 

 

 

 

© 2020 VIVOTEK INC. All Right Reserved 

61 

NAME 

VALUE 

SECURITY(
get/set) 

DESCRIPTION 

* Only available when "rbgain" is 
listed in 
"capability_image_c<0~(n-1)>_wbmo
de". 
* Only valid when 
"videoin_c<0~(n-1)>_whitebalance" !
= auto 
* Normalized range. 

exposurelevel  0~12 

4/4 

Exposure level 
"0,12": This range takes the concept 
from DC's exposure tuning options. 
The definition is: 
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 fit the 
exposure level. 

"shutterpriority"

: Manually adjust 

with variable Shutter Speed, and keep 
adjusting Iris, Gain automatically. 

"irispriority"

: Manually adjust with 

Summary of Contents for Vivotek FD9189-H-V2

Page 1: ...User s Manual 5MP Indoor Outdoor IP66 Day Night Seamless Recording WDR Pro Smart Stream III Fixed Dome Network Camera FD9389 EHV EHTV v2 FD9189 H HT v2 Rev 1 0 ...

Page 2: ...tware 45 Main Page 46 Client Settings 51 Configuration 56 System General settings 57 System Homepage layout 60 System Logs 63 System Parameters 66 System Maintenance 67 Media Image 70 Media Video 85 Media Video 87 Media Audio 96 Media profiles 97 Network General settings 98 Network Streaming protocols 105 Network SNMP Simple Network Management Protocol 114 Network FTP 115 Bonjour 116 Security User...

Page 3: ...a comes with seamless recording that allows recording to the SD card when the network connection is down When the network connection is restored the recorded video will be retrieved from SD card to your NVR or VAST recording station IMPORTANT The equipment comes with a RTC battery Note the following High or low extreme temperatures that a battery can be subjected to during use storage or transport...

Page 4: ...d for various applications including video sharing general security surveillance etc The Configuration chapter suggests ways to best utilize the Network Camera and ensure proper operations For creative and professional developers the URL Commands of the Network Camera section serves as a helpful reference to customizing existing homepages or integrating with the current web server Revision History...

Page 5: ...amera is only to be connected to PoE networks without routing to outside plants 2 For PoE connection use only UL listed I T E with PoE output 1 La caméra ne doit être raccordée qu à des ré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 U...

Page 6: ...VIVOTEK 6 User s Manual Dome cover Outer View Inner View Physical Description Lens IR LED Microphone MicroSD card slot Reset button FD9189 v2 ...

Page 7: ...45 Ethernet connector Some of the suffix syntax used in model naming are listed below E w heater for extreme weather Fx Focal length w number T w Remote focus lens R w PoE repeater H w High Dynamic Range functionality NOTE LEDs ...

Page 8: ...VIVOTEK 8 User s Manual Outer View FD9389 v2 RJ45 Ethernet socket Tilt retention screw Microphone Dome cover ...

Page 9: ...VIVOTEK User s Manual 9 Lens IR LEDs Reset button MicroSD card slot LEDst ...

Page 10: ...VIVOTEK 10 User s Manual Hardware Installation FD9189 2 0002D10766AD XXXXXX 1 Jot down the camera s MAC address for later reference 2 Open the top cover by loosening the T10 anti tamper screws ...

Page 11: ...1 64GB 10 I 1 3 Install a MicroSD card if onboard storage is preferred Remove the protective foam pad 4 Use the alignment sticker to drill mounting holes on the wall or ceiling Drill a cabling routing hole if preferred Ø 4mm ...

Page 12: ... Route an Ethernet cable through the cabling hole Secure the camera to wall or ceiling OR 5 You can use the side routing tab to route the cable along the wall or use the knock out tab at the base plate if routing through a hole ...

Page 13: ...VIVOTEK User s Manual 13 7 Connect the Ethernet cable to the RJ45 socket ...

Page 14: ...s website to Install the Shepherd software utility The program will search for VIVOTEK Video Receivers Video Servers or Network Cameras on the same LAN Double click on the camera s MAC address to open a web console to the camera Browser LAN Shepherd ...

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

Page 16: ...armful interference and 2 this device must accept any interference received including interference that may cause undesired operation Pat 6 930 709 MAC 0002D1730202 Ro HS 9 3 The program will search for all VIVOTEK network devices on the same LAN 9 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 ...

Page 17: ...iguration for security concerns 10 1 Since your camera is used for the first time there is no password Enter root as the user name and nothting for the password 10 2 Enter the combination of alphabetic and numeric characters to fulfill the password strength requirement The default name for the camera administrator is root and can not be changed ...

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

Page 19: ...iew on your computer rotate pan or tilt the camera until you acquire an optimal field of view 1 3 2 350 350 80 Configuration Media Image Focus FD9189 HT v2 1 2 For a model that comes with a remote focus lens use the automatic focusing function ...

Page 20: ...VIVOTEK 20 User s Manual 12 Install the dome cover 13 Remove the protective sheet from the dome cover ...

Page 21: ...VIVOTEK User s Manual 21 0002D10766AD XXXXXX 1 Jot down the camera s MAC address for later reference 2 Open the top cover by loosening the T10 anti tamper screws Hardware Installation FD9389 ...

Page 22: ...nual 3 Install a MicroSD card if onboard storage is preferred Remove the protective foam pad 4 Use the alignment sticker to drill mounting holes on the wall or ceiling Drill a cabling routing hole if preferred 64GB 10 I 1 ...

Page 23: ... s Manual 23 Max Power Consumption via PoE Model Watts Voltage Amp FD9389 EHV v2 12 3 37 57 0 33 0 21 FD9389 EHTV v2 12 3 37 57 0 33 0 21 M8X1 25 5 Pass an Ethernet cable through the included cable gland components ...

Page 24: ... 6 3mm 7 Connect all 8 unstrapped color wires into the connector using a crimping tool Make sure the cable passed through all waterproof components before you make the cable connector o O g B b G br BR 1 2 3 4 5 6 7 8 o white orange stripe O orange solid g white green stripe B blue solid b white blue stripe G green solid br white brown stripe BR brown solid M8X1 25 ...

Page 25: ...VIVOTEK User s Manual 25 11 3cm 8 The length of the cable inside the camera canister is approximately 11 3cm Tighten the waterproof components 9 Connect the Ethernet connector to the RJ45 socket ...

Page 26: ...VIVOTEK 26 User s Manual 10 Secure the camera to wall or ceiling using the included screws ...

Page 27: ... Please visit VIVOTEK s website to Install the Shepherd software utility The program will search for VIVOTEK Video Receivers Video Servers or Network Cameras on the same LAN Double click on the camera s MAC address to open a web console to the camera ...

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

Page 29: ...rmful interference and 2 this device must accept any interference received including interference that may cause undesired operation Pat 6 930 709 MAC 0002D1730202 Ro HS 12 3 The program will search for all VIVOTEK network devices on the same LAN 12 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...

Page 30: ...iguration for security concerns 13 1 Since your camera is used for the first time there is no password Enter root as the user name and nothting for the password 13 2 Enter the combination of alphabetic and numeric characters to fulfill the password strength requirement The default name for the camera administrator is root and can not be changed ...

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

Page 32: ...VIVOTEK 32 User s Manual 350 350 80 14 With a live pan or tilt the camera lens to find a best view angle Tighten the retention screws on the side to secure the shooting angle ...

Page 33: ...l 33 Configuration Media Image Focus 1 2 For a model that comes with a remote focus lens use the automatic focusing function FD9389 EHTV v2 1 2 15 Replace the desiccant bag on the camera to avoid moisture gathering inside ...

Page 34: ...nual Installation height Measured to the approx lens position Not to the ceiling If Using Smart Motion detection measure the height of the camera 16 Install the dome cover and then remove the protective sheet on the cover ...

Page 35: ...nd install again Reset Press the recessed reset button Wait for the Network Camera to reboot Restore Press and hold the reset button until the status LED rapidly blinks Note that all settings will be restored to factory default Upon successful restore the status LED will blink green and red during normal operation SD SDHC SDXC Card Capacity This network camera is compliant with SD SDHC SDXC 16GB 8...

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

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

Page 38: ...lease forward the following ports for the Network Camera on the router HTTP port default is 80 RTSP port default is 554 RTP port for video default is 5556 RTCP port for video default is 5557 If you have changed the port numbers on the Network page please open the ports accordingly on your router For information on how to forward ports on the router please refer to your router s user s manual 3 Fin...

Page 39: ... 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 the router to the camera with...

Page 40: ... on LAN If your network environment is 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 Press Enter 3 Live video will be displayed in your web browser 4 If it is the first time installing the VIVOTEK network camera an information bar will prompt as...

Page 41: ...tection please refer to Security on page 117 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 42: ...ty a 32 bit IE browser will be opened IMPORTANT 1 The onscreen Java control can malfunction under the following situations A PC con nects to different cameras that are using the same IP address or the same camera running different firmware versions Removing your browser cookies will solve this problem 2 If you encounter problems with displaying the configuration menus or UI items try dis able the ...

Page 43: ... 554 please set the RTSP port to 554 For more information please refer to RTSP Streaming on page 106 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 106 for details 1 Launch the RTSP player 2 Choose File Open URL A URL dialog box will pop up 3 The address format is rtsp ip address rts...

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

Page 45: ...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 46: ...w Camera Control Area Configuration Area Host Name Resize Buttons Profile mode 4 pre configured streaming profiles are provided through here Max view Recording view Live view and App Each mode features a different stream source channel resolution multicast and metadata configuration The profiles can be configured in Configuration Media Media profiles Manual Trigger Click to enable disable an event...

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

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

Page 49: ...ag the slider bar To move to a different area you want to magnify drag the navigation screen Pause Pause the transmission of the streaming media The button becomes the Resume button after clicking the Pause button Stop Stop the transmission of the streaming media Click the Resume button to continue transmission Start MP4 Recording Click this button to record video clips in MP4 file format to your ...

Page 50: ...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 video ...

Page 51: ...ork Camera allows up to ten simultaneous accesses UDP multicast This protocol allows multicast enabled routers to forward network packets to all clients requesting streaming media This helps to reduce the network transmission load of the Network Camera while serving multiple clients at the same time Note that to utilize this feature the Network Camera must be configured to enable multicast streami...

Page 52: ...ur local hard disk 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 Local Streaming Buffer Time In the case of encountering unsteady bandwidth live streaming may lag and video streaming may not be very smoothly If you enable this option the live streaming will be stored temporarily on your PC s cache memory for a few milli seconds...

Page 53: ...ick menu If your joystick is not detected if may be defective 2 Click Calibrate or Configure buttons to configure the joystick related settings If you want to assign Preset actions to your joystick the preset locations should be configured in advance in the Configuration PTZ page In Windows use the search function on the Start menu to search for Game Controller If your joystick is not working prop...

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

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

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

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

Page 58: ...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 59: ...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 60: ...page using the default settings Follow the steps below to upload a new logo 1 Click Custom and the Browse field will appear 2 Select a logo from your files 3 Click Upload to replace the existing logo with a new one 4 Enter a website link if necessary 5 Click Save to enable the settings Customized button If you want to hide manual trigger buttons on the homepage please uncheck this item This item i...

Page 61: ...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 62: ... you want to change the color on the right column 3 The palette window will pop up as shown below 4 Drag the slider bar and click on the left square to select a desired color 5 The selected color will be displayed in the corresponding fields and in the Preview column 6 Click Save to enable the settings 1 2 3 4 Color Selector Custom Pattern ...

Page 63: ...rver 3 When completed click Save to enable the setting You can configure the Network Camera to send the system log file to a remote server as a log backup Before utilizing this feature it is suggested that the user install a log recording tool to receive system log messages from the Network Camera An example is Kiwi Syslog Daemon Visit http www kiwisyslog com kiwi syslog daemon overview This colum...

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

Page 65: ...og is stored in the Network Camera s buffer area and will be overwritten when reaching a certain limit VADP log VADP log contains the information for the onboard VADP packages including memory usage module load and unload information Set Parameter log VADP log contains the history of changes made to system parameters such as recording imaging parameters and all other parameters ...

Page 66: ...VIVOTEK 66 User s Manual System Parameters The View Parameters page lists the entire system s parameters If you need technical assistance please provide the information listed on this page ...

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

Page 68: ...es 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 Focus position Retain the lens focus position using the previously saved position parameters If none of the options is selected all settings will be restored to factory default The following message is displayed d...

Page 69: ... report Click to export the current server status report such as time logs parameters process status memory status file system status network status kernel message and so on Tips If a firmware upgrade is accidentally disrupted say by a power outage you still have a last resort method to restore normal operation See the following for how to bring the camera back to work Applicable scenario a Power ...

Page 70: ...e live viewing window and the maximum zoom in will be up to 12 times Position of timestamp and video title on image Select to display time stamp and video title on the top or at the bottom of the video stream Timestamp and video title font size Select the font size for the time stamp and title Video font ttf You can select a True Type font file for the display of textual messages on video Color Se...

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

Page 72: ... the sensor to accept infrared light thus helping to improve low light sensitivity Synchronize with digital input If an external IR device is connected that comes with its own light sensor you can use a digital input from it to trigger the IR cut filter Doing so can synchronize the detection of light level between the camera and the external IR device Schedule mode The Network Camera switches betw...

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

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

Page 75: ...brightness level which ranges from 0 to 100 Contrast Adjust the image contrast level which ranges from 0 to 100 Saturation Adjust the image saturation level which ranges from 0 to 100 Sharpness Adjust the image sharpness level which ranges from 0 to 100 Gamma curve Adjust the image sharpness level which ranges from 0 45 to 1 from Detailed to Contrast You may let firmware Optimize your display or s...

Page 76: ...ng power 3D Noise Reduction is mostly applied in low light conditions When enabled in a low light condition with fast moving objects trails of after images may occur You may then select a lower strength level or disable the function Highlight mask Strong light sources will be masked from the scene and the image contrast will be strengthened This function is useful to prevent the spot light effects...

Page 77: ...r low light compensation For example where low light objects are posed against an extremely bright background You may want to exclude the bright sunlight shining through a building s corridor Full view Calculate the full range of view and offer appropriate light compensation Custom This option allows you to manually add customized windows as inclusive or exclusive regions A total of 10 windows can...

Page 78: ... be calculated out of the remaining of the inclusive window Include Exclude Weighted region Ignored region Include Exclude Center Use the center portion of the screen to determine the exposure level HLC Highlight Compensation Firmware detects strong light sources and compensates on affected spots to enhance the overall image quality For example the HLC helps reduce the glares produced by spotlight...

Page 79: ...e semi circular pointers on the Exposure time and Gain control slide bars to specify a range of shutter time and Gain control values within which the camera can automaticallly tune to an optimal imaging result You can also configure the iris size to control the amount of light For example you may prefer a shorter shutter time to better capture moving objects while a faster shutter reduces light an...

Page 80: ...o enable the setting and click Close to exit the page You can click Restore to recall the original settings without incorporating the changes When completed with the settings on this page click Save to enable the settings If you want to configure another sensor setting for day night schedule mode please click Profile to open the Profile of exposure settings page as shown below Activated period Sel...

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

Page 82: ...ld be displayed and the optimal focus range achieved Use the arrow marks on the sides to fine tune the focus if you are not satisfied with the results You may still need to use the arrow marks to fine tune the focus depending on the live image on your screen means moving from wide to tele end and tele to wide ...

Page 83: ...ant to delete the privacy mask window please click the x mark on the side of window name To configure privacy mask windows 1 Click New to add a new window 2 You can use 4 mouse clicks to create a new masking window which is recommended to be at least twice the size of the object height and width you want to cover 3 Enter a Window Name and click Save to enable the setting 4 Click on the Enable priv...

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

Page 85: ...tion at 5 megapixels in a 4 3 screen aspect ratio with the WDR function enabled 4 Megapixel 16 9 MAX 30fps WDR Pro This is the full resolution at 4 megapixels in a 16 9 screen aspect ratio with the WDR function enabled 1080P FULL HD 16 9 MAX 60fps At the 16 9 aspect ratio the highest frame rate can reach 60fps without the WDR function ...

Page 86: ...e default frame size for Stream 2 is set to the 1600 x 1200 Click Viewing Window to open the viewing region settings page On this page you can configure the Region of Interest and the Output Frame Size for a video stream For example you can crop only a portion of the image that is of your interest and thus save the bandwidth needed to transmit the video stream As the picture shown below the area o...

Page 87: ...for which you want to set up the viewing region 2 Select a Region of Interest from the drop down list The floating frame the same as the one in the Gloabl View window on the home page will resize accordingly If you want to set up a customized viewing region you can also resize and drag the floating frame to a desired position with your mouse 3 Choose a proper Output Frame Size from the drop down l...

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

Page 89: ... P P P P P P I P P P P P P P I Static scene Activities P P P P I P P P P P P P I P P P P P P P I By dynamically prolonging the intervals for I frames insertion to up to 10 seconds the bit rates required for streaming a video can be tremendously reduced When streaming a video of a static scene the Dynamic Intra frame feature can save up to 53 of bandwidth The amount of bandwidth thus saved is also ...

Page 90: ...mart Stream III has two more configurable options Smart Q and Smart FPS NOTE By queuing the old frames from a static scene both the computing efforts and the size of P frames are reduced It is beneficial for keeping up with the frame rate requirements A default frame difference threshold 1 is embedded in firmware for returning from Smart FPS to normal encoding when motions occur Smart FPS In a sta...

Page 91: ...s to normal when one or more objects move in that area The remainder of the screen where there are no moving objects no pixel changes will still be transmitted in low quality format Manual The Manual mode allows you to configure 3 ROI windows Region of Interest with Foreground quality on the screen Areas not included in any ROI windows will be considered as the non interested areas The details in ...

Page 92: ...al mode the non interested area is always transmitted using a low quality format regardless of the activities occurring inside You should also select the Maximum bit rate from the pull down menu as the threshold to contain the bandwidth consumption for both the high and low quality video sections in a smart stream Quality priority Use the slide bar to tune the quality contrast between the ROI and ...

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

Page 94: ...width For example in low light conditions where a Fixed quality setting is applied video packet sizes can tremendously increase when noises are produced with electrical gains You may also manually enter a bit rate number by selecting the Customized option Fixed quality On the other hand if Fixed quality is selected all frames are transmitted with the same quality bandwidth utilization is therefore...

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

Page 96: ...g message is displayed Internal microphone input gain Select the gain of the internal audio input according to ambient conditions Adjust the gain from 0 least to 100 most Audio type Select audio codec as G 711 or G 726 and the bit rate G 711 provides good sound quality and requires about 64Kbps Select pcmu μ Law or pcma A Law mode G 726 is a speech codec standard covering voice transmission at rat...

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

Page 99: ... router so that video streams can be sent out from a LAN To utilize of this feature make sure that your router supports UPnPTM and it is activated PPPoE Point to point over Ethernet Select this option to configure your Network Camera to make it accessible from anywhere as long as there is an Internet connection Note that to utilize this feature it requires an account provided by your ISP Follow th...

Page 100: ... 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 101: ...aces 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 102: ...r 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 addres...

Page 103: ... format Please refer to HTTP streaming on page 105 for detailed information If you choose PPPoE as the Network Type the PPP0 address will be displayed in the IPv6 information column as shown below Manually setup the IP address Select this option to manually set up IPv6 settings if your network environment does not have DHCPv6 server and router advertisements enabled routers If you check this item ...

Page 104: ...VIVOTEK 104 User s Manual ...

Page 105: ...following warning messages will be displayed To access the Network Camera on the LAN both the HTTP port and secondary HTTP port can be used to access the Network Camera For example when the HTTP port is set to 80 and the secondary HTTP port is set to 8080 refer to the list below for the Network Camera s IP address Access name for stream 1 3 This Network camera supports multiple streams simultaneou...

Page 106: ...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 107: ...r stream 1 to 3 For example when the access name for stream 1 is set to live1s1 sdp 1 Launch an RTSP player 2 Choose File Open URL A URL dialog box will pop up 3 Type the above URL command in the text box 4 The live video will be displayed in your player as shown below RTSP port RTP port for video audio RTCP port for video audio RTSP Real Time Streaming Protocol controls the delivery of streaming ...

Page 108: ... one and thus is always odd When the multicast RTP port changes the multicast RTCP port will change accordingly If the multicast RTP video ports are incorrectly assigned the following warning message will be displayed Multicast TTL 1 255 The multicast TTL Time To Live is the value that tells the router the range a packet can be forwarded Initial TTL Scope 0 Restricted to the same host 1 Restricted...

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

Page 110: ...that before utilizing this function please apply for a dynamic domain account first Safe100 net 1 In the DDNS column select Safe100 net from the drop down list Click I accept after reviewing the terms of the Service Agreement 2 In the Register column fill in the Host name xxxx safe100 net Email Key and Confirm Key and click Register After a host name has been successfully created a success message...

Page 111: ... Register column fill in the Host name Email Key and Confirm Key then click Register After a host name has been successfully created you will see a success message in the DDNS Registration Result column 3 Click Copy and all for the registered information will be uploaded to the corresponding fields in the DDNS column 4 Select Enable DDNS and click Save to enable the setting Forget key Click this b...

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

Page 113: ...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 114: ...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 115: ...allows the user to save recorded video clips You can utilize VIVOTEK s Shepherd utility to upgrade the firmware via FTP server By default the FTP port is set to 21 It can also be assigned to another port number between 1025 and 65535 SFTP This is the embedded SFTP client Host Key A host key is the SFTP server s public key Ensuring the SFTP server is validated is an important aspect of the SFTP pro...

Page 116: ...Discovery utility instead Find the Discovery formerly Bonjour Browser from the Mac App Store Discovery is a utility that displays all the Bonjour services on your local network or on Wide Area Bonjour domains The utility is previously called Bonjour Browser it is now distributed on the Mac App Store Discovery requires macOS 10 12 or higher For older versions of Mac OS you can download the old vers...

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

Page 118: ...the management privilege as operators or viewers Select or de select the checkboxes and then click Save to enable the settings If you give Viewers the privilege Operators will also have the ability to control the Network Camera through the main page Please refer to Configuration on page 56 ...

Page 119: ...mmunication with the Network Camera a Certificate must be created first There are three ways to create and install a certificate Create self signed certificate 1 Select this option from a pull down menu 2 In the first column select Enable HTTPS secure connection then select a connection option HTTP HTTPS or HTTPS only 3 Click Create certificate to generate a certificate 4 The Certificate Informati...

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

Page 121: ...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 122: ...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 123: ... User s Manual 123 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 124: ...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 125: ... been created and installed before you can click on the Save button for the configuration to take effect 12 To begin an encrypted HTTPS session click Home to return to the main page Change the URL address from http to https in the address bar and press Enter on your keyboard Some Security Alert dialogs will pop up Click OK or Yes to enable HTTPS ...

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

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

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

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

Page 130: ...ork Camera the supplicant and the RADIUS Server the authentication server 2 A Network Camera requests access to the protected 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 swi...

Page 131: ...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 132: ...gital PTZ Operation E PTZ Operation The e PTZ control settings section will be displayed as shown below For e PTZ related details please refer to page 134 Auto pan patrol speed Select the speed from 1 5 slow fast to set up the Auto pan patrol speed control Zoom factor display If you check this item the zoom indicator will be displayed on the home page when you zoom in out the live viewing window a...

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

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

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

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

Page 137: ...or stimulus which defines when to trigger the Network Camera The trigger source can be configured to use the Network Camera s built in motion detection mechanism or external digital input devices There are several choices of trigger sources as shown on the next page Select the item to display the detailed configuration options Video motion detection This option makes use of the built in motion det...

Page 138: ...dules before you can associatee VADP triggers with an Event setting Click on the Set VADP Trigger button to open the VADP setup menu The triggering conditions available with 3rd party software modules known as VADP will be listed Use the arrow buttons to select these triggers Users may implant these modules for different purposes such as triggering motion detection or applications related to video...

Page 139: ...nction will only be displayed after you set up a network storage NAS The media to back up can include snapshot images video or system logs depending on your event settings Configure CameraLink The camera can be associated with another camera with responsive actions For example if a thermal camera detects some abnormal situations e g a fire the camera can tell another camera say a PTZ camera to mov...

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

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

Page 142: ...e client side settings Server address Enter the SFTP server address in either the domain name or IP address Server port By default the FTP server port is set to 22 It can also be assigned to another port number between 1025 and 65535 Host key MD5 You have the option to use public private key authentication instead of a username and password to connect to the server This option requires that you ha...

Page 143: ...assword or the Public key mode When using SFTP you can authenticate using a public private SSH key pair instead of a password If key authentication is not enabled you need to specify a password instead The administrator of the SFTP server will need to manually add the corresponding public key to the SFTP server If key authentication is not preferred you can specify a username and password in the s...

Page 144: ...e and upload the public key to the SFTP server A private key is a guarded secret and it can be stored on disk in an encrypted form A passphrase is used in order to decrypt it It is a login password to the SSH server the passphrase is only used to decrypt the private key on the local system The passphrase is not transmitted over the network When using SFTP you can authenticate using a public privat...

Page 145: ...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 are correctly configured click Test The result will be shown in a pop up window as shown below If successful you will receive a test txt file on the HTTP server Click Save server to enable the settings ...

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

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

Page 148: ...pshots from any of the video profiles Send pre event images The Network Camera has a buffer to temporarily hold data up to a certain limit Enter a number to decide how many images to capture before a trigger is activated Up to 7 images can be generated Send post event images Enter a number to decide how many images to capture after a trigger is activated Up to 7 images can be generated For example...

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

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

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

Page 152: ...ions Motion detection The Smart Motion utility will be automatically started If Human detection is applied make sure you measured the height of your camera at the installation site It is important for a correct video analysis You should enter the installation height in the Motion detection Settings page Applications Motion detection NOTE Due to system resources concern the motion tracking blocks a...

Page 153: ...r to Smart VCA s user documentation for more information Click on Configuration Applications Smart VCA The Smart VCA utility will be automatically started The Smart Motion detection and Smart VCA share the same utility window If Smart VCA is applied make sure you measured the height of your camera at the installation site It is important for a correct video analysis You should enter the installati...

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

Page 155: ... 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 156: ...eo analysis for intelligent video applications such as license plate recognition object counting or as an agent for edge recording etc Once the software package is successfully uploaded the module configuration vadp xml information is displayed When uploading a module the camera will examine whether the module fits the predefined VADP requirements Please contact our technical support or the vendor...

Page 157: ...he 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 resources To utilize a software module acquire the software package and click Bro...

Page 158: ...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 159: ...Add to open the recording setting window On this page you can define the adaptive recording recording source recording schedule and recording capacity A total of 2 recording settings can be configured Recording name Enter a name for the recording setting Enable this recording Select this option to enable video recording With adaptive recording Select this option will activate the frame rate contro...

Page 160: ...iggered on Camera A will the server record the full frame rate streaming data otherwise it will only request the I frame data during normal monitoring thus effectively saves bandwidths and storage space Time Bandwidth Bandwidth Activity Adaptive Streaming for Dynamic Frame Rate Control I frame Full frame rate I frame Continuous recording To enable adaptive recording please make sure you ve set up ...

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

Page 162: ...recycled Enable cyclic recording If you check this item when the maximum capacity is reached the oldest file will be overwritten by the latest one The reserved amount is reserved for the transaction stage when the storage space is about to be full and new data arrives The minimum for the Reserved space must be larger than 15 MegaBytes Recording file management You can manually assign the Maximum d...

Page 163: ...on about folder naming rules please refer to page 146 for details 20210210 20210211 20210212 f you want to enable recording notification please click Event to configure event triggering settings Please refer to Event Event settings on page 136 for more details When completed select Enable this recording Click Save to enable the setting and click Close to exit this page When the system begins recor...

Page 164: ...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 165: ... 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 166: ...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 167: ...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 168: ...hich will highlight the selected item A Play window will appear on top for immediate review of the selected file For example Download Click on a search result to highlight the selected item in purple as shown above Then click the Download button and a file download window will pop up for you to save the file JPEGs to AVI This functions only applies to JPEG format files such as snapshots You can se...

Page 169: ...h 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 C l i c k t o switch pages ...

Page 170: ...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 171: ...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 0 to active http mywebserver cgi bi...

Page 172: ...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 173: ...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 174: ...ual 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 175: ...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 176: ... 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 177: ...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 178: ...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 179: ...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 180: ...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 181: ...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 182: ...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 183: ...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 184: ...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 185: ...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 186: ...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 187: ...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 188: ...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 189: ...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 190: ...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 191: ...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 192: ... 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 193: ...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 194: ...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 195: ...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 196: ...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 197: ...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 198: ...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 199: ...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 200: ...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 201: ...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 202: ... 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 203: ...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 204: ...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 205: ... 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 206: ...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 207: ...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 208: ...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 209: ...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 210: ...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 211: ... 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 212: ... 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 213: ...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 214: ...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 215: ...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 216: ... 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 217: ...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 218: ...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 219: ... 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 220: ...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 221: ...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 222: ...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 223: ..._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 224: ...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 225: ...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 226: ...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 227: ... 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 228: ... 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 229: ..._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 230: ...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 231: ...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 232: ...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 233: ...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 234: ...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 235: ...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 236: ...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 237: ...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 238: ...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 239: ...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 240: ...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 241: ...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 242: ...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 243: ...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 244: ...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 245: ...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 246: ...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 247: ...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 248: ...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 249: ...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 250: ...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 251: ...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 252: ...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 253: ...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 254: ...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 255: ...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 256: ...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 257: ...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 258: ...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 259: ...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 260: ...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 261: ...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 262: ...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 263: ...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 264: ... 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 265: ...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 266: ...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 267: ...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 268: ...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 269: ...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 270: ...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 271: ...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 272: ...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 273: ...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 274: ...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 275: ... 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 276: ... 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 277: ... 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 278: ...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 279: ...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 280: ...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 281: ...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 282: ...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 283: ...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 284: ...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 285: ... 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 286: ...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 287: ...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 288: ...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 289: ... 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 290: ...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 291: ...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 292: ...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 293: ...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 294: ...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 295: ... 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 296: ...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 297: ...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 298: ...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 299: ...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 300: ... 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 301: ...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 302: ...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 303: ...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 304: ...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 305: ...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 306: ...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 307: ...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 308: ...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 309: ...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 310: ...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 311: ...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 312: ...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 313: ...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 314: ...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 315: ...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 316: ...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 317: ...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 318: ... 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 319: ...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 320: ...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 321: ...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 322: ...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 323: ...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 324: ...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 325: ...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 326: ...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 327: ...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 328: ...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 329: ...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 330: ... 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 331: ...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 332: ...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 333: ...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 334: ...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 335: ...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 336: ...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 337: ...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 338: ... 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 339: ...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 340: ...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 341: ...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 342: ...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 343: ...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 344: ...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 345: ...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 346: ... 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 347: ... 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 348: ...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 349: ...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 350: ...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 351: ... 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 352: ...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 353: ...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 354: ...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 355: ...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 356: ...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 357: ... 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 358: ...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 359: ...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 360: ...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 361: ...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 362: ... _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 363: ...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 364: ...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 365: ...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 366: ...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 367: ...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 368: ...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 369: ...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 370: ...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 371: ...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 372: ...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 373: ...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 374: ...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 375: ...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 376: ...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 377: ...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 378: ...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 379: ...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 380: ... 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 381: ... 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 382: ...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 383: ...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 384: ... 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 385: ...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 386: ...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 387: ...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 388: ...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 389: ... 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 390: ...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 391: ...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 392: ... 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 393: ...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 394: ... 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 395: ...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 396: ...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 397: ...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 398: ...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 399: ...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 400: ...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 401: ... 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 402: ...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 403: ...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 404: ...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 405: ... 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 406: ...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 407: ...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 408: ...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 409: ...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 410: ...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 411: ...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 412: ...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 413: ...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 414: ...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 415: ...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 416: ...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 417: ... 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 418: ...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 419: ... 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 420: ...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 421: ...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 422: ...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 423: ...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 424: ...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 425: ...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 426: ...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 427: ...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 428: ...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 429: ...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 430: ...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 431: ...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 432: ...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 433: ... 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 434: ...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 435: ...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 436: ...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 437: ...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 438: ...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 439: ...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 440: ...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 441: ... 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 442: ... Pm9IM6OJPDy Netcu6YEl3ULa6XHkYldqezJDnUfCBHe3OKjhue2FTBRmM2 j9Zl DkUrO7lQz7X88T w5 rI2OnDIm3szOhzMCYPtHxf8ygMKXI DKp3OR2 cu6ayGhb DezpoSyTjL1fTFINQAymDtP5tbomfESjFDW1fmfD9h1FivqYEy7017djPWrq8mjH N6nAhlaLVVuTVJ xxaJAzYiQwMdwWY8SGUq062ksDvfixYCQfhXUd629oEX82fJU 8OxF8CM0WEHFCIotJVbFjDyT5lP4qln5EMeMlPE8jrmUKEEV AJw9AbaqvCYUNaH EVZ7nlYjrnQqMCktYlO Um8vSiVsOaMFLUdiYJwj2pzyceTzyW19 KEo 8ufOFD LaSp5EGH6l...

Page 443: ...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 444: ...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 445: ... Notices from HEVC Advance THIS PRODUCT IS SOLD WITH A LIMITED LICENSE AND IS AUTHORIZED TO BE USED ONLY IN CONNECTION WITH HEVC CONTENT THAT MEETS EACH OF THE THREE FOLLOWING QUALIFICATIONS 1 HEVC CONTENT ONLY FOR PERSONAL USE 2 HEVC CONTENT THAT IS NOT OFFERED FOR SALE AND 3 HEVC CONTENT THAT IS CREATED BY THE OWNER OF THE PRODUCT THIS PRODUCT MAY NOT BE USED IN CONNECTION WITH HEVC ENCODED CONT...

Page 446: ...g the equipment off and on the user is encouraged to try to correct the interference by one or more of the following measures Reorient or relocate the receiving antenna Increase the separation between the equipment and receiver Connect the equipment into an outlet on a circuit different from that to which the receiver is connected Consult the dealer or an experienced radio TV technician for help S...

Reviews:

No comments

Related manuals for Vivotek FD9189-H-V2

Ganz ZN-D100VE Quick User Manual preview
ZN-D100VE
Brand: Ganz Pages: 7
Ganz VALUE Series Instruction Manual preview
VALUE Series
Brand: Ganz Pages: 8
S&S Merlin 1500S User Manual preview
Merlin 1500S
Brand: S&S Pages: 12
Abus GBM7300W Installation Manual preview
GBM7300W
Brand: Abus Pages: 4
FLIR CB-3102 User And Installation Manual preview
CB-3102
Brand: FLIR Pages: 104
WOXTER Domotify WI-FI Camera User Manual preview
Domotify WI-FI Camera
Brand: WOXTER Pages: 65
König SAS-DUMMYCAM10 Manual preview
SAS-DUMMYCAM10
Brand: König Pages: 51
Q-See QS4088035 User Manual preview
QS4088035
Brand: Q-See Pages: 31
Seas of Solutions FastFind CREW1 User Manual preview
FastFind CREW1
Brand: Seas of Solutions Pages: 2
Falcon Eyes Digital Macro Flash DMR Instruction Manual preview
Digital Macro Flash DMR
Brand: Falcon Eyes Pages: 1
ACTi ACM-3300 Hardware User Manual preview
ACM-3300
Brand: ACTi Pages: 18
SALUPO SS101 Series Instruction And Installation Manual preview
SS101 Series
Brand: SALUPO Pages: 12
Delta AlertMaxx DMS-269 Installation & Operating Instructions Manual preview
AlertMaxx DMS-269
Brand: Delta Pages: 16
First Alert FA110C User Manual preview
FA110C
Brand: First Alert Pages: 44
Conrad 1337785 Operating Instructions Manual preview
1337785
Brand: Conrad Pages: 8
Abus IPCB54511A Installation Manual preview
IPCB54511A
Brand: Abus Pages: 24
Vivotek 4710469351747 User Manual preview
4710469351747
Brand: Vivotek Pages: 436
BZB Gear BG-EPTZ-AF User Manual preview
BG-EPTZ-AF
Brand: BZB Gear Pages: 19

Brands by name

Popular brands

Load more brands