public interface Extractor
Modifier and Type | Interface and Description |
---|---|
static interface |
Extractor.ReadResult
Result values that can be returned by
read(ExtractorInput, PositionHolder) . |
Modifier and Type | Field and Description |
---|---|
static int |
RESULT_CONTINUE
Returned by
read(ExtractorInput, PositionHolder) if the ExtractorInput passed
to the next read(ExtractorInput, PositionHolder) is required to provide data
continuing from the position in the stream reached by the returning call. |
static int |
RESULT_END_OF_INPUT
Returned by
read(ExtractorInput, PositionHolder) if the end of the
ExtractorInput was reached. |
static int |
RESULT_SEEK
Returned by
read(ExtractorInput, PositionHolder) if the ExtractorInput passed
to the next read(ExtractorInput, PositionHolder) is required to provide data starting
from a specified position in the stream. |
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. |
static final int RESULT_CONTINUE
read(ExtractorInput, PositionHolder)
if the ExtractorInput
passed
to the next read(ExtractorInput, PositionHolder)
is required to provide data
continuing from the position in the stream reached by the returning call.static final int RESULT_SEEK
read(ExtractorInput, PositionHolder)
if the ExtractorInput
passed
to the next read(ExtractorInput, PositionHolder)
is required to provide data starting
from a specified position in the stream.static final int RESULT_END_OF_INPUT
read(ExtractorInput, PositionHolder)
if the end of the
ExtractorInput
was reached. Equal to C.RESULT_END_OF_INPUT
.boolean sniff(ExtractorInput input) throws IOException, InterruptedException
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.
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.void init(ExtractorOutput output)
ExtractorOutput
. Called at most once.output
- An ExtractorOutput
to receive extracted data.@Extractor.ReadResult int read(ExtractorInput input, PositionHolder seekPosition) throws IOException, InterruptedException
ExtractorInput
. Must not be called before 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, 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
RESULT_SEEK
is returned. If the extractor reached the end of the data provided by the
ExtractorInput
, then RESULT_END_OF_INPUT
is returned.
input
- The ExtractorInput
from which data should be read.seekPosition
- If 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.void seek(long position, long timeUs)
Following a call to this method, the ExtractorInput
passed to the next invocation of
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
.
position
- The byte offset in the stream from which data will be provided.timeUs
- The seek time in microseconds.void release()