LoopingMediaSource

Artifact: androidx.media3:media3-exoplayer

View Source

---

Kotlin |Java

@UnstableApi
class LoopingMediaSource : WrappingMediaSource

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

---

This class is deprecated.

To loop a MediaSource indefinitely, use setRepeatMode instead of this class. To add a MediaSource a specific number of times to the playlist, use addMediaSource in a loop with the same MediaSource. To combine repeated MediaSource instances into one MediaSource, for example to further wrap it in another MediaSource, use ConcatenatingMediaSource2 with the same MediaSourceadded multiple times.

Loops a MediaSource a specified number of times.

Summary

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

Public functions
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.
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.

Protected functions
MediaSource.MediaPeriodId?	getMediaPeriodIdForChildMediaPeriodId(     mediaPeriodId: MediaSource.MediaPeriodId! ) Returns the MediaPeriodId in the wrapping source corresponding to the specified in a child source.
Unit	onChildSourceInfoRefreshed(newTimeline: Timeline!) Called when the child source info has been refreshed.

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. MediaSource.MediaPeriodId? getMediaPeriodIdForChildMediaPeriodId(     @UnknownNull childSourceId: T!,     mediaPeriodId: MediaSource.MediaPeriodId! ) Returns the MediaPeriodId in the composite source corresponding to the specified in a child source. Long getMediaTimeForChildMediaTime(     @UnknownNull childSourceId: T!,     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(     @UnknownNull childSourceId: T!,     windowIndex: Int ) Returns the window index in the composite source corresponding to the specified window index in a child source. Unit @CallSuper maybeThrowSourceInfoRefreshError() Throws any pending error encountered while loading or refreshing source information. abstract Unit onChildSourceInfoRefreshed(     @UnknownNull childSourceId: T!,     mediaSource: MediaSource!,     newTimeline: Timeline! ) Called when the source info of a child source has been refreshed. 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.
From androidx.media3.exoplayer.source.WrappingMediaSource Boolean canUpdateMediaItem(mediaItem: MediaItem!) Returns whether the for this source can be updated with the provided item. Unit disableChildSource() Disables the child source. Unit enableChildSource() Enables the child source. MediaItem! getMediaItem() Returns the whose media is provided by the source. MediaSource.MediaPeriodId? getMediaPeriodIdForChildMediaPeriodId(     childSourceId: Void!,     mediaPeriodId: MediaSource.MediaPeriodId! ) Returns the MediaPeriodId in the composite source corresponding to the specified 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(     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. Unit updateMediaItem(mediaItem: MediaItem!) Updates the for this source.

Inherited properties
From androidx.media3.exoplayer.source.BaseMediaSource PlayerId? playerId
From androidx.media3.exoplayer.source.WrappingMediaSource MediaSource! mediaSource The wrapped child MediaSource.

Public constructors

LoopingMediaSource

LoopingMediaSource(childSource: MediaSource!)

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

Parameters
childSource: MediaSource!	The MediaSource to loop.

LoopingMediaSource

LoopingMediaSource(childSource: MediaSource!, loopCount: Int)

Loops the provided source a specified number of times.

Parameters
childSource: MediaSource!	The MediaSource to loop.
loopCount: Int	The desired number of loops. Must be strictly positive.

Public functions

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.

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

Protected functions

getMediaPeriodIdForChildMediaPeriodId

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

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 . The Timeline for the wrapping source needs to be published with refreshSourceInfo.

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