com.google.android.exoplayer2.source

Class ClippingMediaSource

java.lang.Object

com.google.android.exoplayer2.source.CompositeMediaSource<java.lang.Void>

com.google.android.exoplayer2.source.ClippingMediaSource

All Implemented Interfaces:

MediaSource

public final class ClippingMediaSource
extends CompositeMediaSource<java.lang.Void>

MediaSource that wraps a source and clips its timeline based on specified start/end positions. The wrapped source must consist of a single period that starts at the beginning of the corresponding window.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClippingMediaSource.IllegalClippingException Thrown when a ClippingMediaSource cannot clip its wrapped source.

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

MediaSource.Listener, MediaSource.MediaPeriodId

Field Summary

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

MEDIA_SOURCE_REUSED_ERROR_MESSAGE

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.
protected void	onChildSourceInfoRefreshed(java.lang.Void id, MediaSource mediaSource, Timeline timeline, java.lang.Object manifest) Called when the source info of a child source 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 com.google.android.exoplayer2.source.CompositeMediaSource

prepareChildSource, releaseChildSource

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 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. Specifying a position that exceeds the mediaSource's duration will also result in the end of the source not being clipped.

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 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. Specifying a position that exceeds the mediaSource's duration will also result in the end of the source not being clipped.

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.

Should not be called directly from application code.

Specified by:

prepareSource in interface MediaSource

Overrides:

prepareSource in class CompositeMediaSource<java.lang.Void>

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 java.io.IOException

Description copied from interface: MediaSource

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

Should not be called directly from application code.

Specified by:

maybeThrowSourceInfoRefreshError in interface MediaSource

Overrides:

maybeThrowSourceInfoRefreshError in class CompositeMediaSource<java.lang.Void>

Throws:

java.io.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).

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.

Returns:

A new MediaPeriod.

releasePeriod

public void releasePeriod(MediaPeriod mediaPeriod)

Description copied from interface: MediaSource

Releases the period.

Should not be called directly from application code.

Parameters:

mediaPeriod - The period to release.

releaseSource

public void releaseSource()

Description copied from interface: MediaSource

Releases the source.

Should not be called directly from application code.

Specified by:

releaseSource in interface MediaSource

Overrides:

releaseSource in class CompositeMediaSource<java.lang.Void>

onChildSourceInfoRefreshed

protected void onChildSourceInfoRefreshed(java.lang.Void id,
                                          MediaSource mediaSource,
                                          Timeline timeline,
                                          @Nullable
                                          java.lang.Object manifest)

Description copied from class: CompositeMediaSource

Called when the source info of a child source has been refreshed.

Specified by:

onChildSourceInfoRefreshed in class CompositeMediaSource<java.lang.Void>

Parameters:

id - The unique id used to prepare the child source.

mediaSource - The child source whose source info has been refreshed.

timeline - The timeline of the child source.

manifest - The manifest of the child source.