com.google.android.exoplayer2.upstream

Class RawResourceDataSource

java.lang.Object

com.google.android.exoplayer2.upstream.BaseDataSource

com.google.android.exoplayer2.upstream.RawResourceDataSource

All Implemented Interfaces:

DataSource

public final class RawResourceDataSource
extends BaseDataSource

A DataSource for reading a raw resource inside the APK.

URIs supported by this source are of the form rawresource:///rawResourceId, where rawResourceId is the integer identifier of a raw resource. buildRawResourceUri(int) can be used to build Uris in this format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RawResourceDataSource.RawResourceDataSourceException Thrown when an IOException is encountered reading from a raw resource.

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

DataSource.Factory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RAW_RESOURCE_SCHEME The scheme part of a raw resource URI.

Constructor Summary

Constructors

Constructor and Description
RawResourceDataSource(android.content.Context context)
RawResourceDataSource(android.content.Context context, TransferListener listener) Deprecated. Use RawResourceDataSource(Context) and BaseDataSource.addTransferListener(TransferListener).

Method Summary

Modifier and Type	Method and Description
static android.net.Uri	buildRawResourceUri(int rawResourceId) Builds a Uri for the specified raw resource identifier.
void	close() Closes the source.
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 com.google.android.exoplayer2.upstream.BaseDataSource

addTransferListener, bytesTransferred, transferEnded, transferInitializing, transferStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.android.exoplayer2.upstream.DataSource

getResponseHeaders

Field Detail

RAW_RESOURCE_SCHEME

public static final java.lang.String RAW_RESOURCE_SCHEME

The scheme part of a raw resource URI.

See Also:

Constant Field Values

Constructor Detail

RawResourceDataSource

public RawResourceDataSource(android.content.Context context)

Parameters:

context - A context.

RawResourceDataSource

@Deprecated
public RawResourceDataSource(android.content.Context context,
                                         @Nullable
                                         TransferListener listener)

Deprecated. Use RawResourceDataSource(Context) and BaseDataSource.addTransferListener(TransferListener).

Parameters:

context - A context.

listener - An optional listener.

Method Detail

buildRawResourceUri

public static android.net.Uri buildRawResourceUri(int rawResourceId)

Builds a Uri for the specified raw resource identifier.

Parameters:

rawResourceId - A raw resource identifier (i.e. a constant defined in R.raw).

Returns:

The corresponding Uri.

open

public long open(DataSpec dataSpec)
          throws RawResourceDataSource.RawResourceDataSourceException

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.

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:

RawResourceDataSource.RawResourceDataSourceException

read

public int read(byte[] buffer,
                int offset,
                int readLength)
         throws RawResourceDataSource.RawResourceDataSourceException

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.

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:

RawResourceDataSource.RawResourceDataSourceException

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.

Returns:

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

close

public void close()
           throws RawResourceDataSource.RawResourceDataSourceException

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.

Throws:

RawResourceDataSource.RawResourceDataSourceException