MediaRouteProvider の概要

Android メディア ルーター フレームワークを使用すると、メーカーは MediaRouteProvider と呼ばれる標準化されたインターフェースを介してデバイスでの再生を有効にできます。ルート プロバイダは、レシーバー デバイスでメディアを再生するための共通インターフェースを定義します。これにより、メディア ルートをサポートする任意の Android アプリから、機器でメディアを再生できるようになります。

このガイドでは、受信側デバイス用のメディアルート プロバイダを作成し、Android で動作する他のメディア再生アプリで利用できるようにする方法について説明します。この API を使用するには、主要なクラスである MediaRouteProvider、MediaRouteProviderDescriptor、RouteController について理解しておく必要があります。

概要

Android メディア ルーター フレームワークを使用すると、メディアアプリ デベロッパーとメディア再生デバイス メーカーは、共通の API と共通のユーザー インターフェースを介して接続できます。MediaRouter インターフェースを実装するアプリ デベロッパーは、フレームワークに接続して、メディア ルーター フレームワークに参加しているデバイスにコンテンツを再生できます。メディア再生デバイスのメーカーは、MediaRouteProvider を公開することでフレームワークに参加できます。これにより、他のアプリがレシーバー デバイスに接続してメディアを再生できるようになります。図 1 は、アプリがメディア ルーター フレームワークを介して受信デバイスに接続する方法を示しています。

図 1. メディアアプリからレシーバー デバイスへの通信をメディア ルート プロバイダ クラスが提供する仕組みの概要。

受信側デバイス用のメディアルート プロバイダを構築する場合、プロバイダは次の目的で使用されます。

  • 他のアプリが受信側デバイスを検出してその再生機能を使用できるように、受信側デバイスの機能を記述して公開する。
  • 受信デバイスのプログラミング インターフェースとその通信トランスポート メカニズムをラップして、デバイスをメディア ルーター フレームワークに対応させます。

ルート プロバイダの配布

メディア ルート プロバイダは、Android アプリの一部として配布されます。MediaRouteProviderService を拡張するか、MediaRouteProvider の実装を独自のサービスでラップし、メディア ルート プロバイダのインテント フィルタを宣言することで、ルート プロバイダを他のアプリで使用できるようにすることができます。これらの手順により、他のアプリがメディア ルートを検出して利用できるようになります。

注: メディアルート プロバイダを含むアプリには、ルート プロバイダへの MediaRouter インターフェースを含めることもできますが、これは必須ではありません。

MediaRouter サポート ライブラリ

メディア ルーター API は、AndroidX MediaRouter ライブラリで定義されています。このライブラリをアプリ デベロッパー プロジェクトに追加する必要があります。プロジェクトにサポート ライブラリを追加する方法については、サポート ライブラリのセットアップをご覧ください。

注意: メディア ルーター フレームワークの AndroidX 実装を使用してください。古い android.media パッケージは使用しないでください。

プロバイダ サービスの作成

メディア ルーター フレームワークは、他のアプリがルートを使用できるように、メディア ルート プロバイダを検出して接続できる必要があります。このため、メディア ルーター フレームワークは、メディア ルート プロバイダのインテント アクションを宣言しているアプリを探します。別のアプリがプロバイダに接続しようとしたときに、フレームワークがプロバイダを呼び出して接続できるように、プロバイダを Service にカプセル化する必要があります。

次のサンプルコードは、マニフェストでのメディア ルート プロバイダ サービスとインテント フィルタの宣言を示しています。これにより、メディア ルーター フレームワークで検出して使用できるようになります。

<service android:name=".provider.SampleMediaRouteProviderService"
    android:label="@string/sample_media_route_provider_service"
    android:process=":mrp">
    <intent-filter>
        <action android:name="android.media.MediaRouteProviderService" />
    </intent-filter>
</service>

このマニフェストの例では、実際のメディア ルート プロバイダ クラスをラップするサービスを宣言しています。 Android メディア ルーター フレームワークには、メディア ルート プロバイダのサービス ラッパーとして使用する MediaRouteProviderService クラスが用意されています。次のサンプルコードは、このラッパークラスの使用方法を示しています。

class SampleMediaRouteProviderService : MediaRouteProviderService() {

    override fun onCreateMediaRouteProvider(): MediaRouteProvider {
        return SampleMediaRouteProvider(this)
    }
}

ルート機能の指定

メディア ルーター フレームワークに接続するアプリは、アプリのマニフェスト宣言を通じてメディアルートを検出できますが、提供するメディアルートの機能も認識する必要があります。メディア ルートにはさまざまなタイプがあり、さまざまな機能があります。他のアプリは、これらの詳細を検出して、ルートとの互換性を判断できる必要があります。

メディア ルーター フレームワークを使用すると、IntentFilter オブジェクト、MediaRouteDescriptor オブジェクト、MediaRouteProviderDescriptor を介して、メディア ルートの機能を定義して公開できます。このセクションでは、これらのクラスを使用して、他のアプリにメディア ルートの詳細を公開する方法について説明します。

