Android 媒體播放框架MediaSession分析與實踐

時間  2019-11-05
標籤 android 媒體 播放 框架 mediasession 分析 實踐 欄目 Android 简体版
原文   原文鏈接

版權聲明：本文爲博主原創文章，未經博主容許不得轉載
源碼：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的源碼分析已經開始更新了：

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程