You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
close

Launch Desktop Client with CLI

------------------------- 

Affected Roles: System Owner • System Administrator

Related DW Spectrum VMS Apps: DW Spectrum Desktop

Difficulty: Medium

------------------------- 

What is the benefit of launching with the CLI?

Launching the Desktop client with the CLI gives you a lot more flexibility. The CLI allows you to launch it normally without any changes but you can also change its behavior by utilizing specific parameters. It can facilitate many tasks such as server auto-login, disabling auto-updates, creating multiple instances of the client, restricting options, and more.

How to launch via CLI:

In Windows:

  1. Open Command Prompt and enter:
     

cd C:\Program Files\Digital watchdog\DW Spectrum\Client

  1. Now to view all installed versions enter:
     

dir

  1. Choose a version: [VERSION = Your version number (e.g., 3.2.0.28738)]
     

cd VERSION

  1. Launch the client (no parameter):
     

applauncher

  1. Launch the client (with parameter):
     

applauncher --layout-name="Example"

In Linux:

  1. Open Terminal and enter:
     

cd /opt/digitalwatchdog/client/VERSION/bin

  • VERSION Example:  cd /opt/digitalwatchdog/client/4.2.0.32842/bin
  1. View all installed versions:
     

ls

  1. Choose a version: VERSION= Your version number (e.g., 4.2.0.32842)
     

cd VERSION/bin

  1. Launch the client (no parameter):
     

./applauncher

  1. Launch the client (with parameter):
     

applauncher --layout-name="Example"

Command-line parameters (v4.0+):


 

Parameter


 

Description

Default implied value


 

Examples

--no-single-application

Allows to have more than one instance of the client application running. (Also disables 'Beta version' warning message.)

true

--no-single-application

--auth

Auto-login to the target server

-

--auth=http://admin:[email protected]:7001

--screen

Open client on the target screen

-

--screen=1

--window-geometry

Place the client window to the target coordinates and resize it

-

--window-geometry=100,100,1024x768

--soft-yuv

Enables video shader software emulation mode. May cause glitches.

true

--soft-yuv


 

--local-settings

Changes settings source from registry to file system (Windows only)

true


 

--local-settings

--no-fullscreen

Open client in the windowed mode. May cause glitches.

true

--no-fullscreen


 

--skip-media-folder-scan

Do not scan media folders. Local resources will not be displayed.

true

--skip-media-folder-scan


 

--override-version

Override software version of the client with the provided value. Will change auto-updates behavior.

-

--override-version=2.3.0.8574






 

--log-level

Minimal level of the log messages that should be recorded to log-file.

Allowed values:

  • none - fully disable logging
  • always
  • error
  • warning
  • info
  • debug
  • verbose

-

--log-level=always

--no-client-update

Disable client auto-update and update notifications.

true

--no-client-update

--acs

ACS mode (for Paxton integrations and similar scenarios)

true

--acs



 

--videowall

Start client in the master videowall mode. Must contain GUID of the existing

Video Wall to work properly.

Requires valid --auth key without specified credentials.

-

--videowall={72934575-ceb7-54bb-23a0-84b81cf1d3f1}


--videowall-instance

Start client in the slave videowall mode. Must contain the GUID of the existing Video Wall Item to work properly. Requires valid--videowall key. Requires valid --auth key without specified credentials.

-

--videowall-instance={8692e6e8-ceb7-54bb-23a0-84b81cf1d3f0}

--light-mode

Start client in the light mode. Can contain 'full' or a numeric value.

full

--light-mode=full

--light-mode=7

--customization

Start client with custom skin, loaded from the target folder.

Works only if the client is built with ENABLE_DYNAMIC_CUSTOMIZATION define.

-

--customization=e:\my_skin

--instant-drop

Inner key to open files in the new window.

-

--instant-drop=<base64-serialized-value>

--delayed-drop

Inner key to open cameras in the new window.

-

--delayed-drop=<base64-serialized-value>

--layout-name

Name of layout which will be opened after connection to server.

-

--layout-name="Some layout name"

--show-full-info

Display full info on cameras instead of the minimal.

true

--show-full-info

--no-hidpi

Disable hidpi support

true

--no-hidpi

v3.2 and below:

--dev-mode-key

Enables developer mode if the key is equal to “razrazraz”

-

--dev-mode-key=razrazraz

--profiler

Switch client to the profiler mode.

true

--profiler


 

--no-version-mismatch-check

Do not show a warning dialog if servers in the system have different versions.

true

--no-version-mismatch-check

--no-vsync

Disable VSync. (May cause glitches.)

true

--no-vsync



 

--ec2-tran-log-level

Minimal level of the transactions log messages that should be recorded to log-file. Allowed values are the same as in --log-level key.

none

--ec2-tran-log-level=info


 

--exception-filters

Prefixes, that will be logged as verbose.

-

--exception-filters=dw::dwsoectrum;dw::utils::Parser

  • 189
  • 25-Apr-2022
  • 2650 Views