spotifywebapiPython 1.0.36__py3-none-any.whl → 1.0.38__py3-none-any.whl

spotifywebapipython/docs/spotifywebapiPython/spotifywebapierror.html

@@ -9,7 +9,7 @@
 </title>
     <link rel="icon" type="image/svg+xml" href="data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20role%3D%22img%22%20aria-label%3D%22pdoc%20logo%22%20width%3D%22300%22%20height%3D%22150%22%20viewBox%3D%22-1%200%2060%2030%22%3E%3Ctitle%3Epdoc%3C/title%3E%3Cpath%20d%3D%22M29.621%2021.293c-.011-.273-.214-.475-.511-.481a.5.5%200%200%200-.489.503l-.044%201.393c-.097.551-.695%201.215-1.566%201.704-.577.428-1.306.486-2.193.182-1.426-.617-2.467-1.654-3.304-2.487l-.173-.172a3.43%203.43%200%200%200-.365-.306.49.49%200%200%200-.286-.196c-1.718-1.06-4.931-1.47-7.353.191l-.219.15c-1.707%201.187-3.413%202.131-4.328%201.03-.02-.027-.49-.685-.141-1.763.233-.721.546-2.408.772-4.076.042-.09.067-.187.046-.288.166-1.347.277-2.625.241-3.351%201.378-1.008%202.271-2.586%202.271-4.362%200-.976-.272-1.935-.788-2.774-.057-.094-.122-.18-.184-.268.033-.167.052-.339.052-.516%200-1.477-1.202-2.679-2.679-2.679-.791%200-1.496.352-1.987.9a6.3%206.3%200%200%200-1.001.029c-.492-.564-1.207-.929-2.012-.929-1.477%200-2.679%201.202-2.679%202.679A2.65%202.65%200%200%200%20.97%206.554c-.383.747-.595%201.572-.595%202.41%200%202.311%201.507%204.29%203.635%205.107-.037.699-.147%202.27-.423%203.294l-.137.461c-.622%202.042-2.515%208.257%201.727%2010.643%201.614.908%203.06%201.248%204.317%201.248%202.665%200%204.492-1.524%205.322-2.401%201.476-1.559%202.886-1.854%206.491.82%201.877%201.393%203.514%201.753%204.861%201.068%202.223-1.713%202.811-3.867%203.399-6.374.077-.846.056-1.469.054-1.537zm-4.835%204.313c-.054.305-.156.586-.242.629-.034-.007-.131-.022-.307-.157-.145-.111-.314-.478-.456-.908.221.121.432.25.675.355.115.039.219.051.33.081zm-2.251-1.238c-.05.33-.158.648-.252.694-.022.001-.125-.018-.307-.157-.217-.166-.488-.906-.639-1.573.358.344.754.693%201.198%201.036zm-3.887-2.337c-.006-.116-.018-.231-.041-.342.635.145%201.189.368%201.599.625.097.231.166.481.174.642-.03.049-.055.101-.067.158-.046.013-.128.026-.298.004-.278-.037-.901-.57-1.367-1.087zm-1.127-.497c.116.306.176.625.12.71-.019.014-.117.045-.345.016-.206-.027-.604-.332-.986-.695.41-.051.816-.056%201.211-.031zm-4.535%201.535c.209.22.379.47.358.598-.006.041-.088.138-.351.234-.144.055-.539-.063-.979-.259a11.66%2011.66%200%200%200%20.972-.573zm.983-.664c.359-.237.738-.418%201.126-.554.25.237.479.548.457.694-.006.042-.087.138-.351.235-.174.064-.694-.105-1.232-.375zm-3.381%201.794c-.022.145-.061.29-.149.401-.133.166-.358.248-.69.251h-.002c-.133%200-.306-.26-.45-.621.417.091.854.07%201.291-.031zm-2.066-8.077a4.78%204.78%200%200%201-.775-.584c.172-.115.505-.254.88-.378l-.105.962zm-.331%202.302a10.32%2010.32%200%200%201-.828-.502c.202-.143.576-.328.984-.49l-.156.992zm-.45%202.157l-.701-.403c.214-.115.536-.249.891-.376a11.57%2011.57%200%200%201-.19.779zm-.181%201.716c.064.398.194.702.298.893-.194-.051-.435-.162-.736-.398.061-.119.224-.3.438-.495zM8.87%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zm-.735-.389a1.15%201.15%200%200%200-.314.783%201.16%201.16%200%200%200%201.162%201.162c.457%200%20.842-.27%201.032-.653.026.117.042.238.042.362a1.68%201.68%200%200%201-1.679%201.679%201.68%201.68%200%200%201-1.679-1.679c0-.843.626-1.535%201.436-1.654zM5.059%205.406A1.68%201.68%200%200%201%203.38%207.085a1.68%201.68%200%200%201-1.679-1.679c0-.037.009-.072.011-.109.21.3.541.508.935.508a1.16%201.16%200%200%200%201.162-1.162%201.14%201.14%200%200%200-.474-.912c.015%200%20.03-.005.045-.005.926.001%201.679.754%201.679%201.68zM3.198%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zM1.375%208.964c0-.52.103-1.035.288-1.52.466.394%201.06.64%201.717.64%201.144%200%202.116-.725%202.499-1.738.383%201.012%201.355%201.738%202.499%201.738.867%200%201.631-.421%202.121-1.062.307.605.478%201.267.478%201.942%200%202.486-2.153%204.51-4.801%204.51s-4.801-2.023-4.801-4.51zm24.342%2019.349c-.985.498-2.267.168-3.813-.979-3.073-2.281-5.453-3.199-7.813-.705-1.315%201.391-4.163%203.365-8.423.97-3.174-1.786-2.239-6.266-1.261-9.479l.146-.492c.276-1.02.395-2.457.444-3.268a6.11%206.11%200%200%200%201.18.115%206.01%206.01%200%200%200%202.536-.562l-.006.175c-.802.215-1.848.612-2.021%201.25-.079.295.021.601.274.837.219.203.415.364.598.501-.667.304-1.243.698-1.311%201.179-.02.144-.022.507.393.787.213.144.395.26.564.365-1.285.521-1.361.96-1.381%201.126-.018.142-.011.496.427.746l.854.489c-.473.389-.971.914-.999%201.429-.018.278.095.532.316.713.675.556%201.231.721%201.653.721.059%200%20.104-.014.158-.02.207.707.641%201.64%201.513%201.64h.013c.8-.008%201.236-.345%201.462-.626.173-.216.268-.457.325-.692.424.195.93.374%201.372.374.151%200%20.294-.021.423-.068.732-.27.944-.704.993-1.021.009-.061.003-.119.002-.179.266.086.538.147.789.147.15%200%20.294-.021.423-.069.542-.2.797-.489.914-.754.237.147.478.258.704.288.106.014.205.021.296.021.356%200%20.595-.101.767-.229.438.435%201.094.992%201.656%201.067.106.014.205.021.296.021a1.56%201.56%200%200%200%20.323-.035c.17.575.453%201.289.866%201.605.358.273.665.362.914.362a.99.99%200%200%200%20.421-.093%201.03%201.03%200%200%200%20.245-.164c.168.428.39.846.68%201.068.358.273.665.362.913.362a.99.99%200%200%200%20.421-.093c.317-.148.512-.448.639-.762.251.157.495.257.726.257.127%200%20.25-.024.37-.071.427-.17.706-.617.841-1.314.022-.015.047-.022.068-.038.067-.051.133-.104.196-.159-.443%201.486-1.107%202.761-2.086%203.257zM8.66%209.925a.5.5%200%201%200-1%200c0%20.653-.818%201.205-1.787%201.205s-1.787-.552-1.787-1.205a.5.5%200%201%200-1%200c0%201.216%201.25%202.205%202.787%202.205s2.787-.989%202.787-2.205zm4.4%2015.965l-.208.097c-2.661%201.258-4.708%201.436-6.086.527-1.542-1.017-1.88-3.19-1.844-4.198a.4.4%200%200%200-.385-.414c-.242-.029-.406.164-.414.385-.046%201.249.367%203.686%202.202%204.896.708.467%201.547.7%202.51.7%201.248%200%202.706-.392%204.362-1.174l.185-.086a.4.4%200%200%200%20.205-.527c-.089-.204-.326-.291-.527-.206zM9.547%202.292c.093.077.205.114.317.114a.5.5%200%200%200%20.318-.886L8.817.397a.5.5%200%200%200-.703.068.5.5%200%200%200%20.069.703l1.364%201.124zm-7.661-.065c.086%200%20.173-.022.253-.068l1.523-.893a.5.5%200%200%200-.506-.863l-1.523.892a.5.5%200%200%200-.179.685c.094.158.261.247.432.247z%22%20transform%3D%22matrix%28-1%200%200%201%2058%200%29%22%20fill%3D%22%233bb300%22/%3E%3Cpath%20d%3D%22M.3%2021.86V10.18q0-.46.02-.68.04-.22.18-.5.28-.54%201.34-.54%201.06%200%201.42.28.38.26.44.78.76-1.04%202.38-1.04%201.64%200%203.1%201.54%201.46%201.54%201.46%203.58%200%202.04-1.46%203.58-1.44%201.54-3.08%201.54-1.64%200-2.38-.92v4.04q0%20.46-.04.68-.02.22-.18.5-.14.3-.5.42-.36.12-.98.12-.62%200-1-.12-.36-.12-.52-.4-.14-.28-.18-.5-.02-.22-.02-.68zm3.96-9.42q-.46.54-.46%201.18%200%20.64.46%201.18.48.52%201.2.52.74%200%201.24-.52.52-.52.52-1.18%200-.66-.48-1.18-.48-.54-1.26-.54-.76%200-1.22.54zm14.741-8.36q.16-.3.54-.42.38-.12%201-.12.64%200%201.02.12.38.12.52.42.16.3.18.54.04.22.04.68v11.94q0%20.46-.04.7-.02.22-.18.5-.3.54-1.7.54-1.38%200-1.54-.98-.84.96-2.34.96-1.8%200-3.28-1.56-1.48-1.58-1.48-3.66%200-2.1%201.48-3.68%201.5-1.58%203.28-1.58%201.48%200%202.3%201v-4.2q0-.46.02-.68.04-.24.18-.52zm-3.24%2010.86q.52.54%201.26.54.74%200%201.22-.54.5-.54.5-1.18%200-.66-.48-1.22-.46-.56-1.26-.56-.8%200-1.28.56-.48.54-.48%201.2%200%20.66.52%201.2zm7.833-1.2q0-2.4%201.68-3.96%201.68-1.56%203.84-1.56%202.16%200%203.82%201.56%201.66%201.54%201.66%203.94%200%201.66-.86%202.96-.86%201.28-2.1%201.9-1.22.6-2.54.6-1.32%200-2.56-.64-1.24-.66-2.1-1.92-.84-1.28-.84-2.88zm4.18%201.44q.64.48%201.3.48.66%200%201.32-.5.66-.5.66-1.48%200-.98-.62-1.46-.62-.48-1.34-.48-.72%200-1.34.5-.62.5-.62%201.48%200%20.96.64%201.46zm11.412-1.44q0%20.84.56%201.32.56.46%201.18.46.64%200%201.18-.36.56-.38.9-.38.6%200%201.46%201.06.46.58.46%201.04%200%20.76-1.1%201.42-1.14.8-2.8.8-1.86%200-3.58-1.34-.82-.64-1.34-1.7-.52-1.08-.52-2.36%200-1.3.52-2.34.52-1.06%201.34-1.7%201.66-1.32%203.54-1.32.76%200%201.48.22.72.2%201.06.4l.32.2q.36.24.56.38.52.4.52.92%200%20.5-.42%201.14-.72%201.1-1.38%201.1-.38%200-1.08-.44-.36-.34-1.04-.34-.66%200-1.24.48-.58.48-.58%201.34z%22%20fill%3D%22green%22/%3E%3C/svg%3E"/>
     <!-- build env - Package Name = "spotifywebapiPython" -->
-    <!-- build env - Package Version = "1.0.36" -->
+    <!-- build env - Package Version = "1.0.38" -->
     <!-- pdoc module.modulename = "spotifywebapipython.spotifywebapierror" -->
     <!-- pdoc module.is_package = "False" -->
     <!-- pdoc root_module_name  = "None" -->
@@ -71,7 +71,7 @@
 
     <footer class="footertext">
         spotifywebapiPython</br>
-        Version 1.0.36</br>
+        Version 1.0.38</br>
         <a href="https://developer.spotify.com/documentation/web-api" target="_blank">
           <img src="../spotifywebapipython.ico" alt="brand icon" style="width:32px; height:32px; padding:4px;"/>
           A Spotify Web Api Client

spotifywebapipython/models/device.py

@@ -43,6 +43,18 @@ class Device:
             self._Type = root.get('type', None)
             self._VolumePercent = root.get('volume_percent', None)
 
+        # post load validations.
+        if self._IsActive is None:
+            self._IsActive = False
+        if self._IsPrivateSession is None:
+            self._IsPrivateSession = False
+        if self._IsRestricted is None:
+            self._IsRestricted = False
+        if self._SupportsVolume is None:
+            self._SupportsVolume = False
+        if self._VolumePercent is None:
+            self._VolumePercent = 0
+
 
     def __repr__(self) -> str:
         return self.ToString()
