HttpDataSource

Artifact: androidx.media3:media3-datasource

View Source

---

Kotlin |Java

public interface HttpDataSource extends DataSource

Known direct subclasses

CronetDataSource, DefaultHttpDataSource, HttpEngineDataSource, OkHttpDataSource

CronetDataSource	DataSource without intermediate buffer based on Cronet API set using UrlRequest.
DefaultHttpDataSource	An HttpDataSource that uses Android's HttpURLConnection.
HttpEngineDataSource	DataSource without intermediate buffer based on HttpEngine set using UrlRequest.
OkHttpDataSource	An HttpDataSource that delegates to Square's Call.Factory.

---

An HTTP DataSource.

Summary

Nested types
@UnstableApi public abstract class HttpDataSource.BaseFactory implements HttpDataSource.Factory Base implementation of Factory that sets default request properties.
public final class HttpDataSource.CleartextNotPermittedException extends HttpDataSource.HttpDataSourceException Thrown when cleartext HTTP traffic is not permitted.
public interface HttpDataSource.Factory extends DataSource.Factory A factory for HttpDataSource instances.
public class HttpDataSource.HttpDataSourceException extends DataSourceException Thrown when an error is encountered when trying to read from a HttpDataSource.
@Documented @Retention(value = RetentionPolicy.SOURCE) @Target(value = TYPE_USE) @IntDef(value = ) public annotation HttpDataSource.HttpDataSourceException.Type The type of operation that produced the error.
public final class HttpDataSource.InvalidContentTypeException extends HttpDataSource.HttpDataSourceException Thrown when the content type is invalid.
public final class HttpDataSource.InvalidResponseCodeException extends HttpDataSource.HttpDataSourceException Thrown when an attempt to open a connection results in a response code not in the 2xx range.
@UnstableApi public final class HttpDataSource.RequestProperties Stores HTTP request properties (aka HTTP headers) and provides methods to modify the headers in a thread safe way to avoid the potential of creating snapshots of an inconsistent or unintended state.

Constants
default static final Predicate<String>	@UnstableApi REJECT_PAYWALL_TYPES A Predicate that rejects content types often used for pay-walls.

Public methods
abstract void	@UnstableApi clearAllRequestProperties() Clears all request headers that were set by setRequestProperty.
abstract void	@UnstableApi clearRequestProperty(String name) Clears the value of a request header.
abstract void	@UnstableApi close() Closes the source.
abstract int	@UnstableApi getResponseCode() When the source is open, returns the HTTP response status code associated with the last open call.
abstract Map<String, List<String>>	@UnstableApi getResponseHeaders() When the source is open, returns the response headers associated with the last open call.
abstract long	@UnstableApi open(DataSpec dataSpec) Opens the source to read the specified data.
abstract int	@UnstableApi read(byte[] buffer, int offset, int length) Reads up to length bytes of data from the input.
abstract void	@UnstableApi setRequestProperty(String name, String value) Sets the value of a request header.

Inherited methods
From androidx.media3.datasource.DataSource abstract void @UnstableApi addTransferListener(TransferListener transferListener) Adds a TransferListener to listen to data transfers. abstract @Nullable Uri @UnstableApi getUri() When the source is open, returns the Uri from which data is being read.

Constants

REJECT_PAYWALL_TYPES

@UnstableApi
default static final Predicate<String> REJECT_PAYWALL_TYPES

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

Public methods

clearAllRequestProperties

@UnstableApi
abstract void clearAllRequestProperties()

Clears all request headers that were set by setRequestProperty.

clearRequestProperty

@UnstableApi
abstract 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
abstract 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.
androidx.media3.datasource.HttpDataSource.HttpDataSourceException

getResponseCode

@UnstableApi
abstract 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
abstract 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.

open

@UnstableApi
abstract long open(DataSpec dataSpec)

Opens the source to read the specified data.

Note: HttpDataSource implementations are advised to set request headers passed via (in order of decreasing priority) the dataSpec, setRequestProperty and the default parameters set in the Factory.

Throws
androidx.media3.datasource.HttpDataSource.HttpDataSourceException

read

@UnstableApi
abstract 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
abstract 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.