@UnstableApi
public final class KtorDataSource extends BaseDataSource implements HttpDataSource

java.lang.Object
   ↳ androidx.media3.datasource.BaseDataSource
     ↳ androidx.media3.datasource.ktor.KtorDataSource

An HttpDataSource that delegates to Ktor's HttpClient.

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 KtorDataSource.Factory implements HttpDataSource.Factory

androidx.media3.datasource.DataSource.Factory for KtorDataSource instances.

Public methods
void

Clears all request headers that were set by setRequestProperty.
void

Clears the value of a request header.
void

Closes the source.
int

When the source is open, returns the HTTP response status code associated with the last open call.
int
@NonNull Map<@NonNull String, @NonNull List<@NonNull String>>

When the source is open, returns the response headers associated with the last open call.
@NonNull Map<@NonNull String, @NonNull List<@NonNull String>>
Uri

When the source is open, returns the Uri from which data is being read.
Uri
long
open(@NonNull DataSpec dataSpec)

Opens the source to read the specified data.
int
read(@NonNull byte[] buffer, int offset, int length)

Reads up to length bytes of data from the input.
void

Sets the value of a request header.

Inherited methods
From androidx.media3.datasource.BaseDataSource
final void
bytesTransferred(int bytesTransferred)

Notifies listeners that bytes were transferred.
final void

Notifies listeners that a transfer ended.
final void

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

Notifies listeners that data transfer for the specified DataSpec started.
From androidx.media3.datasource.DataSource
final void

Public methods

clearAllRequestProperties

public void clearAllRequestProperties()

Clears all request headers that were set by setRequestProperty.

clearRequestProperty

public void clearRequestProperty(@NonNull String name)

Clears the value of a request header. The change will apply to subsequent connections established by the source.

Parameters
@NonNull String name

The name of the header field.

close

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

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.

getResponseCode

public int getResponseCode()

getResponseHeaders

public @NonNull Map<@NonNull String, @NonNull List<@NonNull 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.

getResponseHeaders

public @NonNull Map<@NonNull String, @NonNull List<@NonNull String>> getResponseHeaders()

getUri

public 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
Uri

The Uri from which data is being read, or null if the source is not open.

getUri

public Uri getUri()

open

public long open(@NonNull 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:

Parameters
@NonNull 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.

read

public int read(@NonNull 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
@NonNull 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.

setRequestProperty

public void setRequestProperty(@NonNull String name, @NonNull 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
@NonNull String name

The name of the header field.
@NonNull String value

The value of the field.