Vivotek TB5328 SERIES, User Manual

Page 1: ...User s Manual Outdoor Day Night 30M IR Cable Management Bullet Network Camera TB5328 R T R F3 ET EF3 TB53B6 H R T EHT H R F3 EHF3 Rev 1 1 ...

Page 2: ...guration 38 System General settings 39 System Homepage layout 41 System Logs 44 System Parameters 46 System Maintenance 47 Media Image 51 Media Video 64 Media Video 66 Media Audio 72 Network General settings 73 Network Streaming protocols 81 Network SNMP Simple Network Management Protocol 90 Security User accounts 91 Security HTTPS Hypertext Transfer Protocol over SSL 92 Security Access List 99 PT...

Page 3: ...ution especially in low light environment In addition to applying VIVOTEK s notable bandwidth solution in Smart Stream and 3DNR the TB53B6 and 5328 T RT models are also designed with smart focus system to assit focus adjustment more efficiently To meet more outdoor applications and ease cable deployment TB53B6 and 5328 R models are the first network camera designed with embedded extender to allow ...

Page 4: ...y assembly and installation This also ensures the product is used properly as intended The Network Camera is a network device and its use should be straightforward for those who have basic networking knowledge It is designed for various applications including video sharing general security surveillance etc The Configuration chapter suggests ways to best utilize the Network Camera and ensure proper...

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

Page 6: ...ther TB53B6 5328 camera Please do not connect the yellow LAN port to a PC or switch LAN port The high voltage can damage the LAN port circuits Au Au MIC P MIC N DO DO DI DI icro General I O Terminal Block Ethernet 10 100 RJ45 Plug The E models e g TB5328 ET TB53B6 EHT do not support PoE cascade connections due to its high power consumption The E models come with embedded heater for low temperature...

Page 7: ...resistance can occur with low quality cables 1 2 3 4 1 2 3 4 LAN PoE UPLINK PoE ON OFF 4xFE PoE 1xFE Switch UPLINK POWER ON AW FED 0500 120 100m 100m 100m TB53B6 HRT TB53B6 HT TB5328 RF3 TB53B6 HRF3 TB53B6 EHT TB53B6 EHF3 TB53B6 HF3 TB5328 F3 TB53B6 HRT TB5328 RF3 TB53B6 HRF3 TB5328 ET TB5328 EF3 Many copper coated aluminum CCA and other non standard conductors cabling products are masqueraded as ...

Page 8: ...TB5328 EF3 When using an ordinary 802 3at PoE switch 30W output per port up to 1 TB53B6 HRT and 1 TB53B6 HT can be cascaded in a configuration with a cabling distance of up to 200 meters Please use quality cables when cabling over an extended distance The TB E series heater models can not be applied in the cascade configuration due to its extra power consumption ...

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

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

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

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

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

Page 14: ...nitions 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 network 3 Green LED blinks every 1 sec and RED LED blinks consecutively every 0 15 sec Upgrading firmware 4 Green and RED blink every 0 15 sec Green and RED light on then blink again Restoring defaults 5 RED LED is ...

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

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

Page 19: ...K network devices on the same LAN 4 After a brief search the installer window will prompt Click on the MAC and model name that matches the one printed on the product label You can then double click on the address to open a management session with the Network Camera 0002D1730202 00 02 D1 73 02 02 192 168 5 151 TB53B6 Installation Wizard 2 IW2 Network Camera Model No TB53B6 Made in Taiwan This devic...

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

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

Page 22: ...nch your web browser e g Microsoft Internet Explorer or Mozilla Firefox 2 Enter the IP address of the Network Camera in the address field Press Enter 3 Live video will be displayed in your web browser 4 If it is the first time installing the VIVOTEK network camera an information bar will prompt as shown below Follow the instructions to install the required plug in on your computer NOTE For Mozilla...

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

Page 24: ... a 32 bit IE browser will be opened IMPORTANT 1 The onscreen Java control can malfunction under the following situations A PC con nects to different cameras that are using the same IP address or the same camera running different firmware versions Removing your browser cookies will solve this problem 2 If you encounter problems with displaying the configuration menus or UI items try dis able the Co...

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

Page 26: ...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 64 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 27: ...load it from http www vivotek com 1 If you forget the root administrator password for the camera you can restore the camera defaults by pressing the reset button for longer than 5 seconds 2 If DHCP is enabled in your network and the camera cannot be accessed run the IW2 utility to search the network If the camera has been configured with fixed IP that does not comply with your local network you ma...

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

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

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

Page 31: ...ording button to end recording When you exit the web browser video recording stops accordingly To specify the storage destination and file name please refer to MP4 Saving Options on page 34 for details Volume When the Mute function is not activated move the slider bar to adjust the volume on the local computer Mute Turn off the volume on the local computer The button becomes the Audio On button af...

Page 32: ... button to capture and save still images The captured images will be displayed in a pop up window Right click the image and choose Save Picture As to save it in JPEG jpg or BMP bmp format Digital Zoom Click and uncheck Disable digital zoom to enable the zoom operation The navigation screen indicates the part of the image being magnified To control the zoom level drag the slider bar To move to a di...

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

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

Page 35: ...here are multiple from the Selected joystick menu If your joystick is not detected if may be defective 2 Click Calibrate or Configure buttons to configure the joystick related settings If you want to assign Preset actions to your joystick the preset locations should be configured in advance in the Configuration PTZ page If your joystick is not working properly it may need to be calibrated Click th...

Page 36: ... 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 37: ... 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 38: ...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 39: ...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 40: ... 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 41: ...page using the default settings Hide Powered by VIVOTEK If you check this item it will be removed from the homepage Logo graph Here you can change the logo that is placed at the top of your homepage Follow the steps below to upload a new logo 1 Click Custom and the Browse field will appear 2 Select a logo from your files 3 Click Upload to replace the existing logo with a new one 4 Enter a website ...

Page 42: ...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 43: ...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 44: ...rver 3 When completed click Save to enable the setting You can configure the Network Camera to send the system log file to a remote server as a log backup Before utilizing this feature it is suggested that the user install a log recording tool to receive system log messages from the Network Camera An example is Kiwi Syslog Daemon Visit http www kiwisyslog com kiwi syslog daemon overview System log...

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

Page 46: ... and administrators in a chronological order The access log is stored in the Network Camera s buffer area and will be overwritten when reaching a certain limit System Parameters The View Parameters page lists the entire system s parameters If you need technical assistance please provide the information listed on this page ...

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

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

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

Page 52: ... exterior design of a building The interior of a building can be shaped as a narrow rectangular space such as a corridor The conventional HD image such as that of a 16 9 aspect ratio will be incongruous with its wide horizontal view With video rotation the camera can more readily cover the field of view on a tall and narrow scene The rotation here indicates clockwise rotation Rotation can be appli...

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

Page 54: ...r to accept infrared light thus helping to improve low light sensitivity Synchronize with digital input The Network Camera automatically removes the IR cut filter when a Digital Input is triggerred For example the digital input can come from a housing that is equipped with IR illumination and control circuits such as VIVOTEK s AM 214 Exclude x Tips If there is an object in close proximity the IR l...

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

