插入广告

ExoPlayer 既可用于客户端广告插播，也可用于服务器端广告插播。

客户端广告插入

在客户端广告插入中，播放器会在播放内容和广告之间切换时，从不同的网址加载媒体。广告的相关信息与媒体（例如 XML VAST 或 VMAP 广告代码）分开加载。这可能包括相对于内容开始位置的广告提示位置、实际的广告媒体 URI 以及元数据（例如给定广告是否可跳过）。

使用 ExoPlayer 的 AdsMediaSource 进行客户端广告插入时，播放器会拥有有关要播放的广告的信息。这样做有几个好处：

• 播放器可以使用其 API 公开与广告相关的元数据和功能。
• ExoPlayer 界面组件可以自动显示广告位置的标记，并根据广告是否在播放更改其行为。
• 在内部，播放器可以在广告和内容之间切换时保持一致的缓冲区。

在此设置中，播放器负责在广告和内容之间切换，这意味着应用无需针对广告和内容控制多个单独的后台/前台播放器。

在准备内容视频和广告代码以便与客户端广告插入搭配使用时，广告最好位于内容视频中的同步样本（关键帧）处，以便播放器能够顺畅地继续播放内容。

声明式广告支持

构建 MediaItem 时，您可以指定广告代码 URI：

Kotlin

val mediaItem =
  MediaItem.Builder()
    .setUri(videoUri)
    .setAdsConfiguration(MediaItem.AdsConfiguration.Builder(adTagUri).build())
    .build()

Java

MediaItem mediaItem =
    new MediaItem.Builder()
        .setUri(videoUri)
        .setAdsConfiguration(
            new MediaItem.AdsConfiguration.Builder(adTagUri).build())
        .build();

如需为指定广告代码的媒体内容启用播放器支持，您必须在创建播放器时构建并注入配置了 AdsLoader.Provider 和 AdViewProvider 的 DefaultMediaSourceFactory：

Kotlin

val mediaSourceFactory: MediaSource.Factory =
  DefaultMediaSourceFactory(context).setLocalAdInsertionComponents(adsLoaderProvider, playerView)
val player = ExoPlayer.Builder(context).setMediaSourceFactory(mediaSourceFactory).build()

Java

MediaSource.Factory mediaSourceFactory =
    new DefaultMediaSourceFactory(context)
        .setLocalAdInsertionComponents(adsLoaderProvider, /* adViewProvider= */ playerView);
ExoPlayer player =
    new ExoPlayer.Builder(context).setMediaSourceFactory(mediaSourceFactory).build();

在内部，DefaultMediaSourceFactory 会将内容媒体源封装在 AdsMediaSource 中。AdsMediaSource 将从 AdsLoader.Provider 获取 AdsLoader，并使用它根据媒体内容的广告代码插入广告。

ExoPlayer 的 PlayerView 实现了 AdViewProvider。ExoPlayer IMA 库提供了易于使用的 AdsLoader，如下所述。

含广告的播放列表

播放包含多个媒体项的播放列表时，默认行为是为每个媒体 ID、内容 URI 和广告代码 URI 组合请求广告代码并存储一次广告播放状态。这意味着，对于具有不同媒体 ID 或内容 URI 的广告，用户会看到每个媒体项的广告，即使广告代码 URI 匹配也是如此。如果媒体内容重复播放，用户只会看到相应的广告一次（广告播放状态会存储广告是否已播放，因此广告会在首次出现后被跳过）。

您可以通过传递不透明的广告标识符（与给定媒体内容的广告播放状态相关联，基于对象等式）来自定义此行为。下面的示例中，广告播放状态仅与广告代码 URI 相关联（而非媒体 ID 和广告代码 URI 的组合），因为广告代码 URI 被作为广告标识符传递。这样一来，广告只会加载一次，并且当用户从头到尾播放播放列表时，不会在第二个内容中看到广告。

Kotlin

