MaskingMediaPeriod

public final MediaSource.MediaPeriodId id

The MediaPeriodId used to create the masking media period.

public MaskingMediaPeriod(
    MediaSource.MediaPeriodId id,
    Allocator allocator,
    long preparePositionUs
)

Creates a new masking media period. The media source must be set via setMediaSource before preparation can start.

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.

public void createPeriod(MediaSource.MediaPeriodId id)

Calls createPeriod on the wrapped source then prepares it if prepare has been called. Call releasePeriod to release the period.

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.

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.

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.

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.

public long getPreparePositionOverrideUs()

Returns the prepare position override set by overridePreparePositionUs.

public long getPreparePositionUs()

Returns the position at which the masking media period was prepared, in microseconds.

public TrackGroupArray getTrackGroups()

Returns the TrackGroups exposed by the period.

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

public boolean isLoading()

Returns whether the media period is currently loading.

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.

public void onContinueLoadingRequested(MediaPeriod source)

Called by the loader to indicate that it wishes for its continueLoading method to be called when it can continue to load data. Called on the playback thread.

public void onPrepared(MediaPeriod mediaPeriod)

Called when preparation completes.

Called on the playback thread. After invoking this method, the MediaPeriod can expect for selectTracks to be called with the initial track selection.

public void overridePreparePositionUs(long preparePositionUs)

Overrides the default prepare position at which to prepare the media period. This method must be called before createPeriod.

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.

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.

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.

public void releasePeriod()

Releases the period.

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.

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.

public void setMediaSource(MediaSource mediaSource)

Sets the MediaSource that will create the underlying media period.

public void setPrepareListener(MaskingMediaPeriod.PrepareListener listener)

Sets a listener for preparation events.