MatroskaExtractor

@UnstableApi
class MatroskaExtractor : Extractor

Extracts data from the Matroska and WebM container formats.

Summary

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

Flags controlling the behavior of the extractor.
protected class MatroskaExtractor.Track

Holds data corresponding to a single track.

Constants
const ExtractorsFactory!

This property is deprecated.

Use newFactory instead.
const Int

Flag to disable seeking for cues.
const Int

Flag to use the source subtitle formats without modification.

Public constructors

This function is deprecated.

Use MatroskaExtractor instead.

This function is deprecated.

Use MatroskaExtractor instead.
MatroskaExtractor(subtitleParserFactory: SubtitleParser.Factory!)

Constructs an instance.
MatroskaExtractor(
    subtitleParserFactory: SubtitleParser.Factory!,
    @MatroskaExtractor.Flags flags: Int
)

Constructs an instance.

Public functions
Unit

Initializes the extractor with an ExtractorOutput.
java-static ExtractorsFactory!
newFactory(subtitleParserFactory: SubtitleParser.Factory!)

Creates a factory for MatroskaExtractor instances with the provided .
Int
read(input: ExtractorInput!, seekPosition: PositionHolder!)

Extracts data read from a provided ExtractorInput.
Unit

Releases all kept resources.
Unit
@CallSuper
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.

Protected functions
Unit
@CallSuper
binaryElement(id: Int, contentSize: Int, input: ExtractorInput!)

Called when a binary element is encountered.
Unit

Called when the end of a master element is encountered.
Unit

Called when a float element is encountered.
MatroskaExtractor.Track!
getCurrentTrack(currentElementId: Int)

Returns the track corresponding to the current TrackEntry element.
Int

Maps an element ID to a corresponding type.
Unit
handleBlockAddIDExtraData(
    track: MatroskaExtractor.Track!,
    input: ExtractorInput!,
    contentSize: Int
)
Unit
handleBlockAdditionalData(
    track: MatroskaExtractor.Track!,
    blockAdditionalId: Int,
    input: ExtractorInput!,
    contentSize: Int
)
Unit

Called when an integer element is encountered.
Boolean

Checks if the given id is that of a level 1 element.
Unit
@CallSuper
startMasterElement(id: Int, contentPosition: Long, contentSize: Long)

Called when the start of a master element is encountered.
Unit

Called when a string element is encountered.

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
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

FACTORY

const val FACTORY: ExtractorsFactory!

FLAG_DISABLE_SEEK_FOR_CUES

const val FLAG_DISABLE_SEEK_FOR_CUES = 1: Int

Flag to disable seeking for cues.

Normally (i.e. when this flag is not set) the extractor will seek to the cues element if its position is specified in the seek head and if it's after the first cluster. Setting this flag disables seeking to the cues element. If the cues element is after the first cluster then the media is treated as being unseekable.

FLAG_EMIT_RAW_SUBTITLE_DATA

const val FLAG_EMIT_RAW_SUBTITLE_DATA = 2: Int

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

Public constructors

MatroskaExtractor

MatroskaExtractor()

MatroskaExtractor

MatroskaExtractor(@MatroskaExtractor.Flags flags: Int)

MatroskaExtractor

MatroskaExtractor(subtitleParserFactory: SubtitleParser.Factory!)

Constructs an instance.

Parameters
subtitleParserFactory: SubtitleParser.Factory!

The SubtitleParser.Factory for parsing subtitles during extraction.

MatroskaExtractor

MatroskaExtractor(
    subtitleParserFactory: SubtitleParser.Factory!,
    @MatroskaExtractor.Flags flags: Int
)

Constructs an instance.

Parameters
subtitleParserFactory: SubtitleParser.Factory!

The SubtitleParser.Factory for parsing subtitles during extraction.
@MatroskaExtractor.Flags flags: Int

Flags that control the extractor's behavior.

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.

newFactory

java-static fun newFactory(subtitleParserFactory: SubtitleParser.Factory!): ExtractorsFactory!

Creates a factory for MatroskaExtractor instances with the provided .

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

@CallSuper
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.

Protected functions

binaryElement

@CallSuper
protected fun binaryElement(id: Int, contentSize: Int, input: ExtractorInput!): Unit

Called when a binary element is encountered.

Throws
java.io.IOException
See also
binaryElement

endMasterElement

@CallSuper
protected fun endMasterElement(id: Int): Unit

Called when the end of a master element is encountered.

Throws
androidx.media3.common.ParserException
See also
endMasterElement

floatElement

@CallSuper
protected fun floatElement(id: Int, value: Double): Unit

Called when a float element is encountered.

Throws
androidx.media3.common.ParserException
See also
floatElement

getCurrentTrack

protected fun getCurrentTrack(currentElementId: Int): MatroskaExtractor.Track!

Returns the track corresponding to the current TrackEntry element.

Throws
androidx.media3.common.ParserException

if the element id is not in a TrackEntry.

getElementType

@CallSuper
@EbmlProcessor.ElementType
protected fun getElementType(id: Int): Int

Maps an element ID to a corresponding type.

See also
getElementType

handleBlockAddIDExtraData

protected fun handleBlockAddIDExtraData(
    track: MatroskaExtractor.Track!,
    input: ExtractorInput!,
    contentSize: Int
): Unit
Throws
java.io.IOException

handleBlockAdditionalData

protected fun handleBlockAdditionalData(
    track: MatroskaExtractor.Track!,
    blockAdditionalId: Int,
    input: ExtractorInput!,
    contentSize: Int
): Unit
Throws
java.io.IOException

integerElement

@CallSuper
protected fun integerElement(id: Int, value: Long): Unit

Called when an integer element is encountered.

Throws
androidx.media3.common.ParserException
See also
integerElement

isLevel1Element

@CallSuper
protected fun isLevel1Element(id: Int): Boolean

Checks if the given id is that of a level 1 element.

See also
isLevel1Element

startMasterElement

@CallSuper
protected fun startMasterElement(id: Int, contentPosition: Long, contentSize: Long): Unit

Called when the start of a master element is encountered.

Throws
androidx.media3.common.ParserException
See also
startMasterElement

stringElement

@CallSuper
protected fun stringElement(id: Int, value: String!): Unit

Called when a string element is encountered.

Throws
androidx.media3.common.ParserException
See also
stringElement