EmptySampleStream

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
class EmptySampleStream : SampleStream

An empty SampleStream.

Summary

Public constructors
`EmptySampleStream()`

Public functions
`Boolean`	`isReady()` Returns whether data is available to be read.
`Unit`	`maybeThrowError()` Throws an error that's preventing data from being read.
`Int`	`readData( formatHolder: FormatHolder!, buffer: DecoderInputBuffer!, @SampleStream.ReadFlags readFlags: Int )` Attempts to read from the stream.
`Int`	`skipData(positionUs: Long)` Attempts to skip to the keyframe before the specified position, or to the end of the stream if `positionUs` is beyond it.

Inherited Constants

From androidx.media3.exoplayer.source.SampleStream

`const Int`	`FLAG_HAS_PREROLL = 4` Specifies that the stream contains a preroll of decode-only samples.
`const Int`	`FLAG_MAYBE_HAS_PREROLL = 2` Specifies that the stream may contain preroll samples.
`const Int`	`FLAG_OMIT_SAMPLE_DATA = 4` Specifies that `data`, `supplementalData` and `cryptoInfo` should not be populated when reading a sample buffer.
`const Int`	`FLAG_PEEK = 1` Specifies that the read position should not be advanced if a sample buffer is read.
`const Int`	`FLAG_REQUIRE_FORMAT = 2` Specifies that if a sample buffer would normally be read next, the format of the stream should be read instead.
`const Int`	`FLAG_STRICT_DURATION = 1` Specifies that playout of the stream should be stopped once the duration is reached.

Inherited functions

From androidx.media3.exoplayer.source.SampleStream

Int

@SampleStream.Flags
getFlags()

Returns the Flags set on this stream.

Public constructors

EmptySampleStream

EmptySampleStream()

Public functions

isReady

fun isReady(): Boolean

Returns whether data is available to be read.

Note: If the stream has ended then a buffer with the end of stream flag can always be read from readData. Hence an ended stream is always ready.

Returns
`Boolean`	Whether data is available to be read.

maybeThrowError

fun maybeThrowError(): Unit

Throws an error that's preventing data from being read. Does nothing if no such error exists.

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

readData

fun readData(
    formatHolder: FormatHolder!,
    buffer: DecoderInputBuffer!,
    @SampleStream.ReadFlags readFlags: Int
): Int

Attempts to read from the stream.

If the stream has ended then BUFFER_FLAG_END_OF_STREAM flag is set on buffer and RESULT_BUFFER_READ is returned. Else if no data is available then RESULT_NOTHING_READ is returned. Else if the format of the media is changing or if formatRequired is set then formatHolder is populated and RESULT_FORMAT_READ is returned. Else buffer is populated and RESULT_BUFFER_READ is returned.

Parameters
`formatHolder: FormatHolder!`	A `FormatHolder` to populate in the case of reading a format.
`buffer: DecoderInputBuffer!`	A `DecoderInputBuffer` to populate in the case of reading a sample or the end of the stream. If the end of the stream has been reached, the `BUFFER_FLAG_END_OF_STREAM` flag will be set on the buffer.
`@SampleStream.ReadFlags readFlags: Int`	Flags controlling the behavior of this read operation.

Returns
`Int`	The `result` of the read operation.

Throws
`androidx.media3.decoder.DecoderInputBuffer.InsufficientCapacityException`	If the `buffer` has insufficient capacity to hold the data of a sample being read. The buffer `timestamp` and flags are populated if this exception is thrown, but the read position is not advanced.

skipData

fun skipData(positionUs: Long): Int

Attempts to skip to the keyframe before the specified position, or to the end of the stream if positionUs is beyond it.

Parameters
`positionUs: Long`	The specified time.

Returns
`Int`	The number of samples that were skipped.