com.google.android.exoplayer2.source

Class BaseMediaSource

java.lang.Object

com.google.android.exoplayer2.source.BaseMediaSource

All Implemented Interfaces:

MediaSource

Direct Known Subclasses:

CompositeMediaSource, ExtractorMediaSource, SingleSampleMediaSource

public abstract class BaseMediaSource
extends java.lang.Object
implements MediaSource

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

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

Nested Class Summary

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

MediaSource.MediaPeriodId, MediaSource.SourceInfoRefreshListener

Constructor Summary

Constructors

Constructor and Description
BaseMediaSource()

Method Summary

Modifier and Type	Method and Description
void	addEventListener(android.os.Handler handler, MediaSourceEventListener eventListener) Adds a MediaSourceEventListener to the list of listeners which are notified of media source events.
protected MediaSourceEventListener.EventDispatcher	createEventDispatcher(int windowIndex, MediaSource.MediaPeriodId mediaPeriodId, long mediaTimeOffsetMs) Returns a MediaSourceEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified window index, media period id and time offset.
protected MediaSourceEventListener.EventDispatcher	createEventDispatcher(MediaSource.MediaPeriodId mediaPeriodId) Returns a MediaSourceEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified media period id.
protected MediaSourceEventListener.EventDispatcher	createEventDispatcher(MediaSource.MediaPeriodId mediaPeriodId, long mediaTimeOffsetMs) Returns a MediaSourceEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified media period id and time offset.
void	prepareSource(ExoPlayer player, boolean isTopLevelSource, MediaSource.SourceInfoRefreshListener listener) Starts source preparation if not yet started, and adds a listener for timeline and/or manifest updates.
protected abstract void	prepareSourceInternal(ExoPlayer player, boolean isTopLevelSource) Starts source preparation.
protected void	refreshSourceInfo(Timeline timeline, java.lang.Object manifest) Updates timeline and manifest and notifies all listeners of the update.
void	releaseSource(MediaSource.SourceInfoRefreshListener listener) Removes a listener for timeline and/or manifest updates and releases the source if no longer required.
protected abstract void	releaseSourceInternal() Releases the source.
void	removeEventListener(MediaSourceEventListener eventListener) 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, maybeThrowSourceInfoRefreshError, releasePeriod

Constructor Detail

BaseMediaSource

public BaseMediaSource()

Method Detail

prepareSourceInternal

protected abstract void prepareSourceInternal(ExoPlayer player,
                                              boolean isTopLevelSource)

Starts source preparation. This method is called at most once until the next call to releaseSourceInternal().

Parameters:

player - The player for which this source is being prepared.

isTopLevelSource - Whether this source has been passed directly to ExoPlayer.prepare(MediaSource) or ExoPlayer.prepare(MediaSource, boolean, boolean).

releaseSourceInternal

protected abstract void releaseSourceInternal()

Releases the source. This method is called exactly once after each call to prepareSourceInternal(ExoPlayer, boolean).

refreshSourceInfo

protected final void refreshSourceInfo(Timeline timeline,
                                       @Nullable
                                       java.lang.Object manifest)

Updates timeline and manifest and notifies all listeners of the update.

Parameters:

timeline - The new Timeline.

manifest - The new manifest. May be null.

createEventDispatcher

protected final MediaSourceEventListener.EventDispatcher createEventDispatcher(@Nullable
                                                                               MediaSource.MediaPeriodId mediaPeriodId)

Returns a MediaSourceEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified media period id.

Parameters:

mediaPeriodId - The 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 createEventDispatcher(MediaSource.MediaPeriodId mediaPeriodId,
                                                                               long mediaTimeOffsetMs)

Returns a MediaSourceEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified media period id and time offset.

Parameters:

mediaPeriodId - The MediaPeriodId to be reported with the events.

mediaTimeOffsetMs - The offset to be added to all media times, in milliseconds.

Returns:

An event dispatcher with pre-configured media period id and time offset.

createEventDispatcher

protected final MediaSourceEventListener.EventDispatcher createEventDispatcher(int windowIndex,
                                                                               @Nullable
                                                                               MediaSource.MediaPeriodId mediaPeriodId,
                                                                               long mediaTimeOffsetMs)

Returns a MediaSourceEventListener.EventDispatcher which dispatches all events to the registered listeners with the specified window index, media period id and time offset.

Parameters:

windowIndex - The timeline window index to be reported with the events.

mediaPeriodId - The MediaPeriodId to be reported with the events. May be null, if the events do not belong to a specific media period.

mediaTimeOffsetMs - The offset to be added to all media times, in milliseconds.

Returns:

An event dispatcher with pre-configured media period id and time offset.

addEventListener

public final void addEventListener(android.os.Handler handler,
                                   MediaSourceEventListener eventListener)

Description copied from interface: MediaSource

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

Specified by:

addEventListener in interface MediaSource

Parameters:

handler - A handler on the which listener events will be posted.

eventListener - The listener to be added.

removeEventListener

public final void removeEventListener(MediaSourceEventListener eventListener)

Description copied from interface: MediaSource

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

Specified by:

removeEventListener in interface MediaSource

Parameters:

eventListener - The listener to be removed.

prepareSource

public final void prepareSource(ExoPlayer player,
                                boolean isTopLevelSource,
                                MediaSource.SourceInfoRefreshListener listener)

Description copied from interface: MediaSource

Starts source preparation if not yet started, and adds a listener for timeline and/or manifest updates.

Should not be called directly from application code.

The listener will be also be notified if the source already has a timeline and/or manifest.

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

Specified by:

prepareSource in interface MediaSource

Parameters:

player - The player for which this source is being prepared.

isTopLevelSource - Whether this source has been passed directly to ExoPlayer.prepare(MediaSource) or ExoPlayer.prepare(MediaSource, boolean, boolean). If false, this source is being prepared by another source (e.g. ConcatenatingMediaSource) for composition.

listener - The listener to be added.

releaseSource

public final void releaseSource(MediaSource.SourceInfoRefreshListener listener)

Description copied from interface: MediaSource

Removes a listener for timeline and/or manifest updates and releases the source if no longer required.

Should not be called directly from application code.

Specified by:

releaseSource in interface MediaSource

Parameters:

listener - The listener to be removed.