AdsMediaSource

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
class AdsMediaSource : CompositeMediaSource

kotlin.Any
↳	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
`class AdsMediaSource.AdLoadException : IOException` Wrapper for exceptions that occur while loading ads, which are notified via `onLoadError`.
`@Documented @Retention(value = RetentionPolicy.SOURCE) @Target(value = ElementType.TYPE_USE) @IntDef(value = ) annotation AdsMediaSource.AdLoadException.Type` Types of ad load exceptions.

Public constructors
`AdsMediaSource( contentMediaSource: MediaSource!, adTagDataSpec: DataSpec!, adsId: Any!, adMediaSourceFactory: MediaSource.Factory!, adsLoader: AdsLoader!, adViewProvider: AdViewProvider! )` Constructs a new source that inserts ads linearly with the content specified by `contentMediaSource`.
`AdsMediaSource( contentMediaSource: MediaSource!, adTagDataSpec: DataSpec!, adsId: Any!, adMediaSourceFactory: MediaSource.Factory!, adsLoader: AdsLoader!, adViewProvider: AdViewProvider!, useLazyContentSourcePreparation: Boolean )` Constructs a new source that inserts ads linearly with the content specified by `contentMediaSource`.

Public functions
`Boolean`	`canUpdateMediaItem(mediaItem: MediaItem!)` Returns whether the `MediaItem` for this source can be updated with the provided item.
`MediaPeriod!`	`createPeriod( id: MediaSource.MediaPeriodId!, allocator: Allocator!, startPositionUs: Long )` Returns a new `MediaPeriod` identified by `periodId`.
`MediaItem!`	`getMediaItem()` Returns the `MediaItem` whose media is provided by the source.
`Unit`	`releasePeriod(mediaPeriod: MediaPeriod!)` Releases the period.
`Unit`	`updateMediaItem(mediaItem: MediaItem!)` Updates the `MediaItem` for this source.

Protected functions
`MediaSource.MediaPeriodId!`	`getMediaPeriodIdForChildMediaPeriodId( childSourceId: MediaSource.MediaPeriodId!, mediaPeriodId: MediaSource.MediaPeriodId! )` Returns the `MediaPeriodId` in the composite source corresponding to the specified `MediaPeriodId` in a child source.
`Unit`	`onChildSourceInfoRefreshed( childSourceId: MediaSource.MediaPeriodId!, mediaSource: MediaSource!, newTimeline: Timeline! )` Called when the source info of a child source has been refreshed.
`Unit`	`prepareSourceInternal(mediaTransferListener: TransferListener?)` Starts source preparation and enables the source, see `prepareSource`.
`Unit`	`releaseSourceInternal()` Releases the source, see `releaseSource`.

Public properties
`Any!`	`adsId`

Inherited functions

From androidx.media3.exoplayer.source.BaseMediaSource

