FakeDataSource

Artifact: androidx.media3:media3-test-utils

View Source

---

Kotlin |Java

@UnstableApi
public class FakeDataSource extends BaseDataSource

java.lang.Object
↳	androidx.media3.datasource.BaseDataSource
	↳	androidx.media3.test.utils.FakeDataSource

---

A fake DataSource capable of simulating various scenarios. It uses a FakeDataSet instance which determines the response to data access calls.

Summary

Nested types
public class FakeDataSource.Factory implements DataSource.Factory Factory to create a FakeDataSource.

Public fields
@Nullable Uri	uri

Public constructors
FakeDataSource()
FakeDataSource(FakeDataSet fakeDataSet)
FakeDataSource(FakeDataSet fakeDataSet, boolean isNetwork)

Public methods
final void	close() Closes the source.
final DataSpec[]	getAndClearOpenedDataSpecs() Returns the DataSpec instances passed to open since the last call to this method.
final FakeDataSet	getDataSet()
final @Nullable Uri	getUri() When the source is open, returns the Uri from which data is being read.
final boolean	isOpened() Returns whether the data source is currently opened.
final long	open(DataSpec dataSpec) Opens the source to read the specified data.
final int	read(byte[] buffer, int offset, int length) Reads up to length bytes of data from the input.

Protected methods
void	onClosed() Called when the source is closed.
void	onDataRead(int bytesRead) Called when data is being read.

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.
From androidx.media3.datasource.DataSource Map<String, List<String>> @UnstableApi getResponseHeaders() When the source is open, returns the response headers associated with the last open call.

Public fields

uri

public @Nullable Uri uri

Public constructors

FakeDataSource

public FakeDataSource()

FakeDataSource

public FakeDataSource(FakeDataSet fakeDataSet)

FakeDataSource

public FakeDataSource(FakeDataSet fakeDataSet, boolean isNetwork)

Public methods

close

public final 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.

getAndClearOpenedDataSpecs

public final DataSpec[] getAndClearOpenedDataSpecs()

Returns the DataSpec instances passed to open since the last call to this method.

getDataSet

public final FakeDataSet getDataSet()

getUri

public final @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.

isOpened

public final boolean isOpened()

Returns whether the data source is currently opened.

open

public final 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.

read

public final 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.

Protected methods

onClosed

protected void onClosed()

Called when the source is closed.

onDataRead

protected void onDataRead(int bytesRead)

Called when data is being read.

Throws
java.io.IOException