public final class ClippingMediaPeriod extends Object implements MediaPeriod, MediaPeriod.Callback
MediaPeriod
and clips its SampleStream
s to provide a subsequence of their
samples.MediaPeriod.Callback
Modifier and Type | Field and Description |
---|---|
MediaPeriod |
mediaPeriod
The
MediaPeriod wrapped by this clipping media period. |
Constructor and Description |
---|
ClippingMediaPeriod(MediaPeriod mediaPeriod,
boolean enableInitialDiscontinuity,
long startUs,
long endUs)
Creates a new clipping media period that provides a clipped view of the specified
MediaPeriod 's sample streams. |
Modifier and Type | Method and Description |
---|---|
boolean |
continueLoading(long positionUs)
Attempts to continue loading.
|
void |
discardBuffer(long positionUs,
boolean toKeyframe)
Discards buffered media up to the specified position.
|
long |
getAdjustedSeekPositionUs(long positionUs,
SeekParameters seekParameters)
Returns the position to which a seek will be performed, given the specified seek position and
SeekParameters . |
long |
getBufferedPositionUs()
Returns an estimate of the position up to which data is buffered for the enabled tracks.
|
long |
getNextLoadPositionUs()
Returns the next load time, or
C.TIME_END_OF_SOURCE if loading has finished. |
TrackGroupArray |
getTrackGroups()
Returns the
TrackGroup s exposed by the period. |
void |
maybeThrowPrepareError()
Throws an error that's preventing the period from becoming prepared.
|
void |
onContinueLoadingRequested(MediaPeriod source)
Called by the loader to indicate that it wishes for its
SequenceableLoader.continueLoading(long) method
to be called when it can continue to load data. |
void |
onPrepared(MediaPeriod mediaPeriod)
Called when preparation completes.
|
void |
prepare(MediaPeriod.Callback callback,
long positionUs)
Prepares this media period asynchronously.
|
long |
readDiscontinuity()
Attempts to read a discontinuity.
|
void |
reevaluateBuffer(long positionUs)
Re-evaluates the buffer given the playback position.
|
long |
seekToUs(long positionUs)
Attempts to seek to the specified position in microseconds.
|
long |
selectTracks(TrackSelection[] selections,
boolean[] mayRetainStreamFlags,
SampleStream[] streams,
boolean[] streamResetFlags,
long positionUs)
Performs a track selection.
|
void |
updateClipping(long startUs,
long endUs)
Updates the clipping start/end times for this period, in microseconds.
|
public final MediaPeriod mediaPeriod
MediaPeriod
wrapped by this clipping media period.public ClippingMediaPeriod(MediaPeriod mediaPeriod, boolean enableInitialDiscontinuity, long startUs, long endUs)
MediaPeriod
's sample streams.
If the start point is guaranteed to be a key frame, pass false
to enableInitialPositionDiscontinuity
to suppress an initial discontinuity when the period is
first read from.
mediaPeriod
- The media period to clip.enableInitialDiscontinuity
- Whether the initial discontinuity should be enabled.startUs
- The clipping start time, in microseconds.endUs
- The clipping end time, in microseconds, or C.TIME_END_OF_SOURCE
to
indicate the end of the period.public void updateClipping(long startUs, long endUs)
startUs
- The clipping start time, in microseconds.endUs
- The clipping end time, in microseconds, or C.TIME_END_OF_SOURCE
to
indicate the end of the period.public void prepare(MediaPeriod.Callback callback, long positionUs)
MediaPeriod
callback.onPrepared
is called when preparation completes. If preparation fails,
MediaPeriod.maybeThrowPrepareError()
will throw an IOException
.
If preparation succeeds and results in a source timeline change (e.g. the period duration
becoming known), MediaSource.SourceInfoRefreshListener.onSourceInfoRefreshed(MediaSource, Timeline, Object)
will be called before callback.onPrepared
.
prepare
in interface MediaPeriod
callback
- Callback to receive updates from this period, including being notified when
preparation completes.positionUs
- The expected starting position, in microseconds.public void maybeThrowPrepareError() throws IOException
MediaPeriod
This method is only called before the period has completed preparation.
maybeThrowPrepareError
in interface MediaPeriod
IOException
- The underlying error.public TrackGroupArray getTrackGroups()
MediaPeriod
TrackGroup
s exposed by the period.
This method is only called after the period has been prepared.
getTrackGroups
in interface MediaPeriod
TrackGroup
s.public long selectTracks(TrackSelection[] selections, boolean[] mayRetainStreamFlags, SampleStream[] streams, boolean[] streamResetFlags, long positionUs)
MediaPeriod
The call receives track selections
for each renderer, mayRetainStreamFlags
indicating whether the existing SampleStream
can be retained for each selection, and
the existing stream
s themselves. The call will update streams
to reflect the
provided selections, clearing, setting and replacing entries as required. If an existing sample
stream is retained but with the requirement that the consuming renderer be reset, then the
corresponding flag in streamResetFlags
will be set to true. This flag will also be set
if a new sample stream is created.
This method is only called after the period has been prepared.
selectTracks
in interface MediaPeriod
selections
- The renderer track selections.mayRetainStreamFlags
- Flags indicating whether the existing sample stream can be retained
for each selection. A true
value indicates that the selection is unchanged, and
that the caller does not require that the sample stream be recreated.streams
- The existing sample streams, which will be updated to reflect the provided
selections.streamResetFlags
- Will be updated to indicate new sample streams, and sample streams that
have been retained but with the requirement that the consuming renderer be reset.positionUs
- The current playback position in microseconds. If playback of this period has
not yet started, the value will be the starting position.public void discardBuffer(long positionUs, boolean toKeyframe)
MediaPeriod
This method is only called after the period has been prepared.
discardBuffer
in interface MediaPeriod
positionUs
- The position in microseconds.toKeyframe
- If true then for each track discards samples up to the keyframe before or at
the specified position, rather than any sample before or at that position.public void reevaluateBuffer(long positionUs)
MediaPeriod
This method is only called after the period has been prepared.
A period may choose to discard buffered media so that it can be re-buffered in a different quality.
reevaluateBuffer
in interface MediaPeriod
reevaluateBuffer
in interface SequenceableLoader
positionUs
- The current playback position in microseconds. If playback of this period has
not yet started, the value will be the starting position in this period minus the duration
of any media in previous periods still to be played.public long readDiscontinuity()
MediaPeriod
After this method has returned a value other than C.TIME_UNSET
, all SampleStream
s provided by the period are guaranteed to start from a key frame.
This method is only called after the period has been prepared and before reading from any
SampleStream
s provided by the period.
readDiscontinuity
in interface MediaPeriod
C.TIME_UNSET
.public long getBufferedPositionUs()
MediaPeriod
This method is only called when at least one track is selected.
getBufferedPositionUs
in interface MediaPeriod
getBufferedPositionUs
in interface SequenceableLoader
C.TIME_END_OF_SOURCE
if the track is fully buffered.public long seekToUs(long positionUs)
MediaPeriod
After this method has been called, all SampleStream
s provided by the period are
guaranteed to start from a key frame.
This method is only called when at least one track is selected.
seekToUs
in interface MediaPeriod
positionUs
- The seek position in microseconds.public long getAdjustedSeekPositionUs(long positionUs, SeekParameters seekParameters)
MediaPeriod
SeekParameters
.
This method is only called after the period has been prepared.
getAdjustedSeekPositionUs
in interface MediaPeriod
positionUs
- The seek position in microseconds.seekParameters
- Parameters that control how the seek is performed. Implementations may
apply seek parameters on a best effort basis.public long getNextLoadPositionUs()
MediaPeriod
C.TIME_END_OF_SOURCE
if loading has finished.
This method is only called after the period has been prepared. It may be called when no tracks are selected.
getNextLoadPositionUs
in interface MediaPeriod
getNextLoadPositionUs
in interface SequenceableLoader
public boolean continueLoading(long positionUs)
MediaPeriod
This method may be called both during and after the period has been prepared.
A period may call SequenceableLoader.Callback.onContinueLoadingRequested(SequenceableLoader)
on the
MediaPeriod.Callback
passed to MediaPeriod.prepare(Callback, long)
to request that this method be
called when the period is permitted to continue loading data. A period may do this both during
and after preparation.
continueLoading
in interface MediaPeriod
continueLoading
in interface SequenceableLoader
positionUs
- The current playback position in microseconds. If playback of this period has
not yet started, the value will be the starting position in this period minus the duration
of any media in previous periods still to be played.MediaPeriod.getNextLoadPositionUs()
will return a
different value than prior to the call. False otherwise.public void onPrepared(MediaPeriod mediaPeriod)
MediaPeriod.Callback
Called on the playback thread. After invoking this method, the MediaPeriod
can
expect for MediaPeriod.selectTracks(TrackSelection[], boolean[], SampleStream[], boolean[],
long)
to be called with the initial track selection.
onPrepared
in interface MediaPeriod.Callback
mediaPeriod
- The prepared MediaPeriod
.public void onContinueLoadingRequested(MediaPeriod source)
SequenceableLoader.Callback
SequenceableLoader.continueLoading(long)
method
to be called when it can continue to load data. Called on the playback thread.onContinueLoadingRequested
in interface SequenceableLoader.Callback<MediaPeriod>