joshooaj
commented
4 months ago Hi @aoforb,
Yep, you can do that! Check out New-VmsView and specifically the LayoutDefinitionXml and ViewItemDefinitionXml parameters.
In XProtect, the contents of view groups including subgroups, views, their layouts, and the "view items" in each frame are defined as XML documents. Create a view the way you like it, in Smart Client, and then use Get-VmsViewGroup, and Get-VmsView to retrieve it so that you can extract the ViewItemDefinitionXml from one or more of the items in the view.
For example, I have a view group named "Shared" with a subgroup named "Home". Inside the Home group is a 2x2 view named "Cameras". I can get the xml representing the first item in the view with:
$view = Get-VmsViewGroup -Name Shared | Get-VmsViewGroup -Name Home | Get-VmsView -Name Cameras
$view.ViewItemChildItems[0].ViewItemDefinitionXmlThat will return an XML string similar to:
<?xml version="1.0" encoding="utf-8"?>
<viewitem id="61078c2f-87ac-4981-831e-eddeac55236d" displayname="Camera ViewItem" shortcut="" type="VideoOS.RemoteClient.Application.Data.ContentTypes.CameraContentType.CameraViewItem, VideoOS.RemoteClient.Application" smartClientId="c241da70-597d-4dae-b8ee-55f8e9a4ba3e">
<iteminfo cameraid="0462a451-9ea9-44f0-8fff-3e68fb80b922" lastknowncameradisplayname="Garage" livestreamid="00000000-0000-0000-0000-000000000000" imagequality="100" framerate="0" maintainimageaspectratio="True" usedefaultdisplaysettings="True" showtitlebar="True" keepimagequalitywhenmaximized="False" updateonmotiononly="False" soundonmotion="0" soundonevent="0" smartsearchgridwidth="0" smartsearchgridheight="0" smartsearchgridmask="" pointandclickmode="0" usingproperties="True" />
<properties>
<property name="cameraid" value="2f07a911-702b-440b-982b-f6cf4de82d11" />
<property name="framerate" value="0" />
<property name="imagequality" value="100" />
<property name="lastknowncameradisplayname" value="Garage" />
</properties>
</viewitem>There's also the $view.LayoutViewItems which holds the definition xml for the view layout which looks like...
<ViewItems>
<ViewItem><Position><X>0</X><Y>0</Y></Position><Size><Width>750</Width><Height>1000</Height></Size></ViewItem>
<ViewItem><Position><X>750</X><Y>0</Y></Position><Size><Width>250</Width><Height>333</Height></Size></ViewItem>
<ViewItem><Position><X>750</X><Y>333</Y></Position><Size><Width>250</Width><Height>333</Height></Size></ViewItem>
<ViewItem><Position><X>750</X><Y>666</Y></Position><Size><Width>250</Width><Height>333</Height></Size></ViewItem>
</ViewItems>I'm not sure what the XML looks like for a view item using the Bosch dewarping plugin but the pattern will be the same. You can then customize the XML as needed and create new views. This will likely take you a bit of trial and error, but once you get it working you should find it easy to automate the creation of view groups and views.
In the example below we...
- Pick a pre-defined view layout and extract the definition XML into the variable
$viewItemLayoutXml - Store the "Empty ViewItem" definition xml in
$emptyViewItemand an example of a plain camera view item in$exampleViewItem - Create an array of view item definitions with the same number of elements as there are positions in our view layout in
$viewItemDefinitions - Create a new view inside the Shared/Home view group using
$viewItemLayoutXmland$viewItemDefinitionsto define the layout of the view and the contents in each view item in the layout.
# These few lines are retrieving the 16:9 "1 + 3" view layout so we can use the layout definition xml.
$layoutGroup = ((Get-VmsManagementServer).LayoutGroupFolder.LayoutGroups | Where-Object DisplayName -eq '16:9')
$layoutDefinitionXml = [xml]($layoutGroup.LayoutFolder.Layouts | Where-Object DisplayName -eq '1 + 3').DefinitionXml
$viewItemLayoutXml = $layoutDefinitionXml.ViewLayout.ViewItems.OuterXml
# This is the XML associated with an empty view item. The viewitem id attribute should be replaced with a unique guid.
$emptyViewItem = '<viewitem id="{0}" displayname="Empty ViewItem" shortcut="" type="VideoOS.RemoteClient.Application.Data.Configuration.EmptyViewItem, VideoOS.RemoteClient.Application" smartClientId="36a9c40e-e723-4e70-a54f-5d930c23cd85"><properties /></viewitem>'
$exampleViewItem = @'
<viewitem id="{0}" displayname="Camera ViewItem" shortcut="" type="VideoOS.RemoteClient.Application.Data.ContentTypes.CameraContentType.CameraViewItem, VideoOS.RemoteClient.Application" smartClientId="c241da70-597d-4dae-b8ee-55f8e9a4ba3e">
<iteminfo cameraid="0462a451-9ea9-44f0-8fff-3e68fb80b922" lastknowncameradisplayname="Garage" livestreamid="00000000-0000-0000-0000-000000000000" imagequality="100" framerate="0" maintainimageaspectratio="True" usedefaultdisplaysettings="True" showtitlebar="True" keepimagequalitywhenmaximized="False" updateonmotiononly="False" soundonmotion="0" soundonevent="0" smartsearchgridwidth="0" smartsearchgridheight="0" smartsearchgridmask="" pointandclickmode="0" usingproperties="True" />
<properties>
<property name="cameraid" value="0462a451-9ea9-44f0-8fff-3e68fb80b922" />
<property name="framerate" value="0" />
<property name="imagequality" value="100" />
<property name="lastknowncameradisplayname" value="Garage" />
</properties>
</viewitem>
'@
$viewItemDefinitions = @(
($exampleViewItem -f (New-Guid)),
($emptyViewItem -f (New-Guid)),
($emptyViewItem -f (New-Guid)),
($emptyViewItem -f (New-Guid))
)
$viewGroup = Get-VmsViewGroup -Name Shared | Get-VmsViewGroup -Name Home
$viewGroup | New-VmsView -Name 'New View' -ViewItemDefinitionXml $viewItemDefinitions -LayoutDefinitionXml $viewItemLayoutXml
aoforb
Tarterman
Hello,
On the Smart Client we typically have a view of two panels side by side. The view is for two Bosch panoramic cameras and requires the "bosch dewarping plugin" to flatten out the image.
It requires a human to drag & drop the plugin on to each panel after the view and cameras are added.
Is it possible to automate this?
Thanks