BaseMediaSource (ExoPlayer library) - Exoplayer

Package com.google.android.exoplayer2.source

Class BaseMediaSource

java.lang.Object
- com.google.android.exoplayer2.source.BaseMediaSource
All Implemented Interfaces:MediaSourceDirect Known Subclasses:CompositeMediaSource, DashMediaSource, FakeMediaSource, HlsMediaSource, ProgressiveMediaSource, RtspMediaSource, ServerSideAdInsertionMediaSource, SilenceMediaSource, SingleSampleMediaSource, SsMediaSource

[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public abstract classBaseMediaSourceextends[Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")implements[MediaSource](MediaSource.html "interface in com.google.android.exoplayer2.source")

Deprecated. com.google.android.exoplayer2 is deprecated. Please migrate to androidx.media3 (which contains the same ExoPlayer code). See the migration guide for more details, including a script to help with the migration.

Base MediaSource implementation to handle parallel reuse and to keep a list of MediaSourceEventListeners.

Whenever an implementing subclass needs to provide a new timeline, it must call refreshSourceInfo(Timeline) to notify all listeners.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.source.MediaSource

MediaSource.Factory, MediaSource.MediaPeriodId, MediaSource.MediaSourceCaller

Constructor Summary

Constructors | Constructor | Description | | --- | --- | | BaseMediaSource() | Deprecated. |

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods | Modifier and Type | Method | Description | | --- | --- | --- | | void | addDrmEventListener(Handler handler, DrmSessionEventListener eventListener) | Deprecated.

Adds a DrmSessionEventListener to the list of listeners which are notified of DRM events for this media source. | | void | addEventListener(Handler handler, MediaSourceEventListener eventListener) | Deprecated.

Adds a MediaSourceEventListener to the list of listeners which are notified of media source events. | | protected DrmSessionEventListener.EventDispatcher | createDrmEventDispatcher(int windowIndex, MediaSource.MediaPeriodId mediaPeriodId) | Deprecated.

Returns a DrmSessionEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified window index and MediaSource.MediaPeriodId. | | protected DrmSessionEventListener.EventDispatcher | createDrmEventDispatcher(MediaSource.MediaPeriodId mediaPeriodId) | Deprecated.

Returns a DrmSessionEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified MediaSource.MediaPeriodId | | protected MediaSourceEventListener.EventDispatcher | createEventDispatcher(int windowIndex, MediaSource.MediaPeriodId mediaPeriodId) | Deprecated.

Returns a MediaSourceEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified window index and MediaSource.MediaPeriodId. | | protected MediaSourceEventListener.EventDispatcher | createEventDispatcher(int windowIndex, MediaSource.MediaPeriodId mediaPeriodId, long mediaTimeOffsetMs) | Deprecated. Use createEventDispatcher(int, MediaPeriodId) instead.

| | protected MediaSourceEventListener.EventDispatcher | createEventDispatcher(MediaSource.MediaPeriodId mediaPeriodId) | Deprecated.

Returns a MediaSourceEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified MediaSource.MediaPeriodId. | | protected MediaSourceEventListener.EventDispatcher | createEventDispatcher(MediaSource.MediaPeriodId mediaPeriodId, long mediaTimeOffsetMs) | Deprecated. Use createEventDispatcher(MediaPeriodId) instead.

| | void | disable(MediaSource.MediaSourceCaller caller) | Deprecated.

Disables the source for the creation of MediaPeriods. | | protected void | disableInternal() | Deprecated.

Disables the source, see disable(MediaSourceCaller). | | void | enable(MediaSource.MediaSourceCaller caller) | Deprecated.

Enables the source for the creation of MediaPeriods. | | protected void | enableInternal() | Deprecated.

Enables the source, see enable(MediaSourceCaller). | | protected PlayerId | getPlayerId() | Deprecated.

Returns the PlayerId of the player using this media source. | | protected boolean | isEnabled() | Deprecated.

Registers a MediaSource.MediaSourceCaller. | | protected abstract void | prepareSourceInternal(TransferListener mediaTransferListener) | Deprecated.

Starts source preparation and enables the source, see prepareSource(MediaSourceCaller, TransferListener, PlayerId). | | protected void | refreshSourceInfo(Timeline timeline) | Deprecated.

Updates timeline and manifest and notifies all listeners of the update. | | void | releaseSource(MediaSource.MediaSourceCaller caller) | Deprecated.

Unregisters a caller, and disables and releases the source if no longer required. | | protected abstract void | releaseSourceInternal() | Deprecated.

Releases the source, see releaseSource(MediaSourceCaller). | | void | removeDrmEventListener(DrmSessionEventListener eventListener) | Deprecated.

Removes a DrmSessionEventListener from the list of listeners which are notified of DRM events for this media source. | | void | removeEventListener(MediaSourceEventListener eventListener) | Deprecated.

Removes a MediaSourceEventListener from the list of listeners which are notified of media source events. |

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.android.exoplayer2.source.MediaSource

createPeriod, getInitialTimeline, getMediaItem, isSingleWindow, maybeThrowSourceInfoRefreshError, releasePeriod

Constructor Detail

BaseMediaSource

public BaseMediaSource()

Deprecated.

Method Detail

prepareSourceInternal

protected abstract void prepareSourceInternal(@Nullable[TransferListener](../upstream/TransferListener.html "interface in com.google.android.exoplayer2.upstream")mediaTransferListener)

Deprecated.

Starts source preparation and enables the source, see prepareSource(MediaSourceCaller, TransferListener, PlayerId). This method is called at most once until the next call to releaseSourceInternal(). Parameters:mediaTransferListener - 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.

enableInternal

protected void enableInternal()

Deprecated.

Enables the source, see enable(MediaSourceCaller).

disableInternal

protected void disableInternal()

Deprecated.

Disables the source, see disable(MediaSourceCaller).

releaseSourceInternal

protected abstract void releaseSourceInternal()

Deprecated.

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

refreshSourceInfo

protected final void refreshSourceInfo([Timeline](../Timeline.html "class in com.google.android.exoplayer2")timeline)

Deprecated.

Updates timeline and manifest and notifies all listeners of the update. Parameters:timeline - The new Timeline.

createEventDispatcher

protected final[MediaSourceEventListener.EventDispatcher](MediaSourceEventListener.EventDispatcher.html "class in com.google.android.exoplayer2.source")createEventDispatcher(@Nullable[MediaSource.MediaPeriodId](MediaSource.MediaPeriodId.html "class in com.google.android.exoplayer2.source")mediaPeriodId)

Deprecated.

Returns a MediaSourceEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified MediaSource.MediaPeriodId. Parameters:mediaPeriodId - The MediaSource.MediaPeriodId to be reported with the events. May be null, if the events do not belong to a specific media period.Returns:An event dispatcher with pre-configured media period id.

createEventDispatcher

protected final[MediaSourceEventListener.EventDispatcher](MediaSourceEventListener.EventDispatcher.html "class in com.google.android.exoplayer2.source")createEventDispatcher(int windowIndex,
                                                                               @Nullable[MediaSource.MediaPeriodId](MediaSource.MediaPeriodId.html "class in com.google.android.exoplayer2.source")mediaPeriodId)

Deprecated.

Returns a MediaSourceEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified window index and MediaSource.MediaPeriodId. Parameters:windowIndex - The timeline window index to be reported with the events.mediaPeriodId - The MediaSource.MediaPeriodId to be reported with the events. May be null, if the events do not belong to a specific media period.Returns:An event dispatcher with pre-configured media period id.

createEventDispatcher

[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")protected final[MediaSourceEventListener.EventDispatcher](MediaSourceEventListener.EventDispatcher.html "class in com.google.android.exoplayer2.source")createEventDispatcher([MediaSource.MediaPeriodId](MediaSource.MediaPeriodId.html "class in com.google.android.exoplayer2.source")mediaPeriodId,
                                                                               long mediaTimeOffsetMs)

Deprecated. Use createEventDispatcher(MediaPeriodId) instead.

Note: The mediaTimeOffsetMs passed to this method is ignored and not added to media times in any way.

createEventDispatcher

[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")protected final[MediaSourceEventListener.EventDispatcher](MediaSourceEventListener.EventDispatcher.html "class in com.google.android.exoplayer2.source")createEventDispatcher(int windowIndex,
                                                                               @Nullable[MediaSource.MediaPeriodId](MediaSource.MediaPeriodId.html "class in com.google.android.exoplayer2.source")mediaPeriodId,
                                                                               long mediaTimeOffsetMs)

Deprecated. Use createEventDispatcher(int, MediaPeriodId) instead.

Note: The mediaTimeOffsetMs passed to this method is ignored and not added to media times in any way.

createDrmEventDispatcher

protected final[DrmSessionEventListener.EventDispatcher](../drm/DrmSessionEventListener.EventDispatcher.html "class in com.google.android.exoplayer2.drm")createDrmEventDispatcher(@Nullable[MediaSource.MediaPeriodId](MediaSource.MediaPeriodId.html "class in com.google.android.exoplayer2.source")mediaPeriodId)

Deprecated.

Returns a DrmSessionEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified MediaSource.MediaPeriodId Parameters:mediaPeriodId - The MediaSource.MediaPeriodId to be reported with the events. May be null, if the events do not belong to a specific media period.Returns:An event dispatcher with pre-configured media period id.

createDrmEventDispatcher

protected final[DrmSessionEventListener.EventDispatcher](../drm/DrmSessionEventListener.EventDispatcher.html "class in com.google.android.exoplayer2.drm")createDrmEventDispatcher(int windowIndex,
                                                                                 @Nullable[MediaSource.MediaPeriodId](MediaSource.MediaPeriodId.html "class in com.google.android.exoplayer2.source")mediaPeriodId)

Deprecated.

Returns a DrmSessionEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified window index and MediaSource.MediaPeriodId. Parameters:windowIndex - The timeline window index to be reported with the events.mediaPeriodId - The MediaSource.MediaPeriodId to be reported with the events. May be null, if the events do not belong to a specific media period.Returns:An event dispatcher with pre-configured media period id and time offset.

isEnabled

protected final boolean isEnabled()

Deprecated.

Returns whether the source is enabled.

getPlayerId

protected final[PlayerId](../analytics/PlayerId.html "class in com.google.android.exoplayer2.analytics")getPlayerId()

Deprecated.

Returns the PlayerId of the player using this media source.

Must only be used when the media source is prepared.

addEventListener

public final void addEventListener([Handler](https://developer.android.com/reference/android/os/Handler.html "class or interface in android.os")handler,[MediaSourceEventListener](MediaSourceEventListener.html "interface in com.google.android.exoplayer2.source")eventListener)

Deprecated.

Description copied from interface: MediaSource

Adds a MediaSourceEventListener to the list of listeners which are notified of media source events.

Should not be called directly from application code.

This method must be called on the playback thread.

Specified by:addEventListener in interface MediaSourceParameters:handler - A handler on the which listener events will be posted.eventListener - The listener to be added.

removeEventListener

public final void removeEventListener([MediaSourceEventListener](MediaSourceEventListener.html "interface in com.google.android.exoplayer2.source")eventListener)

Deprecated.

Description copied from interface: MediaSource

Removes a MediaSourceEventListener from the list of listeners which are notified of media source events.

Should not be called directly from application code.

This method must be called on the playback thread.

Specified by:removeEventListener in interface MediaSourceParameters:eventListener - The listener to be removed.

addDrmEventListener

public final void addDrmEventListener([Handler](https://developer.android.com/reference/android/os/Handler.html "class or interface in android.os")handler,[DrmSessionEventListener](../drm/DrmSessionEventListener.html "interface in com.google.android.exoplayer2.drm")eventListener)

Deprecated.

Description copied from interface: MediaSource

Adds a DrmSessionEventListener to the list of listeners which are notified of DRM events for this media source.

Should not be called directly from application code.

This method must be called on the playback thread.

Specified by:addDrmEventListener in interface MediaSourceParameters:handler - A handler on the which listener events will be posted.eventListener - The listener to be added.

removeDrmEventListener

public final void removeDrmEventListener([DrmSessionEventListener](../drm/DrmSessionEventListener.html "interface in com.google.android.exoplayer2.drm")eventListener)

Deprecated.

Description copied from interface: MediaSource

Removes a DrmSessionEventListener from the list of listeners which are notified of DRM events for this media source.

Should not be called directly from application code.

This method must be called on the playback thread.

Specified by:removeDrmEventListener in interface MediaSourceParameters:eventListener - The listener to be removed.

prepareSource

public final void prepareSource([MediaSource.MediaSourceCaller](MediaSource.MediaSourceCaller.html "interface in com.google.android.exoplayer2.source")caller,
                                @Nullable[TransferListener](../upstream/TransferListener.html "interface in com.google.android.exoplayer2.upstream")mediaTransferListener)

Deprecated. Specified by:prepareSource in interface MediaSource

prepareSource

public final void prepareSource([MediaSource.MediaSourceCaller](MediaSource.MediaSourceCaller.html "interface in com.google.android.exoplayer2.source")caller,
                                @Nullable[TransferListener](../upstream/TransferListener.html "interface in com.google.android.exoplayer2.upstream")mediaTransferListener,[PlayerId](../analytics/PlayerId.html "class in com.google.android.exoplayer2.analytics")playerId)

Deprecated.

Description copied from interface: MediaSource

Registers a MediaSource.MediaSourceCaller. Starts source preparation if needed and enables the source for the creation of MediaPerods.

Should not be called directly from application code.

MediaSource.MediaSourceCaller.onSourceInfoRefreshed(MediaSource, Timeline) will be called once the source has a Timeline.

For each call to this method, a call to MediaSource.releaseSource(MediaSourceCaller) is needed to remove the caller and to release the source if no longer required.

This method must be called on the playback thread.

Specified by:prepareSource in interface MediaSourceParameters:caller - The MediaSource.MediaSourceCaller to be registered.mediaTransferListener - 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 be only informed of transfers related to the media loads and not of auxiliary loads for manifests and other data.playerId - The PlayerId of the player using this media source.

enable

public final void enable([MediaSource.MediaSourceCaller](MediaSource.MediaSourceCaller.html "interface in com.google.android.exoplayer2.source")caller)

Deprecated.

Description copied from interface: MediaSource

Enables the source for the creation of MediaPeriods.

Should not be called directly from application code.

This method must be called on the playback thread and only after MediaSource.prepareSource(MediaSourceCaller, TransferListener, PlayerId).

Specified by:enable in interface MediaSourceParameters:caller - The MediaSource.MediaSourceCaller enabling the source.

disable

public final void disable([MediaSource.MediaSourceCaller](MediaSource.MediaSourceCaller.html "interface in com.google.android.exoplayer2.source")caller)

Deprecated.

Description copied from interface: MediaSource

Disables the source for the creation of MediaPeriods. The implementation should not hold onto limited resources used for the creation of media periods.

Should not be called directly from application code.

This method must be called on the playback thread and only after all MediaPeriods previously created by MediaSource.createPeriod(MediaPeriodId, Allocator, long) have been released by MediaSource.releasePeriod(MediaPeriod).

Specified by:disable in interface MediaSourceParameters:caller - The MediaSource.MediaSourceCaller disabling the source.

releaseSource

public final void releaseSource([MediaSource.MediaSourceCaller](MediaSource.MediaSourceCaller.html "interface in com.google.android.exoplayer2.source")caller)

Deprecated.

Description copied from interface: MediaSource

Unregisters a caller, and disables and releases the source if no longer required.

Should not be called directly from application code.

This method must be called on the playback thread and only if all created MediaPeriods have been released by MediaSource.releasePeriod(MediaPeriod).

Specified by:releaseSource in interface MediaSourceParameters:caller - The MediaSource.MediaSourceCaller to be unregistered.