BasePreloadManager

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
public abstract class BasePreloadManager<T, PreloadStatusT>

Known direct subclasses

DefaultPreloadManager

DefaultPreloadManager

A preload manager that preloads with the PreloadMediaSource to load the media data into the SampleQueue.

A base implementation of a preload manager, which maintains the lifecycle of media sources.

Methods should be called on the same thread.

Summary

Nested types
`protected abstract class BasePreloadManager.BuilderBase<T, PreloadStatusT>` A base class of the builder of the concrete extension of `BasePreloadManager`.
`protected inner class BasePreloadManager.MediaSourceHolder implements Comparable` A holder for information for preloading a single media source.

Protected fields
`final RankingDataComparator<T>`	`rankingDataComparator`

Protected constructors
`BasePreloadManager( RankingDataComparator<T> rankingDataComparator, TargetPreloadStatusControl<T, PreloadStatusT> targetPreloadStatusControl, MediaSource.Factory mediaSourceFactory )`

Public methods
`final void`	`add(MediaItem mediaItem, T rankingData)` Adds a `MediaItem` with its `rankingData` to the preload manager.
`final void`	`add(MediaSource mediaSource, T rankingData)` Adds a `MediaSource` with its `rankingData` to the preload manager.
`void`	`addListener(PreloadManagerListener listener)` Adds a `PreloadManagerListener` to listen to the preload events.
`final void`	`addMediaItems(List<MediaItem> mediaItems, List<T> rankingDataList)` Adds a list of `media items` with their `rankingData` to the preload manager.
`final void`	`addMediaSources( List<MediaSource> mediaSources, List<T> rankingDataList )` Adds a list of `media sources` with their `rankingData` to the preload manager.
`void`	`clearListeners()` Clears all the `listeners`.
`final @Nullable MediaSource`	`getMediaSource(MediaItem mediaItem)` Returns the `MediaSource` for the given `MediaItem`.
`final int`	`getSourceCount()` Gets the count of the `media sources` currently being managed by the preload manager.
`final void`	`invalidate()` Invalidates the current preload progress, and triggers a new preload progress based on the new priorities of the managed `media sources`.
`final void`	`release()` Releases the preload manager.
`final boolean`	`remove(MediaItem mediaItem)` Removes a `MediaItem` from the preload manager.
`final boolean`	`remove(MediaSource mediaSource)` Removes a `MediaSource` from the preload manager.
`void`	`removeListener(PreloadManagerListener listener)` Removes a `PreloadManagerListener`.
`final void`	`removeMediaItems(List<MediaItem> mediaItems)` Removes a list of `media items` from the preload manager.
`final void`	`removeMediaSources(List<MediaSource> mediaSources)` Removes a list of `media sources` from the preload manager.
`final void`	`reset()` Resets the preload manager.

Protected methods
`abstract BasePreloadManager.MediaSourceHolder`	`createMediaSourceHolder( MediaItem mediaItem, MediaSource mediaSource, T rankingData )` Returns the `MediaSourceHolder` that the preload manager creates for preloading based on the given `MediaItem` and `MediaSource`.
`@Nullable BasePreloadManager.MediaSourceHolder`	`getMediaSourceHolderToClear()`
`final @Nullable PreloadStatusT`	`getTargetPreloadStatusIfCurrentlyPreloading(MediaItem mediaItem)`
`final @Nullable PreloadStatusT`	`getTargetPreloadStatusIfCurrentlyPreloading(MediaSource mediaSource)`
`final void`	`onCompleted( MediaItem mediaItem, Predicate<PreloadStatusT> shouldNotifyListenerAndAdvancePredicate )` Called when the given `MediaItem` completes preloading.
`final void`	`onCompleted( MediaSource mediaSource, Predicate<PreloadStatusT> shouldNotifyListenerAndAdvancePredicate )` Called when the given `MediaSource` completes preloading.
`final void`	`onError( PreloadException error, MediaItem mediaItem, Predicate<PreloadStatusT> shouldNotifyListenerAndAdvancePredicate )` Called when an error occurs.
`final void`	`onError( PreloadException error, MediaSource mediaSource, Predicate<PreloadStatusT> shouldNotifyListenerAndAdvancePredicate )` Called when an error occurs.
`final void`	`onMediaSourceUpdated( MediaItem mediaItem, MediaSource updatedMediaSource )` Called when the given `MediaItem` has its corresponding `MediaSource` updated.
`final void`	`onSkipped( MediaSource mediaSource, Predicate<PreloadStatusT> shouldAdvancePredicate )` Called when the given `MediaSource` has been skipped before completing preloading.
`final void`	`onSourceCleared()` Called when there is a `MediaSource` has been cleared.
`abstract void`	`preloadMediaSourceHolderInternal( BasePreloadManager.MediaSourceHolder mediaSourceHolder, PreloadStatusT targetPreloadStatus )` Preloads the given `MediaSourceHolder`.
`void`	`releaseInternal()` Releases the preload manager, see `release`.
`void`	`@CallSuper releaseMediaSourceHolderInternal( BasePreloadManager.MediaSourceHolder mediaSourceHolder )` Releases the given `MediaSourceHolder`.
`boolean`	`shouldStartPreloadingNextSource()` Returns whether the next `MediaSource` should start preloading.

