參考資料
媒體應用架構概覽 | Android 開發(fā)者 | Android Developers
MediaSession | Android Developers
MediaSession框架全解析_qzns木雨的博客-CSDN博客_mediasession

1. 多媒體應用架構

1.1 傳統(tǒng)應用架構

播放音頻或視頻的多媒體應用通常由兩部分組成：

• 播放器：接收傳入的數(shù)據(jù)多媒體辉阶，并輸出音頻或視頻〈穸螅可以是MediaPlayer谆甜、ExoPlayer或其他Player。
• 界面：用于顯示集绰、控制播放器狀態(tài)界面规辱。

image

為了解決上面的問題询吴，Android官方從Android5.0開始提供了MediaSession框架掠河。

1.2 MediaSession 框架

MediaSession框架規(guī)范了音視頻應用中界面與播放器之間的通信接口，實現(xiàn)界面與播放器之間的完全解耦猛计∵肽。框架定義了兩個重要的類媒體會話和媒體控制器，它們?yōu)闃嫿ǘ嗝襟w播放器應用提供了一個完善的結構奉瘤。

媒體會話和媒體控制器通過以下方式相互通信：使用與標準播放器操作（播放勾拉、暫停煮甥、停止等）相對應的預定義回調(diào)，以及用于定義應用獨有的特殊行為的可擴展自定義調(diào)用藕赞。

image

2. MediaSession 介紹

MediaSession框架屬于典型的C/S架構成肘，有四個常用的成員類，是整個MediaSession框架流程控制的核心斧蜕。

2.1 客戶端媒體瀏覽器 - MediaBrowser

媒體瀏覽器双霍，用來連接MediaBrowserService和訂閱數(shù)據(jù)，通過它的回調(diào)接口我們可以獲取與Service的連接狀態(tài)以及獲取在Service中的音樂庫數(shù)據(jù)批销。在客戶端（也就是上文我們提到的界面洒闸，或者說是控制端）中創(chuàng)建。
媒體瀏覽器不是線程安全的均芽。所有調(diào)用都應在構造MediaBrowser的線程上進行丘逸。

@RequiresApi(Build.VERSION_CODES.M)
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)

    val component = ComponentName(this, MediaService::class.java)
    mMediaBrowser = MediaBrowser(this, component, connectionCallback, null);
    mMediaBrowser.connect()
}

2.1.1 MediaBrowser.ConnectionCallback

用于接收與MediaBrowserService連接事件的回調(diào)，在創(chuàng)建MediaBrowser時傳入掀宋。

@RequiresApi(Build.VERSION_CODES.M)
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)

    val component = ComponentName(this, MediaService::class.java)
    mMediaBrowser = MediaBrowser(this, component, connectionCallback, null);
    mMediaBrowser.connect()
}

private val connectionCallback = object : MediaBrowser.ConnectionCallback() {

    override fun onConnected() {
        super.onConnected()
    }

    override fun onConnectionFailed() {
        super.onConnectionFailed()
    }

    override fun onConnectionSuspended() {
        super.onConnectionSuspended()
    }
}

2.1.2 MediaBrowser.ItemCallback

用于返回MediaBrowser.getItem()的結果深纲。

private val connectionCallback = object : MediaBrowser.ConnectionCallback() {

    override fun onConnected() {
        super.onConnected()
        // ...
        if(mMediaBrowser.isConnected) {
            val mediaId = mMediaBrowser.root
            mMediaBrowser.getItem(mediaId, itemCallback)
        }
    }
}

@RequiresApi(Build.VERSION_CODES.M)
private val itemCallback = object : MediaBrowser.ItemCallback(){

    override fun onItemLoaded(item: MediaBrowser.MediaItem?) {
        super.onItemLoaded(item)
    }

    override fun onError(mediaId: String) {
        super.onError(mediaId)
    }
}

2.1.3 MediaBrowser.MediaItem

包含有關單個媒體項的信息，用于瀏覽/搜索媒體布朦。MediaItem依賴于服務端提供囤萤，因此框架本身無法保證它包含的值都是正確的。

2.1.4 MediaBrowser.SubscriptionCallback

