CastPlayer のスタートガイド

CastPlayer は、ローカル再生とリモートの Cast 対応デバイスへのキャストの両方をサポートする Jetpack Media3 Player 実装です。CastPlayer を使用すると、アプリにキャスト機能を簡単に追加でき、ローカル再生とリモート再生をシームレスに切り替えるための豊富な機能を利用できます。このガイドでは、メディアアプリに CastPlayer を統合する方法について説明します。

Cast を他のプラットフォームと統合するには、Cast SDK をご覧ください。

CastPlayer を依存関係として追加する

CastPlayer の使用を開始するには、アプリ モジュールの build.gradle ファイルに必要な AndroidX Media3 と CastPlayer の依存関係を追加します。

Kotlin

implementation("androidx.media3:media3-exoplayer:1.9.0-alpha01")
implementation("androidx.media3:media3-ui:1.9.0-alpha01")
implementation("androidx.media3:media3-session:1.9.0-alpha01")
implementation("androidx.media3:media3-cast:1.9.0-alpha01")

Groovy

implementation "androidx.media3:media3-exoplayer:1.9.0-alpha01"
implementation "androidx.media3:media3-ui:1.9.0-alpha01"
implementation "androidx.media3:media3-session:1.9.0-alpha01"
implementation "androidx.media3:media3-cast:1.9.0-alpha01"

Jetpack Media のリリースノートを参照して、最新のアルファ版を見つけ、CastPlayer をアプリに統合してください。すべてのモジュールは同じバージョンである必要があります。

利用可能なライブラリ モジュールの詳細については、Google Maven AndroidX Media3 のページをご覧ください。

CastPlayer を構成する

CastPlayer を構成するには、オプション プロバイダを使用して AndroidManifest.xml ファイルを更新します。

オプション プロバイダ

CastPlayer には、その動作を構成するオプション プロバイダが必要です。基本的な設定では、AndroidManifest.xml ファイルに追加することで、デフォルトのオプション プロバイダを使用できます。これには、デフォルトのレシーバー アプリケーションを含むデフォルト設定が使用されます。

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

構成をカスタマイズするには、独自のカスタム OptionsProvider を実装します。方法については、CastOptions ガイドをご覧ください。

メディア転送用のレシーバを追加する

マニフェストに MediaTransferReceiver を追加すると、システム UI はアプリ アクティビティを開かずにメディアを再ルーティングできます。たとえば、ユーザーはメディア通知からアプリのメディアを再生するデバイスを変更できます。

<application>
  <receiver android:name="androidx.mediarouter.media.MediaTransferReceiver" />
</application>

CastPlayer をビルドする

Cast を使用したリモート再生の場合、アプリは、ユーザーがシステム メディア通知などを介してアプリのアクティビティを操作していない場合でも、再生を管理できる必要があります。そのため、ExoPlayer（ローカル再生用）と CastPlayer（リモート再生用）のインスタンスは、MediaSessionService や MediaLibraryService などのサービスで作成する必要があります。まず、ExoPlayer インスタンスを作成し、CastPlayer インスタンスの作成時に ExoPlayer をローカル プレーヤー インスタンスとして設定します。これにより、出力ルートがローカルからリモートに、またはリモートからローカルに変わったときに、Media3 でプレーヤーの転送を処理できるようになります。

Kotlin

override fun onCreate() {
  super.onCreate()

  val exoPlayer = ExoPlayer.Builder(context).build()
  val castPlayer = CastPlayer.Builder(context)
      .setLocalPlayer(exoPlayer)
      .build()

  mediaSession = MediaSession.Builder(context, castPlayer).build()
}

Java

@Override
public void onCreate() {
  super.onCreate();

  ExoPlayer exoPlayer = new ExoPlayer.Builder(context).build();
  CastPlayer castPlayer = new CastPlayer.Builder(context)
      .setLocalPlayer(exoPlayer)
      .build();

  mediaSession = new MediaSession.Builder(
    /* context= */ context, /* player= */ castPlayer).build();
}

UI 要素を追加する

アプリの UI に MediaRouteButton を追加して、ユーザーがキャスト デバイスを選択できるようにします。このセクションでは、ボタンを追加し、イベントをリッスンして、ローカル デバイスとリモート デバイス間で再生が切り替わったときに UI を更新する方法について説明します。

MediaRouteButton を設定する

ユーザーが操作できるように、アクティビティの UI に MediaRouteButton を追加する方法は 4 つあります。どちらを選択するかは、プレーヤー アクティビティの UI をどのように表示し、動作させるかによって異なります。

コンポーザブルなメディアルート ボタンをプレーヤーに追加する

MediaRouteButton コンポーザブルをプレーヤーの UI に追加できます。詳細については、コンポーズ ガイドをご覧ください。

Kotlin

import androidx.compose.animation.AnimatedVisibility
import androidx.compose.animation.fadeIn
import androidx.compose.animation.fadeOut
import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier
import androidx.media3.cast.MediaRouteButton

@Composable
fun PlayerComposeView(player: Player, modifier: Modifier = Modifier) {
  var controlsVisible by remember { mutableStateOf(false) }

  Box(
    modifier = modifier.clickable { controlsVisible = true },
    contentAlignment = Alignment.Center,
  ) {
    PlayerSurface(player = player, modifier = modifier)
    AnimatedVisibility(visible = controlsVisible, enter = fadeIn(), exit = fadeOut()) {
      Box(modifier = Modifier.fillMaxSize()) {
        MediaRouteButton(modifier = Modifier.align(Alignment.TopEnd))
        PrimaryControls(player = player, modifier = Modifier.align(Alignment.Center))
      }
    }
  }
}

