ClippingMediaSource

Artifact: androidx.media3:media3-exoplayer

View Source

---

Kotlin |Java

@UnstableApi
class ClippingMediaSource : WrappingMediaSource

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

---

MediaSource that wraps a source and clips its timeline based on specified start/end positions. The wrapped source must consist of a single period.

Summary

Nested types
class ClippingMediaSource.Builder A builder for ClippingMediaSource.
class ClippingMediaSource.IllegalClippingException : IOException Thrown when a ClippingMediaSource cannot clip its wrapped source.
@Documented @Retention(value = RetentionPolicy.SOURCE) @Target(value = TYPE_USE) @IntDef(value = ) annotation ClippingMediaSource.IllegalClippingException.Reason The reason clipping failed.

Public constructors
ClippingMediaSource(mediaSource: MediaSource!, durationUs: Long) This function is deprecated. Use Builder instead.
ClippingMediaSource(     mediaSource: MediaSource!,     startPositionUs: Long,     endPositionUs: Long ) This function is deprecated. Use Builder instead.
ClippingMediaSource(     mediaSource: MediaSource!,     startPositionUs: Long,     endPositionUs: Long,     enableInitialDiscontinuity: Boolean,     allowDynamicClippingUpdates: Boolean,     relativeToDefaultPosition: Boolean ) This function is deprecated. Use Builder instead.

Public functions
Boolean	canUpdateMediaItem(mediaItem: MediaItem!) Returns whether the for this source can be updated with the provided item.
MediaPeriod!	createPeriod(     id: MediaSource.MediaPeriodId!,     allocator: Allocator!,     startPositionUs: Long ) Creates the requested MediaPeriod.
Unit	maybeThrowSourceInfoRefreshError() Throws any pending error encountered while loading or refreshing source information.
Unit	releasePeriod(mediaPeriod: MediaPeriod!) Releases a MediaPeriod.

Protected functions
Unit	onChildSourceInfoRefreshed(newTimeline: Timeline!) Called when the child source info has been refreshed.
Unit	releaseSourceInternal() Releases the source, see releaseSource.

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. 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.
From androidx.media3.exoplayer.source.WrappingMediaSource Unit disableChildSource() Disables the child source. Unit enableChildSource() Enables the child source. 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. MediaItem! getMediaItem() Returns the whose media is provided by the source. MediaSource.MediaPeriodId? getMediaPeriodIdForChildMediaPeriodId(     mediaPeriodId: MediaSource.MediaPeriodId! ) Returns the MediaPeriodId in the wrapping source corresponding to the specified in a child 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. Boolean isSingleWindow() Returns true if the media source is guaranteed to never have zero or more than one window. 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

ClippingMediaSource

ClippingMediaSource(mediaSource: MediaSource!, durationUs: Long)

This function is deprecated.

Use Builder instead.

ClippingMediaSource

ClippingMediaSource(
    mediaSource: MediaSource!,
    startPositionUs: Long,
    endPositionUs: Long
)

This function is deprecated.

Use Builder instead.

ClippingMediaSource

ClippingMediaSource(
    mediaSource: MediaSource!,
    startPositionUs: Long,
    endPositionUs: Long,
    enableInitialDiscontinuity: Boolean,
    allowDynamicClippingUpdates: Boolean,
    relativeToDefaultPosition: Boolean
)

This function is deprecated.

Use Builder instead.

Public functions

canUpdateMediaItem

fun canUpdateMediaItem(mediaItem: MediaItem!): Boolean

Returns whether the 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.

This method can be overridden to change whether the MediaItem of the child source can be updated.

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

maybeThrowSourceInfoRefreshError

fun maybeThrowSourceInfoRefreshError(): Unit

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

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

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.

releaseSourceInternal

protected fun releaseSourceInternal(): Unit

Releases the source, see releaseSource. This method is called exactly once after each call to prepareSourceInternal.