SubtitleParser
@UnstableApi
public interface SubtitleParser
DvbParser |
A |
Mp4WebvttParser |
A |
PgsParser |
A |
SsaParser |
A |
SubripParser |
A |
TtmlParser |
A |
Tx3gParser |
A |
VobsubParser |
A |
WebvttParser |
A |
Parses subtitle data into timed CuesWithTiming instances.
Instances are stateful, so samples can be fed in repeated calls to parse, and one or more complete CuesWithTiming instances will be returned when enough data has been received. Due to this stateful-ness, reset must be called after a seek or similar discontinuity in the source data.
Summary
Nested types |
|---|
public interface SubtitleParser.FactoryFactory for |
public class SubtitleParser.OutputOptionsOptions to control the output behavior of |
Public methods |
|
|---|---|
abstract int |
Returns the |
default void |
parse(Parses |
abstract void |
parse(Parses |
default Subtitle |
parseToLegacySubtitle(byte[] data, int offset, int length)Parses |
default void |
reset()Clears any data stored inside this parser from previous parse calls. |
Public methods
getCueReplacementBehavior
@Format.CueReplacementBehavior
abstract int getCueReplacementBehavior()
Returns the CueReplacementBehavior for consecutive CuesWithTiming emitted by this implementation.
A given instance must always return the same value from this method.
parse
default void parse(
byte[] data,
SubtitleParser.OutputOptions outputOptions,
Consumer<CuesWithTiming> output
)
Parses data (and any data stored from previous invocations) and emits resulting CuesWithTiming instances.
Equivalent to parse(data, 0, data.length, outputOptions, output).
parse
abstract void parse(
byte[] data,
int offset,
int length,
SubtitleParser.OutputOptions outputOptions,
Consumer<CuesWithTiming> output
)
Parses data (and any data stored from previous invocations) and emits any resulting complete CuesWithTiming instances via output.
Any samples not used from data will be persisted and used during subsequent calls to this method.
startTimeUs in an emitted instance is derived only from the provided sample data, so has to be considered together with any relevant subsampleOffsetUs. If the provided sample doesn't contain any timing information then at most one CuesWithTiming instance will be emitted, with startTimeUs set to TIME_UNSET, in which case subsampleOffsetUsmust be OFFSET_SAMPLE_RELATIVE.
| Parameters | |
|---|---|
byte[] data |
The subtitle data to parse. This must contain only complete samples. For subtitles muxed inside a media container, a sample is usually defined by the container. For subtitles read from a text file, a sample is usually the entire contents of the text file. |
int offset |
The index in |
int length |
The number of bytes to read from |
SubtitleParser.OutputOptions outputOptions |
Options to control how instances are emitted to |
Consumer<CuesWithTiming> output |
A consumer for |
parseToLegacySubtitle
default Subtitle parseToLegacySubtitle(byte[] data, int offset, int length)
Parses data to a legacy Subtitle instance.
This method only exists temporarily to support the transition away from SubtitleDecoder and Subtitle. It will be removed in a future release.
The default implementation delegates to parse. Implementations can override this to provide a more efficient implementation if desired.
| Parameters | |
|---|---|
byte[] data |
The subtitle data to parse. This must contain only complete samples. For subtitles muxed inside a media container, a sample is usually defined by the container. For subtitles read from a text file, a sample is usually the entire contents of the text file. |
int offset |
The index in |
int length |
The number of bytes to read from |
reset
default void reset()
Clears any data stored inside this parser from previous parse calls.
This must be called after a seek or other similar discontinuity in the source data.
The default implementation is a no-op.