Page 56: ...ain slide bars Image Adjustment Brightness Adjust the image brightness level which ranges from 0 to 100 Contrast Adjust the image contrast level which ranges from 0 to 100 Saturation Adjust the image saturation level which ranges from 0 to 100 Sharpness Adjust the image sharpness level which ranges from 0 to 100 Gamma curve Adjust the image sharpness level which ranges from 0 to 0 45 You may let f...

Page 57: ...apply to Day mode Night mode or Schedule mode Please manually enter a range of time if you choose Schedule mode Then check Save to take effect Noise reduction Enable noise reduction Check to enable noise reduction in order to reduce noises and flickers in image This applies to the onboard 3D Noise Reduction feature Use the pull down menu to adjust the reduction strength Note that applying this fun...

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

Page 59: ...tter reduces light and needs to be compensated by electrical brightness gains The inclusive window refers to the weighed window the exclusive window refers to ignored window It adopts the weighed averages method to calculate the value The inclusive windows have a higher priority You can overlap these windows and if you place an exclusive window within a larger inclusive window the exclusive part o...

Page 60: ...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 Selec...

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

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

Page 63: ...You can use 4 mouse clicks to create a new masking window which is recommended to be at least twice the size of the object height and width you want to cover 3 Enter a Window Name and click Save to enable the setting 4 Click on the Enable privacy mask checkbox to enable this function NOTE Up to 5 privacy mask windows can be set up on the same screen If you want to delete the privacy mask window pl...

Page 64: ...elect different resolutions 5 megapixel at 15fps and 1080P Full HD at 30fps with different aspect ratios 4 3 or 16 9 for the video streams Note that changing the FOV will erase your preset points Motion detection exposure window and privacy masks settings ...

Page 65: ...m 3 is set to the 640 x 480 Stream 4 The default frame size for Stream 3 is set to the 2560 x 1920 and the Viewing Window function is not available for stream 4 Click Viewing Window to open the viewing region settings page On this page you can configure the Region of Interest and the Output Frame Size for a video stream For example you can crop only a portion of the image that is of your interest ...

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

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

Page 68: ... a bit rate from the pull down menu The bit rate ranges from 20kbps to a maximum of 16Mbps The bit rate then becomes the Average or Upper bound bit rate number The Network Camera will strive to deliver video streams around or within the bit rate limitation you impose Policy If Frame Rate Priority is selected the Network Camera will try to maintain the frame rate per second performance while the im...

Page 69: ...The video quality of part of the screen returns to normal when one or more objects move in that area The remainder of the screen where there are no moving objects no pixel changes will still be transmitted in low quality format Manual The Manual mode allows you to configure 3 ROI windows the Foreground areas on the screen Areas not included in any ROI windows will be considered as the Background a...

Page 70: ...mode and the Hybrid mode is that In the Hybrid mode any objects entering the background area will restore the video quality of the moving objects and the area around them The video quality of the associated background area is immediately restored to normal to cover the moving objects In the Manual mode the background area is always transmitted using a low quality format regardless of the activitie...

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

Page 72: ...layed External microphone input Select the gain of the external audio input according to ambient conditions Adjust the gain from 21 db most sensitive or 33 db least sensitive Audio type Select audio codec and the sampling bit rate G 711 also provides good sound quality and requires about 64Kbps Select pcmu μ Law or pcma A Law mode G 726 is a speech codec standard covering voice transmission at rat...

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

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

Page 80: ...erver By default the FTP port is set to 21 It also can be assigned to another port number between 1025 and 65535 2011 03 09 17 08 56 Mute Mic Volume Talk Button Video TCP AV Audio is being transmitted to the Network Camera Click to enable audio transmission to the Network Camera click to adjust the volume of microphone click to turn off the audio To stop talking click again ...

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

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

Page 83: ... when the access name for stream 1 is set to live sdp 1 Launch an RTSP player 2 Choose File Open URL A URL dialog box will pop up 3 Type the above URL command in the text box 4 The live video will be displayed in your player as shown below RTSP port RTP port for video audio RTCP port for video audio RTSP Real Time Streaming Protocol controls the delivery of streaming media By default the port numb...

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

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

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

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

Page 96: ... 96 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 97: ... 97 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 98: ...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 99: ...e How much time the client has been at the webpage User ID If the administrator has set a password for the webpage the clients have to enter a user name and password to access the live video The user name will be displayed in the User ID column If the administrator allows clients to link to the webpage without a user name and password the User ID column will be empty There are some situations that...

Page 100: ...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 101: ... 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 102: ...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 103: ...using 802 1X via a switch the authenticator The client offers its identity and client certificate which is then forwarded by the switch to the RADIUS Server which uses an algorithm to authenticate the Network Camera and returns an acceptance or rejection back to the switch 3 The switch also forwards the RADIUS Server s certificate to the Network Camera 4 Assuming all certificates are validated the...

Page 104: ...Z Operation The e PTZ control settings section will be displayed as shown below For e PTZ related details please refer to page 106 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 105: ...iewing region accordingly Moving Instantly If you check this item the live view window will switch to the new viewing region instantly after you move the floating frame If not selected the process of moving from one position to another will be shown Click on Image The e PTZ function also supports Click on Image When you click on any point of the Global View Window or Live View Window the viewing r...

Page 106: ...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 107: ...t Positions will also be displayed on the Home page Select one from the Go to menu and the Network Camera will move to the selected preset position Click Patrol The Network Camera will patrol along the selected positions repeatedly NOTE ...

Page 108: ...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 109: ...anism or external digital input devices There are several choices of trigger sources as shown on the next page Select the item to display the detailed configuration options Video motion detection This option makes use of the built in motion detection mechanism as a trigger source To enable this function you need to configure a Motion Detection Window first For more information please refer to Moti...

Page 110: ...stem event The triggering condition can be an input exceeding or falling below a threshold Audio detection can take place as a complement to motion detection or as a method to detect activities not covered by the camera s view VADP It is presumed that you already uploaded and enabled the VADP modules before you can associatee VADP triggers with an Event setting Click on the Set VADP Trigger button...

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

Page 112: ...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 113: ...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 114: ...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 115: ...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 137 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 116: ...orded data Click to go back to the previous level of the directory The format is HH 24r Click to open the file list for that hour The format is File name prefix Minute mm You can set up the file name prefix on Add media page Please refer to next page for detailed information 2015 01 20 2015 01 20 2015 01 20 2015 01 20 ...

Page 117: ...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 118: ...eam as the source of video clip Pre event recording The Network Camera has a buffer to temporarily hold data up to a certain limit Enter a number to decide the duration of recording before a trigger is activated Up to 9 seconds can be set Maximum duration Specify the maximum recording duration in seconds The duration can be up to 10 seconds For example if pre event recording is set to five seconds...

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

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

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

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

Page 124: ...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 125: ...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 109 for detailed information ...

Page 126: ... 10 sec 10 min The tamper alarm will be triggered only when the tampering factor 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 2 You can configure Tampering D...

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

Page 130: ... By then the module status will become OFF and the X button will appear at the end of the row Click on the X button to remove an existing module When prompted by a confirm message Click Yes to proceed Yes No Note that the actual memory consumed while operating the module will be indicated on the Memory status field This helps determine whether a running module has consumed too much of system resou...

