VideoWall-objektet

VideoWall-objektet representerar en videovägg i serverkonfigurationen. Det går således inte att skapa egna videoväggsobjekt direkt i skript, utan dessa måste skapas i Admin.

Egenskaper i VideoWall-objektet

Name

Returnerar namnet på videoväggen som det är definierat i serverkonfigurationen

ID

Är det interna IDt på det här videoväggsobjektet.

Den här metoden används för att tillfälligt släcka (eller tända upp) videoväggen (eller en monitor på videoväggen). Exempelvis kan man använda denna metod för att släcka videoväggen när en operatör loggar ut. Under ytan fortsätter videoväggen att fungera, varför aktuellt läge omedelbart kommer att visas när man väljer att tända videoväggen igen.

monitor är en siffra från 0 till och med antalet monitorer som är definierat på videoväggen. 0 innebär att alla monitorer på videoväggen släcks/tänds samtidigt.

blank anger om monitorn ska släckas (true) eller tändas (false),

ClearMonitor(monitor[, keepLayout])

Den här metoden används för att rensa layouten på specificerad monitor på videoväggen. Samtliga kameravyer rensas och blir tomma (svarta)

monitor är en siffra från 0 till och med antalet monitorer som är definierat på videoväggen. 0 innebär att alla monitorer på videoväggen rensas samtidigt.

keepLayout anger om aktuell layout ska bibehållas (true) eller om layouten ska återställas till en 1x1-vy (false eller ej angiven).

GetCameraViewProperty(monitor, row, col, property)

Den här metoden används för att hämta värde för angiven property för den kameravy som definieras av parametrarna monitor, row och col. Om kameravyn inte existerar, returneras false.

monitor är en siffra från 1 till och med antalet monitorer som är definierat på videoväggen.

row är en siffra mellan 1 och antalet rader i layouten.

col är en siffra mellan 1 och antalet kolumner i layouten.

property är en konstant som beskriver den egenskap du vill hämta värdet för. Dessa konstanter är beskrivna i avsnitt 3.35.4 nedan.

GetCurrentLayoutName(monitor)

Returnerar namnet på den aktuella layouten eller en tom sträng om ingen layout används.

monitor är en siffra från 1 till och med antalet monitorer som är definierat på videoväggen.

MaximizeCameraView(monitor, row, col, maximized)

Den här metoden används för att maximera/återställa utpekad kameravy på monitorn.

monitor är en siffra från 1 till och med antalet monitorer som är definierat på videoväggen.

row är en siffra mellan 1 och antalet rader i layouten.

col är en siffra mellan 1 och antalet kolumner i layouten.

maximized anger om kameravyn ska maximeras (true) eller återställas (false).

PlayPausePlayer(monitor, row, col, forward, paused)

Den här metoden används för att starta/stoppa uppspelning av inspelad video på videoväggen.

monitor är en siffra från 1 till och med antalet monitorer som är definierat på videoväggen.

row är en siffra mellan 1 och antalet rader i layouten.

col är en siffra mellan 1 och antalet kolumner i layouten.

forward anger om uppspeling ska ske framåt (true) eller bakåt (false).

paused anger om uppspeling ska ske stoppa (true) eller starta (false).

PlayPauseRound(monitor, row, col[, paused])

Den här metoden används för att starta/stoppa en rondering på videoväggen.

monitor är en siffra från 1 till och med antalet monitorer som är definierat på videoväggen.

row är en siffra mellan 1 och antalet rader i layouten.

col är en siffra mellan 1 och antalet kolumner i layouten.

paused anger om rondering ska stoppas (true) eller startas (false). Om parametern utelämnas så växlar ronderingen till att stoppas/startas baserat på aktuell status.

SelectLayout(monitor, layoutName[, camSrcMonitor, camSrcLayoutName, camSrcRow, camSrcCol, camDstRow, camDstCol] …)

