background image

 

 

VIVOTEK

 

378 - User's Manual

© 2019 VIVOTEK INC. All Right Reserved

244 

 

8.21 BackFocus

 (capability_image_c<0~(n-1)>_remotefocus=4)

 

Note:

 This request requires Administrator privileges. 

Method:

 GET/POST 

 
Syntax: 
http://<

servername

>/cgi-bin/admin/remotefocus.cgi?function=<value>[&direction=<value>] 

[&position=<value>][&steps=<value>][&iris] 
 
PARAMETER 

VALUE 

DESCRIPTION 

Summary of Contents for FD9366-HV

Page 1: ...User s Manual 2MP Outdoor IP67 IK10 NEMA 4x Day Night WDR Pro Smart Stream III 20M Smart IR Fixed Dome Network Camera FD9366 HV Rev 1 0 ...

Page 2: ...ge layout 48 System Logs 51 System Parameters 53 System Maintenance 54 Media Image 58 Media Video 70 Media Video 71 Media Audio 80 Network General settings 81 Network Streaming protocols 88 Network SNMP Simple Network Management Protocol 97 Network FTP 98 Bonjour 99 Security User accounts 100 Security HTTPS Hypertext Transfer Protocol over SSL 102 Security Access List 109 PTZ PTZ settings 115 Even...

Page 3: ...ing the highest quality images in both low light and high contrast environments The onboard IR can provide illumination in total darkness With the Smart IR feature the firmware automatically adjusts the IR intensity for objects that came too close in order to avoid over exposure The camera supports WDR function at the effectiveness of up to 120dB These models support local video stroage on the Mic...

Page 4: ...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 general security surveillance etc The Configuration chapter suggests ways to best utilize the Network Camera and ensure proper operations For creative and professional developers the URL Commands of the Network Camera section serves as...

Page 5: ...ide DI DO terminal blocks T10 star driver Waterproof cable gland 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 hom...

Page 6: ... 6 User s Manual Dome cover RJ45 Ethernet connector Outer View Inner View Physical Description MicroSD card slot Lens IR LEDs Microphone Ground connection Audio line in DI DO connection Gimball retention screw ...

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

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

Page 9: ...K User s Manual 9 3 Connect the DI DO and audio line in wires Name DO 5V max 50mA GND DI any input 30V DI GND Name Audio Line IN GND to ground 4 Connect the ground wire to an appropriate grounding connection ...

Page 10: ... Install a MicroSD card if onboard storage is preferred Avoid touching the circuit board to prevent the damage from electro static discharge If available it is recommended to wear an anti static wrist band ESD 2 5 6 G B 1 0 I 1 ...

Page 11: ...the connections are waterproof by applying putties or tapes to seal the connections 5 5 6 4mm 7 Pass an Ethernet cable through the waterproof cable gland components and through the rubber seal as shown below Connect the Ethernet cable to the camera s RJ45 connector ...

Page 12: ...IVOTEK 12 User s Manual 9 Use the alignment sticker to drill mounting holes on the wall or ceiling Drill a cabling routing hole if preferred 8 Install the seal ring and tighten the waterproof components ...

Page 13: ...VIVOTEK User s Manual 13 Ø 18 mm Ø 4mm 10 Install the camera to wall using the included screws 11 Route cables through the routing hole ...

Page 14: ...VIVOTEK 14 User s Manual 12 Secure the camera to wall or ceiling using the included M3 screws M3 Please do not loosen these screws These screws are used as assembly components ...

Page 15: ... the bend radius if you need to pass it through a narrow space Do not fold the cable 13 Please visit VIVOTEK s website to Install the Shepherd software utility The program will search for VIVOTEK Video Receivers Video Servers or Network Cameras on the same LAN Double click on the camera s MAC address to open a web console to the camera LAN PoE Browser Shepherd IEEE 802 3af ...

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

Page 17: ... 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 one printed on the product label You can then doub...

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

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

Page 20: ...VIVOTEK 20 User s Manual 15 With a live view on your computer rotate pan or tilt the camera until you acquire an optimal field of view 90 90 180 bottom top 0 ...

Page 21: ...all the dome cover Note that you should carefully fit the tether wire in case it will get in the way between the top cover and the edge of camera main body 16 Replace the desiccant from the inside of the dome cover 1 2 6 5 0 4 Kgf cm ...

Page 22: ...VIVOTEK 22 User s Manual 18 Remove the protective sheet from the dome cover IR 70 100 20M Below is the coverage range of the IR illuminator ...

Page 23: ...User s Manual 23 If the need should arise you can rotate your image For example if you install the camera on a wall and you need to cover a long narrow corridor Configuration Media Image General Settings 90 270 ...

Page 24: ...peration MicroSD SDHC SDXC Card Capacity This network camera is compliant with MicroSD SDHC SDXC 16GB 8GB 32GB 64GB 128GB and other preceding standard SD cards LED Definitions Item LED status Description LED De finitions 1 Steady Red Powered and system booting or network failed Red LED off Power off Green LED off Network is disconnected 2 Steady Red and Green LED blinks every 1 sec Connected to ne...

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

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

Page 27: ...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 28: ... 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 29: ...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 30: ...tection please refer to Security on page 100 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 31: ...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 32: ... please set the RTSP port to 554 For more information please refer to RTSP Streaming on page 89 For example 4 The live video will be displayed in your player For more information on how to configure the RTSP access name please refer to RTSP Streaming on page 88 for details rtsp 192 168 5 151 554 live1s1 sdp 1 Launch the RTSP player 2 Choose File Open URL A URL dialog box will pop up 3 The address ...

Page 33: ...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 70 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 34: ...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 35: ...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 70 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 36: ...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 37: ...tion on page 115 For more information about how to set up the viewing region of the current video stream please refer to page 115 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 115 for detailed i...

Page 38: ...lick 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 41 for details Volume When the Mute function is not activated move the slider bar to adjust the volume on the local ...

Page 39: ...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 40: ... This protocol allows multicast enabled routers to forward network packets to all clients requesting streaming media This helps to reduce the network transmission load of the Network Camera while serving multiple clients at the same time Note that to utilize this feature the Network Camera must be configured to enable multicast streaming at the same time For more information please refer to RTSP S...

Page 41: ...ur local hard disk Add date and time suffix to the file name Select this option to append the date and time to the end of the file name Local Streaming Buffer Time In the case of encountering unsteady bandwidth live streaming may lag and video streaming may not be very smoothly If you enable this option the live streaming will be stored temporarily on your PC s cache memory for a few milli seconds...

Page 42: ...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 43: ... 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 44: ... 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 45: ...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 46: ...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 47: ... 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 48: ...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 49: ...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 50: ... 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 51: ...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 52: ...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 Access log Access log displays the access time and IP address of all viewers including operators and administrators in a chronological order The access log is stored in the Network Camera s buffer ...

Page 53: ...If you need technical assistance please provide the information listed on this page VADP log The VADP log displays information for the pre loaded VADP module such as the TrendMicro IoT security package The information includes package size activation time memory size taken records of automated updates etc ...

Page 54: ...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 55: ...settings VADP Retain the VADP modules 3rd party software stored on the SD card and related settings 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 configuration file Click to set the start and end time of DST Daylight Saving Follow the steps below to export 1 In the...

Page 56: ...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 57: ... 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 58: ...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 59: ...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 60: ... the sensor to accept infrared light thus helping to improve low light sensitivity Synchronize with digital input If an external IR device is connected that comes with its own light sensor you can use a digital input from it to trigger the IR cut filter Doing so can synchronize the detection of light level between the camera and the external IR device Schedule mode The Network Camera switches betw...

Page 61: ...f your interest is close to the lens and the IR lights For example if an intruder has a chance of getting near the range of 3 meters Smart IR can effectively reduce the over exposure For a surveillance area at a greater distance e g 5 meters or farther away the Smart IR function may not bring as significant benefits as in close range Anti overexposure When enabled the camera automatically adjusts ...

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

Page 63: ...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 64: ...apply to Day mode Night mode or Schedule mode Please manually enter a range of time if you choose the Schedule mode Then check Save to take effect Noise reduction Enable noise reduction Check to enable noise reduction in order to reduce noises and flickers in image This applies to the onboard 3D Noise Reduction feature Use the slide bar to adjust the reduction strength Note that applying this func...

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

Page 66: ...usive window An exposure value will then 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 cente...

Page 67: ...lar pointers on the Exposure time and Gain control slide bars to specify a range of shutter time and Gain control values within which the camera can automatically tune to an optimal imaging result 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 You can click and drag...

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

