このページは Cloud Translation API によって翻訳されました。

キャストを Android アプリに統合する

このデベロッパーガイドでは、Android Sender SDK を使用して Android 送信者アプリに Google Cast サポートを追加する方法について説明します。

モバイルデバイスまたはノートパソコンは再生操作を行う「送信側」であり、Google Cast デバイスはテレビ上にコンテンツを表示する「レシーバー」です。

送信者フレームワークとは、実行時に送信者に表示される Cast クラスライブラリバイナリと関連リソースを指します。送信者アプリまたはキャストアプリとは、送信者で実行されるアプリを意味します。ウェブレシーバーアプリとは、Cast 対応デバイスで実行される HTML アプリケーションを指します。

送信側フレームワークは、非同期コールバック設計を使用して、送信側アプリにイベントを通知し、キャストアプリのライフサイクルのさまざまな状態の間で遷移します。

アプリケーションの流れ

送信者の Android アプリの一般的な実行フローの概要は次のとおりです。

キャストフレームワークは、Activity のライフサイクルに基づいて、MediaRouter デバイスの検出を自動的に開始します。
ユーザーがキャストボタンをクリックすると、検出されたキャストデバイスのリストが記載されたキャストダイアログが表示されます。
ユーザーがキャストデバイスを選択すると、フレームワークはキャストデバイスでウェブレシーバーアプリの起動を試みます。
フレームワークは送信側アプリでコールバックを呼び出して、ウェブレシーバーアプリが起動されたことを確認します。
フレームワークは、送信者アプリとウェブ受信者アプリ間の通信チャネルを作成します。
フレームワークは通信チャネルを使用して、ウェブレシーバでのメディア再生の読み込みと制御を行います。
フレームワークは送信者とウェブ受信者の間でメディアの再生状態を同期します。ユーザーが送信者の UI 操作を行うと、フレームワークはメディア制御リクエストをウェブ受信者に送信し、ウェブ受信者がメディアステータスの更新を送信すると、フレームワークが送信者 UI の状態を更新します。
ユーザーがキャストアイコンをクリックしてキャストデバイスから切断すると、フレームワークは送信側アプリとウェブレシーバーとの接続を解除します。

Google Cast Android SDK のすべてのクラス、メソッド、イベントの完全なリストについては、Android 用 Google Cast Sender API リファレンスをご覧ください。以下のセクションでは、Android アプリに Cast を追加する手順について説明します。

Android マニフェストを構成する

アプリの AndroidManifest.xml ファイルでは、Cast SDK の次の要素を構成する必要があります。

uses-sdk

Cast SDK がサポートする最小 Android API レベルとターゲット Android API レベルを設定します。現在、最小は API レベル 19 で、ターゲットは API レベル 28 です。

<uses-sdk
        android:minSdkVersion="19"
        android:targetSdkVersion="28" />

android:theme

Android SDK の最小バージョンに基づいてアプリのテーマを設定します。たとえば、独自のテーマを実装しない場合は、Lollipop より前の Android SDK の最小バージョンを対象とするときに Theme.AppCompat のバリアントを使用する必要があります。

<application
        android:icon="@drawable/ic_launcher"
        android:label="@string/app_name"
        android:theme="@style/Theme.AppCompat" >
       ...
</application>

キャストコンテキストを初期化する

フレームワークには、フレームワークのすべてのインタラクションを調整するグローバルシングルトンオブジェクト CastContext があります。

アプリに OptionsProvider インターフェースを実装して、CastContext シングルトンの初期化に必要なオプションを指定する必要があります。OptionsProvider は、フレームワークの動作に影響するオプションを含む CastOptions のインスタンスを提供します。最も重要なのは Web Receiver アプリケーション ID です。この ID を使用して、検出結果をフィルタし、キャストセッションの開始時に Web Receiver アプリを起動します。

Kotlin

class CastOptionsProvider : OptionsProvider {
    override fun getCastOptions(context: Context): CastOptions {
        return Builder()
            .setReceiverApplicationId(context.getString(R.string.app_id))
            .build()
    }

    override fun getAdditionalSessionProviders(context: Context): List<SessionProvider>? {
        return null
    }
}

Java

public class CastOptionsProvider implements OptionsProvider {
    @Override
    public CastOptions getCastOptions(Context context) {
        CastOptions castOptions = new CastOptions.Builder()
            .setReceiverApplicationId(context.getString(R.string.app_id))
            .build();
        return castOptions;
    }
    @Override
    public List<SessionProvider> getAdditionalSessionProviders(Context context) {
        return null;
    }
}

実装された OptionsProvider の完全修飾名を、送信者アプリの AndroidManifest.xml ファイル内のメタデータフィールドとして宣言する必要があります。

