FD8138-H - Security Camera Vivotek - Free user manual and instructions

Product Type	Indoor Network Camera
Brand	Vivotek
Model	FD8138-H
Image Sensor	1/3" Progressive CMOS
Maximum Resolution	1280 x 800 (1MP)
Lens	Vari-focal, manual focus, f=2.8-12 mm, F1.3-F2.85, P-Iris
Field of View	Horizontal: 33°~87°, Vertical: 21°~54°, Diagonal: 39°~110°
Minimum Illumination	Color: 0.27 Lux @ F1.8; B/W: 0.001 Lux @ F1.8
IR Illuminators	Built-in, effective up to 30 meters, Smart IR, 6 IR LEDs
Day/Night	Removable IR cut filter
WDR	WDR Pro, 110 dB dynamic range
Video Compression	H.264, MJPEG
Maximum Frame Rate	30 fps @ 1280x800 (both codecs)
Simultaneous Streams	3 streams
Audio	Built-in microphone, audio output, full duplex, G.711/G.726
Network Interface	10Base-T/100BaseTX Ethernet (RJ-45)
Power Supply	IEEE 802.3af PoE or DC 12V
Power Consumption	PoE: 9.7 W max; DC 12V: 9.96 W max
On-board Storage	MicroSD/SDHC/SDXC card slot (up to 64 GB)
Dimensions (Ø x H)	135 x 102 mm
Weight	512 g
Operating Temperature	Start: -10°C to 50°C; Working: -20°C to 50°C
Certifications	CE, LVD, FCC Class B, VCCI, C-Tick, UL
Maintenance	Clean with soft dry cloth; do not use solvents
Repairability	SD card slot accessible; factory reset via recessed button

Frequently Asked Questions - FD8138-H Vivotek

How do I reset the camera to factory defaults?

Press and hold the recessed reset button with a straightened paper clip until the status LED rapidly blinks. All settings will be restored to factory defaults, except those you choose to retain (network, DST, custom language, VADP).

What is the maximum resolution and frame rate?

The camera supports up to 1280x800 resolution at 30 fps for both H.264 and MJPEG codecs.

Can I use a PoE switch or do I need a separate power adapter?

Yes, the camera supports IEEE 802.3af PoE, so you can power it via a PoE-enabled switch. Alternatively, you can use a DC 12V power input.

How do I access the camera from the internet?

Connect the camera to a router, enable UPnP port forwarding on the camera, and ensure your router supports UPnP. You can also forward ports manually (HTTP, RTSP) and use the public IP address to access the camera.

Does the camera have night vision?

Yes, it has built-in IR illuminators (6 IR LEDs) effective up to 30 meters with Smart IR technology, and a removable IR cut filter for day/night switching.

What types of storage does the camera support?

It supports MicroSD/SDHC/SDXC cards up to 64 GB for local recording. It also supports NAS and FTP for remote storage.

How many users can view the camera simultaneously?

Up to 10 clients can view live video simultaneously.

What is the field of view?

The horizontal field of view is 33° to 87°, vertical 21° to 54°, and diagonal 39° to 110°, depending on the lens zoom position.

Can I use a external microphone with this camera?

Yes, the camera has an audio input for an external microphone. The built-in microphone is also available. Audio compression options include G.711 and G.726.

What software is included for setup?

The camera comes with Installation Wizard 2 (IW2) for discovering and configuring the camera on the LAN, and ST7501 32-channel recording software.

USER MANUAL FD8138-H Vivotek

Technical line drawings of two VIVO TEK security cameras (no text or symbols on the diagrams)

Table of Contents

Overview......4

Revision History ....4

Read Before Use....5

Package Contents....5

Symbols and Statements in this Document....5

Installation (FD8138-H) 8

Installation (FD8338-HV)....12

Network Deployment....19

Software Installation....23

Ready to Use....24

Accessing the Network Camera 25

Using Web Browsers....25

Using RTSP Players....28

Using 3GPP-compatible Mobile Devices....29

Using VIVOTEK Recording Software....30

Main Page 31

Client Settings....36

Configuration....41

System > General settings ....42

System > Homepage layout ....43

System > Logs ....46

System > Parameters ....47

System > Maintenance....48

Media > Image ....52

Media > Video 59

Media > Video ....61

Media >Audio....68

Network > General settings....69

Network > Streaming protocols ....77

Network > SNMP (Simple Network Management Protocol)....86

Security > User Account....87

Security > HTTPS (Hypertext Transfer Protocol over SSL) 88

Security > Access List ....93

PTZ > PTZ settings .....98

Event > Event settings....102

Applications > Motion detection....117

Applications > DI and DO....120

Applications > Tampering detection ....120

Applications > Audio detection ....121

Applications > VADP (VIVOTEK Application Development Platform) 123

PIR 125

Recording > Recording settings ....126

Local storage > SD card management....131

Local storage > Content management....132

Appendix 135

URL Commands for the Network Camera....135

Technical Specifications 322

Technology License Notice....324

Electromagnetic Compatibility (EMC)....325

Overview

VIVOTEK FD8138-H is a stylish, indoor-style network camera designed for diverse indoor applications. Equipped with a 1MP sensor enabling viewing resolution of 1280x800 at a smooth 30 fps, the camera is an all-in-one indoor camera capable of capturing high quality and high resolution video up to 1 Megapixel, even in low light environment. Providing such a polished image quality, the camera is also designed with VIVOTEK Smart Stream, 3DNR to save notable bandwidth for users.

To emphasize the image quality, the camera also comes with a P-iris lens, which controls the iris with extreme precision with its built-in stepper motor. By using software controls, the lens maintains the iris opening at an optimal level at all times, resulting in superior sharpness and depth of field as well as image quality.

VIVOTEK FD8338-HV is a robust, outdoor-style network camera designed for diverse outdoor applications. Equipped with a 1MP sensor enabling viewing resolution of 1280x800 at a smooth 30 fps, the camera is an all-in-one outdoor camera capable of capturing high quality and high resolution video up to 1 Megapixel, even in low light environment. Providing such a polished image quality, the camera is also designed with VIVOTEK Smart Stream, 3DNR to save notable bandwidth for users.

To meet outdoor applications, the camera is also designed with IP66-rated housing to help the camera body withstand rain and dust and high pressure water jets from any direction while its IK10-rated housing can provide the protection against the vandal act and impact.

Revision History

■ Rev. 1.0: Initial release.

Read Before Use

The use of surveillance devices may be prohibited by law in your country. The Network Camera is not only a high-performance web-ready camera but can also be part of a flexible surveillance system. It is the user's responsibility to ensure that the operation of such devices is legal before installing this unit for its intended use.

It is important to first verify that all contents received are complete according to the Package Contents listed below. Take note of the warnings in the Quick Installation Guide before the Network Camera is installed; then carefully read and follow the instructions in the Installation chapter to avoid damage due to faulty assembly and installation. This also ensures the product is used properly as intended.

The Network Camera is a network device and its use should be straightforward for those who have basic networking knowledge. It is designed for various applications including video sharing, general security/surveillance, etc. The Configuration chapter suggests ways to best utilize the Network Camera and ensure proper operations. For creative and professional developers, the URL Commands of the Network Camera section serves as a helpful reference to customizing existing homepages or integrating with the current web server.

Package Contents

■ FD8138-H, FD8338-HV
■ Alignment sticker
■ Stardriver / Desiccant bag / Double-sided tape (8338)
■ Screws
■ Software CD
■ Quick Installation Guide
■ Waterproof Connector & bushing (8338)

Symbols and Statements in this Document

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.

DI/DO Diagram

Please refer to the following illustration for the connection method.

NOTE:

The maximum output load from the Digital Output pins is 50mA.

Hardware Reset

The reset button is used to reset the system or restore the factory default settings. Sometimes resetting the system can return the camera to normal operation. If the system problems remain after reset, restore the factory settings and install again.

Reset: Press and release the recessed reset button with a straightened paper clip. Wait for the Network Camera to reboot.

Restore: Press and hold the recessed reset button until the status LED rapidly blinks. Note that all settings will be restored to factory default. Upon successful restore, the status LED will blink green and red during normal operation.

Micro SD/SDHC/SDXC Card Capacity

This network camera is compliant with Micro SD/SDHC/SDXC 8/16/32/64GB and other preceding standard SD cards.

LED Definitions

Item LED Status Description
1 Steady Red Power on and system booting
2	Steady Red + blinking Green every 1 sec. (Green LED on for 1 sec and off for another)	Network heartbeat
	Steady Red + Green LED off Network disconnected
3	Blinking Red every 0.15 sec. + Blinking Green every 1 sec. (Red LED on for 0.15 sec. and Green LED on for 1 sec. and off for another)	Upgrading firmware
4	Blinking Red every 0.15 sec. + blinking Green every 0.15 sec	Restoring defaults

Installation (FD8138-H)

1. Jot down the MAC address of the camera for later reference.

Illustration of a hand holding a pen with a numbered circle (number 1) in the background, no text or symbols present.

1. Press the release button on the side to remove the top cover.

1. Attach the alignment sticker to wall, and drill holes on it. Fasten 3 screws half-way into the wall.

Consider the effective range and the shooting angles of the PIR when determining the mounting position of the camera.

1. You may drill a cabling hole for routing the cables. You can then hang the camera to the screws by passing them through the key slot holes.

1. If preferred, connect the DI/DO wires to the terminal blocks.

1. Turn the lens moudle around for the best shooting angle.

7. Assigning an IP Address

7-1. Install the "Installation Wizard 2."
7-2. The program will search for VIVOTEK Video Receivers, Video Servers or Network Cameras on the same LAN.
7-3. Double-click on the camera's MAC address to open a browser management session with the camera.
7-4. With a live image, use the zoom and focus pullers to tune for a best image.

graph TD
    A["VIVOEK"] -->|LAN| B["Laptop"]
    C["Installation Wizard 2"] -->|LAN| B
    D["IW2"] --> E["Installation Wizard 2"]
    E --> F["Modern indoor corridor"]
    style A fill:#f9f,stroke:#333
    style B fill:#ccf,stroke:#333
    style C fill:#cfc,stroke:#333
    style D fill:#fcc,stroke:#333
    style E fill:#cff,stroke:#333
    style F fill:#ffc,stroke:#333

1. Align the release button with the vertical tab, and attach the top cover.

Installation (FD8338-HV)

1. Jot down the MAC address of the camera for later reference.

Illustration of a hand holding a pen with a numbered circle (1) in the corner, no text or symbols present.

1. Use the included stardriver to loosen the anti-tamper screws, and open the dome cover.

1. Remove the waterproof connectors.
2. Pass cables through the rubber seal and cable gland.
3. Strip part of the cable.
4. Use a crimping tool to attach the wires to an RJ45 connector.

The supported cable diameters are shown below.

1. If preferred, connect the DI/DO wires to the terminal block.

# Name

1 Audio_MIC_N

2 EXT_MIC_P

3 Audio_out-

4 Audio_out+

5 DI-

6 DI+

7 DO-

8 DO+

9 12V DC-_IN

10 12V DC+_IN

1. Attach the alignment sticker to wall, and drill holes on it. You may drill a cabling hole for routing the cables.

1. Fasten 3 screws half-way into the wall. You can then hang the camera to the screws by passing them through the key slot holes.

1. If you prefer using a conduit for routing cables, you can attach the side bushing to the cabling indent of the camera. You can use two screws to secure the side bushing.

Use a 3/4" conduit with the camera. Make sure the diameters of the cable gland components are not larger than 35mm.

1. Turn the lens moudle around for the best shooting angle.

1. Assigning an IP Address

12-1. Install the "Installation Wizard 2."
12-2. The program will search for VIVOTEK Video Receivers, Video Servers or Network Cameras on the same LAN.
12-3. Double-click on the camera's MAC address to open a browser management session with the camera.
12-4. With a live image, use the zoom and focus pullers to tune for a best image.

graph TD
    A["VIVSER"] -->|LAN| B["Laptop"]
    B --> C["Installation Wizard 2"]
    C --> D["IW2"]
    D --> E["Installation Wizard 2"]
    E --> F["Browser"]
    F --> G["Transportation Panel"]
    style A fill:#f9f,stroke:#333
    style B fill:#ccf,stroke:#333
    style C fill:#cfc,stroke:#333
    style D fill:#fcc,stroke:#333
    style E fill:#cff,stroke:#333
    style F fill:#ffc,stroke:#333
    style G fill:#fcc,stroke:#333

1. Attach the top cover and secure the anti-tamper screws.

NOTE:

For the outdoor models:

You will find a desiccant bag attached to the dome cover. Replace the desiccant bag included in the camera with the one in the accessory bag.

Network Deployment

General Connection (without PoE)

1. Connect RJ45 Ethernet cable to a switch.

2. Connect the AC cables from the terminal block as an alternate power source. The IO cables are user-supplied.

Power over Ethernet (PoE)

When using a PoE-enabled switch

The Network Camera is PoE-compliant, allowing transmission of power and data via a single Ethernet cable. Follow the below illustration to connect the Network Camera to a PoE-enabled switch via Ethernet cable.

Line drawing of a VIVOEX security camera connected to a device via cable (no text or symbols)

PoE Switch

NOTE:

1. The camera is only to be connected to PoE networks without routing to outside plants.
2. For PoE connection, use only UL listed I.T.E. with PoE output.

- When using a non-PoE switch

Use a PoE power injector (optional) to connect between the Network Camera and a non-PoE switch.

graph TD
    A["VIV6EX"] --> B["Power Injector (optional)"]
    B --> C["Network Switch"]
    C --> D["Device with Power Outlet"]

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 23 for details.

graph TD
    A["Internet"] --> B["Cable or DSL Modem"]
    B --> C["WAN (Wide Area Network) Router IP address : from ISP"]
    C --> D["LAN (Local Area Network) Router IP address : 192.168.0.1"]
    D --> E["IP address : 192.168.0.3\nSubnet mask : 255.255.255.0\nDefault router : 192.168.0.1"]
    D --> F["IP address : 192.168.0.2\nSubnet mask : 255.255.255.0\nDefault router : 192.168.0.1"]

1. In this case, if the Local Area Network (LAN) IP address of your Network Camera is 192.168.0.3, please forward the following ports for the Network Camera on the router.

■ HTTP port: default is 80
■ RTSP port: default is 554
■ RTP port for audio: default is 5558
■ RTCP port for audio: default is 5559
■ RTP port for video: default is 5556
■ RTCP port for video: default is 5557

If you have changed the port numbers on the Network page, please open the ports accordingly on your router. For information on how to forward ports on the router, please refer to your router's user's manual.

1. Find out the public IP address of your router provided by your ISP (Internet Service Provider). Use the public IP and the secondary HTTP port to access the Network Camera from the Internet. Please refer to Network Type on page 70 for details.

Internet connection with static IP

Choose this connection type if you are required to use a static IP for the Network Camera. Please refer to LAN setting on page 69 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 70 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 12	2.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
... ... ...

Configure the router, virtual server or firewall, so that the router can forward any data coming into a preconfigured port number to a network camera on the private network, and allow data from the camera to be transmitted to the outside of the network over the same path.

From Forward to
122.146.57.120:8000 19	2.168.2.10:80
122.146.57.120:8001 19	2.168.2.11:80
... ...

When properly configured, you can access a camera behind the router using the HTTP request as follows: http://122.146.57.120:8000

If you change the port numbers on the Network configuration page, please open the ports accordingly on your router. For example, you can open a management session with your router to configure access through the router to the camera within your local network. Please consult your network administrator for router configuration if you have troubles with the configuration.

For more information with network configuration options (such as that of streaming ports), please refer to Configuration > Network Settings. VIVOTEK also provides the automatic port forwarding feature as an NAT traversal function with the precondition that your router must support the UPnP port forwarding feature.

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.

1. The program will conduct an analysis of your network environment. After your network environment is analyzed, please click Next to continue the program.

1. The program will search for all VIVOTEK network devices on the same LAN.
2. After a brief search, the installer window will prompt. Click on the MAC and model name that matches the one printed on the product label. You can then double-click on the address to open a management session with the Network Camera.

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.

Accessing the Network Camera

This chapter explains how to access the Network Camera through web browsers, RTSP players, 3GPP-compatible mobile devices, and VIVOTEK recording software.

Using Web Browsers

Use Installation Wizard 2 (IW2) to access the Network Cameras on LAN.

If your network environment is not a LAN, follow these steps to access the Network Camera:

1. Launch your web browser (e.g., Microsoft® Internet Explorer or Mozilla Firefox).
2. Enter the IP address of the Network Camera in the address field. Press Enter.
3. The live video will be displayed in your web browser.
4. If it is the first time installing the VIVOTEK network camera, an information bar will prompt as shown below. Follow the instructions to install the required plug-in on your computer.

NOTE:

For Mozilla Firefox users, your browser will use Quick Time to stream the live video. If you don't have Quick Time on your computer, please download it first, then launch the web browser.

▶ By default, the Network Camera is not password-protected. To prevent unauthorized access, it is highly recommended to set a password for the Network Camera.

For more information about how to enable password protection, please refer to Security on page 87.

If you see a dialog box indicating that your security settings prohibit running ActiveX Controls, please enable the ActiveX® Controls for your browser.

1. Choose Tools > Internet Options > Security > Custom Level.

1. Look for Download signed ActiveX® controls; select Enable or Prompt. Click OK.

1. Refresh your web browser, then install the ActiveX® control. Follow the instructions to complete installation.

IMPORTANT:

• Currently the Network Camera utilizes a 32-bit ActiveX plugin. You CAN NOT open a management/view session with the camera using a 64-bit IE browser.
• If you encounter this problem, try execute the lexlore.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\explore.exe
• If you experience compatibility issues between the plug-in control, you may try to uninstall the Camera Stream Controller located in: C:/Program Files (x86)/Camera Stream Controller.

Tips:

1. The onscreen Java control can malfunction under the following situations: A PC connects to different cameras that are using the same IP address (or the same camera running different firmware versions). Removing your browser cookies will solve this problem.

2. If you encounter problems with displaying the configuration menus or UI items, try disable the Compatibility View on IE8 or IE9.

You may also press the F12 key to open the developer tools utility, and then change the Browser Mode to the genuine IE8 or IE9 mode.

Using RTSP Players

To view the streaming media using RTSP players, you can use one of the following players that support RTSP streaming.

Quick Time Player

VLC media player

1. Launch the RTSP player.
2. Choose File > Open URL. A URL dialog box will pop up.
3. The address format is rtsp://:/

As most ISPs and players only allow RTSP streaming through port number 554, please set the RTSP port to 554. For more information, please refer to RTSP Streaming on page 78.

For example:

1. The live video will be displayed in your player.

For more information on how to configure the RTSP access name, please refer to RTSP Streaming on page 78 for details.

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 19.

To utilize this feature, please check the following settings on your Network Camera:

1. Because most players on 3GPP mobile phones do not support RTSP authentication, make sure the authentication mode of RTSP streaming is set to disable. For more information, please refer to RTSP Streaming on page 78.

2. As the bandwidth on 3G networks is limited, you will not be able to use a large video size. Please set the video and audio streaming parameters as listed below. For more information, please refer to Stream settings on page 59.

Video Mode 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

1. As most ISPs and players only allow RTSP streaming through port number 554, please set the RTSP port to 554. For more information, please refer to RTSP Streaming on page 78.

2. Launch the player on the 3GPP-compatible mobile devices.

3. Type the following URL commands into the player. The address format is rtsp://:/. For example:

You can configure Stream #2 into the suggested stream settings as listed above for live viewing on a mobile device.

Using VIVOTEK Recording Software

The product software CD also contains an ST7501 recording software, allowing simultaneous monitoring and video recording for multiple Network Cameras. Please install the recording software; then launch the program to add the Network Camera to the Channel list. For detailed information about how to use the recording software, please refer to the user's manual of the software or download it from http://www.vivotek.com.

Main Page

This chapter explains the layout of the main page. It is composed of the following sections: VIVOTEK INC. Logo, Host Name, Camera Control Area, Configuration Area, Menu, and Live Video Window.

VIVOTEK INC. Logo

Click this logo to visit the VIVOTEK website.

Host Name

The host name can be customized to fit your needs. For more information, please refer to System on page 42.

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 59 for detailed information.

Manual Trigger: Click to enable/disable an event trigger manually. Please configure an event setting on Application page before enable this function. A total of 3 event settings can be configured. For more information about event setting, please refer to page 101. If you want to hide this item on the homepage, please go to Configuration> System > Homepage Layout > General settings > Customized button to deselect "show manual trigger button".

Digital Output: Click to turn the digital output device on or off.

Configuration Area

Client Settings: Click this button to access the client setting page. For more information, please refer to Client Settings on page 36.

Configuration: Click this button to access the configuration page of the Network Camera. It is suggested that a password be applied to the Network Camera so that only the administrator can configure the Network Camera. For more information, please refer to Configuration on page 41.

Language: Click this button to choose a language for the user interface. Language options are available in: English, Deutsch, Español, Français, Italiano, 日本語, Português, 簡体中文, and 繁體中文. Please note that you can also change a language on the Configuration page; please refer to page 41.

Hide Button

You can click the hide button to hide the control panel or display the control panel.

Resize Buttons

Click the Auto button, the video cell will resize automatically to fit the monitor.

Click 100% is to display the original homepage size.

Click 50% is to resize the homepage to 50% of its original size.

Click 25% is to resize the homepage to 25% of its original size.

Live Video Window

■ The following window is displayed when the video mode is set to H.264:

Video Title: The video title can be configured. For more information, please refer to Video Settings on page 52.

H.264 Protocol and Media Options: The transmission protocol and media options for H.264 video streaming. For further configuration, please refer to Client Settings on page 36.

Time: Display the current time. For further configuration, please refer to Media > Image > Genral settings on page 52.

Title and Time: The video title and time can be stamped on the streaming video. For further configuration, please refer to Media > Image > General settings on page 54.

PTZ Panel: This Network Camera supports "digital" (e-PTZ) pan/tilt/zoom control, which allows roaming a smaller view frame within a large view frame. Please refer to PTZ settiings on page 98 for detailed information.

Global View: Click on this item to display the Global View window. The Global View window contains a full view image (the largest frame size of the captured video) and a floating frame (the viewing region of the current video stream). The floating frame allows users to control the e-PTZ function (Electronic Pan/Tilt/Zoom). For more information about e-PTZ operation, please refer to E-PTZ Operation on page 98. For more information about how to set up the viewing region of the current video stream, please refer to page 98.

NOTE:

1. For a megapixel camera, it is recommended to use monitors of the 24" size or larger, and are capable of 1600x1200 or better resolutions.
2. The video input is "muted" by default. To receive audio into from external microphone, you need to enable the audio input from Media > Audio. Refer to page 68 for more information.
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 68 for more information.

NOTE:

Quick Time player only supports playback of H.264 stream, and not the MJPEG stream. In terms of audio codec, Quick Time only supports AAC. Since this camera supports G.711 codec, audio is not available on Quick Time.

The VLC player supports H.264/MPEG-4/MJPEG, and all audio codecs supported by VIVOTEK's cameras.

Video and Audio Control Buttons: Depending on the Network Camera model and Network Camera configuration, some buttons may not be available.

Snapshot: Click this button to capture and save still images. The captured images will be displayed in a pop-up window. Right-click the image and choose Save Picture As to save it in JPEG (*.jpg) or BMP (*.bmp) format.

Digital Zoom: Click and uncheck "Disable digital zoom" to enable the zoom operation. The navigation screen indicates the part of the image being magnified. To control the zoom level, drag the slider bar. To move to a different area you want to magnify, drag the navigation screen.

Pause: Pause the transmission of the streaming media. The button becomes the ▶ Resume button after clicking the Pause button.

Stop: Stop the transmission of the streaming media. Click the Resume button to continue transmission.

Start MP4 Recording: Click this button to record video clips in MP4 file format to your computer. Press the Stop MP4 Recording button to end recording. When you exit the web browser, video recording stops accordingly. To specify the storage destination and file name, please refer to MP4 Saving Options on page 37 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.

■ The following window is displayed when the video mode is set to MJPEG:

Video Title: The video title can be configured. For more information, please refer to Media > Image on page 54.

Time: Display the current time. For more information, please refer to Media > Image on page 54.

Title and Time: Video title and time can be stamped on the streaming video. For more information, please refer to Media > Image on page 54.

Video and Audio Control Buttons: Depending on the Network Camera model and Network Camera configuration, some buttons may not be available.

Snapshot: Click this button to capture and save still images. The captured images will be displayed in a pop-up window. Right-click the image and choose Save Picture As to save it in JPEG (*.jpg) or BMP (*.bmp) format.

Digital Zoom: Click and uncheck "Disable digital zoom" to enable the zoom operation. The navigation screen indicates the part of the image being magnified. To control the zoom level, drag the slider bar. To move to a different area you want to magnify, drag the navigation screen.

Start MP4 Recording: Click this button to record video clips in MP4 file format to your computer. Press the Stop MP4 Recording button to end recording. When you exit the web browser, video recording stops accordingly. To specify the storage destination and file name, please refer to MP4 Saving Options on page 37 for details.

Full Screen: Click this button to switch to full screen mode. Press the "Esc" key to switch back to normal mode.

Client Settings

This chapter explains how to select the stream transmission mode and saving options on the local computer. When completed with the settings on this page, click Save on the page bottom to enable the settings.

H.264 Media Options

H.264 Media Options

Video and Audio
Video Only
Audio Only

Select to stream video or audio data or both. This is enabled only when the video mode is set to H.264.

H.264 Protocol Options

H.264 Protocol Options

○ UDP Unicast
○ UDP Multicast
TCP
HTTP

Depending on your network environment, there are four transmission modes of H.264 streaming:

UDP unicast: This protocol allows for more real-time audio and video streams. However, network packets may be lost due to network burst traffic and images may be broken. Activate UDP connection when occasions require time-sensitive responses and the video quality is less important. Note that each unicast client connecting to the server takes up additional bandwidth and the Network Camera allows up to ten simultaneous accesses.
UDP multicast: This protocol allows multicast-enabled routers to forward network packets to all clients requesting streaming media. This helps to reduce the network transmission load of the Network Camera while serving multiple clients at the same time. Note that to utilize this feature, the Network Camera must be configured to enable multicast streaming at the same time. For more information, please refer to RTSP Streaming on page 78.
TCP: This protocol guarantees the complete delivery of streaming data and thus provides better video quality. The downside of this protocol is that its real-time effect is not as good as that of the UDP protocol.
HTTP: This protocol allows the same quality as TCP protocol without needing to open specific ports for streaming under some network environments. Users inside a firewall can utilize this protocol to allow streaming data through.

Two Way Audio

Select one of the checkboxes to configure the two way audio into the half- or full-duplex mode.

MP4 Saving Options

Users can record live video as they are watching it by clicking Start MP4 Recording on the main page. Here, you can specify the storage destination and file name.

Folder: Specify a storage destination for the recorded video files. The location can be changed.

File name prefix: Enter the text that will be appended to the front of the video file name. A specified folder will be automatically created on your local hard disk.

Add date and time suffix to the file name: Select this option to append the date and time to the end of the file name.

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.

Joystick Settings

Enable Joystick

Connect to the USB plug of the joystick to a USB port on your management computer. Once a USB joystick is connected, the related joystick configuration will be available on the Client settings window. The joystick should work properly without installing any other driver or software.

Then you can begin to configure the joystick settings of connected devices. Please follow the instructions below to enable joystick settings.

1. Click on the Configure buttons button. If your joystick is working properly, it will be displayed on the drop-down list.

Buttons Configuration

In the Joystick Settings window, you can use the combinations of pull-down menus, Actions and Button number, to assign joystick buttons with different functions. The number of buttons may differ from the joystick you attached.

Please follow the steps below to configure your joystick buttons:

1. Select the number of the button you want to configure from its pull-down list. For example: Assign Preset 1 (move to preset 1 position) to Button 1.

1. Select an action from the Actions menu. Click Assign to associate the button with an action.
2. Your configuration will be automatically saved.
3. To disable an assignment, select the number of a button, and then click the Delete button. The associated action will then be cleared.
4. Repeat the above process to assign actions to other buttons. When done, simply close the configuration window.

NOTE:

• If you want to assign Preset actions to your joystick, the PTZ preset locations should be configured in advance.
• If your joystick is not working properly, it may need to be calibrated. Click the Calibrate button to open the Game Controllers window located in Microsoft Windows control panel and follow the instructions for trouble shooting.

• The joystick will appear in the Game Controllers list in the Windows Control panel. If you want to check out for your devices, go to the following page: Start -> Control Panel -> Game Controllers.

- Follow the onscreen instructions to calibrate your joystick.

Configuration

Click Configuration on the main page to enter the camera setting pages. Note that only Administrators can access the configuration page. Please refer to page 87 Security > User Account for how to configure access rights for different users.

Each function on the configuration list will be explained in the following sections.

Navigation Area provides an instant switch among Home page (the monitoring page for live viewing), Configuration page, and multi-language selection.

System > General settings

This section explains how to configure the basic settings for the Network Camera, such as the host name and system time. It is composed of the following two columns: System and System Time.

System

System

Host name:

Mega-Pixel Network Camera

Turn off the LED indicator

Host name: Enter a desired name for the Network Camera. The text will be displayed at the top of the main page.

Turn off the LED indicator: Click to disable the onboard LEDs.

System time

System time

Time zone: GMT+08:00 Beijing, Chongqing, Hong Kong, Kuala Lumpur, Singapore, Taipei

Note: You can upload your daylight saving time rules on Maintenance page or use the camera default value.

Keep current date and time

Synchronize with computer time

Manual

© Automatic

Save

Keep current date and time: Select this option to preserve the current date and time of the Network Camera. The Network Camera's internal real-time clock maintains the date and time even when the power of the system is turned off.

Synchronize with computer time: Select this option to synchronize the date and time of the Network Camera with the local computer. The read-only date and time of the PC is displayed as updated.

Manual: The administrator can enter the date and time manually. Note that the date and time format are [yyyy/mm/dd] and [hh:mm:ss].

Automatic: The Network Time Protocol is a protocol which synchronizes computer clocks by periodically querying an NTP Server.

NTP server: Assign the IP address or domain name of the time-server. Leaving the text box blank connects the Network Camera to the default time servers.

Update interval: Select to update the time using the NTP server on an hourly, daily, weekly, or monthly basis.

Time zone : Select the appropriate time zone from the list. If you want to upload Daylight Savings Time rules, please refer to System > Maintenance > Import/ Export files on page 49 for details.

This section explains how to set up your own customized homepage layout.

General settings

This column shows the settings of your homage layout. You can manually select the background and font colors in Theme Options (the second tab on this page). The settings will be displayed automatically in this Preview field. The following shows the homepage using the default settings:

■ Hide Powered by VIVOTEK: If you check this item, it will be removed from the homepage.

Logo graph

Here you can change the logo that is placed at the top of your homepage.

Follow the steps below to upload a new logo:

1. Click Custom and the Browse field will appear.
2. Select a logo from your files.
3. Click Upload to replace the existing logo with a new one.
4. Enter a website link if necessary.
5. Click Save to enable the settings.

Customized button

If you want to hide manual trigger buttons on the homepage, please uncheck this item. This item is checked by default. Customized button

Theme Options

Here you can change the color of your homepage layout. There are three types of preset patterns for you to choose from. The new layout will simultaneously appear in the Preview filed. Click Save to enable the settings.

■ Follow the steps below to set up the customed homepage:

1. Click Custom on the left column.
2. Click the field where you want to change the color on the right column.

1. The palette window will pop up as shown below.

1. Drag the slider bar and click on the left square to select a desired color.
2. The selected color will be displayed in the corresponding fields and in the Preview column.
3. Click Save to enable the settings.

System > Logs

This section explains how to configure the Network Camera to send the system log to a remote server as backup.

Log server settings

Follow the steps below to set up the remote log:

1. Select Enable remote log.
2. In the IP address text box, enter the IP address of the remote server.
3. In the port text box, enter the port number of the remote server.
4. When completed, click Save to enable the setting.

You can configure the Network Camera to send the system log file to a remote server as a log backup. Before utilizing this feature, it is suggested that the user install a log-recording tool to receive system log messages from the Network Camera. An example is Kiwi Syslog Daemon. Visit http://www.kiwisyslog.com/kiwi-syslog-daemon-overview/.

System log

This column displays the system log in a chronological order. The system log is stored in the Network Camera's buffer area and will be overwritten when reaching a certain limit.

Access log

System log Access log

Jan 5 11:36:28 [RTSP SERVER]: Start one session, IP=172.16.2.52
Jan 5 11:49:15 [RTSP SERVER]: Start one session, IP=192.168.4.105
Jan 5 13:11:20 [RTSP SERVER]: Start one session, IP=192.168.4.105 

Access log displays the access time and IP address of all viewers (including operators and administrators) in a chronological order. The access log is stored in the Network Camera's buffer area and will be overwritten when reaching a certain limit.

System > Parameters

The View Parameters page lists the entire system's parameters. If you need technical assistance, please provide the information listed on this page.

Parameters

system_hostname='Mega-Pixel Network Camera'
system_ledoff='0'
system_lowlight='1'
system_date='2014/12/01'
system_time='10:57:21'
system_datetime�'
system_ntp='
system_timezonetimezoneindex='320'
system_daylight_enable='0'
system_daylight_dstactualmode='1'
system_daylight_auto_begintime='NONE'
system_daylight_auto_endtime='NONE'
system_daylight_timezones=',-360,-320,-280,-240,-241,-200,-201,-160
system_updateinterval='0'
system_info_modelname='FD8338-H'
system_info_extendedmodelname='FD8338-H'
system_info_serialnumber='0002D12F9948'
system_info_firmwareversion='FD8338-VVTK-0100b3'
system_info_language_count='9'
system_info_language_i0='English'
system_info_language_i1='Deutsch'
system_info_language_i2='Español'
system_info_language_i3='Français'
system_info_language_i4='Italiano'
system_info_language_i5='日本語'
system_info_language_i6='Português'
system_info_language_i7='简体中文'
system_info_language_i8='繁體中文'
system_info_language_i9= 

System > Maintenance

This chapter explains how to restore the Network Camera to factory default, upgrade firmware version, etc.

General settings > Upgrade firmware

Upgrade firmware

Select firmware file:

Browse.

Upgrade

This feature allows you to upgrade the firmware of your Network Camera. It takes a few minutes to complete the process.

Note: Do not power off the Network Camera during the upgrade!

Follow the steps below to upgrade the firmware:

1. Download the latest firmware file from the VIVOTEK website. The file is in .pkg file format.
2. Click Browse... and specify the firmware file.
3. Click Upgrade. The Network Camera starts to upgrade and will reboot automatically when the upgrade completes.

If the upgrade is successful, you will see "Reboot system now!! This connection will close". After that, re-access the Network Camera.

The following message is displayed when the upgrade has succeeded.

Reboot system now!!

This connection will close.

The following message is displayed when you have selected an incorrect firmware file.

Starting firmware upgrade...

Do not power down the server during the upgrade.

The server will restart automatically after the upgrade is completed.

This will take about 1 - 5 minutes.

Wrong PKG file format

Unpack fail

General settings > Reboot

Reboot

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.

The device is rebooting now. Your browser will reconnect to http://192.168.5.151:80/ If the connection fails, please manually enter the above IP address in your browser.

If the connection fails after rebooting, manually enter the IP address of the Network Camera in the address field to resume the connection.

General settings > Restore

Restore

Restore all settings to factory default except settings in

Network

Daylight saving time

Custom language

VADP

Restore

This feature allows you to restore the Network Camera to factory default settings.

Network: Select this option to retain the Network Type settings (please refer to Network Type on page 70).

Daylight Saving Time: Select this option to retain the Daylight Saving Time settings (please refer to Import/Export files below on this page).

Custom Language: Select this option to retain the Custom Language settings.

VADP: Retain the VADP modules (3rd-party software stored on the SD card) and related settings.

If none of the options is selected, all settings will be restored to factory default. The following message is displayed during the restoring process.

The device is rebooting now. Your browser will reconnect to http://192.168.5.151:80/ If the connection fails, please manually enter the above IP address in your browser.

Import/Export files

This feature allows you to Export / Update daylight saving time rules, custom language file, configuration file, and server status report.

General settings

Import/Export files

Export files

Export daylight saving time configuration file

Export language file

Export configuration file

Export server status report

Export

Export

Export

Export

Upload files

Update daylight saving time rules:

Update custom language file:

Upload configuration file:

Browse... | Upload

Browse... | Upload

Browse... Upload

Export daylight saving time configuration file: Click to set the start and end time of DST (Daylight Saving).

Follow the steps below to export:

1. In the Export files column, click Export to export the daylight saving time configuration file from the Network Camera.

2. A file download dialog will pop up as shown below. Click Open to review the XML file or click Save to store the file for editing.

1. Open the file with Microsoft ^® Notepad and locate your time zone; set the start and end time of DST. When completed, save the file.

In the example below, DST begins each year at 2:00 a.m. on the second Sunday in March and ends at 2:00 a.m. on the first Sunday in November.

Update daylight saving time rules: Click Browse... and specify the XML file to update.

If the incorrect date and time are assigned, you will see the following warning message when uploading the file to the Network Camera.

The following message is displayed when attempting to upload an incorrect file format.

Export language file: Click to export language strings. VIVOTEK provides nine languages: English, Deutsch, Español, Français, Italiano, 日本語, Português, 簡体中文, and 繁體中文.

Update custom language file: Click Browse... and specify your own custom language file to upload.

Export configuration file: Click to export all parameters for the device and user-defined scripts.

Update configuration file: Click Browse... to update a configuration file. Please note that the model and firmware version of the device should be the same as the configuration file. If you have set up a fixed IP or other special settings for your device, it is not suggested to update a configuration file.

Export server staus report: Click to export the current server status report, such as time, logs, parameters, process status, memory status, file system status, network status, kernel message ... and so on.

Tips:

- If a firmware upgrade is accidentally disrupted, say, by a power outage, you still have a last resort method to restore normal operation. See the following for how to bring the camera back to work:

Applicable scenario:

(1) Power disconnected during firmware upgrade.
(2) Unknown reason causing abnormal LED status, and a Restore cannot recover normal working condition.

You can use the following methods to activate the camera with its backup firmware:

(1) Press and hold down the reset button for at least one minute.
(2) Power on the camera until the Red LED blinks rapidly.
(3) After boot up, the firmware should return to the previous version before the camera hanged. (The procedure should take 5 to 10 minutes, longer than the normal boot-up process). When tthis process is completed, the LED status should return to normal.

Media > Image

This section explains how to configure the image settings of the Network Camera. It is composed of the following four columns: General settings, Picture settings, Exposure, and Privacy mask.

General settings

Video title

Show timestamp and video title in video and snapshots: Enter a name that will be displayed on the title bar of the live video as the picture shown below.

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.

Color: Select to display color or black and white video streams.

Power line frequency: Set the power line frequency consistent with local utility settings to eliminate image flickering associated with fluorescent lights. Note that after the power line frequency is changed, you must disconnect and reconnect the power cord of the Network Camera in order for the new setting to take effect.

Video orientation: Flip--vertically reflect the display of the live video; Mirror--horizontally reflect the display of the live video. Select both options if the Network Camera is installed upside-down (e.g., on the ceiling) to correct the image orientation. Please note that if you have preset locations, those locations will be cleared after flip/mirror setting.

IR cut filter

With a removable IR-cut filter, this Network Camera can automatically remove the filter to let IR light into the sensor during low light conditions.

■ Auto mode
The Network Camera automatically removes the filter by judging the level of ambient light.
■ Day mode
In day mode, the Network Camera switches on the IR cut filter at all times to block infrared light from reaching the sensor so that the colors will not be distorted.
■ Night mode
In night mode, the Network Camera switches off the IR cut filter at all times for the sensor to accept infrared light, thus helping to improve low light sensitivity.
■ Synchronize with digital input
The Network Camera automatically removes the IR cut filter when a Digital Input is triggered.
■ Schedule mode
The Network Camera switches between day mode and night mode based on a specified schedule. Enter the start and end time for day mode. Note that the time format is [hh:mm] and is expressed in 24-hour clock time. By default, the start and end time of day mode are set to 07:00 and 18:00.

Light sensor sensitivity

Select Low, Normal, or High sensitivity for the light sensor.

Image settings

On this page, you can tune the White balance, Image adjustment and WDR enhanced .

White balance: Adjust the value for the best color temperature.

■ You may follow the steps below to adjust the white balance to the best color temperature.

1. Place a sheet of paper of white or cooler-color temperature paper, such as blue, in front of the lens, then allow the Network Camera to automatically adjust the color temperature.
2. Click the On button to Fix current value and confirm the setting while the white balance is being measured.

■ You may also manually tune the color temperature by pulling the RGain and BGain slide bards.

Image Adjustment

■ Brightness: Adjust the image brightness level, which ranges from -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%.

Enable 3D noise reduction

■ Enable 3D noise reduction: Check to enable noise reduction in order to reduce noises and flickers in image. This applies to the onboard 3D Noise Reduction feature. Use the pull-down menu to adjust the reduction strength. Note that applying this function to the video channel will consume system computing power.

3D Noise Reduction is mostly applied in low-light conditions. When enabled in a low-light condition with fast moving objects, trails of after-images may occur. You may then select a lower strength level or disable the function.

Note that the Preview button has been cancelled, all changes made to image settings is directly shown on screen. You can click Restore to recall the original settings without incorporating the changes. When completed with the settings on this page, click Save to enable the setting. You can also click on Profile to adjust all settings above in a pop-up window for special lighting conditions.

Activated period: Select the mode this profile to apply to: Day mode, Night mode, or Schedule mode. Please manually enter a range of time if you choose Schedule mode. Then check Save to take effect.

Exposure

On this page, you can set the Measurement window, Exposure level, Exposure mode, and Iris mode. Detailed configurations will be automatically adjusted since the sensor library will automatically adjust the value according to the ambient light.

Measurement Window: This function allows users to configure measurement window(s) for low light compensation.

■ Full view: Calculate the full range of view and offer appropriate light compensation.

■ Custom: This option allows you to manually add specific windows as measuring areas. The measuring window refers to "weighed window" where the lighting condition within the particular area is taken into account. Camera firmware then adopts the weighed averages method to calculate the value.

A total of 9 inclusive and exclusive windows can be created for a view. You can create Exclude windows for the camera to ignore the lighting condition of certain areas.

Note that the title pane of the Include/Exclude windows is not included into the calculation.

■ BLC: When selected, a BLC window will appear on screen meaning that the center of the scene will be taken as a weighed area. This option enables light compensation for images that are too dark or too bright to recognize; for example, for the dark side of objects that is posed against bright sunlight.

Exposure control:

■ Exposure level: You can manually set the Exposure level, which ranges from 0 to 8 (dark to bright). Available when the WDR function is disabled.

- Iris adjustment: Select the round tab on the slide bar to adjust the iris open size according to the light source of the surroundings. A smaller iris size times results in less light entering the lens and sensor.

■ Maximum gain Control: You can manually set the AGC level. However, high gain control value would generate a certain amount of noises.

■ WDR Pro : When enabled, you can select the strength of the WDR function. The Low, Medium, High options correspond to the level of contrast between the overly-lit area and the shaded areas. For example, the High option applies to a high contrast scenario. Note that when the exposure time is set to longer than 1/60 second, the WDR function will be disabled.

You can click Restore to recall the original settings without incorporating the changes. When completed with the settings on this page, click Save to enable the settings.

If you want to configure another sensor setting for day/night/schedule mode, please click Profile to open the Profile of exposure settings page as shown below.

Activated period: Select the mode this profile to apply to: Day mode, Night mode, or Schedule mode. Please manually enter a range of time if you choose Schedule mode. Then check Save to take effect.

Please follow the steps below to setup a profile:

1. Check Enable this profile.
2. Select the applied mode: Day mode, Night mode, or Schedule mode. Please manually enter a range of time if you choose Schedule mode.
3. Configure Exposure control settings in the following columns. Please refer to previous discussions for detailed information.
4. Click Save to enable the setting and click Close to exit the page.

Privacy mask

Click Privacy Mask to open the settings page. On this page, you can block out sensitive zones to address privacy concerns.

■ To set the privacy mask windows, follow the steps below:

1. Click New to add a new window.
2. You can use the mouse cursor to size and drag-drop the window, which is recommended to be at least twice the size of the object (height and width) you want to cover.
3. Enter a Window Name and click Save to enable the setting.
4. Click on the Enable privacy mask checkbox to enable this function.

NOTE:

▶ Up to 5 privacy mask windows can be set up on the same screen.
▶ If you want to delete the privacy mask window, please click the 'x' on the upper right corner of the window.

Media > Video

Stream settings

This Network Camera supports multiple streams with frame size ranging from 176 x 144 to 1280 x 800 pixels.

The definition of multiple streams:

■ Stream 1: Users can define the "Region of Interest" (viewing region) and the "Output Frame Size" (size of the live view window).
■ Stream 2: The default frame size for Stream 2 is set to the minimized 640 x 360 for viewing on mobile devices.
■ Stream 3: Stream 3 does not support the "Region of Interest" configuration.

Click Viewing Window to open the viewing region settings page. On this page, you can set the Region of Interest and the Output Frame Size for streams 1 and 2.

Please follow the steps below to set up those settings for a stream:

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

Click Viewing Window to open the viewing region settings page. On this page, you can configure the Region of Interest and the Output Frame Size for streams 1. For example, you can crop only a portion of the image that is of your interest, and thus save the bandwidth needed to transmit the video stream. As the picture shown below, the area of your interest in a parking lot should the vehicles. The blue sky is of little value for the surveillance purpose.

Exterior view of a large parking lot with numerous parked cars under a cloudy sky, including inset images labeled VGA and 2MP (no signage or text on vehicles)

NOTE:

▶ All the items in the “Region of Interest” should not be larger than the “Output Frame Size” (current maximum resolution).
■ The parameters of the multiple streams:

	Region of Interest Output frame size
Stream 1 1280 X 800 ~ 176 x 144 (Selectable)	1280 X 800 ~ 176 x 144 (Selectable)
Stream 2 1280 X 800 ~ 176 x 144 (Selectable)	1280 X 800 ~ 176 x 144 (Selectable)
	fixed fixed

When completed with the settings in the Viewing Window, click Save to enable the settings and click Close to exit the window. The selected Output Frame Size will immediately be applied to the Frame size of each video stream. Then you can go back to the home page to test the e-PTZ function. For more information about the e-PTZ function, please refer to page 98.

Output Frame Size (Size of the Live View Window)

Click the stream item to display the detailed information. The maximum frame size will follow your settings in the above Viewing Window sections.

This Network Camera offers real-time H.264 and MJPEG compression standards (Dual Codec) for real-time viewing. If H.264 mode is selected, the video is streamed via RTSP protocol. There are several parameters for you to adjust the video performance:

■ Frame size

You can set up different video resolution for different viewing devices. For example, set a smaller frame size and lower bit rate for remote viewing on mobile phones and a larger video size and a higher bit rate for live viewing on web browsers. Note that a larger frame size takes up more bandwidth.

■ Maximum frame rate

This limits the maximum refresh frame rate per second. Set the frame rate higher for smoother video quality and for recognizing moving objects in the field of view.

If the power line frequency is set to 50Hz, the frame rates are selectable at 1fps, 2fps, 3fps, 5fps, 8fps, 10fps, 15fps, 20fps, and 25fps. If the power line frequency is set to 60Hz, the frame rates are selectable at 1fps, 2fps, 3fps, 5fps, 8fps, 10fps, 15fps, 20fps, 25fps, and 30fps. You can also select Customize and manually enter a value.

The frame rate will decrease if you select a higher resolution.

■ Intra frame period

Determine how often to plant an I frame. The shorter the duration, the more likely you will get better video quality, but at the cost of higher network bandwidth consumption. Select the intra frame period from the following durations: 1/4 second, 1/2 second, 1 second, 2 seconds, 3 seconds, and 4 seconds.

■ Video quality

Constant bit rate:

- Constant bit rate: A complex scene generally produces a larger file size, meaning that higher bandwidth will be needed for data transmission. The bandwidth utilization is configurable to match a selected level, resulting in mutable video quality performance. The bit rates are selectable at the following rates: 20Kbps, 30Kbps, 40Kbps, 50Kbps, 64Kbps, 128Kbps, 256Kbps, 512Kbps, 768Kbps, 1Mbps, 2Mbps, 3Mbps, 4Mbps, 6Mbps, 8Mbps, 10Mbps, 12Mbps, 14Mbps, and 16Mbps. You can also select Customize and manually enter a value.

- Target bit rate: select a bit rate from the pull-down menu. The bit rate ranges from 20kbps to a maximum of 8Mbps. The bit rate then becomes the Average or Upper bound bit rate number. The Network Camera will strive to deliver video streams around or within the bit rate limitation you impose.

- Policy: If Frame Rate Priority is selected, the Network Camera will try to maintain the frame rate per second performance, while the image quality will be compromised. If Image quality priority is selected, the Network Camera may drop some video frames in order to maintain image quality.

- Fixed quality: On the other hand, if Fixed quality is selected, all frames are transmitted with the same quality; bandwidth utilization is therefore unpredictable. The video quality can be adjusted to the following settings: Medium, Standard, Good, Detailed, and Excellent. You can also select Customize and manually enter a value.

- Maximum bit rate: With the guaranteed image quality, you might still want to place a bit rate limitation to control the size of video streams for bandwidth and storage concerns. The configurable bit rate starts from 1Mbps to 40Mbps.

The Maximum bit rate setting in the Fixed quality configuration can ensure a reasonable and limited use of network bandwidth. For example, in low light conditions where a Fixed quality setting is applied, video packet sizes can tremendously increase when noises are produced with electrical gain.

You may also manually enter a bit rate number by selecting the Customized option.

- Smart stream:

Smart stream can effectively reduce the video packet size while maintaining good video quality in the selected areas of your interest. When properly configured, Smart stream can reduce the stream size to half or even lower.

Unfold the Smart stream configuration menu by selecting the Smart stream checkbox. You can then configure the following parameters:

• Foreground quality: Foreground is the area of your interest where you want to maintain its video quality. The quality can be: Customized, Medium, Standard, Good, Detailed, or Excellent. Note that the Customized number refers to the video compression rate. The larger the number, higher the compression rate, and thus results in lower quality.
• Background quality: Background is the area that is less important on the scene, such as the building in the below drawing. You can configure the camera to produce a lower-quality display for this area. The background quality can be: Customized, Medium, Standard, Good, Detailed, or Excellent.
• Maximum bit rate: This is an upper threshold on the bit rate per second for producing and transmitting the Smart stream video. It is configurable from 1Mbps to 40Mbps. You can also manually enter a number (in kbps).

- Mode:

• Auto: When set to Auto, only the moving objects and the areas around them will be displayed with the Foreground quality. The rest of the screen will be displayed with the Background (lower) quality.
• Manual: When selected, the Manual window setting option will be displayed. Click on it to display the setting window. You can then manually allocate the regions of your interest on the current field of view. Click New, drag, and pull the window to cover the regions of your interest. Note that the title bar on each window is not taken into account when setting the Foreground areas.

You can create up to 3 ROI windows. Click Save to preserve your setting and click Close to finish the configuration.

Maximum bit rate:

Mode:

40 Mbps

Auto and Manual

Manual window setting

Auto 100%

graph TD
    A["New"] --> B["Restore"]
    A --> C["Close"]
    A --> D["Save"]

- Hybrid: When enabled, moving objects in the Background areas will also be displayed using the Foreground (better) quality.

Note the following with the Smart stream setting:

1. When using the "Auto" or "Hybrid" modes, up to 30 moving objects can be displayed using the Foreground quality.
2. The Smart stream will not be so effective in terms of bandwidth saving when applied in a complex scene where there are objects moving constantly all over the screen.
3. You can compare the bit rates of video streaming with or without the Smart stream configuration by viewing the network traffic information. For example, you can see the information using the VLC player's Media Information > Statistics.
4. Smart stream is only configurable with H.264 and streams #1 to #3.

If JPEG mode is selected, the Network Camera sends consecutive JPEG images to the client, producing a moving effect similar to a filmstrip. Every single JPEG image transmitted guarantees the same image quality, which in turn comes at the expense of variable bandwidth usage. Because the media contents are a combination of JPEG images, no audio data is transmitted to the client. There are three parameters provided in MJPEG mode to control the video performance:

■ Frame size

You can set up different video resolution for different viewing devices. For example, set a smaller frame size and lower bit rate for remote viewing on mobile phones and a larger video size and a higher bit rate for live viewing on web browsers. Note that a larger frame size takes up more bandwidth.

■ Maximum frame rate

This limits the maximum refresh frame rate per second. Set the frame rate higher for smoother video quality.

If the power line frequency is set to 50Hz, the frame rates are selectable at 1fps, 2fps, 3fps, 5fps, 8fps, 10fps, 15fps, 20fps, and 25fps. If the power line frequency is set to 60Hz, the frame rates are selectable at 1fps, 2fps, 3fps, 5fps, 8fps, 10fps, 15fps, 20fps, 25fps, and 30fps. You can also select Customize and manually enter a value. The frame rate will decrease if you select a higher resolution.

■ Video quality

Refer to the previous page setting an average or upper bound threshold for controlling the bandwidth consumed for transmitting motion jpegs. The configuration method is identical to that for H.264.

NOTE:

▶ Video quality and fixed quality refers to the compression rate, so a lower value will produce higher quality.
▶ Converting high-quality video may significantly increase the CPU load, and you may encounter streaming disconnection or video loss while capturing a complicated scene. In the event of occurrence, we suggest you customize a lower video resolution or reduce the frame rate to obtain smooth video.

Media > Audio

Audio Settings

Mute: Select this option to disable audio transmission from the Network Camera to all clients. Note that if muted, no audio data will be transmitted even if audio transmission is enabled on the Client Settings page. In that case, the following message is displayed:

External microphone input gain: Select the gain of the external audio input according to ambient conditions. Adjust the gain from 100% (most sensitive) to 0% (least sensitive).

Audio type: Select audio codec AAC or GSM-AMR and the bit rate.

■ 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.

Network > General settings

This section explains how to configure a wired network connection for the Network Camera.

Network Type

LAN

Select this option when the Network Camera is deployed on a local area network (LAN) and is intended to be accessed by local computers. The default setting for the Network Type is LAN. Remember to click Save when you complete the Network setting.

Get IP address automatically: Select this option to obtain an available dynamic IP address assigned by the DHCP server each time the camera is connected to the LAN.

Use fixed IP address: Select this option to manually assign a static IP address to the Network Camera.

1. You can make use of VIVOTEK Installation Wizard 2 on the software CD to easily set up the Network

Camera on LAN. Please refer to Software Installation on page 23 for details.

1. Enter the Static IP, Subnet mask, Default router, and Primary DNS provided by your ISP.

Subnet mask: This is used to determine if the destination is in the same subnet. The default value is "255.255.255.0".

Default router: This is the gateway used to forward frames to destinations in a different subnet. Invalid router setting will fail the transmission to destinations in different subnet.

Primary DNS: The primary domain name server that translates hostnames into IP addresses.

Secondary DNS: Secondary domain name server that backups the Primary DNS.

Primary WINS server: The primary WINS server that maintains the database of computer names and IP addresses.

Secondary WINS server: The secondary WINS server that maintains the database of computer names and IP addresses.

Enable UPnP presentation: Select this option to enable UPnP ^TM presentation for your Network Camera so that whenever a Network Camera is presented to the LAN, shortcuts of connected Network Cameras will be listed in My Network Places. You can click the shortcut to link to the web browser. Currently, UPnP ^TM 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 ^™ and it is activated.

PPPoE (Point-to-point over Ethernet)

Select this option to configure your Network Camera to make it accessible from anywhere as long as there is an Internet connection. Note that to utilize this feature, it requires an account provided by your ISP.

Follow the steps below to acquire your Network Camera's public IP address.

1. Set up the Network Camera on the LAN.
2. Go to Configuration > Event > Event settings > Add server (please refer to Add server on page 107) to add a new email or FTP server.
3. Go to Configuration > Event > Event settings > Add media (please refer to Add media on page 112).
   Select System log so that you will receive the system log in TXT file format which contains the Network Camera's public IP address in your email or on the FTP server.
4. Go to Configuration > Network > General settings > Network type. Select PPPoE and enter the user name and password provided by your ISP. Click Save to enable the setting.

1. The Network Camera will reboot.
2. Disconnect the power to the Network Camera; remove it from the LAN environment.

NOTE:

▶ If the default ports are already used by other devices connected to the same router, the Network Camera will select other ports for the Network Camera.
If UPnP ^TM is not supported by your router, you will see the following message: Error: Router does not support UPnP port forwarding.
▶ Steps to enable the UPnP ^TM user interface on your computer: Note that you must log on to the computer as a system administrator to install the UPnP ^TM components.

1. Go to Start, click Control Panel, then click Add or Remove Programs.

1. In the Add or Remove Programs dialog box, click Add/Remove Windows Components.

1. In the Windows Components Wizard dialog box, select Networking Services and click Details.

1. In the Networking Services dialog box, select Universal Plug and Play and click OK.

1. Click Next in the following window.

1. Click Finish. UPnP ^TM is enabled.

▶ How does UPnP ^TM work?

UPnP ^TM networking technology provides automatic IP configuration and dynamic discovery of devices added to a network. Services and capabilities offered by networked devices, such as printing and file sharing, are available among each other without the need for cumbersome network configuration. In the case of Network Cameras, you will see Network Camera shortcuts under My Network Places.

Enabling UPnP port forwarding allows the Network Camera to open a secondary HTTP port on the router-not HTTP port-meaning that you have to add the secondary HTTP port number to the Network Camera's public address in order to access the Network Camera from the Internet. For example, when the HTTP port is set to 80 and the secondary HTTP port is set to 8080, refer to the list below for the Network Camera's IP address.

From the Internet 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 49 for details. After the Network Camera is reset to factory default, it will be accessible on the LAN.

Enable IPv6

Select this option and click Save to enable IPv6 settings.

Please note that this only works if your network environment and hardware equipment support IPv6. The browser should be Microsoft® Internet Explorer 6.5, Mozilla Firefox 3.0 or above.

When IPv6 is enabled, by default, the network camera will listen to router advertisements and be assigned with a link-local IPv6 address accordingly.

IPv6 Information: Click this button to obtain the IPv6 information as shown below.

If your IPv6 settings are successful, the IPv6 address list will be listed in the pop-up window. The IPv6 address will be displayed as follows:

Refers to Ethernet

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:

1. Press Enter on the keyboard or click Refresh button to refresh the webpage. For example:

NOTE:

▶ If you have a Secondary HTTP port (the default value is 8080), you can also link to the webpage in the following address format: (Please refer to HTTP streaming on page 77 for detailed information.)

▶ If you choose PPPoE as the Network Type, the [PPP0 address] will be displayed in the IPv6 information column as shown below.

Manually setup the IP address: Select this option to manually set up IPv6 settings if your network environment does not have DHCPv6 server and router advertisements-enabled routers.

If you check this item, the following blanks will be displayed for you to enter the corresponding information:

√ Enable IPv6

IPv6 information

√ Manually setup the IP address

Optional IP address / Prefix length

Optional default router

Optional primary DNS

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 36 and Stream settings on page 59.

graph TD
    A["America"] -->|Audio transmitted from operators| B["Taiwan"]
    B --> C["Operator with camera"]
    C -->|Audio transmitted to operators| D["Computer"]
    D --> E["Desktop with monitor"]
    E --> F["Smartphone with phone"]
    F --> G["User at desk"]

Audio is being transmitted to the Network Camera

Click to enable audio transmission to the Network Camera; click to adjust the volume of microphone; click to turn off the audio. To stop talking, click again.

FTP port: The FTP server allows the user to save recorded video clips. You can utilize VIVOTEK's Installation Wizard 2 to upgrade the firmware via FTP server. By default, the FTP port is set to 21. It also can be assigned to another port number between 1025 and 65535.

Network > Streaming protocols

HTTP streaming

To utilize HTTP authentication, make sure that your have set a password for the Network Camera first; please refer to Security > User account on page 87 for details.

Authentication: Depending on your network security requirements, the Network Camera provides two types of security settings for an HTTP transaction: basic and digest.

If basic authentication is selected, the password is sent in plain text format and there can be potential risks of being intercepted. If digest authentication is selected, user credentials are encrypted using MD5 algorithm and thus provide better protection against unauthorized accesses.

HTTP port / Secondary HTTP port: By default, the HTTP port is set to 80 and the secondary HTTP port is set to 8080. They can also be assigned to another port number between 1025 and 65535. If the ports are incorrectly assigned, the following warning messages will be displayed:

To access the Network Camera on the LAN, both the HTTP port and secondary HTTP port can be used to access the Network Camera. For example, when the HTTP port is set to 80 and the secondary HTTP port is set to 8080, refer to the list below for the Network Camera's IP address.

On the LAN

http://192.168.4.160 or

http://192.168.4.160:8080

Access name for stream 1 \~ 3: This Network camera supports multiple streams simultaneously. The access name is used to differentiate the streaming source. Users can click Media > Video > 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 59.

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.

URL command -- http://:/ For example, when the Access name for stream 2 is set to video2.mjpg:

1. Launch Mozilla Firefox or Netscape.
2. Type the above URL command in the address bar. Press Enter.
3. The JPEG images will be displayed in your web browser.

Wide bridge over water with traffic, modern buildings in background under clear sky (no visible text or symbols)

NOTE:

▶ Microsoft® Internet Explorer does not support server push technology; therefore, using http://:/ will fail to access the Network Camera.
▶ Users can only use URL commands to request the stream 5. For more information about URL commands, please refer to page 135.

RTSP Streaming

To utilize RTSP streaming authentication, make sure that you have set a password for controlling the access to video stream first. Please refer to Security > User account on page 87 for details.

Authentication: Depending on your network security requirements, the Network Camera provides three types of security settings for streaming via RTSP protocol: disable, basic, and digest.

If basic authentication is selected, the password is sent in plain text format, but there can be potential risks of it being intercepted. If digest authentication is selected, user credentials are encrypted using MD5 algorithm, thus providing better protection against unauthorized access.

The availability of the RTSP streaming for the three authentication modes is listed in the following table: Quick Time Player Real Player

	Quick Time player Real Player
Disable O O
Basic O O
Digest O X

Access name for stream 1 \~ 3: This Network camera supports multiple streams simultaneously. The access name is used to differentiate the streaming source.

If you want to use an RTSP player to access the Network Camera, you have to set the video mode to H.264 and use the following RTSP URL command to request transmission of the streaming data rtsp://:/

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.

Street view of a river with vehicles and modern buildings in the background (no visible text or symbols)

RTSP port /RTP port for video, audio/ RTCP port for video, audio

■ RTSP (Real-Time Streaming Protocol) controls the delivery of streaming media. By default, the port number is set to 554.
■ The RTP (Real-time Transport Protocol) is used to deliver video and audio data to the clients. By default, the RTP port for video is set to 5556 and the RTP port for audio is set to 5558.
■ The RTCP (Real-time Transport Control Protocol) allows the Network Camera to transmit the data by monitoring the Internet traffic volume. By default, the RTCP port for video is set to 5557 and the RTCP port for audio is set to 5559.

The ports can be changed to values between 1025 and 65535. The RTP port must be an even number and the RTCP port is the RTP port number plus one, and thus is always an odd number. When the RTP port changes, the RTCP port will change accordingly.

If the RTP ports are incorrectly assigned, the following warning message will be displayed:

Multicast settings for stream 1, 2, and 3: Click the items to display the detailed configuration information. Select the Always multicast option to enable multicast for stream 1 or 2.

Unicast video transmission delivers a stream through point-to-point transmission; multicast, on the other hand, sends a stream to the multicast group address and allows multiple clients to acquire the stream at the same time by requesting a copy from the multicast group address. Therefore, enabling multicast can effectively save Internet bandwidth.

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 firewall.

Network > DDNS

This section explains how to configure the dynamic domain name service for the Network Camera. DDNS is a service that allows your Network Camera, especially when assigned with a dynamic IP address, to have a fixed host and domain name.

Express link

Express Link is a free service provided by VIVOTEK server, which allows users to register a domain name for a network device. One URL can only be mapped to one MAC address. This service will check out if the host name is valid and automatically open a port on your router. Unlike DDNS, the user has to manually check out UPnP port forwarding, Express Link is more convenient and easy to set up.

Please follow the steps below to enable Express Link:

1. Make sure that your router supports UPnP port forwarding and it is activated.
2. Check Enable express link.
3. Enter a host name for the network device and click Save. If the host name has been used by another device, a warning message will show up. If the host name is valid, it will show a message as shown below.

Manual setup

DDNS: Dynamic domain name service

DDNS: Dynamic domain name service

Enable DDNS:

Provider:

Host name:

User name:

Password:

Dyndns.org(Dynamic)

Enable DDNS: Select this option to enable the DDNS setting.

Provider: Select a DDNS provider from the provider drop-down list.

VIVOTEK offers Safe100.net, a free dynamic domain name service, to VIVOTEK customers. It is recommended that you register Safe100.net to access VIVOTEK's Network Cameras from the Internet. Additionally, we offer other DDNS providers, such as Dyndns.org(Dynamic), Dyndns.org(Custom), TZO.com, DHS.org, CustomSafe100, dyn-interfree.it.

Note that before utilizing this function, please apply for a dynamic domain account first.

■ Safe100.net

1. In the DDNS column, select Safe100.net from the drop-down list. Click I accept after reviewing the terms of the Service Agreement.
2. In the Register column, fill in the Host name (xxxx.safe100.net), Email, Key, and Confirm Key, and click Register. After a host name has been successfully created, a success message will be displayed in the DDNS Registration Result column.

Register

Host name:

Email:

Key:

Confirm key:

WTK.safe100.net

[e-mail]

...

...

Forget key

To apply for a domain name for the camera, or to modify the previously registered information, fill in the following fields and then click "Register".

Register

DDNS Registration Result:

[Register] Successfully Your account information has been mailed to registered e-mail address

Upon successful registration, you can click copy to automatically upload relevant information to the DDNS form or you can manually fill it in. Then, click "Save" to save new settings.

1. Click Copy and all the registered information will automatically be uploaded to the corresponding fields in the DDNS column at the top of the page as seen in the picture.

DDNS: Dynamic domain name service

Enable DDNS:

Provider:

Host name:

Email:

Key:

Save

Register

Host name:

Email:

Key:

Confirm key:

WTK.safe100.net

[e-mail]

...

...

Forget key

To apply for a domain name for the camera, or to modify the previously registered information, fill in

the following fields and then click "Register".

Register

DDNS Registration Result

[Register] Successfully Your account information has

been mailed to registered e-mail address

Upon successful registration, you can click copy to automatically upload relevant information to the

DDNS form or you can manually fill it in. Then, click "Save" to save new settings.

1. Select Enable DDNS and click Save to enable the setting.

■ CustomSafe100

VIVOTEK offers documents to establish a CustomSafe100 DDNS server for distributors and system integrators. You can use CustomSafe100 to register a dynamic domain name if your distributor or system integrators offer such services.

