Class FakeMediaPeriod
- java.lang.Object
-
- com.google.android.exoplayer2.testutil.FakeMediaPeriod
-
- All Implemented Interfaces:
MediaPeriod
,SequenceableLoader
public class FakeMediaPeriod extends Object implements MediaPeriod
FakeMediaPeriod
that provides tracks from the givenTrackGroupArray
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
FakeMediaPeriod.TrackDataFactory
A factory to create the test data for a particular track.-
Nested classes/interfaces inherited from interface com.google.android.exoplayer2.source.MediaPeriod
MediaPeriod.Callback
-
-
Constructor Summary
Constructors Constructor Description FakeMediaPeriod(TrackGroupArray trackGroupArray, Allocator allocator, long singleSampleTimeUs, MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher)
Constructs a FakeMediaPeriod with a single sample for each track intrackGroupArray
.FakeMediaPeriod(TrackGroupArray trackGroupArray, Allocator allocator, long singleSampleTimeUs, MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher, DrmSessionManager drmSessionManager, DrmSessionEventListener.EventDispatcher drmEventDispatcher, boolean deferOnPrepared)
Constructs a FakeMediaPeriod with a single sample for each track intrackGroupArray
.FakeMediaPeriod(TrackGroupArray trackGroupArray, Allocator allocator, FakeMediaPeriod.TrackDataFactory trackDataFactory, MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher, DrmSessionManager drmSessionManager, DrmSessionEventListener.EventDispatcher drmEventDispatcher, boolean deferOnPrepared)
Constructs a FakeMediaPeriod.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
continueLoading(long positionUs)
Attempts to continue loading.protected FakeSampleStream
createSampleStream(Allocator allocator, MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher, DrmSessionManager drmSessionManager, DrmSessionEventListener.EventDispatcher drmEventDispatcher, Format initialFormat, List<FakeSampleStream.FakeSampleStreamItem> fakeSampleStreamItems)
Creates a newFakeSampleStream
.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 andSeekParameters
.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, orC.TIME_END_OF_SOURCE
if loading has finished.TrackGroupArray
getTrackGroups()
Returns theTrackGroup
s exposed by the period.boolean
isLoading()
Returns whether the media period is currently loading.void
maybeThrowPrepareError()
Throws an error that's preventing the period from becoming prepared.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.void
release()
Releases the media period.long
seekToUs(long positionUs)
Attempts to seek to the specified position in microseconds.long
selectTracks(@NullableType ExoTrackSelection[] selections, boolean[] mayRetainStreamFlags, @NullableType SampleStream[] streams, boolean[] streamResetFlags, long positionUs)
Performs a track selection.void
setDiscontinuityPositionUs(long discontinuityPositionUs)
Sets a discontinuity position to be returned from the next call toreadDiscontinuity()
.void
setPreparationComplete()
Allows the fake media period to complete preparation.void
setSeekToUsOffset(long seekOffsetUs)
Sets an offset to be applied to positions returned byseekToUs(long)
.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.google.android.exoplayer2.source.MediaPeriod
getStreamKeys
-
-
-
-
Constructor Detail
-
FakeMediaPeriod
public FakeMediaPeriod(TrackGroupArray trackGroupArray, Allocator allocator, long singleSampleTimeUs, MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher)
Constructs a FakeMediaPeriod with a single sample for each track intrackGroupArray
.- Parameters:
trackGroupArray
- The track group array.allocator
- AnAllocator
.singleSampleTimeUs
- The timestamp to use for the single sample in each track, in microseconds.mediaSourceEventDispatcher
- A dispatcher forMediaSourceEventListener
events.
-
FakeMediaPeriod
public FakeMediaPeriod(TrackGroupArray trackGroupArray, Allocator allocator, long singleSampleTimeUs, MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher, DrmSessionManager drmSessionManager, DrmSessionEventListener.EventDispatcher drmEventDispatcher, boolean deferOnPrepared)
Constructs a FakeMediaPeriod with a single sample for each track intrackGroupArray
.- Parameters:
trackGroupArray
- The track group array.allocator
- AnAllocator
.singleSampleTimeUs
- The timestamp to use for the single sample in each track, in microseconds.mediaSourceEventDispatcher
- A dispatcher forMediaSourceEventListener
events.drmSessionManager
- TheDrmSessionManager
used for DRM interactions.drmEventDispatcher
- A dispatcher forDrmSessionEventListener
events.deferOnPrepared
- WhetherMediaPeriod.Callback.onPrepared(MediaPeriod)
should be called only aftersetPreparationComplete()
has been called. Iffalse
preparation completes immediately.
-
FakeMediaPeriod
public FakeMediaPeriod(TrackGroupArray trackGroupArray, Allocator allocator, FakeMediaPeriod.TrackDataFactory trackDataFactory, MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher, DrmSessionManager drmSessionManager, DrmSessionEventListener.EventDispatcher drmEventDispatcher, boolean deferOnPrepared)
Constructs a FakeMediaPeriod.- Parameters:
trackGroupArray
- The track group array.allocator
- AnAllocator
.trackDataFactory
- TheFakeMediaPeriod.TrackDataFactory
creating the data.mediaSourceEventDispatcher
- A dispatcher for media source events.drmSessionManager
- TheDrmSessionManager
used for DRM interactions.drmEventDispatcher
- A dispatcher forDrmSessionEventListener
events.deferOnPrepared
- WhetherMediaPeriod.Callback.onPrepared(MediaPeriod)
should be called only aftersetPreparationComplete()
has been called. Iffalse
preparation completes immediately.
-
-
Method Detail
-
setDiscontinuityPositionUs
public void setDiscontinuityPositionUs(long discontinuityPositionUs)
Sets a discontinuity position to be returned from the next call toreadDiscontinuity()
.- Parameters:
discontinuityPositionUs
- The position to be returned, in microseconds.
-
setPreparationComplete
public void setPreparationComplete()
Allows the fake media period to complete preparation. May be called on any thread.
-
setSeekToUsOffset
public void setSeekToUsOffset(long seekOffsetUs)
Sets an offset to be applied to positions returned byseekToUs(long)
.- Parameters:
seekOffsetUs
- The offset to be applied, in microseconds.
-
release
public void release()
Releases the media period.
-
prepare
public void prepare(MediaPeriod.Callback callback, long positionUs)
Description copied from interface:MediaPeriod
Prepares this media period asynchronously.callback.onPrepared
is called when preparation completes. If preparation fails,MediaPeriod.maybeThrowPrepareError()
will throw anIOException
.If preparation succeeds and results in a source timeline change (e.g. the period duration becoming known),
MediaSource.MediaSourceCaller.onSourceInfoRefreshed(MediaSource, Timeline)
will be called beforecallback.onPrepared
.- Specified by:
prepare
in interfaceMediaPeriod
- Parameters:
callback
- Callback to receive updates from this period, including being notified when preparation completes.positionUs
- The expected starting position, in microseconds.
-
maybeThrowPrepareError
public void maybeThrowPrepareError() throws IOException
Description copied from interface:MediaPeriod
Throws an error that's preventing the period from becoming prepared. Does nothing if no such error exists.This method is only called before the period has completed preparation.
- Specified by:
maybeThrowPrepareError
in interfaceMediaPeriod
- Throws:
IOException
- The underlying error.
-
getTrackGroups
public TrackGroupArray getTrackGroups()
Description copied from interface:MediaPeriod
Returns theTrackGroup
s exposed by the period.This method is only called after the period has been prepared.
- Specified by:
getTrackGroups
in interfaceMediaPeriod
- Returns:
- The
TrackGroup
s.
-
selectTracks
public long selectTracks(@NullableType ExoTrackSelection[] selections, boolean[] mayRetainStreamFlags, @NullableType SampleStream[] streams, boolean[] streamResetFlags, long positionUs)
Description copied from interface:MediaPeriod
Performs a track selection.The call receives track
selections
for each renderer,mayRetainStreamFlags
indicating whether the existingSampleStream
can be retained for each selection, and the existingstream
s themselves. The call will updatestreams
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 instreamResetFlags
will be set to true. This flag will also be set if a new sample stream is created.Note that previously passed
TrackSelections
are no longer valid, and any references to them must be updated to point to the new selections.This method is only called after the period has been prepared.
- Specified by:
selectTracks
in interfaceMediaPeriod
- Parameters:
selections
- The renderer track selections.mayRetainStreamFlags
- Flags indicating whether the existing sample stream can be retained for each track selection. Atrue
value indicates that the selection is equivalent to the one that was previously passed, and that the caller does not require that the sample stream be recreated. If a retained sample stream holds any references to the track selection then they must be updated to point to the new selection.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.- Returns:
- The actual position at which the tracks were enabled, in microseconds.
-
discardBuffer
public void discardBuffer(long positionUs, boolean toKeyframe)
Description copied from interface:MediaPeriod
Discards buffered media up to the specified position.This method is only called after the period has been prepared.
- Specified by:
discardBuffer
in interfaceMediaPeriod
- Parameters:
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.
-
reevaluateBuffer
public void reevaluateBuffer(long positionUs)
Description copied from interface:MediaPeriod
Re-evaluates the buffer given the playback position.This method is only called after the period has been prepared.
A period may choose to discard buffered media or cancel ongoing loads so that media can be re-buffered in a different quality.
- Specified by:
reevaluateBuffer
in interfaceMediaPeriod
- Specified by:
reevaluateBuffer
in interfaceSequenceableLoader
- Parameters:
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.
-
readDiscontinuity
public long readDiscontinuity()
Description copied from interface:MediaPeriod
Attempts to read a discontinuity.A discontinuity implies that the provided
SampleStreams
will start from a new playback position and any output pipelines need to be reset. This happens for example if the streams provide decode-only samples before the intended playback start position that need to be dropped.After this method has returned a value other than
C.TIME_UNSET
, allSampleStreams
provided by the period are guaranteed to start from a key frame.This method is only called after the period has been prepared.
- Specified by:
readDiscontinuity
in interfaceMediaPeriod
- Returns:
- The playback position after the discontinuity, in microseconds, or
C.TIME_UNSET
if there is no discontinuity.
-
getBufferedPositionUs
public long getBufferedPositionUs()
Description copied from interface:MediaPeriod
Returns an estimate of the position up to which data is buffered for the enabled tracks.This method is only called when at least one track is selected.
- Specified by:
getBufferedPositionUs
in interfaceMediaPeriod
- Specified by:
getBufferedPositionUs
in interfaceSequenceableLoader
- Returns:
- An estimate of the absolute position in microseconds up to which data is buffered, or
C.TIME_END_OF_SOURCE
if the track is fully buffered.
-
seekToUs
public long seekToUs(long positionUs)
Description copied from interface:MediaPeriod
Attempts to seek to the specified position in microseconds.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.
- Specified by:
seekToUs
in interfaceMediaPeriod
- Parameters:
positionUs
- The seek position in microseconds.- Returns:
- The actual position to which the period was seeked, in microseconds.
-
getAdjustedSeekPositionUs
public long getAdjustedSeekPositionUs(long positionUs, SeekParameters seekParameters)
Description copied from interface:MediaPeriod
Returns the position to which a seek will be performed, given the specified seek position andSeekParameters
.This method is only called after the period has been prepared.
- Specified by:
getAdjustedSeekPositionUs
in interfaceMediaPeriod
- Parameters:
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.- Returns:
- The actual position to which a seek will be performed, in microseconds.
-
getNextLoadPositionUs
public long getNextLoadPositionUs()
Description copied from interface:MediaPeriod
Returns the next load time, orC.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.
- Specified by:
getNextLoadPositionUs
in interfaceMediaPeriod
- Specified by:
getNextLoadPositionUs
in interfaceSequenceableLoader
-
continueLoading
public boolean continueLoading(long positionUs)
Description copied from interface:MediaPeriod
Attempts to continue loading.This method may be called both during and after the period has been prepared.
A period may call
SequenceableLoader.Callback.onContinueLoadingRequested(SequenceableLoader)
on theMediaPeriod.Callback
passed toMediaPeriod.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.- Specified by:
continueLoading
in interfaceMediaPeriod
- Specified by:
continueLoading
in interfaceSequenceableLoader
- Parameters:
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.- Returns:
- True if progress was made, meaning that
MediaPeriod.getNextLoadPositionUs()
will return a different value than prior to the call. False otherwise.
-
isLoading
public boolean isLoading()
Description copied from interface:MediaPeriod
Returns whether the media period is currently loading.- Specified by:
isLoading
in interfaceMediaPeriod
- Specified by:
isLoading
in interfaceSequenceableLoader
-
createSampleStream
protected FakeSampleStream createSampleStream(Allocator allocator, @Nullable MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher, DrmSessionManager drmSessionManager, DrmSessionEventListener.EventDispatcher drmEventDispatcher, Format initialFormat, List<FakeSampleStream.FakeSampleStreamItem> fakeSampleStreamItems)
Creates a newFakeSampleStream
.- Parameters:
allocator
- AnAllocator
from which to obtain media buffer allocations.mediaSourceEventDispatcher
- AMediaSourceEventListener.EventDispatcher
to notify of media events.drmSessionManager
- ADrmSessionManager
for DRM interactions.drmEventDispatcher
- ADrmSessionEventListener.EventDispatcher
to notify of DRM events.initialFormat
- The firstFormat
to output.fakeSampleStreamItems
- Theitems
to output.- Returns:
- A new
FakeSampleStream
.
-
-