Skip to content

Jukebox

JukeboxControl(api, subsonic)

Class that contains all the methods needed to interact with the jukebox control endpoint in the Subsonic API.

Source code in .venv/lib/python3.11/site-packages/knuckles/_jukebox.py 
16
17
18
19
20
def __init__(self, api: Api, subsonic: "Subsonic") -> None:
    self.api = api

    # Only to pass it to the models
    self.subsonic = subsonic

add(songs_ids)

Add songs to the jukebox playlist.

Parameters:

Name Type Description Default
songs_ids list[str]

A list of song IDs to add to the jukebox playlist.

 required

Returns:

Type Description
Jukebox

An object that contains the updated jukebox status and playlist.
Source code in .venv/lib/python3.11/site-packages/knuckles/_jukebox.py 
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def add(self, songs_ids: list[str]) -> Jukebox:
    """Add songs to the jukebox playlist.

    Args:
        songs_ids: A list of song IDs to add to the jukebox playlist.

    Returns:
        An object that contains the updated jukebox status
            and playlist.
    """

    response = self.api.json_request(
        "jukeboxControl", {"action": "add", "id": songs_ids}
    )["jukeboxStatus"]

    return Jukebox(self.subsonic, **response)

clear()

Clear the playlist of the jukebox.

Returns:

Type Description
Jukebox

An object that contains the updated jukebox status and playlist.
Source code in .venv/lib/python3.11/site-packages/knuckles/_jukebox.py 
135
136
137
138
139
140
141
142
143
144
145
146
def clear(self) -> Jukebox:
    """Clear the playlist of the jukebox.

    Returns:
        An object that contains the updated jukebox status
            and playlist.
    """
    response = self.api.json_request("jukeboxControl", {"action": "clear"})[
        "jukeboxStatus"
    ]

    return Jukebox(self.subsonic, **response)

get()

Get all the info related with the current playlist of the jukebox.

Returns:

Type Description
Jukebox

An object that holds all the info related with the playlist of the jukebox.
Source code in .venv/lib/python3.11/site-packages/knuckles/_jukebox.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
def get(self) -> Jukebox:
    """Get all the info related with the current playlist of
    the jukebox.

    Returns:
        An object that holds all the info related with
            the playlist of the jukebox.
    """

    response = self.api.json_request("jukeboxControl", {"action": "get"})[
        "jukeboxPlaylist"
    ]

    return Jukebox(self.subsonic, **response)

remove(index)

Remove a song from the playlist of the jukebox.

Parameters:

Name Type Description Default
index int

The index of the song to remove from the playlist.

 required

Returns:

Type Description
Jukebox

An object that contains the updated jukebox status and playlist.
Source code in .venv/lib/python3.11/site-packages/knuckles/_jukebox.py 
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
def remove(self, index: int) -> Jukebox:
    """Remove a song from the playlist of the jukebox.

    Args:
        index: The index of the song to remove from the playlist.

    Returns:
        An object that contains the updated jukebox status
            and playlist.
    """

    response = self.api.json_request(
        "jukeboxControl", {"action": "remove", "index": index}
    )["jukeboxStatus"]

    return Jukebox(self.subsonic, **response)

set(songs_ids)

Set the song playlist for the jukebox.

Parameters:

Name Type Description Default
songs_ids list[str]

A list of song IDs to set the jukebox playlist.

 required

Returns:

Type Description
Jukebox

An object that contains the updated jukebox status and playlist.
Source code in .venv/lib/python3.11/site-packages/knuckles/_jukebox.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def set(self, songs_ids: list[str]) -> Jukebox:
    """Set the song playlist for the jukebox.

    Args:
        songs_ids: A list of song IDs to set the jukebox playlist.

    Returns:
        An object that contains the updated jukebox status
            and playlist.
    """

    response = self.api.json_request(
        "jukeboxControl", {"action": "set", "id": songs_ids}
    )["jukeboxStatus"]

    # Preset the song list as this call changes it in a predictable way
    return Jukebox(
        self.subsonic, **response, entry=[{"id": song_id} for song_id in songs_ids]
    )

set_gain(gain)

Set the gain of the playback of the jukebox.

Parameters:

Name Type Description Default
gain float

A number between 0 and 1 (inclusive) to be set as the gain.

 required

