Vivotek SUPREME IP9191-HP User Manual Download Page 367

Page: 367 / 369

VIVOTEK

User's Manual - 367

Technical Specifications

Model

IP9191-HP

System Information

CPU

Multimedia SoC (System-on-Chip)

Flash

128MB

RAM

1GB

Camera Features

Image Sensor

1/2" Progressive CMOS

Maximum Resolution

3840x2160

Lens Type

Vari-focal, Remote Back Focus

Focal Length

f = 3.9 ~ 10 mm

Aperture

F1.5 ~ F2.7

Auto-iris

P-iris (DC-iris reserved)

Field of View

45° ~ 119° (Horizontal)

25° ~ 63° (Vertical)

52° ~ 142° (Diagonal)

Shutter Time

1/5 sec. to 1/32,000 sec.

WDR Technology

WDR Pro

Day/Night

Removable IR-cut filter for day & night

function

Minimum Illumination

0.02 Lux @ F1.5 (Color)

0.01 Lux @ F1.5 (B/W)

Pan/Tilt/Zoom

Functionalities

ePTZ:48x digital zoom

(4x on IE plug-in, 12x built in)

On-board Storage

Slot type: MicroSD/SDHC/SDXC card slot

Seamless Recording

Video

Compression

H.265, H.264, MJPEG

Maximum Frame Rate

30 fps @ 3840x2160 (WDR Pro on)

120 fps @ 1920x1080 (WDR Pro off)

Maximum Streams

3 simultaneous streams

S/N Ratio

60.5 dB

Dynamic Range

100 dB

Video Streaming

Adjustable resolution, quality and constant

bit rate control, Smart Stream III

Image Settings

Time stamp, text overlay, flip & mirror;

Configurable brightness, contrast,

saturation, sharpness, white balance,

exposure control, gain, backlight

compensation, privacy masks; Scheduled

profile settings, video rotation, AE speed,

3DNR, DIS, HLC

Audio

Audio Capability

Two-way audio

Compression

G.711, G.726

Interface

External Mic input

External line output

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, SNMP,

802.1X, UDP, ICMP, ARP, SSL/ TLS, NTCIP

Interface

10 Base-T/100 Base-TX Ethernet /1000 Base-T

(RJ-45)

*It is highly recommended to use standard

CAT5e & CAT6 cables which are compliant

with the 3P/ETL standard.

ONVIF

Supported, specification available at

www.onvif.org

Intelligent Video

Video Motion Detection

Five-window video motion detection

Alarm and Event

Alarm Triggers

Motion detection,manual trigger, digital

input, periodical trigger, system boot,

recording notification, camera tampering

detection, audio detection, advanced

motion detection, MicroSD card life

expectancy

Alarm Events

Event notification using digital output, HTTP,

SMTP, FTP, NAS server and MicroSD card

File upload via HTTP, SMTP, FTP, NAS server

and MicroSD card

General

Connectors

RJ-45 cable connector for Network

10/100/1000 Mbps PoE connection *1

Audio input *1

Audio output *1

AC/DC 24V power input *1

Digital input *2

Digital output *2

RS-485 *1

LED Indicator

System power and status indicator

Power Input

AC 24V, DC 12V, IEEE 802.3af PoE Class 0

Power Consumption

Max. 12 W

Dimensions

151 x 70 x 61 mm (w/o lens)

209 x 70 x 61 mm (w/ lens)

Weight

671 g (w/o lens)

743 g (w/ lens)

Safety Certifications

CE, LVD, FCC Class B, VCCI, C-Tick, UL

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

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

Technical Specifications

Compatible Accessories

6F, No.192, Lien-Cheng Rd., Chung-Ho, New Taipei City, 235, Taiwan, R.O.C. | T: +886-2-82455282 | F: +886-2-82455532 | E: [email protected] | W: www.vivotek.com

Others

Quick installation guide, warranty card,

lens, camera stand, screw pack

Dimensions

70 mm

• w/o lens

• w/ lens

151 mm

70 mm

209 mm

Enclosures

Lens

AE-23E

AL-248

Outdoor Enclosures, PoE Input, IP68, IK10

12 ~ 50mm, F1.8, P-iris

Summary of Contents for SUPREME IP9191-HP

Page 1: ...User s Manual IP9191 HT Box Network Camera 8MP P iris H 265 WDR Pro II Manual or Remote Back Focus SNV 3DNR IP9191 HP Rev 1 0 ...

Page 2: ...ut 39 System Logs 42 System Parameters 44 System Maintenance 45 Media Image 49 Media Video 64 Media Audio 74 Network General settings 76 Network Streaming protocols 83 Network SNMP Simple Network Management Protocol 94 Network FTP 95 Security User accounts 96 Security HTTPS Hypertext Transfer Protocol over SSL 98 Security Access List 105 PTZ PTZ settings 110 PTZ 113 Mechanical PTZ Operation 113 Ev...

Page 3: ...th and storage levels to a minimum VIVOTEK s self developed algorithm brings video compression into the next level and reduces the 4K image compression size to even smaller than a 2 Megapixel image size The IP9191 HP IP9191 HT also employs VIVOTEK s SNV and WDR Pro technologies which allows the camera to capture the highest quality images in both low light and high contrast environments Furthermor...

Page 4: ...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 customizing existing homepages or integrating with the current web server Package Contents I...

Page 5: ...I O Terminal Block Audio Out Status LED MicroSD Card Slot Audio In Rear Panel Ground screw IMPORTANT If DC power is preferred it should comply with O P 12VDC 1A min L P S per IEC 60950 1 Si l alimentation CC est préférable elle devrait être conforme avec ce qui suit Sortie 12 VCC 1 A min alimentation limitée à conformité CEI 60950 1 ...

Page 6: ...tallation 2 Install the lens module to the camera Lens installation is not necessary for IP9191 HT 3 Connect the iris control cable to the socket on the camera 1 Jot down the camera s MAC address for later reference 0002D10766AD XXXXXX 1 ...

Page 7: ...ur camera please notice the specifications as below The screw mount distance A C must be shorter than 5 2mm in case that the bottom of screw mount may hit the IR Cut Filter 4 Install the camera stand to camera 5 Connect an Ethernet cable to the camera A C ...

Page 8: ...can provide a 5V output and the max load is 50mA 64GB 10 I 1 12345678910 1 AC DC PW 12V or 24V 2 AC DC PW 3 RS485 4 RS485 5 DI common GND for all DIs 6 DI2 7 DI1 8 DO2 9 DO1 10 DO 5V Pin 1 is on the left Connect a ground wire to a grounded earth rod with a resistance smaller than 4Ω with a section area larger than 25mm2 to a ground rod 1 5 meters into the ground Note that the ground wire is user s...

Page 9: ...with Protected Earth AC PE PE DC 0V 1 The DO pin provides 5V output voltage and the max load is 50mA 2 The max voltage for DO pins is 30VDC External power In order to control AC devices the above diagram can be taken in consideration The diagram uses a relay to control the ON OFF condition of the AC device 3 An external relay can be triggered by using DO or by an external power source depending on...

Page 10: ...h 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 Browser LAN Shepherd 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 11: ...just the image zoom and focus using the Zoom and Focus pullers on the lens module T W N IP9191 HP IP9191 HT For cameras that come with an automated motor lens enter the Configuration Media Focus page to zoom in if the need arises and tune for the best focus ...