Protected fields

rankingDataComparator

protected final RankingDataComparator<T> rankingDataComparator

Protected constructors

BasePreloadManager

protected BasePreloadManager(
    RankingDataComparator<T> rankingDataComparator,
    TargetPreloadStatusControl<T, PreloadStatusT> targetPreloadStatusControl,
    MediaSource.Factory mediaSourceFactory
)

Public methods

add

public final void add(MediaItem mediaItem, T rankingData)

Adds a MediaItem with its rankingData to the preload manager.

Parameters
`MediaItem mediaItem`	The `MediaItem` to add.
`T rankingData`	The ranking data that is associated with the `mediaItem`.

add

public final void add(MediaSource mediaSource, T rankingData)

Adds a MediaSource with its rankingData to the preload manager.

Parameters
`MediaSource mediaSource`	The `MediaSource` to add.
`T rankingData`	The ranking data that is associated with the `mediaSource`.

addListener

public void addListener(PreloadManagerListener listener)

Adds a PreloadManagerListener to listen to the preload events.

This method can be called from any thread.

addMediaItems

public final void addMediaItems(List<MediaItem> mediaItems, List<T> rankingDataList)

Adds a list of media items with their rankingData to the preload manager.

Parameters
`List<MediaItem> mediaItems`	The `media items` to add.
`List<T> rankingDataList`	The ranking data that are associated with each media item.

Throws
`java.lang.IllegalArgumentException`	If the passed `mediaSources` and `rankingDataList` are different in sizes.

addMediaSources

public final void addMediaSources(
    List<MediaSource> mediaSources,
    List<T> rankingDataList
)

Adds a list of media sources with their rankingData to the preload manager.

Parameters
`List<MediaSource> mediaSources`	The `media sources` to add.
`List<T> rankingDataList`	The ranking data that are associated with each media source.

Throws
`java.lang.IllegalArgumentException`	If the passed `mediaSources` and `rankingDataList` are different in sizes.

clearListeners

public void clearListeners()

Clears all the listeners.

Throws
`java.lang.IllegalStateException`	If this method is called from the wrong thread.

getMediaSource

public final @Nullable MediaSource getMediaSource(MediaItem mediaItem)

Returns the MediaSource for the given MediaItem.

Parameters
`MediaItem mediaItem`	The media item.

Returns
`@Nullable MediaSource`	The source for the given `mediaItem` if it is managed by the preload manager, null otherwise.

getSourceCount

public final int getSourceCount()

Gets the count of the media sources currently being managed by the preload manager.

Returns
`int`	The count of the `media sources`.

invalidate

public final void invalidate()

Invalidates the current preload progress, and triggers a new preload progress based on the new priorities of the managed media sources.

release

public final void release()

Releases the preload manager.

The preload manager must not be used after calling this method.

remove

public final boolean remove(MediaItem mediaItem)

Removes a MediaItem from the preload manager.

Parameters
`MediaItem mediaItem`	The `MediaItem` to remove.

Returns
`boolean`	`true` if the preload manager is holding a `MediaSource` of the given `MediaItem` and it has been removed, otherwise `false`.

remove

public final boolean remove(MediaSource mediaSource)

Removes a MediaSource from the preload manager.

Parameters
`MediaSource mediaSource`	The `MediaSource` to remove.

Returns
`boolean`	`true` if the preload manager is holding the given `MediaSource` instance and it has been removed, otherwise `false`.

removeListener

public void removeListener(PreloadManagerListener listener)

Removes a PreloadManagerListener.

Throws
`java.lang.IllegalStateException`	If this method is called from the wrong thread.

removeMediaItems

public final void removeMediaItems(List<MediaItem> mediaItems)

Removes a list of media items from the preload manager.

Parameters
`List<MediaItem> mediaItems`	The `media items` to remove.

removeMediaSources

public final void removeMediaSources(List<MediaSource> mediaSources)

Removes a list of media sources from the preload manager.

Parameters
`List<MediaSource> mediaSources`	The `media sources` to remove.

reset

public final void reset()