Page 131: ...Internet connection you should acquire the license key elsewhere and manually upload to the network camera Follow the onscreen instruction on VIVOTEK s website for the registration procedure user You can proced with the following link to download a license key http www vivotek com vadp_requestactivation aspx application VCA When the license key is downloaded to your computer upload the key to the ...

Page 132: ...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 133: ...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 134: ...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 135: ...ximum capacity is reached the oldest file will be overwritten by the latest one The reserved amount is reserved for the transaction stage when the storage space is about to be full and new data arrives The minimum for the Reserved space must be larger than 15 MegaBytes Recording file management You can manually assign the Maximum duration and the Maximum file size for each recording footage You ma...

Page 136: ...on about folder naming rules please refer to page 115 for details 20150210 20150211 20150212 f you want to enable recording notification please click Event to configure event triggering settings Please refer to Event Event settings on page 108 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 137: ...s the status and reserved space of your SD card Please remember to format the SD card when using for the first time no SD card NOTE It is recommended to turn OFF the recording activity before you remove an SD card from the camera The lifespan of an SD card is limited Regular replacement of the SD card can be necessary Camera filesystem takes up several megabytes of memory space The storage space c...

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

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

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

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

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

Page 146: ...ed to an email address shorter than n characters eg joe www ibm com ip address A string limited to an IP address eg 192 168 1 1 mac address A string limited to contain a MAC address without hyphens or colons boolean A boolean value of 1 or 0 represents Yes or No True or False Enable or Disable value1 value2 value3 Enumeration Only given values are valid blank A blank string everything inside A des...

Page 147: ...VIVOTEK User s Manual 147 W is the pixel number of width H is the pixel number of height Ex 1920x1080 2048x1536 NOTE The camera should not be restarted when parameters are changed ...

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

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

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

Page 151: ...e 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 value except for a union of the combined results Only available when capability_image_c n _ remotefocus is 1 or capability_image_c n _ backfocus is 1 7 1 1 system info Subgroup of system ...

Page 152: ...ñol language_i3 Français language_i4 Italiano language_i5 日本 語 language_i6 Português language_i7 简体 中文 language_i8 繁體 中文 0 7 Available language lists customlanguage_maxcoun t 0 positive integer 0 6 Maximum number of custom languages supported on the server customlanguage_count 0 positive integer 0 6 Number of custom languages which have been uploaded to the server customlanguage_i 0 ma xcount 1 st...

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

Page 154: ...user_i0_pass password 64 6 6 Root password user_i 1 20 _pass password 64 7 6 User password user_i0_privilege view operator admin 6 7 Root privilege user_i 1 20 _ privilege view operator 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 s...

Page 155: ...dress 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 ieee8021x 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6...

Page 156: ...ity 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 product dependent 0 7 6 6 Audio channel for CoS capability naudioin 0 eventalarm 0 7 6 6 Event alarm channel for CoS management 0 7 6 6 Management channel for CoS eventtunnel 0 7 6 6 Event Control channel for CoS Subgro...

Page 157: ...t 21 1025 65535 6 6 Local ftp server port 7 6 5 HTTP Subgroup of network http NAME VALUE SECURITY get set DESCRIPTION port 80 1025 65535 1 6 HTTP port alternateport 1025 65535 6 6 Alternate HTTP port authmode basic digest 1 6 HTTP authentication mode s 0 capability_nmediast ream 1 _accessname product dependent string 32 1 6 Http server push access name for stream N N 1 capability nmediastream capa...

Page 158: ...ility_nmediast ream 1 _accessname product dependent string 32 1 6 RTSP access name for stream N N 1 capability nmediastream capability protocol spush_mjpeg 1 and capability nmediastream 0 The value are shown as live sdp s0_accessname stream1 live2 sdp s1_accessname stream2 live3 sdp s2_accessname stream3 live4 sdp s3_accessname stream4 etc 7 6 7 1 RTSP multicast Subgroup of network_rtsp_s 0 n 1 mu...

Page 159: ...rt 1025 65535 6 6 Audio channel port for RTP capability protocol rtp_unicast 1 metadataport 1025 65535 6 6 Metadata channel port for RTP 7 6 10 PPPoE Subgroup of network pppoe capability protocol pppoe 0 NAME VALUE SECURITY get set DESCRIPTION user string 128 6 6 PPPoE account user name pass password 64 6 6 PPPoE account password 7 7IP Filter Group ipfilter NAME VALUE SECURITY get set DESCRIPTION ...

Page 160: ...l rbgain widerange outdoor indoor sodiumauto etc Available values are listed in capability_image_c n _wbmode 4 4 Modes of white balance auto Auto white balance rbgain Use rgain and bgain to set white balance manually manual 2 cases a if rbgain is not supported this means keep current white balance status b if rbgain is supported rgain and bgain are updated to the current values which is got from w...

Page 161: ... quality but easy to meet rolling or flicker effect in indoor environment indoor Avoid rolling and flicker effect first fixed Open the iris to maximum Only available when capability_image_c n _iristype dciris 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 ...

Page 162: ...nly text string 64 1 4 Enclose caption imprinttimestamp boolean 4 4 Overlay time stamp on video minexposure product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c n _exposure_min range 4 4 Minimum exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc Only available when capability_image_c n _exposure_minrange ...

Page 163: ...put setting per channel Group videoin_c 0 n 1 for n channel products and m is stream number n denotes the value of capability_nvideoin m denotes the value of capability_nmediastream NAME VALUE SECURITY get set DESCRIPTION cmosfreq 50 60 4 4 CMOS frequency capability videoin type 2 mode 0 capability_videoin_c n _nmode 1 4 4 Indicate the video mode on use whitebalance product dependent auto manual r...

Page 164: ...rol setting 0 Weak 100 Strong Only available when rbgain is listed in capability_image_c n _wbmode Only valid when videoin_c n _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 n _wbmode Only valid when videoin_c n _whitebalance auto Normalized range exposurelevel 0 12 4 4 ...

Page 165: ... with variable Shutter Iris and Gain We support this parameter when the version number httpversion is equal or greater than 0302a irismode fixed indoor outdoor product dependent 4 4 Control DC Iris mode outdoor Auto setting DC Iris to get best quality but easy to meet rolling or flicker effect in indoor environment indoor Avoid rolling and flicker effect first fixed Open the iris to maximum Only a...

Page 166: ...ly available when capability_image_c n _iristype pi ris 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 maxgain 0 100 4 4 Maximum gain value 0 Low 100 High Only available when capability_image_c n _agc_maxga...

Page 167: ...alue Normalized range We support this parameter when the version number httpversion is equal or greater than 0302a color 0 1 4 4 0 monochrome 1 color flip boolean 4 4 Flip the image mirror boolean 4 4 Mirror the image rotate 0 90 180 270 1 4 The rotation angle of image Support only in Rotation mode capability videoin c n rotation 1 ptzstatus 0 positive integer 1 7 A 32 bit integer each bit can be ...

Page 168: ...ult ttf or user uploaded font file mnt flash2 upload ttf textonvideo_upl oadfilename Depends on the font file name uploaded by user 1 7 Show the uploaded font file name minexposure product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c n _exposure_m inrange 4 4 Minimum exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s...

Page 169: ...xed Only available when capability_image_c n _exposure_ra ngetype is twovalues shuttervalue product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c n _exposure_m axrange 4 4 Exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc This parameter may also restrict image frame rate from sensor due to sensor generate...

