sounds.stations
===============

.. py:module:: sounds.stations


Classes
-------

.. autoapisummary::

   sounds.stations.StationService


Module Contents
---------------

.. py:class:: StationService(streaming_service: sounds.streaming.StreamingService, schedule_service: sounds.schedules.ScheduleService, **kwargs)

   Bases: :py:obj:`sounds.base.Base`


   Base class for other classes to inherit shared session and state


   .. py:attribute:: streams


   .. py:attribute:: schedules


   .. py:method:: get_stations_detailed() -> Optional[List[sounds.models.Network]]
      :async:



   .. py:method:: get_stations(include_local: bool = False, include_streams: bool = False, include_schedules: bool = False) -> list[sounds.models.LiveStation]
      :async:


      Gets the list of all stations

      :return: A list of Station objects
      :rtype: list[Station]



   .. py:method:: get_local_stations() -> List[sounds.models.LiveStation]
      :async:



   .. py:method:: get_station_schedule(station_id: str, include_stream: bool = False, include_schedule: bool = False, date: str | None = None) -> sounds.models.LiveStation | None
      :async:


      Gets a station's details

      :return: A Station object
      :rtype: Station



   .. py:method:: get_station(station_id: str, include_stream: bool = False, stream_format: Literal['hls'] | Literal['dash'] = 'hls', include_schedule: bool = False, date: str | None = None) -> sounds.models.LiveStation | None
      :async:


      Get a live radio station

      Args:
          station_id (str): ID of the station, e.g. bbc_radio_four
          include_stream (bool, optional): Set LiveStation.stream to the stream URL. Defaults to False.
          stream_format (Literal["hls"] | Literal["dash"], optional): Stream format preference. Defaults to "hls".
          include_schedule (bool, optional): Set LiveStation.schedule to the station schedule. Defaults to False.
          date (str | None, optional): The date of the schedule, if `include_schedule` is True. Defaults to None.

      Returns:
          LiveStation | None: A LiveStation object if station_id is found



   .. py:method:: get_broadcast(pid: str)
      :async: