media/extensions/ima
andrewlewis 344932af75 Fix handling of ad group load errors
IMA sometimes delivers an ad group load error just after the time of the ad
group, which is problematic now that we set the expected ad group index based on
the last returned content progress.

Only update the expected ad group index once we are within a fixed preloading
threshold of the next ad.

Also fix updating the ad group to use the new ad count, and check for ad group
load errors when we have no expected ad group defensively.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=185803086
2018-02-16 12:07:43 +00:00
..
src/main Fix handling of ad group load errors 2018-02-16 12:07:43 +00:00
build.gradle Fix some lint issues. 2017-11-20 13:39:03 +00:00
proguard-rules.txt Automated g4 rollback of changelist 184056034. 2018-02-01 15:13:51 +00:00
README.md Update IMA documentation for AdsLoader 2017-10-11 12:29:39 +01:00

ExoPlayer IMA extension

The IMA extension is an AdsLoader implementation wrapping the Interactive Media Ads SDK for Android. You can use it to insert ads alongside content.

Getting the extension

The easiest way to use the extension is to add it as a gradle dependency:

compile 'com.google.android.exoplayer:extension-ima:rX.X.X'

where rX.X.X is the version, which must match the version of the ExoPlayer library being used.

Alternatively, you can clone the ExoPlayer repository and depend on the module locally. Instructions for doing this can be found in ExoPlayer's top level README.

Using the extension

To play ads alongside a single-window content MediaSource, prepare the player with an AdsMediaSource constructed using an ImaAdsLoader, the content MediaSource and an overlay ViewGroup on top of the player. Pass an ad tag URI from your ad campaign when creating the ImaAdsLoader. The IMA documentation includes some sample ad tags for testing.

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 the player returns 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. Reuse it when resuming playback of the same content/ads by passing it in when constructing the new AdsMediaSource. 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 of the content/ads has finished and will not be resumed.

You can try the IMA extension in the ExoPlayer demo app. To do this you must select and build one of the withExtensions build variants of the demo app in Android Studio. You can find IMA test content in the "IMA sample ad tags" section of the app. The demo app's PlayerActivity also shows how to persist the ImaAdsLoader instance and the player position when backgrounded during ad playback.

  • Javadoc: Classes matching com.google.android.exoplayer2.ext.ima.* belong to this module.