Page 69: ...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 70: ...am 2 is set to the 640 x 360 Stream 3 The default frame size for Stream 3 is set to the 1920 x 1080 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 71: ...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 72: ...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 73: ... 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 74: ...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 75: ...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 76: ...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 77: ...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 78: ...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 79: ...her 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 15fps and 20fps If the power line frequency is set to 60Hz the frame rates are selectable at 1fps 2fps 3fps 5fps 8fps 10fps 15fps and 20fps You can also select Customize and manually enter a value The frame rate will decrease if you select a higher res...

Page 80: ... of the external audio input according to ambient conditions Adjust the gain from 0 to 100 External 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 c...

Page 81: ...DHCP server 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 s Shepherd utility to easily set up the Network Camera on LAN Please refer to Software Installation on page 16 for details 2 Enter the Static IP Subnet mask Default router and Primary DNS provided by your ISP or ...

Page 82: ... 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 83: ...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 84: ...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 85: ... 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 86: ... format Please refer to HTTP streaming on page 88 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 87: ...VIVOTEK User s Manual 87 ...

Page 88: ...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 89: ...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 90: ...le when the access name for stream 1 is set to live1s1 sdp 1 Launch an RTSP player 2 Choose File Open URL A URL dialog box will pop up 3 Type the above URL command in the text box 4 The live video will be displayed in your player as shown below rtsp 192 168 5 151 554 live1s1 sdp QuickTime 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 ...

Page 91: ...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 92: ...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 93: ...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 94: ... 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 95: ...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 96: ...them a particular forwarding treatment for example how much bandwidth to reserve for it Below are the setting options of DSCP DiffServ Codepoint Specify the DSCP value for each application 0 63 Note that different vendors of network devices might have different methodologies and unique implementations Shown below is a sample corresponding information from a Cisco switch You should enter a DSCP tag...

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

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

Page 100: ...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 101: ...elect the checkboxes and then click Save to enable the settings If you give Viewers the privilege Operators will also have the ability to control the Network Camera through the main page Allow anonymous viewing If you select this item any client can access the live stream without entering a User ID and Password Privilege management ...

Page 102: ...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 103: ...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 104: ...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 105: ...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 106: ... 106 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 107: ... 107 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 108: ... 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 109: ... 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 110: ...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 111: ... 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 112: ...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 113: ...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 114: ...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 115: ...Z Operation The e PTZ control settings section will be displayed as shown below For e PTZ related details please refer to page 117 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 116: ...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 117: ...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 118: ...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 119: ...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 120: ...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 detection mechanism as a trigger source To enable this function you need to configure a Motion Detection Window first For more information please...

Page 121: ...to page 137 for detailed information Manual Triggers This option allows users to enable event triggers manually by clicking the on off button on the homepage Please configure 1 to 3 associated events before using this function VADP It is presumed that you already uploaded and enabled the VADP modules before you can associatee VADP triggers with an Event setting Click on the Set VADP Trigger button...

Page 122: ...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 123: ...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 124: ...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 125: ...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 126: ...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 148 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 127: ...orded data Click to go back to the previous level of the directory The format is HH 24r Click to open the file list for that hour The format is File name prefix Minute mm You can set up the file name prefix on Add media page Please refer to next page for detailed information 2020 01 20 2020 01 20 2020 01 20 2020 01 20 ...

Page 128: ...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 129: ...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 130: ...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_20200513_100341 Date and time suffix The format is YYYYMMDD_HHMMSS File name prefix ...

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

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

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

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

Page 136: ...rk Camera to an external device to detect the current connection status Digital output Select Grounded or Open to define the normal status for the digital output Connect the digital output pin of the Network Camera to an external device to determine the current status Set up the event source as DI on Event Event settings Trigger Please refer to page 126 for detailed information ...

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

Page 140: ...ml 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 of your 3rd party module for the parameters contained within Users can also run VIVOTEK s VADP packages as a means to access updated functionality instead of replacing the entire firmware Note that for some cameras t...

Page 141: ...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 142: ...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 143: ...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 144: ...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 145: ...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 146: ...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 147: ...on about folder naming rules please refer to page 126 for details 20200210 20200211 20200212 f you want to enable recording notification please click Event to configure event triggering settings Please refer to Event Event settings on page 119 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 148: ...his column shows the status and reserved space of your SD card Please remember to format the SD card when using for the first time no SD card NOTE It is recommended to turn OFF the recording activity before you remove an SD card from the camera The lifespan of an SD card is limited Regular replacement of the SD card can be necessary Camera filesystem takes up several megabytes of memory space The ...

Page 149: ... to retain a file For example if you enter 7 days the recorded files will be stored on the SD card for 7 days Click Save to enable your settings NAS management On the NAS setup page you can configure your NAS Networked Storage configuration test mount or unmount the networked storage You can use the Test button to check the setting The result will be shown in the pop up window Network storage path...

Page 150: ...1GB for a network share Enable cyclic storage Check this item if you want to enable cyclic recording When the maximum capacity is reached the oldest file will be overwritten by the latest one Enable automatic disk cleanup Check this item and enter the number of days you wish to retain a file For example if you enter 7 days the recorded files will be stored on the network share for 7 days Click Sav...

Page 151: ...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 attributes Select one or more items as your search criteria Trigger time Manually enter the time range you want to search for contents created at a specific point in time Click Search and the recorded data correspon...

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

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

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

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

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

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

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

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

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

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

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

Page 167: ...conds reset 0 positive integer 7 6 Restart the server after value seconds if value is non negative restoreexceptnet 0 positive integer 7 6 Restore the system parameters to default values except ipaddress subnet router dns1 dns2 pppoe This command can cooperate with other restoreexceptXYZ commands When cooperating with others the system parameters will be restored to the default value except for a ...

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

Page 169: ...7 ODM specific model name of server eg DCS 5610 If it is not an ODM model this field will be equal to modelname serialnumber mac address 1 7 12 characters MAC address without hyphens firmwareversion string 40 0 7 Firmware version including model company and version number in the format MODEL BRAND VERSION language_count positive integer 0 7 Number of webpage languages available on the server langu...

Page 170: ...E VALUE SECURITY get set DESCRIPTION di_i 0 capability_ndi 1 product dependent boolean 1 7 0 Inactive normal 1 Active triggered capability_ndi 0 do_i 0 capability_ndo 1 product dependent boolean 1 7 0 Inactive normal 1 Active triggered capability_ndo 0 onlinenum_rtsp 0 positive integer 6 7 Current number of RTSP connections onlinenum_httppush 0 positive integer 6 7 Current number of HTTP push serv...

Page 171: ... 1 7 3Digital Input Behavior Define Group di_i 0 n 1 for n is the value of capability_ndi capability_capability_ndi 0 NAME VALUE SECURITY get set DESCRIPTION normalstate high low 1 1 Indicates open circuit or closed circuit inactive status 7 4Digital Output Behavior Define Group do_i 0 n 1 for n is the value of capability_ndo capability_ndo 0 NAME VALUE SECURITY get set DESCRIPTION normalstate ope...

Page 172: ..._privilege view operator admin 6 7 Root privilege user_i 1 20 _ privilege view operator admin 6 6 User privilege 7 6Network Group network NAME VALUE 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 cha...

Page 173: ...oot 0 Use preset ipaddress subnet rounter dns1 and dns2 ipaddress ip address 6 6 IP address of server subnet ip address 6 6 Subnet mask router ip address 6 6 Default gateway dns1 ip address 6 6 Primary DNS server dns2 ip address 6 6 Secondary DNS server wins1 ip address 6 6 Primary WINS server wins2 ip address 6 6 Secondary WINS server 7 6 1 802 1x Subgroup of network ieee8021x capability_protocol...

Page 174: ...lled flag for TLS privatekey_time 0 positive integer 6 7 Private key installed time Represented in EPOCH privatekey_size 0 positive integer 6 7 Private key file size in bytes 7 6 2 QOS Subgroup of network qos_cos capability_protocol_qos_cos 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable disable CoS IEEE 802 1p vlanid 1 4095 6 6 VLAN ID video 0 7 6 6 Video channel for CoS audio...

Page 175: ...PV6 Subgroup of network ipv6 capability_protocol_ipv6 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable IPv6 addonipaddress ip address 6 6 IPv6 IP address addonprefixlen 0 128 6 6 IPv6 prefix length addonrouter ip address 6 6 IPv6 router address addondns ip address 6 6 IPv6 DNS address allowoptional boolean 6 6 Allow manually setup of IP address setting 7 6 4 FTP Subgroup of netw...

