1af0b5b432
The new callback allows an app to read data from the content timeline to populate the `AdPlaybackState`. To avoid a deadlock between the `AdMediaSource` waiting for the `AdPlaybackState` and the app waiting for the content `Timeline`, a boolean flag `useLazyContentSourcePreparation` is introduced to tell the `AdsMediaSource` to prepare the content source immediately to make the `Timeline` available. A unit test verifies that in none of the cases (lazy preparation or immediate preparation) a `Timeline` without ad data is leaked to the caller. This ensures that in the case of a preroll, the player won't initially and accidentally read content media data before starting to load the preroll ad. While the content source is prepared early, no content media period must be created before the preroll starts. PiperOrigin-RevId: 696885392
ExoPlayer IMA module
The ExoPlayer IMA module provides an AdsLoader implementation wrapping the Interactive Media Ads SDK for Android. You can use it to insert ads into content played using ExoPlayer.
Getting the module
The easiest way to get the module is to add it as a gradle dependency:
implementation 'androidx.media3:media3-exoplayer-ima:1.X.X'
where 1.X.X is the version, which must match the version of the other media
modules being used.
Alternatively, you can clone this GitHub project and depend on the module locally. Instructions for doing this can be found in the top level README.
Using the module
To use the module, follow the instructions on the
Ad insertion page
of the developer guide. The AdsLoaderProvider passed to the player's
DefaultMediaSourceFactory should return an ImaAdsLoader. Note that the IMA
module only supports players that are accessed on the application's main thread.
Resuming the player after entering the background requires some special
handling when playing ads. The player and its media source are released on
entering the background, and are recreated when returning to the foreground.
When playing ads it is necessary to persist ad playback state while in the
background by keeping a reference to the ImaAdsLoader. When re-entering the
foreground, pass the same instance back when
AdsLoaderProvider.getAdsLoader(MediaItem.AdsConfiguration adsConfiguration)
is called to restore the state. It is also important to persist the player
position when entering the background by storing the value of
player.getContentPosition(). On returning to the foreground, seek to that
position before preparing the new player instance. Finally, it is important to
call ImaAdsLoader.release() when playback has finished and will not be
resumed.
You can try the IMA module in the ExoPlayer demo app, which has test content in
the "IMA sample ad tags" section of the sample chooser. The demo app's
PlayerActivity also shows how to persist the ImaAdsLoader instance and the
player position when backgrounded during ad playback.