在电视上运行的媒体应用需要允许用户浏览其提供的内容、进行选择并开始播放内容。此类应用的内容浏览体验应简单、直观,并且视觉上要赏心悦目。
媒体目录浏览器通常由多个部分组成,每个部分都有一个媒体内容列表。媒体目录中版块的示例包括:播放列表、精选内容、推荐类别。
使用 Compose for TV 提供的函数实现一个界面,用于浏览应用的媒体目录中的音乐或视频。
为目录创建可组合函数
屏幕上显示的所有内容都是在 Compose for TV 中以可组合函数的形式实现的。首先,为媒体目录浏览器定义一个可组合函数:
@Composable
fun CatalogBrowser(
featuredContentList: List<Movie>,
sectionList: List<Section>,
modifier: Modifier = Modifier,
onItemSelected: (Movie) -> Unit = {},
) {
// ToDo: add implementation
}
CatalogBrowser
是实现媒体目录浏览器的可组合函数。该函数采用以下参数:
- 精选内容列表。
- 部分列表。
- 修饰符对象。
- 一个回调函数,用于触发屏幕转换。
设置界面元素
Compose for TV 提供延迟列表,该组件用于显示大量项目(或长度未知的列表)。调用 TvLazyColumn
可垂直放置各个部分。TvLazyColumn
提供了一个 TvLazyListScope.() -> Unit
代码块,该代码块提供用于定义项内容的 DSL。在以下示例中,每个部分都放置在一个垂直列表中,各部分之间的间距为 16 dp:
@Composable
fun CatalogBrowser(
featuredContentList: List<Movie>,
sectionList: List<Section>,
modifier: Modifier = Modifier,
onItemSelected: (Movie) -> Unit = {},
) {
TvLazyColumn(
modifier = modifier.fillMaxSize(),
verticalArrangement = Arrangement.spacedBy(16.dp)
) {
items(sectionList) { section ->
Section(section, onItemSelected = onItemSelected)
}
}
}
在该示例中,Section
可组合函数定义了如何显示各个部分。在以下函数中,TvLazyRow
演示了如何通过调用所提供的 DSL,以类似方式使用 TvLazyColumn
的这一水平版本通过 TvLazyListScope.() -> Unit
代码块定义水平列表:
@Composable
fun Section(
section: Section,
modifier: Modifier = Modifier,
onItemSelected: (Movie) -> Unit = {},
) {
Text(
text = section.title,
style = MaterialTheme.typography.headlineSmall,
)
TvLazyRow(
modifier = modifier,
horizontalArrangement = Arrangement.spacedBy(8.dp)
) {
items(section.movieList){ movie ->
MovieCard(
movie = movie,
onClick = { onItemSelected(movie) }
)
}
}
}
在 Section
可组合项中,使用了 Text
组件。Material Design 中定义的文本组件和其他组件在 tv-material 库中提供。您可以通过引用 MaterialTheme
对象来更改 Material Design 中定义的文本样式。tv-material 库也提供此对象。Card
是 tv-material 库的一部分。MovieCard
定义了每个电影数据在目录中如何渲染,该目录中由以下代码段定义:
@Composable
fun MovieCard(
movie: Movie,
modifier: Modifier = Modifier,
onClick: () -> Unit = {}
) {
Card(modifier = modifier, onClick = onClick){
AsyncImage(
model = movie.thumbnailUrl,
contentDescription = movie.title,
)
}
}
突出显示精选内容
在前面描述的示例中,所有电影都以同等方式显示。它们的区域相同,但视觉上没有区别。
您可以使用 Carousel
突出显示其中部分信息。
轮播界面显示一组项目中的信息,这些项目可以滑动、淡出或进入视图。您可以使用该组件突出显示精选内容,例如新上映的电影或电视节目的新剧集。
Carousel
要求您至少指定轮播界面中的内容数量以及如何绘制每项内容。第一个可以使用 itemCount
指定。第二个参数可作为 lambda 传递。系统会将所显示项的索引编号提供给 lambda。您可以使用给定的索引值确定显示的项:
@Composable
function FeaturedCarousel(
featuredContentList: List<Movie>,
modifier: Modifier = Modifier,
) {
Carousel(
itemCount = featuredContentList.size,
modifier = modifier,
) { index ->
val content = featuredContentList[index]
Box {
AsyncImage(
model = content.backgroundImageUrl,
contentDescription = content.description,
placeholder = painterResource(
id = R.drawable.placeholder
),
contentScale = ContentScale.Crop,
modifier = Modifier.fillMaxSize()
)
Text(text = content.title)
}
}
}
Carousel
可以是延迟列表中的项,例如 TvLazyColumn
。以下代码段显示了在所有 Section
可组合项之上的 FeaturedCarousel
可组合项:
@Composable
fun CatalogBrowser(
featuredContentList: List<Movie>,
sectionList: List<Section>,
modifier: Modifier = Modifier,
onItemSelected: (Movie) -> Unit = {},
) {
TvLazyColumn(
modifier = modifier.fillMaxSize(),
verticalArrangement = Arrangement.spacedBy(16.dp)
) {
item {
FeaturedCarousel(featuredContentList)
}
items(sectionList) { section ->
Section(section, onItemSelected = onItemSelected)
}
}
}