# 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
class SubtitleTranscodingExtractor : Extractor
```

<br />

*** ** * ** ***

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

## Summary

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

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/extractor/Extractor!` | `[getUnderlyingImplementation](https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleTranscodingExtractor#getUnderlyingImplementation())()` **This function is deprecated.** Deprecated in Java |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[init](https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleTranscodingExtractor#init(androidx.media3.extractor.ExtractorOutput))(output: https://developer.android.com/reference/kotlin/androidx/media3/extractor/ExtractorOutput!)` **This function is deprecated.** Deprecated in Java |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `@https://developer.android.com/reference/kotlin/androidx/media3/extractor/Extractor.ReadResult [read](https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleTranscodingExtractor#read(androidx.media3.extractor.ExtractorInput,androidx.media3.extractor.PositionHolder))(input: https://developer.android.com/reference/kotlin/androidx/media3/extractor/ExtractorInput!, seekPosition: https://developer.android.com/reference/kotlin/androidx/media3/extractor/PositionHolder!)` **This function is deprecated.** Deprecated in Java |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[release](https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleTranscodingExtractor#release())()` **This function is deprecated.** Deprecated in Java |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[seek](https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleTranscodingExtractor#seek(long,long))(position: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, timeUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)` **This function is deprecated.** Deprecated in Java |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `[sniff](https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleTranscodingExtractor#sniff(androidx.media3.extractor.ExtractorInput))(input: https://developer.android.com/reference/kotlin/androidx/media3/extractor/ExtractorInput!)` **This function is deprecated.** Deprecated in Java |

### Inherited Constants

From [androidx.media3.extractor.Extractor](https://developer.android.com/reference/kotlin/androidx/media3/extractor/Extractor) `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/extractor/Extractor#RESULT_CONTINUE() = 0`

**This property is deprecated.** Deprecated in Java
`const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/extractor/Extractor#RESULT_END_OF_INPUT() = -1`

**This property is deprecated.** Deprecated in Java
`const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/extractor/Extractor#RESULT_SEEK() = 1`

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

### Inherited functions

From [androidx.media3.extractor.Extractor](https://developer.android.com/reference/kotlin/androidx/media3/extractor/Extractor) `(https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-list/index.html)https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/media3/extractor/SniffFailure!>!` `[getSniffFailureDetails](https://developer.android.com/reference/kotlin/androidx/media3/extractor/Extractor#getSniffFailureDetails())()`

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

## Public constructors

### SubtitleTranscodingExtractor

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

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

## Public functions

### getUnderlyingImplementation

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

> [!CAUTION]
> **This function 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

```
fun [init](https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleTranscodingExtractor#init(androidx.media3.extractor.ExtractorOutput))(output: ExtractorOutput!): Unit
```

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

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

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

### read

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

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

Extracts data read from a provided `https://developer.android.com/reference/kotlin/androidx/media3/extractor/ExtractorInput`. Must not be called before `https://developer.android.com/reference/kotlin/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/kotlin/androidx/media3/extractor/Extractor#RESULT_CONTINUE()` is returned to indicate that the `https://developer.android.com/reference/kotlin/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/kotlin/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/kotlin/androidx/media3/extractor/ExtractorInput`, then `https://developer.android.com/reference/kotlin/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/kotlin/androidx/media3/extractor/ExtractorInput` with an unchanged `https://developer.android.com/reference/kotlin/androidx/media3/extractor/ExtractorInput#getPosition()` to a subsequent call to this method.

| Parameters |
|---|---|
| `input: https://developer.android.com/reference/kotlin/androidx/media3/extractor/ExtractorInput!` | The `https://developer.android.com/reference/kotlin/androidx/media3/extractor/ExtractorInput` from which data should be read. |
| `seekPosition: https://developer.android.com/reference/kotlin/androidx/media3/extractor/PositionHolder!` | If `https://developer.android.com/reference/kotlin/androidx/media3/extractor/Extractor#RESULT_SEEK()` is returned, this holder is updated to hold the position of the required data. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | 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

```
fun [release](https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleTranscodingExtractor#release())(): Unit
```

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

Releases all kept resources.

### seek

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

> [!CAUTION]
> **This function 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/kotlin/androidx/media3/extractor/ExtractorInput` passed to the next invocation of `https://developer.android.com/reference/kotlin/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/kotlin/androidx/media3/extractor/SeekMap` passed to the `https://developer.android.com/reference/kotlin/androidx/media3/extractor/ExtractorOutput`.

| Parameters |
|---|---|
| `position: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The byte offset in the stream from which data will be provided. |
| `timeUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The seek time in microseconds. |

### sniff

```
fun [sniff](https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleTranscodingExtractor#sniff(androidx.media3.extractor.ExtractorInput))(input: ExtractorInput!): Boolean
```

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

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

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | 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. |