Page 170: ... or not s 0 m 1 _c odectype Listed at capability_videoin_codec Possible values are mjpeg h264 h265 product dependent 1 4 Codec type for this stream s 0 m 1 _re solution Available options are list in capability_videoin_c0_resolution 1 4 Video resolution in pixels s 0 m 1 _h 264_dintraperio d_enable boolean 4 4 Enable Dynamic intra frame period Only available when capability_videoin_c 0 n 1 _dint ra...

Page 171: ... Only valid when ratecontrolmode vbr s 0 m 1 _h 264_qvalue 0 51 4 4 Manual video quality level input The Q value which is used by encoded library directly Only valid when ratecontrolmode vbr and s 0 m 1 _h264_quant 99 s 0 m 1 _h 264_qpercent 1 100 4 4 Select customized quality in a normalized full range 1 Worst quality 100 Best quality Only valid when ratecontrolmode vbr and quant 100 s 0 m 1 _h 2...

Page 172: ...l in cbr_qpercent Only available when ratecontrolm ode cbr Only available when capability_s martstream_v ersion 2 0 s 0 m 1 _h 264_cbr_qperce nt 1 100 4 4 Select customized quality in a normalized full range 1 Worst quality 100 Best quality Only valid when ratecontrolmode cbr and quant 100 Only available when capability_smartstream_version 2 0 s 0 m 1 _h 264_bitrate 20000 capability_videoin_c n _h...

Page 173: ...apability_videoin_c0_re solution are recorded in capability_videoin_c n _h264_maxf ramerate s 0 m 1 _h 264_profile 0 2 1 4 Indicate H264 profiles 0 baseline 1 main profile 2 high profile s 0 m 1 _ h 2 6 5 _ d i n t r a p e r boolean 4 4 Enable Dynamic intra frame period Only available when capability_videoin_c 0 n 1 _dint raperiod_support is 1 and h265 is listed in capability_videoin_codec We supp...

Page 174: ... Constant bit rate mode vbr Fixed quality mode all frames are encoded in the same quality smart Smart stream mode Only valid when capability_smartstream_support 1 and capability_smartstream_version is not equal 2 0 Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h 265_quant 1 5 99 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 10...

Page 175: ...ustomized quality in a normalized full range 1 Worst quality 100 Best quality Only available when h265 is listed in capability_videoin_codec Only valid when ratecontrolmode vbr and quant 100 s 0 m 1 _h 265_maxvbrbitr ate 20000 capability_videoin_c n _h2 65_maxbitrate 4 4 The maximum allowed bit rate in fixed quality mode When the bit rate exceeds this value frames will be dropped to restrict the b...

Page 176: ...y 100 Best quality Only available when h265 is listed in capability_videoin_codec Only valid when ratecontrolmode cbr and quant 100 Only available when capability_smartstream_version 2 0 s 0 m 1 _h 265_bitrate 20000 capability_videoin_c n _h2 65_maxbitrate 4 4 The target bit rate in constant bit rate mode Only available when h265 is listed in capability_videoin_codec Only valid when ratecontrolmod...

Page 177: ...1 _m jpeg_ratecontro lmode cbr vbr 4 4 cbr Constant bit rate mode vbr Fixed quality mode all frames are encoded in the same quality s 0 m 1 _m jpeg_quant 1 5 99 100 4 4 Only valid when ratecontrolmode vbr 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 level in qvalue s 0 m 1 _m jpeg_qvalue 10 200 Only val...

Page 178: ... When the bit rate exceeds this value frames will be dropped to restrict the bit rate Only valid when ratecontrolmode vbr s 0 m 1 _m jpeg_cbr_quant 1 5 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality level in cbr_qpercent Only available when ratecontrolmode cbr Only available when capability_smartstream_version 2 0 s 0 m 1 _m jpeg_cbr...

Page 179: ...capability_videoin_c n _mjpeg_ma xframerate wdrpro_mode product dependent boolean 4 4 Enable WDR pro Only available when capability_image_c n _wdrpro_mo de 0 wdrpro_strengt h product dependent 1 100 4 4 The strength of WDR Pro The bigger value means the stronger strength of WDR Pro Only available when capability_image_c n _wdrpro_stre ngth is 1 wdrc_mode product dependent boolean 4 4 Enable WDR en...

Page 180: ...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 n _aespeed is 1 flickerless product dependent boolean 4 4 Turn on 1 or turn off 0 the flickerless mode Only available when ...

Page 181: ...available when capability_fisheyelocaldewarp_c 0 capability_nvideoin 1 0 Group videoin_c 0 n 1 _s 0 m 1 _h264_smartstream capability_smartstream_support 1 Group videoin_c 0 n 1 _s 0 m 1 _h265_smartstream capability_smartstream_support 1 and h265 is listed in capability_videoin_codec n denotes the value of capability_nvideoin m denotes the value of capability_nmediastream NAME VALUE SECURITY get se...

Page 182: ...h channel which might be for different scene of light daytime or nighttime Group videoin_c 0 n 1 _profile_i 0 m 1 for n channel profucts and m profile n denotes the value of capability_nvideoin and m denotes the value of capability_nvideoinprofile capability nvideoinprofile 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable disable this profile setting policy night schedule 4 4 Th...

Page 183: ...set to 1 5s 1 8000s and camera takes 1 5s on the night then sensor only outputs 5 frame s Only available when capability_image_c n _exposure_maxrang e Only valid when piris_mode manual or irismode fixed Only available when capability_image_c n _exposure_rangetyp e is twovalues shuttervalue product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c n _exposu...

Page 184: ...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 0 EV 2 0 1 EV 1 7 2 EV 1 3 3 EV 1 0 4 EV 0 7 5 EV 0 3 6 EV 0 7 EV 0 3 8 EV 0 7 9 EV 1 0 10 EV 1 3 11 EV 1 7 12 EV 2 0 exposuremode product dependent auto shutterpriority irispriority manu...

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

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

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

Page 188: ...ed 1 20 level 1 21 40 level 2 41 60 level 3 61 80 level 4 81 100 level 5 Level 1 4 low high The higher speed level meas shorter AE converged time during AE executing Only available when capability_image_c n _aespeed is 1 aespeed_sensitivity product dependent 1 100 4 4 The sensitivity of AE converge speed 1 20 level 1 21 40 level 2 41 60 level 3 61 80 level 4 81 100 level 5 Level 1 4 low high The h...

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

Page 190: ...TY get set DESCRIPTION brightness Not recommended to use this 5 5 100 4 4 5 Darker 5 Bright 100 Use image_c n _brightnesspercent Only available when bit 0 of capability_image_c n _basicsetting 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 c...

Page 191: ...ercent 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 n _basicsetting is 1 contrastpercent 0 100 4 4 Set contrast in the normalized range 0 Less contrast 100 More contrast Only available when bit 1 of capability_...

Page 192: ...3D noise reduction 0 disable 1 enable Only available when capability_image_c n _dnr is 1 dnr_strength product dependent 1 100 4 4 Strength of 3DNR Only available when capability_image_c n _dnr is 1 defog_mode product dependent boolean 4 4 Enable disable defog mode 0 disable 1 enable Only available when capability_image_c n _defog_mode is 1 defog_strength product dependent 1 100 4 4 Strength of def...

Page 193: ...s 1 Available value is listed in capability_image_c n _scenemode_support type restoreatwb 1 4 4 Restore of adjusting white balance of image according to mode settings freeze product dependent boolean 4 4 Enable disable Image freeze while patrolling 0 disable 1 enable Only available when capability_image_c n _freeze is 1 profile_i 0 m 1 _enable boolean 4 4 Enable disable this profile setting profil...

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

Page 195: ... _sharpness percent 0 100 4 4 Set sharpness in the normalized range 0 Softer 100 Sharper Only available when bit 3 of capability_image_c n _basicsetting is 1 profile_i 0 m 1 _gammacur ve 0 100 4 4 0 Fine turned gamma curve by Vivotek 1 Gamma value 0 01 2 Gamma value 0 02 3 Gamma value 0 03 100 Gamma value 1 Note Although we set gamma value to 100 level but not all gamma values are valid Internal m...

Page 196: ...ic image stabilizer 0 disable 1 enable Only available when eis is listed in capability_image_c n _is_mode profile_i 0 m 1 _eis_streng th product dependent 1 100 4 4 Strength of electronic image stabilizer Only available when eis is listed in capability_image_c n _is_mode profile_i 0 m 1 _dis_mode product dependent boolean 4 4 Digital image stabilizer 0 disable 1 enable Only available when dis is l...

Page 197: ...pensation and the only exposure window is located at the center of view 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 n _exposure_winnum Only available when custom is listed in capability_image_c n _exposure_winmode and valid when exposurewin_c n _mode custom NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Ena...

Page 198: ...e_c n _exposure_windomai n Group exposurewin_c 0 n 1 _profile_i 0 m 1 for n channel profuct and m profile n denotes the value of capability_nvideoin m denotes the value of capability_nvideoinprofile Only valid when capability_image_c n _exposure_mode 1 NAME VALUE SECURITY get set DESCRIPTION mode auto custom blc Available values are listed in capability_image_c n _exposu re_winmode 4 4 The mode in...

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

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

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

Page 202: ...nly available if G 726 is supported s0_g726_vlcmode 0 1 4 4 Enable vlcmode for G 726 0 Standard mode 1 Solve compatibility problem with VLC player Only available if G 726 is supported alarm_enable boolean 4 4 Enable audio detection alarm_level 1 100 4 4 Audio detection alarm level profile_i0_enable boolean 4 4 Enable disable this profile setting profile_i0_policy night schedule 4 4 The mode which ...

Page 203: ... 9999 4 4 Coordinate of polygon window position 4 points x0 y0 x1 y1 x2 y2 x3 y3 Only available when capability_motion_wintype polygon Only available when std is listed in capability_motion_windomain objsize 1 100 4 4 Percent of motion detection window sensitivity Not recommended to use this 1 100 4 4 Sensitivity of motion detection window We replace sensitivity with win_sensitivity This parameter...

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

Page 205: ...ion_c 0 n 1 _profile_i 0 m 1 for m profile and n channel product n denotes the value of capability_nvideoin m denotes the vaule of capability_nmotionprofile capability_nmotionprofile 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable profile 1 m 1 policy night schedule 4 4 The mode which the profile is applied to Not support policy day anymore when the version number httpversion i...

Page 206: ...will not be used after the version number httpversion is equal or greater than 0400a polygonpx Not recommended to use this 0 W 0 H 0 W 0 H 0 W 0 H 0 W 0 H W 0 The current image width 1 H 0 The current image height 1 4 4 Coordinate of polygon window position 4 points x0 y0 x1 y1 x2 y2 x3 y3 Only available when capability_motion_wintype polygon Only available when px is listed in capability_motion_w...

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

Page 208: ...the width to offset to start to analysis the image dark_enable boolean 4 4 Enable or disable image too dark detection dark_threshold 0 100 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 brig...

Page 209: ...der _usernameem ail string 64 6 6 Your user name or email to login to the DDNS service provider provider _passwordkey string 64 6 6 Your password or key to login to the DDNS service provider provider _servername string 128 6 6 The server name for safe100 This field only exists if the provider is customsafe100 7 17 Express link Group expresslink PARAMETER VALUE SECURITY get set DESCRIPTION enable b...

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

Page 211: ... 6 Read only security name authpwrw string 8 128 6 6 Read write authentication password authpwro string 8 128 6 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 6 6 Read write passwrd encryptpwro string 8 128 6 6 Read only password encrypttyperw DES 6 6 Read write encryption type ...

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

Page 213: ...ordinate of window position Only available when capability_image_c n _privacymask_wintype rectangle win_i 0 m 1 _width 0 320 4 4 Width of privacy mask window Only available when capability_image_c n _privacymask_wintype rectangle win_i 0 m 1 _height 0 240 4 4 Height of privacy mask window Only available when capability_image_c n _privacymask_wintype rectangle win_i 0 m 1 _polygon 0 320 0 240 0 320...

Page 214: ...d m privacy mask window capability_image_c 0 n 1 _privacymask_wintype 3Drectangle n denotes the value of capability_nvideoin and m denotes the value of capability_videoin_c 0 n 1 _nprivacymask NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable the 3D privacy mask color 0 capability_image_c 0 n 1 _privacymask_ncolor 4 4 Privacy mask color win_i 0 m 1 _name string 40 4 4 Name of the p...

Page 215: ... version This may cause incompatibility with supporting software Minor version Increase the minor version when add new features interfaces without change the old features and interfaces Revision Increase the revision when fix bugs without change any features of the output _platform This is a constant it is used to distinguish between different platforms API version format MMmmr_k Where MM is the m...

Page 216: ... integer 0 7 Number of PIRs ndi 0 positive integer 0 7 Number of digital inputs nvi 0 positive integer 0 7 Number of virtual inputs manual trigger ndo 0 positive integer 0 7 Number of digital outputs naudioin 0 positive integer 0 7 The number of audio input channel 0 means no audio input support naudioout 0 positive integer 0 7 The number of audio output channel nvideoin positive integer 0 7 Numbe...

Page 217: ...tion 0 not support 1 support Bit 4 Support zoom operation 0 not support 1 support only available when RS 485 interface is supported or SD PZ PT PD video server series Bit 5 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 Reserved bit always 0 Bit 7 External or built in PT 0 built in 1 external windowless boo...

Page 218: ...unction npreset 0 positive integer 0 7 Number of preset locations eptz 0 positive integer 0 7 For nvideoin 1 the definition is as following A 32 bits integer each bit can be set separately as follows Bit 0 1st stream supports ePTZ or not Bit 1 2nd stream supports ePTZ or not and so on For nvideoin 2 the definition is different First all 32 bits are divided into groups for channel Ex nvideoin 2 bit...

Page 219: ... product is fisheye or not tampering boolean 0 7 Indicate whether to support tampering detection tamperingmode tamper toodark toob right tooblurry 0 7 Available tampering mode list Only available when capability_tampering is 1 adaptiverecording boolean 0 7 Indicate whether to support adaptive recording adaptivestreaming boolean 0 7 Indicate whether to support adaptive streaming supporttriggertypes...

