分析

ExoPlayer 支持广泛的播放分析需求。归根结底，分析就是收集、解释、聚合和汇总播放数据。这些数据既可以在设备上使用（例如用于日志记录、调试或为未来的播放决策提供信息），也可以报告给服务器以监控所有设备上的播放情况。

分析系统通常需要首先收集事件，然后进一步处理这些事件以使其具有意义

事件收集：这可以通过在 ExoPlayer 实例上注册一个 AnalyticsListener 来完成。已注册的分析监听器会在播放器使用期间接收发生的事件。每个事件都与播放列表中的相应媒体项目以及播放位置和时间戳元数据相关联。
事件处理：一些分析系统将原始事件上传到服务器，所有事件处理都在服务器端执行。也可以在设备上处理事件，这样做可能更简单或减少需要上传的信息量。ExoPlayer 提供了 PlaybackStatsListener，它允许您执行以下处理步骤
1. 事件解释：为了对分析有用，事件需要在单个播放的上下文中进行解释。例如，播放器状态更改为 STATE_BUFFERING 的原始事件可能对应于初始缓冲、重新缓冲或寻道后发生的缓冲。
2. 状态跟踪：此步骤将事件转换为计数器。例如，状态更改事件可以转换为跟踪每个播放状态花费时间的计数器。结果是单个播放的一组基本分析数据值。
3. 聚合：此步骤将多个播放的分析数据合并在一起，通常通过累加计数器。
4. 汇总指标计算：许多最有用的指标是那些计算平均值或以其他方式组合基本分析数据值的指标。汇总指标可以针对单个或多个播放进行计算。

使用 AnalyticsListener 收集事件

来自播放器的原始播放事件会报告给 AnalyticsListener 实现。您可以轻松添加自己的监听器，并仅覆盖您感兴趣的方法

Kotlin

exoPlayer.addAnalyticsListener(
  object : AnalyticsListener {
    override fun onPlaybackStateChanged(
      eventTime: EventTime, @Player.State state: Int
    ) {}

    override fun onDroppedVideoFrames(
      eventTime: EventTime,
      droppedFrames: Int,
      elapsedMs: Long,
    ) {}
  }
)

Java

exoPlayer.addAnalyticsListener(
    new AnalyticsListener() {
      @Override
      public void onPlaybackStateChanged(
          EventTime eventTime, @Player.State int state) {}

      @Override
      public void onDroppedVideoFrames(
          EventTime eventTime, int droppedFrames, long elapsedMs) {}
    });

传递给每个回调的 EventTime 将事件与播放列表中的媒体项目以及播放位置和时间戳元数据相关联

realtimeMs: 事件的真实时钟时间。
timeline、windowIndex 和 mediaPeriodId：定义事件所属的播放列表和播放列表中的项目。mediaPeriodId 包含可选的额外信息，例如指示事件是否属于项目中的广告。
eventPlaybackPositionMs: 事件发生时项目中的播放位置。
currentTimeline、currentWindowIndex、currentMediaPeriodId 和 currentPlaybackPositionMs：如上所述，但针对当前播放的项目。当前播放的项目可能与事件所属的项目不同，例如如果事件对应于对下一个要播放的项目进行预缓冲。

使用 PlaybackStatsListener 处理事件

PlaybackStatsListener 是一个实现设备上事件处理的 AnalyticsListener。它计算 PlaybackStats，包括计数器和派生指标，例如

汇总指标，例如总播放时间。
自适应播放质量指标，例如平均视频分辨率。
渲染质量指标，例如丢帧率。
资源使用指标，例如通过网络读取的字节数。

您可以在 PlaybackStats Javadoc 中找到可用计数和派生指标的完整列表。

PlaybackStatsListener 为播放列表中的每个媒体项目以及这些项目中插入的每个客户端广告计算单独的 PlaybackStats。您可以向 PlaybackStatsListener 提供回调，以获知已完成的播放，并使用传递给回调的 EventTime 来识别哪个播放已完成。可以对多个播放进行聚合分析数据。还可以随时使用 PlaybackStatsListener.getPlaybackStats() 查询当前播放会话的 PlaybackStats。

Kotlin

exoPlayer.addAnalyticsListener(
  PlaybackStatsListener(/* keepHistory= */ true) {
    eventTime: EventTime?,
    playbackStats: PlaybackStats?,
    -> // Analytics data for the session started at `eventTime` is ready.
  }
)

