Vivotek FD9167-H User Manual Download

Page: 248 / 387

VIVOTEK

248 - User's Manual

* This is kept for compatibility.

videoin_codec

mjpeg, h264, h265

0/7

Available codec of a device, split by comma.
The sequence is not limited.

EX:
FD8183 supports H.264 and MJPEG, then this
is "mjpeg,h264".
IP9171 supports H.264, MJPEG and H.265,
then this is "mjpeg,h264,h265"

videoin_streamcodec

A list of <Positive
Integer>

0/7

This equals
"capability_videoin_c0_streamcodec".

* This is kept for compatibility.

videoin_flexiblebitrate

0/7

Indicate whether to support
flexible bit rate control.

videoout_codec

A list of the available
codec types
separated by
commas

0/7

Available codec list.
"

": not supported

timeshift

0/7

Indicate whether to support time shift caching
stream.

audio_aec

0/7

Indicate whether to support acoustic echo
cancellation.

audio_aecmode auto,

manual

0/7

Indicate the acoustic echo cancellation control
mode.

"auto"

: control by camera automatically.

"manual"

: Manually turn on/off the control

mode.

*Only available when
"capability_audio_aec" is "1".
* We support this parameter when the version
number (httpversion) is equal or greater than
0306b.

audio_aecaffect -,

maxframerate:fixed
:15

0/7

When

acoustic

echo

cancellation

function

enabled, some features may become
malfunction or be forced to a given value. The

Summary of Contents for FD9167-H

Page 1: ...User s Manual 2MP 30FPS Day Night SNV Smart Stream III WDR Pro SNV II 30M Smart IR IP66 IK10 Fixed Dome Network Camera FD9167 H FD9167 HT FD9367 HV FD9367 HTV FD9367 EHTV Rev 1 0 ...

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

Page 3: ...mart IR II technology from VIVOTEK speed domes the FD9367 IR illuminators now align with the remote focus lens focus angle to provide the best IR image quality at any lens setting This feature optimizes IR intensity reduces IR hotspots and increases the IR effective range up to 30 meters Additionally the FD9367 series employs VIVOTEK s Smart Stream III technology and H 265 compression codec reduci...

Page 4: ... use should be straightforward for those who have basic networking knowledge It is designed for various applications including video sharing general security surveillance etc The Configuration chapter suggests ways to best utilize the Network Camera and ensure proper operations For creative and professional developers the URL Commands of the Network Camera section serves as a helpful reference to ...

Page 5: ...to the functional integrity of the machine Tips Tips are useful information that helps enhance or facilitae an installation function or process WARNING or IMPORTANT These statements indicate situations that can be dangerous or hazardous to the machine or you Electrical Hazard This statement appears when high voltage electrical hazards might occur to an operator Physical Description Outer View FD91...

Page 6: ...n Inner View FD9167 Status LEDs Some of the suffix syntax used in model naming are listed below E w heater for extreme weather Fx Focal length w number T w Remote focus lens R w PoE repeater H w High Dynamic Range functionality NOTE Microphone Terminal block Tilt retention screw Pan retention screw PIR sensor ...

Page 7: ...oE 10W PoE Plus mid span or switch 40ºC heater on 12V input 2A 25W 10ºC heater off 12V input 1A 1 2 3 4 6 5 8 7 10 LAN PoE 100 240V AC ON OFF 9 GE LAN GE LAN 802 3at 12V 1A or 2A Inner View FD9367 Lens RJ45 Ethernet port IR LEDs SD card slot Reset button Status LEDs Terminal block Tilt retention screw Pan retention screw Threaded hole for I O wires Threaded hole for Ethernet cable ...

Page 8: ...VIVOTEK 8 User s Manual Hardware Installation FD9167 0002D10766AD XXXXXX 1 Jot down the camera s MAC address for later reference 2 Remove the dome cover using the T10 L wrench ...

Page 9: ...al 9 4 Attach the alignment sticker to a preferred location and drill mounting holes Hammer in the plastic anchors 3 When selecting an installation position note the PIR detection range as illustrated below 77 3 121 5M 5M ...

Page 10: ...XT_MIC_N 2 EXT_MIC_P 3 Audio_out 4 Audio_out 5 DI 6 DI 7 DO 8 DO 5V 9 12V DC _IN 10 12V DC _IN Browser LAN Shepherd 6 Please visit VIVOTEK s website to Install the Shepherd software utility The program will search for VIVOTEK Video Receivers Video Servers or Network Cameras on the same LAN Double click on the camera s MAC address to open a web console with the camera ...

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

Page 12: ...9 MAC 0002D1730202 Ro HS 7 3 The program will search for all VIVOTEK network devices on the same LAN 7 4 After a brief search the installer window will prompt Click on the MAC and model name that matches the one printed on the product label You can then double click on the address to open a management session with the Network Camera Forceful Password Configuration 8 The first time you log in to th...

Page 13: ... 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 8 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 14: ...etely remove the retention screws on the camera to adjust the camera s shooting direction You can pan tilt or rotate the camera 1 2 3 350 350 60 11 Install the dome cover 10 Tighten the retention screws when you are statisfied with the field of view ...

Page 15: ...VIVOTEK User s Manual 15 Hardware Installation FD9367 0002D10766AD XXXXXX 1 Jot down the camera s MAC address for later reference 2 Remove the dome cover using the included T10 L wrench ...

Page 16: ...VIVOTEK 16 User s Manual 4 Route an Ethernet cable through the associated threaded hole on the camera 5 6 3mm DI DO 1 8 2 1mm 3 Remove the waterproof cable gland components from the camera ...

Page 17: ...e cable gland components rubber seal claw and sealing nut to the Ethernet cable 6 Leave around 11 6cm of cable length within the camera and fasten the cable gland sealing nut Connect the Ethernet cable to the camera s RJ45 onnector 11 6 cm ...

Page 18: ...cable gland components This cable gland must be installed whether you have DI DO wires or not Otherwise water or moisture ingress will occur 1 2 3 4 5 6 7 8 910 Name 1 EXT_MIC_N 2 EXT_MIC_P 3 Audio_out 4 Audio_out 5 DI 6 DI 7 DO 8 DO 5V 9 12V DC _IN 10 12V DC _IN The terminal block pinouts is shown below ...

Page 19: ...routing hole Install the camera by hammer in the wall anchors and drive screws A 9 When fastening the screws do not completely tighten the screws Pass cables through the routing holes and then mount the camera by passing the screw heads through the keyhole slots Turn the camera counter clockwise and then fasten the screws ...

Page 20: ... s Manual 3 4 Ø 35mm 3 4 Please avoid using a conduit with a hex nut larger than 35mm If you prefer routing your cables through the side of the camera install the side routing bracket The 3 4 conduit is user supplied ...

Page 21: ...work Cameras on the same LAN Double click on the camera s MAC address to open a web console with the camera Browser LAN Shepherd Software Installation 11 Install the Shepherd utility which helps you locate and configure your Network Camera in the local network If your camera comes without the CD go to VIVOTEK s website and locate the utility in the Downloads Software page ...

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

Page 23: ...iguration for security concerns 12 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 12 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 24: ...pecial ASCII characters are supported _ and You can use them in the password combination 12 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 25: ...ooting direction 13 Loosen but not completely remove the retention screws on the camera to adjust the camera s shooting direction You can pan tilt or rotate the camera lens module 350 350 60 15 Tighten the retention screws when you are statisfied with the field of view ...

Page 26: ...rom a web console open the firmware configuration page Enter the Configuration Media Image Focus page You will see a live stream on screen If pre ferred you can zoom in on the scene Use the Perform Auto Focus function to automati cally tune to a best image focus Check the live view to ensure the image is in focus 16 Install the dome cover ...

Page 27: ... or by an external power source depending on the type of relay you use 4 In case of using an individual relay instead of using a relay module for protection against voltage or current spikes a transient voltage suppression diode must be connected in parallel with the inductive load DI DO DI DO Switch ExternalDevice ExternalDC power Dry contact with external DC power source to supply a relay Dry co...

Page 28: ...er Wet contact with external DC power source to supply a relay NC NO Relay DC ExternalAC power with Protected Earth AC PE PE DC 0V DI DO DI DO Switch ExternalDevice Dry contact and using camera s DO to supply a relay NC NO Relay AC ExternalAC power with Protected Earth PE PE ...

