spotifywebapiPython 1.0.293__py3-none-any.whl → 1.0.295__py3-none-any.whl

spotifywebapipython/spotifyconnect/spotifyconnectdirectorytask.py

@@ -1,6 +1,7 @@
 # external package imports.
 from abc import abstractmethod
 import copy
+from collections import Counter
 from datetime import datetime
 import hashlib
 from pychromecast import APP_MEDIA_RECEIVER, CastBrowser, CastInfo, Chromecast, get_chromecast_from_cast_info, get_chromecast_from_host
@@ -512,7 +513,6 @@ class SpotifyConnectDirectoryTask(threading.Thread):
     def _VerifyMultizoneGroupLeader(
         self, 
         scDevice: SpotifyConnectDevice,
-        discoveryResult: ZeroconfDiscoveryResult,
         ) -> None:
         """
         Verifies the current leader for a cast group is connected and available.
@@ -520,94 +520,169 @@ class SpotifyConnectDirectoryTask(threading.Thread):
         Args:
             scDevice (SpotifyConnectDevice):
                 SpotifyConnectDevice object that contains discovery result details.
-            discoveryResult (ZeroconfDiscoveryResult):
-                Newly discovered zeroconf updates for the device.
+
+        This method should be called from a method that syncronizes access via lock
+        (using `self._SpotifyConnectDevices_RLock`), as it could possibly modify the 
+        SpotifyConnectDevices collection.
         """
+
+        member_summary:list[str] = []
+        member_hosts:list[str] = []
+        timeout:float = 2.0
+        group_uuid:UUID = UUID(scDevice.DiscoveryResult.Key)
+
         try:
 
-            leaderIP:str|None = None 
+            # get a list of device IP addresses that are members of the group, and also log
+            # a user-friendly trace line for debugging.
 
-            # the MultiZoneManager should already have processed any multi-zone updates,
-            # including leadership changes; all we need to do now is to get the ChromeCast
-            # device reference from it, and retrieve the host IP address.
+            # trace.
+            _logsi.LogObject(SILevel.Verbose, "Verifying Chromecast Multizone group leader for Cast Group: %s [UUID=%s]" % (scDevice.Title, group_uuid), scDevice.DiscoveryResult, excludeNonPublic=True, colorValue=SIColors.Coral)
 
-            # if the Chromecast device socket client reports a different host IP address
-            # than it's CastInfo object, then it means that the multizone manager update
-            # is out of sync with the mDNS update!  if that is the case, then we need to
-            # determine which of the two (if any!) is the active group leader.
+            # get multizone controller reference for the group.
+            castMultizoneController:MultizoneController = self._CastMultiZoneControllers.get(str(group_uuid), None)
+            if (castMultizoneController is not None):
 
-            # get group info from the multizone manager instance.
-            groupInfo = self._CastMultiZoneManager._groups.get(scDevice.DiscoveryResult.Key, None)
-            if (groupInfo is not None):
+                # process all members, building a list of their host addresses.
+                for member in castMultizoneController.members:
+                    scMemberDevice:SpotifyConnectDevice = self._SpotifyConnectDevices.GetDeviceByDiscoveryKey(member)
+                    if (scMemberDevice is None):
+                        member_summary.append(member)
+                    else:
+                        member_summary.append("%s [ip=%s]" % (scMemberDevice.Title, scMemberDevice.DiscoveryResult.HostIpTitle))
+                        member_hosts.append(scMemberDevice.DiscoveryResult.HostIpAddress)
 
-                # get the assumed group leader device reference.
-                castDevice:Chromecast = groupInfo.get('chromecast', None)
-                if (castDevice):
+                # trace.
+                _logsi.LogArray(SILevel.Verbose, "Chromecast Multizone group member summary: \"%s\" (count=%d)" % (scDevice.Title, len(member_summary)), member_summary, colorValue=SIColors.Coral)
 
-                    if (castDevice.socket_client) and (castDevice.socket_client.is_connected):
-                        leaderIP = castDevice.socket_client.host
+            # process each member in the group, retrieving it's multi-zone status.
 
