@UnstableApi
class Mp3Extractor : Extractor


Extracts data from the MP3 container format.

Summary

Nested types

@Documented
@Retention(value = SOURCE)
@Target(value = TYPE_USE)
@IntDef(flag = true, value = )
annotation Mp3Extractor.Flags

Flags controlling the behavior of the extractor.

Constants

const ExtractorsFactory!

Factory for Mp3Extractor instances.

const Int

Flag to disable parsing of ID3 metadata.

const Int

Flag to force enable seeking using a constant bitrate assumption in cases where seeking would otherwise not be possible.

const Int

Like FLAG_ENABLE_CONSTANT_BITRATE_SEEKING, except that seeking is also enabled in cases where the content length (and hence the duration of the media) is unknown.

const Int

Flag to force index seeking, in which a time-to-byte mapping is built as the file is read.

Public constructors

Mp3Extractor(
    @Mp3Extractor.Flags flags: Int,
    forcedFirstSampleTimestampUs: Long
)

Public functions

Unit

Disables the extractor from being able to seek through the media.

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

Factory for Mp3Extractor instances.

FLAG_DISABLE_ID3_METADATA

const val FLAG_DISABLE_ID3_METADATA = 8: Int

Flag to disable parsing of ID3 metadata. Can be set to save memory if ID3 metadata is not required.

FLAG_ENABLE_CONSTANT_BITRATE_SEEKING

const val FLAG_ENABLE_CONSTANT_BITRATE_SEEKING = 1: Int

Flag to force enable seeking using a constant bitrate assumption in cases where seeking would otherwise not be possible.

This flag is ignored if FLAG_ENABLE_INDEX_SEEKING is set.

FLAG_ENABLE_CONSTANT_BITRATE_SEEKING_ALWAYS

const val FLAG_ENABLE_CONSTANT_BITRATE_SEEKING_ALWAYS = 2: Int

Like FLAG_ENABLE_CONSTANT_BITRATE_SEEKING, except that seeking is also enabled in cases where the content length (and hence the duration of the media) is unknown. Application code should ensure that requested seek positions are valid when using this flag, or be ready to handle playback failures reported through onPlayerError with errorCode set to ERROR_CODE_IO_READ_POSITION_OUT_OF_RANGE.

If this flag is set, then the behavior enabled by FLAG_ENABLE_CONSTANT_BITRATE_SEEKING is implicitly enabled.

This flag is ignored if FLAG_ENABLE_INDEX_SEEKING is set.

FLAG_ENABLE_INDEX_SEEKING

const val FLAG_ENABLE_INDEX_SEEKING = 4: Int

Flag to force index seeking, in which a time-to-byte mapping is built as the file is read.

This seeker may require to scan a significant portion of the file to compute a seek point. Therefore, it should only be used if one of the following is true:

  • The file is small.
  • The bitrate is variable (or it's unknown whether it's variable) and the file does not provide precise enough seeking metadata.

Public constructors

Mp3Extractor

Mp3Extractor()

Mp3Extractor

Mp3Extractor(@Mp3Extractor.Flags flags: Int)
Parameters
@Mp3Extractor.Flags flags: Int

Flags that control the extractor's behavior.

Mp3Extractor

Mp3Extractor(
    @Mp3Extractor.Flags flags: Int,
    forcedFirstSampleTimestampUs: Long
)
Parameters
@Mp3Extractor.Flags flags: Int

Flags that control the extractor's behavior.

forcedFirstSampleTimestampUs: Long

A timestamp to force for the first sample, or TIME_UNSET if forcing is not required.

Public functions

disableSeeking

fun disableSeeking(): Unit

Disables the extractor from being able to seek through the media.

Please note that this needs to be called before read.

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.