Page 29: ...et network disconnected Hardware Reset The reset button is used to reset the system or restore the factory default settings Sometimes resetting the system can return the camera to normal operation If the system problems remain after reset restore the factory settings and install again Reset Press the recessed reset button Wait for the Network Camera to reboot Restore Press and hold the reset butto...

Page 30: ...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 with PoE output 802 3af 8...

Page 31: ... CD in a deployment consisting of multiple cameras For its installation details please refer to its related documents The E models e g FD9367 EHTV are able to operate in low temperature environments However when starting these cameras in a very low termperature condition e g 40ºC the embedded heater may take half an hour to warm up the camera When the temperature within the canister reaches 10ºC t...

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

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

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

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

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

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

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

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

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

Page 41: ...ell 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...

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

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

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

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

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

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

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

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

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

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

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

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

Page 54: ...r you to choose from The new layout will simultaneously appear in the Preview filed Click Save to enable the settings Font Color of the Video Title Background Color of the Video Area Frame Color Font Color Background Color of the Control Area Font Color of the Configuration Area Background Color of the Configuration Area Preset patterns ...

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

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

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

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

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

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

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

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

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

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

Page 65: ...ter at all times for the sensor to accept infrared light thus helping to improve low light sensitivity Light sensor sensitivity Tune the responsiveness of the IR filter to lighting conditions as Low Normal or High When completed with the settings on this page click Save to enable the settings Schedule mode The Network Camera switches between day mode and night mode based on a specified schedule En...

Page 66: ...ters or farther away the Smart IR function may not bring as significant benefits as in close range Smart IR Anti overexposure When enabled the camera automatically adjusts the IR projection to adjacent objects in order to avoid over exposure in the night mode IR control Turn on built in IR illuminator in night mode Select this to turn on the camera s onboard IR illuminator when the camera detects ...

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

Page 68: ...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 69: ...a range of time if you choose the Schedule mode Then check Save to take effect Noise reduction Enable noise reduction Check to enable noise reduction in order to reduce noises and flickers in image This applies to the onboard 3D Noise Reduction feature Use the slide bar to adjust the reduction strength Note that applying this function to the video channel will consume system computing power 3D Noi...

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

Page 71: ...ve part of the overlapped windows will be deducted from the inclusive window An exposure value will then be calculated out of the remaining of the inclusive window BLC Back Light Compensation This option will automatically add a weighted region in the middle of the window and give the necessary light compensation Include Exclude Weighted region Ignored region Include Exclude Flickerless Fixed iris...

Page 72: ... enhanced This function allows users to identify more image details with an extreme contrast from an object of interest with one shadowed side against a bright background e g an entrance You may select the Enable WDR enhanced checkbox and then adjust the strength low medium high to reach the best image quality WDR Pro This refers to the Wide Dynamic Range function that enables the camera to captur...

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

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

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

Page 76: ...am 2 is set to the 640 x 360 Stream 3 The default frame size for Stream 3 is set to the 1920 x 1080 Click Viewing Window to open the viewing region settings page On this page you can configure the Region of Interest and the Output Frame Size for a video stream For example you can crop only a portion of the image that is of your interest and thus save the bandwidth needed to transmit the video stre...

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

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

Page 79: ... 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 80: ...coding returns to normal to deliver real time streaming f1 f1 f1 f1 f5 f5 f5 f5 f9 f1 f1 f1 f1 f5 f5 f5 f5 f9 f1 f1 f3 f4 f5 f6 f7 f8 f9 Motions Occur By queuing and re encoding 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 2 is embedded in firm...

Page 81: ...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 82: ...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 83: ...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 scenes in different luminosities and hence reduces the occurrence of noises in low light frames Less noises means less of the bandwidth consumed Endorsing different qualities for the I frames and P frames and hence reduces the frame size The h...

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

Page 86: ...ing message is displayed External microphone input Select the gain of the external audio input according to ambient conditions Adjust the gain from 0 to 100 Audio type Select audio codec and the sampling bit rate G 711 also provides good sound quality and requires about 64Kbps Select pcmu μ Law or pcma A Law mode G 726 is a speech codec standard covering voice transmission at rates of 16 24 32 and...

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

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

Page 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: ...smits 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 45 and Stream settings on page 76 SIP SIP is short for Session Initiation Protocol If necessary you can change ...

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

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

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

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

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

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

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

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

Page 107: ...elect the checkboxes and then click Save to enable the settings If you give Viewers the privilege Operators will also have the ability to control the Network Camera through the main page Please refer to Configuration on page 50 Allow anonymous viewing If you select this item any client can access the live stream without entering a User ID and Password ...

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

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

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

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

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

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

Page 114: ... been created and installed before you can click on the Save button for the configuration to take effect 12 To begin an encrypted HTTPS session click Home to return to the main page Change the URL address from http to https in the address bar and press Enter on your keyboard Some Security Alert dialogs will pop up Click OK or Yes to enable HTTPS ...

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

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

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

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

Page 119: ...ork Camera the supplicant and the RADIUS Server the authentication server 2 A Network Camera requests access to the protected LAN using 802 1X via a switch the authenticator The client offers its identity and client certificate which is then forwarded by the switch to the RADIUS Server which uses an algorithm to authenticate the Network Camera and returns an acceptance or rejection back to the swi...

Page 120: ...Z Operation The e PTZ control settings section will be displayed as shown below For e PTZ related details please refer to page 122 Auto pan patrol speed Select the speed from 1 5 slow fast to set up the Auto pan patrol speed control Zoom factor display If you check this item the zoom indicator will be displayed on the home page when you zoom in out the live viewing window as the picture shown on t...

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

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

Page 126: ...ction can take place as a complement to motion detection or as a method to detect activities not covered by the camera s view VADP It is presumed that you already uploaded and enabled the VADP modules before you can associatee VADP triggers with an Event setting Click on the Set VADP Trigger button to open the VADP setup menu The triggering conditions available with 3rd party software modules know...

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

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

Page 131: ...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 154 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 132: ...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 2018 01 20 2018 01 20 2018 01 20 2018 01 20 ...

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

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

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

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

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

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

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

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

Page 142: ...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 143: ... 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 144: ... Refer to page 86 for Audio settings and page 78 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 145: ...VIVOTEK User s Manual 145 Applications PIR FD9167 Click the checkbox to enable the PIR detection Default is enabled ...

Page 146: ...whether the module fits the predefined VADP requirements Please contact our technical support or the vendor of your 3rd party module for the parameters contained within Users can also run VIVOTEK s VADP packages as a means to access updated functionality instead of replacing the entire firmware Note that for some cameras the flash is too small to hold VADP packages These cameras will have its Save...

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

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

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

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

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

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

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

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

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

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

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

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

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

Page 169: ...ncluding model company and version number in the format MODEL BRAND VERSION language_count positive integer 0 7 Number of webpage languages available on the server language_i 0 count 1 string 16 language_i0 English language_i1 Deutsch language_i2 Español language_i3 Français language_i4 Italiano language_i5 日本語 language_i6 Português language_i7 简体中文 language_i8 繁體中文 0 7 Available language lists...

Page 170: ...TP push server connections onlinenum_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 D...

Page 171: ... closed circuit inactive status 7 5security Group security NAME VALUE SECURITY get set DESCRIPTION privilege_do view operator admin 1 6 Indicate which privileges and above can control digital output capability ndo 0 privilege_camctrl view operator admin 1 6 Indicate which privileges and above can control PTZ capability ptzenabled 0 or capability eptz 0 user_i0_name string 64 6 7 User name of root ...

Page 172: ...ail Stopped service will auto start after changing port settings Ex Change HTTP port from 80 to 5556 and change RTP port for video from 5556 to 20480 Then set preprocess 9 to stop both service first cgi bin admin setparam cgi network_preprocess 9 network_http_port 5556 network_rtp_videoport 20480 type lan pppoe 6 6 Network connection type resetip boolean 6 6 1 Get ipaddress subnet router dns1 dns2...

Page 173: ...ekeypassword 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 Certificate installed flag for TLS certificate_time 0 positive integer 6 7 Certificate installed time Represented in EPOCH certificate_size 0 positive integer 6 7...