-                    elif (castDevice.cast_info):
-                        leaderIP = castDevice.cast_info.host
+            votes: Counter[str] = Counter()
+            port_for: dict[str, int] = {}
 
-                    # do we have a group leader conflict between the multizone manager
-                    # reference and the mDNS service update?
-                    if (leaderIP != discoveryResult.HostIpAddress):
+            for host in member_hosts:
 
-                        # at this point, mDNS information is in conflict with MultiZoneManager information
-                        # about who the group leader is!  we will now query BOTH addresses to see which one
-                        # responds, and use it as the group leader.
+                # trace.
+                _logsi.LogVerbose("Retrieving Chromecast Multizone group status for member host: %s" % (host), colorValue=SIColors.Coral)
 
-                        # trace.
-                        _logsi.LogVerbose("Group leader conflict detected for device UUID: \"%s\"" % discoveryResult.Key)
+                # get multizone status for the specified group member.
+                # note that `get_multizone_status` can return both IPV4 (e.g. "192.168.1.97") and IPV6 (e.g. "::ffff:c0a8:161") addresses!
+                status = get_multizone_status(host, timeout=timeout)
 
-                        try:
+                # trace.
+                _logsi.LogDictionary(SILevel.Verbose, "Chromecast Multizone group status for member host: %s" % (host), status, prettyPrint=True, colorValue=SIColors.Coral)
+
+                # if we could not retrieve status, then move on to the next group member.
+                if status is None:
+                    continue
+
+                # add to the vote count for this host address.
+                # a member that is the LEADER answers with its own host and the group's cast_port;
+                # a member that is a FOLLOWER answers with the leader's host and no port (pychromecast 
+                # strips the ':10001' multizone port); right after a re-form, a single member can still 
+                # say 'self' although it no longer leads, so take the majority.
+                for g in status.groups:
+                    if g.uuid == group_uuid and g.host:
+                        votes[g.host] += 1
+                        if g.port:
+                            port_for[g.host] = g.port
+
+                # add to the vote count for this host address for dynamic groups as well.
+                for g in status.dynamic_groups:
+                    if g.uuid == group_uuid and g.host:
+                        votes[g.host] += 1
+                        if g.port:
+                            port_for[g.host] = g.port
 
-                            # connect to the first possible group leader.
-                            _logsi.LogVerbose("Connecting to possible Cast Group leader #1: \"%s\"" % (discoveryResult.HostIpAddress))
-                            castDevice = get_chromecast_from_host(
-                                host=(discoveryResult.HostIpAddress, discoveryResult.HostIpPort, discoveryResult.Key, scDevice.DeviceInfo.ModelDisplayName, scDevice.DeviceInfo.RemoteName),
-                                tries=1,
-                                retry_wait=0.5,
-                                timeout=2)
+            # trace.
+            _logsi.LogCollection(SILevel.Verbose, "Chromecast Multizone group leader vote summary for Cast Group: %s [UUID=%s]" % (scDevice.Title, group_uuid), votes.most_common(), colorValue=SIColors.Coral)
 
-                            # if connection was successful, then use it as the leader.
-                            leaderIP = discoveryResult.HostIpAddress
+            # we will now verify connectivity to all devices that were resolved
+            # as group leaders from the various group members.  in most cases, this
+            # should be just one device, if they all reported the same leader. 
+            # if multiple leaders were reported (this can happen while the group is 
+            # in the midst of reforming), then we will use the host address that was
+            # reported the most, using the host address that was reported the least
+            # as a fallback in case we could not connect to the most-used address.
 
-                        except Exception as ex:
+            # process all reported leaders, using most reported host address first.
+            for host, _ in votes.most_common():
 
-                            try:
+                # trace.
+                _logsi.LogVerbose("Verifying connectivity to Chromecast Multizone group leader: %s" % (host), colorValue=SIColors.Coral)
 
