Leanback 転送コントロールを使用する

Leanback AndroidX ライブラリには、ユーザー エクスペリエンスを改善する新しい再生コントロールが用意されています。動画アプリの場合、トランスポート コントロールは、前方/後方コントロールによる動画スクラブをサポートしています。スクラブ中は、動画内を移動しやすいようにサムネイルが表示されます。

このライブラリには抽象クラスとすぐに使用できる実装が含まれており、デベロッパーはきめ細かな制御を実現できます。ビルド済みの実装を使用すると、多くのコーディングを行うことなく、機能豊富なアプリをすばやく構築できます。詳細なカスタマイズが必要な場合は、ライブラリのビルド済みコンポーネントを拡張できます。

コントロールとプレーヤー

Leanback ライブラリは、トランスポート コントロールを備えた UI と、動画を再生するプレーヤーを分離します。これは、トランスポート コントロール（および必要に応じて動画）を表示する再生サポート フラグメントと、メディア プレーヤーをカプセル化するプレーヤー アダプターの 2 つのコンポーネントで実現されます。

再生フラグメント

アプリの UI アクティビティでは、PlaybackSupportFragment または VideoSupportFragment を使用する必要があります。そのどちらにも Leanback トランスポート コントロールが含まれています。

• PlaybackSupportFragment は、トランスポート コントロールをアニメーション化し、必要に応じて表示 / 非表示を切り替えます。
• VideoSupportFragment は PlaybackSupportFragment を拡張したもので、動画をレンダリングする SurfaceView を備えています。

フラグメントの ObjectAdapter をカスタマイズして UI を強化できます。たとえば、「関連動画」行を追加するには、setAdapter() を使用します。

PlayerAdapter

PlayerAdapter は、基盤となるメディア プレーヤーを制御する抽象クラスです。デベロッパーは、ビルド済みの MediaPlayerAdapter 実装を選択するか、このクラスの独自の実装を作成できます。

フラグメントを接着する

再生フラグメントをプレーヤーに接続するには、「コントロール用接着剤」を使用する必要があります。Leanback ライブラリには 2 種類の接着剤が用意されています。

• PlaybackBannerControlGlue は、再生フラグメントにトランスポート コントロールを「以前のスタイル」で描画し、不透明な背景内に配置します。（PlaybackBannerControlGlue は、サポートが終了した PlaybackControlGlue に代わるものです）。
• PlaybackTransportControlGlue は、透明な背景を持つ「新しいスタイル」のコントロールを使用します。

アプリで動画スクラブをサポートするには、PlaybackTransportControlGlue を使用する必要があります。

また、「グルーホスト」を指定する必要があります。このホストは、グルーを再生フラグメントにバインドし、UI にトランスポート コントロールを描画してその状態を保持し、トランスポート コントロール イベントをグルーに戻す必要があります。ホストは、再生フラグメントのタイプに適合する必要があります。PlaybackSupportFragmentGlueHost を PlaybackFragment とともに使用し、VideoSupportFragmentGlueHost を VideoFragment とともに使用します。

次の図は、Leanback トランスポート コントロールの各要素がどのように連携するかを示しています。

アプリを接着するコードは、UI を定義する PlaybackSupportFragment または VideoSupportFragment 内に配置する必要があります。

次の例では、アプリは PlaybackTransportControlGlue のインスタンスを作成し、playerGlue という名前を付けて、その VideoSupportFragment を新しく作成された MediaPlayerAdapter に接続します。これは VideoSupportFragment であるため、セットアップ コードは setHost() を呼び出して VideoSupportFragmentGlueHost を playerGlue にアタッチします。コードは、VideoSupportFragment を拡張するクラス内に含まれています。

class MyVideoFragment : VideoSupportFragment() {

