DELTA GROUP VIVOTEK CU9171 User Manual Download Page 96

Page: 96 / 411

VIVOTEK

96 - User's Manual

Authentication: Depending on your network security requirements, the Network Camera provides

three types of security settings for streaming via RTSP protocol: disable, basic, and digest.

basic

authentication is selected, the password is sent in plain text format, but there can be

potential risks of it being intercepted. If

digest

authentication is selected, user credentials are

encrypted using MD5 algorithm, thus providing better protection against unauthorized access.

The availability of the RTSP streaming for the three authentication modes is listed below:

Access name for stream 1 ~ 3: This Network camera supports multiple streams simultaneously.

The access name is used to differentiate the streaming source.

If you want to use an

RTSP player

to access the Network Camera, you have to set the video mode

H.264 or H.265

and use the following RTSP URL command to request transmission of the

streaming data.

rtsp://<ip address>:<rtsp port>/<access name for stream 1 to 3>

For example, when the access name for

stream 1

is set to

live1s1.sdp

1. Launch an RTSP player.

2. Choose File > Open URL. A URL dialog box will pop up.

3. Type the above URL command in the text box.

4. The live video will be displayed in your player as shown below.

RTSP port /RTP port for video, audio/ RTCP port for video, audio

■ RTSP (Real-Time Streaming Protocol) controls the delivery of streaming media. By default, the

port number is set to 554.

■ The RTP (Real-time Transport Protocol) is used to deliver video and audio data to the clients. By

default, the RTP port for video is set to 5556.

■ The RTCP (Real-time Transport Control Protocol) allows the Network Camera to transmit the

data by monitoring the Internet traffic volume. By default, the RTCP port for video is set to 5557.

The ports can be changed to values between 1025 and 65535. The RTP port must be an even

number and the RTCP port is the RTP port number plus one, and thus is always an odd number.

When the RTP port changes, the RTCP port will change accordingly.

If the RTP ports are incorrectly assigned, the following warning message will be displayed:

VLC

Disable

Basic

Digest

rtsp://192.168.5.151:554/live1s1.sdp

Summary of Contents for VIVOTEK CU9171

Page 1: ...User s Manual 5MP Multiple Fixed or Fisheye Lens Options Day Night Smart Motion Detection Smart VCA Smart Stream III Split Type Network Camera VC9101 CU9171 CU9183 Rev 1 0 ...

Page 2: ...m Homepage layout 52 System Logs 55 System Parameters 58 System Maintenance 59 Media Image 62 Media Video 74 Media Video 75 Media Audio 84 Media profiles 86 Network General settings 87 Network Streaming protocols 94 Network SNMP Simple Network Management Protocol 104 Network FTP 105 Bonjour 106 Security User accounts 107 Security HTTPS Hypertext Transfer Protocol over SSL 109 Security Access List ...

Page 3: ...th 5 meter long cable to be easily and flexibly installed into any decoration or interior design thus preserving stylish appearances while dramatically saving on installation time and cost The VC9101 can support one camera unit and is designed to work in perfect harmony with a choice of two 2 megapixel WDR camera units the pinhole type and the fisheye type for 180 Panoramic View Both camera units ...

Page 4: ... utilize the Network Camera and ensure proper operations For creative and professional developers the URL Commands of the Network Camera section serves as a helpful reference to customizing existing homepages or integrating with the current web server Revision History Rev 1 0 Initial release IMPORTANT 1 The product must be installed and protected in a location that is not easily accessible and is ...

Page 5: ... IMPORTANT 1 The camera is only to be connected to PoE networks without routing to outside plants 2 For PoE connection use only UL listed I T E with PoE output 1 La caméra ne doit être raccordée qu à des réseaux PoE sans routage vers des installations extérieures 2 Pour les raccordements PoE utilisez uniquement un équipement de TI homologué UL avec une sortie PoE Use the camera only with a DC powe...

Page 6: ...TEK 6 User s Manual OR DC8 36V PoE 802 3af 256GB 10 I 1 Application View Physical Description MicroSD card slot Audio jacks To lens module DC plug Ethernet port DI DO terminal CU9171 H CU9183 H Fisheye lens ...

Page 7: ...VIVOTEK User s Manual 7 24 18 CU9171 H CU9183 H Pinhole ...

Page 8: ... Below are things to notice connecting a ground wire 1 The minimum ground screw type is 3 5mm 2 The minimum ground wire gauge is 18AWG 3 Use green yellow green yellow stripe ground wires 4 Use a knurled washer for securing the grounding srew ...

Page 9: ... is subject to the following two conditions 1 this device may not cause harmful interference and 2 this device must accept any interference received including interference that may cause undesired operation Made in Taiwan 1 Jot down the camera s MAC address for later reference 2 Depending on the types of lens you choose prepare to drill holes on a wall or panel Ø24mm Ø21mm Ø12mm Pin hole ...

Page 10: ...VIVOTEK 10 User s Manual 3 Connect the necessary interfaces 4 The 5 meter cable has one Ethernet connector and a USB type C connector to connect the lens module OR DC8 36V PoE 802 3af 256GB 10 I 1 5m ...

Page 11: ...VIVOTEK User s Manual 11 5 Drill a hole for your lens module Below are the types of installation for different mount brackets and lenses 24 21 12mm A B C D ...

Page 12: ...VIVOTEK 12 User s Manual A 2 Route the module cable A A1 A 1 Insert the lens module into the clamp bracket ...

Page 13: ...VOTEK User s Manual 13 24 2mm Insert the module into the through hole 180º CU9183 H Note that the fisheye lens must be aligned with the edge of the through hole otherwise the field of view will be blocked ...

Page 14: ...VIVOTEK 14 User s Manual CU9183 H 93º The same applies to the pinhole lens ...

Page 15: ...VIVOTEK User s Manual 15 A3 Adjust the orientation of the lens so that the field of view can be properly aligned A4 Tighten the retention screw on the clamp bracket ...

Page 16: ...VIVOTEK 16 User s Manual A6 A5 Peel off the sticker cover You can fasten 2 screws to attach the bracket to a wall or panel ...

Page 17: ...2 inch 5 08mm B1 CU9183 HF For a thinner panel drill a hole and fasten the lens module using the included hex nut C 0 1 inch 2 54mm C1 CU9171 HF For a thinner panel drill a hole and fasten the lens module using the included hex nut ...

Page 18: ...VIVOTEK 18 User s Manual D 1 D1 CU9171 HF CU9183 HF For using the snap on bracket press fit the lens module 2 x2 D2 Secure the installation by fastening two screws from the top ...

Page 19: ...VIVOTEK User s Manual 19 4 D3 Attach the bracket to a panel with a pre drilled hole For the hole diameters refer to the previous description D3 Peel off the sticker cover 3 ...

Page 20: ... can also use a standard wall mount bracket along with a clamp bracket to install the lens module Install the clamp bracket by turing it clockwise onto the threaded pole E2 You can then tilt or rotate to find a best shooting direction ...

Page 21: ...VIVOTEK User s Manual 21 55mm 7 You can mount the VC9101 main unit to a wall by drilling 2 screw holes 55mm apart Hang the unit onto the screws ...

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

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

Page 24: ...harmful interference and 2 this device must accept any interference received including interference that may cause undesired operation Pat 6 930 709 MAC 0002D1730202 Ro HS 9 3 The program will search for all VIVOTEK network devices on the same LAN 9 4 After a brief search the installer window will prompt Click on the MAC and model name that matches the one printed on the product label You can then...

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

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

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

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

Page 30: ...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 31: ... 80 122 146 57 120 8001 192 168 2 11 80 When properly configured you can access a camera behind the router using the HTTP request as follows http 122 146 57 120 8000 If you change the port numbers on the Network configuration page please open the ports accordingly on your router For example you can open a management session with your router to configure access through the router to the camera with...

Page 32: ... on LAN If your network environment is not a LAN follow these steps to access the Netwotk Camera 1 Launch your web browser e g Microsoft Internet Explorer or Mozilla Firefox 2 Enter the IP address of the Network Camera in the address field Press Enter 3 Live video will be displayed in your web browser 4 If it is the first time installing the VIVOTEK network camera an information bar will prompt as...

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

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

Page 35: ...r 554 please set the RTSP port to 554 For more information please refer to RTSP Streaming on page 95 For example 4 The live video will be displayed in your player For more information on how to configure the RTSP access name please refer to RTSP Streaming on page 95 for details 1 Launch the RTSP player 2 Choose File Open URL A URL dialog box will pop up 3 The address format is rtsp ip address rtsp...

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

Page 38: ...ra Control Area Configuration Area Host Name Resize Buttons Profile mode 4 pre configured streaming profiles are provided through here Max view Recording view Live view and App Each mode features a different stream source channel resolution multicast and metadata configuration The profiles can be configured in Configuration Media Media profiles Manual Trigger Click to enable disable an event trigg...

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

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

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

Page 42: ...image and choose Save Picture As to save it in JPEG jpg or BMP bmp format Digital Zoom Click and uncheck Disable digital zoom to enable the zoom operation The navigation screen indicates the part of the image being magnified To control the zoom level drag the slider bar To move to a different area you want to magnify drag the navigation screen Start MP4 Recording Click this button to record video ...

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

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

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

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

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

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

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

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

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

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

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

Page 60: ...es below on this page Custom Language Select this option to retain the Custom Language settings VADP Retain the VADP modules 3rd party software stored on the SD card and related settings Focus position Retain the lens focus position using the previously saved position parameters If none of the options is selected all settings will be restored to factory default The following message is displayed d...

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

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

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

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

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

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

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

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

Page 69: ...e Exposure time and Gain control slide bars to specify a range of shutter time and Gain control values within which the camera can automatically tune to an optimal imaging result You may prefer a shorter shutter time to better capture moving objects while a faster shutter reduces light and needs to be compensated by electrical brightness gains Exposure mode available when WDR Pro is disabled You c...

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

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

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

Page 73: ...f a doorway This application aims to identify a subject passing through a specific area 4 Other factors may include that a person will move in your area of interest The face may not always face the camera 5 Details can be affected by weak lighting or the view angle Therefore higher the pixels higher the chance you can identify the subject 6 The pixel calculator visual tool looks like the following...

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

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

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

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

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

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

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

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

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

Page 83: ...ality and for recognizing moving objects in the field of view If the power line frequency is set to 50Hz the frame rates are selectable at 1fps 2fps 3fps 5fps 8fps 10fps 12fps 15fps and up to 25fps If the power line frequency is set to 60Hz the frame rates are selectable at 1fps 2fps 3fps 5fps 8fps 10fps 12fps 15fps and up to 30fps You can also select Customize and manually enter a value The IB936...

Page 84: ...g to ambient conditions Adjust the gain from 21 db most sensitive or 33 db least sensitive 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 o...

Page 85: ...d an audio clip if available Because the memory space is limited a recording count down will be available on screen You can also upload an audio file to the camera s flash memory With amplified speakers you can playback the audio e g to deter an intruder A maximum of 2 audio clips in wav format are supported The maximum size of the audio file to be uploaded is 2 000Kbytes The voice alert is enable...

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

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

