Categories
Knowledge Support Support exacqVision Client Categories Products Uncategorized

XDV Reference

*** INTERNAL USE ***

Type Definitions

  • Integer – Numeric value
  • Bool – 1 or 0 value where 1 is ‘enabled’ and 0 is ‘disabled’
  • String – Any text value
  • DIP – Device Independent Pixel (represents screen coordinates and sizes)
    • Windows
      • If the system is not using any sort of DPI or screen scaling represents actual pixel values
      • If screen scaling is in use then this number is multiplied by the scaling value
        • Example: A 4k monitor would typically use 200% scaling. A value of 1920 would represent your full display width (1920 * 200% = 3840)
    • Other platforms
  • Epoch – Numeric value representing the number of seconds since January 1st, 1970

The options described in the documentation below are listed in dictionary values, where possible. This is indicated by the key values listed between curly braces ‘{ }’. The key is followed by the description of the key value is colon separated, as in the following example:

    {key1:description1, key2:description2, …}

More than one Instance or Item tag may be defined.

Tags and attributes not included use client defaults.

<br>

XDV / XML Structure

&lt;exacqVision Init&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Instance&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Live&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Layout&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Item/&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Layout&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;System&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Video&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Input/&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Video&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Audio&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;Input&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Audio&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/System&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Live&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Instance&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Systems&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&lt;/Systems&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&lt;SecurityIntegrations/&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Sync/&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Alerts/&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&lt;HWAccel/&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Joystick&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&lt/Joystick&gt;
&lt;/exacqVision Init&gt;

<br>

exacqVision Init Attributes

