com.google.android.exoplayer2.source.ads

Interface AdsLoader

public interface AdsLoader

Interface for loaders of ads, which can be used with AdsMediaSource.

Ad loaders notify the AdsMediaSource about events via AdsLoader.EventListener. In particular, implementations must call AdsLoader.EventListener.onAdPlaybackState(AdPlaybackState) with a new copy of the current AdPlaybackState whenever further information about ads becomes known (for example, when an ad media URI is available, or an ad has played to the end).

attachPlayer(ExoPlayer, EventListener, ViewGroup) will be called when the ads media source first initializes, at which point the loader can request ads. If the player enters the background, detachPlayer() will be called. Loaders should maintain any ad playback state in preparation for a later call to attachPlayer(ExoPlayer, EventListener, ViewGroup). If an ad is playing when the player is detached, update the ad playback state with the current playback position using AdPlaybackState.withAdResumePositionUs(long).

If AdsLoader.EventListener.onAdPlaybackState(AdPlaybackState) has been called, the implementation of attachPlayer(ExoPlayer, EventListener, ViewGroup) should invoke the same listener to provide the existing playback state to the new player.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AdsLoader.EventListener Listener for ad loader events.

Method Summary

Modifier and Type	Method and Description
void	attachPlayer(ExoPlayer player, AdsLoader.EventListener eventListener, android.view.ViewGroup adUiViewGroup) Attaches a player that will play ads loaded using this instance.
void	detachPlayer() Detaches the attached player and event listener.
void	handlePrepareError(int adGroupIndex, int adIndexInAdGroup, java.io.IOException exception) Notifies the ads loader that the player was not able to prepare media for a given ad.
void	release() Releases the loader.
void	setSupportedContentTypes(int... contentTypes) Sets the supported content types for ad media.

Method Detail

setSupportedContentTypes

void setSupportedContentTypes(int... contentTypes)

Sets the supported content types for ad media. Must be called before the first call to attachPlayer(ExoPlayer, EventListener, ViewGroup). Subsequent calls may be ignored.

Parameters:

contentTypes - The supported content types for ad media. Each element must be one of C.TYPE_DASH, C.TYPE_HLS, C.TYPE_SS and C.TYPE_OTHER.

attachPlayer

void attachPlayer(ExoPlayer player,
                  AdsLoader.EventListener eventListener,
                  android.view.ViewGroup adUiViewGroup)

Attaches a player that will play ads loaded using this instance. Called on the main thread by AdsMediaSource.

Parameters:

player - The player instance that will play the loaded ads.

eventListener - Listener for ads loader events.

adUiViewGroup - A ViewGroup on top of the player that will show any ad UI.

detachPlayer

void detachPlayer()

Detaches the attached player and event listener. Called on the main thread by AdsMediaSource.

release

void release()

Releases the loader. Called by the application on the main thread when the instance is no longer needed.

handlePrepareError

void handlePrepareError(int adGroupIndex,
                        int adIndexInAdGroup,
                        java.io.IOException exception)

Notifies the ads loader that the player was not able to prepare media for a given ad. Implementations should update the ad playback state as the specified ad has failed to load.

Parameters:

adGroupIndex - The index of the ad group.

adIndexInAdGroup - The index of the ad in the ad group.

exception - The preparation error.