Raises:

Type Description
ValueError

Raised if the given gain is not between 0 and 1.

Returns:

Type Description
Jukebox

An object that contains the updated jukebox status and playlist.
Source code in .venv/lib/python3.11/site-packages/knuckles/_jukebox.py 
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
def set_gain(self, gain: float) -> Jukebox:
    """Set the gain of the playback of the jukebox.

    Args:
        gain: A number between 0 and 1 (inclusive) to be set as the gain.

    Raises:
        ValueError: Raised if the given gain is not between 0 and 1.

    Returns:
        An object that contains the updated jukebox status
            and playlist.
    """

    if not 1 > gain > 0:
        raise ValueError("The gain should be between 0 and 1 (inclusive)")

    response = self.api.json_request(
        "jukeboxControl", {"action": "setGain", "gain": gain}
    )["jukeboxStatus"]

    return Jukebox(self.subsonic, **response)

shuffle()

Shuffle all the songs in the playlist of the jukebox.

Returns:

Type Description
Jukebox

An object that contains the updated jukebox status and playlist.
Source code in .venv/lib/python3.11/site-packages/knuckles/_jukebox.py 
165
166
167
168
169
170
171
172
173
174
175
176
177
def shuffle(self) -> Jukebox:
    """Shuffle all the songs in the playlist of the jukebox.

    Returns:
        An object that contains the updated jukebox status
            and playlist.
    """

    response = self.api.json_request("jukeboxControl", {"action": "shuffle"})[
        "jukeboxStatus"
    ]

    return Jukebox(self.subsonic, **response)

skip(index, offset=0)

Skip the playback of the current song in the jukebox playlist.

Parameters:

Name Type Description Default
index int

The index of the song to skip to.

 required
offset float

The offset of seconds to start playing the next song.

 0

Returns:

Type Description
Jukebox

An object that contains the updated jukebox status and playlist.
Source code in .venv/lib/python3.11/site-packages/knuckles/_jukebox.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
def skip(self, index: int, offset: float = 0) -> Jukebox:
    """Skip the playback of the current song in the jukebox playlist.

    Args:
        index: The index of the song to skip to.
        offset: The offset of seconds to start playing the next song.

    Returns:
        An object that contains the updated jukebox status
            and playlist.
    """

    response = self.api.json_request(
        "jukeboxControl", {"action": "skip", "index": index, "offset": offset}
    )["jukeboxStatus"]

    return Jukebox(self.subsonic, **response)

start()

Start the playback of the current song in the jukebox playlist.

Returns:

Type Description
Jukebox

An object that contains the updated jukebox status and playlist.
Source code in .venv/lib/python3.11/site-packages/knuckles/_jukebox.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
def start(self) -> Jukebox:
    """Start the playback of the current song in the jukebox playlist.

    Returns:
        An object that contains the updated jukebox status
            and playlist.
    """

    response = self.api.json_request("jukeboxControl", {"action": "start"})[
        "jukeboxStatus"
    ]

    return Jukebox(self.subsonic, **response)

status()

Get all the info related with the current state of the jukebox.

Returns:

Type Description
Jukebox

An object that holds all the info related with the scate of the jukebox.
Source code in .venv/lib/python3.11/site-packages/knuckles/_jukebox.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def status(self) -> Jukebox:
    """Get all the info related with the current state of
    the jukebox.

    Returns:
        An object that holds all the info related with
            the scate of the jukebox.
    """

    response = self.api.json_request("jukeboxControl", {"action": "status"})[
        "jukeboxStatus"
    ]

    return Jukebox(self.subsonic, **response)

stop()

Stop the playback of the current song in the jukebox playlist.

Returns:

Type Description
Jukebox

An object that contains the updated jukebox status and playlist.
Source code in .venv/lib/python3.11/site-packages/knuckles/_jukebox.py 
86
87
88
89
90
91
92
93
94
95
96
97
98
def stop(self) -> Jukebox:
    """Stop the playback of the current song in the jukebox playlist.

    Returns:
        An object that contains the updated jukebox status
            and playlist.
    """

    response = self.api.json_request("jukeboxControl", {"action": "stop"})[
        "jukeboxStatus"
    ]

    return Jukebox(self.subsonic, **response)