Den här metoden används för att välja in en ny, fördefinierad layout på en monitor. Det finns också möjlighet att samtidigt kopiera en eller flera kameravyer från en annan monitor/layout/kameravy.

monitor är en siffra från 1 till och med antalet monitorer som är definierat på videoväggen.

layoutName anger namnet på den fördefinierade layout du vill välja in.

Nedanstående parametrar är valfria, men om de används, måste samtliga parametrar anges. Det går också att lägga till flera omgångar av dessa parametrar, så att flera kameravyer kopieras samtidigt.

camSrcMonitor är en siffra från 1 till och med antalet monitorer som är definierat på videoväggen.

camSrcLayoutName anger namnet på den layout du vill kopiera ifrån.

camSrcRow är en siffra från 1 till och med antalet rader i käll-layouten.

camSrcCol är en siffra från 1 till och med antalet kolumner i käll-layouten.

camDstRow är en siffra från 1 till och med antalet rader i layouten du kopiera till (layoutName).

camDstCol är en siffra från 1 till och med antalet kolumner i layouten du kopierar till (layoutName).

SetLayout(monitor, MonitorLayout object[, layoutName[, forcedLayout]])

Den här metoden används för att knyta en layout till en viss monitor på videoväggen. MonitorLayout-objektet kan innehålla flera namngivna layouter. Då bör du ange vilken layout som ska användas på monitorn.

monitor är en siffra från 0 till och med antalet monitorer som är definierat på videoväggen. 0 innebär att alla monitorer på videoväggen rensas samtidigt.

MonitorLayout object är en referens till ett MonitorLayout-objekt som definierats tidigare.

layoutName anger namnet på den layout i MonitorLayout-objektet som ska användas.

forcedLayout anger om den utpekade layouten ska ersätta en annan layout som redan används på monitorn (true) eller inte (false eller utelämnad).

SetPopupMenu(monitor, MonitorPopupMenu object)

Den här metoden används för att knyta en popupmeny till en viss monitor på videoväggen.

monitor är en siffra från 0 till och med antalet monitorer som är definierat på videoväggen. 0 innebär att alla monitorer på videoväggen rensas samtidigt.

MonitorPopupMenu object är en referens till ett MonitorPopupMenu-objekt som definierats tidigare.

ShowCamera(monitor, row, col[, cameras[, interval = 10]])

Den här metoden används för att visa en eller flera kameror i en specificerad kameravy på en monitor på videoväggen. Om du skickar in fler än en kamera (en lista på kameror), skapas automatiskt en rondering med angiven intervalltid. I annat fall visas helt enkelt live video för angiven kamera.

monitor är en siffra från 1 till och med antalet monitorer som är definierat på videoväggen.

row är en siffra mellan 1 och antalet rader i layouten.

col är en siffra mellan 1 och antalet kolumner i layouten.

cameras är en lista med referenser till kameror, kameraidn eller klientkameranamn. Utesluter du denna parameter, rensas kameravyn och blir svart.

interval är en siffra, som anger hur ofta man byter till en nästa kamera i listan av kameror. Är bara relevant om du skickar in mer än en kamera.

ShowCamera(monitor, row, col[, camera[, target[, margin = 1000]]])

Den här metoden används för att visa live video eller inspelad video från en kamera i en specificerad kameravy på en monitor på videoväggen. Om du utesluter parametrarna target och margin, kommer live video att visas. I annat fall visas inspelad video för den tidpunkt target anger.

monitor är en siffra från 1 till och med antalet monitorer som är definierat på videoväggen.

row är en siffra mellan 1 och antalet rader i layouten.

col är en siffra mellan 1 och antalet kolumner i layouten.

camera är en referens till en kamera, ett kameraid eller klientkameranamn. Utesluter du denna parameter, rensas kameravyn och blir svart.

target är ett datumobjekt eller en sträng i datumformat som anger den tidpunkt du vill börja visa inspelad video för.

