advertisement
IB8373-EH
Bullet
Network Camera
User’s Manual
3MP • 30m IR • IP67 • Smart IR • Smart Focus System
Day & Night • Weather-proof
Rev. 1.0
VIVOTEK
Table of Contents
(Hypertext Transfer Protocol over SSL)
���������������������������������������������������� 88
2 - User's Manual
VIVOTEK
User's Manual - 3
VIVOTEK
Overview
VIVOTEK’s IB8373-EH network camera features a 3-Megapixel WDR CMOS sensor to cope with challenging lighting conditions� The WDR Pro feature allows the camera to capture both the dark and bright areas of an image and combine the differences to generate a highly realistic representation of the original scene� This feature enables the camera to provide video quality very close to the capabilities of the human eye� The IB8373-EH can be deployed widely in high contrast outdoor environments such as parking areas and streets� The P-iris lens controls the iris with extreme precision; with its built-in stepper motor, it maintains the iris opening at an optimal level at all times, resulting in superior image clarity and depth of field.
The IP67-rated housing is designed to help the camera body withstand rain and dust and ensures smooth operation even under a multitude of harsh weather conditions� Additionally, the wide temperature range further enhances the IB8373-EH’s performance and reliability in extremely cold environments�
Revision History
■ Rev. 1.0: Initial release.
4 - User's Manual
VIVOTEK
Read Before Use
The use of surveillance devices may be prohibited by law in your country� The Network Camera is not only a high-performance web-ready camera but can also be part of a flexible surveillance system� It is the user’s responsibility to ensure that the operation of such devices is legal before installing this unit for its intended use�
It is important to first verify that all contents received are complete according to the Package
Contents listed below� Take note of the warnings in the Quick Installation Guide before the Network
Camera is installed; then carefully read and follow the instructions in the Installation chapter to avoid damage due to faulty assembly and installation� This also ensures the product is used properly as intended�
The Network Camera is a network device and its use should be straightforward for those who have basic networking knowledge� It is designed for various applications including video sharing, general security/surveillance, etc� The Configuration chapter suggests ways to best utilize the
Network Camera and ensure proper 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
■ IB8373-EH with an RJ45 Cable
■
■
Sun Shield / Wrench / RJ45 Female-Female Coupler / Double-sided Tape / Screws
■ Wall Mount Bracket
Waterproof Connector for RJ45 Ethernet Enclosure
■ Waterproof Connector (for DI/DO and power wires)
■ Alignment Sticker / Desiccant Bag
■ Quick Installation Guide
■ Software CD
Symbols and Statements in this Document
i INFORMATION: provides important messages or advices that might help prevent inconvenient or problem situations�
NOTE: Notices provide guidance or advices that are related to the functional integrity of the machine�
Tips: Tips are useful information that helps enhance or facilitae an installation, function, or process�
WARNING! or IMPORTANT!: These statements indicate situations that can be dangerous or hazardous to the machine or you�
Electrical Hazard: This statement appears when high voltage electrical hazards might occur to an operator�
User's Manual - 5
VIVOTEK
Physical Description
LED
General I/O
Terminal Block
SD/SDHC/SDXC Card Slot
NTSC-PAL switch
PAL NTSC
Auto Focus
Reset Button
Audio in
Audio out
Status LED
1
2
Item LED status
Steady Red
Red LED off
Blinking Green every 1 sec�
Steady Red and Green LED is off
3
4
Description
Power on and system booting
Power off
Network normal (heartbeat)
Network failed
Red blinking every 0�15 sec�, and Orange LED blinking every 1 sec�
( Red on for 0�15 sec and off for 0�15 sec�); ( Green on for 1 sec� and off for another� )
Upgrading firmware
Blinking Orange every 0�15 sec� Both LEDs are on for 0�15 sec� and off for 0�15 sec�
Restoring default
6 - User's Manual
VIVOTEK
DI/DO Diagram
Please refer to the following illustration for the connection method�
GND
Camera Power
Input
BJT transistor
Output
VDC
Switch +12
VDC
Max.
GND
Camera Power
Input
VDC
Switch
+12
VDC
BJT transistor
Output
Relay
Relay
User's Manual - 7
VIVOTEK
Hardware Reset
Reset Button
The reset button is used to reset the system or restore the factory default settings� Sometimes resetting the system can return the camera to normal operation� If the system problems remain after reset, restore the factory settings and install again�
Reset: Press and release the recessed reset button. Wait for the Network Camera to reboot.
Restore: Press and hold the recessed reset button until the status LED rapidly blinks. Note that all settings will be restored to factory default� Upon successful restore, the status LED will blink green and red during normal operation�
SD/SDHC/SDXC Card Capacity
This network camera is compliant with SD/SDHC/SDXC 16GB / 8GB / 32GB /64GB and other preceding standard SD cards�
8 - User's Manual
VIVOTEK
Installation
Hardware Installation
1� Attach the alignment sticker to the wall� Drill four holes into the wall� Then hammer the supplied plastic anchors into the holes and secure the plate with supplied screws�
2� Fix the intersection bracket to the side of the Network Camera with two screws�
3. Feed the RJ45 cable through the front opening of the wall mount bracket. (If you want to use external devices such as sensors and alarms, please refer to the assembling steps on the next page�)
4� Push the spring mortise and hook the bracket onto the groove of the wall mount bracket�
5� Secure the two screws on the other side of the wall mount bracket�
6� Hang the wall mount bracket to the mounting plate�
7� Fix the wall mount bracket with the supplied screw�
8� Adjust the angle of the wall mount bracket to aim at the shooting area�
1
2
3
5
4
6
8
7
User's Manual - 9
VIVOTEK
Waterproof Connector
Components of the Waterproof Connector
Screw Nut (A)
Seal (B)
Seals (C)
Housing (D)
Sealing Nut (E)
Pin Definitions
Open the rear cover by rotating to the alignment mark, and pull the cover off the canister�
Pin Definitions
1 DC 12V- IN
2 DC 12V+ IN
3 AC24V_2 IN
4 AC24V_1 IN
5 DI-
6 DI+
7 DO-
8 DO+ (12V)
8
Pin number
1
NOTE:
In addition to PoE (Power over Ethernet), you can also supply power to the camera using pins #1~#4 from the terminal block, either using DC 12V or AC24V�
10 - User's Manual
VIVOTEK
Assembling Steps
1� Disassemble the components of the waterproof connector into part (A) ~ (E) as shown above�
2� Open the rear cover of the Network Camera�
3� Remove the rubber stopper from the bottom of the Network Camera and secure the screw nut (A) tightly�
4� You may choose to use AC24V or DC12V inputs as power source, please feed the power lines through the wall mount bracket and the waterproof connector (E --> D --> B -->
A) as illustrated below� Pass power lines through the rubber seal (B) and then connect the power lines to the terminal block�
5� If you have external devices such as sensors and alarms, feed the cables through the wall mount bracket and the waterproof connector (E --> D --> B --> A) as the illustration shown below. Then refer to the pin definition to connect them to the general I/O terminal block. Note: The recommended cable gauge is 2�0 ~ 2�8 mm�
6� Push the seal (B) into the housing (D)�
7� Insert the seals (C) into the empty holes on the seal (B) to avoid moisture�
8� Secure the sealing nut (E) tightly�
5
3
(A)
(B)
(D)
(E)
4
4
(E)
8
6
(B)
(D)
7
(C)
9-2 9-2
9-1
9� Open the aluminum foil vacuum bag and take out the desiccant bag� Attach the desiccant bag to the inner side of the rear cover, to under the insulation pad, and then tighten the rear cover� (Please replace the desiccant bag with a new one whenever you open the rear cover�)
User's Manual - 11
VIVOTEK
Cabling Assembly: RJ45 Cable Connector
RJ45 Cable Dimension (unit: mm)
Assembling Steps
1
Prepare an Ethernet cable and strip part of the sheath�
2
Insert the housing into the screw nut�
(C) (D)
Recommended cable gauge:
O� D� 5�5~7
4
Insert the stripped Ethernet cable through the sealing nut and the housing�
(A)
5
Clamp the cable with an RJ45 plug.
Components of the Waterproof
Connector
Sealing Nut (A)
Seal (B)
Screw Nut (C)
Housing (D)
Gasket (E)
3
Insert the seal into the housing�
(B)
6
Push the RJ45 plug into the housing, then secure the sealing nut tightly�
7
Attach the gasket to the front of the housing�
(E)
8
Connect the Ethernet cable to the RJ45 cable and secure the connectors tightly�
12 - User's Manual
VIVOTEK
Network Deployment
Setting up the Network Camera over the Internet
This section explains how to configure the Network Camera to an Internet connection �
1� If you have external devices such as sensors and alarms, connect them to the general I/
O terminal block�
2� Connect the camera to a switch via Ethernet cable�
3� Connect either the DC 12V or AC 24V power wires from the Network Camera to a power outlet�
3
2
Ethernet Switch
POWER
COLLISION
1 2
3 4 5
LINK
PARTITION
There are several ways to set up the Network Camera over the Internet � The first way is to set up the Network Camera behind a router � The second way is to utilize a static IP � The third way is using PPPoE �
User's Manual - 13
VIVOTEK
Set up the Network Camera through Power over Ethernet (PoE)
When using a PoE-enabled switch
The Network Camera is PoE-compliant, allowing transmission of power and data via a single Ethernet cable� Follow the below illustration to connect the Network Camera to a
PoE-enabled switch via Ethernet cable�
power + data transmission
POWER COLLISION
1 2 3
4 5
LINK
PARTITION
PoE Switch
When using a non-PoE switch
If your switch/router does not support PoE, use a PoE power injector (optional) to connect between the Network Camera and a non-PoE switch�
14 - User's Manual
PoE Power Injector
(optional)
POWER COLLISION
1 2 3
4 5
LINK
PARTITION
Non-PoE Switch
VIVOTEK
Internet connection via a router
Before setting up the Network Camera over the Internet, make sure you have a router and follow the steps below�
1� Connect your Network Camera behind a router, the Internet environment is illustrated
Internet
WAN (Wide Area Network )
Router IP address : from ISP
POWER COLLISION
1 2 3
4 5
LINK
RECEIVE
PARTITION
LAN (Local Area Network)
Router IP address : 192.168.0.1
Cable or DSL Modem
IP address : 192.168.0.3
Subnet mask : 255.255.255.0
Default router : 192.168.0.1
IP address : 192.168.0.2
Subnet mask : 255.255.255.0
Default router : 192.168.0.1
2� In this 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 audio: default is 5558
■ RTCP port for audio: default is 5559
■ RTP port for video: default is 5556
■ RTCP port for video: default is 5557
If you have changed the port numbers on the Network page, please open the ports accordingly on your router� For information on how to forward ports on the router, please refer to your router’s documentation�
3� Find out the public IP address of your router provided by your ISP (Internet Service
Provider)� Use the public IP and the secondary HTTP port to access the Network
Camera from the Internet� Please refer to Network Type on page 69 for details�
Internet connection with static IP
Choose this connection type if you are required to use a static IP for the Network Camera�
Please refer to LAN settings on page 69 for details�
Internet connection via PPPoE (Point-to-Point over Ethernet)
User's Manual - 15
VIVOTEK
For example, your router and IP settings may look like this:
Device
LAN IP of router
IP Address: internal port
Public IP of router 122�146�57�120
Camera 1
Camera 2
���
192�168�2�1
192.168.2.10:80
192.168.2.11:80
���
IP Address: External Port (Mapped port on the router)
122.146.57.120:8000
122.146.57.120:8001
���
Configure the router, virtual server or firewall, so that the router can forward any data coming into a preconfigured port number to a network camera on the private network, and allow data from the camera to be transmitted to the outside of the network over the same path�
From Forward to
122.146.57.120:8000 192.168.2.10:80
122.146.57.120:8001 192.168.2.11:80
��� ���
When properly configured, you can access a camera behind the router using the HTTP request as follows: http://122.146.57.120:8000
If you change the port numbers on the Network configuration page, please open the ports accordingly on your router� For example, you can open a management session with your router to configure access through the router to the camera within your local network.
Please consult your network administrator for router configuration if you have troubles with the configuration.
For more information with network configuration 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 support the UPnP port forwarding feature�
16 - User's Manual
VIVOTEK
Software Installation
Installation Wizard 2 (IW2), free-bundled software included on the product CD, helps you set up your Network Camera on the LAN�
1� Install IW2 under the Software Utility directory from the software CD�
Double-click the IW2 shortcut on your desktop to launch the program�
IW
2
Installation
Wizard 2
2� The program will conduct an analysis of your network environment�
After your network environment is analyzed, please click Next to continue the program�
3� The program will search for all VIVOTEK network devices on the same LAN�
4� After a brief search, the installer window will prompt� Click on the MAC and model name
that matches the one printed on the product label� You can then double-click on the address to open a management session with the Network Camera�
Network Camera
Model No: IB8373-EHV
MAC:0002D1730202
Ro HS
This device complies with part 15 of the FCC rules. Operation is subject to the following two conditions:
(1)This device may not cause harmful interference, and
(2) this device must accept any interference received, including interference that may cause undesired operation.
Pat. 6,930,709
Made in Taiwan
00-02-D1-73-02-02 192.168.5.151 IB8373-EHV
0002D1730202
User's Manual - 17
VIVOTEK
Ready to Use
1� A browser session with the Network Camera should prompt as shown below�
2� You should be able to see live video from your camera� You may also install the 32-channel recording software from the software CD in a deployment consisting of multiple cameras� For its installation details, please refer to its related documents�
18 - User's Manual
VIVOTEK
To adjust the zoom factor and focus range
Focus window
1� The camera comes with a motorized varifocal lens module� With a web console, you can enter the Configuration > Media
> Image > Focus page to tune the image zoom and focus�
2� On this page, you can pull the Zoom and
Focus pointers, set up a Focus window, and use the Perform auto focus button to automatically obtain an optimal focus result�
You may also manually fine-tune zoom and focus using the various functional buttons�
Please refer to page 55, Media > Image >
3� You may also push the Auto Focus & Zoom buttons on the camera to obtain the same results especially when you are using camera tester for onsite adjustment�
User's Manual - 19
VIVOTEK
NOTE:
If you want to use the supplied sun shield for outdoor environments, please follow the steps below to install:
1� Tighten the supplied two hex couplers�
2� Attach the supplied sun shield to the Network Camera and slide it to the desired position�
3� Fix the sun shield with the supplied two screws�
1
2
3
Accessories
VIVOTEK also provides other accessories for versatile applications as the following illustrations. Please visit VIVOTEK's official website for more purchase information.
Corner Mount Bracket
Pole Mount Bracket
20 - User's Manual
VIVOTEK
Accessing the Network Camera
This chapter explains how to access the Network Camera through web browsers, RTSP players,
3GPP-compatible mobile devices, and VIVOTEK recording software�
Using Web Browsers
Use Installation Wizard 2 (IW2) to access the Network Cameras on LAN�
If your network environment is not a LAN, follow these steps to access the Netwotk Camera:
1� Launch your web browser (e�g�, Microsoft
®
Internet Explorer or Mozilla Firefox)�
2. Enter the IP address of the Network Camera in the address field. Press Enter�
3� The 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
NOTE:
► For Mozilla Firefox users, your browser will use Quick Time to stream the live video. If you don’t have Quick Time on your computer, please download it first, then launch the web browser�
User's Manual - 21
VIVOTEK
► By default, the Network Camera is not password-protected. To prevent unauthorized access, it is highly recommended to set a password for the Network Camera�
For more information about how to enable password protection, please refer to Security on page 87�
► 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 complete installation�
®
control� Follow the instructions to
22 - User's Manual
VIVOTEK
IMPORTANT:
•
Currently the Network Camera utilizes a
32-bit ActiveX plugin. You CAN NOT open a
management/view session with the camera using a 64-bit IE browser.
•
If you encounter this problem, try execute the Iexplore.exe program from C:\Windows\
SysWOW64. A 32-bit version of IE browser will be installed.
•
On Windows 7, the 32-bit explorer browser can be accessed from here: C:\Program
Files (x86)\Internet Explorer\iexplore.exe
•
If you experience compatibility issues between the plug-in control, you may try to uninstall the Camera Stream Controller located in: C:/Program Files (x86)/Camera
Stream Controller.
Tips:
1� The onscreen Java control can malfunction under the following situations: A PC connects 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 disable the Compatibility View on IE8 or IE9�
You may also press the F12 key to open the developer tools utility, and then change the
Browser Mode to the genuine IE8 or IE9 mode�
User's Manual - 23
VIVOTEK
Using RTSP Players
To view the streaming media using RTSP players, you can use one of the following players that support RTSP streaming�
Quick Time Player
VLC media player
2� Choose File > Open URL� A URL dialog box will pop up�
3. The address format is rtsp://<ip address>:<rtsp port>/<RTSP streaming access name for stream1 or stream2>
As most ISPs and players only allow RTSP streaming through port number 554, please set the
RTSP port to 554� For more information, please refer to RTSP Streaming on page 78�
For example: rtsp://192.168.5.151:554/live.sdp
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 78 for details�
Video 16:38:01 2012/01/25
24 - User's Manual
VIVOTEK
Using 3GPP-compatible Mobile Devices
To view the streaming media through 3GPP-compatible mobile devices, make sure the Network
Camera can be accessed over the Internet� For more information on how to set up the Network
Camera over the Internet,
please refer to Setup the Network Camera over the Internet on page
To utilize this feature, please check the following settings on your Network Camera:
1� Because most players on 3GPP mobile phones do not support RTSP authentication, make sure the authentication mode of RTSP streaming is set to disable�
For more information, please refer to RTSP Streaming on page 78�
2� As the the bandwidth on 3G networks is limited, you will not be able to use a large video size�
Please set the video and audio streaming parameters as listed below�
For more information, please refer to Stream settings on page 59�
Video Mode
Frame size
Maximum frame rate
Intra frame period
Video quality (Constant bit rate)
Audio type (GSM-AMR)
MPEG-4
176 x 144
5 fps
1S
40kbps
12.2kbps
3� As most ISPs and players only allow RTSP streaming through port number 554, please set
the RTSP port to 554� For more information, please refer to RTSP Streaming on page 78�
4� Launch the player on the 3GPP-compatible mobile devices�
5� Type the following URL commands into the player�
The address format is rtsp://<public ip address of your camera>:<rtsp port>/<RTSP streaming access name for stream # with small frame size and frame rate>�
For example:
You can configure Stream #2 into the suggested stream settings as listed above for live viewing on a mobile device�
User's Manual - 25
VIVOTEK
Using VIVOTEK Recording Software
The product software CD also contains an ST7501 recording software, allowing simultaneous 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
�
26 - User's Manual
VIVOTEK
Main Page
This chapter explains the layout of the main page. It is composed of the following sections:
VIVOTEK INC� Logo, Host Name, Camera Control Area, Configuration Area, Menu, and Live
Video Window�
Resize Buttons
VIVOTEK INC.
Logo
Host Name
Configuration
Area
Camera Control
Area
Hide Button
Live View Window
VIVOTEK INC. Logo
Click this logo to visit the VIVOTEK website�
Host Name
Camera Control Area
Video Stream: This Network Camera supports multiple streams (stream 1 ~ 4) simultaneously. You can
Manual Trigger: Click to enable/disable an event trigger manually. Please configure an event setting
please go to Configuration> System > Homepage Layout > General settings > Customized button to deselect “show manual trigger button”�
Digital Output: Click to turn the digital output device on or off.
User's Manual - 27
VIVOTEK
Configuration Area
Configuration: Click this button to access the configuration page of the Network Camera. It is suggested that a password be applied to the Network Camera so that only the administrator can configure the
Network Camera. For more information, please refer to Configuration on page 37.
Language: Click this button to choose a language for the user interface. Language options are available in: English, Deutsch, Español, Français, Italiano, 日本語, Português, 簡体中文, and 繁體中文� Please
note that you can also change a language on the Configuration page; please refer to page 37.
Hide Button
You can click the hide button to hide the control panel or display the control panel�
Resize Buttons
:
Click the Auto button, the video cell will resize automatically to fit the monitor.
Click 100% is to display the original homepage size�
Click 50% is to resize the homepage to 50% of its original size�
Click 25% is to resize the homepage to 25% of its original size�
Live Video Window
■ The following window is displayed when the video mode is set to H.264:
H.264 Protocol and Media Options
Video Title
Title and Time
Zoom Indicator
Video (TPC-AV)
Video 17:08:56 2014/06/25 x4.0
2014/06/25 17:08:56
Time
Video and Audio Control Buttons
H�264 Protocol and Media Options: The transmission protocol and media options for H.264 video
streaming. For further configuration, please refer to Client Settings on page 32.
28 - User's Manual
VIVOTEK
PTZ Panel: This Network Camera supports “digital“ (e-PTZ) pan/tilt/zoom control, which allows roaming
Global View: Click on this item to display the Global View window� The Global View window contains a full view image (the largest frame size of the captured video) and a floating frame (the viewing region of the current video stream). The floating frame allows users to control the e-PTZ function (Electronic Pan/
Tilt/Zoom)� For more information about e-PTZ operation, please refer to E-PTZ Operation on page 98�
The viewing region of the current video stream
The largest frame size
NOTE:
1� For a megapixel camera, it is recommended to use monitors of the 24" size or larger, and are capable of 1600x1200 or better resolutions�
2� The video input is "muted" by default� To receive audio into from external microphone, you
need to enable the audio input from Media > Audio� Refer to page 68 for more information�
NOTE:
Quick Time player only supports playback of H.264 stream, and not the MJPEG stream. In terms of audio codec, Quick Time only supports AAC� Since this camera supports G�711 codec, audio is not available on Quick Time�
VLC player supports H.264/MPEG-4/MJPEG, and all audio codecs supported by VIVOTEK’s cameras.
User's Manual - 29
VIVOTEK
Video and Audio Control Buttons: Depending on the Network Camera model and Network Camera configuration, some buttons may not be available.
Snapshot: Click this 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 different area you want to magnify, drag the navigation screen�
Pause: Pause the transmission of the streaming media. The button becomes the Resume button after clicking the Pause button�
Stop: Stop the transmission of the streaming media. Click the Resume button to continue transmission�
Start MP4 Recording: Click this button to record video clips in MP4 file format to your computer.
Press the Stop MP4 Recording button to end recording� When you exit the web browser, video
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 after clicking the Mute button�
Talk: Click this button to talk to people around the Network Camera. Audio will project from the external speaker connected to the Network Camera� Click this button again to end talking transmission�
Mic Volume: When the Mute function is not activated, move the slider bar to adjust the microphone volume on the local computer�
Mute: Turn off the Mic volume on the local computer� The button becomes the Mic On button after clicking the Mute button�
Full Screen: Click this button to switch to full screen mode. Press the “Esc” key to switch back to normal mode�
30 - User's Manual
■ The following window is displayed when the video mode is set to MJPEG:
Video Title
Title and Time
Video (HTTP-V)
Video 17:08:56 2014/09/25
2014/09/25 17:08:56
Time
VIVOTEK
Video Control Buttons
Time: Display the current time. For more information, please refer to Media > Image on page 51.
Video and Audio Control Buttons: Depending on the Network Camera model and Network Camera configuration, some buttons may not be available.
Snapshot: Click this 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 different area you want to magnify, drag the navigation screen�
Start MP4 Recording: Click this button to record video clips in MP4 file format to your computer.
Press the Stop MP4 Recording button to end recording� When you exit the web browser, video
Options on page 33 for details�
Full Screen: Click this button to switch to full screen mode. Press the “Esc” key to switch back to normal mode�
User's Manual - 31
VIVOTEK
Client Settings
This chapter explains how to select the stream transmission mode and saving options on the local computer� When completed with the settings on this page, click Save on the page bottom to enable the settings�
H.264 Media Options
H.264 Media Options
Select to stream video or audio data or both� This is enabled only when the video mode is set to H�264�
H.264 Protocol Options
H.264 Protocol Options
Depending on your network environment, there are four transmission modes of H.264 streaming:
UDP unicast: This protocol allows for more real-time audio and video streams. However, network packets may be lost due to network burst traffic and images may be broken. Activate UDP connection when occasions require time-sensitive responses and the video quality is less important� Note that each 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 utilize this feature, the Network Camera must
be configured to enable multicast streaming at the same time� For more information, please refer to
TCP: This protocol guarantees the complete delivery of streaming data and thus provides better video quality� The downside of this protocol is that its real-time effect is not as good as that of the UDP protocol�
HTTP: This protocol allows the same quality as TCP protocol without needing to open specific ports for streaming under some network environments� Users inside a firewall can utilize this protocol to allow streaming data through�
32 - User's Manual
VIVOTEK
Two way audio
Select one of the checkboxes to determine if the audio transmission in and out of the camera is performed in half- or full-duplex mode�
MP4 Saving Options
Users can record live video as they are watching it by clicking Start MP4 Recording on the main page. Here, you can specify the storage destination and file name.
Folder: Specify a storage destination for the recorded video files. The location can be changed.
File name prefix: Enter the text that will be appended to the front of the video file name. A specified folder will be automatically created on your local hard disk�
Add date and time suffix to the file name: Select this option to append the date and time to the end of the file name.
CLIP_ 20110628-180853
File name prefix
Date and time suffix
The format is: YYYYMMDD_HHMMSS
Local Streaming Buffer Time
In a busy network, fluctuations in available bandwidth can occur� Video streaming may lag and may not proceed very smoothly� If you enable this option, video streams from the camera will be temporarily stored on the computer’s cache memory for a configurable period of time (seconds or milliseconds) before being played on a web session� This will help you see the streaming more smoothly� If you enter
3,000 Millisecond, the streaming will delay for 3 seconds�
User's Manual - 33
VIVOTEK
Joystick Settings
Enable Joystick
Connect to the USB plug of the joystick to a USB port on your management computer� Once a
USB joystick is connected, the related joystick configuration will be available on the Client settings window� The joystick should work properly without installing any other driver or software�
Then you can begin to configure the joystick settings of connected devices� Please follow the instructions below to enable joystick settings�
1. Click on the Configure buttons button. If your joystick is working properly, it will be displayed on the drop-down list�
34 - User's Manual
VIVOTEK
Buttons Configuration
In the Joystick Settings window, you can use the combinations of pull-down menus, Actions and
Button number, to assign joystick buttons with different functions� The number of buttons may differ from the joystick you attached�
Please follow the steps below to configure your joystick buttons:
1. Select the number of the button you want to configure from its pull-down list.
For example: Assign Preset 1 (move to preset 1 position) to Button 1�
2� Select an action from the Actions menu� Click Assign to associate the button with an action�
3. Your configuration will be automatically saved.
4� To disable an assignment, select the number of a button, and then click the Delete button� The associated action will then be cleared�
5� Repeat the above process to assign actions to other buttons� When done, simply close the configuration window.
User's Manual - 35
VIVOTEK
NOTE:
• If you want to assign Preset actions to your joystick, the PTZ preset locations should be configured in advance�
• If your joystick is not working properly, it may need to be calibrated� Click the Calibrate button to open the Game Controllers window located in Microsoft Windows control panel and follow the instructions for trouble shooting�
• The joystick will appear in the Game Controllers list in the Windows Control panel� If you want to check out for your devices, go to the following page: Start -> Control Panel -> Game Controllers�
• Follow the onscreen instructions to calibrate your joystick�
36 - User's Manual
VIVOTEK
Configuration
Click Configuration on the main page to enter the camera setting pages� Note that only
Administrators can access the configuration page� Please refer to page 87 Security > User
Account for how to configure access rights for different users.
Navigation Area
Configuration List
Firmware Version
Each function on the configuration list will be explained in the following sections.
Navigation Area provides an instant switch among Home page (the monitoring page for live viewing),
Configuration page, and multi-language selection�
User's Manual - 37
VIVOTEK
System > General settings
This section explains how to configure the basic settings for the Network Camera, such as the host name and system time. It is composed of the following two columns: System and System
Time�
System
Host name: Enter a desired name for the Network Camera. The text will be displayed at the top of the main page�
Turn off the LED indicator: Click to disable the onboard LEDs.
System time
Keep current date and time: Select this option to preserve the current date and time of the Network
Camera� The Network Camera’s internal real-time clock maintains the date and time even when the power of the system is turned off�
Synchronize with computer time: Select this option to synchronize the date and time of the Network
Camera with the local computer� The read-only date and time of the PC is displayed as updated�
Manual: The administrator can enter the date and time manually. Note that the date and time format are
[yyyy/mm/dd] and [hh:mm:ss].
Automatic: The Network Time Protocol is a protocol which synchronizes computer clocks by periodically querying an NTP Server�
NTP server: Assign the IP address or domain name of the time-server. Leaving the text box blank connects the Network Camera to the default time servers�
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 45 for details�
38 - User's Manual
VIVOTEK
System > Homepage layout
This section explains how to set up your own customized homepage layout�
General settings
This column shows the settings of your hompage layout� You can manually select the background and font colors in Theme Options (the second tab on this page)� The settings will be displayed automatically in this Preview field. The following shows the homepage 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 link if necessary�
5� Click Save to enable the settings�
Customized button
If you want to hide manual trigger buttons on the homepage, please uncheck this item� This item is checked by default�
User's Manual - 39
VIVOTEK
Theme Options
Here you can change the color of your homepage layout� There are three types of preset patterns for 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
Font Color
Background Color of the
Control Area
Font Color of the Configuration Area
Background Color of the
Configuration Area
Preset patterns
Background Color of the Video Area
Frame Color
40 - User's Manual
VIVOTEK
■ Follow the steps below to set up the customed homepage:
1� Click Custom on the left column�
2. Click the field where you want to change the color on the right column.
Color Selector
Custom
Pattern
3� The palette window will pop up as shown below�
2
1
4
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�
3
User's Manual - 41
VIVOTEK
System > Logs
This section explains how to configure the Network Camera to send the system log to a remote server as backup�
Log server settings
Follow the steps below to set up the remote log:
1� Select Enable remote log�
2� In the IP address text box, enter the IP address of the remote server�
2� In the port text box, enter the port number of the remote server�
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
This column displays the system log in a chronological order� The system log is stored in the Network
Camera’s buffer area and will be overwritten when reaching a certain limit�
42 - User's Manual
VIVOTEK
Access log
Access log displays the access time and IP address of all viewers (including operators and administrators) in a chronological order� The access log is stored in the Network Camera’s buffer 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�
User's Manual - 43
VIVOTEK
System > Maintenance
This chapter explains how to restore the Network Camera to factory default, upgrade firmware version, etc�
General settings > Upgrade firmware
This feature allows you to upgrade the firmware of your Network Camera� It takes a few minutes to complete the process�
Note: Do not power off the Network Camera during the upgrade!
Follow the steps below to upgrade the firmware:
1. Download the latest firmware file from the VIVOTEK website. The file is in .pkg file format.
2� Click Browse… and specify the firmware file.
3� Click Upgrade� The Network Camera starts to upgrade and will reboot automatically when the upgrade
completes�
If the upgrade is successful, you will see “Reboot system now!! This connection will close”� After that, reaccess the Network Camera�
The following message is displayed when the upgrade has succeeded�
Reboot system now!!
This connection will close.
The following message is displayed when you have selected an incorrect firmware file.
Starting firmware upgrade...
Do not power down the server during the upgrade.
The server will restart automatically after the upgrade is completed.
This will take about 1 - 5 minutes.
Wrong PKG file format
Unpack fail
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 will be displayed in your browser� The following message will be displayed during the reboot process�
If the connection fails after rebooting, manually enter the IP address of the Network Camera in the address field to resume the connection.
44 - User's Manual
VIVOTEK
General settings > Restore
This feature allows you to restore the Network Camera to factory default settings�
Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to
Import/Export files below on this page).
Custom Language: Select this option to retain the Custom Language settings.
VADP: Retain the VADP modules (3rd-party software stored on the SD card) and related settings.
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 configuration file: Click to set the start and end time of DST (Daylight Saving).
Follow the steps below to export:
1. In the Export files column, click Export to export the daylight saving time configuration file from the
Network Camera�
2. A file download dialog will pop up as shown below. Click Open to review the XML file or click Save to store the file for editing.
User's Manual - 45
VIVOTEK
3. Open the file with Microsoft
®
Notepad and locate your time zone; set the start and end time of DST�
When completed, save the file.
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.
46 - User's Manual
The following message is displayed when attempting to upload an incorrect file format.
VIVOTEK
Export language file: Click to export language strings. VIVOTEK provides nine languages: English,
Deutsch, Español, Français, Italiano, 日本語, Português, 簡体中文, and 繁體中文�
Update custom language file: Click Browse… and specify your own custom language file to upload.
Export configuration file: Click to export all parameters for the device and user-defined scripts.
Update configuration file: Click Browse… to update a configuration file. Please note that the model and firmware version of the device should be the same as the configuration file. If you have set up a fixed IP or other special settings for your device, it is not suggested to update a configuration file.
Export server staus 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:
(1) Power disconnected during firmware upgrade.
(2) Unknown reason causing abnormal LED status, and a Restore cannot recover normal working condition�
You can use the following methods to activate the camera with its backup firmware:
(1) Press and hold down the reset button for at least one minute�
(2) Power on the camera until the Red LED blinks rapidly�
(3) After boot up, the firmware should return to the previous version before the camera hanged. (The procedure should take 5 to 10 minutes, longer than the normal boot-up process)� When tthis process is completed, the LED status should return to normal�
User's Manual - 47
VIVOTEK
Media > Image
This section explains how to configure the image settings of the Network Camera� It is composed of the following four columns: General settings, Picture settings, Exposure, and
Privacy mask�
General settings
Video title
Show_timestamp_and video_title_in_video_and_snapshots: Enter a name that will be displayed on the title bar of the live video as the picture shown below�
Video Title
Title and Time
Video 17:08:56 2014/09/09
2014/09/09 17:08:56
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. Color: Select to display color or black/white video streams�
Power line frequency: Set the power line frequency consistent with local utility settings to eliminate image flickering associated with fluorescent lights� Note that after the power line frequency is changed, you must disconnect and reconnect the power cord of the Network Camera in order for the new setting to take effect�
Video orientation: Flip--vertically reflect the display of the live video; Mirror--horizontally reflect the display of the live video� Select both options if the Network Camera is installed upside-down (e�g�, on the ceiling) to correct the image orientation� Please note that if you have preset locations, those locations will be cleared after flip/mirror setting.
48 - User's Manual
VIVOTEK
Day/Night Settings
Switch to B/W in night mode
Select this to enable the Network Camera to automatically switch to Black/White during night mode�
Turn on external IR illuminator in night mode
Select this to turn on an external IR illuminator (connected via Digital Output lines) when the camera detects low light condition and enters the night mode�
Turn on built-in IR illuminator in night mode
Select this to turn on the built-in IR illuminators (effective range up to 20 meters) when the camera detects low light condition and enters the night mode�
Smart IR
When enabled, the camera automatically adjust the IR projection to adjacent objects in order to avoid over-exposure in the night mode�
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� For a surveillance area at a greater distance, e.g., 5 meters, the Smart IR function may not bring as significant benefits as in close range�
Smart IR disabled; distance: 5M
Smart IR enabled; distance: 5M
Smart IR disabled; distance: 3M Smart IR enabled; distance: 3M
User's Manual - 49
VIVOTEK
Tips:
If there is an object in close proximity, the IR lights reflected back from it can mislead the Smart IR’s calculation of light level� To solve this issue, you can place an “Exposure Exclude” window on an unavoidable object in the Exposure setting window�
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
Exclude x
IR cut filter
With a removable IR-cut filter, this Network Camera can automatically remove the filter to let IR light into the sensor during low light conditions�
■ Auto mode
The Network Camera automatically removes the filter by judging the level of ambient light.
■ Day mode
In day mode, the Network Camera switches on the IR cut filter at all times to block infrared light from reaching the sensor so that the colors will not be distorted�
■ Night mode
In night mode, the Network Camera switches off the IR cut filter at all times for the sensor to accept infrared light, thus helping to improve low light sensitivity�
■ Synchronize with digital input
The Network Camera automatically removes the IR cut filter when a Digital Input is triggerred.
■ Schedule mode
The Network Camera switches between day mode and night mode based on a specified schedule. Enter the start and end time for day mode. Note that the time format is [hh:mm] and is expressed in 24-hour clock time. By default, the start and end time of day mode are set to 07:00 and 18:00.
Light sensor sensitivity
Select Low, Normal, or High sensitivity for the light sensor�
50 - User's Manual
Image settings
On this page, you can tune the White balance, Image adjustment and WDR enhanced �
VIVOTEK
Sensor Setting 1:
For normal situations
Sensor Setting 2:
For special situations
White balance: Adjust the value for the best color temperature.
■ You may follow the steps below to adjust the white balance to the best color temperature.
1� Place a sheet of paper of white or cooler-color temperature, such as blue, in front of the lens, then allow the Network Camera to automatically adjust the color temperature�
2� Click the On button to Fix current value and confirm the setting while the white balance is being measured�
■ You may also manually tune the color temperature by pulling the RGain and BGain slide bards.
Image Adjustment
■ Brightness: Adjust the image brightness level, which ranges from 0% to 100%.
■ Contrast: Adjust the image contrast level, which ranges from 0% to 100%.
■ Saturation: Adjust the image saturation level, which ranges from 0% to 100%.
■ Sharpness: Adjust the image sharpness level, which ranges from 0% to 100%�
■ Gamma curve: Adjust the image sharpness level, which ranges from 0�45 (Detailed) to 1
(Contrast)�
You may let firmware Optimize your display or select the Manual mode, and pull the slide bar pointer to change the preferred level of Gamma correction towards higher contrast or towards the higher luminance for detailed expression for both dark and lighted areas of an image�
■ Enable low light compensation: Select this option in low light mode, and the values of sharpness and brightness will change automatically. This function also benefits from an automated noise reduction feature�
User's Manual - 51
VIVOTEK
Noise 3D noise reduction
■ Enable noise reduction: Check to enable noise reduction in order to reduce noises and flickers in image� This applies to the onboard 3D Noise Reduction feature� Use the pull-down menu to adjust the reduction strength� Note that applying this 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 condition with fast moving objects, trails of after-images may occur� You may then select a lower strength level or disable the function�
Note that the Preview button has been cancelled, all changes made to image settings is directly shown on screen� You can click Restore to recall the original settings without incorporating the changes� When completed with the settings on this page, click Save to enable the setting� You can also click on Profile to adjust all settings above in a pop-up window for special lighting conditions�
Activated period: Select the mode this profile to apply to: Day mode, Night mode, or Schedule mode� Please manually enter a range of time if you choose Schedule mode� Then check Save to take effect�
Exposure
On this page, you can set the Measurement window, Exposure level, Exposure mode, and
Iris mode� Detailed configurations will be automatically adjusted since the sensor library will automatically adjust the value according to the ambient light�
Sensor Setting 1:
For normal situations
52 - User's Manual
Sensor Setting 2:
For special situations
VIVOTEK
Measurement Window: This function allows users to configure measurement window(s) for low light compesation�
■ Full view: Calculate the full range of view and offer appropriate light compesation�
■ Custom: This option allows you to manually add specific windows as measuring areas. The measuring window refers to “weighed window“ where the lighting condition within the particular area is taken into account� Camera firmware then adopts the weighed averages method to calculate the value�
A total of 9 inclusive and exclusive windows can be created for a view� You can create Exclude windows for the camera to ignore the lighting condition of certain areas�
Exclude x
Exclude x
Note that the title pane of the Include/
Exclude windows is not included into the calculation�
Include x
Include x
■ BLC: When selected, a BLC window will appear on screen meaning that the center of the scene will be taken as a weighed area� This option enables light compensation for images that are too dark or too bright to recognize; for example, for the dark side of objects that is posed against bright sunlight�
Exposure control:
■ Exposure level: You can manually set the Exposure level, which ranges from -2.0 to +2.0 (dark to bright)�
■ Exposure mode: Select Auto or Manual mode according to your needs�
Manual: Select Manual to set a fixed exposure time and gain. Then, tune the slide bar to set the
Exposure time and Gain Control to the best image quality� A shorter exposure time allows less amount of light to enter the sensor; while a higher gain control value generates certain amount of noises�
Auto: If you set Exposure mode as Auto, the Exposure time and Gain control will not be configurable since the sensor library will automatically adjust the value according to the ambient light� Then you can set iris mode as “indoor” or “outdoor” to reach the best image quality�
■ Iris mode: Select Indoor or Outdoor iris mode to adapt to the installation� The preset iris aperture setting will apply�
User's Manual - 53
VIVOTEK
■ WDR Pro : When enabled, you can select the strength of the WDR function. The Low, Medium,
High options correspond to the level of contrast between the overly-lit area and the shaded areas�
For example, the High option applies to a high contrast scenario� Note that when the exposure time is set to longer than 1/60 second, the WDR function will be disabled�
You can click Restore to recall the original settings without incorporating the changes� When completed with the settings on this page, click Save to enable the settings�
If you want to configure another sensor setting for day/night/schedule mode, please click Profile to open the Profile of exposure settings page as shown below.
Activated period: Select the mode this profile will apply to: Day mode, Night mode, or Schedule mode� Please manually enter a range of time if you choose the Schedule mode� Then check Save for the configuration to take effect.
Please follow the steps below to setup a profile:
1� Check Enable this profile�
2. Select the applied mode: Day mode, Night mode, or Schedule mode� Please manually enter a range of time if you choose Schedule mode�
3. Configure Exposure control settings in the folowing columns� Please refer to previous dicussions for detailed information�
4� Click Save to enable the setting and click Close to exit the page�
54 - User's Manual
VIVOTEK
Focus
The camera comes with a motorized vari-focal lens, and therefore a smart focus function panel is provided to facilitate zoom and focus configuration.
Focus window
■ Zoom: If you need to zoom in to a field of view, click and drag the pointer to the right to zoom in.
Note that the size of the field of view will also be reduced.
■ Focus: Whenever the zoom factor is changed, the focus is automatically updated� You can use the Fine-tune focus button to help achieve best image focus� When you see the live image is out of focus, you can click the focus buttons on the sides, or drag its pointer to find the best focus by draging it along the slide bar�
Fine-tune focus and Full-ranage scan focus:
Click the Fine-tune focus button for the camera to automatically find the best focus. The process takes about several seconds to complete� The pointers will move along the Focus slide bar� When the scan is completed, the Focus pointer will stay at the optimal location on the slide bar�
You may still use the “ >” or “<” buttons to fine-tune the focus depending on the live image on your screen�
User's Manual - 55
VIVOTEK
■ Full-range scan: If selected, the auto focus scan will be performed throughout the complete range of focus� The full-range scan takes a longer time to complete� A full-range scan usually takes approximately 3 minutes or longer�
■ Fully-open Iris: By default, this checkbox is selected for performing an auto scan and should provide an optimal scan result�
Focus window:
By default, the optimal focus is found on a full view window� You may designate a custom window within your current field of view to acquire the best focus out of it. However, you can not place a focus window on a distant background, e�g�, a hall way that stretches away for 3 meters or farther�
Doing so you will not benefit from the Focus window function.
■ Full view: The focus tuning takes place by referring to the full view.
■ Custom: You can create a focus window and drag it to a place of interest in your view window.
Note that it is recommended to use this function only when you have a solid object in your view window that is showing a consistent color or texture� This function will not take effect if you set the focus window on a distant background�
56 - User's Manual
VIVOTEK
Privacy mask
Click Privacy Mask to open the settings page� On this page, you can block out sensitive zones to address privacy concerns�
2014/10/09 17:08:56 2014/10/09 17:08:56
■ To set the privacy mask windows, follow the steps below:
1� Click New to add a new window�
2� You can use the mouse cursor to size and drag-drop the window, which is recommended to be at least twice the size of the object (height and width) you want to cover�
3� Enter a Window Name and click Save to enable the setting�
4� Click on the Enable privacy mask checkbox to enable this function�
NOTE:
► Up to 5 privacy mask windows can be set up on the same screen�
► If you want to delete the privacy mask window, please click the ‘x’ on the upper right corner of the window�
User's Manual - 57
VIVOTEK
Media > Video
FOV (Field of View)
Select a resolution from the list� The default is 3 Megapixels, and if bandwidth or frame rate per second is of the concern you can select a lower resolution. You can configurea the FOV to 1080P
(16:9) at 30fps.
58 - User's Manual
VIVOTEK
Stream settings
This Network Camera supports multiple streams with frame size ranging from 176 x 144 to 2028 x
1536 pixels�
The definition of multiple streams:
■ Stream 1: Users can define the "Region of Interest" (viewing region) and the "Output Frame Size"
(size of the live view window)�
■ Stream 2: The default frame size for Stream 2 is set to the minimized 640 x 480 for viewing on mobile devices�
■ Stream 3: Stream 3 does not support the "Region of Interest" configuration.
Click Viewing Window to open the viewing region settings page� On this page, you can set the
Region of Interest and the Output Frame Size for streams 1 and 2�
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 Region of Interest from the drop-down list� The floating frame, the same as the one in the Gloabl View window on the home page, will resize accordingly� If you want to set up a customized viewing region, you can also resize and drag the floating frame to a desired position with your mouse�
3� Choose a proper Output Frame Size from the drop-down list according to the size of your monitoring device�
User's Manual - 59
VIVOTEK
Click Viewing Window to open the viewing region settings page. On this page, you can configure the Region of Interest and the Output Frame Size for streams 1� 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 complete scene of the video stream� As the picture shown below, the area of your interest in a parking lot should the vehicles� The blue sky is of little value for the surveillance purpose�
60 - User's Manual
VIVOTEK
► All the items in the “Region of Interest” should not be larger than the “Output Frame Size“
(current maximum resolution)�
■ The parameters of the multiple streams:
Stream 1
Stream 2
Region of Interest Output frame size
2048 X 1536 ~ 176 x 144 (Selectable) 2048 X 1536 ~ 176 x 144 (Selectable)
2048 X 1536 ~ 176 x 144 (Selectable) 2048 X 1536 ~ 176 x 144 (Selectable) fixed fixed
When completed with the settings in the Viewing Window, click Save to enable the settings and click Close to exit the window� The selected Output Frame Size will immediately be applied to the Frame size of each video stream� Then you can go back to the home page to test the e-PTZ
function� For more information about the e-PTZ function, please refer to page 98�
Region of Interest
(Viewing Region)
Output Frame Size
(Size of the Live View Window)
User's Manual - 61
VIVOTEK
Click the stream item to display the detailed information� The maximum frame size will follow your settings in the above Viewing Window sections�
This Network Camera offers real-time H.264 and MJPEG compression standards (Triple Codec) for real-time viewing� If
H.264
mode is selected, the video is streamed via RTSP protocol� There are several parameters for you to adjust the video performance:
■ Frame size
You can set up different video resolution for different viewing devices� For example, set a smaller frame size and lower bit rate for remote viewing on mobile phones and a larger video size and a higher bit rate for live viewing on web browsers� Note that a larger frame size takes up more bandwidth�
■ Maximum frame rate
This limits the maximum refresh frame rate per second� Set the frame rate higher for smoother video quality and for recognizing moving objects in the field of view.
The below frame rates apply when the 1080P resolution is selected for a stream:
If the power line frequency is set to 50Hz, the frame rates are selectable at 1fps, 2fps, 3fps, 5fps,
8fps, 10fps, 15fps, 20fps, and 25fps� If the power line frequency is set to 60Hz, the frame rates are selectable at 1fps, 2fps, 3fps, 5fps, 8fps, 10fps, 15fps, 20fps, 25fps, and 30fps� You can also select Customize and manually enter a value�
62 - User's Manual
VIVOTEK
The frame rate will decrease if you select a higher resolution�
■ Intra frame period
Determine how often to plant an I frame� The shorter the duration, the more likely you will get better video quality, but at the cost of higher network bandwidth consumption� Select the intra frame period from the following durations: 1/4 second, 1/2 second, 1 second, 2 seconds, 3 seconds, and 4 seconds�
■
Video quality
Constant bit rate:
• Constant bit rate: A complex scene generally produces a larger file size, meaning that higher bandwidth will be needed for data transmission� The bandwidth utilization is configurable to match a selected level, resulting in mutable video quality performance. The bit rates are selectable at the following rates: 20Kbps, 30Kbps,
40Kbps, 50Kbps, 64Kbps, 128Kbps, 256Kbps, 512Kbps, 768Kbps, 1Mbps, 2Mbps,
3Mbps, 4Mbps, 6Mbps, 8Mbps, 10Mbps, 12Mbps, 14Mbps, and 16Mbps� You can also select Customize and manually enter a value�
- Target bit rate : select a bit rate from the pull-down menu. The bit rate ranges from
20kbps to a maximum of 8Mbps� The bit rate then becomes the Average or Upper bound bit rate number� The Network Camera will strive to deliver video streams around or within the bit rate limitation you impose�
- Policy: If Frame Rate Priority is selected, the Network Camera will try to maintain the frame rate per second performance, while the 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�
• Fixed quality: On the other hand, if Fixed quality is selected, all frames are transmitted with the same quality; bandwidth utilization is therefore unpredictable�
The video quality can be adjusted to the following settings: Medium, Standard, Good,
Detailed, and Excellent� You can also select Customize and manually enter a value�
- Maximum bit rate: With the guaranteed image quality, you might still want to place a bit rate limitation to control the size of video streams for bandwidth and storage concerns. The configurable bit rate starts from 1Mbps to 40Mbps.
The Maximum bit rate setting in 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�
You may also manually enter a bit rate number by selecting the Customized option�
User's Manual - 63
VIVOTEK
• Smart stream:
Smart stream can effectively reduce the video packet size while maintaining good video quality in the selected areas of your interest. When properly configured, Smart stream can reduce the stream size to half or even lower�
Unfold the Smart stream configuration menu by selecting the Smart stream checkbox.
You can then configure the following parameters:
• Foreground quality: Foreground is the area of your interest where you want to maintain its video quality. The quality can be: Customized, Medium, Standard,
Good, Detailed, or Excellent� Note that the Customized number refers to the video compression rate� The larger the number, higher the compression rate, and thus results in lower quality�
• Background quality: Background is the area that is less important on the scene, such as the building in the below drawing. You can configure the camera to produce a lower-quality display for this area. The background quality can be:
Customized, Medium, Standard, Good, Detailed, or Excellent�
• Maximum bit rate: This is an upper threshold on the bit rate per second for producing and transmitting the Smart stream video. It is configurable from 1Mbps to 40Mbps� You can also manually enter a number (in kbps)�
Background
Q= Medium or low
Foreground
Q= Good or better
64 - User's Manual
VIVOTEK
• Mode:
- Auto : When set to Auto, only the moving objects and the areas around them will be displayed with the Foreground quality� The rest of the screen will be displayed with the Background (lower) quality�
- Manual : When selected, the Manual window setting option will be displayed. Click on it to display the setting window� You can then manually allocate the regions of your interest on the current field of view. Click New, drag, and pull the window to cover the regions of your interest� Note that the title bar on each window is not taken into account when setting the Foreground areas�
You can create up to 3 ROI windows� Click Save to preserve your setting and click
Close to finish the configuration.
ROI_1
Foreground
Q= Detailed
Background
Q= Medium or low
ROI_0
Foreground
Q= Detailed
User's Manual - 65
VIVOTEK
- Hybrid : When enabled, moving objects in the Background areas will also be displayed using the Foreground (better) quality�
Note the following with the Smart stream setting:
1� When using the “Auto” or “Hybrid” modes, up to 30 moving objects can be displayed using the Foreground quality�
2� The Smart stream will not be so effective in terms of bandwidth saving when applied in a complex scene where there are objects moving constantly all over the screen�
3� You can compare the bit rates of video streaming with or without the Smart stream configuration by viewing the network traffic information. For example, you can see the information using the VLC player’s Media Information > Statistics�
4. Smart stream is only configurable with H.264 and streams #1 to #3.
66 - User's Manual
VIVOTEK
If
JPEG
mode is selected, the Network Camera sends consecutive JPEG images to the client, producing a moving effect similar to a filmstrip. Every single JPEG image transmitted guarantees the same image quality, which in turn comes at the expense of variable bandwidth usage� Because the media contents are a combination of JPEG images, no audio data is transmitted to the client.
There are three parameters provided in MJPEG mode to control the video performance:
■ Frame size
You can set up different video resolution for different viewing devices� For example, set a smaller frame size and lower bit rate for remote viewing on mobile phones and a larger video size and a higher bit rate for live viewing on web browsers� Note that a larger frame size takes up more bandwidth�
■ Maximum frame rate
This limits the maximum refresh frame rate per second� Set the frame rate higher for smoother video quality�
If the power line frequency is set to 50Hz, the frame rates are selectable at 1fps, 2fps, 3fps, 5fps,
8fps, 10fps, 15fps, 20fps, and 25fps� If the power line frequency is set to 60Hz, the frame rates are selectable at 1fps, 2fps, 3fps, 5fps, 8fps, 10fps, 15fps, 20fps, 25fps, and 30fps� You can also select Customize and manually enter a value� The frame rate will decrease if you select a higher resolution�
■ Video quality
Refer to the previous page setting an average or upper bound threshold for controlling the bandwidth consumed for transmitting motion jpegs. The configuration method is identical to that for H�264�
NOTE:
► Video quality and fixed quality refers to the compression rate, so a lower value will produce higher quality�
► Converting high-quality video may significantly increase the CPU loading, and you may encounter streaming disconnection or video loss while capturing a complicated scene� In the event of occurance, we suggest you customize a lower video resolution or reduce the frame rate to obtain smooth video�
User's Manual - 67
VIVOTEK
Media > Audio
Audio Settings
Mute: Select this option to disable audio transmission from the Network Camera to all clients. Note that if muted, no audio data will be transmitted even if audio transmission is enabled on the Client
Settings page. In that case, the following message is displayed:
External microphone input gain: Select the gain of the external audio input according to ambient conditions� Adjust the gain from 100% (most sensitive) to 0% (least sensitive)�
Audio type: Select audio codec AAC or GSM-AMR and the bit rate.
■ AAC provides good sound quality at the cost of higher bandwidth consumption. The bit rates are selectable from: 16Kbps, 32Kbps, 48Kbps, 64Kbps, 96Kbps, and 128Kbps.
■ G.711 also provides good sound quality and requires about 64Kbps. Select pcmu (μ-Law) or pcma (A-Law) mode�
■ G.726 is a speech codec standard covering voice transmission at rates of 16, 24, 32, and 40kbit/ s�
When completed with the settings on this page, click Save to enable the settings�
68 - User's Manual
VIVOTEK
Network > General settings
This section explains how to configure a wired network connection for the Network
Camera�
Network Type
LAN
Select this option when the Network Camera is deployed on a local area network (LAN) and is intended to be accessed by local computers� The default setting for the Network Type is LAN�
Rememer to click Save when you complete the Network setting�
Get IP address automatically: Select this option to obtain an available dynamic IP address assigned by the DHCP server each time the camera is connected to the LAN�
Use fixed IP address: Select this option to manually assign a static IP address to the Network
Camera�
1� You can make use of VIVOTEK Installation Wizard 2 on the software CD to easily set up the
Network Camera on LAN� Please refer to Software Installation on page 17 for details�
2� Enter the Static IP, Subnet mask, Default router, and Primary DNS provided by your ISP�
Subnet mask: This is used to determine if the destination is in the same subnet. The default value is “255�255�255�0”�
Default router: This is the gateway used to forward frames to destinations in a different subnet.
Invalid router setting will fail the transmission to destinations in different subnet�
User's Manual - 69
VIVOTEK
Primary DNS: The primary domain name server that translates hostnames into IP addresses.
Secondary DNS: Secondary domain name server that backups the Primary DNS.
Primary WINS server: The primary WINS server that maintains the database of computer names and IP addresses�
Secondary WINS server: The secondary WINS server that maintains the database of computer names and IP addresses�
Enable UPnP presentation: Select this option to enable UPnP
TM
presentation for your Network
Camera so that whenever a Network Camera is presented to the LAN, shortcuts of connected
Network Cameras will be listed in My Network Places� You can click the shortcut to link to the web browser� Currently, UPnP
TM please make sure the UPnP
is supported by Windows XP or later� Note that to utilize this feature,
TM
component is installed on your computer�
Mega-pixel Network Camera (192.168.5.151)
Enable UPnP port forwarding: To access the Network Camera from the Internet, select this option to allow the Network Camera to open ports automatically on the router so that video streams can be sent out from a LAN� To utilize of this feature, make sure that your router supports UPnP
TM it is activated�
and
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 the steps below to acquire your Network Camera’s public IP address�
1� Set up the Network Camera on the LAN�
2. Go to Configuration > Event > Event settings > Add server (please refer to Add server on page
107) to add a new email or FTP server�
3. Go to Configuration > Event > Event settings > Add media (please refer to Add media on page
Select System log so that you will receive the system log in TXT file format which contains the
Network Camera’s public IP address in your email or on the FTP server�
4. Go to Configuration > Network > General settings > Network type. Select PPPoE and enter the user name and password provided by your ISP� Click
Save to enable the setting�
5� The Network Camera will reboot�
6� Disconnect the power to the Network Camera; remove it from the LAN environment�
70 - User's Manual
VIVOTEK
NOTE
NOTE:
► If the default ports are already used by other devices connected to the same router, the Network
Camera will select other ports for the Network Camera�
► If UPnP TM is not supported by your router, you will see the following message:
Error: Router does not support UPnP port forwarding.
► Steps to enable the UPnP TM user interface on your computer:
Note that you must log on to the computer as a system administrator to install the UPnP components�
TM
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 box, select Networking Services and click
Details�
User's Manual - 71
VIVOTEK
4� In the Networking Services dialog box, select
Universal Plug and Play and click OK�
5� Click
Next in the following window�
6� Click
Finish� UPnP TM
is enabled�
► How does UPnP
UPnP
TM
TM
work?
networking technology provides automatic IP configuration and dynamic discovery of devices added to a network� Services and capabilities offered by networked devices, such as printing and file sharing, are available among each other without the need for cumbersome network configuration. In the case of Network Cameras, you will see Network Camera shortcuts under My Network Places�
► 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 Camera’s IP address�
From the Internet http://203.67.124.123:8080
In LAN http://192.168.4.160 or http://192.168.4.160:8080
► If the PPPoE settings are incorrectly configured or the Internet access is not working, restore
the Network Camera to factory default; please refer to Restore on page 45 for details� After the
Network Camera is reset to factory default, it will be accessible on the LAN�
72 - User's Manual
VIVOTEK
Enable IPv6
Select this option and click Save to enable IPv6 settings�
Please note that this only works if your network environment and hardware equipment support
IPv6� The browser should be Microsoft
®
Internet Explorer 6�5, Mozilla Firefox 3�0 or 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:
Refers to Ethernet
Link-global IPv6 address/network mask
Link-local IPv6 address/network mask
User's Manual - 73
VIVOTEK
Please follow the steps below to link to an IPv6 address:
1� Open your web browser�
2� Enter the link-global or link-local IPv6 address in the address bar of your web browser�
3. The format should be:
http:// [ 2001:0c08:2500:0002:0202:d1ff:fe04:65f4 ] /
IPv6 address
4� Press Enter on the keyboard or click Refresh button to refresh the webpage�
For example:
NOTE:
► If you have a Secondary HTTP port (the default value is 8080), you can also link to the webpage
http:// [ 2001:0c08:2500:0002:0202:d1ff:fe04:65f4 ] / :8080
IPv6 address
Secondary HTTP port
► 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, the following blanks will be displayed for you to enter the corresponding information:
74 - User's Manual
VIVOTEK
Port
HTTPS port: By default, the HTTPS port is set to 443. It can also be assigned to another port number between 1025 and 65535�
Two way audio port: By default, the two way audio port is set to 5060. Also, it can also be assigned to another port number between 1025 and 65535�
The Network Camera supports two way audio communication so that operators can transmit and receive audio simultaneously� By using the Network Camera’s built-in or external microphone and an external speaker, you can communicate with people around the Network Camera�
Note that as JPEG only transmits a series of JPEG images to the client, to enable the two-way audio function, make sure the video mode is set to “H�264” on the Media > Video > Stream settings page and the media option is set to “Media > Video > Stream settings” on the Client Settings page�
Please refer to Client Settings on page 32 and Stream settings on page 59�
Audio transmitted to operators
America
Audio transmitted from operators
Taiwan
User's Manual - 75
VIVOTEK
Audio is being transmitted to the Network Camera
2014/06/09 17:08:56
Mute
Talk Button
Mic Volume
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�
FTP port: The FTP server allows the user to save recorded video clips. You can utilize VIVOTEK's
Installation Wizard 2 to upgrade the firmware via FTP server. By default, the FTP port is set to 21.
It also can be assigned to another port number between 1025 and 65535�
76 - User's Manual
VIVOTEK
Network > Streaming protocols
HTTP streaming
To utilize HTTP authentication, make sure that your have set a password for the Network Camera
first; please refer to Security > User account on page 87 for details.
Authentication: Depending on your network security requirements, the Network Camera provides two types of security settings for an HTTP transaction: basic and digest.
If
basic
authentication is selected, the password is sent in plain text format and there can be potential risks of being intercepted� If
digest
authentication is selected, user credentials are encrypted using MD5 algorithm and thus provide better protection against unauthorized accesses�
HTTP port / Secondary HTTP port: By default, the HTTP port is set to 80 and the secondary HTTP port is set to 8080� They can also be assigned to another port number 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�
On the LAN http://192.168.4.160 or http://192.168.4.160:8080
Access name for stream 1 ~ 3: This Network camera supports multiple streams simultaneously.
The access name is used to differentiate the streaming source� Users can click
Media > Video >
When using Mozilla Firefox to access the Network Camera and the video mode is set to JPEG, users will receive video comprised of continuous JPEG images. This technology, known as “server push”, allows the Network Camera to feed live pictures to Mozilla Firefox and Netscape�
User's Manual - 77
VIVOTEK
URL command -- http://<ip address>:<http port>/<access name for stream 1, 2, or 3>
For example, when the Access name for stream 2 is set to video2�mjpg :
1� Launch Mozilla Firefox or Netscape�
2� Type the above URL command in the address bar� Press Enter�
3. The JPEG images will be displayed in your web browser.
http://192.168.5.151/video2.mjpg
NOTE
NOTE:
► Microsoft
®
Internet Explorer does not support server push technology; therefore, using http://<ip address>:<http port>/<access name for stream 1, 2, or 3> will fail to access the Network
Camera�
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 > User account on page 87 for details.
78 - User's Manual
VIVOTEK
Authentication: Depending on your network security requirements, the Network Camera provides three types of security settings for streaming via RTSP protocol: disable, basic, and digest.
If
basic
authentication is selected, the password is sent in plain text format, but there can be potential risks of it being intercepted� If
digest
authentication is selected, user credentials are encrypted using MD5 algorithm, thus providing better protection against unauthorized access�
The availability of the RTSP streaming for the three authentication modes is listed in the following table:
Quick Time player VLC
Disable
Basic
Digest
O
O
O
O
O
X
Access name for stream 1 ~ 3: This Network camera supports multiple streams simultaneously.
The access name is used to differentiate the streaming source�
If you want to use an RTSP player to access the Network Camera, you have to set the video mode to H�264 and use the following RTSP URL command to request transmission of the streaming data� rtsp://<ip address>:<rtsp port>/<access name for stream 1 to 3>
For example, when the access name for stream 1 is set to 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�
Video 16:38:01 2012/01/25 rtsp://192.168.5.151:554/live.sdp
RTSP port /RTP port for video, audio/ RTCP port for video, audio
■ RTSP (Real-Time Streaming Protocol) controls the delivery of streaming media. By default, the port number is set to 554�
■ The RTP (Real-time Transport Protocol) is used to deliver video and audio data to the clients. By default, the RTP port for video is set to 5556 and the RTP port for audio is set to 5558�
■ The RTCP (Real-time Transport Control Protocol) allows the Network Camera to transmit the data by monitoring the Internet traffic volume. By default, the RTCP port for video is set to 5557 and the RTCP port for audio is set to 5559�
The ports can be changed to values between 1025 and 65535� The RTP port must be an even number and the RTCP port is the RTP port number plus one, and thus is always an odd number�
When the RTP port changes, the RTCP port will change accordingly�
If the RTP ports are incorrectly assigned, the following warning message will be displayed:
User's Manual - 79
VIVOTEK
Multicast settings for stream 1, 2, and 3: Click the items to display the detailed configuration information� Select the Always multicast option to enable multicast for stream 1 or 2�
Unicast video transmission delivers a stream through point-to-point transmission; multicast, on the other hand, sends a stream to the multicast group address and allows multiple clients to acquire the stream at the same time by requesting a copy from the multicast group address� Therefore, enabling multicast can effectively save Internet bandwith�
The ports can be changed to values between 1025 and 65535� The multicast RTP port must be an even number and the multicast RTCP port number is the multicast RTP port number plus 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
0
1
32
64
128
255
Scope
Restricted to the same host
Restricted to the same subnetwork
Restricted to the same site
Restricted to the same region
Restricted to the same continent
Unrestricted in scope
80 - User's Manual
VIVOTEK
Network > DDNS
This section explains how to configure the dynamic domain name service for the Network
Camera� DDNS is a service that allows your Network Camera, especially when assigned with a dynamic IP address, to have a fixed host and domain name.
Express link
Express Link is a free service provided by VIVOTEK server, which allows users to register a domain name for a network device� One URL can only be mapped to one MAC address�
This service will check out if the host name is valid and automatically open a port on your router� Unlike DDNS, the user has to manually check out UPnP port forwarding, Express
Link is more convenient and easy to set up�
Please follow the steps below to enable Express Link:
1� Make sure that your router supports UPnP port forwarding and it is activated�
2� Check Enable express link�
3� Enter a host name for the network device and click Save� If the host name has been used by another device, a warning message will show up� If the host name is valid, it will show a message as shown below� https://0002D1123456.2bthere.net
User's Manual - 81
2010/12/10 17:08:56
VIVOTEK
Manual setup
DDNS: Dynamic domain name service
Enable DDNS: Select this option to enable the DDNS setting.
Provider: Select a DDNS provider from the provider drop-down list.
VIVOTEK offers
Safe100.net
, a free dynamic domain name service, to VIVOTEK customers� It is recommended that you register
Safe100.net
to access VIVOTEK’s Network Cameras from the
Internet� Additionally, we offer other DDNS providers, such as Dyndns�org(Dynamic), Dyndns� org(Custom), TZO�com, DHS�org, CustomSafe100, dyn-interfree�it�
Note 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 will be displayed in the DDNS Registration Result column�
[Register] Successfully Your account information has been mailed to registered e-mail address
3� Click Copy and all the registered information will automatically be uploaded to the corresponding fields in the DDNS column at the top of the page as seen in the picture.
82 - User's Manual
VIVOTEK
[Register] Successfully Your account information has been mailed to registered e-mail address
4� Select Enable DDNS and click Save to enable the setting�
■ CustomSafe100
VIVOTEK offers documents to establish a CustomSafe100 DDNS server for distributors and system integrators� You can use CustomSafe100 to register a dynamic domain name if your distributor or system integrators offer such services�
1� In the DDNS column, select CustomSafe100 from the drop-down list�
2. In the 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 button if you have forgotten the key to Safe100.net or CustomSafe100. Your account information will be sent to your email address�
Refer to the following links to apply for a dynamic domain account when selecting other
DDNS providers:
■ Dyndns�org(Dynamic) / Dyndns�org(Custom) : visit http://www.dyndns.com/
User's Manual - 83
VIVOTEK
Network > QoS (Quality of Service)
Quality of Service refers to a resource reservation control mechanism, which guarantees a certain quality to different services on the network� Quality of service guarantees are important if the network capacity is insufficient, especially for real-time streaming multimedia applications. Quality can be defined as, for instance, a maintained level of bit rate, low latency, no packet dropping, etc.
The following are the main benefits of a QoS-aware network:
■
The ability to prioritize traffic and guarantee a certain level of performance to the data flow.
■
The ability to control the amount of bandwidth each application may use, and thus provide higher reliability and stability on the network�
Requirements for QoS
To utilize QoS in a network environment, the following requirements must be met:
■
All network switches and routers in the network must include support 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 queuing disciplines to forward the packets�
Below is the setting column for CoS� Enter the VLAN ID of your switch (0~4095) and choose the priority for each application (0~7)�
If you assign Video the highest level, the switch will handle video packets first.
NOTE
NOTE:
► A VLAN Switch (802.1p) is required. The web browsing may fail if the CoS setting is incorrect.
► Class of Service technologies do not guarantee a level of service in terms of bandwidth and delivery time; they offer a "best-effort�" Users can think of CoS as "coarsely-grained" traffic control and QoS as "finely-grained" traffic control.
► Although CoS is simple to manage, it lacks scalability and does not offer end-to-end guarantees since it is based on L2 protocol�
84 - User's Manual
VIVOTEK
QoS/DSCP (the DiffServ model)
DSCP-ECN defines QoS at Layer 3 (Network Layer). The Differentiated Services (DiffServ) model is based on packet marking and router queuing disciplines. The marking is done by adding a field to the IP header, called the DSCP (Differentiated Services Codepoint)� This is a 6-bit field that provides 64 different class IDs� It gives an indication of how a given packet is to be forwarded, known as the Per Hop Behavior (PHB)� The PHB describes a particular service level in terms of bandwidth, queueing theory, and dropping (discarding the packet) decisions� Routers at each network node classify packets according to their DSCP value and give them a particular forwarding treatment; for example, how much bandwidth to reserve for it�
Below are the setting options of DSCP (DiffServ Codepoint)� Specify the DSCP value for each application (0~63)�
User's Manual - 85
VIVOTEK
Network > SNMP
(Simple Network Management Protocol)
This section explains how to use the SNMP on the network camera� The Simple Network
Management Protocol is an application layer protocol that facilitates the exchange of management information between network devices� It helps network administrators to remotely manage network devices and find, solve network problems with ease.
■ The SNMP consists of the following three key components:
1. Manager: Network-management station (NMS), a server which executes applications that monitor and control managed devices�
2. Agent: A network-management software module on a managed device which transfers the status of managed devices to the NMS�
3. Managed device: A network node on a managed network. For example: routers, switches, bridges, hubs, computer hosts, printers, IP telephones, network cameras, web server, and database�
Before configuring SNMP settings on the this page, please enable your NMS first.
SNMP Configuration
Enable SNMPv1, SNMPv2c
Select this option and enter the names of Read/Write community and Read Only community according to your NMS settings�
Enable SNMPv3
This option contains cryptographic security, a higher security level, which allows you to set the
Authentication password and the Encryption password�
■ Security name: According to your NMS settings, choose Read/Write or Read Only and enter the community name�
■ Authentication type: Select MD5 or SHA as the authentication method.
■ Authentication password: Enter the password for authentication (at least 8 characters).
■ Encryption password: Enter a password for encryption (at least 8 characters).
86 - User's Manual
VIVOTEK
Security > User Account
This section explains how to enable password protection and create multiple accounts�
Root Password
The administrator account name is “root”, which is permanent and can not be deleted� If you want to add more accounts in the Manage User column, please apply the password for the “root” account first.
1� Type the password identically in both text boxes, then click Save to enable password protection�
2� A window will be prompted for authentication; type the correct user’s name and password in their respective fields to access the Network Camera.
Privilege Management
Digital Output & PTZ control: You can modify the management privilege for operators or viewers.
Select or deselect the checkboxes, 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 check this item, any client can access the live stream without entering a User ID and Password�
Account Management
Administrators can create up to 20 user accounts�
1� Input the new user’s name and password�
2� Select the privilege level for the new user account� Click Add to enable the setting�
Access rights are sorted by user privilege (Administrator, Operator, and Viewer)� Only administrators can access the Configuration page� Although operators cannot access the
Configuration page, they can use the URL Commands to get and set the value of parameters. For
more information, please refer to URL Commands of the Network Camera on page 135� Viewers
can only access the main page for live viewing�
Here you also can change a user’s access rights or delete user accounts�
1� Select an existing account to modify�
2� Make necessary changes and click Update or Delete to enable the setting�
User's Manual - 87
VIVOTEK
Security > HTTPS
(Hypertext Transfer Protocol over SSL)
This section explains how to enable authentication and encrypted communication over
SSL (Secure Socket Layer)� It helps protect streaming data transmission over the Internet on higher security level�
Create and Install Certificate Method
Before using HTTPS for communication 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 Information will automatically be displayed as shown below. You can click
Certifi-
cate properties to view detailed information about the certificate.
88 - User's Manual
VIVOTEK
5� Click Home to return to the main page� Change the 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://
https://192.168.5.151/index.html
User's Manual - 89
VIVOTEK
Create certificate and install
: Select this option if you want to create a certificate from a certification authority.
1� Select this option from a method pull-down menu�
2� Click Create certificate to generate the certificate.
3� The following information will appear in a pop-up window after clicking Create� 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�
90 - User's Manual
VIVOTEK
4. The Certificate Information will automatically be displayed in the third column as shown below.
You can click Property to see detailed information about the certificate.
5. Copy the contents of the Certificate request (in PEM format). Use the contents to apply for a
3rd-party certification authority such as Symantec VeriSign. Wait for the certificate authority to issue an SSL certificate; click Browse to search for the issued certificate, and then click Upload to finish the process.
User's Manual - 91
VIVOTEK
NOTE
NOTE:
► How do I cancel the HTTPS settings?
1� Click on the Remove certificate button�
2� If you are currently running a secure connection The webpage will redirect to a non-HTTPS page automatically�
Enable HTTPS
Check this item to enable HTTPS communication, then select a connection option: "HTTP &
HTTPS" or "HTTPS only". Note that you have to create and install a certificate first before clicking the Save button�
92 - User's Manual
VIVOTEK
Security > Access List
This section explains how to control access permission by verifying the client PC’s IP address�
General Settings
Maximum number of concurrent streaming connection(s) limited to: Simultaneous live viewing for
1~10 clients (including stream 1 to stream 3)� The default value is 10� If you modify the value and click Save, all current connections will be disconnected and automatically attempt to re-link (IE
Explorer or Quick Time Player)�
View Information: Click this button to display the connection status window showing a list of the current connections. For example:
Note that only consoles that are currently displaying live streaming will be listed in the View
Information list�
■ IP address: Current connections to the Network Camera.
■ Elapsed time: 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 allow clients access to the live video without a user name and password:
1� The administrator does not set up a root password� For more information about how to set up
a root password and manage user accounts, please refer to Security > User account on page
2� The administrator has set up a root password, but set
User's Manual - 93
VIVOTEK
■ Refresh: Click this button to refresh all current connections.
■ Add to deny list: You can select entries from the Connection Status list and add them to the
Deny List to deny access� Please note that those checked connections will only be disconnected temporarily and will automatically try to re-link again (IE Explore or Quick Time Player)� If you want to enable the denied list, please check Enable access list filtering and click Save in the first column.
■ Disconnect: If you want to break off the current connections, please select them and click this button� Please note that those checked connections will only be disconnected temporarily 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 cannot� On the contrary, if you choose Deny Type, those clients whose IP addresses are on the
Access List below will not be allowed to access the Network Camera, and the others can�
Then you can Add a rule to the following Access List� Please note that the IPv6 access list column
will not be displayed unless you enable IPv6 on the Network page� For more information about
IPv6 Settings, please refer to Network > General settings on page 69 for detailed information�
94 - User's Manual
VIVOTEK
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
Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List� The address and network mask are written in CIDR format�
For example:
IP address range 192�168�2�x will be bolcked�
Range: This rule allows the user to assign a range of IP addresses to the Allow/Deny List.
Note: This rule only applies to IPv4 addresses.
For example:
Administrator 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�
User's Manual - 95
VIVOTEK
Security > IEEE 802.1X
Enable this function if your network environment uses IEEE 802�1x, which is a port-based network access control� The network devices, intermediary switch/access point/hub, and RADIUS server must support and enable 802�1x settings�
The 802�1x standard is designed to enhance the security of local area networks, which provides authentication to network devices (clients) attached to a network port (wired or wireless)� If all certificates between client and server are verified, a point-to-point connection will be enabled; if authentication fails, access on that port will be prohibited� 802�1x utilizes an existing protocol, the
Extensible Authentication Protocol (EAP), to facilitate communication�
■
The components of a protected network with 802.1x authentication:
Supplicant
(Network Camera)
Authenticator
(Network Switch)
Authentication Server
(RADIUS Server)
1�
Supplicant: A client end user (camera), which requests authentication�
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�
Please follow the steps below to enable 802.1x settings:
1� Before connecting the Network Camera to the protected network with 802�1x, please apply a digital certificate from a Certificate Authority (i�e�, your network administrator) which can be validated by a RADIUS server�
2� Connect the Network Camera to a PC or notebook outside of the protected LAN� Open the configuration page of the Network Camera as shown below. Select EAP-PEAP or EAP-TLS as the EAP method� In the following blanks, enter your ID and password issued by the CA, then upload related certificate(s).
IMPORTANT:
The maximum length of password is 200 symbols�
96 - User's Manual
VIVOTEK
3� When all settings are complete, move the Network Camera to the protected LAN by connecting it to an 802�1x enabled switch� The devices will then start the authentication automatically�
NOTE:
► The authentication process for 802.1x:
1� The Certificate Authority (CA) provides the required signed certificates to the Network Camera
(the supplicant) and the RADIUS Server (the authentication server)�
2� A Network Camera requests access to the protected LAN using 802�1X via a switch (the authenticator). The client offers its identity and client certificate, which is then forwarded by the switch to the RADIUS Server, which uses an algorithm to authenticate the Network Camera and returns an acceptance or rejection back to the switch�
3. The switch also forwards the RADIUS Server’s certificate to the Network Camera.
4� Assuming all certificates are validated, the switch then changes the Network Camera’s state to authorized and is allowed access to the protected network via a pre-configured port.
Certificate Authority
(CA)
1
Certificate
1
Certificate
2
VIVOTEK
Network Camera
Network Switch
4
RADIUS Server
3
Protected LAN
User's Manual - 97
VIVOTEK
PTZ > PTZ settings
This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation�
Digital PTZ Operation (E-PTZ Operation)
The e-PTZ control settings section will be displayed as shown below:
2010/12/10 17:08:56
2011/12/10 17:08:56
x1.8
Select Stream: Select a video stream to set up the e-PTZ control. Please note that each stream can
Auto pan/patrol speed: Select the speed from 1~5 (slow/fast) to set up the Auto pan/patrol speed control.
When completed with the e-PTZ settings, click Save to enable the settings on this page�
98 - User's Manual
Home page in E-PTZ Mode
x3.3
2014/08/10 17:08:56
VIVOTEK
■ The e-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 position�
■ If you have set up different preset positions for different streams, you can select one of the video streams to display its separate preset positions�
Global View
In addition to using the e-PTZ control panel, you can also use the mouse to drag or resize the floating frame to pan/tilt/zoom the viewing region� The live view window will also move to the viewing region accordingly�
Moving Instantly
If you check this item, the live view window will switch to the new viewing region instantly after you move the floating frame.
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 region will also move to that point�
Note that the”Click on Image” function only applies when you have configured a smaller “Region of
Interest” out of the maximum output frame! e�g�, a 1600x1200 region from the camera’s 2560x1920 maximum frame size�
Patrol button: Click this button, then the Network Camera will patrol among the selected preset positions continuously�
User's Manual - 99
VIVOTEK
Patrol settings
You can select some preset positions for the Network Camera to patrol�
Please follow the steps below to set up a patrol schedule:
1� Select the preset locations on the list, and click �
2� The selected preset locations will be displayed on the Patrol locations list�
3� Set the Dwelling time for the preset location during an auto patrol�
4� If you want to delete a preset location from the Patrol locations list, select it and click Remove�
5� Select a location and click to rearrange the patrol order�
6� Select patrol locations you want to save in the list and click Save to enable the patrol settings�
7� To implement the patrol schedule, please go to homepage and click on the
Patrol button� Please refer to the next page�
x1.8
2
3
1
4 5
6
100 - User's Manual
VIVOTEK
NOTE:
►
The Preset Positions will also be displayed on the home page. Select one from the Go to drop-down
list, and the Network Camera will move to the selected preset position.
►
User's Manual - 101
VIVOTEK
Event > Event settings
This section explains how to configure the Network Camera to responds to particular situations
(event)� A typical application is that when a motion is detected, the Network Camera sends buffered images to an FTP server or e-mail address as notifications� Click on Help, there is an illustration shown in the pop-up window explaining that an event can be triggered by many sources, such as motion detection or external digital input devices� When an event is triggered, 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 set an event with recorded 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 the media files to) when a trigger is activated. An event is an action initiated by a user-defined trigger source
-- Schedule, Trigger, and Action to set an event. A total of 3 event settings can be configured.
�
In the Event column, click Add to open the event settings window� Here you can arrange three elements
102 - User's Manual
VIVOTEK
■ Event name: Enter a name for the event setting.
■ Enable this event: Select this option to enable the event setting.
■ Priority: Select the relative importance of this event (High, Normal, or Low). Events with a higher
priority setting will be executed first.
■ Detect next event after seconds: Enter the duration in seconds to pause motion detection after
a motion is detected� This can prevent event-related actions to be too frequently performed�
1�
Schedule
Specify the period of them during which the event trigger will take place� Please select the days of the week and the time in a day (in 24-hr time format) for the event triggering schedule�
2� Trigger
This is the cause or stimulus which defines when to trigger the Network Camera. The trigger source can be configured to use the Network Camera’s built-in motion detection mechanism or external digital input devices�
There are several choices of trigger sources as shown on 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
Motion Detection on page 117 for details�
■ Periodically
This option allows the Network Camera to trigger periodically for every other defined minute. Up to 999 minutes are allowed�
■ Digital input
This option allows the Network Camera to use an external digital input device or sensor as a trigger source� Depending on your application, there are many choices of digital input devices on the market which helps to detect changes in temperature, vibration, sound, and light, etc�
■ System boot
This option triggers the Network Camera when the power to the Network Camera is disconnected�
■ Recording notify
This option allows the Network Camera to trigger when the recording disk is full or when recording starts to rewrite older data�
User's Manual - 103
VIVOTEK
■ Audio detection
A preset threshold can be configured with an external microphone as the trigger to system 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�
Once you have a preset audio alarm level, you can define the triggering condition either as an audio input rises above or falls below the alarm level�
■ Camera tampering detection
This option allows the Network Camera to trigger when the camera detects that is is being tampered
■ Manual Trigger
This option allows users to enable event triggers manually by clicking the on/off button on the homepage. Please configure 1 to 3 associated events before using this function.
104 - User's Manual
VIVOTEK
■ VADP
It is presumed that you already uploaded and enabled the VADP modules before you can associatee VADP triggers with an Event setting�
Click on the Set VADP Trigger button to open the VADP setup menu� The triggering conditions available with 3rd-party software modules known as VADP will be listed� Use the arrow buttons to select these triggers� Users may implant these modules for different purposes such as triggering
Once the triggers are configured, they will be listed under the VADP option.
User's Manual - 105
VIVOTEK
3� Action
Define the actions to be performed by the Network Camera 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�
■ Backup media if the network is disconnected
Select this option to backup media file on SD card if the network is disconnected. This function will only be displayed after you set up a networked storage device (NAS)�
106 - User's Manual
VIVOTEK
Add server
To set an event with recorded 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 the media files to) when a trigger is activated. Click can be configured.
Add server
to open the server setting window� You can specify where the notification messages are sent when a trigger is activated. A total of 5 server settings
There are four choices of server types available: Email, FTP, HTTP, and Network storage. Select the item to display the 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 server.
■ User name: Enter the user name of the email account if necessary.
■ Password: Enter the password of the email account if necessary.
■ Server port: The default mail server port is set to 25. You can also manually set another port.
If your SMTP server requires a secure connection (SSL), check
This server requires a secure connection (SSL).
User's Manual - 107
VIVOTEK
To verify if the email settings are correctly configured, click Test� The result will be shown in a pop-up window� If successful, you will also receive an email indicating the result�
Click Save server to enable the settings�
Note that after you set up the first event server, the new event server will automatically display on the
Server list� If you wish to add other server options, click 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.
■ Password: Enter the password of the FTP account.
■ FTP folder name
Enter the folder where the media file will be placed. If the folder name does not exist, the Network
Camera will automatically create one on the FTP server�
108 - User's Manual
VIVOTEK
■ Passive mode
Most firewalls do not accept new connections initiated from external requests� If the FTP server supports passive mode, select this option to enable passive mode FTP and allow data transmission to pass through the firewall. The firmware default has the Passive mode checkbox selected.
To verify if the FTP settings are correctly configured, click Test� The result will be shown in a pop-up window 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 verify if the HTTP settings are correctly configured, click Test� The result will be shown in a pop-up window as below. If successful, you will receive a test.txt file on the HTTP server.
Click Save server to enable the settings�
User's Manual - 109
VIVOTEK
Network storage:
NAS server on page 129 for details�
Click Save server to enable the settings�
■ SD Test: Click to test your SD card. The system will display a message indicating success or failure. If
■ View: Click this button to open a file list window. This function is only for SD card and Network Storage.
If you click the View button of SD card, a Local storage page will pop up for you to manage recorded
View button of 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 page�
■ Create folders by date, time, and hour automatically: If you check this item, the system will generate
folders automatically by the date when video footages are stored onto the networked storage�
The following is an example of a file destination with video clips:
20140820
20140821
20140822
The format is: YYYYMMDD
Click to open the directory
Click to delete all recorded data
Click to delete selected items
110 - User's Manual
Click
20140820
to open the directory:
The format is: HH (24r)
Click to open the file list for that hour
2014/08/20
2014/08/20
Click to delete selected items
Click to delete all recorded data
Click to go back to the previous level of the directory
2014/08/20
2014/08/20
The format is: File name prefix + Minute (mm)
VIVOTEK
User's Manual - 111
VIVOTEK
Add media
Click
Add media
to open the media setting window� You can specify the type of media that will be of media types available: Snapshot, Video Clip, and System log. Select the item to display the detailed configuration options. You can configure either one or all of them.
Media type - Snapshot
Select to send snapshots when a trigger is activated�
■ Media name: Enter a name for the media setting.
■ Source: Select to take snapshots from any of the video streams.
■ Send pre-event images
The Network Camera has a buffer area; it temporarily holds 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, if both the Send pre-event images and Send post-event images are set to 7, a total of 15 images are generated after a trigger is activated�
1 pic.
2 pic. 3 pic. 4 pic. 5 pic.
6 pic.
7 pic.
8 pic.
9 pic. 10 pic. 11 pic. 10 pic. 12 pic. 13 pic. 14 pic. 15 pic.
Trigger Activation
■ File name prefix
Enter the text that will be appended to the front of the file name.
112 - User's Manual
VIVOTEK
■ Add date and time suffix to the file name
Select this option to add a date/time suffix to the file name.
For example:
Snapshot_ 20101213_100341
File name prefix Date and time suffix
The format is: YYYYMMDD_HHMMSS
Click Save media to enable the settings�
To note that after you set up the first media server, a new column for media server will automatically show up on the Media list� If you wish to add more other media options, click Add media�
Media type - Video clip
Select to send video clips when a trigger is activated�
■ Media name: Enter a name for the media setting.
■ Source: Select the source of video clip.
■ Pre-event recording
The Network Camera has a buffer area; it temporarily holds 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� Up to 10 seconds can be set�
For example, if pre-event recording is set to five seconds and the maximum duration is set to ten seconds, the Network Camera continues to record for another 4 seconds after a trigger is activated�
1 sec. 2 sec. 3 sec. 4 sec. 5 sec.
6 sec.
7 sec. 8 sec. 9 sec. 10 sec.
Trigger Activation
User's Manual - 113
VIVOTEK
■ Maximum file size
Specify the maximum file size allowed.
■ File name prefix
Enter the text that will be appended to the front of the file name.
For example:
Video_ 20140813_100341
File name prefix Date and time suffix
The format is: YYYYMMDD_HHMMSS
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�
114 - User's Manual
VIVOTEK
In the Event settings column, the Servers and Medias you configured will be listed; please make sure the
Event -> Status is indicated as ON, in order to enable the event triggering action�
When completed, click Save event to enable the settings and click Close to exit Event Settings page�
The new Event / Server settings / Media will appear in the event drop-down list on the Event setting page�
Please see the example of the Event setting page below:
When the Event Status is
ON
, once an event is triggered by motion detection, the Network Camera will automatically send snapshots via e-mails�
If you want to stop the event trigger, you can click
ON
to turn it to
OFF
status or click Delete 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 that you can only delete a server setting when it is not applied to an event setting�
To remove a media setting from the list, select a media name from the drop-down list and click Delete�
Note that you can only delete a media setting when it is not applied to an event setting�
User's Manual - 115
VIVOTEK
Customized Script
This function allows you to upload a sample script (.xml file) to the webpage, which will save your time 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�
Click to upload a file
Click to modify the script online
116 - User's Manual
VIVOTEK
Applications > Motion detection
This section explains how to configure the Network Camera to enable motion detection. A total of three motion detection windows can be configured.
2010/12/10 17:08:56
Motion Detection Setting 1:
For normal situations
Follow the steps below to enable motion detection:
Follow the steps below to enable motion detection:
Motion Detection Setting 2:
For special situations
1� Click New to add a new motion detection window�
2� In the Window Name text box, enter a name for the motion detection window�
■ To move and resize the window, drag and drop your mouse on the window.
■ To delete a window, click X on the upper right corner of the window.
3� Define the sensitivity to moving objects and the space ratio of all alerted pixels by moving the
Sensitivity and Percentage slider bar�
4� Click Save to enable the settings�
5� Select Enable motion detection to enable this function�
For example:
Video(TCP-AV)
2010/12/10 17:08:56 hallway
The Percentage Indicator will rise or fall depending on the variation between sequential images� When motions are detected by the Network Camera and are judged to exceed the defined threshold, the red bar rises� Meanwhile, the motion detection window will be outlined in red� Photos or videos can be captured instantly and configured to be sent to a remote server (Email, FTP) by utilizing this feature as a
User's Manual - 117
VIVOTEK
A green bar indicates that even though motions have been detected, the event has not been triggered because the image variations still fall under the defined threshold.
Percentage = 30%
If you want to configure other motion detection settings for day/night/schedule mode, please click Profile to open the Motion Detection Profile Settings page as shown below� A total of three motion detection windows can be configured on this page as well.
Video(TCP-AV)
2010/12/10 17:08:56
Please follow the steps beolw to set up a profile:
1� Create a new motion detection window�
2� Check Enable this profile�
3. Select the applicable mode: Day mode, Night mode, or Schedule mode. Please manually enter a time range if you choose Schedule mode�
4� Click Save to enable the settings and click Close to exit the page�
This motion detection window will also be displayed on the Event Settings page� You can go to Event
118 - User's Manual
VIVOTEK
NOTE:
► How does motion detection work?
A C
B D
There are two motion detection parameters: Sensitivity and Percentage. In the illustration above, frame A and frame B are two sequential images� Pixel differences between the two frames are detected and highlighted in gray (frame C) and will be compared with the sensitivity setting� Sensitivity is a value that expresses the sensitivity to moving objects� Higher sensitivity settings are expected to detect slight movements while smaller sensitivity settings will neglect them� When the sensitivity is set to 70%, the Network Camera defines the pixels in the purple areas as “alerted pixels” (frame D).
Percentage is a value that expresses the proportion of “alerted pixels” to all pixels in the motion detection window. In this case, 50% of pixels are identified as “alerted pixels”. When the percentage is set to 30%, the motions are judged to exceed the defined threshold; therefore, the motion window will be outlined in red�
For applications that require a high level of security management, it is suggested to use higher sensitivity settings and smaller percentage values�
User's Manual - 119
VIVOTEK
Applications > DI and DO
Connect DI or DO devices to the camera's terminal block, the camera will automatically detect the current connection state as pulled-high or pulled-low� You may then define the triggering condition�
Digital input: Select High or Low to define the "Normal status" for the digital input. The Network
Camera will report the current status�
Digital output: Select Grounded or Open to define the "Normal status" for the digital output. The
Network Camera will show whether the trigger is activated or not�
Applications > Tampering detection
This section explains how to set up camera tamper detection� With tamper detection, the camera is capable of detecting incidents such as redirection, blocking or defocusing, or even
spray paint�
Please follow the steps below to set up the camera tamper detection function:
1� Check Enable camera tampering detection�
2� Enter the tamper trigger duration� (10 sec� ~ 10 min�) The tamper alarm will be triggered only when the tampering factor (the difference between current frame and pre-saved background) exceeds the trigger threshold�
3� Set up the event source as Camera Tampering Detection on
Event > Event settings >
Trigger. Please refer to page 127 for detailed information�
120 - User's Manual
VIVOTEK
Applications > Audio detection
Audio detection, along with video motion detection, is applicable in the following scenarios:
1� Detection of activities not covered by camera view, e�g�, a loud input by gun shots or breaking a door/window�
2� A usually noisy environment, such as a factory, suddenly becomes quiet due to a breakdown of machines�
3� A PTZ camera can be directed to turn to a preset point by the occurrence of audio events�
4� Dark environments where video motion detection may not function well�
The red circles indicate where the audio alarms can be triggered when breaching or falling below the preset threshold�
How 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�
NOTE:
1. Note that the volume numbers (0~100) on the side of wave diagram does not represent decibel
(dB). Sound intensity level has already been mapped to preset values. You can, however, use the real-world inputs at your installation site that are shown on the wave diagram to configure an alarm level.
2. To configure this feature, you must not mute the audio in
Configuration > Media > Audio.
The default of the camera can be muted due to the lack of an internal microphone. An external microphone is provided by users.
User's Manual - 121
VIVOTEK
You can use the Profile window to configure a different Audio detection setting. For example, a place can be noisy in the day time and become very quiet in the night�
1� Click on the Enable this profile checkbox� Once the Audio detection window is opened, the current sound input will be interactively indicated by a fluctuating 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 Day, Night, or Schedule mode check circles. You may also manually configure a period of time during which this profile will take effect.
4� Click Save and then click Close to complete your configuration.
IMPORTANT:
• 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 the detected sound level�
• To configure and enable this feature, you must not configure video stream #1 into
Motion JPEG� If an external microphone input is connected and recording of audio stream is preferred, audio stream is transmitted between camera and viewer/recording station along with stream #1�
• Refer to page 68 for Audio settings, and page 59 for video streaming settings�
122 - User's Manual
Applications > VADP (VIVOTEK Application Development
Platform)
VIVOTEK
Users can store and execute VIVOTEK's or 3rd-party software modules onto the camera's flash memory or SD card� These software modules can apply in video analysis for intelligent video applications such as license plate recognition, object counting, or as an agent for edge recording, etc�
• Once the software package is successfully uploaded, the module configuration (vadp.
xml) information is displayed� When uploading a module, the camera will examine whether the module fits the predefined VADP requirements� Please contact our technical support or the vendor of your 3rd-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 to SD card" checkbox selected and grayed-out for all time�
• The file system of SD card (FAT32) does not support soft (symbolic) link. It will return failure if your module tries to create soft links on SD card�
To utilize a software module, acquire the software package and click Browse and Upload buttons. The screen message for a successful upload is shown below:
User's Manual - 123
VIVOTEK
To start a module, select the checkcircle in front, and click the Start button�
If you should need to remove a module, select the checkcircle in front and then click the
Stop button� 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 resources�
124 - User's Manual
VIVOTEK
On the License page, use the Manual or Automatic to register and activate the license for using VIVOTEK's VADP modules� The Automatic method requires an Internet connection�
Without Internet connection, you should acquire the license key elsewhere, and manually upload to the network camera�
Follow the onscreen instruction on VIVOTEK's website for the registration procedure�
User's Manual - 125
VIVOTEK
Recording > Recording settings
This section explains how to configure the recording settings for the Network Camera.
Recording Settings
Insert your SD card and click here to test
NOTE
NOTE:
Recording Settings
Click 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 control according to alarm trigger�
The frame control means that when there is a triggered alarm, the frame rate will raise up to the value
you’ve set on Video quality page� Please refer to page 63 for more information�
126 - User's Manual
VIVOTEK
If you enable adaptive recording and enable time-shift cache stream on Camera A, only when an event is triggered 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 save lots of bandwidths and storage space�
NOTE
NOTE:
► To enable adaptive recording, please make sure you’ve set up the trigger source such as Motion
Detection, DI Device, or Manual Trigger�
Bandwidth
Bandwidth
I frame ---> Full frame rate ---> I frame
Activity Adaptive Streaming
for Dynamic Frame Rate Control
► When there is no alarm trigger:
- JPEG mode: record 1 frame per second.
- H.264 mode: record I frame only.
► When the I frame period is >1s on Video settings page, firmware will force decrease the I frame period to 1s when adaptive recording is enabled�
Continuous recording
Time
■ Pre-event recording and post-event recording
The Network Camera has a buffer area; it temporarily holds data up to a certain limit� Enter a number to decide the duration of recording before and after a trigger is activated�
■ Priority: Select the relative importance of this recording (High, Normal, or Low). Recording with a higher
priority setting will be executed first.
■ Source: Select a stream for the recording source.
NOTE:
► To enable recording notification please configure Event settings first . Please refer to page 102.
Please follow the steps below to set up the recording�
1� Trigger
Select a trigger source�
■ Schedule: The server will start to record files on the local storage or network storage (NAS).
■ Network fail: Since network fail, the server will start to record files on the local storage (SD card).
User's Manual - 127
VIVOTEK
2� Destination
You can select the SD card or networked storage (NAS) for the recorded video files� If you have not configured a NAS server, see details 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:
3
Network storage path
(\\server name or IP address\folder name)
1
2 4
User name and password for your server
2� Click
Test to check the setting� The result will be shown in the pop-up window�
128 - User's Manual
If successful, you will receive a test.txt file on the network storage server.
VIVOTEK
3� Enter a server name�
4� Click Save to complete the settings and click Close to exit the page�
■ Capacity: You can choose either the entire free space available or limit the reserved space. The
recording size limit must be larger than the reserved amount for cyclic recording�
■ File name prefix: Enter the text that will be appended to the front of the file name.
■ Enable cyclic recording: If you check this item, when the maximum capacity is reached, the oldest file
will be overwritten by the latest one� The reserved amount is reserved for the transaction stage when the storage space is about to be full and new data arrives� The minimum for the Reserved space must be larger than 15 MBytes�
■ Recording file management: You can manually assign the Maximum duration and the Maximum file size for each recording footage� You may need to stitch individual files together under some circumstances. You may also designate a file name prefix by filling in the responsive text field.
User's Manual - 129
VIVOTEK
f you want to enable recording notification, please click
Event
to configure event triggering settings.
Please refer to Event > Event settings on page 102 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 recording, it will send the recorded files to the network storage� The new recording name will appear in the drop-down list on the recording page as shown below�
To remove a recording setting from the list, select a recording name from the drop-down list and click Delete�
■ Click
Video
(Name): Opens the Recording Settings page to modify.
■ Click
ON
(Status): The Status will become
OFF
and stop recording�
■ Click
NAS
(Destination): Opens the file list of recordings as shown below. For more information
about folder naming rules, please refer to page 110 for details�
20140910
20140911
20140912
130 - User's Manual
VIVOTEK
Local storage > SD card management
This section explains how to manage the local storage on the Network Camera� Here you can view SD card status, and implement SD card control�
SD card staus
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
SD card control
■ Enable cyclic storage: Check this item if you want to enable cyclic recording. When the maximum capacity is reached, the oldest file will be overwritten by the latest one.
■ Enable automatic disk cleanup: Check this item and enter the number of days you wish to retain a file.
For example, if you enter “7 days”, the recorded files will be stored on the SD card for 7 days.
Click Save to enable your settings�
User's Manual - 131
VIVOTEK
Local storage > Content management
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 attributes: Select one or more items as your search criteria.
■ Trigger time: Manually enter the time range you want to search.
Click Search and the recorded data corresponding to the search criteria will be listed in Search Results window�
132 - User's Manual
VIVOTEK
Search Results
The following is an example of search results. There are four columns: Trigger time, Media type,
Trigger type, and Locked� Click to sort the search results in either direction�
Highlight an item
■ View: Click on a search result which will highlight the selected item in purple as shown above.
Click the View button and a media window will pop up to play back the selected file.
For example:
2014/8/26 10:43:06
Click to adjust the image size
■ 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 select several snapshots from the list, then click this button� Those snapshots will be converted into an AVI file.
User's Manual - 133
VIVOTEK
■ Lock/Unlock: Select the desired search results, 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:
Click to switch pages
■ Remove: Select the desired search results, then click this button to delete the files.
134 - User's Manual
VIVOTEK
Appendix
URL Commands for the Network Camera
1. Overview
For some customers who already have their own web site or web control application, the Network
Camera/Video Server can be easily integrated through URL syntax� This section specifies the external
HTTP-based application programming interface� The HTTP-based camera interface provides the functionality to request a single image, control camera functions (PTZ, output relay etc�), and get and set internal parameter values� The image and CGI-requests are handled by the built-in Web server�
2. Style Convention
In URL syntax and in descriptions of CGI parameters, text within angle brackets denotes content that is to be replaced with either a value or a string� When replacing the text string, the angle brackets should also be replaced� An example of this is the description of the name for 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 actual server� This can either be a name, e�g�, "mywebcam" or "thecam� adomain�net" or the associated IP number for the server, e�g�, 192�168�0�220�
Syntax: http://<servername>/cgi-bin/viewer/video.jpg
Description of returned data is written with " Return:" in bold face followed by the returned data in a box� All data is returned in HTTP format, i�e�, each line is separated with a Carriage Return and Line Feed (CRLF) printed as \r\n�
Return:
HTTP/1.0 <HTTP code> <HTTP text>\r\n
URL syntax examples are written with " Example:" in bold face followed by a short description and a light grey box with the example�
Example: request a single snapshot image http://mywebserver/cgi-bin/viewer/video.jpg
User's Manual - 135
VIVOTEK
3. General CGI URL Syntax and Parameters
CGI parameters are written in lower-case and as one word without any underscores or other separators. When the
CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server. The CGIs are organized in functionally-related directories under the cgi-bin directory.
The file extension .cgi is required.
Syntax: http://<servername>/cgi-bin/<subdir>[/<subdir>...]/<cgi>.<ext>
[?<parameter>=<value>[&<parameter>=<value>...]]
Example: Set digital output #1 to active http://mywebserver/cgi-bin/dido/setdo.cgi?do1=1
4. Security Level
SECURITY LEVEL SUB-DIRECTORY
0 anonymous
1 [view]
4 [operator]
6 [admin]
7 anonymous, viewer, dido, camctrl anonymous, viewer, dido, camctrl, operator anonymous, viewer, dido, camctrl, operator, admin
N/A
DESCRIPTION
Unprotected.
1. Can view, listen, talk to camera.
2. Can control DI/DO, PTZ of the camera.
Operator access rights can modify most of the camera’s parameters except some privileges and network options.
Administrator access rights can fully control the camera’s operations.
Internal parameters. Unable to be changed by any external interfaces.
136 - User's Manual
VIVOTEK
5. Get Server Parameter Values
Note: The access right depends on the URL directory.
Method: GET/POST
Syntax: http://<servername>/cgi-bin/ anonymous /getparam.cgi?[<parameter>]
[&<parameter>…] http://<servername>/cgi-bin/ viewer /getparam.cgi?[<parameter>]
[&<parameter>…] http://<servername>/cgi-bin/ operator /getparam.cgi?[<parameter>]
[&<parameter>…] http://<servername>/cgi-bin/ admin /getparam.cgi?[<parameter>]
[&<parameter>…]
Where the <parameter> should be <group>[_<name>] or <group>[.<name>]. If you do not specify any parameters, all the parameters on the server will be returned. If you specify only <group>, the parameters of the related group will be returned.
When querying parameter values, the current parameter values are returned.
A successful control request returns parameter pairs as follows:
Return:
HTTP/1.0 200 OK\r\n
Content-Type: text/html\r\n
Context-Length: <length>\r\n
\r\n
<parameter pair>
where <parameter pair> is
<parameter>=<value>\r\n
[<parameter pair>]
<length> is the actual length of content.
Example: Request IP address and its response
Request:
User's Manual - 137
VIVOTEK
http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress
Response:
HTTP/1.0 200 OK\r\n
Content-Type: text/html\r\n
Context-Length: 33\r\n
\r\n network.ipaddress=192.168.0.123\r\n
6. Set Server Parameter Values
Note: The access right depends on the URL directory.
Method: GET/POST
Syntax: http://<servername>/cgi-bin/ anonymous /setparam.cgi? <parameter>=<value>
[&<parameter>=<value>…][&update=<value>][&return=<return page>] http://<servername>/cgi-bin/ viewer /setparam.cgi? <parameter>=<value>
[&<parameter>=<value>…][&update=<value>] [&return=<return page>] http://<servername>/cgi-bin/ operator /setparam.cgi? <parameter>=<value>
[&<parameter>=<value>…][&update=<value>] [&return=<return page>] http://<servername>/cgi-bin/ admin /setparam.cgi? <parameter>=<value>
[&<parameter>=<value>…][&update=<value>] [&return=<return page>]
PARAMETER
<group>_<name> update return
VALUE value to assigned
<boolean>
<return page>
DESCRIPTION
Assign <value> to the parameter <group>_<name>.
Set to 1 to update all fields (no need to update parameter in each group).
Redirect to the page <return page> after the parameter is assigned.
The <return page> can be a full URL path or relative path according to the current path. If you omit this parameter, it will redirect to an empty page.
(Note: The return page can be a general HTML file (.htm, .html) or a
VIVOTEK server script executable (.vspx) file. It cannot be a CGI command or have any extra parameters. This parameter must be
138 - User's Manual
VIVOTEK
placed at the end of the parameter list
Return:
HTTP/1.0 200 OK\r\n
Content-Type: text/html\r\n
Context-Length: <length>\r\n
\r\n
<parameter pair>
where <parameter pair> is
<parameter>=<value>\r\n
[<parameter pair>]
Only the parameters that you set and are readable will be returned.
Example: Set the IP address of server to 192.168.0.123:
Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123
Response:
HTTP/1.0 200 OK\r\n
Content-Type: text/html\r\n
Context-Length: 33\r\n
\r\n network.ipaddress=192.168.0.123\r\n
7. Available parameters on the server
Valid values:
VALID VALUES string[<n>] string[n~m] password[<n>] integer positive integer
<m> ~ <n> domain name[<n>] email address [<n>] ip address
DESCRIPTION
Text strings shorter than ‘n’ characters. The characters “,’, <,>,& are invalid.
Text strings longer than `n’ characters and shorter than `m’ characters. The characters “,’, <,>,& are invalid.
The same as string but displays ‘*’ instead.
Any number between (-2
31
– 1) and (2
31
– 1).
Any number between 0 and (2
32
– 1).
Any number between ‘m’ and ‘n’.
A string limited to a domain name shorter than ‘n’ characters (eg. www.ibm.com).
A string limited to an email address shorter than ‘n’ characters (eg. [email protected]).
A string limited to an IP address (eg. 192.168.1.1).
User's Manual - 139
VIVOTEK
mac address boolean
A string limited to contain a MAC address without hyphens or colons.
A boolean value of 1 or 0 represents [Yes or No], [True or False], [Enable or
Disable].
Enumeration. Only given values are valid. <value1>,
<value2>,
<value3>,
… blank everything inside <> integer primary key text coordinate window size
A blank string.
A description
SQLite data type. A 32-bit signed integer. The value is assigned a unique integer by the server.
SQLite data type. The value is a text string, stored using the database encoding
(UTF-8, UTF-16BE or UTF-16-LE). x, y coordinate (eg. 0,0) window width and height (eg. 800x600)
NOTE: The camera should not be restarted when parameters are changed.
7.1 system
Group: system
NAME hostname ledoff lowlight
VALUE DEFAULT
Network
Camera
<boolean> 0
<boolean> 1
SECURITY
(get/set)
DESCRIPTION
6/6
6/6
Host name of server
(Network Camera,
Wireless Network Camera,
Video Server,
Wireless Video Server).
Turn on (0) or turn off (1) all led indicators.
Turn on white light LED under all conditions.
Only turn on white light LED in low light conditions. date <YYYY/MM/
DD>, keep, auto
140 - User's Manual
<current date>
6/6 Current date of system. Set to ‘keep’ to keep date unchanged. Set to ‘auto’ to use NTP to synchronize date.
time <hh:mm:s s>, keep, auto datetime <MMDDhh mmYYYY.ss
>
<current time>
<blank>
6/6
6/6 timezoneindex name>,
<ip address>,
<blank>
-489 ~ 529 320 6/6
VIVOTEK
Current time of the system. Set to
‘keep’ to keep time unchanged. Set to
‘auto’ to use NTP to synchronize time.
Another current time format of the system.
NTP server.
*Do not use “skip to invoke default server” for default value.
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_Francisco,
Vancouver
-280: GMT-07:00 Mountain Time,
Denver
-281: GMT-07:00 Arizona
-240: GMT-06:00 Central America,
Central Time, Mexico City,
Saskatchewan
-200: GMT-05:00 Eastern Time, New
York, Toronto
-201: GMT-05:00 Bogota, Lima,
Quito, Indiana
-180: GMT-04:30 Caracas
-160: GMT-04:00 Atlantic Time,
Canada, La Paz, Santiago
-140: GMT-03:30 Newfoundland
-120: GMT-03:00 Brasilia, Buenos
Aires,
Georgetown, Greenland
-80: GMT-02:00 Mid-Atlantic
User's Manual - 141
VIVOTEK
142 - User's Manual
-40: GMT-01:00 Azores,
Cape_Verde_IS.
0: GMT Casablanca, Greenwich Mean
Time: Dublin,
Edinburgh, Lisbon, London
40: GMT 01:00 Amsterdam, Berlin,
Rome, Stockholm, Vienna, Madrid,
Paris
41: GMT 01:00 Warsaw, Budapest,
Bern
80: GMT 02:00 Athens, Helsinki,
Istanbul, Riga
81: GMT 02:00 Cairo
82: GMT 02:00 Lebanon, Minsk
83: GMT 02:00 Israel
120: GMT 03:00 Baghdad, 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,
Jakarta, Krasnoyarsk
320: GMT 08:00 Beijing, Chongging,
Hong Kong, Kuala Lumpur, Singapore,
Taipei
360: GMT 09:00 Osaka, Sapporo,
Tokyo, Seoul, Yakutsk
380: GMT 09:30 Adelaide, Darwin
daylight_enable <boolean> 0 daylight_dstactualmode <boolean> 1~4
6/6
6/7
VIVOTEK
400: GMT 10:00 Brisbane, Canberra,
Melbourne, Sydney, Guam,
Vladivostok
440: GMT 11:00 Magadan, Solomon
Is., New Caledonia
480: GMT 12:00 Aucklan, Wellington,
Fiji, Kamchatka, Marshall Is.
520: GMT 13:00 Nuku'Alofa
Enable automatic daylight saving time in time zone.
Check if current time is under daylight saving time.
(Used internally)
Display the current daylight saving start time.
Display the current daylight saving end time.
List time zone index which support daylight saving time. daylight_auto_begintime string[19] NONE 6/7 daylight_auto_endtime string[19] NONE 6/7 daylight_timezones string ,-360,-320,
-280,-240,
-241,-200,
-201,-160,
-140,-120,
-80,-40,0,
40,41,80,
81,82,83,
120,140,
380,400,48
0
6/6
6/6
3600,
86400,
604800,
2592000
99/6 reset restoreexceptnet
<positive integer>
-1, 0,
<positive integer>
0,
N/A
N/A
99/6
99/6
0 to Disable automatic time adjustment, otherwise, it indicates the seconds between NTP automatic update intervals.
Restore the system parameters to default values after <value> seconds.
Restart the server after <value> seconds if <value> is non-negative.
Restore the system parameters to
User's Manual - 143
VIVOTEK
<positive integer>
<positive integer> restoreexceptlang 0, N/A
<positive integer>
99/6
99/6 default values except (ipaddress, subnet, router, dns1, dns2, pppoe).
This command can cooperate with other “restoreexceptXYZ” commands.
When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.
Restore the system parameters to default values except all daylight saving time settings.
This command can cooperate with other “restoreexceptXYZ” commands.
When cooperating with others, the system parameters will be restored to default values except for a union of combined results.
Restore the system parameters to default values except the custom language file the user has uploaded.
This command can cooperate with other “restoreexceptXYZ” commands.
When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.
7.1.1 System.info
Subgroup of system: info (The fields in this group are unchangeable.)
NAME modelname
VALUE string[40]
DEFAULT
IP8173H
SECURITY
(get/set)
0/99 extendedmodelname string[40] IP8173H address> mac
0/99
0/99
DESCRIPTION
Internal model name of the server
(eg. IP7139)
ODM specific model name of server
(eg. DCS-5610). If it is not an ODM model, this field will be equal to
“modelname”
12 characters MAC address (without hyphens).
144 - User's Manual
VIVOTEK
firmwareversion language_count address> string[40] <product 0/99 dependent
>
<integer> 9 0/99 language_i<0~(count-1)> string[16] <product dependent
>
0/99
<integer> 1 0/6 t customlanguage_maxcoun customlanguage_count <integer> 0 0/6 customlanguage_i<0~(ma xcount-1)> string <blank> 0/6
7.2 status
Group: status
NAME di_i<0~(ndi-1)> daynight onlinenum_rtsp onlinenum_httppush eth_i0 vi_i<0~(nvi-1)>
Firmware version, including model, company, and version number in the format: <MODEL-BRAND-VERSION>
Number of webpage languages available on the server.
Available language lists.
Maximum number of custom languages supported on the server.
Number of custom languages which have been uploaded to the server.
Custom language name.
VALUE
<boolean> day, night integer integer
DEFAULT
0
SECURITY
(get/set)
1/99
DESCRIPTION
7/7
0 => Inactive, normal
1 => Active, triggered
(capability.ndi > 0)
Current status of day, night. <product dependent>
0 0/0
0
<string> <product
<boolean> dependent>
0
0/0
1/99
1/99
Current number of RTSP connections.
Current number of HTTP push server connections.
Get network information from mii-tool.
Virtual input
0 => Inactive
1 => Active
(capability.nvi > 0)
User's Manual - 145
VIVOTEK
7.3 digital input behavior define
Group: di_i<0~(ndi-1)> (capability.ndi > 0)
NAME VALUE DEFAULT low
SECURITY
(get/set)
1/1
DESCRIPTION
Indicates open circuit or closed circuit (inactive status)
7.4 digital output behavior define
Group: do_i<0~(ndo-1)> (capability.ndo > 0)
NAME VALUE DEFAULT grounded
SECURITY
(get/set)
1/1
DESCRIPTION
Indicate open circuit or closed circuit (inactive status)
7.5 security
Group: security
NAME privilege_do
<product dependent> privilege_camctrl
<product dependent>
VALUE view, operator, admin view, operator, admin user_i0_name user_i<1~20>_name string[64] string[64] user_i0_pass user_i<1~20>_pass password[64] password[64] user_i0_privilege view, operator, admin user_i<1~20>_ privilege view, operator, admin
146 - User's Manual
root
<blank>
<blank>
<blank> admin
<blank>
DEFAULT operator view
6/7
6/7
6/6
7/6
6/7
SECURITY
(get/set)
1/6
DESCRIPTION
1/6
Indicate which privileges and above can control digital output
(capability.ndo > 0)
Indicate which privileges and above can control PTZ
(capability.ptzenabled > 0 or capability.eptz > 0)
User name of root
User name
Root password
User password
Root privilege
6/6 User privilege
VIVOTEK
7.6 network
Group: network
NAME VALUE preproces s
<positive integer>
DEFAULT
<blank>
SECURITY
(get/set)
6/6
DESCRIPTION
An 32-bit integer, each bit can be set separately as follows:
Bit 0 => HTTP service;
Bit 1=> HTTPS service;
Bit 2=> FTP service;
Bit 3 => Two way audio and RTSP Streaming service;
6/6
To stop service before changing its port settings. It’s
recommended to set this parameter when change a service port to the port occupied by another service currently. Otherwise, the service may fail.
Stopped service will auto-start after changing port settings.
Ex:
Change HTTP port from 80 to 5556, and 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”
Network connection type. type lan, pppoe
<product dependent> resetip lan
<boolean> 1 6/6 ipaddress <ip address> subnet <ip address> router <ip address>
<product dependent>
<blank>
<blank>
6/6
6/6
6/6
1 => Get ipaddress, subnet, router, dns1, dns2 from
DHCP server at next reboot.
0 => Use preset ipaddress, subnet, rounter, dns1, and dns2.
IP address of server.
Subnet mask.
Default gateway.
User's Manual - 147
VIVOTEK
dns1 <ip address> dns2 <ip address> wins1 <ip address> wins2 <ip address>
<blank>
<blank>
<blank>
<blank>
6/6
6/6
6/6
6/6
Primary DNS server.
Secondary DNS server.
Primary WINS server.
Secondary WINS server.
7.6.1 802.1x
Subgroup of network: ieee8021x (capability.protocol.ieee8021x > 0)
NAME VALUE DEFAULT SECURITY
(get/set) enable <boolean> 0 6/6
6/6 identity_peap identity_tls password eap-tls string[64] string[64] string[253]
<blank>
<blank>
<blank>
6/6
6/6
6/6 privatekeypassword ca_exist ca_time string[253]
<boolean>
<integer>
<blank>
0
0
6/6
6/6
6/7 ca_size certificate_exist certificate_time certificate_size privatekey_exist privatekey_time privatekey_size
<integer>
<boolean>
<integer>
<integer>
<integer>
0
0
0
<integer> 0
<boolean> 0
0
0
6/7
6/6
6/7
6/7
6/6
6/7
6/7
DESCRIPTION
Enable/disable IEEE 802.1x
Selected EAP method
PEAP identity
TLS identity
Password for TLS
Password for PEAP
CA installed flag
CA installed time. Represented in
EPOCH
CA file size (in bytes)
Certificate installed flag (for TLS)
Certificate installed time.
Represented in EPOCH
Certificate file size (in bytes)
Private key installed flag (for
TLS)
Private key installed time.
Represented in EPOCH
Private key file size (in bytes)
148 - User's Manual
VIVOTEK
7.6.2 QOS
Subgroup of network: qos_cos (capability.protocol.qos.cos > 0)
NAME VALUE DEFAULT SECURITY
(get/set) enable vlanid
<boolean>
1~4095
0
1
6/6
6/6 video audio
0~7
0~7
0
0
6/6
6/6 eventalarm management eventtunnel
0~7
0~7
0~7
0
0
0
6/6
6/6
6/6
DESCRIPTION
Enable/disable CoS (IEEE 802.1p)
VLAN ID
Video channel for CoS
Audio channel for CoS
(capability.naudio > 0)
Event/alarm channel for CoS
Management channel for CoS
Event/Control channel for CoS
Subgroup of network: qos_dscp (capability.protocol.qos.dscp > 0)
NAME VALUE DEFAULT SECURITY
(get/set) enable video audio
<boolean>
0~63
0~63
0
0
0
6/6
6/6
6/6 eventalarm management eventtunnel
0~63
0~63
0~63
0
0
0
6/6
6/6
6/6
DESCRIPTION
Enable/disable DSCP
Video channel for DSCP
Audio channel for DSCP
(capability.naudio > 0)
Event/alarm channel for DSCP
Management channel for DSCP
Event/Control channel for DSCP
7.6.3 IPV6
Subgroup of network: ipv6 (capability.protocol.ipv6 > 0)
NAME VALUE DEFAULT SECURITY
(get/set) enable addonipaddress addonprefixlen addonrouter
<boolean>
<ip address>
0~128
<ip address>
0
<blank>
64
<blank>
6/6
6/6
6/6
6/6 addondns allowoptional
<ip address>
<boolean>
<blank>
0
6/6
6/6
DESCRIPTION
Enable IPv6.
IPv6 IP address.
IPv6 prefix length.
IPv6 router address.
IPv6 DNS address.
Allow manually setup of IP address setting.
User's Manual - 149
VIVOTEK
7.6.4 FTP
Subgroup of network: ftp
NAME VALUE port 21, 1025~65535
DEFAULT
21
SECURITY
(get/set)
6/6
DESCRIPTION
Local ftp server port.
7.6.5 HTTP
Subgroup of network: http
NAME VALUE port alternateport s0_accessname s1_accessname s2_accessname
S3_accessname anonymousviewing
DEFAULT
80, 1025 ~
65535
80
1025~65535 8080 digest string[32] string[32] string[32]
<boolean> video.mjpg video2.mjpg video3.mjpg
0
SECURITY
(get/set)
1/6
DESCRIPTION
HTTP port.
6/6
1/6
Alternate HTTP port.
HTTP authentication mode.
1/6
1/6
1/6 string[32] videoany.mjpg 1/6
1/6
HTTP server push access name for stream 1.
(capability.protocol.spush_mjpeg =1 and capability.nmediastream > 0)
HTTP server push access name for stream 2.
(capability.protocol.spush_mjpeg =1 and capability.nmediastream > 1)
Http server push access name for stream 3
(capability.protocol.spush_mjpeg =1 and capability.nmediastream > 2)
Http server push access name for anystream.
(capability.protocol.spush.mjpeg = 1 and capability.nanystream = 1)
Enable anonymous streaming viewing.
150 - User's Manual
VIVOTEK
7.6.6 HTTPS port
Subgroup of network: https_port (capability.protocol.https > 0)
NAME VALUE DEFAULT SECURITY
(get/set) port 443, 1025 ~
65535
443 1/6
DESCRIPTION
HTTPS port.
7.6.7 RTSP
Subgroup of network: rtsp (capability.protocol.rtsp > 0)
NAME VALUE DEFAULT port anonymousviewing
554, 1025 ~
65535
<boolean>
554
0 s0_accessname s1_accessname s2_accessname s3_accessname basic, digest string[32] string[32] string[32] string[32] live.sdp live2.sdp live3.sdp liveany.sdp
SECURITY
(get/set)
1/6
DESCRIPTION
1/6
1/6
RTSP port.
(capability.protocol.rtsp=1)
Enable anoymous streaming viewing.
RTSP authentication mode.
(capability.protocol.rtsp=1)
1/6
1/6
1/6
1/6
RTSP access name for stream1.
(capability.protocol.rtsp=1 and capability.nmediastream > 0)
RTSP access name for stream2.
(capability.protocol.rtsp=1 and capability.nmediastream > 1)
RTSP access name for stream3
(capability.protocol.rtsp=1 and capability.nmediastream > 2)
RTSP access name for anystream.
(capability.protocol.rtsp=1 and capability.nanystream = 1)
User's Manual - 151
VIVOTEK
7.6.7.1 RTSP multicast
Subgroup of network_rtsp_s<0~(n-1)>: multicast, n is stream count (capability.protocol.rtp.multicast > 0)
NAME VALUE DEFAULT SECURITY DESCRIPTION
(get/set) alwaysmulticast <boolean> 0 4/4 Enable always multicast. ipaddress <ip address> 4/4 Multicast IP address. videoport audioport ttl
1025 ~ 65535
1025 ~ 65535
1 ~ 255
For n=0,
239.128.1.99
For n=1,
239.128.1.100, and so on.
5560+n*2
5562+n*2
15
4/4
4/4
4/4
Multicast video port.
Multicast audio port.
(capability.naudio > 0)
Mutlicast time to live value.
7.6.8 SIP port
Subgroup of network: sip (capability.protocol.sip> 0)
NAME VALUE DEFAULT port 1025 ~ 65535 5060
SECURITY
(get/set)
1/6
DESCRIPTION
SIP port.
7.6.9 RTP port
Subgroup of network: rtp
NAME VALUE videoport audioport
1025 ~ 65535
1025 ~ 65535
DEFAULT
5556
5558
SECURITY
(get/set)
6/6
DESCRIPTION
6/6
Video channel port for RTP.
(capability.protocol.rtp_unicast=1)
Audio channel port for RTP.
(capability.protocol.rtp_unicast=1)
152 - User's Manual
VIVOTEK
7.6.10 PPPoE
Subgroup of network: pppoe (capability.protocol.pppoe > 0)
NAME VALUE DEFAULT SECURITY
(get/set) user pass string[128] password[64]
<blank>
<blank>
6/6
6/6
DESCRIPTION
PPPoE account user name.
PPPoE account password.
7.7 IP Filter
Group: ipfilter
NAME VALUE enable admin_enable admin_ip maxconnection type ipv4list_i<0~9> ipv6list_i<0~9>
<boolean>
<boolean> string[43]
0~10
0, 1
DEFAULT
0
0
<blank>
10
SECURITY
(get/set)
6/6
6/6
6/6
6/6
1 6/6
DESCRIPTION
Enable access list filtering.
Enable administrator IP address.
Administrator IP address.
Maximum number of concurrent streaming connection(s).
Ipfilter policy :
0 => allow
1 => deny
IPv4 address list.
Single address:
<ip address>
Network address:
<ip address / network mask>
Range address:<start ip address - end ip address> string[43]
<blank> 6/6
<blank> 6/6 IPv6 address list.
User's Manual - 153
VIVOTEK
7.8 Video input
Group: videoin
NAME VALUE cmosfreq whitebalance
DEFAULT
60 50, 60 auto, auto2, manual, manual2, rbgain auto exposurelevel autoiris irismode enablewdr enableblc agc color flip mirror ptzstatus
0~12
<boolean> fixed, indoor, outdoor
<boolean>
<boolean>
0,1,2
0, 1
<boolean>
<boolean>
<integer>
1
0
0
2
0
0
1
6
0 outdoor
1/4
1/4
1/4
1/7
SECURITY
(get/set)
1/4
DESCRIPTION
1/4
1/4
CMOS frequency.
(capability.videoin.type=2)
“auto” indicates auto white balance.
“auto2” indicates auto white balance
2 which is designed for non-bundle lens models.
“manual” indicates keep current value.
“manual2” indicates keep current value for auto2.
“rbgain” indicates using rgain and gbain.
Exposure level
1/4
1/4
Enable auto Iris.
Video Iris for DC Iris.
1/4
1/4
1/4
Enable/disable wield dynamic range.
Enable backlight compensation.
Set auto gain control to normal level or MAX level.
0->2x,
1->4x,
2->8x
0 =>monochrome
1 => color
Flip the image.
Mirror the image.
A 32-bit integer, each bit can be set separately as follows:
Bit 0 => Support camera control function; 0(not support), 1(support)
154 - User's Manual
text imprinttimestamp maxexposure enablepreview string[64]
<boolean>
1, 15, 30,
60, 120, 240,
480
<boolean>
<blank>
0
30
0
1/4
1/4
1/4
1/4
VIVOTEK
Bit 1 => Built-in or external camera; 0 (external), 1(built-in)
Bit 2 => Support pan operation;
0(not support), 1(support)
Bit 3 => Support tilt operation;
0(not support), 1(support)
Bit 4 => Support zoom operation;
0(not support), 1(support)
Bit 5 => Support focus operation;
0(not support), 1(support)
Enclose caption.
Overlay time stamp on video.
Maximum exposure time.
Usage for UI of exposure settings.
Preview settings of video profile.
7.8.1 Video input setting per channel
Group: videoin_c<0~(n-1)> for n channel products, and m is stream number
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION cmosfreq 50, 60 60 1/4 mode 0 1/4
CMOS frequency.
(capability.videoin.type=2)
Set video mode. whitebalance
0 ~
"capability_vid eoin_c<n>_nm ode"-1 auto, auto2, manual, manual2, rbgain auto 1/4 “auto” indicates auto white balance.
“auto2” indicates auto white balance 2 which is designed for non-bundle lens models.
“manual” indicates keep current value.
“manual2” indicates keep current value for auto2.
User's Manual - 155
VIVOTEK
rgain bgain exposurelevel autoiris irismode piris_mode piris_sensitivity piris_response piris_position enableblc agc agcmode maxgain mingain color flip mirror text textonvideo_position textonvideo_size
156 - User's Manual
0~100
0~100
0~12
0~1
6
0
30
30 fixed, indoor, outdoor manual, indoor, outdoor
1~10 outdoor outdoor
4
1~10
1~100
0~1
0,1,2
2
51
0
1
1/4
1/4
1/4
1/4
1/4
1/4
1/4
1/4
1/4
1/4
1/4 auto,fixed
0~100
0~100
0, 1
<boolean>
<boolean> string[64] top, bottom
15,25,30
0
1 auto
100
0
0
<blank> top
1/4
1/4
1/4
1/4
15 1/4
1/4
1/4
1/4
1/4
“rbgain” indicates using rgain and gbain.
Manual set rgain value of gain control setting.
Manual set bgain value of gain control setting.
Exposure level set 1 to enable auto iris, set 0 to disable auto iris.
Video Iris for DC Iris.
P-Iris mode.
P-Iris sensitivity for indoor and outdoor mode.
P-Iris response time for manual mode.
P-Iris position for manual mode.
Enable backlight compensation
Set auto gain control to normal level or MAX level.
0->2x,
1->4x,
2->8x
Set auto gain control mode.
Manual set maximum gain value.
Manual set minimum gain value.
0 =>monochrome
1 => color
Flip the image.
Mirror the image.
Enclose caption.
Position of timestamp and video title on image
Timestamp and video title font-size
imprinttimestamp exposuremode minexposure maxexposure enablepreview
<boolean> auto,fixed
1~32000
1~32000
<boolean>
0 auto
32000
30
0
1/4
1/4
1/4
1/4
1/4 crop_position <coordinate> 1/99
(x,y) crop_size <window size>
(WxH)
2048x1536 1/99
VIVOTEK
Overlay time stamp on video.
Exposure mode
Minimum exposure time.
Maximum exposure time.
Usage for UI of exposure settings. Preview settings of video profile.
Crop left-top corner coordinate.
Crop width and height.
(width must be 16x or 32x and height must be 8x)
Usage for UI of crop setting
Video codec type.
Video resolution in pixels. crop_preview < boolean > 0 1/99 s<0~(m-1)>_codectype s<0~(m-1)>_resolution s<0~(m-1)>_h264_intraperi od s<0~(m-1)>_h264_ratecont rolmode mjpeg, h264
Reference capability_vide oin_resolution
250, 500,
1000, 2000,
3000, 4000 h264
2048x1536 1/4
1000 cbr, vbr, smart cbr
1/4
1/4
1/4 s<0~(m-1)>_h264_priorityp olicy framerate, imagequality framerate 1/4 s<0~(m-1)>_h264_quant 1~5,
99, 100
3 1/4
Intra frame period in milliseconds. cbr, constant bitrate vbr, fix quality smart, smart stream
The policy to apply when the target bit rate is not sufficient to satisfy current encoded conditions.
“framerate” indicates frame rate first.
“imagequality” indicates image quality first.
Quality of video when choosing vbr in “ratecontrolmode”.
99 is the customized manual input setting.
1 = worst quality, 5 = best quality.
100 is percentage mode.
User's Manual - 157
VIVOTEK
s<0~(m-1)>_h264_qvalue 0~51 t s<0~(m-1)>_h264_qpercen 1~100 44 1/4 s<0~(m-1)>_h264_bitrate 1000~400000
00
6000000 1/4 s<0~(m-1)>_h264_maxvbr bitrate
1000~"capabili ty_videoin_c< n>_h264_max bitrate"
40000000 1/4 s<0~(m-1)>_h264_maxfra me s<0~(m-1)>_h264_profile s<0~(m-2)>_h264_smartstr eam_mode s<0~(m-2)>_h264_smartstr eam_foreground_qvalue
158 - User's Manual
1~50,
51~60 (only for NTSC or
60Hz CMOS)
0~2
0~2
0~51
7
20
1
0
20
1/4
1/4
1/4
1/4
1/4
Manual video quality level input.
(s<0~(m-1)>_h264_quant =
99)
Manual video quality level input.
(s<0~(m-1)>_h264_quant =
100)
Set bit rate in bps when choosing cbr in
“ratecontrolmode”.
The maximum allowed bit rate in fixed quality mode.
When the bit rate exceeds this value, frames will be dropped to restrict the bit rate.
* Only valid when
"ratecontrolmode"= vbr
Set maximum frame rate in fps
(for h264).
5M : 1~10fps
3M : 1~20fps
2M : 1~30fps
1080P : 1~30fps
720P : 1~60fps
(for NTSC or 60Hz CMOS)
Indicate H264 profiles
0: baseline
1: main profile
2: high profile
Set Smart stream mode
0:Auto (Motion detection for
ROI)
1:Manual (set manual window for ROI)
2:Auto and Manual (mix both motion detection and Manual window for ROI)
Manual video quality level input.
(s<0~(m-1)>_h264_smartstre am_foreground_quant = 99)
s<0~(m-2)>_h264_smartstr eam_foreground_quant
0~5,
99, 100 s<0~(m-2)>_h264_smartstr eam_background_qvalue
0~51
3
40
1/4
1/4 s<0~(m-2)>_h264_smartstr eam_background_quant
0~5,
99, 100
1 1/4 s<0~(m-2)>_h264_smartstr eam_maxbitrate s<0~(m-2)>_h264_smartstr eam_win_i<0~2>_enable s<0~(m-2)>_h264_smartstr eam_win_i<0~2>_home s<0~(m-2)>_h264_smartstr eam_win_i<0~2>_size s<0~(m-1)>_ mjpeg
_ratecontrolmode s<0~(m-1)>_mjpeg_priority policy
1000~400000
00
0~1 cbr, vbr framerate, imagequality
40000000
0
1/4
1/4
<coordinate> (150,110) 1/4
<window size> (100x75) cbr framerate
1/4
1/4
1/4 s<0~(m-1)>_mjpeg_quant 1~5,
99, 100
3 1/4 s<0~(m-1)>_mjpeg_qvalue 2~97 29 1/4 s<0~(m-1)>_mjpeg_qperce nt
1~100 49 1/4 s<0~(m-1)>_mjpeg_bitrate 1000~400000 14000000 1/4
VIVOTEK
Quality of foreground quality
1 = worst quality, 5 = best quality.
Manual video quality level input.
(s<0~(m-1)>_h264_smartstre am_background_quant = 99)
Quality of background quality
1 = worst quality, 5 = best quality.
Maximum bitrate
Enable or disable the window.
Left-top corner coordinate of the window.
Width and height of the window.
cbr, constant bitrate vbr, fix quality
The policy to apply when the target bit rate is not sufficient to satisfy current encoded conditions.
“framerate” indicates frame rate first.
“imagequality” indicates image quality first.
Quality of JPEG video.
99 is the customized manual input setting.
1 = worst quality, 5 = best quality.
100 is percentage mode.
Manual video quality level input.
(s<0~(m-1)>_mjpeg_quant =
99)
Manual video quality level input.
(s<0~(m-1)>_mjpeg_quant =
100)
Set bit rate in bps when
User's Manual - 159
VIVOTEK
00 s<0~(m-1)>_mjpeg_maxvb rbitrate
1000~"capabili ty_videoin_c< n>_mjpeg_ma xbitrate"
40000000 1/4 s<0~(m-1)>_mjpeg_maxfra me
1~50,
51~60 (only for NTSC or
60Hz CMOS)
10 wdr_mode wdr_strength flickerless
0~1
0~2
0~1
1
1
0
1/4
1/4
1/4
1/4 choosing cbr in
“ratecontrolmode”.
The maximum allowed bit rate in fixed quality mode.
When the bit rate exceeds this value, frames will be dropped to restrict the bit rate.
* Only valid when
"ratecontrolmode"= vbr
Set maximum frame rate in fps
(for JPEG).
5M : 1~13fps
3M : 1~20fps
2M : 1~30fps
1080P : 1~30fps
720P : 1~60fps
(for NTSC or 60Hz CMOS)
Turning WDR Pro on or off.
0: off
1: on
The strength of WDR Pro.
0: low
1: medium
2: high
Turn on(1) or turn off(0) the flickerless mode
7.8.1.1 Alternative video input profiles per channel
In addition to the primary setting of video input, there can be alternative profile video input setting for each channel which might be for different scene of light (daytime or nighttime).
Group: videoin_c0_profile_i<0~(m-1)> (capability. nvideoinprofile > 0)
NAME VALUE DEFAULT DESCRIPTION enable <boolean> 0
SECURITY
(get/set)
1/4 Enable/disable this profile setting night,
1/4 The mode which the profile is applied to.
160 - User's Manual
begintime endtime exposuremode minexposure maxexposure enableblc exposurelevel agc schedule hh:mm hh:mm auto,fixed
1~32000
1~32000
<boolean>
0~12
0,1,2
0
6
2
18:00
06:00 auto
32000
30
1/4
1/4
1/4
1/4
1/4
1/4
1/4
1/4 agcmode maxgain mingain autoiris whitebalance auto,fixed
0~100
0~100
<boolean>
0
0 auto
100 auto, auto2, manual, manual2, rbgain auto
1/4
1/4
1/4
1/4
1/4 rgain bgain irismode piris_mode piris_sensitivity
0~100
0~100
30
30 fixed, indoor, outdoor manual, indoor, outdoor
1~10 outdoor outdoor
4
1/4
1/4
1/4
1/4
1/4
VIVOTEK
Begin time of schedule mode.
End time of schedule mode.
Exposure Mode
Minimum exposure time.
Maximum exposure time.
Enable backlight compensation.
Exposure level
Set auto gain control to normal level or MAX level.
0->2x,
1->4x,
2->8x
Set auto gain control mode.
Manual set maximum gain value.
Manual set minimum gain value.
Enable auto Iris.
“auto” indicates auto white balance.
“auto2” indicates auto white balance
2 which is designed for non-bundle lens models.
“manual” indicates keep current value.
“manual2” indicates keep current value for auto2.
“rbgain” indicates using rgain and gbain.
Manual set rgain value of gain control setting.
Manual set bgain value of gain control setting.
Video Iris for DC Iris.
P-Iris mode.
P-Iris sensitivity for indoor and outdoor mode.
User's Manual - 161
VIVOTEK
piris_response piris_position wdr_mode wdr_strength flickerless
1~10
1~100
0~1
0~2
0~1
2
51
1
1
0
1/4
1/4
1/4
1/4
1/4
P-Iris response time for manual mode.
P-Iris position for manual mode.
Turning WDR Pro on or off.
0: off
1: on
The strength of WDR Pro.
0: low
1: medium
2: high
Turn on(1) or turn off(0) the flickerless mode exposuremode minexposure maxexposure exposurelevel enableblc irismode piris_mode piris_sensitivity piris_response piris_position wdr_mode
7.9 Video input preview
The temporary settings for video preview
Group: videoinpreview
NAME VALUE DEFAULT auto,fixed
1~32000
1~32000
0~12
<boolean> fixed, indoor, outdoor manual, indoor, outdoor
1~10 auto
32000
30
6
0 outdoor outdoor
4
1~10
1~100
0~1
2
51
1 wdr_strength 0~2 1
4/4
1/4
4/4
SECURITY
(get/set)
4/4
4/4
4/4
4/4
4/4
4/4
DESCRIPTION
Exposure Mode
Minimum exposure time.
Maximum exposure time.
Exposure level
Enable backlight compensation.
Video Iris for DC Iris.
1/4
4/4
4/4
P-Iris mode.
P-Iris sensitivity for indoor and outdoor mode.
P-Iris response time for manual mode.
P-Iris position for manual mode.
Turning WDR Pro on or off.
0: off
1: on
The strength of WDR Pro.
0: low
1: medium
162 - User's Manual
agc agcmode maxgain mingain autoiris
0,1,2 1 4/4 auto,fixed
0~100
0~100
<boolean>
0
0 auto
100
4/4
4/4
4/4
4/4
VIVOTEK
2: high
Set auto gain control to normal level or MAX level.
0->2x,
1->4x,
2->8x
Set auto gain control mode.
Manual set maximum gain value.
Manual set minimum gain value.
Enable auto Iris.
7.10 IR cut control
Group: ircutcontrol (capability.nvideoinprofile > 0)
NAME VALUE DEFAULT SECURITY
(get/set)
6/6
DESCRIPTION
Set IR cut control mode sir daymodebegintime daymodeendtime enableextled bwmode day, night, di, schedule
<boolean> 0
00:00~23:59 07:00
00:00~23:59 18:00
<boolean> 0
<boolean> 1
4/4
6/6
6/6
1/6
6/6
6/6
Enable/disable Smart IR
Day mode begin time
Day mod end time
Enable/disable external IR led
(capability.extir > 0)
Switch to B/W in night mode if enabled
Sensitivity of light sensor normal, high
User's Manual - 163
VIVOTEK
7.11 Image setting per channel
Group: image_c<0~(n-1)> for n channel products
NAME VALUE DEFAULT brightness saturation saturationpercent contrast sharpness sharpnesspercent gammacurve lowlightmode dnr_mode dnr_strength profile_i0_enable
-5~5
-5~5,100
0~100
-5 ~ 5
-3~3,100
0~100
0~100
<boolean>
0~1
1~100
<boolean>
-5
0
50
0
0
50
0
1
0
50
0
4/4
4/4
4/4
4/4
SECURITY
(get/set)
4/4
DESCRIPTION
4/4
4/4
4/4
4/4
4/4
4/4
4/4
Adjust brightness of image according to mode settings.
Adjust saturation of image according to mode settings.
100 for saturation percentage mode.
Adjust saturation value of percentage when saturation=100
Adjust contrast of image according to mode settings.
Adjust sharpness of image according to mode settings.
Adjust sharpness value of percentage when sharpness=100
Gamma curve.
Enable/disable low light mode.
Enable/disable noise reduction
The strength of noise reduction.
1~33: low
34~67: medium
68~100: high
Enable/disable this profile setting
The mode which the profile is applied to.
profile_i0_policy day, night night, schedule profile_i0_begintime profile_i0_endtime profile_i0_brightness hh:mm hh:mm
-5~5
18:00
06:00
-5
-5 ~ 5 0
4/4
4/4
4/4
4/4
Begin time of schedule mode.
End time of schedule mode.
Adjust brightness of image according to mode settings.
Adjust contrast of image profile_i0_contrast
164 - User's Manual
profile_i0_saturation -5~5,100 profile_i0_saturationpercent 0~100 profile_i0_sharpness -3~3,100 profile_i0_sharpnesspercent 0~100 profile_i0_gammacurve profile_i0_lowlightmode profile_i0_wdrcstrength profile_i0_wdrcmode
0~100
<boolean>
0~2
0~3 profile_i0_dnr_mode 0~1 profile_i0_dnr_strength 1~100
0
1
1
0
50
0
50
0
1
50
4/4
4/4
4/4
4/4
4/4
4/4
4/4
4/4
4/4
4/4
VIVOTEK
according to mode settings.
Adjust saturation of image according to mode settings.
100 for saturation percentage mode.
when profile_i0_saturation=100, adjust saturation value of percentage according to mode settings.
Adjust sharpness of image according to mode settings.
Adjust sharpness value of percentage when sharpness=100
Gamma curve
Enable/disable low light mode.
WDR enhanced
0: low
1: medium
2: high
WDR enhanced
0: off
1: auto
2: always on
3:keep current value
Enable/disable noise reduction
The strength of noise reduction.
1~33: low
34~67: medium
68~100: high
User's Manual - 165
VIVOTEK
7.12 Image setting for preview
Group: imagepreview_c<0~(n-1)> for n channel products
NAME VALUE DEFAULT SECURITY
(get/set) brightness -5~5 -5 4/4 saturation saturationpercent contrast sharpness sharpnesspercent gammacurve lowlightmode
-5~5,100
0~100
-5 ~ 5
-3~3,100
0~100
0~100
<boolean>
0
50
0
0
50
0
1
4/4
4/4
4/4
4/4
4/4
4/4
4/4
DESCRIPTION
Adjust brightness of image according to mode settings.
Adjust saturation of image according to mode settings.
100 for saturation percentage mode.
Adjust saturation value of percentage when saturation=100
Adjust contrast of image according to mode settings.
Adjust sharpness of image according to mode settings.
Adjust sharpness value of percentage when sharpness=100
Gamma curve
Enable/disable low light mode.
Group: imagepreview
NAME videoin_whitebalance auto, auto2, manual, manual2, rbgain auto videoin_restoreatwb videoin_rgain videoin_bgain
166 - User's Manual
VALUE
0, 1~
0~100
0~100
DEFAULT
0
0
0
SECURITY
(get/set)
4/4
DESCRIPTION
4/4
4/4
4/4
“auto” indicates auto white balance.
“auto2” indicates auto white balance 2 which is designed for non-bundle lens models.
“manual” indicates keep current value.
“manual2” indicates keep current value for auto2.
“rbgain” indicates using rgain and gbain.
Restore of adjusting white balance of image according to mode settings
Manual set rgain value of gain control setting.
Manual set bgain value of gain control
VIVOTEK
setting.
7.13 Audio detection settings
Group: audioin_c<0~(n-1)> for n channel products (capability.audioin>0)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION alarm_enable alarm_level profile_i0_enable
0, 1
1~100
0
50
<boolean> 0
4/4
4/4
4/4
4/4
Enable audio detection
Audio detection alarm level
Enable/disable this profile setting
The mode which the profile is applied to.
night, schedule hh:mm profile_i0_begintime profile_i0_endtime profile_i0_alarm_level hh:mm
1~100
18:00
06:00
50
4/4
4/4
4/4
Begin time of schedule mode.
End time of schedule mode.
Audio detection alarm level
7.14 Audio input per channel
Group: audioin_c<0~(n-1)> for n channel products (capability.audioin>0)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION mute gain boostmic linein,
0, 1
0~100
0~100
1
65
69
1/4
4/4
4/4 micin => use built-in microphone input. linein => use external microphone input.
Disable audio mute.
Gain of input (%).
(audioin_c<0~(n-1)>_source
= linein)
Enable microphone boost.
0 => +0dB
1 => +20dB
2 => +40dB
Or
Gain of input (%).
(audioin_c<0~(n-1)>_source
= micin)
User's Manual - 167
VIVOTEK
s<0~(m-1)>_codectype s<0~(m-1)>_aac4_bitrate
<product dependent> s<0~(m-1)>_g711_mode
<product dependent> s<0~(m-1)>_g726_bitrate s<0~(m-1)>_g726
_bitstreampackingmode s<0~(m-1)>_g726
_vlcmode aac4, g711, g726
16000,
32000,
48000,
64000,
96000,
128000 pcmu, pcma
16000,
24000,
32000,
40000 little, big g711
16000 pcmu
32000 little
0, 1 0
4/4
4/4
4/4
4/4
4/4
4/4
Set audio codec type for input.
Set AAC4 bitrate in bps.
Set G.711 mode.
Set G.726 bitrate in bps.
Set G.726 bit streaming packing mode
Enable vlcmode for G.726
7.15 Time Shift settings
Group: timeshift, c for n channel products, m is stream number (capability.timeshift > 0)
NAME enable c<0~(n-1)>_s
<0~(m-1)>_all ow
VALUE
<boolean>
<boolean>
DEFAUL
T
1
0
SECURIT
Y
(get/set)
4/4
4/4
DESCRIPTION
Enable time shift streaming.
Enable time shift streaming for specific stream.
7.16 Motion detection settings
Group: motion_c<0~(n-1)> for n channel product
NAME VALUE DEFAULT enable win_i<0~2>_enable win_i<0~2>_name
168 - User's Manual
<boolean> 0
<boolean> 0 string[40] <blank>
SECURITY
(get/set)
4/4
4/4
4/4
DESCRIPTION
Enable motion detection.
Enable motion window 1~3.
Name of motion window 1~3.
win_i<0~2>_left win_i<0~2>_top win_i<0~2>_width win_i<0~2>_height
0 ~ 320
0 ~ 240
0 ~ 320
0 ~ 240 win_i<0~2>_objsize 0 ~ 100 win_i<0~2>_sensitivity 0 ~ 100
0
0
0
0
0
0
4/4
4/4
4/4
4/4
4/4
4/4
VIVOTEK
Left coordinate of window position.
Top coordinate of window position.
Width of motion detection window.
Height of motion detection window.
Percent of motion detection window.
Sensitivity of motion detection window.
Group: motion_c<0~(n-1)> profile for m profile and n channel product (capability.nmotionprofile > 0)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION i<0~(m-1)>_enable <boolean> 0 4/4 Enable profile 1 ~
(m-1).
The mode which the profile is applied to.
i<0~(m-1)>_begintime night, schedule hh:mm 18:00 4/4 i<0~(m-1)>_endtime i<0~(m-1)>_win_i<0~2>_enable hh:mm
<boolean>
06:00
0
4/4
4/4
Begin time of schedule mode.
End time of schedule mode.
Enable motion window. i<0~(m-1)>_win_i<0~2>_name string[40] <blank> 4/4 i<0~(m-1)>_win_i<0~2>_left i<0~(m-1)>_win_i<0~2>_top i<0~(m-1)>_win_i<0~2>_width i<0~(m-1)>_win_i<0~2>_objsize i<0~(m-1)>_win_i<0~2>_sensitivity
0 ~ 320
0 ~ 240
0 ~ 320
0 ~ 100
0 ~ 100
0
0
0
0
0
0
4/4
4/4
4/4
4/4
4/4
4/4
Name of motion window.
Left coordinate of window position.
Top coordinate of window position.
Width of motion detection window.
Height of motion detection window.
Percent of motion detection window.
Sensitivity of motion detection window.
User's Manual - 169
VIVOTEK
7.17 Tempering detection settings
Group: tampering_c<0~(n-1)> for n channel product (capability.tampering > 0)
NAME VALUE DEFAULT SECURITY DESCRIPTION
(get/set) enable <boolean> 0 threshold 0 ~ 255 32 duration 10 ~ 600 10
4/4
1/7
4/4
Enable or disable tamper detection.
Threshold of tamper detection.
If tampering value exceeds the ‘threshold’ for more than ‘duration’ second(s), then tamper detection is triggered.
7.18 DDNS
Group: ddns (capability.ddns > 0)
NAME VALUE enable <boolean> provider Safe100,
PeanutHull,
DyndnsDynamic,
DyndnsCustom,
CustomSafe100
DEFAULT
0
DyndnsDyn amic
SECURITY
(get/set)
6/6
6/6
<provider>_ho stname
<provider>_us ernameemail
<provider>_pa sswordkey
<provider>_se rvername string[128] string[64] string[64] string[128]
<blank> 6/6
<blank> 6/6
<blank> 6/6
<blank> 6/6
DESCRIPTION
Enable or disable the dynamic DNS.
Safe100 => safe100.net
PeanutHull => PeanutHull
DyndnsDynamic => dyndns.org
(dynamic)
DyndnsCustom => dyndns.org (custom)
DynInterfree =>dyn-interfree.it
CustomSafe100 => Custom server using safe100 method
Your DDNS hostname.
Your user name or email to login to the
DDNS service provider
Your password or key to login to the
DDNS service provider.
The server name for safe100.
(This field only exists if the provider is customsafe100)
170 - User's Manual
VIVOTEK
7.19 Express link
Group: expresslink
PARAMETER VALUE enable <boolean> url onlyoffline, checkonline, badnetwork string[63]
Default
0
SECURITY
(get/set)
6/6
6/6
DESCRIPTION
Enable or disable express link.
Camera will check the status of network environment and express link URL
NULL 6/6 The url user define to link to camera
7.20 UPnP presentation
Group: upnppresentation
NAME VALUE DEFAULT enable <boolean> 1
SECURITY
(get/set)
6/6
DESCRIPTION
Enable or disable the UPnP presentation service.
7.21 UPnP port forwarding
Group: upnpportforwarding
NAME VALUE DEFAULT enable upnpnatstatus
<boolean> 0
0~3 0
SECURITY
(get/set)
6/6
DESCRIPTION
6/7
Enable or disable the UPnP port forwarding service.
The status of UPnP port forwarding, used internally.
0 = OK, 1 = FAIL, 2 = no IGD router, 3 = no need for port forwarding
User's Manual - 171
VIVOTEK
7.22 System log
Group: syslog
NAME VALUE DEFAULT enableremotelog serverip
<boolean>
<IP address> serverport 514,
1025~65535 level 0~7
0
<blank>
514
6 setparamlevel 0~2 0
SECURITY
(get/set)
6/6
6/6
6/6
DESCRIPTION
Enable remote log.
Log server IP address.
Server port used for log.
6/6
6/6
Levels used to distinguish the importance of the information:
0: LOG_EMERG
1: LOG_ALERT
2: LOG_CRIT
3: LOG_ERR
4: LOG_WARNING
5: LOG_NOTICE
6: LOG_INFO
7: LOG_DEBUG
Show log of parameter setting.
0: disable
1: Show log of parameter setting set from external.
2. Show log of parameter setting set from external and internal.
7.23 UART control
Group: uart (capability.nuart > 0)
NAME VALUE ptzdrivers_i<0~19,
127>_name ptzdrivers_i<0~19,
127>_location enablehttptunnel string[40] string[128]
<boolean>
DEFAULT
<blank>
<blank>
0
SECURITY
(get/set)
1/4
DESCRIPTION
Name of the PTZ driver.
1/4 Full path of the PTZ driver.
1/4 Enable HTTP tunnel channel to control UART.
Group: uart_i<0~(n-1)> n is uart port count (capability.nuart > 0)
172 - User's Manual
VIVOTEK
NAME VALUE DEFAULT SECURITY
(get/set)
4/4
DESCRIPTION baudrate 110,300,600,120
0,2400,3600,480
0,7200,9600,192
00,38400,57600,
115200 databit 5,6,7,8
9600
8
Set baud rate of COM port.
4/4 Data bits in a character frame. stopbit
4/4 For error checking. odd, even
1,2 1 4/4 1
2-1.5 , data bit is 5
2-2
4/4 RS485 or RS232. uartmode rs485, rs485 customdrvcmd_i<0~
9> rs232 string[128] <blank> string[40] <blank> speedlink_i<0~4>_n ame speedlink_i<0~4>_c md string[40] <blank>
1/4
1/4
1/4
PTZ command for custom camera.
Additional PTZ command name.
Additional PTZ command list.
127 (custom),
128 (no driver)
(no driver)
1/4 The PTZ driver is used by this COM port.
7.24 SNMP
Group: snmp (capability.snmp > 0)
NAME VALUE DEFAULT v2 v3 secnamerw secnamero authpwrw
0~1 0
0~1 0 string[31] string[31] string[8~128]
Private
Public
<blank>
SECURITY
(get/set)
6/6
DESCRIPTION
6/6
6/6
6/6
6/6
SNMP v2 enabled. 0 for disable, 1 for enable
SNMP v3 enabled. 0 for disable, 1 for enable
Read/write security name
Read only security name
Read/write authentication password
User's Manual - 173
VIVOTEK
authpwro string[8~128] <blank> 6/6 Read only authentication password authtyperw MD5,SHA MD5 6/6 Read/write authentication type authtypero encryptpwrw encryptpwro encrypttyperw
MD5,SHA string[8~128] string[8~128]
DES
MD5
<blank>
<blank>
DES
6/6
6/6
6/6
6/6
Read only authentication type
Read/write passwrd
Read only password
Read/write encryption type encrypttypero rwcommunity rocommunity syslocation syscontact
DES string[31] string[31] string[128] string[128]
DES
Private
Public
<blank>
<blank>
6/6
6/6
6/6
6/6
6/6
Read only encryption type
Read/write community
Read only community
System location
System contact
7.25 Layout configuration
Group: layout (New version)
NAME VALUE DEFAULT logo_default logo_powerbyvvtk_hidden custombutton_manualtrigger_s how theme_option theme_color_font
<boolean> 1
SECURITY
(get/set)
1/6
DESCRIPTION
0 => Custom logo
1 => Default logo
Hyperlink of the logo w.vivotek.c
om
<boolean> 0 1/6
<boolean> 1
1~4 string[7] theme_color_configfont string[7] theme_color_titlefont string[7]
1
#ffffff
#ffffff
#098bd6
1/6
1/6
1/6
1/6
1/6
0 => display the power by vivotek logo
1 => hide the power by vivotek logo
Show or hide manual trigger (VI) button in homepage
0 -> Hidden
1 -> Visible
1~3: One of the default themes.
4: Custom definition.
Font color
Font color of configuration area.
Font color of video title.
174 - User's Manual
theme_color_controlbackgroun d string[7] theme_color_configbackground string[7]
#565656 1/6
#323232 1/6 theme_color_videobackground string[7] #565656 theme_color_case string[7] #323232
1/6
1/6
VIVOTEK
Background color of control area.
Background color of configuration area.
Background color of video area.
Frame color
7.26 Privacy mask
Group: privacymask_c<0~(n-1)> for n channel product
NAME VALUE DEFAULT enable <boolean> win_i<0~4>_enable <boolean> win_i<0~4>_name string[40] win_i<0~4>_left win_i<0~4>_top
0 ~ 320
0 ~ 240 win_i<0~4>_width 0 ~ 320 win_i<0~4>_height 0 ~ 240
0
0
<blank>
0
0
0
0
SECURITY
(get/set)
4/4
4/4
4/4
4/4
4/4
4/4
4/4
DESCRIPTION
Enable privacy mask.
Enable privacy mask window.
Name of the privacy mask window.
Left coordinate of window position.
Top coordinate of window position.
Width of privacy mask window.
Height of privacy mask window.
7.27 Capability
Group: capability
NAME api_httpversion
VALUE
<string>
DEFAULT
0300a
SECURITY
(get/set)
0/99
DESCRIPTION
The HTTP API version.
Server bootup time. integer>
<positive integer>
Number of IR interfaces.
(Recommand to use ir for built-in
IR and extir for external IR)
Number of PIRs.
<positive integer>
User's Manual - 175
VIVOTEK
<positive integer>
<positive integer>
<positive integer>
<positive integer>
<positive integer> integer>
0/99
0/99 integer> nmediastream <positive 0/99 integer> integer> integer>
<positive integer> nvideoinprofile <positive 0/99 nmotion integer>
0, <positive integer>
3 0/99 nmotionprofile 1 0/99 ptzenabled
0, <positive integer>
0, <positive integer>
0 0/99
Number of digital inputs.
Number of virtual inputs (manual trigger)
Number of digital outputs.
Number of audio inputs.
Number of audio outputs.
Number of video inputs.
Number of video outputs.
Number of media stream per channels.
Number of video settings per channel.
Number of audio settings per channel.
Number of UART interfaces.
Number of video input profiles.
Number of motion window.
Number of motion profiles.
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 => Built-in or external
176 - User's Manual
windowless evctrlchannel joystick storage_dbenabled protocol_https protocol_rtsp protocol_sip
<boolean>
<boolean>
<boolean>
1
1
1
<boolean> 1
< boolean > 1
< boolean > 1
<boolean> 1 integer> protocol_maxgenconnection <positive 10 integer> protocol_rtp_multicast_ <boolean> 1
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
VIVOTEK
camera;
0(external), 1(built-in)
Bit 2 => Support pan operation,
0(not support), 1(support)
Bit 3 => Support tilt operation;
0(not support), 1(support)
Bit 4 => Support zoom operation;
0(not support), 1(support)
Bit 5 => Support focus operation;
0(not support), 1(support)
Bit 6 => Support iris operation;
0(not support), 1(support)
Bit 7 => External or built-in PT;
0(built-in), 1(external)
Bit 8 => Invalidate bit 1 ~ 7;
0(bit 1 ~ 7 are valid),
1(bit 1 ~ 7 are invalid)
Bit 9 => Reserved bit; Invalidate lens_pan, Lens_tilt, lens_zoon, lens_focus, len_iris.
0(fields are valid),
1(fields are invalid)
Indicate whether to support windowless plug-in.
Indicate whether to support HTTP tunnel for event/control transfer.
Indicate whether to support joystick control.
Media files are indexed in database.
Indicate whether to support HTTP over SSL.
Indicate whether to support RTSP.
Indicate whether to support SIP.
The maximum allowed simultaneous connections.
The maximum general streaming connections .
Indicate whether to support
User's Manual - 177
VIVOTEK
scalable protocol_rtp_multicast_ backchannel protocol_rtp_tcp protocol_rtp_http protocol_spush_mjpeg protocol_snmp protocol_ipv6 protocol_pppoe protocol_ieee8021x protocol_qos_cos protocol_qos_dscp protocol_ddns timeshift videoin_type videoin_flexiblebitrate
178 - User's Manual
<boolean> 0
<boolean> 1
<boolean> 1
<boolean> 1
<boolean> 1
<boolean> 1
<boolean> 1
<boolean> 1
<boolean> 1
<boolean> 1
<boolean> 1
<boolean> 1
0, 1, 2 2 h264
Integer>
0, 1 1 h264
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99 scalable multicast.
Indicate whether to support backchannel multicast.
Indicate whether to support RTP over TCP.
Indicate whether to support RTP over HTTP.
Indicate whether to support server push MJPEG.
Indicate whether to support SNMP.
Indicate whether to support IPv6.
Indicate whether to support PPPoE.
Indicate whether to support
IEEE802.1x.
Indicate whether to support CoS.
Indicate whether to support
QoS/DSCP.
Indicate whether to support DDNS.
Indicate whether to support time shift caching stream.
0 => Interlaced CCD
1 => Progressive CCD
2 => CMOS
Available codec of a device.
The sequence is not limited.
EX:
IP7361 supports MPEG4 and
MJPEG, then this is
"mpeg4,mjpeg".
IP8371E supports MPEG4, MJPEG and H.264, then this is
"mpeg4,mjpeg,h264"
This equals
"capability_videoin_c0_streamcod ec".
Support flexible bit rate control or not.
Available resolutions list.
VIVOTEK
videoin_resolution <a list of available resolution separated by commas>
176x144,
320x240,
640x480,
800x600,
1280x960,
1600x1200,
2048x1536
7
0/99
0/99 videoin_nresolution videoin_maxframerate
< number of available resolution list>
<a list of available maximum frame rate separated by commas> videoin_mjpeg_maxframerate <a list of available maximum codec frame rate separated by commas> videoin_h264_maxframerate videoout_codec
<a list of available maximum codec frame rate separated by commas>
<a list of the available codec types separated by commas)
20,
20,
20,
20,
20,
20,
20
20,
20,
20,
20,
20,
20,
20
20,
20,
20,
20,
20,
20
20
<blank>
0/99
0/99
0/99
0/99
How many resolution options
(listed in "resolution") in current video mode.
Available maximum frame list.
Available maximum codec frame list.
For example:
13 means
In 2560x1920,
Mjpeg max frame rate is 13fps.
Available maximum codec frame list.
For example:
10 means
In 2560x1920,
H264 max frame rate is 10fps.
Available codec list.
User's Manual - 179
VIVOTEK
audio_aec audio_mic audio_extmic audio_linein audio_lineout audio_headphoneout audioin_codec audioout_codec camctrl_httptunnel camctrl_privilege uart_httptunnel network_wire network_wireless
180 - User's Manual
<boolean>
<boolean>
<boolean>
<boolean>
0
0
1
1
<boolean> 1
<boolean> 0 aac4, gamr, g711
<product dependent>
<string> g711 g711
<boolean> 0
<boolean> 1
<boolean>
Rx,
Both
<boolean>
<boolean>
0
1
0
0/99
0/99
0/99
0/99
0/99
0/99
0/99
Indicate whether to support acoustic echo cancellation.
Indicate whether to support built-in microphone input.
Indicate whether to support external microphone input.
Indicate whether to support external line input.
(It will be replaced by audio_mic and audio_extmic.)
Indicate whether to support line output.
Indicate whether to support headphone output.
Available codec list for audio input.
0/99
0/99
0/99
0/99
0/99
0/99
0/99
Available codec list for audio output.
Indicate whether to support httptunnel.
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
Indicate whether to support HTTP tunnel for UART transfer.
Indicate transmission mode of the machine: TX = server, Rx = receiver box, Both = DVR.
Indicate whether to support
Ethernet.
Indicate whether to support wireless.
nanystream iva ir extir whitelight iris tampering temperature test_ac wireless_s802dot11b wireless_s802dot11g wireless_s802dot11n derivative_brand npreset eptz
0, <positive integer>
0
<boolean> 0
<boolean> 1
<boolean> 1
<boolean> 0
<boolean> 1
<boolean> 1
<boolean> 0
<boolean> 1
<boolean> 0
<boolean> 0
<boolean> 0
<boolean> 1
0, <positive integer>
0, <positive integer>
20
3
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
VIVOTEK
Indicate whether to support wireless 802.11b+.
Indicate whether to support wireless 802.11g.
Indicate whether to support wireless 802.11n.
Indicate whether to support the upgrade function for the derivative brand. For example, if the value is true, the VVTK product can be upgraded to VVXX. (TCVV<->TCXX is excepted)
Number of preset locations
A 32-bit integer, each bit can be set separately as follows:
Bit 0 => stream 1 supports ePTZ or not.
Bit 1 => stream 2 supports ePTZ or not.
The rest may be deduced by analogy number of any media stream per channel
Indicate whether to support
Intelligent Video analysis
Indicate whether to support built-in IR led.
Indicate whether to support external IR led.
Indicate whether to support white light led.
Indicate whether to support iris control.
Indicate whether to support tampering detection.
Indicate whether to support temperature detection.
Indicate whether to support test ac key.
User's Manual - 181
VIVOTEK
version_onvifdaemon <string> 1.8.0.5 integer> media_snapshot_sizepersecond <positive integer> media_snapshot_maxpreevent <positive integer> media_snapshot_maxpostevent <positive integer> media_videoclip_maxsize <positive integer> media_videoclip_maxlength <positive integer> media_videoclip_maxpreevent <positive integer> image_wdrc <Boolean> 0 image_ iristype image_ focusassist
<string> piris
<Boolean> 0 adaptiverecording <boolean> 1 0/99 adaptivestreaming <boolean> 1 remotecamctrl_master 0, <positive integer>
0/99
0 0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99
0/99 remotecamctrl_slave supportsd fisheye
<boolean> 0
<boolean> 1
<Boolean> 0
0/99
0/99
0/99
Indicate ONVIF daemon version
Available memory space (KB) for media.
Maximum size (KB) of one snapshot image.
Maximum snapshot number before event occurred.
Maximum snapshot number after event occurred.
Maximum size (KB) of a videoclip.
Maximum length (second) of a videoclip.
Maximum duration (second) before event occurred in a videoclip.
Indicate whether to support WDR enhanced.
Indicate iris type.
Indicate whether to support focus assist.
Indicate whether to support adaptive recording.
Indicate whether to support adaptive streaming.
Indicate whether to support remote auxiliary camera (master side), this value means supporting max number of auxiliary camera.
Indicate whether to support remote camera control (slave side).
Indicate whether to support local storage.
Indicate fisheye model.
182 - User's Manual
VIVOTEK
7.28 WebAPI: Information for a channel
Group: capability_videoin_c<n>, n = channel index from 0 to "capability_nvideoin"-1
PARAMETER VALUE DEFAULT SECURITY DESCRIPTION
(get/set)
0/99 maxsize mode
Integer>
<WxH>
<Integer>
2048x1536 0/99
0 0/99
Indicate how many video modes supported by this channel.
The maximum resolution of all modes in this channel, the unit is pixel.
Indicate current video mode. resolution
Integer>
A list of
<WxH>
0/99
176x144,
320x240,
640x480,
800x600,
1280x960,
1600x1200,
2048x1536
0/99 maxframerate A list of
<Integer>
20,
20,
20,
20,
20,
20,
20
0/99 mjpeg_ maxframerate A list of
<Positive
Integer> and
"-"
20,
20,
20,
20,
0/99
20,
20,
20 mjpeg_maxbitrate <Positive 0/99
Integer>, -
How many resolution options (listed in
"resolution") in current video mode.
Resolution options in current video mode.
These options are the possible options for
"videoin_c<n>_s<m>_resolution".
The last one is the maximum resolution in current mode.
Indicate how many frame rate image sensor outputs in current video mode.
One to one mapping to the resolution in
"resolution".
Maximum fps that the device can encoded with MJPEG on resolutions in current video mode.
"-" means not support.
Maximum bitrates of MJPEG.
The unit is bps.
"-" means MJPEG does not support bit rate control.
User's Manual - 183
VIVOTEK
h264_ maxframerate A list of
<Positive
Integer> and
"-"
20,
20,
20,
20,
20,
20,
20
0/99 h264_maxbitrate <Positive 0/99
Integer>
0/99
Integer>
Maximum fps that the device can encoded with H.264 on resolutions in current video mode.
"-" means not support.
Maximum bitrates of H.264.
The unit is bps.
Represent supported codec types of each stream.
This contains a list of positive integers, split by comma. Each one stands for a stream, and the definition is as following:
Bit 0: Support MPEG4.
Bit 1: Support MJPEG
Bit 2: Support H.264
7.29 WebAPI: Information for a mode
Group: capability_videoin_c<n>_mode<m>, n = channel index from 0 to "capability_nvideoin"-1, m = mode index from 0 to "capability_videoin_c<n>_nmode"-1
PARAMETER VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION effectivepixel dependent>
The visible area of full scene in this video mode.
The unit is pixel in source. outputsize dependent>
The output size of source, equal to the captured size by device, in this video mode. The unit is pixel.
This value is used as a basic coordinate system for many features, like ePTZ, privacy mask, motion, etc. binning 0, 1, 3
Integer>
<mode dependent> dependent>
0/99
0/99
Indicate binning is used or not in this video mode.
0: No binning
1: 2x2 binning
3: 3x3 binning
How many resolution options in this video mode.
184 - User's Manual
resolution maxframerate maxfps_h264 maxfps_mjpeg maxfps_h264
A list of
<WxH>
<mode dependent>
0/99
A list of
<Positive
Integer>
A list of
<Positive
Integer> and
"-"
A list of
<Positive
Integer> and
"-"
A list of
<Positive
Integer> and
"-"
<mode dependent>
0/99
<mode dependent>
<mode dependent>
<mode dependent>
0/99
0/99
0/99
VIVOTEK
Resolution options in this video mode.
The last one is the maximum resolution in this video mode.
Indicate how many frame rate image sensor outputs in this video mode.
Maximum fps which the device can encoded with H264 on resolutions in this video mode.
"-" means not support.
Maximum fps which the device can encoded with MJPEG on resolutions in this video mode.
"-" means not support.
Maximum fps which the device can encoded with H.264 on resolutions in this video mode.
"-" means not support.
* One to one mapping to the resolution in
"resolution".
* The element number is defined as
"nresolution" in this group.
* This parameter records the frame rate when "videoin_c<n>_cmosfreq"=60 or
"videoin_c<n>_modulation"=ntsc
* Only available when 'h264' is listed in
"capability_videoin_codec".
Description about this mode. description <String[128]> <mode dependent>
0/99
7.30 Customized event script
Group: event_customtaskfile_i<0~2>
PARAMETER VALUE Default name date time string[40] <blank> string[4~20] <blank> string[4~20] <blank>
SECURITY
(get/set)
6/6
DESCRIPTION
Custom script identification of this entry.
6/6 Date of custom script.
6/6 Time of custom script.
User's Manual - 185
VIVOTEK
7.31 Event setting
Group: event_i<0~2>
PARAMETER VALUE name enable priority
Default string[40]
0, 1
0, 1, 2
<blank>
0
1 delay triggerstatus di
1~999 20 di, motion, seq, recnotify, tampering, visignal, vi, volalarm, vadp
String[40] trigger
, normal~trigger l trigger~norma
<integer> 1
SECURITY
(get/set)
6/6
DESCRIPTION
Identification of this entry.
6/6
6/6
6/6
6/6
6/6
6/6
Enable or disable this event.
Indicate the priority of this event:
“0” = low priority
“1” = normal priority
“2” = high priority
Delay in seconds before detecting the next event.
Indicate the trigger condition:
“boot” = System boot
“di”= Digital input
“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
“vadp” = VADP trigger
The status for event trigger
The status for event DI 1 trigger
6/6 Indicate the source id of di trigger.
This field is required when trigger condition is “di”.
One bit represents one digital input. The
LSB indicates DI 0.
186 - User's Manual
mdwin mdwin0 vi inter weekday
<integer> 0
<integer> 0
<integer> 0
1~999 1
0~127 127 begintime endtime hh:mm 00:00 6/6 hh:mm 24:00 6/6 lowlightcondition 0, 1 1 6/6
6/6
6/6
6/6
6/6
6/6
VIVOTEK
Indicate the source window id of motion detection.
This field is required when trigger condition is “md”.
One bit represents one window.
The LSB indicates the 1 st
window.
For example, to detect the 1 st
and 3 rd windows, set mdwin as 5.
Similar to mdwin. The parameter takes effect when profile 1 of motion detection is enabled.
Indicate the source id of vi trigger.
This field is required when trigger condition is “vi”.
One bit represents one digital input. The
LSB indicates VI 0.
Interval of snapshots in minutes.
This field is used when trigger condition is “seq”.
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.
Begin time of the weekly schedule.
End time of the weekly schedule.
(00:00 ~ 24:00 sets schedule as always on)
Switch on white light LED in low light condition
0 => Do action at all times
1 => Do action in low-light conditions
User's Manual - 187
VIVOTEK
action_do_i<0~(ndo-1)
>_enable action_do_i<0~(ndo-1)
>_duration action_goto_enable
0, 1
1~999
<Boolean>
0
1
0 action_goto_name string[40] <blank> action_cf_enable <Boolean> 0 action_cf_folder action_cf_media action_cf_datefolder string[128]
NULL, 0~4
<boolean>
<blank>
<blank>
1 action_cf_backup <Boolean> 0
6/6
6/6
6/6
6/6
6/6
6/6
6/6
6/6
6/6 action_server_i<0~4>_e 0, 1 nable
0~4, 101 action_server_i<0~4>_ media action_server_i<0~4>_ datefolder
<boolean>
<Boolean> action_patrol_enable
(only for VS series)
<product dependent> action_ patrol _server
(only for VS series)
<product dependent>
0~255
0
<blank>
0
0
0 6/6
6/6
6/6
6/6
6/6
Enable or disable trigger digital output.
Duration of the digital output trigger in seconds.
Enable/disable ptz goto preset position on event triggered.
Specify the preset name that ptz goto on event triggered.
Enable or disable sending media to SD card.
Path to store media.
Index of the attached media.
Enable this to create folders by date, time, and hour automatically.
Enable or disable the function that send media to SD card for backup if network is disconnected.
Enable or disable this server action.
Index of the attached media.
Enable this to create folders by date, time, and hour automatically.
Enable/disable ptz patrol when event triggered.
Indicate the target servers to which the snapshots taken during patrol dwelling time should be sent.
One bit represents one application server
(server_i0~i4). bit0 (LSB) = server_i0. bit1 = server_i1. bit2 = server_i2. bit3 = server_i3. bit4 = server_i4.
For example, enable server_i0, server_i2, and server_i4 as notification servers; the notifyserver value is 21.
188 - User's Manual
action_autofocus_enable <Boolean>
(only for FD series with remote focus function)
0 6/6
VIVOTEK
Enable/disable auto focus when event triggered.
7.32 Server setting for event action
Group: server_i<0~4>
PARAMETER VALUE DEFAULT name string[40] NULL
SECURITY
(get/set)
6/6
DESCRIPTION
Identification of this entry http_url ftp, http, ns string[128] http://
6/6
6/6
Indicate the server type:
“email” = email server
“ftp” = FTP server
“http” = HTTP server
“ns” = network storage
URL of the HTTP server to upload. http_username http_passwd ftp_address ftp_username ftp_passwd ftp_port ftp_location ftp_passive email_address email_sslmode email_port email_username email_passwd email_senderemail email_recipientemail ns_location ns_username string[64] string[64] string[128] string[64] string[64]
0~65535 string[128]
0, 1 string[128]
0, 1
0~65535 string[64] string[64] string[128] string[640] string[128] string[64]
NULL
0
25
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL
21
NULL
1
6/6
6/6
6/6
6/6
6/6
6/6
6/6
6/6
6/6
6/6
6/6
6/6
6/6
6/6
6/6
6/6
6/6
Username to log in to the server.
Password of the user.
FTP server address.
Username to log in to the server.
Password of the user.
Port to connect to the server.
Location to upload or store the media.
Enable or disable passive mode.
0 = disable passive mode
1 = enable passive mode
Email server address.
Enable support SSL.
Port to connect to the server.
Username to log in to the server.
Password of the user.
Email address of the sender.
Email address of the recipient.
Location to upload or store the media.
Username to log in to the server.
User's Manual - 189
VIVOTEK
ns_passwd ns_workgroup string[64] string[64]
NULL
NULL
6/6
6/6
Password of the user.
Workgroup for network storage.
7.33 Media setting for event action
Group: media_i<0~4> (media_freespace is used internally.)
PARAMETER VALUE DEFAULT SECURITY
(get/set) name string[40] NULL 6/6
DESCRIPTION
Identification of this entry
6/6 Media type to send to the server or store on the server. snapshot_source systemlog, videoclip, recordmsg
<integer> 0 6/6 snapshot_prefix snapshot_datesuffix snapshot_preevent snapshot_postevent videoclip_source videoclip_prefix videoclip_preevent string[16]
0, 1
0 ~ 7
0 ~ 7
<integer> string[16]
0 ~ 9
Snapshot1_ 6/6
0
1
1
0
6/6
6/6
6/6
6/6
VideoClip1_ 6/6
0 6/6
Indicate the source of media stream.
0 means the first stream.
1 means the second stream and etc.
2 means the third stream and etc.
3 means the fourth stream and etc.
Indicate the prefix of the filename. media_i0=> Snapshot1_ media_i1=> Snapshot2_ media_i2=> Snapshot3_ media_i3=> Snapshot4_ media_i4=> Snapshot5_
Add date and time suffix to filename:
1 = Add date and time suffix.
0 = Do not add.
Indicates the number of pre-event images.
The number of post-event images.
Indicate the source of media stream.
0 means the first stream.
1 means the second stream and etc.
2 means the third stream and etc.
3 means the fourth stream and etc.
Indicate the prefix of the filename.
Indicates the time for pre-event recording in seconds.
190 - User's Manual
videoclip_maxduration 1 ~ 20 videoclip_maxsize 50 ~ 6144
5
500
6/6
6/6
VIVOTEK
Maximum duration of one video clip in seconds.
Maximum size of one video clip file in
Kbytes.
7.34 Recording
Group: recording_i<0~1>
PARAMETER VALUE name
DEFAULT string[40] NULL networkfail enable priority source limitsize cyclic notify
0, 1
0, 1, 2
0~2
0,1
0,1
0,1
0
0
1
0
1
0
SECURITY
(get/set)
6/6
DESCRIPTION
Identification of this entry.
6/6
6/6
6/6
6/6
6/6
6/6
6/6
The event trigger type schedule: The event is triggered by schedule networkfail: The event is triggered by the failure of network connection.
Enable or disable this recording.
Indicate the priority of this recording:
“0” indicates low priority.
“1” indicates normal priority.
“2” indicates high priority.
Indicate the source of media stream.
0 means the first stream.
1 means the second stream and so on.
0: Entire free space mechanism
1: Limit recording size mechanism
0: Disable cyclic recording
1: Enable cyclic recording
0: Disable recording notification
1: Enable recording notification
User's Manual - 191
VIVOTEK
notifyserver weekday
0~31
0~127
0 reserveamount 0~ 100
0~4
127 begintime endtime hh:mm hh:mm
00:00
24:00
6/6
6/6 prefix cyclesize string[16] <blank> 6/6
200~ 100 6/6
6/6
6/6
6/6
6/6
Indicate which notification server is scheduled.
One bit represents one application server
(server_i0~i4). bit0 (LSB) = server_i0. bit1 = server_i1. bit2 = server_i2. bit3 = server_i3. bit4 = server_i4.
For example, enable server_i0, server_i2, and server_i4 as notification servers; the notifyserver value is 21.
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.
Start time of the weekly schedule.
End time of the weekly schedule.
(00:00~24:00 indicates schedule always on)
Indicate the prefix of the filename.
The maximum size for cycle recording in
Kbytes when choosing to limit recording size.
The reserved amount in Mbytes when choosing cyclic recording mechanism.
The destination to store the recorded data.
“cf” means local storage (CF or SD card).
“0” means the index of the network storage.
192 - User's Manual
cffolder maxsize maxduration adaptive_enable adaptive_preevent string[128]
100~2000
NULL
100
60~3600 60
0,1
0~9 adaptive_postevent 0~10
0
1
1
6/6
6/6
6/6
6/6
6/6
6/6
VIVOTEK
Folder name.
Unit: Mega bytes.
When this condition is reached, recording file is truncated.
Uuit: Second
When this condition is reached, recording file is truncated.
Indicate whether the adaptive recording is enabled
Indicate when is the adaptive recording started before the event trigger point
(seconds)
Indicate when is the adaptive recording stopped after the event trigger point
(seconds)
7.35 HTTPS
Group: https (capability.protocol.https > 0)
NAME VALUE DEFAULT enable policy
<boolean>
<Boolean>
0
0 status countryname manual, install
-3 ~ 1 string[2]
0
TW
SECURITY
(get/set)
6/6
6/6
6/6
6/6
6/6
DESCRIPTION
To enable or disable secure HTTP.
If the value is 1, it will force HTTP connection redirect to HTTPS connection auto => Create self-signed certificate automatically. manual => Create self-signed certificate manually. install => Create certificate request and install.
Specify the https status.
-3 = Certificate not installed
-2 = Invalid public key
-1 = Waiting for certificate
0 = Not installed
1 = Active
Country name in the certificate information.
User's Manual - 193
VIVOTEK
stateorprovincename string[128] localityname string[128]
Asia
Asia
6/6
6/6 organizationname string[64] VIVOTEK Inc. 6/6
VIVOTEK Inc. 6/6 unit string[32] commonname string[64] www.vivotek.
com validdays 0 ~ 3650 3650
6/6
6/6
State or province name in the certificate information.
The locality name in the certificate information.
Organization name in the certificate information.
Organizational unit name in the certificate information.
Common name in the certificate information.
Valid period for the certification.
7.36 Storage management setting
Currently it’s for local storage (SD, CF card)
Group: disk_i<0~(n-1)> n is the total number of storage devices. (capability.storage.dbenabled > 0)
PARAMETER VALUE Default SECURITY
(get/set)
DESCRIPTION cyclic_enabled <boolean> 0 6/6 Enable cyclic storage method. autocleanup_enabled <boolean> 0 6/6 Enable automatic clean up method.
Expired and not locked media files will be deleted. autocleanup_maxage <positive integer> clean up.
7.37 Region of interest
Group: roi_c<0~(n-1)> for n channel product, and m is the number of streams which support ROI.
(capability.eptz > 0)
PARAMETER VALUE Default SECURITY
(get/set)
DESCRIPTION s<0~(m-1)>_home <coordinate> 0,0 1/6 ROI left-top corner coordinate. s<0~(m-1)>_size <window size> 2048x1536 1/6 ROI width and height. The width value must be multiples of 16 and the height value must be multiples of 8
194 - User's Manual
VIVOTEK
7.38 ePTZ setting
Group: eptz_c<0~(n-1)> for n channel product. (capability.eptz > 0)
PARAMETER VALUE Default SECURITY DESCRIPTION
(get/set) osdzoom <boolean> 1 1/4 smooth <boolean> 1 1/4
Indicates multiple of zoom in is
“on-screen display” or not
Enable the ePTZ "move smoothly" feature tiltspeed -5 ~ 5 0 1/7 panspeed zoomspeed autospeed
-5 ~ 5
-5 ~ 5
1 ~ 5
0
0
1
1/7
1/7
1/7
Tilt speed
(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)
Pan speed
(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)
Zoom speed
(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)
Auto pan/patrol speed
(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)
Group: eptz_c<0~(n-1)>_s<0~(m-1)> for n channel product and m is the number of streams which support ePTZ. (capability.eptz > 0)
PARAMETER VALUE Default DESCRIPTION patrolseq string[120] <blank>
SECURITY
(get/set)
1/4 The patrol sequence of ePTZ. All the patrol position indexes will be separated by "," patroldwelling string[160] <blank> 1/4 preset_i<0~19>_name string[40] preset_i<0~19>_pos
<blank>
<coordinate> <blank>
1/7
1/7
The dwelling time (unit: second) of each patrol point, separated by “,”.
Name of ePTZ preset.
(It should be set by ePreset.cgi rather than by setparam.cgi.)
Left-top corner coordinate of the preset.
(It should be set by ePreset.cgi rather than by setparam.cgi.)
User's Manual - 195
VIVOTEK
preset_i<0~19>_size <window size> <blank> 1/7 Width and height of the preset.
(It should be set by ePreset.cgi rather than by setparam.cgi.)
7.39 Exposure window setting per channel
Group: exposurewin_c<0~(n-1)> for n channel products
( capability_ videoin_supportexpwin = 1)
NAME VALUE DEFAULT mode auto, custom, blc auto
SECURITY
(get/set)
4/4 win_i<0~9>_enable win_i<0~9>_policy win_i<0~9>_home win_i<0~9>_size
<boolean>
0~1
<coordinate>
<window size>
0
0
110,90
100x75
4/4
4/4
4/4
4/4
DESCRIPTION
The mode indicates how to decide the exposure. auto: Use full view as the only one exposure window. custom: Use inclusive and exclusive window. blc: Use BLC.
Enable or disable the window.
0: Indicate exclusive.
1: Indicate inclusive.
Left-top corner coordinate of the window.
Width and height of the window.
Group: exposurewin_c<0~(n-1)>_profile for m profile and n channel product
( capability_ videoin_supportexpwin = 1)
NAME VALUE DEFAULT SECURITY DESCRIPTION
(get/set) i<0~(m-1)>_mode auto, custom, blc auto 4/4 i<0~(m-1)>_win_i<0~9>_enable <boolean> i<0~(m-1)>_win_i<0~9>_policy 0~1 i<0~(m-1)>_win_i<0~9>_home <coordinate>
196 - User's Manual
0
0
110,90
4/4
4/4
4/4
The mode indicates how to decide the exposure. auto: Use full view as the only one exposure window.
custom: Use inclusive and exclusive window. blc: Use BLC.
Enable or disable the window.
0: Indicate exclusive.
1: Indicate inclusive.
Left-top corner coordinate
i<0~(m-1)>_win_i<0~9>_size <window size> 100x75 4/4
VIVOTEK
of the window.
Width and height of the window.
7.40 Focus Window setting
Group: focuswindow_c<0~(n-1)> for n channel product.
PARAMETER VALUE Default SECURITY
(get/set) win_i0_enable <boolean> 0 4/4
DESCRIPTION
Enable or disable the window. win_i0_home <coordinate> (300,180) 4/4 Left-top corner coordinate of the window.
win_i0_size <window size> (1280x720) 4/4 Width and height of the window.
7.41 Seamless recording setting
Group: seamlessrecording
PARAMETER VALUE Default maxconnection stream enable guid<0~2>_id guid<0~2>_number manageable
3
1~4
<boolean> string[127] <blank>
0~3
3
1
0
0
SECURITY
(get/set)
1/6
DESCRIPTION
1/6
1/6
“seamless” indicates enable seamless recording.
“manageable” indicates disable seamless recording.
Maximum number of connected seamless streaming.
(Internal used, read only)
1/6
1/6
1/6
Indicate whether seamless recording is recording to local storage or not at present.
(Read only)
The connected seamless streaming ID.
(Read only)
Number of connected seamless streaming with guid<0~2>_id.
(Read only)
User's Manual - 197
VIVOTEK
7.42 VIVOTEK Application Development Platform setting
Group: vadp
NAME version
VALUE DEFAULT SECURITY
(get/set)
<string> <product 6/7 dependent>
6/7 resource_total_memory <integer> <product dependent> resource_total_storage <integer> <product dependent>
6/7 resource_free_memory <integer> <product dependent> resource_free_storage <integer> <product dependent>
6/7
6/7 module_number module_order module_save2sd
<integer> string[40]
0
<blank>
<boolean> <product dependent>
6/7
6/6
6/6
DESCRIPTION
Indicate the VADP version.
Indicate total available memory size for VADP modules.
Indicate total size of the internal storage space for storing VADP modules.
Indicate free memory size for
VADP modules.
Indicate current free storage size for uploading VADP modules.
Record the total module number that already stored in the system.
The execution order of the enabled modules.
Indicate if the module should be saved to SD card when user want to upload it.
If the value is false, save module to the internal storage space and it will occupy storage size.
Group: vadp_module_i<0~(n-1)>
NAME VALUE DEFAULT enable name url
198 - User's Manual
<boolean> 0 string[40] string[120]
<blank>
<blank>
SECURITY
(get/set)
6/6
DESCRIPTION
6/6
6/6
Indicate if the module is enabled or not.
If yes, also add the index of this module to the module_order.
Module name
Define the URL string after the
IP address if the module
vender vendorurl version license licmsg path initscr status statmsg string[40] string[120] string[40] string[40]
<blank>
<blank>
<blank>
<blank> string[128] <blank> string[40] string[40]
<blank>
<blank> string[40] <blank> string[128] <blank>
6/6
6/6
6/6
6/6
6/6
6/6
6/6
6/6
6/6
VIVOTEK
provides it own web page.
The provider of the module.
URL of the vendor.
Version of the module.
Indicate the license status of the module.
Indicate the message that will be show on license status when mouse over.
Record the storage path of the module.
The script that will handle operation commands from the system.
Indicate the running status of the module.
Indicate the message that will be show on the running status when mouse over.
Group: vadp_event
NAME ntrigger
VALUE DEFAULT
<integer> <product dependent>
SECURITY
(get/set)
6/7 triggerlist_i<0~(n-1)>_topic <string> <blank> 6/6
DESCRIPTION
Indicate the number of topics to be transferred to event manager for trigger.
Indicate the event notification with this topic will be transferred to event manager as trigger. n is equal to ntrigger above.
User's Manual - 199
VIVOTEK
8. Useful Functions
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 statuses will be returned.
Return:
HTTP/1.0 200 OK\r\n
Content-Type: text/plain\r\n
Content-Length: <length>\r\n
\r\n
[di0=<state>]\r\n
[di1=<state>]\r\n
[di2=<state>]\r\n
[di3=<state>]\r\n where <state> can be 0 or 1.
Example: Query the status of digital input 1 .
Request: http://myserver/cgi-bin/dido/getdi.cgi?di1
Response:
HTTP/1.0 200 OK\r\n
Content-Type: text/plain\r\n
Content-Length: 7\r\n
\r\n di1=1\r\n
200 - User's Manual
VIVOTEK
Capture Single Snapshot
Note: This request requires Normal User privileges.
Method: GET/POST
Syntax: http://<servername>/cgi-bin/viewer/video.jpg?[channel=<value>][&resolution=<value>]
[&quality=<value>][&streamid=<value>]
If the user requests a size larger than all stream settings on the server, this request will fail.
PARAMETER VALUE DEFAULT DESCRIPTION channel 0~(n-1) 0 resolution <available 0 quality resolution>
1~5 3
The channel number of the video source.
The resolution of the image.
The quality of the image. streamid 0~(m-1) <product The stream number. dependent>
The server will return the most up-to-date snapshot of the selected channel and stream in JPEG format. The size and quality of the image will be set according to the video settings on the server.
Return:
HTTP/1.0 200 OK\r\n
Content-Type: image/jpeg\r\n
[Content-Length: <image size>\r\n]
<binary JPEG image data>
User's Manual - 201
VIVOTEK
Account Management
Note: This request requires Administrator privileges.
Method: GET/POST
Syntax: http://<servername>/cgi-bin/admin/editaccount.cgi
?
method=<value>&username=<name>[&userpass=<value>][&privilege=<value>]
[&privilege=<value>][…][&return=<return page>]
PARAMETER method username userpass
Privilege
Return
VALUE
Add
Delete edit
<name>
<value>
<value> viewer operator admin
<return page>
DESCRIPTION
Add an account to the server. When using this method, the
“username” field is necessary. It will use the default value of other fields if not specified.
Remove an account from the server. When using this method, the
“username” field is necessary, and others are ignored.
Modify the account password and privilege. When using this method, the “username” field is necessary, and other fields are optional. If not specified, it will keep the original settings.
The name of the user to add, delete, or edit.
The password of the new user to add or that of the old user to modify.
The default value is an empty string.
The privilege of the user to add or to modify.
Viewer privilege.
Operator privilege.
Administrator privilege.
Redirect to the page <return page> after the parameter is assigned.
The <return page> can be a full URL path or relative path according to the current path. If you omit this parameter, it will redirect to an empty page.
202 - User's Manual
VIVOTEK
System Logs
Note: This request require Administrator privileges.
Method: GET/POST
Syntax: http://<servername>/cgi-bin/admin/syslog.cgi
Server will return the most up-to-date system log.
Return:
HTTP/1.0 200 OK\r\n
Content-Type: text/plain\r\n
Content-Length: <syslog length>\r\n
\r\n
<system log information>\r\n
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 upgrade the firmware and return with <return page> if indicated.
ePTZ Camera Control (capability.eptz > 0)
Note: This request requires camctrl privileges.
Method: GET/POST
Syntax: http://<servername>/cgi-bin/camctrl/eCamCtrl.cgi?channel=<value>&stream=<value>
User's Manual - 203
VIVOTEK
[&move=<value>] – Move home, up, down, left, right
[&auto=<value>] – Auto pan, patrol
[&zoom=<value>] – Zoom in, out
[&zooming=<value>&zs=<value>] – Zoom without stopping, used for joystick
[&vx=<value>&vy=<value>&vs=<value>] – Shift without stopping, used for joystick
[&x=<value>&y=<value>&videosize=<value>&resolution=<value>&stretch=<value>] – Click on image
(Move the center of image to the coordination (x,y) based on resolution or videosize.)
[ [&speedpan=<value>][&speedtilt=<value>][&speedzoom=<value>][&speedapp=<value>] ] – Set speeds
[&return=<return page>]
Example: http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=0&move=right http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=1&vx=2&vy=2&vz=2 http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=1&x=100&y=100& videosize=640x480&resolution=640x480&stretch=0
PARAMETER channel
VALUE
<0~(n-1)>
DESCRIPTION
Channel of video source. stream <0~(m-1)> Stream. move home Move to home ROI. up down
Move up.
Move down. auto left right pan patrol
Move left.
Move right.
Auto pan.
Auto patrol. zoom stop wide tele
Stop auto pan/patrol.
Zoom larger view with current speed.
Zoom further with current speed. zooming wide or tele zs vx
0 ~ 6
<integer>
Zoom without stopping for larger view or further view with zs speed, used for joystick control.
Set the speed of zooming, “0” means stop.
The direction of movement, used for joystick control. vy <integer> vs 0 ~ 7 Set the speed of movement, “0” means stop.
204 - User's Manual
x y videosize resolution stretch
<integer>
<integer>
<window size>
<window size>
<boolean> speedpan speedtilt speedzoom speedapp return
-5 ~ 5
-5 ~ 5
-5 ~ 5
1 ~ 5
<return page>
VIVOTEK
x-coordinate clicked by user.
It will be the x-coordinate of center after movement. y-coordinate clicked by user.
It will be the y-coordinate of center after movement.
The size of plug-in (ActiveX) window in web page
The resolution of streaming.
0 indicates that it uses resolution (streaming size) as the range of the coordinate system.
1 indicates that it uses videosize (plug-in size) as the range of the coordinate system.
Set the pan speed.
Set the tilt speed.
Set the zoom speed.
Set the auto pan/patrol speed.
Redirect to the page <return page> after the parameter is assigned.
The <return page> can be a full URL path or relative path according to the current path.
ePTZ Recall (capability.eptz > 0)
Note: This request requires camctrl privileges.
Method: GET/POST
Syntax: http://<servername>/cgi-bin/camctrl/eRecall.cgi?channel=<value>&stream=<value>& recall=<value>[&return=<return page>]
PARAMETER channel
VALUE
<0~(n-1)>
DESCRIPTION
Channel of the video source. stream <0~(m-1)> Stream. recall return
Text string less than 40 One of the present positions to recall. characters
<return page> Redirect to the page <return page> after the parameter is assigned.
The <return page> can be a full URL path or relative path according to the current path.
User's Manual - 205
VIVOTEK
ePTZ Preset Locations (capability.eptz > 0)
Note: This request requires Operator privileges.
Method: GET/POST
Syntax: http://<servername>/cgi-bin/operator/ePreset.cgi?channel=<value>&stream=<value>
[&addpos=<value>][&delpos=<value>][&return=<return page>]
PARAMETER channel
VALUE
<0~(n-1)>
DESCRIPTION
Channel of the video source. stream <0~(m-1)> Stream. addpos delpos return
<Text string less than
40 characters>
<Text string less than
40 characters>
<return page>
Add one preset location to the preset list.
Delete preset location from the preset list.
Redirect to the page <return page> after the parameter is assigned.
The <return page> can be a full URL path or relative path according to the current path.
IP Filtering
Note: This request requires Administrator access privileges.
Method: GET/POST
Syntax: <product dependent> http://<servername>/cgi-bin/admin/ipfilter.cgi?type[=<value>] http://<servername>/cgi-bin/admin/ipfilter.cgi?method=add<v4/v6>&ip=<ipaddress>[&index=<value>][&ret urn=<return page>] http://<servername>/cgi-bin/admin/ipfilter.cgi?method=del<v4/v6>&index=<value>[&return=<return page>]
PARAMETER type method
VALUE
NULL allow, deny addv4
DESCRIPTION
Get IP filter type
Set IP filter type
Add IPv4 address into access list. addv6 delv4
Add IPv6 address into access list.
Delete IPv4 address from access list.
206 - User's Manual
ip index return delv6
<IP address>
<value>
<return page>
VIVOTEK
Delete IPv6 address from access list.
Single address: <IP address>
Network address: <IP address / network mask>
Range address:<start IP address - end IP address>
The start position to add or to delete.
Redirect to the page <return page> after the parameter is assigned.
The <return page> can be a full URL path or relative path according to the current path. If you omit this parameter, it will redirect to an empty page.
Event/Control HTTP Tunnel Channel (capability. evctrlchannel >
0)
Note: This request requires Administrator privileges.
Method: GET and POST
Syntax: http://<servername>/cgi-bin/admin/ctrlevent.cgi
-------------------------------------------------------------------------
GET /cgi-bin/admin/ctrlevent.cgi x-sessioncookie: string[22] accept: application/x-vvtk-tunnelled pragma: no-cache cache-control: no-cache
-------------------------------------------------------------------------
POST /cgi-bin/admin/ ctrlevent.cgi x-sessioncookie: string[22] content-type: application/x-vvtk-tunnelled pragma : no-cache cache-control : no-cache content-length: 32767 expires: Sun, 9 Jam 1972 00:00:00 GMT
User must use GET and POST to establish two channels for downstream and upstream. The x-sessioncookie in GET and POST should be the same to be recognized as a pair for one session. The contents of upstream should be base64 encoded to be able to pass through the proxy server.
This channel will help perform real-time event subscription and notification as well as camera control more
User's Manual - 207
VIVOTEK
efficiently. The event and control formats are described in another document.
See Event/control tunnel spec for detail information
Get SDP of Streams
Note: This request requires Viewer access privileges.
Method: GET/POST
Syntax: http://<servername>/<network_rtsp_s<0~m-1>_accessname>
“m” is the stream number.
“network_accessname_<0~(m-1)>” is the accessname for stream “1” to stream “m”. Please refer to the
“subgroup of network: rtsp” for setting the accessname of SDP.
You can get the SDP by HTTP GET.
When using scalable multicast, Get SDP file which contains the multicast information via HTTP.
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 the URL below into an RTSP compatible player. rtsp://<servername>/<network_rtsp_s<0~m-1>_accessname>
“m” is the stream number.
For details on streaming protocol, please refer to the “control signaling” and “data format” documents.
Storage managements (capability.storage.dbenabled > 0)
Note: This request requires administrator privileges.
Method: GET and POST
Syntax: http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=<cmd_type>[&<parameter>=<value>…]
208 - User's Manual
VIVOTEK
The commands usage and their input arguments are as follows.
PARAMETER VALUE cmd_type <string>
DESCRIPTION
Required.
Command to be executed, including search, insert, delete, update, and queryStatus.
Command: search
PARAMETER VALUE DESCRIPTION label <integer primary key> Optional.
The integer primary key column will automatically be assigned a triggerType <text> unique integer.
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> destPath <text>
Optional.
Indicate the file media type.
Please embrace your input value with single quotes.
Ex. mediaType=’videoclip’
Support trigger types are product dependent.
Optional.
Indicate the file location in camera.
Please embrace your input value with single quotes.
Ex. destPath =’/mnt/auto/CF/NCMF/abc.mp4’ resolution <text> Optional.
Indicate the media file resolution.
Please embrace your input value with single quotes.
Ex. resolution=’800x600’ isLocked <boolean> Optional.
Indicate if the file is locked or not.
0: file is not locked.
1: file is locked.
A locked file would not be removed from UI or cyclic storage. triggerTime <text> Optional.
Indicate the event trigger time. (not the file created time)
Format is “YYYY-MM-DD HH:MM:SS”
Please embrace your input value with single quotes.
Ex. triggerTime=’2008-01-01 00:00:00’
User's Manual - 209
VIVOTEK
limit offset
<positive integer>
<positive integer>
If you want to search for a time period, please apply “TO” operation.
Ex. triggerTime=’2008-01-01 00:00:00’+TO+’2008-01-01
23:59:59’ is to search for records from the start of Jan 1 st
2008 to the end of Jan 1 st
2008.
Optional.
Limit the maximum number of returned search records.
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 between 2008-01-01 00:00:00 and
2008-01-01 23:59:59. http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=search&triggerType=’motion’+OR+’di’+OR+’seq’&triggerTi me=’2008-01-01 00:00:00’+TO+’2008-01-01 23:59:59’
Command: delete
PARAMETER label
VALUE DESCRIPTION
<integer primary key> Required.
Identify the designated record.
Ex. label=1
Ex. Delete records whose key numbers are 1, 4, and 8. http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=delete&label=1&label=4&label=8
Command: update
PARAMETER label
VALUE DESCRIPTION
<integer primary key> Required.
Identify the designated record.
Ex. label=1 isLocked <boolean> Required.
Indicate if the file is locked or not.
Ex. Update records whose key numbers are 1 and 5 to be locked status. http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=update&isLocked=1&label=1&label=5
210 - User's Manual
VIVOTEK
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 retType
VALUE xml or javascript
DESCRIPTION
Optional.
Ex. retype=javascript
The default return message is in XML format.
Ex. Query local storage status and call for javascript format return message. http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=queryStatus&retType=javascript
Virtual input (capability.nvi > 0)
Note: Change virtual input (manual trigger) status.
Method: GET
Syntax: http://<servername>/cgi-bin/admin/setvi.cgi?vi0=<value>[&vi1=<value>][&vi2=<value>]
[&return=<return page>]
PARAMETER vi<num> return
Return Code
200
400
VALUE state[(duration)nstate]
DESCRIPTION
Ex: vi0=1
Setting virtual input 0 to trigger state
Where "state" is 0, 1. “0” means inactive or normal state while “1” means active or triggered state.
Where "nstate" is next state after duration.
<return page>
Ex: vi0=0(200)1
Setting virtual input 0 to normal state, waiting 200
milliseconds, setting it to trigger state.
Note that when the virtual input is waiting for next state, it cannot accept new requests.
Redirect to the page <return page> after the request is completely assigned. The <return page> can be a full URL path or relative path according the current path. If you omit this parameter, it will redirect to an empty page.
Description
The request is successfully executed.
The request cannot be assigned, ex. incorrect parameters.
User's Manual - 211
VIVOTEK
503
Examples: setvi.cgi?vi0=0(10000)1(15000)0(20000)1
No multiple duration. setvi.cgi?vi3=0
VI index is out of range. setvi.cgi?vi=1
No VI index is specified.
The resource is unavailable, ex. Virtual input is waiting for next state.
Examples: setvi.cgi?
vi0 =0(15000)1 setvi.cgi?
vi0 =1
Request 2 will not be accepted during the execution time(15 seconds).
Open Anystream (capability.nanystream > 0)
Note: This request requires Viewer access privileges.
Syntax:
For HTTP push server (MJPEG): http://<servername>/videoany.mjpg?codectype=mjpeg[&resolution=<value>&mjpeg_quant=<value>&mjpeg
_qvalue=<value>&mjpeg_maxframe=<value>]
For RTSP (H264), the user needs to input the URL below into an RTSP compatible player. rtsp://<servername>/liveany.sdp?codectype=h264[&resolution=<value>&h264_intraperiod=<value>&h264_r atecontrolmode=<value>&h264_quant=<value>&h264_qvalue=<value>&h264_bitrate=<value>&h264_maxfr ame=<value>]
<product dependent>
PARAMETER codectype resolution
VALUE mjpeg_quant 1~5,
99 mjpeg_qvalue mjpeg_maxframe
2~97
1~30
DESCRIPTION mjpeg, mpeg4, h264 Set codec type for Anystream. capability_videoin_resolution Video resolution in pixels.
Quality of JPEG video.
99 is the customized manual input setting.
1 = worst quality, 5 = best quality.
Manual video quality level input.
(This must be present if mjpeg_quant is equal to 99)
Set maximum frame rate in fps.
3M : 1~20fps
1080P : 1~30fps
212 - User's Manual
VIVOTEK
mpeg4_intraperiod 250, 500, 1000, 2000, 3000,
4000 mpeg4_ratecontrolmode cbr, vbr
Intra frame period in milliseconds. mpeg4_quant 1~5, mpeg4_qvalue mpeg4_bitrate mpeg4_maxframe
99
2~31
1000~40000000
1~25 cbr: constant bitrate vbr: fix quality
Quality of video when choosing vbr in “ratecontrolmode”.
99 is the customized manual input setting.
1 = worst quality, 5 = best quality.
Manual video quality level input.
(This must be present if mpeg4_quant is equal to 99)
Set bit rate in bps when choosing cbr in
“mpeg4_ratecontrolmode”.
Set maximum frame rate in fps.
3M : 1~20fps
1080P : 1~25fps
Intra frame period in milliseconds. h264_intraperiod 250, 500, 1000, 2000, 3000,
4000 h264_ratecontrolmode cbr, vbr h264_quant 1~5, h264_qvalue h264_bitrate h264_maxframe
99
0~51
1000~40000000
1~30 cbr: constant bitrate vbr: fix quality
Quality of video when choosing vbr in
“h264_ratecontrolmode”.
99 is the customized manual input setting.
1 = worst quality, 5 = best quality.
Manual video quality level input.
(This must be present if h264_quant is equal to 99)
Set bit rate in bps when choosing cbr in
“h264_ratecontrolmode”.
Set maximum frame rate in fps.
3M : 1~20fps
1080P : 1~30fps
User's Manual - 213
VIVOTEK
Technical Specifications
Technical Specifications
Model
System Information
CPU
Flash
RAM
Camera Features
Image Sensor
Maximum Resolution
Lens Type
Focal Length
Aperture
Auto-iris
Field of View
Shutter Time
WDR Technology
Day/Night
Minimum Illumination
Pan/tilt/zoom Functionalities
IR Illuminators
On-board Storage
Video
Compression
IB8373-EH
Multimedia SoC (System-on-Chip)
128 MB
256 MB
1/3" Progressive CMOS
2048x1536
Vari-focal, remote focus f = 2.8 ~ 12 mm
F1.8 ~ F2.85
P-iris
29.5° ~ 86.3° (Horizontal)
22.1° ~ 63.3° (Vertical)
37.2° ~ 114.5° (Diagonal)
1/5 sec. to 1/32,000 sec.
WDR Pro
Removable IR-cut filter for day & night function
Smart IR Technology to Avoid Overexposure
0.33 Lux @ F1.8 (Color)
0.001 Lux @ F1.8 (B/W) ePTZ:
48x digital zoom (4x on IE plug-in, 12x built-in)
Built-in IR illuminators, effective up to 30 meters
IR LED*12 with Smart IR Technology
SD/SDHC/SDXC card slot
Maximum Frame Rate
Maximum Streams
S/N Ratio
Dynamic Range
Video Streaming
Image Settings
H.264, MJPEG
H.264:
20 fps @ 2048x1536
30 fps @ 1920x1080
MJPEG:
20 fps @ 2048x1536
30 fps @ 1920x1080
3 simultaneous streams
Above 62 dB
100 dB
Adjustable resolution, quality and bitrate
Adjustable image size, quality and bit rate
Time stamp, text overlay, flip & mirror
Configurable brightness, contrast, saturation, sharpness, white balance, exposure control, gain, backlight compensation, privacy masks, Scheduled profile settings
3D Noise Reduction, Smart Stream
Seamless recording, new text on video, SD recording 1HR
Audio
Audio Capability
Compression
Interface
Network
Users
Audio input/output (full duplex)
AAC, G.711, G.726
External microphone input and output
Protocols
Interface
Live viewing for up to 10 clients
IPv4, IPv6, TCP/IP, HTTP, HTTPS, UPnP, RTSP/RTP/RTCP, IGMP,
SMTP, FTP, DHCP, NTP, DNS, DDNS, PPPoE, CoS, QoS, SNMP,
802.1X
10Base-T/100 BaseTX Ethernet (RJ-45)
Compatible Accessories
ONVIF
Intelligent Video
Video Motion Detection
Alarm and Event
Alarm Triggers
Alarm Events
General
Smart Focus System
Connectors
LED Indicator
Power Input
Power Consumption
Dimensions
Weight
Casing
Safety Certifications
Operating Temperature
Warranty
System Requirements
Operating System
Web Browser
Other Players
Included Accessories
CD
Others
Dimensions
97 mm
Mounting Kits
AM-523
Adapting Plate
Supported, specification available at www.onvif.org
Triple-window video motion detection
Video motion detection, manual trigger, digital input, periodical trigger, system boot, recording notification, camera tampering detection
Event notification using HTTP, SMTP, FTP and NAS server
File upload via HTTP, SMTP, FTP and NAS server
Remote focus
RJ-45 for Network/PoE connection
Audio input
Audio output
AC 24V power input
DC 12V power input
Digital input*1
Digital output*1
System power and status indicator
DC 12V
AC 24V
IEEE 802.3af PoE Class 3
DC: Max.12.24 W (Heater on), 9.5W (Heater off)
AC: Max. 13.11 W (Heater on), 10.1W (Heater off)
PoE: Max. 9.5 W
Ø: 91 mm x 221 mm
Net: 1,314 g (Body only)
Net: 1,911 g (With stand and sunshield)
Weather-proof IP67-rated housing
CE, LVD, FCC Class A, VCCI, C-Tick, UL
Starting Temperature: -40°C ~ 50°C (PoE: -10°C ~ 50°C)
Working Temperature: -50°C ~ 50°C (PoE: -20°C ~ 50°C)
36 months
Microsoft Windows 7/Vista/XP/2000
Mozilla Firefox 7~10 (Streaming only)
Internet Explorer 7/8/9/10
VLC: 1.1.11 or above
QuickTime: 7 or above
User's manual, quick installation guide, Installation Wizard 2, free ST7501 32-channel VMS
Quick installation guide, warranty card, sun shield, wall mount bracket, waterproof RJ45 Ethernet enclosure, alignment sticker, desiccant bag, waterproof connector
296 mm
221 mm
Distributed by:
All specifications are subject to change without notice. Copyright © VIVOTEK INC. All rights reserved.
Ver. 4
VIVOTEK INC.
6F, No.192, Lien-Cheng Rd., Chung-Ho,
New Taipei City, 235, Taiwan, R.O.C.
T: +886-2-82455282 F: +886-2-82455532
VIVOTEK USA
2050 Ringwood Avenue,
San Jose, CA 95131
T: 408-773-8686 F: 408-773-8298
VIVOTEK Europe
Randstad 22-133, 1316BW Almere,
The Netherlands
T: +31(0)36-5298-434
214 - User's Manual
VIVOTEK
Technology License Notice
MPEG-4 AAC Technology
THIS PRODUCT IS LICENSED UNDER THE MPEG-4 AAC AUDIO PATENT LICENSE� THIS PRODUCT MAY
NOT BE DECOMPILED, REVERSE-ENGINEERED OR COPIED, EXCEPT WITH REGARD TO PC SOFTWARE,
OF WHICH YOU MAY MAKE SINGLE COPIES FOR ARCHIVAL PURPOSES� FOR MORE INFORMATION,
PLEASE REFER TO HTTP://WWW.VIALICENSING.COM
�
MPEG-4 Visual Technology
THIS PRODUCT IS LICENSED UNDER THE MPEG-4 VISUAL PATENT PORTFOLIO LICENSE FOR THE
PERSONAL AND NON-COMMERCIAL USE OF A CONSUMER FOR (i) ENCODING VIDEO IN COMPLIANCE
WITH THE MPEG-4 VISUAL STANDARD ("MPEG-4 VIDEO") AND/OR (ii) DECODING MPEG-4 VIDEO THAT
WAS ENCODED BY A CONSUMER ENGAGED IN A PERSONAL AND NON-COMMERCIAL ACTIVITY AND/
OR WAS OBTAINED FROM A VIDEO PROVIDER LICENSED BY MPEG LA TO PROVIDE MPEG-4 VIDEO�
NO LICENSE IS GRANTED OR SHALL BE IMPLIED FOR ANY OTHER USE� ADDITIONAL INFORMATION
INCLUDING THAT RELATING TO PROMOTIONAL, INTERNAL AND COMMERCIAL USES AND LICENSING MAY
BE OBTAINED FROM MPEG LA, LLC� PLEASE REFER TO HTTP://WWW.MPEGLA.COM
�
AMR-NB Standard
THIS PRODUCT IS LICENSED UNDER THE AMR-NB STANDARD PATENT LICENSE AGREEMENT� WITH
RESPECT TO THE USE OF THIS PRODUCT, THE FOLLOWING LICENSORS’ PATENTS MAY APPLY:
TELEFONAKIEBOLAGET ERICSSON AB: US PAT. 6192335; 6275798; 6029125; 6424938; 6058359. NOKIA
CORPORATION: US PAT. 5946651; 6199035. VOICEAGE CORPORATION: AT PAT. 0516621; BE PAT. 0516621;
CA PAT� 2010830; CH PAT� 0516621; DE PAT� 0516621; DK PAT� 0516621; ES PAT� 0516621; FR PAT� 0516621;
GB PAT� 0516621; GR PAT� 0516621; IT PAT� 0516621; LI PAT� 0516621; LU PAT� 0516621; NL PAT� 0516621;
SE PAT 0516621; US PAT 5444816; AT PAT� 819303/AT E 198805T1; AU PAT� 697256; BE PAT� 819303; BR PAT�
9604838-7; CA PAT� 2216315; CH PAT� 819303; CN PAT� ZL96193827�7; DE PAT� 819303/DE69611607T2; DK
PAT. 819303; ES PAT. 819303; EP PAT. 819303; FR PAT. 819303; GB PAT. 819303; IT PAT. 819303; JP PAT. APP.
8-529817; NL PAT� 819303; SE PAT� 819303; US PAT� 5664053� THE LIST MAY BE UPDATED FROM TIME TO
TIME BY LICENSORS AND A CURRENT VERSION OF WHICH IS AVAILABLE ON LICENSOR’S WEBSITE AT
HTTP://WWW.VOICEAGE.COM
�
User's Manual - 215
VIVOTEK
Electromagnetic Compatibility (EMC)
FCC Statement
This device compiles with FCC Rules Part 15� Operation is subject to the following two conditions�
■ This device may not cause harmful interference, and
■ This device must accept any interference received, including interference that may cause undesired operation�
This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to Part 15 of the FCC Rules� These limits are designed to provide reasonable protection against harmful interference in a residential installation� This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications� However, there is no guarantee that interference will not occur in a partial installation� If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures:
■ Reorient or relocate the receiving antenna.
■ Increase the separation between the equipment and receiver.
■ Connect the equipment into an outlet on a circuit different from that to which the receiver is connected.
■ Consult the dealer or an experienced radio/TV technician for help.
Shielded interface cables must be used in order to comply with emission limits�
CE Mark Warning
This is a Class B product� In a domestic environment, this product may cause radio interference, in which case the user may be required to take adequate measures�
VCCI Warning
この装置は、情報処理装置等電波障害自主規制協議会（ＶＣＣＩ）の基準にづくクラスＢ情報技術装置
です。この装置は、家庭環境で使用することを目的としていますが、この装置がラジオやテレビジョン
受信機に近接して使用されると、受信障害を引き起こすことがあります。
取扱説明書に従って正しい取り扱いをして下さい
Liability
VIVOTEK Inc� cannot be held responsible for any technical or typographical errors and reserves the right to make changes to the product and manuals without prior notice� VIVOTEK Inc� makes no warranty of any kind with regard to the material contained within this document, including, but not limited to, the implied warranties of merchantability and fitness for any particular purpose�
216 - User's Manual
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project