Merge pull request #145 from OzGav/groups

Groups, ESPHome and Sonos changes

docs/faq/groups.md

@@ -12,7 +12,7 @@ See also the section on Announcements [Group Behaviour](../integration/announcem
 
 ## Temporary Sync Group
 
-Temporary Sync Group players are configured via the [Player List](ui.md#player-list) or HA action. They provide a very flexible way to create and destroy Sync Groups as the players can be added or removed at any time. 
+Temporary Sync Group players are configured via the [Player List](ui.md#player-list) or HA action. This type of group provides a very flexible way to create and destroy Sync Groups as the players can be added or removed at any time. 
 
 ### Features
 
@@ -30,38 +30,41 @@ Temporary Sync Group players are configured via the [Player List](ui.md#player-l
 
 ## Sync Groups
 
-These are permanent group players that are configured via the MA settings. These should be used when the make up of the group will rarely change and it is desired that the players will typically all continuously play music. A player cannot be removed from the group if the group is playing although it can be muted (or volume reduced to 0). If there is a need to add or remove additional players then use the dynamic members option or switch to using a manual sync group. At power on/off of the syncgroup the original set of members will be restored.
+These are permanent group players that are configured via the MA settings. These should be used when the make up of the group will rarely change and it is desired that the players will typically all continuously play music. A player cannot be removed from the group if the group is playing although it can be muted (or volume reduced to 0). If there is a need to add or remove additional players then enable the dynamic members option or switch to using a manual sync group. At power on/off of the syncgroup the original set of members will be restored.
 
 ![image](../assets/screenshots/syncgroup.png)
 
-After selecting ADD GROUP PLAYER as shown above, the group configuration screen will appear where the group type must be selected. At least one player must be added to the group before the group can be saved. It is recommended that a custom name be used as the automatically generated name is unique but not memorable.
+After selecting ADD GROUP PLAYER as shown above, the group configuration screen will appear where the group type must be selected. You need to specify a name for the group player. The order that the players are selected when the group is created will be the order that the players are shown when viewing the group in the [Player List](../ui.md#player-list).
 
 !!! tip
     Remember Chromecast devices must be grouped in the Google Home app for perfect sync
 
 ### Features
 
-- The native player types shown (i.e. not the Universal Group option) support perfect sync (this is a requirement to be shown in the list)
+- The native player types shown (i.e. not the Universal Group option) support perfect sync
 - In addition to playing in sync the group will hold the queue regardless of which player(s) in the group are powered off
 
 ### Known Issues / Notes
 
 - As mentioned above the group player holds the queue rather than any individual player. However, if the group leader is lost then playback will stop but the queue can be restarted
 - The group will not power on if one of the child players is synced to another group
 - If, in the group settings, the player friendly name has been replaced by an unusual ID then likely the player was seen by the MA logic as unavailable. Check the individual player status
+- When adding a player to an already playing group, Airplay, Snapcast and Sonos will keep playing but all other types will pause for a very brief period to resync
 
 ## Universal Groups
 
-Music Assistant has support for grouping dissimilar playback devices. Configuration is done in the same manner as described in the Sync Groups section with UNIVERSAL selected as the Group Type. 
+Music Assistant has support for grouping dissimilar playback devices. Configuration is done in the same manner as described in the Sync Groups section with UNIVERSAL selected as the Group Type. These groups also support the dynamic member option.
 
 ### Features
 
-All devices can be grouped but not all will play in sync. See the individual player providers page for any specific limitations.
+- All devices can be grouped and will play the same audio but will not play the audio in sync. Use this playertype only for players that are not in close range to eachother.
+- See the individual player providers page for any specific limitations
 
 ### Known Issues / Notes
 
 - This type of group should be avoided if a [Sync Group or Native Group](../ui.md#grouping-players) can be used
 - Universal Groups can include sync groups but not other universal groups
+- When adding a player to an already playing group, MA will try and join seamlessly but there may be a slight pause with some player types
 - The group will not power on if one of the child players is synced to another group
 - The group will power on if one or more of the child players is unavailable
 - If, in the group settings, the player friendly name has been replaced by an unusual ID then likely the player was seen by the MA logic as unavailable. Check the individual player status

docs/player-support/ha.md

@@ -1,3 +1,8 @@
+---
+title: Player Support - Home Assistant Players
+description: Features of, and instructions for, the use of HA media player entitities in Music Assistant
+---
+
 # Home Assistant ![Preview image](../assets/icons/ha-logo.png){ width=70 align=right }
 
 Music Assistant has support for playing to media player entities in Home Assistant.
@@ -8,6 +13,7 @@ Music Assistant has support for playing to media player entities in Home Assista
 ## Features
 
 - All media player entities that are available in HA, for which there is no dedicated MA provider, will be available in MA
+- All media player types that can be grouped in HA can be grouped in MA via the [Player List](../ui.md#player-list) or HA action
 
 ## Known Issues / Notes
 
@@ -18,4 +24,4 @@ Music Assistant has support for playing to media player entities in Home Assista
 - Synchronisation between this player type and any others is not possible
 - In order to support a greater number of players, different streaming profiles are available. If the player doesn't work, stops mid stream or has other playback issues then change the player setting `HTTP Profile used for sending audio` and try each option until the player works
 - If there is no metadata sent to the player then you can trying enabling the option `Try to ingest metadata into stream`
-- ESPHome based Media Players are in general not recommended for playback of music. Short audio announcements and maybe even webradio could work but it is really not suitable for playing music from Music Assistant. TIP: you may have to enable the "fixed content length" HTTP profile in the player's settings. The ESPHome is working on an improved media player which can be used on ESP32 modules with PSRAM, which will work correctly with Music Assistant.  
+- ESPHome based Media Players are in general not recommended for playback of music. Short audio announcements or possibly webradio could work but it is really not suitable for playing music from MA. TIP: you may have to enable the "fixed content length" HTTP profile in the player's settings. Having said that, more powerful ESPHome based players such as the HA Voice PE work well, support FLAC and have some other optimisations.

docs/player-support/sonos.md

@@ -6,7 +6,7 @@ Music Assistant has support for Sonos devices. There are two providers available
 
 - Sonos devices are auto detected by Music Assistant
 - Sonos devices from the same series (S1 or S2) will play in sync when grouped
-- Sonos devices can optionally be grouped with AirPlay devices. 
+- Sonos devices can optionally be grouped with AirPlay devices
 
 ### AirPlay Functionality
 
@@ -28,4 +28,5 @@ If the `Enable Airplay` option is then selected, the playback command(s) will be
 - Issues have been reported with the Sonos Arc and Unifi networking equipment. Ensure Multicast DNS and IGMP snooping are turned on if you have problems
 - S1 and S2 devices cannot be grouped together in the same Sync Group. S1 and S2 devices can be grouped via a Universal Group but will not play in sync
 - Using the Sonos HA Integration at the same time as the MA Sonos S1 player provider may cause problems. It is not possible to run the HA provider and Sonos S1 provider on the same host and additionally these speakers do not like too many requests from too many sources. It is therefore recommended to only use the MA Sonos S1 player provider
-- Sonos has removed AirPlay (1) support from the following models: ERA 100, ERA 300, Move 2 and Arc Ultra. As such, AirPlay streaming (from Music Assistant) to these devices is not possible
+- Syncing Sonos devices with Airplay devices requires the enabling of an option on the Sonos player
+- Sonos has removed AirPlay (1) support from the following models: ERA 100, ERA 300, Move 2 and Arc Ultra. As such, AirPlay streaming (from Music Assistant) to these devices is not possible