Skip to content

Command Line Options

Jump to bottom
PiTheGuy edited this page Dec 20, 2024 · 4 revisions

Command Line Options

Below is a list of supported command line options:

General Options

  • help
    Prints a help message listing all available options.

  • visualizer (String)
    Specifies which visualizer to use.

  • input (File/Folder)
    An audio file to play or a folder containing audio files.

  • url (String)
    Imports audio from a specified YouTube URL.

  • microphone
    Uses the microphone as the input source.

Visualization Options

  • size (2 Arguments)
    Specifies the width and height of the visualization. Requires two arguments: width and height.

  • targetFrameRate (Integer)
    Sets the target frame rate for the visualization

  • mono
    Disables multi-channel visualization and forces mono output.

  • raw
    Displays raw data instead of applying smoothing functions.

Playback Options

  • player
    Enables player mode, which renders the entire audio file at once rather than updating it dynamically.

  • silent
    Runs the visualization without playing the audio file.

  • loop
    Loops the audio file. Not compatible with -exitOnFinish.

  • shuffle
    Shuffles input when multiple tracks are specified.

  • exitOnFinish
    Exits the application when the audio finishes playing. Not compatible with -loop

  • force
    Attempts to read all files as audio, throwing errors on non-audio files.

Interface Options

  • hideControls
    Hides playback controls from the interface.

  • hideMenuBar
    Hides the menu bar.

  • showProgress
    Displays playback progress. Enables seeking unless -disableSeeking is also specified.

  • fullScreen
    Displays the visualization in full-screen mode.

Preferences

  • preferences (String)
    Supplies default preferences as comma-separated key=value pairs.

Supported preferences:

Key Accepted Values
foregroundColor Any color (see below)
backgroundColor Any color (see below)
playedColor Any color (see below)
dynamicIcon true or false
highContrast true or false

Defining Colors

Colors can be a hex color code (e.g. #ff8000 for orange) or one of the following pre-defined values:

black, white, red, orange, yellow, green, blue, magenta, cyan, pink, light_gray, gray, dark_gray

Export Options

  • exportImage (File)
    Exports the visualization as an image to the specified .png file.

  • exportVideo (File)
    Exports the visualization as a video to the specified .mp4 file.

  • exportGif (File)
    Exports the visualization as a GIF to the specified .gif file.

  • exportAudio (File)
    Exports the audio to the specified .wav file.

User Restrictions

  • disableVisualizerSelection
    Prevents the user from switching the visualizer during playback.

  • disableExports
    Prevents the user from exporting the visualization.

  • disableUserImports
    Prevents the user from manually importing audio files.

  • disableQueueManagement
    Prevents the user from accessing the queue management panel.

  • disablePreferences
    Disables user preferences. This prevents the user from accessing the preferences dialog, changing preferences, and prevents previously set preferences from taking effect when the application launches.

  • disableSeeking
    Disables seeking functionality on visualizers that support it.

  • disableSkipping
    Prevents skipping forward and backward in the queue. Users can still view the queue, but editing it will not be allowed.

Clone this wiki locally