sounds.streaming
================

.. py:module:: sounds.streaming


Classes
-------

.. autoapisummary::

   sounds.streaming.StreamingService


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

.. py:class:: StreamingService(auth_service: sounds.auth.AuthService, 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:: auth_service


   .. py:attribute:: schedule_service


   .. py:method:: get_postcasts()
      :async:



   .. py:method:: get_podcast(urn=None, pid=None, include_episodes=True) -> sounds.models.Podcast | sounds.models.RadioSeries
      :async:



   .. py:method:: get_podcast_episodes(pid) -> Optional[List[sounds.models.PodcastEpisode | sounds.models.RadioShow | sounds.models.RadioClip]]
      :async:



   .. py:method:: get_podcast_episode(pid, include_stream=False) -> sounds.models.PodcastEpisode
      :async:



   .. py:method:: get_radio_series(urn, include_episodes=True) -> sounds.models.RadioSeries
      :async:



   .. py:method:: get_radio_show(pid, include_stream=False) -> sounds.models.RadioShow
      :async:



   .. py:method:: get_live_stream(station_id: str, stream_format: Literal['hls'] | Literal['dash'] = 'hls') -> Optional[str]
      :async:



   .. py:method:: get_best_stream(streams: dict, prefer_type: Literal['hls'] | Literal['dash'] = 'hls') -> Optional[str]

      Looks for the first valid stream with the requested format.



   .. py:method:: get_episode_stream(episode_id: str, stream_format: Literal['hls'] | Literal['dash'] = 'hls') -> str | None
      :async:


      Gets the stream for a specified episode.

      :param episode_id: str
      :returns: Stream object of stream information
      :rtype: str | None



   .. py:method:: get_by_pid(pid, include_stream=False, stream_format: Literal['hls'] | Literal['dash'] = 'hls') -> sounds.models.SoundsTypes
      :async:



   .. py:method:: get_pid_container(pid) -> List[sounds.models.PlayableItem] | None
      :async:



   .. py:method:: get_container(urn)
      :async:



   .. py:method:: get_heartbeat_details(pid)
      :async:



   .. py:method:: update_play_status(pid: str, elapsed_time: int, action: sounds.constants.PlayStatus)
      :async:



   .. py:method:: get_category(category) -> sounds.models.Category
      :async:



   .. py:method:: get_collection(pid) -> sounds.models.Collection
      :async:



   .. py:method:: search(query) -> sounds.models.SearchResults
      :async:



   .. py:method:: get_show_segments(vpid) -> List[sounds.models.Segment]
      :async: