Skip to main content

XProtect Smart Client

Smart Client langage de script et limites

Dernière mise à jour : 6 minutes de lecture
Version2026 R2
LangueFrançais

Smart Client Les scripts utilisent un ensemble limité de C# dans XML. Quand XProtect Smart Client charge un fichier de script, il vérifie le fichier par rapport à une liste de fonctionnalités et d’actions de langage autorisées. Si une partie du script est invalide, le corps du script et les déclencheurs d’événements ne s’exécuteront pas. Cependant, le <Login> le blocage est toujours appliqué.

Structure du fichier

Enregistrez le fichier avec le .scs extension, encodée en UTF-8. UTF-8 sans BOM est recommandé.

Élément

Requis

Description

<ScriptEngine>

Oui

Élément racine.

<SchemaVersion>

Non

Version du format du fichier. La version par défaut et actuelle est 1. Si un fichier déclare une version plus récente que la version installée XProtect Smart Client prend en charge, le fichier est refusé.

<Login>

Non

Informations sur l'ouverture de session. Voir Automatisez la connexion avec des scripts.

<Script>

Non

Corps du script. S’exécute une fois par connexion.

<OnEvent Name="…">

Non

Déclencheur d’événement. Un fichier peut en avoir un par événement.

Note

Éléments hérités tels que <ScriptExtension> et toutes <ScriptLanguage> autres que C# sont refusés par le moteur de script.)

Caractères spéciaux

XML lit <, >, et & comme balisage. Enveloppez le code du script <![CDATA[ … ]]>, ce qui est recommandé, ou remplacez chaque caractère par son entité XML :

Caractère

Entité

<

&lt;

>

&gt;

&

&amp;

Langue prise en charge

Variables

Détails

Variables

var, des chaînes, des entiers et des valeurs booléennes (les deux var et les types explicites, tels que int sont pris en charge).

Conditions

if, else if, else

Boucles

for et foreach, avec break et continue. foreach fonctionne uniquement sur les actions qui renvoient une liste.

Opérateurs

+,-,*,/,+=,-=, opérateurs de comparaison,&&,\|\|, et postfix i++

Chaînes

