Class RawResourceDataSource
- java.lang.Object
-
- com.google.android.exoplayer2.upstream.BaseDataSource
-
- com.google.android.exoplayer2.upstream.RawResourceDataSource
-
- All Implemented Interfaces:
DataReader
,DataSource
public final class RawResourceDataSource extends BaseDataSource
ADataSource
for reading a raw resource inside the APK.URIs supported by this source are of one of the forms:
rawresource:///id
, whereid
is the integer identifier of a raw resource.android.resource:///id
, whereid
is the integer identifier of a raw resource.android.resource://[package]/[type/]name
, wherepackage
is the name of the package in which the resource is located,type
is the resource type andname
is the resource name. The package and the type are optional. Their default value is the package of this application and "raw", respectively. Using the two other forms is more efficient.
buildRawResourceUri(int)
can be used to build supportedUri
s.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RawResourceDataSource.RawResourceDataSourceException
Thrown when anIOException
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 Description static String
RAW_RESOURCE_SCHEME
The scheme part of a raw resource URI.
-
Constructor Summary
Constructors Constructor Description RawResourceDataSource(Context context)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Uri
buildRawResourceUri(int rawResourceId)
Builds aUri
for the specified raw resource identifier.void
close()
Closes the source.Uri
getUri()
When the source is open, returns theUri
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 length)
Reads up tolength
bytes of data from the input.-
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 String RAW_RESOURCE_SCHEME
The scheme part of a raw resource URI.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
RawResourceDataSource
public RawResourceDataSource(Context context)
- Parameters:
context
- A context.
-
-
Method Detail
-
buildRawResourceUri
public static Uri buildRawResourceUri(int rawResourceId)
Builds aUri
for the specified raw resource identifier.- Parameters:
rawResourceId
- A raw resource identifier (i.e. a constant defined inR.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. If anIOException
is thrown, callers must still callDataSource.close()
to ensure that any partial effects of the invocation are cleaned up.The following edge case behaviors apply:
- If the
requested position
is within the resource, but therequested length
extends beyond the end of the resource, thenDataSource.open(com.google.android.exoplayer2.upstream.DataSpec)
will succeed and data from the requested position to the end of the resource will be made available throughDataReader.read(byte[], int, int)
. - If the
requested position
is equal to the length of the resource, thenDataSource.open(com.google.android.exoplayer2.upstream.DataSpec)
will succeed, andDataReader.read(byte[], int, int)
will immediately returnC.RESULT_END_OF_INPUT
. - If the
requested position
is greater than the length of the resource, thenDataSource.open(com.google.android.exoplayer2.upstream.DataSpec)
will throw anIOException
for whichDataSourceException.isCausedByPositionOutOfRange(java.io.IOException)
will betrue
.
- 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
equalsC.LENGTH_UNSET
) this value is the resolved length of the request, orC.LENGTH_UNSET
if the length is still unresolved. For all other requests, the value returned will be equal to the request'sDataSpec.length
. - Throws:
RawResourceDataSource.RawResourceDataSourceException
- If the
-
read
public int read(byte[] buffer, int offset, int length) throws RawResourceDataSource.RawResourceDataSourceException
Description copied from interface:DataReader
Reads up tolength
bytes of data from the input.If
readLength
is zero then 0 is returned. Otherwise, if no data is available because the end of the opened range has been reached, thenC.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
- A target array into which data should be written.offset
- The offset into the target array at which to write.length
- The maximum number of bytes to read from the input.- Returns:
- The number of bytes read, or
C.RESULT_END_OF_INPUT
if the input has ended. This may be less thanlength
because the end of the input (or available data) was reached, the method was interrupted, or the operation was aborted early for another reason. - Throws:
RawResourceDataSource.RawResourceDataSourceException
-
getUri
@Nullable public Uri getUri()
Description copied from interface:DataSource
When the source is open, returns theUri
from which data is being read. The returnedUri
will be identical to the one passedDataSource.open(DataSpec)
in theDataSpec
unless redirection has occurred. If redirection has occurred, theUri
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. This method must be called even if the corresponding call toDataSource.open(DataSpec)
threw anIOException
.
-
-