Skip to content

Instantly share code, notes, and snippets.

@yuujii
Last active July 21, 2020 02:34
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save yuujii/ec387c8b2e4923bf5806c422dbb98ba5 to your computer and use it in GitHub Desktop.
Save yuujii/ec387c8b2e4923bf5806c422dbb98ba5 to your computer and use it in GitHub Desktop.
VDCLI.exe(Virtual Device Command Line Interface) output.log #ML1
C:\Unity\MagicLeap\mlsdk\v0.19.0>C:/Unity/MagicLeap/mlsdk/v0.19.0/VirtualDevice/bin/VDCLI.exe
Virtual Device Command Line Interface
error: expected a command
ABOUT: VDCLI is the Command Line Front End for Magic Leap Remote
OPTIONS:
[-h | --help] - this screen
[-s | --start-server] - starts the server if it is not already started
[-r | --restart-server] - kills and restarts the VDS if it is already started
[-m | --manifest] <manifest path> ...
- can be passed with -r or -s to start the VDS with
non-default manifests, or issued after start to
update the current manifests. Manifests may be
listed in any order (device, channel, mixer).
[-t | --list-servers] - list the running servers
[-k | --kill-server] - kills the VDS if it is already running
[-S | --server-status] - retrieves and prints the current VDS status
(online/offline)
[-v | --version] - retrieves and prints the VDS version number
[-P | --parsable-output]- sets output to be simplified for scriptable parsing
[-c | --list-channels] - retrieves and prints the list of registered
VDS channels.
Can be passed one of the following sorting
arguments: (n=name, l=label, t=type)
[-d | --list-devices] - retrieves and prints the list of registered
VDS devices
[-a | --list-mlsdk-applications]
- lists the mlsdk applications currently registered
via the shim
[-Q | --list-active-device-applications]
- lists the device applications currently running
with sparse devices registered with the VDS
[-O | --list-available-device-applications]
- lists the device applications that can be launched
by the vds through the --launch-device-application
[-R | --launch-device-application] <device application name> <label override>
- launches the given device application if it is
registered with the VDS, optionally overriding the
application's label
[-Rn | --no-auto-mapping]
- disables auto-mapping of producer channels of
launched device application sparse devices.
[-T | --kill-device-application] <device application label>
- kills the given device application label by issuing
a shutdown request to any sparse device associated
with the app
[-e | --list-device] <device name>
- retrieves and prints info for a single device
including its channel information
[-E | --list-devices-of-type] <device type>
- retrieves and prints all devices of a given
device type
[-l | --list-channel-mapping]
- retrieves and prints the current device mapping for
all channels
[-p | --list-channel-devices] <channel name> [<channel name 2>]
- retrieves and prints the list of potential devices
for this channel
[-q | --list-device-channels] <device name> [<device name 2>]
- retrieves and prints the list of potential channels
provided by this device
[--list-device-properties] <device name> [<device name 2>]
- retrieves and prints the available configuration
properties for the device name given.
[-D | --list-device-config] <device name> [<device name 2>]
- retrieves and prints the list of configuration
settings for the device name given.
[--list-channel-data] [<channel name> ...]
- prints the current data and override data for the
given channel(s), or all channels if none provided.
[--set-prune-thresholds] <spinup ms> <heartbeat ms>
- set the thresholds for pruning inactive devices
(less than zero means no timeout)
[-u | --prune-device] <device name>
- unregisters the given device as if it had timed out
[-n | --map-device] <device name> [<device 2>]
- maps all registered producer channels for a
given device.
[-o | --unmap-device] <device name> [<device 2>]
- unmaps all registered producer channels for a
given device.
[-M | --map-channel] <channel name> <device name> [<channel 2> <device 2>]
- maps the given device to the given channel if
appropriate. Can be passed with -r or -s to map
at startup or issued after start to update the map.
(Implies --list-channel-mapping)
[-U | --unmap-channel] <channel name> <device name> [<channel 2> <device 2>]
- unmaps the given device from the given channels if
currently mapped. (Implies --list-channel-mapping)
[-N | --null-mapping] - forces all channels to unmap. Can be passed with
-r or -s at startup or issued after start to update
the map
[-A | --save-mapping] <channel map path>
- saves the current channel mapping to the given file
path. File format is in a channel,device pair list.
[-L | --load-mapping] <channel map path>
- loads the current channel mapping to the given file
path. File format is in a channel,device pair list.
[-C | --set-device-config] <device name> <config name> <config value> ...
- updates the given device's configuration setting
to the config value for the config name given.
--reset-device-config <device name> [<config name> ...]
- updates the given device's configuration setting
by resetting all settings or only the named ones.
RECORD/PLAYBACK OPTIONS:
[-G | --recording-status] [<recorder device name>]
- prints the recording status of all recorder devices
or just the status of the given optional device name
[-H | --playback-status] [<playback device name>]
- prints the playback status of all playback devices
or just the status of the given optional device name
[--recording-archive-path] [<recorder device name>]
- prints the current recorder archive paths
[--playback-archive-path] [<recorder device name>]
- prints the current playback recording archive paths
[-J | --start-recording] [<recording archive path> <recorder device name>]
- issues a start recording message if a recorder
device is available for recording, it sends the
recording archive path with name as the recording archive
file to record to
[-K | --stop-recording] [<recorder device name>]
- issues a stop recording message to any active
recorder device (unless a recorder device name is
specified, then only that device is stopped)
and prints the recording archive location(s)
[-F | --start-playback] [<recording archive path> <playback device name>]
- issues a start playback message if a playback
device is available for playback, it sends the
recording archive path as the recording archive file
to playback
[-I | --stop-playback] [<playback device name>]
- issues a stop playback message to any active
playback device (unless a playback device name is
specified, then only that device is stopped)
[--load-playback] [<recording archive path> <playback device name>]
- issues a load playback archive message if a playback
device is available for playback, it sends the
recording archive path as the recording archive file
to load
[--unload-playback] [<playback device name>]
- issues an unload playback archive message to any active
playback device (unless a playback device name is
specified, then only that device is unloaded)
LOGGING OPTIONS:
[-V... | --verbosity ...]
- control logging verbosity; use -Vh for help
for log files based on -Vf/--logfile <path>:
--list-logs - list existing log files and quit
--purge-old-logs - delete log files generated before midnight today
--purge-all-logs - delete all log files
ML1 DEVICE OPTIONS:
--device "default"|<serial>|<address:port>
- select a remote ML1 device accessible by mldb;
either the default device or a specific device
via USB <serial> or over wifi at <address:port>
--connect <remote port>
- connect using <remote port> as reported by the ML1
--disconnect
- disconnect from a remote ML1 device previously
connected via --connect
STATISTICS OPTIONS:
--dump-stats-for <device name>
- print out statistics collected from the device
--dump-stats
- print out statistics collection for all connected
devices
--enable-auto-stats
- enables automatic device stat collection
--disable-auto-stats
- disables automatic device stat collection
DIAGNOSTICS OPTIONS:
--opengl-status
- print OpenGL status of the local machine
--monitor-status
- print information about detected monitors
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment