# Mp3Extractor

Artifact: [androidx.media3:media3-extractor](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/extractor/mp3/Mp3Extractor.java+class:androidx.media3.extractor.mp3.Mp3Extractor)

*** ** * ** ***


```
@UnstableApi
public final class Mp3Extractor implements Extractor
```

<br />

*** ** * ** ***

Extracts data from the MP3 container format.

## Summary

| ### Nested types |
|---|
| `@https://developer.android.com/reference/java/lang/annotation/Documented.html @https://developer.android.com/reference/java/lang/annotation/Retention.html(value = https://developer.android.com/reference/java/lang/annotation/RetentionPolicy.html#SOURCE) @https://developer.android.com/reference/java/lang/annotation/Target.html(value = https://developer.android.com/reference/java/lang/annotation/ElementType.html#TYPE_USE) @https://developer.android.com/reference/androidx/annotation/IntDef(flag = true, value = ) public annotation https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor.Flags` Flags controlling the behavior of the extractor. |

| ### Constants |
|---|---|
| `static final https://developer.android.com/reference/androidx/media3/extractor/ExtractorsFactory` | `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#FACTORY()` Factory for `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor` instances. |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#FLAG_DISABLE_ARTWORK_METADATA() = 16` Flag to disable parsing of artwork metadata. |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#FLAG_DISABLE_ID3_METADATA() = 8` Flag to disable parsing of ID3 metadata. |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#FLAG_ENABLE_CONSTANT_BITRATE_SEEKING() = 1` Flag to force enable seeking using a constant bitrate assumption in cases where seeking would otherwise not be possible. |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#FLAG_ENABLE_CONSTANT_BITRATE_SEEKING_ALWAYS() = 2` Like `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#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. |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#FLAG_ENABLE_INDEX_SEEKING() = 4` Flag to enable index seeking, in which a time-to-byte mapping is built as the file is read. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#Mp3Extractor()()` |
| `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#Mp3Extractor(int)(@https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor.Flags int flags)` |
| `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#Mp3Extractor(int,long)( @https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor.Flags int flags, long forcedFirstSampleTimestampUs )` |

| ### Public methods |
|---|---|
| `void` | `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#disableSeeking()()` Disables the extractor from being able to seek through the media. |
| `void` | `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#init(androidx.media3.extractor.ExtractorOutput)(https://developer.android.com/reference/androidx/media3/extractor/ExtractorOutput output)` Initializes the extractor with an `https://developer.android.com/reference/androidx/media3/extractor/ExtractorOutput`. |
| `int` | `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#read(androidx.media3.extractor.ExtractorInput,androidx.media3.extractor.PositionHolder)(https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput input, https://developer.android.com/reference/androidx/media3/extractor/PositionHolder seekPosition)` Extracts data read from a provided `https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput`. |
| `void` | `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#release()()` Releases all kept resources. |
| `void` | `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#seek(long,long)(long position, long timeUs)` Notifies the extractor that a seek has occurred. |
| `boolean` | `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#sniff(androidx.media3.extractor.ExtractorInput)(https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput input)` Returns whether this extractor can extract samples from the `https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput`, which must provide data from the start of the stream. |

| ### Inherited Constants |
|---|
| From [androidx.media3.extractor.Extractor](https://developer.android.com/reference/androidx/media3/extractor/Extractor) |---|---| | `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/Extractor#RESULT_CONTINUE() = 0` Returned by `https://developer.android.com/reference/androidx/media3/extractor/Extractor#read(androidx.media3.extractor.ExtractorInput,androidx.media3.extractor.PositionHolder)` if the `https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput` passed to the next `https://developer.android.com/reference/androidx/media3/extractor/Extractor#read(androidx.media3.extractor.ExtractorInput,androidx.media3.extractor.PositionHolder)` is required to provide data continuing from the position in the stream reached by the returning call. | | `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/Extractor#RESULT_END_OF_INPUT() = -1` Returned by `https://developer.android.com/reference/androidx/media3/extractor/Extractor#read(androidx.media3.extractor.ExtractorInput,androidx.media3.extractor.PositionHolder)` if the end of the `https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput` was reached. | | `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/Extractor#RESULT_SEEK() = 1` Returned by `https://developer.android.com/reference/androidx/media3/extractor/Extractor#read(androidx.media3.extractor.ExtractorInput,androidx.media3.extractor.PositionHolder)` if the `https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput` passed to the next `https://developer.android.com/reference/androidx/media3/extractor/Extractor#read(androidx.media3.extractor.ExtractorInput,androidx.media3.extractor.PositionHolder)` is required to provide data starting from a specified position in the stream. | |

| ### Inherited methods |
|---|
| From [androidx.media3.extractor.Extractor](https://developer.android.com/reference/androidx/media3/extractor/Extractor) |---|---| | `https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/androidx/media3/extractor/SniffFailure>` | `https://developer.android.com/reference/androidx/media3/extractor/Extractor#getSniffFailureDetails()()` Returns additional details about the last call to `https://developer.android.com/reference/androidx/media3/extractor/Extractor#sniff(androidx.media3.extractor.ExtractorInput)`. | | `https://developer.android.com/reference/androidx/media3/extractor/Extractor` | `@https://checkerframework.org/api/org/checkerframework/dataflow/qual/SideEffectFree.html https://developer.android.com/reference/androidx/media3/extractor/Extractor#getUnderlyingImplementation()()` 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

```
public static final ExtractorsFactory FACTORY
```

Factory for `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor` instances.

### FLAG_DISABLE_ARTWORK_METADATA

```
public static final int FLAG_DISABLE_ARTWORK_METADATA = 16
```

Flag to disable parsing of artwork metadata.

### FLAG_DISABLE_ID3_METADATA

```
public static final int FLAG_DISABLE_ID3_METADATA = 8
```

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

### FLAG_ENABLE_CONSTANT_BITRATE_SEEKING

```
public static final int FLAG_ENABLE_CONSTANT_BITRATE_SEEKING = 1
```

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

### FLAG_ENABLE_CONSTANT_BITRATE_SEEKING_ALWAYS

```
public static final int FLAG_ENABLE_CONSTANT_BITRATE_SEEKING_ALWAYS = 2
```

Like `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#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 `https://developer.android.com/reference/androidx/media3/common/Player.Listener#onPlayerError(androidx.media3.common.PlaybackException)` with `https://developer.android.com/reference/androidx/media3/common/PlaybackException#errorCode()` set to `https://developer.android.com/reference/androidx/media3/common/PlaybackException#ERROR_CODE_IO_READ_POSITION_OUT_OF_RANGE()`.

If this flag is set, then the behavior enabled by `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#FLAG_ENABLE_CONSTANT_BITRATE_SEEKING()` is implicitly enabled.

### FLAG_ENABLE_INDEX_SEEKING

```
public static final int FLAG_ENABLE_INDEX_SEEKING = 4
```

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

This is used as a fallback in two cases:

- The file contains metadata indicating it is VBR (e.g. Xing, VBRI or MLLT frames), but doesn't contain enough information to support VBR-aware seeking (e.g. table of contents).
- The file is CBR (either indicated by explicit metadata, or absence of any VBR metadata), the length of the file (in bytes) is not known, and `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#FLAG_ENABLE_CONSTANT_BITRATE_SEEKING_ALWAYS()` is not set.

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

## Public constructors

### Mp3Extractor

```
public Mp3Extractor()
```

### Mp3Extractor

```
public Mp3Extractor(@Mp3Extractor.Flags int flags)
```

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor.Flags int flags` | Flags that control the extractor's behavior. |

### Mp3Extractor

```
public Mp3Extractor(
    @Mp3Extractor.Flags int flags,
    long forcedFirstSampleTimestampUs
)
```

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor.Flags int flags` | Flags that control the extractor's behavior. |
| `long forcedFirstSampleTimestampUs` | A timestamp to force for the first sample, or `https://developer.android.com/reference/androidx/media3/common/C#TIME_UNSET()` if forcing is not required. |

## Public methods

### disableSeeking

```
public void disableSeeking()
```

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

Please note that this needs to be called before `https://developer.android.com/reference/androidx/media3/extractor/mp3/Mp3Extractor#read(androidx.media3.extractor.ExtractorInput,androidx.media3.extractor.PositionHolder)`.

### init

```
public void init(ExtractorOutput output)
```

Initializes the extractor with an `https://developer.android.com/reference/androidx/media3/extractor/ExtractorOutput`. Called at most once.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/media3/extractor/ExtractorOutput output` | An `https://developer.android.com/reference/androidx/media3/extractor/ExtractorOutput` to receive extracted data. |

### read

```
public int read(ExtractorInput input, PositionHolder seekPosition)
```

Extracts data read from a provided `https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput`. Must not be called before `https://developer.android.com/reference/androidx/media3/extractor/Extractor#init(androidx.media3.extractor.ExtractorOutput)`.

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, `https://developer.android.com/reference/androidx/media3/extractor/Extractor#RESULT_CONTINUE()` is returned to indicate that the `https://developer.android.com/reference/androidx/media3/extractor/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 `https://developer.android.com/reference/androidx/media3/extractor/Extractor#RESULT_SEEK()` is returned. If the extractor reached the end of the data provided by the `https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput`, then `https://developer.android.com/reference/androidx/media3/extractor/Extractor#RESULT_END_OF_INPUT()` is returned.

When this method throws an `https://developer.android.com/reference/java/io/IOException.html`, extraction may continue by providing an `https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput` with an unchanged `https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput#getPosition()` to a subsequent call to this method.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput input` | The `https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput` from which data should be read. |
| `https://developer.android.com/reference/androidx/media3/extractor/PositionHolder seekPosition` | If `https://developer.android.com/reference/androidx/media3/extractor/Extractor#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 |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` | If an error occurred reading from or parsing the input. |

### release

```
public void release()
```

Releases all kept resources.

### seek

```
public void seek(long position, long timeUs)
```

Notifies the extractor that a seek has occurred.

Following a call to this method, the `https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput` passed to the next invocation of `https://developer.android.com/reference/androidx/media3/extractor/Extractor#read(androidx.media3.extractor.ExtractorInput,androidx.media3.extractor.PositionHolder)` 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 `https://developer.android.com/reference/androidx/media3/extractor/SeekMap` passed to the `https://developer.android.com/reference/androidx/media3/extractor/ExtractorOutput`.

| Parameters |
|---|---|
| `long position` | The byte offset in the stream from which data will be provided. |
| `long timeUs` | The seek time in microseconds. |

### sniff

```
public boolean sniff(ExtractorInput input)
```

Returns whether this extractor can extract samples from the `https://developer.android.com/reference/androidx/media3/extractor/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 |
|---|---|
| `https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput input` | The `https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput` from which data should be peeked/read. |

| Returns |
|---|---|
| `boolean` | Whether this extractor can read the provided input. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` | If an error occurred reading from the input. |