Skip to content

Subsonic

Subsonic(url, user, password, client, use_https=True, use_token=True, request_method=RequestMethod.GET)

Object that holds all the other helper objects to interact with the OpenSubsonic REST API.

Inside this object there are helper object that holds all the methods used to access the REST API. The methods are split following the categories listed in the OpenSubsonic REST API Spec.

Attributes:

Name Type Description
api

Helper object used to directly access the REST API of the given server.
system

Helper object used to access all system related endpoints.
browsing

Helper object used to access all system related endpoints.
lists

Helper object used to access all lists related endpoints.
searching

Helper object used to access all searching related endpoints.
playlists

Helper object used to access playlists related endpoints.
media_retrieval

Helper object used to access all media retrieval related endpoints.
media_annotation

Helper object used to access all media annotation related endpoints.
sharing

Helper object used to access all sharing related endpoints.
podcast

Helper object used to access all podcast related endpoints.
jukebox

Helper object used to access all jukebox related endpoints.
internet_radio

Helper object used to access all internet radio related endpoints.
chat

Helper object used to access all chat related endpoints.
user_management

Helper object used to access all user management related endpoints.
bookmarks

Helper object used to access all bookmarks related endpoints.
media_library_scanning

Helper object used to access all media library scanning related endpoints.

Parameters:

Name Type Description Default
url str

The URL of the Subsonic server to connect to.

 required
user str

The name of the user to authenticate.

 required
password str

The password of the user to authenticate.

 required
client str

A unique name of the client to report to the server.

 required
use_https bool

If the requests should be use of HTTPS.

 True
use_token bool

If the authentication should be made using a salted token or in plain text.

 True
request_method RequestMethod

If the requests should be made using a GET verb or a POST verb.

 GET
Source code in .venv/lib/python3.11/site-packages/knuckles/_subsonic.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def __init__(
    self,
    url: str,
    user: str,
    password: str,
    client: str,
    use_https: bool = True,
    use_token: bool = True,
    request_method: RequestMethod = RequestMethod.GET,
) -> None:
    """Construction method of the Subsonic object used to
    interact with the OpenSubsonic REST API.

    Args:
        url: The URL of the Subsonic server to connect to.
        user: The name of the user to authenticate.
        password: The password of the user to authenticate.
        client: A unique name of the client to report to the
            server.
        use_https: If the requests should be use of HTTPS.
        use_token: If the authentication should be made
            using a salted token or in plain text.
        request_method: If the requests should be made
            using a GET verb or a POST verb.
    """

    self.api = Api(
        url, user, password, client, use_https, use_token, request_method
    )
    self.system = System(self.api, self)
    self.browsing = Browsing(self.api, self)
    self.lists = Lists(self.api, self)
    self.searching = Searching(self.api, self)
    self.playlists = Playlists(self.api, self)
    self.media_retrieval = MediaRetrieval(self.api, self)
    self.media_annotation = MediaAnnotation(self.api, self)
    self.sharing = Sharing(self.api, self)
    self.podcast = Podcast(self.api, self)
    self.jukebox = JukeboxControl(self.api, self)
    self.internet_radio = InternetRadio(self.api, self)
    self.chat = Chat(self.api, self)
    self.user_management = UserManagement(self.api, self)
    self.bookmarks = Bookmarks(self.api, self)
    self.media_library_scanning = MediaLibraryScanning(self.api, self)