Page 12: ...ed to network 3 Green LED blinks every 1 sec and RED LED blinks consecutively every 0 15 sec Upgrading firmware 4 Green and RED blink every 0 15 sec Green and RED light on then blink again Restoring defaults 5 RED LED is on Green LED blinks and RED LED is constantly on Status after a reset network connected Green and RED LEDs are constantly on Status after a reset network disconnected You can purc...

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

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

Page 15: ... 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 10 2 Enter the combination of alphabetic and numeric characters to fulfill the password strength requirement The default name for the camera administrator is root and can not be changed ...

Page 16: ... LED rapidly blinks Note that all settings will be restored to factory default Upon successful restore the status LED will blink green and red during normal operation MicroSD SDHC SDXC Card Capacity This network camera is compliant with SD SDHC SDXC 16GB 8GB 32GB 64GB and other preceding standard SD cards Reset Button Network Deployment General Connection PoE When using a PoE enabled switch The Ne...

Page 17: ... 1 LAN Local Area Network Router IP address 192 168 0 1 WAN Wide Area Network Router IP address from ISP Cable or DSL Modem POWE R COLLIS ION LINK R E CE IVE PAR TITION 1 2 3 4 5 Internet When using a non PoE switch Use a PoE power injector optional to connect between the Network Camera and a non PoE switch PoE Power Injector optional NOTE 1 The camera is only to be connected to PoE networks witho...

Page 18: ...is case if the Local Area Network LAN IP address of your Network Camera is 192 168 0 3 please 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...

Page 19: ...ration options such as that of streaming ports please refer to Configuration Network Settings VIVOTEK also provides the automatic port forwarding feature as an NAT traversal function with the precondition that your router must sup port the UPnP port forwarding feature ...

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

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

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

Page 23: ...y 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 C...

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

Page 26: ...multaneous monitoring and video recording for multiple Network Cameras Please install the recording software then launch the program to add the Network Camera to the Channel list For detailed information about how to use the recording software please refer to the user s manual of the software or download it from http www vivotek com ...

Page 27: ...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 64 for detailed information Manual Trigger Click to enable disable an event trigger manually Please configure an event setting on the Application page before you enable this function A total of 3 event configuration can be configured For more ...

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

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

Page 30: ...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 33 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 31: ... 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 32: ...ch unicast client connecting to the server takes up additional bandwidth and the Network Camera allows up to ten simultaneous accesses UDP multicast This protocol allows multicast enabled routers to forward network packets to all clients requesting streaming media This helps to reduce the network transmission load of the Network Camera while serving multiple clients at the same time Note that to u...

Page 33: ...o append the date and time to the end of the file name Local Streaming Buffer Time Due to the unsteady bandwidth flow the live streaming may lag and 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 seconds before being played on the live viewing window This will help you see the streaming more smoothly If you enter 3 0...

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

Page 35: ... 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 36: ... 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 37: ...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 38: ...e default time servers The precondition is that the camera must have the access to the Internet Update interval Select to update the time using the NTP server on an hourly daily weekly or monthly basis Time zone Select the appropriate time zone from the list If you want to upload Daylight Savings Time rules please refer to System Maintenance Import Export files on page 46 for details System Genera...

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

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

Page 43: ...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 44: ... 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 45: ...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 46: ... 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 47: ...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 48: ...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 49: ...ve viewing window and the maximum zoom in will be up to 4 times Position of timestamp and video title on image Select to display time stamp and video title on the top or at the bottom of the video stream Timestamp and video title font size Select the font size for the time stamp and title Video font ttf You can select a True Type font file for the display of textual messages on video Color Select ...

Page 50: ...ous 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 vert...

Page 51: ...t thus helping to improve low light sensitivity Synchronize with digital input The Network Camera automatically removes the IR cut filter when a Digital Input is triggerred For example the digital input can come from a housing that is equipped with IR illumination and control circuits such as VIVOTEK s AM 214 Schedule mode The Network Camera switches between day mode and night mode based on a spec...

Page 52: ...configuration Smart IR disabled distance 5M Smart IR enabled distance 5M Smart IR disabled distance 3M Smart IR enabled distance 3M The Smart IR function is more beneficial when the spot of intrusions or an object of your interest is close to the lens and the IR lights For example if an intruder has a chance of getting near the range of 3 meters Smart IR can effectively reduce the over exposure Fo...

Page 53: ...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 56 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 54: ...ent Brightness Adjust the image brightness level which ranges from 0 to 100 Contrast Adjust the image contrast level which ranges from 0 to 100 Saturation Adjust the image saturation level which ranges from 0 to 100 Sharpness Adjust the image sharpness level which ranges from 0 to 100 Gamma curve This option is disabled when the WDR function is enabled Adjust the image sharpness level which ranges...

Page 55: ...duction Enable noise reduction Check to enable noise reduction in order to reduce noises and flickers in image This applies to the onboard 3D Noise Reduction feature Use the pull down menu to adjust the reduction strength Note that applying this function to the video channel will consume system computing power 3D Noise Reduction is mostly applied in low light conditions When enabled in a low light...

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

Page 57: ...ou may prefer a shorter shutter time to better capture moving objects while a faster shutter reduces light and needs to be compensated by electrical brightness gains The inclusive window refers to the weighted window the exclusive window refers to ignored window It adopts the weighed averages method to calculate the value The inclusive windows have a higher priority You can overlap these windows a...

Page 58: ...Save to enable the settings If you want to configure another sensor setting for day night schedule mode please click Profile mode to open the Profile of exposure settings page as shown below Activated period Select the mode this profile to apply to Night mode or the Schedule mode Please manually enter a range of time if you select the Schedule mode Then check the Save button for the configuration ...

Page 59: ...umns Please refer to previous dicussions for detailed information 4 Click Save to enable the setting and click Close to exit the page Lens configuration If you apply a different lens to the camera you can upload a different configuration file containing an image library for the specific lens module without updating the entire firmware Please contact VIVOTEK s technical support for the supported Le...

Page 60: ...us function can be very helpful when these cameras become out of focus after days or weeks of operation And that can easily result from the effects of natural forces e g shrink and expand due to a wide range of operating temperatures and the vibration caused by wind Focus window x If the need arises use the Zoom tab to zoom in on the scene Use the Media Image Focus function to tune for a best imag...

Page 61: ...TEK User s Manual 61 If using an iCS lens model use the auto focus function for an optimal image The configuration page automaticallly displays different options according to the lens you installed iCS lens ...

Page 62: ...ete After a short while the clearest image obtained should be displayed and the optimal focus range achieved Use the arrow marks on the sides to fine tune the focus if you are not satisfied with the results You may still need to use the arrow marks to fine tune the focus depending on the live image on your screen means moving from wide to tele end and tele to wide Below is the procedure to perform...

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

Page 64: ...ettings page On this page you can configure the Region of Interest and the Output Frame Size for a video stream For example you can crop only a portion of the image that is of your interest and thus save the bandwidth needed to transmit the video stream As shown below the area of your interest in a parking lot should be the vehicles The blue sky is of little value for the surveillance purpose Mode...

Page 65: ...me Size Size of the Live View Window Region of Interest Output frame size Stream 1 3840 x 2160 480 x 272 Selectable 3840 x 2160 480 x 272 Selectable Stream 2 3840 x 2160 480 x 272 Selectable 3840 x 2160 480 x 272 Selectable Stream 3 Fixed Fixed NOTE Please follow the steps below to set up those settings for a stream 1 Select a stream for which you want to set up the viewing region 2 Select a Regio...

