MergingMediaSource

Artifact: androidx.media3:media3-exoplayer

View Source

---

Kotlin |Java

@UnstableApi
public final class MergingMediaSource extends CompositeMediaSource

java.lang.Object
↳	androidx.media3.exoplayer.source.BaseMediaSource
	↳	androidx.media3.exoplayer.source.CompositeMediaSource
		↳	androidx.media3.exoplayer.source.MergingMediaSource

---

Merges multiple MediaSources.

The Timelines of the sources being merged must have the same number of periods.

The values of id and id are modified to start with i:, where i is the 0-based index of the MediaSource passed to the constructor that created this or androidx.media3.common.Format.

Summary

Nested types
public final class MergingMediaSource.IllegalMergeException extends IOException Thrown when a MergingMediaSource cannot merge its sources.
@Documented @Retention(value = RetentionPolicy.SOURCE) @Target(value = TYPE_USE) @IntDef(value = ) public annotation MergingMediaSource.IllegalMergeException.Reason The reason the merge failed.

Public constructors
MergingMediaSource(MediaSource[] mediaSources) Creates a merging media source.
MergingMediaSource(     boolean adjustPeriodTimeOffsets,     MediaSource[] mediaSources ) Creates a merging media source.
MergingMediaSource(     boolean adjustPeriodTimeOffsets,     boolean clipDurations,     MediaSource[] mediaSources ) Creates a merging media source.
MergingMediaSource(     boolean adjustPeriodTimeOffsets,     boolean clipDurations,     CompositeSequenceableLoaderFactory compositeSequenceableLoaderFactory,     MediaSource[] mediaSources ) Creates a merging media source.

Public methods
boolean	canUpdateMediaItem(MediaItem mediaItem) 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	getMediaItem() Returns the MediaItem whose media is provided by the source.
void	maybeThrowSourceInfoRefreshError() Throws any pending error encountered while loading or refreshing source information.
void	releasePeriod(MediaPeriod mediaPeriod) Releases the period.
void	updateMediaItem(MediaItem mediaItem) Updates the MediaItem for this source.

Protected methods
@Nullable MediaSource.MediaPeriodId	getMediaPeriodIdForChildMediaPeriodId(     Integer childSourceId,     MediaSource.MediaPeriodId mediaPeriodId ) Returns the MediaPeriodId in the composite source corresponding to the specified in a child source.
void	onChildSourceInfoRefreshed(     Integer childSourceId,     MediaSource mediaSource,     Timeline newTimeline ) Called when the source info of a child source has been refreshed.
void	prepareSourceInternal(@Nullable TransferListener mediaTransferListener) Starts source preparation and enables the source, see prepareSource.
void	releaseSourceInternal() Releases the source, see releaseSource.

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