用于訂與MediaBrowserService中MediaBrowser.MediaItem列表變化的回調(diào)是趴。

private val connectionCallback = object : MediaBrowser.ConnectionCallback() {

    override fun onConnected() {
        super.onConnected()
        // ...
        if(mMediaBrowser.isConnected) {
            val mediaId = mMediaBrowser.root
            // 需要先取消訂閱
            mMediaBrowser.unsubscribe(mediaId)
            // 服務端會調(diào)用onLoadChildren
            mMediaBrowser.subscribe(mediaId, subscribeCallback)
        }
    }
}

private val subscribeCallback = object : MediaBrowser.SubscriptionCallback(){
    override fun onChildrenLoaded(
        parentId: String,
        children: MutableList<MediaBrowser.MediaItem>
    ) {
        super.onChildrenLoaded(parentId, children)
    }

    override fun onChildrenLoaded(
        parentId: String,
        children: MutableList<MediaBrowser.MediaItem>,
        options: Bundle
    ) {
        super.onChildrenLoaded(parentId, children, options)
    }

    override fun onError(parentId: String) {
        super.onError(parentId)
    }

    override fun onError(parentId: String, options: Bundle) {
        super.onError(parentId, options)
    }
}

2.2 客戶端媒體控制器 - MediaController

媒體控制器，用來向服務端發(fā)送控制指令澄惊，例如：播放唆途、暫停等等，在客戶端中創(chuàng)建掸驱。媒體控制器是線程安全的肛搬。MediaController還有一個關聯(lián)的權限android.permission.MEDIA_CONTENT_CONTROL（不是必須加的權限）必須是系統(tǒng)級應用才可以獲取，幸運的是車載應用一般都是系統(tǒng)級應用毕贼。
MediaController必須在MediaBrowser連接成功后才可以創(chuàng)建温赔。

private val connectionCallback = object : MediaBrowser.ConnectionCallback() {

    override fun onConnected() {
        super.onConnected()
        // ...
        if(mMediaBrowser.isConnected) {
            val sessionToken = mMediaBrowser.sessionToken
            mMediaController = MediaController(applicationContext,sessionToken)
        }
    }
}

2.2.1 MediaController.Callback

用于從MediaSession接收回調(diào)。使用方式如下：

private val connectionCallback = object : MediaBrowser.ConnectionCallback() {

    override fun onConnected() {
        super.onConnected()
        // ...
        if(mMediaBrowser.isConnected) {
            val sessionToken = mMediaBrowser.sessionToken
            mMediaController = MediaController(applicationContext,sessionToken)
            mMediaController.registerCallback(controllerCallback)
        }
    }
}

private val controllerCallback = object : MediaController.Callback() {

    override fun onAudioInfoChanged(info: MediaController.PlaybackInfo?) {
        super.onAudioInfoChanged(info)
    }

    override fun onExtrasChanged(extras: Bundle?) {
        super.onExtrasChanged(extras)
    }
    // ...
}

2.2.2 MediaController.PlaybackInfo

保存有關當前播放以及如何處理此會話的音頻的信息鬼癣。使用方式如下：

// 獲取當前回話播放的音頻信息
val playbackInfo = mMediaController.playbackInfo

2.2.3 MediaController.TransportControls

用于控制會話中媒體播放的接口陶贼。這允許客戶端向Session發(fā)送媒體控制命令。使用方式如下：

private val connectionCallback = object : MediaBrowser.ConnectionCallback() {

    override fun onConnected() {
        super.onConnected()
        // ...
        if(mMediaBrowser.isConnected) {
            val sessionToken = mMediaBrowser.sessionToken
            mMediaController = MediaController(applicationContext,sessionToken)
            // 播放媒體
            mMediaController.transportControls.play()
            // 暫停媒體
            mMediaController.transportControls.pause()
        }
    }
}

2.3 服務端媒體瀏覽服務 - MediaBrowserService

媒體瀏覽器服務待秃，繼承自Service拜秧，MediaBrowserService屬于服務端，也是承載播放器（如MediaPlayer章郁、ExoPlayer等）和MediaSession的容器枉氮。
實現(xiàn)MediaBrowserService時會要求復寫onGetRoot和onLoadChildren兩個方法。
onGetRoot通過的返回值決定是否允許客戶端的MediaBrowser連接到MediaBrowserService。
當客戶端調(diào)用MediaBrowser.subscribe時會觸發(fā)onLoadChildren方法聊替。

