Extractor

Artifact: androidx.media3:media3-extractor

Kotlin |Java

@UnstableApi
public interface Extractor

Known direct subclasses

`Ac3Extractor`	Extracts data from (E-)AC-3 bitstreams.
`Ac4Extractor`	Extracts data from AC-4 bitstreams.
`AdtsExtractor`	Extracts data from AAC bit streams with ADTS framing.
`AmrExtractor`	Extracts data from the AMR containers format (either AMR or AMR-WB).
`AviExtractor`	Extracts data from the AVI container format.
`AvifExtractor`	Extracts data from the AVIF (.avif) container format.
`BmpExtractor`	Extracts data from the BMP container format.
`FlacExtractor`	Extracts data from FLAC container format.
`FlvExtractor`	Extracts data from the FLV container format.
`ForwardingExtractor`	An overridable `Extractor` implementation which forwards all methods to another `Extractor`.
`FragmentedMp4Extractor`	Extracts data from the FMP4 container format.
`HeifExtractor`	Extracts data from the HEIF/HEIC container format.
`JpegExtractor`	Extracts data from the JPEG container format.
`MatroskaExtractor`	Extracts data from the Matroska and WebM container formats.
`Mp3Extractor`	Extracts data from the MP3 container format.
`Mp4Extractor`	Extracts data from the MP4 container format.
`OggExtractor`	Extracts data from the Ogg container format.
`PngExtractor`	Extracts data from the PNG container format.
`PsExtractor`	Extracts data from the MPEG-2 PS container format.
`SingleSampleExtractor`	Extracts data by loading all the bytes into one sample.
`SubtitleExtractor`	Generic extractor for extracting subtitles from various subtitle formats.
`SubtitleTranscodingExtractor`	This class is deprecated. Use `SubtitleTranscodingExtractorOutput` directly from within an existing `Extractor` implementation instead.
`TsExtractor`	Extracts data from the MPEG-2 TS container format.
`WavExtractor`	Extracts data from WAV byte streams.
`WebpExtractor`	Extracts data from the WEBP container format.
`WebvttExtractor`	A special purpose extractor for WebVTT content in HLS.

Extracts media data from a container format.

Summary

Nested types
`@Documented @Retention(value = RetentionPolicy.SOURCE) @Target(value = ElementType.TYPE_USE) @IntDef(value = ) public annotation Extractor.ReadResult` Result values that can be returned by `read`.

Constants
`default static final int`	`RESULT_CONTINUE = 0` Returned by `read` if the `ExtractorInput` passed to the next `read` is required to provide data continuing from the position in the stream reached by the returning call.
`default static final int`	`RESULT_END_OF_INPUT = -1` Returned by `read` if the end of the `ExtractorInput` was reached.
`default static final int`	`RESULT_SEEK = 1` Returned by `read` if the `ExtractorInput` passed to the next `read` is required to provide data starting from a specified position in the stream.

Public methods
`default List<SniffFailure>`	`getSniffFailureDetails()` Returns additional details about the last call to `sniff`.
`default Extractor`	`@SideEffectFree getUnderlyingImplementation()` Returns the 'real' `Extractor` implementation if this is a delegating instance, or `this` if this instance does the extraction directly without delegating (the default behaviour).
`abstract void`	`init(ExtractorOutput output)` Initializes the extractor with an `ExtractorOutput`.
`abstract int`	`@Extractor.ReadResult read(ExtractorInput input, PositionHolder seekPosition)` Extracts data read from a provided `ExtractorInput`.
`abstract void`	`release()` Releases all kept resources.
`abstract void`	`seek(long position, long timeUs)` Notifies the extractor that a seek has occurred.
`abstract boolean`	`sniff(ExtractorInput input)` Returns whether this extractor can extract samples from the `ExtractorInput`, which must provide data from the start of the stream.

Constants

RESULT_CONTINUE

default static final int RESULT_CONTINUE = 0

Returned by read if the ExtractorInput passed to the next read is required to provide data continuing from the position in the stream reached by the returning call.

RESULT_END_OF_INPUT

default static final int RESULT_END_OF_INPUT = -1

Returned by read if the end of the ExtractorInput was reached. Equal to RESULT_END_OF_INPUT.

RESULT_SEEK

default static final int RESULT_SEEK = 1

Returned by read if the ExtractorInput passed to the next read is required to provide data starting from a specified position in the stream.

Public methods

getSniffFailureDetails

default List<SniffFailure> getSniffFailureDetails()

Returns additional details about the last call to sniff. The returned list may be empty if no additional details are available, or the last sniff call returned true.

This only contains details that were discovered before sniff returned false, it is not an exhaustive list of issues which, if resolved, would cause the file to be successfully sniffed.

getUnderlyingImplementation

@SideEffectFree
default Extractor getUnderlyingImplementation()

Returns the 'real' Extractor implementation if this is a delegating instance, or this if this instance does the extraction directly without delegating (the default behaviour).

Extractor implementations that operate by delegating to another Extractor should override this method to return that delegate.

init

abstract void init(ExtractorOutput output)

Initializes the extractor with an ExtractorOutput. Called at most once.

Parameters
`ExtractorOutput output`	An `ExtractorOutput` to receive extracted data.

read

@Extractor.ReadResult
abstract int read(ExtractorInput input, PositionHolder seekPosition)

Extracts data read from a provided ExtractorInput. Must not be called before init.

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.

When this method throws an IOException, extraction may continue by providing an ExtractorInput with an unchanged read position to a subsequent call to this method.

Parameters
`ExtractorInput input`	The `ExtractorInput` from which data should be read.
`PositionHolder seekPosition`	If `RESULT_SEEK` is returned, this holder is updated to hold the position of the required data.

Returns
`int`	One of the `RESULT_` values defined in this interface.

Throws
`java.io.IOException`	If an error occurred reading from or parsing the input.

release

abstract void release()

Releases all kept resources.

seek

abstract void seek(long position, long timeUs)

Notifies the extractor that a seek has occurred.

Following a call to this method, the ExtractorInput passed to the next invocation of read 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.

Parameters
`long position`	The byte offset in the stream from which data will be provided.
`long timeUs`	The seek time in microseconds.

sniff

abstract boolean sniff(ExtractorInput input)

Returns whether this extractor can extract samples from the 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.

Parameters
`ExtractorInput input`	The `ExtractorInput` from which data should be peeked/read.

Returns
`boolean`	Whether this extractor can read the provided input.

Throws
`java.io.IOException`	If an error occurred reading from the input.

Extractor

Summary

Nested types

Constants

Public methods

Constants

RESULT_CONTINUE

RESULT_END_OF_INPUT

RESULT_SEEK

Public methods

getSniffFailureDetails

getUnderlyingImplementation

init

read

release

seek

sniff