UI のカスタマイズ

Media3 には、いくつかのカスタマイズ オプションを提供するデフォルトの PlayerView が用意されています。

ドローアブルをオーバーライドする

PlayerView は PlayerControlView を使用して、再生コントロールと進行状況バーを表示します。PlayerControlView で使用されるドローアブルは、アプリで定義されている同じ名前のドローアブルでオーバーライドできます。オーバーライド可能なコントロール ドローアブルのリストについては、PlayerControlView のドキュメントをご覧ください。

さらにカスタマイズする場合は、アプリ デベロッパーが独自の UI コンポーネントを実装する必要があります。ただし、ここでは、開始に役立つベスト プラクティスをいくつか紹介します。

ベスト プラクティス

Media3 Player（ExoPlayer、MediaController、カスタム Player 実装など）に接続するメディア UI を実装する場合は、最適な UI エクスペリエンスを実現するために、以下のベスト プラクティスに沿ってアプリを実装することをおすすめします。

再生 / 一時停止ボタン

再生ボタンと一時停止ボタンは、1 つのプレーヤーの状態に直接対応していません。たとえば、プレーヤーが一時停止されていない場合でも、再生が終了または失敗した後にユーザーが再生を再開できるようにする必要があります。

実装を簡素化するため、Media3 には、表示するボタンを決定するユーティリティ メソッド（Util.shouldShowPlayButton）と、ボタンの押下を処理するユーティリティ メソッド（Util.handlePlayPauseButtonAction）が用意されています。

Kotlin

val shouldShowPlayButton: Boolean = Util.shouldShowPlayButton(player)
playPauseButton.setImageDrawable(if (shouldShowPlayButton) playDrawable else pauseDrawable)
playPauseButton.setOnClickListener { Util.handlePlayPauseButtonAction(player) }

Java

boolean shouldShowPlayButton = Util.shouldShowPlayButton(player);
playPauseButton.setImageDrawable(shouldShowPlayButton ? playDrawable : pauseDrawable);
playPauseButton.setOnClickListener(view -> Util.handlePlayPauseButtonAction(player));

状態の更新をリッスンする

UI コンポーネントは、対応する UI の更新を必要とする状態変更を通知されるように、Player.Listener を追加する必要があります。詳しくは、再生イベントをリッスンするをご覧ください。

UI の更新にはコストがかかることがあり、複数のプレーヤー イベントが同時に発生することもよくあります。短期間に UI が頻繁に更新されないようにするには、一般的に、onEvents のみをリッスンして、そこから UI の更新をトリガーすることをおすすめします。

Kotlin

player.addListener(
  object : Player.Listener {
    override fun onEvents(player: Player, events: Player.Events) {
      if (
        events.containsAny(
          Player.EVENT_PLAY_WHEN_READY_CHANGED,
          Player.EVENT_PLAYBACK_STATE_CHANGED,
          Player.EVENT_PLAYBACK_SUPPRESSION_REASON_CHANGED,
        )
      ) {
        updatePlayPauseButton()
      }
      if (events.containsAny(Player.EVENT_REPEAT_MODE_CHANGED)) {
        updateRepeatModeButton()
      }
    }
  }
)

Java

player.addListener(
    new Player.Listener() {
      @Override
      public void onEvents(Player player, Player.Events events) {
        if (events.containsAny(
            Player.EVENT_PLAY_WHEN_READY_CHANGED,
            Player.EVENT_PLAYBACK_STATE_CHANGED,
            Player.EVENT_PLAYBACK_SUPPRESSION_REASON_CHANGED)) {
          updatePlayPauseButton();
        }
        if (events.containsAny(Player.EVENT_REPEAT_MODE_CHANGED)) {
          updateRepeatModeButton();
        }
      }
    });

利用可能なコマンドを処理する

さまざまな Player 実装で動作する必要がある汎用 UI コンポーネントは、利用可能なプレーヤー コマンドを確認して、ボタンの表示 / 非表示を切り替え、サポートされていないメソッドを呼び出さないようにする必要があります。

Kotlin

nextButton.isEnabled = player.isCommandAvailable(COMMAND_SEEK_TO_NEXT)

Java

nextButton.setEnabled(player.isCommandAvailable(COMMAND_SEEK_TO_NEXT));

最初のフレームのシャッターと画像表示

UI コンポーネントが動画や画像を表示する場合、通常は、実際の最初のフレームまたは画像が利用可能になるまで、プレースホルダのシャッター ビューを使用します。また、動画と画像の再生を混在させる場合は、適切なタイミングで画像ビューを非表示または表示にする必要があります。

これらの更新を処理する一般的なパターンは、選択したトラック（EVENT_TRACKS_CHANGED）の変更と、最初の動画フレームがレンダリングされたとき（EVENT_RENDERED_FIRST_FRAME）に Player.Listener.onEvents() をリッスンし、新しい画像が利用可能になったときに ImageOutput.onImageAvailable() をリッスンすることです。

Kotlin

override fun onEvents(player: Player, events: Player.Events) {
  if (events.contains(Player.EVENT_TRACKS_CHANGED)) {
    // If no video or image track: show shutter, hide image view.
    // Otherwise: do nothing to wait for first frame or image.
  }
  if (events.contains(Player.EVENT_RENDERED_FIRST_FRAME)) {
    // Hide shutter, hide image view.
  }
}

override fun onImageAvailable(presentationTimeUs: Long, bitmap: Bitmap) {
  // Show shutter, set image and show image view.
}

Java

@Override
public void onEvents(Player player, Player.Events events) {
  if (events.contains(Player.EVENT_TRACKS_CHANGED)) {
    // If no video or image track: show shutter, hide image view.
    // Otherwise: do nothing to wait for first frame or image.
  }
  if (events.contains(Player.EVENT_RENDERED_FIRST_FRAME)) {
    // Hide shutter, hide image view.
  }
}

@Override
public void onImageAvailable(long presentationTimeUs, Bitmap bitmap) {
  // Show shutter, set image and show image view.
}

スクラバーとシークバーのコントロール

ExoPlayer インスタンスに接続するカスタム シークバーまたはスクラバーを実装する場合は、ユーザーがスクラバーのつまみをドラッグし始めたときに ExoPlayer.setScrubbingModeEnabled でスクラブモードを有効にし、ドラッグ中に Player.seekTo の更新をディスパッチして、ジェスチャーが終了またはキャンセルされたらすぐにスクラブモードを無効にします。通常の再生中や単一のシーク中にスクラブモードを有効にしたままにすると、再生が抑制され、デコーダのリソース使用量が増加するため、有効にしたままにしないでください。

また、ScrubbingModeParameters.Builder.setFractionalSeekTolerance を使用して、UI スクラバーの幅から dp ベースの小数シーク許容値を構成することをおすすめします。これにより、ExoPlayer はスクラバーのタッチ精度内で近くのキーフレームにスナップできます。コード例と詳細については、スクラブモードをご覧ください。