@UnstableApi
public final class AdsMediaSource extends CompositeMediaSource

java.lang.Object
   ↳ androidx.media3.exoplayer.source.BaseMediaSource
     ↳ androidx.media3.exoplayer.source.CompositeMediaSource
       ↳ androidx.media3.exoplayer.source.ads.AdsMediaSource

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

The wrapped content media source must contain a single Timeline.Period.

Summary

Nested types
public final class AdsMediaSource.AdLoadException extends IOException

Wrapper for exceptions that occur while loading ads, which are notified via onLoadError.
@Documented
@Retention(value = RetentionPolicy.SOURCE)
@Target(value = TYPE_USE)
@IntDef(value = )
public annotation AdsMediaSource.AdLoadException.Type

Types of ad load exceptions.

Public constructors
AdsMediaSource(
    MediaSource contentMediaSource,
    DataSpec adTagDataSpec,
    Object adsId,
    MediaSource.Factory adMediaSourceFactory,
    AdsLoader adsLoader,
    AdViewProvider adViewProvider
)

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

Public methods
boolean

Returns whether the MediaItem for this source can be updated with the provided item.
MediaPeriod
createPeriod(
    MediaSource.MediaPeriodId id,
    Allocator allocator,
    long startPositionUs
)

Returns a new MediaPeriod identified by periodId.
MediaItem

Returns the MediaItem whose media is provided by the source.
void

Releases the period.
void

Updates the MediaItem for this source.

Protected methods
MediaSource.MediaPeriodId

Returns the MediaPeriodId in the composite source corresponding to the specified in a child source.
void
onChildSourceInfoRefreshed(
    MediaSource.MediaPeriodId childSourceId,
    MediaSource mediaSource,
    Timeline newTimeline
)

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

Starts source preparation and enables the source, see prepareSource.
void

Releases the source, see releaseSource.

Inherited fields
From androidx.media3.exoplayer.source.BaseMediaSource
@Nullable PlayerId

Inherited methods
From androidx.media3.exoplayer.source.BaseMediaSource
final void
addDrmEventListener(
    Handler handler,
    DrmSessionEventListener eventListener
)

Adds a DrmSessionEventListener to the list of listeners which are notified of DRM events for this media source.
final void
addEventListener(
    Handler handler,
    MediaSourceEventListener eventListener
)

Adds a MediaSourceEventListener to the list of listeners which are notified of media source events.
final DrmSessionEventListener.EventDispatcher

Returns a DrmSessionEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified MediaPeriodId
final DrmSessionEventListener.EventDispatcher
createDrmEventDispatcher(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId
)

Returns a DrmSessionEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified window index and MediaPeriodId.
final MediaSourceEventListener.EventDispatcher

Returns a MediaSourceEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified MediaPeriodId.
final MediaSourceEventListener.EventDispatcher
createEventDispatcher(
    MediaSource.MediaPeriodId mediaPeriodId,
    long mediaTimeOffsetMs
)

This method is deprecated.

Use createEventDispatcher instead.
final MediaSourceEventListener.EventDispatcher
createEventDispatcher(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId
)

Returns a MediaSourceEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified window index and MediaPeriodId.
final MediaSourceEventListener.EventDispatcher
createEventDispatcher(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId,
    long mediaTimeOffsetMs
)

This method is deprecated.

Use createEventDispatcher instead.
final void

Disables the source for the creation of MediaPeriods.
final void

Enables the source for the creation of MediaPeriods.
final PlayerId

Returns the PlayerId of the player using this media source.
final boolean

Returns whether the source is enabled.
final void
prepareSource(
    MediaSource.MediaSourceCaller caller,
    @Nullable TransferListener mediaTransferListener
)

This method is deprecated.

Implement prepareSource instead.
final void
prepareSource(
    MediaSource.MediaSourceCaller caller,
    @Nullable TransferListener mediaTransferListener,
    PlayerId playerId
)

Registers a MediaSourceCaller.
final boolean

Returns whether the source has prepareSource called.
final void

Updates timeline and manifest and notifies all listeners of the update.
final void

Unregisters a caller, and disables and releases the source if no longer required.
final void

Removes a DrmSessionEventListener from the list of listeners which are notified of DRM events for this media source.
final void

Removes a MediaSourceEventListener from the list of listeners which are notified of media source events.
final void

Sets the PlayerId of the player using this media source.
From androidx.media3.exoplayer.source.CompositeMediaSource
final void

