Skip to main content

XProtect Smart Client

Smart Client skriptspråk och begränsningar

Senaste uppdatering: Lästid: 5 min.
Version2026 R2
SpråkSvenska

Smart Client skript använder en begränsad uppsättning C# i XML. När XProtect Smart Client läser in en skriptfil, kontrollerar den filen mot en lista med tillåtna språkfunktioner och åtgärder. Om någon del av skriptet är ogiltigt, körs inte skriptets brödtext och händelseutlösare, däremot <Login> Blocket tillämpas fortfarande.

Filstruktur

Spara filen med .scs tillägg, kodad som UTF-8. UTF-8 utan strukturlista rekommenderas.

Element

Obligatorisk

Beskrivning

<ScriptEngine>

Ja

Rotelement.

<SchemaVersion>

Nej

Filformatsversion. Standard och aktuell version är 1. Om en fil deklarerar en nyare version än den installerade XProtect Smart Client stöder, filen nekas.

<Login>

Nej

Inloggningsinformation. Se Automatisera inloggning med skript.

<Script>

Nej

Skripttext. Körs en gång per inloggning.

<OnEvent Name="…">

Nej

Händelseutlösare. En fil kan ha en per händelse.

Notera

Äldre element som <ScriptExtension> och varje <ScriptLanguage> andra än C# nekas av skriptmotorn.)

Specialtecken

XML-läsningar <, >, och & som markering. Radbryt skriptkod i <![CDATA[ … ]]>, vilket rekommenderas, eller ersätt varje tecken med dess XML-enhet:

Tecken

Entitet

<

&lt;

>

&gt;

&

&amp;

Språk som stöds

Variabler

Detaljer

Variabler

var, strängar, heltal och booleska värden (båda var och explicita typer som int stöds).

Villkor

if, else if, else

Slingor

for och foreach, med break och continue. foreach fungerar bara för åtgärder som returnerar en lista.

Operatörer

+,-,*,/,+=,-=, jämförelseoperatörer,&&,\|\|, och postfix i++

Strängar