ルートのカテゴリ

メディア ルート プロバイダのプログラムによる記述の一部として、プロバイダがリモート再生、セカンダリ出力、またはその両方をサポートしているかどうかを指定する必要があります。メディア ルーター フレームワークが提供するルートカテゴリは次のとおりです。

  • CATEGORY_LIVE_AUDIO — ワイヤレス対応の音楽システムなどのセカンダリ出力デバイスへのオーディオ出力。
  • CATEGORY_LIVE_VIDEO — ワイヤレス ディスプレイ デバイスなどのセカンダリ出力デバイスへの動画の出力。
  • CATEGORY_REMOTE_PLAYBACK - メディアの取得、デコード、再生を処理する別のデバイス(Chromecast デバイスなど)で動画または音声を再生します。

これらの設定をメディア ルートの説明に含めるには、IntentFilter オブジェクトに挿入し、後で MediaRouteDescriptor オブジェクトに追加します。

class SampleMediaRouteProvider(context: Context) : MediaRouteProvider(context) {

    companion object {
        private val CONTROL_FILTERS_BASIC: ArrayList<IntentFilter> = IntentFilter().run {
            addCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)
            arrayListOf(this)
        }
    }
}

CATEGORY_REMOTE_PLAYBACK インテントを指定する場合は、メディア ルート プロバイダでサポートされるメディアタイプと再生コントロールも定義する必要があります。次のセクションでは、デバイスにこれらの設定を指定する方法について説明します。

メディアタイプとプロトコル

リモート再生デバイスのメディア ルート プロバイダは、サポートするメディアタイプと転送プロトコルを指定する必要があります。これらの設定は、IntentFilter クラスと、そのオブジェクトの addDataScheme() メソッドおよび addDataType() メソッドを使用して指定します。次のコード スニペットは、http、https、Real Time Streaming Protocol(RTSP)を使用したリモート動画再生をサポートするインテント フィルタを定義する方法を示しています。

class SampleMediaRouteProvider(context: Context) : MediaRouteProvider(context) {

    companion object {

        private fun IntentFilter.addDataTypeUnchecked(type: String) {
            try {
                addDataType(type)
            } catch (ex: IntentFilter.MalformedMimeTypeException) {
                throw RuntimeException(ex)
            }
        }

        private val CONTROL_FILTERS_BASIC: ArrayList<IntentFilter> = IntentFilter().run {
            addCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)
            addAction(MediaControlIntent.ACTION_PLAY)
            addDataScheme("http")
            addDataScheme("https")
            addDataScheme("rtsp")
            addDataTypeUnchecked("video/*")
            arrayListOf(this)
        }
    }
    // ...
}

再生コントロール

リモート再生を提供するメディア ルート プロバイダは、サポートするメディア コントロールの種類を指定する必要があります。メディアルートで利用できる一般的なコントロールのタイプは次のとおりです。

  • 再生コントロール - 再生、一時停止、巻き戻し、早送りなど。
  • キュー機能。送信側アプリは、受信側デバイスで管理されている再生リストにアイテムを追加したり、再生リストからアイテムを削除したりできます。
  • セッション機能。受信側デバイスがリクエスト元のアプリにセッション ID を提供し、その後の再生コントロール リクエストごとにその ID を確認することで、送信側アプリが互いに干渉しないようにします。

次のコード例は、基本的なメディアルート再生コントロールをサポートするインテント フィルタを作成する方法を示しています。

class SampleMediaRouteProvider(context: Context) : MediaRouteProvider(context) {

    companion object {
        // ...
        private val CONTROL_FILTERS_BASIC: ArrayList<IntentFilter> = run {
            val videoPlayback: IntentFilter = ...
            // ...
            val playControls = IntentFilter().apply {
                addCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)
                addAction(MediaControlIntent.ACTION_SEEK)
                addAction(MediaControlIntent.ACTION_GET_STATUS)
                addAction(MediaControlIntent.ACTION_PAUSE)
                addAction(MediaControlIntent.ACTION_RESUME)
                addAction(MediaControlIntent.ACTION_STOP)
            }
            arrayListOf(videoPlayback, playControls)
        }
    }
    // ...
}

利用可能な再生コントロール インテントの詳細については、MediaControlIntent クラスをご覧ください。

MediaRouteProviderDescriptor

IntentFilter オブジェクトを使用してメディア ルートの機能を定義したら、Android メディア ルーター フレームワークに公開するための記述子オブジェクトを作成できます。この記述子オブジェクトには、メディアルートの機能の詳細が含まれているため、他のアプリはメディアルートとのやり取り方法を判断できます。

次のサンプルコードは、作成したインテント フィルタを MediaRouteProviderDescriptor に追加し、メディア ルーター フレームワークで使用する記述子を設定する方法を示しています。

class SampleMediaRouteProvider(context: Context) : MediaRouteProvider(context) {

    init {
        publishRoutes()
    }

