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
@Deprecated public final class AdsMediaSource extends CompositeMediaSource<MediaSource.MediaPeriodId>
Deprecated.com.google.android.exoplayer2 is deprecated. Please migrate to androidx.media3 (which contains the same ExoPlayer code). See the migration guide for more details, including a script to help with the migration.AMediaSource
that inserts ads linearly into a provided content media source.The wrapped content media source must contain a single
Timeline.Period
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AdsMediaSource.AdLoadException
Deprecated.Wrapper for exceptions that occur while loading ads, which are notified viaMediaSourceEventListener.onLoadError(int, MediaPeriodId, LoadEventInfo, MediaLoadData, IOException, boolean)
.-
Nested classes/interfaces inherited from interface com.google.android.exoplayer2.source.MediaSource
MediaSource.Factory, MediaSource.MediaPeriodId, MediaSource.MediaSourceCaller
-
-
Constructor Summary
Constructors Constructor Description AdsMediaSource(MediaSource contentMediaSource, DataSpec adTagDataSpec, Object adsId, MediaSource.Factory adMediaSourceFactory, AdsLoader adsLoader, AdViewProvider adViewProvider)
Deprecated.Constructs a new source that inserts ads linearly with the content specified bycontentMediaSource
.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MediaPeriod
createPeriod(MediaSource.MediaPeriodId id, Allocator allocator, long startPositionUs)
Deprecated.Returns a newMediaPeriod
identified byperiodId
.MediaItem
getMediaItem()
Deprecated.Returns theMediaItem
whose media is provided by the source.protected MediaSource.MediaPeriodId
getMediaPeriodIdForChildMediaPeriodId(MediaSource.MediaPeriodId childSourceId, MediaSource.MediaPeriodId mediaPeriodId)
Deprecated.Returns theMediaSource.MediaPeriodId
in the composite source corresponding to the specifiedMediaSource.MediaPeriodId
in a child source.protected void
onChildSourceInfoRefreshed(MediaSource.MediaPeriodId childSourceId, MediaSource mediaSource, Timeline newTimeline)
Deprecated.Called when the source info of a child source has been refreshed.protected void
prepareSourceInternal(TransferListener mediaTransferListener)
Deprecated.Starts source preparation and enables the source, seeBaseMediaSource.prepareSource(MediaSourceCaller, TransferListener, PlayerId)
.void
releasePeriod(MediaPeriod mediaPeriod)
Deprecated.Releases the period.protected void
releaseSourceInternal()
Deprecated.Releases the source, seeBaseMediaSource.releaseSource(MediaSourceCaller)
.-
Methods inherited from class com.google.android.exoplayer2.source.CompositeMediaSource
disableChildSource, disableInternal, enableChildSource, enableInternal, getMediaTimeForChildMediaTime, getWindowIndexForChildWindowIndex, maybeThrowSourceInfoRefreshError, prepareChildSource, releaseChildSource
-
Methods inherited from class com.google.android.exoplayer2.source.BaseMediaSource
addDrmEventListener, addEventListener, createDrmEventDispatcher, createDrmEventDispatcher, createEventDispatcher, createEventDispatcher, createEventDispatcher, createEventDispatcher, disable, enable, getPlayerId, isEnabled, prepareSource, prepareSource, refreshSourceInfo, releaseSource, removeDrmEventListener, removeEventListener
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.google.android.exoplayer2.source.MediaSource
getInitialTimeline, isSingleWindow
-
-
-
-
Constructor Detail
-
AdsMediaSource
public AdsMediaSource(MediaSource contentMediaSource, DataSpec adTagDataSpec, Object adsId, MediaSource.Factory adMediaSourceFactory, AdsLoader adsLoader, AdViewProvider adViewProvider)
Deprecated.Constructs a new source that inserts ads linearly with the content specified bycontentMediaSource
.- Parameters:
contentMediaSource
- TheMediaSource
providing the content to play.adTagDataSpec
- The data specification of the ad tag to load.adsId
- An opaque identifier for ad playback state associated with this instance. Ad loading and playback state is shared among all playlist items that have the same ads id (byequality
), so it is important to pass the same identifiers when constructing playlist items each time the player returns to the foreground.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
-
getMediaItem
public MediaItem getMediaItem()
Deprecated.Description copied from interface:MediaSource
Returns theMediaItem
whose media is provided by the source.Should not be called directly from application code.
This method must be called on the application thread.
-
prepareSourceInternal
protected void prepareSourceInternal(@Nullable TransferListener mediaTransferListener)
Deprecated.Description copied from class:BaseMediaSource
Starts source preparation and enables the source, seeBaseMediaSource.prepareSource(MediaSourceCaller, TransferListener, PlayerId)
. This method is called at most once until the next call toBaseMediaSource.releaseSourceInternal()
.- Overrides:
prepareSourceInternal
in classCompositeMediaSource<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)
Deprecated.Description copied from interface:MediaSource
Returns a newMediaPeriod
identified byperiodId
.Should not be called directly from application code.
This method must be called on the playback thread and only if the source is enabled.
- Parameters:
id
- The identifier of the period.allocator
- AnAllocator
from which to obtain media buffer allocations.startPositionUs
- The expected start position, in microseconds.- Returns:
- A new
MediaPeriod
.
-
releasePeriod
public void releasePeriod(MediaPeriod mediaPeriod)
Deprecated.Description copied from interface:MediaSource
Releases the period.Should not be called directly from application code.
This method must be called on the playback thread.
- Parameters:
mediaPeriod
- The period to release.
-
releaseSourceInternal
protected void releaseSourceInternal()
Deprecated.Description copied from class:BaseMediaSource
Releases the source, seeBaseMediaSource.releaseSource(MediaSourceCaller)
. This method is called exactly once after each call toBaseMediaSource.prepareSourceInternal(TransferListener)
.- Overrides:
releaseSourceInternal
in classCompositeMediaSource<MediaSource.MediaPeriodId>
-
onChildSourceInfoRefreshed
protected void onChildSourceInfoRefreshed(MediaSource.MediaPeriodId childSourceId, MediaSource mediaSource, Timeline newTimeline)
Deprecated.Description copied from class:CompositeMediaSource
Called when the source info of a child source has been refreshed.- Specified by:
onChildSourceInfoRefreshed
in classCompositeMediaSource<MediaSource.MediaPeriodId>
- Parameters:
childSourceId
- The unique id used to prepare the child source.mediaSource
- The child source whose source info has been refreshed.newTimeline
- The timeline of the child source.
-
getMediaPeriodIdForChildMediaPeriodId
protected MediaSource.MediaPeriodId getMediaPeriodIdForChildMediaPeriodId(MediaSource.MediaPeriodId childSourceId, MediaSource.MediaPeriodId mediaPeriodId)
Deprecated.Description copied from class:CompositeMediaSource
Returns theMediaSource.MediaPeriodId
in the composite source corresponding to the specifiedMediaSource.MediaPeriodId
in a child source. The default implementation does not change the media period id.- Overrides:
getMediaPeriodIdForChildMediaPeriodId
in classCompositeMediaSource<MediaSource.MediaPeriodId>
- Parameters:
childSourceId
- The unique id used to prepare the child source.mediaPeriodId
- AMediaSource.MediaPeriodId
of the child source.- Returns:
- The corresponding
MediaSource.MediaPeriodId
in the composite source. Null if no corresponding media period id can be determined.
-
-