Page 174: ...os dscp 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable disable DSCP video 0 63 6 6 Video channel for DSCP audio 0 63 6 6 Audio channel for DSCP capability naudioin 0 eventalarm 0 63 6 6 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 N...

Page 175: ...de s 0 capability_nmediast ream 1 _accessname product dependent string 32 1 6 Http server push access name for stream N N 1 capability nmediastream capability protocol spush_mjpeg 1 and capability nmediastream 0 The value are shown as video mjpg s0_accessname stream1 video2 mjpg s1_accessname stream2 video3 mjpg s2_accessname stream3 video4 mjpg s3_accessname stream4 etc anonymousviewing boolean 1...

Page 176: ...peg 1 and capability nmediastream 0 The value are shown as live sdp s0_accessname stream1 live2 sdp s1_accessname stream2 live3 sdp s2_accessname stream3 live4 sdp s3_accessname stream4 etc 7 6 7 1 RTSP multicast Subgroup of network_rtsp_s 0 n 1 multicast n is stream count NAME VALUE SECURITY get set DESCRIPTION alwaysmulticast boolean 4 4 Enable always multicast ipaddress ip address 4 4 Multicast...

Page 177: ... than 0304a videoport 1025 65535 4 4 Multicast video port audioport product dependent 1025 65535 4 4 Multicast audio port Only available when capability_naudioin 0 metadataport 1026 65534 4 4 Multicast metadata port ttl 1 255 4 4 Multicasttime to live value 7 6 8 SIP port Subgroup of network sip capability protocol sip 0 NAME VALUE SECURITY get set DESCRIPTION port 1025 65535 1 6 SIP port 7 6 9 RT...

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

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

Page 180: ...lc 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 flip boolean 4 4 Flip the image mirror boolean 4 4 Mirror the image rotate 0 90 180 270 1 4 The rotation angle of image Support...

Page 181: ...2000 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_mi nrange Only valid when piris_mode manual or irismode fixed Only available when capability_image_c 0 n 1 _exposure_ra ngetype 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 _expo...

Page 182: ... 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 _nm ode 1 4 4 Indicate the video mode on use whitebalance product dependent auto manual rbgain widerange outdoor indoor sodiumauto etc Available values are listed in capability_image_c 0 n 1 _wbm ode 4 4 Modes of wh...

Page 183: ...100 Strong Only available when rbgain is listed in capability_image_c 0 n 1 _wbm ode 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 _wbm ode Only valid when videoin_c 0 n 1 _whitebalance auto Normalized range exposurelevel 0 12 4 4 E...

Page 184: ...vel shutterpriority Manually adjust with variable Shutter Speed and keep adjusting Iris Gain automatically irispriority Manually adjust with variable Iris and keep adjusting Gain and Shutter speed automatically qualitypriority Automatically adjust the Iris Gain and Shutter Speed by VIVOTEK quality algorithm manual Manually adjust with variable Shutter Iris and Gain We support this parameter when t...

Page 185: ...Manual set P Iris by piris_position not support only available when capability_image_c 0 n 1 _sens ortype is smartsensor Only available when capability_image_c 0 n 1 _iristy pe piris piris_position product dependent 1 100 1 4 Manual set P Iris 1 Open 100 Close Only valid when piris_mode manual or capability_image_c 0 n 1 _sens ortype is smartsensor Only available when capability_image_c 0 n 1 _iri...

Page 186: ... Low 100 High Only available when capability_image_c 0 n 1 _agc_ mingain Only valid when piris_mode manual or irismode fixed Normalized range Only available when capability_image_c 0 n 1 _expo sure_rangetype is twovalues gainvalue 0 100 4 4 Gain value 0 Low 100 High Only available when capability_image_c 0 n 1 _agc_ maxgain and capability_image_c 0 n 1 _expo sure_rangetype is onevalue Normalized r...

Page 187: ...ration 0 not support 1 support Bit 5 Support focus operation 0 not support 1 support SD PZ IZ series only text string 64 1 4 Enclose caption imprinttimesta mp boolean 4 4 Overlay time stamp on video textonvideo_po sition top bottom 4 4 Text on video string position textonvideo_siz e 20 40 4 4 Text on video font size textonvideo_fon tpath usr share font Default ttf mnt flash2 upload ttf 4 4 Choose ...

Page 188: ...ime 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc This parameter may also restrict image frame rate from sensor due to sensor generates a frame per exposure time Ex If this is set to 1 5s 1 8000s and camera takes 1 5s on the night then sensor only outputs 5 frame s Only available when capability_image_c 0 n 1 _expo sure_maxrange Only valid when piris_mode manu...

Page 189: ...ual 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 _expo sure_mode 0 crop_position coordinate x y 1 7 Crop left top corner coordinate crop_size window size WxH 1 7 Crop width and height width must be 16x or 32x and height must be 8x zoomratiodispla y boolean 1 4 Indicates multiple of z...

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

Page 191: ...quality 100 Best quality Only valid when ratecontrolmode vbr and quant 100 s 0 m 1 _h 264_maxvbrbitr ate 20000 capability_videoin_c 0 n 1 _h264_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 ratecontrolmode vbr s 0 m 1 _h 264_cbr_quant 1 5 100 4 4 Set the pre defined quality leve...

Page 192: ... Only valid when ratecontrolmode cbr s 0 m 1 _h 264_maxframe 1 capability_videoin_c 0 n 1 _h 264_maxframerate 1 4 The maximum frame rates of a H264 stream at different resolutions capability_videoin_c 0 n 1 _resolution are recorded in capability_videoin_c 0 n 1 _h26 4_maxframerate s 0 m 1 _h 264_profile 0 2 1 4 Indicate H264 profiles 0 baseline 1 main profile 2 high profile s 0 m 1 _h 264_smartq_e...

Page 193: ...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 _h 265_quant 1 5 99 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality level in qpercent 99 Use the quality level in qvalue Only available when h265 is listed in capabilit...

Page 194: ...e bit rate exceeds this value frames will be dropped to restrict the bit rate Only available when h265 is listed in capability_videoin_codec Only valid when ratecontrolmode vbr s 0 m 1 _h 265_cbr_quant 1 5 100 4 4 Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality level in cbr_qpercent Only available when h265 is listed in capability_videoin_cod...

Page 195: ...ly valid when ratecontrolmode cbr s 0 m 1 _h 265_maxframe 1 capability_videoin_c 0 n 1 _h 265_maxframerate 1 4 The maximum frame rates of a H265 stream at different resolutions capability_videoin_c 0 n 1 _resolution are recorded in capability_videoin_c 0 n 1 _h26 5_maxframerate Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h 265_profile Available values are listed in capa...

Page 196: ...httpversion format is XXXXX_1 or XXXXX_3 ex 0301a_1 or 0301a_3 or 1 99 Only valid when capability_api_httpversion format is XXXXX_2 ex 0301a_2 product dependent 4 4 Manual video quality level input The Q value which is used by encoded library directly Only valid when ratecontrolmode vbr and s 0 m 1 _mjpeg_quant 99 s 0 m 1 _m jpeg_qpercent 1 100 4 4 Select customized quality in a normalized full ra...

Page 197: ...range 1 Worst quality 100 Best quality Only valid when ratecontrolmode cbr and quant 100 Only available when capability_smartstream_version 2 0 s 0 m 1 _m jpeg_bitrate 20000 capability_videoin_c 0 n 1 _mjpeg_maxbitrate 4 4 The target bit rate in constant bit rate mode Only valid when ratecontrolmode cbr s 0 m 1 _m jpeg_prioritypoli cy framerate imagequality 4 4 Set prioritypolicy Only valid when r...

Page 198: ... h product dependent 1 100 4 4 The strength of WDR Pro The bigger value means the stronger strength of WDR Pro Only available when capability_image_c 0 n 1 _wdrp ro_strength is 1 wdrc_mode product dependent boolean 4 4 Enable WDR enhanced Only available when capability_image_c 0 n 1 _wdrc _mode is 1 wdrc_strength product dependent 1 100 4 4 The strength of WDR enhanced The bigger value means the s...

Page 199: ...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 _aesp eed is 1 and capability_image_c 0 n 1 _aesp eedsupportsensitivity is 1 flickerless product dependent boolean 4 4 Turn on 1 or turn off 0 the flickerless mode Only available when capability_ima...

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