@@ -141,6 +153,14 @@ class Device:
         """
         return self._VolumePercent
 
+    @VolumePercent.setter
+    def VolumePercent(self, value:int):
+        """ 
+        Sets the VolumePercent property value.
+        """
+        if isinstance(value, int):
+            self._VolumePercent = value
+
 
     @staticmethod
     def GetIdFromSelectItem(value:str) -> str:

spotifywebapipython/models/playeractions.py

@@ -36,16 +36,38 @@ class PlayerActions:
         
         else:
 
-            self._InterruptingPlayback:bool = root.get('interrupting_playback', None)
-            self._Pausing:bool = root.get('pausing', None)
-            self._Resuming:bool = root.get('resuming', None)
-            self._Seeking:bool = root.get('seeking', None)
-            self._SkippingNext:bool = root.get('skipping_next', None)
-            self._SkippingPrev:bool = root.get('skipping_prev', None)
-            self._TogglingRepeatContext:bool = root.get('toggling_repeat_context', None)
-            self._TogglingRepeatTrack:bool = root.get('toggling_shuffle', None)
-            self._TogglingShuffle:bool = root.get('toggling_repeat_track', None)
-            self._TransferringPlayback:bool = root.get('transferring_playback', None)
+            self._InterruptingPlayback = root.get('interrupting_playback', None)
+            self._Pausing = root.get('pausing', None)
+            self._Resuming = root.get('resuming', None)
+            self._Seeking = root.get('seeking', None)
+            self._SkippingNext = root.get('skipping_next', None)
+            self._SkippingPrev = root.get('skipping_prev', None)
+            self._TogglingRepeatContext = root.get('toggling_repeat_context', None)
+            self._TogglingRepeatTrack = root.get('toggling_shuffle', None)
+            self._TogglingShuffle = root.get('toggling_repeat_track', None)
+            self._TransferringPlayback = root.get('transferring_playback', None)
+
+        # post load validations.
+        if self._InterruptingPlayback is None:
+            self._InterruptingPlayback = False
+        if self._Pausing is None:
+            self._Pausing = False
+        if self._Resuming is None:
+            self._Resuming = False
+        if self._Seeking is None:
+            self._Seeking = False
+        if self._SkippingNext is None:
+            self._SkippingNext = False
+        if self._SkippingPrev is None:
+            self._SkippingPrev = False
+        if self._TogglingRepeatContext is None:
+            self._TogglingRepeatContext = False
+        if self._TogglingRepeatTrack is None:
+            self._TogglingRepeatTrack = False
+        if self._TogglingShuffle is None:
+            self._TogglingShuffle = False
+        if self._TransferringPlayback is None:
+            self._TransferringPlayback = False
 
 
     def __repr__(self) -> str:

spotifywebapipython/models/playerplaystate.py

@@ -34,8 +34,8 @@ class PlayerPlayState:
         self._IsPlaying:bool = None
         self._ProgressMS:int = None
         self._RepeatState:str = None
-        self._ShuffleState:bool = None
-        self._SmartShuffle:bool = None
+        self._ShuffleState:str = None
+        self._SmartShuffle:str = None
         self._Timestamp:int = None
         
         if (root is None):
@@ -72,7 +72,27 @@ class PlayerPlayState:
                 elif self._CurrentlyPlayingType == 'episode':
                     self._Item = Episode(root=item)
 
-        
+        # post load validations.
+        if self._Actions is None:
+            self._Actions = PlayerActions()
+        if self._Device is None:
+            self._Device = Device()
+        if self._CurrentlyPlayingType is None:
+            self._CurrentlyPlayingType = 'unknown'
+        if self._IsPlaying is None:
+            self._IsPlaying = False
+        if self._ProgressMS is None:
+            self._ProgressMS = 0
+        if self._RepeatState is None:
+            self._RepeatState = 'off'
+        if self._ShuffleState is None:
+            self._ShuffleState = 'off'
+        if self._SmartShuffle is None:
+            self._SmartShuffle = 'off'
+        if self._Timestamp is None:
+            self._Timestamp = 0
+
+
     def __repr__(self) -> str:
         return self.ToString()
 
@@ -148,7 +168,7 @@ class PlayerPlayState:
         """ 
         Sets the IsPlaying property value.
         """
-        if value is None or isinstance(value, bool):
+        if isinstance(value, bool):
             self._IsPlaying = value
 
 
@@ -159,9 +179,9 @@ class PlayerPlayState:
         
         The `RepeatState` property contains the actual repeat setting.
         """
