UI のカスタマイズ

Media3 には、いくつかのカスタマイズ オプションを提供するデフォルトの PlayerView が用意されています。さらなるカスタマイズを行うには、アプリ デベロッパーが独自の UI コンポーネントを実装する必要があります。

おすすめの方法

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

再生/一時停止ボタン

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

実装を簡素化するために、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(Player.COMMAND_SEEK_TO_NEXT)

Java

nextButton.setEnabled(player.isCommandAvailable(Player.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, 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.
}