# DefaultHttpDataSource

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

*** ** * ** ***

<br />

```
class DefaultHttpDataSource : BaseDataSource, HttpDataSource
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.media3.datasource.BaseDataSource](https://developer.android.com/reference/kotlin/androidx/media3/datasource/BaseDataSource) ||
|   | ↳ | [androidx.media3.datasource.DefaultHttpDataSource](https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource) |

*** ** * ** ***

An `https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource` that uses Android's `https://developer.android.com/reference/java/net/HttpURLConnection.html`.

By default this implementation will not follow cross-protocol redirects (i.e. redirects from HTTP to HTTPS or vice versa). Cross-protocol redirects can be enabled by passing `true` to `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource.Factory#setAllowCrossProtocolRedirects(boolean)`.

Note: HTTP request headers will be set using all parameters passed via (in order of decreasing priority) the `dataSpec`, `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource#setRequestProperty(java.lang.String,java.lang.String)` and the default properties that can be passed to `https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource.Factory#setDefaultRequestProperties(java.util.Map<java.lang.String,java.lang.String>)`.

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource.Factory : https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource.Factory` `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSource.Factory` for `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource` instances. |

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource#DEFAULT_CONNECT_TIMEOUT_MILLIS() = 8000` The default connection timeout, in milliseconds. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource#DEFAULT_READ_TIMEOUT_MILLIS() = 8000` The default read timeout, in milliseconds. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource#clearAllRequestProperties()()` Clears all request headers that were set by `https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource#setRequestProperty(java.lang.String,java.lang.String)`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource#clearRequestProperty(java.lang.String)(name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!)` Clears the value of a request header. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource#close()()` Closes the source. |
| `(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.collections/-mutable-list/index.html)https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!>!>!` | `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource#getResponseHeaders()()` When the source is open, returns the response headers associated with the last `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSource#open(androidx.media3.datasource.DataSpec)` call. |
| `https://developer.android.com/reference/android/net/Uri.html?` | `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource#getUri()()` When the source is open, returns the `https://developer.android.com/reference/android/net/Uri.html` from which data is being read. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource#open(androidx.media3.datasource.DataSpec)(dataSpec: https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSpec!)` Opens the source to read the specified data. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource#read(byte[],int,int)(buffer: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte/index.html>!, offset: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, length: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Reads up to `length` bytes of data from the input. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource#setRequestProperty(java.lang.String,java.lang.String)(name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!, value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!)` Sets the value of a request header. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DefaultHttpDataSource#responseCode()` |

### Inherited Constants

From [androidx.media3.datasource.HttpDataSource](https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource) `const 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!>!` `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi
https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource#REJECT_PAYWALL_TYPES()`

A `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/base/Predicate.html` that rejects content types often used for pay-walls.

### Inherited functions