Dubbla citattecken rekommenderas (enkla citattecken accepteras av motorn men genererar en varning och är inte giltiga C#). Gå med i strängar med +.

Kommentarer

// och /* … */

Åtgärder

Åtgärdstyp

Syntax

Anteckningar

Inbyggda åtgärder

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

Direkta metoder som tillhandahålls av Smart Client skriptmotor (till exempel SCS.Application.Minimize();). De flesta åtgärder tar argument.

De tillgängliga grupperna är Application, Views, Browse, Camera, Ptz, MultiWindow, General, och Keyboard.

Vyer, utdata, händelser och PTZ-förinställningar

SCS.Invoke("<name>");

Den <name> är inte det visningsnamn som visas i användargränssnittet. Det börjar med Views.All., Outputs.All., Events.All.,eller Ptz.Presets., följt av de konfigurerade hierarkinamn som förenats med punkter. Alla tecken utom en alfanumerisk bokstav eller siffra konverteras till ett understreck (_).

Exempel: Views.All.Basic_User_Group.All_cameras_Group._10x10_All_cameras

Dessa namn är identiska över alla klientvisningsspråk. Om två objekt i samma grupp bara skiljer sig åt med specialtecken (som kamera 1 och kamera 1) genererar de samma identifierare, och bara en kan nås. Byt namn på ett av objekten för att lösa konflikten.

MIP-plugin-åtgärder, efter namn

SCS.Invoke("<name>");

Den <name> består av de visningsnamn som klienten visar för plugin-programmets grupper och åtgärd, sammanfogade med punkter. Eftersom plugin anger och kan lokalisera dessa namn, beror detta formulär på aktuellt klientspråk. Om flera åtgärder har samma namn nekar skriptmotorn namnet. Anropa istället åtgärden med dess ID.

Åtgärder per ID

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

Språkoberoende unik identifierare. Både namn och ID listas i den genererade skriptreferensfilen när Inkludera konfigurationsobjekt är markerat, vilket låter dig kopiera exakt ID direkt till ditt skript.

För att se alla åtgärder tillgängliga på ditt system, generera en skriptreferens.

Inbyggda funktioner

Funktion

Beskrivning

Thread.Sleep(milliseconds)

Pausar skriptet utan att frysa XProtect Smart Client. Accepterar 0–30 000 ms.

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

Visar en avisering i aviseringsområdet. Det blockerar inte skriptet eller användargränssnittet.

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

Datum- och tidsvärden. Du kan läsa .Year, .Month, .Day, .Hour, .Minute och .Second.

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

Åtgärder för unik identifierare. new Guid("<id as text>") kräver exakt ett strängargument.

SCS.Application.WriteLog(level, message)

Skriver till MIPLog.txt. Nivån är Info, Debug,eller Error.

SCS.Application.GetEventWindowId()

I en händelseutlösare, returnerar ID för fönstret där händelsen inträffade. Returnerar tom text för huvudfönstret, i skriptets brödtext och i ConfigurationReloadCompleted.

Obs! Den här funktionen kan returnera ID för ett inbäddat fönster (t.ex. ett visningsområde på en flik) som inte SCS.MultiWindow åtgärden känner igen. Jämför ID med kända ID för flytande fönster först, eller ignorera okända fönster-ID.

Händelseutlösare

Ange <OnEvent> block inom <ScriptEngine> rotelement för att reagera på användaråtgärder och ändringar på arbetsytan.

Händelse

Kör

ConfigurationReloadCompleted

Efter varje slutförd konfigurationsladdning, när vyer och flikar har kvittats. Körs inte vid första inloggning.

SelectedViewChanged

Efter att en annan vy har valts, i ett fönster.

SelectedViewItemChanged

Efter att ett annat visningselement valts, i ett fönster.

ShownWorkSpaceChanged

Efter att den valda fliken ändras, eller ett fönster växlar mellan Live och Uppspelning.

Notera

Vissa arbetsytor, som Larmhanteraren och Exporter, innehåller sina egna inbäddade visningsområden. Varje inbäddat visningsområde rapporterar att det skapats med ett ID som inte tillhör ett flytande fönster. Att växla till en av dessa flikar kan därför köras ShownWorkSpaceChanged flera gånger (till exempel har Larmhanteraren två inbäddade visningsområden och Exporterna har ett, så att växla till Larmhanteraren kan köra utlösaren upp till tre gånger). Ditt skript bör ignorera okända fönster-ID.

  • Händelseutlösare kontrolleras tillsammans med skripttexten. Ett okänt händelsenamn är ett fel.

  • Händelseutlösare blir aktiva innan skriptkroppen körs och förblir aktiva tills utloggning.

  • En händelseutlösare körs inte igen på grund av en ändring som gjorts av dess egna åtgärder.

  • Händelsenamn är skiftlägeskänsliga.

  • Varje händelsetyp kan deklareras högst en gång i ett skript.

  • Vy- eller flikändringar initierade av skripttexten (<Script>) utlöser även dessa händelser.

Gränser

Begränsning

Värde

Utdrag per körning

100,000

Körtid per körning

30 sekunder

Thread.Sleep per samtal

30 sekunder

Kör per händelseutlösare

60 per minut. Inga fler körningar under den minuten hoppas över.

Iterationer per slinga

10,000

Stränglängd

65 536 tecken

Varje körning av skripttexten eller en händelseutlösare har sina egna gränser. Om en körning når en gräns eller en åtgärd misslyckas, stannar resten av körningen och händelsen loggas in MIPLog.txt, men XProtect Smart Client och alla andra händelseutlösare fortsätter att köras. När du loggar ut eller stänger XProtect Smart Client, stoppar det skript som körs.

Stöds inte

Stöds inte

Använd istället

while, do/while

for

switch

if / else if

try/catch, throw

Verifiera skript… innan du distribuerar skriptet

Villkorlig operatör (?:)

if / else

Prefixökning (++i)

Ökning av postfix (i++)

Stränginterpolering ($"…")

+

Komma-uttryck, flera variabeldeklarationer i for

Separata satser

Matriser, samlingslitteraler och indexering

Stöds inte

%, *=, /=, %=, bitvisa operatörer

Stöds inte

Metoder, klasser, gränssnitt, namnutrymmen, dynamic

MIP-insticksmodul

ScriptExtension

Använd inbyggda skriptåtgärder eller en MIP-plugin

Timer, Task, new Thread(), async, delegater, lambda

Thread.Sleep eller händelseutlösare

Fil-, register-, nätverks- och processåtkomst, reflektion

MIP-insticksmodul