WrappingMediaSource

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
abstract class WrappingMediaSource : CompositeMediaSource

kotlin.Any
↳	androidx.media3.exoplayer.source.BaseMediaSource
	↳	androidx.media3.exoplayer.source.CompositeMediaSource
		↳	androidx.media3.exoplayer.source.WrappingMediaSource

Known direct subclasses

ClippingMediaSource, FilteringMediaSource, LoopingMediaSource, MaskingMediaSource, PreloadMediaSource

`ClippingMediaSource`	`MediaSource` that wraps a source and clips its timeline based on specified start/end positions.
`FilteringMediaSource`	A `MediaSource` that filters the available `track types`.
`LoopingMediaSource`	This class is deprecated. To loop a `MediaSource` indefinitely, use `setRepeatMode` instead of this class.
`MaskingMediaSource`	A `MediaSource` that masks the `Timeline` with a placeholder until the actual media structure is known.
`PreloadMediaSource`	Preloads a `MediaSource` and provides a `MediaPeriod` that has data loaded before playback.

An abstract MediaSource wrapping a single child MediaSource.

The implementation may want to override the following methods as needed:

getMediaItem: Amend the MediaItem for this media source. This is only used before the child source is prepared. You may also want to override canUpdateMediaItem or updateMediaItem to intercept further updates to the MediaItem.
onChildSourceInfoRefreshed: Called whenever the child source's Timeline changed. This Timeline can be amended if needed, for example using ForwardingTimeline. The Timeline for the wrapping source needs to be published with refreshSourceInfo.
createPeriod/releasePeriod: These methods create and release MediaPeriod instances. They typically forward to the wrapped media source and optionally wrap the returned MediaPeriod.

Other methods like prepareSourceInternal, enableInternal, disableInternal or releaseSourceInternal only need to be overwritten if required for resource management.

Summary

Protected constructors
`WrappingMediaSource(mediaSource: MediaSource!)` Creates the wrapping `MediaSource`.

