spotifywebapiPython 1.0.294__py3-none-any.whl → 1.0.296__py3-none-any.whl

spotifywebapipython/spotifyconnect/spotifyconnectdirectorytask.py

@@ -692,6 +692,7 @@ class SpotifyConnectDirectoryTask(threading.Thread):
         transferPlayback:bool=False,
         timeoutActivation:float=15.0,
         timeoutTransfer:float=10.0,
+        activateAppMediaReceiverOnGroupMembers:bool=False,
         ) -> str:
         """
         Activates the Spotify Cast Application on the specified Chromecast device.
@@ -712,18 +713,22 @@ class SpotifyConnectDirectoryTask(threading.Thread):
 
         Args:
             deviceName (str):
-                Chromecast device friendly name (or device id) to activate.
+                Chromecast device friendly name (or device id) to activate.  
             transferPlayback (bool):
                 True to transfer playback to the device; otherwise, False to just activate
-                the Spotify Cast App on the device.
+                the Spotify Cast App on the device.  
             timeoutActivation (float):
                 Amount of time to wait (in seconds) for the Spotify Cast App to be fully activated,
                 the user logged in, and ready for transfer of playback.  
-                Default is 15 seconds.
+                Default is 15 seconds.  
             timeoutTransfer (float):
                 If `transferPlayback` argument is True, the amount of time to wait (in seconds)
                 for the transfer to complete; otherwise, argument is ignored.  
-                Default is 10 seconds.
+                Default is 10 seconds.  
+            activateAppMediaReceiverOnGroupMembers (bool):
+                True to force start the APP_MEDIA_RECEIVER on each group member cast device prior
+                to activating the Spotify Cast App; otherwise, False (default) to not start the
+                APP_MEDIA_RECEIVER on any group devices.  
 
         Returns:
             The deviceId that was activated.
@@ -739,6 +744,7 @@ class SpotifyConnectDirectoryTask(threading.Thread):
             apiMethodParms.AppendKeyValue("transferPlayback", transferPlayback)
             apiMethodParms.AppendKeyValue("timeoutActivation", timeoutActivation)
             apiMethodParms.AppendKeyValue("timeoutTransfer", timeoutTransfer)
+            apiMethodParms.AppendKeyValue("activateAppMediaReceiverOnGroupMembers", activateAppMediaReceiverOnGroupMembers)
             _logsi.LogMethodParmList(SILevel.Verbose, "Activating Spotify App on Chromecast device: \"%s\"" % (deviceName), apiMethodParms)
 
             # validations.
@@ -829,13 +835,13 @@ class SpotifyConnectDirectoryTask(threading.Thread):
 
                 # for groups, the SpotifyAppTask must be activated on the group leader (e.g. coordinator).
                 # the cast zeroconf info may not contain the group leader host info, as it is constantly 
-                # being updated as devices are added / removed from the group.  this can lead to the 
-                # SpotifyAppTask being started on a member of the group that is not the leader, which will 
-                # cause other devices in the group not to play.
-                # 
-                # to combat this, we will call the `get_multizone_status` function that gives us the
-                # current group leader host info for each group.  we will then create a cast device to
-                # the group leader host address, and start the SpotifyCastApp on that specific host.
+                # being updated as devices are added / removed from the group.  the resolution of the group
+                # leader should have been handled by the `_VerifyMultizoneGroupLeader` call above.
+                #
+                # if this the the second attempt at activating the Spotify Cast App, then we will try
+                # starting the APP_MEDIA_RECEIVER on each group member device, as well as calling the
+                # `get_multizone_status` function again to verify the status of the zone before trying to
+                # start the Spotify Cast App.
 
                 # trace.
                 if (_logsi.IsOn(SILevel.Verbose)):
@@ -845,102 +851,109 @@ class SpotifyConnectDirectoryTask(threading.Thread):
                 groupHost:str = scDevice.DiscoveryResult.HostIpAddress
                 groupPort:int = scDevice.DiscoveryResult.HostIpPort
 
-                try:
+                # are we starting the APP_MEDIA_RECEIVER on each group member?
+                if (activateAppMediaReceiverOnGroupMembers != True):
 
-                    # request a multizone group member update.
-                    # note that this will just send a request to the cast group device for its
-                    # status, which will then update the members list via event listener callbacks.
-                    castMultizoneController:MultizoneController = self._CastMultiZoneControllers.get(str(castInfo.uuid), None)
-                    if (castMultizoneController) and (castMultizoneController._socket_client):
-                        castMultizoneController.update_members()
-                        time.sleep(2.0)  # give controller some time to update member list.
-
-                        # activate media receiver app for each member in the group.
-                        # process all device members in the group / zone.
-                        for zone_member_uuid in castMultizoneController.members:
-
-                            # get castInfo instance so we can connect to the device.
-                            zone_member_castInfo = self._CastBrowser.devices.get(UUID(zone_member_uuid))
-                            if zone_member_castInfo is not None:
-
-                                # get cast device instance.
-                                zone_member_castDevice = get_chromecast_from_cast_info(
-                                    cast_info=zone_member_castInfo,
-                                    zconf=self._ZeroconfInstance,
-                                    tries=2,
-                                    retry_wait=0.5,
-                                    timeout=5)
-
-                                # wait for the cast device to provide an initial status.
-                                zone_member_castDevice.wait(10)
-
-                                # formulate title for trace messages.
-                                trc_zone_member_title:str = "\"%s\" [ip=%s:%s]" % (zone_member_castDevice.cast_info.friendly_name, zone_member_castDevice.socket_client.host, zone_member_castDevice.socket_client.port)
-
-                                # trace.
-                                _logsi.LogObject(SILevel.Verbose, "%s - Cast group \"%s\" member Chromecast device status: %s" % (self.name, castInfo.friendly_name, trc_zone_member_title), zone_member_castDevice.status, colorValue=SIColors.Coral)
-
-                                # if current app is APP_SPOTIFY, then stop the app before starting the media receiver.
-                                if (zone_member_castDevice.status) and (zone_member_castDevice.status.app_id == APP_SPOTIFY):
-                                    _logsi.LogVerbose("%s - Issuing quit_app (APP_SPOTIFY) for group \"%s\" member device: %s" % (self.name, castInfo.friendly_name, trc_zone_member_title), colorValue=SIColors.Coral)
-                                    zone_member_castDevice.quit_app(timeout=5.0)
-                                elif (zone_member_castDevice.status) and (zone_member_castDevice.status.app_id == APP_SPOTIFY_CONNECT):
-                                    _logsi.LogVerbose("%s - Issuing quit_app (APP_SPOTIFY_CONNECT) for group \"%s\" member device: %s" % (self.name, castInfo.friendly_name, trc_zone_member_title), colorValue=SIColors.Coral)
-                                    zone_member_castDevice.quit_app(timeout=5.0)
-
-                                # start the media receiver app.
-                                # this will stabilize routing for the group using the Default Media Receiver.
-                                _logsi.LogVerbose("%s - Starting Chromecast default APP_MEDIA_RECEIVER for group \"%s\" member device: %s" % (self.name, castInfo.friendly_name, trc_zone_member_title), colorValue=SIColors.Coral)
-                                zone_member_castDevice.start_app(APP_MEDIA_RECEIVER, force_launch=True, timeout=10.0)
-
-                                # start the connection worker thread, if needed.
-                                # failure to do this will result in the following exception being thrown when
-                                # the `launch_app()` method is called:
-                                # - `pychromecast.error.NotConnected: Chromecast unknown:8009 is connecting...`
-                                if (zone_member_castDevice.is_idle):
-                                    if (zone_member_castDevice.socket_client is not None) and (zone_member_castDevice.socket_client.first_connection):
-                                        _logsi.LogVerbose("%s - Starting Chromecast default APP_MEDIA_RECEIVER connection worker thread for group \"%s\" member device: %s" % (self.name, castInfo.friendly_name, trc_zone_member_title), colorValue=SIColors.Coral)
-                                        zone_member_castDevice.start()
-                                        zone_member_castDevice.wait(timeout=5.0)
-
-                                # media receiver app needs time to start.
-                                time.sleep(2.0)
+                    _logsi.LogVerbose("Bypassing start of APP_MEDIA_RECEIVER for group: %s" % (scDevice.Title), colorValue=SIColors.Coral)
 
-                except Exception as ex:
+                else:
+
+                    try:
+
+                        # request a multizone group member update.
+                        # note that this will just send a request to the cast group device for its
+                        # status, which will then update the members list via event listener callbacks.
+                        castMultizoneController:MultizoneController = self._CastMultiZoneControllers.get(str(castInfo.uuid), None)
+                        if (castMultizoneController) and (castMultizoneController._socket_client):
+                            castMultizoneController.update_members()
+                            time.sleep(2.0)  # give controller some time to update member list.
+
+                            # activate media receiver app for each member in the group.
+                            # process all device members in the group / zone.
+                            for zone_member_uuid in castMultizoneController.members:
+
+                                # get castInfo instance so we can connect to the device.
+                                zone_member_castInfo = self._CastBrowser.devices.get(UUID(zone_member_uuid))
+                                if zone_member_castInfo is not None:
+
+                                    # get cast device instance.
+                                    zone_member_castDevice = get_chromecast_from_cast_info(
+                                        cast_info=zone_member_castInfo,
+                                        zconf=self._ZeroconfInstance,
+                                        tries=2,
+                                        retry_wait=0.5,
+                                        timeout=5)
+
+                                    # wait for the cast device to provide an initial status.
+                                    zone_member_castDevice.wait(10)
+
+                                    # formulate title for trace messages.
+                                    trc_zone_member_title:str = "\"%s\" [ip=%s:%s]" % (zone_member_castDevice.cast_info.friendly_name, zone_member_castDevice.socket_client.host, zone_member_castDevice.socket_client.port)
+
+                                    # trace.
+                                    _logsi.LogObject(SILevel.Verbose, "%s - Cast group \"%s\" member Chromecast device status: %s" % (self.name, castInfo.friendly_name, trc_zone_member_title), zone_member_castDevice.status, colorValue=SIColors.Coral)
+
+                                    # if current app is APP_SPOTIFY, then stop the app before starting the media receiver.
+                                    if (zone_member_castDevice.status) and (zone_member_castDevice.status.app_id == APP_SPOTIFY):
+                                        _logsi.LogVerbose("%s - Issuing quit_app (APP_SPOTIFY) for group \"%s\" member device: %s" % (self.name, castInfo.friendly_name, trc_zone_member_title), colorValue=SIColors.Coral)
+                                        zone_member_castDevice.quit_app(timeout=5.0)
+                                    elif (zone_member_castDevice.status) and (zone_member_castDevice.status.app_id == APP_SPOTIFY_CONNECT):
+                                        _logsi.LogVerbose("%s - Issuing quit_app (APP_SPOTIFY_CONNECT) for group \"%s\" member device: %s" % (self.name, castInfo.friendly_name, trc_zone_member_title), colorValue=SIColors.Coral)
+                                        zone_member_castDevice.quit_app(timeout=5.0)
+
+                                    # start the media receiver app.
+                                    # this will stabilize routing for the group using the Default Media Receiver.
+                                    _logsi.LogVerbose("%s - Starting Chromecast default APP_MEDIA_RECEIVER for group \"%s\" member device: %s" % (self.name, castInfo.friendly_name, trc_zone_member_title), colorValue=SIColors.Coral)
+                                    zone_member_castDevice.start_app(APP_MEDIA_RECEIVER, force_launch=True, timeout=10.0)
+
+                                    # start the connection worker thread, if needed.
+                                    # failure to do this will result in the following exception being thrown when
+                                    # the `launch_app()` method is called:
+                                    # - `pychromecast.error.NotConnected: Chromecast unknown:8009 is connecting...`
+                                    if (zone_member_castDevice.is_idle):
+                                        if (zone_member_castDevice.socket_client is not None) and (zone_member_castDevice.socket_client.first_connection):
+                                            _logsi.LogVerbose("%s - Starting Chromecast default APP_MEDIA_RECEIVER connection worker thread for group \"%s\" member device: %s" % (self.name, castInfo.friendly_name, trc_zone_member_title), colorValue=SIColors.Coral)
+                                            zone_member_castDevice.start()
+                                            zone_member_castDevice.wait(timeout=5.0)
+
+                                    # media receiver app needs time to start.
+                                    time.sleep(2.0)
+
+                    except Exception as ex:
             
-                    # trace.
-                    _logsi.LogException("Chromecast Multizone group update_members exception: %s" % (str(ex)), ex, logToSystemLogger=False)
-                    # ignore exception, as nothing can be done about it.
-
-                # get current multizone status for all groups.
-                castMultiZoneStatus:MultizoneStatus = get_multizone_status(castInfo.host, castInfo.services, self.ZeroconfInstance, 5)
-                _logsi.LogObject(SILevel.Verbose, "%s - Chromecast group multizone status for device: %s [ip=%s:%s]" % (self.name, scDevice.Title, castInfo.host, castInfo.port), castMultiZoneStatus, colorValue=SIColors.Coral)
-
-                # ensure group device is still on the network;
-                # if group device dropped off the network, then we can't query it!
-                if (castMultiZoneStatus is not None):
-
-                    # find the group coordinator for the selected device.
-                    zoneInfo:MultizoneInfo = None
-                    for zoneInfo in castMultiZoneStatus.groups:
-
-                        # is this our group?
-                        if (str(zoneInfo.uuid) == scDevice.DiscoveryResult.Key):
-
-                            # yes - get host info to use for the device.
-                            # we will use the device discovery result HostIpAddress instead of the zoneInfo.host
-                            # value here, as the zoneInfo MAY contain an IPV6 formatted address, which was causing 
-                            # issues if the device was originally activated using an IPV4 address!
-                            groupHost = scDevice.DiscoveryResult.HostIpAddress
-                            groupPort = scDevice.DiscoveryResult.HostIpPort
-                            break
+                        # trace.
+                        _logsi.LogException("Chromecast Multizone group update_members exception: %s" % (str(ex)), ex, logToSystemLogger=False)
+                        # ignore exception, as nothing can be done about it.
+
+                    # get current multizone status for all groups.
+                    castMultiZoneStatus:MultizoneStatus = get_multizone_status(castInfo.host, castInfo.services, self.ZeroconfInstance, 5)
+                    _logsi.LogObject(SILevel.Verbose, "%s - Chromecast group multizone status for device: %s [ip=%s:%s]" % (self.name, scDevice.Title, castInfo.host, castInfo.port), castMultiZoneStatus, colorValue=SIColors.Coral)
+
+                    # ensure group device is still on the network;
+                    # if group device dropped off the network, then we can't query it!
+                    if (castMultiZoneStatus is not None):
+
+                        # find the group coordinator for the selected device.
+                        zoneInfo:MultizoneInfo = None
+                        for zoneInfo in castMultiZoneStatus.groups:
+
+                            # is this our group?
+                            if (str(zoneInfo.uuid) == scDevice.DiscoveryResult.Key):
+
+                                # yes - get host info to use for the device.
+                                # we will use the device discovery result HostIpAddress instead of the zoneInfo.host
+                                # value here, as the zoneInfo MAY contain an IPV6 formatted address, which was causing 
+                                # issues if the device was originally activated using an IPV4 address!
+                                groupHost = scDevice.DiscoveryResult.HostIpAddress
+                                groupPort = scDevice.DiscoveryResult.HostIpPort
+                                break
 
-                    # connect to the device and build a Chromecast instance from group coordinator host info.
-                    castDevice = get_chromecast_from_host(
-                        host=(groupHost, groupPort, castInfo.uuid, castInfo.model_name, castInfo.friendly_name),
-                        tries=2,
-                        retry_wait=0.5,
-                        timeout=10)
+                # connect to the device and build a Chromecast instance from group coordinator host info.
+                castDevice = get_chromecast_from_host(
+                    host=(groupHost, groupPort, castInfo.uuid, castInfo.model_name, castInfo.friendly_name),
+                    tries=2,
+                    retry_wait=0.5,
+                    timeout=10)
 
                 # trace.
                 _logsi.LogVerbose("%s - Waiting %d seconds max for Chromecast group multizone device to activate: %s [ip=%s:%s]" % (self.name, deviceWaitTimeoutSecs, scDevice.Title, groupHost, groupPort), colorValue=SIColors.Coral)
@@ -1535,12 +1548,21 @@ class SpotifyConnectDirectoryTask(threading.Thread):
                 returnCoordinator = True
 
             # get Sonos Controller instance for device name.
-            sonosPlayer:SoCo = self._SonosPlayers.get(device.DiscoveryResult.HostIpAddress, None)
+            hostIpAddress:str = device.DiscoveryResult.HostIpAddress
+            sonosPlayer:SoCo = self._SonosPlayers.get(hostIpAddress, None)
 
             # if not found then it's an error.
             if (sonosPlayer is None):
                 raise SpotifyApiError("Could not find Sonos Controller instance for device: %s" % (device.Title), None, logsi=_logsi)
 
+            # Another integration (e.g. Home Assistant Sonos) can call soco_reset().
+            # Our cached reference then outlives the SoCo singleton registry, and
+            # topology updates only reach the current instance. Reacquire it before
+            # inspecting its coordinator role or group. Without a reset this returns
+            # the same instance, preserving the normal SoCo topology cache.
+            sonosPlayer = SoCo(hostIpAddress)
+            self._SonosPlayers[hostIpAddress] = sonosPlayer
+
             # trace.
             _logsi.LogDictionary(SILevel.Verbose, "Sonos Controller instance for device: %s (speaker_info)" % (device.Title), sonosPlayer.speaker_info)
 

spotifywebapipython/zeroconfapi/zeroconfconnect.py

@@ -648,6 +648,134 @@ class ZeroconfConnect:
                 # formulate the blob.
                 blob = builder.build()
             
+            # special processing for Spotify Soloist client:
+            elif (infoModelDisplayName in ["soloist"]):
+
+                # have not figured out how the Spotify Soloist initial session is created.
+                raise SpotifyWebApiError(404, "Spotify Soloist initial session has not been created for loginId \"%s\"; use an authorized Spotify App to connect to Soloist for this loginId first" % (loginId), apiMethodName, "Soloist Initial Session Not Created", _logsi)
+
+                # The following Soloist log info is generated by a successful connection from an authorized Spotify App:
+                # 20:30:15.371 I [f:379] getAuthInfo: success
+                # 20:30:15.371 I [f:302] zeroconf: received getInfo
+                # 20:30:18.700 I [f:379] getAuthInfo: success
+                # 20:30:18.700 I [f:302] zeroconf: received getInfo
+                # 20:30:18.939 I [f:186] zeroconf: received addUser
+                # 20:30:18.939 I [f:280] loginAuthToken
+                # 20:30:18.939 I [f:273] SpeakerAuth: Login state changed: LOGGED_OUT -> LOGGING_IN
+                # 20:30:18.939 I [f:53 ] Creating session via Connect
+                # 20:30:19.275 I [f:263] High request latency: https://accounts.spotify.com/api took 185 ms
+                # 20:30:19.275 I [f:218] Auth code grant token exchange succeeded
+                # 20:30:19.277 I [f:72 ] Session created via Connect, session: [session:31l77y2al5lnn7mxfrmd4bpfhqke]
+                # 20:30:19.278 I [f:808] Connect session created successfully, received AuthenticatedSession
+                
+            # left the following code in for now - still trying to work out how to create the
+            # initial Soloist session if one has not been established yet.
+
+            # # special processing for Spotify Soloist client:
+            # elif (infoModelDisplayName in ["soloist"]):
+
+            #     # trace.
+            #     _logsi.LogVerbose("Spotify Connect token type is '%s' - using soloist authorization credentials to connect: '%s' (ip=%s)" % (info.TokenType, info.RemoteName, self._HostIpAddress))
+
+            #     # validations.
+            #     # note that userid and password are not needed by soloist, as both of those
+            #     # are contained in the soloist credentials object.  we only need the loginId
+            #     # value for the credentials lookup.
+            #     if (loginId is None) or (not isinstance(loginId,str)):
+            #         raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_ACTIVATE_CREDENTIAL_REQUIRED % ("SpotifyConnectLoginId"), logsi=_logsi)
+
+            #     # we will use credentials from a librespot credentials.json file.
+            #     # this requires that the user copy the "credentials.json" file from the 
+            #     # librespot cache location (e.g. "/home/user/.cache/spotifyd/credentials.json", etc)
+            #     # and place it in the same folder as the token storage file with a new name
+            #     # of "SpotifyWebApiPython_librespot_credentials.json".
+                
+            #     # get credentials from librespot credentials file.
+            #     credentials:dict = self._LoadLibrespotCredentials(loginId)
+                
+            #     # create credentials and builder objects.
+            #     librespot_username = credentials.get('username','')
+            #     librespot_password = b64str_to_bytes(credentials.get('auth_data',''))
+            #     credentials:Credentials = Credentials(librespot_username, librespot_password, AuthenticationTypes.STORED_SPOTIFY_CREDENTIALS)
+            #     builder = BlobBuilder(credentials, info.DeviceId, info.PublicKey)
+
+            #     # set defaults used by this token type:
+            #     # - clientKey should be the getInfo response PublicKey (base64 encoded).
+            #     # - include origin device information in the addUser request.
+            #     # - tokenType should be set to '' (not used by librespot).
+            #     clientKey:str = ''
+            #     includeOriginDeviceInfo = True
+            #     tokenType = 'auth_token'
+            
+            #     # formulate the blob.
+            #     blob = builder.build()
+
+                # The following Soloist log errors are generated for this auth method if an authorized Spotify App 
+                # has not yet connected to the Soloist instance.
+                # The above code passes pre-configured LIBRESPOT credentials to the Spotify Connect zeroconf process.
+                # Note that playback transfer is successful if an authorized Spotify App HAS connected to 
+                # the Soloist instance, as the device is in the Spotify Web API device list (dynamic device); in 
+                # this instance, the `_ConnectAddUser` method is not even called!
+                # 20:18:17.491 I [f:379] getAuthInfo: success
+                # 20:18:17.491 I [f:302] zeroconf: received getInfo
+                # 20:18:44.731 I [f:379] getAuthInfo: success
+                # 20:18:44.731 I [f:302] zeroconf: received getInfo
+                # 20:18:47.458 I [f:186] zeroconf: received addUser
+                # 20:18:47.458 I [f:280] loginAuthToken
+                # 20:18:47.459 I [f:273] SpeakerAuth: Login state changed: LOGGED_OUT -> LOGGING_IN
+                # 20:18:47.459 I [f:53 ] Creating session via Connect
+                # 20:18:47.459 E [f:78 ] Session creation via Connect failed, error: session_invalid_connect_auth_token
+                # 20:18:47.459 E [f:813] Connect session creation failed: session_invalid_connect_auth_token
+                # 20:18:47.459 I [f:273] SpeakerAuth: Login state changed: LOGGING_IN -> LOGGED_OUT
+
+            # # special processing for Spotify Soloist client:
+            # elif (infoModelDisplayName in ["soloist"]):
+
+            #     # trace.
+            #     _logsi.LogVerbose("Spotify Connect token type is '%s' - using Spotify Desktop Client OAuth2 token to connect to Soloist: '%s' (ip=%s)" % (info.TokenType, info.RemoteName, self._HostIpAddress))
+
+            #     # validations.
+            #     if (loginId is None) or (not isinstance(loginId,str)):
+            #         raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_ACTIVATE_CREDENTIAL_REQUIRED % ("SpotifyConnectLoginId"), logsi=_logsi)
+            #     if (username is None) or (not isinstance(username,str)):
+            #         raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_ACTIVATE_CREDENTIAL_REQUIRED % ("SpotifyConnectUsername"), logsi=_logsi)
+            #     if (password is None) or (not isinstance(password,str)):
+            #         raise SpotifyApiError(SAAppMessages.MSG_SPOTIFY_ACTIVATE_CREDENTIAL_REQUIRED % ("SpotifyConnectPassword"), logsi=_logsi)
+
+            #     # create credentials and builder objects.
+            #     credentials:Credentials = Credentials(loginId, password, AuthenticationTypes.SPOTIFY_TOKEN)
+            #     #credentials:Credentials = Credentials(username, password, AuthenticationTypes.SPOTIFY_TOKEN)
+            #     builder = BlobBuilder(credentials, info.DeviceId, info.PublicKey)
+
+            #     # set defaults used by Soloist client.
+            #     # - clientKey not required.
+            #     # - include origin device information in the addUser request.
+            #     # - use tokenType of "auth_token".
+            #     clientKey = ''
+            #     includeOriginDeviceInfo = True
+            #     tokenType = 'auth_token'
+
+            #     # get access token.
+            #     blob:str = self._GetSpotifyConnectAccessToken(info, loginId=loginId)
+
+                # The following Soloist log errors are generated for this auth method if an authorized Spotify App 
+                # has not yet connected to the Soloist instance.
+                # The above code passes pre-configured Spotify Desktop App credentials to the Spotify Connect zeroconf process.
+                # Note that playback transfer is successful if an authorized Spotify App HAS connected to 
+                # the Soloist instance, as the device is in the Spotify Web API device list (dynamic device); in 
+                # this instance, the `_ConnectAddUser` method is not even called!
+                # 20:14:33.640 I [f:379] getAuthInfo: success
+                # 20:14:33.640 I [f:302] zeroconf: received getInfo
+                # 20:14:36.579 I [f:186] zeroconf: received addUser
+                # 20:14:36.579 I [f:280] loginAuthToken
+                # 20:14:36.579 I [f:273] SpeakerAuth: Login state changed: LOGGED_OUT -> LOGGING_IN
+                # 20:14:36.579 I [f:53 ] Creating session via Connect
+                # 20:14:36.579 E [f:78 ] Session creation via Connect failed, error: session_invalid_connect_auth_token
+                # 20:14:36.579 E [f:813] Connect session creation failed: session_invalid_connect_auth_token
+                # 20:14:36.579 I [f:273] SpeakerAuth: Login state changed: LOGGING_IN -> LOGGED_OUT
+                # 20:14:36.579 W [f:552] login failed while API key is configured (action_id=1)
+                # 20:14:36.579 W [f:553] login failed: make sure --api-key is valid
+
             # special processing for tokenType "authorization_code":
             elif info.TokenType == 'authorization_code':
 

spotifywebapipython/zeroconfapi/zeroconfgetinfo.py

@@ -28,6 +28,7 @@ class ZeroconfGetInfo(ZeroconfResponse):
         self._AccountReq:str = None
         self._ActiveUser:str = ""
         self._Aliases:list[ZeroconfGetInfoAlias] = []
+        self._AuthInfo:str = ""
         self._Availability:str = ""
         self._BrandDisplayName:str = None
         self._ClientId:str = None
@@ -55,6 +56,7 @@ class ZeroconfGetInfo(ZeroconfResponse):
 
             self._AccountReq = root.get('accountReq', None)
             self._ActiveUser = root.get('activeUser', "")
+            self._AuthInfo = root.get('authInfo', None)
             self._Availability = root.get('availability', "")
             self._BrandDisplayName = root.get('brandDisplayName', None)
             self._ClientId = root.get('clientID', None)
@@ -137,6 +139,27 @@ class ZeroconfGetInfo(ZeroconfResponse):
         return self._Aliases
 
 
+    @property
+    def AuthInfo(self) -> str:
+        """ 
+        This variable is not documented by the Spotify Web API.
+
+        It appears to be structured authentication information associated with the Soloist 
+        client/device, in base64-encoded / protobuf format (e.g. "CiQyZjA2M ... BVE9NWmU5RQ==").
+        
+        The maximum length of the auth Info string is unknown. 
+        """
+        return self._AuthInfo
+
+    @AuthInfo.setter
+    def AuthInfo(self, value:str):
+        """ 
+        Sets the AuthInfo property value.
+        """
+        if (isinstance(value, str)) or (value is None):
+            self._AuthInfo = value
+
+
     @property
     def Availability(self) -> str:
         """ 
@@ -526,6 +549,7 @@ class ZeroconfGetInfo(ZeroconfResponse):
             'AccountReq': self._AccountReq,
             'ActiveUser': self._ActiveUser,
             'Aliases': [ item.ToDictionary() for item in self._Aliases ],
+            'AuthInfo': self._AuthInfo,
             'Availability': self._Availability,
             'BrandDisplayName': self._BrandDisplayName,
             'ClientId': self._ClientId,
@@ -577,6 +601,7 @@ class ZeroconfGetInfo(ZeroconfResponse):
         if self._AccountReq is not None: msg = '%s\n AccountReq="%s"' % (msg, str(self._AccountReq))
         if self._ActiveUser is not None: msg = '%s\n ActiveUser="%s"' % (msg, str(self._ActiveUser))
         if self._Aliases is not None: msg = '%s\n Aliases=%s' % (msg, str(self._Aliases))
+        if self._AuthInfo is not None: msg = '%s\n AuthInfo="%s"' % (msg, str(self._AuthInfo))
         if self._Availability is not None: msg = '%s\n Availability="%s"' % (msg, str(self._Availability))
         if self._BrandDisplayName is not None: msg = '%s\n BrandDisplayName="%s"' % (msg, str(self._BrandDisplayName))
         if self._ClientId is not None: msg = '%s\n ClientId="%s"' % (msg, str(self._ClientId))

{spotifywebapipython-1.0.294.dist-info → spotifywebapipython-1.0.296.dist-info}/METADATA

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

{spotifywebapipython-1.0.294.dist-info → spotifywebapipython-1.0.296.dist-info}/RECORD

@@ -1,36 +1,36 @@
 spotifywebapipython/__init__.py,sha256=ka7F2AsT-UU7KSYKBnfgl5Trojcep5aQspLutg8D-2k,1306
-spotifywebapipython/const.py,sha256=oj5dY2U2uxxMLiZWij3jeY2VwZzmbqSiHdm1twX9ATw,4100
+spotifywebapipython/const.py,sha256=50BHoLMJDRh4KnIBHjbpaYqfixgOHxMMl8lF_qZlktA,4100
 spotifywebapipython/saappmessages.py,sha256=mVprjpd5CdD8kYeAkLzRvMvIQPmaYtH4UCP5my3QhSk,5065
 spotifywebapipython/sautils.py,sha256=LZF3UvxaBK35WIg1hO37nbW8j1y-M-oOxRbi1dPR39w,8746
 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=jkC2ewbsamh_YNfc0rhWLDk3Z1eaw9rmspVkxmdhH_Y,928610
+spotifywebapipython/spotifyclient.py,sha256=hya2_fpOpP9Qyg6_wuWlUmlPwquTT_8-KcDF3Eiwx08,928655
 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=ctYFvkBPlFFEoM_geP6hzwTyC2mPcrYR_zCCNvsmpwc,3870
 spotifywebapipython/spotifywebplayertoken.py,sha256=axj1j1lM7COiiZfpElkJRdnk4AmE6bAQcjKshUIz1Nk,35813
