MatroskaExtractor
@UnstableApi
class MatroskaExtractor : Extractor
Extracts data from the Matroska and WebM container formats.
Summary
Nested types |
|---|
@DocumentedFlags controlling the behavior of the extractor. |
protected class MatroskaExtractor.TrackHolds data corresponding to a single track. |
Constants |
|
|---|---|
const ExtractorsFactory! |
This property is deprecated. Use |
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 |
This function is deprecated. Use |
MatroskaExtractor(subtitleParserFactory: SubtitleParser.Factory!)Constructs an instance. |
MatroskaExtractor(Constructs an instance. |
Public functions |
|
|---|---|
Unit |
init(output: ExtractorOutput!)Initializes the extractor with an |
java-static ExtractorsFactory! |
newFactory(subtitleParserFactory: SubtitleParser.Factory!)Creates a factory for |
Int |
read(input: ExtractorInput!, seekPosition: PositionHolder!)Extracts data read from a provided |
Unit |
release()Releases all kept resources. |
Unit |
Notifies the extractor that a seek has occurred. |
Boolean |
sniff(input: ExtractorInput!)Returns whether this extractor can extract samples from the |
Protected functions |
|
|---|---|
Unit |
@CallSuperCalled when a binary element is encountered. |
Unit |
@CallSuperCalled when the end of a master element is encountered. |
Unit |
@CallSuperCalled 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( |
Unit |
handleBlockAdditionalData( |
Unit |
@CallSuperCalled when an integer element is encountered. |
Boolean |
@CallSuperChecks if the given id is that of a level 1 element. |
Unit |
@CallSuperCalled when the start of a master element is encountered. |
Unit |
@CallSuperCalled when a string element is encountered. |
Inherited Constants |
||||||
|---|---|---|---|---|---|---|
|
Inherited functions |
||||
|---|---|---|---|---|
|
Constants
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(subtitleParserFactory: SubtitleParser.Factory!)
Constructs an instance.
| Parameters | |
|---|---|
subtitleParserFactory: SubtitleParser.Factory! |
The |
MatroskaExtractor
MatroskaExtractor(
subtitleParserFactory: SubtitleParser.Factory!,
@MatroskaExtractor.Flags flags: Int
)
Constructs an instance.
| Parameters | |
|---|---|
subtitleParserFactory: SubtitleParser.Factory! |
The |
@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 |
newFactory
java-static fun newFactory(subtitleParserFactory: SubtitleParser.Factory!): ExtractorsFactory!
Creates a factory for MatroskaExtractor instances with the provided SubtitleParser.Factory.
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 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 | |
|---|---|
input: ExtractorInput! |
The |
seekPosition: PositionHolder! |
If |
| Returns | |
|---|---|
Int |
One of the |
| Throws | |
|---|---|
java.io.IOException |
If an error occurred reading from or parsing the input. |
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.
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 |
| 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.
| See also | |
|---|---|
endMasterElement |
floatElement
@CallSuper
protected fun floatElement(id: Int, value: Double): Unit
Called when a float element is encountered.
| 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.
| 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.
| See also | |
|---|---|
startMasterElement |
stringElement
@CallSuper
protected fun stringElement(id: Int, value: String!): Unit
Called when a string element is encountered.
| See also | |
|---|---|
stringElement |