<application>
    ...
    <meta-data
        android:name=
            "com.google.android.gms.cast.framework.OPTIONS_PROVIDER_CLASS_NAME"
        android:value="com.foo.CastOptionsProvider" />
</application>

CastContext は、CastContext.getSharedInstance() が呼び出されると遅延初期化されます。

Kotlin

class MyActivity : FragmentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        val castContext = CastContext.getSharedInstance(this)
    }
}

Java

public class MyActivity extends FragmentActivity {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        CastContext castContext = CastContext.getSharedInstance(this);
    }
}

キャスト UX ウィジェット

キャストフレームワークには、キャストデザインチェックリストに準拠するウィジェットが用意されています。

入門オーバーレイ: フレームワークはカスタムビュー IntroductoryOverlay を提供します。これは、レシーバーを初めて使用する際に、キャストボタンに注意を喚起するためにユーザーに表示されます。送信者のアプリは、テキストとタイトルテキストの位置をカスタマイズできます。
キャストボタン: キャストアイコンは、アプリをサポートするレシーバーが検出されると、表示されます。ユーザーが初めてキャストボタンをクリックすると、検出されたデバイスのリストが表示されるキャストダイアログが表示されます。デバイスがキャストされているときにキャストボタンをクリックすると、現在のメディアメタデータ（タイトル、レコーディングスタジオの名前、サムネイル画像など）が表示されるか、キャストデバイスの接続を解除できます。
ミニコントローラ: ユーザーがコンテンツをキャストしているときに、現在のコンテンツページまたは展開されたコントローラから送信者アプリの別の画面に移動すると、画面の下部にミニコントローラが表示され、現在キャストされているメディアのメタデータの確認と再生の制御が可能になります。
拡張コントローラ: ユーザーがコンテンツをキャストしているときにメディア通知またはミニコントローラをクリックすると、拡張コントローラが起動します。これにより、現在再生中のメディアメタデータが表示され、メディアの再生を制御するボタンがいくつか表示されます。
通知: Android のみ。ユーザーがコンテンツをキャストして送信者アプリから離れると、現在キャストされているメディアメタデータと再生コントロールを示すメディア通知が表示されます。
ロック画面: Android のみ。ユーザーがコンテンツをキャストしてロック画面に移動する（またはデバイスがタイムアウトする）と、メディアロック画面コントロールが表示され、現在キャストされているメディアのメタデータと再生コントロールが表示されます。

このガイドでは、これらのウィジェットをアプリに追加する方法について説明します。

キャストアイコンを追加する

Android MediaRouter API は、セカンダリデバイスでメディアの表示と再生を可能にするように設計されています。MediaRouter API を使用する Android アプリでは、ユーザーインターフェースの一部としてキャストアイコンを含め、ユーザーがキャストデバイスなどのセカンダリデバイスでメディアを再生するメディアルートを選択できるようにする必要があります。

このフレームワークにより、MediaRouteButton を Cast button として簡単に追加できます。まず、メニューを定義する xml ファイルにメニュー項目または MediaRouteButton を追加し、次に CastButtonFactory を使用してフレームワークと接続します。

// To add a Cast button, add the following snippet.
// menu.xml
<item
    android:id="@+id/media_route_menu_item"
    android:title="@string/media_route_menu_title"
    app:actionProviderClass="androidx.mediarouter.app.MediaRouteActionProvider"
    app:showAsAction="always" />

Kotlin

// Then override the onCreateOptionMenu() for each of your activities.
// MyActivity.kt
override fun onCreateOptionsMenu(menu: Menu): Boolean {
    super.onCreateOptionsMenu(menu)
    menuInflater.inflate(R.menu.main, menu)
    CastButtonFactory.setUpMediaRouteButton(
        applicationContext,
        menu,
        R.id.media_route_menu_item
    )
    return true
}

Java

// Then override the onCreateOptionMenu() for each of your activities.
// MyActivity.java
@Override public boolean onCreateOptionsMenu(Menu menu) {
    super.onCreateOptionsMenu(menu);
    getMenuInflater().inflate(R.menu.main, menu);
    CastButtonFactory.setUpMediaRouteButton(getApplicationContext(),
                                            menu,
                                            R.id.media_route_menu_item);
    return true;
}

次に、Activity が FragmentActivity から継承する場合、MediaRouteButton をレイアウトに追加できます。

// activity_layout.xml
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
   android:layout_width="match_parent"
   android:layout_height="wrap_content"
   android:gravity="center_vertical"
   android:orientation="horizontal" >

   <androidx.mediarouter.app.MediaRouteButton
       android:id="@+id/media_route_button"
       android:layout_width="wrap_content"
       android:layout_height="wrap_content"
       android:layout_weight="1"
       android:mediaRouteTypes="user"
       android:visibility="gone" />

</LinearLayout>