Page 66: ...t 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 Configure the frame rate higher for smoother video viewing and for recognizing moving objects in the field of view If...

Page 67: ...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 determined by the activities in...

Page 68: ...t Stream II Smart Stream III has two more configurable options Smart Q and Smart FPS NOTE Smart FPS In a static scene the algorithm puts old frames in queue when no motions occur in scene When motions occur the encoding returns to normal to deliver real time streaming By queuing the old frames from a static scene both the computing efforts and the size of P frames are reduced It is beneficial for ...

Page 69: ...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 70: ...he Manual mode the non interested area is always transmitted using a low quality format regardless of the activities 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 non...

Page 71: ... streams around or within the bit rate limitation you impose Policy If Frame Rate Priority is selected the Network Camera will try to maintain the frame rate per second performance while the image quality will be compromised If Image quality priority is selected the Network Camera may drop some video frames in order to maintain image quality Smart Q Select ON or OFF to enable or disable the featur...

Page 72: ... the Fixed quality configuration can ensure a reasonable and limited use of network bandwidth 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 gain Fixed quality On the other hand if Fixed quality is selected all frames are transmitted with the same quality bandwidth utilization is the...

Page 73: ...er 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 12fps If the power line frequency is set to 60Hz the frame rates are selectable at 1fps 2fps 3fps 5fps 8fps 10fps and 12fps You can also select Customize and manually enter a value The frame rate will decrease if you select a higher resolution Video...

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

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

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

Page 77: ... 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 78: ...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 79: ...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 80: ... 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 81: ... format Please refer to HTTP streaming on page 83 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 82: ...VIVOTEK 82 User s Manual ...

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

Page 84: ...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 85: ...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 port RTP port for video audio RTCP port for video audio RTSP Real Time Streaming Protocol controls the delivery of streaming media By default the port...

Page 86: ...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 87: ... 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 or H 265 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 32 and Stream settings on page 64 SIP SIP is short for Session Initiation Protocol If necessary you can cha...

Page 88: ...6 Mute Mic Volume Talk Button Video TCP AV Audio is being transmitted to the Network Camera Click to enable audio transmission to the Network Camera click to adjust the volume of microphone click to turn off the audio To stop talking click again ...

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

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

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

Page 95: ...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 96: ...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 97: ...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 37 Allow anonymous viewing If you select this item any client can access the live stream without entering a User ID and Password ...

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

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

Page 110: ...canner via the RS485 interface Digital PTZ Operation E PTZ Operation The e PTZ control settings section will be displayed as shown below For e PTZ related details please refer to page 112 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...

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

Page 112: ...ions 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 to homepage and...

Page 113: ...en you can configure the PTZ driver and RS485 port with the following settings VIVOTEK provides the following PTZ drivers DynaDome SmartDOME Lilin PIH 7x00 Pelco D and Pelco P protocol If none of the above PTZ drivers is supported by your PTZ scanner please select Custom camera scanner Please refer to the documentation of your PTZ scanner to determine the Camera ID PTZ driver and Port settings The...

Page 114: ...the configuration window A total of 20 preset positions can be configured Please follow the steps below to configure preset positions 1 Adjust the shooting area to the desired position using the buttons on the right side of the window 2 Enter a name for the preset position which allows for up to forty characters Click Add to enable the settings The preset positions will be displayed under the Pres...

Page 115: ...k Camera will move to the selected preset position Click Patrol The Network Camera will patrol along the selected positions repeatedly NOTE Home page in Mechanical PTZ Mode The Preset Positions will also be displayed on the home page Select one from the drop down list and the Network Camera will move to the selected preset position ...

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

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

Page 119: ...a when a trigger is activated Trigger digital output for seconds Select this option to turn on the external digital output device when a trigger is activated Specify the length of the trigger interval in the text box Once the triggers are configured they will be listed under the VADP option ...

Page 120: ...D card Move to preset location Select a preset location you ve configured Note that please configure Preset locations first For detailed information please refer to page 110 Another checkbox will appear Capture media after moving to the location You can select to record associated snapshot video clip or system event once the event is triggered and the camera moves to the preset location See Add Me...

Page 121: ...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 122: ...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 123: ...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 124: ...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 146 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 125: ...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 126: ...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 127: ...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 128: ...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_20180513_100341 Date and time sufﬁx The format is YYYYMMDD_HHMMSS File name preﬁx ...

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

Page 131: ...em 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 longe...

Page 132: ...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 116 Please follow the steps beolw to set up a profile 1 Create a new moti...

Page 133: ...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 134: ...era 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 117 for detailed information ...

Page 135: ...aved 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 Too bright shining a flash light The average lighting level of the scene is taken into consideration Too dark covering the objective or spraying paint Too blu...

Page 136: ... 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 137: ...uring which this profile will take effect 4 Click Save and then click Close to complete your configuration Some of the anti virus software may consider the detection Java applet as virus and disables this function If the Alarm level and the received volume are set within a range of 20 on the wave diagram frequent alarms will be triggered It is recommended to set the Alarm level farther apart from ...

Page 138: ...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 139: ... 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 140: ...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 141: ...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 142: ...ed 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 the t...

Page 143: ...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 144: ...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 duration and the Maximum file size for each recording footage You ...

Page 145: ...n about folder naming rules please refer to page 124 for details 20180210 20180211 20180212 If you want to enable recording notification please click Event to configure event triggering settings Please refer to Event Event settings on page 116 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 146: ...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 147: ...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 148: ...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 149: ...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 150: ...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 151: ...ctive http mywebserver cgi bin dido setdo cgi do1 1 4 Security Level SECURITY LEVEL SUB DIRECTORY DESCRIPTION 0 anonymous Unprotected 1 view viewer Can view listen and talk to camera 4 operator operator Operator access rights can modify most of the camera s parameters except some privileges and network options 6 admin admin Administrator access rights can fully control the camera s operations 7 N ...

Page 152: ...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 153: ... setparam cgi parameter value parameter value return return page http servername cgi bin admin setparam cgi parameter value parameter value return return page PARAMETER DESCRIPTION parameter A full path like videoin_c0_s0_h264_resolution videoin_c0_s0_h264_maxframe etc value The assigned value to the parameter return page Redirect to the page return page after the parameter is assigned The return ...

Page 154: ... 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 155: ...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 156: ...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 157: ... 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 158: ...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 159: ...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 160: ...teger 7 6 Restore the system parameters to default values except zoom and focus value This command can cooperate with other restoreexceptXYZ commands When cooperating with others the system parameters will be restored to the default value except for a union of the combined results Only available when capability_image_c 0 n 1 _remotefocus 0 7 1 1 system info Subgroup of system info The fields in th...

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

Page 162: ...sh 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 DESCRI...

Page 163: ... 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 164: ...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 165: ... 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 Certificate file size in bytes privatekey_exist boolean 6 6 Private key installed flag for TLS privatekey_time 0 positive integ...

Page 166: ... 6 6 Event alarm channel for DSCP management 0 63 6 6 Management channel for DSCP eventtunnel 0 63 6 6 Event Control channel for DSCP 7 6 3 IPV6 Subgroup of network ipv6 capability protocol ipv6 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 Enable IPv6 addonipaddress ip address 6 6 IPv6 IP address addonprefixlen 0 128 6 6 IPv6 prefix length addonrouter ip address 6 6 IPv6 router add...

Page 167: ... 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 6 Enable anonymous streaming viewing 7 6 6 HTTPS port Subgroup of network https capability protocol https 0 NAME VALUE SECURITY get set DESCRIPTION port 443 1025 65535 1 6 HTTPS port 7 6 7 RTSP Subgroup of network rtsp capability ...

Page 168: ...ress with network_rtsp_s 0 n 1 _multicast_videoipaddre ss Reserved for compatibility and suggest don t use this since httpversion 0304a videoipaddress ip address 4 4 Multicast video IP address We support this parameter when the version number httpversion is equal or greater than 0304a audioipaddress product dependent ip address 4 4 Multicast audio IP address We support this parameter when the vers...

Page 169: ...ubgroup of network rtp NAME VALUE SECURITY get set DESCRIPTION videoport 1025 65535 6 6 Video channel port for RTP audioport 1025 65535 6 6 Audio channel port for RTP metadataport 1025 65535 6 6 Metadata channel port for RTP 7 6 10 PPPoE Subgroup of network pppoe capability protocol pppoe 0 NAME VALUE SECURITY get set DESCRIPTION user string 128 6 6 PPPoE account user name pass password 64 7 6 PPP...

Page 170: ...p address Network address ip address network mask Range address start ip address end ip address 6 6 IPv4 address list ipv6list_i 0 9 string 43 6 6 IPv6 address list 7 8Video input Group videoin NAME VALUE SECURITY get set DESCRIPTION cmosfreq 50 60 4 4 CMOS frequency Only available when capability_videoin_type is 2 whitebalance product dependent auto manual rbgain widerange outdoor indoor sodiumau...

Page 171: ...ps Only available when capability_image_c 0 n 1 _wbmode exposurelevel 0 12 4 4 Exposure level 0 12 This range takes the concept from DC s exposure tuning options The definition is 0 EV 2 0 1 EV 1 7 2 EV 1 3 3 EV 1 0 4 EV 0 7 5 EV 0 3 6 EV 0 7 EV 0 3 8 EV 0 7 9 EV 1 0 10 EV 1 3 11 EV 1 7 12 EV 2 0 Only available when capability_image_c 0 n 1 _exposure_m ode 0 irismode fixed indoor outdoor product i...

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

Page 173: ...0 5 8000 etc Available value is listed in capability_image_c 0 n 1 _exposu re_maxrange 4 4 Maximum exposure time 1 32000 1s 1 32000s 5 32000 1 5s 1 32000s 1 8000 1s 1 8000s 5 8000 1 5s 1 8000s etc This parameter may also restrict image frame 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 outpu...

Page 174: ...r indoor sodiumauto etc Available values are listed in capability_image_c 0 n 1 _wbm ode 4 4 Modes of white balance auto Auto white balance rbgain Use rgain and bgain to set white balance manually manual 2 cases a if rbgain is not supported this means keep current white balance status b if rbgain is supported rgain and bgain are updated to the current values which is got from white balance module ...

Page 175: ...ontrol 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 Exposure level 0 12 This range takes the concept from DC s exposure tuning options The definition is 0 EV 2 0 1 EV 1 7 2 EV 1 3 3 EV 1 0 4 EV 0 7 5 EV 0 3 6 EV 0 7 EV 0 3 8 EV 0 7 9 EV 1 0 10 EV 1 3 11 ...

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

Page 177: ...lity_image_c 0 n 1 _sens ortype is smartsensor Only available when capability_image_c 0 n 1 _iristy pe piris enableblc Not support anymore boolean 4 4 Enable backlight compensation Not support this parameter anymore when the version number httpversion is equal or greater than 0301a It s recommanded to use exposurewin_c 0 n 1 _mode to switch on off BLC maxgain 0 100 4 4 Maximum gain value 0 Low 100...

Page 178: ...age_c 0 n 1 _agc_ maxgain and capability_image_c 0 n 1 _expo sure_rangetype is onevalue Normalized range We support this parameter when the version number httpversion is equal or greater than 0302a color 0 1 4 4 0 monochrome 1 color Only available when capability_videoin_c 0 n 1 _color _support is 1 flip boolean 4 4 Flip the image mirror boolean 4 4 Mirror the image rotate 0 90 180 270 1 4 The rot...

Page 179: ...osition textonvideo_siz e 20 40 4 4 Text on video font size textonvideo_fon tpath usr share font Default ttf mnt flash2 upload ttf 4 4 Choose camera default font file usr share font Default ttf or user uploaded font file mnt flash2 upload ttf textonvideo_upl oadfilename Depends on the font file name uploaded by user 1 7 Show the uploaded font file name minexposure product dependent 1 32000 5 32000...

Page 180: ... 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 manual or irismode fixed Only available when capability_image_c 0 n 1 _expo sure_rangetype is twovalues shuttervalue product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c 0 n 1 _expo sure_maxrange 4 4 Exposure tim...

Page 181: ...rop_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 zoom in is on screen display or not We support this parameter when the version number httpversion is equal or greater than 0302a bracketing_level 1 100 4 4 The total available lists cap...

Page 182: ...s referred to capability_videoin_c 0 n 1 _ma xresolution and capability_videoin_c 0 n 1 _min resolution 1 4 Video resolution in pixels s 0 m 1 _s martfps_enable boolean 4 4 Enable Smart fps function Only available when capability_videoin_c 0 n 1 _sma rtfps_support is 1 We support this parameter when the version number httpversion is equal or greater than 0309a s 0 m 1 _h 264_dintraperio d_enable b...

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

Page 184: ...hen capability_smartstream_version 2 0 s 0 m 1 _h 264_bitrate 20000 capability_videoin_c 0 n 1 _h264_maxbitrate 4 4 The target bit rate in constant bit rate mode Only valid when ratecontrolmode cbr s 0 m 1 _h 264_prioritypoli cy framerate imagequality 4 4 Set prioritypolicy 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 ...

Page 185: ... support this parameter when the version number httpversion is equal or greater than 0301c s 0 m 1 _h 265_intraperiod 250 500 1000 2000 3000 4000 4 4 The time interval between two I frames Intra coded picture The unit is millisecond ms Only available when h265 is listed in capability_videoin_codec s 0 m 1 _h 265_ratecontrol mode cbr vbr 4 4 cbr Constant bit rate mode vbr Fixed quality mode all fra...

Page 186: ...ll range 1 Worst quality 100 Best quality Only available when h265 is listed in capability_videoin_codec Only valid when ratecontrolmode vbr and quant 100 s 0 m 1 _h 265_maxvbrbitr ate 20000 capability_videoin_c 0 n 1 _h265_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 available when h265 ...

Page 187: ...h 265_bitrate 20000 capability_videoin_c 0 n 1 _h265_maxbitrate 4 4 The target bit rate in constant bit rate mode Only available when h265 is listed in capability_videoin_codec Only valid when ratecontrolmode cbr s 0 m 1 _h 265_prioritypoli cy framerate imagequality 4 4 Set prioritypolicy Only available when h265 is listed in capability_videoin_codec Only valid when ratecontrolmode cbr s 0 m 1 _h ...

Page 188: ... _m jpeg_ratecontro lmode cbr vbr 4 4 cbr Constant bit rate mode vbr Fixed quality mode all frames are encoded in the same quality s 0 m 1 _m jpeg_quant 1 5 99 100 4 4 Only valid when ratecontrolmode vbr Set the pre defined quality level 1 Medium 2 Standard 3 Good 4 Detailed 5 Excellent 100 Use the quality level in qpercent 99 Use the quality level in qvalue s 0 m 1 _m jpeg_qvalue 10 200 Only vali...

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

Page 190: ...g_maxframerate s 0 m 1 _ra tiocorrect boolean 1 4 Change resolution to fit 4 3 ratio For PAL D1 4CIF 720 704x576 768x576 CIF 352x288 384x288 For NTSC D1 4CIF 720 704x480 640x480 CIF 352x240 320x240 Only available when capability_videoin_type is 0 or 1 wdrpro_mode product dependent boolean 4 4 Enable WDR pro Only available when capability_image_c 0 n 1 _wdrp ro_mode 0 wdrpro_strengt h product depen...

Page 191: ...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 _aesp eed is 1 aespeed_sensiti vity product dependent 1 100 4 4 The sensitivity of AE converge speed 1 20 level 1 21 40 level 2 41 60 level 3 61 80 level 4 81 100 level 5 Level 1 4 low high Th...

Page 192: ...rp mode is different by mount type videoin_c 0 n 1 _mounttype Supported mode list could be extracted from capability_videoin_c 0 n 1 _local dewarp_typeceilingmount and capability_videoin_c 0 n 1 _local dewarp_typewallmount Only available when capability_fisheyelocaldewarp_c 0 capability_nvideoin 1 0 Group videoin_c 0 n 1 _s 0 m 1 _h264_smartstream2 capability_smartstream_support 1 and capability_s...

Page 193: ...non ROI areas If the value is a negative number the video quality of non ROI areas is better than the ROI The level is from 1 to 5 Level 5 is the maximum level of the quality difference between the ROI and non ROI areas Group videoin_c 0 n 1 _s 0 m 1 _h264_smartstream2_win_i 0 k 1 capability_smartstream_support 1 capability_smartstream_version 2 0 and capability_smartstream_mode_manual 1 Group vid...

Page 194: ...ESCRIPTION enable boolean 4 4 Enable disable this profile setting policy night schedule 4 4 The mode which the profile is applied to Not support policy day anymore when the version number httpversion is equal or greater than 0301a begintime hh 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 val...

Page 195: ...e manual or irismode fixed Only available when capability_image_c 0 n 1 _exposure_ra ngetype is twovalues shuttervalue product dependent 1 32000 5 32000 1 8000 5 8000 etc Available value is listed in capability_image_c 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 fro...

Page 196: ...3 3 EV 1 0 4 EV 0 7 5 EV 0 3 6 EV 0 7 EV 0 3 8 EV 0 7 9 EV 1 0 10 EV 1 3 11 EV 1 7 12 EV 2 0 Only available when capability_image_c0_exposure_mode 0 exposuremode product dependent auto shutterpriority irispriority qualitypriority manual etc Available options are list in capability_image_c 0 n 1 _exposu re_modetype 4 4 Select exposure mode auto Automatically adjust the Iris Gain and Shutter Speed t...

Page 197: ...bgain 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 sodium vapor lamps...

Page 198: ...fixed Normalized range Only available when capability_image_c 0 n 1 _exposure_ra ngetype is 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...

Page 199: ...ity_image_c 0 n 1 _iristype piri s 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 _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 me...

Page 200: ...ilable when capability_image_c 0 n 1 _wdrc_mode is 1 aespeed_mode product dependent boolean 4 4 Turning AE converge speed on or off 0 off 1 on Only 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 me...

Page 201: ...4 4 Turn on 1 or turn off 0 the flickerless mode Only available when capability_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 ...

Page 202: ... Day mode begin time daymodeendtime 00 00 23 59 6 6 Day mod end time disableirled boolean 6 6 Enable disable built in IR led capability_daynight_c 0 capability_nvideoi n 1 _builtinir 0 enableextled boolean 1 6 Enable disable external IR led capability_daynight_c 0 capability_nvideoi n 1 _externalir 0 enablewled boolean 6 6 Enable disable built in White led capability_daynight_c 0 capability_nvideo...

Page 203: ...tsensitivity_type is not 7 11 Image setting per channel Group image_c 0 n 1 for n channel profucts and m profile n denotes the value of capability_nvideoin and m denotes the value of capability_nvideoinprofile NAME VALUE SECURITY get set DESCRIPTION brightness Not recommended to use this 5 5 100 4 4 5 Darker 5 Bright 100 Use image_c n _brightnesspercent Only available when bit 0 of capability_imag...

Page 204: ...pability_image_c 0 n 1 _basicsetting is 1 We replace saturation with saturationpercent This parameter will not be used after the version number httpversion is equal or greater than 0400a sharpness Not recommended to use this 3 3 100 4 4 3 Softer 3 Sharper 100 Use image_c 0 n 1 _sharpnesspercent Only available when bit 3 of capability_image_c 0 n 1 _basicsetting is 1 We replace sharpness with sharp...

Page 205: ...range 0 Softer 100 Sharper Only available when bit 3 of capability_image_c 0 n 1 _basicsetting is 1 gammacurve product dependent 0 100 4 4 0 Fine turned gamma curve by Vivotek 1 Gamma value 0 01 2 Gamma value 0 02 3 Gamma value 0 03 100 Gamma value 1 Note Although we set gamma value to 100 level but not all gamma values are valid Internal module will take the closest valid one For example 1 45 may...

Page 206: ... stabilizer 0 disable 1 enable Only available when eis is listed in capability_image_c 0 n 1 _is_mode eis_strength product dependent 1 100 4 4 Strength of electronic image stabilizer Only available when eis is listed in capability_image_c 0 n 1 _is_mode dis_mode product dependent boolean 4 4 Digital image stabilizer 0 disable 1 enable Only available when dis is listed in capability_image_c 0 n 1 _...

Page 207: ...s can choose between two different deinterlacing techniques Spatical mode provides the best image quality while Blend mode provides better image quality than not using the deinterlace function at all Only available when capability_image_c 0 n 1 _deinterlace_ support is 1 xoffset 0 100 4 4 Adjusting the image to proper position horizontally Only available when the bit 4 of capability_image_c 0 n 1 ...

Page 208: ...ot support policy day anymore when the version number httpversion is equal or greater than 0301a profile_i 0 m 1 _begintime hh mm 4 4 Begin time of schedule mode profile_i 0 m 1 _endtime hh mm 4 4 End time of schedule mode profile_i 0 m 1 _brightness Not recommended to use this 5 5 100 4 4 5 Darker 5 Bright 100 Use image_c 0 n 1 _brightnesspercent Only available when bit 0 of capability_image_c 0 ...

Page 209: ...number httpversion is equal or greater than 0400a profile_i 0 m 1 _sharpness Not recommended to use this 3 3 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 after the version number httpversi...

Page 210: ..._gammacur ve 0 100 4 4 0 Fine turned gamma curve by Vivotek 1 Gamma value 0 01 2 Gamma value 0 02 3 Gamma value 0 03 100 Gamma value 1 Note Although we set gamma value to 100 level but not all gamma values are valid Internal module will take the closest valid one For example 1 45 may all be mapped to gamma value 0 45 etc Only available when capability_image_c 0 n 1 _gammacurve is 1 profile_i 0 m 1...

Page 211: ...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_mode profile_i 0 m 1 _eis_streng th product dependent 1 100 4 4 Strength of electronic image stabilizer Only available when eis is listed in capability_image_c 0 n 1 _is_mode profile_i 0 m 1 _dis_mode product dependent boolean 4 4 Digital ...

Page 212: ...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 213: ... 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 214: ...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 215: ...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 216: ...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 217: ...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 218: ..._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 219: ...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 220: ...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 221: ...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 222: ... 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 223: ...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 224: ...RITY get set DESCRIPTION enable boolean 4 4 Enable or disable tamper detection threshold 0 100 4 4 Threshold of tamper detection duration 10 600 4 4 If tampering value exceeds the threshold for more than duration second s then tamper detection is triggered ignorewidth 0 positive integer 1 7 Indicate the width to offset to start to analysis the image dark_enable boolean 4 4 Enable or disable image ...

Page 225: ...fe100 6 6 Safe100 safe100 net DyndnsDynamic dyndns org dynamic DyndnsCustom dyndns org CustomSafe100 Custom server using safe100 method provider _hostname string 128 6 6 Your DDNS hostname provider _usernameem ail string 64 6 6 Your user name or email to login to the DDNS service provider provider _passwordkey string 64 7 6 Your password or key to login to the DDNS service provider provider _serve...

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

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

Page 228: ...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 229: ... 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 230: ...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 231: ... 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 232: ... 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 233: ...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 234: ...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 235: ...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 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...

Page 236: ... virestor e product dependent 0 7 list all the trigger types which are supported in the camera seq Periodic condition boot System boot motion Video motion detection networkfail network connection failure recnotify Recording notification tampering Tamper detection vi Virtual input Manual trigger vadp VADP trigger di Digital input volalarm Audio detection temperature Temperature detection pir PIR de...

Page 237: ... IPv6 protocol_pppoe boolean 0 7 Indicate whether to support PPPoE protocol_ieee8021x boolean 0 7 Indicate whether to support IEEE802 1x protocol_qos_cos boolean 0 7 Indicate 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_nre...

Page 238: ...deoin_c0_streamcodec This is kept for compatibility videoin_flexiblebitrate boolean 0 7 Indicate whether to support flexible bit rate control videoout_codec A list of the available codec types separated by commas product dependent 0 7 Available codec list not supported timeshift boolean 0 7 Indicate whether to support time shift caching stream audio_aec boolean 0 7 Indicate whether to support acou...

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

Page 240: ..._alarm 0 Positive Integer 0 7 0 Not support audio alarm 1 Support audio alarm Bit 0 for CH0 bit 1 for CH1 and so on audio_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 w...

Page 241: ...The window is a 2D rectangle shape Not supported motion_windomain qvga px std 0 7 The domain to set an motion window qvga a 320x240 range to represent the whole image px Locate a window in the image with 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 Only av...

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

Page 243: ...er httpversion is equal or greater than 0301b This equals capability_camctrl_c0_ptztunnel This is kept for compatibility camctrl_privilege boolean 0 7 Indicate whether to support Manage Privilege of PTZ control in the security page 1 support both cgi bin camctrl camctrl cgi and cgi bin viewer camctrl cgi 0 support only cgi bin viewer camctrl cgi This is equivalent to capability_camctrl_c0_privileg...

Page 244: ...ess WPA wireless_encrypt_wpa2 boolean 0 7 Indicate whether to support wireless WPA2 wireless_apmode_enable boolean 0 7 Indicate whether wireless AP mode is supported Only available when capability_network_wireless is 1 We support this parameter when the version number httpversion is equal or greater than 0305a wireless_apmode_ssidpref ix string 0 7 Indicate the prefix of broadcasted SSID when came...

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

Page 246: ...reserved bit and the default value is 0 Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 localstorage_slconnum 0 positive integer 0 7 The maximum seamless connection number Only available when capability_supportsd is 1 or capability_storage_dbenabled is 1 localstorage_smartsd boolean 0 7 The Lifetime and Log SD Card feature allows users to obtain the card s remain...

Page 247: ...1 n denotes the value of capability_nvideoin capability_ptzenabled 0 We support this group when the version number httpversion is equal or greater than 0303b PARAMETER 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 ...

Page 248: ...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 249: ... 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 250: ...oommodule is 1 minfocus 0 positive integer 0 7 The lower limit for focus position Only available when the value of capability_camctrl_c 0 n 1 _zoommodule is 1 maxfocus 0 positive integer 0 7 The upper limit for focus position Only available when the value of capability_camctrl_c 0 n 1 _zoommodule is 1 Group capability_daynight_c 0 n 1 n denotes the value of capability_nvideoin PARAMETER VALUE SECU...

Page 251: ...n is equal or greater than 0302a ircutsensitivity_type string 0 7 Indicate the cgi interface of ircutcontrol_sensitivity options the value of ircutcontrol_sensitivity parameter is low normal high normalize the value of ircutcontrol_sensitivity parameter is 1 100 not support Only available when capability_daynight_c 0 n 1 _support is 1 We support this parameter when the version number httpversion i...

Page 252: ...reams color video In night mode the camera streams black and white video in low light environments di the camera automatically switches the current mode when a ditigal input 1 is triggered di2 the camera automatically switches the current mode when a ditigal input 2 is triggered di3 the camera automatically switches the current mode when a ditigal input 3 is triggered di4 the camera automatically ...

Page 253: ... information about among other things its own geometrical distortion and the exact position of its zoom focus and iris opening N A Only available when httpversion 0301a color_support boolean 0 7 1 camera can select to display color or black white video streams 0 camera do not support this feature We support this parameter when the version number httpversion is equal or greater than 0310a eptz_zoom...

Page 254: ...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 255: ...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 256: ... 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 257: ...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 258: ... 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 259: ...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 260: ... 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 261: ... 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 262: ...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 263: ...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 264: ...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 265: ...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 266: ... 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 267: ...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 268: ...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 269: ...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 270: ...de which are supported in the camera Only available when 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 supported iristype piris dciris 0 7 Indicate iris type piris P Iris dciris DC Iris No Iris control support Note For some cameras this value may be varied...

Page 271: ...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 equal or greater than 0302a exposure_shuttervaluetyp e fixed maximum 0 7 One to one mapping to the mode type in exposure_modetype fixed The shutter value is the assigned value videoin_c 0 n 1 _...

Page 272: ...rsion number httpversion is equal or greater than 0302a exposure_automode_affe ct exposurewin mode blc hidd en defog disabled wdrpro disabled exposurelevel hidden or others x nonnegative integer product dependent 0 7 When exposure auto 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 Descrip...

Page 273: ...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 defog disabled wdrpro disabled exposurelevel hidden or others x nonnegative integer product dependent 0 7 When exposure shutter priority mode is enabled some feature...

Page 274: ... 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 _ 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_irisprioritymod e_affect exposurewin mode blc hidd en ...

Page 275: ...ect 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 irispriority is listed in capability_image_c 0 n 1 _ expos...

Page 276: ...I keeps the status as before and user can t change it hidden UI is hidden fixed UI is fixed to one selection or value ranged UI is fixed to multiple selections or values 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 we...

Page 277: ...cted 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 the affecte...

Page 278: ...t 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 exposurewin is not supported When exposure_mode 0 this value must be set to Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_hlcmode_suppo rtwindow boolean 0 7 Indicate whether to supp...

Page 279: ...tion 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 level 6 Description can be a nonn...

Page 280: ... qvga px std 0 7 The domain to set an exposure window qvga a 320x240 range to represent the whole image px Locate a window in the image with pixels std A normalized 0 9999 range Not supported Only available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_winnum 0 Positive Integer 0 7 Indicate the number of custom exposure windows If no custom is listed in exposure_winmode this should b...

