FD9369

固定ドーム型カメラ

ユーザーズマニュアル
2MP・屋外対応・IP66・デイナイト・シームレス録画
DWDR • Smart Stream III • 音声入力

第1.0版

VIVOTEK

目次
概要 ..........................................................................................................................................................3
改訂履歴................................................................................................................................................................... 4
ご使用の前にお読みください...................................................................................................................................... 4
パッケージ内容 ......................................................................................................................................................... 5
本書で使用されている記号と説明 .............................................................................................................................. 5
ハードウェアの説明.................................................................................................................................................... 6
ハードウェアの取り付け ............................................................................................................................................. 8
ソフトウェアのインストール .......................................................................................................................................14
ネットワークへの接続...............................................................................................................................................21
準備完了.................................................................................................................................................................22

ネットワークカメラへのアクセス .................................................................................................................25
Webブラウザを使用 .................................................................................................................................................25
RTSPプレーヤーを使用 ...........................................................................................................................................28
3GPP対応モバイルデバイスを使用 ..........................................................................................................................29
VIVOTEK録画ソフトウェアを使用 .............................................................................................................................30

メイン画面 ... ............................................................................................................................................31
クライアント設定 ......................................................................................................................................36
設定 .......................................................................................................................................................................... 42
システム＞一般設定................................................................................................................................................43
システム＞ホームページのレイアウト.......................................................................................................................45
システム＞ログ........................................................................................................................................................48
システム＞パラメータ ...............................................................................................................................................51
システム＞メンテナンス ..........................................................................................................................................52
メディア＞画像 ........................................................................................................................................................55
メディア＞ビデオ......................................................................................................................................................68
メディア＞オーディオ................................................................................................................................................78
メディアプロファイル .............................................................................................................................................................. 79
ネットワーク＞一般設定...........................................................................................................................................80
ネットワーク＞ストリーミングプロトコル .....................................................................................................................87
ネットワーク＞SNMP（Simple Network Management Protocol） ..................................................................................96
ネットワーク＞FTP ...................................................................................................................................................97
Bonjour（ボンジュール）アプリ ...................................................................................................................................98
セキュリティ＞ユーザーアカウント ............................................................................................................................99
セキュリティ＞HTTPS（Hypertext Transfer Protocol over SSL) ...............................................................................101
セキュリティ＞アクセスリスト ..................................................................................................................................108
PTZ＞PTZ設定 .....................................................................................................................................................114
イベント＞イベント設定 ..........................................................................................................................................118
アプリケーション＞モーション検知 ..........................................................................................................................134
アプリケーション＞タンパリング検知 .......................................................................................................................135

2 - User's ManualVIVOTEK
アプリケーション＞音声検知..................................................................................................................................136
アプリケーション＞パッケージ管理‐通称VADP（VIVOTEK Application Development Platform）. ................................ 137
録画＞録画設定....................................................................................................................................................140
ストレージ..............................................................................................................................................................145
ストレージ＞SDカード管理............................................................................................................................................................................. 145
ストレージ＞NAS管理.......................................................................................................................................146
ストレージ＞コンテンツマネジメント....................................................................................................................148

Appendix .........................................................................................................................................151
URL Commands for the Network Camera ......................................................................................................151
Technology License Notice....... ......................................................................................................................426
Electromagnetic Compatibility （EMC） ............................................................................................................427

安全上のご注意• 本機に物を落としたり、強い衝撃を与えないで下さい。
• 本機のカバーの上に物を置かないで下さい。
• 本機から熱や煙が出た場合、ただちに使用をやめ本機からプラグを抜いて下さい。
• 異常がある場合は、お買い上げ取扱店へご連絡ください。
• 本機の分解、部品の取替えは、危険がある為行わないで下さい。
• 感電の危険性があるため、カバーを外さないで下さい。
• 外観に破損がないかどうか確認してください。破損が見られた場合は使用を中止してください。
• アークや火花が生じる恐れのある場所を避けて使用して下さい。通気口をふさがないで下さい。
• 本機は、乾燥した涼しい風通しの良い空間で保管・使用をして下さい。また、燃えやすい物から離れた場
所で保管・使用をして下さい。内部を冷却するためのファンが組み込まれている機器では、本機の前後に物を置かず、スペースを空けて下さい。
• 感電の危険性を減らすことと、腐食の防止のため、屋外設置ができない機器は雨や水しぶきのかかる場
所で保管・使用をしないで下さい。
• 本機を使用していない時は、入力 / 出力プラグを取り外して下さい。
• 保証期間内であっても不正改造を発見した場合、保証の対象外とします。

廃棄について
企業でご使用のお客さまは、本製品を産業廃棄物として扱ってください。
本製品を廃棄するときは、地方自治体の条例または規則に従って処理してください。

概要
FD9369は、1920×1080の高解像度映像を30fpsで撮影可能な屋外/屋内用固定ドーム型ネットワーク カメ
ラで す。本カメラシリーズは、DWDRテクノロジーにより、逆光下におけるコントラストを改善し高画質撮影を実現 しました。
本カメラシリーズは、ローカルビデオストレージをサポートしているので、映像データをMicroSDカードに保存できます。また、設定可能なモーション検知と タンパリング 検知機能を搭載しており、最大5つのプライ
バシーマスクエリアが指定できます。
カメラには、シームレス録画機能が搭 載されて います。ネットワークが切断された間の映像をSDカードに録画しておき、ネットワーク接続が回復すると、録画した映像をSDカードからVAST の録画ステーショ ンに取り込むことができます。
User's Manual - 3

VIVOTEK

改訂履歴 Rev. 1.0: 初期リリース。

ご使用の前にお読みください
監視デバイスの使用は、お住まいの地域で制限されている場合があります。ネットワークカメラは、高性能のWeb対応カメラであるだけでなく、監視システムの一部でもあります。この製品を取り付ける前に、このような使い方が合法であることを、ユーザーの責任においてご確認ください。
まず初めに下記のパッケージ内容に従って、受け取った製品の内容が完全であることを確認してください。
ネットワークカメラを取り付ける前に、クイックインストールガイドの［インストール前の注意］をお読みください。次に、誤った組み立てや取り付けによる損傷を防ぐため、インストールに関する説明の指示を注意深く読み、それに従ってください。これにより、製品が意図したとおりに正しく使用できます。
ネットワークカメラはネットワーク機器であり、ネットワークの基本的な知識があれば容易に使用するこ とができます。映像共有、一般的なセキュリティ/監視など、さまざまな用途向けに設計されています。［設定］の章では、ネットワークカメラを最大限に活用して適切な操作を行う方法を提案します。クリエイティブで
プロフェッショナルな開発者にとって、［ネットワークカメラ］の章の「URLコマンド」は、既存のホームページ
をカスタム設定したり、現在のWebサーバーと統合したりする際の参考になります。

重要：
1. カメラをいたずらや衝撃、落下等から保護するため、容易に手が届かず、衝撃や激しい振動のない場所に設置してください。
2. カメラを軒下に設置するときは、建物の軒先から10cm以上内側に設置してください。
3. 屋外にカメラを設置するときに電源アダプタから電源を供給する場合は、アダプタを正しく接地する必要があります。
4. 保守および修理作業は、必ず資格を持った技術者が行ってください。
5. 保守作業は、必ず電源を切ってから行ってください。
6. 電源アダプタについては、VIVOTEKの販売店にお問い合わせください。

4 - User's ManualVIVOTEK

パッケージ内容■ FD9369■ 取付ねじ、トルクスレンチ 一式■ アライメントステッカー■ 乾燥剤、テープ■ クイックインストールガイド■ ケーブルグランド

本書で使用されている記号と説明
情報： 使い方または問題発生の防止に役立つ重要なメッセージやアドバイスです。
ノート： 製品の機能の使い方に関連するガイダンスやアドバイスです。
ヒント： インストール、機能、手順を理解するのに役立つ情報です。
警告!または重要： 製品またはユーザーにとって危険や災害となりうる状況を示します。
感電： 使用者が高電圧の感電に晒される可能性を示します。

User's Manual - 5

VIVOTEK

ハードウェアの説明
外観図
ドームカバー

DC12/24V

内観図

RJ45イーサネット用コネクタ

IR LEDレンズ

6 - User's ManualVIVOTEK

LED

64GB

10
1

I

MicroSD カードスロット
リセットボタンノート：
モデル名末尾のアルファベットは下記の機能を表します。
E
Fx
T
R
H

広範囲な温度に対応するためにヒーターを内蔵
焦点距離(ｘはその値)
リモートフォーカスレンズ内蔵
PoEリピーター内蔵
ワイドダイナミックレンジ機能内蔵

User's Manual - 7

VIVOTEK

ハードウェアの取り付け
1. 後で参照できるように、カメラのMACアドレスを書き留めておきます。

XXXXXX

0002D10766AD

2. 付属のT10トルクスレンチでネジを緩めて、トップカバーを開けてください。

T10

8 - User's ManualVIVOTEK

3. オンボードストレージを使用する場合は、MicroSDカードを取り付けてください。

64GB

10
1

I

リセット
ボタン
4. アライメントステッカーを使用して、壁や天井に取り付け穴を開けてください。必要に応じて、 ケーブル配線用の穴を開けてください。

M3

P/N:XXXXXXØ ≥25mm

User's Manual - 9

VIVOTEK

5. イーサネットケーブルを配線穴に通します。AC/DC電源の接続箇所はテープで密閉して
ください。

1

2
ケーブル

自己融着テープ

2cm

2cm

1. 自己融着テープを2倍の長さに伸ばし、ケーブルに巻きつけます。
2. テープはケーブルのつなぎ目に20mmほど重なるように巻いてください。
3. すべてのコネクタは、使用の有無にかかわらず、防水する必要があります。

6. イーサネットケーブルを防水用のパッキン押え部品とゴム製のパッキンに、下図の要領で通します。イーサネットケーブルをカメラの RJ45 コネクタに接続してください。

5.5 ~10 - User's Manual

6.4m

m

VIVOTEK

7. シールリングを取り付け、防水部材をしっかり締めてください。

8. カメラを2本のネジで壁に固定してください。または、側面のノックアウトをニッパなどで切り欠き、側面にケーブルを通すこともできます。

< 10 kgf-cm

またはUser's Manual - 11

VIVOTEK

ドリップループを形成するようにケーブルを配線することも重要です。漏れや湿気は水滴となって、ケーブルを伝って流れます。ドリップループを形成することで、カ
メラに水分が浸入しにくくなります。

PoE

12 - User's ManualVIVOTEK

9. VIVOTEKのホームページにアクセスして、ソフトウェアユーティリティShepherdをインストール
してください。同一LAN上にあるVIVOTEKビデオレシーバー、ビデオサーバー、ネットワーク
カメラの検索を行います。
カメラのMACアドレスをダブルクリックするとカメラのWebコンソールが開きます。

Shepherd
LAN

IEEE 802.3af準拠

ブラウザ

User's Manual - 13

VIVOTEK

ソフトウェアのインストール
10. Shepherdユーティリティをインストールします。このユーティリティを使用すると、ローカルネッ
トワーク内でネットワークカメラを検出して設定することができます。VIVOTEKのWebサイトにアクセスし、［ダウンロード］＞［ソフトウェア］画面でユーティリティを検索します。

10-1.Shepherdをダウンロードしてアプリケーションを実行してください。
10-2.このプログラムはお使いのネットワーク環境を分析します。

14 - User's ManualVIVOTEK

10-3. このプログラムは同一の LAN 上に存在する全ての VIVOTEK ネットワークデバイスを検索します。
10-4. 検索後、インストーラーのウィンドウが開きます。製品ラベルに記載されているMACナンバーと同じ
モデル名をクリックすると、ネットワークカメラの管理画面が開きます。

Network Camera
Model No: FD9369
MAC:0002D1730202 R o HSThis device complies with part 15 of the FCC rules. Operation is subject to the following two conditions:(1)This device may not cause harmful interference, and(2) this device must accept any interference received, including interference that may cause undesired operation.

Pat. 6,930,709

Made in Taiwan

FD9369
IB8360-W

192.168.4.151

00-02-D1-73-02-02

0002D1730202

User's Manual - 15

VIVOTEK

強力なパスワード設定
11. カメラに初めてログインする場合、カメラはセキュリティ対策用にパスワード設定を促します。

11-1.カメラの工場出荷時点では、パスワードは存在していません。カメラの管理者はパスワードを設定しなくてはいけません。

11-2.パスワードを英数字と一部の記号を組み合わせて設定します。パスワードの強度要求を満たすように入力してください。カメラの管理者のユーザー名は「root」です。これは変更できません。

16 - User's ManualVIVOTEK

一部の ASCII 文字がパスワードに使用できます：!、$、%、-、.、@、^、_、~。

11-3.カメラ管理者のパスワードが設定されましたので、次に改めてログイン画面が表示されます。
ここで管理者としてログインするのであれば、ユーザー名の「root」と今設定したパスワードを入力します。パスワードを入力すると、カメラのウェブコンソール画面が開きます。

User's Manual - 17

VIVOTEK

12. PCのライブビューで、最適な視野が得られるようカメラのパン、チルトを調整します。

0 ~ 350°

18 - User's Manual-10 ~ 75°

VIVOTEK

13. 付属品の乾燥剤パックの袋を破って乾燥剤を取り出し、ドームカバー内側にある乾燥剤を交換します。

2

1

14. ドームカバーを取り付けてください。

T10

User's Manual - 19

VIVOTEK

15. ドームカバーの保護シートを剥がしてください。

ハードウェアのリセット
リセットボタンはシステムをリセットしたり、出荷時のデフォルト設定を復元させる場合に使用します 。
システムをリセットさせてカメラを正常動作させるときに使うことがあります。リセット後もシステムの問題が継続する場合は、初期化により出荷時のデフォルト設定を復元させて再度インストールしてください。
リセット：7ページのリセットボタンを押します。ネットワークカメラが再起動するまでお待ちください。
初 期化：ステータスLEDが素早く点滅し始めるまで、リセットボタンを押し続けます。すべての設定
が出荷時のデフォルト設定に復元される点にご注意ください。復元が完了すると、ステータスLEDは緑色が点滅し、通常動作に戻ると赤色が点灯します。

SD/SDHC/SDXCカードの容量
本モデルは MicroSD/SDHC/SDXC 1TBまでのカードに対応しています。

20 - User's ManualVIVOTEK

ネットワークへの接続
一般接続（PoE）
PoE対応スイッチを使用する場合
ネットワークカメラはPoEに対応しており、1本のイーサネットケーブルで電力供給とデータの送受信が可能です。ネットワークカメラとPoE対応スイッチをイーサネットケーブルで接続する際は、下図のように接続してください。

802.3af

PoEスイッチ

PoE非対応スイッチを使用する場合
PoEパワーインジェクタ(別売り)を使用して、ネットワークカメラとスイッチ間を接続してくださ い。

PoEパワーインジェクタ（別売り）

PoE非対応スイッチ

ノート:
IoT 機器のセキュリティ基準 ( 端末設備等規則第 34 条の 10)「本製品は電気通信事業者 ( 移動通信会社、
固定通信会社、インターネットプロバイダ等 ) の通信回線 ( 公衆無線 LAN を含む ) に直接接続することができません。本製品をインターネットに接続する場合は、必ずルータ等を経由し接続してください。」

User's Manual - 21

VIVOTEK

準備完了
1.ブラウザからネットワークカメラにアクセスすると、下図のような画面が表示されます。
2.複数のカメラを設置する場合は、32 チャンネル録画ソフトウェアをインストールすることもできます。インストールの詳細については、VIVOTEKのWEBを参照してください。

22 - User's ManualVIVOTEK

ルーターを経由したインターネット接続
ネットワークカメラをインターネット経由で設定する前に、ルーターを用意して以下のステップに従ってください。
1. ネットワークカメラをルーターのローカル側に接続します。インターネット接続の環境を以下に示します。IPアドレスの取得方法は、「ソフトウェアのインストール」（P.20）をご参照ください。

インターネット

WAN (ワイドエリアネットワーク )ルーターIPアドレス：ISPから

IPアドレス：192.168.0.3
サブネットマスク：255.255.255.0
デフォルトルーター : 192.168.0.1

LAN （ローカルエリアネットワーク)
ルーターIPアドレス : 192.168.0.1

ケーブル又はDSLモデム

IPアドレス：192.168.0.2
サブネットマスク：255.255.255.0
デフォルトルーター：192.168.0.1

2. この例では、ネットワークカメラのローカルエリアネットワーク（LAN）IP アドレスが192.168.0.3
であり、ルーターは以下のポートの通信をネットワークカメラへ転送します。
■ HTTPポート：デフォルトは80■ RTSPポート：デフォルトは554■ 映像用RTPポート：デフォルトは 5556
■ 映像用RTCPポート：デフォルトは5557
ネットワークの設定でポート番号を変更している場合は、ルーターにて該当するポートを開いてください。ルー
ターでポートの通信を転送する方法は、ルーターのユーザーマニュアルを参照してください。

3. お使いのISP（インターネットサービスプロバイダ）から提供されるルーターのパブリックIPアドレスを確認し、パブリックIPとセカンダリHTTP ポートを使用して、インターネットからネットワークカメラにア
クセスします。
固定IPを使ったインターネット接続
ネットワークカメラに固定IPを使用する必要がある場合は、この接続形式を選択します。詳細は「LANの 設定」（P.80）をご参照ください。

PPPoE（Point-to-Point over Ethernet）経由のインターネット接続
DSL回線でインターネットに接続している場合は、この接続形式を選択してください。詳細は「PPPoE」 （P.81）をご参照ください。

User's Manual - 23

VIVOTEK

例えば、ルーターと IP の設定は以下のようになります。
デバイス

IPアドレス：内部ポート

ルーターのパブリックIP
ルーターのLAN IP
カメラ1
カメラ2
...

122.146.57.120
192.168.2.1
192.168.2.10:80
192.168.2.11:80...

IPアドレス：外部ポート（ルーターのマップされたポート）

122.146.57.120:8000
122.146.57.120:8001...

構成済みのポート番号から入力される全てのデータをルーターがプライベートネットワーク上のネットワークカメラへ転送できるように、ルーター、バーチャルサーバー、ファイアウォールを構成し、同一のパスにてカメラからのデータがネットワークの外部へ転送されるようにします。
送信元
122.146.57.120:8000
122.146.57.120:8001...

送信先192.168.2.10:80
192.168.2.11:80...

正しく構成すれば、以下のアドレスを使用してルーターのローカル側にあるカメラにアクセスできます：http://122.146.57.120:8000
ネットワークの設定でポート番号を変更している場合は、ルーターにて該当するポートを開いてください。例えばお使いのローカルネットワーク内部でルーターを通じたカメラへのアクセスを構成するために、ルーター内の管理セッションで設定を変更します。ルーターの設定に問題がある場合は、ネットワーク管理者にルーター構成を問い合わせてください。
ネットワーク設定オプション（ストリーミングポートの設定など）の詳細については［ネットワーク］＞［一般設定］をご参照ください。VIVOTEKのカメラはまた、NAT トラバーサル機能として自動ポート転送機能も備えています。ただし、ルーターがUPnP ポート転送機能に対応していることが条件となります。

24 - User's ManualVIVOTEK

ネットワークカメラへのアクセス
この章では、Webブラウザ、RTSPプレーヤー、3GPP対応モバイルデバイス、VIVOTEK録画ソフトウェア
からネットワークカメラにアクセスする方法について説明します。

Webブラウザを使用
ユーティリティソフトShepherdを使用して、LAN 上のネットワークカメラへアクセスできます。カメラのIPアドレスがわかっている場合、以下のステップに従い、ネットワークカメラへアクセスします：
1. Webブラウザ（Microsoft®、Internet Explorer、Edge（IEモード）またはChrome）を起動します。
2. アドレス欄にネットワークカメラの IP アドレスを入力します。Enterを押します。
3. ライブ映像がWebブラウザに表示されます。
4. VIVOTEKネットワークカメラを初めてインストールする場合は、以下のようなインフォメーションバー が表示されることがあります。指示に従って必要なプラグインをPCにインストールしてください。

User's Manual - 25

VIVOTEK► ネットワークカメラは、工場出荷時のデフォルト設定ではパスワードにより保護されていません。不正アクセスを防ぐため、画面の指示に従いパスワードを必ず設定してください。
パスワードに関する設定については、「セキュリティ」（P.99）をご参照ください。
► セキュリティ設定により ActiveX® Control が実行できないというダイヤログボックスが表示された場合は、以下に従ってブラウザの ActiveX® Control を有効にしてください。

1. ［ツール］＞［インターネットオプション］＞［セキュリティ］＞［カスタムレベル］を選択します。

2. ［署名入りActiveX®コントロールのダウンロード]の項目から[有効]または[プロンプト]を選択します。
［OK]をクリックします。

3. Webブラウザを更新し、ActiveX®コントロールをインストールします。指示に従いインストールを完了させてください。
26 - User's ManualVIVOTEK重要:• 現行のネットワークカメラは32ビットのActiveXプラグインを使用しています。64ビットのIEブ
ラ ウザでは、カメラの管理/表示セッションを開くことができません。
• 上記の問題が発生した場合は、C:\Windows\SysWOW64からIexplore.exeプログラム を実行
してください。32ビット版のIEブラウザがインストールされます。
• Shepherd ユーティリティからウェブセッションを開いた場合、Chromeブラウザが開きます。

ヒント:
1. 画面のJava制御機能は以下の状態で動作不良を起こすことがあります：PCが同じIPアドレスを使用する別のカメラに接続する場合（または異なるファームウェアバージョンで同じカメラに接続した場合）。ブラウザのCookieを削除するとこの問題を解決できます。

User's Manual - 27

VIVOTEKRTSPプレーヤーを使用
RTSPプレーヤーを使ってストリーミングメディアを視聴する際は、RTSPストリーミングに対応した以下のプレーヤーが使用可能です。
VLCメディアプレーヤー
VLC media player
1. RTSPプレーヤ―を起動します。
mpegable Player
2. ［ファイル］を選択＞［URL］を開く：URLダイアログボックスがポップアップ表示されます。
pvPlayer
3. アドレス形式は次のようになります。
rtsp://<IPアドレス>:<RTSPポート>/<ストリーム1または2用のRTSPストリーミングアクセス>
ISPやプレーヤーは、ポート番号554によるRTSPストリーミングのみを許可している場合がほとんどです
ので、RTSPポートを554に設定してください。詳細は「RTSPストリーミング」（P.88）をご参照ください。
（例）

rtsp://192.168.5.151:554/live1s1.sdp

4. お使いのプレーヤーにライブ映像が表示されます。
RTSPアクセス名の設定方法の詳細については「RTSPストリーミング」（P.88）をご参照ください。

28 - User's ManualVIVOTEK

3GPP対応モバイルデバイスを使用
3GPP対応モバイルデバイスでストリーミングメディアを視聴するには、ネットワークカメラがインターネッ
トに接続可能であることを確認する必要があります。インターネット経由でのネットワークカメラの設定
方法については、「インターネット経由でのネットワークカメラの設定」（P.21）をご参照ください。
この機能を利用する際は、お使いのネットワークカメラについて以下の設定を確認してください。
1. 3GPP携帯電話の多くはプレーヤーがRTSP認証に対応していないため、RTSPストリーミングの認証
モードを無効に設定してください。
詳細は「RTSPストリーミング」（P.88）をご参照ください。
2. 3Gネットワークは帯域に制限があるため、大きな映像サイズは使用できません。ビデオストリーミングのパラメータを以下のように設定してください。
詳細は「ストリーム設定」（P.68）をご参照ください。
映像モード
フレームサイズ
最大フレームレート
イントラ・フレーム・ピリオド
映像画質（固定ビットレート）

H.264
176 x 144
5 fps
1S
40kbps

3. ISPやプレーヤーは、ポート番号554によるRTSPストリーミングのみ許可している場合が多いため、
RTSPポートは554に設定してください。詳細は、「RTSPストリーミング」（P.88）をご参照ください。
4. 3GPP対応モバイルデバイスのプレーヤー（例：VLCプレーヤー）を起動します。
5. プレーヤーに以下のURLコマンドを入力します。
アドレス形式は次のとおりです：rtsp://<お使いのカメラのパブリックIPアドレス>:<RTSPポート>/<フレームサイズおよびフレームレートが小さいストリーム#のRTSPストリーミングアクセス名＞（例）

モバイルデバイスでライブ表示する際は、ストリーム#2を上記の推奨ストリームに設定できます。
User's Manual - 29

VIVOTEKVIVOTEK録画ソフトウェアを使用
VIVOTEKのWEBサイトから録画ソフトをダウンロードして使用することができます。複数のネットワーク
カメラを同時に監視して映像を録画できます。録画ソフトウェアをインストールしてプログラムを開き、ネットワークカメラをチャンネル一覧へ追加します。録画ソフトウェアの詳細な使用方法は、WEBにあるユーザーマニュアルを参照してください。VIVOTEK のWEB サイトへ移動し、 Product (プロダクト）>
Software（ソフトウェア）> VMS からダウンロードしてください。

ヒント：
1. ライブビューの表示やスクリーン上のプラグイン制御に問題が発生した場合は、コンピューターへインストールしたプラグインをアンインストールしてみてください。以下のフォルダ―を削除します：C:\
Program Files (x86)\Camera Stream Controller\。
2. カメラのルート（管理者）パスワードを忘れてしまった場合は、リセットボタンを 5 秒間以上押し続けると、カメラを出荷状態へ復元できます。
3. ネットワークでDHCPが有効になっており、カメラへアクセスできない場合、Shepherdユーティリテ ィ
を実行してネットワークを検索してください。カメラがお使いのローカルネットワークでIPアドレスが自動設定されない場合、デフォルト IPは169.254.x.x. が設定されます。それでもカメラが見つからな
い場合、カメラを出荷状態へ復元してください。
4. LANカードへの接続を追加するなど、ネットワークパラメーターを変更した場合、Shepherdユーテ
ィリティを再起動してください。

30 - User's ManualVIVOTEK

メイン画面
本章では、メイン画面のレイアウトについて説明します。VIVOTEKロゴ、ホスト名、カメラのコントロー
ルパネル、サイズ調整ボタン、設定エリア、ライブビデオウィンドウで構成されています。
サイズ調整ボタン
VIVOTEKロゴ

ホスト名
設定エリア

カメラのコントロー
ルパネル

非表示ボタン
ライブビデオウィンドウ

VIVOTEKロゴ
ロゴをクリックすると、VIVOTEKのWebサイトが開きます。

ホスト名
ホスト名は設定によって変更できます。監視環境に複数のカメラがある場合は、ホスト名を変更することで管理を容易にすることができます。詳細は「システム」（P.42）をご参照ください。

カメラのコントロールパネル
プロファイルモード： 最大ビュー、録画ビュー、ライブビュー、アプリの事前設定された4つのストリーミングプロ
ファイルを提供します。モード毎に、異なるストリームソース(チャネル)、解像度、マルチキャスト、メタデータが設定されています。
プロファイルは［設定］＞［メディア］＞［メディアプロファイル］で設定できます。
手動トリガー：クリックするとイベントのトリガーを手動で有効/無効にできます。この機能を有効にする前に、イベント設定を設定してください。合計3 つのイベントを設定できます。このアイテムをホームページから隠す場 合は、［設定］ > ［システム］ > ［ホーム画面のレイアウト］ > ［一般設定］ > ［カスタマイズボタン］へ移動し、［手動トリガーボタンを表示］」チェックボックスからチェックを外してください。

User's Manual - 31

VIVOTEK

設定エリア
クライアント設定：このボタンをクリックするとクライアント設定ページへアクセスできます。詳細は「ク ライア ント
設定」（P.36）をご参照く ださい。
構成：このボタンをクリックするとネットワークカメラの詳細な設定ページへアクセスできます。管理者のみがネット
ワークカメラを設定できるように、ネットワークカメラへのパスワード設定を推奨します。詳細は「設定」（P. 41）をご参照ください。
言語：ユーザーインターフェースで使用したい言語を選択できます。言語オプションは、英語、オランダ 語、ス ペ イン語、フランス語、イタリア語、日本語、ポルトガル語、中国語（簡体字）、中国語（繁体字）から選択できま す。言語は［設定］画面でも変更できます(P.41をご参照ください)。

非表示ボタン
非表示ボタンをクリックすることで、コントロールパネルの表示/非表示を変更することができます。

サイズ調整ボタン［Auto］ビデオ画面はモニターのサイズに合わせるよう自動的に調整されます。
［100%］オリジナルの画面サイズを表示します。
［50%］画面サイズをオリジナルの50%のサイズへ調整します。
［25%］画面サイズをオリジナルの25%のサイズへ調整します。

ライブビデオウィンドウ■ 以下のウィンドウはビデオモードをH.264またはH.265へ設定した際に表示されます。
H.264またはH.265プロトコルとメディアオプション

ビデオのタイトル
タイトルと時刻
ズーム表示

Video (TPC-AV)

時刻

2018/03/25 17:08:56

Video 17:08:56 2018/03/25

x4.0

ビデオとオーディオの制御ボタン

ビデオのタイトル：ビデオのタイトルは変更できます。詳細は「映像設定」（P.55）をご参照ください。
H.264 またはH.265プロトコルとメディアオプション：H.264またはH.265ビデオストリームの転送プロトコ
ルとメディアオプションを表示します。詳細設定は「クライアント設定」（P.36）をご参照ください。
時刻：現在時刻を表示します。詳細設定は[メディア]>[画像]>[一般設定]（P.55）をご参照ください 。
タイトルと時刻：ストリーミング映像にビデオのタイトルと時刻をスタンプできます。
詳細設定は[メディア]>[画像]>[一般設定]（P.60）をご参照ください。

32 - User's ManualVIVOTEKPTZパネル：このネットワークカメラは「デジタル」パン/チルト/ズーム制御(e-PTZ)に対応しており、ズームイン
したビデオ映像に対しパン/チルトさせることができます。詳細は、「PTZ設定」(P.114)をご参照ください。「グローバルビュー」と「PTZパネル」は、3番目または最後の映像プロファイルで利用可能です。

グローバルビュー：グローバルビューは、3番目または最後の映像プロファイルで利用できます。この項目をクリックすると、グローバルビューウィンドウが開きます。グローバルビューウィンドウは全画面（オリジナルのフレームサイズ）に対しフローティングフレーム（現在の表示画面）を重ねて表示します。フローティングフレームを直接操作して、ユーザーは e-PTZ の操作（パン/チルト/ズーム）をすることができます。e-PTZ操作Gの詳細は「EPTZ操作」（P.114）をご参照ください。現在のビデオストリームの表示エリアの 設定方法については、P.114をご参照ください。

現在のビデオストリームのビュー区域最大のフレームサイズ

e-PTZは、ズームインした映像に限り動作することにご注意ください。ライブビデオウィンドウに全画面が表示されている場合、PTZボタンは機能しません。

User's Manual - 33

VIVOTEK

ビデオ制御ボタン：ネットワークカメラのモデルと設定内容によっては、一部のボタンは機能しません。
［スナップショット］ ： このボタンをクリックすると、スナップショットを取得して保存します。取得した画像はポップアップウィンドウに表示されます。画像を右クリックし、［名前を付けて画像を保存］を選択してJPEG（*.jpg）
または BMP（*.bmp）形式で保存します。
デジタルズーム：［デジタルズームを無効にする］をクリックしてチェックを外すと、ズームが有効になります。
ナビゲーション画面は画像の拡大された箇所を示します。スライドバーをドラッグしてズームレベルを調整します。ナビゲーション画面を直接ドラッグすれば位置を変えることができます。

一時停止:メディアのストリーミングを一時停止します。一時停止ボタンをクリックすると、ボタンは再開ボタンへ変化します。

停止：ライブビデオウインドウでのストリーミング表示を停止します。再開ボタン
ミ ングが再開されます。

をクリックするとストリー

MP4 録画を開始：このボタンをクリックすると、ビデオクリップを MP4 形式で録画してコンピューターへ保存します。 MP4録画を停止ボタン
をクリックすると録画が停止します。Webブラウザを終了すると、ビデオ録画も同時に停止します。保存先やファイル名の指定については「MP4保存オプション」（P.37）をご参照ください。
フルスクリーン：このボタンをクリックするとフルスクリーンモードへ切り替わります。Escキーを押すとノーマ
ルモードへ戻ります。

34 - User's ManualVIVOTEK■ ビデオモードをMJPEGに設定すると以下のウィンドウが表示されます。
ビデオのタイトル

2021/03/25 17:08:56

時刻

タイトルと時間

ビデオ制御ボタン

ビデオのタイトル：ビデオのタイトルは変更できます。詳細は［メディア］＞［画像］（P.60）をご参照ください。
時刻：現在時刻を表示します。詳細は［メディア］＞［画像］（P.60）をご参照ください。
タイトルと時間：ストリーミング映像にビデオのタイトルと時刻をスタンプできます。詳細は[メディア]>[画像] （P.60）を ご参照ください。
ビデオ制御ボタン：ネットワ ークカメラの機種およびネットワークカメラの設定によっては、一部のボタンが使用できない場合があります。
［スナップショット］ ： このボタンをクリックすると、スナップショットをキャプチャして保存できます。キャプ
チャした画像は、ポップアップウィンドウに表示されます。画像を右クリックし、［名前を付けて画像を保存］を選択して、JPEG （*.jpg）またはBMP（*.bmp）形式で保存します。
デジタルズーム：［デジタルズームを無効にする］のチェックを外すと、ズーム操作が可能になります。
ナビゲーション画面には、拡大画像の一部が表示されます。ズームレベルを調整するには、スライドバーをドラッグします。拡大したい別の箇所に移動するには、ナビゲーション画面をドラッグしてください。

MP4録画を開始：このボタンをクリックすると、ビデオクリップをMP4形式で録画してコンピューターへ保存します。MP4録画を停止ボタン
をクリックすると録画が停止します。Webブラウザを終了すると、ビデオ録画も同時に停止します。保存先やファイル名の指定については「MP4保存オプション」（P.37）をご参照く
ださい。
フルスクリーン：このボタンをクリックするとフルスクリーンモードへ切り替わります。Escキーを押すとノーマルモードへ戻ります。

User's Manual - 35

VIVOTEK

クライアント設定
この章ではローカルコンピュータでストリーム転送モードと保存オプションを選択する方法について説明します。本画面での設定が完了したら、画面下部の［保存］をクリックして設定を有効にしてください。

H.265/H.264プロトコルオプション

お使いのネットワーク環境に応じて、H.265/H.264ストリーミングでは次の4つの伝送モードを選択することができます。
UDPユニキャスト：このプロトコルはよりリアルタイムな音声と映像のストリームを可能にします。ただし、バースト
トラフィックによってパケットロスが生じ、画像が破損する場合があります。UDP 接続はリアルタイムな応答が必
要で映像品質がそれほど重要でない場合に適しています。サーバに接続する各ユニキャストクライアントはそれ
ぞれが帯域幅を使用します。このため、一度にアクセスできるネットワークカメラの数は最大10までとなります。
UDPマルチキャスト：このプロトコルを使用すると、マルチキャスト対応のルーターはストリーミングメディアを要求するすべてのクライアントにネットワークパケットを転送することができます。これにより、複数のクライアントに同時にサービスを提供しながらもネットワークカメラの転送負荷を軽減することができます。この機能を使用するには、マルチキャストストリーミングを有効にするようにネットワークカメラを設定する必要があります。詳細は「
RTSPストリーミング」（P.88）をご参照ください。
TCP：このプロトコルはストリーミングデータのより確実な配信と高い映像品質を提供します。ただし、よりリアル
タイムなストリーミングには、UDPプロトコルが適しています。
HTTP：このプロトコルは、ある一部のネットワーク環境において、特定のポートを開くことなくTCPプロトコルと同じ品質でストリーミングを行うことができます。ファイアウォール内のユーザーは、このプロトコルを使用してデ ー
タのストリーミングを許可することができます。

36 - User's ManualVIVOTEK

MP4保存オプション

メイン画面で［MP4録画を開始］ をクリックすると、視聴中のライブビデオを録画することができます。録画
データの保存先とファイル名の指定を行います。
フォルダ： 録画したビデオファイルの保存先を指定します。保存場所は変更することができます。
ファイル名のプレフィックス：ビデオファイル名の前に付加するテキストを入力します。指定したフォルダがロー
カルのハードディスクに自動的に作成されます。
ファイル名に日付と時刻を追加：このオプションを選択すると、ファイル名の末尾に日付と時刻が追加されます。

CLIP_20210321-180853

ファイル名のプレフィックス 日付と時刻のサフィックス
形式：YYYYMMDD_HHMMSS

ローカル・ストリーミング・バッファ時間

帯域幅が不安定な場合、ライブストリーミングに遅延が生じたり、ビデオストリーミングがスムーズに行われないことがあります。このオプションを有効にすると、ライブストリーミングはPCのキャッシュメモリに一時的に保存され、数ミリ秒後にライブビューウインドウで再生されます。これにより、ストリーミングがよりスムーズに再生されます。例えば、バッファタイムを3,000/ミリ秒に設定すると、ストリーミングは３秒間遅延します。

User's Manual - 37

VIVOTEK

ジョイスティックの設定
ジョイスティックを有効にする
ジョイスティックを管理用コンピュータのUSBポートに接続します。対応プラグイン(Microsoft’s DirectX)
により、Webコンソールのプラグインが読み込まれると、コンピュータに接続されたジョイスティックが自動的に検出されます。ジョイスティックは、他のドライバやソフトウェアをインストールしなくても正常に動作します。
次に、接続されているジョイスティックの設定を行います。設定を有効にするには、次の手順に従ってください。
1. デバイスが複数ある場合は、[選択済みのジョイスティック]項目から、検出されたジョイスティックを選択します。ジョイスティックが認識されない場合、デバイスに不具合がある可能性があります。
2. ［キャリブレーション］または［設定］ボタンをクリックし、ジョイスティックに関する設定を行ってください。

ノート：
•

•

•

ジョイスティックにプリセットアクションを割り当てる場合は、[設定]＞[PTZ]画面でプリセットの場所を事前に設定しておく必要があります。Windowsの場合、［スタート］メニューの検索機能を使用して、［ゲームコントローラ］を検索します。
ジョイスティックが正しく動作しない時は、キャリブレーションが必要な場合があります。[キャリブレーシ
ョン]ボタンをクリックして、Windowsのコントロールパネルにあるウインドウを開き、トラブルシューティ
ングの手順に従ってください。
ジョイスティックは、Windowsのコントロールパネルの[ゲームコントローラ]リストに表示されます。
デバイスを確認するには［スタート］>［コントロールパネル］>［ゲームコントローラ］の順に選択します。

38 - User's ManualVIVOTEK

ボタン設定［ボタン設定]ウィンドウでは、左側に割り当て可能なアクション、右側に機能ボタンと割り当てられたアクションが表示されます。ジョイスティックによってボタンの数が異なることがあります。
以下の手順で、ジョイスティックボタンの設定を行ってください：
1. いずれかのアクションを選択して[割り当て]をクリックすると、ダイアログボックスが表示されます。このアクションをボタンに割り当てるには、ジョイスティックのボタンを押すか、ドロップダウンリストから選択します。
（例）ボタン1にHome（ホームポジションへの移動）を割り当てる場合。

2. [OK]をクリックし、設定を確定します。

User's Manual - 39

VIVOTEK

ボタン設定［ボタン設定］をクリックすると、下図のようなウィンドウが表示されます。以下の手順でジョイスティックのボタン を設定してください。
1. ボタン番号のプルダウンメニューから、ボタン番号を選択します。

ヒント：
各ボタンの位置がわからない場合は、［ゲームコントローラ］ユーティリティの［プロパティ］ウィンドウを使用してください。

40 - User's ManualVIVOTEK

2.［パトロール］や［プリセット#］など、対応するアクションを選択します。

3. [割り当て]ボタンをクリックします。ボタン番号を選択し、［削除］ボタンをクリックすると、関連付けを削除することができます。
すべての優先アクションの設定が終了するまで、このプロセスを繰り返します。
設定済のボタンがボタン一覧に表示されます。
4. ［クライアント設定］画面で［保存］ボタンをクリック
し、必ず設定を保存してください。

User's Manual - 41

VIVOTEK

設定
メイン画面で［構成］をクリックし、カメラの設定画面を開いてください。管理者のみが設定画面にアクセスできます。
VIVOTEKは、簡単な手順でネットワークカメラを設定できるように、使いやすいユーザーインターフェースを提供しています。ユーザーインターフェースをシンプルにするため、機能項目をクリックしない限り、詳細情報は表示されません。最初のサブ項目をクリックすると、該当するサブ項目の詳細情報が表示されます。2番目のサブ項目をクリックすると、該当するサブ項目の詳細情報が表示され、最初のサブ
項目の詳細情報は非表示になります。
以下は、メイン画面のインターフェースです：

ナビゲーションエリア

設定リスト

ファームウェアバージョン

設定リストの各機能については、次章以降に説明します。
設定エリアは固定されており、どの設定項目を開いているときも[ホーム](ライブビューウインドウ)、[クライアント設定]、[言語選択] にアクセスできます。

42 - User's ManualVIVOTEK

システム＞一般設定
ホスト名やシステム時刻など、ネットワークカメラの基本的な設定方法について説明します。［システム］と［システム時刻］の2つの画面で構成されています。本画面での設定が完了したら、画面下部の［保存］をクリックして設定を有効にしてください。
システム

ホスト名：ネットワークカメラに設定したい任意の名前を入力します。設定名はメイン画面の上部と、VAST 2
ソフトウェアのビューセルにも表示されます。
LEDインジケーターをオフ：ネットワークカメラが動作していることを第三者に知られたくない場合は、このオプションを選択してLEDインジケーターをオフにすることができます。

User's Manual - 43

VIVOTEK

システム時間

現在の日付と時刻を保持：選択すると、ネットワークカメラの現在の設定日時を維持することができます。カメラの内蔵リアルタイムクロックは、システム側の電源を切っても設定日時を保ちます。
コンピュータ時間と同期：選択すると、ネットワークカメラの日付と時刻をローカルコンピュータと同期することができます。カメラはPCから読み取った日時に更新されて表示されます。
マニュアル：選択すると、日付と時刻を手動で入力することができます。日付と時刻のフォーマットは、 [yyyy/
mm/dd] と [hh:mm:ss]です。
自動：選択すると、NTPサーバに定期的に問い合わせてネットワークカメラの時刻を同期化するNetworkTime
Protocolを設定します。
NTPサーバー：タイムサーバのIPアドレスまたはドメイン名を割り当てます。 テキストボックスを空白のままにすると、ネットワークカメラがインターネットにアクセスできる場合カメラは既定のタイムサーバに接続されます。
アップデート間隔：選択すると、NTPサーバを使用して任意の単位（時間/日/週/月）でカメラの時刻を更新することができます。
タイムゾーン：リストから適切なタイムゾーンを選択します。［タイムゾーン］メニューを下にスクロールして、［カスタム設定］オプションを見つけ、POSIX TZ変数を使用します。
（例）http://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html

44 - User's ManualVIVOTEK

システム＞ホームページのレイアウト
ここでは、ホームページのレイアウトをカスタマイズする方法を説明します。
一般設定
この画面は、ホームページのレイアウトの設定について示すものです。背景色や文字色は、［テーマオプション］（この画面の2番目のタブ）で手動選択することができます。設定は、［プレビュー］フィールドに自動的に表示されます。
以下は、デフォルトの設定を使用したホーム画面です。

■「Powered by VIVOTEKを表示しない」：この項目にチェックを入れると、ホーム画面に表示されなくなります。
ロゴ画像
ホーム画面のトップに表示されるロゴを変更することができます。

以下の手順で、新しいロゴをアップロードします。
1. ［カスタム]をクリックすると、[参照]フィールドが表示されます。
2. ご自分のデータファイルからロゴを選択します。
3. ［アップロード］をクリックして、既存のロゴを新しいロゴに置き換えます。
4. 必要に応じてWebサイトのリンク先を入力してください。
5. ［保存］をクリックし、設定を有効にしてください。
［カスタマイズ］ボタン
ホーム画面の手動トリガーボタンを非表示にしたい場合は、この項目のチェックを外してください。この項目
は、工場出荷時はオンになっています。

User's Manual - 45

VIVOTEK

テーマオプション
ホーム画面のレイアウトの色を変更することができます。３つのプリセットパターンから１つを選択すると、新しいレイアウトがプレビューフィールドに表示されます。設定が完了したら[保存]をクリックして設定を有効にします。

ビデオタイトルフォント色フォント色コントロールエリア背景色
設定エリアフォント色
設定エリア背景色

プリセットパターン46 - User's Manual

ビデオエリア背景色
フレーム色

VIVOTEK■ 以下の手順でホーム画面のカスタム設定を行います。
1. 左枠内の［カスタム］をクリックします。
2. 右枠内の変更したい色のセレクタをクリックします。

カラーセレクタカスタム
パターン
3. 次のようなパレットウィンドウがポップアップ表示されます。

4. スライドバーをドラッグし、左側の四角の枠内をクリックすると、所望の色を選択できます。
5. 選択した色は、対応するフィールドと［プレビュー］画面に表示されます。
6. ［保存］をクリックし、設定を有効にします。

User's Manual - 47

VIVOTEK

システム＞ログ
ここでは、システムログをバックアップしてリモートサーバに送信するようネットワークカメラを設定する
方法を説明します。
ログサーバー設定

以下の手順でリモートログを設定します。
1. ［リモートログを有効にする］を選択します。
2. IPアドレスのテキストボックスに、リモートサーバーのIPアドレスを入力します。
3. ポートテキストボックスに、リモートサーバーのポート番号を入力します。
4. 完了したら、［保存］をクリックして、設定を有効にします。
本機能でシステムログファイルをバックアップしてリモートサーバに送信するようネットワークカメラを設定することができます。この機能を使用する前に、Kiwi Syslog Daemonのようなログ記録ツールをインストールして、ネッ
トワークカメラからシステムログメッセージを受信することをお勧めします。 http://www.kiwisyslog . com/kiwisyslog-daemon-overview/から入手できます。

システムログ

この画面では、システムログが時系列に表示されています。システムログはネットワークカメラのバッファ領域に保存され、一定量に達すると上書きされます。

48 - User's ManualVIVOTEK

付属のVAST録画ソフトウェアをインストールすると、EメールやGSM・ショートメッセージ、画面上のイベントパネルでイベントメッセージを配信したり、アラームなどをトリガーするためのイベント管理機能グループを利用したりすることができます。詳細については、［VASTユーザーマニュアル］
をご参照ください。

インターネット
スマートフォンHTTP
VIVOCloud

携帯電話

GSM

ショートメッセージ

モデム

VAST録画ソフトウェア付
サーバー

Eメール

FTP

抑止

デジタル出力PTZ

User's Manual - 49

VIVOTEK

アクセスログ

アクセスログには、すべての閲覧者(オペレータ、管理者を含む)のアクセス時刻とIPアドレスが時系列で表示されます。アクセスログはネットワークカメラのバッファ領域に保存され、一定時間が経過すると上書きされます。

パラメータログ
パラメータログには、記録、画像パラメータなど、システムパラメータに加えられたすべての変更の履歴 が含まれます。

VADPログ
VADPログには、メモリ使用量、モジュールのロードおよびアンロード情報など、オンボードVADPパッケージに関する情報が含まれています。

50 - User's ManualVIVOTEK

システム＞パラメータ［パラメータの表示］画面には、システム全体のパラメータが表示されます。技術的なサポートが必
要な 場合は、この画面に表示されている情報をご提示ください。

User's Manual - 51

VIVOTEK

システム＞メンテナンス
ネットワークカメラを工場出荷時の状態に戻す方法や、ファームウェアのバージョンアップ方法などについて説明します。
一般設定＞ファームウェアをアップグレード

この機能を使うと、ネットワークカメラのファームウェアをバージョンアップすることができます。この処理は10分以上かかる場合があります。
注意：処理の進行中は、ネットワークカメラの電源を絶対に切らないでください！
以下の手順でファームウェアをバージョンアップしてください。
1. VIVOTEKのホームページから最新のファームウェアファイルをダウンロードします（ファイル形式は.pkgです）。
2. ［参照］をクリックし、ファームウェアのファイルを探します。
3. ［アップグレード］をクリックします。カメラのファームウェアのバージョンアップが開始され、完了する と自動的に再起動します。
アップグレードが成功すると「システムを再起動します!接続を切断します」と表示されます。再起動完了後、ネット ワークカメラに再度アクセスしてください。
アップグレードに成功すると、次のメッセージが表示されます。
Reboot system now!!
This connection will close.

誤ったファームウェアファイルを選択した場合、次のメッセージが表示されます。
Starting firmware upgrade...
Do not power down the server during the upgrade.
The server will restart automatically after the upgrade iscompleted.
This will take about 1 - 5 minutes.
Wrong PKG file format
Unpack fail一般設定＞システムリブート

この機能を使用すると、ネットワークカメラを再起動できます。再起動には約 1分かかります。 完了すると、ライブ映像画面がブラウザに表示されます。再起動の処理中に次のメッセージが表示されます。

再起動後、接続に失敗した場合は、ネットワークカメラのIPアドレスをアドレスフィールドに手動で入力し、接続を再開してください。
52 - User's ManualVIVOTEK

一般設定＞元に戻す

この機能を使用すると、ネットワークカメラを工場出荷時の設定に戻すことができます。
ネットワーク：ネットワークの種類の設定を保持するには、このオプションを選択します（「ネットワークの種類」 （P.81）をご参照ください）。
カスタム言語：カスタム言語の設定を保持するには、このオプションを選択します。
VADP: VADPモジュール（SDカードに保存されたサードパーティ製ソフトウェア）および関連設定を保持します。
オプションを選択しない場合は、すべての設定が工場出荷時の状態に戻ります。初期化中は、次のメッセージが表示されます。

ファイルのインポート/エクスポート
この機能により、カスタム言語ファイル、設定ファイル、サーバーステータスレポートのエクスポートや更新を行うことができます。

User's Manual - 53

VIVOTEK

誤ったファイル形式でアップロードしようとすると、次のようなメッセージが表示されます。

言語ファイルのエクスポート：クリックして言語文字列をエクスポートします。VIVOTEKは、英語、ドイツ語、スペイ
ン語、フランス語、イタリア語、日本語、ポルトガル語、中国語(簡体字)、中国語(繁体字)の9つの言語に対応しています。
カスタム言語ファイルの更新：［参照］をクリックし、アップロードするカスタム言語ファイルを指定します。
構成ファイルのエクスポート：デバイスのすべてのパラメータとユーザー定義のスクリプトをエクスポートします。
構成ファイルの更新：[参照]をクリックして、構成ファイルを更新します。なお、デバイスの機種やファームウェアのバージョンは、構成ファイルと同じである必要があります。固定IPなどの特殊な設定をしている場合は、構成フ
ァイルの更新は推奨されません。
サーバーステータスレポートのエクスポート：時間、ログ、パラメータ、処理状態、メモリ状態、ファイルシステムの状態 、ネ ットワーク状態、カーネルメッセージなどの現在のサーバー状態レポートをエクスポートします。

ヒント：•

ファームウェアのアップグレードが停電などにより意図せず中断された場合でも、正常な動作状態に復旧させる
方法があります。カメラを復旧させる方法については、以下をご参照ください。
該当する状況：(a) ファームウェアのアップグレード中に電源が切断された。
(b) 原因不明の理由によってLEDの状態が異常となり、復旧作業を行っても正常な動作状態に戻せない。
バックアップファームウェアでカメラを起動するには、以下の方法があります。
(a) リセットボタンを1分以上長押しします。
(b) 電源はオンのまま赤色LEDが素早く点滅するまで待ちます。
(c) 起動後にはカメラは切断される前の状態に復旧します(通常の起動より5～10分ほど長くかかります)。
この処理が完了すると、LEDは通常の状態に戻ります。

54 - User's ManualVIVOTEK

メディア＞画像
ネットワークカメラの画像設定について説明します。設定画面は［一般設定］/［IR制御］/［画像設定］/［露出］/「プライバシーマスク」タブで構成されています。

一般設定

ビデオタイトル
タイムスタンプ、ビデオタイトルを表示する：選択するとライブビデオとスナップショットの画面上にビデオタ
イトルと時刻を表示します。ライブビューイングウィンドウでズームイン/アウトすると、ホーム画面に以下のようなズームインジケーターが表示されます。ライブビューイングウィンドウ内でマウスをスクロールすると画像をズームイン/アウトすることができます。最大12倍までのズームインが可能です。
ビデオタイトル
タイトルと時刻2018/7/09 17:08:56
Video 17:08:56 2018/7/09

ズームイン

ズーム倍率

ズームアウトX2.1

イメージ上のタイムスタンプとビデオタイトルの位置：タイムスタンプとビデオタイトルを、ビデオストリーム の上 部または下部に表示することができます。
タイムスタンプと動画タイトルのフォントサイズ：タイムスタンプとタイトルのフォントサイズを選択します。
ビデオフォント(.ttf)：映像に文字を表示する際に、［True Type］フォントをアップロードすることができます。
カラー：カラーまたは白黒のビデオストリームを選択できます。
電源の周波数:カメラの設置場所と一致する電源周波数を設定して、蛍光灯による画像のちらつきを削減することができます。

User's Manual - 55

VIVOTEK

ビデオの方向：ビデオの向きを選択することができます。
反転：ライブビデオの表示を垂直方向に反転します。
ミラー：ライブビデオの表示を水平方向に反転します。
ネットワークカメラが上下逆に取付けられている場合は、両方のオプションを選択して映像の向きを修正します。[反転]と[ミラー]の設定後はプリセットされた位置情報はクリアされます。
［回転］ ー

標準

フリップ

ミラー

時計回りに
90°回転

回転は時計回りに行われます。回転とフリップ
やミラーを組合せて、様々な取付位置に合わせることができます。
図中のイラストは、クリック順に並んでいます。

昼間/夜間設定

夜間モードで白黒に切り替え
このチェックボックスを選択すると夜間モード中はネットワークカメラが自動的に白黒表示に切り替わります。

56 - User's ManualVIVOTEK

IRカットフィルター
赤外線カットフィルタの自動切換えにより、暗い環境では自動的にIRカットフィルタを取り外し、センサに赤外線領域の光を通すことができます。
■ 自動モード（自動モードを選択すると、露出設定の中のプロファイルモードは利用できません）
ネットワークカメラは周囲光のレベルを判定して、IRカットフィルタを自動的にオン/オフします。

■ 昼間モード
昼間モードでは、ネットワークカメラは IR カットフィルタを常にオンにして近赤外線領域の光がセンサーへ取り込まれないようにし、変色を防ぎます。
■ 夜間モード
夜間モードでは、ネットワークカメラは IR カットフィルタを常にオフにして、近赤外線領域の光もセンサーへ取り込まれるようにし、暗い環境での感度を改善します。
■ デジタル入力との同期
照度センサーを搭載した外部IRデバイスを接続した場合、デジタル入力を利用してIRカットフィルター
切換をトリガー することができます。これにより、カメラと外部IRデバイスの照度検出を同期させることができます。
■ スケジュールモード
指定したスケジュールに基づいてネットワークカメラの昼間モードと夜間モードが切り替わります。昼間モードの開始時刻と終了時刻を入力してください。時刻の形式は24時間表示の［hh:mm］です。デフォルト
では、昼間モードの開始時刻は07:00、終了時刻は18:00に設定されています。
デイナイトの感度
赤外線カットフィルタが切り替わるときの照明条件を[低]、[標準]、[高]の３段階に調整することができます。
本画面の設定が完了したら、[保存]をクリックして、設定を有効にしてください。

User's Manual - 57

VIVOTEK

照明装置
夜間モードで内蔵IR-LEDを点灯する
この機能を選択すると、暗い環境に対応してカメラが夜間モードになったときに、カメラの内蔵IR-LEDを点灯させることができます。
Smart IR
抗露出過多：この機能を有効にすると、カメラは夜間モードで露出過多を防ぐために、内蔵されたIR照明
装置の出力を自動的に調整します。

Smart IR機能は、侵入箇所や監視対象がレンズやIRライトの近くに存在する時に特に効果的な機能です。
例えば、侵入者がカメラから3m程の範囲まで近づくような場合は、Smart IR機能で露出過多を効果的に低減できます。5mやそれ以上など、対象者までの距離が遠い場合は、Smart IRによる露出調整効果は減り、適正な露出を得ることができます。

Smart IR無効 距離：5M

Smart IR有効 距離：5M

Smart IR無効 距離：3M

Smart IR有効 距離：3M

58 - User's ManualVIVOTEK

ヒント：
近くに反射物がある場合、赤外線が反射してSmart IRの露出計算に支障をきたすことがあります。この問題を解決
す るには、露出設定ウィンドウで、反射物に「露出除外」
ウィンドウを配置することができます。設定方法はP.63をご参照ください。
また、昼間モードの設定に影響しないように、夜間モードの「プロファイル」設定で「露出除外」ウィンドウを設定することができます。

ExcludeExcludeUser's Manual - 59

VIVOTEK

画像設定
本項では、ホワイトバランスと画像の調整について説明します。

特別な条件での設定画面
通常の設定画面

ホワイトバランス：最適な色温度となるように値を調整します。
■ 自動：光源の変化に対応し、カメラの色温度を自動的に調整します。
■ 現在の値を固定：特定のホワイトバランス状態に固定させるとき、下記の手順で設定します。
1. ホワイトバランスをAuto(自動)に設定します。
2. 白色の紙を用意し、レンズの前に配置して、ネットワークカメラが自動的に色温度を調整できるようにします。
3. カメラがホワイトバランスを自動的に測定して調整した後、Fix current value(現在の値を固定)を選択し、設定を確定します。
■ マニュアル：RGain と BGain のスライドバーを動かし、色温度を手動で調整することもできます。
画像調整■ 明るさ：画像の明るさを0％～100％の範囲で調整します。
■ コントラスト：画像のコントラストを0％～100％の範囲で調整します。
■ 彩度：色の濃さを0％～100％の範囲で調整します。
■ シャープネス：画像のシャープネスレベルを0%から100%の範囲で調整します。
■ ガンマ曲線：画像のガンマ曲線を0.45～1の範囲で調整できます。通常はOptimize(最適）を選択します。「マニュアル」モードを選択し、スライドバーのポイ ンターを移動することで、画像を高コントラストまたは高輝度に調整して、画像の暗い領域と明るい領域の両方を詳細に表示することができます。
WDR機能が有効な場合、このオプションは無効になります。
曇り除去：曇り除去を使用すると、スモッグ、霧、煙等などが発生している悪天候の条件で撮影された画像の鮮明度を改善することができます。

60 - User's ManualVIVOTEK

３Dノイズリダクション
画像のノイズやちらつきを減らす機能です。このカメラには3D Noise Reduction機能が搭載されています。
スライドバーを使用して、削減効果を調整します。
3D ノイズリダクションは、暗い環境でのノイズの抑制に効果があります。しかし動く被写体を撮影する場
合に残像が発生する場合があります。このような場合は強度を下げて使用してください。
[画像設定]にはプレビューボタンはありません。加えられた変更はすべて画面に直接表示されます。
[Restore]を クリックすると、変更を適用せずに元の設定を復元することができます。設定が完了したら、[Save]をクリックして設定を有効にしてください。[Profile mode]では、タブ内のすべての設定を特定のモード時の設定値とすることもできます。

設定を有効にする：このプロファイルを適用するモードを、昼間モード、夜間モード、スケジュールモードの中から選択します。スケジュールモードを選択した場合は、時間帯を手動で入力してください。その後、［保存］にチェックを入れて設定を有効にしてください。

User's Manual - 61

VIVOTEK

露出
本項では、「露出計測ウィンドウ」、「露出レベル」、「測光モード」、「露出時間」、「ゲインコントロール」、「プロファイルモード」の設定について説明します。「露出設定」は、通常状況用と、ナイトモード/スケジュール
モード適用時などの特定のモード用の、二通りの設定ができます。

特定のモードでの設定画面

通常の設定画面

露出方法：［計測ウィンドウ］：この機能を使用して、露出を計測するための計測ウィンドウを設定すれば、被写体の背景に非常に明るい光がある場合などに効果があります。例えば、ビルの廊下を通じて入り込む明るい
日光の影響を除去できます。
■ 全画面： 画面全体に対して、適切な明るさとなるよう露出を調整します。
■ カスタム：カスタム設定されたウィンドウを手動で包含エリアまたは除外エリアとして追加することができます。合計10個までウィンドウを設定することができます。詳細は次項の図解をご参照ください。
■ オート：ファームウェアが最適な露出レベルを自動的に判定します。

62 - User's ManualVIVOTEK

包含ウィンドウは「加重領域」として設定されます。除外ウィンドウは「除外領域」として設定されます。加
重平均手法を用いて値を算出しますので、包含ウィンドウは優先度がより高く設定されます。これらのウ
ィンドウは重複させることができます。除外ウィンドウをより大きな包含ウィンドウの中に配置すると、重複したウィンドウは除外領域として認識され、包含ウィンドウの残りの部分について、露出度が算出されます。

Include

加重領域

IncludeExcludeExclude除外領域■ センター：画面の中央部分を使用して、露出レベルを決定します。

測光モード：■ 自動：カメラが自動的に露出測定を行います。
■ BLC（バックライト補正）：画面中央に「加重領域」を自動的に設定し、最適な露出となるよう調整します。
■ HLC（ハイライト補正）：強い光源を検出し、それによる影響を補正して全体の画質を改善します。例えば、
HLCはスポットライトやヘッドライトによるにじみを減少させます。

User's Manual - 63

VIVOTEK

露出コントロール：■ 露出レベル：露出レベルを-2.0～+2.0（暗い～明るい）の範囲で手動設定できます。［露出時間］や［ゲインコントロール］のスライドバー上の半円形のポインターをクリックしてドラッグすることで、シャッター速度やゲインコントロール値の範囲を指定して、カメラが自動的に最適な撮影結果を得られるように調整する ことができます。動くオブジェクトをより適切に撮影するためにはシャッター速度を短くすることをお勧めしますが、シャッター速度が短すぎると光量が減ってしまうため、ゲインを調整して補正する必要があります。
■ フリッカー補正：映像の周波数と AC 電源周波数の間に差異が生じる場合、不一致により色がシフトしたり画像がフリッカーを起こします。このような場合、Flickerless (フリッカー補正)のチェックボックスをチェ ックしてください。露出時間 (シャッター速度)の範囲が、AC 電源周波数に合わせて制限されます。たと えば電源周波数が60Hzに設定されている場合にこの機能を選択すると、露出時間は 1/120 秒以上に 強制されます。固定アイリスレンズがついたカメラの場合、露出時間を1/120 秒より短くできない
ので、 センサに過度の光量が入力され、映像が白飛びする可能性があります。

■ AE速度調整：
この機能は照明条件が素早く変化する環境を監視する場合に使用します。 例えば、夜間の高速道路の車線やパーキングエリアの入り口などをカメラで監視する必要がある際に 、ライトを点けた車が通過すると、光量が急激に変化します。また、カメラを車両に搭載した場合にお いても、同様にトンネル出入り口での急激な光の変化に対応する必要があります。

WDR：この機能を使用すれば、明るい背景と被写体とのコントラストが高い場合に、暗い部分の明るさを調整し画像をより鮮明にとらえることができます。Enable WDR enhanced （WDR 強化を有効化）のチェックボックスをチェックし、強度（低、中、高）を調整して画質を最適に設定してください。

64 - User's ManualVIVOTEK［初期化］をクリックすると、変更内容を反映させずに元の設定に戻すことができます。本項の設定が完了
したら、[保存]をクリックして設定を有効にしてください。
夜間/スケジュールモード用に別の露出設定にしたい場合は、［プロファイル］をクリックして露出設定のプ
ロファイル画面を開いてください。ただし[一般設定] > [昼間/夜間設定] > [IR カットフィルタ]の設定が自動の場合は、このプロファイルモードは開くことができません。
設定を適用可能にする：夜間モード、スケジュールモードの中からプロファイルを適用するモードを選択します。スケジュールモードを選択した場合は、時間帯を手動で入力してください。［保存］にチェックをいれて設定を有効にしてください。
下記の手順でプロファイルを設定してください：
1. ［プロファイルモード］タブを選択してください。
2. ［夜間モード］または［スケジュールモード］から適用する
モードを選択します。スケジュールモードを選択した場
合は、時間帯を手動で入力してください。
3. ［露出制御］の設定は、次に表示される画面にて行い ます。詳細については、前述の説明をご参照ください。
4. ［保存］をクリックして設定を有効にし、［閉じる］をクリッ クして終了します。

User's Manual - 65

VIVOTEK

プライバシーマスク[プライバシーマスク]をクリックして設定画面を開きます。この機能を使うと、プライバシーを守るために映像をマスキングする範囲を設定することができます。

■ 以下の手順でプライバシーマスクウィンドウを設定できます：
1. ［新規］をクリックして新しいウィンドウを追加します。
2. マウスを4回クリックして四角形の範囲を設定します。このウィンドウは、カバーし た いオブジェク ト
サイズ（高さと幅）の2倍以上であることが推奨されます。
3. ウィンドウ名を入力し、［保存］をクリックして設定を有効にしてください。
4. ［プライバシーマスクを有効にする］にチェックを入れて、機能を有効にしてください。

ノート：► 同一画面上に最大5個のプライバシーマスクウィンドウを設定できます。
► プライバシーマスクウィンドウを削除したい場合は、ウィンドウ名の横にある「×」マークをクリックしてください。

66 - User's ManualVIVOTEK

ピクセルカウンター
画面下部の［追加］ボタンをクリックして、ピクセルカウンターのウィンドウを作成します。ウィンドウをクリックして目的のエリ アに移動した後、ウィンドウのサイズを変更してください。
ウィンドウの下部に画素数が表示されます。これによって、例えば通行人の顔を認識する場合、現在の設定で要件を満たしているかどうかを計算することができます。

算出された画素数は、各ビデオスト リ ーム毎に 画面の下部に一覧表示されます。

1

2

Pixel Calculator

User's Manual - 67

VIVOTEK

メディア＞ビデオ
ストリーム設定

このネットワークカメラは、フレームサイズが480x272～1920x1080ピクセルのマルチストリームに対応しています。
マルチストリームの指定：■ ストリーム1：既定のフレームサイズは1920 x 1080に設定されています。
■ ストリーム2：既定のフレームサイズは1280 x 720に設定されています。

「モニタ領域」を定義することができます。

[表示ウインドウ]をクリックして、モニタ領域の設定ページを開きます。このページでビデオストリームのモ
ニタ領域のフレームサイズを設定してください。例えば、下図の例では監視対象である駐車場の車だけを表示するようにトリミングして青空の部分を削除し、ビデオストリームの送信に必要な帯域幅を節約することもできます。

68 - User's ManualVIVOTEK

下記の手順でストリームの設定をおこなってください：
1．ドロップダウンリストからモニタ領域を選択します。カスタマイズした表示領域を設定する
場合は、マウスでフローティングフレームサイズを変更し、目的の位置にドラッグすることもできます。
2．お使いの監視デバイスに合わせて、ドロップダウンリストから適切な［モニタ領域］ を選択してください。

ノート：► 「モニタ領域」の設定内容はストリーム２の最大解像度以下となるように設定してください。
■ 複数ストリームのパラメータ：
ストリーム1
ストリーム2モニタ領域

出力フレームサイズ

設定できません。
1280 x 720 ~ 480 x 272 (選択可能)

1920 x 1080 ~ 480 x 272 (選択可能)
1280 x 720 ~ 480 x 272 (選択可能)

表示ウィンドウの設定が完了したら、［保存］をクリックして設定を有効にし、［終了］をクリックしてウィンド
ウを閉じます。選択した［出力フレームサイズ］は、各ビデオストリームの［解像度］に即座に適用されます。
その後、ホーム画面に戻り、e-PTZ機能をテストすることができます。e-PTZ機能の詳細について は、
P.114をご参照ください。

X2.1

関心エリア
（表示エリア）

出力フレームサイズ（ライブビューウィンドウのサイズ)

User's Manual - 69

VIVOTEK

ストリーム項目をクリックすると、詳細情報が表示されます。解像度は、上記「表示ウィンドウ」 での設定に従います。

このネットワークカメラは、リアルタイムのH.265、H.264、MJPEGの圧縮規格（トリプルコーデック）に対応しています。H.265またはH.264モードを選択した場合、映像はRTSPプロトコルでストリーミングされます。映像画質を調整するための、複数のパラメータがあります。

■ 解像度
映像を表示するデバイスごとに異なる解像度を設定することができます。例えば、携帯電話を用いてリモートで映像を表示する場合には解像度を小さく、ビットレートを低く設定します。Webブラウザでライブ表示したりNVRにストリームを録画したりする場合には、解像度を大きく、ビットレートを高く設定することが可能です。
■ 最大フレームレート
1秒あたりの最大フレームレートを設定します。フレームレートを高く設定すると、映像の動きが滑らかになり、動いている対象物を認識することが容易になります。
電源周波数が50Hzの場合、フレームレートは1/2/3/5/8/9/10/12/15/20/24fps、最大25fpsから選択可能です。電源周波数が60Hzの場合、フレームレートは1/2/3/5/8/9/10/12/15/20/24/25fps、最大30fpsから選択可能です。［カスタマイズ］を選択し、手動で値を入力することもできます。

70 - User's ManualVIVOTEK

解像度を高く設定すると、フレームレートが低下します。
■ イントラフレーム期間
I フレームを挿入する間隔を決定します。間隔が短いほど画質は向上しますが、ネットワーク帯域幅の消費量は増加します。1/4秒、1/2秒、1秒、2秒、3秒、4秒から選択することができます。

■ Smart stream III■ ダイナミックイントラフレーム
H.265などの高品質モーションコーデックは、ビデオフレーム間の冗長性を利用し画質とビットレートのバランスを調整してビデオストリームを配信します。
下図は符号化パラメータを要約したものです。
I フレームはフレーム内すべての情報を保持しており、サイズは大きくなります。一方、P フレームは前方向予測を用いて符号化されたフレームで、エンコーダは冗長性のある画像情報のために前のI フレームを参照します。
H.264/265フレームタイプ

P I P P P P P P P I

P P P P P P P I

I フレームの挿入間隔を最大10秒まで動的に延長すると、ビデオストリーミングに必要なビットレートを大幅に削減できます。この機能を使用すると、静的シーンの映像をストリーミングする場合、帯域幅を最大53%節約できます。節約される帯域幅の量は、フレーム間の動き予測によっても変わります。シーンに動きがある場合、映像品質維持のために I フレームの挿入間隔を自動的に短縮します。
一方、暗い場所や夜間のシーンでは、ノイズによりP フレームのサイズが大きくなる傾向があり、帯域幅の節約効果は小さくなります。
通常、一般的な2MPのストリーミングには、3～ 4Mb/秒の帯域幅が必要です。この機能を使用すると、中程度の動きの場面をストリーミングするための帯域幅を2～ 3Mb/秒に、動きの少ないシーンでは500kb/
秒にまで削減することができます。

静止場面でのダイナミ ックイントラフレーム

P I

P P P P P P P P P P P P P P P P P P P I

静止場面

動きのある場面でのダイナ ミックイントラフレーム
P I

P P P P P P P I

P P P P P P P I P P P

動きのある場面

User's Manual - 71

VIVOTEK

H.265コーデックを使用しダイナミックイントラフレームをSmart Stream機能と組み合わせると、H.264を使用した場合に比べておよそ80%の帯域幅を節約することができます。

■ Smart FPS
静止場面では、シーン内に動きがない場合、アルゴリズムは古いフレームをキューに入れます。動きがあると、エンコーディングが再度始まりリアルタイムストリーミングを配信します。

f1

f1

f1

f1

f5

f5

f5

f5

f9

f5

f6

f7

f8

f9

モーション発生

f1

f1

f3

f4

静止場面の古いフレームをキューに入れることで、カメラの負荷とP フレームのサイズの両方を削減することができます。またフレームレートを低下させないためにも効果的です。
シーンに動きがあったときに、スマート FPS から通常のエンコーディングに戻すためのフレーム間差分のしきい値は1%です。

ノート：
Smart Stream IIに対し、Smart Stream IIIには2つの設定オプション「Smart Q」と「Smart FPS」が追加されてい ます。

72 - User's ManualVIVOTEK•

スマートコーデック： スマートコーデックは全体または画面上の重要ではない領域の画質を効果的に低下させ、消費される帯域幅を削減します。
重要な領域（ROI)と重要ではない領域(非ROI)の画質を手動で指定できます。

スマートコーデックを使用するときは下記の動作モードを選択します。
- 自動トラッキング：このモードでは、まず画面全体が非ROI領域に設定されます。画面の一部に動きがあると、動きのある領域が自動的にROI領域に設定され、高画質で伝送されます。そのほかの領域は低画質のまま伝送されます。
- 手動：手動モードでは画面上に3つのROIウインドウを設定できます。ROIウインドウに含まれていない領域は非ROI領域と見なされます。ROI領域は、高画質で送信されます。
下図の例は、画面の上半分は重要ではない領域(非ROI)として、画面の下半分は重要な領域(ROI)として設定した例です。(歩道など)

非関心

ROI_0

X

ROI_0

X

User's Manual - 73

VIVOTEK

この結果、画面の下半分は常に高精細に表示され、画面の上半分は低画質で送信されます。上半分の画質は劣りますが、画面全体では一連の映像として何が起きているかを認識することができます。

非ROI：低 品 質

ROI：高品質- ハイブリッド：「手動」モードと「ハイブリッド」モードの主な違いは、以下の通りです。
「ハイブリッド」モードでは、非ROI領域の被写体に動きがあった場合、対象の被写体とその周囲の画質が自動的に改善されます。
「手動」モードでは、非ROI領域は内部の被写体に動きがあっても常に低画質で送信されます。

- 品質の優先度：ROIと非ROI領域の画質の差をスライドバーで調整することができます。
スライドゲージが右側にあるほど、ROI領域の画質は高くなります。反対に、スライドゲージを左に移動すると、非ROI領域の画質が高くなります。
たとえば、ROIウインドウで保護エリアをカバーして、この機能で画質を調整すれ
ば、ROIウインドウをプライバシーマスクのように設定することができます。その逆の設定も可能です。
スマートストリームの高画質映像と低画質映像の両方の帯域幅消費量を抑制するには、[最大ビットレート] をプルダウンメニューからしきい値として設定してください。

74 - User's ManualVIVOTEK■ ビットレートコントロール

制約付きビットレート：
複雑なシーンでは一般にファイルサイズが大きくなるため、データ転送に必要な帯域幅が大きくなります。そこで、利用する帯域幅のレベルを選択して設定することが有効です。このモードでは映像品質は変化します。利用する帯域幅は、20/30/40/50/64/128/256/512/768Kbps、または1/2/3/4/6/8/10/12/14/16/18/20/24/28/32/36/40Mbpsのビットレートの中から選択することができます。また[カスタマイズ]を選択し手動で40Mbpsまでの値を入力して設定することもできます。
•-目標画質：所望の画質を「中」～「高」の範囲で選択します。
- 最大ビットレート：プルダウンメニューからビットレートを選択します。ビットレートの範囲は20kbps～最大40Mbpsです。このビットレートは、平均的な映像における上限のビットレート
値になります。ネットワークカメラはビットレートの制限内もしくは制限に沿った形でビデオス
トリームを配信します。
- ポリシー：「フレームレート優先」を選択した場合、ネットワークカメラは1秒あたりのフレー
ムレート数の維持を優先しますが、画質は低下することがあります。一方、[Image Quarity
Priority]を選択すると、ネットワークカメラは画質の維持を優先します。この場合、フレームレート数が低下することがあります。
Smart Q：ON/OFFを選択して本機能を有効/無効にします。Smart Qはシーン認識を行い、以下の方法でビットレート消費量を低減します。
■ 光量の少ないフレームで、輝度の異なるシーンの画質を動的に調整することができます。ノイズが少ないということは、消費する帯域も少ないということです。
■ I フレームとPフレームで異なる品質を裏書きすることで、フレームサイズを小さくすることができます。
■ 1つのフレームを分割して、それぞれに異なる品質を与えることができます。草木が生い茂っていたり、窓が網戸になっていたり、パターンが繰り返されていたり（壁紙のような複雑な布地のパターン）するような複雑性の高いエリアでは、画質の値を低くしても人間の目にはほとんど影響がありません。
不必要な画質設定は人間の目には認識されず、ビットレートを浪費します。

スマート Qストリーミングは、照明条件が異なっていても、同じ画像品質を維持しながら、最大50%から80%の帯域幅を節約することができます。（これらの数値は、Smart Stream IIとSmart Stream IIIのストリーミングを比較したものです。）

User's Manual - 75

VIVOTEK

固定画質(品質調整）：「固定画質」を選択すると、すべてのフレームが同じ画質で送信されます。帯域幅はシーンによって変動します。映像画質は[中]、[標準]、[良好]、[詳細]、[最高] の中から設定することができます。また、[カスタマイズ]を選択し手動で値を入力することもできます。
最大ビットレート：画質優先の場合でも、帯域幅やストレージを考慮してビデオストリームのサイズを制御するビットレートの制限を設定することができます。1Mbps～40Mbpsの間でビットレートを設定することが可能です。
「固定画質」設定の「最大ビットレート」設定により、ネットワーク帯域幅を制限しつつ適切に利用することができます。例えば、「固定画質」設定が適用されている低照度条件下でゲインアップでノイズが増え、ビットレートが増えるような場合に有効です。
また、［カスタマイズ］を選択して、手動で最大ビットレートの値を入力することができます。

76 - User's ManualVIVOTEKMJPEGモードを選択すると、連続したJPEG画像をクライアントに送信し、複数の静止画を連続して表示することで動きのある映像として表示することができます。転送されるすべてのJPEG画像は同じ画質となります。また、JPEG画像の組み合わせであるため、オーディオデータはクライアントに送信することができません。JPEGモードでは、ビデオ設定のため3つのパラメータが用意されています。

■ 解像度
映像を表示するデバイスごとに異なる解像度を設定することができます。例えば、携帯電話を用いてリモートで映像を表示する場合には解像度を小さく、ビットレートを低く設定し、Webブラウザでライブ表示
する場合には、解像度を大きく、ビットレートを高く設定します。解像度を大 きくすると、帯域幅を多く消費することにご注意ください。
■ 最大フレームレート
1秒あたりの最大リフレッシュレートを制限する機能です。フレームレートを高く設定すると、より滑らかな映像品質が得られます。
電源周波数が50Hzの場合、フレームレートは1/2/3/5/8/9/10/12/15/20/24/25fpsの中から選択可能です。電源周波数が60Hzの場合、フレームレートは1/2/3/5/8/9/10/12/15/20/24/25/30fpsから選択可能です。また、［カスタマイズ］を選択して手動で値を入力することもできます。高解像度を選択した場合、フレームレートが下がることがあります。
■ ビデオ目標品質
前述の平均値または上限値の閾値の設定を参照し、モーションJPEGの転送で消費する帯域の制御設定を行います。設定方法はH.264の場合と同様です。

「制約付きビットレート」やその他の設定に関しては、前述の説明をご参照下さい。

ノート：► 一般に圧縮率を小さくすると画質は良くなりますが、データ量は増加します。
► 高品質なビデオ設定は、CPU の負荷を大幅に増加させ、複雑なシーンの映像などでストリーミングの切断やビデオデータの破損が発生するおそれがあります。問題が発生した場合は、ビデオ設定をカスタマイズして解像度を低くしたり、フレームレートを下げてスムーズなビデオを伝送できるようにしてくだ
さい。

User's Manual - 77

VIVOTEK

メディア＞オーディオ
オーディオ設定

ミュート：ネットワークカメラからすべてのクライアントへの音声送信を無効にするには、このオプションを選択します。ミュートモードがオンの場合、［クライアント設定］画面で音声送信を有効にしていても、音声デー
タは送信されません。このような場合は、次のメッセージが表示されます：

内蔵マイクの増幅率：周囲の環境に応じて内蔵マイクのゲインを選択します。ゲインは0％（最小）～ 100％（最大）の間で調整できます。
音声の種類：オーディオコーデックをG.711またはG.726から選択し、ビットレートを選択します。
■ G.711は高音質で、64Kbps程度を必要とします。「pcmu（μ-Law）」または「pcma(A-Law)」モードを選択します。
■ G.726は、16、24、32、40kビット/秒の音声送信に対応する音声コーデック規格です。
設定完了後、［保存］をクリックして設定を有効にしてください。

78 - User's ManualVIVOTEK

メディアプロファイル
２つのデフォルトプロファイルおよび全部で7種類のストリームプロファイルを設定できます。
ストリーム番号、解像度、使用コーデック、フレームレートなど、ビデオストリームに関連する情報が表示されます。また、ビデオ、オーディオ、「メタデータ設定」用の「マルチキャストポート番号」とアドレスも表示されます。

User's Manual - 79

VIVOTEK

ネットワーク＞一般設定
ネットワークカメラの有線ネットワーク接続の設定について説明します。
ネットワークタイプ

LAN
ネットワークカメラがローカルエリアネットワーク（LAN）上にあり、ローカルPCからアクセスする場合に、このオプションを選択します。お買い上げ時の設定はLANになっています。設定の完了後、必ず[保存]ボタ
ンをクリックし、設定を保存してください。
自動的にIPアドレスを取得：このオプションを選択すると、カメラはLANに接続されるたびにDHCPサーバー
によって割り当てられる使用可能なIPアドレスを取得します。
固定IPアドレスを使用：ネットワークカメラに手動で固定IPアドレスを割り当てるには、このオプションを選択します。

1. VIVOTEK のWEB サイトからShepherd をインストールして起動すると、LAN上のネットワークカメラを簡単に設定することができます。詳細は、「ソフトウェアのインストール」（P.14）をご参照ください。
2. ネットワーク管理者から提供された静的IP、サブネットマスク、デフォルトルーター、プライマリ DNSを入力します。
サブネットマスク：アドレスが同じサブネット内にあるかどうかを判別するために使用します。デフォルト値
は 「255.255.255.0」です。
デフォルトルーター：フレームを別のサブネットのアドレスに転送するために使用されるゲートウェイのIPア
ドレ スです。ルーター設定が無効な場合、異なるサブネット間のアドレスへの送信は無効になります。

80 - User's ManualVIVOTEKDNSサーバー1：ホスト名をIPアドレスに変換するプライマリドメインネームサーバーです。
DNSサーバー2：プライマリDNSをバックアップするセカンダリドメインネームサーバーです。
プライマリWINSサーバー：コンピュータ名とIPアドレスのデータベースを管理します。
セカンダリWINSサーバー：コンピュータ名とIPアドレスのデータベースを管理します。
UPnPプレゼンテーションを有効にする：ネットワークカメラの「UPnPTMプレゼンテーション」が有効になり、ネットワークカメラがLANに接続されると、ネットワークカメラへのショートカットが「マイネットワー ク」に常に表示されるようになります。ショートカットをクリックすると、Webブラウザにリンクします。現在、「UPnPTM 」
は、WindowsXP以降に対応しています。この機能を利用するには、「UPnPTM コンポーネント」がコンピュー
タにインストールされている必要があります。

Mega-pixel Network Camera (192.168.5.151)

UPnPポート転送を有効にする：このオプションを選択すると、インターネットからアクセスしたネットワークカメ
ラが自動的にルータのポートを開いて、LANからビデオストリームを送信することができます。この機能を利用するには、ルータがUPnP™をサポートしており、有効になっている必要があります。

PPPoE（Point-to-point over Ethernet)
このオプションを選択すると、インターネットに接続されていれば、どこからでもネットワー ク カメラにアクセスできるように設定できます。この機能を利用するには、ISPから提供されるアカウントが必要になります。
次の手順でネットワークカメラのパブリックIPアドレスを取得してください。
1. ネットワークカメラをLAN上に設置する。
2. ［設定」＞「イベント」＞「イベント設定」＞「サーバーの追加」（P.122「サーバーの追加」参照）の順にクリックします。新規EメールまたはFTPサーバーを追加します。
3. ［設定］＞［イベント］＞［イベント設定］＞［メディアを追加］（P.130「メディアを追加」参照）の順にクリックします。「システムログ」を選択すると、ネットワークカメラのパブリックIPアドレスを含むTXTファイル形式のシス
テムログがEメールまたはFTPサーバーから受信することができます。
4. ［設定］＞［ネットワーク］＞「一般設定」＞「ネットワークの種類」の順にクリックします。「PPPoE」を選択しISP から提供されたユーザー名とパスワードを入力します。［保存］をクリックして設定を有効にしてください。

5. ネットワークカメラを再起動します。
6. ネットワークカメラの電源を切るときは、LAN環境からカメラを取り除いてください。
User's Manual - 81

VIVOTEK

ノート：► 同じルーターを使用中の他のデバイスがデフォルトポートを使用している場合、ネットワークカメラは、
別 のポートを選択します。
► ルーターが「UPnPTM」をサポートしていない場合、次のようなメッセージが表示されます。
Error: Router does not support UPnP port forwarding.
► お使いのPCで「UPnPTM」のユーザーインターフェースを次の手順で有効にしてください：「UPnPTM」コンポーネントをインストールするには、システム管理者としてパソコンにログインする必要があります。

1. ［スタート]＞[コントロールパネル]＞[プログラムの追加と削除]の順にクリックします。

2. ［プログラムの追加と削除」ダイアログボックスで、「Windowsコンポーネントの追加と削除」をクリックします。

3. ［Windowsコンポーネントウィザード］ダイアログボックスで、［ネットワークサービス］を選択し［詳細］をクリックします。

82 - User's ManualVIVOTEK

4. [ネットワークサービス]ダイアログボックスで、[ユニバーサルプラグアンドプレイ]を選択して、[OK]をクリックします。

5. 続いて表示される画面で［次へ］をクリックします。

6. ［完了］をクリックすると「UPnPTM」が有効になります。
► 「UPnPTM」は次のように機能します。

「UPnPTM」ネットワーク技術により、ネットワークに追加されたデバイスの自動的なIP設定と動的な検出 を行います。印刷やファイル共有など、ネットワークに接続されたデバイスが提供するサービスや機能 を、面倒なネットワーク設定をすることなく相互に利用することができます。ネットワークカメラの場合、 「 マイネットワーク」の下に「ネットワークカメラ」のショートカットが表示されます。

► 「UPnPのポートフォワーディング」を有効にすると、ネットワークカメラはHTTPポートではなくセカンダリ

HTTPポートをルーターに開放します。インターネット経由のネットワークカメラへのアクセスには、ネット
ワークカメラのパブリックアドレスにセカンダリHTTPポート番号を追加する必要があります。たとえば、
HTTPポートを80、セカンダリHTTPポートを8080に設定する場合の、ネットワークカメラのIPアドレスは 以
下のリストをご参照ください。
インターネット経由
http://203.67.124.123:8080

LAN内
http://192.168.4.160 or
http://192.168.4.160:8080► PPPoEの設定が間違っている場合や、インターネットに接続できない場合は、ネットワークカメラを工場

出荷時の状態に戻してください（詳細は「初期化」（P.53）をご参照ください）。工場出荷時の設定に戻す
ことで、LAN上でネットワークカメラにアクセス可能になります。

User's Manual - 83

VIVOTEK有効IPv6
このオプションを選択し、［保存］をクリックしてIPv6設定を有効にします。
ネットワーク環境およびハードウェアデバイスがIPv6に対応している場合のみ動作します。

IPv6を有効にすると、デフォルトでは、ネットワークカメラはルーター通知（RA）を確認し、それに応じてリンクローカルIPv6アドレスが割り当てられます。
IPv6情報：このボタンをクリックし、以下のIPv6情報を取得します。

IPv6設定が成功すると、ポップアップウィンドウにIPv6アドレスの一覧が表示されます。
IPv6アドレスは、次のように表示されます：

イーサネット

リンク‐グローバルIPv6アドレス/ネットワークマスク
リンク‐ローカルIPv6アドレス/ネットワークマスク

84 - User's ManualVIVOTEK

以下の手順でIPv6アドレスにリンクさせます：
1. Webブラウザを起動します。
2. Webブラウザのアドレスバーに、リンク‐グローバルまたはリンク‐ローカルのIPv6アドレスを入力してください。
3. 形式は右図の通りです。

IPv6アドレス4. キーボードのEnterキーを押すか［更新］ボタンをクリックすると、Webページが更新されます。
（例）

ノート：
► セカンダリHTTPポート(デフォルト値は8080)がある場合は、次のアドレス形式でWebページにリンクさせることもできます(詳細は、「HTTPストリーミング」(P.87)をご参照ください)。

IPv6アドレスress

セカンダリHTTPポート► ［ネットワークの種類］にPPPoEを選択した場合、IPv6情報欄に[PPP0アドレス]が次のように表示されます。

IPアドレスを手動で設定：ネットワーク環境にDHCPv6サーバーやルーター通知対応のルーターがない場
合にIPv6を手動で設定するには、このオプションを選択します。この項目にチェックを入れると、以下のような空欄が表示されますので、該当する情報を入力してください。

User's Manual - 85

VIVOTEK

86 - User's ManualVIVOTEK

ネットワーク > ストリーミングプロトコル
ノート：
メタデータ情報は、HTTPのメインポート経由のみ送信可能です。HTTPのセカンダリポート経由ではメタデータは利用できません。

HTTPストリーミング
HTTP認証を利用する際はネットワークカメラにパスワードが設定されていることを確認してください。詳細は、［セキュリティ］＞［ユーザーアカウント］（P.99）をご参照ください。

認証：ネットワークのセキュリティ要件に応じ、ネットワークカメラはHTTPトランザクションに2種類のセキュリティ設定（ベーシックとダイジェスト）を提供しています。
ベーシック認証を選択した場合、パスワードはテキスト形式で送信され、傍受される危険性があります。ダイジェスト認証を選択した場合、ユーザー情報はMD5アルゴリズムを使用して暗号化されるため、不正なアクセスからより安全に保護されます。
HTTPポート／セカンダリHTTPポート：デフォルトでは、HTTPポートは80に、セカンダリHTTPポートは8080に設定されています。また、1025～65535の間で別のポート番号を割り当てることも可能です。ポートの割り当てに誤りがある場合、以下の警告メッセージが表示されます。

LAN上のネットワークカメラへのアクセスに、HTTPポートとセカンダリHTTPポートの両方を使用することができます。たとえば、HTTPポートを80、セカンダリHTTPポートを8080に設定した場合、ネットワークカメラのIPアドレスは次のようになります。
LAN上http://192.168.4.160 or
http://192.168.4.160:8080

ストリーム1～2のアクセス名：ネットワークカメラは、複数の同時ストリームに対応しています。アクセス名
は、異なるビデオストリームを識別する目的で使われます。ユーザーは、［メディア］＞［ビデオ］＞［ストリーム設定］をクリックして、リンクされたストリームのビデオ画質を設定できます。ビデオ画質の設定方法の詳細は、「ストリーム設定」（P.68）」をご参照ください。
ブラウザを使用してネットワークカメラにアクセスする際、ビデオモードがJPEGに設定されている 場合は、連続したJPEG画像で構成された映像を受信することができます。

User's Manual - 87

VIVOTEKURLコマンド―http://<IPアドレス>:<httpポート>/<ストリーム1、2用のアクセス名>
例えば、ストリーム2のアクセス名をvideo1s2.mjpgに設定した場合：
1. ブラウザを起動します。
2. アドレスバーに上記のURLコマンドを入力し、Enterキーを押します。
3. JPEG画像がWebブラウザに表示されます。

http://192.168.5.151/video1s2.mjpg

RTSPストリーミング
RTSPストリーミング認証を利用するには、まずビデオストリームへのアクセスを制御するためのパスワードが設定されていることを確認してください。詳細は［セキュリティ］＞［ユーザーアカウント］（P.99）をご参照く
だ さ い。

88 - User's ManualVIVOTEK

認証：ネットワークのセキュリティ要件に応じて、ネットワークカメラには、RTSPプロトコルでストリーミングするための3種類のセキュリティ設定（無効、ベーシック、ダイジェスト）が用意されています。
ベーシック認証を選択した場合、パスワードはテキスト形式で送信され、傍受される危険性がありま す。
ダイジェスト認証を選択した場合、ユーザー情報はMD5アルゴリズムを使用して暗号化されるため、不正なアクセスからより安全に保護されます。
3つの認証モードによるRTSPストリーミングの可否は以下の通りです：
VLC
無効
基本
ダイジェストO
O
X

ストリーム1～2のアクセス名：ネットワークカメラは、同時に複数のストリームをサポートします。アクセス
名は、ストリーミングのソースを識別する目的で使用されます。
RTSPプレーヤーを使ってネットワークカメラにアクセスする場合、ビデオモードをH.264またはH.265に設定
し、以下のRTSP URLコマンドでストリーミングデータの送信を要求する必要があります。
rtsp://<IPアドレス>:<RTSPポート>/<ストリーム1〜2用のアクセス名＞
例えば、ストリーム1のアクセス名をlive1s1.sdpと設定した場合：
1. RTSPプレーヤーを起動します。
2. ［ファイル]＞[URLを開く]を選択します。URLダイアログボックスがポップアップ表示されます。
3. テキストボックスに上記のURLコマンドを入力します。
4. ライブ映像は、以下のようにプレーヤーに表示されます。

RTSPポート /映像・音声用RTPポート /映像・音声用RTCPポート■ RTSP（Real-Time Streaming Protocol）は、ストリーミングメディアの配信を制御します。デフォルトでは、ポ
ート番号は554に設定されています。
■ RTP（Real-time Transport Protocol）は、映像・音声データをクライアントに配信するために使用されます。
デフォルトでは、映像用のRTPポートは5556に設定されています。
■ RTCP（Real-time Transport Control Protocol）は、インターネットの通信量を監視して、ネットワークカメラにデータを送信させるためのプロトコルです。デフォルトでは、ビデオ用のRTCPポートは5557に設定されています。
ポートは1025～65535の範囲で変更可能です。RTPポートは必ず偶数で、RTCPポートはRTPポート番号に1を加えたものであるため、奇数となります。RTPポートが変更されると、それに応じてRTCPポートも変更されます。
RTPポートの割り当てに誤りがあった場合、以下の警告メッセージが表示されます。

User's Manual - 89

VIVOTEK

ストリームのマルチキャスト設定：各項目をクリックすると、詳細な設定情報が表示されます。
ビデオストリームのマルチキャストを有効にするには、［メディアプロファイル］［ストリームプロファイル設定］の［このスト リームプロファイルを常にマルチキャストする］を選択します。

ユニキャストビデオ送信は、ポイントツーポイント接続によってストリームを配信します。
一方、マルチキャストは、マルチキャストグループアドレスにストリームを配信し、マルチキャストグループア
ドレスからのコピーを要求することで、複数のクライアントが同時にストリームを取得できるようにします。
そのため、マルチキャストを有効にすることで、インターネットの帯域を効果的に節約することができます。
ポートは1025～65535の範囲の値で変更可能です。マルチキャストRTPポートは必ず偶数で、マルチキャ
ストRTCPポート番号はマルチキャストRTPポート番号に1を加えたものであるため、奇数となります。
マル チキャストRTPポートが変更されると、それに伴いマルチキャストRTCPポートも変更されます。
マルチキャスト RTP ビデオポートの割り当てに誤りがある場合、以下の警告メッセージが表示されます。

90 - User's ManualVIVOTEK

マルチキャストTTL [1～255]：マルチキャストTTL（Time To Live）は、ルーターへのパケット転送可能範囲を示す値です。
初期TTL
0
1
32
64
128
255

対象範囲
同一ホストに限定
同一サブネットワークに限定
同一サイト内に限定
同一領域内に限定
同一大陸に限定
範囲に制限なし

重要：［マルチキャストメタデータポート］は、VIVOTEK VADPモジュールによって利用され、ネットワークカメラと、映像解析を実行・観測するクライアント側との間で、映像解析結果、PTZストリーム、テキストデータ、イベ
ントメッセージの転送を行うために使用されます。クライアント側のPCがローカルネットワーク外にある場
合、ルーターやファイアウォールで関連するTCPポートを開く必要があります。

User's Manual - 91

VIVOTEK

ネットワーク＞DDNS
ネットワークカメラのダイナミック・ドメイン・ネーム・サービス（DDNS）を設定する方法を説明します。
DDNSは、ネットワークカメラのIPアドレスが動的な場合、ホスト名とドメイン名を固定するためのサービスです。
エクスプレスリンク
エクスプレスリンクは、VIVOTEKサーバーが提供する無料サービスで、ネットワークデバイスにドメイン名を登録することができます。1つのURLには1つのMACアドレスしかマッピングできません。
このサービスは、ホスト名が有効かどうかを調べ、自動的にルーターにポートを開きます。DDNSを使用する場合、ユーザーはUPnPポートフォワーディングを手動で設定する必要があります。エクスプレスリンクなら便利で簡単に設定することができます。

以下の手順でエクスプレスリンクを有効にしてください。
1. ルーターがUPnPポートフォワーディングに対応しており、有効になっていることを確認してください。
2. ［エクスプレスリンクを有効にする］にチェックを入れます。
3. ネットワークデバイスのホスト名を入力し、［保存］をクリックします。ホスト名が他のデバイスに使用されている場合は、警告メッセージが表示されます。ホスト名が有効な場合は、以下のようなメッセージが表示されます。

https://0002D1123456.2bthere.net

92 - User's ManualVIVOTEK

手動セットアップ
DDNS：ダイナミック・ドメイン・ネーム・サービス

DDNSを有効にする：DDNS設定を有効にするには、このオプションを選択します。
プロバイダー：プロバイダーのドロップダウンリストから、DDNSプロバイダーを選択します。
現在、safe100.netのサービスは終了しております。
なお、本機能をご利用になる前に、ダイナミックドメインアカウントのお申し込みをお願いします。

DDNSプロバイダーを選択する際にダイナミックドメインアカウントを申請するには、以下のリンクをご参照ください。
■ Dyndns.org(Dynamic) / Dyndns.org(Custom): http://www.dyndns.com/

User's Manual - 93

VIVOTEK

ネットワーク＞QoS(Quality of Service)
QoSとは、ネットワーク上の様々なサービスに対して一定の品質を保証するリソース予約制御の仕組みを意味します。ネットワーク容量が不足している場合、特にリアルタイムストリーミング用マルチメディアアプ
リケーションの使用時は、サービス品質の保証が重要です。品質とは、例えば、ビットレートの維持、低遅延、パケットドロップがない、等と定義することができます。
QoSに配慮したネットワークの主なメリット：■ トラフィックに優先順位をつけ、データの流れに一定の性能を保証します。
■ アプリケーションごとに使用できる帯域を制御できるため、ネットワーク上でより高い信頼性と安定性を提供することができます。

QoSの要件
ネットワーク環境でQoSを利用するためには：■ ネットワーク上のすべてのネットワークスイッチとルーターがQoSをサポートしている必要があります。
■ ネットワークで使用するネットワークビデオデバイスでQoSが有効になっている必要があります。

QoSモデルCoS（VLAN 802.1pモデル）
IEEE802.1pは、OSIレイヤー2(データリンク層)でCoS(Class of Service)と呼ばれるQoSモデルを定義しています。これは、VLANのMACヘッダーに3ビットの値を付加し、0（最低）～7（最高）までのフレーム優先度を示すものです。この優先順位はネットワークスイッチで設定され、ネットワークスイッチは異なるキューイン
グ規則を使用してパケットを転送します。
以下はCoSの設定画面です。スイッチの［VLAN ID］（0～4095）を入力し、各アプリケーションの優先度（0～7）を選択します。

［ビデオ］を最高レベルに設定した場合、スイッチはビデオパケットを最初に処理します。

ノート：► VLANスイッチ(802.1p)が必要です。CoSが正しく設定されていない場合、Web閲覧ができないことがあります。
►CoS技術は、帯域幅や配信時間などのサービスレベルを保証するものではなく、"ベストエフォート"を提供するものです。ユーザーは、CoSを「きめの粗い」トラフィック制御、QoSを「きめの細かい」トラフィック制御と考えることができます。
► CoSの管理は簡単ですが、L2プロトコルに基づいているため、拡張性に欠け、徹底した保証ができません。

94 - User's ManualVIVOTEKQoS/DSCP(差別化サービスモデル)
DSCP-ECNはレイヤー3（ネットワーク層）でのQoSを定義づけします。差別化サービス（DiffServ）モデルは、
パケットマーキングとルーター・キューイング規則に基づいています。 パケットマーキングは、
DSCP(Differentiated Services Codepoint)と呼ばれるフィールドをIPヘッダーに追加することにより行われます。これは6ビットのフィールドで、64種類のクラスIDを提供します。あるパケットがどのように転送されるかを示すもので、PHB（ホップ単位動作）として知られています。PHBは、帯域幅、キューイング理論、ドロッ
プ（パケットの破棄）決定の観点から、特定のサービスレベルを記述しています。各ネットワークノードのルーターは、パケットをそのDSCP値によって分類し、特定の転送処理（たとえば、そのために必要な帯域の確保）を行います。
DSCPの設定項目です。アプリケーション毎にDSCP値（0〜63）を指定します。

なお、ネットワークデバイスの販売代理店によっては、異なる方法論や独自の実装を提供している場合があります。以下は、Cisco社製スイッチの対応情報の例です。DSCPタグ値をネットワークデバイスが提供する情報に従って入力する必要があります。

32

QoSベースライン／テクニカル・マーケティング分類/マーキング 推奨

IPルーティング
音声
インタラクティブ映像
ストリーミング映像
ローカル定義のミッション
クリ ティカル・データ
コールシグナリング
トランザクションデータ
ネットワーク管理
バルクデータレイヤー 2 CoS/MPLS EXP

レイヤー3分類

アプリケーション
IPP
6
5
4
4

PHB
CS6
EF
AF41
CS4

DSCP
48
46
34
32

6
5
4
4

3

-

25

3

3
2
2
1

AF31/CS3
AF21
CS2
AF11

26/24
18
16
10

3
2
2
1

QoS B

User's Manual - 95

VIVOTEK

ネットワーク＞SNMP（Simple Network Management Protocol）
ネットワークカメラのSNMPの使用方法について説明します。簡易ネットワーク管理プロトコル（SNMP）
は、ネットワークデバイス間の管理情報の交換を容易にするアプリケーション層のプロトコルです。
ネットワーク管理者は、ネットワークデバイスをリモートで管理し、ネットワークの問題を簡単に発見し、解決することができます。
■ SNMPは、3つのメイン要素で構成されています。
1. 管理者：ネットワーク管理ステーション(NMS)であり、管理対象デバイスの監視と制御のアプリケーションを実行するサーバーです。
2. エージェント：管理対象デバイスのステータスをNMSに転送する、管理対象デバイス上のネットワーク管理
ソフトウェアモジュールです。
3. 管理対象デバイス：管理されたネットワーク上のネットワークノードです（例：ルーター、スイッチ、ブリッジ、
ハブ、コンピュータホスト、プリンター、IP電話、ネットワークカメラ、Webサーバー、データベース）。
SNMPの設定を行う前に、まずNMSを有効にしてください。

SNMPの設定
SNMPv1、SNMPv2cを有効にする
このオプションを選択し、NMSの設定に従って、［読み取り/書き込み］コミュニティと［読み取り専用］コミュ
ニティの名前を入力します。

SNMPv3を有効にする
このオプションには、より高いセキュリティレベルの暗号化セキュリティが含まれており、認証パスワードと暗号化パスワードを設定することができます。
■ セキュリティ名：NMSの設定に従って、［読み取り/書き込み］または［読み取り専用］を選択し、コミュニティ
名を入力します。
■ 認証の種類です。認証方法として、MD5またはSHAを選択します。
■ 認証用パスワード：認証用のパスワードを入力します（8文字以上）。
■ 暗号化パスワード：暗号化するためのパスワードを入力します（8文字以上）。

96 - User's ManualVIVOTEK

ネットワーク＞FTP
セキュリティの観点から工場出荷時にはFTPサーバーを無効にしています。FTPサーバーを有効にしたい場合は、［FTPサーバーを有効にする］を手動で有効にします。この機能を使用しない場合は無効にしてください。
FTPポート：FTPサーバーを利用して、録画したスナップショットを取り出すことができます。デフォルト
では、FTPポートは21に設定されています。1025～65535の間で他のポート番号を割り当てることも可能です。

ヒント：
SDカードに記録された映像をダウンロードしたり、「http://ip/cgi-bin/admin/ lsctrl.cgi?cmd=search」コ
マンドを使用してSDカードの録画ファイルを調べることができます。

User's Manual - 97

VIVOTEK

Bonjour（ボンジュール）アプリ
Macコンピュータからカメラにアクセスするには、［Safari］で［Bonjour］をクリックし、ドロップダウンリストからカメラを選択します。
Safari＞環境設定でユーザー名とパスワードを入力し、rootパスワードを入力します。カメラのメイン画面がブラウザで開きます。

最近のiOSは、Bonjourオプションがない場合があります。その場合は、Discoveryユーティリティをインストールしてください。
Discovery（旧Bonjourブラウザ）はMac App Storeで検索してください。
Discoveryは、ローカルネットワークまたは広域Bonjourドメイン上のすべての「Bonjour」サービスを表示するユーティリティです。以前は「Bonjourブラウザ」と呼ばれていました。現在はMac App Storeで配布されています。
DiscoveryはmacOS 10.12以降を要件とします。Mac OSがそれ以前のバージョンの場合は、旧バージョンのBonjourブラウザをダウンロードすることができます。
Bonjourブラウザ（廃止）http://www.tildesoft.com/files/BonjourBrowser.dmg - Version 1.5.6
iOS版Discovery
https://itunes.apple.com/us/app/discovery-dns-sd-browser/id305441017?mt=898 - User's ManualVIVOTEK

セキュリティ＞ユーザーアカウントパスワード保護を有効にする方法と、複数のアカウントを作成する方法を説明します。
アカウント管理管理者アカウント名は「root」です。変更や削除はできません。アカウント管理画面でアカウントを追加する
場合は、まず「root」アカウントのパスワードを適用してください。
管理者は最大20個のユーザーアカウントを作成できます。
新規ユーザー作成の手順：
1. クリックするとプルダウンメニューが開きます。［新しいユーザー］を選択します。
2. 新しいユーザー名とパスワードを入力します。両方のテキストボックスに同じパスワードを入力します。

いくつかの特殊ASCII文字（「!」、「$」、「%」、「-」、「.」、「@」、「^」、「_」、「~」）は対応していません
が、パスワードの文字の組み合わせとして使用することができます。
パスワードの組み合わせの強度は右側に表示されます。パスワードの強度が十分になるまで、アルファベット、数字、大文字、小文字を組み合わせて使用してください。
3. 新しいユーザーアカウントの権限レベルを選択します。［追加］をクリックして、設定を有効にします。
権限レベルは次の通りです。
管理者
フルコントロール
オペレーター
スナップショット、画面、音声、PTZ の操作（選択可能）
カメラの設定画面には入れません。
ビューアー

スナップショット、画面、音声、PTZ の操作(選択可能）
カメラの設定画面には入れません。

アクセス権は、ユーザー権限（管理者/オペレーター/ビューアー）ごとに分類されています。管理者
のみ が設定画面にアクセスすることができます。オペレーターは設定画面にアクセスできませんが、URL
コマ ン ド を 使 用 し て パ ラ メ ー タ の 値 の 取 得 や 設 定 が で き ま す 。詳細は、「 URL Commands for the
Network Camera(ネットワークカメラのURLコマンド)」（P.151）をご参照ください。ビューアーは、ライブ表示のメイン画面にのみアクセスできます。
また、ユーザーのアクセス権の変更やユーザーアカウントの削除もできます。
1. 変更する既存のアカウントを選択します。
2. 必要な変更を行い、［更新］または［削除］をクリックして、設定を有効にします。

User's Manual - 99

VIVOTEK

権限の管理

PTZコントロール：オペレーターまたはビューアーとしての管理権限を変更することができます。チェックボ
ックスを選択または解除し、［保存］をクリックして設定を有効にします。

100 - User's Manual
ManualVIVOTEK

セキュリティ＞HTTPS (Hypertext Transfer Protocol over SSL)
SSL（Secure Socket Layer）による認証と暗号化通信を有効にする方法について説明します。インターネット上のストリーミングデータ通信をより高いセキュリティレベルで保護することができます。
証明書の作成とインストール方法
ネットワークカメラとの通信にHTTPSを使用する前に、証明書を作成する必要があります。証明書の作成と インストールには、3つの方法があります。
自己署名証明書の作成
1. プルダウンメニューからこのオプションを選択します。
2. 先頭にある［HTTPSセキュア接続を有効にする］のチェックボックスを選択し、「HTTP & HTTPS」
か 「HTTPSのみ」のどちらか一方の接続オプションを選択します。
3. ［証明書を作成する］をクリックすると、証明書が生成されます。

4. 自動的に下図のような「証明書情報」が表示されます。［証明書のプロパティ］をクリックすると、証明書の詳細情報が表示されます。

User's Manual - 101

VIVOTEK

5. ［保存］をクリックすると、設定が保存され、カメラとの現在のセッションが、暗号化された接続に変更されます。
6. Webセッションが暗号化されたHTTPSセッションに自動的に変更されない場合は、［ホーム］をクリックしてメイン画面に戻ってください。アドレスバーでURLアドレスを「http://」から「https://」に変更し、キーボードのEnterキーを押してください。いくつかのセキュリティ警告ダイアログがポップアップ表示されます
ので、［OK］または［はい］をクリックして、HTTPSを有効にします。

https://

https://192.168.5.151/index.html

102 - User's Manual
ManualVIVOTEK

証明書要求の作成とインストール
1. ［方法］のプルダウンメニューから［証明書要求の作成とインストール］を選択します。
2. ［証明書を作成する］をクリックして次に進みます。
3. ［作成]をクリックすると、以下の情報がポップアップウィンドウに表示されます。[保存]をクリックすると証明書要求が生成されます。

4. ［証明書要求］ウィンドウが表示されます。

以下のような情報バーが表示された場合は、［OK］をクリックし、画面上部の情報バーをクリックして、ポップアップを許可してください。

User's Manual - 103

VIVOTEK

5. シマンテックのベリサイン認証サービスなどの電子証明書を発行している、信頼できる認証局を探します。サインインして、SSL認証サービスを購入します。要求プロンプトから証明書要求をコピーし、CAの署名要求ウィンドウに貼り付けます。CAのWebページに記載されているCAの指示に従い、手続きを進めてください。

6. 完了すると、SSL証明書がEメールなどでお手元に届きます。メールに記載されている証明書の内容をコピーし、IDM Computer Solutions社のUltraEditなどのテキスト/HTML/Hexエディター/コンバーターに貼り付けてください。

104 - User's Manual
ManualVIVOTEK

7. 新規編集を開き、証明書の内容を貼り付けます。最後にEnterキーを押して、空白行を追加してください。

8. ファイル形式をDOSからUNIXに変換します。［ファイル］＞［変換］＞［DOS→UNIX］の順に開いてください。

User's Manual - 105

VIVOTEK

9. 編集内容を拡張子 「.crt」の形式（「CAcert.crt.」など）で保存します。

10. 元のファームウェアのセッションに戻り、［参照］ボタンで「crt証明書ファイル」を探します。
[アップロード]をクリックして認証を有効にします。

106 - User's Manual
ManualVIVOTEK

11. 証明書ファイルが正常に読み込まれると、ステータスが「有効」と表示されます。なお、［保存］ボタンをクリックして設定を有効にする前に、証明書が作成され、インストールされている必要があります。

12.暗号化されたHTTPSセッションを開始するには、[ホーム]をクリックしてメイン画面に戻ります。アドレス
バーでURLアドレスを「http://」から「https://」に変更し、キーボードのEnterキーを押してください。セキ
ュリティ警告ダイアログがポップアップ表示されます。［OK］または［はい］をクリックして、HTTPSを有効にします。

User's Manual - 107

VIVOTEK

セキュリティ＞アクセスリスト
フィルター
アクセスリストフィルタリングを有効にする：この項目にチェックを入れて[保存]をクリックするとアクセスリスト
フィルタリング機能が有効になります。
フィルタータイプ：フィルターの種類として、［許可］または［拒否］を選択します。［許可］を選択した場合、下記のアクセスリストに記載されているIPアドレスのクライアントだけがネットワークカメラにアクセス可能になり、それ以外はアクセスできません。反対に、［拒否］を選ぶと、下記のアクセスリストに載っているク
ライアントはネットワークカメラにアクセスできず、それ以外のクライアントはネットワークカメラにアクセスできるようになります。

次に、以下のアクセスリストにルールを［追加］します。なお、[IPv6アクセスリスト]欄は、［ネットワーク］画
面でIPv6を有効にしないと表示されません。IPv6の設定の詳細については、「ネットワーク＞全般設定」（P.80）をご参照ください。

108 - User's Manual
ManualVIVOTEK

ルールは3種類あります。
単一：［許可］/［拒否］リストにIPアドレスを追加することができます。
（例）

192.168.2.1

ネットワーク：ネットワークアドレスとそれに対応するサブネットマスクを、［許可］/［拒否］リストに割り当てることができます。アドレスとネットワークマスクはCIDR形式で記述します。
（例）

IPアドレス範囲192.168.2.xがブロックされます。
IPv6フィルターを優先する場合、以下のように表示されます。IPv6アドレスと2デジットのプレフィックス長を入力し、設定するIPアドレスの範囲を指定します。

範囲：ユーザーがIPアドレスの範囲を［許可］/［拒否］リストに割り当てることができます（注：このルールは、
IPv4アドレスにのみ適用されます）。
（例）

User's Manual - 109

VIVOTEK

管理者IPアドレス
このIPアドレスにデバイスへのアクセスを常に許可する：この項目にチェックを入れ、管理者のIPアドレス
を 入力フィールドに追加することで、管理者が常にデバイスに接続できるようになります。

110 - User's Manual
ManualVIVOTEK

セキュリティ＞IEEE 802.1X
ネットワーク環境で、ポートベースのネットワークアクセス制御を行うIEEE 802.1xが使用されている場合にこの機能を有効にします。ネットワークデバイス、中継スイッチ/アクセスポイント/ハブやRADIUSサーバー
は、802.1xの設定に対応し、これを有効にする必要があります。
802.1x規格は、ネットワークポート(有線またはワイヤレス)に接続されたネットワークデバイス(クライアント)に認証を提供するローカルエリアネットワークのセキュリティを強化するように設計されています。クライア
ントとサーバー間のすべての証明書が検証されると、ポイントツーポイント接続が有効になり、認証に失敗
すると、そのポートでのアクセスは禁止されます。802.1xは、既存のプロトコルである拡張認証プロトコル（EAP）を利用し、通信を容易にします。

■ 802.1x認証によって保護されたネットワークは次のように構成されます。

サプリカントオーセンティケータ

認証サーバー（ネットワークカメラ）（ネットワークスイッチ）（RADIUSサーバー）

1. サプリカント：認証要求するクライアントエンドユーザー（カメラ）です。
2. オーセンティケータ（アクセスポイントまたはスイッチ）：許可されていないエンドユーザーが認証サーバーと通信することを制限する「仲介役」です。
3. 認証サーバー（通常はRADIUSサーバー）：クライアント証明書を確認しエンドユーザーからのアクセス要
求を受け入れるかどうかを決定します。

■ VIVOTEKネットワークカメラは、認証を実行するためにEAP-PEAPとEAP-TLSの2種類のEAP方式をサポートしています。
以下の手順で、802.1xの設定を有効にしてください。
1. ネットワークカメラを802.1xで保護されたネットワークに接続する前に、RADIUSサーバーで検証可能な認証局（ネットワーク管理者）からのデジタル証明書を適用してください。
2. 保護されたLAN外にあるPCやノートPCにネットワークカメラを接続します。ネットワークカメラの設定画
面を下図のように開きます。EAP方式として［EAP-PEAP］または［EAP-TLS］を選択します。下の空欄に、認証局から発行されたIDとパスワードを入力し、関連する証明書をアップロードします。

User's Manual - 111

VIVOTEK

3. すべての設定が完了したら、ネットワークカメラを802.1x対応のスイッチに接続し、保護されたLANに移動します。デバイスが自動で認証を開始します。

ノート：► 802.1xの認証プロセスについて：
1. 認証局（CA）は、ネットワークカメラ(サプリカント)とRADIUSサーバー(認証サーバー)に必要な署名付き証明書を提供します。
2. ネットワークカメラは、スイッチ（オーセンティケータ）を経由して802.1Xで保護されたLANへのアクセスを要求します。クライアントが自分のIDとクライアント証明書を提供すると、スイッチからRADIUSサーバーに転送されます。RADIUSサーバーはアルゴリズムを使ってネットワークカメラを認証し、スイッチに承諾
または拒否を返信します。
3. また、スイッチは、RADIUSサーバーの証明書をネットワークカメラに転送します。
4. すべての証明書が検証されると、スイッチはネットワークカメラの状態を認証済に変更し、あらかじめ設
定されたポート経由で保護されたネットワークにアクセスできるようになります。
認証局

1
証明書

1
証明書

2

4
RADIUSサーバー

3
保護されたLAN112 - User's Manual
ManualVIVOTEK

セキュリティ＞その他
搭載されているトレンドマイクロ・ユーティリティは、クロスサイト・リクエスト・フォージェリに対する防御を提供します。クロスサイト・リクエスト・フォージェリは、ワンクリック攻撃やセッション・ライデ
ィングとも呼ばれ、CSRFと略称されます。CSRFはWebサイト（ここではカメラ）を悪用するタイプの攻撃です。不正なコマンドは、Webアプリケーションが信頼するユーザーから送信され、信頼できるユーザー自身のリクエストを、そのユーザー自身のCookieを含むリクエストなどで偽造する仕組みで送信されます。悪意のあるWebサイトは、特殊加工された画像タグ、隠しフォーム、
JavaScriptのXMLHttpRequestsなど、多様な方法で不正なコマンドを送信してきます。悪意のある攻撃は、ユーザーとやりとりすることなく、また、ユーザーが知らない間に行われる可能性があります。

User's Manual - 113

VIVOTEKPTZ＞PTZ設定
ネットワークカメラのパン/チルト/ズームの操作方法について説明します（ストリーム２で利用可能）。
デジタル：e-PTZの動作を制御します。物理的にカメラを動かすことなく、電子ズームによって拡大された領域が画角の範囲内でパンチルト動作をします。
デジタルPTZ操作（E-PTZ操作）
下図のようにe-PTZ制御設定が表示されます。

2015/05/20 09:57:30

x1.8
x1.8

e-PTZ関連の詳細についてはP.116をご参照ください。
オートパン/パトロール速度：1～5（遅い/速い）から速度を選択し、オートパン/パトロール速度制御を設定します。
ズームファクター表示
この項目にチェックを入れると、ライブビューイングウィンドウを拡大／縮小したときに、ホーム画面にズームインジ
ケーターが表示されます。
e-PTZの設定完了後、［保存］をクリックして設定を有効にします。

114 - User's Manual
ManualVIVOTEKE-PTZモードでのホーム画面■ ［e-プリセット位置］は、ホーム画面にも表示されます。ドロップダウンリストから選択すると、ネットワーク
カメラが選択された位置へ動きます。

グローバルビュー
e-PTZコントロールパネルを使用する以外に、マウスを使用してフローティングフレームをドラッグするまたはサイズを変更する方法で、表示エリアをパン/チルト/ズームすることもできます。それに応じて、ライブ
ビューウィンドウも表示エリアに移動します。
即時移動
この項目にチェックを入れると、フローティングフレームを移動した後、ライブビューウィンドウが新しい表示
エリアへ即時に切り替わります。この項目を選択しない場合は、ある位置から別の位置への移動過程も表示されます。
画像クリックe-PTZ機能は、「画像クリック」にも対応しています。グローバルビューの任意 の場所をクリックすると、その表示エリアもクリックした場所に移動します。
「画像クリック」機能は、例えば、カメラの最大フレームサイズのうち、800x600の領域を設定した場合や、最大出力フレームのうち、より小さな「関心エリア」を設定した場合にのみ適用されます。
パトロールボタン：このボタンをクリックすると、ネットワークカメラが選択されたプリセット位置を連続的にパト
ロールします。

User's Manual - 115

VIVOTEK

パトロール設定
ネットワークカメラがパトロールする位置をあらかじめ設定することができます。
以下の手順で、パトロールのスケジュールを設定してください。
1. リストからプリセット位置を選択し をクリックします。
2. 選択されたプリセット位置は、［巡回位置］リストに表示されます。
3. 自動パトロール中の際のプリセット位置での［停留時間］を設定します。
4. ［巡回位置］リストからプリセットした位置を削除したい場合は、その位置を選択して［削除］をクリックします。
5. 位置を選択しをクリックすると、パトロールの順番が入れ替わります。
6. ［保存］をクリックすると、パトロール設定が有効になります。
7. パトロールを開始するには、ホーム画面の［パトロール］ボタンをクリックしてください。

x1.8

116 - User's Manual
ManualVIVOTEK

ノート：••

プリセット位置は、ホーム画面にも表示されます。［移動］から1つ選択すると、ネットワー クカメラは選択したプリセット位置に移動します。
［パトロール］をクリックすると、ネットワークカメラは、選択された位置に沿って繰り返しパトロールを実行 します。

User's Manual - 117

VIVOTEK

イベント＞イベント設定
ネットワークカメラを特定の状況（イベント）に対応させるための設定方法について説明します。典型的な適用例としては、動きが検出されたときに、ネットワークカメラがバッファされた画像をFTPサーバーまたはEメールアドレスに通知として送信する等があります。[ヘルプ]をクリックすると、ポップアップウィン
ドウにイラストが表示され、モーション検知や外部デジタル入力デバイスなど、さまざまなソースによってイベントがトリガーされる可能性があることが解説されます。イベントがトリガーされたときに実行されるアクションの種類を指定することができます。スナップショットやビデオをEメールアドレスやFTPサイトに送信するようネットワークカメラを設定することができます。

イベント
映像やスナップショットの録画などの対応手段と関連付けてイベントを設定するには、トリガー発動時に実行する
アクション(メディアファイルの送信先サーバーなど)をネットワークカメラに認識させるため、サーバーとメディアを設定する必要があります。イベントとは、ユーザーが定義したトリガーソースによって開始されるアクションのことです。［イベント］画面内の［追加］をクリックして、［イベント設定］ウィンドウを開きます。ここでは、スケジュール、
トリガー、アクションの3つの要素でイベントを設定することができます。最大３つのイベントまで設定することができます。

118 - User's Manual
ManualVIVOTEK■ イベント名：イベント設定の名前を入力します。
■ ［このイベントを有効にする］：チェックを入れるとイベント設定が有効になります。
■ 優先度：このイベントの相対的な重要性(高、通常、または低)を選択します。優先度を高く設定したイベントは、
優 先して実行されます。
■ 次のモーション検知またはデジタル入力を＿秒後に検知：動きが検知された後、モーション検知を一時的に停止する時間を秒単位で入力します。これにより、イベント関連のアクションが頻繁に行われるのを防ぐことができます。

1. スケジュールイベントトリガーの有効期間を指定します。イベントトリガーのスケジュール設定の対象となる曜日と1日の時間（24時間表示）を選択してください（例えば、業務時間外の時間帯にのみイベントをトリガーさせることができます）。

2. トリガー
ネットワークカメラをトリガーするタイミングを決める要因やきっかけを意味します。トリガーソースとして、ネットワ
ークカメラに搭載されたモーション検知またはマニュアルトリガーを使用するように設定することができます。
トリガーソースにはいくつかの選択肢があります。項目を選択して、詳細な設定オプションを表示します。
■ ビデオ動き検知
このオプションは、搭載されたモーション検知機構をトリガーソースとして使用します。この機能を有効にするには、まず［モーション検知ウィンドウ」を設定する必要があります。詳細は「モーション検出」（P.134）をご参照くだ
さい。

■ 期間
このオプションを選択すると、指定した時間（分単位で指定）おきに定期的にネットワークカメラを起動させることができます。最大999分まで設定できます。

■ システム起動
ネットワークカメラの電源が切断され、再接続されたときにトリガーされます。
■ 録画通知このオプションを使用すると、記録ディスク容量が上限に達したとき、または古いデータを上書きし始めたときに、ネットワークカメラはトリガーされるようになります。

User's Manual - 119

VIVOTEK■ カメラタンパー検知
このオプションにより、ネットワークカメラは、タンパリングを検知したときにトリガーされるようになります。この機能を有効にするには、事前に［タンパー検出］を設定する必要があります。詳細はP.135をご 参照ください。

■ 手動トリガー設定
ホーム画面のオン/オフボタンをクリックすることで、手動でイベントトリガーを有効/無効に設定できます。この機能をご使用になる前に、1から3のイベントを設定してください。

120 - User's Manual
ManualVIVOTEK

3. アクション
トリガーが発動したときに、ネットワークカメラが実行するアクションを設定します。

■ ネットワークが切断されると、メディアがバックアップされます
ネットワークが切断された場合にメディアファイルをSDカードにバックアップするには、このオプションを選択します。バックアップするメディアには、イベント設定に応じて、スナップショット画像、映像、または
システムログを含めることができます。

User's Manual - 121

VIVOTEK

サーバーの追加
トリガー発動時に実行するアクション(メディアファイルをどのサーバーに送るかなど)をネットワークカメラに認識させるために、サーバーとメディアの設定を構成する必要があります。［サーバーの追加］をクリックすると、サーバー設定ウィンドウが表示されます。トリガー発動時の通知メッセージの送信先を指定することができます。最大
合計5個までのサーバー設定が可能です。
使用可能なサーバーの種類として、Eメール、FTP、SFTP、およびHTTPの4つの選択肢があります。選択すると、詳細な設定オプションが表示されます。いずれか1つ、またはそのすべてを設定することが可能です。

サーバーの種類： Eメール
トリガー発動時に、メディアファイルをEメールで送信するかどうかを選択します。
■ サーバー名：サーバー設定の名前を入力します。
■ 送信者のEメールアドレス：送信者のEメールアドレスを入力します。
■ 受信者のEメールアドレス：受信者のEメールアドレスを入力します。
■ サーバーアドレス：メールサーバーのドメイン名またはIPアドレスを入力します。
■ ユーザー名：必要に応じてメールアカウントのユーザー名を入力してください。
■ パスワード：必要に応じてメールアカウントのパスワードを入力します。
■ サーバーポート：デフォルトでのメールサーバーポートは25に設定されています。手動で別のポートを設定することも可能です。
お使いのSMTPサーバーがセキュリティ保護された接続(SSL)を必要とする場合は、[このサーバーはセキュアな接続が必要]を選択します。

122 - User's Manual
ManualVIVOTEK

Eメールの設定が正しく行われているかどうかを確認するには、［テスト］をクリックします。結果がポップアップウ
ィンドウに表示されます。成功すると、結果を知らせるEメールが送信されます。

［サーバーを保存］をクリックすると、設定が有効になります。
最初のイベントサーバーを設定すると、新しいイベントサーバーが自動的に［サーバー］リストに表示されます。
他のサーバーオプションを追加する場合は、［サーバーの追加］をクリックします。

サーバーの種類：FTP
トリガー発動時に、メディアファイルをFTPサーバーに送信するかどうかを選択します。

■ サーバー名：サーバー設定の名前を入力します。
■ サーバーアドレス：FTPサーバーのドメイン名またはIPアドレスを入力します。
■ サーバーポート：デフォルトでは、FTPサーバーのポート番号は21に設定されています。他のポート番号（1025～65535の範囲）を割り当てることも可能です。
■ ユーザー名：FTP アカウントのログイン名を入力します。
■ パスワード：FTPアカウントのパスワードを入力します。
■ リモートフォルダ名
メディアファイルを配置するフォルダを入力します。フォルダ名が存在しない場合は、ネットワークカメラが自動的にFTPサーバー上にフォルダを作成します。

User's Manual - 123

VIVOTEK■ パッシブモード
ほとんどのファイアウォールは、外部からの要求によって開始された新しい接続を受け付けません。FTPサーバーがパッシブモードに対応している場合、このオプションを選択するとパッシブモードFTPが有効になり、データがファイアウォールを通過して転送されます。ファームウェアのデフォルトでは、パッシブモードにチェックが入っています。
FTPの設定が正しく行われているかどうかを確認するには、［テスト］をクリックします。結果がポップアップウィン
ド ウに表示されます。成功すると、FTPサーバーに「test.txt」ファイルが生成されます。

［サーバーを保存］をクリックして設定を有効にします。
サーバーの種類：SFTP
トリガー発動時にメディアファイルをSFTP（Secure File Transfer Protocol）サーバーに送信するかどうかを選択します。この設定画面は、クライアント側の設定も含みます。

■ サーバーアドレス：SFTPサーバーアドレスをドメイン名またはIPアドレスで入力します。
■ サーバーポート：デフォルトでは、FTPサーバーのポート番号は22に設定されています。他のポート番号（1025～ 65535の間）を割り当てることも可能です。
■ ホストキーMD5：サーバーへの接続に、ユーザー名とパスワードの代わりに公開鍵/秘密鍵の認証を使用するオプションがあります。このオプションを使用するには、お客様がSSHの秘密鍵/公開鍵のペアをお持ちで、公開鍵がSFTPサーバーに配置されている必要があります。
このSFTPサーバーで鍵認証を使用する場合は、[取得(フィンガープリントの読み取り)]ボタンをクリックして、サーバーに公開鍵のフィンガープリントを要求します。ホストキーMD5は、FTPサーバーの公開鍵のハッシュ値であり、カメラが正しいSFTPサーバーに接続されていることを確認するために保存されます。そのフィン
ガープリントをコピーして、後で参照できるように保存することができます。
MD5フィンガープリントの最大文字数は47文字です。
124 - User's ManualVIVOTEK

鍵認証を希望しない場合は、以下のセクションでユーザー名とパスワードを指定することができます。
RSAキーのフィンガープリントは次のように表示されます：da:47:93:b4:3a:90:5b:50:1f:20:a8:f9:b7:a1:d0:e1.
これが接続先のSFTPサーバーであるかどうかを確認します。

■ フォルダ名
メディアファイルを配置するフォルダを入力します。フォルダ名が存在しない場合は、ネットワークカメラがSFTPサーバー上に任意のフォルダを作成します。
パスを指定する場合はバックスラッシュ「\」を使用します。SFTPサーバーのデフォルトルートディレクトリのパスを使用する場合は、空白のままにします。フォルダ名の最大文字数は128文字です。
■ ログインモード［パスワード］モードまたは［公開鍵］モードのログインモードを選択します。
SFTPを使用する場合、パスワードの代わりに公開/非公開のSSH鍵ペアを使用して認証することができます。
鍵認証が有効でない場合は、代わりにパスワードを指定する必要があります。SFTPサーバーの管理者は、対応する公開鍵を手動で追加する必要があります。
パスワードモード■ ユーザー名：SFTPアカウントのログイン名を入力します。
■ パスワード：SFTP アカウントのパスワードを入力します。
［テスト］をクリックして接続状態をテストします。テスト完了
後、サーバー名を入力し、［サーバーを保存］クリックして設定を保存します。

User's Manual - 125

VIVOTEK

公開鍵モード
公開鍵モードを選択すると、ペアリングモードのオプション（［オート］/［ダウンロード］/［アップロード］）
が表示されます。
オート

カメラが鍵ペアを生成し、SFTPサーバーと公開鍵との自動ペアリングを行います。

ダウンロードユーザーがSFTPサーバーにアップロードできるように、カメラが鍵ペアを生成して公開
鍵をダウンロードします。サポート形式は：ED25519（デフォルト。楕円曲線署名方式
Edwards-curve Digital Signature Algorithm；鍵の生成、暗号化、復号化が高速）、RSA（Rivest-Shamir-Adleman；可搬性が高い）、ECDSA（楕円曲線デジタル署名方式）です。
ここで秘密鍵をアップロードし、公開鍵をSFTPサーバーにアップロードします。
秘密鍵は保護情報であり、暗号化された状態でディスクに保存することができます。パスフレーズは、復号化に使用されます。これはSSHサーバーへのログインパスワード
で、パスフレーズはローカルシステム上で秘密鍵を復号化するためにのみ使用されます。パスフレーズはネットワーク経由で送信されることはありません。

アップロードSFTPを使用する場合、パスワードの代わりに公開/非公開のSSH鍵ペアを使用して認証することができます。鍵認証が有効でない場合は、代わりにパスワードを指定する必要があります。SFTPサーバーの管理者は、対応する公開鍵を手動で追加する必要があります。
鍵ベース認証の主な利点は、パスワードを使用する代わりに、ブルートフォース（総当たり）攻撃を受けにくく、サーバーが侵害された場合でも、有効な認証情報を公開しない点にあります。

126 - User's Manual
ManualVIVOTEK

サーバーの種類：HTTP
トリガー作動時に、メディアファイルをHTTPサーバーに送信するかどうかを選択します。

■ サーバー名：サーバー設定の名前を入力します。
■ URL：HTTPサーバーのURLを入力します。
■ ユーザー名：必要に応じて入力します。
■ パスワード：必要に応じて入力します。
HTTPの設定が正しく行われているかどうかを確認するには、［テスト］をクリックします。結果はポップアップ
ウィンドウに表示されます。成功すると、HTTPサーバーに「test.txt」ファイルが生成されます。

［サーバーを保存］をクリックして設定を有効にします。

User's Manual - 127

VIVOTEK

ネットワークストレージ
トリガー発動時に、メディアファイルをネットワーク上のストレージに送信するかどうかを選択します。詳細は「NASサーバー」（P.143）をご参照ください。設定できるNASサーバーは1つのみです。
［サーバーを保存］をクリックして設定を有効にします。

■ SDの検査：クリックすると、SDカードのテストができます。成功または失敗の結果を示すメッセージが表示されます。SDカードをローカルストレージで使用する場合は、使用前にフォーマットしてください。詳細はP.130 をご参照ください。
■ 表示：クリックするとファイル一覧ウィンドウが表示されます。SDカードとネットワークストレージ用の機能です。
SDカードの[表示]ボタンをクリックすると、ローカルストレージの画面が表示され、SDカード上の録画ファイルを管理することができます。ローカルストレージの詳細については、P.145をご参照ください。ネットワークストレ
ージの[表示]ボタンをクリックすると、ファイルディレクトリウィンドウが表示され、ネットワークストレージの録画
データを確認することができます。図解による詳細な説明は次ページをご覧ください。
■ 日付、時刻、時間帯ごとにフォルダを自動作成：この機能を選択すると、ネットワークストレージにビデオ映像
が保 存される際に、システムが自動的に日付ごとのフォルダを作成します。
映像クリップを含むファイルの保存先の例は次のとおりです。

形式はYYYYMMDD
クリックするとディレクトリが開きます

クリックすると、録画データがすべて削除されます
クリックすると、選択した項目が削除されます
128 - User's Manual
ManualVIVOTEK

20210120をクリックすると、ディレクトリが表示されます。

形式はHH（24時間表示）
クリックすると、その時間帯のファイルリストが表示されます

2021/01/20
2021/01/20

クリックすると、選択した項目が削除されます

クリックすると、前の階層のディレクトリに戻ります

クリックすると、録画データがすべて削除されます2021/01/20
2021/01/20

形式：ファイル名のプレフィックス＋分（mm）
ファイル名のプレフィックスは、「メディアの追加」画面で設定できます。
詳細は次ページをご参照ください。

User's Manual - 129

VIVOTEK

メディアを追加［メディアを追加］をクリックすると、メディア設定ウィンドウが表示されます。トリガー発動時に送信されるメディアの種類を指定できます。合計5つのメディア設定を行うことができます。メディアの種類はスナップショット、ビデオ
クリップ、システムログの3種類から選択できます。項目を選択すると、詳細な設定オプションが表示されます。
いずれか1つ、またはすべてを設定することができます。

メディアの種類：スナップショット
トリガー発動時にスナップショットを送信するかどうかを選択します。
■ メディア名：メディア設定の名前を入力します。
■ ソース：任意の映像プロファイルからスナップショットを撮影する場合に選択します。
■ イベント前画像を＿枚送信
ネットワークカメラには、一定のデータを一時的に保持するためのバッファがあります。トリガー発動前に何枚の画像を取り込むかを、数値を入力して決定します。最大３枚の画像を生成することができます。
■ イベント後画像を＿枚送信
トリガー発動後、何枚の画像を取り込むかを数値で入力して決定します。最大３枚の画像を生成することができます。
例えば、「イベント前画像の送信」と「イベント後画像の送信」の両方を３に設定した場合、トリガー 発動後に合計７枚の画像を生成することが可能です。
1 pic.

2 pic.

3 pic.

4 pic.

5 pic.

6 pic.

7 pic.

8 pic.

9 pic.

トリガー発動■ ファイル名のプレフィックス
ファイル名の前に付加するテキストを入力します。

130 - User's Manual

10 pic.

11 pic. 10 pic.

12 pic. 13 pic.

14 pic.

15 pic.

VIVOTEK■ ファイル名の最後に日付と時間を追加
ファイル名に日付/時刻のサフィックスを追加するには、このオプションを選択します。
（例）
スナップショット_20210513_100341

ファイル名のプレフィックス 日付と時刻のサフィックス
形式はYYYYMMDD_HHMMSS［メディアを保存する］をクリックして設定を有効にします。

メディアの種類：映像クリップ
トリガー発動時に映像クリップを送信するかどうかを選択します。

■ メディア名：メディア設定の名前を入力します。
■ ソース：映像クリップのソースとして、ビデオストリームプロファイルを選択します。
■ イベント前録画
ネットワークカメラには、一定のデータを一時的に保持するためのバッファがあります。トリガーが発動するまでの録画時間を数値を入力して決定します。最大9秒まで設定できます。
■ 最大録画時間
最大録画時間を秒単位で指定します。最大20秒まで設定できます。
たとえば、イベント前録画を5秒、最大録画時間を10秒に設定している場合、ネットワークカメラはトリガー発動後、さらに4秒間録画を継続します。
1 sec.

2 sec.

3 sec.

4 sec.

5 sec.

6 sec.

7 sec. 8 sec.

9 sec.

10 sec.

トリガー発動User's Manual - 131

VIVOTEK■ 最大ファイルサイズ
許容される最大ファイルサイズを指定します。使用用途によっては、フォレンジックエビデンスの検索や整理用途のため、映像 クリップをつなぎ合わせる必要が生じます。そのような場合に役立つ機能です。
■ ファイル名のプレフィックス
ファイル名の前に付加するテキストを入力します。
（例）
映像_20210513_100341

ファイル名のプレフィックス 日付と時刻のサフィックス
形式はYYYYMMDD_HHMMSS［メディアを保存］をクリックして設定を有効にします。

メディアの種類：システムログ
トリガー発動時にシステムログを送信するかどうかを選択します。

［メディアを保存］をクリックして設定を有効にし、［閉じる］をクリックして終了します。

132 - User's Manual
ManualVIVOTEK［イベント設定］画面に、設定したサーバーとメディアが一覧表示されます。
イベントトリガー対応を有効にするため、[イベント]＞[ステータス]が[オン]になっていることを確認してください。
設定完了後、[イベントを保存]をクリックして設定を有効にし、[終了]をクリックして[イベント設定]を終了します。
イベント設定画面のイベントドロップダウンリストに、新しい［イベント］/［サーバー設定］/［メディア］が表示されます。
以下のイベント設定画面の例をご参照ください。

イベントステータスが［オン］の場合、上記のイベント設定がモーション検知によってトリガーされると、ネットワー
クカ メラが自動的にEメールでスナップショットを送信します。
イベントトリガーを停止させたい場合は、[オン］ボタンをクリックして[オフ］の状態にするか、［削除］をクリックしてイベン ト設定を削除します。
リストからサーバー設定を削除するには、ドロップダウンリストからサーバー名を選択し、［削除］をクリックします。
既存のイベント設定に適用されていない場合のみサーバー設定を削除できます。
リストからメディア設定を削除するには、ドロップダウンリストからメディア名を選択し、［削除］をクリックします。
既存のメディア設定に適用されていない場合のみメディア設定を削除できます。

User's Manual - 133

VIVOTEK

アプリケーション＞モーション検知
ノート：•

本機でモーション検知を実行する際、システムリソースの理由から、モーション追跡ブロックと人物検知エリアは表示されません。

本機では、VCAパッケージとしてSmart Motion検知ユーティリティがあらかじめ搭載されています。
詳細はユーザーガイドをご参照ください。
http://download.vivotek.com/downloadfile/solutions/vadp/smart-motion-detection-manual_en.pdf.
［設定]＞[アプリケーション]＞[モーション検知]の順に開きます。Smart Motionユーティリティが自動的に起動します。
人物検知を適用する際は、事前に設置場所でのカメラの高さを測定しておきます。正しく映像解析を行うため必要な準備です。モーション検知の設定画面で設置場所の高さを入力する必要があります。

134 - User's Manual
ManualVIVOTEK

アプリケーション＞タンパリング検知
カメラのタンパリング検知を設定する方法について説明します。タンパリング検知では、カメラの「向きの変更」、「遮り」や「焦点ずらし」、「スプレー塗料の吹き付け」といった事象を検知することができます。

カメラのタンパリング検知機能の設定は、次の手順で行ってください。
1. 各タンパリング条件（［タンパリング検知］、［画像が暗すぎる］、［画像が明るすぎる］、［画像がぼやけている］）のチェックボックスを選択します。トリガーされるまでのタンパリング行為の継続時間を入力します(10秒～10分)。継続時間は、タンパリングが実際のアラームとみなされるまでの時間です。これを指定することにより、短時間の変化による誤報を回避することができます。
タンパリング要因（現在のフレームと事前に保存された背景の差）がトリガーの閾値を超えた
場合のみ、タンパリングアラームがトリガーされます。画像が暗すぎる、明るすぎる、またはぼや けている（焦点が合わない）などの条件も、タンパリング条件として設定することができます。
トリガーの閾値により、タンパリング検知の感度が決まります。閾値を低くすると、トリガーが発動しやすくなります。
明るすぎる場合：懐中電灯の光が当てられています。シーンの平均的な採光レベルを考慮する必要があります。
暗すぎる場合：対物レンズが覆われたり、スプレー塗料が吹き付けられたりしています。
ぼやけている場合：シーンがぼやけている場合は、EMIの干渉など、デバイスの強い干渉の結果であることがあります。
2. ［イベント]＞[イベントの設定]＞[トリガー]のプロアクティブイベント設定で、トリガー要因としてタンパリング検知を設定することができます。たとえば、カメラが不正に操作された場合、イベント前後の映像クリップをネットワーク上のストレージデバイスに送信するように設定できます。
詳細はP.119をご参照ください。
User's Manual - 135

VIVOTEK

アプリケーション＞音声検知
音声検知は、映像のモーション検知と組み合わせて、次のようなシーンに適用できます。
1. カメラ映像に含まれないアクティビティの検知（銃声やドア・窓の破壊による大きな音の入力など）。
2. 普段は騒音下にある工場などの環境が、機械の故障で急に静かになる場合。
3. 音声イベントの発生時に、PTZカメラがプリセットポイントに向くように設定したい場合。
4. 映像によるモーション検知がうまく機能しない暗い環境。

赤丸は、事前に設定した閾値を超えたとき、または下回ったときに音声アラームがトリガーされる所を示しています。
音声検知の設定方法
1. ［音声検知］ウィンドウを開くと、現在の音声入力が、変動する黄色の波形図によってインタラクティブ
表示されます。
2. マウスをクリックし、アラームレベルタブをスライドバー上の所望の位置にドラッグします。
3. ［音声検知を有効にする］にチェックを入れ、［保存］をクリックして機能を有効にします。

ノート：
1. なお、波形図の横にある音量の数値（0〜100）は、デシベル（dB）を表すものではありません。音量レベ
ルはあらかじめ設定された値にマッピングされていますが、波形図に示されている設置場所での実際の入力値を使用してアラームレベルを設定することもできます。
2. この機能を設定する際は、[設定]＞[メディア]＞[音声]で音声ミュート機能を無効にする必要があります。
内蔵マイクがないため、デフォルトでは、カメラのミュート機能が有効になっている場合があります。外部
マイクはお客様ご自身でご用意ください。

136 - User's Manual
ManualVIVOTEK

アプリケーション＞パッケージ管理－通称VADP (VIVOTEK Application
Development Platform)
Smart Motion 検知は、人物検知機能と調整可能なタイムフィルターにより、従来のモーション検知の欠点を解消し、監視現場での設定を容易にしました。
この機能の詳細については、以下からユーザーガイドをダウンロードしてください。
https://download.vivotek.com/downloadfile/solutions/vadp/smart-motion-detection-manual_en.pdf

カメラのフラッシュメモリに、VIVOTEKやサードパーティのソフトウェアモジュールを保 存し、実行することができます。これらのソフトウェアモジュールは、オブジェクトのカウントなどのインテリジェントビデオアプリケーションの映像分析に適用したり、エッジ記録のエージェントとして使用することができます。
•

ソフトウェアパッケージのアップロードに成功すると、モジュール設定（vadp.xml）情報が表示されます。モジュールをアップロードする際、カメラはそのモジュールが事前に定義されたVADPの要件に適合しているかどうかを確認します。モジュールに含まれるパラメータについては、
弊社テクニカルサポートまたはサードパーティモジュールの販売店にお問い合わせください。

User's Manual - 137

VIVOTEK

ソフトウェアモジュールを利用するには、ソフトウェアパッケージを取得し、［参照］と［アップロード］
をクリックします。アップロードに成功すると、次の画面メッセージが表示されます。

モジュールを起動するには、先頭のラジオボタンを選択し、［開始］をクリックします。

モジュールを取り外す必要がある場合は、先頭のラジオボタンを選択し、［停止］をクリックします。モジュールのステータスが［オフ］になり、列の最後に[×]マークが表示されます。[×]マークをクリックすると、既存のモジュールが削除されます。

確認メッセージが表示されたら、［はい］をクリックして次に進みます。

Yes

No

モジュールの動作中に実際に消費されたメモリは［メモリステータス］フィールドに表示されます。
実行中のモジュールがシステムリソースを過剰に消費していないかどうかを判断するのに役立ちます。

138 - User's ManualVIVOTEKVIVOTEKのVADPモジュールを使用するために、［ライセンス］画面でライセンス登録とアクティベーションを行います。ライセンスキーは別に取得し、ネットワークカメラに手動でアップロードする必要があります。
VIVOTEKホームページの画面の指示に従って、登録手続きを行ってください。

User's Manual - 139

VIVOTEK

録画＞録画設定
ネットワークカメラの録画設定について説明します。
録画設定
SDカードを挿入後、クリックしてテストを実行してくださいノート：► 初めてSDカードを使用する際は、ご使用前にカメラのWebコンソール（「ローカルストレージ、SDカード管理」画面）で必ずSDカードをフォーマットしてください。詳細はP.145をご参照ください。
録画設定［追加］をクリックすると、録画設定ウィンドウが表示されます。最適化録画、録画ソース、録画スケジュール、 録画
容量を定義することができます。合計2つの録画設定を行うことができます。

■ 録画名：録画設定の名前を入力します。
■ この録画を有効にする：映像の録画を有効にするには、このオプションを選択します。
■ 最適化録画：
このオプションを選択すると、アラームトリガーに応じてフレームレートがコントロールされます。
アラームがトリガーされると、フレームレートがビデオ設定画面上で設定した値まで上昇します。
詳細はP.71をご参照ください。
140 - User's Manual
ManualVIVOTEK

アダプティブ録画をカメラ上で有効にした場合、カメラ上でイベントがトリガーされたときのみ、サーバーはフルフ
レームレートストリーミングデ ータを記録し、そうでない場合、通常監視の間、Iフレームデ ータのみを録画することで、効率的に帯域幅とストレージ容量を節約します。

ノート：

Bandwidth
I-フレーム→フルフレームレート→I-フレーム► アダプティブ録画を有効にするには、モーション検出、DIデバイス、または手動トリガーなどのトリガーソース を設定していることを確認してください。
► アラームトリガーがない場合：- JPEGモード：1秒当たり1フレームを録画- H.264モード：Iフレームのみを録画

帯域幅
アクティビティアダプティブストリーミング
ダイナミックフレームレート制御用► Iフレーム期間がビデオ設定画面上で、＞1秒である場
合、アダプティブ録画が有効となった際に、 ファームウェ
アは、Iフレーム期間を1秒に設定し ます。
継続録画

時間

アラームトリガーは、モーション検知とDI検知を含みます。P.118のイベント設定をご参照ください。
■ イベント前録画とイベント後録画
ネットワークカメラは、一定期間、データを一時的に保持するバッファを有します。したがって、イベントが発生した場合、カメラは数秒前に撮影された画像フレームを読み出すことができます。時間を入力し、トリガーの発動前後の録画期間を設定します。
■ 優先度：この録画の相対的な重要性(高、通常、または低)を選択します。優先度を高く設定した録画は、優先
して 実行されます。
■ ソース：録画ソースとしてビデオプロファイルを選択します。

ノート：► 録画通知を有効にするには、まず［イベントの設定］を行ってください。P.118をご参照ください。
以下の手順で録画の設定をしてください。
1. トリガートリガーソースを選択します。

■ スケジュール：サーバーがローカルストレージまたはネットワークストレージ（NAS）へファイル保存を開始す
る スケジュールを設定できます。
■ ネットワークエラー：チェックを入れると、ネットワークに障害が発生した場合、サーバーがローカルストレー
ジ （SDカード）にファイルを保存します。
User's Manual - 141

VIVOTEK

2. 保存先録画した映像ファイルの保存先として、SDカードまたはネットワークストレージ（NAS）を指定できます。お客様がNASサーバーを設定している場合の設定については以下をご参照ください。

NASサーバー［NASサーバーを追加］をクリックしてサーバー設定ウィンドウを開き、以下の手順で設定します。
1. サーバーの情報を入力します。
（例）

サーバーのユーザー名とパスワード

2. ［テスト］をクリックして設定を確認します。結果はポップアップウィンドウに表示されます。

142 - User's Manual
ManualVIVOTEK

成功すると、ネットワークストレージサーバー上に「test.txt」ファイルが生成されます。

3. サーバー名を入力します。
4. ［保存］をクリックして設定を完了し、［閉じる］をクリックして終了します。

■ ［最小予約ストレージ領域］で空き容量全部を使用するか、予約容量を制限するかを選択できます。録画サイズの上限は、サイクル録画用の予約容量よりも大きくなければなりません「予約ストレージ領域」とは、容量が使い果たされるか再利用される直前の、トランザクション段階でのみ使用される少量の領域です。
■ ［循環ストレージを有効にする］にチェックを入れると、最大容量に達した場合、最も古いファイルから順番に
最 新のファイルに上書きされます。予約容量は、ストレージ領域がほぼ満杯の状態で新規データが届いた
時のトランザクション段階用に確保されています。予約容量の下限は15メガバイト以上必要です。
■ ［自動クリーンアップを有効にする］にチェックを入れ、ファイルを保管する日数を入力します。例えば「7日」と入力した場合、録画ファイルはNASに7日間分保存されます。

User's Manual - 143

VIVOTEK

録画通知を有効にする場合は、［イベント］をクリックして、イベントのトリガー設定を行います。
詳しくは「イベント＞イベント設定」（P.118）をご参照ください。
設定完了後、[この録画を有効にする]を選択します。［保存］をクリックして設定を有効にし、［閉じる］で終了します。システムが録画を開始すると、録画されたファイルがネットワークストレージに送信されます。新
しい録画名は、下図のように録画画面のドロップダウンリストに表示されます。
リストから録画設定を削除するには、ドロップダウンリストから録画名を選択し、［削除］をクリックします。

■ ［録画（名）］をクリックすると、［録画設定］画面を開いて修正することができます。
■ ［オン（状態）］をクリックすると、［オフ］の状態になり、録画を停止します。
■ ［NAS（保存先）］をクリックすると、次のような録画ファイルリストが開きます。
フォルダ名の命名規則についての詳細はP.128をご参照ください。

144 - User's Manual
ManualVIVOTEK

ストレージ
ノート：
•
•
•
•
•

カメラからSDカードを取り外す前に、録画動作をオフにすることを推奨します。
SDカードには寿命があります。SDカードの定期的な交換が必要となる場合があります。
カメラファイルシステムは、数メガバイトのメモリ領域を使用します。このストレージ領域は録画には使用 できません。
他のデバイスで記録したデータが入ったSDカードは、本機で使用しないでください。
SDカード内のフォルダ名を修正・変更しないでください。カメラの故障の原因になります。

ストレージ＞SDカード管理
ネットワークカメラのローカルストレージの管理方法について説明します。SDカードの状態を表示した
り、SDカードの制御を行うことができます。
SDカードの状態
この画面は、SDカードの状態や予約領域を示すものです。初めてSDカードを使用する際は事前にフォーマットを行ってください。

SDカード無し

SDカードのフォーマット
LinuxカーネルのEXT4ファイルシステム・フォーマットは、32GB以上のSDカードに適用されます。ただし、EXT4を適用した場合、Windowsを実行中のPCは、サードパーティ製のソフトウェアを使用しない限り、SDカード内のコンテンツにアクセスすることはできません。

User's Manual - 145

VIVOTEK

SDカードコントロール■ ［最小予約ストレージ領域]で空き容量全部を使用するか、予約容量を制限するかを選択できます。「予約ストレージ領域」とは、容量が使い果たされるか再利用される直前の、トランザクション段階でのみ使用される少量の領域です。通常はデフォルトの10%でお使いください。
■ ［循環ストレージを有効にする］にチェックを入れると、サイクル録画が有効になります。最大容量に達す ると、最も古いファイルから順番に最新のファイルに上書きされます。
■ ［ディスクの自動クリーンアップを有効にする］にチェックを入れ、ファイルを保管する日数を入力します。例えば「7日」と入力した場合、録画ファイルはSDカードに7日間保存されます。
［保存］をクリックして設定を有効にします。

ストレージ＞NAS管理
NASのセットアップ［NAS管理］タブをクリックしてサーバー設定ウィンドウを開き、以下の手順で設定します。
1. ネットワーク上の共有ストレージへのアクセス情報を入力します。
（例）\\192.160.5.122\NASvivotekrita.li

146 - User's Manual
ManualVIVOTEK

2. ［テスト］をクリックして設定を確認します。結果はポップアップウィンドウに表示されます。

成功すると、ネットワーク上のストレージサーバーに「test.txt」ファイルが生成されます。

3. ［マウント］をクリックすると設定が完了します。

NAS管理■ 最小予約ストレージ領域：予約領域は、特に循環録画機能が有効になっている場合、ストレージ領域 が上限に達した状態で受信ストリーミングデータを既存の録画データに上書きするトランザクションの段階
で、安全なバッファとして使用されます。
■ 循環ストレージを有効にする：既存の録画データに新しい録画データを上書きすることを許可します。
■ 自動ディスククリーンアップを有効にする：NASストレージに録画ファイルを保管する期間を設定できます。
最長保存期間＿日：録画した映像ファイルをＮＡＳストレージに保存する期間を指定します。

User's Manual - 147

VIVOTEK

ストレージ＞コンテンツマネージメント
ネットワークカメラで録画した映像コンテンツを管理する方法を説明します。録画映像の検索や検索結果の視聴ができます。

録画映像の検索と視聴
この画面では、録画データの検索条件を設定することができます。条件を選択せず［検索］ボタンをクリックすると、すべての録画データが［検索結果］画面に一覧表示されます。

■ ファイルの属性：検索条件として1つまたは複数の項目を選択します。
■ トリガー時間：特定の時点で作成されたコンテンツを検索したい場合、時間範囲を手動で入力します。
［検索］をクリックすると、検索条件に該当する録画データが［検索結果］画面に一覧表示されます。

148 - User's Manual
ManualVIVOTEK

検索結果
以下は、検索結果の一例です。［トリガー時間］/［メディアの種類」/［トリガータイプ］/［ロック済］の4つの項目があります。 を クリックすると、検索結果をどちらかの方向で並べ替えることができます。
1画面に表示される件数

クリックするとライブビューが開きます■ 再生：検索結果をクリックすると、選択された項目がハイライト表示されます。選択したファイルをすぐに確認できるように、再生ウィンドウが上部に表示されます。
（例）■ ダウンロード：検索結果をクリックすると、選択された項目が紫色でハイライトされます。［ダウンロード］をクリック
すると、ファイルのダウンロードウィンドウが表示され、ファイルを保存することができます。
■ JPEGからAVIへ：この機能は、スナップショットのような「JPEG」形式のファイルにのみ適用されます。リストか
らいくつかのスナップショットを選択し、このボタンをクリックすると、スナップショットがAVIファイルに変換されます。

User's Manual - 149

VIVOTEK■ ロック/アンロック：該当の検索結果の先頭にあるチェックボックスを選択し、［ロック/アンロック］をクリックします。選択された項目はロックされた状態になり、サイクル録画中に削除されることはありません。もう一度クリックすると、選択されている項目のロックが解除されます。
（例）

クリックすると画面が前後のページに移動します■ 削除：対象となる検索結果を選択し、［削除］をクリックすると、選択されたファイルが削除されます。

150 - User's ManualVIVOTEKAppendix

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 thefunctionality 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 thatis to be replaced with either a value or a string. When replacing the text string, the angle brackets
should also be replaced. An example of this is the description of the name for the server, denoted with
<servername> in the URL syntax description below, that is replaced with the string myserver in the URL
syntax example further down in the page.
URL syntax is denoted with the word "Syntax:" written in bold face followed by a box with the referenced
syntax as shown below. For example, name of the server is written as <servername> and is intended tobe replaced with the name of the actual server. This can either be a name, e.g., "mywebcam" or "thecam.
adomain.net" or the associated IP number for the server, e.g., 192.168.0.220.
Syntax:
http://<servername>/cgi-bin/viewer/video.jpg
Description of returned data is written with "Return:" in bold face followed by the returned data in a box. All data isreturned in HTTP format, i.e., each line is separated with a Carriage Return and Line Feed (CRLF) printed as \r\n.
Return:HTTP/1.0 <HTTP code> <HTTP text>\r\n
URL syntax examples are written with "Example:" in bold face followed by a short description and a light grey box
with the example.
Example: request a single snapshot image
http://mywebserver/cgi-bin/viewer/video.jpg

User's Manual - 151

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

3. General CGI URL Syntax and Parameters
CGI parameters are written in lower-case and as one word without any underscores or otherseparators. 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 infunctionally-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 #0 to active
http://mywebserver/cgi-bin/dido/setdo.cgi?do0=1

152 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

4. Security Level
SECURITY LEVEL SUB-DIRECTORYDESCRIPTION

0anonymous

Unprotected.

1 [view]viewerCan view, listen, and talk to camera.

4 [operator]

operator

Operator access rights can modify most of the camera’s
parameters except some privileges and network options.

6 [admin]admin

Administrator access rights can fully control thecamera’s operations.

7

N/AInternal APIs. Unable to be changed by any externalinterfaces.

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.

User's Manual - 153

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

5. Get Server Parameter Values
Note: The access right depends on the URL directory.
Method: GET/POST
Syntax:
http://<servername>/cgi-bin/anonymous/getparam.cgi?[<parameter>][&<parameter>…]
http://<servername>/cgi-bin/viewer/getparam.cgi?[<parameter>][&<parameter>…]
http://<servername>/cgi-bin/operator/getparam.cgi?[<parameter>][&<parameter>…]
http://<servername>/cgi-bin/admin/getparam.cgi?[<parameter>][&<parameter>…]
Where the <parameter> should be <group>[_<name>] or <group>[.<name>]. If you do not specify
any parameters, all the parameters on the server will be returned. If you specify only <group>, theparameters oftherelated group will be returned.
When querying parameter values, the current parameter values are returned.
A successful control request returns parameter pairs as follows:
Return:HTTP/1.0 200 OK\r\nContent-Type: text/html\r\nContext-Length: <length>\r\n\r\n<parameter pair>where<parameter pair> is<parameter>=<value>\r\n[<parameter pair>]<length> is the actual length of content.
Example: Request IP address and its response
Request:154 - User's Manual© 2020 VIVOTEK INC. All Right Reserved

VIVOTEK

http://192.168.0.123/cgi-bin/admin/getparam.cgi?network_ipaddress
Response:
HTTP/1.0 200 OK\r\nContent-Type: text/html\r\nContext-Length: 33\r\n\r\nnetwork.ipaddress=192.168.0.123\r\nUser's Manual - 155

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

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>]
PARAMETERDESCRIPTION<parameter>

A full path like: "videoin_c0_s0_h264_resolution","videoin_c0_s0_h264_maxframe", etc.

<value>

The assigned <value> to the <parameter>.

<return page> Redirect to the page <return page>after the <parameter> is assigned. The <return
page>can be a full URL path or relative path according to the current path. If youomit 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 endof the parameter list.
Return:HTTP/1.0 200 OK\r\nContent-Type: text/html\r\nContext-Length: <length>\r\n\r\n<parameter pair>where<parameter pair> is<parameter>=<value>\r\n

156 - User's Manual© 2020 VIVOTEK INC. All Right Reserved

VIVOTEK[<parameter pair>]
Only the parameters that you set and are readable will be returned.
Example: Set the IP address of server to 192.168.0.123:
Request:http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123
Response:
HTTP/1.0 200 OK\r\nContent-Type: text/html\r\nContext-Length: 33\r\n\r\nnetwork.ipaddress=192.168.0.123\r\nUser's Manual - 157

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

7. Available Parameters on the Server
Valid values:
VALID VALUESDESCRIPTION

string[<n>]Text strings shorter than ‘n’ characters. The characters “,’,<,>,& areinvalid.

string[n~m]Text strings longer than `n’ characters and shorter than `m’ characters.
The characters “,’,<,>,& are invalid.

password[<n>]The same as string but displays‘*’ instead.

<integer>Any single integer number in 32-bits.
The range is -2147483648~2147483647.

<positive integer>

Any single positive integer number in 32-bits.
The range is 1~ 4294967295.

<m> ~ <n>Any number between ‘m’ and ‘n’.

domain name[<n>]A string limited to a domain name shorter than ‘n’ characters (eg.
www.ibm.com).

email address [<n>]A string limited to an email address shorter than ‘n’ characters (eg.
joe@www.ibm.com).

<ip address>

A string limited to an IP address (eg. 192.168.1.1).

<mac address>

A string limited to contain a MAC address without hyphens or colons.

<boolean>A boolean value of 1 or 0 represents [Yes or No], [True or False],[Enable or Disable].

<value1>,<value2>,<value3>,

Enumeration. Only given values are valid.

…
blank

A blank string.

everything inside <>A description

integer primary key

SQLite data type. A 32-bit signed integer. The value is assigned a uniqueinteger by the server.

<text>

SQLite data type. The value is a text string, stored using the databaseencoding (UTF-8, UTF-16BE or UTF-16-LE).

<coordinate>x, y coordinate (eg. 0,0)<window size>

window width and height (eg. 800x600)<W,H>

The format for coordinate in 2D.
W is the pixel number of width.
H is the pixel number of height.
EX: (176,144)

158 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

VALID VALUESDESCRIPTION<WxH>

The format for resolution.
W is the pixel number of width.
H is the pixel number of height.
Ex: 1920x1080, 2048x1536

available

The API is listed in product WebAPIs.

non-available

The API is not in product WebAPIs.

valid

The API is listed in product WebAPIs, and is functional.

non-valid

The API is listed in product WebAPIs, but is malfunction in this status.

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

VALUE

SECURITY(get/set)

DESCRIPTION

hostname

string[64]1/6Host name of server(Network Camera,
Wireless Network Camera,
Video Server,
Wireless Video Server).

ledoff<boolean>

6/6

date

<YYYY/MM/DD 6/6
>,
keep,
auto

Current date of system. Set to ‘keep’ tokeep date unchanged. Set to ‘auto’ touse NTP to synchronize date.

time<hh:mm:ss>,
keep,
auto

Current time of the system. Set to ‘keep’
to keep time unchanged. Set to ‘auto’ touse NTP to synchronize time.

datetime<MMDDhhmm 6/6
YYYY.ss>

Another current time format of thesystem.

ntp<domainname>,<ip address>,

NTP server.
*Do not use “skip to invoke default
server” for default value.

6/6

6/6

Turn on (0) or turn off (1) all led
indicators.

User's Manual - 159

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)<blank>timezoneindex<Not recommended touse this>-489 ~ 529

6/6

Indicate timezone and area.
-480: GMT-12:00 Eniwetok, Kwajalein-440: GMT-11:00 Midway Island, Samoa-400: GMT-10:00 Hawaii-360: GMT-09:00 Alaska-320: GMT-08:00 Las Vegas,
San_Francisco,
Vancouver-280: GMT-07:00 Mountain Time, Denver-281: GMT-07:00 Arizona-240: GMT-06:00 Central America,
Central Time, Mexico City, Saskatchewan-200: GMT-05:00 Eastern Time, New
York, Toronto-201: GMT-05:00 Bogota, Lima, Quito,
Indiana-180: GMT-04:30 Caracas-160: GMT-04:00 Atlantic Time, Canada,
La Paz, Santiago-140: GMT-03:30 Newfoundland-120: GMT-03:00 Brasilia, Buenos Aires,
Georgetown, Greenland-80: GMT-02:00 Mid-Atlantic-40: GMT-01:00 Azores, Cape_Verde_IS.
0: GMT Casablanca, Greenwich Mean
Time: Dublin,
Edinburgh, Lisbon, London
40: GMT 01:00 Amsterdam, Berlin,
Rome, Stockholm, Vienna, Madrid, Paris
41: GMT 01:00 Warsaw, Budapest, Bern
80: GMT 02:00 Athens, Helsinki, Istanbul,
Riga
81: GMT 02:00 Cairo
82: GMT 02:00 Lebanon, Minsk
83: GMT 02:00 Israel

160 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
120: GMT 03:00 Baghdad, Kuwait,
Riyadh, Moscow, St. Petersburg, Nairobi
121: GMT 03:00 Iraq
140: GMT 03:30 Tehran
160: GMT 04:00 Abu Dhabi, Muscat,
Baku,
Tbilisi, Yerevan
180: GMT 04:30 Kabul
200: GMT 05:00 Ekaterinburg, Islamabad,
Karachi, Tashkent
220: GMT 05:30 Calcutta, Chennai,
Mumbai, New Delhi
230: GMT 05:45 Kathmandu
240: GMT 06:00 Almaty, Novosibirsk,
Astana, Dhaka, Sri Jayawardenepura
260: GMT 06:30 Rangoon
280: GMT 07:00 Bangkok, Hanoi, Jakarta,
Krasnoyarsk
320: GMT 08:00 Beijing, Chongging,Hong Kong, Kuala Lumpur, Singapore,
Taipei360: GMT 09:00 Osaka, Sapporo, Tokyo,
Seoul, Yakutsk
380: GMT 09:30 Adelaide, Darwin
400: GMT 10:00 Brisbane, Canberra,
Melbourne, Sydney, Guam, Vladivostok
440: GMT 11:00 Magadan, Solomon Is.,New Caledonia
480: GMT 12:00 Aucklan, Wellington, Fiji,
Kamchatka, Marshall Is.
520: GMT 13:00 Nuku'Alofa* We replace this parameter with“system_tz” when the version number(httpversion) is equal or greater than0314b.
daylight_enable<boolean>

6/6

Enable automaticdaylight saving time inUser's Manual - 161

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)time zone.
daylight_auto_begintim string[19]e6/7

Display the current daylight saving start
time.

daylight_auto_endtime

6/7

Display the current daylight saving end

string[19]time.
daylight_timezones

string

6/6

List time zone index which support
daylight saving time.

updateinterval

utctime

0,
3600,

6/6

0 to Disable automatic time adjustment,
otherwise, it indicates the seconds

86400,

between NTP automatic update604800,2592000

intervals.

<string>

6/7

Current UTC timestamp.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0314b.

tz<POSIX TZ
string>

6/6

POSIX timezone setting.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0314b.

restore0,

7/6<positive
integer>

Restore the system parameters to default
values after <value> seconds.

reset

0,
<positive
integer>

7/6

Restart the server after <value> seconds
if <value> is non-negative.

restoreexceptnet

0,<positive
integer>

7/6

Restore the system parameters to default
values except (ipaddress, subnet, router,
dns1, dns2, pppoe).
This command can cooperate with other“restoreexceptXYZ” commands. When
cooperating with others, the systemparameters will be restored to thedefault value except for a union of the
combined results.

restoreexceptdst

0,

7/6

Restore the system parameters to default

162 - User's Manual© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY

VIVOTEKDESCRIPTION(get/set)<positive
integer>values except all daylight saving time
settings.
This command can cooperate with other“restoreexceptXYZ” commands. When
cooperating with others, the systemparameters will be restored to default
values except for a union of combined
results.

restoreexceptlang

0,

7/6

Restore the system parameters to default<positive

values except the custom language file

integer>the user has uploaded.
This command can cooperate with other“restoreexceptXYZ” commands. When
cooperating with others, the systemparameters will be restored to thedefault value except for a union of the
combined results.

restoreexceptvadp

restoreexceptfocusvalu
e

0,

7/6

Restore the system parameters to default<positive

values except the vadp parameters andinteger>

VADP modules that stored in the system.
This command can cooperate with other“restoreexceptXYZ” commands. When
cooperating with others, the systemparameters will be restored to thedefault value except for a union of the
combined results.

0,<positive
integer>

7/6

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 systemparameters will be restored to thedefault value except for a union of the
combined results.
* Only available when"capability_image_c<0~(n-1)>_remotefo

User's Manual - 163

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)cus" != 0.
restoreexceptlen

0,<positive

7/6

integer>

Restore the system parameters to default
values except lens profile.
This command can cooperate with other“restoreexceptXYZ” commands. When
cooperating with others, the systemparameters will be restored to thedefault value except for a union of the
combined results.
* Only available when"capability_image_c<0~(n-1)>_lensconfig
uration_support" != 0.

connection_timeout<integer>

6/6

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

VALUE

SECURITY(get/set)

DESCRIPTION

modelnamestring[40]0/7Internal model name of the server

extendedmodelname

string[40]0/7

ODM specific model name of server (eg.
DCS-5610). If it is not an ODM model,
this field will be equal to “modelname”

serialnumber<mac address>

1/7

12 characters MAC address (without
hyphens).

firmwareversion

string[40]0/7Firmware version, including model,
company, and version number in theformat:<MODEL-BRAND-VERSION>

language_count<positive
integer>

0/7

Number of webpage languages available
on the server.

language_i<0~(count-string[16]0/7Available language lists.

1)>

language_i0 :English164 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)language_i1 :Deutschlanguage_i2 :Españollanguage_i3 :Français
language_i4 :Italiano
language_i5 :日本語
language_i6 :Português
language_i7 :简体中文language_i8 :繁體中文customlanguage_max
count0,<positive
integer>

0/6

Maximum number of custom languages
supported on the server.

customlanguage_coun 0,<positive

0/6

Number of custom languages which havet

integer>customlanguage_i<0~(maxcount-1)>

stringbeen uploaded to the server.
0/6

Custom language name.

7.2 Status
Group: status
NAME

VALUE

SECURITY DESCRIPTION(get/set)

di_i<0~(capability_ndi-1)><product dependent><boolean>

1/7

0 => Inactive, normal
1 => Active, triggered(capability_ndi > 0)

do_i<0~(capability_ndo-1)> <boolean><product dependent>

1/7

0 => Inactive, normal
1 => Active, triggered(capability_ndo > 0)

onlinenum_rtsp

6/7

Current number of RTSP
connections.

0,<positive
integer>

User's Manual - 165

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY DESCRIPTION(get/set)

onlinenum_httppush

0,<positive
integer>

6/7

Current number of HTTP push serverconnections.

onlinenum_sip

0,<positive

6/7

Current number of SIP connections.

1/7

Get network information from

integer>
eth_i0<string>

mii-tool.
vi_i<0~(capability_nvi-1)><product dependent><boolean>

1/7

Virtual input
0 => Inactive
1 => Active(capability_nvi > 0)

7.2.1 Status per Channel
Group: status_c<0~(n-1)> for n channel productsn denotes the value of "capability_nvideoin"
NAME

VALUE

SECURITY DESCRIPTION(get/set)signal_detect<boolean>

1/7

Indicates whether the video source isconnected or not.
* Only available whencapability_videoin_type is 0 or 1.

signal_typentsc,pal

1/7

The actual modulation type.
* Only available whencapability_videoin_type is 0 or 1.

7.3 Digital Input Behavior DefineGroup: di_i<0~(n-1)> for n is the value of "capability_ndi" (capability_ndi > 0)
NAME

VALUE

SECURITY DESCRIPTION(get/set)normalstate

high,
low

1/1

Indicates open circuit or closed circuit(inactive status)

7.4 Digital Output Behavior DefineGroup: do_i<0~(n-1)> for n is the value of "capability_ndo" (capability_ndo > 0)

166 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY DESCRIPTION(get/set)normalstate

open,
grounded

1/1

Indicate open circuit or closed circuit(inactive status)

NAME

VALUE

SECURITY DESCRIPTION(get/set)privilege_do

view, operator,

1/6

7.5 Security
Group: security

admin

Indicate which privileges and above
can control digital output(capability_ndo > 0)

privilege_camctrl

view, operator,
admin

1/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 nameuser_i0_pass

password[64]7/6Root password

user_i<1~20>_pass

password[64]7/6User password

user_i0_privilege

view,
operator,
admin

6/7

Root privilege

user_i<1~20>_ privilege

view,
operator,
admin

6/6

User privilege

7.6 Network
Group: network
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

preprocess<positive integer>

6/6

An 32-bit integer, each bit can be set
separately as follows:
Bit 0 => HTTP service;
Bit 1=> HTTPS service;

User's Manual - 167

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)Bit 2=> FTP service;
Bit 3 => Two way audio and RTSP
Streaming service;
To stop service before changing its portsettings. It’s recommended to set thisparameter 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, andchange RTP port for video from 5556 to
20480.
Then, set preprocess=9 to stop both
service first.
”/cgi-bin/admin/setparam.cgi?
network_preprocess=9&network_http_port=5556&
network_rtp_videoport=20480”
type

lan,
pppoe

6/6

Network connection type.

resetip<boolean>

6/6

1 => Get ipaddress, subnet, router,
dns1, dns2 from DHCP server at next
reboot.
0 => Use preset ipaddress, subnet,
rounter, dns1, and dns2.

ipaddress<ip address>

6/6

IP address of server.

subnet<ip address>

6/6

Subnet mask.

router<ip address>

6/6

Default gateway.

dns1<ip address>

6/6

Primary DNS server.

dns2<ip address>

6/6

Secondary DNS server.

wins1<ip address>

6/6

Primary WINS server.

168 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
wins2<ip address>

6/6

Secondary WINS server.

7.6.1 802.1x
Subgroup of network: ieee8021x (capability_protocol_ieee8021x > 0)
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

enable<boolean>

6/6

Enable/disable IEEE 802.1x

eapmethod

eap-peap, eap-tls

6/6

Selected EAP method

identity_peap

string[64]6/6PEAP identity

identity_tls

string[64]6/6TLS identity

password

string[200]7/6

Password for TLS

privatekeypassword

string[200]7/6

Password for PEAP

ca_exist<boolean>

6/6

CA installed flag

ca_time0,<positive
integer>

6/7

CA installed time. Represented in
EPOCH

ca_size0,<positive
integer>

6/7

CA file size (in bytes)

certificate_exist<boolean>

6/6

Certificate installed flag (for TLS)

certificate_time

0,<positive
integer>

6/7

Certificate installed time. Represented
in EPOCH

certificate_size

0,<positive
integer>

6/7

Certificate file size (in bytes)

privatekey_exist<boolean>

6/6

Private key installed flag (for TLS)

privatekey_time

0,<positive

6/7

Private key installed time. Represented

integer>
privatekey_size

0,<positive
integer>in EPOCH
6/7

Private key file size (in bytes)

7.6.2 QOS
Subgroup of network: qos_cos (capability_protocol_qos_cos > 0)
NAME

VALUE

SECURITY DESCRIPTION(get/set)

enable<boolean>

6/6

Enable/disable CoS (IEEE 802.1p)

vlanid

1~4095

6/6

VLAN ID
User's Manual - 169

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY DESCRIPTION(get/set)

video

0~7

6/6

Video channel for CoS

audio<product dependent>

0~7

6/6

Audio channel for CoS(capability_naudioin > 0)

eventalarm

0~7

6/6

Event/alarm channel for CoS

management

0~7

6/6

Management channel for CoS

eventtunnel

0~7

6/6

Event/Control channel for CoS

Subgroup of network: qos_dscp (capability_protocol_qos_dscp > 0)
NAME

VALUE

SECURITY DESCRIPTION(get/set)

enable<boolean>

6/6

Enable/disable DSCP

video

0~63

6/6

Video channel for DSCP

audio

0~63

6/6

Audio channel for DSCP
(capability_naudioin > 0)

eventalarm

0~63

6/6

Event/alarm channel for DSCP

management

0~63

6/6

Management channel for DSCP

eventtunnel

0~63

6/6

Event/Control channel for DSCP

7.6.3 IPV6
Subgroup of network: ipv6 (capability_protocol_ipv6 > 0)
NAME

VALUE

SECURITY DESCRIPTION(get/set)

enable<boolean>

6/6

Enable IPv6.

addonipaddress<ip address>

6/6

IPv6 IP address.

addonprefixlen

0~128

6/6

IPv6 prefix length.

addonrouter<ip address>

6/6

IPv6 router address.

addondns<ip address>

6/6

IPv6 DNS address.

allowoptional<boolean>

6/6

Allow manually setup of IP address
setting.

7.6.4 FTP
Subgroup of network: ftp
NAME

170 - User's Manual

VALUE

SECURITY DESCRIPTION(get/set)© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

VIVOTEKSECURITY DESCRIPTION(get/set)

port

21, 1025~65535

6/6

Local ftp server port.

enable<boolean>

6/6

Enable ftp.

7.6.5 HTTP
Subgroup of network: http
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

port

80, 1025 ~
65535

1/6

HTTP port.

alternateport1025~65535

6/6

Alternate HTTP port.

authmode

basic,
digest

1/6

HTTP authentication mode.

s<0~(capability_nmed
iastream*capability_nvideoin)-1)>_accessna

string[32]1/6

Http server push access name for stream

me<product dependent><Not recommended
to use this>N, N=
1~(capability_nmediastream*capability_
nvideoin)-1).
(capability_protocol_spush_mjpeg =1
and capability_nmediastream > 0)
The value are shown asvideo1s1.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.

User's Manual - 171

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

7.6.6 HTTP per Channel
Subgroup of network: http_c<0~(n-1)> for n channel productsn denotes the value of "capability_nvideoin"
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

s<0~(capability_nmedia
stream-1)>_accessname<product dependent>

string[32]1/6

Http server push access name forchannel 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 asvideo1s1.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 theversion number (httpversion) is equal or
greater than 0311c.

7.6.7 HTTS Port
Subgroup of network: https (capability_protocol_https > 0)
NAME

VALUE

SECURITY DESCRIPTION(get/set)

port

443, 1025 ~
65535

1/6

7.6.8 RTSP
Subgroup of network: rtsp (capability_protocol_rtsp > 0)

172 - User's Manual

HTTPS port.

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
port

554, 1025 ~ 65535

1/6

RTSP port.
(capability_protocol_rtsp=1)

authmode

disable,1/6

RTSP authentication mode.

basic,(capability_protocol_rtsp=1)

digests<0~(capability_nmed

string[32]

1/6

RTSP access name for channel andiastream*capability_nvideoin)-1)>_accessna

stream.
(capability_protocol_spush_mjpeg

me=1 and capability_nmediastream > 0)
The value are shown as<product dependent>

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 notallowed.
* We modify the value of RTSP
access name after version
number(httpversion) is 0311cc<0~(capability_nvide string[32]oin)-1>_s<0~(capabilit
y_nmediastream)-1)>_accessname<product dependent>

1/6

RTSP access name for channel N
stream M, N= 1~
capability_nvideoin, M =1~capability_nmediastream.
The value are shown aslive1s1.sdp = c0_s0_accessname,(channel1stream1)
live1s2.sdp = c0_s1_accessname,(channel1stream2)
live1s3.sdp = c0_s2_accessname,

User's Manual - 173

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)(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 notallowed.
* We modify the value of RTSP
access name after version
number(httpversion) is 0311c
pimssm_enable<boolean>

7/6

To enable the feature of Protocol
Independent Multicast - Source
Specific Multicast.
* We support this parameter whenthe 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

alwaysmulticast<boolean>

4/4Enable always multicast.

ipaddress<ip
address>

4/4

Multicast video IP address.
* We replace"network_rtsp_s<0~(n-1)>_multicast_ipaddress"
with "
network_rtsp_s<0~(n-1)>_multicast_videoipadd
ress ".
* Reserved for compatibility, and suggest don't
use this since [httpversion] > 0304a

videoipaddress<ip
address>

4/4

Multicast video IP address.
* We support this parameter when the version
number (httpversion) is equal or greater than

174 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
0304a.
audioipaddress<product<ip
address>

4/4

dependent>

Multicast audio IP address.
* We support this parameter when the version
number (httpversion) is equal or greater than0304a.
* Only available when capability_naudioin > 0

metadataipaddres

<ip

4/4

s

address>

Multicast metadata IP address.
* We support this parameter when the version
number (httpversion) is equal or greater than0304a.

videoport

1025 ~
65535

4/4

Multicast video port.

audioport<product1025 ~
65535

4/4

Multicast audio port.
* Only available when capability_naudioin > 0

metadataport1026~6553
4

4/4

Multicast metadata port.

ttl

1 ~ 255

4/4

Multicasttime to live value.

dependent>

7.6.10 SIP Port
Subgroup of network: sip (capability_protocol_sip> 0)
NAME

VALUE

SECURITY DESCRIPTION(get/set)

port

1025 ~ 65535

1/6

NAME

VALUE

SECURITY(get/set)

DESCRIPTION

videoport

1025 ~ 65535

6/6Video channel port for RTP.

audioport

1025 ~ 65535

6/6

Audio channel port for RTP.

SIP port.

7.6.11 RTP Port
Subgroup of network: rtp

User's Manual - 175

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
metadataport

1025 ~ 65535

6/6

Metadata channel port for RTP.

7.6.12 PPPoE
Subgroup of network: pppoe (capability_protocol_pppoe > 0)
NAME

VALUE

SECURITY DESCRIPTION(get/set)user

string[128]6/6

PPPoE account user name.

pass

password[64]7/6PPPoE account password.

7.6.13 Bonjour
Subgroup of network: service_bonjour
NAME

VALUE

SECURITY DESCRIPTION(get/set)

enable<boolean>

6/6

Enable bonjour service feature.
* We support this parameter when theversion number (httpversion) is equal
or greater than 0312a.

servicename<string>

6/6

A friendly name for bonjour service.
* We support this parameter when theversion number (httpversion) is equal
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

VALUE

SECURITY DESCRIPTION(get/set)

port

22,
1025~65535

6/6

Local sftp server port.

enable<boolean>

6/6

Enable sftp.

7.7 IP Filter
Group: ipfilter

176 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
enable<boolean>

6/6

Enable access list filtering.

admin_enable<boolean>

6/6

Enable administrator IP address.

admin_ip

string[43]6/6Administrator IP address.

maxconnection

1~

6/6

Maximum number of (s).

6/6

Ipfilter policy :"capability_protoc
ol_maxconnection"
type

0, 1

0 => allow
1 => deny
ipv4list_i<0~9>Single address: <ip
address>

6/6

IPv4 address list.

6/6

IPv6 address list.

Network address:<ip address /network mask>
Range
address:<start ip
address - end ip
address>
ipv6list_i<0~9>

string[43]7.8 Video Input<Not Recommended to use>
Group: videoin* We do not support this parameter when "capability_nvideoin > 1".
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

cmosfreq50, 60

4/4

CMOS frequency.
* Only available whencapability_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.

whitebalance

auto,

4/4

Modes of white balance.

User's Manual - 177

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)<product dependent>"auto": Auto white balance

panorama,
manual,"panorama": indicates that camera
would try to balance the whiterbgain,widerange,
outdoor,balance effect of every sensor.
"rbgain": Use rgain and bgain to set
white balance manually.

indoor,sodiumauto,etc"manual": 2 cases:(Available values
are listed instatus.

a. if "rbgain" is not supported, thismeans keep current white balanceb. if "rbgain" is supported, "rgain"and "bgain" are updated to the"capability_image_c<0~(n-1)>_wbmo
de")current values which is got fromwhite balance module. Then, act asrbgain mode
"widerange": Auto Tracing Whitebalance (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)>_wbmo
de" !="-"* 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.

exposurelevel

0~12

4/4

Exposure level"0,12": This range takes the conceptfrom DC's exposure tuning options.
The definition is:0: EV -2.0
1: EV -1.7

178 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
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)>_exposu
re_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.
irismode

fixed, indoor,
outdoor

4/4<product
independent>

Control DC-Iris mode.
"outdoor": Auto-setting DC-Iris to getbest quality, but easy to meet rollingor 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.

enableblc<boolean>

4/4Enable backlight compensation.

User's Manual - 179

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)<Not support
anymore>* Not support this parameter
anymore when the version number(httpversion) is equal or greater than
0301a.
* It's recommanded to use"exposurewin_c<0~(n-1)>_mode" toswitch on/off BLC.

color

0, 1

4/4

0 =>monochrome
1 => 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.

flip<boolean>

4/4

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

mirror<boolean>

4/4

Mirror 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,270

1/4

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

180 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)* This parameter will not be used
after the version number (httpversion)is equal or greater than 0400a.
ptzstatus

0,<positive<Not support
anymore>integer>

1/7

A 32-bit integer, each bit can be set
separately as follows:
Bit 0 => Support camera control
function; 0(not support), 1(support)
Bit 1 =>Built-in or external camera; 0(external), 1(built-in)
Bit 2 => Support pan operation; 0(notsupport), 1(support)
Bit 3 => Support tilt operation; 0(notsupport), 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 than0309a.

text

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

imprinttimestamp<boolean>

4/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<product dependent><1~32000>,<5~32000>,

4/4

Minimum exposure time
1~32000 => 1s ~ 1/32000s

User's Manual - 181

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)<1~8000>,<5~8000>,

5~32000 => 1/5s ~ 1/32000s
1~8000 => 1s ~ 1/8000s

etc.

5~8000 => 1/5s ~ 1/8000s* Available value isetc.
* Only available when

listed in"capability_image_c<0~(n-1)>_exposu"capability_image_c<0~(n-1)>_exposu

re_minrange" != "-"* Only valid whenre_minrange""piris_mode"=manual or"irismode"=fixed* Only available when"capability_image_c<0~(n-1)>_exposu
re_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.

maxexposure<1~32000>,<product dependent><5~32000>,<1~8000>,<5~8000>,
etc.
* Available value islisted in"capability_image_c<0~(n-1)>_exposu
re_maxrange"

182 - User's Manual

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 tosensor 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 5frame/s.
* Only available when"capability_image_c<0~(n-1)>_exposu
re_maxrange" != "-"* Only valid when"piris_mode"=manual or

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)"irismode"=fixed* Only available when"capability_image_c<0~(n-1)>_exposu
re_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.
enablepreview<boolean>

1/4

Usage for UI of exposure settings.
Preview settings of video profile.
* Only available when"capability_image_c<0~(n-1)>_exposu
re_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, 60

4/4

CMOS frequency.
* Only available when "capability_videoin_type " is 2

mode

0~
"capability_videoin_c<0~(n-1)>_nmode"-1

4/4

Indicate the video mode on use.

whitebalance<product
dependent>

auto,
panorama,
manual,4/4

Modes of white balance.
"auto": Auto white balance"panorama": indicates that camera

rbgain,would try to balance the white

User's Manual - 183

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY(DESCRIPTION

get/set)widerange,
outdoor,balance effect of every sensor.
"rbgain": Use rgain and bgain to set
white balance manually.

indoor,sodiumauto,etc"manual": 2 cases:(Available values are listedinstatus.

a. if "rbgain" is not supported, thismeans keep current white balance"capability_image_c<0~(n-b. if "rbgain" is supported, "rgain"and "bgain" are updated to the1)>_wbmode")current values which is got fromwhite balance module. Then, act asrbgain mode
"widerange": Auto Tracing Whitebalance (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)>_wbmo
de" !="-"

rgain

0~100

4/4

Manual set rgain value of gain control
setting.
0: Weak <-> 100: Strong* Only available when "rbgain" islisted in"capability_image_c<0~(n-1)>_wbmode".
* Only valid when"videoin_c<0~(n-1)>_whitebalance" !
= auto* Normalized range.

bgain

0~100

4/4

Manual set bgain value of gain control
setting.
0: Weak <-> 100: Strong

184 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY(DESCRIPTION

get/set)* Only available when "rbgain" islisted in"capability_image_c<0~(n-1)>_wbmode".
* Only valid when"videoin_c<0~(n-1)>_whitebalance" !
= auto* Normalized range.
exposurelevel

0~12

4/4

Exposure level"0,12": This range takes the conceptfrom 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)>_exposu
re_mode" !=0

exposuremode<product
dependent>

auto,
shutterpriority,
irispriority,
qualitypriority,
manual,etc(Available options are list

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

User's Manual - 185

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY(DESCRIPTION

get/set)in"capability_image_c<0~(n-variable Iris, and keep adjusting Gain
and Shutter speed automatically.

1)>_exposure_modetype")"qualitypriority": Automaticallyadjust the Iris, Gain and Shutter Speedby VIVOTEK quality algorithm.
"manual": Manually adjust withvariable Shutter, Iris and Gain.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.
* Only available when"capability_image_c<0~(n-1)>_exposu
re_mode" !=0

irismode

fixed, indoor, outdoor<product dependent>

4/4

Control DC-Iris mode.
"outdoor": Auto-setting DC-Iris to getbest quality, but easy to meet rollingor 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_mode<product
dependent>

manual, indoor, outdoor,-

1/4

Control P-Iris mode.
"outdoor": Auto-setting P-Iris to getbest quality, but easy to meet rollingor 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")

186 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY(DESCRIPTION

get/set)* Only available when"capability_image_c<0~(n-1)>_iristype"=pirispiris_position

1~100

1/4

<product
dependent>

Manual 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"=pirisenableblc<Not support<boolean>

4/4

anymore>Enable backlight compensation* Not support this parameter
anymore when the version number(httpversion) is equal or greater than
0301a.
* It's recommanded to use"exposurewin_c<0~(n-1)>_mode" toswitch on/off BLC.

maxgain

0~100

4/4

Maximum 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)>_exposu
re_rangetype" is "twovalues".

mingain

0~100

4/4

Minimum gain value.
0: Low <-> 100: High* Only available when"capability_image_c<0~(n-1)>_agc_mi

User's Manual - 187

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY(DESCRIPTION

get/set)ngain" != "-"* Only valid when"piris_mode"=manual or"irismode"=fixed* Normalized range.
* Only available when"capability_image_c<0~(n-1)>_exposu
re_rangetype" is "twovalues".
gainvalue

0~100

4/4

Gain value.
0: Low <-> 100: High* Only available when"capability_image_c<0~(n-1)>_agc_maxgain" != "-" and"capability_image_c<0~(n-1)>_exposu
re_rangetype" is "onevalue".
* Normalized range.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.

color

0, 1

4/4

0 =>monochrome
1 => color* Only available when "capability_videoin_c<0~(n-1)>_color_support" is 1.

flip<boolean>

4/4

Flip the image.

mirror<boolean>

4/4

Mirror the image.

rotate0,90,180,270

1/4

The rotation angle of image.
Support only in Rotation mode
(capability_videoin_c<0~(n-1)>_rotati
on=1)

ptzstatus<Not support
anymore>0,<positive integer>

1/7

A 32-bit integer, each bit can be set
separately as follows:
Bit 0 => Support camera control
function; 0(not support), 1(support)
Bit 1 =>Built-in or external camera; 0(external), 1(built-in)

188 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY(DESCRIPTION

get/set)Bit 2 => Support pan operation; 0(notsupport), 1(support)
Bit 3 => Support tilt operation; 0(notsupport), 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 than0309a.
text

string[64]1/4Enclose caption.

imprinttimesta
mp<boolean>

4/4Overlay time stamp on video.

textonvideo_p

top, bottom

4/4

Text on video string position

20~40

4/4

Text on video font size

ositiontextonvideo_sizetextonvideo_fo /usr/share/font/Default.ttf 4/4
ntpath, /mnt/flash2/upload.ttf

Choose camera default font file(/usr/share/font/Default.ttf) or user
uploaded fontfile(/mnt/flash2/upload.ttf).

textonvideo_u
ploadfilename

Depends on the font filename uploaded by user

1/7

Show the uploaded font file name.

minexposure<product
dependent><1~32000>,<5~32000>,<1~8000>,<5~8000>,
etc.

4/4

Minimum 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.
* Only available when"capability_image_c<0~(n-1)>_exposu
re_minrange" != "-"* Only valid when

* Available value is listedin"capability_image_c<0~(n1)>_exposure_minrange"

User's Manual - 189

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY(DESCRIPTION

get/set)"piris_mode"=manual or"irismode"=fixed* Only available when"capability_image_c<0~(n-1)>_exposu
re_rangetype" is "twovalues".
maxexposure<product<1~32000>,<5~32000>,

4/4

Maximum exposure time
1~32000 => 1s ~ 1/32000s

dependent><1~8000>,

5~32000 => 1/5s ~ 1/32000s<5~8000>,
etc.

1~8000 => 1s ~ 1/8000s
5~8000 => 1/5s ~ 1/8000s* Available value is listed

etc.

in
"capability_image_c<0~(n1)>_exposure_maxrange"* This parameter may also restrict
image frame rate from sensor due tosensor 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 5frame/s.
* Only available when"capability_image_c<0~(n-1)>_exposu
re_maxrange" != "-"* Only valid when"piris_mode"=manual or"irismode"=fixed* Only available when"capability_image_c<0~(n-1)>_exposu
re_rangetype" is "twovalues".

shuttervalue<product
dependent>

190 - User's Manual<1~32000>,<5~32000>,<1~8000>,<5~8000>,
etc.

4/4

* Available value is listed

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 restrictinimage frame rate from sensor due to"capability_image_c<0~(n-sensor generates a frame per

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY(DESCRIPTION

get/set)1)>_exposure_maxrange"

exposure time. Ex: If this is set to 1/5s
~ 1/8000s and camera takes 1/5s on
the night, then sensor only outputs 5frame/s.
* Only available when"capability_image_c<0~(n-1)>_exposu
re_maxrange" != "-" and"capability_image_c<0~(n-1)>_exposu
re_rangetype" is "onevalue".
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.

enablepreview<boolean>

1/4

Usage for UI of exposure settings.
Preview settings of video profile.
* Only available when"capability_image_c<0~(n-1)>_exposu
re_mode" !=0

meteringmode

auto,

4/4

"auto": The algorithm chooses theblc,best metering strategy.

hlc* Available value is listed"blc": This metering method increases
the weight of dark area.

in"capability_image_c<0~(n1)>_exposure_meteringm
ode""hlc": The metering method can
detect strong light and make affectedarea clear.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0311a.

crop_position<coordinate>
(x,y)

1/7

Crop left-top corner coordinate.

crop_size<window size>
(WxH)

1/7

Crop width and height.
(width must be 16x or 32x and heightmust be 8x)

zoomratiodispl<boolean>

1/4

Indicates multiple of zoom in isay“on-screen display” or not.
* We support this parameter when

User's Manual - 191

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY(DESCRIPTION

get/set)the version number (httpversion) is
equal or greater than 0302a.
bracketing_lev

1~100

4/4



el

The total available lists(capability_image_c<0~(n-1)>_ex
posure_bracketing_range) will benormalized 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)>_exposu
re_bracketing_mode"=1.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0310a.
s<0~(m-1)>_en <boolean>

4/4

ableeptz
s<0~(m-1)>_co
dectype

Indicate whether stream supprts eptz
or notListed at"capability_videoin_codec

1/4

Codec type for this stream

Available options are list in 1/4"capability_videoin_c<0~(n-1)>_resolution".

Video resolution in pixels.

"
Possible values are: mjpeg,
h264,h265<product dependent>s<0~(m-1)>_resolution

Besides, available options
is referred to"capability_videoin_c<0~(n-1)>_maxresolution" and"capability_videoin_c<0~(n-1)>_minresolution"s<0~(m-1)>_smartfps_enabl

192 - User's Manual<boolean>

4/4Enable "Smart fps" function.
* Only available when

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY(DESCRIPTION

get/set)e"capability_videoin_c<0~(n-1)>_smart
fps_support" is 1.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0309a.

s<0~(m-1)>_h2 <boolean>
64_dintraperio

4/4

d_enable

Enable "Dynamic intra frame period".
* Only available when"capability_videoin_c<0~(n-1)>_dintra
period_support" is 1.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0301c.

s<0~(m-1)>_h2 250, 500, 1000, 2000,
64_intraperiod 3000, 4000

4/4

The time interval between two
I-frames (Intra coded picture).
The unit is millisecond (ms).

s<0~(m-1)>_h2 cbr, vbr
64_ratecontrol
mode

4/4

cbr: Constant bit rate mode.
vbr: Fixed quality mode, all frames are
encoded in the same quality.

s<0~(m-1)>_h2 1~5,
64_quant
99, 100

4/4

Set the pre-defined quality level:
1: Medium
2: Standard
3: Good
4: Detailed
5: Excellent
100: Use the quality level in"qpercent"
99: Use the quality level in "qvalue"* Only valid when"h264_ratecontrolmode"= vbr.

s<0~(m-1)>_h2 0~51
64_qvalue

4/4

Manual video quality level input. The
Q value which is used by encoded
library directly.
* Only valid when"h264_ratecontrolmode"= vbr ands<0~(m-1)>_h264_quant = 99.

s<0~(m-1)>_h2 1~100

4/4

Select customized quality in a

User's Manual - 193

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY(DESCRIPTION

get/set)64_qpercent

normalized full range.
1: Worst quality
100: Best quality* Only valid when"h264_ratecontrolmode"= vbr and"quant"= 100.

s<0~(m-1)>_h2 20000~"capability_videoin
64_maxvbrbitr _c<0~(n-1)>_h264_maxbit
ate

4/4

rate"

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)>_h2 1~5, 100
64_cbr_quant

4/4

Set the pre-defined quality level:
1: Medium
2: Standard
3: Good
4: Detailed
5: Excellent
100: Use the quality level in"cbr_qpercent"* Only available when"h264_ratecontrolmode"= cbr.

s<0~(m-1)>_h2 1~100
64_cbr_qpercent

4/4

Select customized quality in anormalized full range.
1: Worst quality
100: Best quality* Only valid when"h264_ratecontrolmode"= cbr and"quant"= 100.

s<0~(m-1)>_h2 20000~"capability_videoin
64_bitrate_c<0~(n-1)>_h264_maxbit
rate"

4/4

The target bit rate in constant bit ratemode.
* Only valid when"h264_ratecontrolmode"= cbr

s<0~(m-1)>_h2 framerate,imagequality
64_prioritypoli

4/4

Set prioritypolicy* Only valid when

194 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY(DESCRIPTION

get/set)cy"h264_ratecontrolmode"= cbr

s<0~(m-1)>_h2 1~"capability_videoin_c<0 1/4
64_maxframe ~(n-1)>_h264_maxframera

The maximum frame rates of a H264
stream at differentte"resolutions("capability_videoin_c<0~(n-1)>_resolution") are recorded in"capability_videoin_c<0~(n-1)>_h264_maxframerate"s<0~(m-1)>_h2 0~264_profile

1/4

Indicate H264 profiles* Available values can also

0: baseline

be <string> listed in"capability_videoin_c<n>_1: main2: highh264_profile"* It’s recommended to use available
values from
"capability_videoin_c<n>_h264_profile".

s<0~(m-1)>_h2 <boolean>
64_smartq_en
able

4/4

Enable "Smart Q" function.
* Only available when"capability_videoin_c<0~(n-1)>_smart
q_support" is 1.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0309a.

s<0~(m-1)>_h2 <boolean>
65_dintraperio
d_enable

4/4

Enable "Dynamic intra frame period".
* Only available when"capability_videoin_c<0~(n-1)>_dintra
period_support" is 1 and h265 is listedin "capability_videoin_codec".
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0301c.

s<0~(m-1)>_h2 250, 500, 1000, 2000,
65_intraperiod 3000, 4000

4/4

The 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)>_h2 cbr, vbr

4/4

cbr: Constant bit rate mode.

User's Manual - 195

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY(DESCRIPTION

get/set)vbr: Fixed quality mode, all frames are
encoded in the same quality.

65_ratecontrolmode* Only available when h265 is listed in"capability_videoin_codec".
s<0~(m-1)>_h2 1~5,
65_quant
99, 100

4/4

Set the pre-defined quality level:
1: Medium
2: Standard
3: Good
4: Detailed
5: Excellent
100: 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)>_h2 0~51

4/4

65_qvalue

Manual 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)>_h2 1~10065_qpercent

4/4

Select customized quality in anormalized full range.
1: Worst quality
100: 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)>_h2 20000~"capability_videoin
65_maxvbrbitr _c<0~(n-1)>_h265_maxbit

4/4

The maximum allowed bit rate in fixed
quality mode.

196 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY(DESCRIPTION

get/set)
ate

rate"

When the bit rate exceeds this value,
frames will be dropped to restrict the
bit rate.
* Only available when h265 is listed in"capability_videoin_codec".
* Only valid when"h265_ratecontrolmode"= vbr

s<0~(m-1)>_h2 1~5, 100

4/4

65_cbr_quantSet the pre-defined quality level:
1: Medium
2: Standard
3: Good
4: Detailed
5: Excellent
100: 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)>_h2 1~100

4/4

65_cbr_qpercent

Select customized quality in anormalized full range.
1: Worst quality
100: 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)>_h2 20000~"capability_videoin
65_bitrate_c<0~(n-1)>_h265_maxbit
rate"

4/4

The target bit rate in constant bit ratemode.
* Only available when h265 is listed in"capability_videoin_codec".
* Only valid when"h265_ratecontrolmode"= cbr

s<0~(m-1)>_h2 framerate,imagequality

4/4

Set prioritypolicy

User's Manual - 197

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY(DESCRIPTION

get/set)65_prioritypolicy* Only available when h265 is listed in"capability_videoin_codec".
* Only valid when"h265_ratecontrolmode"= cbr

s<0~(m-1)>_h2 1~"capability_videoin_c<0 1/4
65_maxframe ~(n-1)>_h265_maxframerate"

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)>_h2 Available values are listed
65_profile
in "

1/4

capability_videoin_c<0~(n-1)>_h265_profile"s<0~(m-1)>_h2 <boolean>

Indicate H265 profiles* Only available when h265 is listed in"capability_videoin_codec".

4/4

65_smartq_en
able

Enable "Smart Q" function.
* Only available when h265 is listed in"capability_videoin_codec".
* Only available when"capability_videoin_c<0~(n-1)>_smart
q_support" is 1.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0309a.

s<0~(m-1)>_mj cbr, vbr
peg_ratecontr
olmode4/4

cbr: Constant bit rate mode.
vbr: Fixed quality mode, all frames are
encoded in the same quality.

s<0~(m-1)>_mj 1~5,
peg_quant99, 100

4/4* Only valid when"mjpeg_ratecontrolmode"= vbr.
Set the pre-defined quality level:
1: Medium
2: Standard
3: Good
4: Detailed

198 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY(DESCRIPTION

get/set)
5: Excellent
100: Use the quality level in"qpercent"
99: Use the quality level in "qvalue"s<0~(m-1)>_mj 10~200
peg_qvalue(Only valid when

4/4

Manual video quality level input. The
Q value which is used by encoded"capability_api_httpversio

library directly.
* Only valid whenn" format is XXXXX_1 or
XXXXX_3 or XXXXX_4"mjpeg_ratecontrolmode"= vbr and

ex: 0301a_1 or 0301a_3 ors<0~(m-1)>_mjpeg_quant = 99

0301a_4)
or 1~99(Only valid when"capability_api_httpversion" format is XXXXX_2,
ex: 0301a_2)<product dependent>s<0~(m-1)>_mj 1~1004/4

peg_qpercent

Select customized quality in anormalized full range.
1: Worst quality
100: Best quality* Only valid when"mjpeg_ratecontrolmode"= vbr ands<0~(m-1)>_mjpeg_quant = 100.

s<0~(m-1)>_mj 20000~"capability_videoin 4/4
peg_maxvbrbit _c<0~(n-1)>_mjpeg_maxbi
rate
trate"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"mjpeg_ratecontrolmode"= vbr

s<0~(m-1)>_mj 1~5, 100
peg_cbr_quantSet the pre-defined quality level:
1: Medium
2: Standard
3: Good
4: Detailed

4/4

User's Manual - 199

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY(DESCRIPTION

get/set)
5: Excellent
100: Use the quality level in"cbr_qpercent"* Only valid when"mjpeg_ratecontrolmode"= cbr.
s<0~(m-1)>_mj 1~100
peg_cbr_qperc

4/4

ent

Select customized quality in anormalized full range.
1: Worst quality
100: Best quality* Only valid when"mjpeg_ratecontrolmode"= cbr and"quant"= 100.

s<0~(m-1)>_mj 20000~"capability_videoin 4/4
peg_bitrate_c<0~(n-1)>_mjpeg_maxbi
trate"The target bit rate in constant bit ratemode.
* Only valid when"mjpeg_ratecontrolmode"= cbr

s<0~(m-1)>_mj framerate,imagequality
peg_prioritypo

4/4

Set prioritypolicy* Only valid whenlicy"mjpeg_ratecontrolmode"= cbr

s<0~(m-1)>_mj 1~"capability_videoin_c<0 1/4
peg_maxframe ~(n-1)>_mjpeg_maxframerate"

The 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)>_mjpe
g_maxframerate"s<0~(m-1)>_ra
tiocorrect

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

1/4* Only available whencapability_videoin_type is 0 or 1.

200 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY(DESCRIPTION

get/set)wdrpro_mode<product0, 1, 2

4/4

dependent>

0: Disable WDR Pro.
1: Enable WDR Pro.
* Only valid when"capability_image_c<0~(n-1)>_wdrpro_mode" = 1
2: Enable WDR Pro II.
* Only valid when"capability_image_c<0~(n-1)>_wdrpro_mode" = 2

wdrpro_streng

1~100

4/4

The strength of WDR Pro.

th<product

The bigger value means the stronger
strength of WDR Pro.

dependent>* Only available when"capability_image_c<0~(n-1)>_wdrpro_strength" is 1

wdrc_mode<product<boolean>

4/4dependent>
wdrc_strength<product
dependent>

Enable WDR enhanced.
* Only available when"capability_image_c<0~(n-1)>_wdrc_
mode" is 1

1~100

4/4

The 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_mode<product
dependent><boolean>

4/4Turning AE converge speed on or off.
0: off
1: on* Only available when"capability_image_c<0~(n-1)>_aespeed" is 1

aespeed_spee
dlevel<product
dependent>

1~100

4/4

The speed level of AE converge speed.
1~20: level 1
21~40: level 241~60: level 361~80: level 4

User's Manual - 201

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY(DESCRIPTION

get/set)81~100: level 5
Level 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_sensi

1~100

4/4

The sensitivity of AE converge speed.

tivity1~20: level 1<product
dependent>

21~40: level 241~60: level 361~80: level 481~100: level 5
Level 1~4(low ~ high)
The higher sensitivity level meas that
it 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)>_aespee
dsupportsensitivity" is 1.

flickerless<product
dependent><boolean>

4/4Turn on(1) or turn off(0) the flickerlessmode* Only available when"capability_image_c<0~(n-1)>_flickerl
ess" is 1.

mounttypeceiling, wall, floor

1/6

Hardware installation.
* Only available when"capability_videoin_c<0~(n-1)>_moun
ttype" != "-".

enablewaterm
ark

0, 1

1/6

0: Not to add watermarks on images
1: Add watermarks on images<product
dependent>

202 - User's Manual* Only available when"capability_fisheye" > 0VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY(DESCRIPTION

get/set)s<0~(m-2)>_fis
heyedewarpm‘1O, 1P, 2P, 1R, 4R’ forceiling/floor mountode‘1O, 1P, 1R, 4R’ for wall

<product
dependent>

mount<product dependent>

1/4

Local dewarp mode.
“1O” is original mode (disable).
Supported dewarp mode is different
by mount type.
* Only available when"capability_fisheyelocaldewarp_c<0~(* Available value is listedin"capability_videoin_c<0~(capability_nvideoin)-1>" > 0n-1)>_localdewarp_typeceilingmount" and"capability_videoin_c<0~(n-1)>_localdewarp_typew
allmount"
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"
NAME

VALUE

SECURITYDESCRIPTION(get/set)
enable<boolean>

4/4Enable or Disable smart codec
function

mode

autotracking,manual,hybrid4/4

Set Smart stream mode
"autotracking": only available when"capability_smartstream_mode_autot
racking" is 1.
"manual": only available when"capability_smartstream_mode_manual" is 1.
"hybrid": only available when"capability_smartstream_mode_hybri
d" is 1.

qualitypriority-5,-4,-3,-2,-1,1,2,3,4,5

4/4

The differential value of Q between
the regions of interest (ROI) and theareas of non-interest (non-ROI) of theUser's Manual - 203

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)
display image.
If the value is a positive number, thevideo quality of ROI is better than the
non-ROI areas. The level is from 1 to
5. Level 5 is the maximum level of thequality difference between the ROI
and non-ROI areas.
If the value is a negative number, thevideo quality of non-ROI areas isbetter than the ROI. The level is from
-1 to -5. Level -5 is the maximum levelof 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 andcapability_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",kdenotes the value of "capability_smartstream_nwindow_manual".
NAME

VALUE

SECURITYDESCRIPTION(get/set)
enable<boolean>

4/4Enable or disable the window.

home

0~320,0~240

4/4

Left-top corner coordinate of thewindow.

size

0~320x0~240

4/4

Width 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 profilen denotes the value of "capability_nvideoin" and m denotes the value of"capability_nvideoinprofile" (capability_nvideoinprofile> 0)

204 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
enable<boolean>

4/4Enable/disable this profile setting

policynight,

4/4

The mode which the profile is appliedschedule

to.

<product dependent>* 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".

begintime

hh:mm

4/4

Begin time of schedule mode.

endtime

hh:mm

4/4

End time of schedule mode.

minexposure<product
dependent><1~32000>,<5~32000>,<1~8000>,

4/4

Minimum 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.
* Only available when"capability_image_c<0~(n-1)>_exposu
re_minrange" != "-"<5~8000>,
etc.
* Available value is listedin"capability_image_c<0~(n1)>_exposure_minrange"* Only valid when"piris_mode"=manual or"irismode"=fixed* Only available when"capability_image_c<0~(n-1)>_exposu
re_rangetype" is "twovalues".

maxexposure<product
dependent><1~32000>,<5~32000>,<1~8000>,<5~8000>,
etc.
* Available value is listedin

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 toUser's Manual - 205

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)"capability_image_c<0~(n1)>_exposure_maxrange"

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 5frame/s.
* Only available when"capability_image_c<0~(n-1)>_exposu
re_maxrange" != "-"* Only valid when"piris_mode"=manual or"irismode"=fixed* Only available when"capability_image_c<0~(n-1)>_exposu
re_rangetype" is "twovalues".

shuttervalue<1~32000>,

4/4

Exposure time

<product
dependent><5~32000>,<1~8000>,<5~8000>,

1~32000 => 1s ~ 1/32000s
5~32000 => 1/5s ~ 1/32000s
1~8000 => 1s ~ 1/8000s

etc.

5~8000 => 1/5s ~ 1/8000s* Available value is listedin"capability_image_c<0~(n1)>_exposure_maxrange"etc.
* This parameter may also restrict
image frame rate from sensor due tosensor 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 5frame/s.
* Only available when"capability_image_c<0~(n-1)>_exposu
re_maxrange" != "-" and"capability_image_c<0~(n-1)>_exposu
re_rangetype" is "onevalue".
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.

enableblc

206 - User's Manual<boolean>

4/4Enable backlight compensation.

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)<Not support
anymore>* Not support this parameter
anymore when the version number(httpversion) is equal or greater than
0301a.
* It's recommanded to use"exposurewin_c<n>_mode" to switch
on/off BLC.

exposurelevel

0~12

4/4

Exposure level"0,12": This range takes the conceptfrom 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_c0_exposure_mod
e" != 0

exposuremode<product
dependent>

auto,
shutterpriority,
irispriority,
qualitypriority,
manual,etc(Available options are listin

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 withvariable Iris, and keep adjusting Gain

User's Manual - 207

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)"capability_image_c<0~(n1)>_exposure_modetype")

and Shutter speed automatically.
"qualitypriority": Automaticallyadjust the Iris, Gain and Shutter Speedby VIVOTEK quality algorithm.
"manual": Manually adjust withvariable Shutter, Iris and Gain.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.
*Only available when"capability_image_c0_exposure_mod
e" != 0whitebalance<product
dependent>

auto,
panorama,
manual,Modes of white balance.
"auto": Auto white balance"panorama": indicates that camera

rbgain,widerange,
outdoor,would try to balance the whitebalance effect of every sensor.
"rbgain": Use rgain and bgain to set

indoor,white balance manually.
"manual": 2 cases:
a. if "rbgain" is not supported, thissodiumauto,
etc(Available values are listedin"capability_image_c<0~(n1)>_wbmode")

208 - User's Manual

4/4

means keep current white balance
status.
b. if "rbgain" is supported, "rgain"and "bgain" are updated to thecurrent values which is got fromwhite balance module. Then, act asrbgain mode
"widerange": Auto Tracing Whitebalance (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

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)"capability_image_c<0~(n-1)>_wbmo
de" !="-"
rgain

0~100

4/4

Manual set rgain value of gain control
setting.
0: Weak <-> 100: Strong* Only available when "rbgain" islisted in"capability_image_c<0~(n-1)>_wbmode".
* Only valid when"videoin_c<0~(n-1)>_whitebalance" !
= auto* Normalized range.

bgain

0~100

4/4

Manual set bgain value of gain control
setting.
0: Weak <-> 100: Strong* Only available when "rbgain" islisted in"capability_image_c<0~(n-1)>_wbmode".
* Only valid when"videoin_c<0~(n-1)>_whitebalance" !
= auto* Normalized range.

maxgain

0~100

4/4

Maximum 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)>_exposu
re_rangetype" is "twovalues".

User's Manual - 209

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)mingain

0~100

4/4

Minimum 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)>_exposu
re_rangetype" is "twovalues".

gainvalue

0~100

4/4

Gain value.
0: Low <-> 100: High* Only available when"capability_image_c<0~(n-1)>_agc_maxgain" != "-" and"capability_image_c<0~(n-1)>_exposu
re_rangetype" is "onevalue".
* Normalized range.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.

meteringmode

auto,
blc,
hlc

4/4

"auto": The algorithm chooses thebest metering strategy.
"blc": This metering method increases
the weight of dark area.
"hlc": The metering method can
detect strong light and make affectedarea clear.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0311a.

1/4

Control P-Iris mode.

* Available value is listedin"capability_image_c<0~(n1)>_exposure_meteringmode"piris_mode<product
dependent>

210 - User's Manual

manual, indoor, outdoor,-"outdoor": Auto-setting P-Iris to getbest quality, but easy to meet rollingVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)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"=pirispiris_position<product
dependent>

1~100

1/4

Manual 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"=pirisirismode

fixed, indoor, outdoor<product dependent>

4/4

Control DC-Iris mode.
"outdoor": Auto-setting DC-Iris to getbest quality, but easy to meet rollingor 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_mode<product0, 1, 2

4/4

0: Disable WDR Pro.
1: Enable WDR Pro.

dependent>* Only valid when"capability_image_c<0~(n-1)>_wdrpro

User's Manual - 211

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)_mode" = 1
2: Enable WDR Pro II.
* Only valid when"capability_image_c<0~(n-1)>_wdrpro_mode" = 2
wdrpro_streng
th

1~100

4/4

The strength of WDR Pro.
The bigger value means the stronger<product

strength of WDR Pro.

dependent>* Only available when"capability_image_c<0~(n-1)>_wdrpro_strength" is 1

wdrc_mode<product
dependent><boolean>

4/4Enable WDR enhanced.
* Only available when"capability_image_c<0~(n-1)>_wdrc_
mode" is 1

wdrc_strength<product

1~100

4/4

dependent>

The 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_mode<product
dependent><boolean>

4/4Turning AE converge speed on or off.
0: off
1: on* Only available when"capability_image_c<0~(n-1)>_aespeed" is 1

aespeed_spee
dlevel<product
dependent>

1~100

4/4

The speed level of AE converge speed.
1~20: level 1
21~40: level 241~60: level 361~80: level 481~100: level 5
Level 1~4(low ~ high)
The higher speed level meas shorterAE converged time during AE

212 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
executing.
* Only available when"capability_image_c<0~(n-1)>_aespeed" is 1
aespeed_sensi
tivity1~100

4/4

The sensitivity of AE converge speed.
1~20: level 1<product21~40: level 2

dependent>

41~60: level 361~80: level 481~100: level 5
Level 1~4(low ~ high)
The higher sensitivity level meas that
it 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)>_aespee
dsupportsensitivity" is 1.

flickerless<boolean>

4/4<product
dependent>

Turn on(1) or turn off(0) the flickerlessmode* Only available when"capability_image_c<0~(n-1)>_flickerl
ess" 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"
NAME

VALUE

SECURITY(
get/set)DESCRIPTION

ipaddress<ip address>

4/4

Multicast video IP address.

port1025 ~ 65535

4/4

Multicast video port.

ipversion

IPv4, IPv6

4/4

The version of internet protocol.

User's Manual - 213

VIVOTEK

ttl© 2020 VIVOTEK INC. All Right Reserved

1 ~ 255

4/4

Multicast video time to live value.

7.9 Time Shift Settings
Group: timeshift for n channel products and m streamn denotes the value of "capability_nvideoin", m denotes the value of "capability_nmediastream"(capability_timeshift > 0)
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

enable<boolean>

4/4Enable time shift streaming.

<Not* We replace this parameter with "recommended
to use>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.

c<0~(n-1)>_en
able<boolean>

4/4Enable time shift streaming.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0312a.

c<0~(n-1)>_s<
0~(m-1)>_allow<boolean>

4/4Enable time shift streaming forspecific stream.

7.10 IR Cut Control<Not recommended to use this>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

auto,

6/6

Set IR cut control mode

214 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)<Not
recommended today,night,* We replace this parameter with
“ircutcontrol_c0_mode” when theuse this>di,version number (httpversion) is equal

schedule…etc* Available values areor greater than 0312a.
* We do not support this parameter

listed inwhen "capability_nvideoin > 1".

"capability_daynight_c<0~(n-1)>_mode"* This parameter will not be used
after the version number (httpversion)<product dependent>

is equal or greater than 0400a.

sir<boolean>

6/6

Enable/disable Smart IR* Only

<product
dependent>

available when"capability_daynight_c<0~"capability_<Not
recommended touse this>

nvideoin"-1>_smartir" is 1
* We replace this parameter with
“ircutcontrol_c<0~(n-1)>_sir” whenthe 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 00:00~23:59

6/6

<Not
recommended touse this>daymodeendtime<Notrecommended to

Day mode begin time
* We replace this parameter with
“ircutcontrol_c<0~(n-1)>_daymodebe
gintime” 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.

00:00~23:59

6/6

Day mod end time
* We replace this parameter with
“ircutcontrol_c<0~(n-1)>_daymodeen

User's Manual - 215

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)
use this>dtime” 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<boolean>

6/6

Enable/disable built-in IR led<Not* Only available when "recommended touse this>

capability_daynight_c<0~"capability_
nvideoin"-1>_builtinir > 0".
* We replace this parameter with
"ircutcontrol_illuminators_builtin_irle
d_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.

enableextled<Not
recommended touse this><boolean>

1/6

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.

216 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
enablewled<Not<boolean>

6/6

Enable/disable built-in White led* Only available when "recommended tocapability_daynight_c<0~"capability_

use this>

nvideoin"-1>_builtinwled > 0".
* We replace this parameter with
"ircutcontrol_illuminators_builtin_whi
teled_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<boolean>

6/6

<Not
recommended touse this>

Switch to B/W in night mode if
enabled.
* Only available when"capability_daynight_c<0~(n-1)>_
blackwhitemode" is 1.
* 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<Notrecommended touse this>

low,normal,high,1~10
0

6/6

Sensitivity of day/night control.
There are two value format:"low,normal,high": ifcapability_daynight_c<0~(n-1)>_ircuts
ensitivity_type=options"1~100": ifcapability_daynight_c<0~(n-1)>_ircuts

User's Manual - 217

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)
ensitivity_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

visible,<Not
recommended touse this>ir,
irenhanced,
blueenhanced

6/6

Set spectrum method .
* Only available when"capability_daynight_c<0~(n-1)>_spec
trum_support" is 1.
* We replace this parameter with<product dependent>* Available values arelisted in"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.

"capability_daynight_c<0~(n-1)>_spectrum_mode".

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

218 - User's Manual

VALUE

SECURITY

DESCRIPTIONVIVOTEK© 2020 VIVOTEK INC. All Right Reserved(get/set)
mode

auto,
day,

6/6

Set IR cut control mode
* We support this parameter whennight,

the version number (httpversion) is
equal or greater than 0312a.

di,schedule…etc* Available values
are listed in"capability_daynig
ht_c<0~(n-1)>_mo
de"<product
dependent>
sir<product dependent><boolean>

6/6

Enable/disable Smart IR* Only available when"capability_daynight_c<0~"capability_
nvideoin"-1>_smartir" is 1
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0312a.

daymodebegintime

00:00~23:59

6/6

Day mode begin time
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0312a.

daymodeendtime

00:00~23:59

6/6

Day mod end time
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0312a.

bwmode<boolean>

6/6

Switch to B/W in night mode if
enabled.
* Only available when"capability_daynight_c<0~(n-1)>_
blackwhitemode" is 1.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0312a.

sensitivity

low,normal,high,1
~100

6/6

Sensitivity of day/night control.

User's Manual - 219

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

There are two value format:"low,normal,high": ifcapability_daynight_c<0~(n-1)>_ircuts
ensitivity_type=options"1~100": ifcapability_daynight_c<0~(n-1)>_ircuts
ensitivity_type=normalize* Only available when"capability_daynight_c<0~(n-1)>_ircutsensitivity_type" is not "-".
* We support this parameter whenthe 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"
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

builtin_irled_enabled<boolean>

6/6

Enable/disable built-in IR led* Only available when"capability_daynight_illuminators_buil
tin_support > 0" and "irled" is listed in"capability_daynight_ illuminators_builtin_type"* We support this parameter whenthe version number (httpversion) is
equal or greater than 0312a.

builtin_whiteled_enabled<boolean>

6/6

Enable/disable built-in white led* Only available when"capability_daynight_illuminators_buil
tin_support > 0" and "whiteled" islisted in "capability_daynight_
illuminators _builtin_type"

220 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved* We support this parameter whenthe version number (httpversion) is
equal or greater than 0312a.
external_do_enabled<boolean>

1/6

Enable/disable external led mounted
on do1* Only available when"capability_daynight_illuminators_ext
ernal_support > 0" and "do" is listedin"capability_daynight_illuminators_ext
ernal_interface".
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0312a.

external_do<2~(capabili
ty_ndo)>_enabled<boolean>

1/6

Enable/disable external led mounted
on do<
2~(capability_ndo)>* Only available when "capability_ndo> 1"* Only available when"capability_daynight_illuminators_ext
ernal_support > 0" and"do<2~(capability_ndo)>" are listed in"capability_daynight_illuminators_ext
ernal_interface".
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0312a.

spectrum_mode

visible,ir,
irenhanced,
blueenhanced<product
dependent>* Available values
are listed in"capability_daynig
ht_illuminators

6/6

Set spectrum method .
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0312a.
* Only available when"capability_daynight_illuminators_
spectrum _support > 0".

User's Manual - 221

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved_spectrum_mode".

7.11 Image Setting per Channel
Group: image_c<0~(n-1)> for n channel products and m profilen denotes the value of "capability_nvideoin" and m denotes the value of"capability_nvideoinprofile"
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

brightness-5~5,100

4/4-5: Darker <-> 5: Bright<Not

100: Use "recommended touse this>

image_c<n>_brightnesspercent"* Only available when bit 0 of
"capability_image_c<0~(n-1)>_basicse
tting" is 1
* We replace "brightness" with"brightnesspercent".
* This parameter will not be used
after the version number (httpversion)is equal or greater than 0400a.

contrast<Not
recommended to-5~5,100

4/4

use this>-5: Less contrast <-> 5: More contrast
100: Use "image_c<0~(n-1)>_contrastpercent"* Only available when bit 1 of"capability_image_c<0~(n-1)>_basicse
tting" is 1.
* We replace "contrast" with"contrastpercent ".
* This parameter will not be used
after the version number (httpversion)is equal or greater than 0400a.

saturation<Not
recommended touse this>-5~5,100

4/4-5: Less saturation <-> 5: Moresaturation
100: Use "image_c<n>_saturationpercent"* Only available when bit 2 of"capability_image_c<0~(n-1)>_basicse

222 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)tting" is 1.
* We replace "saturation" with"saturationpercent".
* This parameter will not be used
after the version number (httpversion)is equal or greater than 0400a.
sharpness<Not-3~3,100

4/4

recommended to-3: Softer <-> 3: Sharper
100: Use "image_c<0~(n-1)>_sharpnesspercent"* Only available when bit 3 ofuse this>"capability_image_c<0~(n-1)>_basicse
tting" is 1.
* We replace "sharpness" with"sharpnesspercent".
* This parameter will not be used
after the version number (httpversion)is equal or greater than 0400a.
brightnesspercent

0~100

4/4

Set brightness in the normalized
range.
0: Darker <-> 100: Bright* Only available when bit 0 of
"capability_image_c<0~(n-1)>_basicse
tting" is 1.

contrastpercent

0~100

4/4

Set contrast in the normalized range.
0: Less contrast <-> 100: Morecontrast* Only available when bit 1 of"capability_image_c<0~(n-1)>_basicse
tting" is 1

saturationpercent

0~100

4/4

Set saturation in the normalized
range.
0: Less saturation <-> 100: Moresaturation* Only available when bit 2 of"capability_image_c<0~(n-1)>_basicse
tting" is 1.

User's Manual - 223

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)
sharpnesspercent

0~100

4/4

Set sharpness in the normalized
range.
0: Softer <-> 100: Sharper* Only available when bit 3 of"capability_image_c<0~(n-1)>_basicse
tting" is 1

gammacurve<product

0~100

4/4

dependent>

0: Fine-turned gamma curve by
Vivotek.
1: Gamma value = 0.01
2: Gamma value = 0.02
3: 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 theclosest 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)>_gamm
acurve" is 1

lowlightmode<boolean>

4/4<product
dependent>

Enable/disable low light mode.
* Only available when"capability_image_c<0~(n-1)>_lowligh
tmode" is 1

hlm
<product
dependent><boolean>

4/4Enable/disable hightlight mask.
* Only available when"capability_image_c<0~(n-1)>_hlm" is1

dnr_mode<product
dependent><boolean>

4/4

3D noise reduction.
0:disable
1:enable* Only available when"capability_image_c<0~(n-1)>_dnr" is1

224 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
dnr_strength<product

1~100

4/4

dependent>

Strength of 3DNR
* Only available when"capability_image_c<0~(n-1)>_dnr" is1

defog_mode<product<boolean>

4/4dependent>

Enable/disable defog mode.
0:disable
1:enable* Only available when"capability_image_c<0~(n-1)>_defog_
mode" is 1

defog_strength

1~100

4/4

<product
dependent>

Strength of defog* Only available when"capability_image_c<0~(n-1)>_defog_
mode" is 1

eis_mode<boolean>

4/4<product
dependent>

Electronic image stabilizer
0:disable
1:enable* Only available when 'eis' is listed in"capability_image_c<0~(n-1)>_is_mode".

eis_strength

1~100

4/4

<product
dependent>

Strength of electronic image stabilizer* Only available when 'eis' is listed in"capability_image_c<0~(n-1)>_is_mode".

dis_mode<product
dependent><boolean>

4/4

Digital image stabilizer
0:disable
1:enable* Only available when 'dis' is listed in"capability_image_c<0~(n-1)>_is_mode".

dis_strength<product
dependent>

1~100

4/4

Strength of digital image stabilizer* Only available when 'dis' is listed in"capability_image_c<0~(n-1)>_is_mode".

User's Manual - 225

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)scene_mode<product

visibility,
noiseless,dependent>

lpcparkinglot,

4/4

Value of scene mode
* Only available when"capability_image_c<0~(n-1)>_scene
mode_support" is 1

lpcstreet,
lpchighway,
auto,
deblur,lpcfreeway<product dependent>* Available values arelisted in"capability_image_c<0~(n-1)>_scenemode_
supporttype"restoreatwb<positive integer>

4/4

Restore of adjusting white balance ofimage according to mode settings

freeze<boolean>

4/4<product
dependent>

Enable/disable Image freeze while
patrolling.
0: disable
1: enable* Only available when"capability_image_c<0~(n-1)>_freeze"
is 1

deinterlace_enable<boolean>

4/4Enable/disable deinterlace function.
0: disable
1: enable* Only available when"capability_image_c<0~(n-1)>_deinterlace_support" is 1.

deinterlace_mode

spatial,blend

4/4

Users can choose between two
different deinterlacing techniques:
Spatical mode provides the best
image quality, while Blend mode
provides better image quality (thannot using the deinterlace function atall).

226 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)* Only available when"capability_image_c<0~(n-1)>_deinterlace_support" is 1.
xoffset

0~100

4/4

Adjusting the image to proper
position horizontally.
* Only available when the bit 4 ofcapability_image_c<0~(n-1)>_basicset
ting is 1.

yoffset

0~100

4/4

Adjusting the image to proper
position vertically.
* Only available when the bit 5 ofcapability_image_c<0~(n-1)>_basicset
ting is 1.

lens_alignment

0~100

4/4

Stitch the sensors together into
focused position.
* Only available when"capability_image_c<0~(n-1)>_lens_al
ignment" is 1.

lens_ldc_mode<boolean>

4/4Enable/disable lens distortion
correction.
* Only available when"capability_image_c<0~(n-1)>_lens_ld
c_support" is 1.

palette_mode

Available value islisted in"capability_image_c<0~(n-1)>_palette_mo
de"

1/4

Set color palette option.

profile_i<0~(m-1)>_enable<boolean>

4/4Enable/disable this profile setting

profile_i<0~(m-1)>_policynight,
schedule<product dependent>

4/4

The mode which the profile is appliedto.

* Only available when"capability_image_c<0~(n-1)>_palette_support" is 1.

* Not support "policy=day" anymore
when the version number

User's Manual - 227

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)(httpversion) is equal or greater than
0301a.
* "policy=night" is only available when"capability_daynight_c<0~(n-1)>_support > 0".
profile_i<0~(m-1)>_begintime

hh:mm

4/4

Begin time of schedule mode.

profile_i<0~(m-1)>

hh:mm

4/4

End time of schedule mode.

-5~5,100

4/4-5: Darker <-> 5: Bright_endtime
profile_i<0~(m-1)>_brightness<Not

100: Use "image_c<0~(n-1)>_brightnesspercent"recommended to* Only available when bit 0 of

use this>"capability_image_c<0~(n-1)>_basicse
tting" 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 touse this>-5~5,100

4/4-5: Less contrast <-> 5: More contrast
100: Use "image_c<0~(n-1)>_contrastpercent"* Only available when bit 1 of"capability_image_c<0~(n-1)>_basicse
tting" 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)>

228 - User's Manual-5~5,100

4/4-5: Less saturation <-> 5: More

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)_saturation<Not

saturation
100: Use "recommended toimage_c<0~(n-1)>_saturationpercent"use this>* Only available when bit 2 of"capability_image_c<0~(n-1)>_basicse
tting" 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-3~3,100

4/4<Not
recommended touse this>-5: Less saturation <-> 5: Moresaturation
100: Use "image_c<0~(n-1)>_saturationpercent"* Only available when bit 2 of"capability_image_c<0~(n-1)>_basicse
tting" 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)>_brightnesspercent

0~100

4/4

Set brightness in the normalized
range.
0: Darker <-> 100: Bright* Only available when bit 0 of
"capability_image_c<0~(n-1)>_basicse
tting" is 1.

profile_i<0~(m-1)>

0~100

4/4

Set contrast in the normalized range.

_contrastpercent

0: Less contrast <-> 100: Morecontrast

User's Manual - 229

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)* Only available when bit 1 of"capability_image_c<0~(n-1)>_basicse
tting" is 1
profile_i<0~(m-1)>

0~100

4/4

_saturationpercent

Set saturation in the normalized
range.
0: Less saturation <-> 100: Moresaturation* Only available when bit 2 of"capability_image_c<0~(n-1)>_basicse
tting" is 1.

profile_i<0~(m-1)>

0~100

4/4

_sharpnesspercent

Set sharpness in the normalized
range.
0: Softer <-> 100: Sharper* Only available when bit 3 of"capability_image_c<0~(n-1)>_basicse
tting" is 1

profile_i<0~(m-1)>

0~100

4/4

_gammacurve

profile_i<0~(m-1)>_lowlightmode<product
dependent>

230 - User's Manual

0: Fine-turned gamma curve by
Vivotek.
1: Gamma value = 0.01
2: Gamma value = 0.02
3: 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 theclosest 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)>_gamm
acurve" is 1<boolean>

4/4Enable/disable low light mode.
* Only available when"capability_image_c<0~(n-1)>_lowligh
tmode" is 1

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
profile_i<0~(m-1)>_hlm<boolean>

4/4Enable/disable hightlight mask.
* Only available when

<product"capability_image_c<0~(n-1)>_hlm" isdependent>

1

profile_i<0~(m-1)>_dnr_mode<boolean>

4/4

3D noise reduction.
0:disable<product1:enabledependent>* Only available when"capability_image_c<0~(n-1)>_dnr" is1

profile_i<0~(m-1)>

1~100

4/4

Strength of 3DNR

_dnr_strength<product* Only available when"capability_image_c<0~(n-1)>_dnr" isdependent>

1

profile_i<0~(m-1)><boolean>

4/4_defog_mode<product
dependent>

Enable/disable defog mode.
0:disable
1:enable* Only available when"capability_image_c<0~(n-1)>_defog_
mode" is 1

profile_i<0~(m-1)>

1~100

4/4

_defog_strength<product
dependent>

Strength of defog* Only available when"capability_image_c<0~(n-1)>_defog_
mode" is 1

profile_i<0~(m-1)>_eis_mode<product
dependent><boolean>

4/4Electronic image stabilizer
0:disable
1:enable* Only available when 'eis' is listed in"capability_image_c<0~(n-1)>_is_mode".

profile_i<0~(m-1)>_eis_strength<product
dependent>

1~100

4/4

Strength 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_mode<boolean>

4/4

Digital image stabilizer
0:disable

User's Manual - 231

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)<product
dependent>

1:enable* Only available when 'dis' is listed in"capability_image_c<0~(n-1)>_is_mode".

profile_i<0~(m-1)>_dis_strength

1~100

4/4

Strength of digital image stabilizer* Only available when 'dis' is listed in<product"capability_image_c<0~(n-1)>_is_mod

dependent>e".

7.12 Exposure Window Setting per Channel
Group: exposurewin_c<0~(n-1)> for n channel profucts
n denotes the value of "capability_nvideoin"(Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1)
NAME

VALUE

SECURITYDESCRIPTION(get/set)mode

auto, custom,blc,hlc,center* Available values are listedin"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 thecenter of view.
"hlc": Use HLC (High Light
Compensation), and to perform themasking of bright light area.
"center": Use Center window asmetering 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".

232 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved(Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1 and when custom is listedin "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

enable<boolean>

4/4Enable or disable the window.

policy0~1

4/4

0: Indicate exclusive.
1: Indicate inclusive.
* Only available when exclusive islisted in"capability_image_c<0~(n-1)>_exposu
re_wintype".

home<0~320,0~240>

4/4

Left-top corner coordinate of thewindow.
* Only available when qvga is listed in"capability_image_c<0~(n-1)>_exposu
re_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)>_exposu
re_windomain".

homepx<0~W,0~H>

4/4

W: 0~ The current image width-1
H: 0~ The current image height-1
sizepx<0~Wx0~ H>* Only available when px is listed in"capability_image_c<0~(n-1)>_exposu
re_windomain".
4/4

W: 0~ The current image width-1
H: 0~ The current image height-1
homestd<0~9999,0~9999>

Left-top corner coordinate of thewindow.

Width and height of the window.
* Only available when px is listed in"capability_image_c<0~(n-1)>_exposu
re_windomain".

4/4

Left-top corner coordinate of thewindow.

User's Manual - 233

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)* Only available when std is listed in"capability_image_c<0~(n-1)>_exposu
re_windomain".
sizestd<0~9999x0~9999>

4/4

Width and height of the window.
* Only available when std is listed in"capability_image_c<0~(n-1)>_exposu
re_windomain".

Group: exposurewin_c<0~(n-1)>_profile_i<0~(m-1)> for n channel profuct 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

VALUE

SECURITY(get/set)

DESCRIPTION

mode

auto, custom,blc,hlc,center* Available values are listed

4/4

The mode indicates how to decide theexposure.

in"capability_image_c<0~(n-1)>_exposure_winmode""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 thecenter of view.
"hlc": Use HLC (High Light
Compensation), and to perform themasking of bright light area.
"center": Use Center window asmetering 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".

234 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved(Only available when "capability_image_c<0~(n-1)>_exposure_mode"=1 and when custom is listedin "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

enable<boolean>

4/4Enable or disable the window.

policy0~1

4/4

0: Indicate exclusive.
1: Indicate inclusive.
* Only available when exclusive islisted in"capability_image_c<0~(n-1)>_exposu
re_wintype".
* "policy=night" is only available when"capability_daynight_c<0~(n-1)>_support > 0".

home<0~320,0~240>

4/4

Left-top corner coordinate of thewindow.
* Only available when qvga is listed in"capability_image_c<0~(n-1)>_exposu
re_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)>_exposu
re_windomain".

homepx<0~W,0~H>

4/4

W: 0~ The current image width-1
H: 0~ The current image height-1
sizepx<0~Wx0~ H>

Left-top corner coordinate of thewindow.
* Only available when px is listed in"capability_image_c<0~(n-1)>_exposu
re_windomain".

4/4

Width and height of the window.

W: 0~ The current image width-1* Only available when px is listed in"capability_image_c<0~(n-1)>_exposu

H: 0~ The current image height-1

re_windomain".

User's Manual - 235

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)homestd<0~9999,0~9999>

4/4

Left-top corner coordinate of thewindow.
* Only available when std is listed in"capability_image_c<0~(n-1)>_exposu
re_windomain".

sizestd<0~9999x0~9999>

4/4

Width and height of the window.
* Only available when std is listed in"capability_image_c<0~(n-1)>_exposu
re_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

SECURITYDESCRIPTION(get/set)source<Not recommended
to use this>micin, linein<product
dependent>

4/4

micin => use built-in microphone
input.
linein => use external microphone
input.
* We replace this parameter with
“audioin_c<0~(n-1)>_input” when theversion number (httpversion) is equal
or greater than 0301a.

input

intmic, extmic<product
dependent>

4/4

intmic: Internal (built-in) microphone.
(Only available whencapability_audio_intmic = 1)
extmic: External microphone input.
(Only available whencapability_audio_extmic =1)* Note: If physical microphone switch
is showed on product, this value isupdated during booting to fit switch
status.

volume_internal

0~100

4/4

Volume when take internal
microphone as input source.

236 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
0: Minimum
100: Maximum* Only available when the channel
supports internal microphone (Therelated bit of"capability_audio_intmic" is equal to1).
volume_external

0~100

4/4

Volume when take external
microphone as input source.
0: Minimum
100: Maximum* Only available when the channel
supports external microphone (Therelated bit of"capability_audio_extmic" is equal to
1).

mute

0, 1

1/4

0: Mute off
1: Mute ongain<Not recommended

0~100

4/4

Gain of input.
(audioin_c<0~(n-1)>_source = linein)

to use this>* Reserved for compatibility, andsuggest don't use this since theversion 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

0~100

4/4

Enable microphone boost.

<Not recommended

Gain of input.

to use this>(audioin_c<0~(n-1)>_source = micin)

User's Manual - 237

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)* Reserved for compatibility, andsuggest don't use this since theversion 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_codectypes0_aac4_bitrateaac4, gamr, g711,
g726

4/4

Set audio codec type for input.
aac4: Advanced Audio Coding (AAC)(Available codec arelisted in

gamr: Adaptive Multi-Rate (AMR)
g711: G.711"capability_audioin_
codec")

g726: G.726

16000,

4/4

32000,
48000,
64000,

Set AAC4 bitrate in bps.
* Only available if AAC is supported.

96000,
128000s0_gamr_bitrate

4750,
5150,
5900,
6700,
7400,
7950,
10200,
12200

4/4

AMR encoded bitrate in bps.
* Only available if AMR is supported.

s0_g711_mode

pcmu,
pcma

4/4

Set G.711 companding algorithm.
pcmu: µ-law algorithm
pcma: A-law algorithm* Only available if G.711 is supported.

s0_g726_bitrate

16000,
24000,

4/4

Set G.726 encoded bitrate in bps.
* Only available if G.726 is supported.

238 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
32000,
40000
s0_g726_bitstreamp

little, big

4/4

ackingmode

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

0, 1

4/4

Enable vlcmode for G.726.
0: Standard mode.
1: Solve compatibility problem with
VLC player.
* Only available if G.726 is supported.

aec_enable<boolean>

4/4Enable acoustic echo cancellation.
* Only available when"capability_audio_aecmode" is"manual".
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0306b.

alarm_enable<boolean>

4/4Enable audio detection

alarm_level

1~100

4/4

Audio detection alarm levelprofile_i0_enable<boolean>

4/4Enable/disable this profile setting

profile_i0_policynight,
schedule<product
dependent>

4/4

The mode which the profile is appliedto.
* 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_begintime hh:mm

4/4

Begin time of schedule mode.

profile_i0_endtime

hh:mm

4/4

End time of schedule mode.

profile_i0_alarm_lev
el

1~100

4/4

Audio detection alarm level

User's Manual - 239

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

7.13.1. Multicast Settings for Audio Streaming
Group: audioin_c<0~(n-1)>_s0_multicast (capability_naudioin > 0 andcapability_media_streamprofiles_support = 1)n denotes the value of "capability_naudioin"
NAME

VALUE

SECURITY(DESCRIPTION

get/set)ipaddress<ip address>

4/4

Multicast audio IP address.

port1025 ~ 65535

4/4

Multicast audio port.

ipversion

IPv4, IPv6

4/4

The version of internet protocol.

ttl

1 ~ 255

4/4

Multicast 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~100

4/4

Adjusting audio volume

7.15 Play an Audio Clip
Group: audioclip_i<0~1> (capability_audio_audioclip=1)
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

namestring[40]1/4Specify the audio clip name that canbe played when an event occurs.

size

0,<positive integer>

1/4

The size of audio clip.

Group: audioclip (capability_audio_audioclip=1)
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

prerecord_seconds

1~10

1/4

Indicates the seconds that can be
waited before audio clip start to240 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)record.

7.16 Motion Detection Settings
Group: motion_c<0~(n-1)> for n channel productsn denotes the value of "capability_nvideoin"
NAME

VALUE

SECURITY DESCRIPTION(get/set)

enable<boolean>

4/4Enable motion detection.

win_sensitivity

0 ~ 100

4/4

Sensitivity of all motion detection
windows.
* The value "0" is reserved forcompatibility 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 DESCRIPTION(get/set)

enable<boolean>

4/4Enable motion detection window.

namestring[14]4/4Name of motion window.

polygonstd

0 ~ 9999,0 ~ 9999, 0~ 9999,0 ~ 9999, 0 ~9999,0 ~ 9999, 0 ~9999,0 ~ 9999

4/4

Coordinate 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 ~ 100

4/4

Percent of motion detection window.

sensitivity<Not recommended
to use this>0 ~ 100

4/4

Sensitivity of motion detection window.
* We replace "sensitivity" with
"win_sensitivity".
* This parameter will not be used after
User's Manual - 241

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY DESCRIPTION(get/set)
the version number (httpversion) is
equal or greater than 0400a.

polygonpx<Not recommended

0 ~ W,0 ~ H, 0 ~ W,0~ H, 0 ~ W,0 ~ H, 0 ~4/4

Coordinate of polygon window
position.

to use this>W,0 ~ H

(4 points: x0,y0,x1,y1,x2,y2,x3,y3)

W: 0~ The current
image width -1* Only available when"capability_motion_wintype" =H: 0~ The current

polygon.

image height -1* 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

0 ~ 320,0 ~ 240, 0 ~320,0 ~ 240, 0 ~to use this>

320,0 ~ 240, 0 ~320,0 ~ 240

4/4

Coordinate 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>242 - User's Manual

0 ~ 320

4/4

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

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY DESCRIPTION(get/set)top

0 ~ 240

4/4<Not recommended
to use this>Top 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

0 ~ 320

4/4<Not recommended
to use this>Width 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 ~ 240

4/4

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

VALUE

SECURITY DESCRIPTION(get/set)

User's Manual - 243

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY DESCRIPTION(get/set)

enable<boolean>

4/4Enable profile 1 ~ (m-1).

policynight,

4/4

The mode which the profile is applied to.

schedule* 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".
begintime

hh:mm

4/4

Begin time of schedule mode.

endtime

hh:mm

4/4

End time of schedule mode.

win_sensitivity

0 ~ 100

4/4

Sensitivity of all motion detection
windows.
* The value "0" is reserved forcompatibility 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".
NAME

VALUE

SECURITY DESCRIPTION(get/set)

enable<boolean>

4/4Enable motion detection window.

namestring[14]4/4Name of motion window.

polygonstd

0 ~ 9999,0 ~ 9999,
0 ~ 9999,0 ~ 9999,
0 ~ 9999,0 ~ 9999,
0 ~ 9999,0 ~ 9999

4/4

Coordinate 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 ~ 100

4/4

Percent of motion detection window.

sensitivity<Not recommended

0 ~ 100

4/4

Sensitivity of motion detection window.
* We replace "sensitivity" with

244 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY DESCRIPTION(get/set)

to use this>"win_sensitivity".
* This parameter will not be used after
the version number (httpversion) is equal
or greater than 0400a.

polygonpx

0 ~ W,0 ~ H, 0 ~4/4

Coordinate of polygon window position.

<Not recommended
to use this>W,0 ~ H, 0 ~ W,0 ~H, 0 ~ W,0 ~ H(4 points: x0,y0,x1,y1,x2,y2,x3,y3)* Only available when

W: 0~ The current"capability_motion_wintype" = polygon.

image width -1
H: 0~ The current* Only available when px is listed in"capability_motion_windomain".

image height -1* 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

0 ~ 320,0 ~ 240, 0 ~ 4/4
320,0 ~ 240, 0 ~Coordinate of polygon window position.
(4 points: x0,y0,x1,y1,x2,y2,x3,y3)

to use this>

320,0 ~ 240, 0 ~320,0 ~ 240* 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 ~ 320

4/4

Left 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

0 ~ 240

4/4

Top coordinate of window position.
* Only available when

User's Manual - 245

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY DESCRIPTION(get/set)

to use this>"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

0 ~ 320

4/4

to use this>Width 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.

height0 ~ 240

4/4

Height of motion detection window.

<Not recommended* Only available when

to use this>"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

enable<boolean>

4/4Enable or disable tamper detection.

246 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
threshold

0~100

4/4

Threshold of tamper detection.

duration

10~600

4/4

If tampering value exceeds the"threshold" for more than "duration"
second(s), then tamper detection istriggered.

ignorewidth0,<positive

1/7

integer>dark_enable<boolean>

Indicate the width to offset to start toanalysis the image.

4/4

Enable or disable image too dark
detection

dark_threshold

0~100

4/4

Threshold of image too dark detection

dark_duration

1~10

4/4

If image too dark value exceeds the"threshold" for more than "duration"
second(s), then image too dark
detection is triggered.

bright_enable<boolean>

4/4Enable or disable image too brightdetectionbright_threshold

0~100

4/4

Threshold of image too brightdetectionbright_duration

1~10

4/4

If image too bright value exceeds the"threshold" for more than "duration"
second(s), then image too brightdetection is triggered.

blurry_enable<boolean>

4/4Enable or disable image too blurry
detection

blurry_threshold

0~100

4/4

Threshold of image too blurry
detection

blurry_duration

1~10

4/4

If image too blurry value exceeds the"threshold" for more than "duration"
second(s), then image too blurry
detection is triggered.

SECURITY(get/set)

DESCRIPTION

7.18 DDNS
Group: ddns (capability_protocol_ddns > 0)
NAME

VALUE

User's Manual - 247

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
enable<boolean>

6/6

Enable or disable the dynamic DNS.

providerDyndnsDynamic,
DyndnsCustom,

6/6

DyndnsDynamic => dyndns.org(dynamic)

Safe100<provider>_hostnam string[128]DyndnsCustom => dyndns.org
Safe100 => safe100.net
6/6

Your DDNS hostname.

6/6

Your user name or email to login toe<provider>_usernam string[64]eemail<provider>_passwor

the DDNS service provider
string[64]

7/6

dkey

Your password or key to login to the
DDNS service provider.

7.19 Express Link
Group: expresslink
PARAMETERVALUE

SECURITY(get/set)

DESCRIPTION

enable<boolean>

6/6

Enable or disable express link.

state

onlycheck,

6/6

Camera will check the status of network
environment and express link URL

6/6

The url user define to link to camera

onlyoffline,
checkonline,
badnetwork
urlstring[64]7.20 UPnP Presentation
Group: upnppresentation
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

enable<boolean>

6/6

Enable or disable the UPnP
presentation service.

7.21 UPnP Port Forwarding
Group: upnpportforwarding

248 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITY DESCRIPTION(get/set)

enable<boolean>

6/6

Enable or disable the UPnP port
forwarding service.

upnpnatstatus

0~3

6/7

The status of UPnP port forwarding,used internally.
0 = OK, 1 = FAIL, 2 = no IGD router, 3 =no need for port forwarding

7.22 System Log
Group: syslog
NAME

VALUE

SECURITY DESCRIPTION(get/set)

enableremotelog<boolean>

6/6

Enable remote log.

serverip<IP address>

6/6

Log server IP address.

serverport

514, 1025~65535 6/6Server port used for log.

level

0~7

Levels used to distinguish theimportance of the information:

6/6

0: LOG_EMERG
1: LOG_ALERT
2: LOG_CRIT
3: LOG_ERR
4: LOG_WARNING
5: LOG_NOTICE
6: LOG_INFO
7: LOG_DEBUG
setparamlevel

0~2

6/6

Show log of parameter setting.
0: disable
1: Show log of parameter setting set
from external.
2. Show log of parameter setting set
from external and internal.

7.23 SNMPGroup: snmp (capability_protocol_snmp > 0)

User's Manual - 249

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)v2<boolean>

6/6

SNMP v2 enabled. 0 for disable, 1 forenablev3<boolean>

6/6

SNMP v3 enabled. 0 for disable, 1 forenablesecnamerw

string[31]6/6Read/write security namesecnamero

string[31]6/6Read only security nameauthpwrw

string[8~128]

7/6

Read/write authentication password

authpwrostring[8~128]

7/6

Read only authentication password

authtyperw

MD5,SHA

6/6

Read/write authentication type

authtypero

MD5,SHA

6/6

Read only authentication type

encryptpwrw

string[8~128]

7/6

Read/write passwrd

encryptpwro

string[8~128]

7/6

Read only password

encrypttyperw

DES

6/6

Read/write encryption type

encrypttypero

DES

6/6

Read only encryption typerwcommunity

string[31]6/6Read/write community

rocommunity

string[31]6/6Read only community

syslocation

string[128]6/6System location

syscontact

string[128]6/6System contact

7.24 Layout Configuration
Group: layout
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

logo_default<boolean>

1/6

0 => Custom logo
1 => Default logo

logo_link

string[128]http://www.vivot
ek.com

1/6

Hyperlink of the logo

logo_powerbyvvtk_hidd
en<boolean>

1/6

0 => display the power by vivotek logo
1 => hide the power by vivotek logo

250 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)custombutton_manualtr <boolean>igger_show

1/6

Show or hide manual trigger (VI)button in homepage
0 -> Hidden
1 -> Visible

theme_option

1~4

1/6

1~3: One of the default themes.
4: Custom definition.

theme_color_font

string[7]1/6Font color

theme_color_configfont

string[7]1/6Font color of configuration area.

theme_color_titlefontstring[7]1/6Font color of video title.

theme_color_controlba
ckgroundstring[7]1/6Background color of control area.

theme_color_configbac
kgroundstring[7]1/6Background color of configuration
area.

theme_color_videoback

string[7]1/6Background color of video area.

theme_color_case

string[7]1/6

Frame color

defaultpassword_specia
lcharacter!%-.@^_~

6/7

Allowed special characters* We support this parameter whengroundthe version number (httpversion) is
equal or greater than 0314b.
defaultpassword_type<positive
integer>

6/7

Required 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 character
Bit 2 => Require digit number
Bit 3 => Require lowercase letter
Bit 4 => Require uppercase letter
Bit 5 => Allow checking username andpassword; if "bit=1" means
username=password is allowed,
otherwise is not allowed.
* We support this parameter whenthe version number (httpversion) is

User's Manual - 251

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)equal or greater than 0314b.
defaultpassword_length

8 ~ 64

6/7

Allowed password length.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0314b.

252 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

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_videoin_c<0~(n-1)>_nprivacymask"
NAME

VALUE

SECURITYDESCRIPTION(get/set)
enable<boolean>

4/4Enable privacy mask.

win_i<0~(m-1)>_enable<boolean>

4/4Enable privacy mask window.

win_i<0~(m-1)>_namestring[14]4/4Name of the privacy mask window.

win_i<0~(m-1)>_left

0 ~ 320

4/4

Left coordinate of window position.
* Only available when"capability_image_c<0~(n-1)>_privacy
mask_wintype" = rectangle.

win_i<0~(m-1)>_top

0 ~ 240

4/4

Top coordinate of window position.
* Only available when"capability_image_c<0~(n-1)>_privacy
mask_wintype" = rectangle.

win_i<0~(m-1)>_width

0 ~ 320

4/4

Width of privacy mask window.
* Only available when"capability_image_c<0~(n-1)>_privacy
mask_wintype" = rectangle.

win_i<0~(m-1)>_height0 ~ 240

4/4

Height of privacy mask window.
* Only available when"capability_image_c<0~(n-1)>_privacy
mask_wintype" = rectangle.

win_i<0~(m-1)>_polygon

0 ~ 320,0 ~ 240,
0 ~ 320,0 ~ 240,
0 ~ 320,0 ~ 240,
0 ~ 320,0 ~ 240

4/4

Coordinate of polygon window
position.
(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)>_privacy
mask_windomain".

win_i<0~(m-1)>_polygo
npx

0 ~ W,0 ~ H,
0 ~ W,0 ~ H,

4/4

Coordinate of polygon window
position.

User's Manual - 253

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
0 ~ W,0 ~ H,
0 ~ W,0 ~ H(4 points: x0,y0,x1,y1,x2,y2,x3,y3)* Only available when

W: 0~ The

"capability_image_c<0~(n-1)>_privacy

current image
width -1

mask_wintype" = polygon.
* Only available when px is listed in

H: 0~ The current"capability_image_c<0~(n-1)>_privacy

image height -1

mask_windomain".

win_i<0~(m-1)>_polygo

0 ~ 9999,0 ~4/4

Coordinate of polygon window

nstd

9999, 0 ~ 9999,0

position.

~ 9999, 0 ~9999,0 ~ 9999, 0(4 points: x0,y0,x1,y1,x2,y2,x3,y3)* Only available when~ 9999,0 ~ 9999

"capability_image_c<0~(n-1)>_privacy
mask_wintype" = polygon.
* Only available when std is listed in"capability_image_c<0~(n-1)>_privacy
mask_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_videoin_c<0~(n-1)>_nprivacymask"
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

enable<boolean>

4/4Enable the 3D privacy mask

color

0~"
4/4
capability_image_c<0~(n1)>_privacymask_ncolor"-1

Privacy mask color

win_i<0~(m-1)>_namestring[40]Name of the privacy mask
window.

win_i<0~(m-1)>_pan"capability_ptz_c<0~(n-1) 4/4>_minpan" ~"capability_ptz_c<0~(n-1)>_maxpan"

254 - User's Manual

4/4

Pan position of window
position.
* Only available when bit0 of"capability_camctrl_c<0~(n-1)>_

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)buildinpt" is "1"
win_i<0~(m-1)>_tilt

win_i<0~(m-1)>_zoom"capability_ptz_c<0~(n-1) 4/4>_mintilt" ~Tilt position of window position.
* Only available when bit1 of"capability_ptz_c<0~(n-1)"capability_camctrl_c<0~(n-1)>_>_maxtilt"

buildinpt" is "1""capability_ptz_c<0~(n-1) 4/4>_minzoom" ~Zoom position of window
position.

"capability_ptz_c<0~(n-1)>_maxzoom"
win_i<0~(m-1)>_fliped<boolean>

4/4

Flip side of window position.
0: Non-flip side
1: Flip side

7.27 CapabilityGroup: capability
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

api_httpversion<string>

0/7

The version of VIVOTEK WebAPI withThis number startwith 0301a.

4 integers plus 1 alphabet, There arecomposed by "major version", "minor
version", "revision","_platform". ex:
0301a_1
Major version
Increase the major version whenchange, remove the oldfeatures/interfaces or the firmware
has substantially change inarchitecture and not able to roll backto previous version. This may cause
incompatibility with supporting
software.
Minor version
Increase the minor version when add
new features/interfaces withoutchange the old features andUser's Manual - 255

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)interfaces.
Revision
Increase the revision when fix bugs
without change any features of theoutput.
_platform
This is a constant, it is used to
distinguish between different
platforms
API version format:
MMmmr_k
Where "MM" is the major version,"mm" is the minor version and "r" isthe revision.
'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 = 1
The 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 notfollow the API definition of 0301a_1,
we will fix them and change this API
value to 0301b_1.
bootuptime<positive integer>

0/7Server bootup time.

nir<Not support
anymore>0,<positive integer>

0/7

Number of IR interfaces.
(Recommand to use
capability_daynight_c<0~"capability_
nvideoin"-1>_builtinir for built-in IRandcapability_daynight_c<0~"capability_

256 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
nvideoin"-1>_externalir for externalIR)* Not support this parameter
anymore when the version number(httpversion) is equal or greater than
0301a.
npir

0,<positive integer>

0/7

Number of PIRs.

ndi

0,

0/7

Number of digital inputs.

<positive integer>nvi

0,<positive integer>

0/7

Number of virtual inputs (manualtrigger)

ndo

0,

0/7

Number of digital outputs.

<positive integer>
naudioin0,<positive integer>

0/7

The number of audio input channel. 0means no audio input support.

naudioout0,<positive integer>

0/7

The number of audio output channel

nvideoin<positive integer>

0/7

Number of video inputs.

nvideoout

0, <Positive Integer>

0/7

Number of video out interface.

nvideoinprofile<positive integer>

0/7

Number of video input profiles.

nmediastream<positive integer>

0/7

Number of media stream perchannels.

naudiosetting<Not support
anymore><positive integer>

0/7

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

nuart

0,
<positive integer>

0/7

Number of UART interfaces.

User's Manual - 257

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)
nmotion<positive integer>

0/7

The number of motion window.

nmotionprofile0, <positive integer>

0/7

Number of motion profiles.

nevent0, <positive integer>

0/7

Number of event.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0311c.

nrecording

0, <positive integer>

0/7

Number of recording.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0309a.

ptzenabled

0, <positive integer>

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

258 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
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)
windowless<boolean>

0/7

Indicate whether to support
windowless plug-in.

evctrlchannel<boolean>

0/7

Indicate whether to support HTTP
tunnel for event/control transfer.

joystick<boolean>

0/7

Indicate whether to support joystick
control.

remotefocus

0,<positive integer>

0/7

An 4-bit integer, which indicates the<Notrecommended touse this>

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 touse 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, <positive integer>

0/7

Number of preset locations

User's Manual - 259

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)presettourdirection <boolean>

0/7

Indicate whether to support presettour direction function. It means users
can choose which direction the presettour goes.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0307a.

eptz

0, <positive integer>

0/7

For "nvideoin" = 1, the definition is asfollowing:
A 32-bits integer, each bit can be set
separately as follows:
Bit 0 => 1st stream supports ePTZ ornot.
Bit 1 => 2nd stream supports ePTZ ornot, and so on.
For nvideoin >= 2, the definition isdifferent:
First all 32 bits are divided into groups
for channel.
Ex:nvideoin = 2, bit 0~15 are the 1stgroup for 1st channel, bit 16~31 are
the 2nd group for 2nd channel.
nvideoin = 3, bit 0~9 are the 1st groupfor 1st channel, bit 10~19 are the 2ndgroup for 2nd channel, bit 20~31 are
the 3rd group for 3rd channel.
Then, the 1st bit of the groupindicates 1st stream of a channel
support ePTZ or not. The 2nd bit of
the group indicates 2nd stream of achannel support ePTZ or not, and soon.
* For most products, the last streamof a channel will not support ePTZ. It
is reserved for full view of the

260 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)channel. For some dual-stream
products, both streams support ePTZ.
nanystream

0, <positive integer>

0/7

number of any media stream perchanneliva<boolean>

0/7

Indicate whether to support
Intelligent Video analysis

whitelight<Not<boolean>

0/7

Indicate whether to support whitelight led.

recommended to* We replace this parameter with

use this>"capability_daynight_c<0~(n-1)>_built
inwled" when the version number(httpversion) is equal or greater than
0309d.

iris<boolean>

0/7

Indicate whether to support iris
control.

supportsd<boolean>

0/7

Indicate whether to support local
storage.

fisheye<boolean>

0/7

The parameter is used to determine
whether the product is fisheye or not.

tampering<boolean>

0/7

Indicate whether to support
tampering detection.

tamperingmodetamper,toodark,toobri
ght,tooblurry

0/7

Available tampering mode list.
* Only available when"capability_tampering" is 1.

adaptiverecording<boolean>

0/7

Indicate whether to support adaptive
recording.

adaptivestreaming<boolean>

0/7

Indicate whether to support adaptive
streaming.

supporttriggertypes

seq,boot,motion,netw 0/7
orkfail,recnotify,tamp
ering,vi,vadp,di,volalarm,temperature,pir,visignal,
backup,smartsd,

list all the trigger types which aresupported in the camera:"seq" = Periodic condition"boot" = System boot"motion" = Video motion detection"networkfail" = network connection

shockalarm,virestore<product dependent>

failure"recnotify" = Recording notification.

User's Manual - 261

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)"tampering" = Tamper detection.
"vi" = Virtual input (Manual trigger)"vadp" = VADP trigger.
"di"= Digital input.
"volalarm" = Audio detection.
"temperature" = Temperaturedetection.
"pir" = PIR detection.
"visignal" = Video input signal loss.
"backup" = Backing up recorded files.
"smartsd" = Lifetime detection of SD
card.
"shockalarm" = Shock detection.
"virestore" = Video input signal
restore.
* Only available when [httpversion] >=0301a
media_num

0,<positive integer>

0/7

Number of media number.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0311c.

storage_dbenabled<boolean>

0/7Media files are indexed in database.

protocol_https< boolean >0/7

Indicate whether to support HTTP
over SSL.

protocol_rtsp< boolean >0/7

Indicate whether to support RTSP.

protocol_sip<boolean>

0/7

Indicate whether to support SIP.

protocol_maxconn
ection<positive integer>

0/7

The maximum number of allowed
simultaneous connections.

protocol_maxgenc
onnection<Not
Recommended touse this><positive integer>

0/7

The maximum general streaming
connections .
* We replaced this parameter with“capability_protocol_maxconnection”
when the version number(httpversion) is equal or greater than
0311c.

262 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
protocol_rtp_multi
cast_scalable<boolean>

0/7

Indicate whether to support scalable
multicast.

protocol_rtp_multi<boolean>

0/7

Indicate whether to support

cast_backchannel
protocol_rtp_tcp

backchannel multicast.
<boolean>

0/7

Indicate whether to support RTP over
TCP.

protocol_rtp_http<boolean>

0/7

Indicate whether to support RTP over
HTTP.

protocol_spush_mj
peg<boolean>

0/7

Indicate whether to support server
push MJPEG.

protocol_snmp<boolean>

0/7

Indicate whether to support SNMP.

protocol_ipv6<boolean>

0/7

Indicate whether to support IPv6.

protocol_pppoe<boolean>

0/7

Indicate whether to support PPPoE.

protocol_ieee8021x<boolean>

0/7

Indicate whether to support
IEEE802.1x.

protocol_qos_cos<boolean>

0/7

Indicate whether to support CoS.

protocol_qos_dscp<boolean>

0/7

Indicate whether to support
QoS/DSCP.

protocol_ddns<boolean>

0/7

Indicate whether to support DDNS.

protocol_ftp_serve<positive integer>

0/7

An 32-bit integer, each bit can be setrseparately as follows:
Bit 0 => ftp;
Bit 1=> sftp;* We support this parameter whenthe version number (httpversion) is
equal or greater than 0314a.

protocol_ftp_client<positive integer>

0/7

An 32-bit integer, each bit can be set
separately as follows:
Bit 0 => ftp;
Bit 1=> sftp;* We support this parameter whenthe version number (httpversion) is
equal or greater than 0314a.

videoin_type

0, 1, 2

0/7

0 => Interlaced CCD

User's Manual - 263

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
1 => Progressive CCD
2 => CMOS
videoin_nresolutio<positive integer>

0/7nThis equals"capability_videoin_c0_nresolution".
* This is kept for compatibility.

videoin_resolution

A list of <WxH>

0/7<product dependent>

This equals"capability_videoin_c0_resolution".
* This is kept for compatibility.

videoin_maxframer A list of <Integer>

0/7

ate

This equals"capability_videoin_c0_maxframerate".
* This is kept for compatibility.

videoin_mjpeg_ma
xframerate

A list of <Integer> and
"-"

0/7

This equals"capability_videoin_c0_mjpeg_maxfra
merate".
* This is kept for compatibility.

videoin_h264_max
framerate

A list of <Integer> and
"-"

0/7

This equals"capability_videoin_c0_h264_maxfra
merate".
* This is kept for compatibility.

videoin_codec

mjpeg, h264, h265
<product dependent>

0/7

Available codec of a device, split bycomma.
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_streamcodec

A list of <Positive
Integer>

0/7This equals"capability_videoin_c0_streamcodec".
* This is kept for compatibility.

0/7

Indicate whether to support
flexible bit rate control.

videoin_flexiblebitr <boolean>
ate
videoout_codec

264 - User's Manual

A list of the available
0/7
codec types separated

Available codec list.
"-": not supported

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)by commas<product dependent>
timeshift<boolean>

0/7

Indicate whether to support time shiftcaching stream.

audio_aec<boolean>

0/7

Indicate whether to support acoustic
echo cancellation.

audio_aecmode

auto,
manual

0/7

Indicate the acoustic echo
cancellation control mode.
"auto": control by camera
automatically.
"manual": Manually turn on/off thecontrol mode.
*Only available when"capability_audio_aec" is "1".
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0306b.

audio_aecaffect-,maxframerate:fixed:1
5<product dependent>

0/7

When acoustic echo cancellation
function is enabled, some features
may become malfunction or be forced
to a given value. The affectedfunctions 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 asbefore and user can't change it.
- (hidden) : UI is hidden.
- (fixed) : UI is fixed to one selection orvalue.
- (ranged) : UI is fixed to multiple
selections or values.
- (enabled) : UI is checked.

User's Manual - 265

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)- (notsupport) : the affected function
is not available.
"Affect API name" can be described inhierarchy, 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" whichmeans 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 whenthe version number (httpversion) is
equal or greater than 0306b.
audio_mic<Not support
anymore><boolean>

0/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/7Internal (Built-in) Microphone.
0: Not support
1: Support
Bit 0 for CH0, bit 1 for CH1, and so on.

audio_extmic<0~Positive Integer>

0/7

External Microphone.

266 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
0: Not support
1: Support
Bit 0 for CH0, bit 1 for CH1, and so on.
audio_alarm<0~Positive Integer>

0/7

0: Not support audio alarm.
1: Support audio alarm.
Bit 0 for CH0, bit 1 for CH1, and so on.

audio_linein<Not support<boolean>0/7

anymore>Indicate whether to support externalline 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_lineout<boolean>

0/7

Indicate whether to support line
output.

audio_michardwar
eswitch<boolean>

0/7

Indicate whether the hardware
supports built-in/external mic switch

audio_headphoneo <boolean>

0/7

Indicate whether to support

ut<Not support
anymore>headphone output.
* Not support this parameter
anymore when the version number(httpversion) is equal or greater than
0301a.

audio_audioclip<boolean>

0/7

Indicate whether to support audio clip
function.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0309a.

audioin_codec

aac4, gamr, g711,
g726, <product dependent>

0/7

Available audio codec. We takecomma to split codec without any
space.
"aac4": Advanced Audio Coding (AAC)"gamr": Adaptive Multi-Rate (AMR)"g711": G.711

User's Manual - 267

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)"g726": G.726"-": Not supported.
audioout_codec

g711, -

0/7"-": Not supported.

<product dependent>
motion_wintype

rectangle, polygon,-

Available codec list for SIP.

0/7

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

The 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_support<boolean>

0/7

Indicate whether smart stream is
supported.

smartstream_versi<integer>

0/7

Number of smart stream version.

on* Only available when"capability_smartstream_support" is 1

smartstream_nstre
am<positive integer>

0/7

Number of stream that support smart
stream.
* Only available when"capability_smartstream_support" is 1

smartstream_windomain

qvga, px, std, -0/7

The 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_mod<boolean>

0/7

Indicate whether autotracking smart

268 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
e_autotracking

stream is supported.
* Only available when"capability_smartstream_support" is 1

smartstream_mod<boolean>0/7

e_manual

Indicate whether manual smart
stream is supported.
* Only available when"capability_smartstream_support" is 1

smartstream_mod<boolean>0/7

e_hybrid

Indicate whether hybrid(autotracking+manual) smart stream is supported.
* Only available when"capability_smartstream_support" is 1

smartstream_nwin
dow_autotracking<positive integer>

0/7

Maximum number of tracking windowof autotracking.
* Only available when"capability_smartstream_support" is 1

smartstream_nwin<positive integer>

0/7

dow_manual

smartstream_nwin

Maximum number of tracking windowof manual.
* Only available when"capability_smartstream_support" is 1

<positive integer>

0/7

dow_hybrid_autotr
ackingMaximum number of tracking windowof autotracking in hybrid mode.
* Only available when"capability_smartstream_support" is 1

smartstream_nwin
dow_hybrid_manual<positive integer>

0/7

Maximum number of tracking windowof manual in hybrid mode.
* Only available when"capability_smartstream_support" is 1

vadp_supportfeature<positive integer>

0/7

An 32-bit integer, each bit can be set
separately as follows:
Bit 0 => VADP interface
Bit 1 => Capture video raw data
Bit 2 => Support encode jpeg
Bit 3 => Capture audio raw data
Bit 4 => Support event trigger
Bit 5 => Support license registration
Bit 6 => Support shared memory API

User's Manual - 269

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)Bit 7 => Support digital signature of
package
Bit 8 => Support snapshot
Bit 9 => Support upload encrypted
package
vadp_npackage<positive integer>

0/7

Indicate the maximum number of
VADP package that can be uploaded
to the device.

camctrl_httptunnel <boolean><Not support

0/7

anymore>Indicate whether to support
httptunnel.
* Not support this parameter
anymore when the version number(httpversion) is equal or greater than
0301b.
* It will be replaced bycapability_camctrl_ptztunnel.

camctrl_ptztunnel<boolean>

0/7

Indicate whether to support
ptztunnel.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0301b.
This equals"capability_camctrl_c0_ptztunnel".
* This is kept for compatibility.

camctrl_privilege<boolean>

0/7

Indicate whether to support “Manage
Privilege” of PTZ control in the
security page.
1: support both/cgi-bin/camctrl/camctrl.cgi and/cgi-bin/viewer/camctrl.cgi
0: support only
/cgi-bin/viewer/camctrl.cgi
This is equivalentto"capability_camctrl_c0_privilege".
* This is kept for compatibility.

uart_httptunnel

270 - User's Manual<boolean>

0/7

Indicate whether to support HTTP

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)tunnel for UART transfer.
transmission_mod
e

Tx,
Rx,

0/7

Both

Indicate transmission mode of themachine: TX = server, Rx = receiverbox, Both = DVR.

network_wire<boolean>

0/7

Indicate whether to support Ethernet.

network_wireless<boolean>

0/7

Indicate whether to support wireless.

network_dualmod<boolean>

0/7

Indicate whether network dual modeeis supported.
* Only available when"capability_network_wireless" is "1".
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0305a.

wireless_s802dot1<boolean>0/7

1bwireless_s802dot1

Indicate whether to support wireless802.11b+.

<boolean>

0/7

1g

Indicate whether to support wireless802.11g.

wireless_s802dot1
1n<boolean>

0/7

Indicate whether to support wireless802.11n.

wireless_begincha

1 ~ 14

0/7

Indicate the begin channel of wirelessnnel

network

wireless_endchannel

1 ~ 14

0/7

Indicate the end channel of wirelessnetwork

wireless_encrypt_
wep<boolean>

0/7

Indicate whether to support wirelessWEP.

wireless_encrypt_
wpa<boolean>

0/7

Indicate whether to support wirelessWPA.

wireless_encrypt_
wpa2<boolean>

0/7

Indicate whether to support wirelessWPA2.

wireless_apmode_
enable<boolean>

0/7

Indicate whether wireless AP mode issupported.
* Only available when"capability_network_wireless" is "1".
* We support this parameter whenthe version number (httpversion) is

User's Manual - 271

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)equal or greater than 0305a.
wireless_apmode_
ssidprefix<string>

0/7

Indicate 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 whenthe version number (httpversion) is
equal or greater than 0305a.

derivative_brand<boolean>

0/7

Indicate whether to support the
upgrade function for the derivative
brand. For example, if the value istrue, the VVTK product can be
upgraded to VVXX. (TCVV<->TCXX is
excepted)

test_ac<boolean>

0/7

Indicate whether to support test ac
key.

version_onvifdaem<string>

0/7

Indicate ONVIF daemon version<string>

0/7

Indicate ONVIF test tool version

version_genetec<string>

0/7

Indicate Genetec daemon version* We support this parameter whenthe version number (httpversion) is
equal or greater than 0312a.

media_totalspace<positive integer>

0/7

Available memory space (KB) for
media.

media_snapshot_
maxpreevent<positive integer>

0/7

Maximum snapshot number before
event occurred.

media_snapshot_
maxpostevent<positive integer>

0/7

Maximum snapshot number after
event occurred.

media_snapshot_
maxsize<positive integer>

0/7

Maximum size (KB) of a snapshot.

media_videoclip_
maxsize<positive integer>

0/7

Maximum size (KB) of a videoclip.

on
version_onviftesttool

272 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)media_videoclip_
maxlength<positive integer>

0/7

Maximum length (second) of avideoclip.

media_videoclip_<positive integer>

0/7

Maximum duration (second) after

maxpreevent

event occurred in a videoclip.

media_streamprofi
les_support<boolean>

0/7

Indicates support of stream profile
feature.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0313a.

media_streamprofi<positive integer>

0/7

Maximum number of stream profiles.

les_num

image_iristype<Not
recommended to* We support this parameter whenthe version number (httpversion) is
equal or greater than 0313a.
<string>

0/7

use this>

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, andsuggest don't use this since[httpversion] > 0301a

image_focusassist<Not
recommended touse this><boolean>

0/7

Indicate whether to support focus
assist.
* We replace "capability_image_focusassist "with"capability_image_c0_ focusassist".
* Reserved for compatibility, andsuggest don't use this since[httpversion] > 0301a

User's Manual - 273

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
localstorage_manageable<boolean>

0/7

Indicate whether manageable local
storage is supported.
* Only available when"capability_supportsd" is 1 or"capability_storage_dbenabled" is 1.

localstorage_seaml
ess0,<positive integer>

0/7

Indicate 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_modn
um
<Not

0,
<positive integer>

0/7

recommended touse this>

The maximum 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_modv
ersion<string>

0/7

Indicate MOD daemon version.
* Only available when"capability_supportsd" is 1 or"capability_storage_dbenabled" is 1.

localstorage_storm
grversion<string>

0/7

Indicate storage manager daemon
version.
* Only available when"capability_supportsd" is 1 or"capability_storage_dbenabled" is 1.

0/7

An 32-bit integer, which indicates the
supportive application of edge

localstorage_suppo 0,
rtedge<positive integer>

storage.
If the value of this parameter is larger

274 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
than 0, it means that the camera
supports edge recording function.
bit 0 : It supports to record directly toan 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_slcon

0,<positive integer>

0/7

num

The maximum seamless connection
number for each channel.
* Only available when"capability_supportsd" is 1 or"capability_storage_dbenabled" is 1.

localstorage_smart
sd<boolean>

0/7

The "Lifetime and Log SD Card"feature allows users to obtain the
card's remaining lifetime information.
0: Non-support this feature
1: Support this feature* Only Sony, Micron SD card cansupport this function now.
* Only available when"capability_supportsd" is 1 or"capability_storage_dbenabled" is 1.

remotecamctrl_ma
ster0, <positive integer>

0/7

Indicate whether to support remote
auxiliary camera (master side), thisvalue means supporting max numberof auxiliary camera.

remotecamctrl_slave<boolean>

0/7

Indicate whether to support remotecamera control (slave side).

fisheyelocaldewarp_c<0~(capability_nvideoin)-1><product0, <positive integer>

0/7

Indicate the supported streams of
local dewarp. One bit represents
one supported stream. The LSB
indicates stream 0.

dependent>

Ex: “3” means stream 0 and stream 1
support local dewarp.

User's Manual - 275

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)* Only available when"capability_fisheye" > 0
shockalarm_suppo<boolean>

0/7

rtIndicate whether to support the shock
detection.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0306e.

layout_redirection<string>

0/7

Indicate which function will be
redirected to the vadp package path.
"-": Not supported.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0309a.

securecam_suppor<Boolean>

0/7tIndicate support for security camera.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0314a.

securecam_version<string>

0/7

Indicate the security camera featurephases.
* Only available whencapability_securecam_support=1.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0314a.

taics_support<boolean>

0/7

Support the feature for Video
Surveillance System Security fromTAICS.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0314b.

taics_level0, <positive integer>

0/7

Indicate the support level for Video
Surveillance System Security fromTAICS.
* Only available when"capability_taics_support" is 1.
* We support this parameter when276 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
the version number (httpversion) is
equal or greater than 0314b.

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

SECURITY(get/set)

DESCRIPTION

ptztunnel<boolean>

0/7

Indicate whether to support ptztunnel
in this video input.

privilege<boolean>

0/7

Indicate 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.cgi
0: support only
/cgi-bin/viewer/camctrl.cgi

rs485<boolean>0/7

An 32-bit integer, each bit can be set
separately as follows:
Bit 0 => support rs485-in
Bit 1 => support rs485-out

buildinpt<boolean>0/7

An 32-bit integer, each bit can be set
separately as follows:
Bit 0 => support build-in pan
Bit 1 => support build-in tilt

User's Manual - 277

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)zoommodule<boolean>

0/7

Indicate whether to support zoom lens.
In our product, only SD series and IZ
series use the zoom lens.
* Both varifocal and zoom lenses arebuilt 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 thathas been focused on an object at any
focal length. A varifocal will need to be
refocused whenever the focal length isadjusted; the zoom will stay in focus
when the focal length is adjusted.

focusmode

auto,onetimeauto,sp 0/7

Focus mode selection:

otlight,manual<product
dependent>"auto": Camera will automaticallyadjust the focus position full time toadapt a clear picture.
"onetimeauto": Camera willautomatically adjust the focus position
one time, which follows any PTZ
control.
"spotlight": Camera will automaticallyadjust the focus position full time, andto consider a spotlight avoidance
situation.
"manual": Turn off the automaticallyfocus function. For user to control the
focus position manually as their
purpose.
* Only available when"capability_camctrl_c<0~(n-1)_zoommo
dule" is 1.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0304a.

278 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

7.27.2 Capability for PTZGroup: 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.
PARAMETERVALUE

SECURITY(get/set)

panspeedlv

0, <positive integer> 0/7

DESCRIPTION
The maximum speed level of pan
motion.
*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildin
pt" is "1"

minpan0, <positive integer> 0/7

The lower limit for pan position.
*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildin
pt" is "1"

maxpan0, <positive integer> 0/7

The upper limit for pan position.
*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildin
pt" is "1"

minpanangle<integer>

0/7

The lower limit for pan angle.
*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildin
pt" is "1"

maxpanangle<integer>

0/7

The upper limit for pan angle.
*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildin
pt" is "1"

tiltspeedlv

0, <positive integer> 0/7

The maximum speed level of tilt
motion.
*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildin
pt" is "1"

mintilt

0, <positive integer> 0/7

The lower limit for tilt position.
*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildin
pt" is "1"

User's Manual - 279

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)
maxtilt

0, <positive integer> 0/7

The upper limit for tilt position.
*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildin
pt" is "1"

mintiltangle<integer>

0/7

The lower limit for tilt angle.
*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildin
pt" is "1"

maxtiltangle<integer>

0/7

The upper limit for tilt angle.
*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildin
pt" is "1"zoomspeedlv

0, <positive integer> 0/7

The maximum speed level of zoom
motion.
*Only available when the value of"capability_camctrl_c<0~(n-1)>_zoomm
odule" is "1"

minzoom

0, <positive integer> 0/7

The lower limit for zoom position.
*Only available when the value of"capability_camctrl_c<0~(n-1)>_zoomm
odule" is "1"

maxzoom

0, <positive integer> 0/7

The upper limit for zoom position.
*Only available when the value of"capability_camctrl_c<0~(n-1)>_zoomm
odule" is "1"

maxdzoom

0, <positive integer> 0/7

The upper limit for digital zoom
position.
*Only available when the value of"capability_camctrl_c<0~(n-1)>_zoomm
odule" is "1"

focusspeedlv

0, <positive integer> 0/7

The maximum speed level of focus
motion.
*Only available when the value of"capability_camctrl_c<0~(n-1)>_zoomm
odule" is "1"

280 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITYDESCRIPTION(get/set)
minfocus

0, <positive integer> 0/7

The lower limit for focus position.
*Only available when the value of"capability_camctrl_c<0~(n-1)>_zoomm
odule" is "1"

maxfocus

0, <positive integer> 0/7

The upper limit for focus position.
*Only available when the value of"capability_camctrl_c<0~(n-1)>_zoomm
odule" is "1"

7.27.3 Capability for IR Led
Group: capability_daynight_c<0~(n-1)> n denotes the value of "capability_nvideoin"
PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

support<boolean>

0/7

Indicate whether the camera supports
day/night mode switch

builtinir<boolean>

0/7

Indicate whether to support built-in IR
led.
* We replaced this parameter with“capability_daynight_illuminators_builti
n_support” when the version number(httpversion) is equal or greater than
0312a.

builtinwled<boolean>

0/7

Indicate whether to support built-in
white led.
* We replaced this parameter with“capability_daynight_illuminators_builti
n_type=whiteled” when the version
number (httpversion) is equal or greaterthan 0312a.

User's Manual - 281

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY DESCRIPTION(get/set)

externalir<boolean>

0/7

Indicate whether to support external IR
led.
* We replaced this parameter with“capability_daynight_illuminators_exter
nal_support” when the version number(httpversion) is equal or greater than
0312a.

optimizedir<boolean>

0/7

Indicate whether to support optimized
IR control technology.
* We replaced this parameter with“capability_daynight_illumintators_opti
mizedir” when the version number(httpversion) is equal or greater than
0312a.

smartir<boolean>

0/7

Indicate whether to support smart IR.

ircutfilter<boolean>

0/7

Indicate whether to support IR cut.

lightsensor<boolean>

0/7

Indicate whether to support lightsensor.

blackwhitemode<boolean>

0/7

Indicate whether to support
automatically switch to Black & White
display during the night mode.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0302a.

282 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

ircutsensitivity_type<string>

0/7

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)>_suppo
rt" is 1.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0302a.

ircutsensitivity_supportle 0,vel<positive integer>

0/7

The value indicate the support strength
level of ircutsensitivity.
* Only available when"capability_daynight_c<0~(n-1)>_suppo
rt" is 1 and"capability_daynight_c<0~(n-1)>_ircuts
ensitivity_type" is not "-".
* We support this parameter when theversion number (httpversion) is equal or
greater than 0302a.

extled_interface

do<product
dependent>

0/7

The 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_exter
nal_interface” when the version
number (httpversion) is equal or greaterthan 0312a.

User's Manual - 283

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY DESCRIPTION(get/set)

spectrum_support<boolean>

0/7

Indicate whether to support proposed abrightness enhancement method basedon CCM(Color Correction Matrix) model
to improve the brightness effect of theimages if the IR and blue light exists.
* Only available when"capability_daynight_c<0~(n-1)>_suppo
rt" is 1* We replaced this parameter with“capability_daynight_illuminators_spect
rum_support” when the version
number (httpversion) is equal or greaterthan 0312a.

spectrum_mode

visible,ir,irenhanced, 0/7
blueenhanced

Indicate the spectrum mode.
"visible": The ideal default setting for<product
dependent>

visible light.
"ir": The ideal default setting for IR
light.
"irenhanced": This CCM modelincreases the brightness effect of IR
light.
"blueenhanced": This CCM modelincreases the brightness effect of blue
light.
*Only available when"capability_daynight_c<0~(n-1)>_suppo
rt" is 1 and"capability_daynight_c<0~(n-1)>_spectr
um_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.

284 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITY DESCRIPTION(get/set)mode

auto,daynight,di,di2, 0/7
di3,di4,schedule,-

Indicate the day / night switch mode.
"auto": The Camera automatically<productjudges the current operation mode bydependent>

the level of ambient light detected.
"daynight": support day mode and night
mode. In day mode, the camera
streams color video. In night mode, thecamera 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 automaticallyswitches the current mode when aditigal input 2 is triggered.
"di3": the camera automaticallyswitches the current mode when aditigal input 3 is triggered.
"di4": the camera automaticallyswitches the current mode when aditigal 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 theversion number (httpversion) is equal or
greater than 0309d.

7.27.4 Capability for IR Illuminators
Group: capability_daynight_illuminators
PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

User's Manual - 285

VIVOTEK

optimizedir© 2020 VIVOTEK INC. All Right Reserved<boolean>

0/7

Indicate whether to support optimized IR
control technology.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

builtin_support<boolean>

0/7

Indicate whether to support built-in led.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

builtin_typeirled,whiteled,-

0/7

Indicate whether to support built-in led<producttype.

dependent>"irled": IR led"whiteled": white led"-": not support* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

external_support<boolean>

0/7

Indicate whether to support external led.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

external_interface

286 - User's Manual

do,do2,do3,do4<product
dependent>

0/7

The device interface of external led:"do": digital output 1"do2": digital output 2* Available values
are do,do<2~(capability_nd"do3": digital output 3"do4": digital output 4* We support this parameter when theo)>version number (httpversion) is equal or
greater than 0312a.
* Only available when"capability_daynight_illuminators_
external_support" is 1

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

spectrum_support<boolean>

0/7

Indicate whether to support proposed abrightness enhancement method based on
CCM(Color Correction Matrix) model
to improve the brightness effect of theimages if the IR and blue light exists.
* Only available when"capability_daynight_c<0~(n-1)>_support"
is 1* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

spectrum_mode

visible,ir,irenhanced, 0/7
blueenhanced

Indicate the spectrum mode.
"visible": The ideal default setting for<product

visible light.

dependent>"ir": The ideal default setting for IR light.
"irenhanced": This CCM model increases
the brightness effect of IR light.
"blueenhanced": This CCM modelincreases the brightness effect of blue
light.
*Only available when"capability_daynight_c<0~(n-1)>_support"
is 1 and"capability_daynight_illuminators_spectru
m_support " is 1
* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

7.27.5 Capability for Storage Management
Group: capability_storage_management
PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

ndevice<positive integer>

0/7

Indicate the number of storage devices.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

User's Manual - 287

VIVOTEK

device© 2020 VIVOTEK INC. All Right Reserved

sd, nas

0/7<product
dependent>

Indicate the supported storage devices.
* Only available when"capability_storage_dbenabled" is 1.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.
* Note: If “nas” storage is supported, themedia storage path format is “\<macaddress>\date\hour”. “\date\hour” format
is “\YYYYMMDD\hh”.

modnum0,

0/7<positive integer>

The maximum MOD connection numbers.
* Only available when"capability_storage_dbenabled" is 1.
* We support this parameter when theversion 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"
PARAMETERVALUE

SECURITYDESCRIPTION(get/set)
lens_type

fisheye, fixed,
varifocal,
changeable,
motor, ics,<productdependent>

0/7

The lens type 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-mountlens 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

288 - User's Manual© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITY

VIVOTEKDESCRIPTION(get/set)color_support<boolean>0/7

1 : camera can select to display color or
black/white video streams.
0: camera do not support this feature.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0310a.

eptz_zoomratio<string>

0/7

Indicate the support zoom ratio of eptz.
"-": not support ePTZ
* We support this parameter when theversion number (httpversion) is equal or
greater than 0310a.

rotation<boolean>

0/7

Indicate current mode whether support
video rotation

User's Manual - 289

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)
rotationaffect<product
dependent>

0/7

When rotation is enabled, some features
may become malfunction or be forced to agiven 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 orvalue.
- (ranged) : UI is fixed to multiple selections
or values.
- (enabled) : UI is checked.
- (notsupport) : the affected function is notavailable.
"Affect API name" can be described inhierarchy, such as"exposurewin.mode.blc:disabled:" whichmeans 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 theversion number (httpversion) is equal or
greater than 0304b.

290 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITYDESCRIPTION(get/set)
rotationangle<string>

0/7

The different angles which camera supports
for rotation.
* Only avaliable when"capability_videoin_c<0~(n-1)>_rotation" is1.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0309b.

orientation

flip,mirror,rotatio 0/7

Indicates the camera supports flip, mirror ornrotation.

<product
dependent>* We support this parameter when theversion number (httpversion) is equal or
greater than 0309b.

streamcodec<positive integer> 0/7

Represent supported codec types of eachstream.
This contains a list of positive integers, split
by comma. Each one stands for a stream,
and the definition is as following:
Bit 0: Support MPEG4.
Bit 1: Support MJPEG
Bit 2: Support H.264
Bit 3: Support H.265

mode

0,<positive
integer>

0/7

Indicate current video mode.

nmode<positive integer> 0/7

Indicate how many video modes supportedby this channel.

maxsize

<WxH>

0/7

The maximum resolution of all modes in thischannel, the unit is pixel.

nprivacymask

0, <positive
integer>

0/7

Number of privacy mask per channel

nresolution<positive integer> 0/7

The maximum resolution options (listed in"resolution") in current video mode.

User's Manual - 291

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)
resolution

A list of <WxH><product0/7

dependent>

Resolution options in current video mode.
These options are the possible options for"videoin_c<n>_s<m>_resolution".
The last one is the maximum resolution incurrent mode.

maxresolution

A list of <Integer> 0/7

Represent supported maximum resolutionof each stream in current video mode.
* The element number is defined as"capability_nmediastream".

minresolution

A list of <Integer> 0/7

Represent supported minimum resolutionof each stream in current video mode.
* The element number is defined as"capability_nmediastream".
* We support this parameter when theversion number (httpversion) is equal or
greater than 0304b.

maxframerate

A list of <Integer> 0/7

Indicate 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<n>_cmosfreq"=50 or"videoin_c<n>_modulation"=pal.
Ex: 30 fps is changed to 25 fps, 60 fps ischanged to 50 fps, and so on.

292 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITYDESCRIPTION(get/set)
mjpeg_maxframerate A list of <Positive 0/7
Integer> and "-"Maximum fps that the device can encodedwith MJPEG on resolutions in current videomode.
"-" means not support.
* One to one mapping to the resolution in"resolution".
* The element number is defined as"nresolution" in this group.
* This parameter may be changed when"videoin_c<n>_cmosfreq"=50 or"videoin_c<n>_modulation"=pal.
Ex: 30 fps is changed to 25 fps, 60 fps ischanged to 50 fps, and so on.
* Only available when 'mjpeg' is listed in"capability_videoin_codec".

mjpeg_maxbitrate<positive
integer>, -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_maxframerate

A list of <Positive 0/7
Integer> and "-"Maximum fps that the device can encodedwith H.264 on resolutions in current videomode.
"-" means not support.
* One to one mapping to the resolution in"resolution".
* The element number is defined as"nresolution" in this group.
* This parameter may be changed when"videoin_c<n>_cmosfreq"=50 or"videoin_c<n>_modulation"=pal.
Ex: 30 fps is changed to 25 fps, 60 fps ischanged to 50 fps, and so on.
* Only available when 'h264' is listed in"capability_videoin_codec".

User's Manual - 293

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITYDESCRIPTION(get/set)
h264_maxbitrate<positive integer> 0/7

Maximum bitrates of H.264.
The unit is bps.
* Only available when 'h264' is listed in"capability_videoin_codec".

h264_profile

baseline,main,hig 0/7
hIndicate H264 profiles* Only available when 'h264' is listed in"capability_videoin_codec".
* We support this parameter when theversion number (httpversion) is equal or
greater than 0309a.

h265_maxframerate

A list of <Positive 0/7

Maximum fps that the device can encoded

Integer> and "-"with H.265 on resolutions in current videomode.
"-" means not support.
* One to one mapping to the resolution in"resolution".
* The element number is defined as"nresolution" in this group.
* This parameter may be changed when"videoin_c<n>_cmosfreq"=50 or"videoin_c<n>_modulation"=pal.
Ex: 30 fps is changed to 25 fps, 60 fps ischanged to 50 fps, and so on.
* Only available when 'h265' is listed in"capability_videoin_codec".

h265_maxbitrate<positive integer> 0/7

Maximum bitrates of H.265.
The unit is bps.
* Only available when 'h265' is listed in"capability_videoin_codec".

h265_profile

main,main10<product
dependent>

0/7

Indicate H265 profiles* Only available when 'h265' is listed in"capability_videoin_codec".
* We support this parameter when theversion number (httpversion) is equal or
greater than 0309a.

294 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITYDESCRIPTION(get/set)
fisheye_mounttype<Not recommended

ceiling, wall, floor 0/7<product

Indicate the supported type.
wall mount: 180° panoramic viewto use this>dependent>

ceiling mount: 360° surround view without
blind spots
floor mount: 360° surround view without
blind spots* Only available when "capability_fisheye" >0* It's recommended to use"capability_videoin_c<0~(n-1)>_mounttype"

mounttypeceiling, wall,
floor,-

0/7

Indicate the supported mount type.
"-": not support<product
dependent* We support this parameter when theversion number (httpversion) is equal or* Available values
are listed in "capability_videoin

greater than 0309c.

_c<0~(n-1)>_mou
nttype "dintraperiod_support <boolean>

0/7

0: 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 ofI-frame.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0301c.

User's Manual - 295

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)
cameraunit_name

CU8131,
CU8171,A "camera unit" name of a split-type camera
system, which the camera unit and the

0/7

CU8161-H,

video core are separated.

CU8162-H,
CU8163-H,-: If the camera is not a split-type camera
system, the value of this parameter is "-".

CU8361-H,* We support this parameter when the...,-version number (httpversion) is equal or
greater than 0302b.

<product
dependent>
cmosfreq_support<boolean>

0/7

0: The power line frequency(50/60Hz) is
detected by camera automatically.
1: The power line frequency(50/60Hz) canbe set by user.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0308a.

smartfps_support<boolean>

0/7

Indicate whether to support Smart fps
function.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0309a.

smartq_support<boolean>

0/7

Indicate whether to support Smart Q
function.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0309a.

7.27.7 Capability for Local Dewarp
Group: capability_videoin_c<0~(n-1)>_localdewarp(capability_fisheyelocaldewarp_c<0~(capability_nvideoin)-1> > 0)n denotes the value of "capability_nvideoin"
PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

typeceilingmount

1O, 1P, 2P, 1R, 4R

0/7

296 - User's Manual

Available dewarp types of ceiling andfloor mount.

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

typewallmount

1O, 1P, 1R, 4R

0/7

Available dewarp types of wall mount.

resolutionC1P

A list of <WxH>

0/7

Available resolutions of 1P mode ofceiling and floor mount.

resolutionC2P

A list of <WxH>

0/7

Available resolutions of 2P mode ofceiling and floor mount.

resolutionC1R

A list of <WxH>

0/7

Available resolutions of 1R mode ofceiling and floor mount.

resolutionC4R

A list of <WxH>

0/7

Available resolutions of 4R mode ofceiling and floor mount.

resolutionW1P

A list of <WxH>

0/7

Available resolutions of 1P mode of wall
mount.

resolutionW1R

A list of <WxH>

0/7

Available resolutions of 1R mode of wall
mount.

resolutionW4R

A list of <WxH>

0/7

Available resolutions of 4R mode of wall
mount.

panorama_pancontrol<Boolean>

0/7

Indicate whether to support
localdewarp panorama pan control.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0312b.

7.27.8 Capability for Video ModeGroup: 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"
PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

rotation<boolean>

0/7

Indicate this mode whether support
video rotation

User's Manual - 297

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY DESCRIPTION(get/set)eptz

0, <positive integer> 0/7

Indicate 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 achannel support ePTZ or not. The 2nd bit of the groupindicates 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.

wdrpro0, 1, 2

0/7

Indicate this mode whether support WDR pro.
0: Non-support WDR Pro
1: Support WDR Pro

2: Support WDR Pro and WDR Pro II* We support this parameter when theversion number (httpversion) is equal or
greater than 0304b.
effectivepixel

298 - User's Manual

<WxH>

0/7

The visible area of full scene in this videomode.
The unit is pixel in source.
* If"effectivepixel"<"capability_videoin_c<0~(n-1)>_maxsize", then the visible area islocated at the center of full scene.

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

outputsize

<WxH>

0/7

The output size of source, equal to thecaptured 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.

binning

0, 1, 3

0/7

Indicate binning is used or not in thisvideo mode.
0: No binning
1: 2x2 binning
3: 3x3 binning* Binning is a technology to increase lightsensitivity by combining multiple pixels
to one. The drawback is reduced
resolution. We design this parameter todisclose this information.

nresolution<positive integer>

0/7

How many resolution options in thisvideo mode.

resolution

A list of <WxH>

0/7

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

maxresolution

A list of <Integer>

0/7

Represent supported maximum
resolution of each stream in current
video mode.
* The element number is defined as"capability_nmediastream".

User's Manual - 299

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY DESCRIPTION(get/set)minresolution

A list of <Integer>

0/7

Represent supported minimum
resolution of each stream in current
video mode.
* The element number is defined as"capability_nmediastream".
* We support this parameter when theversion number (httpversion) is equal or
greater than 0304b.

maxframerate

A list of <Positive

0/7

Integer>

Indicates 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 ratewhen"videoin_c<0~(n-1)>_cmosfreq"=60 or"videoin_c<0~(n-1)>_modulation"=ntsc

maxfps_mjpeg

A list of <Positive
Integer> and "-"0/7

Maximum fps which the device canencoded with MJPEG on resolutions inthis 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 ratewhen"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".

300 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

maxfps_h264

A list of <Positive
Integer> and "-"0/7

Maximum fps which the device canencoded with H.264 on resolutions in thisvideo 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 ratewhen"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_h265

A list of <Positive

0/7

Integer> and "-"Maximum fps which the device canencoded with H.265 on resolutions in thisvideo 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 ratewhen"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".

description<string[128]>

0/7

Description 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, <positive
integer>

0/7

A 32-bits integer, each bit can be set
separately as follows:

User's Manual - 301

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
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.
hlm

<boolean>

0/7Hightlight Mask: The function will
strengthen the image contrast andmask the specified zone of image if
any strong spot-light exists.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0311a.

wdrpro_mode

0, 1, 20/7

0: Non-support WDR Pro
1: Support WDR Pro
2: Support WDR Pro and WDR Pro II

wdrpro_strength

0, 1

0/7

0: 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_supportlevel0, <positive
integer>

0/7This 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 firstnumber indicate the support strength
level of WDR Pro, and the scecond
number indicate the support strength
level of WDR Pro II.

wdrpro_affect-,exposurewin.mode

0/7

When WDR Pro is enabled, somefeatures may become malfunction or

302 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set):fixed:auto,
exposurelevel:hidd
en:,exposurelevel:fixed

be forced to a given value. The
affected functions are list here.
The format is "Affect API
name":"Policy":"Description":<x>,
exposurelevel:fixed:<x>/<x>,"Policy" can be categorized into
following groups:- (disabled) : UI turns grey and users

exposuremode:fixed:auto,can't select it.
- (unchanged) : UI keeps the status asgammacurve:disabl
ed:,exposurewin.mode.blc:hidden:,
exposurewin.mode.hlc:hidden:,
exposuretime:hidd
en:,gaincontrol:hidden:,
flickerless:unchanged:,wdrc:enabled:,
wdrc:enabled:only
once,
wdrc:unchanged:,<x>: nonnegative
integer<product
dependent>

before and user can't change it.
- (hidden) : UI is hidden.
- (fixed) : UI is fixed to one selection orvalue.
- (ranged) : UI is fixed to multiple
selections or values.
- (enabled) : UI is checked.
- (notsupport) : the affected function
is not available.
- (onlyonce) : when wdrpro is enabled,
wdrc is checked; when wdrpro isdisable, wdrc is unchecked.
"Affect API name" can be described inhierarchy, 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" whichmeans exposurelevel is fixed to level
6, level 8 and level 12.
"-" means no feature is affected.

User's Manual - 303

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)* When "wdrpro"=0, this value mustbe "-"
wdrpro_description<string>

0/7

Description about WDR Pro mode.
* Only available when"capability_image_c<0~(n-1)>_wdrpro_mode" > 0

wdrc_mode

0, 1

0/7

0: Non-support WDR Enhanced
1: Support WDR Enhanced

wdrc_supportlevel0, <positive
integer>

0/7

Indicate the support strength level of
WDR Enhanced.

wdrc_affect-,
0/7
gammacurve:disabl
ed:,<x>: nonnegative
integer<product
dependent>

When WDR Enhanced 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 asbefore and user can't change it.
- (hidden) : UI is hidden.
- (fixed) : UI is fixed to one selection orvalue.
- (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 inhierarchy, such as"exposurewin.mode.blc:disabled:"
which means blc exposure window is
disabled. API name can be one word

304 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
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" whichmeans exposurelevel is fixed to level
6, level 8 and level 12.
"-" means no feature is affected.
* When "wdrc"=0, this value must be
"-"
dnr

0,1

0/7

0: Non-support 3D digital noise
reduction
1: Support 3D digital noise reduction

dnrstrength<positive integer>

0/7

Indicate the support strength level of
3D digital noise reduction.
* Only available when"capability_image_c<0~(n-1)>_dnr" >0.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0306d.

dnrtype

2d,3d

0/7

Description about DNR type.
* Only available when"capability_image_c<0~(n-1)>_dnr" >0.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0308a.

eis

0,1

0/7

0: Non-support electronic image
stabilizer
1: Support electronic image stabilizer

is_mode

eis,
dis,
-

0/7

Indicate the image stabilizer mode.
"eis": electronic image stabilizer"dis": digital image stabilizer

User's Manual - 305

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)"-": not support* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.
is_strength<boolean>0/7

0: Non-support tuning strength ofimage stabilizer mode.
1: Support tuning strength of image
stabilizer mode.
* Only available when"capability_image_c<0~(n-1)>_is_mod
e" is not "-".
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.

is_supportlevel0, <positive
integer>

0/7

Indicate the support strength level ofimage stabilizer mode.
* Only available when"capability_image_c<0~(n-1)>_is_mod
e" is not "-".
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.

is_affect306 - User's Manual-,<x>: nonnegative
integer<product
dependent>

0/7

When Is mode is not "-", somefeatures 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 asbefore anduser can't change it.
- (hidden) : UI is hidden.

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)- (fixed) : UI is fixed to one selection orvalue.
- (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 inhierarchy, 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_mod
e" is not "-".
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.
scenemode_support

0,1

scenemode_supportty visibility,penoiseless,<product dependent> lpcparkinglot,
lpcstreet,
lpchighway,
auto,
deblur,lpcfreeway<product
dependent>

0/7

0: Non-support scene mode
1: Support scene mode

0/7

list all the scene mode which aresupported in the camera.
* Only available when"capability_image_c<0~(n-1)>_
scenemode_support" is 1

User's Manual - 307

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
wbmodeauto,
panorama,
manual,rbgain,0/7

Available white balance mode.
"-" means white balance is notsupported.

0/7

Indicate iris type.
"piris": P-Iris"dciris": DC-Iris"-": No Iris control support* Note: For some cameras, this value

widerange,
outdoor,indoor,
sodiumauto,<product
dependent>
iristype

piris,
dciris,-may be varied depending on mounted
lens.
sensortype

rawsensor,

0/7

Indicate sensor type.

smartsensor,
thermalsensor,"rawsensor": Raw sensor"smartsensor": Smart sensor-"thermalsensor": Thermal sensor"-": N/A* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.

exposure_mode

0,1

0/7

0: Non-support exposure control.
1: Support exposure control.

exposure_modetypeauto,
shutterpriority,
irispriority,
manual<product
dependent>

0/7

Available mode of exposure setting.
* Only available when"capability_image_c<0~(n-1)>_
exposure_mode" is 1.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.

exposure_rangetype

onevalue,
twovalues

0/7

Support interface of exposure range.
"onevalue": The parameter is a308 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
constant value.
"twovalues": Need two parameters toindicate the exposure range.
* Only available when"capability_image_c<0~(n-1)>_
exposure_mode" is 1.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.
exposure_shuttervalu
etype

fixed,
maximum,-

0/7* One to one mapping to the mode
type in "exposure_modetype".
"fixed": The shutter value is theassigned value(videoin_c<0~(n-1)>_shuttervalue).
"maximum": The shutter value can be
up to the assigned value(videoin_c<0~(n-1)>_shuttervalue).
"-": not support.
* Only available when"capability_image_c<0~(n-1)>_
exposure_mode" is 1 and"capability_image_c<0~(n-1)>_exposu
re_rangetype" is "onevalue".
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.

exposure_gainvaluety
pe

fixed,
maximum,-

0/7* One to one mapping to the mode
type in "exposure_modetype".
"fixed": The shutter value is theassigned value(videoin_c<0~(n-1)>_gainvalue).
"maximum": The shutter value can be
up to the assigned value(videoin_c<0~(n-1)>_gainvalue)"-": not support.
* Only available when

User's Manual - 309

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)"capability_image_c<0~(n-1)>_
exposure_mode" is 1 and"capability_image_c<0~(n-1)>_exposu
re_rangetype" is "onevalue".
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.
exposure_automode_
affect

310 - User's Manual-,exposurewin.mode

0/7

When exposure auto mode isenabled, some features may become.blc:hidden:,defog:disabled:,
wdrpro:disabled:,
exposurelevel:hidd
en:,defaultgain:fixed:x

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 intoor others<x>: nonnegative
integer<product
dependent>

following groups:- (disabled) : UI turns grey and users
can't select it.
- (unchanged) : UI keeps the status asbefore anduser can't change it.
- (hidden) : UI is hidden.
- (fixed) : UI is fixed to one selection orvalue.
- (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 inhierarchy, 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

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
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 whenthe version number (httpversion) is
equal or greater than 0302a.
exposure_shutterprior -,itymode_affectexposurewin.mode.blc:hidden:,defog:disabled:,
wdrpro:disabled:,
exposurelevel:hidd
en:,defaultgain:fixed:xor others<x>: nonnegative
integer<product
dependent>

0/7

When exposure shutter priority modeis enabled, some features may
become malfunction or be forced to agiven 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 asbefore anduser can't change it.
- (hidden) : UI is hidden.
- (fixed) : UI is fixed to one selection orvalue.
- (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 inhierarchy, such as

User's Manual - 311

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)"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 whenthe version number (httpversion) is
equal or greater than 0302a.
exposure_irispriority
mode_affect

312 - User's Manual-,exposurewin.mode.blc:hidden:,defog:disabled:,
wdrpro:disabled:,
exposurelevel:hidd
en:,defaultgain:fixed:xor others<x>: nonnegative
integer<product
dependent>

0/7

When exposure iris priority mode isenabled, 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 asbefore anduser can't change it.
- (hidden) : UI is hidden.
- (fixed) : UI is fixed to one selection orvalue.
- (ranged) : UI is fixed to multiple

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
selections or values.
- (enabled) : UI is checked.
- (notsupport) : the affected function
is not available.
"Affect API name" can be described inhierarchy, 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 islisted in"capability_image_c<0~(n-1)>_
exposure_modetype" and"capability_image_c<0~(n-1)>_
exposure_mode" is 1.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.
exposure_qualityprioritymode_affect-,exposurewin.mode.blc:hidden:,defog:disabled:,
wdrpro:disabled:,
exposurelevel:hidd
en:,defaultgain:fixed:xor others<x>: nonnegative
integer<product

0/7

When exposure quality priority modeis enabled, some features may
become malfunction or be forced to agiven 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

User's Manual - 313

VIVOTEKNAME© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)
dependent>

before anduser can't change it.
- (hidden) : UI is hidden.
- (fixed) : UI is fixed to one selection orvalue.
- (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 inhierarchy, 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 whenthe version number (httpversion) is
equal or greater than 0305a.

exposure_manualmod -,e_affect
exposurewin.mode.blc:hidden:,defog:disabled:,
wdrpro:disabled:,
exposurelevel:hidd

314 - User's Manual

0/7

When exposure manual mode isenabled, some features may become
malfunction or be forced to a given
value. The affected functions are list
here.
The format is "Affect API

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)en:,
icrmode.auto:nots
upport:or othersname":"Policy":"Description""Policy" can be categorized into
following groups:- (disabled) : UI turns grey and users<x>: nonnegative
integer<product

can't select it.
- (unchanged) : UI keeps the status asbefore anddependent>

user can't change it.
- (hidden) : UI is hidden.
- (fixed) : UI is fixed to one selection orvalue.
- (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 inhierarchy, 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 listedin "capability_image_c<0~(n-1)>_
exposure_modetype" and"capability_image_c<0~(n-1)>_
exposure_mode" is 1.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.

exposure_levelrange

-,

0/7

Available range for

User's Manual - 315

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)"0,12""videoin_c<0~(n-1)>_exposurelevel"* When "exposure_mode"=0, thisvalue must be set to "-".
* Only available when"capability_image_c<0~(n-1)>_
exposure_mode" is 1.

exposure_winmode

auto,
custom,
blc,

0/7

hlc,
center,<product
dependent>
exposure_meteringm
ode

auto,
blc,
hlc

Available options for"exposurewin_c<0~(n-1)>_mode"* "-" means group: exposurewin is notsupported.
* When exposure_mode="0", thisvalue must be set to "-".
* Only available when"capability_image_c<0~(n-1)>_
exposure_mode" is 1.

0/7<product
dependent>

Available options for"videoin_c<0~(n-1)>_meteringmode"* Only available when"capability_image_c<0~(n-1)>_
exposure_mode" is 1.

exposure_hlcmode_s
upportwindow<boolean>

0/7

Indicate 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_af
fect-,
sir:hidden:
or others<x>: nonnegative
integer<product
dependent>

0/7

When hlc mode is enabled, somefeatures 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

316 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
can't select it.
- (unchanged) : UI keeps the status asbefore anduser can't change it.
- (hidden) : UI is hidden.
- (fixed) : UI is fixed to one selection orvalue.
- (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 inhierarchy, 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 listedin "capability_image_c<0~(n-1)>_
exposure_winmode".
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0304a.
exposure_wintype

inclusive,
exclusive,-

0/7

The supported exposure window type.
"inclusive": The image inside awindow is the target area of exposure
control.
"exclusive": The image inside aUser's Manual - 317

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
window is omitted by exposure
control.
"-": Not supported.
* Only available when"capability_image_c<0~(n-1)>_
exposure_mode" is 1.
exposure_windomain

qvga, px, std, -0/7

The 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

0/7

Integer>

Indicate the number of custom
exposure windows.
* If no "custom" is listed in"exposure_winmode", this should be0.
* Only available when"capability_image_c<0~(n-1)>_
exposure_mode" is 1.

exposure_ntsc_totalra A list of <Positivenge
Integer>

0/7

Available total range for NTSC analog
output.
* Only available when"capability_image_c<0~(n-1)>_
exposure_mode" is 1.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0301a.

exposure_pal_totalra
nge

0/7

Available total range for PAL analog
output.
* Only available when318 - User's Manual

A list of <Positive
Integer>VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)"capability_image_c<0~(n-1)>_
exposure_mode" is 1.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0301a.
exposure_maxrange"1,32000","1,8000",-,
or others

0/7<product
dependent>

Available range for"videoin_c<n>_maxexposure""1,32000" => 1s ~ 1/32000s"1,8000" => 1s ~ 1/8000s
etc.
"-" means maximum exposure time is
not available.
* When "exposure_mode"=0, thisvalue must be set to "-".
* Only available when"capability_image_c<0~(n-1)>_
exposure_mode" is 1.

exposure_minrange"1,32000",

0/7

Available range for"1,8000",-,"videoin_c<n>_minexposure""1,32000" => 1s ~ 1/32000s

or others<product
dependent>"1,8000" => 1s ~ 1/8000s
etc.
"-" means minimum exposure time is
not available.
* When "exposure_mode"=0, thisvalue must be set to "-".
* Only available when"capability_image_c<0~(n-1)>_
exposure_mode" is 1.

exposure_bracketing_mode<boolean>0/7

0: Non-support Auto Exposure
Bracketing (AEB)
1: Support Auto Exposure Bracketing(AEB)
Auto Exposure Bracketing (AEB) is aterm that is used to signify a process
where the camera automatically takes

User's Manual - 319

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
two or more exposures but withdifferent exposure values.
* Only available when"capability_image_c<0~(n-1)>_
exposure_mode" is 1.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0310a.
exposure_bracketing_

A list of ratio

range

For example:
2x,3x,4x0/7

The 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 whenthe version number (httpversion) is
equal or greater than 0310a.

privacymask_wintype

rectangle,

0/7

The supported mask window type.
"polygon": The window is a 2D
polygon shape.
"rectangle": The window is a 2D

polygon,3Drectangle

rectangle shape.
"3Drectangle": The window is a 3D
rectangle shape.
privacymask_windomainqvga, px, std, -0/7

The 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_ncolor<Positive Integer>

0/7

Available total color numbers ofprivacy mask.

agc_maxgain"0,100",

0/7

Available range for

320 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)"-""videoin_c<n>_maxgain"“0,100” => 0~100 percent"-" means "videoin_c<n>_maxgain" is
not available.

agc_mingain"0,100","-"

0/7

Available range for"videoin_c<n>_mingain"“0,100” => 0~100 percent"-" means "videoin_c<n>_mingain" is
not available.

flickerless

0,1

0/7

0: Non-support flickerless
1: Support flickerless

flickerlessaffect-,minexposure.lower
bound:fixed:xor others

0/7

When flickerless is enabled, somefeatures may become malfunction or
be forced to a given value. The
affected functions are list here.

<x>: nonnegative
integer<product

The format is "Affect API
name":"Policy":"Description""Policy" can be categorized into

dependent>

following groups:- (disabled) : UI turns grey and users
can't select it.
- (unchanged) : UI keeps the status asbefore anduser can't change it.
- (hidden) : UI is hidden.
- (fixed) : UI is fixed to one selection orvalue.
- (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 inhierarchy, such as"exposurewin.mode.blc:disabled:"
which means blc exposure window isUser's Manual - 321

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
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_mode

0,1

0/7

0: Non-support defog
1: Support defog

defog_strength

0, 1

0/7

0: Non-support tuning strength ofdefog
1: Support tuning strength of defog* If"capability_image_c<0~(n-1)>_defog_
mode"=1, this may be either 0 or 1.

defog_supportlevel0, <positive

0/7

The value indicate the support

integer>defog_affect322 - User's Manual-,
wdrc:unchanged:
contrast:hidden:
or others<x>: nonnegative
integer<product
dependent>

strength level of defog.
0/7

When defog is enabled, some features
may become malfunction or be forced
to a given value. The affectedfunctions 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 asbefore anduser can't change it.
- (hidden) : UI is hidden.
- (fixed) : UI is fixed to one selection orvalue.
- (ranged) : UI is fixed to multiple

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
selections or values.
- (enabled) : UI is checked.
- (notsupport) : the affected function
is not available.
"Affect API name" can be described inhierarchy, 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 mustbe "-"
aespeed0,1

0/7

0: Non-support AE speed
1: Support AE speed

aespeedsupportlevel<positive integer>

0/7

The value indicate the support
strength level of aespeed.
* Only available when"capability_image_c<0~(n-1)>_aespeed" is 1.

aespeedsupportsensit
ivity

0,1

0/7

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

gammacurve

0,1

0/7

0: Non-support tuning Gamma curve
1: Support tuning Gamma curve

lowlightmode

-,0,1

0/7

-: Internal parameter, must not open
to user.
0: Non-support low light mode

User's Manual - 323

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
1: Support low light mode
focusassist

0,1

0/7

0: Non-support focus assist
1: Support focus assist

remotefocus

0,<positive

0/7

An 4-bit integer, which indicates theinteger>

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

focuswindomain

qvga, px, std, -0/7

The 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_nwindo
w0,<positive
integer>

focuswindow_range<leftrange,rightran 0/7
ge,toprange,lowrange><product
dependent>

Available range for focuswindow.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0305d.
*-: Not supported.

lensconfiguration_sup
port

0,1

0/7

Indicate whether to support different
image library configuration files for
specific exchangeable lens.

freeze<boolean>0/7

0: Non-support image freeze feature
1: Support image freeze feature

324 - User's Manual

0/7

Number of focus window

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.
autotrack_support<boolean>0/7

0: Non-support auto tracking feature
1: Support auto tracking feature* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.

smartsensor_iristotalrange

A list of iris value

0/7

Available total step for iris value.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0302a.
* Only available when"capability_image_c<0~(n-1)>_sensor
type" is "smartsensor"

deinterlace_support<boolean>

0/7

Indicate whether to support
deinterlace function.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0308a.

deinterlace_mode

spatial, blend

0/7

Spatical mode provides the best
image quality, while Blend mode
provides better image quality (thannot using the deinterlace function atall).
* Only available whencapability_image_c<0~(n-1)>_deinterl
ace_support is 1

lens_alignment<boolean>

0/7

Indicate whether to support lensalignment function.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0309b.

lens_alignmentlevel<positive integer>

0/7

The value indicate the support level ofalignment.
* Only available when

User's Manual - 325

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)"capability_image_c<0~(n-1)>_lens_al
ignment" is 1.
lens_ldc_support<boolean>

0/7

Indicate whether to support lensdistortion correction function.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0309d.

palette_support<boolean>

0/7

Indicate support color palettes or not.
Thermal cameras provide a choice ofcolor palettes on the camera, that
help quickly distinguish thermalvariations and patterns in an image.
The color tones correspond to theapparent surface temperatures of thetarget.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0310a.

palette_mode

7.27.10

A list of palette
options

0/7

Palette options used in thermal
surveillance.
*Only available when"capability_image_c<0~(n-1)>_palette_support"=1.
* We support this parameter whenthe version number (httpversion) is
equal or greater than 0310a.

Capability for Peripheral Device

Group: capability_peripheral_c<0~(n-1)> n denotes the value of "capability_nvideoin"
PARAMETERVALUE

SECURITY(get/set)

DESCRIPTION

devicecontrol<boolean>

0/7

Indicate whether to support the
peripheral device control.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0305c.

326 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

7.28 Event SettingGroup: event_i<0~(n-1)> n denotes the value of "capability_nevent"(capability_nevent > 0)
PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

namestring[40]6/6

Identification of this entry.

enable0, 1

6/6

Enable or disable this event.

priority

0, 1, 2

6/6

Indicate the priority of this event:“0”= low priority“1”= normal priority“2”= high priority

delay

1~999

6/6

Delay in seconds before detecting thenext event.

trigger

boot,

6/6

Indicate the trigger condition:

di,
pir,
motion,"boot" = System boot.
"di"= Digital input.
"pir"= PIR detection.

seq,
recnotify,
tampering,"motion" = Video motion detection.
"seq" = Periodic condition.
"visignal" = Video input signal loss.
"recnotify" = Recording notification.
"tampering" = Tamper detection.

vi,
volalarm,
visignal,"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.
* "smartsd" is only valid when smart SD
card is inserted

vadp,
smartsd<product
dependent>

triggerstatus

string[40]6/6The status for event trigger

User's Manual - 327

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITY DESCRIPTION(get/set)di0,<positive
integer>

6/6

Indicate the source id of di trigger.
This field is required when trigger
condition is “di”.
One bit represents one digital input. The
LSB indicates DI 0.
* Only available when "capability_ndi" >
0

mdwin

0,<positive

6/6

integer>

Indicate the source window id of motion
detection.
This field is required when trigger
condition is “md”.
One bit represents one window.
The LSB indicates the 1st window.
For example, to detect the 1st and 3rd
windows, set mdwin as 5.

mdwin00,<positive
integer>

6/6

Similar to mdwin. The parameter takes
effect when profile 1 of motion detection
is enabled.

vi

0,<positive
integer>

6/6

Indicate the source id of vi trigger.
This field is required when trigger
condition is “vi”.
One bit represents one digital input. The
LSB indicates VI 0.

vadp<product dependent>

0,<positive
integer>

6/6

Indicate the source id of vadp event
notification.
Each bit corresponds to one vadp source,
and the LSB indicates source id 0.
For example, to detect event from any
one of source id 0, 1 and 3, set vadp to11.
* Only available when vadp is listed in"capability_supporttriggertypes"

valevel0,1

6/6

Select audio detection event.
0: not select
1: select328 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

valevel00,1

6/6

Select audio detection profile event.
0: not select
1: select

inter

1~999

6/6

Interval of snapshots in minutes.
This field is used when trigger condition
is “seq”.

weekday

0~127

6/6

Indicate which weekday is scheduled.
One bit represents one weekday.
bit0 (LSB) = Saturday
bit1 = Friday
bit2 = Thursday
bit3 = Wednesday
bit4 = Tuesday
bit5 = Monday
bit6 = Sunday
For example, to detect events on Friday
and Sunday, set weekday as 66.

begintime

hh:mm

6/6

Begin time of the weekly schedule.

endtime

hh:mm

6/6

End time of the weekly schedule.
(00:00 ~ 24:00 sets schedule as alwayson)lowlightcondition<product dependent>

0, 1

6/6

Switch on white light LED in low light
condition
0 => Do action at all times
1 => Do action in low-light conditions

action_do_i<0~(ndo-1)>_ <boolean>enable

6/6

Enable or disable trigger digital output.
* Only available when "capability_ndo" >0action_do_i<0~(ndo-1)>_ 1~999
duration

6/6

Duration of the digital output trigger inseconds.
* Only available when "capability_ndo" >0action_cf_enable

6/6

Enable or disable sending media to SD
card.
* Only available when"capability_supportsd" > 0<Boolean>User's Manual - 329

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITY DESCRIPTION(get/set)action_cf_folder<Not recommended tostring[128]6/6

use this>foldername

Path to store media.
* Only available when"capability_supportsd" > 0

string[128]6/6Path to store media.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

action_cf_media

NULL, 0~4,101

6/6

Index of the attached media.
101 means “Recording Notify”* Only available when"capability_supportsd" > 0

action_cf_datefolder<boolean>

6/6

Enable this to create folders by date,time, and hour automatically.
* Only available when"capability_supportsd" > 0

action_cf_backup<Boolean>

6/6

Enable 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>_en <boolean>
able

6/6

Enable or disable this server action.

action_server_i<0~4>_m NULL, 0~4,101
edia

6/6

Index of the attached media.
101 means "Recording Notify"

action_server_i<0~4>_da <boolean>tefolder

6/6

Enable this to create folders by date,time, and hour automatically.

action_goto_enable<product dependent><boolean>

6/6

Enable/disable ptz goto preset position
on event triggered.
* Only available when"capability_ptzenabled" > 0.

action_goto_name<product dependent>

string[40]6/6Specify the preset name that ptz goto on
event triggered.
* Only available when"capability_ptzenabled" > 0.

330 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITY DESCRIPTION(get/set)action_goto_sync<product dependent><boolean>

6/6Capture media after moving to thelocation.
* Only avaliable when the bit4 ofcapability_ptzenabled is 1 and the bit7 ofcapability_ptzenabled is 0, or
capability_camctrl_c0_zoommodule > 0

action_autotrack_enable <boolean><product dependent>

6/6

Enable/disable auto tracking on event
triggerd.
* Only avaliable when the bit4 ofcapability_ptzenabled is 1 and the bit7 ofcapability_ptzenabled is 0

action_audioclip_enable <boolean>

6/6

Enable/disable the function the play an
audio clip when an event is triggered.
* Only avaliable when"capability_audio_audioclip" is 1.

action_audioclip_media 0,<positive
integer>

6/6

Indicate the source id of audioclip event
notification.
* Only avaliable when"capability_audio_audioclip" is 1.

tampering0,<positive
integer>

6/6

Indicate the source channel id oftampering detection.
A 4-bit integer, each bit represents eachchannel.
bit 0 => tampering detection for firstchannel.
bit 1 => tampering detection for second
channel.
bit 2 => tampering detection for thirdchannel.
bit 3 => tampering detection for fourthchannel.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0311c.

User's Manual - 331

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

7.29 Server Setting for Event Action
Group: server_i<0~4>
PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

namestring[40]6/6

Identification of this entry

type

email,

6/6

Indicate the server type:

ftp,“email” = email server

http,
ns,

“ftp” = FTP server“http” = HTTP server

sftp“ns” = network storage“sftp” = secure FTP* “sftp” is only available when bit 1 of“capability_protocol_ftp_client” is 1.

http_url

string[128]6/6

URL of the HTTP server to upload.

http_username

string[64]6/6Username to log in to the server.

http_passwd

string[64]7/6

Password of the user.

ftp_address

string[128]6/6

FTP server address.

ftp_username

string[64]6/6Username to log in to the server.

ftp_passwd

string[64]7/6

Password of the user.

ftp_port

0~65535

6/6

Port to connect to the server.

ftp_location

string[128]6/6Location to upload or store the media.

ftp_passive<boolean>

6/6

Enable or disable passive mode.
0 = disable passive mode
1 = enable passive mode

email_address

string[128]6/6Email server address.

email_sslmode<boolean>

6/6

Enable support SSL.

email_port

0~65535

6/6

Port to connect to the server.

email_username

string[64]6/6Username to log in to the server.

email_passwd

string[64]7/6

Password of the user.

email_senderemail

string[128]6/6Email address of the sender.

email_recipientemail

string[640]6/6

Email address of the recipient.

332 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

ns_location

string[128]6/6Location to upload or store the media.
* For httpversion is equal or greater than
0312a:The media storage path format is “\<macaddress>\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_username

string[64]6/6Username to log in to the server.

ns_passwd

string[64]7/6

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

SECURITY DESCRIPTION(get/set)address

string[128]6/6Server address

loginmode

passwd,publickey

6/6authentication method:”passwd” = password authentication.
You have to setup sftp_passwd for thislogin mode to work.
”publickey” = Public key authentication
is more secure than password
authentication.
Please see sftpclient.cgi for more detailsettings.

username

string[64]6/6Usernamepasswdstring[64]7/6User password

port

0~65535

6/6Server port

locationstring[128]6/6

Login path on server

User's Manual - 333

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

fingerprint_enable

boolean

6/6

Verify server fingerprint to avoid
connect to fake server.

fingerprint_content

string[128]6/6Server fingerprint(MD5).
You can get it by calculate server hostkey(public) md5.

publickey_pairmode

auto,

6/6

"autopair": Autopair mode is selected

download,
uploadfor this event server.
"downloadkey": Download key pairmode is selected for this event server.
"uploadkey": Upload key pair mode isselected for this event server.

publickey_downloadkeytype

ed25519,

6/6

The keytype used for key pair.

rsa,"ed25519": faster to generate withecdsa

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

6/6

The private key file be encrypted ornot.

publickey_passphrase_content string[128]7/6

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

SECURITY DESCRIPTION(get/set)Namestring[40]6/6

Identification of this entryTypesnapshot,systemlog,
videoclip,
recordmsg

6/6

Media type to send to the server
or store on the server.

334 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

snapshot_channel

0~"capability_nvideoin"-1

6/6

Indicate 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 greaterthan 0311c.

snapshot_source0~"capability_nmediastream 6/6"-1

Indicate the source of media
stream.
0 means the first stream.
1 means the second stream andetc.
2 means the third stream and etc.
3 means the fourth stream andetc.

snapshot_prefix

string[16]6/6

Indicate the prefix of thefilename.
media_i0=> Snapshot1_
media_i1=> Snapshot2_
media_i2=> Snapshot3_
media_i3=> Snapshot4_
media_i4=> Snapshot5_

snapshot_datesuffix

0, 1

6/6

Add date and time suffix tofilename:
1 = Add date and time suffix.
0 = Do not add.

snapshot_preevent0~"
6/6
capability_media_snapshot_
maxpreevent"

Indicates the number of pre-event
images.

snapshot_postevent0~"
6/6
capability_media_snapshot_

Indicates the number ofpost-event images.

maxpostevent"User's Manual - 335

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY DESCRIPTION(get/set)videoclip_channel

0~"capability_nvideoin"-1

6/6

Indicate 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 greaterthan 0311c.

videoclip_source0~"capability_nmediastream 6/6"-1

Indicate the source of media
stream.
0 means the first stream.
1 means the second stream andetc.
2 means the third stream and etc.
3 means the fourth stream andetc.

videoclip_prefix

string[16]6/6

Indicate the prefix of thefilename.

videoclip_preevent0~"
6/6
capability_media_videoclip_

Indicates the time for pre-event
recording in seconds.

maxpreevent"
videoclip_maxduration 1 ~ "6/6
capability_media_videoclip_
maxlength"

Maximum duration of one video
clip in seconds.

videoclip_maxsize

Maximum size of one video clip
file in Kbytes.

50 ~ "
6/6
capability_media_videoclip_
maxsize"videoclip_profiletoken string[64]336 - User's Manual

6/6

Indicate the source for media
profile.
* We support this parameter
when the version number(httpversion) is equal or greaterthan 0314b.

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

7.31 Recording
Group: recording_i<0~(n-1)> n denotes the value of "capability_nrecording"(capability_nrecording > 0)
PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

namestring[40]6/6

Identification of this entry.

triggerschedule,

6/6

The event trigger typenetworkfailschedule: The event is triggered byschedule
networkfail: The event is triggered by
the failure of network connection.

enable<boolean>

6/6

Enable or disable this recording.

priority

0, 1, 2

6/6

Indicate the priority of this recording:“0” indicates low priority.
“1” indicates normal priority.
“2” indicates high priority.

channel0~"capability_nvideoin"-1 6/6

Indicate 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 theversion number (httpversion) is equal or
greater than 0311c.

source0~"capability_nmediastrea 6/6
m"-1

Indicate the source of media stream.
0 means the first stream.
1 means the second stream and so on.

User's Manual - 337

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY DESCRIPTION(get/set)maxretentiontime <string>

6/6

To specify the expired time for
automatic clean up, and it only takes
effect for video clip generated byrecording_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, itmeans 1 days and 10 hours.
The parameter takes effect when
autocleanup_maxretentiontime_recording_enabled
is enabled.

notify<boolean>

6/6

0: Disable recording notification
1: Enable recording notification

notifyserver

0~31

6/6

Indicate which notification server isscheduled.
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.

338 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

weekday

0~127

6/6

Indicate which weekday is scheduled.
One bit represents one weekday.
bit0 (LSB) = Saturday
bit1 = Friday
bit2 = Thursday
bit3 = Wednesday
bit4 = Tuesday
bit5 = Monday
bit6 = Sunday
For example, to detect events on Friday
and Sunday, set weekday as 66.

begintime

hh:mm

6/6

Start time of the weekly schedule.

endtime

hh:mm

6/6

End time of the weekly schedule.
(00:00~24:00 indicates schedule alwayson)prefixstring[16]6/6

Indicate the prefix of the filename.

dest

cf,

6/6

The destination to store the recorded

0~4

data.
“cf” means local storage (CF or SD card).
“0” means the index of the network
storage.

cffolder<Not
recommended touse this>

string[128]6/6

Folder name.

foldername

string[128]6/6

Folder name.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

maxsize

100~2000

6/6

Unit: Mega bytes.
When this condition is reached,recording file is truncated.

maxduration

60~3600

6/6

Unit: Second
When this condition is reached,recording file is truncated.

User's Manual - 339

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITY DESCRIPTION(get/set)

adaptive_enable<boolean>

adaptive_preevent 0~9

6/6

Indicate whether the adaptive
recording is enabled

6/6

Indicate when is the adaptive recording
started before the event trigger point(seconds)

adaptive_postevent 0~10

6/6

Indicate when is the adaptive recording
stopped after the event trigger point(seconds)

recordingjob_Sourc string[64]6/6eToken_Token

Indicate the source for media profile.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0314b.

7.32 HTTPSGroup: https (capability_protocol_https > 0)
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

enable<boolean>

6/6

To enable or disable secure HTTP.

policy<Boolean>

6/6

If the value is 1, it will force HTTP
connection redirect to HTTPS
connection

methodauto,
manual,install

6/6

auto =>Create self-signed certificate
automatically.
manual =>Create self-signed certificate
manually.
install =>Create certificate request andinstall.

status-3 ~ 1

6/6

Specify the https status.
-3= Certificate not installed-2 = Invalid public key-1 = Waiting for certificate
0= Not installed
1 = Active

countryname

340 - User's Manual

string[2]6/6Country name in the certificate
information.

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)stateorprovincename

string[128]6/6State or province name in thecertificate information.

localityname

string[128]6/6The locality name in thecertificate
information.

organizationname string[64]6/6VIVOTEK Inc.

Organization name in the certificate
information.

unit

string[64]
VIVOTEK Inc.

6/6

Organizational unit name inthecertificate information.

commonname

string[64]www.vivotek.com

6/6

Common name in the certificate
information.

validdays

0 ~ 825

6/6

Valid period for the certification.

7.33 Storage Management SettingGroup: disk_i<0~(n-1)> n denotes the value of "capability_storage_management_ndevice"(capability_storage_management_ndevice > 0)
PARAMETERVALUE

SECURITY(get/set)

DESCRIPTION

cyclic_enabled<boolean>

6/6

Enable cyclic storage method.

cyclic_reserve10 ~ 99

6/6

The reserved percentage of this disk.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

type

sd, nas<product
dependent>

6/7

The storage device type.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

User's Manual - 341

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITYDESCRIPTION(get/set)
autocleanup_mode

targetbase,sourcebase

6/6Specify the automatic clean up method
for storage devices, where “targetbase”
indicate the automatic clean up is basedon the attached devices such as nas or sd
card, whereas “sourcebase” indicate
automatic clean up is based on theselected recording track.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

autocleanup_enabled<Not recommended to<boolean>

6/6

use this>Enable automatic clean up method.
Expired and not locked media files will bedeleted.
* For forward compatibility reservations,but only group disk_i0_autocleanup iseffective.
* Not recommended to use this. Pleaserefers "autocleanup" group.
* This parameter will not be used after
the version number (httpversion) is equal
or greater than 0400a.

autocleanup_maxage<Not recommended touse this>342 - User's Manual<positive integer> 6/6

To specify the expired days for automaticclean up.
* For forward compatibility reservations,but only group disk_i0_autocleanup iseffective.
* Not recommended to use this. Pleaserefers "autocleanup" group.
* This parameter will not be used after
the version number (httpversion) is equal
or greater than 0400a.

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

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

SECURITY(get/set)

DESCRIPTION

s<0~(m-1)>_home<W,H><product

1/6

ROI left-top corner coordinate.* If theminimal window size is 64x64, then thedependent>"win_i0_home"=(0~resolution_W-64,
0~resolution_H-64), which the resolution
is the value in current stream.
* If the stream doesn’t support ePTZ, thepermissions of this parameter must be
set as 1/7.

s<0~(m-1)>_size<WxH><product
dependent>

1/6

ROI width and height. The width value
must be multiples of 16 and the heightvalue must be multiples of 8
* The minimal window size is 64x64, andthen resolution_W, resolution_H is thevalue in current stream.
* If the stream doesn’t support ePTZ, thepermissions of this parameter must be
set as 1/7.

7.35 ePTZ SettingGroup: eptz_c<0~(n-1)> for n channel product. (capability_eptz > 0)
PARAMETERVALUE

SECURITY(get/set)

DESCRIPTION

osdzoom<Not recommended touse this><boolean>

1/4

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

smooth<boolean>

1/4

Enable the ePTZ "move smoothly"
featureUser's Manual - 343

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITYDESCRIPTION(get/set)tiltspeed-5 ~ 5

1/7

Tilt speed(It should be set by eCamCtrl.cgi rather
than by setparam.cgi.)

panspeed-5 ~ 5

1/7

Pan speed(It should be set by eCamCtrl.cgi rather
than by setparam.cgi.)

zoomspeed-5 ~ 5

1/7

Zoom speed(It should be set by eCamCtrl.cgi rather
than by setparam.cgi.)

autospeed

1~5

1/7

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

SECURITY(get/set)

DESCRIPTION

patrolseq

string[120]1/4

The patrol sequence of ePTZ. All thepatrol position indexes will be separated
by ","

patroldwelling

string[160]1/4

The dwelling time (unit: second) of eachpatrol 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>_pos<W,H><product
dependent>

1/7

Left-top corner coordinate of the preset.
(It should be set by ePreset.cgi rather

344 - User's Manual

than by setparam.cgi.)

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITYDESCRIPTION(get/set)preset_i<0~19>_size<WxH><product

1/7

Width and height of the preset.
(It should be set by ePreset.cgi rather

dependent>

than by setparam.cgi.)

7.36 Focus Window SettingGroup: focuswindow_c<0~(n-1)> for n channel productsn denotes the value of "capability_nvideoin".
(capability_image_c<0~(n-1)>_focuswindow_nwindow > 0)
PARAMETERVALUE

SECURITY(get/set)

DESCRIPTION

win_i0_enable<boolean>

4/4Enable or disable the window.

win_i0_home<W,H><product

4/4

Left-top corner coordinate of thewindow.

dependent>* If the minimal window size is 192x144,
then the"win_i0_home"=(0~resolution_W-192,
0~resolution_H-144), resolution_W andresolution_H based on"capability_image_c<0~(n-1)>_focuswindow_range" .

win_i0_size<WxH><product
dependent>

4/4

Width and height of the window.
* The minimal window size is 192x144,
and resolution_W and resolution_H isbased on "capability_image_c<0~(n-1)>_focuswindow_range" .

7.37 Seamless Recording Setting<Not recommended to use>
Group: seamlessrecording(capability_localstorage_seamless> 0)* We do not support this parameter when "capability_nvideoin > 1".
PARAMETERVALUE

SECURITY(get/set)

DESCRIPTION

User's Manual - 345

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)
diskmode

seamless,
1/6
manageable“seamless” indicates enable seamlessrecording.
“manageable” indicates disable seamlessrecording.
* 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 theversion number (httpversion) is equal or
greater than 0400a.

maxconnection

3

1/7

Maximum number of connected seamlessstreaming.
* We replace this parameter with“seamlessrecording_c<0~(n-1)>_maxconnecti
on” 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 theversion number (httpversion) is equal or
greater than 0400a.

enable<boolean>

1/7

Indicate whether seamless recording isrecording 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 theversion number (httpversion) is equal or
greater than 0400a.

346 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITYDESCRIPTION(get/set)
guid<0~2>_id

string[127]1/7

The 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 theversion number (httpversion) is equal or
greater than 0400a.

guid<0~2>_number

0~3

1/7

Number of connected seamless streamingwith 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 theversion 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 productsn denotes the value of "capability_nvideoin".
(capability_localstorage_seamless> 0)
PARAMETERVALUE

SECURITY DESCRIPTION(get/set)

User's Manual - 347

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

diskmode

seamless,

1/6

manageable“seamless” indicates enable seamlessrecording.
“manageable” indicates disable
seamless recording.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

maxconnection

3

1/7

Maximum number of connectedseamless streaming.
* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

triggerrecord<boolean>

1/7

Indicate whether seamless recording isrecording to local storage or not atpresent.
(Read only)* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

guid<0~(k-1)>_id

string[127]1/7

The connected seamless streaming ID.
(Read only)* k denotes the value of"seamlessrecording_c<0~(n-1)>_maxconnection"* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

guid<0~(k-1)>_number

348 - User's Manual

0~3

1/7

Number of connected seamlessstreaming with guid<0~(k-1)>_id.
(Read only)* k denotes the value of"seamlessrecording_c<0~(n-1)>_maxconnection"* We support this parameter when theversion number (httpversion) is equal or
greater than 0312a.

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

7.38 VIVOTEK Application Development Platform SettingGroup: vadp
NAME

VALUE

SECURITY DESCRIPTION(get/set)

version<string>

6/7

Indicate the VADP version.

resource_total_memory

0,<positive
integer>

6/7

Indicate total available memory size
for VADP modules.

resource_total_storage

0,<positive
integer>

6/7

Indicate total size of the internal
storage space for storing VADP
modules.

resource_free_memory

0,<positive

6/7

integer>

Indicate free memory size for VADP
modules.

resource_free_storage

0,<positive
integer>

6/7

Indicate current free storage size for
uploading VADP modules.

module_number

0,<positive
integer>

6/7

Record the total module number that
already stored in the system.

module_order

string[40]6/6The execution order of the enabledmodules.

module_save2sd<boolean>

6/6

Indicate if the module should besaved to SD card when user want to
upload it.
If the value is false, save module tothe internal storage space and it will
occupy storage size.

numberstring[128]6/7This number is used to register
license key for VADP application.

statusstring[40]6/7Indicate the hardware restore statusdeveloper_mode<Boolean>

6/6

Developer mode provide ways toestablish communication between
the developer of VADP vendor andyour camera.
* Only available whencapability_securecam_support=1.

7.38.1. VADP Settings for Each Hyperlink
Group: vadp_hyperlink_i<0~(n-1)>

User's Manual - 349

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

Maximum of n=10 hyperlink is supported.
NAME

VALUE

SECURITY DESCRIPTION(get/set)moduleidx

0,<positive

1/7

Refer to the package index.

integer>title

string[40]1/7Name of the vadp hyperlink.

urlstring[120]1/7

The URL address of vadp hyperlink.

statusstring[40]1/7

Value 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".
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

enable<boolean>

6/6

Indicate if the module is enabled ornot.
If yes, also add the index of this module
to the module_order.

namestring[40]6/6Module nameextendedname

string[40]6/6Extended module name. If this value is
not blank, it will be shown on the VADPUI first instead of
vadp_module_i<n>_name.

url

string[120]6/6

Define the URL string after the IP
address if the module provides it own
web page.

vendorstring[40]6/6The provider of the module.

vendorurl

string[120]6/6

URL of the vendor.

versionstring[40]6/6Version of the module.

licensestring[40]6/6Indicate the license status of themodule.

licmsgstring[128]6/6

Indicate the message that will be showon license status when mouse over.

path

string[40]6/6Record the storage path of the module.

350 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)initscrstring[40]6/6The script that will handle operationcommands from the system.

statusstring[40]6/6Indicate the running status of themodule.

statmsg

string[128]6/6

Indicate the message that will be showon the running status when mouseover.

vvtklicensemec

string[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")
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

enable<boolean>

6/6

Enable or disable the schedule mode tocontrol the execution of the VADP
package

begintime

hh:mm

6/6

Begin time of the schedule

endtime

hh:mm

6/6

End time of the schedule

7.38.4. VADP Event Settings
Group: vadp_event
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

ntrigger0,<positive
integer>

6/7

Indicate the number of topics to betransferred to event manager for
trigger.

triggerlist_i<0~(n-1)>_t
opic

string[256]6/6

Indicate the event notification with this
topic will be transferred to event
manager as trigger.
n is equal to ntrigger above.

User's Manual - 351

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

7.39 Camera PTZ Control
Group: camctrl (capability_camctrl_ptztunnel > 0)
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

enableptztunnel<boolean>

1/4

Enable 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"
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

panspeed-5 ~ 5

1/4

Pan speedtiltspeed-5 ~ 5

1/4

Tilt speed

zoomspeed-5 ~ 5

1/4

Zoom speed

focusspeed-5 ~ 5

1/4

Auto focus speed

patrolseq

string[120]1/4(For external device)
The indexes of patrol points, separated
by “,”

patroldwelling

string[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)>_dwelling

0 ~ 999

1/4

The dwelling time of each preset
location* only available whencapability_camctrl_c0_rs485=2

uart

0~"
capability_nuar
t"-1

1/4

Select corresponding uart(capability_nuart>0).
* only available whencapability_camctrl_c0_rs485=2

cameraid

0~255

1/4

Camera ID controlling external PTZ
camera.

isptz

0~2

1/4

0: disable PTZ commands.
1: enable PTZ commands with PTZ

352 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
driver.
2: enable PTZ commands with UART
tunnel.
* only available whencapability_camctrl_c0_rs485=2
disablemdonptz<boolean>

1/4

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

cameraid

0 ~ 255

1/4

Camera ID controlling external PTZ
camera.
Note:
Please set your speed dome to theappropriate baud rate, and Camera ID,
e.g. 2400bps, camera ID 1,2,3,,,,etc.
All Camera IDs on the same controllingsystem (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 ~ 5

1/4

Pan speedtiltspeed-5 ~ 5

1/4

Tilt speed

zoomspeed-5 ~ 5

1/4

Zoom speed

autospeed-5 ~ 5

1/4

Auto pan speed

focusspeed-5 ~ 5

1/4

Auto focus speed

focusmode

auto,onetimeau 1/4
to,spotlight,maIndicate the focus control mode.

User's Manual - 353

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)nual* Available
values arelisted in"capability_cam
ctrl_c<0~(n-1)>_focusmode"
uart

isptz

0~

1/4

Select corresponding uart"capability_nua(capability_nuart>0).

rt"-1* only available whencapability_camctrl_c0_rs485=2

0~2

1/4

0: 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)>_name string[40]preset_i<0~(k-1)>_zoom

1/4

capability_ptz_ 1/4
c<0~(n-1)>_min

Name of the preset location.
Zoom position at each preset location.

zoom ~
capability_ptz_
c<0~(n-1)>_ma
xzoom
preset_i<0~(k-1)>_focus

capability_ptz_ 1/4
c<0~(n-1)>_min
focus ~
capability_ptz_
c<0~(n-1)>_ma
xfocus

Focus position at each preset location.

preset_i<0~(k-1)>_dwelling

0 ~ 999

1/4

The dwelling time of each preset
location* only available whencapability_camctrl_c0_rs485=2

preset_i<0~(k-1)>_focus

sync,

1/4

The focus mode of each preset, which is354 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)setting

fixcurrent

essential and should be grouped with“preset_i<0~(k-1)>_name.”* We support this parameter when theversion number (httpversion) is equal
or greater than 0305b.

patrolseq

string[120]1/4(For external device)
The indexes of patrol points, separated
by “,”

patroldwelling

string[160]1/4(For external device)
The dwelling time of each patrol point,
separated by “,”* only available whencapability_camctrl_c0_rs485=2

disablemdonptz<boolean>

1/4

Disable motion detection on PTZ
operation.

defaulthome<boolean>

1/4This field tells system to use default
home position or not.

axisz

capability_ptz_ 1/4
c<0~(n-1)>_min

Custom home zoom position.

zoom ~
capability_ptz_
c<0~(n-1)>_ma
xzoom
axisf

capability_ptz_ 1/4
c<0~(n-1)>_min
focus ~
capability_ptz_
c<0~(n-1)>_ma
xfocusCustom home focus position.

digitalzoom<boolean>

1/4

Enable/disable digital zoom

zoomenhance<boolean>

1/4

Enable /disable zoom enhancement

returnhome<boolean>

1/4

Enable/disable return home while idle.

returnhomeinterval

1~999

1/4

While idle over this time interval, idle
action will be taken.

idleaction_enable<boolean>

1/4

Enable/disable idle action while idle

idleaction_type

home

1/4

This field tells what kind of action

User's Manual - 355

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)should be taken while idle.
idleaction_interval

1~999

1/4

While 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 thebit4 of capability_ptzenabled is 1)
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)

cameraid

1 ~ 255

1/4

Camera ID controlling external
PTZ camera.
Note:
Please set your speed dome tothe appropriate baud rate, andCamera 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 acontrolling signal, each camera
will only accept the inputs withthe corresponding ID.

panspeed-5 ~ 5

1/4

Pan speedtiltspeed-5 ~ 5

1/4

Tilt speed

zoomspeed-5 ~ 5

1/4

Zoom speed

autospeed-5 ~ 5

1/4

Auto pan speed

focusspeed-5 ~ 5

1/4

Auto focus speed

focusmode

auto,onetimeauto,sp
otlight,manual

1/4

Indicate the focus control mode.

356 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)* Available values arelisted in"capability_camctrl_c<0~(n-1)>_focusmode"preset_i<0~(k-1)>_name string[40]1/4Name of the preset location.

preset_i<0~(k-1)>_pan

1/4

Pan position at each preset
location.

1/4

Tilt position at each preset
location.

1/4

Zoom position at each preset
location.

1/4

Focus position at each preset

capability_ptz_c<0~(n-1)>_minpan ~capability_ptz_c<0~(n-1)>_maxpan

preset_i<0~(k-1)>_tilt

capability_ptz_c<0~(n-1)>_mintilt ~capability_ptz_c<0~(n-1)>_maxtilt

preset_i<0~(k-1)>_zoom

capability_ptz_c<0~(n-1)>_minzoom ~capability_ptz_c<0~(n-1)>_maxzoom

preset_i<0~(k-1)>_focus

capability_ptz_c<0~(n-1)>_minfocus ~capability_ptz_c<0~(n-1)>_maxfocus

preset_i<0~(k-1)>_focus
setting

location.

sync,
fixcurrent

1/4

The focus mode of each preset,
which is essential and should begrouped with“preset_i<0~(k-1)>_name.”* We support this parameter
when the version number(httpversion) is equal or greaterthan 0305b.

preset_i<0~(k-1)>_fliped <boolean>

1/4

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

0 ~ 999

1/4(For internal device)

dwelling

The dwelling time of each patrol
location

User's Manual - 357

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
disablemdonptz<boolean>

1/4

Disable motion detection on PTZ
operation.

defaulthome<boolean>

1/4This field tells system to use
default home position or not.

axisx

capability_ptz_c<0~(

1/4

Custom home pan position.

1/4

Custom home tilt position.

1/4

Custom home zoom position.

1/4

Custom home focus position.

n-1)>_minpan ~capability_ptz_c<0~(n-1)>_maxpan
axisy

capability_ptz_c<0~(n-1)>_mintilt ~capability_ptz_c<0~(n-1)>_maxtilt

axisz

capability_ptz_c<0~(n-1)>_minzoom ~capability_ptz_c<0~(n-1)>_maxzoom

axisf

capability_ptz_c<0~(n-1)>_minfocus ~capability_ptz_c<0~(n-1)>_maxfocus

axisflip<boolean>

1/4

Custom home flip side.

returnhome<boolean>

1/4

Enable/disable return home whileidle.

returnhomeinterval

1~999

1/4

While idle over this time interval,
idle action will be taken.

digitalzoom<boolean>

1/4

Enable/disable digital zoom

idleaction_enable<boolean>

1/4

Enable/disable idle action while
idle

idleaction_type

pan,patrol,tour,home,objtrack,prev

1/4This field tells what kind of action
should be taken while idle.

idleaction_interval

1~999

1/4

While idle over this time interval,
idle action will be taken.

zoomenhance<boolean>

1/4

Enable /disable zoom
enhancement

tour_index-1, 0~19

1/4

Index of the enabled tour group,from 0 to 19.

358 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
Set -1 to disable all the tour
groups.
tour_i<0~19>_namestring[40]1/4Name of the tour.

tour_i<0~19>_type<boolean>

1/4

0 = Recorded tour
1 = Preset tour

tour_i<0~19>_speed-5 ~ 5

1/4

Preset tour: pan and tilt speed
when moving between presets.
Recorded tour: unnecessary.

tour_i<0~19>_direction

forward,backward,ra
ndom

1/4

User can choose which direction
the preset tour goes.
"forward": preset tour goes inforward order.
"backward": preset tour goes inbackward 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 greaterthan 0307a.

tour_i<0~19>_checklist

string[512]1/4

The indexes of preset positions,separated by “,”

tour_i<0~19>_dwelltim
estring[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.

PLEASE REFER TO PTZ CONTROL API

7.42 UART Control
User's Manual - 359

VIVOTEK© 2020 VIVOTEK INC. All Right ReservedGroup: uart (capability_nuart > 0 and capability_fisheye = 0)
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

ptzdrivers_i<0~19,

string[40]1/4Name of the PTZ driver.

string[128]1/4Full path of the PTZ driver.

<boolean>

1/4

Enable HTTP tunnel channel to control

127>_nameptzdrivers_i<0~19,
127>_location
enablehttptunnel

UART.
Group: uart_i<0~(n-1)> n is uart port count (capability_nuart > 0 and capability_fisheye = 0)
NAME

VALUE

SECURITYDESCRIPTION(get/set)baudrate

300,600,1200,2400,

4/4

Set baud rate of COM port.

4800,9600,19200,38
400,57600,115200
databit

5,6,7,8

4/4

Data bits in a character frame.

paritybit

none,
odd,

4/4

For error checking.

4/4"1": One stop bit is transmitted toevenstopbit

1,2

indicate the end of a byte.
"2": Two stop bits are transmitted toindicate the end of a byte.
If you want to transfer the stopbit for
150% of the normal time used totransfer one bit, theuart_i<0~(n-1)>_stopbit should be set
as 2 and the uart_i<0~(n-1)>_databit
set as 5 as well.
uartmode

rs485,
rs232

4/4

RS485 or RS232.

customdrvcmd_i<0~9>string[128]1/4

PTZ 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

360 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
speedlink_i<0~4>_cmd

string[40]1/4Additional PTZ command list.
* only available whencapability_camctrl_c0_rs485=2

ptzdriver

0~19,

1/4

127 (custom),
128 (no driver)

The 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 ofcapability_ptzenabled is 0, the bit4 of capability_ptzenabled is 1)
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

cameraid

1~255

4/4

Camera ID controlling external PTZ
camera.
Note:
Please set your speed dome to theappropriate baud rate, and Camera ID,
e.g. 2400bps, camera ID 1,2,3,,,,etc.
All Camera IDs on the same controllingsystem (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.

baudrate

2400,4800,9600,19
200,38400,57600,1
15200

4/4

Set baud rate of COM port.

databit

5,6,7,8

4/4

Data bits in a character frame.

paritybit

none,
odd,
even

4/4

For error checking.

User's Manual - 361

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)
stopbit

1,2

4/4"1": One stop bit is transmitted toindicate the end of a byte.
"2": Two stop bits are transmitted toindicate the end of a byte.
If you want to transfer the stopbit for
150% of the normal time used totransfer one bit, theuart_i<0~(n-1)>_stopbit should be set
as 2 and the uart_i<0~(n-1)>_databit
set as 5 as well.

uartmode

rs485

4/7

RS485 mode.

7.44 Lens Configuration
Group: lens for n channel productsn denotes the value of "capability_nvideoin"(capability_image_c<0~(n-1)>_lensconfiguration_support = 1)
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

selected<string>

6/7

Current selected lens profile.
e.g. lens_selected=lens_default_i0, it
means choosen lens configuration is i0
lens of default group.

Group: lens_default
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

totalnumbers

0,<positive
integer>

6/7

Totoal support number of the default
lens profiles

NAME

VALUE

SECURITY(get/set)

DESCRIPTION

totalnumbers

0,<positive
integer>

6/7

Totoal support number of the user lensprofilesGroup: lens_user

362 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right ReservedGroup: lens_default_i<0~(n-1)>
n denotes the value of "lens_default_totalnumbers"
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

name<string>

6/7

Default lens nameGroup: lens_user_i<0~(n-1)>
n denotes the value of "lens_user_totalnumbers"
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

name<string>

6/7

User-defined lens name7.45 Fisheye Info.
Group: fisheyeinfo (capability_fisheye > 0)
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

revisedcenteraxis<coordinate>

1/7

The actual center axis coordinate

radius0, <positive
integer>

1/7

The actual center radius

7.46 Fisheye Local Dewarp SettingGroup: 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"
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

panspeed-5 ~ 5

1/4

Pan speed of regional viewtiltspeed-5 ~ 5

1/4

Tilt speed of regional view

zoomspeed-5 ~ 5

1/4

Zoom speed of regionals<0~(m-2)>_panora
ma_panstart

0~359

1/4

Initial pan position of panorama view.
(only available for 1P and 2P mode atceiling or floor mount)s<0~(m-2)>_region_pan-90~359

1/4

Pan home angle of regional view (for1R mode)Pan range of ceiling/floor mount is[0~359].
Pan range of wall mount is [-90~90].

User's Manual - 363

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

NAME

VALUE

SECURITYDESCRIPTION(get/set)s<0~(m-2)>_region_t -90~90
ilt

1/4

Tilt home angle of regional view (for1R mode)Tilt range of ceiling/floor mount is[0~90].
Tilt range of wall mount is [-90~90].

s<0~(m-2)>_region_zoom

100~300

1/4

Zoom home ratio of regional view (for1R mode)s<0~(m-2)>_region_r -90~359

1/4

Pan home angle of regional view (for<0~(i-1)>_pan

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

1/4<0~(i-1)>_tilt

Tilt home angle of regional view (for4R 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 100~300

1/4<0~(i-1)>_zoom

Zoom home ratio of regional view (for4R mode, i is the view index and range
from 0 to 3)

7.47 PIR Behavior DefineGroup: pir (capability_npir > 0)
NAME

VALUE

SECURITY(get/set)

DESCRIPTION

enable<boolean>

1/1

Enable/disable PIR

7.48 Auto Tracking SettingGroup: autotrack_c<0~(n-1)> (capability_image_c<0~(n-1)>_autotrack_support > 0)n denotes the value of "capability_nvideoin"

364 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

SECURITYDESCRIPTION(get/set)objsize_type

-1~2

1/4

Type of object size.
-1 : customized width and height0 : object size = 30 x 30
1 : object size = 10 x 20
2 : object size = 10 x 10

objsize_customized_w 10~320
idth

1/4

The minimum width of tracking target.

objsize_customized_h 10~240

1/4

The minimum height of tracking target.

1/4

Tracking sensitivity.

eight
sensitivity

0~2

0: Low
1: Medium
2: High

7.49 WirelessGroup: wireless (capability_network_wireless > 0)
PARAMETERVALUE

SECURITY(get/set)

DESCRIPTION

ssid

string[32]6/6SSID for wireless lan settings.

wlmodeInfra,
Adhoc

6/6

Wireless mode.
Infra: Infrastructurechannel

1~11 or

6/6

A list of WLAN channels.

1~13 or
10~11 or
10~13 or
1~14

Countries apply their own regulations
to the allowable channels.
1~11: USA and Canada
1~13: Europe
10~11: Spain
10~13: France
1~14: Japan* Only valid when "wireless_wlmode"is "Adhoc"

User's Manual - 365

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)
encrypt

authmode

none,
wep,

6/6

Encryption method:
none: NONE,

wpa,

wep: WEP,

wpa2

wpa: WPA,
wpa2: WPA2PSKOPEN, SHARED

6/6

Authentication mode.
* Only valid when "wireless_encrypt" is"wep"keylength64, 128

6/6

Key length in bits.
* Only valid when "wireless_encrypt" is"wep"

keyformat

HEX, ASCII

6/6

Key1 ~ key4 presentation format.
* Only valid when "wireless_encrypt" is"wep"keyselect

1~4

6/6

Default key number.
* Only valid when "wireless_encrypt" is
"wep"

key1

password [26]6/6

WEP key1 for encryption.
* Only valid when "wireless_encrypt" is
"wep"

key2

password [26]6/6

WEP key2 for encryption.
* Only valid when "wireless_encrypt" is
"wep"

key3

password [26]6/6

WEP key3 for encryption.
* Only valid when "wireless_encrypt" is
"wep"

key4

password [26]6/6

WEP key4 for encryption.
* Only valid when "wireless_encrypt" is"wep"algorithm

AES, TKIP

6/6

Algorithm* Only valid when "wireless_encrypt" is"wpa" or "wpa2"

presharedkey

password [64]6/6

WPA/WPA2PSK mode pre-shared key.
* Only valid when "wireless_encrypt" is"wpa" or "wpa2"

366 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

7.50 Shock Detection
Group: shock_c<0~(n-1)> for n channel productsn denotes the value of "capability_nvideoin" (capability_shockalarm_support > 0)
PARAMETERVALUE

SECURITY(get/set)

DESCRIPTION

alarm_enable<boolean>

4/4Enable shock detection's alarm.

alarm_level

1~100

4/4

The value indicate the support strength
level of shock detection's alarm.

7.51

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

SECURITY(get/set)

DESCRIPTION

profilename<string>

1/6

Friendly name of the profile.

token<string>

1/7

An unique identifier of the profile.

fixed<boolean>

1/7

The value indicates whether the profile
can be deleted or not.
Ex. fixed=1 indicates the profile cannot
be deleted.

occupied<boolean>

1/6

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

alwaysmulticast<boolean>

1/6

Enable always multicast.

videoconfiguration_en <boolean>
able

1/6

To enable the selectedvideoconfiguration source for thisprofile.

User's Manual - 367

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

SECURITYDESCRIPTION(get/set)videoconfiguration_so c<0~(n-1)>s<0~(m-1) 1/6
urce>* n denotes the valueof“capability_nvideoin,
and m denotes the

The videoconfiguration source for the
profile.
Ex. videoconfiguration_source=c<0~(n-1)>s<0~(m-1)> indicates video
stream of channel n stream m isselected for the profile.

value of“capability_nmediastr
eam”
audioconfiguration_en <boolean>
able

1/6

To enable the selectedaudioconfiguration source for thisprofile.
* Only available whencapability_naudioin > 0

audioconfiguration_so c<0~(n-1)>s0
urce

1/6

The audioconfiguration source for the
profile.

* n denotes the valueof

Ex. audioconfiguration_source=c<0~(n-1)>s0 indicates audio stream of"capability_naudioin"

channel n and stream 1 is selected forthe profile.
* Only available whencapability_naudioin > 0

metadataconfiguratio <boolean>
n_enable

1/6

To enable the selected
metadataconfiguration source for the
profile.

metadataconfiguratio c<0~(n-1)>s0
1/6
n_source* n denotes the valueof"capability_nvideoin"

The metadataconfiguration source forthe profile
Ex. metadataconfiguration_source=c<0~(n-1)>s0 indicates metadata
stream of channel n and stream 1 isselected for the profile.

7.52 Multicast Settings for Metadata Streaming
368 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right ReservedGroup: 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

ipaddress<ip address>

4/4

Multicast metadata IP address.

port1025 ~ 65535

4/4

Multicast metadata port.

ipversion

IPv4, IPv6

4/4

The version of internet protocol.

ttl

1 ~ 255

4/4

Multicast metadata time to live value.

User's Manual - 369

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

8. Useful Functions
8.1 Drive the Digital Output (capability_ndo > 0)
Note: This request requires Viewer privileges.
Method: GET/POST
Syntax:
http://<servername>/cgi-bin/dido/setdo.cgi?do1=<value> [&do2=<value>][&do3=<value>][&do4=<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.
PARAMETERVALUE

DESCRIPTION

do<num>state[trigger time]

Ex: do1=1
Setting digital output 1 to trigger state.

Where "state" is 0, 1. Ex: do1=0[30]“0” means inactive or Setting digital output 1 to normal state, waiting 30
normal state whileseconds, setting it to trigger state.
“1” means active or
triggered state.
Where "trigger time"is reset time afterstate change.
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?do1=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.

370 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

Return:HTTP/1.0 200 OK\r\nContent-Type: text/plain\r\nContent-Length: <length>\r\n\r\n[di0=<state>]\r\n[di1=<state>]\r\n[di2=<state>]\r\n[di3=<state>]\r\nwhere <state> can be 0 or 1.
Example: Query the status of digital input 1 .
Request:http://myserver/cgi-bin/dido/getdi.cgi?di1
Response:
HTTP/1.0 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 7\r\n\r\ndi1=1\r\n8.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\nContent-Type: text/plain\r\nContent-Length: <length>\r\n\r\n[do0=<state>]\r\nUser's Manual - 371

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved[do1=<state>]\r\n[do2=<state>]\r\n[do3=<state>]\r\nwhere <state> can be 0 or 1.
Example: Query the status of digital output 1.
Request:http://myserver/cgi-bin/dido/getdo.cgi?do1
Response:
HTTP/1.0 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 7\r\n\r\ndo1=1\r\n8.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.
PARAMETER VALUEDESCRIPTION

channelThe channel number of the video
source.

0~(capability_nvideoin -1)

Default: 0
resolution

Available options are list in"capability_videoin_c<0~(n-1)>_resolution".

The resolution of the image.

Default: Returns snapshot of current
Besides, available options is referred toresolution by [channel] and"capability_videoin_c<0~(n-1)>_maxresolution [streamid].
" and"capability_videoin_c<0~(n-1)>_minresolution"

372 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETER VALUEDESCRIPTION

quality

1~5

The quality of the image.

streamid0~( capability_nmediastream -1)

The stream number.
Default: Returns snapshot of
maxmum 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\nContent-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=<name>[&userpass=<value>][&privilege=<value>][&return=<return
page>]PARAMETERVALUE

DESCRIPTION

methodadd

Add an account to the server. When using this method,
the“username” field is necessary. It will use the default
value of other fields if not specified.

deleteRemove an account from the server. When using thismethod, the “username” field is necessary, and others are
ignored.

edit

Modify the account password and privilege. When using
this method, the“username” field is necessary, and otherfields are optional. If not specified, it will keep the original
settings.

User's Manual - 373

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

DESCRIPTION

username<name>The name of the user to add, delete, or edit.

userpass<value>The password of the new user to add or that of the olduser to modify. The default value is an empty string.

privilegeview

The privilege of the user to add or to modify.

operator“view”: Viewer privilege.
“operator”: Operator privilege.

admin
return<return page>“admin”: Administrator privilege.
Redirect to the page <return page> after the parameter isassigned. The <return page> should be the relative pathaccording to the root of camera. If you omit thisparameter, it will redirect to an empty page.
* If the <return page> is invalid path, it will ignore thisparameter.

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&privi
lege=viewResponse of success:
HTTP/1.1 200 OK\r\nContent-Type: text/html\r\nContent-Length: 2\r\n\r\nResponse 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!

374 - User's Manual© 2020 VIVOTEK INC. All Right Reserved

VIVOTEKERROR: 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 <file name> to upgradethe firmware and return with <return
page> if indicated.

User's Manual - 375

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

8.7 ePTZ 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 specificarea[&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=5376 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reservedb. 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&r
esolution=1920x1080
PARAMETERVALUE

DESCRIPTION

channel<0~(n-1)>

Channel of video source.

stream<0~(m-1)>

Stream.

move

home

Move to home ROI.

up

Move up.

down

Move down.

leftMove left.

rightMove right.

panAuto pan.

patrolAuto patrol.

stop

Stop auto pan/patrol.

wide

Zoom larger view with current speed.

tele

Zoom further with current speed.

zoomingwide or tele

Zoom without stopping for larger view or further view withzs speed, used for joystick control.

zs

0~6

Set the speed of zooming, “0” means stop.

x<integer>

The desired coordinate, and it will be the center after

auto

zoom

User's Manual - 377

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

DESCRIPTIONy<integer>movementw<integer>

The scaled area sizeh<integer>

resolution<window size>

The resolution of streaming.

vx<integer>

The direction of movement, used for joystick control.

vy<integer>vs

0~7

Set the speed of movement, “0” means stop.

x<integer>x-coordinate clicked by user.
It will be the x-coordinate of center after movement.

y<integer>y-coordinate clicked by user.
It will be the y-coordinate of center after movement.

videosize<window size>

The size of plug-in (ActiveX)window in web page

resolution<window size>

The resolution of streaming.

stretch<boolean>

0 indicates that it usesresolution(streaming size) as therange of the coordinate system.
1 indicates that it usesvideosize(plug-in size) as the rangeof the coordinate system.

speedpan-5 ~ 5

Set the pan speed.

speedtilt-5 ~ 5

Set the tilt speed.

speedzoom-5 ~ 5

Set the zoom speed.

speedapp

1~5

Set the auto pan/patrol speed.

return<return page>

Redirect to the page <return page> after the parameter isassigned. The <return page> should be the relative pathaccording to the root of camera. If you omit thisparameter, it will redirect to an empty page.
* If the <return page> is invalid path, it will ignore thisparameter.

378 - User's Manual© 2020 VIVOTEK INC. All Right Reserved

VIVOTEK

8.8 ePTZ Recall (capability_eptz > 0 and capability_fisheye = 0)
Note: This request requires camctrl privileges.
Method: GET/POST
Syntax:
http://<servername>/cgi-bin/camctrl/eRecall.cgi?channel=<value>&stream=<value>&recall=<value>[&return=<return page>]
PARAMETERVALUE

DESCRIPTION

channel<0~(n-1)>

Channel of the video source.

stream<0~(m-1)>

Stream.

recallText string less than

One of the present positions to recall.

40 characters
return<return page>

Redirect to the page <return page> after the parameter isassigned. The <return page> should be the relative pathaccording to the root of camera. If you omit thisparameter, it will redirect to an empty page.
* If the <return page> is invalid path, it will ignore thisparameter.

8.9 ePTZ Preset Locations (capability_eptz > 0 andcapability_fisheye = 0)
Note: This request requires Operator privileges.
Method: GET/POST
Syntax:
http://<servername>/cgi-bin/operator/ePreset.cgi?channel=<value>&stream=<value>[&addpos=<value>][&delpos=<value>][&return=<return page>]
PARAMETERVALUE

DESCRIPTION

channel<0~(n-1)>

Channel of the video source.

stream<0~(m-1)>

Stream.

User's Manual - 379

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

DESCRIPTION

addpos<Text string less than Add one preset location to the preset list.
40 characters>delpos<Text string less than Delete preset location from the preset list.
40 characters>

return<return page>

Redirect to the page <return page> after the parameter isassigned. The <return page> should be the relative pathaccording to the root of camera. If you omit thisparameter, it will redirect to an empty page.
* If the <return page> is invalid path, it will ignore thisparameter.

8.10 IP Filtering for ONVIF
Syntax:<product dependent>
http://<servername>/cgi-bin/admin/ipfilter.cgi?type[=<value>]
http://<servername>/cgi-bin/admin/ipfilter.cgi?method=add<v4/v6>&ip=<ipaddress>[&index=<value>][&return=<return page>]
http://<servername>/cgi-bin/admin/ipfilter.cgi?method=del<v4/v6>&index=<value>[&return=<retu
rn page>]
PARAMETERVALUE

DESCRIPTION

type

NULL

Get IP filter typeallow, deny

Set IP filter typeaddv4

Add IPv4 address into access list.

addv6

Add IPv6 address into access list.

delv4

Delete IPv4 address from access list.

delv6

Delete IPv6 address from access list.

ip<IP address>

Single address: <IP address>
Network address: <IP address / network mask>
Range address:<start IP address - end IP address>

index<value>The start position to add or to delete.

method8.11 UART HTTP Tunnel Channel (capability_nuart > 0)
Note: This request requires Operator privileges.
Method: GET and POST
380 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

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-tunnelledpragma: no-cache
cache-control: no-cache------------------------------------------------------------------------POST /cgi-bin/operator/uartchannel.cgi
x-sessioncookie: string[22]content-type: application/x-vvtk-tunnelledpragma : 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
PARAMETERVALUE

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

User's Manual - 381

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved------------------------------------------------------------------------GET /cgi-bin/admin/ctrlevent.cgi
x-sessioncookie: string[22]accept: application/x-vvtk-tunnelledpragma: no-cache
cache-control: no-cache------------------------------------------------------------------------POST /cgi-bin/admin/ ctrlevent.cgi
x-sessioncookie: string[22]content-type: application/x-vvtk-tunnelledpragma : 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

382 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

network_rtsp_s2_accessname = live2s1.sdp
network_rtsp_s3_accessname = live2s2.sdp
etc.
* Note: RTSP access name format is modified to “live<n>s<m>.sdp” after version
number(httpversion) is 0311c.
Please refer to the “subgroup of network: rtsp” for setting the accessname of SDP.
You can get the SDP by HTTP GET.
When using scalable multicast, Get SDP file which contains the multicast information via HTTP.

8.14 Open the Network Stream
Note: This request requires Viewer access privileges.
Syntax:For HTTP push server (MJPEG):
http://<servername>/<network_http_s<0~m-1>_accessname>
For RTSP (MP4), the user needs to input 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>]
PARAMETERVALUE

DESCRIPTIONcom

1 ~ <max. com port
number>

The target COM/RS485 port number.

User's Manual - 383

VIVOTEK

data© 2020 VIVOTEK INC. All Right Reserved<hex decimal

The <hex decimal data> is a series of digits from 0 ~ 9, A ~data>[,<hex decimal F. Each comma separates the commands by 200
data>]
milliseconds.
flush

yes,noyes: Receive data buffer of the COM port will be cleared
before read.
no: Do not clear the receive data buffer.

wait

1 ~ 65535

Wait time in milliseconds before read data.

read

1 ~ 128

The data length in bytes to read. The read data will be in
the return page.

Return:HTTP/1.0 200 OK\r\nContent-Type: text/plain\r\nContent-Length: <system information length>\r\n\r\n<hex decimal data>\r\nWhere 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.
PARAMETERVALUE

DESCRIPTION

cmd_type<string>

Required.
Command to be executed, including search andqueryStatus.

384 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

Command: search
PARAMETERVALUE

DESCRIPTION

label<integer primary key> Optional.
The integer primary key column will automatically be
assigned a unique integer.

triggerType<text>

Optional.
Indicate the event trigger type.
Please embrace your input value with single quotes.
Ex. triggerType=’vi’

mediaType<text>

Optional.
Indicate the file media type.
Ex. mediaType=videoclip* logical “OR” is not supported for this parameter.

destPath<text>

Optional.
Indicate the file location in camera.
Please embrace your input value with single quotes.
Ex. destPath =’/mnt/auto/CF/NCMF/abc.mp4’

resolution<text>

Optional.
Indicate the media file resolution.
Please embrace your input value with single quotes.
Ex. resolution=’800x600’

isLocked<boolean>

Optional.
Indicate if the file is locked or not.
0: file is not locked.
1: file is locked.
A locked file would not be removed from UI or cyclic
storage.

triggerTime<text>

Optional.
Indicate the event trigger time. (not the file createdtime)
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 1st2008 to the end of Jan 1st 2008.

User's Manual - 385

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

DESCRIPTION

limit<positive integer>

Optional.
Limit the maximum number of returned search records.

offset<positive integer>

Optional.
Specifies how many rows to skip at the beginning of thematched 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
PARAMETERVALUE

DESCRIPTION

retTypexml or javascript

Optional.
Ex. retype=javascript
The default return message is in XML format.

Ex. Query local storage status and call for javascript format return message.
http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=queryStatus&retType=javascript

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

VALUE

vi<num>state[(duration)nstate]
Ex: vi0=1
Where "state" is 0, 1. “0” Setting virtual input 0 to trigger statemeans inactive or normal

386 - User's Manual

DESCRIPTIONVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETER

returnVALUE

DESCRIPTION

state while “1” means
active or triggered state.
Where "nstate" is next
state after duration.

Ex: vi0=0(200)1
Setting virtual input 0 to normal state, waiting 200
milliseconds, setting it to trigger state.
Note that when the virtual input is waiting for next
state, it cannot accept new requests.

<return page>

Redirect to the page <return page> after theparameter is assigned. The <return page> shouldbe the relative path according to the root ofcamera. If you omit this parameter, it will redirect
to an empty page.
* If the <return page> is invalid path, it will ignore
this parameter.

Return CodeDescription

200

The request is successfully executed.

400

The request cannot be assigned, ex. incorrect parameters.
Examples:setvi.cgi?vi0=0(10000)1(15000)0(20000)1
No multiple duration.
setvi.cgi?vi3=0
VI index is out of range.
setvi.cgi?vi=1
No VI index is specified.

503

The resource is unavailable, ex. Virtual input is waiting for next state.
Examples:setvi.cgi?vi0=0(15000)1
setvi.cgi?vi0=1
Request 2 will not be accepted during the execution time(15 seconds).

8.18 Open Timeshift Stream (capability_timeshift > 0,timeshift_enable=1, timeshift_c<n>_s<m>_allow=1)
Note: This request requires Viewer access privileges.
Syntax:For HTTP push server (MJPEG):

User's Manual - 387

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

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>&refti
me=<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.
PARAMETERVALUE

DEFAULTDESCRIPTION

maxsft<positive

0

Request cached stream at most how many seconds

integer>tsmodenormal,adaptiveago.
The value must be a positive integer. (>0)
normalStreaming mode:
normal => Full FPS all the time.
adaptive => Default send only I-frame for MP4 andH.264, and send 1 FPS for MJPEG. If DI or motion
window are triggered, the streaming is changed tosend full FPS for 10 seconds.
(*Note: this parameter also works on non-timeshift
streams.)tsmode must exactly match well-defined wording(normal, adaptive), unknown parameters are always
ignored.

reftimemm:ss

The time
camerareceives therequest.

Reference time for maxsft and minsft.
(This provides more precise time control to eliminate
the inaccuracy due to network latency.)
Ex: Request the streaming from 12:20
rtsp://10.0.0.1/live.sdp?maxsft=10&reftime=12:30

forcechk

N/A

N/A

Check if the requested stream enables timeshift,feature and if minsft is achievable.
If false, return “415 Unsupported Media Type”.

minsft<positive
integer>0

How many seconds of cached stream client can
accept at least.
(Used by forcechk)
The value must be a positive integer. (>0)

388 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

Return CodeDescription

400 Bad Request

Request is rejected because some parameter values are illegal.

415 Unsupported Media Type

Returned, if forcechk appears,when minsft is not achievable or
the timeshift feature of the target stream is not enabled.

8.19 RemoteFocus(capability_image_c<0~(n-1)>_remotefocus=1)
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 VALUEDESCRIPTION

channel0~"capability_nvideoin"-1 Channel of the video source.

functionzoom,
focus,

zoom - Move focus motor
focus – Move focus motor

auto,
scan,
stop,
positioning,
irisopen,
irisenable

auto – Perform auto focus
scan – Perform focus scanstop – 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.

direct,forward,backward

Motor’s moving direction.
It works only if function=zoom or function=focus.

direction

User's Manual - 389

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETER VALUEDESCRIPTION

position

Motor’s position.
It works only if function=zoom or function= focus and<motor_start> ~<motor_end>

direction=direct.
<motor_start> : remote_focus_zoom_motor_start or
remote_focus_focus_motor_start,<motor_end> : remote_focus_zoom_motor_end or
remote_focus_focus_motor_end replied from"function=getstatus"
steps

1 ~ 30Motor’s moving steps.
It works only if function=zoom or function=focus anddirection=forward and direction=backward.
* Motor will stop when it reaches to <motor_start> or<motor_end>.
* This parameter is for additional fine-tune, the value isfrom 1 to 30.

iris

N/A

Open iris or not.
It works only if function=auto or function=scan.

Syntax: (for query API)
http://<servername>/cgi-bin/admin/remotefocus.cgi?channel=<value>&[function=<value>]390 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

function

getstatus

Information of motors, return value as below:
remote_focus_zoom_motor_max: Maximum steps of zoom
motor
remote_focus_focus_motor_max: Maximum steps of focus
motor
remote_focus_zoom_motor_start: Start point of zoom motor
remote_focus_zoom_motor_end: End point of zoom motor
remote_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 motor
remote_focus_focus_motor: Current position of focus motor
remote_focus_zoom_enable: Current function of zoom motor
remote_focus_focus_enable: Current function of focus motor
remote_focus_iris_open: The current status of iris. 0: irisenable,
1: irisopen
Current function of zoom/focus motor, return value as below:
0: no service
1: zooming
2. focusing
3: auto focus
4: focus scan
5: 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]
PARAMETERVALUE

DESCRIPTION

channel0~"capability_nvideoin"-1 Channel of the video source.

User's Manual - 391

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

DESCRIPTION

function

focus,
auto,

focus – Move focus motor
auto – Perform auto focus

scan,

scan – Perform focus scanstop,
positioning,stop – Stop current operation
positioning – Position the motors

irisopen,

resetfocus – reset focus position to default

irisenable,
resetfocus

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.

direction

position

direct,Motor’s moving direction.

forward,backward

It works only if function= focus.

<motor_start> ~<motor_end>

Motor’s position.
It works only if function=focus and direction=direct.
<motor_start> : remote_focus_zoom_motor_start or
remote_focus_focus_motor_start,<motor_end> : remote_focus_zoom_motor_end or
remote_focus_focus_motor_end replied from"function=getstatus"

steps

1 ~ 30Motor’s moving steps.
It works only if function=focus and direction=forward or
direction=backward.
* Motor will stop when it reaches to <motor_start> or<motor_end>.
* 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://<servername>/cgi-bin/admin/remotefocus.cgi?channel=<value>&[function=<value>]392 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

function

getstatus

Information of motors, return value as below:
remote_focus_focus_motor_max: Maximum steps offocus motor
remote_focus_focus_motor_start: Start point ofeffective focal length
remote_focus_focus_motor_end: End point of effective
focal length
remote_focus_focus_motor: Current position of focus
motor
remote_focus_focus_enable: Current function of focus
motor
remote_focus_iris_open: The current status of iris. 0:
irisenable, 1: irisopen
Current function of zoom/focus motor, return value as
below:
0: no service
1: zooming
2. focusing
3: auto focus
4: focus scan
5: 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://<servername>/cgi-bin/admin/exportDst.cgi
For language file:
http://<servername>/cgi-bin/admin/export_language.cgi?currentlanguage=<value>
PARAMETERVALUE

DESCRIPTION

User's Manual - 393

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

currentlanguage 0~20

Available language lists.
Please refer to:system_info_language_i0 ~ system_info_language_i19.

For setting backup file:
http://<servername>/cgi-bin/admin/export_backup.cgi?backup

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

394 - User's Manual© 2020 VIVOTEK INC. All Right Reserved

VIVOTEK

Server will accept the file named <file name> 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>
PARAMETERVALUE

DESCRIPTION

value<string>

Available lens name.
Please refer to:lens_default_i<0~(n-1)>_namelens_user_i<0~(n-1)>_namen is a positive integer.

Method: POST
Syntax:User's Manual - 395

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

For upload user-defined lens configuration:
http://<servername>/cgi-bin/admin/update_lens.cgi?upload_lensPost data:
upload_lens_profile_input = <file name>\r\n\r\n<multipart encoded form data>
Server will accept the file named <file name> to upload the lens profile to camera.

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>]
PARAMETER VALUEDEFAULTDESCRIPTION

stime<YYYYMMDD_HHMMSS.MMM> N/A

Start time.

etime<YYYYMMDD_HHMMSS.MMM> N/A

End time.

length<positive integer>

The length of media of interest.

N/A

The unit is second.
loctime<boolean>0Specify if start/end time is local time
format.
1 for local time, 0 for UTC+0

file<string>

N/A

The media file to be played.

tsmode<positive integer>

N/A

Timeshift mode, the unit is second.

Ex.
stime

etime

lengthfile

Description

V

V

X

X

Play recordings between stime and etime
rtsp://10.10.1.2/mod.sdp?stime=20110312_040400.000&etime=2011_0312_040
510.000

V

X

V

X

Play recordings for length seconds which start fromstime
rtsp://10.10.1.2/mod.sdp?stime=20110312_040400.000&length=120

396 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

X

V

V

X

Play recordings for length seconds which ends at
etime
rtsp://10.10.1.2/mod.sdp?etime=20110312_040400.000&length=120

X

X

X

V

Play file filertsp://10.10.1.2/mod.sdp?filename=/mnt/link0/

User's Manual - 397

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

8.25 3D Privacy Mask
(Capability_image_c<0~(n-1)>_privacymask_wintype =3Drectangle)
n denotes the value of "capability_nvideoin"
Note: This request requires admin user privilege
Method: GET/POST
Syntax:
http://<servername>/cgi-bin/admin/setpm3d.cgi?method=<value>&maskname=<value>&[maskhei
ght=<value>&maskwidth=<value>&videosize=<value>&return=<return page>]
PARAMETERVALUE

DESCRIPTION

methodadd

Add a 3D privacy mask at current location

deleteDelete a 3D privacy mask

edit

Edit a 3D privacy mask

maskname

string[40]3D privacy mask namemaskheight

integer

3D privacy mask heightmaskwidth

integer

3D privacy mask width

videosize<window size>

Optimal.
The size of plug-in (ActiveX) window in web page is thesize of the privacy window size. This field is notnecessary, it will use the default value if not specified.
320x180 for 16:9 resolution and 320x240 for 4:3
resolution.

return398 - User's Manual<return page>

Redirect to the page <return page> after the parameteris assigned. The <return page> should be the relative
path according to the root of camera. If you omit thisparameter, it will redirect to an empty page.
* If the <return page> is invalid path, it will ignore thisparameter.

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

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>][&speedl
ink=<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=704x
480&videosize=704x480&strech=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 greaterthan 5.0.0.20.
http://myserver/cgi-bin/camctrl/camctrl.cgi?name=xxx&focussetting=sync&cam=getsetpreset
PARAMETERVALUE

DESCRIPTION

channel<0~(n-1)>

Channel of video source.

camid

0,<positive integer>

Camera ID.

move

home

Move to camera to home position.

up

Move camera up.

User's Manual - 399

VIVOTEKPARAMETER© 2020 VIVOTEK INC. All Right Reserved

VALUE

DESCRIPTION

down

Move camera down.

leftMove camera left.

rightMove camera right.

speedpan-5 ~ 5

Set the pan speed.

speedtilt-5 ~ 5

Set the tilt speed.

speedzoom-5 ~ 5

Set the zoom speed.

speedfocus-5 ~ 5

Set the focus speed.

speedapp-5 ~ 5

Set the auto pan/patrol speed.

auto

pan

Auto pan.

patrolAuto patrol.

stop

Stop camera.

wide

Zoom larger view with current speed.

tele

Zoom further with current speed.

stop

Stop zoom.

zoomingwide or tele

Zoom without stopping for larger view or further view withzs speed, used for joystick control.

zs

0~8

Set the speed of zooming, “0” means stop.

vx<integer , excluding

zoom<SD8362>

The slope of movement = vy/vx, used for joystick control.

0>vy<integer>vs0 ~ 127

Set the speed of movement, “0” means stop.

x<integer>x-coordinate clicked by user.
It will be the x-coordinate of center after movement.

y<integer>y-coordinate clicked by user.
It will be the y-coordinate of center after movement.

videosize<window size>

The size of plug-in (ActiveX) window in web page

resolution<window size>

The resolution of streaming.

stretch<boolean>

0 indicates that it uses resolution (streaming size) as therange of the coordinate system.
1 indicates that it uses videosize (plug-in size) as the rangeof the coordinate system.

400 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

DESCRIPTION

focus

auto

Auto focus.

far

Focus on further distance.

near

Focus on closer distance.

sync

Applies the selected focus mode infocusseting

camctrl_c<0~(n-1)>_focusmode to this preset.
fixcurrent

Applies the current focus position to this preset.

* We support this function when the version number of the PTZ control module isequal or greater than 5.0.0.20.
cam

getsetpreset

Adds a named preset at current position, and return thepreset 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\nCache-control: no-cache\r\nPragma: no-cache\r\n\r\npan=4117\r\nPARAMETERVALUE

DESCRIPTION

getversion<string>

Get the version of the PTZ control module.

getaction

idle,
autopan,tracking,
tour,

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

patrol,getpan0, <positive integer> Get the current pan position.
*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"

User's Manual - 401

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

DESCRIPTION

getpanangle<integer>Get the current pan angle.
*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"gettilt

0, <positive integer> Get the current tilt position.
*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"gettiltangle<integer>Get the current tilt angle.
*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"

getzoom

0, <positive integer> Get the current zoom position.

getratio<decimal>getfocus

0, <positive integer> Get the current focus position.

getminspeedlv

0, <positive integer> Get the minimum speed level of the PTZ control. Normally,
the speed level is ‘0,’ which denotes halting a continuous
movement.

Get the current zoom ratio.

getmaxptspeedlv 0, <positive integer> Get the maximum speed level of pan/tilt moving.
*Only available when"capability_camctrl_c<0~(n-1)>_buildinpt" > 0getmaxzspeedlv 0, <positive integer> Get the maximum speed level of zoom moving.
getmaxfspeedlv 0, <positive integer> Get the maximum speed level of focus moving.
getminpan

0, <positive integer> Get the lower limit for pan position.
*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"getmaxpan

0, <positive integer> Get the upper limit for pan position.
*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"

getminpanangle <integer>

Get the lower limit for pan angle.
*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"getmaxpanangle <integer>

Get the upper limit for pan angle.
*Only available when bit0 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"

getmintilt

0, <positive integer> Get the lower limit for tilt position.
*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"getmaxtilt

0, <positive integer> Get the upper limit for tilt position.
*Only available when bit1 of

402 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

DESCRIPTION"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"

getmintiltangle<integer>Get the lower limit for tilt angle.
*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"getmaxtiltangle <integer>

Get the upper limit for tilt angle.
*Only available when bit1 of"capability_camctrl_c<0~(n-1)>_buildinpt" is "1"

getminzoom

0, <positive integer> Get the lower limit for zoom position.

getmaxzoom

0, <positive integer> Get the upper limit for zoom position.

getmaxdzoom

0, <positive integer> Get the upper limit for digital zoom position.

getmaxratio<decimal>Get the maximum ratio of optical zoom.
* We support this parameter when the version number(getversion) is equal or greater than 5.0.0.14

getmaxdratio<decimal>Get the maximum ratio of digital zoom.
* We support this parameter when the version number(getversion) is equal or greater than 5.0.0.14

getminfocus

0, <positive integer> Get the lower limit for focus position.

getmaxfocus

0, <positive integer> 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>]
PARAMETERVALUE

DESCRIPTION

recallstring[30]

One of the present positions to recall.

channel0~"
Channel of the video source.
capability_nvideoin"-1

User's Manual - 403

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

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

DESCRIPTION

addposstring[30]Add one preset location to the preset list.

channel0~"capability_nvideoin"-1 Channel of the video source.

delposstring[30]Delete preset location from preset list.

return<return page>

Redirect to the page <return page> after the parameteris assigned. The <return page> should be the relative
path according to the root of camera. If you omit thisparameter, it will redirect to an empty page.
* If the <return page> is invalid path, it will ignore thisparameter.

8.29 SmartSD (capability_localstorage_smartsd > 0)
Note: This request requires Administrator privileges.
Method: GET/POST
Syntax:
http://<servername>/cgi-bin/admin/smartsd.cgi?function=<value>

404 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

DESCRIPTION

function

getstatus

Function typegetstauts : Information of smartSD internal status return
value as below:
smartsd_lifetime_num:
Accumulated amount of data that has been written
smartsd_lifetime_den:
Card-guaranteed amount of data that can be written
smartsd_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 thepercentage 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 isrecommended to be replaced if the percentage reaches
above 90%.
smartsd_data_size_per_unit:
Size (in sectors) of data to be written when Life
Information1 is updated.
smartsd_num_of_sudden_power_failure:
Indicates how many times power disconnection occurred during write/erase
operations

smartsd_operation_mode:
Enables/disables power-off detection and write error notification

smartsd_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

User's Manual - 405

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

Syntax:
http://<servername>/cgi-bin/admin/connect_ap.cgi
PARAMETERVALUE

DESCRIPTION

N/A

N/A

Apply 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://<servername>/cgi-bin/admin/getwirelessinfo.cgi
PARAMETERVALUE

DESCRIPTION

N/A

N/A

Get wireless information. Camera will return following
information.
1. Wireless channel
2. Link quality
3. Signal level
4. Noise level
5. SNR
6. TX Rate
7. 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

406 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

PARAMETERVALUE

DESCRIPTION

N/A

N/A

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

DESCRIPTION

N/A

N/A

Start 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=<value>&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\nCache-control: no-cache\r\nPragma: no-cache\r\n\r\nUser's Manual - 407

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved"washer_mode : OK\r\n""washer_status : FAIL\r\n"PARAMETERVALUE

DESCRIPTION

channel0~"capability_nvideoin"-1

Channel of the video source.

washer_mode

wiper

Apply the wiper to the mode of washer
control system.

washer_status

washerApply the washer to the mode of washer
control system.

onEnable the functionality of washer control
system.

off

Disable the functionality of washer control
system.

washer_dwelltime

15~999

Apply washer washer control system
operation time (including the time whenspraying and wiper actions take place).

heater_statusauto

automatic control the heater component tokeep the device in a workable environment.

triggerheater component is work in force heater
once.

Syntax: (for query API)
http://<servername>/cgi-bin/admin/peripheral.cgi?channel=<value>&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_
statusResponse:
HTTP/1.0 200 OK\r\nCache-control: no-cache\r\n408 - User's Manual© 2020 VIVOTEK INC. All Right Reserved

VIVOTEK

Pragma: no-cache\r\n\r\nsupportdevice=washer,heater\r\nwasher_status=off\r\nPARAMETERVALUE

DESCRIPTION

channel0~"capability_nvideoin"-1 Channel of the video source.

supportdevice

N/A

Get support peripheral device.

washer_supportmode N/A

Get the support mode of washer control system.

washer_mode

N/A

Get the current mode of washer control system.
It return the value of "washer_mode"

washer_status

N/A

Get the current status of washer control module.
The status is 'off' as default, which means thewasher is stopped; and the status 'on' means thewasher is running.

washer_dwelltime

N/A

Get the current washer clean period of washer
control system.

heater_supportstatus N/A

Get the support status of heater control system.

heater_status

Get the current heater status.
Normally it will be 'auto', it means the heater
device is control by internal algorithm to keep ina suitable environment; Otherwise is 'trigger', itmeans the heater device is force enable to heat

N/A

to an internal condition.‘trigger’ status will betransfer to ‘auto’ after reach the internal
condition.

User's Manual - 409

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

8.35 Optimized IR control(capability_daynight_c<0~(n-1)>_optimizedir > 0)
Note: This request requires Administrator privileges.
Method: GET/POST
Syntax:
http://<servername>/cgi-bin/admin/optimizedir.cgi?function=<value>[&channel=<value>]
PARAMETERVALUE

DESCRIPTION

channel0~"capability_nvideoin"-1 Channel of the video source.

function

getstatus,
onetimeauto"onetimeauto": Camera will automatically adjust the IRzone one time only.
"getstatus": Information of optimized IR control status andreturn 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:410 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

http://myserver/cgi-bin/admin/optimizedir.cgi?function=getstatus
Response:
HTTP/1.0 200 OK\r\nCache-control: no-cache\r\nPragma: 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=<value>&operation=<value>&irmode=
manual[&strength=<value>] – Set IR strength
PARAMETERVALUE

DESCRIPTION

channel0~"capability_nvideoin"-1

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

strength

1~100

If the operation is set as "set", the number ofstrength values need to be the same as it ofirnum. However, it needs only one value forstrength 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\nCache-control: no-cache\r\nPragma: no-cache\r\n\r\n"optimizedir_c0_irstrength='50,70,50,50,50'""optimizedir_c0_irmode='manual'"

User's Manual - 411

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

Example:http://myserver/cgi-bin/admin/optimizedir.cgi?channel=0&operation=settoall&irmode=manual&str
ength=100
Response:
HTTP/1.0 200 OK\r\nCache-control: no-cache\r\nPragma: 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\nCache-control: no-cache\r\nPragma: no-cache\r\n\r\nERROR: 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\nCache-control: no-cache\r\nPragma: no-cache\r\n\r\nERROR: Must have the "irmode=manual" argument!

Syntax: (for query API)412 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

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
PARAMETERVALUE

DESCRIPTION

channel0~"capability_nvideoin"-1 Channel of the video source.

support_irmode

N/A

List all adjustment mode that IR supports

irmodeN/A

Get the current IR control mode.

irnum

N/A

Get 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\nCache-control: no-cache\r\nPragma: 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\nCache-control: no-cache\r\nPragma: no-cache\r\nUser's Manual - 413

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved\r\nOK
Example:http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate
Response:
HTTP/1.0 200 OK\r\nCache-control: no-cache\r\nPragma: no-cache\r\n\r\nERROR: time out
Example:http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=set&action=shuttercompensate
Response:
HTTP/1.0 200 OK\r\nCache-control: no-cache\r\nPragma: no-cache\r\n\r\nERROR: fail

PARAMETERVALUE

DESCRIPTION

actionshuttercompensate

Camera will do shutter compensate.

Syntax: (for query API)
http://<servername>/cgi-bin/admin/thermalctrl.cgi?operation=get&version=<value>
PARAMETERVALUE

DESCRIPTION

versionN/A

Indicate lensctrl thermal version

Example:http://myserver/cgi-bin/admin/thermalctrl.cgi?operation=get&version

414 - User's Manual© 2020 VIVOTEK INC. All Right Reserved

VIVOTEK

Response:
HTTP/1.0 200 OK\r\nCache-control: no-cache\r\nPragma: no-cache\r\n\r\nversion=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>]
PARAMETERVALUE

DESCRIPTION

operation

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

name<string>

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

index

0, 1

Number 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://<servername>/cgi-bin/admin/upload_audioclip.cgi[&clipname=<value>][&clipindex=<value>]
PARAMETERVALUE

DESCRIPTION

User's Manual - 415

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

clipname<string>

Name of the audio clip.

clipindex

0, 1

Number of the 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.
PARAMETER VALUEDESCRIPTION

operation

Set

Set formatting parameters and start
formatting

fstypefat32, ext4

fat32: High compatibility for PC, but
low stability for Data
ext4 : Low compatibility for PC, buthigh stability for Data.

fullformat

0, 1

1: Completely clean data (fat32
support only)

blockingmo blocking

blocking: Send an HTTP response atdethe end of the format.
nonblocking: Send an HTTP responseat the start of the format

index

0~N

which 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\nContent-Type: text/plain\r\nContent-Length: 2\r\n\r\nok

416 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

Response of formatting fail:
HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: <Error Message Length>\r\n\r\n<Error Message>
Syntax: (for query API)
http://<servername>/cgi-bin/admin/ format_sdcard.cgi?operation=get
PARAMETER VALUEDESCRIPTION

Get

Get formatting progress(0~100) or
result(error message)*It is unnecessary when using theblocking 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\nContent-Type: text/plain\r\nContent-Length: <Success Message Length>\r\n\r\n<Success Message>
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

User's Manual - 417

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

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<x>_token” is the unique identifier for each profile, x is within0~(capability_media_streamprofiles_num)-1.
 port is the rtsp port.
Please refer to the streamprofile group for requesting the stream profile token value for eachprofile.
PARAMETER VALUEDESCRIPTION

pimssm1: Enable the feature of Protocol

1

Independent Multicast - Source
Specific Multicast.
* This field is only required whenusing 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<x>_occupied=0, which indicates stream profile <x>
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)
418 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

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<x>_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 eachprofile.
You can get the SDP by HTTP GET.
When using scalable multicast, Get SDP file which contains the multicast information via HTTP.
PARAMETER VALUEDESCRIPTION

pimssm1: Enable the feature of Protocol
Independent Multicast - Source

1

Specific Multicast.
* This field is only required whenusing 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<x>_alwaysmulticast=1.
2. If the requested certain streamprofile_i<x>_profilename is empty, which indicates stream
profile <x> 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<x>_profilename which have the same value,
the requested SDP file will be overwrite by the last request.

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)

User's Manual - 419

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=<value>[&parameter=<value>]
PARAMETERVALUE

DESCRIPTION

operation

automode, manualmode"automode": Key pair will be generated, andautomatically copy public key to server.
"manualmode": Key should be downloaded or
uploaded by user.
* This field is required.

key

download, 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 therequest body, see examples below.
* Required when operation=manualmodeaddress<sftp server address or

sftp server address or hostname

hostname>* This field is required.
port<sftp port>

sftp port

index

0~4

Event setting server index* This field is required.

username

string[64]Sftp server username* This field is required.

passwdstring[64]Sftp server password* Required when operation=automode.

fingerprint_enable<Boolean>

Verify fingerprint* Default is 1.

fingerprint_content<128-bit hash value>

Fingerprint content* Required when fingerprint_enable=1.

passphrase_enable
420 - User's Manual<Boolean>Enable passphrase

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved* 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 theparameter 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://<servername>/cgi-bin/admin/sftpclient.cgi?operation=manualmode&key=download&index=
1&address=<ip>&username=xxx&fingerprint_enable=1&fingerprint_content=<MD5
value>&keytype=ecdsa
Response of success:
HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: <Success Message Length>\r\n\r\nok
Request:http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=manualmode&key=download&index=
1&address=<ip>&username=xxx&fingerprint_enable=1&fingerprint_content=<MD5

User's Manual - 421

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved

value>&keytype=test
Response of failure:
HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: <Error Message Length>\r\n\r\nERROR: 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

422 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

TovnyQQANfyNLykEtP7U7Htxbdqg4dqYdFahJEBNs0QHxhmYHTESccKM4NOB0qMY
5+9gwlMZqNIymxGlGwylTMcV7gV6JaY/bX0K4J0B6AhNHjCIOFErrQivp026TXj9
m+bnnrAt7v5uBMH4oclPC8oDHqd1jWwHIBcbqjRPWL37VW5B+YPZQ7FVUP496OKp
riheNLTF6yOtYFw9syyoOnRF+gxpFpQrSO7skENGyv4CO7kH/S7Kpc7qmMgTk/rL
s12230NogZsqghhTJIpg2vX5Ha3wCDIZZVKPUGItQl0MB6t74nsV1o8YVtRovI5F
YX2d8sPIIkcTDWBO498+v98DQ7DH51/i39JoJouRojz+n3ffsSGjY2AKEcTde2xI
v2f81KqAxkraXllScl1SNEGXQpngXy3IK2GrVw9BzJILMSBuj30Ar2zfTbc0C5VC
YqWK1FcMA5Jb6AvYwmpgijIb52T9P7g07RwFGJpumvaqTchBeSp8pXa3C++DoBdY
9zYohmuSSs52QLoIkTPzDjJJHvncddPi6VuUkSyaK5x75p0+aoljPjlAQHXbXsmt
8HAdPs9Fwab9GbC2aumH4XT1xoWFnYJ9lBHc3iZRiI/nSIPev2YneyyOhJg4tHYD
swUUEydNC8Q5qrbLfHESDrkHlx0sQiM7A/DyY1akkoxKEFW9LxqsJpcf7LM2TrlX
IjSd+RMqL3yCFzM0aqcQNjd77nDP6+u9RYYyGT8dH5ud7pJVofxI+pvpQN3k5Tlb
Pm9IM6OJPDy/Netcu6YEl3ULa6XHkYldqezJDnUfCBHe3OKjhue2FTBRmM2/j9Zl
DkUrO7lQz7X88T/w5+rI2OnDIm3szOhzMCYPtHxf8ygMKXI/DKp3OR2/cu6ayGhb
DezpoSyTjL1fTFINQAymDtP5tbomfESjFDW1fmfD9h1FivqYEy7017djPWrq8mjH
N6nAhlaLVVuTVJ+xxaJAzYiQwMdwWY8SGUq062ksDvfixYCQfhXUd629oEX82fJU
8OxF8CM0WEHFCIotJVbFjDyT5lP4qln5EMeMlPE8jrmUKEEV+AJw9AbaqvCYUNaH
EVZ7nlYjrnQqMCktYlO/Um8vSiVsOaMFLUdiYJwj2pzyceTzyW19/KEo//8ufOFD
LaSp5EGH6lBCTBfQ9PGeOkB2ZVf0jLFB9Sage8Ln5frWYOAROxzumUJWSvOoBael
15OdV5hApqQjGrn1vbc/kC8p478ZCzx2iDyckPqyVpHSke70T5bV6vcDZcCTrwkA
PHdD4Q0cqd7sX0R2OAScwJk2AkaQ+PsLwS05hw1nQBsQrC4m9e8Kmg32RgCGDAES
xpV9dkSkvoaLZmN1qfBwnyOxsjmx9OAOBKWzMlW5PoPCR9z8Z1gsiACBnrT+K5ec
NZdgsxvxMfdI7vfj6mkO89MvwLX8YEtnFrihIZmDnnVMuHfq6g5kbwlHbHVaoImo-----END RSA PRIVATE KEY---------------------------------7e1309282ed0f1a--

Syntax: (for query API)
http://<servername>/cgi-bin/admin/sftpclient.cgi?operation=<value>[&parameter=<value>]
PARAMETERVALUE

DESCRIPTION

operation

getserverhostkey" getserverhostkey ": Auto scan
SFTP server host key.
* This field is required.

address<sftp server address or hostname>sftp server address or hostname

User's Manual - 423

VIVOTEK© 2020 VIVOTEK INC. All Right Reserved* 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\nContent-Type: text/plain\r\nContent-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>
PARAMETERVALUE

DESCRIPTION

operation

updatehostkey"updatehostkey": Re-generate host
key for SFTP server.
* It might take several seconds togenerate 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\nContent-Type: text/plain\r\nContent-Length: <Success Message Length>\r\n\r\nok

424 - User's ManualVIVOTEK© 2020 VIVOTEK INC. All Right Reserved

Syntax: (for query API)
http://<servername>/cgi-bin/admin/sftpserver.cgi?operation=<value>
PARAMETERVALUE

DESCRIPTION

operation

gethostkey"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://<servername>/cgi-bin/admin/sftpserver.cgi?operation=gethostkey
Response of success
HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: <Success Message Length>\r\n\r\nMD5: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)<End of document>

User's Manual - 425

VIVOTEKTechnology License Notice
AMR-NB Standard
THIS PRODUCT IS LICENSED UNDER THE AMR-NB STANDARD PATENT LICENSE AGREEMENT. WITHRESPECT TO THE USE OF THIS PRODUCT, THE FOLLOWING LICENSORS’ PATENTS MAY APPLY:TELEFONAKIEBOLAGET ERICSSON AB: US PAT. 6192335; 6275798; 6029125; 6424938; 6058359. NOKIACORPORATION: 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.

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 FOLLOWINGQUALIFICATIONS: (1) HEVC CONTENT ONLY FOR PERSONAL USE; (2) HEVC CONTENT THATIS 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 PURCHASEDFROM 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 INCOMPLIANCE WITH THE AVC STANDARD ("AVC VIDEO") AND/OR (ii) DECODE AVC VIDEO
THAT WAS ENCODED BY A CONSUMER ENGAGED IN A PERSONAL AND NON-COMMERCIALACTIVITY 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

426 - User's ManualVIVOTEKElectromagnetic Compatibility (EMC)
VCCI 規制について
この装置は、クラスＢ情報技術装置です。この装置は、家庭環境で使用することを目的としていますが、 この装置がラジオやテレビジョン受信機に近接して使用されると、受信障害を引き起こすことがありま す。取扱説明書に従って正しい取扱いをして下さい。
VCCI-B
責任① 本書の内容は、将来予告なしに変更する場合があります。
② 本書の内容について万全を期して作成いたしましたが、万が一ご不審な点や誤り、記載もれなどお気づきの点がございましたら、お買い求めの販売店にご連絡ください。
③ 製品を運用した結果の影響については②項にかかわらず責任を負いかねますのでご了承ください。
製品の譲渡または売却時のご注意
この製品を第三者に譲渡または売却する場合は、この製品に添付されているすべてのものを譲渡または売却してください。
IoT 機器のセキュリティ基準 ( 端末設備等規則第 34 条の 10)「本製品は電気通信事業者 ( 移動通信会社、固定通信会社、インターネットプロバイダ等 ) の通信回線 ( 公衆
無線 LAN を含む ) に直接接続することができません。本製品をインターネットに接続する場合は、必ずルータ等を経由し接続してください。」

User's Manual - 427