Android 媒体播放框架MediaSession分析与实践
版权声明：本文为博主原创文章，未经博主容许不得转载
源码：AnliaLee/BauzMusic
你们要是看到有错误的地方或者有啥好的建议，欢迎留言评论html
前言
最近一直在忙着学习和研究音乐播放器，发现介绍MediaSession框架的资料很是少，更多的是一些源码和开源库，这对于初学者来讲不是很友好，可能看着看着就绕晕了，遂博主决定动手写点这方面的博客分享给你们java
参考资料
googlesamples/android-UniversalMusicPlayer
Media Apps Overview（有前辈翻译后的版本Android媒体应用（一））android
MediaSession框架简介
咱们先来看看如何设计一款音乐播放App的架构，传统的作法是这样的：git
- 注册一个Service，用于异步获取音乐库数据、音乐控制等，在Service中咱们可能还须要自定义一些状态值和回调接口用于流程控制
- 经过广播（其余方式如接口、Messenger均可以）实现Activity和Service之间的通讯，使得用户能够经过界面上的组件控制音乐的播放、暂停、拖动进度条等操做
若是咱们的音乐播放器还须要支持通知栏快捷控制音乐播放的功能，那么又得新增一套广播和相应的接口去响应通知栏按钮的事件github
若是还须要支持多端（电视、手表、耳机等）控制同一个播放器，那么整个系统架构可能会变得很是复杂，咱们要花费大量的时间和精力去设计、优化代码的结构。那么有什么方法能够节省这些工做，提升咱们的效率，而后还能够优雅地实现上述这些功能呢？浏览器
Google在Android 5.0中加入了MediaSession框架（在support-v4中一样提供了相应的兼容包，相关的类以Compat结尾，Api基本相同），专门用来解决媒体播放时界面和Service通信的问题，意在规范上述这些功能的流程。使用这个框架咱们能够减小一些流程复杂的开发工做，例如使用各类广播来控制播放器，并且其代码可读性、结构耦合度方面都控制得很是好，所以推荐你们尝试下这个框架。下面咱们就开始介绍MediaSession框架的核心成员和使用流程bash
MediaSession框架的使用
经常使用成员类概述
MediaSession框架中有四个经常使用的成员类，它们是整个流程控制的核心网络
-
MediaBrowser
媒体浏览器，用来链接MediaBrowserService和订阅数据，经过它的回调接口咱们能够获取和Service的链接状态以及获取在Service中异步获取的音乐库数据。媒体浏览器通常建立于客户端（能够理解为各个终端负责控制音乐播放的界面）中session -
MediaBrowserService
浏览器服务，提供onGetRoot（控制客户端媒体浏览器的链接请求，经过返回值决定是否容许该客户端链接服务）和onLoadChildren（媒体浏览器向Service发送数据订阅时调用，通常在这执行异步获取数据的操做，最后将数据发送至媒体浏览器的回调接口中）这两个抽象方法
同时MediaBrowserService还做为承载媒体播放器（如MediaPlayer、ExoPlayer等）和MediaSession的容器架构 -
MediaSession
媒体会话，即受控端，经过设置MediaSessionCompat.Callback回调来接收媒体控制器MediaController发送的指令，当收到指令时会触发Callback中各个指令对应的回调方法（回调方法中会执行播放器相应的操做，如播放、暂停等）。Session通常在Service.onCreate方法中建立，最后需调用setSessionToken方法设置用于和控制器配对的令牌并通知浏览器链接服务成功 -
MediaController
媒体控制器，在客户端中开发者不只可使用控制器向Service中的受控端发送指令，还能够经过设置MediaControllerCompat.Callback回调方法接收受控端的状态，从而根据相应的状态刷新界面UI。MediaController的建立须要受控端的配对令牌，所以需在浏览器成功链接服务的回调执行建立的操做
经过上述的简介中咱们不难看出这四个成员之间有着很是明确的分工和做用范围，使得整个代码结构变得清晰易读。能够经过下面这张图来简单概括它们之间的关系
除此以外，MediaSession框架中还有一些一样重要的类须要拿出来说，例如封装了各类播放状态的PlaybackState，和Map类似经过键值对保存媒体信息的MediaMetadata，以及用于MediaBrowser和MediaBrowserService之间进行数据交互的MediaItem等等，下面咱们经过实现一个简单的demo来具体分析这套框架的工做流程
使用MediaSession框架构建简单的音乐播放器
例如咱们的demo是这样的（见下图），只提供简单的播放暂停操做，音乐数据源从raw资源文件夹中获取
按照工做流程，咱们就从获取音乐库数据开始吧。首先界面上方添加一个RecyclerView来展现获取的音乐列表，咱们在DemoActivity中完成一些RecyclerView的初始化操做
public class DemoActivity extends AppCompatActivity {
private RecyclerView recyclerView;
private List<MediaBrowserCompat.MediaItem> list;
private DemoAdapter demoAdapter;
private LinearLayoutManager layoutManager;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_demo);
list = new ArrayList<>();
layoutManager = new LinearLayoutManager(this);
layoutManager.setOrientation(LinearLayoutManager.VERTICAL);
demoAdapter = new DemoAdapter(this,list);
recyclerView = (RecyclerView) findViewById(R.id.recyclerView);
recyclerView.setLayoutManager(layoutManager);
recyclerView.setAdapter(demoAdapter);
}
}
复制代码
注意List元素的类型为MediaBrowserCompat.MediaItem，由于MediaBrowser从服务中获取的每一首音乐都会封装成MediaItem对象。接下来咱们建立MediaBrowser，并执行链接服务端和订阅数据的操做
public class DemoActivity extends AppCompatActivity {
...
private MediaBrowserCompat mBrowser;
@Override
protected void onCreate(Bundle savedInstanceState) {
...
mBrowser = new MediaBrowserCompat(
this,
new ComponentName(this, MusicService.class),//绑定浏览器服务
BrowserConnectionCallback,//设置链接回调
null
);
}
@Override
protected void onStart() {
super.onStart();
//Browser发送链接请求
mBrowser.connect();
}
@Override
protected void onStop() {
super.onStop();
mBrowser.disconnect();
}
/** * 链接状态的回调接口，链接成功时会调用onConnected()方法 */
private MediaBrowserCompat.ConnectionCallback BrowserConnectionCallback =
new MediaBrowserCompat.ConnectionCallback(){
@Override
public void onConnected() {
Log.e(TAG,"onConnected------");
//必须在确保链接成功的前提下执行订阅的操做
if (mBrowser.isConnected()) {
//mediaId即为MediaBrowserService.onGetRoot的返回值
//若Service容许客户端链接，则返回结果不为null，其值为数据内容层次结构的根ID
//若拒绝链接，则返回null
String mediaId = mBrowser.getRoot();
//Browser经过订阅的方式向Service请求数据，发起订阅请求须要两个参数，其一为mediaId
//而若是该mediaId已经被其余Browser实例订阅，则须要在订阅以前取消mediaId的订阅者
//虽然订阅一个 已被订阅的mediaId 时会取代原Browser的订阅回调，但却没法触发onChildrenLoaded回调
//ps：虽然基本的概念是这样的，可是Google在官方demo中有这么一段注释...
// This is temporary: A bug is being fixed that will make subscribe
// consistently call onChildrenLoaded initially, no matter if it is replacing an existing
// subscriber or not. Currently this only happens if the mediaID has no previous
// subscriber or if the media content changes on the service side, so we need to
// unsubscribe first.
//大概的意思就是如今这里还有BUG，即只要发送订阅请求就会触发onChildrenLoaded回调
//因此不管怎样咱们发起订阅请求以前都须要先取消订阅
mBrowser.unsubscribe(mediaId);
//以前说到订阅的方法还须要一个参数，即设置订阅回调SubscriptionCallback
//当Service获取数据后会将数据发送回来，此时会触发SubscriptionCallback.onChildrenLoaded回调
mBrowser.subscribe(mediaId, BrowserSubscriptionCallback);
}
}
@Override
public void onConnectionFailed() {
Log.e(TAG,"链接失败！");
}
};
/** * 向媒体浏览器服务(MediaBrowserService)发起数据订阅请求的回调接口 */
private final MediaBrowserCompat.SubscriptionCallback BrowserSubscriptionCallback =
new MediaBrowserCompat.SubscriptionCallback(){
@Override
public void onChildrenLoaded(@NonNull String parentId, @NonNull List<MediaBrowserCompat.MediaItem> children) {
Log.e(TAG,"onChildrenLoaded------");
//children 即为Service发送回来的媒体数据集合
for (MediaBrowserCompat.MediaItem item:children){
Log.e(TAG,item.getDescription().getTitle().toString());
list.add(item);
}
//在onChildrenLoaded能够执行刷新列表UI的操做
demoAdapter.notifyDataSetChanged();
}
};
}
复制代码
经过上述的代码和注释你们应该清楚MediaBrowser从链接服务到向其订阅数据的流程了，简单总结一下就是
connect → onConnected → subscribe → onChildrenLoaded
复制代码
那么Service端那边在这段流程中又作了什么呢？首先咱们得继承MediaBrowserService（这里使用了support-v4包的类）建立MusicService类。MediaBrowserService继承自Service，因此记得在AndroidManifest.xml中完成配置
<service android:name=".demo.MusicService">
<intent-filter>
<action android:name="android.media.browse.MediaBrowserService" />
</intent-filter>
</service>
复制代码
咱们须要在Service初始化的时候就完成MediaSession的构建，并为它设置相应的标志、状态等，具体的代码以下
public class MusicService extends MediaBrowserServiceCompat {
private MediaSessionCompat mSession;
private PlaybackStateCompat mPlaybackState;
@Override
public void onCreate() {
super.onCreate();
mPlaybackState = new PlaybackStateCompat.Builder()
.setState(PlaybackStateCompat.STATE_NONE,0,1.0f)
.build();
mSession = new MediaSessionCompat(this,"MusicService");
mSession.setCallback(SessionCallback);//设置回调
mSession.setFlags(MediaSessionCompat.FLAG_HANDLES_TRANSPORT_CONTROLS);
mSession.setPlaybackState(mPlaybackState);
//设置token后会触发MediaBrowserCompat.ConnectionCallback的回调方法
//表示MediaBrowser与MediaBrowserService链接成功
setSessionToken(mSession.getSessionToken());
}
}
复制代码
这里解释下其中的一些细节，首先是调用MediaSession.setFlag为Session设置标志位，以便Session接收控制器的指令。而后是播放状态的设置，需调用MediaSession.setPlaybackState，那么PlaybackState又是什么呢？以前咱们简单介绍过它是封装了各类播放状态的类，咱们能够经过判断当前播放状态来控制各个成员的行为，而PlaybackState类为咱们定义了各类状态的规范。此外咱们还须要设置SessionCallback回调，当客户端使用控制器发送指令时，就会触发这些回调方法，从而达到控制播放器的目的
public class MusicService extends MediaBrowserServiceCompat {
...
private MediaPlayer mMediaPlayer;
@Override
public void onCreate() {
...
mMediaPlayer = new MediaPlayer();
mMediaPlayer.setOnPreparedListener(PreparedListener);
mMediaPlayer.setOnCompletionListener(CompletionListener);
}
/** * 响应控制器指令的回调 */
private android.support.v4.media.session.MediaSessionCompat.Callback SessionCallback = new MediaSessionCompat.Callback(){
/** * 响应MediaController.getTransportControls().play */
@Override
public void onPlay() {
Log.e(TAG,"onPlay");
if(mPlaybackState.getState() == PlaybackStateCompat.STATE_PAUSED){
mMediaPlayer.start();
mPlaybackState = new PlaybackStateCompat.Builder()
.setState(PlaybackStateCompat.STATE_PLAYING,0,1.0f)
.build();
mSession.setPlaybackState(mPlaybackState);
}
}
/** * 响应MediaController.getTransportControls().onPause */
@Override
public void onPause() {
Log.e(TAG,"onPause");
if(mPlaybackState.getState() == PlaybackStateCompat.STATE_PLAYING){
mMediaPlayer.pause();
mPlaybackState = new PlaybackStateCompat.Builder()
.setState(PlaybackStateCompat.STATE_PAUSED,0,1.0f)
.build();
mSession.setPlaybackState(mPlaybackState);
}
}
/** * 响应MediaController.getTransportControls().playFromUri * @param uri * @param extras */
@Override
public void onPlayFromUri(Uri uri, Bundle extras) {
Log.e(TAG,"onPlayFromUri");
try {
switch (mPlaybackState.getState()){
case PlaybackStateCompat.STATE_PLAYING:
case PlaybackStateCompat.STATE_PAUSED:
case PlaybackStateCompat.STATE_NONE:
mMediaPlayer.reset();
mMediaPlayer.setDataSource(MusicService.this,uri);
mMediaPlayer.prepare();//准备同步
mPlaybackState = new PlaybackStateCompat.Builder()
.setState(PlaybackStateCompat.STATE_CONNECTING,0,1.0f)
.build();
mSession.setPlaybackState(mPlaybackState);
//咱们能够保存当前播放音乐的信息，以便客户端刷新UI
mSession.setMetadata(new MediaMetadataCompat.Builder()
.putString(MediaMetadataCompat.METADATA_KEY_TITLE,extras.getString("title"))
.build()
);
break;
}
}catch (IOException e){
e.printStackTrace();
}
}
@Override
public void onPlayFromSearch(String query, Bundle extras) {
}
};
/** * 监听MediaPlayer.prepare() */
private MediaPlayer.OnPreparedListener PreparedListener = new MediaPlayer.OnPreparedListener() {
@Override
public void onPrepared(MediaPlayer mediaPlayer) {
mMediaPlayer.start();
mPlaybackState = new PlaybackStateCompat.Builder()
.setState(PlaybackStateCompat.STATE_PLAYING,0,1.0f)
.build();
mSession.setPlaybackState(mPlaybackState);
}
} ;
/** * 监听播放结束的事件 */
private MediaPlayer.OnCompletionListener CompletionListener = new MediaPlayer.OnCompletionListener() {
@Override
public void onCompletion(MediaPlayer mediaPlayer) {
mPlaybackState = new PlaybackStateCompat.Builder()
.setState(PlaybackStateCompat.STATE_NONE,0,1.0f)
.build();
mSession.setPlaybackState(mPlaybackState);
mMediaPlayer.reset();
}
};
}
复制代码
MediaSessionCompat.Callback中还有许多回调方法，你们能够按需覆盖重写便可
构建好MediaSession后记得调用setSessionToken保存Session的配对令牌，同时调用此方法也会回调MediaBrowser.ConnectionCallback的onConnected方法，告知客户端Browser与BrowserService链接成功了，咱们也就完成了MediaSession的建立和初始化
以前咱们还讲到Browser与BrowserService的订阅关系，在MediaBrowserService中咱们须要重写onGetRoot和onLoadChildren方法，其做用以前已经讲过就很少赘述了
public class MusicService extends MediaBrowserServiceCompat {
@Nullable
@Override
public BrowserRoot onGetRoot(@NonNull String clientPackageName, int clientUid, @Nullable Bundle rootHints) {
Log.e(TAG,"onGetRoot-----------");
return new BrowserRoot(MEDIA_ID_ROOT, null);
}
@Override
public void onLoadChildren(@NonNull String parentId, @NonNull final Result<List<MediaBrowserCompat.MediaItem>> result) {
Log.e(TAG,"onLoadChildren--------");
//将信息从当前线程中移除，容许后续调用sendResult方法
result.detach();
//咱们模拟获取数据的过程，真实状况应该是异步从网络或本地读取数据
MediaMetadataCompat metadata = new MediaMetadataCompat.Builder()
.putString(MediaMetadataCompat.METADATA_KEY_MEDIA_ID, ""+R.raw.jinglebells)
.putString(MediaMetadataCompat.METADATA_KEY_TITLE, "圣诞歌")
.build();
ArrayList<MediaBrowserCompat.MediaItem> mediaItems = new ArrayList<>();
mediaItems.add(createMediaItem(metadata));
//向Browser发送数据
result.sendResult(mediaItems);
}
private MediaBrowserCompat.MediaItem createMediaItem(MediaMetadataCompat metadata){
return new MediaBrowserCompat.MediaItem(
metadata.getDescription(),
MediaBrowserCompat.MediaItem.FLAG_PLAYABLE
);
}
}
复制代码
最后咱们回到客户端这边，四大成员还剩下控制器MediaController没讲。MediaController的建立依赖于Session的配对令牌，当Browser和BrowserService链接成功咱们就能够经过Browser拿到这个令牌了。控制器建立后，咱们就能够经过MediaController.getTransportControls的方法发送播放指令，同时也能够注册MediaControllerCompat.Callback回调接收播放状态，用以刷新界面UI
public class DemoActivity extends AppCompatActivity {
...
private Button btnPlay;
private TextView textTitle;
@Override
protected void onCreate(Bundle savedInstanceState) {
...
btnPlay = (Button) findViewById(R.id.btn_play);
textTitle = (TextView) findViewById(R.id.text_title);
}
public void clickEvent(View view) {
switch (view.getId()) {
case R.id.btn_play:
if(mController!=null){
handlerPlayEvent();
}
break;
}
}
/** * 处理播放按钮事件 */
private void handlerPlayEvent(){
switch (mController.getPlaybackState().getState()){
case PlaybackStateCompat.STATE_PLAYING:
mController.getTransportControls().pause();
break;
case PlaybackStateCompat.STATE_PAUSED:
mController.getTransportControls().play();
break;
default:
mController.getTransportControls().playFromSearch("", null);
break;
}
}
/** * 链接状态的回调接口，链接成功时会调用onConnected()方法 */
private MediaBrowserCompat.ConnectionCallback BrowserConnectionCallback =
new MediaBrowserCompat.ConnectionCallback(){
@Override
public void onConnected() {
Log.e(TAG,"onConnected------");
if (mBrowser.isConnected()) {
...
try{
mController = new MediaControllerCompat(DemoActivity.this,mBrowser.getSessionToken());
//注册回调
mController.registerCallback(ControllerCallback);
}catch (RemoteException e){
e.printStackTrace();
}
}
}
@Override
public void onConnectionFailed() {
Log.e(TAG,"链接失败！");
}
};
/** * 媒体控制器控制播放过程当中的回调接口，能够用来根据播放状态更新UI */
private final MediaControllerCompat.Callback ControllerCallback =
new MediaControllerCompat.Callback() {
/*** * 音乐播放状态改变的回调 * @param state */
@Override
public void onPlaybackStateChanged(PlaybackStateCompat state) {
switch (state.getState()){
case PlaybackStateCompat.STATE_NONE://无任何状态
textTitle.setText("");
btnPlay.setText("开始");
break;
case PlaybackStateCompat.STATE_PAUSED:
btnPlay.setText("开始");
break;
case PlaybackStateCompat.STATE_PLAYING:
btnPlay.setText("暂停");
break;
}
}
/** * 播放音乐改变的回调 * @param metadata */
@Override
public void onMetadataChanged(MediaMetadataCompat metadata) {
textTitle.setText(metadata.getDescription().getTitle());
}
};
private Uri rawToUri(int id){
String uriStr = "android.resource://" + getPackageName() + "/" + id;
return Uri.parse(uriStr);
}
}
复制代码
MediaSession框架的基本用法咱们已经分析完了，后续将会分析Google官方demo UniversalMusicPlayer 的源码，看看播放进度条、播放队列控制、通知栏上的快捷操做等等这些功能是如何结合MediaSession框架实现的
更新
UniversalMusicPlayer的源码分析已经开始更新了：