Skip to content

Internet Radio Station

InternetRadioStation(subsonic, id, name, streamUrl, homepageUrl)

Bases: Model

Object that holds all the info about a Internet radio station.

Attributes:

Name Type Description
id str

The ID of the Internet radio station.
name str

Then name of the Internet radio station.
stream_url str

The URL of the stream of the Internet radio station.
homepage_url str

The URl of the hompage of the Internet radio station.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_internet_radio_station.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
def __init__(
    self,
    subsonic: "Subsonic",
    id: str,
    name: str,
    streamUrl: str,
    homepageUrl: str,
) -> None:
    super().__init__(subsonic)

    self.id = id
    self.name = name
    self.stream_url = streamUrl
    self.homepage_url = homepageUrl

create()

Create a new Internet radio station for the authenticated user with the same data of the object where this method is called.

Returns:

Type Description
Self

The object itself.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_internet_radio_station.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def create(self) -> Self:
    """Create a new Internet radio station for the authenticated user
    with the same data of the object where this method is
    called.

    Returns:
        The object itself.
    """

    self._subsonic.internet_radio.create_internet_radio_station(
        self.stream_url, self.name, self.homepage_url
    )

    return self

delete()

Delete the Internet radio station entry from the server.

Returns:

Type Description
Self

The object itself.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_internet_radio_station.py 
87
88
89
90
91
92
93
94
95
96
def delete(self) -> Self:
    """Delete the Internet radio station entry from the server.

    Returns:
        The object itself.
    """

    self._subsonic.internet_radio.delete_internet_radio_station(self.id)

    return self

generate()

Return a new album 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
InternetRadioStation | None

A new object with all the updated info.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_internet_radio_station.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def generate(self) -> "InternetRadioStation | None":
    """Return a new album 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_station = self._subsonic.internet_radio.get_internet_radio_station(self.id)

    if get_station is None:
        raise ResourceNotFound(
            (
                "Unable to generate internet radio station"
                + "as it does not exist in the server"
            )
        )

    return get_station

update()

Update the info about the Internet radio station using the current data of the object.

Returns:

Type Description
Self

The object itself.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_internet_radio_station.py 
73
74
75
76
77
78
79
80
81
82
83
84
85
def update(self) -> Self:
    """Update the info about the Internet radio station using the
    current data of the object.

    Returns:
        The object itself.
    """

    self._subsonic.internet_radio.update_internet_radio_station(
        self.id, self.stream_url, self.name, self.homepage_url
    )

    return self