From [androidx.media3.datasource.BaseDataSource](https://developer.android.com/reference/kotlin/androidx/media3/datasource/BaseDataSource) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `@https://developer.android.com/reference/kotlin/androidx/media3/common/util/UnstableApi
https://developer.android.com/reference/kotlin/androidx/media3/datasource/BaseDataSource#addTransferListener(androidx.media3.datasource.TransferListener)(transferListener: https://developer.android.com/reference/kotlin/androidx/media3/datasource/TransferListener!)`

Adds a `https://developer.android.com/reference/kotlin/androidx/media3/datasource/TransferListener` to listen to data transfers.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/datasource/BaseDataSource#bytesTransferred(int)(bytesTransferred: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`

Notifies listeners that bytes were transferred.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/datasource/BaseDataSource#transferEnded()()`

Notifies listeners that a transfer ended.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/datasource/BaseDataSource#transferInitializing(androidx.media3.datasource.DataSpec)(dataSpec: https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSpec!)`

Notifies listeners that data transfer for the specified `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSpec` is being initialized.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/kotlin/androidx/media3/datasource/BaseDataSource#transferStarted(androidx.media3.datasource.DataSpec)(dataSpec: https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSpec!)`

Notifies listeners that data transfer for the specified `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSpec` started.

## Constants

### DEFAULT_CONNECT_TIMEOUT_MILLIS

```
@UnstableApi
const val DEFAULT_CONNECT_TIMEOUT_MILLIS = 8000: Int
```

The default connection timeout, in milliseconds.

### DEFAULT_READ_TIMEOUT_MILLIS

```
@UnstableApi
const val DEFAULT_READ_TIMEOUT_MILLIS = 8000: Int
```

The default read timeout, in milliseconds.

## Public functions

### clearAllRequestProperties

```
@UnstableApi
fun clearAllRequestProperties(): Unit
```

Clears all request headers that were set by `https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource#setRequestProperty(java.lang.String,java.lang.String)`.

### clearRequestProperty

```
@UnstableApi
fun clearRequestProperty(name: String!): Unit
```

Clears the value of a request header. The change will apply to subsequent connections established by the source.

| Parameters |
|---|---|
| `name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | The name of the header field. |

### close

```
@UnstableApi
fun close(): Unit
```

Closes the source. This method must be called even if the corresponding call to `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSource#open(androidx.media3.datasource.DataSpec)` threw an `https://developer.android.com/reference/java/io/IOException.html`.

| Throws |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` | If an error occurs closing the source. |
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource.HttpDataSourceException` |   |

### getResponseHeaders

```
@UnstableApi
fun getResponseHeaders(): (Mutable)Map<String!, (Mutable)List<String!>!>!
```

When the source is open, returns the response headers associated with the last `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSource#open(androidx.media3.datasource.DataSpec)` call. Otherwise, returns an empty map.

Key look-up in the returned map is case-insensitive.

### getUri

```
@UnstableApi
fun getUri(): Uri?
```

When the source is open, returns the `https://developer.android.com/reference/android/net/Uri.html` from which data is being read. The returned `https://developer.android.com/reference/android/net/Uri.html` will be identical to the one passed `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSource#open(androidx.media3.datasource.DataSpec)` in the `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSpec` unless redirection has occurred. If redirection has occurred, the `https://developer.android.com/reference/android/net/Uri.html` after redirection is returned.

| Returns |
|---|---|
| `https://developer.android.com/reference/android/net/Uri.html?` | The `https://developer.android.com/reference/android/net/Uri.html` from which data is being read, or null if the source is not open. |

### open

```
@UnstableApi
fun open(dataSpec: DataSpec!): Long
```

Opens the source to read the specified data.

| Throws |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource.HttpDataSourceException` |   |

### read

```
@UnstableApi
fun read(buffer: ByteArray<Byte>!, offset: Int, length: Int): Int
```

Reads up to `length` bytes of data from the input.

If `readLength` is zero then 0 is returned. Otherwise, if no data is available because the end of the opened range has been reached, then `https://developer.android.com/reference/kotlin/androidx/media3/common/C#RESULT_END_OF_INPUT()` is returned. Otherwise, the call will block until at least one byte of data has been read and the number of bytes read is returned.

| Parameters |
|---|---|
| `buffer: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte/index.html>!` | A target array into which data should be written. |
| `offset: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The offset into the target array at which to write. |
| `length: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The maximum number of bytes to read from the input. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The number of bytes read, or `https://developer.android.com/reference/kotlin/androidx/media3/common/C#RESULT_END_OF_INPUT()` if the input has ended. This may be less than `length` because the end of the input (or available data) was reached, the method was interrupted, or the operation was aborted early for another reason. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` | If an error occurs reading from the input. |
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource.HttpDataSourceException` |   |

### setRequestProperty

```
@UnstableApi
fun setRequestProperty(name: String!, value: String!): Unit
```

Sets the value of a request header. The value will be used for subsequent connections established by the source.

Note: If the same header is set as a default parameter in the `https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource.Factory`, then the header value set with this method should be preferred when connecting with the data source. See `https://developer.android.com/reference/kotlin/androidx/media3/datasource/HttpDataSource#open(androidx.media3.datasource.DataSpec)`.

| Parameters |
|---|---|
| `name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | The name of the header field. |
| `value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | The value of the field. |

## Public properties

### responseCode

```
val responseCode: Int
```