margin är en siffra som anger marginalen runt tidpunkten target och används för att hitta en inspelad bild så nära target som möjligt, men inom marginalen. Standard är 1000 ms. En för snäv marginal kan göra att det inte visas något inspelad video eftersom det inte finns någon inspelad bild för exakt den tidpunkten.

StepEvent(monitor, row, col, forward)

Den här metoden används för hoppa till nästa/föregående videosegment i en kameravy som visar inspelad video på en monitor på videoväggen.

monitor är en siffra från 1 till och med antalet monitorer som är definierat på videoväggen.

row är en siffra mellan 1 och antalet rader i layouten.

col är en siffra mellan 1 och antalet kolumner i layouten.

forward anger om du vill hoppa framåt (true) eller bakåt (false) till nästa/föregående videosegment.

StepFrame(monitor, row, col, forward)

Den här metoden används för hoppa till nästa/föregående bild i en kameravy som visar inspelad video på en monitor på videoväggen.

monitor är en siffra från 1 till och med antalet monitorer som är definierat på videoväggen.

row är en siffra mellan 1 och antalet rader i layouten.

col är en siffra mellan 1 och antalet kolumner i layouten.

forward anger om du vill hoppa framåt (true) eller bakåt (false) till nästa/föregående bild.

StepRound(monitor, row, col, forward)

Den här metoden används för hoppa till nästa/föregående kamera i en rondering på en monitor på videoväggen.

monitor är en siffra från 1 till och med antalet monitorer som är definierat på videoväggen.

row är en siffra mellan 1 och antalet rader i layouten.

col är en siffra mellan 1 och antalet kolumner i layouten.

forward anger om du vill hoppa framåt (true) eller bakåt (false) till nästa/föregående kamera.

Händelser i VideoWall-objektet

Det finns ett par händelser du kan lyssna till i ditt skript. Gemensamt för dem är att du får tillgång till ett event-objekt som har ett antal egenskaper. Exakt vilka egenskaper som är tillgängliga beror på typen av händelse.

onLayoutSelected

Denna händelse avfyras när en användare väljer in en layout från popupmenyn i en videoväggsrepresentation. Händelsen kan exempelvis användas för att göra egna justeringar av layouten som väljs in av användaren. Standarsbeteendet är att den nya layouten börjar visas med de kameror som fanns i den förra gången den visades. Det finns möjlighet att i stället själv hantera vilka kameror som ska visas i den nya layouten. I det fall måste du anropa:

event.preventDefault();

för att tala om att du själv har hanterat händelsen och att du inte vill att standardimplementationen ska användas.

Exempel:

videoWall.onLayoutSelected = function(event)
{
Debug.Print("onLayoutSelected - " + event.MonitorNum + " - " + event.CurrentLayout + " - " + event.NewLayout);
}

Det här exemplet skriver ut vilken monitor användaren högerklickade i samt den nuvarande layouten och den nya layouten.

Följande egenskaper finns i event-objektet:

MonitorNum innehåller en siffra som motsvarar den monitor på videoväggen där användaren, i videoväggsrepresentationen, högerklickade för att visa popupmenyn, där han sedan valde den nya layouten.

Row innehåller en siffra som motsvarar den rad där användaren högerklickade i på monitorn i videoväggsrepresentationen.

Col innehåller en siffra som motsvarar den kolumn där användaren högerklickade på monitorn i videoväggsrepresentationen.

CurrentLayout innehåller namnet på den aktuella layouten.

NewLayout innehåller namnet på den nya layouten användaren valde i popupmenyn.

onPopupMenuOpening

Denna händelse avfyras när en användare högerklickar i videoväggsrepresentationen, precis innan popupmenyn visas. Det finns möjlighet att dölja menyalternativ som inte är relevanta av någon anledning.

Följande egenskaper finns i event-objektet:

Row innehåller en siffra som motsvarar den rad där användaren högerklickade i på monitorn i videoväggsrepresentationen.

