5d540acbeb
We currently start the timeout as soon as the player enters the target ad, but that ad hasn't loaded yet (= at the point where we actively start waiting for it). And then we try to clear the timeout at various places that mean we are no longer waiting for this ad. This is very error-prone though because there are a lot of places in the AdTagLoader that change the AdPlaybackState and could mark the ad as skipped, failed or loaded. A much less error-prone way of clearing the timeout is not even try to find all places that may revert the wait condition and instead just check if we are still waiting at the point of executing the timeout message. PiperOrigin-RevId: 748291720
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.