# OkHttpDataSource.Factory

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

*** ** * ** ***


```
class OkHttpDataSource.Factory : HttpDataSource.Factory
```

<br />

*** ** * ** ***

`https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSource.Factory` for `https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource` instances.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory#Factory(Call.Factory)(callFactory: Factory!)` Creates an instance. |

| ### Public functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource!` | `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory#createDataSource()()` Creates a `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSource` instance. |
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory!` | `@https://checkerframework.org/api/com/google/errorprone/annotations/CanIgnoreReturnValue.html @https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory#setCacheControl(CacheControl)(cacheControl: CacheControl?)` Sets the CacheControl that will be used. |
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory!` | `@https://checkerframework.org/api/com/google/errorprone/annotations/CanIgnoreReturnValue.html @https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory#setContentTypePredicate(com.google.common.base.Predicate<java.lang.String>)(contentTypePredicate: https://guava.dev/releases/snapshot-android/api/docs/com/google/common/base/Predicate.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!>?)` Sets a content type `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/base/Predicate.html`. |
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory!` | `@https://checkerframework.org/api/com/google/errorprone/annotations/CanIgnoreReturnValue.html @https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory#setDefaultRequestProperties(java.util.Map<java.lang.String,java.lang.String>)( defaultRequestProperties: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-map/index.html)https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!>! )` Sets the default request headers for `https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource` instances created by the factory. |
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory!` | `@https://checkerframework.org/api/com/google/errorprone/annotations/CanIgnoreReturnValue.html @https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory#setTransferListener(androidx.media3.datasource.TransferListener)(transferListener: https://developer.android.com/reference/kotlin/androidx/media3/datasource/TransferListener?)` Sets the `https://developer.android.com/reference/kotlin/androidx/media3/datasource/TransferListener` that will be used. |
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory!` | `@https://checkerframework.org/api/com/google/errorprone/annotations/CanIgnoreReturnValue.html https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory#setUserAgent(java.lang.String)(userAgent: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?)` Sets the user agent that will be used. |

### Inherited functions

From [androidx.media3.datasource.DataSource.Factory](https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSource.Factory) `abstract https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSource!` `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi
https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSource.Factory#createDataSource()()`

Creates a `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSource` instance.

## Public constructors

### Factory

```
Factory(callFactory: Factory!)
```

Creates an instance.

| Parameters |
|---|---|
| `callFactory: Factory!` | A Call.Factory (typically an OkHttpClient) for use by the sources created by the factory. |

## Public functions

### createDataSource

```
@UnstableApi
fun createDataSource(): OkHttpDataSource!
```

Creates a `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSource` instance.

### setCacheControl

```
@CanIgnoreReturnValue
@UnstableApi
fun setCacheControl(cacheControl: CacheControl?): OkHttpDataSource.Factory!
```

Sets the CacheControl that will be used.

The default is `null`.

| Parameters |
|---|---|
| `cacheControl: CacheControl?` | The cache control that will be used. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory!` | This factory. |

### setContentTypePredicate

```
@CanIgnoreReturnValue
@UnstableApi
fun setContentTypePredicate(contentTypePredicate: Predicate<String!>?): OkHttpDataSource.Factory!
```

Sets a content type `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/base/Predicate.html`. If a content type is rejected by the predicate then a `https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource.InvalidContentTypeException` is thrown from `https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource#open(androidx.media3.datasource.DataSpec)`.

The default is `null`.

| Parameters |
|---|---|
| `contentTypePredicate: https://guava.dev/releases/snapshot-android/api/docs/com/google/common/base/Predicate.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!>?` | The content type `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/base/Predicate.html`, or `null` to clear a predicate that was previously set. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory!` | This factory. |

### setDefaultRequestProperties

```
@CanIgnoreReturnValue
@UnstableApi
fun setDefaultRequestProperties(
    defaultRequestProperties: (Mutable)Map<String!, String!>!
): OkHttpDataSource.Factory!
```

Sets the default request headers for `https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource` instances created by the factory.

The new request properties will be used for future requests made by `https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource` created by the factory, including instances that have already been created. Modifying the `defaultRequestProperties` map after a call to this method will have no effect, and so it's necessary to call this method again each time the request properties need to be updated.

| Parameters |
|---|---|
| `defaultRequestProperties: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-map/index.html)https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!>!` | The default request properties. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory!` | This factory. |

### setTransferListener

```
@CanIgnoreReturnValue
@UnstableApi
fun setTransferListener(transferListener: TransferListener?): OkHttpDataSource.Factory!
```

Sets the `https://developer.android.com/reference/kotlin/androidx/media3/datasource/TransferListener` that will be used.

The default is `null`.

See `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSource#addTransferListener(androidx.media3.datasource.TransferListener)`.

| Parameters |
|---|---|
| `transferListener: https://developer.android.com/reference/kotlin/androidx/media3/datasource/TransferListener?` | The listener that will be used. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory!` | This factory. |

### setUserAgent

```
@CanIgnoreReturnValue
fun setUserAgent(userAgent: String?): OkHttpDataSource.Factory!
```

Sets the user agent that will be used.

The default is `null`, which causes the default user agent of the underlying OkHttpClient to be used.

| Parameters |
|---|---|
| `userAgent: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | The user agent that will be used, or `null` to use the default user agent of the underlying OkHttpClient. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/okhttp/OkHttpDataSource.Factory!` | This factory. |