1. In the DDNS column, select CustomSafe100 from the drop-down list.
2. In the Register column, fill in the Host name, Email, Key, and Confirm Key; then click Register. After a host name has been successfully created, you will see a success message in the DDNS Registration Result column.
3. Click Copy and all for the registered information will be uploaded to the corresponding fields in the DDNS column.
4. Select Enable DDNS and click Save to enable the setting.

Forget key: Click this button if you have forgotten the key to Safe100.net or CustomSafe100. Your account information will be sent to your email address.

Refer to the following links to apply for a dynamic domain account when selecting other DDNS providers:

■ Dyndns.org(Dynamic) / Dyndns.org(Custom): visit http://www.dyndns.com/

Network > QoS (Quality of Service)

Quality of Service refers to a resource reservation control mechanism, which guarantees a certain quality to different services on the network. Quality of service guarantees are important if the network capacity is insufficient, especially for real-time streaming multimedia applications. Quality can be defined as, for instance, a maintained level of bit rate, low latency, no packet dropping, etc.

The following are the main benefits of a QoS-aware network:

■ The ability to prioritize traffic and guarantee a certain level of performance to the data flow.
■ The ability to control the amount of bandwidth each application may use, and thus provide higher reliability and stability on the network.

Requirements for QoS

To utilize QoS in a network environment, the following requirements must be met:

■ All network switches and routers in the network must include support for QoS.
■ The network video devices used in the network must be QoS-enabled.

QoS models

CoS (the VLAN 802.1p model)

IEEE802.1p defines a QoS model at OSI Layer 2 (Data Link Layer), which is called CoS, Class of Service. It adds a 3-bit value to the VLAN MAC header, which indicates the frame priority level from 0 (lowest) to 7 (highest). The priority is set up on the network switches, which then use different queuing disciplines to forward the packets.

Below is the setting column for CoS. Enter the VLAN ID of your switch (0\~4095) and choose the priority for each application (0\~7).

If you assign Video the highest level, the switch will handle video packets first.

NOTE:

▶ A VLAN Switch (802.1p) is required. The web browsing may fail if the CoS setting is incorrect.
▶ Class of Service technologies do not guarantee a level of service in terms of bandwidth and delivery time; they offer a "best-effort." Users can think of CoS as "coarsely-grained" traffic control and QoS as "finely-grained" traffic control.
▶ Although CoS is simple to manage, it lacks scalability and does not offer end-to-end guarantees since it is based on L2 protocol.

QoS/DSCP (the DiffServ model)

DSCP-ECN defines QoS at Layer 3 (Network Layer). The Differentiated Services (DiffServ) model is based on packet marking and router queuing disciplines. The marking is done by adding a field to the IP header, called the DSCP (Differentiated Services Codepoint). This is a 6-bit field that provides 64 different class IDs. It gives an indication of how a given packet is to be forwarded, known as the Per Hop Behavior (PHB). The PHB describes a particular service level in terms of bandwidth, queueing theory, and dropping (discarding the packet) decisions. Routers at each network node classify packets according to their DSCP value and give them a particular forwarding treatment; for example, how much bandwidth to reserve for it.

Below are the setting options of DSCP (DiffServ Codepoint). Specify the DSCP value for each application (0\~63).

Network > SNMP (Simple Network Management Protocol)

This section explains how to use the SNMP on the network camera. The Simple Network Management Protocol is an application layer protocol that facilitates the exchange of management information between network devices. It helps network administrators to remotely manage network devices and find, solve network problems with ease.

■ The SNMP consists of the following three key components:

1. Manager: Network-management station (NMS), a server which executes applications that monitor and control managed devices.
2. Agent: A network-management software module on a managed device which transfers the status of managed devices to the NMS.
3. Managed device: A network node on a managed network. For example: routers, switches, bridges, hubs, computer hosts, printers, IP telephones, network cameras, web server, and database.

Before configuring SNMP settings on the this page, please enable your NMS first.

SNMP Configuration

Enable SNMPv1, SNMPv2c

Select this option and enter the names of Read/Write community and Read Only community according to your NMS settings.

Enable SNMPv1, SNMPv2c

SNMPv1, SNMPv2c Settings

Read/Write community:

Private

Read only community:

Public

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).

Enable SNMPv3

SNMPv3 Settings

Read/Write Security name:

Private

Authentication Type:

MD5

Authentication Password:

The Ground Truth image displays a single, solid horizontal line. According to Rule 2 (UNDERSCORE & LINE RULES), this is a stylistic or background line, not a placeholder underscore. Therefore, the OCR result must ignore it and output nothing or only meaningful text. The provided OCR content is "____", which consists of four underscores. This is an incorrect interpretation of the line as a placeholder, violating the rule that stylistic lines must be ignored. The OCR has hallucinated placeholder underscores where none exist in the GT, violating the rule to ignore such lines. Hence, the OCR result is inconsistent with the Ground Truth.

Encryption Password:

The Ground Truth image displays a single, solid horizontal line. According to Rule 2 (UNDERSCORE & LINE RULES), this is a stylistic or background line, not a placeholder underscore. Therefore, the OCR result must ignore it and output nothing or only meaningful text. The provided OCR content is "____", which consists of four underscores. This is an incorrect interpretation of the line as a placeholder, violating the rule that stylistic lines must be ignored. The OCR has hallucinated placeholder underscores where none should exist in the GT. Hence, the OCR result is inconsistent with the Ground Truth.

Read only Security name:

Public

Authentication Type:

MD5

Authentication Password:

The Ground Truth image displays a single, solid horizontal line. According to Rule 2 (UNDERSCORE & LINE RULES), this is a stylistic or background line, not a placeholder underscore. Therefore, the OCR result must ignore it and output nothing or only meaningful text. The provided OCR content is "____", which consists of four underscores. This is an incorrect interpretation of the line as a placeholder, violating the rule that stylistic lines must be ignored. The OCR has hallucinated placeholder underscores where none should exist in the GT. This is a formatting error: the OCR should have output nothing for this line. Therefore, the OCR result is inconsistent with the Ground Truth.

Encryption Password:

Security > User Account

This section explains how to enable password protection and create multiple accounts.

Root Password

The administrator account name is "root", which is permanent and can not be deleted. If you want to add more accounts in the Manage User column, please apply the password for the "root" account first.

1. Type the password identically in both text boxes, then click Save to enable password protection.
2. A window will be prompted for authentication; type the correct user's name and password in their respective fields to access the Network Camera.

Privilege Management

Digital Output & PTZ control: You can modify the management privilege for operators or viewers. Select or deselect the checkboxes, then click Save to enable the settings. If you give Viewers the privilege, Operators will also have the ability to control the Network Camera through the main page. (Please refer to Configuration on page 41).

Allow anonymous viewing: If you check this item, any client can access the live stream without entering a User ID and Password.

Account Management

Administrators can create up to 20 user accounts.

1. Input the new user's name and password.
2. Select the privilege level for the new user account. Click Add to enable the setting.

Access rights are sorted by user privilege (Administrator, Operator, and Viewer). Only administrators can access the Configuration page. Although operators cannot access the Configuration page, they can use the URL Commands to get and set the value of parameters. For more information, please refer to URL Commands of the Network Camera on page 135. Viewers can only access the main page for live viewing.

Here you also can change a user's access rights or delete user accounts.

1. Select an existing account to modify.
2. Make necessary changes and click Update or Delete to enable the setting.

Security > HTTPS (Hypertext Transfer Protocol over SSL)

This section explains how to enable authentication and encrypted communication over SSL (Secure Socket Layer). It helps protect streaming data transmission over the Internet on higher security level.

Create and Install Certificate Method

Before using HTTPS for communication with the Network Camera, a Certificate must be created first. There are three ways to create and install a certificate:

Create self-signed certificate

1. Select this option from a pull-down menu.
2. In the first column, select Enable HTTPS secure connection, then select a connection option: "HTTP & HTTPS" or "HTTPS only".
3. Click Create certificate to generate a certificate.

1. The Certificate Information will automatically be displayed as shown below. You can click Certificate properties to view detailed information about the certificate.

1. Click Home to return to the main page. Change the address from "http://" to "https://" in the address bar and press Enter on your keyboard. Some Security Alert dialogs will pop up. Click OK or Yes to enable HTTPS.

https://

Create certificate and install : Select this option if you want to create a certificate from a certification authority.

1. Select this option from a method pull-down menu.
2. Click Create certificate to generate the certificate.

Certificate:

Certificate information

Status:

method:

Country:

State or province:

Locality:

Organization:

Organization unit:

Common name:

Not installed

Create certificate request and install

Create self-signed certificate

Create certificate request and install

Asia

Asia

VIVOTEK, Inc

VIVOTEK, Inc

www.vivotek.com

Please wait while the certificate is being generated...

1. The following information will appear in a pop-up window after clicking Create. If you see the following Information bar, click OK and click on the Information bar at the top of the page to allow pop-ups.

1. The Certificate Information will automatically be displayed in the third column as shown below. You can click Property to see detailed information about the certificate.

Create Certificate Request Completed

Copy the PEM format request below and send it to a CA for identify validation. After that, you have to install it by clicking the "Upload" button on HTTPS page.

Certificate Request (PEM format)

----BEGIN CERTIFICATE REQUEST----

MIIBuDCCASECADB5MQswCQYDVQQGEwJUVzERMA8GA1UECBMIUHJvdm1uY2UxEjAQBgNVBAcTCUNpdHkgTmFtZTEaMBgGA1UEChMRT3JnYW5pemFOaW9uIE5hbWUXejAQBgNVBAsTCVVuaXQgTmFtZTETMEBGA1UEAxMKSVAgQWRkcmVzczCBnzANBgkqhkiG9wOBAQEFAAOBJQAwgYkCgYEAuDT75EY52gsSyPFMxZ7wHdQ1obPescsXLUX9DFw6OMRheukFaXFDKM+5xK+K5oEPBPqj77yhH+zduHS27fFSLG57bW9SoxrWuLhSvRZWmCD+/A1JX864dJ/mjHn7Wc55GFaxgMvbALcxT+hCIeDCWYnRqh/fpKNj+BxvVoNUrcCAwEAAAAMA0GCSqGStb3DQEBBOQUAA4GBAAVAzWOAtftfU9dyFgTxOY01D/zOF0TKbnDOQG18e4fTJ3rROD1TvIIMjg3K8zsAS8Gd3pME1ejqLYoBrtaSqdCUqGIX50bLG1subWsXr88PngaBwjYoTpG3qlzvUPJZLAVmdL3ne5urTbABXOScCHOQGTh+PX9dw40JWKIC8QhV

----END CERTIFICATE REQUEST----

1. Copy the contents of the Certificate request (in PEM format). Use the contents to apply for a 3rd-party certification authority such as Symantec VeriSign. Wait for the certificate authority to issue an SSL certificate; click Browse to search for the issued certificate, and then click Upload to finish the process.

NOTE:

▶ How do I cancel the HTTPS settings?

1. Click on the Remove certificate button.

Certificate:

1. If you are currently running a secure connection The webpage will redirect to a non-HTTPS page automatically.

Enable HTTPS

Check this item to enable HTTPS communication, then select a connection option: "HTTP & HTTPS" or "HTTPS only". Note that you have to create and install a certificate first before clicking the Save button.

Enable HTTPS

Enable HTTPS secure connection:

HTTP & HTTPS Ⓞ HTTPS only

Save

Security > Access List

This section explains how to control access permission by verifying the client PC's IP address.

General Settings

Maximum number of concurrent streaming connection(s) limited to: Simultaneous live viewing for 1\~10 clients (including stream 1 to stream 3). The default value is 10. If you modify the value and click Save, all current connections will be disconnected and automatically attempt to re-link (IE Explorer or Quick Time Player).

View Information: Click this button to display the connection status window showing a list of the current connections. For example:

Note that only consoles that are currently displaying live streaming will be listed in the View Information list.

■ IP address: Current connections to the Network Camera.
■ Elapsed time: How much time the client has been at the webpage.
■ User ID: If the administrator has set a password for the webpage, the clients have to enter a user name and password to access the live video. The user name will be displayed in the User ID column. If the administrator allows clients to link to the webpage without a user name and password, the User ID column will be empty.

There are some situations that allow clients access to the live video without a user name and password:

1. The administrator does not set up a root password. For more information about how to set up a root password and manage user accounts, please refer to Security > User account on page 87.
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 78.
3. The administrator has set up a root password, but allows anonymous viewing. For more information about Allow Anonymous Viewing, please refer to page 87.

■ Refresh: Click this button to refresh all current connections.
■ Add to deny list: You can select entries from the Connection Status list and add them to the Deny List to deny access. Please note that those checked connections will only be disconnected temporarily and will automatically try to re-link again (IE Explore or Quick Time Player). If you want to enable the denied list, please check Enable access list filtering and click Save in the first column.
■ Disconnect: If you want to break off the current connections, please select them and click this button. Please note that those checked connections will only be disconnected temporarily and will automatically try to re-link again (IE Explore or Quick Time Player).

Filter

Enable access list filtering: Check this item and click Save if you want to enable the access list filtering function.

Filter type: Select Allow or Deny as the filter type. If you choose Allow Type, only those clients whose IP addresses are on the Access List below can access the Network Camera, and the others cannot. On the contrary, if you choose Deny Type, those clients whose IP addresses are on the Access List below will not be allowed to access the Network Camera, and the others can.

Then you can Add a rule to the following Access List. Please note that the IPv6 access list column will not be displayed unless you enable IPv6 on the Network page. For more information about IPv6 Settings, please refer to Network > General settings on page 69 for detailed information.

There are three types of rules:

Single: This rule allows the user to add an IP address to the Allowed/Denied list.

For example:

Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List. The address and network mask are written in CIDR format.

For example:

Range: This rule allows the user to assign a range of IP addresses to the Allow/Deny List.

Note: This rule only applies to IPv4 addresses.

For example:

Administrator IP address

Always allow the IP address to access this device: You can check this item and add the Administrator's IP address in this field to make sure the Administrator can always connect to the device.

Security > IEEE 802.1X

Enable this function if your network environment uses IEEE 802.1x, which is a port-based network access control. The network devices, intermediary switch/access point/hub, and RADIUS server must support and enable 802.1x settings.

The 802.1x standard is designed to enhance the security of local area networks, which provides authentication to network devices (clients) attached to a network port (wired or wireless). If all certificates between client and server are verified, a point-to-point connection will be enabled; if authentication fails, access on that port will be prohibited. 802.1x utilizes an existing protocol, the Extensible Authentication Protocol (EAP), to facilitate communication.

■ The components of a protected network with 802.1x authentication:

graph LR
    A["Supplicant\n(Network Camera)"] <--> B["Authenticator\n(Network Switch)"]
    B <--> C["Authentication Server\n(RADIUS Server)"]

1. Supplicant: A client end user (camera), which requests authentication.
2. Authenticator (an access point or a switch): A “go between” which restricts unauthorized end users from communicating with the authentication server.
3. Authentication server (usually a RADIUS server): Checks the client certificate and decides whether to accept the end user's access request.

■ VIVOTEK Network Cameras support two types of EAP methods to perform authentication: EAP-PEAP and EAP-TLS.

Please follow the steps below to enable 802.1x settings:

1. Before connecting the Network Camera to the protected network with 802.1x, please apply a digital certificate from a Certificate Authority (i.e., your network administrator) which can be validated by a RADIUS server.
2. Connect the Network Camera to a PC or notebook outside of the protected LAN. Open the configuration page of the Network Camera as shown below. Select EAP-PEAP or EAP-TLS as the EAP method. In the following blanks, enter your ID and password issued by the CA, then upload related certificate(s).

IEEE 802.1x

Enable IEEE 802.1x

EAP method:

Identity:

Password:

CA certificate:

Status: no file

IMPORTANT:

The maximum length of password is 200 symbols.

IEEE 802.1x

Enable 802.1x

EAP method:

Identity:

Private key password:

CA certificate:

Status: no file

client certificate:

Status: no file

Client private key:

Status: no file

EAP-TLS

Browse..

Upload

Remove

Browse..

Upload

Remove

Browse..

Upload

Remove

1. When all settings are complete, move the Network Camera to the protected LAN by connecting it to an 802.1x enabled switch. The devices will then start the authentication automatically.

NOTE:

▶ The authentication process for 802.1x:

1. The Certificate Authority (CA) provides the required signed certificates to the Network Camera (the supplicant) and the RADIUS Server (the authentication server).
2. A Network Camera requests access to the protected LAN using 802.1X via a switch (the authenticator). The client offers its identity and client certificate, which is then forwarded by the switch to the RADIUS Server, which uses an algorithm to authenticate the Network Camera and returns an acceptance or rejection back to the switch.
3. The switch also forwards the RADIUS Server's certificate to the Network Camera.
4. Assuming all certificates are validated, the switch then changes the Network Camera's state to authorized and is allowed access to the protected network via a pre-configured port.

graph TD
    A["Certificate"] --> B["VIVOTEK Network Camera"]
    C["Certificate Authority (CA)"] --> D["Network Switch"]
    D --> E["RADIUS Server"]
    F["Certificate"] --> C
    G["Protected LAN"] --> D
    style A fill:#cce5ff,stroke:#333
    style C fill:#cce5ff,stroke:#333
    style F fill:#ffcccc,stroke:#333
    style G fill:#ffcccc,stroke:#333

PTZ > PTZ settings

This section explains how to control the Network Camera's Pan/Tilt/Zoom operation.

Digital PTZ Operation (E-PTZ Operation)

The e-PTZ control settings section will be displayed as shown below:

Select Stream: Select a video stream to set up the e-PTZ control. Please note that each stream can possess its own preset and patrol settings. For detailed information about how to set up preset and patrol settings, please refer to page 98.

Auto pan/patrol speed: Select the speed from 1\~5 (slow/fast) to set up the Auto pan/patrol speed control.

When completed with the e-PTZ settings, click Save to enable the settings on this page.

Home page in E-PTZ Mode

■ The e-Preset Positions will also be displayed on the home page. Select one from the drop-down list, and the Network Camera will move to the selected position.
■ If you have set up different preset positions for different streams, you can select one of the video streams to display its separate preset positions.

Global View

In addition to using the e-PTZ control panel, you can also use the mouse to drag or resize the floating frame to pan/tilt/zoom the viewing region. The live view window will also move to the viewing region accordingly.

Moving Instantly

If you check this item, the live view window will switch to the new viewing region instantly after you move the floating frame.

Click on Image

The e-PTZ function also supports "Click on Image". When you click on any point of the Global View Window or Live View Window, the viewing region will also move to that point.

Note that the "Click on Image" function only applies when you have configured a smaller "Region of Interest" out of the maximum output frame! e.g., a 1600x1200 region from the camera's 2560x1920 maximum frame size.

Patrol button: Click this button, then the Network Camera will patrol among the selected preset positions continuously.

Patrol settings

You can select some preset positions for the Network Camera to patrol.

Please follow the steps below to set up a patrol schedule:

1. Select the preset locations on the list, and click >>.
2. The selected preset locations will be displayed on the Patrol locations list.
3. Set the Dwelling time for the preset location during an auto patrol.

4. If you want to delete a preset location from the Patrol locations list, select it and click Remove.

5. Select a location and click ▲ ▼ to rearrange the patrol order.

6. Select patrol locations you want to save in the list and click Save to enable the patrol settings.

7. To implement the patrol schedule, please go to homepage and click on the Patrol button. Please refer to the next page.

NOTE:

The Preset Positions will also be displayed on the home page. Select one from the Go to drop-down list, and the Network Camera will move to the selected preset position.
▶ Click Patrol: The Network Camera will patrol along the selected positions repeatedly. Please refer to page 100 to see more details.

Event > Event settings

This section explains how to configure the Network Camera to respond to particular situations (event). A typical application is that when a motion is detected, the Network Camera sends buffered images to an FTP server or e-mail address as notifications. Click on Help, there is an illustration shown in the pop-up window explaining that an event can be triggered by many sources, such as motion detection or external digital input devices. When an event is triggered, you can specify what type of action that will be performed. You can configure the Network Camera to send snapshots or videos to your email address or FTP site.

Event

To set an event with recorded video or snapshots, it is necessary to configure the server and media settings so that the Network Camera will know what action to take (such as which server to send the media files to) when a trigger is activated. An event is an action initiated by a user-defined trigger source. In the Event column, click Add to open the event settings window. Here you can arrange three elements -- Schedule, Trigger, and Action to set an event. A total of 3 event settings can be configured.

■ Event name: Enter a name for the event setting.
■ Enable this event: Select this option to enable the event setting.
■ Priority: Select the relative importance of this event (High, Normal, or Low). Events with a higher priority setting will be executed first.
- Detect next motion detection or digital input after □ seconds: Enter the duration in seconds to pause motion detection after a motion is detected. This can prevent event-related actions to be too frequently performed.

1. Schedule

Specify the period of time during which the event trigger will take place. Please select the days of the week and the time in a day (in 24-hr time format) for the event triggering schedule.

2. Trigger

This is the cause or stimulus which defines when to trigger the Network Camera. The trigger source can be configured to use the Network Camera's built-in motion detection mechanism or external digital input devices.

There are several choices of trigger sources as shown on next page. Select the item to display the detailed configuration options.

■ Video motion detection

This option makes use of the built-in motion detection mechanism as a trigger source. To enable this function, you need to configure a Motion Detection Window first. For more information, please refer to Motion Detection on page 117 for details.

Video motion detection

Normal: □ door

Profile: hallway

Note: Please configure Motion detection first

■ Periodically

This option allows the Network Camera to trigger periodically for every other defined minute. Up to 999 minutes are allowed.

Periodically

Trigger every other 1 minutes

■ 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.

■ PIR (FD8138-H)

Uses PIR detection as a triggering source.

■ System boot

This option triggers the Network Camera when the power to the Network Camera is disconnected.

■ Recording notify

This option allows the Network Camera to trigger when the recording disk is full or when recording starts to rewrite older data.

■ Audio detection

A preset threshold can be configured with an external microphone as the trigger to system event. The triggering condition can be an input exceeding or falling below a threshold. Audio detection can take place as a complement to motion detection or as a method to detect activities not covered by the camera's view.

Audio detection

Note: Please configure Audio detection first

Once you have a preset audio alarm level, you can define the triggering condition either as an audio input rises above or falls below the alarm level.

■ Camera tampering detection

This option allows the Network Camera to trigger when the camera detects that is is being tampered with. To enable this function, you need to configure the Tampering Detection option first. Please refer to page 120 for detailed information.

■ Manual Trigger

This option allows users to enable event triggers manually by clicking the on/off button on the homepage. Please configure 1 to 3 associated events before using this function.

■ VADP

It is presumed that you already uploaded and enabled the VADP modules before you can associate 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 123 for the configuration options with VADP modules.

Once the triggers are configured, they will be listed under the VADP option.

3. Action

Define the actions to be performed by the Network Camera when a trigger is activated.

■ Trigger digital output for □seconds
Select this option to turn on the external digital output device when a trigger is activated. Specify the length of the trigger interval in the text box.
■ Backup media if the network is disconnected
Select this option to backup media file on SD card if the network is disconnected. This function will only be displayed after you set up a networked storage device (NAS).

Add server

To set an event with recorded video or snapshots, it is necessary to configure the server and media settings so that the Network Camera will know what action to take (such as which server to send the media files to) when a trigger is activated. Click Add server to open the server setting window. You can specify where the notification messages are sent when a trigger is activated. A total of 5 server settings can be configured.

There are four choices of server types available: Email, FTP, HTTP, and Network storage. Select the item to display the detailed configuration options. You can configure either one or all of them.

Server type - Email

Select to send the media files via email when a trigger is activated.

■ Server name: Enter a name for the server setting.
■ Sender email address: Enter the email address of the sender.
■ Recipient email address: Enter the email address of the recipient.
■ Server address: Enter the domain name or IP address of the email server.
■ User name: Enter the user name of the email account if necessary.
■ Password: Enter the password of the email account if necessary.
■ Server port: The default mail server port is set to 25. You can also manually set another port.

If your SMTP server requires a secure connection (SSL), check This server requires a secure connection (SSL).

To verify if the email settings are correctly configured, click Test. The result will be shown in a pop-up window. If successful, you will also receive an email indicating the result.

Click Save server to enable the settings.

Note that after you set up the first event server, the new event server will automatically display on the Server list. If you wish to add other server options, click Add server.

Server type - FTP

Select to send the media files to an FTP server when a trigger is activated.

■ Server name: Enter a name for the server setting.
■ Server address: Enter the domain name or IP address of the FTP server.
■ Server port: By default, the FTP server port is set to 21. It can also be assigned to another port number between 1025 and 65535.
■ User name: Enter the login name of the FTP account.
■ Password: Enter the password of the FTP account.
■ FTP folder name

Enter the folder where the media file will be placed. If the folder name does not exist, the Network Camera will automatically create one on the FTP server.

■ Passive mode

Most firewalls do not accept new connections initiated from external requests. If the FTP server supports passive mode, select this option to enable passive mode FTP and allow data transmission to pass through the firewall. The firmware default has the Passive mode checkbox selected.

To verify if the FTP settings are correctly configured, click Test. The result will be shown in a pop-up window as shown below. If successful, you will also receive a test.txt file on the FTP server.

Click Save server to enable the settings.

Server type - HTTP

Select to send the media files to an HTTP server when a trigger is activated.

■ Server name: Enter a name for the server setting.
■ URL: Enter the URL of the HTTP server.
■ User name: Enter the user name if necessary.
■ Password: Enter the password if necessary.

To verify if the HTTP settings are correctly configured, click Test. The result will be shown in a pop-up window as below. If successful, you will receive a test.txt file on the HTTP server.

Click Save server to enable the settings.

Network storage:

Select to send the media files to a network storage location when a trigger is activated. Please refer to NAS server on page 129 for details.

Click Save server to enable the settings.

■ SD Test: Click to test your SD card. The system will display a message indicating success or failure. If you want to use your SD card for local storage, please format it before use. Please refer to page 112 for detailed information.
■ View: Click this button to open a file list window. This function is only for SD card and Network Storage. If you click the View button of SD card, a Local storage page will pop up for you to manage recorded files on SD card. For more information about Local storage, please refer to page 131. If you click the View button of Network storage, a file directory window will prompt for you to view recorded data on Network storage. For detailed illustration, please refer to the next page.
■ Create folders by date, time, and hour automatically: If you check this item, the system will generate folders automatically by the date when video footages are stored onto the networked storage.

The following is an example of a file destination with video clips:

Click 20140820 to open the directory:

The format is: HH (24r)

Click to open the file list for that hour

The format is: File name prefix + Minute (mm)

You can set up the file name prefix on Add media page. Please refer to next page for detailed information.

Add media

Click Add media to open the media setting window. You can specify the type of media that will be sent when a trigger is activated. A total of 5 media settings can be configured. There are three choices of media types available: Snapshot, Video Clip, and System log. Select the item to display the detailed configuration options. You can configure either one or all of them.

Media type - Snapshot

Select to send snapshots when a trigger is activated.

■ Media name: Enter a name for the media setting.
■ Source: Select to take snapshots from any of the video streams.
■ 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 prefix

Enter the text that will be appended to the front of the file name.

■ Add date and time suffix to the file name

Select this option to add a date/time suffix to the file name.

For example:

Click Save media to enable the settings.

To note that after you set up the first media server, a new column for media server will automatically show up on the Media list. If you wish to add more other media options, click Add media.

Media type - Video clip

Select to send video clips when a trigger is activated.

■ Media name: Enter a name for the media setting.
■ Source: Select the source of video clip.
■ Pre-event recording

The Network Camera has a buffer area; it temporarily holds data up to a certain limit. Enter a number to decide the duration of recording before a trigger is activated. Up to 9 seconds can be set.

■ Maximum duration

Specify the maximum recording duration in seconds. Up to 10 seconds can be set.

For example, if pre-event recording is set to five seconds and the maximum duration is set to ten seconds, the Network Camera continues to record for another 4 seconds after a trigger is activated.

■ Maximum file size

Specify the maximum file size allowed.

■ File name prefix

Enter the text that will be appended to the front of the file name.

For example:

Click Save media to enable the settings.

Media type - System log

Select to send a system log when a trigger is activated.

Click Save media to enable the settings, then click Close to exit the page.

In the Event settings column, the Servers and Medias you configured will be listed; please make sure the Event -> Status is indicated as ON, in order to enable the event triggering action.

When completed, click Save event to enable the settings and click Close to exit Event Settings page. The new Event / Server settings / Media will appear in the event drop-down list on the Event setting page.

Please see the example of the Event setting page below:

When the Event Status is ON, once an event is triggered by motion detection, the Network Camera will automatically send snapshots via e-mail.

If you want to stop the event trigger, you can click ON to turn it to OFF status or click Delete to remove the event setting.

To remove a server setting from the list, select a server name from the drop-down list and click Delete. Note that you can only delete a server setting when it is not applied to an event setting.

To remove a media setting from the list, select a media name from the drop-down list and click Delete. Note that you can only delete a media setting when it is not applied to an event setting.

Customized Script

This function allows you to upload a sample script (.xml file) to the webpage, which will save your time on configuring the settings. Please note that there is a limited number of customized scripts you can upload; if the current amount of customized scripts has reached the limit, an alert message will prompt. If you need more information, please contact VIVOTEK technical support.

Applications > Motion detection

This section explains how to configure the Network Camera to enable motion detection. A total of three motion detection windows can be configured.

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 a window, click X on the upper right corner of the window.

1. Define the sensitivity to moving objects and the space ratio of all alerted pixels by moving the Sensitivity and Percentage slider bar.
2. Click Save to enable the settings.
3. Select Enable motion detection to enable this function.

For example:

Enable motion detection

Profile

The Percentage Indicator will rise or fall depending on the variation between sequential images. When motions are detected by the Network Camera and are judged to exceed the defined threshold, the red bar rises. Meanwhile, the motion detection window will be outlined in red. Photos or videos can be captured instantly and configured to be sent to a remote server (Email, FTP) by utilizing this feature as a trigger source. For more information on how to set an event, please refer to Event settings on page 102.

A green bar indicates that even though motions have been detected, the event has not been triggered because the image variations still fall under the defined threshold.

If you want to configure other motion detection settings for day/night/schedule mode, please click Profile to open the Motion Detection Profile Settings page as shown below. A total of three motion detection windows can be configured on this page as well.

>Motion detection profile settings

Please follow the steps beolw to set up a profile:

1. Create a new motion detection window.
2. Check Enable this profile.
3. Select the applicable mode: Day mode, Night mode, or Schedule mode. Please manually enter a time range if you choose Schedule mode.
4. Click Save to enable the settings and click Close to exit the page.

This motion detection window will also be displayed on the Event Settings page. You can go to Event > Event settings > Trigger to choose it as a trigger source. Please refer to page 127 for detailed information.

NOTE:

▶ How does motion detection work?

Illustration of a cat and a striped cat playing in a pool with grass and rocks (no text or symbols)

Illustration of a fish with green grass and rocks, displayed within a grid interface (no text or symbols)

There are two motion detection parameters: Sensitivity and Percentage. In the illustration above, frame A and frame B are two sequential images. Pixel differences between the two frames are detected and highlighted in gray (frame C) and will be compared with the sensitivity setting. Sensitivity is a value that expresses the sensitivity to moving objects. Higher sensitivity settings are expected to detect slight movements while smaller sensitivity settings will neglect them. When the sensitivity is set to 70%, the Network Camera defines the pixels in the purple areas as “alerted pixels” (frame D).

Percentage is a value that expresses the proportion of “alerted pixels” to all pixels in the motion detection window. In this case, 50% of pixels are identified as “alerted pixels”. When the percentage is set to 30%, the motions are judged to exceed the defined threshold; therefore, the motion window will be outlined in red.

For applications that require a high level of security management, it is suggested to use higher sensitivity settings and smaller percentage values.

Applications > DI and DO

Connect DI or DO devices to the camera's terminal block, the camera will automatically detect the current connection state as pulled-high or pulled-low. You may then define the triggering condition.

Digital input: Select High or Low to define the "Normal status" for the digital input. The Network Camera will report the current status.

Digital output: Select Grounded or Open to define the "Normal status" for the digital output. The Network Camera will show whether the trigger is activated or not.

Applications > Tampering detection

This section explains how to set up camera tamper detection. With tamper detection, the camera is capable of detecting incidents such as redirection, blocking or defocusing, or even spray paint.

Please follow the steps below to set up the camera tamper detection function:

1. Check Enable camera tampering detection.
2. Enter the tamper trigger duration. (10 sec. \~ 10 min.) The tamper alarm will be triggered only when the tampering factor (the difference between current frame and pre-saved background) exceeds the trigger threshold.
3. Set up the event source as Camera Tampering Detection on Event > Event settings > Trigger. Please refer to page 127 for detailed information.

Applications > Audio detection

Audio detection, along with video motion detection, is applicable in the following scenarios:

1. Detection of activities not covered by camera view, e.g., a loud input by gun shots or breaking a door/window.
2. A usually noisy environment, such as a factory, suddenly becomes quiet due to a breakdown of machines.
3. A PTZ camera can be directed to turn to a preset point by the occurrence of audio events.
4. Dark environments where video motion detection may not function well.

The red circles indicate where the audio alarms can be triggered when breaching or falling below the preset threshold.

How to configure Audio detection:

1. Once the Audio detection window is opened, the current sound input will be interactively indicated by a fluctuating yellow wave diagram.
2. Use a mouse click to drag the Alarm level tab to a preferred location on the slide bar.
3. Select the "Enable audio detection" checkbox and click Save to enable the feature.

NOTE:

1. Note that the volume numbers (0\~100) on the side of wave diagram does not represent decibel (dB). Sound intensity level has already been mapped to preset values. You can, however, use the real-world inputs at your installation site that are shown on the wave diagram to configure an alarm level.