Page 88: ... 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 89: ...Error Router does not support UPnP port forwarding Steps to enable the UPnPTM user interface on your computer Note that you must log on to the computer as a system administrator to install the UPnPTM components 1 Go to Start click Control Panel then click Add or Remove Programs 2 In the Add or Remove Programs dialog box click Add Remove Windows Components 3 In the Windows Components Wizard dialog ...

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

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

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

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

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

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

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

Page 97: ...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 98: ...h 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 Stream settings on the Client Settings page Please refer to Client Settings on page 43 and Stream settings on page 79 SIP SIP is shor...

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

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

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

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

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

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

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

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

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

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

Page 109: ...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 110: ...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 111: ...ate certificate to proceed 3 The following information will show up in a pop up window after clicking Create Then click Save to generate the certificate request 4 The Certificate request window will prompt If you see the following Information bar click OK and click on the Information bar at the top of the page to allow pop ups ...

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

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

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

Page 115: ... been created and installed before you can click on the Save button for the configuration to take effect 12 To begin an encrypted HTTPS session click Home to return to the main page Change the URL 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 116: ... 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 117: ...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 118: ... 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 119: ...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 120: ...ork Camera the supplicant and the RADIUS Server the authentication server 2 A Network Camera requests access to the protected LAN using 802 1X via a switch the authenticator The client offers its identity and client certificate which is then forwarded by the switch to the RADIUS Server which uses an algorithm to authenticate the Network Camera and returns an acceptance or rejection back to the swi...

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

Page 122: ...trol settings section will be displayed as shown below For e PTZ related details please refer to page 124 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 the next page When complet...

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

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

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

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

Page 129: ...eo or system logs depending on your event settings Once the triggers are configured they will be listed under the VADP option Configure CameraLink The camera can be associated with another camera with responsive actions For example if a thermal camera detects some abnormal situations e g a fire the camera can tell another camera say a PTZ camera to move to a preset position to observe the current ...

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

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

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

Page 135: ...setting URL Enter the URL of the HTTP server User name Enter the user name if necessary Password Enter the password if necessary To verify if the HTTP settings are correctly configured click Test The result will be shown in a pop up window as shown below If successful you will receive a test txt file on the HTTP server Click Save server to enable the settings ...

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

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

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

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

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

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

Page 144: ...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 127 for detailed information ...

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

Page 146: ... 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 147: ... Refer to page 84 for Audio settings and page 74 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 148: ... intelligent video applications such as license plate recognition object counting or as an agent for edge recording etc Once the software package is successfully uploaded the module configuration vadp xml information is displayed When uploading a module the camera will examine whether the module fits the predefined VADP requirements Please contact our technical support or the vendor of your 3rd pa...

Page 149: ...he end of the row Click on the X button to remove an existing module When prompted by a confirm message Click Yes to proceed Yes No Note that the actual memory consumed while operating the module will be indicated on the Memory status field This helps determine whether a running module has consumed too much of system resources To utilize a software module acquire the software package and click Bro...

Page 150: ...page register and activate the license for using VIVOTEK s VADP modules You should acquire the license key elsewhere and manually upload to the network camera Follow the onscreen instruction on VIVOTEK s website for the registration procedure ...

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

Page 155: ...on about folder naming rules please refer to page 136 for details 20190210 20190211 20190212 f you want to enable recording notification please click Event to configure event triggering settings Please refer to Event Event settings on page 126 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 156: ...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 can...

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

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

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

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

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

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

Page 166: ...p _ 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 r n Context Length length ...

Page 168: ...h like videoin_c0_s0_h264_resolution videoin_c0_s0_h264_maxframe etc value The assigned value to the parameter return page Redirect to the page return page after the parameter is assigned The return page can be a full URL path or relative path according to the current path If you omit this parameter it will redirect to an empty page Note The return page can be a general HTML file htm html It canno...

Page 169: ...022 VIVOTEK INC All Right Reserved 31 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 170: ...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 description integer primary key SQLite data type A 32 bit signed integer The value is assigned a unique i...

Page 171: ...nt date of system Set to keep to keep date unchanged Set to auto to use NTP to synchronize date time hh mm ss keep auto 6 6 Current time of the system Set to keep to keep time unchanged Set to auto to use NTP to synchronize time datetime MMDDhhmm YYYY 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 defaul...

Page 172: ...adrid Paris Warsaw Budapest Bern 41 GMT 01 00 Amsterdam Berlin Rome Stockholm Vienna Madrid Paris Warsaw Budapest Bern 80 GMT 02 00 Athens Helsinki Riga 81 GMT 02 00 Cairo 82 GMT 02 00 Lebanon 83 GMT 02 00 120 GMT 03 00 Baghdad Kuwait Riyadh Nairobi 121 GMT 03 00 Iraq Minsk 140 GMT 03 30 Tehran 160 GMT 04 00 Abu Dhabi Muscat Baku Tbilisi Yerevan Moscow St Petersburg 180 GMT 04 30 Kabul 200 GMT 05 ...

Page 173: ...aylight_auto_endtime string 19 6 7 Display the current daylight saving end time daylight_timezones 360 320 280 240 241 200 140 121 40 0 40 41 80 82 83 140 380 480 6 7 List time zone index which support daylight saving time The timezone list can t be modified for the version number httpversion equal or greater than 0316b we recommend using system_tz for customized time settings instead updateinterv...

Page 174: ...e restored to default values except for a union of combined results restoreexceptlang 0 positive integer 7 6 Restore the system parameters to default values except the custom language file the user has uploaded 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 r...

Page 175: ...0 connection_timeout integer 6 6 Session connection timeout interval Only available when capability_taics_support 1 7 1 1 System Info Subgroup of system info The fields in this group are unchangeable NAME VALUE SECURITY get set DESCRIPTION modelname string 40 0 7 Internal model name of the server extendedmodelname string 40 0 7 ODM specific model name of server eg DCS 5610 If it is not an ODM mode...

Page 176: ...m languages which have been uploaded to the server customlanguage_i 0 maxcount 1 string 0 6 Custom language name 7 2Status Group status NAME VALUE SECURITY get set DESCRIPTION di_i 0 k 1 product dependent boolean 1 7 0 Inactive normal 1 Active triggered capability_ndi 0 k is determined by the below criterion The following applies for capability_extension_di_num 0 if extension_connected 1 k capabil...

Page 177: ...num_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 2 1 Status per Channel Group status_c 0 n 1 for n channel products n denotes the value of capability_nvideoin NAME VALUE SECURITY get set DESCRIPTION signal_detect boolean ...

Page 178: ... 0 k is determined by the below criterion The following applies for capability_extension_do_num 0 if extension_connected 1 k capability_ndo if extension_connected 0 k capability_ndo capability_extension_do_num Otherwise k capability_ndo NAME VALUE SECURITY get set DESCRIPTION normalstate open grounded 1 1 Indicate open circuit or closed circuit inactive status 7 5Security Group security NAME VALUE...

Page 179: ...TTP service Bit 1 HTTPS service Bit 2 FTP service Bit 3 Two way audio and RTSP Streaming service To stop service before changing its port settings It s recommended to set this parameter when change a service port to the port occupied by another service currently Otherwise the service may fail Stopped service will auto start after changing port settings Ex Change HTTP port from 80 to 5556 and chang...

Page 180: ... 6 Selected EAP method identity_peap string 64 6 6 PEAP identity identity_tls string 64 6 6 TLS identity password string 200 7 6 Password for TLS privatekeypassword string 200 7 6 Password for PEAP ca_exist boolean 6 6 CA installed flag ca_time 0 positive integer 6 7 CA installed time Represented in EPOCH ca_size 0 positive integer 6 7 CA file size in bytes certificate_exist boolean 6 6 Certificat...

Page 181: ...video 0 63 6 6 Video channel for DSCP audio 0 63 6 6 Audio channel for DSCP capability_naudioin 0 eventalarm 0 63 6 6 Event alarm channel for DSCP management 0 63 6 6 Management channel for DSCP eventtunnel 0 63 6 6 Event Control channel for DSCP 7 6 3 IPV6 Subgroup of network ipv6 capability_protocol_ipv6 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable IPv6 addonipaddress ip a...

Page 182: ...video1s1 mjpg c0_s0_accessname channel1stream1 video1s2 mjpg c0_s1_accessname channel1stream2 video1s3 mjpg c0_s2_accessname channel1stream3 video1s4 mjpg c0_s3_accessname channel1stream4 etc We replace this parameter with network_http_c 0 capability_nvideoin 1 _s 0 capability_nmediastream 1 _accessname when the version number httpversion is equal or greater than 0311c 7 6 6 HTTP per Channel Subgr...

Page 183: ...tps 0 NAME VALUE SECURITY get set DESCRIPTION port 443 1025 65535 1 6 HTTPS port 7 6 8 RTSP Subgroup of network rtsp capability_protocol_rtsp 0 NAME VALUE SECURITY get set DESCRIPTION port 554 1025 65535 1 6 RTSP port capability_protocol_rtsp 1 authmode disable basic digest 1 6 RTSP authentication mode capability_protocol_rtsp 1 s 0 capability_nmed iastream capability_n videoin 1 _accessname produ...

Page 184: ...own as live1s1 sdp c0_s0_accessname channel1stream1 live1s2 sdp c0_s1_accessname channel1stream2 live1s3 sdp c0_s2_accessname channel1stream3 live1s4 sdp c0_s3_accessname channel1stream4 etc Values start with prefix cgi bin are prohibited For example c cg cgi cgi cgi b cgi bi cgi bin are not allowed We modify the value of RTSP access name after version number httpversion is 0311c pimssm_enable boo...

Page 185: ... dependent ip address 4 4 Multicast audio IP address We support this parameter when the version number httpversion is equal or greater than 0304a Only available when capability_naudioin 0 metadataipaddres s ip address 4 4 Multicast metadata IP address We support this parameter when the version number httpversion is equal or greater than 0304a videoport 1025 65535 4 4 Multicast video port audioport...

Page 186: ...onjour Subgroup of network service_bonjour NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable bonjour service feature We support this parameter when the version number httpversion is equal or greater than 0312a servicename string 6 6 A friendly name for bonjour service We support this parameter when the version number httpversion is equal or greater than 0312a 7 6 14 SFTP server Onl...

Page 187: ... 9 string 43 6 6 IPv6 address list 7 8Video Input Not Recommended to use Group videoin We do not support this parameter when capability_nvideoin 1 NAME VALUE SECURITY get set DESCRIPTION cmosfreq 50 60 4 4 CMOS frequency Only available when capability_videoin_type is 2 We do not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion i...

Page 188: ...cally for outdoor indoor auto white balance mode specifically for indoor sodiumauto sodium vapor lamps Only available when capability_image_c 0 n 1 _wbmode We do not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a exposurelevel 0 12 4 4 Exposure level 0 12 This range takes the concept from DC s ex...

