com.google.android.exoplayer2.source

Interface MediaSource

All Known Implementing Classes:

AdsMediaSource, BaseMediaSource, ClippingMediaSource, CompositeMediaSource, ConcatenatingMediaSource, DynamicConcatenatingMediaSource, ExtractorMediaSource, LoopingMediaSource, MergingMediaSource, SingleSampleMediaSource

public interface MediaSource

Defines and provides media to be played by an ExoPlayer. A MediaSource has two main responsibilities:

• To provide the player with a Timeline defining the structure of its media, and to provide a new timeline whenever the structure of the media changes. The MediaSource provides these timelines by calling MediaSource.SourceInfoRefreshListener.onSourceInfoRefreshed(com.google.android.exoplayer2.source.MediaSource, com.google.android.exoplayer2.Timeline, java.lang.Object) on the MediaSource.SourceInfoRefreshListeners passed to prepareSource(SourceInfoRefreshListener, TransferListener).
• To provide MediaPeriod instances for the periods in its timeline. MediaPeriods are obtained by calling createPeriod(MediaPeriodId, Allocator, long), and provide a way for the player to load and read the media.

All methods are called on the player's internal playback thread, as described in the ExoPlayer Javadoc. They should not be called directly from application code. Instances can be re-used, but only for one ExoPlayer instance simultaneously.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MediaSource.MediaPeriodId Identifier for a MediaPeriod.
static interface	MediaSource.SourceInfoRefreshListener Listener for source events.

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.
MediaPeriod	createPeriod(MediaSource.MediaPeriodId id, Allocator allocator, long startPositionUs) Returns a new MediaPeriod identified by periodId.
default java.lang.Object	getTag() Returns the tag set on the media source, or null if none was set.
void	maybeThrowSourceInfoRefreshError() Throws any pending error encountered while loading or refreshing source information.
void	prepareSource(MediaSource.SourceInfoRefreshListener listener, TransferListener mediaTransferListener) Starts source preparation if not yet started, and adds a listener for timeline and/or manifest updates.
void	releasePeriod(MediaPeriod mediaPeriod) Releases the period.
void	releaseSource(MediaSource.SourceInfoRefreshListener listener) Removes a listener for timeline and/or manifest updates and releases the source if no longer required.
void	removeEventListener(MediaSourceEventListener eventListener) Removes a MediaSourceEventListener from the list of listeners which are notified of media source events.

Method Detail

addEventListener

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

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

Parameters:

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

eventListener - The listener to be added.

removeEventListener

void removeEventListener(MediaSourceEventListener eventListener)

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

Parameters:

eventListener - The listener to be removed.

getTag

@Nullable
default java.lang.Object getTag()

Returns the tag set on the media source, or null if none was set.

prepareSource

void prepareSource(MediaSource.SourceInfoRefreshListener listener,
                   @Nullable
                   TransferListener mediaTransferListener)

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 releaseSource(SourceInfoRefreshListener) is needed to remove the listener and to release the source if no longer required.

Parameters:

listener - The listener to be added.

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.

maybeThrowSourceInfoRefreshError

void maybeThrowSourceInfoRefreshError()
                               throws java.io.IOException

Throws any pending error encountered while loading or refreshing source information.

Should not be called directly from application code.

Throws:

java.io.IOException

createPeriod

MediaPeriod createPeriod(MediaSource.MediaPeriodId id,
                         Allocator allocator,
                         long startPositionUs)

Returns a new MediaPeriod identified by periodId. This method may be called multiple times without an intervening call to releasePeriod(MediaPeriod).

Should not be called directly from application code.

Parameters:

id - The identifier of the period.

allocator - An Allocator from which to obtain media buffer allocations.

startPositionUs - The expected start position, in microseconds.

Returns:

A new MediaPeriod.

releasePeriod

void releasePeriod(MediaPeriod mediaPeriod)

Releases the period.

Should not be called directly from application code.

Parameters:

mediaPeriod - The period to release.

releaseSource

void releaseSource(MediaSource.SourceInfoRefreshListener listener)

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.

Parameters:

listener - The listener to be removed.