-        if self._RepeatState is None or self._RepeatState == 'off': 
-            return False
-        return True
+        if self._RepeatState is not 'off': 
+            return True
+        return False
 
 
     @property
@@ -169,9 +189,19 @@ class PlayerPlayState:
         """ 
         True if shuffle play is enabled; otherwise, False. 
         """
-        if self.ShuffleState is None or self.ShuffleState == 'off':
-            return False
-        return True
+        if self.ShuffleState == 'on':
+            return True
+        return False
+
+
+    @property
+    def IsSmartShuffleEnabled(self) -> bool:
+        """ 
+        True if smart shuffle play is enabled; otherwise, False. 
+        """
+        if self.SmartShuffle == 'on':
+            return True
+        return False
 
 
     @property
@@ -181,6 +211,14 @@ class PlayerPlayState:
         """
         return self._ProgressMS
 
+    @ProgressMS.setter
+    def ProgressMS(self, value:int):
+        """ 
+        Sets the ProgressMS property value.
+        """
+        if isinstance(value, int):
+            self._ProgressMS = value
+
 
     @property
     def RepeatState(self) -> str:
@@ -237,6 +275,14 @@ class PlayerPlayState:
         """
         return self._Timestamp
 
+    @Timestamp.setter
+    def Timestamp(self, value:int):
+        """ 
+        Sets the Timestamp property value.
+        """
+        if isinstance(value, int):
+            self._Timestamp = value
+
 
     def ToDictionary(self) -> dict:
         """

spotifywebapipython/spotifyclient.py

@@ -484,6 +484,50 @@ class SpotifyClient:
         msg.ResponseData = responseData
 
 
+    def _GetPlayerNowPlayingAlbumUri(self) -> str:
+        """
+        Returns the album uri value of the currently playing media if something is
+        playing; otherwise, null is returned.
+        """
+        result:str = None
+        
+        # get nowplaying status.
+        _logsi.LogVerbose("Querying NowPlaying status of Spotify player")
+        nowPlaying:PlayerPlayState = self.GetPlayerNowPlaying()
+        
+        # is a track playing?  if so, return the album uri value.
+        if nowPlaying is not None:
+            _logsi.LogVerbose("NowPlaying data: %s" % str(nowPlaying))
+            if nowPlaying.CurrentlyPlayingType in ['track']:
+                trackItem:Track = nowPlaying.Item
+                if (trackItem is not None) and (trackItem.Album is not None):
+                    result = trackItem.Album.Uri
+                
+        return result
+    
+
+    def _GetPlayerNowPlayingArtistUri(self) -> str:
+        """
+        Returns the artist uri value of the currently playing media if something is
+        playing; otherwise, null is returned.
+        """
+        result:str = None
+        
+        # get nowplaying status.
+        _logsi.LogVerbose("Querying NowPlaying status of Spotify player")
+        nowPlaying:PlayerPlayState = self.GetPlayerNowPlaying()
+        
+        # is a track playing?  if so, return the artist uri value.
+        if nowPlaying is not None:
+            _logsi.LogVerbose("NowPlaying data: %s" % str(nowPlaying))
+            if nowPlaying.CurrentlyPlayingType in ['track']:
+                trackItem:Track = nowPlaying.Item
+                if (trackItem is not None) and (len(trackItem.Artists) > 0):
+                    result = trackItem.Artists[0].Uri
+                
+        return result
+    
+
     def _GetPlayerNowPlayingUri(self) -> str:
         """
         Returns the uri value of the currently playing media if something is