// Build the media items, passing the same ads identifier for both items,
// which means they share ad playback state so ads play only once.
val firstItem =
  MediaItem.Builder()
    .setUri(firstVideoUri)
    .setAdsConfiguration(MediaItem.AdsConfiguration.Builder(adTagUri).setAdsId(adTagUri).build())
    .build()
val secondItem =
  MediaItem.Builder()
    .setUri(secondVideoUri)
    .setAdsConfiguration(MediaItem.AdsConfiguration.Builder(adTagUri).setAdsId(adTagUri).build())
    .build()
player.addMediaItem(firstItem)
player.addMediaItem(secondItem)

Java

// Build the media items, passing the same ads identifier for both items,
// which means they share ad playback state so ads play only once.
MediaItem firstItem =
    new MediaItem.Builder()
        .setUri(firstVideoUri)
        .setAdsConfiguration(
            new MediaItem.AdsConfiguration.Builder(adTagUri).setAdsId(adTagUri).build())
        .build();
MediaItem secondItem =
    new MediaItem.Builder()
        .setUri(secondVideoUri)
        .setAdsConfiguration(
            new MediaItem.AdsConfiguration.Builder(adTagUri).setAdsId(adTagUri).build())
        .build();
player.addMediaItem(firstItem);
player.addMediaItem(secondItem);

ExoPlayer IMA 库

ExoPlayer IMA 库提供了 ImaAdsLoader，可让您轻松地将客户端广告插入集成到您的应用中。它封装了客户端 IMA SDK 的功能，以支持插入 VAST/VMAP 广告。如需了解如何使用该库（包括如何处理后台播放和恢复播放），请参阅自述文件。

演示版应用使用 IMA 库，并在示例列表中包含多个 VAST/VMAP 广告代码示例。

界面注意事项

默认情况下，PlayerView 会在广告播放期间隐藏其传输控件，但应用可以通过调用 setControllerHideDuringAds 来切换此行为。在广告播放期间，IMA SDK 会在播放器上方显示其他视图（例如“更多信息”链接和跳过按钮，如果适用）。

注意 ：由于广告客户希望在各个应用中获得一致的体验，因此 IMA SDK 不允许自定义广告播放期间显示的视图。因此，您无法移除或重新定位“跳过”按钮、更改字体，或对这些视图的外观进行其他自定义。

IMA SDK 可能会报告广告是否因在播放器上呈现的应用提供的视图被遮挡。如果应用需要叠加对控制播放至关重要的视图，则必须在 IMA SDK 中注册这些视图，以便在计算可见度时将其忽略。使用 PlayerView 作为 AdViewProvider 时，它会自动注册其控件叠加层。使用自定义播放器界面的应用必须通过从 AdViewProvider.getAdOverlayInfos 返回叠加层视图来注册叠加层视图。

如需详细了解叠加视图，请参阅 IMA SDK 中的 Open Measurement。

随播广告

某些广告代码包含可以在应用界面的“广告位”中展示的其他随播广告。这些槽可通过 ImaAdsLoader.Builder.setCompanionAdSlots(slots) 传递。如需了解详情，请参阅添加随播广告。

独立广告

IMA SDK 旨在将广告插入媒体内容中，而不是单独播放广告。因此，IMA 库不支持播放独立广告。对于此用例，我们建议改用 Google 移动广告 SDK。

使用第三方广告 SDK

如果您需要通过第三方广告 SDK 加载广告，则有必要检查它是否已提供 ExoPlayer 集成。如果没有，建议实现封装第三方广告 SDK 的自定义 AdsLoader，因为它具有上述 AdsMediaSource 的优势。ImaAdsLoader 用作实现示例。

或者，您也可以使用 ExoPlayer 的播放列表支持功能来构建一系列广告和内容片段：

Kotlin

// A pre-roll ad.
val preRollAd = MediaItem.fromUri(preRollAdUri)
// The start of the content.
val contentStart =
  MediaItem.Builder()
    .setUri(contentUri)
    .setClippingConfiguration(ClippingConfiguration.Builder().setEndPositionMs(120000).build())
    .build()
