SampleStream

const val FLAG_OMIT_SAMPLE_DATA = 4: Int

Specifies that data, supplementalData and cryptoInfo should not be populated when reading a sample buffer.

This flag is useful for efficiently reading or (when combined with FLAG_PEEK) peeking sample metadata. It can also be used for efficiency by a caller wishing to skip a sample buffer.

const val FLAG_PEEK = 1: Int

Specifies that the read position should not be advanced if a sample buffer is read.

const val FLAG_REQUIRE_FORMAT = 2: Int

Specifies that if a sample buffer would normally be read next, the format of the stream should be read instead. In detail, the effect of this flag is as follows:

• If a sample buffer would be read were the flag not set, then the stream format will be read instead.
• If nothing would be read were the flag not set, then the stream format will be read if it's known. If the stream format is not known then behavior is unchanged.
• If an end of stream buffer would be read were the flag not set, then behavior is unchanged.

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.

fun maybeThrowError(): Unit

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

@SampleStream.ReadDataResult
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.

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.