Merge pull request #44 from OzGav/main

Changes as a result of the integration update

docs/faq/massannounce.md

@@ -0,0 +1,17 @@
+# MA play_announcement Service Call
+
+This service call allows you to send audio announcements via a URL to a player. The URL could be accessed in a variety of ways. For example:
+- External such as `https://www.soundjay.com/door/doorbell-5.mp3` 
+- Using [Home Assistant](https://www.home-assistant.io/integrations/http/#hosting-files) you can add the sound files under your `www` folder and access them like this `http://192.168.1.165:8123/local/audio/Apartment-door-chime-melody.mp3`
+- You could [run your own webserver](https://www.instructables.com/Set-up-your-very-own-Web-server/)
+
+![image](../assets/screenshots/service-call/play_announcement.png)
+
+!!! note
+    For sending text messages use the HA TTS service calls and target the MA media player entity
+```
+    service: tts.google_say
+      data:
+        entity_id: media_player.ma_kitchen_speaker
+        message: This is a test
+```

docs/faq/massplaymedia.md

@@ -29,7 +29,7 @@ Or a list of uris which can even be from different music providers
 !!! note
     The regular `media_player.play_media` service call also accepts all of the above but it cannot take multiple items
 
-There are additional options as well. These will appear when an entity that supports them is selected.
+There are additional options as well. Enqueue will appear when an entity that supports it is selected.
 
 ![image](../assets/screenshots/service-call/play7.png)
 

docs/index.md

@@ -15,7 +15,7 @@ Music Assistant is a music library manager for your offline and online music sou
 - Playback synchronisation is possible for supported players
 - Announcements during playback supported 
 - Truly hassle free streaming of your favourite music to players, no advanced knowledge required
-- Rich User interface (Progressive Web App) powered by VueJS 3
+- Rich User interface (Progressive Web App) powered by ![logo](assets/icons/vue-js-logo.png){width=10 }VueJS 3
 
 [![Music Assistant Add-on For Home Assistant](https://my.home-assistant.io/badges/supervisor_addon.svg)](https://my.home-assistant.io/redirect/supervisor_addon/?addon=d5369777_music_assistant_beta&repository_url=https%3A%2F%2Fgithub.com%2Fmusic-assistant%2Fhome-assistant-addon)
 

docs/installation.md

@@ -6,21 +6,21 @@ Music Assistant (MA) can be operated as a complete standalone product but it is
 
 MA requires a 64bit Operating System and a minimum of 2GB of RAM on the physical device or the container (physical devices are recommended to have 4GB+ if they are running anything else)
 
-## Primary installation method: Home Assistant Integration Installation
-
-Using [HAOS](https://developers.home-assistant.io/docs/operating-system/). Go to the [Home Assistant Integration](integration/installation.md) page and follow the instructions there which will install the integration and the server (as an addon).
-
-[![Add Music Assistant as Add-on to Home Assistant.](https://my.home-assistant.io/badges/supervisor_addon.svg)](https://my.home-assistant.io/redirect/supervisor_addon/?addon=d5369777_music_assistant&repository_url=https%3A%2F%2Fgithub.com%2Fmusic-assistant%2Fhome-assistant-addon)
-
-## Secondary installation method: Home Assistant Add-on Manual Installation
+## Primary installation method: Home Assistant Add-on Manual Installation
 
 Using [HAOS](https://developers.home-assistant.io/docs/operating-system/). If you dont need the HA Integration but want to run the Music Assistant Server then install the Music Assistant Add-on manually:
 
 1. Add the Music Assistant repository to your Home Assistant instance.
-2. Install the Music Assistant add-on.
 
 [![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fmusic-assistant%2Fhome-assistant-addon)
 
+2. Install the Music Assistant add-on.
+
+[![Add Music Assistant as Add-on to Home Assistant.](https://my.home-assistant.io/badges/supervisor_addon.svg)](https://my.home-assistant.io/redirect/supervisor_addon/?addon=d5369777_music_assistant&repository_url=https%3A%2F%2Fgithub.com%2Fmusic-assistant%2Fhome-assistant-addon)
+
+## Secondary installation method: Home Assistant Integration Installation
+
+Using [HAOS](https://developers.home-assistant.io/docs/operating-system/). Go to the [Home Assistant Integration](integration/installation.md) page and follow the instructions there which will install the integration and the server (as an addon).
 
 ## Tertiary installation method: Docker image
 

docs/music-providers/index.md

@@ -8,6 +8,7 @@ General Notes:
 - If you remove a provider a cleanup of the database will be done but it takes a little time to complete. If you still see entries from a deleted provider after some time, then try a MA restart to retrigger the cleanup process.
 - Music providers are added by navigating to MA Settings and then clicking on ADD MUSIC PROVIDER at the top of the page
 
-!!! tip "Note" - Depending up on the sequence of adding providers the automatic linking process may need to be initiated again. If what appears to be identical albums or tracks are seen then navigate to the album or track and using the ⋮ menu in the banner at the top of the view select "Refresh Item". This will trigger the linking process and should result in the same albums and tracks being collapsed together.
+!!! tip "Note" 
+    If a problem occurs the automatic linking process may need to be initiated again. If what appears to be identical albums or tracks are seen then navigate to the album or track and using the ⋮ menu in the banner at the top of the view select "Refresh Item". This will trigger the linking process and should result in the same albums and tracks being collapsed together. Submit an issue report if this is required so that it can be investigated.
 
-![image](../assets/screenshots/add-music-provider.png){ width=400  }
+![image](../assets/screenshots/add-music-provider.png)

docs/music-providers/url.md

@@ -8,14 +8,11 @@ Music Assistant has support for manually adding radio station URLs to the databa
 
 ## Usage
 
-The URL provider is enabled by default.
-
-1. In the left hand menu you need to select 'Radio'
-2. Then click on the ⋮ in the top right corner
+1. In the left hand menu select 'Radio'
+2. Then click on the icon in the top right corner
 
     ![screenshot](../assets/screenshots/url.png)
 
-3. Then click on ADD ITEM FROM URL
-4. Add the full URL including http:// or https:// 
+3. Add the full URL including http:// or https:// 
 
-After completing step 4 the station will become available in the Radio view
+After completing step 3 the station will become available in the Radio view

docs/player-support/universal.md

@@ -7,11 +7,11 @@ Music Assistant has support for grouping playback devices.
 All devices (except Chromecast) can be grouped but not all will play in sync. See the individual players for their limitations.
 
 !!! tip
-    Reminder chromecast devices must be grouped in the Google Home app for perfect sync
+    Reminder Chromecast devices must be grouped in the Google Home app for perfect sync
 
 ![image](../assets/screenshots/universal-group.png)
 
 ## Known Issues / Notes
 
-UGP is on best-effort basis and might not work correctly with all player models or give unexpected results. For best reaults use standalone or syncgroup playback as [explained here](../ui.md/#grouping-players)
+UGP is on best-effort basis and might not work correctly with all player models or give unexpected results. For best results use standalone or syncgroup playback as [explained here](../ui.md/#grouping-players)
 

docs/ui.md

@@ -4,9 +4,22 @@
 
 ![image](assets/screenshots/UI-main-menu.png)
 
+This menu's appearance can be configured in the settings. It can be placed vertically (as shown) on the left or horizontally at the bottom. Any of the icons can be hidden. If the settings icon is hidden from this menu it is available in the top right of the HOME screen.
+
+!!! warning
+    If you remove both the Home and Settings icons then you will be locked out. In that case you will need to manually enter the path or clear the browser cookies to regain access to the settings page.
+
 When visiting Browse you will only see what is already in the Library of the Streaming Providers. For the local Providers you will see all files and if a folder is visited that is not already in the MA Library it will be automatically added even if it has been previously removed.
 ***************************************************************
 
+## Global Search
+![image](assets/screenshots/global-search.png)
+
+Searches can be done via any combinbination of words or partial words and also via a URL to a provider such as `https://open.spotify.com/album/0BwWUstDMUbgq2NYONRqlu` 
+
+Results are returned in the six categories of Top Results, Tracks, Artists, Albums, Playlists and Radio. Context sensitive menus are available for the various items.
+***************************************************************
+
 ## Player Bar
 ![image](assets/screenshots/UI-playercontrols-bar.png)
 
@@ -15,7 +28,8 @@ The codec shown in the UI to the right of the track title is the codec of the or
 
 ## Now Playing View
 ![image](assets/screenshots/now-playing-view.png)
-
+
+This view will change depending on screen width. With wider displays you will be able to see the track that is playing (and associated information) as well as the queue. With narrow displays you need to use the toggle in the bottom right to switch between the currently playing information and the queue. Adjustments to the queue can be done with the ⋮ menu on the right.
 ***************************************************************
 
 ## Player List
@@ -29,7 +43,6 @@ When a player group is powered on the members of that group will disappear from
 
 !!! note
     The MDI icon shown against each player can be changed in the player settings.
-
 ***************************************************************
 
 ## Grouping Players
@@ -46,22 +59,21 @@ There are three ways to group players
     ![image](assets/screenshots/syncgroup.png)
 
 3.   Create a [Universal Group](player-support/universal.md)
-
 ***************************************************************
 
 ## Artist / Album / Track View
 
 ![image](assets/screenshots/UI-artist-view.png)
 
-Album and Track Views look the same as the above except there is no album artist filter icon but there is an additional view specific menu item
+Album and Track Views look the same as the above except there is no album artist filter icon
 
 A red dot on the search icon ![image](assets/icons/search-icon.png)
 indicates that the viewed results are subject to filtering by search. This is useful if the search box has been closed.
 
 A red dot on the refresh icon ![image](assets/icons/refresh-icon.png)
 indicates that the viewed results have some sort of update pending. Press the refresh button.
 
-Items in all views can be "right clicked" or "long pressed" to bring up an extensive menu of options. See an example below in the [Track Menu](ui.md#track-menu) section
+Items in all views can be "right clicked" or "long pressed" to bring up an extensive menu of options which is the same as that accessed by the ⋮ menu on the right. In the image above the complete list of possibilities is shown and this will vary slightly depending on the current view.
 
 Multiple selections of albums / artists / tracks is possible by clicking the multi-select icon. Once one or more items are selected then clicking on the "ACTIONS" at the bottom
 
@@ -72,7 +84,6 @@ will bring up this menu
 ![image](assets/screenshots/UI-actions-menu.png)
 
 The behaviour described above will work on any view where you see the "x item(s) selected" text.
-
 ***************************************************************
 
 ## Individual Artist View
@@ -82,7 +93,6 @@ The behaviour described above will work on any view where you see the "x item(s)
 The tracks and albums sections are collapsible. The view above shows them both collapsed. The tracks section shows ALL tracks that are in the library or that are available across all of the providers. A red dot on the library icon ![image](assets/icons/library-icon.png) indicates that the viewed results are filtered to only show items that are in the library. To see what albums any given track is on you can either sort alphabetically or click on one and use the context menu and SHOW INFO. 
 
 The PROVIDER DETAILS section shows from where the albums and tracks listed above were obtained. It is normal to have multiple entries here if an artist has aliases or there are variant spellings, use of punctuation etc.  The ID shown against the streaming provider may be used in automations and scripts.
-
 ***************************************************************
 
 ## Track Menu
@@ -94,7 +104,6 @@ Right click or long press on a track to get the following
 If the provider supports it you will also see the START RADIO option. This will populate the queue with tracks based on the selected track. The tracks are selected by the provider not MA. 
 
 ![image](assets/screenshots/UI-start-radio.jpeg)
-
 ***************************************************************
 
 ## Track "Show Info" View

docs/usage.md

@@ -17,20 +17,18 @@ As a further means of filtering the library, items can be marked as a "favourite
 
 ## The Queue
 
-Each player has its own queue. Viewing the queue is done by pressing the :material-playlist-play: button. This button can be found on the control bar at the bottom of the UI or for narrow displays in the NOW PLAYING view.
+Each player has its own queue. Viewing the queue is done by pressing the :material-playlist-play: button. This button can be found on the player bar at the bottom of the UI or for narrow displays in the NOW PLAYING view.
 
-Depending upon screen resolution the PLAYED ITEMS option may or may not be visible. If it is then selecting that will show the previous items from the queue and selecting any will restart the queue from that point.
+Selecting the PLAYED ITEMS option will show the previous items from the queue and selecting any will show a menu and this will allow a restart of the queue from that point.
 
 ![Preview image](assets/screenshots/queue1.png)
 
+A menu of options to control the queue is available for each upcoming track and is shown in the image above.
+
 !!! note
     What happens to the queue when the different types of items (e.g. album, artist, playlist etc) are added to it is configurable in MA SETTINGS>>CORE>>PLAYER QUEUES CONTROLLER
 
-Right clicking or long press on a track in the queue will show this menu
-
-![Preview image](assets/screenshots/queue2.png)
-
-The options in the menu in the top right is shown below. This is the only place crossfade can be enabled or disabled (crossfade duration is set in the player settings). Repeat and Shuffle have buttons at the bottom in the control bar (or in the NOW PLAYING view for narrow mobile devices).
+The options in the menu available in the top right is shown below. Repeat and Shuffle also have buttons at the bottom in the player bar (or in the NOW PLAYING view for narrow mobile devices).
 
 ![Preview image](assets/screenshots/queue3.png)
 
@@ -41,10 +39,14 @@ The options in the menu in the top right is shown below. This is the only place
 
 Playlists must be stored on a provider. A music provider's playlist can only contain tracks from that provider. However, MA has a built-in provider with the ability to create playlists that have tracks from multiple music providers. In this case the playlist will be stored solely within the MA database. These options are automtically presented in the Add to Playlist dialog.
 
+Playlists can be created or added to from various menus in the different views. They can also be created in the Playlist view by clicking on the icon in the top right.
+
+![Preview image](assets/screenshots/playlist-create.png)
+
 Playlists which consist of tracks from the filesystem provider will be stored in the MA database.
 
-User created playlists from streaming providers will be imported into the MA database and will remain synchronised regardless of whether changes are made from the MA UI or from the streaming providers native applicatons.
+User created playlists from streaming providers will be imported into the MA database and will remain synchronised regardless of whether changes are made from the MA UI or from the streaming provider's native applicatons.
 
 Automatically generated playlists from streaming providers may be supported. See the specific provider documentation for further information.
 
-MA automatically generates some dynamic playlists. These playlists will be updated when they are viewed or played.
+MA automatically generates some dynamic playlists. These playlists will be updated at the sync interval set in MA SETTINGS>>CORE>>MUSIC CONTROLLER or they can be updated manually by navigating to the playlist and then the ⋮ menu in the top right and selecting REFRESH ITEM.

mkdocs.yml

@@ -11,6 +11,7 @@ nav:
     - integration/index.md
     - Installation: integration/installation.md
     - Play Media Service Call: faq/massplaymedia.md
+    - Play Announcement Service Call: faq/massannounce.md
     - Search Service Call: faq/masssearch.md
   - Companion App: companion-app.md
   - Usage: