User`s Manual
IP816A-HP
Box
Network Camera
User’s Manual
2MP • WDR Pro • Remote back Focus • Snapshot Focus
Rev. 1.1
VIVOTEK
Table of Contents
Overview�������������������������������������������������������������������������������������������������������������������������������������������������������������������� 4
Revision History����������������������������������������������������������������������������������������������������������������������������������������������������� 4
Read Before Use���������������������������������������������������������������������������������������������������������������������������������������������������� 5
Package Contents�������������������������������������������������������������������������������������������������������������������������������������������������� 5
Symbols and Statements in this Document������������������������������������������������������������������������������������������������������������ 5
Physical Description����������������������������������������������������������������������������������������������������������������������������������������������� 6
Mounting the Lens to the Camera�������������������������������������������������������������������������������������������������������������������������� 7
Install the Camera Stand�������������������������������������������������������������������������������������������������������������������������������������� 10
Network Deployment�������������������������������������������������������������������������������������������������������������������������������������������� 11
Software Installation��������������������������������������������������������������������������������������������������������������������������������������������� 14
Ready to Use�������������������������������������������������������������������������������������������������������������������������������������������������������� 15
Accessing the Network Camera��������������������������������������������������������������������������������������������������������������������������� 18
Using Web Browsers�������������������������������������������������������������������������������������������������������������������������������������������� 18
Using RTSP Players��������������������������������������������������������������������������������������������������������������������������������������������� 21
Using 3GPP-compatible Mobile Devices�������������������������������������������������������������������������������������������������������������� 22
Using VIVOTEK Recording Software������������������������������������������������������������������������������������������������������������������� 23
Main Page���������������������������������������������������������������������������������������������������������������������������������������������������������������� 24
Client Settings��������������������������������������������������������������������������������������������������������������������������������������������������������� 30
Configuration����������������������������������������������������������������������������������������������������������������������������������������������������������� 36
System > General settings����������������������������������������������������������������������������������������������������������������������������������� 37
System > Homepage layout �������������������������������������������������������������������������������������������������������������������������������� 39
System > Logs ���������������������������������������������������������������������������������������������������������������������������������������������������� 42
System > Parameters ������������������������������������������������������������������������������������������������������������������������������������������ 44
System > Maintenance����������������������������������������������������������������������������������������������������������������������������������������� 45
Media > Image �������������������������������������������������������������������������������������������������������������������������������������������������� 49
Media > Video������������������������������������������������������������������������������������������������������������������������������������������������������ 61
Media > Audio������������������������������������������������������������������������������������������������������������������������������������������������������ 66
Network > General settings���������������������������������������������������������������������������������������������������������������������������������� 67
Network > Streaming protocols �������������������������������������������������������������������������������������������������������������������������� 75
Network > SNMP (Simple Network Management Protocol)��������������������������������������������������������������������������������� 84
Security > User accounts������������������������������������������������������������������������������������������������������������������������������������� 85
Security > HTTPS (Hypertext Transfer Protocol over SSL)
���������������������������������������������������������������������� 86
Security > Access List ���������������������������������������������������������������������������������������������������������������������������������������� 93
PTZ > PTZ settings���������������������������������������������������������������������������������������������������������������������������������������������� 98
PTZ��������������������������������������������������������������������������������������������������������������������������������������������������������������������� 101
Mechanical PTZ Operation��������������������������������������������������������������������������������������������������������������������������������� 101
Event > Event settings��������������������������������������������������������������������������������������������������������������������������������������� 106
Applications > Motion detection������������������������������������������������������������������������������������������������������������������������� 120
Applications > DI and DO����������������������������������������������������������������������������������������������������������������������������������� 123
Applications > Tampering detection ������������������������������������������������������������������������������������������������������������������� 123
Applications > Audio detection ������������������������������������������������������������������������������������������������������������������������� 124
Package management (VADP, VIVOTEK Application Development Platform) ������������������������������������������������� 126
Snapshot Focus������������������������������������������������������������������������������������������������������������������������������������������������� 128
Recording > Recording settings ������������������������������������������������������������������������������������������������������������������������ 130
2 - User's Manual
VIVOTEK
Local storage > SD card management����������������������������������������������������������������������������������������������������� 135
Local storage > Content management����������������������������������������������������������������������������������������������������� 136
Appendix ���������������������������������������������������������������������������������������������������������������������������������������������������� 139
URL Commands for the Network Camera������������������������������������������������������������������������������������������������ 139
Technical Specifications��������������������������������������������������������������������������������������������������������������������������� 232
Technology License Notice����������������������������������������������������������������������������������������������������������������������� 234
Electromagnetic Compatibility (EMC)������������������������������������������������������������������������������������������������������� 235
User's Manual - 3
VIVOTEK
Overview
The VIVOTEK IP816A-HP is a professional box network camera offering up to 60 fps @
2-Megapixel resolution with superb image quality, even in the darkest hours of the night.
Featuring the improved Wide Dynamic Range Technology, WDR Pro, the IP816A-HP provides
superior visibility in high-contrast lighting environments with 2-shutter capture method.
When combined with 3D Noise Reduction Technology, users can enjoy an increased level of
image detail in extremely dark environments without consuming or wasting unreasonbly high
bandwidth.
To provide top-notch image quality, IP816A-HP also comes with a P-iris lens, which controls the
iris with extreme precision with its built-in stepper motor. Controlled by advanced software, the
lens maintains the iris opening at an optimal level at all times, resulting in superior sharpness
and depth of field. VIVOTEK knows that accurately focusing a megapixel network camera can
be difficult due to the level of image detail. In order to help installers properly adjust the focus
of this high resolution camera, the IP816A-HP is also equipped with VIVOTEK’ s RBF (Remote
Back Focus) System, allowing installers to adjust focus even more accurately.
Revision History
■ Rev. 1.0: Initial release
■ Rev. 1.1: Corrected DO pin description
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
■ IP816A-HP
■ C-mount lens
■ C-mount adaptor ring
■ Camera Stand
■ L-type Hex key wrench
■ Software CD
■ Quick Installation Guide
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
Front Panel
Light Sensor
Lens
Rear Panel
Microphone In
Recessed Reset Button
Audio Out
SD/SDHC/SDXC Card Slot
Focus Assist Button
Ethernet 10/100 RJ45
Socket
General I/O Terminal Block
Status LED
NTSC/PAL Switch
BNC Video Out
6 - User's Manual
VIVOTEK
Lens
Zoom Controller
Focus Controller
Mounting the Lens to the Camera
1. Jot down the camera's MAC address for later reference.
2. Install a C-mount adaptor ring.
3. Mount the lens by turning it clockwise onto the camera mount until it stops.
4. Connect the P-iris control cable to the socket.
User's Manual - 7
VIVOTEK
General I/O Terminal Block
This Network Camera provides a general I/O terminal block which is used to connect external
input / output devices. The pin definitions are described below. The “AC/DC pw” pins can be
used to connect both 24V AC and 12V DC power source.
DO+
DODI1+
DI2+
DI3+
DI- (common GND)
RS485RS485+
AC/DC pw
AC/DC pw
DI/DO Diagram
1. The DO+ pin provides a 5V output, and the max. load is 50mA.
2. The max. voltage for DO- pins is 80VDC (External power).
In order to control AC devices, the following diagram can be taken into consideration. This
diagram uses a relay to control the ON/OFF condition of the AC device.
3. An external relay can be triggered by using the DO+ or by an external power source,
depending on the type of relay you use.
4. In case of using an individual relay (instead of using a relay module), for protection against
voltage or current spikes, a transient voltage suppression diode must be connected in parallel
with the inductive load.
DIVDC
DO+
DI+
BJT transistor
Switch
DO-
External
power source
NO
AC
Source
NC
Relay
External
device
8 - User's Manual
VIVOTEK
DIDO+
DI+
BJT transistor
VDC
Switch
AC
Source
DO-
NO
NC
Relay
External
device
Hardware Reset
Recessed
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 with a straightened paper clip. 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.
User's Manual - 9
VIVOTEK
Micro SD/SDHC/SDXC Card Capacity
This network camera is compliant with Micro SD/SDHC/SDXC 16GB / 8GB / 32GB /
64GB and other preceding standard SD cards.
Install the Camera Stand
1. Install the camera stand by drilling holes on the ceiling.
2. Secure the stand to ceiling using the screws and anchors.
3. Secure the camera to stand and tighten the fastening ring.
10 - User's Manual
VIVOTEK
Network Deployment
General Connection (with PoE)
4. If you have external devices such as sensors and alarms, connect them to the general I/O
terminal block. Install the camera base to the mounting hole at the bottom of the camera.
5. Connect the camera to a switch using an Ethernet cable.
1. DO+
2. DO3. DI1+
4. DI2+
5. DI3+
6. DI- (common GND)
7. RS4858: RS485+
9. AC/DC pw
10. AC/DC pw
POWER
COLLISION
1
2
3
4
5
LINK
RECEIVE
PARTITION
PoE Switch
NOTE:
•
•
The camera is only to be connected to PoE networks without routing to outside plants.
For PoE connections, use only UL listed I.T.E. with PoE output.
6. Use the included hex wrench to access the SD card socket. Install an SD card.
TM
User's Manual - 11
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 below.
Regarding how to obtain your IP address, please refer to Software Installation on page 14 for
details.
WAN (Wide Area Network )
Internet
Router IP address : from ISP
POWER
COLLISION
1
2
3
4
5
IP address : 192.168.0.3
Subnet mask : 255.255.255.0
Default router : 192.168.0.1
LINK
RECEIVE
PARTITION
LAN (Local Area Network)
Router IP address : 192.168.0.1
Cable or DSL Modem
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 user’s manual.
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 67 for details.
For example, your router and IP settings may look like this:
Device
IP Address: internal
IP Address: External Port (Mapped port on the
port
router)
Public IP of router 122.146.57.120
LAN IP of router
192.168.2.1
Camera 1
192.168.2.10:80
122.146.57.120:8000
Camera 2
192.168.2.11:80
122.146.57.120:8001
...
...
...
12 - User's Manual
VIVOTEK
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.
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 setting on page 67 for details.
Internet connection via PPPoE (Point-to-Point over Ethernet)
Choose this connection type if you are connected to the Internet via a DSL Line. Please
refer to PPPoE on page 68 for details.
User's Manual - 13
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.
IW2
1. Install IW2 under the Software Utility directory from the software CD.
Double-click the IW2 shortcut on your desktop to launch the program.
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: IP816A-HP
MAC:0002D1730202 R o 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
14 - User's Manual
Made in Taiwan
00-02-D1-73-02-02
0002D1730202
192.168.5.151
IP816A-HP
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.
2015/01/11 10:19:19
3. Unscrew the zoom controller to adjust the zoom factor. Upon completion, tighten the zoom
controller.
4. Unscrew the focus controller to adjust the focus range. Upon completion, tighten the focus
controller.
∞
T
N
W
User's Manual - 15
VIVOTEK
5. You may also use the Focus assist button or the auto focus function for the best imaging
result. See Configuration > Image > Focus.
Focus window
16 - User's Manual
x
VIVOTEK
NOTE:
If using a CS-mount lens, please notice the specifications as below.
The screw mount (distance A-C) must be shorter than 5.2mm; in case that the bottom of
screw mount may hit the IR Cut Filter.
A
C
User's Manual - 17
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.
NOTENOTE:
► For Mozilla Firefox or Netscape 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.
18 - User's Manual
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 85.
► If you see a dialog box indicating that your security settings prohibit running ActiveX ®
Controls, please enable the ActiveX ® Controls for your browser.
1. Choose Tools > Internet Options > Security > Custom Level.
2. Look for Download signed ActiveX ® controls; select Enable or Prompt. Click OK.
3. Refresh your web browser, then install the ActiveX ® control. Follow the instructions to
complete installation.
User's Manual - 19
VIVOTEK
IMPORTANT:
1. 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.
2. 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.
3. On Windows 7, the 32-bit explorer browser can be accessed from here:
C:\Program Files (x86)\Internet Explorer\iexplore.exe
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. Below are the defaults for Audio settings:
For cameras with built-in microphone: Not Muted.
For cameras without built-in microphone: Muted.
To receive audio input from external microphone, you may need to enable the audio
input from Media > Audio. Refer to page 66 for more information.
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. In the event of plug-in compatibility issues, you may try to uninstall the plug-in that was
previously installed.
20 - User's Manual
VIVOTEK
Using RTSP Players
To view the video streaming media using RTSP players, you can use one of the following
players that support RTSP streaming.
Quick Time Player
VLC media player
VLC media player
1. Launch the RTSP player.
mpegable
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
pvPlayer
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 76.
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 76 for details.
Video 16:38:01 2012/01/25
User's Manual - 21
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
11.
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 76.
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 61.
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 76.
4. Launch the player on the 3GPP-compatible mobile devices (e.g., Quick Time).
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.
22 - User's Manual
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.
User's Manual - 23
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
The host name can be customized to fit your needs. For more information, please refer to System on page 37.
Camera Control Area
Video Stream: This Network Camera supports multiple streams (stream 1 ~ 3) simultaneously. You can
select any of them for live viewing. For more information about multiple streams, please refer to page 61
for detailed information.
Manual Trigger: Click to enable/disable an event trigger manually. Please configure an event setting
on Application page before enable this function. A total of 3 event settings can be configured. For more
information about event setting, please refer to page 101. If you want to hide this item on the homepage,
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.
24 - User's Manual
VIVOTEK
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 81. For more information about how to set up the viewing region of the
current video stream, please refer to Viewing Windows on page 25.
PTZ control: If a different control interface, e.g., the RS485, is connected, you can select the
Mechanical PTZ control. For example, the camera can be mounted on a mechanical scanner that
enables moving the shooting direction.
The viewing region of
the curruent video
stream
The largest frame size
User's Manual - 25
VIVOTEK
Configuration Area
Client Settings: Click this button to access the client setting page. For more information, please refer to
Client Settings on page 30.
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 36.
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 36.
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)
2015/01/25 17:08:56
Time
Video 17:08:56 2015/01/25
x4.0
Video and Audio Control Buttons
Video Title: The video title can be configured. For more information, please refer to Video Settings on
page 49.
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 30.
Time: Display the current time. For further configuration, please refer to Media > Image > Genral settings
on page 49.
Title and Time: The video title and time can be stamped on the streaming video. For further configuration,
please refer to Media > Image > General settings on page 52.
26 - User's Manual
VIVOTEK
PTZ Panel: This Network Camera supports “digital“ (e-PTZ) pan/tilt/zoom control, which allows roaming
a smaller view frame within a large view frame. Please refer to PTZ settiings on page 98 for detailed
information.
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.
For more information about how to set up the viewing region of the current video stream, please refer to
page 98.
The viewing region of
the curruent 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. Below are the defaults for Audio settings:
For cameras with built-in microphone: Not Muted.
For cameras without built-in microphone: Muted.
To receive audio into from external microphone, you may need to enable the audio input
from Media > Audio. Refer to page 66 for more information.
User's Manual - 27
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
after clicking the Pause button.
Stop: Stop the transmission of the streaming media. Click the
transmission.
Resume button
Resume button to continue
Start MP4 Recording: Click this button to record video clips in MP4 file format to your computer.
Stop MP4 Recording button to end recording. When you exit the web browser, video
Press the
recording stops accordingly. To specify the storage destination and file name, please refer to MP4 Saving
Options on page 31 for details.
Volume: When the
local computer.
Mute function is not activated, move the slider bar to adjust the volume on the
Mute: Turn off the volume on the local computer. The button becomes the
clicking the Mute button.
Audio On button after
Talk: Click this button to talk to people around the Network Camera. Audio will project from
again to end talking
the external speaker connected to the Network Camera. Click this button
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
after clicking the Mute button.
Mic On button
Full Screen: Click this button to switch to full screen mode. Press the “Esc” key to switch back to normal
mode.
28 - User's Manual
VIVOTEK
■ The following window is displayed when the video mode is set to MJPEG:
Video Title
Title and Time
Video (HTTP-V)
2015/01/25 17:08:56
Time
Video 17:08:56 2015/01/25
Video Control Buttons
Video Title: The video title can be configured. For more information, please refer to Media > Image on
page 52.
Time: Display the current time. For more information, please refer to Media > Image on page 52.
Title and Time: Video title and time can be stamped on the streaming video. For more information, please
refer to Media > Image on page 52.
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.
Stop MP4 Recording button to end recording. When you exit the web browser, video
Press the
recording stops accordingly. To specify the storage destination and file name, please refer to MP4 Saving
Options on page 31 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 - 29
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
RTSP Streaming on page 76.
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.
30 - User's Manual
VIVOTEK
Two way audio
Half duplex: Audio is transmitted from one direction at a time, e.g., from a PC holding a web
console with the camera.
Full duplex: Audio is transmitted in both directions simultaneously.
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
Due to the possiblity of encountering unsteady bandwidth flow, the live streaming may lag and not
be very smoothly. If you enable this option, the live streaming will be stored on console PC’s cache
memory for a configurable period of time before being played on the live view window. This helps
you see the streaming more smoothly. If you enter 3000 Millisecond, the streaming will delay for 3
seconds.
User's Manual - 31
VIVOTEK
Joystick Settings
Enable Joystick
Connect to the USB plug of the joystick to a USB port on your management computer. Supported
by the plug-in in the main page (Microsoft’s DirectX), once the plug-in in the main page is loaded, it
will automatically detect if there is any joystick on the computer. 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. Right-click on a live view window. Select Joystick Settings. If your joystick is working properly, it
will be displayed on the drop-down list.
c. Select the joystick you want to configure. Check Enable Joystick, then click Configure Buttons
to open Buttons configuration window.
32 - User's Manual
VIVOTEK
Buttons Configuration
In Button Configuration window, the left column shows the actions you can assign, and the right
column shows the functional buttons and assigned actions. The number of buttons may differ from
different joysticks.
Please follow the steps below to configure your joystick buttons:
1. Choosing one of the actions and click Assign will pop up a dialog. Then you can assign this
action to a button by pressing the joystick button or select it from the drop-down list.
For example: Assign Home (move to home position) to Button 1.
2. Click OK to confirm the configuration.
User's Manual - 33
VIVOTEK
3. The Assigned Action will appear beside Button 1 in the right column as shown in the following
diagram. Note that a button can only be assigned with an action. If you want to modify the
settings, select the action on the list and click Clear Selected.
4. If you want to assign additional actions, repeat step a.~c. When all settings are complete, click
OK to save the settings or click Cancel to discard the settings.
34 - User's Manual
VIVOTEK
5. Click OK to save the settings or click Cancel to discard the settings.
NOTE:
•
•
•
If you want to assign Preset actions to your joystick, the 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.
User's Manual - 35
VIVOTEK
Configuration
Click Configuration on the main page to enter the camera setting pages. Note that only
Administrators can access the configuration page.
VIVOTEK offers an easy-to-use user interface that helps you set up your network camera with
minimal effort.
In order to simplify the user interface, the detailed information will be hidden unless you click on
the function item. When you click on the first sub-item, the detailed information for the first subitem will be displayed; when you click on the second sub-item, the detailed information for the
second sub-item will be displayed and that of the first sub-item will be hidden.
The following is the main page interface:
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),
Client settings, Configuration page, and multi-language selection.
36 - User's Manual
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. When finished with the settings on this page, click Save at the bottom of the page to
enable the settings.
System
Host name: Enter a desired name for the Network Camera. The text will be displayed at the top of the
main page, and also on the view cell of ST7501 and VAST management software.
Turn off the LED indicators: If you do not want others to notice the network camera is in operation, you
can select this option to turn off the LED indicators.
User's Manual - 37
VIVOTEK
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 46 for details.
38 - User's Manual
VIVOTEK
System > Homepage layout
This section explains how to set up a 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 field. 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
40 - User's Manual
Background Color of
the Video Area
Frame Color
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
3
1
4
4. Drag the slide bar and click on the left palette 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.
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
You can install the included ST7501 recording software, which provides an Event
Management function group for delivering event messages via emails, GSM short
messages, onscreen event panel, or to trigger an alarm, etc. For more information, refer to
the ST7501 User Manual.
VIVOTEK Network Cameras
Internet
3G Cell phone
HTTP
Cell phone
Short message
GSM
Modem
PC with
ST7501 Recording Software
Digital output
Email
PTZ
User's Manual - 43
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.
44 - User's Manual
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 locate 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.
User's Manual - 45
VIVOTEK
General settings > Restore
This feature allows you to restore the Network Camera to factory default settings.
Network: Select this option to retain the Network Type settings (please refer to Network Type on page
68).
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 prompt as shown below. Click Open to review the XML file or click Save to
store the file for editing.
46 - User's Manual
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.
User's Manual - 47
VIVOTEK
The following message is displayed when attempting to upload an incorrect file format.
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.
48 - User's Manual
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
2015/01/09 17:08:56
Video 17:08:56 2015/01/09
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. Note that the Rotate function is available only when
User's Manual - 49
VIVOTEK
you select the Video Rotation mode in Media > Video window. See page 61 for more information.
Rotate Normal
Flip
Mirror
Rotate 90°
clockwise
The rotation here indicates clockwise
rotation. Rotation can be applied with flip,
mirror, and physical lens rotation settings
to adapt to different mounting locations.
The figures in the illustration are shown
in a consecutive order.
The camera may be installed on a vertical, side-facing, or tilted surface in order to accommodate
the interior or exterior design of a vehicle or building. Because the interior of a transportation
vehicle is often shaped as a narrow rectangular space, the conventional HD image, such as that
of a 16:9 aspect ratio, will be incongruous with its wide horizontal view. With video rotation, the
camera can more readily cover a tall and narrow field of view.
50 - 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.
IR cut filter
With a removable IR-cut filter, this Network Camera can automatically remove the filter to let IR
light enter the light 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 (1~3)
The Network Camera automatically removes the IR cut filter when a Digital Input is triggerred.
For example, the digital input can come from a housing that is equipped with IR illumination and
control circuits such as VIVOTEK’s AM-214 outdoor housing.
■ 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.
User's Manual - 51
VIVOTEK
Image settings
On this page, you can tune the White balance, Image adjustment and WDR enhanced .
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 color, 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 bars.
Image Adjustment
■ Brightness: Adjust the image brightness level, which ranges from 0% to 100%.
■ Contrast: Adjust the image contrast level, which ranges from 0% to 100%.
■ Saturation: Adjust the image saturation level, which ranges from 0% to 100%.
■ Sharpness: Adjust the image sharpness level, which ranges from 0% to 100%.
■ Gamma curve: Adjust the image sharpness level, which ranges from 0.45 to 1.
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.
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.
52 - User's Manual
VIVOTEK
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.
Electronic image stabilizer
Select the checkbox to enable the Electronic image stabilization (EIS) 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.
Note that when the WDR Pro function is enabled, the Measurement window is not configurable.
Sensor Setting 1:
For normal situations
Sensor Setting 2:
For special situations
User's Manual - 53
VIVOTEK
Measurement Window: Note that when WDR Pro is enabled, this function is not applicable.
This function allows users to configure measurement window(s) for low light compensation. For
example, where low-light objects are posed against an extremely bright background, you may want
to exclude the bright sunlight shining through a building's corridor.
■ Full view: Calculate the full range of view and offer appropriate light compensation.
■ Custom: This option allows you to manually add 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 10 inclusive windows can be
created for a view.
Note that the title pane of the Include
window is not included into the
calculation.
Include
Include
x
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). You can click on the Exposure time and Gain control slide bars to specify a range
of shutter time and Gain control values within which the camera can automatically tune to an
optimal imaging result. You may prefer a shorter shutter time to better capture moving objects,
while a faster shutter reduces light and needs to be compensated by electrical brightness gains.
■ Exposure mode: 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.
54 - User's Manual
VIVOTEK
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 configure iris mode as “indoor” or “outdoor” to reach the best image quality.
■ Iris mode (When the Auto Exposure mode is selected): Select Indoor or Outdoor iris mode to
adapt to the installation. The preset iris aperture setting will apply.
■ Iris adjustment (When the Manual Exposure mode is selected): Manually tune the aperture size
from Close to Open.
■ Iris Adjustment (this option is available when the Manual mode is selected):
The camera comes with a P-iris lens, which controls the iris opening with extreme precision by
its built-in stepping motor. Via software controls, the lens maintains the iris opening at an optimal
level at all times, resulting in superior sharpness and depth of field as well as image quality.
Once set, the iris will stay at current position as long as the lighting condition allows. When
external lighting conditions exceed an acceptable range, the P-iris mechanism adjusts itself.
User's Manual - 55
VIVOTEK
■ WDR Pro:
This refers to the Wide Dynamic Range function that enables the camera to capture details in
a high contrast environment. Use the checkbox to enable the function, and use the slide bar
to select the strength of the WDR Pro functionality, depending on the lighting condition at the
installation site. You can select a higher effect when the contrast is high (between the shaded
area and the light behind the objects).
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 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 for
the configuration take effect.
Please follow the steps below to configure 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.
56 - User's Manual
VIVOTEK
Lens configuration
If you apply a different lens to the camera, you can upload a different configuration file (containing
an image library) for the specific lens module without updating the entire firmware. Please contact
VIVOTEK's technical support for the supported Lens configuration files.
Note that applying a new lens configuration requires a camera reboot.
User's Manual - 57
VIVOTEK
Focus
Focus here refers to the Remote Back Focus, is applicable to Network Cameras that are
equipped with stepping motor lens. The automated focus adjustment function eliminates
the needs to physically adjust camera focus. In an outdoor deployment consisting of a
large number of cameras, the auto focus function can be very helpful when these cameras
become out of focus after days or weeks of operation. And that can easily result from
the effects of natural forces, e.g., shrink and expand due to a wide range of operating
temperatures and the vibration caused by wind.
Focus window
x
Below is the procedure to perform the automated Focus function:
1.Select from the bottom of the screen whether you want to perform focus adjustment on
the Full view or within a Custom focus window. You can create a custom window and
click and drag the window to a desired position on screen.
2. It is recommended to Reset to the default back focus position of the sensor board.
3. You can use the Open iris button to increase the iris size for a better focus adjustment
result.
4. On an initial setup, you can change the zoom factor and roughly make focus using hte
pullers on the lens module.
5. Click to select the Fine-tune focus or the Full-range scan focus buttons. When a fullrange scan is selected, a full-range scan through the camera's entire focal length can
take about 30 to 80 seconds. If not, the auto focus scan will only go through the length
where optimal focus may occur, and that takes about 15 to 20 seconds. In theory, best
results of the auto scan can be acquired when the camera's iris is fully open.
58 - User's Manual
VIVOTEK
6. Wait for the scan to complete. After a short while, the clearest image obtained should
be displayed and the optimal focus range achieved. Use the arrow marks on the sides
to fine-tune the focus if you are not satisfied with the results. You may still need to use the
arrow buttons to fine-tune the focus depending on the live image on your screen. “>” means moving from wide to tele end; and “<” tele to wide.
7. Click on the Enable iris button to save the current configuration.
The methodology of using the Resize Buttons at the upper left corner of the streaming
window is the same as that on the home page.
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.
Please refer to page 128 for information about the Snapshot Focus feature. This feature
is enabled as a VADP package.
User's Manual - 59
VIVOTEK
Privacy mask
Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to
address privacy concerns.
■ 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.
60 - User's Manual
VIVOTEK
Media > Video
Mode
Due to system resources limitations, you can select one of the streaming modes for your
application.
Note that changes made to the video mode may require a system reboot and may erase the
current Motion, Privacy mask, Exposure and Focus settings.
■ Dual Stream (Max. 30fps): Dual video streams are available. Users can define the frame size,
video quality, and a frame rate of up to 30fps.
■ Video Rotation (Max. 30fps): This Rotation mode applies to a tall and norrow field of view
applicable to the monitoring of a corridor or the interior of a vehicle.
■ Single Stream (Max. 60fps): The Single Stream mode at 60fps applies to the monitoring of high
speed traffic such as the installation on a highway.
User's Manual - 61
VIVOTEK
Stream settings
This Network Camera supports multiple streams with frame sizes ranging from 176 x 144 to 1920 x
1080 pixels.
The definition of multiple streams:
■ Stream 1: Users can define the frame size video quality and frame rate of up to 30/60fps.
■ Stream 2: The default frame size for Stream 2 is set to a smaller 640 x 360 size for viewing on
mobile devices.
62 - User's Manual
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 provides real-time H.264 and MJPEG compression standards (Dual Codec)
for real-time viewing. If the H.264 mode is selected, the video is streamed via RTSP protocol.
There are several parameters through which you can adjust the video performance:
■ Frame size
You can set up different video resolutions 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. A higher quality stream can also be
recorded to an NVR. Note that a larger frame size takes up more bandwidth.
■ Maximum frame rate
This limits the maximum refresh frame rate per second. Set the frame rate higher for smoother
video quality and for recognizing moving objects in the field of view.
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 single stream mode allows a 60fps frame rate.
User's Manual - 63
VIVOTEK
■ Intra frame period
Determine how often for firmware 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,
and 8Mbps. 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 20Mbps. 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 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. In low light
conditions, lot of noises can be generated and the frame sizes can significantly
increase. Placing a bit rate limitation can limit the size of frames.
You may also manually enter a bit rate number by selecting the Customized option.
64 - User's Manual
VIVOTEK
If the 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 the H.264.
For Constant Bit Rate and other settings, refer to the previous page for details.
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 load, 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 - 65
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 +21 db (most sensitive) or -33db (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.
66 - 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.
Please rememer to click on the Save button 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 14 for details.
2. Enter the Static IP, Subnet mask, Default router, and Primary DNS provided by your ISP or
network administrator.
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 disable the transmission to destinations across different subnets.
User's Manual - 67
VIVOTEK
Primary DNS: The primary domain name server that translates host names 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 UPnPTM presentation for your Network
Camera so that whenever a Network Camera is presented to the LAN, the shortcuts to connected
Network Cameras will be listed in My Network Places. You can click the shortcut to link to the web
browser. Currently, UPnPTM is supported by Windows XP or later. Note that to utilize this feature,
please make sure the UPnPTM 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 UPnPTM and
it is activated.
PPPoE (Point-to-point over Ethernet)
Select this option to configure your Network Camera to make it accessible from anywhere as long
as there is an Internet connection. Note that to utilize this feature, it requires an account provided
by your ISP.
Follow 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
110) to add a new email or FTP server.
3. Go to Configuration > Event > Event settings > Add media (please refer to Add media on page
115).
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.
68 - User's Manual
VIVOTEK
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 TM
components.
1. Go to Start, click Control Panel, then click Add or Remove Programs.
2. In the Add or Remove Programs dialog box, click Add/Remove Windows Components.
3. In the Windows Components Wizard dialog box, select Networking Services and click
Details.
User's Manual - 69
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 TM work?
UPnP TM 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 46 for details. After the
Network Camera is reset to factory default, it will be accessible on the LAN.
70 - 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 - 71
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
in the following address format: (Please refer to HTTP streaming on page 75 for detailed
information.)
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:
72 - 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 30 and Stream settings on page 61.
Audio transmitted to operators
America
Audio transmitted from operators
Taiwan
User's Manual - 73
VIVOTEK
Audio is being transmitted to the Network Camera
2015/01/09 17:08:56
Mute
Talk Button
Mic Volume
Click
to enable audio transmission to the Network Camera; click
to adjust the volume of
to turn off the audio. To stop talking, click
again.
microphone; click
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.
74 - 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 85 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 ~ 2: This Network camera supports multiple streams simultaneously.
The access name is used to identify different video streams. Users can click Media > Video >
Stream settings to set up the video quality of linked streams. For more information about how to
set up the video quality, please refer to Stream settings on page 61.
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 - 75
VIVOTEK
URL command -- http://<ip address>:<http port>/<access name for stream 1 or 2>
For example, when the Access name for stream 2 is set to video2.mjpg:
1. Launch Mozilla Firefox.
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:
► Microsoft ® Internet Explorer does not support server push technology; therefore, using http://<ip
address>:<http port>/<access name for stream 1 or 2> will fail to access the Network Camera.
► Users can only use URL commands to request the stream 5. For more information about URL
commands, please refer to page 139.
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 85 for details.
76 - 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 below:
Disable
Basic
Digest
Quick Time player
VLC
O
O
O
O
O
X
Access name for stream 1 ~ 2: 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 2>
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 - 77
VIVOTEK
Multicast settings for stream 1, 2: 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
78 - User's Manual
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
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 examine if the host name is valid and automatically open a port on your
router. If using DDNS, the user has to manually configure UPnP port forwarding. Express
Link is more convenient and easier to set up.
Please follow the steps below to enable Express Link:
1. Make sure that your router supports UPnP port forwarding and it is activated.
2. Check Enable express link.
3. Enter a 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 display a
message as shown below.
https://0002D1123456.2bthere.net
2010/12/10 17:0
User's Manual - 79
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.
80 - 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 - 81
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. 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.
82 - 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 - 83
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 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).
84 - User's Manual
VIVOTEK
Security > User accounts
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 36).
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 139. 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 - 85
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 Certificate properties to view detailed information about the certificate.
86 - User's Manual
VIVOTEK
5. Click Save to preserve your configuration, and your current session with the camera will change
to the encrypted connection.
6. If your web session does not automatically change to an encrypted HTTPS session, click Home
to return to the main page. Change the URL address from “http://” to “https://“ in the address bar
and press Enter on your keyboard. Some Security Alert dialogs will pop up. Click OK or Yes to
enable HTTPS.
https://
https://192.168.5.151/index.html
User's Manual - 87
VIVOTEK
Create certificate request and install
1. Select the option from the Method pull-down menu.
2. Click Create certificate to proceed.
3. The following information will show up in a pop-up window after clicking Create. Then click Save
to generate the certificate request.
4. The Certificate request window will prompt.
If you see the following Information bar, click OK and click on the Information bar at the top of
the page to allow pop-ups.
88 - User's Manual
VIVOTEK
5. Look for a trusted certificate authority, such as Symantec’s VeriSign Authentication Services, that
issues digital certificates. Sign in and purchase the SSL certification service. Copy the certificate
request from your request prompt and paste it in the CA’s signing request window. Proceed with
the rest of the process as CA’s instructions on their webpage.
6. Once completed, your SSL certificate should be delivered to you via an email or other means.
Copy the contents of the certificate in the email and paste it in a text/HTML/hex editor/converter,
such as IDM Computer Solutions’ UltraEdit.
User's Manual - 89
VIVOTEK
7. Open a new edit, paste the certificate contents, and press ENTER at the end of the contents to
add an empty line.
8. Convert file format from DOS to UNIX. Open File menu > Conversions > DOS to Unix.
90 - User's Manual
VIVOTEK
9. Save the edit using the “.crt” extension, using a file name like “CAcert.crt.”
10. Return to the original firmware session, use the Browse button to locate the crt certificate file,
and click Upload to enable the certification.
User's Manual - 91
VIVOTEK
11. When the certifice file is successfully loaded, its status will be stated as Active. Note that a
certificate must have been created and installed before you can click on the “Save"
button for the configuration to take effect.
12. To begin an encrypted HTTPS session, click Home to return to the main page. Change the
URL address from “http://” to “https://“ in the address bar and press Enter on your keyboard.
Some Security Alert dialogs will pop up. Click OK or Yes to enable HTTPS.
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 all video streams). 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
85.
2. The administrator has set up a root password, but set RTSP Authentication to “disable“. For
more information about RTSP Authentication, please refer to RTSP Streaming on page 76.
3. The administrator has set up a root password, but allows anonymous viewing. For more
information about Allow Anonymous Viewing, please refer to page 85.
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 67 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.
If IPv6 filter is preferred, you will be prompted by the following window. Enter the IPv6 address and
the two-digit prefix length to specify the range of IP addresses in your configuration.
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: EAPPEAP 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).
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.
1
Certificate Authority
(CA)
1
Certificate
Certificate
2
4
VIVOTEK
Network Camera
Network Switch
3
RADIUS Server
Protected LAN
User's Manual - 97
VIVOTEK
PTZ > PTZ settings
This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation.
There are two ways to enable the camera control function:
1. Digital: Control the e-PTZ operation. Within a field of view, it allows users to quickly move the
focus to a target area for close-up viewing without physically moving the camera.
2. Mechanical: Connect the Network Camera to a PTZ driver or scanner via the RS485
interface.
Digital PTZ Operation (E-PTZ Operation)
The e-PTZ control settings section will be displayed as shown below:
x1.8
x1.8
Select Stream: Select a video stream to set up the e-PTZ control. Please note that each stream can
possess its own preset and patrol settings. For detailed information about how to set up preset and patrol
settings, please refer to page 100.
Auto pan/patrol speed: Select the speed from -5 to 5 (slow/fast) to set up the Auto pan/patrol speed
control.
Zoom factor display
If you check this item, the zoom indicator will be displayed on the home page when you zoom in/out the
live viewing window as the picture shown on the next page.
98 - User's Manual
VIVOTEK
When completed with the e-PTZ settings, click Save to enable the settings on this page.
Home page in the E-PTZ Mode
2012/04/10 17:08:56
x3.3
■ 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. If deselected, the process moving from one point to the other will be
shown, yet it is not easy to observe if the move is not over a long distance.
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 720x480 region from the camera’s 1280x1024
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.
► Click Patrol: The Network Camera will patrol along the selected positions repeatedly.
PTZ
Mechanical PTZ Operation
Select the “Mechanical” tab to display the RS485 Settings:
RS485 Settings
Disable: Select this option to disable this function.
PTZ camera: Select this option to enable PTZ operation.
To utilize this feature, please connect the Network Camera to a PTZ driver or scanner via RS485 serial
interface first. Then you can configure the PTZ driver and RS485 port with the following settings.
VIVOTEK provides the following PTZ drivers: DynaDome/SmartDOME, Lilin PIH-7x00, Pelco D, and
Pelco P protocol. If none of the above PTZ drivers is supported by your PTZ scanner, please select
Custom camera (scanner). Please refer to the documentation of your PTZ scanner to determine the
Camera ID, PTZ driver, and Port settings. The Camera ID is necessary to control multiple cameras. If you
click Save to enable this function, the camera control panel will be displayed on the main page. Please
refer to the illustration on page 38.
User's Manual - 101
VIVOTEK
Transparent HTTP Tunnel: If you want to use your own RS-485 device, you can use UART
commands to build a Transparent HTTP Tunnel. The UART commands will be sent through HTTP
tunnel established between the RS-485 device and the camera. For detailed application notes,
please refer to URL Commands started on page 139 or http://www.vivotek.com/downloadfiles/support/
appnote/14_document_1.pdf.
Preset Positions
If you select DynaDome/SmartDOME, Lilin PIH-7x00, Pelco D, Pelco P protocol as the PTZ driver
and click the Save button, the Preset Position button will become available. Click on the Preset
Position button to open the configuration window. A total of 20 preset positions can be configured.
Please follow the steps below to configure preset positions:
1. Adjust the shooting area to the desired position using the buttons on the right side of the window.
2. Enter a name for the preset position, which allows for up to forty characters. Click Add to enable
the settings. The preset positions will be displayed under the Preset Location list on the left-hand
side.
3. To add additional preset positions, please repeat steps 1~2.
4. To remove a preset position from the list, select it from the drop-down list and click Remove.
5. The preset positions will also be displayed on the main page. Please refer to the illustration on
the next page.
6. Click Save to enable the settings.
2015/1/20 13:39:20
1
Functions are the same as
the Control Panel on the
home page
2
4
102 - User's Manual
6
VIVOTEK
Home page in Mechanical PTZ Mode
The Preset Positions will also be displayed on the home page. Select one from the drop-down list,
and the Network Camera will move to the selected preset position.
User's Manual - 103
VIVOTEK
Patrol Settings
You can select some preset positions for the Network Camera to patrol through them.
Please follow the steps below to set up a patrol schedule:
1. Select preset locations on the list and click on the >> button. They will be replicated to the Patrol
Locations.
2. Set the Dwelling time for the field of view to stay at the preset location during patrol. You can
also manually enter a value in the blank.
3. If you want to delete a selected location, select it from the list and click Remove.
4. Select a location and click the arrow buttons to rearrange the patrol order.
5. Click Save to enable the settings.
2015/1/20 10:19:10
1
2
3
4
5
104 - User's Manual
VIVOTEK
Custom Command
If Custom Camera (scanner) is selected as the PTZ driver, you will need to configure command
buttons to control the PTZ scanner. Click Custom Command to open the Custom Command
page to set the commands in the Control Settings session. Please refer to your PTZ scanner's
documentation to enter the commands in the following fields. Click Save to enable the settings and
click Close to exit the page.
NOTE:
►If you select DynaDome/SmartDOME,
Lilin PIH-7x00, Pelco D, or Pelco
P protocol as the PTZ driver, the
Control Settings column will not be
displayed.
►For all PTZ drivers, a total of five
additional command buttons can be
configured.
►The command buttons will be displayed on the main page:
User's Manual - 105
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 configure an event with reactive measures such as recording video or snapshots, it is necessary to
configure the server and media settings so that the Network Camera will know what action to take (such
as which server to send the media files to) when a trigger is activated. An event is an action initiated by a
user-defined trigger source. In the Event column, click Add to open the event settings window. Here you
can arrange three elements -- Schedule, Trigger, and Action to set an event. A total of 3 event settings
can be configured.
106 - 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 take place too frequently.
1. Schedule
Specify the period of them during which the event trigger will take effect. 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 120 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 overwrite older data.
User's Manual - 107
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
with. To enable this function, you need to configure the Tampering Detection option first. Please refer
to page 123 for detailed information.
■ 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.
108 - User's Manual
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 files on SD card if the network is disconnected. This function
will only be displayed after you set up a recording connection to a network attached storage
(NAS).
User's Manual - 109
VIVOTEK
Add server
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 Add
server to open the server setting window. You can specify where the notification messages are sent to
when a trigger is activated. A total of 5 server settings can be configured.
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).
110 - User's Manual
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.
User's Manual - 111
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.
112 - User's Manual
VIVOTEK
Network storage:
Select to send the media files to a network storage location when a trigger is activated. Please refer to
NAS server on page 133 for details. Note that only one NAS server can be configured.
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
you want to use your SD card for local storage, please format it before use. Please refer to page 115
for detailed information.
■ 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 prompt so that you can manage the
recorded files on SD card. For more information about Local storage, please refer to page 135. If you
click the 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:
20150120
20150121
The format is: YYYYMMDD
Click to open the directory
20150122
Click to delete all recorded data
Click to delete selected items
User's Manual - 113
VIVOTEK
Click 20150120 to open the directory:
The format is: HH (24r)
Click to open the file list for that hour
2015/01/20
2015/01/20
Click to go back to the previous
level of the directory
Click to delete
selected items
Click to delete all
recorded data
2015/01/20
2015/01/20
The format is: File name prefix + Minute (mm)
You can set up the file name prefix on Add media page. Please
refer to next page for detailed information.
114 - User's Manual
VIVOTEK
Add media
Click Add media to open the media setting window. You can specify the type of media that will be
sent when a trigger is activated. A total of 5 media settings can be configured. There are three choices
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.
pre-event images
■ Send
The Network Camera has a buffer to temporarily hold data up to a certain limit. Enter a number to
decide how many images to capture before a trigger is activated. Up to 7 images can be generated.
■ Send post-event images
Enter a number to decide how many images to capture after a trigger is activated. Up to 7 images can
be generated.
For example, 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.
User's Manual - 115
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_20140513_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
display on the Media list. If you wish to add more 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 a video stream as the source of video clip.
■ Pre-event recording
The Network Camera has a buffer to temporarily hold data up to a certain limit. Enter a number to
decide the duration of recording before a trigger is activated. Up to 9 seconds can be set.
■ Maximum duration
Specify the maximum recording duration in seconds. The duration can be up to 10 seconds.
For example, if pre-event recording is set to five seconds 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.
Trigger Activation
116 - User's Manual
9 sec.
10 sec.
VIVOTEK
■ Maximum file size
Specify the maximum file size allowed. Some users may need to stitch the video clips together.
■ File name prefix
Enter the text that will be appended to the front of the file name.
For example:
Video_20150113_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.
User's Manual - 117
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 the Save event button 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, the event configuration above is triggered by motion detection, the
Network Camera will automatically send snapshots via e-mail.
If you want to stop the event trigger, you can click on the ON button to turn it to OFF status or click the
Delete button to remove the event setting.
To remove a server setting from the list, select a server name from the drop-down list and click Delete.
Note that you can only delete a server setting when it is not applied in an existing 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 in an existing setting.
118 - User's Manual
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
User's Manual - 119
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.
2015/1/20 14:39:12
Motion Detection Setting 1:
For normal situations
hallway
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 it to a preferred location, and let cursor stay on the edge of the
window until it changes into resize cursor.
■ 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 slide bars.
4. Click Save to enable the settings.
5. Select Enable motion detection to enable this function.
For example:
2015/1/20
14:39:12
2010/12/10
17:08:56
Video(TCP-AV)
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). For more information on
how to configure an event setting, please refer to Event settings on page 106.
120 - User's Manual
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 preset 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
2015/1/20 14:39:12
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
> Event settings > Trigger to select it as a trigger source. Please refer to page 131 for detailed
information.
User's Manual - 121
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 lower percentage values.
122 - User's Manual
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 as the state of the signal to define the "Normal status" for the
digital input. Connect the digital input lines to the Network Camera, and the camera will report
the current status.
Digital output: Select Grounded or Open as the state of the signal to define the "Normal status"
for the digital output. Connect the digital output lines to the Network Camera, and the camera
will display the current status.
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 131 for detailed information.
User's Manual - 123
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.
124 - User's Manual
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 66 for Audio settings, and page 61 for video streaming settings.
User's Manual - 125
VIVOTEK
Package management (VADP, VIVOTEK Application
Development Platform)
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 technical
support or the vendor of your 3rd-party package 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:
126 - User's Manual
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.
User's Manual - 127
VIVOTEK
Snapshot Focus
Snapshot Focus comes as a standard VADP package. This feature helps find the best
focus when a camera is aiming at an area where no referential or substantial objects
exist, e.g., a highway with flows of high speed vehicles. It is often difficult to find the best
focus when the field of view is set to cover a section of highway while the real target is the
vehicle.
Limitations:
1.This package should be enabled or separately downloaded from VIVOTEK’s website or
technical support to a camera. You may need to register yourself on VIVOTEK’s website
and activate the package.
2.This feature does not support the MJPEG stream. If a camera’s stream 1 is configured
into MJPEG, a warning message will prompt.
Operation Procedure:
1.Press the Snapshot Recording button, e.g., when a car is passing the field of view.
A short, 2.5 seconds of video recording will be available (including 1 second of prerecording and another second of post-recording).
128 - User's Manual
VIVOTEK
2.The recording takes place on Stream 1 with a focusing result calculated from the full of
the current field of view.
3.The Snapshot Focus comes with an embedded Quick time player. Users can review the
current focusing results on a viewing window. Users can also use the left arrow key on
their keyboard to go through the recording in a frame-by-frame manner (after the video is
played once).
In this way, an installer can immediately examine whether the focus is optimal when a
fast going car is captured by video. If not, he can tune the focus again and review the
imaging result until satisfied.
4.Users can also download the short recording clip to a PC. Note that if the Snapshot
Focus page is refreshed or the web session is closed, the recording will be erased.
Note that you can use the arrow buttons on the sides of the Focus tuning bar to find the
best focus.
User's Manual - 129
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:
► Please remember to format your SD card via the camera’s web console (in the Local storage .
SD card management page) when using it for the first time. Please refer to page 135 for detailed
information.
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 configured on the Video quality page. Please refer to page 64 for more information.
130 - 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 saves bandwidth and storage space.
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
► When there is no alarm trigger:
- JPEG mode: record 1 frame per second.
- H.264 mode: record I frame only.
I frame ---> Full frame rate ---> I frame
Bandwidth
Activity Adaptive Streaming
for Dynamic Frame Rate Control
► 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
The alarm trigger includes: motion detection and DI detection. Please refer to Event Settings on page 106.
■ Pre-event recording and post-event recording
The Network Camera has a buffer that temporarily holds data up to a certain limit. Enter a number to
define 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 video stream as the recording source.
NOTE:
► To enable recording notification please configure Event settings first . Please refer to page 106.
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 a networked attached storage
(NAS).
■ Network fail: Since network fail, the server will start to record files on the local storage (SD card).
User's Manual - 131
VIVOTEK
2. Destination
You can select the SD card or network 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.
132 - User's Manual
VIVOTEK
If successful, you will receive a test.txt file on the network storage server.
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.
■ Enable cyclic recording: If you check this item, when the maximum capacity is reached, the oldest file
will be overwritten by the latest one. The reserved amount is reserved for the transaction stage when
the storage space is about to be full and new data arrives. The minimum for the Reserved space must
be larger than 15 MegaBytes.
■ Recording file management: You can manually assign the Maximum 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.
■ File name prefix: Enter the text that will be appended to the front of the file name.
User's Manual - 133
VIVOTEK
f you want to enable recording notification, please click Event to configure event triggering settings.
Please refer to Event > Event settings on page 106 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 recording (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 113 for details.
20150110
20150111
20150112
134 - 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 format
The Linux kernel EXT4 file system format applies to SD card larger than 32GB. However, if EXT4 is
applied, the computers running Windows will not be able to access the contents on the 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 - 135
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 for contents created at a specific point
in time.
Click Search and the recorded data corresponding to the search criteria will be listed in Search Results
window.
136 - 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.
Numbers of entries displayed
on one page
Enter a key word to filter the
search results
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:
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 - 137
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.
138 - 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 - 139
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
DESCRIPTION
0
anonymous
Unprotected.
1 [view]
anonymous, viewer,
1. Can view, listen, talk to camera.
dido, camctrl
2. Can control DI/DO, PTZ of the camera.
anonymous, viewer,
Operator access rights can modify most of the camera’s
dido, camctrl, operator
parameters except some privileges and network options.
anonymous, viewer,
Administrator access rights can fully control the camera’s
dido, camctrl, operator,
operations.
4 [operator]
6 [admin]
admin
7
N/A
Internal parameters. Unable to be changed by any external
interfaces.
140 - 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
oftherelated group will be returned.
When querying parameter values, the current parameter values are returned.
A successful control request returns parameter pairs as follows:
Return:
HTTP/1.0 200 OK\r\n
Content-Type: text/html\r\n
Context-Length: <length>\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 - 141
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
VALUE
DESCRIPTION
<group>_<name>
value to assigned
Assign <value> to the parameter <group>_<name>.
update
<boolean>
Set to 1 to update all fields (no need to update parameter in each
group).
return
<return page>
Redirect to the 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
commandor have any extra parameters.This parameter must be
142 - 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
User's Manual - 143
VIVOTEK
7. Available parameters on the server
Valid values:
VALID VALUES
DESCRIPTION
string[<n>]
Text strings shorter than ‘n’ characters. The characters “,’,<,>,& are invalid.
string[n~m]
Text strings longer than `n’ characters and shorter than `m’ characters. The
characters “,’,<,>,& are invalid.
password[<n>]
The same as string but displays‘*’ instead.
integer
Any number between (-231– 1) and (231– 1).
positive integer
Any number between 0 and (232– 1).
<m> ~ <n>
Any number between ‘m’ and ‘n’.
domain name[<n>]
A string limited to a domain name shorter than ‘n’ characters (eg. www.ibm.com).
email address [<n>]
A string limited to an email address shorter than ‘n’ characters (eg.
[email protected]).
ip address
A string limited to an IP address (eg. 192.168.1.1).
mac address
A string limited to contain a MAC address without hyphens or colons.
boolean
A boolean value of 1 or 0 represents [Yes or No], [True or False], [Enable or
Disable].
<value1>,
Enumeration. Only given values are valid.
<value2>,
<value3>,
…
blank
A blank string.
everything inside <>
A description
integer primary key
SQLite data type. A 32-bit signed integer. The value is assigned a unique integer by
the server.
text
SQLite data type. The value is a text string, stored using the database encoding
(UTF-8, UTF-16BE or UTF-16-LE).
coordinate
x, y coordinate (eg. 0,0)
window size
window width and height (eg. 800x600)
NOTE: The camera should not be restarted when parameters are changed.
144 - User's Manual
VIVOTEK
7.1 system
Group: system
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
hostname
string[64]
IP816A-HP
1/6
Host name of server
(Network Camera,
Wireless Network Camera,
Video Server,
Wireless Video Server).
ledoff
<boolean>
0
6/6
Turn on (0) or turn off (1) all led
indicators.
date
<YYYY/MM/
<current
DD>,
date>
6/6
Current date of system. Set to ‘keep’
to keep date unchanged. Set to ‘auto’
keep,
to use NTP to synchronize date.
auto
time
<hh:mm:s
<current
s>,
time>
6/6
Current time of the system. Set to
‘keep’ to keep time unchanged. Set to
keep,
‘auto’ to use NTP to synchronize time.
auto
datetime
<MMDDhh
<blank>
6/6
mmYYYY.ss
Another current time format of the
system.
>
ntp
<domain
<blank>
6/6
NTP server.
name>,
*Do not use “skip to invoke default
<ip
server” for default value.
address>,
<blank>
timezoneindex
-489 ~ 529
320
6/6
Indicate timezone and area.
-480: GMT-12:00 Eniwetok, Kwajalein
-440: GMT-11:00 Midway Island,
Samoa
-400: GMT-10:00 Hawaii
-360: GMT-09:00 Alaska
-320: GMT-08:00 Las Vegas,
San_Francisco,
Vancouver
-280: GMT-07:00 Mountain Time,
Denver
User's Manual - 145
VIVOTEK
-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
-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
146 - User's Manual
VIVOTEK
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
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
daylight_enable
<boolean>
0
6/6
Enable automaticdaylight saving time
in time zone.
daylight_dstactualmode
< positive
1~4
6/7
integer >
Check if current time is under daylight
saving time.
(Used internally)
daylight_auto_begintime
string[19]
NONE
6/7
Display the current daylight saving
start time.
daylight_auto_endtime
string[19]
NONE
6/7
Display the current daylight saving
end time.
daylight_timezones
string
,-360,-320,
-280,-240,
6/6
List time zone index which support
daylight saving time.
-241,-200,
-201,-160,
-140,-120,
-80,-40,0,
40,41,80,
User's Manual - 147
VIVOTEK
81,82,83,
120,140,
380,400,48
0
updateinterval
0,
0
6/6
0 to Disable automatic time
3600,
adjustment, otherwise, it indicates
86400,
the seconds between NTP automatic
604800,
update intervals.
2592000
restore
0,
N/A
7/6
<positive
Restore the system parameters to
default values after <value> seconds.
integer>
reset
-1, 0,
N/A
7/6
<positive
Restart the server after <value>
seconds if <value> is non-negative.
integer>
restoreexceptnet
<Any
N/A
7/6
value>
Restore the system parameters to
default values except (ipaddress,
subnet, router, dns1, dns2, pppoe).
This command can cooperate with
other “restoreexceptXYZ” commands.
When cooperating with others, the
system parameters will be restored to
the default value except for a union of
the combined results.
restoreexceptdst
<Any
N/A
7/6
value>
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.
restoreexceptlang
<Any
Value>
N/A
7/6
Restore the system parameters to
default values except the custom
language file the user has uploaded.
This command can cooperate with
other “restoreexceptXYZ” commands.
When cooperating with others, the
system parameters will be restored to
148 - User's Manual
VIVOTEK
the default value except for a union of
the combined results.
restoreexceptvadp
<integer>
N/A
7/6
Restore the system parameters to
default values except the vadp
parameters and VADP modules that
stored in the system.
This command can cooperate with
other “restoreexceptXYZ” commands.
When cooperating with others, the
system parameters will be restored to
the default value except for a union of
the combined results.
7.1.1system.info
Subgroup of system: info (The fields in this group are unchangeable.)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
modelname
string[40]
IP816A-HP
0/7
Internal model name of the server
extendedmodelname
string[40]
IP816A-HP
0/7
ODM specific model name of server
(eg. DCS-5610). If it is not an ODM
model, this field will be equal to
“modelname”
serialnumber
<mac
<product
address>
mac
0/7
12 characters MAC address (without
hyphens).
address>
firmwareversion
string[40]
<product
0/7
dependent>
Firmware version, including model,
company, and version number in the
format:<MODEL-BRAND-VERSION>
language_count
<integer>
9
0/7
Number of webpage languages
available on the server.
language_i<0~(count-1)>
string[16]
language_i0
0/7
Available language lists.
: English
language_i1
: Deutsch
language_i2
: Español
language_i3
: Français
language_i4
User's Manual - 149
VIVOTEK
: Italiano
language_i5
: 日本語
language_i6
: Português
language_i7
: 简体中文
language_i8
: 繁體中文
customlanguage_maxcoun
<integer>
1
0/6
Maximum number of custom
t
languages supported on the server.
customlanguage_count
<integer>
0
0/6
Number of custom languageswhich
have been uploaded to the server.
customlanguage_i<0~(ma
string
<blank>
0/6
Custom language name.
xcount-1)>
7.2 status
Group: status
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
di_i<0~(ndi-1)>
<boolean>
0
1/7
<product dependent>
0 => Inactive, normal
1 => Active, triggered
(capability.ndi > 0)
do_i<0~(ndo-1)>
<boolean>
0
1/7
<product dependent>
0 => Inactive, normal
1 => Active, triggered
(capability.ndo > 0)
onlinenum_rtsp
integer
0
6/7
Current number of RTSP
connections.
onlinenum_httppush
integer
0
6/7
Current number of HTTP push
server connections.
eth_i0
<string>
<product
1/7
dependent>
vi_i<0~(nvi-1)>
<product dependent>
<boolean>
0
Get network information from
mii-tool.
1/7
Virtual input
0 => Inactive
1 => Active
(capability.nvi > 0)
150 - User's Manual
VIVOTEK
7.3 digital input behavior define
Group: di_i<0~(ndi-1)>(capability.ndi > 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
normalstate
high,
high
1/1
low
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
SECURITY
DESCRIPTION
(get/set)
normalstate
open,
open
1/1
grounded
Indicate open circuit or closed
circuit (inactive status)
7.5 security
Group: security
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
privilege_do
view, operator,
operator
1/6
admin
Indicate which privileges and
above can control digital output
(capability.ndo > 0)
privilege_camctrl
view, operator,
view
1/6
admin
Indicate which privileges and
above can control PTZ
(capability.ptzenabled > 0 or
capability.eptz > 0)
user_i0_name
string[64]
root
6/7
User name of root
user_i<1~20>_name
string[64]
<blank>
6/7
User name
user_i0_pass
password[64]
<blank>
6/6
Root password
user_i<1~20>_pass
password[64]
<blank>
7/6
User password
user_i0_privilege
view,
admin
6/7
Root privilege
<blank>
6/6
User privilege
operator,
admin
user_i<1~20>_ privilege
view,
operator,
admin
User's Manual - 151
VIVOTEK
7.6 network
Group: network
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
preproces
<positive
s
integer>
<blank>
6/6
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;
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”
type
lan,
lan
6/6
Network connection type.
1
6/6
1 => Get ipaddress, subnet, router, dns1, dns2 from
pppoe
resetip
<boolean>
DHCP server at next reboot.
0 => Use preset ipaddress, subnet, rounter, dns1,
and dns2.
ipaddress
subnet
<ip
<product
6/6
IP address of server.
address>
dependent>
<ip
<blank>
6/6
Subnet mask.
<blank>
6/6
Default gateway.
<blank>
6/6
Primary DNS server.
address>
router
<ip
address>
dns1
<ip
address>
152 - User's Manual
VIVOTEK
dns2
<ip
<blank>
6/6
Secondary DNS server.
<blank>
6/6
Primary WINS server.
<blank>
6/6
Secondary WINS server.
address>
wins1
<ip
address>
wins2
<ip
address>
7.6.1 802.1x
Subgroup of network: ieee8021x(capability.protocol.ieee8021x > 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
enable
<boolean>
0
6/6
Enable/disable IEEE 802.1x
eapmethod
eap-peap,
eap-peap
6/6
Selected EAP method
eap-tls
identity_peap
String[64]
<blank>
6/6
PEAP identity
identity_tls
String[64]
<blank>
6/6
TLS identity
password
String[253]
<blank>
6/6
Password for TLS
privatekeypassword
String[253]
<blank>
6/6
Password for PEAP
ca_exist
<boolean>
0
6/6
CA installed flag
ca_time
0~20
0
6/7
CA installed time. Represented in
EPOCH
ca_size
0~20
0
6/7
CA file size (in bytes)
certificate_exist
<boolean>
0
6/6
Certificate installed flag (for TLS)
certificate_time
0~20
0
6/7
Certificate installed time.
Represented in EPOCH
certificate_size
0~20
0
6/7
Certificate file size (in bytes)
privatekey_exist
<boolean>
0
6/6
Private key installed flag (for
TLS)
privatekey_time
0~20
0
6/7
Private key installed time.
Represented in EPOCH
privatekey_size
0~20
0
6/7
Private key file size (in bytes)
User's Manual - 153
VIVOTEK
7.6.2 QOS
Subgroup of network: qos_cos (capability.protocol.qos.cos > 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
enable
<boolean>
0
6/6
Enable/disable CoS (IEEE 802.1p)
vlanid
1~4095
1
6/6
VLAN ID
video
0~7
0
6/6
Video channel for CoS
audio
0~7
0
6/6
Audio channel for CoS
(capability.naudio > 0)
eventalarm
0~7
0
6/6
Event/alarm channel for CoS
management
0~7
0
6/6
Management channel for CoS
eventtunnel
0~7
0
6/6
Event/Control channel for CoS
Subgroup of network: qos_dscp (capability.protocol.qos.dscp > 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
enable
<boolean>
0
6/6
Enable/disable DSCP
video
0~63
0
6/6
Video channel for DSCP
audio
0~63
0
6/6
Audio channel for DSCP
(capability.naudio > 0)
eventalarm
0~63
0
6/6
Event/alarm channel for DSCP
management
0~63
0
6/6
Management channel for DSCP
eventtunnel
0~63
0
6/6
Event/Control channel for DSCP
7.6.3 IPV6
Subgroup of network: ipv6 (capability.protocol.ipv6 > 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
enable
<boolean>
0
6/6
Enable IPv6.
addonipaddress
<ip address>
<blank>
6/6
IPv6 IP address.
addonprefixlen
0~128
64
6/6
IPv6 prefix length.
addonrouter
<ip address>
<blank>
6/6
IPv6 router address.
addondns
<ip address>
<blank>
6/6
IPv6 DNS address.
allowoptional
<boolean>
0
6/6
Allow manually setup of IP address
setting.
154 - User's Manual
VIVOTEK
7.6.4 FTP
Subgroup of network: ftp
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
port
21, 1025~65535
21
6/6
Local ftp server port.
7.6.5 HTTP
Subgroup of network: http
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
port
80, 1025 ~
80
1/6
HTTP port.
65535
alternateport
1025~65535
8080
6/6
Alternate HTTP port.
authmode
basic,
basic
1/6
HTTP authentication mode.
video.mjpg
1/6
HTTP server push access name for
digest
s0_accessname
string[32]
stream 1.
(capability.protocol.spush_mjpeg =1
and capability.nmediastream > 0)
s1_accessname
string[32]
video2.mjpg
1/6
HTTP server push access name for
stream 2.
(capability.protocol.spush_mjpeg =1
and capability.nmediastream > 1)
s2_accessname
string[32]
video3.mjpg
1/6
Http server push access name for
stream 3
(capability.protocol.spush_mjpeg =1
and capability.nmediastream > 2)
anonymousviewing
<boolean>
0
1/6
Enable anonymous streaming
viewing.
User's Manual - 155
VIVOTEK
7.6.6 HTTPS port
Subgroup of network: https_port (capability.protocol.https > 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
port
443, 1025 ~
443
1/6
HTTPS port.
65535
7.6.7 RTSP
Subgroup of network: rtsp (capability.protocol.rtsp > 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
port
554, 1025 ~
554
1/6
65535
anonymousviewing
<boolean>
RTSP port.
(capability.protocol.rtsp=1)
0
1/6
Enable anoymous streaming
viewing.
authmode
disable,
basic
1/6
basic,
RTSP authentication mode.
(capability.protocol.rtsp=1)
digest
s0_accessname
string[32]
live.sdp
1/6
RTSP access name for stream1.
(capability.protocol.rtsp=1 and
capability.nmediastream > 0)
s1_accessname
string[32]
live2.sdp
1/6
RTSP access name for stream2.
(capability.protocol.rtsp=1 and
capability.nmediastream > 1)
s2_accessname
string[32]
live3.sdp
1/6
RTSP access name for stream3
(capability.protocol.rtsp=1 and
capability.nmediastream > 2)
s0_audiotrack
<boolean>
-1
6/6
Enable audio for stream1.
s1_audiotrack
<boolean>
-1
6/6
Enable audio for stream2.
s2_audiotrack
<boolean>
-1
6/6
Enable audio for stream3.
156 - User's Manual
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>
For n=0,
4/4
Multicast IP address.
239.128.1.99
For n=1,
239.128.1.100,
and so on.
videoport
1025 ~ 65535
5560+n*2
4/4
Multicast video port.
audioport
1025 ~ 65535
5562+n*2
4/4
Multicast audio port.
(capability.naudio > 0)
ttl
1 ~ 255
15
4/4
Mutlicast time to live value.
7.6.8 SIP port
Subgroup of network: sip (capability.protocol.sip> 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
port
1025 ~ 65535
5060
1/6
SIP port.
7.6.9 RTP port
Subgroup of network: rtp
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
videoport
1025 ~ 65535
5556
6/6
Video channel port for RTP.
(capability.protocol.rtp_unicast=1)
audioport
1025 ~ 65535
5558
6/6
Audio channel port for RTP.
(capability.protocol.rtp_unicast=1)
User's Manual - 157
VIVOTEK
7.6.10 PPPoE
Subgroup of network: pppoe (capability.protocol.pppoe > 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
user
string[128]
<blank>
6/6
PPPoE account user name.
pass
password[64]
<blank>
6/6
PPPoE account password.
7.7 IP Filter
Group: ipfilter
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
enable
<boolean>
0
6/6
Enable access list filtering.
admin_enable
<boolean>
0
6/6
Enable administrator IP
address.
admin_ip
String[43]
<blank>
6/6
Administrator IP address.
maxconnection
1~10
10
6/6
Maximum number of
concurrent streaming
connection(s).
type
0, 1
1
6/6
Ipfilter policy :
0 => allow
1 => deny
ipv4list_i<0~9>
Single address:
<blank>
6/6
IPv4 address list.
<blank>
6/6
IPv6 address list.
<ip address>
Network address:
<ip address /
network mask>
Range
address:<start ip
address - end ip
address>
ipv6list_i<0~9>
158 - User's Manual
String[43]
VIVOTEK
7.8Video input
Group: videoin
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
cmosfreq
50, 60
60
4/4
CMOS frequency.
(capability.videoin.type=2)
whitebalance
auto, auto2,
auto
4/4
“auto& auto2” indicate auto white
manual,manual2
balance.“manual& manual2”
,rbgain
indicate keep current value.
2 which is designed for non-bundle
lens models
“rbgain” indicates using rgain
and gbain.
exposurelevel
0~12
6
4/4
Exposure level
autoiris
<boolean>
0
4/4
Enable auto Iris.
irismode
fixed, indoor,
outdoor
4/4
Video Iris mode.
outdoor
enableblc
<boolean>
0
4/4
Enable backlight compensation.
color
0, 1
1
4/4
0 =>monochrome
1 => color
flip
<boolean>
0
4/4
Flip the image.
mirror
<boolean>
0
4/4
Mirror the image.
rotate
0,90,180,270
0
1/4
The rotation angle of image.
(rotation
Support only in Rotation mode
mode)
(capability.videoin.c0.mode==1)
1/7 (others)
ptzstatus
<integer>
2
1/7
A 32-bit integer, each bit can be set
separately as follows:
Bit 0 => Support camera control
function; 0(not support), 1(support)
Bit 1 =>Built-in or external
camera; 0 (external), 1(built-in)
Bit 2 => Support pan operation;
0(not support), 1(support)
Bit 3 => Support tilt operation;
0(not support), 1(support)
User's Manual - 159
VIVOTEK
Bit 4 => Support zoom operation;
0(not support), 1(support)
Bit 5 => Support focus operation;
0(not support), 1(support)
text
string[64]
<blank>
1/4
Enclose caption.
imprinttimestamp
<boolean>
0
4/4
Overlay time stamp on video.
maxexposure
1~10000
30
4/4
Maximum exposure time.
0
4/4
Usage for UI of exposure settings.
<product
dependent>
enablepreview
<boolean>
Preview settings of video profile.
7.8.1Video input setting per channel
Group:videoin_c<0~(n-1)> for n channel products, and m is stream number
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
cmosfreq
50, 60
60
4/4
CMOS frequency.
(capability.videoin.type=2)
mode
0,1,2
0
4/4
Set video mode
0: Dual stream mode (Max.
30fps)
1: Dual stream mode with
video rotation (Max. 30fps)
2: Single stream mode with
high framerate (Max. 60fps)
whitebalance
auto, auto2,
auto
4/4
“auto& auto2” indicate auto
manual,
white balance.
manual2,
“auto2” indicates auto white
rbgain
balance“manual& manual2”
<product
indicate keep current value.
dependent>
2 which is designed for
non-bundle
lens models
“rbgain” indicates using rgain
and gbain.
rgain
0~100
30
4/4
Manual set rgain value of
gain control setting.
bgain
160 - User's Manual
0~100
30
4/4
Manual set bgain value of
VIVOTEK
gain control setting.
exposurelevel
0~12
6
4/4
Exposure level
autoiris
0~1
0
4/4
set 1 to enable auto iris, set 0
to disable auto iris.
irismode
fixed, indoor,
outdoor
4/4
Video Iris mode.
outdoor
1/4
PIris mode
outdoor
piris_mode
manual, indoor,
outdoor
manual = 0
indoor=1
outdoor=2
piris_position
1~100
1
1/4
Position of piris
enableblc
0~1
0
4/4
Enable backlight
compensation
maxgain
0~100
100
4/4
Manual set maximum gain
value.
mingain
0~100
0
4/4
Manual set minimum gain
value.
color
0, 1
1
4/4
0 =>monochrome
1 => color
flip
<boolean>
0
4/4
Flip the image.
mirror
<boolean>
0
4/4
Mirror the image.
rotate
0,90,180,270
0
4/4
The rotation angle of image.
Support only in Rotation
mode
(capability.videoin.c0.mode
=1)
text
string[64]
<blank>
1/4
Enclose caption.
imprinttimestamp
<boolean>
0
4/4
Overlay time stamp on video.
textonvideo_position
top, bottom
Top
4/4
Text on video string position
textonvideo_size
15, 25, 30
15
4/4
Text on video font size
exposuremode
auto,fixed
auto
4/4
Exposure mode
flickerless
<boolean>
0
4/4
Avoid flickering on images.
maxexposure
1~ 10000
30
4/4
Maximum exposure time.
minexposure
480~ 10000
10000
4/4
Minimum exposure time.
enablepreview
<boolean>
0
1/4
Usage for UI of exposure
settings. Preview settings of
video profile.
s<0~(m-1)>_codectype
mjpeg, h264
H264
1/4
Video codec type.
User's Manual - 161
VIVOTEK
s<0~(m-1)>_resolution
Reference
s0:1920x1080
capability_vide
s1:640x360
1/4
Video resolution in pixels.
4/4
Intra frame period in
oin_resolution
s<0~(m-1)>_h264_intraperi
250, 500,
od
1000, 2000,
1000
milliseconds.
3000, 4000
s<0~(m-1)>_h264_ratecont
cbr, vbr
rolmode
s<0~(m-1)>_h264_quant
s0:cbr
4/4
s1:cbr
1~5,
3
cbr, constant bitrate
vbr, fix quality
4/4
99, 100
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.
s<0~(m-1)>_h264_qvalue
10~51
31
4/4
Manual video quality level
input.
(s<0~(m-1)>_h264_quant
= 99)
s<0~(m-1)>_h264_qpercen
1~100
50
4/4
t
Manual video quality level
input.
(s<0~(m-1)>_h264_quant
= 100)
s<0~(m-1)>_h264_bitrate
4000~400000
s0:6000000
00
s1:512000
4/4
Set bit rate in bps when
choosing cbr in
“ratecontrolmode”.
s<0~(m-1)>_h264_maxvbr
1000~400000
bitrate
00
40000000
4/4
Set bit rate in bps when
choosing vbr in
“ratecontrolmode”.
s<0~(m-1)>_h264_maxfra
1,2,3,5,8,10,1
s0:30
me
2,15,20,25,30
s1:15
1/4
Set maximum frame rate in
fps (for h264).
3M : 1~30fps
2M : 1~60fps
(for NTSC or 60Hz CMOS)
s<0~(m-1)>_h264_profile
0~2
1
1/4
Indicate H264 profiles
0: baseline
1: main profile
2: high profile
s<0~(m-1)>_h264_priorityp
162 - User's Manual
framerate,imag
s0:framerate
4/4
Set prioritypolicy
VIVOTEK
olicy
equality
s1:imagequality
s<0~(m-1)>_mjpeg_ratecon
cbr, vbr
s0: vbr
trolmode
s<0~(m-1)>_mjpeg_quant
4/4
s1: vbr
1~5,
3
cbr, constant bitrate
vbr, fix quality
4/4
99, 100
Quality of JPEG video.
99 is the customized manual
input setting.
1 = worst quality, 5 = best
quality.
100 is percentage mode.
s<0~(m-1)>_mjpeg_qvalue
2~97
49
4/4
Manual video quality level
input.
(s<0~(m-1)>_mjpeg_quant
= 99)
s<0~(m-1)>_mjpeg_qperce
1~100
50
4/4
nt
Manual video quality level
input.
(s<0~(m-1)>_mjpeg_quant
= 100)
s<0~(m-1)>_mjpeg_bitrate
4000~400000
s0:14000000
00
s1:512000
4/4
Set bit rate in bps when
choosing cbr in
“ratecontrolmode”.
s<0~(m-1)>_mjpeg_maxvb
1000~400000
rbitrate
00
40000000
4/4
Set bit rate in bps when
choosing vbr in
“ratecontrolmode”.
s<0~(m-1)>_mjpeg_maxfra
1,2,3,5,8,10,1
s0:10
me
2,15,20,25,30
s1:15
1/4
Set maximum frame rate in
fps (for JPEG).
3M : 1~30fps
2M : 1~60fps
(for NTSC or 60Hz CMOS)
s<0~(m-1)>_mjpeg_priority
framerate,imag
s0:framerate
4/4
Set prioritypolicy
policy
equality
s1:imagequality
wdr_mode
0~1
1
4/4
30fps:WDRPro
wdr_strength
0~2
1
4/4
60fps:no WDR
WDRPro:3 level (from low to
high)
level1: wdr_mode=1,
wdr_strength=0
level2: wdr_mode=1,
wdr_strength=1
User's Manual - 163
VIVOTEK
level3: wdr_mode=1,
wdr_strength=2
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
SECURITY
DESCRIPTION
(get/set)
enable
<boolean>
0
4/4
Enable/disable this profile setting
policy
day,
night
4/4
The mode which the profile is applied
night,
to.
schedule
begintime
hh:mm
18:00
4/4
Begin time of schedule mode.
endtime
hh:mm
06:00
4/4
End time of schedule mode.
exposuremode
auto,fixed
auto
4/4
Exposure Mode
flickerless
<boolean>
0
4/4
Avoid flickering on images.
maxexposure
1~10000
30
4/4
Maximum exposure time.
minexposure
480~10000
10000
4/4
Minimum exposure time.
enableblc
<boolean>
0
4/4
Enable backlight compensation.
exposurelevel
0~12
6
4/4
Exposure level
maxgain
0~100
100
4/4
Manual set maximum gain value.
mingain
0~100
0
4/4
Manual set minimum gain value.
autoiris
<boolean>
0
4/4
Enable auto Iris.
piris_mode
manual, indoor,
outdoor
1/4
PIris mode
outdoor
manual = 0
indoor=1
outdoor=2
piris_position
1~100
1
1/4
Position of piris
irismode
fixed, indoor,
outdoor
4/4
Video Iris mode.
outdoor
wdr_mode
0~1
1
4/4
30fps:WDRPro
wdr_strength
0~2
1
4/4
60fps:no WDR
WDRPro:3 level (from low to high)
level1: wdr_mode=1,
wdr_strength=0
164 - User's Manual
VIVOTEK
level2: wdr_mode=1,
wdr_strength=1
level3: wdr_mode=1,
wdr_strength=2
whitebalance
auto, auto2,
auto
4/4
“auto& auto2” indicate auto white
manual,
balance.
manual2,
“auto2” indicates auto white
rbgain <product
balance“manual& manual2” indicate
dependent>
keep current value.
2 which is designed for non-bundle
lens models
“rbgain” indicates using rgain and
gbain.
rgain
0~100
30
4/4
Manual set rgain value of gain
control setting.
bgain
0~100
30
4/4
Manual set bgain value of gain
control setting.
7.9Video input preview
The temporary settings for video preview
Group: videoinpreview
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
exposuremode
auto,fixed
auto
4/4
Exposure Mode
maxexposure
1~10000
30
4/4
Maximum exposure time.
minexposure
480~10000
10000
4/4
Minimum exposure time.
exposurelevel
0~12
6
4/4
Exposure level
enableblc
<boolean>
0
4/4
Enable backlight compensation.
irismode
fixed, indoor,
outdoor
4/4
Video Iris mode.
outdoor
1/4
PIris mode
outdoor
piris_mode
manual, indoor,
outdoor
manual = 0
indoor=1
outdoor=2
piris_position
1~100
1
1/4
Position of piris
wdr_mode
0~1
1
4/4
30fps:WDRPro
wdr_strength
0~2
1
4/4
60fps:no WDR
WDRPro:3 level (from low to high)
User's Manual - 165
VIVOTEK
level1: wdr_mode=1,
wdr_strength=0
level2: wdr_mode=1,
wdr_strength=1
level3: wdr_mode=1,
wdr_strength=2
maxgain
0~100
100
4/4
Manual set maximum gain value.
mingain
0~100
0
4/4
Manual set minimum gain value.
autoiris
<boolean>
0
4/4
Enable auto Iris.
7.10 IR cut control
Group: ircutcontrol(capability.nvideoinprofile> 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
mode
auto,
auto
6/6
Set IR cut control mode
day,
night,
di0,
di1,
di2,
schedule
daymodebegintime
00:00~23:59
07:00
6/6
Day mode begin time
daymodeendtime
00:00~23:59
18:00
6/6
Day mod end time
disableirled
<boolean>
0
6/6
Enable/disable built-in IR led
(capability.ir > 0)
enableextled
<boolean>
0
1/6
Enable/disable external IR led
(capability.extir > 0)
bwmode
<boolean>
1
6/6
Switch to B/W in night mode if
enabled
sensitivity
low,
normal,
high
166 - User's Manual
normal
6/6
Sensitivity of light sensor
VIVOTEK
7.11Image setting per channel
Group: image_c<0~(n-1)> for n channel products
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
brightness
-5~5,100
100
4/4
Adjust brightness of image
according to mode settings.
saturation
-5~5,100
100
4/4
Adjust saturation of image
according to mode settings.
contrast
-5~5,100
100
4/4
Adjust contrast of image
according to mode settings.
sharpness
-3~3,100
100
4/4
Adjust sharpness of image
according to mode settings.
brightnesspercent
0~100
0
4/4
Adjust brightnesspercent of
image
saturationpercent
0~100
50
4/4
Adjust saturation value of
percentage when
saturation=100
contrastpercent
0~100
50
4/4
Adjust contrastpercent of image
sharpnesspercent
0~100
50
4/4
Adjust sharpnessvalue of
percentage when
sharpness=100
gammacurve
0~100
0
4/4
Gamma curve.
lowlightmode
<boolean>
1
4/4
Enable/disable low light mode.
dnr_mode
0~1
1
4/4
0:disable
1:enable
dnr_strength
1~100
50
4/4
Strength of DNR
eis
0~1
0
4/4
Electronic image stabilizer
0:disable
1:enable
profile_i0_enable
<boolean>
0
4/4
Enable/disable this profile
setting
profile_i0_policy
day,
night
4/4
night,
The mode which the profile is
applied to.
schedule
profile_i0_begintime
hh:mm
18:00
4/4
Begin time of schedule mode.
profile_i0_endtime
hh:mm
06:00
4/4
End time of schedule mode.
profile_i0_brightness
-5~5,100
100
4/4
Adjust brightness of image
User's Manual - 167
VIVOTEK
according to mode settings.
profile_i0_saturation
-5~5,100
100
4/4
Adjust saturation of image
according to mode settings.
profile_i0_contrast
-5~5,100
100
4/4
Adjust contrast of image
according to mode settings.
profile_i0_sharpness
-3~3,100
100
4/4
Adjust sharpness of image
according to mode settings.
profile_i0_brightnesspercent
0~100
0
4/4
Adjust brightnesspercent of
image
profile_i0_contrastpercent
0~100
50
4/4
Adjust contrastpercent of image
profile_i0_saturationpercent
0~100
50
4/4
Adjust saturationpercent of
image
profile_i0_sharpnesspercent
0~100
50
4/4
Adjust sharpnesspercentvalue
of image
profile_i0_gammacurve
0~100
0
4/4
Gamma curve.
profile_i0_lowlightmode
<boolean>
1
4/4
Enable/disable low light mode.
profile_i0_dnr_mode
0~1
1
4/4
0:disable
1:enable
profile_i0_dnr_strength
1~100
50
4/4
Strength of DNR
profile_i0_eis
0~1
0
4/4
Electronic image stabilizer
0:disable
1:enable
168 - User's Manual
VIVOTEK
7.12 Image setting for preview
Group: imagepreview_c<0~(n-1)> for n channel products
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
brightness
-5~5,100
100
4/4
Adjust brightness of image
according to mode settings.
saturation
-5~5,100
100
4/4
Adjust saturation of image
according to mode settings.
100 for saturation percentage
mode.
contrast
-5~5,100
100
4/4
Adjust contrast of image
according to mode settings.
sharpness
-3~3,100
100
4/4
Adjust sharpness of image
according to mode settings.
brightnesspercent
0~100
0
4/4
Adjust brightnesspercent of
image
saturationpercent
0~100
50
4/4
Adjust saturation value of
percentage when
saturation=100
contrastpercent
0~100
50
4/4
Adjust contrastpercent of image
sharpnesspercent
0~100
50
4/4
Adjust sharpnessvalue of
percentage when
sharpness=100
gammacurve
0~100
0
4/4
Gamma curve.
lowlightmode
<boolean>
1
4/4
Enable/disable low light mode.
dnr_mode
0~1
1
4/4
0:disable
1:enable
dnr_strength
1~100
50
4/4
Strength of DNR
eis
0~1
0
4/4
Electronic image stabilizer
0:disable
1:enable
Group: imagepreview
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
videoin_whitebalance
auto,
auto2,
auto
4/4
Preview of adjusting white balance of image
according to mode settings
manual,
User's Manual - 169
VIVOTEK
manual2,
rbgain
videoin_restoreatwb
1~
1
4/4
Restore of adjusting white balance of image
according to mode settings
videoin_rgain
0~100
30
4/4
Manual set rgain value of gain control
setting.
videoin_bgain
0~100
30
4/4
Manual set bgain value of gain control
setting.
170 - User's Manual
VIVOTEK
7.13 Exposure window setting per channel
Group: exposurewin_c<0~(n-1)> for n channel products
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
mode
auto, custom,blc
auto
4/4
The mode indicates how to
decide the exposure.
auto: Use full view as the only
one exposure window.
custom: Use inclusive window.
blc: Use BLC.
win_i<0~9>_enable
<boolean>
0
4/4
Enable or disable the window.
win_i<0~9>_policy
0~1
0
4/4
1: Indicate inclusive.
win_i<0~9>_home
<coordinate>
(110,80)
4/4
Left-top corner coordinate of the
window.
win_i<0~9>_size
<window size>
(100x75)
4/4
Width and height of the window.
Group: exposurewin_c<0~(n-1)>_profile for m profile and n channel product
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
i<0~(m-1)>_mode
auto,
auto
4/4
custom,blc
The mode indicates how to
decide the exposure.
auto: Use full view as the
only one exposure window.
custom: Use inclusive
window.
blc: Use BLC.
i<0~(m-1)>_win_i<0~9>_enable
<boolean>
0
4/4
Enable or disable the
window.
i<0~(m-1)>_win_i<0~9>_policy
0~1
0
4/4
1: Indicate inclusive.
i<0~(m-1)>_win_i<0~9>_home
<coordinate>
(110,80)
4/4
Left-top corner coordinate
of the window.
i<0~(m-1)>_win_i<0~9>_size
<window size>
(100x75)
4/4
Width and height of the
window.
User's Manual - 171
VIVOTEK
7.14 Audio input per channel
Group: audioin_c<0~(n-1)> for n channel products (capability.audioin>0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
source
linein
linein
4/4
micin => use built-in microphone
input.
linein => use external microphone
input.
mute
0, 1
1
1/4
Disable audio mute.
gain
0~100
65
4/4
Gain of input.
(audioin_c<0~(n-1)>_source =
linein)
boostmic
0~100
65
4/4
Enable microphone boost.
Gain of input.
(audioin_c<0~(n-1)>_source =
micin)
s<0~(m-1)>_codectype
aac4, g711,
g711
4/4
Set audio codec type for input.
16000
4/4
Set AAC4 bitrate in bps.
pcmu
4/4
Set G.711 mode.
32000
4/4
Set G.726 bitrate in bps.
little
4/4
Set G.726 bit streaming packing
g726
s<0~(m-1)>_aac4_bitrate
16000,
32000,
48000,
64000,
96000,
128000
s<0~(m-1)>_g711_mode
pcmu,
pcma
s<0~(m-1)>_g726_bitrate
16000,
24000,
32000,
40000
s<0~(m-1)>_g726
little, big
_bitstreampackingmode
s<0~(m-1)>_g726
mode
0, 1
0
4/4
Enable vlcmode for G.726
alarm_enable
0, 1
0
4/4
Enable audio detection
alarm_level
1~100
50
4/4
Audio detection alarm level
profile_i0_enable
<boolean>
0
4/4
Enable/disable this profile setting
profile_i0_policy
day,
night
4/4
The mode which the profile is
_vlcmode
night,
172 - User's Manual
applied to.
VIVOTEK
schedule
profile_i0_begintime
hh:mm
18:00
4/4
Begin time of schedule mode.
profile_i0_endtime
hh:mm
06:00
4/4
End time of schedule mode.
profile_i0_alarm_level
1~100
50
4/4
Audio detection alarm level
7.15 Time Shift settings
Group: timeshift, c for n channel products, m is stream number(capability.timeshift > 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
enable
<boolean>
0
4/4
Enable time shift streaming.
c<0~(n-1)>_s<0~
<boolean>
0
4/4
Enable time shift streaming for specific
(m-1)>_allow
stream.
7.16 Motion detection settings
Group: motion_c<0~(n-1)>for n channel product
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
enable
<boolean>
0
4/4
Enable motion detection.
win_i<0~2>_enable
<boolean>
0
4/4
Enable motion window 1~3.
win_i<0~2>_name
string[14]
<blank>
4/4
Name of motion window 1~3.
win_i<0~2>_left
0 ~ 320
0
4/4
Left coordinate of window position.
win_i<0~2>_top
0 ~ 240
0
4/4
Top coordinate of window position.
win_i<0~2>_width
0 ~ 320
0
4/4
Width of motion detection window.
win_i<0~2>_height
0 ~ 240
0
4/4
Height of motion detection window.
win_i<0~2>_objsize
0 ~ 100
0
4/4
Percent of motion detection window.
win_i<0~2>_sensitivity
0 ~ 100
0
4/4
Sensitivity of motion detection
window.
Group: motion_c<0~(n-1)> profilefor m profile and n channel product (capability.nmotionprofile > 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
i<0~(m-1)>_enable
<boolean>
0
4/4
Enable profile 1 ~
(m-1).
i<0~(m-1)>_policy
day,
night
4/4
night,
The mode which the
profile is applied to.
schedule
i<0~(m-1)>_begintime
hh:mm
18:00
4/4
Begin time of
User's Manual - 173
VIVOTEK
schedule mode.
i<0~(m-1)>_endtime
hh:mm
06:00
4/4
End time of
schedule mode.
i<0~(m-1)>_win_i<0~2>_enable
<boolean>
0
4/4
Enable motion
window.
i<0~(m-1)>_win_i<0~2>_name
string[14]
<blank>
4/4
Name of motion
window.
i<0~(m-1)>_win_i<0~2>_left
0 ~ 320
0
4/4
Left coordinate of
window position.
i<0~(m-1)>_win_i<0~2>_top
0 ~ 240
0
4/4
Top coordinate of
window position.
i<0~(m-1)>_win_i<0~2>_width
0 ~ 320
0
4/4
Width of motion
detection window.
i<0~(m-1)>_win_i<0~2>_height
0 ~ 240
0
4/4
Height of motion
detection window.
i<0~(m-1)>_win_i<0~2>_objsize
0 ~ 100
0
4/4
Percent of motion
detection window.
i<0~(m-1)>_win_i<0~2>_sensitivity
0 ~ 100
0
4/4
Sensitivity of
motion detection
window.
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
4/4
Enable or disable tamper detection.
threshold
0 ~ 255
120
1/7
Threshold of tamper detection.
duration
10 ~ 20
2
1/7
If tampering value exceeds the ‘threshold’ for
more than ‘duration’ second(s), then tamper
detection is triggered.
174 - User's Manual
VIVOTEK
7.18 DDNS
Group: ddns (capability.ddns > 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
enable
<boolean>
0
6/6
Enable or disable the dynamic DNS.
provider
CustomSafe100,
DyndnsDyn
6/6
Safe100 => safe100.net
DyndnsDynamic,
amic
DyndnsDynamic => dyndns.org
DyndnsCustom,
(dynamic)
Safe100
DyndnsCustom => dyndns.org
CustomSafe100 =>
Custom server using safe100 method
<provider>_ho
string[128]
<blank>
6/6
Your DDNS hostname.
string[64]
<blank>
6/6
Your user name or email to login to the
stname
<provider>_us
ernameemail
DDNS service provider
<provider>_pa
string[64]
<blank>
6/6
sswordkey
Your password or key to login to the
DDNS service provider.
<provider>_se
string[128]
<blank>
6/6
rvername
The server name for safe100.
(This field only exists if the provider is
customsafe100)
7.19 Express link
Group:expresslink
PARAMETER
VALUE
Default
SECURITY
DESCRIPTION
(get/set)
enable
<boolean>
0
6/6
Enable or disable express link.
state
onlycheck,
badnetwork
6/6
Camera will check the status of network
onlyoffline,
environment and express link URL
checkonline,
badnetwork
url
string[64]
NULL
6/6
The url user define to link to camera
User's Manual - 175
VIVOTEK
7.20 UPnP presentation
Group: upnppresentation
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
enable
<boolean>
1
6/6
Enable or disable the UPnP
presentation service.
7.21 UPnP port forwarding
Group: upnpportforwarding
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
enable
<boolean>
0
6/6
Enable or disable the UPnP port
forwarding service.
upnpnatstatus
0~3
0
6/7
The status of UPnP port forwarding,
used internally.
0 = OK, 1 = FAIL, 2 = no IGD router, 3 =
no need for port forwarding
7.22 System log
Group: syslog
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
enableremotelog
<boolean>
0
6/6
Enable remote log.
serverip
<IP address>
<blank>
6/6
Log server IP address.
serverport
514,
514
6/6
Server port used for log.
6
6/6
Levels used to distinguish the
1025~65535
level
0~7
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
176 - User's Manual
VIVOTEK
setparamlevel
0~2
0
6/6
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 camera PTZ control
Group: camctrl(capability.camctrl.httptunnel> 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
enablehttptunnel
<boolean>
0
1/4
Enable HTTP tunnel for camera
control.
Group: camctrl_c<0~(n-1)>for n channel product (capability.ptzenabled)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
panspeed
-5 ~ 5
0
1/4
Pan speed
tiltspeed
-5 ~ 5
0
1/4
Tilt speed
zoomspeed
-5 ~ 5
0
1/4
Zoom speed
focusspeed
-5 ~ 5
0
1/4
Auto focus speed
patrolseq
string[120]
<blank>
1/4
(For external device)
The indexes of patrol points,
separated by “,”
patroldwelling
string[160]
<blank>
1/4
(For external device)
The dwelling time of each patrol
point, separated by “,”
preset_i<0~(npreset-1
string[40]
<blank>
1/4
Name of the preset location.
0 ~ 999
0
1/4
The dwelling time of each preset
)>_name
preset_i<0~(npreset-1
)>_ dwelling
uart
location
0 ~ (m-1), m
0
1/4
is UART count
cameraid
0~255
Select corresponding uart
(capability.nuart>0).
1
1/4
Camera ID controlling external PTZ
camera.
isptz
0~2
0
1/4
0: disable PTZ commands.
1: enable PTZ commands with PTZ
User's Manual - 177
VIVOTEK
driver.
2: enable PTZ commands with UART
tunnel.
disablemdonptz
<boolean>
0
1/4
Disable motion detection on PTZ
operation.
7.24 UART control (Not used in FE8174/FE8173/FE8181)
Group: uart (capability.nuart > 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
ptzdrivers_i<0~19,
string[40]
127>_name
ptzdrivers_i<0~19,
1/4
Name of the PTZ driver.
1/4
Full path of the PTZ driver.
4/4
Enable HTTP tunnel channel to
dependent>
string[128]
127>_location
enablehttptunnel
<product
< product
dependent>
<boolean>
0
control UART.
Group: uart_i<0~(n-1)>n is uart port count (capability.nuart > 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
baudrate
110,300,600,120
9600
4/4
Set baud rate of COM port.
8
4/4
Data bits in a character frame.
none
4/4
For error checking.
1
4/4
1
0,2400,3600,480
0,7200,9600,192
00,38400,57600,
115200
databit
5,6,7,8
6,7,8
<product
dependent>
paritybit
none,
odd,
even
stopbit
1,2
2-1.5 , data bit is 5
2-2
uartmode
178 - User's Manual
rs485,
rs485
4/4
RS485 or RS232.
VIVOTEK
rs232
customdrvcmd_i<0~
string[128]
<blank>
1/4
PTZ command for custom camera.
string[40]
<blank>
1/4
Additional PTZ command name.
string[128]
<blank>
1/4
Additional PTZ command list.
0~19,
128
4/4
The PTZ driver is used by this COM
127 (custom),
(no driver)
9>
speedlink_i<0~4>_n
ame
speedlink_i<0~4>_c
md
ptzdriver
port.
128 (no driver)
7.25 SNMP
Group: snmp (capability.snmp > 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
v2
0~1
0
6/6
SNMP v2 enabled. 0 for disable, 1 for
enable
v3
0~1
0
6/6
SNMP v3 enabled. 0 for disable, 1 for
enable
secnamerw
string[31]
Private
6/6
Read/write security name
secnamero
string[31]
Public
6/6
Read only security name
authpwrw
string[8~128]
<blank>
6/6
Read/write authentication password
authpwro
string[8~128]
<blank>
6/6
Read only authentication password
authtyperw
MD5,SHA
MD5
6/6
Read/write authentication type
authtypero
MD5,SHA
MD5
6/6
Read only authentication type
encryptpwrw
string[8~128]
<blank>
6/6
Read/write passwrd
encryptpwro
string[8~128]
<blank>
6/6
Read only password
encrypttyperw
DES
DES
6/6
Read/write encryption type
encrypttypero
DES
DES
6/6
Read only encryption type
rwcommunity
string[31]
Private
6/6
Read/write community
rocommunity
string[31]
Public
6/6
Read only community
syslocation
string[128]
<blank>
6/6
System location
syscontact
string[128]
<blank>
6/6
System contact
User's Manual - 179
VIVOTEK
7.26 Layout configuration
Group: layout (New version)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
logo_default
<boolean>
1
1/6
0 => Custom logo
1 => Default logo
logo_link
string[128]
http://ww
1/6
Hyperlink of the logo
1/6
0 => display the power by vivotek
w.vivotek.c
om
logo_powerbyvvtk_hidden
<boolean>
0
logo
1 => hide the power by vivotek
logo
custombutton_manualtrigger_s
<boolean>
1
1/6
how
Show or hide manual trigger (VI)
button in homepage
0 -> Hidden
1 -> Visible
theme_option
1~4
1
1/6
1~3: One of the default themes.
4: Custom definition.
theme_color_font
string[7]
#ffffff
1/6
Font color
theme_color_configfont
string[7]
#ffffff
1/6
Font color of configuration area.
theme_color_titlefont
string[7]
#098bd6
1/6
Font color of video title.
theme_color_controlbackgroun
string[7]
#565656
1/6
Background color of control area.
string[7]
#323232
1/6
Background color of configuration
d
theme_color_configbackground
area.
theme_color_videobackground
string[7]
#565656
1/6
Background color of video area.
theme_color_case
string[7]
#323232
1/6
Frame color
180 - User's Manual
VIVOTEK
7.27 Privacy mask
Group: privacymask_c<0~(n-1)>for n channel product
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
enable
<boolean>
0
4/4
Enable privacy mask.
win_i<0~4>_enable
<boolean>
0
4/4
Enable privacy mask window.
win_i<0~4>_name
string[40]
<blank>
4/4
Name of the privacy mask
window.
win_i<0~4>_left
0 ~ 320
0
4/4
Left coordinate of window
position.
win_i<0~4>_top
0 ~ 240
0
4/4
Top coordinate of window
position.
win_i<0~4>_width
0 ~ 320
0
4/4
Width of privacy mask window.
win_i<0~4>_height
0 ~ 240
0
4/4
Height of privacy mask window.
User's Manual - 181
VIVOTEK
7.28 Capability
Group: capability
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
api_httpversion
<string>
0300a
0/7
The HTTP API version.
bootuptime
<positive
60
0/7
Server bootup time.
0
0/7
Number of IR interfaces.
0
0/7
Number of PIRs.
3
0/7
Number of digital inputs.
3
0/7
Number of virtual inputs
integer>
nir
0,
<positive
integer>
npir
0,
<positive
integer>
ndi
0,
<positive
integer>
nvi
0,
<positive
(manual trigger)
integer>
ndo
0,
1
0/7
Number of digital outputs.
1
0/7
Number of audio inputs.
1
0/7
Number of audio outputs.
1
0/7
Number of video inputs.
1
0/7
Number of videoinput
<positive
integer>
naudioin
0,
<positive
integer>
naudioout
0,
<positive
integer>
nvideoin
<positive
integer>
nvideoinprofile
<positive
integer>
nmediastream
<positive
profiles.
2
0/7
integer>
naudiosetting
<positive
per channels.
1
0/7
integer>
nuart
0,
<positive
182 - User's Manual
Number of media stream
Number of audio settings
per channel.
1
0/7
Number of UART
interfaces.
VIVOTEK
integer>
nmotion
<positive
3
0/7
Number of motions
1
0/7
Number of motion
integer>
nmotionprofile
0, <positive
integer>
ptzenabled
0, <positive
integer>
profiles.
189
0/7
An 32-bit integer, each bit
can be set separately as
follows:
Bit 0 => Support camera
control function;
0(not support),
1(support)
Bit 1 => 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)
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)
User's Manual - 183
VIVOTEK
Bit 9 => Reserved bit;
Invalidate lens_pan,
Lens_tilt, lens_zoon,
lens_focus, lens_iris.
0(fields are valid),
1(fields are invalid)
evctrlchannel
<boolean>
1
0/7
Indicate whether to
support HTTP tunnel for
event/control transfer.
joystick
<boolean>
1
0/7
Indicate whether to
support joystick control.
windowless
<boolean>
1
0/7
Indicate whether to
support
Windowless-plugin.
remotefocus
<boolean>
4
0/7
Indicate whether to
support
remotefocus function.
storage_dbenabled
<boolean>
1
0/7
Media files are indexed in
database.
protocol_https
< boolean >
1
0/7
Indicate whether to
support HTTP over SSL.
protocol_rtsp
< boolean >
1
0/7
Indicate whether to
support RTSP.
protocol_sip
<boolean>
1
0/7
Indicate whether to
support SIP.
protocol_maxconnection
<positive
10
0/7
integer>
The maximum allowed
simultaneous
connections.
protocol_maxgenconnection
<positive
10
0/7
integer>
protocol_rtp_multicast_
<boolean>
The maximum general
streaming connections .
1
0/7
scalable
Indicate whether to
support scalable
multicast.
protocol_rtp_multicast_
<boolean>
1
0/7
backchannel
Indicate whether to
support backchannel
multicast.
protocol_rtp_tcp
<boolean>
1
0/7
Indicate whether to
support RTP over TCP.
protocol_rtp_http
<boolean>
1
0/7
Indicate whether to
support RTP over HTTP.
184 - User's Manual
VIVOTEK
protocol_spush_mjpeg
<boolean>
1
0/7
Indicate whether to
support server push
MJPEG.
protocol_snmp
<boolean>
1
0/7
Indicate whether to
support SNMP.
protocol_ipv6
<boolean>
1
0/7
Indicate whether to
support IPv6.
protocol_pppoe
<boolean>
1
0/7
Indicate whether to
support PPPoE.
protocol_ieee8021x
<boolean>
1
0/7
Indicate whether to
support IEEE802.1x.
protocol_qos_cos
<boolean>
1
0/7
Indicate whether to
support CoS.
protocol_qos_dscp
<boolean>
1
0/7
Indicate whether to
support QoS/DSCP.
protocol_ddns
<boolean>
1
0/7
Indicate whether to
support DDNS.
videoin_type
0, 1, 2
2
0/7
0 => Interlaced CCD
1 => Progressive CCD
2 => CMOS
videoin_codec
mjpeg, h264
mjpeg, h264
0/7
Available codec list.
videoin_c0_nmode
<Integer>
3
0/7
Indicate how many video
modes supported by this
channel.
videoin_c0_rotation
<boolean>
0
0/7
Indicate current mode
whether support video
rotation
videoin_c0_nresolution
<positive
7
0/7
integer>
videoin_c0_resolution
Number of videoin
resolution.
<a list of
176x144, 384x216,
available
640x360,1280x720,
resolution
1360x768,1600x904
0/7
Available resolutions list.
0/7
Indicate how many frame
separated by
commas>
<product
dependent>
videoin_c0_maxframerate
A list of
30,30,30,30,30,30,3
<Integer>
0
rate image sensor outputs
in current video mode.
User's Manual - 185
VIVOTEK
*One to one mapping to
the resolution in
"resolution".
* The element number is
defined as "nresolution"
in this group.
* This parameter may be
changed when
"videoin_c<n>_cmosfreq
"=50 or
"videoin_c<n>_modulati
on"=pal.
Ex: 30 fps is changed to
25 fps, 60 fps is changed
to 50 fps, and so on.
videoin_c0_mjpeg_maxfram
A list of
30,30,30,30,30,30,3
erate
<Integer>
0
0/7
Maximum fps that the
device can encoded one
stream with MJPEG on
resolutions in current
video mode.
"-" means not support.
* One to one mapping to
the resolution in
"resolution".
* The element number is
defined as "nresolution"
in this group.
* This parameter may be
changed when
"videoin_c<n>_cmosfreq
"=50 or
"videoin_c<n>_modulati
on"=pal.
Ex: 30 fps is changed to
25 fps, 60 fps is changed
to 50 fps, and so on.
* Only available when
'mjpeg' is listed in
186 - User's Manual
VIVOTEK
"capability_videoin_codec
".
videoin_c0_mjpeg_maxbitra
<Positive
te
Integer>
40000000
0/7
Maximum bitrates of
MJPEG.
The unit is bps.
"-" means MJPEG does
not support bit rate
control.
* Only available when
'mjpeg' is listed in
"capability_videoin_codec
".
videoin_c0_h264_maxframe
A list of
30,30,30,30,30,30,3
rate
<Integer>
0
0/7
Maximum fps that the
device can encoded one
stream with H.264 on
resolutions in current
video mode.
"-" means not support.
* One to one mapping to
the resolution in
"resolution".
* The element number is
defined as "nresolution"
in this group.
* This parameter may be
changed when
"videoin_c<n>_cmosfreq
"=50 or
"videoin_c<n>_modulati
on"=pal.
Ex: 30 fps is changed to
25 fps, 60 fps is changed
to 50 fps, and so on.
* Only available when
'h264' is listed in
"capability_videoin_codec
".
videoin_c0_h264_maxbitrat
<Positive
40000000
0/7
Maximum bitrates of
User's Manual - 187
VIVOTEK
e
Integer>
H.264.
The unit is bps.
* Only available when
'h264' is listed in
"capability_videoin_codec
".
videoin_c0_streamcodec
<Positive
6,6
0/7
Integer>
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
videoin_c0_mode
<Integer>
0
0/7
Indicate current video
mode.
0:Dual stream mode
(Max. 30fps)
1: Video rotation mode
(Max. 30fps)
2: Single stream mode
(Max. 60fps)
videoin_c0_maxsize
<WxH>
1920x1080
0/7
The maximum resolution
of this channel, the unit is
pixel.
videoin_c0_mode0_rotation
<boolean>
0
0/7
Indicate this mode
whether support video
rotation
videoin_c0_mode0_effective
pixel
<WxH>
1920x1080
0/7
The visible area of full
scene in this video mode.
The unit is pixel in source.
* This value must <=
"capability_videoin_c<n>
_maxsize"
188 - User's Manual
VIVOTEK
* If "effectivepixel" <
"capability_videoin_c<n>
_maxsize", then the
visible area is located at
the center of full scene.
videoin_c0_mode0_outputsi
<WxH>
1920x1080
0/7
ze
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.
* Source (most for image
sensor) may perform
scale or binning, etc on
image data, and output
data with smaller size.
This parameter is
designed to represent
this.
videoin_c0_mode0_binning
binning
0
0/7
Indicate binning is used or
not in this video mode.
0: No binning
1: 2x2 binning
3: 3x3 binning
videoin_c0_mode0_nresoluti
<positive
7
0/7
Available resolutions list.
on
integer>
videoin_c0_mode0_resolutio
<a list of
176x144, 384x216,
0/7
Available resolutions list.
n
available
640x360,1280x720,
resolution
1360x768,1600x904
separated by
,1920x1080
0/7
Indicate how many frame
commas>
<product
dependent>
videoin_c0_mode0_maxfra
A list of
30,30,30,30,30,30,3
merate
<Positive
0
Integer>
rate image sensor outputs
in this video mode.
User's Manual - 189
VIVOTEK
* 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>_modulati
on"=ntsc
videoin_c0_mode0_maxfps_
<Integer>
mjpeg
videoin_c0_mode0_maxfps_
30,30,30,30,30,30,3
0/7
0
<Integer>
h264
30,30,30,30,30,30,3
device can encode
0/7
0
videoin_c0_mode0_descripti
<String[128]
Dual Stream (Max.
on
>
30fps)
videoin_c0_mode1_rotation
<boolean>
1
Maximum fps that the
Maximum fps that the
device can encode
0/7
Description about this
mode
0/7
Indicate this mode
whether support video
rotation
videoin_c0_mode1_effective
<WxH>
1920x1080
0/7
pixel
The visible area of full
scene in this video mode.
The unit is pixel in source.
* This value must <=
"capability_videoin_c<n>
_maxsize"
* If "effectivepixel" <
"capability_videoin_c<n>
_maxsize", then the
visible area is located at
the center of full scene.
videoin_c0_mode1_outputsi
ze
<WxH>
1920x1080
0/7
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
190 - User's Manual
VIVOTEK
systemfor many features,
like ePTZ, privacy mask,
motion, etc.
* Source (most for image
sensor) may perform
scale or binning, etc on
image data, and output
data with smaller size.
This parameter is
designed to represent
this.
videoin_c0_mode1_binning
binning
0
0/7
Indicate binning is used or
not in this video mode.
0: No binning
1: 2x2 binning
3: 3x3 binning
videoin_c0_mode1_nresoluti
<positive
7
0/7
Available resolutions list.
on
integer>
videoin_c0_mode1_resolutio
<a list of
176x144, 384x216,
0/7
Available resolutions list.
n
available
640x360,1280x720,
resolution
1360x768,1600x904
separated by
,1920x1080
0/7
Indicate how many frame
commas>
<product
dependent>
videoin_c0_mode1_maxfra
A list of
merate
<Positive
30,30,30,30,30,30,3
rate image sensor outputs
Integer>
0
in this video mode.
* 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
User's Manual - 191
VIVOTEK
"videoin_c<n>_modulati
on"=ntsc
videoin_c0_mode1_maxfps_
<Integer>
mjpeg
videoin_c0_mode1_maxfps_
30,30,30,30,30,30,3
0/7
0
<Integer>
h264
30,30,30,30,30,30,3
device can encode
0/7
0
videoin_c0_mode1_descripti
<String[128]
Video Rotation (Max.
on
>
30fps)
videoin_c0_mode2_rotation
<boolean>
0
Maximum fps that the
Maximum fps that the
device can encode
0/7
Description about this
mode
0/7
Indicate this mode
whether support video
rotation
videoin_c0_mode2_effective
<WxH>
1920x1080
0/7
pixel
The visible area of full
scene in this video mode.
The unit is pixel in source.
* This value must <=
"capability_videoin_c<n>
_maxsize"
* If "effectivepixel" <
"capability_videoin_c<n>
_maxsize", then the
visible area is located at
the center of full scene.
videoin_c0_mode2_outputsi
ze
<WxH>
1920x1080
0/7
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.
* Source (most for image
sensor) may perform
scale or binning, etc on
image data, and output
data with smaller size.
This parameter is
designed to represent
192 - User's Manual
VIVOTEK
this.
videoin_c0_mode2_binning
binning
0
0/7
Indicate binning is used or
not in this video mode.
0: No binning
1: 2x2 binning
3: 3x3 binning
videoin_c0_mode2_nresoluti
<positive
7
0/7
Available resolutions list.
on
integer>
videoin_c0_mode2_resolutio
<a list of
176x144, 384x216,
0/7
Available resolutions list.
n
available
640x360,1280x720,
resolution
1360x768,1600x904
separated by
,1920x1080
0/7
Indicate how many frame
commas>
<product
dependent>
videoin_c0_mode2_maxfra
A list of
60,60,60,60,60,60,6
merate
<Positive
0
rate image sensor outputs
Integer>
in this video mode.
* 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>_modulati
on"=ntsc
videoin_c0_mode2_maxfps_
<Integer>
mjpeg
videoin_c0_mode2_maxfps_
60,60,60,60,60,60,6
0/7
0
<Integer>
h264
60,60,60,60,60,60,6
device can encode
0/7
0
videoin_c0_mode2_descripti
<String[128]
Single Stream (Max.
on
>
60fps)
videoin_flexiblebitrate
<boolean>
1
Maximum fps that the
Maximum fps that the
device can encode
0/7
Description about this
mode
0/7
Indicate whether to
support
User's Manual - 193
VIVOTEK
flexible bit rate control.
timeshift
<boolean>
1
0/7
Indicate whether to
support time shift caching
stream.
audio_aec
<boolean>
0
0/7
Indicate whether to
support acoustic echo
cancellation.
audio_mic
<boolean>
0
0/7
Indicate whether to
support built-in
microphone input.
audio_extmic
<boolean>
1
0/7
Indicate whether to
support external
microphone input.
audio_linein
<boolean>
1
0/7
Indicate whether to
support external line
input.
(It will be replaced by
audio_mic and
audio_extmic.)
audio_lineout
<boolean>
1
0/7
Indicate whether to
support line output.
audio_headphoneout
<boolean>
0
0/7
Indicate whether to
support headphone
output.
audioin_codec
aac4, g711,
aac4, g711, g726
0/7
g726
audioout_codec
g711
Available codec list for
audio input.
g711
0/7
Available codec list for
SIP.
camctrl_httptunnel
<boolean>
1
0/7
Indicate whether to
support httptunnel.
camctrl_privilege
<boolean>
1
0/7
Indicate whether to
support “Manage
Privilege” of PTZ control in
the Security page.
1: support both
/cgi-bin/camctrl/camctrl.
cgi and
/cgi-bin/viewer/camctrl.c
gi
194 - User's Manual
VIVOTEK
0: support only
/cgi-bin/viewer/camctrl.c
gi
uart_httptunnel
<boolean>
1
0/7
Indicate whether to
support HTTP tunnel for
UART transfer.
transmission_mode
Tx,
Tx
0/7
Indicate transmission
Rx,
mode of the machine: TX
Both
= server, Rx = receiver
box, Both = DVR.
network_wire
<boolean>
1
0/7
Indicate whether to
support Ethernet.
network_wireless
<boolean>
0
0/7
Indicate whether to
support wireless.
wireless_s802dot11b
<boolean>
0
0/7
Indicate whether to
support wireless
802.11b+.
wireless_s802dot11g
<boolean>
0
0/7
Indicate whether to
support wireless 802.11g.
wireless_s802dot11n
<boolean>
0
0/7
Indicate whether to
support wireless 802.11n.
wireless_beginchannel
1 ~ 14
255
0/7
Indicate the begin
channel of wireless
network
wireless_endchannel
1 ~ 14
255
0/7
Indicate the end channel
of wireless network
wireless_encrypt_wep
<boolean>
0
0/7
Indicate whether to
support wireless WEP.
wireless_encrypt_wpa
<boolean>
0
0/7
Indicate whether to
support wireless WPA.
wireless_encrypt_wpa2
<boolean>
0
0/7
Indicate whether to
support wireless WPA2.
derivative_brand
<boolean>
1
0/7
Indicate whether to
support the upgrade
function for the derivative
brand. For example, if the
value is true, the VVTK
product can be upgraded
to VVXX. (TCVV<->TCXX
is excepted)
User's Manual - 195
VIVOTEK
npreset
0, <positive
20
0/7
integer>
eptz
0, <positive
Number of preset
locations
3
0/7
integer>
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
nanystream
0, <positive
0
0/7
integer>
iva
<boolean>
number of any media
stream per channel
0
0/7
Indicate whether to
support Intelligent Video
analysis
ir
<boolean>
0
0/7
Indicate whether to
support built-in IR led.
extir
<boolean>
1
0/7
Indicate whether to
support external IR led.
whitelight
<boolean>
0
0/7
Indicate whether to
support white light led.
iris
<boolean>
1
0/7
Indicate whether to
support iris control.
tampering
<boolean>
1
0/7
Indicate whether to
support tampering
detection.
temperature
<boolean>
0
0/7
Indicate whether to
support temperature
detection.
test_ac
<boolean>
0
0/7
Indicate whether to
support test ac key.
version_onvifdaemon
<string>
1.8.1.1
0/7
Indicate ONVIF daemon
version
version_genetec
<string>
1.0.2.7
0/7
Indicate Genetec version
media_videoclip_maxpreeve
<positive
9
0/7
Maximum duration
nt
integer>
(second) after event
occurred in a videoclip.
image_wdrc
196 - User's Manual
<Boolean>
0
0/7
Indicate whether to
VIVOTEK
support WDR enhanced.
image_iristype
<string>
piris
0/7
Indicate iris type.
image_focusassist
<Boolean>
0
0/7
Indicate whether to
support focus assist.
localstorage_manageable
<boolean>
1
0/7
Indicate whether
manageable local storage
is supported.
localstorage_seamless
<boolean>
1
0/7
Indicate whether
seamless recording is
supported.
localstorage_modnum
0,
4
0/7
<positive
The maximum MOD
connection numbers.
integer>
localstorage_modversion
<string>
1.0.2.6
0/7
Indicate MOD daemon
version
localstorage_slconnum
0,
1
0/7
<positive
The maximum seamless
connection number.
integer>
supportsd
<boolean>
1
0/7
Indicate whether to
support local storage.
remotecamctrl_master
0, <positive
0
0/7
integer>
Indicate whether to
support remote auxiliary
camera (master side),
this value means
supporting max number
of auxiliary camera.
remotecamctrl_slave
<boolean>
1
0/7
Indicate whether to
support remote camera
control (slave side).
vadp
<positive
integer>
1
0/7
An 32-bit integer, each bit
can be set separately as
follows:
Bit 0 => VADP interface
Bit 1 => Capture video
raw data
Bit 2 => Support encode
jpeg
Bit 3 => Audio
Bit 4 => Event
User's Manual - 197
VIVOTEK
nvadppkg
<positive
10
0/7
integer>
Indicate how many vadp
packages can be
uploaded.
7.29 Customized event script
Group: event_customtaskfile_i<0~2>
PARAMETER
VALUE
Default
SECURITY
DESCRIPTION
(get/set)
name
string[40]
<blank>
6/6
Custom script identification of this entry.
date
string[4~20]
<blank>
6/6
Date of custom script.
time
string[4~20]
<blank>
6/6
Time of custom script.
Default
SECURITY
DESCRIPTION
7.30 Event setting
Group: event_i<0~2>
PARAMETER
VALUE
(get/set)
name
string[40]
<blank>
6/6
Identification of this entry.
enable
0, 1
0
6/6
Enable or disable this event.
priority
0, 1, 2
1
6/6
Indicate the priority of this event:
“0”= low priority
“1”= normal priority
“2”= high priority
delay
1~999
10
6/6
Delay in seconds before detecting the
next event.
trigger
boot,
boot
6/6
Indicate the trigger condition:
di,
“boot” = System boot
motion,
“di”= Digital input
seq,
“motion” = Video motion detection
recnotify,
“seq” = Periodic condition
tampering,
“visignal” = Video input signal loss.
vi,
“recnotify” = Recording notification.
volalarm
“tampering” = Tamper detection.
“vi”= Virtual input (Manual trigger)
“volalarm”= Audio detection
triggerstatus
198 - User's Manual
String[40]
trigger
6/6
The status for event trigger
VIVOTEK
exttriggerstatus
trigger,
<blank>
6/6
The status for event DI 1 trigger
<blank>
6/6
The status for event audio detection
normal~trigger
,
trigger~norma
l
exttriggerstatus1
trigger,
normal~trigger
profiletrigger
,
trigger~norma
l
di
<integer>
1
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.
mdwin
<integer>
0
6/6
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 1st window.
For example, to detect the 1st and 3rd
windows, set mdwin as 5.
mdwin0
<integer>
0
6/6
Similar to mdwin. The parameter takes
effect when profile 1 of motion detection
is enabled.
vi
<integer>
0
6/6
Indicate the source id of vi trigger.
This field is required when trigger
condition is “vi”.
One bit represents one digital input. The
LSB indicates VI 0.
valevel
0,1
0
6/6
Select audio detection event.
0: not select
1: select
valevel0
0,1
0
6/6
Select audio detection profile event.
0: not select
1: select
inter
1~999
1
6/6
Interval of snapshots in minutes.
This field is used when trigger condition
is “seq”.
User's Manual - 199
VIVOTEK
weekday
0~127
127
6/6
Indicate which weekday is scheduled.
One bit represents one weekday.
bit0 (LSB) = Saturday
bit1 = Friday
bit2 = Thursday
bit3 = Wednesday
bit4 = Tuesday
bit5 = Monday
bit6 = Sunday
For example, to detect events on Friday
and Sunday, set weekday as 66.
begintime
hh:mm
00:00
6/6
Begin time of the weekly schedule.
endtime
hh:mm
24:00
6/6
End time of the weekly schedule.
(00:00 ~ 24:00 sets schedule as always
on)
lowlightcondition
0, 1
1
6/6
<product dependent>
Switch on white light LED in low light
condition
0 => Do action at all times
1 => Do action in low-light conditions
action_do_i<0~(ndo-1)
0, 1
0
6/6
Enable or disable trigger digital output.
1~999
1
6/6
Duration of the digital output trigger in
>_enable
action_do_i<0~(ndo-1)
>_duration
action_cf_enable
seconds.
<Boolean>
0
6/6
Enable or disable sending media to SD
card.
action_cf_folder
string[128]
<blank>
6/6
Path to store media.
action_cf_media
NULL, 0~4,101 <blank>
6/6
Index of the attached media.
action_cf_datefolder
<boolean>
6/6
Enable this to create folders by date,
1
time, and hour automatically.
action_cf_backup
<Boolean>
0
6/6
Enable or disable the function that send
media to SD card for backup if network is
disconnected.
action_server_i<0~4>_e 0, 1
0
6/6
Enable or disable this server action.
6/6
Index of the attached media.
nable
action_server_i<0~4>_ NULL, 0~4,101 <blank>
media
action_server_i<0~4>_ <boolean>
datefolder
200 - User's Manual
101 means “Recording Notify”
0
6/6
Enable this to create folders by date,
time, and hour automatically.
VIVOTEK
7.31 Server setting for event action
Group: server_i<0~4>
PARAMETER
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
name
string[40]
NULL
6/6
Identification of this entry
type
email,
email
6/6
Indicate the server type:
ftp,
“email” = email server
http,
“ftp” = FTP server
ns
“http” = HTTP server
“ns” = network storage
http_url
string[128]
http://
6/6
URL of the HTTP server to upload.
http_username
string[64]
NULL
6/6
Username to log in to the server.
http_passwd
string[64]
NULL
6/6
Password of the user.
ftp_address
string[128]
NULL
6/6
FTP server address.
ftp_username
string[64]
NULL
6/6
Username to log in to the server.
ftp_passwd
string[64]
NULL
6/6
Password of the user.
ftp_port
0~65535
21
6/6
Port to connect to the server.
ftp_location
string[128]
NULL
6/6
Location to upload or store the media.
ftp_passive
0, 1
1
6/6
Enable or disable passive mode.
0 = disable passive mode
1 = enable passive mode
email_address
string[128]
NULL
6/6
Email server address.
email_sslmode
0, 1
0
6/6
Enable support SSL.
email_port
0~65535
25
6/6
Port to connect to the server.
email_username
string[64]
NULL
6/6
Username to log in to the server.
email_passwd
string[64]
NULL
6/6
Password of the user.
email_senderemail
string[128]
NULL
6/6
Email address of the sender.
email_recipientemail
string[640]
NULL
6/6
Email address of the recipient.
ns_location
string[128]
NULL
6/6
Location to upload or store the media.
ns_username
string[64]
NULL
6/6
Username to log in to the server.
ns_passwd
string[64]
NULL
6/6
Password of the user.
ns_workgroup
string[64]
NULL
6/6
Workgroup for network storage.
User's Manual - 201
VIVOTEK
7.32 Media setting for event action
Group: media_i<0~4>(media_freespace is used internally.)
PARAMETER
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
name
string[40]
NULL
6/6
Identification of this entry
type
snapshot,
snapshot
6/6
Media type to send to the server or store
systemlog,
on the server.
videoclip,
recordmsg
snapshot_source
<integer>
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.
snapshot_prefix
string[16]
Snapshot[n]_
6/6
Indicate the prefix of the filename.
media_i0=> Snapshot1_
media_i1=> Snapshot2_
media_i2=> Snapshot3_
media_i3=> Snapshot4_
media_i4=> Snapshot5_
snapshot_datesuffix
0, 1
0
6/6
Add date and time suffix to filename:
1 = Add date and time suffix.
0 = Do not add.
snapshot_preevent
0~7
1
6/6
Indicates the number of pre-event
images.
snapshot_postevent
0~7
1
6/6
The number of post-event images.
videoclip_source
<integer>
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.
videoclip_prefix
string[16]
VideoClip[n]_
6/6
Indicate the prefix of the filename.
videoclip_preevent
0~9
0
6/6
Indicates the time for pre-event
recording in seconds.
videoclip_maxduration
1 ~ 20
5
6/6
Maximum duration of one video clip in
seconds.
videoclip_maxsize
50 ~ 3072
500
6/6
Maximum size of one video clip file in
Kbytes.
202 - User's Manual
VIVOTEK
7.33 Recording
Group: recording_i<0~1>
PARAMETER
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
name
string[40]
NULL
6/6
Identification of this entry.
trigger
schedule,
schedule
6/6
The event trigger type
networkfail
schedule: The event is triggered by
schedule
networkfail: The event is triggered by the
failure of network connection.
enable
0, 1
0
6/6
Enable or disable this recording.
priority
0, 1, 2
1
6/6
Indicate the priority of this recording:
“0” indicates low priority.
“1” indicates normal priority.
“2” indicates high priority.
source
0~2
0
6/6
Indicate the source of media stream.
0 means the first stream.
1 means the second stream and so on.
limitsize
0,1
0
6/6
0: Entire free space mechanism
1: Limit recording size mechanism
cyclic
0,1
0
6/6
0: Disable cyclic recording
1: Enable cyclic recording
notify
0,1
1
6/6
0: Disable recording notification
1: Enable recording notification
notifyserver
0~31
0
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.
User's Manual - 203
VIVOTEK
weekday
0~127
127
6/6
Indicate which weekday is scheduled.
One bit represents one weekday.
bit0 (LSB) = Saturday
bit1 = Friday
bit2 = Thursday
bit3 = Wednesday
bit4 = Tuesday
bit5 = Monday
bit6 = Sunday
For example, to detect events on Friday
and Sunday, set weekday as 66.
begintime
hh:mm
00:00
6/6
Start time of the weekly schedule.
endtime
hh:mm
24:00
6/6
End time of the weekly schedule.
(00:00~24:00 indicates schedule always
on)
prefix
string[16]
<blank>
6/6
Indicate the prefix of the filename.
cyclesize
200~
100
6/6
The maximum size for cycle recording in
Kbytes when choosing to limit recording
size.
reserveamount
0~
100
6/6
The reserved amount in Mbytes when
choosing cyclic recording mechanism.
dest
cf,
cf
6/6
0~4
The destination to store the recorded
data.
“cf” means local storage (CF or SD card).
“0” means the index of the network
storage.
cffolder
string[128]
NULL
6/6
Folder name.
maxsize
100~2000
100
6/6
Unit: Mega bytes.
When this condition is reached, recording
file is truncated.
maxduration
60~3600
60
6/6
Uuit: Second
When this condition is reached, recording
file is truncated.
adaptive_enable
0,1
0
6/6
Indicate whether the adaptive recording
is enabled
adaptive_preevent
0~9
5
6/6
Indicate when is the adaptive recording
started before the event trigger point
(seconds)
204 - User's Manual
VIVOTEK
adaptive_postevent
0~10
5
6/6
Indicate when is the adaptive recording
stopped after the event trigger point
(seconds)
7.34 HTTPS
Group: https (capability.protocol.https > 0)
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
enable
<boolean>
0
6/6
To enable or disable secure HTTP.
policy
<Boolean>
0
6/6
If the value is 1, it will force HTTP
connection redirect to HTTPS
connection
method
auto,
auto
6/6
auto =>Create self-signed
manual,
certificate automatically.
install
manual =>Create self-signed
certificate manually.
install =>Create certificate request
and install.
status
-3 ~ 1
0
6/6
Specify the https status.
-3= Certificate not installed
-2 = Invalid public key
-1 = Waiting for certificate
0= Not installed
1 = Active
countryname
string[2]
TW
6/6
Country name in the certificate
information.
stateorprovincename
string[128]
Asia
6/6
State or province name in the
certificate information.
localityname
string[128]
Asia
6/6
The locality name in thecertificate
information.
organizationname
string[64]
VIVOTEK Inc.
6/6
Organization name in the
certificate information.
unit
string[64]
VIVOTEK Inc.
6/6
Organizational unit name in
thecertificate information.
commonname
string[64]
www.vivotek.
6/6
com
validdays
0 ~ 3650
3650
Common name in the certificate
information.
6/6
Valid period for the certification.
User's Manual - 205
VIVOTEK
7.35 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
DESCRIPTION
(get/set)
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
7
6/6
integer>
To specify the expired days for automatic
clean up.
7.36 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
DESCRIPTION
(get/set)
s<0~(m-1)>_home
<coordinate>
0,0
s<0~(m-1)>_size
<window size> 1920x1080
1/6
ROI left-top corner coordinate.
1/6
ROI width and height. The width value
must be multiples of 16 and the height
value must be multiples of 8
7.37 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
Indicates multiple of zoom in is
“on-screen display” or not
smooth
<boolean>
1
1/4
Enable the ePTZ "move smoothly"
feature
tiltspeed
-5 ~ 5
0
1/7
Tilt speed
(It should be set by eCamCtrl.cgi rather
than by setparam.cgi.)
panspeed
-5 ~ 5
0
1/7
Pan speed
(It should be set by eCamCtrl.cgi rather
than by setparam.cgi.)
206 - User's Manual
VIVOTEK
zoomspeed
-5 ~ 5
0
1/7
Zoom speed
(It should be set by eCamCtrl.cgi rather
than by setparam.cgi.)
autospeed
1~5
1
1/7
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
SECURITY
DESCRIPTION
(get/set)
patrolseq
string[120]
<blank>
1/4
The patrol sequence of ePTZ. All the
patrol position indexes will be separated
by ","
patroldwelling
string[160]
<blank>
1/4
The dwelling time (unit: second) of each
patrol point, separated by “,”.
preset_i<0~19>_name
string[40]
<blank>
1/7
Name of ePTZ preset.
(It should be set by ePreset.cgi rather
than by setparam.cgi.)
preset_i<0~19>_pos
<coordinate>
<blank>
1/7
Left-top corner coordinate of the preset.
(It should be set by ePreset.cgi rather
than by setparam.cgi.)
preset_i<0~19>_size
<window size> <blank>
1/7
Width and height of the preset.
(It should be set by ePreset.cgi rather
than by setparam.cgi.)
User's Manual - 207
VIVOTEK
7.38 Focus Window setting
Group: focuswindow_c<0~(n-1)>for n channel product.
PARAMETER
VALUE
Default
SECURITY
DESCRIPTION
(get/set)
win_i0_enable
<boolean>
0
4/4
Enable or disable the window.
win_i0_home
(0~1728,0~936)
(864,468)
4/4
Left-top corner coordinate of the window.
win_i0_size
(192~1920,144~1080) (192x144)
4/4
Width and height of the window.
7.39 Seamless recording setting
Group: seamlessrecording(capability.localstorage.seamless> 0)
PARAMETER
VALUE
Default
SECURITY
DESCRIPTION
(get/set)
diskmode
seamless,
seamless
1/6
manageable
“seamless” indicates enable seamless
recording.
“manageable” indicates disable seamless
recording.
maxconnection
3
3
1/6
Maximum number of connected
seamless streaming.
stream
1~4
1
1/6
(Internal used, read only)
output
0~3
2
1/6
(Internal used, read only)
enable
<boolean>
0
1/6
Indicate whether seamless recording is
recording to local storage or not at
present.
(Read only)
guid<0~2>_id
string[127]
<blank>
1/6
The connected seamless streaming ID.
(Read only)
guid<0~2>_number
0~3
0
1/6
Number of connected seamless
streaming with guid<0~2>_id.
(Read only)
208 - User's Manual
VIVOTEK
7.40VIVOTEK Application Development Platformsetting
Group: vadp
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
version
<string>
1.3.0.0
6/7
Indicate the VADP version.
resource_total_memory
<integer>
124112
6/7
Indicate total available memory
size for VADP modules.
resource_total_storage
<integer>
32944
6/7
Indicate total size of the
internal storage space for
storing VADP modules.
resource_free_memory
<integer>
<product
6/7
dependent>
resource_free_storage
<integer>
<product
Indicate free memory size for
VADP modules.
6/7
dependent>
Indicate current free storage
size for uploading VADP
modules.
module_number
<integer>
1
6/7
Record the total module
number that already stored in
the system.
module_order
string[40]
<blank>
6/6
The execution order of the
enabled modules.
module_save2sd
<boolean>
1
6/6
Indicate if the module should
be saved to SD card when user
want to upload it.
If the value is false, save
module to the internal storage
space and it will occupy storage
size.
number
string[128]
<product
6/7
dependent>
This number is used to register
license key for VADP
application.
Group: vadp_module_i<0~(n-1)>
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
enable
<boolean>
0
6/6
Indicate if the module is
enabled or not.
If yes, also add the index of this
module to the module_order.
User's Manual - 209
VIVOTEK
name
string[40]
<blank>
6/6
Module name
url
string[120]
<blank>
6/6
Define the URL string after the
IP address if the module
provides it own web page.
vender
string[40]
<blank>
6/6
The provider of the module.
vendorurl
string[120]
<blank>
6/6
URL of the vendor.
version
string[40]
<blank>
6/6
Version of the module.
license
string[40]
<blank>
6/6
Indicate the license status of
the module.
licmsg
string[128]
<blank>
6/6
Indicate the message that will
be show on license status when
mouse over.
path
string[40]
<blank>
6/6
Record the storage path of the
module.
initscr
string[40]
<blank>
6/6
The script that will handle
operation commands from the
system.
status
string[40]
<blank>
6/6
Indicate the running status of
the module.
statmsg
string[128]
<blank>
6/6
Indicate the message that will
be show on the running status
when mouse over.
vvtklicensemec
string[40]
<blank>
6/7
Indicate the module use
VIVOTEK license mechanism
210 - User's Manual
VIVOTEK
7.41 Lens configuration
Group: lens
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
selected
0~127
0
1/6
Current selected lens profile
VALUE
DEFAULT
SECURITY
DESCRIPTION
Group: lens_default
NAME
(get/set)
numbers
0~127
1
1/6
Totoal number of the default
lens profiles
Group: lens_default_len<0~(n-1)>
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
name
string[127]
lens0:
1/6
Default lens name
1/6
Default lens type
HV0418PCIR_4-18mm_F1.4_P-IRIS
type
string[127]
Lens0:
P-IRIS
Group: lens_user
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
numbers
0~127
0
1/6
Totoal number of the default
lens profiles
max
0~127
10
1/6
Maximumnumber of the default
lens profiles
Group: lens_user_len<0~(n-1)>
NAME
VALUE
DEFAULT
SECURITY
DESCRIPTION
(get/set)
name
string[127]
<blank>
1/6
User-definedlens name
type
string[127]
<blank>
1/6
User-definedlens type
User's Manual - 211
VIVOTEK
8. Useful Functions
Drive the Digital Output (capability.ndo > 0)
Note: This request requires Viewer privileges.
Method: GET/POST
Syntax:
http://<servername>/cgi-bin/dido/setdo.cgi?do1=<state>[&do2=<state>]
[&do3=<state>][&do4=<state>]
Where state is 0 or 1; “0” means inactive or normal state, while “1” means active or triggered state.
PARAMETER
VALUE
DESCRIPTION
do<num>
0, 1
0 – Inactive, normal state
1 – Active, triggered state
Example: Drive the digital output 1 to triggered state and redirect to an empty page.
http://myserver/cgi-bin/dido/setdo.cgi?do1=1
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.
212 - User's Manual
VIVOTEK
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
Query Status of the Digital Output (capability.ndo > 0)
Note: This request requires Viewer privileges
Method: GET/POST
Syntax:
http://<servername>/cgi-bin/dido/getdo.cgi?[do0][&do1][&do2][&do3]
If no parameter is specified, all the digital output statuses will be returned.
Return:
HTTP/1.0 200 OK\r\n
Content-Type: text/plain\r\n
Content-Length: <length>\r\n
\r\n
[do0=<state>]\r\n
[do1=<state>]\r\n
[do2=<state>]\r\n
[do3=<state>]\r\n
where <state> can be 0 or 1.
Example: Query the status of digital output 1.
Request:
http://myserver/cgi-bin/dido/getdo.cgi?do1
Response:
HTTP/1.0 200 OK\r\n
Content-Type: text/plain\r\n
Content-Length: 7\r\n
User's Manual - 213
VIVOTEK
\r\n
do1=1\r\n
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
DEFA DESCRIPTION
ULT
channel
0~(n-1)
0
The channel number of the video source.
resolution
160~640, 120~360
0
The resolution of the image.
quality
1~5
3
The quality of the image.
streamid
0~(m-1)
2
The stream number.
The server will return the most up-to-date snapshot of the selected channel and stream in JPEG format. The size
and quality of the image will be set 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>
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>]
214 - User's Manual
VIVOTEK
PARAMETER
VALUE
DESCRIPTION
method
Add
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.
Delete
Remove an account from the server. When using this method, the
“username” field is necessary, and others are ignored.
edit
Modify the account password and privilege. When using this method,
the“username” field is necessary, and other fields are optional. If not
specified, it will keep the original settings.
username
<name>
The name of the user to add, delete, or edit.
userpass
<value>
The password of the new user to add or that of the old user to modify.
The default value is an empty string.
Privilege
Return
<value>
The privilege of the user to add or to modify.
viewer
Viewer privilege.
operator
Operator privilege.
admin
Administrator privilege.
<return page>
Redirect to the page <return page>after the parameter is assigned.
The <return page>can be a full URL path or relative path according to
the current path. If you omit this parameter, it will redirect to an
empty page.
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
User's Manual - 215
VIVOTEK
Upgrade Firmware
Note: This request requires Administrator privileges.
Method: POST
Syntax:
http://<servername>/cgi-bin/admin/upgrade.cgi
Post data:
fimage=<file name>[&return=<return page>]\r\n
\r\n
<multipart encoded form data>
Server will accept the file named <file name> to upgradethe firmware and return with <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>
[&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
216 - User's Manual
VIVOTEK
PARAMETER
VALUE
DESCRIPTION
channel
<0~(n-1)>
Channel of video source.
stream
<0~(m-1)>
Stream.
move
home
Move to home ROI.
up
Move up.
down
Move down.
left
Move left.
right
Move right.
pan
Auto pan.
patrol
Auto patrol.
stop
Stop auto pan/patrol.
wide
Zoom larger view with current speed.
tele
Zoom further with current speed.
wide or tele
Zoom without stopping for larger view or further view with zs speed,
auto
zoom
zooming
used for joystick control.
zs
0~6
Set the speed of zooming, “0” means stop.
vx
<integer>
The direction of movement, used for joystick control.
vy
<integer>
vs
0~7
Set the speed of movement, “0” means stop.
x
<integer>
x-coordinate clicked by user.
It will be the x-coordinate of center after movement.
y
<integer>
y-coordinate clicked by user.
It will be the y-coordinate of center after movement.
videosize
<window size>
The size of plug-in (ActiveX)window in web page
resolution
<window size>
The resolution of streaming.
stretch
<boolean>
0 indicates that it usesresolution(streaming size) as the range of the
coordinate system.
1 indicates that it usesvideosize(plug-in size) as the range of the
coordinate system.
speedpan
-5 ~ 5
Set the pan speed.
speedtilt
-5 ~ 5
Set the tilt speed.
speedzoom
-5 ~ 5
Set the zoom speed.
User's Manual - 217
VIVOTEK
speedapp
1~5
Set the auto pan/patrol speed.
return
<return page>
Redirect to the page <return page>after the parameter is assigned.
The <return page>can be a full URL path or relative path according to
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
VALUE
DESCRIPTION
channel
<0~(n-1)>
Channel of the video source.
stream
<0~(m-1)>
Stream.
recall
Text string less than 40 One of the present positions to recall.
characters
return
<return page>
Redirect to the page <return page>after the parameter is assigned.
The <return page>can be a full URL path or relative path according to
the current path.
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
VALUE
DESCRIPTION
channel
<0~(n-1)>
Channel of the video source.
stream
<0~(m-1)>
Stream.
218 - User's Manual
VIVOTEK
addpos
<Text string less than
Add one preset location to the preset list.
40 characters>
delpos
<Text string less than
Delete preset location from the preset list.
40 characters>
return
<return page>
Redirect to the page <return page>after the parameter is assigned.
The <return page>can be a full URL path or relative path according to
the current path.
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
VALUE
DESCRIPTION
type
NULL
Get IP filter type
allow, deny
Set IP filter type
addv4
Add IPv4 address into access list.
addv6
Add IPv6 address into access list.
delv4
Delete IPv4 address from access list.
delv6
Delete IPv6 address from access list.
<IP address>
Single address: <IP address>
method
ip
Network address: <IP address / network mask>
Range address:<start IP address - end IP address>
index
<value>
The start position to add or to delete.
return
<return page>
Redirect to the page <return page>after the parameter is assigned.
The <return page>can be a full URL path or relative path according to
the current path. If you omit this parameter, it will redirect to an
empty page.
User's Manual - 219
VIVOTEK
IP Filtering for ONVIF
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
VALUE
DESCRIPTION
type
NULL
Get IP filter type
allow, deny
Set IP filter type
addv4
Add IPv4 address into access list.
addv6
Add IPv6 address into access list.
delv4
Delete IPv4 address from access list.
delv6
Delete IPv6 address from access list.
<IP address>
Single address: <IP address>
method
ip
Network address: <IP address / network mask>
Range address:<start IP address - end IP address>
index
<value>
The start position to add or to delete.
return
<return page>
Redirect to the page <return page>after the parameter is assigned.
The <return page>can be a full URL path or relative path according to
the current path. If you omit this parameter, it will redirect to an
empty page.
220 - User's Manual
VIVOTEK
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 theURL 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.
User's Manual - 221
VIVOTEK
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>…]
The commands usage and their input arguments are as follows.
PARAMETER
VALUE
DESCRIPTION
cmd_type
<string>
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
unique integer.
triggerType
<text>
Optional.
Indicate the event trigger type.
Please embrace your input value with single quotes.
Ex. mediaType=’motion’
Support trigger types are product dependent.
mediaType
<text>
Optional.
Indicate the file media type.
Please embrace your input value with single quotes.
Ex. mediaType=’videoclip’
Support trigger types are product dependent.
destPath
<text>
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>
222 - User's Manual
Optional.
VIVOTEK
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’
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 1st2008to
the end of Jan 1st 2008.
limit
<positive integer>
Optional.
Limit the maximum number of returned search records.
offset
<positive integer>
Optional.
Specifies how many rows to skip at the beginning of the matched
records.
Note that the offset keyword is used after limit keyword.
To increase the flexibility of search command, you may use “OR” connectors for logical “OR” search operations.
Moreover, 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
VALUE
DESCRIPTION
label
<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
User's Manual - 223
VIVOTEK
Command: update
PARAMETER
VALUE
DESCRIPTION
label
<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
Ex. Update records whose key numbers are 2 and 3 to be unlocked status.
http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=update&isLocked=0&label=2&label=3
Command: queryStatus
PARAMETER
VALUE
DESCRIPTION
retType
xml or javascript
Optional.
Ex. retype=javascript
The default return message is in XML format.
Ex. Query local storage status and call for javascript format return 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
VALUE
DESCRIPTION
vi<num>
state[(duration)nstate]
Ex: vi0=1
Setting virtual input 0 to trigger state
Where "state" is 0, 1. “0”
224 - User's Manual
VIVOTEK
return
means inactive or normal
Ex: vi0=0(200)1
state while “1” means
Setting virtual input 0 to normal state, waiting 200
active or triggered state.
milliseconds, setting it to trigger state.
Where "nstate" is next
Note that when the virtual input is waiting for next state, it
state after duration.
cannot accept new requests.
<return page>
Redirect to the page <return page>after the request is
completely assigned. The <return page>can be a full URL
path or relative path according the current path. If you omit
this parameter, it will redirect to an empty page.
Return Code
Description
200
The request is successfully executed.
400
The request cannot be assigned, ex. incorrect parameters.
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.
503
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).
User's Manual - 225
VIVOTEK
Open Timeshift Stream (capability.timeshift > 0,
timeshift_enable=1, timeshift_c<n>_s<m>_allow=1)
Note: This request requires Viewer access privileges.
Syntax:
For HTTP push server (MJPEG):
http://<servername>/<network_http_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&reftime=<v
alue>&forcechk&minsft=<value>]
For RTSP (H264), the user needs to input theURL below into an RTSP compatible player.
rtsp://<servername>/<network_rtsp_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&reftime=<va
lue>&forcechk&minsft=<value>]
“n” is the channel index.
“m” is the timeshift stream index.
For details on timeshift stream, please refer to the “TimeshiftCaching” documents.
PARAMETER
VALUE
DEFAULT
DESCRIPTION
maxsft
<positive
0
Request cached stream at most how many seconds ago.
normal
Streaming mode:
integer>
tsmode
normal,
adaptive
normal => Full FPS all the time.
adaptive => Default send only I-frame for H.264, and send 1
FPS for MJPEG. If DI or motion window are triggered, the
streaming is changed to send full FPS for 10 seconds.
(*Note: this parameter also works on non-timeshift streams.)
reftime
mm:ss
The time
Reference time for maxsft and minsft.
camera receives (This provides more precise time control to eliminate the
the request.
inaccuracy due to network latency.)
Ex: Request the streaming from 12:20
rtsp://10.0.0.1/live.sdp?maxsft=10&reftime=12:30
forcechk
N/A
N/A
Check if the requested stream enables timeshift, feature and
if minsft is achievable.
If false, return “415 Unsupported Media Type”.
minsft
<positive
integer>
226 - User's Manual
0
How many seconds of cached stream client can accept at least.
(Used by forcechk)
VIVOTEK
Return Code
Description
400 Bad Request
Request is rejected because some parameter values are illegal.
415 Unsupported Media Type
Returned, if forcechk appears,when minsft is not achievable or the timeshift
feature of the target stream is not enabled.
Remote Focus
Note: This request requires Administrator privileges.
Method: GET/POST
Syntax:
http://<servername>/cgi-bin/admin/remotefocus.cgi?function=<value>[&direction=<value>]
[&position=<value>][&steps=<value>][&iris]
PARAMETER
VALUE
DESCRIPTION
function
focus,
Function type
auto,
focus – Move focus motor
scan,
auto – Perform auto focus
stop,
scan – Perform focus scan
positioning,
stop – Stop current operation
irisopen,
positioning – Position the motors
irisenable,
irisopen – Open iris. It will maintain this status until sending irisenable
resetfocus,
cgi.
getstatus
irisenable – Not open iris
resetfocus – reset focus motor to default valuegetstatus–Information
of motors, return value as below:
remote_focus_focus_motor_max: Maximum steps of focus motor
remote_focus_focus_motor_start: Start point of effective focal length
remote_focus_focus_motor_end: End point of effective focal length
remote_focus_focus_motor: Current position of focus motor
remote_focus_focus_enable: Current function of focus motor
remote_focus_value_mode: Source of focus value. 0: ISP, 1: Edge.
remote_focus_iris_open: The current status of iris. 0: irisenable, 1:
irisopen
direction
direct,
Motor’s moving direction.
forward,
It works only if function= focus.
backward
User's Manual - 227
VIVOTEK
position
0~<motor_max>
Motor’s position.
It works only if function=zoom | focus and direction=direct.
<motor_max> is refer to remote_focus_focus_motor_max which
replied from "function=getstatus"
steps
1 ~ <motor_max>
Motor’s moving steps.
It works only if function= focus and direction=forward | backward.
<motor_max> is refer to remote_focus_focus_motor_max which
replied from "function=getstatus"
iris
N/A
Open iris or not.
It works only if function=auto | scan.
Export Files
Note: This request requires Administrator privileges.
Method: GET
Syntax:
For daylight saving time configuration file:
http://<servername>/cgi-bin/admin/exportDst.cgi
For language file:
http://<servername>/cgi-bin/admin/export_language.cgi?currentlanguage=<value>
PARAMETER
VALUE
DESCRIPTION
currentlanguage
0~20
Available language lists.
Please refer to:
system_info_language_i0 ~ system_info_language_i19.
For setting backup file:
http://<servername>/cgi-bin/admin/export_backup.cgi?backup
228 - User's Manual
VIVOTEK
Upload Files
Note: This request requires Administrator privileges.
Method: POST
Syntax:
For daylight saving time configuration file:
http://<servername>/cgi-bin/admin/upload_dst.cgi
Post data:
filename =<file name>\r\n
\r\n
<multipart encoded form data>
For language file:
http://<servername>/cgi-bin/admin/upload_lan.cgi
Post data:
filename =<file name>\r\n
\r\n
<multipart encoded form data>
For setting backup file:
http://<servername>/cgi-bin/admin/upload_backup.cgi
Post data:
filename =<file name>\r\n
\r\n
<multipart encoded form data>
Server will accept the file named <file name> to upload this one to camera.
User's Manual - 229
VIVOTEK
Update Lens configuration
Note: This request requires Administrator privileges.
Method: GET
Syntax:
For choose selected lens configuration:
http://<servername>/cgi-bin/admin/update_lens.cgi?choose_lens=<value>
For delete selected lens configuration:
http://<servername>/cgi-bin/admin/update_lens.cgi?delete_lens=<value>
PARAMETER
VALUE
DESCRIPTION
value
0~10
Available lens lists.
Please refer to:
lens_default_len0 ~ lens_default_len10
lens_user_len0 ~ lens_user_len10
Method: POST
Syntax:
For upload user defined lens configuration:
http://<servername>/cgi-bin/admin/update_lens.cgi?upload_lens
Post data:
upload_lens_profile_input =<file name>\r\n
\r\n
<multipart encoded form data>
Server will accept the file named <file name> to upload the lens profile to camera.
230 - User's Manual
VIVOTEK
9. Video out supporting issues
The VideoOut support depends on different video modes. In following video modes, Video out will not support in
such cases:
Dual stream mode
Video rotation mode
Single stream mode
IP8155
Always support VideoOut
Both stream resolution > 720p
Not support VideoOut
IP8165
Both stream resolution > 720p
Both stream resolution > 720p
Not support VideoOut
IP816A
Both stream resolution > 720p
Both stream resolution > 720p
Not support Video Out
User's Manual - 231
VIVOTEK
Technical Specifications
Technical Specifications
Model
Intelligent Video
IP816A-HP
System Information
Video Motion Detection
Triple-window video motion detection
CPU
Multimedia SoC (System-on-Chip)
Alarm and Event
Flash
256 MB
Alarm Triggers
RAM
384 MB
Video motion detection, manual trigger, digital input,
periodical trigger, system boot, recording notification,
camera tampering detection, audio detection
Alarm Events
Event notification using digital output, HTTP, SMTP, FTP and
NAS server, SD Card
File upload via HTTP, SMTP, FTP, NAS server and SD card
Camera Features
Image Sensor
1/1.9" Progressive CMOS
Maximum Resolution
1920x1080 (2MP)
Lens Type
Vari-focal
Focal Length
f = 4 ~ 18 mm
Aperture
F1.4 ~ F13
Auto-iris
P-iris (DC-iris reserved)
Field of View
General
Smart Focus System
RBF (Remote Back Focus)
Connectors
29° ~ 106° (Horizontal)
16° ~ 60° (Vertical)
33° ~ 130° (Diagonal)
RJ-45 for Network/PoE connection
Audio input/output
BNC Video output
AC 24V power input
DC 12V power input
Digital input*3
Digital output*1
RS485
LED Indicator
System power and status indicator
Shutter Time
1/5 sec. to 1/10,000 sec.
Power Input
DC12V/AC24V
IEEE 802.3af PoE
WDR Technology
WDR Pro
Power Consumption
Day/Night
Removable IR-cut filter for day & night function
DC Max. 9.2W
AC Max. 15.4W
PoE Max.12.2W
Minimum Illumination
0.03 Lux @ F1.4 (Color)
0.001 Lux @ F1.4 (B/W)
Dimensions
230.2 mm (D) x 70 mm (W) x 63.5 mm (H)
Weight
Net: 632g
Safety Certifications
CE, LVD, FCC Class B, VCCI, C-Tick, UL
Operating Temperature
Starting Temperature: 0°C ~ 60°C (32°F ~ 140°F)
Working Temperature: -10°C ~ 60°C (14°F ~ 140°F)
Warranty
36 months
Pan/tilt/zoom Functionalities
On-board Storage
ePTZ:
48x digital zoom (4x on IE plug-in, 12x built in)
SD/SDHC/SDXC card slot
Video
Compression
H.264 & MJPEG
Maximum Frame Rate
In both compression mode
30fps @ 1920 x1080
60fps @ 1920 x1080 (In one-stream mode only)
Maximum Streams
2 simultaneous streams
S/N Ratio
50.8 dB
Dynamic Range
Up to 100 dB
Video Streaming
Adjustable resolution, quality and bitrate
Image Settings
Time stamp, text overlay, flip & mirror
Configurable brightness, contrast, saturation, sharpness,
white balance, exposure control, gain, backlight
compensation, privacy masks, scheduled profile settings
3D noise reduction, EIS, video rotation, snapshot focus
System Requirements
Operating System
Microsoft Windows 8/7/Vista/XP/2000
Web Browser
Mozilla Firefox 7~10 (streaming only)
Internet Explorer 7/8/9/10
Other Players
VLC: 1.1.11 or above
Quicktime: 7 or above
Included Accessories
Audio
CD
User's manual, quick installation guide, Installation Wizard 2,
ST7501 32-channel recording software
Others
Quick installation guide, warranty card, lens, camera stand,
screw pack
Dimensions
Audio Capability
Two-way audio (full duplex)
Compression
AAC, G.711, G.726
Interface
External microphone input
Audio output
70 mm
Network
Live viewing for up to 10 clients
Protocols
IPv4, IPv6, TCP/IP, HTTP, HTTPS, UPnP, RTSP/RTP/RTCP, IGMP,
SMTP, FTP, DHCP, NTP, DNS, DDNS, PPPoE, CoS, QoS, SNMP,
802.1X, UDP, ICMP
Interface
10Base-T/100 BaseTX Ethernet (RJ-45)
ONVIF
Supported, specification available at www.onvif.org
156.5 mm
63.5 mm
Users
73.7 mm
Compatible Accessories
Enclosures
AE-211
AE-232
AE-233
AE-234
AE-235
Camera enclosure
with blower
Camera enclosure
with heater and
blower
Camera enclosure
with heater and
blower (24 VAC)
Camera enclosure
with blower and
IR (IK10)
Camera enclosure
with blower and IR
All specifications are subject to change without notice. Copyright © VIVOTEK INC. All rights reserved.
Ver. 8
232 - User's Manual
VIVOTEK INC.
VIVOTEK USA
VIVOTEK Europe
VIVOTEK India
6F, No.192, Lien-Cheng Rd., Chung-Ho,
New Taipei City, 235, Taiwan, R.O.C.
T: +886-2-82455282 F: +886-2-82455532
E: [email protected]
2050 Ringwood Avenue,
San Jose, CA 95131
T: 408-773-8686 F: 408-773-8298
E: [email protected]
Randstad 22-133, 1316BW Almere,
The Netherlands
T: +31(0)36-5298-434
E: [email protected]
602, Best sky Tower, Plot No. F-5,
Netaji Subhash Place, Pitam Pura, Delhi-110 034
T: +91-11-45137465
E: [email protected]
VIVOTEK
Technology License Notice
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 - 233
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
この装置は、情報処理装置等電波障害自主規制協議会(VCCI)の基準にづくクラスB情報技術装置
です。この装置は、家庭環境で使用することを目的としていますが、この装置がラジオやテレビジョン
受信機に近接して使用されると、受信障害を引き起こすことがあります。
取扱説明書に従って正しい取り扱いをして下さい
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.
234 - User's Manual
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement