Skip to main content

XProtect Smart Client

Smart Client Skriptsprache und -grenzen

Zuletzt aktualisiert: 5 Minuten Lesezeit
Version2026 R2
SpracheDeutsch

Smart Client Ihre Skripte verwenden eine begrenzte Anzahl von C# innerhalb von XML. Wann XProtect Smart Client Wenn eine Skriptdatei geladen wird, wird die Datei mit einer Liste der zugelassenen Sprachfunktionen und -aktionen abgeglichen. Wenn ein Teil des Skripts ungültig ist, werden der Skriptkörper und die Ereignisauslöser nicht ausgeführt. Die <Login> Die Sperre wird weiterhin angewendet.

Dateistruktur

Speichern Sie die Datei mit dem .scs Erweiterung, codiert als UTF-8. UTF-8 ohne BOM wird empfohlen.

Element

Erforderlich

Beschreibung

<ScriptEngine>

Ja

Stammelement.

<SchemaVersion>

Nein

Version des Dateiformats. Die Standard- und aktuelle Version ist 1. Wenn eine Datei eine neuere Version als die installierte XProtect Smart Client Unterstützt, wird die Datei abgelehnt.

<Login>

Nein

Anmeldeinformationen. Siehe Automatisieren Sie die Anmeldung mit Skripten.

<Script>

Nein

Skripttext. Läuft einmal pro Anmeldung.

<OnEvent Name="…">

Nein

Ereignis auslösen. Eine Datei kann eine pro Ereignis haben.

Anmerkung

Ältere Elemente wie <ScriptExtension> und alle <ScriptLanguage> Andere als C# werden von der Skript-Engine abgelehnt.)

Sonderzeichen

XML-Lesevorgänge <, >, und & Als Markup. Skriptcode einschließen <![CDATA[ … ]]>, was empfohlen wird, oder ersetzen Sie jedes Zeichen durch seine XML-Entität:

Zeichen

Entität

<

&lt;

>

&gt;

&

&amp;

Unterstützte Sprache

Variablen

Details

Variablen

var, Zeichenfolgen, Ganzzahlen und boolesche Werte (beide var und explizite Typen wie int werden unterstützt).

Bedingungen

if, else if, else

Schleifen

for und foreach, mit break und continue. foreach Funktioniert nur bei Aktionen, die eine Liste zurückgeben.

Bediener

+,-,*,/,+=,-=, Vergleichsoperatoren,&&,\|\|, und Postfix i++

Zeichenketten

