在 Chromecast 中跟踪核心播放

本文档介绍 2.x 版本的 SDK 中的跟踪。

1. 初始跟踪设置

   识别用户何时触发播放意图（用户点击“播放”和/或自动播放开启）并创建 MediaObject 实例。

   MediaObjectAPI 引用：

   createMediaObject

   mediaObject = ADBMobile.media.createMediaObject(<name>, <id>, <duration>, <streamType>, <mediaType>);
   

   StreamType常量：

   ADBMobile Media

   MediaType常量：

   ADBMobile Media

2. 附加视频元数据

   （可选）通过上下文数据变量将标准和/或自定义视频元数据对象附加到视频跟踪会话。

   • 标准视频元数据

     在 Chromecast 中实施标准元数据

     注意

     将标准视频元数据对象附加到媒体对象是可选的。

   • 自定义元数据

     为自定义变量创建变量对象，然后使用此视频的数据进行填充。例如：

     /* Set custom context data */
     var customVideoMetadata = {
         isUserLoggedIn: "false",
         tvStation: "Sample TV station",
         programmer: "Sample programmer"
     };
     

3. 跟踪开始播放的意图

   要开始跟踪媒体会话，请在 media 对象中调用 trackSessionStart。

   ADBMobile.media.trackSessionStart(mediaObject, customVideoMetadata);
   

   重要

   trackSessionStart 跟踪的是用户的播放意图，而不是播放的开始。此 API 用于加载视频数据/元数据并评估开启 QoS 量度的时间（trackSessionStart 和 trackPlay 之间的持续时间）。

   注意

   第二个值是您在步骤 2 中创建的自定义视频元数据对象名称。如果不使用自定义视频元数据，则只需在 trackSessionStart 中为 data 参数发送一个空对象，如上面 iOS 示例中注释掉的行所示。

4. 跟踪播放的实际开始事件

   识别视频播放器中的视频播放开始事件（视频的第一帧呈现在屏幕上）并调用 trackPlay：

   ADBMobile.media.trackPlay();
   

5. 更新播放头值

   播放头更改时多次更新mediaUpdatePlayhead ' 位置值。
   对于视频点播 (VOD)，该值以从媒体项开头开始的秒数指定。
   对于直播，如果播放器不提供有关内容持续时间的信息，则该值可以指定为自当天 UTC 午夜开始的秒数。

   ADBMobile().media.updatePlayhead(position)
   

   注意

   调用 media.updatePlayhead API：

   • 使用进度标记时，需要内容持续时间，并且播放头需要更新为从媒体项目开始的秒数，从0开始。
   • 使用Media SDK时，必须调用 media.updatePlayhead API至少每秒执行一次。

6. 跟踪播放的结束事件

   识别视频播放器中的视频播放结束事件（用户一直观看至内容的结尾）并调用 trackComplete：

   ADBMobile.media.trackComplete();
   

7. 跟踪会话的结束事件

   识别视频播放器中的视频播放卸载/关闭事件（用户关闭视频和/或视频已结束并卸载）并调用 trackSessionEnd：

   ADBMobile.media.trackSessionEnd();
   

   重要

   trackSessionEnd 标记视频跟踪会话的结尾。如果会话成功观看至结束（用户一直观看内容至结尾），请确保先调用 trackComplete，之后再调用 trackSessionEnd。在调用 trackSessionEnd 之后，任何其他 track* API 调用都将被忽略（除了用于新的视频跟踪会话的 trackSessionStart 之外）。

8. 跟踪所有可能的暂停方案

   识别视频播放器中的视频暂停事件并调用 trackPause：

   ADBMobile.media.trackPause();
   

   暂停方案

   识别视频播放器将会暂停的任何方案，并确保正确调用了 trackPause。以下方案均要求应用程序调用 trackPause()：

   • 用户在应用程序中明确点击暂停。
   • 播放器将其置于“暂停”状态。
   • （移动应用程序）- 用户将应用程序放入后台，但您希望应用程序保持会话打开。
   • （移动应用程序）- 发生导致应用程序被置于后台运行的任何类型的系统中断。例如，用户接收到一个调用，或者出现来自其他应用程序的弹出窗口，但您希望应用程序将会话保持活动状态，以便用户有机会从中断点继续观看视频。

9. 识别播放器中的视频播放事件和/或视频在暂停后继续播放的事件并调用 trackPlay：

   ADBMobile.media.trackPlay();
   

   小贴士

   这可能与步骤 4 中所使用的事件源相同。请确保当视频播放继续时，每个 trackPause() API 调用均与随后的一个 trackPlay() API 调用相配对。

• 跟踪方案：不含广告的 VOD 播放
• Chromecast SDK 随附有示例播放器，用于提供完整的跟踪示例。