Skip to content

Command Line Interface

William Hubbard edited this page Sep 17, 2021 · 1 revision

Command Line Interface

Command-line arguments

universalplayer [OPTIONS] [term...]

Arguments

term

A search term for songs to enqueue. The search term will be applied to songs based on song and album titles, and artist names. Songs that match more terms will be applied first. Any song that does not meet at least 65% of the provided terms will not be added.

Any songs that do match will be added to the queue. To replace the current queue, use the --clear option.

Options

headless

Runs the player without a GUI.


play

Starts playback


pause

Pauses playback


toggle

Toggles playback

Aliases

--toggle, -t


seek

Seeks the player to the provided time, in seconds

Arguments

time - The time to skip to, in seconds.


clear

Clears the queue before adding songs

Aliases

--clear, -c


next

Skips to the next song by skipBy songs.

Arguments

skipBy - The number of songs to skip. Optional, defaults to 1.

Aliases

--next, -n


prev

Skips to the previous song by skipBy songs.

Arguments

skipBy - The number of songs to skip. Optional, defaults to 1.

Aliases

--prev, -p


skip

Skips to the requested song in the queue.

Arguments

skipTo - The queue index to skip to. Defaults to the next song in the queue.


status

Obtains the playback status


song

Obtains the current song


queue

Gets the queue


help

Prints this help message

Aliases

--help, -h

Clone this wiki locally