com.google.android.exoplayer2.source.ads

Class AdsMediaSource

java.lang.Object

com.google.android.exoplayer2.source.BaseMediaSource

com.google.android.exoplayer2.source.CompositeMediaSource<MediaSource.MediaPeriodId>

com.google.android.exoplayer2.source.ads.AdsMediaSource

All Implemented Interfaces:

MediaSource

public final class AdsMediaSource
extends CompositeMediaSource<MediaSource.MediaPeriodId>

A MediaSource that inserts ads linearly with a provided content media source.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdsMediaSource.AdLoadException Wrapper for exceptions that occur while loading ads, which are notified via MediaSourceEventListener#onLoadError(int, MediaPeriodId, LoadEventInfo, MediaLoadData, IOException, boolean).
static interface	AdsMediaSource.EventListener Deprecated. To listen for ad load error events, add a listener via BaseMediaSource.addEventListener(Handler, MediaSourceEventListener) and check for AdsMediaSource.AdLoadExceptions in MediaSourceEventListener#onLoadError(int, MediaPeriodId, LoadEventInfo, MediaLoadData, IOException, boolean). Individual ads loader implementations should expose ad interaction events, if applicable.
static interface	AdsMediaSource.MediaSourceFactory Factory for creating MediaSources to play ad media.

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

MediaSource.MediaPeriodId, MediaSource.SourceInfoRefreshListener

Constructor Summary

Constructors

Constructor and Description
AdsMediaSource(MediaSource contentMediaSource, AdsMediaSource.MediaSourceFactory adMediaSourceFactory, AdsLoader adsLoader, android.view.ViewGroup adUiViewGroup) Constructs a new source that inserts ads linearly with the content specified by contentMediaSource.
AdsMediaSource(MediaSource contentMediaSource, AdsMediaSource.MediaSourceFactory adMediaSourceFactory, AdsLoader adsLoader, android.view.ViewGroup adUiViewGroup, android.os.Handler eventHandler, AdsMediaSource.EventListener eventListener) Deprecated. To listen for ad load error events, add a listener via BaseMediaSource.addEventListener(Handler, MediaSourceEventListener) and check for AdsMediaSource.AdLoadExceptions in MediaSourceEventListener#onLoadError(int, MediaPeriodId, LoadEventInfo, MediaLoadData, IOException, boolean). Individual ads loader implementations should expose ad interaction events, if applicable.
AdsMediaSource(MediaSource contentMediaSource, DataSource.Factory dataSourceFactory, AdsLoader adsLoader, android.view.ViewGroup adUiViewGroup) Constructs a new source that inserts ads linearly with the content specified by contentMediaSource.
AdsMediaSource(MediaSource contentMediaSource, DataSource.Factory dataSourceFactory, AdsLoader adsLoader, android.view.ViewGroup adUiViewGroup, android.os.Handler eventHandler, AdsMediaSource.EventListener eventListener) Deprecated. To listen for ad load error events, add a listener via BaseMediaSource.addEventListener(Handler, MediaSourceEventListener) and check for AdsMediaSource.AdLoadExceptions in MediaSourceEventListener#onLoadError(int, MediaPeriodId, LoadEventInfo, MediaLoadData, IOException, boolean). Individual ads loader implementations should expose ad interaction events, if applicable.

Method Summary

Modifier and Type	Method and Description
MediaPeriod	createPeriod(MediaSource.MediaPeriodId id, Allocator allocator) Returns a new MediaPeriod identified by periodId.
protected MediaSource.MediaPeriodId	getMediaPeriodIdForChildMediaPeriodId(MediaSource.MediaPeriodId childId, MediaSource.MediaPeriodId mediaPeriodId) Returns the MediaPeriodId in the composite source corresponding to the specified MediaPeriodId in a child source.
protected void	onChildSourceInfoRefreshed(MediaSource.MediaPeriodId mediaPeriodId, MediaSource mediaSource, Timeline timeline, java.lang.Object manifest) Called when the source info of a child source has been refreshed.
void	prepareSourceInternal(ExoPlayer player, boolean isTopLevelSource) Starts source preparation.
void	releasePeriod(MediaPeriod mediaPeriod) Releases the period.
void	releaseSourceInternal() Releases the source.

Methods inherited from class com.google.android.exoplayer2.source.CompositeMediaSource

getMediaTimeForChildMediaTime, getWindowIndexForChildWindowIndex, maybeThrowSourceInfoRefreshError, prepareChildSource, releaseChildSource

Methods inherited from class com.google.android.exoplayer2.source.BaseMediaSource

addEventListener, createEventDispatcher, createEventDispatcher, createEventDispatcher, prepareSource, refreshSourceInfo, releaseSource, removeEventListener

Methods inherited from class java.lang.Object

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

Constructor Detail

AdsMediaSource

public AdsMediaSource(MediaSource contentMediaSource,
                      DataSource.Factory dataSourceFactory,
                      AdsLoader adsLoader,
                      android.view.ViewGroup adUiViewGroup)