    private fun publishRoutes() {
        val resources = context.resources
        val routeName: String = resources.getString(R.string.variable_volume_basic_route_name)
        val routeDescription: String = resources.getString(R.string.sample_route_description)
        // Create a route descriptor using previously created IntentFilters.
        val routeDescriptor: MediaRouteDescriptor =
            MediaRouteDescriptor.Builder(VARIABLE_VOLUME_BASIC_ROUTE_ID, routeName)
                .setDescription(routeDescription)
                .addControlFilters(CONTROL_FILTERS_BASIC)
                .setPlaybackStream(AudioManager.STREAM_MUSIC)
                .setPlaybackType(MediaRouter.RouteInfo.PLAYBACK_TYPE_REMOTE)
                .setVolumeHandling(MediaRouter.RouteInfo.PLAYBACK_VOLUME_VARIABLE)
                .setVolumeMax(VOLUME_MAX)
                .setVolume(mVolume)
                .build()
        // Add the route descriptor to the provider descriptor.
        val providerDescriptor: MediaRouteProviderDescriptor =
            MediaRouteProviderDescriptor.Builder()
                .addRoute(routeDescriptor)
                .build()

        // Publish the descriptor to the framework.
        descriptor = providerDescriptor
    }
    // ...
}

使用可能な記述子の設定の詳細については、MediaRouteDescriptor と MediaRouteProviderDescriptor のリファレンス ドキュメントをご覧ください。

ルートのコントロール

アプリケーションがメディア ルート プロバイダに接続すると、プロバイダは、他のアプリからルートに送信されたメディア ルーター フレームワークを介して再生コマンドを受信します。これらのリクエストを処理するには、MediaRouteProvider.RouteController クラスの実装を提供する必要があります。このクラスは、コマンドを処理し、受信側デバイスとの実際の通信を処理します。

メディア ルーター フレームワークは、ルート プロバイダの onCreateRouteController() メソッドを呼び出してこのクラスのインスタンスを取得し、リクエストをそのインスタンスにルーティングします。MediaRouteProvider.RouteController クラスの主なメソッドは次のとおりです。これらのメソッドは、メディア ルート プロバイダに実装する必要があります。

  • onSelect() — アプリが再生用のルートを選択したときに呼び出されます。このメソッドは、メディアの再生を開始する前に必要となる準備作業を行うために使用します。
  • onControlRequest() - 特定の再生コマンドを受信デバイスに送信します。
  • onSetVolume() - 再生音量を特定の値に設定するよう、受信デバイスにリクエストを送信します。
  • onUpdateVolume() - 受信デバイスにリクエストを送信して、再生音量を指定した量だけ変更します。
  • onUnselect() - アプリでルートの選択が解除されたときに呼び出されます。
  • onRelease() - フレームワークでルートが不要になったときに呼び出され、リソースを解放できます。

音量の変更を除くすべての再生コントロール リクエストは、onControlRequest() メソッドに転送されます。このメソッドの実装では、制御リクエストを解析して適切に応答する必要があります。リモート再生メディア ルートのコマンドを処理するこのメソッドの実装例を次に示します。

private class SampleRouteController : MediaRouteProvider.RouteController() {
    // ...

    override fun onControlRequest(
        intent: Intent,
        callback: MediaRouter.ControlRequestCallback?
    ): Boolean {
        return if (intent.hasCategory(MediaControlIntent.CATEGORY_REMOTE_PLAYBACK)) {
            val action = intent.action
            when (action) {
                MediaControlIntent.ACTION_PLAY -> handlePlay(intent, callback)
                MediaControlIntent.ACTION_ENQUEUE -> handleEnqueue(intent, callback)
                MediaControlIntent.ACTION_REMOVE -> handleRemove(intent, callback)
                MediaControlIntent.ACTION_SEEK -> handleSeek(intent, callback)
                MediaControlIntent.ACTION_GET_STATUS -> handleGetStatus(intent, callback)
                MediaControlIntent.ACTION_PAUSE -> handlePause(intent, callback)
                MediaControlIntent.ACTION_RESUME -> handleResume(intent, callback)
                MediaControlIntent.ACTION_STOP -> handleStop(intent, callback)
                MediaControlIntent.ACTION_START_SESSION -> handleStartSession(intent, callback)
                MediaControlIntent.ACTION_GET_SESSION_STATUS ->
                    handleGetSessionStatus(intent, callback)
                MediaControlIntent.ACTION_END_SESSION -> handleEndSession(intent, callback)
                else -> false
            }.also {
                Log.d(TAG, sessionManager.toString())
            }
        } else {
            false
        }
    }
    // ...
}

MediaRouteProvider.RouteController クラスは、メディア再生機器の API のラッパーとして機能することを目的としています。このクラスのメソッドの実装は、受信デバイスが提供するプログラム インターフェースに完全に依存します。

サンプルコード

MediaRouter サンプルは、カスタム メディア ルート プロバイダを作成する方法を示しています。