DefaultHttpDataSource

Artifact: androidx.media3:media3-datasource

View Source

---

Kotlin |Java

class DefaultHttpDataSource : BaseDataSource, HttpDataSource

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

---

An HttpDataSource that uses Android's HttpURLConnection.

By default this implementation will not follow cross-protocol redirects (i.e. redirects from HTTP to HTTPS or vice versa). Cross-protocol redirects can be enabled by passing true to setAllowCrossProtocolRedirects.

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

Summary

Nested types
class DefaultHttpDataSource.Factory : HttpDataSource.Factory DataSource.Factory for DefaultHttpDataSource instances.

Constants
const Int	@UnstableApi DEFAULT_CONNECT_TIMEOUT_MILLIS = 8000 The default connection timeout, in milliseconds.
const Int	@UnstableApi DEFAULT_READ_TIMEOUT_MILLIS = 8000 The default read timeout, in milliseconds.

Public constructors
@UnstableApi DefaultHttpDataSource() This function is deprecated. Use DefaultHttpDataSource.Factory instead.
@UnstableApi DefaultHttpDataSource(userAgent: String?) This function is deprecated. Use DefaultHttpDataSource.Factory instead.
@UnstableApi DefaultHttpDataSource(     userAgent: String?,     connectTimeoutMillis: Int,     readTimeoutMillis: Int ) This function is deprecated. Use DefaultHttpDataSource.Factory instead.
@UnstableApi DefaultHttpDataSource(     userAgent: String?,     connectTimeoutMillis: Int,     readTimeoutMillis: Int,     allowCrossProtocolRedirects: Boolean,     defaultRequestProperties: HttpDataSource.RequestProperties? ) This function is deprecated. Use DefaultHttpDataSource.Factory instead.

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.
(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 setContentTypePredicate(contentTypePredicate: Predicate<String!>?) This function is deprecated. Use setContentTypePredicate instead.
Unit	@UnstableApi setRequestProperty(name: String!, value: String!) Sets the value of a request header.

Public properties
Int	responseCode

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.

Constants

DEFAULT_CONNECT_TIMEOUT_MILLIS

@UnstableApi
const val DEFAULT_CONNECT_TIMEOUT_MILLIS = 8000: Int

The default connection timeout, in milliseconds.

DEFAULT_READ_TIMEOUT_MILLIS

@UnstableApi
const val DEFAULT_READ_TIMEOUT_MILLIS = 8000: Int

The default read timeout, in milliseconds.

Public constructors

DefaultHttpDataSource

@UnstableApi
DefaultHttpDataSource()

This function is deprecated.

Use DefaultHttpDataSource.Factory instead.

DefaultHttpDataSource

@UnstableApi
DefaultHttpDataSource(userAgent: String?)

This function is deprecated.

Use DefaultHttpDataSource.Factory instead.

DefaultHttpDataSource

@UnstableApi
DefaultHttpDataSource(
    userAgent: String?,
    connectTimeoutMillis: Int,
    readTimeoutMillis: Int
)

This function is deprecated.

Use DefaultHttpDataSource.Factory instead.

DefaultHttpDataSource

@UnstableApi
DefaultHttpDataSource(
    userAgent: String?,
    connectTimeoutMillis: Int,
    readTimeoutMillis: Int,
    allowCrossProtocolRedirects: Boolean,
    defaultRequestProperties: HttpDataSource.RequestProperties?
)

This function is deprecated.

Use DefaultHttpDataSource.Factory instead.

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

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.

Throws
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

setContentTypePredicate

@UnstableApi
fun setContentTypePredicate(contentTypePredicate: Predicate<String!>?): Unit

This function is deprecated.

Use setContentTypePredicate instead.

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.

Public properties

responseCode

val responseCode: Int