Skip to content

Podcast

Channel(subsonic, id, url=None, title=None, description=None, coverArt=None, originalImageUrl=None, status=None, episode=None)

Bases: Model

Object that holds all the info about a channel.

Attributes:

Name Type Description
id str

The ID of the channel.
url str | None

The URL of the channel.
title str | None

The title of the channel.
description str | None

The description of the channel.
cover_art CoverArt | None

All the info related with the cover art of the channel.
original_image_url str | None

The URL of the original image of the channel.
status str | None

The status of the channel.
episodes list[Episode] | None

List that holds all the info about all the episodes of the channel.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_podcast.py 
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
def __init__(
    self,
    subsonic: "Subsonic",
    id: str,
    url: str | None = None,
    title: str | None = None,
    description: str | None = None,
    coverArt: str | None = None,
    originalImageUrl: str | None = None,
    status: str | None = None,
    episode: list[dict[str, Any]] | None = None,
) -> None:
    super().__init__(subsonic)

    self.id = id
    self.url = url
    self.title = title
    self.description = description
    self.cover_art = CoverArt(self._subsonic, coverArt) if coverArt else None
    self.original_image_url = originalImageUrl
    self.status = status
    self.episodes = (
        [Episode(self._subsonic, **episode_data) for episode_data in episode]
        if episode
        else None
    )

create()

Create a new podcast with the info of the current one.

Returns:

Type Description
Self

The object itself.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_podcast.py 
186
187
188
189
190
191
192
193
194
195
196
197
198
199
def create(self) -> Self:
    """Create a new podcast with the info of the current one.

    Returns:
        The object itself.
    """

    # Ignore the None type error as the server
    # should return an Error Code 10 in response
    self._subsonic.podcast.create_podcast_channel(
        self.url  # type: ignore[arg-type]
    )

    return self

delete()

Delete the podcast from the server.

Returns:

Type Description
Self

The object itself.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_podcast.py 
201
202
203
204
205
206
207
208
209
210
def delete(self) -> Self:
    """Delete the podcast from the server.

    Returns:
        The object itself.
    """

    self._subsonic.podcast.delete_podcast_channel(self.id)

    return self

generate()

Return a new channel 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
Channel

A new object with all the updated info.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_podcast.py 
173
174
175
176
177
178
179
180
181
182
183
184
def generate(self) -> "Channel":
    """Return a new channel 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.
    """

    return self._subsonic.podcast.get_podcast_channel(self.id)

Episode(subsonic, id, streamId=None, channelId=None, title=None, description=None, publishDate=None, status=None, parent=None, isDir=None, year=None, genre=None, coverArt=None, size=None, contentType=None, suffix=None, duration=None, bitRate=None, path=None)

Bases: Model

Object that holds all the info about a episode

Attributes:

Name Type Description
id

(str) The ID of the episode
stream_id str | None

The ID of the stream of the episode.
channel Channel | None

The channel where the episode is from.
title str | None

The title of the episode.
description str | None

The description of the episode.
publish_date datetime | None

The timestamp when the episode was publised.
status str | None

The status of the episode.
parent str | None

The ID of the parent of the episode.
is_dir bool | None

If the episode is a directory.
year int | None

The year when the episode was released.
genre str | None

The name of the genre of the episode.
cover_art CoverArt | None

All the info related with the cover art of the episode.
size int | None

The size of the episode.
content_type str | None

The HTTP Content-Type of the file of the episode.
suffix str | None

The suffix of the filename of the file of the episode.
duration int | None

The duration in seconds of the episode.
bit_rate int | None

The bit rate of the episode.
path str | None

The path of the episode.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_podcast.py 
43
44
45
46
47
48
49
50
51
52
53
54
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
def __init__(
    self,
    subsonic: "Subsonic",
    id: str,
    streamId: str | None = None,
    channelId: str | None = None,
    title: str | None = None,
    description: str | None = None,
    publishDate: str | None = None,
    status: str | None = None,
    parent: str | None = None,
    isDir: bool | None = None,
    year: int | None = None,
    genre: str | None = None,
    coverArt: str | None = None,
    size: int | None = None,
    contentType: str | None = None,
    suffix: str | None = None,
    duration: int | None = None,
    bitRate: int | None = None,
    path: str | None = None,
) -> None:
    super().__init__(subsonic)

    self.id = id
    self.stream_id = streamId
    self.channel = Channel(self._subsonic, channelId) if channelId else None
    self.title = title
    self.description = description
    self.publish_date = parser.parse(publishDate) if publishDate else None
    self.status = status
    self.parent = parent
    self.is_dir = isDir
    self.year = year
    self.genre = genre
    self.cover_art = CoverArt(self._subsonic, coverArt) if coverArt else None
    self.size = size
    self.content_type = contentType
    self.suffix = suffix
    self.duration = duration
    self.bit_rate = bitRate
    self.path = path

delete()

Delete the episode from the server.

Returns:

Type Description
Self

The object itself.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_podcast.py 
117
118
119
120
121
122
123
124
125
126
def delete(self) -> Self:
    """Delete the episode from the server.

    Returns:
        The object itself.
    """

    self._subsonic.podcast.delete_podcast_episode(self.id)

    return self

download()

Request the server to download the episode.

Returns:

Type Description
Self

The object itself.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_podcast.py 
106
107
108
109
110
111
112
113
114
115
def download(self) -> Self:
    """Request the server to download the episode.

    Returns:
        The object itself.
    """

    self._subsonic.podcast.download_podcast_episode(self.id)

    return self

generate()

Return a new episode 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
Episode

A new object with all the updated info.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_podcast.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def generate(self) -> "Episode":
    """Return a new episode 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_episode = self._subsonic.podcast.get_podcast_episode(self.id)

    if get_episode is None:
        raise ResourceNotFound(
            "Unable to generate episode as it does not exist in the server"
        )

    return get_episode