`Unit`	`@UnstableApi addDrmEventListener( handler: Handler!, eventListener: DrmSessionEventListener! )` Adds a `DrmSessionEventListener` to the list of listeners which are notified of DRM events for this media source.
`Unit`	`@UnstableApi addEventListener( handler: Handler!, eventListener: MediaSourceEventListener! )` Adds a `MediaSourceEventListener` to the list of listeners which are notified of media source events.
`DrmSessionEventListener.EventDispatcher!`	`createDrmEventDispatcher(mediaPeriodId: MediaSource.MediaPeriodId?)` Returns a `DrmSessionEventListener.EventDispatcher` which dispatches all events to the registered listeners with the specified `MediaPeriodId`
`DrmSessionEventListener.EventDispatcher!`	`createDrmEventDispatcher( windowIndex: Int, mediaPeriodId: MediaSource.MediaPeriodId? )` Returns a `DrmSessionEventListener.EventDispatcher` which dispatches all events to the registered listeners with the specified window index and `MediaPeriodId`.
`MediaSourceEventListener.EventDispatcher!`	`createEventDispatcher(mediaPeriodId: MediaSource.MediaPeriodId?)` Returns a `MediaSourceEventListener.EventDispatcher` which dispatches all events to the registered listeners with the specified `MediaPeriodId`.
`MediaSourceEventListener.EventDispatcher!`	`createEventDispatcher( mediaPeriodId: MediaSource.MediaPeriodId!, mediaTimeOffsetMs: Long )` This function is deprecated. Use `createEventDispatcher` instead.
`MediaSourceEventListener.EventDispatcher!`	`createEventDispatcher( windowIndex: Int, mediaPeriodId: MediaSource.MediaPeriodId? )` Returns a `MediaSourceEventListener.EventDispatcher` which dispatches all events to the registered listeners with the specified window index and `MediaPeriodId`.
`MediaSourceEventListener.EventDispatcher!`	`createEventDispatcher( windowIndex: Int, mediaPeriodId: MediaSource.MediaPeriodId?, mediaTimeOffsetMs: Long )` This function is deprecated. Use `createEventDispatcher` instead.
`Unit`	`@UnstableApi disable(caller: MediaSource.MediaSourceCaller!)` Disables the source for the creation of `MediaPeriods`.
`Unit`	`@UnstableApi enable(caller: MediaSource.MediaSourceCaller!)` Enables the source for the creation of `MediaPeriods`.
`Boolean`	`isEnabled()` Returns whether the source is enabled.
`Unit`	`@UnstableApi prepareSource( caller: MediaSource.MediaSourceCaller!, mediaTransferListener: TransferListener? )` This function is deprecated. Implement `prepareSource` instead.
`Unit`	`@UnstableApi prepareSource( caller: MediaSource.MediaSourceCaller!, mediaTransferListener: TransferListener?, playerId: PlayerId! )` Registers a `MediaSourceCaller`.
`Boolean`	`prepareSourceCalled()` Returns whether the source has `prepareSource` called.
`Unit`	`refreshSourceInfo(timeline: Timeline!)` Updates timeline and manifest and notifies all listeners of the update.
`Unit`	`@UnstableApi releaseSource(caller: MediaSource.MediaSourceCaller!)` Unregisters a caller, and disables and releases the source if no longer required.
`Unit`	`@UnstableApi removeDrmEventListener(eventListener: DrmSessionEventListener!)` Removes a `DrmSessionEventListener` from the list of listeners which are notified of DRM events for this media source.
`Unit`	`@UnstableApi removeEventListener(eventListener: MediaSourceEventListener!)` Removes a `MediaSourceEventListener` from the list of listeners which are notified of media source events.

From androidx.media3.exoplayer.source.CompositeMediaSource

`Unit`	`disableChildSource(@UnknownNull id: T!)` Disables a child source.
`Unit`	`@CallSuper disableInternal()` Disables the source, see `disable`.
`Unit`	`enableChildSource(@UnknownNull id: T!)` Enables a child source.
`Unit`	`@CallSuper enableInternal()` Enables the source, see `enable`.
`Long`	`getMediaTimeForChildMediaTime( @UnknownNull childSourceId: T!, mediaTimeMs: Long, mediaPeriodId: MediaSource.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 childSourceId: T!, windowIndex: Int )` Returns the window index in the composite source corresponding to the specified window index in a child source.
`Unit`	`@CallSuper maybeThrowSourceInfoRefreshError()` Throws any pending error encountered while loading or refreshing source information.
`Unit`	`prepareChildSource(@UnknownNull id: T!, mediaSource: MediaSource!)` Prepares a child source.
`Unit`	`releaseChildSource(@UnknownNull id: T!)` Releases a child source.

From androidx.media3.exoplayer.source.MediaSource