const val FOLDERS_ID = "__FOLDERS__"
const val ARTISTS_ID = "__ARTISTS__"
const val ALBUMS_ID = "__ALBUMS__"
const val GENRES_ID = "__GENRES__"
const val ROOT_ID = "__ROOT__"

class MediaService : MediaBrowserService() {

    override fun onGetRoot(
        clientPackageName: String,
        clientUid: Int,
        rootHints: Bundle?
    ): BrowserRoot? {
        // 由MediaBrowser.connect觸發(fā)楼肪，可以通過返回null拒絕客戶端的連接。
        return BrowserRoot(ROOT_ID, null)
    }

    override fun onLoadChildren(
        parentId: String,
        result: Result<MutableList<MediaBrowser.MediaItem>>
    ) {
    // 由MediaBrowser.subscribe觸發(fā)
        when (parentId) {
            ROOT_ID -> {
                // 查詢本地媒體庫
                // ...
                // 將此消息與當前線程分離惹悄，并允許稍后進行sendResult調(diào)用
                result.detach()
                // 設定到 result 中
                result.sendResult()
            }
            FOLDERS_ID -> {

            }
            ALBUMS_ID -> {

            }
            ARTISTS_ID -> {

            }
            GENRES_ID -> {

            }
            else -> {

            }
        }
    }
}

然后還需要在manifest中注冊這個Service淹辞。

<service
    android:name=".MediaService"
    android:label="@string/service_name">
    <intent-filter>
        <action android:name="android.media.browse.MediaBrowserService" />
    </intent-filter>
</service>

2.3.1 MediaBrowserService.BrowserRoot

包含瀏覽器服務首次連接時需要返回給客戶端的信息。

MediaBrowserService.BrowserRoot API 列表

2.3.2 MediaBrowserService.Result<T>

包含瀏覽器服務返回給客戶端的結果集。通過調(diào)用sendResult()將結果返回給調(diào)用方爷速，但是在此之前需要調(diào)用detach()央星。

MediaBrowserService.Result API 列表

2.4 服務端媒體會話 - MediaSession

媒體會話莉给，即受控端。通過設定MediaSession.Callback回調(diào)來接收媒體控制器MediaController發(fā)送的指令廉沮。
創(chuàng)建MediaSession后還需要調(diào)用setSessionToken()方法設置用于和**控制器配對的令牌颓遏。使用方式如下：

const val FOLDERS_ID = "__FOLDERS__"
const val ARTISTS_ID = "__ARTISTS__"
const val ALBUMS_ID = "__ALBUMS__"
const val GENRES_ID = "__GENRES__"
const val ROOT_ID = "__ROOT__"

class MediaService : MediaBrowserService() {

    private lateinit var mediaSession: MediaSession;

    override fun onCreate() {
        super.onCreate()
        mediaSession = MediaSession(this, "TAG")
        mediaSession.setCallback(callback)
        sessionToken = mediaSession.sessionToken
    }

    // 與MediaController.transportControls中的大部分方法都是一一對應的
    // 在該方法中實現(xiàn)對 播放器 的控制，
    private val callback = object : MediaSession.Callback() {

        override fun onPlay() {
            super.onPlay()
            // 處理 播放器 的播放邏輯滞时。
            // 車載應用的話叁幢，別忘了處理音頻焦點
        }

        override fun onPause() {
            super.onPause()
        }

    }
        override fun onGetRoot(
        clientPackageName: String,
        clientUid: Int,
        rootHints: Bundle?
    ): BrowserRoot? {
        Log.e("TAG", "onGetRoot: $rootHints")
        return BrowserRoot(ROOT_ID, null)
    }

    override fun onLoadChildren(
        parentId: String,
        result: Result<MutableList<MediaBrowser.MediaItem>>
    ) {
        Log.e("TAG", "onLoadChildren: $parentId")
        result.detach()
        when (parentId) {
            ROOT_ID -> {
                result.sendResult(null)
            }
            FOLDERS_ID -> {

            }
            ALBUMS_ID -> {

            }
            ARTISTS_ID -> {

            }
            GENRES_ID -> {

            }
            else -> {

            }
        }
    }