@@ -977,7 +1021,8 @@ class SpotifyClient:
                               name:str=None,
                               description:str=None,
                               public:bool=None,
-                              collaborative:bool=None
+                              collaborative:bool=None,
+                              imagePath:str=None
                               ) -> None:
         """
         Change a playlist's details (name, description, and public / private state).  
@@ -1001,6 +1046,9 @@ class SpotifyClient:
                 If true, the playlist will become collaborative and other users will be able to modify 
                 the playlist in their Spotify client.  
                 Note: You can only set collaborative to true on non-public playlists.
+            imagePath (str):
+                A fully-qualified path of an image to display for the playlist.
+                The image must be in JPEG format, and cannot exceed 256KB in Base64 encoded size.  
 
         The user must own the playlist.
         
@@ -1021,6 +1069,9 @@ class SpotifyClient:
         A playlist can also be made collaborative by setting the `collaborative` argument to true. 
         This means that anyone with the link can add to or remove a track from it.
                 
+        If the `imagePath` argument is specified, the `AddPlaylistCoverImage` method is called to 
+        upload the image after the playlist details are updated.
+
         <details>
           <summary>Sample Code</summary>
         ```python
@@ -1040,6 +1091,7 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("description", description)
             apiMethodParms.AppendKeyValue("public", public)
             apiMethodParms.AppendKeyValue("collaborative", collaborative)
+            apiMethodParms.AppendKeyValue("imagePath", imagePath)
             _logsi.LogMethodParmList(SILevel.Verbose, "Change a playlist details", apiMethodParms)
                 
             # if collaborative is True, then force public to false as Spotify requires it.
@@ -1067,6 +1119,13 @@ class SpotifyClient:
             msg.RequestJson = reqData
             self.MakeRequest('PUT', msg)
 
+            # was a playlist image path specified?  if so, then assign the image.
+            if imagePath is not None:
+                try:
+                    self.AddPlaylistCoverImage(playlistId, imagePath)
+                except Exception as ex:
+                    pass   # ignore exceptions, as they are already logged.
+
             # process results.
             # no results to process - this is pass or fail.
             return
@@ -1871,7 +1930,8 @@ class SpotifyClient:
                        name:str=None,
                        description:str=None,
                        public:bool=True,
-                       collaborative:bool=False
+                       collaborative:bool=False,
+                       imagePath:str=None
                        ) -> Playlist:
         """
         Create an empty playlist for a Spotify user.  
