# AviExtractor

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/avi/AviExtractor.java+class:androidx.media3.extractor.avi.AviExtractor)

*** ** * ** ***


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

<br />

*** ** * ** ***

Extracts data from the AVI container format.

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

## 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/avi/AviExtractor.Flags` Flags controlling the behavior of the extractor. |

| ### Constants |
|---|---|
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FLAG_EMIT_RAW_SUBTITLE_DATA() = 1` Flag to use the source subtitle formats without modification. |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FOURCC_AVI_() = 541677121` |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FOURCC_JUNK() = 1263424842` |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FOURCC_LIST() = 1414744396` |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FOURCC_RIFF() = 1179011410` |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FOURCC_auds() = 1935963489` |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FOURCC_avih() = 1751742049` |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FOURCC_hdrl() = 1819436136` |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FOURCC_idx1() = 829973609` |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FOURCC_movi() = 1769369453` |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FOURCC_strf() = 1718776947` |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FOURCC_strh() = 1752331379` |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FOURCC_strl() = 1819440243` |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FOURCC_strn() = 1852994675` |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FOURCC_txts() = 1937012852` |
| `static final int` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#FOURCC_vids() = 1935960438` |

| ### Public constructors |
|---|
| `[AviExtractor](https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#AviExtractor())()` **This method is deprecated.** Use `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#AviExtractor(int,androidx.media3.extractor.text.SubtitleParser.Factory)` instead. <br /> |
| `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#AviExtractor(int,androidx.media3.extractor.text.SubtitleParser.Factory)( @https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor.Flags int extractorFlags, https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleParser.Factory subtitleParserFactory )` Constructs an instance. |

| ### Public methods |
|---|---|
| `void` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#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/avi/AviExtractor#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/avi/AviExtractor#release()()` Releases all kept resources. |
| `void` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#seek(long,long)(long position, long timeUs)` Notifies the extractor that a seek has occurred. |
| `boolean` | `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#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

### FLAG_EMIT_RAW_SUBTITLE_DATA

```
public static final int FLAG_EMIT_RAW_SUBTITLE_DATA = 1
```

Flag to use the source subtitle formats without modification. If unset, subtitles will be transcoded to `https://developer.android.com/reference/androidx/media3/common/MimeTypes#APPLICATION_MEDIA3_CUES()` during extraction.

### FOURCC_AVI_

```
public static final int FOURCC_AVI_ = 541677121
```

### FOURCC_JUNK

```
public static final int FOURCC_JUNK = 1263424842
```

### FOURCC_LIST

```
public static final int FOURCC_LIST = 1414744396
```

### FOURCC_RIFF

```
public static final int FOURCC_RIFF = 1179011410
```

### FOURCC_auds

```
public static final int FOURCC_auds = 1935963489
```

### FOURCC_avih

```
public static final int FOURCC_avih = 1751742049
```

### FOURCC_hdrl

```
public static final int FOURCC_hdrl = 1819436136
```

### FOURCC_idx1

```
public static final int FOURCC_idx1 = 829973609
```

### FOURCC_movi

```
public static final int FOURCC_movi = 1769369453
```

### FOURCC_strf

```
public static final int FOURCC_strf = 1718776947
```

### FOURCC_strh

```
public static final int FOURCC_strh = 1752331379
```

### FOURCC_strl

```
public static final int FOURCC_strl = 1819440243
```

### FOURCC_strn

```
public static final int FOURCC_strn = 1852994675
```

### FOURCC_txts

```
public static final int FOURCC_txts = 1937012852
```

### FOURCC_vids

```
public static final int FOURCC_vids = 1935960438
```

## Public constructors

### AviExtractor

```
public [AviExtractor](https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#AviExtractor())()
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Use `https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor#AviExtractor(int,androidx.media3.extractor.text.SubtitleParser.Factory)` instead.

### AviExtractor

```
public AviExtractor(
    @AviExtractor.Flags int extractorFlags,
    SubtitleParser.Factory subtitleParserFactory
)
```

Constructs an instance.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/media3/extractor/avi/AviExtractor.Flags int extractorFlags` | Flags that control the extractor's behavior. |
| `https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleParser.Factory subtitleParserFactory` | The `https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleParser.Factory` for parsing subtitles during extraction. |

## Public methods

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