-spotifywebapipython/docs/__init__.html,sha256=FsnO64WP9HsImXs-AonCUUmUWEOlBajpYqhBYVcjNiE,199713
+spotifywebapipython/docs/__init__.html,sha256=2F9ndL51ND0rePvMs3q1AOaJB6jksyMo82YoBePSgOQ,200803
 spotifywebapipython/docs/codecopy.js,sha256=ryuoZwLIL03YitjjFzn49UO5ta7-OBos6LNA3qHhFzs,3120
-spotifywebapipython/docs/index.html,sha256=rNcPZUg3v7qJZSaXOcuFERqwC5CEm260Kc91BEbXoSg,48779
-spotifywebapipython/docs/search.js,sha256=xdiBYN4bciyd6hIKcrC6l9ySbFg0NjJ3bl6aAFns-7E,9277464
+spotifywebapipython/docs/index.html,sha256=OGv36bUHX26oGcS2HmgUEpMVSUOVAVSNhqfYOeDcfRw,48779
+spotifywebapipython/docs/search.js,sha256=wdg_LJOjbdrkNQchItK23zLj9CiU-3uVBqFjue7v4k4,9289882
 spotifywebapipython/docs/spotifywebapipython.ico,sha256=YImj39fqqSPSuB2-sMDlUYDd6YwRfQeJRtq4FjwWglg,16410
 spotifywebapipython/docs/spotifywebapipython_OLD.ico,sha256=YIv5LjcD4bTIJQSOr8jjwbWaeB3QkElRwkTOePiGbZo,14904