AllowAccelerators
ShowSunkenBorder bool {0:disabled, 1:enabled}
ShowRecStatusBorder bool {0:disabled, 1:enabled}
ShowPTZFocusBorder bool {0:disabled, 1:enabled}
ShowOnScreeDisplay bool {0:disabled, 1:enabled}
UseOsdColor bool {0:disabled, 1:enabled}
Use OSD color for Serial Profiles
KeepAspectRatio bool {0:disabled, 1:enabled}
Keep aspect ratio during resize
RestoreOnAttnReq bool {0:disabled, 1:enabled}
Restore client on user attention request
MySystemsColMask
EntCamColMask
AnalogCamColMask
IPCamColMask
EntCamFilterTreeSize integer (DIP value)
Width of filter tree panel on Enterprise Cameras
NonEntCamFilterTreeSize integer (DIP value)
Width of filter tree panel on Camera Recordings
VGAAccelMode
VGAAccelColorspace
DisplayAdapter
TimelapsePlaybackInterval integer {0-15}
Immediate jump to next frame if gap exceeds X seconds
PanelSizeRatio integer {0:content, 1:window, 2:16×9, 3:4×3}
CameraSortOrder integer {0:default order, 1:ascending, 2:descending}
GroupsSortOrder integer {0:default order, 1:ascending, 2:descending}
MapsSortOrder integer {0:default order, 1:ascending, 2:descending}
ViewsSortOrder integer {0:default order, 1:ascending, 2:descending}
EventsSortOrder integer {0:default order, 1:ascending, 2:descending}
BookmarksSortOrder integer {0:default order, 1:ascending, 2:descending}
ReportsSortOrder integer {0:default order, 1:ascending, 2:descending}
LiveAudioLipSync integer {0:auto, 1:enabled, 2:disabled}
AudioInputDevice integer
0 indexed list based on client detected devices
MuteDuringTwoWayAudio bool {0:disabled, 1:enabled}
AutoFillEmptyVideoPanels bool {0:disabled, 1:enabled}
CPUDecompResult
EnableIndicators bool {0:disabled, 1:enabled}
Show notifications for indicators
ConfirmClose bool {0:disabled, 1:enabled}
Prompts user for confirmation when attempting to close client window
CollapseLiveAutoContexts bool {0:disabled, 1:enabled}
Hide individual quality streams
CombineRegionOfInterestStreams bool {0:disabled, 1:enabled}
Manage all streams as quality streams
CameraPreviewMode integer {0:no preview, 1:thumbnail, 2:video
ShowSystemGroups bool {0:disabled, 1:enabled}
Show system group folders
RequireSSLCert bool {0:disabled, 1:enabled}
Require SSL certificate validation
UseSparseConnections bool {0:disabled, 1:enabled}
Use dynamic connections
SparseSystemCount integer
Number of systems using dynamic connections
EnableAllAnalytics bool {0:disabled, 1:enabled}
NormalLayoutCollapseMode integer {0:auto, 1:expanded, 2:collapsed}
EventButtonCollapseMode
LastUsedNormalLayout
LastUsedWidescreenLayout deprecated
LastUsedEventButton
DeblockingMode integer {0:auto, 1:enabled, 2:disabled}
H.264 deblocking, attempts to smooth sharp edges of decoded compressed video blocks
DirectSearch integer {0:disabled, 1:prefer system video, 2:prefer archive video, 3:prefer cloud video}
LastUsedLayout string
Language
Caption string
Title of the client window
ViewLayout integer
Number of panels in startup layout
LegacyAuthentication integer {0:only if required, 1:force, 2:never}
To be deprecated
TimeoutEnabled bool {0:disabled, 1:enabled}
Inactivity timeout
TimeoutMinutes integer {1-100}
KeepAliveSeconds
CurrentTheme string {light:Light, dark:Dark, classic:Classic}
DisableLiveStreams bool {0:disabled, 1:enabled}
Prevents user from viewing live video, does not affect search
Use12HourClock bool {0:disabled, 1:enabled}
TemperatureScale bool {0:Fahrenheit, 1:Celsius}
LicenseWarningAck bool {0:disabled, 1:enabled}
LicenseExpirationAck epoch
AutoCheckForClientUpdates bool {0:disabled, 1:enabled}
Found on client About pop-up
ShowNotificationsForIndicators bool {0:disabled, 1:enabled}
StartUpInstanceCount integer
Number of client instances to open
IgnoredVersion
SendAnonymousData bool {0:disabled, 1:enabled}
Found on client About pop-up
MotionColor integer {0-16777215}
Decimal color value
AlarmColor integer {0-16777215}
Decimal color value
FreeRunColor integer {0-16777215}
Decimal color value
PTZFocusColor integer {0-16777215}
Decimal color value
EventMonitorColor integer {0-16777215}
Decimal color value
BookmarkColor integer {0-16777215}
Decimal color value
NoColor integer {0-16777215}
Decimal color value
ClientIniAutoUpdateEna bool {0:disabled, 1:enabled}
Toggles automatic import on Add Systems
ClientIniAutoUpdateUrl string (path or url address to XDV file to import)
HWAccelLimit
ShowTrayIcon bool {0:disabled, 1:enabled}
Shows icon for Client instance in System Tray
See also: How to Configure No Close Client Usage
Delete bool {0:disabled, 1:enabled}
Disabling prevents Client instance closure.
See also: How to Configure No Close Client Usage

Instance Attributes

Number integer
Client instance number
Top integer (distance from top of desktop where client window begins)
Left integer (distance from left edge of desktop where client window begins)
Width integer (width of client window from left point)
Height integer (height of client window from top point)
Maximize bool {0:disabled, 1:enabled}
Client window fills screen or not
FullScreen bool {0:disabled, 1:enabled}
Fills screen and hides window controls (F11)
ShowToolbars bool {0:disabled, 1:enabled}
Hide/show toolbar (F8)
ShowNavPanel bool {0:disabled, 1:enabled}
Hide/show nav panel (F4)
LiveMode integer {0:cameras, 1:groups, 2:maps, 3:views}
Client opens with Live nav panel to the selected option
LiveModeNavButtons integer {0:collapsed, 1:cameras, 2:groups, 3:maps, 4:all expanded}
Expanded or collapsed level of nav panel buttons
SearchModeNavButtons integer {0:collapsed, 1:cameras, 2:groups, 3:maps, 4:views, 5:events, 6:bookmarks/cases}
Expanded or collapsed level of search panel buttons
RemoteControlEnabled bool {0:disabled, 1:enabled}
Toggles receiving of video push display
RemoteControlName string
MainSashPos integer (width of left side nav panel)
PTZControlLeft integer (distance from left edge of desktop where ptz pop-up begins)
PTZControlTop integer (distance from top edge of desktop where ptz pop-up begins)
SoftTriggerControlWidth integer (width of soft trigger pop-up from left point)
SoftTriggerControlHeight integer (height of soft trigger pop-up from top point)
SoftTriggerControlLeft integer (distance from left edge of desktop where soft trigger pop-up begins)
SoftTriggerControlTop integer (distance from top edge of desktop where soft trigger pop-up begins)
TwoWayAudioDialogWidth integer (width of two-way audio pop-up from left point)
TwoWayAudioDialogHeight integer (height of two-way audio pop-up from top point)
TwoWayAudioDialogLeft integer (distance from left edge of desktop where two-way audio pop-up begins)
TwoWayAudioDialogTop integer (distance from top edge of desktop where two-way audio pop-up begins)
RemoteControlDialogWidth integer (width of video push pop-up from left point)
RemoteControlDialogHeight integer (height of video push pop-up from top point)
RemoteControlDialogLeft integer (distance from left edge of desktop where video push pop-up begins)
RemoteControlDialogTop integer (distance from top edge of desktop where video push pop-up begins)
RemoteControlGUID string

Live Attributes

View string (name of View)
Tour string (name of Tour)
EventMonitor string (name of Event Monitoring profile)
Must be Switch View type
StartLayout

Layout Attributes

Name string (layout name)
Rows integer (number of video panel rows to allot)
Cols integer (number of video panel columns to allot)

Item Attributes

X integer (beginning column number)
Y integer (beginning row number)
Width integer (number of columns to merge)
Height integer (number of rows to merge

System Attributes

Name string (host/IP:port)

Video Attributes

Position
Name string
CameraID integer
Device string (IP address)
DeviceMac string (MAC address)
Number integer
Context
AutoContext integer
ToggleAnalytics integer

Audio Attributes

Name string
Device string (IP address)
DeviceMac string (MAC address)
Number integer
Context

Systems Attributes

Address
Port
Group
Name
AllowSave
Username
Password
PasswordType
Enabled
Latency
ExportPermission
EnterpriseManaged
UseSystemLogin
SupportsTargetSearch
IsEdgeServer
ExpandedInCamTree
FailoverState
Model
Serial
Package
Version
MAC
License
IsLicensed
IsEnterprise
IsEnterpriseEx
Expiration

Security Integrations

AlwaysPrompt bool

Sync Attributes

Enabled
ConnectedOnce
SyncFrequency
CredsSingleSignOn
CredsPrompt
Username
Password
PasswordType
UpdaterPath
UpdateCheckInterval
ForcedUpdates