Inherited methods
From androidx.media3.exoplayer.source.BaseMediaSource final void @UnstableApi 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 @UnstableApi addEventListener(     Handler handler,     MediaSourceEventListener eventListener ) Adds a MediaSourceEventListener to the list of listeners which are notified of media source events. final DrmSessionEventListener.EventDispatcher createDrmEventDispatcher(     @Nullable MediaSource.MediaPeriodId mediaPeriodId ) 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 createEventDispatcher(@Nullable MediaSource.MediaPeriodId mediaPeriodId) 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 @UnstableApi disable(MediaSource.MediaSourceCaller caller) Disables the source for the creation of MediaPeriods. final void @UnstableApi enable(MediaSource.MediaSourceCaller caller) Enables the source for the creation of MediaPeriods. final PlayerId getPlayerId() Returns the PlayerId of the player using this media source. final boolean isEnabled() Returns whether the source is enabled. final void @UnstableApi prepareSource(     MediaSource.MediaSourceCaller caller,     @Nullable TransferListener mediaTransferListener ) This method is deprecated. Implement prepareSource instead. final void @UnstableApi prepareSource(     MediaSource.MediaSourceCaller caller,     @Nullable TransferListener mediaTransferListener,     PlayerId playerId ) Registers a MediaSourceCaller. final boolean prepareSourceCalled() Returns whether the source has prepareSource called. final void refreshSourceInfo(Timeline timeline) Updates timeline and manifest and notifies all listeners of the update. final void @UnstableApi releaseSource(MediaSource.MediaSourceCaller caller) Unregisters a caller, and disables and releases the source if no longer required. final void @UnstableApi removeDrmEventListener(DrmSessionEventListener eventListener) Removes a DrmSessionEventListener from the list of listeners which are notified of DRM events for this media source. final void @UnstableApi removeEventListener(MediaSourceEventListener eventListener) Removes a MediaSourceEventListener from the list of listeners which are notified of media source events. final void setPlayerId(PlayerId playerId) Sets the PlayerId of the player using this media source.
From androidx.media3.exoplayer.source.CompositeMediaSource final void disableChildSource(@UnknownNull T id) Disables a child source. void @CallSuper disableInternal() Disables the source, see disable. final void enableChildSource(@UnknownNull T id) Enables a child source. void @CallSuper enableInternal() 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. final void prepareChildSource(@UnknownNull T id, MediaSource mediaSource) Prepares a child source. final void releaseChildSource(@UnknownNull T id) Releases a child source.
From androidx.media3.exoplayer.source.MediaSource @Nullable 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.

Public constructors

MergingMediaSource

public MergingMediaSource(MediaSource[] mediaSources)

Creates a merging media source.

Neither offsets between the timestamps in the media sources nor the durations of the media sources will be adjusted.

Parameters
MediaSource[] mediaSources	The MediaSources to merge.

MergingMediaSource

public MergingMediaSource(
    boolean adjustPeriodTimeOffsets,
    MediaSource[] mediaSources
)

Creates a merging media source.

Durations of the media sources will not be adjusted.

Parameters
boolean adjustPeriodTimeOffsets	Whether to adjust timestamps of the merged media sources to all start at the same time.
MediaSource[] mediaSources	The MediaSources to merge.

MergingMediaSource

public MergingMediaSource(
    boolean adjustPeriodTimeOffsets,
    boolean clipDurations,
    MediaSource[] mediaSources
)

Creates a merging media source.

Parameters
boolean adjustPeriodTimeOffsets	Whether to adjust timestamps of the merged media sources to all start at the same time.
boolean clipDurations	Whether to clip the durations of the media sources to match the shortest duration.
MediaSource[] mediaSources	The MediaSources to merge.

MergingMediaSource

public MergingMediaSource(
    boolean adjustPeriodTimeOffsets,
    boolean clipDurations,
    CompositeSequenceableLoaderFactory compositeSequenceableLoaderFactory,
    MediaSource[] mediaSources
)

Creates a merging media source.

Parameters
boolean adjustPeriodTimeOffsets	Whether to adjust timestamps of the merged media sources to all start at the same time.
boolean clipDurations	Whether to clip the durations of the media sources to match the shortest duration.
CompositeSequenceableLoaderFactory compositeSequenceableLoaderFactory	A factory to create composite s for when this media source loads data from multiple streams (video, audio etc...).
MediaSource[] mediaSources	The MediaSources to merge.

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.

maybeThrowSourceInfoRefreshError

public void maybeThrowSourceInfoRefreshError()

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

Should not be called directly from application code.

This method must be called on the playback thread and only after prepareSource.

Throws
java.io.IOException

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 @Nullable MediaSource.MediaPeriodId getMediaPeriodIdForChildMediaPeriodId(
    Integer 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
Integer childSourceId	The unique id used to prepare the child source.
MediaSource.MediaPeriodId mediaPeriodId	A MediaPeriodId of the child source.

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

onChildSourceInfoRefreshed

protected void onChildSourceInfoRefreshed(
    Integer childSourceId,
    MediaSource mediaSource,
    Timeline newTimeline
)

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

Parameters
Integer 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.