com.google.android.exoplayer2.source

Interface MediaSource

All Known Implementing Classes:

AdsMediaSource, ClippingMediaSource, 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.Listener.onSourceInfoRefreshed(com.google.android.exoplayer2.source.MediaSource, com.google.android.exoplayer2.Timeline, java.lang.Object) on the MediaSource.Listener passed to prepareSource(ExoPlayer, boolean, Listener).
• To provide MediaPeriod instances for the periods in its timeline. MediaPeriods are obtained by calling createPeriod(MediaPeriodId, Allocator), 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.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
MediaPeriod	createPeriod(MediaSource.MediaPeriodId id, Allocator allocator) Returns a new MediaPeriod identified by periodId.
void	maybeThrowSourceInfoRefreshError() Throws any pending error encountered while loading or refreshing source information.
void	prepareSource(ExoPlayer player, boolean isTopLevelSource, MediaSource.Listener listener) Starts preparation of the source.
void	releasePeriod(MediaPeriod mediaPeriod) Releases the period.
void	releaseSource() Releases the source.

Method Detail

prepareSource

void prepareSource(ExoPlayer player,
                   boolean isTopLevelSource,
                   MediaSource.Listener listener)

Starts preparation of the source.

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 for source events.

maybeThrowSourceInfoRefreshError

void maybeThrowSourceInfoRefreshError()
                               throws java.io.IOException

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

Throws:

java.io.IOException

createPeriod

MediaPeriod createPeriod(MediaSource.MediaPeriodId id,
                         Allocator allocator)

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

Parameters:

id - The identifier of the period.

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

Returns:

A new MediaPeriod.

releasePeriod

void releasePeriod(MediaPeriod mediaPeriod)

Releases the period.

Parameters:

mediaPeriod - The period to release.

releaseSource

void releaseSource()

Releases the source.

This method should be called when the source is no longer required. It may be called in any state.