Java

exoPlayer.addAnalyticsListener(
    new PlaybackStatsListener(
        /* keepHistory= */ true,
        (eventTime, playbackStats) -> {
          // Analytics data for the session started at `eventTime` is ready.
        }));

PlaybackStatsListener 的构造函数提供了保留处理事件完整历史记录的选项。请注意，这可能会根据播放时长和事件数量产生未知的内存开销。因此，只有在需要访问处理事件的完整历史记录而不仅仅是最终分析数据时，才应启用此选项。

请注意，PlaybackStats 使用一组扩展状态来指示媒体的状态，以及用户播放意图和更详细的信息，例如播放为何中断或结束。

播放状态	用户播放意图	无播放意图
播放前	`JOINING_FOREGROUND`	`NOT_STARTED`、`JOINING_BACKGROUND`
活跃播放	`PLAYING`
中断播放	`BUFFERING`、`SEEKING`	`PAUSED`、`PAUSED_BUFFERING`、`SUPPRESSED`、`SUPPRESSED_BUFFERING`、`INTERRUPTED_BY_AD`
结束状态		`ENDED`、`STOPPED`、`FAILED`、`ABANDONED`

用户播放意图对于区分用户主动等待播放继续的时间和被动等待时间至关重要。例如，PlaybackStats.getTotalWaitTimeMs 返回在 JOINING_FOREGROUND、BUFFERING 和 SEEKING 状态下花费的总时间，但不包括播放暂停的时间。同样，PlaybackStats.getTotalPlayAndWaitTimeMs 将返回用户有播放意图的总时间，即总主动等待时间和在 PLAYING 状态下花费的总时间。

已处理和已解释的事件

您可以通过将 PlaybackStatsListener 与 keepHistory=true 配合使用来记录已处理和已解释的事件。生成的 PlaybackStats 将包含以下事件列表

playbackStateHistory：一个扩展播放状态的有序列表，其中包含它们开始应用的 EventTime。您还可以使用 PlaybackStats.getPlaybackStateAtTime 在给定真实时钟时间查找状态。
mediaTimeHistory：真实时钟时间和媒体时间对的历史记录，让您可以重建媒体的哪些部分在何时播放。您还可以使用 PlaybackStats.getMediaTimeMsAtRealtimeMs 在给定真实时钟时间查找播放位置。
videoFormatHistory 和 audioFormatHistory：播放期间使用的视频和音频格式的有序列表，其中包含它们开始使用的 EventTime。
fatalErrorHistory 和 nonFatalErrorHistory：致命和非致命错误的有序列表，其中包含它们发生的 EventTime。致命错误是导致播放结束的错误，而非致命错误可能是可恢复的。

单次播放分析数据

即使使用 PlaybackStatsListener，此数据也会自动收集，即使使用 keepHistory=false 也是如此。最终值是您可以在 PlaybackStats Javadoc 中找到的公共字段，以及 getPlaybackStateDurationMs 返回的播放状态持续时间。为方便起见，您还会发现诸如 getTotalPlayTimeMs 和 getTotalWaitTimeMs 之类的方法，它们返回特定播放状态组合的持续时间。

Kotlin

Log.d(
  "DEBUG",
  "Playback summary: " +
    "play time = " +
    playbackStats.totalPlayTimeMs +
    ", rebuffers = " +
    playbackStats.totalRebufferCount
)

Java

Log.d(
    "DEBUG",
    "Playback summary: "
        + "play time = "
        + playbackStats.getTotalPlayTimeMs()
        + ", rebuffers = "
        + playbackStats.totalRebufferCount);

聚合多个播放的分析数据

您可以通过调用 PlaybackStats.merge 将多个 PlaybackStats 组合在一起。生成的 PlaybackStats 将包含所有合并播放的聚合数据。请注意，它不包含单个播放事件的历史记录，因为这些事件无法聚合。

PlaybackStatsListener.getCombinedPlaybackStats 可用于获取在一个 PlaybackStatsListener 的生命周期内收集的所有分析数据的聚合视图。

计算的汇总指标

除了基本分析数据之外，PlaybackStats 还提供了许多计算汇总指标的方法。

Kotlin

Log.d(
  "DEBUG",
  "Additional calculated summary metrics: " +
    "average video bitrate = " +
    playbackStats.meanVideoFormatBitrate +
    ", mean time between rebuffers = " +
    playbackStats.meanTimeBetweenRebuffers
)