Page 281: ...t 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 available when capability_image_c 0 n 1 _ exposure_mode is 1 exposure_minrange 1 32000 1 8000 or others product dependent 0 7 Available range for videoin_c n _minexposure 1 32000 1s 1 32000s 1 8000 1s 1 8000s e...

Page 282: ...ased on the original exposure time first stream Only available when capability_image_c 0 n 1 _ exposure_bracketing_mode is 1 We support this parameter when the version number httpversion is equal or greater than 0310a privacymask_wintype rectangle polygon 3Drectangle 0 7 The supported mask window type polygon The window is a 2D polygon shape rectangle The window is a 2D rectangle shape 3Drectangle...

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

Page 284: ... defog If capability_image_c 0 n 1 _defog _mode 1 this may be either 0 or 1 defog_supportlevel 0 positive integer 0 7 The value indicate the support strength level of defog defog_affect wdrpro unchanged or others x nonnegative integer product dependent 0 7 When defog is enabled some features may become malfunction or be forced to a given value The affected functions are list here The format is Aff...

Page 285: ...tring or NULL means no feature is affected When defog 0 this value must be aespeed 0 1 0 7 0 Non support AE speed 1 Support AE speed aespeedsupportlevel positive integer 0 7 The value indicate the support strength level of aespeed Only available when capability_image_c 0 n 1 _aesp eed is 1 aespeedsupportsensitivity 0 1 0 7 0 Non support tuning the sensitivity of AE converge speed 1 Support tuning ...

Page 286: ...e is 0 focuswindomain qvga px std 0 7 The domain to set a focus window qvga a 320x240 range to represent the whole image px Locate a window in the image with pixels std A normalized 0 9999 range Not supported focuswindow_nwindow 0 positive integer 0 7 Number of focus window focuswindow_range leftrange rightrange topra nge lowrange product dependent 0 7 Available range for focuswindow We support th...

Page 287: ...ion number httpversion is equal or greater than 0308a deinterlace_mode spatial blend 0 7 Spatical mode provides the best image quality while Blend mode provides better image quality than not using the deinterlace function at all Only available when capability_image_c 0 n 1 _deinte rlace_support is 1 lens_alignment boolean 0 7 Indicate whether to support lens alignment function We support this para...

Page 288: ...able when capability_image_c 0 n 1 _palet te_support 1 We support this parameter when the version number httpversion is equal or greater than 0310a Group capability_peripheral_c 0 n 1 n 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 n...

Page 289: ...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 290: ...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 291: ...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 292: ...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 293: ...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 294: ...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 295: ... 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 296: ...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 297: ...t trigger point seconds adaptive_postevent 0 10 6 6 Indicate when is the adaptive recording stopped after the event trigger point seconds 7 33 HTTPS Group https capability protocol https 0 NAME VALUE SECURITY get set DESCRIPTION enable boolean 6 6 To enable or disable secure HTTP policy Boolean 6 6 If the value is 1 it will force HTTP connection redirect to HTTPS connection method auto manual inst...

Page 298: ...TER VALUE SECURITY get set DESCRIPTION cyclic_enabled boolean 6 6 Enable cyclic storage method autocleanup_enabled Not recommended to use this boolean 6 6 Enable automatic clean up method Expired and not locked media files will be deleted For forward compatibility reservations but only group disk_i0_autocleanup is effective Not recommended to use this Please refers autocleanup group This parameter...

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

Page 300: ...is the index of video stream which support ePTZ capability eptz 0 or capability_fisheye 1 PARAMETER VALUE SECURITY get set DESCRIPTION s 0 m 1 _home W H product dependent 1 6 ROI left top corner coordinate If the minimal 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 permission...

Page 301: ...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 302: ...pendent 1 4 Left top corner coordinate of the preset Only available when capability_fisheye 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 tha...

Page 303: ...Number of connected seamless streaming with guid 0 2 _id Read only 7 39 VIVOTEK Application Development Platformsetting Group vadp NAME VALUE SECURITY get set DESCRIPTION version string 6 7 Indicate the VADP version resource_total_memory 0 positive integer 6 7 Indicate total available memory size for VADP modules resource_total_storage 0 positive integer 6 7 Indicate total size of the internal sto...

Page 304: ...e IP address if the module provides it own web page vendor string 40 6 6 The provider of the module vendorurl string 120 6 6 URL of the vendor version string 40 6 6 Version of the module license string 40 6 6 Indicate the license status of the module licmsg string 128 6 6 Indicate the message that will be show on license status when mouse over path string 40 6 6 Record the storage path of the modu...

Page 305: ...amctrl ptztunnel 0 NAME VALUE SECURITY get set DESCRIPTION enableptztunnel boolean 1 4 Enable PTZ tunnel for camera control Group camctrl_c 0 n 1 for n channel products capability ptzenabled 0 n denotes the value of capability_nvideoin and k denotes the value of capability_npreset NAME VALUE SECURITY get set DESCRIPTION panspeed 5 5 1 4 Pan speed tiltspeed 5 5 1 4 Tilt speed zoomspeed 5 5 1 4 Zoom...

Page 306: ...npreset NAME VALUE SECURITY get set DESCRIPTION ccdtype string 16 6 7 Internal used read only motortype string 16 6 7 Internal used read only cameraid 0 255 1 4 Camera ID controlling external PTZ camera Note Please set your speed dome to the appropriate baud rate and Camera ID e g 2400bps camera ID 1 2 3 etc All Camera IDs on the same controlling system NVR or rs485 keyboard have to be distinct Th...

Page 307: ...tion at each preset location preset_i 0 k 1 _ dwelling 0 999 1 4 The dwelling time of each preset location preset_i 0 k 1 _focus setting sync fixcurrent 1 4 The focus mode of each preset which is essential and should be grouped with preset_i 0 k 1 _name We support this parameter when the version number httpversion is equal or greater than 0305b patrolseq string 120 1 4 For external device The inde...

Page 308: ...ction will be taken 7 42 camera PTZ control SD series Group camctrl_c 0 n 1 for n channel products the bit7 of capability_ptzenabled is 0 and the bit4 of capability_ptzenabled is 1 n denotes the value of capability_nvideoin and k denotes the value of capability_npreset NAME VALUE SECURITY get set DESCRIPTION ccdtype string 16 6 7 Internal used read only motortype string 16 6 7 Internal used read o...

Page 309: ..._minzoom capability_ptz_c 0 n 1 _maxzoom 1 4 Zoom position at each preset location preset_i 0 k 1 _focus capability_ptz_c 0 n 1 _minfocus capability_ptz_c 0 n 1 _maxfocus 1 4 Focus position at each preset location preset_i 0 k 1 _focus setting sync fixcurrent 1 4 The focus mode of each preset which is essential and should be grouped with preset_i 0 k 1 _name We support this parameter when the vers...

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

Page 311: ...preset position separated by Recorded tour number of seconds to wait before continuing a loop tour 7 43 UART control Group uart capability nuart 0 and capability fisheye 0 NAME VALUE SECURITY get set DESCRIPTION ptzdrivers_i 0 19 127 _name string 40 1 4 Name of the PTZ driver ptzdrivers_i 0 19 127 _location string 128 1 4 Full path of the PTZ driver enablehttptunnel boolean 1 4 Enable HTTP tunnel ...

