blob: b7f6f722a8eab3fe63ebdf67d769306129037504 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
Copyright 2013 The Android Open Source Project
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.
<!-- Include additional dependencies here.-->
<![CDATA[ This sample is DEPRECATED. ]]>
<!-- The basic templates have already been enabled. Uncomment more as desired. -->
<template src="base-build" />
<template src="base-application" />
This sample is deprecated. See the
[Universal Android Music Player](
sample for a more complete solution for using a MediaSession and MediaBrowserService.
This sample shows how to implement a media app that allows
background playback of audio, and provide a media library
that is exposed to other apps.
1. It allows other apps control media playback externally
using MediaSession. This allows playback to be controlled by
the Google Assistant, for example.
2. It exposes a simple music library through MediaBrowserService.
And it provides MediaSession callbacks. This allows it to be used
by Android Auto, for example.
When not connected to a car, the app has a very simple UI that
allows for playback as well as skip to previous and next tracks.
To learn more about MediaSession and MediaBrowserService, read
this [article on Medium](
that goes into the architectural details of these APIs.
<img src="screenshots/architecture.png" height="400" alt="Architecture Diagram"/>
To implement a MediaBrowserService, you need to:
- Extend MediaBrowserServiceCompat, implementing the media
browsing related methods onGetRoot and onLoadChildren;
- In onCreate, start a new MediaSession and call super.setSessionToken() with
this MediaSession's token;
- Set a MediaSession.Callback class on the MediaSession. The callback class
will receive all the user's actions, like play, pause, etc;
- Handle all the actual music playing using any method your app prefers
(for example, the Android MediaPlayer class)
- Whenever it changes, update info about the playing item and the playing
queue using MediaSession corresponding methods (setMetadata,
setPlaybackState, setQueue, setQueueTitle, etc)
- Handle AudioManager focus change events and react appropriately
(e.g. pause when audio focus is lost)
To make it compatible with Android Auto, you also need to:
- Declare a meta-data tag in AndroidManifest.xml linking to a xml resource
with a automotiveApp root element. For a media app, this must include
an &lt;uses name="media"/&gt; element as a child.
For example, in AndroidManifest.xml:
<meta-data android:name=""
And in res/xml/automotive\_app\_desc.xml:
<?xml version="1.0" encoding="utf-8"?>
<uses name="media"/>
- Declare and export the service in AndroidManifest.xml:
<action android:name="" />