Page 176: ...m capability_protocol_spush_mjpeg 1 and capability_nmediastream 0 The value are shown as video1s1 mjpg c0_s0_accessname channel1stream1 video1s2 mjpg c0_s1_accessname channel1stream2 video1s3 mjpg c0_s2_accessname channel1stream3 video1s4 mjpg c0_s3_accessname channel1stream4 etc We replace this parameter with network_http_c 0 capability_nvideoin 1 _s 0 capability_nmediastream 1 _ accessname when ...

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

Page 178: ...ct dependent string 32 1 6 RTSP access name for channel stream N N 1 capability_nmediastream capability_protocol_spush_mjpeg 1 and capability_nmediastream 0 The value are shown as live1s1 sdp c0_s0_accessname channel1stream1 live1s2 sdp c0_s1_accessname channel1stream2 live1s3 sdp c0_s2_accessname channel1stream3 live1s4 sdp c0_s3_accessname channel1stream4 etc 7 6 9 RTSP Multicast Subgroup of net...

Page 179: ...udio IP address We support this parameter when the version number httpversion is equal or greater than 0304a Only available when capability_naudioin 0 metadataipaddres s ip address 4 4 Multicast metadata IP 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 Mul...

Page 180: ... 0 NAME VALUE SECURITY get set DESCRIPTION user string 128 6 6 PPPoE account user name pass password 64 7 6 PPPoE account password 7 7IP Filter Group ipfilter NAME VALUE SECURITY get set 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_protoc ol_maxconnecti...

Page 181: ...lable values are listed in capability_image_ c 0 n 1 _wbmo de 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 upd...

Page 182: ...1 3 3 EV 1 0 4 EV 0 7 5 EV 0 3 6 EV 0 7 EV 0 3 8 EV 0 7 9 EV 1 0 10 EV 1 3 11 EV 1 7 12 EV 2 0 Only available when capability_image_c 0 n 1 _exposu re_mode 0 irismode fixed indoor outdoor product independent 4 4 Control DC Iris mode outdoor Auto setting DC Iris to get best quality but easy to meet rolling or flicker effect in indoor environment indoor Avoid rolling and flicker effect first fixed O...

Page 183: ...irror the image rotate 0 90 180 270 1 4 The rotation angle of image Support only in Rotation mode Only available when capability_videoin_c 0 n 1 _rotatio n 1 ptzstatus Not support anymore 0 positive integer 1 7 A 32 bit integer each bit can be set separately as follows Bit 0 Support camera control function 0 not support 1 support Bit 1 Built in or external camera 0 external 1 built in Bit 2 Suppor...

Page 184: ...manual or irismode fixed Only available when capability_image_c 0 n 1 _exposu re_rangetype is twovalues maxexposure product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_ c 0 n 1 _exposu re_maxrange 4 4 Maximum exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc This parameter may also restrict image frame ra...

Page 185: ...ed 51 NAME VALUE SECURITY get set DESCRIPTION capability_image_c 0 n 1 _exposu re_rangetype is twovalues enablepreview boolean 1 4 Usage for UI of exposure settings Preview settings of video profile Only available when capability_image_c 0 n 1 _exposu re_mode 0 ...

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

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

Page 188: ...ter Speed and keep adjusting Iris Gain automatically irispriority Manually adjust with variable Iris and keep adjusting Gain and Shutter speed automatically qualitypriority Automatically adjust the Iris Gain and Shutter Speed by VIVOTEK quality algorithm manual Manually adjust with variable Shutter Iris and Gain We support this parameter when the version number httpversion is equal or greater than...

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

Page 190: ...imum gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_mi ngain Only valid when piris_mode manual or irismode fixed Normalized range Only available when capability_image_c 0 n 1 _exposu re_rangetype is twovalues gainvalue 0 100 4 4 Gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_m axgain and capability_image_c 0 n 1 _exposu re_rangetype is onev...

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

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

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

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

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

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

Page 197: ...rioritypoli cy framerate imagequality 4 4 Set prioritypolicy Only valid when h264_ratecontrolmode cbr s 0 m 1 _h2 64_maxframe 1 capability_videoin_c 0 n 1 _h264_maxframera te 1 4 The maximum frame rates of a H264 stream at different resolutions capability_videoin_c 0 n 1 _resolution are recorded in capability_videoin_c 0 n 1 _h264 _maxframerate s 0 m 1 _h2 64_profile 0 2 1 4 Indicate H264 profiles...

Page 198: ...ability_videoin_codec s 0 m 1 _h2 65_ratecontrol mode cbr vbr 4 4 cbr Constant bit rate mode vbr Fixed quality mode all frames are encoded in the same quality Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h2 65_quant 1 5 99 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality level in qpercent 99 Use the quality l...

Page 199: ...e maximum allowed bit rate in fixed quality mode When the bit rate exceeds this value frames will be dropped to restrict the bit rate Only available when h265 is listed in capability_videoin_codec Only valid when h265_ratecontrolmode vbr s 0 m 1 _h2 65_cbr_quant 1 5 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality level in cbr_qpercent...

Page 200: ...ality 4 4 Set prioritypolicy Only available when h265 is listed in capability_videoin_codec Only valid when h265_ratecontrolmode cbr s 0 m 1 _h2 65_maxframe 1 capability_videoin_c 0 n 1 _h265_maxframera te 1 4 The maximum frame rates of a H265 stream at different resolutions capability_videoin_c 0 n 1 _resolution are recorded in capability_videoin_c 0 n 1 _h265 _maxframerate Only available when h2...

Page 201: ...et the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality level in qpercent 99 Use the quality level in qvalue s 0 m 1 _mj peg_qvalue 10 200 Only valid when capability_api_httpversio n format is XXXXX_1 or XXXXX_3 or XXXXX_4 ex 0301a_1 or 0301a_3 or 0301a_4 or 1 99 Only valid when capability_api_httpversio n format is XXXXX_2 ex 0301a_2 product dependen...

Page 202: ..._ratecontrolmode vbr s 0 m 1 _mj peg_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 valid when mjpeg_ratecontrolmode cbr Only available when capability_smartstream_version 2 0 s 0 m 1 _mj peg_cbr_qperc ent 1 100 4 4 Select customized quality in a normalized full range 1 Worst quality 100 Best ...

Page 203: ...t boolean 1 4 Change resolution to fit 4 3 ratio For PAL D1 4CIF 720 704x576 768x576 CIF 352x288 384x288 For NTSC D1 4CIF 720 704x480 640x480 CIF 352x240 320x240 Only available when capability_videoin_type is 0 or 1 wdrpro_mode product dependent boolean 4 4 Enable WDR pro Only available when capability_image_c 0 n 1 _wdrpro _mode 0 wdrpro_streng th product dependent 1 100 4 4 The strength of WDR P...

Page 204: ...1 100 4 4 The speed level of AE converge speed 1 20 level 1 21 40 level 2 41 60 level 3 61 80 level 4 81 100 level 5 Level 1 4 low high The higher speed level meas shorter AE converged time during AE executing Only available when capability_image_c 0 n 1 _aespee d is 1 aespeed_sensi tivity product dependent 1 100 4 4 The sensitivity of AE converge speed 1 20 level 1 21 40 level 2 41 60 level 3 61 ...

Page 205: ... 1P 2P 1R 4R for ceiling floor mount 1O 1P 1R 4R for wall mount product dependent 1 4 Local dewarp mode 1O is original mode disable Supported dewarp mode is different by mount type videoin_c 0 n 1 _mounttype Supported mode list could be extracted from capability_videoin_c 0 n 1 _locald ewarp_typeceilingmount and capability_videoin_c 0 n 1 _locald ewarp_typewallmount Only available when capability_...

Page 206: ...uality of ROI is better than the non ROI areas The level is from 1 to 5 Level 5 is the maximum level of the quality difference between the ROI and non ROI areas If the value is a negative number the video quality of non ROI areas is better than the ROI The level is from 1 to 5 Level 5 is the maximum level of the quality difference between the ROI and non ROI areas Group videoin_c 0 n 1 _s 0 m 1 _h...

Page 207: ...n denotes the value of capability_nvideoin and m denotes the value of capability_nvideoinprofile capability_nvideoinprofile 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable disable this profile setting policy night schedule 4 4 The mode which the profile is applied to Not support policy day anymore when the version number httpversion is equal or greater than 0301a begintime hh m...

