ContentDataSource

@UnstableApi
class ContentDataSource : BaseDataSource

kotlin.Any
   ↳ androidx.media3.datasource.BaseDataSource
     ↳ androidx.media3.datasource.ContentDataSource

A DataSource for reading from a content URI.

Summary

Nested types

Thrown when an IOException is encountered reading from a content URI.

Public constructors

Public functions
Unit

Closes the source.
Long
open(dataSpec: DataSpec!)

Opens the source to read the specified data.
Int
read(buffer: ByteArray!, offset: Int, length: Int)

Reads up to length bytes of data from the input.

Public properties
Uri?

Inherited functions
From androidx.media3.datasource.BaseDataSource
Unit

Adds a TransferListener to listen to data transfers.
Unit
bytesTransferred(bytesTransferred: Int)

Notifies listeners that bytes were transferred.
Unit

Notifies listeners that a transfer ended.
Unit

Notifies listeners that data transfer for the specified DataSpec is being initialized.
Unit

Notifies listeners that data transfer for the specified DataSpec started.
From androidx.media3.datasource.DataSource
(Mutable)Map<String!, (Mutable)List<String!>!>!

When the source is open, returns the response headers associated with the last open call.

Public constructors

ContentDataSource

ContentDataSource(context: Context!)
Parameters
context: Context!

A context.

Public functions

close

fun close(): Unit

Closes the source. This method must be called even if the corresponding call to open threw an IOException.

Throws
java.io.IOException

If an error occurs closing the source.
androidx.media3.datasource.ContentDataSource.ContentDataSourceException

open

fun open(dataSpec: DataSpec!): Long

Opens the source to read the specified data. If an IOException is thrown, callers must still call close to ensure that any partial effects of the invocation are cleaned up.

The following edge case behaviors apply:

Parameters
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 length equals LENGTH_UNSET) this value is the resolved length of the request, or LENGTH_UNSET if the length is still unresolved. For all other requests, the value returned will be equal to the request's length.
Throws
java.io.IOException

If an error occurs opening the source. DataSourceException can be thrown or used as a cause of the thrown exception to specify the reason of the error.
androidx.media3.datasource.ContentDataSource.ContentDataSourceException

read

fun read(buffer: ByteArray!, 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 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: ByteArray!

A target array into which data should be written.
offset: Int

The offset into the target array at which to write.
length: Int

The maximum number of bytes to read from the input.
Returns
Int

The number of bytes read, or 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
java.io.IOException

If an error occurs reading from the input.
androidx.media3.datasource.ContentDataSource.ContentDataSourceException

Public properties

uri

val uri: Uri?