Page 201: ...in_i 0 k 1 capability_smartstream_support 1 capability_smartstream_version 2 0 and capability_smartstream_mode_manual 1 Group videoin_c 0 n 1 _s 0 m 1 _h265_smartstream2_win_i 0 k 1 capability_smartstream_support 1 capability_smartstream_version 2 0 and h265 is listed in capability_videoin_codec and capability_smartstream_mode_manual 1 n denotes the value of capability_nvideoin m denotes the value...

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

Page 203: ...value product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c 0 n 1 _exposu re_maxrange 4 4 Exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc This parameter may also restrict image frame rate from sensor due to sensor generates a frame per exposure time Ex If this is set to 1 5s 1 8000s and camera takes 1 5...

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

Page 205: ...supported rgain and bgain are updated to the current values which is got from white balance module Then act as rbgain mode widerange Auto Tracing White balance 2000K to 10000K outdoor auto white balance mode specifically for outdoor indoor auto white balance mode specifically for indoor sodiumauto sodium vapor lamps Only available when capability_image_c 0 n 1 _wbmode rgain 0 100 4 4 Manual set rg...

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

Page 207: ...valid when piris_mode manual or capability_image_c 0 n 1 _sensortype is smartsensor Only available when capability_image_c 0 n 1 _iristype piri s irismode fixed indoor outdoor product dependent 4 4 Control DC Iris mode outdoor Auto setting DC Iris to get best quality but easy to meet rolling or flicker effect in indoor environment indoor Avoid rolling and flicker effect first fixed Open the iris t...

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

Page 209: ...pability_image_c 0 n 1 _flickerless is 1 7 9Time Shift settings Group timeshift for n channel profucts and m stream n denotes the value of capability_nvideoin m denotes the value of capability_nmediastream capability timeshift 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable time shift streaming c 0 n 1 _s 0 m 1 _allow boolean 4 4 Enable time shift streaming for specific stream ...

Page 210: ... disable built in IR led capability_daynight_c 0 capability_nvideoi n 1 _buildinir 0 enableextled boolean 1 6 Enable disable external IR led capability_daynight_c 0 capability_nvideoi n 1 _externalir 0 extledmode do irring Available values are listed in capability_daynight _c 0 n 1 _extle d_interface 6 6 Turn on an external IR led which is mounted do digital output device or is a IR ring device On...

Page 211: ...lity_daynight _c 0 n 1 _ircut sensitivity_type no rmalize low normal high if capability_daynight_c 0 n 1 _ircutsensiti vity_type options 1 100 if capability_daynight_c 0 n 1 _ircutsensiti vity_type normalize Only available when capability_daynight_c 0 n 1 _ircutsensitivity_type is not ...

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

Page 213: ...400a brightnesspercent 0 100 4 4 Set brightness in the normalized range 0 Darker 100 Bright Only available when bit 0 of capability_image_c 0 n 1 _basicsetting is 1 contrastpercent 0 100 4 4 Set contrast in the normalized range 0 Less contrast 100 More contrast Only available when bit 1 of capability_image_c 0 n 1 _basicsetting is 1 saturationpercent 0 100 4 4 Set saturation in the normalized rang...

Page 214: ...le disable low light mode Only available when capability_image_c 0 n 1 _lowlightmode is 1 dnr_mode product dependent boolean 4 4 3D noise reduction 0 disable 1 enable Only available when capability_image_c 0 n 1 _dnr is 1 dnr_strength product dependent 1 100 4 4 Strength of 3DNR Only available when capability_image_c 0 n 1 _dnr is 1 defog_mode product dependent boolean 4 4 Enable disable defog mod...

Page 215: ... 4 Enable disable scene mode 0 disable 1 enable Only available when capability_image_c 0 n 1 _scenemode_ support is 1 scene_mode product dependent visibility noiseless lpcparkinglot lpcstreet product dependent 4 4 Value of scene mode Only available when capability_image_c 0 n 1 _scenemode_ support is 1 Available value is listed in capability_image_c 0 n 1 _scenemode_ supporttype restoreatwb positi...

Page 216: ...e bit 5 of capability_image_c 0 n 1 _basicsetting is 1 lens_alignment 0 100 4 4 Stitch the sensors together into focused position Only available when capability_image_c 0 n 1 _lens_alignme nt is 1 profile_i 0 m 1 _enable boolean 4 4 Enable disable this profile setting profile_i 0 m 1 _policy night schedule 4 4 The mode which the profile is applied to Not support policy day anymore when the version...

Page 217: ...ll 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 profile_i0_saturation with profile_i0_saturationpercent This parameter will not be used ...

Page 218: ...y_image_c 0 n 1 _basicsetting is 1 profile_i 0 m 1 _saturation percent 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 _sharpness percent 0 100 4 4 Set sharpness in the normalized range 0 Softer 100 Sharper Only available when bit 3 of capability_image_c 0 n 1 _basicsetti...

Page 219: ...efog mode 0 disable 1 enable Only available when capability_image_c 0 n 1 _defog_mode is 1 profile_i 0 m 1 _defog_str ength product dependent 1 100 4 4 Strength of defog Only available when capability_image_c 0 n 1 _defog_mode is 1 profile_i 0 m 1 _eis_mode product dependent boolean 4 4 Electronic image stabilizer 0 disable 1 enable Only available when eis is listed in capability_image_c 0 n 1 _is...

Page 220: ...isable scene mode 0 disable 1 enable Only available when capability_image_c 0 n 1 _scenemode_ support is 1 profile_i 0 m 1 _scene_mo de product dependent visibility noiseless lpcparkinglot lpcstreet product dependent 4 4 Value of scene mode Only available when capability_image_c 0 n 1 _scenemode_ support is 1 Available value is listed in capability_image_c 0 n 1 _scenemode_ supporttype ...

Page 221: ...roup exposurewin_c 0 n 1 _win_i 0 k 1 n denotes the value of capability_nvideoin k denotes the value of capability_image_c 0 n 1 _exposure_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...

Page 222: ... 9999x0 9999 4 4 Width and height of the window Only available when std is listed in capability_image_c 0 n 1 _exposure_wi ndomain Group exposurewin_c 0 n 1 _profile_i 0 m 1 for n channel profuct and m profile n denotes the value of capability_nvideoin m denotes the value of capability_nvideoinprofile Only available when capability_image_c 0 n 1 _exposure_mode 1 NAME VALUE SECURITY get set DESCRIP...

Page 223: ...isted in capability_image_c 0 n 1 _exposure_wi ntype home 0 320 0 240 4 4 Left top corner coordinate of the window Only available when qvga is listed in capability_image_c 0 n 1 _exposure_wi ndomain size 0 320x0 240 4 4 Width and height of the window Only available when qvga is listed in capability_image_c 0 n 1 _exposure_wi ndomain homepx 0 W 0 H W 0 The current image width 1 H 0 The current imag...

Page 224: ...y and suggest don t use this since the version number httpversion is equal or greater than 0301a We replace source with input More details please refer the parameter description of input input intmic extmic product dependent 4 4 intmic Internal built in microphone Only available when capability_audio_intmic 1 extmic External microphone input Only available when capability_audio_extmic 1 Note If ph...

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

Page 226: ...Only available if G 726 is supported s0_g726_bitstreampackin gmode little big 4 4 Set G 726 bit streaming packing mode little Little endian bitstream format big Big endian bitstream format Only available if G 726 is supported s0_g726_vlcmode 0 1 4 4 Enable vlcmode for G 726 0 Standard mode 1 Solve compatibility problem with VLC player Only available if G 726 is supported aec_enable boolean 4 4 Ena...

Page 227: ..._i0_endtime hh mm 4 4 End time of schedule mode profile_i0_alarm_level 1 100 4 4 Audio detection alarm level 7 14 Audio out per channel Group audioout_c 0 n 1 for n channel products capability_audio_audioclip 1 n denotes the value of capability_nvideoin NAME VALUE SECURITY get set DESCRIPTION volume 0 100 4 4 Adjusting audio volume 7 15 Play an audio clip Group audioclip_i 0 1 capability_audio_aud...

Page 228: ...ion 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 objsize 1 100 4 4 Percent of motion detection window sensitivity Not recommended to use...

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