Page 208: ...er exposure time Ex If this is set to 1 5s 1 8000s and camera takes 1 5s on the night then sensor only outputs 5 frame s Only available when capability_image_c 0 n 1 _exposu re_maxrange Only valid when piris_mode manual or irismode fixed Only available when capability_image_c 0 n 1 _exposu re_rangetype is twovalues shuttervalue product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is...

Page 209: ...ion is equal or greater than 0302a 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 n _mode to switch on off BLC exposurelevel 0 12 4 4 Exposure level 0 12 This range takes the concept from DC s exposure tuning options The definition is ...

Page 210: ...tically 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_c0_exposure_mod e 0 whitebalance product dependent auto panorama manual rbgain widerange outdoor indoor s...

Page 211: ...iumauto sodium vapor lamps Only available when capability_image_c 0 n 1 _wbmo de rgain 0 100 4 4 Manual set rgain value of gain control setting 0 Weak 100 Strong Only available when rbgain is listed in capability_image_c 0 n 1 _wbmo de Only valid when videoin_c 0 n 1 _whitebalance auto Normalized range bgain 0 100 4 4 Manual set bgain value of gain control setting 0 Weak 100 Strong Only available ...

Page 212: ...100 High Only available when capability_image_c 0 n 1 _agc_mi ngain Only valid when piris_mode manual or irismode fixed Normalized range Only available when capability_image_c 0 n 1 _exposu re_rangetype is twovalues gainvalue 0 100 4 4 Gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_m axgain and capability_image_c 0 n 1 _exposu re_rangetype is onevalue Normalized range ...

Page 213: ...o 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 1 _sensor type is smartsensor Only available when capability_image_c 0 n 1 _iristype piris piris_position product dependent 1 100 1 4 Manual set P Iris 1 Open 100 Close Onl...

Page 214: ...he stronger strength of WDR Pro Only available when capability_image_c 0 n 1 _wdrpro _strength is 1 wdrc_mode product dependent boolean 4 4 Enable WDR enhanced Only available when capability_image_c 0 n 1 _wdrc_ mode is 1 wdrc_strength product dependent 1 100 4 4 The strength of WDR enhanced The bigger value means the stronger strength of WDR enhanced Only available when capability_image_c 0 n 1 _...

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

Page 216: ...me 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 auto day night di schedule etc Available values are listed in capability_daynight_ c 0 n 1 _mode product dependent 6 6 Set IR cut control mode sir product dependent boolean 6 6 Enable disable Sma...

Page 217: ...daynight_c 0 capability_ nvideoin 1 _builtinwled 0 bwmode boolean 6 6 Switch to B W in night mode if enabled Only available when capability_daynight_c 0 n 1 _ blackwhitemode is 1 sensitivity low normal high 1 10 0 6 6 Sensitivity of day night control There are two value format low normal high if capability_daynight_c 0 n 1 _ircuts ensitivity_type options 1 100 if capability_daynight_c 0 n 1 _ircut...

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

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

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

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

Page 222: ...e patrolling 0 disable 1 enable Only available when capability_image_c 0 n 1 _freeze is 1 deinterlace_enable boolean 4 4 Enable disable deinterlace function 0 disable 1 enable Only available when capability_image_c 0 n 1 _deinter lace_support is 1 deinterlace_mode spatial blend 4 4 Users can choose between two different deinterlacing techniques Spatical mode provides the best image quality while B...

Page 223: ...orrection Only available when capability_image_c 0 n 1 _lens_ld c_support is 1 palette_mode Available value is listed in capability_image_c 0 n 1 _palette_mo de 1 4 Set color palette option Only available when capability_image_c 0 n 1 _palette _support is 1 Not support policy day anymore when the version number httpversion is equal or greater than 0310a profile_i 0 m 1 _enable boolean 4 4 Enable d...

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

Page 225: ...e_c 0 n 1 _basicse tting is 1 We replace profile_i0_saturation with profile_i0_saturationpercent This parameter will not be used after the version number httpversion is equal or greater than 0400a profile_i 0 m 1 _brightnesspercent 0 100 4 4 Set brightness in the normalized range 0 Darker 100 Bright Only available when bit 0 of capability_image_c 0 n 1 _basicse tting is 1 profile_i 0 m 1 _contrast...

Page 226: ... Gamma value 0 02 3 Gamma value 0 03 100 Gamma value 1 Note Although we set gamma value to 100 level but not all gamma values are valid Internal module will take the closest valid one For example 1 45 may all be mapped to gamma value 0 45 etc Only available when capability_image_c 0 n 1 _gamm acurve is 1 profile_i 0 m 1 _lowlightmode product dependent boolean 4 4 Enable disable low light mode Only...

Page 227: ...endent 1 100 4 4 Strength of defog Only available when capability_image_c 0 n 1 _defog_ mode is 1 profile_i 0 m 1 _eis_mode product dependent boolean 4 4 Electronic image stabilizer 0 disable 1 enable Only available when eis is listed in capability_image_c 0 n 1 _is_mod e profile_i 0 m 1 _eis_strength product dependent 1 100 4 4 Strength of electronic image stabilizer Only available when eis is li...

Page 228: ... Back Light Compensation and the only exposure window is located at the center of view hlc Use HLC High Light Compensation and to perform the masking of bright light area center Use Center window as metering area and give the necessary light compensation Group exposurewin_c 0 n 1 _win_i 0 k 1 n denotes the value of capability_nvideoin k denotes the value of capability_image_c 0 n 1 _exposure_winnu...

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

Page 230: ... Light Compensation and the only exposure window is located at the center of view hlc Use HLC High Light Compensation and to perform the masking of bright light area center Use Center window as metering area and give the necessary light compensation Group exposurewin_c 0 n 1 _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 v...

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

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

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

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

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

Page 236: ..._nvideoin NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable motion detection win_sensitivity 0 100 4 4 Sensitivity of all motion detection windows The value 0 is reserved for compatibility and will not be used after the version number httpversion is equal or greater than 0400a Group motion_c 0 n 1 _win_i 0 k 1 n denotes the value of capability_nvideoin k denotes the value of capabi...

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

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

Page 239: ...al or greater than 0301a begintime hh mm 4 4 Begin time of schedule mode endtime hh mm 4 4 End time of schedule mode win_sensitivity 0 100 4 4 Sensitivity of all motion detection windows The value 0 is reserved for compatibility and will not be used after the version number httpversion is equal or greater than 0400a Group motion_c 0 n 1 _profile_i 0 m 1 _win_i 0 k 1 for m profile and n channel pro...

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

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

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

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

Page 244: ...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 information 0 LOG_EMERG 1 LOG_ALERT 2 LOG_CRIT 3 LOG_ERR 4 LOG_WARNING 5 LOG_NOTICE 6 LOG_INFO 7 LOG_DEBUG setparamlevel ...

Page 245: ...g 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 encrypttypero DES 6 6 Read only encryptio...

Page 246: ..._show boolean 1 6 Show or hide manual trigger VI button in homepage 0 Hidden 1 Visible theme_option 1 4 1 6 1 3 One of the default themes 4 Custom definition theme_color_font string 7 1 6 Font color theme_color_configfont string 7 1 6 Font color of configuration area theme_color_titlefont string 7 1 6 Font color of video title theme_color_controlba ckground string 7 1 6 Background color of control...

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

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

Page 249: ...apability_ptz_c 0 n 1 _mintilt capability_ptz_c 0 n 1 _maxtilt 4 4 Tilt position of window position Only available when bit1 of capability_camctrl_c 0 n 1 _ buildinpt is 1 win_i 0 m 1 _zoom capability_ptz_c 0 n 1 _minzoom capability_ptz_c 0 n 1 _maxzoom 4 4 Zoom position of window position win_i 0 m 1 _fliped boolean 4 4 Flip side of window position 0 Non flip side 1 Flip side ...

Page 250: ...ld 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 Major version Increase the minor version when add new features interfaces without change the old features and interfaces Minor version Increase the revision when fix bugs without change any features of the output Revis...

Page 251: ...on of 0301a_1 we will fix them and change this API value to 0301b_1 bootuptime positive integer 0 7 Server bootup time nir Not support anymore 0 positive integer 0 7 Number of IR interfaces Recommand to use capability_daynight_c 0 capability_ nvideoin 1 _builtinir for built in IR and capability_daynight_c 0 capability_ nvideoin 1 _externalir for external IR Not support this parameter anymore when ...

Page 252: ... Not support this parameter anymore when the version number httpversion is equal or greater than 0301a We replace naudiosetting with naudioin More details please refer the parameter description of volume_internal and volume_external nuart 0 positive integer 0 7 Number of UART interfaces nmotion positive integer 0 7 The number of motion window nmotionprofile 0 positive integer 0 7 Number of motion ...