Kotlin

// MyActivity.kt
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_layout)

    mMediaRouteButton = findViewById<View>(R.id.media_route_button) as MediaRouteButton
    CastButtonFactory.setUpMediaRouteButton(applicationContext, mMediaRouteButton)

    mCastContext = CastContext.getSharedInstance(this)
}

Java

// MyActivity.java
@Override
protected void onCreate(Bundle savedInstanceState) {
   super.onCreate(savedInstanceState);
   setContentView(R.layout.activity_layout);

   mMediaRouteButton = (MediaRouteButton) findViewById(R.id.media_route_button);
   CastButtonFactory.setUpMediaRouteButton(getApplicationContext(), mMediaRouteButton);

   mCastContext = CastContext.getSharedInstance(this);
}

テーマを使用してキャストアイコンの外観を設定するには、キャストアイコンをカスタマイズするをご覧ください。

デバイスの検出を構成する

デバイスの検出は CastContext によって完全に管理されます。CastContext を初期化する際に、送信側アプリはウェブレシーバーアプリケーション ID を指定します。必要に応じて、CastOptions で supportedNamespaces を設定することで、名前空間フィルタリングをリクエストできます。CastContext は MediaRouter への参照を内部で保持し、送信側アプリがフォアグラウンドに入ると検出プロセスを開始し、送信側アプリがバックグラウンドに移動したときに停止します。

Kotlin

class CastOptionsProvider : OptionsProvider {
    companion object {
        const val CUSTOM_NAMESPACE = "urn:x-cast:custom_namespace"
    }

    override fun getCastOptions(appContext: Context): CastOptions {
        val supportedNamespaces: MutableList<String> = ArrayList()
        supportedNamespaces.add(CUSTOM_NAMESPACE)

        return CastOptions.Builder()
            .setReceiverApplicationId(context.getString(R.string.app_id))
            .setSupportedNamespaces(supportedNamespaces)
            .build()
    }

    override fun getAdditionalSessionProviders(context: Context): List<SessionProvider>? {
        return null
    }
}

Java

class CastOptionsProvider implements OptionsProvider {
    public static final String CUSTOM_NAMESPACE = "urn:x-cast:custom_namespace";

    @Override
    public CastOptions getCastOptions(Context appContext) {
        List<String> supportedNamespaces = new ArrayList<>();
        supportedNamespaces.add(CUSTOM_NAMESPACE);

        CastOptions castOptions = new CastOptions.Builder()
            .setReceiverApplicationId(context.getString(R.string.app_id))
            .setSupportedNamespaces(supportedNamespaces)
            .build();
        return castOptions;
    }

    @Override
    public List<SessionProvider> getAdditionalSessionProviders(Context context) {
        return null;
    }
}

セッション管理の仕組み

Cast SDK では、キャストセッションのコンセプトが導入されています。つまり、デバイスへの接続、ウェブレシーバーアプリの起動（または参加）、アプリへの接続、メディアコントロールチャネルの初期化というステップが確立されます。キャストセッションとウェブレシーバーのライフサイクルについて詳しくは、ウェブレシーバーのアプリケーションライフサイクルガイドをご覧ください。

セッションはクラス SessionManager によって管理され、アプリは CastContext.getSessionManager() を介してアクセスできます。個々のセッションは、Session クラスのサブクラスで表されます。たとえば、CastSession はキャストデバイスによるセッションを表します。アプリは、SessionManager.getCurrentCastSession() を介して現在アクティブなキャストセッションにアクセスできます。

アプリでは、SessionManagerListener クラスを使用して、作成、一時停止、再開、終了などのセッションイベントをモニタリングできます。セッションがアクティブな間、フレームワークは異常終了または突然の終了から自動的に再開を試みます。

セッションは、MediaRouter ダイアログでのユーザー操作に応じて作成、破棄されます。

キャスト開始エラーを詳しく把握するために、アプリで CastContext#getCastReasonCodeForCastStatusCode(int) を使用してセッション開始エラーを CastReasonCodes に変換できます。なお、一部のセッション開始エラー（CastReasonCodes#CAST_CANCELLED など）は意図された動作であり、エラーとしてログに記録されません。

セッションの状態変化を認識する必要がある場合は、SessionManagerListener を実装できます。この例では、Activity で CastSession の可用性をリッスンしています。

Kotlin

class MyActivity : Activity() {
    private var mCastSession: CastSession? = null
    private lateinit var mCastContext: CastContext
    private lateinit var mSessionManager: SessionManager
    private val mSessionManagerListener: SessionManagerListener<CastSession> =
        SessionManagerListenerImpl()

