Skip to main content

XProtect Smart Client

Smart Client Linguagem de script e limites

Última atualização: 6 minutos de leitura
Versão2026 R2
IdiomaPortuguês

Smart Client Os scripts usam um conjunto limitado de C# dentro de XML. Quando XProtect Smart Client Carrega um arquivo de script, ele verifica o arquivo em relação a uma lista de recursos e ações de idioma permitidos. Se qualquer parte do script for inválida, o corpo do script e os disparadores de eventos não serão executados; no entanto, o <Login> O bloco ainda está aplicado.

Estrutura de arquivo

Salve o arquivo com o .scs extensão, codificada como UTF-8. Recomenda-se UTF-8 sem BOM.

Elemento

Necessário

Descrição

<ScriptEngine>

Sim

Elemento raiz.

<SchemaVersion>

Não

Versão do formato de arquivo. A versão padrão e atual é 1. Se um arquivo declarar uma versão mais recente do que a instalada XProtect Smart Client suporta, o arquivo é recusado.

<Login>

Não

Informações de login. Consulte Automatizar login com scripts.

<Script>

Não

Corpo do script. Roda uma vez por login.

<OnEvent Name="…">

Não

Disparo de evento. Um arquivo pode ter um por evento.

Nota

Elementos herdados como <ScriptExtension> e qualquer <ScriptLanguage> outros que não C# são recusados pelo mecanismo de script.)

Caracteres especiais

Leituras XML <, >e & como marcação. Envolver código de script em <![CDATA[ … ]]>, o que é recomendado ou substitua cada caractere por sua entidade XML:

Caractere

Entidade

<

&lt;

>

&gt;

&

&amp;

Idioma suportado

Variáveis

Detalhes

Variáveis

var, sequências, números inteiros e valores booleanos (ambos var e tipos explícitos, como int são suportados).

Condições

if, else if, else

Loops

for e foreach, com break e continue. foreach Funciona apenas em ações que retornam uma lista.

Operadores

+,-,*,/,+=,-=, Operadores de comparação,&&,\|\|, e posfixo i++

Sequências

