com.google.android.exoplayer2.upstream

Class DefaultDataSource

java.lang.Object

com.google.android.exoplayer2.upstream.DefaultDataSource

All Implemented Interfaces:

DataSource

public final class DefaultDataSource
extends java.lang.Object
implements DataSource

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

• 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).
• rawresource: For fetching data from a raw resource in the application's apk (e.g. rawresource:///resourceId, where rawResourceId is the integer identifier of the raw resource).
• content: For fetching data from a content URI (e.g. content://authority/path/123).
• rtmp: For fetching data over RTMP. Only supported if the project using ExoPlayer has an explicit dependency on ExoPlayer's RTMP extension.
• data: For parsing data inlined in the URI as defined in RFC 2397.
• http(s): For fetching data over HTTP and HTTPS (e.g. https://www.something.com/media.mp4), if constructed using DefaultDataSource(Context, TransferListener, String, boolean), or any other schemes supported by a base data source if constructed using DefaultDataSource(Context, TransferListener, DataSource).

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.upstream.DataSource

DataSource.Factory

Constructor Summary

Constructors

Constructor and Description
DefaultDataSource(android.content.Context context, DataSource baseDataSource) Constructs a new instance that delegates to a provided DataSource for URI schemes other than file, asset and content.
DefaultDataSource(android.content.Context context, java.lang.String userAgent, boolean allowCrossProtocolRedirects) Constructs a new instance, optionally configured to follow cross-protocol redirects.
DefaultDataSource(android.content.Context context, java.lang.String userAgent, int connectTimeoutMillis, int readTimeoutMillis, boolean allowCrossProtocolRedirects) Constructs a new instance, optionally configured to follow cross-protocol redirects.
DefaultDataSource(android.content.Context context, TransferListener listener, DataSource baseDataSource) Deprecated. Use DefaultDataSource(Context, DataSource) and addTransferListener(TransferListener).
DefaultDataSource(android.content.Context context, TransferListener listener, java.lang.String userAgent, boolean allowCrossProtocolRedirects) Deprecated. Use DefaultDataSource(Context, String, boolean) and addTransferListener(TransferListener).
DefaultDataSource(android.content.Context context, TransferListener listener, java.lang.String userAgent, int connectTimeoutMillis, int readTimeoutMillis, boolean allowCrossProtocolRedirects) Deprecated. Use DefaultDataSource(Context, String, int, int, boolean) and addTransferListener(TransferListener).

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

DefaultDataSource

public DefaultDataSource(android.content.Context context,
                         java.lang.String userAgent,
                         boolean allowCrossProtocolRedirects)

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

Parameters:

context - A context.

userAgent - The User-Agent to use 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.

DefaultDataSource

public DefaultDataSource(android.content.Context context,
                         java.lang.String userAgent,
                         int connectTimeoutMillis,
                         int readTimeoutMillis,
                         boolean allowCrossProtocolRedirects)

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

Parameters:

context - A context.

userAgent - The User-Agent to use 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.

DefaultDataSource

public DefaultDataSource(android.content.Context context,
                         DataSource baseDataSource)

Constructs a new instance that delegates to a provided DataSource for URI schemes other than file, asset and content.

Parameters:

context - A context.

baseDataSource - A DataSource to use for URI schemes other than file, asset and content. This DataSource should normally support at least http(s).

DefaultDataSource

@Deprecated
public DefaultDataSource(android.content.Context context,
                                     @Nullable
                                     TransferListener listener,
                                     java.lang.String userAgent,
                                     boolean allowCrossProtocolRedirects)

Deprecated. Use DefaultDataSource(Context, String, boolean) and addTransferListener(TransferListener).

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

Parameters:

context - A context.

listener - An optional listener.

userAgent - The User-Agent to use 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.

DefaultDataSource

@Deprecated
public DefaultDataSource(android.content.Context context,
                                     @Nullable
                                     TransferListener listener,
                                     java.lang.String userAgent,
                                     int connectTimeoutMillis,
                                     int readTimeoutMillis,
                                     boolean allowCrossProtocolRedirects)

Deprecated. Use DefaultDataSource(Context, String, int, int, boolean) and addTransferListener(TransferListener).

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

Parameters:

context - A context.

listener - An optional listener.

userAgent - The User-Agent to use 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.

DefaultDataSource

@Deprecated
public DefaultDataSource(android.content.Context context,
                                     @Nullable
                                     TransferListener listener,
                                     DataSource baseDataSource)

Deprecated. Use DefaultDataSource(Context, DataSource) and addTransferListener(TransferListener).

Constructs a new instance that delegates to a provided DataSource for URI schemes other than file, asset and content.

Parameters:

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

Method Detail

addTransferListener

public void addTransferListener(TransferListener transferListener)

Description copied from interface: DataSource

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

Specified by:

addTransferListener in interface DataSource

Parameters:

transferListener - A TransferListener.

open

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

Description copied from interface: DataSource

Opens the source to read the specified data.

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

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

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

Description copied from interface: DataSource

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

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

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 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
public android.net.Uri getUri()

Description copied from interface: DataSource

When the source is open, returns the 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.

Specified by:

getUri in interface DataSource

Returns:

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

getResponseHeaders

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

Description copied from interface: DataSource

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

Specified by:

getResponseHeaders in interface DataSource

close

public void close()
           throws java.io.IOException

Description copied from interface: DataSource

Closes the source.

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.

Specified by:

close in interface DataSource

Throws:

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