Vivotek Turret Dome IT9389-H - Security Camera

Turret Dome IT9389-H - Security Camera Vivotek - Free user manual and instructions

Find the device manual for free Turret Dome IT9389-H Vivotek in PDF.

📄 458 pages English EN Download 💬 AI Question
Notice Vivotek Turret Dome IT9389-H - page 6
Pick your language and provide your email: we'll send you a specifically translated version.

User questions about Turret Dome IT9389-H Vivotek

0 question about this device. Answer the ones you know or ask your own.

Ask a new question about this device

The email remains private: it is only used to notify you if someone responds to your question.

No questions yet. Be the first to ask one.

Download the instructions for your Security Camera in PDF format for free! Find your manual Turret Dome IT9389-H - Vivotek and take your electronic device back in hand. On this page are published all the documents necessary for the use of your device. Turret Dome IT9389-H by Vivotek.

USER MANUAL Turret Dome IT9389-H Vivotek

natural_image Technical line drawing of a mechanical component with concentric rings and internal features (no text or symbols)

Rev. 1.0

Table of Contents

Overview....3

Revision History .... 4

Read Before Use....4

Package Contents....5

Symbols and Statements in this Document....5

Physical Description 6

Hardware Installation 8

Software Installation....16

Network Deployment....29

Ready to Use....30

Accessing the Network Camera 33

Using Web Browsers 33

Using RTSP Players....36

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

Using VIVOTEK Recording Software 38

Main Page....39

Client Settings....44

Configuration......49

System > General settings....50

System > Maintenance....60

Media > Image 63

Media > Video 76

Media > Video ....77

Media > Video 78

Media > Audio....87

Media profiles 88

Network > General settings....89

Network > Streaming protocols 96

Network > SNMP (Simple Network Management Protocol) 105

Network > FTP 106

Bonjour 107

Security > User accounts 108

Security > HTTPS (Hypertext Transfer Protocol over SSL) 110

Security > Access List 117

PTZ > PTZ settings 123

Event > Event settings.... 127

Applications > Motion detection....143

Applications > Tampering detection 144

Applications > Smart VCA....145

Applications > Audio detection 146

Applications > Shock detection 147

Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform) ... 148

Recording > Recording settings 151

Storage 156

Storage > SD card management....156

Storage > NAS management 157

Storage > Content management 159

Appendix 162

URL Commands for the Network Camera....162

Technology License Notice....437

Electromagnetic Compatibility (EMC)....438

Overview

The IT9389-H-v2 is an outdoor turret dome camera capable of 5MP imaging at 30 fps. With the WDR Pro technology, the camera series is capable of capturing the highest quality images in both low light and high contrast environments.

These models support local video stroage on the MicroSD cards if network service should be interrupted. The camera also comes with configurable motion detection and tampering detection with up to 5 privacy mask areas.

The camera comes with seamless recording that allows recording to the SD card when the network connection is down. When the network connection is restored, the recorded video will be retrieved from SD card to your NVR or VAST recording station.

Vivotek Turret Dome IT9389-H - Overview - 1

IMPORTANT:

The equipment comes with a RTC battery. Note the following:

  • Replacement of a battery with an incorrect type that can defeat a safeguard (for example, in the case of some lithium battery types);
  • Disposal of a battery into fire or a hot oven, or mechanically crushing or cutting of a battery, that can result in an explosion;
    • Leaving a battery in an extremely high temperature surrounding environment that can result in an explosion or the leakage of flammable liquid or gas; and
  • A battery subjected to extremely low aire pressure that may result in an explosion or the leakage of flammal liquid or gas.
  • CAUTION: Risk of fire or explosion if the battery is replaced by an incorrect type.

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.

Vivotek Turret Dome IT9389-H - Read Before Use - 1

IMPORTANT:

  1. The product must be installed and protected in a location that is not easily accessible, and is away from impacts or heavy vibration. For example, at the location where the surveillance cameras are looking down or installed at high positions such as on a wall, or at least 3 meters above the ground.
  2. The camera should be installed at least 10 centimeters away from the eave of a building.
  3. If powered by a power adapter, the adapter should be properly grounded.
  4. Maintenance and repair work must always be carried out by qualified technical personnel.
  5. Disconnect power from the unit when performing a maintenance task.
  6. Please contact VIVOTEK's certified dealers for power adapters.

Package Contents

■ IT9389-H-v2
■ Screw pack, T10 anti-tamper screw wrench.
■ Alignment sticker. ■ Mounting plate.
■ Quick Installation Guide.
■ Waterproof cable gland.

Symbols and Statements in this Document

Vivotek Turret Dome IT9389-H - Symbols and Statements in this Document - 1

INFORMATION: provides important messages or advices that might help prevent inconvenient or problem situations.

Vivotek Turret Dome IT9389-H - Symbols and Statements in this Document - 2

NOTE: Notices provide guidance or advices that are related to the functional integrity of the machine.

Vivotek Turret Dome IT9389-H - Symbols and Statements in this Document - 3

Tips: Tips are useful information that helps enhance or facilitae an installation, function, or process.

Vivotek Turret Dome IT9389-H - Symbols and Statements in this Document - 4

WARNING: or IMPORTANT:: These statements indicate situations that can be dangerous or hazardous to the machine or you.

Vivotek Turret Dome IT9389-H - Symbols and Statements in this Document - 5

Electrical Hazard: This statement appears when high voltage electrical hazards might occur to an operator.

Vivotek Turret Dome IT9389-H - Symbols and Statements in this Document - 6

IMPORTANT:

Use the camera only with a DC power supply that is UL listed, and limited power source (LPS) certified. The power supply should bear the UL listed and LPS marks. The power supply should also meet any safety and compliance requirements for the country of use.

Physical Description
Vivotek Turret Dome IT9389-H - IMPORTANT: - 1

text_image IR LEDs Lens Microphone SC card access panel RJ45 Ethernet connector

Vivotek Turret Dome IT9389-H - IMPORTANT: - 2

text_image Reset button SD card slot

Vivotek Turret Dome IT9389-H - IMPORTANT: - 3

NOTE:

Some of the suffix syntax used in model naming are listed below:

E w/ heater for extreme weather
Fx Focal length w/ number
T w/ Remote focus lens
R w/ PoE repeater
H w/ High Dynamic Range functionality

Hardware Installation

  1. Jot down the camera's MAC address for later reference.

Vivotek Turret Dome IT9389-H - Hardware Installation - 1

text_image Network Camera VIVOTEK Model No: XXXXXX MAC: 0002D10766AD CE FC XXXX Pat.6, 930, 709 RoHS Made in Taiwan

Vivotek Turret Dome IT9389-H - Hardware Installation - 2

natural_image Illustration of a hand writing on a sheet of paper with a pen (no text or symbols present)
  1. Remove the trim ring by snatching and pulling it.

Vivotek Turret Dome IT9389-H - Hardware Installation - 3

text_image Micro SD Reset

Vivotek Turret Dome IT9389-H - Hardware Installation - 4

You can tilt, pan, or rotate the lens body to acquire the best field of view.

Vivotek Turret Dome IT9389-H - Hardware Installation - 5

text_image 75° 180° 180°
  1. Tilt the camera to access the MicroSD access panel. Loosen 2 T10 screws to open it.

Vivotek Turret Dome IT9389-H - Hardware Installation - 6

text_image Micro SD Reset T10 Micro SD Reset
  1. Install a MicroSD card if onboard storage is preferred.

Vivotek Turret Dome IT9389-H - Hardware Installation - 7

natural_image Technical line drawing of a device with an arrow pointing to a micro drive labeled '64GB' (no text or symbols on the diagram itself)
  1. Use the alignment sticker to drill mounting holes on the wall or ceiling. Drill a cabling routing hole if preferred.

Vivotek Turret Dome IT9389-H - Hardware Installation - 8

text_image Alignment Sticker V3 Drill hole Drill hole P/X:XXXXX Ø ≥25mm
  1. Install the access panel back to its original position.

Vivotek Turret Dome IT9389-H - Hardware Installation - 9

natural_image Technical line drawing of a micro SO reset device with attached mechanical components (no text or symbols)
  1. Use the alignment sticker to drill holes on a wall or ceiling.

Vivotek Turret Dome IT9389-H - Hardware Installation - 10

text_image Cable hole Alignment Sticker
  1. Route an Ethernet cable through the routing hole.

Vivotek Turret Dome IT9389-H - Hardware Installation - 11

text_image Ø ≥25mm
  1. If a routing hole is not applicable, you can route the cable along the wall by removing a side lid from the mouting bracket using a pincer.

Vivotek Turret Dome IT9389-H - Hardware Installation - 12

text_image Diagram illustrating the process of a camera lens assembly, showing wire connection and tool application steps.
  1. Pass an Ethernet cable through the waterproof cable gland components, and through the rubber seal as shown below. Connect the Ethernet cable to the camera's RJ45 connector.

Vivotek Turret Dome IT9389-H - Hardware Installation - 13

text_image 5.5 ~ 6.4mm
  1. Install the seal ring and tighten the waterproof components.

Vivotek Turret Dome IT9389-H - Hardware Installation - 14

natural_image Diagram of a cable connector assembly showing internal components and wiring (no text or labels)
  1. Secure the camera to wall by driving 2 screws. You can also route the cables through the side by breaking the side lid using a pincer.

Vivotek Turret Dome IT9389-H - Hardware Installation - 15

natural_image Technical line drawing of a ceiling-mounted device with screwdriver and socket, no text or symbols present

Vivotek Turret Dome IT9389-H - Hardware Installation - 16

Note that it is always a good practice to form a drip loop of cables. Moisture condensation or dripping water can eventually cause problems without the drip loop.

Vivotek Turret Dome IT9389-H - Hardware Installation - 17

text_image PoE - User's Manual

14 - User's Manual

  1. Please visit VIVOTEK's website to Install the "Shepherd" software utility. The program will search for VIVOTEK Video Receivers, Video Servers or Network Cameras on the same LAN.

Double-click on the camera's MAC address to open a web console to the camera.

Vivotek Turret Dome IT9389-H - Hardware Installation - 18

Vivotek Turret Dome IT9389-H - Hardware Installation - 19

text_image 66 device(s) found Status Model IP ▲ MAC All devices Selected VSR401 192.158.40.71 00-02-01-12-48-56 C300c FDR157 192.158.40.76 00-02-01-30-04-35 C10023 FDR172 192.158.40.69 00-02-01-23-09-FC C200a FDR261 192.158.40.68 00-02-01-25-27-8F C100c FDR174 192.158.40.67 00-02-01-28-09-18 C203a1 FDR165HP 192.158.40.62 00-03-03-10-AA-54 C201c FDR371E 192.158.40.54 00-02-01-25-45-8F C301b FDR362E 192.158.40.51 00-02-01-21-29-05 C203d FDR155HP 192.158.40.47 00-02-01-28-16-93 C203a FDR1437T 192.158.40.42 00-02-01-30-28-48 C100f FDR173 192.158.40.28 00-02-01-25-50-84 C203h FDR371EV 192.158.40.27 00-02-01-28-89-85 C309b FDR369 192.158.40.26 00-03-01-29-30-63 C109g FDR373-EHV 192.158.40.25 00-02-01-31-51-82 C140g FDR180 192.158.40.23 00-02-01-32-25-19 C109f FDR372 192.158.40.21 00-02-01-25-44-97 C269h

Vivotek Turret Dome IT9389-H - Hardware Installation - 20

flowchart
graph LR
    A["Device"] --> B["LAN"]
    B --> C["IEEE 802.3af"]
    C --> D["Browser"]
    D --> E["Shepherd"]
    E --> F["66 device(s) found o"]

Software Installation

  1. Install the Shepherd utility, which helps you locate and configure your Network Camera in the local network. If your camera comes without the CD, go to VIVOTEK's website, and locate the utility in the Downloads > Software page.

Vivotek Turret Dome IT9389-H - Software Installation - 1

text_image VIVOTEK Products Support Downloads Solutions L Product Files Brochure Firmware Flyer Logo Software Wall Paper SDK A&E Tough Prote for Tough High-Seq

13-1. Run the Shepherd utility.

13-2. The program will conduct an analysis of your network environment.

Vivotek Turret Dome IT9389-H - Software Installation - 2

text_image 13 device(s) found Search with IP range Status Model IP MAC All devices Selected AW-GET-DNA... 192.168.4.123 00-02-D1-2F-B7-3C 0106 EQ8141 192.168.50.4 00-02-D1-2D-5S-BF 0100gs FD9181-H 192.168.50.3 00-02-D1-3E-1D-B7 0100s3 IZ9361-EH 192.168.4.148 00-02-D1-43-66-52 0102f FD8177-H 192.168.4.147 00-02-D1-4B-F2-1C 0100e_8 SD9368-EHL 192.168.4.105 00-02-D1-4C-FB-E8 0103a AW-GEU-085A... 192.168.50.3 00-02-D1-4E-B8-14 0001 VAST 169.254.214.242 00-50-56-C0-00-01 1.32.1.8 VAST 192.168.4.113 2C-4B-DC-EF-S2-9F 1.33.0.3 VAST 192.168.4.131 2C-4B-DC-EF-S2-A0 1.32.1.8 VAST 192.168.4.121 34-56-D7-24-TD-C6 1.33.0.3 VAST 192.168.4.118 54-53-ZD-B3-B9-B7 1.33.0.3 VAST 169.254.214.242 67-56-ZA-3E-B7-A3 1.33.1.8

13-3. The program will search for all VIVOTEK network devices on the same LAN.

13-4. After a brief search, the installer window will prompt. Click on the MAC and model name that matches the one printed on the product label. You can then double-click on the address to open a management session with the Network Camera.

Vivotek Turret Dome IT9389-H - Software Installation - 3

text_image Network Camera VIVOTEK Model No: IT9389-H-v2 MAC:0002D1730202 RoHS CE N11360 FC VEI This device is designed with a 5% of the FDC bus. Operation is subject to the following: we still need: ITINAS based on what can be necessary for operation, and (2) PC device has open all information received, creating network that may have undemand operation. Pat. 6,830,709 Made in Taiwan

Vivotek Turret Dome IT9389-H - Software Installation - 4

text_image 1 selected Search with IP range All devices Selected Status Model IP MAC Firmware E8368-W-2 192.168.4.151 00:02-D1-73-02-02 0002D1730202 E2981-EH 192.168.4.148 01:02F FD8177-H 192.168.4.147 01:00e_8 SO9366-EHL 192.168.4.105 00-02-01-4C-FB-EB 01:03e VAST 192.168.4.13 00-50-56-CD-00-01 1.12.1.8 VAST 192.168.4.113 2C-60-0C-FF-52-9F 1.13.8.3 VAST 192.168.4.131 2C-60-0C-FF-52-A0 1.12.1.8 VAST 192.168.4.118 54-53-ED-B3-B9-RE 1.13.8.3 VAST 192.168.4.130 54-A0-50-BB-39-3B 1.12.1.8 ISSXWD-W 169.254.205.233 5C-P3-70-36-29-D3 01:00b VAST 169.254.182.143 GB-05-CA-IF-BD-10 1.12.1.8

Forceful Password Configuration

  1. The first time you log in to the camera, the firmware will prompt for a password configuration for security concerns.
    13-1. Since your camera is used for the first time, there is no password. Enter "root" as the user name, and nothing for the password.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 1

text_image Windows Security The server 169.254.205.239 is asking for your user name and password. The server reports that it is from streaming_server. Warning: Your user name and password will be sent using basic authentication on a connection that isn't secure. root Remember my credentials 確定 取消

13-2. Enter the combination of alphabetic and numeric characters to fulfill the password strength. requirement. The default name for the camera administrator is "root", and can not be changed.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 2

text_image VIVOTEK www.vivotek.com Language Configure password At least 8 characters with no space, one alphabet character(uppercase or lowercase), and one numeric character User name : root User password : medium Confirm user password : ✓ Enable https connection to secure the configuration for password *The new password will be applied to all connections Save Cancel

Some, but not all special ASCII characters are supported: !, \$, %, -, ., @, ^, _, and \~. You can use them in the password combination.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 3

text_image You have used invalid characters. These characters are valid:A-Z, a-z, 0-9 and !$%-.@^_^~

13-3. Another prompt will request for the password you just configured. Enter the password and then you can start configure your camera and see the live view.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 4

text_image Windows Security The server 169.254.205.239 is asking for your user name and password. The server reports that it is from streaming_server. Warning: Your user name and password will be sent using basic authentication on a connection that isn't secure. root Remember my credentials 確定 取消
  1. With a live view on your computer, rotate, pan, or tilt the camera until you acquire an optimal field of view. Loosen the retention screw on the side of the camera.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 5

text_image Technical diagram showing mechanical assembly with labeled components and prohibition signs
  1. Pan or tilt the camera.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 6

flowchart
graph TD
    A["Camera with sensor"] --> B["Rotation System"]
    B --> C["Home with tree and person climbing a path"]
    C --> D["House with tree and person running along a path"]
  1. When done, tighten the retention screw.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 7

natural_image Technical line drawing of a mechanical component with a dashed line indicating a connection or assembly (no text or symbols present)
  1. Install the trim ring.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 8

text_image M203.60 M203.60 M203.60

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 9

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 10

With the mount bracket, the camera can be installed to a single gang box, or 3.5" box.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 11

natural_image Technical line drawing of a mechanical housing or enclosure with multiple circular cutouts and mounting holes (no text or symbols)

3.5" single gang box

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 12

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 13

text_image Technical diagram of a circular mechanical component with labeled parts A, B, C and mounting holes

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 14

natural_image Technical line drawing of a mechanical housing component with circular holes and mounting holes (no text or symbols)

3.5" Octagon gang box

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 15

B holes
Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 16

natural_image Technical line drawing of a mechanical housing component with circular holes and mounting holes (no text or symbols)

3.5" single gang box

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 17

text_image Technical diagram of a mechanical component with labeled parts A, B, C and arrows indicating features or assembly points.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 18

text_image C holes

3.5" Octagon gang box

You can press fit the Ethernet cable to clips on the bracket.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 19

text_image A-2 9

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 20

You can press fit the cable gland assembly in the center. Route the cable along the side of the bracket.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 21

natural_image Technical diagram of a mechanical assembly showing internal components and directional arrows (no text or labels)

Install the camera by aligning with the associated key-slot holes.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 22

text_image A-4 A C B A C A

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 23

Turn the camera clockwise and fasten a retention screw.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 24

natural_image Technical line drawing of a mechanical assembly with a hand holding a tool, showing internal components and a close-up view of the component (no text or symbols present)

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 25
B

The mounting bracket can be directly installed to a wall or ceiling. Use the included alignment sticker.
Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 26

text_image 3-1 Cable holes Alignment Sticker

B-2
The mounting bracket can be directly installed to a wall or ceiling. Use the included alignment sticker. Refer to Step A-2 for the rest of the procedure.
Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 27

text_image A holes A-2

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 28

The mounting bracket can be installed to a 3/4" NPT pipe. With a 3/4" female coupling, and a hex nut, you can install the bracket to it.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 29

text_image 3/4" NPT pipe 3/4" female threaded fitting/coupling Locknut

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 30

natural_image Technical line drawing of a mechanical device with a vertical shaft and a separate vertical cable (no text or symbols)
  1. Remove the protective sheet from the dome cover.

Vivotek Turret Dome IT9389-H - Forceful Password Configuration - 31

natural_image Illustration of a hand holding a camera lens with a magnified inset showing the lens and screen (no text or symbols)

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 the recessed reset button. Wait for the Network Camera to reboot.

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

SD/SDHC/SDXC Card Capacity

This network camera is compliant with SD/SDHC/SDXC 16GB / 8GB / 32GB / 64GB / , and up to 512 / 1024GB and other preceding standard SD cards.

Network Deployment

General Connection (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.

Vivotek Turret Dome IT9389-H - When using a PoE-enabled switch - 1

text_image 802.3af PoE Switch

When using a non-PoE switch

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

Vivotek Turret Dome IT9389-H - When using a non-PoE switch - 1

text_image PoE Power Injector (optional) Non-PoE Switch

Vivotek Turret Dome IT9389-H - When using a non-PoE switch - 2

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.

Ready to Use

  1. A browser session to 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 in a deployment consisting of multiple cameras. For its installation details, please refer to its related documents.

Vivotek Turret Dome IT9389-H - Ready to Use - 1

text_image IT9389-H-v2 Profile name: Max Manual triggers: PTZ control: Digital Home Client settings Configuration Language Powered by Vivotek

Internet connection via a router

Before setting up the Network Camera over the Internet, make sure you have a router and follow the steps below.

  1. Connect your Network Camera behind a router, the Internet environment is illustrated below. Regarding how to obtain your IP address, please refer to Software Installation on page 20 for details.

Vivotek Turret Dome IT9389-H - Internet connection via a router - 1

flowchart
graph TD
    A["Internet"] --> B["Cable or DSL Modem"]
    B --> C["WAN (Wide Area Network)<br>Router IP address : from ISP"]
    C --> D["LAN (Local Area Network)<br>Router IP address: 192.168.0.1"]
    D --> E["IP address: 192.168.0.3<br>Subnet mask: 255.255.255.0<br>Default router: 192.168.0.1"]
    D --> F["IP address: 192.168.0.2<br>Subnet mask: 255.255.255.0<br>Default 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 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 90 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 89 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 90 for details.

For example, your router and IP settings may look like this:

Device IP Address: internal port IP Address: External Port (Mapped port on the router)
Public IP of router 122.146.57.120
LAN IP of router 192.168.2.1
Camera 1 192.168.2.1080 122.146.57.120:8000
Camera 2 192.168.2.1180 122.146.57.120:8001
... ... ...

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

From Forward to
122.146.57.120:8000 192.168.2.10:80
122.146.57.120:8001 192.168.2.11:80
... ...

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

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

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

Vivotek Turret Dome IT9389-H - Internet connection via PPPoE (Point-to-Point over Ethernet) - 1

text_image Network > General settings Network type Port LAN Get IP address automatically Use fixed IP address Enable UPnP presentation Enable UPnP port forwarding PPPoE Enable IPv6 IPv6 inform: Manusity The device is configuring now. Your browser will reconnect to http://192.168.4.140:80/ If the connection fails, please manually enter the above IP address in your browser. Save System Media Network General settings Streaming protocols DONS QoS SNMP Security PTZ Event

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

Vivotek Turret Dome IT9389-H - Using Web Browsers - 1

text_image Network Camera - Microsoft Internet Camera Profile name: New Manual image: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 Mega-Pixel Network Camera This is a plug-in (ActiveX). If you see this text, your browser is not support or disable ActiveX. Information Bar: Did you notice the Information Bar? The Information Bar does not use any Internet Explorer which is a popular window or download site that is used. It is a single page or more image. Use in the Information Bar (see the top of your browser). Do not show the language again. Lines about the Information Bar... 01 Side VIVOTEK

Vivotek Turret Dome IT9389-H - Using Web Browsers - 2

text_image Network Camera - Myrtle Files Add to Web Help Add to Web Help Additional plugin are installed to deposit the media on the page. Initial Pinning Tools Mega-Pixel Network Camera Choose how to download a plugin Plugin Plugin Service Available Plugin Downloads The following plugin are available: Apache Utilities Save plugin must receive additional information from your existing installation. Press Next to install these plugins. Next > Cancel Name

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

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.

Vivotek Turret Dome IT9389-H - Using Web Browsers - 3

text_image Internet Options General Security Privacy Content Connections Programs Advanced Select a Web content zone to specify its security settings. Internet Local intranet Trusted sites Restricted sites Internet This zone contains all Web sites you haven't placed in other zones Sites... Security level for this zone Custom Custom settings. - To change the settings, click Custom Level. - To use the recommended settings, click Default Level. Custom Level... Default Level OK Cancel Apply
  1. Look for Download signed ActiveX ^® controls; select Enable or Prompt. Click OK.

Vivotek Turret Dome IT9389-H - Using Web Browsers - 4

text_image Security Settings Settings: ActiveX controls and plug-ins Download signed ActiveX controls Disable Enable Prompt Download unsigned ActiveX controls Disable Enable Prompt Initialize and script ActiveX controls not marked as safe Disable Enable Prompt Run ActiveX controls and plug-ins Reset custom settings Reset to: Medium Reset OK Cancel
  1. Refresh your web browser, then install the ActiveXcontrol. Follow the instructions to complete installation.

Vivotek Turret Dome IT9389-H - Using Web Browsers - 5

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\iexplore.exe
  • If you open a web session from the Shepherd utility, a 32-bit IE browser will be opened.

Vivotek Turret Dome IT9389-H - IMPORTANT: - 1

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.

Vivotek Turret Dome IT9389-H - Tips: - 1

text_image http://www.joinsmsn.com/

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.

Vivotek Turret Dome IT9389-H - Tips: - 2

text_image File Find Disable View Images Cache Tools Validate Browser Mode: IE9 Document Mode: IE9 standards HTML CSS Console Script Profiler Network Internet Explorer 7 Internet Explorer 8 ✓ Internet Explorer 9 Internet Explorer 9 Compatibility View

- In the event of plug-in compatibility issues, you may try to uninstall the plug-in that was previously installed.

Vivotek Turret Dome IT9389-H - Tips: - 3

text_image Business Explorer Camera Stream Controller Uninstall Catalyst Control Center

Using RTSP Players

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

Vivotek Turret Dome IT9389-H - Using RTSP Players - 1

VLC media 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 97.

For example:

Vivotek Turret Dome IT9389-H - VLC media player - 1

text_image VLC media play Media Playback Open Media File Disc Network Capture Device Playlist Media Library My Computer My Videos Network Protocol Please enter a network URL: #sv/192.168.51.63-55 Drive-1st.sh http://www.example.com/week.cn
  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 97 for details.

Vivotek Turret Dome IT9389-H - VLC media player - 2

natural_image River scene with multiple cars driving along a multi-lane road, city skyline in background (no visible text or symbols)

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

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

  2. As the bandwidth on 3G networks is limited, you will not be able to use a large video size. Please set the video streaming parameters as listed below.

For more information, please refer to Stream settings on page 77.

Video Mode H.264
Frame size 176 x 144
Maximum frame rate 5 fps
Intra frame period 1S
Video quality (Constant bit rate) 40kbps
  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 97.

  2. Launch the player on the 3GPP-compatible mobile devices (e.g., VLC player).

  3. Type the following URL commands into the player.

The address format is rtsp://:/.

For example:

Vivotek Turret Dome IT9389-H - Using 3GPP-compatible Mobile Devices - 1

text_image VLC media plot Media Playback Playlist Playlist Media Library My Computer My Videos My Music My Pictures Devices Discs Open Media File Disc Network Capture Device Network Protocol Please enter a network URL: http://197.168-5.144-52/0001.b3.c http://www.etsample.com/stream.ai/ http://61234 https://minto.examples.com/stream.ai/ http://www.etsample.org/8080boc.edu/ http://www.youybe.com/watch?vvgb/a Show more options Play Cancel

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

Using VIVOTEK Recording Software

Visit our website for download the VAST recording software that provides simultaneous monitoring and video recording for multiple Network Cameras. Please install the recording software; then launch the program to add the Network Camera to the Channel list. For detailed information about how to use the recording software, please refer to the user's manual of the software or download it from http://www.vivotek.com.

Vivotek Turret Dome IT9389-H - Using VIVOTEK Recording Software - 1

natural_image Overhead view of a modern, multi-level interior space with illuminated furniture and digital displays (no visible text or symbols)

Vivotek Turret Dome IT9389-H - Using VIVOTEK Recording Software - 2

Tips:

  1. If you encounter problems with displaying live view or the onscreen plug-in control, you may try to remove the plug-ins that might have been installed on your computer. Remove the following folder: C:\Program Files (x86)\Camera Stream Controller\
  2. If you forget the root (administrator) password for the camera, you can restore the camera defaults by pressing the reset button for longer than 5 seconds.
  3. If DHCP is enabled in your network, and the camera cannot be accessed, run the Shepherd utility to search the network. If the camera has been configured with fixed IP that does not comply with your local network, you may see its default IP 169.254.x.x. If you still cannot find the camera, you can restore the camera to its factory defaults.
  4. If you change your network parameters, e.g., added a connection to a LAN card, re-start the Shepherd utility.

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 Turret Dome IT9389-H - Main Page - 1

text_image VIVOTEK INC. Logo Camera Control Area Resize Buttons VIVOTEK IT9389-H-v2 Host Name Client settings Configuration Language Configuration Area Live View Window

Click this logo to visit the VIVOTEK website.

Host Name

The host name can be customized to fit your needs. The name can be changed especially there are many cameras in your surveillance deployment. For more information, please refer to System on page 50.

Camera Control Area

Profile mode: 4 pre-configured streaming profiles are provided through here: Max. view, Recording view, Live view, and App. Each mode features a different stream source (channel), resolution, multicast, and metadata configuration.

The profiles can be configured in Configuration > Media > Media profiles.

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

Configuration Area

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

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

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, 簡体 ^ID , and 繁體 ^ID . Please note that you can also change a language on the Configuration page; please refer to page 49.

Hide Button

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

Resize Buttons

Vivotek Turret Dome IT9389-H - Resize Buttons - 1

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 or H.265: H.265/264 Protocol and Media Options

Vivotek Turret Dome IT9389-H - Live Video Window - 1

text_image Video Title Title and Time Zoom Indicator x4.0 Video (TPC-AV) 2018/03/25 17:08:56 Time Video 17:08:56 2018/03/25 Video Control Buttons

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

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

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

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

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 settings on page 123 for detailed information. Global view and the PTZ panel are available with the 3rd or the last video profile.

Global View: Global view is available with the 3rd or the last video profile. 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 operationG, please refer to E-PTZ Operation on page 123. For more information about how to set up the viewing region of the current video stream, please refer to page 123.

Vivotek Turret Dome IT9389-H - Live Video Window - 2

text_image Global View: The viewing region of the curruent video stream The largest frame size Moving Instantly

Note that the PTZ buttons on the panel are not operational unless you are showing only a portion of the full image. If the live view window is displaying the full view, the PTZ buttons are not functional.

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

Vivotek Turret Dome IT9389-H - Live Video Window - 3

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

Vivotek Turret Dome IT9389-H - Live Video Window - 4

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

Vivotek Turret Dome IT9389-H - Live Video Window - 5

text_image Disable digital ptz Zoom Factor: 100% 100% 400%

Vivotek Turret Dome IT9389-H - Live Video Window - 6

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

Vivotek Turret Dome IT9389-H - Live Video Window - 7

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

Vivotek Turret Dome IT9389-H - Live Video Window - 8

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

Vivotek Turret Dome IT9389-H - Live Video Window - 9

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:

Vivotek Turret Dome IT9389-H - Live Video Window - 10

text_image Video Title Title and Time Video (HTTP-V) 2021/03/25 17:08:56 Time Video 17:08:56 2021/03/25 Go to Select one Video Control Buttons

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

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

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

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

Vivotek Turret Dome IT9389-H - Live Video Window - 11

text_image Disable digital ptz Zoom Factor: 100% 100% 400%

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 45 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.265/H.264 Protocol Options

H.265/H.264 protocol options

TCP

Vivotek Turret Dome IT9389-H - H.265/H.264 Protocol Options - 1

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

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.

MP4 Saving Options

MP4 saving options

Folder:

C:\Record

Browse.

File name prefix:

CLIP

Vivotek Turret Dome IT9389-H - MP4 Saving Options - 1

Add date and time suffix to file name

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 on your PC 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.

Vivotek Turret Dome IT9389-H - MP4 Saving Options - 2

text_image CLIP_20210321-180853 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS

Local Streaming Buffer Time

Local streaming buffer time

0

Millisecond

Save

In the case of encountering unsteady bandwidth, live streaming may lag and video streaming may not be very smoothly. If you enable this option, the live streaming will be stored temporarily on your PC's cache memory for a few milli seconds before being played on the live viewing window. 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 a joystick to a USB port on your management computer. Supported by the plug-in (Microsoft's DirectX), once the plug-in for the web console is loaded, it will automatically detect if there is any joystick on the computer. The joystick should work properly without installing any other driver or software.

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

  1. Select a detected joystick, if there are multiple, from the Selected joystick menu. If your joystick is not detected, if may be defective.

  2. Click Calibrate or Configure buttons to configure the joystick-related settings.

Vivotek Turret Dome IT9389-H - Enable Joystick - 1

text_image Joystick settings Selected joystick: Macally AirStick Calibrate Configure buttons Save

Vivotek Turret Dome IT9389-H - Enable Joystick - 2

NOTE:

  • If you want to assign Preset actions to your joystick, the preset locations should be configured in advance in the Configuration > PTZ page. In Windows, use the search function on the Start menu to search for Game Controller.
  • 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.

Vivotek Turret Dome IT9389-H - NOTE: - 1

text_image Game Controllers These settings help you configure the game controllers installed on your computer. Installed game controllers Controller Status CH PRODUCTS IP DESKTOP CONTROLLER OK Add... Remove Properties Advanced... Troubleshoot... OK

Buttons Configuration

In the Button Configuration window, the left column shows the actions you can assign, and the right column shows the functional buttons and assigned actions. The number of buttons may differ from different joysticks.

Please follow the steps below to configure your joystick buttons:

  1. Choosing one of the actions and click Assign will pop up a dialog. Then you can assign this action to a button by pressing the joystick button or select it from the drop-down list. For example: Assign Home (move to home position) to Button 1.

Vivotek Turret Dome IT9389-H - Buttons Configuration - 1

text_image Buttons Configuration Assigned Actions Actions Home Zoom In Zoom Out Focus Iris Pan Stop Patrol Preset Page Up Page Down Record to AVI Snapshot Auto Naming Assign Clear Selected Buttons Assigned Actions Button1 Button2 Button3 Button4 Button5 Button6 Button7 Button8 Button9 Button10 Button11 Button12 "Home" Press the joystick button to assign to "Home" or select the button from the list below. Button1 Button2 Button3 Button4 Button5 Button6 Button7 Button8 Button9 Button10 Button11 Button12 OK Cancel OK Cancel
  1. Click OK to confirm the configuration.

Vivotek Turret Dome IT9389-H - Buttons Configuration - 2

text_image Buttons Configuration Assigned Actions Actions Home Zoom In Zoom Out Focus Iris Pan Stop Patrol Preset Preset1 Preset2 Preset3 Preset4 Preset5 "Home" Press the joystick button to assign to "Home" or select the button from the list below. Button1 Click "Ok" to assign "" to button1 OK Cancel Assign Clear Selected OK Cancel

Buttons Configuration

Click the Configure Buttons button, a window will prompt as shown below. Please follow the steps below to configure your joystick buttons:

  1. Select a button number from the Button # pull-down menu.

Vivotek Turret Dome IT9389-H - Buttons Configuration - 1

text_image >Joystick Settings Actions: Toggle play/pause Button: 1 1 2 3 4 5 6 7 8 9 10 11 12 Assigned Actions Full Screen Stop Zoom in Patrol Toggle play/pause Snapshot Assign Delete OK 網際網路 | 受保議模式: 關閉 100%

Vivotek Turret Dome IT9389-H - Buttons Configuration - 2

Tips:

If you are not sure of the locations of each button, use the Properties window in the Game Controllers utility.

Vivotek Turret Dome IT9389-H - Tips: - 1

text_image Game Controls These settings help you configure the game controllers installed on your computer. Installed game controllers Controller MacMy AirStock Status OK Add... Remove Properties Advanced... Defaulted... OK Your Air Stock properties Settings Test Test the game controller. If the controller is not functioning proprieze it may need to be calibrated. To calculate it, go to the Settings page. Axes: X Axis / Y Axis Std. Buttons 1 2 3 4 5 6 7 8 3 4 5 6 7 8 Point of View Path OK Cancel +/-
  1. Select a corresponding action, such as Patrol or Preset#.
  2. Click the Assign button to assign an action to the button. You can delete an association by selecting a button number, and then click the Delete button.

Repeat the process until you are done with the configuration of all preferred actions.

The buttons you define should appear on the button list accordingly.

  1. Please remember to click the Save button on the Client settings page to preserver your settings.

Vivotek Turret Dome IT9389-H - Tips: - 2

text_image >Joystick Settings Actions: Toggle play/pause Toggle play/pause Stop streaming Snapshot Full Screen Start/stop recording Pan Patrol 1 Stop 2 Zoom in Zoom out 3 Digital output on/off 1 4 Digital output on/off 2 Digital output on/off 3 Digital output on/off 4 6 Manual trigger on/off 1 Manual trigger on/off 2 Manual trigger on/off 3 8 Preset 1 9 Preset 2 9 Preset 3 10 Preset 4 11 Preset 5 12 Preset 6 12 Preset 7 12 Preset 8 12 Preset 9 12 Preset 10 12 Preset 11 12 Preset 12 12 Preset 13 Param Assign Delete OK 網際網 100%

Configuration

Click Configuration on the main page to enter the camera setting pages. Note that only Administrators can access the configuration page.

VIVOTEK provides an easy-to-use user interface that helps you set up your network camera with minimal effort. In order to simplify the user interface, detailed information will be hidden unless you click on the function item. When you click on the first sub-item, the detailed information for the first sub-item will be displayed; when you click on the second sub-item, the detailed information for the second sub-item will be displayed and that of the first sub-item will be hidden.

The following is the interface of the main page:

Vivotek Turret Dome IT9389-H - Configuration - 1

text_image VIVOTEK 6.0 VIVOTEK.com Home Client settings Configuration Language System > General settings System General settings Homepage layout Logs Parameters Maintenance Media Network Security PTZ Event Applications Recording Storage System Host name: Mega-Pixel Network Camera Turn off the LED indicator Navigation Area 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 Configuration List Save Version: 0100s Firmware Version

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

The Navigation Area provides access to all different views from the Home 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. When finished with the settings on this page, click Save at the bottom of the page to enable the settings.

System

System

Host name:

Mega-Pixel Network Camera

Vivotek Turret Dome IT9389-H - System - 1

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, and also on the view cells of the ST7501 and VAST management software.

Turn off the LED indicators: If you do not want others to notice the network camera is in operation, you can select this option to turn off the LED indicators.

System time

Vivotek Turret Dome IT9389-H - System time - 1

text_image System time Time zone: GMT+08:00 Beijing, Chongqing, Hong Kong, Kuala Lumpur, Singapore, Taipei, Irkutsk Keep current date and time Synchronize with computer time Manual Automatic NTP server: pool.ntp.org Updating interval: One hour 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. The precondition is that the camera must have the access to the Internet.

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

Time zone : Select the appropriate time zone from the list. You can scroll down on the Time zone menu to find the Customize option and use the POSIX TZ variables. For example, http://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html.

Vivotek Turret Dome IT9389-H - System time - 2

text_image Time zone: Customize POSIX TZ: WGT3 Enable daylight saving time Starting time: Not Support Ending time: Not Support

Here are some examples for TZ values, including the appropriate Daylight Saving Time and its dates of applicability. In North American Eastern Standard Time (EST) and Eastern Daylight Time (EDT), the normal offset from UTC is 5 hours; since this is west of the prime meridian, the sign is positive. Summer time begins on March's second Sunday at 2:00am, and ends on November's first Sunday at 2:00am. EST+5EDT,M3.2.0/2,M11.1.0/2

Israel Standard Time (IST) and Israel Daylight Time (IDT) are 2 hours ahead of the prime meridian in winter, springing forward an hour on March's fourth Thursday (i.e., on the first Friday on or after March 23), and falling back on October's last Sunday.

IST-2IDT,M3.4.4,M10.5.0

Western Argentina Summer Time (WARST) is 3 hours behind the prime meridian all year. There is a dummy fall-back transition on December 31 at 25:00 daylight saving time (i.e., 24:00 standard time, equivalent to January 1 at 00:00 standard time), and a simultaneous spring-forward transition on January 1 at 00:00 standard time, so daylight saving time is in effect all year and the initial WART is a placeholder.

The format is TZ = local_timezone, date/time, date/time.

Here, date is in the Mm.n.d format, where:

Mm (1-12) for 12 months

n (1-5) 1 for the first week and 5 for the last week in the month

d (0-6) 0 for Sunday and 6 for Saturday

CST6CDT is the name of the time zone

CST is the abbreviation used when DST is off

6 hours is the time difference from GMT

CDT is the abbreviation used when DST is on

,M3 is the third month

.2 is the second occurrence of the day in the month

.0 is Sunday

/2 is the time

,M11 is the eleventh month

.1 is the first occurrence of the day in the month

.0 is Sunday

/2 is the time

The minimum specifier is down to the hour.

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:

Vivotek Turret Dome IT9389-H - General settings - 1

text_image General settings Theme options VIVOTEK www.vivotek.com profile_name: Pro! Manual triggers: Digital output: On Off Powered by VIVOTEK Mega-Pixel Network Hide Powered by VIVOTEK

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

Vivotek Turret Dome IT9389-H - Logo graph - 1

text_image Logo graph A customized logo (Gif, JPG or PNG) can be uploaded for main page. It will be resized to 160x50 pixels to replace the previous logo. Default Custom VIVOTEK www.vivotek.com Browse... Upload Logo link: http://www.vivotek.com

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.

Vivotek Turret Dome IT9389-H - Customized button - 1

text_image Customized button ✓ Show manual trigger 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.

Vivotek Turret Dome IT9389-H - Theme Options - 1

text_image General settings Theme options VIVOTEK www.vivotek.com Mega-Pixel Network Font Color of the Video Title profile_name: Pro Manual triggers: Digital output: On Off Font Color Background Color of the Control Area Font Color of the Configuration Area Background Color of the Configuration Area Powered by VIVOTEK Background Color of the Video Area Frame Color Preset patterns Themes Custom Color Font color: #000000 Font color of video title: #098BD5 Bk color of control area: #C4EAFF Bk color of configuration area: #0186D1 Bk color of video area: #C4EAFF Frame color: #0186D1 Save

Vivotek Turret Dome IT9389-H - Theme Options - 2

text_image General settings Theme options VIVOTEK www.vivotek.com Mega-Pixel Network Video stream 1 Manual triggers: Digital output: On Off Powered by VIVOTEK General settings Theme options VIVOTEK www.vivOTEK.com Video stream 1 Manual triggers: Digital output: On Off Powered by VIVOTEK Mega-Pixel Network

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

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

Vivotek Turret Dome IT9389-H - Theme Options - 3

text_image Themes Custom Pattern Color Font color: Font color of configuration area: #FFFFFF Font color of video title: #098BD6 Bk color of control area: #565656 Bk color of configuration area: #323232 Bk color of video area: #565656 Frame color: #323232 Color Selector
  1. The palette window will pop up as shown below.

Vivotek Turret Dome IT9389-H - Theme Options - 4

text_image Hex: #000000 Red: 0 Green: 0 Blue: 0 Hue: 0 Saturation: 0 Value: 0 Select

Vivotek Turret Dome IT9389-H - Theme Options - 5

text_image Hex: #23538A Red: 35 Green: 83 Blue: 138 Hue: 212 Saturation: 74.6 Value: 54.1 4 Select
  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

Vivotek Turret Dome IT9389-H - Log server settings - 1

text_image Log server settings Enable remote log IP address: port: 514 Save

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

Vivotek Turret Dome IT9389-H - Log server settings - 2

text_image 06-27-2011 17:08.48 Syling Info 192.168.4.103 cplogd 1.5.9 Event 06-27-2011 17:06.57 UsnInfo 192.168.4.103 [RISP SERVER] Stop one session, IP=192.168.4.101 06-27-2011 17:06.57 UsnInfo 192.168.4.103 last message repeated 2 bytes 06-27-2011 17:06.13 UsnInfo 192.168.4.103 [RISP SERVER] Start one session, IP=192.168.4.101 06-27-2011 17:06.12 UsnEuro 192.168.4.103 [RISP SERVER] on/session_reg_function c-700_3MSPServer_ReadAll File /Area/Sessioninfo failedTM 06-27-2011 17:06.12 UsnInfo 192.168.4.103 [RISP SERVER] XMLSpacer: jack after document element at line 6TM 06-27-2011 17:06.12 UsnInfo 192.168.4.103 [RISP SERVER] Stop one session, IP=192.168.4.101 06-27-2011 17:06.12 UsnInfo 192.168.4.103 [RISP SERVER] Stop one session, IP=192.168.4.101 06-27-2011 17:06.18 UsnNotice 192.168.4.103 [SNPP DEVICES] Process end 06-27-2011 17:06.08 UsnNotice 192.168.4.103 [DSIM Service] Starting DMM service 06-27-2011 17:06.07 UsnInfo 192.168.4.103 [watchdog] Ready to match httpd 06-27-2011 17:06.06 Daemon notice 192.168.4.103 ushcpc: dirx 192.168.8.10 192.168.0.20 06-27-2011 17:06.06 Daemon Notice 192.168.4.103 ushcpc: sender 192.168.4.1 06-27-2011 17:06.05 Daemon Notice 192.168.4.103 ushcpc: IP 192.168.4.103 network 255.255.255.0 06-27-2011 17:06.03 Usn Waiting 192.168.4.103 [EVENT MSG] the process of event B1 is stopped because of low priority 0 06-27-2011 17:06.01 Daemon Notice 192.168.4.103 ushcpc: sender 192.168.4.1 06-27-2011 17:06.00 Daemon Notice 192.168.4.103 ushcpc: IP 192.168.4.103 network 255.255.255.0 06-27-2011 17:06.00 Daemon Notice 192.168.4.103 ushcpc: descending

System log

Vivotek Turret Dome IT9389-H - System log - 1

text_image System log Access log Set parameter log VADP log Jul 10 10:43:17 syslogd 1.5.0: restart. Jul 10 10:43:18 [VENC]: Fixed-Iris! Jul 10 10:43:19 MOD: [System_ShmemInit] 3 sectors detected Jul 10 10:43:19 MOD: [System_Init] MOD (1.0.5.11) initialized Jul 10 10:43:20 [VENC]: Failed to open /etc/conf.d/image_cfgs/c0/ISP/ISP_GTR_1P.cfg Jul 10 10:43:20[swatchdog]: Ready to watch httpd. Jul 10 10:43:21[swatchdog]: Ready to watch recorder. Jul 10 10:43:22[swatchdog]: Ready to watch websocketserver. Jul 10 10:43:22 MOD: [control_end] unrecognized value freeslot, bracket output Jul 10 10:43:22 MOD: [System_ProcessInput] Generic error Jul 10 10:43:22 MOD: [control_end] unrecognized value freeslot, bracket output Jul 10 10:43:22 MOD: [System_ProcessInput] Generic error Jul 10 10:43:22 MOD: [control_end] unrecognized value freeslot, bracket output Jul 10 10:43:22 MOD: [System_ProcessInput] Generic error Jul 10 10:43:22 MOD: [control_end] unrecognized value freeslot, bracket output Jul 10 10:43:22 MOD: [System_ProcessInput] Generic error Jul 10 10:43:22 MOD: [control_end] unrecognized value freeslot, bracket output Jul 10 10:43:22 MOD[ System _ProcessInput ] Generic error Jul 10 10:43:22 MOD: [control_end] unrecognized value freeslot, bracket output Jul 10 10:43:22 MOD: [System _ProcessInput ] Generic error Jul 10 10:43:22 MOD: [control_end] unrecognized value freeslot, bracket output Jul 10 10:43:22 MOD: [System _ProcessInput ] Generic error Jul 10 10:43:22[VENC]: Day mode Jul 10 10:43:22[swatchdog]: Ready to watch vencslave3. Jul 10 10:43:22[swatchdog]: Ready to watch rtsp.

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.

You can install the included VAST recording software, which provides an Event Management function group for delivering event messages via emails, GSM short messages, onscreen event panel, or to trigger an alarm, etc. For more information, refer to the VAST User Manual.

Vivotek Turret Dome IT9389-H - System log - 2

flowchart
graph TD
    A["VIVOTEK Network Cameras"] --> B["Internet"]
    C["3G Cell phone"] --> B
    D["Cell phone Short message"] --> E["Modem"]
    F["Digital output"] --> G["Deterrent"]
    H["PTZ"] --> I["Server with VAST Recording Software"]
    J["VIVOCloud"] --> K["EmailGSM"]
    L["FTP"] --> M["Data Port"]
    N["HTTP"] --> B
    O["3G Phone"] --> B

Access log

Vivotek Turret Dome IT9389-H - Access log - 1

text_image System log Access log Set parameter log VADP 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.

Set Parameter log

VADP log contains the history of changes made to system parameters such as recording, imaging parameters, and all other parameters.

VADP log

VADP log contains the information for the onboard VADP packages, including memory usage, module load and unload information.

Vivotek Turret Dome IT9389-H - VADP log - 1

text_image Jan 14 20:22:30 [VADP]: Jan 14 20:22:30 [VADP]: File system disk space usage Jan 14 20:22:30 [VADP]: Filesystem Size Used Available Use% Mounted on Jan 14 20:22:30 [VADP]: ubi1:flashfs2 32.3M 4.2M 26.4M 14% /mnt/flash2 Jan 14 20:22:30 [VADP]: ********************** Jan 14 20:22:30 [VADP]: Start to upgrade preload package Jan 14 20:22:30 [VADP]: ********************** Jan 14 20:22:30 [VADP]: Preload package Size: 3.2M Jan 14 20:22:32 [VADP]: Untar package Size: 6.9M Jan 14 20:22:32 [VADP]: Trend Micro IoT Security Preload Package Version: 1.1b.a1.7.5 Jan 14 20:22:41 [VADP]: Update configuration... Jan 14 20:22:42 [VADP]: Jan 14 20:22:42 [VADP]: Trend Micro IoT Security is stopped Jan 14 20:22:43 [VADP]: File system disk space usage Jan 14 20:22:43 [VADP]: Upgrade Filesystem Size Used Available Use% Mounted on Jan 14 20:22:43 [VADP]: Before ubi1:flashfs2 32.3M 1.1M 29.5M 3% /mnt/flash2 Jan 14 20:22:43 [VADP]: After ubi1:flashfs2 32.3M 6.0M 24.6M 20% /mnt/flash2 Jan 14 20:22:43 [VADP]: File space usage: Jan 14 20:22:43 [VADP]: Upgrade Size Path Jan 14 20:22:43 [VADP]: Before 0 Jan 14 20:22:43 [VADP]: After 6.9M /mnt/flash2/vadp/0 Jan 14 20:22:43 [VADP]: Upgrade preload Trend Micro IoT Security package successfully Jan 14 20:22:43 [VADP]: Jan 14 20:22:43 [VADP]: Preload package Size: 1.0M Jan 14 20:22:43 [VADP]: Untar package Size: 2.3M Jan 14 20:22:44 [VADP]: Stratocast Preload Package Version: 1.1b.a1.4.2 Jan 14 20:22:50 [VADP]: Update configuration... Jan 14 20:22:57 [VADP]: Jan 14 20:22:57 [VADP]: File system disk space usage Jan 14 20:22:58 [VADP]: Upgrade Filesystem Size Used Available Use% Mounted on Jan 14 20:22:58 [VADP]: Before ubi1:flashfs2 32.3M 5.0M 25.6M 16% /mnt/flash2 Jan 14 20:22:58 [VADP]: After ubi1:flashfs2 32.3M 6.5M 24.0M 21% /mnt/flash2 Jan 14 20:22:58 [VADP]: File space usage: Jan 14 20:22:58 [VADP]: Upgrade Size Path Jan 14 20:22:58 [VADP]: Before 0 Jan 14 20:22:58 [VADP]: After 2.3M /mnt/flash2/vadp/1 Jan 14 20:22:58 [VADP]: Upgrade preload Stratocast package successfully Jan 14 20:22:58 [VADP]: Jan 14 20:22:58 [VADP]: *********************** Jan 14 20:22:58 [VADP]: Upgrade preload package end Jan 14 20:22:58 [VADP]: *********************** Jan 14 20:22:58 [VADP]: File system disk space usage Jan 14 20:22:58 [VADP]: Filesystem Size Used Available Use% Mounted on Jan 14 20:22:58 IVADI: ubi1:flashfs2 32.3M 6.5M

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='IT9389-H-v2'
system_ledoff='0'
system_lowlight='1'
system_date='2000/01/04'
system_time='07:10:08'
system_datetime=''
system_ntp Alexandria
system_daylight_enable='0'
system_daylight_auto_begintime='Not Support'
system_daylight_auto_endtime='Not Support'
system_daylight_timezones='-360,-320,-280,-240,-241,-200,-140,-121,-40,0,40,41,80,82,83,140,380,480'
system_updateinterval='0'
system_info_modelname='IT9389-H-v2'
system_info_extendedmodelname='IT9389-H-v2'
system_info_serialnumber='02AC25557B68'
system_info_firmwareversion='IT9389_v2-VVTK-1.2102.33.01f'
system_info_language_count='10'
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_info_language_i10='
system_info_language_i11=' 

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 locate the firmware file.
  3. Click Upgrade. The Network Camera starts to upgrade and will reboot automatically when the upgrade completes.

If the upgrade is successful, you will see "Reboot system now!! This connection will close". After that, 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.

[Non-Text]

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

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.

Focus position: Retain the lens focus position using the previously saved position parameters.

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

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.

Vivotek Turret Dome IT9389-H - General settings &gt; Restore - 1

Import/Export files

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

General settings

Import/Export files

Export files

Export language file

Export configuration file

Export server status report

Export

Export

Export

Upload files

Update custom language file:

Upload configuration file:

Browse.

Upload

Browse.

Upload

Browse.

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

Vivotek Turret Dome IT9389-H - Import/Export files - 1

text_image Microsoft Internet Explorer The file must have a .xml filename suffix. OK

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.

Vivotek Turret Dome IT9389-H - Import/Export files - 2

Tips:

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

Applicable scenario:

(a) Power disconnected during firmware upgrade.
(b) 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:

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

Media > Image

This section explains how to configure the image settings of the Network Camera. It is composed of the following columns: General settings, IR control, Image settings, Exposure, Focus, and Privacy mask. The Focus window is available only for models that come with motorized lens.

General settings

Vivotek Turret Dome IT9389-H - General settings - 1

text_image General settings Illuminators Image settings Exposure Privacy mask Pixel calculator Video settings Video title Show timestamp and video title in video and snapshots Position of timestamp and video title on image: Top Timestamp and video title font-size: 30 Video font (.ttf): Default Upload Color: B/W Color Power line frequency: 50 Hz 60 Hz Video orientation: Flip Mirror Rotate

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. A zoom indicator will be displayed on the Home page when you zoom in/out on the live viewing window as shown below. You may zoom in/out on the image by scrolling the mouse wheel inside the live viewing window, and the maximum zoom in will be up to 12 times.

Vivotek Turret Dome IT9389-H - Video title - 1

text_image Video Title Title and Time Video TCP-AV 2018/7/09 17:08:56 Video 17:06:56 2018/7/09 Zoom In Zoom Out Zoom Factor X2.1

Position of timestamp and video title on image: Select to display time stamp and video title on the top or at the bottom of the video stream.

Timestamp and video title font size: Select the font size for the time stamp and title.

Video font (.ttf): You can select a True Type font file for the display of textual messages on video.

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

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

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

Rotate -

Vivotek Turret Dome IT9389-H - Rotate - - 1

Rotate

Vivotek Turret Dome IT9389-H - Rotate - - 2

Degrees

The rotation here indicates clockwise rotation. Rotation can be applied with flip, mirror, and physical lens rotation (see below) settings to adapt to different mounting locations.

The figures in the illustration are shown in a consecutive order.

Vivotek Turret Dome IT9389-H - Rotate - - 3

flowchart
graph TD
    A["House"] --> B["Downward Arrow"]
    B --> C["Box Box"]
    C --> D["Box Box"]
    D --> E["Box Box"]
    E --> F["Box Box"]
    F --> G["Box Box"]
    G --> H["Box Box"]
    H --> I["Box Box"]
    I --> J["Box Box"]
    J --> K["Box Box"]
    K --> L["Box Box"]
    L --> M["Box Box"]
    M --> N["Box Box"]
    N --> O["Box Box"]
    O --> P["Box Box"]
    P --> Q["Box Box"]
    Q --> R["Box Box"]
    R --> S["Box Box"]
    S --> T["Box Box"]
    T --> U["Box Box"]
    U --> V["Box Box"]
    V --> W["Box Box"]
    W --> X["Box Box"]
    X --> Y["Box Box"]
    Y --> Z["Box Box"]

The camera may be installed on a vertical, side-facing, or tilted surface in order to accommodate the interior or exterior design of a building. The interior of a building can be shaped as a narrow rectangular space, such as a corridor. The conventional HD image, such as that of a 16:9 aspect ratio, will be incongruous with its wide horizontal view. With video rotation, the camera can more readily cover the field of view on a tall and narrow scene.

Day/Night Settings

Day/Night settings

Switch to BW in night mode

IR cut filter:

Light sensor sensitivity:

Vivotek Turret Dome IT9389-H - Day/Night Settings - 1

Vivotek Turret Dome IT9389-H - Day/Night Settings - 2

Save

Switch to B/W in night mode

Select this to enable the Network Camera to automatically switch to Black/White during night mode.

IR cut filter

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

■ Auto mode (The Day/Night Exposure Profile will not be available if Auto mode is selected) 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

If an external IR device is connected that comes with its own light sensor, you can use a digital input from it to trigger the IR cut filter. Doing so can synchronize the detection of light level between the camera and the external IR device.

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

Sensitivity of IR cut filter

Tune the responsiveness of the IR filter to lighting conditions as Low, Normal, or High.

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

Illuminators

Turn on built-in IR illuminator in night mode

Select this to turn on the camera's onboard IR illuminator when the camera detects low light condition and enters the night mode.

Smart IR

Anti-overexposure: When enabled, the camera automatically adjusts the IR projection to adjacent objects in order to avoid over-exposure in the night mode.

The Smart IR function is more beneficial when the spot of intrusions or an object of your interest is close to the lens and the IR lights. For example, if an intruder has a chance of getting near the range of 3 meters, Smart IR can effectively reduce the over-exposure. For a surveillance area at a greater distance, e.g., 5 meters or farther away, the Smart IR function may not bring as significant benefits as in close range.

Smart IR disabled; distance: 5M

Vivotek Turret Dome IT9389-H - Smart IR - 1

natural_image Black-and-white photo of a person standing in a long, empty corridor with curtains and draped drapes (no visible text or symbols)

Smart IR disabled; distance: 3M

Vivotek Turret Dome IT9389-H - Smart IR - 2

natural_image Black-and-white photo of a person standing in a dimly lit corridor with curtains and a fan (no visible text or symbols)

Smart IR enabled; distance: 5M

Vivotek Turret Dome IT9389-H - Smart IR - 3

natural_image Black-and-white photo of a person standing in a dimly lit corridor with curtains and curtains (no visible text or symbols)

Smart IR enabled; distance: 3M

Vivotek Turret Dome IT9389-H - Smart IR - 4

natural_image Person standing in a dimly lit corridor with curtains, no visible text or symbols

Vivotek Turret Dome IT9389-H - Smart IR - 5

Tips:

If there is an object in close proximity, the IR lights reflected back from it can mislead the Smart IR's calculation of light level. To solve this problem, you can place an "Exposure Exclude" window on an unavoidable object in the Exposure setting window. See page 71 for how to do it.

You can also configure the "Exposure Exclude window in a night mode "Profile" setting so that your day time setting is not affected.

Vivotek Turret Dome IT9389-H - Tips: - 1

text_image General settings Illuminators Image settings Exposure Privacy mask Exclude Add inclusive window Add exclusive window Normal light mode Profile mode Enable to apply these settings at Night mode Schedule mode Exposure strategy Measurement window: Full view Custom BLC HLC Exposure control Exposure level 0

Vivotek Turret Dome IT9389-H - Tips: - 2

natural_image Interior hallway with a person in protective suit walking past, computer monitor visible on desk, and downward arrow pointing to bottom (no text or symbols)

Vivotek Turret Dome IT9389-H - Tips: - 3

text_image ExcludeX

Image settings

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

Vivotek Turret Dome IT9389-H - Image settings - 1

text_image General settings Illuminators Image settings Exposure Privacy mask Pixel calculator 0.100% Sensor Setting 2: For special situations Sensor Setting 1: For normal situations Normal light mode Profile mode White balance Auto Image adjustment Brightness: 50% Contrast: 50% Saturation: 50% Sharpness: 50% Gamma curve: Optimize Defon

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

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

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

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

Image Adjustment

■ Brightness: Adjust the image brightness level, which ranges from 0% to 100%.
■ Contrast: Adjust the image contrast level, which ranges from 0% to 100%.
■ Saturation: Adjust the image saturation level, which ranges from 0% to 100%.
■ Sharpness: Adjust the image sharpness level, which ranges from 0% to 100%.

■ Gamma curve: Adjust the image sharpness level, which ranges from 0.45 to 1, from Detailed to Contrast. You may let firmware Optimize your display or select the Manual mode, and pull the slide bar pointer to change the preferred level of Gamma correction towards higher contrast or towards the higher luminance for detailed expression for both dark and lighted areas of an image.

This option is disabled when the WDR feature is enabled.

Defog: Defog helps improve the visibility quality of captured image in poor weather conditions such as smog, fog, or smoke.

Noise reduction

■ Enable noise reduction: Check to enable noise reduction in order to reduce noises and flickers in image. This applies to the onboard 3D Noise Reduction feature. Use the slide bar 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 mode to adjust all settings above in a tabbed window for special lighting conditions.

Vivotek Turret Dome IT9389-H - Noise reduction - 1

text_image Normal light mode Profile mode ✓ Enable to apply these settings at ● Night mode ○ Schedule mode

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

Enable digital image stabilizer

If you experience problems such as vibration occurs when on a pole mount, try enable the image stabilizer.

Scene mode: deblur

■ When enabled, shutter time will be fixed to 1/120 second to reduce image smear. This feature is designed to apply with human movement at the pace of 1.4\~2.2m/s. The deblur function is related to Motion detection where motion-alerted pixels need to be suppressed in order to increase the accuracy of motion detection. In certain conditions, shadows or light changes can all cause false alarms in motion detection.

The deblur function uses the same detection window as that of the Motion detection.

Exposure

On this page, you can set the Exposure measurement window, Exposure level, Exposure mode, Exposure time, Gain control, and Day/Night mode settings. You can configure two sets of Exposure settings: one for normal situations, the other for special situations, such as the day/night/schedule mode.

Vivotek Turret Dome IT9389-H - Exposure - 1

text_image General settings Illuminators Image settings Exposure Privacy mask Pixel calculator 3.000 3.10m Sensor Setting 2: For special situations Normal light mode Profile mode Select auto mode will disable profile of exposure settings. Exposure strategy Measurement window: Full view Custom Center Metering mode: Auto BLC HLC Exposure control Exposure level: 0 Flickerless Exposure time: 1/32000 - 1/30 Restore Save Sensor Setting 1: For normal situations

Exposure strategy:

Measurement window: This function allows users to set measurement window(s) for low light compensation. For example, where low-light objects are posed against an extremely bright background. You may want to exclude the bright sunlight shining through a building's corridor.

■ Full view: Calculate the full range of view and offer appropriate light compensation.
■ Custom: This option allows you to manually add customized windows as inclusive or exclusive regions. A total of 10 windows can be configured. Please refer to the next page for detailed illustration.
■ Auto: Firmware automatically determines an optimal exposure level.

The inclusive window refers to the “weighted window”; the exclusive window refers to “ignored window”. It adopts the weighted averages method to calculate the value. The inclusive windows have a higher priority. You can overlap these windows, and, if you place an exclusive window within a larger inclusive window, the exclusive part of the overlapped windows will be deducted from the inclusive window. An exposure value will then be calculated out of the remaining of the inclusive window.

Vivotek Turret Dome IT9389-H - Exposure strategy: - 1

text_image Fisheye (TCP-V) 2012/7/2 09:57:04 Include Exclude Include Exclude Weighted region Ignored region Add inclusive window Add exclusive window Measurement window Full view Custom BLC

■ Center: Use the center portion of the screen to determine the exposure level.

Metering mode:

■ Auto: Lets firmware automatically detect the exposure measurement.
■ BLC (Back Light Compensation): This option will automatically add a “weighted region” in the middle of the window and give the necessary light compensation.
■ HLC: (Highlight Compensation). Firmware detects strong light sources and compensates on affected spots to enhance the overall image quality. For example, the HLC helps reduce the glares produced by spotlights or headlights.

Exposure control:

■ Exposure level: You can manually set the Exposure level, which ranges from -2.0 to +2.0 (dark to bright). You can click and drag the semi-circular pointers on the Exposure time and Gain control slide bars to specify a range of shutter time and Gain control values within which the camera can automatically tune to an optimal imaging result. You may prefer a shorter shutter time to better capture moving objects, while a faster shutter reduces light and needs to be compensated by electrical brightness gains.
■ Exposure mode: (available when WDR is disabled)

You can click and drag the semi-circular pointers on the Exposure time and Gain control slide bars to specify a range of shutter time and Gain control values within which the camera can automatically tune to an optimal imaging result. You can also configure the iris size to control the amount of light. For example, you may prefer a shorter shutter time to better capture moving objects, while a faster shutter reduces light and needs to be compensated by electrical brightness gains.

■ Flickerless: Under some circumstances when there is a difference between the video capture frequency and local AC power frequency (NTSC or PAL), the mismatch causes color shifts or flickering images. If the above mismatch occurs, select the Flickerless checkbox, and the range of Exposure time (the shutter time) will be limited to a range in order to match the AC power frequency. When selected, the exposure time will be forced to stay longer than 1/120 second. For cameras that come with fixed iris lens, setting the exposure time to longer than 1/120 second may introduce too much lights to the lens. Users can use this option to observe whether the result of long exposure time is satisfactory.
■ AE Speed Adjustment:

This function applies when you need to monitor fast changing lighting conditions. For example, the camera may need to monitor a highway lane or entrance of a parking area at night where cars passing by with their lights on can bring fast changes in light levels. The same applies if the camera is installed on a vehicle, and when it needs to adapt to fast changes of light when entering and leaving a tunnel.

■ WDR Pro:

This refers to the Wide Dynamic Range function that enables the camera to capture details in a high contrast environment. Use the checkbox to enable the function, and use the slide bar to select the strength of the WDR Pro functionality, depending on the lighting condition at the installation site. You can select a higher effect when the contrast is high (between the shaded area and the light behind the objects).

Enable WDR enhanced: This function allows users to identify more image details with an extreme contrast from an object of interest with one shadowed side against a bright background, e.g., an entrance. You may select the Enable WDR enhanced checkbox, and then adjust the strength (low, medium, high) to reach the best image quality.

For high dynamic scene, we suggest selecting "HLC" or metering method and configure WDR enhanced to high strength for better image visibility.

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 set up a profile:

  1. Select the Profile mode tab.
  2. Select the applicable mode: Night mode or Schedule mode. Please manually enter a range of time if you choose the 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.

Vivotek Turret Dome IT9389-H - Exposure control: - 1

text_image General settings Illuminators Image settings Exposure Privacy mask Pixel calculator Normal light mode Profile mode Enable to apply these settings at: Exposure strategy Measurement window: Full view Custom Center Metering mode: Auto BLC HLC Exposure control Exposure level: 0 Flickerless Exposure time: 1/32000 - 1:30 Restore Save

Privacy mask

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

Vivotek Turret Dome IT9389-H - Privacy mask - 1

text_image General Settings Illuminators Image settings Exposure Privacy mask Pixel calculator Enable privacy mask Window name New Save New Save 4x

■ To configure privacy mask windows,

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

Vivotek Turret Dome IT9389-H - Privacy mask - 2

NOTE:

▶ Up to 5 privacy mask windows can be configured on the same screen.
▶ If you want to delete the privacy mask window, please click the 'x' mark on the side of window name.

Pixel Calculator

Click the Add button at the lower screen to create a pixel calculator window. Place your cursor on the window to move it to an area of your interest, and change the size of window to fit the area of interest.

Once they are drawn, the numbers of pixels on the sides of windows will appear. This allows you to calculate if your current configuration fulfills a requirement, for instance, for recognizing the faces of persons passing through a location. A facial recognition usually requires around 130 pixels per meter or higher.

Vivotek Turret Dome IT9389-H - Pixel Calculator - 1

text_image General settings Illuminators Image settings Exposure Privacy mask Pixel calculator E Add E 100% Fisheye(TCP-V) 2015/1/23 16:31:57:00 1 X 2 X Add Pixel Counter Window1 (H)x(V) Window2 (H)x(V) Stream1: 551x373 Stream2: 55x37 Stream3: 551x373 Stream1: 555x370 Stream2: 55x37 Stream3: 555x370

The pixels thus calculated are listed at the lower screen on a per-stream basis depending on the frame size you configured for each video stream.

Media > Video

Mode

Mode

Stream

5-Megapixel (4:3) (MAX 30fps)(WDR Pro)
○ 4-Megapixel (16:9) (MAX 30fps)(WDR Pro)
○ 1080P FULL HD (16:9) (MAX 60fps)

The applicable video modes include:

■ 5-Megapixel (4:3)(MAX 30fps) (WDR Pro): This is the full resolution at 5 megapixels in a 4:3 screen aspect, with the WDR function enabled.
■ 4-Megapixel (16:9)(MAX 30fps) (WDR Pro): At the 16:9 aspect ratio, the highest frame rate can reach 30fps, with the WDR function.
■ 1080P FULL HD (16:9) (MAX 60fps): At the 16:9 aspect ratio, the highest frame rate can reach 60fps, without the WDR function.

Media > Video

Stream settings

Mode Stream

Video settings for stream 1
Video settings for stream 2
Video settings for stream 3 Viewing Window

Save

This Network Camera supports multiple streams with frame sizes ranging from 480 x 272 to 2560x1920 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 1280 x 960.
■ Stream 3: The default frame size for Stream 2 is set to the 800 x 600.

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 a video stream. For example, you can crop only a portion of the image that is of your interest, and thus save the bandwidth needed to transmit the video stream. As the picture shown below, the area of your interest in a parking lot should be the vehicles. The blue sky is of little value for the surveillance purpose.

Vivotek Turret Dome IT9389-H - Mode Stream - 1

natural_image Large outdoor parking lot with rows of parked cars under a cloudy sky, inset shows a close-up of a car's side view (no visible text or symbols)

Vivotek Turret Dome IT9389-H - Mode Stream - 2

text_image Stream Viewing Window Video stream : stream2 Full view: 1920x1080 Region of interest : (0,0) 800x600 custom Save Close Note: Frame size will be changed to match region of interest.

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

Vivotek Turret Dome IT9389-H - Mode Stream - 3

NOTE: Video

▶ 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 2560 x 1920 ~ 640 x 480 (Fixed) 2560 x 1920 ~ 640 x 480 (Fixed)
Stream 2 2560 x 1920 ~ 640 x 480 (Fixed) 2560 x 1920 ~ 640 x 480 (Fixed)
Stream 3 2560 x 1920 ~ 640 x 480 (Selectable) 2560 x 1920 ~ 640 x 480 (Selectable)

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

Vivotek Turret Dome IT9389-H - NOTE: Video - 1

text_image IT9389-H-v2 Profile name: Line Manual triggers: PTZ control: Digital Pan speed: Tik speed: Zoom speed: Global view Region of Interest (Viewing Region) Move Instantly 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.

Vivotek Turret Dome IT9389-H - NOTE: Video - 2

text_image Mode Stream Video settings for stream 1 H.265 H.264 Resolution: 2560x1920 Maximum frame rate: 15 fps Intra frame period: 1 S Smart stream III Dynamic intra frame period ((help)) Smart FPS Smart codec: Mode: Auto tracking Quality priority: ((help)) Bit rate control Constrained bit rate: Target quality: Detailed Maximum bit rate: 8 Mbps Policy: Frame rate priority Smart Q: ON Fixed quality: MJPEG Video settings for stream 2 Video settings for stream 3 Viewing Window Save

This Network Camera provides real-time H.265, H.264 and MJPEG compression standards (Triple Codec) for real-time viewing. If the H.265 or H.264 mode is selected, the video is streamed via RTSP protocol. There are several parameters through which you can adjust the video performance:

Vivotek Turret Dome IT9389-H - NOTE: Video - 3

text_image H.265 Resolution: 2000x1900 Maximum frame rate: 15 fps Intra frame period: 1.5 Smart stream tb Dynamic intra frame period (theip) Smart FPS Smart codes: Mode: Auto tracking Quality priority: (theip) Bit rate control Constrained bit rate: Target quality: Detailed Maximum bit rate: 8 Mbps Policy: Frame rate priority Smart Q: ON Fixed quality:

■ Frame size

You can set up different video resolutions for different viewing devices. For example, you can configure 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, or recording the stream to an NVR. Note that a larger frame size takes up more bandwidth.

■ Maximum frame rate

This limits the maximum refresh frame rate per second. 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, 12fps, 15fps, and up to 25fps. If the power line frequency is set to 60Hz, the frame rates are selectable at 1fps, 2fps, 3fps, 5fps, 8fps, 10fps, 12fps, 15fps, and up to 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 for firmware to plant an I frame. The shorter the duration, the more likely you will get better video quality, but at the cost of higher network bandwidth consumption. Select the intra frame period from the following durations: 1/4 second, 1/2 second, 1 second, 2 seconds, 3 seconds, and 4 seconds.

■ Smart stream III

■ Dynamic Intra frame period

High quality motion codecs, such as H.265, utilize the redundancies between video frames to deliver video streams at a balance of quality and bit rate.

The encoding parameters are summarized and illustrated below. The I-frames are completely self-referential and they are largest in size. The P-frames are predicted frames. The encoder refers to the previous I- or P-frames for redundant image information.

Vivotek Turret Dome IT9389-H - ■ Maximum frame rate - 1

natural_image Abstract geometric pattern with alternating blue and white parallelograms (no text or symbols)

H.264/265 Frame Types
PIPPPPPPPIPPPPPPPI

By dynamically prolonging the intervals for I-frames insertion to up to 10 seconds, the bit rates required for streaming a video can be tremendously reduced. When streaming a video of a static scene, the Dynamic Intra frame feature can save up to 53% of bandwidth. The amount of bandwidth thus saved is also determined by the activities in the field of view. If activities occur in the scene, firmware automatically shortens the I-frame insertion intervals in order to maintain image quality. In the low light or night conditions, the sizes of P-frames tend to be enlarged due to the noises, and hence the bandwidth saving effect is also reduced.

Streaming a typical 2MP scene normally requires 3\~4Mb/s of bandwidth. With the Dynamic Intra frame function, the bandwidth for streaming a medium-traffic scene can be reduced to 2\~3Mb/s, and during the no-traffic period of time, down to 500kb/s.

Vivotek Turret Dome IT9389-H - ■ Maximum frame rate - 2

natural_image Abstract geometric pattern with alternating blue and white parallelograms (no text or symbols)

Vivotek Turret Dome IT9389-H - ■ Maximum frame rate - 3
Static scene

natural_image Abstract geometric pattern of alternating blue and white parallelograms (no text or symbols)

PIPPPPPPPIPPPPPPPI PPP

Vivotek Turret Dome IT9389-H - ■ Maximum frame rate - 4
Activities
Dynamic Intra Frame w/ static scenes

Vivotek Turret Dome IT9389-H - ■ Maximum frame rate - 5
Dynamic Intra Frame w/ activities in scenes

With the H.265 codec in an optimal scenario and when Dynamic Intra frame is combined with the Smart Stream function, an 80% of bandwidth saving can be achieved compared with using H.264 without enabling these bandwidth-saving features.

■ Smart FPS

In a static scene, the algorithm puts old frames in queue when no motions occur in scene. When motions occur, the encoding returns to normal to deliver real-time streaming.

Vivotek Turret Dome IT9389-H - ■ Smart FPS - 1

flowchart
graph LR
    A["f1f1f1"] --> B["f1"]
    B --> C["f5f5f5f5f9"]

Vivotek Turret Dome IT9389-H - ■ Smart FPS - 2

flowchart
graph LR
    f1 --> f3 --> f4 --> f5 --> f6 --> f7 --> f8 --> f9
    note right of f4: Motions Occur.
    classDef magenta fill:#f9f,stroke:#333;
    class f1,f3,magenta;

By queuing the old frames from a static scene, both the computing efforts and the size of P frames are reduced. It is beneficial for keeping up with the frame rate requirements.

A default frame difference threshold, 1%, is embedded in firmware for returning from Smart FPS to normal encoding when motions occur.

Vivotek Turret Dome IT9389-H - ■ Smart FPS - 3

NOTE:

Comparing with Smart Stream II, Smart Stream III has two more configurable options: Smart Q, and Smart FPS.

- Smart codec: Smart codec effectively reduces the quality of the whole or the non-interested areas on a screen and therefore reduces the bandwidth consumed.

You can manually specify the video quality for the foreground and the background areas.

Vivotek Turret Dome IT9389-H - NOTE: - 1

text_image Smartstream II ✓ Dynamic intra frame period (Help) ✓ smart_codec: Mode: Manual Manual window setting Quality priority (Help) The user can adjust the quality balance between ROI (Region of Interest) and non-ROI area, moving the selector to the right side gives more quality priority on ROI area, whereas moving the selector to the left side gives more quality priority on non-ROI area. Example

Select an operation mode if Smart codec is preferred.

- Auto tracking: The Auto mode configures the whole screen into the non-interested area. The video quality of part of the screen returns to normal when one or more objects move in that area. The remainder of the screen where there are no moving objects (no pixel changes) will still be transmitted in low-quality format.

- Manual: The Manual mode allows you to configure 3 ROI windows (Region of Interest, with Foreground quality) on the screen. Areas not included in any ROI windows will be considered as the non-interested areas. The details in the ROI areas will be transmitted in a higher-quality video format.

As illustrated below, the upper screen may contain little details of your interest, while the sidewalk on the lower screen is included in an ROI window.

Vivotek Turret Dome IT9389-H - NOTE: - 2

text_image (TCP-V) non-interested ROI_0 ROI New Restore Close Save

As the result, the lower screen is constantly displayed in high details, while the upper half is transmitted using a lower-quality format. Although the upper half is transmitted using a lower quality format, you still have an awareness of what is happening on the whole screen.

Vivotek Turret Dome IT9389-H - NOTE: - 3

text_image non-ROI: lower-quality ROI: higher-quality

- Hybrid: The major difference between the “Manual” mode and the “Hybrid” mode is that:

In the "Hybrid" mode, any objects entering the non-interested area will restore the video quality of the moving objects and the area around them. The video quality of the associated non-interested area is immediately restored to normal to cover the moving objects.

In the “Manual” mode, the non-interested area is always transmitted using a low-quality format regardless of the activities occurring inside.

Quality priority: (Help)

Vivotek Turret Dome IT9389-H - NOTE: - 4

- Quality priority: Use the slide bar to tune the quality contrast between the ROI and non-interested areas.

The farther the slide bar button is to the right, the higher the image quality of the ROI areas. On the contrary, the farther the slide bar button to the left, the higher the image quality of the non-interested area.

In this way, you may set up an ROI window as a privacy mask by covering a protected area using an ROI window, while the rest of the screen becomes the non-interested area. You may then configure the non-interested area to have a high image quality, or vice versa.

You should also select the Maximum bit rate from the pull-down menu as the threshold to contain the bandwidth consumption for both the high- and low-quality video sections in a smart stream.

■ Bit rate control

Constrained 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, \~ to 80Mbps. You can also select Customize and manually enter a value up to 40Mbps.

- Target quality: Select a desired quality ranging from Medium to Excellent.

  • Maximum bit rate: select a bit rate from the pull-down menu. The bit rate ranges from 20kbps to a maximum of 80Mbps. 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.

Smart Q: Select ON or OFF to enable or disable the feature. Smart Q is scene-aware. The Smart Q reduces frame size and bit rate consumption through the following:

■ Dynamically adjusting the image quality for scenes in different luminosities in low light frames. Less noises means less of the bandwidth consumed.
■ Endorsing different qualities for the I frames and P frames, and hence reduces the frame size.
■ Dividing a single frame into different sections, and giving these sections different qualities. For a highly complex area, such as an area with dense vegetation, screen windows, or repeated patterns (complex textiles patterns like wall paper), having a lower quality value actually poses little effects on human eyes.

Unnecessary quality is unrecognized by human eyes and wastes the bit rate.

The Smart Q streaming can save up to 50% to 80% of bandwidth in different illumination conditions while keeping the same imaging quality. These numbers come from the comparison between Smart Stream II and Smart Stream III streamings.

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 80Mbps.

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

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

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

Vivotek Turret Dome IT9389-H - Fixed quality: - 1

Resolution:

2560x1920

Maximum frame rate:

10 fps

Bit rate control

○ Constrained bit rate:

Fixed quality:

Quality:

Good

Maximum bit rate:

80 Mbps

■ 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 (at the 5MP resolution), the frame rates are selectable at 1fps, 2fps, 3fps, 5fps, 8fps, 10fps, and 15fps. If the power line frequency is set to 60Hz, the frame rates are selectable at 1fps, 2fps, 3fps, 5fps, 8fps, 10fps, and 15fps. 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.

For Constant Bit Rate and other settings, refer to the previous page for details.

Vivotek Turret Dome IT9389-H - ■ Video quality - 1

NOTE:

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

Media > Audio

Audio Settings

Vivotek Turret Dome IT9389-H - Audio Settings - 1

text_image Audio settings Mute Internal microphone input gain: 70% Audio type ● G.711: pcmu ○ G.726 bit rate: 32 Kbps Save

Mute: Select this option to disable audio transmission from the Network Camera to all clients. Note that if mute mode is turned on, 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:

Vivotek Turret Dome IT9389-H - Audio Settings - 2

text_image Warning The media type has been changed to video only because the media from server contains no audio OK

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

Audio type: Select audio codec as G.711 or G.726 and the bit rate.

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

Media profiles

You can configure a different video stream for each of the 3 default profiles, Max. view, Recording, Live view, and App.

The related video stream information will display, including stream number, resolution, codec used, frame rate, etc. The Multicast port number, and address for video, audio, and Metadata configuration will also be listed.

Vivotek Turret Dome IT9389-H - Media profiles - 1

text_image > Stream profiles setup Profile name: Max view ✓ Always multicast for this stream profile Video configuration ✓ Setup a video configuration Source Stream No: Stream 1 Codec: H.264 Resolution: 2048x2048 Frame rate: 15 Bit rate (kbit/s): 6000000 Multicast Port: 15560 Address: 239.240.7.99 RTCP Port: 15561 Multicast TTL [1~255]: 15 Audio configuration ✓ Setup an audio configuration Source Codec: 6.711 Multicast Port: 15562 Address: 239.240.7.99

Network > General settings

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

Network Type

Vivotek Turret Dome IT9389-H - Network Type - 1

text_image Network type LAN Get IP address automatically Use fixed IP address Enable UPnP presentation Enable UPnP port forwarding PPPoE Enable IPv6 Save

LAN

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

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

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

Vivotek Turret Dome IT9389-H - LAN - 1

text_image Network type LAN Get IP address automatically Use fixed IP address IP address: 172.16.168.10 Subnet mask: 255.255.0.0 Default router: 172.16.0.1 Primary DNS: 192.168.0.21 Secondary DNS: 192.168.0.22 Primary WINS server: 192.168.0.21 Secondary WINS server: 192.168.0.22 Enable UPnP presentation Enable UPnP port forwarding PPPoE Enable IPv6 Save
  1. You can make use of VIVOTEK Installation Wizard 2 on the software CD to easily set up the Network Camera on LAN. Please refer to Software Installation on page 16 for details.
  2. Enter the Static IP, Subnet mask, Default router, and Primary DNS provided by your ISP or network administrator.

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

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

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, the shortcuts to connected Network Cameras will be listed in My Network Places. You can click the shortcut to link to the web browser. Currently, UPnP ^TM is supported by Windows XP or later. Note that to utilize this feature, please make sure the UPnP ^TM component is installed on your computer.

Vivotek Turret Dome IT9389-H - LAN - 2

text_image My Network Places File Edit View Favorites Tools Help Back Search Folders Address My Network Places Go Network Tasks Add a network place View network connections Set up a home or small office network View workgroup computers Local Network Wireless Network Camera (192.168.5.126) Mega-pixel Network Camera (192.168.5.151) Wireless Network Camera with Pan/Tilt (192.168.5.141)

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 131) to add a new email or FTP server.
  3. Go to Configuration > Event > Event settings > Add media (please refer to Add media on page 139).
    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.

Vivotek Turret Dome IT9389-H - PPPoE (Point-to-point over Ethernet) - 1

text_image Network type LAN PPPoE User name: Password: Confirm password: Enable IPv6 Save
  1. The Network Camera will reboot.
  2. Disconnect the power to the Network Camera; remove it from the LAN environment.

Vivotek Turret Dome IT9389-H - PPPoE (Point-to-point over Ethernet) - 2

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.

Vivotek Turret Dome IT9389-H - NOTE: - 1

text_image Control Panel File Edit View Favorites Tools Help Search Problems Control Panel Switch to Clear: Yes See Also Windows Update Help and Support Other Controls Panel Options Pick a category Appearance and Themes Networks and Internet Connections Add or Remove Programs Brush, Speech, and Audio Devices Performance and Maintenance Protocols and Other Hardware User Accounts Data, Time, Language, and Stringed Options Accessibility Options
  1. In the Add or Remove Programs dialog box, click Add/Remove Windows Components.

Vivotek Turret Dome IT9389-H - NOTE: - 2

text_image Add or Remove Programs Currently installed programs: Sort by: None Apple Software Update Click here for support information. Size 2.1MB Used rarely Last Used On 7/27/2007 Change Remove Add New Programs Add Remove Windows Components Installation Wizard Microsoft Office Professional Edition 2003 Mozilla Firefox (2.0.0.6) PostgreSQL 8.2 QuickTime Virtual Machine Additions Vivtek Installation Wizard 2 VYOTEK ST7501 Windows Genuine Advantage Validation Tool (KB892130) Windows XP Hotfix - KB828869 Windows XP Hotfix - KB828741 Windows XP Hotfix - KB833407 Windows XP Hotfix - KB835732 Close
  1. In the Windows Components Wizard dialog box, select Networking Services and click Details.

Vivotek Turret Dome IT9389-H - NOTE: - 3

text_image Windows Components Wizard Windows Components You can add or remove components of Windows XP To add or remove a component, click the checkbox. A shaded box means that only part of the component will be installed. To see what's included in a component, click Details. Components Message Queuing 0.0 MB MSN Explorer 135 MB Networking Services 0.3 MB Other Network File and Print Services 0.0 MB Update Food Certificates 0.0 MB Description: Contains a variety of specialized, network related services and protocols. Total disk space required: 0.0 MB Space available on disk: 12125.4 MB Details... < Back Next > Cancel
  1. In the Networking Services dialog box, select Universal Plug and Play and click OK.

Vivotek Turret Dome IT9389-H - NOTE: - 4

text_image Networking Services To add or remove a component, click the check box. A shaded box means that only part of the component will be installed. To see what's included in a component, click Details. Subcomponents of Networking Services: RIP Listener 0.0 MB Simple TCP/IP Services 0.0 MB Universal Plug and Play 0.2 MB Description: Listens for route updates sent by routers that use the Routing Information Protocol version 1 (RIPv1). Total disk space required: 0.0 MB Space available on disk: 12125.4 MB Details... OK Cancel
  1. Click Next in the following window.

Vivotek Turret Dome IT9389-H - NOTE: - 5

text_image Windows Components Wizard Windows Components You can add or remove components of Windows XP. To add or remove a component, click the checkbox. A shaded box means that only part of the component will be installed. To see what's included in a component, click Details. Components Message Queuing 0.0 MB MSN Explorer 13.5 MB Networking Services 0.3 MB Other Network File and Print Services 0.0 MB Update Boot Certificates 0.0 MB Description: Contains a variety of specialized, network-related services and protocols. Total disk space required: 0.0 MB Space available on disk: 12125.4 MB Details... < Back Next > Cancel
  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 61 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.

Vivotek Turret Dome IT9389-H - Enable IPv6 - 1

text_image Network type ○ LAN ● PPPoE User name: Password: Confirm password: ✓ Enable IPv6 IPv6 information □ Manually setup the IP address Save

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.

Vivotek Turret Dome IT9389-H - Enable IPv6 - 2

text_image [eth0 address] fs80.0000.0000:0000:0202.d1ff:fe0e:d4c8/64@Link [Gateway] IPv6 address list of gateway [DNS] IPv6 address list of DNS

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:

Vivotek Turret Dome IT9389-H - Enable IPv6 - 3

text_image Refers to Ethernet [eth0 address] 2001:0c08:2500:0002:0202:d1ff:fe04:65f4/64@Global fe80:0000:0000:0000:0202:d1ff:fe04:65f4/64@Link [Gateway] fe80::211:d8ff:fea2:1a2b [DNS] 2010:05c0:978d::

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:

Vivotek Turret Dome IT9389-H - Enable IPv6 - 4

text_image http://[2001:0c08:2500:0002:0202:d1ff:fe04:65f4]/ IPv6 address
  1. Press Enter on the keyboard or click Refresh button to refresh the webpage. For example:

Vivotek Turret Dome IT9389-H - Enable IPv6 - 5

text_image Network Camera - Microsoft Internet Explorer File Edit View Favorites Tools Help Back Search Favorites Address http://[2001:0c08:2500:0002:0202:d1ff:fe04:65f4]/ VIVOTEK www.vivotek.com

Vivotek Turret Dome IT9389-H - Enable IPv6 - 6

NOTE:

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

Vivotek Turret Dome IT9389-H - NOTE: - 1

text_image http://[2001:0c08:2500:0002:0202:d1ff:fe04:65f4]/:8080 IPv6 address Secondary HTTP port

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

Vivotek Turret Dome IT9389-H - NOTE: - 2

text_image [eth0 address] fe80:0000:0000:0000:0202:dlff:fe11:2299/64@Link [ppp0 address] fe80:0000:0000:0000:0202:dlff:fe11:2299/10@Link 2001:b100:01c0:0002:0202:dlff:fe11:2299/64@Global [Gateway] fe80::90:1a00:4142:8ced [DNS] 2001:b000::1

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

Vivotek Turret Dome IT9389-H - IPv6 information - 1

text_image 1/64

Network > Streaming protocols

Vivotek Turret Dome IT9389-H - Network &gt; Streaming protocols - 1

NOTE:

The metadata information can only be transmitted through the HTTP main port. Metadata is not available through the secondary HTTP port.

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

Vivotek Turret Dome IT9389-H - HTTP streaming - 1

text_image HTTP RTSP Authentication: basic HTTP port: 80 Secondary HTTP port: 8080 Access name for stream 1: video1s1.mjpg Access name for stream 2: video1s2.mjpg Access name for stream 3: video1s3.mjpg Save

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:

Vivotek Turret Dome IT9389-H - HTTP streaming - 2

text_image Microsoft Internet Explorer HTTP port must be 80 or from 1025 to 65535 OK

Vivotek Turret Dome IT9389-H - HTTP streaming - 3

text_image Microsoft Internet Explorer Secondary HTTP port must be from 1025 to 65535 OK

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 identify different video streams. Users can click Media > Video > Stream settings to set up the video quality of linked streams. For more information about how to set up the video quality, please refer to Stream settings on page 77.

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

Vivotek Turret Dome IT9389-H - HTTP streaming - 4

text_image video2.mjpg (JPEG Image, 320x240 pixels) - Mozilla Firefox File Edit View History Bookmarks Tools Help http://192.168.5.151/video1s2.mjpg Customize Links Free Hotmail Windows Media Windows

Vivotek Turret Dome IT9389-H - HTTP streaming - 5

NOTE:

▶ Microsoft® Internet Explorer does not support server push technology; therefore, you will not be able to access a video stream using http://:/.

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

Vivotek Turret Dome IT9389-H - RTSP Streaming - 1

text_image HTTP RTSP Authentication: digest RTSP port: 554 RTP port for video: 5556 RTCP port for video: 5557 RTP port for metadata: 6556 RTCP port for metadata: 6557 RTP port for audio: 5558 RTCP port for audio: 5559 Video Multicast settings for Stream 1 IP version: IPv6 Multicast video address: 239.240.7.99 Multicast video port: 15560 Multicast video TTL [1~255]: 15 Audio Multicast settings:

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

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

The availability of the RTSP streaming for the three authentication modes is listed below:

VLC
Disable O
Basic O
Digest 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 or H.265 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 live1s1.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.

Vivotek Turret Dome IT9389-H - RTSP Streaming - 2

natural_image River scene with multiple cars and buildings in the background under a clear blue sky (no visible text or symbols)

Vivotek Turret Dome IT9389-H - RTSP Streaming - 3

text_image VLC media play Media Playback Playlist My Computer My Videos My Music My Pictures Devices Discs Open Media File Disc Network Capture Device Network Protocol Please enter a network URL: rspr/192.168.51.64-55 Vlvelst.sla http://www.example.com/wiki.org/ http://sp.1234 https://https.example.com/wiki.org/ http://www.example.org/3080test.sla/ http://www.youtube.com/watch?vzgs4s

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

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:

Vivotek Turret Dome IT9389-H - RTSP Streaming - 4

text_image Microsoft Internet Explorer Invalid port number: RTP video port must be an even number. OK

Multicast settings for streams: Click the items to display the detailed configuration information. Select the Always multicast option to enable multicast for video streams.

Vivotek Turret Dome IT9389-H - RTSP Streaming - 5

text_image Video Multicast settings for Stream 1 IP version: IPv6 Multicast video address: 239.240.7.99 Multicast video port: 15560 Multicast video TTL [1~255]: 15 Audio Multicast settings: IP version: IPv4 Multicast audio address: 239.240.7.99 Multicast audio port: 15562 Multicast audio TTL [1~255]: 15 Metadata Multicast settings: IP version: IPv4 Multicast metadata address: 239.240.7.99 Multicast metadata port: 16560 Multicast metadata TTL [1~255]: 15

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:

Vivotek Turret Dome IT9389-H - RTSP Streaming - 6

text_image Microsoft Internet Explorer Invalid port number. Multicast stream 1 video port must be an even number. OK

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

Vivotek Turret Dome IT9389-H - RTSP Streaming - 7

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 is a free service provided by VIVOTEK server, which allows users to register a domain name for a network device. One URL can only be mapped to one MAC address. This service will examine if the host name is valid and automatically open a port on your router. If using DDNS, the user has to manually configure UPnP port forwarding. Express Link is more convenient and easier to set up.

Vivotek Turret Dome IT9389-H - Express link - 1

text_image Express link Manual setup Enable express link http:// | .2bthere.net Help Save By Express link, all users need to do is create host name for the camera. It will generate the link to access the camera from internet.

Please follow the steps below to enable Express Link:

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

Vivotek Turret Dome IT9389-H - Express link - 2

text_image Express link Manual setup Enable express link http:// 0002D1123456 .2bthere.net Help Save The camera can now be accessed at http://0002D1123456.2bthere.net

Vivotek Turret Dome IT9389-H - Express link - 3

text_image Network Camera - Microsoft Internet Explorer File Edit View Favorites Tools Help Back Search Favorites https://0002D1123456.2bthere.net VIVOTEK www.vivotek.com Video Stream 1 Manual Trigger: Digital Output On Off Focus Assist On Off Mega-Pixel Network Came ( TCP-AV )

Manual setup

DDNS: Dynamic domain name service

DDNS: Dynamic domain name service
Vivotek Turret Dome IT9389-H - DDNS: Dynamic domain name service - 1

Enable DDNS:

Provider:

Dyndns.org(Dynamic)

Host name:

User name:

Password:

Vivotek Turret Dome IT9389-H - DDNS: Dynamic domain name service - 2

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:

WTK.safe100.net

Email:

wtk@vivotek.com

Key:

...

Confirm 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

Vivotek Turret Dome IT9389-H - ■ Safe100.net - 1

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:

Safe100.net

VWTK.safe100.net

wtk@vivotek.com

...

Vivotek Turret Dome IT9389-H - ■ Safe100.net - 2

[*.safe100.net]

Save

Register

Host name:

Email:

Key:

Confirm key:

WTK.safe100.net

wtk@vivotek.com

●●●●

...

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

Vivotek Turret Dome IT9389-H - ■ Safe100.net - 3

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

Vivotek Turret Dome IT9389-H - CoS (the VLAN 802.1p model) - 1

text_image CoS Enable CoS VLAN ID: 1 Live video: 0 ▼ Live audio: 0 ▼ Event/Alarm: 0 ▼ Management: 0 ▼

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

Vivotek Turret Dome IT9389-H - CoS (the VLAN 802.1p model) - 2

NOTE:

▶ A VLAN Switch (802.1p) is required. Web browsing may fail if the CoS setting is incorrect.
The 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).

Vivotek Turret Dome IT9389-H - QoS/DSCP (the DiffServ model) - 1

text_image QoS/DSCP Enable QoS/DSCP Live video: 0 Live audio: 0 Event/Alarm: 0 Management: 0 Save

Note that different vendors of network devices might have different methodologies and unique implementations. Shown below is a sample corresponding information from a Cisco switch. You should enter a DSCP tag value according to the information provided by the network devices.

DSCP to Queue Table
Ingress DSCPOutput QueueIngress DSCPOutput QueueIngress DSCPOutput QueueIngress DSCPOutput Queue
0(BE)1▼16(CS2)2▼32(CS4)3▼48(CS6)3▼
11▼172▼333▼493▼
21▼16(AF21)2▼34(AF41)3▼503▼
31▼192▼353▼513▼
41▼20(AF22)2▼36(AF42)3▼523▼
51▼212▼373▼533▼
61▼22(AF23)2▼38(AF43)3▼543▼
71▼232▼393▼553▼
8(CS1)1▼24(CS3)3▼40(CS5)4▼56(CS7)3▼
91▼253▼414▼573▼
10(AF11)1▼26(AF31)3▼424▼583▼
111▼273▼434▼593▼
12(AF12)1▼28(AF32)3▼444▼603▼
131▼293▼454▼613▼
14(AF13)1▼30(AF33)3▼46(EF)4▼623▼
151▼313▼474▼633▼

Vivotek Turret Dome IT9389-H - QoS/DSCP (the DiffServ model) - 2

text_image QoS/DSCP Enable QoS/DSCP Live video 32 0 Live audio: 0 Event/Alarm: 0 Management: 0
QoS Baseline/Technical Marketing Classification and Marking Recommendations
Application Layer3 Classification Layer 2 CoS/MPLS EXP
IPP PHB DSCP
IP Routing 6 CS6 48 6
Voice 5 EF 46 5
Interactive Video 4 AF4134 4 QoS B
Streaming-Video 4 CS4 32 4
Locally-defined Mission-Critical Data3 -25 3
Call-signaling3 AF31/CS326/243
Transactional Data2 AF2118 2
Network Management2 CS2 16 2
Bulk Data1 AF1110 1

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:

Encryption Password:

Read only Security name:

Public

Authentication Type:

MD5

Authentication Password:

-

Encryption Password:

Network > FTP

The newer firmware disabled the FTP port for security concerns. You can manually enable the FTP server service to enable the FTP function. You can disable the FTP server function when it is not in use.

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

Vivotek Turret Dome IT9389-H - Network &gt; FTP - 1

Tips:

You can FTP the camera's IP address to download videos recorded in the SD card, or use the "http://ip/cgi-bin/admin/lsctrl.cgi?cmd=search" command to examine the recorded files on your SD card.

SFTP:

This is the embedded SFTP client. Host Key: A host key is the SFTP server's public key. Ensuring the SFTP server is validated is an important aspect of the SFTP protocol. It is designed to protect against man-in-the-middle attacks where the hacker intercepts and relays an impersonated message to the other party.

Click the Save button and the camera SFTP server MD5 key will display. The default format is ED25519 and RSA.

Vivotek Turret Dome IT9389-H - SFTP: - 1

text_image SFTP Enable SFTP server SFTP port: 22 Host Key: MD5:b0:fd:64:28:36:fe:80:2b:26:e4:e1:45:96:22:2e:42 (RSA) MD5:0e:ac:24:ba:0f:4b:03:09:70:a4:56:2b:db:e6:03:2e (ED25519)

Bonjour

To access the camera from a Mac computer, go to Safari, click on Bonjour and select the camera from a drop-down list.

You can go to Safari > Preferences to enter your user name and password, and provide the root password the first time you access the camera. The camera main page will open in your browser.

Vivotek Turret Dome IT9389-H - Bonjour - 1

text_image Discovery ▼local - 6 items ►_afpovertcp_tcp. (AFP over TCP) ►_companion-link_tcp. ►_case-sb_tcp. ►_http_tcp. (World Wide Web HTTP) ►_risp_tcp. (Real Time Streaming Protocol (RTSP)) - 1 items ▼ FD9165-NN-00ABCDABCODEF Network Camera.local 192.168.0.16:554 path=live.scp ►_amb_tcp. (Server Message Block over TCP/IP)

Some later iOSes may come without the Bonjour option. Install the Discovery utility instead.

Find the Discovery (formerly Bonjour Browser) from the Mac App Store.

Discovery is a utility that displays all the Bonjour services on your local network or on Wide-Area Bonjour domains. The utility is previously called Bonjour Browser, it is now distributed on the Mac App Store.

Discovery requires macOS 10.12 or higher. For older versions of Mac OS you can download the old version of Bonjour Browser.

Bonjour Browser (obsolete)

http://www.tildesoft.com/files/BonjourBrowser.dmg - Version 1.5.6

Discovery for iOS

https://itunes.apple.com/us/app/discovery-dns-sd-browser/id305441017?mt=8

Security > User accounts

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

Account management

Security > User accounts

Vivotek Turret Dome IT9389-H - Security &gt; User accounts - 1

text_image Account management Privilege management --New user-- User name: root User password: ********** Password should meet the following requirements: *8~64 characters with no spaces *include at least one alphabetic character *include at least one numeric character Confirm user password: ********** Privilege: Administrator Delete Add Update

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

The administrator can create up to 20 user accounts.

To create a new user,

  1. Click to unfold the pull-down menu. Select New user.
  2. Enter the new user's name and password. Type the password identically in both text boxes.

Some, but not all special ASCII characters are supported: !, \$, %, -, ., @, ^, _, and \~. You can use them in the password combination.

The strength of your password combination is shown on the right, use the combination of alphabetic, numeric, upper case, and lower case characters until the password strength is good enough.

  1. Select the privilege level for the new user account. Click Add to enable the setting.

The privilege levels are listed below:

Administrator Full control
Operator ControlDO, white-light illuminator, snapshot, and PTZ; unable to enter the camera Configuration page.
Viewer ControlDO, white-light illuminator, view, listen, PTZ, and talk through the camera interface.

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

Privilege management

Vivotek Turret Dome IT9389-H - Privilege management - 1

text_image Account management Privilege management Operator: ✓ PTZ control Viewer: ✓ PTZ control Save

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

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.

Vivotek Turret Dome IT9389-H - Create self-signed certificate - 1

text_image HTTPS Enable HTTPS secure connection Mode: HTTP & HTTPS HTTPS only Please wait while the certificate is being generated... Certificate: Certificate information Status: Not installed method: Create self-signed certificate Country: TW State or province: Asia Locality: Asia Organization: VIVOTEK.inc Organization unit: VIVOTEK.inc Common name: www.vivotek.com Validity: 3650 days Create certificate
  1. The Certificate Information will automatically be displayed as shown below. You can click Certificate properties to view detailed information about the certificate.

Vivotek Turret Dome IT9389-H - Create self-signed certificate - 2

text_image Certificate information Status: Active method: Create self-signed certificate Country: TW State or province: Asia Locality: Asia Organization: VIVOTEK.Inc Organization unit: VIVOTEK.Inc Common name: www.vivotek.com Certificate properties Remove certificate
  1. Click Save to preserve your configuration, and your current session with the camera will change to the encrypted connection.
  2. If your web session does not automatically change to an encrypted HTTPS session, click Home to return to the main page. Change the URL address from "http://" to "https://" in the address bar and press Enter on your keyboard. Some Security Alert dialogs will pop up. Click OK or Yes to enable HTTPS.

https://
Vivotek Turret Dome IT9389-H - Create self-signed certificate - 3

text_image Network Camera - Microsoft Internet Explorer File Edit View Favorites Tools Help Back Search Favorites Address: https://192.168.5.151/index.html VIVOTEK www.vivotek.com Video stream: 1 Manual triggers: Digital output: On Ctrl Focus assist: On Ctrl PTZ control: Digital Zoom Pan Stop Patrol Pan speed: 0 Tilt speed: 0 Zoom speed: 0 Global view. Mega-Pixel Network Camera Home Client settings Configura (TCP-AV) Security Alert You are about to view pages over a secure connection. Any information you exchange with this site cannot be viewed by anyone else on the Web. In the future, do not show this warning OK More Info

Vivotek Turret Dome IT9389-H - Create self-signed certificate - 4

text_image Security Alert Information you exchange with this site cannot be viewed or changed by others. However, there is a problem with the site's security certificate. The security certificate was issued by a company you have not chosen to trust. View the certificate to determine whether you want to trust the certifying authority. The security certificate date is valid. The name on the security certificate is invalid or does not match the name of the site Do you want to proceed? Yes No View Certificate

Vivotek Turret Dome IT9389-H - Create self-signed certificate - 5

text_image Security Information This page contains both secure and nonsecure items. Do you want to display the nonsecure items? Yes No More Info

Create certificate request and install

  1. Select the option from the Method pull-down menu.
  2. Click Create certificate to proceed.
  3. The following information will show up in a pop-up window after clicking Create. Then click Save to generate the certificate request.

Vivotek Turret Dome IT9389-H - Create certificate request and install - 1

text_image Certificate information Status: Not installed Method: Create certificate request and install Country: TW State or province: Asia Locality: Asia Organization: VIVOTEK Inc. Organization unit: VIVOTEK Inc. Common name: www.vivotek.com Please wait while the certificate is being generated... Create certificate
  1. The Certificate request window will prompt.

Vivotek Turret Dome IT9389-H - Create certificate request and install - 2

text_image http://192.168.4.168/setup/security/certificate_request.html - Windows Interns... Create certificate 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---- MIIBssCCARwCAQIvcaZEIMAKGA1UEBhMCVFcxDTALBgNVBAqTBEFsaWEzDTALBgNVBAcTBEFsaWExPTAIBgNVBAcTDFTZJVk9UUSqSW5jLjZVMBMGA1UKCxMNkIWT1RFSyBJdmNHRgVgYDVYQDEwS3dcdm12b3Rlay5jb20wg18wDQYJKOZHvcNAQEBBQADgY0AMICJAoGEALfF5jkjh1CoufOBp43fOWUngQEDtQ8si94HCTbrsvhpun/WADJAYKh5hLQvGpmpaMy9crSVtu0JuGTbkhLAuRn/T57Rdv24UC0sGvmnSAg2S16ZpnGI2PY9L244VnhuaircvwvAIIVHoMIXxflodD2UEKmC3UHpNLBk6JSr7vASAgMBAAAGGADANBgkqhkiG9V0BAQUFAA0BGqB4cGpKdU1cbwNd1RPnIU58EMShBr1XHmYzk/1gI7ELKxPWE0KAlgi9i4KpFNjAVBGsOLwUU0h/nyHRSc2a2eEZWILBJhD1A1PmI2XND1IAvC46aa0h9hqT9eSILK6VllwClpAXNmoBuUqNa4MYVyaAgd8soeQuZSVs3Mxxrfluow= ----END CERTIFICATE REQUEST----

If you see the following Information bar, click OK and click on the Information bar at the top of the page to allow pop-ups.

Vivotek Turret Dome IT9389-H - Create certificate request and install - 3

text_image HTTPS - Microsoft Internet Explorer File Edit View Favorites Tools Help Back Search Favorites Address http://192.168.5:151/setup/https.html Pop-up blocked. To see this pop-up or additional options click here... VIVOTEK VIVOTEK.com Security > HTTPS Home Configuration Language System Security User account HTTPS ACCESS LIST IEEE 802.1x Network Information Bar Did you notice the Information Bar? The Information Bar alerts you when Internet Explorer blocks a pop-up window or the download that might not be safe. If a Web page does not display property, look for the Information Bar (near the top of your browser). Do not show this message again. Learn about the Information Bar... OK
  1. Look for a trusted certificate authority, such as Symantec's VeriSign Authentication Services, that issues digital certificates. Sign in and purchase the SSL certification service. Copy the certificate request from your request prompt and paste it in the CA's signing request window. Proceed with the rest of the process as CA's instructions on their webpage.

Vivotek Turret Dome IT9389-H - Create certificate request and install - 4

text_image Symantec. Trust Center Free Trial ▶ 1) Options ▶ 2) Technical Contact ▶ 3) CSR ▶ 4) Summary Enter Certificate Signing Request (CSR) Server platform Select one Sample CSR BEGIN CERTIFICATE REQUEST... MIR@CCARc.CA@rc.ELEN@AL@EBH.CVY\v3DTAL@bgv/BBAGTBEFzWE/IE/DTAL@bgv/ DA@TDBt.sA#EFTAT@giv/Ba#TOFZ/A#BUPJagD#GLEVHEMGATUECvANIVVAT1R# SYb@bn#N##WfYOYVQEDwSx8sU2dN#MyTcyfml#MTCBnA#BqI#DKOVA0BA.OF# AAC@GwvgNkGyDYL2eT22mvo29nLGEIDHfgYVQdLJNudma2dtBsdD#QoSA# SI@uHsXG0G0NDIL5eD#OEBBNlS#BgNpCZSmInGZHvCKYB6eAeG# ZE@cugm#FDHGPL#RC#LTNvCGRY0eP##GZGymenCT#pJEqGhKCAEA# da#A#WU#KCSWgDLDDEEgAaMAGBnAdeHklaGMfvsrGQFSLMADLFTSB#lv# TMow#t#lngMvZnBtEveYwCypWYHdZpGLVUUCMkVYwEoWYZSTBkHcY# cpRJbdoCZAY10-pcgjcbMUSXooyKDPYKYoSMgADBCzepET7eRpNGEFhq# V23xccM1 ----END CERTIFICATE REQUEST---- Order details Symantec™ SSL Test Certificate • Validity period 30 days Total (free Trial) US $0 Help What is a CSR? A CSR is generated from your server and is your server's unique 'fing eprint'. The CSR includes your server's public key, which enables server authentication and secure communication. Need help create asking a CSR? -- Close Total: US 10 (free trial) < Back Cancel Continue Legal Nuttras | Privacy | Repository | Feedback TrUSTe Norton Done
  1. Once completed, your SSL certificate should be delivered to you via an email or other means. Copy the contents of the certificate in the email and paste it in a text/HTML/hex editor/converter, such as IDM Computer Solutions' UltraEdit.

immediately, please dial 866.893.6565 or 650.426.5112 option 3 or send an email to internet-sales@verisign.com

Thank you for your interest in Symantec!

----BEGIN CERTIFICATE----

MI1FDDCA+yuAvIAgAIqF1xCehn/CeB5it0Q0DDIzANBgkqhkiG5w0DAQUFADC8yeELMNYGALCEHRVCMVFnFaSveAgVFGAeTD101cn11c7aUduLCbWmAtMTAvLgYDVQQEydG63lgVGvdZChDqXJxb3NlcyB4Pmm5LiAgTtEqg/XNdxAHhmbLCydwKgBABgQVBAstTOVRcMLiUEAFMHHv2SSNDGncRmWvaV0L3dH2SY2TKpc2Inbl5jb90VYr3BzLR5c3RjY5AcYwkOteNCeGAUfEAwNKwVraWvPngZ4gYH3pwYgUVdXLJIFLNcl2lcEDQSRATlECyMD4DTEyMDcwWuAwMDwAFtFCDEtyMDgwMlIzntK1CVYowca4xCzAJrDgHVbALTALNGMwCyFvDWgERbc21MnGwCVDFVQEFARBC2lnNMBoEVyDVQQKEFAWSV2PVEVLIETyynfimFTEgIVNAsUDF2VjkUUR8sgSW5JyLD6DGdGA10EcQwYgVypD0gbyYgdKN1IGF01843cySZJKpc2lnp15jb20VT382LR3lcIR1RYSaAYwTWEMZXGGAIEAe4t3dLn21ODE3M15)jb26wgZEWQDTKkoZThvCRsQAEBQBQADgY0AMl6oAaGANIIOTcrkBFcc+ha9UYVtgFSkCYT3c72ctcuRYLrpdlid6eQDRp+h+jhttPCUgSCTIwnWUBCDPG/Q4mIFPeOpWMuSO20GR/qqmANKJlxnkEN/ARwklINsk1svakloCdygrFeRSCDNPq945DorRBSkduuMpqAnHoKOcNgqTAGMBAGggG8MllBrTA2BgNVHREEEjAggg83dcZuM4McyLMnvBTAdBgNVRKMELJAMALIGA10dWDwWqAEwFoHEGBNWRREFDAMDingGqJodNHwO1WL1ZSVRjYPWvtRxIsYslsIn2clmlawWuLNWvb59TVJUHmbhEcycImNyDBDOR NgVMSAQBMDM08CmCGSACG+EUBBxOMTAtvBggrgBETDQcCARYjahEHOhM6Ly3d3cudmVyeXHpZ24uYz9t2LcYNw60C2XNGY25BVQDVRO10EBYFWAYKVAHQBBAQHEGCCAQAFWEHMCM8BGAIuDWYMBnAFCkgAE9pIK3A7stYb2BhMyG7LMHGCCGGAQUFBVBBGGwZkABCggtyBFEQCwAYYeHRCocDvL29jc1AadUnVyaK24U78MD4GCCsSAQFPEzAChlJoDeIRw0lV0UZLVSNYtRvWtYwhLhLnZlcmaJwduLnNb69TVJUcmlnhEcycINMlcjANBgkheikic9wOEQAUFRAOCAQEATkuW7FnLac/T7Tfc/zsrzSEdHBKSEQSpqlaeWsinSc10p3znEkrvp6TCLFMbrODGjPa1LFnAEUItIsWISCoKMwLIaWp12qvSbDfxvgVMx9T7rdOrUrJaime61cfShlt5BqeZtc5peAkWhAB/U+cy0GbEvBzCfaSnHqcapKcgDXVmyrcHEWNRQgsSc136bgPaszVTrRhlnLnpdJnXESGesxSH13KCtrAzQvlRsd1EQYSTg20PgNm2ghdEuCthHNUwQwAhNueIfE1TFER70m6CoVohtbnlomFpvYEevIDvcZlIMn2BpoSoSclZAIPHI//KcGe--

END CERTIFICATE

  1. Open a new edit, paste the certificate contents, and press ENTER at the end of the contents to add an empty line.

Vivotek Turret Dome IT9389-H - Create certificate request and install - 5

text_image [Edit1*] - UltraEdit File Edit Search Insert Project View Format Column Scripting Advanced Window Help File View Project Open Explorer Lists Filter: * * A: C: D: E: Network FTP Accounts Name Date modified Open Files Edit1* CmCGS1GG+EUBBxUwKTAvEggrBgEFBQcCARYjaHROcHM6Ly93d3cudmVyaXNp224u Y29tL2Nvcy90ZNOY2EfHQYDVPO1BBYwFAYIKwYBBQUHAwEGCCsGAQUFBvMCMB8G A1UdIwQYMBaIFCgXE4q91qK13AYet7eO2h8mYG71MHQGCCsGAQUFBvEBBGgu2jAk BggrBgEFBQcwAYYYaHR0cDcvL2Djc3AudmVyaXNp224uY39tMD4GCCsCAQUFBsAC hjJodHRvOi8vU12SVHJpYUwtFeItYUlhLnZlcmltaWdulmNvbS9TVlIJUcm1hbEcy LmN1cjANBgkqhkiG9wOBAQUFAACCAQEATxuH7FnIac/K7T6z/ssr9sEKhLKSEQSp qaNc6osvix3c129Pp3kzERvp6TCLPS3MbrOPGjPaILFxAEUITr3WL3CoXVR1AjUp12 qV3bDfxgVHUx9TTrd2oURzjms6ifcM5Ttub3Qc2Tu3p9eAKbAH/U+x+j0GOEvE3z cPa5hn/qcapKcqOXvHycwBeCWNDRQgsGci360qkPzssv7oErbanLhupjdxUE3GExu 3M13CXrAtQZv1Rad1f0QYSTgSCNq2mA9ghdEuKTnhCHUwwqOxN8uceI163ITPK70 m5Co7pntbigmFtyjSEvgIUdc6YZImn2BOq5c5q3iZARPH/g1//ZeGg== ----END CERTIFICATE---- C:\My\Manager\
  1. Convert file format from DOS to UNIX. Open File menu > Conversions > DOS to Unix.

Vivotek Turret Dome IT9389-H - Create certificate request and install - 6

text_image File Edit Search Insert Project View Format Column Macro Scripting Advanced Window Help New Ctrl+N Open... Ctrl+O Quick Open... Ctrl+Q Close Close All Files Ctrl+Shift+F4 Close All Files Except This FIF/Telnet Revert to Saved Save Ctrl+S Save As... F12 Save All Alt+F12 Save Section As... Make Copy/Backup Encryption Rename File Compare... Alt+F11 Sort Conversions Special Functions Print... Ctrl+P Print All Files Print Preview Print Setup/Configuration Favorite Files... Ctrl+Shift+F Recent Files Recent Projects/WorkSpace Exit GSAGG+EUBBxWvKTAwBggrEgEFBQcCARYjaHROcHM6Ly93d3cudbVyaXNp224u cL2Nvcy90ZXNCY2EwKQYDVRO1BBDywFAYIKwYBDQUHAwEGCCsGAQUFBvHCME6G diWQYHBaAFCgXE4qS1qK13AYst7acZhBmYG71MHQGCCsGAQUFBvEBDGgw2jAK rBgEFBQcWATYYaHR0cDcvL29jc3AudmVyaXNpZ2iuY29tMD4GCCsGIQUFBzAC odHRU018vU1ZSVHojYWutRzItYUlhLnZlcmlzaWduLMNVbS9TVIJUcmlhhbEcy lc)IWBgkqhk:G9WEAQAUFAAACCAC/EATXuH7FnIae/X7T6t/zsr95EKHLKSEQSp c8svixSc129Pp3kzEKvp6TCLPSMbrOPGjPalLFxAEUITr3WISCoxURlajUp12 bDfxgWMWx9TTrd2oURzjms6ifcM5Ttub3Qc2Tu3pWelKBAH/U+x+ojGOEvB3z Shn/qcapKcqOXvHycwHeCWN8RQgsGci368qcPzssv7oErbnLhupjdxESGExu xCKrAtQZv1Rad1fJQYSTgSCNq2mA9ghdEuKTnhCHUwvgOxN8uceI183ITPKT0 o7pntb1gmFtyj9RvgIUdc6Y2Imn2BOq3c5q3iZARPH/gi//XeGg== --END CERTIFICATE---- UNIX\MAC to DOS DOS to MAC DOS to UNIX EBCDIC to ASCII ASCII to EBCDIC OEN to ANSI ANCI to OEM ASCII to Unicode UTF-B to Unicode Unicode to ASCII Template List Global Power User
  1. Save the edit using the ".crt" extension, using a file name like "CAcert.crt."

Vivotek Turret Dome IT9389-H - Create certificate request and install - 7

text_image [C:\Documents and Settings\eric.io\Desktop\Edit2.cit*] - Ultraldit File Edit Search Insert Project View Format Column Macro Scripting Advanced Window Help File View Project Open Explorer Lists Filter: A: C: D: E: F: Network FTP Accounts Save As Save in: Desktop My Documents My Computer My Network Places Adobe Reader 9 Filezilla Client Google Chrome Installation Wizard 2 LiveClient McAfee Security Scan Plus Milestone XProtect Smart Client Mozilla Firefox Playback QuickTime Player RealPlayer TeamViewer 6 UltraCompare UltraEdit VIVO-TEK BlackholePM公用资料夹 (位於 Blackhole) New Folder 41 45 46 802.1x 802.1x-1 802.1x-2 802.1x-3 access_alert activeX_plugin activeX_plugin1 My Recent Documents Desktop My Documents My Computer My Network Places File name: CAcert.cit Save as type: All Files, (*.*) Line Terminator: Default Format: Default Leave as 'Default' for normal use, or change f. conversion or save required. ADS Stream: (All Data Stream is only for files on NTFS drives)
  1. Return to the original firmware session, use the Browse button to locate the crt certificate file, and click Upload to enable the certification.

Vivotek Turret Dome IT9389-H - Create certificate request and install - 8

text_image SUPREME R NEE DEFINITION OF HD Home Client settings Configuration Language Security > HTTPS System Media Network Security User accounts HTTPS Access list IEEE 902.1x PTZ Event Applications Recording Local storage [ Basic mode ] Version 0100c HTTPS Enable HTTPS secure connection Mode HTTP & HTTPS C HTTPS only Certificate: Certificate Information Status: Waiting for certificated Select certificate file: C:\Documents and Se Browse... Uploaded Method: Create certificate request and install Country: TVV State or province: Asia Locality: Asia Organization: VVOTEK Inc. Organization unit: VVOTEK Inc. Common name: www.vvotek.com Remove certificate
  1. When the certificate file is successfully loaded, its status will be stated as Active. Note that a certificate must have been created and installed before you can click on the "Save" button for the configuration to take effect.

Vivotek Turret Dome IT9389-H - Create certificate request and install - 9

text_image HTTPS Enable HTTPS secure connection Mode: HTTP & HTTPS ○ HTTPS only Certificate: Certificate information Status: Active Method: Create certificate request and install Country: TW State or province: Asia Locality: Asia Organization: VIVOTEK Inc. Organization unit: VIVOTEK Inc. Common name: www.vivotek.com Certificate properties Remove certificate Save
  1. To begin an encrypted HTTPS session, click Home to return to the main page. Change the URL address from "http://" to "https://" in the address bar and press Enter on your keyboard. Some Security Alert dialogs will pop up. Click OK or Yes to enable HTTPS.

Vivotek Turret Dome IT9389-H - Create certificate request and install - 10

text_image Security Alert You are about to view pages over a secure connection. Any information you exchange with this site cannot be viewed by anyone else on the Web. In the future, do not show this warning OK More Info

Vivotek Turret Dome IT9389-H - Create certificate request and install - 11

text_image Security Information This page contains both secure and nonsecure items. Do you want to display the nonsecure items? Yes No More Info

Vivotek Turret Dome IT9389-H - Create certificate request and install - 12

text_image Security Alert Information you exchange with this site cannot be viewed or changed by others. However, there is a problem with the site's security certificate. The security certificate was issued by a company you have not chosen to trust. View the certificate to determine whether you want to trust the certifying authority. The security certificate date is valid. The name on the security certificate is invalid or does not match the name of the site Do you want to proceed? Yes No View Certificate

Security > Access List

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

General Settings

Vivotek Turret Dome IT9389-H - General Settings - 1

text_image General settings Maximum number of concurrent streaming: 10 ▼ Connection management

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:

Vivotek Turret Dome IT9389-H - General Settings - 2

text_image IP address Elapsed time User ID 172.16.2.53 00:00:05 192.168.4.104 01:49:35 Refresh Add to deny list Disconnect Close

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 108.
  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 97.
  3. The administrator has set up a root password, but allows anonymous viewing. For more information about Allow Anonymous Viewing, please refer to page 108.

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

Vivotek Turret Dome IT9389-H - Filter - 1

text_image Filter Enable access list filtering Filter type: Allow Dany IPv4 access list Add Delete IPv6 access list Add Delete

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

There are three types of rules:

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

For example:

Vivotek Turret Dome IT9389-H - Filter - 2

text_image Filter address Rule: Single IP address: 192.168.2.1 OK Cancel

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:

Vivotek Turret Dome IT9389-H - Filter - 3

text_image Filter address Rule: Network Network address / Network mask: 192.168.2.0 / 24 OK Cancel IP address range 192.168.2.x will be bolcked.

If IPv6 filter is preferred, you will be prompted by the following window. Enter the IPv6 address and the two-digit prefix length to specify the range of IP addresses in your configuration.

Vivotek Turret Dome IT9389-H - Filter - 4

text_image >Add ipv6 filter list Filter address Rule: Network Network address /Network mask: / OK Cancel

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:

Vivotek Turret Dome IT9389-H - Filter - 5

text_image Filter address Rule: Range IP address - IP address: 192.168.2.0 - 192.168.2.255 OK Cancel

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.

Vivotek Turret Dome IT9389-H - Administrator IP address - 1

text_image Administrator IP address □ Always allow the IP address to access this device Save

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:

Vivotek Turret Dome IT9389-H - Security &gt; IEEE 802.1X - 1

flowchart
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

Vivotek Turret Dome IT9389-H - Security &gt; IEEE 802.1X - 2

text_image EAP-PEAP Browse... Upload Remove

IEEE 802.1x

Vivotek Turret Dome IT9389-H - IEEE 802.1x - 1

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

Vivotek Turret Dome IT9389-H - Enable 802.1x - 1

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

Vivotek Turret Dome IT9389-H - Enable 802.1x - 2

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.

Vivotek Turret Dome IT9389-H - NOTE: - 1

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

Security > Miscellaneous

The embedded TrendMicro utility provides the protection against Cross-Site Request Forgery. Cross-site request forgery is also known as one-click attack or session riding and is abbreviated as CSRF. CSRF is a type of malicious exploit of a website, in this case, the camera. Unauthorized commands are transmitted from a user that the web application trusts, using the mechanism of forging a trusted user's own request with a request containing his own cookies, etc. Different ways can be used for a malicious website to transmit such commands. They can be specially-crafted image tags, hidden forms, and JavaScript XMLHttpRequests. The malicious attack can occur without users' interaction or even knowing it.

Miscellaneous

√ Enable Cross-Site Request Forgery(CSRF) protection.

We strongly recommend not to disable this protection. Disabling this feature will expose your camera to risks.

Save

PTZ > PTZ settings

This section explains how to control the Network Camera's Pan/Tilt/Zoom operation (available in the 3rd or the last video profile).

Digital: Control the e-PTZ operation. Within a field of view, it allows users to quickly move the focus to a target area for close-up viewing without physically moving the camera.

Digital PTZ Operation (E-PTZ Operation)

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

Vivotek Turret Dome IT9389-H - Digital PTZ Operation (E-PTZ Operation) - 1

text_image Digital Select stream: 1 (TCP-V) 2015/05/20 09:57:30 x1.8 Home Pan speed: 0 Tilt speed: 0 Zoom speed: 0 Auto pan/patrol speed: 1 Go to: -- Select one -- Home location settings Set current position as home Restore home position to default Preset and patrol settings Name: Add preset location User preset locations lower left center right upper right lower right Remove More Select Preset Locations for Patrol Patrol locations Dwell time (sec) upper left 5 left 5 lower left 5 center 5 right 5 Remove More Misc settings Zoom factor display Save

For e-PTZ related details, please refer to page 125.

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

Zoom factor display

If you check this item, the zoom indicator will be displayed on the home page when you zoom in/out the live viewing window as the picture shown on the next page.

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

Home page in the E-PTZ Mode

Vivotek Turret Dome IT9389-H - Home page in the E-PTZ Mode - 1

text_image IT9389-H-v2 Profile name: Live Manual tnggers: PTZ control: Digital Zoom Pan: Zoom Pan speed: 0 Tik speed: 0 Zoom speed: 0 Global view: Move Instantly Go to - Select one - - Select one - up right down left Powered by i.vivotek

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

Global View

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

Moving Instantly

If you check this item, the live view window will switch to the new viewing region instantly after you move the floating frame. If not selected, the process of moving from one position to another will be shown.

Click on Image

The e-PTZ function also supports "Click on Image". When you click on any point of the Global View Window or Live View Window, the viewing 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., an 800 x 600 region from out of the camera's 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.

Digital

Select stream: 2 √

Vivotek Turret Dome IT9389-H - Patrol settings - 1

natural_image River scene with multi-lane highways and modern buildings in the background under a clear blue sky (no visible text or symbols)

Vivotek Turret Dome IT9389-H - Patrol settings - 2

text_image Home Zoom Pan speed: 0 ✓ Tilt speed: 0 ✓ Zoom speed: 0 ✓ Auto pan/patrol speed: 1 ✓ Go to: -- Select one -- ✓

Home location settings

Set current position as home

Restore home position to default

Preset and patrol settings

Name: Add preset location

2

Select Preset Locations for Patrol

3

User preset locations
√ upper left
√ left
lower left
√ center
right

Remove

More

□ Patrol locations

Dwell time (sec)

□ upper left
□ left
□ lower left
□ center
□ right

Remove

▲ ▼

More

4 5

Misc settings

√ Zoom factor display

6

Vivotek Turret Dome IT9389-H - Patrol settings - 3

Vivotek Turret Dome IT9389-H - Patrol settings - 4

NOTE:

  • The Preset Positions will also be displayed on the Home page. Select one from the Go to menu, and the Network Camera will move to the selected preset position.
  • Click Patrol: The Network Camera will patrol along the selected positions repeatedly.

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.

Vivotek Turret Dome IT9389-H - Event &gt; Event settings - 1

text_image Event Name Status Sun Mon Tue Wed Thu Fri Sat Time Trigger Add Help close or Esc Key Event Trigger → Action (What to do) Ex: Motion detection, Periodically, Digital input, System boot Media (What to send) Server (Where to send) Ex Snapshot Video Clip, System log Ex Email, FTP, HTTP Server, Network storage

Event

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

Vivotek Turret Dome IT9389-H - Event - 1

text_image Event Name Status Sun Mon Tue Wed Thu Fri Sat Time Trigger Add Help Event name: Enable this event Priority Normal Detect next motion detection or digital input after 10 second(s). 1. Schedule 2. Trigger 3. Action Event Schedule Sun Mon Tue Wed Thu Fri Sat Time Always From 00:00 to 24:00 [hh mm] Save event Close

■ Event name: Enter a name for the event setting.
■ Enable this event: Select this checkbox 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 take place too frequently.

1. Schedule

Specify the period of time during which the event trigger will take effect. Please select the days of the week and the time in a day (in 24-hr time format) for the event triggering schedule. For example, you may prefer an event to be triggered only during the off-office hours.

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 the next page. Select the item to display the detailed configuration options.

■ Video motion detection

This option makes use of the built-in motion detection mechanism as a trigger source. To enable this function, you need to configure a Motion Detection Window first. For more information, please refer to Motion Detection on page 143 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

■ System boot

This option triggers the Network Camera when the power to the Network Camera is disconnected and re-connected.

■ Recording notify

This option allows the Network Camera to trigger when the recording disk is full or when recording starts to overwrite 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.

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

● Camera tampering detection

☑ Tampering detection ☐ Too dark ☐ Too bright ☐ Too blurry

Note: Please configure Camera tampering detection first

■ Manual Triggers

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.

Vivotek Turret Dome IT9389-H - ■ Manual Triggers - 1

Vivotek Turret Dome IT9389-H - ■ Manual Triggers - 2

text_image VIVOTEK www.vivotek.com Video Stream 1 Manual Trigger: 1 On Off 2 On Off 3 On Off

■ Shock detection

A shock accelerometer comes with the camera. If impact to the camera occurs, such as someone tries to destroy the camera, the impact can be detected and reported. The Shock detection configuration is found in Configuration > Applications > Shock detection.

3. Action

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

Vivotek Turret Dome IT9389-H - Action - 1

text_image Action Backup media if the network is disconnected Server Media Extra parameter SD ----None---- SD test View HTTP ----None---- nas ----None---- Create folders by date time and hour automatically View Add server Add media

■ 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 network storage (NAS). The media to back up can include snapshot images, video, or system logs depending on your event settings.

■ Configure CameraLink

The camera can be associated with another camera with responsive actions. For example, if a thermal camera detects some abnormal situations, e.g., a fire, the camera can tell another camera, say, a PTZ camera to move to a preset position to observe the current situation.

Add server

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

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

Vivotek Turret Dome IT9389-H - Add server - 1

text_image Add server Add media Server name: Email Server type Email Sender email address: Camera@vivotek.com Recipient email address: recipient@vivotek.com Server address: Ms.vivotek.tw User name: user Password: ********** Server port 25 This server requires a secure connection (SSL) FTP HTTP Network storage Test Save server Close

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

Vivotek Turret Dome IT9389-H - Server type - Email - 1

text_image The email has been sent successfully.

Vivotek Turret Dome IT9389-H - Server type - Email - 2

text_image Error in sending email.

Click Save server to enable the settings.

Note that after you configure 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.

Vivotek Turret Dome IT9389-H - Server type - Email - 3

text_image Server Media Extra parameter SD ----None ----- SD test View Email ----None ----- Add server Add media

Server type - FTP

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

Vivotek Turret Dome IT9389-H - Server type - FTP - 1

text_image Server name: FTP Server Type Email FTP Server address: ftp.vivotek.com Server port: 21 User name: vivotek Password: ••••••• FTP folder name: ✓ Passive mode HTTP Network storage Test Save server Close

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

Vivotek Turret Dome IT9389-H - ■ Passive mode - 1

text_image ftp transmission successfully.

Vivotek Turret Dome IT9389-H - ■ Passive mode - 2

text_image ftp transmission failed.

Click Save server to enable the settings.

Server type - SFTP

Select to send the media files to an SFTP (Secure File Transfer Protocol) server when a trigger is activated. This page contains the client side settings.

Vivotek Turret Dome IT9389-H - Server type - SFTP - 1

text_image Server type ○ Email ○ FTP ● SFTP Server address: 192.168.5.114 Server port: 22 Host key MD5: Scanning... please wait Get Folder name: Login mode: ○ Password ● Publickey User name: admin Pairing mode: ● Auto ○ Download ○ Upload Password: Pairing

■ Server address: Enter the SFTP server address in either the domain name or IP address.
■ Server port: By default, the FTP server port is set to 22. It can also be assigned to another port number between 1025 and 65535.
■ Host key MD5: You have the option to use public/private key authentication instead of a username and password to connect to the server. This option requires that you have a private/public SSH key pair, and that the public key is in place on your SFTP server.

If you wish to Use key authentication for this SFTP server, click the Get (Read Fingerprint) button to request the public key fingerprint from the server. The host key MD5 is a hash of the FTP server's public key, which the camera stores in order to verify that it is connecting to the correct SFTP server. You can copy that fingerprint and save it for later reference.

The max. length of MD5 fingerprint is 47 characters.

If key authentication is not preferred, you can specify a username and password in the section below.

An RSA key fingerprint will look like this: da:47:93:b4:3a:90:5b:50:1f:20:a8:f9:b7:a1:d0:e1. Verify if this is the SFTP server you want to connect to.

Vivotek Turret Dome IT9389-H - Server type - SFTP - 2

text_image 網頁訊息 Please confirm if the SFTP server( 192.168.5.114 ) is trustable for you and the host key MD5 is: fc:ee:0f:26:30:71:fb:92:3f:b3:83:1d:90:18:c3:87. 確定 取消

■ Folder name

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

Use backslash "\" when you need to specify a path. Leave it blank to use the SFTP server's default root directory. The max. length of folder name is 128 characters.

■ Login mode

Select a Login mode as either the Password or the Public key mode.

When using SFTP, you can authenticate using a public/private SSH key pair instead of a password. If key authentication is not enabled, you need to specify a password instead. The administrator of the SFTP server will need to manually add the corresponding public key to the SFTP server.

Password mode:

■ User name: Enter the login name of the SFTP account.
■ Password: Enter the password of the SFTP account.

Vivotek Turret Dome IT9389-H - Password mode: - 1

text_image Add server Add media Server name: SFTP Server type ○ Email ○ FTP ● SFTP Server address: 10.16.103.55 Server port: 22 Host key MD5: 38:e0:5d:83.7b:43.9c:06.6a:76.aef Get Folder name: Login mode: Password ○ Publickey User name: admin Password: ********** ○ HTTP ○ Network storage Test Save server Close

Use the Test button to test the connectivity. When done, enter the server name and click the Save server button to preserve your settings.

Vivotek Turret Dome IT9389-H - Password mode: - 2

text_image sftp transmission successfully Close

Publickey mode:

Selecting the Public key mode will bring up the Pairing mode options: Auto, Download, Upload.

Auto Camerawill generate a key pair and auto pair public key with the SFTP server.
DownloadCamera will generate a key pair and download the public key for the user to upload it to the SFTP server. The supported formats are: ED25519 (default.Elliptic curve signature scheme Edwards-curve Digital Signature Algorithm; with faster key creation, encryption and decryption), RSA (Rivest-Shamir-Adleman, with greater portability), ECDSA (Elliptic Curve Digital Signature Algorithm).
Upload Uploadthe private key here and upload the public key to the SFTP server.A private key is a guarded secret and it can be stored on disk in an encrypted form. A passphrase is used in order to decrypt it. It is a login password to the SSH server, the passphrase is only used to decrypt the private key on the local system. The passphrase is not transmitted over the network.

When using SFTP, you can authenticate using a public/private SSH key pair instead of a password. If key authentication is not enabled, you need to specify a password instead. The administrator of the SFTP server will need to manually add the corresponding public key to the SFTP server.

The key benefit of a key-based authentication is that instead of a using a password, you are less vulnerable to brute-force attacks and you do not expose valid credentials, if the server has been compromised.

Vivotek Turret Dome IT9389-H - Publickey mode: - 1

text_image Server name: Server type ○ Email ○ FTP ● SFTP Server address: 192.168.5.114 Server port: 22 Host key MD5: Get Folder name: Login mode: ○ Password ● Publickey User name: Pairing mode: ● Auto ○ Download ○ Upload Password: Pairing ○ HTTP ● Network storage Test Save server Close Camera will generate a key pair and download the public key for the user to upload it to the SFTP server.

Server type - HTTP

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

Vivotek Turret Dome IT9389-H - Server type - HTTP - 1

text_image Server name: HTTP Server Type Email FTP HTTP URL: http://192.168.5.10/cgi-bin/upload.cgi User name: Password: Network storage Test Save server Close

■ 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 shown below. If successful, you will receive a test.txt file on the HTTP server.

Vivotek Turret Dome IT9389-H - Server type - HTTP - 2

text_image HTTP Transmission successfully. Thanks

Vivotek Turret Dome IT9389-H - Server type - HTTP - 3

text_image HTTP Transmission failed.

Click Save server to enable the settings.

Network storage:

Select to send the media files to a networked storage when a trigger is activated. Please refer to NAS server on page 154 for details. Note that only one NAS server can be configured.

Click Save server to enable the settings.

Vivotek Turret Dome IT9389-H - Network storage: - 1

text_image Action Backup media if the network is disconnected Server Media Extra parameter SD None SD test View Email None FTP None HTTP None NAS None Create folders by date time and hour automatically View Add server Add media Close Save event

■ SD Test: Click to test your SD card. The system will display a message indicating the result as a success or a failure. If you want to use your SD card for local storage, please format it before use. Please refer to page 139 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 for an SD card, a Local storage page will prompt so that you can manage the recorded files on SD card. For more information about Local storage, please refer to page 156. If you click the View button for a Network storage, a file directory window will prompt for you to view recorded data on Network storage. For detailed illustration, please refer to the next page.
■ Create folders by date, time, and hour automatically: If you select this item, the system will automatically create folders by the date when video footages are stored onto the networked storage.

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

Vivotek Turret Dome IT9389-H - Network storage: - 2

text_image 20210120 20210121 20210122 The format is: YYYYMMDD Click to open the directory Delete Delete all Click to delete all recorded data elected items

Click 20210120 to open the directory:

The format is: HH (24r)

Click to open the file list for that hour

Vivotek Turret Dome IT9389-H - The format is: HH (24r) - 1

text_image < 07 08 09 10 11 12 13 14 15 16 17 > file name size date time Recording1 58.mp4 2526004 2021/01/20 07:58:28 Recording1 59.mp4 2563536 2021/01/20 07:59:28 Delete Delete all Back Click to delete selected items Click to delete all recorded data Click to go back to the previous level of the directory

Vivotek Turret Dome IT9389-H - The format is: HH (24r) - 2

text_image < 07 08 09 10 11 12 13 14 15 16 17 ≥ file name size date time Recording1 58.mp4 2526004 2021/01/20 07:58:28 Recording1 59.mp4 2563536 2021/01/20 07:59:28 Delete Delete all Back

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.

Vivotek Turret Dome IT9389-H - Add media - 1

text_image Add server Add media Media name: Media type Attached media: ○ Snapshot ● Video clip Source: Live view Pre-event recording: 0 seconds [0~9] Maximum duration: 5 seconds [1~20] Maximum file size: 500 Kbytes [50~4096] File name prefix: ○ System log Save media Close

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 profiles.
■ Send □ pre-event images

The Network Camera has a buffer to temporarily hold data up to a certain limit. Enter a number to decide how many images to capture before a trigger is activated. Up to 7 images can be generated.

■ Send □ post-event images

Enter a number to decide how many images to capture after a trigger is activated. Up to 7 images can be generated.

For example, if both the Send pre-event images and Send post-event images are set to 7, a total of 15 images can be generated after a trigger is activated.

Vivotek Turret Dome IT9389-H - Media type - Snapshot - 1

text_image 1 pic. 2 pic. 3 pic. 4 pic. 5 pic. 6 pic. 7 pic. 8 pic. 9 pic. 10 pic. 11 pic. 10 pic. 12 pic. 13 pic. 14 pic. 15 pic. Trigger Activation

■ File name prefix

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

■ Add date and time suffix to the file name

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

For example:

Vivotek Turret Dome IT9389-H - Media type - Snapshot - 2

text_image Snapshot_20210513_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS

Click Save media to enable the settings.

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

Media type - Video clip

Select to send video clips when a trigger is activated.

Vivotek Turret Dome IT9389-H - Media type - Video clip - 1

text_image Media name: Media type Attached media: ○ Snapshot ● Video clip Source: Profilef827 Pre-event recording: 0 seconds [0~9] Maximum duration: 5 seconds [1~20] Maximum file size: 500 Kbytes [50~4096] File name prefix: ○ System log Save media Close

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

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

■ Maximum duration

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

Vivotek Turret Dome IT9389-H - Media type - Video clip - 2

text_image 1 sec. 2 sec. 3 sec. 4 sec. 5 sec. 6 sec. 7 sec. 8 sec. 9 sec. 10 sec. Trigger Activation

■ Maximum file size

Specify the maximum file size allowed. Some users may need to stitch the video clips together when searching and packing up forensic evidence.

■ File name prefix

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

For example:

Vivotek Turret Dome IT9389-H - Media type - Video clip - 3

text_image Video_20210513_100341 File name prefix Date and time suffix The format is: YYYYMMDD_HHMMSS

Click Save media to enable the settings.

Media type - System log

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

Vivotek Turret Dome IT9389-H - Media type - System log - 1

text_image Media name: System log | Media Type Attached media: Snapshot Video Clip System log Save media Close

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

Vivotek Turret Dome IT9389-H - Media type - System log - 2

text_image Action Backup media if the network is disconnected Server Media Extra parameter SD ----None ---- SD test View mail ----None ---- None Add serve email log snapshot Save event Close

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

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

Please see the example of the Event setting page below:

Event
Vivotek Turret Dome IT9389-H - Media type - System log - 3

text_image Name Status Sun Mon Tue Wed Thu Fri Sat Time Trigger event1 ON V V V V V V V V 00:00~24:00 seq Delete Add Help

Server settings
Vivotek Turret Dome IT9389-H - Media type - System log - 4

text_image Name Type Address/Location HTTP http http://192.168.5.10 Delete Add

Media
Vivotek Turret Dome IT9389-H - Media type - System log - 5

text_image Available memory space: 13000KB Name Type Snapshot snapshot Delete Video clip videoclip Delete System log systemlog Delete Add

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

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

To remove a server setting from the list, select a server name from the drop-down list and click Delete. Note that you can only delete a server setting when it is not applied in an existing 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 in an existing event setting.

Applications > Motion detection

Vivotek Turret Dome IT9389-H - Applications &gt; Motion detection - 1

NOTE:

- Due to system resources concern, the motion tracking blocks and the Human detection area will not display when running motion detection on this model.

The camera comes with a Smart Motion Detection utility as its pre-loaded VCA package. Please refer to its User Guide for more information:

http://download.vivotek.com/downloadfile/solutions/vadp/smart-motion-detection-manual_en.pdf.

Click on Configuration > Applications > Motion detection. The Smart Motion utility will be automatically started.

If Human detection is applied, make sure you measured the height of your camera at the installation site. It is important for a correct video analysis. You should enter the installation height in the Motion detection Settings page.

Vivotek Turret Dome IT9389-H - NOTE: - 1

text_image IB9387-H Smart Motion Detection Main Scheduled 2018/10/14 05:51 Motion Window 0 1 2 3 4 Set up camera installation (Human detection only) Create motion windows Adjust sensitivity Set trigger level Time filter ① Minimum activity duration 500 millimeters Activity merge interval 1500 millimeters Show Discard

Vivotek Turret Dome IT9389-H - NOTE: - 2

text_image 10938744 Smart Motion Detection Main Scheduled Settings Camera Installation Export & restore Human detection only Camera height 0 cm Camera angle Φ ■ Auto: TIR 171° Rol: $14' ○ Manual: TIR 0 Rol: 0 TIR ROL Bullet Exame Set up camera installation first

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.

Vivotek Turret Dome IT9389-H - Applications &gt; Tampering detection - 1

text_image Camera tampering detection □ Tampering detection Trigger duration 10 seconds [10~600] Trigger threshold 12 [0~100] □ Image too dark detection Trigger duration 2 seconds [1~10] Trigger threshold 15 [0~100] □ Image too bright detection Trigger duration 2 seconds [1~10] Trigger threshold 15 [0~100] □ Image too blurry detection Trigger duration 7 seconds [1~10] Trigger threshold 12 [0~100]

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

  1. Click to select the checkbox before tampering conditions: Tampering detection, Image too dark, Image too bright, and Image too blurry. Enter the tamper trigger duration. (10 sec. \~ 10 min.). The duration specifies the set of time before the tampering is considered as a real alarm. This helps avoid false alarms by short-lived changes.

The tamper alarm will be triggered only when the tampering factor (the difference between current frame and pre-saved background) exceeds the trigger threshold. Conditions such as image too dark, too bright, or too blurry (defocused) can also be configured as tampering conditions. The Trigger threshold determines how sensitive your is tamper detection setting. Lower the threshold number, easier to trigger.

Too bright: shining a flash light. The average lighting level of the scene is taken into consideration.

Too dark: covering the objective or spraying paint.

Too blurry: blurry scene can be the result of strong interference on the device, such as EMI interference.

  1. You can configure Tampering Detection as a trigger element to the proactive event configurations in Event -> Event settings -> Trigger. For example, when the camera is tampered with, camera can be configured to send the pre- and post-event video clips to a networked storage device. Please refer to page 128 for detailed information.

Applications > Smart VCA

Smart VCA provides the following features:

Intrusion detection, Loitering detection, Missing object detection, Unattended Object detection, Line Crossing detection, and Face detection.

Please refer to Smart VCA's user documentation for more information.

Click on Configuration > Applications > Smart VCA. The Smart VCA utility will be automatically started. The Smart Motion detection and Smart VCA share the same utility window.

If Smart VCA is applied, make sure you measured the height of your camera at the installation site. It is important for a correct video analysis. You should enter the installation height in the Smart VCA Settings page.

Vivotek Turret Dome IT9389-H - Applications &gt; Smart VCA - 1

text_image FE9382-EHV-v2 Smart Motion Detection Main Scheduled (TCP-V) 2000/12 07:23:14 ① Set up camera installation (People detection only) ② Create motion windows ③ Adjust sensitivity ④ Set trigger level

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.

Vivotek Turret Dome IT9389-H - Applications &gt; Audio detection - 1

line | Time | Alarm Level | Volume | |------|-------------|--------| | 1 | 60 | 60 | | 2 | 60 | 60 | | 3 | 60 | 60 | | 4 | 60 | 60 | | 5 | 60 | 60 | | 6 | 60 | 60 | | 7 | 60 | 60 | | 8 | 60 | 60 | | 9 | 60 | 60 | | 10 | 60 | 60 | | 11 | 60 | 60 | | 12 | 60 | 60 | | 13 | 60 | 60 | | 14 | 60 | 60 | | 15 | 60 | 60 | | 16 | 60 | 60 | | 17 | 60 | 60 | | 18 | 60 | 60 | | 19 | 60 | 60 | | 20 | 60 | 60 | | 21 | 60 | 60 | | 22 | 60 | 60 | | 23 | 60 | 60 | | 24 | 60 | 60 | | 25 | 60 | 60 | | 26 | 60 | 60 | | 27 | 60 | 60 | | 28 | 60 | 60 | | 29 | 60 | 60 | | 30 | 60 | 60 | | 31 | 60 | 60 | | 32 | 60 | 60 | | 33 | 60 | 60 | | 34 | 60 | 60 | | 35 | 60 | 60 | | 36 | 60 | 60 | | 37 | 60 | 60 | | 38 | 60 | 60 | | 39 | 60 | 60 | | 40 | 60 | 60 | | 41 | 60 | 60 | | 42 | 60 | 60 | | 43 | 60 | 60 | | 44 | 60 | 60 | | 45 | 60 | 60 | | 46 | 60 | 60 | | 47 | 60 | 60 | | 48 | 60 | 60 | | 49 | 60 | 60 | | 50 | 60 | 60 | | 51 | 60 | 60 | | 52 | 60 | 60 | | 53 | 60 | 60 | | 54 | 60 | 60 | | 55 | 60 | 60 | | 56 | 60 | 60 | | 57 | 60 | 60 | | 58 | 60 | 60 | | 59 | 60 | 60 | | 60 | 60 | 60 | | 61 | 60 | 60 | | 62 | 60 | 60 | | 63 | 60 | 60 | | 64 | 60 | 60 | | 65 | 60 | 60 | | 66 | 60 | 60 | | 67 | 60 | 60 | | 68 | 60 | 60 | | 69 | 60 | 60 | | 70 | 60 | 60 | | 71 | 60 | 60 | | 72 | 60 | 60 | | 73 | 60 | 60 | | 74 | 60 | 60 | | 75 | 60 | 60 | | 76 | 60 | 60 | | 77 | 60 | 60 | | 78 | 60 | 60 | | 79 | 60 | 60 | | 80 | 60 | 60 | | 81 | 60 | 60 | | 82 | 60 | 60 | | 83 | 60 | 60 | | 84 | 60 | 60 | | 85 | 60 | 60 | | 86 | 60 | 60 | | 87 | 60 | 60 | | 88 | 60 | 60 | | 89 | 60 | 60 | | 90 | - | - | | Peak (approx) - Volume - Scale - Enable Audio detection Profile Save Save

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.

Vivotek Turret Dome IT9389-H - Applications &gt; Audio detection - 2

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.

Applications > Shock detection

The camera comes with a shock accelerometer. The shock sensor can detect impacts to the camera. For example, when a person deliberately tries to destroy the camera, the camera can report the event to the administrator.

Normally, a 5kgm impact can cause the detected impact level to surge to 50% on the scale. Configure the Alarm Level to a preferred percentage on the chart. Click the Enable shock detector checkbox and click Save to complete the configuration.

Vivotek Turret Dome IT9389-H - Applications &gt; Shock detection - 1

line | Time | Alarm Level | Shock Level | |------|-------------|-------------| | 0 | 15 | 0 | | 1 | 15 | 0 | | 2 | 15 | 0 | | 3 | 15 | 0 | | 4 | 15 | 0 | | 5 | 15 | 0 | | 6 | 15 | 0 | | 7 | 15 | 0 | | 8 | 15 | 0 | | 9 | 15 | 0 | | 10 | 15 | 0 | | 11 | 15 | 0 | | 12 | 15 | 0 | | 13 | 15 | 0 | | 14 | 15 | 0 | | 15 | 15 | 0 | | 16 | 15 | 0 | | 17 | 15 | 0 | | 18 | 15 | 0 | | 19 | 15 | 0 | | 20 | 15 | 0 | | 21 | 15 | 0 | | 22 | 15 | 0 | | 23 | 15 | 0 | | 24 | 15 | 0 | | 25 | 15 | 0 | | 26 | 15 | 0 | | 27 | 15 | 0 | | 28 | 15 | 0 | | 29 | 15 | 0 | | 30 | 15 | 0 | | 31 | 15 | 0 | | 32 | 15 | 0 | | 33 | 15 | 0 | | 34 | 15 | 0 | | 35 | 15 | 0 | | 36 | 15 | 0 | | 37 | 15 | 0 | | 38 | 15 | 0 | | 39 | 15 | 0 | | 40 | 15 | 0 | | 41 | 15 | 0 | | 42 | 15 | 0 | | 43 | 15 | 0 | | 44 | 15 | 0 | | 45 | 15 | 0 | | 46 | 15 | 0 | | 47 | 15 | 0 | | 48 | 15 | 0 | | 49 | 15 | 0 | | 50 | 15 | 0 | | 51 | 15 | 0 | | 52 | 15 | 0 | | 53 | 15 | 0 | | 54 | 15 | 0 | | 55 | 15 | 0 | | 56 | 15 | 0 | | 57 | 15 | 0 | | 58 | 15 | 0 | | 59 | 15 | 0 | | 60 | 15 | 0 | | 61 | 15 | 0 | | 62 | 15 | 0 | | 63 | 15 | 0 | | 64 | 15 | 0 | | 65 | 15 | 0 | | 66 | 15 | 0 | | 67 | 15 | 0 | | 68 | 15 | 0 | | 69 | 15 | 0 | | 70 | 15 | 0 | | 71 | 15 | 0 | | 72 | 15 | 0 | | 73 | 15 | 0 | | 74 | 15 | 0 | | 75 | 15 | 0 | | 76 | 15 | 0 | | 77 | 15 | 0 | | 78 | 15 | 0 | | 79 | 15 | 0 | | 80 | 15 | 0 | | 81 | 15 | 0 | | 82 | 15 | 0 | | 83 | 15 | 0 | | 84 | 15 | 0 | | 85 | 15 | 0 | | 86 | 15 | 0 | | 87 | 15 | 0 | | 88 | 15 | 0 | | 89 | 15 | 0 | | 90 | 15 | 0 | | Note: The actual values for Shock Level and Alarm Level are not provided in the code. The code does not provide the exact values from the data. The labels for Shock Level and Alarm Level are estimated based on the code. There is only one data series in this case. The values for Alarm Level are estimated based on the code. You would need to run the code if you want to detect the shock level. You would need to run the code if you want to detect the shock level. You would need to run the code if you want to detect the shock level. You would need to run the code if you want to detect the shock level. You would need to run the code if you want to detect the shock level. You would need to run the code if you want to detect the shock level. You would need to run the code if you want to detect the shock level. You would then run the code if you want to detect the shock level. You would then run the code if you want to detect the shock level. You would then run the code if you want to detect the shock level. You would then run the code if you want to detect the shock level. You would then run the code if you want to detect the shock level. You would then run the code if you want to detect the shock level. You would then run the code if you want to detect the knockdown of the shock level. You would then run the code if you want to detect the shock level. You would then run the code if you want to detect the shock level. You would then run the code if you want to detect the shock level. You would then run the code if you want to detect the shock level. You would then run the code if you want to detect the shock level. You would then run the code if you want to detect the shock level. You would then run the codes that use a single data point (e.g., “Shock Level” or “Alarm Level”) in either direction. The code does not use a separate data series (e.g., “Enable shock detection”).

You should then go to Event settings to configure the shock detection as a triggering source. See page 127 for Event configuration.

The measurement range of the sensor is ±16G .

For every one G force (g = 9.8 m/s ^2 ) perceived, the sensor acquires a reading of 512.

The value acquired by a 2 G acceleration will look like the following:

$$ 5 1 2 * 2 / 1 6 = 6 4 $$

Suppose that all 3-axis readings are equal (for simplicity reasons only), the shock level shown on the Shock detection chart will be (64 + 64 + 64) × 100 / 1024 = 18.75 .

Applications > Package management - a.k.a., VADP (VIVOTEK Application Development Platform)

The IB9365-HT is the first camera line to come embedded with the Smart Motion Detection feature. The Smart Motion detection, with Human detection and tunable time filter, can eliminate the defects of traditional motion detection and facilitate the configuration at a surveillance site.

To learn more about this feature, download its User Guide in: http://download.vivotek.com/downloadfile/solutions/vadp/smart-motion-detection-manual_en.pdf

Vivotek Turret Dome IT9389-H - Applications &gt; Package management - a.k.a., VADP (VIVOTEK Application Development Platform) - 1

text_image Upload package Save to SD card Select file Browse... Upload Resource status Storage status: storage_size: 10240 KBytes Free size: 10240 KBytes SD card status: Detached Total size: 0 KBytes Free size: 0 KBytes Used size: 0 KBytes Use (%): 0 % Memory status: Total size: 24576 KBytes Free size: 24576 KBytes Package list Module name Vendor Version Status License Backup Reload Restore Start Stop

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:

Vivotek Turret Dome IT9389-H - Applications &gt; Package management - a.k.a., VADP (VIVOTEK Application Development Platform) - 2

text_image : Starting VADP upload procedure, please wait a moment... Uploading new module: Hello World / ABC Update configuration... . Reloading configuration httpd: . Upload VADP package successfully

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

Vivotek Turret Dome IT9389-H - Applications &gt; Package management - a.k.a., VADP (VIVOTEK Application Development Platform) - 3

text_image Package list Module name Vendor Version Status(License Hello World ABC 1.0.0 ON=yes Backup Reload Restore Start Stop

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.

Vivotek Turret Dome IT9389-H - Applications &gt; Package management - a.k.a., VADP (VIVOTEK Application Development Platform) - 4

text_image Package list Module name Vendor Version Status(License Hello World ABC 1.0.0 ON=no Backup Reload Restore Start Stop

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

Vivotek Turret Dome IT9389-H - Applications &gt; Package management - a.k.a., VADP (VIVOTEK Application Development Platform) - 5

text_image Do you want to delete the VADP module? Yes No

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

On the License page, register and activate the license for using VIVOTEK's VADP modules. You should acquire the license key elsewhere, and manually upload to the network camera.

Follow the onscreen instruction on VIVOTEK's website for the registration procedure.

Status

License

Manual License

To receive a license key for VADP application, go to http://www.vivotek.com and join the VWTK member. This device's VADP number is:

BbM79RE=OdGu1PIUEqJRFgc6sacoRs7g4PXI 

Select file

Browse...

No file selected.

Upload

Recording > Recording settings

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

Recording Settings
Vivotek Turret Dome IT9389-H - Recording &gt; Recording settings - 1

text_image Insert your SD card and click here to test Recording settings Name Status Sun Mon Tue Wed Thu Fri Sat Time Source Destination Delete Add SD test Note: Before setup recording, you may setup network storage via NAS server page

Vivotek Turret Dome IT9389-H - Recording &gt; Recording settings - 2

NOTE:

▶ Please remember to format your SD card via the camera's web console (in the Local storage . SD card management page) when using it for the first time. Please refer to page 156 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.

Vivotek Turret Dome IT9389-H - Recording Settings - 1

text_image Recording name: video Enable this recording With adaptive recording Pre-event recording: 5 seconds [0~9] Post-event recording: 5 seconds [0~10] Priority: Normal Source: Stream 1 1. Trigger 2. Destination Trigger Schedule Sun Mon Tue Wed Thu Fri Sat Time Always From 00:00 to 24:00 [hh:mm] Network fail Note: To enable recording notification please configure Event first Close Save

■ Recording name: Enter a name for the recording setting.
■ Enable this recording: Select this option to enable video recording.
■ With adaptive recording:

Select this option will activate the frame rate control according to alarm trigger.

The frame control means that when there is a triggered alarm, the frame rate will raise up to the value you've configured on the Video quality page. Please refer to page 80 for more information.

If you enable adaptive recording on a camera, only when an event is triggered on Camera A will the server record the full frame rate streaming data; otherwise, it will only request the I frame data during normal monitoring, thus effectively saves bandwidths and storage space.

Vivotek Turret Dome IT9389-H - Recording Settings - 2

text_image ① ② ③ ④ I frame ----> Full frame rate ----> I frame

Vivotek Turret Dome IT9389-H - Recording Settings - 3

line | Time | Bandwidth | |------|-----------| | Continuous recording | 0 | | Activity Adaptive Streaming for Dynamic Frame Rate Control | 1 | | Activity Adaptive Streaming for Dynamic Frame Rate Control | 0 |

Vivotek Turret Dome IT9389-H - Recording Settings - 4

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 the 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 127.

■ Pre-event recording and post-event recording
The Network Camera has a buffer that temporarily holds data for a period of time. Therefore, when an event occurs, the camera can restore image frames taken several seconds ago. Enter a number to define the duration of recording before and after a trigger is activated.
■ Priority: Select the relative importance of this recording (High, Normal, or Low). Recording with a higher priority setting will be executed first.
■ Source: Select a video stream as the recording source.

Vivotek Turret Dome IT9389-H - NOTE: - 1

NOTE:

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

Please follow the steps below to set up the recording.

1. Trigger

Select a trigger source.

Trigger

Schedule

Vivotek Turret Dome IT9389-H - Trigger - 1

Vivotek Turret Dome IT9389-H - Trigger - 2

Vivotek Turret Dome IT9389-H - Trigger - 3

Vivotek Turret Dome IT9389-H - Trigger - 4

Vivotek Turret Dome IT9389-H - Trigger - 5

Vivotek Turret Dome IT9389-H - Trigger - 6

Vivotek Turret Dome IT9389-H - Trigger - 7

Vivotek Turret Dome IT9389-H - Trigger - 8

Vivotek Turret Dome IT9389-H - Trigger - 9

Vivotek Turret Dome IT9389-H - Trigger - 10

Vivotek Turret Dome IT9389-H - Trigger - 11

Vivotek Turret Dome IT9389-H - Trigger - 12

Vivotek Turret Dome IT9389-H - Trigger - 13

Vivotek Turret Dome IT9389-H - Trigger - 14

Vivotek Turret Dome IT9389-H - Trigger - 15

Vivotek Turret Dome IT9389-H - Trigger - 16

Vivotek Turret Dome IT9389-H - Trigger - 17

Time

Vivotek Turret Dome IT9389-H - Trigger - 18

Vivotek Turret Dome IT9389-H - Trigger - 19

Vivotek Turret Dome IT9389-H - Trigger - 20

Vivotek Turret Dome IT9389-H - Trigger - 21

Vivotek Turret Dome IT9389-H - Trigger - 22

Vivotek Turret Dome IT9389-H - Trigger - 23

Vivotek Turret Dome IT9389-H - Trigger - 24

Vivotek Turret Dome IT9389-H - Trigger - 25

Vivotek Turret Dome IT9389-H - Trigger - 26

Vivotek Turret Dome IT9389-H - Trigger - 27

Vivotek Turret Dome IT9389-H - Trigger - 28

Vivotek Turret Dome IT9389-H - Trigger - 29

Vivotek Turret Dome IT9389-H - Trigger - 30

Vivotek Turret Dome IT9389-H - Trigger - 31

Vivotek Turret Dome IT9389-H - Trigger - 32

Vivotek Turret Dome IT9389-H - Trigger - 33

Vivotek Turret Dome IT9389-H - Trigger - 34

Vivotek Turret Dome IT9389-H - Trigger - 35

Vivotek Turret Dome IT9389-H - Trigger - 36

Vivotek Turret Dome IT9389-H - Trigger - 37

Vivotek Turret Dome IT9389-H - Trigger - 38

Vivotek Turret Dome IT9389-H - Trigger - 39

Vivotek Turret Dome IT9389-H - Trigger - 40

Vivotek Turret Dome IT9389-H - Trigger - 41

Vivotek Turret Dome IT9389-H - Trigger - 42

Vivotek Turret Dome IT9389-H - Trigger - 43

Vivotek Turret Dome IT9389-H - Trigger - 44

Vivotek Turret Dome IT9389-H - Trigger - 45

Vivotek Turret Dome IT9389-H - Trigger - 46

Vivotek Turret Dome IT9389-H - Trigger - 47

Vivotek Turret Dome IT9389-H - Trigger - 48

Vivotek Turret Dome IT9389-H - Trigger - 49

Vivotek Turret Dome IT9389-H - Trigger - 50

Vivotek Turret Dome IT9389-H - Trigger - 51

Vivotek Turret Dome IT9389-H - Trigger - 52

Vivotek Turret Dome IT9389-H - Trigger - 53

Vivotek Turret Dome IT9389-H - Trigger - 54

Vivotek Turret Dome IT9389-H - Trigger - 55

Vivotek Turret Dome IT9389-H - Trigger - 56

Vivotek Turret Dome IT9389-H - Trigger - 57

Vivotek Turret Dome IT9389-H - Trigger - 58

Vivotek Turret Dome IT9389-H - Trigger - 59

Vivotek Turret Dome IT9389-H - Trigger - 60

Vivotek Turret Dome IT9389-H - Trigger - 61

Vivotek Turret Dome IT9389-H - Trigger - 62

Vivotek Turret Dome IT9389-H - Trigger - 63

Vivotek Turret Dome IT9389-H - Trigger - 64

Vivotek Turret Dome IT9389-H - Trigger - 65

Vivotek Turret Dome IT9389-H - Trigger - 66

Vivotek Turret Dome IT9389-H - Trigger - 67

Vivotek Turret Dome IT9389-H - Trigger - 68

Vivotek Turret Dome IT9389-H - Trigger - 69

Vivotek Turret Dome IT9389-H - Trigger - 70

Vivotek Turret Dome IT9389-H - Trigger - 71

Vivotek Turret Dome IT9389-H - Trigger - 72

Vivotek Turret Dome IT9389-H - Trigger - 73

Vivotek Turret Dome IT9389-H - Trigger - 74

Vivotek Turret Dome IT9389-H - Trigger - 75

Vivotek Turret Dome IT9389-H - Trigger - 76

Vivotek Turret Dome IT9389-H - Trigger - 77

Vivotek Turret Dome IT9389-H - Trigger - 78

Vivotek Turret Dome IT9389-H - Trigger - 79

Vivotek Turret Dome IT9389-H - Trigger - 80

Vivotek Turret Dome IT9389-H - Trigger - 81

Vivotek Turret Dome IT9389-H - Trigger - 82

Vivotek Turret Dome IT9389-H - Trigger - 83

Vivotek Turret Dome IT9389-H - Trigger - 84

Vivotek Turret Dome IT9389-H - Trigger - 85

Vivotek Turret Dome IT9389-H - Trigger - 86

Vivotek Turret Dome IT9389-H - Trigger - 87

Vivotek Turret Dome IT9389-H - Trigger - 88

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

Vivotek Turret Dome IT9389-H - Destination - 1

text_image Priority: Normal Source: Stream 1 1. Trigger Destination Destination: NAS Capacity: Entire free space Reserved space: 100 Mbytes Enable cyclic recording Recording file management Maximum duration: 1 minutes [1~30] Maximum file size: 100 MB [100~2000] File name prefix: Note: To enable recording notification please configure Event first Save Close

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:

Vivotek Turret Dome IT9389-H - NAS server - 1

flowchart
graph TD
    A["1. Trigger"] --> B["2. Destination"]
    B --> C["Add NAS server"]
    C --> D["Server name: NAS"]
    D --> E["Server type"]
    E --> F["Network storage"]
    F --> G["Network storage location: \192.168.5.12\NAS"]
    G --> H["(For example: \my_nas\disk\folder)"]
    H --> I["Workgroup: vivotek"]
    I --> J["User name: ritiali"]
    J --> K["Password: ********..."]
    K --> L["Test"]
    K --> M["Close"]
    K --> N["Save server"]
  1. Click Test to check the setting. The result will be shown in the pop-up window.

Vivotek Turret Dome IT9389-H - NAS server - 2

text_image http://192.168.5.151/cgi-bin/admin/testserver... Mount successfully. Thanks Done Internet

Vivotek Turret Dome IT9389-H - NAS server - 3

text_image http://192.168.5.151/cgi-bin/admin/testserver... Mount failed. Done Internet

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

Vivotek Turret Dome IT9389-H - NAS server - 4

text_image 10.22.22.225 Organize Search active directory Network and Sharing Center View remote printers Favorites Desktop Downloads Recent Places Libraries Documents Music Pictures Videos Computer Network derek1 Share Shortcut to test Shortcut 1 KB. test - Notepad File Edit Format View Help [NOTIFICATION]The Result of Server Test of Your IP File Station DSI_network_share 上接 新建 帮助 工具 邮件 DSI313air DSI_network_share + Anycle + 0002019059008 + 200001001 + 00 + 10 + 11 + 12 + 13 + 200001002 + 05 + NCMP 名称 类型 修改日期 Anycle 查找点 2020-06-03 13:23:04 0002019059008 查找点 2020-06-04 00:50:43 txt.txt 38 bytes TXT 程序 2020-06-03 13:21:32
  1. Enter a server name.
  2. Click Save to complete the settings and click Close to exit the page.

Vivotek Turret Dome IT9389-H - NAS server - 5

text_image Recording name: Enable this recording With adaptive recording (Help) Pre-event recording: 5 seconds [0-9] Post-event recording: 5 seconds [0-10] Priority: Normal Source: Stream 1 Destination Destination: NAS Capacity: Entire free space Reserved space: 100 Mbytes Enable cyclic recording Recording file management Maximum duration: 1 minutes [1-30] Maximum file size: 100 MB [100-900] File name prefix: 1. Trigger 2. Destination Note: To enable recording notification please configure Event first Save Close

■ 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. The reserved space is a small amount of space used only for the transaction stage when the capacity is about to be used up or recycled.
■ Enable cyclic recording: If you check this item, when the maximum capacity is reached, the oldest file will be overwritten by the latest one. The reserved amount is reserved for the transaction stage when the storage space is about to be full and new data arrives. The minimum for the Reserved space must be larger than 15 MegaBytes.
■ Recording file management: You can manually assign the Maximum duration and the Maximum file size for each recording footage. You may need to stitch individual files together under some circumstances. You may also designate a file name prefix by filling in the responsive text field.
■ File name prefix: Enter the text that will be appended to the front of the file name.

f you want to enable recording notification, please click Event to configure event triggering settings. Please refer to Event > Event settings on page 127 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.

Vivotek Turret Dome IT9389-H - NAS server - 6

text_image Recording settings Name Status Sun Mon Tue Wed Thu Fri Sat Time Source Destination Delete recording ON V V V V V V V 00:00~24:00 sream1 NAS Delete Add SD test

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

Vivotek Turret Dome IT9389-H - NAS server - 7

text_image 20210210 20210211 20210212 Delete Delete all

Storage

Vivotek Turret Dome IT9389-H - Storage - 1

NOTE:

  • It is recommended to turn OFF the recording activity before you remove an SD card from the camera.
  • The lifespan of an SD card is limited. Regular replacement of the SD card can be necessary.
  • Camera filesystem takes up several megabytes of memory space. The storage space cannot be used for recording.
  • Using an SD card that already contains data recorded by another device should not be used in this camera.
  • Please do not modify or change the folder names in the SD card. That may result in camera malfunctions.

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.

Vivotek Turret Dome IT9389-H - SD card staus - 1

text_image SD card status SD card status: Detached → no SD card Total size: 0 KBytesFree size:0 KBytes Used size:0 KBytesUse (%): 0 % Format

Vivotek Turret Dome IT9389-H - SD card staus - 2

text_image SD card status SD card status: Ready File system: FAT32 Total size: 15323496 KBytes Free size: 15087976 KBytes Used size: 235520 KBytes Use (%): 1.537 %

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 unless using some 3rd-party software.

Vivotek Turret Dome IT9389-H - SD card format - 1

text_image SD card format Ext4 Ext4 FAT32 Format

SD card control

Vivotek Turret Dome IT9389-H - SD card control - 1

text_image SD card control Enable cyclic storage Enable automatic disk cleanup Maximum duration for keeping files: 7 days Save

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

Storage > NAS management

NAS Setup

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

  1. Fill in the information for the access to the shared networked storage.

For example:

Vivotek Turret Dome IT9389-H - NAS Setup - 1

text_image NAS setup Network storage location: \DS213air\DS_network_share (For example: \my_nas\disk\folder) Workgroup: WORKGROUP User name: admin Password: •••••••••••••••• Test Mount Unmount
  1. Click Test to check the setting. The result will be shown in the pop-up window.

Vivotek Turret Dome IT9389-H - NAS Setup - 2

text_image http://192.168.5.151/cgi-bin/admin/testserver... Mount succeeded.

Vivotek Turret Dome IT9389-H - NAS Setup - 3

text_image http://192.168.5.151/cgi-bin/admin/testserver... Mount failed. Done Internet

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

Vivotek Turret Dome IT9389-H - NAS Setup - 4

text_image 10.22.22.22S [10.22.22.22S] Organize Search active directory Network and Sharing Center View remote printers Favorites Desktop Downloads Recent Places Libraries Documents Music Pictures Videos Computer Network derek1 Share Shortcut to test Shortcut: 1 LB test - Notepad File Edit Format View Help [NOTIFICATION]The Result of Server Test of Your IP Car File Station DS_network_share DS213alr DS_network_share * #recycle 8002D:1W05R05 20000101 * 09 * 13 * 11 * 12 * 13 * 20000102 * 05 * NCMF 文件 编辑类型 资料库 2020-06-03 13:23:06 复制 2020-06-04 08:50:43 test.txt SB bytes TXT 编辑 2020-06-03 13:21:32
  1. Click Mount to complete the settings.

NAS management

■ Minimum reserved storage space: The reserved space can be used as a safe buffer especially when the cyclic recording function is enabled, during the transaction stage when a storage space is full and the incoming streaming data is about to overwrite the previously saved videos.
■ Enable cyclic storage: Allows previous recordings to be overwritten by new recordings.
■ Enable automatic disk cleanup: Allows you to specify how long the recording files will be kept on the NAS storage.

Maximum duration for keeping files: ____ days: Specify the days of retention of the video files recorded to the NAS storage.

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.

Vivotek Turret Dome IT9389-H - Searching and Viewing the Records - 1

text_image Search Device target All devices SD NAS Trigger type Backup System boot Digital input Motion Network fail Recording notify Periodically Shock detection SD card life expectancy Tampering detection VADP Manual triggers Audio detection Media type Video clip Snapshot Text Time Search for last 1 minute(s) hours days weeks From: 2020/05/22 04: 31 PM to: 2020/05/29 04: 31 PM Search

■ File attributes: Select one or more items as your search criteria.
■ Trigger time: Manually enter the time range you want to search for contents created at a specific point in time.

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

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.

Vivotek Turret Dome IT9389-H - Search Results - 1

text_image Numbers of entries displayed on one page Search results Name Trigger type Starting time Ending time to SD Periodically Today at 3:45 PM Today at 3:58 PM to SD Periodically Today at 3:58 PM test Motion Today at 3:45 PM Today at 3:45 PM test Motion Today at 3:49 PM Today at 3:49 PM test Motion Today at 3:49 PM Today at 3:49 PM test Motion Today at 3:50 PM Today at 3:50 PM test Motion Today at 3:50 PM Today at 3:50 PM 10 Download Lock/Unlock JPEGs to AVI Remove

■ Play: Click on a search result which will highlight the selected item. A Play window will appear on top for immediate review of the selected file. For example:

Vivotek Turret Dome IT9389-H - Search Results - 2

text_image Play Back to search (TOP-AV) 2016/8/26 15:45:39

■ 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 checkbox in front of a desired search result, then click this button. The selected items will become Locked, which will not be deleted during cyclic recording. You can click again to unlock the selections.

For example:

Vivotek Turret Dome IT9389-H - Search Results - 3

text_image Search results Name Trigger type Starting time Ending time to SD Periodically Today at 3:45 PM Today at 3:58 PM to SD Periodically Today at 3:58 PM test Motion Today at 3:45 PM Today at 3:45 PM test Motion Today at 3:49 PM Today at 3:49 PM test Motion Today at 3:49 PM Today at 3:49 PM test Motion Today at 3:50 PM Today at 3:50 PM test Motion Today at 3:50 PM Today at 3:50 PM 10 ✓ 1 /3 ✓ Click to switch pages Download Lock/Unlock JPEGs to AVI Remove

■ 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:///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 \n.

Return:

HTTP/1.0 \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

2. Style Convention

In URL syntax and in descriptions of CGI parameters, a text within angle brackets denotes a content that is to be replaced with either a value or a string. When replacing the text string, the angle brackets shall also be replaced. An example of this is the description of the name for the server, denoted with in the URL syntax description below, which is replaced with the string myserver in the URL syntax example, also below.

URL syntax is written with the word "Syntax:" written in bold face followed by a box with the reference syntax as seen below. The name of the server is written as . This 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.

Special notes will be marked in RED.

Syntax:

http:///cgi-bin/viewer/video.jpg

Description of returned data is written with "Return:" in bold face followed by the returned data shown in a box. All data is returned as HTTP formatted, i.e., starting with the string HTTP and line separated with a Carriage Return and Line Feed (CRLF) printed as \r\n.

Return:

HTTP/1.0 \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

3. General CGI URL Syntax and Parameters

CGI parameters are written in lower-case and as one word without any underscores or other separators. When the CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server. The CGIs are organized in functionally-related directories under the cgi-bin directory. The file extension .cgi is required.

Syntax:

http://<servername>/cgi-bin/<subdir>[/<subdir>...]/<cgi>.<ext>
[?<parameter>=<value>[&<parameter>=<value>...]] 

Example: Set digital output #1 to active

http://mywebserver/cgi-bin/dido/setdo.cgi?do0=1 

4. Security Level

SECURITY LEVELSUB-DIRECTORYDESCRIPTION
0anonymousUnprotected.
1 [view]viewerCan view, listen, and talk to camera.
4 [operator]operatorOperator access rights can modify most of the camera's parameters except some privileges and network options.
6 [admin]adminAdministrator access rights can fully control the camera's operations.
7N/AInternal APIs. Unable to be changed by any external interfaces.

A viewer account can access all APIs with security level 0 and 1. An operator account can access all APIs with security level 0, 1, or 4. An admin account can access all APIs except internal APIs.

Access management is based on the URL directory structure and is described in following paragraphs.

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 [_] or [.<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 DESCRIPTION
A full path like: "videoin_c0_s0_h264_resolution", "videoin_c0_s0_h264_maxframe", etc.
The assignedto the.
Redirect to the pageafter theis 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 

[]

Only the parameters that you set and are readable will be returned.

Example: Set the IP address of server to 192.168.0.123:

Request:

http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123

Response:

HTTP/1.0 200 OK\r\n

Content-Type: text/html\r\n

Context-Length: 33\r\n

\r\n

network.ipaddress=192.168.0.123\r\n

7. Available Parameters on the Server

Valid values:

VALID VALUES DESCRIPTION
string[]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.
Any single integer number in 32-bits.The range is -2147483648~2147483647.
Any single positive integer number in 32-bits.The range is 1~ 4294967295.
~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. joe@www.ibm.com).
A string limited to an IP address (eg. 192.168.1.1).
A string limited to contain a MAC address without hyphens or colons.
A boolean value of 1 or 0 represents [Yes or No], [True or False], [Enable or Disable].
Enumeration. Only given values are valid.
blankA blank string.
everything inside <> A description
integer primary keySQLite data type. A 32-bit signed integer. The value is assigned a unique integer by the server.
SQLite data type. The value is a text string, stored using the database encoding (UTF-8, UTF-16BE or UTF-16-LE).
x, y coordinate (eg. 0,0)
window width and height (eg. 800x600)
The format for coordinate in 2D.W is the pixel number of width.H is the pixel number of height.EX: (176,144)
The format for resolution.W is the pixel number of width.H is the pixel number of height.Ex: 1920x1080, 2048x1536
availableThe API is listed in product WebAPIs.
non-availableThe API is not in product WebAPIs.
validThe API is listed in product WebAPIs, and is functional.
non-validThe API is listed in product WebAPIs, but is malfunction in this status.
Any decimal number expressed in 32-bits ranging from 1.18e-38~3.40e+38.

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

7.1 System

Group: system

NAMEVALUESECURITY (get/set)DESCRIPTION
hostnamestring[64]1/6Host name of server (Network Camera, Wireless Network Camera, Video Server, Wireless Video Server).
ledoff6/6Turn on (0) or turn off (1) all led indicators.
date,, keep, auto6/6Current date of system. Set to ‘keep’ to keep date unchanged. Set to ‘auto’ to use NTP to synchronize date.
time,, keep, auto6/6Current time of the system. Set to ‘keep’ to keep time unchanged. Set to ‘auto’ to use NTP to synchronize time.
datetime6/6Another current time format of the system.
ntp,, ,6/6NTP server.*Do not use “skip to invoke default server” for default value.
NAME VALUE SECURITY(get/set)DESCRIPTION
timezoneindex<Not recommended to use this>-489 ~ 5296/6Indicate timezone and area.-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-241: GMT-06:00 Mexico City-242: GMT-06:00 Saskatchewan-200: GMT-05:00 Eastern Time, New York, Toronto-201: GMT-05:00 Bogota, Lima, Quito, Indiana-180: GMT-04:00 Caracas-160: GMT-04:00 Atlantic Time(Canada), La Paz-140: GMT-03:30 Newfoundland-120: GMT-03:00 Brasilia, Buenos Aires, Georgetown, Greenland, Sao Paulo-121: GMT-03:00 Santiago-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, Paris, Warsaw, Budapest, Bern41: GMT 01:00 Amsterdam, Berlin, Rome, Stockholm, Vienna, Madrid, Paris, Warsaw, Budapest, Bern80: GMT 02:00 Athens, Helsinki, Riga81: GMT 02:00 Cairo82: GMT 02:00 Lebanon83: GMT 02:00120: GMT 03:00 Baghdad, Kuwait,Riyadh, Nairobi121: GMT 03:00 Iraq, Minsk140: GMT 03:30 Tehran160: GMT 04:00 Abu Dhabi, Muscat,Baku, Tbilisi, Yerevan, Moscow, St.Petersburg180: GMT 04:30 Kabul200: GMT 05:00 Islamabad, Karachi,Tashkent220: GMT 05:30 Calcutta, Chennai,Mumbai, New Delhi230: GMT 05:45 Kathmandu240: GMT 06:00 Ekaterinburg, Almaty,Astana, Dhaka, Sri Jayawardenepura260: GMT 06:30 Rangoon280: GMT 07:00 Bangkok, Hanoi,Novosibirsk, Jakarta320: GMT 08:00 Beijing, Chongqing,Hong Kong, Kuala Lumpur, Singapore,Taipei, Krasnoyarsk360: GMT 09:00 Osaka, Sapporo, Tokyo,Seoul380: GMT 09:30 Adelaide, Darwin400: GMT 10:00 Brisbane, Canberra,Melbourne, Sydney, Guam401: GMT 10:00 Vladivostok440: GMT 11:00 Magadan, Solomon Is.,New Caledonia, Vladivostok480: GMT 12:00481: GMT 12:00 Auckland, Wellington,Fiji, Marshall Is.-480: GMT 12:00 Eniwetok, Kwajalein520: GMT 13:00 Nuku'Alofa
* We replace this parameter with “system_tz” when the version number (httpversion) is equal or greater than 0314b.
daylight_enable6/6Enable automaticdaylight saving time in time zone.
daylight_auto_begintimestring[19]6/7Display the current daylight saving start time.
daylight_auto_endtimestring[19]6/7Display the current daylight saving end time.
daylight_timezones,-360,-320,-280,-240,-241,-200,-140,-121,-40,0,40,41,80,82,83,140,380,4806/7List time zone index which support daylight saving time.* The timezone list can’t be modified for the version number (httpversion) equal or greater than 0316b, we recommend using “system_tz” for customized time settings instead.
updateinterval 0,3600,86400,604800,25920006/60 to Disable automatic time adjustment, otherwise, it indicates the seconds between NTP automatic update intervals.
utctime6/7Current UTC timestamp.* We support this parameter when the version number (httpversion) is equal or greater than 0314b.
tzstring>6/6 POSIX timezone setting.* We support this parameter when the version number (httpversion) is equal or greater than 0314b.
restore0,7/6Restore the system parameters to default values afterseconds.
reset 0,restoreexceptnet0,7/6 Restart7/6the server afterseconds ifis non-negative.Restore the system parameters to default values except (ipaddress, subnet, router, dns1, dns2, pppoe).This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.
restoreexceptdst0,7/6Restore the system parameters to default values except all daylight saving time settings.This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to default values except for a union of combined results.
restoreexceptlang0,7/6Restore 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.
restoreexceptvadprestoreexceptfocusvalue0,0,7/6 Restore7/6the 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.Restore the system parameters to default values except zoom and focus value.This command can cooperate with other "restoreexceptXYZ" commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.* Only available when "capability_image_c<0~(n-1)>_remotefocus" != 0.
restoreexceptlen 0,7/6 Restorethe system parameters to default values except lens profile.This command can cooperate with other "restoreexceptXYZ" commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results.* Only available when "capability_image_c<0~(n-1)>_lensconfiguration_support" != 0.
connection_timeout6/6Session connection timeout interval.* Only available when "capability_taics_support" = 1.

7.1.1 System.Info

Subgroup of system: info (The fields in this group are unchangeable.)

NAMEVALUESECURITY (get/set)DESCRIPTION
modelnamestring[40]0/7Internal model name of the server
extendedmodelnamestring[40]0/7ODM specific model name of server (eg. DCS-5610). If it is not an ODM model, this field will be equal to “modelname”
NAME VALUE SECURITY(get/set)DESCRIPTION
serialnumber1/712 characters MAC address (without hyphens).
firmwareversionstring[40]0/7Firmware version, including model, company, and version number in the format:
language_count0/7Number of webpage languages available on the server.
language_i<0~(count-1)>string[16]language_i0 :Englishlanguage_i1 :Deutschlanguage_i2 :Españollanguage_i3 :Françaislanguage_i4 :Italiano language_i5 :日本語language_i6 :Portuguêslanguage_i7 :简体中文language_i8 :繁體中文0/7 Available language lists.
customlanguage_max count0,<positive integer>0/6Maximum number of custom languages supported on the server.
customlanguage_count0,<positive integer>0/6 Number of custom languages which have been uploaded to the server.
customlanguage_i<0~(maxcount-1)>string0/6Custom language name.

7.2 Status

Group: status

NAME VALUE SECURITY(get/set)DESCRIPTION
di_i<0~(k-1)>1/70 => Inactive, normal1 => Active, triggered(capability_ndi > 0)k is determined by the below criterion:The following applies for capability_extension_di_num >= 0* if extension_connected=1,k=capability_ndi* if extension_connected=0,k=capability_ndi+capability_extension_di_numOtherwise,* k=capability_ndi
do_i<0~(k-1)>1/70 => Inactive, normal1 => Active, triggered(capability_ndo > 0)k is determined by the below criterion:The following applies for capability_extension_do_num >= 0* if extension_connected=1,k=capability_ndo* if extension_connected=0,k=capability_ndo+capability_extension_do_numOtherwise,* k=capability_ndo
onlinenum_rtsp0,<positive>integer>6/7Current number of RTSPconnections.
onlinenum_httppush 0,positive integer>6/7 Current number of HTTP push server connections.
onlinenum_sip0,6/7Current number of SIP connections.
eth_i01/7 Get network information from mii-tool.
vi_i<0~(capability_nvi-1)>boolean>1/7Virtual input0 => Inactive1 => Active(capability_nvi >0)

7.2.1 Status per Channel

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

n denotes the value of "capability_nvideoin"

NAMEVALUESECURITY (get/set)DESCRIPTION
signal_detect1/7Indicates whether the video source is connected or not.* Only available whencapability_videoin_type is 0 or 1.
signal_typentsc,pal1/7The actual modulation type.* Only available whencapability_videoin_type is 0 or 1.
daynightday, night1/7Indicate the current light status.

7.3 Digital Input Behavior Define

Group: di_i<0(n-1)> for n is the value of "capability_ndi" (capability_ndi > 0)

k is determined by the below criterion:

The following applies for capability_extension_di_num >= 0

* if extension_connected=1, k=capability_ndi
* if extension_connected=0, k=capability_ndi+ capability_extension_di_num

Otherwise,

* k=capability_ndi

NAME VALUE SECURITY(get/set)DESCRIPTION
normalstatehigh,low1/1Indicates open circuit or closed circuit(inactive status)

7.4 Digital Output Behavior Define

Group: do_i<0\~(n-1)> for n is the value of "capability_ndo" (capability_ndo > 0)

k is determined by the below criterion:

The following applies for capability_extension_do_num >= 0

* if extension_connected=1, k=capability_ndo
* if extension_connected=0, k=capability_ndo+ capability_extension_do_num

Otherwise,

* k=capability_ndo

NAMEVALUESECURITY (get/set)DESCRIPTION
normalstate open,grounded1/1 Indicateopen circuit or closed circuit (inactive status)

7.5 Security

Group: security

NAME VALUE SECURITY(get/set)DESCRIPTION
privilege_doview, operator, admin1/6Indicate which privileges and above can control digital output (capability_ndo > 0)
privilege_camctrlview, operator, admin1/6 Indicate which privileges and above can control PTZ (capability_ptzenabled > 0 or capability_eptz > 0 or capability_fisheye > 0)
user_i0_namestring[64]6/7User name of root
user_i<1~20>_namestring[64]6/7User name
user_i0_passpassword[64]7/6Root password
user_i<1~20>_passpassword[64]7/6User password
user_i0_privilegeview, operator,admin6/7Root privilege
user_i<1~20>_privilegeview, operator, admin6/6 User privilege

7.6 Network

Group: network

NAMEVALUESECURITY (get/set)DESCRIPTION
preprocess6/6An 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”
NAME VALUE SECURITY(get/set)DESCRIPTION
typelan, pppoe6/6Network connection type.
resetip6/61 => Get ipaddress, subnet, router, dns1, dns2 from DHCP server at next reboot.0 => Use preset ipaddress, subnet, rounter, dns1, and dns2.
ipaddress6/6IP address of server.
subnet6/6Subnet mask.
router6/6Default gateway.
dns16/6Primary DNS server.
dns26/6Secondary DNS server.
wins16/6Primary WINS server.
wins26/6Secondary WINS server.

7.6.1 802.1x

Subgroup of network: ieee8021x (capability_protocol_ieee8021x > 0)

NAMEVALUESECURITY (get/set)DESCRIPTION
enable6/6Enable/disable IEEE 802.1x
eapmethodeap-peap, eap-tls6/6Selected EAP method
identity_peapstring[64]6/6PEAP identity
identity_tlsstring[64]6/6TLS identity
passwordstring[200]7/6Password for TLS
privatekeypasswordstring[200]7/6Password for PEAP
ca_exist6/6CA installed flag
ca_time0,<positive integer>6/7CA installed time. Represented in EPOCH
ca_size0,<positive integer>6/7CA file size (in bytes)
certificate_exist6/6Certificate installed flag (for TLS)
certificate_time0,<positive integer>6/7Certificate installed time. Represented in EPOCH
certificate_size0,<positive integer>6/7Certificate file size (in bytes)
NAMEVALUE SECURITY(get/set)DESCRIPTION
integer>
privatekey_exist6/6Private key installed flag (for TLS)
privatekey_time0,<positive integer>6/7Private key installed time. Represented in EPOCH
privatekey_size0,<positive integer>6/7Private key file size (in bytes)

7.6.2 QOS

Subgroup of network: qos_cos (capability_protocol_qos_cos > 0)

NAMEVALUESECURITY (get/set)DESCRIPTION
enable6/6Enable/disable CoS (IEEE 802.1p)
vlanid1~40956/6VLAN ID
video0~76/6Video channel for CoS
audio0~76/6Audio channel for CoS(capability_naudioin >0)
eventalarm0~76/6Event/alarm channel for CoS
management0~76/6Management channel for CoS
eventtunnel0~76/6Event/Control channel for CoS

Subgroup of network: qos_dscp (capability_protocol_qos_dscp > 0)

NAMEVALUESECURITY (get/set)DESCRIPTION
enable6/6Enable/disable DSCP
video0~636/6Video channel for DSCP
audio0~636/6Audio channel for DSCP(capability_naudioin > 0)
eventalarm0~636/6Event/alarm channel for DSCP
management0~636/6Management channel for DSCP
eventtunnel0~636/6Event/Control channel for DSCP

7.6.3 IPV6

Subgroup of network: ipv6 (capability_protocol_ipv6 > 0)

NAME VALUE SECURITY(get/set)DESCRIPTION
enable6/6Enable IPv6.
addonipaddress6/6IPv6 IP address.
addonprefixlen0~1286/6IPv6 prefix length.
addonrouter6/6IPv6 router address.
addondns6/6IPv6 DNS address.
allowoptional6/6Allow manually setup of IP address setting.

7.6.4 FTP

Subgroup of network: ftp

NAME VALUE SECURITY(get/set)DESCRIPTION
port21, 1025~655356/6Local ftp server port.
enable6/6Enable ftp.

7.6.5 HTTP

Subgroup of network: http

NAMEVALUESECURITY (get/set)DESCRIPTION
port80, 1025 ~ 655351/6HTTP port.
alternateport1025~655356/6Alternate HTTP port.
authmodebasic,digest1/6HTTP authentication mode.
s<0~(capability_nmediastream*capability_nvideoin)-1>_accessname<product dependent><Not recommended to use this>string[32]1/6Http server push access name for stream N, N=1~(capability_nmediastream*capability_nvideoin)-1).(capability_protocol_spush_mjpeg =1 and capability_nmediastream >0)The value are shown as video1s1.mjpg = c0_s0_accessname,(channel1stream1)video1s2.mjpg = c0_s1_accessname,(channel1stream2)video1s3.mjpg = c0_s2_accessname,(channel1stream3)video1s4.mjpg = c0_s3_accessname,(channel1stream4)etc.* We replace this parameter with "network_http_c<0~(capability_nvideoin-1)>_s<0~(capability_nmediastream-1)>_accessname" when the version number (httpversion) is equal or greater than 0311c.

7.6.6 HTTP per Channel

Subgroup of network: http_c<0\~(n-1)> for n channel products n denotes the value of "capability_nvideoin"

NAMEVALUESECURITY (get/set)DESCRIPTION
s<0~(capability_nmedia stream-1)>_accessnameNAME VALUE SECURITYstring[32]1/6(get/set)Http server push access name for channel N and stream M, N= 1~capability_nvideoin, M= 1~capability_nmediastream.(capability_protocol_spush_mjpeg =1 and capability_nmediastream >0)The value are shown as video1s1.mjpg = c0_s0_accessname,(channel1stream1)video1s2.mjpg = c0_s1_accessname,(channel1stream2)video2s1.mjpg = c1_s0_accessname,(channel2stream1)video2s2.mjpg = c1_s1_accessname,(channel2stream2)etc.* We support this parameter when theDESCRIPTION
version number (httpversion) is equal or greater than 0311c.

7.6.7 HTTPS Port

Subgroup of network: https (capability_protocol_https > 0)

NAMEVALUESECURITY (get/set)DESCRIPTION
port 443, 1025 ~655351/6 HTTPSport.

7.6.8 RTSP

Subgroup of network: rtsp (capability_protocol_rtsp > 0)

NAME VALUE SECURITY(get/set)DESCRIPTION
port554, 1025 ~ 655351/6RTSP port.(capability_protocol_rtsp=1)
authmode disable,basic,digest1/6 RTSP authentication mode.(capability_protocol_rtsp=1)
s<0~(capability_nmediastream*capability_nvideoin)-1>_accessnameproduct dependent>string[32]1/6RTSP access name for channel and stream.(capability_protocol_spush_mjpeg =1 and capability_nmediastream >0)The value are shown as live1s1.sdp = s0_accessname,(channel1stream1)live1s2.sdp = s1_accessname,(channel1stream2)live1s3.sdp = s2_accessname,(channel1stream3)live1s4.sdp = s3_accessname,(channel1stream4)etc.* Values start with prefix “cgi-bin”are prohibited. For example, “c, cg, cgi, cgi-, cgi-b, cgi-bi, cgi-bin” are not allowed.* We modify the value of RTSP access name after version number(httpversion) is 0311c
c<0~(capability_nvide oin)-1>_s<0~(capability_nmediastream)-1>_accessnameproduct dependent>string[32]1/6RTSP access name for channel N stream M, N= 1~capability_nvideoin, M = 1~capability_nmediastream.The value are shown as live1s1.sdp = c0_s0_accessname, (channel1stream1)live1s2.sdp = c0_s1_accessname, (channel1stream2)live1s3.sdp = c0_s2_accessname, (channel1stream3)live1s4.sdp = c0_s3_accessname, (channel1stream4)etc.* Values start with prefix “cgi-bin” are prohibited. For example, “c, cg, cgi, cgi-, cgi-b, cgi-bi, cgi-bin” are not allowed.* We modify the value of RTSP access name after version number(httpversion) is 0311c
pimssm_enable7/6To enable the feature of Protocol Independent Multicast - Source Specific Multicast.* We support this parameter when the version number (httpversion) is equal or greater than 0313a.

7.6.9 RTSP Multicast

Subgroup of network: rtsp_s<0\~(n-1)>_multicast

n denotes the value of "capability_nmediastream * capability_nvideoin"

NAME VALUE SECURITY(get/set)DESCRIPTION
alwaysmulticast4/4Enable always multicast.
ipaddressaddress>4/4 Multicastvideo IP address.* We replace "network_rtsp_s<0~(n-1)>_multicast_ipaddress" with "network_rtsp_s<0~(n-1)>_multicast_videoipaddress".* Reserved for compatibility, and suggest don't use this since [httpversion] >0304a
videoipaddressaddress>4/4 Multicastvideo IP address.* We support this parameter when the version number (httpversion) is equal or greater than 0304a.
audioipaddress4/4Multicast audio IP address.* We support this parameter when the version number (httpversion) is equal or greater than 0304a.* Only available when capability_naudioin >0
metadataipaddress s4/4 Multicastmetadata IP address.* We support this parameter when the version number (httpversion) is equal or greater than 0304a.
videoport 1025 ~655354/4 Multicastvideo port.
audioport1025 ~4/4 Multicastaudio port.* Only available when capability_naudioin >0
metadataaport 1026 ~655344/4 Multicastmetadata port.
ttl1 ~ 2554/4Multicasttime to live value.

7.6.10 SIP Port

Subgroup of network: sip (capability_protocol_sip>0)

NAMEVALUESECURITY (get/set)DESCRIPTION
port1025 ~ 655351/6SIP port.

7.6.11 RTP Port

Subgroup of network: rtp

NAMEVALUESECURITY (get/set)DESCRIPTION
videoport1025 ~ 655356/6Video channel port for RTP.
audiport1025 ~ 655356/6Audio channel port for RTP.
metadataaport1025 ~ 655356/6Metadata channel port for RTP.

7.6.12 PPPoE

Subgroup of network: pppoe (capability_protocol_pppoe > 0)

NAMEVALUESECURITY (get/set)DESCRIPTION
userstring[128]6/6PPPoE account user name.
passpassword[64]7/6PPPoE account password.

7.6.13 Bonjour

Subgroup of network: service_bonjour

NAMEVALUESECURITY (get/set)DESCRIPTION
enable6/6Enable bonjour service feature.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
servicename6/6A friendly name for bonjour service.* We support this parameter when the version number (httpversion) is equal
NAME VALUE SECURITY(get/set)DESCRIPTION
or greater than 0312a.

7.6.14 SFTP server

* Only available when bit 1 of "capability_protocol_ftp_server" is 1.

Subgroup of network: sftp

NAME VALUESECURITY(get/set)DESCRIPTION
port 22,1025~655356/6 Local sftp server port.
enable6/6Enable sftp.

7.7 IP Filter

Group: ipfilter

NAMEVALUESECURITY (get/set)DESCRIPTION
enable6/6Enable access list filtering.
admin_enable6/6Enable administrator IP address.
admin_ipstring[43]6/6Administrator IP address.
maxconnection1~ "capability_protocol_maxconnection"6/6Maximum number of (s).
type0, 16/6Ipfilter policy :0 => allow1 => deny
ipv4list_i<0~9>Single address:Network address:Rangeaddress:6/6IPv4 address list.
ipv6list_i<0~9>string[43]6/6IPv6 address list.

7.8 Video Input

Group: videoin

* We do not support this parameter when "capability_nvideoin > 1".

NAMEVALUESECURITY (get/set)DESCRIPTION
cmosfreq50, 604/4CMOS frequency.* Only available when capability_videoin_type is 2.* We do not support this parameter when "capability_nvideoin >1"* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
whitebalanceauto,panorama,manual,rbgain,widerange,outdoor,indoor,sodiumauto,etc(Available values are listed in "capability_image_c<0~(n-1)>_wbmode")4/4Modes of white balance."auto": Auto white balance"panorama": indicates that camera would try to balance the white balance effect of every sensor."rbgain": Use rgain and bgain to set white balance manually."manual": 2 cases:a. if "rbgain" is not supported, this means keep current white balance status.b. if "rbgain" is supported, "rgain" and "bgain" are updated to the current values which is got from white balance module. Then, act as rbgain mode"widerange": Auto Tracing White balance (2000K to 10000K)."outdoor": auto white balance mode specifically for outdoor."indoor": auto white balance mode specifically for indoor."sodiumauto": sodium vapor lamps.
NAME VALUE SECURITY(get/set)DESCRIPTION
* Only available when "capability_image_c<0~(n-1)>_wbmode" != "-" * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
exposurelevel0~124/4Exposure level "0,12": This range takes the concept from DC's exposure tuning options. The definition is: 0: EV -2.0 1: EV -1.7 2: EV -1.3 3: EV -1.0 4: EV -0.7 5: EV -0.3 6: EV 0 7: EV +0.3 8: EV +0.7 9: EV +1.0 10: EV +1.3 11: EV +1.7 12: EV +2.0 * Only available when "capability_image_c<0~(n-1)>_exposure_mode" !=0 * We do not support this parameter when "capability_nvideoin > 1". * This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
irismodefixed, indoor, outdoor4/4Control DC-Iris mode. "outdoor": Auto-setting DC-Iris to get best quality, but easy to meet rolling
independent>or flicker effect in indoor environment."indoor": Avoid rolling and flicker effect first."fixed": Open the iris to maximum.* Only available when "capability_image_c<0~(n-1)>_iristype"=dciris* We do not support this parameter when "capability_nvideoin > 1"* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
enableblc4/4Enable backlight compensation.* Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.* It's recommended to use "exposurewin_c<0~(n-1)>_mode" to switch on/off BLC.
color0, 14/40 =>monochrome1 => color* Only available when "capability_videoin_c<0~(n-1)>_color_support" is 1.* We do not support this parameter when "capability_nvideoin > 1"* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
flip4/4Flip the image.* We do not support this parameter when "capability_nvideoin > 1"* This parameter will not be used after the version number (httpversion)is equal or greater than 0400a.
mirror4/4Mirror the image.* We do not support this parameter when "capability_nvideoin >1".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
rotate0,90,180,2701/4The rotation angle of image.Support only in Rotation mode.* Only available when "capability_videoin_c<0~(n-1)>_rotation"=1* We do not support this parameter when "capability_nvideoin >1".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
ptzstatus<Not support anymore>0,<positive integer>1/7A 32-bit integer, each bit can be set separately as follows:Bit 0 => Support camera control function; 0(not support), 1(support)Bit 1 =>Built-in or external camera; 0 (external), 1(built-in)Bit 2 =>Support pan operation; 0(not support), 1(support)Bit 3 =>Support tilt operation; 0(not support), 1(support)Bit 4 =>Support zoom operation; 0(not support), 1(support)Bit 5 =>Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only)* Not support this parameter anymore when the version number (httpversion) is equal or greater than 0309a.
textstring[64]1/4Enclose caption.* We do not support this parameter when "capability_nvideoin > 1".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
imprinttimestamp4/4Overlay time stamp on video.* We do not support this parameter when "capability_nvideoin > 1".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
minexposure<1~32000>,<5~32000>,<1~8000>,<5~8000>,etc.* Available value is listed in "capability_image_c<0~(n-1)>_exposure_minrange"4/4Minimum exposure time1~32000 => 1s ~ 1/32000s5~32000 => 1/5s ~ 1/32000s1~8000 => 1s ~ 1/8000s5~8000 => 1/5s ~ 1/8000setc.* Only available when "capability_image_c<0~(n-1)>_exposure_minrange" != "-" * Only valid when "piris_mode" = manual or "irismode" = fixed* Only available when "capability_image_c<0~(n-1)>_exposure_minrange" is "twovalues".* We do not support this parameter when "capability_nvideoin > 1".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
maxexposure<1~32000>,<5~32000>,<1~8000>,<5~8000>,4/4 Maximum exposure time1~32000 => 1s ~ 1/32000s5~32000 => 1/5s ~ 1/32000s1~8000 => 1s ~ 1/8000s
etc.* Available value is listed in "capability_image_c<0~(n-1)>_exposure_maxrange"5~8000 => 1/5s ~ 1/8000s etc.* This parameter may also restrict image frame rate from sensor due to sensor generates a frame per exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.* Only available when "capability_image_c<0~(n-1)>_exposure_maxrange" != "-" * Only valid when "piris_mode" = manual or "irismode" = fixed* Only available when "capability_image_c<0~(n-1)>_exposure_rangetype" is "twovalues".* We do not support this parameter when "capability_nvideoin > 1".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
enablepreview1/4Usage for UI of exposure settings. Preview settings of video profile.* Only available when "capability_image_c<0~(n-1)>_exposure_mode" != 0* We do not support this parameter when "capability_nvideoin > 1".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.

7.8.1 Video Input Setting per Channel

Group: videoin_c<0\~(n-1)> for n channel products, and m is stream number

n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream"

NAME VALUE SECURITY(get/set)DESCRIPTION
cmosfreq50, 604/4CMOS frequency.* Only available when "capability_videoin_type" is 2
mode0~"capability_videoin_c<0~(n-1)>_nmode"-14/4 Indicatethe video mode on use.
whitebalanceauto,panorama,manual,rbgain,widerange,outdoor,indoor,sodiumauto,etc(Available values are listed in"capability_image_c<0~(n-1)>_wbmode")4/4Modes of white balance."auto": Auto white balance"panorama": indicates that camera would try to balance the white balance effect of every sensor."rbgain": Use rgain and bgain to set white balance manually."manual": 2 cases:a. if "rbgain" is not supported, this means keep current white balance status.b. if "rbgain" is supported, "rgain" and "bgain" are updated to the current values which is got from white balance module. Then, act as rbgain mode"widerange": Auto Tracing White balance (2000K to 10000K)."outdoor": auto white balance mode specifically for outdoor."indoor": auto white balance mode specifically for indoor."sodiumauto": sodium vapor lamps.* Only available when"capability_image_c<0~(n-1)>_wbmode" != "-"
rgain0~1004/4Manual set rgain value of gain control setting.0: Weak <-> 100: Strong* Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbmode".* Only valid when "videoin_c<0~(n-1)>_whitebalance" != auto* Normalized range.
bgain0~1004/4Manual set bgain value of gain control setting.0: Weak <-> 100: Strong* Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbmode".* Only valid when "videoin_c<0~(n-1)>_whitebalance" != auto* Normalized range.
exposurelevel0~124/4Exposure level"0,12": This range takes the concept from DC's exposure tuning options.The definition is:0: EV -2.01: EV -1.72: EV -1.33: EV -1.04: EV -0.75: EV -0.36: EV 07: EV +0.38: EV +0.79: EV +1.010: EV +1.311: EV +1.712: EV +2.0* Only available when"capability_image_c<0~(n-1)>_exposure_mode" !=0
exposuremodeauto,shutterpriority,irispriority,qualitypriority,manual,etc(Available options are list in"capability_image_c<0~(n-1)>_exposure_modetype")4/4 Select exposure mode."auto": Automatically adjust the Iris, Gain and Shutter Speed to fit the exposure level."shutterpriority": Manually adjust with variable Shutter Speed, and keep adjusting Iris, Gain automatically."irispriority": Manually adjust with variable Iris, and keep adjusting Gain and Shutter speed automatically."qualitypriority": Automatically adjust the Iris, Gain and Shutter Speed by VIVOTEK quality algorithm."manual": Manually adjust with variable Shutter, Iris and Gain.* We support this parameter when the version number (httpversion) is equal or greater than 0302a.* Only available when"capability_image_c<0~(n-1)>_exposure_mode" !=0
irismodefixed, indoor, outdoor4/4Control DC-Iris mode."outdoor": Auto-setting DC-Iris to get best quality, but easy to meet rolling or flicker effect in indoor environment."indoor": Avoid rolling and flicker effect first."fixed": Open the iris to maximum.* Only available when"capability_image_c<0~(n-1)>_iristype"=dciris
piris_modemanual, indoor, outdoor,-1/4Control P-Iris mode."outdoor": Auto-setting P-Iris to get best quality, but easy to meet rolling or flicker effect in indoor environment."indoor": Avoid rolling and flicker effect first."manual": Manual set P-Iris by "piris_position"."-": not support. (only available when "capability_image_c<0~(n-1)>_sensor type" is "smartsensor")* Only available when "capability_image_c<0~(n-1)>_iristype"=piris
piris_position1~1001/4Manual set P-Iris.1: Open <-> 100: Close* Only valid when"piris_mode"=manual or "capability_image_c<0~(n-1)>_sensor type" is "smartsensor"* Only available when "capability_image_c<0~(n-1)>_iristype"=piris
enableblc4/4Enable backlight compensation* Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.* It's recommended to use "exposurewin_c<0~(n-1)>_mode" to switch on/off BLC.
maxgain0~1004/4Maximum gain value.0: Low <-> 100: High* Only available when "capability_image_c<0~(n-1)>_agc_maxgain" != "-" * Only valid when "piris_mode" = manual or "irismode" = fixed* Normalized range.* Only available when "capability_image_c<0~(n-1)>_exposure_rangetype" is "twovalues".
mingain0~1004/4Minimum gain value.0: Low <-> 100: High* Only available when "capability_image_c<0~(n-1)>_agc_mingain" != "-" * Only valid when "piris_mode" = manual or "irismode" = fixed* Normalized range.* Only available when "capability_image_c<0~(n-1)>_exposure_rangetype" is "twovalues".
gainvalue0~1004/4Gain value.0: Low <-> 100: High* Only available when "capability_image_c<0~(n-1)>_agc_maxgain" != "-" and "capability_image_c<0~(n-1)>_exposure_rangetype" is "onevalue".* Normalized range.* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
color0, 14/40 => monochrome1 => color* Only available when "capability_videoin_c<0~(n-1)>_color_support" is 1.
flip4/4Flip the image.
mirror4/4Mirror the image.
rotate0,90,180,2701/4The rotation angle of image.Support only in Rotation mode(capability_videoin_c<0~(n-1)>_rotation=1)
ptzstatus0,1/7A 32-bit integer, each bit can be set separately as follows:Bit 0 => Support camera control function; 0(not support), 1(support)Bit 1 =>Built-in or external camera; 0 (external), 1(built-in)Bit 2 => Support pan operation; 0(not support), 1(support)Bit 3 => Support tilt operation; 0(not support), 1(support)Bit 4 => Support zoom operation; 0(not support), 1(support)Bit 5 => Support focus operation; 0(not support), 1(support)(SD/PZ/IZ series only)* Not support this parameter anymore when the version number (httpversion) is equal or greater than 0309a.
textstring[64]1/4Enclose caption.
imprinttimestamp4/4Overlay time stamp on video.
textonvideo_positiontop, bottom4/4Text on video string position
textonvideo_size20~404/4Text on video font size
textonvideo_fontpath/usr/share/font/Default.ttf,/mnt/flash2/upload.ttf4/4Choose camera default font file(/usr/share/font/Default.ttf) or user uploaded font file(/mnt/flash2/upload.ttf).
textonvideo_uploadfilenameDepends on the font file name uploaded by user1/7Show the uploaded font file name.
minexposure<1~32000>,<5~32000>,<1~8000>,<5~8000>,etc.* Available value is listed in"capability_image_c<0~(n-1)>_exposure_minrange"4/4Minimum exposure time1~32000 => 1s ~ 1/32000s5~32000 => 1/5s ~ 1/32000s1~8000 => 1s ~ 1/8000s5~8000 => 1/5s ~ 1/8000setc.* Only available when"capability_image_c<0~(n-1)>_exposure_minrange" != "-" * Only valid when"piris_mode" = manual or"irismode" = fixed* Only available when"capability_image_c<0~(n-1)>_exposure_minrange" is "twovalues".
maxexposure<1~32000>,<5~32000>,<1~8000>,<5~8000>,etc.* Available value is listed in"capability_image_c<0~(n-1)>_exposure_maxrange"4/4 Maximum exposure time1~32000 => 1s ~ 1/32000s5~32000 => 1/5s ~ 1/32000s1~8000 => 1s ~ 1/8000s5~8000 => 1/5s ~ 1/8000setc.* This parameter may also restrict image frame rate from sensor due to sensor generates a frame per exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.* Only available when"capability_image_c<0~(n-1)>_exposure_maxrange" != "-"
* Only valid when"piris_mode" = manual or"irismode" = fixed* Only available when"capability_image_c<0~(n-1)>_exposure_rangetype" is "twovalues".
shuttervalue<1~32000>,<5~32000>,<1~8000>,<5~8000>,etc.* Available value is listed in"capability_image_c<0~(n-1)>_exposure_maxrange"4/4 Exposure time1~32000 => 1s ~ 1/32000s5~32000 => 1/5s ~ 1/32000s1~8000 => 1s ~ 1/8000s5~8000 => 1/5s ~ 1/8000setc.* This parameter may also restrict image frame rate from sensor due to sensor generates a frame per exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.* Only available when"capability_image_c<0~(n-1)>_exposure_maxrange" != "-" and"capability_image_c<0~(n-1)>_exposure_rangetype" is "onevalue"* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
enablepreview1/4Usage for UI of exposure settings. Preview settings of video profile.* Only available when"capability_image_c<0~(n-1)>_exposure_mode" != 0
meteringmodeauto,blc,hlc* Available value is listedin"capability_image_c<0~(n-1)>_exposure_meteringmode"4/4"auto": The algorithm chooses the best metering strategy."blc": This metering method increases the weight of dark area."hlc": The metering method can detect strong light and make affected area clear.* We support this parameter when the version number (httpversion) is equal or greater than 0311a.
crop_position-coordinate>(x,y)1/7Crop left-top corner coordinate.
crop_size1/7Crop width and height.(width must be 16x or 32x and height must be 8x)
zoomratiodisplay1/4Indicates multiple of zoom in is "on-screen display" or not.* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
bracketing_level1~1004/4● The total available lists(capability_image_c<0~(n-1)>_exposure_bracketing_range) will be normalized to 1~100 scale.● For example, the total available list is 7. (2x,3x,4x,5x,6x,7x,8x)● 1 ~ 14 that correspond with 2x.● 15 ~ 30 that correspond with 3x.*Only available when"capability_image_c<0~(n-1)>_exposure_bracketing_mode"=1.* We support this parameter when the version number (httpversion) is equal or greater than 0310a.
s<0~(m-1)>_enableptz4/4Indicate whether stream supprts eptz or not
s<0~(m-1)>_codetypeListed at"capability_videooin_codec"Possible values are: mjpeg, h264,h2651/4Codec type for this stream
s<0~(m-1)>_resolutionAvailable options are list in "capability_videoin_c<0~(n-1)>_resolution".Besides, available options is referred to "capability_videoin_c<0~(n-1)>_maxresolution" and "capability_videoin_c<0~(n-1)>_minresolution"1/4 Video resolution in pixels.
s<0~(m-1)>_smartfps_enable4/4Enable "Smart fps" function.* Only available when "capability_videoin_c<0~(n-1)>_smart fps_support" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0309a.
s<0~(m-1)>_h264_dintraperiod_enable4/4Enable "Dynamic intra frame period"* Only available when "capability_videoin_c<0~(n-1)>_dintraperiod_support" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0301c.
s<0~(m-1)>_h264_intraperiod250, 500, 1000, 2000, 3000, 40004/4The time interval between two I-frames (Intra coded picture). The unit is millisecond (ms).
s<0~(m-1)>_h264_ratecontrol modecbr, vbr4/4cbr: Constant bit rate mode.vbr: Fixed quality mode, all frames are encoded in the same quality.
s<0~(m-1)>_h264_quant1~5, 99, 1004/4Set the pre-defined quality level:1: Medium2: Standard
NAME VALUE SECURITY(get/set)DESCRIPTION
3: Good4: Detailed5: Excellent100: Use the quality level in "qpercent"99: Use the quality level in "qvalue"* Only valid when"h264_ratecontrolmode" = vbr.
s<0~(m-1)>_h264_qvalue0~514/4 Manual video quality level input. The Q value which is used by encoded library directly.* Only valid when"h264_ratecontrolmode" = vbr and s<0~(m-1)>_h264_quant = 99.
s<0~(m-1)>_h264_qpercent1~1004/4 Select customized quality in a normalized full range.1: Worst quality100: Best quality* Only valid when"h264_ratecontrolmode" = vbr and "quant" = 100.
s<0~(m-1)>_h264_maxvbrbitrate20000~"capability_videoin_c<0~(n-1)>_h264_maxbit rate"4/4 The maximum allowed bit rate in fixed quality mode.When the bit rate exceeds this value, frames will be dropped to restrict the bit rate.* Only valid when"h264_ratecontrolmode" = vbr
s<0~(m-1)>_h264_cbr_quant1~5, 1004/4 Set the pre-defined quality level:1: Medium2: Standard3: Good4: Detailed5: Excellent100: Use the quality level in "cbr_qpercent"
NAME VALUE SECURITY(get/set)DESCRIPTION
* Only available when"h264_ratecontrolmode"= cbr.
s<0~(m-1)>_h264_cbr_qpercent1~1004/4Select customized quality in a normalized full range.1: Worst quality100: Best quality* Only valid when"h264_ratecontrolmode"= cbr and"quant" = 100.
s<0~(m-1)>_h264_bitrate20000~"capability_videoin_c<0~(n-1)>_h264_maxbit rate"4/4The target bit rate in constant bit rate mode.* Only valid when"h264_ratecontrolmode"= cbr
s<0~(m-1)>_h264_prioritypolicyframerate,imagequality4/4Set prioritypolicy* Only valid when"h264_ratecontrolmode"= cbr
s<0~(m-1)>_h264_maxframe1~"capability_videoin_c<0~(n-1)>_h264_maxframerate"1/4The maximum frame rates of a H264 stream at different resolutions("capability_videoin_c<0~(n-1)>_resolution") are recorded in "capability_videoin_c<0~(n-1)>_h264_maxframerate"
s<0~(m-1)>_h264_profile0~2* Available values can also belisted in "capability_videoin_c_h264_profile"1/4 IndicateH264 profiles0: baseline1: main2: high* It's recommended to use available values from "capability_videoin_c_h264_profile".
s<0~(m-1)>_h264_smartq_enable4/4Enable "Smart Q" function.* Only available when "capability_videoin_c<0~(n-1)>_smart q_support" is 1.* We support this parameter when the version number (httpversion) isequal or greater than 0309a.
s<0~(m-1)>_h265_dintraperiod_enable4/4Enable "Dynamic intra frame period".* Only available when"capability_videoin_c<0~(n-1)>_dintraperiod_support" is 1 and h265 is listed in "capability_videoin_codec".* We support this parameter when the version number (httpversion) is equal or greater than 0301c.
s<0~(m-1)>_h265_intraperiod250, 500, 1000, 2000, 3000, 40004/4The time interval between two I-frames (Intra coded picture).The unit is millisecond (ms).* Only available when h265 is listed in "capability_videoin_codec".
s<0~(m-1)>_h265_ratecontrol modecbr, vbr4/4cbr: Constant bit rate mode.vbr: Fixed quality mode, all frames are encoded in the same quality.* Only available when h265 is listed in "capability_videoin_codec".
s<0~(m-1)>_h265_quant1~5, 99, 1004/4Set the pre-defined quality level:1: Medium2: Standard3: Good4: Detailed5: Excellent100: Use the quality level in "qpercent"99: Use the quality level in "qvalue"* Only available when h265 is listed in "capability_videoin_codec".* Only valid when"h265_ratecontrolmode"= vbr
s<0~(m-1)>_h265_qvalue0~514/4Manual video quality level input. The Q value which is used by encoded library directly.* Only available when h265 is listed in"capability_videoin_codec".* Only valid when"h265_ratecontrolmode" = vbr ands<0~(m-1)>_h265_quant = 99.
s<0~(m-1)>_h265_qpercent1~1004/4Select customized quality in anormalized full range.1: Worst quality100: Best quality* Only available when h265 is listed in"capability_videoin_codec".* Only valid when"h265_ratecontrolmode" = vbr and"quant" = 100.
s<0~(m-1)>_h265_maxvbrbitrate20000~"capability_videoin_c<0~(n-1)>_h265_maxbitrate"4/4The maximum allowed bit rate in fixedquality mode.When the bit rate exceeds this value,frames will be dropped to restrict thebit rate.* Only available when h265 is listed in"capability_videoin_codec".* Only valid when"h265_ratecontrolmode" = vbr
s<0~(m-1)>_h265_cbr_quant1~5, 1004/4Set the pre-defined quality level:1: Medium2: Standard3: Good4: Detailed5: Excellent100: Use the quality level in"cbr_qpercent"* Only available when h265 is listed in"capability_videoin_codec" and"h265_ratecontrolmode" = cbr.
s<0~(m-1)>_h265_cbr_qpercent1~1004/4Select customized quality in anormalized full range.1: Worst quality100: Best quality* Only available when h265 is listed in "capability_ videoin_codec".* Only valid when "h265_ratecontrolmode" = cbr and "quant" = 100.
s<0~(m-1)>_h265_bitrate20000~"capability_ videoin_c<0~(n-1)>_h265_maxbit rate"4/4 The target bit rate in constant bit rate mode.* Only available when h265 is listed in "capability_ videoin_codec".* Only valid when "h265_ratecontrolmode" = cbr
s<0~(m-1)>_h265_prioritypolicyframerate, imagequality4/4Set prioritypolicy* Only available when h265 is listed in "capability_ videoin_codec".* Only valid when "h265_ratecontrolmode" = cbr
s<0~(m-1)>_h265_maxframe1~"capability_ videoin_c<0~(n-1)>_h265_maxframerate"1/4 The maximum frame rates of a H265 stream at different resolutions("capability_ videoin_c<0~(n-1)>_resolution") are recorded in "capability_ videoin_c<0~(n-1)>_h265_maxframerate"* Only available when h265 is listed in "capability_ videoin_codec".
s<0~(m-1)>_h265_profileAvailable values are listed in "capability_ videoin_c<0~(n-1)>_h265_profile"1/4Indicate H265 profiles* Only available when h265 is listed in "capability_ videoin_codec".
s<0~(m-1)>_h265_smartq_enable4/4Enable "Smart Q" function.* Only available when h265 is listed in "capability_ videoin_codec".* Only available when "capability_ videoin_c<0~(n-1)>_smartq_support" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0309a.
s<0~(m-1)>_mjpeg_ratecontrolmodecbr, vbr4/4cbr: Constant bit rate mode.vbr: Fixed quality mode, all frames are encoded in the same quality.
s<0~(m-1)>_mjpeg_quant1~5,99, 1004/4* Only valid when "mjpeg_ratecontrolmode" = vbr.Set the pre-defined quality level:1: Medium2: Standard3: Good4: Detailed5: Excellent100: Use the quality level in "qpercent"99: Use the quality level in "qvalue"
s<0~(m-1)>_mjpeg_qvalue10~200(Only valid when "capability_api_httpversion" format is XXXXX_1 orXXXXX_3 or XXXXX_4ex: 0301a_1 or 0301a_3 or 0301a_4)or 1~99(Only valid when "capability_api_httpversion" format is XXXXX_2, ex: 0301a_2)4/4 Manualvideo quality level input. The Q value which is used by encoded library directly.* Only valid when "mjpeg_ratecontrolmode" = vbr and s<0~(m-1)>_mjpeg_quant = 99
s<0~(m-1)>_mjpeg_qpercent1~1004/4Select customized quality in a normalized full range.1: Worst quality100: Best quality* Only valid when "mjpeg_ratecontrolmode" = vbr and s<0~(m-1)>_mjpeg_quant = 100.
s<0~(m-1)>_mjpeg_maxvbrbit rate20000~"capability_videoin_c<0~(n-1)>_mjpeg_maxbitrate"4/4 The maxmaximum allowed bit rate in fixed quality mode.When the bit rate exceeds this value, frames will be dropped to restrict the bit rate.* Only valid when "mjpeg_ratecontrolmode" = vbr
s<0~(m-1)>_mjpeg_cbr_quant1~5, 1004/4Set the pre-defined quality level:1: Medium2: Standard3: Good4: Detailed5: Excellent100: Use the quality level in "cbr_qpercent"* Only valid when "mjpeg_ratecontrolmode" = cbr.
s<0~(m-1)>_mjpeg_cbr_qpercent1~1004/4Select customized quality in a normalized full range.1: Worst quality100: Best quality* Only valid when "mjpeg_ratecontrolmode" = cbr and "quant" = 100.
s<0~(m-1)>_mjpeg_bitrate20000~"capability_videoin_c<0~(n-1)>_mjpeg_maxbitrate"4/4The target bit rate in constant bit rate mode.* Only valid when "mjpeg_ratecontrolmode" = cbr
s<0~(m-1)>_mjpeg_prioritypolicyframerate,imagequality4/4Set prioritypolicy* Only valid when "mjpeg_ratecontrolmode" = cbr
s<0~(m-1)>_mjpeg_maxframe1~"capability_videoin_c<0~(n-1)>_mjpeg_maxframerate"1/4The maximum frame rates of a mjpeg stream at different resolutions("capability_videoin_c<0~(n-1)>_resolution") are recorded in "capability_videoin_c<0~(n-1)>_mjpeg_maxframerate"
s<0~(m-1)>_ra tiocorrect1/4Change resolution to fit 4:3 ratio. For PAL:D1/4CIF(720/704x576) -> (768x576) CIF(352x288)->(384x288) For NTSC:D1/4CIF(720/704x480) -> (640x480) CIF(352x240)->(320x240)* Only available when capability_videoin_type is 0 or 1.
wdrpro_modeproduct dependent>0, 1, 24/40: Disable WDR Pro.1: Enable WDR Pro.* Only valid when "capability_image_c<0~(n-1)>_wdrpro_mode" = 12: Enable WDR Pro II.* Only valid when "capability_image_c<0~(n-1)>_wdrpro_mode" = 2
wdrpro_strengthproduct dependent>1~1004/4The strength of WDR Pro.The bigger value means the stronger strength of WDR Pro.* Only available when "capability_image_c<0~(n-1)>_wdrpro_strength" is 1
wdrc_modeproduct dependent>4/4Enable WDR enhanced.* Only available when "capability_image_c<0~(n-1)>_wdrc_mode" is 1
wdrc_strengthproductdependent>1~1004/4The strength of WDR enhanced.The bigger value means the strongerstrength of WDR enhanced.* Only available when"capability_image_c<0~(n-1)>_wdrc_mode" is 1
aespeed_mode4/4Turning AE converge speed on or off.0: off1: on* Only available when"capability_image_c<0~(n-1)>_aespeed" is 1
aespeed_speedlevel1~1004/4The speed level of AE converge speed.1~20: level 121~40: level 241~60: level 361~80: level 481~100: level 5Level 1~4(low ~ high)The higher speed level meas shorterAE converged time during AE executing.* Only available when"capability_image_c<0~(n-1)>_aespeed" is 1
aespeed_sensitivity1~1004/4The sensitivity of AE converge speed.1~20: level 121~40: level 241~60: level 361~80: level 481~100: level 5Level 1~4(low ~ high)The higher sensitivity level meas thatit is easy to be trigger while scene changed.* Only available when"capability_image_c<0~(n-1)>_aespeed" is 1 and"capability_image_c<0~(n-1)>_aespeedsupportsensitivity" is 1.
flickerless4/4Turn on(1) or turn off(0) the flickerless mode* Only available when"capability_image_c<0~(n-1)>_flickerless" is 1.
mounttypeceiling, wall, floor1/6Hardware installation.* Only available when"capability_videoin_c<0~(n-1)>_mounttype" != "-" .
enablewatermark0, 11/60: Not to add watermarks on images1: Add watermarks on images* Only available when"capability_fisheye">0
s<0~(m-2)>_fisheyedewarpmode'10, 1P, 2P, 1R, 4R' for ceiling/floor mount'10, 1P, 1R, 4R' for wall mount* Available value is listed in"capability_videoin_c<0~(n-1)>_localdewarp_typeceilingmount" and"capability_videoin_c<0~(n-1)>_localdewarp_typewallmount"1/4Local dewarp mode."10" is original mode (disable).Supported dewarp mode is different by mount type.* Only available when"capability_fisheyelocaldewarp_c<0~(capability_nvideoin)-1>" >0

Group: videoin_c<0\~(n-1)>_s<0\~(m-1)>_h264_smartstream2 (capability_smartstream_support=1 and capability_smartstream_version>=2.0)

Group: videoin_c<0\~(n-1)>_s<0\~(m-1)>_h265_smartstream2 (capability_smartstream_support=1, capability_smartstream_version>=2.0 and h265 is listed in "capability_videoin_codec")

n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream"

NAMEVALUESECURITY (get/set)DESCRIPTION
NAME VALUE SECURITY(get/set)DESCRIPTION
enable4/4Enable or Disable smart codec function
mode autotracking,manual,hybrid4/4 Set Smart stream mode"autotracking": only available when "capability_smartstream_mode_autotracking" is 1."manual": only available when "capability_smartstream_mode_manual" is 1."hybrid": only available when "capability_smartstream_mode_hybrid" is 1.
qualitypriority-5,-4,-3,-2,-1,1,2,3,4,54/4The differential value of Q between the regions of interest (ROI) and the areas of non-interest (non-ROI) of the display image.If the value is a positive number, the video quality of ROI is better than the non-ROI areas. The level is from 1 to 5. Level 5 is the maximum level of the quality difference between the ROI and non-ROI areas.If the value is a negative number, the video quality of non-ROI areas is better than the ROI. The level is from -1 to -5. Level -5 is the maximum level of the quality difference between the ROI and non-ROI areas.

Group: videoin_c<0\~(n-1)>_s<0\~(m-1)>_h264_smartstream2_win_i<0\~(k-1)>

(capability_smartstream_support=1, capability_smartstream_version>=2.0 and

capability_smartstream_mode_manual = 1)

Group: videoin_c<0\~(n-1)>_s<0\~(m-1)>_h265_smartstream2_win_i<0\~(k-1)>

(capability_smartstream_support=1, capability_smartstream_version>=2.0 and h265 is listed in

"capability_videoin_codec" and capability_smartstream_mode_manual = 1)

n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream", k denotes the value of "capability_smartstream_nwindow_manual".

NAME VALUE SECURITY(get/set)DESCRIPTION
enable4/4Enable or disable the window.
home0~320,0~2404/4Left-top corner coordinate of the window.
size0~320x0~2404/4Width and height of the window

7.8.1.1 Alternative Video Input Profiles per Channel

In addition to the primary setting of video input, there can be alternative profile video input setting for each channel which might be for different scene of light (daytime or nighttime).

Group: videoin_c<0\~(n-1)>_profile_i<0\~(m-1)> for n channel products and m profile

n denotes the value of "capability_nvideoin" and m denotes the value of

"capability_nvideoinprofile" (capability_nvideoinprofile>0)

NAMEVALUESECURITY (get/set)DESCRIPTION
enable4/4Enable/disable this profile setting
policynight, schedule4/4The mode which the profile is applied to.* Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a.* "policy=night" is only available when "capability_daynight_c<0~(n-1)>_support >0".
begintimehh:mm4/4Begin time of schedule mode.
endtimehh:mm4/4End time of schedule mode.
minexposure<1~32000>, <5~32000>, <1~8000>, <5~8000>, etc.* Available value is listed in4/4 Minimum exposure time1~32000 => 1s ~ 1/32000s5~32000 => 1/5s ~ 1/32000s1~8000 => 1s ~ 1/8000s5~8000 => 1/5s ~ 1/8000setc.* Only available when "capability_image_c<0~(n-1)>_exposum exposure time1~32000 => 1s ~ 1/32000s5~32000 => 1/5s ~ 1/32000s1~8000 => 1s ~ 1/8000s5~8000 => 1/5s ~ 1/8000setc.* Only available when "capability_image_c<0~(N-1)>_exposu
NAME VALUE SECURITY(get/set)DESCRIPTION
"capability_image_c<0~(n-1)>_exposure_minrange"re_minrange" != "-" * Only valid when "piris_mode" = manual or "irismode" = fixed * Only available when "capability_image_c<0~(n-1)>_exposure_rangetype" is "twovalues".
maxexposure<1~32000>, <5~32000>, <1~8000>, <5~8000>, etc. * Available value is listed in "capability_image_c<0~(n-1)>_exposure_maxrange"4/4 Maximum exposure time 1~32000 => 1s ~ 1/32000s 5~32000 => 1/5s ~ 1/32000s 1~8000 => 1s ~ 1/8000s 5~8000 => 1/5s ~ 1/8000s etc. * This parameter may also restrict image frame rate from sensor due to sensor generates a frame per exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s. * Only available when "capability_image_c<0~(n-1)>_exposure_maxrange" != "-" * Only valid when "piris_mode" = manual or "irismode" = fixed * Only available when "capability_image_c<0~(n-1)>_exposure_rangetype" is "twovalues".
shuttervalue<1~32000>, <5~32000>, <1~8000>, <5~8000>, etc. * Available value is listed in4/4Exposure time 1~32000 => 1s ~ 1/32000s 5~32000 => 1/5s ~ 1/32000s 1~8000 => 1s ~ 1/8000s 5~8000 => 1/5s ~ 1/8000s etc. * This parameter may also restrict
NAME VALUE SECURITY(get/set)DESCRIPTION
"capability_image_c<0~(n-1)>_exposure_maxrange"image frame rate from sensor due to sensor generates a frame per exposure time. Ex: If this is set to 1/5s ~ 1/8000s and camera takes 1/5s on the night, then sensor only outputs 5 frame/s.* Only available when "capability_image_c<0~(n-1)>_exposure_maxrange" != "-" and "capability_image_c<0~(n-1)>_exposure_rangetype" is "onevalue".* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
enableblc4/4Enable backlight compensation.* Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.* It's recommended to use "exposurewin_c<no>mode" to switch on/off BLC.
exposurelevel0~124/4Exposure level"0,12": This range takes the concept from DC's exposure tuning options.The definition is:0: EV -2.01: EV -1.72: EV -1.33: EV -1.04: EV -0.75: EV -0.36: EV 07: EV +0.38: EV +0.79: EV +1.0
NAME VALUE SECURITY(get/set)DESCRIPTION
10: EV +1.311: EV +1.712: EV +2.0*Only available when"capability_image_c0_exposure_mode" != 0
exposuremodeauto,shutterpriority,irispriority,qualitypriority,manual,etc(Available options are list in"capability_image_c<0~(n-1)>_exposure_modetype")4/4 Select exposure mode."auto": Automatically adjust the Iris, Gain and Shutter Speed to fit the exposure level."shutterpriority": Manually adjust with variable Shutter Speed, and keep adjusting Iris, Gain automatically."irispriority": Manually adjust with variable Iris, and keep adjusting Gain and Shutter speed automatically."qualitypriority": Automatically adjust the Iris, Gain and Shutter Speed by VIVOTEK quality algorithm."manual": Manually adjust with variable Shutter, Iris and Gain.* We support this parameter when the version number (httpversion) is equal or greater than 0302a.*Only available when"capability_image_c0_exposure_mode" != 0
whitebalanceauto,panorama,manual,rbgain,widerange,outdoor,indoor,sodiumauto,etc4/4Modes of white balance."auto": Auto white balance"panorama": indicates that camera would try to balance the white balance effect of every sensor."rbgain": Use rgain and bgain to set white balance manually."manual": 2 cases:a. if "rbgain" is not supported, this
NAME VALUE SECURITY(Available values are listed in "capability_image_c<0~(n-1)>_wbmode")DESCRIPTIONmeans keep current white balance status.b. if "rbgain" is supported, "rgain" and "bgain" are updated to the current values which is got from white balance module. Then, act as rbgain mode"widerange": Auto Tracing White balance (2000K to 10000K). "outdoor": auto white balance mode specifically for outdoor."indoor": auto white balance mode specifically for indoor."sodiumauto": sodium vapor lamps.* Only available when "capability_image_c<0~(n-1)>_wbmode" != "-"
rgain0~1004/4Manual set rgain value of gain control setting.0: Weak <-> 100: Strong* Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbmode".* Only valid when "videoin_c<0~(n-1)>_whitebalance" != auto* Normalized range.
bgain0~1004/4Manual set bgain value of gain control setting.0: Weak <-> 100: Strong* Only available when "rbgain" is listed in "capability_image_c<0~(n-1)>_wbmode".* Only valid when
NAME VALUE SECURITY(get/set)DESCRIPTION
"videoin_c<0~(n-1)>_whitebalance" != auto* Normalized range.
maxgain0~1004/4Maximum gain value.0: Low <-> 100: High* Only available when "capability_image_c<0~(n-1)>_agc_maxgain" != "-"* Only valid when "piris_mode" = manual or "irismode" = fixed* Normalized range.* Only available when "capability_image_c<0~(n-1)>_exposure_rangetype" is "twovalues".
mingain0~1004/4Minimum gain value.0: Low <-> 100: High* Only available when "capability_image_c<0~(n-1)>_agc_mingain" != "-"* Only valid when "piris_mode" = manual or "irismode" = fixed* Normalized range.* Only available when "capability_image_c<0~(n-1)>_exposure_rangetype" is "twovalues".
gainvalue0~1004/4Gain value.0: Low <-> 100: High* Only available when "capability_image_c<0~(n-1)>_agc_maxgain" != "-" and "capability_image_c<0~(n-1)>_exposure_rangetype" is "onevalue".* Normalized range.* We support this parameter whenthe version number (httpversion) is equal or greater than 0302a.
meteringmodeauto,blc,hlc* Available value is listed in"capability_image_c<0~(n-1)>_exposure_meteringmode"4/4"auto": The algorithm chooses the best metering strategy."blc": This metering method increases the weight of dark area."hlc": The metering method can detect strong light and make affected area clear.* We support this parameter when the version number (httpversion) is equal or greater than 0311a.
piris_modemanual, indoor, outdoor,-1/4Control P-Iris mode."outdoor": Auto-setting P-Iris to get best quality, but easy to meet rolling or flicker effect in indoor environment."indoor": Avoid rolling and flicker effect first."manual": Manual set P-Iris by "piris_position"."-": not support (only available when "capability_image_c<0~(n-1)>_sensor type" is "smartsensor")* Only available when "capability_image_c<0~(n-1)>_iristype"=piris
piris_position1~1001/4Manual set P-Iris.1: Open <-> 100: Close* Only valid when "piris_mode" = manual or "capability_image_c<0~(n-1)>_sensor type" is "smartsensor"* Only available when "capability_image_c<0~(n-1)>_iristype" =piris
irismodefixed, indoor, outdoor4/4Control DC-Iris mode."outdoor": Auto-setting DC-Iris to get best quality, but easy to meet rolling or flicker effect in indoor environment."indoor": Avoid rolling and flicker effect first."fixed": Open the iris to maximum.* Only available when"capability_image_c<0~(n-1)>_iristype"=dciris
wdrpro_mode0, 1, 24/40: Disable WDR Pro.1: Enable WDR Pro.* Only valid when"capability_image_c<0~(n-1)>_wdrpro_mode" = 12: Enable WDR Pro II.* Only valid when"capability_image_c<0~(n-1)>_wdrpro_mode" = 2
wdrpro_strength1~1004/4The strength of WDR Pro.The bigger value means the stronger strength of WDR Pro.* Only available when"capability_image_c<0~(n-1)>_wdrpro_strength" is 1
wdrc_mode4/4Enable WDR enhanced.* Only available when"capability_image_c<0~(n-1)>_wdrc_mode" is 1
wdrc_strength1~1004/4The strength of WDR enhanced.The bigger value means the stronger strength of WDR enhanced.* Only available when"capability_image_c<0~(n-1)>_wdrc_mode" is 1
aespeed_mode4/4Turning AE converge speed on or off.0: off1: on* Only available when"capability_image_c<0~(n-1)>_aespeed" is 1
aespeed_speedlevel1~1004/4The speed level of AE converge speed.1~20: level 121~40: level 241~60: level 361~80: level 481~100: level 5Level 1~4(low ~ high)The higher speed level meas shorterAE converged time during AEexecuting.* Only available when"capability_image_c<0~(n-1)>_aespeed" is 1
aespeed_sensitivity1~1004/4The sensitivity of AE converge speed.1~20: level 121~40: level 241~60: level 361~80: level 481~100: level 5Level 1~4(low ~ high)The higher sensitivity level meas thatit is easy to be trigger while scenechanged.* Only available when"capability_image_c<0~(n-1)>_aespeed" is 1 and"capability_image_c<0~(n-1)>_aespeedsupportsensitivity" is 1.
flickerlessdependent>4/4Turn on(1) or turn off(0) the flickerless mode* Only available when"capability_image_c<0~(n-1)>_flickerless" is 1

7.8.2 Multicast Settings for Video Streaming

Group: videoin_c<0\~(n-1)>_s<0\~(m-1)>_multicast (capability_media_streamprofiles_support = 1) n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream"

NAMEVALUESECURITY( get/set)DESCRIPTION
ipaddress4/4Multicast video IP address.
port1025 ~ 655354/4Multicast video port.
ipversionIPv4, IPv64/4The version of internet protocol.
ttl1 ~ 2554/4Multicast video time to live value.

7.9 Time Shift Settings

Group: timeshift for n channel products and m stream

n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream"

(capability_timeshift > 0)

NAMEVALUESECURITY (get/set)DESCRIPTION
enable4/4Enable time shift streaming.* We replace this parameter with "timeshift_c<0~(n-1)>_enable" when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin >1".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
NAME VALUE SECURITY(get/set)DESCRIPTION
c<0~(n-1>_enable4/4Enable time shift streaming.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
c<0~(n-1>_s<0~(m-1>_allow4/4Enable time shift streaming for specific stream.

7.10 IR Cut Control

Group: ircutcontrol (capability_nvideoinprofile> 0 and capability_daynight_c<0\~(n-1)>_support > 0) n denotes the value of "capability_nvideoin"

* We do not support these parameters when "capability_nvideoin > 1"

NAME VALUE SECURITY(get/set)DESCRIPTION
mode<Not recommended to use this>auto,day,night,di,schedule...etc* Available values are listed in"capability_daynight_c<0~(n-1)>_mode"6/6Set IR cut control mode* We replace this parameter with "ircutcontrol_c0_mode" when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin >1".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
sirproduct dependent>recommended to use this>6/6Enable/disable Smart IR* Only available when "capability_daynight_c<0~"capability_nvideoin"-1>_smartir" is 1* We replace this parameter with "ircutcontrol_c<0~(n-1)>_sir" when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin >1".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
daymodebegintime<Not recommended to use this>00:00~23:596/6Day mode begin time* We replace this parameter with "ircutcontrol_c<0~(n-1)>_daymodebegintime" when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin >1"* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
daymodeendtime<Not recommended to use this>00:00~23:596/6Day mod end time* We replace this parameter with "ircutcontrol_c<0~(n-1)>_daymodeendtime" when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin >1"* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
disableirled<Not recommended to use this>enableextled<Not recommended to use this>6/61/6Enable/disable built-in IR led* Only available when "capability_daynight_c<0~"capability_nvideoin"-1>_builtinir >0"* We replace this parameter with "ircutcontrol_illuminators_builtin_irled_enabled" when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin >1".Enable/disable external IR led* Only available when "capability_daynight_c<0~"capability_nvideoin"-1>_externalir >0".* We replace this parameter with "ircutcontrol_illuminators_external_do_enabled" when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin >1".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
enablewled<Not recommended to use this>6/6Enable/disable built-in White led* Only available when "capability_daynight_c<0~"capability_nvideoin"-1>_builtinwled >0".* We replace this parameter with "ircutcontrol_illuminators_builtin_whiteled_enabled" when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin >1".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
bwmode<Not recommended to use this>6/6Switch to B/W in night mode if enabled.* Only available when "capability_daynight_c<0~(n-1)>_blackwhitemode" is 1.
NAME VALUE SECURITY(get/set)DESCRIPTION
* We replace this parameter with "ircutcontrol_c<0~(n-1)>_bwmode" when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin >1".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
sensitivity<Not recommended to use this>low,normal,high,1~1006/6 Sensitivity of day/night control.There are two value format:"low,normal,high": if capability_daynight_c<0~(n-1)>_ircutsensitivity_type=options"1~100": if capability_daynight_c<0~(n-1)>_ircutsensitivity_type=normalize* Only available when "capability_daynight_c<0~(n-1)>_ircutsensitivity_type" is not "-".* We replace this parameter with ircutcontrol_c<0~(n-1)>_sensitivity" when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin >1".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
spectrum_mode<Not recommended to use this>visible,ir,irenhanced,blueenhanced6/6 Set spectrum method .* Only available when "capability_daynight_c<0~(n-1)>_spec trum_support" is 1.* We replace this parameter with
NAME VALUE SECURITY(get/set)DESCRIPTION
* Available values are listed in "capability_daynight_c<0~(n-1)>_spectrum_mode"."ircutcontrol_illuminators_spectrum_mode" when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin > 1"* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.

7.10.1 IR cut control setting per channel

Group: ircutcontrol_c<0\~(n-1)> for n channel products (capability_daynight_c<0\~(n-1)>_support > 0)

n denotes the value of "capability_nvideoin"

NAMEVALUESECURITY(get/set)DESCRIPTION
mode auto,day,night,di,schedule...etc* Available values are listed in "capability_daynight_c<0~(n-1)>_mode"6/6Set IR cut control mode* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
sir6/6Enable/disable Smart IR* Only available when "capability_daynight_c<0~"capability_nvideoin"-1>_smartir" is 1* We support this parameter when the version number (httpversion) isequal or greater than 0312a.
daymodebegintime00:00~23:596/6Day mode begin time* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
daymodeendtime00:00~23:596/6Day mod end time* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
bwmode6/6Switch to B/W in night mode if enabled.* Only available when "capability_daynight_c<0~(n-1)>blackwhitemode" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
sensitivity low,normal,high1~1006/6 Sensitivity of day/night control.There are two value format:"low,normal,high": if capability_daynight_c<0~(n-1)>ircutsensitivity_type=options"1~100": if capability_daynight_c<0~(n-1)>ircutsensitivity_type=normalize* Only available when "capability_daynight_c<0~(n-1)>ircutsensitivity_type" is not "-".* We support this parameter when the version number (httpversion) is equal or greater than 0312a.

7.10.2 IR cut control Illuminators

Group: ircutcontrol_illuminators (capability_daynight_c<0\~(n-1)>_support > 0)

n denotes the value of "capability_nvideoin"

k is determined by the below criterion:

The following applies for capability_extension_do_num >= 0

* if extension_connected=1, k=capability_ndo
* if extension_connected=0, k=capability_ndo+ capability_extension_do_num
* k=capability_ndo

Otherwise,

NAME VALUE SECURITY (get/set)DESCRIPTION
builtin_irled_enabled6/6Enable/disable built-in IR led* Only available when"capability_daynight_illuminators_builtin_support >0" and "irled" is listed in"capability_daynight_illuminators_builtin_type"* We support this parameter whenthe version number (httpversion) isequal or greater than 0312a.
builtin_whiteled_enable d6/6Enable/disable built-in white led* Only available when"capability_daynight_illuminators_builtin_support >0" and "whiteled" islisted in "capability_daynight_illuminators_builtin_type"* We support this parameter whenthe version number (httpversion) isequal or greater than 0312a.
external_do_enabled1/6Enable/disable external led mountedon do1* Only available when"capability_daynight_illuminators_external_support >0" and "do" is listedin"capability_daynight_illuminators_external_interface"* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
external_do<2~(k)>_enabled1/6Enable/disable external led mounted on do<2~(k)>.* Only available when "capability_ndo >1"* Only available when "capability_daynight_illuminators_external_support >0" and "do<2~(k)"> are listed in "capability_daynight_illuminators_external_interface".* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
spectrum_mode visible,ir,irenhanced,blueenhanced** Available values are listed in "capability_daynight_illuminators_spectrum_mode".6/6 Set spespectrum method .* We support this parameter when the version number (httpversion) is equal or greater than 0312a.* Only available when "capability_daynight_illuminators_spectrum _support >0".

7.11 Image Setting per Channel

Group: image_c<0\~(n-1)> for n channel products and m profile

n denotes the value of "capability_nvideoin" and m denotes the value of "capability_nvideoinprofile"

NAME VALUE SECURITY(get/set)DESCRIPTION
brightness<Notrecommended to use this>-5~5,1004/4
contrast<Notrecommended to use this>-5~5,1004/4
saturation<Notrecommended to use this>-5~5,1004/4
NAME VALUE SECURITY(get/set)DESCRIPTION
"saturationpercent".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
sharpness<Not recommended to use this>-3~3,1004/4-3: Softer <-> 3: Sharper100: Use "image_c<0~(n-1)>_sharpnesspercent"* Only available when bit 3 of"capability_image_c<0~(n-1)>_basicsetting" is 1.* We replace "sharpness" with"sharpnesspercent".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
brightnesspercent0~1004/4Set brightness in the normalized range.0: Darker <-> 100: Bright* Only available when bit 0 of"capability_image_c<0~(n-1)>_basicsetting" is 1.
contrastpercent0~1004/4Set contrast in the normalized range.0: Less contrast <-> 100: More contrast* Only available when bit 1 of"capability_image_c<0~(n-1)>_basicsetting" is 1
saturationpercent0~1004/4Set saturation in the normalized range.0: Less saturation <-> 100: More saturation* Only available when bit 2 of"capability_image_c<0~(n-1)>_basicsetting" is 1.
sharpnesspercent0~1004/4Set sharpness in the normalized range.0: Softer <-> 100: Sharper* Only available when bit 3 of "capability_image_c<0~(n-1)>_basicsetting" is 1
gammacurve0~1004/40: Fine-turned gamma curve by Vivotek.1: Gamma value = 0.012: Gamma value = 0.023: Gamma value = 0.03...100: Gamma value = 1* Note: Although we set gamma value to 100 level, but not all gamma values are valid. Internal module will take the closest valid one. For example, 1~45 may all be mapped to gamma value = 0.45, etc.* Only available when "capability_image_c<0~(n-1)>_gammacurve" is 1
lowlightmode4/4Enable/disable low light mode.* Only available when "capability_image_c<0~(n-1)>_lowlightmode" is 1
hlm4/4Enable/disable highlight mask.* Only available when "capability_image_c<0~(n-1)>_hlm" is 1
dnr_mode4/43D noise reduction.0:disable1:enable* Only available when "capability_image_c<0~(n-1)>_dnr" is 1
dnr_strengthdependent>1~1004/4Strength of 3DNR* Only available when"capability_image_c<0~(n-1)>_dnr" is 1
defog_mode4/4Enable/disable defog mode.0:disable1:enable* Only available when"capability_image_c<0~(n-1)>_defog_mode" is 1
defog_strength1~1004/4Strength of defog* Only available when"capability_image_c<0~(n-1)>_defog_mode" is 1
eis_mode4/4Electronic image stabilizer0:disable1:enable* Only available when 'eis' is listed in"capability_image_c<0~(n-1)>_is_mode".
eis_strength1~1004/4Strength of electronic image stabilizer* Only available when 'eis' is listed in"capability_image_c<0~(n-1)>_is_mode".
dis_mode4/4Digital image stabilizer0:disable1:enable* Only available when 'dis' is listed in"capability_image_c<0~(n-1)>_is_mode".
dis_strength1~1004/4Strength of digital image stabilizer* Only available when 'dis' is listed in"capability_image_c<0~(n-1)>_is_mode".
scene_modevisibility,noiseless,lpcparkinglot,lpcstreet,4/4 Value of scene mode* Only available when"capability_image_c<0~(n-1)>_scene mode_support" is 1
lpchighway, auto, deblur, lpcfreeway, signallight, railtrack* Available values are listed in "capability_image_c<0~(n-1)>_scenemode_supporttype"
restoreatwb4/4Restore of adjusting white balance of image according to mode settings
freeze4/4Enable/disable Image freeze while patrolling.0: disable1: enable* Only available when "capability_image_c<0~(n-1)>_freeze" is 1
deinterlace_enable4/4Enable/disable deinterlace function.0: disable1: enable* Only available when "capability_image_c<0~(n-1)>_deinter lace_support" is 1.
deinterlace_modespatial,blend4/4Users can choose between two different deinterlacing techniques: Spatial mode provides the best image quality, while Blend mode provides better image quality (than not using the deinterlace function at all).* Only available when "capability_image_c<0~(n-1)>_deinter
NAME VALUE SECURITY(get/set)DESCRIPTION
lace_support" is 1.
xoffset0~1004/4Adjusting the image to proper position horizontally.* Only available when the bit 4 of capability_image_c<0~(n-1)>_basicsetting is 1.
yoffset0~1004/4Adjusting the image to proper position vertically.* Only available when the bit 5 of capability_image_c<0~(n-1)>_basicsetting is 1.
lens_alignment0~1004/4Stitch the sensors together into focused position.* Only available when "capability_image_c<0~(n-1)>_lens_alignment" is 1.
lens_ldc_mode4/4Enable/disable lens distortion correction.* Only available when "capability_image_c<0~(n-1)>_lens_ldc_support" is 1.
palette_modeAvailable value is listed in "capability_image_c<0~(n-1)>_palette_mode"1/4 Set color palette option.* Only available when "capability_image_c<0~(n-1)>_palette_support" is 1.
profile_i<0~(m-1)>_enable4/4Enable/disable this profile setting
profile_i<0~(m-1)>_policynight, scheduleproduct dependent>4/4 The mode which the profile is applied to.* Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a.
NAME VALUE SECURITY(get/set)DESCRIPTION
* "policy=night" is only available when "capability_daynight_c<0~(n-1)>_support > 0".
profile_i<0~(m-1)>_begintimehh:mm 4/4 Begin time of schedule mode.
profile_i<0~(m-1)>_endtimehh:mm4/4End time of schedule mode.
profile_i<0~(m-1)>_brightness<Not recommended to use this>-5~5,1004/4-5: Darker <-> 5: Bright100: Use "image_c<0~(n-1)>_brightnesspercent"* Only available when bit 0 of "capability_image_c<0~(n-1)>_basicsetting" is 1* We replace "profile_i0_brightness" with "profile_i0_brightnesspercent".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
profile_i<0~(m-1)>_contrast<Not recommended to use this>-5~5,1004/4-5: Less contrast <-> 5: More contrast100: Use "image_c<0~(n-1)>_contrastpercent"* Only available when bit 1 of "capability_image_c<0~(n-1)>_basicsetting" is 1.* We replace "profile_i0_contrast" with "profile_i0_contrastpercent".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
profile_i<0~(m-1)>_saturation<Not-5~5,1004/4-5: Less saturation <-> 5: More saturation100: Use "
NAME VALUE SECURITY(get/set)DESCRIPTION
recommended to use this>image_c<0~(n-1)>_saturationpercent"* Only available when bit 2 of "capability_image_c<0~(n-1)>_basicsetting" is 1.* We replace "profile_i0_saturation" with "profile_i0_saturationpercent".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
profile_i<0~(m-1)>_sharpness<Not recommended to use this>-3~3,1004/4
profile_i<0~(m-1)>_brightnesspercent0~1004/4
profile_i<0~(m-1)>_contrastpercent0~1004/4
NAME VALUE SECURITY(get/set)DESCRIPTION
tting" is 1
profile_i<0~(m-1)>_saturationpercent0~1004/4Set saturation in the normalized range.0: Less saturation <-> 100: More saturation* Only available when bit 2 of "capability_image_c<0~(n-1)>_basicsetting" is 1.
profile_i<0~(m-1)>_sharpnesspercent0~1004/4Set sharpness in the normalized range.0: Softer <-> 100: Sharper* Only available when bit 3 of "capability_image_c<0~(n-1)>_basicsetting" is 1
profile_i<0~(m-1)>_gammacurve0~1004/40: Fine-turned gamma curve by Vivotek.1: Gamma value = 0.012: Gamma value = 0.023: Gamma value = 0.03...100: Gamma value = 1* Note: Although we set gamma value to 100 level, but not all gamma values are valid. Internal module will take the closest valid one. For example, 1~45 may all be mapped to gamma value = 0.45, etc.* Only available when "capability_image_c<0~(n-1)>_gammacurve" is 1
profile_i<0~(m-1)>_lowlightmode4/4Enable/disable low light mode.* Only available when "capability_image_c<0~(n-1)>_lowlightmode" is 1
profile_i<0~(m-1)>_hlmNAME VALUE SECURITY4/4(get/set)Enable/disable highlight mask.* Only available whenDESCRIPTION
"capability_image_c<0~(n-1)>_hlm" is 1
profile_i<0~(m-1)>_dnr_mode4/43D noise reduction.0:disable1:enable* Only available when"capability_image_c<0~(n-1)>_dnr" is 1
profile_i<0~(m-1)>_dnr_strength1~1004/4Strength of 3DNR* Only available when"capability_image_c<0~(n-1)>_dnr" is 1
profile_i<0~(m-1)>_defog_mode4/4Enable/disable defog mode.0:disable1:enable* Only available when"capability_image_c<0~(n-1)>_defog_mode" is 1
profile_i<0~(m-1)>_defog_strength1~1004/4Strength of defog* Only available when"capability_image_c<0~(n-1)>_defog_mode" is 1
profile_i<0~(m-1)>_eis_mode4/4Electronic image stabilizer0:disable1:enable* Only available when 'eis' is listed in"capability_image_c<0~(n-1)>_is_mode".
profile_i<0~(m-1)>_eis_strength1~1004/4Strength of electronic image stabilizer* Only available when 'eis' is listed in"capability_image_c<0~(n-1)>_is_mode".
profile_i<0~(m-1)>_dis_mode4/4Digital image stabilizer0:disable1:enable* Only available when 'dis' is listed in"capability_image_c<0~(n-1)>_is_mode".
profile_i<0~(m-1)>_dis_strengthproduct>1~1004/4Strength of digital image stabilizer* Only available when 'dis' is listed in "capability_image_c<0~(n-1)>_is_mode".

7.12 Exposure Window Setting per Channel

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

n denotes the value of "capability_nvideoin"

(Only available when "capability_image_c<0\~(n-1)>_exposure_mode"=1)

NAME VALUESECURITY(get/set)DESCRIPTION
modeauto, custom,blc,hlc,center* Available values are listed in"capability_image_c<0~(n-1)>_exposure_winmode"4/4"auto": Use full image view as the only exposure window."custom": Use custom windows."blc": Use BLC(Back Light Compensation), and the only exposure window is located at the center of view."hlc": Use HLC (High Light Compensation), and to perform the masking of bright light area."center": Use Center window as metering area and give the necessary light compensation.

7.12.1. Exposure Window Setting for Each Window

Group: exposurewin_c<0\~(n-1)>_win_i<0\~(k-1)>

n denotes the value of "capability_nvideoin",

k denotes the value of "capability_image_c<0\~(n-1)>_exposure_winnum".

(Only available when "capability_image_c<0\~(n-1)>_exposure_mode" = 1 and when custom is listed in "capability_image_c<0\~(n-1)>_exposure_winmode" and valid when

"exposurewin_c<0\~(n-1)>_mode"=custom or "exposurewin_c<0\~(n-1)>_mode"=hlc)

NAME VALUESECURITY(get/set)DESCRIPTION
enable4/4 Enable or disable the window.
policy0~14/4 0: Indicate exclusive.1: Indicate inclusive.* Only available when exclusive is listed in "capability_image_c<0~(n-1)>_exposure_wintype".
home<0~320,0~240>4/4 Left-top corner coordinate of the window.* Only available when qvga is listed in "capability_image_c<0~(n-1)>_exposure_windomain".
size<0~320x0~240>4/4 Width and height of the window.* Only available when qvga is listed in "capability_image_c<0~(n-1)>_exposure_windomain".
homepx<0~W,0~H>W: 0~ The current image width -1H: 0~ The current image height -14/4 Left-top corner coordinate of the window.* Only available when px is listed in "capability_image_c<0~(n-1)>_exposure_windomain".
sizepx<0~Wx0~ H>W: 0~ The current image width -1H: 0~ The current image height -14/4 Width and height of the window.* Only available when px is listed in "capability_image_c<0~(n-1)>_exposure_windomain".
homestead<0~9999,0~9999>4/4 Left-top corner coordinate of the window.
NAME VALUE SECURITY(get/set)DESCRIPTION
* Only available when std is listed in "capability_image_c<0~(n-1)>_exposure_windomain".
sizestd<0~9999x0~9999>4/4Width and height of the window.* Only available when std is listed in "capability_image_c<0~(n-1)>_exposure_windomain".

Group: exposurewin_c<0\~(n-1)>_profile_i<0\~(m-1)> for n channel product and m profile, n denotes the value of "capability_nvideoin", m denotes the value of "capability_nvideoinprofile", (Only available when "capability_image_c<0\~(n-1)>_exposure_mode"=1)

NAME VALUESECURITY(get/set)DESCRIPTION
modeauto, custom,blc,hlc,center* Available values are listed in"capability_image_c<0~(n-1)>_exposure_winmode"4/4The 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(Back Light Compensation), and the only exposure window is located at the center of view."hlc": Use HLC (High Light Compensation), and to perform the masking of bright light area."center": Use Center window as metering area and give the necessary light compensation.

Group: exposurewin_c<0\~(n-1)>_profile_i<0\~(m-1)>_win_i<0\~(k-1)> for m profile and n channel product,

n denotes the value of "capability_nvideoin", m denotes the value of "capability_nvideoinprofile", k denotes the value of "capability_image_c<0\~(n-1)>_exposure_winnum".

(Only available when "capability_image_c<0\~(n-1)>_exposure_mode" = 1 and when custom is listed in "capability_image_c<0\~(n-1)>_exposure_winmode" and valid when

"exposurewin_c<0\~(n-1)>_mode"=custom or "exposurewin_c<0\~(n-1)>_mode"=hlc)

NAME VALUE SECURITY(get/set)DESCRIPTION
enable4/4Enable or disable the window.
policy0~14/40: Indicate exclusive.1: Indicate inclusive.* Only available when exclusive is listed in "capability_image_c<0~(n-1)>_exposure_wintype".* "policy=night" is only available when "capability_daynight_c<0~(n-1)>_support > 0".
home<0~320,0~240>4/4Left-top corner coordinate of the window.* Only available when qvga is listed in "capability_image_c<0~(n-1)>_exposure_windomain".
size<0~320x0~240>4/4Width and height of the window.* Only available when qvga is listed in "capability_image_c<0~(n-1)>_exposure_windomain".
homepx<0~W,0~H>W: 0~ The current image width -1H: 0~ The current image height -14/4Left-top corner coordinate of the window.* Only available when px is listed in "capability_image_c<0~(n-1)>_exposure_windomain".
sizepx<0~Wx0~ H>W: 0~ The current image width -1H: 0~ The current image height -14/4 Width and height of the window.* Only available when px is listed in "capability_image_c<0~(n-1)>_exposure_windomain".
homestead<0~9999,0~9999>4/4Left-top corner coordinate of the window.* Only available when std is listed in "capability_image_c<0~(n-1)>_exposure_windomain".
sizestd<0~9999x0~9999>4/4Width and height of the window.* Only available when std is listed in "capability_image_c<0~(n-1)>_exposure_windomain".

7.13 Audio Input per Channel

Group: audioin_c<0\~(n-1)>(capability_naudioin>0)

n denotes the value of "capability_naudioin"

NAME VALUE SECURITY(get/set)DESCRIPTION
source<Not recommended to use this>micin, lineinproduct dependent>4/4micin => use built-in microphone input.linein => use external microphone input.* We replace this parameter with “audioin_c<0~(n-1)>_input” when the version number (httpversion) is equal or greater than 0301a.
input intmic, extmic4/4intmic: Internal (built-in) microphone.(Only available when capability_audio_intmic = 1)extmic: External microphone input.(Only available when capability_audio_extmic =1)* Note: If physical microphone switch is showed on product, this value is updated during booting to fit switch status.
volume_internal0~1004/4Volume when take internal microphone as input source.0: Minimum100: Maximum* Only available when the channel supports internal microphone (The related bit of "capability_audio_intmic" is equal to 1).
volume_external0~1004/4Volume when take external microphone as input source.0: Minimum100: Maximum* Only available when the channel supports external microphone (The related bit of "capability_audio_extmic" is equal to 1).
mute0, 11/40: Mute off1: Mute on
gain<Not recommended to use this>0~1004/4Gain of input.(audioin_c<0~(n-1)>_source = linein)* Reserved for compatibility, and suggest don't use this since the version number (httpversion) is equal or greater than 0301a.* We replace "gain" with "volume_internal" and "volume_external". More details, please refer the parameter description of "volume_internal" and "volume_external".
boostmic<Not recommended to use this>0~1004/4Enable microphone boost.Gain of input.(audioin_c<0~(n-1)>_source = micin)* Reserved for compatibility, and suggest don't use this since the version number (httpversion) is equal or greater than 0301a.* We replace "boostmic" with "volume_internal" and "volume_external". More details, please refer the parameter description of "volume_internal" and "volume_external".
s0_codectype aac4, gamr, g711, g726(Available codec are listed in "capability_audioCODEC")4/4 Set audio codec type for input.aac4: Advanced Audio Coding (AAC)gamr: Adaptive Multi-Rate (AMR)g711: G.711g726: G.726
s0_aac4_bitrate16000,32000,48000,64000,96000,1280004/4Set AAC4 bitrate in bps.* Only available if AAC is supported.
s0_gamr_bitrate 4750,5150,5900,6700,7400,7950,10200,122004/4 AMR encoded bitrate in bps.* Only available if AMR is supported.
s0_g711_modepcmu,pcma4/4Set G.711 companding algorithm.pcmu: μ-law algorithmpcma: A-law algorithm* Only available if G.711 is supported.
s0_g726_bitrate16000,24000,4/4 Set G.726 encoded bitrate in bps.* Only available if G.726 is supported.
32000,40000
s0_g726_bitstream packingmodelittle, big4/4Set G.726 bit streaming packing mode.little: Little-endian bitstream format.big: Big-endian bitstream format.* Only available if G.726 is supported.
s0_g726_vlcmode0, 14/4Enable vlcmode for G.726.0: Standard mode.1: Solve compatibility problem with VLC player.* Only available if G.726 is supported.
aec_enable4/4Enable acoustic echo cancellation.* Only available when "capability_audio_aecmode" is "manual"* We support this parameter when the version number (httpversion) is equal or greater than 0306b.
alarm_enable4/4Enable audio detection
alarm_level1~1004/4Audio detection alarm level
profile_i0_enable4/4Enable/disable this profile setting
profile_i0_policynight,scheduleproductdependent>4/4The mode which the profile is applied to.* Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a.* "policy=night" is only available when "capability_daynight_c<0~(n-1)>_support >0".
profile_i0_begintimehh:mm4/4Begin time of schedule mode.
profile_i0_endtimehh:mm4/4End time of schedule mode.
profile_i0_alarm_level1~1004/4Audio detection alarm level

7.13.1. Multicast Settings for Audio Streaming

Group: audioin_c<0\~(n-1)>_s0_multicast (capability_naudioin > 0 and

capability_media_streamprofiles_support = 1)

n denotes the value of "capability_naudioin"

NAME VALUE SECURITY(get/set)DESCRIPTION
ipaddress4/4Multicast audio IP address.
port1025 ~ 655354/4Multicast audio port.
ipversionIPv4, IPv64/4The version of internet protocol.
ttl1 ~ 2554/4Multicast audio time to live value.

7.14 Audio Output per Channel

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

n denotes the value of "capability_naudioout"

NAME VALUE SECURITY(get/set)DESCRIPTION
volume0~1004/4Adjusting audio volume

7.15 Play an Audio Clip

Group: audioclip_i<0\~1> (capability_audio_audioclip=1)

NAMEVALUESECURITY (get/set)DESCRIPTION
namestring[40]1/4Specify the audio clip name that can be played when an event occurs.
size0,1/4The size of audio clip.

Group: audioclip (capability_audio_audioclip=1)

NAMEVALUESECURITY (get/set)DESCRIPTION
prerecord_seconds1~101/4Indicates the seconds that can be waited before audio clip start to
NAME VALUE SECURITY(get/set)DESCRIPTION
record.

7.16 Motion Detection Settings

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

n denotes the value of "capability_nvideoin"

NAME VALUESECURITY(get/set)DESCRIPTION
enable4/4Enable motion detection.
win_sensitivity0 ~ 1004/4Sensitivity of all motion detection windows.* The value "0" is reserved for compatibility and will not be used after the version number (httpversion) is equal or greater than 0400a.

7.16.1. Motion Detection for Each Window

Group: motion_c<0\~(n-1)>_win_i<0\~(k-1)>

n denotes the value of "capability_nvideoin", k denotes the value of "capability_nmotion".

NAME VALUE SECURITY(get/set)DESCRIPTION
enable4/4Enable motion detection window.
namestring[14]4/4Name of motion window.
polygonstd0 ~ 9999,0 ~ 9999, 0 ~ 9999,0 ~ 9999, 0 ~ 9999,0 ~ 9999, 0 ~ 9999,0 ~ 99994/4Coordinate of polygon window position.(4 points: x0,y0,x1,y1,x2,y2,x3,y3)* Only available when "capability_motion_wintype" = polygon.* Only available when std is listed in "capability_motion_windomain"
objsize1 ~ 1004/4Percent of motion detection window.
sensitivity<Not recommended to use this>0 ~ 1004/4Sensitivity of motion detection window.* We replace "sensitivity" with "win_sensitivity".* This parameter will not be used after
NAMEVALUESECURITY (get/set)DESCRIPTION
the version number (httpversion) is equal or greater than 0400a.
polygonpx<Not recommended to use this>0 ~ W,0 ~ H, 0 ~ W,0 ~ H, 0 ~ W,0 ~ H, 0 ~ W,0 ~ H, 0 ~ W,0 ~ HW: 0~ The current image width -1H: 0~ The current image height -14/4Coordinate of polygon window position.(4 points: x0,y0,x1,y1,x2,y2,x3,y3)* Only available when "capability_motion_wintype" = polygon.* Only available when px is listed in "capability_motion_windomain"* It's recommended to use polygonsd* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
polygon<Not recommended to use this>0 ~ 320,0 ~ 240, 0 ~ 320,0 ~ 240, 0 ~ 320,0 ~ 240, 0 ~ 320,0 ~ 2404/4Coordinate of polygon window position.(4 points: x0,y0,x1,y1,x2,y2,x3,y3)* Only available when "capability_motion_wintype" = polygon.* Only available when qvga is listed in "capability_motion_windomain"* It's recommended to use polygonsd* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
left<Not recommended to use this>0 ~ 3204/4Left coordinate of window position.* Only available when "capability_motion_wintype" = rectangle.* Only available when qvga is listed in "capability_motion_windomain"* It's recommended to use polygonsd* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
top<Not recommended to use this>0 ~ 2404/4Top coordinate of window position.* Only available when "capability_motion_wintype" = rectangle.* Only available when qvga is listed in "capability_motion_windomain"* It's recommended to use polygonsd* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
width<Not recommended to use this>0 ~ 3204/4Width of motion detection window.* Only available when "capability_motion_wintype" = rectangle.* Only available when qvga is listed in "capability_motion_windomain"* It's recommended to use polygonsd* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
height<Not recommended to use this>0 ~ 2404/4Height of motion detection window.* Only available when "capability_motion_wintype" = rectangle.* Only available when qvga is listed in "capability_motion_windomain"* It's recommended to use polygonsd* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.

Group: motion_c<0\~(n-1)>_profile_i<0\~(m-1)> for m profile and n channel product, n denotes the value of "capability_nvideoin", m denotes the vaule of "capability_nmotionprofile ", (capability_nmotionprofile > 0)

NAMEenableVALUESECURITY (get/set)4/4DESCRIPTIONEnable profile 1 ~ (m-1).
policynight, schedule4/4The mode which the profile is applied to.* Not support "policy=day" anymore when the version number (httpversion) is equal or greater than 0301a.* "policy=night" is only available when "capability_daynight_c<0~(n-1)>_support >0".
begintimehh:mm4/4Begin time of schedule mode.
endtimehh:mm4/4End time of schedule mode.
win_sensitivity0 ~ 1004/4Sensitivity of all motion detection windows.* The value "0" is reserved for compatibility and will not be used after the version number (httpversion) is equal or greater than 0400a.

Group: motion_c<0\~(n-1)>_profile_i<0\~(m-1)>_win_i<0\~(k-1)> for m profile and n channel product,

n denotes the value of "capability_nvideoin", m denotes the vaule of "capability_nmotionprofile", k denotes the value of "capability_nmotion".

NAMEVALUESECURITY (get/set)DESCRIPTION
enable4/4Enable motion detection window.
namestring[14]4/4Name of motion window.
polygonstd0 ~ 9999,0 ~ 9999,0 ~ 9999,0 ~ 9999,0 ~ 9999,0 ~ 9999,0 ~ 99994/4Coordinate of polygon window position.(4 points: x0,y0,x1,y1,x2,y2,x3,y3)* Only available when"capability_motion_wintype" = polygon.* Only available when std is listed in"capability_motion_windomain
objsize1 ~ 1004/4Percent of motion detection window.
sensitivity<Not recommendedto use this>0 ~ 1004/4Sensitivity of motion detection window.* We replace "sensitivity" with"win_sensitivity".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
polygonpx<Not recommended to use this>0 ~ W,0 ~ H, 0 ~ W,0 ~ H, 0 ~ W,0 ~ H, 0 ~ W,0 ~ HW: 0~ The current image width -1H: 0~ The current image height -14/4Coordinate of polygon window position.(4 points: x0,y0,x1,y1,x2,y2,x3,y3)* Only available when "capability_motion_wintype" = polygon.* Only available when px is listed in "capability_motion_windomain"* It's recommended to use polygonsd* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
polygon<Not recommended to use this>0 ~ 320,0 ~ 240, 0 ~ 320,0 ~ 240, 0 ~ 320,0 ~ 240, 0 ~ 320,0 ~ 2404/4Coordinate of polygon window position.(4 points: x0,y0,x1,y1,x2,y2,x3,y3)* Only available when "capability_motion_wintype" = polygon.* Only available when qvga is listed in "capability_motion_windomain"* It's recommended to use polygonsd* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
left<Not recommended to use this>0 ~ 3204/4Left coordinate of window position.* Only available when "capability_motion_wintype" = rectangle.* Only available when qvga is listed in "capability_motion_windomain"* It's recommended to use polygonsd* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
top<Not recommendedto use this>0 ~ 2404/4Top coordinate of window position.* Only available when"capability_motion_wintype" = rectangle.* Only available when qvga is listed in "capability_motion_windomain"* It's recommended to use polygonsd* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
width<Not recommended to use this>0 ~ 3204/4Width of motion detection window.* Only available when "capability_motion_wintype" = rectangle.* Only available when qvga is listed in "capability_motion_windomain"* It's recommended to use polygonsd* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
height<Not recommended to use this>0 ~ 2404/4Height of motion detection window.* Only available when "capability_motion_wintype" = rectangle.* Only available when qvga is listed in "capability_motion_windomain"* It's recommended to use polygonsd* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.

7.17 Tampering Detection Settings

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

n denotes the value of "capability_nvideoin"

NAME VALUE SECURITY(get/set)DESCRIPTION
enable4/4Enable or disable tamper detection.
threshold0~1004/4Threshold of tamper detection.
duration10~6004/4If tampering value exceeds the "threshold" for more than "duration" second(s), then tamper detection is triggered.
ignorewidth 0,integer>1/7 Indicate the width to offset to start to analysis the image.
dark_enable4/4Enable or disable image too dark detection
dark_threshold0~1004/4Threshold of image too dark detection
dark_duration1~104/4If image too dark value exceeds the "threshold" for more than "duration" second(s), then image too dark detection is triggered.
bright_enable4/4Enable or disable image too bright detection
bright_threshold0~1004/4Threshold of image too bright detection
bright_duration1~104/4If image too bright value exceeds the "threshold" for more than "duration" second(s), then image too bright detection is triggered.
blurry_enable4/4Enable or disable image too blurry detection
blurry_threshold0~1004/4Threshold of image too blurry detection
blurry_duration1~104/4If image too blurry value exceeds the "threshold" for more than "duration" second(s), then image too blurry detection is triggered.

7.18 DDNS

Group: ddns (capability_protocol_ddns > 0)

NAME VALUE SECURITY(get/set)DESCRIPTION
enable6/6Enable or disable the dynamic DNS.
provider DyndnsDynamic, DyndnsCustom, Safe1006/6 DyndnsDynamic => dyndns.org (dynamic) DyndnsCustom => dyndns.org Safe100 => safe100.net
Anti- hostingnamestring[128]6/6Your DDNS hostname.
Anti- usernamestring[64]6/6Your user name or email to login to the DDNS service provider
Anti- passwordstring[64]7/6Your password or key to login to the DDNS service provider.

Group: expresslink

PARAMETERVALUESECURITY (get/set)DESCRIPTION
enable6/6Enable or disable express link.
stateonlycheck, onlyoffline, checkonline, badnetwork6/6Camera will check the status of network environment and express link URL
urlstring[64]6/6The url user define to link to camera

7.20 UPnP Presentation

Group: upnppresentation

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

7.21 UPnP Port Forwarding

Group: upnpportforwarding

NAMEVALUESECURITY (get/set)DESCRIPTION
enable6/6Enable or disable the UPnP port forwarding service.
upnpnatstatus0~36/7The status of UPnP port forwarding, used internally.0 = OK, 1 = FAIL, 2 = no IGD router, 3 = no need for port forwarding

7.22 System Log

Group: syslog

NAMEVALUESECURITY (get/set)DESCRIPTION
enableremotelog6/6Enable remote log.
serverip6/6Log server IP address.
serverport514, 1025~655356/6Server port used for log.
level0~76/6Levels 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
setparamlevel0~26/6Show 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.23 SNMP

Group: snmp (capability_protocol_snmp > 0)

NAME VALUE SECURITY(get/set)DESCRIPTION
v26/6SNMP v2 enabled. 0 for disable, 1 for enable
v36/6SNMP v3 enabled. 0 for disable, 1 for enable
secnamerwstring[31]6/6Read/write security name
secnamerostring[31]6/6Read only security name
authpwrwstring[8~128]7/6Read/write authentication password
authpwrostring[8~128]7/6Read only authentication password
authtyperwMD5,SHA6/6Read/write authentication type
authtyperoMD5,SHA6/6Read only authentication type
encryptpwrwstring[8~128]7/6Read/write passwd
encryptpwrostring[8~128]7/6Read only password
encrypttyperwDES6/6Read/write encryption type
encrypttyperoDES6/6Read only encryption type
rwcommunitystring[31]6/6Read/write community
rocommunitystring[31]6/6Read only community
syslocationstring[128]6/6System location
syscontactstring[128]6/6System contact

7.24 Layout Configuration

Group: layout

NAMEVALUESECURITY (get/set)DESCRIPTION
logo_default1/60 => Custom logo1 => Default logo
logo_linkstring[128]http://www.vivotek.com1/6Hyperlink of the logo
logo_powerbyvvtk_hiddenRenewable >1/60 => display the power by vivotek logo1 => hide the power by vivotek logo
custombutton_manualtrigger_showRenewable >1/6Show or hide manual trigger (VI) button in homepage0 -> Hidden1 -> Visible
theme_option1~41/61~3: One of the default themes.4: Custom definition.
theme_color_fontstring[7]1/6Font color
theme_color_configfontstring[7]1/6Font color of configuration area.
theme_color_titlefontstring[7]1/6Font color of video title.
theme_color_controlbackgroundstring[7]1/6Background color of control area.
theme_color_configbackgroundstring[7]1/6Background color of configuration area.
theme_color_videobackgroundstring[7]1/6Background color of video area.
theme_color_casestring[7]1/6Frame color
defaultpassword_specialcharacter!%-.@^_^~6/7Allowed special characters* We support this parameter when the version number (httpversion) is equal or greater than 0314b.
defaultpassword_typePositive integer>6/7Required character type for password.An 32-bit integer, each bit can be set separately as follows:Bit 0 => Require English alphabet letter (uppercase or lowercase)Bit 1 => Require special characterBit 2 => Require digit numberBit 3 => Require lowercase letterBit 4 => Require uppercase letterBit 5 => Allow checking username and password; if "bit=1" means
NAME VALUE SECURITY(get/set)DESCRIPTION
username=password is allowed, otherwise is not allowed.* We support this parameter when the version number (httpversion) is equal or greater than 0314b.
defaultpassword_length8 ~ 646/7Allowed password length.* We support this parameter when the version number (httpversion) is equal or greater than 0314b.

7.25 Privacy Mask

Group: privacymask_c<0\~(n-1)> for n channel products and m privacy mask window.

n denotes the value of "capability_nvideoin" and m denotes the value of

"capability_videooin_c<0\~(n-1)>_nprivacymask"

NAME VALUE SECURITY(get/set)DESCRIPTION
enable4/4Enable privacy mask.
win_i<0~(m-1)>_enable4/4Enable privacy mask window.
win_i<0~(m-1)>_namestring[14]4/4Name of the privacy mask window.
win_i<0~(m-1)>_left0 ~ 3204/4Left coordinate of window position.* Only available when"capability_image_c<0~(n-1)>_privacymask_wintype" = rectangle.* If the image is rotated by 90 or 270 degrees, the range of left coordinate is 0~240.
win_i<0~(m-1)>_top0 ~ 2404/4Top coordinate of window position.* Only available when"capability_image_c<0~(n-1)>_privacymask_wintype" = rectangle.* If the image is rotated by 90 or 270 degrees, the range of top coordinate is 0~320.
win_i<0~(m-1)>_width0 ~ 3204/4Width of privacy mask window.* Only available when"capability_image_c<0~(n-1)>_privacymask_wintype" = rectangle.* If the image is rotated by 90 or 270 degrees, the range of width is 0~240.
win_i<0~(m-1)>_height0 ~ 2404/4Height of privacy mask window.* Only available when"capability_image_c<0~(n-1)>_privacymask_wintype" = rectangle.* If the image is rotated by 90 or 270 degrees, the range of height is 0~320.
win_i<0~(m-1)>_polygon0 ~ 320,0 ~ 240,0 ~ 320,0 ~ 240,0 ~ 320,0 ~ 240,0 ~ 320,0 ~ 2404/4Coordinate of polygon windowposition.(4 points: x0,y0,x1,y1,x2,y2,x3,y3)* Only available when"capability_image_c<n>_privacymask_wintype" = polygon.* Only available when qvga is listed in"capability_image_c<0~(n-1)>_privacymask_windomain".
win_i<0~(m-1)>_polygonpx0 ~ W,0 ~ H,0 ~ W,0 ~ H,0 ~ W,0 ~ H,0 ~ W,0 ~ HW: 0~ The current imagewidth -1H: 0~ The current image height -14/4 Coordinate of polygon window position.(4 points: x0,y0,x1,y1,x2,y2,x3,y3)* Only available when"capability_image_c<0~(n-1)>_privacymask_wintype" = polygon.* Only available when px is listed in"capability_image_c<0~(n-1)>_privacymask_windomain".
win_i<0~(m-1)>_polygonstd0 ~ 9999,0 ~9999, 0 ~ 9999,0 ~ 9999,0 ~ 9999,0 ~ 9999,0 ~ 99994/4Coordinate of polygon window position.(4 points: x0,y0,x1,y1,x2,y2,x3,y3)* Only available when"capability_image_c<0~(n-1)>_privacymask_wintype" = polygon.* Only available when std is listed in"capability_image_c<0~(n-1)>_privacymask_windomain".

7.26 3D Privacy Mask

Group: privacymask3d_c<0\~(n-1)> for n channel products and m privacy mask window.

(capability_image_c<0\~(n-1)>_privacymask_wintype = 3Drectangle)

n denotes the value of "capability_nvideoin" and m denotes the value of

"capability_videooin_c<0\~(n-1)>_nprivacymask"

NAME VALUE SECURITY(get/set)DESCRIPTION
enable4/4Enable the 3D privacy mask
color 0~"capability_image_c<0~(n-1)>_privacymask_ncolor"-14/4 Privacy mask color
win_i<0~(m-1)>_namestring[40]4/4Name of the privacy mask window.
win_i<0~(m-1)>_pan"capability_ptz_c<0~(n-1)>_minpan" ~ "capability_ptz_c<0~(n-1)>_maxpan"4/4 Pan position of window position.* Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1"
win_i<0~(m-1)>_tilt"capability_ptz_c<0~(n-1)>_mintilt" ~ "capability_ptz_c<0~(n-1)>_maxtilt"4/4 Tilt position of window position.* Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1"
win_i<0~(m-1)>_zoom"capability_ptz_c<0~(n-1)>_minzoom" ~ "capability_ptz_c<0~(n-1)>_maxzoom"4/4 Zoom position of window position.
win_i<0~(m-1)>_fliped4/4Flip side of window position.0: Non-flip side1: Flip side

7.27 Capability

Group: capability

NAME VALUE SECURITY(get/set)DESCRIPTION
api_httpversion0/7The version of VIVOTEK WebAPI with 4 integers plus 1 alphabet, There are composed by "major version", "minor version", "revision", "_platform". ex: 0301a_1Major versionIncrease the major version when change, remove the old features/interfaces or the firmware has substantially change in architecture and not able to roll back to previous version. This may cause incompatibility with supporting software.Minor versionIncrease the minor version when add new features/interfaces without change the old features and interfaces.RevisionIncrease the revision when fix bugs without change any features of the output.platformThis is a constant, it is used to distinguish between different platformsAPI version format:MMmmr_kWhere "MM" is the major version, "mm" is the minor version and "r" is the revision.
NAME VALUE SECURITY(get/set)DESCRIPTION
'M' and 'm' and 'k' are decimal digit from 0 to 9, while 'r' is an alphabetic. EX: 0302b_1 => Major version = 03, minor version = 02, revision = b, platform = 1The 4 integer numbers are WebAPI version, we use short name: [httpversion] for it in this document. The 5th character is model-based version for API bug-fix and it's default to "a".Ex: If some APIs in a model does not follow the API definition of 0301a_1, we will fix them and change this API value to 0301b_1.
api_logoversionThis number start with 1.00/7 Indicate the version of Vivotek log format.* We support this parameter when the version number (httpversion) is equal or greater than 0317c.
bootuptime0/7 Server bootup time.
nir0,0/7 Number of IR interfaces.(Recommend to use capability_daynight_c<0~"capability_nvideoin"-1>_builtinir for built-in IR and capability_daynight_c<0~"capability_nvideoin"-1>_externalir for external IR)* Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.0/7 Number of IR interfaces.(Recommend to use capability_daynight_c<0~"capability_nvideoin"-1>_builtinir for built-in IR and capability_daynight_c<0~"capability_nvideoin"-1>_externalir for external IR)* Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.
npir 0,0/7 Number of PIRs.
NAME VALUE SECURITY(get/set)DESCRIPTION
ndi0,0/7Number of digital inputs.
nvi 0,0/7 Number of virtual inputs (manual trigger)
ndo0,0/7Number of digital outputs.
naudioin 0,0/7 The number of audio input channel. 0 means no audio input support.
naudioout0,0/7The number of audio output channel
nvideoin0/7Number of video inputs.
nvideoout0,0/7Number of video out interface.
nvideoinprofile0/7Number of video input profiles.
nmediastream0/7Number of media stream per channels.
naudiosetting0/7Number of audio settings per channel.* Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.* We replace "naudiosetting" with "naudioin". More details, please refer the parameter description of "volume_internal" and "volume_external".
nuart0,0/7Number of UART interfaces.
nmotion0/7The number of motion window.
nmotionprofile0,0/7Number of motion profiles.
nevent0,0/7Number of event.* We support this parameter when the version number (httpversion) is equal or greater than 0311c.
nrecording0,0/7Number of recording.
NAME VALUE SECURITY(get/set)DESCRIPTION
* We support this parameter when the version number (httpversion) is equal or greater than 0309a.
ptzenabled0,0/7 An 32-bit integer, each bit can be set separately as follows:Bit 0 => Support camera control function;0(not support), 1(support)Bit 1 => (only available when bit0 is 1)Built-in or external video source;0(external), 1(built-in)Bit 2 => (only available when bit0 is 1)Support pan operation;0(not support), 1(support)Bit 3 => (only available when bit0 is 1)Support tilt operation;0(not support), 1(support)Bit 4 => (only available when bit0 is 1)Support zoom operation;0(not support), 1(support)(only available when RS-485 interface is supported or SD/PZ/PT/PD/video server series)Bit 5 => (only available when bit0 is 1)Support focus operation;0(not support), 1(support)(only available when RS-485 interface is supported or SD/PZ/PT/PD/video server series)Bit 6 => (only available when bit0 is 1)Reserved bit; always 0.Bit 7 => (only available when bit0 is 1)External or built-in PT;0(built-in), 1(external)
windowless0/7 Indicate whether to support windowless plug-in.
NAME VALUE SECURITY(get/set)DESCRIPTION
evctrlchannel0/7Indicate whether to support HTTP tunnel for event/control transfer.
joystick0/7Indicate whether to support joystick control.
remotefocus<Not recommended to use this>0,0/7An 4-bit integer, which indicates the supportive application of remotefocus.If the value of this parameter is larger than 0, it means that the camera supports remotefocus function.bit 0 => Indicate whether to support both zoom and focus function.bit 1 => Only support zoom function.bit 2 => Only support focus function.bit 3 => Currently, this is a reserved bit, and the default value is 0.* It's strongly non-recommended to use this.* This is reserved for compatibility and will not be used after the version number (httpversion) is equal or greater than 0400a.* We replace "capability_remotefocus" with "capability_image_c0_remotefocus".
npreset0,0/7Number of preset locations
presettourdirection0/7Indicate whether to support preset tour direction function. It means users can choose which direction the preset tour goes.* We support this parameter when the version number (httpversion) is equal or greater than 0307a.
eptz0,0/7For "nvideoin" = 1, the definition is as following:
NAME VALUE SECURITY(get/set)DESCRIPTION
A 32-bits integer, each bit can be set separately as follows:Bit 0 => 1st stream supports ePTZ or not.Bit 1 => 2nd stream supports ePTZ or not, and so on.For nvideoin >= 2, the definition is different:First all 32 bits are divided into groups for channel.Ex:nvideoin = 2, bit 0~15 are the 1st group for 1st channel, bit 16~31 are the 2nd group for 2nd channel.nvideoin = 3, bit 0~9 are the 1st group for 1st channel, bit 10~19 are the 2nd group for 2nd channel, bit 20~31 are the 3rd group for 3rd channel.Then, the 1st bit of the group indicates 1st stream of a channel support ePTZ or not. The 2nd bit of the group indicates 2nd stream of a channel support ePTZ or not, and so on.* For most products, the last stream of a channel will not support ePTZ. It is reserved for full view of the channel. For some dual-stream products, both streams support ePTZ.
nanystream0,0/7 number of any media stream per channel
iva0/7 Indicate whether to support Intelligent Video analysis
whitelight<Notrecommended to0/7 Indicate whether to support white light led.* We replace this parameter with
NAME VALUE SECURITY(get/set)DESCRIPTION
use this>"capability_daynight_c<0~(n-1)>_built inwled" when the version number (httpversion) is equal or greater than 0309d.
iris0/7Indicate whether to support iris control.
supportsd0/7Indicate whether to support local storage.
fisheye0/7The parameter is used to determine whether the product is fisheye or not.
tampering0/7Indicate whether to support tampering detection.
tamperingmode tamper,toodark,toobright,tooblurry0/7Available tampering mode list.* Only available when "capability_tampering" is 1.
adaptiverecording0/7Indicate whether to support adaptive recording.
adaptivestreaming0/7Indicate whether to support adaptive streaming.
supporttriggertypesNAME VALUE SECURITYseq,boot,motion,networkfail,recnotify,tampering,vi,vadp,di,volalarm,temperature,pir,visignal,backup,smartsd,shockalarm,virestore,presetreached,casingopenproduct dependent>0/7(get/set)list all the trigger types which are supported in the camera:"seq" = Periodic condition"boot" = System boot"motion" = Video motion detection"networkfail" = network connection failure"recnotify" = Recording notification."tampering" = Tamper detection."vi" = Virtual input (Manual trigger)"vadp" = VADP trigger."di" = Digital input."volalarm" = Audio detection."temperature" = Temperature detection."pir" = PIR detection."visignal" = Video input signal loss.DESCRIPTION
"backup" = Backing up recorded files."smartsd" = Lifetime detection of SD card."shockalarm" = Shock detection."virestore" = Video input signal restore."presetreached" = When any preset is reached"casingopen" = Casing open detection.* Only available when [httpversion] >= 0301a
media_num0,0/7Number of media number.* We support this parameter when the version number (httpversion) is equal or greater than 0311c.
storage_dbenabled0/7Media files are indexed in database.
protocol_https0/7Indicate whether to support HTTP over SSL.
protocol_rtsp0/7Indicate whether to support RTSP.
protocol_sip0/7Indicate whether to support SIP.
protocol_ibis0/7Indicate whether to support integrated on-board information system (IBIS).* We support this parameter when the version number (httpversion) is equal or greater than 0317a.
protocol_maxconnection0/7The maximum number of allowed simultaneous connections.
protocol_maxgenc connection0/7The maximum general streaming connections .* We replaced this parameter with "capability_protocol_maxconnection" when the version number (httpversion) is equal or greater than 0311c.
NAME VALUE SECURITY(get/set)DESCRIPTION
protocol_rtp_multicast_scalable0/7Indicate whether to support scalable multicast.
protocol_rtp_multicast_backchannel0/7Indicate whether to support backchannel multicast.
protocol_rtp_tcp0/7Indicate whether to support RTP over TCP.
protocol_rtp_http0/7Indicate whether to support RTP over HTTP.
protocol_spush_mjpeg0/7Indicate whether to support server push MJPEG.
protocol_snmp0/7Indicate whether to support SNMP.
protocol_ipv60/7Indicate whether to support IPv6.
protocol_pppoe0/7Indicate whether to support PPPoE.
protocol_ieee8021x0/7Indicate whether to support IEEE802.1x.
protocol_qos_cos0/7Indicate whether to support CoS.
protocol_qos_dscp0/7Indicate whether to support QoS/DSCP.
protocol_ddns0/7Indicate whether to support DDNS.
protocol_ftp_server0/7An 32-bit integer, each bit can be set separately as follows:Bit 0 => ftp;Bit 1=> sftp;* We support this parameter when the version number (httpversion) is equal or greater than 0314a.
protocol_ftp_client0/7An 32-bit integer, each bit can be set separately as follows:Bit 0 => ftp;Bit 1=> sftp;* We support this parameter when the version number (httpversion) is equal or greater than 0314a.
videoin_type0, 1, 20/70 => Interlaced CCD
NAME VALUE SECURITY(get/set)DESCRIPTION
1 => Progressive CCD2 => CMOS
videoin_nresolution0/7This equals"capability_videoin_c0_nresolution"* This is kept for compatibility.
videoin_resolutionA list of0/7This equals"capability_videoin_c0_resolution"* This is kept for compatibility.
videoin_maxframerateA list of0/7This equals"capability_videoin_c0_maxframerate"* This is kept for compatibility.
videoin_mjpeg_maxframerateA list ofand "-"0/7This equals"capability_videoin_c0_mjpeg_maxframerate"* This is kept for compatibility.
videoin_h264_maxframerateA list ofand "-"0/7 This equals"capability_videoin_c0_h264_maxframerate"* This is kept for compatibility.
videoin_codecmjpeg, h264, h2650/7Available codec of a device, split by comma.The sequence is not limited.EX:FD8183 supports H.264 and MJPEG, then this is "mjpeg,h264".IP9171 supports H.264, MJPEG and H.265, then this is "mjpeg,h264,h265"
videoin_streamcodecA list ofInteger>0/7 This equals"capability_videoin_c0_streamcodec"* This is kept for compatibility.
videoin_flexiblebitrate0/7Indicate whether to support flexible bit rate control.
videoout_codecA list of the available codec types separated0/7 Available codec list."-": not supported
by commas
timeshift0/7Indicate whether to support time shift caching stream.
audio_aec0/7Indicate whether to support acoustic echo cancellation.
audio_aecmode auto, manual0/7 Indicate the acoustic echo cancellation control mode."auto": control by camera automatically."manual": Manually turn on/off the control mode.*Only available when "capability_audio_aec" is "1"* We support this parameter when the version number (httpversion) is equal or greater than 0306b.
audio_aecaffect-, maxframerate:fixed:15product dependent>0/7When acoustic echo cancellation function is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here.The format is "Affect API name":"Policy":"Description" Policy" can be categorized into following groups:- (disabled) : UI turns grey and users can't select it.- (unchanged) : UI keeps the status as before and user can't change it.- (hidden) : UI is hidden.- (fixed) : UI is fixed to one selection or value.- (ranged) : UI is fixed to multiple selections or values.- (enabled) : UI is checked.
NAME VALUE SECURITY(get/set)DESCRIPTION
- (notsupport) : the affected function is not available."Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL.For example:"maxframerate: fixed:15" which means the max frame rate is 15fps when acoustic echo cancellation function is enabled."-" means no feature is affected.* Only available when "capability_audio_aec" is "1".* We support this parameter when the version number (httpversion) is equal or greater than 0306b.
audio_mic0/7 Indicate whether to support built-in microphone input.* Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.* We replace "audio_mic" with "audio_intmic".
audio_intmic<0~Positive Integer>0/7 Internal (Built-in) Microphone.0: Not support1: SupportBit 0 for CH0, bit 1 for CH1, and so on.
audio_extmic<0~Positive Integer>0/7 External Microphone.
NAME VALUE SECURITY(get/set)DESCRIPTION
0: Not support1: SupportBit 0 for CH0, bit 1 for CH1, and so on.
audio_alarm<0~Positive Integer>0/70: Not support audio alarm.1: Support audio alarm.Bit 0 for CH0, bit 1 for CH1, and so on.
audio_linein0/7Indicate whether to support external line input.* Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.* It will be replaced by audio_intmic and audio_extmic.
audio_lineout0/7Indicate whether to support line output.
audio_michardwareswitch0/7Indicate whether the hardware supports built-in/external mic switch
audio_headphoneout0/7Indicate whether to support headphone output.* Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301a.
audio_audioclip0/7Indicate whether to support audio clip function.* We support this parameter when the version number (httpversion) is equal or greater than 0309a.
audioin_codec aac4,gamr, g711,g726, -0/7Available audio codec. We take comma to split codec without any space."aac4": Advanced Audio Coding (AAC)"gamr": Adaptive Multi-Rate (AMR)"g711": G.711
NAME VALUE SECURITY(get/set)DESCRIPTION
"g726": G.726"-": Not supported.
audioout_codecg711, -0/7Available codec list for SIP."-": Not supported.
motion_wintyperectangle, polygon,-0/7The supported motion window type."polygon": The window is a 2D polygon shape."rectangle": The window is a 2D rectangle shape."-": Not supported.
motion_windomainqvga, px, std, -0/7The domain to set an motion window."qvga": a 320x240 range to represent the whole image."px": Locate a window in the image with pixels."std": A normalized 0~9999 range."-": Not supported.
smartstream_support0/7Indicate whether smart stream is supported.
smartstream_version0/7Number of smart stream version.* Only available when"capability_smartstream_support" is 1
smartstream_nstream0/7Number of stream that support smart stream.* Only available when"capability_smartstream_support" is 1
smartstream_windomainqvga, px, std, -0/7The domain to set an focus window."qvga": a 320x240 range to represent the whole image."px": Locate a window in the image with pixels."std": A normalized 0~9999 range."-": Not supported.* Only available when"capability_smartstream_support" is 1
smartstream_mod0/7Indicate whether autotracking smart
NAME VALUE SECURITY(get/set)DESCRIPTION
e_autotrackingstream is supported.* Only available when"capability_smartstream_support" is 1
smartstream_mode_manual0/7Indicate whether manual smart stream is supported.* Only available when"capability_smartstream_support" is 1
smartstream_mode_hybrid0/7Indicate whether hybrid(autotracking+manual) smart stream is supported.* Only available when"capability_smartstream_support" is 1
smartstream_nwindow_autotracking0/7Maximum number of tracking window of autotracking.* Only available when"capability_smartstream_support" is 1
smartstream_nwindow_manual0/7Maximum number of tracking window of manual.* Only available when"capability_smartstream_support" is 1
smartstream_nwindow_hybrid_autotracking0/7Maximum number of tracking window of autotracking in hybrid mode.* Only available when"capability_smartstream_support" is 1
smartstream_nwindow_hybrid_manual0/7Maximum number of tracking window of manual in hybrid mode.* Only available when"capability_smartstream_support" is 1
vadp_supportfeature0/7An 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 => Capture audio raw dataBit 4 => Support event triggerBit 5 => Support license registrationBit 6 => Support shared memory APIBit 7 => Support digital signature of packageBit 8 => Support snapshotBit 9 => Support upload encrypted package
vadp_npackage0/7Indicate the maximum number of VADP package that can be uploaded to the device.
camctrl_httptunnel0/7Indicate whether to support httptunnel.* Not support this parameter anymore when the version number (httpversion) is equal or greater than 0301b.* It will be replaced by capability_camctrl_ptztunnel.
camctrl_ptztunnel0/7Indicate whether to support ptztunnel.* We support this parameter when the version number (httpversion) is equal or greater than 0301b.This equals "capability_camctrl_c0_ptztunnel"* This is kept for compatibility.* Only available when capability_ptzenabled >0
camctrl_privilege0/7Indicate 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.cgiThis is equivalent to"capability_camctrl_c0_privilege".
NAME VALUE SECURITY(get/set)DESCRIPTION
* This is kept for compatibility.* Only available whencapability_ptzenabled >0
uart_httptunnel0/7Indicate whether to support HTTP tunnel for UART transfer.
transmission_modeTx,Rx,Both0/7Indicate transmission mode of the machine: TX = server, Rx = receiver box, Both = DVR.
network_wire0/7Indicate whether to support Ethernet.
network_wireless0/7Indicate whether to support wireless.
network_dualmode0/7Indicate whether network dual mode is supported.* Only available when"capability_network_wireless" is "1"* We support this parameter when the version number (httpversion) is equal or greater than 0305a.
wireless_s802dot11b0/7Indicate whether to support wireless 802.11b+.
wireless_s802dot11g0/7Indicate whether to support wireless 802.11g.
wireless_s802dot11n0/7Indicate whether to support wireless 802.11n.
wireless_beginchannel1 ~ 140/7Indicate the begin channel of wireless network
wireless_endchannel1 ~ 140/7Indicate the end channel of wireless network
wireless_encrypt_wep0/7Indicate whether to support wireless WEP.
wireless_encrypt_wpa0/7Indicate whether to support wireless WPA.
wireless_encrypt_wpa20/7Indicate whether to support wireless WPA2.
wireless_apmode_enable0/7Indicate whether wireless AP mode is supported.
NAME VALUE SECURITY(get/set)DESCRIPTION
* Only available when "capability_network_wireless" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0305a.
wireless_apmode_ssidprefix0/7Indicate the prefix of broadcasted SSID when camera is in wireless AP mode. * Only available when "capability_wireless_apmode_enable" is "1". * We support this parameter when the version number (httpversion) is equal or greater than 0305a.
derivative_brand0/7Indicate 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)
test_ac0/7Indicate whether to support test ac key.
version_onvifdaemon0/7Indicate ONVIF daemon version
version_onviftesttool0/7Indicate ONVIF test tool version
version_genetec0/7Indicate Genetec daemon version * We support this parameter when the version number (httpversion) is equal or greater than 0312a.
media_totalspace0/7Available memory space (KB) for media.
media_snapshot_maxpreevent0/7Maximum snapshot number before event occurred.
media_snapshot_maxpostevent0/7Maximum snapshot number afterevent occurred.
media_snapshot_maxsize0/7Maximum size (KB) of a snapshot.
media_videoclip_maxsize0/7Maximum size (KB) of a videoclip.
media_videoclip_maxlength0/7Maximum length (second) of a videoclip.
media_videoclip_maxpreevent0/7Maximum duration (second) after event occurred in a videoclip.
media_streamprofiles_support0/7Indicates support of stream profile feature.* We support this parameter when the version number (httpversion) is equal or greater than 0313a.
media_streamprofiles_num0/7Maximum number of stream profiles.* We support this parameter when the version number (httpversion) is equal or greater than 0313a.
image_iristype<Notrecommended to use this><string> 0/7 Indicate iris type.● "piris": P-Iris● "dciris": DC-Iris● "-": No Iris control support* When "capability_iris" = 0, this value must be "-".* Note: For some box-type cameras, this value may be varied depending on mounted lens.* We replace "capability_image_iristype" with "capability_image_c0_iristype".* Reserved for compatibility, and suggest don't use this since [httpversion] > 0301a
image_focusassist<Notrecommended touse this>0/7Indicate whether to support focus assist.* We replace "capability_image_focusassist "with"capability_image_c0_focusassist".* Reserved for compatibility, and suggest don't use this since[httpversion] > 0301a
localstorage_manageable0/7Indicate whether manageable local storage is supported.* Only available when"capability_supportsd" is 1 or"capability_storage_dbenabled" is 1.
localstorage_seamless0,0/7Indicate whether seamless recording is supported.One bit represents one channel.Ex: "3" means channel 0 and channel1 support seamless recording .* Only available when"capability_supportsd" is 1 or"capability_storage_dbenabled" is 1.
localstorage_modnum<Not recommended to use this>0,0/7 The maxmaximum MOD connection numbers.* Only available when"capability_supportsd" is 1 or"capability_storage_dbenabled" is 1.* We replace this parameter with"capability_storage_management_modnum" when the version number (httpversion) is equal or greater than 0312a.
localstorage_modversion0/7Indicate MOD daemon version.* Only available when"capability_supportsd" is 1 or"capability_storage_dbenabled" is 1.
localstorage_storm grversion0/7 Indicate storage manager daemon version.* Only available when"capability_supportsd" is 1 or0/7Indicate daemon version.* Only available when"capability_supportsd" is 1 or"capability_storage_dbenabled" is 1."capability_storage_dbenabled" is 1.
localstorage_supportedge0,0/7An 32-bit integer, which indicates the supportive application of edge storage.If the value of this parameter is larger than 0, it means that the camera supports edge recording function.bit 0 : It supports to record directly to an on-board SD-Card.bit 1~: Currently, they are reserved bit, and the default value is 0.* Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1.
localstorage_slconnum0,0/7The maximum seamless connection number for each channel.* Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1.
localstorage_smartsd0/7The "Lifetime and Log SD Card" feature allows users to obtain the card's remaining lifetime information.0: Non-support this feature1: Support this feature* Only Sony, Micron SD card can support this function now.* Only available when "capability_supportsd" is 1 or "capability_storage_dbenabled" is 1.
remotecamctrl_master0,0/7Indicate whether to support remote auxiliary camera (master side), this value means supporting max number of auxiliary camera.
remotecamctrl_slave0/7Indicate whether to support remote camera control (slave side).
NAME VALUE SECURITY0,0/7Indicate the supported streams of local dewarp. One bit represents one supported stream. The LSB indicates stream 0.Ex: “3” means stream 0 and stream 1 support local dewarp.* Only available when "capability_fisheye" >0
fisheyelocaldewarp_c<0~(capability_nvideoin)-1><productdependent>
shockalarm_support0/7Indicate whether to support the shock detection.* We support this parameter when the version number (httpversion) is equal or greater than 0306e.
layout_redirection0/7Indicate which function will be redirected to the vadp package path."-": Not supported.* We support this parameter when the version number (httpversion) is equal or greater than 0309a.
securecam_support0/7Indicate support for security camera.* We support this parameter when the version number (httpversion) is equal or greater than 0314a.
securecam_version0/7Indicate the security camera feature phases.* Only available when capability_securecam_support=1.* We support this parameter when the version number (httpversion) is equal or greater than 0314a.
taics_support0/7Support the feature for Video Surveillance System Security from TAICS.* We support this parameter when the version number (httpversion) is equal or greater than 0314b.
NAME VALUE SECURITY(get/set)DESCRIPTION
taics_level0,0/7Indicate the support level for Video Surveillance System Security from TAICS.* Only available when "capability_taics_support" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0314b.
cameralink_support0/7Indicate support for the feature of camera link.* We support this parameter when the version number (httpversion) is equal or greater than 0315a.
cameralink_num0,0/7Indicate the maximum number of receiver camera link.* Only available when "capability_cameralink_support" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0315a.
cameralink_version0/7Indicate the version of camera link feature.* Only available when "capability_cameralink_support" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0315a.

7.27.1 Capability for Camctrl

Group: capability_camctrl_c<0\~(n-1)> n denotes the value of "capability_nvideoin"

(capability_ptzenabled > 0)

* We support this group when the version number (httpversion) is equal or greater than 0303b.

PARAMETERVALUESECURITY (get/set)DESCRIPTION
ptztunnel0/7Indicate whether to support ptztunnel in this video input.
privilege0/7Indicate whether to support “Manage Privilege” of PTZ control in the security page in this video input.1: support both/cgi-bin/camctrl/camctrl.cgi and/cgi-bin/viewer/camctrl.cgi0: support only/cgi-bin/viewer/camctrl.cgi
rs4850/7An 32-bit integer, each bit can be set separately as follows:Bit 0 => support rs485-inBit 1 => support rs485-out
buildinpt0/7An 32-bit integer, each bit can be set separately as follows:Bit 0 => support build-in panBit 1 => support build-in tilt
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
zoommodule0/7Indicate whether to support zoom lens. In our product, only SD series and IZ series use the zoom lens.* Both varifocal and zoom lenses are built with movable elements that permit changing the effective focal length. And the key difference between a varifocal and a zoom lens can be explained by thinking about a lens that has been focused on an object at any focal length. A varifocal will need to be refocused whenever the focal length is adjusted; the zoom will stay in focus when the focal length is adjusted.
focusmode auto,onetimeeauto,spotlight,manualdependent>0/7 Focus mode selection:"auto": Camera will automatically adjust the focus position full time to adapt a clear picture."onetimeauto": Camera will automatically adjust the focus position one time, which follows any PTZ control."spotlight": Camera will automatically adjust the focus position full time, and to consider a spotlight avoidance situation."manual": Turn off the automatically focus function. For user to control the focus position manually as their purpose.* Only available when"capability_camctrl_c<0~(n-1)_zoommodule" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0304a.
digitalzoom_support0/7Indicate the lens support digital zoom or not.* We support this parameter when the version number (httpversion) is equal or greater than 0317a.

7.27.2 Capability for PTZ

Group: capability_ptz_c<0\~(n-1)> n denotes the value of "capability_nvideoin"

(capability_ptzenabled > 0 and capability_camctrl_c<0\~(n-1)>_zoommodule !=0)

* We support this group when the version number (httpversion) is equal or greater than 0303b.

PARAMETERVALUESECURITY (get/set)DESCRIPTION
panspeedlv0,0/7The maximum speed level of pan motion.*Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1"
minpan0,0/7The lower limit for pan position.*Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1"
maxpan0,0/7The upper limit for pan position.*Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1"
minpanangle0/7The lower limit for pan angle.*Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1"
maxpanangle0/7The upper limit for pan angle.*Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1"
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
tiltspeedlv0,0/7The maximum speed level of tilt motion.*Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1"
mintilt0,0/7The lower limit for tilt position.*Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1"
maxtilt0,0/7The upper limit for tilt position.*Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1"
mintiltangle0/7The lower limit for tilt angle.*Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1"
maxtiltangle0/7The upper limit for tilt angle.*Only available when bit1 of "capability_camctrl_c<0~(n-1)>_buildin pt" is "1"
zoomspeedlv0,0/7The maximum speed level of zoom motion.*Only available when the value of "capability_camctrl_c<0~(n-1)>_zoom module" is "1"
minzoom0,0/7The lower limit for zoom position.*Only available when the value of "capability_camctrl_c<0~(n-1)>_zoom module" is "1"
maxzoom0,0/7The upper limit for zoom position.*Only available when the value of "capability_camctrl_c<0~(n-1)>_zoom module" is "1"
maxdzoom0,0/7The upper limit for digital zoom position.*Only available when the value of "capability_camctrl_c<0~(n-1)>_zoom module" is "1"
focusspeedlv0,0/7The maximum speed level of focus motion.*Only available when the value of "capability_camctrl_c<0~(n-1)>_zoom module" is "1"
minfocus0,0/7The lower limit for focus position.*Only available when the value of "capability_camctrl_c<0~(n-1)>_zoom module" is "1"
maxfocus0,0/7The upper limit for focus position.*Only available when the value of "capability_camctrl_c<0~(n-1)>_zoom module" is "1"

7.27.3 Capability for IR Led

Group: capability_daynight_c<0\~(n-1)> n denotes the value of "capability_nvideoin"

PARAMETERVALUESECURITY (get/set)DESCRIPTION
support0/7Indicate whether the camera supports day/night mode switch
builtinir0/7Indicate whether to support built-in IR led.* We replaced this parameter with “capability_daynight_illuminators_builtin_support” when the version number (httpversion) is equal or greater than 0312a.
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
builtinwled0/7Indicate whether to support built-in white led.* We replaced this parameter with "capability_daynight_illuminators_builtin_type=whiteled" when the version number (httpversion) is equal or greater than 0312a.
externalir0/7Indicate whether to support external IR led.* We replaced this parameter with "capability_daynight_illuminators_external_support" when the version number (httpversion) is equal or greater than 0312a.
optimizedir0/7Indicate whether to support optimized IR control technology.* We replaced this parameter with "capability_daynight_illuminators_optimizedir" when the version number (httpversion) is equal or greater than 0312a.
smartir0/7Indicate whether to support smart IR.
ircutfilter0/7Indicate whether to support IR cut.
lightsensor0/7Indicate whether to support light sensor.
blackwhitemodeircutsensitivity_type0/70/7Indicate whether to support automatically switch to Black & White display during the night mode.* We support this parameter when the version number (httpversion) is equal or greater than 0302a.Indicate the cgi interface of "ircutcontrol_sensitivity"."options": the value of "ircutcontrol_sensitivity" parameter is "low, normal,high"."normalize": the value of "ircutcontrol_sensitivity" parameter is "1~100"-":not support* Only available when "capability_daynight_c<0~(n-1)>_support" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
ircutsensitivity_supportlevel0,0/7 The value indicate the support strength level of ircutsensitivity.* Only available when "capability_daynight_c<0~(n-1)>_support" is 1 and "capability_daynight_c<0~(n-1)>_ircutsensitivity_type" is not "-".* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
extled_interfacedoproductdependent>0/7The device interface of external IR led:"do": digital output* Only available when "capability_daynight_c<0~(n-1)>_externalir" is 1* We replaced this parameter with "capability_daynight_illuminators_external_interface" when the version number (httpversion) is equal or greater than 0312a.
spectrum_support0/7Indicate whether to support proposed a brightness enhancement method based on CCM(Color Correction Matrix) model to improve the brightness effect of the images if the IR and blue light exists.* Only available when"capability_daynight_c<0~(n-1)>_support" is 1* We replaced this parameter with"capability_daynight_illuminators_spect rum_support" when the version number (httpversion) is equal or greater than 0312a.
spectrum_modevisible,ir,irenhanced, blueenhanced0/7 Indicatethe spectrum mode."visible": The ideal default setting for visible light."ir": The ideal default setting for IR light."irenhanced": This CCM model increases the brightness effect of IR light."blueenhanced": This CCM model increases the brightness effect of blue light.*Only available when"capability_daynight_c<0~(n-1)>_support" is 1 and"capability_daynight_c<0~(n-1)>_spect rum_support" is 1* We replaced this parameter with"capability_daynight_illuminators_spect rum_mode" when the version number (httpversion) is equal or greater than 0312a.
modeauto,daynight,di,di2,di3,di4,schedule,-<product dependent>0/7Indicate the day / night switch mode."auto": The Camera automatically judges the current operation mode by the level of ambient light detected."daynight": support day mode and night mode. In day mode, the camera streams color video. In night mode, the camera streams black and white video in low light environments."di": the camera automatically switches the current mode when a ditigal input 1 is triggered."di2": the camera automatically switches the current mode when a ditigal input 2 is triggered."di3": the camera automatically switches the current mode when a ditigal input 3 is triggered."di4": the camera automatically switches the current mode when a ditigal input 4 is triggered."schedule": The Camera switches between day mode and night mode based on a specified schedule."-": not support* We support this parameter when the version number (httpversion) is equal or greater than 0309d.

7.27.4 Capability for IR Illuminators

Group: capability_daynight_illuminators

PARAMETER VALUE SECURITY(get/set)DESCRIPTION
optimizedir0/7Indicate whether to support optimized IR control technology.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
builtin_support0/7Indicate whether to support built-in led.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
builtin_typeirled,whiteled,-<product dependent>0/7Indicate whether to support built-in led type."irled": IR led"whiteled": white led"-": not support* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
external_support0/7Indicate whether to support external led.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
external_interfacespectrum_supportdo,do2,do3,do4product dependent>* Available values are do,do<2~(capability_nd o)>0/70/7The device interface of external led:"do": digital output 1"do2": digital output 2"do3": digital output 3"do4": digital output 4* We support this parameter when the version number (httpversion) is equal or greater than 0312a.* Only available when"capability_daynight_illuminators_external_support" is 1Indicate whether to support proposed a brightness enhancement method based on CCM(Color Correction Matrix) model to improve the brightness effect of the images if the IR and blue light exists.* Only available when"capability_daynight_c<0~(n-1)>_support" is 1* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
spectrum_modevisible,ir,irenhanced, blueenhanced0/7Indicate the spectrum mode."visible": The ideal default setting for visible light."ir": The ideal default setting for IR light."irenhanced": This CCM model increases the brightness effect of IR light."blueenhanced": This CCM model increases the brightness effect of blue light.*Only available when"capability_daynight_c<0~(n-1)>_support" is 1 and"capability_daynight_illuminators_spectrum_m_support " is 1* We support this parameter when the version number (httpversion) is equal or greater than 0312a.

7.27.5 Capability for Storage Management

Group: capability_storage_management

PARAMETERVALUESECURITY (get/set)DESCRIPTION
ndevicedevice sd, nas0/70/7Indicate the number of storage devices.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.Indicate the supported storage devices.* Only available when"capability_storage_dbenabled" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.* Note: If "nas" storage is supported, the media storage path format is “\date\hour”. “\date\hour” format is “\YYYYMMDD\hh”.
modnum0,0/7The maximum MOD connection numbers.* Only available when"capability_storage_dbenabled" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.

7.27.6 Capability for Video Input

Group: capability_videoin_c<0\~(n-1)> n denotes the value of "capability_nvideoin"

PARAMETERVALUESECURITY (get/set)DESCRIPTION
lens_type fisheye, fixed,varifocal,changeable,motor, ics,-PARAMETER VALUE SECURITY0/7 The lenstype of this channel."fisheye": Fisheye lens"fixed": Build-in fixed-focus lens."varifocal": Build-in varifocal lens."changeable": changeable lens. Like box-type camera, users can install any C-Mount or CS-Mount lens as they wish."motor": Lens with motor to support zoom, focus, etc."ics": An i-CS lens is an intelligent CS-mount lens that contains information about, among other things, its own geometrical distortion and the exact position of its zoom, focus, and iris opening."-": N/A* Only available when [httpversion] >= 0301a(get/set)DESCRIPTION
color_support0/71: camera can select to display color or black/white video streams.0: camera do not support this feature.* We support this parameter when the version number (httpversion) is equal or greater than 0310a.
eptz_zoomratio0/7Indicate the support zoom ratio of eptz."-": not support ePTZ* We support this parameter when the version number (httpversion) is equal or greater than 0310a.
rotation0/7Indicate current mode whether support video rotation
rotationaffect-0/7When rotation is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here.The format is "Affect API name":"Policy":"Description""Policy" can be categorized into following groups:- (disabled) : UI turns grey and users can't select it.- (unchanged) : UI keeps the status as before and user can't change it.- (hidden) : UI is hidden.- (fixed) : UI is fixed to one selection or value.- (ranged) : UI is fixed to multiple selections or values.- (enabled) : UI is checked.- (notsupport) : the affected function is not available."Affect API name" can be described in hierarchy, such as"exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as"exposurelevel:fixed:6" which means exposurelevel is fixed to level 6."Description" can be a nonnegative integer or string or NULL."-" means no feature is affected.* When "rotation"=0, this value must be "-"* We support this parameter when the version number (httpversion) is equal or greater than 0304b.
rotationangle0/7The different angles which camera supports for rotation.* Only avaliable when "capability_videooin_c<0~(n-1)>_rotation" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0309b.
orientation flip,mirror,rotation0/7Indicates the camera supports flip, mirror or rotation.* We support this parameter when the version number (httpversion) is equal or greater than 0309b.
streamcodec0/7Represent 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.264Bit 3: Support H.265
mode 0,<positive integer>0/7 Indicatecurrent video mode.
nmode0/7Indicate how many video modes supported by this channel.
maxsize <WxH> 0/7The maximum resolution of all modes in this channel, the unit is pixel.
nprivacymask0,<positive integer>0/7Number of privacy mask per channel
nresolution0/7The maximum resolution options (listed in "resolution") in current video mode.
resolutionA list of0/7Resolution options in current video mode. These options are the possible options for "videoin_c<s resolution". The last one is the maximum resolution in current mode.
maxresolutionA list of0/7Represent supported maximum resolution of each stream in current video mode.* The element number is defined as "capability_nmediastream".
minresolutionA list of0/7Represent supported minimum resolution of each stream in current video mode.* The element number is defined as "capability_nmediastream"* We support this parameter when the version number (httpversion) is equal or greater than 0304b.
maxframerateA list of0/7Indicate frame rate that the video source outputs in current video mode.One to one mapping to the resolution in "resolution".* The element number is defined as "nresolution" in this group.* This parameter may be changed when "videoin_c<cmosfreq"=50 or "videoin_c<modulation"=pal.Ex: 30 fps is changed to 25 fps, 60 fps is changed to 50 fps, and so on.
PARAMETER VALUESECURITY(get/set)DESCRIPTION
mjpeg_maxframerateA list ofand "-"0/7Maximum fps that the device can encoded with MJPEG on resolutions in current video mode."-" means not support.* One to one mapping to the resolution in "resolution".* The element number is defined as "nresolution" in this group.* This parameter may be changed when "videoin_c<ncmosfreq"=50 or "videoin_c<ncmodulation"=pal.Ex: 30 fps is changed to 25 fps, 60 fps is changed to 50 fps, and so on.* Only available when 'mjpeg' is listed in "capability_videoin_codec".
mjpeg_maxbitratepositiveinteger>, -0/7 Maximum bitrates of MJPEG.The unit is bps."-" means MJPEG does not support bit rate control.* Only available when 'mjpeg' is listed in "capability_videoin_codec".
h264_maxframerateA list ofand "-"0/7Maximum fps that the device can encoded with H.264 on resolutions in current video mode."-" means not support.* One to one mapping to the resolution in "resolution".* The element number is defined as "nresolution" in this group.* This parameter may be changed when "videoin_c<ncmosfreq"=50 or "videoin_c<ncmodulation"=pal.Ex: 30 fps is changed to 25 fps, 60 fps is changed to 50 fps, and so on.* OnlyAvailable when 'h264' is listed in "capability_videoin_codec".
h264_maxbitrate0/7Maximum bitrates of H.264.The unit is bps.* Only available when 'h264' is listed in "capability_videoin_codec".
h264_profile baseline,main,high0/7 IndicateH264 profiles* Only available when 'h264' is listed in "capability_videoin_codec"* We support this parameter when the version number (httpversion) is equal or greater than 0309a.
h265_maxframerateA list ofand "-"0/7Maximum fps that the device can encoded with H.265 on resolutions in current video mode."-" means not support.* One to one mapping to the resolution in "resolution"* The element number is defined as "nresolution" in this group.* This parameter may be changed when "videoin_ccmosfreq"=50 or "videoin_cmodulation"=pal.Ex: 30 fps is changed to 25 fps, 60 fps is changed to 50 fps, and so on.* Only available when 'h265' is listed in "capability_videoin_codec".
h265_maxbitrate0/7Maximum bitrates of H.265.The unit is bps.* Only available when 'h265' is listed in "capability_videoin_codec".
h265_profilemain,main100/7Indicate H265 profiles* Only available when 'h265' is listed in "capability_videoin_codec"* We support this parameter when the version number (httpversion) is equal or greater than 0309a.
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
fisheye_mounttype<Not recommended to use this>ceiling, wall, floorproductdependent>0/7Indicate the supported type.wall mount: 180° panoramic viewceiling mount: 360° surround view withoutblind spotsfloor mount: 360° surround view withoutblind spots* Only available when "capability_fisheye">0* It's recommended to use"capability_videooin_c<0~(n-1)>_mounttype"
mounttype ceiling, wall, floor,-* Available values are listed in "capability_videooin_c<0~(n-1)>_mounttype"0/7 Indicatethe supported mount type."-": not support* We support this parameter when the version number (httpversion) is equal or greater than 0309c.
dintraperiod_support0/70: Non-support "Dynamic intra frame period"1: Support "Dynamic intra frame period""Dynamic intra frame period" can be used to reduce bitrate by reducing the number of I-frame.* We support this parameter when the version number (httpversion) is equal or greater than 0301c.
cameraunit_nameCU8131, CU8171, CU8161-H, CU8162-H, CU8163-H, CU8361-H, ..., -0/7A "camera unit" name of a split-type camera system, which the camera unit and the video core are separated. -: If the camera is not a split-type camera system, the value of this parameter is "-". * We support this parameter when the version number (httpversion) is equal or greater than 0302b.
cmosfreq_support0/70: The power line frequency(50/60Hz) is detected by camera automatically. 1: The power line frequency(50/60Hz) can be set by user. * We support this parameter when the version number (httpversion) is equal or greater than 0308a.
smartfps_support0/7Indicate whether to support Smart fps function. * We support this parameter when the version number (httpversion) is equal or greater than 0309a.
smartq_support0/7Indicate whether to support Smart Q function. * We support this parameter when the version number (httpversion) is equal or greater than 0309a.

7.27.7 Capability for Local Dewarp

Group: capability_videooin_c<0\~(n-1)>_localdewarp

(capability_fisheyelocaldewarp_c<0\~(capability_nvideoin)-1>>0)

n denotes the value of "capability_nvideoin"

PARAMETERVALUESECURITY (get/set)DESCRIPTION
typeceilingmount1O, 1P, 2P, 1R, 4R0/7Available dewarp types of ceiling and floor mount.
typewallmount1O, 1P, 1R, 4R0/7Available dewarp types of wall mount.
resolutionC1PA list of0/7Available resolutions of 1P mode of ceiling and floor mount.
resolutionC2PA list of0/7Available resolutions of 2P mode of ceiling and floor mount.
resolutionC1RA list of0/7Available resolutions of 1R mode of ceiling and floor mount.
resolutionC4RA list of0/7Available resolutions of 4R mode of ceiling and floor mount.
resolutionW1PA list of0/7Available resolutions of 1P mode of wall mount.
resolutionW1RA list of0/7Available resolutions of 1R mode of wall mount.
resolutionW4RA list of0/7Available resolutions of 4R mode of wall mount.
panorama_pancontrol0/7Indicate whether to support localdewarp panorama pan control.* We support this parameter when the version number (httpversion) is equal or greater than 0312b.

7.27.8 Capability for Video Mode

Group: capability_videoin_c<0\~(n-1)>_mode<0\~(m-1)> n denotes the value of

"capability_nvideoin", m denotes the value of "capability_videoin_c<0\~(n-1)>_nmode"

PARAMETERVALUESECURITY (get/set)DESCRIPTION
rotation0/7Indicate this mode whether support video rotation
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
is_modeeis, dis, -0/7Indicate this mode whether support image stabilizer mode."eis": electronic image stabilizer"dis": digital image stabilizer"-": not support* Only available when "capability_image_c<0~(n-1)>_eis" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0317a.
digitalzoom_support0/7Indicate this mode whether support digital zoom.* Only available when "capability camctrl_c<0~(n-1)>_zoommo dule" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0317a.
eptz0,0/7Indicate this mode whether support eptz. For "nvideoin" = 1, the definition is as following:A 32-bits integer, each bit can be set separately as follows:Bit 0 => 1st stream supports ePTZ or not. Bit 1 => 2nd stream supports ePTZ or not, and so on.For nvideoin >= 2, the definition is different:First all 32 bits are divided into groups for channel.Ex:nvideoin = 2, bit 0~15 are the 1st group for 1st channel, bit 16~31 are the 2nd group for 2nd channel.nvideoin = 3, bit 0~9 are the 1st group for 1st channel, bit 10~19 are the 2nd group for 2nd channel, bit 20~31 are the 3rd group for 3rd channel.Then, the 1st bit of the group indicates 1st stream of a channel support ePTZ or not. The 2nd bit of the group indicates 2nd stream of a channel support ePTZ or not, and so on.* We support this parameter when the version number (httpversion) is equal or greater than 0304b.
wdrpro 0, 1, 2 0/7Indicate this mode whether support WDR pro.0: Non-support WDR Pro1: Support WDR Pro2: Support WDR Pro II* We support this parameter when the version number (httpversion) is equal or greater than 0304b.
effectivepixel0/7The visible area of full scene in this video mode.The unit is pixel in source.* If"effectivepixel"<"capability_videooin_c<0~(n-1)>_maxsize", then the visible area is located at the center of full scene.
outputsize0/7The output size of source, equal to the captured size by device, in this video mode. The unit is pixel.This value is used as a basic coordinate system for many features, like ePTZ, privacy mask, motion, etc.* Source (most for image sensor) may perform scale or binning, etc on image data, and output data with smaller size.This parameter is designed to represent this.
binning0, 1, 30/7Indicate binning is used or not in this video mode.0: No binning1: 2x2 binning3: 3x3 binning* Binning is a technology to increase light sensitivity by combining multiple pixels to one. The drawback is reduced resolution. We design this parameter to disclose this information.
nresolution0/7How many resolution options in this video mode.
resolutionA list of0/7Resolution options in this video mode.The last one is the maximum resolution in this video mode.* The element number is defined as "nresolution" in this group.
maxresolutionA list of0/7Represent supported maximum resolution of each stream in current video mode.* The element number is defined as "capability_nmediastream".
minresolutionA list of0/7Represent supported minimum resolution of each stream in current video mode.* The element number is defined as "capability_nmediastream"* We support this parameter when the version number (httpversion) is equal or greater than 0304b.
maxframerateA list of0/7Indicates frame rate that the video source outputs in this video mode.* One to one mapping to the resolution in "resolution"* The element number is defined as "nresolution" in this group.* This parameter records the frame rate when "videoin_c<0~(n-1)>_cmosfreq"=60 or "videoin_c<0~(n-1)>_modulation"=ntsc
maxfps_mjpegA list ofand "-"0/7Maximum fps which the device can encoded with MJPEG on resolutions in this video mode."-" means not support.* One to one mapping to the resolution in "resolution".* The element number is defined as "nresolution" in this group.* This parameter records the frame rate when"videoin_c<0~(n-1)>_cmosfreq"=60 or"videoin_c<0~(n-1)>_modulation"=ntsc* Only available when 'mjpeg' is listed in "capability_videoin_codec".
maxfps_h264 A list ofand "-"0/7 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<0~(n-1)>_cmosfreq"=60 or"videoin_c<0~(n-1)>_modulation"=ntsc* Only available when 'h264' is listed in "capability_videoin_codec".
maxfps_h265A list ofand "-"0/7Maximum fps which the device can encoded with H.265 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<0~(n-1)>_cmosfreq"=60 or"videoin_c<0~(n-1)>_modulation"=ntsc* Only available when 'h265' is listed in "capability_videoin_codec".
description0/7Description about this mode.

7.27.9 Capability for Image

Group: capability_image_c<0\~(n-1)> n denotes the value of "capability_nvideoin"

NAME VALUE SECURITY(get/set)DESCRIPTION
basicsetting 0,integer>0/7A 32-bits integer, each bit can be set separately as follows:Bit 0 => Supports Brightness or not.Bit 1 => Supports Contrast or not.Bit 2 => Supports Saturation or not.Bit 3 => Supports Sharpness or not.Bit 4 => Supports adjusting the image to proper position horizontally or not.Bit 5 => Supports adjusting the image to proper position vertically or not.
hlm0/7Hightlight Mask: The function will strengthen the image contrast and mask the specified zone of image if any strong spot-light exists.* We support this parameter when the version number (httpversion) isequal or greater than 0311a.
wdrpro_mode0, 1, 20/70: Non-support WDR Pro1: Support WDR Pro2: Support WDR Pro II
wdrpro_strength0, 10/70: Non-support tuning strength of WDR Pro1: Support tuning strength of WDR Pro * If"capability_image_c<0~(n-1)>_wdrpro"=1, this may be either 0 or 1.
wdrpro_supportlevel 0,0/7 This contains a list of positive integers, split by comma.If "wdrpro_mode" =1, then the value indicate the support strength level of WDR Pro.If "wdrpro_mode" =2, then the first number indicate the support strength level of WDR Pro, and the second number indicate the support strength level of WDR Pro II.
wdrpro_affect-,exposurewin.mode :fixed:auto,exposurelevel:hidden:,exposurelevel:fixed :,,exposurelevel:fixed :,,exposuremode:fixed:auto,gammacurve:disabled:,exposurewin.mode .blc:hidden:,exposurewin.mode0/7When WDR Pro is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here.The format is "Affect API name":"Policy":"Description""Policy" can be categorized into following groups:- (disabled) : UI turns grey and users can't select it.- (unchanged) : UI keeps the status as before and user can't change it.- (hidden) : UI is hidden.- (fixed) : UI is fixed to one selection or value.- (ranged) : UI is fixed to multiple
.hlc:hidden:,exposuretime:hidden:,gaincontrol:hidden:,flickerless:unchanged:,wdrc:enabled:,wdrc:enabled:only once,wdrc:unchanged:,: nonnegative integer: nonnegative integerselections or values.-(enabled): UI is checked.(notsupport): the affected function is not available.(onlyonce): when wdrpro is enabled, wdrc is checked; when wdrpro is disable, wdrc is unchecked."Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6."Description" can be a nonnegative integer or string or NULL.For example:"exposurelevel:fixed:6/8/12" which means exposurelevel is fixed to level 6, level 8 and level 12."-" means no feature is affected.* When "wdrpro"=0, this value must be "-"
wdrpro_description0/7Description about WDR Pro mode.* Only available when "capability_image_c<0~(n-1)>_wdrpro_mode">0
wdrc_mode0, 10/70: Non-support WDR Enhanced1: Support WDR Enhanced
wdrc_supportlevel0,0/7Indicate the support strength level of WDR Enhanced.
wdrc_affect-,gammacurve:disabled:,: nonnegativeinteger0/7When WDR Enhanced is enabled, some features may become malfunction or be forced to a given value. The affected functions are listhere.The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups:- (disabled) : UI turns grey and users can't select it.- (unchanged) : UI keeps the status as before and user can't change it.- (hidden) : UI is hidden.- (fixed) : UI is fixed to one selection or value.- (ranged) : UI is fixed to multiple selections or values.- (enabled) : UI is checked.- (notsupport) : the affected function is not available."Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6."Description" can be a nonnegative integer or string or NULL.For example:"exposurelevel:fixed:6/8/12" which means exposurelevel is fixed to level 6, level 8 and level 12."-" means no feature is affected.* When "wdrc"=0, this value must be "-"
dnr0,10/70: Non-support 3D digital noise reduction1: Support 3D digital noise reduction
dnrstrength0/7Indicate the support strength level of 3D digital noise reduction.* Only available when "capability_image_c<0~(n-1)>_dnr">0.* We support this parameter when the version number (httpversion) is equal or greater than 0306d.
dnrtype2d,3d0/7Description about DNR type.* Only available when "capability_image_c<0~(n-1)>_dnr">0.* We support this parameter when the version number (httpversion) is equal or greater than 0308a.
eis0,10/70: Non-support electronic image stabilizer1: Support electronic image stabilizer
is_modeeis,dis,-0/7Indicate the image stabilizer mode."eis": electronic image stabilizer"dis": digital image stabilizer"-": not support* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
is_strength0/70: Non-support tuning strength of image stabilizer mode.1: Support tuning strength of image stabilizer mode.* Only available when "capability_image_c<0~(n-1)>_is_mode" is not "-".* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
is_supportlevel0,0/7Indicate the support strength level of image stabilizer mode.* Only available when "capability_image_c<0~(n-1)>_is_mode" is not "-".* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
is_affect -,0/7When Is mode is not "-", some features may become malfunction or be forced to a given value. The affected functions are list here.The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups:- (disabled) : UI turns grey and users can't select it.- (unchanged) : UI keeps the status as before and user can't change it.- (hidden) : UI is hidden.- (fixed) : UI is fixed to one selection or value.- (ranged) : UI is fixed to multiple selections or values.- (enabled) : UI is checked.- (notsupport) : the affected function is not available."Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc: disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means
exposurelevel is fixed to level 6."Description" can be a nonnegative integer or string or NULL."-" means no feature is affected.* Only available when "capability_image_c<0~(n-1)>_is_mode" is not "-".* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
scenemode_support0,10/70: Non-support scene mode1: Support scene mode
scenemode_supporttypeproduct dependent>visibility, noiseless,lpcparkinglot,lpcstreet,lpchighway,auto,deblur,lpcfreeway,signallight,railtrackproduct dependent>0/7list all the scene mode which are supported in the camera.* Only available when "capability_image_c<0~(n-1)>_scenemode_support" is 1
scenemode_signalligh t_affectproduct dependent>-, flickerless:unchanged:,wdrpro:unchanged :product dependent>0/7When scene mode is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here.The format is "Affect API name":"Policy":"Description""Policy" can be categorized into following groups:- (disabled) : UI turns grey and users can't select it.- (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available."Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc: disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6."Description" can be a nonnegative integer or string or NULL."-" means no feature is affected.* Only available when "signallight" is listed in "capability_image_c<0~(n-1)>_scene mode_supporttype" and "capability_image_c<0~(n-1)>_scene mode_support" is 1.
scenemode_railtrack_affectproduct dependent>-, flickerless:unchanged:,wdrpro:unchanged :productdependent>0/7When scene mode is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here.The format is "Affect APIname":"Policy":"Description" "Policy" can be categorized into following groups: - (disabled) : UI turns grey and users can't select it. - (unchanged) : UI keeps the status as before and user can't change it. - (hidden) : UI is hidden. - (fixed) : UI is fixed to one selection or value. - (ranged) : UI is fixed to multiple selections or values. - (enabled) : UI is checked. - (notsupport) : the affected function is not available. "Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc: disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6. "Description" can be a nonnegative integer or string or NULL. "-" means no feature is affected. * Only available when "railtrack" is listed in "capability_image_c<0~(n-1)>_scene mode_supporttype" and "capability_image_c<0~(n-1)>_scene mode_support" is 1.
wbmodeauto,panorama,manual,rbgain,widerange,outdoor,indoor,sodiumauto,-0/7Available white balance mode."-" means white balance is not supported.
iristype piris,dciris,-0/7 Indicateiris type."piris": P-Iris"dciris": DC-Iris"-": No Iris control support* Note: For some cameras, this value may be varied depending on mounted lens.
sensortyperawsensor,smartsensor,thermalsensor,-0/7Indicate sensor type."rawsensor": Raw sensor"smartsensor": Smart sensor"thermalsensor": Thermal sensor"-": N/A* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
exposure_mode0,10/70: Non-support exposure control.1: Support exposure control.
exposure_modetypeauto,shutterpriority,irispriority,manual0/7Available mode of exposure setting.* Only available when"capability_image_c<0~(n-1)>_exposure_mode" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
exposure_rangetype onevalue,twovalues0/7Support interface of exposure range."onevalue": The parameter is a
constant value."twovalues": Need two parameters to indicate the exposure range.* Only available when "capability_image_c<0~(n-1)>_exposure_mode" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
exposure_shuttervalu etypefixed, maximum, ranged, -0/7* One to one mapping to the mode type in "exposure_modetype"."fixed": The shutter value is the assigned value (videoin_c<0~(n-1)>_shuttervalue)."maximum": The shutter value can be up to the assigned value (videoin_c<0~(n-1)>_shuttervalue)."ranged": Need two parameters to indicate the shutter range.(videoin_c<0~(n-1)>_maxexposure/videoin_c<0~(n-1)>_maxexposure)"-": not support.* Only available when "shutterpriority" is listed in "capability_image_c<0~(n-1)>_exposure_modetype" and "capability_image_c<0~(n-1)>_exposure_mode" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
exposure_gainvaluetypefixed, maximum, ranged, -0/7* One to one mapping to the mode type in "exposure_modetype"."fixed": The gain value is the assigned value (videoin_c<0~(n-1)>_gainvalue)."maximum": The gain value can be up to the assigned value (videoin_c<0~(n-1)>_gainvalue)"ranged": Need two parameters to indicate the gain range. (videoin_c<0~(n-1)>_maxgain/ videoin_c<0~(n-1)>_maxgain)"-": not support.* Only available when "irispriority" or "shutterpriority" is listed in "capability_image_c<0~(n-1)>_exposure_modetype" and "capability_image_c<0~(n-1)>_exposure_mode" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
exposure_automode_ affect-,exposurewin.mode.blc:hidden:,defog:disabled:,wdrpro:disabled:,exposurelevel:hidden:,defaultgain:fixed:x or others:. nonnegative integerproduct dependent>0/7 When exposure auto mode is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here.The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups:- (disabled) : UI turns grey and users can't select it.- (unchanged) : UI keeps the status as before and user can't change it.- (hidden) : UI is hidden.- (fixed) : UI is fixed to one selection or value.- (ranged) : UI is fixed to multiple
selections or values.-(enabled): UI is checked.-(notsupport): the affected function is not available."Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6."Description" can be a nonnegative integer or string or NULL."-" means no feature is affected.* Only available when auto is listed in "capability_image_c<0~(n-1)>_exposure_modetype" and "capability_image_c<0~(n-1)>_exposure_mode" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
exposure_shutterprioritymode_affect-,exposurewin.mode.blc:hidden:,defog:disabled:,wdrpro:disabled:,exposurelevel:hidden:,defaultgain:fixed:x or others:.nonnegative integerproduct dependent>0/7 When exexposure shutter priority mode is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here.The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups:- (disabled): UI turns grey and users can't select it.- (unchanged): UI keeps the status as before anduser can't change it.-(hidden): UI is hidden.-(fixed): UI is fixed to one selection or value.-(ranged): UI is fixed to multiple selections or values.-(enabled): UI is checked.-(notsupport): the affected function is not available."Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6."Description" can be a nonnegative integer or string or NULL."-" means no feature is affected.* Only available when shutterpriority is listed in "capability_image_c<0~(n-1)>_exposure_modetype" and "capability_image_c<0~(n-1)>_exposure_mode" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
exposure_irispriority mode_affect-,exposurewin.mode.blc:hidden:,defog:disabled:,wdrpro:disabled:,exposurelevel:hidden:,defaultgain:fixed:x or others< x>: nonnegative integer< product dependent>0/7 When exexposure iris priority mode is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here.The format is "Affect API name":"Policy":"Description""Policy" can be categorized into following groups:- (disabled) : UI turns grey and users can't select it.- (unchanged) : UI keeps the status as before and user can't change it.- (hidden) : UI is hidden.- (fixed) : UI is fixed to one selection or value.- (ranged) : UI is fixed to multiple selections or values.- (enabled) : UI is checked.- (notsupport) : the affected function is not available."Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6."Description" can be a nonnegative integer or string or NULL."-" means no feature is affected.* Only available when irispriority is listed in "capability_image_c<0~(n-1)>_exposure_modetype" and "capability_image_c<0~(n-1)>_exposure_mode" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
exposure_qualityprioritymode_affect-,exposurewin.mode.blc:hidden:, defog:disabled:, wdrpro:disabled:, exposurelevel:hidden:, defaultgain:fixed:x or others:. nonnegative integer: dependent>0/7When exposure quality priority modeis enabled, some features may become malfunction or be forced to a given value. The affected functions are list here.The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups:- (disabled) : UI turns grey and users can't select it.- (unchanged) : UI keeps the status as before and user can't change it.- (hidden) : UI is hidden.- (fixed) : UI is fixed to one selection or value.- (ranged) : UI is fixed to multiple selections or values.- (enabled) : UI is checked.- (notsupport) : the affected function is not available."Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6."Description" can be a nonnegative integer or string or NULL."-" means no feature is affected.* Only available when qualitypriority is listed in "capability_image_c<0~(n-1)>_exposure_modetype" and"capability_image_c<0~(n-1)>_exposure_mode" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0305a.
exposure_manualmode_affect-,exposurewin.mode.blc:hidden:,defog:disabled:,wdrpro:disabled:,exposurelevel:hidden:,icrmode.auto:notsupport:or others:x>: nonnegative integerproduct dependent>0/7 When exposure manual mode is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here.The format is "Affect API name":"Policy":"Description""Policy" can be categorized into following groups:- (disabled) : UI turns grey and users can't select it.- (unchanged) : UI keeps the status as before and user can't change it.- (hidden) : UI is hidden.- (fixed) : UI is fixed to one selection or value.- (ranged) : UI is fixed to multiple selections or values.- (enabled) : UI is checked.- (notsupport) : the affected function is not available."Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6."Description" can be a nonnegative
integer or string or NULL."-" means no feature is affected.* Only available when manual is listed in "capability_image_c<0~(n-1)>_exposure_modetype" and "capability_image_c<0~(n-1)>_exposure_mode" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
exposure_levelrange -,"0,12"0/7 Available range for"videoin_c<0~(n-1)>_exposurelevel"* When "exposure_mode" = 0, this value must be set to "-".* Only available when"capability_image_c<0~(n-1)>_exposure_mode" is 1.
exposure_winmodeauto,custom,blc,hlc,center,-product dependent>0/7Available options for"exposurewin_c<0~(n-1)>_mode"* "-" means group: exposurewin is not supported.* When exposure_mode="0", this value must be set to "-".* Only available when"capability_image_c<0~(n-1)>_exposure_mode" is 1.
exposure_meteringmodeauto,blc,hlcproduct dependent>0/7 Available options for"videoin_c<0~(n-1)>_meteringmode"* Only available when"capability_image_c<0~(n-1)>_exposure_mode" is 1.
exposure_hlcmode_supportwindow0/7Indicate whether to support exposure window in hlc mode.* Only available when"capability_image_c<0~(n-1)>_exposure_mode" is 1 and hlc is listedin "capability_image_c<0~(n-1)>_exposure_winmode".
exposure_hlcmode_affect-, sir:hidden: or others:x>: nonnegative integerproduct dependent>0/7 When hlc mode is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here. The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups:- (disabled) : UI turns grey and users can't select it.- (unchanged) : UI keeps the status as before and user can't change it.- (hidden) : UI is hidden.- (fixed) : UI is fixed to one selection or value.- (ranged) : UI is fixed to multiple selections or values.- (enabled) : UI is checked.- (notsupport) : the affected function is not available."Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6."Description" can be a nonnegative integer or string or NULL."-" means no feature is affected.* Only available when "capability_image_c<0~(n-1)>_
exposure_mode" is 1 and hlc is listed in "capability_image_c<0~(n-1)>_exposure_winmode".* We support this parameter when the version number (httpversion) is equal or greater than 0304a.
exposure_wintype inclusive, exclusive, -0/7The supported exposure window type."inclusive": The image inside a window is the target area of exposure control."exclusive": The image inside a window is omitted by exposure control."-": Not supported.* Only available when "capability_image_c<0~(n-1)>_exposure_mode" is 1.
exposure_windomainqvga, px, std, -0/7The domain to set an exposure window."qvga": a 320x240 range to represent the whole image."px": Locate a window in the image with pixels."std": A normalized 0~9999 range."-": Not supported.* Only available when "capability_image_c<0~(n-1)>_exposure_mode" is 1.
exposure_winnum 0,Positive Integer>0/7 Indicatethe number of custom exposure windows.* If no "custom" is listed in "exposure_winmode", this should be 0.* Only available when "capability_image_c<0~(n-1)>_exposure_mode" is 1.
exposure_ntsc_totalrangeA list of0/7Available total range for NTSC analog output.* Only available when "capability_image_c<0~(n-1)>_exposure_mode" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0301a.
exposure_pal_totalrangeA list of0/7 Availabletotal range for PAL analog output.* Only available when "capability_image_c<0~(n-1)>_exposure_mode" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0301a.
exposure_maxrange"1,32000", "1,8000", -, or others0/7Available range for "videoin_cmaxexposure""1,32000" => 1s ~ 1/32000s"1,8000" => 1s ~ 1/8000s etc."-" means maximum exposure time is not available.* When "exposure_mode" = 0, this value must be set to "-".* Only available when "capability_image_c<0~(n-1)>_exposure_mode" is 1.
exposure_minrange "1,32000", "1,8000", -, or others0/7 Availablerange for "videoin_cminexposure""1,32000" => 1s ~ 1/32000s"1,8000" => 1s ~ 1/8000s etc."-" means minimum exposure time is not available.* When "exposure_mode" = 0, this
value must be set to "-".* Only available when"capability_image_c<0~(n-1)>_exposure_mode" is 1.
exposure_bracketing_mode0/70: Non-support Auto Exposure Bracketing (AEB)1: Support Auto Exposure Bracketing (AEB)Auto Exposure Bracketing (AEB) is a term that is used to signify a process where the camera automatically takes two or more exposures but with different exposure values.* Only available when"capability_image_c<0~(n-1)>_exposure_mode" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0310a.
exposure_bracketing_rangeA list of ratioFor example:2x,3x,4x0/7The input parameter decides how much ratio of exposure compensation will be expanded on the next stream, which is based on the original exposure time (first stream).* Only available when"capability_image_c<0~(n-1)>_exposure_bracketing_mode " is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0310a.
privacymask_wintyperectangle,polygon,3Drectangle0/7 The supported mask window type."polygon": The window is a 2D polygon shape."rectangle": The window is a 2D rectangle shape."3Drectangle": The window is a 3Drectangle shape.
privacymask_windomainqvga, px, std, -0/7The domain to set an window."qvga": a 320x240 range to represent the whole image."px": Locate a window in the image with pixels."std": A normalized 0~9999 range."-": Not supported.
privacymask_ncolor0/7Available total color numbers of privacy mask.
agc_maxgain "0,100", "-""-"0/7 Available range for"videoin_c__maxgain""0,100" => 0~100 percent"-" means "videoin_c__maxgain" is not available.
agc_mingain"0,100", "-"0/7Available range for"videoin_c__mingain""0,100" => 0~100 percent"-" means "videoin_c__mingain" is not available.
flickerless0,10/70: Non-support flickerless1: Support flickerless
flickerlessaffect-, minexposure.lower bound:fixed:x or others:. nonnegative integerproduct dependent>0/7When flickerless is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here.The format is "Affect API name":"Policy":"Description" "Policy" can be categorized into following groups:- (disabled) : UI turns grey and users can't select it.- (unchanged) : UI keeps the status as before and user can't change it.- (hidden) : UI is hidden.- (fixed) : UI is fixed to one selection or value.- (ranged) : UI is fixed to multiple selections or values.- (enabled) : UI is checked.- (notsupport) : the affected function is not available."Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6."Description" can be a nonnegative integer or string or NULL."-" means no feature is affected.* When "flickerless" = 0, this value must be "-"
defog_mode0,10/70: Non-support defog1: Support defog
defog_strength0, 10/70: Non-support tuning strength of defog1: Support tuning strength of defog* If"capability_image_c<0~(n-1)>_defog_mode"=1, this may be either 0 or 1.
defog_supportlevel 0,positiveinteger>0/7 The value indicate the support strength level of defog.
defog_affect-, wdrc:unchanged: contrast:hidden: or others:x>: nonnegative integer0/7When defog is enabled, some features may become malfunction or be forced to a given value. The affected functions are list here.The format is "Affect API name":"Policy":"Description""Policy" can be categorized into following groups:- (disabled) : UI turns grey and users can't select it.- (unchanged) : UI keeps the status as before and user can't change it.- (hidden) : UI is hidden.- (fixed) : UI is fixed to one selection or value.- (ranged) : UI is fixed to multiple selections or values.- (enabled) : UI is checked.- (notsupport) : the affected function is not available."Affect API name" can be described in hierarchy, such as "exposurewin.mode.blc:disabled:" which means blc exposure window is disabled. API name can be one word as well, such as "exposurelevel:fixed:6" which means exposurelevel is fixed to level 6."Description" can be a nonnegative integer or string or NULL."-" means no feature is affected.* When "defog" = 0, this value must be "-"
aespeed0,10/70: Non-support AE speed1: Support AE speed
aespeedsupportlevel0/7The value indicate the support strength level of aespeed.* Only available when "capability_image_c<0~(n-1)>_aespeed" is 1.
aespeedsupportssensitivity0,10/70: Non-support tuning the sensitivityof AE converge speed.1: Support tuning the sensitivity of AE converge speed.* Only available when "capability_image_c<0~(n-1)>_aespeed" is 1.
gammacurve0,10/70: Non-support tuning Gamma curve1: Support tuning Gamma curve
lowlightmode-,0,10/7-: Internal parameter, must not open to user.0: Non-support low light mode1: Support low light mode
focusassist0,10/70: Non-support focus assist1: Support focus assist
remotefocus0,<positive integer>0/7An 4-bit integer, which indicates the supportive application of remotefocus in this channel.If the value of this parameter is larger than 0, it means that the camera supports remotefocus function in this channel.bit 0 => Indicate whether to support both zoom and focus function.bit 1 => Only support zoom function.bit 2 => Only support focus function.bit 3 => Currently, this is a reserved bit, and the default value is 0.
focuswindomainqvga, px, std, -0/7The domain to set a focus window."qvga": a 320x240 range to represent the whole image."px": Locate a window in the image with pixels."std": A normalized 0~9999 range."-": Not supported.
focuswindow_nwindow0,<positiveinteger>0/7Number of focus window
focuswindow_range0/7Available range for focuswindow.* We support this parameter when the version number (httpversion) is equal or greater than 0305d.*-: Not supported.
lensconfiguration_support0,10/7Indicate whether to support different image library configuration files for specific exchangeable lens.
freeze0/70: Non-support image freeze feature1: Support image freeze feature* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
autotrack_support0/70: Non-support auto tracking feature1: Support auto tracking feature* We support this parameter when the version number (httpversion) is equal or greater than 0302a.
smartsensor_iristotalrangeA list of iris value0/7Available total step for iris value.* We support this parameter when the version number (httpversion) is equal or greater than 0302a.* Only available when "capability_image_c<0~(n-1)>_sensor type" is "smartsensor"
deinterlace_support0/7Indicate whether to support deinterlace function.* We support this parameter when the version number (httpversion) is equal or greater than 0308a.
deinterlace_modespatial, blend0/7Spatial mode provides the best image quality, while Blend mode provides better image quality (than not using the deinterlace function at all).* Only available when capability_image_c<0~(n-1)>_deinterlace_support is 1
lens_alignment0/7Indicate whether to support lens alignment function.* We support this parameter when the version number (httpversion) is equal or greater than 0309b.
lens_alignmentlevel0/7The value indicate the support level of alignment.* Only available when "capability_image_c<0~(n-1)>_lens_alignment" is 1.
lens_ldc_support0/7Indicate whether to support lens distortion correction function.* We support this parameter when the version number (httpversion) is equal or greater than 0309d.
palette_support0/7Indicate support color palettes or not. Thermal cameras provide a choice of color palettes on the camera, that help quickly distinguish thermal variations and patterns in an image. The color tones correspond to the apparent surface temperatures of the target.* We support this parameter when the version number (httpversion) is equal or greater than 0310a.
palette_mode A list of palette options0/7 Palette options used in thermal surveillance.*Only available when "capability_image_c<0~(n-1)>_palette_support"=1.* We support this parameter when the version number (httpversion) is0/7 Palette options used in thermal surveillance.*Only available when "capability_image_c<0~(n-1)>_palette_support"=1.* We support this parameter when the version number (httpversion) is
equal or greater than 0310a.
focussystem_mode AFbyzoom, focusshift, -product dependent>0/7 Supported features for remotefocus."AFbyzoom": Trigger autofocus if zoom is operated."focusshift": Ability to adjust day/night focus position."-": Not supported.* Only available when "capability_image_c<0~(n-1)>_remote focus">0* We support this parameter when the version number (httpversion) is equal or greater than 0316a

7.27.10 Capability for Peripheral Device

Group: capability_peripheral_c<0\~(n-1)> n denotes the value of "capability_nvideoin"

PARAMETERVALUESECURITY (get/set)DESCRIPTION
devicecontrol0/7Indicate whether to support the peripheral device control.* We support this parameter when the version number (httpversion) is equal or greater than 0305c.

7.27.11 Capability for Extension Modules

Group: capability_extension

PARAMETERVALUESECURITY (get/set)DESCRIPTION
di_num0/7The number of supported extension digital input module.* We support this parameter when the version number (httpversion) is equal or greater than 0316a.
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
do_num0/7The number of supported extension digital output module.* We support this parameter when the version number (httpversion) is equal or greater than 0316a.

7.28 Event Setting

Group: event_i<0\~(n-1)> n denotes the value of "capability_nevent"

(capability_nevent > 0)

PARAMETERVALUESECURITY (get/set)DESCRIPTION
namestring[40]6/6Identification of this entry.
enable0, 16/6Enable or disable this event.
priority0, 1, 26/6Indicate the priority of this event: “0”= low priority“1”= normal priority“2”= high priority
delay1~9996/6Delay in seconds before detecting the next event.
triggerboot,di,pir,motion,seq,recnotify,tampering,vi,volalarm,visignal,vadp,smartsd,presetreached,casingopen6/6Indicate the trigger condition:"boot" = System boot."di" = Digital input."pir" = PIR detection."motion" = Video motion detection."seq" = Periodic condition."visignal" = Video input signal loss."recnotify" = Recording notification."tampering" = Tamper detection."vi" = Virtual input (Manual trigger)."volalarm" = Audio detection."smartsd" = Lifetime detection of SD card."shockalarm" = Shock detection."virestore" = Video input signal restore."vadp" = VADP trigger."presetreached" = When any preset is reached"casingopen" = Casing open detection* "smartsd" is only valid when smart SD card is inserted
triggerstatusstring[40]6/6The status for event trigger
di0,<positive integer>6/6Indicate 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.* Only available when "capability_ndi">0
mdwinPARAMETER VALUE SECURITY0,<positive integer>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.(get/set)DESCRIPTION
mdwin00,6/6Similar to mdwin. The parameter takes effect when profile 1 of motion detection is enabled.
vi 0,integer>6/6Indicate 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.
vadpproduct dependent>0,6/6Indicate the source id of vadp event notification.Each bit corresponds to one vadp source, and the LSB indicates source id 0.For example, to detect event from any one of source id 0, 1 and 3, set vadp to 11.* Only available when vadp is listed in "capability_supporttriggertypes"
valevel0,16/6Select audio detection event.0: not select1: select
valevel00,16/6Select audio detection profile event.0: not select1: select
inter1~9996/6Interval of snapshots in minutes.This field is used when trigger condition is “seq”.
weekday0~1276/6Indicate 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.
begintimehh:mm6/6Begin time of the weekly schedule.
endtimehh:mm6/6End time of the weekly schedule.(00:00 ~ 24:00 sets schedule as always on)
lowlightcondition0, 16/6Switch on white light LED in low light condition0 => Do action at all times1 => Do action in low-light conditions
action_do_i<0~(k-1)>_enable6/6Enable or disable trigger digital output.k is determined by the below criterion:The following applies forcapability_extension_do_num >= 0* if extension_connected=1,k=capability_ndo* if extension_connected=0,k=capability_ndo+capability_extension_do_numOtherwise,* k=capability_ndo* Only available when "capability_ndo" >0
action_do_i<0~(k-1)>_duration1~9996/6Duration of the digital output trigger in seconds.k is determined by the below criterion:The following applies forcapability_extension_do_num >= 0* if extension_connected=1,k=capability_ndo* if extension_connected=0,k=capability_ndo+capability_extension_do_numOtherwise,* k=capability_ndo* Only available when "capability_ndo">0
action_cf_enable6/6Enable or disable sending media to SD card.* Only available when"capability_supportsd">0
action_cf_folderstring[128]6/6Path to store media.* Only available when"capability_supportsd">0string[128]6/6Path to store media.* Only available when"capability_supportsd">0
foldernamestring[128]6/6Path to store media.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
action_cf_mediaNULL, 0~4,1016/6Index of the attached media.101 means “Recording Notify"* Only available when"capability_supportsd">0
action_cf_datefolder6/6Enable this to create folders by date, time, and hour automatically.* Only available when"capability_supportsd">0
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
action_cf_backup6/6Enable or disable the function that send media to SD card for backup if network is disconnected.* Only available when "capability_supportsd" >0
action_server_i<0~4>_enable6/6Enable or disable this server action.
action_server_i<0~4>_mediaNULL, 0~4,1016/6Index of the attached media.101 means "Recording Notify"
action_server_i<0~4>_datefolder6/6Enable this to create folders by date, time, and hour automatically.
action_goto_enable6/6Enable/disable ptz goto preset position on event triggered.* Only available when "capability_ptzenabled" >0.
action_goto_namestring[40]6/6Specify the preset name that ptz goto on event triggered.* Only available when "capability_ptzenabled" >0.
action_goto_sync6/6Capture media after moving to the location.* Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0, or capability_camctrl_c0_zoommodule >0
action_autotrack_enable6/6Enable/disable auto tracking when an event is triggerd.* Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
action_autotrack_namestring[40]6/6Indicate the source name of smart tracking advanced when an event is triggered.* Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0, and the camera supports “Smart Tracking Advanced” feature. (Please refer to PTZ Control API for more details)* We support this parameter when the version number (httpversion) is equal or greater than 0317d.
action_tour_enable6/6Enable/disable auto tour function when an event is triggered.* Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0
action_tour_namestring[40]6/6Indicate the source name of auto tour when an event is triggered.* Only avaliable when the bit4 of capability_ptzenabled is 1 and the bit7 of capability_ptzenabled is 0
action_audioclip_enable6/6Enable/disable the function the play an audio clip when an event is triggered.* Only avaliable when "capability_audio_audioclip" is 1.
action_audioclip_media0,<positive integer>6/6Indicate the source id of audioclip event notification.* Only avaliable when "capability_audio_audioclip" is 1.
tampering0,<positive integer>6/6Indicate the source channel id of tampering detection.A 4-bit integer, each bit represents each channel.bit 0 => tampering detection for first channel.bit 1 => tampering detection for second channel.bit 2 => tampering detection for third channel.bit 3 => tampering detection for fourth channel.* We support this parameter when the version number (httpversion) is equal or greater than 0311c.
action_cameralink_id6/6Refer to the receiver camera id when an event is triggered.ex. cameralink_i0 refers to the information in cameralink_i0 group.* Only available when "capability_cameralink_support" is 1.

7.29 Server Setting for Event Action

Group: server_i<0\~4>

PARAMETERVALUESECURITY (get/set)DESCRIPTION
namestring[40]6/6Identification of this entry
typeemail, ftp, http, ns, sftp6/6Indicate the server type: “email” = email server “ftp” = FTP server “http” = HTTP server “ns” = network storage “sftp” = secure FTP * “sftp” is only available when bit 1 of “capability_protocol_ftp_client” is 1.
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
http_urlstring[128]6/6URL of the HTTP server to upload.
http_usernamestring[64]6/6Username to log in to the server.
http_passwdstring[64]7/6Password of the user.
ftp_addressstring[128]6/6FTP server address.
ftp_usernamestring[64]6/6Username to log in to the server.
ftp_passwdstring[64]7/6Password of the user.
ftp_port0~655356/6Port to connect to the server.
ftp_locationstring[128]6/6Location to upload or store the media.
ftp_passive6/6Enable or disable passive mode.0 = disable passive mode1 = enable passive mode
email_addressstring[128]6/6Email server address.
email_sslmode6/6Enable support SSL.
email_port0~655356/6Port to connect to the server.
email_usernamestring[64]6/6Username to log in to the server.
email_passwdstring[64]7/6Password of the user.
email_senderemailstring[128]6/6Email address of the sender.
email_recipientemailstring[640]6/6Email address of the recipient.
ns_locationstring[128]6/6Location to upload or store the media.* For httpversion is equal or greater than 0312a:The media storage path format is “\date\hour”. (Only available when “nas” is included in “capability_storage_management_device”)* For httpversion smaller than 0312a:The media storage format is “\date\hour”.* Note: “\date\hour” format is “\YYYYMMDD\hh”.
ns_usernamestring[64]6/6Username to log in to the server.
ns_passwdstring[64]7/6Password of the user.
ns_workgroupstring[64]6/6Workgroup for network storage.

7.29.1. Server Setting for Event Action of sftp

Group: server_i<0\~4>_sftp

* Only available when bit 1 of "capability_protocol_ftp_client" is 1.

PARAMETERVALUESECURITY (get/set)DESCRIPTION
addressstring[128]6/6Server address
loginmodepasswd, publickey6/6authentication method:"passwd" = password authentication.You have to setup sftp_passwd for this login mode to work."publickey" = Public key authentication is more secure than password authentication.Please see sftpclient.cgi for more detail settings.
usernamestring[64]6/6Username
passwdstring[64]7/6User password
port0~655356/6Server port
locationstring[128]6/6Login path on server
fingerprint_enableboolean6/6Verify server fingerprint to avoid connect to fake server.
fingerprint_content<128-bit hash value>6/6Server fingerprint(MD5).You can get it by calculate server host key(public) md5.
publickey_pairmodeauto, download, upload6/6"autopair": Autopair mode is selected for this event server."downloadkey": Download key pair mode is selected for this event server."uploadkey": Upload key pair mode is selected for this event server.
publickey_downloadkeytype ed25519,rsa,ecdsa6/6The keytype used for key pair."ed25519": faster to generate with higher security level, some old server might not support."rsa": slower to generate with slightly lower security level than ed25519."ecdsa": low security level.
publickey_passphrase_enableboolean6/6The private key file be encrypted or not.
publickey_passphrase_contentstring[128]7/6The encryption passphrase.

7.30 Media Setting for Event Action

Group: media_i<0\~(n-1)> n denotes the value of "capability_media_num"

(capability_media_num > 0)

PARAMETER VALUE SECURITY(get/set)DESCRIPTION
Namestring[40]6/6Identification of this entry
Type snapshot,systemlog, videoclip, recordmsg6/6 Mediatype to send to the server or store on the server.
snapshot_channel0~"capability_nvideoin"-16/6Indicate the source of media channel.0 means the first channel.1 means the second channel.2 means the third channel.3 means the fourth channel.* We support this parameter when the version number (httpversion) is equal or greater than 0311c.
snapshot_source0~"capability_nmediastream"-16/6Indicate the source of media stream.0 means the first stream.1 means the second stream and etc.2 means the third stream and etc.3 means the fourth stream and etc.
snapshot_prefixstring[16]6/6Indicate the prefix of the filename.media_i0=>Snapshot1_media_i1=>Snapshot2_media_i2=>Snapshot3_media_i3=>Snapshot4_media_i4=>Snapshot5_
snapshot_datesuffix0, 16/6Add date and time suffix to filename:1 = Add date and time suffix.0 = Do not add.
snapshot_preevent0~"capability_media_snapshot_maxpreevent"6/6 Indicates the number of pre- event images.
snapshot_postevent0~"capability_media_snapshot_maxpostevent"6/6Indicates the number of post-event images.
videoclip_channel0~"capability_nvideoin"-16/6Indicate the source of media channel.0 means the first channel.1 means the second channel.2 means the third channel.3 means the fourth channel.* We support this parameter when the version number (httpversion) is equal or greater than 0311c.
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
videoclip_source0~"capability_nmediastream"-16/6Indicate the source of media stream.0 means the first stream.1 means the second stream and etc.2 means the third stream and etc.3 means the fourth stream and etc.
videoclip_prefixstring[16]6/6Indicate the prefix of the filename.
videoclip_preevent0 ~ "capability_media_videoclip_maxpreevent"6/6Indicates the time for pre-event recording in seconds.
videoclip_maxduration1 ~ "capability_media_videoclip_maxlength"6/6 Maximum duration of one video clip in seconds.
videoclip_maxsize50 ~ "capability_media_videoclip_maxsize"6/6Maximum size of one video clip file in Kbytes.
videoclip_profiletokenstring[64]6/6Indicate the source for media profile.* We support this parameter when the version number (httpversion) is equal or greater than 0314b.

7.31 Recording

Group: recording_i<0\~(n-1)> n denotes the value of "capability_nrecording"

(capability_nrecording > 0)

PARAMETERVALUESECURITY (get/set)DESCRIPTION
namestring[40]6/6Identification of this entry.
triggerschedule, networkfail6/6 The event trigger type schedule: The event is triggered by schedule networkfail: The event is triggered by the failure of network connection.
enable6/6Enable or disable this recording.
priority0, 1, 26/6Indicate the priority of this recording: "0" indicates low priority. "1" indicates normal priority. "2" indicates high priority.
channel0~"capability_nvideoin"-16/6Indicate the source of recording channel. 0 means the first channel. 1 means the second channel. 2 means the third channel. 3 means the fourth channel. * We support this parameter when the version number (httpversion) is equal or greater than 0311c.
source0~"capability_nmediastream"-16/6Indicate the source of media stream. 0 means the first stream. 1 means the second stream and so on.
PARAMETER VALUESECURITY(get/set)DESCRIPTION
maxretentiontime6/6To specify the expired time for automatic clean up, and it only takes effect for video clip generated by recording_i <0~1>.Format is“P[Y]Y[MM]M[DDD]DT[hh]H[mm]M[ss]S”, similar with ISO8601 with symbols P Ex. P7D, it means 7 days. P1DT10H, it means 1 days and 10 hours.The parameter takes effect when autocleanup_maxretentiontime_recording_enabled is enabled.
notify6/60: Disable recording notification1: Enable recording notification
notifyserver0~316/6Indicate 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.
weekday0~1276/6Indicate 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.
begintimehh:mm6/6Start time of the weekly schedule.
endtime hh:mm 6/6 End time of the weekly schedule.(00:00~24:00 indicates schedule always on)
prefixstring[16]6/6Indicate the prefix of the filename.
destcf,0~46/6 The destdestination to store the recorded data."cf" means local storage (CF or SD card)."0" means the index of the network storage.
cffolderstring[128]Folder name.string[128]6/6Folder name.
foldernamestring[128]6/6Folder name.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
maxsize100~20006/6Unit: Mega bytes.When this condition is reached, recording file is truncated.
maxduration60~36006/6Unit: SecondWhen this condition is reached, recording file is truncated.
adaptive_enable6/6Indicate whether the adaptive recording is enabled
adaptive_preevent0~96/6Indicate when is the adaptive recording started before the event trigger point (seconds)
adaptive_postevent0~106/6Indicate when is the adaptive recording stopped after the event trigger point (seconds)
recordingjob_SourceToken_Tokenstring[64]6/6Indicate the source for media profile.* We support this parameter when the version number (httpversion) is equal or greater than 0314b.

7.32 HTTPS

Group: https (capability_protocol_https > 0)

NAME VALUE SECURITY(get/set)DESCRIPTION
enable6/6To enable or disable secure HTTP.
policy6/6If the value is 1, it will force HTTP connection redirect to HTTPS connection
methodauto, manual, install6/6auto =>Create self-signed certificate automatically. manual =>Create self-signed certificate manually. install =>Create certificate request and install.
status-3 ~ 16/6Specify the https status. -3= Certificate not installed -2 = Invalid public key -1 = Waiting for certificate 0= Not installed 1 = Active
countrynamestring[2]6/6Country name in the certificate information.
stateorprovincenamestring[128]6/6State or province name in the certificate information.
localitynamestring[128]6/6The locality name in the certificate information.
organizationnamestring[64]VIVOTEK Inc.6/6Organization name in the certificate information.
unitstring[64]VIVOTEK Inc.6/6Organizational unit name in the certificate information.
commonnamestring[64]www.vivotek.com6/6Common name in the certificate information.
validdays0 ~ 8256/6Valid period for the certification.

7.33 Storage Management Setting

Group: disk_i<0\~(n-1)> n denotes the value of "capability_storage_management_ndevice" (capability_storage_management_ndevice > 0)

PARAMETERVALUESECURITY (get/set)DESCRIPTION
cyclic_enabled6/6Enable cyclic storage method.
cyclic_reserve10 ~ 996/6The reserved percentage of this disk.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
typesd, nas6/7The storage device type.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
autocleanup_modetargetbase, sourcebase6/6Specify the automatic clean up method for storage devices, where “targetbase” indicate the automatic clean up is based on the attached devices such as nas or sd card, whereas “sourcebase” indicate automatic clean up is based on the selected recording track.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
autocleanup_enabled6/6Enable automatic clean up method.Expired and not locked media files will be deleted.* For forward compatibility reservations, but only group disk_i0_autocleanup is effective.* Not recommended to use this. Please refers "autocleanup" group.* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
autocleanup_maxage6/6To specify the expired days for automatic clean up.* For forward compatibility reservations, but only group disk_i0_autocleanup is effective.* Not recommended to use this. Please refers "autocleanup" group.* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.

7.34 Region of Interest

Group: roi_c<0\~(n-1)> for n channel product and m is the index of video stream which support ePTZ. (capability_eptz > 0)

PARAMETER VALUE SECURITY(get/set)DESCRIPTION
s<0~(m-1)>_home1/6ROI left-top corner coordinate.* If the minimal window size is 64x64, then the "home"=(0~resolution_W-64, 0~resolution_H-64), which the resolution is equal to the captured size by device in this video mode.* If the stream doesn't support ePTZ, the permissions of this parameter must be set as 1/7.
s<0~(m-1)>_size1/6 ROI width and height. The width value must be multiples of 16 and the height value must be multiples of 8*If the minimal window size is 64x64, then the "size"=(64~resolution_W, 64~resolution_H), which the resolution is equal to the captured size by device in this video mode.* If the stream doesn't support ePTZ, the permissions of this parameter must be set as 1/7.

7.35 ePTZ Setting

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

PARAMETER VALUE SECURITY(get/set)DESCRIPTION
osdzoom1/4Indicates multiple of zoom in is "on-screen display" or not.* Reserved for compatibility, and suggest don't use this since [httpversion] >0302a* We replace"eptz_c<0~(n-1)>_osdzoom" with "videoin_c<0~(n-1)>_zoomratiodisplay".
smooth1/4Enable the ePTZ "move smoothly" feature
tiltspeed-5 ~ 51/7Tilt speed(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)
panspeed-5 ~ 51/7Pan speed(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)
zoomspeed-5 ~ 51/7Zoom speed(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)
autospeed1 ~ 51/7Auto pan/patrol speed(It should be set by eCamCtrl.cgi rather than by setparam.cgi.)

7.35.1. ePTZ Settings for Each Stream

Group: eptz_c<0\~(n-1)>_s<0\~(m-1)> for n channel product and m is the index of video stream.

(capability_eptz > 0)

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

7.36 Focus Window Setting

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

n denotes the value of "capability_nvideoin".

(capability_image_c<0\~(n-1)>_focuswindow_nwindow>0)

PARAMETERVALUESECURITY (get/set)DESCRIPTION
win_i0_enable4/4Enable or disable the window.
win_i0_home4/4 Left-topcorner coordinate of the window.* If the minimal window size is 192x144, then the"win_i0_home"=(0~resolution_W-192,0~resolution_H-144), resolution_W and resolution_H based on"capability_image_c<0~(n-1)>_focuswindow_range".
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
win_i0_sizeWidth and height of the window.* The minimal window size is 192x144, and resolution_W and resolution_H is based on "capability_image_c<0~(n-1)>_focuswindow_range".

7.37 Seamless Recording Setting

Group: seamlessrecording

(capability_localstorage_seamless>0)

* We do not support this parameter when "capability_nvideoin > 1".

PARAMETERVALUESECURITY (get/set)DESCRIPTION
diskmodeseamless, manageable1/6 “seamless” indicates enable seamless recording. “manageable” indicates disable seamless recording.* We replace this parameter with “seamlessrecording_c<0~(n-1)>_diskmode” when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin >1".* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
maxconnection31/7Maximum number of connected seamless streaming.* We replace this parameter with "seamlessrecording_c<0~(n-1)>_maxconnection" when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin > 1"* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
enable1/7Indicate whether seamless recording is recording to local storage or not at present. (Read only)* We replace this parameter with "seamlessrecording_c<0~(n-1)>_triggerrecord" when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin > 1"* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
guid<0~2>_idstring[127]1/7The connected seamless streaming ID. (Read only)* We replace this parameter with "seamlessrecording_c<0~(n-1)>_guid<0~2>_id" when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin > 1"* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
guid<0~2>_number0~3Number of connected seamless streaming with guid<0~(k-1>_id.(Read only)* We replace this parameter with “seamlessrecording_c<0~(n-1>_guid<0~2>_number” when the version number (httpversion) is equal or greater than 0312a.* We do not support this parameter when "capability_nvideoin >1"* This parameter will not be used after the version number (httpversion) is equal or greater than 0400a.

7.37.1 Seamless recording setting per channel

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

n denotes the value of "capability_nvideoin".

(capability_localstorage_seamless>0)

PARAMETERVALUESECURITY (get/set)DESCRIPTION
diskmode seamless,manageable1/6“seamless” indicates enable seamless recording. “manageable” indicates disable seamless recording.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
maxconnectiontriggerrecord31/71/7Maximum number of connected seamless streaming.* We support this parameter when the version number (httpversion) is equal or greater than 0312a.Indicate whether seamless recording is recording to local storage or not at present.(Read only)* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
guid<0~(k-1)>_idstring[127]1/7The connected seamless streaming ID.(Read only)* k denotes the value of"seamlessrecording_c<0~(n-1)>_maxconnection"* We support this parameter when the version number (httpversion) is equal or greater than 0312a.
guid<0~(k-1)>_number0~31/7Number of connected seamless streaming with guid<0~(k-1)>_id.(Read only)* k denotes the value of"seamlessrecording_c<0~(n-1)>_maxconnection"* We support this parameter when the version number (httpversion) is equal or greater than 0312a.

7.38 VIVOTEK Application Development Platform Setting

Group: vadp

NAMEVALUESECURITY (get/set)DESCRIPTION
version6/7Indicate the VADP version.
resource_total_memory0,6/7Indicate total available memory size for VADP modules.
resource_total_storage0,6/7Indicate total size of the internal storage space for storing VADP modules.
resource_free_memoryNAME VALUE SECURITY0,6/7(get/set)Indicate free memory size for VADP modules.DESCRIPTION
resource_free_storage0,6/7Indicate current free storage size for uploading VADP modules.
module_number 0,itive integer>6/7 Recordthe total module number that already stored in the system.
module_orderstring[40]6/6The execution order of the enabled modules.
module_save2sd6/6Indicate 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.* This feature is not supported when "capability_securecam_support=1" and the version number of "capability_securecam_version" < "1.0.1.0"
numberstring[128]6/7This number is used to register license key for VADP application.
statusstring[40]6/7Indicate the hardware restore status
developer_mode6/6Developer mode provide ways to establish communication between the developer of VADP vendor and your camera.* Only available when capability_securecam_support=1.

Group: vadp_hyperlink_i<0\~(n-1)>

Maximum of n=10 hyperlink is supported.

NAMEVALUESECURITY (get/set)DESCRIPTION
moduleidx 0,<positiveinteger>1/7 Refer to the package index.
titlestring[40]1/7Name of the vadp hyperlink.
NAME VALUE SECURITY(get/set)DESCRIPTION
urlstring[120]1/7The URL address of vadp hyperlink.
statusstring[40]1/7Value of “on” indicates a valid connection of vadp hyperlink.Value of “off” indicates a invalid connection of vadp hyperlink.

7.38.2. VADP Settings for Each Package

Group: vadp_module_i<0\~(n-1)> for n VADP package number (capability_vadp_npackage > 0) n denotes the value of "capability_vadp_npackage".

NAMEVALUESECURITY (get/set)DESCRIPTION
enable6/6Indicate if the module is enabled or not.If yes, also add the index of this module to the module_order.
namestring[40]6/6Module name
extendednamestring[40]6/6Extended module name. If this value is not blank, it will be shown on the VADP UI first instead ofvadp_module_i<nae.
urlstring[120]6/6Define the URL string after the IP address if the module provides it own web page.
vendorstring[40]6/6The provider of the module.
vendorurlstring[120]6/6URL of the vendor.
versionstring[40]6/6Version of the module.
licensestring[40]6/6Indicate the license status of the module.
licmsgstring[128]6/6Indicate the message that will be show on license status when mouse over.
pathstring[40]6/7Record the storage path of the module.
initscrstring[40]6/7The script that will handle operation commands from the system.
statusstring[40]6/6Indicate the running status of the module.
NAME VALUE SECURITY(get/set)DESCRIPTION
statmsgstring[128]6/6Indicate the message that will be show on the running status when mouse over.
vvtklicensemecstring[40]6/7Indicate the module use VIVOTEK license mechanism

7.38.3. VADP Schedule Settings

Group: vadp_schedule_i<0\~(n-1)> for n VADP package number

n denotes the value of "capability_vadp_npackage".

(Only available when "capability_vadp_npackage" > 0 and the version number of "vadp_version" >= "1.3.2.0")

NAMEVALUESECURITY (get/set)DESCRIPTION
enable6/6Enable or disable the schedule mode to control the execution of the VADP package
begintimehh:mm6/6Begin time of the schedule
endtimehh:mm6/6End time of the schedule

7.38.4. VADP Event Settings

Group: vadp_event

NAME VALUE SECURITY(get/set)DESCRIPTION
ntrigger0,6/7Indicate the number of topics to be transferred to event manager for trigger.
triggerlist_i<0~(n-1)>_topicstring[256]6/6Indicate the event notification with this topic will be transferred to event manager as trigger.n is equal to ntrigger above.

7.39 Camera PTZ Control

Group: camctrl (capability_camctrl_ptztunnel > 0)

NAMEVALUESECURITY (get/set)DESCRIPTION
enableptztunnel1/4Enable PTZ tunnel for camera control.

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

n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset"

NAMEVALUESECURITY (get/set)DESCRIPTION
panspeed-5 ~ 51/4Pan speed
tiltspeed-5 ~ 51/4Tilt speed
zoomspeed-5 ~ 51/4Zoom speed
focusspeed-5 ~ 51/4Auto focus speed
patrolseqstring[120]1/4(For external device)The indexes of patrol points, separated by “,”
patroldwellingstring[160]1/4(For external device)The dwelling time of each patrol point, separated by “,”* only available whencapability_camctrl_c0_rs485=2
preset_i<0~(k-1)>_namestring[40]1/4Name of the preset location.
preset_i<0~(k-1)>_dwelling0 ~ 9991/4The dwelling time of each preset location* only available whencapability_camctrl_c0_rs485=2
uart0 ~ "capability_nuart"-11/4 Select corresponding uart(capability_nuart>0).* only available whencapability_camctrl_c0_rs485=2
cameraid0~2551/4Camera ID controlling external PTZ camera.
isptz0 ~ 21/40: disable PTZ commands.1: enable PTZ commands with PTZ
NAME VALUE SECURITY(get/set)DESCRIPTION
driver.2: enable PTZ commands with UART tunnel.* only available when capability_camctrl_c0_rs485=2
disablemdonptz1/4Disable motion detection on PTZ operation.

7.40 Camera PTZ Control (IZ Series)

Group: camctrl_c<0\~(n-1)> for n channel products (capability_camctrl_c0_zoommodule = 1 and capability_camctrl_c0_buildinpt = 0)

n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset"

NAME VALUE SECURITY(get/set)DESCRIPTION
ccdtypestring[16]6/7(Internal used, read only)
motortypestring[16]6/7(Internal used, read only)
cameraid0 ~ 2551/4Camera ID controlling external PTZ camera.Note:Please set your speed dome to the appropriate baud rate, and Camera ID, e.g. 2400bps, camera ID 1,2,3,,,etc.All Camera IDs on the same controlling system (NVR or rs485 keyboard) have to be distinct.Therefore, once you send a controlling signal, each camera will only accept the inputs with the corresponding ID.
panspeed-5 ~ 51/4Pan speed
tiltspeed-5 ~ 51/4Tilt speed
zoomspeed-5 ~ 51/4Zoom speed
autospeed-5 ~ 51/4Auto pan speed
focusspeed-5 ~ 51/4Auto focus speed
focusmodeauto,onetimeau to,spotlight,manual* Available values are listed in "capability_cam ctrl_c<0~(n-1)>_focusmode"1/4Indicate the focus control mode.
uart0 ~ "capability_nuart"-11/4 Select corresponding uart(capability_nuart>0).* only available whencapability_camctrl_c0_rs485=2
isptz0 ~ 21/40: disable PTZ commands.1: enable PTZ commands with PTZ driver.2: enable PTZ commands with UART tunnel.* only available whencapability_camctrl_c0_rs485=2
preset_i<0~(k-1)>_namestring[40]1/4Name of the preset location.
preset_i<0~(k-1)>_zoomcapability_ptz_c<0~(n-1)>_min zoom ~capability_ptz_c<0~(n-1)>_maxzoom1/4Zoom position at each preset location.
preset_i<0~(k-1)>_focuscapability_ptz_c<0~(n-1)>_min focus ~capability_ptz_c<0~(n-1)>_maxfocus1/4Focus position at each preset location.
preset_i<0~(k-1)>_dwelling0 ~ 9991/4The dwelling time of each preset location* only available whencapability_camctrl_c0_rs485=2
preset_i<0~(k-1)>_focussettingsync,fixcurrent1/4The focus mode of each preset, which isessential and should be grouped with “preset_i<0~(k-1)>_name.”* We support this parameter when the version number (httpversion) is equal or greater than 0305b.
patrolseqstring[120]1/4(For external device)The indexes of patrol points, separated by “,”
patroldwellingstring[160]1/4(For external device)The dwelling time of each patrol point, separated by “,”* only available whencapability_camctrl_c0_rs485=2
disablemdonptz1/4Disable motion detection on PTZ operation.
defaulthome1/4This field tells system to use default home position or not.
axisz capability_ptz_c<0~(n-1)>_minzoom ~capability_ptz_c<0~(n-1)>_maxzoom1/4 Customhome zoom position.
axisfcapability_ptz_c<0~(n-1)>_minfocus ~capability_ptz_c<0~(n-1)>_maxfocus1/4Custom home focus position.
digitalzoom1/4Enable/disable digital zoom
zoomenhance1/4Enable /disable zoom enhancement
returnhome1/4Enable/disable return home while idle.
returnhomeinterval1~9991/4While idle over this time interval, idle action will be taken.
idleaction_enable1/4Enable/disable idle action while idle
idleaction_typehome1/4This field tells what kind of actionshould be taken while idle.
idleaction_interval1~9991/4While idle over this time interval, idle action will be taken.

PLEASE REFER TO PTZ CONTROL API

7.41 Camera PTZ Control (SD Series)

Group: camctrl_c<0\~(n-1)> for n channel products (the bit7 of capability_ptzenabled is 0 and the bit4 of capability_ptzenabled is 1)

n denotes the value of "capability_nvideoin" and k denotes the value of "capability_npreset"

NAME VALUESECURITY(get/set)DESCRIPTION
ccdtypestring[16]6/7(Internal used, read only)
motortypestring[16]6/7(Internal used, read only)
cameraid1 ~ 2551/4Camera ID controlling external PTZ camera.Note:Please set your speed dome to the appropriate baud rate, and Camera ID, e.g. 2400bps, camera ID 1,2,3,,,etc.All Camera IDs on the same controlling system (NVR or rs485 keyboard) have to be distinct.Therefore, once you send a controlling signal, each camera will only accept the inputs with the corresponding ID.
panspeed-5 ~ 51/4Pan speed
tiltspeed-5 ~ 51/4Tilt speed
zoomspeed-5 ~ 51/4Zoom speed
autospeed-5 ~ 51/4Auto pan speed
focusspeed-5 ~ 51/4Auto focus speed
focusmodeauto,onetimeauto,spotlight,manual1/4Indicate the focus control mode.
NAME VALUE SECURITY(get/set)DESCRIPTION
* Available values are listed in "capability_camctrl_c <0~(n-1)>_focusmode"
preset_i<0~(k-1)>_namestring[40]1/4Name of the preset location.
preset_i<0~(k-1)>_pancapability_ptz_c<0~(n-1)>_minpan ~capability_ptz_c<0~(n-1)>_maxpan1/4Pan position at each preset location.
preset_i<0~(k-1)>_tilt capcapability_ptz_c<0~(n-1)>_mintilt ~capability_ptz_c<0~(n-1)>_maxtilt1/4 Tilt position at each preset location.
preset_i<0~(k-1)>_zoomcapability_ptz_c<0~(n-1)>_minzoom ~capability_ptz_c<0~(n-1)>_maxzoom1/4Zoom position at each preset location.
preset_i<0~(k-1)>_focuscapability_ptz_c<0~(n-1)>_minfocus ~capability_ptz_c<0~(n-1)>_maxfocus1/4 Focus position at each preset location.
preset_i<0~(k-1)>_focus settingsync, fixcurrent1/4The focus mode of each preset, which is essential and should be grouped with "preset_i<0~(k-1)>_name." * We support this parameter when the version number (httpversion) is equal or greater than 0305b.
preset_i<0~(k-1)>_fliped1/4Flip side at each preset location.
patrol_i<0~39>_namestring[40]1/4(For internal device) The name of patrol location
patrol_i<0~39>_dwellingdisablemdonptz0 ~ 9991/41/4(For internal device) The dwelling time of each patrol locationDisable motion detection on PTZ operation.
defaulthome1/4This field tells system to use default home position or not.
axisxcapability_ptz_c<0~(n-1)>_minpan ~capability_ptz_c<0~(n-1)>_maxpan1/4Custom home pan position.
axisycapability_ptz_c<0~(n-1)>_mintilt ~capability_ptz_c<0~(n-1)>_maxtilt1/4 Customhome tilt position.
axiszcapability_ptz_c<0~(n-1)>_minzoom ~capability_ptz_c<0~(n-1)>_maxzoom1/4Custom home zoom position.
axisfcapability_ptz_c<0~(n-1)>_minfocus ~capability_ptz_c<0~(n-1)>_maxfocus1/4 Customhome focus position.
axisflip1/4Custom home flip side.
returnhome1/4Enable/disable return home while idle.
returnhomeinterval1~9991/4While idle over this time interval, idle action will be taken.
digitalzoom1/4Enable/disable digital zoom
idleaction_enable1/4Enable/disable idle action while idle
idleaction_typepan,patrol,tour,home,objtrack,prev1/4 This fiel d tells what kind of action should be taken while idle.
idleaction_interval1~9991/4While idle over this time interval, idle action will be taken.
zoomenhance1/4Enable /disable zoom enhancement
tour_index-1, 0~191/4Index of the enabled tour group, from 0 to 19.Set -1 to disable all the tour groups.
tour_i<0~19>_namestring[40]1/4Name of the tour.
tour_i<0~19>_type1/40 = Recorded tour1 = Preset tour
tour_i<0~19>_speed-5 ~ 51/4Preset tour: pan and tilt speed when moving between presets. Recorded tour: unnecessary.
tour_i<0~19>_directionforward,backward,random1/4User can choose which direction the preset tour goes."forward": preset tour goes in forward order."backward": preset tour goes in backward order."random": the presets of the tour will be recalled randomly.* Only available when "capability_presettourdirection" is 1.* We support this parameter when the version number (httpversion) is equal or greater than 0307a.
tour_i<0~19>_checkliststring[512]1/4The indexes of preset positions, separated by ", "
tour_i<0~19>_dwelltimestring[512]1/4Preset tour: time to wait before moving to the next preset position, separated by ", "Recorded tour: number of seconds to wait before continuing a loop tour.
tour_i<0~19>_enabletrack1/4Whether the "preset tour" enters the tracking mode during the dwell time* We support this parameter when the version number
(httpversion) is equal or greater than 0317a.

PLEASE REFER TO PTZ CONTROL API

7.42 UART Control

Group: uart (capability_nuart > 0 and capability_fisheye = 0)

NAMEVALUESECURITY (get/set)DESCRIPTION
ptzdrivers_i<0~19, 127>_namestring[40]1/4Name of the PTZ driver.
ptzdrivers_i<0~19, 127>_locationstring[128]1/4Full path of the PTZ driver.
enablehttptunnel1/4Enable HTTP tunnel channel to control UART.

Group: uart_i<0\~(n-1)> n is uart port count (capability_nuart > 0 and capability_fisheye = 0)

NAMEVALUESECURITY (get/set)DESCRIPTION
baudrate300,600,1200,2400, 4800,9600,19200,38 400,57600,1152004/4Set baud rate of COM port.
databit5,6,7,84/4Data bits in a character frame.
paritybitnone, odd, even4/4 For error checking.
stopbit1,24/4"1": One stop bit is transmitted to indicate the end of a byte."2": Two stop bits are transmitted to indicate the end of a byte.If you want to transfer the stopbit for 150% of the normal time used to transfer one bit, the uart_i<0~(n-1)>_stopbit should be set as 2 and the uart_i<0~(n-1)>_databit
NAME VALUE SECURITY(get/set)DESCRIPTION
set as 5 as well.
uartmoders485, rs2324/4RS485 or RS232.
customdrvcmd_i<0~9>string[128]1/4PTZ command for custom camera.* only available whencapability_camctrl_c0_rs485=2
speedlink_i<0~4>_namestring[40]1/4Additional PTZ command name.* only available whencapability_camctrl_c0_rs485=2
speedlink_i<0~4>_cmdstring[40]1/4Additional PTZ command list.* only available whencapability_camctrl_c0_rs485=2
ptzdriver0~19, 127 (custom), 128 (no driver)1/4The PTZ driver is used by this COM port.* only available whencapability_camctrl_c0_rs485=2

7.43 UART Control (SD Series)

Group: uart_i<0\~(n-1)> n is uart port count (capability_nuart > 0 and the bit7 of capability_ptzenabled is 0, the bit4 of capability_ptzenabled is 1)

NAMEVALUESECURITY (get/set)DESCRIPTION
cameraidNAME VALUE SECURITY1~2554/4(get/set)Camera ID controlling external PTZ camera.Note:Please set your speed dome to the appropriate baud rate, and Camera ID, e.g. 2400bps, camera ID 1,2,3,,,etc.All Camera IDs on the same controlling system (NVR or rs485 keyboard) have to be distinct.Therefore, once you send a controlling signal, each camera will only accept theDESCRIPTION
inputs with the corresponding ID.
baudrate2400,4800,9600,19200,38400,57600,1152004/4 Set baud rate of COM port.
databit5,6,7,84/4Data bits in a character frame.
paritybitnone,odd,even4/4 For error checking.
stopbit1,24/4"1": One stop bit is transmitted to indicate the end of a byte."2": Two stop bits are transmitted to indicate the end of a byte.If you want to transfer the stopbit for 150% of the normal time used to transfer one bit, theuart_i<0~(n-1)>_stopbit should be set as 2 and theuart_i<0~(n-1)>_databit set as 5 as well.
uartmoders4854/7RS485 mode.

7.44 UART Control (SC Series)

Group: uart_i<0\~(n-1)> n is uart port count (capability_nuart > 0 and capability_ibis = 1)

NAME VALUE SECURITY(get/set)DESCRIPTION
baudrate1200,2400,4800,960 0,19200,384004/4Set baud rate of COM port.
databit5,6,7,84/4Data bits in a character frame.
paritybitnone, odd, even4/4 For errorchecking.
stopbit1,24/4"1": One stop bit is transmitted to indicate the end of a byte."2": Two stop bits are transmitted to indicate the end of a byte.If you want to transfer the stopbit for 150% of the normal time used to transfer one bit, the uart_i<0~(n-1)>_stopbit should be set as 2 and the uart_i<0~(n-1)>_databit set as 5 as well.

7.45 Lens Configuration

Group: lens for n channel products

n denotes the value of "capability_nvideoin"

(capability_image_c<0\~(n-1)>_lensconfiguration_support = 1)

NAMEVALUESECURITY (get/set)DESCRIPTION
selected6/7Current selected lens profile.e.g. lens_selected=lens_default_i0, it means chosen lens configuration is i0 lens of default group.

Group: lens_default

NAME VALUE SECURITY(get/set)DESCRIPTION
totalnumbers0,6/7Totoal support number of the default lens profiles

Group: lens_user

NAMEVALUESECURITY (get/set)DESCRIPTION
totalnumbers 0,integer>6/7 Totoal support number of the user lens profiles

Group: lens_default_i<0\~(n-1)>

n denotes the value of "lens_default_totalnumbers"

NAME VALUE SECURITY(get/set)DESCRIPTION
name6/7Default lens name

Group: lens_user_i<0\~(n-1)>

n denotes the value of "lens_user_totalnumbers"

NAME VALUE SECURITY(get/set)DESCRIPTION
name6/7User-defined lens name

7.46 Fisheye Info.

Group: fisheyeinfo (capability_fisheye > 0)

NAMEVALUESECURITY (get/set)DESCRIPTION
revisedcenteraxis1/7The actual center axis coordinate
radius0,1/7The actual center radius

7.47 Fisheye Local Dewarp Setting

Group: fisheyedewarp_c<0\~(n-1)>(capability_fisheyelocaldewarp_c<0\~(n-1)>>0)

n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream"

NAMEVALUESECURITY (get/set)DESCRIPTION
panspeed-5 ~ 51/4Pan speed of regional view
tiltspeed-5 ~ 51/4Tilt speed of regional view
zoomspeed-5 ~ 51/4Zoom speed of regional
s<0~(m-2)>_panorama_panstart0~3591/4Initial pan position of panorama view. (only available for 1P and 2P mode at ceiling or floor mount)
s<0~(m-2)>_region_pan-90~3591/4Pan home angle of regional view (for 1R mode)Pan range of ceiling/floor mount is [0~359].Pan range of wall mount is [-90~90].
s<0~(m-2)>_region_tilt-90~901/4Tilt home angle of regional view (for 1R mode)Tilt range of ceiling/floor mount is [0~90].Tilt range of wall mount is [-90~90].
NAME VALUE SECURITY(get/set)DESCRIPTION
s<0~(m-2)>_region_zoom100~3001/4Zoom home ratio of regional view (for 1R mode)
s<0~(m-2)>_region_r<0~(i-1)>_pan-90~3591/4Pan home angle of regional view (for 4R mode, i is the view index and range from 0 to 3)Pan range of ceiling/floor mount is [0~359].Pan range of wall mount is [-90~90].
s<0~(m-2)>_region_r<0~(i-1)>_tilt-90~901/4Tilt home angle of regional view (for 4R mode, i is the view index and range from 0 to 3)Tilt range of ceiling/floor mount is [0~90].Tilt range of wall mount is [-90~90].
s<0~(m-2)>_region_r<0~(i-1)>_zoom100~3001/4Zoom home ratio of regional view (for 4R mode, i is the view index and range from 0 to 3)

7.48 PIR Behavior Define

Group: pir (capability_npir > 0)

NAME VALUE SECURITY(get/set)DESCRIPTION
enable1/1Enable/disable PIR

7.49 Auto Tracking Setting

Group: autotrack_c<0\~(n-1)>(capability_image_c<0\~(n-1)>_autotrack_support > 0) n denotes the value of "capability_nvideoin"

PARAMETERVALUESECURITY (get/set)DESCRIPTION
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
objsize_type-1~21/4Type of object size.-1:customized width and height0:object size = 30 x 301:object size = 10 x 202:object size = 10 x 10
objsize_customized_width10~3201/4The minimum width of tracking target.
objsize_customized_height10~2401/4The minimum height of tracking target.
sensitivity0~21/4Tracking sensitivity.0:Low1:Medium2:High

7.50 Wireless

Group: wireless (capability_network_wireless > 0)

PARAMETER VALUE SECURITY(get/set)DESCRIPTION
ssidstring[32]6/6SSID for wireless lan settings.
wlmodeInfra,Adhoc6/6Wireless mode.Infra: Infrastructure
channel 1~11 or1~13 or10~11 or10~13 or1~146/6A list of WLAN channels.Countries apply their own regulations to the allowable channels.1~11: USA and Canada1~13: Europe10~11: Spain10~13: France1~14: Japan* Only valid when "wireless_wlmode" is "Adhoc"
PARAMETER VALUESECURITY(get/set)DESCRIPTION
encryptnone,wep,wpa,wpa26/6Encryption method:none: NONE,wep: WEP,wpa: WPA,wpa2: WPA2PSK
authmodeOPEN, SHARED6/6Authentication mode.* Only valid when "wireless_encrypt" is "wep"
keylength64, 1286/6Key length in bits.* Only valid when "wireless_encrypt" is "wep"
keyformatHEX, ASCII6/6Key1 ~ key4 presentation format.* Only valid when "wireless_encrypt" is "wep"
keyselect1 ~ 46/6Default key number.* Only valid when "wireless_encrypt" is "wep"
key1password [26]6/6WEP key1 for encryption.* Only valid when "wireless_encrypt" is "wep"
key2password [26]6/6WEP key2 for encryption.* Only valid when "wireless_encrypt" is "wep"
key3password [26]6/6WEP key3 for encryption.* Only valid when "wireless_encrypt" is "wep"
key4password [26]6/6WEP key4 for encryption.* Only valid when "wireless_encrypt" is "wep"
algorithmAES, TKIP6/6Algorithm* Only valid when "wireless_encrypt" is "wpa" or "wpa2"
presharedkeypassword [64]6/6WPA/WPA2PSK mode pre-shared key.* Only valid when "wireless_encrypt" is "wpa" or "wpa2"

7.51 Shock Detection

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

n denotes the value of "capability_nvideoin" (capability_shockalarm_support > 0)

PARAMETER VALUE SECURITY(get/set)DESCRIPTION
alarm_enable4/4Enable shock detection's alarm.
alarm_level1~1004/4The value indicate the support strength level of shock detection's alarm.

7.52 Stream Profiles

Group: streamprofile_i<0\~(n-1)> for n profiles product.

n denotes the value of "capability_media_streamprofiles_num"

(capability_media_streamprofiles_support = 1)

PARAMETER VALUE SECURITY(get/set)DESCRIPTION
profilename1/6Friendly name of the profile.
token1/7An unique identifier of the profile.
fixed1/7The value indicates whether the profile can be deleted or not.Ex. fixed=1 indicates the profile cannot be deleted.
occupied1/6Indicates the action of creating profile.Ex. If occupied=1 indicates the current profile is to be created; otherwise, if occupied=0 indicates the current profile is to be deleted.
alwaysmulticast1/6Enable always multicast.
videoconfiguration_enable1/6To enable the selected videoconfiguration source for this profile.
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
videoconfiguration_sourcec<0~(n-1)>s<0~(m-1)>* n denotes the value of "capability_nvideoin, and m denotes the value of "capability_nmediastream"1/6The videoconfiguration source for the profile.Ex. videoconfiguration_source=c<0~(n-1)>s<0~(m-1)> indicates video stream of channel n stream m is selected for the profile.
audioconfiguration_enable1/6To enable the selected audioconfiguration source for this profile.* Only available when capability_naudioin > 0
audioconfiguration_sourcec<0~(n-1)>s0* n denotes the value of "capability_naudioin"1/6The audioconfiguration source for the profile.Ex. audioconfiguration_source=c<0~(n-1)>s0 indicates audio stream of channel n and stream 1 is selected for the profile.* Only available when capability_naudioin > 0
metadataconfiguration_enable1/6To enable the selected metadataconfiguration source for the profile.
metadataconfiguration_sourcec<0~(n-1)>s0* n denotes the value of "capability_nvideoin"1/6The metadataconfiguration source for the profileEx. metadataconfiguration_source=c<0~(n-1)>s0 indicates metadata stream of channel n and stream 1 is selected for the profile.

7.53 Multicast Settings for Metadata Streaming

Group: metadata_c<0\~(n-1)>_s0_multicast (capability_media_streamprofiles_support = 1)

n denotes the value of "capability_nvideoin"

NAME VALUE SECURITY(get/set)DESCRIPTION
ipaddress4/4Multicast metadata IP address.
port1025 ~ 655354/4Multicast metadata port.
ipversionIPv4, IPv64/4The version of internet protocol.
ttl1 ~ 2554/4Multicast metadata time to live value.

Group: cameralink_i<0\~(n-1)>(capability_cameralink_support = 1)

n denotes the value of "capability_cameralink_num"

PARAMETERVALUESECURITY (get/set)DESCRIPTION
namestring[40]6/6Identification of this entry.
ipaddress6/6The ipaddress of the receiving camera.
usernamestring[64]6/6The username of the receiving camera.
passwdstring[64]7/6The password of the receiving camera.
port0~655356/6The connection port to the receiving camera.
do6/6Indicate the source id and trigger time of di trigger.Ex. “0[10]” sets do0 with trigger time of 10 s for the receiving camera.
autotrack_enable6/6Enables autotracking for the receiving camera.
PARAMETER VALUE SECURITY(get/set)DESCRIPTION
autotrack_index0,6/6PTZ preset index with smart tracking advanced of the receiving camera.* Only valid when the camera supports “Smart Tracking Advanced” feature. (Please refer to PTZ Control API for more details)* We support this parameter when the version number (httpversion) is equal or greater than 0317d.
gotopreset_enable6/6Enable the PTZ preset function of the receiving camera.
gotopreset_typemechanical, digital6/6PTZ type of the receiving camera.
gotopreset_index 0,positive integer>6/6PTZ preset index of the receiving camera.
gotopreset_channel 0,positive integer>6/6 PTZ preset channel of the receiving camera.
gotopreset_stream0,6/6 PTZ preset stream of the receiving camera.

7.55 Extension Module IO

Group: Extension (capability_extension_di_num > 0 or capability_extension_do_num > 0)

PARAMETER VALUE SECURITY(get/set)DESCRIPTION
connected6/7Indication if extension module IO is connected.

7.56 Focussystem

Group: focussystem_c<0\~(n-1)>(capability_image_c<0\~(n-1)>_remotefocus>0)

n denotes the value of "capability_nvideooin"

PARAMETER VALUE SECURITY(get/set)DESCRIPTION
autofocus_enablebyzoom7/6To allow the feature of auto focus when zoom is operated.* Only available whencapability_image_c<0~(n-1)>_focussystem_mode=AFbyzoom

7.55.1. Save Day/Night Focus Position

Group: focussystem_c<0\~(n-1)>(capability_image_c<0\~(n-1)>_remotefocus > 0 and capability_image_c<0\~(n-1)>_focussystem_mode=focusshift)

n denotes the value of "capability_nvideoin"

PARAMETERVALUESECURITY (get/set)DESCRIPTION
focusshift_enable6/6To allow the remotefocus system to apply a shifted day or night position indicated in day_position or night_position.
focusshift_day_position6/7A customized IR offset value in lens profile when ICR is switched to day mode.: default IR offset value is used.
focusshift_day_lastdate6/7A recorded UTC time when IR offset value is saved during day mode.: IR offset value hasn't been saved before.
focusshift_night_position6/7A customized IR offset value in lens profile when ICR is switched to night mode.: default IR offset value is used.
focusshift_night_lastdate6/7A recorded UTC time when IR offset value is saved during night mode.: IR offset value hasn't been saved before.

8. Useful Functions

8.1Drive the Digital Output (capability\_ndo > 0)

Note: This request requires Viewer privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/dido/setdo.cgi?do0=<value>[&do1=<value>][&do2=<value>][&do3=<value>] 

Where state is 0 or 1; “0” means inactive or normal state, while “1” means active or triggered state, and trigger time is indicated in seconds.

PARAMETER VALUE DESCRIPTION
dostate[trigger time]Where "state" is 0, 1. "0" means inactive or normal state while "1" means active or triggered state.Where "trigger time" is reset time after state change.Ex: do0=1Setting digital output #1 to trigger state.
Ex: do0=0[30]Setting digital output #1 to normal state, waiting 30 seconds, setting it to trigger state.

Example: Drive the digital output #1 to triggered state, reset do0 after 20 seconds and redirect to an empty page.

http://myserver/cgi-bin/dido/setdo.cgi?do0=1[20] 

8.2 Query Status of the Digital Input (capability\_ndi > 0)

Note: This request requires Viewer privileges

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/dido/getdi.cgi?[di0][&di1][&di2][&di3] 

If no parameter is specified, all of the digital input 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?di0 

Response:

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

8.3 Query Status of the Digital Output (capability\_ndo > 0)

Note: This request requires Viewer privileges

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/dido/getdo.cgi?[do0][&do1][&do2][&do3] 

If no parameter is specified, all the digital output statuses will be returned.

Return:

HTTP/1.0 200 OK\r\n
Content-Type: text/plain\r\n
Content-Length: <length>\r\n
\r\n
[do0=<state>]\r\n 
[do1=<state>]\r\n
[do2=<state>]\r\n
[do3=<state>]\r\n 

where can be 0 or 1.

Example: Query the status of digital output #1.

Request:
http://myserver/cgi-bin/dido/getdo.cgi?do0 
Response:
HTTP/1.0 200 OK\r\n
Content-Type: text/plain\r\n
Content-Length: 7\r\n
\r\n
do0=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 request contains invalid parameters, a full FOV snapshot will return.

PARAMETERVALUE DESCRIPTION
channel0~(capability_nvideoin -1)The channel number of the video source.Default: 0
resolutionAvailable options are list in "capability_videooin_c<0~(n-1)>_resolution".Besides, available options is referred to "capability_videooin_c<0~(n-1)>_maxresolution" and "capability_videooin_c<0~(n-1)>_minresolution"The resolution of the image.Default: Returns snapshot of current resolution by [channel] and [streamid].
quality1~5The quality of the image.
streamid0~(capability_nmediastream -1)The stream number.Default: Returns snapshot of maximum resolution for current channel.

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

Syntax:

http://<servername>/cgi-bin/admin/editaccount.cgi? method=<value>&username=[&userpass=<value>][&privilege=<value>][&return=<return page>] 
PARAMETER VALUE DESCRIPTION
methodaddAdd 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.
deleteRemove an account from the server. When using this method, the “username” field is necessary, and others are ignored.
editModify the account password and privilege. When using this method, the “username” field is necessary, and other fields are optional. If not specified, it will keep the original settings.The name of the user to add, delete, or edit.
username
userpassThe password of the new user to add or that of the old user to modify. The default value is an empty string.
privilegeviewThe privilege of the user to add or to modify.“view”: Viewer privilege.“operator”: Operator privilege.“admin”: Administrator privilege.
operator
admin
returnRedirect to the pageafter the parameter is assigned. Theshould be the relative path according to the root of camera. If you omit this parameter, it will redirect to an empty page.* If theis invalid path, it will ignore this parameter.

Note:
1. Rules of password settings is defined by layout_defaultpassword group.

Example:

Request:
http://myserver/cgi-bin/admin/editaccount.cgi?method=add&username=test&userpass=123&privilege=view

Response of success:

HTTP/1.1 200 OK\r\nContent-Type: text/html\r\nContent-Length: 2\r\n\r\n

Response of failure:

HTTP/1.1 200 OK\r\nContent-Type: text/html\r\nContent-Length: <Error Message Length>\r\n\r\n<Error Message>

List of error message:

ERROR: Add user fail!
ERROR: Delete user fail!
ERROR: Update user's password fail!

ERROR: Update user's privilege fail!

8.6 Upgrade Firmware

Note: This request requires Administrator privileges.

Method: POST

Syntax:

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

Post data:

fimage=<file name>[&return=<return page>]\r\n\r\n<multipart encoded form data> 

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

8.7ePTZ Camera Control (capability\_eptz > 0 and

Capability\_fisheye = 0)

Note: This request requires camctrl privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/camctrl/eCamCtrl.cgi?channel=<value>&stream=<value>
[&move=<value>] - Move home, up, down, left, right
[&auto=<value>] - Auto pan, patrol
[&zoom=<value>] - Zoom in, out
[&zooming=<value>&zs=<value>] - Zoom without stopping, used for joystick
[&x=<value>&y=<value>&w=<value>&h=<value>&resolution=<value>] - Zoom in, out on a specific area
[&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 

In zoom operation, there are two ways to control it, scale zoom and area zoom.

  1. [Scale zoom]: contains two control method, relative movement and continuous movement
    a. relative movement -

If you trigger a relative movement, it will only zoom certain ratio and stop by itself.

http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zoom=tele

http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zoom=wide

The zoom ratio to move by relative movement is according to the setting of speedzoom [-5\~5].

http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&speedzoom=5

b. continuous movement -

If you trigger a continuous movement, you have to handle the stop time by yourself.

A continuous movement is convenient to integrate a joystick control.

http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=tele&zs=1

http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zooming=wide&zs=5

zooming is used to indicate the moving direction, and zs is used to indicate the speed.

To stop a continuous movement, you have to use the command as below:

http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?stream=0&zoom=stop&zs=0

2. [Area zoom]: it means to zoom in on a specific area, here is an example for a directly moving

[x, y] is the desired coordinate, and it will be the center after movement

[w, h] is the scaled area size

[resolution] is the base range of this coordinate system

The example shows [w, h] = [864, 488] , which means to zoom in to ratio x2.2 based on [1920x1080] .

Pay attention to that [x, y, w, h] are essential parameters in an area zoom case, and the stream index is counted from 0 as the first stream.

http://IPAddr/cgi-bin/camctrl/eCamCtrl.cgi?channel=0&stream=0&x=912&y=297&w=864&h=488&resolution=1920x1080

PARAMETER VALUE DESCRIPTION
channel<0~(n-1)>Channel of video source.
stream<0~(m-1)>Stream.
movehomeMove to home ROI.
up Move up.
down Move down.
leftMove left.
rightMove right.
autopanAuto pan.
patrolAuto patrol.
stopStop auto pan/patrol.
zoomwideZoom larger view with current speed.
teleZoom further with current speed.
zoomingwide or teleZoom without stopping for larger view or further view with zs speed, used for joystick control.
zs0 ~ 6Set the speed of zooming, “0” means stop.
xThe desired coordinate, and it will be the center after
ymovement
wThe scaled area size
h
resolutionThe resolution of streaming.
vxThe direction of movement, used for joystick control.
vy
vs0 ~ 7Set the speed of movement, “0” means stop.
xx-coordinate clicked by user.It will be the x-coordinate of center after movement.
yy-coordinate clicked by user.It will be the y-coordinate of center after movement.
videosizeThe size of plug-in (ActiveX)window in web page
resolutionThe resolution of streaming.
stretch0 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 ~ 5Set the pan speed.
speedtilt-5 ~ 5Set the tilt speed.
speedzoom-5 ~ 5Set the zoom speed.
speedapp1 ~ 5Set the auto pan/patrol speed.
returnRedirect to the pageafter the parameter is assigned. Theshould be the relative path according to the root of camera. If you omit this parameter, it will redirect to an empty page.* If theis invalid path, it will ignore this parameter.

8.8ePTZ Recall (capability\_eptz > 0 and capability\_fisheye = 0)

Note: This request requires camctrl privileges.

Method: GET/POST

Syntax:

http:///cgi-bin/camctrl/eRecall.cgi?channel=&stream=&recall=[&return=]
PARAMETER VALUE DESCRIPTION
channel<0~(n-1)>Channel of the video source.
stream<0~(m-1)>Stream.
recallText string less than 40 charactersOne of the present positions to recall.
returnRedirect to the pageafter the parameter is assigned. Theshould be the relative path according to the root of camera. If you omit this parameter, it will redirect to an empty page.* If theis invalid path, it will ignore this parameter.

8.9ePTZ Preset Locations (capability\_eptz > 0 and

capability_fisheye = 0)

Note: This request requires Operator privileges.

Method: GET/POST

Syntax:

http:///cgi-bin/operator/ePreset.cgi?channel=&stream=[&addpos=][&delpos=][&return=]
PARAMETERVALUEDESCRIPTION
channel<0~(n-1)>Channel of the video source.
stream<0~(m-1)>Stream.
PARAMETER VALUE DESCRIPTION
addposAdd one preset location to the preset list.
delposing less than40 characters>Delete preset location from the preset list.
returnRedirect to the pageafter the parameter is assigned. Theshould be the relative path according to the root of camera. If you omit this parameter, it will redirect to an empty page.* If theis invalid path, it will ignore this parameter.

8.10 IP Filtering for ONVIF

Syntax:

http://<servername>/cgi-bin/admin/ipfilter.cgi?type[=<value>]
http://<servername>/cgi-bin/admin/ipfilter.cgi?method=add<v4/v6>&ip=<ipaddress>[&index=<value>][&return=<return page>]
http://<servername>/cgi-bin/admin/ipfilter.cgi?method=del<v4/v6>&index=<value>[&return=<return page> 
PARAMETER VALUE DESCRIPTION
typeNULLGet IP filter type
allow, deny Set IP filter type
methodaddv4Add IPv4 address into access list.
addv6 Add IPv6 address into access list.
delv4Delete IPv4 address from access list.
delv6Delete IPv6 address from access list.
ipSingle address:Network address:Range address:
indexThe start position to add or to delete.

8.11 UART HTTP Tunnel Channel (capability\_nuart > 0)

Note: This request requires Operator privileges.

Method: GET and POST

Syntax:

http://<servername>/cgi-bin/operator/uartchannel.cgi?[channel=<value>]

GET /cgi-bin/operator/uartchannel.cgi?[channel=<value>]

x-sessioncookie: string[22]

accept: application/x-vvtk-tunnelled

pragma: no-cache

cache-control: no-cache

POST /cgi-bin/operator/uartchannel.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 a proxy server.

This channel will help to transfer the raw data of UART over the network.

Please see UART tunnel spec for detail information

PARAMETER VALUE DESCRIPTION
channel0 ~ (n-1)The channel number of UART.

8.12 Event/Control HTTP Tunnel Channel

(capability\_evctrlchannel > 0)

Note: This request requires Administrator privileges.

Method: GET and POST

Syntax:

http://<servername>/cgi-bin/admin/ctrlevent.cgi
----
GET /cgi-bin/admin/ctrlevent.cgi
x-sessioncookie: string[22]
accept: application/x-vvtk-tunnelled
pragma: no-cache
cache-control: no-cache

----
POST /cgi-bin/admin/ ctrlevent.cgi
x-sessioncookie: string[22]
content-type: application/x-vvtk-tunnelled
pragma : no-cache
cache-control : no-cache
content-length: 32767
expires: Sun, 9 Jam 1972 00:00:00 GMT 

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

This channel will help perform real-time event subscription and notification as well as camera control more 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/POST

Syntax:

http://<servername>/<network_rtsp_s<0~(n*m)-1>_accessname> 

n denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream".

Example:

For m=2, the values are shown as network_rtsp_s0_accessname = live1s1.sdp network_rtsp_s1_accessname = live1s2.sdp network_rtsp_s2_accessname = live2s1.sdp network_rtsp_s3_accessname = live2s2.sdp etc. 

* For version number(httpversion) above 0311c, the default RTSP access name format is "lives.sdp". 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.

Note:

* We recommend to use new format to access streaming when capability_media_streamprofiles_support=1, please refer to Methods for Accessing Streaming

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 theURL below into an RTSP compatible player.

rtsp://<servername>/<network_rtsp_s<0~m-1>_accessname> 

“m” is the stream number.

For details on streaming protocol, please refer to the “control signaling” and “data format” documents.

8.15 Send Data (capability\_nuart > 0)

Note: This request requires Viewer privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/viewer/senddata.cgi?  
[com=<value>][&data=<value>][&flush=<value>] [&wait=<value>] [&read=<value>] 
PARAMETER VALUE DESCRIPTION
com1 ~The target COM/RS485 port number.
data[,]Theis a series of digits from 0 ~ 9, A ~ F. Each comma separates the commands by 200 milliseconds.
flushyes,noyes:Receive data buffer of the COM port will be cleared before read.no: Do not clear the receive data buffer.
wait1 ~ 65535Wait time in milliseconds before read data.
read1 ~ 128The data length in bytes to read. The read data will be in the return page.

Return:

HTTP/1.0 200 OK\r\n
Content-Type: text/plain\r\n
Content-Length: <system information length>\r\n\r\n
<hex decimal data>\r\n 

Where hexadecimal data is digits from 0 \~ 9, A \~ F.

8.16 Storage Managements (capability\_storage\_dbenabled > 0)

Method: GET and POST

Note: This request requires administrator privileges.

In the past time, all the recorded files could be searched/updated/deleted independently. However, this implementation provides no abstraction of recorded video clips, and which is not easy to use.

Thus edge storage API try to provide a higher abstraction of these video clips.

Ability to change database content from lsctrl.cgi was removed, lsctrl.cgi is changed to read-only.

PLEASE REFER TO EDGE STORAGE API

Syntax:

http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=<cmd_type>[&<parameter>=<value>...] 

The commands usage and their input arguments are as follows.

PARAMETERVALUEDESCRIPTION
cmd_typeRequired.Command to be executed, including search and queryStatus.

Command: search

PARAMETERVALUEDESCRIPTION
labelOptional.The integer primary key column will automatically be assigned a unique integer.
triggerTypeOptional.Indicate the event trigger type.Please embrace your input value with single quotes.Ex. triggerType='vi'
mediaTypeOptional.Indicate the file media type.Ex. mediaType=videoclip* logical "OR" is not supported for this parameter.
destPathOptional.Indicate the file location in camera.Please embrace your input value with single quotes.Ex. destPath='/mnt/auto/CF/NCMF/abc.mp4'
resolutionOptional.Indicate the media file resolution.Please embrace your input value with single quotes.Ex. resolution='800x600'
isLockedOptional.Indicate if the file is locked or not.0: file is not locked.1: file is locked.
PARAMETER VALUEDESCRIPTION
A locked file would not be removed from UI or cyclic storage.
triggerTimeOptional.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.
limitOptional.Limit the maximum number of returned search records.
offsetOptional.Specifies how many rows to skip at the beginning of the matched records.Note that the offset keyword is used after limit keyword.

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

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

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

Command: queryStatus

PARAMETER VALUEDESCRIPTION
retTypexml or javascriptOptional.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 

Syntax:

http://<servername>/cgi-bin/admin/downloadMedias.cgi?type=<type>[&<parameter><value>...] 
PARAMETERVALUEDESCRIPTION
typeRequiredcommand to be excuted includevideoclip
devicecommand to be excuted includesd,nas
recordingtokenPlease refer to Edge Storage API
starttimeOptional.Format is “YYYY-MM-DD HH:MM:SS”Please embrace your input value with single quotes.Example:starttime=2008-01-01 00:00:00Notice: you should use UTC time
endtimeOptional.Format is “YYYY-MM-DD HH:MM:SS”Please embrace your input value with single quotes.Example:starttime = 2008-01-01 00:00:00Notice: you should use UTC time

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 VALUEDESCRIPTION
resolutionResolution
fpsFrame rate
listThe 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.17 Virtual Input (capability\_nvi > 0)

Note: Change virtual input (manual trigger) status.

Method: GET

Syntax:

http://<servername>/cgi-bin/admin/setvi.cgi?vi0=<value>[&vi1=<value>][&vi2=<value>]
[&return=<return page>] 
PARAMETERVALUEDESCRIPTION
vistate[(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.
returnRedirect to the pageafter the parameter is assigned. Theshould be the relative path according to the root of camera. If you omit this parameter, it will redirect to an empty page.* If theis invalid path, it will ignore this parameter.
Return CodeDescription
200The request is successfully executed.
400The request cannot be assigned, ex. incorrect parameters.Examples:setvi.cgi?vi0=0(10000)1(15000)0(20000)1No multiple duration.setvi.cgi?vi3=0VI index is out of range.setvi.cgi?vi=1No VI index is specified.
503The resource is unavailable, ex. Virtual input is waiting for next state.Examples:setvi.cgi?vi0=0(15000)1setvi.cgi?vi0=1Request 2 will not be accepted during the execution time(15 seconds).

8.18 Open Timeshift Stream (capability\_timeshift > 0,

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>&reft ime=<value>&forcechk&minsft=<value>] 

For RTSP (MP4 and H264), the user needs to input theURL below into an RTSP compatible player.

rtsp://<servername>/<network_rtsp_s<m>_accessname>?maxsft=<value>[&tsmode=<value>&reftime=<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.

PARAMETERVALUEDEFAULTDESCRIPTION
maxsft0Request cached stream at most how many seconds ago.The value must be a positive integer. (>0)
tsmode normal,adaptivenormal 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.)tsmodemust exactly match well-defined wording (normal, adaptive), unknown parameters are always ignored.
reftimemm:ssThe time camera receives the request.Reference time for maxsft and minsft.(This provides more precise time control to eliminate the inaccuracy due to network latency.)Ex: Request the streaming from 12:20rtsp://10.0.0.1/live.sdp?maxsft=10&reftime=12:30
forcechkN/AN/ACheck if the requested stream enables timeshift, feature and if minsft is achievable.If false, return “415 Unsupported Media Type”.
minsft0How many seconds of cached stream client can accept at least.(Used by forcechk)The value must be a positive integer. (>0)
Return CodeDescription
400 Bad RequestRequest is rejected because some parameter values are illegal.
415 Unsupported Media TypeReturned, if forcechk appears,when minsft is not achievable or the timeshift feature of the target stream is not enabled.

8.19 RemoteFocus

(capability\_image\_c<0\~(n-1)>\_remotefocus=1)

Note: This request requires Administrator privileges.

Method: GET/POST

Syntax: (for control API)

http://
/cgi-bin/admin/remotefocus.cgi?channel=&[function=]([\&direction=<value>][&position=<value>][&steps=<value>][&iris]
PARAMETERVALUEDESCRIPTION
channel0~"capability_nvideoin"-1Channel of the video source.
functionzoom, focus, auto, scan, stop, positioning, irisopen, irisenablezoom- Move focus motor focus-Move focus motor auto-Perform auto focus scan-Perform focus scan stop-Stop current operation positioning-Position the motors irisopen-Fully open iris. It will maintain fully open iris status until sending function=irisenable cgi. irisenable-return back to user setting status of iris.
directiondirect, forward, backwardMotor's moving direction. It works only if function=zoom or function=focus.
position~Motor's position. It works only if function=zoom or function= focus and direction=direct. : remote_focus zoom motor start or remote focus focus motor start, : remote focus zoom motor end or remote focus focus motor end replied from "function=getstatus"
PARAMETERVALUE DESCRIPTION
steps1 ~ 30Motor's moving steps.It works only if function=zoom or function=focus and direction=forward and direction=backward.* Motor will stop when it reaches toor.* This parameter is for additional fine-tune, the value is from 1 to 30.
iris N/A Open iris or not.It works only if function=auto or function=scan.

Syntax: (for query API)

http:///cgi-bin/admin/remotefocus.cgi?channel=&[function=]

functiongetstatusInformation of motors, return value as below:remote_focus_zoom_motor_max: Maximum steps of zoom motorremote_focus_focus_motor_max: Maximum steps of focus motorremote_focus_zoom_motor_start: Start point of zoom motorremote_focus_zoom_motor_end: End point of zoom motorremote_focus_focus_motor_start: Start point of effective focal lengthremote_focus_focus_motor_end: End point of effective focal lengthremote_focus_zoom_motor: Current position of zoom motorremote_focus_focus_motor: Current position of focus motorremote_focus_zoom_enable: Current function of zoom motorremote_focus_focus_enable: Current function of focus motorremote_focus_iris_open: The current status of iris. 0: irisenable,1: irisopenCurrent function of zoom/focus motor, return value as below:0: no service1: zooming2. focusing3: auto focus4: focus scan5: positioning (both zoom motor and focus motor)12: reset focus

8.20 BackFocus (capability\_image\_c<0\~(n-1)>\_remotefocus=4)

Note: This request requires Administrator privileges.

Method: GET/POST

Syntax: (for control API)

http://<servername>/cgi-bin/admin/remotefocus.cgi?channel=<value>&[function=<value>][&direct ion=<value>][&position=<value>][&steps=<value>][&iris] 
PARAMETER VALUE DESCRIPTION
channel0~"capability_nvideoin"-1Channel of the video source.
functionfocus,auto,scan,stop,positioning,irisopen,irisenable,resetfocusfocus- Move focus motorauto- Perform auto focusscan- Perform focus scanstop- Stop current operationpositioning- Position the motorsresetfocus- reset focus position to defaultirisopen-Fully open iris. It will maintain fully open iris status until sending function=irisenable cgi.irisenable-return back to user setting status of iris.
direction direct,forward,backwardMotor's moving direction.It works only if function= focus.
position~Motor's position.It works only if function= focus and direction= direct.: remote_focus zoom motor start or remote focus focus motor start,: remote focus zoom motor end or remote focus focus motor end replied from "function=getstatus"
steps1 ~ 30Motor's moving steps.It works only if function= focus and direction= forward or direction= backward.* Motor will stop when it reaches toor.* This parameter is for additional fine-tune, the value is from 1 to 30.
irisN/AOpen iris or not.It works only if function= auto or function= scan.

Syntax: (for query API)

http:///cgi-bin/admin/remotefocus.cgi?channel=&[function=]

function getstatusInformation of motors, return value as below:remote_focus_focus_motor_max: Maximum steps of focus motorremote_focus_focus_motor_start: Start point of effective focal lengthremote_focus_focus_motor_end: End point of effective focal lengthremote_focus_focus_motor: Current position of focus motorremote_focus_focus_enable: Current function of focus motorremote_focus_iris_open: The current status of iris. 0: irisenable, 1: irisopenCurrent function of zoom/focus motor, return value as below:0: no service1: zooming2. focusing3: auto focus4: focus scan5: positioning (both zoom motor and focus motor)12: reset focus

8.21 Export Files

Note: This request requires Administrator privileges.

Method: GET

Syntax:

For daylight saving time configuration file:

* This CGI is not supported when the version number (httpversion) is equal or greater than 0314b, please use "system_tz" as a replacement.

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

For language file:

http:///cgi-bin/admin/export_language.cgi?currentlanguage=

PARAMETERVALUEDESCRIPTION
currentlanguage0~20Available 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.22 Upload Files

Note: This request requires Administrator privileges.

Method: POST

Syntax:

For daylight saving time configuration file:

* This CGI is not supported when the version number (httpversion) is equal or greater than 0314b, please use "system_tz" as a replacement.

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.23 Update Lens Configuration

(capability_image_c<0\~(n-1)>_lensconfiguration_support > 0)

Note: This request requires Administrator privileges.

Method: GET

Syntax:

For list a name of lens currently used:

http://<servername>/cgi-bin/admin/update_lens.cgi?get_currentlens 

For list all names of lens installed in camera:

http://<servername>/cgi-bin/admin/update_lens.cgi?list_lens 

For choose selected lens configuration:

http://<servername>/cgi-bin/admin/update_lens.cgi?choose_lens=<value> 

You need to reboot manually after you choose another lens configuration.

For choose selected lens configuration and reboot camera:

http://<servername>/cgi-bin/admin/update_lens.cgi?choose_reboot_lens=<value> 

The camera will reboot after using this cgi.

For delete selected lens configuration:

http://<servername>/cgi-bin/admin/update_lens.cgi?delete_lens=<value> 
PARAMETER VALUE DESCRIPTION
valueAvailable lens name.Please refer to: lens_default_i<0~(n-1)>_name lens_user_i<0~(n-1)>_namen is a positive integer.

Method: POST

Syntax:

For upload user-defined lens configuration:

http://<servername>/cgi-bin/admin/update_lens.cgi?upload_lens 

Post data:

upload_lens_profile_input = <file name>\r\n\r\n<multipart encoded form data> 

Server will accept the file named to upload the lens profile to camera.

8.24 Media on Demand (capability\_localstorage.modnum > 0)

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>] 
PARAMETERVALUEDEFAULTDESCRIPTION
stimeN/AStart time.
etimeMMDD_HHMMSS.MMM>N/A End time.
lengthN/AThe length of media of interest.The unit is second.
loctime0Specify if start/end time is local time format.1 for local time, 0 for UTC+0
fileN/AThe media file to be played.
tsmodeN/ATimeshift mode, the unit is second.

Ex.

stimeetimelengthfileDescription
VVXXPlay recordings between stime and etimersp://10.10.1.2/mod.sdp?stime=20110312_040400.000&etime=2011_0312_040510.000
VXVXPlay recordings for length seconds which start from stimersp://10.10.1.2/mod.sdp?stime=20110312_040400.000&length=120
XVVXPlay recordings for length seconds which ends at etimertsp://10.10.1.2/mod.sdp?etime=20110312_040400.000&length=120
XXXVPlay file filertsp://10.10.1.2/mod.sdp?filename=/mnt/link0/

8.25 3D Privacy Mask

(Capability\_image\_c<0\~(n-1)>\_privacymask\_wintype = 3Drectangle)

n denotes the value of "capability_nvideooin"

Note: This request requires admin user privilege

Method: GET/POST

Syntax:

http:///cgi-bin/admin/setpm3d.cgi?method=&maskname=&[maskheight=&maskwidth=&videosize=&return=]

PARAMETER VALUE DESCRIPTION
methodaddAdd a 3D privacy mask at current location
delete Delete a 3D privacy mask
edit Edit a 3D privacy mask
masknamestring[40]3D privacy mask name
maskheightinteger3D privacy mask height
maskwidth integer 3D privacy mask width
videosizeOptimal.The size of plug-in (ActiveX) window in web page is the size of the privacy window size. This field is not necessary, it will use the default value if not specified.320x180 for 16:9 resolution and 320x240 for 4:3 resolution.
returnRedirect to the pageafter the parameter is assigned. Theshould be the relative path according to the root of camera. If you omit this parameter, it will redirect to an empty page.* If theis invalid path, it will ignore this parameter.

8.26 Camera Control

(capability\_camctrl\_c<0\~(n-1)>\_zoommodule = 1)

Note: This request requires Viewer privileges.

Method: GET/POST

Syntax: (for control API)

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

Example:

http://myserver/cgi-bin/camctrl/camctrl.cgi?channel=0&camid=1&move=right
http://myserver/cgi-bin/camctrl/camctrl.cgi?channel=0&camid=1&zoom=tele
http://myserver/cgi-bin/camctrl/camctrl.cgi?channel=0&camid=1&x=300&y=200&resolution=704x480&videosize=704x480&streach=1 

Example: (set the ptz preset with focus mode)

* We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20.

http://myserver/cgi-bin/camctrl/camctrl.cgi?name=xxx&focussetting=sync&cam=getsetpreset 
PARAMETER VALUE DESCRIPTION
channel<0~(n-1)>Channel of video source.
camid0,Camera ID.
movehomeMove to camera to home position.
upMove camera up.
downMove camera down.
left Move camera left.
right Move camera right.
speedpan-5 ~ 5Set the pan speed.
speedtilt -5 ~ 5 Set the tilt speed.
speedzoom-5 ~ 5Set the zoom speed.
speedfocus-5 ~ 5Set the focus speed.
speedapp-5 ~ 5Set the auto pan/patrol speed.
auto pan Auto pan.
zoomwideZoom larger view with current speed.
tele Zoom further with current speed.
stopStop zoom.
zoomingwide or teleZoom without stopping for larger view or further view with zs speed, used for joystick control.
zs0 ~ 8Set the speed of zooming, “0” means stop.
vxThe slope of movement = vy/vx, used for joystick control.
vy
vs0 ~ 127Set the speed of movement, “0” means stop.
xx-coordinate clicked by user.It will be the x-coordinate of center after movement.
yy-coordinate clicked by user.It will be the y-coordinate of center after movement.
videosizeThe size of plug-in (ActiveX) window in web page
resolutionThe resolution of streaming.
stretchfocusauto0 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.Auto focus.
farFocus on further distance.
nearFocus on closer distance.
focussetingsyncApplies the selected focus mode in camctrl_c<0~(n-1)>_focusmode to this preset.
fixcurrentApplies the current focus position to this preset.
* We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20.
camgetsetpresetAdds a named preset at current position, and return the preset index.* We support this function when the version number of the PTZ control module is equal or greater than 5.0.0.20.

Syntax: (for query API)

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

Example:

http://myserver/cgi-bin/camctrl/camctrl.cgi?getpan 

Response:

HTTP/1.0 200 OK\r\n 
Cache-control: no-cache\r\n 
Pragma: no-cache\r\n 
\r\n 
pan=4117\r\n 
PARAMETERVALUEDESCRIPTION
getversionGet the version of the PTZ control module.
getactionidle,autopan,tracking,tour,patrol,Get the current status of the camera.* We support this parameter when the version number (getversion) is equal or greater than 5.0.0.12
getpan0,Get the current pan position.*Only available when bit0 of "capability_camctrl_c<0~(n-1)>_buildinpt" is "1"
PARAMETER VALUE DESCRIPTION
getpanangleGet the current pan angle.*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"
gettilt0,Get the current tilt position.*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"
gettiltangleGet the current tilt angle.*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"
getzoom0,Get the current zoom position.
getratioGet the current zoom ratio.
getfocus0,Get the current focus position.
getminspeedlv0,Get the minimum speed level of the PTZ control. Normally,the speed level is '0,' which denotes halting a continuousmovement.
getmaxptspeedlv0,Get the maximum speed level of pan/tilt moving.*Only available when"capability_camctrl_c<0~(n-1)>_buildinpt" >0
getmaxzspeedlv0,Get the maximum speed level of zoom moving.
getmaxfspeedlv0,Get the maximum speed level of focus moving.
getminpan0,Get the lower limit for pan position.*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"
getmaxpan0,Get the upper limit for pan position.*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"
getminpanangleGet the lower limit for pan angle.*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"
getmaxpanangleGet the upper limit for pan angle.*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"
getmintilt0,Get the lower limit for tilt position.*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"
getmaxtilt0,Get the upper limit for tilt position.*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"
getmintiltangleGet the lower limit for tilt angle.*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"
getmaxtiltangleGet the upper limit for tilt angle.*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"
getminzoom0,Get the lower limit for zoom position.
getmaxzoom0,Get the upper limit for zoom position.
getmaxdzoom0,Get the upper limit for digital zoom position.
getmaxratioGet the maximum ratio of optical zoom.* We support this parameter when the version number (getversion) is equal or greater than 5.0.0.14
getmaxdratioGet the maximum ratio of digital zoom.* We support this parameter when the version number (getversion) is equal or greater than 5.0.0.14
getminfocus0,Get the lower limit for focus position.
getmaxfocus0,Get the upper limit for focus position.

8.27 Recall (capability\_camctrl\_c<0\~(n-1)>\_zoommodule = 1)

Note: This request requires Viewer privileges.

Method: GET

Syntax:

http://<servername>/cgi-bin/viewer/recall.cgi?recall=<value>[&channel=<value>][&return=<return page>] 
PARAMETERVALUEDESCRIPTION
recallstring[30]One of the present positions to recall.
channel0~"capability_nvideoin"-1Channel of the video source.

8.28 Preset Locations

(capability\_camctrl\_c<0\~(n-1)>\_zoommodule = 1)

Note: This request requires Operator privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/operator/preset.cgi?[channel=<value>][&addpos=<value>][&delpos=<value>][&return=<return page>]
PARAMETER VALUE DESCRIPTION
addposstring[30]Add one preset location to the preset list.
channel0~"capability_nvideoin"-1Channel of the video source.
delposstring[30]Delete preset location from preset list.
returnpage>Redirect to the pageafter the parameter is assigned. Theshould be the relative path according to the root of camera. If you omit this parameter, it will redirect to an empty page.* If theis invalid path, it will ignore this parameter.

8.29 SmartSD (capability\_localstorage\_smartsd > 0)

Note: This request requires Administrator privileges.

Method: GET/POST

Syntax:

http:///cgi-bin/admin/smartsd.cgi?function=

PARAMETER VALUE DESCRIPTION
functiongetstatusFunction typegetstauts : Information of smartSD internal status return value as below:smartsd_lifetime_num:Accumulated amount of data that has been writtensmartsd_lifetime_den:Card-guaranteed amount of data that can be writtensmartsd_lifetime_rate:The ratio of smartsd_lifetime_num tosmartsd_lifetime_den.It means the accumulated percentage amount of flash block has been written. The range is from 0 to 100 (unit: %).The SD card is recommended to be replaced if the percentage reaches above 90%.smartsd_spare_block_rate:Usage rate of spare blocks.It means the usage percentage of total spare block. The range is from 0 to 100 (unit: %). The SD card is recommended to be replaced if the percentage reaches above 90%.smartsd_data_size_per_unit:Size (in sectors) of data to be written when LifeInformation1 is updated.smartsd_num_of_sudden_power_failure:Indicates how many times power disconnection occurred during write/erase operationssmartsd_operation_mode:Enables/disables power-off detection and write error notificationsmartsd_attached:Indicate the smartSD is attached or not.

8.30 Connect to AP (capability\_network\_wireless > 0)

Note: This request requires Administrator privileges.

Method: GET/POST

Syntax:

http://
/cgi-bin/admin/connect_ap.cgi
PARAMETER VALUE DESCRIPTION
N/AN/AApply the wireless settings and connect to AP.

8.31 Get Wireless Information (capability\_network\_wireless > 0)

Note: This request requires Administrator privileges.

Method: GET/POST

Syntax:

http://
/cgi-bin/admin/getwirelessinfo.cgi
PARAMETERVALUEDESCRIPTION
N/AN/AGet wireless information. Camera will return following information.1. Wireless channel2. Link quality3. Signal level4. Noise level5. SNR6. TX Rate7. RX Rate

8.32 Get Wireless Signal Strength (capability\_network\_wireless

0)

Note: This request requires Administrator privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/admin/getwlsignalstrength.cgi
METER VALUE DESCRIPTION
N/AN/AGet wireless signal strength.

8.33 WPS Transaction (capability\_network\_wireless > 0)

Note: This request requires Administrator privileges.

Method: GET/POST

Syntax:

http://<servername>/cgi-bin/admin/start_wps.cgi
PARAMETERVALUEDESCRIPTION
N/AN/AStart WPS transaction.

8.34 Peripheral Control (capability\_peripheral\_c<0\~(n-1)>.

devicecontrol > 0)

Note: This request requires Administrator privileges.

Method: GET/POST

Syntax: (for control API)

http://<servername>/cgi-bin/admin/peripheral.cgi?channel=&operation=set[&washer_mode=<value>] - Set washer mode[&washer_status=<value>] - Set washer status[&washer_dwelltime=<value>] - Set washer clean time[&heater_status=<value>] - Set heater status

Example:

http://myserver/cgi-bin/admin/peripheral.cgi?channel=0&operation=set&washer_mode=wiper&washer_status=on

Response:

HTTP/1.0 200 OK\r\n

Cache-control: no-cache\r\n

Pragma: no-cache\r\n

\r\n

PARAMETER VALUE DESCRIPTION
channel0~"capability_nvideoin"-1Channel of the video source.
washer_modewiperApply the wiper to the mode of washer control system.
washerApply the washer to the mode of washer control system.
washer_statusonEnable the functionality of washer control system.
offDisable the functionality of washer control system.
washer_dwelltime15~999Apply washer washer control system operation time (including the time when spraying and wiper actions take place).
heater_statusautoautomatic control the heater component to keep the device in a workable environment.
triggerheater component is work in force heater once.

Syntax: (for query API)

http:///cgi-bin/admin/peripheral.cgi?channel=&operation=get

[&supportdevice] – Get support peripheral device

[&washer_supportmode] – Get washer support modes

[&washer_mode] – Get washer mode

[&washer_status] – Get washer status

[&washer_dwelltime] – Get washer clean time

[&heater_supportstatus] – Get heater support control status
[&heater_status] – Get heater status 

Example:

http://myserver/cgi-bin/admin/peripheral.cgi?channel=0&operation=get&supportdevice&washer_status
Response:
HTTP/1.0 200 OK\r\n
Cache-control: no-cache\r\n
Pragma: no-cache\r\n
\r\n
supportdevice=washer,heater\r\n
washer_status=off\r\n 
PARAMETER VALUE DESCRIPTION
channel0~"capability_nvideoin"-1Channel of the video source.
supportdeviceN/AGet support peripheral device.
washer_supportmodeN/AGet the support mode of washer control system.
washer_mode N/AGet the current mode of washer control system.It return the value of "washer_mode"
washer_statusN/AGet the current status of washer control module.The status is 'off' as default, which means the washer is stopped; and the status 'on' means the washer is running.
washer_dwelltimeN/AGet the current washer clean period of washer control system.
heater_supportstatusN/AGet the support status of heater control system.
heater_status N/AGet the current heater status.Normally it will be 'auto', it means the heater device is control by internal algorithm to keep in a suitable environment; Otherwise is 'trigger', it means the heater device is force enable to heat to an internal condition.‘trigger’ status will be transfer to 'auto' after reach the internal condition.

8.35 Optimized IR control

(capability\_daynight\_c<0\~(n-1)>\_optimizedir > 0)

Note: This request requires Administrator privileges.

Method: GET/POST

Syntax:

http:///cgi-bin/admin/optimizedir.cgi?function=[&channel=]
PARAMETERVALUEDESCRIPTION
channel0~"capability_nvideoin"-1Channel of the video source.
functiongetstatus, onetimeauto"onetimeauto": Camera will automatically adjust the IR zone one time only."getstatus": Information of optimized IR control status and return value as below:optimizedir_c<0~(n-1)>_irmode:Indicate the IR current mode, available value is "auto" and "manual" mode.optimizedir_c<0~(n-1)>_irnum:The number of IR that camera supports.optimizedir_c<0~(n-1)>_irstrength:Only available when irmode is set as manual. It's a set of integers, which indicate the strength of each IR LED (e.g. 23,45,100,100).optimizedir_c<0~(n-1)>_irstatus:Current IR status, normal / adjusting:"normal": the IR LED strength has been fixed."adjusting": the IR LED strength is adjusting.optimizedir_c<0~(n-1)>_supportmode:"auto": automatically adjust the IR control."manual": manual adjustment.

Example:

http://myserver/cgi-bin/admin/optimizedir.cgi?function=getstatus

Response:

HTTP/1.0 200 OK\r\n

Cache-control: no-cache\r\n

Pragma: no-cache\r\n

\r\n

"optimizedir_c0_irmode='auto'"

"optimizedir_c0_irnum='5'"

"optimizedir_c0_irstrength='1,97,100,100,100'"

"optimizedir_c0_irstatus='normal'"

Syntax: (for control API)

http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=&operation=&irmode=manual[&strength=] - Set IR strength
PARAMETERVALUEDESCRIPTION
channel0~"capability_nvideoin"-1Channel of the video source.
operationset, settoall"set": set the strength of each IR LED separately "settoall": use fixed strength for all IR LED
irmodeauto, manualIrmode needs to be set as manual for adjusting IR LED strength.
strength1~100If the operation is set as "set", the number of strength values need to be the same as it of irnum. However, it needs only one value for strength when the operation is set as "settoall".

Example:

http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&irmode=manual&strength=50,70,50,50,50

Response:

HTTP/1.0 200 OK\r\n

Cache-control: no-cache\r\n

Pragma: no-cache\r\n

\r\n

"optimizedir_c0_irstrength='50,70,50,50,50'"

"optimizedir_c0_irmode='manual'"

Example:

http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=settoall&irmode=manual&strength=100 

Response:

HTTP/1.0 200 OK\r\n 
Cache-control: no-cache\r\n 
Pragma: no-cache\r\n 
\r\n 
"optimizedir_c0_irstrength='100,100,100,100,100'" 
"optimizedir_c0_irmode='manual'"

Example:

http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&irmode=auto&strength=50,70,50,50,50 

Response:

HTTP/1.0 200 OK\r\n 
Cache-control: no-cache\r\n 
Pragma: no-cache\r\n 
\r\n 
ERROR: Parameter "irmode" must be set as "manual"! 

Example:

http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=set&strength=50,70,50,50,50 

Response:

HTTP/1.0 200 OK\r\n 
Cache-control: no-cache\r\n 
Pragma: no-cache\r\n 
\r\n 
ERROR: Must have the "irmode=manual" argument! 

Syntax: (for query API)

http://<servername>/cgi-bin/admin/optimizedir.cgi?channel=<value>&operation=get
[&support_irmode] – list all adjustment mode that IR supports
[&irmode] – Get current IR mode
[&irnum] – Get the number of IR zone 
PARAMETERVALUEDESCRIPTION
channel0~"capability_nvideoin"-1Channel of the video source.
support_irmodeN/AList all adjustment mode that IR supports
irmodeN/AGet the current IR control mode.
irnumN/AGet the number of IR that camera supports.

Example:

http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=get&irmode 

Response:

HTTP/1.0 200 OK\r\n 
Cache-control: no-cache\r\n 
Pragma: no-cache\r\n 
\r\n 
"optimizedir_c0_irmode='auto'" 

8.36 Lens Thermal Control

(capabiltiy_image_c<0\~(n-1)>_sensortype=thermalsensor)

Note: This request requires Administrator privileges.

Method: GET/POST

Syntax: (for control API)

http://<servername>/cgi-bin/admin/thermalctrl.cgi?operation=set 
&action=<value> 

Example:

http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate 

Response:

HTTP/1.0 200 OK\r\n 
Cache-control: no-cache\r\n 
Pragma: no-cache\r\n 

\r\n

OK

Example:

http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate 

Response:

HTTP/1.0 200 OK\r\n 
Cache-control: no-cache\r\n 
Pragma: no-cache\r\n 

\r\n

ERROR: time out 

Example:

http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate 

Response:

HTTP/1.0 200 OK\r\n 
Cache-control: no-cache\r\n 
Pragma: no-cache\r\n 

\r\n

ERROR: fail 
PARAMETERVALUEDESCRIPTION
actionshuttercompensateCamera will do shutter compensate.

Syntax: (for query API)

http://<servername>/cgi-bin/admin/thermalctrl.cgi?operation=get&version=<value> 
PARAMETER VALUE DESCRIPTION
version N/AIndicate lensctrl thermal version

Example:

http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=get&version 
Response:
HTTP/1.0 200 OK\r\n
Cache-control: no-cache\r\n
Pragma: no-cache\r\n
\r\n
version=1120B15 

8.37 Audio Clip Control (capability\_audio\_audioclip=1)

Note: This request requires Administrator privileges.

Method: GET/POST

Syntax: (for control API)

http://<servername>/cgi-bin/admin/audioclip.cgi?operation=<value>[&name=<value>][&index=<value>] 
PARAMETERVALUEDESCRIPTION
operationstartrecording, stoprecording, play, stopplayback, remove, download"startrecording" = Record a new audio clip."stoprecording" = Stop an ongoing recording."play" = Play an audio clip."stopplayback" = Stop to playback of an audio clip."remove" = Delete a clip."download" = Download a clip to the client.* Recording time is limited to 60 seconds.
nameName of the audio clip.The audio clip the action applies to. We support two interfaces (name or index) to specify the media clip to be played.
index0, 1Number of the audio clip.The audio clip the action applies to. We support two interfaces (name or index) to specify the media clip to be played.

Syntax: (for control API)

Add a new audio clip by uploading a file:

* File size is limited to 10MB.

* Support .wav format only

http://cgi-bin/admin/upload_audioclip.cgi[&clipname=][&clipindex=]
PARAMETERVALUEDESCRIPTION
clipnameName of the audio clip.
clipindex 0, 1 Number ofthe audio clip.

8.38 Format SD card

Note: This request requires Administrator privileges.

Method: GET/POST

Syntax: (for control API)

http://<servername>/cgi-bin/admin/format_sdcard.cgi?operation=set[&<parameter>=<value>] 

If the user requests a size larger than all stream settings on the server, this request will fail.

If the user requests include an invalid parameter value, we will use the default value.

PARAMETERVALUEDESCRIPTION
operationSetSet formatting parameters and start formatting
fstypefat32, ext4fat32: High compatibility for PC, but low stability for Dataext4: Low compatibility for PC, but high stability for Data.
fullformat0, 11: Completely clean data (fat32 support only)
blockingmodeblockingblocking: Send an HTTP response at the end of the format.nonblocking: Send an HTTP response at the start of the format
index0~Nwhich one SD card

Example:

Request of format SD card:

http://myserver/cgi-bin/admin/format_sdcard.cgi?operation=set&fstype=ext4 

Response of success:

HTTP/1.1 200 OK\r\n

Content-Type: text/plain\r\n

Content-Length: 2\r\n

\r\n

ok

Response of formatting fail:

HTTP/1.1 200 OK\r\n

Content-Type: text/plain\r\n

Content-Length: \r\n

\r\n

Syntax: (for query API)

http://<servername>/cgi-bin/admin/ format_sdcard.cgi?operation=get
PARAMETERVALUE DESCRIPTION
GetGet formatting progress(0~100) or result(error message)*It is unnecessary when using the blocking mode.

Example:

Request of get formatting progress(0\~100):

http://myserver/cgi-bin/admin/format_sdcard.cgi?operation=get

Response of success:

HTTP/1.1 200 OK\r\n

Content-Type: text/plain\r\n

Content-Length: \r\n

\r\n

List of success message:

0\~100 and 100 represents formatting completed

List of error message:

ERROR: You cannot format an SD card repeatedly

ERROR: Format SD failed, but removed all contents success

ERROR: Format SD failed, and failed to remove all contents

ERROR: Please insert SD card

ERROR: Please use ext file system

ERROR: File system type is not supported

ERROR: The device does not exist or is busy

ERROR: Formatted successfully, but cannot create database

8.39 Methods for Accessing Streaming

8.39.1 Get Stream URI (capability\_media\_streamprofiles\_support = 1)

Note: This request requires Viewer access privileges.

Syntax:

For RTSP, the user needs to input the URL below into a RTSP compatible player.

rtsp://<servername>:<port>/media2/stream.sdp?profile=<streamprofile_i<0~(n-1)>_token>[&<parameter>=<value>] 
  • “n” is the maximum stream profile number (capability_media_streamprofiles_num)
  • "streamprofile_i_token" is the unique identifier for each profile, x is within 0\~(capability_media_streamprofiles_num)-1.
  • port is the rtsp port.

Please refer to the streamprofile group for requesting the stream profile token value for each profile.

PARAMETERVALUE DESCRIPTION
pimssm11: Enable the feature of Protocol Independent Multicast - Source Specific Multicast.* This field is only required when using PIM-SSM feature.* Only valid when network_rtsp_pimssm_enable=1.

Example:

Request the streaming of streamprofile_i0_token=Profile200,

rtsp://192.168.1.1:554/media2/stream.sdp?profile=Profile200

Note:

If the requested certain profile streamprofile_i_occupied=0, which indicates stream profile has not been created, the above method for requesting RTSP streaming will fail.

8.39.2 Get SDP for always multicast

(capability_media_streamprofiles_support = 1)

Note: This request requires Viewer access privileges.

Method: GET/POST

Syntax:

http://<servername>:<port>/media2/<streamprofile_i<0~(n-1)>_profilename>.sdp?[<parameter>=<value>] 
  • “n” is the maximum stream profile number (capability_media_streamprofiles_num)
  • "streamprofile_i_profilename" is a friendly name for certain profile, x is within 0\~(capability_media_streamprofiles_num)-1.
  • port is the http port.

Please refer to the streamprofile group for requesting the stream profile name value for each profile.

You can get the SDP by HTTP GET.

When using scalable multicast, Get SDP file which contains the multicast information via HTTP.

PARAMETERVALUEDESCRIPTION
pimssm11: Enable the feature of Protocol Independent Multicast - Source Specific Multicast.* This field is only required when using PIM-SSM feature.* Only valid when network_rtsp_pimssm_enable=1.

Note:

  1. This method is only valid when always multicast is enabled, i.e. streamprofile_i_alwaysmulticast=1.
  2. If the requested certain streamprofile_i_profilename is empty, which indicates stream profile doesn't have a valid SDP file, the above method of requesting SDP file will fail.
  3. If there existed two or more streamprofile_i_profilename which have the same value, the requested SDP file will be overwrite by the last request.

4.

8.40 Accessing SFTP server and client

8.40.1 SFTP server setting for event action

* Only available when bit 1 of "capability_protocol_ftp_client" is 1.

Syntax: (for control API)

http:///cgi-bin/admin/sftpclient.cgi?operation=[&parameter=]

PARAMETERVALUEDESCRIPTION
operationautomode, manualmode"automode": Key pair will be generated, and automatically copy public key to server."manualmode": Key should be downloaded or uploaded by user.* This field is required.
keydownload, upload"download": Download public key."upload": Upload private key. Only support HTTP POST and "content-type: multipart/form-data". HTTP headers with its name="parameter" or name="uploadKeyFile" will be describing the request body, see examples below.* Required when operation=manualmode
addresssftp server address or hostname* This field is required.
portsftp port
index0~4Event setting server index* This field is required.
usernamestring[64]Sftp server username* This field is required.
passwdfingerprint_enablestring[64]Sftp server password* Required when operation=automode.Verify fingerprint* Default is 1.
fingerprint_content<128-bit hash value>Fingerprint content* Required when fingerprint_enable=1.
passphrase_enableEnable passphrase* Only valid when operation=manualmode and key=upload.
passphrase_content<128-bit hash value >Passphrase* Only valid when operation=manualmode and key=upload.
locationstring[128]sftp server file location
namestring[40]Username for server_i<index>_name* The default value is sftp<index>.
keytypeed25519, rsa, ecdsa"ed25519": faster to generate with higher security level, some old server might not support."rsa": slower to generate with slightly lower security level than ed25519."ecdsa": low security level.A keytype will be automatically selected if the parameter is not provided. The selected order will be ed25519/rsa/ecdsa until successful pairing, an error message will return if all keytype failed.* Required when operation=download.

Example of download key:

Request:

http:///cgi-bin/admin/sftpclient.cgi?operation=manualmode&key=download&index=

1&address=&username=xxx&fingerprint_enable=1&fingerprint_content=<MD5

value>&keytype=ecdsa

Response of success:

HTTP/1.1 200 OK\r\n

Content-Type: text/plain\r\n

Content-Length: <Success Message Length>\r\n
\r\n
ok 

Request:

http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=manualmode&key=download&index=1&address=<ip>&username=xxx&fingerprint_enable=1&fingerprint_content=<MD5 value>&keytype=test 

Response of failure:

HTTP/1.1 200 OK\r\n
Content-Type: text/plain\r\n
Content-Length: <Error Message Length>\r\n\r\n
ERROR: Invalid keytype 

Example of upload private key:

POST http://172.16.219.217/cgi-bin/admin/sftpclient.cgi HTTP/1.1
Accept: text/html, application/xhtml+xml, */*
Accept-Language: zh-TW
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; rv:11.0) like Gecko
Content-Type: multipart/form-data; boundary=--------7e1309282ed0f1a
Accept-Encoding: gzip, deflate
Host: 172.16.219.217
Content-Length: 6123
Connection: Keep-Alive
Pragma: no-cache
Cookie: webptzmode=continuous; activatedmode=digital; g_mode=1; viewsizemode=Auto;
4x3=false; lan=8
Authorization: Basic cm9vdDpGREQwMDAwMA==
--------7e1309282ed0f1a
Content-Disposition: form-data; name="parameter"
operation=manualmode&key=upload&index=1
--------7e1309282ed0f1a
Content-Disposition: form-data; name="uploadKeyFile"; filename="id_rsa"
Content-Type: text/plain 

----BEGIN RSA PRIVATE KEY----

Proc-Type: 4, ENCRYPTED

DEK-Info: AES-128-CBC,E6B9F3F257EF2DA03BA8A4832BC6386F

NYzaqdoY7OxS0XhviOKncGbMLpnx6n3VRYbeArSBwn+6wA7Y4lknFoMQiuC4HrCa oHgEex609584TWFBrkR+DfqKB73RCALTeAqAhEtywq75KQTWyHJcpOu8qZxquoKE TovnyQQANfyNLykEtP7U7Htxbdqg4dqYdFahJEBNs0QHxhmYHTESccKM4NOB0qMY 5+9gwIMZqNIymxGIGwylTMcV7gV6JaY/bX0K4J0B6AhNHjCIOFErrQivp026TXj9 m+bnnrAt7v5uBMH4ocIPC8oDHqd1jWwHIBcbqjRPWL37VW5B+YPZQ7FVUP496OKp riheNLTF6yOtYFw9syyoOnRF+gxpFpQrSO7skENGyv4CO7kH/S7Kpc7qmMgTk/rL s12230NogZsqghhTJlpg2vX5Ha3wCDIZZVKPUGItQl0MB6t74nsV1o8YVtRovI5F YX2d8sPIIkcTDWBO498+v98DQ7DH51/i39JoJouRojz+n3ffsSGjY2AKEcTde2xl v2f81KqAxkraXIIScI1SNEGXQpngXy3IK2GrVw9BzJILMSBuj30Ar2zfTbc0C5VC YqWK1FcMA5Jb6AvYwmpgijlb52T9P7g07RwFGJpumvaqTchBeSp8pXa3C++DoBdY 9zYohmuSSs52QLolkTPzDjJJHvncddPi6VuUkSyaK5x75p0+aoljPjlAQHXbXsmt 8HAdPs9Fwab9GbC2aumH4XT1xoWFnYJ9IBHc3iZRil/nSIPev2YneyyOhJg4tHYD swUUEydNC8Q5qrbLfHESDrkHlx0sQiM7A/DyY1akkoxKEFW9LxqsJpcf7LM2TrlX IjSd+RMqL3yCFzM0aqcQNjd77nDP6+u9RYYyGT8dH5ud7pJVofxl+pvpQN3k5Tlb Pm9IM6OJP Dy/Netcu6YEI3ULa6XHkYldqezJDnUfCBHe3OKjhue2FTBRmM2/j9Zl DkUrO7lQz7X88T/w5+rI2OnDIm3szOhzMCYPtHxf8ygMKXI/DKp3OR2/cu6ayGhb DezpoSyTjL1fTFINQAymDtP5tbomfESjFDW1fmfD9h1FivqYEy7017djPWrq8mjH N6nAhlaLVVuTVJ+xxaJAzYiQwMdwWY8SGUq062ksDvfixYCQfhXUd629oEX82fJU 8OxF8CM0WEHFClotJVbFjDyT5IP4qln5EMeMIPE8jrmUKEEV+AJw9AbaqvCYUNaH EVZ7nlYjrnQqMCktYIO/Um8vSiVsOaMFLUdiYJwj2pzyceTzyW19/KEo//8ufOFD LaSp5EGH6IBCTBfQ9PGeOkB2ZVf0jLFB9Sage8Ln5frWYOAROxzumUJWSvOoBael 15OdV5hApqQjGrn1vbc/kC8p478ZCzx2iDyckPqyVpHSke70T5bV6vcDZcCTrwkA PHdD4Q0cqd7sX0R2OAScwJk2AkaQ+PsLwS05hw1nQBsQrC4m9e8Kmg32RgCGDAES xpV9dkSkvoaLZmN1qfBwnyOxsjmx9OAOBKWzMlW5PoPCR9z8Z1gsiACBnrT+K5ec NZdgsxvxMfdI7vfj6mkO89MvwLX8YEtnFrihlZmDnnVMuHfq6g5kbwlHbHVaoImo ----END RSA PRIVATE KEY----

7e1309282ed0f1a--

Syntax: (for query API)

http:///cgi-bin/admin/sftpclient.cgi?operation=[&parameter=]

PARAMETERVALUEDESCRIPTION
operationgetserverhostkey" getserverhostkey ": Auto scan SFTP server host key.* This field is required.
addresssftp server address or hostname* This field is required.

Example of scanning SFTP server host key:

Request:

http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=getserverhostkey&address=<ip> 

Response of success:

HTTP/1.1 200 OK\r\n 
Content-Type: text/plain\r\n 
Content-Length: <Success Message Length>\r\n 
\r\n 
<MD5 value> 

8.40.2 SFTP Server Setting

* Only available when bit 1 of "capability_protocol_ftp_server" is 1.

Syntax: (for control API)

http://<servername>/cgi-bin/admin/sftpserver.cgi?operation=<value> 
PARAMETERVALUEDESCRIPTION
operationupdatehostkey"updatehostkey": Re-generate host key for SFTP server.* It might take several seconds to generate key, you can use "gethostkey" after key is generated.* This field is required.

Example of re-generate host key:

Request:

http://<servername>/cgi-bin/admin/sftpserver.cgi?operation=updatehostkey 

Response of success:

HTTP/1.1 200 OK\r\n

Content-Type: text/plain\r\n

Content-Length: \r\n

\r\n

ok

Syntax: (for query API)

http:///cgi-bin/admin/sftpserver.cgi?operation=

PARAMETERVALUEDESCRIPTION
operationgethostkey"gethostkey": Get host key for SFTP server.* This field is required.* If “updatehostkey” is not yet finished, you will receive error message.

Example of get host key:

Request:

http:///cgi-bin/admin/sftpserver.cgi?operation=gethostkey

Response of success

HTTP/1.1 200 OK\r\n

Content-Type: text/plain\r\n

Content-Length: \r\n

\r\n

MD5:a5:8a:7d:e2:2a:f8:c9:a0:ee:93:93:b8:0a:7a:18:97 (RSA)

MD5:7a:f4:07:48:e3:70:d5:89:15:36:6f:d5:25:f2:7e:0d (ED25519)

Technology License Notice

AMR-NB Standard

THIS PRODUCT IS LICENSED UNDER THE AMR-NB STANDARD PATENT LICENSE AGREEMENT. WITH RESPECT TO THE USE OF THIS PRODUCT, THE FOLLOWING LICENSORS' PATENTS MAY APPLY:

TELEFONAKIEBOLAGET ERICSSON AB: US PAT. 6192335; 6275798; 6029125; 6424938; 6058359. NOKIA CORPORATION: US PAT. 5946651; 6199035. VOICEAGE CORPORATION: AT PAT. 0516621; BE PAT. 0516621; CA PAT. 2010830; CH PAT. 0516621; DE PAT. 0516621; DK PAT. 0516621; ES PAT. 0516621; FR PAT. 0516621; GB PAT. 0516621; GR PAT. 0516621; IT PAT. 0516621; LI PAT. 0516621; LU PAT. 0516621; NL PAT. 0516621; SE PAT 0516621; US PAT 5444816; AT PAT. 819303/AT E 198805T1; AU PAT. 697256; BE PAT. 819303; BR PAT. 9604838-7; CA PAT. 2216315; CH PAT. 819303; CN PAT. ZL96193827.7; DE PAT. 819303/DE69611607T2; DK PAT. 819303; ES PAT. 819303; EP PAT. 819303; FR PAT. 819303; GB PAT. 819303; IT PAT. 819303; JP PAT. APP. 8-529817; NL PAT. 819303; SE PAT. 819303; US PAT. 5664053. THE LIST MAY BE UPDATED FROM TIME TO TIME BY LICENSORS AND A CURRENT VERSION OF WHICH IS AVAILABLE ON LICENSOR'S WEBSITE AT HTTP://WWW.VOICEAGE.COM.

Vivotek Turret Dome IT9389-H - AMR-NB Standard - 1

HEVC Advance™

Covered by Patents at patentlist.hevcadvance.com

Notices from HEVC Advance:

THIS PRODUCT IS SOLD WITH A LIMITED LICENSE AND IS AUTHORIZED TO BE USED ONLY IN CONNECTION WITH HEVC CONTENT THAT MEETS EACH OF THE THREE FOLLOWING QUALIFICATIONS: (1) HEVC CONTENT ONLY FOR PERSONAL USE; (2) HEVC CONTENT THAT IS NOT OFFERED FOR SALE; AND (3) HEVC CONTENT THAT IS CREATED BY THE OWNER OF THE PRODUCT. THIS PRODUCT MAY NOT BE USED IN CONNECTION WITH HEVC ENCODED CONTENT CREATED BY A THIRD PARTY, WHICH THE USER HAS ORDERED OR PURCHASED FROM A THIRD PARTY, UNLESS THE USER IS SEPARATELY GRANTED RIGHTS TO USE THE PRODUCT WITH SUCH CONTENT BY A LICENSED SELLER OF THE CONTENT. YOUR USE OF THIS PRODUCT IN CONNECTION WITH HEVC ENCODED CONTENT IS DEEMED ACCEPTANCE OF THE LIMITED AUTHORITY TO USE AS NOTED ABOVE.

H.264

THIS PRODUCT IS LICENSED UNDER THE AVC PATENT PORTFOLIO LICENSE FOR THE PERSONAL AND NON-COMMERCIAL USE OF A CONSUMER TO (i) ENCODE VIDEO IN COMPLIANCE WITH THE AVC STANDARD ("AVC VIDEO") AND/OR (ii) DECODE AVC VIDEO THAT WAS ENCODED BY A CONSUMER ENGAGED IN A PERSONAL AND NON-COMMERCIAL ACTIVITY AND/OR WAS OBTAINED FROM A VIDEO PROVIDER LICENSED TO PROVIDE AVC VIDEO. NO LICENSE IS GRANTED OR SHALL BE IMPLIED FOR ANY OTHER USE. ADDITIONAL INFORMATION MAY BE OBTAINED FROM MPEG LA, L.L.C. SEE HTTP://WWW.MPEGLA.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 規制について

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.

Table of contents Click a title to access it
Manual assistant
Powered by Anthropic
Waiting for your message
Product information

Brand : Vivotek

Model : Turret Dome IT9389-H

Category : Security Camera