@@ -1900,6 +1960,9 @@ class SpotifyClient:
                 To create collaborative playlists you must have granted `playlist-modify-private`
                 and `playlist-modify-public` scope.  
                 Defaults to false.
+            imagePath (str):
+                A fully-qualified path of an image to display for the playlist.
+                The image must be in JPEG format, and cannot exceed 256KB in Base64 encoded size.  
 
         The playlist will be empty until you add tracks. 
         
@@ -1912,6 +1975,9 @@ class SpotifyClient:
         This means that anyone with the link can add to or remove a track from it.
         
         Each user is generally limited to a maximum of 11,000 playlists.
+        
+        If the `imagePath` argument is specified, the `AddPlaylistCoverImage` method is called to 
+        upload the image after the playlist is created.
 
         Returns:
             A `Playlist` object that contains the playlist details.
@@ -1943,6 +2009,7 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("description", description)
             apiMethodParms.AppendKeyValue("public", public)
             apiMethodParms.AppendKeyValue("collaborative", collaborative)
+            apiMethodParms.AppendKeyValue("imagePath", imagePath)
             _logsi.LogMethodParmList(SILevel.Verbose, "Create an empty playlist for a user", apiMethodParms)
                 
             # if userId is not supplied, then use profile value.
@@ -1970,6 +2037,13 @@ class SpotifyClient:
 
             # process results.
             result = Playlist(root=msg.ResponseData)
