Add PlexClient createPlayQueue method

Author: JonnyWong16

plexapi/client.py

@@ -481,8 +481,23 @@ def setVideoStream(self, videoStreamID, mtype=DEFAULT_MTYPE):
         """
         self.setStreams(videoStreamID=videoStreamID, mtype=mtype)
 
+    def createPlayQueue(self, server, items, **kwargs):
+        """ Create a playqueue and start playback of the specified media item.
+
+            Parameters:
+                server (:class:`~plexapi.server.PlexServer`): Server you are connected to.
+                items (:class:`~plexapi.base.PlexPartialObject`):
+                    A media item or a list of media items.
+                **kwargs (dict): Additional options to apply to the playqueue.
+                    See :func:`~plexapi.playqueue.PlayQueue.create` for available parameters.
+        """
+        args = PlayQueue._createArgs(server=server, items=items, **kwargs)
+        self.sendCommand("playback/createPlayQueue", **args)
+
     def playMedia(self, media, offset=0, **params):
-        """ Start playback of the specified media item. See also:
+        """ Start playback of the specified media item.
+            Note: This is a legacy command for older clients.
+            Use :func:`~plexapi.client.PlexClient.createPlayQueue` instead for modern clients.
 
             Parameters:
                 media (:class:`~plexapi.media.Media`): Media item to be played back

plexapi/playqueue.py

@@ -136,9 +136,8 @@ def get(
         c._server = server
         return c
 
-    @classmethod
-    def create(
-        cls,
+    @staticmethod
+    def _createArgs(
         server,
         items,
         startItem=None,
@@ -147,28 +146,15 @@ def create(
         includeChapters=1,
         includeRelated=1,
         continuous=0,
+        **kwargs
     ):
-        """Create and return a new :class:`~plexapi.playqueue.PlayQueue`.
-
-        Parameters:
-            server (:class:`~plexapi.server.PlexServer`): Server you are connected to.
-            items (:class:`~plexapi.base.PlexPartialObject`):
-                A media item or a list of media items.
-            startItem (:class:`~plexapi.base.Playable`, optional):
-                Media item in the PlayQueue where playback should begin.
-            shuffle (int, optional): Start the playqueue shuffled.
-            repeat (int, optional): Start the playqueue shuffled.
-            includeChapters (int, optional): include Chapters.
-            includeRelated (int, optional): include Related.
-            continuous (int, optional): include additional items after the initial item.
-                For a show this would be the next episodes, for a movie it does nothing.
-        """
         args = {
             "includeChapters": includeChapters,
             "includeRelated": includeRelated,
             "repeat": repeat,
             "shuffle": shuffle,
             "continuous": continuous,
+            **kwargs
         }
 
         if isinstance(items, list):
@@ -187,6 +173,48 @@ def create(
         if startItem:
             args["key"] = startItem.key
 
+        return args
+
+    @classmethod
+    def create(
+        cls,
+        server,
+        items,
+        startItem=None,
+        shuffle=0,
+        repeat=0,
+        includeChapters=1,
+        includeRelated=1,
+        continuous=0,
+        **kwargs
+    ):
+        """Create and return a new :class:`~plexapi.playqueue.PlayQueue`.
+
+        Parameters:
+            server (:class:`~plexapi.server.PlexServer`): Server you are connected to.
+            items (:class:`~plexapi.base.PlexPartialObject`):
+                A media item or a list of media items.
+            startItem (:class:`~plexapi.base.Playable`, optional):
+                Media item in the PlayQueue where playback should begin.
+            shuffle (int, optional): Start the playqueue shuffled.
+            repeat (int, optional): Start the playqueue shuffled.
+            includeChapters (int, optional): include Chapters.
+            includeRelated (int, optional): include Related.
+            continuous (int, optional): include additional items after the initial item.
+                For a show this would be the next episodes, for a movie it does nothing.
+            **kwargs (dict): Additional options to apply to the playqueue.
+        """
+        args = cls._createArgs(
+            server=server,
+            items=items,
+            startItem=startItem,
+            shuffle=shuffle,
+            repeat=repeat,
+            includeChapters=includeChapters,
+            includeRelated=includeRelated,
+            continuous=continuous,
+            **kwargs
+        )
         path = f"/playQueues{utils.joinArgs(args)}"
         data = server.query(path, method=server._session.post)
         c = cls(server, data, initpath=path)