`Timeline?`	`@UnstableApi getInitialTimeline()` 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`	`@UnstableApi isSingleWindow()` Returns true if the media source is guaranteed to never have zero or more than one window.

Inherited properties

From androidx.media3.exoplayer.source.BaseMediaSource

PlayerId?

playerId

Public constructors

AdsMediaSource

AdsMediaSource(
    contentMediaSource: MediaSource!,
    adTagDataSpec: DataSpec!,
    adsId: Any!,
    adMediaSourceFactory: MediaSource.Factory!,
    adsLoader: AdsLoader!,
    adViewProvider: AdViewProvider!
)

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

This is equivalent to passing true as param useLazyContentSourcePreparation when calling AdsMediaSource.

Parameters
`contentMediaSource: MediaSource!`	The `MediaSource` providing the content to play.
`adTagDataSpec: DataSpec!`	The data specification of the ad tag to load.
`adsId: Any!`	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.
`adMediaSourceFactory: MediaSource.Factory!`	Factory for media sources used to load ad media.
`adsLoader: AdsLoader!`	The loader for ads.
`adViewProvider: AdViewProvider!`	Provider of views for the ad UI.

AdsMediaSource

AdsMediaSource(
    contentMediaSource: MediaSource!,
    adTagDataSpec: DataSpec!,
    adsId: Any!,
    adMediaSourceFactory: MediaSource.Factory!,
    adsLoader: AdsLoader!,
    adViewProvider: AdViewProvider!,
    useLazyContentSourcePreparation: Boolean
)

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

Parameters
`contentMediaSource: MediaSource!`	The `MediaSource` providing the content to play.
`adTagDataSpec: DataSpec!`	The data specification of the ad tag to load.
`adsId: Any!`	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.
`adMediaSourceFactory: MediaSource.Factory!`	Factory for media sources used to load ad media.
`adsLoader: AdsLoader!`	The loader for ads.
`adViewProvider: AdViewProvider!`	Provider of views for the ad UI.
`useLazyContentSourcePreparation: Boolean`	True if the content source should be prepared lazily and wait for an `AdPlaybackState` to be set before preparing. False if the timeline is required `to read ad data from it` to populate the `AdPlaybackState` (See `manifest` also).

Public functions

canUpdateMediaItem

fun canUpdateMediaItem(mediaItem: MediaItem!): Boolean

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

fun createPeriod(
    id: MediaSource.MediaPeriodId!,
    allocator: Allocator!,
    startPositionUs: Long
): MediaPeriod!

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
`id: MediaSource.MediaPeriodId!`	The identifier of the period.
`allocator: Allocator!`	An `Allocator` from which to obtain media buffer allocations.
`startPositionUs: Long`	The expected start position, in microseconds.

Returns
`MediaPeriod!`	A new `MediaPeriod`.

getMediaItem

fun getMediaItem(): MediaItem!

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

fun releasePeriod(mediaPeriod: MediaPeriod!): Unit

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

fun updateMediaItem(mediaItem: MediaItem!): Unit

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 functions

getMediaPeriodIdForChildMediaPeriodId

protected fun getMediaPeriodIdForChildMediaPeriodId(
    childSourceId: MediaSource.MediaPeriodId!,
    mediaPeriodId: MediaSource.MediaPeriodId!
): MediaSource.MediaPeriodId!

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.

Parameters
`childSourceId: MediaSource.MediaPeriodId!`	The unique id used to prepare the child source.
`mediaPeriodId: MediaSource.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 fun onChildSourceInfoRefreshed(
    childSourceId: MediaSource.MediaPeriodId!,
    mediaSource: MediaSource!,
    newTimeline: Timeline!
): Unit

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

Parameters
`childSourceId: MediaSource.MediaPeriodId!`	The unique id used to prepare the child source.
`mediaSource: MediaSource!`	The child source whose source info has been refreshed.
`newTimeline: Timeline!`	The timeline of the child source.

prepareSourceInternal

protected fun prepareSourceInternal(mediaTransferListener: TransferListener?): Unit

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

This method is called on the playback thread.

Parameters
`mediaTransferListener: TransferListener?`	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 fun releaseSourceInternal(): Unit

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

This method is called on the playback thread.

Public properties

adsId

val adsId: Any!

AdsMediaSource

Summary

Nested types

Public constructors

Public functions

Protected functions

Public properties

Inherited functions

Inherited properties

Public constructors

AdsMediaSource

AdsMediaSource

Public functions

canUpdateMediaItem

createPeriod

getMediaItem

releasePeriod

updateMediaItem

Protected functions

getMediaPeriodIdForChildMediaPeriodId

onChildSourceInfoRefreshed

prepareSourceInternal

releaseSourceInternal

Public properties

adsId