2. To configure this feature, you must not mute the audio in Configuration > Media > Audio. The default of the camera can be muted due to the lack of an internal microphone. An external microphone is provided by users.

You can use the Profile window to configure a different Audio detection setting. For example, a place can be noisy in the day time and become very quiet in the night.

1. Click on the Enable this profile checkbox. Once the Audio detection window is opened, the current sound input will be interactively indicated by a fluctuating yellow wave diagram.
2. Use a mouse click to drag the Alarm level tab to a preferred location on the slide bar.
3. Select the Day, Night, or Schedule mode check circles. You may also manually configure a period of time during which this profile will take effect.
4. Click Save and then click Close to complete your configuration.

IMPORTANT:

• If the Alarm level and the received volume are set within a range of 20% on the wave diagram, frequent alarms will be triggered. It is recommended to set the Alarm level farther apart from the detected sound level.
• To configure and enable this feature, you must not configure video stream #1 into Motion JPEG. If an external microphone input is connected and recording of audio stream is preferred, audio stream is transmitted between camera and viewer/recording station along with stream #1.
  • Refer to page 68 for Audio settings, and page 59 for video streaming settings.

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 configuration (vadp.xml) information is displayed. When uploading a module, the camera will examine whether the module fits the predefined VADP requirements. Please contact our technical support or the vendor of your 3rd-party module for the parameters contained within.
• Users can also run VIVOTEK's VADP packages as a means to access updated functionality instead of replacing the entire firmware.
• Note that for some cameras the flash is too small to hold VADP packages. These cameras will have its "Save to SD card" checkbox selected and grayed-out for all time.
• The file system of SD card (FAT32) does not support soft (symbolic) link. It will return failure if your module tries to create soft links on SD card.

To utilize a software module, acquire the software package and click Browse and Upload buttons. The screen message for a successful upload is shown below:

To start a module, select the checkcircle in front, and click the Start button.

If you should need to remove a module, select the checkcircle in front and then click the Stop button. By then the module status will become OFF, and the X button will appear at the end of the row. Click on the X button to remove an existing module.

When prompted by a confirm message, Click Yes to proceed.

Note that the actual memory consumed while operating the module will be indicated on the Memory status field. This helps determine whether a running module has consumed too much of system resources.

PIR

The indoor camera, FD8138-H, comes with a PIR (Passive Infrared sensor) detector. Select the checkbox on this page to enable the PIR function.

Recording > Recording settings

This section explains how to configure the recording settings for the Network Camera.

Recording Settings

NOTE:

▶ Please remember to format your SD card when using it for the first time. Please refer to page 131 for detailed information.

Recording Settings

Click Add to open the recording setting window. On this page, you can define the adaptive recording, recording source, recording schedule, and recording capacity. A total of 2 recording settings can be configured.

■ Recording name: Enter a name for the recording setting.
■ Enable this recording: Select this option to enable video recording.
■ With adaptive recording:
Select this option will activate the frame rate control according to alarm trigger.
The frame control means that when there is a triggered alarm, the frame rate will raise up to the value you've set on Video quality page. Please refer to page 63 for more information.

If you enable adaptive recording and enable time-shift cache stream on Camera A, only when an event is triggered on Camera A will the server record the full frame rate streaming data; otherwise, it will only request the I frame data during normal monitoring, thus effectively save lots of bandwidths and storage space.

graph TD
    A["1: I frame"] --> B["2: ----> Full frame rate"]
    B --> C["3: ----> I frame"]
    C --> D["4: I frame"]
    style A fill:#f9f,stroke:#333
    style B fill:#ccf,stroke:#333
    style C fill:#cfc,stroke:#333
    style D fill:#fcc,stroke:#333
    note right of B "Activity Adaptive Streaming for Dynamic Frame Rate Control"
    note right of C "Bandwidth"
    note right of D "Continuous recording"
    A -.-> note right of B
    B -.-> note right of C

NOTE:

▶ 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, firmware will force decrease the I frame period to 1s when adaptive recording is enabled.

The alarm trigger includes: motion detection and DI detection. Please refer to Event Settings on page 102.

■ Pre-event recording and post-event recording
The Network Camera has a buffer area; it temporarily holds data up to a certain limit. Enter a number to decide the duration of recording before and after a trigger is activated.
■ Priority: Select the relative importance of this recording (High, Normal, or Low). Recording with a higher priority setting will be executed first.
■ Source: Select a stream for the recording source.

NOTE:

▶ To enable recording notification please configure Event settings first. Please refer to page 102.

Please follow the steps below to set up the recording.

1. Trigger

Select a trigger source.

■ Schedule: The server will start to record files on the local storage or network storage (NAS).
■ Network fail: Since network fail, the server will start to record files on the local storage (SD card).

2. Destination

You can select the SD card or networked storage (NAS) for the recorded video files. If you have not configured a NAS server, see details in the following.

NAS server

Click Add NAS server to open the server setting window and follow the steps below to set up:

1. Fill in the information for your server.

For example:

User name and password for your server

1. Click Test to check the setting. The result will be shown in the pop-up window.

If successful, you will receive a test.txt file on the network storage server.

1. Enter a server name.
2. Click Save to complete the settings and click Close to exit the page.

■ Capacity: You can choose either the entire free space available or limit the reserved space. The recording size limit must be larger than the reserved amount for cyclic recording.
■ File name prefix: Enter the text that will be appended to the front of the file name.
■ Enable cyclic recording: If you check this item, when the maximum capacity is reached, the oldest file will be overwritten by the latest one. The reserved amount is reserved for the transaction stage when the storage space is about to be full and new data arrives. The minimum for the Reserved space must be larger than 15 MBytes.
■ Recording file management: You can manually assign the Maximum duration and the Maximum file size for each recording footage. You may need to stitch individual files together under some circumstances. You may also designate a file name prefix by filling in the responsive text field.

f you want to enable recording notification, please click Event to configure event triggering settings. Please refer to Event > Event settings on page 102 for more details.

When completed, select Enable this recording. Click Save to enable the setting and click Close to exit this page. When the system begins recording, it will send the recorded files to the network storage. The new recording name will appear in the drop-down list on the recording page as shown below.

To remove a recording setting from the list, select a recording name from the drop-down list and click Delete.

■ Click Video (Name): Opens the Recording Settings page to modify.
■ Click ON (Status): The Status will become OFF and stop recording.
■ Click NAS (Destination): Opens the file list of recordings as shown below. For more information about folder naming rules, please refer to page 110 for details.

Local storage > SD card management

This section explains how to manage the local storage on the Network Camera. Here you can view SD card status, and implement SD card control.

SD card staus

This column shows the status and reserved space of your SD card. Please remember to format the SD card when using for the first time.

SD card format

The Linux kernel EXT4 file system format applies to SD card larger than 32GB. However, if EXT4 is applied, the computers running Windows will not be able to access the contents on the SD card.

SD card control

■ Enable cyclic storage: Check this item if you want to enable cyclic recording. When the maximum capacity is reached, the oldest file will be overwritten by the latest one.
■ Enable automatic disk cleanup: Check this item and enter the number of days you wish to retain a file. For example, if you enter "7 days", the recorded files will be stored on the SD card for 7 days.

Click Save to enable your settings.

Local storage > Content management

This section explains how to manage the content of recorded videos on the Network Camera. Here you can search and view the records and view the searched results.

Searching and Viewing the Records

This column allows the user to set up search criteria for recorded data. If you do not select any criteria and click Search button, all recorded data will be listed in the Search Results column.

■ File attributes: Select one or more items as your search criteria.
■ Trigger time: Manually enter the time range you want to search.

Click Search and the recorded data corresponding to the search criteria will be listed in Search Results window.

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.

■ View: Click on a search result which will highlight the selected item in purple as shown above. Click the View button and a media window will pop up to play back the selected file.

For example:

■ Download: Click on a search result to highlight the selected item in purple as shown above. Then click the Download button and a file download window will pop up for you to save the file.
■ JPEGs to AVI: This functions only applies to "JPEG" format files such as snapshots. You can select several snapshots from the list, then click this button. Those snapshots will be converted into an AVI file.

■ 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 files.

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

The URL commands for the FD8338-H starts on page 229.

3. General CGI URL Syntax and Parameters

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>]
[&<parameter>...]

http://<servername>/cgi-bin/operator/getparam.cgi?[<parameter>]
[&<parameter>...]

http://<servername>/cgi-bin/admin/getparam.cgi?[<parameter>]
[&<parameter>...] 

Where the should be []. If you do not specify any parameters, all the parameters on the server will be returned. If you specify only , 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>] 

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

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>...][&return=<return page]

http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value>
[&<parameter>=<value>...][&return=<return page]

http://<servername>/cgi-bin/operator/setparam.cgi? <parameter>=<value>
[&<parameter>=<value>...][&return=<return page]

http://<servername>/cgi-bin/admin/setparam.cgi? <parameter>=<value>
[&<parameter>=<value>...][&return=<return page] 

PARAMETER VALUE DESCRIPTION

	value to assigned	Assignto the parameter.
return		Redirect to the pageafter the parameter is assigned. Thecan 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). 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
<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

This chapter defines all the parameters which can be configured or retrieved from VIVOTEK network camera or video server. The general format of description is listed in the table below

Valid values:

VALID VALUES DESCRIPTION
string[]	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[] The same	as string but displays ‘*’ instead.
integer Any number between (-231-1) and (231-1).
positive integer Any number between 0 and (232-1).
~Any number	between ‘m’ and ‘n’.
domain name[] A string limited to a domain name shorter than ‘n’ characters (eg. www.ibm.com).
email address []	A string limited to an email address shorter than ‘n’ characters (eg. [e-mail]).
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].
	Enumeration. Only given values are valid.
...
blank	A blank string.
everything inside <>	A description
integer primary key	SQLite data type. A 32-bit signed integer. The value is assigned a unique integer by the server.
text	SQLite data type. The value is a text string, stored using the database encoding (UTF-8, UTF-16BE or UTF-16-LE).
coordinate	x, y coordinate (eg. 0,0)
window size	window width and height (eg. 800x600)

NOTE: The camera should not be restarted when parameters are changed.

7.1 system

Group: system

NAME VALUE DEFAULT	SECURITY		(get/set)	DESCRIPTION
hostname string[64] FD8138-H 1/6 Host name of server.
ledoff0 6/6 Turn on (0) or turn off (1) all				led indicators.
date, keep, auto		6/6 Current date of system. Set to ‘keep’ to keep date unchanged. Set to ‘auto’ to use NTP to synchronize date.
time, keep, auto		6/6 Current time of the system. Set to ‘keep’ to keep time unchanged. Set to ‘auto’ to use NTP to synchronize time.
datetime		6/6 Another current time format of the system.
ntp, ,,		NTP server.
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-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, London40: GMT 01:00 Amsterdam, Berlin, Rome, Stockholm, Vienna, Madrid, Paris41: GMT 01:00 Warsaw, Budapest, Bern80: GMT 02:00 Athens, Helsinki, Istanbul, Riga81: GMT 02:00 Cairo82: GMT 02:00 Lebanon, Minsk83: GMT 02:00 Israel120: GMT 03:00 Baghdad, Kuwait, Riyadh, Moscow, St. Petersburg, Nairobi121: GMT 03:00 Iraq140: GMT 03:30 Tehran160: GMT 04:00 Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan180: GMT 04:30 Kabul200: GMT 05:00Ekaterinburg, Islamabad,Karachi, Tashkent220: GMT 05:30 Calcutta,Chennai, Mumbai, New Delhi230: GMT 05:45 Kathmandu240: GMT 06:00 Almaty,Novosibirsk, Astana, Dhaka,Sri Jayawardenepura260: GMT 06:30 Rangoon280: GMT 07:00 Bangkok,Hanoi, Jakarta, Krasnoyarsk320: GMT 08:00 Beijing,Chongging, Hong Kong,Kuala Lumpur, Singapore,Taipei360: GMT 09:00 Osaka,Sapporo, Tokyo, Seoul,Yakutsk380: GMT 09:30 Adelaide,Darwin400: GMT 10:00 Brisbane,Canberra, Melbourne,Sydney, Guam, Vladivostok440: GMT 11:00 Magadan,Solomon Is., New Caledonia480: GMT 12:00 Auckland,Wellington, Fiji, Kamchatka,Marshall Is.520: GMT 13:00 Nuku'Alofa
daylight_enable	0 6/6 Enable automatic daylight			saving time in time zone.
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 0	6/6 List time zone index which		support daylight saving time.
updateinterval	0,3600,86400,604800,2592000	0 6/6 0 to Disable automatic	timeadjustment, otherwise, itindicates the seconds betweenNTP automatic updateintervals.
restore	0,<positiveinteger>	N/A 7/6 Restore the system	parameters to default valuesafterseconds.
reset	0,<positiveinteger>	N/A 7/6 Restart the server after<value> seconds ifis non-negative.	seconds ifis non-negative.
restoreexceptnet	0,<positiveinteger>	N/A 7/6 Restore the system	parameters to default valuesexcept (ipaddress, subnet,router, dns1, dns2, pppoe).This command can cooperatewith other"restoreexceptXYZ"commands. Whencooperating with others, thesystem parameters will berestored to the default valueexcept for a union of thecombined results.
restoreexceptdst	0,<positiveinteger>	N/A 7/6 Restore the system	parameters to default valuesexcept all daylight savingtime settings.This command can cooperatewith other"restoreexceptXYZ"commands. Whencooperating with others, thesystem parameters will berestored to default valuesexcept for a union of

				combined results.
restoreexceptlang	0,	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.
	integer>
restoreexceptvadp	0,	N/A 99/6 Restore the system		parameters to default values except the vadp parameters and VADP modules that stored in the system. This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.
	integer>

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]	FD8138-H 0/7		Internal model	name of the server
extendedmodelname string[40] FD8138-H		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			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:language_count90/7Number of webpage languages available on the server.			0/7 Firmware version, including model, company, and version number in the format:Number of webpage languages available on the server.
language_i<0~(count-1)>	string[16]	English Deutsch Español Français Italiano 日本語 Português 简体中文繁體中文	0/7 Available language lists.
customlanguage_maxcount		1	0/6	Maximum number of custom languages supported on the server.
customlanguage_count		0	0/6	Number of custom languages which have been uploaded to the server.
customlanguage_i<0~(max count-1)>	string	N/A 0/6 Custom language name.

7.2 status

Group: status

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
di_i<0~(ndi-1)>0 1/7 0 => Inactive, normal				1 => Active, triggered
do_i<0~(ndo-1)>0 1/7 0 => Inactive, normal				1 => Active, triggered
daynight day, night 0 7/7 Current status of day, night.
onlinenum_rtsp integer 0 6/7 Current number of RTSP				connections.
onlinenum_httppush integer 0 6/7 Current number of HTTP connections.
eth_i0			1/7	Get network information from mii-tool.
vi_i<0~(nvi-1)>0 1/7 Virtual input				0 => Inactive1 => Active

7.3 digital input behavior define

Group: di_i<0\~(ndi-1)>

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)>

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
Normalstate	open, grounded	open	1/1 Indicate	open circuit or closed circuit (inactive status)

7.5 PIR detection behavior define

Group: pir

NAME VALUE DEFAULT	T SECURITY		(get/set)	DESCRIPTION
enable		0	1/1	Enable/disable PIR detection

7.6 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 ePTZ
user_i0_name	string[64]	root	6/7 User name of root
user_i<1~20>_name	string[64]		6/7 User name
user_i0_pass password[64]	6/6 Root password
user_i<1~20>_pass	password[64]		7/6 User password
user_i0_privilege	admin	admin	6/7 Root privilege
user_i<1~20>_privilege	view, operator, admin		6/6 User privilege

7.7 network

Group: network

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
preprocess		NULL 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'srecommendedto set this parameter when change a service port to the port occupied by another service currently. Otherwise, the service may fail.Stopped service will auto-start after changing port settings.Ex:Change HTTP port from 80 to 5556, and change RTP port for video from 5556 to 20480.Then, set preprocess=9 to stop both service first.”/cgi-bin/admin/setparam.cgi?network_preprocess=9&network_http_port=5556 & network_rtp_videoport=20480”
type	lan,pppoc	lan 6/6 Network connection type.
resetip <boolean> 1 6/6		1 => Get ipaddress, subnet, router, dns1, dns2from DHCP server at next reboot.0 => Use preset ipaddress, subnet, rounter, dns1, and dns2.
ipaddress			6/6 IP address of server.
subnet			Subnet mask.
router			Default gateway.
	address>
dns1		6/6	Primary DNS server.
dns2		6/6	Secondary DNS server.
wins1		6/6	Primary WINS server.
wins2		6/6	Secondary WINS server.

7.7.1 802.1x

Subgroup of network: ieee8021x

NAME VALUE DEF	FAULT SECURITY		(get/set)	DESCRIPTION
enable0 6/6 Enable/disableIEEE 802.1x
eapmethod	eap-peap,cap-tls	eap-peap 6/6 Selected EAP method
identity_peap String[64]		6/6 PEAP identity
identity_tls	String[64]		6/6	TLS identity
password	String[200]		6/6	Password for TLS
privatekeypassword	String[200]		6/6	Password for PEAP
ca_exist	0 6/6 CA installed flag
ca_time	0 6/7 CA installed time. Represented in EPOCH
ca_size0 6/7 CA file size (in bytes)
certificate_exist	0		6/6	Certificate installed flag (for TLS)
certificate_time	0 6/7 Certificate installed time. Represented in EPOCH
certificate_size	0 6/7 Certificate file size (in bytes)
privatekey_exist	0 6/6 Private key installed flag (for TLS)
privatekey_time	0 6/7 Private key installed time. Represented in EPOCH
privatekey_size	0 6/7 Private key file size (in bytes)

7.7.2 QOS

Subgroup of network: qos_cos

NAME VALUE	DEFAULT SECURITY		(get/sct)	DESCRIPTION
enable	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
eventalarm		0~7	0 6/6 Event/alarm channel for CoS
management		0~7	0	6/6
eventtunnel		0~7	0 6/6 Event/Control channel for CoS

Subgroup of network: qos_dscp

NAME VALUE	DEFAULT SECURITY		(get/set)	DESCRIPTION
enable	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
eventalarm	0~63	0 6/6 Event/alarm channel for DSCP		DSCP
management	0~63	0	6/6	Management channel for DSCP
eventtunnel	0~63	0 6/6 Event/Control channel for DSCP		DSCP

7.7.3 IPV6

Subgroup of network: ipv6

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
enable		0	6/6	Enable IPv6.
addonipaddress			6/6	IPv6 IP address.
addonprefixlen	0~128	64 6/6 IPv6 prefix length.
addonrouter			6/6	IPv6 router address.
addondns			6/6	IPv6 DNS address.
allowoptional		0	6/6	Allow manually setup of IP address setting.

7.7.4 FTP

Subgroup of network: ftp

NAME VALUE DEF	AULT SECURITY		(get/set)	DESCRIPTION
port 21, 1025~65535	21 6/6 Local ftp server port.

7.7.5 HTTP

Subgroup of network: http

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
port	80, 1025 ~ 65535	80 1/6 HTTP port.
alternateport 1025~65	535 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.
s1_accessname	string[32]	video2.mjpg	1/6	HTTP server push access name for stream 2.
s2_accessname	string[32]	video3.mjpg	1/6	Http server push access name for stream 3
anonymousviewing		0	1/6	Enable anonymous streaming viewing.

7.7.6 HTTPS port

Subgroup of network: https

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
port	443, 1025 ~ 65535	443	1/6	HTTPS port.

7.7.7 RTSP

Subgroup of network: rtsp

NAME VALUE DEFAULT SECURITY		(get/set)	DESCRIPTION
port 554, 1025 ~65535	554 1/6 RTSP port.
anonymousviewing	0	1/6	Enable anonymous streaming viewing.
authmode	disable, basic, digest	disable 1/6 RTSP authentication mode.
s0_accessname	string[32]	live.sdp	1/6	RTSP access name for stream1.
s1_accessname	string[32]	live2.sdp	1/6	RTSP access name for stream2.
s2_accessname	string[32]	live3.sdp	1/6	RTSP access name for stream3

7.7.7.1 RTSP multicast

Subgroup of network_rtsp_s<0\~(n-1)>: multicast, n is stream count

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
alwaysmulticast		0	4/4	Enable always multicast.
ipaddress		For n=0,239.128.1.99For n=1,239.128.1.100,and so on.	4/4	Multicast IP address.
videoport	1025 ~ 65535	5560+n*2	4/4	Multicast video port.
audioport	1025 ~ 65535	5562+n*2	4/4	Multicast audio port.
metadaport	1026~65534	6560+n*2	4/4	Multicast metadata port.
ttl	1 ~ 255	15	4/4	Multicast time to live value.

7.7.8 SIP port

Subgroup of network: sip

NAME VALUE DE	FAULT SECURIT		Y (get/set)	DESCRIPTION
port 1025 ~ 65535	5060 1/6 SIP port.

7.7.9 RTP port

Subgroup of network: rtp

NAME VALUE DE	FAULT SECURIT		Y(get/set)	DESCRIPTION
videoport 1025 ~ 65	535 5556 6/6	Video channel port	for RTP.
audiport 1025 ~ 65	535 5558 6/6	Audio channel port	for RTP.
metadaport 1025 ~	65535 6556 6/6	Metadata channel	for RTP.

7.7.10 PPPoE

Subgroup of network: pppoe

NAME VALUE DEF	AULT SECURITY		(get/set)	DESCRIPTION
user	string[128]		6/6	PPPoE account user name.
pass	password[64]		6/6	PPPoE account password.

7.8 IP Filter

7.8.1 ipfilter for ONVIF

Group: ipfilter

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
enable0	6/6 Enable access list filtering.
admin_enable0 6/6 Enable administrator IP				address.
admin_ip String[43]		6/6 Administrator IP address.
maxconnection	0~10	10	6/6	Maximum number of concurrent streaming connection(s).
type	0, 1	1	6/6	Ipfilter policy :0 => allow1 => deny
ipv4list_i<0~9>	String[31]		6/6	IPv4 address list.
ipv6list_i<0~9>	String[43]		6/6	IPv6 address list.

7.9 video input

Group: videoin

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
cmosfreq 50, 60	60	4/4 CMOS frequency.
whitebalance	auto, manual, rbgain	auto	4/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
color	0, 1	1	4/4 0 =>mono chrome1 => color
flip		0	4/4	Flip the image.
mirror		0	4/4	Mirror the image.

text string[16] <blank> 1/4 Enclose caption.
imprinttimestamp <boolean> 0 4/4 Overlay time stamp on video.

7. 9.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
whitebalance	auto, manual, rbgain	auto 4/4 “auto” indicates auto	auto white balance. “manual” indicates keep current value. “rbgain” indicates using rgain and gbain.
rgain	0~100 16	4/4 Manual set rgain value of gain control setting.
bgain	0~100 21	4/4 Manual set bgain value of gain control setting.
exposurelevel	0~8	4	4/4	Exposure level
cmosfreq	50, 60 60	4/4 CMOS frequency.
mode	0 ~ "capability_ videoin_c<n mode"-1	0	4/99	Indicate the video mode on use.
maxgain	0~5	5	4/4	Manual set maximum gain value.
mingain	0~100	0	4/4	Manual set minimum gain value.
color	0, 1	1	4/4 0 =>monochrome 1 => color
flip		0	4/4	Flip the image.
mirror		0	4/4	Mirror the image.
ptzstatus		2	1/7	A 32-bit integer, each bit can be set separately as follows: Bit 0 => Support camera control function; 0(not support), 1(support) Bit 1 =>Built-in or externalcamera; 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 4/4 Overlay time stamp on				video.
textonvideo_position top, bottom top 4/4 Position of timestamp and				video title on image
textonvideo_size	15,25,30	15	4/4	Timestamp and video font-size
minexposure	5~32000	32000	4/4	Minimum exposure time.
maxexposure	5~32000	30	4/4	Maximum exposure time.
s<0~(m-1)>_codectype	mjpeg, h264	h264	1/4	Video codec type.svc is only supported with stream 0.
s<0~(m-1)>_resolution	Reference capability_vide oin_resolution	1280x800	1/4 Video resolution in pixels.
s<0~(m-1)>_h264_intraperiod	250, 500,1000, 2000,3000, 4000	1000	4/4	Intra frame period in milliseconds.
s<0~(m-1)>_h264_priority policy	framerate, imagequality	imagequal ity	4/4 The policy	to apply when the target bit rate is not sufficient to satisfy current encoded conditions. “framerate” indicates frame rate first. “imagequality” indicates image quality first.
s<0~(m-1)>_h264_ratecontrol mode	cbr, vbr, smart cbr	4/4 cbr, constant bitrate		vbr, fix quality
s<0~(m-1)>_h264_quant 1~5,99	100 3 4/4 Quality of video when			choosing vbr in “ratecontrolmode”. 1 = worst quality, 5 = best quality. 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue"
s<0~(m-1)>_h264_qpercent	1~100 50	4/4 Set quality by percentage.		1: Worst quality 100: Best quality (s<0~(m-1)>_h264_quant = 100)
s<0~(m-1)>_h264_qvalue	0~51	29	4/4 Manual	video quality level input. (s<0~(m-1)>_h264_quant = 99)
s<0~(m-1)>_h264_bitrate	1000~4000000 0	3000000 4/4	Set bit rate in bps when choosing cbr in “ratecontrolmode”.
s<0~(m-1)>_h264_maxframe	1~30	30	1/4	Set maximum frame rate in fps (for h264).
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_smartstream_mode	autotracking, manual,hybrid	autotracking	4/4	Indicate the samrt stream mode on use.
s0_h264_smartstream_win_i<0~(m-1)enable		Enable smart stream.
s<0~(m-1)_h264_smartstream_win_i<0~(m-1)_home	"0~320","0~240	150, 110 4/4		Left-top corner coordinate of the smart stream window.
s<0~(m-1)_h264_smartstream_win_i<0~(m-1)_size	"0~320","0~240	100x75	4/4	Width and height of the smart steam window.
s<0~(m-1)>_h264_smartstream_background_quant	0~5	1	4/4	Quality of background quality0 = worst quality, 5 = best quality.
s<0~(m-1)>_h264_smartstream_foreground_quant	0~5	3	4/4	Quality of foreground quality0 = worst quality, 5 = best quality.
s<0~(m-1)_h264_smartstream_maxbitrate	1000~40000000	40000000	4/4	Maximum bitrates of smart steam.
s<0~(m-1)>_mjpeg_priority policy	framerate, imagequality	framerate 4/4	The policy to apply when the target bit rate is not sufficient to satisfy current encoded conditions.“framerate” indicates frame rate first.“imagequality” indicates image quality first.
s<0~(m-1)>_mjpeg_rate controlmode	cbr, vbr vbr 4/4	cbr, constant	bitrate	vbr, fix quality
s<0~(m-1)>_mjpeg_quant 1~5	99, 100 3 4/4	Quality of JPEG video.
				1 = worst quality, 5 = best quality.100: Use the quality level in "qpercent"99: Use the quality level in "qvalue"
s<0~(m-1)>_mjpeg_maxframe	1~30 30 1/4 Set maximum frame rate in			fps (for JPEG).
s<0~(m-1)>_mjpeg_qvalue	10~200	49 4/4 Manual video quality		level input.(s<0~(m-1)>_mjpeg_quant = 0)
s<0~(m-1)>_mjpeg_qpercent	1~100 50 4/4 Set quality by percentage.			1: Worst quality100: Best quality(s<0~(m-1)>_mjpeg_quant = 100)
s<0~(m-1)>_mjpeg_bitrate	1000~40000000	6000000 4/4 Set bit rate in		bps when choosing cbr in "ratecontrolmode".
s<0~(m-1)>_forcei N/A N/A	7/6 Force I frame.
piris_mode manual	manual 1/4			PIris mode manual = 0 indoor=1 outdoor=2
piris_sensitivity	1~10 2	4/4 Sensitivity of piris
piris_response	1~10	2	4/4	Response of piris
piris_position	1~100	12	1/4	Position of piris

7.9.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_profile_i<0\~(m-1)>

NAME VALUE DEF	AULT SECURITY		(get/set)	DESCRIPTION
enable0 4/4 Enable/disable this profile setting
policy	day,night,schedule	night 4/4 The mode which the profile is applied to.
begintime hh:mm 18:00 4/4 Begin time of schedule mode.
endtime	hh:mm 06:00	4/4 End time of schedule mode.
exposurelevel	0~8	4 4/4 Exposure level
minexposure	5~32000	32000	4/4	Minimum exposure time.
maxexposure	5~32000	30	4/4	Maximum exposure time.
maxgain	0~5	5	4/4	Manual set maximum gain value.
mingain	0~100	0	4/4	Manual set minimum gain value.
whitebalance auto,	manual,rbgain	auto	4/4	“auto” indicates auto white balance.“manual” indicates keep current value.“rbgain” indicates using rgain and gbain.
rgain	0~100 16 4/4	Manual set rgain value of gain control setting.
bgain	0~100	21	4/4	Manual set bgain value of gain control setting.

7.10 IR cut control

Group: ircutcontrol

NAME VALUE DEFAULT	T SECURITY		(get/set)	DESCRIPTION
mode	auto, day, night, di, schedule	auto 6/6 Set IR cut control mode
sir0 6/6 Enable/disable Smart IR
daymodebegintime 00:00~23:59 07:00 6/6 Day mode begin time
daymodecendtime 00:00~23:59 18:00 6/6 Day mod end time
disableirled		0	6/6	Enable/disable built-in IR led
bwmode		1	6/6	Switch to B/W in night mode if enabled
sensitivity	low, normal, high	normal 6/6 Sensitivity of light sensor

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	0	4/4	Adjust brightness of image according to mode settings.
saturation	-5 ~ 5, 100	100	4/4	Adjust saturation of image according to mode settings.
saturationpercent	0~100	50	4/4	Adjust saturation value of percentage when saturation=100
contrast	-5 ~ 5	0	4/4	Adjust contrast of image according to mode settings.
sharpness -3~3, 100 100 4/4	Adjust sharpness of			image according to mode settings.
sharpnesspercent 0~100 50 4/4	Adjust sharpness of			image by percentage. Softer 0 <-> 100 Sharper
gammacurve 0~100 0 4/4	Gamma curve.
dnr_mode	0~1	1	4/4	3D noise reduction. 0: off 1: on
dnr_strength	1~100	50	4/4	3D noise reduction strength.
lowlightmode		1 4/4 Enable	disable low	light mode.
profile_i0_enable		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_brightness	-5~5	0 4/4 Adjust	brightness of	image according to mode settings.
profile_i0_contrast -5 ~ 5	0 4/4	Adjust contrast of		image according to mode settings.
profile_i0_saturation	-5~5,100	100	4/4	Adjust saturation of image according to mode settings. 100 for saturation percentage mode.
profile_i0_saturationpercent	0~100	50	4/4	when profile_i0_saturation=100, adjust saturation value of percentageaccording to mode settings.
profile_i0_sharpness -3~3,1	00 100 4/4 Adjust	sharpness of		image according to mode settings.
profile_i0_sharpnesspercent	0~100 50 4/4 Adjust	adjust sharpness		value of percentage when sharpness=100
profile_i0_gammacurve 0~1	100 0 4/4 Gamma curve
profile_i0_dnr_mode 0~1 1	4/4 3D noise reduction.			0: off1: on
profile_i0_dnr_strength 1~100 50	4/4 3D noise reduction			strength.
profile_i0_lowlightmode		1	4/4	Enable/disable low light mode.

7.12 Audio input per channel

