Leanback UI 工具包具有播放控件,可提供改进的用户体验。对于视频应用,传输控件支持使用前进和后退控件进行视频拖动。拖动时,显示缩略图以帮助浏览视频。
该库包含抽象类以及预构建的现成实现,为开发者提供了更细粒度的控制。使用预构建的实现,您可以快速构建功能丰富的应用,而无需进行大量编码。如果您需要更多自定义,您可以扩展库的任何预构建组件。
控件和播放器
Leanback UI 工具包将传输控件 UI 与播放视频的播放器分离。这是通过两个组件实现的:一个用于显示传输控件(以及可选的视频)的播放支持片段和一个用于封装媒体播放器的播放器适配器。
播放片段
您的应用的 UI Activity 应使用PlaybackSupportFragment
或VideoSupportFragment
。两者都包含 Leanback 传输控件
PlaybackSupportFragment
会对其传输控件进行动画处理,以根据需要显示/隐藏它们。VideoSupportFragment
扩展了PlaybackSupportFragment
,并具有一个SurfaceView
来渲染视频。
您可以自定义片段的ObjectAdapter
来增强 UI。例如,使用setAdapter()
添加“相关视频”行。
PlayerAdapter
PlayerAdapter
是一个抽象类,用于控制底层媒体播放器。开发者可以选择预构建的MediaPlayerAdapter
实现,或编写自己的此类实现。
将各个部分连接起来
您必须使用一些“控制胶水”将播放片段连接到播放器。Leanback 库提供了两种胶水
PlaybackBannerControlGlue
以“旧样式”在播放片段中绘制传输控件,并将它们放置在不透明背景中。(PlaybackBannerControlGlue
替换了已弃用的PlaybackControlGlue
。)PlaybackTransportControlGlue
使用具有透明背景的“新样式”控件。
如果希望您的应用支持视频拖动,则必须使用PlaybackTransportControlGlue
。
您还需要指定一个“胶水主机”,它将胶水绑定到播放片段,在 UI 中绘制传输控件并维护其状态,并将传输控件事件传回胶水。主机必须与播放片段类型匹配。将PlaybackSupportFragmentGlueHost
与PlaybackFragment
一起使用,并将VideoSupportFragmentGlueHost
与VideoFragment
一起使用。
以下是显示 Leanback 传输控件的各个部分如何组合在一起的插图
将应用程序粘合在一起的代码应该位于定义 UI 的PlaybackSupportFragment
或 VideoSupportFragment
中。
在以下示例中,应用程序构建了一个 PlaybackTransportControlGlue
的实例,将其命名为 playerGlue
,并将其 VideoSupportFragment
连接到一个新创建的 MediaPlayerAdapter
。由于这是一个 VideoSupportFragment
,因此设置代码调用 setHost()
将 VideoSupportFragmentGlueHost
附加到 playerGlue
。代码包含在扩展 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 粘合
您可以自定义 PlaybackBannerControlGlue
和 PlaybackTransportControlGlue
以更改 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 Showcase 应用程序 中的示例。。