Resets the preload manager. All sources that the preload manager is holding will be released.

Protected methods

createMediaSourceHolder

protected abstract BasePreloadManager.MediaSourceHolder createMediaSourceHolder(
    MediaItem mediaItem,
    MediaSource mediaSource,
    T rankingData
)

Returns the MediaSourceHolder that the preload manager creates for preloading based on the given MediaItem and MediaSource.

Parameters
`MediaItem mediaItem`	The `MediaItem`.
`MediaSource mediaSource`	The `MediaSource` based on which the preload manager creates for preloading.
`T rankingData`	The ranking data that is associated with the `mediaItem`.

Returns
`BasePreloadManager.MediaSourceHolder`	The `MediaSourceHolder` the preload manager creates for preloading.

getMediaSourceHolderToClear

protected @Nullable BasePreloadManager.MediaSourceHolder getMediaSourceHolderToClear()

getTargetPreloadStatusIfCurrentlyPreloading

protected final @Nullable PreloadStatusT getTargetPreloadStatusIfCurrentlyPreloading(MediaItem mediaItem)

getTargetPreloadStatusIfCurrentlyPreloading

protected final @Nullable PreloadStatusT getTargetPreloadStatusIfCurrentlyPreloading(MediaSource mediaSource)

onCompleted

protected final void onCompleted(
    MediaItem mediaItem,
    Predicate<PreloadStatusT> shouldNotifyListenerAndAdvancePredicate
)

Called when the given MediaItem completes preloading.

onCompleted

protected final void onCompleted(
    MediaSource mediaSource,
    Predicate<PreloadStatusT> shouldNotifyListenerAndAdvancePredicate
)

Called when the given MediaSource completes preloading.

onError

protected final void onError(
    PreloadException error,
    MediaItem mediaItem,
    Predicate<PreloadStatusT> shouldNotifyListenerAndAdvancePredicate
)

Called when an error occurs.

onError

protected final void onError(
    PreloadException error,
    MediaSource mediaSource,
    Predicate<PreloadStatusT> shouldNotifyListenerAndAdvancePredicate
)

Called when an error occurs.

onMediaSourceUpdated

protected final void onMediaSourceUpdated(
    MediaItem mediaItem,
    MediaSource updatedMediaSource
)

Called when the given MediaItem has its corresponding MediaSource updated.

Parameters
`MediaItem mediaItem`	The `MediaItem` that apps have added with.
`MediaSource updatedMediaSource`	The updated `MediaSource`.

onSkipped

protected final void onSkipped(
    MediaSource mediaSource,
    Predicate<PreloadStatusT> shouldAdvancePredicate
)

Called when the given MediaSource has been skipped before completing preloading.

onSourceCleared

protected final void onSourceCleared()

Called when there is a MediaSource has been cleared.

preloadMediaSourceHolderInternal

protected abstract void preloadMediaSourceHolderInternal(
    BasePreloadManager.MediaSourceHolder mediaSourceHolder,
    PreloadStatusT targetPreloadStatus
)

Preloads the given MediaSourceHolder.

Parameters
`BasePreloadManager.MediaSourceHolder mediaSourceHolder`	The `MediaSourceHolder` to preload.
`PreloadStatusT targetPreloadStatus`	The target preload status.

releaseInternal

protected void releaseInternal()

Releases the preload manager, see release.

releaseMediaSourceHolderInternal

@CallSuper
protected void releaseMediaSourceHolderInternal(
    BasePreloadManager.MediaSourceHolder mediaSourceHolder
)

Releases the given MediaSourceHolder.

Parameters
`BasePreloadManager.MediaSourceHolder mediaSourceHolder`	The `MediaSourceHolder` to remove.

shouldStartPreloadingNextSource

protected boolean shouldStartPreloadingNextSource()

Returns whether the next MediaSource should start preloading.

BasePreloadManager

Summary

Nested types

Protected fields

Protected constructors

Public methods

Protected methods

Protected fields

rankingDataComparator

Protected constructors

BasePreloadManager

Public methods

add

add

addListener

addMediaItems

addMediaSources

clearListeners

getMediaSource

getSourceCount

invalidate

release

remove

remove

removeListener

removeMediaItems

removeMediaSources

reset

Protected methods

createMediaSourceHolder

getMediaSourceHolderToClear

getTargetPreloadStatusIfCurrentlyPreloading

getTargetPreloadStatusIfCurrentlyPreloading

onCompleted

onCompleted

onError

onError

onMediaSourceUpdated

onSkipped

onSourceCleared

preloadMediaSourceHolderInternal

releaseInternal

releaseMediaSourceHolderInternal

shouldStartPreloadingNextSource