Page 230: ...n It s recommended to use polygonsd This parameter will not be used after the version number httpversion is equal or greater than 0400a Group motion_c 0 n 1 _profile_i 0 m 1 for m profile and n channel product n denotes the value of capability_nvideoin m denotes the vaule of capability_nmotionprofile capability_nmotionprofile 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 4 4 Enable prof...

Page 231: ... available when std is listed in capability_motion_windomain objsize 1 100 4 4 Percent of motion detection window sensitivity Not recommended to use this 0 100 4 4 Sensitivity of motion detection window We replace sensitivity with win_sensitivity This parameter will not be used after the version number httpversion is equal or greater than 0400a polygonpx Not recommended to use this 0 W 0 H 0 W 0 H...

Page 232: ...able 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 is listed in capability_motion_windomain It s recomme...

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

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

Page 235: ... service provider provider _passwordkey string 64 7 6 Your password or key to login to the DDNS service provider provider _servername string 128 6 6 The server name for safe100 This field only exists if the provider is customsafe100 7 19 Express link Group expresslink PARAMETER VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable or disable express link state onlycheck onlyoffline checkonl...

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

Page 237: ...te authentication password authpwro string 8 128 7 6 Read only authentication password authtyperw MD5 SHA 6 6 Read write authentication type authtypero MD5 SHA 6 6 Read only authentication type encryptpwrw string 8 128 7 6 Read write passwrd encryptpwro string 8 128 7 6 Read only password encrypttyperw DES 6 6 Read write encryption type encrypttypero DES 6 6 Read only encryption type rwcommunity s...

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

Page 239: ... of window position Only available when capability_image_c 0 n 1 _privacymask _wintype rectangle win_i 0 m 1 _width 0 320 4 4 Width of privacy mask window Only available when capability_image_c 0 n 1 _privacymask _wintype rectangle win_i 0 m 1 _height 0 240 4 4 Height of privacy mask window Only available when capability_image_c 0 n 1 _privacymask _wintype rectangle win_i 0 m 1 _polygo n 0 320 0 2...

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

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

Page 242: ... capability_daynight_c 0 capability_nvideoi n 1 _externalir for external IR Not support this parameter anymore when the version number httpversion is equal or greater than 0301a npir 0 positive integer 0 7 Number of PIRs ndi 0 positive integer 0 7 Number of digital inputs nvi 0 positive integer 0 7 Number of virtual inputs manual trigger ndo 0 positive integer 0 7 Number of digital outputs naudioi...

Page 243: ...f recording We support this parameter when the version number httpversion is equal or greater than 0309a ptzenabled 0 positive integer 0 7 An 32 bit integer each bit can be set separately as follows Bit 0 Support camera control function 0 not support 1 support Bit 1 only available when bit0 is 1 Built in or external video source 0 external 1 built in Bit 2 only available when bit0 is 1 Support pan...

Page 244: ...value of this parameter is larger than 0 it means that the camera supports remotefocus function bit 0 Indicate whether to support both zoom and focus function bit 1 Only support zoom function bit 2 Only support focus function bit 3 Currently this is a reserved bit and the default value is 0 It s strongly non recommended to use this This is reserved for compatibility and will not be used after the ...

Page 245: ... 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 For most products the last stream of a channel will not support ePTZ It is reserved for full view of the channel For some dual stream products both streams support ePTZ nanystream 0 positive integer 0 7 number of a...

Page 246: ...otify Recording notification tampering Tamper detection vi Virtual input Manual trigger vadp VADP trigger di Digital input volalarm Audio detection temperature Temperature detection pir PIR detection visignal Video input signal loss backup Backing up recorded files smartsd Lifetime detection of SD card shockalarm Shock detection virestore Video input signal restore Only available when httpversion ...

Page 247: ...dicate whether to support CoS protocol_qos_dscp boolean 0 7 Indicate whether to support QoS DSCP protocol_ddns boolean 0 7 Indicate whether to support DDNS videoin_type 0 1 2 0 7 0 Interlaced CCD 1 Progressive CCD 2 CMOS videoin_nresolution positive integer 0 7 This equals capability_videoin_c0_nresolution This is kept for compatibility videoin_resolution A list of WxH product dependent 0 7 This e...

Page 248: ...ec 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 cancellation audio_aecmode auto manual 0 7 Indicate the acoustic echo cancellation control mode auto control by camera automatically manual Manu...

Page 249: ... not available Affect API name can be described in hierarchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL For example maxframerate fixed 15 which means the max frame rate is 15fps when acoustic e...

Page 250: ...linein Not support anymore boolean 0 7 Indicate whether to support external line input Not support this parameter anymore when the version number httpversion is equal or greater than 0301a It will be replaced by audio_intmic and audio_extmic audio_lineout boolean 0 7 Indicate whether to support line output audio_michardwareswitch boolean 0 7 Indicate whether the hardware supports built in external...

Page 251: ...image with pixels std A normalized 0 9999 range Not supported smartstream_support boolean 0 7 Indicate whether smart stream is supported smartstream_version integer 0 7 Number of smart stream version smartstream_nstream positive integer 0 7 Number of stream that support smart stream Only available when capability_smartstream_support is 1 smartstream_windomain qvga px std 0 7 The domain to set an f...

Page 252: ...nly available when capability_smartstream_support is 1 smartstream_nwindow_h ybrid_manual positive integer 0 7 Maximum number of tracking window of manual in hybrid mode Only available when capability_smartstream_support is 1 vadp_supportfeature positive integer 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 jp...

Page 253: ...s kept for compatibility uart_httptunnel boolean 0 7 Indicate whether to support HTTP tunnel for UART transfer transmission_mode Tx Rx Both 0 7 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_dualmode boolean 0 7 Indicate whether netwo...

Page 254: ...y available when capability_wireless_apmode_enable is 1 We support this parameter when the version number httpversion is 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 boolean 0 7 Indicate whether to support test...

Page 255: ...mage_ focusassist with capability_image_c0_ focusassist Reserved for compatibility and suggest don t use this since httpversion 0301a localstorage_manageable boolean 0 7 Indicate whether manageable local storage is supported Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 localstorage_seamless boolean 0 7 Indicate whether seamless recording is supported Only avai...

Page 256: ...remaining lifetime information 0 Non support this feature 1 Support this feature Only Sony SD card can support this function now Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 remotecamctrl_master 0 positive integer 0 7 Indicate whether to support remote auxiliary camera master side this value means supporting max number of auxiliary camera remotecamctrl_slave b...

Page 257: ...RAMETER VALUE SECURITY get set DESCRIPTION ptztunnel boolean 0 7 Indicate whether to support ptztunnel in this video input privilege boolean 0 7 Indicate whether to support Manage Privilege of PTZ control in the security page in this video input 1 support both cgi bin camctrl camctrl cgi and cgi bin viewer camctrl cgi 0 support only cgi bin viewer camctrl cgi rs485 boolean 0 7 An 32 bit integer ea...

Page 258: ...ear picture onetimeauto Camera will automatically adjust the focus position one time which follows any PTZ control spotlight Camera will automatically adjust the focus position full time and to consider a spotlight avoidance situation manual Turn off the automatically focus function For user to control the focus position manually as their purpose Only available when capability_camctrl_c 0 n 1 _zoo...

Page 259: ... 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 0 n 1 _buildinpt is 1 mintiltangle integer ...

Page 260: ...or 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 Group capability_daynight_c 0 n 1 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION support boolean 0 7 Indicate whether th...

Page 261: ...ble when capability_daynight_c 0 n 1 _support is 1 We support this parameter when the version number httpversion is equal or greater than 0302a ircutsensitivity_supportlevel 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 _ircutsensitivi ty_type is not We support t...

Page 262: ...ct dependent 0 7 The lens type of this channel fisheye Fisheye lens fixed Build in fixed focus lens varifocal Build in varifocal lens changeable changeable lens Like box type camera users can install any C Mount or CS Mount lens as they wish motor Lens with motor to support zoom focus etc N A Only available when httpversion 0301a rotation boolean 0 7 Indicate current mode whether support video rot...

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

Page 264: ...Bit 0 Support MPEG4 Bit 1 Support MJPEG Bit 2 Support H 264 Bit 3 Support H 265 mode 0 positive integer 0 7 Indicate current video mode nmode positive integer 0 7 Indicate how many video modes supported by this channel maxsize WxH 0 7 The maximum resolution of all modes in this channel the unit is pixel nprivacymask 0 positive integer 0 7 Number of privacy mask per channel nresolution positive int...

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

Page 266: ...lement number is defined as nresolution in this group This parameter may be changed when videoin_c n _cmosfreq 50 or videoin_c n _modulation pal Ex 30 fps is changed to 25 fps 60 fps is changed to 50 fps and so on Only available when h264 is listed in capability_videoin_codec h264_maxbitrate positive integer 0 7 Maximum bitrates of H 264 The unit is bps Only available when h264 is listed in capabi...

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

Page 268: ...161 H CU8162 H CU8163 H CU8361 H product dependent 0 7 A camera unit name of a split type camera system which the camera unit and the video core are separated If the camera is not a split type camera system the value of this parameter is We support this parameter when the version number httpversion is equal or greater than 0302b cmosfreq_support boolean 0 7 0 The power line frequency 50 60Hz is de...

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

Page 270: ... 2nd group for 2nd channel nvideoin 3 bit 0 9 are the 1st group for 1st channel bit 10 19 are the 2nd group for 2nd channel bit 20 31 are the 3rd group for 3rd channel Then the 1st bit of the group indicates 1st stream of a channel support ePTZ or not The 2nd bit of the group indicates 2nd stream of a channel support ePTZ or not and so on We support this parameter when the version number httpversi...

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

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

Page 273: ...s not support One to one mapping to the resolution in resolution The element number is defined as nresolution in this group This parameter records the frame rate when videoin_c 0 n 1 _cmosfreq 60 or videoin_c 0 n 1 _modulation ntsc Only available when h265 is listed in capability_videoin_codec description string 128 0 7 Description about this mode Group capability_image_c 0 n 1 n denotes the value...

Page 274: ...DR Pro and the scecond number indicate the support strength level of WDR Pro II wdrpro_affect exposurewin mode fixed au to exposurewin mode blc disab led aespeed disabled exposurelevel hidden exposurelevel fixed x exposurelevel fixed x x exposurelevel ranged x x exposuremode fixed auto x nonnegative integer product dependent 0 7 When WDR Pro is enabled some features may become malfunction or be fo...

Page 275: ... is affected When wdrpro 0 this value must be wdrpro_description string 0 7 Description about WDR Pro mode Only available when capability_image_c 0 n 1 _wdrp ro_mode 0 wdrc_mode 0 1 0 7 0 Non support WDR Enhanced 1 Support WDR Enhanced wdrc_supportlevel 0 positive integer 0 7 Indicate the support strength level of WDR Enhanced wdrc_affect exposurewin mode fixed au to exposurewin mode blc disab led...

Page 276: ...rchy such as exposurewin mode blc disabled which means blc exposure window is disabled API name can be one word as well such as exposurelevel fixed 6 which means exposurelevel is fixed to level 6 Description can be a nonnegative integer or string or NULL For example exposurelevel fixed 6 8 12 which means exposurelevel is fixed to level 6 level 8 and level 12 means no feature is affected When wdrc ...

Page 277: ...s dis 0 7 Indicate the image stabilizer mode eis electronic image stabilizer dis digital image stabilizer not support We support this parameter when the version number httpversion is equal or greater than 0302a is_strength boolean 0 7 0 Non support tuning strength of image stabilizer mode 1 Support tuning strength of image stabilizer mode Only available when capability_image_c 0 n 1 _is_m ode is n...

Page 278: ...ame 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 desc...

Page 279: ... scenemode_support is 1 scenemode_visibility_affe ct product dependent minexposure hidden mingain hidden wdrpro unchanged 3dnr unchanged or others x nonnegative integer 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 int...

Page 280: ...1 _ scenemode_support is 1 scenemode_noiseless_aff ect product dependent minexposure hidden mingain hidden wdrpro unchanged 3dnr unchanged or others x nonnegative integer 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 i...

Page 281: ...emode_supporttype and capability_image_c 0 n 1 _ scenemode_support is 1 scenemode_lpcparkinglot _affect product dependent minexposure hidden mingain hidden wdrpro unchanged 3dnr unchanged or others x nonnegative integer 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 na...

Page 282: ...sted in capability_image_c 0 n 1 _ scenemode_supporttype and capability_image_c 0 n 1 _ scenemode_support is 1 scenemode_lpcstreet_aff ect product dependent minexposure hidden mingain hidden wdrpro unchanged 3dnr unchanged or others x nonnegative integer 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 li...

Page 283: ...el is fixed to level 6 Description can be a nonnegative integer or sting or NULL means no feature is affected Only available when visibility is listed in capability_image_c 0 n 1 _ scenemode_supporttype and capability_image_c 0 n 1 _ scenemode_support is 1 wbmode auto manual rbgain widerange outdoor indoor sodiumauto product dependent 0 7 Available white balance mode means white balance is not sup...

Page 284: ...rt this parameter when the version number httpversion is equal or greater than 0302a exposure_rangetype onevalue twovalues 0 7 Support interface of exposure range onevalue The parameter is a constant value twovalues Need two parameters to indicate the exposure range Only available when capability_image_c 0 n 1 _ exposure_mode is 1 We support this parameter when the version number httpversion is eq...

Page 285: ... support Only available when capability_image_c 0 n 1 _ exposure_mode is 1 and capability_image_c 0 n 1 _expo sure_rangetype is onevalue We support this parameter when the version number httpversion is equal or greater than 0302a exposure_automode_affe ct exposurewin mode blc hidd en defog disabled wdrpro disabled exposurelevel hidden or others x nonnegative integer product dependent 0 7 When expo...

Page 286: ...is fixed to level 6 Description can be a nonnegative integer or string or NULL means no feature is affected Only available when auto 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_shutterpriority mode_affect exposurewin mode blc hidd en ...

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

Page 288: ... 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 exposure window is disabled API name can be one word as wel...

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

Page 290: ...hidden or others x nonnegative integer product dependent 0 7 When exposure manual 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 291: ...port this parameter when the version number httpversion is equal or greater than 0302a exposure_levelrange 0 12 0 7 Available range for videoin_c 0 n 1 _exposurelevel When exposure_mode 0 this value must be set to Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_winmode auto custom blc hlc product dependent 0 7 Available options for exposurewin_c 0 n 1 _mode means group e...

Page 292: ...ategorized 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 described in hierarchy such as exposurewin...

Page 293: ...a of exposure control exclusive 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 c...

Page 294: ...hen capability_image_c 0 n 1 _ exposure_mode is 1 We support this parameter when the version number httpversion is equal or greater than 0301a exposure_maxrange 1 32000 1 8000 or others product dependent 0 7 Available range for videoin_c n _maxexposure 1 32000 1s 1 32000s 1 8000 1s 1 8000s etc means maximum exposure time is not available When exposure_mode 0 this value must be set to Only availabl...

Page 295: ...alized 0 9999 range Not supported privacymask_ncolor Positive Integer 0 7 Available total color numbers of privacy mask agc_maxgain 0 100 0 7 Available range for videoin_c n _maxgain 0 100 0 100 percent means videoin_c n _maxgain is not available agc_mingain 0 100 0 7 Available range for videoin_c n _mingain 0 100 0 100 percent means videoin_c n _mingain is not available flickerless 0 1 0 7 0 Non ...

Page 296: ...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 flickerless 0 this value must be defog_mode 0 1 0 7 0 No...

Page 297: ...to 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 described in hierarchy such as exposurewin mode blc dis...

Page 298: ...1 0 7 0 Non support tuning Gamma curve 1 Support tuning Gamma curve lowlightmode 0 1 0 7 Internal parameter must not open to user 0 Non support low light mode 1 Support low light mode focusassist 0 1 0 7 0 Non support focus assist 1 Support focus assist remotefocus 0 positive integer 0 7 An 4 bit integer which indicates the supportive application of remotefocus in this channel If the value of this...

Page 299: ...upport image freeze feature 1 Support image freeze feature We support this parameter when the version number httpversion is equal or greater than 0302a autotrack_support boolean 0 7 0 Non support auto tracking feature 1 Support auto tracking feature We support this parameter when the version number httpversion is equal or greater than 0302a smartsensor_iristotalrang e A list of iris value 0 7 Avai...

