# HttpEngineDataSource

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/HttpEngineDataSource.java+class:androidx.media3.datasource.HttpEngineDataSource)

*** ** * ** ***

<br />

```
@RequiresExtension(extension = Build.VERSION_CODES.S, version = 7)
@UnstableApi
public final class HttpEngineDataSource extends BaseDataSource implements HttpDataSource
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.media3.datasource.BaseDataSource](https://developer.android.com/reference/androidx/media3/datasource/BaseDataSource) ||
|   | ↳ | [androidx.media3.datasource.HttpEngineDataSource](https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource) |

*** ** * ** ***

DataSource without intermediate buffer based on `https://developer.android.com/reference/android/net/http/HttpEngine.html` set using `https://developer.android.com/reference/android/net/http/UrlRequest.html`.

Note: HTTP request headers will be set using all parameters passed via (in order of decreasing priority) the `dataSpec`, `https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource#setRequestProperty(java.lang.String,java.lang.String)` and the default parameters used to construct the instance.

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource.Factory implements https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.Factory` `https://developer.android.com/reference/androidx/media3/datasource/DataSource.Factory` for `https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource` instances. |
| `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi public final class https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource.OpenException extends https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.HttpDataSourceException` Thrown when an error is encountered when trying to open a `https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource`. |

| ### Constants |
|---|---|
| `static final int` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource#DEFAULT_CONNECT_TIMEOUT_MILLIS() = 8000` The default connection timeout, in milliseconds. |
| `static final int` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource#DEFAULT_READ_TIMEOUT_MILLIS() = 8000` The default read timeout, in milliseconds. |

| ### Public methods |
|---|---|
| `void` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource#clearAllRequestProperties()()` Clears all request headers that were set by `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#setRequestProperty(java.lang.String,java.lang.String)`. |
| `void` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource#clearRequestProperty(java.lang.String)(https://developer.android.com/reference/java/lang/String.html name)` Clears the value of a request header. |
| `synchronized void` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource#close()()` Closes the source. |
| `int` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource#getResponseCode()()` When the source is open, returns the HTTP response status code associated with the last `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#open(androidx.media3.datasource.DataSpec)` call. |
| `https://developer.android.com/reference/java/util/Map.html<https://developer.android.com/reference/java/lang/String.html, https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/String.html>>` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource#getResponseHeaders()()` When the source is open, returns the response headers associated with the last `https://developer.android.com/reference/androidx/media3/datasource/DataSource#open(androidx.media3.datasource.DataSpec)` call. |
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/net/Uri.html` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource#getUri()()` When the source is open, returns the `https://developer.android.com/reference/android/net/Uri.html` from which data is being read. |
| `long` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource#open(androidx.media3.datasource.DataSpec)(https://developer.android.com/reference/androidx/media3/datasource/DataSpec dataSpec)` Opens the source to read the specified data. |
| `int` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource#read(java.nio.ByteBuffer)(https://developer.android.com/reference/java/nio/ByteBuffer.html buffer)` Reads up to `buffer.remaining()` bytes of data and stores them into `buffer`, starting at `buffer.position()`. |
| `int` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource#read(byte[],int,int)(byte[] buffer, int offset, int length)` Reads up to `length` bytes of data from the input. |
| `void` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/datasource/HttpEngineDataSource#setRequestProperty(java.lang.String,java.lang.String)(https://developer.android.com/reference/java/lang/String.html name, https://developer.android.com/reference/java/lang/String.html value)` Sets the value of a request header. |

### Inherited Constants

From [androidx.media3.datasource.HttpDataSource](https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource) `static final https://guava.dev/releases/snapshot-android/api/docs/com/google/common/base/Predicate.html<https://developer.android.com/reference/java/lang/String.html>` `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi
https://developer.android.com/reference/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 methods

From [androidx.media3.datasource.BaseDataSource](https://developer.android.com/reference/androidx/media3/datasource/BaseDataSource) `final void` `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi
https://developer.android.com/reference/androidx/media3/datasource/BaseDataSource#addTransferListener(androidx.media3.datasource.TransferListener)(https://developer.android.com/reference/androidx/media3/datasource/TransferListener transferListener)`

Adds a `https://developer.android.com/reference/androidx/media3/datasource/TransferListener` to listen to data transfers.
`final void` `https://developer.android.com/reference/androidx/media3/datasource/BaseDataSource#bytesTransferred(int)(int bytesTransferred)`

Notifies listeners that bytes were transferred.
`final void` `https://developer.android.com/reference/androidx/media3/datasource/BaseDataSource#transferEnded()()`

Notifies listeners that a transfer ended.
`final void` `https://developer.android.com/reference/androidx/media3/datasource/BaseDataSource#transferInitializing(androidx.media3.datasource.DataSpec)(https://developer.android.com/reference/androidx/media3/datasource/DataSpec dataSpec)`

Notifies listeners that data transfer for the specified `https://developer.android.com/reference/androidx/media3/datasource/DataSpec` is being initialized.
`final void` `https://developer.android.com/reference/androidx/media3/datasource/BaseDataSource#transferStarted(androidx.media3.datasource.DataSpec)(https://developer.android.com/reference/androidx/media3/datasource/DataSpec dataSpec)`

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

## Constants

### DEFAULT_CONNECT_TIMEOUT_MILLIS

```
@UnstableApi
public static final int DEFAULT_CONNECT_TIMEOUT_MILLIS = 8000
```

The default connection timeout, in milliseconds.

### DEFAULT_READ_TIMEOUT_MILLIS

```
@UnstableApi
public static final int DEFAULT_READ_TIMEOUT_MILLIS = 8000
```

The default read timeout, in milliseconds.

## Public methods

### clearAllRequestProperties