-spotifywebapipython/docs/spotifywebapipython/const.html,sha256=IsLvA9DVCXJm0ahAFiFqH5fCP_LDErWOknP4_-fIP0w,60537
-spotifywebapipython/docs/spotifywebapipython/saappmessages.html,sha256=5Q_EVCeeIak4bjbiBmzJt2f1P2u6dpRNq_mKWu9JEIs,62358
-spotifywebapipython/docs/spotifywebapipython/sautils.html,sha256=-yv1l4IM__IVWHIIbzRUjCUC7rQJeR2OmDHQY64fH6U,62031
-spotifywebapipython/docs/spotifywebapipython/spotifyapierror.html,sha256=S_mHY212fy_lMKx_xakhFaNaOAI8nJclAnPpKnbSGLM,48054
-spotifywebapipython/docs/spotifywebapipython/spotifyapimessage.html,sha256=eiFt3S4N5FtErC-lEnU39m3sA_ISEMr2YOU6EIDahTA,59210
-spotifywebapipython/docs/spotifywebapipython/spotifyauthtoken.html,sha256=ALxUxbPz9EUt6GxF3C1wghH3iKj-OCvOi1y5cdasaeE,59256
-spotifywebapipython/docs/spotifywebapipython/spotifyclient.html,sha256=bKgbh_ERKgTKypnQH6Gk-M-YTZgk0ihitAhPJpZkaeo,1677607
-spotifywebapipython/docs/spotifywebapipython/spotifydiscovery.html,sha256=Nj2t95BtEXLAoVyzI-unE22CgqbPVzfhu3LEGrnJ5ug,57662
-spotifywebapipython/docs/spotifywebapipython/spotifymediatypes.html,sha256=_Ntks24sCD3968HJtNHkN8IEnpgYW64hH69bY0EN7h0,51532
-spotifywebapipython/docs/spotifywebapipython/spotifytypeprefixes.html,sha256=VccKsPzaqeN00S8Oz91yTetc4VKCfrAxHdm0C3T4ozg,52401
-spotifywebapipython/docs/spotifywebapipython/spotifywebapiauthenticationerror.html,sha256=Z6TRDfiZ2ylfCkKaOGDEk5yoAE8-sc7OaX-GPIjeATM,52174
-spotifywebapipython/docs/spotifywebapipython/spotifywebapierror.html,sha256=z16KGA-IX21EQBfVLw4woYLCMjJe837_mD3jRyYkwkE,51484
-spotifywebapipython/docs/spotifywebapipython/spotifywebplayertoken.html,sha256=RtDWlyO3C3FlR7us4euXW29Spc99HRAw_JTLhJ52axc,62204
+spotifywebapipython/docs/spotifywebapipython/const.html,sha256=lHX8fMlg1Wd6MOAj9QABn9UtA3AWYFf6WTC2YOU6dsI,60537
+spotifywebapipython/docs/spotifywebapipython/saappmessages.html,sha256=8Z2OMN1jlwhsYyORHZysY-ECDOfhPCiS91huz43ceHQ,62358
+spotifywebapipython/docs/spotifywebapipython/sautils.html,sha256=BERvm-lHcFYo4-MIXhi_dfOpvlF4GHr8Ke_QGqx0Ecs,62031
+spotifywebapipython/docs/spotifywebapipython/spotifyapierror.html,sha256=8vXg0qZ5kH9nAfKJeAjrv9JLR2t5E_DMDQsbguIX1ZQ,48054
+spotifywebapipython/docs/spotifywebapipython/spotifyapimessage.html,sha256=2UlqgTeZKQzT-wFuCjLq5zvSpcimnd5ojMYvDYhNt3M,59210
+spotifywebapipython/docs/spotifywebapipython/spotifyauthtoken.html,sha256=MdmU34FdYdsn4h4glGd7cZJ70TSPTkjMq2LoI-0PmZk,59256
+spotifywebapipython/docs/spotifywebapipython/spotifyclient.html,sha256=oikPy0hqH3rbmcWoVHMCbcnFpvzjfie7yAoACBYedMM,1677607
+spotifywebapipython/docs/spotifywebapipython/spotifydiscovery.html,sha256=lcs4bqdzMxbptqGL8ElmPNvsGhFCgoNVdCmWnqblMOY,57662
+spotifywebapipython/docs/spotifywebapipython/spotifymediatypes.html,sha256=2VUSFazpMxjWW7xBSqo2zE0ncMBPttNGrZqlmf5-sMA,51532
+spotifywebapipython/docs/spotifywebapipython/spotifytypeprefixes.html,sha256=Fgypo08rN1oCBeSxlIBlOKYK6la14WUv78KgT_ri7jc,52401
+spotifywebapipython/docs/spotifywebapipython/spotifywebapiauthenticationerror.html,sha256=POs3Fp9loNh4Vpp7IHu3VUGcMS8XD0UH__39bZtzJdI,52174
+spotifywebapipython/docs/spotifywebapipython/spotifywebapierror.html,sha256=hNHWZzM2MUf4J6KEmpuNXRCbkfOx-GVeh6EnCSkbL8M,51484
+spotifywebapipython/docs/spotifywebapipython/spotifywebplayertoken.html,sha256=z8FBtuJ5ytOuNBvcRG5Nq9b9A-ZXHdHyl9P00eiEbjc,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
@@ -110,7 +110,7 @@ spotifywebapipython/oauthcli/__init__.py,sha256=K37XTxYAKT0n8otCNzWbjgJ10fAPN4WL
 spotifywebapipython/oauthcli/authclient.py,sha256=qGKa4FLBHHZQyP5ho1sIM_mNmyshQd720YwKcUFQJAw,56207
 spotifywebapipython/spotifyconnect/__init__.py,sha256=9Xl5KiJFvWLbsdb4YQ0xmF67i36ybpXCCXrWeNsKEvc,1108
 spotifywebapipython/spotifyconnect/spotifyconnectdeviceeventargs.py,sha256=35hKa0FAaPgy7W8D6MFXmga667pjwXITo8jSj1TDfE8,1988
