使用频道数据

TV 输入源必须在其设置 activity 中至少提供一个频道的电子收视指南 (EPG) 数据。您还应定期更新这些数据,并考虑更新的大小以及处理更新的处理线程。此外,您还可以提供频道的应用链接,引导用户访问相关内容和 activity。本课介绍如何在系统数据库中创建和更新频道和节目数据,同时考虑到这些因素。

请试用 TV 输入服务示例应用。

获取权限

为了使您的 TV 输入源处理 EPG 数据,它必须在其 Android 清单文件中声明写入权限,如下所示:

<uses-permission android:name="com.android.providers.tv.permission.WRITE_EPG_DATA" />

在数据库中注册频道

Android TV 系统数据库维护 TV 输入的频道数据记录。在您的设置 activity 中,您必须将每个频道的频道数据映射到 TvContract.Channels 类的以下字段:

虽然 TV 输入框架足够通用,可以处理传统的广播和 OTT 服务 (OTT) 内容,没有任何区别,但除了上述列之外,您可能还需要定义以下列,以便更好地识别传统广播频道:

如果要提供频道的应用链接详细信息,则需要更新一些其他字段。如需详细了解应用链接字段,请参阅添加应用链接信息

对于基于互联网流式传输的 TV 输入,请相应地为上面指定您自己的值,以便可以唯一地标识每个频道。

从后端服务器提取频道元数据(采用 XML、JSON 或其他任何格式),然后在设置 activity 中将值映射到系统数据库,如下所示:

Kotlin

val values = ContentValues().apply {
    put(TvContract.Channels.COLUMN_DISPLAY_NUMBER, channel.number)
    put(TvContract.Channels.COLUMN_DISPLAY_NAME, channel.name)
    put(TvContract.Channels.COLUMN_ORIGINAL_NETWORK_ID, channel.originalNetworkId)
    put(TvContract.Channels.COLUMN_TRANSPORT_STREAM_ID, channel.transportStreamId)
    put(TvContract.Channels.COLUMN_SERVICE_ID, channel.serviceId)
    put(TvContract.Channels.COLUMN_VIDEO_FORMAT, channel.videoFormat)
}
val uri = context.contentResolver.insert(TvContract.Channels.CONTENT_URI, values)

Java

ContentValues values = new ContentValues();

values.put(Channels.COLUMN_DISPLAY_NUMBER, channel.number);
values.put(Channels.COLUMN_DISPLAY_NAME, channel.name);
values.put(Channels.COLUMN_ORIGINAL_NETWORK_ID, channel.originalNetworkId);
values.put(Channels.COLUMN_TRANSPORT_STREAM_ID, channel.transportStreamId);
values.put(Channels.COLUMN_SERVICE_ID, channel.serviceId);
values.put(Channels.COLUMN_VIDEO_FORMAT, channel.videoFormat);

Uri uri = context.getContentResolver().insert(TvContract.Channels.CONTENT_URI, values);

在上面的示例中,channel 是一个对象,用于保存来自后端服务器的频道元数据。

呈现频道和节目信息

