diff --git a/contrib/spotifyd.conf b/contrib/spotifyd.conf index 7a00c869..4a7e6987 100644 --- a/contrib/spotifyd.conf +++ b/contrib/spotifyd.conf @@ -1,23 +1,32 @@ [global] -# Your Spotify account name. -#username = "username" -# Your Spotify account password. -#password = "password" +#---------# +# GENERAL # +#---------# -# A command that gets executed and can be used to -# retrieve your password. -# The command should return the password on stdout. -# -# This is an alternative to the `password` field. Both -# can't be used simultaneously. -#password_cmd = "pass show spotify.com" +# The name that gets displayed under the connect tab on +# official clients. +#device_name = "device_name_in_spotify_connect" + +# The displayed device type in Spotify clients. +# Can be unknown, computer, tablet, smartphone, speaker, t_v, +# a_v_r (Audio/Video Receiver), s_t_b (Set-Top Box), and audio_dongle. +#device_type = "speaker" -# If set to true, `spotifyd` tries to look up your -# password in the system's password storage. +# The directory used to store credentials and audio cache. +# Default: infers a sensible cache directory (e.g. on Linux: $XDG_CACHE_HOME) # -# Note, that the `password` field will take precedence, if set. -#use_keyring = true +# Note: The file path does not get expanded. Environment variables and +# shell placeholders like $HOME or ~ don't work! +#cache_path = "/full/path/to/cache/directory" + +# If set to true, audio data does NOT get cached. +# In this case, the cache is only used for credentials. +#no_audio_cache = true + +# The maximal size of the cache directory in bytes +# The example value corresponds to ~ 1GB +#max_cache_size = 1000000000 # If set to true, `spotifyd` tries to bind to dbus (default is the session bus) # and expose MPRIS controls. When running headless, without the session bus, @@ -33,6 +42,24 @@ # own the name. #dbus_type = "session" +#-----------# +# DISCOVERY # +#-----------# + +# If set to true, this disables zeroconf discovery. +# This can be useful, if one prefers to run a single-user instance. +#disable_discovery = false + +# The port at which `spotifyd` is going to offer its service over the network (TCP). +# If not set, a random port > 1024 is used. For the service to be discoverable on the +# local network via mDNS, both the mDNS port (5353 UDP) and the random or fixed +# zeroconf port need to be allowed through any active firewall. +#zeroconf_port = 1234 + +#-------# +# AUDIO # +#-------# + # The audio backend used to play music. To get # a list of possible backends, run `spotifyd --help`. #backend = "alsa" # use portaudio for macOS [homebrew] @@ -47,45 +74,25 @@ # "Alsa error PCM open ALSA function 'snd_pcm_hw_params_set_format' failed with error 'EINVAL: Invalid argument'" #audio_format = "S16" -# The alsa control device. By default this is the same -# name as the `device` field. -#control = "default" # omit for macOS - -# The alsa mixer used by `spotifyd`. -#mixer = "PCM" # omit for macOS - # The volume controller. Each one behaves different to # volume increases. For possible values, run # `spotifyd --help`. #volume_controller = "softvol" # use softvol for macOS -# A command that gets executed in your shell after each song changes. -#on_song_change_hook = "echo \"hook executed on $PLAYER_EVENT\"" +# ! Only relevant for ALSA ! +# The alsa control device. By default this is the same +# name as the `device` field. +#control = "default" -# The name that gets displayed under the connect tab on -# official clients. -#device_name = "device_name_in_spotify_connect" +# ! Only relevant for ALSA ! +# The alsa mixer used by `spotifyd`. +#mixer = "PCM" # omit for macOS # The audio bitrate. 96, 160 or 320 kbit/s #bitrate = 160 -# The directory used to cache audio data. This setting can save -# a lot of bandwidth when activated, as it will avoid re-downloading -# audio files when replaying them. -# -# Note: The file path does not get expanded. Environment variables and -# shell placeholders like $HOME or ~ don't work! -#cache_path = "/full/path/to/cache/directory" - -# The maximal size of the cache directory in bytes -# The example value corresponds to ~ 1GB -#max_cache_size = 1000000000 - -# If set to true, audio data does NOT get cached. -#no_audio_cache = true - # Volume on startup between 0 and 100 -# NOTE: This variable's type will change in v0.4, to a number (instead of string) +# NOTE: This variable's type will change in v0.5, to a number (instead of string) #initial_volume = "90" # If set to true, enables volume normalisation between songs. @@ -94,19 +101,16 @@ # The normalisation pregain that is applied for each song. #normalisation_pregain = -10 +#-------รค +# OTHER # +#-------# + # After the music playback has ended, start playing similar songs based on the previous tracks. +# By default, `spotifyd` infers this setting from the user settings. #autoplay = true -# The port at which `spotifyd` is going to offer its service over the network (TCP). -# If not set, a random port > 1024 is used. For the service to be discoverable on the -# local network via mDNS, both the mDNS port (5353 UDP) and the random or fixed -# zeroconf port need to be allowed through any active firewall. -#zeroconf_port = 1234 +# A command that gets executed in your shell after each song changes. +#on_song_change_hook = "echo \"hook executed on $PLAYER_EVENT\"" # The proxy `spotifyd` will use to connect to spotify. #proxy = "http://proxy.example.org:8080" - -# The displayed device type in Spotify clients. -# Can be unknown, computer, tablet, smartphone, speaker, t_v, -# a_v_r (Audio/Video Receiver), s_t_b (Set-Top Box), and audio_dongle. -#device_type = "speaker"