com.google.android.exoplayer2.upstream

Interface DataSource

All Known Subinterfaces:

HttpDataSource

All Known Implementing Classes:

AesCipherDataSource, AssetDataSource, BaseDataSource, ByteArrayDataSource, CacheDataSource, ContentDataSource, DataSchemeDataSource, DefaultDataSource, DefaultHttpDataSource, DummyDataSource, FileDataSource, PriorityDataSource, RawResourceDataSource, StatsDataSource, TeeDataSource, UdpDataSource

public interface DataSource

A component from which streams of data can be read.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DataSource.Factory A factory for DataSource instances.

Method Summary

Modifier and Type	Method and Description
void	addTransferListener(TransferListener transferListener) Adds a TransferListener to listen to data transfers.
void	close() Closes the source.
default java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getResponseHeaders() When the source is open, returns the response headers associated with the last open(com.google.android.exoplayer2.upstream.DataSpec) call.
android.net.Uri	getUri() When the source is open, returns the Uri from which data is being read.
long	open(DataSpec dataSpec) Opens the source to read the specified data.
int	read(byte[] buffer, int offset, int readLength) Reads up to length bytes of data and stores them into buffer, starting at index offset.

Method Detail

addTransferListener

void addTransferListener(TransferListener transferListener)

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

Parameters:

transferListener - A TransferListener.

open

long open(DataSpec dataSpec)
   throws java.io.IOException

Opens the source to read the specified data.

Note: If an IOException is thrown, callers must still call close() to ensure that any partial effects of the invocation are cleaned up.

Parameters:

dataSpec - Defines the data to be read.

Returns:

The number of bytes that can be read from the opened source. For unbounded requests (i.e. requests where DataSpec.length equals C.LENGTH_UNSET) this value is the resolved length of the request, or C.LENGTH_UNSET if the length is still unresolved. For all other requests, the value returned will be equal to the request's DataSpec.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

int read(byte[] buffer,
         int offset,
         int readLength)
  throws java.io.IOException

Reads up to length bytes of data and stores them into buffer, starting at index offset.

If length is zero then 0 is returned. Otherwise, if no data is available because the end of the opened range has been reached, then C.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 - The buffer into which the read data should be stored.

offset - The start offset into buffer at which data should be written.

readLength - The maximum number of bytes to read.

Returns:

The number of bytes read, or C.RESULT_END_OF_INPUT if no data is available because the end of the opened range has been reached.

Throws:

java.io.IOException - If an error occurs reading from the source.

getUri

@Nullable
android.net.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(DataSpec) in the DataSpec unless redirection has occurred. If redirection has occurred, the Uri after redirection is returned.

Returns:

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

getResponseHeaders

default java.util.Map<java.lang.String,java.util.List<java.lang.String>> getResponseHeaders()

When the source is open, returns the response headers associated with the last open(com.google.android.exoplayer2.upstream.DataSpec) call. Otherwise, returns an empty map.

close

void close()
    throws java.io.IOException

Closes the source.

Note: This method must be called even if the corresponding call to open(DataSpec) threw an IOException. See open(DataSpec) for more details.

Throws:

java.io.IOException - If an error occurs closing the source.