Vivotek IT9389 Series User Manual Download

Page: 57 / 395

VIVOTEK

User's Manual - 57

PC with

VAST Recording Software

Internet

VIVOTEK Network Cameras

3G Cell phone

Cell phone

Short message

GSM

Modem

HTTP

Digital output

VIVOCloud

PTZ

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.

Summary of Contents for IT9389 Series

Page 1: ...User s Manual 5MP Outdoor IP66 IK08 Day Night Smart Motion Detection H T Remote Focus T WDR Pro Smart Stream III 30M Smart IR Shock Detection Turret Dome Camera IT9389 H IT9389 HT Rev 1 0 ...

Page 2: ...tings 51 System Homepage layout 53 System Logs 56 System Parameters 58 System Maintenance 59 Media Image 63 Media Video 76 Media Video 77 Media Video 78 Media Audio 87 Network General settings 88 Network Streaming protocols 95 Network SNMP Simple Network Management Protocol 104 Network FTP 105 Security User accounts 106 Security HTTPS Hypertext Transfer Protocol over SSL 108 Security Access List 1...

Page 3: ... in a video surveillance area Since humans are the objects of interest in the majority of video surceillance the Human detection feature enables users to quickly configure his installation With Human detection light changes or swaying vegetation vehicles passing by or animal activities in the scene are not taken as event triggers Only human activities will trigger an event This helps reduce false ...

Page 4: ...mera is installed then carefully read and follow the instructions in the Installation chapter to avoid damage due to faulty assembly and installation This also ensures the product is used properly as intended The Network Camera is a network device and its use should be straightforward for those who have basic networking knowledge It is designed for various applications including video sharing gene...

Page 5: ... cable housing T10 torx wrench Quick Installation Guide IMPORTANT 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 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...

Page 6: ...VIVOTEK 6 User s Manual Trim ring Lens IR LEDs Outer View Inner View Physical Description SD card slot Reset button Mount bracket Microphone ...

Page 7: ...using these CCA products especially when cascading PoE cameras It is a must to use Ethernet cables compliant with the 3P ETL standard IMPORTANT You should not use an RJ45 connector with a strain relief boot The camera s cable can be routed through a drilled hole or through the opening on the side of camera Observe and look for the best installation position OR ...

Page 8: ...w 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 M Manual focus lens NOTE IMPORTANT Power consumption Model Consumption Power Input IT9389 H PoE 37 57 Vdc 0 17 0 11 A IT9389 HT PoE 37 57 Vdc 0 24 0 16 A ...

Page 9: ...amera The height information is important for the accuracy of the video analytics results Some of the other perspective information are automatically collected by the onboard G sensor The height information enables the horizontal and vertical keystone corrections of the field of view Measure the distance between camera lens and the ground Installation height Measured to the approx lens position No...

Page 10: ...VIVOTEK 10 User s Manual 2 Remove the trim ring by squeezing it and pulling it off the camera 75 180 180 Below are the tilt pan and rotation limitations ...

Page 11: ...VIVOTEK User s Manual 11 T10 3 Remove the SD card panel cover using the included T10 wrench 64GB 10 I 1 4 Install a MicroSD card if onboard storage is preferred ...

Page 12: ...VIVOTEK 12 User s Manual 6 Use the included alignment sticker to drill holes for mounting screws and a cabling hole if applicable 5 Install the SD card panel cover ...

Page 13: ...VIVOTEK User s Manual 13 7 Pull a CAT5e Ethernet cable through the hole Ø 25mm OR 8 If drilling a cable routing hole is not possible you can remove the side lid and route a cable from the side ...

Page 14: ...he cable gland and install the waterproof seal components to an Ethernet cable 10 Connect the Ethernet cable to the camera s RJ45 female socket Tighten up the waterproof components Make sure they are adequately installed to prevent damage by moisture ...

Page 15: ...VIVOTEK User s Manual 15 11 Install the camera to a wall or ceiling by fastening 3 included screws ...

Page 16: ...ers 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 Software Installation 13 Install the Shepherd utility which helps you locate and configure your Network Camera in the local network If your camera comes without the CD go to VIVOTEK s website and locate the utility in the Downloads Software page ...

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

Page 18: ...ns Protecting your camera with a password can deter the majority of cyber attacks 14 1 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 Some but not all special ASCII characters are supported _ and You can use them in the password combination ...

Page 19: ...VIVOTEK User s Manual 19 14 2 Another prompt will request for the password you just configured Enter the password and then you can start configure your camera and see the live view ...

Page 20: ...ut not completely remove the retention screw on the side of the camera to adjust the camera s shooting direction You can pan tilt or rotate the camera 16 With the live view tilt pan or rotate the camera to acquire an optimal field of view ...

Page 21: ...VIVOTEK User s Manual 21 17 When done tighten the retention screw on the camera 18 Install the trim ring Aligh the trim ring using the center ridge at the back of the camera ...

Page 22: ...en the firmware configuration page Enter the Configuration Media Image Focus page You will see a live stream on screen If preferred you can zoom in on the scene Use the Perform Auto Focus function to automatically tune to a best image focus Check the live view to ensure the image is in focus 1 2 Configuration Media Image Focus The T models comes with a motorized focus lens HT ...

Page 23: ...nstallation The mount bracket supports the installation to a 3 5 single gang box or octagon gang box 3 5 single gang box 3 5 Octagon gang box B holes 3 5 single gang box A 1 Use the B holes on the bracket to install to a single gang box ...

Page 24: ...on gang box Use the C holes on the bracket to install to an octagon gang box A 2 Route an Ethernet cable through the center hole and then along the retention tabs Refer to the previous description for how to install the waterproof cable housing ...

Page 25: ...ion and press the assembled cable housing into the center position When snapped into place its position will be secured by 4 retention tabs A 3 A 4 Install the camera by aligning the keyhole slots Align the two way keyhole slot with the larger screw head ...

Page 26: ...VIVOTEK 26 User s Manual A 5 Turn the the camera clockwise and secure the installation using an included Phillips screw ...

Page 27: ...VIVOTEK User s Manual 27 B B 1 Mouting to ceiling using the bracket Use the included alignment sticker to drill mounting holes on a wall or ceiling ...

Page 28: ...fer to page 24 for the rest of the installation steps 3 4 NPT pipe 3 4 female threaded fitting coupling Locknut C You can also secure the bracket to a 3 4 NPT pipe An additional 3 4 female to female coupling and lock nut are required You should then place the cable housing inside the pipe ...

Page 29: ...s and 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 16G...

Page 30: ...transmission of power and data via a sin gle Ethernet cable Follow the below 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 802 3af ...

Page 31: ...era 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 from the software CD in a deployment consisting of multiple cameras For its installation details please refer to its related documents ...

Page 32: ...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 33: ... 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 34: ...unch your web browser e g Microsoft Internet Explorer or Mozilla Firefox 2 Enter the IP address of the Network Camera in the address field Press Enter 3 Live video will be displayed in your web browser 4 If it is the first time installing the VIVOTEK network camera an information bar will prompt as shown below Follow the instructions to install the required plug in on your computer NOTE For Mozill...

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

Page 36: ...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 37: ...54 please set the RTSP port to 554 For more information please refer to RTSP Streaming on page 96 For example 4 The live video will be displayed in your player For more information on how to configure the RTSP access name please refer to RTSP Streaming on page 96 for details rtsp 192 168 5 151 554 live sdp 1 Launch the RTSP player 2 Choose File Open URL A URL dialog box will pop up 3 The address f...

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

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

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

Page 43: ...cording Click this button to record video clips in MP4 file format to your computer Press the Stop MP4 Recording button to end recording When you exit the web browser video recording stops accordingly To specify the storage destination and file name please refer to MP4 Saving Options on page 46 for details Volume When the Mute function is not activated move the slider bar to adjust the volume on t...

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

Page 46: ... and time to the end of the file name Local Streaming Buffer Time In the case of encountering unsteady bandwidth live streaming may lag and video streaming may not be very smoothly If you enable this option the live streaming will be stored temporarily on your PC s cache memory for a few milli seconds before being played on the live viewing window This will help you see the streaming more smoothly...

Page 47: ...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 48: ... 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 49: ... 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 50: ...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 51: ...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 52: ... manually Note that the date and time format are yyyy mm dd and hh mm ss Automatic The Network Time Protocol is a protocol which synchronizes computer clocks by periodically querying an NTP Server NTP server Assign the IP address or domain name of the time server Leaving the text box blank connects the Network Camera to the default time servers The precondition is that the camera must have the acc...

Page 53: ...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 54: ...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 55: ... 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 56: ...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 57: ...t message Email GSM Modem HTTP Digital output VIVOCloud PTZ 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 58: ... and administrators in a chronological order The access log is stored in the Network Camera s buffer area and will be overwritten when reaching a certain limit System Parameters The View Parameters page lists the entire system s parameters If you need technical assistance please provide the information listed on this page ...

Page 59: ...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 60: ... the lens focus position using the previously saved position parameters If none of the options is selected all settings will be restored to factory default The following message is displayed during the restoring process Import Export files This feature allows you to Export Update daylight saving time rules custom language file configuration file and server status report Export daylight saving time...

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

Page 62: ... 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 63: ...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 64: ...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 65: ... 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 Sensitivity of IR cut filter Tune the responsi...

Page 66: ...TEK 66 User s Manual IR control Turn on built in IR illuminator in night mode Select this to turn on the camera s onboard IR illuminator when the camera detects low light condition and enters the night mode ...

Page 67: ...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 68: ...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 Enable digital image stabilizer If you experience problems such as vibration occurs when on a pole mount try enable the image stabilizer Highlight mask Strong light so...

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

Page 70: ... be calculated out of the remaining of the inclusive window Include Exclude Weighted region Ignored region Include Exclude 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 spotlights or headlights Center Use the center portion of the screen to determine the...

Page 71: ... You may prefer a shorter shutter time to better capture moving objects while a faster shutter reduces light and needs to be compensated by electrical brightness gains Exposure mode available when WDR Pro is disabled You can click and drag the 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 c...

