Back to Exoplayer

SubtitleOutputBuffer (ExoPlayer library)

docs/doc/reference/com/google/android/exoplayer2/text/SubtitleOutputBuffer.html

latest6.5 KB
Original Source

Package com.google.android.exoplayer2.text

Class SubtitleOutputBuffer


[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public abstract classSubtitleOutputBufferextends[DecoderOutputBuffer](../decoder/DecoderOutputBuffer.html "class in com.google.android.exoplayer2.decoder")implements[Subtitle](Subtitle.html "interface in com.google.android.exoplayer2.text")

Deprecated. com.google.android.exoplayer2 is deprecated. Please migrate to androidx.media3 (which contains the same ExoPlayer code). See the migration guide for more details, including a script to help with the migration.

Base class for SubtitleDecoder output buffers.

Nested Class Summary

- 

Nested classes/interfaces inherited from class com.google.android.exoplayer2.decoder.DecoderOutputBuffer

DecoderOutputBuffer.Owner<S extends DecoderOutputBuffer>

Field Summary

- 

Fields inherited from class com.google.android.exoplayer2.decoder.DecoderOutputBuffer

skippedOutputBufferCount, timeUs

Constructor Summary

Constructors | Constructor | Description | | --- | --- | | SubtitleOutputBuffer() | Deprecated. |

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods | Modifier and Type | Method | Description | | --- | --- | --- | | void | clear() | Deprecated.

Clears the buffer. | | List<Cue> | getCues​(long timeUs) | Deprecated.

Retrieve the cues that should be displayed at a given time. | | long | getEventTime​(int index) | Deprecated.

Returns the event time at a specified index. | | int | getEventTimeCount() | Deprecated.

Returns the number of event times, where events are defined as points in time at which the cues returned by Subtitle.getCues(long) changes. | | int | getNextEventTimeIndex​(long timeUs) | Deprecated.

Returns the index of the first event that occurs after a given time (exclusive). | | void | setContent​(long timeUs, Subtitle subtitle, long subsampleOffsetUs) | Deprecated.

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

- 

Methods inherited from class com.google.android.exoplayer2.decoder.DecoderOutputBuffer

release

- 

Methods inherited from class com.google.android.exoplayer2.decoder.Buffer

addFlag, clearFlag, getFlag, hasSupplementalData, isDecodeOnly, isEndOfStream, isFirstSample, isKeyFrame, isLastSample, setFlags

- 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

- 

SubtitleOutputBuffer

public SubtitleOutputBuffer()

Deprecated.

Method Detail

- 

setContent

public void setContent​(long timeUs,[Subtitle](Subtitle.html "interface in com.google.android.exoplayer2.text")subtitle,
                       long subsampleOffsetUs)

Deprecated.

Sets the content of the output buffer, consisting of a Subtitle and associated metadata. Parameters:timeUs - The time of the start of the subtitle in microseconds.subtitle - The subtitle.subsampleOffsetUs - An offset that must be added to the subtitle's event times, or Format.OFFSET_SAMPLE_RELATIVE if timeUs should be added.

- 

getEventTimeCount

public int getEventTimeCount()

Deprecated.

Description copied from interface: Subtitle

Returns the number of event times, where events are defined as points in time at which the cues returned by Subtitle.getCues(long) changes. Specified by:getEventTimeCount in interface SubtitleReturns:The number of event times.

- 

getEventTime

public long getEventTime​(int index)

Deprecated.

Description copied from interface: Subtitle

Returns the event time at a specified index. Specified by:getEventTime in interface SubtitleParameters:index - The index of the event time to obtain.Returns:The event time in microseconds.

- 

getNextEventTimeIndex

public int getNextEventTimeIndex​(long timeUs)

Deprecated.

Description copied from interface: Subtitle

Returns the index of the first event that occurs after a given time (exclusive). Specified by:getNextEventTimeIndex in interface SubtitleParameters:timeUs - The time in microseconds.Returns:The index of the next event, or C.INDEX_UNSET if there are no events after the specified time.

- 

getCues

public[List](https://developer.android.com/reference/java/util/List.html "class or interface in java.util")<[Cue](Cue.html "class in com.google.android.exoplayer2.text")> getCues​(long timeUs)

Deprecated.

Description copied from interface: Subtitle

Retrieve the cues that should be displayed at a given time. Specified by:getCues in interface SubtitleParameters:timeUs - The time in microseconds.Returns:A list of cues that should be displayed, possibly empty.

- 

clear

public void clear()

Deprecated.

Description copied from class: Buffer

Clears the buffer. Overrides:clear in class Buffer