Skip to content

Play Queue

PlayQueue(subsonic, entry, current=None, position=None, username=None, changed=None, changedBy=None)

Bases: Model

Object that holds al the info about a play queue.

Attributes:

Name Type Description
songs list[Song]

All the info about all the songs in the play queue.
current Song | None

The current playing song in the play queue.
position int | None

The index of the current playing song in the play queue.
user User | None

The user owner of the play queue.
changed timedate | None

The timestamp when the play queue received any change.
changed_by str | None

The name of the client that made the last modification to the play queue.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_play_queue.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def __init__(
    self,
    subsonic: "Subsonic",
    entry: list[dict[str, Any]],
    current: str | None = None,
    position: int | None = None,
    username: str | None = None,
    changed: str | None = None,
    changedBy: str | None = None,
) -> None:
    super().__init__(subsonic)

    self.current = Song(self._subsonic, current) if current else None
    self.position = position
    self.user = User(self._subsonic, username) if username else None
    self.changed = parser.parse(changed) if changed else None
    self.changed_by = changedBy
    self.songs = [Song(self._subsonic, **song) for song in entry] if entry else None

generate()

Return a new play queue object with all the data updated from the API, using the endpoint that return the most information possible.

Useful for making copies with updated data or updating the object itself with immutability, e.g., foo = foo.generate().

Returns:

Type Description
PlayQueue

A new object with all the updated info.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_play_queue.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def generate(self) -> "PlayQueue":
    """Return a new play queue object with all the data updated from the API,
    using the endpoint that return the most information possible.

    Useful for making copies with updated data or updating the object
    itself with immutability, e.g., `foo = foo.generate()`.

    Returns:
        A new object with all the updated info.
    """

    get_play_queue = self._subsonic.bookmarks.get_play_queue()

    return get_play_queue

save()

Calls the "savePlayQueue" endpoint of the API.

Saves the play queue using the parameters in the object.

:return: description :rtype: Self

Source code in .venv/lib/python3.11/site-packages/knuckles/models/_play_queue.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
def save(self) -> Self:
    """Calls the "savePlayQueue" endpoint of the API.

    Saves the play queue using the parameters in the object.

    :return: _description_
    :rtype: Self
    """

    song_ids: list[str] = [song.id for song in self.songs] if self.songs else []

    self._subsonic.bookmarks.save_play_queue(
        song_ids, self.current.id if self.current else None, self.position
    )

    return self