Page 72: ...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 Select the mode this profile to apply to Day mode Night m...

Page 73: ...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 74: ...ce by referring to the full view Custom You can create a focus window and drag it to a place of interest in your view window Note that it is recommended to use this function only when you have a solid object in your view window that is showing a consistent color or texture This function will not take effect if you set the focus window on a distant background 5 Wait for the scan to complete After a...

Page 75: ...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 76: ... is the full resolution at 5 megapixels in a 4 3 screen aspect ratio 4 Megapixel 16 9 max 30fps At the 16 9 aspect ratio the usable resolution is slightly reduced to 4MP 1080P Full HD 16 9 max 60fps If the need should arise for monitoring fast vehicles at 60fps select this mode with a compromised resolution ...

Page 77: ...am 2 is set to the 640 x 480 Stream 3 The default frame size for Stream 3 is set to the 2560 x 1920 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 stre...

Page 78: ...nt 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 list according to...

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

Page 80: ... 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 81: ...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 82: ...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 83: ...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 84: ...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 85: ...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 86: ... 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 87: ...ing message is displayed Internal microphone input Select the gain of the external audio input according to ambient conditions Adjust the gain from 0 to 100 Audio type Select audio codec and the sampling bit rate G 711 also provides good sound quality and requires about 64Kbps Select pcmu μ Law or pcma A Law mode G 726 is a speech codec standard covering voice transmission at rates of 16 24 32 and...

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

Page 89: ... 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 90: ...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 91: ...ces Enabling UPnP port forwarding allows the Network Camera to open a secondary HTTP port on the router not HTTP port meaning that you have to add the secondary HTTP port number to the Network Camera s public address in order to access the Network Camera from the Internet For example when the HTTP port is set to 80 and the secondary HTTP port is set to 8080 refer to the list below for the Network ...

Page 92: ... above When IPv6 is enabled by default the network camera will listen to router advertisements and be assigned with a link local IPv6 address accordingly IPv6 Information Click this button to obtain the IPv6 information as shown below If your IPv6 settings are successful the IPv6 address list will be listed in the pop up window The IPv6 address will be displayed as follows Link global IPv6 address...

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

Page 94: ...VIVOTEK 94 User s Manual ...

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

Page 96: ...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 97: ...ample when the access name for stream 1 is set to live sdp 1 Launch an RTSP player 2 Choose File Open URL A URL dialog box will pop up 3 Type the above URL command in the text box 4 The live video will be displayed in your player as shown below rtsp 192 168 5 151 554 live sdp Quick Time player VLC Disable O O Basic O O Digest O X Video 16 38 01 2012 01 25 RTSP port RTP port for video audio RTCP po...

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

Page 100: ...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 101: ... 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 102: ...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 103: ...e 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 t...

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

Page 106: ...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 107: ...VIVOTEK User s Manual 107 Privilege management Allow anonymous viewing If you select this item any client can access the live stream without entering a User ID and Password ...

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

Page 113: ... 113 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 114: ... 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 115: ... 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 116: ...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 117: ... 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 118: ...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 119: ...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 120: ...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 121: ...Z Operation The e PTZ control settings section will be displayed as shown below For e PTZ related details please refer to page 123 Auto pan patrol speed Select the speed from 1 5 slow fast to set up the Auto pan patrol speed control Zoom factor display If you check this item the zoom indicator will be displayed on the home page when you zoom in out the live viewing window as the picture shown on t...

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

Page 128: ...s disconnected Select this option to backup media file on SD card if the network is disconnected This function will only be displayed after you set up a network storage NAS The media to back up can include snapshot images video or system logs depending on your event settings Once the triggers are configured they will be listed under the VADP option ...

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

Page 132: ...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 152 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 133: ...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 2019 01 20 2019 01 20 2019 01 20 2019 01 20 ...

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

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

Page 136: ...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_20190513_100341 Date and time sufﬁx The format is YYYYMMDD_HHMMSS File name preﬁx ...

Page 137: ... 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 138: ...n configuring the settings Please note that there is a limited number of customized scripts you can upload if the current amount of customized scripts has reached the limit an alert message will prompt If you need more information please contact VIVOTEK technical support 20180213 20180213 Click to upload a file Click to modify the script online ...

Page 139: ...votek com downloadfile solutions vadp smart motion detection manual_ en pdf Click on Configuration Applications Motion detection The Smart Motion utility will be automatically started If Human detection is applied make sure you measured the height of your camera at the installation site It is important for a correct video analysis You should enter the installation height in the Motion detection Se...

Page 140: ...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 141: ... 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 142: ... Refer to page 87 for Audio settings and page 79 for video streaming settings You can use the Profile window to configure a different Audio detection setting For example a place can be noisy in the day time and become very quiet in the night 1 Click on the Enable this profile checkbox Once the Audio detection window is opened the current sound input will be interactively indicated by a fluctuating...

Page 143: ...ntage on the chart Click the Enable shock detector checkbox and click Save to complete the configuration Shock Level You should then go to Event settings to configure the shock detection as a triggering source See page 125 for Event configuration The measurement range of the sensor is 16G For every one G force g 9 8 m s perceived the sensor acquires a reading of 512 The value acquired by a 2 G acc...

Page 144: ...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 145: ...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 146: ...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 147: ...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 148: ...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 149: ...etails in the following NAS server Click Add NAS server to open the server setting window and follow the steps below to set up 1 Fill in the information for your server For example 2 Click Test to check the setting The result will be shown in the pop up window 1 2 3 4 Network storage path server name or IP address folder name User name and password for your server ...

Page 150: ...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 151: ...on about folder naming rules please refer to page 132 for details 20190210 20190211 20190212 f you want to enable recording notification please click Event to configure event triggering settings Please refer to Event Event settings on page 125 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 152: ...s This column shows the status and reserved space of your SD card Please remember to format the SD card when using for the first time no SD card NOTE It is recommended to turn OFF the recording activity before you remove an SD card from the camera The lifespan of an SD card is limited Regular replacement of the SD card can be necessary Camera filesystem takes up several megabytes of memory space T...

Page 153: ...This section explains how to manage the content of recorded videos on the Network Camera Here you can search and view the records and view the searched results Searching and Viewing the Records This column allows the user to set up search criteria for recorded data If you do not select any criteria and click Search button all recorded data will be listed in the Search Results column File attribute...

Page 154: ...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 155: ...rch result then click this button The selected items will become Locked which will not be deleted during cyclic recording You can click again to unlock the selections For example Remove Select the desired search results then click this button to delete the files Click to switch pages ...

Page 156: ...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 157: ...ctive http mywebserver cgi bin dido setdo cgi do1 1 4 Security Level SECURITY LEVEL SUB DIRECTORY DESCRIPTION 0 anonymous Unprotected 1 view viewer Can view listen and talk to camera 4 operator operator Operator access rights can modify most of the camera s parameters except some privileges and network options 6 admin admin Administrator access rights can fully control the camera s operations 7 N ...

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

Page 159: ...n operator setparam cgi parameter value parameter value return return page http servername cgi bin admin setparam cgi parameter value parameter 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 T...

Page 160: ...eter value r n parameter pair Only the parameters that you set and are readable will be returned Example Set the IP address of server to 192 168 0 123 Request http myserver cgi bin admin setparam cgi network_ipaddress 192 168 0 123 Response HTTP 1 0 200 OK r n Content Type text html r n Context Length 33 r n r n network ipaddress 192 168 0 123 r n ...

Page 161: ... 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 blank string everythi...

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

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

Page 164: ...83 GMT 02 00 Israel 120 GMT 03 00 Baghdad Kuwait Riyadh Moscow St Petersburg Nairobi 121 GMT 03 00 Iraq 140 GMT 03 30 Tehran 160 GMT 04 00 Abu Dhabi Muscat Baku Tbilisi Yerevan 180 GMT 04 30 Kabul 200 GMT 05 00 Ekaterinburg Islamabad Karachi Tashkent 220 GMT 05 30 Calcutta Chennai Mumbai New Delhi 230 GMT 05 45 Kathmandu 240 GMT 06 00 Almaty Novosibirsk Astana Dhaka Sri Jayawardenepura 260 GMT 06 ...

Page 165: ...00 6 6 0 to Disable automatic time adjustment otherwise it indicates the seconds between NTP automatic update intervals 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 restoreexceptnet 0 positive integer 7 6 Restore the system parameters to default values ...

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

Page 167: ...ual to modelname serialnumber mac address 1 7 12 characters MAC address without hyphens firmwareversion string 40 0 7 Firmware version including model company and version number in the format MODEL BRAND VERSION language_count positive integer 0 7 Number of webpage languages available on the server language_i 0 count 1 string 16 language_i0 English language_i1 Deutsch language_i2 Español language_...

Page 168: ...Inactive normal 1 Active triggered capability_ndi 0 do_i 0 capability_ndo 1 product dependent boolean 1 7 0 Inactive normal 1 Active triggered capability_ndo 0 onlinenum_rtsp 0 positive integer 6 7 Current number of RTSP connections onlinenum_httppush 0 positive integer 6 7 Current number of HTTP push server connections onlinenum_sip 0 positive integer 6 7 Current number of SIP connections eth_i0 ...

Page 169: ... n is the value of capability_ndi capability_capability_ndi 0 NAME VALUE SECURITY get set DESCRIPTION normalstate high low 1 1 Indicates open circuit or closed circuit inactive status 7 4digital output behavior define Group do_i 0 n 1 for n is the value of capability_ndo capability_ndo 0 NAME VALUE SECURITY get set DESCRIPTION normalstate open grounded 1 1 Indicate open circuit or closed circuit i...

Page 170: ...LUE SECURITY get set DESCRIPTION preprocess positive integer 6 6 An 32 bit integer each bit can be set separately as follows Bit 0 HTTP service Bit 1 HTTPS service Bit 2 FTP service Bit 3 Two way audio and RTSP Streaming service To stop service before changing its port settings It s recommended to set this parameter when change a service port to the port occupied by another service currently Other...

Page 171: ...WINS server 7 6 1 802 1x Subgroup of network ieee8021x capability_protocol_ieee8021x 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable disable IEEE 802 1x eapmethod eap peap eap tls 6 6 Selected EAP method identity_peap string 64 6 6 PEAP identity identity_tls string 64 6 6 TLS identity password string 200 7 6 Password for TLS privatekeypassword string 200 7 6 Password for PEAP c...

Page 172: ...talarm 0 7 6 6 Event alarm channel for CoS management 0 7 6 6 Management channel for CoS eventtunnel 0 7 6 6 Event Control channel for CoS Subgroup of network qos_dscp capability_protocol_qos_dscp 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable disable DSCP video 0 63 6 6 Video channel for DSCP audio 0 63 6 6 Audio channel for DSCP capability_naudioin 0 eventalarm 0 63 6 6 Even...

Page 173: ...ort authmode basic digest 1 6 HTTP authentication mode s 0 capability_nmediast ream 1 _accessname product dependent Not recommended to use this string 32 1 6 Http server push access name for stream N N 1 capability_nmediastream capability_protocol_spush_mjpeg 1 and capability_nmediastream 0 The value are shown as video1s1 mjpg c0_s0_accessname channel1stream1 video1s2 mjpg c0_s1_accessname channel...

Page 174: ...stream M N 1 capability_nvideoin M 1 capability_nmediastream capability_protocol_spush_mjpeg 1 and capability_nmediastream 0 The value are shown as video1s1 mjpg c0_s0_accessname channel1stream1 video1s2 mjpg c0_s1_accessname channel1stream2 video2s1 mjpg c1_s0_accessname channel2stream1 video2s2 mjpg c1_s1_accessname channel2stream2 etc We support this parameter when the version number httpversio...

Page 175: ...for channel stream N N 1 capability_nmediastream capability_protocol_spush_mjpeg 1 and capability_nmediastream 0 The value are shown as live1s1 sdp c0_s0_accessname channel1stream1 live1s2 sdp c0_s1_accessname channel1stream2 live1s3 sdp c0_s2_accessname channel1stream3 live1s4 sdp c0_s3_accessname channel1stream4 etc 7 6 8 RTSP multicast Subgroup of network_rtsp_s 0 n 1 _multicast n denotes the v...

Page 176: ... Multicast metadata IP address We support this parameter when the version 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 65534 4 4 Multicast metadata port ttl 1 255 4 4 Multicasttime to live value 7 6 9 SIP port Subgroup of net...

Page 177: ...DESCRIPTION enable boolean 6 6 Enable access list filtering admin_enable boolean 6 6 Enable administrator IP address admin_ip string 43 6 6 Administrator IP address maxconnection 1 capability_protocol _maxconnection 6 6 Maximum number of s type 0 1 6 6 Ipfilter policy 0 allow 1 deny ipv4list_i 0 9 Single address ip address Network address ip address network mask Range address start ip address end ...

Page 178: ...sensor rbgain Use rgain and bgain to set white balance manually manual 2 cases a if rbgain is not supported this means keep current white balance status b if rbgain is supported rgain and bgain are updated to the current values which is got from white balance module Then act as rbgain mode widerange Auto Tracing White balance 2000K to 10000K outdoor auto white balance mode specifically for outdoor...

Page 179: ...environment indoor Avoid rolling and flicker effect first fixed Open the iris to maximum Only available when capability_image_c 0 n 1 _iristype d ciris enableblc Not support anymore boolean 4 4 Enable backlight compensation Not support this parameter anymore when the version number httpversion is equal or greater than 0301a It s recommanded to use exposurewin_c 0 n 1 _mode to switch on off BLC col...

Page 180: ...Bit 5 Support focus operation 0 not support 1 support SD PZ IZ series only text string 64 1 4 Enclose caption imprinttimestamp boolean 4 4 Overlay time stamp on video minexposure product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c 0 n 1 _exposu re_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 ...

Page 181: ...his 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 _exposure_ maxrange Only valid when piris_mode manual or irismode fixed Only available when capability_image_c 0 n 1 _exposure_r angetype is twovalues enablepreview boolean 1 4 Usage for UI of exposure settings Preview settings of video profile Only availabl...

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

Page 183: ...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 _wb mode 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 ...

Page 184: ...t with variable Iris and keep adjusting Gain and Shutter speed automatically qualitypriority Automatically adjust the Iris Gain and Shutter Speed by VIVOTEK quality algorithm manual Manually adjust with variable Shutter Iris and Gain We support this parameter when the version number httpversion is equal or greater than 0302a Only available when capability_image_c 0 n 1 _exp osure_mode 0 irismode f...

Page 185: ...y_image_c 0 n 1 _irist ype piris piris_position product dependent 1 100 1 4 Manual set P Iris 1 Open 100 Close Only valid when piris_mode manual or capability_image_c 0 n 1 _sen sortype is smartsensor Only available when capability_image_c 0 n 1 _irist ype piris enableblc Not support anymore boolean 4 4 Enable backlight compensation Not support this parameter anymore when the version number httpve...

Page 186: ...rmalized range Only available when capability_image_c 0 n 1 _exp osure_rangetype is twovalues gainvalue 0 100 4 4 Gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc _maxgain and capability_image_c 0 n 1 _exp osure_rangetype is onevalue Normalized range We support this parameter when the version number httpversion is equal or greater than 0302a color 0 1 4 4 0 monochrome 1 ...

Page 187: ...port SD PZ IZ series only text string 64 1 4 Enclose caption imprinttimesta mp boolean 4 4 Overlay time stamp on video textonvideo_po sition top bottom 4 4 Text on video string position textonvideo_siz e 20 40 4 4 Text on video font size textonvideo_fon tpath 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 m...

Page 188: ...s parameter may also restrict image frame rate from sensor due to sensor generates a frame per exposure time Ex If this is set to 1 5s 1 8000s and camera takes 1 5s on the night then sensor only outputs 5 frame s Only available when capability_image_c 0 n 1 _exp osure_maxrange Only valid when piris_mode manual or irismode fixed Only available when capability_image_c 0 n 1 _exp osure_rangetype is t...

Page 189: ...of video profile Only available when capability_image_c 0 n 1 _exp osure_mode 0 meteringmode auto blc hlc Available value is listed in capability_image_c 0 n 1 _expo sure_meteringmode 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 parame...

Page 190: ...apability_image_c 0 n 1 _exp osure_bracketing_mode 1 We support this parameter when the version number httpversion is equal or greater than 0310a s 0 m 1 _e nableeptz boolean 4 4 Indicate whether stream supprts eptz or not s 0 m 1 _c odectype 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 option...

Page 191: ...greater than 0301c s 0 m 1 _h 264_intraperiod 250 500 1000 2000 3000 4000 4 4 The time interval between two I frames Intra coded picture The unit is millisecond ms s 0 m 1 _h 264_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 _h 264_quant 1 5 99 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 ...

Page 192: ...ate exceeds this value frames will be dropped to restrict the bit rate Only valid when h264_ratecontrolmode vbr s 0 m 1 _h 264_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 Only available when capability_smartstream_version 2 0 s 0 m 1 _h 264_cbr_qperce...

Page 193: ...maxframerate s 0 m 1 _h 264_profile 0 2 1 4 Indicate H264 profiles 0 baseline 1 main profile 2 high profile s 0 m 1 _h 264_smartq_en able boolean 4 4 Enable Smart Q function Only available when capability_videoin_c 0 n 1 _sm artq_support is 1 We support this parameter when the version number httpversion is equal or greater than 0309a s 0 m 1 _h 265_dintraperio d_enable boolean 4 4 Enable Dynamic i...

Page 194: ...00 Use the quality level in qpercent 99 Use the quality level in qvalue Only available when h265 is listed in capability_videoin_codec and h265_ratecontrolmode vbr s 0 m 1 _h 265_qvalue 0 51 4 4 Manual video quality level input The Q value which is used by encoded library directly Only available when h265 is listed in capability_videoin_codec Only valid when h265_ratecontrolmode vbr and s 0 m 1 _h...

Page 195: ..._h 265_cbr_quant 1 5 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality level in cbr_qpercent Only available when h265 is listed in capability_videoin_codec and h265_ratecontrolmode cbr Only available when capability_smartstream_version 2 0 s 0 m 1 _h 265_cbr_qperce nt 1 100 4 4 Select customized quality in a normalized full range 1 Wors...

Page 196: ..._c 0 n 1 _resolution are recorded in capability_videoin_c 0 n 1 _h2 65_maxframerate Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h 265_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 _h 265_smartq_en able boolean 4 4 Enable Smart Q function O...

Page 197: ...uality level input The Q value which is used by encoded library directly Only valid when mjpeg_ratecontrolmode vbr and s 0 m 1 _mjpeg_quant 99 s 0 m 1 _m jpeg_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 _m jpeg_maxvbrbit rate 20000 capability_videoin_c 0 n 1 _...

Page 198: ...m 1 _m jpeg_bitrate 20000 capability_videoin_c 0 n 1 _mjpeg_maxbitrate 4 4 The target bit rate in constant bit rate mode Only valid when mjpeg_ratecontrolmode cbr s 0 m 1 _m jpeg_prioritypoli cy framerate imagequality 4 4 Set prioritypolicy Only valid when mjpeg_ratecontrolmode cbr s 0 m 1 _m jpeg_maxframe 1 capability_videoin_c 0 n 1 _ mjpeg_maxframerate 1 4 The maximum frame rates of a mjpeg str...

Page 199: ...pability_image_c 0 n 1 _wdr pro_strength is 1 wdrc_mode product dependent boolean 4 4 Enable WDR enhanced Only available when capability_image_c 0 n 1 _wdr c_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 _wdr c_mode is 1 aespeed_mode product dependent boolean...

Page 200: ...is easy to be trigger while scene changed Only available when capability_image_c 0 n 1 _aes peed is 1 and capability_image_c 0 n 1 _aes peedsupportsensitivity 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 _flick erless is 1 mounttype ceiling wall floor 1 6 Hardware installation Only available when capability...

