自定义

ExoPlayer 库的核心是 Player 接口。Player 可提供传统的高级媒体播放器功能,例如缓冲媒体、播放、暂停和跳转。默认实现 ExoPlayer 旨在对正在播放的媒体类型、存储方式和位置以及呈现方式做出少量假设(因此施加少量限制)。ExoPlayer 实现不会直接实现媒体的加载和渲染,而是将此工作委托给在创建播放器或将新媒体源传递给播放器时注入的组件。所有 ExoPlayer 实现的通用组件包括:

  • MediaSource 实例,用于定义要播放的媒体、加载媒体,以及从中读取已加载的媒体。MediaSource 实例由播放器内的 MediaSource.Factory 通过 MediaItem 创建。也可以使用基于媒体源的播放列表 API 直接传递给播放器。
  • MediaItem 转换为 MediaSourceMediaSource.Factory 实例。在创建播放器时注入 MediaSource.Factory
  • 用于呈现媒体各个组件的 Renderer 实例。这些是在创建播放器时注入的。
  • 一种 TrackSelector,用于选择由 MediaSource 提供的轨道,以供每个可用的 Renderer 使用。在创建播放器时注入 TrackSelector
  • 一种 LoadControl,用于控制 MediaSource 何时缓冲更多媒体以及缓冲多少媒体。在创建播放器时注入 LoadControl
  • 一个 LivePlaybackSpeedControl,用于控制直播回放期间的播放速度,使播放器能够保持在配置的直播偏移量附近。在创建播放器时注入 LivePlaybackSpeedControl

整个库中都存在注入实现部分播放器功能的组件的概念。某些组件的默认实现会将工作委托给进一步注入的组件。这样一来,许多子组件都可以单独替换为以自定义方式配置的实现。

播放器自定义

下面介绍了一些通过注入组件来自定义播放器的常见示例。

配置网络堆栈

我们有一个页面介绍了如何自定义 ExoPlayer 使用的网络堆栈

缓存从网络加载的数据

请参阅有关临时即时缓存下载媒体的指南。

自定义服务器互动

某些应用可能需要拦截 HTTP 请求和响应。您可能需要注入自定义请求标头、读取服务器的响应标头、修改请求的 URI 等。例如,您的应用可以在请求媒体段时注入令牌作为标头,从而进行身份验证。

以下示例演示了如何通过将自定义 DataSource.Factory 注入 DefaultMediaSourceFactory 来实现这些行为:

Kotlin

val dataSourceFactory =
  DataSource.Factory {
    val dataSource = httpDataSourceFactory.createDataSource()
    // Set a custom authentication request header.
    dataSource.setRequestProperty("Header", "Value")
    dataSource
  }
val player =
  ExoPlayer.Builder(context)
    .setMediaSourceFactory(
      DefaultMediaSourceFactory(context).setDataSourceFactory(dataSourceFactory)
    )
    .build()

Java

DataSource.Factory dataSourceFactory =
    () -> {
      HttpDataSource dataSource = httpDataSourceFactory.createDataSource();
      // Set a custom authentication request header.
      dataSource.setRequestProperty("Header", "Value");
      return dataSource;
    };

ExoPlayer player =
    new ExoPlayer.Builder(context)
        .setMediaSourceFactory(
            new DefaultMediaSourceFactory(context).setDataSourceFactory(dataSourceFactory))
        .build();

在上面的代码段中,注入的 HttpDataSource 在每个 HTTP 请求中都包含标头 "Header: Value"。对于与 HTTP 源的每次互动,此行为都是固定的。

如需采用更精细的方法,您可以使用 ResolvingDataSource 注入实时行为。以下代码段展示了如何在与 HTTP 源交互之前注入请求标头:

Kotlin

val dataSourceFactory: DataSource.Factory =
  ResolvingDataSource.Factory(httpDataSourceFactory) { dataSpec: DataSpec ->
    // Provide just-in-time request headers.
    dataSpec.withRequestHeaders(getCustomHeaders(dataSpec.uri))
  }

