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

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

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

モバイル デバイスやノートパソコンは再生側であり、Google Cast デバイスはテレビ受信側のコンテンツのレシーバーです。

送信者フレームワークとは、実行時に送信側に存在するキャスト クラス ライブラリ バイナリと関連リソースを指します。送信者アプリまたはキャストアプリは、同じく送信者で実行されているアプリを指します。ウェブ レシーバ アプリは、Cast 対応デバイスで動作する HTML アプリを指します。

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

アプリケーションの流れ

次の手順は、送信者の Android アプリの一般的な実行フローを示しています。

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

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

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 アプリでは、ユーザー インターフェースの一部としてキャスト アイコンを含める必要があります。これにより、ユーザーはキャスト デバイスなどのセカンダリ デバイスでメディアを再生するメディアルートを選択できます。

このフレームワークにより、MediaRouteButtonCast 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;
}

その後、ActivityFragmentActivity から継承している場合は、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 を指定し、必要に応じて CastOptionssupportedNamespaces を設定して名前空間フィルタリングをリクエストできます。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 のコンセプトは、キャスト セッションのコンセプトを導入したものです。このセッションでは、デバイスへの接続、Web Receiver アプリの起動(または参加)、アプリへの接続、メディア制御チャネルの初期化のステップが組み合わされます。キャスト セッションとウェブレシーバーのライフサイクルについて詳しくは、ウェブレシーバーのアプリケーション ライフサイクル ガイドをご覧ください。

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

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

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

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

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

    private inner class SessionManagerListenerImpl : SessionManagerListener<CastSession?> {
        override fun onSessionStarted(session: CastSession?, sessionId: String) {
            invalidateOptionsMenu()
        }

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

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

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        mSessionManager = CastContext.getSharedInstance(this).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 CastSession mCastSession;
    private SessionManager mSessionManager;
    private SessionManagerListener<CastSession> mSessionManagerListener =
            new SessionManagerListenerImpl();

    private class SessionManagerListenerImpl implements SessionManagerListener<CastSession> {
        @Override
        public void onSessionStarted(CastSession session, String sessionId) {
            invalidateOptionsMenu();
        }
        @Override
        public void onSessionResumed(CastSession session, boolean wasSuspended) {
            invalidateOptionsMenu();
        }
        @Override
        public void onSessionEnded(CastSession session, int error) {
            finish();
        }
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        mSessionManager = CastContext.getSharedInstance(this).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() を呼び出します。

詳細については、Web Receiver でのストリーム転送をご覧ください。

自動再接続

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

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

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

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

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

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

Cast フレームワークでは、Cast 2.x の RemoteMediaPlayer クラスが非推奨になり、新しい API RemoteMediaClient に置き換えられました。このクラスは、一連のより便利な API で同じ機能を提供し、GoogleApiClient を渡す必要がなくなります。

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

Web Receiver にリクエストを送信する 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 を取得し、その RemoteMediaClientMediaInfo を読み込みます。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] > [リモコンの通知を表示] で、その通知をオフにすることができます。 (通知には設定アプリへのショートカットが含まれています)。詳しくは、キャスト リモコンの通知をご覧ください。

ミニ コントローラを追加

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

フレームワークでは、カスタムビューである 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" />

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

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

拡張コントローラを追加

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 を編集して、NotificationOptionsCastMediaOptions を変更し、ターゲット アクティビティを新しいアクティビティに設定します。

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());
}

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

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

音量調節

フレームワークは、送信者アプリのボリュームを自動的に管理します。フレームワークは送信者アプリと Web Receiver アプリを自動的に同期するため、送信者 UI は常に Web Receiver で指定されたボリュームを報告します。

物理ボタンの音量コントロール

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

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

Jelly Bean より前の Android デバイスでウェブ レシーバの音量を調整するには、物理的な音量キーを使用する必要があります。送信アプリは、アクティビティ内の 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 デザイン チェックリストでは、送信者のアプリに通知へのメディア コントロールの実装ロック画面への送信が求められますが、送信者のキャストは行われていますが、送信者アプリはフォーカスされていません。フレームワークは MediaNotificationServiceMediaIntentReceiver を提供しており、送信者アプリは通知とロック画面でメディア コントロールを作成できます。

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

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

アプリは、NotificationOptions を介してロック画面から通知とメディア コントロールを構成できます。アプリは、通知に表示されるコントロール ボタンと、ユーザーが通知をタップしたときに開く Activity を構成できます。アクションを明示的に指定しない場合は、デフォルト値の MediaIntentReceiver.ACTION_TOGGLE_PLAYBACKMediaIntentReceiver.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();

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

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

エラーを処理する

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