Skip to main content

XProtect Smart Client

Smart Client スクリプトの言語と制限

最終更新日: 11 分で読めます
バージョン2026 R2
言語日本語

Smart Client スクリプトは、XML内のC#の限られたセットを使用します。次の場合 XProtect Smart Client スクリプトファイルを読み込み、許可されている言語の機能とアクションのリストと照らしてファイルをチェックします。スクリプトの一部が無効な場合、スクリプト本体とイベントトリガーは実行されませんが、 <Login> ブロックは引き続き適用されます。

ファイル構造

ファイルを .scs UTF-8としてエンコードされた拡張子。BOMなしのUTF-8をお勧めします。

エレメント

必須

説明

<ScriptEngine>

はい

ルート要素。

<SchemaVersion>

いいえ

ファイル形式バージョン。デフォルトの現行バージョンは 1. ファイルがインストールされているバージョンよりも新しいバージョンを宣言する場合 XProtect Smart Client をサポートしている場合、ファイルは拒否されます。

<Login>

いいえ

ログイン情報。スクリプトを使用した自動ログインをご参照ください。

<Script>

いいえ

スクリプト本体。ログインごとに1回実行されます。

<OnEvent Name="…">

いいえ

イベントトリガー。ファイルはイベントごとに1つずつ含めることができます。

注記

レガシー要素 <ScriptExtension> および <ScriptLanguage> c#以外はスクリプトエンジンによって拒否されます。)

特殊文字

XML読み取り <, >、および & マークアップとして。スクリプト コードをラップ <![CDATA[ … ]]>、または各文字をXMLエンティティに置き換えることをお勧めします。

文字

エンティティ

<

&lt;

>

&gt;

&

&amp;

対応言語

変数

詳細

変数

var、文字列、整数、およびブール値(両方 var および明示的な型 int がサポートされています)。

条件

if, else if, else

ループ

for および foreach、 break および continue. foreach リストを返すアクションでのみ動作します。

オペレータ

+,-,*,/,+=,-=, 比較演算子,&&,\|\|, および接尾辞 i++

文字列