Java

    DataSource.Factory dataSourceFactory =
        new ResolvingDataSource.Factory(
            httpDataSourceFactory,
            // Provide just-in-time request headers.
            dataSpec -> dataSpec.withRequestHeaders(getCustomHeaders(dataSpec.uri)));

您还可以使用 ResolvingDataSource 对 URI 进行实时修改,如以下代码段所示:

Kotlin

val dataSourceFactory: DataSource.Factory =
  ResolvingDataSource.Factory(httpDataSourceFactory) { dataSpec: DataSpec ->
    // Provide just-in-time URI resolution logic.
    dataSpec.withUri(resolveUri(dataSpec.uri))
  }

Java

DataSource.Factory dataSourceFactory =
    new ResolvingDataSource.Factory(
        httpDataSourceFactory,
        // Provide just-in-time URI resolution logic.
        dataSpec -> dataSpec.withUri(resolveUri(dataSpec.uri)));

自定义错误处理

实现自定义 LoadErrorHandlingPolicy 可让应用自定义 ExoPlayer 对加载错误的响应方式。例如,应用可能希望快速失败,而不是重试多次,或者可能希望自定义退避逻辑,以控制播放器在每次重试之间等待的时间。以下代码段展示了如何实现自定义退避逻辑:

Kotlin

val loadErrorHandlingPolicy: LoadErrorHandlingPolicy =
  object : DefaultLoadErrorHandlingPolicy() {
    override fun getRetryDelayMsFor(loadErrorInfo: LoadErrorInfo): Long {
      // Implement custom back-off logic here.
      return 0
    }
  }
val player =
  ExoPlayer.Builder(context)
    .setMediaSourceFactory(
      DefaultMediaSourceFactory(context).setLoadErrorHandlingPolicy(loadErrorHandlingPolicy)
    )
    .build()

Java

LoadErrorHandlingPolicy loadErrorHandlingPolicy =
    new DefaultLoadErrorHandlingPolicy() {
      @Override
      public long getRetryDelayMsFor(LoadErrorInfo loadErrorInfo) {
        // Implement custom back-off logic here.
        return 0;
      }
    };

ExoPlayer player =
    new ExoPlayer.Builder(context)
        .setMediaSourceFactory(
            new DefaultMediaSourceFactory(context)
                .setLoadErrorHandlingPolicy(loadErrorHandlingPolicy))
        .build();

LoadErrorInfo 实参包含有关加载失败的更多信息,可用于根据错误类型或失败的请求自定义逻辑。

自定义提取器标志

提取器标志可用于自定义从渐进式媒体中提取各个格式的方式。可以在提供给 DefaultMediaSourceFactoryDefaultExtractorsFactory 上设置这些属性。以下示例传递了一个标志,用于为 MP3 流启用基于索引的搜索。

Kotlin

val extractorsFactory =
  DefaultExtractorsFactory().setMp3ExtractorFlags(Mp3Extractor.FLAG_ENABLE_INDEX_SEEKING)
val player =
  ExoPlayer.Builder(context)
    .setMediaSourceFactory(DefaultMediaSourceFactory(context, extractorsFactory))
    .build()

Java

DefaultExtractorsFactory extractorsFactory =
    new DefaultExtractorsFactory().setMp3ExtractorFlags(Mp3Extractor.FLAG_ENABLE_INDEX_SEEKING);

ExoPlayer player =
    new ExoPlayer.Builder(context)
        .setMediaSourceFactory(new DefaultMediaSourceFactory(context, extractorsFactory))
        .build();

启用恒定比特率搜索