@Composable
fun PrimaryControls(player: Player, modifier: Modifier = Modifier) {
  ...
}

メディアルート ボタンを PlayerView に追加する

MediaRouteButton は PlayerView の UI コントロール内で直接追加できます。PlayerView のプレーヤーとして MediaController を設定したら、MediaRouteButtonViewProvider を指定して、プレーヤーにキャスト ボタンを表示します。

Kotlin

override fun onStart() {
  super.onStart()

  playerView.player = mediaController
  playerView.setMediaRouteButtonViewProvider(MediaRouteButtonViewProvider())
}

Java

@Override
public void onStart() {
  super.onStart();

  playerView.setPlayer(mediaController);
  playerView.setMediaRouteButtonViewProvider(new MediaRouteButtonViewProvider());
}

メディアルート ボタンをアプリバーのメニューに追加する

このメソッドは、アプリバーのメニューにメディアルート ボタンを設定します。このスタイルのボタンを表示するには、マニフェスト ファイルと Activity の両方を更新する必要があります。

<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:showAsAction="always"
    app:actionProviderClass="androidx.mediarouter.app.MediaRouteActionProvider"/>
</menu>

Kotlin

override fun onCreateOptionsMenu(menu: Menu): Boolean {
    ...
    menuInflater.inflate(R.menu.sample_media_route_button_menu, menu)
    val menuItemFuture: ListenableFuture<MenuItem> =
        MediaRouteButtonFactory.setUpMediaRouteButton(
            context, menu, R.id.media_route_menu_item)
    Futures.addCallback(
        menuItemFuture,
        object : FutureCallback<MenuItem> {
            override fun onSuccess(menuItem: MenuItem?) {
                // Do something with the menu item.
            }

            override fun onFailure(t: Throwable) {
                // Handle the failure.
            }
        },
        executor)
    ...
}

Java

@Override
public boolean onCreateOptionsMenu(Menu menu) {
    ...
    getMenuInflater().inflate(R.menu.sample_media_route_button_menu, menu);
    ListenableFuture<MenuItem> menuItemFuture =
        MediaRouteButtonFactory.setUpMediaRouteButton(
          context, menu, R.id.media_route_menu_item);
    Futures.addCallback(
        menuItemFuture,
        new FutureCallback<MenuItem>() {
          @Override
          public void onSuccess(MenuItem menuItem) {
            // Do something with the menu item.
          }

          @Override
          public void onFailure(Throwable t) {
            // Handle the failure.
          }
        },
        executor);
    ...
}

メディアルート ボタンを View として追加する

または、アクティビティの layout.xml で MediaRouteButton を設定することもできます。MediaRouteButton の設定を完了するには、Activity コードで Media3 Cast MediaRouteButtonFactory を使用します。

Kotlin

override fun onCreate(savedInstanceState: Bundle?) {
  super.onCreate(savedInstanceState)

  findViewById<MediaRouteButton>(R.id.media_route_button)?.also {
    val unused = MediaRouteButtonFactory.setUpMediaRouteButton(context, it)
  }
}

Java

@Override
public void onCreate(Bundle savedInstanceState) {
    ...
    MediaRouteButton button = findViewById(R.id.media_route_button);
    ListenableFuture<Void> setUpFuture =
        MediaRouteButtonFactory.setUpMediaRouteButton(context, button);
}

アクティビティ リスナー

Activity で Player.Listener を作成して、メディア再生位置の変更をリッスンします。playbackType が PLAYBACK_TYPE_LOCAL と PLAYBACK_TYPE_REMOTE の間で変化するときに、必要に応じて UI を調整できます。メモリリークを防ぎ、リスナー アクティビティをアプリが表示されているときのみに制限するには、onStart でリスナーを登録し、onStop で登録を解除します。

Kotlin

import androidx.media3.common.DeviceInfo
import androidx.media3.common.Player

private val playerListener: Player.Listener =
  object : Player.Listener {
    override fun onDeviceInfoChanged(deviceInfo: DeviceInfo) {
      if (deviceInfo.playbackType == DeviceInfo.PLAYBACK_TYPE_LOCAL) {
        // Add UI changes for local playback.
      } else if (deviceInfo.playbackType == DeviceInfo.PLAYBACK_TYPE_REMOTE) {
        // Add UI changes for remote playback.
      }
    }
  }

override fun onStart() {
  super.onStart()
  mediaController.addListener(playerListener)
}

override fun onStop() {
  super.onStop()
  mediaController.removeListener(playerListener)
}

Java

import androidx.media3.common.DeviceInfo;
import androidx.media3.common.Player;

private Player.Listener playerListener =
    new Player.Listener() {
      @Override
      public void onDeviceInfoChanged(DeviceInfo deviceInfo) {
        if (deviceInfo.playbackType == DeviceInfo.PLAYBACK_TYPE_LOCAL) {
          // Add UI changes for local playback.
        } else if (deviceInfo.playbackType == DeviceInfo.PLAYBACK_TYPE_REMOTE) {
          // Add UI changes for remote playback.
        }
      }
    };

@Override
protected void onStart() {
  super.onStart();
  mediaController.addListener(playerListener);
}

@Override
protected void onStop() {
  super.onStop();
  mediaController.removeListener(playerListener);
}

再生イベントをリッスンして応答する方法について詳しくは、プレーヤー イベントのガイドをご覧ください。