Es werden doppelte Anführungszeichen empfohlen (einfache Anführungszeichen werden von der Engine akzeptiert, erzeugen jedoch eine Warnung und sind nicht gültig für C#). Verknüpfen Sie Zeichenfolgen mit +.

Anmerkungen

// und /* … */

Aktionen

Aktionstyp

Syntax

Anmerkungen

Integrierte Aktionen

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

Direkte Methoden zur Verfügung gestellt von Smart Client Skript-Engine (zum Beispiel SCS.Application.Minimize();). Die meisten Aktionen benötigen Argumente.

Die verfügbaren Gruppen sind Application, Views, Browse, Camera, Ptz, MultiWindow, General, und Keyboard.

Ansichten, Ausgänge, Ereignisse und PTZ-Voreinstellungen

SCS.Invoke("<name>");

Das Feld <name> Dies ist nicht der Anzeigename, der in der Benutzeroberfläche angezeigt wird. Es beginnt mit Views.All., Outputs.All., Events.All.,oder Ptz.Presets., gefolgt von den Namen der konfigurierten Hierarchie, die durch Punkte verbunden sind. Jedes Zeichen, das kein alphanumerischer Buchstabe oder keine Ziffer ist, wird in einen Unterstrich (_).

Beispiel: Views.All.Basic_User_Group.All_cameras_Group._10x10_All_cameras

Diese Namen sind in allen Client-Anzeigesprachen identisch. Wenn sich zwei Elemente in derselben Gruppe nur durch Sonderzeichen unterscheiden (z. B. Cam 1 und Cam-1), erzeugen sie denselben Bezeichner, und nur eines ist erreichbar. Benennen Sie eines der Elemente um, um die Kollision aufzulösen.

MIP-Plugin-Aktionen, nach Namen

SCS.Invoke("<name>");

Das Feld <name> Besteht aus den Anzeigenamen, die der Client für die Gruppen und Aktionen des Plugins anzeigt, verbunden durch Punkte. Da das Plugin diese Namen definiert und lokalisieren kann, hängt diese Form von der aktuellen Client-Sprache ab. Wenn mehrere Aktionen denselben Namen haben, lehnt die Skript-Engine den Namen ab. Rufen Sie stattdessen die Aktion über ihre ID auf.

Aktionen nach ID

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

Sprachunabhängige eindeutige Kennung. Sowohl Namen als auch IDs werden in der generierten Skriptreferenzdatei aufgeführt, wenn Konfigurationselemente einschließen aktiviert ist, sodass Sie die genaue ID direkt in Ihr Skript kopieren können.

Generieren Sie eine Skriptreferenz, um alle in Ihrem System verfügbaren Aktionen anzuzeigen.

Integrierte Funktionen

Funktion

Beschreibung

Thread.Sleep(milliseconds)

Hält das Skript an, ohne es einzufrieren XProtect Smart Client. Akzeptiert 0–30.000 ms.

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

Zeigt eine Benachrichtigung im Benachrichtigungsbereich an. Es blockiert weder das Skript noch die Benutzeroberfläche.

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

Datums- und Uhrzeitwerte. Sie können lesen .Year, .Month, .Day, .Hour, .Minute und .Second.

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

Eindeutige Bezeichner-Operationen. new Guid("<id as text>") Erfordert genau ein Zeichenfolgenargument.

SCS.Application.WriteLog(level, message)

Schreibt in MIPLog.txt. Die Ebene ist Info, Debug,oder Error.

SCS.Application.GetEventWindowId()

Bei einem Ereignisauslöser wird die ID des Fensters zurückgegeben, in dem das Ereignis aufgetreten ist. Gibt einen leeren Text für das Hauptfenster, den Skripttext und die ConfigurationReloadCompleted.

Hinweis: Diese Funktion kann die ID eines eingebetteten Fensters (z. B. eines Ansichtsbereichs in einer Registerkarte) zurückgeben, das keine SCS.MultiWindow Aktion erkennt. Vergleichen Sie die ID zuerst mit bekannten IDs für bewegliche Fenster oder ignorieren Sie nicht erkannte Fenster-IDs.

Ereignisauslöser

Definieren Sie <OnEvent> Blöcke innerhalb der <ScriptEngine> Stammelement, um auf Benutzeraktionen und Änderungen am Arbeitsbereich zu reagieren.

Ereignis

Läuft

ConfigurationReloadCompleted

Nach jeder abgeschlossenen Konfiguration neu laden, sobald Ansichten und Registerkarten eingerichtet sind. Läuft nicht bei der ersten Anmeldung.

SelectedViewChanged

Wenn eine andere Ansicht ausgewählt wurde, klicken Sie in einem beliebigen Fenster auf.

SelectedViewItemChanged

Wenn ein anderes Ansichtselement ausgewählt wurde, klicken Sie in einem beliebigen Fenster auf.

ShownWorkSpaceChanged

Wenn sich die ausgewählte Registerkarte ändert oder ein Fenster zwischen Live und Wiedergabe wechselt.

Anmerkung

Einige Arbeitsbereiche, z. B. Alarm-Manager und Exporte, enthalten eigene eingebettete Ansichtsbereiche. Jeder eingebettete Ansichtsbereich meldet seine Erstellung anhand einer ID, die nicht zu einem beweglichen Fenster gehört. Daher kann der Wechsel zu einer dieser Registerkarten ausgeführt werden ShownWorkSpaceChanged mehrmals (z. B. der Alarm-Manager hat zwei eingebettete Ansichtsbereiche und die Exporte haben einen, sodass der Alarm-Manager den Trigger bis zu dreimal auslösen kann). Ihr Skript sollte nicht erkannte Fenster-IDs ignorieren.

  • Ereignisauslöser werden zusammen mit dem Skripttext überprüft. Ein unbekannter Ereignisname ist ein Fehler.

  • Ereignisauslöser werden aktiv, bevor der Skripttext ausgeführt wird, und bleiben aktiv, bis Sie sich abmelden.

  • Ein Ereignisauslöser wird aufgrund einer durch seine eigenen Aktionen vorgenommenen Änderung nicht erneut ausgeführt.

  • Bei Ereignisnamen wird zwischen Groß- und Kleinschreibung unterschieden.

  • Jeder Ereignistyp kann höchstens einmal in einem Skript deklariert werden.

  • Ansicht- oder Registerkartenänderungen, die durch den Skripttext ausgelöst werden (<Script>) lösen auch diese Ereignisse aus.

Grenzen

Begrenzen

Wert

Anweisungen pro Durchlauf

100,000

Laufzeit pro Durchlauf

30 Sekunden

Thread.Sleep Pro Anruf

30 Sekunden

Durchläufe pro Ereignisauslöser

60 pro Minute. Alle weiteren Durchläufe in dieser Minute werden übersprungen.

Iterationen pro Schleife

10,000

Zeichenfolgenlänge

65.536 Zeichen

Jeder Durchlauf des Skriptkörpers oder eines Ereignisauslösers hat seine eigenen Grenzen. Wenn ein Durchlauf ein Limit erreicht oder eine Aktion fehlschlägt, wird der Rest dieses Durchlaufs gestoppt und das Ereignis protokolliert MIPLog.txt, aber XProtect Smart Client und alle anderen Ereignisauslöser laufen weiter. Wenn Sie sich abmelden oder schließen XProtect Smart Client, werden alle laufenden Skripte gestoppt.

Nicht unterstützt

Nicht unterstützt

Verwenden Sie stattdessen

while, do/while

for

switch

if / else if

try/catch, throw

Überprüfen Sie das Skript... bevor Sie es bereitstellen

Bedingter Operator (?:)

if / else

Präfix-Inkrement (++i)

Postfix-Inkrement (i++)

String-Interpolation ($"…")

+

Kommaausdrücke, mehrere Variablendeklarationen in for

Separate Anweisungen

Arrays, Auflistungsliterale und Indizierung

Nicht unterstützt

%, *=, /=, %=, bitweise Operatoren

Nicht unterstützt

Methoden, Klassen, Schnittstellen, Namespaces, dynamic

MIP-Plugin

ScriptExtension

Verwenden Sie integrierte Skriptaktionen oder ein MIP-Plugin

Timer, Task, new Thread(), async, Delegierte, Lambdas

Thread.Sleep oder Ereignisauslöser

Datei-, Registrierungs-, Netzwerk- und Prozesszugriff, Reflexion

MIP-Plugin