music-assistant-server

1"""
2MusicAssistant PlayerController.
3
4Handles all logic to control supported players,
5which are provided by Player Providers.
6
7Note that the PlayerController has a concept of a 'player' and a 'playerstate'.
8The Player is the actual object that is provided by the provider,
9which incorporates the (unaltered) state of the player (e.g. volume, state, etc)
10and functions for controlling the player (e.g. play, pause, etc).
11
12The playerstate is the (final) state of the player, including any user customizations
13and transformations that are applied to the player.
14The playerstate is the object that is exposed to the outside world (via the API).
15"""
16
17from __future__ import annotations
18
19import asyncio
20import contextlib
21import time
22import weakref
23from collections.abc import AsyncIterator
24from contextlib import suppress
25from typing import TYPE_CHECKING, Any, cast
26
27from music_assistant_models.auth import Scope
28from music_assistant_models.background_task import TaskSchedule
29from music_assistant_models.config_entries import ConfigEntry
30from music_assistant_models.constants import (
31    PLAYER_CONTROL_FAKE,
32    PLAYER_CONTROL_NATIVE,
33    PLAYER_CONTROL_NONE,
34)
35from music_assistant_models.enums import (
36    ConfigEntryType,
37    EventType,
38    IdentifierType,
39    MediaType,
40    PlaybackState,
41    PlayerFeature,
42    PlayerType,
43    ProviderFeature,
44    ProviderType,
45    SourceControl,
46)
47from music_assistant_models.errors import (
48    AlreadyRegisteredError,
49    InsufficientPermissions,
50    InvalidDataError,
51    MusicAssistantError,
52    PlayerCommandFailed,
53    PlayerUnavailableError,
54    ProviderUnavailableError,
55    UnsupportedFeaturedException,
56)
57from music_assistant_models.media_items import AudioSource
58from music_assistant_models.player import PlayerOptionValueType  # noqa: TC002
59from music_assistant_models.player_control import PlayerControl  # noqa: TC002
60
61from music_assistant.constants import (
62    ATTR_ACTIVE_SOURCE,
63    ATTR_ANNOUNCEMENT_IN_PROGRESS,
64    ATTR_AVAILABLE,
65    ATTR_ENABLED,
66    ATTR_FAKE_MUTE,
67    ATTR_FAKE_POWER,
68    ATTR_FAKE_VOLUME,
69    ATTR_GROUP_MEMBERS,
70    ATTR_GROUP_VOLUME_SNAPSHOT,
71    ATTR_LAST_POLL,
72    ATTR_MUTE_CONTROL,
73    ATTR_MUTE_LOCK,
74    ATTR_POWER_CONTROL,
75    ATTR_POWERED,
76    ATTR_PREVIOUS_VOLUME,
77    ATTR_SUPPORTED_FEATURES,
78    ATTR_VOLUME_CONTROL,
79    ATTR_VOLUME_TARGET,
80    CONF_ANNOUNCE_TTS_ENGINE,
81    CONF_AUTO_PLAY,
82    CONF_CACHED_ARP_MAC,
83    CONF_ENTRY_MAX_VOLUME,
84    CONF_ENTRY_MIN_VOLUME,
85    CONF_GROUP_MEMBERS,
86    CONF_MAX_VOLUME,
87    CONF_MIN_VOLUME,
88    CONF_MUTE_CONTROL,
89    CONF_PLAY_MEDIA_OVERRIDES_GROUP,
90    CONF_PLAYER_DSP,
91    CONF_PLAYER_QUEUES,
92    CONF_PLAYERS,
93    CONF_POWER_CONTROL,
94    CONF_PROTOCOL_PARENT_ID,
95    CONF_REPORTED_MAC,
96    CONF_VOLUME_CONTROL,
97    CONF_VOLUME_STEP,
98    VERBOSE_LOG_LEVEL,
99)
100from music_assistant.controllers.webserver.helpers.auth_middleware import (
101    get_current_user,
102    get_sendspin_player_id,
103    has_scope,
104)
105from music_assistant.helpers.api import api_command
106from music_assistant.helpers.colors import get_palette_for_url
107from music_assistant.helpers.plugin_engines import create_tts_engine_config_entries
108from music_assistant.helpers.util import (
109    TaskManager,
110    enrich_device_mac_address,
111    is_valid_mac_address,
112)
113from music_assistant.models.core_controller import CoreController
114from music_assistant.models.player import Player, PlayerMedia, PlayerState
115from music_assistant.models.player_provider import PlayerProvider
116from music_assistant.models.plugin import PluginProvider
117
118from .announcements import AnnouncementsMixin
119from .constants import PlayerLockPurpose
120from .helpers import handle_player_command, wait_for_power_on
121from .protocol_linking import ProtocolLinkingMixin
122
123if TYPE_CHECKING:
124    from collections.abc import Callable, Iterator
125
126    from music_assistant_models.config_entries import (
127        CoreConfig,
128        PlayerConfig,
129    )
130    from music_assistant_models.player import OutputProtocol
131    from music_assistant_models.player_queue import PlayerQueue
132
133    from music_assistant import MusicAssistant
134    from music_assistant.helpers.json import SerializableType
135
136CACHE_CATEGORY_PLAYER_POWER = 1
137
138# state keys that carry the current_media playback-position anchor; these only
139# change on discrete position events (play/pause/seek/track change/buffer correction)
140POSITION_ANCHOR_KEYS = frozenset(
141    {
142        "current_media.elapsed_time",
143        "current_media.elapsed_time_last_updated",
144    }
145)
146
147# How long the volume level of the last command outranks the level the player reports.
148# Long enough to cover a burst of volume nudges on a player that only reports its volume
149# back some time later, short enough for a change made on the device itself to win again.
150VOLUME_TARGET_EXPIRY = 2.0
151
152# Sentinel used to detect omitted optional arguments where ``None`` is a valid value.
153_SENTINEL: Any = object()
154
155
156class PlayerController(AnnouncementsMixin, ProtocolLinkingMixin, CoreController):
157    """Controller holding all logic to control registered players."""
158
159    domain: str = "players"
160
161    def __init__(self, mass: MusicAssistant) -> None:
162        """Initialize core controller."""
163        super().__init__(mass)
164        self._players: dict[str, Player] = {}
165        self._controls: dict[str, PlayerControl] = {}
166        self.manifest.name = "Player Controller"
167        self.manifest.description = (
168            "Music Assistant's core controller which manages all players from all providers."
169        )
170        self.manifest.icon = "speaker-multiple"
171        self._poll_task: asyncio.Task[None] | None = None
172        self._player_command_locks: dict[str, asyncio.Lock] = {}
173        # Re-entrancy tracking for get_player_lock, keyed on the task object
174        # (weak ref auto-clears entries if a task is GC'd before its finally runs).
175        self._task_held_locks: weakref.WeakKeyDictionary[asyncio.Task[Any], set[str]] = (
176            weakref.WeakKeyDictionary()
177        )
178        # Lock to prevent race conditions during player registration
179        self._register_lock = asyncio.Lock()
180        # Track pending protocol player evaluations (delayed to allow all protocols to register)
181        self._pending_protocol_evaluations: dict[str, asyncio.TimerHandle] = {}
182        # Serialize delayed evaluations to prevent race conditions
183        self._delayed_evaluation_lock = asyncio.Lock()
184        # Subscribers for player state updates (called with player + changed_values)
185        self._state_update_subscribers: list[
186            Callable[[Player, dict[str, tuple[Any, Any]]], None]
187        ] = []
188
189    @contextlib.asynccontextmanager
190    async def get_player_lock(
191        self, player_id: str, purpose: PlayerLockPurpose = PlayerLockPurpose.PLAYBACK
192    ) -> AsyncIterator[None]:
193        """
194        Acquire a purpose-scoped lock for a player, with re-entrant support.
195
196        Tracks lock ownership per asyncio Task so that nested calls within the same
197        task skip re-acquisition (preventing deadlocks), while deferred callbacks
198        (call_later / create_task) correctly acquire a fresh lock.
199
200        If the lock can't be acquired within 30s the body runs anyway, to keep
201        the player responsive when a previous holder is stuck on a hung command.
202
203        :param player_id: The player to lock.
204        :param purpose: Lock category. Commands with different purposes can run
205            concurrently on the same player.
206        """
207        lock_key = f"{purpose.value}_{player_id}"
208        task = asyncio.current_task()
209
210        if task is not None and lock_key in self._task_held_locks.get(task, set()):
211            yield
212            return
213
214        lock = self._player_command_locks.setdefault(lock_key, asyncio.Lock())
215        # Two-stage acquire: a slow-acquire log at 5s and a hard give-up at 30s.
216        # If the previous holder is stuck (e.g. on a dead provider socket), we
217        # proceed without the lock so this player stays responsive.
218        acquired = False
219        try:
220            async with asyncio.timeout(5):
221                await lock.acquire()
222            acquired = True
223        except TimeoutError:
224            self.logger.debug(
225                "Acquiring %s lock for player %s is slow (>5s)", purpose.value, player_id
226            )
227            try:
228                async with asyncio.timeout(25):
229                    await lock.acquire()
230                acquired = True
231            except TimeoutError:
232                self.logger.warning(
233                    "Timed out (30s) acquiring %s lock for player %s — "
234                    "previous holder appears stuck; proceeding without lock",
235                    purpose.value,
236                    player_id,
237                )
238
239        if acquired and task is not None:
240            self._task_held_locks.setdefault(task, set()).add(lock_key)
241        try:
242            yield
243        finally:
244            if acquired:
245                if task is not None and (held := self._task_held_locks.get(task)) is not None:
246                    held.discard(lock_key)
247                    if not held:
248                        del self._task_held_locks[task]
249                lock.release()
250
251    async def get_config_entries(self) -> tuple[ConfigEntry, ...]:
252        """Return Config Entries for the Player Controller."""
253        return (
254            ConfigEntry(
255                key=CONF_VOLUME_STEP,
256                type=ConfigEntryType.INTEGER,
257                default_value=0,
258                range=(0, 10),
259                required=False,
260                category="generic",
261            ),
262            *await create_tts_engine_config_entries(
263                self.mass, CONF_ANNOUNCE_TTS_ENGINE, category="announcements"
264            ),
265        )
266
267    async def setup(self, config: CoreConfig) -> None:
268        """Async initialize of module."""
269        self._repair_protocol_parent_links()
270        self._poll_task = self.mass.create_task(self._poll_players())
271        self.mass.tasks.register_scheduled_task(
272            task_id="fix_group_member_configs",
273            name="Fix sync group member configurations",
274            handler=self._fix_group_member_configs,
275            schedule=TaskSchedule.weekly(
276                days_of_week=[0],
277                hour=4,
278                minute=0,
279            ),
280            initial_delay=300,
281        )
282
283    async def close(self) -> None:
284        """Cleanup on exit."""
285        if self._poll_task and not self._poll_task.done():
286            self._poll_task.cancel()
287        # Cancel all pending protocol evaluations
288        for handle in self._pending_protocol_evaluations.values():
289            handle.cancel()
290        self._pending_protocol_evaluations.clear()
291        for player in self._players.values():
292            if player.sleep_timer_expires_at is not None:
293                self.mass.cancel_timer(self._sleep_timer_task_id(player.player_id))
294
295    async def get_diagnostics(self) -> dict[str, SerializableType]:
296        """Return diagnostics info for this controller to include in diagnostics reports."""
297        players = list(self._players.values())
298        return {
299            "players_synced": sum(player.state.synced_to is not None for player in players),
300            "players_with_active_group": sum(
301                player.state.active_group is not None for player in players
302            ),
303            "announcements_in_progress": sum(
304                bool(player.extra_data.get(ATTR_ANNOUNCEMENT_IN_PROGRESS)) for player in players
305            ),
306            "pending_protocol_evaluations": len(self._pending_protocol_evaluations),
307        }
308
309    async def on_provider_loaded(self, provider: PlayerProvider) -> None:
310        """Handle logic when a provider is loaded."""
311
312    async def on_provider_unload(self, provider: PlayerProvider) -> None:
313        """Handle logic when a provider is (about to get) unloaded."""
314
315    @property
316    def providers(self) -> list[PlayerProvider]:
317        """Return all loaded/running MusicProviders."""
318        return cast("list[PlayerProvider]", self.mass.get_providers(ProviderType.PLAYER))
319
320    def iter_players(
321        self,
322        return_unavailable: bool = True,
323        return_disabled: bool = False,
324        provider_filter: str | None = None,
325        return_protocol_players: bool = False,
326    ) -> Iterator[Player]:
327        """
328        Iterate over all registered players, regardless of who is asking.
329
330        Use this for internal logic - state derivation, bookkeeping and topology
331        lookups - which must stay correct no matter which user's command happened
332        to trigger it. Use :meth:`all_players` for anything presented to a user.
333
334        :param return_unavailable [bool]: Include unavailable players.
335        :param return_disabled [bool]: Include disabled players.
336        :param provider_filter [str]: Optional filter by provider lookup key.
337        :param return_protocol_players [bool]: Include protocol players (hidden by default).
338        """
339        for player in list(self._players.values()):
340            if not (player.state.available or return_unavailable):
341                continue
342            if not (player.state.enabled or return_disabled):
343                continue
344            if not player.initialized.is_set():
345                continue
346            if provider_filter is not None and player.provider.instance_id != provider_filter:
347                continue
348            if not return_protocol_players and player.state.type == PlayerType.PROTOCOL:
349                continue
350            yield player
351
352    def all_players(
353        self,
354        return_unavailable: bool = True,
355        return_disabled: bool = False,
356        provider_filter: str | None = None,
357        return_protocol_players: bool = False,
358    ) -> list[Player]:
359        """
360        Return the registered players the current user is allowed to see.
361
362        Note that this applies user filters for players (for non admin users),
363        which makes it unsuitable for internal logic - use :meth:`iter_players` there.
364
365        :param return_unavailable [bool]: Include unavailable players.
366        :param return_disabled [bool]: Include disabled players.
367        :param provider_filter [str]: Optional filter by provider lookup key.
368        :param return_protocol_players [bool]: Include protocol players (hidden by default).
369
370        :return: List of Player objects.
371        """
372        current_user = get_current_user()
373        user_filter = (
374            current_user.player_filter
375            if current_user and not has_scope(current_user, Scope.ALL)
376            else None
377        )
378        current_sendspin_player = get_sendspin_player_id()
379        return [
380            player
381            for player in self.iter_players(
382                return_unavailable=return_unavailable,
383                return_disabled=return_disabled,
384                provider_filter=provider_filter,
385                return_protocol_players=return_protocol_players,
386            )
387            if not user_filter
388            or player.player_id in user_filter
389            or player.player_id == current_sendspin_player
390        ]
391
392    @api_command("players/all", required_scope=Scope.PLAYERS_READ)
393    def all_player_states(
394        self,
395        return_unavailable: bool = True,
396        return_disabled: bool = False,
397        provider_filter: str | None = None,
398        return_protocol_players: bool = False,
399    ) -> list[PlayerState]:
400        """
401        Return PlayerState for all registered players.
402
403        :param return_unavailable [bool]: Include unavailable players.
404        :param return_disabled [bool]: Include disabled players.
405        :param provider_filter [str]: Optional filter by provider lookup key.
406        :param return_protocol_players [bool]: Include protocol players (hidden by default).
407
408        :return: List of PlayerState objects.
409        """
410        return [
411            player.state
412            for player in self.all_players(
413                return_unavailable=return_unavailable,
414                return_disabled=return_disabled,
415                provider_filter=provider_filter,
416                return_protocol_players=return_protocol_players,
417            )
418        ]
419
420    def get_player(
421        self,
422        player_id: str,
423        raise_unavailable: bool = False,
424    ) -> Player | None:
425        """
426        Return Player by player_id.
427
428        :param player_id [str]: ID of the player.
429        :param raise_unavailable [bool]: Raise if player is unavailable.
430
431        :raises PlayerUnavailableError: If player is unavailable and raise_unavailable is True.
432        :return: Player object or None.
433        """
434        if player := self._players.get(player_id):
435            if (not player.state.available or not player.state.enabled) and raise_unavailable:
436                msg = f"Player {player_id} is not available"
437                raise PlayerUnavailableError(msg)
438            return player
439        if raise_unavailable:
440            msg = f"Player {player_id} is not available"
441            raise PlayerUnavailableError(msg)
442        return None
443
444    @api_command("players/get", required_scope=Scope.PLAYERS_READ)
445    def get_player_state(
446        self,
447        player_id: str,
448        raise_unavailable: bool = False,
449    ) -> PlayerState | None:
450        """
451        Return PlayerState by player_id.
452
453        :param player_id [str]: ID of the player.
454        :param raise_unavailable [bool]: Raise if player is unavailable.
455
456        :raises PlayerUnavailableError: If player is unavailable and raise_unavailable is True.
457        :return: Player object or None.
458        """
459        current_user = get_current_user()
460        user_filter = (
461            current_user.player_filter
462            if current_user and not has_scope(current_user, Scope.ALL)
463            else None
464        )
465        current_sendspin_player = get_sendspin_player_id()
466        if (
467            current_user
468            and user_filter
469            and player_id not in user_filter
470            and player_id != current_sendspin_player
471        ):
472            msg = f"{current_user.username} does not have access to player {player_id}"
473            raise InsufficientPermissions(msg)
474        if player := self.get_player(player_id, raise_unavailable):
475            return player.state
476        return None
477
478    def get_player_by_name(self, name: str) -> Player | None:
479        """
480        Return Player by name.
481
482        Performs case-insensitive matching against the player's state name
483        (the final name visible in clients and API).
484        If multiple players match, logs a warning and returns the first match.
485
486        :param name: Name of the player.
487        :return: Player object or None.
488        """
489        name_normalized = name.strip().lower()
490        matches: list[Player] = []
491
492        for player in list(self._players.values()):
493            if player.state.name.strip().lower() == name_normalized:
494                matches.append(player)
495
496        if not matches:
497            return None
498
499        if len(matches) > 1:
500            player_ids = [p.player_id for p in matches]
501            self.logger.warning(
502                "players/get_by_name: Multiple players found with name '%s': %s - "
503                "returning first match (%s). "
504                "Consider using the players/get API with player_id instead "
505                "for unambiguous lookups.",
506                name,
507                player_ids,
508                matches[0].player_id,
509            )
510
511        return matches[0]
512
513    @api_command("players/get_by_name", required_scope=Scope.PLAYERS_READ)
514    def get_player_state_by_name(self, name: str) -> PlayerState | None:
515        """
516        Return PlayerState by name.
517
518        :param name: Name of the player.
519        :return: PlayerState object or None.
520        """
521        current_user = get_current_user()
522        user_filter = (
523            current_user.player_filter
524            if current_user and not has_scope(current_user, Scope.ALL)
525            else None
526        )
527        current_sendspin_player = get_sendspin_player_id()
528        if player := self.get_player_by_name(name):
529            if (
530                current_user
531                and user_filter
532                and player.player_id not in user_filter
533                and player.player_id != current_sendspin_player
534            ):
535                msg = f"{current_user.username} does not have access to player {player.player_id}"
536                raise InsufficientPermissions(msg)
537            return player.state
538        return None
539
540    @api_command("players/player_controls", required_scope=Scope.PLAYERS_READ)
541    def player_controls(
542        self,
543    ) -> list[PlayerControl]:
544        """Return all registered playercontrols."""
545        return list(self._controls.values())
546
547    @api_command("players/player_control", required_scope=Scope.PLAYERS_READ)
548    def get_player_control(
549        self,
550        control_id: str,
551    ) -> PlayerControl | None:
552        """
553        Return PlayerControl by control_id.
554
555        :param control_id: ID of the player control.
556        :return: PlayerControl object or None.
557        """
558        if control := self._controls.get(control_id):
559            return control
560        return None
561
562    @api_command("players/sleep_timer/get", required_scope=Scope.PLAYERS_READ)
563    def get_sleep_timer(self, player_id: str) -> float | None:
564        """
565        Return the active sleep timer expiry timestamp for the player.
566
567        :param player_id: Player ID to check.
568        """
569        player = self._get_player_with_redirect(player_id)
570        return player.sleep_timer_expires_at
571
572    @api_command("players/sleep_timer/set", required_scope=Scope.PLAYERS_CONTROL)
573    def set_sleep_timer(self, player_id: str, seconds: int) -> float:
574        """
575        Set a sleep timer for the player.
576
577        :param player_id: Player ID to set the timer for.
578        :param seconds: Delay in seconds before playback is stopped.
579        """
580        if seconds <= 0:
581            msg = "Sleep timer duration must be greater than zero seconds"
582            raise InvalidDataError(msg)
583        player = self._get_player_with_redirect(player_id)
584        try:
585            # guard against absurd durations that overflow the float timestamp math
586            expires_at = time.time() + seconds
587        except OverflowError:
588            msg = "Sleep timer duration is too large to schedule"
589            raise InvalidDataError(msg) from None
590        player.set_sleep_timer_expires_at(expires_at)
591        player.update_state()
592        self._signal_sleep_timer_updated(player, expires_at)
593        self.mass.call_later(
594            seconds,
595            self._handle_sleep_timer_expired,
596            player.player_id,
597            task_id=self._sleep_timer_task_id(player.player_id),
598        )
599        return expires_at
600
601    @api_command("players/sleep_timer/clear", required_scope=Scope.PLAYERS_CONTROL)
602    def clear_sleep_timer(self, player_id: str) -> None:
603        """
604        Clear the active sleep timer for the player.
605
606        :param player_id: Player ID to clear the timer for.
607        """
608        player = self._get_player_with_redirect(player_id)
609        self._clear_sleep_timer(player)
610
611    # Player commands
612
613    @api_command("players/cmd/stop", required_scope=Scope.PLAYERS_CONTROL)
614    @handle_player_command(lock=PlayerLockPurpose.PLAYBACK)
615    async def cmd_stop(self, player_id: str) -> None:
616        """
617        Send STOP command to given player.
618
619        - player_id: player_id of the player to handle the command.
620        """
621        player = self._get_player_with_redirect(player_id)
622        # Redirect to queue controller if it is active (skip if already in queue command context)
623        if active_queue := self.get_active_queue(player):
624            await self.mass.player_queues.stop(active_queue.queue_id)
625            return
626        # Delegate to internal handler for actual implementation
627        await self._handle_cmd_stop(player.player_id)
628
629    @api_command("players/cmd/play", required_scope=Scope.PLAYERS_CONTROL)
630    @handle_player_command
631    async def cmd_play(self, player_id: str) -> None:
632        """
633        Send PLAY (unpause) command to given player.
634
635        - player_id: player_id of the player to handle the command.
636        """
637        player = self._get_player_with_redirect(player_id)
638        if player.state.playback_state == PlaybackState.PLAYING:
639            self.logger.info(
640                "Ignore PLAY request to player %s: player is already playing", player.state.name
641            )
642            return
643        # player is not paused: check for queue redirect, then delegate to internal handler
644        if player.state.playback_state != PlaybackState.PAUSED:
645            source = player.state.active_source
646            if active_queue := self.mass.player_queues.get(source or player_id):
647                await self.mass.player_queues.resume(active_queue.queue_id)
648                return
649
650        # Delegate to internal handler for actual implementation
651        await self._handle_cmd_play(player.player_id)
652
653    @api_command("players/cmd/pause", required_scope=Scope.PLAYERS_CONTROL)
654    @handle_player_command
655    async def cmd_pause(self, player_id: str) -> None:
656        """
657        Send PAUSE command to given player.
658
659        - player_id: player_id of the player to handle the command.
660        """
661        player = self._get_player_with_redirect(player_id)
662        # Redirect to queue controller if it is active (skip if already in queue command context)
663        if active_queue := self.get_active_queue(player):
664            await self.mass.player_queues.pause(active_queue.queue_id)
665            return
666        # Delegate to internal handler for actual implementation
667        await self._handle_cmd_pause(player.player_id)
668
669    @api_command("players/cmd/play_pause", required_scope=Scope.PLAYERS_CONTROL)
670    async def cmd_play_pause(self, player_id: str) -> None:
671        """
672        Toggle play/pause on given player.
673
674        - player_id: player_id of the player to handle the command.
675        """
676        player = self._get_player_with_redirect(player_id)
677        if player.state.playback_state == PlaybackState.PLAYING:
678            await self.cmd_pause(player.player_id)
679        else:
680            await self.cmd_play(player.player_id)
681
682    @api_command("players/cmd/resume", required_scope=Scope.PLAYERS_CONTROL)
683    @handle_player_command(lock=PlayerLockPurpose.PLAYBACK)
684    async def cmd_resume(
685        self, player_id: str, source: str | None = None, media: PlayerMedia | None = None
686    ) -> None:
687        """
688        Send RESUME command to given player.
689
690        Resume (or restart) playback on the player.
691
692        :param player_id: player_id of the player to handle the command.
693        :param source: Optional source to resume.
694        :param media: Optional media to resume.
695        """
696        await self._handle_cmd_resume(player_id, source, media)
697
698    @api_command("players/cmd/seek", required_scope=Scope.PLAYERS_CONTROL)
699    @handle_player_command
700    async def cmd_seek(self, player_id: str, position: int) -> None:
701        """
702        Handle SEEK command for given player.
703
704        - player_id: player_id of the player to handle the command.
705        - position: position in seconds to seek to in the current playing item.
706        """
707        player = self._get_player_with_redirect(player_id)
708        # If an AudioSource is the active queue item, proxy the seek to the plugin
709        if active := self._get_active_audio_source(player):
710            audio_source, plugin_prov = active
711            if audio_source.can_seek:
712                await plugin_prov.on_source_control(
713                    audio_source.item_id, SourceControl.SEEK, position
714                )
715                return
716        # Redirect to queue controller if it is active
717        if active_queue := self.get_active_queue(player):
718            await self.mass.player_queues.seek(active_queue.queue_id, position)
719            return
720        # handle command on player/source directly
721        active_source = next((x for x in player.source_list if x.id == player.active_source), None)
722        if active_source and not active_source.can_seek:
723            msg = (
724                f"The active source ({active_source.name}) on player "
725                f"{player.display_name} does not support seeking"
726            )
727            raise PlayerCommandFailed(msg)
728        if PlayerFeature.SEEK not in player.supported_features:
729            msg = f"Player {player.display_name} does not support seeking"
730            raise UnsupportedFeaturedException(msg)
731        # handle command on player directly
732        await player.seek(position)
733
734    @api_command("players/cmd/next", required_scope=Scope.PLAYERS_CONTROL)
735    @handle_player_command
736    async def cmd_next_track(self, player_id: str) -> None:
737        """Handle NEXT TRACK command for given player."""
738        player = self._get_player_with_redirect(player_id)
739        active_source_id = player.state.active_source or player.player_id
740        # If an AudioSource is the active queue item, proxy next to the plugin
741        if active := self._get_active_audio_source(player):
742            audio_source, plugin_prov = active
743            if audio_source.can_next_previous:
744                await plugin_prov.on_source_control(audio_source.item_id, SourceControl.NEXT)
745                return
746        # Redirect to queue controller if it is active
747        if active_queue := self.get_active_queue(player):
748            await self.mass.player_queues.next(active_queue.queue_id)
749            return
750        if PlayerFeature.NEXT_PREVIOUS in player.state.supported_features:
751            # player has some other source active and native next/previous support
752            active_source = next(
753                (x for x in player.state.source_list if x.id == active_source_id), None
754            )
755            if active_source and active_source.can_next_previous:
756                await player.next_track()
757                return
758            msg = "This action is (currently) unavailable for this source."
759            raise PlayerCommandFailed(msg)
760        # Player does not support next/previous feature
761        msg = f"Player {player.state.name} does not support skipping to the next track."
762        raise UnsupportedFeaturedException(msg)
763
764    @api_command("players/cmd/previous", required_scope=Scope.PLAYERS_CONTROL)
765    @handle_player_command
766    async def cmd_previous_track(self, player_id: str) -> None:
767        """Handle PREVIOUS TRACK command for given player."""
768        player = self._get_player_with_redirect(player_id)
769        active_source_id = player.state.active_source or player.player_id
770        # If an AudioSource is the active queue item, proxy previous to the plugin
771        if active := self._get_active_audio_source(player):
772            audio_source, plugin_prov = active
773            if audio_source.can_next_previous:
774                await plugin_prov.on_source_control(audio_source.item_id, SourceControl.PREVIOUS)
775                return
776        # Redirect to queue controller if it is active
777        if active_queue := self.get_active_queue(player):
778            await self.mass.player_queues.previous(active_queue.queue_id)
779            return
780        if PlayerFeature.NEXT_PREVIOUS in player.state.supported_features:
781            # player has some other source active and native next/previous support
782            active_source = next(
783                (x for x in player.state.source_list if x.id == active_source_id), None
784            )
785            if active_source and active_source.can_next_previous:
786                await player.previous_track()
787                return
788            msg = "This action is (currently) unavailable for this source."
789            raise PlayerCommandFailed(msg)
790        # Player does not support next/previous feature
791        msg = f"Player {player.state.name} does not support skipping to the previous track."
792        raise UnsupportedFeaturedException(msg)
793
794    @api_command("players/cmd/power", required_scope=Scope.PLAYERS_CONTROL)
795    @handle_player_command(lock=PlayerLockPurpose.PLAYBACK)
796    async def cmd_power(self, player_id: str, powered: bool) -> None:
797        """
798        Send POWER command to given player.
799
800        :param player_id: player_id of the player to handle the command.
801        :param powered: bool if player should be powered on or off.
802        """
803        # Power is serialized with PLAYBACK because powering on a sync/group player
804        # forms the group (and powering off dissolves it) - this must not race with
805        # play_media / cmd_resume / cmd_set_members on the same player.
806        await self._handle_cmd_power(player_id, powered)
807
808    @api_command("players/cmd/volume_set", required_scope=Scope.PLAYERS_CONTROL)
809    @handle_player_command
810    async def cmd_volume_set(self, player_id: str, volume_level: int) -> None:
811        """
812        Send VOLUME_SET command to given player.
813
814        :param player_id: player_id of the player to handle the command.
815        :param volume_level: volume level (0..100) to set on the player.
816        """
817        volume_level = max(0, min(100, volume_level))
818        # record the level and invalidate the group volume state up front, before waiting
819        # for the volume lock: a command that is still queued would otherwise undo what a
820        # command issued after it already recorded.
821        # skip for group players since _handle_cmd_volume_set redirects those to
822        # set_group_volume which creates/uses the snapshot itself
823        if (player := self.get_player(player_id)) and player.type != PlayerType.GROUP:
824            self._record_volume_target(player, volume_level)
825            self._invalidate_group_volume_snapshot(player_id)
826        async with self.get_player_lock(player_id, PlayerLockPurpose.VOLUME):
827            await self._handle_cmd_volume_set(player_id, volume_level, record_target=False)
828
829    @api_command("players/cmd/volume_up", required_scope=Scope.PLAYERS_CONTROL)
830    @handle_player_command
831    async def cmd_volume_up(self, player_id: str) -> None:
832        """
833        Send VOLUME_UP command to given player.
834
835        - player_id: player_id of the player to handle the command.
836        """
837        if not (player := self.get_player(player_id)):
838            return
839        if player.type == PlayerType.GROUP:
840            await self.cmd_group_volume_up(player_id)
841            return
842        current_volume = self._volume_nudge_base(player) or 0
843        new_volume = min(100, current_volume + self._get_volume_step(current_volume))
844        await self.cmd_volume_set(player_id, new_volume)
845
846    @api_command("players/cmd/volume_down", required_scope=Scope.PLAYERS_CONTROL)
847    @handle_player_command
848    async def cmd_volume_down(self, player_id: str) -> None:
849        """
850        Send VOLUME_DOWN command to given player.
851
852        - player_id: player_id of the player to handle the command.
853        """
854        if not (player := self.get_player(player_id)):
855            return
856        if player.type == PlayerType.GROUP:
857            await self.cmd_group_volume_down(player_id)
858            return
859        current_volume = self._volume_nudge_base(player) or 0
860        new_volume = max(0, current_volume - self._get_volume_step(current_volume))
861        await self.cmd_volume_set(player_id, new_volume)
862
863    @api_command("players/cmd/group_volume", required_scope=Scope.PLAYERS_CONTROL)
864    @handle_player_command
865    async def cmd_group_volume(
866        self,
867        player_id: str,
868        volume_level: int,
869    ) -> None:
870        """
871        Handle adjusting the overall/group volume to a playergroup (or synced players).
872
873        Will set a new (overall) volume level to a group player or syncgroup.
874
875        :param player_id: Player ID of group player or syncleader to handle the command.
876        :param volume_level: Volume level (0..100) to set to the group.
877        """
878        player = self.get_player(player_id, True)
879        assert player is not None  # for type checker
880        group_player = self._resolve_group_volume_player(player)
881        if group_player is None:
882            # treat as normal player volume change
883            await self.cmd_volume_set(player_id, volume_level)
884            return
885        async with self.get_player_lock(group_player.player_id, PlayerLockPurpose.GROUP_VOLUME):
886            await self.set_group_volume(group_player, volume_level)
887
888    @api_command("players/cmd/group_volume_up", required_scope=Scope.PLAYERS_CONTROL)
889    @handle_player_command
890    async def cmd_group_volume_up(self, player_id: str) -> None:
891        """
892        Send VOLUME_UP command to given playergroup.
893
894        - player_id: player_id of the player to handle the command.
895        """
896        player = self.get_player(player_id, True)
897        assert player is not None  # for type checker
898        # step from the volume of the group as a whole, which is not the volume of the
899        # addressed player when the command is addressed to one of its synced members
900        group_player = self._resolve_group_volume_player(player) or player
901        async with self.get_player_lock(group_player.player_id, PlayerLockPurpose.GROUP_VOLUME):
902            cur_volume = self._group_volume_nudge_base(group_player)
903            if cur_volume is None:
904                return
905            new_volume = min(100, cur_volume + self._get_volume_step(cur_volume))
906            await self.cmd_group_volume(player_id, new_volume)
907
908    @api_command("players/cmd/group_volume_down", required_scope=Scope.PLAYERS_CONTROL)
909    @handle_player_command
910    async def cmd_group_volume_down(self, player_id: str) -> None:
911        """
912        Send VOLUME_DOWN command to given playergroup.
913
914        - player_id: player_id of the player to handle the command.
915        """
916        player = self.get_player(player_id, True)
917        assert player is not None  # for type checker
918        group_player = self._resolve_group_volume_player(player) or player
919        async with self.get_player_lock(group_player.player_id, PlayerLockPurpose.GROUP_VOLUME):
920            cur_volume = self._group_volume_nudge_base(group_player)
921            if cur_volume is None:
922                return
923            new_volume = max(0, cur_volume - self._get_volume_step(cur_volume))
924            await self.cmd_group_volume(player_id, new_volume)
925
926    @api_command("players/cmd/group_volume_mute", required_scope=Scope.PLAYERS_CONTROL)
927    @handle_player_command
928    async def cmd_group_volume_mute(self, player_id: str, muted: bool) -> None:
929        """
930        Handle muting a playergroup (or synced players) as a whole.
931
932        A group player or syncleader mutes all of its members, a synced player is
933        redirected to its syncleader and an ungrouped player is muted on its own.
934
935        :param player_id: Player ID of the player to handle the command.
936        :param muted: bool if the group should be muted.
937        """
938        player = self.get_player(player_id, True)
939        assert player is not None  # for type checker
940        if player.state.type == PlayerType.GROUP or player.state.group_members:
941            # dedicated group player or sync leader
942            await self._mute_group_members(player, muted)
943            return
944        if player.state.synced_to and (sync_leader := self.get_player(player.state.synced_to)):
945            # redirect to sync leader
946            await self._mute_group_members(sync_leader, muted)
947            return
948        # treat as normal player mute
949        await self.cmd_volume_mute(player_id, muted)
950
951    @api_command("players/cmd/volume_mute", required_scope=Scope.PLAYERS_CONTROL)
952    @handle_player_command(lock=PlayerLockPurpose.VOLUME)
953    async def cmd_volume_mute(self, player_id: str, muted: bool) -> None:
954        """
955        Send VOLUME_MUTE command to given player.
956
957        - player_id: player_id of the player to handle the command.
958        - muted: bool if player should be muted.
959        """
960        player = self.get_player(player_id, True)
961        assert player
962
963        if player.type == PlayerType.GROUP:
964            # redirect to special group mute control
965            await self.cmd_group_volume_mute(player_id, muted)
966            return
967
968        # clearing the mute lock may not depend on mute support, otherwise a lock set
969        # while the player still had a mute control would outlive a control change
970        if not muted:
971            player.extra_data.pop(ATTR_MUTE_LOCK, None)
972
973        mute_control = player.mute_control
974        if mute_control == PLAYER_CONTROL_NONE:
975            raise UnsupportedFeaturedException(
976                f"Player {player.state.name} does not support muting"
977            )
978
979        # Set mute lock for players in a group
980        # This prevents auto-unmute when group volume changes
981        had_mute_lock = ATTR_MUTE_LOCK in player.extra_data
982        if muted and self._is_in_group(player.state):
983            player.extra_data[ATTR_MUTE_LOCK] = True
984
985        try:
986            await self._handle_cmd_volume_mute(player, mute_control, muted)
987        except Exception:
988            # a mute that did not happen may not leave a lock behind, but a lock
989            # earned by an earlier successful mute must survive
990            if not had_mute_lock:
991                player.extra_data.pop(ATTR_MUTE_LOCK, None)
992            raise
993
994    @handle_player_command
995    async def play_media(self, player_id: str, media: PlayerMedia) -> None:
996        """
997        Handle PLAY MEDIA on given player.
998
999        :param player_id: player_id of the player to handle the command.
1000        :param media: The Media that needs to be played on the player.
1001        """
1002        # An explicit play_media on a captured player honors the player's
1003        # CONF_PLAY_MEDIA_OVERRIDES_GROUP preference (default: True) — the
1004        # player is released from its group/sync first, then plays the media
1005        # standalone. With the preference off, behavior falls back to the
1006        # legacy "redirect to group leader" path below.
1007        # Note: the release step runs outside the PLAYBACK lock to avoid an
1008        # AB-BA cycle with cmd_set_members(group), which acquires lock(group)
1009        # then lock(sync_leader) via the sync_group provider.
1010        target_player = self.get_player(player_id, True)
1011        if target_player is not None and (
1012            target_player.state.synced_to or target_player.state.active_group
1013        ):
1014            override = bool(
1015                self.mass.config.get_raw_player_config_value(
1016                    target_player.player_id,
1017                    CONF_PLAY_MEDIA_OVERRIDES_GROUP,
1018                    True,
1019                )
1020            )
1021            if override:
1022                await self._release_player_for_play_media(target_player)
1023                async with self.get_player_lock(
1024                    target_player.player_id, PlayerLockPurpose.PLAYBACK
1025                ):
1026                    await self._handle_play_media(target_player.player_id, media)
1027                return
1028        player = self._get_player_with_redirect(player_id)
1029        async with self.get_player_lock(player.player_id, PlayerLockPurpose.PLAYBACK):
1030            await self._handle_play_media(player.player_id, media)
1031
1032    @api_command("players/cmd/select_sound_mode", required_scope=Scope.PLAYERS_CONTROL)
1033    @handle_player_command
1034    async def select_sound_mode(self, player_id: str, sound_mode: str) -> None:
1035        """
1036        Handle SELECT SOUND MODE command on given player.
1037
1038        - player_id: player_id of the player to handle the command
1039        - sound_mode: The ID of the sound mode that needs to be activated/selected.
1040        """
1041        player = self.get_player(player_id, True)
1042        assert player is not None  # for type checking
1043
1044        if PlayerFeature.SELECT_SOUND_MODE not in player.supported_features:
1045            raise UnsupportedFeaturedException(
1046                f"Player {player.display_name} does not support sound mode selection"
1047            )
1048
1049        prev_sound_mode = player.active_sound_mode
1050        if sound_mode == prev_sound_mode:
1051            return
1052
1053        # basic check if sound mode is valid for player
1054        if not any(x for x in player.sound_mode_list if x.id == sound_mode):
1055            raise PlayerCommandFailed(
1056                f"{sound_mode} is an invalid sound_mode for player {player.display_name}"
1057            )
1058
1059        # forward to player
1060        await player.select_sound_mode(sound_mode)
1061
1062    @api_command("players/cmd/set_option", required_scope=Scope.PLAYERS_CONTROL)
1063    @handle_player_command
1064    async def set_option(
1065        self, player_id: str, option_key: str, option_value: PlayerOptionValueType
1066    ) -> None:
1067        """
1068        Handle SET_OPTION command on given player.
1069
1070        - player_id: player_id of the player to handle the command
1071        - option_key: The key of the player option that needs to be activated/selected.
1072        - option_value: The new value of the player option.
1073        """
1074        player = self.get_player(player_id, True)
1075        assert player is not None  # for type checking
1076
1077        if PlayerFeature.OPTIONS not in player.supported_features:
1078            raise UnsupportedFeaturedException(
1079                f"Player {player.display_name} does not support set_option"
1080            )
1081
1082        prev_player_option = next((x for x in player.options if x.key == option_key), None)
1083        if not prev_player_option:
1084            return
1085        if prev_player_option.value == option_value:
1086            return
1087
1088        if prev_player_option.read_only:
1089            raise UnsupportedFeaturedException(
1090                f"Player {player.display_name} option {option_key} is read-only"
1091            )
1092
1093        # forward to player
1094        await player.set_option(option_key=option_key, option_value=option_value)
1095
1096    @api_command("players/cmd/select_source", required_scope=Scope.PLAYERS_CONTROL)
1097    @handle_player_command
1098    async def select_source(self, player_id: str, source: str | None) -> None:
1099        """
1100        Handle SELECT SOURCE command on given player.
1101
1102        - player_id: player_id of the player to handle the command.
1103        - source: The ID of the source that needs to be activated/selected.
1104        """
1105        if source is None:
1106            source = player_id  # default to MA queue source
1107        player = self.get_player(player_id, True)
1108        assert player is not None  # for type checking
1109        # If player is currently grouped, handle it so the source switch can proceed.
1110        # This allows external sources (e.g. Spotify Connect, AirPlay) to take over a grouped player.
1111        if player.state.active_group and (
1112            group_player := self.get_player(player.state.active_group)
1113        ):
1114            if player_id in group_player.state.static_group_members:
1115                # player is a static member of a permanent group - stop the group
1116                # and power it off if supported, rather than removing the member
1117                await self._handle_cmd_stop(group_player.player_id)
1118                if group_player.state.power_control != PLAYER_CONTROL_NONE:
1119                    await self._handle_cmd_power(group_player.player_id, False)
1120            else:
1121                await self.cmd_ungroup(player_id)
1122        elif player.state.synced_to:
1123            await self.cmd_ungroup(player_id)
1124        # Delegate to internal handler for actual implementation
1125        await self._handle_select_source(player_id, source)
1126
1127    async def deselect_source(self, player_id: str) -> None:
1128        """
1129        Deselect the current source and stop the player.
1130
1131        Use this when an external source (plugin/receiver) disconnects and the player
1132        should stop playback rather than switch to another source.
1133
1134        :param player_id: player_id of the player to stop and deselect.
1135        """
1136        player = self.get_player(player_id, raise_unavailable=False)
1137        if not player:
1138            return
1139        with suppress(PlayerCommandFailed, PlayerUnavailableError, RuntimeError):
1140            await self._handle_cmd_stop(player_id)
1141
1142    @handle_player_command(lock=PlayerLockPurpose.PLAYBACK)
1143    async def enqueue_next_media(self, player_id: str, media: PlayerMedia) -> None:
1144        """
1145        Handle enqueuing of a next media item on the player.
1146
1147        :param player_id: player_id of the player to handle the command.
1148        :param media: The Media that needs to be enqueued on the player.
1149        :raises UnsupportedFeaturedException: if the player does not support enqueueing.
1150        :raises PlayerUnavailableError: if the player is not available.
1151        """
1152        # Note: No group redirect needed here as enqueue doesn't use _get_player_with_redirect
1153        # Delegate to internal handler for actual implementation
1154        await self._handle_enqueue_next_media(player_id, media)
1155
1156    @api_command("players/cmd/set_members", required_scope=Scope.PLAYERS_CONTROL)
1157    async def cmd_set_members(
1158        self,
1159        target_player: str,
1160        player_ids_to_add: list[str] | None = None,
1161        player_ids_to_remove: list[str] | None = None,
1162    ) -> None:
1163        """
1164        Join/unjoin given player(s) to/from target player.
1165
1166        Will add the given player(s) to the target player (sync leader or group player).
1167
1168        :param target_player: player_id of the syncgroup leader or group player.
1169        :param player_ids_to_add: List of player_id's to add to the target player.
1170        :param player_ids_to_remove: List of player_id's to remove from the target player.
1171
1172        :raises UnsupportedFeaturedException: if the target player does not support grouping.
1173        :raises PlayerUnavailableError: if the target player is not available.
1174        """
1175        parent_player: Player | None = self.get_player(target_player, True)
1176        assert parent_player is not None  # for type checking
1177        if PlayerFeature.SET_MEMBERS not in parent_player.state.supported_features:
1178            msg = f"Player {parent_player.name} does not support group commands"
1179            raise UnsupportedFeaturedException(msg)
1180
1181        # if the target player is a member of an active group player (e.g. a syncgroup),
1182        # redirect the command to that group player so it can manage the member change
1183        if (
1184            parent_player.type != PlayerType.GROUP
1185            and parent_player.state.active_group
1186            and (group_player := self.get_player(parent_player.state.active_group))
1187            and group_player.type == PlayerType.GROUP
1188            and PlayerFeature.SET_MEMBERS in group_player.state.supported_features
1189        ):
1190            self.logger.debug(
1191                "Redirecting set_members from %s to its group player %s",
1192                parent_player.name,
1193                group_player.name,
1194            )
1195            await self.cmd_set_members(
1196                parent_player.state.active_group, player_ids_to_add, player_ids_to_remove
1197            )
1198            return
1199
1200        if parent_player.synced_to:
1201            # handle edge case: target player is already synced itself to another player
1202            # automatically ungroup it first and wait for state to propagate
1203            await self._auto_ungroup_if_synced(parent_player, "setting members")
1204
1205        # Use lock for playback commands to prevent protocol switches from
1206        # racing with concurrent play_media / play_index / resume calls.
1207        async with self.get_player_lock(parent_player.player_id, PlayerLockPurpose.PLAYBACK):
1208            await self._handle_set_members(parent_player, player_ids_to_add, player_ids_to_remove)
1209
1210    @api_command("players/cmd/group", required_scope=Scope.PLAYERS_CONTROL)
1211    @handle_player_command
1212    async def cmd_group(self, player_id: str, target_player: str) -> None:
1213        """
1214        Handle GROUP command for given player.
1215
1216        Join/add the given player(id) to the given (leader) player/sync group.
1217        If the target player itself is already synced to another player, this may fail.
1218        If the player can not be synced with the given target player, this may fail.
1219
1220        NOTE: This is a convenience helper for cmd_set_members.
1221
1222        :param player_id: player_id of the player to handle the command.
1223        :param target_player: player_id of the syncgroup leader or group player.
1224
1225        :raises UnsupportedFeaturedException: if the target player does not support grouping.
1226        :raises PlayerCommandFailed: if the target player is already synced to another player.
1227        :raises PlayerUnavailableError: if the target player is not available.
1228        :raises PlayerCommandFailed: if the player is already grouped to another player.
1229        """
1230        await self.cmd_set_members(target_player, player_ids_to_add=[player_id])
1231
1232    @api_command("players/cmd/group_many", required_scope=Scope.PLAYERS_CONTROL)
1233    async def cmd_group_many(self, target_player: str, child_player_ids: list[str]) -> None:
1234        """
1235        Join given player(s) to target player.
1236
1237        Will add the given player(s) to the target player (sync leader or group player).
1238        This is a (deprecated) alias for cmd_set_members.
1239        """
1240        await self.cmd_set_members(target_player, player_ids_to_add=child_player_ids)
1241
1242    @api_command("players/cmd/ungroup", required_scope=Scope.PLAYERS_CONTROL)
1243    @handle_player_command
1244    async def cmd_ungroup(self, player_id: str) -> None:
1245        """
1246        Handle UNGROUP command for given player.
1247
1248        Remove the given player from any (sync)groups it currently is synced to.
1249        If the player is not currently grouped to any other player,
1250        this will silently be ignored.
1251        """
1252        if not (player := self.get_player(player_id)):
1253            self.logger.warning("Player %s is not available", player_id)
1254            return
1255
1256        # Ungroup on a group player is interpreted as 'release the captured
1257        # session entirely'. This avoids the "Cannot remove static member"
1258        # error path when transfer_queue or HA's unjoin asks us to release a
1259        # group that has static members.
1260        if player.state.type == PlayerType.GROUP:
1261            if player.state.power_control != PLAYER_CONTROL_NONE:
1262                await self._handle_cmd_power(player.player_id, False)
1263            else:
1264                await self._handle_cmd_stop(player.player_id)
1265            return
1266
1267        if player.state.active_group:
1268            group = self.get_player(player.state.active_group)
1269            is_static_member = group is not None and player_id in group.state.static_group_members
1270            if is_static_member:
1271                # Static members can't be released individually — recurse so
1272                # the group-player branch above stops/dissolves the session.
1273                if group is not None:
1274                    await self.cmd_ungroup(group.player_id)
1275                return
1276            # dynamic or non-static member — remove just this player
1277            await self.cmd_set_members(player.state.active_group, player_ids_to_remove=[player_id])
1278            return
1279
1280        if player.state.synced_to:
1281            # player is a sync member
1282            await self.cmd_set_members(player.state.synced_to, player_ids_to_remove=[player_id])
1283            return
1284
1285        if player.state.group_members:
1286            # player is a sync leader (a non-group player with synced followers).
1287            # Remove only the leader itself: _handle_set_members will either transfer
1288            # leadership to a remaining member (keeping playback alive) or, when no
1289            # members remain / nothing is playing, dissolve the group and stop.
1290            await self.cmd_set_members(player.player_id, player_ids_to_remove=[player.player_id])
1291            return
1292        # unjoin from any dynamic sync groups if we're currently in one (edge case)
1293        # this is in particular used for the Home Assistant integration which does
1294        # not have a set_members command and only supports a single unjoin command
1295        for player in self.iter_players(False):
1296            if not player.state.group_members or player.state.synced_to:
1297                continue
1298            if PlayerFeature.SET_MEMBERS not in player.state.supported_features:
1299                continue
1300            if player_id in player.state.static_group_members:
1301                continue
1302            if player_id in player.state.group_members:
1303                await self.cmd_set_members(player.player_id, player_ids_to_remove=[player_id])
1304                return
1305
1306    @api_command("players/cmd/ungroup_many", required_scope=Scope.PLAYERS_CONTROL)
1307    async def cmd_ungroup_many(self, player_ids: list[str]) -> None:
1308        """Handle UNGROUP command for all the given players."""
1309        for player_id in list(player_ids):
1310            await self.cmd_ungroup(player_id)
1311
1312    @api_command("players/create_group_player", required_scope=Scope.CONFIG_PLAYERS_WRITE)
1313    async def create_group_player(
1314        self, provider: str, name: str, members: list[str], dynamic: bool = True
1315    ) -> Player:
1316        """
1317        Create a new (permanent) Group Player.
1318
1319        :param provider: The provider (id) to create the group player for.
1320        :param name: Name of the new group player.
1321        :param members: List of player ids to add to the group.
1322        :param dynamic: Whether the group is dynamic (members can change).
1323        """
1324        if not (provider_instance := self.mass.get_provider(provider)):
1325            raise ProviderUnavailableError(f"Provider {provider} not found")
1326        provider_instance = cast("PlayerProvider", provider_instance)
1327        if ProviderFeature.CREATE_GROUP_PLAYER not in provider_instance.supported_features:
1328            raise UnsupportedFeaturedException(
1329                f"Provider {provider} does not support creating group players"
1330            )
1331        return await provider_instance.create_group_player(name, members, dynamic)
1332
1333    @api_command("players/remove_group_player", required_scope=Scope.CONFIG_PLAYERS_WRITE)
1334    async def remove_group_player(self, player_id: str) -> None:
1335        """Remove a group player."""
1336        if not (player := self.get_player(player_id)):
1337            # we simply permanently delete the player by wiping its config
1338            self.mass.config.remove(f"players/{player_id}")
1339            return
1340        if player.state.type != PlayerType.GROUP:
1341            raise UnsupportedFeaturedException(f"Player {player.state.name} is not a group player")
1342        player.provider.check_feature(ProviderFeature.REMOVE_GROUP_PLAYER)
1343        await player.provider.remove_group_player(player_id)
1344
1345    @api_command("players/add_currently_playing_to_favorites", required_scope=Scope.LIBRARY_WRITE)
1346    async def add_currently_playing_to_favorites(self, player_id: str) -> None:
1347        """
1348        Add the currently playing item/track on given player to the favorites.
1349
1350        This tries to resolve the currently playing media to an actual media item
1351        and add that to the favorites in the library. Will raise an error if the
1352        player is not currently playing anything or if the currently playing media
1353        can not be resolved to a media item.
1354        """
1355        player = self._get_player_with_redirect(player_id)
1356        # handle mass player queue active
1357        if mass_queue := self.get_active_queue(player):
1358            if not (current_item := mass_queue.current_item) or not current_item.media_item:
1359                raise PlayerCommandFailed("No current item to add to favorites")
1360            # if we're playing a radio station, try to resolve the currently playing track
1361            if current_item.media_item.media_type == MediaType.RADIO:
1362                if not (
1363                    (streamdetails := mass_queue.current_item.streamdetails)
1364                    and (stream_title := streamdetails.stream_title)
1365                    and " - " in stream_title
1366                ):
1367                    # no stream title available, so we can't resolve the track
1368                    # this can happen if the radio station does not provide metadata
1369                    # or there's a commercial break
1370                    # Possible future improvement could be to actually detect the song with a
1371                    # shazam-like approach.
1372                    raise PlayerCommandFailed("No current item to add to favorites")
1373                # send the streamtitle into a global search query
1374                search_artist, search_title_title = stream_title.split(" - ", 1)
1375                # strip off any additional comments in the title (such as from Radio Paradise)
1376                search_title_title = search_title_title.split(" | ")[0].strip()
1377                if track := await self.mass.music.get_track_by_name(
1378                    search_title_title, search_artist
1379                ):
1380                    # we found a track, so add it to the favorites
1381                    await self.mass.music.add_item_to_favorites(track)
1382                    return
1383                # we could not resolve the track, so raise an error
1384                raise PlayerCommandFailed("No current item to add to favorites")
1385
1386            # else: any other media item, just add it to the favorites directly
1387            await self.mass.music.add_item_to_favorites(current_item.media_item)
1388            return
1389
1390        # guard for player with no active source
1391        if not player.state.active_source:
1392            raise PlayerCommandFailed("Player has no active source")
1393        # handle other source active using the current_media with uri
1394        if current_media := player.state.current_media:
1395            # prefer the uri of the current media item
1396            if current_media.uri:
1397                with suppress(MusicAssistantError):
1398                    await self.mass.music.add_item_to_favorites(current_media.uri)
1399                    return
1400            # fallback to search based on artist and title (and album if available)
1401            if current_media.artist and current_media.title:
1402                if track := await self.mass.music.get_track_by_name(
1403                    current_media.title,
1404                    current_media.artist,
1405                    current_media.album,
1406                ):
1407                    # we found a track, so add it to the favorites
1408                    await self.mass.music.add_item_to_favorites(track)
1409                    return
1410        # if we reach here, we could not resolve the currently playing item
1411        raise PlayerCommandFailed("No current item to add to favorites")
1412
1413    async def register(self, player: Player) -> None:
1414        """Register a player on the Player Controller."""
1415        if self._teardown_in_progress(player):
1416            return
1417
1418        # Use lock to prevent race conditions during concurrent player registrations
1419        async with self._register_lock:
1420            player_id = player.player_id
1421
1422            if player_id in self._players:
1423                msg = f"Player {player_id} is already registered!"
1424                raise AlreadyRegisteredError(msg)
1425
1426            # ignore disabled players
1427            if not player.state.enabled:
1428                return
1429
1430            if player.type not in (PlayerType.GROUP, PlayerType.STEREO_PAIR):
1431                await self._resolve_mac_addresses(player)
1432
1433            # restore 'fake' power state from cache if available.
1434            # Group players intentionally do NOT restore their fake-power
1435            # state across restarts: at boot there is no sync session yet, so
1436            # a restored 'powered=True' would put the group in an inconsistent
1437            # 'active without captured session' state where children appear
1438            # owned by a group that has no leader. Users who want their
1439            # 'group captured' state preserved across restarts would need
1440            # explicit session restoration which is out of scope here.
1441            if player.type != PlayerType.GROUP:
1442                cached_value = await self.mass.cache.get(
1443                    key=player.player_id,
1444                    provider=self.domain,
1445                    category=CACHE_CATEGORY_PLAYER_POWER,
1446                    default=False,
1447                )
1448                if cached_value is not None:
1449                    player.extra_data[ATTR_FAKE_POWER] = cached_value
1450
1451            # _registration_aborted below only works once the player is in the registry;
1452            # until then the unregister pass of a provider unload cannot see it, so re-check
1453            # the guard from the top of this method, which the awaits above may have staled
1454            if self._teardown_in_progress(player):
1455                return
1456
1457            # finally actually register it
1458
1459            # Despite the fact that the player is not fully ready yet
1460            # (config not loaded, protocol links not evaluated),
1461            # we already add it to the _players dict here because we
1462            # want to make sure the player is available in the controller
1463            # during the rest of the registration process
1464            # (such as when fetching config or evaluating protocol links).
1465            # We use the 'initialized' attribute to indicate that the player
1466            # is still in the process of being registered so we can filter it out where needed.
1467            self._players[player_id] = player
1468            # update state to ensure player.state reflects the final attributes
1469            # (e.g. player type) set after super().__init__() in the player subclass,
1470            # before we fetch config (which relies on state.type for entry resolution)
1471            player.update_state(signal_event=False)
1472            # ensure we fetch and set the latest/full config for the player
1473            player_config = await self.mass.config.get_player_config(player_id)
1474            if self._registration_aborted(player):
1475                return
1476            player.set_config(player_config)
1477            # update state again now that config is loaded
1478            player.update_state(signal_event=False)
1479            self._save_underlying_player_id(player)
1480            # call hook after the player is registered and config is set
1481            await player.on_config_updated()
1482            if self._registration_aborted(player):
1483                return
1484
1485            # Handle protocol linking
1486            self._evaluate_protocol_links(player)
1487
1488            # now we're ready to signal the player is added and available
1489            player.set_initialized()
1490            self.logger.info(
1491                "Player (type %s) registered: %s/%s",
1492                player.state.type.value,
1493                player_id,
1494                player.state.name,
1495            )
1496            # signal event that a player was added
1497            if player.state.type != PlayerType.PROTOCOL:
1498                self.mass.signal_event(
1499                    EventType.PLAYER_ADDED, object_id=player.player_id, data=player
1500                )
1501            # register playerqueue for this player (if not a protocol player)
1502            if player.state.type != PlayerType.PROTOCOL:
1503                await self.mass.player_queues.on_player_register(player)
1504                if self._registration_aborted(player):
1505                    # the queue restore outlived the unregister that already cleaned it up,
1506                    # so drop the queue we just recreated for a player that is gone
1507                    self.mass.player_queues.on_player_remove(player_id, permanent=False)
1508
1509        # Schedule debounced update of all players since can_group_with values may change
1510        # when a new player is added (provider IDs expand to include the new player)
1511        self._schedule_update_all_players(2)
1512
1513    async def register_or_update(self, player: Player) -> None:
1514        """Register a new player on the controller or update existing one."""
1515        if self._teardown_in_progress(player):
1516            return
1517
1518        # the register lock ensures a replacement is never swapped in while register()
1519        # is still setting the player up
1520        async with self._register_lock:
1521            if (existing := self._players.get(player.player_id)) is not None:
1522                # a protocol player is hidden behind its parent and owns no queue, every
1523                # other player does. Reading the role the player is leaving off that
1524                # published reality keeps it independent of when the player's state was
1525                # last recalculated, which providers cannot control (they flip the type
1526                # before this call).
1527                was_protocol = self.mass.player_queues.get(player.player_id) is None
1528                becomes_protocol = player.type == PlayerType.PROTOCOL
1529                role_changed = becomes_protocol != was_protocol
1530                if role_changed:
1531                    # release the topology of the role the player is leaving
1532                    self._cleanup_player_type_transition(
1533                        existing, becomes_protocol=becomes_protocol
1534                    )
1535                self._players[player.player_id] = player
1536                if existing is not player:
1537                    # a fresh instance starts out with a base config only, so it needs
1538                    # the config the registration resolved before it can be used
1539                    player.set_config(existing.config)
1540                    await player.on_config_updated()
1541                    if self._registration_aborted(player):
1542                        return
1543                # the replacement takes over the identity of an already registered
1544                # player, so it must be marked initialized as well
1545                player.set_initialized()
1546                player.update_state()
1547                # the derived-transport edge may have been set/revoked after the
1548                # initial registration (e.g. via a bridge claim)
1549                self._save_underlying_player_id(player)
1550                if role_changed:
1551                    await self._finish_player_type_transition(player)
1552                # Also schedule update when replacing existing player
1553                self._schedule_update_all_players()
1554                return
1555
1556        await self.register(player)
1557
1558    def trigger_player_update(
1559        self, player_id: str, force_update: bool = False, debounce_delay: float = 0.25
1560    ) -> None:
1561        """Trigger a (debounced) update for the given player."""
1562        if self.mass.closing:
1563            return
1564        if not (player := self.get_player(player_id)):
1565            return
1566        # mark dirty right away (not at execution): a trigger means state the player
1567        # derives from changed, and a direct update_state call may come in before
1568        # the debounced one runs
1569        player.mark_state_dirty()
1570        task_id = f"player_update_state_{player_id}"
1571        self.mass.call_later(
1572            debounce_delay,
1573            player.update_state,
1574            force_update=force_update,
1575            task_id=task_id,
1576        )
1577
1578    async def unregister(
1579        self,
1580        player_id: str,
1581        permanent: bool = False,
1582        replacement_player_id: str | None = None,
1583    ) -> None:
1584        """
1585        Unregister a player from the player controller.
1586
1587        Called (by a PlayerProvider) when a player is removed or no longer available
1588        (for a longer period of time). This will remove the player from the player
1589        controller and optionally remove the player's config from the mass config.
1590        If the player is not registered, this will silently be ignored.
1591
1592        :param player_id: Player ID of the player to unregister.
1593        :param permanent: If True, remove the player permanently by deleting its config.
1594                          If False, the player config will not be removed.
1595        :param replacement_player_id: Player ID that takes this player's place, only
1596                                      used for a permanent removal.
1597        """
1598        player = self._players.get(player_id)
1599        if player is None:
1600            return
1601        del self._players[player_id]
1602        # clean up all lock entries for this player
1603        for prefix in [p.value for p in PlayerLockPurpose]:
1604            self._player_command_locks.pop(f"{prefix}_{player_id}", None)
1605        if handle := self._pending_protocol_evaluations.pop(player_id, None):
1606            handle.cancel()
1607        self._clear_sleep_timer(player)
1608        self.mass.player_queues.on_player_remove(player_id, permanent=permanent)
1609        # teardown is best-effort: a provider that fails to release its player must not
1610        # strand the other players of that provider, nor the provider unload itself
1611        try:
1612            await player.on_unload()
1613        except Exception:
1614            self.logger.exception("Error unloading player %s", player.name)
1615        if permanent:
1616            # player permanent removal: cleanup protocol links, delete config
1617            # and signal PLAYER_REMOVED event.
1618            # No group detach is issued here: the player is already out of the registry,
1619            # so it is filtered out of every group's live member list, and its persisted
1620            # membership is settled by delete_player_config below.
1621            self._cleanup_protocol_links(player)
1622            self.delete_player_config(player_id, replacement_player_id)
1623            self.logger.info("Player removed: %s", player.name)
1624            if player.state.type != PlayerType.PROTOCOL:
1625                self.mass.signal_event(EventType.PLAYER_REMOVED, player_id)
1626        else:
1627            # temporary unavailable: mark player as unavailable
1628            # note: the player will be re-registered later if it comes back online
1629            player.state.available = False
1630            self.logger.info("Player unavailable: %s", player.name)
1631            if player.state.type != PlayerType.PROTOCOL:
1632                self.mass.signal_event(
1633                    EventType.PLAYER_UPDATED, object_id=player.player_id, data=player.state
1634                )
1635        # Schedule debounced update of all players since can_group_with values may change
1636        self._schedule_update_all_players()
1637
1638    @api_command("players/remove", required_scope=Scope.CONFIG_PLAYERS_WRITE)
1639    async def remove(self, player_id: str) -> None:
1640        """
1641        Remove a player from a provider.
1642
1643        Can only be called when a PlayerProvider supports ProviderFeature.REMOVE_PLAYER.
1644        """
1645        player = self.get_player(player_id)
1646        if player is None:
1647            # we simply permanently delete the player config since it is not registered
1648            self.delete_player_config(player_id)
1649            return
1650        if player.state.type == PlayerType.GROUP:
1651            # Handle group player removal
1652            player.provider.check_feature(ProviderFeature.REMOVE_GROUP_PLAYER)
1653            await player.provider.remove_group_player(player_id)
1654            return
1655        player.provider.check_feature(ProviderFeature.REMOVE_PLAYER)
1656        await player.provider.remove_player(player_id)
1657        # check for group memberships that need to be updated
1658        if player.state.active_group and (
1659            group_player := self.mass.players.get_player(player.state.active_group)
1660        ):
1661            # try to remove from the group
1662            with suppress(UnsupportedFeaturedException, PlayerCommandFailed):
1663                await group_player.set_members(
1664                    player_ids_to_remove=[player_id],
1665                )
1666        # We removed the player and can now clean up its config
1667        self.delete_player_config(player_id)
1668
1669    def delete_player_config(
1670        self, player_id: str, replacement_player_id: str | None = None
1671    ) -> None:
1672        """
1673        Permanently delete a player's configuration, including its DSP and queue settings.
1674
1675        The saved queue of a player that is no longer registered is dropped along with it,
1676        so a device that returns under the same id starts out fresh. The player itself is
1677        not unregistered.
1678        The config of a linked protocol player is wiped along with it, so the device
1679        returns as a brand new player once it is discovered again. Protocol players that
1680        are still registered or that already moved to another parent keep their config;
1681        registered ones are detached from the removed player and re-evaluated.
1682        Any group that lists the player as a member follows the replacement, or loses
1683        the member when there is none.
1684
1685        :param player_id: Player ID of the player to delete the configuration of.
1686        :param replacement_player_id: Player ID that takes this player's place, so users
1687                                      restricted to it and groups it belongs to follow
1688                                      the replacement.
1689        """
1690        self._detach_protocol_children(player_id)
1691        self._update_group_memberships(player_id, replacement_player_id)
1692        player_ids = [
1693            protocol_id
1694            for protocol_id in self.mass.config.get(CONF_PLAYERS, {})
1695            if self._get_cached_protocol_parent_id(protocol_id) == player_id
1696            and self.get_player(protocol_id) is None
1697        ]
1698        player_ids.append(player_id)
1699        for pid in player_ids:
1700            for key in (
1701                f"{CONF_PLAYERS}/{pid}",
1702                f"{CONF_PLAYER_DSP}/{pid}",
1703                f"{CONF_PLAYER_QUEUES}/{pid}",
1704            ):
1705                self.mass.config.remove(key)
1706            if self.get_player(pid) is None:
1707                self.mass.player_queues.purge_saved_queue(pid)
1708        # a user access filter is an allow-list of player ids, so it must not be left
1709        # pointing at a player whose config was just wiped: a replaced player hands its
1710        # entries over to its replacement, a removed one has them dropped
1711        if replacement_player_id:
1712            self.mass.create_task(
1713                self.mass.webserver.auth.replace_player_in_user_filters(
1714                    player_id, replacement_player_id, removed_player_ids=player_ids
1715                )
1716            )
1717        else:
1718            self.mass.create_task(
1719                self.mass.webserver.auth.remove_from_user_filters(player_ids=player_ids)
1720            )
1721
1722    def scale_volume_to_device(self, player_id: str, logical_volume: int) -> int:
1723        """Scale logical volume (0-100) to device volume (min_volume-max_volume)."""
1724        min_volume, max_volume = self._get_volume_limits(player_id)
1725        if min_volume == 0 and max_volume == 100:
1726            return logical_volume
1727        # Scale: logical 0 -> min_volume, logical 100 -> max_volume
1728        return min_volume + (logical_volume * (max_volume - min_volume)) // 100
1729
1730    def scale_volume_from_device(self, player_id: str, device_volume: int) -> int:
1731        """Scale device volume (min_volume-max_volume) to logical volume (0-100)."""
1732        min_volume, max_volume = self._get_volume_limits(player_id)
1733        if min_volume == 0 and max_volume == 100:
1734            return device_volume
1735        volume_range = max_volume - min_volume
1736        if volume_range == 0:
1737            return 0
1738        # Scale to 0-100 without clamping so that out-of-range device volumes
1739        # produce distinct logical values, ensuring state change detection triggers
1740        # volume limit enforcement
1741        return ((device_volume - min_volume) * 100) // volume_range
1742
1743    def on_player_position_jumped(self, player: Player) -> None:
1744        """
1745        Handle a discrete jump of a player's corrected playback position.
1746
1747        Called by a Player when its corrected position moved significantly
1748        outside regular playback progression (seek or buffer correction). This
1749        is not an event by itself: it re-bases the active queue's timing on the
1750        fresh position and nudges related players so derived positions stay in
1751        sync; current_media then re-anchors from the corrected queue time on
1752        the follow-up update, which emits the actual update event.
1753        """
1754        if self.mass.closing:
1755            return
1756        self.mass.player_queues.on_player_elapsed_time_corrected(player)
1757        self.trigger_player_update(player.player_id)
1758        self._forward_state_update(player, {})
1759
1760    def signal_player_state_update(
1761        self,
1762        player: Player,
1763        changed_values: dict[str, tuple[Any, Any]],
1764        force_update: bool = False,
1765        skip_forward: bool = False,
1766        media_position_jumped: bool = False,
1767    ) -> None:
1768        """
1769        Signal a player state update.
1770
1771        Called by a Player when its state has changed.
1772        This will update the player state in the controller and signal the event bus.
1773        """
1774        player_id = player.player_id
1775        if self.mass.closing:
1776            return
1777
1778        # ignore updates for disabled players
1779        if not player.state.enabled and ATTR_ENABLED not in changed_values:
1780            return
1781
1782        # The current_media position anchor only changes on discrete events
1783        # (play/pause/seek/track change/buffer correction), so a change set holding
1784        # only anchor keys represents a position correction rather than a regular
1785        # state change.
1786        non_anchor_keys = changed_values.keys() - POSITION_ANCHOR_KEYS
1787        if len(non_anchor_keys) == 0 and not force_update:
1788            if not media_position_jumped:
1789                # anchor adoption without a significant corrected-position change
1790                return
1791            # current_media's corrected position jumped (seek or buffer correction
1792            # reached the current media): emit the full player update below so
1793            # consumers see the fresh position
1794
1795        if self.logger.isEnabledFor(VERBOSE_LOG_LEVEL):
1796            self.logger.log(
1797                VERBOSE_LOG_LEVEL,
1798                "Player state updated for %s: changed fields: %s",
1799                player.name,
1800                ", ".join(changed_values.keys()),
1801            )
1802
1803        # signal update to the playerqueue
1804        if player.state.type != PlayerType.PROTOCOL:
1805            self.mass.call_later(
1806                0.5,
1807                self.mass.player_queues.on_player_update,
1808                player,
1809                changed_values,
1810                task_id=f"queue_on_player_update_{player.player_id}",
1811            )
1812
1813        # Kick async palette extraction on cold cache. On transition prefetch
1814        # the next queue item too. Skip players that mirror another player's media
1815        # (grouped/synced members, protocol children): their current_media - palette
1816        # included - is taken wholesale from the owner, so resolving it per member is
1817        # wasted work that also produces duplicate state updates across the group.
1818        if (
1819            not self._mirrors_parent_media(player)
1820            and (current_media := player.state.current_media)
1821            and current_media.image_url
1822        ):
1823            if current_media.palette is None:
1824                self._schedule_palette_fetch(player_id, current_media.image_url)
1825            if "current_media.image_url" in changed_values or "current_media" in changed_values:
1826                self._schedule_next_queue_item_palette_prefetch(player_id, current_media)
1827
1828        # handle DSP reload of the leader when grouping/ungrouping
1829        if ATTR_GROUP_MEMBERS in changed_values:
1830            prev_group_members, new_group_members = changed_values[ATTR_GROUP_MEMBERS]
1831            self._handle_group_dsp_change(player, prev_group_members or [], new_group_members)
1832            # Removed group members also need to be updated since they are no longer part
1833            # of this group and are available for playback again
1834            removed_members = set(prev_group_members or []) - set(new_group_members or [])
1835            for _removed_player_id in removed_members:
1836                if removed_player := self.get_player(_removed_player_id):
1837                    removed_player.refresh_state()
1838
1839        # detect when active_source changes to
1840        # something external while we have a grouped protocol active
1841        if ATTR_ACTIVE_SOURCE in changed_values:
1842            task_id = f"external_source_takeover_{player_id}"
1843            self.mass.call_later(
1844                5,
1845                self._check_external_source_takeover,
1846                player,
1847                task_id=task_id,
1848            )
1849        # only steer into the (relatively expensive) membership cleanup when a field
1850        # that can require an unsync actually changed - this runs on every state tick
1851        if changed_values.keys() & {ATTR_AVAILABLE, ATTR_ENABLED, ATTR_POWERED}:
1852            self._handle_membership_cleanup_on_state_change(player, changed_values)
1853
1854        # enforce volume limits when volume changes externally
1855        if "volume_level" in changed_values:
1856            corrected = self._enforce_volume_limits(player)
1857            # a level set on the device itself makes the reference a group volume change
1858            # interpolates from obsolete. a member on its way to a level we did send
1859            # reports levels too, and a group only ever reports what its members are at,
1860            # so neither of those counts. a correction always is the device's own doing:
1861            # the levels we command never fall outside the configured range
1862            if player.state.type != PlayerType.GROUP and (
1863                corrected or self._unexpired_volume_target(player) is None
1864            ):
1865                self._invalidate_group_volume_snapshot(player_id)
1866        # dispatch to internal state update subscribers (with changed_values)
1867        self._dispatch_state_update_subscribers(player, changed_values)
1868
1869        # signal player update on the eventbus
1870        if player.state.type != PlayerType.PROTOCOL:
1871            self.mass.signal_event(EventType.PLAYER_UPDATED, object_id=player_id, data=player)
1872
1873        # signal a separate PlayerOptionsUpdated event
1874        if options := changed_values.get("options"):
1875            self.mass.signal_event(
1876                EventType.PLAYER_OPTIONS_UPDATED, object_id=player_id, data=options
1877            )
1878        # signal player config update event if playerfeatures changed
1879        # this is temporary needed for the Home Assistant integration which only
1880        # re-evalues the entity's supported features on a PLAYER_CONFIG_UPDATED event.
1881        # TODO: Remove this temporary workaround once the HA integration is updated to
1882        # also re-evaluate supported features on PLAYER_UPDATED events.
1883        if changed_values.keys() & {
1884            ATTR_SUPPORTED_FEATURES,
1885            ATTR_MUTE_CONTROL,
1886            ATTR_VOLUME_CONTROL,
1887            ATTR_POWER_CONTROL,
1888        }:
1889            self.mass.signal_event(
1890                EventType.PLAYER_CONFIG_UPDATED, object_id=player_id, data=player.config
1891            )
1892
1893        if not skip_forward or force_update:
1894            self._forward_state_update(player, changed_values)
1895
1896        # trigger update of all players in a provider if group related fields changed
1897        # this ensures that calculated fields like can_group_with are updated on all players
1898        if any(key in changed_values for key in ("group_members", "synced_to", "available")):
1899            for prov_player in player.provider.players:
1900                self.trigger_player_update(prov_player.player_id, debounce_delay=2)
1901
1902    async def register_player_control(self, player_control: PlayerControl) -> None:
1903        """Register a new PlayerControl on the controller."""
1904        if self.mass.closing:
1905            return
1906        control_id = player_control.id
1907
1908        if control_id in self._controls:
1909            msg = f"PlayerControl {control_id} is already registered"
1910            raise AlreadyRegisteredError(msg)
1911
1912        # make sure that the playercontrol's provider is set to the instance_id
1913        prov = self.mass.get_provider(player_control.provider)
1914        if not prov or prov.instance_id != player_control.provider:
1915            raise RuntimeError(f"Invalid provider ID given: {player_control.provider}")
1916
1917        self._controls[control_id] = player_control
1918
1919        self.logger.info(
1920            "PlayerControl registered: %s/%s",
1921            control_id,
1922            player_control.name,
1923        )
1924
1925        # always call update to update any attached players etc.
1926        self.update_player_control(player_control.id, include_configured=True)
1927
1928    async def register_or_update_player_control(self, player_control: PlayerControl) -> None:
1929        """Register a new playercontrol on the controller or update existing one."""
1930        if self.mass.closing:
1931            return
1932        if player_control.id in self._controls:
1933            self._controls[player_control.id] = player_control
1934            self.update_player_control(player_control.id, include_configured=True)
1935            return
1936        await self.register_player_control(player_control)
1937
1938    def update_player_control(self, control_id: str, include_configured: bool = False) -> None:
1939        """
1940        Refresh the players that use the given player control.
1941
1942        :param control_id: The control whose state or availability changed.
1943        :param include_configured: Also refresh the players that select this control in their
1944            config but do not currently resolve to it. Needed when a control (re)appears,
1945            because such a player has already fallen back to another control and would
1946            otherwise never pick this one back up.
1947        """
1948        if self.mass.closing:
1949            return
1950        # update all players that are using this control
1951        for player in list(self._players.values()):
1952            if control_id in (
1953                player.state.power_control,
1954                player.state.volume_control,
1955                player.state.mute_control,
1956            ) or (
1957                include_configured and control_id in self._configured_control_ids(player.player_id)
1958            ):
1959                self.mass.loop.call_soon(player.refresh_state)
1960
1961    def remove_player_control(self, control_id: str) -> None:
1962        """Remove a player_control from the player manager."""
1963        control = self._controls.pop(control_id, None)
1964        if control is None:
1965            return
1966        self.logger.info("PlayerControl removed: %s", control.name)
1967        # players configured to use this control still resolve to it until they are
1968        # refreshed, so let them fall back to their remaining options right away
1969        self.update_player_control(control_id)
1970
1971    def get_player_provider(self, player_id: str) -> PlayerProvider:
1972        """Return PlayerProvider for given player."""
1973        player = self._players[player_id]
1974        assert player  # for type checker
1975        return player.provider
1976
1977    def get_active_queue(self, player: Player) -> PlayerQueue | None:
1978        """Return the current active queue for a player (if any)."""
1979        # account for player that is synced (sync child)
1980        if player.state.synced_to and player.state.synced_to != player.player_id:
1981            if sync_leader := self.get_player(player.state.synced_to):
1982                return self.get_active_queue(sync_leader)
1983        # handle active group player
1984        if player.state.active_group and player.state.active_group != player.player_id:
1985            if group_player := self.get_player(player.state.active_group):
1986                return self.get_active_queue(group_player)
1987        # active_source may be filled queue id (or None)
1988        active_source = player.state.active_source or player.player_id
1989        if active_queue := self.mass.player_queues.get(active_source):
1990            return active_queue
1991        # handle active protocol player with parent player queue
1992        if player.type == PlayerType.PROTOCOL and player.protocol_parent_id:
1993            if parent_player := self.mass.players.get_player(player.protocol_parent_id):
1994                return self.get_active_queue(parent_player)
1995        return None
1996
1997    async def set_group_volume(self, group_player: Player, volume_level: int) -> None:
1998        """
1999        Set the overall volume for a player group or synced players.
2000
2001        Uses interpolation to adjust all child volumes while preserving their
2002        relative balance. A snapshot of child volumes is cached on first call and
2003        used as the reference point for subsequent adjustments.
2004
2005        :param group_player: The group player or sync leader.
2006        :param volume_level: Target volume level (0..100).
2007        """
2008        cur_volume = group_player.state.group_volume
2009        if cur_volume is None:
2010            return
2011
2012        children: list[Player] = []
2013        for child_player in self.iter_group_members(
2014            group_player, only_powered=True, exclude_self=False
2015        ):
2016            if child_player.state.volume_control == PLAYER_CONTROL_NONE:
2017                continue
2018            children.append(child_player)
2019        if not children:
2020            return
2021
2022        # cache a snapshot of child volumes on the group player as reference for interpolation.
2023        # scaling up: each child interpolates from its snapshot value toward 100.
2024        # scaling down: each child interpolates from its snapshot value toward 0.
2025        # this ensures the relative balance is preserved and all children converge
2026        # to 0 and 100 at the extremes. the snapshot is invalidated when a child's
2027        # individual volume or the group membership changes, and rebuilt when the
2028        # children it holds are no longer the ones being adjusted.
2029        # the levels a nudge steps from are the ones the members were last commanded, so
2030        # the snapshot has to read the same source, or a change a member has not confirmed
2031        # yet puts the reference above the level being set and turns a step up into one down
2032        snapshot: dict[str, int] | None = group_player.extra_data.get(ATTR_GROUP_VOLUME_SNAPSHOT)
2033        if snapshot is None or snapshot.keys() != {c.player_id for c in children}:
2034            snapshot = {c.player_id: self._volume_nudge_base(c) or 0 for c in children}
2035            group_player.extra_data[ATTR_GROUP_VOLUME_SNAPSHOT] = snapshot
2036
2037        base_group = max(snapshot.values())
2038
2039        coros = []
2040        for child_player in children:
2041            child_base = snapshot.get(child_player.player_id, 0)
2042            if volume_level >= base_group:
2043                # scaling up: interpolate each child from snapshot toward 100
2044                if base_group >= 100:
2045                    new_child_volume = child_base
2046                else:
2047                    progress = (volume_level - base_group) / (100 - base_group)
2048                    new_child_volume = round(child_base + (100 - child_base) * progress)
2049            elif base_group == 0:
2050                new_child_volume = 0
2051            else:
2052                # scaling down: interpolate each child from snapshot toward 0
2053                progress = volume_level / base_group
2054                new_child_volume = round(child_base * progress)
2055            new_child_volume = max(0, min(100, new_child_volume))
2056            coros.append(self._set_member_volume(child_player.player_id, new_child_volume))
2057        await asyncio.gather(*coros)
2058
2059        # notify active AudioSource once at the group level to prevent
2060        # feedback loops from per-child callbacks with different volume values
2061        if active := self._get_active_audio_source(group_player):
2062            audio_source, plugin_prov = active
2063            active_queue = self.get_active_queue(group_player)
2064            if active_queue is not None and active_queue.queue_id == group_player.player_id:
2065                await plugin_prov.on_volume_change(audio_source.item_id, volume_level)
2066
2067    def iter_group_members(
2068        self,
2069        group_player: Player,
2070        only_powered: bool = False,
2071        only_playing: bool = False,
2072        active_only: bool = False,
2073        exclude_self: bool = True,
2074    ) -> Iterator[Player]:
2075        """Get (child) players attached to a group player or syncgroup."""
2076        for child_id in list(group_player.state.group_members):
2077            if child_player := self.get_player(child_id, False):
2078                if not child_player.state.available or not child_player.state.enabled:
2079                    continue
2080                if only_powered and child_player.state.powered is False:
2081                    continue
2082                if active_only and child_player.state.active_group != group_player.player_id:
2083                    continue
2084                if exclude_self and child_player.player_id == group_player.player_id:
2085                    continue
2086                if only_playing and child_player.state.playback_state not in (
2087                    PlaybackState.PLAYING,
2088                    PlaybackState.PAUSED,
2089                ):
2090                    continue
2091                yield child_player
2092
2093    def subscribe_player_state_update(
2094        self,
2095        callback: Callable[[Player, dict[str, tuple[Any, Any]]], None],
2096    ) -> Callable[[], None]:
2097        """
2098        Subscribe to player state update notifications.
2099
2100        The callback receives the Player and a dict of changed values
2101        (mapping attribute name to a (previous, new) tuple).
2102
2103        :param callback: Function to invoke for each player state update.
2104        :return: An unsubscribe function.
2105        """
2106        self._state_update_subscribers.append(callback)
2107
2108        def _unsub() -> None:
2109            with suppress(ValueError):
2110                self._state_update_subscribers.remove(callback)
2111
2112        return _unsub
2113
2114    @contextlib.asynccontextmanager
2115    async def wait_for_player_update(
2116        self,
2117        player_id: str,
2118        attribute_name: str | None = None,
2119        attribute_value: Any = _SENTINEL,
2120        timeout: float = 5.0,
2121    ) -> AsyncIterator[None]:
2122        """
2123        Async context manager that waits for a player state update.
2124
2125        Subscribes to player state updates on entry, runs the body (typically
2126        the action that triggers the expected update), then waits for a
2127        matching update on exit. If ``attribute_name`` and ``attribute_value``
2128        are both provided and the current value already matches at entry, the
2129        wait is skipped.
2130
2131        Example::
2132
2133            async with mass.players.wait_for_player_update(
2134                player_id, attribute_name="playback_state",
2135                attribute_value=PlaybackState.IDLE, timeout=5,
2136            ):
2137                await mass.players._handle_cmd_stop(player_id)
2138
2139        :param player_id: The player ID to wait for.
2140        :param attribute_name: Optional state attribute to watch for changes
2141            (e.g. ``"playback_state"``). If omitted, any state change satisfies
2142            the wait.
2143        :param attribute_value: Optional value the watched attribute must reach.
2144            Only meaningful in combination with ``attribute_name``.
2145        :param timeout: Maximum time to wait in seconds.
2146        """
2147        update_event = asyncio.Event()
2148
2149        def _on_state_update(player: Player, changed_values: dict[str, tuple[Any, Any]]) -> None:
2150            if player.player_id != player_id:
2151                return
2152            if attribute_name is None:
2153                update_event.set()
2154                return
2155            if attribute_name not in changed_values:
2156                return
2157            if attribute_value is _SENTINEL:
2158                update_event.set()
2159                return
2160            _prev, new_val = changed_values[attribute_name]
2161            if new_val == attribute_value:
2162                update_event.set()
2163
2164        # short-circuit when the desired value is already the current state
2165        already_satisfied = (
2166            attribute_name is not None
2167            and attribute_value is not _SENTINEL
2168            and (player := self.get_player(player_id)) is not None
2169            and getattr(player.state, attribute_name, _SENTINEL) == attribute_value
2170        )
2171
2172        unsub = self.subscribe_player_state_update(_on_state_update)
2173        try:
2174            yield
2175            if already_satisfied:
2176                return
2177            try:
2178                async with asyncio.timeout(timeout):
2179                    await update_event.wait()
2180            except TimeoutError:
2181                self.logger.debug(
2182                    "Timed out waiting for player update on %s (attr=%s value=%s)",
2183                    player_id,
2184                    attribute_name,
2185                    attribute_value,
2186                )
2187        finally:
2188            unsub()
2189
2190    async def on_player_config_change(self, config: PlayerConfig, changed_keys: set[str]) -> None:
2191        """Call (by config manager) when the configuration of a player changes."""
2192        min_vol_changed = f"values/{CONF_MIN_VOLUME}" in changed_keys
2193        max_vol_changed = f"values/{CONF_MAX_VOLUME}" in changed_keys
2194        if min_vol_changed or max_vol_changed:
2195            raw_min = config.get_value(CONF_MIN_VOLUME)
2196            raw_max = config.get_value(CONF_MAX_VOLUME)
2197            min_vol = int(cast("int", raw_min)) if raw_min is not None else 0
2198            max_vol = int(cast("int", raw_max)) if raw_max is not None else 100
2199            if min_vol > max_vol:
2200                msg = "Minimum volume cannot exceed maximum volume"
2201                raise InvalidDataError(msg)
2202        player = self.get_player(config.player_id)
2203        player_provider = self.mass.get_provider(config.provider)
2204        player_disabled = ATTR_ENABLED in changed_keys and not config.enabled
2205        player_enabled = ATTR_ENABLED in changed_keys and config.enabled
2206
2207        if player_disabled and player and player.state.available:
2208            # edge case: ensure that the player is powered off if the player gets disabled
2209            if player.state.power_control != PLAYER_CONTROL_NONE:
2210                await self._handle_cmd_power(config.player_id, False)
2211            elif player.state.playback_state != PlaybackState.IDLE:
2212                await self.cmd_stop(config.player_id)
2213
2214        # signal player provider that the player got enabled/disabled
2215        if (player_enabled or player_disabled) and player_provider:
2216            assert isinstance(player_provider, PlayerProvider)  # for type checking
2217            # Collect linked protocol IDs to cascade the enable/disable to.
2218            # Without this, a disabled native parent leaves its linked protocols
2219            # registered after restart; they then fail to find their parent and
2220            # get wrapped in a fresh Universal Player.
2221            cascade_protocol_ids: list[str] = []
2222            parent_is_protocol = player.state.type == PlayerType.PROTOCOL if player else False
2223            if not parent_is_protocol:
2224                if player and player.linked_output_protocols:
2225                    cascade_protocol_ids = [
2226                        link.output_protocol_id for link in player.linked_output_protocols
2227                    ]
2228                else:
2229                    cascade_protocol_ids = self._get_cached_protocol_ids(config.player_id)
2230            if player_disabled:
2231                player_provider.on_player_disabled(config.player_id)
2232            elif player_enabled:
2233                player_provider.on_player_enabled(config.player_id)
2234            for protocol_id in cascade_protocol_ids:
2235                protocol_raw = self.mass.config.get(f"{CONF_PLAYERS}/{protocol_id}")
2236                if not protocol_raw:
2237                    continue
2238                if bool(protocol_raw.get("enabled", True)) == bool(player_enabled):
2239                    continue
2240                self.mass.create_task(
2241                    self.mass.config.save_player_config(
2242                        protocol_id, {ATTR_ENABLED: bool(player_enabled)}
2243                    )
2244                )
2245            return  # enabling/disabling a player will be handled by the provider
2246
2247        if not player:
2248            return  # guard against player not being registered (yet)
2249
2250        resume_queue: PlayerQueue | None = (
2251            self.mass.player_queues.get(player.state.active_source)
2252            if player.state.active_source
2253            else None
2254        )
2255
2256        # ensure player state gets updated with any updated config
2257        player.set_config(config)
2258        await player.on_config_updated()
2259        player.update_state()
2260        # if the PlayerQueue was playing, restart playback
2261        if resume_queue and resume_queue.state == PlaybackState.PLAYING:
2262            requires_restart = any(
2263                v.requires_reload
2264                for v in config.values.values()
2265                if f"values/{v.key}" in changed_keys
2266            )
2267            if requires_restart:
2268                # always stop first to ensure the player uses the new config
2269                await self.mass.player_queues.stop(resume_queue.queue_id)
2270                self.mass.call_later(
2271                    1, self.mass.player_queues.resume, resume_queue.queue_id, False
2272                )
2273
2274    async def on_player_dsp_change(self, player_id: str) -> None:
2275        """Call (by config manager) when the DSP settings of a player change."""
2276        # signal player provider that the config changed
2277        if not (player := self.get_player(player_id)):
2278            return
2279        if player.state.playback_state == PlaybackState.PLAYING:
2280            self.logger.info("Restarting playback of Player %s after DSP change", player_id)
2281            # this will restart the queue stream/playback
2282            if self.get_active_queue(player):
2283                self.mass.call_later(
2284                    0, self.mass.player_queues.resume, player.state.active_source, False
2285                )
2286                return
2287            # if the player is not using a queue, we need to stop and start playback
2288            await self.cmd_stop(player_id)
2289            await self.cmd_play(player_id)
2290
2291    def schedule_active_output_protocol_clear(self, player: Player) -> None:
2292        """
2293        Clear the player's active output protocol once it stops playing.
2294
2295        A device may keep reporting PLAYING for a short while after a stop
2296        command, so the clear is deferred until the player reports IDLE (with a
2297        timeout as fallback). Starting a new session cancels the pending clear
2298        (see Player.set_active_output_protocol).
2299
2300        :param player: The player whose active output protocol must be cleared.
2301        """
2302        # Deduplicated per player via task_id: if a clear is already pending we
2303        # keep it, so the single tracked task stays cancellable by a new session.
2304        self.mass.create_task(
2305            self._clear_active_output_protocol_when_idle(player),
2306            task_id=f"clear_active_protocol_{player.player_id}",
2307        )
2308
2309    def __iter__(self) -> Iterator[Player]:
2310        """Iterate over all players."""
2311        return iter(self._players.values())
2312
2313    async def _resolve_mac_addresses(self, player: Player) -> None:
2314        """
2315        Resolve and persist the MAC addresses used to match the player against protocols.
2316
2317        :param player: The player to resolve the MAC address(es) for.
2318        """
2319        conf_base = f"{CONF_PLAYERS}/{player.player_id}/values"
2320        # Save the original MAC reported by the provider (before ARP enrichment)
2321        reported_mac = player.device_info.identifiers.get(IdentifierType.MAC_ADDRESS)
2322
2323        # Try to use cached ARP MAC from config for fast matching on restart.
2324        # This allows protocol linking to work immediately even if ARP is slow/fails.
2325        cached_arp_mac: str | None = self.mass.config.get(
2326            f"{conf_base}/{CONF_CACHED_ARP_MAC}", None
2327        )
2328        if cached_arp_mac and is_valid_mac_address(cached_arp_mac):
2329            player.device_info.add_identifier(IdentifierType.MAC_ADDRESS, cached_arp_mac)
2330
2331        # Enrich device MAC address via ARP if needed
2332        # (handles invalid MACs, locally-administered MACs, and missing MACs)
2333        await enrich_device_mac_address(player.device_info, self.logger)
2334
2335        # Cache the resolved MAC for fast matching on subsequent restarts
2336        current_mac = player.device_info.identifiers.get(IdentifierType.MAC_ADDRESS)
2337        if current_mac and is_valid_mac_address(current_mac) and current_mac != cached_arp_mac:
2338            self.mass.config.set(f"{conf_base}/{CONF_CACHED_ARP_MAC}", current_mac)
2339
2340        # Store original reported MAC if it differs from the resolved MAC.
2341        # This enables multi-MAC matching for devices with multiple interfaces
2342        # (e.g., WiFi + Ethernet) where ARP resolves one interface but the
2343        # protocol reports the other.
2344        if reported_mac and is_valid_mac_address(reported_mac) and current_mac:
2345            if reported_mac.upper() != current_mac.upper():
2346                player.extra_data["reported_mac"] = reported_mac
2347                self.mass.config.set(f"{conf_base}/{CONF_REPORTED_MAC}", reported_mac)
2348            else:
2349                # Provider's reported MAC matches the resolved MAC; clear any stale
2350                # stored reported MAC to avoid false-positive multi-MAC matches.
2351                self.mass.config.set(f"{conf_base}/{CONF_REPORTED_MAC}", None)
2352        elif not reported_mac or not is_valid_mac_address(reported_mac):
2353            # Restore reported MAC from config on restart only when the provider
2354            # did not supply a usable MAC address.
2355            cached_reported_mac: str | None = self.mass.config.get(
2356                f"{conf_base}/{CONF_REPORTED_MAC}", None
2357            )
2358            if cached_reported_mac and is_valid_mac_address(cached_reported_mac):
2359                if current_mac and cached_reported_mac.upper() == current_mac.upper():
2360                    # Cached value matches the resolved MAC; clear stale entry.
2361                    self.mass.config.set(f"{conf_base}/{CONF_REPORTED_MAC}", None)
2362                else:
2363                    player.extra_data["reported_mac"] = cached_reported_mac
2364
2365    def _teardown_in_progress(self, player: Player) -> bool:
2366        """
2367        Return True if the server or this player's provider is shutting down.
2368
2369        :param player: The player that is in the process of being registered.
2370        """
2371        return self.mass.closing or player.provider.unloading
2372
2373    def _registration_aborted(self, player: Player) -> bool:
2374        """
2375        Return True if the given player is no longer the registered player for its ID.
2376
2377        :param player: The player that is in the process of being registered.
2378        """
2379        # registration awaits provider I/O while the player is already in the registry,
2380        # so an unregister (e.g. a provider unload or a device disconnect) can drop or
2381        # replace it in the meantime, after which registration must stop
2382        if self._players.get(player.player_id) is player:
2383            return False
2384        self.logger.debug(
2385            "Registration of player %s aborted: it was unregistered while setting up",
2386            player.player_id,
2387        )
2388        return True
2389
2390    async def _finish_player_type_transition(self, player: Player) -> None:
2391        """
2392        Publish a registered player that moved in or out of the protocol role.
2393
2394        :param player: The player, with its new type already applied to its state.
2395        """
2396        self._evaluate_protocol_links(player)
2397        if player.state.type == PlayerType.PROTOCOL:
2398            # the player is hidden behind its parent from now on and no longer owns a queue.
2399            # only the queue is dropped, never the playback: the player either just became a
2400            # (hidden) bridge client with nothing playing on it, or is already serving its
2401            # parent, where a stop would cut that parent's stream short. A protocol player
2402            # has no active group of its own either, so there is nothing to detach here.
2403            self.mass.signal_event(EventType.PLAYER_REMOVED, player.player_id)
2404            self.mass.player_queues.on_player_remove(player.player_id, permanent=False)
2405            return
2406        # the player surfaces on its own, which leaves it unusable without a queue
2407        self.mass.signal_event(EventType.PLAYER_ADDED, object_id=player.player_id, data=player)
2408        await self.mass.player_queues.on_player_register(player)
2409        if self._registration_aborted(player):
2410            # the queue restore outlived the unregister that already cleaned it up,
2411            # so drop the queue we just recreated for a player that is gone
2412            self.mass.player_queues.on_player_remove(player.player_id, permanent=False)
2413
2414    async def _release_player_for_play_media(self, player: Player) -> None:
2415        """
2416        Release a captured player so a play_media command can target it directly.
2417
2418        :param player: The captured player to release.
2419        """
2420        # Strategy is picked from how the player is currently captured:
2421        #   synced_to            → unsync this player (cmd_ungroup)
2422        #   dynamic group member → remove from group via cmd_set_members
2423        #   static group member  → dissolve the whole group (power off if it
2424        #                          has a real power control, otherwise stop)
2425        # In every branch we wait for the relevant state attribute to actually
2426        # clear before returning. Providers (Sonos in particular) reject a
2427        # play_media on a player whose synced_to/active_group is still set
2428        # locally even though the release command has been acknowledged.
2429        if player.state.synced_to:
2430            self.logger.debug(
2431                "Unsyncing %s from %s to honor explicit play_media target",
2432                player.state.name,
2433                player.state.synced_to,
2434            )
2435            async with self.wait_for_player_update(
2436                player.player_id,
2437                attribute_name="synced_to",
2438                attribute_value=None,
2439                timeout=5,
2440            ):
2441                await self.cmd_ungroup(player.player_id)
2442            return
2443        if not player.state.active_group:
2444            return
2445        group = self.get_player(player.state.active_group)
2446        if group is None:
2447            return
2448        is_dynamic_member = (
2449            PlayerFeature.SET_MEMBERS in group.state.supported_features
2450            and player.player_id not in group.state.static_group_members
2451        )
2452        if is_dynamic_member:
2453            self.logger.debug(
2454                "Removing %s from dynamic group %s to honor explicit play_media target",
2455                player.state.name,
2456                group.state.name,
2457            )
2458            async with self.wait_for_player_update(
2459                player.player_id,
2460                attribute_name="active_group",
2461                attribute_value=None,
2462                timeout=5,
2463            ):
2464                await self.cmd_set_members(group.player_id, player_ids_to_remove=[player.player_id])
2465            return
2466        # static member: a single member can't be released, so the whole
2467        # group must dissolve. Prefer cmd_power when an explicit power
2468        # control is set so the user-visible state stays consistent.
2469        async with self.wait_for_player_update(
2470            player.player_id,
2471            attribute_name="active_group",
2472            attribute_value=None,
2473            timeout=5,
2474        ):
2475            if group.state.power_control != PLAYER_CONTROL_NONE and group.state.powered:
2476                self.logger.debug(
2477                    "Powering off %s to honor explicit play_media target on %s",
2478                    group.state.name,
2479                    player.state.name,
2480                )
2481                await self._handle_cmd_power(group.player_id, False)
2482            else:
2483                self.logger.debug(
2484                    "Stopping %s to honor explicit play_media target on %s",
2485                    group.state.name,
2486                    player.state.name,
2487                )
2488                await self._handle_cmd_stop(group.player_id)
2489
2490    def _mirrors_parent_media(self, player: Player) -> bool:
2491        """
2492        Return True if the player's current_media is taken from another player.
2493
2494        Grouped/synced members and protocol children mirror their parent's
2495        current_media (palette included), so they must not resolve it themselves.
2496
2497        :param player: The player to check.
2498        """
2499        state = player.state
2500        # a self-referential active_group/synced_to is not a real parent (mirror the
2501        # != self guard in Player.__final_current_media), so it must not skip resolution
2502        parent_id = state.active_group or state.synced_to
2503        if parent_id and parent_id != player.player_id:
2504            return True
2505        return state.type == PlayerType.PROTOCOL and player.protocol_parent_id is not None
2506
2507    def _schedule_palette_fetch(
2508        self, player_id: str, image_url: str | None, *, trigger_update: bool = True
2509    ) -> None:
2510        """
2511        Kick off an async palette extraction for an image URL.
2512
2513        :param player_id: Player the palette is scoped to (used for task dedup).
2514        :param image_url: Image URL to extract from. No-op when empty or already cached.
2515        :param trigger_update: When True, re-emit player state once palette is ready
2516                               (current track). When False, only warm the cache (prefetch).
2517        """
2518        if not image_url:
2519            return
2520        # Key the task on the image (not just the player) so a track change always
2521        # schedules a fetch for the new image instead of being dropped by an in-flight
2522        # fetch for the previous one; repeated schedules for the same image still dedupe.
2523        slot = "current" if trigger_update else "next"
2524        self.mass.create_task(
2525            self._fetch_palette(player_id, image_url, trigger_update=trigger_update),
2526            task_id=f"palette_fetch_{player_id}_{slot}_{image_url}",
2527            abort_existing=False,
2528        )
2529
2530    async def _fetch_palette(self, player_id: str, image_url: str, *, trigger_update: bool) -> None:
2531        palette = await get_palette_for_url(self.mass, image_url)
2532        if palette is None or not trigger_update:
2533            return  # prefetch only warms the cache controller; nothing to attach
2534        player = self.get_player(player_id)
2535        if player is None:
2536            return
2537        current = player.state.current_media
2538        if current is None or current.image_url != image_url:
2539            return  # media changed while fetching
2540        # Carry the palette on player state so the (sync) serialization reads it back.
2541        player.set_resolved_palette(image_url, palette)
2542        # Avoid trigger_player_update so a concurrent state-change debounce
2543        # doesn't cancel our timer via the shared player_update_state task_id.
2544        self.mass.call_later(
2545            0,
2546            player.update_state,
2547            force_update=True,
2548            task_id=f"palette_player_update_{player_id}",
2549        )
2550
2551    def _schedule_next_queue_item_palette_prefetch(
2552        self, player_id: str, current_media: PlayerMedia
2553    ) -> None:
2554        """Warm the palette cache for the next queue item so it's hot at transition."""
2555        queue_id, item_id = current_media.source_id, current_media.queue_item_id
2556        if not queue_id or not item_id:
2557            return
2558        next_item = self.mass.player_queues.get_next_item(queue_id, item_id)
2559        if next_item is None or not next_item.image:
2560            return
2561        next_url = self.mass.metadata.get_image_url(
2562            next_item.image, size=512, prefer_stream_server=True
2563        )
2564        self._schedule_palette_fetch(player_id, next_url, trigger_update=False)
2565
2566    def _configured_control_ids(self, player_id: str) -> set[str]:
2567        """Return the player control ids the given player's config selects."""
2568        return {
2569            str(value)
2570            for conf_key in (CONF_POWER_CONTROL, CONF_VOLUME_CONTROL, CONF_MUTE_CONTROL)
2571            if (value := self.mass.config.get_raw_player_config_value(player_id, conf_key))
2572        }
2573
2574    def _get_volume_step(self, current_volume: int) -> int:
2575        """
2576        Return the step size for a single volume increment at the given level.
2577
2578        A configured (non-zero) `volume_step` is a flat step. The default of 0 keeps the
2579        adaptive ladder, which takes finer steps near the ends of the range.
2580        """
2581        if configured := self.get_config_value(CONF_VOLUME_STEP, 0, return_type=int):
2582            return configured
2583        if current_volume < 10 or current_volume > 90:
2584            return 1
2585        if current_volume < 30 or current_volume > 70:
2586            return 2
2587        return 3
2588
2589    def _get_volume_limits(self, player_id: str) -> tuple[int, int]:
2590        """Get the configured min/max volume limits for a player."""
2591        min_volume = int(
2592            cast(
2593                "int",
2594                self.mass.config.get_raw_player_config_value(
2595                    player_id, CONF_MIN_VOLUME, CONF_ENTRY_MIN_VOLUME.default_value
2596                ),
2597            )
2598        )
2599        max_volume = int(
2600            cast(
2601                "int",
2602                self.mass.config.get_raw_player_config_value(
2603                    player_id, CONF_MAX_VOLUME, CONF_ENTRY_MAX_VOLUME.default_value
2604                ),
2605            )
2606        )
2607        return min_volume, max_volume
2608
2609    def _enforce_volume_limits(self, player: Player) -> bool:
2610        """
2611        Clamp device volume to min/max range when changed externally.
2612
2613        :param player: The player to check the volume of.
2614        :return: True if the volume was outside the configured range and got corrected.
2615        """
2616        player_id = player.player_id
2617        min_volume, max_volume = self._get_volume_limits(player_id)
2618        if min_volume == 0 and max_volume == 100:
2619            return False
2620        # state.volume_level is the resolved logical volume, available for all
2621        # volume control types; a device volume outside the configured range
2622        # surfaces here as a value outside 0-100 (scaling does not clamp)
2623        logical_volume = player.state.volume_level
2624        if logical_volume is None or 0 <= logical_volume <= 100:
2625            return False
2626        clamped = max(0, min(100, logical_volume))
2627        # correct via the regular volume-set path so scaling and redirection apply
2628        self.mass.create_task(self._handle_cmd_volume_set(player_id, clamped))
2629        return True
2630
2631    def _forward_state_update(
2632        self, player: Player, changed_values: dict[str, tuple[Any, Any]]
2633    ) -> None:
2634        """Forward a player state update to related players (groups, sync parent, protocols)."""
2635        # TODO: make this fan-out change-aware (skip relatives that derive nothing from
2636        # the changed fields) once reverse indexes for synced_to/active_group exist.
2637        # Propagate group or sync-leader updates to child players.
2638        if player.state.group_members:
2639            for child_player in self.iter_group_members(player, exclude_self=True):
2640                if player.type == PlayerType.GROUP:
2641                    child_player.on_group_updated(player, changed_values)
2642                else:
2643                    child_player.on_sync_parent_updated(player, changed_values)
2644        # update/signal group player(s) when a member updates. A sync leader is a member of the
2645        # group player that formed the sync group and gaining members of its own does not change
2646        # that: a group player mirrors its leader, so it depends on exactly these updates.
2647        for group_player in self._get_player_groups(player):
2648            group_player.on_group_member_updated(player, changed_values)
2649
2650        # update/signal manually sync-parent player when child updates
2651        if (_sync_parent_id := player.state.synced_to) and (
2652            _sync_parent := self.get_player(_sync_parent_id)
2653        ):
2654            self.trigger_player_update(_sync_parent.player_id)
2655        # If this is a protocol player, forward the state update to the parent player
2656        if (
2657            player.type == PlayerType.PROTOCOL
2658            and player.protocol_parent_id
2659            and (_protocol_parent := self.mass.players.get_player(player.protocol_parent_id))
2660        ):
2661            _protocol_parent.on_protocol_player_updated(player, changed_values)
2662        # If this is a parent player with linked protocols, forward state updates
2663        # to linked protocol players so their state reflects parent dependencies
2664        if player.state.type != PlayerType.PROTOCOL and player.linked_output_protocols:
2665            for linked in player.linked_output_protocols:
2666                if protocol_player := self.mass.players.get_player(linked.output_protocol_id):
2667                    protocol_player.on_protocol_parent_updated(player, changed_values)
2668
2669    def _invalidate_group_volume_snapshot(self, player_id: str) -> None:
2670        """Clear the cached group volume snapshot for all groups this player belongs to."""
2671        player = self.get_player(player_id)
2672        if not player:
2673            return
2674        if player.state.group_members:
2675            player.extra_data.pop(ATTR_GROUP_VOLUME_SNAPSHOT, None)
2676        for group_player in self._get_player_groups(player):
2677            group_player.extra_data.pop(ATTR_GROUP_VOLUME_SNAPSHOT, None)
2678        if player.state.synced_to and (leader := self.get_player(player.state.synced_to)):
2679            leader.extra_data.pop(ATTR_GROUP_VOLUME_SNAPSHOT, None)
2680
2681    def _record_volume_target(self, player: Player, volume_level: int) -> None:
2682        """Remember the volume level just commanded, as the base for the next nudge."""
2683        if self._stays_silent_on_volume_change(player):
2684            volume_level = 0
2685        player.extra_data[ATTR_VOLUME_TARGET] = (volume_level, time.monotonic())
2686
2687    def _volume_nudge_base(self, player: Player) -> int | None:
2688        """Return the volume level a volume nudge for the given player steps from."""
2689        target = self._unexpired_volume_target(player)
2690        if target is not None:
2691            return target
2692        return player.state.volume_level
2693
2694    def _group_volume_nudge_base(self, group_player: Player) -> int | None:
2695        """Return the volume level a group volume nudge for the given group steps from."""
2696        if not group_player.state.group_members:
2697            # an ungrouped player is stepped through its own volume, so it is that
2698            # volume the command lands on and that a following nudge steps from
2699            return self._volume_nudge_base(group_player)
2700        # mirrors Player.group_volume, but steps from the level last commanded to each
2701        # member instead of the level it reports, so the group is not held back by a
2702        # member that has not confirmed the previous nudge yet
2703        base: int | None = None
2704        for child_player in self.iter_group_members(
2705            group_player, only_powered=True, exclude_self=group_player.type != PlayerType.PLAYER
2706        ):
2707            if child_player.state.volume_control == PLAYER_CONTROL_NONE:
2708                continue
2709            if (child_volume := self._volume_nudge_base(child_player)) is None:
2710                continue
2711            if base is None or child_volume > base:
2712                base = child_volume
2713        return base
2714
2715    def _unexpired_volume_target(self, player: Player) -> int | None:
2716        """Return the volume level last commanded, or None once it is too old to trust."""
2717        if (target := player.extra_data.get(ATTR_VOLUME_TARGET)) is None:
2718            return None
2719        volume_level, issued_at = target
2720        if time.monotonic() - issued_at < VOLUME_TARGET_EXPIRY:
2721            return cast("int", volume_level)
2722        del player.extra_data[ATTR_VOLUME_TARGET]
2723        return None
2724
2725    def _dispatch_state_update_subscribers(
2726        self, player: Player, changed_values: dict[str, tuple[Any, Any]]
2727    ) -> None:
2728        """Notify all internal subscribers of a player state update."""
2729        for subscriber in list(self._state_update_subscribers):
2730            try:
2731                subscriber(player, changed_values)
2732            except Exception:
2733                self.logger.exception(
2734                    "Error in player state update subscriber for %s", player.player_id
2735                )
2736
2737    async def _wait_for_playback_state(
2738        self,
2739        player: Player,
2740        wanted_state: PlaybackState,
2741        timeout: float,
2742        minimal_time: float = 0,
2743    ) -> None:
2744        """Wait for a player to reach a playback state, with optional minimum wait time."""
2745        start_timestamp = time.time()
2746        async with self.wait_for_player_update(
2747            player.player_id,
2748            attribute_name="playback_state",
2749            attribute_value=wanted_state,
2750            timeout=timeout,
2751        ):
2752            pass
2753        elapsed = time.time() - start_timestamp
2754        if elapsed < minimal_time:
2755            await asyncio.sleep(minimal_time - elapsed)
2756
2757    async def _clear_active_output_protocol_when_idle(self, player: Player) -> None:
2758        """Wait for the player to stop playing, then clear its active output protocol."""
2759        await self._wait_for_playback_state(player, PlaybackState.IDLE, timeout=10)
2760        player.set_active_output_protocol(None)
2761
2762    def _handle_membership_cleanup_on_state_change(
2763        self, player: Player, changed_values: dict[str, tuple[Any, Any]]
2764    ) -> None:
2765        """Detach a player from its (sync)groups when a state change requires it."""
2766        # A player that became unavailable or disabled can no longer be commanded,
2767        # so we drop it from its parent group/leader directly.
2768        became_inactive = (
2769            ATTR_AVAILABLE in changed_values and changed_values[ATTR_AVAILABLE][1] is False
2770        ) or (ATTR_ENABLED in changed_values and changed_values[ATTR_ENABLED][1] is False)
2771        if became_inactive and (player.state.active_group or player.state.synced_to):
2772            self.mass.create_task(self._cleanup_player_memberships(player.player_id))
2773
2774        # A player whose power was turned off outside of an MA power command (e.g. its
2775        # linked power control was switched off directly) must be unsynced too. We act
2776        # only on an explicit on->off transition, leaving players without power control
2777        # (powered == None) untouched. The player is still reachable here, so we route
2778        # through cmd_ungroup which also transfers leadership when it is a sync leader.
2779        if (
2780            changed_values.get(ATTR_POWERED) == (True, False)
2781            and player.state.type == PlayerType.PLAYER
2782            and (player.state.synced_to or player.state.active_group or player.state.group_members)
2783        ):
2784            self.mass.create_task(self.cmd_ungroup(player.player_id))
2785
2786    async def _cleanup_player_memberships(self, player_id: str) -> None:
2787        """Ensure a player is detached from any groups or syncgroups."""
2788        if not (player := self.get_player(player_id)):
2789            return
2790        with suppress(UnsupportedFeaturedException, PlayerCommandFailed, PlayerUnavailableError):
2791            if parent_id := (player.state.active_group or player.state.synced_to):
2792                # the player is part of a (permanent) groupplayer and the user tries to ungroup
2793                if parent_player := self.get_player(parent_id):
2794                    await self._handle_set_members(parent_player, player_ids_to_remove=[player_id])
2795                return
2796
2797    def _get_player_with_redirect(self, player_id: str) -> Player:
2798        """Get player with check if playback related command should be redirected."""
2799        player = self.get_player(player_id, True)
2800        assert player is not None  # for type checking
2801        if player.state.synced_to and (sync_leader := self.get_player(player.state.synced_to)):
2802            self.logger.info(
2803                "Player %s is synced to %s and can not accept "
2804                "playback related commands itself, "
2805                "redirected the command to the sync leader.",
2806                player.name,
2807                sync_leader.name,
2808            )
2809            return sync_leader
2810        if player.state.active_group and (
2811            active_group := self.get_player(player.state.active_group)
2812        ):
2813            self.logger.info(
2814                "Player %s is part of a playergroup and can not accept "
2815                "playback related commands itself, "
2816                "redirected the command to the group leader.",
2817                player.name,
2818            )
2819            return active_group
2820        return player
2821
2822    def _get_active_audio_source(self, player: Player) -> tuple[AudioSource, PluginProvider] | None:
2823        """
2824        Return the active AudioSource and its owning PluginProvider for a player.
2825
2826        Returns None when the player's active queue item is not a MediaType.AUDIO_SOURCE
2827        or when the owning plugin provider is no longer available.
2828
2829        :param player: The player whose active queue to inspect.
2830        """
2831        active_queue = self.get_active_queue(player)
2832        if active_queue is None:
2833            return None
2834        current_item = active_queue.current_item
2835        if current_item is None or current_item.media_item is None:
2836            return None
2837        media_item = current_item.media_item
2838        # isinstance check defends against a non-AudioSource subclass that
2839        # somehow has media_type=AUDIO_SOURCE set (mutated or constructed wrong)
2840        # — the media_type guard alone would let it through and crash later.
2841        if not isinstance(media_item, AudioSource):
2842            return None
2843        provider = self.mass.get_provider(media_item.provider)
2844        if not isinstance(provider, PluginProvider):
2845            return None
2846        # Belt-and-suspenders: a queue item carrying media_type=AUDIO_SOURCE
2847        # can only have come from a provider that declared the feature, but
2848        # a feature flag flipped off at runtime (provider reload, config
2849        # change) would leave on_source_control / on_volume_change raising
2850        # NotImplementedError out of cmd_play / cmd_pause. Skip cleanly.
2851        if ProviderFeature.AUDIO_SOURCE not in provider.supported_features:
2852            return None
2853        return media_item, provider
2854
2855    def _get_player_groups(self, player: Player) -> Iterator[Player]:
2856        """
2857        Return all group players the given player is a member of.
2858
2859        :param player: The player to look up the group memberships for.
2860        """
2861        # A group player mirrors its members, so it is also included while unavailable -
2862        # skipping it there is exactly how its state goes stale.
2863        player_id = player.player_id
2864        for _player in self.iter_players():
2865            if _player.player_id == player_id:
2866                continue
2867            if _player.state.type != PlayerType.GROUP:
2868                continue
2869            if player_id in _player.state.group_members:
2870                yield _player
2871
2872    # Protocol linking methods are provided by ProtocolLinkingMixin (protocol_linking.py)
2873
2874    def _repair_protocol_parent_links(self) -> None:
2875        """
2876        Repair protocol parent links in player configs on startup.
2877
2878        Scans player configs with a protocol_parent_id set and clears parent_ids
2879        that point to player configs that no longer exist (e.g., deleted universal
2880        players). A valid parent link also proves the player is a protocol child,
2881        so a stale player_type (left behind by an aborted registration) is healed.
2882        """
2883        all_player_configs = self.mass.config.get(CONF_PLAYERS, {})
2884        for player_id, player_config in all_player_configs.items():
2885            values = player_config.get("values") or {}
2886            parent_id = values.get(CONF_PROTOCOL_PARENT_ID)
2887            if not parent_id:
2888                continue
2889            # Check if parent config still exists
2890            parent_config = all_player_configs.get(parent_id)
2891            if not parent_config:
2892                self.logger.debug(
2893                    "Clearing stale protocol_parent_id %s for %s (parent config deleted)",
2894                    parent_id,
2895                    player_id,
2896                )
2897                conf_key = f"{CONF_PLAYERS}/{player_id}/values/{CONF_PROTOCOL_PARENT_ID}"
2898                self.mass.config.set(conf_key, None)
2899                continue
2900            if player_config.get("player_type") != PlayerType.PROTOCOL.value:
2901                self.logger.info(
2902                    "Repairing player type of %s - linked as protocol child of %s",
2903                    player_id,
2904                    parent_id,
2905                )
2906                self.mass.config.set_player_type(player_id, PlayerType.PROTOCOL)
2907
2908    async def _fix_group_member_configs(self) -> None:
2909        """
2910        Fix stale protocol player IDs in sync group member configs.
2911
2912        When a sync group references a protocol player ID instead of
2913        the parent player ID, correct it using the cached protocol parent mapping.
2914        """
2915        all_player_configs = self.mass.config.get(CONF_PLAYERS, {})
2916        total_fixes = 0
2917        fixed_groups: list[str] = []
2918
2919        for group_id, group_config in list(all_player_configs.items()):
2920            if group_config.get("provider") != "sync_group":
2921                continue
2922            old_members: list[str] = group_config.get("values", {}).get(CONF_GROUP_MEMBERS, [])
2923            if not old_members:
2924                continue
2925
2926            new_members: list[str] = []
2927            changes = 0
2928            for member_id in old_members:
2929                parent_id = self._get_cached_protocol_parent_id(member_id)
2930                corrected_id = parent_id or member_id
2931                if corrected_id != member_id:
2932                    changes += 1
2933                    self.logger.debug(
2934                        "Sync group %s: corrected member %s -> %s",
2935                        group_id,
2936                        member_id,
2937                        corrected_id,
2938                    )
2939                if corrected_id not in new_members:
2940                    new_members.append(corrected_id)
2941
2942            if changes:
2943                self.mass.config.set_raw_player_config_value(
2944                    group_id, CONF_GROUP_MEMBERS, new_members
2945                )
2946                total_fixes += changes
2947                fixed_groups.append(group_id)
2948
2949        for group_id in fixed_groups:
2950            if (group_player := self.get_player(group_id)) and group_player.available:
2951                await group_player.on_config_updated()
2952
2953        if total_fixes:
2954            self.logger.info(
2955                "Fixed %d stale member reference(s) across %d sync group(s)",
2956                total_fixes,
2957                len(fixed_groups),
2958            )
2959
2960    async def _poll_players(self) -> None:
2961        """Background task that polls players for updates."""
2962        while True:
2963            for player in list(self._players.values()):
2964                # if the player is playing, update elapsed time every tick
2965                # to ensure the queue has accurate details
2966                player_playing = player.state.playback_state == PlaybackState.PLAYING
2967                if player_playing and player.type != PlayerType.PROTOCOL:
2968                    self.mass.call_later(
2969                        0.5,
2970                        self.mass.player_queues.on_player_update,
2971                        player,
2972                        {"corrected_elapsed_time": (None, player.state.corrected_elapsed_time)},
2973                        task_id=f"queue_on_player_update_{player.player_id}",
2974                    )
2975                # Poll player;
2976                if not player.needs_poll:
2977                    continue
2978                try:
2979                    last_poll: float = player.extra_data[ATTR_LAST_POLL]
2980                except KeyError:
2981                    last_poll = 0.0
2982                if (self.mass.loop.time() - last_poll) < player.poll_interval:
2983                    continue
2984                player.extra_data[ATTR_LAST_POLL] = self.mass.loop.time()
2985                try:
2986                    await player.poll()
2987                except Exception as err:
2988                    self.logger.warning(
2989                        "Error while requesting latest state from player %s: %s",
2990                        player.state.name,
2991                        str(err),
2992                        exc_info=err if self.logger.isEnabledFor(10) else None,
2993                    )
2994                # Yield to event loop to prevent blocking
2995                await asyncio.sleep(0)
2996            await asyncio.sleep(1)
2997
2998    def _handle_group_dsp_change(
2999        self, player: Player, prev_group_members: list[str], new_group_members: list[str]
3000    ) -> None:
3001        """Handle DSP reload when group membership changes."""
3002        # reset cached group volume snapshot since membership changed
3003        player.extra_data.pop(ATTR_GROUP_VOLUME_SNAPSHOT, None)
3004        prev_child_count = len(prev_group_members)
3005        new_child_count = len(new_group_members)
3006        is_player_group = player.state.type == PlayerType.GROUP
3007
3008        # handle special case for PlayerGroups: since there are no leaders,
3009        # DSP still always work with a single player in the group.
3010        multi_device_dsp_threshold = 1 if is_player_group else 0
3011
3012        prev_is_multiple_devices = prev_child_count > multi_device_dsp_threshold
3013        new_is_multiple_devices = new_child_count > multi_device_dsp_threshold
3014
3015        if prev_is_multiple_devices == new_is_multiple_devices:
3016            return  # no change in multi-device status
3017
3018        supports_multi_device_dsp = (
3019            PlayerFeature.MULTI_DEVICE_DSP in player.state.supported_features
3020        )
3021
3022        dsp_enabled: bool
3023        if player.state.type == PlayerType.GROUP:
3024            # Since player groups do not have leaders, we will use the only child
3025            # that was in the group before and after the change
3026            if prev_is_multiple_devices:
3027                if childs := new_group_members:
3028                    # We shrank the group from multiple players to a single player
3029                    # So the now only child will control the DSP
3030                    dsp_enabled = self.mass.config.get_player_dsp_config(childs[0]).enabled
3031                else:
3032                    dsp_enabled = False
3033            elif childs := prev_group_members:
3034                # We grew the group from a single player to multiple players,
3035                # let's see if the previous single player had DSP enabled
3036                dsp_enabled = self.mass.config.get_player_dsp_config(childs[0]).enabled
3037            else:
3038                dsp_enabled = False
3039        else:
3040            dsp_enabled = self.mass.config.get_player_dsp_config(player.player_id).enabled
3041
3042        if dsp_enabled and not supports_multi_device_dsp:
3043            # We now know that the group configuration has changed so:
3044            # - multi-device DSP is not supported
3045            # - we switched from a group with multiple players to a single player
3046            #   (or vice versa)
3047            # - the leader has DSP enabled
3048            self.mass.create_task(self.mass.players.on_player_dsp_change(player.player_id))
3049
3050    def _check_external_source_takeover(self, player: Player) -> None:
3051        """
3052        Handle when an external source takes over playback on a player.
3053
3054        When a player has an active grouped output protocol (e.g., AirPlay group) and
3055        an external source (e.g., Spotify Connect, TV input) takes over playback,
3056        we need to clear the active output protocol and ungroup the protocol players.
3057
3058        This prevents the situation where the player appears grouped via protocol
3059        but is actually playing from a different source.
3060
3061        :param player: The player whose active_source changed.
3062        """
3063        # Only relevant for non-protocol players
3064        if player.type == PlayerType.PROTOCOL:
3065            return
3066
3067        # Not a takeover if the player is not actively playing
3068        if player.playback_state != PlaybackState.PLAYING:
3069            return
3070
3071        # Only relevant if we have an active output protocol (not native)
3072        if not player.active_output_protocol or player.active_output_protocol == "native":
3073            return
3074
3075        new_source = player.state.active_source
3076
3077        # Check if new source is external (not MA-managed)
3078        if self._is_ma_managed_source(player, new_source):
3079            return
3080
3081        # Get the active protocol player
3082        protocol_player = self.get_player(player.active_output_protocol)
3083        if not protocol_player:
3084            return
3085
3086        # If the source matches the active protocol's domain, it's expected - not a takeover
3087        # e.g., source "airplay" when using AirPlay protocol is normal
3088        if new_source and new_source.lower() == protocol_player.provider.domain.lower():
3089            return
3090
3091        if (
3092            new_source
3093            and new_source.lower() in ("airplay", "cast", "chromecast", "network")
3094            and protocol_player.provider.domain.lower() == "sendspin"
3095        ):
3096            # Special case for Sendspin bridge: if the new source matches cast or airplay and the
3097            # active protocol is Sendspin, we consider this a normal behavior and not a takeover
3098            return
3099
3100        # Confirmed external source takeover
3101        self.logger.info(
3102            "External source '%s' took over on %s while playing via protocol %s - "
3103            "clearing active output protocol and ungrouping",
3104            new_source,
3105            player.display_name,
3106            protocol_player.provider.domain,
3107        )
3108
3109        # Set active output protocol to native
3110        player.set_active_output_protocol("native")
3111
3112        # Ungroup the protocol player (async task)
3113        self.mass.create_task(protocol_player.ungroup())
3114
3115    def _is_ma_managed_source(self, player: Player, source: str | None) -> bool:
3116        """
3117        Check if a source is managed by Music Assistant.
3118
3119        MA-managed sources include:
3120        - None (=autodetect, no source explicitly set by player)
3121        - The player's own ID (MA queue)
3122        - Any active queue ID
3123        - Any plugin source ID
3124
3125        :param player: The player to check.
3126        :param source: The source ID to check.
3127        :return: True if the source is MA-managed, False if external.
3128        """
3129        if source is None:
3130            return True
3131
3132        # Player's own ID means MA queue is active
3133        if source == player.player_id:
3134            return True
3135
3136        # Check if it's a known queue ID
3137        return self.mass.player_queues.get(source) is not None
3138
3139    def _schedule_update_all_players(self, delay: float = 2.0) -> None:
3140        """
3141        Schedule a debounced update of all players' state.
3142
3143        Used when a new player is registered to ensure all existing players
3144        update their dynamic properties (like can_group_with) that may have changed.
3145
3146        :param delay: Delay in seconds before triggering updates (default 2.0).
3147        """
3148        if self.mass.closing:
3149            return
3150
3151        for player in self.all_players(
3152            return_unavailable=True,
3153            return_disabled=False,
3154            return_protocol_players=True,
3155        ):
3156            self.trigger_player_update(player.player_id, debounce_delay=delay)
3157
3158    async def _auto_ungroup_if_synced(self, player: Player, log_context: str) -> None:
3159        """
3160        Automatically ungroup a player if it's synced to another player.
3161
3162        :param player: The player to check and potentially ungroup.
3163        :param log_context: Additional context for the log message (e.g., target player name).
3164        """
3165        if not player.state.synced_to and not player.state.active_group:
3166            return
3167        self.logger.info(
3168            "Player %s is already synced to %s, ungrouping it first before %s",
3169            player.name,
3170            player.state.synced_to or player.state.active_group,
3171            log_context,
3172        )
3173        # Use internal _handle_set_members to avoid deadlocking on the play lock
3174        # (we're already inside a cmd_set_members chain that holds a play lock).
3175        synced_to = player.state.synced_to or player.state.active_group
3176        if synced_to and (parent := self.get_player(synced_to)):
3177            try:
3178                async with self.wait_for_player_update(player.player_id, timeout=5):
3179                    await self._handle_set_members(parent, player_ids_to_remove=[player.player_id])
3180            except asyncio.CancelledError:
3181                raise
3182            except Exception:
3183                self.logger.warning(
3184                    "Failed to auto-ungroup %s from %s, proceeding anyway",
3185                    player.name,
3186                    synced_to,
3187                )
3188
3189    async def _handle_set_members(
3190        self,
3191        parent_player: Player,
3192        player_ids_to_add: list[str] | None = None,
3193        player_ids_to_remove: list[str] | None = None,
3194    ) -> None:
3195        """
3196        Handle the actual set_members logic.
3197
3198        Skips permission checks and locking (internal use only).
3199
3200        :param parent_player: The parent player to add/remove members to/from.
3201        :param player_ids_to_add: List of player_id's to add to the parent player.
3202        :param player_ids_to_remove: List of player_id's to remove from the parent player.
3203        """
3204        target_player = parent_player.player_id
3205        # handle the sync leader being removed from itself: either transfer leadership
3206        # to a remaining member (keeping playback alive) or dissolve the group entirely
3207        should_stop = False
3208        if player_ids_to_remove and target_player in player_ids_to_remove:
3209            remaining_members = [
3210                m
3211                for m in parent_player.state.group_members
3212                if m != target_player
3213                and m not in player_ids_to_remove
3214                and (member := self.get_player(m))
3215                and member.state.available
3216            ]
3217            active_queue = self.get_active_queue(parent_player)
3218            if remaining_members and active_queue and active_queue.state != PlaybackState.IDLE:
3219                # transfer leadership to a remaining member instead of dissolving
3220                await self._transfer_ad_hoc_leadership(parent_player, remaining_members)
3221                return
3222            self.logger.info(
3223                "Dissolving sync group of player %s as it is being removed from itself",
3224                parent_player.name,
3225            )
3226            player_ids_to_add = None
3227            player_ids_to_remove = [
3228                x for x in parent_player.state.group_members if x != target_player
3229            ]
3230            should_stop = True
3231        # filter all player ids on compatibility and availability
3232        final_player_ids_to_add: list[str] = []
3233        for child_player_id in player_ids_to_add or []:
3234            if child_player_id == target_player:
3235                continue
3236            if child_player_id in final_player_ids_to_add:
3237                continue
3238            if (
3239                not (child_player := self.get_player(child_player_id))
3240                or not child_player.state.available
3241            ):
3242                self.logger.warning("Player %s is not available", child_player_id)
3243                continue
3244
3245            # check if player can be synced/grouped with the target player
3246            # state.can_group_with already handles all expansion and translation
3247            if child_player_id not in parent_player.state.can_group_with:
3248                self.logger.warning(
3249                    "Player %s can not be grouped with %s",
3250                    child_player.name,
3251                    parent_player.name,
3252                )
3253                continue
3254
3255            if (
3256                child_player.state.synced_to
3257                and child_player.state.synced_to == target_player
3258                and child_player_id in parent_player.state.group_members
3259            ):
3260                continue  # already synced to this target
3261
3262            # also skip if the child is part of this group via its sync leader
3263            # (e.g. synced to the sync leader of this syncgroup)
3264            if (
3265                child_player.state.active_group == target_player
3266                and child_player_id in parent_player.state.group_members
3267            ):
3268                continue
3269
3270            # handle edge case: child player is synced to a different player
3271            # automatically ungroup it first and wait for state to propagate
3272            # but not if the child is already part of this group (via its sync leader)
3273            if child_player.state.synced_to and target_player not in {
3274                child_player.state.synced_to,
3275                child_player.state.active_group,
3276            }:
3277                await self._auto_ungroup_if_synced(child_player, f"joining {parent_player.name}")
3278
3279            # power on the player if needed
3280            if (
3281                not child_player.state.powered
3282                and child_player.state.power_control != PLAYER_CONTROL_NONE
3283            ):
3284                await self._handle_cmd_power(child_player.player_id, True)
3285            # if we reach here, all checks passed
3286            final_player_ids_to_add.append(child_player_id)
3287
3288        # process player ids to remove and filter out invalid/unavailable players and edge cases
3289        final_player_ids_to_remove: list[str] = []
3290        if player_ids_to_remove:
3291            for child_player_id in player_ids_to_remove:
3292                if child_player_id in parent_player.state.group_members:
3293                    final_player_ids_to_remove.append(child_player_id)
3294                    continue
3295                # also accept the removal if the child player itself reports
3296                # being synced to this parent - handles race conditions where the
3297                # parent's group_members state is stale/not yet updated
3298                child_player = self.get_player(child_player_id)
3299                if child_player and child_player.state.synced_to == target_player:
3300                    final_player_ids_to_remove.append(child_player_id)
3301                    continue
3302
3303        # Forward command to the appropriate player after all (base) sanity checks
3304        # GROUP players (sync_group, universal_group) manage their own members internally
3305        # and don't need protocol translation - call their set_members directly
3306        if (
3307            parent_player.type == PlayerType.GROUP
3308            and PlayerFeature.SET_MEMBERS in parent_player.state.supported_features
3309        ):
3310            await parent_player.set_members(
3311                player_ids_to_add=final_player_ids_to_add,
3312                player_ids_to_remove=final_player_ids_to_remove,
3313            )
3314            return
3315        # For regular players, handle protocol selection and translation
3316        await self._handle_set_members_with_protocols(
3317            parent_player, final_player_ids_to_add, final_player_ids_to_remove
3318        )
3319
3320        if should_stop:
3321            # Stop playback on the player if it is being removed from itself
3322            await self._handle_cmd_stop(parent_player.player_id)
3323
3324    async def _handle_set_members_with_protocols(
3325        self,
3326        parent_player: Player,
3327        player_ids_to_add: list[str],
3328        player_ids_to_remove: list[str],
3329    ) -> None:
3330        """
3331        Handle set_members considering protocol and native members.
3332
3333        Skips permission checks, locking, and all redirect logic (internal use only).
3334        Translates visible player IDs to protocol player IDs when appropriate,
3335        and forwards to the correct player's set_members.
3336
3337        :param parent_player: The parent player to add/remove members to/from.
3338        :param player_ids_to_add: List of visible player IDs to add as members.
3339        :param player_ids_to_remove: List of visible player IDs to remove from members.
3340        """
3341        # Get parent's active protocol domain and player if available
3342        parent_protocol_domain = None
3343        parent_protocol_player = None
3344        if (
3345            parent_player.active_output_protocol
3346            and parent_player.active_output_protocol != "native"
3347        ):
3348            parent_protocol_player = self.get_player(parent_player.active_output_protocol)
3349            if parent_protocol_player:
3350                parent_protocol_domain = parent_protocol_player.provider.domain
3351
3352        self.logger.debug(
3353            "set_members on %s: active_protocol=%s, adding=%s, removing=%s",
3354            parent_player.state.name,
3355            parent_protocol_domain or "none",
3356            player_ids_to_add,
3357            player_ids_to_remove,
3358        )
3359
3360        # Translate members to add
3361        (
3362            protocol_members_to_add,
3363            native_members_to_add,
3364            parent_protocol_player,
3365            parent_protocol_domain,
3366        ) = self._translate_members_for_protocols(
3367            parent_player, player_ids_to_add, parent_protocol_player, parent_protocol_domain
3368        )
3369
3370        self.logger.debug(
3371            "Translated members: protocol=%s (domain=%s), native=%s",
3372            protocol_members_to_add,
3373            parent_protocol_domain,
3374            native_members_to_add,
3375        )
3376
3377        # Translate members to remove
3378        protocol_members_to_remove, native_members_to_remove = (
3379            self._translate_members_to_remove_for_protocols(
3380                parent_player, player_ids_to_remove, parent_protocol_player, parent_protocol_domain
3381            )
3382        )
3383
3384        # Forward protocol members to protocol player's set_members
3385        if (protocol_members_to_add or protocol_members_to_remove) and parent_protocol_player:
3386            await self._forward_protocol_set_members(
3387                parent_player,
3388                parent_protocol_player,
3389                protocol_members_to_add,
3390                protocol_members_to_remove,
3391            )
3392
3393        # Forward native members to parent player's set_members
3394        if native_members_to_add or native_members_to_remove:
3395            filtered_native_add = self._filter_native_members(native_members_to_add, parent_player)
3396            # For removal, allow protocol players if they're actually in the parent's group_members
3397            # This handles native protocol players (e.g., native AirPlay) where group_members
3398            # contains protocol player IDs
3399            filtered_native_remove = [
3400                pid
3401                for pid in native_members_to_remove
3402                if (p := self.get_player(pid))
3403                and (p.type != PlayerType.PROTOCOL or pid in parent_player.group_members)
3404            ]
3405            self.logger.debug(
3406                "Native grouping on %s: filtered_add=%s, filtered_remove=%s",
3407                parent_player.state.name,
3408                filtered_native_add,
3409                filtered_native_remove,
3410            )
3411            if filtered_native_add or filtered_native_remove:
3412                if PlayerFeature.SET_MEMBERS not in parent_player.state.supported_features:
3413                    return
3414                self.logger.info(
3415                    "Calling set_members on native player %s with add=%s, remove=%s",
3416                    parent_player.state.name,
3417                    filtered_native_add,
3418                    filtered_native_remove,
3419                )
3420                await parent_player.set_members(
3421                    player_ids_to_add=filtered_native_add or None,
3422                    player_ids_to_remove=filtered_native_remove or None,
3423                )
3424
3425    async def _transfer_ad_hoc_leadership(
3426        self, leader: Player, remaining_members: list[str]
3427    ) -> None:
3428        """
3429        Transfer leadership of an ad-hoc sync group to a remaining member.
3430
3431        Called when the sync leader of an ad-hoc group is unjoined while other
3432        members remain and playback is active. The queue is moved to a newly
3433        selected leader, the remaining members are regrouped under it and playback
3434        resumes at the saved position (accepting a brief audio gap).
3435
3436        :param leader: The current sync leader being removed from the group.
3437        :param remaining_members: Available group members (excluding the leader)
3438            that should keep playing under a new leader.
3439        """
3440        active_queue = self.get_active_queue(leader)
3441        was_playing = active_queue is not None and active_queue.state == PlaybackState.PLAYING
3442        new_leader_id = self._select_ad_hoc_leader(leader, remaining_members)
3443        self.logger.info(
3444            "Transferring leadership of %s to %s (%s remaining member(s))",
3445            leader.name,
3446            new_leader_id,
3447            len(remaining_members),
3448        )
3449        # Move the queue to the new leader. transfer_queue frees the new leader from
3450        # the old leader's group and stops the old leader; the playback position
3451        # survives because stop() stores it in resume_pos.
3452        await self.mass.player_queues.transfer_queue(
3453            leader.player_id, new_leader_id, auto_play=False
3454        )
3455        # regroup the other remaining members under the new leader
3456        other_members = [m for m in remaining_members if m != new_leader_id]
3457        if other_members:
3458            await self.cmd_set_members(new_leader_id, player_ids_to_add=other_members)
3459        if was_playing:
3460            await self.mass.player_queues.resume(new_leader_id)
3461
3462    def _select_ad_hoc_leader(self, leader: Player, remaining_members: list[str]) -> str:
3463        """
3464        Pick the new leader for an ad-hoc sync group leadership transfer.
3465
3466        Prefers a remaining member that can currently be reached on the protocol the
3467        group is playing on, so the other members can be regrouped under it; falls back
3468        to the first remaining member. The members' own ``can_group_with`` is unusable
3469        here because it is empty while they are still synced to the old leader.
3470
3471        :param leader: The current sync leader being removed.
3472        :param remaining_members: Candidate member player_ids, already filtered for
3473            availability. Must not be empty.
3474        """
3475        active_domain: str | None = None
3476        if leader.active_output_protocol and leader.active_output_protocol != "native":
3477            if protocol_player := self.get_player(leader.active_output_protocol):
3478                active_domain = protocol_player.provider.domain
3479        if active_domain:
3480            for member_id in remaining_members:
3481                member = self.get_player(member_id)
3482                if member is None:
3483                    continue
3484                if active_domain in member.playback_domains:
3485                    return member_id
3486        return remaining_members[0]
3487
3488    def _clear_sleep_timer(self, player: Player) -> None:
3489        """
3490        Clear the active sleep timer for the player.
3491
3492        :param player: Player to clear the timer for.
3493        """
3494        self.mass.cancel_timer(self._sleep_timer_task_id(player.player_id))
3495        if player.sleep_timer_expires_at is not None:
3496            player.set_sleep_timer_expires_at(None)
3497            player.update_state()
3498            self._signal_sleep_timer_updated(player, None)
3499
3500    async def _handle_sleep_timer_expired(self, player_id: str) -> None:
3501        """
3502        Stop playback when a player's sleep timer expires.
3503
3504        :param player_id: Player ID whose sleep timer expired.
3505        """
3506        player = self.get_player(player_id)
3507        if player is None or player.sleep_timer_expires_at is None:
3508            return
3509        player.set_sleep_timer_expires_at(None)
3510        player.update_state()
3511        self._signal_sleep_timer_updated(player, None)
3512        await self.cmd_stop(player_id)
3513
3514    def _signal_sleep_timer_updated(self, player: Player, expires_at: float | None) -> None:
3515        """
3516        Signal a sleep timer change for the player on the event bus.
3517
3518        :param player: Player whose sleep timer changed.
3519        :param expires_at: New expiry timestamp, or None when the timer was cleared.
3520        """
3521        if player.state.type == PlayerType.PROTOCOL:
3522            return
3523        self.mass.signal_event(
3524            EventType.PLAYER_SLEEP_TIMER_UPDATED,
3525            object_id=player.player_id,
3526            data=expires_at,
3527        )
3528
3529    @staticmethod
3530    def _sleep_timer_task_id(player_id: str) -> str:
3531        """
3532        Return the scheduled task ID for a player's sleep timer.
3533
3534        :param player_id: Player ID to build the task ID for.
3535        """
3536        return f"player_sleep_timer_{player_id}"
3537
3538    # Private command handlers (no permission checks)
3539
3540    async def _handle_cmd_resume(
3541        self, player_id: str, source: str | None = None, media: PlayerMedia | None = None
3542    ) -> None:
3543        """
3544        Handle resume playback command.
3545
3546        Skips permission checks and locking (internal use only).
3547        """
3548        player = self._get_player_with_redirect(player_id)
3549        source = source or player.state.active_source
3550        media = media or player.state.current_media
3551        # power on the player if needed
3552        if not player.state.powered and player.state.power_control != PLAYER_CONTROL_NONE:
3553            await self._handle_cmd_power(player.player_id, True)
3554        # Redirect to queue controller if it is active
3555        if active_queue := self.mass.player_queues.get(source or player_id):
3556            await self.mass.player_queues.resume(active_queue.queue_id)
3557            return
3558        # try to handle command on player directly
3559        # TODO: check if player has an active source with native resume support
3560        active_source = next((x for x in player.state.source_list if x.id == source), None)
3561        if (
3562            player.state.playback_state in (PlaybackState.IDLE, PlaybackState.PAUSED)
3563            and active_source
3564            and active_source.can_play_pause
3565            and PlayerFeature.PAUSE in player.state.supported_features
3566        ):
3567            # player has some other source active and native resume support
3568            await player.play()
3569            return
3570        if active_source and not active_source.passive:
3571            await self.select_source(player_id, active_source.id)
3572            return
3573        if media:
3574            # try to re-play the current media item
3575            await player.play_media(media)
3576            return
3577        # fallback: just try to resume queue playback
3578        await self.mass.player_queues.resume(player.player_id)
3579
3580    async def _handle_cmd_power(
3581        self, player_id: str, powered: bool, skip_auto_play: bool = False
3582    ) -> None:
3583        """
3584        Handle player power on/off command.
3585
3586        Skips permission checks and locking (internal use only).
3587
3588        :param player_id: The player ID to power on/off.
3589        :param powered: True to power on, False to power off.
3590        :param skip_auto_play: If True, skip auto-play on power on.
3591        """
3592        player = self.get_player(player_id, True)
3593        assert player is not None  # for type checking
3594        player_state = player.state
3595
3596        if player_state.powered == powered:
3597            self.logger.debug(
3598                "Ignoring power %s command for player %s: already in state %s",
3599                "ON" if powered else "OFF",
3600                player_state.name,
3601                "ON" if player_state.powered else "OFF",
3602            )
3603            return  # nothing to do
3604
3605        # ungroup player at power off
3606        player_was_sync_child = bool(player.state.synced_to or player.state.active_group)
3607        if (
3608            (player_was_sync_child or player.group_members)
3609            and player.type == PlayerType.PLAYER
3610            and not powered
3611        ):
3612            # ungroup player if it is synced (or is a sync leader itself)
3613            await self.cmd_ungroup(player_id)
3614
3615        # always stop player at power off
3616        if (
3617            not powered
3618            and not player_was_sync_child
3619            and player_state.playback_state in (PlaybackState.PLAYING, PlaybackState.PAUSED)
3620        ):
3621            # wait for the stop command to process and prevent race conditions
3622            async with self.wait_for_player_update(player_id, timeout=5):
3623                await self._handle_cmd_stop(player_id)
3624
3625        # power off all synced childs when player is a sync leader
3626        elif not powered and player_state.type == PlayerType.PLAYER and player_state.group_members:
3627            async with TaskManager(self.mass) as tg:
3628                for member in self.iter_group_members(player, True):
3629                    if member.power_control == PLAYER_CONTROL_NONE:
3630                        continue
3631                    tg.create_task(self._handle_cmd_power(member.player_id, False))
3632
3633        # handle actual power command
3634        if player_state.power_control == PLAYER_CONTROL_NONE:
3635            self.logger.debug(
3636                "Player %s does not support power control, ignoring power command",
3637                player_state.name,
3638            )
3639            return
3640        if player_state.power_control == PLAYER_CONTROL_NATIVE:
3641            # player supports power command natively: forward to player provider
3642            await player.power(powered)
3643            if powered:
3644                await wait_for_power_on(self.logger, player)
3645        elif player_state.power_control == PLAYER_CONTROL_FAKE:
3646            # user wants to use fake power control - so we (optimistically) update the state
3647            # and store the state in the cache
3648            player.extra_data[ATTR_FAKE_POWER] = powered
3649            # Group players need to actively form/dissolve their session when the
3650            # user toggles fake power — otherwise the toggle would only update the
3651            # cosmetic state without ever capturing or releasing the members.
3652            if player_state.type == PlayerType.GROUP:
3653                await player.power(powered)
3654            player.update_state()  # trigger update of the player state
3655            if player_state.type != PlayerType.GROUP:
3656                # see register(): group fake-power is intentionally not persisted
3657                # because there is no session to restore at boot.
3658                await self.mass.cache.set(
3659                    key=player_id,
3660                    data=powered,
3661                    provider=self.domain,
3662                    category=CACHE_CATEGORY_PLAYER_POWER,
3663                )
3664        # handle external player control
3665        elif player_control := self._controls.get(player.state.power_control):
3666            control_name = player_control.name
3667            self.logger.debug("Redirecting power command to PlayerControl %s", control_name)
3668            if not player_control.supports_power:
3669                raise UnsupportedFeaturedException(
3670                    f"Player control {control_name} is not available"
3671                )
3672            if powered:
3673                assert player_control.power_on is not None  # for type checking
3674                await player_control.power_on()
3675                await wait_for_power_on(self.logger, player, player_control)
3676            else:
3677                assert player_control.power_off is not None  # for type checking
3678                await player_control.power_off()
3679        # always trigger a state update to update the UI
3680        player.refresh_state()
3681
3682        # handle 'auto play on power on' feature
3683        if (
3684            not skip_auto_play
3685            and not player_state.active_group
3686            and not player_state.synced_to
3687            and powered
3688            and player.config.get_value(CONF_AUTO_PLAY)
3689            and player_state.active_source in (None, player_id)
3690            and not player.extra_data.get(ATTR_ANNOUNCEMENT_IN_PROGRESS)
3691        ):
3692            await self.mass.player_queues.resume(player_id)
3693
3694    def _resolve_group_volume_player(self, player: Player) -> Player | None:
3695        """
3696        Return the player whose group a group volume command applies to.
3697
3698        Returns None if the given player is not grouped at all. Commands addressed to a
3699        synced member and to its sync leader resolve to the same player, so they read
3700        and guard one and the same group.
3701
3702        :param player: The player the command was addressed to.
3703        """
3704        # the group volume lock this resolves to may not share the VOLUME purpose:
3705        # set_group_volume sets the volume of the members concurrently and a sync leader
3706        # is a member of its own group, so a group command would wait on its own lock.
3707        if player.state.type == PlayerType.GROUP or player.state.group_members:
3708            # dedicated group player or sync leader
3709            return player
3710        if player.state.synced_to:
3711            # a synced player follows its sync leader
3712            return self.get_player(player.state.synced_to)
3713        return None
3714
3715    async def _set_member_volume(self, player_id: str, volume_level: int) -> None:
3716        """
3717        Set the volume of a single member as part of a group volume change.
3718
3719        :param player_id: player_id of the member to handle the command.
3720        :param volume_level: logical volume level (0..100) to set on the member.
3721        """
3722        # record before waiting for the lock, for the same reason as cmd_volume_set
3723        if member := self.get_player(player_id):
3724            self._record_volume_target(member, volume_level)
3725        # take the volume lock of the member itself, so a group volume change and an
3726        # individual volume command for that member can not overtake one another
3727        async with self.get_player_lock(player_id, PlayerLockPurpose.VOLUME):
3728            await self._handle_cmd_volume_set(player_id, volume_level, record_target=False)
3729
3730    async def _handle_cmd_volume_set(
3731        self, player_id: str, volume_level: int, *, record_target: bool = True
3732    ) -> None:
3733        """
3734        Handle Player volume set command.
3735
3736        Skips permission checks and locking (internal use only).
3737
3738        :param player_id: player_id of the player to handle the command.
3739        :param volume_level: logical volume level (0..100) to set on the player.
3740        :param record_target: Set to False when the caller already recorded the level as
3741            the base for the next volume nudge, before it waited for the volume lock.
3742        """
3743        player = self.get_player(player_id, True)
3744        assert player is not None  # for type checker
3745
3746        # Clamp logical volume to 0-100
3747        volume_level = max(0, min(100, volume_level))
3748
3749        if player.type == PlayerType.GROUP:
3750            # redirect to special group volume control
3751            await self.cmd_group_volume(player_id, volume_level)
3752            return
3753
3754        # A muted player stays muted: only an explicit unmute lifts it, and the level
3755        # set here is the one it plays at once that happens. Fake mute is the exception,
3756        # because it is simulated with the volume itself.
3757        if self._stays_silent_on_volume_change(player):
3758            # a locked player stays silent, the volume it holds is the one
3759            # that gets restored once it is unmuted again
3760            volume_level = 0
3761            # the lock may have been earned after the caller recorded the level it asked
3762            # for, which is then not the level this player ends up at
3763            record_target = True
3764        else:
3765            player.extra_data.pop(ATTR_FAKE_MUTE, None)
3766
3767        if record_target:
3768            self._record_volume_target(player, volume_level)
3769
3770        # Scale logical volume (0-100) to device volume (min_volume-max_volume)
3771        device_volume = self.scale_volume_to_device(player_id, volume_level)
3772
3773        # Notify the active AudioSource of a volume change.
3774        # Only fire if this player is the direct owner of its queue,
3775        # not when it merely inherits active_source from a parent group —
3776        # group volume changes handle the callback once at the group level.
3777        if active := self._get_active_audio_source(player):
3778            audio_source, plugin_prov = active
3779            active_queue = self.get_active_queue(player)
3780            if active_queue is not None and active_queue.queue_id == player.player_id:
3781                await plugin_prov.on_volume_change(audio_source.item_id, volume_level)
3782
3783        # Handle native volume control support
3784        if player.volume_control == PLAYER_CONTROL_NATIVE:
3785            # player supports volume command natively: forward to player
3786            await player.volume_set(device_volume)
3787            return
3788        # Handle fake volume control support
3789        if player.volume_control == PLAYER_CONTROL_FAKE:
3790            # user wants to use fake volume control - so we (optimistically) update the state
3791            # and store the state in the cache. Fake volume uses the logical volume (no scaling).
3792            player.extra_data[ATTR_FAKE_VOLUME] = volume_level
3793            player.update_state()
3794            return
3795        # player has no volume support at all
3796        if player.volume_control == PLAYER_CONTROL_NONE:
3797            raise UnsupportedFeaturedException(
3798                f"Player {player.state.name} does not support volume control"
3799            )
3800        # handle external player control
3801        if player_control := self._controls.get(player.state.volume_control):
3802            control_name = player_control.name
3803            self.logger.debug("Redirecting volume command to PlayerControl %s", control_name)
3804            if not player_control.supports_volume:
3805                raise UnsupportedFeaturedException(
3806                    f"Player control {control_name} is not available"
3807                )
3808            assert player_control.volume_set is not None
3809            # forward the already-scaled device volume; the external control sets the
3810            # raw device volume and does not apply min/max scaling of its own
3811            await player_control.volume_set(device_volume)
3812            return
3813        if protocol_player := self.get_player(player.state.volume_control):
3814            # forward the already-scaled device volume: the limits configured on this
3815            # (user-facing) player are the only ones that apply to the command
3816            self.logger.debug(
3817                "Redirecting volume command to protocol player %s",
3818                protocol_player.provider.manifest.name,
3819            )
3820            await protocol_player.volume_set(device_volume)
3821            return
3822
3823    @staticmethod
3824    def _is_in_group(state: PlayerState) -> bool:
3825        """Check if the player with the given state is currently grouped with other players."""
3826        # a sync leader has neither synced_to nor active_group set, but it does lead its
3827        # own group_members, which stays empty for a player that is not grouped at all
3828        return bool(state.synced_to or state.active_group or state.group_members)
3829
3830    def _has_active_mute_lock(self, player: Player) -> bool:
3831        """
3832        Check if the given player holds a mute lock that still applies to it.
3833
3834        A lock is only earned inside a group and only holds for as long as the player
3835        is still grouped, so it can not outlive the group it was earned in.
3836
3837        :param player: The player to check, which may be a protocol player.
3838        """
3839        if player.extra_data.get(ATTR_MUTE_LOCK) and self._is_in_group(player.state):
3840            return True
3841        # cmd_volume_mute stores the lock on the parent player, while the volume command
3842        # may arrive with the protocol player ID (e.g. during group volume changes)
3843        if player.protocol_parent_id and (parent := self.get_player(player.protocol_parent_id)):
3844            return bool(parent.extra_data.get(ATTR_MUTE_LOCK)) and self._is_in_group(parent.state)
3845        return False
3846
3847    def _stays_silent_on_volume_change(self, player: Player) -> bool:
3848        """Check if a volume command for the given player lands at 0 to keep it silent."""
3849        return (
3850            self._has_active_mute_lock(player)
3851            and player.mute_control == PLAYER_CONTROL_FAKE
3852            and bool(player.extra_data.get(ATTR_FAKE_MUTE))
3853        )
3854
3855    async def _mute_group_members(self, group_player: Player, muted: bool) -> None:
3856        """
3857        Mute or unmute all mute capable members of a player group or synced players.
3858
3859        :param group_player: The group player or sync leader.
3860        :param muted: bool if the group should be muted.
3861        """
3862        coros = []
3863        for child_player in self.iter_group_members(
3864            group_player, only_powered=True, exclude_self=False
3865        ):
3866            if child_player.mute_control == PLAYER_CONTROL_NONE:
3867                # members without a mute control are left alone, just like the
3868                # group mute state itself is calculated from the capable members only
3869                continue
3870            coros.append(self.cmd_volume_mute(child_player.player_id, muted))
3871        await asyncio.gather(*coros)
3872
3873    async def _handle_cmd_volume_mute(self, player: Player, mute_control: str, muted: bool) -> None:
3874        """
3875        Send the mute command to the given player's mute control.
3876
3877        Skips permission checks, locking and mute lock bookkeeping (internal use only).
3878
3879        :param player: the player to handle the command.
3880        :param mute_control: the already resolved mute control of the player.
3881        :param muted: bool if player should be muted.
3882        """
3883        if mute_control == PLAYER_CONTROL_NATIVE:
3884            # player supports mute command natively: forward to player
3885            await player.volume_mute(muted)
3886            return
3887        if mute_control == PLAYER_CONTROL_FAKE:
3888            # user wants to use fake mute control - so we use volume instead
3889            self.logger.debug(
3890                "Using volume for muting for player %s",
3891                player.state.name,
3892            )
3893            if muted:
3894                already_muted = bool(player.extra_data.get(ATTR_FAKE_MUTE))
3895                if not already_muted:
3896                    # on a repeated mute command the volume is already 0
3897                    player.extra_data[ATTR_PREVIOUS_VOLUME] = player.state.volume_level
3898                await self._handle_cmd_volume_set(player.player_id, 0)
3899                # set the flag after the volume command, as that clears it
3900                player.extra_data[ATTR_FAKE_MUTE] = True
3901                player.update_state()
3902            else:
3903                was_muted = bool(player.extra_data.get(ATTR_FAKE_MUTE))
3904                player.extra_data[ATTR_FAKE_MUTE] = False
3905                player.update_state()
3906                if not was_muted:
3907                    # the volume is the one the user is listening at, restoring
3908                    # anything here would turn a no-op unmute into a volume change
3909                    return
3910                stored_volume: int | None = player.extra_data.pop(ATTR_PREVIOUS_VOLUME, None)
3911                # the volume was still unknown at mute time, so pick a low volume
3912                # rather than blasting the speaker at some assumed level
3913                await self._handle_cmd_volume_set(
3914                    player.player_id, 1 if stored_volume is None else stored_volume
3915                )
3916            return
3917
3918        # handle external player control
3919        if player_control := self._controls.get(mute_control):
3920            control_name = player_control.name
3921            self.logger.debug("Redirecting mute command to PlayerControl %s", control_name)
3922            if not player_control.supports_mute:
3923                raise UnsupportedFeaturedException(
3924                    f"Player control {control_name} is not available"
3925                )
3926            assert player_control.mute_set is not None
3927            await player_control.mute_set(muted)
3928            return
3929
3930        # handle to protocol player as volume_mute control
3931        if protocol_player := self.get_player(mute_control):
3932            self.logger.debug(
3933                "Redirecting mute command to protocol player %s",
3934                protocol_player.provider.manifest.name,
3935            )
3936            await protocol_player.volume_mute(muted)
3937            return
3938
3939        # the configured control disappeared after the mute control was resolved
3940        raise UnsupportedFeaturedException(f"Player {player.state.name} does not support muting")
3941
3942    async def _handle_play_media(self, player_id: str, media: PlayerMedia) -> None:
3943        """
3944        Handle play media command without group redirect.
3945
3946        Skips permission checks, locking, and all redirect logic (internal use only).
3947
3948        :param player_id: player_id of the player to handle the command.
3949        :param media: The Media that needs to be played on the player.
3950        """
3951        player = self.get_player(player_id, raise_unavailable=True)
3952        assert player is not None
3953        # set active source if media has a source_id (e.g. plugin source or mass queue source)
3954        if media.source_id:
3955            player.set_active_mass_source(media.source_id)
3956
3957        # Determine output protocol to use:
3958        # While a session is active (playing/paused), keep using the already active
3959        # protocol so mid-session commands stay on the same output.
3960        # On a fresh start always (re)select: a leftover active protocol from a
3961        # previous session must not overrule user preference, a grouped protocol
3962        # or native playback (and it may point at a player that is gone by now).
3963        target_player: Player | None = None
3964        output_protocol: OutputProtocol | None = None
3965        if (
3966            player.state.playback_state in (PlaybackState.PLAYING, PlaybackState.PAUSED)
3967            and player.active_output_protocol
3968            and player.active_output_protocol != "native"
3969            and (protocol_player := self.get_player(player.active_output_protocol))
3970        ):
3971            # Use the already-set protocol directly
3972            output_protocol = player.get_linked_protocol(player.active_output_protocol)
3973            if output_protocol is not None:
3974                target_player = protocol_player
3975        if target_player is None:
3976            target_player, output_protocol = self._select_best_output_protocol(player)
3977
3978        if target_player.player_id != player.player_id:
3979            # Playing via linked protocol - update active output protocol
3980            # output_protocol is guaranteed to be non-None when target_player != player
3981            assert output_protocol is not None
3982            self.logger.debug(
3983                "Starting playback on %s via protocol %s (target=%s), group_members=%s",
3984                player.state.name,
3985                output_protocol.name,
3986                target_player.display_name,
3987                target_player.state.group_members,
3988            )
3989            player.set_active_output_protocol(output_protocol.output_protocol_id)
3990        elif player.type != PlayerType.GROUP:
3991            # Native playback - group players don't have output protocols of their own
3992            # (they delegate to a sync leader / member which manages its own protocol)
3993            self.logger.debug(
3994                "Starting playback on %s via native, group_members=%s",
3995                player.state.name,
3996                player.state.group_members,
3997            )
3998            player.set_active_output_protocol("native")
3999
4000        # power on the player if needed (skip auto-play since we're about to start playback)
4001        if not player.state.powered and player.state.power_control != PLAYER_CONTROL_NONE:
4002            await self._handle_cmd_power(player.player_id, True, skip_auto_play=True)
4003        await target_player.play_media(media)
4004        if target_player.player_id != player.player_id:
4005            # notify the native player that protocol playback started
4006            assert output_protocol is not None
4007            await player.on_protocol_playback(output_protocol=output_protocol)
4008
4009    async def _handle_enqueue_next_media(self, player_id: str, media: PlayerMedia) -> None:
4010        """
4011        Handle enqueue next media command without group redirect.
4012
4013        Skips permission checks, locking, and all redirect logic (internal use only).
4014
4015        :param player_id: player_id of the player to handle the command.
4016        :param media: The Media that needs to be enqueued on the player.
4017        """
4018        player = self.get_player(player_id, raise_unavailable=True)
4019        assert player is not None
4020        if target_player := self._get_control_target(
4021            player,
4022            required_feature=PlayerFeature.ENQUEUE,
4023            require_active=True,
4024        ):
4025            self.logger.debug(
4026                "Redirecting enqueue command to protocol player %s",
4027                target_player.provider.manifest.name,
4028            )
4029            await target_player.enqueue_next_media(media)
4030            return
4031
4032        if PlayerFeature.ENQUEUE not in player.state.supported_features:
4033            raise UnsupportedFeaturedException(
4034                f"Player {player.state.name} does not support enqueueing"
4035            )
4036        await player.enqueue_next_media(media)
4037
4038    async def _handle_select_source(self, player_id: str, source: str | None) -> None:
4039        """
4040        Handle select source command without group redirect.
4041
4042        Skips permission checks, locking, and all redirect logic (internal use only).
4043
4044        :param player_id: player_id of the player to handle the command.
4045        :param source: The ID of the source that needs to be activated/selected.
4046        """
4047        if source is None:
4048            source = player_id  # default to MA queue source
4049        player = self.get_player(player_id, True)
4050        assert player is not None
4051        # check if player is already playing and source is different
4052        # in that case we need to stop the player first
4053        prev_source = player.state.active_source
4054        if prev_source and source != prev_source:
4055            with suppress(PlayerCommandFailed, RuntimeError):
4056                # just try to stop (regardless of state)
4057                async with self.wait_for_player_update(player_id, timeout=5):
4058                    await self._handle_cmd_stop(player_id)
4059        # check if source is a mass queue
4060        # this can be used to restore the queue after a source switch
4061        if self.mass.player_queues.get(source):
4062            player.set_active_mass_source(source)
4063            return
4064        # Legacy compatibility: the old plugin-source API used the
4065        # plugin's instance_id directly as the source string. The refactor
4066        # moved plugin sources to first-class AudioSource MediaItems played
4067        # via player_queues.play_media. Translate a legacy plugin-instance-id
4068        # source into the new flow so old frontends, third-party scripts,
4069        # and HA automations keep working — but only when the provider
4070        # exposes EXACTLY ONE AudioSource (it was always a 1:1 mapping under
4071        # the old API; multi-source providers have to use the explicit URI).
4072        if (legacy_prov := self.mass.get_provider(source)) and isinstance(
4073            legacy_prov, PluginProvider
4074        ):
4075            if ProviderFeature.AUDIO_SOURCE not in legacy_prov.supported_features:
4076                raise PlayerCommandFailed(f"Provider {source} does not expose AudioSources")
4077            sources = await legacy_prov.get_audio_sources()
4078            if len(sources) == 1:
4079                self.logger.debug(
4080                    "Translating legacy select_source(%s) to play_media(%s)",
4081                    source,
4082                    sources[0].uri,
4083                )
4084                await self.mass.player_queues.play_media(player_id, str(sources[0].uri))
4085                return
4086            raise UnsupportedFeaturedException(
4087                f"Provider {source} exposes {len(sources)} AudioSources; the legacy "
4088                "select_source(plugin_instance_id) API only supported 1:1 mappings. "
4089                "Use player_queues.play_media with an explicit AudioSource URI."
4090            )
4091        # basic check if player supports source selection
4092        if PlayerFeature.SELECT_SOURCE not in player.state.supported_features:
4093            raise UnsupportedFeaturedException(
4094                f"Player {player.state.name} does not support source selection"
4095            )
4096        # basic check if source is valid for player
4097        if not any(x for x in player.state.source_list if x.id == source):
4098            raise PlayerCommandFailed(
4099                f"{source} is an invalid source for player {player.state.name}"
4100            )
4101        # forward to player
4102        await player.select_source(source)
4103
4104    async def _handle_cmd_stop(self, player_id: str) -> None:
4105        """
4106        Handle stop command without any redirects.
4107
4108        Skips permission checks, locking, and all redirect logic (internal use only).
4109
4110        :param player_id: player_id of the player to handle the command.
4111        """
4112        player = self.get_player(player_id, raise_unavailable=True)
4113        assert player is not None
4114        protocol_player: Player | None = None
4115        if player.active_output_protocol and player.active_output_protocol != "native":
4116            protocol_player = self.get_player(player.active_output_protocol)
4117        if player.state.playback_state == PlaybackState.IDLE:
4118            # The player already reports idle but an output protocol is still marked
4119            # active: the protocol player may never have received a stop at all
4120            # (e.g. the source stream ended on its own before this stop command
4121            # arrived). Forward an (idempotent) stop and schedule the protocol clear
4122            # so no stale session lingers on the device and the next playback
4123            # (re)selects the output protocol.
4124            if protocol_player is not None:
4125                await protocol_player.stop()
4126                if len(protocol_player.group_members) <= 1:
4127                    self.schedule_active_output_protocol_clear(player)
4128            return
4129        player.mark_stop_called()
4130        # Delegate to active protocol player if one is active
4131        target_player = player
4132        if protocol_player is not None:
4133            target_player = protocol_player
4134            if PlayerFeature.POWER in target_player.supported_features:
4135                # if protocol player supports/requires power,
4136                # we power it off instead of just stopping (which also stops playback)
4137                # this is rare as most protocols do not support power control (except for cast)
4138                await self._handle_cmd_power(target_player.player_id, False)
4139                return
4140
4141        # handle command on player(protocol) directly
4142        await target_player.stop()
4143        # Only clear active protocol if the protocol player has no remaining group members.
4144        # If there are still protocol group members, keep the protocol active so that
4145        # when playback resumes it continues on the same protocol.
4146        if target_player.player_id == player.player_id or len(target_player.group_members) <= 1:
4147            self.schedule_active_output_protocol_clear(player)
4148
4149    async def _handle_cmd_play(self, player_id: str) -> None:
4150        """
4151        Handle play command without group redirect.
4152
4153        Skips permission checks, locking, and all redirect logic (internal use only).
4154
4155        :param player_id: player_id of the player to handle the command.
4156        """
4157        player = self.get_player(player_id, raise_unavailable=True)
4158        assert player is not None
4159        if player.state.playback_state == PlaybackState.PLAYING:
4160            self.logger.info(
4161                "Ignore PLAY request to player %s: player is already playing", player.state.name
4162            )
4163            return
4164        # If an AudioSource is the active queue item, proxy play to the plugin
4165        if active := self._get_active_audio_source(player):
4166            audio_source, plugin_prov = active
4167            if audio_source.can_play_pause:
4168                await plugin_prov.on_source_control(audio_source.item_id, SourceControl.PLAY)
4169                return
4170        # handle unpause (=play if player is paused)
4171        if player.state.playback_state == PlaybackState.PAUSED:
4172            active_source = next(
4173                (x for x in player.state.source_list if x.id == player.state.active_source), None
4174            )
4175            # raise if active source does not support play/pause
4176            if active_source and not active_source.can_play_pause:
4177                msg = (
4178                    f"The active source ({active_source.name}) on player "
4179                    f"{player.state.name} does not support play/pause"
4180                )
4181                raise PlayerCommandFailed(msg)
4182            # Delegate to active protocol player if one is active
4183            if target_player := self._get_control_target(
4184                player, PlayerFeature.PAUSE, require_active=True
4185            ):
4186                await target_player.play()
4187                return
4188            # No active protocol target: if the player rendering the audio supports pause and
4189            # the active (external) source can be paused, unpause it directly instead of
4190            # restarting the source.
4191            output_player = player.resolve_output_player()
4192            if (
4193                active_source
4194                and active_source.can_play_pause
4195                and PlayerFeature.PAUSE in output_player.supported_features
4196            ):
4197                await output_player.play()
4198                return
4199
4200        # player is not paused: try to resume the player
4201        # Note: We handle resume inline here without calling _handle_cmd_resume
4202        active_source = next(
4203            (x for x in player.state.source_list if x.id == player.state.active_source), None
4204        )
4205        media = player.state.current_media
4206        # power on the player if needed
4207        if not player.state.powered and player.state.power_control != PLAYER_CONTROL_NONE:
4208            await self._handle_cmd_power(player.player_id, True)
4209        if active_source and not active_source.passive:
4210            await self._handle_select_source(player_id, active_source.id)
4211            return
4212        if media:
4213            # try to re-play the current media item
4214            await player.play_media(media)
4215            return
4216        # fallback: just send play command - which will fail if nothing can be played
4217        await player.play()
4218
4219    async def _handle_cmd_pause(self, player_id: str) -> None:
4220        """
4221        Handle pause command without any redirects.
4222
4223        Skips permission checks, locking, and all redirect logic (internal use only).
4224
4225        :param player_id: player_id of the player to handle the command.
4226        """
4227        player = self.get_player(player_id, raise_unavailable=True)
4228        assert player is not None
4229        if player.state.playback_state == PlaybackState.IDLE:
4230            return
4231        # If an AudioSource is the active queue item, proxy pause to the plugin
4232        if active := self._get_active_audio_source(player):
4233            audio_source, plugin_prov = active
4234            if audio_source.can_play_pause:
4235                await plugin_prov.on_source_control(audio_source.item_id, SourceControl.PAUSE)
4236                return
4237        # handle command on player/source directly
4238        active_source = next(
4239            (x for x in player.state.source_list if x.id == player.state.active_source), None
4240        )
4241        if active_source and not active_source.can_play_pause:
4242            # raise if active source does not support play/pause
4243            msg = (
4244                f"The active source ({active_source.name}) on player "
4245                f"{player.state.name} does not support play/pause"
4246            )
4247            raise PlayerCommandFailed(msg)
4248        # Delegate to active protocol player if one is active
4249        if target_player := self._get_control_target(
4250            player, PlayerFeature.PAUSE, require_active=True
4251        ):
4252            await target_player.pause()
4253            return
4254        # No active protocol target: if the player rendering the audio supports pause and the
4255        # active (external) source can be paused, forward the command to it instead of stopping
4256        # it (mirrors the external-source handling in cmd_seek/cmd_next_track).
4257        output_player = player.resolve_output_player()
4258        if (
4259            active_source
4260            and active_source.can_play_pause
4261            and PlayerFeature.PAUSE in output_player.supported_features
4262        ):
4263            await output_player.pause()
4264            return
4265        # player/protocol does not support pause: fall back to stop
4266        self.logger.debug(
4267            "Player/protocol %s does not support pause, using STOP instead",
4268            player.state.name,
4269        )
4270        await self._handle_cmd_stop(player.player_id)
4271