-                                # connect to the first possible group leader.
-                                _logsi.LogVerbose("Connecting to possible Cast Group leader #2: \"%s\"" % (leaderIP))
-                                castDevice = get_chromecast_from_host(
-                                    host=(leaderIP, scDevice.DiscoveryResult.HostIpPort, scDevice.DiscoveryResult.Key, scDevice.DeviceInfo.ModelDisplayName, scDevice.DeviceInfo.RemoteName),
-                                    tries=1,
-                                    retry_wait=0.5,
-                                    timeout=2)
+                # ensure we resolved a port for this host.
+                port = port_for.get(host)
+                if port is None:
 
-                                # if connection was successful, then use it as the leader.
-                                leaderIP = leaderIP
+                    # if a port was not resolved for this host, then it points at a host we have not 
+                    # retrieved multizone status for yet - ask it for its port.
 
-                            except Exception as ex:
+                    # trace.
+                    _logsi.LogVerbose("Retrieving Chromecast Multizone group status for member host: %s" % (host), colorValue=SIColors.Coral)
 
-                                _logsi.LogVerbose("Could not connect to either possible Cast Group leader for device: \"%s\"" % (scDevice.Title))
+                    # get multizone status for the specified group member.
+                    # note that `get_multizone_status` can return both IPV4 (e.g. "192.168.1.97") and IPV6 (e.g. "::ffff:c0a8:161") addresses!
+                    status = get_multizone_status(host, timeout=timeout)
+
+                    # trace.
+                    _logsi.LogDictionary(SILevel.Verbose, "Chromecast Multizone group status for member host: %s" % (host), status, prettyPrint=True, colorValue=SIColors.Coral)
+
+                    if status:
+                        for g in status.groups:
+                            if g.uuid == group_uuid and g.host == host and g.port:
+                                port = g.port
+                        for g in status.dynamic_groups:
+                            if g.uuid == group_uuid and g.host == host and g.port:
+                                port = g.port
+
+                # verify connectivity if we have a port for this host.
+                if port:
+
+                    try:
 
-                        # free resources.
-                        castDevice = None
+                        # trace.
+                        _logsi.LogVerbose("Verifying connection to Chromecast Multizone group leader host candidate: ip=%s, port=%s" % (host, port), colorValue=SIColors.Coral)
+
+                        # connect to the host on the designated port.  this should return almost
+                        # immediately if the device is found on the local network.
+                        with socket.create_connection((host, port), timeout=timeout):
+
+                            # if it's a good socket connection, then we will treat this host as the
+                            # group leader; update the devices collection if the addresses are different.
+                            if (host != scDevice.DiscoveryResult.HostIpAddress):
+
+                                # note that we only care about IPV4 addresses, as `get_multizone_status`
+                                # can return both IPV4 and IPV6 addresses.
+                                if (host.count(":")) > 1: # IPV6 address?
+                                    _logsi.LogVerbose("Ignoring Chromecast Multizone group leader candidate address: %s (IPV6 address)" % (host), colorValue=SIColors.Coral)
+                                else:
+                                    _logsi.LogObject(SILevel.Verbose, "Cast Group leader IP was changed from [%s] to [%s] for Cast Group \"%s\"" % (scDevice.DiscoveryResult.HostIpAddress, host, scDevice.Name), scDevice.DiscoveryResult, excludeNonPublic=True, colorValue=SIColors.ForestGreen)
+                                    scDevice.DiscoveryResult.HostIpAddress = host
+                                    scDevice.DiscoveryResult.Id = "\"%s\" (%s:%s)" % (scDevice.DiscoveryResult.DeviceName, scDevice.DiscoveryResult.HostIpAddress, scDevice.DiscoveryResult.HostIpPort)
+
+                            # connection was good; we are done here.
+                            _logsi.LogVerbose("Chromecast Multizone group leader host was verified for Cast Group: \"%s\" [%s:%s]" % (scDevice.Name, host, port), colorValue=SIColors.Coral)
+                            return
 
-                    # do we have a group leader change?
-                    if (leaderIP != scDevice.DiscoveryResult.HostIpAddress):
+                    except Exception as ex:
 
                         # trace.