Page 220: ...cate whether to support backchannel multicast protocol_rtp_tcp boolean 0 7 Indicate whether to support RTP over TCP protocol_rtp_http boolean 0 7 Indicate whether to support RTP over HTTP protocol_spush_mjpeg boolean 0 7 Indicate whether to support server push MJPEG protocol_snmp boolean 0 7 Indicate whether to support SNMP protocol_ipv6 boolean 0 7 Indicate whether to support IPv6 protocol_pppoe ...

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

Page 222: ...pport built in microphone input Not support this parameter anymore when the version number httpversion is equal or greater than 0301a We replace audio_mic with audio_intmic audio_intmic 0 Positive Integer 0 7 Internal Built in Microphone 0 Not support 1 Support Bit 0 for CH0 bit 1 for CH1 and so on audio_extmic 0 Positive Integer 0 7 External Microphone 0 Not support 1 Support Bit 0 for CH0 bit 1 ...

Page 223: ... audioout_codec g711 product dependent 0 7 Available codec list for SIP Not supported motion_wintype rectangle polygon 0 7 The supported motion window type polygon The window is a 2D polygon shape rectangle The window is a 2D rectangle shape motion_windomain 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 pix...

Page 224: ...able when capability_smartstream_support is 1 smartstream_nwindow_m anual positive integer 0 7 Maximum number of tracking window of manual only available when capability_smartstream_support is 1 smartstream_nwindow_h ybrid_autotracking positive integer 0 7 Maximum number of tracking window of autotracking in hybrid mode only available when capability_smartstream_support is 1 smartstream_nwindow_h ...

Page 225: ...customheater the threshold of heater can be sepcified by user only available when capability_thermal_support is 1 We support this parameter when the version number httpversion is equal or greater than 0302a thermal_temperaturedete ction boolean 0 7 Indicate whether to support temperature detection camctrl_httptunnel Not support anymore boolean 0 7 Indicate whether to support httptunnel Not support...

Page 226: ...ess WEP wireless_encrypt_wpa boolean 0 7 Indicate whether to support wireless WPA wireless_encrypt_wpa2 boolean 0 7 Indicate whether to support wireless WPA2 derivative_brand boolean 0 7 Indicate whether 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 sup...

Page 227: ...sist with capability_image_c0_ focusassist Reserved for compatibility and suggest don t use this since httpversion 0301a localstorage_manageable boolean 0 7 Indicate whether manageable local storage is supported localstorage_seamless boolean 0 7 Indicate whether seamless recording is supported localstorage_modnum 0 positive integer 0 7 The maximum MOD connection numbers localstorage_modversion str...

Page 228: ...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 0 Group capability_daynight_c 0 n 1 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION support boolean 0 7 Indicate whether the camera supports day night mode switch builtinir boo...

Page 229: ...ight_c n _support is 1 and capability_daynight_c n _ircutsensitivity_type is normalize We support this parameter when the version number httpversion is equal or greater than 0302a Group capability_videoin_c 0 n 1 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION lens_type fisheye fixed varifocal changeable motor product dependent 0 7 The lens type of this chan...

Page 230: ...7 The maximum resolution options listed in resolution in current video mode resolution A list of WxH product dependent 0 7 Resolution options in current video mode These options are the possible options for videoin_c n _s m _resolution The last one is the maximum resolution in current mode maxresolution A list of Integer 0 7 Represent supported maximum resolution of each stream in current video mo...

Page 231: ...ility_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 not support One to one mapping to the resol...

Page 232: ... and so on Only available when h265 is listed in capability_videoin_codec h265_maxbitrate positive integer 0 7 Maximum bitrates of H 265 The unit is bps Only available when h265 is listed in capability_videoin_codec fisheye_mounttype product dependent ceiling wall floor product dependent 0 7 Indicate the supported type wall mount 180 panoramic view ceiling mount 360 surround view without blind spo...

Page 233: ...rt this parameter when the version number httpversion is equal or greater than 0302b Group capability_videoin_c 0 n 1 _localdewarp capability_fisheyelocaldewarp_c 0 capability_nvideoin 1 0 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION typeceilingmount 1O 1P 2P 1R 4R 0 7 Available dewarp types of ceiling and floor mount typewallmount 1O 1P 1R 4R 0 7 Availab...

Page 234: ...ity_nvideoin m denotes the value of capability_videoin_c n _nmode PARAMETER VALUE SECURITY get set DESCRIPTION rotation boolean 0 7 Indicate this mode whether support video rotation effectivepixel WxH 0 7 The visible area of full scene in this video mode The unit is pixel in source This value must capability_videoin_c n _maxsize If effectivepixel capability_videoin_c n _max size then the visible a...

Page 235: ...options in this video mode The last one is the maximum resolution in this video mode The element number is defined as nresolution in this group maxresolution A list of Integer 0 7 Represent supported maximum resolution of each stream in current video mode The element number is defined as capability_nmediastream maxframerate A list of Positive Integer 0 7 Indicates frame rate that the video source ...

Page 236: ...deo 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 n _cmosfreq 60 or videoin_c n _modulation ntsc Only available when h264 is listed in capability_videoin_codec maxfps_h265 A list of Positive Integer and 0 7 Maximum fps which the device can encoded with H 265 o...

Page 237: ...ber is defined as capability_nresolution mjpeg_bitrate A list of Positive Integer and 0 7 Default setting of mjpeg bitrate on resolutions in this video mode means not support The element number is defined as capability_nresolution h264_framerate A list of Positive Integer and 0 7 Default setting of h264 framerate on resolutions in this video mode means not support The element number is defined as ...

Page 238: ... Sharpness or not 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 n _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_mode 1 then the...

Page 239: ...to one selection or value ranged UI is fixed to multiple selections or values Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Value can be a nonnegative integer or NULL means no feature is affected When wdrpro 0...

Page 240: ...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 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 ...

Page 241: ... available when capability_image_c n _is_mode is not We support this parameter when the version number httpversion is equal or greater than 0302a is_supportlevel 0 positive integer 0 7 Indicate the support strength level of image stabilizer mode Only available when capability_image_c n _is_mode is not We support this parameter when the version number httpversion is equal or greater than 0302a is_a...

Page 242: ...disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Value can be a nonnegative integer or NULL means no feature is affected Only available when capability_image_c n _is_mode is not We support this parameter when the version number httpversion is equal or greater than 0302a scenemode_support 0 1 0 7 0 Non support scene mode 1 Support...

Page 243: ...I 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 Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to l...

Page 244: ...I is hidden fixed UI is fixed to one selection or value ranged UI is fixed to multiple selections or values Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Value can be a nonnegative integer or NULL means no fea...

Page 245: ...ged UI is fixed to multiple selections or values Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Value can be a nonnegative integer or NULL means no feature is affected Only available when visibility is listed i...

Page 246: ...ue ranged UI is fixed to multiple selections or values Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Value can be a nonnegative integer or NULL means no feature is affected Only available when visibility is li...

Page 247: ...xposure control exposure_modetype auto shutterpriority irispriority manual product dependent 0 7 Available mode of exposure setting We support this parameter when the version number httpversion is equal or greater than 0302a exposure_rangetype onevalue twovalues 0 7 Support interface of exposure range onevalue The parameter is a constant value twovalues Need two parameters to indicate the exposure...

