Skip to main content

XProtect Smart Client

Smart Client язык сценариев и ограничения

Последнее обновление: 5 минут чтения
Версия2026 R2
ЯзыкРусский

Smart Client Сценарии используют ограниченный набор C# внутри XML. Когда XProtect Smart Client При загрузке файла сценария он сверяет файл со списком допустимых функций и действий языка. Если какая-либо часть сценария недействительна, тело сценария и триггеры событий не будут выполняться; однако <Login> Блокировка по-прежнему применяется.

Структура файлов

Сохраните файл с помощью .scs расширение, закодированное как UTF-8. Рекомендуется использовать UTF-8 без спецификации.

Элемент

Обязательно

Описание

<ScriptEngine>

Да

Корневой элемент.

<SchemaVersion>

Нет

Версия формата файла. Версия по умолчанию и текущая 1. Если файл объявляет более новую версию, чем установленная XProtect Smart Client Если файл не поддерживается, он отклоняется.

<Login>

Нет

Сведения о входе в систему. См. раздел Автоматизация входа с помощью сценариев.

<Script>

Нет

Тело сценария. Выполняется один раз при входе в систему.

<OnEvent Name="…">

Нет

Активатор события. Файл может иметь одно событие.

Примечание

Устаревшие элементы, такие как <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> не является отображаемым именем, отображаемым в пользовательском интерфейсе. Начинается с Views.All., Outputs.All., Events.All., или Ptz.Presets., за которыми следуют имена настроенной иерархии, объединенные точками. Любой символ, отличный от буквенно-цифровой буквы или цифры, преобразуется в символ подчеркивания (_).

Пример: Views.All.Basic_User_Group.All_cameras_Group._10x10_All_cameras

Эти имена одинаковы для всех языков отображения клиента. Если два элемента в одной группе отличаются только специальными символами (например, Cam-1 и Cam-1), они генерируют один и тот же идентификатор, и доступен только один из них; переименуйте один из элементов, чтобы устранить коллизию.

Действия подключаемого модуля MIP, по имени

SCS.Invoke("<name>");

Самая <name> состоит из отображаемых имен, которые клиент показывает для групп и действий плагина, объединенных точками. Поскольку встраиваемое расширение определяет и может локализовать эти имена, эта форма зависит от текущего языка клиента. Если несколько действий используют одно и то же имя, обработчик сценариев отказывается от этого имени; вместо этого вызывайте действие по его идентификатору.

Действия по идентификатору

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

Независимый от языка уникальный идентификатор. Имена и идентификаторы отображаются в созданном файле сценария, если установлен флажок Включить элементы конфигурации, что позволяет скопировать точный идентификатор непосредственно в сценарий.

Чтобы просмотреть все действия, доступные в вашей системе, создайте ссылку на сценарий.

Встроенные функции

Функция

Описание

Thread.Sleep(milliseconds)

Приостанавливает выполнение сценария без зависания XProtect Smart Client. Принимает 0–30 000 мс.

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

Уведомление в области уведомлений. Он не блокирует сценарий или пользовательский интерфейс.

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>") требуется ровно одна строка аргумента.

SCS.Application.WriteLog(level, message)

Запись в MIPLog.txt. Уровень Info, Debug, или Error.

SCS.Application.GetEventWindowId()

В триггере события возвращает идентификатор окна, в котором произошло событие. Возвращает пустой текст в главном окне, в теле сценария и в ConfigurationReloadCompleted.

Примечание. Эта функция может возвращать идентификатор встроенного окна (например, области просмотра внутри вкладки), который не SCS.MultiWindow действие распознано. Сначала сравните идентификатор с известными идентификаторами плавающих окон или проигнорируйте нераспознанные идентификаторы окон.

Триггеры событий

Определить <OnEvent> блоки внутри <ScriptEngine> корневой элемент для реагирования на действия пользователя и изменения рабочей области.

Событие

Запуски

ConfigurationReloadCompleted

После каждой завершенной перезагрузки конфигурации, когда представления и вкладки устоятся. Не запускается при первом входе в систему.

SelectedViewChanged

После выбора другого представления в любом окне.

SelectedViewItemChanged

После выбора другого элемента представления в любом окне.

ShownWorkSpaceChanged

После изменения выбранной вкладки или переключения окна между режимами "Наблюдение" и "Воспроизведение".

Примечание

Некоторые рабочие области, такие как Диспетчер сигналов тревоги и Экспорт, содержат собственные встроенные области просмотра. Каждая встроенная область представления сообщает о своем создании, используя идентификатор, который не относится к плавающему окну. Таким образом, может выполняться переключение на одну из этих вкладок ShownWorkSpaceChanged несколько раз (например, Диспетчер тревог имеет две встроенные области просмотра и Экспорты имеет один, так что переключение на Диспетчер тревог может запустить триггер (до трех раз). Ваш сценарий должен игнорировать нераспознанные идентификаторы окон.

  • Триггеры событий проверяются вместе с телом сценария. Неизвестное имя события является ошибкой.

  • Активаторы событий активируются до запуска тела сценария и остаются активными до выхода из системы.

  • Активатор события не запускается снова из-за изменения, внесенного его собственными действиями.

  • В именах событий учитывается регистр.

  • Каждый тип события может быть объявлен в сценарии не более одного раза.

  • Изменения вида или вкладки, инициированные телом сценария (<Script>) также активируют эти события.

Ограничения

Ограничение

Значение

Операторов на запуск

100,000

Время выполнения на запуск

30 секунд

Thread.Sleep за вызов

30 секунд

Выполняется по триггеру события

60 в минуту Любые дополнительные запуски в эту минуту пропускаются.

Количество итераций в цикле

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