Page 189: ...r the version number httpversion is equal or greater than 0400a enableblc Not support anymore boolean 4 4 Enable backlight compensation Not support this parameter anymore when the version number httpversion is equal or greater than 0301a It s recommanded to use exposurewin_c 0 n 1 _mode to switch on off BLC color 0 1 4 4 0 monochrome 1 color Only available when capability_videoin_c 0 n 1 _color_su...

Page 190: ...port camera control function 0 not support 1 support Bit 1 Built in or external camera 0 external 1 built in Bit 2 Support pan operation 0 not support 1 support Bit 3 Support tilt operation 0 not support 1 support Bit 4 Support zoom operation 0 not support 1 support Bit 5 Support focus operation 0 not support 1 support SD PZ IZ series only Not support this parameter anymore when the version number...

Page 191: ...ideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a maxexposure product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_ c 0 n 1 _exposure_max range 4 4 Maximum exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc This parameter may also restrict image fra...

Page 192: ...bility_nvideoin m denotes the value of capability_nmediastream NAME VALUE SECURITY get set DESCRIPTION cmosfreq 50 60 4 4 CMOS frequency Only available when capability_videoin_type is 2 mode 0 capability_videoin_c 0 n 1 _nmode 1 4 4 Indicate the video mode on use whitebalance product dependent auto panorama manual rbgain widerange outdoor indoor sodiumauto etc Available values are listed in capabi...

Page 193: ...lable when rbgain is listed in capability_image_c 0 n 1 _wbmode Only valid when videoin_c 0 n 1 _whitebalance auto Normalized range bgain 0 100 4 4 Manual set bgain value of gain control setting 0 Weak 100 Strong Only available when rbgain is listed in capability_image_c 0 n 1 _wbmode Only valid when videoin_c 0 n 1 _whitebalance auto Normalized range exposurelevel 0 12 4 4 Exposure level 0 12 Thi...

Page 194: ...by VIVOTEK quality algorithm manual Manually adjust with variable Shutter Iris and Gain We support this parameter when the version number httpversion is equal or greater than 0302a Only available when capability_image_c 0 n 1 _exposure_mode 0 irismode fixed indoor outdoor product dependent 4 4 Control DC Iris mode outdoor Auto setting DC Iris to get best quality but easy to meet rolling or flicker...

Page 195: ...backlight compensation Not support this parameter anymore when the version number httpversion is equal or greater than 0301a It s recommanded to use exposurewin_c 0 n 1 _mode to switch on off BLC maxgain 0 100 4 4 Maximum gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_maxgain Only valid when piris_mode manual or irismode fixed Normalized range Only available when capab...

Page 196: ...ror boolean 4 4 Mirror the image rotate 0 90 180 270 1 4 The rotation angle of image Support only in Rotation mode capability_videoin_c 0 n 1 _rotation 1 ptzstatus Not support anymore 0 positive integer 1 7 A 32 bit integer each bit can be set separately as follows Bit 0 Support camera control function 0 not support 1 support Bit 1 Built in or external camera 0 external 1 built in Bit 2 Support pa...

Page 197: ...y_image_c 0 n 1 _exposure_minrange 4 4 Minimum exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc Only available when capability_image_c 0 n 1 _exposure_minrange Only valid when piris_mode manual or irismode fixed Only available when capability_image_c 0 n 1 _exposure_rangetype is twovalues maxexposure product dependent 1 32000 5 32000 1 8000 5 8000 e...

Page 198: ...or only outputs 5 frame s Only available when capability_image_c 0 n 1 _exposure_maxrange and capability_image_c 0 n 1 _exposure_rangetype is onevalue We support this parameter when the version number httpversion is equal or greater than 0302a enablepreview boolean 1 4 Usage for UI of exposure settings Preview settings of video profile Only available when capability_image_c 0 n 1 _exposure_mode 0 ...

Page 199: ... available list is 7 2x 3x 4x 5x 6x 7x 8x 1 14 that correspond with 2x 15 30 that correspond with 3x Only available when capability_image_c 0 n 1 _exposure_bracketing_mode 1 We support this parameter when the version number httpversion is equal or greater than 0310a s 0 m 1 _enableept z Not support anymore boolean 4 4 Indicate whether stream supprts eptz or not s 0 m 1 _codectype Listed at capabil...

Page 200: ...n two I frames Intra coded picture The unit is millisecond ms s 0 m 1 _h264_rate controlmode 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 _h264_qua nt 1 5 99 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality level in qpercent 99 Use the quality level in qvalue Only vali...

Page 201: ...ratecontrolmode cbr and quant 100 s 0 m 1 _h264_bitr ate 20000 capability_videoin _c 0 n 1 _h264_maxbitrate 4 4 The target bit rate in constant bit rate mode Only valid when h264_ratecontrolmode cbr s 0 m 1 _h264_prio ritypolicy framerate imagequality 4 4 Set prioritypolicy Only valid when h264_ratecontrolmode cbr s 0 m 1 _h264_max frame 1 capability_videoin_c 0 n 1 _h264_maxframerate 1 4 The maxi...

Page 202: ...erval between two I frames Intra coded picture The unit is millisecond ms Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h265_rate controlmode cbr vbr 4 4 cbr Constant bit rate mode vbr Fixed quality mode all frames are encoded in the same quality Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h265_qua nt 1 5 99 100 4 4 Set the pre defined quality ...

Page 203: ...Only available when h265 is listed in capability_videoin_codec Only valid when h265_ratecontrolmode vbr s 0 m 1 _h265_cbr_ quant 1 5 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality level in cbr_qpercent Only available when h265 is listed in capability_videoin_codec and h265_ratecontrolmode cbr s 0 m 1 _h265_cbr_ qpercent 1 100 4 4 Sel...

Page 204: ..._videoin_c 0 n 1 _h265_profile 1 4 Indicate H265 profiles Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h265_sma rtq_enable boolean 4 4 Enable Smart Q function Only available when h265 is listed in capability_videoin_codec Only available when capability_videoin_c 0 n 1 _smartq_support is 1 We support this parameter when the version number httpversion is equal or greater t...

Page 205: ...br and s 0 m 1 _mjpeg_quant 100 s 0 m 1 _mjpeg_ma xvbrbitrate 20000 capability_videoin _c 0 n 1 _mjpeg_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 bit rate Only valid when mjpeg_ratecontrolmode vbr s 0 m 1 _mjpeg_cbr _quant 1 5 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Det...

Page 206: ...IF 720 704x576 768x576 CIF 352x288 384x288 For NTSC D1 4CIF 720 704x480 640x480 CIF 352x240 320x240 Only available when capability_videoin_type is 0 or 1 wdrpro_mode product dependent 0 1 2 4 4 0 Disable WDR Pro 1 Enable WDR Pro Only valid when capability_image_c 0 n 1 _wdrpro_mode 1 2 Enable WDR Pro II Only valid when capability_image_c 0 n 1 _wdrpro_mode 2 wdrpro_streng th product dependent 1 10...

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

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

Page 209: ...stream_mode_manual 1 n denotes the value of capability_nvideoin m denotes the value of capability_nmediastream k denotes the value of capability_smartstream_nwindow_manual NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable or disable the window home 0 320 0 240 4 4 Left top corner coordinate of the window size 0 320x0 240 4 4 Width and height of the window 7 8 1 1 Alternative Video ...

Page 210: ... 0 n 1 _exposure_minrange Only valid when piris_mode manual or irismode fixed Only available when capability_image_c 0 n 1 _exposure_rangetype is twovalues maxexposure product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c 0 n 1 _exposure_maxrange 4 4 Maximum exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s e...

Page 211: ...5s on the night then sensor only outputs 5 frame s Only available when capability_image_c 0 n 1 _exposure_maxrange and capability_image_c 0 n 1 _exposure_rangetype is onevalue We support this parameter when the version number httpversion is equal or greater than 0302a enableblc Not support anymore boolean 4 4 Enable backlight compensation Not support this parameter anymore when the version number ...

Page 212: ...the Iris Gain and Shutter Speed by VIVOTEK quality algorithm manual Manually adjust with variable Shutter Iris and Gain We support this parameter when the version number httpversion is equal or greater than 0302a Only available when capability_image_c0_exposure_mod e 0 whitebalance product dependent auto panorama manual rbgain widerange outdoor indoor sodiumauto etc Available values are listed in ...

Page 213: ...id when videoin_c 0 n 1 _whitebalance auto Normalized range bgain 0 100 4 4 Manual set bgain value of gain control setting 0 Weak 100 Strong Only available when rbgain is listed in capability_image_c 0 n 1 _wbmode Only valid when videoin_c 0 n 1 _whitebalance auto Normalized range maxgain 0 100 4 4 Maximum gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_maxgain Only val...

Page 214: ..._c 0 n 1 _exposure_meteringm ode 4 4 auto The algorithm chooses the best metering strategy blc This metering method increases the weight of dark area hlc The metering method can detect strong light and make affected area clear We support this parameter when the version number httpversion is equal or greater than 0311a piris_mode product dependent manual indoor outdoor 1 4 Control P Iris mode outdo...

Page 215: ...0 n 1 _iristype dciris wdrpro_mode product dependent 0 1 2 4 4 0 Disable WDR Pro 1 Enable WDR Pro Only valid when capability_image_c 0 n 1 _wdrpro_mode 1 2 Enable WDR Pro II Only valid when capability_image_c 0 n 1 _wdrpro_mode 2 wdrpro_streng th 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 0 n 1 ...

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

Page 217: ...rameter with timeshift_c 0 n 1 _enable when the version number httpversion is equal or greater than 0312a We do not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a c 0 n 1 _enable boolean 4 4 Enable time shift streaming We support this parameter when the version number httpversion is equal or grea...

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

Page 219: ...ility_ nvideoin 1 _externalir 0 We replace this parameter with ircutcontrol_illuminators_external_d o_enabled when the version number httpversion is equal or greater than 0312a We do not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a enablewled Not recommended to use this boolean 6 6 Enable disab...

Page 220: ...rcutsensitivity_type normalize Only available when capability_daynight_c 0 n 1 _ircutsensitivity_type is not We replace this parameter with ircutcontrol_c 0 n 1 _sensitivity when the version number httpversion is equal or greater than 0312a We do not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a...

Page 221: ...e version number httpversion is equal or greater than 0312a sir product dependent boolean 6 6 Enable disable Smart IR Only available when capability_daynight_c 0 capability_ nvideoin 1 _smartir is 1 We support this parameter when the version number httpversion is equal or greater than 0312a daymodebegintime 00 00 23 59 6 6 Day mode begin time We support this parameter when the version number httpv...

Page 222: ...l_illuminators capability_daynight_c 0 n 1 _support 0 n denotes the value of capability_nvideoin k is determined by the below criterion The following applies for capability_extension_do_num 0 if extension_connected 1 k capability_ndo if extension_connected 0 k capability_ndo capability_extension_do_num Otherwise k capability_ndo NAME VALUE SECURIT Y get set DESCRIPTION builtin_irled_enabled boolea...