```
@UnstableApi
public void clearAllRequestProperties()
```

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

### clearRequestProperty

```
@UnstableApi
public void clearRequestProperty(String name)
```

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

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html name` | The name of the header field. |

### close

```
@UnstableApi
synchronized public void close()
```

Closes the source. This method must be called even if the corresponding call to `https://developer.android.com/reference/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. |

### getResponseCode

```
@UnstableApi
public int getResponseCode()
```

When the source is open, returns the HTTP response status code associated with the last `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource#open(androidx.media3.datasource.DataSpec)` call. Otherwise, returns a negative value.

### getResponseHeaders

```
@UnstableApi
public Map<String, List<String>> getResponseHeaders()
```

When the source is open, returns the response headers associated with the last `https://developer.android.com/reference/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
public @Nullable Uri getUri()
```

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/androidx/media3/datasource/DataSource#open(androidx.media3.datasource.DataSpec)` in the `https://developer.android.com/reference/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/androidx/annotation/Nullable 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
public long open(DataSpec dataSpec)
```

Opens the source to read the specified data. If an `https://developer.android.com/reference/java/io/IOException.html` is thrown, callers must still call `https://developer.android.com/reference/androidx/media3/datasource/DataSource#close()` to ensure that any partial effects of the invocation are cleaned up.

The following edge case behaviors apply:

- If the `https://developer.android.com/reference/androidx/media3/datasource/DataSpec#position()` is within the resource, but the `https://developer.android.com/reference/androidx/media3/datasource/DataSpec#length()` extends beyond the end of the resource, then `https://developer.android.com/reference/androidx/media3/datasource/DataSource#open(androidx.media3.datasource.DataSpec)` will succeed and data from the requested position to the end of the resource will be made available through `https://developer.android.com/reference/androidx/media3/common/DataReader#read(byte[],int,int)`.
- If the `https://developer.android.com/reference/androidx/media3/datasource/DataSpec#position()` is equal to the length of the resource, then `https://developer.android.com/reference/androidx/media3/datasource/DataSource#open(androidx.media3.datasource.DataSpec)` will succeed, and `https://developer.android.com/reference/androidx/media3/common/DataReader#read(byte[],int,int)` will immediately return `https://developer.android.com/reference/androidx/media3/common/C#RESULT_END_OF_INPUT()`.
- If the `https://developer.android.com/reference/androidx/media3/datasource/DataSpec#position()` is greater than the length of the resource, then `https://developer.android.com/reference/androidx/media3/datasource/DataSource#open(androidx.media3.datasource.DataSpec)` will throw an `https://developer.android.com/reference/java/io/IOException.html` for which `https://developer.android.com/reference/androidx/media3/datasource/DataSourceException#isCausedByPositionOutOfRange(java.io.IOException)` will be `true`.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/media3/datasource/DataSpec dataSpec` | Defines the data to be read. |

| Returns |
|---|---|
| `long` | The number of bytes that can be read from the opened source. For unbounded requests (i.e., requests where `https://developer.android.com/reference/androidx/media3/datasource/DataSpec#length()` equals `https://developer.android.com/reference/androidx/media3/common/C#LENGTH_UNSET()`) this value is the resolved length of the request, or `https://developer.android.com/reference/androidx/media3/common/C#LENGTH_UNSET()` if the length is still unresolved. For all other requests, the value returned will be equal to the request's `https://developer.android.com/reference/androidx/media3/datasource/DataSpec#length()`. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` | If an error occurs opening the source. `https://developer.android.com/reference/androidx/media3/datasource/DataSourceException` can be thrown or used as a cause of the thrown exception to specify the reason of the error. |
| `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.HttpDataSourceException` |   |

### read

```
@UnstableApi
public int read(ByteBuffer buffer)
```

Reads up to `buffer.remaining()` bytes of data and stores them into `buffer`, starting at `buffer.position()`. Advances the position of the buffer by the number of bytes read and returns this length.

If there is an error, a `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.HttpDataSourceException` is thrown and the contents of ` buffer` should be ignored. If the exception has error code ` HttpDataSourceException.TYPE_READ`, note that HttpEngine may continue writing into ` buffer` after the method has returned. Thus the caller should not attempt to reuse the buffer.

If `buffer.remaining()` 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/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.

Passed buffer must be direct ByteBuffer. If you have a non-direct ByteBuffer, consider the alternative read method with its backed array.

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/nio/ByteBuffer.html buffer` | The ByteBuffer into which the read data should be stored. Must be a direct ByteBuffer. |

| Returns |
|---|---|
| `int` | The number of bytes read, or `https://developer.android.com/reference/androidx/media3/common/C#RESULT_END_OF_INPUT()` if no data is available because the end of the opened range has been reached. |

| Throws |
|---|---|
| `https://developer.android.com/reference/androidx/media3/datasource/HttpDataSource.HttpDataSourceException` | If an error occurs reading from the source. |
| `https://developer.android.com/reference/java/lang/IllegalArgumentException.html` | If `buffer` is not a direct ByteBuffer. |

### read

```
@UnstableApi
public int read(byte[] buffer, int offset, int length)
```

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/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 |
|---|---|
| `byte[] buffer` | A target array into which data should be written. |
| `int offset` | The offset into the target array at which to write. |
| `int length` | The maximum number of bytes to read from the input. |

| Returns |
|---|---|
| `int` | The number of bytes read, or `https://developer.android.com/reference/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/androidx/media3/datasource/HttpDataSource.HttpDataSourceException` |   |

### setRequestProperty

```
@UnstableApi
public void setRequestProperty(String name, String value)
```

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/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/androidx/media3/datasource/HttpDataSource#open(androidx.media3.datasource.DataSpec)`.

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html name` | The name of the header field. |
| `https://developer.android.com/reference/java/lang/String.html value` | The value of the field. |