    override fun onLoadItem(itemId: String?, result: Result<MediaBrowser.MediaItem>?) {
        super.onLoadItem(itemId, result)
        Log.e("TAG", "onLoadItem: $itemId")
    }
}

2.4.1 MediaSession.Callback

接收來自控制器和系統(tǒng)的媒體按鈕、傳輸控件和命令坪稽。與MediaController.transportControls中的大部分方法都是一一對應的曼玩。使用方式如下：

override fun onCreate() {
    super.onCreate()
    mediaSession = MediaSession(this, "TAG")
    mediaSession.setCallback(callback)
    sessionToken = mediaSession.sessionToken
}

// 與MediaController.transportControls中的方法是一一對應的。
// 在該方法中實現(xiàn)對 播放器 的控制窒百，
private val callback = object : MediaSession.Callback() {

    override fun onPlay() {
        super.onPlay()
        // 處理 播放器 的播放邏輯黍判。
        // 車載應用的話，別忘了處理音頻焦點
        // ...
        if (!mediaSession.isActive) {
            mediaSession.isActive = true
        }
        // 更新播放狀態(tài).
        val state = PlaybackState.Builder()
            .setState(
                PlaybackState.STATE_PLAYING,1,1f
            )
            .build()
        // 此時MediaController.Callback.onPlaybackStateChanged會回調(diào)
        mediaSession.setPlaybackState(state)
    }

    override fun onPause() {
        super.onPause()
    }

    override fun onStop() {
        super.onStop()
    }

}

2.4.2 MediaSession.QueueItem

作為播放隊列一部分的單個項目篙梢。它包含隊列中項目及其 ID 的說明顷帖。
MediaSession.QueueItem API 列表

2.4.3 MediaSession.Token

表示正在進行的會話蔼水。這可以通過會話所有者傳遞給客戶端震糖，以允許客戶端與服務端之間建立通信。

2.5 播放器狀態(tài) - PlaybackState

用于承載播放狀態(tài)的類趴腋。如當前播放位置和當前控制功能吊说。
在MediaSession.Callback更改狀態(tài)后需要調(diào)用MediaSession.setPlaybackState把狀態(tài)同步給客戶端论咏。使用方式如下：

private val callback = object : MediaSession.Callback() {

    override fun onPlay() {
        super.onPlay()
        // ...
        // 更新狀態(tài)
        val state = PlaybackState.Builder()
            .setState(
                PlaybackState.STATE_PLAYING,1,1f
            )
            .build()
        mediaSession.setPlaybackState(state)
    }
}

2.5.1 PlaybackState.Builder

基于建造者模式來生成PlaybackState對象。使用方式如下：

PlaybackState state = new PlaybackState.Builder()
        .setState(PlaybackState.STATE_PLAYING,
                mMediaPlayer.getCurrentPosition(), PLAYBACK_SPEED)
        .setActions(PLAYING_ACTIONS)
        .addCustomAction(mShuffle)
        .setActiveQueueItemId(mQueue.get(mCurrentQueueIdx).getQueueId())
        .build();

2.5.2 PlaybackState.CustomAction

CustomActions可用于通過將特定于應用程序的操作發(fā)送給MediaControllers颁井，這樣就可以擴展標準傳輸控件的功能厅贪。使用方式如下：

CustomAction action = new CustomAction
        .Builder("android.car.media.localmediaplayer.shuffle",
        mContext.getString(R.string.shuffle),
        R.drawable.shuffle)
        .build();

PlaybackState state = new PlaybackState.Builder()
        .setState(PlaybackState.STATE_PLAYING,
                mMediaPlayer.getCurrentPosition(), PLAYBACK_SPEED)
        .setActions(PLAYING_ACTIONS)
        .addCustomAction(action)
        .setActiveQueueItemId(mQueue.get(mCurrentQueueIdx).getQueueId())
        .build();

PlaybackState.CustomAction API 說明

2.6 元數(shù)據(jù)類 - MediaMetadata