Page 312: ...md string 40 1 4 Additional PTZ command list ptzdriver 0 19 127 custom 128 no driver 1 4 The PTZ driver is used by this COM port 7 44 UART control SD series Group uart_i 0 n 1 n is uart port count capability nuart 0 and the bit7 of capability_ptzenabled is 0 the bit4 of capability_ptzenabled is 1 NAME VALUE SECURITY get set DESCRIPTION cameraid 1 255 4 4 Camera ID controlling external PTZ camera N...

Page 313: ...mode rs485 4 7 RS485 mode 7 45 Lens configuration Group lens for n channel products n denotes the value of capability_nvideoin capability image c 0 n 1 lensconfiguration support 1 NAME VALUE SECURITY get set DESCRIPTION selected string 6 7 Current selected lens profile e g lens_selected lens_default_i0 it means choosen lens configuration is i0 lens of default group Group lens_default NAME VALUE SE...

Page 314: ...teger 6 7 The actual center radius 7 47 Fisheye local dewarp setting Group fisheyedewarp_c 0 n 1 capability_fisheyelocaldewarp_c 0 n 1 0 n denotes the value of capability_nvideoin m denotes the value of capability_nmediastream NAME VALUE SECURITY get set DESCRIPTION panspeed 5 5 integer 1 4 Pan speed of regional view tiltspeed 5 5 integer 1 4 Tilt speed of regional view zoomspeed 5 5 integer 1 4 Z...

Page 315: ...n 1 1 Enable disable PIR 7 49 Auto tracking setting Group autotrack_c 0 n 1 capability_image_c 0 n 1 _autotrack_support 0 n denotes the value of capability_nvideoin PARAMETER VALUE SECURITY get set DESCRIPTION objsize_type 1 2 1 4 Type of object size 1 customized width and height 0 object size 30 x 30 1 object size 10 x 20 2 object size 10 x 10 objsize_customized_width 10 320 1 4 The minimum width...

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

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

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

Page 321: ...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 322: ...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 323: ...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 324: ... 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 325: ...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 326: ...rn page after the parameter is assigned The return page should be the relative path according to the root of camera If you omit this parameter it will redirect to an empty page If the return page is invalid path it will ignore this parameter 8 10 ePTZ Preset Locations capability eptz 0 and capability_fisheye 0 Note This request requires Operator privileges Method GET POST Syntax http servername cg...

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

Page 328: ...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 329: ...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 330: ...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 331: ... 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 332: ...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 333: ...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 334: ...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 335: ...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 336: ...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 337: ...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 338: ...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 339: ...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 340: ...lied 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 8 21 BackFocus capability_image_c 0 n 1 _remotefocus 4 Note This request requires Administrator privileges Method GET POST Syntax http servername cgi bin admin remotefocus cgi function value direction value position value steps value iris P...

Page 341: ..._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 342: ...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 343: ...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 344: ...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 345: ...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 346: ...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 347: ...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 348: ...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 349: ...value speedtilt value speedzoom value speedapp value speedlink v alue 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 video size 704x480 strech 1 Example set the ptz preset with ...

Page 350: ...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 351: ... for querying API http servername cgi bin camctrl camctrl cgi parameter parameter Example http myserver cgi bin camctrl camctrl cgi getpan Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n pan 4117 r n PARAMETER VALUE DESCRIPTION getversion string Get the version of the PTZ control module getaction idle autopan tracking tour patrol Get the current status of the camera...

Page 352: ...ity_camctrl_c 0 n 1 _buildinpt is 1 getmaxpan 0 positive integer 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_cam...

Page 353: ... 0 positive integer Get the upper limit 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 ...

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

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

Page 357: ...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 358: ...equires Administrator privileges Method GET POST Syntax http servername cgi bin admin start_wps cgi PARAMETER VALUE DESCRIPTION N A N A Start WPS transaction 8 36 Peripheral control capability_peripheral_c 0 n 1 _ devicecontrol 0 Note This request requires Administrator privileges Method GET POST Syntax for control API http servername cgi bin admin peripheral cgi channel value operation set washer...

Page 359: ...sher to the mode of washer control system Only available when capability_peripheral_c 0 n 1 _washer_supp ort 1 washer_status on Enable the functionality of washer control system Only available when capability_peripheral_c 0 n 1 _washer_supp ort 1 off Disable the functionality of washer control system Only available when capability_peripheral_c 0 n 1 _washer_supp ort 1 washer_dwelltime 15 999 Apply...

Page 360: ...eater_status Get heater status Example http myserver cgi bin admin peripheral cgi channel 0 operation get supportdevice washer_status Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n supportdevice washer heater r n washer_status off r n PARAMETER VALUE DESCRIPTION channel 0 capability_nvideoin 1 Channel of the video source supportdevice N A Get support peripheral dev...

Page 361: ...able when capability_peripheral_c 0 n 1 _washer_supp ort 1 heater_supportstatus N A Get the support status of heater control system Only available when capability_peripheral_c 0 n 1 _heater_suppo rt 1 heater_status N A Get the current heater status Normally it will be auto it means the heater device is control by internal algorithm to keep in a suitable environment Otherwise is trigger it means th...

Page 362: ...cally adjust the IR zone one time only getstatus Information of optimized IR control status and return value as below optimizedir_c 0 n 1 _irmode Indicate the IR current mode available value is auto and manual mode optimizedir_c 0 n 1 _irnum The number of IR that camera supports optimizedir_c 0 n 1 _irstrength Only available when irmode is set as manual It s a set of integers which indicate the st...

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

Page 364: ...ength 50 70 50 50 50 Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n ERROR Parameter irmode must be set as manual Example http myserver cgi bin admin optimizedir cgi channel 0 operation set strength 50 70 50 50 50 Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n ERROR Must have the irmode manual argument Syntax for querying API http se...

Page 365: ... all adjustment mode that IR supports irmode N A Get the current IR control mode irnum N A Get the number of IR that camera supports Example http myserver cgi bin admin optimizedir cgi channel 0 operation get irmode Response HTTP 1 0 200 OK r n Cache control no cache r n Pragma no cache r n r n optimizedir_c0_irmode auto End of document ...

Page 366: ... TCP IP HTTP HTTPS UPnP RTSP RTP RTCP IGMP CIFS SMB SMTP FTP DHCP NTP DNS DDNS PPPoE CoS QoS SNMP 802 1X UDP ICMP ARP SSL TLS NTCIP Interface 10 Base T 100 Base TX Ethernet 1000 Base T RJ 45 It is highly recommended to use standard CAT5e CAT6 cables which are compliant with the 3P ETL standard ONVIF Supported specification available at www onvif org Intelligent Video Video Motion Detection Five wi...

Page 367: ... Ver 3 6F No 192 Lien Cheng Rd Chung Ho New Taipei City 235 Taiwan R O C T 886 2 82455282 F 886 2 82455532 E sales vivotek com W www vivotek com Others Quick installation guide warranty card lens camera stand screw pack Dimensions 70 mm w o lens w lens 61 mm 151 mm 70 mm 61 mm 209 mm Enclosures Lens AE 23E AL 248 Outdoor Enclosures PoE Input IP68 IK10 12 50mm F1 8 P iris ...

Page 368: ... 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 369: ...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 SUPREME IP9191-HP

Reviews:

Related manuals for SUPREME IP9191-HP

Brands by name

Popular brands

Vivotek SUPREME IP9191-HP, User Manual

Search results

Summary of Contents for SUPREME IP9191-HP

Reviews:

Related manuals for SUPREME IP9191-HP

Brands by name

Popular brands