# DataSink

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

*** ** * ** ***

<br />

```
@UnstableApi
interface DataSink
```

<br />

Known direct subclasses [AesCipherDataSink](https://developer.android.com/reference/kotlin/androidx/media3/datasource/AesCipherDataSink), [ByteArrayDataSink](https://developer.android.com/reference/kotlin/androidx/media3/datasource/ByteArrayDataSink), [CacheDataSink](https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheDataSink), [FailOnCloseDataSink](https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FailOnCloseDataSink)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/AesCipherDataSink` | A wrapping `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSink` that encrypts the data being consumed. |
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/ByteArrayDataSink` | A `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSink` for writing to a byte array. |
| `https://developer.android.com/reference/kotlin/androidx/media3/datasource/cache/CacheDataSink` | Writes data into a cache. |
| `https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FailOnCloseDataSink` | A `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSink` that can simulate caching the bytes being written to it, and then failing to persist them when `https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FailOnCloseDataSink#close()` is called. |

*** ** * ** ***

A component to which streams of data can be written.

## Summary

| ### Nested types |
|---|
| `interface https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSink.Factory` A factory for `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSink` instances. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSink#close()()` Closes the sink. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSink#open(androidx.media3.datasource.DataSpec)(dataSpec: https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSpec!)` Opens the sink to consume the specified data. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSink#write(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)` Consumes the provided data. |

## Public functions

### close

```
fun close(): Unit
```

Closes the sink.

Note: This method must be called even if the corresponding call to `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSink#open(androidx.media3.datasource.DataSpec)` threw an `https://developer.android.com/reference/java/io/IOException.html`. See `https://developer.android.com/reference/kotlin/androidx/media3/datasource/DataSink#open(androidx.media3.datasource.DataSpec)` for more details.

| Throws |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` | If an error occurs closing the sink. |

### open

```
fun open(dataSpec: DataSpec!): Unit
```

Opens the sink to consume the specified data.

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

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

| Throws |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` | If an error occurs opening the sink. |

### write

```
fun write(buffer: ByteArray<Byte>!, offset: Int, length: Int): Unit
```

Consumes the provided data.

| 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>!` | The buffer from which data should be consumed. |
| `offset: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The offset of the data to consume in `buffer`. |
| `length: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The length of the data to consume, in bytes. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` | If an error occurs writing to the sink. |