ConcatenatingMediaSource2

@UnstableApi
class ConcatenatingMediaSource2 : CompositeMediaSource

kotlin.Any
   ↳ 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 functions
Boolean

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.
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.
Unit
releasePeriod(mediaPeriod: MediaPeriod!)

Releases the period.
synchronized Unit

Updates the MediaItem for this source.

Protected functions
Unit

Enables the source, see enable.
MediaSource.MediaPeriodId?
getMediaPeriodIdForChildMediaPeriodId(
    childSourceId: Int!,
    mediaPeriodId: MediaSource.MediaPeriodId!
)

Returns the MediaPeriodId in the composite source corresponding to the specified in a child source.
Long
getMediaTimeForChildMediaTime(
    childSourceId: Int!,
    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(childSourceId: Int!, windowIndex: Int)

Returns the window index in the composite source corresponding to the specified window index in a child source.
Unit
onChildSourceInfoRefreshed(
    childSourceId: Int!,
    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

Releases the source, see releaseSource.

Public properties
MediaItem!
@GuardedBy(value = "this")
mediaItem

Inherited functions
From androidx.media3.exoplayer.source.BaseMediaSource
Unit
addDrmEventListener(
    handler: Handler!,
    eventListener: DrmSessionEventListener!
)

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

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

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!

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

Disables the source for the creation of MediaPeriods.
Unit

Enables the source for the creation of MediaPeriods.
Boolean

Returns whether the source is enabled.
Unit
prepareSource(
    caller: MediaSource.MediaSourceCaller!,
    mediaTransferListener: TransferListener?
)

This function is deprecated.

Implement prepareSource instead.
Unit
prepareSource(
    caller: MediaSource.MediaSourceCaller!,
    mediaTransferListener: TransferListener?,
    playerId: PlayerId!
)

Registers a MediaSourceCaller.
Boolean

Returns whether the source has prepareSource called.
Unit

Updates timeline and manifest and notifies all listeners of the update.
Unit

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

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

Removes a MediaSourceEventListener from the list of listeners which are notified of media source events.
From androidx.media3.exoplayer.source.CompositeMediaSource
Unit

Disables a child source.
Unit

Disables the source, see disable.
Unit

Enables a child source.
Unit

Throws any pending error encountered while loading or refreshing source information.
Unit
prepareChildSource(@UnknownNull id: T!, mediaSource: MediaSource!)

Prepares a child source.
Unit

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.

Inherited properties
From androidx.media3.exoplayer.source.BaseMediaSource
PlayerId?

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.

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.

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

synchronized 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

enableInternal

protected fun enableInternal(): Unit

Enables the source, see enable.

getMediaPeriodIdForChildMediaPeriodId

protected fun getMediaPeriodIdForChildMediaPeriodId(
    childSourceId: Int!,
    mediaPeriodId: MediaSource.MediaPeriodId!
): MediaSource.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
childSourceId: Int!

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(
    childSourceId: Int!,
    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: Int!

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(childSourceId: Int!, 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: Int!

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(
    childSourceId: Int!,
    mediaSource: MediaSource!,
    newTimeline: Timeline!
): Unit

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

Parameters
childSourceId: Int!

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.

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.

Public properties

mediaItem

@GuardedBy(value = "this")
val mediaItem: MediaItem!