com.google.android.exoplayer2.source

Class ClippingMediaSource

java.lang.Object

com.google.android.exoplayer2.source.ClippingMediaSource

All Implemented Interfaces:

MediaSource, MediaSource.Listener

public final class ClippingMediaSource
extends Object
implements MediaSource, MediaSource.Listener

MediaSource that wraps a source and clips its timeline based on specified start/end positions. The wrapped source may only have a single period/window and it must not be dynamic (live).

Nested Class Summary

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

MediaSource.Listener, MediaSource.MediaPeriodId

Constructor Summary

Constructors

Constructor and Description
ClippingMediaSource(MediaSource mediaSource, long startPositionUs, long endPositionUs) Creates a new clipping source that wraps the specified source.
ClippingMediaSource(MediaSource mediaSource, long startPositionUs, long endPositionUs, boolean enableInitialDiscontinuity) Creates a new clipping source that wraps the specified source.

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	onSourceInfoRefreshed(Timeline timeline, Object manifest) Called when manifest and/or timeline has been refreshed.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClippingMediaSource

public ClippingMediaSource(MediaSource mediaSource,
                           long startPositionUs,
                           long endPositionUs)

Creates a new clipping source that wraps the specified source.

Parameters:

mediaSource - The single-period, non-dynamic source to wrap.

startPositionUs - The start position within mediaSource's timeline at which to start providing samples, in microseconds.

endPositionUs - The end position within mediaSource's timeline at which to stop providing samples, in microseconds. Specify C.TIME_END_OF_SOURCE to provide samples from the specified start point up to the end of the source.

ClippingMediaSource

public ClippingMediaSource(MediaSource mediaSource,
                           long startPositionUs,
                           long endPositionUs,
                           boolean enableInitialDiscontinuity)

Creates a new clipping source that wraps the specified source.

If the start point is guaranteed to be a key frame, pass false to enableInitialPositionDiscontinuity to suppress an initial discontinuity when a period is first read from.

Parameters:

mediaSource - The single-period, non-dynamic source to wrap.

startPositionUs - The start position within mediaSource's timeline at which to start providing samples, in microseconds.

endPositionUs - The end position within mediaSource's timeline at which to stop providing samples, in microseconds. Specify C.TIME_END_OF_SOURCE to provide samples from the specified start point up to the end of the source.

enableInitialDiscontinuity - Whether the initial discontinuity should be enabled.

Method Detail

prepareSource

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

Description copied from interface: MediaSource

Starts preparation of the source.

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

maybeThrowSourceInfoRefreshError

public void maybeThrowSourceInfoRefreshError()
                                      throws IOException

Description copied from interface: MediaSource

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

Specified by:

maybeThrowSourceInfoRefreshError in interface MediaSource

Throws:

IOException

createPeriod

public MediaPeriod createPeriod(MediaSource.MediaPeriodId id,
                                Allocator allocator)

Description copied from interface: MediaSource

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

Specified by:

createPeriod in interface MediaSource

Parameters:

id - The identifier of the period.

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

Returns:

A new MediaPeriod.

releasePeriod

public void releasePeriod(MediaPeriod mediaPeriod)

Description copied from interface: MediaSource

Releases the period.

Specified by:

releasePeriod in interface MediaSource

Parameters:

mediaPeriod - The period to release.

releaseSource

public void releaseSource()

Description copied from interface: MediaSource

Releases the source.

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

Specified by:

releaseSource in interface MediaSource

onSourceInfoRefreshed

public void onSourceInfoRefreshed(Timeline timeline,
                                  Object manifest)

Description copied from interface: MediaSource.Listener

Called when manifest and/or timeline has been refreshed.

Specified by:

onSourceInfoRefreshed in interface MediaSource.Listener

Parameters:

timeline - The source's timeline.

manifest - The loaded manifest. May be null.