Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-add transfer queue action plus minor edits #36054

Open
wants to merge 5 commits into
base: next
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions source/_integrations/music_assistant.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ha_zeroconf: true
ha_integration_type: integration
---

The **Music Assistant**(MA) {% term integrations %} allows you to connect Home Assistant to a [Music Assistant Server](https://music-assistant.io/). Once configured, all [MA Players](https://music-assistant.io/player-support/) show up as Home Assistant [media player entities](/integrations/media_player/). Media players will allow you to control media playback and see the currently playing item.
The **Music Assistant** (MA) {% term integration %} allows you to connect Home Assistant to a [Music Assistant Server](https://music-assistant.io/). Once configured, all [MA Players](https://music-assistant.io/player-support/) show up as Home Assistant [media player entities](/integrations/media_player/). Media players will allow you to control media playback and see the currently playing item.

There is currently support for the following Home Assistant Platforms:

Expand All @@ -27,11 +27,11 @@ All of the Home Assistant [Media Player Control Actions](https://www.home-assist

### Manual configuration

Under normal circumstances, Home Assistant automatically discovers your running Music Assistant Server. If something special about the HA or MA setup (for example, the MA server is running as a remote Docker container) or discovery is not working, you can manually specify the URL to your Music Assistant server.
Under normal circumstances, Home Assistant automatically discovers your running Music Assistant Server. If there is something special about the HA or MA setup (for example, the MA server is running as a remote Docker container) or discovery is not working, you can manually specify the URL to your Music Assistant server. If the Music Assistant Server is not installed then follow these [installation instructions](https://music-assistant.io/installation/).

## Media player

The Music Assistant media player creates media player entities for all players available in MA including those imported from Home Assistant. This is needed to provide the full functionality Music Assistant has to offer. These entities will display media information, playback progress, and playback controls.
The Music Assistant integration creates media player entities for all players available in MA including those imported from Home Assistant. This is needed to provide the full functionality Music Assistant has to offer. These entities will display media information, playback progress, and playback controls.

### Action `media_player.play_media`

Expand Down Expand Up @@ -85,11 +85,11 @@ Play media on a Music Assistant player with more fine-grained control options.
- **Example**: `playlist`
- **Data attribute**: `artist`
- **Optional**: Yes.
- **Description**: When specifying a track or album in the Media ID field, you can optionally restrict results by this artist name.
- **Description**: When specifying a track or album by name in the Media ID field, you can optionally restrict results by this artist name.
- **Example**: `Queen`
- **Data attribute**: `album`
- **Optional**: Yes.
- **Description**: When specifying a track in the Media ID field, you can optionally restrict results by this album name.
- **Description**: When specifying a track by name in the Media ID field, you can optionally restrict results by this album name.
- **Example**: `News of the world`
- **Data attribute**: `enqueue`
- **Optional**: Yes.
Expand Down Expand Up @@ -122,6 +122,19 @@ Play announcement on a Music Assistant player with more fine-grained control opt
- **Description**: Use a forced volume level for the announcement. Omit to use the player default.
- **Example**: `75`

### Action `music_assistant.transfer_queue`

Transfer the player's queue to another player.

- **Data attribute**: `source_player`
- **Optional**: Yes.
- **Description**: The source media player which has the queue to be transferred. When omitted, the first playing player will be used.
- **Example**: `media_player.kitchen_speaker`
- **Data attribute**: `auto_play`
- **Optional**: Yes.
- **Description**: Start playing the queue on the target player. Omit to use the default behavior.
- **Example**: `true`

## Notes

- Any Home Assistant players added to Music Assistant will appear duplicated as the MA version of the player is created. The original HA player can be hidden if desired.