# StatsDataSource

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

*** ** * ** ***


```
@UnstableApi
public final class StatsDataSource implements DataSource
```

<br />

*** ** * ** ***

`https://developer.android.com/reference/androidx/media3/datasource/DataSource` wrapper which keeps track of bytes transferred, redirected uris, and response headers.

## Summary

| ### Public fields |
|---|---|
| `long` | `https://developer.android.com/reference/androidx/media3/datasource/StatsDataSource#bytesRead()` |
| `https://developer.android.com/reference/android/net/Uri.html` | `https://developer.android.com/reference/androidx/media3/datasource/StatsDataSource#lastOpenedUri()` |
| `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/datasource/StatsDataSource#lastResponseHeaders()` |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/media3/datasource/StatsDataSource#StatsDataSource(androidx.media3.datasource.DataSource)(https://developer.android.com/reference/androidx/media3/datasource/DataSource dataSource)` Creates the stats data source. |

| ### Public methods |
|---|---|
| `void` | `https://developer.android.com/reference/androidx/media3/datasource/StatsDataSource#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. |
| `void` | `https://developer.android.com/reference/androidx/media3/datasource/StatsDataSource#close()()` Closes the source. |
| `long` | `https://developer.android.com/reference/androidx/media3/datasource/StatsDataSource#getBytesRead()()` Returns the total number of bytes that have been read from the data source. |
| `https://developer.android.com/reference/android/net/Uri.html` | `https://developer.android.com/reference/androidx/media3/datasource/StatsDataSource#getLastOpenedUri()()` Returns the `https://developer.android.com/reference/android/net/Uri.html` associated with the last `https://developer.android.com/reference/androidx/media3/datasource/StatsDataSource#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/datasource/StatsDataSource#getLastResponseHeaders()()` Returns the response headers associated with the last `https://developer.android.com/reference/androidx/media3/datasource/StatsDataSource#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/datasource/StatsDataSource#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/datasource/StatsDataSource#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/datasource/StatsDataSource#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/datasource/StatsDataSource#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/datasource/StatsDataSource#resetBytesRead()()` Resets the number of bytes read as returned from `https://developer.android.com/reference/androidx/media3/datasource/StatsDataSource#getBytesRead()` to zero. |

## Public fields

### bytesRead

```
public long bytesRead
```

### lastOpenedUri

```
public Uri lastOpenedUri
```

### lastResponseHeaders

```
public Map<String, List<String>> lastResponseHeaders
```

## Public constructors

### StatsDataSource

```
public StatsDataSource(DataSource dataSource)
```

Creates the stats data source.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/media3/datasource/DataSource dataSource` | The wrapped `https://developer.android.com/reference/androidx/media3/datasource/DataSource`. |

## Public methods

### addTransferListener

```
public void addTransferListener(TransferListener transferListener)
```

Adds a `https://developer.android.com/reference/androidx/media3/datasource/TransferListener` to listen to data transfers. This method is not thread-safe.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/media3/datasource/TransferListener transferListener` | A `https://developer.android.com/reference/androidx/media3/datasource/TransferListener`. |

### close

```
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. |

### getBytesRead

```
public long getBytesRead()
```

Returns the total number of bytes that have been read from the data source.

### getLastOpenedUri

```
public Uri getLastOpenedUri()
```

Returns the `https://developer.android.com/reference/android/net/Uri.html` associated with the last `https://developer.android.com/reference/androidx/media3/datasource/StatsDataSource#open(androidx.media3.datasource.DataSpec)` call. If redirection occurred, this is the redirected uri. Returns `https://developer.android.com/reference/android/net/Uri.html#EMPTY` if `https://developer.android.com/reference/androidx/media3/datasource/StatsDataSource#open(androidx.media3.datasource.DataSpec)` has never been called.

### getLastResponseHeaders

```
public Map<String, List<String>> getLastResponseHeaders()
```

Returns the response headers associated with the last `https://developer.android.com/reference/androidx/media3/datasource/StatsDataSource#open(androidx.media3.datasource.DataSpec)` call.

### getResponseHeaders

```
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

```
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

```
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. |

### read

```
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. |

### resetBytesRead

```
public void resetBytesRead()
```

Resets the number of bytes read as returned from `https://developer.android.com/reference/androidx/media3/datasource/StatsDataSource#getBytesRead()` to zero.