Page 223: ...n is equal or greater than 0312a external_do 2 k _ena bled boolean 1 6 Enable disable external led mounted on do 2 k Only available when capability_ndo 1 Only available when capability_daynight_illuminators_ext ernal_support 0 and do 2 k are listed in capability_daynight_illuminators_ext ernal_interface We support this parameter when the version number httpversion is equal or greater than 0312a sp...

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

Page 225: ...ng is 1 saturationpercent 0 100 4 4 Set saturation in the normalized range 0 Less saturation 100 More saturation Only available when bit 2 of capability_image_c 0 n 1 _basicsetting is 1 sharpnesspercent 0 100 4 4 Set sharpness in the normalized range 0 Softer 100 Sharper Only available when bit 3 of capability_image_c 0 n 1 _basicsetting is 1 gammacurve product dependent 0 100 4 4 0 Fine turned ga...

Page 226: ...nr is 1 defog_mode product dependent boolean 4 4 Enable disable defog mode 0 disable 1 enable Only available when capability_image_c 0 n 1 _defog_mode is 1 defog_strength product dependent 1 100 4 4 Strength of defog Only available when capability_image_c 0 n 1 _defog_mode is 1 eis_mode product dependent boolean 4 4 Electronic image stabilizer 0 disable 1 enable Only available when eis is listed i...

Page 227: ...eatwb positive integer 4 4 Restore of adjusting white balance of image according to mode settings freeze product dependent boolean 4 4 Enable disable Image freeze while patrolling 0 disable 1 enable Only available when capability_image_c 0 n 1 _freeze is 1 deinterlace_enable boolean 4 4 Enable disable deinterlace function 0 disable 1 enable Only available when capability_image_c 0 n 1 _deinterlace...

Page 228: ...vailable when capability_image_c 0 n 1 _lens_ldc_support is 1 palette_mode Available value is listed in capability_image_c 0 n 1 _palette_mode 1 4 Set color palette option Only available when capability_image_c 0 n 1 _palette_support is 1 profile_i 0 m 1 _enable boolean 4 4 Enable disable this profile setting profile_i 0 m 1 _policy night schedule product dependent 4 4 The mode which the profile i...

Page 229: ...ng is 1 We replace profile_i0_contrast with profile_i0_contrastpercent This parameter will not be used after the version number httpversion is equal 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 0 n 1 _saturationpercent Only available when bit 2 of capability_image_c 0 n 1 _basicsetting is 1 We replace ...

Page 230: ...n bit 1 of capability_image_c 0 n 1 _basicsetting is 1 profile_i 0 m 1 _saturationperc ent 0 100 4 4 Set saturation in the normalized range 0 Less saturation 100 More saturation Only available when bit 2 of capability_image_c 0 n 1 _basicsetting is 1 profile_i 0 m 1 _sharpnessperc ent 0 100 4 4 Set sharpness in the normalized range 0 Softer 100 Sharper Only available when bit 3 of capability_image...

Page 231: ...gth of 3DNR Only available when capability_image_c 0 n 1 _dnr is 1 profile_i 0 m 1 _defog_mode product dependent boolean 4 4 Enable disable defog mode 0 disable 1 enable Only available when capability_image_c 0 n 1 _defog_mode is 1 profile_i 0 m 1 _defog_strengt h product dependent 1 100 4 4 Strength of defog Only available when capability_image_c 0 n 1 _defog_mode is 1 profile_i 0 m 1 _eis_mode p...

Page 232: ...osure window custom Use custom windows blc Use BLC Back Light Compensation and the only exposure window is located at the center of view hlc Use HLC High Light Compensation and to perform the masking of bright light area center Use Center window as metering area and give the necessary light compensation 7 12 1 Exposure Window Setting for Each Window Group exposurewin_c 0 n 1 _win_i 0 k 1 n denotes...

Page 233: ...0 H W 0 The current image width 1 H 0 The current image height 1 4 4 Width and height of the window Only available when px is listed in capability_image_c 0 n 1 _exposure_windomain homestd 0 9999 0 9999 4 4 Left top corner coordinate of the window Only available when std is listed in capability_image_c 0 n 1 _exposure_windomain sizestd 0 9999x0 9999 4 4 Width and height of the window Only availabl...

Page 234: ...capability_nvideoinprofile k denotes the value of capability_image_c 0 n 1 _exposure_winnum Only available when capability_image_c 0 n 1 _exposure_mode 1 and when custom is listed in capability_image_c 0 n 1 _exposure_winmode and valid when exposurewin_c 0 n 1 _mode custom or exposurewin_c 0 n 1 _mode hlc NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable or disable the window polic...

Page 235: ...ity_image_c 0 n 1 _exposure_windomain sizestd 0 9999x0 9999 4 4 Width and height of the window Only available when std is listed in capability_image_c 0 n 1 _exposure_windomain 7 13 Audio Input per Channel Group audioin_c 0 n 1 capability_naudioin 0 n denotes the value of capability_naudioin NAME VALUE SECURITY get set DESCRIPTION source Not recommended to use this micin linein product dependent 4...

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

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

Page 238: ...r httpversion is equal or greater than 0301a policy night is only available when capability_daynight_c 0 n 1 _support 0 profile_i0_begintime hh mm 4 4 Begin time of schedule mode profile_i0_endtime hh mm 4 4 End time of schedule mode profile_i0_alarm_lev el 1 100 4 4 Audio detection alarm level 7 13 1 Multicast Settings for Audio Streaming Group audioin_c 0 n 1 _s0_multicast capability_naudioin 0 ...

Page 239: ...ates the seconds that can be waited before audio clip start to record 7 16 Motion Detection Settings Group motion_c 0 n 1 for n channel products n denotes the value of capability_nvideoin NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable motion detection win_sensitivity 0 100 4 4 Sensitivity of all motion detection windows The value 0 is reserved for compatibility and will not be u...

Page 240: ...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_windomain It s recommended to use polygonsd This parameter will not be used after the version number httpversion is equal or greater than 0400a polygon Not recommended to use this 0 320 0 240 0 ...

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

Page 242: ...ion NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable motion detection window name string 14 4 4 Name of motion window polygonstd 0 9999 0 9999 0 9999 0 9999 0 9999 0 9999 0 9999 0 9999 4 4 Coordinate of polygon window position 4 points x0 y0 x1 y1 x2 y2 x3 y3 Only available when capability_motion_wintype polygon Only available when std is listed in capability_motion_windomain objs...

Page 243: ...le 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 of window position Only available when capability_motion_wintype rectangle Only available when qvga...

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

Page 245: ...et provider _hostnam e string 128 6 6 Your DDNS hostname provider _usernam eemail string 64 6 6 Your user name or email to login to the DDNS service provider provider _passwor dkey string 64 7 6 Your password or key to login to the DDNS service provider 7 19 Express Link Group expresslink PARAMETER VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable or disable express link state onlycheck...

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

Page 247: ...128 7 6 Read write passwrd encryptpwro string 8 128 7 6 Read only password encrypttyperw DES 6 6 Read write encryption type encrypttypero DES 6 6 Read only encryption type rwcommunity string 31 6 6 Read write community rocommunity string 31 6 6 Read only community syslocation string 128 6 6 System location syscontact string 128 6 6 System contact 7 24 Layout Configuration Group layout NAME VALUE S...

Page 248: ...ltpassword_specia lcharacter _ 6 7 Allowed special characters We support this parameter when the version number httpversion is equal or greater than 0314b defaultpassword_type positive integer 6 7 Required character type for password An 32 bit integer each bit can be set separately as follows Bit 0 Require English alphabet letter uppercase or lowercase Bit 1 Require special character Bit 2 Require...

Page 249: ...0 degrees the range of left coordinate is 0 240 win_i 0 m 1 _top 0 240 4 4 Top coordinate of window position Only available when capability_image_c 0 n 1 _privacymask_wintype rectangle If the image is rotated by 90 or 270 degrees the range of top coordinate is 0 320 win_i 0 m 1 _width 0 320 4 4 Width of privacy mask window Only available when capability_image_c 0 n 1 _privacymask_wintype rectangle...

Page 250: ... 9999 4 4 Coordinate of polygon window position 4 points x0 y0 x1 y1 x2 y2 x3 y3 Only available when capability_image_c 0 n 1 _privacymask_wintype polygon Only available when std is listed in capability_image_c 0 n 1 _privacymask_windomain 7 26 3D Privacy Mask Group privacymask3d_c 0 n 1 for n channel products and m privacy mask window capability_image_c 0 n 1 _privacymask_wintype 3Drectangle n de...

Page 251: ...Capability Group capability NAME VALUE SECURITY get set DESCRIPTION api_httpversion string This number start with 0301a 0 7 The version of VIVOTEK WebAPI with 4 integers plus 1 alphabet There are composed by major version minor version revision _platform ex 0301a_1 Major version Increase the major version when change remove the old features interfaces or the firmware has substantially change in ar...

Page 252: ...s in a model does not follow the API definition of 0301a_1 we will fix them and change this API value to 0301b_1 api_logoversion string This number start with 1 0 0 7 Indicate the version of Vivotek log format We support this parameter when the version number httpversion is equal or greater than 0317c bootuptime positive integer 0 7 Server bootup time nir Not support anymore 0 positive integer 0 7...

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

Page 254: ...SD PZ PT PD video server series Bit 6 only available when bit0 is 1 Reserved bit always 0 Bit 7 only available when bit0 is 1 External or built in PT 0 built in 1 external windowless boolean 0 7 Indicate whether to support windowless plug in evctrlchannel boolean 0 7 Indicate whether to support HTTP tunnel for event control transfer joystick boolean 0 7 Indicate whether to support joystick control...

Page 255: ... 0307a 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 0 15 are the 1st group for 1st channel bit 16 31 are the 2...

Page 256: ...ther the product is fisheye or not tampering boolean 0 7 Indicate whether to support tampering detection tamperingmode tamper toodark toobri ght tooblurry 0 7 Available tampering mode list Only available when capability_tampering is 1 adaptiverecording boolean 0 7 Indicate whether to support adaptive recording adaptivestreaming boolean 0 7 Indicate whether to support adaptive streaming supporttrig...

Page 257: ... 7 Indicate whether to support RTSP protocol_sip boolean 0 7 Indicate whether to support SIP protocol_ibis boolean 0 7 Indicate whether to support integrated on board information system IBIS We support this parameter when the version number httpversion is equal or greater than 0317a protocol_maxconn ection positive integer 0 7 The maximum number of allowed simultaneous connections protocol_maxgenc...

Page 258: ...o support DDNS protocol_ftp_serve r positive integer 0 7 An 32 bit integer each bit can be set separately as follows Bit 0 ftp Bit 1 sftp We support this parameter when the version number httpversion is equal or greater than 0314a protocol_ftp_client positive integer 0 7 An 32 bit integer each bit can be set separately as follows Bit 0 ftp Bit 1 sftp We support this parameter when the version numb...

