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. This source cannot be used as a child source in a composition. It must be the top-level source used to prepare the player.

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.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, AdsLoader.AdViewProvider adViewProvider) Constructs a new source that inserts ads linearly with the content specified by contentMediaSource.
AdsMediaSource(MediaSource contentMediaSource, DataSource.Factory dataSourceFactory, AdsLoader adsLoader, AdsLoader.AdViewProvider adViewProvider) 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, long startPositionUs) 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.
java.lang.Object	getTag() Returns the tag set on the media source, or null if none was set.
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(TransferListener mediaTransferListener) 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,
                      AdsLoader.AdViewProvider adViewProvider)

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.

adViewProvider - Provider of views for the ad UI.

AdsMediaSource

public AdsMediaSource(MediaSource contentMediaSource,
                      AdsMediaSource.MediaSourceFactory adMediaSourceFactory,
                      AdsLoader adsLoader,
                      AdsLoader.AdViewProvider adViewProvider)

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.

adViewProvider - Provider of views for the ad UI.

Method Detail

getTag

@Nullable
public java.lang.Object getTag()

Description copied from interface: MediaSource

Returns the tag set on the media source, or null if none was set.

prepareSourceInternal

public void prepareSourceInternal(@Nullable
                                  TransferListener mediaTransferListener)

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:

mediaTransferListener - The transfer listener which should be informed of any media data transfers. May be null if no listener is available. Note that this listener should usually be only informed of transfers related to the media loads and not of auxiliary loads for manifests and other data.

createPeriod

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

Description copied from interface: MediaSource

Returns a new MediaPeriod identified by periodId. This method may be called multiple times 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.

startPositionUs - The expected start position, in microseconds.

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

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.