spotifywebapiPython 1.0.262__py3-none-any.whl → 1.0.263__py3-none-any.whl

spotifywebapipython/spotifyclient.py

@@ -67,6 +67,10 @@ from .const import (
 
 CACHE_SOURCE_CACHED:str = "cached"
 CACHE_SOURCE_CURRENT:str = "current"
+CACHE_KEY_GETSPOTIFYCONNECTDEVICES:str = "GetSpotifyConnectDevices"
+
+MUSIC_SOURCE_SPOTIFY_LOCAL_QUEUE:str = "SPOTIFY_LOCAL_QUEUE"
+MUSIC_SOURCE_SPOTIFY_CONNECT:str = "SPOTIFY_CONNECT"
 
 DELAY_DISCONNECT:float = 0.350
 """
@@ -1084,6 +1088,10 @@ class SpotifyClient:
             # Spotify Connect devices on the local network.  
             self._SpotifyConnectDirectory.WaitForInitComplete.wait()
 
+            # load initial configuration cache with devices we have found thus far.
+            # no need to refresh, since they were just loaded (just loads the cache).
+            self.GetSpotifyConnectDevices(refresh=False)
+
             # trace.
             _logsi.LogVerbose("Spotify Connect Directory task was started and initialized successfully")
 
@@ -6844,9 +6852,17 @@ class SpotifyClient:
                     # get Sonos playback state via Sonos Controller instance.
                     playerStateSonos:PlayerPlayState = self.GetPlayerPlaybackStateSonos(scDevice)
 
-                    # return the device playstate.
-                    _logsi.LogVerbose("Sonos device %s playstate will be returned" % (scDevice.Title))
-                    result = playerStateSonos
+                    # is the device still playing spotify content?
+                    if (playerStateSonos.DeviceMusicSource in [MUSIC_SOURCE_SPOTIFY_CONNECT, MUSIC_SOURCE_SPOTIFY_LOCAL_QUEUE]):
+
+                        # yes - return the device playstate.
+                        _logsi.LogVerbose("Sonos device %s playstate will be returned (music source=\"%s\")" % (scDevice.Title, playerStateSonos.DeviceMusicSource))
+                        result = playerStateSonos
+
+                    else:
+
+                        # no - return an empty playstate.
+                        _logsi.LogVerbose("Sonos device %s music source (%s) is not Spotify; an empty playstate will be returned" % (scDevice.Title, playerStateSonos.DeviceMusicSource))
 
                     # did Sonos Controller instance return a playstate?
                     # if so, then update the player last played info if something is playing.
@@ -8705,18 +8721,25 @@ class SpotifyClient:
                         else:
                             result.ItemType = SpotifyMediaTypes.PODCAST.value
         
-            # check for a restricted device; if found, then grab the device id from the 
-            # cached list of spotify connect devices (if present).
+            # if device id is not present (e.g. a restricted device), then get the device id 
+            # from the cached list of spotify connect devices (if present).
             if (not result.IsEmpty):
                 device:Device = result.Device
                 if (device is not None) and (device.Id is None or device.Id == ''):
-                    cacheKey:str = 'GetSpotifyConnectDevices'
+                    cacheKey:str = CACHE_KEY_GETSPOTIFYCONNECTDEVICES
                     if (cacheKey in self._ConfigurationCache):
                         devices:SpotifyConnectDevices = self._ConfigurationCache[cacheKey]
                         scDevice:SpotifyConnectDevice = devices.GetDeviceByName(device.Name)
                         if scDevice is not None:
                             device.Id = scDevice.DeviceInfo.DeviceId
-        
+                            # is this a Sonos device? if so, then update the music source.
+                            # at this point, it will probably be "SPOTIFY_CONNECT" since it was
+                            # detected in the Spotify Web API device list.
+                            if (scDevice.IsSonos):
+                                sonosPlayer = self._SpotifyConnectDirectory.GetSonosPlayer(scDevice)
+                                if (sonosPlayer):
+                                    result.DeviceMusicSource = sonosPlayer.music_source
+
             # did Spotify return a playstate?
             # if so, then update the player last played info if something is playing.
             if (not result.IsEmpty):
@@ -8796,6 +8819,16 @@ class SpotifyClient:
             playerState.IsDeviceState = True
             playerState.DeviceMusicSource = "" + str(sonosPlayer.music_source)
 
+            # at this point, the the device music_source is probably set to one of the following:
+            # - "UNKNOWN": indicates that Spotify is POSSIBLY playing from the Sonos local queue.
+            # - "SPOTIFY_CONNECT": indicates that Spotify is playing via Spotify Connect using Spotify App.
+            # if not SPOTIFY_CONNECT, then check the currently playing track info to see if it's
+            # a Spotify uri; if so, then it's (probably) playing Spotify from the local queue, so 
+            # we will set the music source to the "SPOTIFY_LOCAL_QUEUE" custom value.
+            if (playerState.DeviceMusicSource != MUSIC_SOURCE_SPOTIFY_CONNECT):
+                if (sonosTrackInfo.get('uri','').startswith("x-sonos-spotify:")):
+                    playerState.DeviceMusicSource = MUSIC_SOURCE_SPOTIFY_LOCAL_QUEUE
+
             # update Spotify Web API player state with Sonos player state.
             playerState._Device._Id = scDevice.Id
             playerState._Device._Name = sonosPlayer.player_name
@@ -10869,7 +10902,7 @@ class SpotifyClient:
                 # was the Sonos device music source set to SPOTIFY_CONNECT?
                 # if not, then issue a Disconnect to (hopefully) reset the music source. this should allow
                 # the subsequent Connect to re-establish a SPOTIFY_CONNECT music source on the Sonos device.
-                if sonosMusicSource != "SPOTIFY_CONNECT":
+                if sonosMusicSource != MUSIC_SOURCE_SPOTIFY_CONNECT:
                     _logsi.LogVerbose("Issuing Disconnect to Sonos Spotify Connect device %s" % (scDevice.Title))
                     zcfResult = zconn.Disconnect(ignoreStatusResult=True)
 
@@ -10893,7 +10926,7 @@ class SpotifyClient:
 
                 # was the Sonos device music source set to Spotify Connect?
                 # if not, then it's a lost cause at this point since it's probably in an UNKNOWN state.
-                if sonosMusicSource != "SPOTIFY_CONNECT":
+                if sonosMusicSource != MUSIC_SOURCE_SPOTIFY_CONNECT:
                     _logsi.LogVerbose("Sonos device %s music source after Connect is not SPOTIFY_CONNECT; it will probably fail to play" % (scDevice.Title))
                 elif (self.HasSpotifyWebPlayerCredentials):
                     # if using Spotify Web Player credentials, then we don't have to wait for device.
@@ -11048,7 +11081,7 @@ class SpotifyClient:
             result = self._SpotifyConnectDirectory.GetDevices()
 
             # update cache.
-            self._ConfigurationCache[apiMethodName] = result
+            self._ConfigurationCache[CACHE_KEY_GETSPOTIFYCONNECTDEVICES] = result
 
             # trace.
             _logsi.LogArray(SILevel.Verbose, TRACE_METHOD_RESULT_TYPE_CACHED % (apiMethodName, type(result).__name__, cacheDesc), result)

{spotifywebapipython-1.0.262.dist-info → spotifywebapipython-1.0.263.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spotifywebapipython
-Version: 1.0.262
+Version: 1.0.263
 Summary: Spotify Web API Python3 Library
 Author: Todd Lucas
 Author-email: <thlucas@yahoo.com>

{spotifywebapipython-1.0.262.dist-info → spotifywebapipython-1.0.263.dist-info}/RECORD

@@ -1,36 +1,36 @@
 spotifywebapipython/__init__.py,sha256=ka7F2AsT-UU7KSYKBnfgl5Trojcep5aQspLutg8D-2k,1306
-spotifywebapipython/const.py,sha256=CRubvbOGAujjY3jvcI9atoI_2Ef9zyjfa3PqUNjxKEo,3923
+spotifywebapipython/const.py,sha256=X1O3doqDi2CZV-htEm6RmwUdvBvSb1rxTkwFACaTdN8,3923
 spotifywebapipython/saappmessages.py,sha256=mVprjpd5CdD8kYeAkLzRvMvIQPmaYtH4UCP5my3QhSk,5065
 spotifywebapipython/sautils.py,sha256=j3f_Lu3Tb5D7-Gd2rJ2Ep901W-4XDp6Vq6XXVl8DX5I,8098
 spotifywebapipython/spotifyapierror.py,sha256=23_CYlxWN0BceYYCLpBpunl55vEwPr_wFf34l74xzeA,1855
 spotifywebapipython/spotifyapimessage.py,sha256=wCnW8jYMLS3x9kjyXPgXXZqaf1HeMTTXzU8u_Dm5pfA,8447
 spotifywebapipython/spotifyauthtoken.py,sha256=iVg2Pa5mfMqYe4qgc5H8td6JzJlaDqk4vMEhH5LmtfI,9289
-spotifywebapipython/spotifyclient.py,sha256=wjDSV_Sb0ZPw5813zo8yHvRKbImtG3vL-cSWXKyVzLk,893191
+spotifywebapipython/spotifyclient.py,sha256=3O67xgSi1WphKR8_KrIi9KefWzALb1AnHK14j3vGuFQ,895623
 spotifywebapipython/spotifydiscovery.py,sha256=cyysxl8PQj9yGHVbaqhSF3SStlrp-NvfGAudM-dDmg0,20290
 spotifywebapipython/spotifymediatypes.py,sha256=hMjkxhbfTtks0_P8BKmY7qg3EmB2zhH3RT0DbEpb_2s,1628
 spotifywebapipython/spotifytypeprefixes.py,sha256=3yfpxKF7jF694qBuo-PbKYvm70YwwdBoGj9enOpWsAg,1375
 spotifywebapipython/spotifywebapiauthenticationerror.py,sha256=5A0MKvYo3Ypv0ZeSSfLHuFLwzoUUu044bBoUgMfNXNw,3940
 spotifywebapipython/spotifywebapierror.py,sha256=5cga9213J_nFQ0UX4vSn3dpyinASKTRiH0wAR4nLjvs,3147
 spotifywebapipython/spotifywebplayertoken.py,sha256=axj1j1lM7COiiZfpElkJRdnk4AmE6bAQcjKshUIz1Nk,35813
-spotifywebapipython/docs/__init__.html,sha256=svP0_Zd1aCtK31Rpc2edqdSANnKYzkPayQ2rt5O3DEs,185784
+spotifywebapipython/docs/__init__.html,sha256=Mbe_gNtLqnRX9sCOatchw7RQyrN1wJJhP8Bbs8T0XeA,186244
 spotifywebapipython/docs/codecopy.js,sha256=ryuoZwLIL03YitjjFzn49UO5ta7-OBos6LNA3qHhFzs,3120
-spotifywebapipython/docs/index.html,sha256=ffD3BVHdGWc4hYzqb62KoP14guXLwDNSAUnLKVK3928,48779
-spotifywebapipython/docs/search.js,sha256=-2_-ZEqQhG03iQdw-p1L0AoJGbFWIYL1ih4OIoJWFhY,9145781
+spotifywebapipython/docs/index.html,sha256=J8oWTry75qWoIfz_KCJ1PRH8vTajRQXTvnBSFMENbDc,48779
+spotifywebapipython/docs/search.js,sha256=HCnF-ooWrM_2QDC6WeM08U_AEAmX49BK7pG4xjOpxSg,9147212
 spotifywebapipython/docs/spotifywebapipython.ico,sha256=YImj39fqqSPSuB2-sMDlUYDd6YwRfQeJRtq4FjwWglg,16410
 spotifywebapipython/docs/spotifywebapipython_OLD.ico,sha256=YIv5LjcD4bTIJQSOr8jjwbWaeB3QkElRwkTOePiGbZo,14904
-spotifywebapipython/docs/spotifywebapipython/const.html,sha256=vscCq0D8EkoN3szfwQEVUUjjG-VT6J8WkhPcaGJ79aA,59805
-spotifywebapipython/docs/spotifywebapipython/saappmessages.html,sha256=gbIZFpzxEbniRboTZIRtpeZdBEjU4l2Mz3Ag68ceOtE,62358
-spotifywebapipython/docs/spotifywebapipython/sautils.html,sha256=sfIegHwDLVaIYyr8cf2qjprc8jwF1kECGEnVnUOaaMY,61063
-spotifywebapipython/docs/spotifywebapipython/spotifyapierror.html,sha256=VATh8MiVmtOmRb1_l0KeT_4FA9mhw5L_5WGOtcPK-LE,48054
-spotifywebapipython/docs/spotifywebapipython/spotifyapimessage.html,sha256=rNqvUxV4fVRmR4U2dSBZgAB5WPcEQpaA5yoP21pZyMI,59210
-spotifywebapipython/docs/spotifywebapipython/spotifyauthtoken.html,sha256=AvNeQ5m_Y3c0kViKq-2Cy6CMQf3kf0_mScvb0uNIiLI,59256
-spotifywebapipython/docs/spotifywebapipython/spotifyclient.html,sha256=4HdAOGQbSNPAujuxO9sLct31mzFRe0tUOHsiYgFpi-U,1670639
-spotifywebapipython/docs/spotifywebapipython/spotifydiscovery.html,sha256=_V98zL81_9mEt_m2jKPKjHaB8L2T8sjU06IkGaFy9Uc,57662
-spotifywebapipython/docs/spotifywebapipython/spotifymediatypes.html,sha256=_9PyyJEuKj4i16MGgHx3uXO0dgYi5-M42SWyQMwUMeU,51532
-spotifywebapipython/docs/spotifywebapipython/spotifytypeprefixes.html,sha256=9MnDyzqm6eO9oEF5znbTNFDZVYLCo1QQxRuU6Z4QLGY,52401
-spotifywebapipython/docs/spotifywebapipython/spotifywebapiauthenticationerror.html,sha256=d93-xHKMJVqCsBZaxqZnKYYQxT2ZMLOi1wH_1Vjuzus,52174
-spotifywebapipython/docs/spotifywebapipython/spotifywebapierror.html,sha256=4gciZ8YJYZUYvaZK03EmAL6evkzIqFyDuaIzZZzzYfs,50592
-spotifywebapipython/docs/spotifywebapipython/spotifywebplayertoken.html,sha256=9-k-8lvCralCnReXGnDAmMgqICwkaZKt93D3DKst5Xg,62204
+spotifywebapipython/docs/spotifywebapipython/const.html,sha256=m2bDOn2RhAUvCDOLdxhcZvR8EQDtrN0qMxtVD_rSXqU,59805
+spotifywebapipython/docs/spotifywebapipython/saappmessages.html,sha256=M-PhRbUYM7rw8AgTTyCXUinTZmIvWtZJXNdXCo73Np4,62358
+spotifywebapipython/docs/spotifywebapipython/sautils.html,sha256=B99_1_h8_1vCRBqCP1WHLkgBAXDdCLoIFrmVjIZ3yug,61063
+spotifywebapipython/docs/spotifywebapipython/spotifyapierror.html,sha256=ISzyl60Sgi11InldvQ8WNeqfAbCNa7anQOVsAdW6K20,48054
+spotifywebapipython/docs/spotifywebapipython/spotifyapimessage.html,sha256=chuosQxoJBXjcmuabFOH15cumPZ1zNJsWL330AO_R98,59210
+spotifywebapipython/docs/spotifywebapipython/spotifyauthtoken.html,sha256=-qJTTEx6V71TYYDTyi-pIr4-1DAVSD7sU0hIRBr6BSc,59256
+spotifywebapipython/docs/spotifywebapipython/spotifyclient.html,sha256=WOGxzoZ3KoId_N2GE_I9dLwUWX_QI0QHsHyAGkfJGxU,1670639
+spotifywebapipython/docs/spotifywebapipython/spotifydiscovery.html,sha256=7VXh0YMjMhOCJ5PrVU27WYPjxHWS_bsYuenQ-49tbb0,57662
+spotifywebapipython/docs/spotifywebapipython/spotifymediatypes.html,sha256=kMpGOHLomKKAUuerbS7ydCkmhWeYFSZYzsdlmeiLXOE,51532
+spotifywebapipython/docs/spotifywebapipython/spotifytypeprefixes.html,sha256=PeKPBD3d_qudE2qNORMPHGZjl0R-tX_wQL-VyjBym6g,52401
+spotifywebapipython/docs/spotifywebapipython/spotifywebapiauthenticationerror.html,sha256=xs3chHX43VZuQD2JC_jSxLT94XVYUChtyjCOWgI9wEQ,52174
+spotifywebapipython/docs/spotifywebapipython/spotifywebapierror.html,sha256=xsu5CtzcSMMQGcl3zPY-b06ZgboNV0RN6-a_hS8SsG8,50592
+spotifywebapipython/docs/spotifywebapipython/spotifywebplayertoken.html,sha256=Oooy-uaRi2fIfwTaFcQEi-qzchwcOepzYBKcCZoq6Oc,62204
 spotifywebapipython/models/__init__.py,sha256=RwRQhUX-6EUs8XvStVFpR8EPwoqIAz9K6ref-28qHKI,4423
 spotifywebapipython/models/album.py,sha256=U3Pdw0-EL33LdkeiN31fjZ23rlLk6DNGV8jRmZU7EyQ,5170
 spotifywebapipython/models/albumpagesaved.py,sha256=SBYMhkh5ZsMrRAXl-cm9zsxMDh8gO190ENq6Py2TyGY,2417
@@ -72,7 +72,7 @@ spotifywebapipython/models/narrator.py,sha256=8gkYk8YkWX7m0ErDs9pwkWbXKkGmCMCFVP
 spotifywebapipython/models/owner.py,sha256=RokGhciF6TV43svWzeqyvKClhm1YuT0jW5XTx54ZEsI,4543
 spotifywebapipython/models/pageobject.py,sha256=KEQhaapYL-7eSxc2gHGqZnozBJs3wJ888W1wLZwRCD0,11045
 spotifywebapipython/models/playeractions.py,sha256=GaqEBcmHev8eoCXb51xt8O9trqeOhIpIysjlKYWOBY0,6564
-spotifywebapipython/models/playerlastplayedinfo.py,sha256=BjyOn3flodSkM6CeF_M5sEgh8wcb2yJ-Wl7CB1I8vdY,10983
+spotifywebapipython/models/playerlastplayedinfo.py,sha256=7Dt-0K3bdfbWzLb3quaDW-ge_F3WVD08O5D1m0FOpzE,11015
 spotifywebapipython/models/playerplaystate.py,sha256=v5uzD-ck6SvMpWASKbXsAHrDC6-uhZglpszVXXLNQ3g,15231
 spotifywebapipython/models/playerqueueinfo.py,sha256=BryoQ7UjiuUxNRQrIW7bl2_S0FaIeKwYyG1cVSZXemk,7204
 spotifywebapipython/models/playhistory.py,sha256=GO2rM1H6O5BvKuCDKq7p7rb1vBk7JF-QoHeU9nJ_4i0,3853
@@ -107,7 +107,7 @@ spotifywebapipython/models/userprofilesimplified.py,sha256=YCEVED8PMeqWkORMHwj0J
 spotifywebapipython/models/zeroconfdiscoveryresult.py,sha256=XID2qmaK2WTGJoLTQ54aQjfutLJMLgJ7A1ATwAp06kY,20250
 spotifywebapipython/models/zeroconfproperty.py,sha256=sXGUqbHhFMutCNKFJwJKbNbbQAnBnR7Ob5wNDSePxZk,2141
 spotifywebapipython/oauthcli/__init__.py,sha256=K37XTxYAKT0n8otCNzWbjgJ10fAPN4WL6seEpwvWyo4,168
-spotifywebapipython/oauthcli/authclient.py,sha256=-B_av5cxVHGHOaf8F_Xeo5u-HbOI1ytN86nOBzfW4Sw,56026
+spotifywebapipython/oauthcli/authclient.py,sha256=rpOgX8T-co8JByHlmB6JJqvXUaphP7jDhJ4qjhf0XA8,56065
 spotifywebapipython/spotifyconnect/__init__.py,sha256=9Xl5KiJFvWLbsdb4YQ0xmF67i36ybpXCCXrWeNsKEvc,1108
 spotifywebapipython/spotifyconnect/spotifyconnectdeviceeventargs.py,sha256=35hKa0FAaPgy7W8D6MFXmga667pjwXITo8jSj1TDfE8,1988
 spotifywebapipython/spotifyconnect/spotifyconnectdirectorytask.py,sha256=QXNpJSqUGuOYxCzvDH63Ka9L9Yo7Bb5iVBRtDhc4ILE,153923
@@ -137,8 +137,8 @@ spotifywebapipython/zeroconfapi/zeroconfgetinfo.py,sha256=APayso_F7lCsdzzrkescgd
 spotifywebapipython/zeroconfapi/zeroconfgetinfoalias.py,sha256=FZJM23HIPJSfhXIC3-EuS1XhawheoG5maSp7__k4yBo,2932
 spotifywebapipython/zeroconfapi/zeroconfgetinfodrmmediaformat.py,sha256=c5uk8ljsIuBK3w2jahHKQuoWvm245LOjUBitetXx5Mo,2347
 spotifywebapipython/zeroconfapi/zeroconfresponse.py,sha256=mAPIDj5MG53x8peiScrp7OJblwy_o_Sto4wqE0rGujU,6445
-spotifywebapipython-1.0.262.dist-info/LICENSE,sha256=KGcc9g0zwqNLcWnSn_ezv1UtKyhMENFhvtixpxUPNsE,1177
-spotifywebapipython-1.0.262.dist-info/METADATA,sha256=J6jwjNAnDnbwC7s9Y28-kEPijkEz-IiZ1B2AJsXPwjs,11644
-spotifywebapipython-1.0.262.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-spotifywebapipython-1.0.262.dist-info/top_level.txt,sha256=jTBLFlijKTesYh2dteAz4vb17qjaqWKeDjpnnwTcrjs,20
-spotifywebapipython-1.0.262.dist-info/RECORD,,
+spotifywebapipython-1.0.263.dist-info/LICENSE,sha256=KGcc9g0zwqNLcWnSn_ezv1UtKyhMENFhvtixpxUPNsE,1177
+spotifywebapipython-1.0.263.dist-info/METADATA,sha256=G2E7xQSkFRE0u3QWzdW3iqL7GgjL868pG8jaMhTtwnc,11644
+spotifywebapipython-1.0.263.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+spotifywebapipython-1.0.263.dist-info/top_level.txt,sha256=jTBLFlijKTesYh2dteAz4vb17qjaqWKeDjpnnwTcrjs,20
+spotifywebapipython-1.0.263.dist-info/RECORD,,