Page 248: ...d value videoin_c n _gainvalue not support Only available when capability_image_c n _exposure_ra ngetype is onevalue We support this parameter when the version number httpversion is equal or greater than 0302a exposure_automode_affe ct exposurewin mode blc hidd en defog disabled wdrpro disabled exposurelevel hidden or others x nonnegative integer product dependent 0 7 When exposure mode is enabled...

Page 249: ... NULL means no feature is affected Only available when auto is listed in capability_image_c n _ exposure_modetype and capability_image_c n _ exposure_mode is 1 We support this parameter when the version number httpversion is equal or greater than 0302a exposure_shutterpriority mode_affect exposurewin mode blc hidd en defog disabled wdrpro disabled exposurelevel hidden or others x nonnegative integ...

Page 250: ...ich means exposurelevel is fixed to level 6 Value can be a nonnegative integer or NULL means no feature is affected Only available when shutterpriority is listed in capability_image_c n _ exposure_modetype and capability_image_c n _ exposure_mode is 1 We support this parameter when the version number httpversion is equal or greater than 0302a exposure_irisprioritymod e_affect exposurewin mode blc ...

Page 251: ...e window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Value can be a nonnegative integer or NULL means no feature is affected Only available when irispriority is listed in capability_image_c n _ exposure_modetype and capability_image_c n _ exposure_mode is 1 We support this parameter when the version number httpversion is ...

Page 252: ... values Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Value can be a nonnegative integer or NULL means no feature is affected Only available when manual is listed in capability_image_c n _ exposure_modetype an...

Page 253: ...in qvga px std 0 7 The domain to set an exposure 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 exposure_winnum 0 Positive Integer 0 7 Indicate the number of custom exposure windows If no custom is listed in exposure_winmode this should be 0 exposure_ntsc_totalrange A list of Positive Integer 0 7 Avai...

Page 254: ...le 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_windomain qvga px std 0 7 The domain to set an 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 priva...

Page 255: ...ormat is Affect API name Policy Value 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 Affect API name can be described in hierarchy such as exposurewin mode blc disabled ...

Page 256: ...eger 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 Value 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 o...

Page 257: ...ternal parameter must not open to user 0 Non support low light mode 1 Support low light mode backfocus 0 1 0 7 0 Non support back focus 1 Support back focus focusassist 0 1 0 7 0 Non support focus assist 1 Support focus assist remotefocus 0 1 0 7 0 Non support remote focus 1 Support remote focus focuswindomain qvga px std 0 7 The domain to set an focus window qvga a 320x240 range to represent the ...

Page 258: ...et set DESCRIPTION iristotalrange A list of iris value 0 7 Available total step for iris value We support this parameter when the version number httpversion is equal or greater than 0302a Group capability_peripheral_c 0 n 1 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION waterspray_support boolean 0 7 0 Non support water spray feature 1 Support water spray f...

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

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

Page 261: ... digital output trigger in seconds Only available when capability_ndo 0 action_cf_enable Boolean 6 6 Enable or disable sending media to SD card action_cf_folder string 128 6 6 Path to store media action_cf_media NULL 0 4 101 6 6 Index of the attached media 101 means Recording Notify action_cf_datefolder boolean 6 6 Enable this to create folders by date time and hour automatically action_cf_backup ...

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

Page 263: ...eam and etc 2 means the third stream and etc 3 means the fourth stream and etc snapshot_prefix string 16 6 6 Indicate the prefix of the filename media_i0 Snapshot1_ media_i1 Snapshot2_ media_i2 Snapshot3_ media_i3 Snapshot4_ media_i4 Snapshot5_ snapshot_datesuffix 0 1 6 6 Add date and time suffix to filename 1 Add date and time suffix 0 Do not add snapshot_preevent 0 capability_media_snapshot_maxp...

Page 264: ...es 7 30 Recording Group recording_i 0 1 PARAMETER VALUE SECURITY get set DESCRIPTION name string 40 6 6 Identification of this entry trigger schedule networkfail 6 6 The event trigger type schedule The event is triggered by schedule networkfail The event is triggered by the failure of network connection enable boolean 6 6 Enable or disable this recording priority 0 1 2 6 6 Indicate the priority of...

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

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

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

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

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

Page 270: ...H product dependent 1 7 ROI left top corner coordinate If the minimal window size is 64x64 then the win_i0_home 0 resolution_W 64 0 resolution_H 64 which the resolution is the value in current stream s m 1 _size WxH product dependent 1 7 ROI width and height The width value must be multiples of 16 and the height value must be multiples of 8 The minimal window size is 64x64 7 34 ePTZ setting Group ...

Page 271: ...than by setparam cgi Group eptz_c 0 n 1 _s 0 m 1 for n channel product and m is the number of streams which support ePTZ capability eptz 0 PARAMETER VALUE SECURITY get set DESCRIPTION patrolseq string 120 1 4 The patrol sequence of ePTZ All the patrol position indexes will be separated by patroldwelling string 160 1 4 The dwelling time unit second of each patrol point separated by preset_i 0 19 _n...

Page 272: ...lue in current stream win_i0_size WxH product dependent 4 4 Width and height of the window The minimal window size is 192x144 7 36 Seamless recording setting Group seamlessrecording capability localstorage seamless 0 PARAMETER VALUE SECURITY get set DESCRIPTION diskmode seamless manageable 1 6 seamless indicates enable seamless recording manageable indicates disable seamless recording maxconnectio...

Page 273: ...n order of the enabled modules module_save2sd boolean 6 6 Indicate if the module should be saved to SD card when user want to upload it If the value is false save module to the internal storage space and it will occupy storage size number string 128 6 7 This number is used to register license key for VADP application Group vadp_module_i 0 n 1 for n VADP package number capability_vadp_npackage 0 n ...

Page 274: ...module use VIVOTEK license mechanism Group vadp_schedule_i 0 n 1 for n VADP package number n denotes the value of capability_vadp_npackage Only available when capability_vadp_npackage 0 and the version number of vadp_version is equal or greater than 1 3 2 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable or disable the schedule mode to control the execution of the VADP package be...

Page 275: ...ernal device The indexes of patrol points separated by patroldwelling string 160 1 4 For external device The dwelling time of each patrol point separated by preset_i 0 capability_n preset 1 _name string 40 1 4 Name of the preset location preset_i 0 capability_n preset 1 _ dwelling 0 999 1 4 The dwelling time of each preset location uart 0 capability_nuart 1 1 4 Select corresponding uart capability...

Page 276: ...the corresponding ID panspeed 5 5 1 4 Pan speed tiltspeed 5 5 1 4 Tilt speed zoomspeed 5 5 1 4 Zoom speed autospeed 5 5 1 4 Auto pan speed focusspeed 5 5 1 4 Auto focus speed preset_i 0 k 1 _name string 40 1 4 Name of the preset location preset_i 0 k 1 _pan capability_ptz_minpan capability_ptz_maxpan 1 4 Pan position at each preset location preset_i 0 k 1 _tilt capability_ptz_mintilt capability_pt...

Page 277: ...talzoom boolean 1 4 Enable disable digital zoom idleaction_enable boolean 1 4 Enable disable idle action while idle idleaction_type pan patrol 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 horizontalalignment boolean 1 4 Once you enable this feature a reference line w...