-spotifywebapipython/spotifyconnect/spotifyconnectdirectorytask.py,sha256=Ha5Ht0PDaXNQJQxCcZEbu5SpDvETHcPgqbkr9l8WfhE,168043
+spotifywebapipython/spotifyconnect/spotifyconnectdirectorytask.py,sha256=RUXj875jstz_zRuZHn0TAn-gN59x4eA8yRRgmwTnK6Y,169688
 spotifywebapipython/spotifyconnect/spotifyconnectzeroconfcastapptask.py,sha256=jArxsjAGntTcQD9L9yVuey1L8pw0KvshlNXIBA7PqiI,23367
 spotifywebapipython/spotifyconnect/spotifyconnectzeroconfcastcontroller.py,sha256=e2wLmFq4393IdVa51w8X5UQl4KfnHRh34DMlxZfl9-g,34218
 spotifywebapipython/spotifyconnect/spotifyconnectzeroconfcastlistener.py,sha256=e7vKob2xim8H3BkxbgPj-eymftKvWgT71tzpskd0sn0,16720
@@ -132,13 +132,13 @@ spotifywebapipython/zeroconfapi/credentials.py,sha256=MIXqZvFNDjoICpZGNXPveHNl9G
 spotifywebapipython/zeroconfapi/cryptodiffiehellman.py,sha256=k-nMR68GtzODYsQrwCpvFE2XNxv-XUFbMemplldtwp4,3340
 spotifywebapipython/zeroconfapi/helpers.py,sha256=9lJFOuKYrk-e7SbU94WmFv5oiBq4k5gMS8wE1it4Wbc,1429
 spotifywebapipython/zeroconfapi/spotifyzeroconfapierror.py,sha256=rTwIrr1qV0UiQS_zBufboyZ3A3yGrdCsTAOiVA5dvzY,3031