Public functions
`Boolean`	`canUpdateMediaItem(mediaItem: MediaItem!)` Returns whether the for this source can be updated with the provided item.
`MediaPeriod!`	`createPeriod( id: MediaSource.MediaPeriodId!, allocator: Allocator!, startPositionUs: Long )` Creates the requested `MediaPeriod`.
`Timeline?`	`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.
`MediaItem!`	`getMediaItem()` Returns the whose media is provided by the source.
`Boolean`	`isSingleWindow()` Returns true if the media source is guaranteed to never have zero or more than one window.
`Unit`	`releasePeriod(mediaPeriod: MediaPeriod!)` Releases a `MediaPeriod`.
`Unit`	`updateMediaItem(mediaItem: MediaItem!)` Updates the for this source.

Protected functions
`Unit`	`disableChildSource()` Disables the child source.
`Unit`	`enableChildSource()` Enables the child source.
`MediaSource.MediaPeriodId?`	`getMediaPeriodIdForChildMediaPeriodId( mediaPeriodId: MediaSource.MediaPeriodId! )` Returns the `MediaPeriodId` in the wrapping source corresponding to the specified `MediaPeriodId` in a child source.
`MediaSource.MediaPeriodId?`	`getMediaPeriodIdForChildMediaPeriodId( childSourceId: Void!, mediaPeriodId: MediaSource.MediaPeriodId! )` Returns the `MediaPeriodId` in the composite source corresponding to the specified `MediaPeriodId` in a child source.
`Long`	`getMediaTimeForChildMediaTime( mediaTimeMs: Long, mediaPeriodId: MediaSource.MediaPeriodId? )` Returns the media time in the `MediaPeriod` of the wrapping source corresponding to the specified media time in the `MediaPeriod` of the child source.
`Long`	`getMediaTimeForChildMediaTime( childSourceId: Void!, 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(windowIndex: Int)` Returns the window index in the wrapping source corresponding to the specified window index in a child source.
`Int`	`getWindowIndexForChildWindowIndex(childSourceId: Void!, windowIndex: Int)` Returns the window index in the composite source corresponding to the specified window index in a child source.
`Unit`	`onChildSourceInfoRefreshed(newTimeline: Timeline!)` Called when the child source info has been refreshed.
`Unit`	`onChildSourceInfoRefreshed( childSourceId: Void!, mediaSource: MediaSource!, newTimeline: Timeline! )` Called when the source info of a child source has been refreshed.
`Unit`	`prepareChildSource()` Prepares the wrapped child source.
`Unit`	`prepareSourceInternal()` Starts source preparation and enables the source, see `prepareSource`.
`Unit`	`prepareSourceInternal(mediaTransferListener: TransferListener?)` Starts source preparation and enables the source, see `prepareSource`.
`Unit`	`releaseChildSource()` Releases the child source.

Protected properties
`MediaSource!`	`mediaSource` The wrapped child `MediaSource`.

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`.
`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.
`Unit`	`@CallSuper releaseSourceInternal()` Releases the source, see `releaseSource`.

Inherited properties

From androidx.media3.exoplayer.source.BaseMediaSource

PlayerId?

playerId

Protected constructors

WrappingMediaSource

protected WrappingMediaSource(mediaSource: MediaSource!)

Creates the wrapping MediaSource.

Parameters
`mediaSource: MediaSource!`	The wrapped child `MediaSource`.

Public functions

canUpdateMediaItem

fun canUpdateMediaItem(mediaItem: MediaItem!): Boolean

Returns whether the 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.

This method can be overridden to change whether the MediaItem of the child source can be updated.

createPeriod

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

Creates the requested MediaPeriod.

This method typically forwards to the wrapped media source and optionally wraps the returned MediaPeriod.

See also
`createPeriod`

getInitialTimeline

fun getInitialTimeline(): 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.

Should not be called directly from application code.

The initial timeline must use the same uids for windows and periods that the real timeline will use. It also must provide windows which are marked as dynamic to indicate that the window is expected to change when the real timeline arrives.

Any media source which has multiple windows should typically provide such an initial timeline to make sure the player reports the correct number of windows immediately.

This method must be called on the application thread.

getMediaItem

fun getMediaItem(): MediaItem!

Returns the whose media is provided by the source.

Should not be called directly from application code.

This method must be called on the application thread.

This method can be overridden to amend the MediaItem of the child source. It is only used before the child source is prepared.

isSingleWindow

fun isSingleWindow(): Boolean

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

Should not be called directly from application code.

The default implementation returns true.

This method must be called on the application thread.

Returns
`Boolean`	true if the source has exactly one window.

releasePeriod

fun releasePeriod(mediaPeriod: MediaPeriod!): Unit

Releases a MediaPeriod.

This method typically forwards to the wrapped media source and optionally unwraps the provided MediaPeriod.

See also
`releasePeriod`

updateMediaItem

fun updateMediaItem(mediaItem: MediaItem!): Unit

Updates the 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 .

This method can be overridden to change how the MediaItem of the child source is updated.

Protected functions

disableChildSource

protected fun disableChildSource(): Unit

Disables the child source.

enableChildSource

protected fun enableChildSource(): Unit

Enables the child source.

getMediaPeriodIdForChildMediaPeriodId

protected fun getMediaPeriodIdForChildMediaPeriodId(
    mediaPeriodId: MediaSource.MediaPeriodId!
): MediaSource.MediaPeriodId?

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

Parameters
`mediaPeriodId: MediaSource.MediaPeriodId!`	A `MediaPeriodId` of the child source.

Returns
`MediaSource.MediaPeriodId?`	The corresponding `MediaPeriodId` in the wrapping source. Null if no corresponding media period id can be determined.

getMediaPeriodIdForChildMediaPeriodId

protected fun getMediaPeriodIdForChildMediaPeriodId(
    childSourceId: Void!,
    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: Void!`	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.

getMediaTimeForChildMediaTime

protected fun getMediaTimeForChildMediaTime(
    mediaTimeMs: Long,
    mediaPeriodId: MediaSource.MediaPeriodId?
): Long

Returns the media time in the MediaPeriod of the wrapping source corresponding to the specified media time in the MediaPeriod of the child source. The default implementation does not change the media time.

Parameters
`mediaTimeMs: Long`	A media time in the `MediaPeriod` of the child source, in milliseconds.
`mediaPeriodId: MediaSource.MediaPeriodId?`	The `MediaPeriodId` of the `MediaPeriod` of the child source, or null if the time does not relate to a specific `MediaPeriod`.

Returns
`Long`	The corresponding media time in the `MediaPeriod` of the wrapping source, in milliseconds.

getMediaTimeForChildMediaTime

protected fun getMediaTimeForChildMediaTime(
    childSourceId: Void!,
    mediaTimeMs: Long,
    mediaPeriodId: MediaSource.MediaPeriodId?
): Long

Returns the media time in the MediaPeriod of the composite source corresponding to the specified media time in the MediaPeriod of the child source. The default implementation does not change the media time.

Parameters
`childSourceId: Void!`	The unique id used to prepare the child source.
`mediaTimeMs: Long`	A media time in the `MediaPeriod` of the child source, in milliseconds.
`mediaPeriodId: MediaSource.MediaPeriodId?`	The `MediaPeriodId` of the `MediaPeriod` of the child source, or null if the time does not relate to a specific `MediaPeriod`.

Returns
`Long`	The corresponding media time in the `MediaPeriod` of the composite source, in milliseconds.

getWindowIndexForChildWindowIndex

protected fun getWindowIndexForChildWindowIndex(windowIndex: Int): Int

Returns the window index in the wrapping source corresponding to the specified window index in a child source. The default implementation does not change the window index.

Parameters
`windowIndex: Int`	A window index of the child source.

Returns
`Int`	The corresponding window index in the wrapping source.

getWindowIndexForChildWindowIndex

protected fun getWindowIndexForChildWindowIndex(childSourceId: Void!, windowIndex: Int): Int

Returns the window index in the composite source corresponding to the specified window index in a child source. The default implementation does not change the window index.

Parameters
`childSourceId: Void!`	The unique id used to prepare the child source.
`windowIndex: Int`	A window index of the child source.

Returns
`Int`	The corresponding window index in the composite source.

onChildSourceInfoRefreshed

protected fun onChildSourceInfoRefreshed(newTimeline: Timeline!): Unit

Called when the child source info has been refreshed.

This Timeline can be amended if needed, for example using ForwardingTimeline. The Timeline for the wrapping source needs to be published with refreshSourceInfo.

Parameters
`newTimeline: Timeline!`	The timeline of the child source.

onChildSourceInfoRefreshed

protected fun onChildSourceInfoRefreshed(
    childSourceId: Void!,
    mediaSource: MediaSource!,
    newTimeline: Timeline!
): Unit

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

Parameters
`childSourceId: Void!`	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.

prepareChildSource

protected fun prepareChildSource(): Unit

Prepares the wrapped child source.

onChildSourceInfoRefreshed will be called when the child source updates its timeline.

If sources aren't explicitly released with releaseChildSource they will be released in releaseSourceInternal.

prepareSourceInternal

protected fun prepareSourceInternal(): Unit

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

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.

releaseChildSource

protected fun releaseChildSource(): Unit

Releases the child source.

Protected properties

mediaSource

protected val mediaSource: MediaSource!

The wrapped child MediaSource.