# SubtitleTranscodingExtractor

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

*** ** * ** ***


```
@UnstableApi
public class SubtitleTranscodingExtractor implements Extractor
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
>
> Use `https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleTranscodingExtractorOutput` directly from within an existing `https://developer.android.com/reference/androidx/media3/extractor/Extractor` implementation instead.

## Summary

| ### Public constructors |
|---|
| `[SubtitleTranscodingExtractor](https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleTranscodingExtractor#SubtitleTranscodingExtractor(androidx.media3.extractor.Extractor,androidx.media3.extractor.text.SubtitleParser.Factory))( https://developer.android.com/reference/androidx/media3/extractor/Extractor delegate, https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleParser.Factory subtitleParserFactory )` **This method is deprecated.** Deprecated in Java |

| ### Public methods |
|---|---|
| `https://developer.android.com/reference/androidx/media3/extractor/Extractor` | `[getUnderlyingImplementation](https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleTranscodingExtractor#getUnderlyingImplementation())()` **This method is deprecated.** Deprecated in Java |
| `void` | `[init](https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleTranscodingExtractor#init(androidx.media3.extractor.ExtractorOutput))(https://developer.android.com/reference/androidx/media3/extractor/ExtractorOutput output)` **This method is deprecated.** Deprecated in Java |
| `int` | `@https://developer.android.com/reference/androidx/media3/extractor/Extractor.ReadResult [read](https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleTranscodingExtractor#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)` **This method is deprecated.** Deprecated in Java |
| `void` | `[release](https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleTranscodingExtractor#release())()` **This method is deprecated.** Deprecated in Java |
| `void` | `[seek](https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleTranscodingExtractor#seek(long,long))(long position, long timeUs)` **This method is deprecated.** Deprecated in Java |
| `boolean` | `[sniff](https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleTranscodingExtractor#sniff(androidx.media3.extractor.ExtractorInput))(https://developer.android.com/reference/androidx/media3/extractor/ExtractorInput input)` **This method is deprecated.** Deprecated in Java |

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

**This field is deprecated.** Deprecated in Java
`static final int` `https://developer.android.com/reference/androidx/media3/extractor/Extractor#RESULT_END_OF_INPUT() = -1`

**This field is deprecated.** Deprecated in Java
`static final int` `https://developer.android.com/reference/androidx/media3/extractor/Extractor#RESULT_SEEK() = 1`

**This field is deprecated.** Deprecated in Java

### 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>` `[getSniffFailureDetails](https://developer.android.com/reference/androidx/media3/extractor/Extractor#getSniffFailureDetails())()`

**This method is deprecated.** Deprecated in Java

## Public constructors

### SubtitleTranscodingExtractor

```
public [SubtitleTranscodingExtractor](https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleTranscodingExtractor#SubtitleTranscodingExtractor(androidx.media3.extractor.Extractor,androidx.media3.extractor.text.SubtitleParser.Factory))(
    Extractor delegate,
    SubtitleParser.Factory subtitleParserFactory
)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

## Public methods

### getUnderlyingImplementation

```
public Extractor [getUnderlyingImplementation](https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleTranscodingExtractor#getUnderlyingImplementation())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

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

`Extractor` implementations that operate by delegating to another `Extractor` should override this method to return that delegate.

### init

```
public void [init](https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleTranscodingExtractor#init(androidx.media3.extractor.ExtractorOutput))(ExtractorOutput output)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

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

```
@Extractor.ReadResult
public int [read](https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleTranscodingExtractor#read(androidx.media3.extractor.ExtractorInput,androidx.media3.extractor.PositionHolder))(ExtractorInput input, PositionHolder seekPosition)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

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](https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleTranscodingExtractor#release())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Releases all kept resources.

### seek

```
public void [seek](https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleTranscodingExtractor#seek(long,long))(long position, long timeUs)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

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](https://developer.android.com/reference/androidx/media3/extractor/text/SubtitleTranscodingExtractor#sniff(androidx.media3.extractor.ExtractorInput))(ExtractorInput input)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

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