FakeMediaPeriod

Artifact: androidx.media3:media3-test-utils

Kotlin |Java

@UnstableApi
public class FakeMediaPeriod implements MediaPeriod

Fake MediaPeriod that provides tracks from the given TrackGroupArray.

Summary

Nested types
`public interface FakeMediaPeriod.TrackDataFactory` A factory to create the test data for a particular track.

Public constructors
`FakeMediaPeriod( TrackGroupArray trackGroupArray, Allocator allocator, long singleSampleTimeUs, MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher )` Constructs a FakeMediaPeriod with a single sample for each track in `trackGroupArray`.
`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 in `trackGroupArray`.
`FakeMediaPeriod( TrackGroupArray trackGroupArray, Allocator allocator, FakeMediaPeriod.TrackDataFactory trackDataFactory, MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher, DrmSessionManager drmSessionManager, DrmSessionEventListener.EventDispatcher drmEventDispatcher, boolean deferOnPrepared )` Constructs a FakeMediaPeriod.
`FakeMediaPeriod( TrackGroupArray trackGroupArray, Allocator allocator, FakeMediaPeriod.TrackDataFactory trackDataFactory, @Nullable long[] syncSampleTimestampsUs, MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher, DrmSessionManager drmSessionManager, DrmSessionEventListener.EventDispatcher drmEventDispatcher, boolean deferOnPrepared )` Constructs a FakeMediaPeriod.

Public methods
`boolean`	`continueLoading(LoadingInfo loadingInfo)` 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 `TIME_END_OF_SOURCE` if loading has finished.
`TrackGroupArray`	`getTrackGroups()` Returns the `TrackGroup`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.
`synchronized 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 to `readDiscontinuity`.
`synchronized void`	`setPreparationComplete()` Allows the fake media period to complete preparation.
`void`	`setSeekToUsOffset(long seekOffsetUs)` Sets an offset to be applied to positions returned by `seekToUs`.
`void`	`setUsesStreamPrerollFlags()` Notifies the media period that the player will use `getFlags` to check if streams contain initial discontinuities at the start of the period rather than using `readDiscontinuity`.

Protected methods
`FakeSampleStream`	`createSampleStream( Allocator allocator, @Nullable MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher, DrmSessionManager drmSessionManager, DrmSessionEventListener.EventDispatcher drmEventDispatcher, Format initialFormat, List<FakeSampleStream.FakeSampleStreamItem> fakeSampleStreamItems )` Creates a new `FakeSampleStream`.

Inherited methods

From androidx.media3.exoplayer.source.MediaPeriod

`List<StreamKey>`	`getStreamKeys(List<ExoTrackSelection> trackSelections)` Returns a list of `StreamKeys` which allow to filter the media in this period to load only the parts needed to play the provided `TrackSelections`.
`long`	`setEndPositionUs(long endPositionUs)` Sets the end position at which the period stops loading and providing samples.

Public constructors

FakeMediaPeriod

public FakeMediaPeriod(
    TrackGroupArray trackGroupArray,
    Allocator allocator,
    long singleSampleTimeUs,
    MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher
)

Constructs a FakeMediaPeriod with a single sample for each track in trackGroupArray.

Parameters
`TrackGroupArray trackGroupArray`	The track group array.
`Allocator allocator`	An `Allocator`.
`long singleSampleTimeUs`	The timestamp to use for the single sample in each track, in microseconds.
`MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher`	A dispatcher for `MediaSourceEventListener` 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 in trackGroupArray.