Group: audioin_c<0\~(n-1)> for n channel products

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
mute	0, 1	0	1/4	Enable audio mute.
gain	0~100	65	4/4	Gain of input.
s<0~(m-1>_codectype	g711, g726	g711	4/4	Set audio codec type for input.
s<0~(m-1>_g711_mode	pcmu, pcma	pcmu	4/4	Set G.711 mode.
s<0~(m-1>_g726_bitrate	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		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_alarm_level	1~100 50	4/4 Audio detection alarm level

7.13 Time Shift settings

Group: timeshift, c for n channel products, m is stream number

NAME VALUE DEFAULT		T	SECURITY(get/set)	DESCRIPTION
enable		0	4/4	Enable time shift streaming.
c<0~(n-1)>_s<0~(m-1)>_allow			4/4	Enable time shift streaming for specific stream.s0 default =1, other default =0.

7.14 Motion detection settings

Group: motion_c<0\~(n-1)> for n channel product

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
enable		0	4/4	Enable motion detection.
win_i<0~2>_enable		0	4/4	Enable motion window 1~3.
win_i<0~2>_name	string[14]		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)>_enable0 4/4 Enable profile 1 ~				(m-1).
i<0~(m-1)>_policy	day,night,schedule	night	4/4 The mode	which theprofile 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	0	4/4 Enable motion		window.
i<0~(m-1)>_win_i<0~2>_name	string[14]		4/4	Name of motion window.
i<0~(m-1)>_win_i<0~2>_left	0 ~ 320	0	4/4	Left coordinate of window position.
i<0~(m-1)>_win_i<0~2>_top	0 ~ 240	0	4/4	Top coordinate of window position.
i<0~(m-1)>_win_i<0~2>_width	0 ~ 320	0	4/4	Width of motion detection window.
i<0~(m-1)>_win_i<0~2>_height	0 ~ 240	0	4/4	Height of motion detection window.
i<0~(m-1)>_win_i<0~2>_objsize	0 ~ 100	0	4/4	Percent of motion detection window.
i<0~(m-1)>_win_i<0~2>_sensitivity	0 ~ 100	0	4/4	Sensitivity of motion detection window.

7.15 Tampering detection settings

Group: tampering_c<0\~(n-1)> for n channel product

NAME VALUE	DEFAULT	T SECURITY	(get/set)	DESCRIPTION
enable0 4/4 Enable or disable tamper detection.
duration 10~600 10 4/4 If tampering value exceeds the ‘th threshold’ formore than ‘duration’ second(s), then tamperdetection is triggered.

7.16 DDNS

Group: ddns

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
enable		0	6/6	Enable or disable the dynamic DNS.
provider	Safe100, DyndnsDynamic, DyndnsCustom, CustomSafe100, PeanutHull	DyndnsDynamic	6/6	Safe100 => safe100.net DyndnsDynamic => dyndns.org (dynamic) DyndnsCustom => dyndns.org (custom) CustomSafe100 => Custom server using safe100 method PeanutHull => PeanutHull
颁布>_hostname	string[128]		6/6	Your DDNS hostname.
usernameemail	string[64]		6/6	Your user name or email to login to the DDNS service provider
passwordkey	string[64]		6/6	Your password or key to login to the DDNS service provider.
servername	string[128]		6/6	The server name for safe100. (This field only exists if the provider is customsafe100)

7.16.1 Express link

Group:expresslink

NAME VALUE DE	FAULT SECURITY		(get/sct)	DESCRIPTION
enable0	6/6 Enable or disable express link.
state	onlycheck, onlyoffline, checkonline, badnetwork	badnetwork 6/6 “onlycheck”	“onlycheck”	You have to input the host name of your camera and press "Register" button to register it.“onlyoffline”: Express link is active, you can now connect to this camera at expresslink_url.“checkonline”: Express link is not active.“badnetwork”: Express Link is not supported under this network environment.
url string[64]	6/6 The URL to connect to this camera			by express link.

7.17 UPnP presentation

Group: upnppresentation

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
enable		1	6/6	Enable or disable the UPnP presentation service.

7.18 UPnP port forwarding

Group: upnpportforwarding

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
enable0	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 portforwarding

7.19 System log

Group: syslog

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
enableremotelog0 6/6 Enable remote log.
serverip6/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_EMERG1: LOG_ALERT2: LOG_CRIT3: LOG_ERR4: LOG_WARNING5: LOG_NOTICE6: LOG_INFO7: LOG_DEBUG
setparamlevel	0~2	0	6/6	Show log of parameter setting.0: disable1: Show log of parameter setting set from external.2. Show log of parameter setting set from external and internal.

7.20 SNMP

Group: snmp

NAME VALUE DE	FAULT 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
authpwrw	string[8~128]		6/6	Read/write authentication password
authpwro	string[8~128]		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]		6/6	Read/write passwd
encryptpwro	string[8~128]		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 Ready only	community

7.21 Layout configuration

Group: layout

NAME	VALUE	DEFAULT	SECURITY(get/set)	DESCRIPTION
logo_default		1	1/6	0 => Custom logo1 => Default logo
logo_link	string[128]	http://www.vivotek.com	1/6	Hyperlink of the logo
logo_powerbyvvtk_hidden		0	1/6	0 => display the power byvivotek logo1 => hide the power by vivotek logo
theme_option 1~4 1 1/6 1~3: One of the default themes.				4: Custom definition.
theme_color_font string[7] #ffffff 1/6 Font color
theme_color_configfont string[7] #ffffff 1/6 Font color of configuration				area.
theme_color_titlefont string[7] #098bd6 1/6 Font color of video title.
theme_color_controlbackground	string[7] #56	5656 1/6 Background color	of control area.
theme_color_configbackground	string[7] #323	232 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] #323	232 1/6 Frame color
custombutton_manualtrigger_show		1 1/6 Show or hide manual trigger(VI) button in homepage0 -> Hidden1 -> Visible

7.22 Privacy mask

Group: privacymask_c<0\~(n-1)> for n channel product

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
enable		0	4/4	Enable privacy mask.
win_i<0~4>_enable		0	4/4	Enable privacy mask window.
win_i<0~4>_name	string[16]		4/4	Name of the privacy mask window.
win_i<0~4>_left	0 ~ 320	0	4/4	Left coordinate of window position.
win_i<0~4>_top	0 ~ 240	0	4/4	Top coordinate of window position.
win_i<0~4>_width	0 ~ 320	0	4/4	Width of privacy mask window.

win_i<0~4>_height 0

~240 0 4/4 Height of privacy mask

window.

7.23 Capability

Group: capability

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
api_httpversion		0300a	0/99	The HTTP API version.
bootuptime		70	0/99	Server bootup time.
nir	0,	1	0/99	Number of IR interfaces.(Recommend to use ir forbuilt-in IR and extir forexternal IR)
npir	0,	1	0/99	Number of PIRs.
ndi	0,	1	0/99	Number of digital inputs.
nvi	0,	3	0/99	Number of virtual inputs(manual trigger)
ndo	0,	1	0/99	Number of digital outputs.
naudioin	0,	1	0/99	Number of audio inputs.
naudioout	0,	1	0/99	Number of audio outputs.
nvideoin		1	0/99	Number of video inputs.
nvideoout	0,	0	0/99	Number of video outinterface.
nvideoinprofile	integer>	1	0/99	Number of video inputprofiles.
nmediastream		3	0/99	Number of media stream per channels.
naudiosetting		1	0/99	Number of audio settings per channel.
nuart	0,	0	0/99	Number of UART interfaces.
nmotion 0,	integer>	3	0/99	Number of motion window.
nmotionprofile 0,	integer>	1	0/99	Number of motion profiles.
ptzenabled 0,	integer>	0	0/99	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 video source;0(external), 1(built-in)Bit 2 => Support pan operation, 0(not support), 1(support)Bit 3 => Support tilt operation; 0(not support), 1(support)Bit 4 => Support zoom operation;0(not support), 1(support)Bit 5 => Support focus operation;0(not support), 1(support)Bit 6 => Support iris operation;0(not support), 1(support)Bit 7 => External or built-in PT; 0(built-in), 1(external)Bit 8 => Invalidate bit 1 ~ 7;0(bit 1 ~ 7 are valid),1(bit 1 ~ 7 are invalid)Bit 9 => Reserved bit;Invalidate lens_pan,Lens_tilt, lens_zoon,lens_focus, len_iris.0(fields are valid),1(fields are invalid)Examples:PT8133: 0b1111SD8362: 0b111111VS8102: 0b10111101
windowless	boolean> 1		0/99	Indicate whether to support windowless plug-in.
eptz 0,	integer>	3	0/99	A 32-bit integer, each bit can be set separately as follows:Bit 0 => stream 1 supports ePTZ or not.Bit 1 => stream 2 supports ePTZ or not.The rest may be deduced by analogy
remotefocus	boolean> 0		0/99	Indicate whether to support remote focus function.
npreset 0,	integer>	20	0/99	Number of preset locations.
protocol_https <boolean> 1			0/99	Indicate whether to support HTTP over SSL.
protocol_rtsp <boolean> 1			0/99	Indicate whether to support RTSP.
protocol_sip	boolean> 0		0/99	Indicate whether to support SIP.
protocol_maxconnection		10	0/99	The maximum allowed simultaneous connections.
protocol_maxgenconnection		10	0/99	The maximum general streaming connections.
protocol_maxmegaconnection		10	0/99	The maximum megapixel streaming connections.
protocol_rtp_multicast_scalable		1	0/99	Indicate whether to support scalable multicast.
protocol_rtp_multicast_backchannel		1	0/99	Indicate whether to support backchannel multicast.
protocol_rtp_tcp		1	0/99	Indicate whether to support RTP over TCP.
protocol_rtp_http		1	0/99	Indicate whether to support RTP over HTTP.
protocol_spush_mjpeg		1	0/99	Indicate whether to support server push MJPEG.
protocol_snmp		1	0/99	Indicate whether to support SNMP.
protocol_ipv6		1	0/99	Indicate whether to support IPv6.
protocol_pppoe		1	0/99	Indicate whether to support PPPoE.
protocol_ieee8021x		1	0/99	Indicate whether to support IEEE802.1x.
protocol_qos_cos		1	0/99	Indicate whether to support CoS.
protocol_qos_dscp		1	0/99	Indicate whether to support QoS/DSCP.
protocol_ddns		1	0/99	Indicate whether to support DDNS.
videoin_type	0, 1, 2	2	0/99	0 => Interlaced CCD 1 => Progressive CCD 2 => CMOS
videoin_codec		mjpeg, h264	0/99	Available codec of a device.The sequence is not limited.
videoin_streamcodec		6,6,6	0/99	This equals "capability_videoin_c0_streamcodec".
videoin_flexiblebitrate 0,1 1	0/99 Support flexible bit rate			control or not.
videoin_c0_resolution	ofavailableresolutionseparated by commas>	176x144,384x216,640x360,1280x720,1280x800	0/99 Available resolutions list.
videoin_c0_nresolution	number ofavailableresolution list>	5 0/99 How many resolution options (listed in "resolution") in current video mode.
videoin_c0_maxframerate	list ofavailablemaximumframe rateseparated by commas>	30,30,30,30,30	0/99 Available maximum frame list.
videoin_c0_mjpeg_maxframerate		30,30,30,30,30	0/99 Available maximum codec frame list.
videoin_c0_h264_maxframe rate		30,30,30,30,30	0/99 Available maximum codec frame list.
timeshift		1	0/99	Indicate whether to support time shift caching stream.
audio_aec	0		0/99	Indicate whether to support acoustic echo cancellation.
audio_mic	1		0/99	Indicate whether to support built-inmicrophone input.
audio_extmic			0/99	Indicate whether to support external microphone input.
audio_intmic			0/99	Indicate whether to support internal microphone input.
audio_linein			0/99	Indicate whether to support external line input.(It will be replaced by audio_mic and audio_extmic.)
audio_lineout		1	0/99	Indicate whether to support line output.
audio_headphoneout		0	0/99	Indicate whether to support headphone output.
audioin_codec		g711, g726	0/99	Available codec list for audio input.
audioout_codec			0/99	Available codec list for SIP.
uart_httptunnel		0	0/99	Indicate whether to support HTTP tunnel for UART transfer.
camctrl_httptunnel		0	0/99	The attribute indicates whether sending camera control commands through HTTP tunnel is supported.0: Not supported1: Supported
camctrl_privilege		1	0/99	Indicate whether to support “Manage Privilege” of PTZ control in the Security page.1: support both/cgi-bin/camctrl/camctrl.cgi and/cgi-bin/viewer/camctrl.cgi0: support only/cgi-bin/viewer/camctrl.cgi
transmission_mode	Tx,Rx,Both	Tx	0/99	Indicate transmission mode of the machine: TX = server, Rx = receiver box, Both = DVR.
network_wire			0/99	Indicate whether to support Ethernet.
network_wireless		0	0/99	Indicate whether to support wireless.
derivative_brand		1	0/99	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)
evctrlchannel			0/99	Indicate whether to support HTTP tunnel for event/control transfer.
joystick			0/99	Indicate whether to support joystick control.
storage_dbenabled		1	0/99	Media files are indexed in database.
nanystream 0,integer>00/99number of any media stream per channel	integer>	0	0/99	number of any media stream per channel
iva		0		0/99
ir		1		0/99
extir		1		0/99
whitelight		0		0/99
iris		0		0/99
tampering			0/99	Indicate whether to support tampering detection.
temperature			0/99	Indicate whether to support temperature detection.
version_onvifdaemon		1.8.06/99		Indicate ONVIF daemon version
version_onvifevent		1.3.0.7	0/99	Indicate ONVIF event version
media_totalspace		20000	0/99	Available memory space (KB) for media.
media_snapshot_sizepersecond		500	0/99	Maximum size (KB) of one snapshot image.
media_snapshot_maxpreevent		7	0/99	Maximum snapshot number before event occurred.
media_snapshot_maxpostevent		7	0/99	Maximum snapshot number after event occurred.
media_videoclip_maxsize		4096	0/99	Maximum size (KB) of a videoclip.
media_videoclip_maxlength		20	0/99	Maximum length (second) of a videoclip.
media_videoclip_maxpreevent		9	0/99	Maximum duration (second) after event occurred in a videoclip.
localstorage_manageable		1	0/99	Indicate whether manageable local storage is supported.
localstorage_seamless		1 0/99 Indicate whether		seamless recording is supported.
localstorage_modnum 0,		4 0/99 The maximum MOD connection numbers.
localstorage_modversion		1.0.1.19	0/99	Indicate MOD daemon version
localstorage_slconnum	0,	1	0/99	The maximum seamless connection number.
	integer>
adaptiverecording		1	0/99	Indicate whether to support adaptive recording.
adaptivestreaming	1 0/99 Indicate whether to			support adaptive streaming.
remotecamctrl_master 0,	positive integer>	0	0/99 Indicate	whether to support remote auxiliary camera (master side), this value means supporting max number of auxiliary camera.
remotecamctrl_slave		0	0/99 Indicate	whether to support remote camera control (slave side).
fisheye		0	0/99 Indicate	where fisheye camera
vadp		127	0/99	An 32-bit integer, each bit can be set separately as follows:Bit 0 => VADP interfaceBit 1 => Capture video raw dataBit 2 => Support encode jpegBit 3 => AudioBit 4 => Event
smartstream_support	1 0/99 Indicate whether smart			stream is supported.
smartstream_nstream		3 0/99 Number of stream		that support smart stream
smartstream_mode_autotracking		1 0/99 Indicate whether		autotracking smart stream is supported
smartstream_mode_manual	1 0/99 Indicate whether manual			smart stream is
				supported
smartstream_mode_hybrid <boolean> 1 0/99		Indicate whether		hybrid(autotracking+ manual) smart stream is supported
smartstream_nwindow_auto tracking		8	0/99	Maximum number of tracking window of autotracking
smartstream_nwindow_manual		3	0/99	Maximum number of tracking window of manual
smartstream_nwindow_hybrid_autotracking		5	0/99	Maximum number of tracking window of autotracking in hybrid mode
smartstream_nwindow_hybrid_manual		3	0/99	Maximum number of tracking window of manual in hybrid mode
smartstream_supportquality		excellent,d etailed,good,standard, medium,low	0/99 Available	able quality of smart stream
smartstream_supportmaxbitrate		1Mbps,2Mbps,4Mbps,6Mbps,8Mbps,10Mbps,20Mbps,30Mbps,40Mbps	0/99 Available	able maxbitrate of smart stream
version_genetec		1.0.2.3	0/99	Indicate genetec version

Group: capability_image_c, where n = channel index from 0 \~ "capability_nvideoin"-1

NAME VALUE DEFAULT SECURITY		(get/set)	DESCRIPTION
wdrc 0,1 0		0/99	0: Non-support WDREnhanced1: Support WDR Enhanced

wdr 0,1 1			0/99	0: Non-support WDR Pro1: Support WDR Pro
dnr 0,1 1			0/99	0: Non-support 3D noise reduction1: Support 3D noise reduction
iristype piris, dciris, - piris			0/99	Indicate iris type."piris": P-Iris"dciris": DC-Iris"-": No Iris control support* Note: For some cameras, this value may be varied depending on mounted lens.
focusassist 0,1 0			0/99	0: Non-support focus assistance1: Support focus assistance

7.24 WebAPI: Information for a channel

Group: capability_ videoin_c, n = channel index from 0 to "capability_nvideoin"-1

PARAMETER VALUE	DEFAULT	SECURITY	(get/set)	DESCRIPTION
nmode		1 0/99 Indicate how many video modes supported by this channel.
maxsize		1280x800	0/99	The maximum resolution of all modes in this channel, the unit is pixel.
mode		0	0/99	Indicate current video mode.
nresolution		5 0/99 How many resolution options (listed in "resolution") in current video mode.
resolution	A list of	176x144,384x216,640x360,1280x720,1280x800	0/99 Resolution options in current video mode. These options are the possible options for "videoin_c<s Mali resolution". The last one is the maximum resolution in current mode.
maxframerate A list of		30,30,30,30,30,	0/99 Indicate	how many frame rate image sensor outputs in current video mode.One to one mapping to the resolution in "resolution".
mjpeg_maxframerate A list ofand "-"		30,30,30,30,30,	0/99 Maximum	fps that the device can encoded with MJPEG on resolutions in current video mode."-" means not support.
mjpeg_maxbitrate	, -	40000000 0/99	Maximum	bitrates of MJPEG.The unit is bps."-" means MJPEG does not support bit rate control.
h264_maxframerate A list ofand "-"		30,30,30,30,30,	0/99 Maximum	fps that the device can encoded with H.264 on resolutions in current video mode."-" means not support.
h264_maxbitrate		40000000 0/99	Maximum	bitrates of H.264.The unit is bps.
streamcodec		6,6,6 0/99	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 MJPEGBit 2: Support H.264

7.25 WebAPI: Information for a mode

Group: capability_videoin_c_mode, n = channel index from 0 to "capability_nvideoin"-1, m = mode index from 0 to "capability_videoin_c_nmode"-1

PARAMETER VALUE	DEFAULT	SECURITY	(get/set)	DESCRIPTION
effectivepixel		1280x800	0/99 The visible area of full scene in this video mode.The unit is pixel in source.
outputsize		1280x800	0/99 The output size of source, equal to the captured size by device, in this video mode. The unit is pixel.This value is used as a basic coordinate system for many features, like ePTZ, privacy mask, motion, etc.
binning 0, 1, 3		0	0/99 Indicate binning is used or not in this video mode.0: No binning1: 2x2 binning3: 3x3 binning
nresolution		5	0/99 How many resolution options in this video mode.
resolution A list of		176x144, 384x216, 640x360, 1280x720, 1280x800	0/99 Resolution options in this video mode.The last one is the maximum resolution in this video mode.
maxframerate A list of		30, 30, 30, 30, 30	0/99 Indicate how many frame rate image sensor outputs in this video mode.
maxfps_mjpeg A list of		30, 30, 30, 30, 30	0/99 Maximum fps which the device can encoded with MJPEG on resolutions in this video mode."-" means not support.

maxfps_h264 A list of		0/99 Maximum fps which the device can encoded with H.264 on resolutions in this video mode."-" means not support.* One to one mapping to the resolution in "resolution".* The element number is defined as "nresolution" in this group.* This parameter records the frame rate when"videoin_ccmosfreq"=60 or"videoin_cmodulation"=ntsc* Only available when 'h264' is listed in "capability_videoin_codec".
	30, 30, 30, 30, 30
description		na	0/99 Description about this mode.

7.26 Customized event script

Group: event_customtaskfile_i<0\~2>

PARAMETER VALUE	Default SECURITY	(get/set)	DESCRIPTION
name string[40] NULL	6/6 Custom script identification of this		entry.
date string[4-20] NULL	6/6 Date of custom script.
time string[4-20] NULL	6/6 Time of custom script.

7.27 Event setting

Group: event_i<0\~2>

PARAMETER VALUE	Default SECURITY		(gct/set)	DESCRIPTION
name string[40] NULL	6/6 Identification of this entry.
enable 0, 1 0 6/6 Enable	or disable this event.
priority 0, 1, 2	6/6 Indicate the priority of this event:		event:	“0” = low priority“1” = normal priority“2” = high priority
delay 1~999 10	6/6	Delay in seconds before detecting the next event.
trigger	boot,di,pir,motion,seq,recnotify,tampering,vi,volalarm,vadp	boot	6/6 Indicate the trigger condition:“boot” = System boot“di” = Digital input“pir” = PIR detection“motion” = Video motion detection“seq” = Periodic condition“recnotify” = Recording notification.“tampering” = Tamper detection.“vi” = Virtual input (Manual trigger)“volalarm” = Audio detection.“vadp” = VADP trigger
triggerstatus	String[40]	trigger	6/6	The status for event trigger
di	0, 1 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.
vimdwin 0~7 0 6/6 Indicate the source window id of	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.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.
inter 1~999 1 6/6 Interval of snapshots in minutes.				This field is used when trigger condition is “seq”.
weekday 0~127 127 6/6	Indicate which	weekday is scheduled.		One bit represents one weekday.bit0 (LSB) = Saturdaybit1 = Fridaybit2 = Thursdaybit3 = Wednesdaybit4 = Tuesdaybit5 = Mondaybit6 = SundayFor 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_cf_enable	0.1 0 6/6 Enable media write on CF or other			local storage media

action_cf_folder string[12]	8] NULL 6/6	Path to store media.
action_cf_media NULL, 0~4 NULL 6/6		Index of the attached media.
action_cf_datefolder		1 6/6	Enable this to create folders by date, time, and hour automatically.
action_cf_backup <boolean> 0 6/6 Enable the capability of backing up			recorded files to the SD card when network is lost.0: Disabled1: Enabled
action_server_i<0~4>_enable	0, 1 0 6/6 Enable or disable this server action.
action_server_i<0~4>_media	0~4, 101 NULL 6/6 Index of the attached media.
action_server_i<0~4>_datefolder	<boolean> 0 6/6 Enable this to create folders by date, time, and hour automatically.
vadp		0 6/6	Indicate the source id of vadp event notification.Each bit corresponds to one vadp source, and the LSB indicates source id 0.For example, to detect event from any one of source id 0, 1 and 3, set vadp to 11.

7.28 Server setting for event action

Group: server_i<0\~4>

PARAMETER	VALUE	DEFAULT	SECURITY (gct/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 mode1 = 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.

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	to the server or store on the server.
snapshot_source 0~2 0	6/6 Indicate the source of media			stream.0 means the first stream.1 means the second stream.2 means the third stream.
snapshot_prefix string[16]	6/6	Indicate the prefix of the filename.
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		images
videoclip_source	0~2 0 6/6 Indicate the source of media			stream.0 means the first stream.1 means the second stream.2 means the third stream.
videoclip_prefix string[16]	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 ~ 4096	500	6/6	Maximum size of one video clip file in Kbytes.

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.
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,1,2 0 6/6 Indicate the source of media stream.				0 means the first stream.1 means the second stream and so on.
limitsize	0,1	0 6/6 0: Entire free space mechanism
cyclic	0,1	0 6/6 0: Disable cyclic recording
notify	0,1	1 6/6 0: Disable 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.
weekday 0~127 127 6/6	Indicate which	weekday is		scheduled.One bit represents one weekday.bit0 (LSB) = Saturdaybit1 = Fridaybit2 = Thursdaybit3 = Wednesdaybit4 = Tuesdaybit5 = Mondaybit6 = SundayFor example, to detect events onFriday and Sunday, set weekday as66.
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 schedulealways on)
prefix string[16] <blank>	6/6 Indicate the prefix of the filename.
cyclesize 100~ 100 6/6	The maximum size for cycle			recording in Kbytes when choosingto limit recording size.
reserveamount	0~15000000	100 6/6 The reserved amount in Mbyteswhen choosing cyclic recordingmechanism.
dest	cf,0~4	cf	6/6 The destination to store the recordeddata.“cf” means local storage (SD card).“0~4” means the index of thenetwork storage.
cffolder	string[128]	NULL	6/6	Folder name.
trigger	schedule,networkfail	schedule 6/6 The event trigger typeschedule: The event is triggered byschedulenetworkfail: The event is triggeredby the failure of network connection.
adaptive_enable	0,1	0	6/6	Indicate whether the adaptivercording is enabled

adaptive_preevent 0~9 5	6/6 Indicate when is the adaptive		recording started before the event trigger point (seconds)
adaptive_postevent 0~10	5 6/6 Indicate when is the adaptive		recording stopped after the event trigger point (seconds)
maxsize 100~2000 100	6/6		Unit: Mega bytes.When this condition is reached, recording file is truncated.
maxduration	60~3600	60	6/6

7.31 HTTPS

Group: https

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
enable		0	6/6	To enable or disable secure HTTP.
policy		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~3650 36	50 6/6 Valid period	for the

7.32 Storage management setting

Currently it's for local storage (SD card)

Group: disk_i<0\~(n-1)> n is the total number of storage devices.

PARAMETER	VALUE	Default	SECURITY (get/set)	DESCRIPTION
cyclic_enabled		0	6/6	Enable cyclic storage method.
autocleanup_enabled		0	6/6	Enable automatic clean up method.Expired and not locked media files will be deleted.
autocleanup_maxage	1~	7	6/6	To specify the expired days for automatic clean up.

7.33 Region of interest

Group: roi_c<0\~(n-1)> for n channel product, and m is the number of streams which support ROI.

PARAMETER	VALUE	Default	SECURITY (get/set)	DESCRIPTION
s<0~(m-1)>_home		0,0	1/6	ROI left-top corner coordinate.
s<0~(m-1)>_size		1280x800	1/6	ROI width and height. The width value must be multiples of 16 and the height value must be multiples of 8

7.34 ePTZ setting

Group: eptz_c<0\~(n-1)> for n channel product.

PARAMETER VALUE	Default SECURITY		(get/set)	DESCRIPTION
osdzoom <boolean> 1 1/4 Indicates multiple of zoom in is				“on-screen display” or not
smooth <boolean> 1 1/4 Enable the ePTZ "move smoothly"				feature
tiltspeed -5 ~ 5 0 1/7 Tilt speed				(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)
panspeed -5 ~ 5 0 1/7 Pan speed				(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)
zoomspeed	-5 ~ 5 0 1/7 Zoom speed			(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)
autospeed	1 ~ 5	1 1/7 Auto pan/patrol speed		(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)

Group: eptz_c<0\~(n-1)>_s<0\~(m-1)> for n channel product and m is the number of streams which support ePTZ.

PARAMETER VALUE	Default SECURITY		(get/set)	DESCRIPTION
patrolseq	string[120]		1/4	The patrol sequence of ePTZ. All the patrol position indexes will be separated by ","
patroldwelling	string[160]		1/4	The dwelling time (unit: second) of each patrol point, separated by “,”.
preset_i<0~19>_name	string[40]		1/7	Name of ePTZ preset.(It should be set by ePreset.cgi rather than by setparam.cgi.)
preset_i<0~19>_pos			1/7	Left-top corner coordinate of the preset.(It should be set by ePreset.cgi rather than by setparam.cgi.)

preset_i<0~19>_size

1/7 Width

and height of

the preset.(It should be set by ePreset.cgi rather than by setparam.cgi.)

7.35 Exposure window setting per channel

Group: exposurewin_c<0\~(n-1)> for n channel products

NAME VALUE DEFAULT	LT SECURITY		(get/set)	DESCRIPTION
mode auto, custom,	blc	auto 4/4 The mode indicates		how to decide the exposure.auto: Use full view as the only one exposure window.custom: Use inclusive and exclusive window.blc: Use BLC.
win_i<0~9>_enable		0	4/4	Enable or disable the window.
win_i<0~9>_policy	0~1	0	4/4	0: Indicate exclusive.1: Indicate inclusive.
win_i<0~9>_home		110,90	4/4	Left-top corner coordinate of the window.
win_i<0~9>_size		100x75	4/4	Width and height of the window.

Group: exposurewin_c<0\~(n-1)>_profile for m profile and n channel product

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
i<0~(m-1)>_mode	auto, custom, blc	auto	4/4	The mode indicates how to decide the exposure.auto: Use full view as the only one exposurewindow.custom: Use inclusive and exclusive window.blc: Use BLC.
i<0~(m-1)>_win_i<0~9>_enable		0 4/4 Enable or disable the		window.
i<0~(m-1)>_win_i<0~9>_policy	0~1 0 4/4 0: Indicate exclusive.			1: Indicate inclusive.
i<0~(m-1)>_win_i<0~9>_home	110,90 4/4 Left-top corner			coordinate of the window.
i<0~(m-1)>_win_i<0~9>_size	100x75 4/4 Width and height of			the window.

7.36 Seamless recording setting

Group: seamlessrecording

PARAMETER VALUE	Default SEC	URITY	(get/set)	DESCRIPTION
diskmode	scamless, manageable	scamless	1/6 “scamless” indicates enable seamless recording. “manageable” indicates disable seamless recording.
maxconnection	3	3	1/6	Maximum number of connected seamless streaming.
stream	0~3	1	1/6	(Internal used, read only)
output	0~3	2	1/6	(Internal used, read only)
enable		0	1/6	Indicate whether seamless recording is recording to local storage or not at present. (Read only)
guid<0~2>_id	string[127]		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.37 VIVOTEK Application Development Platform setting

Group: vadp

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
version1.2.1.06/7 Indicate the VADPversion.				version.
resource_total_memory			6/7 Indicate total available memory size for VADP modules.
resource_total_storage			6/7 Indicate total size of the internal storage space for storing VADP modules.
resource_free_memory			6/7 Indicate free memory size for VADP modules.
resource_free_storage			6/7 Indicate current free storage size for uploading VADP modules.
module_number		0	6/7	Record the total module number that already stored in the system.
module_order	string[40]		6/6 The execution order of the enabled modules.
module_save2sd		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
enable0 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]	6/6	Module name
url	string[120]	6/6	Define the URL	stringafter the IP address if the module provides it own web page.
vender	string[40]	6/6	The provider of the module.
vendorurl	string[120]	6/6	URL of the vendor.
version	string[40]	6/6	Version of the module.
license	string[40]		6/6	Indicate the license status of the module.
path	string[40]	6/6	Record the storage path of the module.
initscr	string[40]	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.

8. Useful Functions

8.1 Drive the Digital Output

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 

8.2 Query Status of the Digital Input

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 can be 0 or 1.

Example: Query the status of digital input 1.

Request:
http://myserver/cgi-bin/dido/getdi.cgi?di1 

Response:

HTTP/1.0 200 OK\r\n
Content-Type: text/plain\r\n
Content-Length: 7\r\n
\r\n
di1=1\r\n 

8.3 Query Status of the Digital Output

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: \r\n

\r\n

[do0=]\r\n

[do1=]\r\n

[do2=]\r\n

[do3=]\r\n

where 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

\r\n

do1=1\r\n

8.4 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		0 The resolution of the image.
quality 1~5 3	The quality of the image.
streamid	0~(m-1)		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> 

8.5 Account Management

Note: This request requires Administrator privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/admin/editaccount.cgi? method=<value>&username=<name>[&userpass=<value>][&privilege=<value>][&privilege=<value>][...][&return=<return page>] 

PARAMETER 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.
usernameThe name of the user to add, delete, or edit.
userpassThe password of the new user to add or that of the old user to modify. The default value is an empty string.
Privilege
	viewer Viewer privilege.
	operator	Operator privilege.
	admin	Administrator privilege.
Return

8.6 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: \r\n

\r\n

<system log information>\r\n 

8.7 Upgrade Firmware

Note: This request requires Administrator privileges.

Method: POST

Syntax:

http://<servername>/cgi-bin/admin/upgrade.cgi 

Post data:

fimage=[&return=]\r\n

\r\n

<multipart encoded form data> 

Server will accept the file named to upgrade the firmware and return with if indicated.

8.8 ePTZ Camera Control

Note: This request requires camctrl privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/camctrl/eCamCtrl.cgi?channel=<value>&stream=<value>
[&move=<value>] - Move home, up, down, left, right
[&auto=<value>] - Auto pan, patrol
[&zoom=<value>] - Zoom in, out
[&zooming=<value>&zs=<value>] - Zoom without stopping, used for joystick
[&vx=<value>&vy=<value>&vs=<value>] - Shift without stopping, used for joystick
[&x=<value>&y=<value>&videosize=<value>&resolution=<value>&stretch=<value>] - Click on image
(Move the center of image to the coordination (x,y) based on resolution or videosize.)
[ [&speedpan=<value>][&speedtilt=<value>][&speedzoom=<value>][&speedapp=<value>] ] - Set speeds
[&return=<return page>] 

Example:

http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=0&move=right
http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=1&vx=2&vy=2&vz=2
http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=1&x=100&y=100&videosize=640x480&resolution=640x480&stretch=0 

PARAMETER VALUE DESCRIPTION
channel <0~(n-1)> Channel of video source.
stream	<0~(m-1)>	Stream.
move home Move to home ROI.
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 withzs speed, used for joystick control.
zs 0~6 Set the speed of zooming, “0” means stop.
vxThe direction of movement, used for joystick control.
vy
vs 0~7 Set the speed of movement, “0” means stop.
x		x-coordinate clicked by user.It will be the x-coordinate of center after movement.
y		y-coordinate clicked by user.It will be the y-coordinate of center after movement.
videosize	The size of plug-in (ActiveX) window in web page
resolution		The resolution of streaming.
stretch		0 indicates that it usesresolution(streaming size) as the range of the coordinate system.1 indicates that it usesvideosize(plug-in size) as the range of the coordinate system.
speedpan	-5~5	Set the pan speed.
speedtilt	-5~5	Set the tilt speed.
speedzoom	-5~5	Set the zoom speed.
speedapp	1~5 Set the auto pan/patrol speed.
return		Redirect to the pageafter the parameter is assigned. Thecan be a full URL path or relative path according to the current path.

8.9 ePTZ Recall

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		Redirect to the pageafter the parameter is assigned. Thecan be a full URL path or relative path according to the current path.

8.10 ePTZ Preset Locations

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	ing less than 40 characters>	Add one preset location to the preset list.
delpos	ing less than 40 characters>	Delete preset location from the preset list.
return		Redirect to the pageafter the parameter is assigned. Thecan be a full URL path orrelative path according to the current path.
8.11 IP FilteringNote: This request requires Administrator access privileges.Method: GET/POSTSyntax:http://cgi-bin/admin/ipfilter.cgi?method=&[start=&end=&index=&return=]
PARAMETER VALUE DESCRIPTION
method addallow	Add allowed IP address	ss range to the server. Start and end parameters must be specified. If the index parameter is specified, it will try to add starting from the index position.
	adddeny Add denied IP address range to the server. Start and end parameters must be specified. If the index parameter is specified, it will try to add starting from the index position.
	deletcallow Remove allowed IP address range from server. If start and end parameters are specified, it will try to remove the matched IP address. If index is specified, it will try to remove the address from given index position. [start, end] parameters have higher priority then the [index] parameter.
	deletedeny Remove denied IP address range from server. If start and end parameters are specified, it will try to remove the matched IP address. If index is specified, it will try to remove the address from given index position. [start, end] parameters have higher priority then the [index] parameter.