包含有關項目的基礎數(shù)據(jù)蜀变，例如標題悄谐、藝術家等。一般需要服務端從本地數(shù)據(jù)庫或遠端查詢出原始數(shù)據(jù)在封裝成MediaMetadata再通過MediaSession.setMetadata(metadata)返回到客戶端的MediaController.Callback.onMetadataChanged中库北。

MediaMetadata API 說明

MediaMetadata 常用Key

3. MediaSession 簡單實踐

MediaSession 框架核心類通信過程如下圖所示贼急。

image

客戶端源碼如下所示：

class MainActivity : AppCompatActivity() {

    private lateinit var mMediaBrowser: MediaBrowser
    private lateinit var mMediaController: MediaController

    @RequiresApi(Build.VERSION_CODES.M)
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val component = ComponentName(this, MediaService::class.java)
        mMediaBrowser = MediaBrowser(this, component, connectionCallback, null);
        // 連接到MediaBrowserService，會觸發(fā)MediaBrowserService的onGetRoot方法捏萍。
        mMediaBrowser.connect()

        findViewById<Button>(R.id.btn_play).setOnClickListener {
            mMediaController.transportControls.play()
        }
    }

    private val connectionCallback = object : MediaBrowser.ConnectionCallback() {

        override fun onConnected() {
            super.onConnected()
            if (mMediaBrowser.isConnected) {
                val sessionToken = mMediaBrowser.sessionToken
                mMediaController = MediaController(applicationContext, sessionToken)
                mMediaController.registerCallback(controllerCallback)
                // 獲取根mediaId
                val rootMediaId = mMediaBrowser.root
                // 獲取根mediaId的item列表，會觸發(fā)MediaBrowserService.onLoadItem方法
                mMediaBrowser.getItem(rootMediaId,itemCallback)
                mMediaBrowser.unsubscribe(rootMediaId)
                // 訂閱服務端 media item的改變令杈，會觸發(fā)MediaBrowserService.onLoadChildren方法
                mMediaBrowser.subscribe(rootMediaId, subscribeCallback)
            }
        }
    }

    private val controllerCallback = object : MediaController.Callback() {

        override fun onPlaybackStateChanged(state: PlaybackState?) {
            super.onPlaybackStateChanged(state)
            Log.d("TAG", "onPlaybackStateChanged: $state")
            when(state?.state){
                PlaybackState.STATE_PLAYING ->{
                    // 處理UI
                }
                PlaybackState.STATE_PAUSED ->{
                    // 處理UI
                }
                // 還有其它狀態(tài)需要處理
            }
        }

        // 音頻信息走敌，音量
        override fun onAudioInfoChanged(info: MediaController.PlaybackInfo?) {
            super.onAudioInfoChanged(info)
            val currentVolume = info?.currentVolume
            // 顯示在UI上
        }

        override fun onMetadataChanged(metadata: MediaMetadata?) {
            super.onMetadataChanged(metadata)
            val artUri = metadata?.getString(MediaMetadata.METADATA_KEY_ALBUM_ART_URI)
            // 顯示UI上
        }

        override fun onSessionEvent(event: String, extras: Bundle?) {
            super.onSessionEvent(event, extras)
            Log.d("TAG", "onSessionEvent: $event")
        }
        // ...
    }

    private val subscribeCallback = object : MediaBrowser.SubscriptionCallback() {
        override fun onChildrenLoaded(
            parentId: String,
            children: MutableList<MediaBrowser.MediaItem>
        ) {
            super.onChildrenLoaded(parentId, children)
        }

        override fun onChildrenLoaded(
            parentId: String,
            children: MutableList<MediaBrowser.MediaItem>,
            options: Bundle
        ) {
            super.onChildrenLoaded(parentId, children, options)
        }

        override fun onError(parentId: String) {
            super.onError(parentId)
        }
    }

    private val itemCallback = object : MediaBrowser.ItemCallback() {

        override fun onItemLoaded(item: MediaBrowser.MediaItem?) {
            super.onItemLoaded(item)
        }

        override fun onError(mediaId: String) {
            super.onError(mediaId)
        }
    }
}

服務端源碼如下所示：