Page 259: ...dec This is kept for compatibility videoin_flexiblebitr ate boolean 0 7 Indicate whether to support flexible bit rate control videoout_codec A list of the available codec types separated by commas product dependent 0 7 Available codec list not supported timeshift boolean 0 7 Indicate whether to support time shift caching stream audio_aec boolean 0 7 Indicate whether to support acoustic echo cancel...

Page 260: ...rewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL For example maxframerate fixed 15 which means the max frame rate is 15fps when acoustic echo cancellation function is enabled means no feature is affected Only avai...

Page 261: ...laced by audio_intmic and audio_extmic audio_lineout boolean 0 7 Indicate whether to support line output audio_michardwar eswitch boolean 0 7 Indicate whether the hardware supports built in external mic switch audio_headphoneo ut Not support anymore boolean 0 7 Indicate whether to support headphone output Not support this parameter anymore when the version number httpversion is equal or greater th...

Page 262: ...er of stream that support smart stream Only available when capability_smartstream_support is 1 smartstream_wind omain qvga px std 0 7 The domain to set an focus window qvga a 320x240 range to represent the whole image px Locate a window in the image with pixels std A normalized 0 9999 range Not supported Only available when capability_smartstream_support is 1 smartstream_mod e_autotracking boolean...

Page 263: ...ger 0 7 An 32 bit integer each bit can be set separately as follows Bit 0 VADP interface Bit 1 Capture video raw data Bit 2 Support encode jpeg Bit 3 Capture audio raw data Bit 4 Support event trigger Bit 5 Support license registration Bit 6 Support shared memory API Bit 7 Support digital signature of package Bit 8 Support snapshot Bit 9 Support upload encrypted package vadp_npackage positive inte...

Page 264: ...Indicate transmission mode of the machine TX server Rx receiver box Both DVR network_wire boolean 0 7 Indicate whether to support Ethernet network_wireless boolean 0 7 Indicate whether to support wireless network_dualmod e boolean 0 7 Indicate whether network dual mode is supported Only available when capability_network_wireless is 1 We support this parameter when the version number httpversion is...

Page 265: ...equal or greater than 0305a 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 Not support anymore boolean 0 7 Indicate whether to support test ac key version_onvifdaem on string 0 7 Indicate ONVIF daemon version version_onviftestto ol string 0...

Page 266: ...313a image_iristype Not recommended to use this string 0 7 Indicate iris type piris P Iris dciris DC Iris No Iris control support When capability_iris 0 this value must be Note For some box type cameras this value may be varied depending on mounted lens We replace capability_image_iristype with capability_image_c0_iristype Reserved for compatibility and suggest don t use this since httpversion 030...

Page 267: ... capability_storage_dbenabled is 1 localstorage_storm grversion string 0 7 Indicate storage manager daemon version Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 localstorage_suppo rtedge 0 positive integer 0 7 An 32 bit integer which indicates the supportive application of edge storage If the value of this parameter is larger than 0 it means that the camera sup...

Page 268: ...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 shockalarm_suppo rt boolean 0 7 Indicate whether to support the shock detection We support this parameter when the version number httpversion is equal or greater than 0306e layout_redirection string 0 7 Indicate which function will...

Page 269: ...e version number httpversion is equal or greater than 0315a cameralink_num 0 positive integer 0 7 Indicate the maximum number of receiver camera link Only available when capability_cameralink_support is 1 We support this parameter when the version number httpversion is equal or greater than 0315a cameralink_version integer 0 7 Indicate the version of camera link feature Only available when capabil...

Page 270: ...5 out buildinpt boolean 0 7 An 32 bit integer each bit can be set separately as follows Bit 0 support build in pan Bit 1 support build in tilt zoommodule boolean 0 7 Indicate whether to support zoom lens In our product only SD series and IZ series use the zoom lens Both varifocal and zoom lenses are built with movable elements that permit changing the effective focal length And the key difference ...

Page 271: ...on manually as their purpose Only available when capability_camctrl_c 0 n 1 _zoommodule is 1 We support this parameter when the version number httpversion is equal or greater than 0304a digitalzoom_support boolean 0 7 Indicate the lens support digital zoom or not We support this parameter when the version number httpversion is equal or greater than 0317a 7 27 2 Capability for PTZ Group capability_...

Page 272: ...is 1 tiltspeedlv 0 positive integer 0 7 The maximum speed level of tilt motion Only available when bit1 of capability_camctrl_c 0 n 1 _buildinpt is 1 mintilt 0 positive integer 0 7 The lower limit for tilt position Only available when bit1 of capability_camctrl_c 0 n 1 _buildinpt is 1 maxtilt 0 positive integer 0 7 The upper limit for tilt position Only available when bit1 of capability_camctrl_c ...

Page 273: ...motion Only available when the value of capability_camctrl_c 0 n 1 _zoommodule is 1 minfocus 0 positive integer 0 7 The lower limit for focus position Only available when the value of capability_camctrl_c 0 n 1 _zoommodule is 1 maxfocus 0 positive integer 0 7 The upper limit for focus position Only available when the value of capability_camctrl_c 0 n 1 _zoommodule is 1 7 27 3 Capability for IR Led...

Page 274: ...hen the version number httpversion is equal or greater than 0312a optimizedir boolean 0 7 Indicate whether to support optimized IR control technology We replaced this parameter with capability_daynight_illumintators_opti mizedir when the version number httpversion is equal or greater than 0312a smartir boolean 0 7 Indicate whether to support smart IR ircutfilter boolean 0 7 Indicate whether to sup...

Page 275: ...equal or greater than 0302a ircutsensitivity_supportle vel 0 positive integer 0 7 The value indicate the support strength level of ircutsensitivity Only available when capability_daynight_c 0 n 1 _support is 1 and capability_daynight_c 0 n 1 _ircutsensitivity_type is not We support this parameter when the version number httpversion is equal or greater than 0302a extled_interface do product depende...

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

Page 277: ...s triggered di3 the camera automatically switches the current mode when a ditigal input 3 is triggered di4 the camera automatically switches the current mode when a ditigal input 4 is triggered schedule The Camera switches between day mode and night mode based on a specified schedule not support We support this parameter when the version number httpversion is equal or greater than 0309d 7 27 4 Cap...

Page 278: ...t Available values are do do 2 capability_nd o 0 7 The device interface of external led do digital output 1 do2 digital output 2 do3 digital output 3 do4 digital output 4 We support this parameter when the version number httpversion is equal or greater than 0312a Only available when capability_daynight_illuminators_ external_support is 1 spectrum_support boolean 0 7 Indicate whether to support pro...

Page 279: ...age Management Group capability_storage_management PARAMETER VALUE SECURITY get set DESCRIPTION ndevice positive integer 0 7 Indicate the number of storage devices We support this parameter when the version number httpversion is equal or greater than 0312a device sd nas product dependent 0 7 Indicate the supported storage devices Only available when capability_storage_dbenabled is 1 We support thi...

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

Page 281: ...e selections or values enabled UI is checked notsupport the affected function is not available Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL means no ...

Page 282: ...this channel maxsize WxH 0 7 The maximum resolution of all modes in this channel the unit is pixel nprivacymask 0 positive integer 0 7 Number of privacy mask per channel nresolution positive integer 0 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 opti...

Page 283: ...on mjpeg_maxframerate A list of Positive Integer and 0 7 Maximum fps that the device can encoded with MJPEG on resolutions in current video mode means not support One to one mapping to the resolution in resolution The element number is defined as nresolution in this group This parameter may be changed when videoin_c n _cmosfreq 50 or videoin_c n _modulation pal Ex 30 fps is changed to 25 fps 60 fp...

Page 284: ...4 is listed in capability_videoin_codec h264_profile baseline main hig h product dependent 0 7 Indicate H264 profiles Only available when h264 is listed in capability_videoin_codec We support this parameter when the version number httpversion is equal or greater than 0309a h265_maxframerate A list of Positive Integer and 0 7 Maximum fps that the device can encoded with H 265 on resolutions in curr...

Page 285: ...ng wall floor product dependent Available values are listed in capability_videoin _c 0 n 1 _mounttype 0 7 Indicate the supported mount type not support We support this parameter when the version number httpversion is equal or greater than 0309c dintraperiod_support boolean 0 7 0 Non support Dynamic intra frame period 1 Support Dynamic intra frame period Dynamic intra frame period can be used to re...

Page 286: ...bility_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 Available dewarp types of wall mount resolutionC1P A list of WxH 0 7 Available resolutions of 1P mode ...

Page 287: ...0 n 1 _nmode PARAMETER VALUE SECURITY get set DESCRIPTION rotation boolean 0 7 Indicate this mode whether support video rotation is_mode eis dis 0 7 Indicate this mode whether support image stabilizer mode eis electronic image stabilizer dis digital image stabilizer not support Only available when capability_image_c 0 n 1 _eis is 1 We support this parameter when the version number httpversion is e...

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

Page 289: ...ght sensitivity by combining multiple pixels to one The drawback is reduced resolution We design this parameter to disclose this information nresolution positive integer 0 7 How many resolution options in this video mode resolution A list of WxH 0 7 Resolution options in this video mode The last one is the maximum resolution in this video mode The element number is defined as nresolution in this g...

Page 290: ...ions in this video mode means not support One to one mapping to the resolution in resolution The element number is defined as nresolution in this group This parameter records the frame rate when videoin_c 0 n 1 _cmosfreq 60 or videoin_c 0 n 1 _modulation ntsc Only available when mjpeg is listed in capability_videoin_codec maxfps_h264 A list of Positive Integer and 0 7 Maximum fps which the device ...

Page 291: ...apability_nvideoin NAME VALUE SECURITY get set DESCRIPTION basicsetting 0 positive integer 0 7 A 32 bits integer each bit can be set separately as follows Bit 0 Supports Brightness or not Bit 1 Supports Contrast or not Bit 2 Supports Saturation or not Bit 3 Supports Sharpness or not Bit 4 Supports adjusting the image to proper position horizontally or not Bit 5 Supports adjusting the image to prop...

Page 292: ...d only once wdrc unchanged x nonnegative integer product dependent 0 7 When WDR Pro is enabled some features may become malfunction or be forced to a given value The affected functions are list here The format is Affect API name Policy Description Policy can be categorized into following groups disabled UI turns grey and users can t select it unchanged UI keeps the status as before and user can t ...

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

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

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

Page 296: ... dependent flickerless unchang ed wdrpro unchanged product dependent 0 7 When scene mode is enabled some features may become malfunction or be forced to a given value The affected functions are list here The format is Affect API name Policy Description Policy can be categorized into following groups disabled UI turns grey and users can t select it unchanged UI keeps the status as before and user c...

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

Page 298: ...ameras this value may be varied depending on mounted lens sensortype rawsensor smartsensor thermalsensor 0 7 Indicate sensor type rawsensor Raw sensor smartsensor Smart sensor thermalsensor Thermal sensor N A We support this parameter when the version number httpversion is equal or greater than 0302a exposure_mode 0 1 0 7 0 Non support exposure control 1 Support exposure control exposure_modetype ...

