com.google.android.exoplayer.upstream

Class DefaultUriDataSource

java.lang.Object

com.google.android.exoplayer.upstream.DefaultUriDataSource

All Implemented Interfaces:

DataSource, UriDataSource

public final class DefaultUriDataSource
extends Object
implements UriDataSource

A UriDataSource that supports multiple URI schemes. The supported schemes are:

• http(s): For fetching data over HTTP and HTTPS (e.g. https://www.something.com/media.mp4).
• file: For fetching data from a local file (e.g. file:///path/to/media/media.mp4, or just /path/to/media/media.mp4 because the implementation assumes that a URI without a scheme is a local file URI).
• asset: For fetching data from an asset in the application's apk (e.g. asset:///media.mp4).
• content: For fetching data from a content URI (e.g. content://authority/path/123).

Constructor Summary

Constructors

Constructor and Description
DefaultUriDataSource(Context context, String userAgent) Constructs a new instance.
DefaultUriDataSource(Context context, TransferListener listener, String userAgent) Constructs a new instance.
DefaultUriDataSource(Context context, TransferListener listener, String userAgent, boolean allowCrossProtocolRedirects) Constructs a new instance, optionally configured to follow cross-protocol redirects.
DefaultUriDataSource(Context context, TransferListener listener, UriDataSource httpDataSource) Constructs a new instance, using a provided HttpDataSource for fetching remote data.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the DataSource.
String	getUri() When the source is open, returns the URI from which data is being read.
long	open(DataSpec dataSpec) Opens the DataSource 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultUriDataSource

public DefaultUriDataSource(Context context,
                            String userAgent)

Constructs a new instance.

The constructed instance will not follow cross-protocol redirects (i.e. redirects from HTTP to HTTPS or vice versa) when fetching remote data. Cross-protocol redirects can be enabled by using DefaultUriDataSource(Context, TransferListener, String, boolean) and passing true as the final argument.

Parameters:

context - A context.

userAgent - The User-Agent string that should be used when requesting remote data.

DefaultUriDataSource

public DefaultUriDataSource(Context context,
                            TransferListener listener,
                            String userAgent)

Constructs a new instance.

The constructed instance will not follow cross-protocol redirects (i.e. redirects from HTTP to HTTPS or vice versa) when fetching remote data. Cross-protocol redirects can be enabled by using DefaultUriDataSource(Context, TransferListener, String, boolean) and passing true as the final argument.

Parameters:

context - A context.

listener - An optional TransferListener.

userAgent - The User-Agent string that should be used when requesting remote data.

DefaultUriDataSource

public DefaultUriDataSource(Context context,
                            TransferListener listener,
                            String userAgent,
                            boolean allowCrossProtocolRedirects)

Constructs a new instance, optionally configured to follow cross-protocol redirects.

Parameters:

context - A context.

listener - An optional TransferListener.

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

DefaultUriDataSource

public DefaultUriDataSource(Context context,
                            TransferListener listener,
                            UriDataSource httpDataSource)

Constructs a new instance, using a provided HttpDataSource for fetching remote data.

Parameters:

context - A context.

listener - An optional TransferListener.

httpDataSource - UriDataSource to use for non-file URIs.

Method Detail

open

public long open(DataSpec dataSpec)
          throws IOException

Description copied from interface: DataSource

Opens the DataSource to read the specified data. Calls to DataSource.open(DataSpec) and DataSource.close() must be balanced.

Note: If DataSource.open(DataSpec) throws an IOException, callers must still call DataSource.close() to ensure that any partial effects of the DataSource.open(DataSpec) invocation are cleaned up. Implementations of this class can assume that callers will call DataSource.close() in this case.

Specified by:

open in interface DataSource

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_UNBOUNDED) this value is the resolved length of the request, or C.LENGTH_UNBOUNDED if the length is still unresolved. For all other requests, the value returned will be equal to the request's DataSpec.length.

Throws:

IOException - If an error occurs opening the source.

read

public int read(byte[] buffer,
                int offset,
                int readLength)
         throws IOException

Description copied from interface: DataSource

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

This method blocks until at least one byte of data can be read, the end of the opened range is detected, or an exception is thrown.

Specified by:

read in interface DataSource

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 the end of the opened range is reached.

Throws:

IOException - If an error occurs reading from the source.

getUri

public String getUri()

Description copied from interface: UriDataSource

When the source is open, returns the URI from which data is being read.

If redirection occurred, the URI after redirection is the one returned.

Specified by:

getUri in interface UriDataSource

Returns:

When the source is open, the URI from which data is being read. Null otherwise.

close

public void close()
           throws IOException

Description copied from interface: DataSource

Closes the DataSource.

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

Specified by:

close in interface DataSource

Throws:

IOException - If an error occurs closing the source.