使用傳輸控制項

使用 Compose 建構更優質的內容
使用 Android TV OS 版 Jetpack Compose,以最少的程式碼打造精美的 UI。

Leanback UI 工具包提供播放控制項,可提供更優質的使用者體驗。對於影片應用程式,傳輸控制項支援使用前進和後退控制項來快轉影片。在快速略過時,畫面會顯示縮圖,方便你瀏覽影片。

程式庫包含抽象類別和預先建構的即用型實作項目,可為開發人員提供更精細的控制選項。您可以使用預先建構的實作項目,不必編寫太多程式碼,即可快速建構功能豐富的應用程式。如果需要進一步自訂,您可以延伸程式庫的任何預先建構元件。

控制項和播放器

「輕鬆看」UI 工具包會將傳輸控制項 UI 與播放影片的播放器分開。這會透過兩個元件完成: 用於顯示傳輸控制項的播放支援片段 (以及 影片) 和播放器轉接程式來封裝媒體播放器。

播放片段

應用程式的 UI 活動應使用 PlaybackSupportFragmentVideoSupportFragment。 兩者都包含 leanback 傳輸控制項:

您可以自訂片段的 ObjectAdapter,以提升 UI 品質。例如,使用 setAdapter() 新增「相關影片」列。

PlayerAdapter

PlayerAdapter 是用來控制底層媒體播放器的抽象類別。開發人員可以選擇 預先建立的 MediaPlayerAdapter 實作,或寫入 自己的程式碼實作方式

將這些元素凝聚在一起

你必須使用「控制黏膠」連結播放片段 傳遞到播放器中極致時尚 程式庫提供兩種黏附方式:

Leanback 運輸控制膠水

如要讓應用程式支援影片拖曳功能 PlaybackTransportControlGlue

您還需要指定「glue 主機」,將 glue 繫結至播放片段、在 UI 中繪製傳輸控制項並維持其狀態,以及將傳輸控制事件傳回至 glue。主機必須與播放片段類型相符。使用 PlaybackSupportFragmentGlueHost 搭配 是 PlaybackFragment,以及 VideoSupportFragmentGlueHost 搭配 VideoFragment

這張插圖顯示 Leanback 控件的組成部分 相輔相成:

Leanback 運輸控制膠水

會與應用程式一起整合的程式碼應該位於 定義 UI 的 PlaybackSupportFragmentVideoSupportFragment

在下列項目中 例如,應用程式會建構 PlaybackTransportControlGlue 的例項。 將其命名為 playerGlue。 並將其 VideoSupportFragment 連結至新建立的 MediaPlayerAdapter。開始時間 這是 VideoSupportFragment,設定程式碼會呼叫 setHost() 來附加 VideoSupportFragmentGlueHostplayerGlue。程式碼會包含在擴充 VideoSupportFragment 的類別中。

Kotlin

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

Java

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 黏合處

您可以自訂 PlaybackBannerControlGluePlaybackTransportControlGlue 來變更 PlaybackControlsRow

自訂標題和說明

如要自訂播放控制項頂端的標題和說明,請覆寫 onCreateRowPresenter()

Kotlin

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

Java

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

新增控制項

控制項黏合中會顯示 PlaybackControlsRow 中動作的控制項。

PlaybackControlsRow 中的動作會指派給兩個群組:主要動作次要動作。主要群組的控制項會顯示在跳轉列上方,以及 控制列下方會顯示次要群組。一開始只有一個主要動作 沒有次要動作。

您可以透過覆寫的方式,將動作新增至主要和次要群組 「onCreatePrimaryActions()」和 onCreateSecondaryActions()

Kotlin

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

Java

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() 可處理新動作。

Kotlin

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.
}

Java

@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 展示應用程式。 ,直接在 Google Cloud 控制台實際操作。