    private inner class SessionManagerListenerImpl : SessionManagerListener<CastSession?> {
        override fun onSessionStarting(session: CastSession?) {}

        override fun onSessionStarted(session: CastSession?, sessionId: String) {
            invalidateOptionsMenu()
        }

        override fun onSessionStartFailed(session: CastSession?, error: Int) {
            val castReasonCode = mCastContext.getCastReasonCodeForCastStatusCode(error)
            // Handle error
        }

        override fun onSessionSuspended(session: CastSession?, reason Int) {}

        override fun onSessionResuming(session: CastSession?, sessionId: String) {}

        override fun onSessionResumed(session: CastSession?, wasSuspended: Boolean) {
            invalidateOptionsMenu()
        }

        override fun onSessionResumeFailed(session: CastSession?, error: Int) {}

        override fun onSessionEnding(session: CastSession?) {}

        override fun onSessionEnded(session: CastSession?, error: Int) {
            finish()
        }
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        mCastContext = CastContext.getSharedInstance(this)
        mSessionManager = mCastContext.sessionManager
    }

    override fun onResume() {
        super.onResume()
        mCastSession = mSessionManager.currentCastSession
        mSessionManager.addSessionManagerListener(mSessionManagerListener, CastSession::class.java)
    }

    override fun onPause() {
        super.onPause()
        mSessionManager.removeSessionManagerListener(mSessionManagerListener, CastSession::class.java)
        mCastSession = null
    }
}

Java

public class MyActivity extends Activity {
    private CastContext mCastContext;
    private CastSession mCastSession;
    private SessionManager mSessionManager;
    private SessionManagerListener<CastSession> mSessionManagerListener =
            new SessionManagerListenerImpl();

    private class SessionManagerListenerImpl implements SessionManagerListener<CastSession> {
        @Override
        public void onSessionStarting(CastSession session) {}
        @Override
        public void onSessionStarted(CastSession session, String sessionId) {
            invalidateOptionsMenu();
        }
        @Override
        public void onSessionStartFailed(CastSession session, int error) {
            int castReasonCode = mCastContext.getCastReasonCodeForCastStatusCode(error);
            // Handle error
        }
        @Override
        public void onSessionSuspended(CastSession session, int reason) {}
        @Override
        public void onSessionResuming(CastSession session, String sessionId) {}
        @Override
        public void onSessionResumed(CastSession session, boolean wasSuspended) {
            invalidateOptionsMenu();
        }
        @Override
        public void onSessionResumeFailed(CastSession session, int error) {}
        @Override
        public void onSessionEnding(CastSession session) {}
        @Override
        public void onSessionEnded(CastSession session, int error) {
            finish();
        }
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        mCastContext = CastContext.getSharedInstance(this);
        mSessionManager = mCastContext.getSessionManager();
    }
    @Override
    protected void onResume() {
        super.onResume();
        mCastSession = mSessionManager.getCurrentCastSession();
        mSessionManager.addSessionManagerListener(mSessionManagerListener, CastSession.class);
    }
    @Override
    protected void onPause() {
        super.onPause();
        mSessionManager.removeSessionManagerListener(mSessionManagerListener, CastSession.class);
        mCastSession = null;
    }
}

ストリーミング転送

セッション状態を維持することはストリーム転送の基礎であり、ユーザーは音声コマンド、Google Home アプリ、スマートディスプレイを使用して、既存の音声や動画のストリームをデバイス間で移動できます。メディアは、あるデバイス（ソース）で再生を停止し、別のデバイス（宛先）で再生を続けます。最新のファームウェアを搭載したキャストデバイスは、ストリーミング転送でソースまたは宛先として機能できます。

ストリームの転送または拡張中に新しいデスティネーションデバイスを取得するには、CastSession#addCastListener を使用して Cast.Listener を登録します。次に、onDeviceNameChanged コールバック中に CastSession#getCastDevice() を呼び出します。

詳細については、ウェブレシーバーでのストリーム転送をご覧ください。

自動再接続

フレームワークには ReconnectionService が用意されています。これは、センダーアプリで、次のような微妙なケースでも再接続を処理するために有効にできます。

Wi-Fi の一時的な障害から回復する
デバイスのスリープから回復する
アプリのバックグラウンドから復元する
アプリがクラッシュした場合に復元する

このサービスはデフォルトで有効になっていますが、CastOptions.Builder で無効にできます。

Gradle ファイルで自動マージが有効になっている場合、このサービスは自動的にアプリのマニフェストにマージされます。

メディアセッションがあると、フレームワークはサービスを開始し、メディアセッションが終了するとサービスを停止します。

メディアコントロールの仕組み

キャストフレームワークでは、Cast 2.x の RemoteMediaPlayer クラスが非推奨になり、新しい API RemoteMediaClient に置き換えられました。このクラスは、便利な API のセットで同様の機能を提供するため、GoogleApiClient を渡す必要がありません。