系统 TV 应用会在用户浏览频道时向其呈现频道和节目信息,如图 1 所示。为了确保频道和节目信息可以与系统 TV 应用的频道和节目信息 Presenter 一起使用,请遵循以下准则。

  1. 频道号 (COLUMN_DISPLAY_NUMBER)
  2. 图标(TV 输入清单中的 android:icon
  3. 节目说明 (COLUMN_SHORT_DESCRIPTION)
  4. 节目名称 (COLUMN_TITLE)
  5. 频道徽标 (TvContract.Channels.Logo)
    • 使用颜色 #EEEEEE,让徽标与周围的文字相配
    • 请勿添加内边距
  6. 海报图片 (COLUMN_POSTER_ART_URI)
    • 宽高比介于 16:9 到 4:3 之间

图 1. 系统 TV 应用频道和节目信息 Presenter。

系统 TV 应用通过收视指南提供相同的信息(包括海报图片),如图 2 所示。

图 2. 系统 TV 应用的收视指南。

更新频道数据

更新现有频道数据时,请使用 update() 方法,而不要先删除再重新添加数据。在选择要更新的记录时,您可以使用 Channels.COLUMN_VERSION_NUMBERPrograms.COLUMN_VERSION_NUMBER 来识别数据的当前版本。

注意:向 ContentProvider 添加频道数据可能需要一些时间。仅当您将 EpgSyncJobService 配置为在后台更新其余频道数据时,才能添加当前节目(当前时间两小时内的节目)。如需查看示例,请参阅 Android TV Live TV 示例应用

批量加载频道数据

使用大量频道数据更新系统数据库时,请使用 ContentResolver applyBatch()bulkInsert() 方法。下面是一个使用 applyBatch() 的示例:

Kotlin

val ops = ArrayList<ContentProviderOperation>()
val programsCount = channelInfo.mPrograms.size
channelInfo.mPrograms.forEachIndexed { index, program ->
    ops += ContentProviderOperation.newInsert(
            TvContract.Programs.CONTENT_URI).run {
        withValues(programs[index])
        withValue(TvContract.Programs.COLUMN_START_TIME_UTC_MILLIS, programStartSec * 1000)
        withValue(
                TvContract.Programs.COLUMN_END_TIME_UTC_MILLIS,
                (programStartSec + program.durationSec) * 1000
        )
        build()
    }
    programStartSec += program.durationSec
    if (index % 100 == 99 || index == programsCount - 1) {
        try {
            contentResolver.applyBatch(TvContract.AUTHORITY, ops)
        } catch (e: RemoteException) {
            Log.e(TAG, "Failed to insert programs.", e)
            return
        } catch (e: OperationApplicationException) {
            Log.e(TAG, "Failed to insert programs.", e)
            return
        }
        ops.clear()
    }
}

Java

ArrayList<ContentProviderOperation> ops = new ArrayList<>();
int programsCount = channelInfo.mPrograms.size();
for (int j = 0; j < programsCount; ++j) {
    ProgramInfo program = channelInfo.mPrograms.get(j);
    ops.add(ContentProviderOperation.newInsert(
            TvContract.Programs.CONTENT_URI)
            .withValues(programs.get(j))
            .withValue(Programs.COLUMN_START_TIME_UTC_MILLIS,
                    programStartSec * 1000)
            .withValue(Programs.COLUMN_END_TIME_UTC_MILLIS,
                    (programStartSec + program.durationSec) * 1000)
            .build());
    programStartSec = programStartSec + program.durationSec;
    if (j % 100 == 99 || j == programsCount - 1) {
        try {
            getContentResolver().applyBatch(TvContract.AUTHORITY, ops);
        } catch (RemoteException | OperationApplicationException e) {
            Log.e(TAG, "Failed to insert programs.", e);
            return;
        }
        ops.clear();
    }
}

异步处理频道数据

数据操作(例如从服务器提取流或访问数据库)不应阻塞界面线程。使用 AsyncTask 是异步执行更新的一种方法。例如,从后端服务器加载频道信息时,您可以使用 AsyncTask,如下所示:

Kotlin

private class LoadTvInputTask(val context: Context) : AsyncTask<Uri, Unit, Unit>() {

    override fun doInBackground(vararg uris: Uri) {
        try {
            fetchUri(uris[0])
        } catch (e: IOException) {
            Log.d("LoadTvInputTask", "fetchUri error")
        }
    }

    @Throws(IOException::class)
    private fun fetchUri(videoUri: Uri) {
        context.contentResolver.openInputStream(videoUri).use { inputStream ->
            Xml.newPullParser().also { parser ->
                try {
                    parser.setFeature(XmlPullParser.FEATURE_PROCESS_NAMESPACES, false)
                    parser.setInput(inputStream, null)
                    sTvInput = ChannelXMLParser.parseTvInput(parser)
                    sSampleChannels = ChannelXMLParser.parseChannelXML(parser)
                } catch (e: XmlPullParserException) {
                    e.printStackTrace()
                }
            }
        }
    }
}

Java

private static class LoadTvInputTask extends AsyncTask<Uri, Void, Void> {

    private Context mContext;

    public LoadTvInputTask(Context context) {
        mContext = context;
    }

    @Override
    protected Void doInBackground(Uri... uris) {
        try {
            fetchUri(uris[0]);
        } catch (IOException e) {
          Log.d("LoadTvInputTask", "fetchUri error");
        }
        return null;
    }

    private void fetchUri(Uri videoUri) throws IOException {
        InputStream inputStream = null;
        try {
            inputStream = mContext.getContentResolver().openInputStream(videoUri);
            XmlPullParser parser = Xml.newPullParser();
            try {
                parser.setFeature(XmlPullParser.FEATURE_PROCESS_NAMESPACES, false);
                parser.setInput(inputStream, null);
                sTvInput = ChannelXMLParser.parseTvInput(parser);
                sSampleChannels = ChannelXMLParser.parseChannelXML(parser);
            } catch (XmlPullParserException e) {
                e.printStackTrace();
            }
        } finally {
            if (inputStream != null) {
                inputStream.close();
            }
        }
    }
}

如果您需要定期更新 EPG 数据,不妨考虑在空闲时间(例如每天凌晨 3:00)使用 WorkManager 运行更新流程。

将数据更新任务与界面线程分离的其他方法包括使用 HandlerThread 类,或者您也可以使用 LooperHandler 类实现自己的方法。如需了解详情,请参阅 进程和线程

频道可以使用应用链接来让用户在观看频道内容时轻松启动相关 activity。频道应用使用应用链接启动显示相关信息或其他内容的 activity,从而提升用户互动度。例如,您可以使用应用链接执行以下操作:

  • 引导用户发现和购买相关内容。
  • 提供有关当前播放内容的其他信息。
  • 在观看剧集内容时,开始观看系列中的下一集。
  • 让用户在不中断内容播放的情况下与内容互动(例如,对内容进行评分或评价)。

如果用户在观看频道内容时按选择以显示电视菜单,系统会显示应用链接。

图 1. 显示频道内容时,显示在频道行上的示例应用链接。

当用户选择应用链接时,系统会使用频道应用指定的 intent URI 启动一个 activity。当应用链接 activity 处于活动状态时,频道内容会继续播放。用户可以按返回以返回频道内容。

提供应用链接频道数据

Android TV 会使用频道数据中的信息自动为每个频道创建应用链接。如需提供应用链接信息,请在 TvContract.Channels 字段中指定以下详细信息:

  • COLUMN_APP_LINK_COLOR - 此频道的应用链接的强调色。如需查看强调色示例,请见图 2 中的标注 3。
  • COLUMN_APP_LINK_ICON_URI - 此频道的应用链接的应用标志图标的 URI。如需查看应用标志图标示例,请见图 2 中的标注 2。
  • COLUMN_APP_LINK_INTENT_URI - 此频道的应用链接的 intent URI。您可以结合使用 toUri(int)URI_INTENT_SCHEME 来创建 URI,然后使用 parseUri() 将 URI 转换回原始 intent。
  • COLUMN_APP_LINK_POSTER_ART_URI - 用作此频道的应用链接背景的海报图片的 URI。如需查看海报图片示例,请见图 2 中的标注 1。
  • COLUMN_APP_LINK_TEXT - 此频道的应用链接的描述性链接文字。如需查看应用链接说明示例,请参阅图 2 中的标注 3 中的文字。

图 2. 应用链接详细信息。

如果频道数据未指定应用链接信息,系统会创建默认应用链接。系统会选择默认详细信息,具体说明如下:

  • 对于 intent URI (COLUMN_APP_LINK_INTENT_URI),系统会将 ACTION_MAIN activity 用于 CATEGORY_LEANBACK_LAUNCHER 类别(通常在应用清单中定义)。如果未定义此 activity,会出现一个不起作用的应用链接,如果用户点击该链接,它不会执行任何操作。
  • 对于描述性文本 (COLUMN_APP_LINK_TEXT),系统会使用“Open app-name”。如果未定义可行的应用链接 intent URI,系统会使用“No link available”。
  • 对于强调色 (COLUMN_APP_LINK_COLOR),系统会使用默认应用颜色。
  • 对于海报图片 (COLUMN_APP_LINK_POSTER_ART_URI),系统会使用应用的主屏幕横幅。如果应用未提供横幅,系统会使用默认 TV 应用图片。
  • 对于标记图标 (COLUMN_APP_LINK_ICON_URI),系统会使用显示应用名称的标记。如果系统也将应用横幅或默认应用图片用作海报图片,则不会显示任何应用标志。

您可以在应用的设置 activity 中指定频道的应用链接详细信息。您可以随时更新这些应用链接详细信息,因此如果某个应用链接需要与频道变更保持一致,请更新应用链接详细信息并根据需要调用 ContentResolver.update()。如需详细了解如何更新频道数据,请参阅更新频道数据