OkHttpDataSource

Artifact: androidx.media3:media3-datasource-okhttp

Kotlin |Java

class OkHttpDataSource : BaseDataSource, HttpDataSource

kotlin.Any
↳	androidx.media3.datasource.BaseDataSource
	↳	androidx.media3.datasource.okhttp.OkHttpDataSource

An HttpDataSource that delegates to Square's Call.Factory.

Note: HTTP request headers will be set using all parameters passed via (in order of decreasing priority) the dataSpec, setRequestProperty and the default parameters used to construct the instance.

Summary

Nested types
`class OkHttpDataSource.Factory : HttpDataSource.Factory` `DataSource.Factory` for `OkHttpDataSource` instances.

Public functions
`Unit`	`@UnstableApi clearAllRequestProperties()` Clears all request headers that were set by `setRequestProperty`.
`Unit`	`@UnstableApi clearRequestProperty(name: String!)` Clears the value of a request header.
`Unit`	`@UnstableApi close()` Closes the source.
`Int`	`@UnstableApi getResponseCode()` When the source is open, returns the HTTP response status code associated with the last `open` call.
`(Mutable)Map<String!, (Mutable)List<String!>!>!`	`@UnstableApi getResponseHeaders()` When the source is open, returns the response headers associated with the last `open` call.
`Uri?`	`@UnstableApi getUri()` When the source is open, returns the `Uri` from which data is being read.
`Long`	`@UnstableApi open(dataSpec: DataSpec!)` Opens the source to read the specified data.
`Int`	`@UnstableApi read(buffer: ByteArray!, offset: Int, length: Int)` Reads up to `length` bytes of data from the input.
`Unit`	`@UnstableApi setRequestProperty(name: String!, value: String!)` Sets the value of a request header.

Inherited Constants

From androidx.media3.datasource.HttpDataSource

const Predicate<String!>!

@UnstableApi
REJECT_PAYWALL_TYPES

A Predicate that rejects content types often used for pay-walls.

Inherited functions

From androidx.media3.datasource.BaseDataSource

`Unit`	`@UnstableApi addTransferListener(transferListener: TransferListener!)` Adds a `TransferListener` to listen to data transfers.
`Unit`	`bytesTransferred(bytesTransferred: Int)` Notifies listeners that bytes were transferred.
`Unit`	`transferEnded()` Notifies listeners that a transfer ended.
`Unit`	`transferInitializing(dataSpec: DataSpec!)` Notifies listeners that data transfer for the specified `DataSpec` is being initialized.
`Unit`	`transferStarted(dataSpec: DataSpec!)` Notifies listeners that data transfer for the specified `DataSpec` started.

Public functions

clearAllRequestProperties

@UnstableApi
fun clearAllRequestProperties(): Unit

Clears all request headers that were set by setRequestProperty.

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: String!`	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 open threw an IOException.

Throws
`java.io.IOException`	If an error occurs closing the source.

getResponseCode

@UnstableApi
fun getResponseCode(): Int

When the source is open, returns the HTTP response status code associated with the last open call. Otherwise, returns a negative value.

getResponseHeaders

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

When the source is open, returns the response headers associated with the last open 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 Uri from which data is being read. The returned Uri will be identical to the one passed open in the DataSpec unless redirection has occurred. If redirection has occurred, the Uri after redirection is returned.

Returns
`Uri?`	The `Uri` 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. 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:

If the requested position is within the resource, but the requested length extends beyond the end of the resource, then open will succeed and data from the requested position to the end of the resource will be made available through read.
If the requested position is equal to the length of the resource, then open will succeed, and read will immediately return RESULT_END_OF_INPUT.
If the requested position is greater than the length of the resource, then open will throw an IOException for which isCausedByPositionOutOfRange will be true.

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

read

@UnstableApi
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.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 Factory, then the header value set with this method should be preferred when connecting with the data source. See open.

Parameters
`name: String!`	The name of the header field.
`value: String!`	The value of the field.

OkHttpDataSource

Summary

Nested types

Public functions

Inherited Constants

Inherited functions

Public functions

clearAllRequestProperties

clearRequestProperty

close

getResponseCode

getResponseHeaders

getUri

open

read

setRequestProperty