アプリがメディア名前空間をサポートするウェブレシーバアプリで CastSession を確立すると、フレームワークによって RemoteMediaClient のインスタンスが自動的に作成されます。アプリは CastSession インスタンスで getRemoteMediaClient() メソッドを呼び出してインスタンスにアクセスできます。

ウェブレシーバにリクエストを発行する RemoteMediaClient のすべてのメソッドは、そのリクエストの追跡に使用できる PendingResult オブジェクトを返します。

RemoteMediaClient のインスタンスは、アプリの複数の部分で共有される可能性があり、実際に、永続的なミニコントローラや通知サービスなど、フレームワークの内部コンポーネントによっても共有されることがあります。そのため、このインスタンスは RemoteMediaClient.Listener の複数のインスタンスの登録をサポートしています。

メディアメタデータの設定

MediaMetadata クラスは、キャストするメディアアイテムに関する情報を表します。次の例では、映画の新しい MediaMetadata インスタンスを作成し、タイトル、サブタイトル、2 つの画像を設定しています。

Kotlin

val movieMetadata = MediaMetadata(MediaMetadata.MEDIA_TYPE_MOVIE)

movieMetadata.putString(MediaMetadata.KEY_TITLE, mSelectedMedia.getTitle())
movieMetadata.putString(MediaMetadata.KEY_SUBTITLE, mSelectedMedia.getStudio())
movieMetadata.addImage(WebImage(Uri.parse(mSelectedMedia.getImage(0))))
movieMetadata.addImage(WebImage(Uri.parse(mSelectedMedia.getImage(1))))

Java

MediaMetadata movieMetadata = new MediaMetadata(MediaMetadata.MEDIA_TYPE_MOVIE);

movieMetadata.putString(MediaMetadata.KEY_TITLE, mSelectedMedia.getTitle());
movieMetadata.putString(MediaMetadata.KEY_SUBTITLE, mSelectedMedia.getStudio());
movieMetadata.addImage(new WebImage(Uri.parse(mSelectedMedia.getImage(0))));
movieMetadata.addImage(new WebImage(Uri.parse(mSelectedMedia.getImage(1))));

メディアメタデータのある画像の使用方法については、画像の選択をご覧ください。

メディアを読み込む

アプリでは、次のコードに示すように、メディアアイテムを読み込むことができます。まず、メディアのメタデータで MediaInfo.Builder を使用して、MediaInfo インスタンスを作成します。現在の CastSession から RemoteMediaClient を取得し、その RemoteMediaClient に MediaInfo を読み込みます。RemoteMediaClient を使用して、ウェブレシーバで実行されているメディアプレーヤーアプリを再生、一時停止、またはその他の方法で制御します。

Kotlin

val mediaInfo = MediaInfo.Builder(mSelectedMedia.getUrl())
    .setStreamType(MediaInfo.STREAM_TYPE_BUFFERED)
    .setContentType("videos/mp4")
    .setMetadata(movieMetadata)
    .setStreamDuration(mSelectedMedia.getDuration() * 1000)
    .build()
val remoteMediaClient = mCastSession.getRemoteMediaClient()
remoteMediaClient.load(MediaLoadRequestData.Builder().setMediaInfo(mediaInfo).build())

Java

MediaInfo mediaInfo = new MediaInfo.Builder(mSelectedMedia.getUrl())
        .setStreamType(MediaInfo.STREAM_TYPE_BUFFERED)
        .setContentType("videos/mp4")
        .setMetadata(movieMetadata)
        .setStreamDuration(mSelectedMedia.getDuration() * 1000)
        .build();
RemoteMediaClient remoteMediaClient = mCastSession.getRemoteMediaClient();
remoteMediaClient.load(new MediaLoadRequestData.Builder().setMediaInfo(mediaInfo).build());

メディアトラックの使用に関するセクションもご覧ください。

4K 動画形式

メディアの動画形式を確認するには、MediaStatus の getVideoInfo() を使用して VideoInfo の現在のインスタンスを取得します。このインスタンスには、HDR TV 形式のタイプとディスプレイの高さと幅（ピクセル単位）が含まれています。4K 形式のバリエーションは、定数 HDR_TYPE_* で示されます。

複数のデバイスへのリモートコントロール通知

ユーザーがキャストすると、同じネットワーク上の他の Android デバイスにも通知が届き、再生も操作できるようになります。このような通知を受け取ったデバイスのユーザーは、Google > [設定] > [Google Cast] > [リモコンの通知の表示] でそのデバイスの通知をオフにできます。（通知には設定アプリのショートカットが含まれています）。詳しくは、リモコンの通知をご覧ください。

ミニコントローラを追加