startThe starting IP address to add or to delete.
endThe ending IP address to add or to delete.
index		The start position to add or to delete.
return		Redirect to the pageafter the parameter is assigned. Thecan 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.

8.11.1 IP Filtering for ONVIF

Syntax:

http://cgi-bin/admin/ipfilter.cgi?type[=]
http://cgi-bin/admin/ipfilter.cgi?method=add&ip=[&index=&return=]
http://cgi-bin/admin/ipfilter.cgi?method=del&index=[&return=&return=
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.
ipSingle address:Network address:Range address:
indexThe start position to add or to delete.
return		Redirect to the pageafter the parameter is assigned. Thecan 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.

8.12 Event/Control HTTP Tunnel Channel

Note: This request requires Administrator privileges.

Method: GET and POST

Syntax:

http:///cgi-bin/admin/ctrlevent.cgi

GET /cgi-bin/admin/ctrlevent.cgi

x-sessioncookie: string[22]

accept: application/x-vvtk-tunnelled

pragma: no-cache

cache-control: no-cache

POST /cgi-bin/admin/ ctrlevent.cgi

x-sessioncookie: string[22]

content-type: application/x-vvtk-tunnelled

pragma : no-cache

cache-control : no-cache

content-length: 32767

expires: Sun, 9 Jam 1972 00:00:00 GMT

User must use GET and POST to establish two channels for downstream and upstream. The x-sessioncookie in GET and POST should be the same to be recognized as a pair for one session. The contents of upstream should be base64 encoded to be able to pass through the proxy server.

This channel will help perform real-time event subscription and notification as well as camera control more efficiently. The event and control formats are described in another document.

See Event/control tunnel spec for detail information

8.13 Get SDP of Streams

Note: This request requires Viewer access privileges.

Method: GET

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.

8.14 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.

8.15 Storage managements

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		Required.Command to be executed, including search, insert, delete, update, and queryStatus.

Command: search

PARAMETER VALUE DESCRIPTION
label	Optional.	The integer primary key column will automatically be assigned a unique integer.
triggerType		Optional.Indicate the event trigger type.Please embrace your input value with single quotes.Ex. mediaType='motion'Support trigger types are product dependent.
mediaType		Optional.Indicate the file media type.Please embrace your input value with single quotes.Ex. mediaType='videoclip'Support trigger types are product dependent.
destPath		Optional.Indicate the file location in camera.Please embrace your input value with single quotes.Ex. destPath ='/mnt/auto/CF/NCMF/abc.mp4'
resolution		Optional.Indicate the media file resolution.Please embrace your input value with single quotes.Ex. resolution='800x600'
isLocked		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		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	Optional.	Limit the maximum number of returned search records.
offset	Optional.	Specifies how many rows to skip at the beginning of the matched records.Note that the offset keyword is used after limit keyword.

To increase the flexibility of search command, you may use “OR” connectors for logical “OR” search operations. Moreover, to search for a specific time period, you can use “TO” connector.

Ex. To search records triggered by motion or di or sequential and also triggered between 2008-01-01 00:00:00 and 2008-01-01 23:59:59.

http:///cgi-bin/admin/lsctrl.cgi?cmd=search&triggerType='motion'+OR+'di'+OR+'seq' &triggerTime='2008-01-01 00:00:00'+TO+'2008-01-01 23:59:59'

Command: delete

PARAMETER VALUE DESCRIPTION
labelRequired.Identify the designated record.Ex. label=1	required.

Ex. Delete records whose key numbers are 1, 4, and 8.

http:///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		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 

8.15.1 Return Message

The returned results are always in XML format, except for storage status related elements that can be returned in javascript format. (i.e. status, totalSize,_freeSize, and usefulness.)

The elements are listed as follows.

Group: stormgr

Element name	Type Description
counts	Integer> Total number	of matched records.
limit	Limit the maxi	num number of returned search records.Could be empty if not specified.
offset	Specifies how many rows to skip at the beginning of the matched records.Could be empty if not specified.
statusCode		The reply status (see table below)
		Value of return-code	Description
		200	OK
		400	Unrecognized Message Type/Content
		500	Server executes command error.
		501	Parse Input Message Failed.
		502	Error Occurs When Searching Database.
		503	Storage is Not Ready.
statusString	string	Return string describing the reason that status code is not OK.

Subgroup of stormgr: i<0\~(n-1)>: n is the total number of displayed records.

Element name Type Description
labelA unique integer.
triggerTypeIndicate the event trigger type.
mediaType	Indicate the file media type.
destPathIndicate the file location in camera.
resolutionIndicate the media file resolution.
isLockedIndicate if the file is locked or not.
triggerTimeIndicate the event trigger time.Format is “YYYY-MM-DD HH:MM:SS”
backup		Indicate if the file is generated when network loss.

Subgroup of stormgr_disk: i<0\~(n-1)>: n is the total number of storage devices.

Element name	Type Description
name	string	Description of specified storage device.
status	ready, detached, error, and readonly	The storage device status.ready: storage is ready for access.detached: storage is not mounted.error: failed to open storage device.readonly: storage is write protected.
totalSize		The overall storage size in kilobytes.
freeSize		The available storage size in kilobytes.
usedSize		The used storage size in kilobytes.
path	string	Location of database of storage sink

Ex. Returned results of search command

<?xml version="1.0" encoding="ISO-8859-1" ?>
<stormgr version="0.0.0.1">
    <counts>5</counts>
    <limit>2</limit>
    <offset>0</offset>
    <i0>
    <label>1</label>
    <triggerType>motion</triggerType>
    <mediaType>videoclip</mediaType>
    <destPath>/mnt/auto/NCMF/abc/abc.jpg</destPath>
    <resolution>800x600</resolution>
    <isLocked>0</isLocked> 

<triggerTime>2009-01-24 12:00:00</triggerTime>
<backup>0</backup>
</i0>
<i1>
<label>2</label>
<triggerType>di</triggerType>
<mediaType>snapshot</mediaType>
<destPath>/mnt/auto/NCMF/123/123.jpg</destPath>
<resolution>800x600</resolution>
<isLocked>0</isLocked>
<triggerTime>2009-01-24 12:01:00</triggerTime>
<backup>0</backup>
</i1>
</stormgr> 

Ex. Local storage status in XML format.

<?xml version="1.0" encoding="ISO-8859-1" ?>
<stormgr version="0.0.0.1">
    <disk>
    <i0>
    <name>SDcard</name>
    <status>ready</status>
    <totalSize>7824444</totalSize>
    <freeSize>7824388</freeSize>
    <usedSize>56</usedSize>
    </i0>
    </disk>
</stormgr> 

Ex. Local storage status in javascript format.

disk_i0_name='SDcard'
disk_i0_status='ready'
disk_i0_totalSize='7824444'
disk_i0_freeSize='7824388'
disk_i0_usedSize='56'
disk_i0_path=i0/NCMF/.db/.localStorage.db 

Command: queryStatus

PARAMETER VALUE DESCRIPTION 

retType xml or javascript Optional.

Ex. retype=javascriptThe default return message is in XML format.

Ex. Query local storage status and call for javascript format return message.

http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=queryStatus&retType=javascript 

There are two cgi commands for download and composing jpegs to avi format.

For download single selected file, you can use "/cgi-bin/admin/downloadMedias.cgi". Just assign the request file path to this cgi.

Syntax:

http://<servername>/cgi-bin/admin/downloadMedias.cgi?<File_Path> 

The is in querystus return message.

Ex.

http://<servername>/cgi-bin/admin/downloadMedias.cgi?/mnt/auto/CF/NCMF/20090310/07/02.mp4 

For creating an AVI file by giving a list of JPEG files, you can use "/cgi-bin/admin/jpegtoavi.cgi".

Syntax:

http://<servername>/cgi-bin/admin/jpegtoavi.cgi?<resolution>=<width>x<height>&<fps>=<num>&<list>=<fileList> 

PARAMETER VALUE DESCRIPTION
resolution	x	Resolution
fps	Frame rate
list	The JPEG file list.	The file path should be embraced by single quotation marks

Ex.

http://<servername>/cgi-bin/admin/
jpegtoavi.cgi?resolution=800x600&fps=1&list='/mnt/auto/CF/NCMF/video1650.jpg', '/mnt/auto/CF/NCMF/video1651.jpg', '/mnt/auto/CF/NCMF/video1652.jpg', 

8.16 Virtual input

Note: Change virtual input (manual trigger) status.

Method: GET/POST

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=1Setting virtual input 0 to trigger state
		Ex: vi0=0(200)1Setting 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		Redirect to the pageafter the request is completely assigned. Thecan 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:1. setvi.cgi?vi0=0(10000)1(15000)0(20000)1No multiple duration.2. setvi.cgi?vi3=0VI index is out of range.3. setvi.cgi?vi=1No VI index is specified.

503 The resource is unavailable, ex. Virtual input is waiting for next state.

Examples:

1. setvi.cgi?vi0=0(15000)1

2. setvi.cgi?vi0=1

Request 2 will not be accepted during the execution time(15 seconds).

8.17 Open Timeshift Stream (timeshift\_enable=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=<value>&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=<value>&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		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	Reference time for maxsft and minsft.(This provides more precise time control to eliminate the inaccuracy due to network latency.)

		request. Ex: Request the streaming from 12:20rtsp://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		0 How many seconds of cached stream client can accept at least.(Used by forcechk)

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.

8.18 Open Anystream

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 (MPEG4), the user needs to input the URL below into an RTSP compatible player.

rtsp://<servername>/liveany.sdp?codectype=mpeg4[&resolution=<value>&mpeg4_intraperiod=<value>&mpeg4_ratecontrolmode=<value>&mpeg4_quant=<value>&mpeg4_qvalue=<value>&mpeg4_bit rate=<value>&mpeg4_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>] 

PARAMETER	VALUE	DEFAULT	DESCRIPTION
codectype	mjpeg, mpeg4, h264product dependent>	N/A	Set codec type for Anystream.
solution	capability_videoin_resolution		Video resolution in pixels.
mjpeg_quant 0, 1~5	99, 1~5	3 Quality of JPEG video.0,99 is the customized manual input setting.1 = worst quality, 5 = best quality.
mjpeg_qvalue	10~2002~97	50Manual video quality level input.(This must be present ifmjpeg_quant is equal to 0, 99)
mjpeg_maxframe 1~25	26~30 (only for NTSC or 60Hz CMOS)	15 Set maximum frame rate in fps(for JPEG).
mpeg4_intraperiod 250,	500, 1000, 2000, 3000, 4000	1000 Intra frame period in milliseconds.
mpeg4_ratecontrolmode	cbr, vbr vbr cbr: constant bitrate
mpeg4_quant 0, 1~5	99, 1~5	3 Quality of video when choosingvbr in“mpeg4_ratecontrolmode”.0,99 is the customized manual input setting.1 = worst quality, 5 = best quality.
mpeg4_qvalue	1~312~31	7Manual video quality level input.(This must be present ifmpeg4_quant is equal to 0, 99)
mpeg4_bitrate	1000~80000001000~4000000	512000Set bit rate in bps when choosingcbr in“mpeg4_ratecontrolmode”.
mpeg4_maxframe 1~25,	26~30 (only for NTSC or 60Hz CMOS)	1015Set maximum frame rate in fps(for MPEG-4).
h264_intraperiod 250, 50	0, 1000, 2000, 3000, 4000	1000 Intra frame period in milliseconds.
h264_ratecontrolmode cbr, vbr, smart vbr cbr: constant bitrate			vbr: fix qualitysmart: smart stream
h264_quant 0, 1~5	99, 1~5	3 Quality of	video when choosingvbr in “h264_ratecontrolmode”.0,99 is the customized manualinput setting.1 = worst quality, 5 = bestquality.
h264_qvalue	0~51	30	Manual video quality level input.(This must be present if h264_quant is equal to 0, 99)
h264_bitrate	1000~80000001000~4000000	512000	Set bit rate in bps when choosingcbr in “h264_ratecontrolmode”.
h264_maxframe 1~25,	26~30 (only for NTSC or 60Hz CMOS)	1015	Set maximum frame rate in fps(for H264).
h264_smartstream_mode	autotracking, manual, hybrid	autotracking	Set Smart stream mode
h264_smartstream_foreground_quant	0~5 3 Quality of foreground	quality	0 = worst quality, 5 = bestquality.
h264_smartstream_background_quant	0~5 1 Quality of foreground	quality	0 = worst quality, 5 = bestquality.
h264_smartstream_maxbitrate	1000~40000000 40000000	Maximum bitrate
h264_smartstream_win_i<0~2>_enable	0~1 0 Enable or disable the window.
h264_smartstream_win_i<0~2>_home	(150,110)	Left-top	corner coordinate of thewindow.
h264_smartstream_win_i<0~2>_size	(100x75)		Width and height of the window.

8.19 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 

8.20 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 to upload this one to camera.

8.21 Media on demand

Media on demand allows users to select and receive/watch/listen to metadata/video/audio contents on demand.

Note: This request requires Viewer access privileges.

Syntax:

rtsp://<servername>/mod.sdp?[&stime=<value>][&etime=<value>][&length=<value>][&loctime=<value>][&file=<value>][&tsmode=<value>] 

PARAMETER	VALUE DEFAULT DESCRIPTION
stime	MMDD_HHMMSS.MMM> N/A Start time.
etime	MMDD_HHMMSS.MMM> N/A End time.
length	N/A The length of media of interest.		The unit is second.
loctime	0 Specify if start/end time is local		time format.1 for local time, 0 for UTC+0
file	N/A The media file to be played.
tsmode		N/A	Timeshift mode, the unit is second.

Ex.

stime	etime	length	file	Description
V	V X	X		Play recordings between stime and etimertsp://10.10.1.2/mod.sdp?stime=20110312_040400.000&etime=2011_0312_040510.000
V	X	V	X	Play recordings for length seconds which start from stimertsp://10.10.1.2/mod.sdp?stime=20110312_040400.000&length=120
X	VV	X		Play recordings for length seconds which ends at etimertsp://10.10.1.2/mod.sdp?etime=20110312_040400.000&length=120
X	X	X	V	Play file filertsp://10.10.1.2/mod.sdp?filename=/mnt/link0/

3. General CGI URL Syntax and Parameters

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>]
[&<parameter>...]

http://<servername>/cgi-bin/operator/getparam.cgi?[<parameter>]
[&<parameter>...]

http://<servername>/cgi-bin/admin/getparam.cgi?[<parameter>]
[&<parameter>...] 

Where the should be [_<name)]. If you do not specify any parameters, all the parameters on the server will be returned. If you specify only , 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>] 

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

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>...][&return=<return page]

http://<servername>/cgi-bin/viewer/setparam.cgi? <parameter>=<value>
[&<parameter>=<value>...][&return=<return page]

http://<servername>/cgi-bin/operator/setparam.cgi? <parameter>=<value>
[&<parameter>=<value>...][&return=<return page]

http://<servername>/cgi-bin/admin/setparam.cgi? <parameter>=<value>
[&<parameter>=<value>...][&return=<return page] 

PARAMETER VALUE DESCRIPTION

	value to assigned	Assignto the parameter.
return		Redirect to the pageafter the parameter is assigned. Thecan 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). 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
<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

This chapter defines all the parameters which can be configured or retrieved from VIVOTEK network camera or video server. The general format of description is listed in the table below

Valid values:

VALID VALUES DESCRIPTION
string[]	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[] The same	as string but displays ‘*’ instead.
integer Any number between (-231-1) and (231-1).
positive integer Any number between 0 and (232-1).
~Any number	between ‘m’ and ‘n’.
domain name[] A string limited to a domain name shorter than ‘n’ characters (eg. www.ibm.com).
email address []	A string limited to an email address shorter than ‘n’ characters (eg. [e-mail]).
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].
	Enumeration. Only given values are valid.
blank	A blank string.
everything inside <>	A description
integer primary key	SQLite data type. A 32-bit signed integer. The value is assigned a unique integer by the server.
text	SQLite data type. The value is a text string, stored using the database encoding (UTF-8, UTF-16BE or UTF-16-LE).
coordinate	x, y coordinate (eg. 0,0)
window size	window width and height (eg. 800x600)

NOTE: The camera should not be restarted when parameters are changed.

7.1 system

Group: system

NAME VALUE DEFAULT	SECURITY		(get/set)	DESCRIPTION
hostname string[64]	Mega-Pixel Network Camera	1/6 Host name	of server.
ledoff0 6/6 Turn on (0) or turn off(1) all				led indicators.
date, keep, auto		6/6 Current date of system. Set to ‘keep’ to keep date unchanged. Set to ‘auto’ to use NTP to synchronize date.
time, keep, auto		6/6 Current time of the system. Set to ‘keep’ to keep time unchanged. Set to ‘auto’ to use NTP to synchronize time.
datetime		6/6 Another current time format of the system.
ntp, ,,	6/6 NTP server.
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-200: GMT-05:00 EasternTime, New York, Toronto-201: GMT-05:00 Bogota,Lima, Quito, Indiana-180: GMT-04:30 Caracas-160: GMT-04:00 AtlanticTime, Canada, La Paz,Santiago-140: GMT-03:30Newfoundland-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, London40: GMT 01:00 Amsterdam,Berlin, Rome, Stockholm,Vienna, Madrid, Paris41: GMT 01:00 Warsaw,Budapest, Bern80: GMT 02:00 Athens,Helsinki, Istanbul, Riga81: GMT 02:00 Cairo82: GMT 02:00 Lebanon,Minsk83: GMT 02:00 Israel120: GMT 03:00 Baghdad,Kuwait, Riyadh, Moscow, St.Petersburg, Nairobi121: GMT 03:00 Iraq140: GMT 03:30 Tehran160: GMT 04:00 Abu Dhabi,Muscat, Baku,Tbilisi, Yerevan180: GMT 04:30 Kabul200: GMT 05:00Ekaterinburg, Islamabad,Karachi, Tashkent220: GMT 05:30 Calcutta,Chennai, Mumbai, New Delhi230: GMT 05:45 Kathmandu240: GMT 06:00 Almaty,Novosibirsk, Astana, Dhaka,Sri Jayawardenepura260: GMT 06:30 Rangoon280: GMT 07:00 Bangkok,Hanoi, Jakarta, Krasnoyarsk320: GMT 08:00 Beijing,Chongging, Hong Kong,Kuala Lumpur, Singapore,Taipei360: GMT 09:00 Osaka,Sapporo, Tokyo, Seoul,Yakutsk380: GMT 09:30 Adelaide,Darwin400: GMT 10:00 Brisbane,Canberra, Melbourne,Sydney, Guam, Vladivostok440: GMT 11:00 Magadan,Solomon Is., New Caledonia480: GMT 12:00 Auckland,Wellington, Fiji, Kamchatka,Marshall Is.520: GMT 13:00 Nuku'Alofa
daylight_enable	0 6/6 Enable automatic daylight			saving time in time zone.
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 0	6/6 List time zone index which		support daylight saving time.
updateinterval	0,3600,86400,604800,2592000	0 6/6 0 to D	timeadjustment, otherwise, itindicates the seconds betweenNTP automatic updateintervals.
restore	0,<positiveinteger>	N/A 7/6 Restore the system	parameters to default valuesafterseconds.
reset	0,<positiveinteger>	N/A 7/6 Restart the server after<value> seconds ifis non-negative.	seconds ifis non-negative.
restoreexceptnet	0,<positiveinteger>	N/A 7/6 Restore the system	parameters to default valuesexcept (ipaddress, subnet,router, dns1, dns2, pppoe).This command can cooperatewith other"restoreexceptXYZ"commands. Whencooperating with others, thesystem parameters will berestored to the default valueexcept for a union of thecombined results.
restoreexceptdst	0,<positiveinteger>	N/A 7/6 Restore the system	parameters to default valuesexcept all daylight savingtime settings.This command can cooperatewith other"restoreexceptXYZ"commands. Whencooperating with others, thesystem parameters will berestored to default valuesexcept for a union of

				combined results.
restoreexceptlang	0,	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.
	integer>
restoreexceptvadp	0,	N/A 99/6 Restore the system		parameters to default values except the vadp parameters and VADP modules that stored in the system. This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.
	integer>

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]	FD8338-H 0/7		Internal model	name of the server
extendedmodelname string[40]serialnumber	FD8338-H	0/7 ODM sp	cific model name0/7 12 characters	of server (eg. DCS-5610). If it is not an ODM model, this field will be equal to “modelname”MAC address (without hyphens).
firmwareversion string[40]product dependent>0/7 Firmware version, including model, company, and version number in the format:language_count90/7Number of webpage languages available on the server.	string[40]	product dependent>	0/7 Firmware version, including model, company, and version number in the format:	username, including model, company, and version number in the format:
language_i<0~(count-1)>	string[16]	English Deutsch Español Français Italiano 日本語 Português 简体中文繁體中文	0/7 Available language lists.	Available online language lists.
customlanguage_maxcount		1 0/6 Maximum number of custom languages supported on the server.
customlanguage_count0 0/6 Number of custom languageswhich have been uploaded to the server.	0 0/6	Number of custom languages		which have been uploaded to the server.
customlanguage_i<0~(max count-1)>	string N/A	0/6 Custom language name.

7.2 status

Group: status

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
di_i<0~(ndi-1)>0 1/7 0 => Inactive, normal				1 => Active, triggered
do_i<0~(ndo-1)>0 1/7 0 => Inactive, normal				1 => Active, triggered
daynight day, night 0 7/7 Current status of day, night.
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			1/7	Get network information from mii-tool.
vi_i<0~(nvi-1)>0 1/7 Virtual input				0 => Inactive1 => Active

7.3 digital input behavior define

Group: di_i<0\~(ndi-1)>

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)>

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
Normalstate	open, grounded	open	1/1 Indicate	open circuit or closed circuit (inactivestatus)

7.5 PIR detection behavior define

Group: pir

NAME VALUE DEFAULT	T SECURITY		(get/set)	DESCRIPTION
enable		0	1/1	Enable/disable PIR detection

7.6 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 ePTZ
user_i0_name	string[64]	root	6/7
user_i<1~20>_name	string[64]	6/7	User name
user_i0_pass	password[64]	6/6	Root password
user_i<1~20>_pass	password[64]	7/6	User password
user_i0_privilege	admin	admin	6/7
user_i<1~20>_privilege	view, operator, admin	6/6	User privilege

7.7 network

Group: network

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
preprocess		NULL 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'srecommendedto set this parameter when change a service port to the port occupied by another service currently. Otherwise, the service may fail.Stopped service will auto-start after changing port settings.Ex:Change HTTP port from 80 to 5556, and change RTP port for video from 5556 to 20480.Then, set preprocess=9 to stop both service first.”/cgi-bin/admin/setparam.cgi?network_preprocess=9&network_http_port=5556 & network_rtp_videoport=20480”
type	lan,pppoc	lan 6/6 Network connection type.
resetip <boolean> 1 6/6		1 => Get ipaddress, subnet, router, dns1, dns2from DHCP server at next reboot.0 => Use preset ipaddress, subnet, rounter, dns1, and dns2.
ipaddress			6/6 IP address of server.
subnet			Subnet mask.
router <ip	6/6 Default gateway.
	address>
dns1		6/6	Primary DNS server.
dns2		6/6	Secondary DNS server.
wins1		6/6	Primary WINS server.
wins2		6/6	Secondary WINS server.

7.7.1 802.1x

Subgroup of network: ieee8021x

NAME VALUE DEF	FAULT SECURITY		(get/set)	DESCRIPTION
enable0 6/6 Enable/disable IEEE 802.1x
eapmethod	eap-peap,cap-tls	eap-peap 6/6 Selected EAP method
identity_peap	String[64]		6/6	PEAP identity
identity_tls	String[64]		6/6	TLS identity
password	String[200]		6/6	Password for TLS
privatekeypassword	String[200]		6/6	Password for PEAP
ca_exist	0 6/6 CA installed flag
ca_time	0 6/7 CA installed time. Represented in EPOCH
ca_size0 6/7 CA file size (in bytes)
certificate_exist	0 6/7 Certificate installed time.			Certificate installed flag (for TLS)
certificate_time	0 6/7 Certificate installed time.			Represented in EPOCH
certificate_size	0 6/7 Certificate file size (in bytes)
privatekey_exist	0 6/6 Private key installed flag (for TLS)
privatekey_time0 6/7 Private key installed time. Represented in EPOCH				Represented in EPOCH
privatekey_size	0 6/7 Private key file size (in bytes)

7.7.2 QOS

Subgroup of network: qos_cos

NAME VALUE	DEFAULT SECURITY		(get/sct)	DESCRIPTION
enable0 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
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

NAME VALUE	DEFAULT SECURITY		(get/set)	DESCRIPTION
enable	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
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.7.3 IPV6

Subgroup of network: ipv6

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
enable		0	6/6	Enable IPv6.
addonipaddress			6/6	IPv6 IP address.
addonprefixlen	0~128	64 6/6 IPv6 prefix length.
addonrouter			6/6	IPv6 router address.
addondns			6/6	IPv6 DNS address.
allowoptional		0	6/6	Allow manually setup of IP address setting.

7.7.4 FTP

Subgroup of network: ftp

NAME VALUE DEF	AULT SECURITY		(get/set)	DESCRIPTION
port 21, 1025~65535	21 6/6 Local ftp server port.

7.7.5 HTTP

Subgroup of network: http

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
port	80, 1025 ~ 65535	80 1/6 HTTP port.
alternateport 1025~65	535 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.
s1_accessname	string[32]	video2.mjpg	1/6	HTTP server push access name for stream 2.
s2_accessname	string[32]	video3.mjpg	1/6	Http server push access name for stream 3
anonymousviewing		0	1/6	Enable anonymous streaming viewing.

7.7.6 HTTPS port

Subgroup of network: https

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
port	443, 1025 ~ 65535	443	1/6	HTTPS port.

7.7.7 RTSP

Subgroup of network: rtsp

NAME VALUE DEFAULT SECURITY		(get/set)	DESCRIPTION
port 554, 1025 ~65535	554 1/6 RTSP port.
anonymousviewing	0	1/6	Enable anonymous streaming viewing.
authmode	disable, basic, digest	disable 1/6 RTSP authentication mode.
s0_accessname string[3]2] live.sdp	1/6 RTSP access name for stream1.
s1_accessname string[3]2] live2.sdp	1/6 RTSP access name for stream2.
s2_accessname string[3]2] live3.sdp	1/6 RTSP access name for stream3

7.7.7.1 RTSP multicast

Subgroup of network_rtsp_s<0\~(n-1)>: multicast, n is stream count

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
alwaysmulticast		0	4/4	Enable always multicast.
ipaddress		For n=0,239.128.1.99For n=1,239.128.1.100,and so on.	4/4	Multicast IP address.
videoport	1025 ~ 65535	5560+n*2	4/4	Multicast video port.
audioport	1025 ~ 65535	5562+n*2	4/4	Multicast audio port.
metadaport	1026~65534	6560+n*2	4/4	Multicast metadata port.
ttl	1 ~ 255	15	4/4	Multicast time to live value.

7.7.8 SIP port

Subgroup of network: sip

NAME VALUE DEFAULT SECURIT		Y(get/set)	DESCRIPTION
port 1025 ~ 65535 5060 1/6 SIP port.

7.7.9 RTP port

Subgroup of network: rtp

NAME VALUE DEFAULT SECURIT		Y(get/set)	DESCRIPTION
videoport 1025 ~ 65535 5556 6/6 Video channel port for RTP.
audiport 1025 ~ 65535 5558 6/6 Audio channel port for RTP.
metadataport 1025 ~ 65535 6556 6/6 Metadata channel port for RTP.

7.7.10 PPPoE

Subgroup of network: pppoe

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
user	string[128]		6/6	PPPoE account user name.
pass	password[64]		6/6	PPPoE account password.

7.8 IP Filter

7.8.1 ipfilter for ONVIF

Group: ipfilter

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
enable0	6/6 Enable access list filtering.
admin_enable0 6/6 Enable administrator IP				address.
admin_ip String[43]	6/6 Administrator IP address.
maxconnection	0~10	10	6/6	Maximum number of concurrent streaming connection(s).
type	0, 1	1	6/6	Ipfilter policy :0 => allow1 => deny
ipv4list_i<0~9>	String[31]		6/6	IPv4 address list.
ipv6list_i<0~9>	String[43]		6/6	IPv6 address list.

7.9 video input

Group: videoin

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
cmosfreq 50, 60	60	4/4 CMOS frequency.
whitebalance	auto, manual, rbgain	auto	4/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
color	0, 1	1	4/4 0 =>monochrome1 => color
flip		0	4/4	Flip the image.
mirror		0	4/4	Mirror the image.
text string[16] <blank> 1/4 Enclose caption.
imprinttimestamp <boolean> 0 4/4 Overlay time stamp on video.

7. 9.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
whitebalance	auto, manual, rbgain	auto 4/4	“auto”	indicates auto white balance. “manual” indicates keep current value. “rbgain” indicates using rgain and gbain.
rgain	0~100	16	4/4	Manual set rgain value of gain control setting.
bgain	0~100	21	4/4	Manual set bgain value of gain control setting.
exposurelevel	0~8	4	4/4	Exposure level
cmosfreq	50, 60	60	4/4	CMOS frequency.
mode	0 ~ "capability_ videoin_c<n_n mode"-1	0	4/99	Indicate the video mode on use.
maxgain	0~5	5	4/4	Manual set maximum gain value.
mingain	0~100	0	4/4	Manual set minimum gain value.
color	0, 1	1	4/4	0 =>monochrome 1 => color
flip		0	4/4	Flip the image.
mirror		0	4/4	Mirror the image.
ptzstatus		2	1/7	A 32-bit integer, each bit can be set separately as follows: Bit 0 => Support camera control function; 0(not support), 1(support) Bit 1 =>Built-in or externalcamera; 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 4/4 Overlay time stamp on				video.
textonvideo_position top, bottom top 4/4 Position of timestamp and				video title on image
textonvideo_size	15,25,30	15	4/4	Timestamp and font-size
minexposure	5~32000	32000	4/4	Minimum exposure time.
maxexposure	5~32000	30	4/4	Maximum exposure time.
s<0~(m-1)>_codectype	mjpeg, h264	h264	1/4	Video codec type.svc is only supported with stream 0.
s<0~(m-1)>_resolution	Reference capability_vide oin_resolution	1280x800	1/4 Video resolution in pixels.
s<0~(m-1)>_h264_intraperiod	250, 500,1000, 2000,3000, 4000	1000	4/4	Intra frame period in milliseconds.
s<0~(m-1)>_h264_priority policy	framerate, imagequality	imagequal ity	4/4 The policy	cy to apply when the target bit rate is not sufficient to satisfy current encoded conditions. “framerate” indicates frame rate first. “imagequality” indicates image quality first.
s<0~(m-1)>_h264_ratecontrol mode	cbr, vbr, smart cbr	4/4 cbr, constant bitrate		vbr, fix quality
s<0~(m-1)>_h264_quant 1~5,99	9, 100 3 4/4 Quality of video when			choosing vbr in “ratecontrolmode”. 1 = worst quality, 5 = best quality. 100: Use the quality level in "qpercent" 99: Use the quality level in "qvalue"
s<0~(m-1)>_h264_qpercent	1~100 50	4/4 Set quality by percentage.		1: Worst quality 100: Best quality (s<0~(m-1)>_h264_quant = 100)
s<0~(m-1)>_h264_qvalue	0~51	29	4/4 Manual	video quality level input. (s<0~(m-1)>_h264_quant = 99)
s<0~(m-1)>_h264_bitrate	1000~4000000 0	3000000 4/4	Set bit rate in bps when choosing cbr in “ratecontrolmode”.
s<0~(m-1)>_h264_maxframe	1~30	30	1/4	Set maximum frame rate in fps (for h264).
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_smartstream_mode	autotracking, manual,hybrid	autotracking	4/4	Indicate the smart stream mode on use.
s0_h264_smartstream_win_i<0~(m-1)enable		Enable smart stream.
s<0~(m-1)_h264_smartstream_win_i<0~(m-1)_home	"0~320","0~240	150, 110 4/4		Left-top corner coordinate of the smart stream window.
s<0~(m-1)_h264_smartstream_win_i<0~(m-1)_size	"0~320","0~240	100x75	4/4	Width and height of the smart steam window.
s<0~(m-1)>_h264_smartstream_background_quant	0~5	1	4/4	Quality of background quality0 = worst quality, 5 = best quality.
s<0~(m-1)>_h265_smartstream_foreground_quant	0~5	3	4/4	Quality of foreground quality0 = worst quality, 5 = best quality.
s<0~(m-1)_h264_smartstream_maxbitrate	1000~40000000	40000000	4/4	Maximum bitrates of smart steam.
s<0~(m-1)>_mjpeg_priority policy	framerate, imagequality	framerate 4/4	The policy to apply when the target bit rate is not sufficient to satisfy current encoded conditions.“framerate” indicates frame rate first.“imagequality” indicates image quality first.
s<0~(m-1)>_mjpeg_rate controlmode	cbr, vbr vbr 4/4	cbr, constant	bitrate	vbr, fix quality
s<0~(m-1)>_mjpeg_quant 1~5	99, 100 3 4/4	Quality of JPEG video.
				1 = worst quality, 5 = best quality.100: Use the quality level in "qpercent"99: Use the quality level in "qvalue"
