Skip to content

configuration.md

Latest commit

 

History

History
73 lines (58 loc) · 4.6 KB

configuration.md

File metadata and controls

73 lines (58 loc) · 4.6 KB
Raw

configuration and usage

documentation index · project readme

linking your own app

you can create an application in the spotify developer dashboard to use a public-facing redirect_uri. the configured URI must match the dashboard entry.

  1. go to the spotify developer dashboard
  2. create a new application
  3. add an exact redirect URI such as https://radio.example:3443/login
  4. enable the Web Playback SDK and Web API
  5. copy the client ID
./target/release/spotifm --redirect-uri https://radio.example:3443/login --client-id a1b2c3d4e5f6

files and precedence

file/dir primary secondary tertiary
config.toml --conf FILE ./config.toml $XDG_CONFIG_HOME/spotifm/config.toml
playlists/ $XDG_DATA_HOME/spotifm/playlists/ ~/.local/share/spotifm/playlists/ when XDG_DATA_HOME is unset --
credentials.json $XDG_CACHE_HOME/spotifm/ $XDG_CACHE_HOME/librespot/ $XDG_CACHE_HOME/*/librespot/
rspotify_token.json $XDG_CACHE_HOME/spotifm/ -- --
cert.pem and key.pem tls_cert and tls_key, or --tls-cert and --tls-key $XDG_CACHE_HOME/spotifm/tls/ --
spotifm.log $XDG_CACHE_HOME/spotifm/ ~/.cache/spotifm/ when XDG_CACHE_HOME is unset .spotifm_cache/ fallback

configuration options and command-line flags

toml parameter cli flag short default value description
(none) --conf FILE -c ./config.toml if present, otherwise $XDG_CONFIG_HOME/spotifm/config.toml config file path
api_ip --api-ip -s 0.0.0.0 address for both HTTP and HTTPS servers
api_port --api-port -p 3333 HTTP player/API port
tls_port --tls-port (none) 3443 HTTPS player/API port
tls_cert --tls-cert FILE (none) generated certificate PEM certificate or certificate-chain file; requires tls_key
tls_key --tls-key FILE (none) generated private key PEM private-key file; requires tls_cert
client_id --client-id -d d420a117a32841c2b3474932e49fb54b spotify client ID
redirect_uri --redirect-uri -r http://127.0.0.1:3333/login registered redirect URI for a custom Web API client; bundled loopback clients use api_port
oauth_ip --oauth-ip -S 0.0.0.0 oauth listener address
oauth_port --oauth-port -P redirect URI port oauth listener port override
no_browser --no-browser [BOOL] -x false prevent opening the authorization page
skip_import --skip-import [BOOL] -X false skip importing ncspot/librespot credentials
url_file --url-file -u none authorization URL output file
bitrate --bitrate -b 320 spotify source bitrate in kbps (96, 160, or 320) and {bitrate} pipeline value
queue_size --queue-size -Q 32 broadcast buffer capacity
max_buffers --max-buffers -M 10 gstreamer appsink buffer limit and {max_buffers} pipeline value
silence_interval --silence-interval -I 40 milliseconds between idle silence chunks
lyrics_interval --lyrics-interval -L 250 milliseconds between lyrics websocket updates
capacity --capacity -C 1024 lyrics websocket broadcast capacity
pipeline --pipeline -g passthrough passthrough, opus, vorbis, mp3, or a custom pipeline name
stream_endpoint --stream-endpoint -E /listen audio-stream path
player_endpoint --player-endpoint -e / web-player path
player --player PATH -w ./player local player directory or index.html path
gst_pipelines.<name> (config only) (none) built-in mp3, opus, and vorbis pipelines custom or overridden gstreamer pipeline template
[[api_key]] (config only) (none) none API key with key and a scope array

custom gstreamer pipelines

spotifm uses pipeline = "passthrough" by default. select opus, vorbis, mp3, or a custom pipeline name to use gstreamer instead.

custom pipelines are defined under [gst_pipelines] in config.toml and must:

  1. contain a raw pcm appsrc named src
  2. end with an appsink named sink

the available template values are {bitrate} and {max_buffers}.

For low-latency Ogg output, keep oggmux page delay below the lyric update interval. The built-in Opus and Vorbis pipelines use max-delay=20000000 max-page-delay=20000000 (20 ms).