OkHttpDataSource

Artifact: androidx.media3:media3-datasource-okhttp

View Source

---

Kotlin |Java

public class OkHttpDataSource extends BaseDataSource implements HttpDataSource

java.lang.Object
↳	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
public final class OkHttpDataSource.Factory implements HttpDataSource.Factory DataSource.Factory for OkHttpDataSource instances.

Public methods
void	@UnstableApi clearAllRequestProperties() Clears all request headers that were set by setRequestProperty.
void	@UnstableApi clearRequestProperty(String name) Clears the value of a request header.
void	@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.
Map<String, List<String>>	@UnstableApi getResponseHeaders() When the source is open, returns the response headers associated with the last open call.
@Nullable 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(byte[] buffer, int offset, int length) Reads up to length bytes of data from the input.
void	@UnstableApi setRequestProperty(String name, String value) Sets the value of a request header.

Inherited Constants
From androidx.media3.datasource.HttpDataSource static final Predicate<String> @UnstableApi REJECT_PAYWALL_TYPES A Predicate that rejects content types often used for pay-walls.

Inherited methods

From androidx.media3.datasource.BaseDataSource final void @UnstableApi addTransferListener(TransferListener transferListener) Adds a TransferListener to listen to data transfers. final void bytesTransferred(int bytesTransferred) Notifies listeners that bytes were transferred. final void transferEnded() Notifies listeners that a transfer ended. final void transferInitializing(DataSpec dataSpec) Notifies listeners that data transfer for the specified DataSpec is being initialized. final void transferStarted(DataSpec dataSpec) Notifies listeners that data transfer for the specified DataSpec started.

Public methods

clearAllRequestProperties

@UnstableApi
public void clearAllRequestProperties()

Clears all request headers that were set by setRequestProperty.

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
String name	The name of the header field.

close

@UnstableApi
public void close()

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
public int getResponseCode()

When the source is open, returns the HTTP response status code associated with the last open 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 open 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 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
@Nullable Uri	The Uri 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 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
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 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 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
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 Factory, then the header value set with this method should be preferred when connecting with the data source. See open.

Parameters
String name	The name of the header field.
String value	The value of the field.