EmptyMediaSource

Artifact: androidx.media3:media3-test-utils

View Source

---

Kotlin |Java

@UnstableApi
class EmptyMediaSource : BaseMediaSource

kotlin.Any
↳	androidx.media3.exoplayer.source.BaseMediaSource
	↳	androidx.media3.test.utils.EmptyMediaSource

---

MediaSource producing an empty Timeline.

Summary

Public constructors
EmptyMediaSource()

Public functions
Boolean	canUpdateMediaItem(mediaItem: MediaItem!) 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!	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 MediaItem whose media is provided by the source.
Boolean	isSingleWindow() Returns true if the media source is guaranteed to never have zero or more than one window.
Unit	maybeThrowSourceInfoRefreshError() Throws any pending error encountered while loading or refreshing source information.
Unit	releasePeriod(mediaPeriod: MediaPeriod!) Releases the period.

Protected functions
Unit	prepareSourceInternal(mediaTransferListener: TransferListener?) Starts source preparation and enables the source, see prepareSource.
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 disableInternal() Disables the source, see disable. Unit @UnstableApi enable(caller: MediaSource.MediaSourceCaller!) Enables the source for the creation of MediaPeriods. Unit enableInternal() Enables the source, see enable. 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.MediaSource Unit @UnstableApi updateMediaItem(mediaItem: MediaItem!) Updates the MediaItem for this source.

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

Public constructors

EmptyMediaSource

EmptyMediaSource()

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.

getMediaItem

fun getMediaItem(): MediaItem!

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.

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.

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.

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.

Protected functions

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.

This method is called on the playback thread.

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.

This method is called on the playback thread.