对于 MP3、ADTS 和 AMR 流,您可以使用 FLAG_ENABLE_CONSTANT_BITRATE_SEEKING 标志启用基于恒定比特率假设的近似搜索。如上所述,可以使用各个 DefaultExtractorsFactory.setXyzExtractorFlags 方法为各个提取器设置这些标志。如需为所有支持恒定比特率搜索的提取器启用此功能,请使用 DefaultExtractorsFactory.setConstantBitrateSeekingEnabled

Kotlin

val extractorsFactory = DefaultExtractorsFactory().setConstantBitrateSeekingEnabled(true)

Java

DefaultExtractorsFactory extractorsFactory =
    new DefaultExtractorsFactory().setConstantBitrateSeekingEnabled(true);

然后,可以通过 DefaultMediaSourceFactory 注入 ExtractorsFactory,如上文所述,自定义提取器标志。

启用异步缓冲区排队

异步缓冲区排队是 ExoPlayer 渲染流水线中的一项增强功能,它以异步模式运行 MediaCodec 实例,并使用额外的线程来安排数据的解码和渲染。启用此功能可减少丢帧和音频欠载。

在搭载 Android 12(API 级别 31)及更高版本的设备上,默认启用异步缓冲区排队;从 Android 6.0(API 级别 23)开始,可以手动启用异步缓冲区排队。考虑为出现丢帧或音频欠载的特定设备启用此功能,尤其是在播放受 DRM 保护或高帧率内容时。

在最简单的情况下,您需要向播放器注入 DefaultRenderersFactory,如下所示:

Kotlin

val renderersFactory = 
  DefaultRenderersFactory(context).forceEnableMediaCodecAsynchronousQueueing()
val exoPlayer = ExoPlayer.Builder(context, renderersFactory).build()

Java

DefaultRenderersFactory renderersFactory =
    new DefaultRenderersFactory(context).forceEnableMediaCodecAsynchronousQueueing();
ExoPlayer exoPlayer = new ExoPlayer.Builder(context, renderersFactory).build();

如果您要直接实例化渲染器,请将 new DefaultMediaCodecAdapter.Factory(context).forceEnableAsynchronous() 传递给 MediaCodecVideoRendererMediaCodecAudioRenderer 构造函数。

使用 ForwardingSimpleBasePlayer 自定义操作

您可以通过将 Player 实例封装在 ForwardingSimpleBasePlayer 的子类中,来自定义该实例的部分行为。此类可让您拦截特定的“操作”,而无需直接实现 Player 方法。这可确保 play()pause()setPlayWhenReady(boolean) 等具有一致的行为。它还可确保所有状态更改都正确传播到已注册的 Player.Listener 实例。对于大多数自定义使用情形,由于这些一致性保证,ForwardingSimpleBasePlayer 应优先于更容易出错的 ForwardingPlayer

例如,要在开始或停止播放时添加一些自定义逻辑,请执行以下操作:

Kotlin

class PlayerWithCustomPlay(player: Player) : ForwardingSimpleBasePlayer(player) {
  override fun handleSetPlayWhenReady(playWhenReady: Boolean): ListenableFuture<*> {
    // Add custom logic
    return super.handleSetPlayWhenReady(playWhenReady)
  }
}

Java

class PlayerWithCustomPlay extends ForwardingSimpleBasePlayer {

  public PlayerWithCustomPlay(Player player) {
    super(player);
  }

  @Override
  protected ListenableFuture<?> handleSetPlayWhenReady(boolean playWhenReady) {
    // Add custom logic
    return super.handleSetPlayWhenReady(playWhenReady);
  }
}

或者,如需禁止使用 SEEK_TO_NEXT 命令(并确保 Player.seekToNext 不执行任何操作),请运行以下命令:

Kotlin

class PlayerWithoutSeekToNext(player: Player) : ForwardingSimpleBasePlayer(player) {
  override fun getState(): State {
    val state = super.getState()
    return state
      .buildUpon()
      .setAvailableCommands(
        state.availableCommands.buildUpon().remove(COMMAND_SEEK_TO_NEXT).build()
      )
      .build()
  }

