MaskingMediaPeriod

MaskingMediaPeriod(
    id: MediaSource.MediaPeriodId!,
    allocator: Allocator!,
    preparePositionUs: Long
)

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

fun continueLoading(loadingInfo: LoadingInfo!): Boolean

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.

fun createPeriod(id: MediaSource.MediaPeriodId!): Unit

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

fun discardBuffer(positionUs: Long, toKeyframe: Boolean): Unit

Discards buffered media up to the specified position.

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

fun getAdjustedSeekPositionUs(
    positionUs: Long,
    seekParameters: SeekParameters!
): Long

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.

fun getBufferedPositionUs(): Long

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.

fun getNextLoadPositionUs(): Long

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.

fun getTrackGroups(): TrackGroupArray!

Returns the TrackGroups exposed by the period.

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

fun isLoading(): Boolean

Returns whether the media period is currently loading.

fun maybeThrowPrepareError(): Unit

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.

fun onContinueLoadingRequested(source: MediaPeriod!): Unit

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.

fun onPrepared(mediaPeriod: MediaPeriod!): Unit

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.

fun overridePreparePositionUs(preparePositionUs: Long): Unit

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

fun prepare(callback: MediaPeriod.Callback!, positionUs: Long): Unit

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.

fun readDiscontinuity(): Long

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.

fun reevaluateBuffer(positionUs: Long): Unit

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.

fun releasePeriod(): Unit

Releases the period.

fun seekToUs(positionUs: Long): Long

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.

fun selectTracks(
    @NullableType selections: Array<@NullableType ExoTrackSelection!>!,
    mayRetainStreamFlags: BooleanArray!,
    @NullableType streams: Array<@NullableType SampleStream!>!,
    streamResetFlags: BooleanArray!,
    positionUs: Long
): Long

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.

fun setMediaSource(mediaSource: MediaSource!): Unit

Sets the MediaSource that will create the underlying media period.

fun setPrepareListener(listener: MaskingMediaPeriod.PrepareListener!): Unit

Sets a listener for preparation events.

val id: MediaSource.MediaPeriodId!

The MediaPeriodId used to create the masking media period.