# SubtitleParser.Factory

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

*** ** * ** ***


```
interface SubtitleParser.Factory
```

<br />

Known direct subclasses [DefaultSubtitleParserFactory](https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/DefaultSubtitleParserFactory), [ThrowingSubtitleParserFactory](https://developer.android.com/reference/kotlin/androidx/media3/test/utils/ThrowingSubtitleParserFactory)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/DefaultSubtitleParserFactory` | A factory for `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser` instances. |
| `https://developer.android.com/reference/kotlin/androidx/media3/test/utils/ThrowingSubtitleParserFactory` | A `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser.Factory` for `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser` instances that throw an exception on every call to `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser#parse(byte[],androidx.media3.extractor.text.SubtitleParser.OutputOptions,java.util.function.Consumer<androidx.media3.extractor.text.CuesWithTiming>)`. |

*** ** * ** ***

Factory for `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser` instances.

## Summary

| ### Constants |
|---|---|
| `const https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser.Factory!` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser.Factory#UNSUPPORTED()` A subtitle parser factory that supports no formats. |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser!` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser.Factory#create(androidx.media3.common.Format)(format: https://developer.android.com/reference/kotlin/androidx/media3/common/Format!)` Creates a `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser` for the given `https://developer.android.com/reference/kotlin/androidx/media3/common/Format`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `@https://developer.android.com/reference/kotlin/androidx/media3/common/Format.CueReplacementBehavior https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser.Factory#getCueReplacementBehavior(androidx.media3.common.Format)(format: https://developer.android.com/reference/kotlin/androidx/media3/common/Format!)` Returns the `https://developer.android.com/reference/kotlin/androidx/media3/common/Format.CueReplacementBehavior` of the `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser` implementation that handles `format`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser.Factory#supportsFormat(androidx.media3.common.Format)(format: https://developer.android.com/reference/kotlin/androidx/media3/common/Format!)` Returns whether the factory is able to instantiate a `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser` for the given `https://developer.android.com/reference/kotlin/androidx/media3/common/Format`. |

## Constants

### UNSUPPORTED

```
const val UNSUPPORTED: SubtitleParser.Factory!
```

A subtitle parser factory that supports no formats.

## Public functions

### create

```
fun create(format: Format!): SubtitleParser!
```

Creates a `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser` for the given `https://developer.android.com/reference/kotlin/androidx/media3/common/Format`.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser!` | The `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser` instance. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException.html` | if `format` is `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser.Factory#supportsFormat(androidx.media3.common.Format)` by this factory. |

### getCueReplacementBehavior

```
@Format.CueReplacementBehavior
fun getCueReplacementBehavior(format: Format!): Int
```

Returns the `https://developer.android.com/reference/kotlin/androidx/media3/common/Format.CueReplacementBehavior` of the `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser` implementation that handles `format`.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The replacement behavior. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException.html` | if `format` is `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser.Factory#supportsFormat(androidx.media3.common.Format)` by this factory. |

### supportsFormat

```
fun supportsFormat(format: Format!): Boolean
```

Returns whether the factory is able to instantiate a `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser` for the given `https://developer.android.com/reference/kotlin/androidx/media3/common/Format`.

| Parameters |
|---|---|
| `format: https://developer.android.com/reference/kotlin/androidx/media3/common/Format!` | The `https://developer.android.com/reference/kotlin/androidx/media3/common/Format`. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether the factory can instantiate a suitable `https://developer.android.com/reference/kotlin/androidx/media3/extractor/text/SubtitleParser`. |