  // We don't need to override handleSeek, because it is guaranteed not to be called for
  // COMMAND_SEEK_TO_NEXT since we've marked that command unavailable.
}

Java

class PlayerWithoutSeekToNext extends ForwardingSimpleBasePlayer {

  public PlayerWithoutSeekToNext(Player player) {
    super(player);
  }

  @Override
  protected State getState() {
    State state = super.getState();
    return state
        .buildUpon()
        .setAvailableCommands(
            state.availableCommands.buildUpon().remove(COMMAND_SEEK_TO_NEXT).build())
        .build();
  }

  // We don't need to override handleSeek, because it is guaranteed not to be called for
  // COMMAND_SEEK_TO_NEXT since we've marked that command unavailable.
}

MediaSource 自定义

上述示例会注入自定义组件,以便在播放传递给播放器的所有 MediaItem 对象时使用。如果需要精细的自定义,还可以将自定义组件注入到各个 MediaSource 实例中,这些实例可以直接传递给播放器。以下示例展示了如何自定义 ProgressiveMediaSource 以使用自定义 DataSource.FactoryExtractorsFactoryLoadErrorHandlingPolicy

Kotlin

val mediaSource =
  ProgressiveMediaSource.Factory(customDataSourceFactory, customExtractorsFactory)
    .setLoadErrorHandlingPolicy(customLoadErrorHandlingPolicy)
    .createMediaSource(MediaItem.fromUri(streamUri))

Java

ProgressiveMediaSource mediaSource =
    new ProgressiveMediaSource.Factory(customDataSourceFactory, customExtractorsFactory)
        .setLoadErrorHandlingPolicy(customLoadErrorHandlingPolicy)
        .createMediaSource(MediaItem.fromUri(streamUri));

创建自定义组件

该库为常见用例提供了本页顶部列出的组件的默认实现。ExoPlayer 可以使用这些组件,但如果需要非标准行为,也可以构建为使用自定义实现。以下是一些自定义实现的应用场景:

  • Renderer - 您可能需要实现自定义 Renderer 来处理库提供的默认实现不支持的媒体类型。
  • TrackSelector - 实现自定义 TrackSelector 可让应用开发者更改 MediaSource 公开的轨道被每个可用 Renderer 选择以供使用的方式。
  • LoadControl - 实现自定义 LoadControl 可让应用开发者更改播放器的缓冲政策。
  • Extractor - 如果您需要支持库目前不支持的容器格式,请考虑实现自定义 Extractor 类。
  • MediaSource - 如果您希望以自定义方式获取媒体样本以馈送到渲染器,或者希望实现自定义 MediaSource 合成行为,则实现自定义 MediaSource 类可能比较合适。
  • MediaSource.Factory - 实现自定义 MediaSource.Factory 可让应用自定义从 MediaItem 创建 MediaSource 的方式。
  • DataSource - ExoPlayer 的上游软件包已包含针对不同使用情形的多种 DataSource 实现。您可能需要实现自己的 DataSource 类,以其他方式加载数据,例如通过自定义协议、使用自定义 HTTP 堆栈或从自定义持久缓存加载数据。

构建自定义组件时,我们建议您采取以下措施:

  • 如果自定义组件需要向应用报告事件,我们建议您使用与现有 ExoPlayer 组件相同的模型,例如使用 EventDispatcher 类或将 Handler 与监听器一起传递给组件的构造函数。
  • 我们建议自定义组件使用与现有 ExoPlayer 组件相同的模型,以便应用在播放期间进行重新配置。为此,自定义组件应实现 PlayerMessage.Target,并在 handleMessage 方法中接收配置更改。应用代码应通过以下方式传递配置更改:调用 ExoPlayer 的 createMessage 方法、配置消息,并使用 PlayerMessage.send 将消息发送到组件。发送要在播放线程上递送的消息可确保这些消息按顺序执行,并与播放器上执行的任何其他操作保持一致。