Page 299: ..._shuttervalue ranged Need two parameters to indicate the shutter range videoin_c 0 n 1 _maxexposure videoin_c 0 n 1 _maxexposure not support Only available when shutterpriority is listed in capability_image_c 0 n 1 _ exposure_modetype and capability_image_c 0 n 1 _ exposure_mode is 1 We support this parameter when the version number httpversion is equal or greater than 0302a exposure_gainvaluety p...

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

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

Page 302: ...r value ranged UI is fixed to multiple selections or values enabled UI is checked notsupport the affected function is not available Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegativ...

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

Page 304: ...dow is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL means no feature is affected Only available when manual is listed in capability_image_c 0 n 1 _ exposure_modetype and capability_image_c 0 n 1 _ exposure_mode is 1 We support this parameter when the version number ht...

Page 305: ...af fect sir hidden or others x nonnegative integer product dependent 0 7 When hlc mode is enabled some features may become malfunction or be forced to a given value The affected functions are list here The format is Affect API name Policy Description Policy can be categorized into following groups disabled UI turns grey and users can t select it unchanged UI keeps the status as before and user can...

Page 306: ...ive The image inside a window is omitted by exposure control Not supported Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_windomain 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 Only available when capability_image_c 0 n 1 _ ex...

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

Page 308: ...reater than 0310a privacymask_wintype rectangle polygon 3Drectangle 0 7 The supported mask window type polygon The window is a 2D polygon shape rectangle The window is a 2D rectangle shape 3Drectangle The window is a 3D rectangle shape privacymask_windom ain qvga px std 0 7 The domain to set an window qvga a 320x240 range to represent the whole image px Locate a window in the image with pixels std...

Page 309: ...to multiple selections or values enabled UI is checked notsupport the affected function is not available Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL...

Page 310: ...abled UI is checked notsupport the affected function is not available Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL means no feature is affected When ...

Page 311: ...ly support zoom function bit 2 Only support focus function bit 3 Currently this is a reserved bit and the default value is 0 focuswindomain qvga px std 0 7 The domain to set a focus window qvga a 320x240 range to represent the whole image px Locate a window in the image with pixels std A normalized 0 9999 range Not supported focuswindow_nwindo w 0 positive integer 0 7 Number of focus window focusw...

Page 312: ...tial blend 0 7 Spatical mode provides the best image quality while Blend mode provides better image quality than not using the deinterlace function at all Only available when capability_image_c 0 n 1 _deinterlace_support is 1 lens_alignment boolean 0 7 Indicate whether to support lens alignment function We support this parameter when the version number httpversion is equal or greater than 0309b le...

Page 313: ...oom Trigger autofocus if zoom is operated focusshift Ability to adjust day night focus position Not supported Only available when capability_image_c 0 n 1 _remotefocus 0 We support this parameter when the version number httpversion is equal or greater than 0316a 7 27 10 Capability for Peripheral Device Group capability_peripheral_c 0 n 1 n denotes the value of capability_nvideoin PARAMETER VALUE S...

Page 314: ... integer 0 7 The number of supported extension digital input module We support this parameter when the version number httpversion is equal or greater than 0316a do_num integer 0 7 The number of supported extension digital output module We support this parameter when the version number httpversion is equal or greater than 0316a 7 27 12 Capability for Onvif Group capability_onvif PARAMETER VALUE SEC...

Page 315: ...di Digital input pir PIR detection motion Video motion detection seq Periodic condition visignal Video input signal loss recnotify Recording notification tampering Tamper detection vi Virtual input Manual trigger volalarm Audio detection smartsd Lifetime detection of SD card shockalarm Shock detection virestore Video input signal restore vadp VADP trigger presetreached When any preset is reached c...

Page 316: ...nput 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 any one of source id 0 1 and 3 set vadp to 11 Only available when vadp is listed in capability_supporttriggertypes valevel 0 1 6 6 Select audio detection event 0 not sel...

Page 317: ...num 0 if extension_connected 1 k capability_ndo if extension_connected 0 k capability_ndo capability_extension_do_num Otherwise k capability_ndo Only available when capability_ndo 0 action_do_i 0 k 1 _duration 1 999 6 6 Duration of the digital output trigger in seconds k is determined by the below criterion The following applies for capability_extension_do_num 0 if extension_connected 1 k capabili...

Page 318: ...r action action_server_i 0 4 _m edia NULL 0 4 101 6 6 Index of the attached media 101 means Recording Notify action_server_i 0 4 _da tefolder Not support anymore boolean 6 6 Enable this to create folders by date time and hour automatically action_goto_enable product dependent boolean 6 6 Enable disable ptz goto preset position on event triggered Only available when capability_ptzenabled 0 action_g...

Page 319: ...action_tour_enable product dependent boolean 6 6 Enable disable auto tour function when an event is triggered Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0 action_tour_name product dependent string 40 6 6 Indicate the source name of auto tour when an event is triggered Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 of...

Page 320: ...when an event is triggered ex cameralink_i0 refers to the information in cameralink_i0 group Only available when capability_cameralink_support is 1 7 29 Server Setting for Event Action Group server_i 0 4 PARAMETER VALUE SECURITY get set DESCRIPTION name string 40 6 6 Identification of this entry type email ftp http ns sftp 6 6 Indicate the server type email email server ftp FTP server http HTTP se...

Page 321: ...ail string 128 6 6 Email address of the sender email_recipientemail string 640 6 6 Email address of the recipient ns_location string 128 6 6 Location to upload or store the media For httpversion is equal or greater than 0312a The media storage path format is mac address date hour Only available when nas is included in capability_storage_management_device For httpversion smaller than 0312a The medi...

Page 322: ...ey public md5 publickey_pairmode auto download upload 6 6 autopair Autopair mode is selected for this event server downloadkey Download key pair mode is selected for this event server uploadkey Upload key pair mode is selected for this event server publickey_downloadkeytype ed25519 rsa ecdsa 6 6 The keytype used for key pair ed25519 faster to generate with higher security level some old server mig...

Page 323: ...1c snapshot_source 0 capability_nmediastream 1 6 6 Indicate the source of media stream 0 means the first stream 1 means the second stream and etc 2 means the third stream and etc 3 means the fourth stream and etc snapshot_prefix string 16 6 6 Indicate the prefix of the filename media_i0 Snapshot1_ media_i1 Snapshot2_ media_i2 Snapshot3_ media_i3 Snapshot4_ media_i4 Snapshot5_ snapshot_datesuffix 0...

Page 324: ... stream and etc videoclip_prefix string 16 6 6 Indicate the prefix of the filename videoclip_preevent 0 capability_media_videoclip_ maxpreevent 6 6 Indicates the time for pre event recording in seconds videoclip_maxduration 1 capability_media_videoclip_ maxlength 6 6 Maximum duration of one video clip in seconds videoclip_maxsize 50 capability_media_videoclip_ maxsize 6 6 Maximum size of one video...

Page 325: ...el 1 means the second channel 2 means the third channel 3 means the fourth channel We support this parameter when the version number httpversion is equal or greater than 0311c source 0 capability_nmediastrea m 1 6 6 Indicate the source of media stream 0 means the first stream 1 means the second stream and so on maxretentiontime string 6 6 To specify the expired time for automatic clean up and it o...

Page 326: ... bit3 Wednesday bit4 Tuesday bit5 Monday bit6 Sunday For example to detect events on Friday and Sunday set weekday as 66 begintime hh mm 6 6 Start time of the weekly schedule endtime hh mm 6 6 End time of the weekly schedule 00 00 24 00 indicates schedule always on prefix string 16 6 6 Indicate the prefix of the filename dest cf 0 4 6 6 The destination to store the recorded data cf means local sto...

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

Page 328: ...R VALUE SECURITY get set DESCRIPTION cyclic_enabled boolean 6 6 Enable cyclic storage method cyclic_reserve 10 99 6 6 The reserved percentage of this disk We support this parameter when the version number httpversion is equal or greater than 0312a type sd nas product dependent 6 7 The storage device type We support this parameter when the version number httpversion is equal or greater than 0312a a...

Page 329: ...ffective Not recommended to use this Please refers autocleanup group This parameter will not be used after the version number httpversion is equal or greater than 0400a autocleanup_maxage Not recommended to 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 th...

Page 330: ...pendent 1 6 ROI width and height The width value must be multiples of 16 and the height value must be multiples of 8 If the minimal window size is 64x64 then the size 64 resolution_W 64 resolution_H which the resolution is equal to the captured size by device in this video mode If the stream doesn t support ePTZ the permissions of this parameter must be set as 1 7 7 35 ePTZ Setting Group eptz_c 0 ...

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

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

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

Page 334: ...0 2 _number when the version number httpversion is equal or greater than 0312a We do not support this parameter when capability_nvideoin 1 This parameter will not be used after the version number httpversion is equal or greater than 0400a 7 37 1 Seamless recording setting per channel Group seamlessrecording_c 0 n 1 for n channel products n denotes the value of capability_nvideoin capability_locals...

Page 335: ... when the version number httpversion is equal or greater than 0312a 7 38 VIVOTEK Application Development Platform Setting Group vadp NAME VALUE SECURITY get set DESCRIPTION version string 6 7 Indicate the VADP version resource_total_memory 0 positive integer 6 7 Indicate total available memory size for VADP modules resource_total_storage 0 positive integer 6 7 Indicate total size of the internal s...

Page 336: ... VADP vendor and your camera Only available when capability_securecam_support 1 7 38 1 VADP Settings for Each Hyperlink Group vadp_hyperlink_i 0 n 1 Maximum of n 10 hyperlink is supported NAME VALUE SECURITY get set DESCRIPTION moduleidx 0 positive integer 1 7 Refer to the package index title string 40 1 7 Name of the vadp hyperlink url string 120 1 7 The URL address of vadp hyperlink status strin...

Page 337: ...hat will be show on license status when mouse over path string 40 6 7 Record the storage path of the module initscr string 40 6 7 The script that will handle operation commands from the system status string 40 6 6 Indicate the running status of the module statmsg string 128 6 6 Indicate the message that will be show on the running status when mouse over vvtklicensemec string 40 6 7 Indicate the mo...

Page 338: ... for n channel products capability_ptzenabled 0 n denotes the value of capability_nvideoin and k denotes the value of capability_npreset NAME VALUE SECURITY get set DESCRIPTION panspeed 5 5 1 4 Pan speed tiltspeed 5 5 1 4 Tilt speed zoomspeed 5 5 1 4 Zoom speed focusspeed 5 5 1 4 Auto focus speed patrolseq string 120 1 4 For external device The indexes of patrol points separated by patroldwelling ...

Page 339: ...ability_nvideoin and k denotes the value of capability_npreset NAME VALUE SECURITY get set DESCRIPTION ccdtype string 16 6 7 Internal used read only motortype string 16 6 7 Internal used read only cameraid 0 255 1 4 Camera ID controlling external PTZ camera Note Please set your speed dome to the appropriate baud rate and Camera ID e g 2400bps camera ID 1 2 3 etc All Camera IDs on the same controll...

