处理频道数据

您的电视输入必须在其设置活动中至少为一个频道提供电子节目指南 (EPG) 数据。您还应定期更新这些数据,同时考虑更新的大小和处理它的处理线程。此外,您可以为引导用户访问相关内容和活动的频道提供应用链接。本课程讨论了在考虑这些因素的情况下,在系统数据库上创建和更新频道和节目数据。

试用 电视输入服务 示例应用。

获取权限

为了使您的电视输入能够使用 EPG 数据,它必须在其 Android 清单文件中声明写入权限,如下所示:

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

在数据库中注册频道

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

尽管电视输入框架足够通用,可以无差别地处理传统的广播和OTT内容,但您可能希望除了上述列之外,还定义以下列,以便更好地识别传统的广播频道

如果您想为您的频道提供应用链接详细信息,您需要更新一些额外的字段。有关应用链接字段的更多信息,请参阅 添加应用链接信息

对于基于互联网流的电视输入,请相应地为上述内容分配您自己的值,以便可以唯一地识别每个频道。

从您的后端服务器提取您的频道元数据(XML、JSON或其他格式),并在您的设置活动中将值映射到系统数据库,如下所示

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 是一个对象,它保存来自后端服务器的频道元数据。

呈现频道和节目信息

系统电视应用会在用户切换频道时向用户呈现频道和节目信息,如图1所示。为了确保频道和节目信息与系统电视应用的频道和节目信息呈现器协同工作,请遵循以下指南。

  1. 频道号 (COLUMN_DISPLAY_NUMBER)
  2. 图标 (android:icon 在电视输入的清单文件中)
  3. 节目描述 (COLUMN_SHORT_DESCRIPTION)
  4. 节目标题 (COLUMN_TITLE)
  5. 频道标志 (TvContract.Channels.Logo)
    • 使用颜色 #EEEEEE 与周围文本匹配
    • 不要包含填充
  6. 海报图 (COLUMN_POSTER_ART_URI)
    • 宽高比在 16:9 和 4:3 之间

图1. 系统电视应用频道和节目信息呈现器。

系统电视应用通过节目指南提供相同的信息,包括海报图,如图2所示。

图2. 系统电视应用节目指南。

更新频道数据

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

注意:ContentProvider 添加频道数据可能需要一些时间。仅当您配置 EpgSyncJobService 在后台更新其余频道数据时,才添加当前节目(距离当前时间两小时内的节目)。请参阅 Android TV 直播电视示例应用 以了解示例。

批量加载频道数据

使用大量频道数据更新系统数据库时,请使用 ContentResolverapplyBatch()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();
    }
}

异步处理频道数据

数据操作(例如从服务器获取流或访问数据库)不应阻塞UI线程。使用 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数据,请考虑使用 WorkManager 在空闲时间(例如每天凌晨3:00)运行更新过程。

其他将数据更新任务与UI线程分离的技术包括使用 HandlerThread 类,或者您可以使用 LooperHandler 类实现自己的技术。有关更多信息,请参阅 进程和线程

频道可以使用应用链接,让用户在观看频道内容时轻松启动相关的活动。频道应用使用应用链接通过启动显示相关信息或附加内容的活动来扩展用户参与度。例如,您可以使用应用链接执行以下操作

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

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

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

当用户选择应用链接时,系统将使用频道应用指定的意图URI启动活动。在应用链接活动处于活动状态时,频道内容将继续播放。用户可以通过按下返回键返回到频道内容。

提供应用链接频道数据

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

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

如果频道数据未指定应用链接信息,系统将创建一个默认应用链接。系统将按如下方式选择默认详细信息

  • 对于意图URI (COLUMN_APP_LINK_INTENT_URI),系统将使用 ACTION_MAIN 活动,用于 CATEGORY_LEANBACK_LAUNCHER 类别,通常在应用清单中定义。如果未定义此活动,则会出现一个无法正常工作的应用链接——如果用户点击它,则不会发生任何事情。
  • 对于描述性文本 (COLUMN_APP_LINK_TEXT),系统将使用“打开app-name”。如果未定义任何可行的应用链接意图URI,系统将使用“无可用链接”。
  • 对于强调色 (COLUMN_APP_LINK_COLOR),系统将使用默认应用颜色。
  • 对于海报图像 (COLUMN_APP_LINK_POSTER_ART_URI),系统将使用应用的主屏幕横幅。如果应用未提供横幅,系统将使用默认的电视应用图像。
  • 对于徽章图标 (COLUMN_APP_LINK_ICON_URI),系统将使用显示应用名称的徽章。如果系统还使用应用横幅或默认应用图像作为海报图像,则不会显示应用徽章。

您可以在应用的设置活动中为您的频道指定应用链接详细信息。您可以随时更新这些应用链接详细信息,因此,如果应用链接需要与频道更改匹配,请更新应用链接详细信息并根据需要调用 ContentResolver.update()。有关更新频道数据的更多详细信息,请参阅 更新频道数据