LoopingMediaSource

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
public final class LoopingMediaSource extends WrappingMediaSource

java.lang.Object
↳	androidx.media3.exoplayer.source.BaseMediaSource
	↳	androidx.media3.exoplayer.source.CompositeMediaSource
		↳	androidx.media3.exoplayer.source.WrappingMediaSource
			↳	androidx.media3.exoplayer.source.LoopingMediaSource

Loops a MediaSource a specified number of times.

Summary

Public constructors
`LoopingMediaSource(MediaSource childSource)` Loops the provided source indefinitely.
`LoopingMediaSource(MediaSource childSource, int loopCount)` Loops the provided source a specified number of times.

Public methods
`MediaPeriod`	`createPeriod( MediaSource.MediaPeriodId id, Allocator allocator, long startPositionUs )` Creates the requested `MediaPeriod`.
`@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.
`boolean`	`isSingleWindow()` Returns true if the media source is guaranteed to never have zero or more than one window.
`void`	`releasePeriod(MediaPeriod mediaPeriod)` Releases a `MediaPeriod`.

Protected methods
`@Nullable MediaSource.MediaPeriodId`	`getMediaPeriodIdForChildMediaPeriodId( MediaSource.MediaPeriodId mediaPeriodId )` Returns the `MediaPeriodId` in the wrapping source corresponding to the specified in a child source.
`void`	`onChildSourceInfoRefreshed(Timeline newTimeline)` Called when the child source info has been refreshed.

Inherited fields

From androidx.media3.exoplayer.source.BaseMediaSource

@Nullable PlayerId

playerId

From androidx.media3.exoplayer.source.WrappingMediaSource

final MediaSource

mediaSource

The wrapped child MediaSource.

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`.
`@Nullable MediaSource.MediaPeriodId`	`getMediaPeriodIdForChildMediaPeriodId( @UnknownNull T childSourceId, MediaSource.MediaPeriodId mediaPeriodId )` Returns the `MediaPeriodId` in the composite source corresponding to the specified in a child source.
`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.
`void`	`@CallSuper maybeThrowSourceInfoRefreshError()` Throws any pending error encountered while loading or refreshing source information.
`abstract void`	`onChildSourceInfoRefreshed( @UnknownNull T childSourceId, MediaSource mediaSource, Timeline newTimeline )` Called when the source info of a child source has been refreshed.
`final void`	`prepareChildSource(@UnknownNull T id, MediaSource mediaSource)` Prepares a child source.
`final void`	`releaseChildSource(@UnknownNull T id)` Releases a child source.
`void`	`@CallSuper releaseSourceInternal()` Releases the source, see `releaseSource`.

From androidx.media3.exoplayer.source.WrappingMediaSource

`boolean`	`canUpdateMediaItem(MediaItem mediaItem)` Returns whether the for this source can be updated with the provided item.
`final void`	`disableChildSource()` Disables the child source.
`final void`	`enableChildSource()` Enables the child source.
`MediaItem`	`getMediaItem()` Returns the whose media is provided by the source.
`final @Nullable MediaSource.MediaPeriodId`	`getMediaPeriodIdForChildMediaPeriodId( Void childSourceId, MediaSource.MediaPeriodId mediaPeriodId )` Returns the `MediaPeriodId` in the composite source corresponding to the specified in a child source.
`long`	`getMediaTimeForChildMediaTime( long mediaTimeMs, @Nullable MediaSource.MediaPeriodId 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.
`final long`	`getMediaTimeForChildMediaTime( Void 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(int windowIndex)` Returns the window index in the wrapping source corresponding to the specified window index in a child source.
`final int`	`getWindowIndexForChildWindowIndex(Void childSourceId, int windowIndex)` Returns the window index in the composite source corresponding to the specified window index in a child source.
`final void`	`onChildSourceInfoRefreshed( Void childSourceId, MediaSource mediaSource, Timeline newTimeline )` Called when the source info of a child source has been refreshed.
`final void`	`prepareChildSource()` Prepares the wrapped child source.
`void`	`prepareSourceInternal()` Starts source preparation and enables the source, see `prepareSource`.
`final void`	`prepareSourceInternal(@Nullable TransferListener mediaTransferListener)` Starts source preparation and enables the source, see `prepareSource`.
`final void`	`releaseChildSource()` Releases the child source.
`void`	`updateMediaItem(MediaItem mediaItem)` Updates the for this source.

Public constructors

LoopingMediaSource

public LoopingMediaSource(MediaSource childSource)

Loops the provided source indefinitely. Note that it is usually better to use setRepeatMode.

Parameters
`MediaSource childSource`	The `MediaSource` to loop.

LoopingMediaSource

public LoopingMediaSource(MediaSource childSource, int loopCount)

Loops the provided source a specified number of times.

Parameters
`MediaSource childSource`	The `MediaSource` to loop.
`int loopCount`	The desired number of loops. Must be strictly positive.

Public methods

createPeriod

public MediaPeriod createPeriod(
    MediaSource.MediaPeriodId id,
    Allocator allocator,
    long startPositionUs
)

Creates the requested MediaPeriod.

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

See also
`createPeriod`

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.

isSingleWindow

public boolean isSingleWindow()

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

public void releasePeriod(MediaPeriod mediaPeriod)

Releases a MediaPeriod.

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

See also
`releasePeriod`

Protected methods

getMediaPeriodIdForChildMediaPeriodId

protected @Nullable MediaSource.MediaPeriodId getMediaPeriodIdForChildMediaPeriodId(
    MediaSource.MediaPeriodId mediaPeriodId
)

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

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

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

onChildSourceInfoRefreshed

protected void onChildSourceInfoRefreshed(Timeline newTimeline)

Called when the child source info has been refreshed.

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

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