Page 253: ... 485 interface is supported or SD PZ PT PD video server series Bit 5 only available when bit0 is 1 Support focus operation 0 not support 1 support only available when RS 485 interface is supported or SD PZ PT PD video server series Bit 6 only available when bit0 is 1 Reserved bit always 0 Bit 7 only available when bit0 is 1 External or built in PT 0 built in 1 external windowless boolean 0 7 Indic...

Page 254: ...for compatibility and will not be used after the version number httpversion is equal or greater than 0400a We replace capability_remotefocus with capability_image_c0_remotefocus npreset 0 positive integer 0 7 Number of preset locations presettourdirection boolean 0 7 Indicate whether to support preset tour direction function It means users can choose which direction the preset tour goes We support...

Page 255: ...pport ePTZ or not The 2nd bit of the group indicates 2nd stream of a channel support ePTZ or not and so on For most products the last stream of a channel will not support ePTZ It is reserved for full view of the channel For some dual stream products both streams support ePTZ nanystream 0 positive integer 0 7 number of any media stream per channel iva boolean 0 7 Indicate whether to support Intelli...

Page 256: ...0 7 Indicate whether to support adaptive streaming supporttriggertype s seq boot motion netw orkfail recnotify tamp ering vi vadp di volala rm temperature pir visignal backup smartsd shockalarm virestore 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 network connection failure recn...

Page 257: ...nc onnection Not support anymore positive integer 0 7 The maximum general streaming connections Not support this parameter anymore when the version number httpversion is equal or greater than 0311c protocol_rtp_multi cast_scalable boolean 0 7 Indicate whether to support scalable multicast protocol_rtp_multi cast_backchannel boolean 0 7 Indicate whether to support backchannel multicast protocol_rtp...

Page 258: ...y_videoin_c0_resolution This is kept for compatibility videoin_maxframer ate A list of Integer 0 7 This equals capability_videoin_c0_maxframerate This is kept for compatibility videoin_mjpeg_ma xframerate A list of Integer and 0 7 This equals capability_videoin_c0_mjpeg_maxfra merate This is kept for compatibility videoin_h264_max framerate A list of Integer and 0 7 This equals capability_videoin_...

Page 259: ...ancellation audio_aecmode auto manual 0 7 Indicate the acoustic echo cancellation control mode auto control by camera automatically manual Manually turn on off the control mode Only available when capability_audio_aec is 1 We support this parameter when the version number httpversion is equal or greater than 0306b audio_aecaffect maxframerate fixed 1 5 product dependent 0 7 When acoustic echo canc...

Page 260: ...l 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 maxframerate fixed 15 which means the max frame rate is 15fps when acoustic echo cancellation function is enabled means no feature is affected Only available when capability_audio_aec is 1 We support this parameter when the version number httpversion ...

Page 261: ...ate whether to support external line input Not support this parameter anymore when the version number httpversion is equal or greater than 0301a It will be replaced by audio_intmic and audio_extmic audio_lineout boolean 0 7 Indicate whether to support line output audio_michardwar eswitch boolean 0 7 Indicate whether the hardware supports built in external mic switch audio_headphoneo ut Not support...

Page 262: ...ndow is a 2D rectangle shape Not supported motion_windomai n qvga px std 0 7 The domain to set an motion window qvga a 320x240 range to represent the whole image px Locate a window in the image with pixels std A normalized 0 9999 range Not supported smartstream_supp ort boolean 0 7 Indicate whether smart stream is supported smartstream_versi on integer 0 7 Number of smart stream version Only avail...

Page 263: ...able when capability_smartstream_support is 1 smartstream_nwin dow_autotracking positive integer 0 7 Maximum number of tracking window of autotracking Only available when capability_smartstream_support is 1 smartstream_nwin dow_manual positive integer 0 7 Maximum number of tracking window of manual Only available when capability_smartstream_support is 1 smartstream_nwin dow_hybrid_autotr acking po...

Page 264: ...ot support anymore boolean 0 7 Indicate whether to support httptunnel Not support this parameter anymore when the version number httpversion is equal or greater than 0301b It will be replaced by capability_camctrl_ptztunnel camctrl_ptztunnel boolean 0 7 Indicate whether to support ptztunnel We support this parameter when the version number httpversion is equal or greater than 0301b This equals cap...

Page 265: ...bility_network_wireless is 1 We support this parameter when the version number httpversion is equal or greater than 0305a wireless_s802dot1 1b boolean 0 7 Indicate whether to support wireless 802 11b wireless_s802dot1 1g boolean 0 7 Indicate whether to support wireless 802 11g wireless_s802dot1 1n boolean 0 7 Indicate whether to support wireless 802 11n wireless_begincha nnel 1 14 0 7 Indicate the...

Page 266: ...her to support the upgrade function for the derivative brand For example if the value is true the VVTK product can be upgraded to VVXX TCVV TCXX is excepted test_ac boolean 0 7 Indicate whether to support test ac key version_onvifdaem on string 0 7 Indicate ONVIF daemon version version_onviftestto ol string 0 7 Indicate ONVIF test tool version media_totalspace positive integer 0 7 Available memory...

Page 267: ... lens We replace capability_image_iristype with capability_image_c0_iristype Reserved for compatibility and suggest don t use this since httpversion 0301a image_focusassist Not recommended to use this boolean 0 7 Indicate whether to support focus assist We replace capability_image_ focusassist with capability_image_c0_ focusassist Reserved for compatibility and suggest don t use this since httpver...

Page 268: ...tring 0 7 Indicate storage manager daemon version Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 localstorage_suppo rtedge 0 positive integer 0 7 An 32 bit integer which indicates the supportive application of edge storage If the value of this parameter is larger than 0 it means that the camera supports edge recording function bit 0 It supports to record directl...

Page 269: ...iary camera remotecamctrl_sla ve boolean 0 7 Indicate whether to support remote camera control slave side fisheyelocaldewarp _c 0 capability_n videoin 1 product dependent 0 positive integer 0 7 Indicate the supported streams of local dewarp One bit represents one supported stream The LSB indicates stream 0 Ex 3 means stream 0 and stream 1 support local dewarp Only available when capability_fisheye...

Page 270: ...wer camctrl cgi rs485 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...

Page 271: ...ce situation manual Turn off the automatically focus function For user to control the focus position manually as their purpose Only available when capability_camctrl_c 0 n 1 _zoommo dule is 1 We support this parameter when the version number httpversion is equal or greater than 0304a Group capability_ptz_c 0 n 1 n denotes the value of capability_nvideoin capability_ptzenabled 0 and capability_camc...

Page 272: ... _buildin pt is 1 maxpanangle integer 0 7 The upper limit for pan angle Only available when bit0 of capability_camctrl_c 0 n 1 _buildin pt is 1 tiltspeedlv 0 positive integer 0 7 The maximum speed level of tilt motion Only available when bit1 of capability_camctrl_c 0 n 1 _buildin pt is 1 mintilt 0 positive integer 0 7 The lower limit for tilt position Only available when bit1 of capability_camctr...

Page 273: ...axzoom 0 positive integer 0 7 The upper limit for zoom position Only available when the value of capability_camctrl_c 0 n 1 _zoomm odule is 1 maxdzoom 0 positive integer 0 7 The upper limit for digital zoom position Only available when the value of capability_camctrl_c 0 n 1 _zoomm odule is 1 focusspeedlv 0 positive integer 0 7 The maximum speed level of focus motion Only available when the value ...

Page 274: ...to support built in white led externalir boolean 0 7 Indicate whether to support external IR led optimizedir boolean 0 7 Indicate whether to support optimized IR control technology smartir boolean 0 7 Indicate whether to support smart IR ircutfilter boolean 0 7 Indicate whether to support IR cut lightsensor boolean 0 7 Indicate whether to support light sensor blackwhitemode boolean 0 7 Indicate wh...

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

Page 276: ... exists Only available when capability_daynight_c 0 n 1 _suppo rt is 1 spectrum_mode visible ir irenhanced blueenhanced product dependent 0 7 Indicate the spectrum mode visible The ideal default setting for visible light ir The ideal default setting for IR light irenhanced This CCM model increases the brightness effect of IR light blueenhanced This CCM model increases the brightness effect of blue...

Page 277: ...mera streams black and white video in low light environments di the camera automatically switches the current mode when a ditigal input 1 is triggered di2 the camera automatically switches the current mode when a ditigal input 2 is triggered di3 the camera automatically switches the current mode when a ditigal input 3 is triggered di4 the camera automatically switches the current mode when a ditig...