Constructs a new source that inserts ads linearly with the content specified by contentMediaSource. Ad media is loaded using ExtractorMediaSource.

Parameters:

contentMediaSource - The MediaSource providing the content to play.

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

adsLoader - The loader for ads.

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

AdsMediaSource

public AdsMediaSource(MediaSource contentMediaSource,
                      AdsMediaSource.MediaSourceFactory adMediaSourceFactory,
                      AdsLoader adsLoader,
                      android.view.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.

adMediaSourceFactory - Factory for media sources used to load ad media.

adsLoader - The loader for ads.

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

AdsMediaSource

@Deprecated
public AdsMediaSource(MediaSource contentMediaSource,
                                  DataSource.Factory dataSourceFactory,
                                  AdsLoader adsLoader,
                                  android.view.ViewGroup adUiViewGroup,
                                  @Nullable
                                  android.os.Handler eventHandler,
                                  @Nullable
                                  AdsMediaSource.EventListener eventListener)

Deprecated. To listen for ad load error events, add a listener via BaseMediaSource.addEventListener(Handler, MediaSourceEventListener) and check for AdsMediaSource.AdLoadExceptions in MediaSourceEventListener#onLoadError(int, MediaPeriodId, LoadEventInfo, MediaLoadData, IOException, boolean). Individual ads loader implementations should expose ad interaction events, if applicable.

Constructs a new source that inserts ads linearly with the content specified by contentMediaSource. Ad media is loaded using ExtractorMediaSource.

Parameters:

contentMediaSource - The MediaSource providing the content to play.

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

adsLoader - 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.

AdsMediaSource

@Deprecated
public AdsMediaSource(MediaSource contentMediaSource,
                                  AdsMediaSource.MediaSourceFactory adMediaSourceFactory,
                                  AdsLoader adsLoader,
                                  android.view.ViewGroup adUiViewGroup,
                                  @Nullable
                                  android.os.Handler eventHandler,
                                  @Nullable
                                  AdsMediaSource.EventListener eventListener)

Deprecated. To listen for ad load error events, add a listener via BaseMediaSource.addEventListener(Handler, MediaSourceEventListener) and check for AdsMediaSource.AdLoadExceptions in MediaSourceEventListener#onLoadError(int, MediaPeriodId, LoadEventInfo, MediaLoadData, IOException, boolean). Individual ads loader implementations should expose ad interaction events, if applicable.

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

Parameters:

contentMediaSource - The MediaSource providing the content to play.

adMediaSourceFactory - Factory for media sources used to load ad media.

adsLoader - 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

prepareSourceInternal

public void prepareSourceInternal(ExoPlayer player,
                                  boolean isTopLevelSource)

Description copied from class: BaseMediaSource

Starts source preparation. This method is called at most once until the next call to BaseMediaSource.releaseSourceInternal().

Overrides:

prepareSourceInternal in class CompositeMediaSource<MediaSource.MediaPeriodId>

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).

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).

Should not be called directly from application code.

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.

Should not be called directly from application code.

Parameters:

mediaPeriod - The period to release.

releaseSourceInternal

public void releaseSourceInternal()

Description copied from class: BaseMediaSource

Releases the source. This method is called exactly once after each call to BaseMediaSource.prepareSourceInternal(ExoPlayer, boolean).

Overrides:

releaseSourceInternal in class CompositeMediaSource<MediaSource.MediaPeriodId>

onChildSourceInfoRefreshed

protected void onChildSourceInfoRefreshed(MediaSource.MediaPeriodId mediaPeriodId,
                                          MediaSource mediaSource,
                                          Timeline timeline,
                                          @Nullable
                                          java.lang.Object manifest)

Description copied from class: CompositeMediaSource

Called when the source info of a child source has been refreshed.

Specified by:

onChildSourceInfoRefreshed in class CompositeMediaSource<MediaSource.MediaPeriodId>

Parameters:

mediaPeriodId - The unique id used to prepare the child source.

mediaSource - The child source whose source info has been refreshed.

timeline - The timeline of the child source.

manifest - The manifest of the child source.

getMediaPeriodIdForChildMediaPeriodId

@Nullable
protected MediaSource.MediaPeriodId getMediaPeriodIdForChildMediaPeriodId(MediaSource.MediaPeriodId childId,
                                                                                    MediaSource.MediaPeriodId mediaPeriodId)

Description copied from class: CompositeMediaSource

Returns the MediaPeriodId in the composite source corresponding to the specified MediaPeriodId in a child source. The default implementation does not change the media period id.

Overrides:

getMediaPeriodIdForChildMediaPeriodId in class CompositeMediaSource<MediaSource.MediaPeriodId>

Parameters:

childId - The unique id used to prepare the child source.

mediaPeriodId - A MediaPeriodId of the child source.

Returns:

The corresponding MediaPeriodId in the composite source. Null if no corresponding media period id can be determined.