Parameters
`TrackGroupArray trackGroupArray`	The track group array.
`Allocator allocator`	An `Allocator`.
`long singleSampleTimeUs`	The timestamp to use for the single sample in each track, in microseconds.
`MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher`	A dispatcher for `MediaSourceEventListener` events.
`DrmSessionManager drmSessionManager`	The `DrmSessionManager` used for DRM interactions.
`DrmSessionEventListener.EventDispatcher drmEventDispatcher`	A dispatcher for `DrmSessionEventListener` events.
`boolean deferOnPrepared`	Whether `onPrepared` should be called only after `setPreparationComplete` has been called. If `false` 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 trackGroupArray`	The track group array.
`Allocator allocator`	An `Allocator`.
`FakeMediaPeriod.TrackDataFactory trackDataFactory`	The `TrackDataFactory` creating the data.
`MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher`	A dispatcher for media source events.
`DrmSessionManager drmSessionManager`	The `DrmSessionManager` used for DRM interactions.
`DrmSessionEventListener.EventDispatcher drmEventDispatcher`	A dispatcher for `DrmSessionEventListener` events.
`boolean deferOnPrepared`	Whether `onPrepared` should be called only after `setPreparationComplete` has been called. If `false` preparation completes immediately.

FakeMediaPeriod

public FakeMediaPeriod(
    TrackGroupArray trackGroupArray,
    Allocator allocator,
    FakeMediaPeriod.TrackDataFactory trackDataFactory,
    @Nullable long[] syncSampleTimestampsUs,
    MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher,
    DrmSessionManager drmSessionManager,
    DrmSessionEventListener.EventDispatcher drmEventDispatcher,
    boolean deferOnPrepared
)

Constructs a FakeMediaPeriod.

Parameters
`TrackGroupArray trackGroupArray`	The track group array.
`Allocator allocator`	An `Allocator`.
`FakeMediaPeriod.TrackDataFactory trackDataFactory`	The `TrackDataFactory` creating the data.
`@Nullable long[] syncSampleTimestampsUs`	A list of timestamps of samples returned from `trackDataFactory` which are 'sync samples' for the purposes of seeking.
`MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher`	A dispatcher for media source events.
`DrmSessionManager drmSessionManager`	The `DrmSessionManager` used for DRM interactions.
`DrmSessionEventListener.EventDispatcher drmEventDispatcher`	A dispatcher for `DrmSessionEventListener` events.
`boolean deferOnPrepared`	Whether `onPrepared` should be called only after `setPreparationComplete` has been called. If `false` preparation completes immediately.

Public methods

continueLoading

public boolean continueLoading(LoadingInfo loadingInfo)

Attempts to continue loading.

This method may be called both during and after the period has been prepared.

A period may call onContinueLoadingRequested on the Callback passed to prepare 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.

Parameters
`LoadingInfo loadingInfo`	The `LoadingInfo` when attempting to continue loading.

Returns
`boolean`	True if progress was made, meaning that `getNextLoadPositionUs` will return a different value than prior to the call. False otherwise.

discardBuffer

public void discardBuffer(long positionUs, boolean toKeyframe)

Discards buffered media up to the specified position.

This method is only called after the period has been prepared.

Parameters
`long positionUs`	The position in microseconds.
`boolean 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.

getAdjustedSeekPositionUs

public long getAdjustedSeekPositionUs(
    long positionUs,
    SeekParameters seekParameters
)

Returns the position to which a seek will be performed, given the specified seek position and SeekParameters.

This method is only called after the period has been prepared.

Parameters
`long positionUs`	The seek position in microseconds.
`SeekParameters seekParameters`	Parameters that control how the seek is performed. Implementations may apply seek parameters on a best effort basis.

Returns
`long`	The actual position to which a seek will be performed, in microseconds.

getBufferedPositionUs

public long getBufferedPositionUs()

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.

Returns
`long`	An estimate of the absolute position in microseconds up to which data is buffered, or `TIME_END_OF_SOURCE` if the track is fully buffered.

getNextLoadPositionUs

public long getNextLoadPositionUs()

Returns the next load time, or 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.

getTrackGroups

public TrackGroupArray getTrackGroups()

Returns the TrackGroups exposed by the period.

This method is only called after the period has been prepared.

Returns
`TrackGroupArray`	The `TrackGroup`s.

isLoading

public boolean isLoading()

Returns whether the media period is currently loading.

maybeThrowPrepareError

public void maybeThrowPrepareError()

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.

Throws
`java.io.IOException`	The underlying error.

prepare

synchronized public void prepare(MediaPeriod.Callback callback, long positionUs)

Prepares this media period asynchronously.

callback.onPrepared is called when preparation completes. If preparation fails, maybeThrowPrepareError will throw an IOException.

If preparation succeeds and results in a source timeline change (e.g. the period duration becoming known), onSourceInfoRefreshed will be called before callback.onPrepared.

Parameters
`MediaPeriod.Callback callback`	Callback to receive updates from this period, including being notified when preparation completes.
`long positionUs`	The expected starting position, in microseconds.