キャストデザインチェックリストによれば、送信アプリは、ユーザーが現在のコンテンツページから離れて送信者アプリの別の場所に移動したときに表示される「ミニコントローラ」と呼ばれる永続的なコントロールを提供する必要があります。ミニコントローラは、現在のキャストセッションのリマインダーをユーザーに表示します。ミニコントローラをタップすると、全画面表示の展開されたコントローラビューに戻ることができます。

フレームワークには、カスタム View である MiniControllerFragment が用意されています。これは、ミニコントローラを表示する各アクティビティのレイアウトファイルの下部に追加できます。

<fragment
    android:id="@+id/castMiniController"
    android:layout_width="fill_parent"
    android:layout_height="wrap_content"
    android:layout_alignParentBottom="true"
    android:visibility="gone"
    class="com.google.android.gms.cast.framework.media.widget.MiniControllerFragment" />

送信側アプリが動画や音声のライブ配信を再生すると、SDK はミニコントローラの再生/一時停止ボタンの代わりに再生/停止ボタンを自動的に表示します。

このカスタムビューのタイトルとサブタイトルのテキスト表示を設定し、ボタンを選択するには、ミニコントローラをカスタマイズするをご覧ください。

拡張コントローラを追加

Google Cast デザインチェックリストでは、送信側アプリがキャスト対象のメディアに拡張コントローラを提供する必要があります。展開されたコントローラは、ミニコントローラの全画面バージョンです。

Cast SDK には、拡張コントローラの ExpandedControllerActivity というウィジェットが用意されています。これは、キャストアイコンを追加するためにサブクラス化する必要がある抽象クラスです。

まず、拡張コントローラの新しいメニューリソースファイルを作成して、キャストアイコンを提供します。

<menu xmlns:android="http://schemas.android.com/apk/res/android"
      xmlns:app="http://schemas.android.com/apk/res-auto">

    <item
            android:id="@+id/media_route_menu_item"
            android:title="@string/media_route_menu_title"
            app:actionProviderClass="androidx.mediarouter.app.MediaRouteActionProvider"
            app:showAsAction="always"/>

</menu>

ExpandedControllerActivity を拡張する新しいクラスを作成します。

Kotlin

class ExpandedControlsActivity : ExpandedControllerActivity() {
    override fun onCreateOptionsMenu(menu: Menu): Boolean {
        super.onCreateOptionsMenu(menu)
        menuInflater.inflate(R.menu.expanded_controller, menu)
        CastButtonFactory.setUpMediaRouteButton(this, menu, R.id.media_route_menu_item)
        return true
    }
}

Java

public class ExpandedControlsActivity extends ExpandedControllerActivity {
    @Override
    public boolean onCreateOptionsMenu(Menu menu) {
        super.onCreateOptionsMenu(menu);
        getMenuInflater().inflate(R.menu.expanded_controller, menu);
        CastButtonFactory.setUpMediaRouteButton(this, menu, R.id.media_route_menu_item);
        return true;
    }
}

次に、アプリマニフェストで application タグ内の新しいアクティビティを宣言します。

<application>
...
<activity
        android:name=".expandedcontrols.ExpandedControlsActivity"
        android:label="@string/app_name"
        android:launchMode="singleTask"
        android:theme="@style/Theme.CastVideosDark"
        android:screenOrientation="portrait"
        android:parentActivityName="com.google.sample.cast.refplayer.VideoBrowserActivity">
    <intent-filter>
        <action android:name="android.intent.action.MAIN"/>
    </intent-filter>
</activity>
...
</application>

CastOptionsProvider を編集して、NotificationOptions と CastMediaOptions を変更し、ターゲットアクティビティを新しいアクティビティに設定します。

Kotlin

override fun getCastOptions(context: Context): CastOptions? {
    val notificationOptions = NotificationOptions.Builder()
        .setTargetActivityClassName(ExpandedControlsActivity::class.java.name)
        .build()
    val mediaOptions = CastMediaOptions.Builder()
        .setNotificationOptions(notificationOptions)
        .setExpandedControllerActivityClassName(ExpandedControlsActivity::class.java.name)
        .build()

    return CastOptions.Builder()
        .setReceiverApplicationId(context.getString(R.string.app_id))
        .setCastMediaOptions(mediaOptions)
        .build()
}

Java

public CastOptions getCastOptions(Context context) {
    NotificationOptions notificationOptions = new NotificationOptions.Builder()
            .setTargetActivityClassName(ExpandedControlsActivity.class.getName())
            .build();
    CastMediaOptions mediaOptions = new CastMediaOptions.Builder()
            .setNotificationOptions(notificationOptions)
            .setExpandedControllerActivityClassName(ExpandedControlsActivity.class.getName())
            .build();

    return new CastOptions.Builder()
            .setReceiverApplicationId(context.getString(R.string.app_id))
            .setCastMediaOptions(mediaOptions)
            .build();
}

