Support for Artist radio stations (#870)

* Initial support of artist radio stations

* Fix docstring

* Change to a singular optional station

* Change to a property

* Revert property

* Explicitly set librarySectionID

Co-authored-by: JonnyWong16 <[email protected]>

Co-authored-by: JonnyWong16 <[email protected]>

Author: jjlawren

plexapi/audio.py

@@ -8,6 +8,7 @@
 from plexapi.mixins import AdvancedSettingsMixin, ArtUrlMixin, ArtMixin, PosterUrlMixin, PosterMixin
 from plexapi.mixins import RatingMixin, SplitMergeMixin, UnmatchMatchMixin
 from plexapi.mixins import CollectionMixin, CountryMixin, GenreMixin, LabelMixin, MoodMixin, SimilarArtistMixin, StyleMixin
+from plexapi.playlist import Playlist
 
 
 class Audio(PlexPartialObject):
@@ -222,6 +223,11 @@ def download(self, savepath=None, keep_original_name=False, subfolders=False, **
             filepaths += track.download(_savepath, keep_original_name, **kwargs)
         return filepaths
 
+    def station(self):
+        """ Returns a :class:`~plexapi.playlist.Playlist` artist radio station or `None`. """
+        key = '%s?includeStations=1' % self.key
+        return next(iter(self.fetchItems(key, cls=Playlist, rtag="Stations")), None)
+
 
 @utils.registerPlexObject
 class Album(Audio, ArtMixin, PosterMixin, RatingMixin, UnmatchMatchMixin,

plexapi/playlist.py

@@ -29,7 +29,11 @@ class Playlist(PlexPartialObject, Playable, ArtMixin, PosterMixin, SmartFilterMi
             icon (str): Icon URI string for smart playlists.
             key (str): API URL (/playlist/<ratingkey>).
             leafCount (int): Number of items in the playlist view.
+            librarySectionID (int): Library section identifier (radio only)
+            librarySectionKey (str): Library section key (radio only)
+            librarySectionTitle (str): Library section title (radio only)
             playlistType (str): 'audio', 'video', or 'photo'
+            radio (bool): If this playlist represents a radio station
             ratingKey (int): Unique key identifying the playlist.
             smart (bool): True if the playlist is a smart playlist.
             summary (str): Summary of the playlist.
@@ -54,7 +58,11 @@ def _loadData(self, data):
         self.icon = data.attrib.get('icon')
         self.key = data.attrib.get('key', '').replace('/items', '')  # FIX_BUG_50
         self.leafCount = utils.cast(int, data.attrib.get('leafCount'))
+        self.librarySectionID = utils.cast(int, data.attrib.get('librarySectionID'))
+        self.librarySectionKey = data.attrib.get('librarySectionKey')
+        self.librarySectionTitle = data.attrib.get('librarySectionTitle')
         self.playlistType = data.attrib.get('playlistType')
+        self.radio = utils.cast(bool, data.attrib.get('radio', 0))
         self.ratingKey = utils.cast(int, data.attrib.get('ratingKey'))
         self.smart = utils.cast(bool, data.attrib.get('smart'))
         self.summary = data.attrib.get('summary')
@@ -169,6 +177,8 @@ def item(self, title):
 
     def items(self):
         """ Returns a list of all items in the playlist. """
+        if self.radio:
+            return []
         if self._items is None:
             key = '%s/items' % self.key
             items = self.fetchItems(key)

plexapi/playqueue.py

@@ -175,8 +175,11 @@ def create(
             args["uri"] = "library:///directory/{uri_args}".format(uri_args=uri_args)
             args["type"] = items[0].listType
         elif items.type == "playlist":
-            args["playlistID"] = items.ratingKey
             args["type"] = items.playlistType
+            if items.radio:
+                args["uri"] = f"server://{server.machineIdentifier}/{server.library.identifier}{items.key}"
+            else:
+                args["playlistID"] = items.ratingKey
         else:
             uuid = items.section().uuid
             args["type"] = items.listType