com.google.android.exoplayer2.ext.ima

Class ImaAdsLoader

java.lang.Object

com.google.android.exoplayer2.ext.ima.ImaAdsLoader

All Implemented Interfaces:

com.google.ads.interactivemedia.v3.api.AdErrorEvent.AdErrorListener, com.google.ads.interactivemedia.v3.api.AdEvent.AdEventListener, com.google.ads.interactivemedia.v3.api.AdsLoader.AdsLoadedListener, com.google.ads.interactivemedia.v3.api.player.AdProgressProvider, com.google.ads.interactivemedia.v3.api.player.ContentProgressProvider, com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer, Player.EventListener

public final class ImaAdsLoader
extends Object
implements Player.EventListener, com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer, com.google.ads.interactivemedia.v3.api.player.ContentProgressProvider, com.google.ads.interactivemedia.v3.api.AdErrorEvent.AdErrorListener, com.google.ads.interactivemedia.v3.api.AdsLoader.AdsLoadedListener, com.google.ads.interactivemedia.v3.api.AdEvent.AdEventListener

Loads ads using the IMA SDK. All methods are called on the main thread.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer

com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer.VideoAdPlayerCallback

Constructor Summary

Constructors

Constructor and Description
ImaAdsLoader(Context context, Uri adTagUri) Creates a new IMA ads loader.
ImaAdsLoader(Context context, Uri adTagUri, com.google.ads.interactivemedia.v3.api.ImaSdkSettings imaSdkSettings) Creates a new IMA ads loader.

Method Summary

Modifier and Type	Method and Description
void	addCallback(com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer.VideoAdPlayerCallback videoAdPlayerCallback)
com.google.ads.interactivemedia.v3.api.player.VideoProgressUpdate	getAdProgress()
com.google.ads.interactivemedia.v3.api.player.VideoProgressUpdate	getContentProgress()
void	loadAd(String adUriString)
void	onAdError(com.google.ads.interactivemedia.v3.api.AdErrorEvent adErrorEvent)
void	onAdEvent(com.google.ads.interactivemedia.v3.api.AdEvent adEvent)
void	onAdsManagerLoaded(com.google.ads.interactivemedia.v3.api.AdsManagerLoadedEvent adsManagerLoadedEvent)
void	onLoadingChanged(boolean isLoading) Called when the player starts or stops loading the source.
void	onPlaybackParametersChanged(PlaybackParameters playbackParameters) Called when the current playback parameters change.
void	onPlayerError(ExoPlaybackException error) Called when an error occurs.
void	onPlayerStateChanged(boolean playWhenReady, int playbackState) Called when the value returned from either Player.getPlayWhenReady() or Player.getPlaybackState() changes.
void	onPositionDiscontinuity() Called when a position discontinuity occurs without a change to the timeline.
void	onRepeatModeChanged(int repeatMode) Called when the value of Player.getRepeatMode() changes.
void	onTimelineChanged(Timeline timeline, Object manifest) Called when the timeline and/or manifest has been refreshed.
void	onTracksChanged(TrackGroupArray trackGroups, TrackSelectionArray trackSelections) Called when the available or selected tracks change.
void	pauseAd()
void	playAd()
void	release() Releases the loader.
void	removeCallback(com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer.VideoAdPlayerCallback videoAdPlayerCallback)
void	resumeAd()
void	stopAd()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImaAdsLoader

public ImaAdsLoader(Context context,
                    Uri adTagUri)

Creates a new IMA ads loader.

Parameters:

context - The context.

adTagUri - The Uri of an ad tag compatible with the Android IMA SDK. See https://developers.google.com/interactive-media-ads/docs/sdks/android/compatibility for more information.

ImaAdsLoader

public ImaAdsLoader(Context context,
                    Uri adTagUri,
                    com.google.ads.interactivemedia.v3.api.ImaSdkSettings imaSdkSettings)

Creates a new IMA ads loader.

Parameters:

context - The context.

adTagUri - The Uri of an ad tag compatible with the Android IMA SDK. See https://developers.google.com/interactive-media-ads/docs/sdks/android/compatibility for more information.

imaSdkSettings - ImaSdkSettings used to configure the IMA SDK, or null to use the default settings. If set, the player type and version fields may be overwritten.

Method Detail

release

public void release()

Releases the loader. Must be called when the instance is no longer needed.

onAdsManagerLoaded

public void onAdsManagerLoaded(com.google.ads.interactivemedia.v3.api.AdsManagerLoadedEvent adsManagerLoadedEvent)

Specified by:

onAdsManagerLoaded in interface com.google.ads.interactivemedia.v3.api.AdsLoader.AdsLoadedListener

onAdEvent

public void onAdEvent(com.google.ads.interactivemedia.v3.api.AdEvent adEvent)

Specified by:

onAdEvent in interface com.google.ads.interactivemedia.v3.api.AdEvent.AdEventListener

onAdError

public void onAdError(com.google.ads.interactivemedia.v3.api.AdErrorEvent adErrorEvent)

Specified by:

onAdError in interface com.google.ads.interactivemedia.v3.api.AdErrorEvent.AdErrorListener

getContentProgress

public com.google.ads.interactivemedia.v3.api.player.VideoProgressUpdate getContentProgress()

Specified by:

getContentProgress in interface com.google.ads.interactivemedia.v3.api.player.ContentProgressProvider

getAdProgress

public com.google.ads.interactivemedia.v3.api.player.VideoProgressUpdate getAdProgress()

Specified by:

getAdProgress in interface com.google.ads.interactivemedia.v3.api.player.AdProgressProvider

loadAd

public void loadAd(String adUriString)

Specified by:

loadAd in interface com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer

addCallback

public void addCallback(com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer.VideoAdPlayerCallback videoAdPlayerCallback)

Specified by:

addCallback in interface com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer

removeCallback

public void removeCallback(com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer.VideoAdPlayerCallback videoAdPlayerCallback)

Specified by:

removeCallback in interface com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer

playAd

public void playAd()

Specified by:

playAd in interface com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer

stopAd

public void stopAd()

Specified by:

stopAd in interface com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer

pauseAd

public void pauseAd()

Specified by:

pauseAd in interface com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer

resumeAd

public void resumeAd()

Specified by:

resumeAd in interface com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer

onTimelineChanged

public void onTimelineChanged(Timeline timeline,
                              Object manifest)

Description copied from interface: Player.EventListener

Called when the timeline and/or manifest has been refreshed.

Note that if the timeline has changed then a position discontinuity may also have occurred. For example, the current period index may have changed as a result of periods being added or removed from the timeline. This will not be reported via a separate call to Player.EventListener.onPositionDiscontinuity().

Specified by:

onTimelineChanged in interface Player.EventListener

Parameters:

timeline - The latest timeline. Never null, but may be empty.

manifest - The latest manifest. May be null.

onTracksChanged

public void onTracksChanged(TrackGroupArray trackGroups,
                            TrackSelectionArray trackSelections)

Description copied from interface: Player.EventListener

Called when the available or selected tracks change.

Specified by:

onTracksChanged in interface Player.EventListener

Parameters:

trackGroups - The available tracks. Never null, but may be of length zero.

trackSelections - The track selections for each renderer. Never null and always of length Player.getRendererCount(), but may contain null elements.

onLoadingChanged

public void onLoadingChanged(boolean isLoading)

Description copied from interface: Player.EventListener

Called when the player starts or stops loading the source.

Specified by:

onLoadingChanged in interface Player.EventListener

Parameters:

isLoading - Whether the source is currently being loaded.

onPlayerStateChanged

public void onPlayerStateChanged(boolean playWhenReady,
                                 int playbackState)

Description copied from interface: Player.EventListener

Called when the value returned from either Player.getPlayWhenReady() or Player.getPlaybackState() changes.

Specified by:

onPlayerStateChanged in interface Player.EventListener

Parameters:

playWhenReady - Whether playback will proceed when ready.

playbackState - One of the STATE constants.

onRepeatModeChanged

public void onRepeatModeChanged(int repeatMode)

Description copied from interface: Player.EventListener

Called when the value of Player.getRepeatMode() changes.

Specified by:

onRepeatModeChanged in interface Player.EventListener

Parameters:

repeatMode - The Player.RepeatMode used for playback.

onPlayerError

public void onPlayerError(ExoPlaybackException error)

Description copied from interface: Player.EventListener

Called when an error occurs. The playback state will transition to Player.STATE_IDLE immediately after this method is called. The player instance can still be used, and Player.release() must still be called on the player should it no longer be required.

Specified by:

onPlayerError in interface Player.EventListener

Parameters:

error - The error.

onPositionDiscontinuity

public void onPositionDiscontinuity()

Description copied from interface: Player.EventListener

Called when a position discontinuity occurs without a change to the timeline. A position discontinuity occurs when the current window or period index changes (as a result of playback transitioning from one period in the timeline to the next), or when the playback position jumps within the period currently being played (as a result of a seek being performed, or when the source introduces a discontinuity internally).

When a position discontinuity occurs as a result of a change to the timeline this method is not called. Player.EventListener.onTimelineChanged(Timeline, Object) is called in this case.

Specified by:

onPositionDiscontinuity in interface Player.EventListener

onPlaybackParametersChanged

public void onPlaybackParametersChanged(PlaybackParameters playbackParameters)

Description copied from interface: Player.EventListener

Called when the current playback parameters change. The playback parameters may change due to a call to Player.setPlaybackParameters(PlaybackParameters), or the player itself may change them (for example, if audio playback switches to passthrough mode, where speed adjustment is no longer possible).

Specified by:

onPlaybackParametersChanged in interface Player.EventListener

Parameters:

playbackParameters - The playback parameters.