+
+            # was a playlist image path specified?  if so, then assign the image.
+            if imagePath is not None:
+                try:
+                    self.AddPlaylistCoverImage(result.Id, imagePath)
+                except Exception as ex:
+                    pass   # ignore exceptions, as they are already logged.
         
             # trace.
             _logsi.LogObject(SILevel.Verbose, TRACE_METHOD_RESULT_TYPE % (apiMethodName, type(result).__name__), result, excludeNonPublic=True)
@@ -1989,7 +2063,7 @@ class SpotifyClient:
 
 
     def FollowArtists(self, 
-                      ids:str,
+                      ids:str=None,
                       ) -> None:
         """
         Add the current user as a follower of one or more artists.
@@ -2001,6 +2075,7 @@ class SpotifyClient:
                 A comma-separated list of the Spotify artist IDs.  
                 A maximum of 50 IDs can be sent in one request.
                 Example: `2CIMQHirSU0MQqyYHq0eOx,1IQ2e1buppatiN1bxUVkrk`
+                If null, the currently playing track artist uri id value is used.
                 
         Raises:
             SpotifyWebApiError: 
@@ -2027,7 +2102,15 @@ class SpotifyClient:
             apiMethodParms = _logsi.EnterMethodParmList(SILevel.Debug, apiMethodName)
             apiMethodParms.AppendKeyValue("ids", ids)
             _logsi.LogMethodParmList(SILevel.Verbose, "Add the current user as a follower of one or more artists", apiMethodParms)
-                
+                                   
+            # if ids not specified, then return currently playing artist id value.
+            if (ids is None) or (len(ids.strip()) == 0):
+                uri = self._GetPlayerNowPlayingArtistUri()
+                if uri is not None:
+                    ids = SpotifyClient.GetIdFromUri(uri)
+                else:
+                    raise SpotifyApiError(SAAppMessages.ARGUMENT_REQUIRED_ERROR % (apiMethodName, 'ids'), logsi=_logsi)
+
             # build a list of all item id's.
             # remove any leading / trailing spaces in case user put a space between the items.
             arrIds:list[str] = ids.split(',')
@@ -5697,7 +5780,7 @@ class SpotifyClient:
                 properly handles cases of new types in the future by checking against the type field of each object.
                 
         Returns:
-            A `PlayerPlayState` object that contains the currently playing media, or null if nothing is playing.
+            A `PlayerPlayState` object that contains the currently playing media state.
                 
         Raises:
             SpotifyWebApiError: 
@@ -9486,7 +9569,7 @@ class SpotifyClient:
 
 
     def RemoveAlbumFavorites(self, 
-                             ids:str
+                             ids:str=None
                              ) -> None:
         """
         Remove one or more albums from the current user's 'Your Library'.