Page 201: ... 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 function mode autotracking manual hybrid 4 4 Set Smart stream...

Page 202: ...in_i 0 k 1 capability_smartstream_support 1 capability_smartstream_version 2 0 and capability_smartstream_mode_manual 1 Group videoin_c 0 n 1 _s 0 m 1 _h265_smartstream2_win_i 0 k 1 capability_smartstream_support 1 capability_smartstream_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...

Page 203: ...applied to Not support policy day anymore when the version number httpversion is equal or greater than 0301a begintime hh mm 4 4 Begin time of schedule mode endtime hh mm 4 4 End time of schedule mode minexposure product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c 0 n 1 _exposu re_minrange 4 4 Minimum exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 ...

Page 204: ...value 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 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 5...

Page 205: ...n capability_image_c0_exposure_mode 0 exposuremode product dependent auto shutterpriority irispriority qualitypriority manual etc Available options are list in capability_image_c 0 n 1 _exposu re_modetype 4 4 Select exposure mode auto Automatically adjust the Iris Gain and Shutter Speed to fit the exposure level shutterpriority Manually adjust with variable Shutter Speed and keep adjusting Iris Ga...

Page 206: ...white balance manually manual 2 cases a if rbgain is not supported this means keep current white balance status b if rbgain is supported rgain and bgain are updated to the current values which is got from white balance module Then act as rbgain mode widerange Auto Tracing White balance 2000K to 10000K outdoor auto white balance mode specifically for outdoor indoor auto white balance mode specifica...

Page 207: ..._c 0 n 1 _agc_maxga in Only valid when piris_mode manual or irismode fixed Normalized range Only available when capability_image_c 0 n 1 _exposure_r angetype is twovalues mingain 0 100 4 4 Minimum gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_mingai n Only valid when piris_mode manual or irismode fixed Normalized range Only available when capability_image_c 0 n 1 _exp...

Page 208: ... when the version number httpversion is equal or greater than 0311a piris_mode product dependent manual indoor outdoor 1 4 Control P Iris mode outdoor Auto setting P Iris to get best quality but easy to meet rolling or flicker effect in indoor environment indoor Avoid rolling and flicker effect first manual Manual set P Iris by piris_position not support only available when capability_image_c 0 n ...

Page 209: ... 4 4 The strength of WDR Pro The bigger value means the stronger strength of WDR Pro Only available when capability_image_c 0 n 1 _wdrpro_str ength 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 enh...

Page 210: ...4 The sensitivity of AE converge speed 1 20 level 1 21 40 level 2 41 60 level 3 61 80 level 4 81 100 level 5 Level 1 4 low high The higher sensitivity level meas that it is easy to be trigger while scene changed Only available when capability_image_c 0 n 1 _aespeed is 1 and capability_image_c 0 n 1 _aespeedsup portsensitivity is 1 flickerless product dependent boolean 4 4 Turn on 1 or turn off 0 t...

Page 211: ...ming We support this parameter when the version number httpversion is equal or greater than 0311c c 0 n 1 _s 0 m 1 _allow boolean 4 4 Enable time shift streaming for specific stream 7 10 IR cut control Group ircutcontrol capability_daynight_c 0 n 1 _support 0 n denotes the value of capability_nvideoin NAME VALUE SECURITY get set DESCRIPTION mode Not recommended to use this auto day night di schedu...

Page 212: ...n 0311c disableirled Not recommended to use this boolean 6 6 Enable disable built in IR led Only available when capability_daynight_illuminators_builtin_su pport 0 and irled is listed in capability_daynight_ illuminators _builtin_type We replace this parameter with ircutcontrol_illuminators_builtin_irled_enab led when the version number httpversion is equal or greater than 0311c enableextled Not r...

Page 213: ...ol There are two value format low normal high if capability_daynight_c 0 n 1 _ircutsensi tivity_type options 1 100 if capability_daynight_c 0 n 1 _ircutsensi tivity_type normalize Only available when capability_daynight_c 0 n 1 _ircutsensitivity_type is not We replace this parameter with ircutcontrol_c 0 n 1 _sensitivity when the version number httpversion is equal or greater than 0311c spectrum_m...

Page 214: ...n is equal or greater than 0311c sir product dependent boolean 6 6 Enable disable Smart IR Only available when capability_daynight_c 0 capability_nvide oin 1 _smartir is 1 We support this parameter when the version number httpversion is equal or greater than 0311c daymodebegintime 00 00 23 59 6 6 Day mode begin time We support this parameter when the version number httpversion is equal or greater ...

Page 215: ... of day night control There are two value format low normal high if capability_daynight_c 0 n 1 _ircutsensi tivity_type options 1 100 if capability_daynight_c 0 n 1 _ircutsensi tivity_type normalize Only available when capability_daynight_c 0 n 1 _ircutsensitivity_type is not We support this parameter when the version number httpversion is equal or greater than 0311c ...

Page 216: ... available when capability_daynight_illuminators_builtin_su pport 0 and whiteled is listed in capability_daynight_ illuminators _builtin_type We support this parameter when the version number httpversion is equal or greater than 0311c external_do_enabled boolean 6 6 Enable disable external led mounted on do1 Only available when capability_daynight_illuminators_external_ support 0 and do is listed ...

Page 217: ...al or greater than 0311c spectrum_mode visible ir irenhanced blueenhanced product dependent Available values are listed in capability_daynight _illuminators _spectrum_mode 6 6 Set spectrum method We support this parameter when the version number httpversion is equal or greater than 0311c Only available when capability_daynight_illuminators_ spectrum _support 0 ...

Page 218: ...sspercent 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 _basicsetting is 1 We replace contrast with contrastpercent This parameter will not be used after the version number...

Page 219: ...400a 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 _basicsetting is 1 contrastpercent 0 100 4 4 Set contrast in the normalized range 0 Less contrast 100 More contrast Only available when bit 1 of capability_image_c 0 n 1 _basicsetting is 1 saturationpercent 0 100 4 4 Set saturation in the normalized rang...

Page 220: ... mode Only available when capability_image_c 0 n 1 _lowlightmod e is 1 hlm product dependent boolean 4 4 Enable disable hightlight mask Only available when capability_image_c 0 n 1 _hlm is 1 dnr_mode product dependent boolean 4 4 3D noise reduction 0 disable 1 enable Only available when capability_image_c 0 n 1 _dnr is 1 dnr_strength product dependent 1 100 4 4 Strength of 3DNR Only available when...

Page 221: ...vailable when dis is listed in capability_image_c 0 n 1 _is_mode scene_mode product dependent Available value is listed in capability_im age_c 0 n 1 _scenemod e_supporttype product dependent 4 4 Value of scene mode Only available when capability_image_c 0 n 1 _scenemode_ support is 1 restoreatwb positive integer 4 4 Restore of adjusting white balance of image according to mode settings freeze prod...

Page 222: ...1 lens_alignment 0 100 4 4 Stitch the sensors together into focused position Only available when capability_image_c 0 n 1 _lens_alignm ent is 1 lens_ldc_mode boolean 4 4 Enable disable lens distortion correction Only available when capability_image_c 0 n 1 _lens_ldc_sup port is 1 palette_mode Available value is listed in capability_im age_c 0 n 1 _palette_m ode 1 4 Set color palette option Only av...

Page 223: ...he 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 when bit 1 of capability_image_c 0 n 1 _basicsetting is 1 We replace profile_i0_contrast with profile_i0_contrastpercent This parameter will not be used after the version number httpversi...

Page 224: ... 1 _brightness percent 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 _basicsetting is 1 profile_i 0 m 1 _contrastpe rcent 0 100 4 4 Set contrast in the normalized range 0 Less contrast 100 More contrast Only available when bit 1 of capability_image_c 0 n 1 _basicsetting is 1 profile_i 0 m 1 _saturation percent 0 100 4 4 S...

Page 225: ...ge_c 0 n 1 _lowlightmod e is 1 profile_i 0 m 1 _hlm product dependent boolean 4 4 Enable disable hightlight mask Only available when capability_image_c 0 n 1 _hlm is 1 profile_i 0 m 1 _dnr_mode product dependent boolean 4 4 3D noise reduction 0 disable 1 enable Only available when capability_image_c 0 n 1 _dnr is 1 profile_i 0 m 1 _dnr_stren gth product dependent 1 100 4 4 Strength of 3DNR Only av...

Page 226: ...n capability_image_c 0 n 1 _is_mode 7 12 Exposure window setting per channel Group exposurewin_c 0 n 1 for n channel profucts n denotes the value of capability_nvideoin Only available when capability_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 imag...

Page 227: ...main 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 _exposure_ 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 available when px is listed in capability_image_c 0 n 1 _exposure_ windomain sizepx 0 Wx0 H W 0 The current image width 1 H 0 The cur...

Page 228: ...on and to perform the masking of bright light area center Use Center window as metering area and give the necessary light compensation Group exposurewin_c 0 n 1 _profile_i 0 m 1 _win_i 0 k 1 for m profile and n channel product n denotes the value of capability_nvideoin m denotes the value of capability_nvideoinprofile k denotes the value of capability_image_c 0 n 1 _exposure_winnum Only available ...

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

Page 230: ...parameter description of input input intmic extmic product dependent 4 4 intmic Internal built in microphone Only available when capability_audio_intmic 1 extmic External microphone input Only available when capability_audio_extmic 1 Note If physical microphone switch is showed on product this value is updated during booting to fit switch status volume_internal 0 100 4 4 Volume when take internal ...

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

Page 232: ...vailable if G 726 is supported s0_g726_vlcmode 0 1 4 4 Enable vlcmode for G 726 0 Standard mode 1 Solve compatibility problem with VLC player Only available if G 726 is supported aec_enable boolean 4 4 Enable acoustic echo cancellation Only available when capability_audio_aecmode is manual We support this parameter when the version number httpversion is equal or greater than 0306b alarm_enable boo...

Page 233: ...lity_audio_audioclip 1 n denotes the value of capability_nvideoin 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 clip name that can be played when an event occurs size 0 positive integer 1 4 The size of audio clip p...

