public final class DefaultDataSource extends Object implements DataSource
DataSource
that supports multiple URI schemes. The supported schemes are:
DefaultDataSource(Context, TransferListener, String, boolean)
, or
any other schemes supported by a base data source if constructed using
DefaultDataSource(Context, TransferListener, DataSource)
.
DataSource.Factory
Constructor and Description |
---|
DefaultDataSource(Context context,
TransferListener<? super DataSource> listener,
DataSource baseDataSource)
Constructs a new instance that delegates to a provided
DataSource for URI schemes other
than file, asset and content. |
DefaultDataSource(Context context,
TransferListener<? super DataSource> listener,
String userAgent,
boolean allowCrossProtocolRedirects)
Constructs a new instance, optionally configured to follow cross-protocol redirects.
|
DefaultDataSource(Context context,
TransferListener<? super DataSource> listener,
String userAgent,
int connectTimeoutMillis,
int readTimeoutMillis,
boolean allowCrossProtocolRedirects)
Constructs a new instance, optionally configured to follow cross-protocol redirects.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes the source.
|
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 . |
public DefaultDataSource(Context context, TransferListener<? super DataSource> listener, String userAgent, boolean allowCrossProtocolRedirects)
context
- A context.listener
- An optional listener.userAgent
- The User-Agent string that should be used when requesting remote data.allowCrossProtocolRedirects
- Whether cross-protocol redirects (i.e. redirects from HTTP
to HTTPS and vice versa) are enabled when fetching remote data.public DefaultDataSource(Context context, TransferListener<? super DataSource> listener, String userAgent, int connectTimeoutMillis, int readTimeoutMillis, boolean allowCrossProtocolRedirects)
context
- A context.listener
- An optional listener.userAgent
- The User-Agent string that should be used when requesting remote data.connectTimeoutMillis
- The connection timeout that should be used when requesting remote
data, in milliseconds. A timeout of zero is interpreted as an infinite timeout.readTimeoutMillis
- The read timeout that should be used when requesting remote data,
in milliseconds. A timeout of zero is interpreted as an infinite timeout.allowCrossProtocolRedirects
- Whether cross-protocol redirects (i.e. redirects from HTTP
to HTTPS and vice versa) are enabled when fetching remote data.public DefaultDataSource(Context context, TransferListener<? super DataSource> listener, DataSource baseDataSource)
DataSource
for URI schemes other
than file, asset and content.context
- A context.listener
- An optional listener.baseDataSource
- A DataSource
to use for URI schemes other than file, asset and
content. This DataSource
should normally support at least http(s).public long open(DataSpec dataSpec) throws IOException
DataSource
Note: If an IOException
is thrown, callers must still call DataSource.close()
to ensure
that any partial effects of the invocation are cleaned up.
open
in interface DataSource
dataSpec
- Defines the data to be read.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
.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.public int read(byte[] buffer, int offset, int readLength) throws IOException
DataSource
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.
read
in interface DataSource
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.C.RESULT_END_OF_INPUT
if no data is avaliable
because the end of the opened range has been reached.IOException
- If an error occurs reading from the source.public Uri getUri()
DataSource
Uri
from which data is being read. The returned
Uri
will be identical to the one passed DataSource.open(DataSpec)
in the DataSpec
unless redirection has occurred. If redirection has occurred, the Uri
after redirection
is returned.getUri
in interface DataSource
Uri
from which data is being read, or null if the source is not open.public void close() throws IOException
DataSource
Note: This method must be called even if the corresponding call to DataSource.open(DataSpec)
threw an IOException
. See DataSource.open(DataSpec)
for more details.
close
in interface DataSource
IOException
- If an error occurs closing the source.