115 lines
4.3 KiB
ReStructuredText
115 lines
4.3 KiB
ReStructuredText
Settings
|
|
########
|
|
|
|
There are many settings available in Sublime Music. Some are application-wide
|
|
settings while others are are configurable on a per-music-provider basis.
|
|
|
|
Application Settings
|
|
--------------------
|
|
|
|
The following settings can be changed for the entire application. They can be
|
|
accessed via the gear icon in the header.
|
|
|
|
Enable Song Notifications : (``bool``)
|
|
If toggled on, a notification will be shown whenever a new song starts to
|
|
play. The notification will contain the title, artist name, album name, and
|
|
cover art of the song.
|
|
|
|
Replay Gain : (Disabled | Track | Album)
|
|
Configures the replay gain setting for the MPV player. You can disable this
|
|
setting, or configure it to work on a track or album basis.
|
|
|
|
Serve Local Files to Chromecasts on the LAN : (``bool``)
|
|
If checked, a local server will be started on your computer which will serve
|
|
your locally cached music files to the Chromecast. If not checked, the
|
|
Chromecast will always stream from the server.
|
|
If you are having trouble playing on your Chromecast, try disabling this
|
|
feature.
|
|
|
|
LAN Server Port Number : (``int``)
|
|
The port number to use for streaming to Chromecast devices on the same
|
|
LAN.
|
|
A server will be started on this port and when you play a song that is
|
|
already cached locally, the Chromecast will connect to your computer and
|
|
stream from it instead of from the internet.
|
|
|
|
Allow Song Downloads : (``bool``)
|
|
If toggled on, this will allow songs to be downloaded and cached locally.
|
|
|
|
When Streaming, Also Download Song : (``bool``)
|
|
If toggled on, when a song is streamed, it will also be downloaded. Once the
|
|
download is complete, Sublime Music will stop streaming and switch to the
|
|
downloaded version (if playing locally with MPV).
|
|
|
|
Number of Songs to Prefetch : (``int``)
|
|
If the next :math:`n` songs in the play queue are not already downloaded,
|
|
they will be downloaded.
|
|
|
|
Maximum Concurrent Downloads : (``int``)
|
|
Specifies the maximum number of songs that should be downloaded at the same
|
|
time.
|
|
|
|
Music Provider Settings
|
|
-----------------------
|
|
|
|
Each server has the following configuration options:
|
|
|
|
Music Provider Name : (``string``)
|
|
The friendly name of this server which is used throughout the UI to
|
|
differentiate music providers.
|
|
|
|
Subsonic Music Provider Settings
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
The following settings are configurable when using Subsonic as the music
|
|
provider.
|
|
|
|
Server Address : (URI)
|
|
The URI of the Subsonic-API-compliant server (specify the server root, do
|
|
not include ``/api`` or any other suffix). If you don't include ``https://``
|
|
at the front o
|
|
|
|
Username : (``string``)
|
|
The username to login as.
|
|
|
|
Password : (``string``)
|
|
The password to login with. Sublime Music will attempt to store it in the
|
|
system keyring, but fall back to storing it in plaintext in the
|
|
configuration.
|
|
|
|
Verify Certificate : (``bool``, default ``True``)
|
|
Whether or not to verify the SSL certificate of the server.
|
|
|
|
.. danger::
|
|
|
|
Only turn this off if you are *absolutely certain* that your connection
|
|
to your server is secure. One reasons this may be necessary is if you
|
|
have a self-signed certificate.
|
|
|
|
Sync Play Queue : (``bool``, default ``True``)
|
|
If on, Sublime Music will periodically save the play queue state so that you
|
|
can resume on other devices.
|
|
|
|
.. admonition:: Details
|
|
|
|
Sublime Music will synchronise the play queue and song progress to the
|
|
server every 15 seconds while playing a song. It will also sync whenever
|
|
a song is is paused/played, or when the play queue is edited, and
|
|
whenever a new song is started.
|
|
|
|
Local Network SSID : (``string``)
|
|
If Sublime Music is connected to the given SSID, the Local Network Address
|
|
will be used instead of the Server address when making network requests.
|
|
|
|
.. admonition:: Details
|
|
|
|
If this SSID is active (as reported by NetworkManager), then the *Local
|
|
network address* will be used to connect to the Subsonic-API-compliant
|
|
server instead of the *Server address*.
|
|
|
|
This is useful if your internet provider does not allow you to connect to
|
|
your internal network using the external IP of your network.
|
|
|
|
Local Network Address : (``string``)
|
|
See *Local network SSID*
|