Page 234: ...4 4 Name of motion window polygonstd 0 9999 0 9999 0 9999 0 9999 0 9999 0 9999 0 9999 0 9999 4 4 Coordinate of polygon window position 4 points x0 y0 x1 y1 x2 y2 x3 y3 Only available when capability_motion_wintype polygon Only available when std is listed in capability_motion_windomain objsize 1 100 4 4 Percent of motion detection window sensitivity Not recommended to use this 0 100 4 4 Sensitivit...

Page 235: ...be used after the version number httpversion is equal or greater than 0400a left Not recommended to use this 0 320 4 4 Left coordinate of window position Only available when capability_motion_wintype rectangle Only available when qvga is listed in capability_motion_windomain It s recommended to use polygonsd This parameter will not be used after the version number httpversion is equal or greater t...

Page 236: ...nsd This parameter will not be used after the version number httpversion is equal or greater than 0400a Group motion_c 0 n 1 _profile_i 0 m 1 for m profile and n channel product n denotes the value of capability_nvideoin m denotes the vaule of capability_nmotionprofile capability_nmotionprofile 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable profile 1 m 1 policy night schedule ...

Page 237: ...ain objsize 1 100 4 4 Percent of motion detection window sensitivity Not recommended to use this 0 100 4 4 Sensitivity of motion detection window We replace sensitivity with win_sensitivity This parameter will not be used after the version number httpversion is equal or greater than 0400a polygonpx Not recommended to use this 0 W 0 H 0 W 0 H 0 W 0 H 0 W 0 H W 0 The current image width 1 H 0 The cu...

Page 238: ...main It s recommended to use polygonsd This parameter will not be used after the version number httpversion is equal or greater than 0400a top Not recommended to use this 0 240 4 4 Top coordinate of window position Only available when capability_motion_wintype rectangle Only available when qvga is listed in capability_motion_windomain It s recommended to use polygonsd This parameter will not be us...

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

Page 240: ...ndnsDynamic DyndnsCustom Safe100 6 6 DyndnsDynamic dyndns org dynamic DyndnsCustom dyndns org Safe100 safe100 net provider _hostname string 128 6 6 Your DDNS hostname provider _usernameem ail string 64 6 6 Your user name or email to login to the DDNS service provider provider _passwordkey string 64 7 6 Your password or key to login to the DDNS service provider 7 19 Express link Group expresslink P...

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

Page 242: ... 6 Read only security name authpwrw string 8 128 7 6 Read write authentication password authpwro string 8 128 7 6 Read only authentication password authtyperw MD5 SHA 6 6 Read write authentication type authtypero MD5 SHA 6 6 Read only authentication type encryptpwrw string 8 128 7 6 Read write passwrd encryptpwro string 8 128 7 6 Read only password encrypttyperw DES 6 6 Read write encryption type ...

Page 243: ...w or hide manual trigger VI button in homepage 0 Hidden 1 Visible theme_option 1 4 1 6 1 3 One of the default themes 4 Custom definition theme_color_font string 7 1 6 Font color theme_color_configfont string 7 1 6 Font color of configuration area theme_color_titlefont string 7 1 6 Font color of video title theme_color_controlback ground string 7 1 6 Background color of control area theme_color_con...

Page 244: ... of window position Only available when capability_image_c 0 n 1 _privacymas k_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 _privacymas k_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 _privacymas k_wintype rectangle win_i 0 m 1 _polygo n 0 320 0 2...

Page 245: ...ility_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 get set DESCRIPTION enable boolean 4 4 Enable the 3D privacy mask color 0 capability_image_c 0 n 1 _privacymask_ncolor 1 4 4 Privacy mask color win_i 0 m 1 _name string 40 4 4 Name of the privacy mask window win_i 0 ...

Page 246: ...r version when change remove the old features interfaces or the firmware has substantially change in architecture and not able to roll back to previous version This may cause incompatibility with supporting software Minor version Increase the minor version when add new features interfaces without change the old features and interfaces Revision Increase the revision when fix bugs without change any...

Page 247: ...bility_nvideo in 1 _builtinir for built in IR and capability_daynight_c 0 capability_nvideo in 1 _externalir for external IR Not support this parameter anymore when the version number httpversion is equal or greater than 0301a npir 0 positive integer 0 7 Number of PIRs ndi 0 positive integer 0 7 Number of digital inputs nvi 0 positive integer 0 7 Number of virtual inputs manual trigger ndo 0 posit...

Page 248: ...itive integer 0 7 Number of event We support this parameter when the version number httpversion is equal or greater than 0311c nrecording 0 positive integer 0 7 Number of recording We support this parameter when the version number httpversion is equal or greater than 0309a ptzenabled 0 positive integer 0 7 An 32 bit integer each bit can be set separately as follows Bit 0 Support camera control fun...

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

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

Page 251: ...adaptivestreaming boolean 0 7 Indicate whether to support adaptive streaming supporttriggertypes seq boot motion net workfail recnotify ta mpering vi vadp di volalarm temperatu re pir visignal backup smartsd shockalarm virestor e product dependent 0 7 list all the trigger types which are supported in the camera seq Periodic condition boot System boot motion Video motion detection networkfail netwo...

Page 252: ...her to support scalable multicast protocol_rtp_multicast_ba ckchannel boolean 0 7 Indicate whether to support backchannel multicast protocol_rtp_tcp boolean 0 7 Indicate whether to support RTP over TCP protocol_rtp_http boolean 0 7 Indicate whether to support RTP over HTTP protocol_spush_mjpeg boolean 0 7 Indicate whether to support server push MJPEG protocol_snmp boolean 0 7 Indicate whether to s...

Page 253: ...eger and 0 7 This equals capability_videoin_c0_h264_maxframerate This is kept for compatibility videoin_codec mjpeg h264 h265 product dependent 0 7 Available codec of a device split by comma The sequence is not limited EX FD8183 supports H 264 and MJPEG then this is mjpeg h264 IP9171 supports H 264 MJPEG and H 265 then this is mjpeg h264 h265 videoin_streamcodec A list of Positive Integer 0 7 This...

Page 254: ...n 0306b audio_aecaffect maxframerate fixed 15 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 categorized into following groups disabled UI turns grey and users can t select it unchanged UI keeps the status ...

Page 255: ...er than 0306b audio_mic Not support anymore boolean 0 7 Indicate whether to support built in microphone input Not support this parameter anymore when the version number httpversion is equal or greater than 0301a We replace audio_mic with audio_intmic audio_intmic 0 Positive Integer 0 7 Internal Built in Microphone 0 Not support 1 Support Bit 0 for CH0 bit 1 for CH1 and so on audio_extmic 0 Positiv...

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

Page 257: ... std A normalized 0 9999 range Not supported Only available when capability_smartstream_support is 1 smartstream_mode_autot racking boolean 0 7 Indicate whether autotracking smart stream is supported Only available when capability_smartstream_support is 1 smartstream_mode_man ual boolean 0 7 Indicate whether manual smart stream is supported Only available when capability_smartstream_support is 1 s...

Page 258: ...5 Support license registration Bit 6 Support shared memory API Bit 7 Support digital signature of package Bit 8 Support snapshot vadp_npackage positive integer 0 7 Indicate the maximum number of VADP package that can be uploaded to the device camctrl_httptunnel Not support anymore boolean 0 7 Indicate whether to support httptunnel Not support this parameter anymore when the version number httpvers...

Page 259: ... 1 We support this parameter when the version number httpversion is equal or greater than 0305a wireless_s802dot11b boolean 0 7 Indicate whether to support wireless 802 11b wireless_s802dot11g boolean 0 7 Indicate whether to support wireless 802 11g wireless_s802dot11n boolean 0 7 Indicate whether to support wireless 802 11n wireless_beginchannel 1 14 0 7 Indicate the begin channel of wireless net...

Page 260: ...daemon version version_onviftesttool string 0 7 Indicate ONVIF test tool version media_totalspace positive integer 0 7 Available memory space KB for media media_snapshot_maxpre event positive integer 0 7 Maximum snapshot number before event occurred media_snapshot_maxpost event positive integer 0 7 Maximum snapshot number after event occurred media_snapshot_maxsize positive integer 0 7 Maximum siz...

Page 261: ...nts one channel Ex 3 means channel 0 and channel1 support seamless recording Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 localstorage_modnum 0 positive integer 0 7 The maximum MOD connection numbers Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 localstorage_modversion string 0 7 Indicate MOD daemon version Only available w...

Page 262: ...ate whether to support remote auxiliary camera master side this value means supporting max number of auxiliary camera remotecamctrl_slave boolean 0 7 Indicate whether to support remote camera control slave side fisheyelocaldewarp_c 0 capability_nvideoin 1 product dependent 0 positive integer 0 7 Indicate the supported streams of local dewarp One bit represents one supported stream The LSB indicate...

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

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

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

Page 266: ...iltinir Not recommended to use this boolean 0 7 Indicate whether to support built in IR led We replace this parameter with capability_daynight_illuminators_builtin_supp ort and irled is listed in capability_daynight_ illuminators _builtin_type when the version number httpversion is equal or greater than 0311c builtinwled Not recommended to use this boolean 0 7 Indicate whether to support built in ...

Page 267: ...er to support light sensor blackwhitemode boolean 0 7 Indicate whether to support automatically switch to Black White display during the night mode We support this parameter when the version number httpversion is equal or greater than 0302a ircutsensitivity_type string 0 7 Indicate the cgi interface of ircutcontrol_sensitivity options the value of ircutcontrol_sensitivity parameter is low normal h...

Page 268: ...l output Only available when capability_daynight_c 0 n 1 _externalir is 1 We replace this parameter with capability_daynight_illuminators_external_int erface when the version number httpversion is equal or greater than 0311c spectrum_support Not recommended to use this boolean 0 7 Indicate whether to support proposed a brightness enhancement method based on CCM Color Correction Matrix model to imp...

Page 269: ...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_c 0 n 1 _spectrum_ support is 1 We replace this parameter with capability_daynight_illuminators_spectrum_m ode when the version number httpversion is...

Page 270: ...tically switches the current mode when a ditigal input 2 is triggered di3 the camera automatically switches the current mode when a ditigal input 3 is triggered di4 the camera automatically switches the current mode when a ditigal input 4 is triggered schedule The Camera switches between day mode and night mode based on a specified schedule not support We support this parameter when the version nu...

Page 271: ...ter when the version number httpversion is equal or greater than 0311c external_interface do do2 do3 do4 product dependent 0 7 The device interface of external led do digital output 1 do2 digital output 2 do3 digital output 3 do4 digital output 4 We support this parameter when the version number httpversion is equal or greater than 0311c spectrum_support boolean 0 7 Indicate whether to support pro...

Page 272: ...version is equal or greater than 0311c 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 changeable changeable lens Like box type camer...

Page 273: ...eature 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 274: ...n fixed UI is fixed to one selection or value ranged UI is fixed to multiple selections or values enabled UI is checked notsupport the affected function is not available Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to l...

Page 275: ...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 Indicate how many video modes supported by this channel maxsize WxH 0 7 The maximum resolution of all modes in this channel the unit is pixel nprivacymask 0 positive integer 0 7 Number of privacy mask per channel nresolution positive int...

Page 276: ... 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 mjpeg_maxframerate A list of Positive Integer and 0 7 Maximum fps that the device can encoded with MJPEG on resolutions in current video mode means not support One to one mapping to the resolution in resolution Th...

Page 277: ...lement 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 h264 is listed in capability_videoin_codec h264_maxbitrate positive integer 0 7 Maximum bitrates of H 264 The unit is bps Only available when h264 is listed in capabi...

Page 278: ... h265_maxbitrate positive integer 0 7 Maximum bitrates of H 265 The unit is bps Only available when h265 is listed in capability_videoin_codec h265_profile main main10 product dependent 0 7 Indicate H265 profiles Only available when h265 is listed in capability_videoin_codec We support this parameter when the version number httpversion is equal or greater than 0309a fisheye_mounttype Not recommend...

Page 279: ... cameraunit_name CU8131 CU8171 CU8161 H CU8162 H CU8163 H CU8361 H product dependent 0 7 A camera unit name of a split type camera system which the camera unit and the video core are separated If the camera is not a split type camera system the value of this parameter is We support this parameter when the version number httpversion is equal or greater than 0302b cmosfreq_support boolean 0 7 0 The ...

Page 280: ... of ceiling and floor mount resolutionC2P A list of WxH 0 7 Available resolutions of 2P mode of ceiling and floor mount resolutionC1R A list of WxH 0 7 Available resolutions of 1R mode of ceiling and floor mount resolutionC4R A list of WxH 0 7 Available resolutions of 4R mode of ceiling and floor mount resolutionW1P A list of WxH 0 7 Available resolutions of 1P mode of wall mount resolutionW1R A l...

Page 281: ... 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 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 httpversi...

Page 282: ...sensor may perform scale or binning etc on image data and output data with smaller size This parameter is designed to represent this binning 0 1 3 0 7 Indicate binning is used or not in this video 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 disc...

Page 283: ... frame rate that the video source outputs in this video mode One to one mapping to the resolution in resolution The element number is defined as nresolution in this group This parameter records the frame rate when videoin_c 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 thi...

Page 284: ...s 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 h265 is listed in capability_videoin_codec description string 128 0 7 Description about this mode Group capability_image_c 0 n 1 n ...

Page 285: ...of WDR Pro If capability_image_c 0 n 1 _wdr pro 1 this may be either 0 or 1 wdrpro_supportlevel 0 positive integer 0 7 This contains a list of positive integers split by comma If wdrpro_mode 1 then the value indicate the support strength level of WDR Pro If wdrpro_mode 2 then the first number indicate the support strength level of WDR Pro and the scecond number indicate the support strength level ...

Page 286: ...n 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 For example exposurelevel fixed 6 8 12 which means exposurelevel is fixed to level 6 ...

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

Page 288: ...the version number httpversion is equal or greater than 0306d dnrtype 2d 3d 0 7 Description about DNR type Only available when capability_image_c 0 n 1 _dnr 0 We support this parameter when the version number httpversion is equal or greater than 0308a eis 0 1 0 7 0 Non support electronic image stabilizer 1 Support electronic image stabilizer is_mode eis dis 0 7 Indicate the image stabilizer mode e...

Page 289: ...arameter when the version number httpversion is equal or greater than 0302a is_affect minexposure hidden mingain hidden wdrpro unchanged 3dnr unchanged or others x nonnegative integer product dependent 0 7 When Is mode is not some features may become malfunction or be forced to a given value The affected functions are list here The format is Affect API name Policy Description Policy can be categor...

Page 290: ...no feature is affected Only available when capability_image_c 0 n 1 _is_ mode is not We support this parameter when the version number httpversion is equal or greater than 0302a scenemode_support 0 1 0 7 0 Non support scene mode 1 Support scene mode scenemode_supporttype product dependent visibility noiseless lpcparkinglot lpcstreet lpchighway auto deblur lpcfreeway product dependent 0 7 list all ...

Page 291: ...ber httpversion is equal or greater than 0302a exposure_mode 0 1 0 7 0 Non support exposure control 1 Support exposure control exposure_modetype auto shutterpriority irispriority manual product dependent 0 7 Available mode of exposure setting Only available when capability_image_c 0 n 1 _ exposure_mode is 1 We support this parameter when the version number httpversion is equal or greater than 0302...

Page 292: ...n 1 _ exposure_mode is 1 and capability_image_c 0 n 1 _exp osure_rangetype is onevalue We support this parameter when the version number httpversion is equal or greater than 0302a exposure_gainvaluetype fixed maximum 0 7 One to one mapping to the mode type in exposure_modetype fixed The shutter value is the assigned value videoin_c 0 n 1 _gainvalue maximum The shutter value can be up to the assign...

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

Page 294: ... 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 is fixed to multiple sel...

Page 295: ...n defog disabled wdrpro disabled exposurelevel hidden or others x nonnegative integer product dependent 0 7 When exposure iris priority mode is enabled some features may become malfunction or be forced to a given value The affected functions are list here The format is Affect API name Policy Description Policy can be categorized into following groups disabled UI turns grey and users can t select i...

Page 296: ...mage_c 0 n 1 _ exposure_mode is 1 We support this parameter when the version number httpversion is equal or greater than 0302a exposure_qualitypriority mode_affect exposurewin mode blc hidd en defog disabled wdrpro disabled exposurelevel hidden or others x nonnegative integer product dependent 0 7 When exposure quality priority mode is enabled some features may become malfunction or be forced to a...

Page 297: ...level 6 Description can be a nonnegative integer or string or NULL means no feature is affected Only available when qualitypriority is listed in capability_image_c 0 n 1 _ exposure_modetype and capability_image_c 0 n 1 _ exposure_mode is 1 We support this parameter when the version number httpversion is equal or greater than 0305a exposure_manualmode_a ffect exposurewin mode blc hidd en defog disa...

Page 298: ...fected function is not available Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL means no feature is affected Only available when manual is listed in ca...

Page 299: ... n 1 _ exposure_mode is 1 exposure_meteringmode auto blc hlc product dependent 0 7 Available options for videoin_c 0 n 1 _meteringmod e Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_hlcmode_suppo rtwindow 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_...

Page 300: ... function is not available Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL means no feature is affected Only available when capability_image_c 0 n 1 _ e...

Page 301: ...epresent the whole image px Locate a window in the image with pixels std A normalized 0 9999 range Not supported Only available 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_...

Page 302: ...exposure 1 32000 1s 1 32000s 1 8000 1s 1 8000s etc means maximum exposure time is not available When exposure_mode 0 this value must be set to Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_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 avai...

Page 303: ...s how much ratio of exposure compensation will be expanded on the next stream which is based on the original exposure time 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 T...

Page 304: ...rless 1 Support flickerless flickerlessaffect minexposure hidden mingain hidden or others x nonnegative integer product 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 ...

Page 305: ...defog 1 Support defog defog_strength 0 1 0 7 0 Non support tuning strength of defog 1 Support tuning strength of defog If capability_image_c 0 n 1 _def og_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 wdrpro unchanged or others x nonnegative integer product dependent 0 7 When defog is enabled some feat...

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

Page 307: ...r than 0 it means that the camera supports remotefocus function in this channel bit 0 Indicate whether to support both zoom and focus function bit 1 Only support zoom function bit 2 Only support focus function bit 3 Currently this is a 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 ...

Page 308: ...f iris value 0 7 Available total step for iris value We support this parameter when the version number httpversion is equal or greater than 0302a Only available when capability_image_c 0 n 1 _sen sortype 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 deinter...

Page 309: ...ide a choice of color palettes on the camera that help quickly distinguish thermal variations and patterns in an image The color tones correspond to the apparent surface temperatures of the target We support this parameter when the version number httpversion is equal or greater than 0310a palette_mode A list of palette options 0 7 Palette options used in thermal surveillance Only available when ca...

Page 310: ...stom script identification of this entry date string 4 20 6 6 Date of custom script time string 4 20 6 6 Time of custom script 7 29 Event setting Group event_i 0 n 1 n denotes the value of capability_nevent capability_nevent 0 PARAMETER VALUE SECURITY get set DESCRIPTION name string 40 6 6 Identification of this entry enable 0 1 6 6 Enable or disable this event priority 0 1 2 6 6 Indicate the prio...

Page 311: ...s string 40 6 6 The status for event trigger di 0 positive integer 6 6 Indicate the source id of di trigger This field is required when trigger condition is di One bit represents one digital input The LSB indicates DI 0 Only available when capability_ndi 0 mdwin 0 positive integer 6 6 Indicate the source window id of motion detection This field is required when trigger condition is md One bit repr...

Page 312: ... in minutes This field is used when trigger condition is seq weekday 0 127 6 6 Indicate which weekday is scheduled One bit represents one weekday bit0 LSB Saturday bit1 Friday bit2 Thursday bit3 Wednesday bit4 Tuesday bit5 Monday bit6 Sunday For example to detect events 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 we...

Page 313: ...y 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 _ena ble boolean 6 6 Enable or disable this server action action_server_i 0 4 _me dia NULL 0 4 101 6 6 Index of the attached media 101 means Recording Notify action_server_...

Page 314: ...zenabled 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 ...

Page 315: ...rt 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_address string 128 6 6 Email server address email_sslmode boolean 6 6 Enable support SSL email_port 0 65535 6 6 Port to connect to the server email_username string 64 6 6 Username to ...

Page 316: ...r when the version number httpversion is equal or greater than 0311c snapshot_source 0 capability_nmediastream 1 6 6 Indicate the source of media stream 0 means the first stream 1 means the second stream and etc 2 means 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 Snapsh...

Page 317: ...cate the source of media stream 0 means the first stream 1 means the second stream and etc 2 means the third stream and etc 3 means the fourth stream and etc videoclip_prefix string 16 6 6 Indicate the prefix of the filename videoclip_preevent 0 capability_media_videoclip_maxpre event 6 6 Indicates the time for pre event recording in seconds videoclip_maxduration 1 capability_media_videoclip_maxle...

Page 318: ...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 support this parameter w...

Page 319: ...ecording_enabled is enabled limitsize boolean 6 6 0 Entire free space mechanism 1 Limit recording size mechanism cyclic boolean 6 6 0 Disable cyclic recording 1 Enable cyclic recording notify boolean 6 6 0 Disable recording notification 1 Enable recording notification notifyserver 0 31 6 6 Indicate which notification server is scheduled One bit represents one application server server_i0 i4 bit0 L...

Page 320: ... size reserveamount 0 15000000 6 6 The reserved amount in Mbytes when choosing cyclic recording mechanism dest cf 0 4 6 6 The destination to store the recorded data cf means local storage CF or SD card 0 means the index of the network storage cffolder string 128 6 6 Folder name maxsize 100 2000 6 6 Unit Mega bytes When this condition is reached recording file is truncated maxduration 60 3600 6 6 U...

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

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

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

Page 324: ...64x64 then the win_i0_home 0 resolution_W 64 0 resolution_H 64 which the resolution is the value in current stream If the stream doesn t support ePTZ the permissions of this parameter must be set as 1 7 s 0 m 1 _size WxH product dependent 1 6 ROI width and height The width value must be multiples of 16 and the height value must be multiples of 8 The minimal window size is 64x64 and then resolution...

Page 325: ...able the ePTZ move smoothly feature tiltspeed 5 5 1 4 Tilt speed Only available when capability_fisheye is 1 1 7 Tilt speed It should be set by eCamCtrl cgi rather than by setparam cgi panspeed 5 5 1 4 Pan speed Only available when capability_fisheye is 1 1 7 Pan speed It should be set by eCamCtrl cgi rather than by setparam cgi zoomspeed 5 5 1 4 Zoom speed Only available when capability_fisheye i...

Page 326: ...eparated by patroldwelling string 160 1 4 The dwelling time unit second of each patrol point separated by preset_i 0 19 _name string 40 1 4 Name of ePTZ preset Only available when capability_fisheye is 1 1 7 Name of ePTZ preset It should be set by ePreset cgi rather than by setparam cgi preset_i 0 19 _pos W H product dependent 1 4 Left top corner coordinate of the preset Only available when capabi...

Page 327: ... 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_W...

Page 328: ...um 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 0311c enable Not recommended to use this boolean 1 7 Indicate whether seamless recording is recording to local storage or not at present Read only We replace this parameter with seamlessrecording_c 0 n 1 _triggerrecor d when...

Page 329: ...RAMETER VALUE SECURITY get set DESCRIPTION diskmode seamless manageable 1 6 seamless indicates enable seamless recording manageable indicates disable seamless recording maxconnection 3 1 7 Maximum number of connected seamless streaming triggerrecord boolean 1 7 Indicate whether seamless recording is recording to local storage or not at present Read only guid 0 k 1 _id string 127 1 7 The connected ...

Page 330: ...ring 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 size number string 128 6 7 This number is used to register license key for VADP application Group vadp_module_i 0 n 1 for n VADP package number capab...

Page 331: ...censemec string 40 6 7 Indicate the module use VIVOTEK license mechanism Group vadp_schedule_i 0 n 1 for n VADP package number n denotes 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...

Page 332: ...us 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 preset_i 0 k 1 _name string 40 1 4 Name of the preset location preset_i 0 k 1 _ dwelling 0 999 1 4 The dwelling time of each preset location uart 0 capability_nuart 1 1 4 Select corresponding uart capab...

Page 333: ...00bps camera ID 1 2 3 etc All Camera IDs on the same controlling system NVR or rs485 keyboard have to be distinct Therefore once you send a controlling signal each camera will only accept the inputs with the corresponding ID panspeed 5 5 1 4 Pan speed tiltspeed 5 5 1 4 Tilt speed zoomspeed 5 5 1 4 Zoom speed autospeed 5 5 1 4 Auto pan speed focusspeed 5 5 1 4 Auto focus speed focusmode auto onetim...

Page 334: ...rsion number httpversion is equal or greater than 0305b patrolseq string 120 1 4 For external device The indexes of patrol points separated by patroldwelling string 160 1 4 For external device The dwelling time of each patrol point separated by disablemdonptz boolean 1 4 Disable motion detection on PTZ operation defaulthome boolean 1 4 This field tells system to use default home position or not ax...

Page 335: ...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 a controlling signal each camera will only acc...

Page 336: ...which is essential and should be grouped with preset_i 0 k 1 _name We support this parameter when the version number httpversion is equal or greater than 0305b preset_i 0 k 1 _fliped boolean 1 4 Flip side at each preset location patrol_i 0 39 _name string 40 1 4 For internal device The name of patrol location patrol_i 0 39 _ dwelling 0 999 1 4 For internal device The dwelling time of each patrol l...

Page 337: ...hile idle over this time interval idle action will be taken zoomenhance boolean 1 4 Enable disable zoom enhancement tour_index 1 0 19 1 4 Index of the enabled tour group from 0 to 19 Set 1 to disable all the tour groups tour_i 0 19 _name string 40 1 4 Name of the tour tour_i 0 19 _type boolean 1 4 0 Recorded tour 1 Preset tour tour_i 0 19 _speed 5 5 1 4 Preset tour pan and tilt speed when moving b...

Page 338: ...driver enablehttptunnel boolean 1 4 Enable HTTP tunnel channel to control UART Group uart_i 0 n 1 n is uart port count capability_nuart 0 and capability_fisheye 0 NAME VALUE SECURITY get set DESCRIPTION baudrate 300 600 1200 2400 4800 9600 19200 38400 57600 11520 0 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 stopbi...

Page 339: ...D controlling external PTZ camera Note Please set your speed dome to the appropriate baud rate and Camera ID e g 2400bps camera ID 1 2 3 etc All Camera IDs on the same controlling system NVR or rs485 keyboard have to be distinct Therefore once you send a controlling signal each camera will only accept the inputs with the corresponding ID baudrate 2400 4800 9600 19 200 38400 57600 1 15200 4 4 Set b...

Page 340: ...efault_i0 it means choosen lens configuration is i0 lens of default group Group lens_default NAME VALUE SECURITY get set DESCRIPTION totalnumbers 0 positive integer 6 7 Totoal support number of the default lens profiles Group lens_user NAME VALUE SECURITY get set DESCRIPTION totalnumbers 0 positive integer 6 7 Totoal support number of the user lens profiles Group lens_default_i 0 n 1 n denotes the...

Page 341: ...RITY get set DESCRIPTION panspeed 5 5 integer 1 4 Pan speed of regional view tiltspeed 5 5 integer 1 4 Tilt speed of regional view zoomspeed 5 5 integer 1 4 Zoom speed of regional s 0 m 2 _panorama_ panstart 0 359 integer 1 4 Initial pan position of panorama view only available for 1P and 2P mode at ceiling or floor mount s 0 m 2 _region_pan 90 359 integer 1 4 Pan home angle of regional view Pan r...

Page 342: ...type 1 2 1 4 Type of object size 1 customized width and height 0 object size 30 x 30 1 object size 10 x 20 2 object size 10 x 10 objsize_customized_width 10 320 1 4 The minimum width of tracking target objsize_customized_height 10 240 1 4 The minimum height of tracking target sensitivity 0 2 1 4 Tracking sensitivity 0 Low 1 Medium 2 High 7 50 Wireless Group wireless capability_network_wireless 0 P...

Page 343: ...ncrypt is wep keyformat HEX ASCII 6 6 Key1 key4 presentation format Only valid when 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 ...

Page 344: ...l products n denotes the value of capability_nvideoin capability_shockalarm_support 0 PARAMETER VALUE SECURITY get set DESCRIPTION alarm_enable boolean 4 4 Enable shock detection s alarm alarm_level 1 100 4 4 The value indicate the support strength level of shock detection s alarm ...

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

Page 346: ...rivileges Method GET POST Syntax http servername cgi bin dido getdo cgi do0 do1 do2 do3 If no parameter is specified all the digital output statuses will be returned Return HTTP 1 0 200 OK r n Content Type text plain r n Content Length length r n r n do0 state r n do1 state r n do2 state r n do3 state r n where state can be 0 or 1 Example Query the status of digital output 1 Request http myserver ...

Page 347: ...urce resolution Available options are list in capability_videoin_c 0 n 1 _resolution Besides available options is referred to capability_videoin_c 0 n 1 _maxresolution and capability_videoin_c 0 n 1 _minresolution The resolution of the image quality 1 5 The quality of the image streamid 0 capability_nmediastream 1 The stream number The server will return the most up to date snapshot of the selecte...

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

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

Page 350: ... 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 operation there are two ways to control it scale zoom and area zoom 1 Scale zoom contains two control method rel...

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

Page 352: ...ion window size The resolution of streaming stretch boolean 0 indicates that it usesresolution streaming size as the range of the coordinate system 1 indicates that it usesvideosize plug in size as the range of the coordinate system speedpan 5 5 Set the pan speed speedtilt 5 5 Set the tilt speed speedzoom 5 5 Set the zoom speed speedapp 1 5 Set the auto pan patrol speed return return page Redirect...

Page 353: ...rn 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 10 ePTZ Preset Locations capability_eptz 0 and capability_fisheye 0 Note This request requires Operator privileges Method GET POST Syntax http servername cg...

Page 354: ...cgi bin admin ipfilter cgi type value http servername cgi bin admin ipfilter cgi method add v4 v6 ip ipaddress index value return return page http servername cgi bin admin ipfilter cgi method del v4 v6 index value return return page PARAMETER VALUE DESCRIPTION type NULL Get IP filter type allow deny Set IP filter type method addv4 Add IPv4 address into access list addv6 Add IPv6 address into acces...

Page 355: ...kie string 22 content type application x vvtk tunnelled pragma no cache cache control no cache content length 32767 expires Sun 9 Jam 1972 00 00 00 GMT User must use GET and POST to establish two channels for downstream and upstream The x sessioncookie in GET and POST should be the same to be recognized as a pair for one session The contents of upstream should be base64 encoded to be able to pass ...

Page 356: ...ation x vvtk tunnelled pragma no cache cache control no cache content length 32767 expires Sun 9 Jam 1972 00 00 00 GMT User must use GET and POST to establish two channels for downstream and upstream The x sessioncookie in GET and POST should be the same to be recognized as a pair for one session The contents of upstream should be base64 encoded to be able to pass through the proxy server This cha...

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

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

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

Page 360: ...r Optional Specifies how many rows to skip at the beginning of the matched records Note that the offset keyword is used after limit keyword To increase the flexibility of search command you may use OR connectors for logical OR search operations Moreover to search for a specific time period you can use TO connector Ex To search records triggered by motion or di or sequential and also triggered betw...

Page 361: ...update isLocked 1 label 1 label 5 Ex Update records whose key numbers are 2 and 3 to be unlocked status http servername cgi bin admin lsctrl cgi cmd update isLocked 0 label 2 label 3 Command queryStatus PARAMETER VALUE DESCRIPTION retType xml or javascript Optional Ex retype javascript The default return message is in XML format Ex Query local storage status and call for javascript format return m...

Page 362: ...e that when the virtual input is waiting for next state it cannot accept new requests return return page Redirect to the page return page after the parameter is assigned The return page should be the relative path according to the root of camera If you omit this parameter it will redirect to an empty page If the return page is invalid path it will ignore this parameter Return Code Description 200 ...

Page 363: ...am please refer to the TimeshiftCaching documents PARAMETER VALUE DEFAULT DESCRIPTION maxsft positive integer 0 Request cached stream at most how many seconds ago The value must be a positive integer 0 tsmode normal adaptive normal Streaming mode normal Full FPS all the time adaptive Default send only I frame for MP4 and H 264 and send 1 FPS for MJPEG If DI or motion window are triggered the strea...

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

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

Page 366: ...m_motor_start Start point of zoom motor remote_focus_zoom_motor_end End point of zoom motor remote_focus_focus_motor_start Start point of effective focal length remote_focus_focus_motor_end End point of effective focal length remote_focus_zoom_motor Current position of zoom motor remote_focus_focus_motor Current position of focus motor remote_focus_zoom_enable Current function of zoom motor remote...

Page 367: ...plied from function getstatus steps 1 motor_max Motor s moving steps It works only if function zoom or function focus and direction forward and direction backward motor_max is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from function getstatus This parameter is for additional fine tune the value is from 1 to 30 iris N A Open iris or not It works only if funct...

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

Page 369: ...ote_focus_focus_motor_start Start point of effective focal length remote_focus_focus_motor_end End point of effective focal length remote_focus_focus_motor Current position of focus motor remote_focus_focus_enable Current function of focus motor remote_focus_iris_open The current status of iris 0 irisenable 1 irisopen Current function of zoom focus motor return value as below 0 no service 1 zoomin...

Page 370: ... works only if function auto or function scan 8 22 Export Files Note This request requires Administrator privileges Method GET Syntax For daylight saving time configuration file http servername cgi bin admin exportDst cgi For language file http servername cgi bin admin export_language cgi currentlanguage value PARAMETER VALUE DESCRIPTION currentlanguage 0 20 Available language lists Please refer t...

Page 371: ...i Post data filename file name r n r n multipart encoded form data For language file http servername cgi bin admin upload_lan cgi Post data filename file name r n r n multipart encoded form data For setting backup file http servername cgi bin admin upload_backup cgi Post data filename file name r n r n multipart encoded form data Server will accept the file named file name to upload this one to ca...

Page 372: ...ate_lens cgi choose_lens value You need to reboot manually after you choose another lens configuration For choose selected lens configuration and reboot camera http servername cgi bin admin update_lens cgi choose_reboot_lens value The camera will reboot after using this cgi For delete selected lens configuration http servername cgi bin admin update_lens cgi delete_lens value PARAMETER VALUE DESCRI...

Page 373: ...MMDD_HHMMSS MMM N A End time length positive integer N A The length of media of interest The unit is second loctime boolean 0 Specify if start end time is local time format 1 for local time 0 for UTC 0 file string N A The media file to be played tsmode positive integer N A Timeshift mode the unit is second Ex stime etime length file Description V V X X Play recordings between stime and etime rtsp ...

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

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

Page 376: ...dit 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 3 resolution return...

Page 377: ...value speedtilt value speedzoom value speedapp value speedlink 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 704x480 vi deosize 704x480 strech 1 Example set the ptz preset with f...

Page 378: ...rol 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 coordinate of center after movement videosize window size The size of plug in ActiveX window in web page resolution window size The resolution of streaming stretch boolean 0 indicates that ...

Page 379: ...IPTION getversion string Get the version of the PTZ control module getaction idle autopan tracking tour patrol Get the current status of the camera We support this parameter when the version number getversion is equal or greater than 5 0 0 12 getpan 0 positive integer Get the current pan position Only available when bit0 of capability_camctrl_c 0 n 1 _buildinpt is 1 getpanangle integer Get the cur...

Page 380: ...ngle Only available when bit0 of capability_camctrl_c 0 n 1 _buildinpt is 1 getmaxpanangle integer Get the upper limit for pan angle Only available when bit0 of capability_camctrl_c 0 n 1 _buildinpt is 1 getmintilt 0 positive integer Get the lower limit for tilt position Only available when bit1 of capability_camctrl_c 0 n 1 _buildinpt is 1 getmaxtilt 0 positive integer Get the upper limit for til...

Page 381: ...GET Syntax http servername cgi bin viewer recall cgi recall value channel value return return page PARAMETER VALUE DESCRIPTION recall string 30 One of the present positions to recall channel 0 capability_nvideoin 1 Channel of the video source 8 30 Preset Locations capability_camctrl_c 0 n 1 _zoommodule 1 Note This request requires Operator privileges Method GET POST Syntax http servername cgi bin ...

Page 382: ...ld 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 31 SmartSD capability_localstorage_smartsd 0 Note This request requires Administrator privileges Method GET POST Syntax http servername cgi bin admin smartsd cgi function value PARAMETER VALUE DESCRIPTION ...

Page 383: ...e 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_failure Indicates how many time...

Page 384: ...VIVOTEK 384 User s Manual Method GET POST Syntax http servername cgi bin admin connect_ap cgi PARAMETER VALUE DESCRIPTION N A N A Apply the wireless settings and connect to AP ...

Page 385: ...SCRIPTION 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 34 Get wireless signal strength capability_network_wireless 0 Note This request requires Administrator privileges Method GET POST Syntax http servername cgi bin admin getwlsignalstrength cgi PARAMETER VALUE DESCRIPTION N A N ...

Page 386: ...hod 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 myserver cgi bin admin peripheral cgi channel 0 operation set washer_mode wiper washer_status on Response HTTP 1 0 200 OK r...

Page 387: ... ort 1 washer_dwelltime 15 999 Apply washer washer control system operation time including the time when spraying and wiper actions take place Only available when capability_peripheral_c 0 n 1 _washer_supp ort 1 heater_status auto automatic control the heater component to keep the device in a workable environment Only available when capability_peripheral_c 0 n 1 _heater_suppo rt 1 trigger heater c...

Page 388: ...A Get the support mode of washer control system its value is the same with capability_peripheral_ c 0 n 1 _washer_mode Only available when capability_peripheral_c 0 n 1 _washer_supp ort 1 washer_mode N A Get the current mode of washer control system It return the value of washer_mode Available values are listed in capability_peripheral_c 0 n 1 _washer_mod e washer_status N A Get the current status...

Page 389: ...A Get the current heater status Normally it will be auto it means the heater device is control by internal algorithm to keep in a suitable environment Otherwise is trigger it means the heater device is force enable to heat to an internal condition trigger status will be transfer to auto after reach the internal condition Only available when capability_peripheral_c 0 n 1 _heater_suppo rt 1 ...

Page 390: ...cally adjust the IR zone one 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 st...

Page 391: ...ideoin 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 strength when the ope...

Page 392: ...ength 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 control no cache r n Pragma no cache r n r n ERROR Must have the irmode manual argument Syntax for querying API http se...

Page 393: ... all adjustment mode that IR supports irmode N A Get the current IR control mode 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 End of document ...

Page 394: ... 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 395: ...nt off and on the user is encouraged to try to correct the interference by one or more of the following measures Reorient or relocate the receiving antenna Increase the separation between the equipment and receiver Connect the equipment into an outlet on a circuit different from that to which the receiver is connected Consult the dealer or an experienced radio TV technician for help Shielded inter...

Search results

Summary of Contents for IT9389 Series

Reviews:

Related manuals for IT9389 Series

Brands by name

Popular brands

Vivotek IT9389 Series, User Manual

Search results

Summary of Contents for IT9389 Series

Reviews:

Related manuals for IT9389 Series

Brands by name

Popular brands