Col innehåller en siffra som motsvarar den kolumn där användaren högerklickade på monitorn i videoväggsrepresentationen.

CurrentLayout innehåller namnet på den aktuella layouten.

CameraViewType innehåller en sträng som beskriver vad det är för vytyp i den kameravy användaren högerklickade i. Möjliga värden är Unused, Camera, Round, Picture, Hotspot, Web, MiniPlayer.

PopupMenuName innehåller namnet på den popupmeny som knutits till den monitor användaren högerklickade på.

PopupMenu.

PopupMenu. Alla menyalternativ som definierats för popupmenyn listas här. Du kan sätta dem till false för att dölja den i menyn eller till true för att visa dem. Standardvärdet är att alla menyalternativ visas.

onPopupMenuItemClick

Denna händelse avfyras när en användare väljer ett menyalternativ i popupmenyn som visas när man högerklickar på en monitor i videoväggsrepresentationen. Alla funktioner i popupmenyn måste hanteras manuellt i skript. Det kan handla om att växla in en speciell layout, radera en kamera från videoväggen eller skapa en rondering.

Denna händelse avfyras också när användaren har en kameravy på videoväggsrepresentationen i fokus (grön rektangel) och klickar på en knapp på joysticken eller keypaden som är konfigurerad till någon av följande funktioner:

Maximize

NextWindow

PrevWindow

Freeze

MiniPlayer

ManualRecording

PlayPause

NextFrame

NextRecording

PrevFrame

PrevRecording

KeyF1

KeyF2

KeyF3

KeyF4

KeyF5

KeyF6

KeyF7

KeyF8

KeyF9

KeyF10

I detta fall, är det viktigt att du flaggar i skriptet om du manuellt hanterar något av dessa funktioner genom att anropa preventDefault();

Exempel:

videoWall.onPopupMenuItemClick = function(event)
{
if (event.PopupMenuItem == "PlayPause")
{
if (event.CurrentLayout == "Round")
{
videoWall.PlayPauseRound(event.MonitorNum, 2, 1);
videoWall.PlayPauseRound(event.MonitorNum, 2, 2);
videoWall.PlayPauseRound(event.MonitorNum, 2, 3);
//Mark that we have handled the event, so that the default implamentation is not used
event.preventDefault();
}
}
}

Följande egenskaper finns i event-objektet:

Row innehåller en siffra som motsvarar den rad där användaren högerklickade i på monitorn i videoväggsrepresentationen.

Col innehåller en siffra som motsvarar den kolumn där användaren högerklickade på monitorn i videoväggsrepresentationen.

CurrentLayout innehåller namnet på den aktuella layouten.

CameraViewType innehåller en sträng som beskriver vad det är för vytyp i den kameravy användaren högerklickade i. Möjliga värden är Unused, Camera, Round, Picture, Hotspot, Web, MiniPlayer.

PopupMenuName innehåller namnet på den popupmeny som knutits till den monitor användaren högerklickade på.

PopupMenuItem innehåller namnet på det menyalternativ användaren klickade på i popupmenyn eller namnet på den joystickknappfunktion som den knapp användaren klickat på på joysticken eller keypaden är konfigurerad till.

Konstanter i VideoWall-objektet

Kameravyegenskaper

Dessa konstanter används av metoden GetCameraViewProperty i parameter property.

VIDEO_WALL_PROPERTY_HEIGHT - 0

VIDEO_WALL_PROPERTY_WIDTH - 1

VIDEO_WALL_PROPERTY_VIEWTYPE - 2

VIDEO_WALL_PROPERTY_IS_FIXED - 3

VIDEO_WALL_PROPERTY_IS_RECORDED_VIDEO - 4

VIDEO_WALL_PROPERTY_IS_ROUND - 5

VIDEO_WALL_PROPERTY_IS_RECORDED_VIDEO_ALLOWED- 6

Ethiris Admin Manual