s<0~(m-1)>_mjpeg_maxframe	1~30 30 1/4 Set maximum frame rate in			fps (for JPEG).
s<0~(m-1)>_mjpeg_qvalue	10~200	49 4/4 Manual video quality		level input.(s<0~(m-1)>_mjpeg_quant = 0)
s<0~(m-1)>_mjpeg_qpercent	1~100 50 4/4 Set quality by percentage.			1: Worst quality100: Best quality(s<0~(m-1)>_mjpeg_quant = 100)
s<0~(m-1)>_mjpeg_bitrate 1000~40000000	6000000 4/4 Set bit rate in			bps when choosing cbr in "ratecontrolmode".
s<0~(m-1)>_forcei N/A N/A 7/6 Force I frame.
piris_mode manual	manual 1/4			PIris mode manual = 0 indoor=1 outdoor=2
piris_sensitivity	1~10 2	4/4 Sensitivity of piris
piris_response	1~10	2	4/4	Response of piris
piris_position	1~100	12	1/4	Position of piris

7.9.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_profile_i<0\~(m-1)>

NAME VALUE DEF	AULT SECURITY		(get/set)	DESCRIPTION
enable0 4/4 Enable/disable this profile setting
policy	day,night,schedule	night 4/4 The mode which the profile is applied to.
begintime hh:mm 18:00 4/4 Begin time of schedule mode.
endtime	hh:mm 06:00 4/4	End time of schedule mode.
exposurelevel	0~8	4 4/4 Exposure level
minexposure	5~32000	32000	4/4	Minimum exposure time.
maxexposure	5~32000	30	4/4	Maximum exposure time.
maxgain	0~5	5	4/4	Manual set maximum gain value.
mingain	0~100	0	4/4	Manual set minimum gain value.
whitebalance auto,	manual,rbgain	auto	4/4	“auto” indicates auto white balance.“manual” indicates keep current value.“rbgain” indicates using rgain and gbain.
rgain	0~100 16 4/4	Manual set rgain value of gain control setting.
bgain	0~100	21	4/4	Manual set bgain value of gain control setting.

7.10 IR cut control

Group: ircutcontrol

NAME VALUE DEFAULT	T SECURITY		(get/set)	DESCRIPTION
mode	auto, day, night, di, schedule	auto 6/6 Set IR cut control mode
sir0 6/6 Enable/disable Smart IR
daymodebegintime 00:00~23:59 07:00 6/6 Day mode begin time
daymodecendtime	00:00~23:59	18:00 6/6 Day mod end time
disableirled		0	6/6	Enable/disable built-in IR led
bwmode		1	6/6	Switch to B/W in night mode if enabled
sensitivity	low, normal, high	normal	6/6 Sensitivity	of light sensor

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	0	4/4	Adjust brightness of image according to mode settings.
saturation	-5 ~ 5, 100	100	4/4	Adjust saturation of image according to mode settings.
saturationpercent	0~100	50	4/4	Adjust saturation value of percentage when saturation=100
contrast	-5 ~ 5	0	4/4	Adjust contrast of image according to mode settings.
sharpness -3~3, 100 100 4/4	Adjust sharpness of			image according to mode settings.
sharpnesspercent 0~100 50 4/4	Adjust sharpness of			image by percentage. Softer 0 <-> 100 Sharper
gammacurve 0~100 0 4/4	Gamma curve.
dnr_mode 0~1 1 4/4	3D noise reduction.			0: off 1: on
dnr_strength	1~100	50	4/4	3D noise reduction strength.
lowlightmode		1 4/4 Enable	disable low	light mode.
profile_i0_enable		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_brightness	-5~5	0 4/4 Adjust	brightness of	image according to mode settings.
profile_i0_contrast -5 ~ 5	0 4/4	Adjust contrast of		image according to mode settings.
profile_i0_saturation	-5~5,100	100	4/4	Adjust saturation of image according to mode settings. 100 for saturation percentage mode.
profile_i0_saturationpercent	0~100	50	4/4	when profile_i0_saturation=100, adjust saturation value of percentageaccording to mode settings.
profile_i0_sharpness -3~3,1	00 100 4/4 Adjust	sharpness of		image according to mode settings.
profile_i0_sharpnesspercent	0~100 50 4/4 Adjust	just sharpness		value of percentage when sharpness=100
profile_i0_gammacurve 0~1	100 0 4/4 Gamma curve
profile_i0_dnr_mode 0~1 1	4/4 3D noise reduction.			0: off1: on
profile_i0_dnr_strength	1~100	50	4/4	3D noise reduction strength.
profile_i0_lowlightmode		1	4/4	Enable/disable low light mode.

7.12 Audio input per channel

Group: audioin_c<0\~(n-1)> for n channel products

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
mute	0, 1	0	1/4	Enable audio mute.
gain	0~100	65	4/4	Gain of input.
s<0~(m-1>_codectype	g711, g726	g711	4/4	Set audio codec type for input.
s<0~(m-1>_g711_mode	pcmu, pcma	pcmu	4/4	Set G.711 mode.
s<0~(m-1>_g726_bitrate	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		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_alarm_level	1~100 50	4/4 Audio detection alarm level

7.13 Time Shift settings

Group: timeshift, c for n channel products, m is stream number

NAME VALUE DEFAULT		T	SECURITY(get/set)	DESCRIPTION
enable		0	4/4	Enable time shift streaming.
c<0~(n-1)>_s<0~(m-1)>_allow			4/4	Enable time shift streaming for specific stream.

7.14 Motion detection settings

Group: motion_c<0\~(n-1)> for n channel product

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
enable		0	4/4	Enable motion detection.
win_i<0~2>_enable		0	4/4	Enable motion window 1~3.
win_i<0~2>_name	string[14]		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 ~ 2	40 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		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		0	4/4	Enable motion window.
i<0~(m-1)>_win_i<0~2>_name	string[14]		4/4	Name of motion window.
i<0~(m-1)>_win_i<0~2>_left	0 ~ 320	0	4/4	Left coordinate of window position.
i<0~(m-1)>_win_i<0~2>_top	0 ~ 240	0	4/4	Top coordinate of window position.
i<0~(m-1)>_win_i<0~2>_width	0 ~ 320	0	4/4	Width of motion detection window.
i<0~(m-1)>_win_i<0~2>_height	0 ~ 240	0	4/4	Height of motion detection window.
i<0~(m-1)>_win_i<0~2>_objsize	0 ~ 100	0	4/4	Percent of motion detection window.
i<0~(m-1)>_win_i<0~2>_sensitivity	0 ~ 100	0	4/4	Sensitivity of motion detection window.

7.15 Tampering detection settings

Group: tampering_c<0\~(n-1)> for n channel product

NAME VALUE	DEFAULT	SECURITY	(get/set)	DESCRIPTION
enable0 4/4Enable or disable tamper detection.
duration 10~600 10 4/4If tampering value exceeds the ‘threshold’ formore than ‘duration’ second(s), then tamperdetection is triggered.

7.16 DDNS

Group: ddns

NAME VALUE	DEFAULT SECURITY		(get/set)	DESCRIPTION
enable		0	6/6	Enable or disable the dynamic DNS.
provider	Safe100, DyndnsDynamic, DyndnsCustom, CustomSafe100, PeanutHull	DyndnsDynamic	6/6	Safe100 => safe100.net DyndnsDynamic => dyndns.org (dynamic) DyndnsCustom => dyndns.org (custom) CustomSafe100 => Custom server using safe100 method PeanutHull => PeanutHull
颁布>_hostname	string[128]		6/6	Your DDNS hostname.
usernameemail	string[64]		6/6	Your user name or email to login to the DDNS service provider
passwordkey	string[64]		6/6	Your password or key to login to the DDNS service provider.
servername	string[128]		6/6	The server name for safe100. (This field only exists if the provider is customsafe100)

7.16.1 Express link

Group:expresslink

NAME VALUE DE	FAULT SECURITY		(get/sct)	DESCRIPTION
enable0	6/6 Enable or disable express link.
state	onlycheck, onlyoffline, checkonline, badnetwork	badnetwork 6/6 “onlycheck”	“onlycheck”	You have to input the host name of your camera and press "Register" button to register it.“onlyoffline”: Express link is active, you can now connect to this camera at expresslink_url.“checkonline”: Express link is not active.“badnetwork”: Express Link is not supported under this network environment.
url string[64]	6/6 The URL to connect to this camera			by express link.

7.17 UPnP presentation

Group: upnppresentation

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
enable		1	6/6	Enable or disable the UPnP presentation service.

7.18 UPnP port forwarding

Group: upnpportforwarding

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
enable0	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 portforwarding

7.19 System log

Group: syslog

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
enableremotelog0 6/6 Enable remote log.
serverip6/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_EMERG1: LOG_ALERT2: LOG_CRIT3: LOG_ERR4: LOG_WARNING5: LOG_NOTICE6: LOG_INFO7: LOG_DEBUG
setparamlevel	0~2	0	6/6	Show log of parameter setting.0: disable1: Show log of parameter setting set from external.2. Show log of parameter setting set from external and internal.

7.20 SNMP

Group: snmp

NAME VALUE DE	FAULT SECURITY		(get/sct)	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
authpwrw	string[8~128]		6/6	Read/write authentication password
authpwro	string[8~128]		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]		6/6	Read/write passwd
encryptpwro	string[8~128]		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 Ready only	community

7.21 Layout configuration

Group: layout

NAME VALUE DEFAULT SECURIT			Y(get/set)	DESCRIPTION
logo_default1 1/6 0 => Custom logo				1 => Default logo
logo_link	string[128]	vivotek.com	1/6 Hypotink of the logo
logo_powerbyvvtk_hidden0 1/6 0 => display the power by				vivotek logo1 => hide the power by vivotek logo
theme_option 1~4 1 1/6 1~3: One of the default themes.				4: Custom definition.
theme_color_font string[7]	#ffffff	1/6 Font color
theme_color_configfont	string[7]	#ffffff	1/6	Font color of configuration area.
theme_color_titlefont	string[7]	#098bd6	1/6	Font color of video title.
theme_color_controlbackground	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
custombutton_manualtrigger_show	1	1/6 Show or	hide manual trigger	(VI) button in homepage0 -> Hidden1 -> Visible

7.22 Privacy mask

Group: privacymask_c<0\~(n-1)> for n channel product

NAME VALUE DEF	FAULT SECURITY		(get/set)	DESCRIPTION
enable0 4/4 Enable privacy mask.
win_i<0~4>_enable		4/4 Enable privacy mask		window.
win_i<0~4>_name	string[16]		4/4	Name of the privacy mask window.
win_i<0~4>_left	0 ~ 320	0 4/4 Left coordinate of window		position.
win_i<0~4>_top	0 ~ 240	0 4/4 Top coordinate of window		position.
win_i<0~4>_width	0 ~ 320	0 4/4 Width of privacy mask		window.
win_i<0~4>_height	0 ~ 240	0 4/4 Height of privacy mask		window.

7.23 Capability

Group: capability

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
api_httpversion		0300a	0/99	The HTTP API version.
bootuptime		70	0/99	Server bootup time.
nir	0,	1	0/99	Number of IR interfaces. (Recommend to use ir for built-in IR and extir for external IR)
npir	0,	0	0/99	Number of PIRs.
ndi	0,	1	0/99	Number of digital inputs.
nvi	0,	3	0/99	Number of virtual inputs (manual trigger)
	integer>
ndo	0,	1	0/99	Number of digital outputs.
	integer>
naudioin	0,	1	0/99	Number of audio inputs.
	integer>
naudioout	0,	1	0/99	Number of audio outputs.
	integer>
nvideoin		1	0/99	Number of video inputs.
	integer>
nvideoout	0,	0	0/99	Number of video out interface.
	integer>
nvideoinprofile		1	0/99	Number of video input profiles.
	integer>
nmediastream		3	0/99	Number of media stream per channels.
	integer>
naudiosetting		1	0/99	Number of audio settings per channel.
	integer>
nuart	0,	0	0/99	Number of UART interfaces.
	integer>
nmotion 0,	integer>	3	0/99	Number of motion window.
	integer>
nmotionprofile 0,	integer>	1	0/99	Number of motion profiles.
	integer>
ptzenabled 0,	integer>	0	0/99	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 video source;0(external), 1(built-in)Bit 2 => Support pan
	integer>
				operation, 0(not support),1(support)Bit 3 => Support tilt operation; 0(not support),1(support)Bit 4 => Support zoom operation;0(not support), 1(support)Bit 5 => Support focus operation;0(not support), 1(support)Bit 6 => Support iris operation;0(not support), 1(support)Bit 7 => External or built-in PT; 0(built-in),1(external)Bit 8 => Invalidate bit 1 ~ 7;0(bit 1 ~ 7 are valid),1(bit 1 ~ 7 are invalid)Bit 9 => Reserved bit;Invalidate lens_pan,Lens_tilt, lens_zoon,lens_focus, len_iris.0(fields are valid),1(fields are invalid)Examples:PT8133: 0b1111SD8362: 0b111111VS8102: 0b10111101
windowless	boolean>	1		0/99
eptz 0,	integer>		3	0/99
				Bit 1 => stream 2 supports ePTZ or not.The rest may be deduced by analogy
remotefocus	0		0/99	Indicate whether to supportremote focus function.
npreset 0,	integer>	20	0/99	Number of preset locations.
protocol_https <boolean > 1			0/99	Indicate whether to support HTTP over SSL.
protocol_rtsp <boolean > 1			0/99	Indicate whether to support RTSP.
protocol_sip	0		0/99	Indicate whether to support SIP.
protocol_maxconnection		10	0/99	The maximum allowed simultaneous connections.
protocol_maxgenconnection		10	0/99	The maximum general streaming connections .
protocol_maxmegaconnection		10	0/99	The maximum megapixel streaming connections.
protocol_rtp_multicast_ scalable		1	0/99	Indicate whether to support scalable multicast.
protocol_rtp_multicast_ backchannel		1	0/99	Indicate whether to support backchannel multicast.
protocol_rtp_tcp		1	0/99	Indicate whether to support RTP over TCP.
protocol_rtp_http		1	0/99	Indicate whether to support RTP over HTTP.
protocol_spush_mjpeg		1	0/99	Indicate whether to support server push MJPEG.
protocol_snmp		1	0/99	Indicate whether to support SNMP.
protocol_ipv6			0/99	Indicate whether to support IPv6.
protocol_pppoe		1	0/99	Indicate whether to support PPPoE.
protocol_ieee8021x		1	0/99	Indicate whether to support IEEE802.1x.
protocol_qos_cos		1	0/99	Indicate whether to support CoS.
protocol_qos_dscp		1	0/99	Indicate whether to support QoS/DSCP.
protocol_ddns			0/99	Indicate whether to support DDNS.
videoin_type 0, 1, 2 2 0/99	0 => Interlaced CCD			1 => Progressive CCD2 => CMOS
videoin_codec		mjpeg,h264	0/99 Available codec of a device.The sequence is not limited.
videoin_streamcodec		6,6,6	0/99	This equals "capability_videoin_c0_streamcodec".
videoin_flexiblebitrate 0, 1	1 0/99 Support flexible bit rate			control or not.
videoin_c0_resolution		176x144,384x216,640x360,1280x720,1280x800	0/99 Available resolutions list.
videoin_c0_nresolution		5 0/99 How many resolution options (listed in "resolution") in current video mode.
videoin_c0_maxframerate		30,30,30,30,30	0/99 Available maximum frame list.
videoin_c0_mjpeg_maxframerate		30,30,30,30,30	0/99 Available maximum codec frame list.
	codec frame rate separated by commas>	30, 30
videoin_c0_h264_maxframe rate		30, 30, 30, 30, 30	0/99	Available maximum codec frame list.
timeshift		1	0/99	Indicate whether to support time shift caching stream.
audio_aec			0/99	Indicate whether to support acoustic echo cancellation.
audio_mic			0/99	Indicate whether to support built-in microphone input.
audio_extmic			0/99	Indicate whether to support external microphone input.
audio_intmic			0/99	Indicate whether to support internal microphone input.
audio_linein			0/99	Indicate whether to support external line input. (It will be replaced by audio_mic and audio_extmic.)
audio_lineout		1	0/99	Indicate whether to support line output.
audio_headphoneout		0	0/99	Indicate whether to support headphone output.
audioin_codec		26	0/99	Available codec list for audio input.
audioout_codec			0/99	Available codec list for SIP.
uart_httptunnel		0	0/99	Indicate whether to support HTTP tunnel forUART transfer.
camctrl_httptunnel		0	0/99	The attribute indicates whether sending camera control commands through HTTP tunnel is supported.0: Not supported1: Supported
camctrl_privilege		1	0/99	Indicate whether to support “Manage Privilege” of PTZ control in the Security page.1: support both /cgi-bin/camctrl/camctrl.cgi and /cgi-bin/viewer/camctrl.cgi0: support only /cgi-bin/viewer/camctrl.cgi
transmission_mode	Tx,Rx,Both	Tx	0/99	Indicate transmission mode of the machine: TX = server, Rx = receiver box, Both = DVR.
network_wire			0/99	Indicate whether to support Ethernet.
network_wireless		0	0/99	Indicate whether to support wireless.
derivative_brand		1	0/99	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)
evctrlchannel			0/99	Indicate whether to support HTTP tunnel for event/control transfer.
joystick			0/99	Indicate whether to support joystick control.
storage_dbenabled		1	0/99	Media files are indexed in database.
nanystream 0,	integer>	0	0/99	number of any media stream per channel
iva		0		0/99
ir		1		0/99
extir		1		0/99
whitelight		0		0/99
iris		0		0/99
tampering		1		0/99
temperature		0		0/99
version_onvifdaemon			1.8.06/99	Indicate ONVIF daemon version
version_onvifevent			1.3.0.7	0/99
media_totalspace			20000	0/99
media_snapshot_sizepersecond			500	0/99
media_snapshot_maxpreevent			7	0/99
media_snapshot_maxpostevent			7	0/99
media_videoclip_maxsize			4096	0/99
media_videoclip_maxlength		20	0/99	Maximum length (second) of a videoclip.
media_videoclip_maxpreevent		9	0/99	Maximum duration (second) after event occurred in a videoclip.
localstorage_manageable		1	0/99	Indicate whether manageable local storage is supported.
localstorage_seamless	1 0/99 Indicate whether			seamless recording is supported.
localstorage_modnum 0,		4 0/99 The maximum MOD connection numbers.
localstorage_modversion		1.0.1.19	0/99	Indicate MOD daemon version
localstorage_slconnum	0,	1	0/99	The maximum seamless connection number.
adaptiverecording		1	0/99	Indicate whether to support adaptive recording.
adaptivestreaming	1 0/99 Indicate whether to			support adaptive streaming.
remotecamctrl_master 0,	0	0/99 Indicate whether to support remote auxiliary camera (master side), this value means supporting max number of auxiliary camera.
remotecamctrl_slave		0	0/99 Indicate whether to support remote camera control (slave side).
fisheye		0	0/99 Indicate where fisheye camera
vadp		127	0/99	An 32-bit integer, each bit can be set separately as follows:Bit 0 => VADP interfaceBit 1 => Capture videoraw dataBit 2 => Support encodejpegBit 3 => AudioBit 4 => Event
smartstream_support	1 0/99 Indicate whether smart			stream is supported.
smartstream_nstream		3 0/99 Number of stream		thatsupport smart stream
smartstream_mode_autotracking		1 0/99 Indicate whether		autotracking smartstream is supported
smartstream_mode_manual	1 0/99	Indicate whether manual		smart stream issupported
smartstream_mode_hybrid	1 0/99	Indicate whether		hybrid(autotracking+manual) smart stream issupported
smartstream_nwindow_autotracking		8	0/99	Maximum number oftracking window ofautotracking
smartstream_nwindow_manual		3	0/99	Maximum number oftracking window ofmanual
smartstream_nwindow_hybrid_autotracking		5	0/99	Maximum number oftracking window ofautotracking in hybridmode
smartstream_nwindow_hybrid_manual		3	0/99	Maximum number oftracking window ofmanual in hybrid mode
smartstream_supportquality		excellent,detailed,good,standard,medium,low	0/99 Available	able quality ofsmart stream
smartstream_supportmaxbitrate		1Mbps,2Mbps,4Mbps,6Mbps,8Mbps,10Mbps,20Mbps,30Mbps,40Mbps	0/99 Available	able maxbitrate of smart stream
version_genetec		1.0.2.3	0/99	Indicate genetec version

Group: capability_image_c, where n = channel index from 0 \~ "capability_nvideoin"-1

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
wdrc 0,1 0			0/99	0: Non-support WDR Enhanced1: Support WDR Enhanced
wdr 0,1 1			0/99	0: Non-support WDR Pro1: Support WDR Pro
dnr 0,1 1			0/99	0: Non-support 3D noise reduction1: Support 3D noise reduction
iristype piris, dciris, - piris			0/99	Indicate iris type."piris": P-Iris"dciris": DC-Iris"-": No Iris control support* Note: For some cameras, this value may be varied depending on mounted lens.
focusassist 0,1 0			0/99	0: Non-support focus assistance1: Support focus assistance

7.24 WebAPI: Information for a channel

Group: capability_videoin_c, n = channel index from 0 to "capability_nvideoin"-1

PARAMETER VALUE	DEFAULT	SECURITY	(get/set)	DESCRIPTION
nmode		1 0/99 Indicate how many video modes supported by this channel.
maxsize1280x800 0/99 The maximum resolution of all modes in this channel, the unit is pixel.
mode00/99Indicate current video mode.
nresolution		5 0/99 How many resolution options (listed in "resolution") in current video mode.
resolution A list of		176x144,384x216,640x360,1280x720,1280x800	0/99 Resolution options in current video mode. These options are the possible options for "videoin_c<sresolution". The last one is the maximum resolution in current mode.
maxframerate A list of		30,30,30,30,30	0/99 Indicate how many frame rate image sensor outputs in current video mode.One to one mapping to the resolution in "resolution".
mjpeg_maxframerate	A list ofand "-"	30,30,30,30,30,30	0/99 Maximum fps that the device can encoded with MJPEG on resolutions in current video mode."-" means not support.
mjpeg_maxbitrate		40000000 0/99 Maximum bitrates of MJPEG.The unit is bps."-" means MJPEG does not support bit rate control.

h264_maxframerate A	list ofand "-"	30,30,30,30,30	0/99 Maximum fps that the device can encoded with H.264 on resolutions in current video mode."-" means not support.
h264_maxbitrate		40000000 0/99 Maximum bitrates of H.264. Integer>	The unit is bps.
streamcodec		6,6,6 0/99 Represent supported codec types of integer, split by comma. Each one stands for a stream, and the definition is as following:Bit 0: Support MPEG4.Bit 1: Support MJPEGBit 2: Support H.264	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 MJPEGBit 2: Support H.264

7.25 WebAPI: Information for a mode

Group: capability_videoin_c_mode, n = channel index from 0 to "capability_nvideoin"-1, m = mode index from 0 to "capability_videoin_c_nmode"-1

PARAMETER VALUE	DEFAULT	SECURITY	(get/set)	DESCRIPTION
effectivepixel		1280x800	0/99 The visible area of full scene in this video mode.The unit is pixel in source.
outputsize		1280x800	0/99 The output size of source, equal to the captured size by device, in this video mode. The unit is pixel.This value is used as a basic coordinate system for many features, like ePTZ, privacy mask, motion, etc.
binning 0, 1, 3		0	0/99	Indicate binning is used or not in this video mode.0: No binning1: 2x2 binning3: 3x3 binning

nresolution		5	0/99 How many resolution options in this video mode.
resolution A list of		176x144,384x216,640x360,1280x720,1280x800	0/99 Resolution options in this video mode.The last one is the maximum resolution in this video mode.
maxframerate A list of		30, 30, 30,30, 30	0/99 Indicate how many frame rate image sensor outputs in this video mode.
maxfps_mjpeg A list of		30, 30, 30,30, 30	0/99 Maximum fps which the device can encoded with MJPEG on resolutions in this video mode."-" means not support.
maxfps_h264 A list of		30, 30, 30,30, 30	0/99 Maximum fps which the device can encoded with H.264 on resolutions in this video mode."-" means not support.* One to one mapping to the resolution in "resolution".* The element number is defined as "nresolution" in this group.* This parameter records the frame rate when "videoin_c__cmosfreq"=60 or "videoin_c__modulation"=ntsc* Only available when 'h264' is listed in "capability_videoin_codec".
description		na	0/99 Description about this mode.

7.26 Customized event script

Group: event_customtaskfile_i<0\~2>

PARAMETER VALUE	Default SECURITY	(get/set)	DESCRIPTION
name string[40] NULL	6/6 Custom script identification of this		entry.
date string[4-20] NULL	6/6 Date of custom script.
time string[4-20] NULL	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] NULL	6/6 Identification of this entry.
enable	0, 1	0	6/6	Enable or disable this event.
priority	0, 1, 2	1	6/6	Indicate the priority of this event:“0” = low priority“1” = normal priority“2” = high priority
delay 1~999 10	6/6	Delay in seconds before detecting the next event.
trigger	boot,di,pir,motion,seq,recnotify,tampering,vi,volalarm,vadp	boot	6/6 Indicate the trigger condition:“boot” = System boot“di”= Digital input“pir”= PIR detection“motion” = Video motion detection“seq” = Periodic condition“recnotify” = Recording notification.“tampering” = Tamper detection.“vi”= Virtual input (Manual trigger)“volalarm” = Audio detection.“vadp” = VADP trigger
triggerstatus	String[40]	trigger	6/6	The status for event trigger
di 0,1 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.
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.
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.
inter 1~999 1 6/6 Interval of snapshots in minutes.				This field is used when trigger condition is “seq”.
weekday 0~127 127 6/6 Indicate which weekday is scheduled.				One bit represents one weekday.bit0 (LSB) = Saturdaybit1 = Fridaybit2 = Thursdaybit3 = Wednesdaybit4 = Tuesdaybit5 = Mondaybit6 = SundayFor 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_cf_enable 0.1 0 6/6 Enable media write on CF or other local storage media
action_cf_folder string[128] NULL 6/6 Path to store media.
action_cf_media	NULL, 0~4	NULL	6/6	Index of the attached media.
action_cf_datefolder		1	6/6	Enable this to create folders by date, time, and hour automatically.
action_cf_backup		0	6/6	Enable the capability of backing up recorded files to the SD card when network is lost.0: Disabled1: Enabled
action_server_i<0~4>_ enable	0, 1 0 6/6 Enable or disable this server action.
action_server_i<0~4>_ media	0~4, 101	NULL 6/6 Index of the attached media.
action_server_i<0~4>_ datefolder		0 6/6 Enable this to create folders by date, time, and hour automatically.
vadp		0	6/6	Indicate the source id of vadp event notification.Each bit corresponds to one vadp source, and the LSB indicates source id 0.For example, to detect event from any one of source id 0, 1 and 3, set vadp to 11.

7.28 Server setting for event action

Group: server_i<0\~4>

PARAMETER VALUE	DEFAULT SEC	URITY	(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 mode1 = 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.

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~2 0	6/6 Indicate the source of media			stream.0 means the first stream.1 means the second stream.2 means the third stream.
snapshot_prefix string[16]		6/6 Indicate the prefix of the filename.
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~2 0 6/6 Indicate the source of media			stream.0 means the first stream.1 means the second stream.2 means the third stream.
videoclip_prefix string[16]		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 ~ 4096	500	6/6	Maximum size of one video clip file in Kbytes.

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.
enable 0,1 0 6/6 Enable	or disable this recording.
priority 0,1,2	6/6 Indicate the priority of this			recording:“0” indicates low priority.“1” indicates normal priority.“2” indicates high priority.
source 0,1,2 0 6/6 Indicate the source of media stream.				0 means the first stream.1 means the second stream and so on.
limitsize	0,1	0 6/6 0: Entire free space mechanism		1: Limit recording size mechanism
cyclic	0,1	0 6/6 0: Disable cyclic recording		1: Enable cyclic recording
notify	0,1	1 6/6 0: Disable recording notification		1: Enable recording notification
notifyserver	0~31	0 6/6 Indicate which notification server is scheduled.One bit represents one application server (server_i0~i4).bit0 (LSB) = server_i0.bit1 = server_i1.bit2 = server_i2.bit3 = server_i3.bit4 = server_i4.For example, enable server_i0, server_i2, and server_i4 as notification servers; the notifyserver value is 21.
weekday 0~127 127 6/6	Indicate which	weekday is		scheduled.One bit represents one weekday.bit0 (LSB) = Saturdaybit1 = Fridaybit2 = Thursdaybit3 = Wednesdaybit4 = Tuesdaybit5 = Mondaybit6 = SundayFor example, to detect events onFriday and Sunday, set weekday as66.
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 schedulealways on)
prefix string[16] <blank>	6/6 Indicate the prefix of the filename.
cyclesize 100~ 100 6/6	The maximum size for cycle			recording in Kbytes when choosingto limit recording size.
reserveamount	0~15000000	100	6/6	The reserved amount in Mbyteswhen choosing cyclic recordingmechanism.
dest	cf,0~4	cf	6/6 The desti	nation to store the recordeddata."cf" means local storage (SD card). "0~4" means the index of thenetwork storage.
cffolder	string[128]	NULL	6/6	Folder name.
trigger	schedule,networkfail	schedule 6/6 The event trigger		typeschedule: The event is triggered byschedulenetworkfail: The event is triggeredby the failure of network connection.
adaptive_enable	0,1	0	6/6	Indicate whether the adaptivercording is enabled

adaptive_preevent 0~9 5	6/6 Indicate when is the adaptive		recording started before the event trigger point (seconds)
adaptive_postevent 0~10	5 6/6 Indicate when is the adaptive		recording stopped after the event trigger point (seconds)
maxsize 100~2000 100	6/6		Unit: Mega bytes.When this condition is reached, recording file is truncated.
maxduration	60~3600	60	6/6

7.31 HTTPS

Group: https

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
enable		0	6/6	To enable or disable secure HTTP.
policy		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~3650 36	50 6/6 Valid period	for the

7.32 Storage management setting

Currently it's for local storage (SD card)

Group: disk_i<0\~(n-1)> n is the total number of storage devices.

PARAMETER	VALUE	Default	SECURITY (get/set)	DESCRIPTION
cyclic_enabled		0	6/6	Enable cyclic storage method.
autocleanup_enabled		0	6/6	Enable automatic clean up method.Expired and not locked media files will be deleted.
autocleanup_maxage	1~	7	6/6	To specify the expired days for automatic clean up.

7.33 Region of interest

Group: roi_c<0\~(n-1)> for n channel product, and m is the number of streams which support ROI.

PARAMETER	VALUE	Default	SECURITY (get/set)	DESCRIPTION
s<0~(m-1)>_home		0,0	1/6	ROI left-top corner coordinate.
s<0~(m-1)>_size		1280x800	1/6	ROI width and height. The width value must be multiples of 16 and the height value must be multiples of 8

7.34 ePTZ setting

Group: eptz_c<0\~(n-1)> for n channel product.

PARAMETER VALUE	Default SECURITY	(get/set)	DESCRIPTION
osdzoom1 1/4 Indicates multiple of zoom in is			“on-screen display” or not
smooth1 1/4 Enable the ePTZ "move smoothly"			feature
tiltspeed -5~5 0 1/7 Tilt speed			(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)
panspeed -5~5 0 1/7 Pan speed			(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)
zoomspeed -5~5 0 1/7 Zoom speed			(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)
autospeed	1~5	1 1/7 Auto pan/patrol speed	(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)

Group: eptz_c<0\~(n-1)>_s<0\~(m-1)> for n channel product and m is the number of streams which support ePTZ.

PARAMETER VALUE	Default SECURITY		(get/set)	DESCRIPTION
patrolseq	string[120]		1/4	The patrol sequence of ePTZ. All the patrol position indexes will be separated by ","
patroldwelling	string[160]		1/4	The dwelling time (unit: second) of each patrol point, separated by “,”.
preset_i<0~19>_name	string[40]		1/7	Name of ePTZ preset.(It should be set by ePreset.cgi rather than by setparam.cgi.)
preset_i<0~19>_pos			1/7	Left-top corner coordinate of the preset.(It should be set by ePreset.cgi rather than by setparam.cgi.)

preset_i<0~19>_size

1/7 Width

and height of

the preset.(It should be set by ePreset.cgi rather than by setparam.cgi.)

7.35 Exposure window setting per channel

Group: exposurewin_c<0\~(n-1)> for n channel products

NAME VALUE DEFAULT	LT SECURITY		(get/set)	DESCRIPTION
mode auto, custom,	blc	auto 4/4 The mode indicates		how to decide the exposure.auto: Use full view as the only one exposure window.custom: Use inclusive and exclusive window.blc: Use BLC.
win_i<0~9>_enable		0	4/4	Enable or disable the window.
win_i<0~9>_policy	0~1	0	4/4	0: Indicate exclusive.1: Indicate inclusive.
win_i<0~9>_home		110,90	4/4	Left-top corner coordinate of the window.
win_i<0~9>_size		100x75	4/4	Width and height of the window.

Group: exposurewin_c<0\~(n-1)>_profile for m profile and n channel product

NAME	VALUE	DEFAULT	SECURITY (get/set)	DESCRIPTION
i<0~(m-1)>_mode	auto, custom, blc	auto	4/4	The mode indicates how to decide the exposure.auto: Use full view as the only one exposurewindow.custom: Use inclusive and exclusive window.blc: Use BLC.
i<0~(m-1)>_win_i<0~9>_enable		0 4/4 Enable or disable the		window.
i<0~(m-1)>_win_i<0~9>_policy	0~1 0 4/4 0: Indicate exclusive.			1: Indicate inclusive.
i<0~(m-1)>_win_i<0~9>_home	110,90 4/4 Left-top corner			coordinate of the window.
i<0~(m-1)>_win_i<0~9>_size	100x75 4/4 Width and height of			the window.

7.36 Seamless recording setting

Group: seamlessrecording

