-
-
Notifications
You must be signed in to change notification settings - Fork 435
Add documentation for Android Media Controls feature #1304
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
Open
FletcherD
wants to merge
1
commit into
home-assistant:master
Choose a base branch
from
FletcherD:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| title: "Android Media Controls" | ||
| id: 'android-media-controls' | ||
| --- | ||
|
|
||
|  <span class='beta'>BETA</span> | ||
|
|
||
| The Android app can show your Home Assistant `media_player` entities as native media controls in the notification shade — the same interface used by apps like Spotify or YouTube Music. This lets you control playback (play, pause, skip track, seek) directly from the notification shade without opening the app. | ||
|
|
||
| ## Supported actions | ||
|
|
||
| The media control supports the following actions, depending on what the `media_player` entity supports: | ||
|
|
||
| - **Play/pause** — start or pause playback | ||
| - **Next/previous track** — skip to the next or previous track | ||
| - **Seek** — scrub to a specific position in the current track | ||
| - **Progress bar** — shows playback progress, even for entities that don't support seeking | ||
| - **Album art** — displays the current media's artwork | ||
|
|
||
| ## Setup | ||
|
|
||
| 1. In the Home Assistant app, go to **Settings** > **Companion App** > **Media controls**. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We could make a deeplink to that. @jpelgrom did we consider doing deeplinks to settings? |
||
| 2. If you have multiple servers, select a server. | ||
| 3. Select a `media_player` entity from the list. | ||
| 4. Tap **Save**. | ||
| 5. Start playing media on the selected entity. A media control will appear in the notification shade. | ||
|
|
||
| ## Removing the media control | ||
|
|
||
| To remove the media control, go to **Settings** > **Companion App** > **Media controls** and tap **Clear**. This stops the background service and removes the notification. | ||
|
|
||
| ## Notes and limitations | ||
|
|
||
| - Only one `media_player` entity can be configured at a time. | ||
| - The media control appears in the notification shade only when the entity has an active playback state (playing, paused, or buffering). | ||
| - After a device reboot, the media control restarts when the app is next opened. | ||
| - This feature is available on both `full` and `minimal` [app flavors](../core/android-flavors.md). | ||
| - Media session notifications do not require notification permissions on Android 13 and later. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you mean by
even for entities that don't support seeking