VIVOTEK
2 - User's Manual
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
Installation .......................................................................................................................................................10
Hardware Installation ..................................................................................................................................... 10
Network Deployment ..................................................................................................................................... 13
Software Installation ...................................................................................................................................... 16
Ready to Use .................................................................................................................................................17
Conguration Option: Recessed Mount Installation ......................................................................................18
Accessing the Network Camera ......................................................................................................................... 25
Using Web Browsers ..................................................................................................................................... 25
Using RTSP Players ...................................................................................................................................... 27
Using 3GPP-compatible Mobile Devices ....................................................................................................... 28
Using VIVOTEK Recording Software ............................................................................................................ 29
Main Page ..........................................................................................................................................................30
Client Settings ....................................................................................................................................................37
Conguration ......................................................................................................................................................42
System > General settings ............................................................................................................................ 43
System > Homepage layout ......................................................................................................................... 44
System > Logs ..............................................................................................................................................47
System > Parameters ...................................................................................................................................48
System > Maintenance .................................................................................................................................. 49
Media > Image ............................................................................................................................................ 53
Media > Video ............................................................................................................................................... 61
Media > Audio................................................................................................................................................ 64
Network > General settings ........................................................................................................................... 65
Network > Streaming protocols ................................................................................................................... 73
Network > DDNS ......................................................................................................................................... 77
Network > SNMP (Simple Network Management Protocol) .......................................................................... 82
Security > User Account ................................................................................................................................ 83
Security > HTTPS (Hypertext Transfer Protocol over SSL) ................................................................ 84
Security > Access List ................................................................................................................................. 91
PTZ > PTZ settings ......................................................................................................................................96
Event > Event settings ................................................................................................................................101
Applications > Motion detection................................................................................................................... 116
Applications > DI and DO .......................................................................................................................... 119
Applications > Audio detection .................................................................................................................. 120
Applications > VADP (VIVOTEK Application Development Platform) ........................................................ 122
VIVOTEK
User's Manual - 3
Recording > Recording settings ........................................................................................................................ 124
Local storage > SD card management ............................................................................................................... 129
Local storage > Content management ............................................................................................................... 130
Appendix ................................................................................................................................................................. 132
URL Commands for the Network Camera .......................................................................................................... 132
Technical Specications ..................................................................................................................................... 230
Technology License Notice ................................................................................................................................. 231
Electromagnetic Compatibility (EMC) ................................................................................................................. 232
VIVOTEK
4 - User's Manual
Overview
VIVOTEK’s SD8161 is part of the SUPREME series product line offering 1080p Full HD
resolution with superb image quality. Adopting a 18x optical zoom lens and sophisticated pan/
tilt mechanism, the SD8161 is able to capture ne detail at top-notch quality, and is especially
suitable for wide open indoor spaces such as airports and lobbies where highest levels of
reliability and precision are always required.
The SD8161 supports high-performance H.264/MJPEG compression technology and offers
extra smooth video quality with resolution of up to 30 fps @ 1080p. With WDR Enhancement
technology, the SD8161 can also cope with challenging lighting conditions and generate image
quality close to the capabilities of the human eye. With a sophisticated pan/tilt mechanism, the
camera provides fast, precise movement with continuous 360-degree pan and 220-degree tilt.
Users can also easily control the lens position via a mouse or a joystick to track the object of
interest and set up to 256 preset positions. With its built-in auto tracking feature, the SD8161
further provides instantaneous reaction to suspicious moving objects in wide area locations,
even before operators are aware of activity. With other advanced features such as MicroSD/
SDHC/SDXC card slot, 802.3at compliant PoE Plus and 30 fps high quality video, the SD8161
is the best choice for the most demanding indoor surveillance applications.
Revision History
■ Rev. 1.0: Initial release
VIVOTEK
User's Manual - 5
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 exible 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 rst 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
■ SD8161
■ Screws / Alignment Sticker / T25 Stardriver
■ Quick Installation Guide
■ Software CD
■ PC/ABS /Smoked Dome Cover (Separately Purchased)
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.
VIVOTEK
6 - User's Manual
Physical Description
Outer View
Lens
Status LED
Network LED
Reset Button
This drawing shows a camera with its dome cover
removed.
M
icro
SD
The MicroSD card slot is accessed by removing the dome cover
using the T25 stardriver. Peel the rubber cover open to acess the
MicroSD slot.
VIVOTEK
User's Manual - 7
Status LED
Item LED status Description
1 Steady red Power on and system booting
Red LED OFF Power off
2 Steady red & Green blinking every 1 sec. Network normal (heartbeat)
Steady
red & Green LED OFF Network failed
3 Red blinking every 0.15 sec. & Green blinking
every 1 sec.
Upgrading rmware
4 Red blinking every 0.15 sec. & Green blinking
every 0.15 sec.
Restoring default
Hardware Reset
The reset button is used to reset the system or to 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 reset button with a paper clip or thin object. Wait for the Network
Camera to reboot.
Restore: Press and hold the reset button for at least ten seconds to restore system defaults.
Note that all settings will be restored to factory defaults.
SD/SDHC/SDXC Card Capacity
This network camera is compliant with SD/SDHC/SDXC 32GB, 64GB, and other preceding
standard SD cards.
VIVOTEK
8 - User's Manual
Terminal Block Pinouts
Name Description Note:
Chassis ground
Audio GND Audio ground Common ground for MIC
IN and Line OUT
MIC IN Microphone input
Line OUT Audio output
RS485- RS485 receive
RS485+ RS485 transmit
DI GND Digital input ground Common ground for all DI
and DO pins
DI1 ~ DI4 Digital input pins 1
to 4
DO1 ~ DO2 Digital output pins
1 & 2
DO+(12V) Digital output pin w/
12V output
(max. load current 50mA)
Power IN 12V DC or 24V AC
power input
VIVOTEK
User's Manual - 9
DI/DO Diagram
Please refer to the following illustration for the connection method. Please note that the
maximum load on the DO pins is 50mA.
DI-
DO+
DI+
DO-
+12
VDC
Max.
VDC
Switch
BJT transistor
DI-
DO+
DI+
DO-
+12
VDC
VDC
Switch
BJT transistor
Relay
Relay
AC
Source
NO NC
AC
Device
AC
Source
AC
Device
NO
NC
•
The camera can be driven by an Ethernet connection to a PoE Plus switch (30W output).
You can connect both the PoE Plus and the 24V power for fail-safe redundancy.
IMPORTANT:
VIVOTEK
10 - User's Manual
Installation
Hardware Installation
The camera weighs 2.4kg. Select a rigid mounting location to prevent vibration to the camera.
1. Remove the retention screw on the side of camera.
2. Turn and detach the top section.
3. Attach the alignment sticker to the wall. Drill 3 pilot holes into the wall, and drill another hole
for routing cables.
1
2
3
1. IO wires are user-supplied.
2. Avoid touching the circuit boards to prevent damage by electro static discharge.
3. Use CAT5e and CAT6 cables only.
NOTE:
VIVOTEK
User's Manual - 11
5
4
6
4. Hammer in the threaded anchors.
5. Secure the top section to ceiling using the included screws.
6. Pass cables through the pre-drilled hole or the side openings, and then connect to the
camera.
The product is not likely to require connection to an Ethernet network with outside plant routing,
including the campus environments; and the ITE is to be connected only to PoE networks
without routing to the outside plant.
IMPORTANT:
VIVOTEK
12 - User's Manual
Mounting the Camera
7
8
9
Alignment Mark
7. Align the camera body with the top section. Align the alignment mark on the camera with that
on the top section. Push the camera up to match the top section.
8. Rotate the camera clockwise.
9. Use the included T25 stardriver to tighten the anti-tamper screw on the side to secure the
connection. Make sure all parts have been securely tightened.
VIVOTEK
User's Manual - 13
Network Deployment
Setting up the Network Camera over the Internet
There are several ways to set up the Network Camera over the Internet. The rst way is to set
up the Network Camera behind a router
. The second way is to utilize a static IP. The third way is
to use PPPoE
.
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 16 for
details.
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.
■ Secondary HTTP port: 8080
■ RTSP port: 554
■ RTP port for audio: 5558
■ RTCP port for audio: 5559
■ RTP port for video: 5556
■ RTCP port for video: 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
IP address : 192.168.0.3
Subnet mask : 255.255.255.0
Default router : 192.168.0.1
IP address : 192.168.0.2
Subnet mask : 255.255.255.0
Default router : 192.168.0.1
LAN (Local Area Network)
Router IP address : 192.168.0.1
WAN (Wide Area Network )
Router IP address : from ISP
Cable or DSL Modem
POWER
COLLISION
LINK
RECEIVE
PARTITION
1
2
3
4
5
Internet
VIVOTEK
14 - User's Manual
Internet. Please refer to Network Type on page 65 for details.
For example, your router and IP settings may look like this:
Device IP Address: internal
port
IP Address: External Port (Mapped port on the
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
... ... ...
Congure the router, virtual server or rewall, so that the router can forward any data coming
into a precongured 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 congured, 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 conguration page, please open the ports
accordingly on your router. For example, you can open a management session with your router
to congure access through the router to the camera within your local network. Please consult
your network administrator for router conguration if you have troubles with the conguration.
For more information with network conguration options (such as that of streaming ports),
please refer to Conguration > 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.
VIVOTEK
User's Manual - 15
General Connection
1. Connect the Network Camera's Ethernet cable (CAT5e) to a PoE Plus switch.
When using a non-PoE switch
Use a PoE Plus power injector (separately purchased) capable of 30W output to connect be-
tween the Network Camera and a non-PoE switch.
2. Connect the power wires to an AC 24V power adaptor (user-supplied).
You can connect both power sources for redundancy in power supply.
Power over Ethernet (High Power PoE)
AC 24V 3.5A Adapter
(User-supplied)
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 on page 65 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 66 for details.
IEEE 802.3at PoE Switch (30W output)
and / or
Non-PoE Switch
PoE Plus Power
Injector
VIVOTEK
16 - User's Manual
Software Installation
Installation Wizard 2 (IW2), free-bundled software included on the product CD, helps you set up
your Network Camera on the LAN.
1. Install IW2 under the Software Utility directory from the software CD.
Double click the IW2 shortcut on your desktop to launch the program.
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 main installer window will prompt. Double-click on the MAC and
model name which matches the product label on your device to connect to the Network
Camera via a web browser.
0002D1730202
00-02-D1-73-02-02 192.168.5.151 SD8161
Installation
Wizard 2
IW
2
Network Camera
Model No: SD8161
Made in Taiwan
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
MAC:0002D1730202
R o HS
VIVOTEK
User's Manual - 17
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.
•
Currently the Network Camera utilizes a 32-bit ActiveX plugin. You CAN NOT open a
management/view session with the camera using a 64-bit IE browser.
•
If you encounter this problem, try execute the Iexplore.exe program from C:\Windows\
SysWOW64. A 32-bit version of IE browser will be installed.
•
On Windows 7, the 32-bit explorer browser can be accessed from here: C:\Program Files
(x86)\Internet Explorer\iexplore.exe
•
If you experience compatibility issues between the plug-in control, you may try to uninstall
the Camera Stream Controller located in: C:/Program Files (x86)/Camera Stream Controller.
30x
IMPORTANT:
VIVOTEK
18 - User's Manual
Conguration Option: Recessed Mount Installation
AM-104 Recessed-mount Bracket Mechanical Drawing
Package Contents
• Recessed-mount bracket
• 1x tether line to the camera
• Alignment sticker
User Supplied Items
• Tether line to the bracket
• #2 Phillips screwdriver.
• Tools for handling the ceiling board.
IMPORTANT:
1. This recessed mount bracket is for indoor use only.
2. Any hardware that is not provided by VIVOTEK (this bracket is installed to) is the responsibility
of the installer.
3. Do not install the camera to lightweight ceiling boards that can not support the weight of this
installation.
4. Use Ethernet cables that come without the strain relief boot or molding.
VIVOTEK
User's Manual - 19
260mm
48mm
Up to
Ceiling Hole Template Sticker
260mm
Mounting Hole Denitions
1. Determine a secure location for the recessed-mount bracket.
2. Drill or cut a 260mm hole (in diameter). The maximum thickness of the ceiling/board is 48mm.
The ceiling should be able to sustain at least a weight of 6kgs.
3. Remove cover ring from the mount
bracket by turning it clockwise.
VIVOTEK
20 - User's Manual
4. Use a #2 Phillips screwdriver to move the clamping plates down so that the ceiling board is
caught between the clamps and the ange on the other side of the ceiling.
Clockwise
Counter-
clockwise
VIVOTEK
User's Manual - 21
5. Make sure the recessed mount bracket is secured to the ceiling board by its clamping plates.
You can then route an Ethernet cable and I/O wires through the opening on the bracket.
For safety concerns, you should also pass a tether line through the hanger piece on the
bracket. Connect the other end of the line to a secure anchor point.
VIVOTEK
22 - User's Manual
6. Remove the top section and connect cables to the camera.
Use the package foam to protect the dome cover when
working on the camera.
VIVOTEK
User's Manual - 23
2
3
4
1
7. Attach the camera body to the recessed mount bracket.
7-1. Install and secure the camera's tether line to the hanger piece of the bracket.
7-2. Push the camera up into the bracket, turn the camera clock-wise.
7-3. When doing so, apply a steady and even force upwards.
7-4. When the grooves on top of the cameras reach the locking tabs on the bracket, the
camera will t into position. Turn further clock-wise. You can feel a slight resistance force. The
camera will then be secured to the bracket.
VIVOTEK
24 - User's Manual
NOTE:
1. Connect and route cables before you secure the recessed-mount bracket to a ceiling.
2. For details on the cable connections with the camera, please refer to their Quick Installation
Guide.
8. Once the camera is secured, align and attach cover ring to the bracket by turning it counter-
clockwise.
VIVOTEK
User's Manual - 25
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 to the Network Cameras on the 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 eld. (A temporary IP will be
generated for the camera. Find it in your Network Neighborhood). Press Enter.
3. Live video will display in your web browser.
4. If it is the rst time installing the VIVOTEK network camera, an information bar will pop up as
shown below. Follow the instructions to install the required plug-in on your computer.
For Mozilla Firefox or Netscape users, your browser will use Quick Time to stream live video.
If you do not have Quick Time on your computer, please download Quick Time from Apple Inc's
website, and then launch your web browser.
30x
28x
28x
NOTE:
VIVOTEK
26 - User's Manual
► 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 83.
► 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.
VIVOTEK
User's Manual - 27
Using RTSP Players
To view the H.264 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
mpegable Player
pvPlayer
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 74.
For example:
4. The live video will be displayed in your player.
For more information on how to configure the RTSP access name, please refer to RTSP
Streaming on page 74 for details.
1. Launch the RTSP player.
2. Choose File > Open URL. An URL dialog box will pop up.
3. The address format is rtsp://<ip address>:<rtsp port>/<RTSP streaming access name for
stream1 or stream2>
rtsp://192.168.5.151:554/live.sdp
Video 16:38:01 2011/03/25
VIVOTEK
28 - User's Manual
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
13.
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 74.
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 62.
Video Mode MPEG-4
Frame size 176 x 144
Maximum frame rate 5 fps
Intra frame period 1S
Video quality (Constant bit rate) 40kbps
Audio type (GSM-AMR) 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 74.
4. Launch the player on the 3GPP-compatible mobile devices (ex. Real Player).
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 3>.
For example:
rtsp://192.168.5.151:554/live.sdp
VIVOTEK
User's Manual - 29
Using VIVOTEK Recording Software
The product software CD also contains 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.
VIVOTEK
30 - User's Manual
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, and Live Video
Window.
Live View Window
Host Name
VIVOTEK INC.
Logo
Camera Control
Area
Configuration
Area
Resize Buttons
Hide Button
Mouse and Screen Control
In addition to the use of a joystick, mouse control is also supported by the web session. You can click
on any spot on the screen to move camera's eld of view to that direction. To pan 360 degrees, you can
click and hold down the left mouse button when clicking a PTZ button. The same applies to arrow keys,
Zoom, and Focus buttons on the PTZ panel.
Note that if your screen control malfunctions, it is possible that the CPU of your current view station can
not cope with the HD video feeds or that an incompatibility issue occurred with the ActiveX control plug-
ins.
Zoom In
Zoom Out
Click and hold down
the button
Click to bring to
center of view
VIVOTEK
User's Manual - 31
Left
Down
Zoom Out
Focus Near
Start to Auto Patrol
Start to Auto Pan
Stop Auto Panning/patrolling/tracking
Return to Home Position
Right
Up
Zoom In
Focus Far
Auto Focus
Auto Tracking
VIVOTEK INC. Logo
Click this logo to visit the VIVOTEK website.
Host Name
The host name can be customized to t your needs. For more information, please refer to System on page 43.
Camera Control Area
Video Stream: This Network Camera supports multiple streams (stream 1 ~ 4) simultaneously. You can
select either one for live viewing. For more information about multiple streams, please refer to page 61
for detailed information.
Manual triggers: Manual triggers can be turned on/off by users from the main page. The manual triggers
can be associated with the Event settings, and, as the result, can be used to perform recording actions,
sending notications, and so on. See Event settings on page 101.
Digital Output: Click to turn the digital output device on or off.
PTZ Control Panel:
Pan: Click this button to start the auto pan (360° continuous rotation).
Stop: Click this button to stop the Auto Pan, Auto Patrol, and Auto Tracking functions.
Patrol: Once the Administrator has determined the list of preset positions (including the zoom-in action
on a particular position), click this button to command the camera to patrol among those positions on
the Patrol List. The Network Camera will patrol continuously. For more information, please refer to PTZ
control on page 96.
Track: Allows the camera to move along following the moving objects in the current eld of view. If you
observe an object of your interest, click this button to track the object. Note that this function does not
apply in an extremely crowded area, such as a market or sidewalk full of pedestrian activities. Constant
shift of tracked objects will decrease the usability of this feature.
Once started, you can use the Stop button to stop the current action. A click on the screen can also stop
the tracking action.
Another key concept is that the camera only detect movements within the current eld of view.
Please refer to PTZ > Auto tracking on page 99 and further for tracking conguration details.
VIVOTEK
32 - User's Manual
Pan /Tilt /Zoom /Focus speed: Adjust the speed of Pan/ Tilt/ Zoom/ Focus:
Note that mouse screen control is also supported. You can refer to page 96 for related information.
Conguration Area
Client Settings: Click this button to access the client setting page. For more information, please refer to
Client Settings on page 37.
Conguration: Click this button to access the conguration 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 Conguration on page 42.
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
繁體中文
. You can
also change a language on the Conguration page; please refer to page 42.
Hide Button
You can click the hide button to hide the control panel or display the control panel.
Pan speed Tilt speed Zoom speed Focus speed
-5 -5 -5 -5 Slower
Faster
-4 -4 -4 -4
-3 -3 -3 -3
-2 -2 -2 -2
-1 -1 -1 -1
0 0 0 0
1 1 1 1
2 2 2 2
3 3 3 3
4 4 4 4
5 5 5 5
VIVOTEK
User's Manual - 33
Resize Buttons
:
Click the Auto button, the video cell will resize automatically to t 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.
Go to
If you have preset PTZ positions, these positions will be available in the Go to menu. Please refer to
page 96 for more information.
Live Video Window
■ The following window is displayed when the video mode is set to H.264:
Video Title: The video title can be congured. For more information, please refer to Video settings on
page 53.
H.264 Protocol and Media Options: The transmission protocol and media options for H.264 video
streaming. For further conguration, please refer to Client Settings on page 37.
Time: Display the current time. For further configuration, please refer to Media > Image > General
settings on page 53.
Title and Time: The video title and time can be stamped on the streaming video. For further conguration,
please refer to Media > Image > General settings on page 53. The zoom ratio is also displayed with the
title bar.
Video and Audio Control Buttons: Depending on the Network Camera model and Network Camera
conguration, some buttons may not be available.
2.0x Title 2014/03/05 10:39:08
Video 17:08:56 2014/03/10
Title and Time
2014/03/10 17:08:56
Time
Video and Audio Control Buttons
Video (TPC-AV)
H.264/MPEG-4 Protocol and Media Options
Video Title
The camera also supports digital zoom. See page 97 for the digital zoom option.
VIVOTEK
34 - User's Manual
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 deselect the “Disable digital zoom” to enable the zoom operation. The
navigation screen indicates the part of the image being magnied. To control the zoom level, drag the
slider bar. To move to a different area you want to magnify, drag the navigation screen.
Pause: Pause the transmission of the streaming media. The button becomes the Resume button
after clicking the Pause button.
Stop: Stop the transmission of the streaming media. Click the Resume button to continue
transmission.
Start MP4 Recording: Click this button to record video clips in MP4 file format to your computer.
Press the
Stop MP4 Recording button to end recording. When you exit the web browser, video
recording stops accordingly. To specify the storage destination and le name, please refer to MP4 Saving
Options on page 38 for details.
Volume: When the Mute function is not activated, move the slider bar to adjust the volume on the
local computer.
Mute: Turn off the volume on the local computer. The button becomes the Audio On button after
clicking the Mute button.
Talk: Click this button to talk to people around the Network Camera. Audio will project from
the external speaker connected to the Network Camera. Click this button
again to end talking
transmission.
Mic Volume: When the Mute function is not activated, move the slider bar to adjust the
microphone volume on the local computer.
Mute: Turn off the Mic volume on the local computer. The button becomes the Mic On button
after clicking the Mute button.
Full Screen: Click this button to switch to full screen mode. Press the “Esc” key to switch back to normal
mode.
VIVOTEK
User's Manual - 35
■ The following window is displayed when the video mode is set to MJPEG:
Video Title: The video title can be congured. For more information, please refer to Media > Image on
page 53.
Time: Display the current time. For more information, please refer to Media > Image on page 53.
Title and Time: Video title and time can be stamped on the streaming video. For more information, please
refer to Media > Image on page 53
.
Video and Audio Control Buttons: Depending on the Network Camera model and Network Camera
conguration, 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 magnied. To control the zoom level, drag the slider bar. To
move to a different area you want to magnify, drag the navigation screen.
Start MP4 Recording: Click this button to record video clips in MP4 file format to your computer.
Press the
Stop MP4 Recording button to end recording. When you exit the web browser, video
recording stops accordingly. To specify the storage destination and le name, please refer to MP4 Saving
Options on page 38 for details.
Full Screen: Click this button to switch to full screen mode. Press the “Esc” key to switch back to normal
mode.
Video 17:08:56 2014/03/10
Title and Time
2014/03/10 17:08:56
Time
Video (HTTP-V)
Video Title
Video Control Buttons
VIVOTEK
36 - User's Manual
NOTE:
1. For a megapixel camera, it is recommended to use monitors of the 24" size or larger, and are capable
of 1600x1200 or better resolutions.
2. The video input is "muted" by default. To receive audio into from external microphone, you need to
enable the audio input from Media > Audio. Refer to page 64 for more information.
3. Below are the defaults for the Audio settings:
For cameras with a built-in microphone: Not Muted.
For cameras without a built-in microphone: Muted.
To receive audio input from an external microphone, you may need to enable the audio input from
Media > Audio. Refer to page 64 for more information.
Quick Time player only supports playback of H.264 stream, and not the MJPEG stream. In terms of au-
dio codec, Quick Time only supports AAC. Since this camera supports G.711 codec, audio is not avail-
able on Quick Time.
The VLC player supports H.264/MJPEG, and all audio codecs supported by VIVOTEK’s cameras.
NOTE:
VIVOTEK
User's Manual - 37
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
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
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 trafc 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 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 75.
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 specic ports for
streaming under some network environments. Users inside a firewall can utilize this protocol to allow
streaming data through.
H.264 Media Options
H.264 Protocol Options
VIVOTEK
38 - User's Manual
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 the button - Start MP4 Recording - on
the main page. Here, you can specify the storage destination and le name.
Folder: Specify a storage destination for the recorded video les.
File name prex: Enter the text that will be appended to the front of the video le name.
Add date and time sufx to the le name: Select this option to append the date and time to the end of the
le name of the recorded videos.
Local Streaming Buffer Time
In a busy network, fluctuations in available bandwidth can occur. Video streaming may lag and may
not proceed very smoothly. If you enable this option, video streams from the camera will be temporarily
stored on the computer’s cache memory for a configurable period of time (seconds or milliseconds)
before being played on a web session. This will help you see the streaming more smoothly. If you enter
3,000 Millisecond, the streaming will delay for 3 seconds.
CLIP_20110328-180853
Date and time suffix
The format is: YYYYMMDD_HHMMSS
File name prefix
VIVOTEK
User's Manual - 39
Joystick Settings
Enable Joystick
Connect to the USB plug of the joystick to a USB port on your management computer. Once a USB
joystick is connected, the related joystick conguration will be available on the Client settings window.
The joystick should work properly without installing any other driver or software.
Then you can begin to congure the joystick settings of connected devices. Please follow the instructions
below to enable joystick settings.
1. Click on the Congure buttons button. If your joystick is working properly, it will be displayed on the
drop-down list.
VIVOTEK
40 - User's Manual
Buttons Conguration
In the Joystick Settings window, you can use the combinations of pull-down menus, Actions and Button
number, to assign joystick buttons with different functions. The number of buttons may differ from the
joystick you attached.
Please follow the steps below to congure your joystick buttons:
1. Select the number of the button you want to congure from its pull-down list.
For example: Assign Preset 1 (move to preset 1 position) to Button 1.
2. Select an action from the Actions menu. Click Assign to associate the button with an action.
3. Your conguration will be automatically saved.
4.
To disable an assignment, select the number of a button, and then click the Delete button. The
associated action will then be cleared.
5. Repeat the above process to assign actions to other buttons.
When done, simply close the conguration
window.
VIVOTEK
User's Manual - 41
• If you want to assign Preset actions to your joystick, the PTZ preset locations should be congured 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.
NOTE:
• The joystick will appear in the Game Controllers list in the Windows Control panel. If you want to check
out for your devices, go to the following page: Start -> Control Panel -> Game Controllers.
• Follow the onscreen instructions to calibrate your joystick.
VIVOTEK
42 - User's Manual
Conguration
Click Configuration on the main page to enter the camera setting pages. Note that only
Administrators can access the configuration page. Please refer to page 83 Security > User
Account for how to congure access rights for different users.
Configuration List
Firmware Version
Navigation Area
Each function on the conguration list will be explained in the following sections.
Navigation Area provides an instant switch among Home page (the monitoring page for live viewing),
Conguration page, and multi-language selection.
VIVOTEK
User's Manual - 43
System > General settings
This section explains how to congure the basic settings for the Network Camera, such as the
host name and system time. It is composed of the following two columns: System and System
Time.
System
Host name: Enter a desired name for the Network Camera. The text will be displayed at the top of the
main page.
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 an established time server. Leaving the text box
blank connects the Network Camera to the default time servers. The precondition is that your camera
must have access to the Internet.
Update interval: Select to update the time using the NTP server on an hourly, daily, weekly, or monthly
basis.
Time zone : Select the appropriate time zone from the list. If you want to upload Daylight Savings Time
rules, please refer to System > Maintenance > Import/ Export les on page 50 for details.
When nished with the settings on this page, click Save at the bottom of the page to enable the settings.
VIVOTEK
44 - User's Manual
System > Homepage layout
This section explains how to set up your own customized homepage layout.
General settings
This column shows the settings of your hompage layout. You can manually select the background and
font colors in Theme Options (the second tab on this page). The settings will be displayed automatically
in this Preview eld. The following shows the homepage using the default settings:
■ Hide Powered by VIVOTEK: If you check this item, such wording will be removed from the homepage.
Logo graph
Here you can change the logo at the top of your homepage.
Follow the steps below to upload a new logo:
1. Click Custom and the Browse eld will appear.
2. Select a logo from your les.
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
Deselect the checkbox if you do not need the Manual trigger buttons on the main page.
VIVOTEK
User's Manual - 45
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 led. Click Save to enable the
settings.
Font Color of the
Video Title
Background Color of
the Video Area
Frame Color
Font Color
Background Color of the
Control Area
Font Color of the
Configuration Area
Background Color of the
Configuration Area
Preset patterns
VIVOTEK
46 - User's Manual
■ Follow the steps below to set up the customed homepage:
1. Click Custom on the left column.
2. A double-click on the color selection area (the right hand side column) will bring up a color palette
window.
3. The palette window will pop up as shown below.
4. Drag the slider bar and click on the left square to select a desired color.
5. The selected color will be displayed in the corresponding elds and in the Preview column.
6. Click Save to enable the settings.
Below are the options for system integrators or VARs. You can use the checkboxes to replace
VIVOTEK’s company logo, the embedded website address or the slogan “Powered by VIVOTEK.“ When
done, use the Save button to complete the conguration.
1
2
3
4
Color Selector
Custom
Pattern
VIVOTEK
User's Manual - 47
System > Logs
This section explains how to configure the Network Camera to send the system log to the
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 congure the Network Camera to send the system log le 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 the number of events reaches a preset limit.
VIVOTEK
48 - User's Manual
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 in an alphabetical order. If you
need technical assistance, please provide the information listed on this page.
VIVOTEK
User's Manual - 49
System > Maintenance
This chapter explains how to restore the Network Camera to factory default, reboot, upgrade
rmware version, etc.
General settings > Upgrade rmware
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 rmware:
1. Download the latest rmware le from the VIVOTEK website. The le is in .pkg le format.
2. Click Browse… and specify the rmware le.
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,
refresh the management session with the Network Camera.
The following message is displayed when the upgrade has succeeded.
The following message is displayed when you have selected an incorrect rmware le.
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 eld to resume the connection.
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
Reboot system now!!
This connection will close.
VIVOTEK
50 - User's Manual
General settings > Restore
This feature allows you to restore the Network Camera’s factory defaults.
Network: Select this option to retain the Network Type settings (please refer to Network Type on page
65).
Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to
Import/Export les 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 les
This feature allows you to Export / Update daylight saving time rules, custom language file, and
conguration le.
Export daylight saving time conguration le: Click to set the start and end time of DST.
Follow the steps below to export:
1. In the Export les column, click Export to export the daylight saving time conguration le from the
Network Camera.
2. A le download dialog will pop up as shown below. Click Open to review the XML le or click Save to
store the le for editing.
VIVOTEK
User's Manual - 51
3. Open and edit the le using Microsoft
®
Notepad and locate your time zone in the strings; set the start
and end time of DST. When completed, save the le.
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 rst Sunday in November.
Update daylight saving time rules: Click Browse… and specify the XML le to update.
If the incorrect date and time are assigned, you will see the following warning message when uploading
the le to the Network Camera.
VIVOTEK
52 - User's Manual
The following message is displayed when attempting to upload an incorrect le 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 le: Click Browse… and specify your own custom language le to upload.
Export conguration le: Click to export all parameters for the device and user-dened scripts.
Update conguration le: Click Browse… to update a conguration le. Please note that the model and
rmware version of the device should be identical to those specied for the conguration le. If you have
set up a xed IP or other special settings for your device, it is not suggested to update a conguration
le.
Export server status report: Click to export the current server status report, such as time, logs,
parameters, process status, memory status, le 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 rmware 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 rmware:
(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 this
process is completed, the LED status should return to normal.
VIVOTEK
User's Manual - 53
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 videos_and_snapshots: Enter a name that will be displayed on the
title bar of the live video as the picture shown below.
Video Title
Title and Time
Video 17:08:56 2014/03/09
2014/03/09 17:08:56
Position of timestamp and video title on image: Select to display time stamp and video title on the top or
at the bottom of the video stream.
Timestamp and video title font size: Select the font size for the time stamp and title.
Color: Select to display color or black/white video streams.
Power line frequency: Set the power line frequency consistent with local utility settings to eliminate image
flickering associated with fluorescent lights. Note that after the power line frequency is changed, you
must disconnect and reconnect the power cord of the Network Camera in order for the new setting to
take effect.
Video orientation: Flip - vertically reflect the display of the live video; Mirror - horizontally reflect the
display of the live video. Change the settings if the Network Camera is installed in a different orientation
(which is rare for a speed dome) to correct the image orientation.
Day/Night settings: This is a hyperlink to the Exposure > Day/Night setting page.
VIVOTEK
54 - User's Manual
Image settings
On this page, you can tune the White balance and Image adjustment settings.
White balance: Adjust the value for the best color temperature.
■ Select one of the white balance modes:
■ Auto (system default): This mode lets rmware automatically nd the optimal balance.
■ Fix current value: This option is available when the Wide lighting range is selected. When selected, the
camera will use the current color temperature setting. Note that you should use the Save button below
to preserve current conguration. Otherwise, the white balance mode will return to Auto after you leave
the conguration page.
■ Manual: In the manual mode, you can manually tune the R gain and Blue gain values by dragging the
slide bars. Index numbers will be shown on the right hand side while changes in image is immediately
displayed.
Image Adjustment
■ Brightness: Adjust the image brightness level, which ranges from -5 to +5.
■ Contrast: Adjust the image contrast level, which ranges from -5 to +5.
■ 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% to 100%
.
You may let rmware 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.
Sensor Setting 1:
For normal situations
VIVOTEK
User's Manual - 55
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 Prole
to adjust all settings above in a pop-up window for special lighting conditions during a specic period of
time in a day.
Enable 3D Noise reduction
■ Check to enable noise reduction in order to reduce noises and ickers in image. This applies to the
onboard 3D Noise Reduction feature. Use the pull-down menu to adjust the reduction strength. Note
that applying this function to the video channel will consume system computing power.
3D Noise Reduction is mostly applied in low-light conditions. When enabled in a low-light condition
with fast moving objects, trails of after-images may occur. You may then select a lower strength level
or disable the function.
Sensor Setting 2:
For customized situations such as
night mode.
VIVOTEK
56 - User's Manual
- Fixed: In the xed mode, you can manually congure the Maximum Exposure Time (1/3,2000 to 1/5
sec.) and Maximum Gain Control (0% to 100%).
Exposure control:
■
Exposure level: You can manually set the Exposure level, which ranges from -2.0 to +2.0 (dark
to bright). You can also select other values from the Exposure mode menus and select a preferred
scenario or manually congure the associated settings. 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 Fixed mode according to your needs.
- Auto: System default, which automatically adjusts the iris, shutter speed, and gain for an optimmal
exposure level.
Exposure
On this page, you can configure the Exposure level, Max gain, and Exposure mode related settings.
Detailed congurations will be automatically adjusted since the sensor library will automatically adjust the
value according to the ambient light.
Sensor Setting 1:
For normal situations
Sensor Setting 2:
For special situations
■ 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.
VIVOTEK
User's Manual - 57
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 lter
With a removable IR-cut lter, this Network Camera can automatically remove the lter to allow IR light to
reach the sensor during low light conditions.
■ Auto mode
The Network Camera automatically removes the lter by judging the level of ambient light.
■ Day mode
In day mode, the Network Camera switches on the IR cut lter 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 lter at all times for the sensor to accept
infrared light, thus helping to improve low light sensitivity.
■ Synchronize with digital input
The Network Camera automatically removes the IR cut lter when a Digital Input is triggerred.
■ Schedule mode
The Network Camera switches between day mode and night mode based on a specied 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.
Sensitivity of IR cut lter
Select Low, Normal, or High sensitivity for the light sensor.
IMPORTANT:
1. When set to the Night mode, the image display automatically changes to Black and White.
2. There is no Preview button in the Exposure window. Conguration changes are directly reected in the
live view window.
VIVOTEK
58 - User's Manual
Please follow the steps below to set up a prole:
1. Check Enable and apply this prole to.
2. Select the applicable mode: Day mode, Night mode,
or Schedule mode. Please manually enter a range of
time if you choose Schedule mode.
When a span of time is congured using the Schedule
mode, you can configure the Day/Night setting for
controlling the behavior of the IR cut lter during that
time.
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 window.
Exposure Prole:
If you want to congure another sensor and exposure setting for a different lighting condition, e.g., low
light condition during the night, 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 the Schedule mode. Then click Save for the
conguration to take effect.
VIVOTEK
User's Manual - 59
Privacy mask
Click Privacy Mask to open the settings page. On this page, you can block out sensitive view areas to
address privacy concerns.
■ To set the privacy mask windows, follow the steps below:
1. Click on the Enable privacy mask checkbox to enable this function.
2. Use mouse clicks on the screen to move to a place where you want to create a mask. You can also
use the PTZ panel to ne-tune the move to the target area.
3. Enter a name for the masking window. Click Add to create a new window.
4. Click on the Modify button and then use the mouse cursor to re-size the masking window, which is
recommended to be at least twice the size of the object (height and width) you want to cover. You can
select the Drawing mode as "Fixed in center" or "Drag to move."
• When using the Fixed in center mode, you can move to the area of your interest, and then
manually change the size and shape of the masking window.
• When using the Drag to move mode, you can move to an area of your interest using the PTZ
buttons above, and then click and drag to draw a masking window. The click to move maneuver
is not available when you select the Drag to move mode.
5. You can also change the color of the mask from the Color menu.
6. If preferred, move the eld of view to other places to create more privacy masks.
You may be prompted by the message when trying to create a privacy mask at angles between +70°
and -70°.
NOTE:
1. The navigation buttons here
also support the continuous
move. You can click and hold
down the button to move
across the screen until you
release the button.
2. You can not create privacy
masks at angles between
+70° and -70°.
90°
+70°
-70°
0°0°
VIVOTEK
60 - User's Manual
NOTE:
• The camera supports "3D Privacy Mask." Privacy masks should stay at the same positions
regardless of how the camera lens may move.
• When the "Enabled privacy mask" checkbox is deselected, no privacy masks will appear on screen.
• Up to 24 privacy mask windows can be congured over the camera's hemispheric coverage.
• If you want to delete a privacy mask window, select its name from the pull-down menu at the bottom,
and then click Delete to remove it.
Privacy mask
Current field of view
Privacy mask
VIVOTEK
User's Manual - 61
Media > Video
Stream settings
This Network Camera supports multiple streams with frame sizes ranging from 176 x 144 to 1920 x 1080
pixels.
The denition of multiple streams:
■ Stream 1: Users can dene the Frame sizes, compression format, image quality, etc.
■ Stream 2: The default frame size for stream 2 is congured to 1280 x 720.
■ Stream 3: The default frame size for Stream 3 is set to the minimized 640 x 360 for viewing on mobile
devices.
■ Stream 4: The default frame size for stream 4 is congured to 1920 x 1080 in the H.264 mode.
VIVOTEK
62 - User's Manual
Click the stream item to display the detailed information. .
This Network Camera provides real-time H.264 and MJPEG compression standards (Multiple 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:
►
Video quality and fixed quality refers to the compression rate, so a lower value will produce higher
quality.
►
Converting high-quality video may significantly increase the CPU loading, and you may encounter
streaming disconnection or video loss while capturing a complicated scene. In the event of occurance,
we suggest you customize a lower video resolution or reduce the frame rate to obtain smooth video.
NOTE:
VIVOTEK
User's Manual - 63
■ Frame size
You can set up different video resolution for different viewing devices. For example, set a smaller
frame size and lower bit rate for remote viewing on mobile phones and a larger video size and a higher
bit rate for live viewing on web browsers. Note that a larger frame size takes up more bandwidth.
■ Maximum frame rate
This limits the maximum refresh frame rate per second. Set the frame rate higher for smoother video
quality and for recognizing moving objects in the eld 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.
■ Intra frame period
Determine how often for rmware to plant an I frame. The shorter the duration, the more likely you
will get better video quality, but at the cost of higher network bandwidth consumption. Select the intra
frame period from the following durations: 1/4 second, 1/2 second, 1 second, 2 seconds, 3 seconds,
and 4 seconds.
■
Video quality
Constant bit rate:
• Constant bit rate: A complex scene generally produces a larger file size, meaning that
higher bandwidth will be needed for data transmission. The bandwidth utilization is
configurable to match a selected level, resulting in mutable video quality performance.
The bit rates are selectable at the following rates:
20Kbps, 30Kbps, 40Kbps, 50Kbps, 64Kbps,
128Kbps, 256Kbps, 512Kbps, 768Kbps, 1Mbps, 2Mbps, 3Mbps, 4Mbps, 6Mbps, 8Mbps, 10Mbps,
12Mbps, 14Mbps, and 16Mbps
. You can also select Customize and manually enter a value.
- Target bit rate: Select a bit rate from the pull-down menu. The bit rate ranges from
20kbps to a maximum of 16Mbps. 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 sometimes be compromised.
If
Image quality priority is selected, the Network Camera may drop some video frames in
order to maintain the image quality of individual frames.
• 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 xed image quality, you can still impose an upper threshold
on the maximum bit rate as a ceiling value. For example, in low light conditions where
a Fixed quality setting is applied, video packet sizes can tremendously increase when
noises are produced with electrical gains.
VIVOTEK
64 - User's Manual
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 as AAC, G.711, or G.726, and the sampling 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.
The network camera does not come with embedded microphone. An external microphone will be
necessary especially if you prefer the Audio Detection feature. By default, the Audio setting is muted,
and you need to manually uncheck the Mute option.
IMPORTANT:
VIVOTEK
User's Manual - 65
Network > General settings
This section explains how to congure 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 xed 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 16 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.
VIVOTEK
66 - User's Manual
Primary DNS: The primary domain name server that translates host names into IP addresses.
Secondary DNS: Secondary domain name server that backs up the Primary DNS.
Primary WINS server: The primary WINS server that maintains the database of computer names and IP
addresses.
Secondary WINS server: The secondary WINS server that maintains the database of computer names
and IP addresses.
Enable UPnP presentation: Select this option to enable UPnP
TM
presentation for your Network Camera
so that whenever a Network Camera is presented to the LAN, 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, UPnP
TM
is supported by Windows XP or later. Note that to utilize this feature, please make
sure the UPnP
TM
component is installed on your computer.
Enable UPnP port forwarding: To access the Network Camera from the Internet, select this option to
allow the Network Camera to open ports automatically on the router so that video streams can be sent
out from a LAN. To utilize of this feature, make sure that your router supports UPnP
TM
and it is activated.
PPPoE (Point-to-point over Ethernet)
Select this option to congure 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 Conguration > Event > Event settings > Add server (please refer to Add server on page 110) to
add a new email or FTP server.
3. Go to Conguration > Event > Event settings > Add media (please refer to Add media on page 101).
Select System log so that you will receive the system log in TXT le format which contains the
Network Camera’s public IP address in your email or on the FTP server.
4. Go to Conguration > 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.
Mega-pixel Network Camera (192.168.5.151)
VIVOTEK
User's Manual - 67
► 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.
NOTE:
VIVOTEK
68 - User's Manual
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 conguration and dynamic discovery of devices
added to a network. Services and capabilities offered by networked devices, such as printing and le
sharing, are available among each other without the need for cumbersome network conguration. 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 In LAN
http://203.67.124.123:8080 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 50 for details. After the Network
Camera is reset to factory default, it will be accessible on the LAN.
VIVOTEK
User's Manual - 69
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:
Link-global IPv6 address/network mask
Link-local IPv6 address/network mask
Refers to Ethernet
VIVOTEK
70 - User's Manual
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:
4. Press Enter on the keyboard or click Refresh button to refresh the webpage.
For example:
► 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 73 for detailed information.)
► If you choose PPPoE as the Network Type, the [
PPP0 address] will be displayed in the IPv6
information column as shown below.
Manually setup the IP address: Select this option to manually set up IPv6 settings if your network
environment does not have a DHCPv6 server and router advertisements-enabled routers.
If you select this item, the following blanks will be displayed for you to enter the corresponding
information:
http://[2001:0c08:2500:0002:0202:d1ff:fe04:65f4]/
IPv6 address
http://[2001:0c08:2500:0002:0202:d1ff:fe04:65f4]/:8080
IPv6 address
Secondary HTTP port
NOTE:
VIVOTEK
User's Manual - 71
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 37 and Stream settings on page 62.
Audio transmitted from operators
Audio transmitted to operators
America
Taiwan
VIVOTEK
72 - User's Manual
2014/06/09 17:08:56
Audio is being transmitted to the Network Camera
Mute
Mic Volume
Talk Button
Click to enable audio transmission to the Network Camera; click to adjust the volume of
microphone; click
to turn off the audio. To stop talking, click again.
FTP port: The FTP server allows the user to save recorded video clips. You can utilize VIVOTEK's
Installation Wizard 2 to upgrade the rmware 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.
VIVOTEK
User's Manual - 73
Network > Streaming protocols
HTTP streaming
To utilize HTTP authentication, make sure that your have set a password for the Network Camera rst;
please refer to Security > User account on page 83 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.
Access name for stream 1 ~ 5: 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.
On the LAN
http://192.168.4.160 or
http://192.168.4.160:8080
VIVOTEK
74 - User's Manual
URL command -- http://<ip address>:<http port>/<access name for stream 1, 2, 3, 4, or 5>
For example, when the Access name for stream 2 is set to video2.mjpg:
1. Launch the Mozilla Firefox browser.
2. Type the above URL command in the address bar. Press Enter.
3. The JPEG images will be displayed in your web browser.
► Microsoft
®
Internet Explorer does not support server push technology; therefore, using http://<ip
address>:<http port>/<access name for stream 1, 2, 3, 4, or 5>
will not work.
RTSP Streaming
To utilize RTSP streaming authentication, make sure that you have set a password for controlling the
access to video stream rst. Please refer to Security > User account on page 83 for details.
NOTE:
VIVOTEK
User's Manual - 75
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:
Access name for stream 1 ~ 5: 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 5>
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.
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 trafc 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:
rtsp://192.168.5.151:554/live.sdp
Quick Time player VLC
Disable O O
Basic O O
Digest O X
Video 16:38:01 2012/01/25
VIVOTEK
76 - User's Manual
Multicast settings for stream 1, 2, 3, and 4: Click the items to display the detailed configuration
information. Select the Always multicast option to enable multicast for video streams.
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 Scope
0 Restricted to the same host
1 Restricted to the same subnetwork
32 Restricted to the same site
64 Restricted to the same region
128 Restricted to the same continent
255 Unrestricted in scope
IMPORTANT:
The Multicast metadata port is utilized by VIVOTEK VADP modules to transfer video analytics results,
PTZ stream, textual data, and event messages between the camera and the client side running and
observing the video analysis. If your client side computer is located outside the local network, you may
need to open the associated TCP port on routers and rewall.
VIVOTEK
User's Manual - 77
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 xed 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 congure 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://vivotek_test3454.2bthere.net
VIVOTEK
78 - User's Manual
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),
CustomSafe100, dyn-interfree.it.
Note that before utilizing this function, please apply for a dynamic domain account rst.
■ 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, ll in the Host name (xxxx.safe100.net), Email, Key, and Conrm Key, and
click Register. After a host name has been successfully created, a success message will be displayed
in the DDNS Registration Result column.
3. Click Copy and all the registered information will automatically be uploaded to the corresponding elds
in the DDNS column at the top of the page as seen in the picture.
[Register] Successfully Your account information has
been mailed to registered e-mail address
VIVOTEK
User's Manual - 79
[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, ll in the Host name, Server name, Email, Key, and Conrm Key; then click
Register. After a host name has been successfully created, you will see a success message in the
DDNS Registration Result column. Enter
ns1.safe100.net as the Server name.
3. Click Copy and all for the registered information will be uploaded to the corresponding elds 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/
VIVOTEK
80 - User's Manual
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 insufcient, especially for real-time streaming multimedia applications. Quality can be dened as, for
instance, a maintained level of bit rate, low latency, no packet dropping, etc.
The following are the main benets of a QoS-aware network:
■
The ability to prioritize trafc and guarantee a certain level of performance to the data ow.
■
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 via a web console with 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 rst.
► 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" trafc control and QoS as
"nely-grained" trafc 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.
NOTE:
VIVOTEK
User's Manual - 81
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 eld 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).
VIVOTEK
82 - User's Manual
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 nd, solve network problems with ease.
■ The SNMP consists of the following three key components:
1. Manager: Network-management station (NMS), a server which executes applications that monitor and
control managed devices.
2. Agent: A network-management software module on a managed device which transfers the status of
managed devices to the NMS.
3. Managed device: A network node on a managed network. For example: routers, switches, bridges,
hubs, computer hosts, printers, IP telephones, network cameras, web server, and database.
Before conguring SNMP settings on the this page, please enable your NMS rst.
SNMP Conguration
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).
VIVOTEK
User's Manual - 83
Security > User Account
This section explains how to enable password protection and create multiple accounts.
Root Password
The administrator account name is “root”, which is permanent and can not be deleted. If you want to add
more accounts in the Manage User column, please apply the password for the “root” account rst.
1. Type the password identically in both text boxes, then click Save to enable password protection.
2. A window will prompt for authentication; type the correct user’s name and password in their respective
elds to access the Network Camera.
Privilege management
Digital Output & PTZ control: You can modify the manage privileges of 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 Conguration on page 42).
Allow anonymous viewing: If this checkbox is selected, any client can access the live stream without
entering a User ID and Password.
Account management
Administrators can add 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 Conguration page. Although operators cannot access the Conguration page, they can use
the URL Commands to get and set the camera parameters. For more information, please refer to URL
Commands of the Network Camera at the Appendix of this manual on page 132. Viewers access only 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.
VIVOTEK
84 - User's Manual
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 Certicate Method
Before using HTTPS for communication with the Network Camera, a Certicate must be created rst.
There are three ways to create and install a certicate:
Create self-signed certificate
1. Select this option from a pull-down menu.
2. In the rst column, select Enable HTTPS secure connection, then select a connection option: “HTTP
& HTTPS” or “HTTPS only”.
3. Click Create certicate to generate a certicate.
4. The Certicate Information will automatically be displayed as shown below. You can click Certicate
properties to view detailed information about the certicate.
VIVOTEK
User's Manual - 85
5. Click Save to preserve your conguration, 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 re-
turn to the main page. Change the URL address from “
http://” to “https://“ in the address bar and press
Enter on your keyboard. Some Security Alert dialogs will pop up. Click OK or Yes to enable HTTPS.
https://192.168.5.151/index.html
https://
VIVOTEK
86 - User's Manual
Create certificate request and install
1. Select the option from the Method pull-down menu.
2. Click Create certicate to proceed.
3. The following information will show up in a pop-up window after clicking Create. Then click Save to
generate the certicate request.
4. The Certicate 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.
VIVOTEK
User's Manual - 87
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 certicate should be delivered to you via an email or other means. Copy
the contents of the certicate in the email and paste it in a text/HTML/hex editor/converter, such as
IDM Computer Solutions’ UltraEdit.
VIVOTEK
88 - User's Manual
7. Open a new edit, paste the certicate contents, and press ENTER at the end of the contents to add an
empty line.
8. Convert le format from DOS to UNIX. Open File menu > Conversions > DOS to Unix.
VIVOTEK
User's Manual - 89
9. Save the edit using the “.crt” extension, using a le name like “CAcert.crt.”
10. Return to the original rmware session, use the Browse button to locate the crt certicate le, and
click Upload to enable the certication.
VIVOTEK
90 - User's Manual
11. When the certifice file is successfully loaded, its status will be stated as Active.
Note that a
certicate must have been created and installed before you can click on the “Save" button for
the conguration to take effect.
12.To begin an encrypted HTTPS session, click Home to return to the main page. Change the URL ad-
dress 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.
VIVOTEK
User's Manual - 91
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 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).
Connection management: Click this button to display the connection status window showing a list of the
current connections. For example:
■ IP address: Current connections to the Network Camera.
■ Elapsed time: How long the client has been at the live view webpage (note that only clients currently at
the live view window will be listed here).
■ 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 make a connection without a user name and password, the User ID
column will be empty.
There are some situations which 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 83.
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 74.
3. The administrator has set up a root password, but allows anonymous viewing. For more information
about Allow Anonymous Viewing, please refer to page 83.
■ 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 their access. Please note that those checked connections will only be disconnected temporarily
and they will automatically retry a connection (IE Explorer or Quick Time Player). If you want to enable
the denied list, please check Enable access list ltering and click Save in the rst column.
192.168.3.25
61.22.15.3
192.168.1.147
IP address
45:00:34
00:10:09
12:20:34
Elapsed time
greg
anonymous
root
User ID
Add to Deny List DisconnectRefresh
VIVOTEK
92 - User's Manual
■ 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 they will
automatically retry a connection (IE Explore or Quick Time Player).
Enable access list ltering: Check this item and click Save if you want to enable the access list ltering
function.
Filter
Filter type: Select Allow or Deny as the lter type. If you choose Allow Type, only those clients whose
IP addresses are on the Access List below can access the Network Camera, and exclude the access
from those that are not on the list. 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, while those that are not on the
list 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 > Enable IPv6 on page 69 for detailed information.
There are three types of rules:
Single: This rule allows the user to add an IP address to the Allowed/Denied list.
For example:
VIVOTEK
User's Manual - 93
Network: This rule allows the user to assign a network address and corresponding subnet mask to the
Allow/Deny List in the CIDR format, e.g. 192.168.xx.xx/24.
For example:
Range: This rule allows the user to assign a range of IP addresses to the Allow/Deny List.
Note: This rule is only applicable 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 eld to make sure the Administrator can always connect to the device.
IP address 192.168.2.x will be blocked.
VIVOTEK
94 - User's Manual
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 have their 802.1x settings enabled.
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 certicates
between client and server are veried, 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:
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 certicate and decides whether to
accept the end user’s access request.
■
VIVOTEK Network Cameras support two types of EAP methods to perform authentication: EAP-PEAP
and EAP-TLS.
Please follow the steps below to enable 802.1x settings:
1. Before connecting the Network Camera to the protected network with 802.1x, please apply a digital
certificate from a Certificate Authority (i.e., network administrator of your company) 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
conguration 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 certicate(s).
Supplicant
(Network Camera)
Authenticator
(Network Switch)
Authentication Server
(RADIUS Server)
VIVOTEK
User's Manual - 95
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.
► Below is the authentication process for 802.1x:
1. The Certicate Authority (CA) provides the required signed certicates 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 certicate, 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 certicate 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-congured port.
VIVOTEK
Network Camera
RADIUS Server
Certificate Authority
(CA)
Protected LAN
Certificate
1
1
2
3
4
Network Switch
Certificate
NOTE:
VIVOTEK
96 - User's Manual
PTZ > PTZ settings
This section explains how to control the Network Camera’s Pan/Tilt/Zoom operation.
The camera comes with built-in PTZ mechanisms.
Preset positions and patrol settings
In the PTZ settings page, you can select preset positions for the camera to patrol. A total of 256 preset
positions can be congured. 40 of them can be used in a patrolling tour.
Please follow the steps below to congure preset positions and arrange them in a pan/tilt/zoom tour:
1. Adjust the shooting area to the desired position using the keypad on the upper right side of the
window. The default Home position refers to the center position defaulted in the factory. You might as
well select another area of interest as the “Home“ position. You should also select the speeds for the
actions that occur during the patrol; i.e., pan, tilt, zoom, focus, and the auto pan/patrol.
2. Enter a name for a new preset position, which can contain up to forty characters. Click Add to enable
the settings. The preset positions will be listed on the User preset locations. (To add positions you
wish, please repeat steps 1~2.)
3. Select the preset positions and click on the Save button at the bottom of the screen.
4. Click on the move button (>>)
to move positions to the Patrol locations window.
5. You may select some or all of the imported positions as the stop points during the tour.
6. Enter a preferred dwell time before the camera lens moves to the next position.
7. Select a speed level for the auto patrol tour.
8. Click on the Save button to preserve your conguration.
To remove a preset position from the list, select it and click Remove.
You can re-arrange the patrol order of the positions on the list using the
buttons.
1
1
2
3
4
5
6
7
8
NOTE:
The navigation buttons here also
support the continuous move. You
can click and hold down the button
to move across the screen until you
release the button.
VIVOTEK
User's Manual - 97
Misc. settings: Use the checkboxes and the pull-down menus for the camera to automatically resume the
previous action or return to the home position after the camera has stayed idle for a period of time.
PTZ control panel operation mode: This determines how your mouse and PTZ control panel works on a
live view window.
The Continuous move allows your screen control action to continue as long as you click and hold down
the left mouse button. For example, if you click on the left button on the PTZ control panel, the camera's
view should continuously rotate to the left until you release the button. The same applies to arrow keys,
Zoom, and Focus buttons on the PTZ panel. If you select Click to move, every single mouse click takes
effect for once without the ensuing move.
Note that if your screen control malfunctions, it is possible that the CPU of your current view station can
not cope with the HD video feeds or that an incompatibility issue occurred with the ActiveX control plug-
ins.
If you select the Enable digital zoom checkbox, you will be able to zoom in on an image by up to 216X
magnication with the combination of the 18x mechanical zoom and another 12X digital zoom.
The Enable Zoom enhancement option takes effect only when a camera is showing a live stream of a
smaller frame size, e.g., 640 x 360, than the maximum frame size. This option is enabled by default. This
allows a slightly more zoom in ratio than the original mechanical zoom.
Zoom In
Zoom Out
Click and hold down
the button
Click to bring to
center of view
VIVOTEK
98 - User's Manual
Positions on the Home page
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 position.
Pan button: Click this button to start the 360° horizontal auto pan.
Patrol button: Click this button, then the Network Camera will patrol continuously among the selected
positions.
PTZ > Calibrate
This function re-calibrates the home position to the default center to recover any displacement caused by
external forces. Please note that there is no conrm message after using the function, and the calibration
immediately takes place. If, after a long use, a user nds it is difcult to move camera’s eld of view to a
specic point, use this function to restore the camera’s orginal coordinates in pan and tilt motions.
Pan button
Patrol button
The Zoom factor display: This option is enabled by default, and zoom ratio is displayed along with the
video title on the upper left corner of a view cell.
Apply previous action if the camera idles for __(1~999) seconds: You can assign an action to be
taken when the camera sits idle for a congurable period time. For example, you can let camera resume
a patrol tour. The resumed patrol will continue from the last preset position. You may also let the camera
return to the home position. The idle state does not include the situations when the camera is performing
pan or patrol action.
Return to home position: When no activities occur after a congurable period of time, let the camera’s
lens return to the default home position.
VIVOTEK
User's Manual - 99
Auto tracking
In this window, you can modify the minimum object size as the triggering factor while performing the
Auto Tracking function. You can move the camera view to an area of your interest, estimate, and dene
the possible size of objects. For example, you can designate the object size such as that of a human
trespasser. The silhouette of the tresspasser must be larger than the whole of the object size square box.
The minimum object size is 30x30 pixels within a 320x420 view window.
Use the slide bar to tune the sensitivity of the tracking function.
2014/3/2 15:28:44
This function stops when the user clicks on any buttons on the PTZ panel, or a mouse click takes place
on a view window.
Users can choose to perform other functions, such as pan or patrol, simply by clicking their buttons on
the PTZ panel while the camera is performing the auto tracking function.
SD8161-VVTK(TCP-V)
Tracking.. 1.0X SD8161-VVTK 2014/06/17
When Auto Tracking is taking place, a “Tracking” message is displayed on the message bar.
VIVOTEK
100 - User's Manual
NOTE:
The conditions for using this function are listed below:
1. The speed dome can track one object at a time.
2. If multiple objects are present in the FOV, the camera tracks the object that is farthest from the
camera.
3. If a tracked object stays motionless for 10 seconds, camera will abandon it and start tracking another
object that is farthest away from the center.
4. The zoom-in ratio while tracking is determined by the zoom ratio of the camera lens when the tracking
is triggered.
5. Manual control always has a higher priority than Auto tracking, such as using a joystick to pan or tilt or
using a click on VAST view cell.
6. Objects can easily move away from an FOV when the zoom-in ratio is high. Therefore, it is
recommended not to zoom in too much on where the Auto tracking is expected to take place.
Auto tracking is congured by designating the minimum object size. Moving objects larger than the min.
size that entered the current region of view will trigger the tracking action.
Auto tracking, if applied, is designed to track an intruder in a place where human trafc is not heavy, such
as a warehouse or a load area. Heavy trafc can result in a constant shift of tracked objects, and reduce
the effectiveness of the feature.
VIVOTEK
User's Manual - 101
Event > Event settings
This section explains how to congure 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 will be performed.
Event
An event is an action initiated by a user-dened trigger source. In the Event column, click Add to open
the event settings window.
VIVOTEK
102 - User's Manual
■ 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 rst.
■ Detect next motion detection or digital input after
seconds: Enter the duration in seconds to
pause motion detection after a motion is detected.This avoids event messages to be too frequently
generated.
Follow the steps 1~3 to arrange the three elements -- Schedule, Trigger, and Action to configure an
action to take when an event is triggered. You can congure 3 event-triggered conditions.
1. Schedule
Specify the time span for the event-triggering condition. Please select the days of the week and the time
in a day (in 24-hr time format) for the recording schedule.
2. Trigger
This is the cause or stimulus which denes when to trigger the Network Camera. The trigger source can
be congured 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 conguration 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 congure a Motion Detection Window rst. For more information, please refer to
Motion Detection on page 116 for details.
■ Periodically
This option allows the Network Camera to trigger periodically for every other dened 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 and
reconnected.
■ Recording notify
This option allows the Network Camera to trigger when the recording disk is full or when recording
starts to rewrite older data.
VIVOTEK
User's Manual - 103
■ Audio detection
A preset threshold can be congured 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. Please refer to page 119 Applications > Audio detection for more details.
Once you have a preset audio alarm level, you can dene the triggering condition either as an audio
input rises above or falls below the alarm level.
■ Manual triggers
An event can be manually triggered by the manual trigger buttons on the main page.
■ VADP
It is presumed that you already uploaded and enabled the VADP modules before you can associatee
VADP triggers with an Event setting.
Click on the Set VADP Trigger button to open the VADP setup menu. The triggering conditions
available with 3rd-party software modules known as VADP will be listed. Use the arrow buttons to
select these triggers. Users may implant these modules for different purposes such as triggering
motion detection, or applications related to video analysis, etc. Please refer to page 122 for the
conguration options with VADP modules.
VIVOTEK
104 - User's Manual
3. Action
Dene 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 le on SD card if the network is disconnected. Please note that this
function will only be displayed after you set up a networked storage (NAS). For more information about
how to set up network storage, please refer to page 126.
■ Move to preset location
Select a preset location you’ve configured. Note that please configure Preset locations first. For
detailed information, please refer to page 97. Another checkbox will appear, Capture media after
moving to the location. You can select to record associated snapshot, video clip or system event
once the event is triggered and the camera moves to the preset location. See Add Media in the
following discussion.
To configure an event with recorded video or snapshots, it is necessary to configure the server and
media settings so that the Network Camera will know what action to take (such as which server to send
the media les to) when a trigger is activated.
VIVOTEK
User's Manual - 105
NOTE:
Motion detection
window
Current field of view
If you congured a motion detection window as a trigger, the motion detection may become invalid when
the camera’s eld of view moved away from the detection window.
You can let camera return to the motion detection position to detect the coming event by re-conguring
your Home position in PTZ > PTZ settings (see page 96) or turn the camera to a preset position.
VIVOTEK
106 - User's Manual
Add server
Click Add server to unfold the server setting window. You can specify where the notication messages
are sent when a trigger is activated. A total of 5 server settings can be congured.
There are four choices of server types available: Email, FTP, HTTP, and Network storage.
Select the item
to display the detailed conguration options. You can congure either one or all of them.
Server type - Email
Select to send the media les 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).
VIVOTEK
User's Manual - 107
To verify if the email settings are correctly congured, 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, then click Close to exit the Add server page.
After you set up the first event server, a new item for event server will automatically show up on the
Server list. If you wish to add more server options, click Add server.
Server type - FTP
Select to send the media les 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 le will be placed. If the folder name does not exist, the Network
Camera will create one on the FTP server.
VIVOTEK
108 - User's Manual
■ 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 rewall.
To verify if the FTP settings are correctly congured, click Test. The result will be shown in a pop-up
window as shown below. If successful, you will also receive a test.txt le on the FTP server.
Click Save server to enable the settings, then click Close to exit the Add server page.
Server type - HTTP
Select to send the media les 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 congured, click Test. The result will be shown in a pop-up
window as below. If successful, you will receive a test.txt le on the HTTP server.
Click Save server to enable the settings and click Close to exit the Add server page.
VIVOTEK
User's Manual - 109
Network storage:
Select to send the media les to a network storage location when a trigger is activated. Please refer to
NAS server on page 126 for details.
Click Save server to enable the settings, then click Close to exit the Add server page.
■ 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 129
for detailed information.
VIVOTEK
110 - User's Manual
Add media
Click
Add media
to open the media setting window. You can specify the type of media that will be sent
and preserved when a trigger is activated. A total of 5 media settings can be congured. There are three
choices of media types available: Snapshot, Video Clip, and System log.
Select the item to display the
detailed conguration options. You can congure 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 stream 1 ~ 4. (The following options are available when the
check circle is selected.
■ Send
pre-event images
The Network Camera has a buffer area; it temporarily holds data up to a certain limit. Enter a number
to decide how many images to capture before a trigger is activated. Up to 7 images can be generated.
■ Send
post-event images
Enter a number to decide how many images to capture after a trigger is activated. Up to 7 images can
be generated.
For example, if both the Send pre-event images and Send post-event images are set to 7, a total of 15
images are generated after a trigger is activated.
■ File name prex
Enter the text that will be appended to the front of the le name.
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
VIVOTEK
User's Manual - 111
■ Add date and time sufx to the le name
Select this option to add a date/time sufx to the le name.
For example:
Click Save media to enable the settings, then click Close to exit the Add media page.
After you set up the rst media server, a drop-down menu of existing medias will be available on the
Media list. If you wish to add more media options, click Add media again.
Media type -
Video clip
Select to send video clips when a trigger is activated.
■ Media name: Enter a name for the media setting.
■ Source: Select the source of video clip.
■ Pre-event recording
The Network Camera has a buffer area; it temporarily holds data up to a certain limit. Enter a number
to decide the duration of recording before a trigger is activated. Up to 9 seconds can be set.
Snapshot_20110320_100341
Date and time suffix
The format is: YYYYMMDD_HHMMSS
File name prefix
VIVOTEK
112 - User's Manual
■ Maximum duration
Specify the maximum recording duration in seconds. Up to 20 seconds can be set.
For example, if pre-event recording is set to 5 seconds and the maximum duration is set to 10
seconds, the Network Camera continues to record for another 4 seconds after a trigger is activated.
■ Maximum le size
Specify the maximum le size allowed.
■ File name prex
Enter the text that will be appended to the front of the le name.
For example:
Click Save media to enable the settings, then click Close to exit the Add media page.
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 Add media page.
1 sec. 2 sec. 3 sec. 4 sec. 5 sec. 6 sec. 7 sec. 8 sec. 9 sec. 10 sec.
Trigger Activation
Video_20110320_100341
Date and time suffix
The format is: YYYYMMDD_HHMMSS
File name prefix
VIVOTEK
User's Manual - 113
■ View: Click this button to open a file list window. This function only apllies when an SD card and
networked storage are available.
If you click View button of SD card, a Local storage page will pop up for you to manage recorded les
on SD card. For more information about Local storage, please refer to page 129. If you click View
button of Network storage, a le directory window will pop up for you to view recorded data on Network
storage.
■ Create folders by date, time, and hour automatically: If you check this item, the system will
automatically create sub-folders named by the date.
The following is an example of a le destination with recorded video clips:
Click
20140320 to open the directory:
Video Clip_59.mp4
Video Clip_58.mp4
2014/03/20
2014/03/20
Click to delete
selected items
Click to delete all
recorded data
Click to go back to the previous
level of the directory
The format is: HH (24r)
Click to open the le list for that hour
Video Clip_59.mp4
Video Clip_58.mp4
2014/03/20
2014/03/20
The format is: File name prex + Minute (mm)
You can set up the le name prex on Add media page.
20140320
20140321
20140322
Click to delete selected items
Click to delete all recorded data
The format is: YYYYMMDD
Click to open the directory
VIVOTEK
114 - User's Manual
Here is an example of the Event setting:
When completed the settings with steps 1~3 to arrange Schedule, Trigger, and Action of an event, click
Save event to enable the settings and click Close to exit the page.
The following is an example of the Event setting page:
VIVOTEK
User's Manual - 115
When the Event Status is ON, once an event is triggered by motion detection, the Network Camera will
automatically send snapshots via e-mails.
If you want to stop the event trigger, you can click
ON to turn it to OFF status or click Delete to remove
the event setting.
To remove a server setting from the list, select a server name and click Delete. Note that you can only
delete a server setting when the server setting is currently not applied to an event setting.
To remove a media setting from the list, select a media name and click Delete. Note that you can only
delete a media setting when the media setting is currently not applied to an event setting.
Customized Script
This function allows you to upload a sample script (.xml le) to the camera, which will save your time on
conguring 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.
2014/03/20
2014/03/20
Click to upload a le
Click to modify the
script online
VIVOTEK
116 - User's Manual
Applications > Motion detection
This section explains how to congure the Network Camera to enable motion detection. A total
of three motion detection windows can be congured.
Follow the steps below to enable motion detection:
Follow the steps below to enable motion detection:
1. Click New to add a new motion detection window.
2. In the Window Name text box, enter a name for the motion detection window.
■ To move and resize the window, drag and drop your mouse on the window.
■ To delete window, click X on the top right corner of the window.
3. Define the sensitivity to moving objects and the space ratio of all alerted pixels by moving the
Sensitivity and Percentage slider bar.
4. Click Save to enable the settings.
5. Select Enable motion detection to enable this function.
For example:
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 congured to be sent to a remote server (Email, FTP) by utilizing this feature as a
trigger source. For more information on how to set an event, please refer to Event settings on page 101.
2011/03/10 17:08:56
Motion Detection Setting 2:
For special situations
Motion Detection Setting 1:
For normal situations
VIVOTEK
User's Manual - 117
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 dened threshold.
If you want to congure other motion detection settings for day/night/schedule mode, please click Prole
to open the Motion Detection Profile Settings page as shown below. A total of three motion detection
windows can be congured on this page as well.
Please follow the steps beolw to set up a prole:
1. Create a new motion detection window.
2. Check Enable this prole.
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 configure it as a trigger source. Please refer to page 102 for detailed
information.
Percentage = 30%
VIVOTEK
118 - User's Manual
► How does motion detection work?
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 denes 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 identied as “alerted pixels”. When the percentage is
set to 30%, the motions are judged to exceed the dened threshold; therefore, the motion window will
be outlined in red.
For applications that require a high level of security management, it is suggested to use higher
sensitivity settings and smaller percentage values.
A
B D
C
NOTE:
VIVOTEK
User's Manual - 119
Applications > DI and DO
Digital input: Select High or Low to dene normal status for the digital input. Connect a digital input from
a sensor device to the camera, the Network Camera will report the current signal status. You may then
congure the Normal status (non-trigger status) as High or Low.
Digital output: Select High or Low to dene normal status for the digital output. Connect an output line to
an external device, the Network Camera will report the current signal status. You may then congure the
Normal status (non-trigger status) as High or Low.
Set up the event source as DI on Event > Event settings > Trigger. Please refer to page 102 for
detailed information.
VIVOTEK
120 - User's Manual
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 congure Audio detection:
1. Once the Audio detection window is opened, the current sound input will be interactively indicated
by a uctuating yellow wave diagram.
2. Use a mouse click to drag the Alarm level tab to a preferred location on the slide bar.
3. Select the “Enable audio detection“ checkbox and click Save to enable the feature.
1. Note that the volume numbers (0~100) on the side of wave 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 congure 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.
NOTE:
VIVOTEK
User's Manual - 121
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 64 for Audio settings, and page 62 for video streaming settings.
You can use the Prole window to congure 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 prole checkbox. Once the Audio detection window is opened, the current
sound input will be interactively indicated by a uctuating 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 congure a period
of time during which this prole will take effect.
4. Click Save and then click Close to complete your conguration.
VIVOTEK
122 - User's Manual
Applications > 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 conguration (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 module for the parameters contained within.
• Users can also run VIVOTEK's VADP packages as a means to access updated functionality
instead of replacing the entire rmware.
• Note that for some cameras the ash 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 le 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:
VIVOTEK
User's Manual - 123
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 conrm message, Click Yes to proceed.
Yes
No
Note that the actual memory consumed while operating the module will be indicated on the
Memory status eld. This helps determine whether a running module has consumed too much
of system resources.
VIVOTEK
124 - User's Manual
Recording > Recording settings
This section explains how to congure the recording settings for the Network Camera.
Recording Settings
► Please remember to format your SD card when using it for the rst time. Please refer to page 129 for
detailed information.
Recording Settings
Click Add to open the recording setting window. On this page, you can dene the adaptive recording,
recording source, recording schedule, and recording capacity. A total of 2 recording settings can be
congured.
■ 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 alarm trigger, the frame rate will raise up to the value you’ve set on Stream
setting page. Please refer to page 63 for more information.
Insert your SD card and click here to test
NOTE:
VIVOTEK
User's Manual - 125
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 video streams in the full frame rate; otherwise, it will only
request the I frame data during normal monitoring, thus effectively save lots of bandwidth and storage.
The alarm trigger includes: motion detection and DI detection. Please refer to Event settings on page 101.
■ Pre-event recording and post-event recording
The Network Camera has a buffer area; it temporarily holds data for up to a certain limit. Enter a
number to decide the duration of recording that will take place 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 rst.
■ Source: Select a stream as the recording source.
► To enable recording notication, please congure Event settings rst. Please refer to page 101.
Please follow steps 1~2 below to set up the recording:
1. Trigger
Select a trigger source.
■ Schedule: The server will start to record les on the local storage or to a networked storage device
(NAS).
■ Network fail: Since the time when the network fails, the server will start to record files on the local
storage (SD card).
Time
Bandwidth
Bandwidth
Activity Adaptive Streaming
for Dynamic Frame Rate Control
I frame ---> Full frame rate ---> I frame
Continuous recording
► To enable adaptive recording, please make sure
you’ve set up the trigger source such as Motion
Detection, DI Device, or Manual Trigger.
► When there is no alarm trigger:
- JPEG mode: record 1 frame per second.
- H.264 mode: record I frame only.
► When the I frame period is >1s on Video settings
page, it should be forced to make the I frame period
to 1s when adaptive recording is activated.
NOTE:
NOTE:
VIVOTEK
126 - User's Manual
2. Destination
You can select the SD card or network attached storage (NAS) for recording video les.
NAS server
Click Add NAS server
to open the server setting window and follow the steps below to set up:
1. Fill in the information for your server.
For example:
2. Click Test to check the setting. The result will be shown in the pop-up window.
1
2 4
Network storage path
(\\server name or IP address\folder name)
User name and
password for your
server
3
VIVOTEK
User's Manual - 127
If successful, you will receive a test.txt le 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 select either the entire storage space available or specify a reserved space. The
recording size limit must be larger than the reserved space for cyclic recording. The reserved space
is used during cyclic recording to prevent malfunctions that might occur during the transaction stage
when the video feeds are about to ll up the storage space, and new data is still coming. This value
must be larger than 15 MBytes.
■ Enable cyclic recording: If you check this item, when the maximum capacity is reached, the oldest les
will be overwritten by the latest ones.
■ File name prex: Enter the text that will be appended to the front of the le name.
If you want to enable recording notication, please click Event
to set up. Please refer to Event > Event
settings on page 101 for more details.
When completed, select Enable this recording. Click Save to enable the setting and click Close to exit
VIVOTEK
128 - User's Manual
this page. When the system begins recording, it will send the recorded les to a networked storage or SD
card. The new recording name will appear on the recording page as shown below.
To remove a recording setting from the list, select it and click Delete.
■
Video (Name): Click to open the Recording settings page to modify its details.
■ ON (Status): Click to manually adjust the Status. (ON: start recording; OFF: stop recording)
■
NAS or SD (Destination): Click to open the le list of recordings as shown below. For more information
about folder naming rules, please refer to page 113 or page 115 for details.
VIVOTEK
User's Manual - 129
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 status
This column shows the status and reserved space of your SD card. Please remember to format the SD
card when using for the rst time.
SD card control
■ Enable cyclic storage: Check this item if you want to enable cyclic recording. When the maximum
capacity is reached, the oldest les will be overwritten by the latest ones.
■ Enable automatic disk cleanup: Check this item and enter the number of days you wish to retain a le.
For example, if you enter “7 days”, the recorded les will be stored on the SD card for 7 days.
When all settings are completed, click Save to enable your settings.
no SD card
VIVOTEK
130 - User's Manual
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 search results.
Searching and Viewing the Records
This column allows the user to set up search criteria for recorded data. If you do not select any criteria
and click Search button, all recorded data will be listed in the Search Results column.
■ File attributes: Select one or more items as your search criteria.
■ Trigger time: Manually enter the time range you want to search.
Click Search and the recorded data that matches the search criteria will be listed in Search Results
window.
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 lter the
search results
Highlight an item
VIVOTEK
User's Manual - 131
■ View: Click on a search result. The entry will be highlighted in purple as shown above. Click the
View button and a media window will pop up to play back the selected le.
For example:
■ Download: Click on a search result to select an entry as shown above. Then click the Download button
and a le download window will prompt for you to save the le.
■ JPEGs to AVI: This function only applies to “JPEG“ format files such as snapshots. You can select
several snapshots from the list, then click this button. The series of snapshots will be converted into an
AVI le.
■ 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:
■ Remove: Select the desired search results, then click this button to delete the les.
Click to adjust the image size
Click to switch
pages
VIVOTEK
132 - User's Manual
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
VIVOTEK
User's Manual - 133
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,
dido, camctrl
1. Can view, listen, talk to camera.
2. Can control DI/DO, PTZ of the camera.
4 [operator] anonymous, viewer,
dido, camctrl, operator
Operator access rights can modify most of the camera’s
parameters except some privileges and network options.
6 [admin] anonymous, viewer,
dido, camctrl, operator,
admin
Administrator access rights can fully control the camera’s
operations.
7 N/A Internal parameters. Unable to be changed by any external
interfaces.
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>]
VIVOTEK
134 - User's Manual
[&<parameter>…]
http://<servername>/cgi-bin/operator/getparam.cgi?[<parameter>]
[&<parameter>…]
http://<servername>/cgi-bin/admin/getparam.cgi?[<parameter>]
[&<parameter>…]
Where the <parameter> should be <group>[_<name>] or <group>[.<name>]. If you do not specify any
parameters, all the parameters on the server will be returned. If you specify only <group>, the parameters of the
related group will be returned.
When querying parameter values, the current parameter values are returned.
A successful control request returns parameter pairs as follows:
Return:
HTTP/1.0 200 OK\r\n
Content-Type: text/html\r\n
Context-Length: <length>\r\n
\r\n
<parameter pair>
where <parameter pair> is
<parameter>=<value>\r\n
[<parameter pair>]
<length> is the actual length of content.
Example: Request IP address and its response
Request:
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
VIVOTEK
User's Manual - 135
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
command or have any extra parameters. This parameter must be
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
VIVOTEK
136 - User's Manual
<parameter>=<value>\r\n
[<parameter pair>]
Only the parameters that you set and are readable will be returned.
Example: Set the IP address of server to 192.168.0.123:
Request:
http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123
Response:
HTTP/1.0 200 OK\r\n
Content-Type: text/html\r\n
Context-Length: 33\r\n
\r\n
network.ipaddress=192.168.0.123\r\n
7. Available parameters on the server
Valid values:
VALID VALUES 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 (-2
31
– 1) and (2
31
– 1).
positive integer Any number between 0 and (2
32
– 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.
joe@www.ibm.com).
ip address A string limited to an IP address (eg. 192.168.1.1).
mac address A string limited to contain a MAC address without hyphens or colons.
boolean A boolean value of 1 or 0 represents [Yes or No], [True or False], [Enable or
Disable].
<value1>,
<value2>,
<value3>,
…
Enumeration. Only given values are valid.
blank A blank string.
everything inside <> A description
VIVOTEK
User's Manual - 137
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.
VIVOTEK
138 - User's Manual
7.1 system
Group: system
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
hostname string[64] SD8161 1/6 Host name of server
ledoff <boolean> 0 6/6 Turn on (0) or turn off (1) all led
indicators.
date <YYYY/MM/
DD>,
keep,
auto
<current
date>
6/6 Current date of system. Set to ‘keep’
to keep date unchanged. Set to ‘auto’
to use NTP to synchronize date.
time <hh:mm:s
s>,
keep,
auto
<current
time>
6/6 Current time of the system. Set to
‘keep’ to keep time unchanged. Set to
‘auto’ to use NTP to synchronize time.
datetime <MMDDhh
mmYYYY.ss
>
<blank> 7/6 Another current time format of the
system.
ntp <domain
name>,
<ip
address>,
<blank>
<blank> 6/6 NTP server.
*Do not use “skip to invoke default
server” for default value.
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
-281: GMT-07:00 Arizona
-240: GMT-06:00 Central America,
Central Time, Mexico City,
Saskatchewan
VIVOTEK
User's Manual - 139
-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
200: GMT 05:00 Ekaterinburg,
Islamabad, Karachi, Tashkent
220: GMT 05:30 Calcutta, Chennai,
Mumbai, New Delhi
VIVOTEK
140 - User's Manual
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 automatic daylight saving time
in time zone.
daylight_dstactualmode 1~4
<positive
integer>
1 6/7 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,
-241,-200,
-201,-160,
-140,-120,
-80,-40,0,
40,41,80,
81,82,83,
120,140,
380,400,48
0
6/6 List time zone index which support
daylight saving time.
VIVOTEK
User's Manual - 141
updateinterval 0,
3600,
86400,
604800,
2592000
0 6/6 0 to Disable automatic time
adjustment, otherwise, it indicates
the seconds between NTP automatic
update intervals.
restore 0,
<positive
integer>
N/A 7/6 Restore the system parameters to
default values after <value> seconds.
reset 0,
<positive
integer>
N/A 7/6 Restart the server after <value>
seconds if <value> is non-negative.
restoreexceptnet <Any
value>
N/A 7/6 Restore the system parameters to
default values except (ipaddress,
subnet, router, dns1, dns2, pppoe).
This command can cooperate with
other “restoreexceptXYZ” commands.
When cooperating with others, the
system parameters will be restored to
the default value except for a union of
the combined results.
restoreexceptdst <Any
value>
N/A 7/6 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
the default value except for a union of
the combined results.
restoreexceptvadp <Any
Value>
N/A 7/6 Restore the system parameters to
default values except the custom
VIVOTEK
142 - User's Manual
language file the user has uploaded.
This command can cooperate with
other “restoreexceptXYZ” commands.
When cooperating with others, the
system parameters will be restored to
the default value except for a union of
the combined results.
7.1.1 system.info
Subgroup of system: info (The fields in this group are unchangeable.)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
modelname string[40] SD8161 0/7 Internal model name of the server
(eg. IP7139)
extendedmodelname string[40] SD8161 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
address>
<product
mac
address>
0/7 12 characters MAC address (without
hyphens).
firmwareversion string[40] <product
dependent
>
0/7 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] <product
dependent
>
0/7 Available language lists.
customlanguage_maxcoun
t
<integer> 1 0/6 Maximum number of custom
languages supported on the server.
customlanguage_count <integer> 0 0/6 Number of custom languages which
have been uploaded to the server.
customlanguage_i<0~(ma
xcount-1)>
string <blank> 0/6 Custom language name.
VIVOTEK
User's Manual - 143
7.2 status
Group: status
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
di_i<0~(ndi-1)> <boolean> 0 1/7 0 => Inactive, normal
1 => Active, triggered
(capability.ndi > 0)
do_i<0~(ndo-1)> <boolean> 0 1/7 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
dependent>
1/7 Get network information from
mii-tool.
vi_i<0~(nvi-1)> <boolean> 0 1/7 Virtual input
0 => Inactive
1 => Active
(capability.nvi > 0)
7.3 digital input behavior define
Group: di_i<0~(ndi-1)>
(capability.ndi > 0)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
normalstate high,
low
high 1/1 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
(get/set)
DESCRIPTION
normalstate open,
grounded
open 1/1 Indicate open circuit or closed
circuit (inactive status)
VIVOTEK
144 - User's Manual
7.5 security
Group: security
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
privilege_do view, operator,
admin
operator 1/6 Indicate which privileges and
above can control digital
output
(capability.ndo > 0)
privilege_camctrl view, operator,
admin
view 1/6 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,
operator,
admin
admin 6/7 Root privilege
user_i<1~20>_ privilege view,
operator,
admin
<blank> 6/6 User privilege
7.6 network
Group: network
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
preproces
s
<positive
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.
VIVOTEK
User's Manual - 145
Stopped service will auto-start after changing port
settings.
Ex:
Change HTTP port from 80 to 5556, and change RTP
port for video from 5556 to 20480.
Then, set preprocess=9 to stop both service first.
”/cgi-bin/admin/setparam.cgi?
network_preprocess=9&network_http_port=5556&
network_rtp_videoport=20480”
type lan,
pppoe
<product
dependent>
lan 6/6 Network connection type.
resetip <boolean> 1 6/6 1 => Get ipaddress, subnet, router, dns1, dns2 from
DHCP server at next reboot.
0 => Use preset ipaddress, subnet, rounter, dns1,
and dns2.
ipaddress <ip
address>
<product
dependent>
6/6 IP address of server.
subnet <ip
address>
<blank> 6/6 Subnet mask.
router <ip
address>
<blank> 6/6 Default gateway.
dns1 <ip
address>
<blank> 6/6 Primary DNS server.
dns2 <ip
address>
<blank> 6/6 Secondary DNS server.
wins1 <ip
address>
<blank> 6/6 Primary WINS server.
wins2 <ip
address>
<blank> 6/6 Secondary WINS server.
7.6.1 802.1x
Subgroup of network: ieee8021x (capability.protocol.ieee8021x > 0)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
enable <boolean> 0 6/6 Enable/disable IEEE 802.1x
eapmethod eap-peap,
eap-tls
eap-peap 6/6 Selected EAP method
VIVOTEK
146 - User's Manual
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)
7.6.2 QOS
Subgroup of network: qos_cos (capability.protocol.qos.cos > 0)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
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
(get/set)
DESCRIPTION
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)
VIVOTEK
User's Manual - 147
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
(get/set)
DESCRIPTION
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.
7.6.4 FTP
Subgroup of network: ftp
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
port 21, 1025~65535 21 6/6 Local ftp server port.
7.6.5 HTTP
Subgroup of network: http
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
port 80, 1025 ~
65535
80 1/6 HTTP port.
alternateport 1025~65535 8080 6/6 Alternate HTTP port.
authmode basic,
digest
basic 1/6 HTTP authentication mode.
s0_accessname string[32] video.mjpg 1/6 HTTP server push access name for
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
VIVOTEK
148 - User's Manual
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)
s3_accessname string[32] video4.mjpg 1/6 Http server push access name for
stream 4
(capability.protocol.spush_mjpeg =1
and capability.nmediastream > 2)
anonymousviewing <boolean> 0 1/6 Enable anonymous streaming
viewing.
7.6.6 HTTPS
Subgroup of network: https
(capability.protocol.https > 0)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
port 443, 1025 ~
65535
443 1/6 HTTPS port.
7.6.7 RTSP
Subgroup of network: rtsp (capability.protocol.rtsp > 0)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
port 554, 1025 ~
65535
554 1/6 RTSP port.
(capability.protocol.rtsp=1)
anonymousviewing <boolean> 0 1/6 Enable anoymous streaming
viewing.
authmode disable,
basic,
digest
disable 1/6 RTSP authentication mode.
(capability.protocol.rtsp=1)
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)
VIVOTEK
User's Manual - 149
s2_accessname string[32] live3.sdp 1/6 RTSP access name for stream3
(capability.protocol.rtsp=1 and
capability.nmediastream > 2)
s3_accessname string[32] live4.sdp 1/6 RTSP access name for stream4
(capability.protocol.rtsp=1 and
capability.nmediastream > 2)
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
(get/set)
DESCRIPTION
alwaysmulticast <boolean> 0 4/4 Enable always multicast.
ipaddress <ip address> For n=0,
239.128.1.99
For n=1,
239.128.1.100,
and so on.
4/4 Multicast IP address.
videoport 1025 ~ 65535 s0:5560
s1:5564
s2:5568
s3:5572
4/4 Multicast video port.
Audioport 1025 ~ 65535 s0:5562
s1:5566
s2:5570
s3:5574
4/4 Multicast audio port.
(capability.naudio > 0)
metadataport 1025 ~ 65535 s0:6560
s1:6564
s2:6568
s3:6572
4/4 Multicast metadata port.
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
(get/set)
DESCRIPTION
port 1025 ~ 65535 5060 1/6 SIP port.
VIVOTEK
150 - User's Manual
7.6.9 RTP port
Subgroup of network: rtp
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
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)
metadataport 1025 ~ 65535 6556 6/6 Metadata port for RTP.
(capability.protocol.rtp_unicast=1)
7.6.10 PPPoE
Subgroup of network: pppoe (capability.protocol.pppoe > 0)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
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
(get/set)
DESCRIPTION
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> 0~31
(Single address:
<ip address>
Network address:
<blank> 6/6 IPv4 address list.
VIVOTEK
User's Manual - 151
<ip address /
network mask>
Range
address:<start ip
address - end ip
address>)
ipv6list_i<0~9> String[43] <blank> 6/6 IPv6 address list.
7.8 Video input
Group: videoin
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
cmosfreq 50, 60 60 4/4 CMOS frequency.
(capability.videoin.type=2)
whitebalance auto, manual,
rbgain <product
dependent>
auto 1/4 “auto” indicates auto white balance.
“manual” indicates keep current
value.
“rbgain” indicates using rgain and
gbain.
exposurelevel 0~12 6 4/4 Exposure level
enableblc <boolean> 0 1/4 Enable backlight compensation.
color 0, 1 1 1/4 0 =>monochrome
1 => color
flip <boolean> 0 1/4 Flip the image.
mirror <boolean> 0 1/4 Mirror the image.
ptzstatus <integer> 0 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)
Bit 4 => Support zoom operation;
0(not support), 1(support)
VIVOTEK
152 - User's Manual
Bit 5 => Support focus operation;
0(not support), 1(support)
text string[64] <blank> 4/4 Enclose caption.
imprinttimestamp <boolean> 0 1/4 Overlay time stamp on video.
maxexposure 1~32000
<product
dependent>
30 1/4 Maximum exposure time.
irismode fixed, indoor,
outdoor
indoor 4/4 Video Iris mode.
7.8.1 Video input setting per channel
Group: videoin_c<0~(n-1)> for n channel products, and m is stream number
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
mode 0 0 1/4 Set video mode.
cmosfreq 50, 60 60 1/4 CMOS frequency.
(capability.videoin.type=2)
whitebalance auto, manual,
rbgain
<product
dependent>
auto 1/4 “auto” indicates auto white
balance.
“manual” indicates keep current
value.
“rbgain” indicates using rgain
and gbain.
rgain 0~100 30 1/4 Manual set rgain value of gain
control setting.
bgain 0~100 30 1/4 Manual set bgain value of gain
control setting.
ggain 0~100 0 1/4 Manual set ggain value of gain
control setting.
exposurelevel 0~12 6 1/4 Exposure level
irismode fixed, indoor,
outdoor
indoor 1/4 Iris mode
enableblc 0~1 0 1/4 Enable backlight compensation
maxgain 0~100 100 1/4 Manual set maximum gain
value.
color 0, 1 1 1/4 0 =>monochrome
1 => color
VIVOTEK
User's Manual - 153
flip <boolean> 0 1/4 Flip the image.
mirror <boolean> 0 1/4 Mirror the image.
ptzstatus <integer> 0 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)
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 1/4 Overlay time stamp on video.
textonvideo_position top, bottom top 1/4 Text on video string position
textonvideo_size 15, 25, 30 15 1/4 Text on video font size
maxexposure 1~32000 30 1/4 Maximum 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
<product
dependent>
h264 1/4 Video codec type.
s<0~(m-1)>_resolution Reference
capability_vide
oin_resolution
s0:1920x1
080
s1:1280x7
20
s2:640x36
0
s3:1920x1
080
1/4 Video resolution in pixels.
s<0~(m-1)>_h264_intraperi 250, 500, 1000 1/4 Intra frame period in
VIVOTEK
154 - User's Manual
od 1000, 2000,
3000, 4000
milliseconds.
s<0~(m-1)>_h264_ratecont
rolmode
s0: cbr, vbr
s1: cbr, vbr
s2: cbr, vbr
s3: cbr, vbr
cbr 1/4 cbr, constant bitrate
vbr, fix quality
s<0~(m-1)>_h264_quant 1~5,
99, 100
3 1/4 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 0~51 30 1/4 Manual video quality level input.
(s<0~(m-1)>_h264_quant =
99)
s<0~(m-1)>_h264_qpercen
t
1~100 50 1/4 Manual video quality level input.
(s<0~(m-1)>_h264_quant =
100)
s<0~(m-1)>_h264_bitrate 20000~40000
000
s0:800000
0
s1:
8000000
s2:512000
s1:
8000000
1/4 Set bit rate in bps when
choosing cbr in
“ratecontrolmode”.
s<0~(m-1)>_h264_maxvbr
bitrate
1000~400000
00
40000000 1/4 Set bit rate in bps when
choosing vbr in
“ratecontrolmode”.
s<0~(m-1)>_h264_maxfra
me
1~30 s0:30
s1:30
s2:15
s3:30
1/4 Set maximum frame rate in fps
(for h264).
5M : 1~25fps
2M : 1~30fps
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
olicy
framerate,imag
equality
s0:framera
te
s1:framera
1/4 Set prioritypolicy
VIVOTEK
User's Manual - 155
te
s2:imageq
uality
s3:imageq
uality
s<0~(m-1)>_mjpeg_ratecon
trolmode
cbr, vbr vbr 1/4 cbr, constant bitrate
vbr, fix quality
s<0~(m-1)>_mjpeg_quant 1~5,
99, 100
3 1/4 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 50 1/4 Manual video quality level input.
(s<0~(m-1)>_mjpeg_quant =
99)
s<0~(m-1)>_mjpeg_qperce
nt
1~100 50 1/4 Manual video quality level input.
(s<0~(m-1)>_mjpeg_quant =
100)
s<0~(m-1)>_mjpeg_bitrate 1000~400000
00
s0:800000
0
s1:800000
0
s2:512000
s3:800000
0
1/4 Set bit rate in bps when
choosing cbr in
“ratecontrolmode”.
s<0~(m-1)>_mjpeg_maxvb
rbitrate
1000~400000
00
40000000 1/4 Set bit rate in bps when
choosing vbr in
“ratecontrolmode”.
s<0~(m-1)>_mjpeg_maxfra
me
1~30 s0:10
s1:10
s2:15
s3:10
1/4 Set maximum frame rate in fps
(for JPEG).
5M : 1~25fps
2M : 1~30fps
s<0~(m-1)>_mjpeg_priority
policy
framerate,imag
equality
s0:framera
te
s1:framera
te
s2:imageq
uality
s3:
1/4 Set prioritypolicy
VIVOTEK
156 - User's Manual
imagequali
ty
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
(get/set)
DESCRIPTION
Enable <boolean> 0 1/4 Enable/disable this profile setting
policy day,
night,
schedule
night 1/4 The mode which the profile is applied
to.
begintime hh:mm 18:00 1/4 Begin time of schedule mode.
endtime hh:mm 06:00 1/4 End time of schedule mode.
maxexposure 1~32000 30 1/4 Maximum exposure time.
enableblc <boolean> 0 1/4 Enable backlight compensation.
exposurelevel 0~12 6 1/4 Exposure level
maxgain 0~100 100 1/4 Manual set maximum gain value.
mingain 0~100 0 1/4 Manual set minimum gain value.
whitebalance auto, manual,
rbgain
auto 1/4 “auto” indicates auto white balance.
“manual” indicates keep current
value.
rgain 0~100 30 1/4 Manual set rgain value of gain
control setting.
bgain 0~100 30 1/4 Manual set bgain value of gain
control setting.
ggain 0~100 0 1/4 Manual set ggain value of gain
control setting.
irismode fixed, indoor,
outdoor
indoor 1/4 Video Iris mode.
VIVOTEK
User's Manual - 157
7.9 Video input preview
The temporary settings for video preview
Group: videoinpreview
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
maxexposure 1~32000 30 4/4 Maximum exposure time.
exposurelevel 0~12 6 4/4 Exposure level
enableblc <boolean> 0 4/4 Enable backlight compensation.
irismode fixed, indoor,
outdoor
indoor 4/4 Video Iris mode.
maxgain 0~100 100 4/4 Manual set maximum gain value.
mingain 0~100 0 4/4 Manual set minimum gain value.
7.10 IR cut control
Group: ircutcontrol (capability.nvideoinprofile > 0)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
mode auto,
day,
night,
di,
schedule
<product
dependent>
auto 1/6 Set IR cut control mode
daymodebegintime 00:00~23:59 07:00 1/6 Day mode begin time
daymodeendtime 00:00~23:59 18:00 1/6 Day mod end time
bwmode <boolean> 1 1/6 Switch to B/W in night mode if
enabled
sir <boolean> 0 1/6 Turn on Smart IR if this parameter
is set with 1.
enableextled <boolean> 0 1/6 Turn on external IR LED in night
mode if this parameter is set with
1.
sensitivity low,
normal,
normal 1/6 Sensitivity of IR cut filter
VIVOTEK
158 - User's Manual
high
7.11 Image setting per channel
Group: image_c<0~(n-1)> for n channel products
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
brightness -5~5,100 100 4/4 Adjust brightness of image
brightnesspercent 0~100 0 4/4 Adjust brightness value in
percentage when
brightness=100
saturation -5~5,100 100 4/4 Adjust saturation of image
saturationpercent 0~100 50 4/4 Adjust saturation value in
percentage when
saturation=100
contrast -5~5,100 100 4/4 Adjust contrast of image
contrastpercent 0~100 50 4/4 Adjust contrast value in
percentage when contrast=100
sharpness -5~5,100 100 4/4 Adjust sharpness value of image
sharpnesspercent 0~100 50 4/4 Adjust sharpness value in
percentage when
sharpness=100
gammacurve 0~100 0 4/4 Gamma curve
dnr_mode 0~1 1 4/4 0:disable
1:enable
dnr_strength 1~100 50 4/4 Strength of DNR
profile_i0_enable <boolean> 0 4/4 Enable/disable this profile
setting
profile_i0_policy day,
night,
schedule
night 4/4 The mode which the profile is
applied to.
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_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 sharpnesspercent value
VIVOTEK
User's Manual - 159
of image
profile_i0_gammacurve 0~100 0 4/4 Gamma curve
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
VIVOTEK
160 - User's Manual
7.12 Image setting for preview
Group: imagepreview_c<0~(n-1)> for n channel products
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
brightness -5~5,100 100 4/4 Adjust brightness of image
according to mode settings.
brightnesspercent 0~100 0 4/4 Adjust brightness value in
percentage when
saturation=100
saturation -5~5,100 100 4/4 Adjust saturation of image
according to mode settings.
100 for saturation percentage
mode.
saturationpercent 0~100 50 4/4 Adjust saturation value in
percentage when
saturation=100
contrast -5 ~ 5,100 100 4/4 Adjust contrast of image
according to mode settings.
contrastpercent 0~100 50 4/4 Adjust contrast value in
percentage when
saturation=100
sharpness -5~5,100 100 4/4 Adjust sharpness of image
according to mode settings.
sharpnesspercent 0~100 50 4/4 Adjust sharpness value in
percentage when
sharpness=100
dnr_mode 0~1 1 4/4 0:disable
1:enable
dnr_strength 1~100 50 4/4 Strength of DNR
Group: imagepreview
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
videoin_whitebalance auto,
manual,
rbgain
auto 4/4 Preview of adjusting white balance of image
according to mode settings
videoin_restoreatwb 1~ 0 4/4 Restore of adjusting white balance of image
according to mode settings
videoin_rgain 0~100 0 4/4 Manual set rgain value of gain control
VIVOTEK
User's Manual - 161
setting.
videoin_bgain 0~100 0 4/4 Manual set bgain value of gain control
setting.
videoin_ggain 0~100 0 4/4 Manual set ggain value of gain control
setting.
VIVOTEK
162 - User's Manual
7.13 Exposure window setting per channel
Group: exposurewin_c<0~(n-1)> for n channel products
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
mode auto, blc auto 4/4 The mode indicates how to
decide the exposure.
auto: Use full view as the only
one exposure window.
blc: Use BLC.
Group: exposurewin_c<0~(n-1)>_profile for m profile and n channel product
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
i<0~(m-1)>_mode auto, 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 and
exclusive window.
blc: Use BLC.
VIVOTEK
User's Manual - 163
7.14 Audio input per channel
Group: audioin_c<0~(n-1)> for n channel products
(capability.audioin>0)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
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)
s<0~(m-1)>_codectype aac4, g711,
g726
g711 4/4 Set audio codec type for input.
s<0~(m-1)>_aac4_bitrate 16000,
32000,
48000,
64000,
96000,
128000
16000 4/4 Set AAC4 bitrate in bps.
s<0~(m-1)>_g711_mode pcmu,
pcma
pcmu 4/4 Set G.711 mode.
s<0~(m-1)>_g726_mode 16000,
24000,
32000,
40000
32000 4/4 Set G.726 bitrate in bps.
s<0~(m-1)>_g726
_bitstreampackingmode
little, big little 4/4 Set G.726 bit streaming
packing mode
s<0~(m-1)>_g726
_vlcmode
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,
schedule
night 4/4 The mode which the profile is
applied to.
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.
VIVOTEK
164 - User's Manual
profile_i0_alarm_level 1~100 50 4/4 Audio detection alarm level
7.15 Motion detection settings
Group: motion_c<0~(n-1)> for n channel product
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
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[40] <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)> profile for m profile and n channel product (capability.nmotionprofile > 0)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
i<0~(m-1)>_enable <boolean> 0 4/4 Enable profile 1 ~
(m-1).
i<0~(m-1)>_policy day,
night,
schedule
night 4/4 The mode which the
profile is applied to.
i<0~(m-1)>_begintime hh:mm 18:00 4/4 Begin time of
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[40] <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
VIVOTEK
User's Manual - 165
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.16 DDNS
Group: ddns (capability.ddns > 0)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
enable <boolean> 0 6/6 Enable or disable the dynamic DNS.
provider CustomSafe100,
DyndnsDynamic,
DyndnsCustom,
PeanutHull,
Safe100,
DyndnsDyn
amic
6/6 Safe100 => safe100.net
DyndnsDynamic => dyndns.org
(dynamic)
DyndnsCustom => dyndns.org
CustomSafe100 =>
Custom server using safe100 method
PeanutHull => PeanutHull
<provider>_ho
stname
string[128] <blank> 6/6 Your DDNS hostname.
<provider>_us
ernameemail
string[64] <blank> 6/6 Your user name or email to login to the
DDNS service provider
<provider>_pa
sswordkey
string[64] <blank> 6/6 Your password or key to login to the
DDNS service provider.
<provider>_se
rvername
string[128] <blank> 6/6 The server name for safe100.
(This field only exists if the provider is
customsafe100)
7.17 Express link
Group: expresslink
PARAMETER VALUE Default SECURITY
(get/set)
DESCRIPTION
enable <boolean> 0 6/6 Enable or disable express link.
VIVOTEK
166 - User's Manual
state onlycheck,
onlyoffline,
checkonline,
badnetwork
badnetwork 6/6 Camera will check the status of network
environment and express link URL
url string[63] NULL 6/6 The url user define to link to camera
7.18 UPnP presentation
Group: upnppresentation
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
enable <boolean> 1 6/6 Enable or disable the UPnP
presentation service.
7.19 UPnP port forwarding
Group: upnpportforwarding
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
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.20 System log
Group: syslog
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
enableremotelog <boolean> 0 6/6 Enable remote log.
serverip <IP address> <blank> 6/6 Log server IP address.
serverport 514,
1025~65535
514 6/6 Server port used for log.
level 0~7 6 6/6 Levels used to distinguish the
importance of the information:
0: LOG_EMERG
1: LOG_ALERT
VIVOTEK
User's Manual - 167
2: LOG_CRIT
3: LOG_ERR
4: LOG_WARNING
5: LOG_NOTICE
6: LOG_INFO
7: LOG_DEBUG
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.21 camera PTZ control
Group: camctrl_c<0~(n-1)> for n channel product (capability.ptzenabled)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
ccdtype string[16] product
dependent
6/7 FE : SD8161
motortype string[16] 4 6/7 Motor device type
panspeed -5 ~ 5 0 1/4 Pan speed
tiltspeed -5 ~ 5 0 1/4 Tilt speed
zoomspeed -5 ~ 5 0 1/4 Zoom speed
autospeed -5 ~ 5 0 1/4 Auto pan speed
focusspeed -5 ~ 5 0 1/4 Auto focus speed
preset_i<0~(npreset
-1)>_name
string[40] <blank> 1/4 Name of the preset location.
preset_i<0~(npreset
-1)>_pan
0 ~ 7999 <blank> 1/4 Pan position at each preset
location.
preset_i<0~(npreset
-1)>_tilt
0 ~ 2445 <blank> 1/4 Tilt position at each preset
location.
preset_i<0~(npreset
-1)>_zoom
0 ~ 16384 <blank> 1/4 Zoom position at each preset
location.
preset_i<0~(npreset
-1)>_focus
4096 ~ 49152 <blank> 1/4 Focus position at each preset
location.
preset_i<0~(npreset
-1)>_fliped
0,1 <blank> 1/4 Flip side at each preset location.
patrol_i<0~39>_na string[40] <blank> 1/4 (For internal device)
VIVOTEK
168 - User's Manual
me The name of patrol location
patrol_i<0~39>_
dwelling
0 ~ 255 <blank> 1/4 (For internal device)
The dwelling time of each patrol
location
disablemdonptz <boolean> 1 1/4 Disable motion detection on PTZ
operation.
defaulthome <boolean> 1 1/4 This field tells system to use
default home position or not.
axisx 0 ~ 3999 0 1/4 Custom home pan position.
axisy 0 ~ 1221 0 1/4 Custom home tilt position.
axisz 0 ~ 2520 0 1/4 Custom home zoom position.
axisf 0 ~ 820 0 1/4 Custom home focus position.
axisflip 0,1 0 1/4 Custom home flip side.
returnhome 0,1 0 1/4 Enable/disable return home while
idle.
returnhomeinterval 1~999 5 1/4 While idle over this time interval,
idle action will be taken.
digitalzoom <boolean> 0 1/4 Enable/disable digital zoom
idleaction_enable 0~1 1 1/4 Enable/disable idle action while
idle
idleaction_type pan,patrol,hom
e,objtrack,prev
prev 1/4 This field tells what kind of action
should be taken while idle.
idleaction_interval 1~999 5 1/4 While idle over this time interval,
idle action will be taken.
zoomenhance <boolean> 0 1/4 Enable / Disable zoom
enhancement
7.22 SNMP
Group: snmp (capability.snmp > 0)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
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
VIVOTEK
User's Manual - 169
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
7.23 Layout configuration
Group: layout (New version)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
logo_default <boolean> 1 1/6 0 => Custom logo
1 => Default logo
logo_link string[128] http://ww
w.vivotek.c
om
1/6 Hyperlink of the logo
logo_powerbyvvtk_hidden <boolean> 0 1/6 0 => display the power by vivotek
logo
1 => hide the power by vivotek
logo
custombutton_manualtrigger_s
how
<boolean> 1 1/6 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.
VIVOTEK
170 - User's Manual
theme_color_titlefont string[7] #098bd6 1/6 Font color of video title.
theme_color_controlbackgroun
d
string[7] #565656 1/6 Background color of control area.
theme_color_configbackground string[7] #323232 1/6 Background color of configuration
area.
theme_color_videobackground string[7] #565656 1/6 Background color of video area.
theme_color_case string[7] #323232 1/6 Frame color
7.24 Privacy mask
Group: privacymask3d_c<0~(n-1)> for n channel product
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
enable <boolean> 0 4/4 Enable the 3D privacy mask
color 0~14 0 4/4 Privacy mask color
win_i<0~23>_name string[40] <blank> 4/4 Name of the privacy mask window.
win_i<0~23>_pan 0 ~ 7999 0 4/4 Pan position of window position.
win_i<0~23>_tilt 0 ~ 2445 0 4/4 Tilt position of window position.
win_i<0~23>_zoom 0 ~ 16384 0 4/4 Zoom position of window position.
win_i<0~23>_fliped 0,1 0 4/4 Flip side of window position.
win_i<0~23>_width 0 ~ 80 0 4/4 Width of privacy mask window.
win_i<0~23>_height 0 ~ 60 0 4/4 Height of privacy mask window.
VIVOTEK
User's Manual - 171
7.25 Capability
Group: capability
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
api_httpversion <string> 0300a 0/7 The HTTP API
version.
bootuptime <positive integer> 60 0/7 Server bootup time.
nir 0,
<positive integer>
0 0/7 Number of IR
interfaces.
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
npir 0,
<positive integer>
0 0/7 Number of PIRs.
ndi 0,
<positive integer>
4 0/7 Number of digital
inputs.
nvi 0,
<positive integer>
3 0/7 Number of virtual
inputs (manual
trigger)
ndo 0,
<positive integer>
2 0/7 Number of digital
outputs.
naudioin 0,
<positive integer>
1 0/7 Number of audio
inputs.
naudioout 0,
<positive integer>
1 0/7 Number of audio
outputs.
nvideoin <positive integer> 1 0/7 Number of video
inputs.
nvideoout 0,
<positive integer>
0 0/7 Number of video
input profiles.
nmediastream <positive integer> 4 0/7 Number of media
stream per
channels.
nmotion <positive integer> 3 0/7 Number of motions
nvideosetting <positive integer> 4 0/7 Number of video
VIVOTEK
172 - User's Manual
settings per
channel.
naudiosetting <positive integer> 1 0/7 Number of audio
settings per
channel.
nuart 0,
<positive integer>
0 0/7 Number of UART
interfaces.
nvideoinprofile <positive integer> 1 0/7 Number of video
input profiles.
nmotionprofile 0, <positive integer> 1 0/7 Number of motion
profiles.
ptzenabled 0, <positive integer> 63 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)
VIVOTEK
User's Manual - 173
Bit 6 => Support
iris operation;
0(not support),
1(support)
Bit 7 => External or
built-in PT;
0(built-in),
1(external)
Bit 8 => Invalidate
bit 1 ~ 7;
0(bit 1 ~ 7 are
valid),
1(bit 1 ~ 7 are
invalid)
Bit 9 => Reserved
bit; Invalidate
lens_pan, Lens_tilt,
lens_zoon,
lens_focus, len_iris.
0(fields are valid),
1(fields are invalid)
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.
ptz_panspeedlv <positive integer> 127 0/7 The maximum
speed level of pan
moving.
ptz_tiltspeedlv <positive integer> 127 0/7 The maximum
speed level of tilt
moving.
ptz_zoomspeedlv <positive integer> 10 0/7 The maximum
speed level of zoom
moving
ptz_focusspeedlv 0, <positive integer> 10 0/7 The maximum
speed level of focus
moving.
VIVOTEK
174 - User's Manual
ptz_minpan <positive integer> 0 0/7 The lower limit for
pan position.
ptz_maxpan <positive integer> 3999 0/7 The upper limit for
pan position.
ptz_minpanangle < integer> 0 0/7 The lower limit for
pan angle.
ptz_maxpanangle < integer> 360 0/7 The upper limit for
pan position.
ptz_mintilt <positive integer> 0 0/7 The lower limit for
tilt position.
ptz_maxtilt <positive integer> 1221 0/7 The upper limit for
tilt position.
ptz_mintiltangle < integer> -20 0/7 The lower limit for
tilt angle.
ptz_maxtiltangle < integer> 90 0/7 The upper limit for
tilt angle.
ptz_minzoom 0, <positive integer> 0 0/7 The lower limit for
zoom position.
ptz_maxzoom 0, <positive integer> 2520 0/7 The upper limit for
zoom position.
ptz_maxdzoom 0, <positive integer> 2630 0/7 The upper limit for
digital zoom
position.
ptz_minfocus 0, <positive integer> 0 0/7 The lower limit for
focus position.
ptz_maxfocus 0, <positive integer> 820 0/7 The upper limit for
focus position.
remotefocus <boolean> 0 0/7 Indicate whether to
support
remote focus
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.
VIVOTEK
User's Manual - 175
protocol_sip <boolean> 1 0/7 Indicate whether to
support SIP.
protocol_maxconnectio
n
<positive integer> 10 0/7 The maximum
allowed
simultaneous
connections.
protocol_maxgenconne
ction
<positive integer> 10 0/7 The maximum
general streaming
connections .
protocol_rtp_multicast_
scalable
<boolean> 1 0/7 Indicate whether to
support scalable
multicast.
protocol_rtp_multicast_
backchannel
<boolean> 1 0/7 Indicate whether to
support
backchannel
multicast.
protocol_rtp_tcp <boolean> 1 0/7 Indicate whether to
support RTP over
TC P.
protocol_rtp_http <boolean> 1 0/7 Indicate whether to
support RTP over
HTTP.
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.
VIVOTEK
176 - User's Manual
videoin_type 0, 1, 2 2 0/7 0 => Interlaced
CCD
1 => Progressive
CCD
2 => CMOS
videoin_c0_nmode <Integer> 1 0/7 Indicate how many
video modes
supported by this
channel.
videoin_c0_mode <Integer> 0 0/7 Indicate current
video mode.
videoin_c0_streamcode
c
<A list of positive
integer separated by
commas>
6,6,6,6 0/7 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_lens_type motor motor 0/7 The lens type of this
channel.
fisheye: Fisheye
lens
fixed: Build-in lens.
The lens may be
fixed focal,
vari-focal, etc, but
not be changeable.
changeable:
changeable lens.
Like box-type
VIVOTEK
User's Manual - 177
camera, users can
install any C-Mount
or CS-Mount lens as
they wish.
motor: Lens with
motor to support
zoom, focus, etc.
-: N/A
videoin_c0_lens_model
name
- - 0/7 Optional model
name for lens.
videoin_c0_mode<0~1
>_binning
0 0 0/7 Indicate binning is
used or not in this
video mode.
0: No binning
1: 2x2 binning
3: 3x3 binning
videoin_c0_mode<0~1
>_description
<string> 1080P (16:9) (MAX
30fps)
0/7 Description about
this mode.
videoin_c0_mode<0~1
>_ effectivepixel
<WxH> 1920x1080 0/7 The visible area of
full scene in this
video mode.
The unit is pixel.
videoin_c0_mode<0~1
>_outputsize
<WxH> 1920x1080 0/7 The output size of
source, equal to the
captured size by
device, in this video
mode.
The unit is pixel.
videoin_c0_mode<0~1
>_maxframerate
<A list of positive
integer separated by
commas>
30,30,30,30,30,30,
30
0/7 Indicate maximum
frame rate available
for the
corresponding
resolution. Those
values are
one-to-one
mapping to the
"resolution"
parameter in this
video mode.
videoin_codec <string> mjpeg,h264 0/7 Available codec list.
VIVOTEK
178 - User's Manual
videoin_c0_nresolution <positive integer> 7 0/7 Number of videoin
resolution.
videoin_c0_resolution <a list of available
resolution separated
by commas>
<product
dependent>
176x144,
384x216,
640x360,
1280x720,
1360x768,
1600x904,
1920x1080
0/7 Available
resolutions list.
Videoin_c0_maxsize <WxH> 1920x1080 0/7 The maximum
resolution of this
channel, the unit is
pixel.
videoin_c0_mode0_nre
solution
<positive integer> 7 0/7 Available
resolutions list.
videoin_c0_mode0_res
olution
<a list of available
resolution separated
by commas>
<product
dependent>
176x144,
384x216,
640x360,
1280x720,
1360x768,
1600x904,
1920x1080
0/7 Available
resolutions list.
videoin_c0_mode0_ma
xfps_mjpeg
<Integer> 30,30,30,30,30,30,
30
0/7 Maximum fps that
the device can
encode
videoin_c0_mode0_ma
xfps_h264
<Integer> 30,30,30,30,30,30,
30
0/7 Maximum fps that
the device can
encode
videoin_flexiblebitrate <boolean> 1 0/7 Indicate whether to
support
flexible bit rate
control.
videoin_flexiblebitrate <boolean> 1 0/7 Indicate whether to
support flexible
bitrate.
audio_aec <boolean> 0 0/7 Indicate whether to
support acoustic
echo cancellation.
VIVOTEK
User's Manual - 179
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, g726
<product
dependent>
aac4, g711, g726 0/7 Available codec list
for audio input.
audioout_codec g711
<product
dependent>
g711 0/7 Available codec list
for SIP.
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/ca
mctrl.cgi and
/cgi-bin/viewer/ca
mctrl.cgi
0: support only
/cgi-bin/viewer/ca
mctrl.cgi
uart_httptunnel <boolean> 0 0/7 Indicate whether to
support HTTP tunnel
for UART transfer.
VIVOTEK
180 - User's Manual
nprivacymask <positive integer> 5 0/7 Number of privacy
masks.
transmission_mode Tx,
Rx,
Both
Tx 0/7 Indicate
transmission mode
of the machine: TX
= 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 N/A 0/7 Indicate the begin
channel of wireless
network
wireless_endchannel 1 ~ 14 N/A 0/7 Indicate the end
channel of wireless
network
wireless_encrypt_wep <boolean> 0 0/7 Indicate whether to
support wireless
W E P.
wireless_encrypt_wpa <boolean> 0 0/7 Indicate whether to
support wireless
WPA.
VIVOTEK
User's Manual - 181
wireless_encrypt_wpa2 <boolean> 0 0/7 Indicate whether to
support wireless
WPA2.
localstorage_manageab
le
<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,
<positive integer>
4 0/7 The maximum MOD
connection
numbers.
localstorage_slconnum 0,
<positive integer>
1 0/7 The maximum
seamless
connection number.
localstorage_modversio
n
<string> 1.0.2.1 0/7 Indicate MOD
daemon version
adaptiverecording <boolean> 1 0/7 Indicate whether to
support adaptive
recording.
adaptivestreaming <boolean> 1 0/7 Indicate whether to
support adaptive
recording.
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)
npreset 0, <positive integer> 256 0/7 Number of preset
locations
eptz 0, <positive integer> 0 0/7 A 32-bit integer,
each bit can be set
VIVOTEK
182 - User's Manual
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 integer> 0 0/7 number of any
media stream per
channel
iva <boolean> 0 0/7 Indicate whether to
support Intelligent
Video analysis
tampering <boolean> 0 0/7 Indicate whether to
support tampering
detection.
test_ac <boolean> 0 0/7 Indicate whether to
support test ac key.
image_wdrc <Boolean> 0 0/7 Indicate whether to
support WDR
enhanced.
image_iristype <string> dciris 0/7 Indicate iris type.
image_focusassist <Boolean> 0 0/7 Indicate whether to
support focus
assist.
windowless <boolean> 1 0/7 Indicate whether to
support windowless
plug-in.
supportsd <boolean> 1 0/7 Indicate whether to
support local
storage.
timeshift <boolean> 1 0/7 Indicate whether to
support time shift
caching stream.
whitelight <boolean> 0 0/7 Indicate whether to
support white light
VIVOTEK
User's Manual - 183
led.
Iris <boolean> 0 0/7 Indicate whether to
support iris control.
temperature <boolean> 0 0/7 Indicate whether to
support
temperature
detection.
Fisheye <boolean> 0 0/7 Indicate where
fisheye camera.
vadp <positive integer> 23 0/7 An 32-bit integer,
each bit can be set
separately as
follows:
Bit 0 => VADP
interface
Bit 1 => Capture
video raw data
Bit 2 => Support
encode jpeg
Bit 3 => Capture
audio raw data
Bit 4 => Support
event trigger
Bit 5 => Support
license registration
Bit 6 => Support
shared memory API
remotecamctrl_master 0, <positive integer> 0 0/7 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).
VIVOTEK
184 - User's Manual
media_totalspace <positive integer> 35000 0/7 Available memory
space (KB) for
media.
media_snapshot_sizepe
rsecond
<positive integer> 1250 0/7 Maximum size (KB)
of one snapshot
image.
media_snapshot_maxp
reevent
<positive integer> 7 0/7 Maximum snapshot
number before
event occurred.
media_snapshot_maxp
ostevent
<positive integer> 7 0/7 Maximum snapshot
number after event
occurred.
media_videoclip_maxsi
ze
<positive integer> 8192 0/7 Maximum size (KB)
of a videoclip.
media_videoclip_maxle
ngth
<positive integer> 20 0/7 Maximum length
(second) of a
videoclip.
media_videoclip_maxpr
eevent
<positive integer> 9 0/7 Maximum duration
(second) after event
occurred in a
videoclip.
version_genetec <string> 1.0.2.5 0/7 Indicate Genetec
daemon version
version_onvifdaemon <string> 1.8.0.7 0/7 Indicate ONVIF
daemon version
image_ c0_wdrc <boolean> 0 0/7 Indicate whether to
support WDR
enhanced.
image_c0_dnr <boolean> 1 0/7 Indicate whether to
support digital noise
reduction.
image_ c0_iristype <string> dciris 0/7 Indicate iris type.
image_ c0_backfocus <boolean> 0 0/7 Indicate whether to
support back focus.
image_ c0_focusassist <boolean> 0 0/7 Indicate whether to
support focus
assist.
image_ c0_remotefocus <boolean> 0 0/7 Indicate whether to
support remote
focus.
VIVOTEK
User's Manual - 185
7.26 Customized event script
Group: event_customtaskfile_i<0~2>
PARAMETER VALUE Default SECURITY
(get/set)
DESCRIPTION
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.
7.27 Event setting
Group: event_i<0~2>
PARAMETER VALUE Default SECURITY
(get/set)
DESCRIPTION
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 20 6/6 Delay in seconds before detecting the
next event.
trigger boot,
di,
motion,
seq,
recnotify,
vi,
volalarm,
boot 6/6 Indicate the trigger condition:
“boot” = System boot
“di”= Digital input
“motion” = Video motion detection
“seq” = Periodic condition
“recnotify” = Recording notification.
“tampering” = Tamper detection.
“vi”= Virtual input (Manual trigger)
"volalarm" = Audio detection
"pir" = Passive infrared sensor trigger
(capability.npir>0)
triggerstatus String[40] trigger 6/6 The status for event trigger.
exttriggerstatus String[40] <blank> 6/6 The status for event trigger.
VIVOTEK
186 - User's Manual
exttriggerstatus1 String[40] <blank> 6/6 The status for event trigger.
exttriggerstatus2 String[40] <blank> 6/6 The status for event trigger.
exttriggerstatus3 String[40] <blank> 6/6 The status for event trigger.
di 0~3 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 0~7 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 1
st
window.
For example, to detect the 1
st
and 3
rd
windows, set mdwin as 5.
mdwin0 0~7 0 6/6 Similar to mdwin. The parameter takes
effect when profile 1 of motion detection
is enabled.
vi 0~7 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”.
VIVOTEK
User's Manual - 187
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)
action_do_i<0~(ndo-1)
>_enable
0, 1 0 6/6 Enable or disable trigger digital output.
action_do_i<0~(ndo-1)
>_duration
1~999 1 6/6 Duration of the digital output trigger in
seconds.
action_goto_enable <Boolean> 0 6/6 Enable/disable ptz goto preset position
on event triggered.
action_goto_name string[40] <blank> 6/6 Specify the preset name that ptz goto on
event triggered.
action_cf_enable <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 0~4,101 <blank> 6/6 Index of the attached media.
action_cf_datefolder <boolean> 0 6/6 Enable this to create folders by date,
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
nable
0, 1 0 6/6 Enable or disable this server action.
action_server_i<0~4>_
media
0~4,101 <blank> 6/6 Index of the attached media.
101 means “Recording Notify”
action_server_i<0~4>_
datefolder
<boolean> 0 6/6 Enable this to create folders by date,
time, and hour automatically.
VIVOTEK
188 - User's Manual
7.28 Server setting for event action
Group: server_i<0~4>
PARAMETER VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
name string[40] NULL 6/6 Identification of this entry
type email,
ftp,
http,
ns
email 6/6 Indicate the server type:
“email” = email server
“ftp” = FTP server
“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.
VIVOTEK
User's Manual - 189
7.29 Media setting for event action
Group: media_i<0~4> (media_freespace is used internally.)
PARAMETER VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
name string[40] NULL 6/6 Identification of this entry
type snapshot,
systemlog,
videoclip,
recordmsg
snapshot 6/6 Media type to send to the server or store
on the server.
snapshot_source 0~3 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 0~3 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 ~ 8192 1000 6/6 Maximum size of one video clip file in
Kbytes.
VIVOTEK
190 - User's Manual
7.30 Recording
Group: recording_i<0~1>
PARAMETER VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
name string[40] NULL 6/6 Identification of this entry.
trigger schedule,
networkfail
schedule 6/6 The event trigger type
schedule: The event is triggered by
schedule
networkfail: The event is triggered by the
failure of network connection.
enable 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~3 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.
VIVOTEK
User's Manual - 191
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
T
he 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,
0~4
cf 6/6 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
<product dependent>
100~2000
<product
dependent>
100
<product
dependent>
6/6 Unit: Mega bytes.
When this condition is reached, recording
file is truncated.
maxduration
<product dependent>
60~3600
<product
dependent>
60
<product
dependent>
6/6 Uuit: Second
When this condition is reached, recording
file is truncated.
adaptive_enable
<product dependent>
0,1 0 6/6 Indicate whether the adaptive recording
is enabled
adaptive_preevent
<product dependent>
0~9 1 6/6 Indicate when is the adaptive recording
started before the event trigger point
(seconds)
VIVOTEK
192 - User's Manual
adaptive_postevent
<product dependent>
0~10 1 6/6 Indicate when is the adaptive recording
stopped after the event trigger point
(seconds)
7.31 HTTPS
Group: https (capability.protocol.https > 0)
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
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,
manual,
install
auto 6/6 auto => Create self-signed
certificate automatically.
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 the certificate
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 the
certificate information.
commonname string[64] www.vivotek.
com
6/6 Common name in the certificate
information.
validdays 0 ~ 9999 3650 6/6 Valid period for the certification.
VIVOTEK
User's Manual - 193
7.32 Storage management setting
Currently it’s for local storage (SD, CF card)
Group: disk_i<0~(n-1)> n is the total number of storage devices.
(capability.storage.dbenabled > 0)
PARAMETER VALUE Default SECURITY
(get/set)
DESCRIPTION
cyclic_enabled <boolean> 0 6/6 Enable cyclic storage method.
autocleanup_enabled <boolean> 0 6/6 Enable automatic clean up method.
Expired and not locked media files will be
deleted.
autocleanup_maxage <positive
integer>
7 6/6
T
o specify the expired days for automatic
clean up.
7.33 VIVOTEK Application Development Platform setting
Group: vadp
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
version 0~.0~.0~.0~.0~ 1.1.0.0 6/7 Indicate the VADP version.
resource_total_video 0~ 1 6/7 Indicate total video resource
number of the system.
resource_total_audio 0~ 0 6/7 Indicate total audio resource
number of the system.
resource_total_do 0~ 0 6/7 Indicate total DO resource
number of the system.
resource_total_memory 0~ 24576 6/7 Indicate total available
memory size for VADP
modules.
resource_total_storage 0~ 10240 6/7 Indicate total size of the
internal storage space for
storing VADP modules.
resource_free_video 0~ 1 6/7 Indicate free video resource
number of the system.
resource_free_audio 0~ 0 6/7 Indicate free audio resource
number of the system.
resource_free_do 0~ 0 6/7 Indicate free DO resource
number of the system.
resource_free_memory 0~ 24576 6/7 Indicate free memory size
for VADP modules.
VIVOTEK
194 - User's Manual
resource_free_storage 0~ 10240 6/7 Indicate current free
storage size for uploading
VADP modules.
module_number 0~ 0 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> 0 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.
Group: vadp_module_i<0~(n-1)>
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
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.
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.
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] off 6/6 Indicate the running status of
the module.
VIVOTEK
User's Manual - 195
7.34 Seamless recording setting
Group: seamlessrecording (capability.localstorage.seamless > 0)
PARAMETER VALUE Default SECURITY
(get/set)
DESCRIPTION
diskmode seamless,
manageable
seamless 1/6 “seamless” indicates enable
seamless recording.
“manageable” indicates disable
seamless recording.
maxconnection 3 3 1/6 Maximum number of connected
seamless streaming.
stream 1~3 1 1/6 (Internal used, read only)
output 0~2 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)
7.35 Genetec info
Group: genetec
NAME VALUE DEFAULT SECURITY
(get/set)
DESCRIPTION
image_ contrast <integer> 50 7/7 Only for genetec omnicast
image_ brightness <integer> 0 7/7 Only for genetec omnicast
motion_ i<0~2> <integer> 0,0,0,0 7/7 Only for genetec omnicast
VIVOTEK
196 - User's Manual
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.
VIVOTEK
User's Manual - 197
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
VIVOTEK
198 - User's Manual
\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 DEFAULT DESCRIPTION
channel 0~(n-1) 0 The channel number of the video source.
resolution <available
resolution>
0 The resolution of the image.
quality 1~5 3 The quality of the image.
streamid 0~(m-1) <product
dependent>
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>]
VIVOTEK
User's Manual - 199
[&privilege=<value>][…][&return=<return page>]
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 <value> The privilege of the user to add or to modify.
viewer Viewer privilege.
operator Operator privilege.
admin Administrator privilege.
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.
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
VIVOTEK
200 - User's Manual
<system log information>\r\n
Upgrade Firmware
Note: This request requires Administrator privileges.
Method: POST
Syntax:
http://<servername>/cgi-bin/admin/upgrade.cgi
Post data:
fimage=<file name>[&return=<return page>]\r\n
\r\n
<multipart encoded form data>
Server will accept the file named <file name> to upgrade the firmware and return with <return page> if indicated.
Camera Control (capability.ptzenabled > 0)
Note: This request requires Viewer privileges.
Method: GET/POST
Syntax:
http://<servername>/cgi-bin/camctrl/camctrl.cgi?[channel=<value>][&camid=<value>]
[&move=<value>] – Move home, up, down, left, right
[&focus=<value>] – Focus operation
[&iris=<value>] – Iris operation
[&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>][&speedlink=<val
ue>] ] – Set speeds
[&return=<return page>]
Example:
http://myserver/cgi-bin/camctrl/camctrl.cgi?channel=0&camid=1&move=right
http://myserver/cgi-bin/camctrl/camctrl.cgi?channel=0&camid=1&zoom=tele
http://myserver/cgi-bin/camctrl/camctrl.cgi?channel=0&camid=1&x=300&y=200&resolution=704x480&videosi
VIVOTEK
User's Manual - 201
ze=704x480&strech=1
PARAMETER VALUE DESCRIPTION
channel <0~(n-1)> Channel of video source.
camid 0,<positive integer> Camera ID.
move home Move to camera to home position.
up Move camera up.
down Move camera down.
left Move camera left.
right Move camera right.
speedpan -5 ~ 5 Set the pan speed.
speedtilt -5 ~ 5 Set the tilt speed.
speedzoom -5 ~ 5 Set the zoom speed.
speedfocus -5 ~ 5 Set the focus speed.
speedapp -5 ~ 5 Set the auto pan/patrol speed.
auto pan Auto pan.
patrol Auto patrol.
stop Stop camera.
zoom wide Zoom larger view with current speed.
tele Zoom further with current speed.
stop Stop zoom.
zooming wide or tele Zoom without stopping for larger view or further view with zs speed,
used for joystick control.
zs 0 ~ 8 <SD8362> Set the speed of zooming, “0” means stop.
vx <integer , excluding 0> The slope of movement = vy/vx, used for joystick control.
vy <integer>
vs 0 ~ 127 Set the speed of movement, “0” means stop.
x <integer> x-coordinate clicked by user.
It will be the x-coordinate of center after movement.
y <integer> y-coordinate clicked by user.
It will be the y-coordinate of center after movement.
videosize <window size> The size of plug-in (ActiveX) window in web page
resolution <window size> The resolution of streaming.
VIVOTEK
202 - User's Manual
stretch <boolean> 0 indicates that it uses resolution (streaming size) as the range of
the coordinate system.
1 indicates that it uses videosize (plug-in size) as the range of the
coordinate system.
focus auto Auto focus.
far Focus on further distance.
near Focus on closer distance.
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.
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=640x400&resolution=640x400&stretch=0
PARAMETER VALUE DESCRIPTION
channel <0~(n-1)> Channel of video source.
stream <0~(m-1)> Stream.
move home Move to home ROI.
VIVOTEK
User's Manual - 203
up Move up.
down Move down.
left Move left.
right Move right.
auto pan Auto pan.
patrol Auto patrol.
stop Stop auto pan/patrol.
zoom wide Zoom larger view with current speed.
tele Zoom further with current speed.
zooming wide or tele Zoom without stopping for larger view or further view with zs speed,
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 uses resolution (streaming size) as the range of
the coordinate system.
1 indicates that it uses videosize (plug-in size) as the range of the
coordinate system.
speedpan -5 ~ 5 Set the pan speed.
speedtilt -5 ~ 5 Set the tilt speed.
speedzoom -5 ~ 5 Set the zoom speed.
speedapp 1 ~ 5 Set the auto pan/patrol speed.
return <return page> Redirect to the page <return page> after the parameter is assigned.
The <return page> can be a full URL path or relative path according to
the current path.
VIVOTEK
204 - User's Manual
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
characters
One of the present positions to recall.
return <return page> Redirect to the page <return page> after the parameter is assigned.
The <return page> 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.
addpos <Text string less than
40 characters>
Add one preset location to the preset list.
delpos <Text string less than
40 characters>
Delete preset location from the preset list.
return <return page> Redirect to the page <return page> after the parameter is assigned.
The <return page> can be a full URL path or relative path according to
the current path.
VIVOTEK
User's Manual - 205
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
method addv4 Add IPv4 address into access list.
addv6 Add IPv6 address into access list.
delv4 Delete IPv4 address from access list.
delv6 Delete IPv6 address from access list.
ip <IP address> Single address: <IP address>
Network 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.
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
VIVOTEK
206 - User's Manual
method addv4 Add IPv4 address into access list.
addv6 Add IPv6 address into access list.
delv4 Delete IPv4 address from access list.
delv6 Delete IPv6 address from access list.
ip <IP address> Single address: <IP address>
Network 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.
VIVOTEK
User's Manual - 207
Get SDP of Streams
Note: This request requires Viewer access privileges.
Method: GET/POST
Syntax:
http://<servername>/<network_rtsp_s<0~m-1>_accessname>
“m” is the stream number.
“network_accessname_<0~(m-1)>” is the accessname for stream “1” to stream “m”. Please refer to the
“subgroup of network: rtsp” for setting the accessname of SDP.
You can get the SDP by HTTP GET.
When using scalable multicast, Get SDP file which contains the multicast information via HTTP.
Open the Network Stream
Note: This request requires Viewer access privileges.
Syntax:
For HTTP push server (MJPEG):
http://<servername>/<network_http_s<0~m-1>_accessname>
For RTSP (MP4), the user needs to input the URL below into an RTSP compatible player.
rtsp://<servername>/<network_rtsp_s<0~m-1>_accessname>
“m” is the stream number.
For details on streaming protocol, please refer to the “control signaling” and “data format” documents.
Senddata (capability.nuart > 0)
Note: This request requires Viewer privileges.
Method: GET/POST
Syntax:
http://<servername>/cgi-bin/viewer/senddata.cgi?
[com=<value>][&data=<value>][&flush=<value>] [&wait=<value>] [&read=<value>]
PARAMETER VALUE DESCRIPTION
VIVOTEK
208 - User's Manual
com 1 ~ <max. com port
number>
The target COM/RS485 port number.
data <hex decimal
data>[,<hex decimal
data>]
The <hex decimal data> is a series of digits from 0 ~ 9, A ~ F. Each
comma separates the commands by 200 milliseconds.
flush yes,no yes: Receive data buffer of the COM port will be cleared before read.
no: Do not clear the receive data buffer.
wait 1 ~ 65535 Wait time in milliseconds before read data.
read 1 ~ 128 The data length in bytes to read. The read data will be in the return
page.
Return:
HTTP/1.0 200 OK\r\n
Content-Type: text/plain\r\n
Content-Length: <system information length>\r\n
\r\n
<hex decimal data>\r\n
Where hexadecimal data is digits from 0 ~ 9, A ~ F.
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.
VIVOTEK
User's Manual - 209
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> Optional.
Indicate if the file is locked or not.
0: file is not locked.
1: file is locked.
A locked file would not be removed from UI or cyclic storage.
triggerTime <text> Optional.
Indicate the event trigger time. (not the file created time)
Format is “YYYY-MM-DD HH:MM:SS”
Please embrace your input value with single quotes.
Ex. triggerTime=’2008-01-01 00:00:00’
If you want to search for a time period, please apply “TO”
operation.
Ex. triggerTime=’2008-01-01 00:00:00’+TO+’2008-01-01
23:59:59’ is to search for records from the start of Jan 1
st
2008 to
the end of Jan 1
st
2008.
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.
VIVOTEK
210 - User's Manual
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
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.
VIVOTEK
User's Manual - 211
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]
Where "state" is 0, 1. “0”
means inactive or normal
state while “1” means
active or triggered state.
Where "nstate" is next
state after duration.
Ex: vi0=1
Setting virtual input 0 to trigger state
Ex: vi0=0(200)1
Setting virtual input 0 to normal state, waiting 200
milliseconds, setting it to trigger state.
Note that when the virtual input is waiting for next state, it
cannot accept new requests.
return <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
VIVOTEK
212 - User's Manual
Request 2 will not be accepted during the execution time(15 seconds).
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 (MP4 and H264), the user needs to input the URL 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
integer>
0 Request cached stream at most how many seconds ago.
tsmode normal,
adaptive
normal Streaming mode:
normal => Full FPS all the time.
adaptive => Default send only I-frame for MP4 and H.264, and
send 1 FPS for MJPEG. If DI or motion window are triggered, the
streaming is changed to send full FPS for 10 seconds.
(*Note: this parameter also works on non-timeshift streams.)
reftime mm:ss The time
camera receives
the request.
Reference time for maxsft and minsft.
(This provides more precise time control to eliminate the
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>
0 How many seconds of cached stream client can accept at least.
(Used by forcechk)
VIVOTEK
User's Manual - 213
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.
Open Anystream (capability.nanystream > 0)
Note: This request requires Viewer access privileges.
Syntax:
For HTTP push server (MJPEG):
http://<servername>/videoany.mjpg?codectype=mjpeg[&resolution=<value>&mjpeg_quant=<value>&mjpeg
_qvalue=<value>&mjpeg_maxframe=<value>]
For RTSP (H264), the user needs to input the URL below into an RTSP compatible player.
rtsp://<servername>/liveany.sdp?codectype=h264[&resolution=<value>&h264_intraperiod=<value>&
h264_ratecontrolmode=<value>& h264_quant=<value>& h264_qvalue=<value>& h264_bitrate=<value>&
h264_maxframe=<value>]
<product dependent>
PARAMETER VALUE DEFAULT DESCRIPTION
codectype mjpeg, h264 N/A Set codec type for Anystream.
solution capability_videoin_resolution <product
dependent>
Video resolution in pixels.
mjpeg_quant 99, 1~5 3 Quality of JPEG video.
0,99 is the customized manual input
setting.
1 = worst quality, 5 = best quality.
mjpeg_qvalue 2~97 50 Manual video quality level input.
(This must be present if mjpeg_quant is
equal to 0, 99)
mjpeg_maxframe 1~25 (5M mode)
1~30 (2M mode)
30 Set maximum frame rate in fps (for JPEG).
h264_intraperiod 250, 500, 1000, 2000, 3000,
4000
1000 Intra frame period in milliseconds.
VIVOTEK
214 - User's Manual
h264_ratecontrolmode cbr, vbr vbr cbr: constant bitrate
vbr: fix quality
h264_quant 99, 1~5 3 Quality of video when choosing vbr in
“h264_ratecontrolmode”.
0,99 is the customized manual input
setting.
1 = worst quality, 5 = best quality.
h264_qvalue 0~51 30 Manual video quality level input.
(This must be present if h264_quant is
equal to 0, 99)
h264_bitrate 20~40000000 8000000 Set bit rate in bps when choosing cbr in
“h264_ratecontrolmode”.
h264_maxframe 1~25 (5M mode)
1~30 (2M mode)
25
30
Set maximum frame rate in fps (for H264).
VIVOTEK
User's Manual - 215
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 zoom,
focus,
auto,
scan,
stop,
positioning
getstatus
Function type
zoom – Move zoom motor
focus – Move focus motor
auto – Perform auto focus
scan – Perform focus scan
stop – Stop current operation
positioning – Position the motors
getstatus – Information of motors, return value as below:
remote_focus_focus_motor_max: Maximum steps of focus motor
remote_focus_zoom_motor_max: Maximum steps of zoom 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_zoom_motor: Current position of zoom motor
remote_focus_focus_enable: Current function of focus motor
remote_focus_zoom_enable: Current function of zoom motor
remote_focus_value_mode: Source of focus value. 0: ISP, 1: Edge.
direction direct,
forward,
backward
Motor’s moving direction.
It works only if function=zoom | focus.
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 or
remote_focus_zoom_motor_max which replied from
"function=getstatus"
VIVOTEK
216 - User's Manual
steps 1 ~ <motor_max> Motor’s moving steps.
It works only if function=zoom | focus and direction=forward |
backward.
<motor_max> is refer to remote_focus_focus_motor_max or
remote_focus_zoom_motor_max which replied from
"function=getstatus"
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
VIVOTEK
User's Manual - 217
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.
VIVOTEK
218 - User's Manual
Technical Specications
Model SD8161
System Information
CPU Multimedia SoC (System-on-Chip)
Flash 256 MB
RAM 512 MB
Camera Features
Image Sensor 1/3" Progressive CMOS
Maximum Resolution 1920 x10 80
Lens Type 18x Optical Zoom, Auto Focus
Focal Length f = 4.7 ~ 84 mm
Aperture F1.6 ~ F2.8
Auto-iris DC-iris
Field of View 4° ~ 61° (Horizontal)
2° ~ 36° (Vertical)
5° ~ 70° (Diagonal)
Shutter Time 1/5 sec. to 1/32,000 sec.
WDR Technology WDR Enhanced
Day/Night Removable IR-cut filter for day & night function
Minimum Illumination 0.72 Lux @ F1.6 (Color)
0.001 Lux @ F1.6 (B/W)
Pan Speed 0.05° ~ 450° / sec
Pan Range 360 endless
Tilt Speed 0.05° ~ 450° / sec
Tilt Range 220° (-110° ~ +110°)
Preset Locations 256 preset locations, 40 presets per tour
Pan/tilt/zoom Functionalities 48x digital zoom (4x on IE plug-in, 12x built-in)
Auto pan mode
Auto patrol mode
On-board Storage MicroSD/SDHC/SDXC card slot
Video
Compression H.264, MJPEG
Maximum Frame Rate 30 fps @ 1920x1080
In both compression modes
Maximum Streams 4 simultaneous streams
S/N Ratio Above 67dB
Dynamic Range 60dB
Video Streaming Adjustable resolution, quality and bitrate
Zoom enhancement for better image quality under limited
bandwidth
Image Settings Adjustable image size, quality and bit rate
Time stamp, text overlay, flip & mirror
Configurable brightness, contrast, saturation, sharpness, white
balance, exposure control, gain, backlight compensation, privacy
masks (Up to 24)
Scheduled profile settings, 3D Noise Reduction
Audio
Audio Capability Audio input/output (full duplex)
Compression AAC, G.711, G.726
Interface External microphone input
External line output
Network
Users Live viewing for up to 10 clients
Protocols IPv4, IPv6, TCP/IP, HTTP, HTTPS, UPnP, RTSP/RTP/RTCP, IGMP,
SMTP, FTP, DHCP, NTP, DNS, DDNS, PPPoE, CoS, QoS, SNMP,
802.1X
Interface 10Base-T/100 BaseTX Ethernet (RJ-45)
ONVIF Supported, specification available at www.onvif.org
Technical Specifications
Compatible Accessories
Intelligent Video
Video Motion Detection Triple-window video motion detection
Auto-Tracking Auto-tracking on moving object
Alarm and Event
Alarm Triggers 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
File upload via HTTP, SMTP, FTP and NAS server
General
Connectors RJ-45 cable connector for Network/PoE connection
Audio input
Audio output
AC 24V power input
DC 12V power input
Digital input*4
Digital output*2
RS-485 for PTZ control (PelcoD protocol, adjustable baud rate
2400~19200)
LED Indicator System power and status indicator
Power Input PoE plus (IEEE 802.3at compliant)
DC 12V
AC 24V
Power Consumption PoE Plus: Max. 25.5W
AC24V/DC12V: Max. 30W
Dimensions Ø: 205 mm x 226 mm
Weight Net: 2330 g
Safety Certifications CE, FCC Class B, VCCI, C-tick, UL
Operating Temperature Starting Temperature: 0°C ~ 50°C (32°F ~ 122°F)
Working Temperature: -10°C ~ 50°C (14°F ~ 122°F)
Warranty 36 months
System Requirements
Operating System Microsoft Windows 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
CD User's manual, quick installation guide, Installation Wizard 2,
ST7501 32-channel recording software
Others Ceiling mount bracket, screws, terminal blocks, quick installation
guide, warranty card, alignment sticker, T25 stardriver, software
CD
Dimensions
Ø205 mm
167 mm
226 mm
Mounting Kits
A M-116 /117
20/40 cm pendant pipe
PoE Solution
Others
AC-213
Smoked cover
A M-118
Indoor pendant head
AM-221
Goose neck mounting kit
AM-519
1.5" PT adapter
AM-104
Recessed Kit
AW-FET-050A-065
4-port Unmanaged
PoE Switch
AP-GIC-010A-030
1xGE IEEE 802.3at
PoE Injector
AM-521
Mounting adapter
AM-231
Parapet mounting kit
6F, No.192, Lien-Cheng Rd., Chung-Ho,
New Taipei City, 235, Taiwan, R.O.C.
T: +886-2-82455282 F: +886-2-82455532
E: sales@vivotek.com
VIVOTEK INC.
2050 Ringwood Avenue,
San Jose, CA 95131
T: 408-773-8686 F: 408-773-8298
VIVOTEK USA
Ver. 4
All specifications are subject to change without notice. Copyright © VIVOTEK INC. All rights reserved.
Randstad 22-133, 1316BW Almere,
The Netherlands
T: +31(0)36 -5298 - 434
E: saleseurope@vivotek.com
VIVOTEK Europe
602, Best sky Tower, Plot No. F-5,
Netaji Subhash Place, Pitam Pura, Delhi-110 034
T: +91-11-45137465
E: salesindia@vivotek.com
VIVOTEK India
VIVOTEK
User's Manual - 219
Technology License Notice
MPEG-4 AAC Technology
THIS PRODUCT IS LICENSED UNDER THE MPEG-4 AAC
AUDIO
PATENT LICENSE. THIS PRODUCT MAY
NOT BE DECOMPILED, REVERSE-ENGINEERED OR COPIED, EXCEPT WITH REGARD TO PC SOFTWARE,
OF WHICH YOU MAY MAKE SINGLE COPIES FOR ARCHIVAL PURPOSES. FOR MORE INFORMATION,
PLEASE REFER TO HTTP://WWW.VIALICENSING.COM.
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.
VIVOTEK
220 - User's Manual
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 A digital device, pursuant
to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against
harmful interference when the equipment is operated in a commercial environment. This equipment
generates, uses, and can radiate radio frequency energy and, if not installed and used in accordance
with the installation manual, may cause harmful interference to radio communications. Operation of this
equipment in a residential area is likely to cause harmful interference, in which case the user will be
required to correct the interference at his own expense.
CE Mark Warning
This is a Class A product. In a domestic environment, this product may cause radio interference, in which
case the user may be required to take adequate measures.
VCCI Warning
この装置は、情報処理装置等電波障害自主規制協議会（ＶＣＣＩ）の基準にづくクラスＢ情報技術装置です。この
装置は、家庭環境で使用することを目的としていますが、この装置がラジオやテレビジョン受信機に近接して使
用されると、受信障害を引き起こすことがあります。
取扱説明書に従って正しい取り扱いをして下さい
Liability
VIVOTEK Inc. cannot be held responsible for any technical or typographical errors and reserves the right
to make changes to the product and manuals without prior notice. VIVOTEK Inc. makes no warranty
of any kind with regard to the material contained within this document, including, but not limited to, the
implied warranties of merchantability and fitness for any particular purpose.