  fun onCreate(savedInstanceState: Bundle) {
      super.onCreate(savedInstanceState)
      val playerGlue = PlaybackTransportControlGlue(getActivity(),
          MediaPlayerAdapter(getActivity()))
      playerGlue.setHost(VideoSupportFragmentGlueHost(this))
      playerGlue.addPlayerCallback(object : PlaybackGlue.PlayerCallback() {
          override fun onPreparedStateChanged(glue: PlaybackGlue) {
              if (glue.isPrepared()) {
                  playerGlue.seekProvider = MySeekProvider()
                  playerGlue.play()
              }
          }
      })
      playerGlue.setSubtitle("Leanback artist")
      playerGlue.setTitle("Leanback team at work")
      val uriPath = "android.resource://com.example.android.leanback/raw/video"
      playerGlue.getPlayerAdapter().setDataSource(Uri.parse(uriPath))
  }
}

public class MyVideoFragment extends VideoSupportFragment {

  @Override
  public void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      final PlaybackTransportControlGlue<MediaPlayerAdapter> playerGlue =
              new PlaybackTransportControlGlue(getActivity(),
                      new MediaPlayerAdapter(getActivity()));
      playerGlue.setHost(new VideoSupportFragmentGlueHost(this));
      playerGlue.addPlayerCallback(new PlaybackGlue.PlayerCallback() {
          @Override
          public void onPreparedStateChanged(PlaybackGlue glue) {
              if (glue.isPrepared()) {
                  playerGlue.setSeekProvider(new MySeekProvider());
                  playerGlue.play();
              }
          }
      });
      playerGlue.setSubtitle("Leanback artist");
      playerGlue.setTitle("Leanback team at work");
      String uriPath = "android.resource://com.example.android.leanback/raw/video";
      playerGlue.getPlayerAdapter().setDataSource(Uri.parse(uriPath));
  }
}

セットアップ コードでは、メディア プレーヤーからのイベントを処理する PlayerAdapter.Callback も定義しています。

UI 用接着剤をカスタマイズする

PlaybackBannerControlGlue と PlaybackTransportControlGlue をカスタマイズして PlaybackControlsRow を変更できます。

タイトルと説明をカスタマイズする

再生コントロールの上部にあるタイトルと説明をカスタマイズするには、onCreateRowPresenter() をオーバーライドします。

override fun onCreateRowPresenter(): PlaybackRowPresenter {
    return super.onCreateRowPresenter().apply {
        (this as? PlaybackTransportRowPresenter)
                ?.setDescriptionPresenter(MyCustomDescriptionPresenter())
    }
}

@Override
protected PlaybackRowPresenter onCreateRowPresenter() {
  PlaybackTransportRowPresenter presenter = (PlaybackTransportRowPresenter) super.onCreateRowPresenter();
  presenter.setDescriptionPresenter(new MyCustomDescriptionPresenter());
  return presenter;
}

コントロールを追加する

コントロール用接着剤は、PlaybackControlsRow 内のアクションのコントロールを表示します。

PlaybackControlsRow 内のアクションは、プライマリ アクションとセカンダリ アクションの 2 つのグループに割り当てられます。プライマリ グループのコントロールはシークバーの上に表示され、セカンダリ グループのコントロールはシークバーの下に表示されます。最初は、再生/一時停止ボタンのプライマリ アクションは 1 つのみで、セカンダリ アクションはありません。

プライマリ グループとセカンダリ グループにアクションを追加するには、onCreatePrimaryActions() と onCreateSecondaryActions() をオーバーライドします。

private lateinit var repeatAction: PlaybackControlsRow.RepeatAction
private lateinit var pipAction: PlaybackControlsRow.PictureInPictureAction
private lateinit var thumbsUpAction: PlaybackControlsRow.ThumbsUpAction
private lateinit var thumbsDownAction: PlaybackControlsRow.ThumbsDownAction
private lateinit var skipPreviousAction: PlaybackControlsRow.SkipPreviousAction
private lateinit var skipNextAction: PlaybackControlsRow.SkipNextAction
private lateinit var fastForwardAction: PlaybackControlsRow.FastForwardAction
private lateinit var rewindAction: PlaybackControlsRow.RewindAction

