Command Line Arguments
Headless (Streamer, Linux only)
The --headless flag runs the Streamer application in headless mode, meaning the GUI is not rendered to the screen.
Useful for running Streamer as a service, e.g. on an embedded system such as the NVIDIA Jetson platform.
The flag has no effect on non-Linux platforms.
Configurator (Streamer)
The --configurator flag enables a Player application with the Streamer Configurator entity to connect to and configure a Streamer, without an active Remote Streamer connection.
This is useful when setting up a headless Streamer on a platform without a monitor.
Windowless
The --windowless flag runs the Player or Streamer application in windowless mode, meaning that the window is hidden from the user.
The GUI sidebar can be toggled with the Toggle Hide GUI shortcut (default CTRL+H).
Allow Multiple Streamers
The --multiple-streamers flag can be set in order to run multiple streamers on the same computer.
Project
The --project [path] flag loads the given project file at startup.
A project file path can also be passed as a positional argument, but in that case it must appear at the end of the command line (after all flags). Otherwise the path may be consumed as a value for the preceding flag. Using --project [path] is unambiguous regardless of position.
|
Plugin Parameters
The --plugin-param [key] [value] flag passes a key/value parameter to plugins. The flag may be repeated to pass multiple parameters.