Page 300: ...ent Only available when capability_image_c 0 n 1 _lens_ alignment is 1 Group capability_peripheral_c 0 n 1 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION devicecontrol boolean 0 7 Indicate whether to support the peripheral device control We support this parameter when the version number httpversion is equal or greater than 0305c 7 28 Customized event script...

Page 301: ...endent 6 6 Indicate the trigger condition boot System boot di Digital input pir PIR detection motion Video motion detection seq Periodic condition visignal Video input signal loss recnotify Recording notification tampering Tamper detection vi Virtual input Manual trigger volalarm Audio detection smartsd Lifetime detection of SD card shockalarm Shock detection virestore Video input signal restore t...

Page 302: ...is field is required when trigger condition is vi One bit represents one digital input The LSB indicates VI 0 vadp product dependent 0 positive integer 6 6 Indicate the source id of vadp event notification Each bit corresponds to one vadp source and the LSB indicates source id 0 For example to detect event from any one of source id 0 1 and 3 set vadp to 11 Only available when vadp is listed in cap...

Page 303: ...gger digital output Only available when capability_ndo 0 action_do_i 0 ndo 1 _ duration 1 999 6 6 Duration of the digital output trigger in seconds Only available when capability_ndo 0 action_cf_enable Boolean 6 6 Enable or disable sending media to SD card Only available when capability_supportsd 0 action_cf_folder string 128 6 6 Path to store media Only available when capability_supportsd 0 actio...

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

Page 305: ...rt 0 65535 6 6 Port to connect to the server ftp_location string 128 6 6 Location to upload or store the media ftp_passive boolean 6 6 Enable or disable passive mode 0 disable passive mode 1 enable passive mode email_address string 128 6 6 Email server address email_sslmode boolean 6 6 Enable support SSL email_port 0 65535 6 6 Port to connect to the server email_username string 64 6 6 Username to ...

Page 306: ...Snapshot2_ media_i2 Snapshot3_ media_i3 Snapshot4_ media_i4 Snapshot5_ snapshot_datesuffix 0 1 6 6 Add date and time suffix to filename 1 Add date and time suffix 0 Do not add snapshot_preevent 0 capability_media_snapshot_maxpr eevent 6 6 Indicates the number of pre event images snapshot_postevent 0 capability_media_snapshot_maxpo stevent 6 6 Indicates the number of post event images videoclip_sou...

Page 307: ... of network connection enable boolean 6 6 Enable or disable this recording priority 0 1 2 6 6 Indicate the priority of this recording 0 indicates low priority 1 indicates normal priority 2 indicates high priority source 0 capability_nmediastream 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 ...

Page 308: ...server_i4 as notification servers the notifyserver value is 21 weekday 0 127 6 6 Indicate which weekday is scheduled One bit represents one weekday bit0 LSB Saturday bit1 Friday bit2 Thursday bit3 Wednesday bit4 Tuesday bit5 Monday bit6 Sunday For example to detect events on Friday and Sunday set weekday as 66 begintime hh mm 6 6 Start time of the weekly schedule endtime hh mm 6 6 End time of the ...

Page 309: ...ondition is reached recording file is truncated maxduration 60 3600 6 6 Unit Second When this condition is reached recording file is truncated adaptive_enable boolean 6 6 Indicate whether the adaptive recording is enabled adaptive_preevent 0 9 6 6 Indicate when is the adaptive recording started before the event trigger point seconds adaptive_postevent 0 10 6 6 Indicate when is the adaptive recordi...

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

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

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

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

Page 314: ...lable when capability_fisheye is 1 1 7 Tilt speed It should be set by eCamCtrl cgi rather than by setparam cgi panspeed 5 5 1 4 Pan speed Only available when capability_fisheye is 1 1 7 Pan speed It should be set by eCamCtrl cgi rather than by setparam cgi zoomspeed 5 5 1 4 Zoom speed Only available when capability_fisheye is 1 1 7 Zoom speed It should be set by eCamCtrl cgi rather than by setpara...

Page 315: ... is 1 1 7 Left top corner coordinate of the preset It should be set by ePreset cgi rather than by setparam cgi preset_i 0 19 _size WxH product dependent 1 4 Width and height of the preset Only available when capability_fisheye is 1 1 7 Width and height of the preset It should be set by ePreset cgi rather than by setparam cgi 7 37 Focus Window setting Group focuswindow_c 0 n 1 for n channel product...

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

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

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

Page 319: ...us speed patrolseq string 120 1 4 For external device The indexes of patrol points separated by patroldwelling string 160 1 4 For external device The dwelling time of each patrol point separated by preset_i 0 k 1 _name string 40 1 4 Name of the preset location preset_i 0 k 1 _ dwelling 0 999 1 4 The dwelling time of each preset location uart 0 capability_nuart 1 1 4 Select corresponding uart capab...

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

Page 321: ... k 1 _name We support this parameter when the version number httpversion is equal or greater than 0305b patrolseq string 120 1 4 For external device The indexes of patrol points separated by patroldwelling string 160 1 4 For external device The dwelling time of each patrol point separated by disablemdonptz boolean 1 4 Disable motion detection on PTZ operation defaulthome boolean 1 4 This field tel...

Page 322: ...reset 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 1 255 1 4 Camera ID controlling external PTZ camera Note Please set your speed dome to the appropriate baud rate and Camera ID e g 2400bps camera ID 1 2 3 etc All Camera IDs on the same controlling system NVR or rs485 keyboard have to be distinct Ther...

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

Page 324: ...idle idleaction_interval 1 999 1 4 While idle over this time interval idle action will be taken zoomenhance boolean 1 4 Enable disable zoom enhancement tour_index 1 0 19 1 4 Index of the enabled tour group from 0 to 19 Set 1 to disable all the tour groups tour_i 0 19 _name string 40 1 4 Name of the tour tour_i 0 19 _type boolean 1 4 0 Recorded tour 1 Preset tour tour_i 0 19 _speed 5 5 1 4 Preset t...

Page 325: ...127 _location string 128 1 4 Full path of the PTZ driver enablehttptunnel boolean 1 4 Enable HTTP tunnel channel to control UART Group uart_i 0 n 1 n is uart port count capability nuart 0 and capability fisheye 0 NAME VALUE SECURITY get set DESCRIPTION baudrate 300 600 1200 2400 4800 9600 19200 38400 57600 11520 0 4 4 Set baud rate of COM port databit 5 6 7 8 4 4 Data bits in a character frame par...

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

Page 327: ...cted string 6 7 Current selected lens profile e g lens_selected lens_default_i0 it means choosen lens configuration is i0 lens of default group Group lens_default NAME VALUE SECURITY get set DESCRIPTION totalnumbers 0 positive integer 6 7 Totoal support number of the default lens profiles Group lens_user NAME VALUE SECURITY get set DESCRIPTION totalnumbers 0 positive integer 6 7 Totoal support num...

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

Page 329: ...support 0 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION objsize_type 1 2 1 4 Type of object size 1 customized width and height 0 object size 30 x 30 1 object size 10 x 20 2 object size 10 x 10 objsize_customized_width 10 320 1 4 The minimum width of tracking target objsize_customized_height 10 240 1 4 The minimum height of tracking target sensitivity 0 2 1...

Page 330: ...dhoc encrypt none wep wpa wpa2 6 6 Encryption method none NONE wep WEP wpa WPA wpa2 WPA2PSK authmode OPEN SHARED 6 6 Authentication mode Only valid when wireless_encrypt is wep keylength 64 128 6 6 Key length in bits Only valid when wireless_encrypt is wep keyformat HEX ASCII 6 6 Key1 key4 presentation format Only valid when wireless_encrypt is wep keyselect 1 4 6 6 Default key number Only valid w...

Page 331: ...6 6 WPA WPA2PSK mode pre shared key Only valid when wireless_encrypt is wpa or wpa2 7 51 Shock detection Group shock_c 0 n 1 for n channel products n denotes the value of capability_nvideoin capability_shockalarm_support 0 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...

Page 332: ...e cgi bin dido setdo cgi do1 state do2 state do3 state do4 state Where state is 0 or 1 0 means inactive or normal state while 1 means active or triggered state PARAMETER VALUE DESCRIPTION do num 0 1 0 Inactive normal state 1 Active triggered state Example Drive the digital output 1 to triggered state and redirect to an empty page http myserver cgi bin dido setdo cgi do1 1 ...

Page 333: ...er is specified all of the digital input 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 di0 state r n di1 state r n di2 state r n di3 state r n where state can be 0 or 1 Example Query the status of digital input 1 Request http myserver cgi bin dido getdi cgi di1 Response HTTP 1 0 200 OK r n Content Type text plain r n Content Length 7...

Page 334: ...ter is specified all the digital output statuses will be returned Return HTTP 1 0 200 OK r n Content Type text plain r n Content Length length r n r n do0 state r n do1 state r n do2 state r n do3 state r n where state can be 0 or 1 Example Query the status of digital output 1 Request http myserver cgi bin dido getdo cgi do1 Response HTTP 1 0 200 OK r n Content Type text plain r n Content Length 7...

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

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

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

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

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

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

Page 341: ... PARAMETER VALUE DESCRIPTION channel 0 n 1 Channel of the video source stream 0 m 1 Stream recall Text string less than 40 characters One of the present positions to recall return return page Redirect to the page return page after the parameter is assigned The return page should be the relative path according to the root of camera If you omit this parameter it will redirect to an empty page If the...

Page 342: ...nel 0 n 1 Channel of the video source stream 0 m 1 Stream addpos Text string less than 40 characters Add one preset location to the preset list delpos Text string less than 40 characters Delete preset location from the 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 om...

Page 343: ...dv4 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 access list ip IP address Single address IP address Network address IP address network mask Range address start IP address end IP address index value The start position to add or to delete return return page Redirect to the page return page after t...

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

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

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

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

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

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

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

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

Page 352: ...AMETER VALUE DEFAULT DESCRIPTION maxsft positive integer 0 Request cached stream at most how many seconds ago tsmode normal adaptive normal Streaming mode normal Full FPS all the time adaptive Default send only I frame for MP4 and H 264 and send 1 FPS for MJPEG If DI or motion window are triggered the streaming is changed to send full FPS for 10 seconds Note this parameter also works on non timesh...

Page 353: ...e Description 400 Bad Request Request is rejected because some parameter values are illegal 415 Unsupported Media Type Returned if forcechk appears when minsft is not achievable or the timeshift feature of the target stream is not enabled ...

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

Page 355: ...nd point of effective focal length remote_focus_zoom_motor Current position of zoom motor remote_focus_focus_motor Current position of focus motor remote_focus_zoom_enable Current function of zoom motor remote_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 s...

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

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

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

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

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

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

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

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

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

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

Page 366: ...value speedtilt value speedzoom value speedapp value speedlink val ue Set speeds return return page Example http myserver cgi bin camctrl camctrl cgi channel 0 camid 1 move right http myserver cgi bin camctrl camctrl cgi channel 0 camid 1 zoom tele http myserver cgi bin camctrl camctrl cgi channel 0 camid 1 x 300 y 200 resolution 704x480 videosi ze 704x480 strech 1 Example set the ptz preset with ...

Page 367: ...rol vy integer vs 0 127 Set the speed of movement 0 means stop x integer x coordinate clicked by user It will be the x coordinate of center after movement y integer y coordinate clicked by user It will be the y coordinate of center after movement videosize window size The size of plug in ActiveX window in web page resolution window size The resolution of streaming stretch boolean 0 indicates that ...

Page 368: ... servername cgi bin camctrl camctrl cgi parameter parameter Example http myserver cgi bin camctrl camctrl cgi getpan Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n pan 4117 r n PARAMETER VALUE DESCRIPTION getversion string Get the version of the PTZ control module getaction idle autopan tracking tour patrol Get the current status of the camera We support this param...

Page 369: ...eger Get the upper limit for pan position Only available when bit0 of capability_camctrl_c 0 n 1 _buildinpt is 1 getminpanangle integer Get the lower limit for pan angle Only available when bit0 of capability_camctrl_c 0 n 1 _buildinpt is 1 getmaxpanangle integer Get the upper limit for pan angle Only available when bit0 of capability_camctrl_c 0 n 1 _buildinpt is 1 getmintilt 0 positive integer G...

Page 370: ...t for focus position 8 29 Recall capability_camctrl_c 0 n 1 _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 return return page Redirect to ...

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

Page 372: ...It means the accumulated percentage amount of flash block has been written The range is from 0 to 100 unit The SD card is recommended to be replaced if the percentage reaches above 90 smartsd_spare_block_rate Usage rate of spare blocks It means the usage percentage of total spare block The range is from 0 to 100 unit The SD card is recommended to be replaced if the percentage reaches above 90 smar...

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

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

Page 375: ...er cgi bin admin peripheral cgi channel 0 operation set washer_mode wiper washer_status on Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n washer_mode OK r n washer_status FAIL r n PARAMETER VALUE DESCRIPTION channel 0 capability_nvideoin 1 Channel of the video source washer_mode wiper Apply the wiper to the mode of washer control system Only available when capabili...

Page 376: ...ent Only available when capability_peripheral_c 0 n 1 _heater_suppo rt 1 trigger heater component is work in force heater once Only available when capability_peripheral_c 0 n 1 _heater_suppo rt 1 Syntax for querying 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 was...

Page 377: ...c 0 n 1 _washer_mod e washer_status N A Get the current status of washer control module The status is off as default which means the washer is stopped and the status on means the washer is running Only available when capability_peripheral_c 0 n 1 _washer_supp ort 1 washer_dwelltime N A Get the current washer clean period of washer control system Only available when capability_peripheral_c 0 n 1 _w...

Page 378: ...nel of the video source function getstatus onetimeauto onetimeauto Camera will automatically adjust the IR zone one time only getstatus Information of optimized IR control status and return value as below optimizedir_c 0 n 1 _irmode Indicate the IR current mode available value is auto and manual mode optimizedir_c 0 n 1 _irnum The number of IR that camera supports optimizedir_c 0 n 1 _irstrength O...

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

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

Page 381: ...de 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 Channel of the video source support_irmode N A List all adjustment mode that IR supports irmode N A Get the current IR control mode irnum N A Get the number of IR that camera supports Example http myserver cgi bin admin optimizedir cgi ...

Page 382: ...ontrol gain backlight compensation privacy masks Scheduled profile settings video rotation 3DNR DIS HLC Audio Audio Capability Two way audio Compression G 711 G 726 Interface Built in Mic External Mic input External line output Effective Range 5 meters Network Users Live viewing for up to 10 clients Protocols IPv4 IPv6 TCP IP HTTP HTTPS UPnP RTSP RTP RTCP IGMP CIFS SMB SMTP FTP DHCP NTP DNS DDNS P...

Page 383: ...tek com Operating Temperature Starting Temperature 0 C 50 C 32 F 122 F Working Temperature 10 C 50 C 14 F 122 F Humidity 90 Warranty 24 months System Requirements Operating System Microsoft Windows 8 7 Web Browser Mozilla Firefox 7 43 streaming only Internet Explorer 10 11 Other Players VLC 1 1 11 or above Quicktime 7 or above Included Accessories Others Quick installation guide warranty card scre...

Page 384: ...light compensation privacy masks Scheduled profile settings video rotation 3DNR DIS HLC Audio Audio Capability Two way audio Compression G 711 G 726 Interface Built in Mic External Mic input External line output Effective Range 5 meters Network Users Live viewing for up to 10 clients Protocols IPv4 IPv6 TCP IP HTTP HTTPS UPnP RTSP RTP RTCP IGMP CIFS SMB SMTP FTP DHCP NTP DNS DDNS PPPoE CoS QoS SNM...

Page 385: ...F Working Temperature 30 C 50 C 22 F 122 F FD9367 EHTV Starting Temperature 40 C 50 C 40 F 122 F Working Temperature 50 C 50 C 58 F 122 F Humidity 90 Warranty 36 months System Requirements Operating System Microsoft Windows 8 7 Web Browser Mozilla Firefox 7 43 streaming only Internet Explorer 10 11 Other Players VLC 1 1 11 or above Quicktime 7 or above Included Accessories Others Quick installatio...

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

Search results

Summary of Contents for FD9167-H

Reviews:

Related manuals for FD9167-H

Brands by name

Popular brands

Vivotek FD9167-H, User Manual

Search results

Summary of Contents for FD9167-H

Reviews:

Related manuals for FD9167-H

Brands by name

Popular brands