リモートメディアが読み込まれたときに新しいアクティビティを表示するように、LocalPlayerActivity loadRemoteMedia メソッドを更新します。

Kotlin

private fun loadRemoteMedia(position: Int, autoPlay: Boolean) {
    val remoteMediaClient = mCastSession?.remoteMediaClient ?: return

    remoteMediaClient.registerCallback(object : RemoteMediaClient.Callback() {
        override fun onStatusUpdated() {
            val intent = Intent(this@LocalPlayerActivity, ExpandedControlsActivity::class.java)
            startActivity(intent)
            remoteMediaClient.unregisterCallback(this)
        }
    })

    remoteMediaClient.load(
        MediaLoadRequestData.Builder()
            .setMediaInfo(mSelectedMedia)
            .setAutoplay(autoPlay)
            .setCurrentTime(position.toLong()).build()
    )
}

Java

private void loadRemoteMedia(int position, boolean autoPlay) {
    if (mCastSession == null) {
        return;
    }
    final RemoteMediaClient remoteMediaClient = mCastSession.getRemoteMediaClient();
    if (remoteMediaClient == null) {
        return;
    }
    remoteMediaClient.registerCallback(new RemoteMediaClient.Callback() {
        @Override
        public void onStatusUpdated() {
            Intent intent = new Intent(LocalPlayerActivity.this, ExpandedControlsActivity.class);
            startActivity(intent);
            remoteMediaClient.unregisterCallback(this);
        }
    });
    remoteMediaClient.load(new MediaLoadRequestData.Builder()
            .setMediaInfo(mSelectedMedia)
            .setAutoplay(autoPlay)
            .setCurrentTime(position).build());
}

送信側アプリが動画または音声のライブストリームを再生すると、SDK で展開されたコントローラの再生/一時停止ボタンの代わりに、再生/停止ボタンが自動的に表示されます。

テーマを使用して外観を設定するには、表示するボタンを選択し、カスタムボタンを追加します。拡張コントローラをカスタマイズするをご覧ください。

音量調節

このフレームワークでは、送信側アプリのボリュームが自動的に管理されます。フレームワークにより、送信側アプリとウェブ受信側アプリが自動的に同期されるため、送信側 UI は常に、送信側アプリが指定したボリュームを受信します。

物理ボタンの音量調節

Android では、Jelly Bean 以降を搭載したすべてのデバイスで、送信側のデバイスの物理ボタンを使用して、ウェブレシーバーでのキャストセッションの音量をデフォルトで変更できます。

Jelly Bean 以前の物理ボタンの音量コントロール

Jelly Bean より前の Android デバイスで Web Receiver デバイスの音量を制御するには、送信側のアプリでアクティビティ内の dispatchKeyEvent をオーバーライドして CastContext.onDispatchVolumeKeyEventBeforeJellyBean() を呼び出す必要があります。

Kotlin

class MyActivity : FragmentActivity() {
    override fun dispatchKeyEvent(event: KeyEvent): Boolean {
        return (CastContext.getSharedInstance(this)
            .onDispatchVolumeKeyEventBeforeJellyBean(event)
                || super.dispatchKeyEvent(event))
    }
}

Java

class MyActivity extends FragmentActivity {
    @Override
    public boolean dispatchKeyEvent(KeyEvent event) {
        return CastContext.getSharedInstance(this)
            .onDispatchVolumeKeyEventBeforeJellyBean(event)
            || super.dispatchKeyEvent(event);
    }
}

通知とロック画面にメディアコントロールを追加する

Google Cast デザインチェックリストの Android では、送信者アプリは通知にメディアコントロールを実装する必要があります。また、ロック画面で、送信者がキャストしているが送信者アプリがフォーカスされていないことを確認します。このフレームワークには、送信側アプリが通知やロック画面でメディアコントロールを作成できるように、MediaNotificationService と MediaIntentReceiver が用意されています。

MediaNotificationService は、送信者がキャストしているときに実行され、画像のサムネイル、現在のキャストアイテムに関する情報、再生/一時停止ボタン、停止ボタンとともに通知を表示します。

MediaIntentReceiver は、通知からのユーザーアクションを処理する BroadcastReceiver です。

アプリは、NotificationOptions を介してロック画面から通知とメディアコントロールを構成できます。アプリでは、通知に表示するコントロールボタンと、ユーザーが通知をタップしたときに開く Activity を設定できます。アクションが明示的に指定されていない場合は、デフォルト値の MediaIntentReceiver.ACTION_TOGGLE_PLAYBACK と MediaIntentReceiver.ACTION_STOP_CASTING が使用されます。

Kotlin