Page 278: ...rt zoom focus etc ics An i CS lens is an intelligent CS mount lens that contains information about among other things its own geometrical distortion and the exact position of its zoom focus and iris opening N A Only available when httpversion 0301a color_support boolean 0 7 1 camera can select to display color or black white video streams 0 camera do not support this feature We support this parame...

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

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

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

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

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

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

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

Page 286: ...resolutionC4R A list of WxH 0 7 Available resolutions of 4R mode of ceiling and floor mount resolutionW1P A list of WxH 0 7 Available resolutions of 1P mode of wall mount resolutionW1R A list of WxH 0 7 Available resolutions of 1R mode of wall mount resolutionW4R A list of WxH 0 7 Available resolutions of 4R mode of wall mount Group capability_videoin_c 0 n 1 _mode 0 m 1 n denotes the value of cap...

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

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

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

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

Page 291: ...ual or greater than 0311a wdrpro_mode 0 1 2 0 7 0 Non support WDR Pro 1 Support WDR Pro 2 Support WDR Pro and WDR Pro II wdrpro_strength 0 1 0 7 0 Non support tuning strength of WDR Pro 1 Support tuning strength of WDR Pro If capability_image_c 0 n 1 _wdrpro 1 this may be either 0 or 1 wdrpro_supportlevel 0 positive integer 0 7 This contains a list of positive integers split by comma If wdrpro_mod...

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

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

Page 294: ...ital noise reduction Only available when capability_image_c 0 n 1 _dnr 0 We support this parameter when the version number httpversion is equal or greater than 0306d dnrtype 2d 3d 0 7 Description about DNR type Only available when capability_image_c 0 n 1 _dnr 0 We support this parameter when the version number httpversion is equal or greater than 0308a eis 0 1 0 7 0 Non support electronic image s...

Page 295: ...pability_image_c 0 n 1 _is_mod e is not We support this parameter when the version number httpversion is equal or greater than 0302a is_affect minexposure hidde n 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 i...

Page 296: ...eger or string or NULL means no feature is affected Only available when capability_image_c 0 n 1 _is_mod e is not We support this parameter when the version number httpversion is equal or greater than 0302a scenemode_support 0 1 0 7 0 Non support scene mode 1 Support scene mode scenemode_supportty pe product dependent visibility noiseless lpcparkinglot lpcstreet lpchighway auto deblur lpcfreeway p...

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

Page 298: ...igned value videoin_c 0 n 1 _shuttervalue not support Only available when capability_image_c 0 n 1 _ exposure_mode is 1 and capability_image_c 0 n 1 _exposu re_rangetype is onevalue We support this parameter when the version number httpversion is equal or greater than 0302a exposure_gainvaluety pe fixed maximum 0 7 One to one mapping to the mode type in exposure_modetype fixed The shutter value is...

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

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

Page 301: ...e_irispriority mode_affect exposurewin mode blc hidden defog disabled wdrpro disabled exposurelevel hidd en 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 ...

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

Page 303: ...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_manualmod e_affect exposurewin mode blc hidden defog disabled wdrpro disabled exposurelevel hidd en...

Page 304: ...s exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL means no feature is affected Only available when manual is listed in capability_image_c 0 n 1 _ exposure_modetype and capability_image_c 0 n 1 _ exposure_mo...

Page 305: ...ingmode Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_hlcmode_s upportwindow boolean 0 7 Indicate whether to support exposure window in hlc mode Only available when capability_image_c 0 n 1 _ exposure_mode is 1 and hlc is listed in capability_image_c 0 n 1 _ exposure_winmode exposure_hlcmode_af fect or others x nonnegative integer product dependent 0 7 When hlc mode is...

Page 306: ... as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL means no feature is affected Only available when capability_image_c 0 n 1 _ exposure_mode is 1 and hlc is listed in capability_image_c 0 n 1 _ exposure_winmode We support this parameter when the version number httpversion is equal or greater than 0304a exp...

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

Page 308: ... exposure_minrange 1 32000 1 8000 or others product dependent 0 7 Available range for videoin_c n _minexposure 1 32000 1s 1 32000s 1 8000 1s 1 8000s etc means minimum exposure time is not available When exposure_mode 0 this value must be set to Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_bracketing_ mode boolean 0 7 0 Non support Auto Exposure Bracketing AEB 1 Suppor...

Page 309: ...e support this parameter when the version number httpversion is equal or greater than 0310a privacymask_wintype rectangle polygon 3Drectangle 0 7 The supported mask window type polygon The window is a 2D polygon shape rectangle The window is a 2D rectangle shape 3Drectangle The window is a 3D rectangle shape privacymask_windom ain qvga px std 0 7 The domain to set an window qvga a 320x240 range to...

Page 310: ...o a given value The affected functions are list here The format is Affect API name Policy Description Policy can be categorized into following groups disabled UI turns grey and users can t select it unchanged UI keeps the status as before and user can t change it hidden UI is hidden fixed UI is fixed to one selection or value ranged UI is fixed to multiple selections or values enabled UI is checke...

Page 311: ...tive 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 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 gre...

Page 312: ...port AE speed aespeedsupportlevel positive integer 0 7 The value indicate the support strength level of aespeed Only available when capability_image_c 0 n 1 _aespee d is 1 aespeedsupportsensit ivity 0 1 0 7 0 Non support tuning the sensitivity of AE converge speed 1 Support tuning the sensitivity of AE converge speed Only available when capability_image_c 0 n 1 _aespee d is 1 gammacurve 0 1 0 7 0 ...

Page 313: ...sent the whole image px Locate a window in the image with pixels std A normalized 0 9999 range Not supported focuswindow_nwindo w 0 positive integer 0 7 Number of focus window focuswindow_range leftrange rightran ge toprange lowran ge product dependent 0 7 Available range for focuswindow We support this parameter when the version number httpversion is equal or greater than 0305d Not supported lens...

Page 314: ...on We support this parameter when the version number httpversion is equal or greater than 0308a deinterlace_mode spatial blend 0 7 Spatical mode provides the best image quality while Blend mode provides better image quality than not using the deinterlace function at all Only available when capability_image_c 0 n 1 _deinterl ace_support is 1 lens_alignment boolean 0 7 Indicate whether to support le...

Page 315: ...eratures of the target We support this parameter when the version number httpversion is equal or greater than 0310a palette_mode A list of palette options 0 7 Palette options used in thermal surveillance Only available when capability_image_c 0 n 1 _palette _support 1 We support this parameter when the version number httpversion is equal or greater than 0310a Group capability_peripheral_c 0 n 1 n ...

Page 316: ...f custom script time string 4 20 6 6 Time of custom script 7 29 Event Setting Group event_i 0 n 1 n denotes the value of capability_nevent capability_nevent 0 PARAMETER VALUE SECURITY get set DESCRIPTION name string 40 6 6 Identification of this entry enable 0 1 6 6 Enable or disable this event priority 0 1 2 6 6 Indicate the priority of this event 0 low priority 1 normal priority 2 high priority ...

Page 317: ...detection virestore Video input signal restore vadp VADP trigger smartsd is only valid when smart SD card is inserted triggerstatus string 40 6 6 The status for event trigger di 0 positive integer 6 6 Indicate the source id of di trigger This field is required when trigger condition is di One bit represents one digital input The LSB indicates DI 0 Only available when capability_ndi 0 mdwin 0 posit...

Page 318: ...tect event from any one of source id 0 1 and 3 set vadp to 11 Only available when vadp is listed in capability_supporttriggertypes valevel 0 1 6 6 Select audio detection event 0 not select 1 select valevel0 0 1 6 6 Select audio detection profile event 0 not select 1 select inter 1 999 6 6 Interval of snapshots in minutes This field is used when trigger condition is seq weekday 0 127 6 6 Indicate w...

Page 319: ...Only available when capability_ndo 0 action_cf_enable Boolean 6 6 Enable or disable sending media to SD card Only available when capability_supportsd 0 action_cf_folder string 128 6 6 Path to store media Only available when capability_supportsd 0 action_cf_media NULL 0 4 101 6 6 Index of the attached media 101 means Recording Notify Only available when capability_supportsd 0 action_cf_datefolder b...

Page 320: ...ailable when capability_ptzenabled 0 action_goto_sync product dependent boolean 6 6 Capture media after moving to the location Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0 or capability_camctrl_c0_zoommodule 0 action_autotrack_enable product dependent boolean 6 6 Enable disable auto tracking on event triggerd Only avaliable when the bit4 of ...

Page 321: ...tpversion is equal or greater than 0311c 7 30 Server Setting for Event Action Group server_i 0 4 PARAMETER VALUE SECURITY get set DESCRIPTION name string 40 6 6 Identification of this entry type email ftp http ns 6 6 Indicate the server type email email server ftp FTP server http HTTP server ns network storage http_url string 128 6 6 URL of the HTTP server to upload http_username string 64 6 6 Use...

Page 322: ...olean 6 6 Enable support SSL email_port 0 65535 6 6 Port to connect to the server email_username string 64 6 6 Username to log in to the server email_passwd string 64 7 6 Password of the user email_senderemail string 128 6 6 Email address of the sender email_recipientemail string 640 6 6 Email address of the recipient ns_location string 128 6 6 Location to upload or store the media ns_username str...

Page 323: ...eoin 1 6 6 Indicate the source of media channel 0 means the first channel 1 means the second channel 2 means the third channel 3 means the fourth channel We support this parameter when the version number httpversion is equal or greater than 0311c snapshot_source 0 capability_nmediastream 1 6 6 Indicate the source of media stream 0 means the first stream 1 means the second stream and etc 2 means th...

Page 324: ...l 0 means the first channel 1 means the second channel 2 means the third channel 3 means the fourth channel We support this parameter when the version number httpversion is equal or greater than 0311c videoclip_source 0 capability_nmediastream 1 6 6 Indicate the source of media stream 0 means the first stream 1 means the second stream and etc 2 means the third stream and etc 3 means the fourth str...

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

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

Page 327: ...ffect when autocleanup_ maxretentiontime_recording_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 ...

Page 328: ...n prefix string 16 6 6 Indicate the prefix of the filename cyclesize 100 6 6 The maximum size for cycle recording in Kbytes when choosing to limit recording 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 c...

Page 329: ...alue is 1 it will force HTTP connection redirect to HTTPS connection method auto manual install 6 6 auto Create self signed certificate automatically manual Create self signed certificate manually install Create certificate request and install status 3 1 6 6 Specify the https status 3 Certificate not installed 2 Invalid public key 1 Waiting for certificate 0 Not installed 1 Active countryname stri...

Page 330: ...n 6 6 Enable cyclic storage method autocleanup_enabled Not recommended to use this boolean 6 6 Enable automatic clean up method Expired and not locked media files will be deleted For forward compatibility reservations but only group disk_i0_autocleanup is effective Not recommended to use this Please refers autocleanup group This parameter will not be used after the version number httpversion is eq...

Page 331: ...eanup_enabled is enabled maxretentiontime_record ing_i 0 1 _maxage string 6 6 To specify the expired time for automatic clean up and it only takes effect for video clip generated by recording_i 0 1 Format is P Y Y MM M DDD DT hh H mm M ss S similar with ISO8601 with symbols P Ex P7D it means 7 days P1DT10H it means 1 days and 10 hours The parameter takes effect when autocleanup_ maxretentiontime_r...

Page 332: ...days and 10 hours The parameter takes effect when autocleanup_maxretentiontime_others_ enabled is enabled 7 35 Region of Interest Group roi_c 0 n 1 for n channel product and m is the index of video stream which support ePTZ capability_eptz 0 or capability_fisheye 1 PARAMETER VALUE SECURITY get set DESCRIPTION s 0 m 1 _home W H product dependent 1 6 ROI left top corner coordinate If the minimal win...

Page 333: ...duct capability_eptz 0 or capability_fisheye 1 PARAMETER VALUE SECURITY get set DESCRIPTION osdzoom Not recommended to use this boolean 1 4 Indicates multiple of zoom in is on screen display or not Reserved for compatibility and suggest don t use this since httpversion 0302a We replace eptz_c 0 n 1 _osdzoom with videoin_c 0 n 1 _zoomratiodisplay smooth boolean 1 4 Enable the ePTZ move smoothly fea...

Page 334: ...ility_fisheye is 1 and capability_fisheyelocaldewarp_c 0 n 1 is 0 Group eptz_c 0 n 1 _s 0 m 1 for n channel product and m is the index of video stream which support ePTZ if capability_eptz 0 m is the index of stream number if capability_fisheye 1 capability_eptz 0 or capability_fisheye 1 PARAMETER VALUE SECURITY get set DESCRIPTION patrolseq string 120 1 4 The patrol sequence of ePTZ All the patro...

Page 335: ... than by setparam cgi 7 37 Focus Window Setting Group focuswindow_c 0 n 1 for n channel products n denotes the value of capability_nvideoin capability_image_c 0 n 1 _focuswindow_nwindow 0 PARAMETER VALUE SECURITY get set DESCRIPTION win_i0_enable boolean 4 4 Enable or disable the window win_i0_home W H product dependent 4 4 Left top corner coordinate of the window If the minimal window size is 192...

Page 336: ...amless indicates enable seamless recording manageable indicates disable seamless recording maxconnection 3 1 7 Maximum number of connected seamless streaming enable boolean 1 7 Indicate whether seamless recording is recording to local storage or not at present Read only guid 0 2 _id string 127 1 7 The connected seamless streaming ID Read only guid 0 2 _number 0 3 1 7 Number of connected seamless s...

Page 337: ..._free_memory 0 positive integer 6 7 Indicate free memory size for VADP modules resource_free_storage 0 positive integer 6 7 Indicate current free storage size for uploading VADP modules module_number 0 positive integer 6 7 Record the total module number that already stored in the system module_order string 40 6 6 The execution order of the enabled modules module_save2sd boolean 6 6 Indicate if the...

Page 338: ... The provider of the module vendorurl string 120 6 6 URL of the vendor version string 40 6 6 Version of the module license string 40 6 6 Indicate the license status of the module licmsg string 128 6 6 Indicate the message that will be show on license status when mouse over path string 40 6 6 Record the storage path of the module initscr string 40 6 6 The script that will handle operation commands ...

Page 339: ...ication with this topic will be transferred to event manager as trigger n is equal to ntrigger above 7 40 Camera PTZ Control Group camctrl capability_camctrl_ptztunnel 0 NAME VALUE SECURITY get set DESCRIPTION enableptztunnel boolean 1 4 Enable PTZ tunnel for camera control Group camctrl_c 0 n 1 for n channel products capability_ptzenabled 0 n denotes the value of capability_nvideoin and k denotes...

Page 340: ...ver 2 enable PTZ commands with UART tunnel Only available when bit7 of capability_ptzenabled is 1 disablemdonptz boolean 1 4 Disable motion detection on PTZ operation 7 41 Camera PTZ Control IZ Series Group camctrl_c 0 n 1 for n channel products capability_camctrl_c0_zoommodule 1 and capability_camctrl_c0_buildinpt 0 n denotes the value of capability_nvideoin and k denotes the value of capability_...

Page 341: ...d focusspeed 5 5 1 4 Auto focus speed focusmode auto onetimeau to spotlight ma nual Available values are listed in capability_cam ctrl_c 0 n 1 _focusmode 1 4 Indicate the focus control mode uart 0 capability_nua rt 1 1 4 Select corresponding uart capability_nuart 0 isptz 0 2 1 4 0 disable PTZ commands 1 enable PTZ commands with PTZ driver 2 enable PTZ commands with UART tunnel Only available when ...

Page 342: ...set_i 0 k 1 _name We support this parameter when the version 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 fi...

Page 343: ...rnhome boolean 1 4 Enable disable return home while idle returnhomeinterval 1 999 1 4 While idle over this time interval idle action will be taken idleaction_enable boolean 1 4 Enable disable idle action while idle idleaction_type home 1 4 This field tells what kind of action should be taken while idle idleaction_interval 1 999 1 4 While idle over this time interval idle action will be taken PLEAS...

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

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

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

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

Page 348: ...y_fisheye 0 NAME VALUE SECURITY get set DESCRIPTION baudrate 300 600 1200 2400 4800 9600 19200 38 400 57600 115200 4 4 Set baud rate of COM port databit 5 6 7 8 4 4 Data bits in a character frame paritybit none odd even 4 4 For error checking stopbit 1 2 4 4 1 One stop bit is transmitted to indicate the end of a byte 2 Two stop bits are transmitted to indicate the end of a byte If you want to tran...

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

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

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

Page 352: ...oup pir capability_npir 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 1 1 Enable disable PIR 7 49 Auto Tracking Setting Group autotrack_c 0 n 1 capability_image_c 0 n 1 _autotrack_support 0 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION objsize_type 1 2 1 4 Type of object size 1 customized width and height 0 object size 30 x 30 1 object size 10 x...