Page 340: ... 1 _minzoom capability_ptz_ c 0 n 1 _maxzoom 1 4 Zoom position at each preset location preset_i 0 k 1 _focus capability_ptz_ c 0 n 1 _minfocus capability_ptz_ c 0 n 1 _maxfocus 1 4 Focus position at each preset location preset_i 0 k 1 _ dwelling 0 999 1 4 The dwelling time of each preset location only available when capability_camctrl_c0_rs485 2 preset_i 0 k 1 _focussetting sync fixcurrent 1 4 The...

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

Page 342: ...nual Available values are listed in capability_camctrl_c 0 n 1 _focusmode 1 4 Indicate the focus control mode preset_i 0 k 1 _name string 40 1 4 Name of the preset location preset_i 0 k 1 _pan capability_ptz_c 0 n 1 _minpan capability_ptz_c 0 n 1 _maxpan 1 4 Pan position at each preset location preset_i 0 k 1 _tilt capability_ptz_c 0 n 1 _mintilt capability_ptz_c 0 n 1 _maxtilt 1 4 Tilt position a...

Page 343: ...home pan position axisy capability_ptz_c 0 n 1 _mintilt capability_ptz_c 0 n 1 _maxtilt 1 4 Custom home tilt position axisz capability_ptz_c 0 n 1 _minzoom capability_ptz_c 0 n 1 _maxzoom 1 4 Custom home zoom position axisf capability_ptz_c 0 n 1 _minfocus capability_ptz_c 0 n 1 _maxfocus 1 4 Custom home focus position axisflip boolean 1 4 Custom home flip side returnhome boolean 1 4 Enable disabl...

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

Page 345: ... in a character frame paritybit none odd even 4 4 For error checking stopbit 1 2 4 4 1 One stop bit is transmitted to indicate the end of a byte 2 Two stop bits are transmitted to indicate the end of a byte If you want to transfer the stopbit for 150 of the normal time used to transfer one bit the uart_i 0 n 1 _stopbit should be set as 2 and the uart_i 0 n 1 _databit set as 5 as well uartmode rs48...

Page 346: ...l Camera IDs on the same controlling system NVR or rs485 keyboard have to be distinct Therefore once you send a controlling signal each camera will only accept the inputs with the corresponding ID baudrate 2400 4800 9600 19 200 38400 57600 1 15200 4 4 Set baud rate of COM port databit 5 6 7 8 4 4 Data bits in a character frame paritybit none odd even 4 4 For error checking stopbit 1 2 4 4 1 One st...

Page 347: ...l time used to transfer one bit the uart_i 0 n 1 _stopbit should be set as 2 and the uart_i 0 n 1 _databit set as 5 as well 7 45 Lens Configuration Group lens for n channel products n denotes the value of capability_nvideoin capability_image_c 0 n 1 _lensconfiguration_support 1 NAME VALUE SECURITY get set DESCRIPTION selected string 6 7 Current selected lens profile e g lens_selected lens_default_...

Page 348: ...er radius 7 47 Fisheye Local Dewarp Setting Group fisheyedewarp_c 0 n 1 capability_fisheyelocaldewarp_c 0 n 1 0 n denotes the value of capability_nvideoin m denotes the value of capability_nmediastream NAME VALUE SECURITY get set DESCRIPTION panspeed 5 5 1 4 Pan speed of regional view tiltspeed 5 5 1 4 Tilt speed of regional view zoomspeed 5 5 1 4 Zoom speed of regional s 0 m 2 _panorama_pans tart...

Page 349: ...unt is 0 90 Tilt range of wall mount is 90 90 s 0 m 2 _region_r 0 i 1 _zoom 100 300 1 4 Zoom home ratio of regional view for 4R mode i is the view index and range from 0 to 3 7 48 PIR Behavior Define Group pir capability_npir 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 1 1 Enable disable PIR 7 49 Auto Tracking Setting Group autotrack_c 0 n 1 capability_image_c 0 n 1 _autotrack_support...

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

Page 351: ...ction Group shock_c 0 n 1 for n channel products n denotes the value of capability_nvideoin capability_shockalarm_support 0 PARAMETER VALUE SECURITY get set DESCRIPTION alarm_enable boolean 4 4 Enable shock detection s alarm alarm_level 1 100 4 4 The value indicate the support strength level of shock detection s alarm 7 52 Stream Profiles Group streamprofile_i 0 n 1 for n profiles product n denote...

Page 352: ...1 s 0 m 1 indicates video stream of channel n stream m is selected for the profile audioconfiguration_en able boolean 1 6 To enable the selected audioconfiguration source for this profile Only available when capability_naudioin 0 audioconfiguration_so urce c 0 n 1 s0 n denotes the value of capability_naudioin 1 6 The audioconfiguration source for the profile Ex audioconfiguration_source c 0 n 1 s0...

Page 353: ...t DESCRIPTION name string 40 6 6 Identification of this entry ipaddress ip address 6 6 The ipaddress of the receiving camera username string 64 6 6 The username of the receiving camera passwd string 64 7 6 The password of the receiving camera port 0 65535 6 6 The connection port to the receiving camera do integer trigger time 6 6 Indicate the source id and trigger time of di trigger Ex 0 10 sets d...

Page 354: ...ule IO is connected 7 56 Focussystem Group focussystem_c 0 n 1 capability_image_c 0 n 1 _remotefocus 0 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION autofocus_enablebyzoom Boolean 7 6 To allow the feature of auto focus when zoom is operated Only available when capability_image_c 0 n 1 _focussystem_mode AFbyzoom 7 55 1 Save Day Night Focus Position Group fo...

Page 355: ...saved during day mode blank IR offset value hasn t been saved before focusshift_night_position blank positive integer 6 7 A customized IR offset value in lens profile when ICR is switched to night mode blank default IR offset value is used focusshift_night_lastdate blank YYYY MM DD HH MM SS 6 7 A recorded UTC time when IR offset value is saved during night mode blank IR offset value hasn t been sa...

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

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

Page 358: ...urce Default 0 resolution Available options are list in capability_videoin_c 0 n 1 _resolution Besides available options is referred to capability_videoin_c 0 n 1 _maxresolution and capability_videoin_c 0 n 1 _minresolution The resolution of the image Default Returns snapshot of current resolution by channel and streamid quality 1 5 The quality of the image streamid 0 capability_nmediastream 1 The...

Page 359: ...ername field is necessary and other fields are optional If not specified it will keep the original settings username name The name of the user to add delete or edit userpass value The password of the new user to add or that of the old user to modify The default value is an empty string privilege view The privilege of the user to add or to modify view Viewer privilege operator Operator privilege ad...

Page 360: ...Error Message List of error message ERROR Add user fail ERROR Delete user fail ERROR Update user s password fail ERROR Update user s privilege fail 8 6Upgrade 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 fil...

Page 361: ...s return return page Example http myserver cgi bin camctrl eCamCtrl cgi channel 0 stream 0 move right http myserver cgi bin camctrl eCamCtrl cgi channel 0 stream 1 vx 2 vy 2 vz 2 http myserver cgi bin camctrl eCamCtrl cgi channel 0 stream 1 x 100 y 100 videosize 640x480 resolution 640x480 stretch 0 In zoom operation there are two ways to control it scale zoom and area zoom 1 Scale zoom contains tw...

Page 362: ... 488 which means to zoom in to ratio x2 2 based on 1920x1080 Pay attention to that x y w h are essential parameters in an area zoom case and the stream index is counted from 0 as the first stream http IPAddr cgi bin camctrl eCamCtrl cgi channel 0 stream 0 x 912 y 297 w 864 h 488 resolution 1920x1 080 PARAMETER VALUE DESCRIPTION channel 0 n 1 Channel of video source stream 0 m 1 Stream move home Mo...

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

Page 364: ...rect to the page return page after the parameter is assigned The return page should be the relative path according to the root of camera If you omit this parameter it will redirect to an empty page If the return page is invalid path it will ignore this parameter 8 9ePTZ Preset Locations capability_eptz 0 and capability_fisheye 0 Note This request requires Operator privileges Method GET POST Syntax...

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

Page 366: ...be the same to be recognized as a pair for one session The contents of upstream should be base64 encoded to be able to pass through a proxy server This channel will help to transfer the raw data of UART over the network Please see UART tunnel spec for detail information PARAMETER VALUE DESCRIPTION channel 0 n 1 The channel number of UART 8 12 Event Control HTTP Tunnel Channel capability_evctrlchan...

Page 367: ...c for detail information 8 13 Get SDP of Streams Note This request requires Viewer access privileges Method GET POST Syntax http servername network_rtsp_s 0 n m 1 _accessname n denotes the value of capability_nvideoin m denotes the value of capability_nmediastream Example For m 2 the values are shown as network_rtsp_s0_accessname live1s1 sdp network_rtsp_s1_accessname live1s2 sdp network_rtsp_s2_a...

Page 368: ...ote This request requires Viewer privileges Method GET POST Syntax http servername cgi bin viewer senddata cgi com value data value flush value wait value read value PARAMETER VALUE DESCRIPTION com 1 max com port number The target COM RS485 port number data hex decimal data hex decimal data The hex decimal data is a series of digits from 0 9 A F Each comma separates the commands by 200 millisecond...

Page 369: ...is changed to read only PLEASE REFER TO EDGE STORAGE API Syntax http servername cgi bin admin lsctrl cgi cmd cmd_type parameter value The commands usage and their input arguments are as follows PARAMETER VALUE DESCRIPTION cmd_type string Required Command to be executed including search and queryStatus Command search PARAMETER VALUE DESCRIPTION label integer primary key Optional The integer primary...

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

Page 371: ...in downloadMedias cgi type type parameter value PARAMETER VALUE DESCRIPTION type text Required command to be excuted include videoclip device text command to be excuted include sd nas recordingtoken text Please refer to Edge Storage API starttime text Optional Format is YYYY MM DD HH MM SS Please embrace your input value with single quotes Example starttime 2008 01 01 00 00 00 Notice you should us...

Page 372: ...e duration nstate Where state is 0 1 0 means inactive or normal state while 1 means active or triggered state Where nstate is next state after duration Ex vi0 1 Setting virtual input 0 to trigger state Ex vi0 0 200 1 Setting virtual input 0 to normal state waiting 200 milliseconds setting it to trigger state Note that when the virtual input is waiting for next state it cannot accept new requests r...

Page 373: ...sft value For RTSP MP4 and H264 the user needs to input theURL below into an RTSP compatible player rtsp servername network_rtsp_s m _accessname maxsft value tsmode value refti me value forcechk minsft value n is the channel index m is the timeshift stream index For details on timeshift stream please refer to the TimeshiftCaching documents PARAMETER VALUE DEFAULT DESCRIPTION maxsft positive intege...

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

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