Aspas duplas são recomendadas (aspas simples são aceitas pelo mecanismo, mas geram um aviso e não são C# válidas). Unir sequências com +.

Comentários

// e /* … */

Ações

Tipo de ação

Sintaxe

Observações

Ações integradas

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

Métodos diretos fornecidos pelo Smart Client mecanismo de script (por exemplo, SCS.Application.Minimize();). A maioria das ações leva argumentos.

Os grupos disponíveis são Application, Views, Browse, Camera, Ptz, MultiWindow, Generale Keyboard.

Visualizações, saídas, eventos e predefinições PTZ

SCS.Invoke("<name>");

O <name> Esse não é o nome de exibição exibido na IU. Começa com Views.All., Outputs.All., Events.All., ou Ptz.Presets., seguido pelos nomes de hierarquia configurados unidos por pontos. Qualquer caractere que não seja uma letra ou dígito alfanumérico é convertido em um sublinhado (_).

Exemplo: Views.All.Basic_User_Group.All_cameras_Group._10x10_All_cameras

Esses nomes são idênticos em todos os idiomas de exibição do cliente. Se dois itens no mesmo grupo diferirem apenas por caracteres especiais (como Cam-1 e Cam-1), eles gerarão o mesmo identificador e apenas um estará acessível; renomeie um dos itens para resolver a colisão.

Ações de plug-in do MIP, por nome

SCS.Invoke("<name>");

O <name> Consiste nos nomes de exibição que o cliente mostra para os grupos e ações do plug-in, unidos por pontos. Como o plug-in define e pode localizar esses nomes, este formulário depende do idioma do cliente atual. Se várias ações compartilharem o mesmo nome, o mecanismo de script recusa o nome; chame a ação por sua ID.

Ações por ID

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

Identificador exclusivo independente de idioma. Ambos os nomes e IDs são listados no arquivo de referência de script gerado quando Incluir itens de configuração está marcado, permitindo que você copie o ID exato diretamente em seu script.

Para ver todas as ações disponíveis em seu sistema, gere uma referência de script.

Funções integradas

Função

Descrição

Thread.Sleep(milliseconds)

Pausa o script sem congelamento XProtect Smart Client. Aceita de 0 a 30.000 ms.

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

Mostra uma notificação na área de notificação. Ele não bloqueia o script ou a interface do usuário.

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

Valores de data e hora. Você pode ler .Year, .Month, .Day, .Hour, .Minute e .Second.

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

Operações de identificador exclusivo. new Guid("<id as text>") Requer exatamente um argumento de sequência.

SCS.Application.WriteLog(level, message)

Gravações em MIPLog.txt. O nível é Info, Debug, ou Error.

SCS.Application.GetEventWindowId()

Em um disparo de evento, retorna o ID da janela onde o evento aconteceu. Retorna texto vazio para a janela principal, no corpo do script e em ConfigurationReloadCompleted.

Nota: Esta função pode retornar a ID de uma janela integrada (como uma área de visualização dentro de uma guia) que não SCS.MultiWindow A ação reconhece. Compare primeiro o ID com IDs de janela flutuante conhecidos ou ignore IDs de janela não reconhecidos.

Disparos de eventos

Definir <OnEvent> Blocos dentro do <ScriptEngine> elemento raiz para reagir às ações do usuário e alterações no espaço de trabalho.

Evento

Executar

ConfigurationReloadCompleted

Após cada recarga de configuração concluída, uma vez que as visualizações e guias forem definidas. Não é executado no primeiro login.

SelectedViewChanged

Depois que uma visualização diferente for selecionada, em qualquer janela.

SelectedViewItemChanged

Depois que um item de visualização diferente for selecionado, em qualquer janela.

ShownWorkSpaceChanged

Depois que a guia selecionada mudar, uma janela alterna entre Ao vivo e Reprodução.

Nota

Alguns espaços de trabalho, como Gerenciador de alarmes e Exportações, contêm suas próprias áreas de visualização integradas. Cada área de visualização integrada relata sua criação usando um ID que não pertence a uma janela flutuante. A alternância para uma dessas guias pode ser executada ShownWorkSpaceChanged várias vezes (por exemplo, o Gerenciador de Alarmes tem duas áreas de visualização integradas e o Exportações tem uma, então mudar para o Gerenciador de Alarmes pode executar o disparo até três vezes). Seu script deve ignorar IDs de janela não reconhecidas.

  • Os disparos de eventos são verificados junto com o corpo do script. Um nome de evento desconhecido é um erro.

  • Os disparos de evento ficam ativos antes que o corpo do script seja executado e permanecem ativos até o logout.

  • Um disparo de evento não é executado novamente devido a uma alteração feita por suas próprias ações.

  • Os nomes de eventos diferenciam maiúsculas de minúsculas.

  • Cada tipo de evento pode ser declarado no máximo uma vez em um script.

  • Alterações de visualização ou guia iniciadas pelo corpo do script (<Script>) também disparam esses eventos.

Limites

Limite

Valor

Declarações por execução

100,000

Tempo de execução por execução

30 segundos

Thread.Sleep por chamada

30 segundos

Execuções por disparo de evento

60 por minuto. Mais execuções nesse minuto serão ignoradas.

Iterações por loop

10,000

Comprimento da sequência

65.536 caracteres

Cada execução do corpo do script ou um disparo de evento tem seus próprios limites. Se uma execução atingir um limite ou uma ação falhar, o resto dessa execução para e o evento é registrado MIPLog.txt, mas XProtect Smart Client e quaisquer outros disparos de eventos continuam em execução. Quando você fizer logoff ou fechar XProtect Smart Client, ele para qualquer script em execução.

Não suportado

Não suportado

Em vez disso, use

while, do/while

for

switch

if / else if

try/catch, throw

Verifique o script… antes de implantar o script

Operador condicional (?:)

if / else

Incremento de prefixo (++i)

Incremento de pós-fixo (i++)

Interpolação de cadeias de caracteres ($"…")

+

Expressões de vírgula, várias declarações de variáveis em for

Declarações separadas

Matrizes, literais de coleção e indexação

Não suportado

%, *=, /=, %=, operadores bit a bit

Não suportado

Métodos, classes, interfaces, namespaces, dynamic

Plug-in MIP

ScriptExtension

Usar ações de script integradas ou um plug-in do MIP

Temporizadores, Task, new Thread(), async, delegados, lambdas

Thread.Sleep ou gatilhos de eventos

Acesso a arquivo, registro, rede e processo, reflexão

Plug-in MIP