Page 353: ...r own regulations to the allowable channels 1 11 USA and Canada 1 13 Europe 10 11 Spain 10 13 France 1 14 Japan Only valid when wireless_wlmode is Adhoc encrypt none wep wpa wpa2 6 6 Encryption method none NONE wep WEP wpa WPA wpa2 WPA2PSK authmode OPEN SHARED 6 6 Authentication mode Only valid when wireless_encrypt is wep keylength 64 128 6 6 Key length in bits Only valid when wireless_encrypt is...

Page 354: ...WEP key4 for encryption Only valid when wireless_encrypt is wep algorithm AES TKIP 6 6 Algorithm Only valid when wireless_encrypt is wpa or wpa2 presharedkey password 64 6 6 WPA WPA2PSK mode pre shared key Only valid when wireless_encrypt is wpa or wpa2 7 51 Shock Detection Group shock_c 0 n 1 for n channel products n denotes the value of capability_nvideoin capability_shockalarm_support 0 PARAMET...

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

Page 356: ...tus of the Digital Output capability_ndo 0 Note This request requires Viewer privileges Method GET POST Syntax http servername cgi bin dido getdo cgi do0 do1 do2 do3 If no parameter is specified all the digital output statuses will be returned Return HTTP 1 0 200 OK r n Content Type text plain r n Content Length length r n r n do0 state r n do1 state r n do2 state r n do3 state r n where state can...

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

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

Page 359: ...og Return HTTP 1 0 200 OK r n Content Type text plain r n Content Length syslog length r n r n system log information r n 8 7Upgrade 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 firmw...

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

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

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

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

Page 364: ...ameter 8 11 IP Filtering for ONVIF Syntax product dependent http servername cgi bin admin ipfilter cgi type value http servername cgi bin admin ipfilter cgi method add v4 v6 ip ipaddress index val ue return return page http servername cgi bin admin ipfilter cgi method del v4 v6 index value return retu rn page PARAMETER VALUE DESCRIPTION type NULL Get IP filter type allow deny Set IP filter type me...

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

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

Page 367: ...g the accessname of SDP You can get the SDP by HTTP GET When using scalable multicast Get SDP file which contains the multicast information via HTTP 8 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 s...

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

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

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

Page 371: ...ked or not Ex Update records whose key numbers are 1 and 5 to be locked status http servername cgi bin admin lsctrl cgi cmd update isLocked 1 label 1 label 5 Ex Update records whose key numbers are 2 and 3 to be unlocked status http servername cgi bin admin lsctrl cgi cmd update isLocked 0 label 2 label 3 Command queryStatus PARAMETER VALUE DESCRIPTION retType xml or javascript Optional Ex retype ...

Page 372: ... milliseconds setting it to trigger state Note that when the virtual input is waiting for next state it cannot accept new requests return return page Redirect to the page return page after the parameter is assigned The return page should be the relative path according to the root of camera If you omit this parameter it will redirect to an empty page If the return page is invalid path it will ignor...

Page 373: ...name network_rtsp_s m _accessname maxsft value tsmode value refti me value forcechk minsft value n is the channel index m is the timeshift stream index For details on timeshift stream please refer to the TimeshiftCaching documents PARAMETER VALUE DEFAULT DESCRIPTION maxsft positive integer 0 Request cached stream at most how many seconds ago The value must be a positive integer 0 tsmode normal ada...

Page 374: ...t 10 reftime 12 30 forcechk N A N A Check if the requested stream enables timeshift feature and if minsft is achievable If false return 415 Unsupported Media Type minsft positive integer 0 How many seconds of cached stream client can accept at least Used by forcechk The value must be a positive integer 0 Return Code Description 400 Bad Request Request is rejected because some parameter values are ...

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

Page 376: ...of zoom motor remote_focus_focus_motor_max Maximum steps of focus motor remote_focus_zoom_motor_start Start point of zoom motor remote_focus_zoom_motor_end End point of zoom motor remote_focus_focus_motor_start Start point of effective focal length remote_focus_focus_motor_end End point of effective focal length remote_focus_zoom_motor Current position of zoom motor remote_focus_focus_motor Curren...

Page 377: ...tor_max is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from function getstatus steps 1 motor_max Motor s moving steps It works only if function zoom or function focus and direction forward and direction backward motor_max is refer to remote_focus_focus_motor_max or remote_focus_zoom_motor_max which replied from function getstatus This parameter is for additio...

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

Page 379: ... of iris getstatus Information of motors return value as below remote_focus_focus_motor_max Maximum steps of focus motor remote_focus_focus_motor_start Start point of effective focal length remote_focus_focus_motor_end End point of effective focal length remote_focus_focus_motor Current position of focus motor remote_focus_focus_enable Current function of focus motor remote_focus_iris_open The cur...

Page 380: ...ed from function getstatus This parameter is for additional fine tune the value is from 1 to 30 iris N A Open iris or not It works only if function auto or function scan 8 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...

Page 381: ... admin upload_dst cgi Post data filename file name r n r n multipart encoded form data For language file http servername cgi bin admin upload_lan cgi Post data filename file name r n r n multipart encoded form data For setting backup file http servername cgi bin admin upload_backup cgi Post data filename file name r n r n multipart encoded form data Server will accept the file named file name to u...

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

Page 383: ... PARAMETER VALUE DEFAULT DESCRIPTION stime YYYYMMDD_HHMMSS MMM N A Start time etime YYYYMMDD_HHMMSS MMM N A End time length positive integer N A The length of media of interest The unit is second loctime boolean 0 Specify if start end time is local time format 1 for local time 0 for UTC 0 file string N A The media file to be played tsmode positive integer N A Timeshift mode the unit is second Ex s...

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

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

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

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

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

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

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

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

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

Page 393: ...n page PARAMETER VALUE DESCRIPTION addpos string 30 Add one preset location to the preset list channel 0 capability_nvideoin 1 Channel of the video source delpos string 30 Delete preset location from preset list return return page Redirect to the page return page after the parameter is assigned The return page should be the relative path according to the root of camera If you omit this parameter i...

Page 394: ...nual 2019 VIVOTEK INC All Right Reserved 260 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 ...

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

Page 396: ...VALUE DESCRIPTION N A N A Apply the wireless settings and connect to AP 8 33 Get Wireless Information capability_network_wireless 0 Note This request requires Administrator privileges Method GET POST Syntax http servername cgi bin admin getwirelessinfo cgi PARAMETER VALUE DESCRIPTION N A N A Get wireless information Camera will return following information 1 Wireless channel 2 Link quality 3 Signa...

Page 397: ...ileges Method GET POST Syntax http servername cgi bin admin getwlsignalstrength cgi PARAMETER VALUE DESCRIPTION N A N A Get wireless signal strength 8 35 WPS Transaction capability_network_wireless 0 Note This request requires Administrator privileges Method GET POST Syntax http servername cgi bin admin start_wps cgi PARAMETER VALUE DESCRIPTION N A N A Start WPS transaction ...

Page 398: ...e 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 n Cache control no cache r n Pragma no cache r n r n washer_mode OK r n washer_status FAIL r n PARAMETER VALUE DESCRIPTION channel 0 capability_nvideoin 1 Channel of the video source washer_mode wiper Apply the wiper to the...

Page 399: ...e Only available when capability_peripheral_c 0 n 1 _washer _support 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 _support 1 trigger heater component is work in force heater once Only available when capability_peripheral_c 0 n 1 _heater _support 1 Syntax for query API http serverna...

Page 400: ...de N 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 s...

Page 401: ... capability_peripheral_c 0 n 1 _heater_suppo rt 1 heater_status N 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 availa...

Page 402: ...Camera will automatically 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 w...

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

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

Page 405: ... of IR zone PARAMETER VALUE DESCRIPTION channel 0 capability_nvideoin 1 Channel of the video source support_irmode N A List 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 Pragm...

Page 406: ...ttp myserver cgi bin admin thermalctrl cgi operation set action shuttercompensate Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n OK Example http myserver cgi bin admin thermalctrl cgi operation set action shuttercompensate Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n ERROR time out Example http myserver cgi bin admin thermalctrl c...

Page 407: ...pensate Syntax for query API http servername cgi bin admin thermalctrl cgi operation get version value PARAMETER VALUE DESCRIPTION version N A Indicate lensctrl thermal version Example http myserver cgi bin admin thermalctrl cgi function get version Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n version 1120B15 End of document ...

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

Reviews: