com.google.android.exoplayer2.ext.ima

Class ImaAdsMediaSource

java.lang.Object

com.google.android.exoplayer2.ext.ima.ImaAdsMediaSource

All Implemented Interfaces:

MediaSource

public final class ImaAdsMediaSource
extends Object
implements MediaSource

A MediaSource that inserts ads linearly with a provided content media source using the Interactive Media Ads SDK for ad loading and tracking.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImaAdsMediaSource.AdsListener Listener for events relating to ad loading.

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.source.MediaSource

MediaSource.Listener, MediaSource.MediaPeriodId

Constructor Summary

Constructors

Constructor and Description
ImaAdsMediaSource(MediaSource contentMediaSource, DataSource.Factory dataSourceFactory, ImaAdsLoader imaAdsLoader, ViewGroup adUiViewGroup) Constructs a new source that inserts ads linearly with the content specified by contentMediaSource.
ImaAdsMediaSource(MediaSource contentMediaSource, DataSource.Factory dataSourceFactory, ImaAdsLoader imaAdsLoader, ViewGroup adUiViewGroup, Handler eventHandler, ImaAdsMediaSource.AdsListener eventListener) Constructs a new source that inserts ads linearly with the content specified by contentMediaSource.

Method Summary

Modifier and Type	Method and Description
MediaPeriod	createPeriod(MediaSource.MediaPeriodId id, Allocator allocator) Returns a new MediaPeriod identified by periodId.
void	maybeThrowSourceInfoRefreshError() Throws any pending error encountered while loading or refreshing source information.
void	prepareSource(ExoPlayer player, boolean isTopLevelSource, MediaSource.Listener listener) Starts preparation of the source.
void	releasePeriod(MediaPeriod mediaPeriod) Releases the period.
void	releaseSource() Releases the source.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImaAdsMediaSource

public ImaAdsMediaSource(MediaSource contentMediaSource,
                         DataSource.Factory dataSourceFactory,
                         ImaAdsLoader imaAdsLoader,
                         ViewGroup adUiViewGroup)

Constructs a new source that inserts ads linearly with the content specified by contentMediaSource.

Parameters:

contentMediaSource - The MediaSource providing the content to play.

dataSourceFactory - Factory for data sources used to load ad media.

imaAdsLoader - The loader for ads.

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

ImaAdsMediaSource

public ImaAdsMediaSource(MediaSource contentMediaSource,
                         DataSource.Factory dataSourceFactory,
                         ImaAdsLoader imaAdsLoader,
                         ViewGroup adUiViewGroup,
                         @Nullable
                         Handler eventHandler,
                         @Nullable
                         ImaAdsMediaSource.AdsListener eventListener)

Constructs a new source that inserts ads linearly with the content specified by contentMediaSource.

Parameters:

contentMediaSource - The MediaSource providing the content to play.

dataSourceFactory - Factory for data sources used to load ad media.

imaAdsLoader - The loader for ads.

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

eventHandler - A handler for events. May be null if delivery of events is not required.

eventListener - A listener of events. May be null if delivery of events is not required.

Method Detail

prepareSource

public void prepareSource(ExoPlayer player,
                          boolean isTopLevelSource,
                          MediaSource.Listener listener)

Description copied from interface: MediaSource

Starts preparation of the source.

Specified by:

prepareSource in interface MediaSource

Parameters:

player - The player for which this source is being prepared.

isTopLevelSource - Whether this source has been passed directly to ExoPlayer.prepare(MediaSource) or ExoPlayer.prepare(MediaSource, boolean, boolean). If false, this source is being prepared by another source (e.g. ConcatenatingMediaSource) for composition.

listener - The listener for source events.

maybeThrowSourceInfoRefreshError

public void maybeThrowSourceInfoRefreshError()
                                      throws IOException

Description copied from interface: MediaSource

Throws any pending error encountered while loading or refreshing source information.

Specified by:

maybeThrowSourceInfoRefreshError in interface MediaSource

Throws:

IOException

createPeriod

public MediaPeriod createPeriod(MediaSource.MediaPeriodId id,
                                Allocator allocator)

Description copied from interface: MediaSource

Returns a new MediaPeriod identified by periodId. This method may be called multiple times with the same period identifier without an intervening call to MediaSource.releasePeriod(MediaPeriod).

Specified by:

createPeriod in interface MediaSource

Parameters:

id - The identifier of the period.

allocator - An Allocator from which to obtain media buffer allocations.

Returns:

A new MediaPeriod.

releasePeriod

public void releasePeriod(MediaPeriod mediaPeriod)

Description copied from interface: MediaSource

Releases the period.

Specified by:

releasePeriod in interface MediaSource

Parameters:

mediaPeriod - The period to release.

releaseSource

public void releaseSource()

Description copied from interface: MediaSource

Releases the source.

This method should be called when the source is no longer required. It may be called in any state.

Specified by:

releaseSource in interface MediaSource