// Example showing 4 buttons: "rewind", "play/pause", "forward" and "stop casting".
val buttonActions: MutableList<String> = ArrayList()
buttonActions.add(MediaIntentReceiver.ACTION_REWIND)
buttonActions.add(MediaIntentReceiver.ACTION_TOGGLE_PLAYBACK)
buttonActions.add(MediaIntentReceiver.ACTION_FORWARD)
buttonActions.add(MediaIntentReceiver.ACTION_STOP_CASTING)

// Showing "play/pause" and "stop casting" in the compat view of the notification.
val compatButtonActionsIndices = intArrayOf(1, 3)

// Builds a notification with the above actions. Each tap on the "rewind" and "forward" buttons skips 30 seconds.
// Tapping on the notification opens an Activity with class VideoBrowserActivity.
val notificationOptions = NotificationOptions.Builder()
    .setActions(buttonActions, compatButtonActionsIndices)
    .setSkipStepMs(30 * DateUtils.SECOND_IN_MILLIS)
    .setTargetActivityClassName(VideoBrowserActivity::class.java.name)
    .build()

Java

// Example showing 4 buttons: "rewind", "play/pause", "forward" and "stop casting".
List<String> buttonActions = new ArrayList<>();
buttonActions.add(MediaIntentReceiver.ACTION_REWIND);
buttonActions.add(MediaIntentReceiver.ACTION_TOGGLE_PLAYBACK);
buttonActions.add(MediaIntentReceiver.ACTION_FORWARD);
buttonActions.add(MediaIntentReceiver.ACTION_STOP_CASTING);

// Showing "play/pause" and "stop casting" in the compat view of the notification.
int[] compatButtonActionsIndices = new int[]{1, 3};

// Builds a notification with the above actions. Each tap on the "rewind" and "forward" buttons skips 30 seconds.
// Tapping on the notification opens an Activity with class VideoBrowserActivity.
NotificationOptions notificationOptions = new NotificationOptions.Builder()
    .setActions(buttonActions, compatButtonActionsIndices)
    .setSkipStepMs(30 * DateUtils.SECOND_IN_MILLIS)
    .setTargetActivityClassName(VideoBrowserActivity.class.getName())
    .build();

通知とロック画面からのメディアコントロールの表示はデフォルトでオンになっています。無効にするには、CastMediaOptions.Builder の null を指定して setNotificationOptions を呼び出します。現在のところ、ロック画面機能を有効にするには、通知がオンになっている必要があります。

Kotlin

// ... continue with the NotificationOptions built above
val mediaOptions = CastMediaOptions.Builder()
    .setNotificationOptions(notificationOptions)
    .build()
val castOptions: CastOptions = Builder()
    .setReceiverApplicationId(context.getString(R.string.app_id))
    .setCastMediaOptions(mediaOptions)
    .build()

Java

// ... continue with the NotificationOptions built above
CastMediaOptions mediaOptions = new CastMediaOptions.Builder()
        .setNotificationOptions(notificationOptions)
        .build();
CastOptions castOptions = new CastOptions.Builder()
        .setReceiverApplicationId(context.getString(R.string.app_id))
        .setCastMediaOptions(mediaOptions)
        .build();

送信側アプリが動画や音声のライブストリームを再生する場合、SDK は通知コントロールの再生/一時停止ボタンの代わりに再生/停止ボタンを自動的に表示しますが、ロック画面コントロールは表示しません。

注: Lollipop 以前のデバイスにロック画面コントロールを表示する場合、RemoteMediaClient は自動的に音声フォーカスをリクエストします。

エラーを処理する

送信者のアプリがすべてのエラーコールバックを処理し、キャストライフサイクルの各ステージに最適なレスポンスを決定することは、非常に重要です。アプリでは、ユーザーにエラーダイアログを表示するか、ウェブレシーバへの接続を破棄するかどうかを決定できます。

データセーフティセクション

UI のカスタマイズ

キャストを Android アプリに統合する

アプリケーションの流れ

Android マニフェストを構成する

uses-sdk

android:theme

キャスト コンテキストを初期化する

キャスト UX ウィジェット

キャスト アイコンを追加する

デバイスの検出を構成する

セッション管理の仕組み

ストリーミング転送

自動再接続

メディア コントロールの仕組み

メディア メタデータの設定

メディアを読み込む

4K 動画形式

複数のデバイスへのリモート コントロール通知

ミニ コントローラを追加

拡張コントローラを追加

音量調節

物理ボタンの音量調節

Jelly Bean 以前の物理ボタンの音量コントロール

通知とロック画面にメディア コントロールを追加する

エラーを処理する

キャストコンテキストを初期化する

キャストアイコンを追加する

メディアコントロールの仕組み

メディアメタデータの設定

複数のデバイスへのリモートコントロール通知

ミニコントローラを追加

通知とロック画面にメディアコントロールを追加する