PARAMETER VALUE	Default SEC	URITY	(get/set)	DESCRIPTION
diskmode	scamless, manageable	scamless 1/6	“seamless” ind	indicates enable seamless recording. “manageable” indicates disable seamless recording.
maxconnection	3	3	1/6	Maximum number of connected seamless streaming.
stream	0~3	1	1/6	(Internal used, read only)
output	0~3	2	1/6	(Internal used, read only)
enable		0	1/6	Indicate whether seamless recording is recording to local storage or not at present. (Read only)
guid<0~2>_id	string[127]		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.37 VIVOTEK Application Development Platform setting

Group: vadp

NAME VALUE DEFAULT SECURITY			(get/set)	DESCRIPTION
version1.2.1.06/7 Indicate the VADPversion.				version.
resource_total_memory			6/7 Indicate total available memory size for VADP modules.
resource_total_storage			6/7 Indicate total size of the internal storage space for storing VADP modules.
resource_free_memory			6/7 Indicate free memory size for VADP modules.
resource_free_storage			6/7 Indicate current free storage size for uploading VADP modules.
module_number		0	6/7	Record the total module number that already stored in the system.
module_order	string[40]		6/6 The execution order of the enabled modules.
module_save2sd		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	LT SECURITY		(get/set)	DESCRIPTION
enable0 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]	6/6	Module name
url	string[120]	6/6	Define the URL	string after the IP address if the module provides it own web page.
vender	string[40]	6/6	The provider of the module.
vendorurl	string[120]	6/6	URL of the vendor.
version	string[40]	6/6	Version of the module.
license	string[40]		6/6	Indicate the lice of the module.
path	string[40]	6/6	Record the storage path of the module.
initscr	string[40]	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.

nse status

8. Useful Functions

8.1 Drive the Digital Output

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 

8.2 Query Status of the Digital Input

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: \r\n

\r\n

[di0 = ] r n

[di1=] \r\n

[di2=] \r\n

[di3=] |r|n

where can be 0 or 1.

Example: Query the status of digital input 1.

Request:

http://myserver/cgi-bin/dido/getdi.cgi?di1

Response:

HTTP/1.0 200 OK\r\n

Content-Type: text/plain\r\n

Content-Length: 7\r\n

\r\n

di1=1\r\n

8.3 Query Status of the Digital Output

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: \r\n

\r\n

[do0=]\r\n

[do1=]\r\n

[do2=]\r\n

[do3=]\r\n

where 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

\r\n

do1=1\r\n 

8.4 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		0 The resolution of the image.
quality 1~5 3	The quality of the image.
streamid	0~(m-1)		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> 

8.5 Account Management

Note: This request requires Administrator privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/admin/editaccount.cgi? method=<value>&username=<name>[&userpass=<value>][&privilege=<value>][&privilege=<value>][...][&return=<return page>] 

PARAMETER 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	The name of the user to add, delete, or edit.
userpass	The password of the new user to add or that of the old user to modify. The default value is an empty string.
Privilege		The privilege of the user to add or to modify.
	viewer	Viewer privilege.
	operator	Operator privilege.
	admin	Administrator privilege.
Return		Redirect to the pageafter the parameter is assigned. Thecan 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.

8.6 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: \r\n

\r\n

<system log information>\r\n 

8.7 Upgrade Firmware

Note: This request requires Administrator privileges.

Method: POST

Syntax:

http://<servername>/cgi-bin/admin/upgrade.cgi 

Post data:

fimage=[&return=]\r\n

\r\n

<multipart encoded form data> 

Server will accept the file named to upgrade the firmware and return with if indicated.

8.8 ePTZ Camera Control

Note: This request requires camctrl privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/camctrl/eCamCtrl.cgi?channel=<value>&stream=<value>
[&move=<value>] - Move home, up, down, left, right
[&auto=<value>] - Auto pan, patrol
[&zoom=<value>] - Zoom in, out
[&zooming=<value>&zs=<value>] - Zoom without stopping, used for joystick
[&vx=<value>&vy=<value>&vs=<value>] - Shift without stopping, used for joystick
[&x=<value>&y=<value>&videosize=<value>&resolution=<value>&stretch=<value>] - Click on image
(Move the center of image to the coordination (x,y) based on resolution or videosize.)
[ [&speedpan=<value>][&speedtilt=<value>][&speedzoom=<value>][&speedapp=<value>] ] - Set speeds
[&return=<return page>] 

Example:

http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=0&move=right
http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=1&vx=2&vy=2&vz=2
http://myserver/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=1&x=100&y=100&videosize=640x480&resolution=640x480&stretch=0 

PARAMETER VALUE DESCRIPTION
channel <0~(n-1)> Channel of video source.
stream	<0~(m-1)>	Stream.
move home Move to home ROI.
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 withzs speed, used for joystick control.
zs 0~6 Set the speed of zooming, “0” means stop.
vxThe direction of movement, used for joystick control.
vy
vs 0~7 Set the speed of movement, “0” means stop.
x		x-coordinate clicked by user.It will be the x-coordinate of center after movement.
y		y-coordinate clicked by user.It will be the y-coordinate of center after movement.
videosizeThe size of plug-in (ActiveX) window in web page
resolution	The resolution of streaming.
stretch		0 indicates that it usesresolution(streaming size) as the range of the coordinate system.1 indicates that it usesvideosize(plug-in size) as the range of the coordinate system.
speedpan	-5~5	Set the pan speed.
speedtilt	-5~5	Set the tilt speed.
speedzoom	-5~5	Set the zoom speed.
speedapp	1~5 Set the auto pan/patrol speed.
return		Redirect to the pageafter the parameter is assigned. Thecan be a full URL path or relative path according to the current path.

8.9 ePTZ Recall

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		Redirect to the pageafter the parameter is assigned. Thecan be a full URL path or relative path according to the current path.

8.10 ePTZ Preset Locations

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	ing less than 40 characters>	Add one preset location to the preset list.
delpos	ing less than 40 characters>	Delete preset location from the preset list.
return		Redirect to the pageafter the parameter is assigned. Thecan be a full URL path orrelative path according to the current path.
8.11 IP FilteringNote: This request requires Administrator access privileges.Method: GET/POSTSyntax:
http://cgi-bin/admin/ipfilter.cgi?method=&[start=&end=&index=&return=]
PARAMETER VALUE DESCRIPTION
method addallow	Add allowed IP address	ss range to the server. Start and end parameters must be specified. If the index parameter is specified, it will try to add starting from the index position.
	adddeny Add denied IP	address range to the server. Start and end parameters must be specified. If the index parameter is specified, it will try to add starting from the index position.
	delete callow Remove all	allowed IP address range from server. If start and end parameters are specified, it will try to remove the matched IP address. If index is specified, it will try to remove the address from given index position. [start, end] parameters have higher priority then the [index] parameter.
	deletedeny Remove den	died IP address range from server. If start and end parameters are specified, it will try to remove the matched IP address. If index is specified, it will try to remove the address from given index position. [start, end] parameters have higher priority then the [index] parameter.
startThe starting IP address to add or to delete.
endThe ending IP address to add or to delete.
indexThe start position to add or to delete.
return		Redirect to the pageafter the parameter is assigned. Thecan 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.

8.11.1 IP Filtering for ONVIF

Syntax:

http://cgi-bin/admin/ipfilter.cgi?type[=]
http://cgi-bin/admin/ipfilter.cgi?method=add&ip=[&index=&return=]
http://cgi-bin/admin/ipfilter.cgi?method=del&index=[&return=&return=
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.
ipSingle address:Network address:Range address:
indexThe start position to add or to delete.
return		Redirect to the pageafter the parameter is assigned. Thecan 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.

8.12 Event/Control HTTP Tunnel Channel

Note: This request requires Administrator privileges.

Method: GET and POST

Syntax:

http:///cgi-bin/admin/ctrlevent.cgi

GET /cgi-bin/admin/ctrlevent.cgi

x-sessioncookie: string[22]

accept: application/x-vvtk-tunnelled

pragma: no-cache

cache-control: no-cache

POST /cgi-bin/admin/ ctrlevent.cgi

x-sessioncookie: string[22]

content-type: application/x-vvtk-tunnelled

pragma : no-cache

cache-control : no-cache

content-length: 32767

expires: Sun, 9 Jam 1972 00:00:00 GMT

User must use GET and POST to establish two channels for downstream and upstream. The x-sessioncookie in GET and POST should be the same to be recognized as a pair for one session. The contents of upstream should be base64 encoded to be able to pass through the proxy server.

This channel will help perform real-time event subscription and notification as well as camera control more efficiently. The event and control formats are described in another document.

See Event/control tunnel spec for detail information

8.13 Get SDP of Streams

Note: This request requires Viewer access privileges.

Method: GET

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.

8.14 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.

8.15 Storage managements

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		Required.Command to be executed, including search, insert, delete, update, and queryStatus.

Command: search

PARAMETER VALUE DESCRIPTION
label	Optional.	The integer primary key column will automatically be assigned a unique integer.
triggerType		Optional.Indicate the event trigger type.Please embrace your input value with single quotes.Ex. mediaType='motion'Support trigger types are product dependent.
mediaType		Optional.Indicate the file media type.Please embrace your input value with single quotes.Ex. mediaType='videoclip'Support trigger types are product dependent.
destPath		Optional.Indicate the file location in camera.Please embrace your input value with single quotes.Ex. destPath ='/mnt/auto/CF/NCMF/abc.mp4'
resolution		Optional.Indicate the media file resolution.Please embrace your input value with single quotes.Ex. resolution='800x600'
isLocked		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		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	Optional.	Limit the maximum number of returned search records.
offset	Optional.	Specifies how many rows to skip at the beginning of the matched records.Note that the offset keyword is used after limit keyword.

To increase the flexibility of search command, you may use “OR” connectors for logical “OR” search operations. Moreover, to search for a specific time period, you can use “TO” connector.

Ex. To search records triggered by motion or di or sequential and also triggered between 2008-01-01 00:00:00 and 2008-01-01 23:59:59.

http:///cgi-bin/admin/lsctrl.cgi?cmd=search&triggerType='motion'+OR+'di'+OR+'seq' &triggerTime='2008-01-01 00:00:00'+TO+'2008-01-01 23:59:59'

Command: delete

PARAMETER VALUE DESCRIPTION
labelRequired.Identify the designated record.Ex. label=1	required.

Ex. Delete records whose key numbers are 1, 4, and 8.

http:///cgi-bin/admin/lsctrl.cgi?cmd=delete&label=1&label=4&label=8

Command: update

PARAMETER VALUE DESCRIPTION
labelRequired.		Identify the designated record.Ex. label=1
isLocked		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 

8.15.1 Return Message

The returned results are always in XML format, except for storage status related elements that can be returned in javascript format. (i.e. status, totalSize,_freeSize, and usefulness.)

The elements are listed as follows.

Group: stormgr

Element name	Type Description
counts	Integer> Total number	of matched records.
limit	Limit the maxim	num number of returned search records.Could be empty if not specified.
offset	Specifies how many rows to skip at the beginning of the matched records.Could be empty if not specified.
statusCode		The reply status (see table below)
		Value of return-code	Description
		200	OK
		400	Unrecognized Message Type/Content
		500	Server executes command error.
		501	Parse Input Message Failed.
		502	Error Occurs When Searching Database.
		503	Storage is Not Ready.
statusString	string	Return string describing the reason that status code is not OK.

Subgroup of stormgr: i<0\~(n-1)>: n is the total number of displayed records.

Element name Type Description
labelA unique integer.
triggerTypeIndicate the event trigger type.
mediaType	Indicate the file media type.
destPathIndicate the file location in camera.
resolutionIndicate the media file resolution.
isLockedIndicate if the file is locked or not.
triggerTime	Indicate the event trigger time.Format is “YYYY-MM-DD HH:MM:SS”
backup	Indicate if the file is generated when network loss.

Subgroup of stormgr_disk: i<0\~(n-1)>: n is the total number of storage devices.

Element name	Type	Description
name	string	Description of specified storage device.
status	ready, detached, error, and readonly	The storage device status.ready: storage is ready for access.detached: storage is not mounted.error: failed to open storage device.readonly: storage is write protected.
totalSize		The overall storage size in kilobytes.
freeSize		The available storage size in kilobytes.
usedSize		The used storage size in kilobytes.
path	string	Location of database of storage sink

Ex. Returned results of search command

<?xml version="1.0" encoding="ISO-8859-1" ?>
<stormgr version="0.0.0.1">
    <counts>5</counts>
    <limit>2</limit>
    <offset>0</offset>
    <i0>
    <label>1</label>
    <triggerType>motion</triggerType>
    <mediaType>videoclip</mediaType>
    <destPath>/mnt/auto/NCMF/abc/abc.jpg</destPath>
    <resolution>800x600</resolution>
    <isLocked>0</isLocked>
</stormgr> 

<triggerTime>2009-01-24 12:00:00</triggerTime>
<backup>0</backup>
</i0>
<i1>
<label>2</label>
<triggerType>di</triggerType>
<mediaType>snapshot</mediaType>
<destPath>/mnt/auto/NCMF/123/123.jpg</destPath>
<resolution>800x600</resolution>
<isLocked>0</isLocked>
<triggerTime>2009-01-24 12:01:00</triggerTime>
<backup>0</backup>
</i1>
</stormgr> 

Ex. Local storage status in XML format.

<?xml version="1.0" encoding="ISO-8859-1" ?>
<stormgr version="0.0.0.1">
    <disk>
    <i0>
    <name>SDcard</name>
    <status>ready</status>
    <totalSize>7824444</totalSize>
    <freeSize>7824388</freeSize>
    <usedSize>56</usedSize>
    </i0>
    </disk>
</stormgr> 

Ex. Local storage status in javascript format.

disk_i0_name='SDcard'
disk_i0_status='ready'
disk_i0_totalSize='7824444'
disk_i0_freeSize='7824388'
disk_i0_usedSize='56'
disk_i0_path=i0/NCMF/.db/.localStorage.db 

Command: queryStatus

PARAMETER VALUE DESCRIPTION 

retType xml or javascript Optional.

Ex. retype=javascriptThe default return message is in XML format.

Ex. Query local storage status and call for javascript format return message.

http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=queryStatus&retType=javascript 

There are two cgi commands for download and composing jpegs to avi format.

For download single selected file, you can use "/cgi-bin/admin/downloadMedias.cgi". Just assign the request file path to this cgi.

Syntax:

http://<servername>/cgi-bin/admin/downloadMedias.cgi?<File_Path> 

The is in querystus return message.

Ex.

http://<servername>/cgi-bin/admin/downloadMedias.cgi?/mnt/auto/CF/NCMF/20090310/07/02.mp4 

For creating an AVI file by giving a list of JPEG files, you can use "/cgi-bin/admin/jpegtoavi.cgi".

Syntax:

http://<servername>/cgi-bin/admin/jpegtoavi.cgi?<resolution>=<width>x<height>&<fps>=<num>&<list>=<fileList> 

PARAMETER VALUE DESCRIPTION
resolution	x	Resolution
fps	Frame rate
list	The JPEG file list.	The file path should be embraced by single quotation marks

Ex.

http:// <servername>/cgi-bin/admin/
jpegtoavi.cgi?resolution=800x600&fps=1&list='/mnt/auto/CF/NCMF/video1650.jpg', '/mnt/auto/C F/NCMF/video1651.jpg', '/mnt/auto/CF/NCMF/video1652.jpg', 

8.16 Virtual input

Note: Change virtual input (manual trigger) status.

Method: GET/POST

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=1Setting virtual input 0 to trigger state
		Ex: vi0=0(200)1Setting 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		Redirect to the pageafter the request is completely assigned. Thecan 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:1. setvi.cgi?vi0=0(10000)1(15000)0(20000)1No multiple duration.2. setvi.cgi?vi3=0VI index is out of range.3. setvi.cgi?vi=1No VI index is specified.

503 The resource is unavailable, ex. Virtual input is waiting for next state.

Examples:

1. setvi.cgi?vi0=0(15000)1

2. setvi.cgi?vi0=1

Request 2 will not be accepted during the execution time(15 seconds).

8.17 Open Timeshift Stream (timeshift\_enable=1,

timeshift\_c\_s\_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=<value>&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=<value>&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		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	Reference time for maxsft and minsft.(This provides more precise time control to eliminate the inaccuracy due to network latency.)

		request. Ex: Request the streaming from 12:20rtsp://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		0 How many seconds of cached stream client can accept at least.(Used by forcechk)

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.

8.18 Open Anystream

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 (MPEG4), the user needs to input the URL below into an RTSP compatible player.

rtsp://<servername>/liveany.sdp?codectype=mpeg4[&resolution=<value>&mpeg4_intraperiod=<value>&mpeg4_ratecontrolmode=<value>&mpeg4_quant=<value>&mpeg4_qvalue=<value>&mpeg4_bit rate=<value>&mpeg4_maxframe=<value>] 

For RTSP (H264), the user needs to input the URL below into an RTSP compatible player.

rtsp://<servername>/liveany.sdp?codetype=h264[&resolution=<value>&h264_intraperiod=<value>&h264_ratecontrolmode=<value>& h264_quant=<value>& h264_qvalue=<value>&h264_bitrate=<value>& h264_maxframe=<value>] 

PARAMETER	VALUE	DEFAULT	DESCRIPTION
codectype	mjpeg, mpeg4, h264	N/A	Set codec type for Anystream.
solution	capability_videoin_resolution		Video resolution in pixels.
mjpeg_quant 0, 1~5	99, 1~5	3 Quality of JPEG video.0,99 is the customized manual input setting.1 = worst quality, 5 = best quality.
mjpeg_qvalue	10~2002~97	50Manual video quality level input.(This must be present ifmjpeg_quant is equal to 0, 99)
mjpeg_maxframe 1~25	26~30 (only for NTSC or 60Hz CMOS)	15 Set maximum frame rate in fps(for JPEG).
mpeg4_intraperiod 250,	500, 1000, 2000, 3000, 4000	1000 Intra frame period in milliseconds.
mpeg4_ratecontrolmode	cbr, vbr vbr cbr: constant bitrate		vbr: fix quality
mpeg4_quant 0, 1~5	99, 1~5	3 Quality of video when choosingvbr in“mpeg4_ratecontrolmode”.0,99 is the customized manual input setting.1 = worst quality, 5 = best quality.
mpeg4_qvalue	1~312~31	7Manual video quality level input.(This must be present ifmpeg4_quant is equal to 0, 99)
mpeg4_bitrate	1000~80000001000~4000000	512000Set bit rate in bps when choosingcbr in“mpeg4_ratecontrolmode”.
mpeg4_maxframe 1~25,	26~30 (only for NTSC or 60Hz CMOS)	1015Set maximum frame rate in fps(for MPEG-4).
h264_intraperiod	250, 500, 1000, 2000, 3000, 4000	1000 Intra frame period in milliseconds.
h264_ratecontrolmode cbr, vbr, smart vbr cbr: constant bitrate			vbr: fix qualitysmart: smart stream
h264_quant 0, 1~5	99, 1~5	3 Quality of	video when choosingvbr in “h264_ratecontrolmode”.0,99 is the customized manualinput setting.1 = worst quality, 5 = bestquality.
h264_qvalue	0~51	30	Manual video quality level input.(This must be present if h264_quant is equal to 0, 99)
h264_bitrate	1000~80000001000~4000000	512000	Set bit rate in bps when choosingcbr in “h264_ratecontrolmode”.
h264_maxframe 1~25,	26~30 (only for NTSC or 60Hz CMOS)	1015	Set maximum frame rate in fps(for H264).
h264_smartstream_mode	autotracking, manual, hybrid	autotracking	Set Smart stream mode
h264_smartstream_foreground_quant	0~5 3 Quality of foreground	quality	0 = worst quality, 5 = bestquality.
h264_smartstream_background_quant	0~5 1 Quality of foreground	quality	0 = worst quality, 5 = bestquality.
h264_smartstream_maxbitrate	1000~40000000 40000000	Maximum bitrate
h264_smartstream_win_i<0~2>_enable	0~1 0 Enable or disable the window.
h264_smartstream_win_i<0~2>_home	(150,110)	Left-top	corner coordinate of thewindow.
h264_smartstream_win_i<0~2>_size	(100x75)	Width and height of the window.

8.19 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 

8.20 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 to upload this one to camera.

8.21 Media on demand

Media on demand allows users to select and receive/watch/listen to metadata/video/audio contents on demand.

Note: This request requires Viewer access privileges.

Syntax:

rtsp://<servername>/mod.sdp?[&stime=<value>][&etime=<value>][&length=<value>][&loctime=<value>][&file=<value>][&tsmode=<value>] 

PARAMETER	VALUE DEFAULT DESCRIPTION
stime	MMDD_HHMMSS.MMM> N/A Start time.
etime	MMDD_HHMMSS.MMM> N/A End time.
length	N/A The length of media of interest.		The unit is second.
loctime	0 Specify if start/end time is local		time format.1 for local time, 0 for UTC+0
file	N/A The media file to be played.
tsmode		N/A	Timeshift mode, the unit is second.

Ex.

stime	etime	length	file	Description
V	V X	X		Play recordings between stime and etimersp://10.10.1.2/mod.sdp?stime=20110312_040400.000&etime=2011_0312_040510.000
V	X	V	X	Play recordings for length seconds which start from stimertsp://10.10.1.2/mod.sdp?stime=20110312_040400.000&length=120
X	V	X		Play recordings for length seconds which ends at etimertsp://10.10.1.2/mod.sdp?etime=20110312_040400.000&length=120
X	X	X	V	Play file filertsp://10.10.1.2/mod.sdp?filename=/mnt/link0/

Technical Specifications

Technical Specifications

Model FD8138-H
System Information
CPU Multimedia SoC (System-on-Chip)
Flash 126MB
RAM 256MB
Camera Features
Imago Sensor I/3" Progressive CMOS
Maximum Resolution 1260x600
Lens Type	Vari-focal, Manual Focus
Focal Length	f = 2.8 - 12 mm
Aperture F1.3 ~ F2.85
Auto-Iris P.Iris
Field of View 33° ~ 87° (Horizontal)	21°~54° (Vertical)30°~110° (Diagonal)
Shutter Time	1/5 sec. to 1/30,000 sec.
WDR Technology	WDR Pro
Day'Night	Removable IR cut filter for day & night function
Minimum Illumination	0.27 Lux @ F1.8 (Color)0.001 Lux @ F1.8 (R/W)
Fan/IIR/zoom Functionalities	ePTZ:48x digital zoom (4x on E plug-in, 12x built-in)
IR Illuminators	Built-in IR Illuminators, effective up to 30 meters with Smart IRIR LED*6
On-board Storage	MicroSD/SDHC/SDXC card slot

Video

Compression	H.264, MPEG
Maximum Frame Rate	H.264:30 tos @ 1280x300MPEG:30 tos @ 1280x300
Maximum Streams	3 simultaneous streams
5' N Ratio	Above 61 dB
Dynamic Range	110 dB
Video Streaming	Adjustable resolution, quality and bitrate
Image Settings	Time stamp, text overlay, flip & mirrorConfigurable brightness, contrast, saturation, sharpness, whitebalance, exposure control, gain, backlight compensation,privacy masks. Schedules profile settings, 3D noise reduction,seamless recording

Audio

Audio Capability	Audio input/output (full duplex)
Compression	0.711, 0.728
Interface	Built-in microphoneAudio 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, IX

Interface	108aseo-T 100 basedTX Ethernet (R-45)
ONVIF	Supported, specification available at www.onvil.org
Intelligent Video
Video Motion Detection	Triple window video motion detection
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 serverFile upload via HTTP, SMTP, FTP and NAS server

General

Connectors	BJ-45 cable connector for Network/PoE connectionAudio outputDC 12V power inputDigital input*1Digital output*1
LED Indicator	System power and status indicator
Power Input	IEEE 802.3sf PoEDC 12V
Power Consumption	PoE Max: 9.7 WDC 12V: Max: 9.96 W
Dimensions	: 135 x 102 mm
Weight	Net: 51⁄2g
Safety Certifications	CE, LVD, FOG Class B, VCOI, C-Trok, UL
Operating Temperature	Starting Temperature: -10°C ~ 50°C (14°F~ 122°F)Working Temperature: 20°C ~ 50°C (-4°F~ 122°F)

Warranty 36 months

System Requirements

Operating System	Microsoft Windows 8/7 Vistar XP 2009
Web Browser	Mozilla Firefox 7-10 (streaming only)Internet Explorer 7.x or 6.x, 9.x, 10.x
Other Players	VLC:1.1.11 or aboveQuicktime: 7 or above
Included Accessories
CD	User's manual, quick installation guide, Installation Wizard 2,S17501 32-channel recording software
Others	Quick installation guide, warranty card, alignment sticker desiccant bag, waterproof connector

Dimensions

Compatible Accessories

Mounting Kits

AM-215 L Shape Bracket

AM-712 Conduit Box

AM-517 Adaptor Ring

AM-520 Mounting Adapter

All specifications are subject to change without notice. Copyright © VIVOTEK INC. All rights reserved.

Distributed by:

Ver. 4

VIVOTEK INC.

6F, No.192, Lien-Cheng Rd., Chung-Ho, 2050 Ringwood Avenue. New Taipei City, 235, Taiwan, R.O.C. San Jose, CA 95131
I: [phone] F: [phone] I: 408-773-8686 F: 408-773-8298 E: [e-mail] E: [e-mail]

VIVOTEK Europe

Randstad 22-133, 1316BW Almere, The Netherlands

1: +31|0|36-5298-434

E: [e-mail]

Technical Specifications

Model FD8338-HV
System Information
CPU Multimedia SoC (System-on-Chip)
Flash 128 MB
RAM 256MB
Camera Features
Image Sensor 1/3" Progressive CMOS
Maximum Resolution 1280x800
Lens Type Vari-Focal, Manual Focus
Focal Length f = 2.8 - 12 mm
Aperture F1.8 ~ F2.85
Auto-irls P-Iris
Field of View 33' - 87" (Horizontal)	21" - 54" (Vertical)39' - 110" (Diagonal)
Shutter Time 1/5 sec. to 1/32,000 sec.
WDR Technology	WDR Pro
Day/Night	Removable IR cut filter for day & night function
Minimum Illumination	0.27 Lux @ F1.8 (Color)0.001 Lux @ F1.8 (B/W)
Pan/tilt/zoom functionalities	ePTZ48x digital zoom (4x on IE plug in, 12x built in)
IR Illuminators	Built-in IR Illuminators, effective up to 30 meters with Smart IRIR LED*6
On-board Storage	MicroSD/SDHC/SDXC card slot
Video
Compression H.264, MJPG
Maximum Frame Rate	H.264:30 fps @ 1280x800MJPG:30 fps @ 1280x800
Maximum Streams	3 simultaneous streams
S/N Ratio	Above 61 dR
Dynamic Range	110 dB
Video Streaming	Adjustable resolution, quality and bitrate
Image Settings	Time stamp, text overlay, flip & mirrorConfigurable brightness, contrast, saturation, sharpness, white balance, exposure control, gain, backlight compensation, privacy masks, Scheduled profile settings, 3D noise reduction, seamless recording
Audio
Audio Capability	Audio input/output (full duplex)
Compression G.711, G.720
Interface	External microphone inputAudio output
Network
Users	Live viewing for up to 10 clients
Protocols	IPv4, IPv6, TCP/IP, HTTP, HTTPS, UPnP, RTSP/RTP/RTCP, ICMP, SMTP, FTP, DHCP, NTP, DNS, DDNS, PMOE, Cos, QoS, SNMP, 802.IX
Interface	10Base-T/100 BaseTX Ethernet (RU-45)

Compatible Accessories

Mounting Kits
	AM-215L Shape Bracket		AM-517Adaptor Ring

ONVIF Supported, specification available at www.onvif.org

Intelligent Video
Video Motion Detection	Triple-window video motion detection
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 serverFile upload via HTTP, SMTP, FTP and NAS server

General

Connectors	RJ-45 cable connector for Network/PoE connectionAudio inputAudio outputDC 12V power inputDigital input*1Digital output*1
LED Indicator System power and status indicator
Power Input	IEEE 802.3af PoEDC 12V
Power Consumption	PoE: Max. 9.7WDC 12V: Max. 9.96 W
Dimensions	∅: 141 x 103 mm
Weight	Net: 836g
Casing	Weather proof IP66-rated housingVandal-proof IK10-rated metal housing
Safety Certifications	CF, LVD, FCC Class A, VCCI, C-Tick, UL
Operating Temperature	Starting Temperature: -10°C ~ -50°C (14T~ 122T)Working Temperature: 20°C ~ 50°C (4T~ 122°F)

Warranty 36 months

System Requirements

Operating System	Microsoft Windows 8/7/Vista/XP/2000
Web Browser Mozilla Firefox 7-10 (Streaming only)Internet Explorer 7.x or 8.x, 9.x, 10.x
Other Players	VLC: 1.1.11 or aboveQuicktime: 7 or above
Included Accessories
CD	User's manual, quick installation guide, Installation Wizard 2, ST7501 32-channel recording software
Others	Quick installation guide, warranty card, alignment sticker/desiccant bag, waterproof connector

Dimensions

All specifications are subject to change without notice. Copyright © VIVOTEK INC. All rights reserved.

Distributed by:

Ver. 4

VIVOTEK INC.

6F, No.192, Lien-Cheng Rd., Chung-Ho,

New Taipei City, 235, Taiwan, R.O.C

T [phone] F [phone]

E: [e-mail]

VIVOTEK USA

2050 Ringwood Avenue.

San Jose, CA 95131

Randstad 22-133, 1316BW Almere,

The Netherlands

T-31(0)36-5298-434

E: [e-mail]

Technology License Notice

MPEG-4 AAC Technology

THIS PRODUCT IS LICENSED UNDER THE MPEG-4 AAC AUDIO PATENT LICENSE. THIS PRODUCT MAY NOT BE DECOMPILED, REVERSE-ENGINEERED OR COPIED, EXCEPT WITH REGARD TO PC SOFTWARE, OF WHICH YOU MAY MAKE SINGLE COPIES FOR ARCHIVAL PURPOSES. FOR MORE INFORMATION, PLEASE REFER TO HTTP://WWW.VIALICENSING.COM.

MPEG-4 Visual Technology

THIS PRODUCT IS LICENSED UNDER THE MPEG-4 VISUAL PATENT PORTFOLIO LICENSE FOR THE PERSONAL AND NON-COMMERCIAL USE OF A CONSUMER FOR (i) ENCODING VIDEO IN COMPLIANCE WITH THE MPEG-4 VISUAL STANDARD ("MPEG-4 VIDEO") AND/OR (ii) DECODING MPEG-4 VIDEO THAT WAS ENCODED BY A CONSUMER ENGAGED IN A PERSONAL AND NON-COMMERCIAL ACTIVITY AND/OR WAS OBTAINED FROM A VIDEO PROVIDER LICENSED BY MPEG LA TO PROVIDE MPEG-4 VIDEO. NO LICENSE IS GRANTED OR SHALL BE IMPLIED FOR ANY OTHER USE. ADDITIONAL INFORMATION INCLUDING THAT RELATING TO PROMOTIONAL, INTERNAL AND COMMERCIAL USES AND LICENSING MAY BE OBTAINED FROM MPEG LA, LLC. PLEASE REFER TO HTTP://WWW.MPEGLA.COM.

AMR-NB Standard

THIS PRODUCT IS LICENSED UNDER THE AMR-NB STANDARD PATENT LICENSE AGREEMENT. WITH RESPECT TO THE USE OF THIS PRODUCT, THE FOLLOWING LICENSORS' PATENTS MAY APPLY:

TELEFONAKIEBOLAGET ERICSSON AB: US PAT. 6192335; 6275798; 6029125; 6424938; 6058359. NOKIA CORPORATION: US PAT. 5946651; 6199035. VOICEAGE CORPORATION: AT PAT. 0516621; BE PAT. 0516621; CA PAT. 2010830; CH PAT. 0516621; DE PAT. 0516621; DK PAT. 0516621; ES PAT. 0516621; FR PAT. 0516621; GB PAT. 0516621; GR PAT. 0516621; IT PAT. 0516621; LI PAT. 0516621; LU PAT. 0516621; NL PAT. 0516621; SE PAT 0516621; US PAT 5444816; AT PAT. 819303/AT E 198805T1; AU PAT. 697256; BE PAT. 819303; BR PAT. 9604838-7; CA PAT. 2216315; CH PAT. 819303; CN PAT. ZL96193827.7; DE PAT. 819303/DE69611607T2; DK PAT. 819303; ES PAT. 819303; EP PAT. 819303; FR PAT. 819303; GB PAT. 819303; IT PAT. 819303; JP PAT. APP. 8-529817; NL PAT. 819303; SE PAT. 819303; US PAT. 5664053. THE LIST MAY BE UPDATED FROM TIME TO TIME BY LICENSORS AND A CURRENT VERSION OF WHICH IS AVAILABLE ON LICENSOR'S WEBSITE AT HTTP://WWW.VOICEAGE.COM.

Electromagnetic Compatibility (EMC)

FCC Statement

This device compiles with FCC Rules Part 15. Operation is subject to the following two conditions.

■ This device may not cause harmful interference, and
■ This device must accept any interference received, including interference that may cause undesired operation.

This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a partial installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures:

■ Reorient or relocate the receiving antenna.
■ Increase the separation between the equipment and receiver.
■ Connect the equipment into an outlet on a circuit different from that to which the receiver is connected.
■ Consult the dealer or an experienced radio/TV technician for help.

Shielded interface cables must be used in order to comply with emission limits.

CE Mark Warning

This is a Class B product. In a domestic environment, this product may cause radio interference, in which case the user may be required to take adequate measures.

VCCI Warning

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.