// A mid-roll ad.
val midRollAd = MediaItem.fromUri(midRollAdUri)
// The rest of the content
val contentEnd =
  MediaItem.Builder()
    .setUri(contentUri)
    .setClippingConfiguration(ClippingConfiguration.Builder().setStartPositionMs(120000).build())
    .build()

// Build the playlist.
player.addMediaItem(preRollAd)
player.addMediaItem(contentStart)
player.addMediaItem(midRollAd)
player.addMediaItem(contentEnd)

Java

// A pre-roll ad.
MediaItem preRollAd = MediaItem.fromUri(preRollAdUri);
// The start of the content.
MediaItem contentStart =
    new MediaItem.Builder()
        .setUri(contentUri)
        .setClippingConfiguration(
            new ClippingConfiguration.Builder().setEndPositionMs(120_000).build())
        .build();
// A mid-roll ad.
MediaItem midRollAd = MediaItem.fromUri(midRollAdUri);
// The rest of the content
MediaItem contentEnd =
    new MediaItem.Builder()
        .setUri(contentUri)
        .setClippingConfiguration(
            new ClippingConfiguration.Builder().setStartPositionMs(120_000).build())
        .build();

// Build the playlist.
player.addMediaItem(preRollAd);
player.addMediaItem(contentStart);
player.addMediaItem(midRollAd);
player.addMediaItem(contentEnd);

服务器端广告插播

在服务器端广告插播（也称为动态广告插播 [DAI]）中，媒体串流同时包含广告和内容。DASH 清单可以同时指向内容和广告片段，可能位于不同的时段。对于 HLS，请参阅有关将广告添加到播放列表的 Apple 文档。

使用服务器端广告插入时，客户端可能需要动态解析媒体网址以获取拼接的直播，可能需要在界面中显示广告叠加层，或者可能需要向广告 SDK 或广告服务器报告事件。

对于使用 ssai:// 架构的 URI，ExoPlayer 的 DefaultMediaSourceFactory 可以将所有这些任务委托给服务器端广告插入 MediaSource：

Kotlin

val player =
  ExoPlayer.Builder(context)
    .setMediaSourceFactory(
      DefaultMediaSourceFactory(context).setServerSideAdInsertionMediaSourceFactory(ssaiFactory)
    )
    .build()

Java

Player player =
    new ExoPlayer.Builder(context)
        .setMediaSourceFactory(
            new DefaultMediaSourceFactory(context)
                .setServerSideAdInsertionMediaSourceFactory(ssaiFactory))
        .build();

ExoPlayer IMA 库

ExoPlayer IMA 库提供 ImaServerSideAdInsertionMediaSource，可让您轻松在应用中将 IMA 服务器端插入的广告流集成在一起。它封装了 IMA DAI SDK for Android 的功能，并将提供的广告元数据完全集成到播放器中。例如，这样一来，您就可以使用 Player.isPlayingAd() 等方法，监听内容广告转换，并让播放器处理广告播放逻辑（例如跳过已播放的广告）。

如需使用此类，您需要设置 ImaServerSideAdInsertionMediaSource.AdsLoader 和 ImaServerSideAdInsertionMediaSource.Factory，并将它们连接到玩家：

Kotlin

// MediaSource.Factory to load the actual media stream.
val defaultMediaSourceFactory = DefaultMediaSourceFactory(context)
// AdsLoader that can be reused for multiple playbacks.
val adsLoader =
  ImaServerSideAdInsertionMediaSource.AdsLoader.Builder(context, adViewProvider).build()
// MediaSource.Factory to create the ad sources for the current player.
val adsMediaSourceFactory =
  ImaServerSideAdInsertionMediaSource.Factory(adsLoader, defaultMediaSourceFactory)
// Configure DefaultMediaSourceFactory to create both IMA DAI sources and
// regular media sources. If you just play IMA DAI streams, you can also use
// adsMediaSourceFactory directly.
defaultMediaSourceFactory.setServerSideAdInsertionMediaSourceFactory(adsMediaSourceFactory)
// Set the MediaSource.Factory on the Player.
val player = ExoPlayer.Builder(context).setMediaSourceFactory(defaultMediaSourceFactory).build()
// Set the player on the AdsLoader
adsLoader.setPlayer(player)

Java

// MediaSource.Factory to load the actual media stream.
DefaultMediaSourceFactory defaultMediaSourceFactory = new DefaultMediaSourceFactory(context);
// AdsLoader that can be reused for multiple playbacks.
ImaServerSideAdInsertionMediaSource.AdsLoader adsLoader =
    new ImaServerSideAdInsertionMediaSource.AdsLoader.Builder(context, adViewProvider).build();
// MediaSource.Factory to create the ad sources for the current player.
ImaServerSideAdInsertionMediaSource.Factory adsMediaSourceFactory =
    new ImaServerSideAdInsertionMediaSource.Factory(adsLoader, defaultMediaSourceFactory);
// Configure DefaultMediaSourceFactory to create both IMA DAI sources and
// regular media sources. If you just play IMA DAI streams, you can also use
// adsMediaSourceFactory directly.
defaultMediaSourceFactory.setServerSideAdInsertionMediaSourceFactory(adsMediaSourceFactory);
// Set the MediaSource.Factory on the Player.
Player player =
    new ExoPlayer.Builder(context).setMediaSourceFactory(defaultMediaSourceFactory).build();
// Set the player on the AdsLoader
adsLoader.setPlayer(player);

使用 ImaServerSideAdInsertionUriBuilder 构建网址，以加载 IMA 资产键或内容来源 ID 和视频 ID：

Kotlin

val ssaiUri =
  ImaServerSideAdInsertionUriBuilder()
    .setAssetKey(assetKey)
    .setFormat(C.CONTENT_TYPE_HLS)
    .build()
player.setMediaItem(MediaItem.fromUri(ssaiUri))

Java

Uri ssaiUri =
    new ImaServerSideAdInsertionUriBuilder()
        .setAssetKey(assetKey)
        .setFormat(C.CONTENT_TYPE_HLS)
        .build();
player.setMediaItem(MediaItem.fromUri(ssaiUri));

最后，在广告加载器不再使用后释放它：

Kotlin

adsLoader.release()

Java

adsLoader.release();

注意： 目前，同一播放列表中仅支持单个 IMA 服务器端广告插入串流。您可以将该数据流与其他媒体组合使用，但不能与其他 IMA 服务器端广告插入数据流组合使用。

界面注意事项

与客户端广告插播相关的界面注意事项也适用于服务器端广告插播。

随播广告

某些广告代码包含可以在应用界面的“广告位”中展示的其他随播广告。这些槽可通过 ImaServerSideAdInsertionMediaSource.AdsLoader.Builder.setCompanionAdSlots(slots) 传递。如需了解详情，请参阅添加随播广告。

使用第三方广告 SDK

如果您需要使用第三方广告 SDK 加载广告，不妨检查该 SDK 是否已提供 ExoPlayer 集成。如果不是，建议您提供一个自定义 MediaSource，以接受与 ImaServerSideAdInsertionMediaSource 类似的采用 ssai:// 架构的 URI。

创建广告结构的实际逻辑可以委托给通用 ServerSideAdInsertionMediaSource，它会封装数据流 MediaSource 并允许用户设置和更新表示广告元数据的 AdPlaybackState。

通常，服务器端插入的广告串包含定时事件，用于通知玩家广告元数据。如需了解 ExoPlayer 支持哪些时间戳元数据格式，请参阅支持的格式。自定义广告 SDK MediaSource 实现可以使用 Player.Listener.onMetadata 监听来自播放器的时间戳元数据事件。