@@ -9498,6 +9581,7 @@ class SpotifyClient:
                 A comma-separated list of the Spotify IDs for the albums.  
                 Maximum: 50 IDs.  
                 Example: `6vc9OTcyd3hyzabCmsdnwE,382ObEPsp2rxGrnsizN5TX`
+                If null, the currently playing track album uri id value is used.
                 
         Raises:
             SpotifyWebApiError: 
@@ -9529,6 +9613,14 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("ids", ids)
             _logsi.LogMethodParmList(SILevel.Verbose, "Remove album(s) from user favorites", apiMethodParms)
                 
+            # if ids not specified, then return currently playing album id value.
+            if (ids is None) or (len(ids.strip()) == 0):
+                uri = self._GetPlayerNowPlayingAlbumUri()
+                if uri is not None:
+                    ids = SpotifyClient.GetIdFromUri(uri)
+                else:
+                    raise SpotifyApiError(SAAppMessages.ARGUMENT_REQUIRED_ERROR % (apiMethodName, 'ids'), logsi=_logsi)
+
             # build a list of all item id's.
             # remove any leading / trailing spaces in case user put a space between the items.
             arrIds:list[str] = ids.split(',')
@@ -10203,7 +10295,7 @@ class SpotifyClient:
 
 
     def SaveAlbumFavorites(self, 
-                           ids:str
+                           ids:str=None
                            ) -> None:
         """
         Save one or more albums to the current user's 'Your Library'.
@@ -10215,6 +10307,7 @@ class SpotifyClient:
                 A comma-separated list of the Spotify IDs for the albums.  
                 Maximum: 50 IDs.  
                 Example: `6vc9OTcyd3hyzabCmsdnwE,382ObEPsp2rxGrnsizN5TX,2noRn2Aes5aoNVsU6iWThc`
+                If null, the currently playing track album uri id value is used.
                 
         Raises:
             SpotifyWebApiError: 
@@ -10246,6 +10339,14 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("ids", ids)
             _logsi.LogMethodParmList(SILevel.Verbose, "Save album(s) to user favorites", apiMethodParms)
                 
+            # if ids not specified, then return currently playing album id value.
+            if (ids is None) or (len(ids.strip()) == 0):
+                uri = self._GetPlayerNowPlayingAlbumUri()
+                if uri is not None:
+                    ids = SpotifyClient.GetIdFromUri(uri)
+                else:
+                    raise SpotifyApiError(SAAppMessages.ARGUMENT_REQUIRED_ERROR % (apiMethodName, 'ids'), logsi=_logsi)
+
             # build a list of all item id's.
             # remove any leading / trailing spaces in case user put a space between the items.
             arrIds:list[str] = ids.split(',')
@@ -12681,7 +12782,7 @@ class SpotifyClient:
 
 
     def UnfollowArtists(self, 
-                        ids:str,
+                        ids:str=None,
                         ) -> None:
         """
         Remove the current user as a follower of one or more artists.
@@ -12693,6 +12794,7 @@ class SpotifyClient:
                 A comma-separated list of Spotify artist IDs.  
                 A maximum of 50 IDs can be sent in one request.
                 Example: `2CIMQHirSU0MQqyYHq0eOx,1IQ2e1buppatiN1bxUVkrk`
+                If null, the currently playing track artist uri id value is used.
                 
         Raises:
             SpotifyWebApiError: 
@@ -12720,6 +12822,14 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("ids", ids)
             _logsi.LogMethodParmList(SILevel.Verbose, "Remove the current user as a follower of one or more artists", apiMethodParms)
                 
+            # if ids not specified, then return currently playing artist id value.
+            if (ids is None) or (len(ids.strip()) == 0):
+                uri = self._GetPlayerNowPlayingArtistUri()
+                if uri is not None:
+                    ids = SpotifyClient.GetIdFromUri(uri)
+                else:
+                    raise SpotifyApiError(SAAppMessages.ARGUMENT_REQUIRED_ERROR % (apiMethodName, 'ids'), logsi=_logsi)
+
             # build a list of all item id's.
             # remove any leading / trailing spaces in case user put a space between the items.
             arrIds:list[str] = ids.split(',')