Page 278: ...1 4 Name of the PTZ driver ptzdrivers_i 0 19 127 _location string 128 1 4 Full path of the PTZ driver enablehttptunnel boolean 1 4 Enable HTTP tunnel channel to control UART Group uart_i 0 n 1 n is uart port count capability nuart 0 and capability fisheye 0 NAME VALUE SECURITY get set DESCRIPTION baudrate 110 300 600 1200 2400 3600 4800 72 00 9600 19200 384 00 57600 115200 4 4 Set baud rate of COM...

Page 279: ...5 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 camera will only accept the inputs with the corresponding ID baudrate 110 300 600 1200 2400 3600 4800 72 00...

Page 280: ...ault group Group lens_default NAME VALUE SECURITY get set DESCRIPTION totalnumbers 0 positive integer 6 7 Totoal support number of the default lens profiles Group lens_user NAME VALUE SECURITY get set DESCRIPTION totalnumbers 0 positive integer 6 7 Totoal support number of the user lens profiles Group lens_default_i 0 n 1 n is lens_default_totalnumbers NAME VALUE SECURITY get set DESCRIPTION name ...

Page 281: ... tiltspeed 5 5 integer 1 4 Tilt speed of regional view zoomspeed 5 5 integer 1 4 Zoom speed of regional s 0 m 2 _panorama_ panstart 0 359 integer 1 4 Initial pan position of panorama view only available for 1P and 2P mode at ceiling or floor mount s 0 m 2 _region_pan 90 359 integer 1 4 Pan home angle of regional view Pan range of ceiling floor mount is 0 359 Pan range of wall mount is 90 90 s 0 m ...

Page 282: ...set DESCRIPTION objsize_type 1 2 1 4 Type of object size 1 customized width and height 0 object size 30 x 30 1 object size 10 x 20 2 object size 10 x 10 objsize_customized_width 10 320 1 4 The minimum width of tracking target objsize_customized_height 10 240 1 4 The minimum height of tracking target sensitivity 0 2 1 4 Tracking sensitivity 0 Low 1 Medium 2 High ...

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

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

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

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

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

Page 288: ...ctrl eCamCtrl cgi channel 0 stream 0 move right http myserver cgi bin camctrl eCamCtrl cgi channel 0 stream 1 vx 2 vy 2 vz 2 http myserver cgi bin camctrl eCamCtrl cgi channel 0 stream 1 x 100 y 100 videosize 640x480 resolution 640x480 stretch 0 In zoom operation there are two ways to control it scale zoom and area zoom 1 Scale zoom contains two control method relative movement and continuous move...

Page 289: ... y w h are essential parameters in an area zoom case and the stream index is counted from 0 as the first stream http IPAddr cgi bin camctrl eCamCtrl cgi channel 0 stream 0 x 912 y 297 w 864 h 488 resolution 1920x1080 PARAMETER VALUE DESCRIPTION channel 0 n 1 Channel of video source stream 0 m 1 Stream move home Move to home ROI up Move up down Move down left Move left right Move right auto pan Aut...

Page 290: ...e coordinate system 1 indicates that it usesvideosize plug in size as the range of the coordinate system speedpan 5 5 Set the pan speed speedtilt 5 5 Set the tilt speed speedzoom 5 5 Set the zoom speed speedapp 1 5 Set the auto pan patrol speed return return page Redirect to the page return page after the parameter is assigned The return page can be a full URL path or relative path according to th...

Page 291: ... privileges Method GET POST Syntax http servername cgi bin operator ePreset cgi channel value stream value addpos value delpos value return return page PARAMETER VALUE DESCRIPTION channel 0 n 1 Channel of the video source stream 0 m 1 Stream addpos Text string less than 40 characters Add one preset location to the preset list delpos Text string less than 40 characters Delete preset location from t...

Page 292: ...Pv6 address from access list ip IP address Single address IP address Network address IP address network mask Range address start IP address end IP address index value The start position to add or to delete return return page Redirect to the page return page after the parameter is assigned The return page can be a full URL path or relative path according to the current path If you omit this paramet...

Page 293: ... 13 UART HTTP Tunnel Channel capability nuart 0 Note This request requires Operator privileges Method GET and POST Syntax http servername cgi bin operator uartchannel cgi channel value GET cgi bin operator uartchannel cgi channel value x sessioncookie string 22 accept application x vvtk tunnelled pragma no cache cache control no cache POST cgi bin operator uartchannel cgi x sessioncookie string 22...

Page 294: ... control no cache POST cgi bin admin ctrlevent 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 co...

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

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

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

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

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

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

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

Page 302: ...erform auto focus scan Perform focus scan stop Stop current operation positioning Position the motors irisopen Open iris It will maintain this status until sending irisenable cgi irisenable Not open iris resetfocus reset focus motor to default valuegetstatus Information of motors return value as below remote_focus_focus_motor_max Maximum steps of focus motor remote_focus_focus_motor_start Start po...

Page 303: ...lied from function getstatus iris N A Open iris or not It works only if function auto scan 8 22 Export Files Note This request requires Administrator privileges Method GET Syntax For daylight saving time configuration file http servername cgi bin admin exportDst cgi For language file http servername cgi bin admin export_language cgi currentlanguage value PARAMETER VALUE DESCRIPTION currentlanguage...

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

Page 305: ...or delete selected lens configuration http servername cgi bin admin update_lens cgi delete_lens value PARAMETER VALUE DESCRIPTION value string Available lens name Please refer to lens_default_i 0 n 1 _name lens_user_i 0 n 1 _name n is a positive integer Method POST Syntax For upload user defined lens configuration http servername cgi bin admin update_lens cgi upload_lens Post data upload_lens_prof...

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

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

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

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

Page 310: ...ion x y based on resolution or videosize speedpan value speedtilt value speedzoom value speedapp value speedlink val ue Set speeds return return page Example http myserver cgi bin camctrl camctrl cgi channel 0 camid 1 move right http myserver cgi bin camctrl camctrl cgi channel 0 camid 1 zoom tele http myserver cgi bin camctrl camctrl cgi channel 0 camid 1 x 300 y 200 resolution 704x480 videosi ze...

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

Page 312: ...turn page can be a full URL path or relative path according to the current path If you omit this parameter it will redirect to an empty page 8 30 Preset Locations capability ptzenabled 0 Note This request requires Operator privileges Method GET POST Syntax http servername cgi bin operator preset cgi channel value addpos value delpos value return return page PARAMETER VALUE DESCRIPTION addpos strin...

Page 313: ...VIVOTEK User s Manual 313 The return page can be a full URL path or relative path according to the current path If you omit this parameter it will redirect to an empty page End of document ...

Page 314: ...fications Compatible Accessories VCA Line crossing detection field detection loitering detection Alarm and Event Alarm Triggers Video motion detection manual trigger digital input periodical trigger system boot recording notification camera tampering detection audio detection Alarm Events Event notification using digital output HTTP SMTP FTP and NAS server SD Card File upload via HTTP SMTP FTP NAS...

Page 315: ...ons Compatible Accessories Alarm Triggers Video motion detection manual trigger digital input periodical trigger system boot recording notification camera tampering detection audio detection Alarm Events Event notification using digital output HTTP SMTP FTP and NAS server SD Card File upload via HTTP SMTP FTP NAS server and SD card General Smart Focus System TB53B6 HT EHT Remote Focus Connectors R...

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

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