SubtitleOutputBuffer

Kotlin |Java

@UnstableApi
public abstract class SubtitleOutputBuffer extends DecoderOutputBuffer implements Subtitle

java.lang.Object
↳	androidx.media3.decoder.Buffer
	↳	androidx.media3.decoder.DecoderOutputBuffer
		↳	androidx.media3.extractor.text.SubtitleOutputBuffer

Base class for SubtitleDecoder output buffers.

Summary

Public constructors
`SubtitleOutputBuffer()`

Public methods
`void`	`clear()` Clears the buffer.
`List<Cue>`	`getCues(long timeUs)` Retrieve the cues that should be displayed at a given time.
`long`	`getEventTime(int index)` Returns the event time at a specified index.
`int`	`getEventTimeCount()` Returns the number of event times, where events are defined as points in time at which the cues returned by `getCues` changes.
`int`	`getNextEventTimeIndex(long timeUs)` Returns the index of the first event that occurs after a given time (exclusive).
`void`	`setContent(long timeUs, Subtitle subtitle, long subsampleOffsetUs)` Sets the content of the output buffer, consisting of a `Subtitle` and associated metadata.

`boolean`	`shouldBeSkipped` Whether this buffer should be skipped, usually because the decoding process generated no data or invalid data.
`int`	`skippedOutputBufferCount` The number of buffers immediately prior to this one that were skipped in the `Decoder`.
`long`	`timeUs` The presentation timestamp for the buffer, in microseconds.

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

abstract void

release()

Releases the output buffer for reuse.

public SubtitleOutputBuffer()

public void clear()

Clears the buffer.

public List<Cue> getCues(long timeUs)

Retrieve the cues that should be displayed at a given time.

Parameters
`long timeUs`	The time in microseconds.

Returns
`List<Cue>`	A list of cues that should be displayed, possibly empty.

public long getEventTime(int index)

Returns the event time at a specified index.

Parameters
`int index`	The index of the event time to obtain.

Returns
`long`	The event time in microseconds.

public int getEventTimeCount()

Returns the number of event times, where events are defined as points in time at which the cues returned by getCues changes.

Returns
`int`	The number of event times.

public int getNextEventTimeIndex(long timeUs)

Returns the index of the first event that occurs after a given time (exclusive).

Parameters
`long timeUs`	The time in microseconds.

Returns
`int`	The index of the next event, or `INDEX_UNSET` if there are no events after the specified time.

public void setContent(long timeUs, Subtitle subtitle, long subsampleOffsetUs)

Sets the content of the output buffer, consisting of a Subtitle and associated metadata.

Parameters
`long timeUs`	The time of the start of the subtitle in microseconds.
`Subtitle subtitle`	The subtitle.
`long subsampleOffsetUs`	An offset that must be added to the subtitle's event times, or `OFFSET_SAMPLE_RELATIVE` if `timeUs` should be added.