Disables a child source.
void

Disables the source, see disable.
final void

Enables a child source.
void

Enables the source, see enable.
long
getMediaTimeForChildMediaTime(
    @UnknownNull T childSourceId,
    long mediaTimeMs,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId
)

Returns the media time in the MediaPeriod of the composite source corresponding to the specified media time in the MediaPeriod of the child source.
int
getWindowIndexForChildWindowIndex(
    @UnknownNull T childSourceId,
    int windowIndex
)

Returns the window index in the composite source corresponding to the specified window index in a child source.
void

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

Prepares a child source.
final void

Releases a child source.
From androidx.media3.exoplayer.source.MediaSource
@Nullable Timeline

Returns the initial placeholder timeline that is returned immediately when the real timeline is not yet known, or null to let the player create an initial timeline.
boolean

Returns true if the media source is guaranteed to never have zero or more than one window.

Public constructors

AdsMediaSource

public AdsMediaSource(
    MediaSource contentMediaSource,
    DataSpec adTagDataSpec,
    Object adsId,
    MediaSource.Factory adMediaSourceFactory,
    AdsLoader adsLoader,
    AdViewProvider adViewProvider
)

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

Parameters
MediaSource contentMediaSource

The MediaSource providing the content to play.
DataSpec adTagDataSpec

The data specification of the ad tag to load.
Object 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 (by equality), so it is important to pass the same identifiers when constructing playlist items each time the player returns to the foreground.
MediaSource.Factory adMediaSourceFactory

Factory for media sources used to load ad media.
AdsLoader adsLoader

The loader for ads.
AdViewProvider adViewProvider

Provider of views for the ad UI.

Public methods

canUpdateMediaItem

public boolean canUpdateMediaItem(MediaItem mediaItem)

Returns whether the MediaItem for this source can be updated with the provided item.

Should not be called directly from application code.

This method must be called on the application thread.

Parameters
MediaItem mediaItem

The new MediaItem.
Returns
boolean

Whether the source can be updated using this item.

createPeriod

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

Returns a new MediaPeriod identified by periodId.

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
MediaSource.MediaPeriodId id

The identifier of the period.
Allocator allocator

An Allocator from which to obtain media buffer allocations.
long startPositionUs

The expected start position, in microseconds.
Returns
MediaPeriod

A new MediaPeriod.

getMediaItem

public MediaItem getMediaItem()

Returns the MediaItem whose media is provided by the source.

Should not be called directly from application code.

This method must be called on the application thread.

releasePeriod

public void releasePeriod(MediaPeriod mediaPeriod)

Releases the period.

Should not be called directly from application code.

This method must be called on the playback thread.

Parameters
MediaPeriod mediaPeriod

The period to release.

updateMediaItem

public void updateMediaItem(MediaItem mediaItem)

Updates the MediaItem for this source.

Should not be called directly from application code.

This method must be called on the playback thread and only if canUpdateMediaItem returns true for the new MediaItem.

Parameters
MediaItem mediaItem

The new MediaItem.

Protected methods

getMediaPeriodIdForChildMediaPeriodId

protected MediaSource.MediaPeriodId getMediaPeriodIdForChildMediaPeriodId(
    MediaSource.MediaPeriodId childSourceId,
    MediaSource.MediaPeriodId mediaPeriodId
)

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

Parameters
MediaSource.MediaPeriodId childSourceId

The unique id used to prepare the child source.
MediaSource.MediaPeriodId mediaPeriodId

A MediaPeriodId of the child source.
Returns
MediaSource.MediaPeriodId

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

onChildSourceInfoRefreshed

protected void onChildSourceInfoRefreshed(
    MediaSource.MediaPeriodId childSourceId,
    MediaSource mediaSource,
    Timeline newTimeline
)

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

Parameters
MediaSource.MediaPeriodId childSourceId

The unique id used to prepare the child source.
MediaSource mediaSource

The child source whose source info has been refreshed.
Timeline newTimeline

The timeline of the child source.

prepareSourceInternal

protected void prepareSourceInternal(@Nullable TransferListener mediaTransferListener)

Starts source preparation and enables the source, see prepareSource. This method is called at most once until the next call to releaseSourceInternal.

Parameters
@Nullable TransferListener 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.

releaseSourceInternal

protected void releaseSourceInternal()

Releases the source, see releaseSource. This method is called exactly once after each call to prepareSourceInternal.