@UnstableApi
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.
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 = TYPE_USE)
@IntDef(value = )
annotation Extractor.ReadResult

Result values that can be returned by read.

Constants
const Int

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.
const Int

Returned by read if the end of the was reached.
const Int

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 functions
(Mutable)List<SniffFailure!>!

Returns additional details about the last call to sniff.
Extractor!

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).
Unit

Initializes the extractor with an ExtractorOutput.
Int

Extracts data read from a provided ExtractorInput.
Unit

Releases all kept resources.
Unit
seek(position: Long, timeUs: Long)

Notifies the extractor that a seek has occurred.
Boolean

Returns whether this extractor can extract samples from the ExtractorInput, which must provide data from the start of the stream.

Constants

RESULT_CONTINUE

const val RESULT_CONTINUE = 0: Int

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

const val RESULT_END_OF_INPUT = -1: Int

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

RESULT_SEEK

const val RESULT_SEEK = 1: Int

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 functions

getSniffFailureDetails

fun getSniffFailureDetails(): (Mutable)List<SniffFailure!>!

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
fun getUnderlyingImplementation(): Extractor!

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

fun init(output: ExtractorOutput!): Unit

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

Parameters
output: ExtractorOutput!

An ExtractorOutput to receive extracted data.

read

@Extractor.ReadResult
fun read(input: ExtractorInput!, seekPosition: PositionHolder!): Int

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 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
input: ExtractorInput!

The ExtractorInput from which data should be read.
seekPosition: PositionHolder!

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

fun release(): Unit

Releases all kept resources.

seek

fun seek(position: Long, timeUs: Long): Unit

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
position: Long

The byte offset in the stream from which data will be provided.
timeUs: Long

The seek time in microseconds.

sniff

fun sniff(input: ExtractorInput!): Boolean

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
input: ExtractorInput!

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.