Remote Relay

class AzuracastPy.models.RemoteRelay(id: int, display_name: str, is_visible_on_public_pages: bool, type: str, is_editable: bool, enable_autodj: bool, autodj_format: str, autodj_bitrate: int, custom_listen_url: str, url: str, mount: str, admin_password: str, source_port: int, source_mount: str, source_username: str, source_password: str, is_public: bool, listeners_unique: int, listeners_total: int, links: Links, _station)

Represents a remote relay on a station.

__init__(id: int, display_name: str, is_visible_on_public_pages: bool, type: str, is_editable: bool, enable_autodj: bool, autodj_format: str, autodj_bitrate: int, custom_listen_url: str, url: str, mount: str, admin_password: str, source_port: int, source_mount: str, source_username: str, source_password: str, is_public: bool, listeners_unique: int, listeners_total: int, links: Links, _station)

Initializes a RemoteRelay object.

Note

This class should not be initialized directly. Instead, obtain an instance via: create(), __call__() or remote_relays().

delete()

Deletes the remote relay from the station.

Sets all attributes of the current RemoteRelay object to None.

Usage:

remote_relay.delete()
edit(station_listening_url: str | None = None, remote_type: RemoteTypes | None = None, display_name: str | None = None, station_listening_mount_point: str | None = None, station_admin_password: str | None = None, show_on_public_pages: bool | None = None, enable_autodj: bool | None = None, autodj_format: Formats | None = None, autodj_bitrate: Bitrates | None = None, station_source_port: int | None = None, station_source_mount_point: str | None = None, station_source_username: str | None = None, station_source_password: str | None = None, is_public: bool | None = None)

Edits the remote relay’s properties.

Updates all edited attributes of the current RemoteRelay object.

Parameters:

  • station_listening_url – (Optional) The new URL of the listening station. Default: None.

  • remote_type – (Optional) The new type of the remote station. Default: None.

  • display_name – (Optional) The new display name of this relay when viewing it on administrative or public pages. Default: None.

  • station_listening_mount_point – (Optional)

  • station_admin_password – (Optional) The new admin password. Default: None.

  • show_on_public_pages – (Optional) Determines whether listeners can select this relay on this station’s public pages. Default: None.

  • enable_autodj – (Optional) Determines whether the AutoDJ on this installation will automatically play music to this mount point. Default: None.

  • autodj_format – (Optional) The format of the music played by AutoDJ. Default: None.

  • autodj_bitrate – (Optional) The bitrate of the music played by AutoDJ. Default: None.

  • station_source_port – (Optional)

  • station_source_mount_point – (Optional)

  • station_source_username – (Optional) If you are broadcasting using AutoDJ, enter the source username here. This may be blank. Default: None.

  • station_source_password – (Optional) If you are broadcasting using AutoDJ, enter the source password here. Default: None.

  • is_public – (Optional) Determines whether this relay will be advertised on “Yellow Pages” public radio directories. Default: None.

Usage:

remote_relay.edit(
    display_name="New display name",
    enable_autodj=False
)