readDiscontinuity

public long readDiscontinuity()

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 TIME_UNSET, all SampleStreams provided by the period are guaranteed to start from a key frame.

This method is only called after the period has been prepared.

Returns
`long`	The playback position after the discontinuity, in microseconds, or `TIME_UNSET` if there is no discontinuity.

reevaluateBuffer

public void reevaluateBuffer(long positionUs)

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.

Parameters
`long 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.

release

public void release()

Releases the media period.

seekToUs

public long seekToUs(long positionUs)

Attempts to seek to the specified position in microseconds.

After this method has been called, all SampleStreams provided by the period are guaranteed to start from a key frame.

This method is only called when at least one track is selected.

Parameters
`long positionUs`	The seek position in microseconds.

Returns
`long`	The actual position to which the period was seeked, in microseconds.

selectTracks

public long selectTracks(
    @NullableType ExoTrackSelection[] selections,
    boolean[] mayRetainStreamFlags,
    @NullableType SampleStream[] streams,
    boolean[] streamResetFlags,
    long positionUs
)

Performs a track selection.

The call receives track selections for each renderer, mayRetainStreamFlags indicating whether the existing SampleStream can be retained for each selection, and the existing streams 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.

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.

Parameters
`@NullableType ExoTrackSelection[] selections`	The renderer track selections.
`boolean[] mayRetainStreamFlags`	Flags indicating whether the existing sample stream can be retained for each track selection. A `true` 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.
`@NullableType SampleStream[] streams`	The existing sample streams, which will be updated to reflect the provided selections.
`boolean[] 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.
`long positionUs`	The current playback position in microseconds. If playback of this period has not yet started, the value will be the starting position.

Returns
`long`	The actual position at which the tracks were enabled, in microseconds.

setDiscontinuityPositionUs

public void setDiscontinuityPositionUs(long discontinuityPositionUs)

Sets a discontinuity position to be returned from the next call to readDiscontinuity.

Parameters
`long discontinuityPositionUs`	The position to be returned, in microseconds.

setPreparationComplete

synchronized 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 by seekToUs.

Parameters
`long seekOffsetUs`	The offset to be applied, in microseconds.

setUsesStreamPrerollFlags

public void setUsesStreamPrerollFlags()

Notifies the media period that the player will use getFlags to check if streams contain initial discontinuities at the start of the period rather than using readDiscontinuity.

If invoked then readDiscontinuity should only report discontinuities that occur during playback, not any initial discontinuities at the start of the period.

Protected methods

createSampleStream

protected FakeSampleStream createSampleStream(
    Allocator allocator,
    @Nullable MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher,
    DrmSessionManager drmSessionManager,
    DrmSessionEventListener.EventDispatcher drmEventDispatcher,
    Format initialFormat,
    List<FakeSampleStream.FakeSampleStreamItem> fakeSampleStreamItems
)

Creates a new FakeSampleStream.

Parameters
`Allocator allocator`	An `Allocator` from which to obtain media buffer allocations.
`@Nullable MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher`	A `MediaSourceEventListener.EventDispatcher` to notify of media events.
`DrmSessionManager drmSessionManager`	A `DrmSessionManager` for DRM interactions.
`DrmSessionEventListener.EventDispatcher drmEventDispatcher`	A `DrmSessionEventListener.EventDispatcher` to notify of DRM events.
`Format initialFormat`	The first `Format` to output.
`List<FakeSampleStream.FakeSampleStreamItem> fakeSampleStreamItems`	The `items` to output.

Returns
`FakeSampleStream`	A new `FakeSampleStream`.

FakeMediaPeriod

Summary

Nested types

Public constructors

Public methods

Protected methods

Inherited methods

Public constructors

FakeMediaPeriod

FakeMediaPeriod

FakeMediaPeriod

FakeMediaPeriod

Public methods

continueLoading

discardBuffer

getAdjustedSeekPositionUs

getBufferedPositionUs

getNextLoadPositionUs

getTrackGroups

isLoading

maybeThrowPrepareError

prepare

readDiscontinuity

reevaluateBuffer

release

seekToUs

selectTracks

setDiscontinuityPositionUs

setPreparationComplete

setSeekToUsOffset

setUsesStreamPrerollFlags

Protected methods

createSampleStream