@UnstableApi
class AviExtractor : Extractor

Extracts data from the AVI container format.

Spec: https://docs.microsoft.com/en-us/windows/win32/directshow/avi-riff-file-reference.

Summary

Nested types
@Documented
@Retention(value = RetentionPolicy.SOURCE)
@Target(value = TYPE_USE)
@IntDef(flag = true, value = )
annotation AviExtractor.Flags

Flags controlling the behavior of the extractor.

Constants
const Int

Flag to use the source subtitle formats without modification.
const Int
FOURCC_AVI_ = 541677121
const Int
FOURCC_JUNK = 1263424842
const Int
FOURCC_LIST = 1414744396
const Int
FOURCC_RIFF = 1179011410
const Int
FOURCC_auds = 1935963489
const Int
FOURCC_avih = 1751742049
const Int
FOURCC_hdrl = 1819436136
const Int
FOURCC_idx1 = 829973609
const Int
FOURCC_movi = 1769369453
const Int
FOURCC_strf = 1718776947
const Int
FOURCC_strh = 1752331379
const Int
FOURCC_strl = 1819440243
const Int
FOURCC_strn = 1852994675
const Int
FOURCC_txts = 1937012852
const Int
FOURCC_vids = 1935960438

Public constructors

This function is deprecated.

Use AviExtractor instead.
AviExtractor(
    @AviExtractor.Flags extractorFlags: Int,
    subtitleParserFactory: SubtitleParser.Factory!
)

Constructs an instance.

Public functions
Unit

Initializes the extractor with an ExtractorOutput.
Int
read(input: ExtractorInput!, seekPosition: PositionHolder!)

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.

Inherited Constants
From androidx.media3.extractor.Extractor
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.

Inherited functions
From androidx.media3.extractor.Extractor
(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).

Constants

FLAG_EMIT_RAW_SUBTITLE_DATA

const val FLAG_EMIT_RAW_SUBTITLE_DATA = 1: Int

Flag to use the source subtitle formats without modification. If unset, subtitles will be transcoded to APPLICATION_MEDIA3_CUES during extraction.

FOURCC_AVI_

const val FOURCC_AVI_ = 541677121: Int

FOURCC_JUNK

const val FOURCC_JUNK = 1263424842: Int

FOURCC_LIST

const val FOURCC_LIST = 1414744396: Int

FOURCC_RIFF

const val FOURCC_RIFF = 1179011410: Int

FOURCC_auds

const val FOURCC_auds = 1935963489: Int

FOURCC_avih

const val FOURCC_avih = 1751742049: Int

FOURCC_hdrl

const val FOURCC_hdrl = 1819436136: Int

FOURCC_idx1

const val FOURCC_idx1 = 829973609: Int

FOURCC_movi

const val FOURCC_movi = 1769369453: Int

FOURCC_strf

const val FOURCC_strf = 1718776947: Int

FOURCC_strh

const val FOURCC_strh = 1752331379: Int

FOURCC_strl

const val FOURCC_strl = 1819440243: Int

FOURCC_strn

const val FOURCC_strn = 1852994675: Int

FOURCC_txts

const val FOURCC_txts = 1937012852: Int

FOURCC_vids

const val FOURCC_vids = 1935960438: Int

Public constructors

AviExtractor

AviExtractor()

AviExtractor

AviExtractor(
    @AviExtractor.Flags extractorFlags: Int,
    subtitleParserFactory: SubtitleParser.Factory!
)

Constructs an instance.

Parameters
@AviExtractor.Flags extractorFlags: Int

Flags that control the extractor's behavior.
subtitleParserFactory: SubtitleParser.Factory!

The SubtitleParser.Factory for parsing subtitles during extraction.

Public functions

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

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.