ConcatenatingMediaSource2

@UnstableApi
public final class ConcatenatingMediaSource2 extends CompositeMediaSource

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

Concatenates multiple MediaSources, combining everything in one single .

This class can be used under the following conditions:

  • All sources must be non-empty.
  • The period offset in all windows (except for the first one) must not change during the lifetime of this media source. This excludes, for example, live streams with moving live windows or dynamic updates to the clipping start time of a ClippingMediaSource.

Summary

Nested types

A builder for ConcatenatingMediaSource2 instances.

Public fields
MediaItem
@GuardedBy(value = "this")
mediaItem

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.
@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.
synchronized MediaItem

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

Releases the period.
synchronized void

Updates the MediaItem for this source.

Protected methods
void

Enables the source, see enable.
@Nullable MediaSource.MediaPeriodId
getMediaPeriodIdForChildMediaPeriodId(
    Integer childSourceId,
    MediaSource.MediaPeriodId mediaPeriodId
)

Returns the MediaPeriodId in the composite source corresponding to the specified in a child source.
long
getMediaTimeForChildMediaTime(
    Integer 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(
    Integer childSourceId,
    int windowIndex
)

Returns the window index in the composite source corresponding to the specified window index 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

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
@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

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
@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

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

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
boolean

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

Public fields

mediaItem

@GuardedBy(value = "this")
public MediaItem mediaItem

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.

getInitialTimeline

public @Nullable 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.

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

synchronized 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

synchronized 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

enableInternal

protected void enableInternal()

Enables the source, see enable.

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.

getMediaTimeForChildMediaTime

protected long getMediaTimeForChildMediaTime(
    Integer 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. The default implementation does not change the media time.

Parameters
Integer childSourceId

The unique id used to prepare the child source.
long mediaTimeMs

A media time in the MediaPeriod of the child source, in milliseconds.
@Nullable MediaSource.MediaPeriodId 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 int getWindowIndexForChildWindowIndex(
    Integer childSourceId,
    int windowIndex
)

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
Integer childSourceId

The unique id used to prepare the child source.
int windowIndex

A window index of the child source.
Returns
int

The corresponding window index in the composite source.

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.