二重引用符をお勧めします(単一引用符はエンジンで受け入れられますが、警告が生成され、有効なC#ではありません)。文字列を結合 +.

コメント

// および /* … */

アクション

アクションタイプ

構文

メモ

組み込みアクション

SCS.<Group>.<Action>(<arguments>);

直接メソッドを提供します Smart Client スクリプトエンジン(例: SCS.Application.Minimize();). ほとんどのアクションは引数を取ります。

使用可能なグループは次のとおりです Application, Views, Browse, Camera, Ptz, MultiWindow, General、および Keyboard.

ビュー、出力、イベント、PTZプリセット

SCS.Invoke("<name>");

第 <name> はUIに表示されている表示名ではありません。以下で始まります Views.All., Outputs.All., Events.All.、または Ptz.Presets.をクリックし、設定された階層名をドットで結合します。英数字の文字または数字以外の文字は、アンダースコア(_).

例: Views.All.Basic_User_Group.All_cameras_Group._10x10_All_cameras

これらの名前は、すべてのクライアントの表示言語で同じです。同じグループ内の2つのアイテムが特殊文字によってのみ異なる場合(カメラ1やカメラ1など)、それらは同じ識別子を生成し、1つだけが到達可能です。衝突を解決するために、いずれかのアイテムの名前を変更します。

名前によるMIPプラグインのアクション

SCS.Invoke("<name>");

第 <name> クライアントがプラグインのグループとアクションに対して表示する表示名をドットで結合して構成します。プラグインはこれらの名前を定義し、ローカライズできるため、このフォームは現在のクライアント言語に依存します。複数のアクションが同じ名前を共有する場合、スクリプトエンジンはその名前を拒否し、代わりにIDでアクションを呼び出します。

ID別アクション

SCS.Invoke("<action-id>");

言語に依存しない一意の識別子。名前とIDの両方が、Include configuration items(構成アイテムを含む)がチェックされたときに生成されたスクリプト参照ファイルに一覧表示され、スクリプトに正確なIDを直接コピーできます。

システムで利用可能なすべてのアクションを表示するには、スクリプト参照を生成します。

ビルトイン機能

機能

説明

Thread.Sleep(milliseconds)

スクリプトをフリーズせずに一時停止します XProtect Smart Client. 0~30,000ミリ秒を受け入れます。

MessageBox.Show(message), MessageBox.Show(message, caption)

通知領域に通知を表示します。スクリプトやUIをブロックしません。

DateTime.Now, DateTime.Today, DateTime.Parse(), new DateTime(…)

日時の値。読むことができます .Year, .Month, .Day, .Hour, .Minute および .Second.

Guid.Empty, Guid.Parse(), new Guid("<id as text>")

一意の識別子操作。new Guid("<id as text>") には文字列の引数が1つだけ必要です。

SCS.Application.WriteLog(level, message)

書き込み先 MIPLog.txt. レベル: Info, Debug、または Error.

SCS.Application.GetEventWindowId()

イベントトリガーでは、イベントが発生したウィンドウのIDを返します。メインウィンドウの空のテキストをスクリプト本体と ConfigurationReloadCompleted.

注:この関数は、タブ内のビューエリアなどの埋め込みウィンドウのIDを返すことができ、その場合は SCS.MultiWindow アクションが認識します。最初にIDを既知のフローティングウィンドウIDと比較するか、認識されていないウィンドウIDを無視します。

イベントトリガー

定義 <OnEvent> 内のブロック <ScriptEngine> root要素を使用して、ユーザーアクションとワークスペースの変更に対応します。

イベント

実行

ConfigurationReloadCompleted

設定の再読み込みが完了するたびに、ビューとタブが確定します。最初のログイン時には実行されません。

SelectedViewChanged

別のビューを選択した後、任意のウィンドウで。

SelectedViewItemChanged

別のビューアイテムを選択した後、任意のウィンドウで。

ShownWorkSpaceChanged

選択したタブが変更された後、またはウィンドウがライブと再生を切り替えた後。

注記

アラームマネージャやエクスポートなどの一部のワークスペースには、独自の組み込みビューエリアがあります。各組み込みビューエリアは、フローティングウィンドウに属さないIDを使用して作成を報告します。したがって、これらのタブのいずれかに切り替えると実行できます ShownWorkSpaceChanged 複数回(たとえば、Alarm Managerには2つの組み込みビューエリアがあり、Exportsには1つがあるため、Alarm Managerに切り替えるとトリガーを最大3回実行できます)。 スクリプトは認識されないウィンドウIDを無視する必要があります。

  • イベントトリガーは、スクリプト本体と一緒にチェックされます。不明なイベント名はエラーです。

  • イベントトリガーはスクリプト本体が実行される前にアクティブになり、ログアウトするまでアクティブのままになります。

  • イベントトリガーは、それ自体のアクションによって行われた変更のため、再度実行されません。

  • イベント名では大文字と小文字が区別されます。

  • 各イベントタイプは、スクリプト内で一度に宣言できます。

  • スクリプト本体(<Script>)もこれらのイベントを起動します。

制限

制限

値

実行ごとのステートメント

100,000

実行ごとの実行時間

30 秒

Thread.Sleep 呼び出しごと

30 秒

イベントトリガーごとに実行

1分あたり60。その1分間に実行された実行はスキップされます。

ループごとのイテレーション

10,000

文字列長

65,536文字

スクリプト本体またはイベントトリガーの実行にはそれぞれ制限があります。実行が制限に達するか、アクションが失敗すると、その実行の残りが停止し、イベントがログインします MIPLog.txt、しかし XProtect Smart Client その他のイベントトリガーは実行し続けます。ログアウトまたは閉じるとき XProtect Smart Client、実行中のスクリプトを停止します。

サポート対象外

サポート対象外

代わりに使用

while, do/while

for

switch

if / else if

try/catch, throw

スクリプトの確認… スクリプトをデプロイする前に

条件付き演算子(?:)

if / else

接頭辞の増分 (++i)

接尾辞の増分 (i++)

文字列の補間 ($"…")

+

コンマ式、複数の変数宣言 for

個別のステートメント

配列、コレクション リテラル、インデックス作成

サポート対象外

%, *=, /=, %=、ビット演算子

サポート対象外

メソッド、クラス、インターフェイス、名前空間、 dynamic

MIPプラグイン

ScriptExtension

組み込みのスクリプトアクションまたはMIPプラグインを使用

タイマー、 Task, new Thread(), async、代理オブジェクト、ラムダ

Thread.Sleep またはイベントトリガー

ファイル、レジストリ、ネットワークおよびプロセスへのアクセス、リフレクション

MIPプラグイン