-spotifywebapipython/zeroconfapi/zeroconfconnect.py,sha256=JzAKVc7XC_HrTH1IwsuXpcgW0rFlRYocHL8likoYYvQ,79023
-spotifywebapipython/zeroconfapi/zeroconfgetinfo.py,sha256=gTr3J3iVDR_ueP1tg-WHuCOke3eP864WGiESmOOYFUw,22243
+spotifywebapipython/zeroconfapi/zeroconfconnect.py,sha256=8SxKNnzBiDtL7Mjrs5K7v67j-qr20ixS-2jwpvsiutw,88286
+spotifywebapipython/zeroconfapi/zeroconfgetinfo.py,sha256=J8Oab4JJJ_OuNR5Q4cywTAYHUPUtarTGmmBjAzcUdq4,23135
 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.294.dist-info/LICENSE,sha256=KGcc9g0zwqNLcWnSn_ezv1UtKyhMENFhvtixpxUPNsE,1177
-spotifywebapipython-1.0.294.dist-info/METADATA,sha256=aNEmx_UG_r6U79DD-SDB6Fnswiu-1OQll8IW_BGmr6c,11644
-spotifywebapipython-1.0.294.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-spotifywebapipython-1.0.294.dist-info/top_level.txt,sha256=jTBLFlijKTesYh2dteAz4vb17qjaqWKeDjpnnwTcrjs,20
-spotifywebapipython-1.0.294.dist-info/RECORD,,
+spotifywebapipython-1.0.296.dist-info/LICENSE,sha256=KGcc9g0zwqNLcWnSn_ezv1UtKyhMENFhvtixpxUPNsE,1177
+spotifywebapipython-1.0.296.dist-info/METADATA,sha256=RgTFqUYbGNKScjkYOnpf66c1p-DFjUk9QMMyLBvTzaw,11644
+spotifywebapipython-1.0.296.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+spotifywebapipython-1.0.296.dist-info/top_level.txt,sha256=jTBLFlijKTesYh2dteAz4vb17qjaqWKeDjpnnwTcrjs,20
+spotifywebapipython-1.0.296.dist-info/RECORD,,