Java

Log.d(
    "DEBUG",
    "Additional calculated summary metrics: "
        + "average video bitrate = "
        + playbackStats.getMeanVideoFormatBitrate()
        + ", mean time between rebuffers = "
        + playbackStats.getMeanTimeBetweenRebuffers());

高级主题

将分析数据与播放元数据关联

在收集单个播放的分析数据时，您可能希望将播放分析数据与有关正在播放媒体的元数据相关联。

建议使用 MediaItem.Builder.setTag 设置媒体特定的元数据。媒体标签是原始事件报告的 EventTime 的一部分，并且在 PlaybackStats 完成时，因此在处理相应的分析数据时可以轻松检索它

Kotlin

PlaybackStatsListener(/* keepHistory= */ false) {
  eventTime: EventTime,
  playbackStats: PlaybackStats ->
  val mediaTag =
    eventTime.timeline
      .getWindow(eventTime.windowIndex, Timeline.Window())
      .mediaItem
      .localConfiguration
      ?.tag
    // Report playbackStats with mediaTag metadata.
}

Java

new PlaybackStatsListener(
    /* keepHistory= */ false,
    (eventTime, playbackStats) -> {
      Object mediaTag =
          eventTime.timeline.getWindow(eventTime.windowIndex, new Timeline.Window())
              .mediaItem
              .localConfiguration
              .tag;
      // Report playbackStats with mediaTag metadata.
    });

报告自定义分析事件

如果您需要向分析数据添加自定义事件，则需要将这些事件保存到您自己的数据结构中，然后将它们与报告的 PlaybackStats 结合。如果有所帮助，您可以扩展 DefaultAnalyticsCollector，以便为您的自定义事件生成 EventTime 实例，并将它们发送给已注册的监听器，如以下示例所示。

Kotlin

private interface ExtendedListener : AnalyticsListener {
  fun onCustomEvent(eventTime: EventTime)
}

private class ExtendedCollector : DefaultAnalyticsCollector(Clock.DEFAULT) {
  fun customEvent() {
    val eventTime = generateCurrentPlayerMediaPeriodEventTime()
    sendEvent(eventTime, CUSTOM_EVENT_ID) { listener: AnalyticsListener ->
      if (listener is ExtendedListener) {
        listener.onCustomEvent(eventTime)
      }
    }
  }
}

// Usage - Setup and listener registration.
val player = ExoPlayer.Builder(context).setAnalyticsCollector(ExtendedCollector()).build()
player.addAnalyticsListener(
  object : ExtendedListener {
    override fun onCustomEvent(eventTime: EventTime?) {
      // Save custom event for analytics data.
    }
  }
)
// Usage - Triggering the custom event.
(player.analyticsCollector as ExtendedCollector).customEvent()

Java

private interface ExtendedListener extends AnalyticsListener {
  void onCustomEvent(EventTime eventTime);
}

private static class ExtendedCollector extends DefaultAnalyticsCollector {
  public ExtendedCollector() {
    super(Clock.DEFAULT);
  }

  public void customEvent() {
    AnalyticsListener.EventTime eventTime = generateCurrentPlayerMediaPeriodEventTime();
    sendEvent(
        eventTime,
        CUSTOM_EVENT_ID,
        listener -> {
          if (listener instanceof ExtendedListener) {
            ((ExtendedListener) listener).onCustomEvent(eventTime);
          }
        });
  }
}

// Usage - Setup and listener registration.
ExoPlayer player =
    new ExoPlayer.Builder(context).setAnalyticsCollector(new ExtendedCollector()).build();
player.addAnalyticsListener(
    (ExtendedListener) eventTime -> {
      // Save custom event for analytics data.
    });
// Usage - Triggering the custom event.
((ExtendedCollector) player.getAnalyticsCollector()).customEvent();

分析 使用收藏夹整理内容 根据您的偏好保存和分类内容。

使用 AnalyticsListener 收集事件

Kotlin

Java

使用 PlaybackStatsListener 处理事件

Kotlin

Java

已处理和已解释的事件

单次播放分析数据

Kotlin

Java

聚合多个播放的分析数据

计算的汇总指标

Kotlin

Java

高级主题

将分析数据与播放元数据关联

Kotlin

Java

报告自定义分析事件

Kotlin

Java

分析