Page 376: ...otor Current position of focus motor remote_focus_zoom_enable Current function of zoom motor remote_focus_focus_enable Current function of focus motor remote_focus_iris_open The current status of iris 0 irisenable 1 irisopen Current function of zoom focus motor return value as below 0 no service 1 zooming 2 focusing 3 auto focus 4 focus scan 5 positioning both zoom motor and focus motor 12 reset f...

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

Page 378: ...on of zoom focus motor return value as below 0 no service 1 zooming 2 focusing 3 auto focus 4 focus scan 5 positioning both zoom motor and focus motor 12 reset focus 8 21 Export Files Note This request requires Administrator privileges Method GET Syntax For daylight saving time configuration file This CGI is not supported when the version number httpversion is equal or greater than 0314b please us...

Page 379: ...system_tz as a replacement http servername cgi bin admin upload_dst cgi Post data filename file name r n r n multipart encoded form data For language file http servername cgi bin admin upload_lan cgi Post data filename file name r n r n multipart 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 dat...

Page 380: ...ion For choose selected lens configuration and reboot camera http servername cgi bin admin update_lens cgi choose_reboot_lens value The camera will reboot after using this cgi For delete selected lens configuration http servername cgi bin admin update_lens cgi delete_lens value PARAMETER VALUE DESCRIPTION value string Available lens name Please refer to lens_default_i 0 n 1 _name lens_user_i 0 n 1...

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

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

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

Page 384: ...top vx integer excluding 0 The slope of movement vy vx used for joystick control vy integer vs 0 127 Set the speed of movement 0 means stop x integer x coordinate clicked by user It will be the x coordinate of center after movement y integer y coordinate clicked by user It will be the y coordinate of center after movement videosize window size The size of plug in ActiveX window in web page resolut...

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

Page 386: ...ability_camctrl_c 0 n 1 _buildinpt is 1 getmintilt 0 positive integer Get the lower limit for tilt position Only available when bit1 of capability_camctrl_c 0 n 1 _buildinpt is 1 getmaxtilt 0 positive integer Get the upper limit for tilt position Only available when bit1 of capability_camctrl_c 0 n 1 _buildinpt is 1 getmintiltangle integer Get the lower limit for tilt angle Only available when bit...

Page 387: ...zoommodule 1 Note This request requires Viewer privileges Method GET Syntax http servername cgi bin viewer recall cgi recall value channel value return return page PARAMETER VALUE DESCRIPTION recall string 30 One of the present positions to recall channel 0 capability_nvideoin 1 Channel of the video source ...

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

Page 389: ...re_block_rate Usage rate of spare blocks It means the usage percentage of total spare block The range is from 0 to 100 unit The SD card is recommended to be replaced if the percentage reaches above 90 smartsd_data_size_per_unit Size in sectors of data to be written when Life Information1 is updated smartsd_num_of_sudden_power_failure Indicates how many times power disconnection occurred during wri...

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

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

Page 392: ...rce heater once Syntax for query API http servername cgi bin admin peripheral cgi channel value operation get supportdevice Get support peripheral device washer_supportmode Get washer support modes washer_mode Get washer mode washer_status Get washer status washer_dwelltime Get washer clean time heater_supportstatus Get heater support control status heater_status Get heater status Example http mys...

Page 393: ...nning washer_dwelltime N A Get the current washer clean period of washer control system heater_supportstatus N A Get the support status of heater control system heater_status N A Get the current heater status Normally it will be auto it means the heater device is control by internal algorithm to keep in a suitable environment Otherwise is trigger it means the heater device is force enable to heat ...

Page 394: ... sensors and peripheral devices on camera Response devicemonitor_tempsensor_iX_name the name of temperature sensor devicemonitor_tempsensor_iX_celsius Current Celsius temperature of the sensor devicemonitor_tempsensor_iX_fahrenheit Current fahrenheit temperature of the sensor devicemonitor_heater_iY_name the name of heater sensor devicemonitor_heater_iY_status Current on off status of the heater s...

Page 395: ...r_tempsensor_i0_celsius 30 devicemonitor_tempsensor_i0_fahrenheit 86 devicemonitor_heater_i0_name front glass devicemonitor_heater_i0_status off 8 36 Optimized IR control capability_daynight_c 0 n 1 _optimizedir 0 Note This request requires Administrator privileges Method GET POST Syntax http servername cgi bin admin optimizedir cgi function value channel value PARAMETER VALUE DESCRIPTION channel ...

Page 396: ...ED e g 23 45 100 100 optimizedir_c 0 n 1 _irstatus Current IR status normal adjusting normal the IR LED strength has been fixed adjusting the IR LED strength is adjusting optimizedir_c 0 n 1 _supportmode auto automatically adjust the IR control manual manual adjustment Example http myserver cgi bin admin optimizedir cgi function getstatus Response HTTP 1 0 200 OK r n Cache control no cache r n Pra...

Page 397: ...it needs only one value for strength when the operation is set as settoall Example http myserver cgi bin admin optimizedir cgi channel 0 operation set irmode manual strength 50 70 50 50 50 Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n optimizedir_c0_irstrength 50 70 50 50 50 optimizedir_c0_irmode manual Example http myserver cgi bin admin optimizedir cgi channel 0...

Page 398: ...50 50 Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n ERROR Must have the irmode manual argument Syntax for query API http servername cgi bin admin optimizedir cgi channel value operation get support_irmode list all adjustment mode that IR supports irmode Get current IR mode irnum Get the number of IR zone PARAMETER VALUE DESCRIPTION channel 0 capability_nvideoin 1 ...

Page 399: ...vileges Method GET POST Syntax for control API http servername cgi bin admin thermalctrl cgi operation set action value Example http myserver cgi bin admin thermalctrl cgi operation set action shuttercompensate Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n OK Example http myserver cgi bin admin thermalctrl cgi operation set action shuttercompensate Response HTTP 1...

Page 400: ...in admin thermalctrl cgi operation get version Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n version 1120B15 8 38 Audio Clip Control capability_audio_audioclip 1 Note This request requires Administrator privileges Method GET POST Syntax for control API http servername cgi bin admin audioclip cgi operation value name value index value PARAMETER VALUE DESCRIPTION op...

Page 401: ...LUE DESCRIPTION clipname string Name of the audio clip clipindex 0 1 Number of the audio clip 8 39 Format SD card Note This request requires Administrator privileges Method GET POST Syntax for control API http servername cgi bin admin format_sdcard cgi operation set parameter value If the user requests a size larger than all stream settings on the server this request will fail If the user requests...

Page 402: ...ntent Length Error Message Length r n r n Error Message Syntax for query API http servername cgi bin admin format_sdcard cgi operation get PARAMETER VALUE DESCRIPTION Get Get formatting progress 0 100 or result error message It is unnecessary when using the blocking mode Example Request of get formatting progress 0 100 http myserver cgi bin admin format_sdcard cgi operation get Response of success...

Page 403: ... sdp profile streamprofile_i 0 n 1 _token parameter value n is the maximum stream profile number capability_media_streamprofiles_num streamprofile_i x _token is the unique identifier for each profile x is within 0 capability_media_streamprofiles_num 1 port is the rtsp port Please refer to the streamprofile group for requesting the stream profile token value for each profile PARAMETER VALUE DESCRIP...

Page 404: ...e multicast Get SDP file which contains the multicast information via HTTP PARAMETER VALUE DESCRIPTION pimssm 1 1 Enable the feature of Protocol Independent Multicast Source Specific Multicast This field is only required when using PIM SSM feature Only valid when network_rtsp_pimssm_enable 1 Note 1 This method is only valid when always multicast is enabled i e streamprofile_i x _alwaysmulticast 1 ...

Page 405: ...ame uploadKeyFile will be describing the request body see examples below Required when operation manualmode address sftp server address or hostname sftp server address or hostname This field is required port sftp port sftp port index 0 4 Event setting server index This field is required username string 64 Sftp server username This field is required passwd string 64 Sftp server password Required wh...

Page 406: ...nload key Request http servername cgi bin admin sftpclient cgi operation manualmode key download index 1 address ip userna me xxx fingerprint_enable 1 fingerprint_content MD5 value keytype ecdsa Response of success HTTP 1 1 200 OK r n Content Type text plain r n Content Length Success Message Length r n r n ok Request http servername cgi bin admin sftpclient cgi operation manualmode key download i...

Page 407: ...Kpc7qmMgTk rL s12230NogZsqghhTJIpg2vX5Ha3wCDIZZVKPUGItQl0MB6t74nsV1o8YVtRovI5F YX2d8sPIIkcTDWBO498 v98DQ7DH51 i39JoJouRojz n3ffsSGjY2AKEcTde2xI v2f81KqAxkraXllScl1SNEGXQpngXy3IK2GrVw9BzJILMSBuj30Ar2zfTbc0C5VC YqWK1FcMA5Jb6AvYwmpgijIb52T9P7g07RwFGJpumvaqTchBeSp8pXa3C DoBdY 9zYohmuSSs52QLoIkTPzDjJJHvncddPi6VuUkSyaK5x75p0 aoljPjlAQHXbXsmt 8HAdPs9Fwab9GbC2aumH4XT1xoWFnYJ9lBHc3iZRiI nSIPev2YneyyOhJg4tH...

Page 408: ...anning SFTP server host key Request http servername cgi bin admin sftpclient cgi operation getserverhostkey address ip Response of success HTTP 1 1 200 OK r n Content Type text plain r n Content Length Success Message Length r n r n MD5 value 8 40 2 SFTP Server Setting Only available when bit 1 of capability_protocol_ftp_server is 1 Syntax for control API http servername cgi bin admin sftpserver c...

Page 409: ...erver cgi operation value PARAMETER VALUE DESCRIPTION operation gethostkey gethostkey Get host key for SFTP server This field is required If updatehostkey is not yet finished you will receive error message Example of get host key Request http servername cgi bin admin sftpserver cgi operation gethostkey Response of success HTTP 1 1 200 OK r n Content Type text plain r n Content Length Success Messa...

Page 410: ... Notices from HEVC Advance THIS PRODUCT IS SOLD WITH A LIMITED LICENSE AND IS AUTHORIZED TO BE USED ONLY IN CONNECTION WITH HEVC CONTENT THAT MEETS EACH OF THE THREE FOLLOWING QUALIFICATIONS 1 HEVC CONTENT ONLY FOR PERSONAL USE 2 HEVC CONTENT THAT IS NOT OFFERED FOR SALE AND 3 HEVC CONTENT THAT IS CREATED BY THE OWNER OF THE PRODUCT THIS PRODUCT MAY NOT BE USED IN CONNECTION WITH HEVC ENCODED CONT...

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

Search results

Summary of Contents for VIVOTEK CU9171

Reviews:

Related manuals for VIVOTEK CU9171

Brands by name

Popular brands

DELTA GROUP VIVOTEK CU9171, User Manual

Search results

Summary of Contents for VIVOTEK CU9171

Reviews:

Related manuals for VIVOTEK CU9171

Brands by name

Popular brands