override fun onCreatePrimaryActions(primaryActionsAdapter: ArrayObjectAdapter) {
    // Order matters, super.onCreatePrimaryActions() will create the play / pause action.
    // Will display as follows:
    // play/pause, previous, rewind, fast forward, next
    //   > /||      |<        <<        >>         >|
    super.onCreatePrimaryActions(primaryActionsAdapter)
    primaryActionsAdapter.apply {
        add(skipPreviousAction)
        add(rewindAction)
        add(fastForwardAction)
        add(skipNextAction)
    }
}

override fun onCreateSecondaryActions(adapter: ArrayObjectAdapter?) {
    super.onCreateSecondaryActions(adapter)
    adapter?.apply {
        add(thumbsDownAction)
        add(thumbsUpAction)
    }
}

private PlaybackControlsRow.RepeatAction repeatAction;
private PlaybackControlsRow.PictureInPictureAction pipAction;
private PlaybackControlsRow.ThumbsUpAction thumbsUpAction;
private PlaybackControlsRow.ThumbsDownAction thumbsDownAction;
private PlaybackControlsRow.SkipPreviousAction skipPreviousAction;
private PlaybackControlsRow.SkipNextAction skipNextAction;
private PlaybackControlsRow.FastForwardAction fastForwardAction;
private PlaybackControlsRow.RewindAction rewindAction;

@Override
protected void onCreatePrimaryActions(ArrayObjectAdapter primaryActionsAdapter) {
    // Order matters, super.onCreatePrimaryActions() will create the play / pause action.
    // Will display as follows:
    // play/pause, previous, rewind, fast forward, next
    //   > /||      |<        <<        >>         >|
    super.onCreatePrimaryActions(primaryActionsAdapter);
    primaryActionsAdapter.add(skipPreviousAction);
    primaryActionsAdapter.add(rewindAction);
    primaryActionsAdapter.add(fastForwardAction);
    primaryActionsAdapter.add(skipNextAction);
}

@Override
protected void onCreateSecondaryActions(ArrayObjectAdapter adapter) {
    super.onCreateSecondaryActions(adapter);
    adapter.add(thumbsDownAction);
    adapter.add(thumbsUpAction);
}

新しいアクションを処理するには、onActionClicked() をオーバーライドする必要があります。

override fun onActionClicked(action: Action) {
    when(action) {
        rewindAction -> {
            // Handle Rewind
        }
        fastForwardAction -> {
            // Handle FastForward
        }
        thumbsDownAction -> {
            // Handle ThumbsDown
        }
        thumbsUpAction -> {
            // Handle ThumbsUp
        }
        else ->
            // The superclass handles play/pause and delegates next/previous actions to abstract methods,
            // so those two methods should be overridden rather than handling the actions here.
            super.onActionClicked(action)
    }
}

override fun next() {
    // Skip to next item in playlist.
}

override fun previous() {
    // Skip to previous item in playlist.
}

@Override
public void onActionClicked(Action action) {
    if (action == rewindAction) {
        // Handle Rewind
    } else if (action == fastForwardAction ) {
        // Handle FastForward
    } else if (action == thumbsDownAction) {
        // Handle ThumbsDown
    } else if (action == thumbsUpAction) {
        // Handle ThumbsUp
    } else {
        // The superclass handles play/pause and delegates next/previous actions to abstract methods,
        // so those two methods should be overridden rather than handling the actions here.
        super.onActionClicked(action);
    }
}

@Override
public void next() {
    // Skip to next item in playlist.
}

@Override
public void previous() {
    // Skip to previous item in playlist.
}

特殊なケースでは、独自の PlaybackTransportRowPresenter を実装してカスタム コントロールをレンダリングし、PlaybackSeekUi を使用してシーク操作に応答できます。

動画スクラブ

アプリで VideoSupportFragment を使用している場合は、動画スクラブをサポートすることをおすすめします。

PlaybackSeekDataProvider の実装を指定する必要があります。このコンポーネントは、スクロール時に使用する動画のサムネイルを提供します。PlaybackSeekDataProvider を拡張して独自のプロバイダを実装する必要があります。 Leanback Showcase アプリの例をご覧ください。