const val FOLDERS_ID = "__FOLDERS__"
const val ARTISTS_ID = "__ARTISTS__"
const val ALBUMS_ID = "__ALBUMS__"
const val GENRES_ID = "__GENRES__"
const val ROOT_ID = "__ROOT__"

class MediaService : MediaBrowserService() {

    // 控制是否允許客戶端連接，并返回root media id給客戶端
    override fun onGetRoot(
        clientPackageName: String,
        clientUid: Int,
        rootHints: Bundle?
    ): BrowserRoot? {
        Log.e("TAG", "onGetRoot: $rootHints")
        return BrowserRoot(ROOT_ID, null)
    }

    // 處理客戶端的訂閱信息
    override fun onLoadChildren(
        parentId: String,
        result: Result<MutableList<MediaBrowser.MediaItem>>
    ) {
        Log.e("TAG", "onLoadChildren: $parentId")
        result.detach()
        when (parentId) {
            ROOT_ID -> {
                result.sendResult(null)
            }
            FOLDERS_ID -> {

            }
            ALBUMS_ID -> {

            }
            ARTISTS_ID -> {

            }
            GENRES_ID -> {

            }
            else -> {

            }
        }
    }

    override fun onLoadItem(itemId: String?, result: Result<MediaBrowser.MediaItem>?) {
        super.onLoadItem(itemId, result)
        Log.e("TAG", "onLoadItem: $itemId")
        // 根據(jù)itemId逗噩，返回對用MediaItem
        result?.detach()
        result?.sendResult(null)
    }

    private lateinit var mediaSession: MediaSession;

    override fun onCreate() {
        super.onCreate()
        mediaSession = MediaSession(this, "TAG")
        mediaSession.setCallback(callback)
        // 設置token
        sessionToken = mediaSession.sessionToken
    }

    // 與MediaController.transportControls中的方法是一一對應的掉丽。
    // 在該方法中實現(xiàn)對 播放器 的控制跌榔，
    private val callback = object : MediaSession.Callback() {

        override fun onPlay() {
            super.onPlay()
            // 處理 播放器 的播放邏輯。
            // 車載應用的話机打，別忘了處理音頻焦點
            Log.e("TAG", "onPlay:")
            if (!mediaSession.isActive) {
                mediaSession.isActive = true
            }
            // 更新狀態(tài)
            val state = PlaybackState.Builder()
                .setState(
                    PlaybackState.STATE_PLAYING, 1, 1f
                )
                .build()
            mediaSession.setPlaybackState(state)
        }

        override fun onPause() {
            super.onPause()
        }

        override fun onStop() {
            super.onStop()
        }

        // 還有其它方法需要復寫
    }
}

上述的代碼只是幫助理解MediaSession框架的通信過程矫户，本身的功能非常的簡陋。上一篇Android車載應用開發(fā)與分析（6）- 車載多媒體（一）- 音視頻基礎知識與MediaPlayer中介紹了音視頻的基礎知識和MediaPlayer的生命周期残邀，再通過本篇了解了MediaSession框架的基礎使用皆辽，下一篇我們就可以開始解析車載Android中的原生LocalMedia應用了。

4. MediaSession API 列表

4.1 MediaBrowser 相關組件 API 列表

4.1.1 MediaBrowser

4.1.2 MediaBrowser.ConnectionCallback

4.1.3 MediaBrowser. ItemCallback

4.1.4 MediaBrowser. MediaItem

4.1.5 MediaBrowser.SubscriptionCallback

4.2 MediaController 相關組件 API 列表

4.2.1 MediaController

4.2.2 MediaController.Callback

4.2.3 MediaController. PlaybackInfo

4.2.4 MediaController. TransportControls

4.3 MediaBrowserService 相關組件 API 列表

4.3.1 MediaBrowserService

4.3.2 MediaBrowserService.BrowserRoot

4.3.3 MediaBrowserService.Result

4.4 MediaSession 相關組件 API 列表

4.4.1 MediaSession

4.4.2 MediaSession.Callback

4.4.3 MediaSession.QueueItem

4.5 PlaybackState 相關組件 API 列表

4.5.1 PlaybackState

4.5.2 PlaybackState.Builder

4.5.3 PlaybackState.CustomAction