Les guillemets doubles sont recommandés (les guillemets simples sont acceptés par le moteur mais génèrent un avertissement et ne sont pas des C# valides). Joignez des chaînes avec +.

Commentaires

// et /* … */

Actions

Type d’action

Syntaxe

Remarques

Actions intégrées

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

Méthodes directes fournies par le Smart Client moteur de script (par exemple, SCS.Application.Minimize();). La plupart des actions prennent des arguments.

Les groupes disponibles sont Application, Views, Browse, Camera, Ptz, MultiWindow, General, et Keyboard.

Vues, sorties, événements et positions prédéfinies PTZ

SCS.Invoke("<name>");

Le <name> n’est pas le nom affiché dans l’interface utilisateur. Cela commence par Views.All., Outputs.All., Events.All.,ou Ptz.Presets., suivis des noms de hiérarchie configurés, reliés par des points. Tout caractère autre qu’une lettre alphanumérique ou un chiffre est converti en trait de soulignement (_).

Exemple : Views.All.Basic_User_Group.All_cameras_Group._10x10_All_cameras

Ces noms sont identiques dans toutes les langues d’affichage du client. Si deux éléments d’un même groupe ne diffèrent que par des caractères spéciaux (tels que Cam 1 et Cam-1), ils génèrent le même identifiant, et qu’un seul est accessible ; renommez l’un des éléments pour résoudre la collision.

Actions du plugin MIP, par nom

SCS.Invoke("<name>");

Le <name> se compose des noms d’affichage que le client affiche pour les groupes et les actions du plugin, joints par des points. Étant donné que le plugin définit et peut localiser ces noms, ce formulaire dépend de la langue du client actuel. Si plusieurs actions partagent le même nom, le moteur de script refuse le nom ; appelez l’action par son ID à la place.

Actions par ID

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

Identifiant unique indépendant de la langue. Les noms et les ID sont répertoriés dans le fichier de référence du script généré lorsque l’option Inclure les éléments de configuration est cochée, ce qui vous permet de copier l’ID exact directement dans votre script.

Pour voir toutes les actions disponibles sur votre système, générez une référence de script.

Fonctions intégrées

Fonction

Description

Thread.Sleep(milliseconds)

Met le script en pause sans se figer XProtect Smart Client. Accepte de 0 à 30 000 ms.

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

Affiche une notification dans la zone de notification. Il ne bloque pas le script ni l’interface utilisateur.

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

Valeurs de date et d’heure. Vous pouvez lire .Year, .Month, .Day, .Hour, .Minute et .Second.

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

Opérations d’identifiant unique. new Guid("<id as text>") nécessite exactement un argument de chaîne.

SCS.Application.WriteLog(level, message)

Écrit à MIPLog.txt. Le niveau est Info, Debug,ou Error.

SCS.Application.GetEventWindowId()

Dans un déclencheur d’événement, renvoie l’ID de la fenêtre dans laquelle l’événement s’est produit. Retourne du texte vide pour la fenêtre principale, dans le corps du script et dans ConfigurationReloadCompleted.

Remarque : cette fonction peut renvoyer l’ID d’une fenêtre intégrée (telle qu’une zone de vue à l’intérieur d’un onglet) qui n’est pas SCS.MultiWindow l’action reconnaît. Comparez d’abord l’ID avec les ID de fenêtre flottante connus ou ignorez les ID de fenêtre non reconnus.

Déclenchements d’événements

Définissez <OnEvent> blocs à l’intérieur du <ScriptEngine> élément racine pour réagir aux actions des utilisateurs et aux changements de l’espace de travail.

Événement

S’exécute

ConfigurationReloadCompleted

Après chaque rechargement de configuration terminé, une fois que les vues et les onglets sont installés. Ne s’exécute pas lors de la première connexion.

SelectedViewChanged

Après avoir sélectionné une autre vue, dans n’importe quelle fenêtre.

SelectedViewItemChanged

Après avoir sélectionné un autre élément de vue, dans n’importe quelle fenêtre.

ShownWorkSpaceChanged

Une fois que l’onglet sélectionné a été modifié, une fenêtre passe du mode En direct au mode Lecture.

Note

Certains espaces de travail, tels que le gestionnaire d’alarme et les exportations, contiennent leurs propres zones de vue intégrées. Chaque zone de vue intégrée signale sa création à l’aide d’un ID qui n’appartient pas à une fenêtre flottante. Le passage à l’un de ces onglets peut donc s’exécuter ShownWorkSpaceChanged plusieurs fois (par exemple, Alarm Manager a deux zones de vue intégrées et Exports en a une, donc le passage à Alarm Manager peut déclencher jusqu’à trois fois). Votre script doit ignorer les ID de fenêtre non reconnus.

  • Les déclencheurs d’événements sont vérifiés avec le corps du script. Un nom d’événement inconnu est une erreur.

  • Les déclencheurs d’événements deviennent actifs avant l’exécution du corps du script et restent actifs jusqu’à la déconnexion.

  • Un déclencheur d’événement ne s’exécute pas à nouveau en raison d’un changement apporté par ses propres actions.

  • Les noms d’événements sont sensibles à la casse.

  • Chaque type d’événement peut être déclaré au plus une fois dans un script.

  • Changements de vue ou d’onglet initiés par le corps du script (<Script>) déclenchent également ces événements.

Limites

Limiter

Valeur

Relevés par exécution

100,000

Durée d’exécution par exécution

30 secondes

Thread.Sleep par appel

30 secondes

S’exécute par déclencheur d’événement

60 par minute. Toutes les autres exécutions dans cette minute sont ignorées.

Itérations par boucle

10,000

Longueur de chaîne

65 536 caractères

Chaque exécution du corps du script ou d’un déclencheur d’événement a ses propres limites. Si une exécution atteint une limite ou si une action échoue, le reste de l’exécution s’arrête et l’événement est connecté MIPLog.txt, mais XProtect Smart Client et tous les autres déclencheurs d’événements continuent de s’exécuter. Lorsque vous vous déconnectez ou fermez XProtect Smart Client, il arrête tous les scripts en cours d’exécution.

Non supporté

Non supporté

Utilisez plutôt

while, do/while

for

switch

if / else if

try/catch, throw

Vérifier le script… avant de déployer le script

Opérateur conditionnel (?:)

if / else

Incrément du préfixe (++i)

Incrément Postfix (i++)

Interpolation de chaîne ($"…")

+

Expressions virgules, déclarations de variables multiples dans for

Déclarations distinctes

Tableaux, littéraux de collection et indexation

Non supporté

%, *=, /=, %=, opérateurs binaires

Non supporté

Méthodes, classes, interfaces, espaces de noms, dynamic

Plugin MIP

ScriptExtension

Utilisez des actions de script intégrées ou un plugin MIP

Minuteries, Task, new Thread(), async, délégués, lambdas

Thread.Sleep ou déclencheurs d’événements

Accès aux fichiers, registres, réseaux et processus, réflexion

Plugin MIP