BaseDataSource

Kotlin |Java

@UnstableApi
public abstract class BaseDataSource implements DataSource

Known direct subclasses

`AssetDataSource`	A `DataSource` for reading from a local asset.
`ByteArrayDataSource`	A `DataSource` for reading from a byte array.
`ContentDataSource`	A `DataSource` for reading from a content URI.
`CronetDataSource`	DataSource without intermediate buffer based on Cronet API set using UrlRequest.
`DataSchemeDataSource`	A `DataSource` for reading data URLs, as defined by RFC 2397.
`DefaultHttpDataSource`	An `HttpDataSource` that uses Android's `HttpURLConnection`.
`FakeDataSource`	A fake `DataSource` capable of simulating various scenarios.
`FileDataSource`	A `DataSource` for reading local files.
`FileDescriptorDataSource`	A `DataSource` for reading from a `FileDescriptor`.
`HttpEngineDataSource`	DataSource without intermediate buffer based on `HttpEngine` set using `UrlRequest`.
`KtorDataSource`	An `HttpDataSource` that delegates to Ktor's `HttpClient`.
`MediaDataSourceAdapter`	A `DataSource` for reading from a `MediaDataSource`.
`OkHttpDataSource`	An `HttpDataSource` that delegates to Square's `Call.Factory`.
`RawResourceDataSource`	A `DataSource` for reading a raw resource.
`RtmpDataSource`	A Real-Time Messaging Protocol (RTMP) `DataSource`.
`UdpDataSource`	A UDP `DataSource`.

Base DataSource implementation to keep a list of TransferListeners.

Subclasses must call transferInitializing, transferStarted, bytesTransferred, and transferEnded to inform listeners of data transfers.

Summary

Protected constructors
`BaseDataSource(boolean isNetwork)` Creates base data source.

Public methods
`final void`	`@UnstableApi addTransferListener(TransferListener transferListener)` Adds a `TransferListener` to listen to data transfers.

Protected methods
`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.

abstract int

read(byte[] buffer, int offset, int length)

Reads up to length bytes of data from the input.

`abstract void`	`@UnstableApi close()` Closes the source.
`Map<String, List<String>>`	`@UnstableApi getResponseHeaders()` When the source is open, returns the response headers associated with the last `open` call.
`abstract @Nullable Uri`	`@UnstableApi getUri()` When the source is open, returns the `Uri` from which data is being read.
`abstract long`	`@UnstableApi open(DataSpec dataSpec)` Opens the source to read the specified data.

protected BaseDataSource(boolean isNetwork)

Creates base data source.

Parameters
`boolean isNetwork`	Whether the data source loads data through a network.

@UnstableApi
public final void addTransferListener(TransferListener transferListener)

Adds a TransferListener to listen to data transfers. This method is not thread-safe.

Parameters
`TransferListener transferListener`	A `TransferListener`.

protected final void bytesTransferred(int bytesTransferred)

Notifies listeners that bytes were transferred.

Parameters
`int bytesTransferred`	The number of bytes transferred since the previous call to this method (or if the first call, since the transfer was started).

protected final void transferEnded()

Notifies listeners that a transfer ended.

protected final void transferInitializing(DataSpec dataSpec)

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

Parameters
`DataSpec dataSpec`	`DataSpec` describing the data for initializing transfer.

protected final void transferStarted(DataSpec dataSpec)

Notifies listeners that data transfer for the specified DataSpec started.

Parameters
`DataSpec dataSpec`	`DataSpec` describing the data being transferred.