-                        _logsi.LogObject(SILevel.Verbose, "Cast Group leader IP was changed from [%s] to [%s] for device \"%s\"" % (scDevice.DiscoveryResult.HostIpAddress, leaderIP, scDevice.Name), scDevice, excludeNonPublic=True, colorValue=SIColors.ForestGreen)
-                        scDevice.DiscoveryResult.HostIpAddress = leaderIP
-                        scDevice.DiscoveryResult.Id = "\"%s\" (%s:%s)" % (scDevice.DiscoveryResult.DeviceName, scDevice.DiscoveryResult.HostIpAddress, scDevice.DiscoveryResult.HostIpPort)
+                        _logsi.LogException("Chromecast Group member [ip=%s, port=%s] could not be reached; moving on to next host" % (host, port, str(ex)), ex, logToSystemLogger=False)
+                        # ignore exception and check the next available host
+
+                else:
+                    _logsi.LogVerbose("Ignoring Chromecast Multizone group leader address: %s (port not found)" % (host), colorValue=SIColors.Coral)
+
+            # if we make it here, then the cast group leader could not be verified!
+
+            # trace.
+            _logsi.LogVerbose("Could not verify Chromecast Multizone group leader for Cast Group: %s [UUID=%s] - existing host [ip=%s] will be used" % (scDevice.Title, group_uuid, scDevice.DiscoveryResult.HostIpTitle), colorValue=SIColors.Coral)
 
         except Exception as ex:
             
             # trace.
-            _logsi.LogException("Chromecast Multizone group leader query exception: %s" % (str(ex)), ex, logToSystemLogger=False)
+            _logsi.LogException("Chromecast Multizone group leader verification exception: %s" % (str(ex)), ex, logToSystemLogger=False)
             # ignore exception, as nothing can be done about it.
 
 
@@ -617,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.
@@ -637,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.
@@ -664,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.
@@ -693,7 +774,7 @@ class SpotifyConnectDirectoryTask(threading.Thread):
 
                     # verify the current leader of the group.
                     # the device collection entry will be updated if a change was detected.
-                    self._VerifyMultizoneGroupLeader(scDevice, scDevice.DiscoveryResult)
+                    self._VerifyMultizoneGroupLeader(scDevice)
 
             # is this a chromecast device?
             if (not scDevice.IsChromeCast):
@@ -754,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)):
@@ -770,110 +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:
-            
-                    # 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
+                else:
 
-                    # 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)
+                    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
 
-                    # don't need this anymore, since we are activating media receiver on each group member.
-                    # left it in here just in case we change our mind.
-                    # # calculate wait timeout for devices to become active, based on number of devices in group.
-                    # if (castMultiZoneStatus.groups is not None):
-                    #     groupCount:int = len(castMultiZoneStatus.groups)
-                    #     if (groupCount > 1):
-                    #         deviceWaitTimeoutSecs = (groupCount * 5.0)
+                # 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)
@@ -2117,7 +2197,7 @@ class SpotifyConnectDirectoryTask(threading.Thread):
 
                                 # verify the current leader of the group.
                                 # the device collection entry will be updated if a change was detected.
-                                self._VerifyMultizoneGroupLeader(scDevice, zeroconfDiscoveryResult)
+                                self._VerifyMultizoneGroupLeader(scDevice)
 
                             # is this a Google Cast Group "update_cast" event? 
                             # if so, AND the device name did not change, then ignore the update since

spotifywebapipython/spotifyconnect/spotifyconnectzeroconfcastlistener.py

@@ -149,7 +149,7 @@ class SpotifyConnectZeroconfCastListener(AbstractCastListener):
 
             # ensure IPV4 connection - ignore if IPV6.
             # Windows OS does not support dual-stack socket handling IPv4 (224.0.0.251) and IPv6 (ff02::fb).
-            if (castInfoHost.count(":")) > 1:
+            if (castInfoHost.count(":")) > 1:  #IPV6?
                 _logsi.LogDebug("Chromecast IPV6 device addresses are not supported; device could cause problems: \"%s\" (%s)" % (castInfo.friendly_name, serviceName), colorValue=SIColors.Red)
 
                 # will still allow this for now, but we might want to ignore IPV6 devices

{spotifywebapipython-1.0.293.dist-info → spotifywebapipython-1.0.295.dist-info}/METADATA

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