SubtitleInputBuffer

Kotlin |Java

@UnstableApi
class SubtitleInputBuffer : DecoderInputBuffer

kotlin.Any
↳	androidx.media3.decoder.Buffer
	↳	androidx.media3.decoder.DecoderInputBuffer
		↳	androidx.media3.extractor.text.SubtitleInputBuffer

Summary

Public constructors
`SubtitleInputBuffer()`

Public properties
`Long`	`subsampleOffsetUs` An offset that must be added to the subtitle's event times after it's been decoded, or `OFFSET_SAMPLE_RELATIVE` if `timeUs` should be added.

`const Int`	`BUFFER_REPLACEMENT_MODE_DIRECT = 2` Allows buffer replacement using `allocateDirect`.
`const Int`	`BUFFER_REPLACEMENT_MODE_DISABLED = 0` Disallows buffer replacement.
`const Int`	`BUFFER_REPLACEMENT_MODE_NORMAL = 1` Allows buffer replacement using `allocate`.

`Unit`	`addFlag(@C.BufferFlags flag: Int)` Adds the `flag` to this buffer's flags.
`Unit`	`clearFlag(@C.BufferFlags flag: Int)` Removes the `flag` from this buffer's flags, if it is set.
`Boolean`	`getFlag(@C.BufferFlags flag: Int)` Returns whether the specified flag has been set on this buffer.
`Boolean`	`hasSupplementalData()` Returns whether the `BUFFER_FLAG_HAS_SUPPLEMENTAL_DATA` flag is set.
`Boolean`	`isDecodeOnly()` This function is deprecated. Check instead whether the buffer time is greater or equal to the desired start time.
`Boolean`	`isEndOfStream()` Returns whether the `BUFFER_FLAG_END_OF_STREAM` flag is set.
`Boolean`	`isFirstSample()` Returns whether the `BUFFER_FLAG_FIRST_SAMPLE` flag is set.
`Boolean`	`isKeyFrame()` Returns whether the `BUFFER_FLAG_KEY_FRAME` flag is set.
`Boolean`	`isLastSample()` Returns whether the `BUFFER_FLAG_LAST_SAMPLE` flag is set.
`Unit`	`setFlags(@C.BufferFlags flags: Int)` Replaces this buffer's flags with `flags`.

`Unit`	`clear()` Clears the buffer.
`Unit`	`@EnsuresNonNull(value = "data") ensureSpaceForWrite(length: Int)` Ensures that `data` is large enough to accommodate a write of a given length at its current position.
`Unit`	`flip()` Flips `data` and `supplementalData` in preparation for being queued to a decoder.
`Boolean`	`isEncrypted()` Returns whether the `BUFFER_FLAG_ENCRYPTED` flag is set.
`java-static DecoderInputBuffer!`	`newNoDataInstance()` Returns a new instance that's not able to hold any data.
`Unit`	`@EnsuresNonNull(value = "supplementalData") resetSupplementalData(length: Int)` Clears `supplementalData` and ensures that it's large enough to accommodate `length` bytes.

`CryptoInfo!`	`cryptoInfo` `CryptoInfo` for encrypted data.
`ByteBuffer?`	`data` The buffer's data, or `null` if no data has been set.
`Format?`	`format` The `Format`.
`ByteBuffer?`	`supplementalData` Supplemental data related to the buffer, if `hasSupplementalData` returns true.
`Long`	`timeUs` The time at which the sample should be presented.
`Boolean`	`waitingForKeys` Whether the last attempt to read a sample into this buffer failed due to not yet having the DRM keys associated with the next sample.

SubtitleInputBuffer()

val subsampleOffsetUs: Long

An offset that must be added to the subtitle's event times after it's been decoded, or OFFSET_SAMPLE_RELATIVE if timeUs should be added.