public final class WebvttExtractor extends Object implements Extractor
This extractor passes through non-empty WebVTT files untouched, however derives the correct sample timestamp for each by sniffing the X-TIMESTAMP-MAP header along with the start timestamp of the first cue header. Empty WebVTT files are not passed through, since it's not possible to derive a sample timestamp in this case.
Extractor.ReadResult
RESULT_CONTINUE, RESULT_END_OF_INPUT, RESULT_SEEK
Constructor and Description |
---|
WebvttExtractor(String language,
TimestampAdjuster timestampAdjuster) |
Modifier and Type | Method and Description |
---|---|
void |
init(ExtractorOutput output)
Initializes the extractor with an
ExtractorOutput . |
int |
read(ExtractorInput input,
PositionHolder seekPosition)
Extracts data read from a provided
ExtractorInput . |
void |
release()
Releases all kept resources.
|
void |
seek(long position,
long timeUs)
Notifies the extractor that a seek has occurred.
|
boolean |
sniff(ExtractorInput input)
Returns whether this extractor can extract samples from the
ExtractorInput , which must
provide data from the start of the stream. |
public WebvttExtractor(String language, TimestampAdjuster timestampAdjuster)
public boolean sniff(ExtractorInput input) throws IOException, InterruptedException
Extractor
ExtractorInput
, which must
provide data from the start of the stream.
If true
is returned, the input
's reading position may have been modified.
Otherwise, only its peek position may have been modified.
sniff
in interface Extractor
input
- The ExtractorInput
from which data should be peeked/read.IOException
- If an error occurred reading from the input.InterruptedException
- If the thread was interrupted.public void init(ExtractorOutput output)
Extractor
ExtractorOutput
. Called at most once.init
in interface Extractor
output
- An ExtractorOutput
to receive extracted data.public void seek(long position, long timeUs)
Extractor
Following a call to this method, the ExtractorInput
passed to the next invocation of
Extractor.read(ExtractorInput, PositionHolder)
is required to provide data starting from position
in the stream. Valid random access positions are the start of the stream and
positions that can be obtained from any SeekMap
passed to the ExtractorOutput
.
public void release()
Extractor
public int read(ExtractorInput input, PositionHolder seekPosition) throws IOException, InterruptedException
Extractor
ExtractorInput
. Must not be called before Extractor.init(ExtractorOutput)
.
A single call to this method will block until some progress has been made, but will not block for longer than this. Hence each call will consume only a small amount of input data.
In the common case, Extractor.RESULT_CONTINUE
is returned to indicate that the ExtractorInput
passed to the next read is required to provide data continuing from the
position in the stream reached by the returning call. If the extractor requires data to be
provided from a different position, then that position is set in seekPosition
and
Extractor.RESULT_SEEK
is returned. If the extractor reached the end of the data provided by the
ExtractorInput
, then Extractor.RESULT_END_OF_INPUT
is returned.
read
in interface Extractor
input
- The ExtractorInput
from which data should be read.seekPosition
- If Extractor.RESULT_SEEK
is returned, this holder is updated to hold the
position of the required data.RESULT_
values defined in this interface.IOException
- If an error occurred reading from the input.InterruptedException
- If the thread was interrupted.