com.google.android.exoplayer2.upstream

Class DataSpec

java.lang.Object

com.google.android.exoplayer2.upstream.DataSpec

public final class DataSpec
extends java.lang.Object

Defines a region of data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DataSpec.Flags The flags that apply to any request for data.

Field Summary

Fields

Modifier and Type	Field and Description
long	absoluteStreamPosition The absolute position of the data in the full stream.
static int	FLAG_ALLOW_CACHING_UNKNOWN_LENGTH Permits content to be cached even if its length can not be resolved.
static int	FLAG_ALLOW_GZIP Permits an underlying network stack to request that the server use gzip compression.
int	flags Request flags.
java.lang.String	key A key that uniquely identifies the original stream.
long	length The length of the data, or C.LENGTH_UNSET.
long	position The position of the data when read from uri.
byte[]	postBody Body for a POST request, null otherwise.
android.net.Uri	uri The source from which data should be read.

Constructor Summary

Constructors

Constructor and Description
DataSpec(android.net.Uri uri) Construct a DataSpec for the given uri and with key set to null.
DataSpec(android.net.Uri uri, byte[] postBody, long absoluteStreamPosition, long position, long length, java.lang.String key, int flags) Construct a DataSpec where position may differ from absoluteStreamPosition.
DataSpec(android.net.Uri uri, int flags) Construct a DataSpec for the given uri and with key set to null.
DataSpec(android.net.Uri uri, long absoluteStreamPosition, long position, long length, java.lang.String key, int flags) Construct a DataSpec where position may differ from absoluteStreamPosition.
DataSpec(android.net.Uri uri, long absoluteStreamPosition, long length, java.lang.String key) Construct a DataSpec where position equals absoluteStreamPosition.
DataSpec(android.net.Uri uri, long absoluteStreamPosition, long length, java.lang.String key, int flags) Construct a DataSpec where position equals absoluteStreamPosition.

Method Summary

Modifier and Type	Method and Description
boolean	isFlagSet(int flag) Returns whether the given flag is set.
DataSpec	subrange(long offset) Returns a DataSpec that represents a subrange of the data defined by this DataSpec.
DataSpec	subrange(long offset, long length) Returns a DataSpec that represents a subrange of the data defined by this DataSpec.
java.lang.String	toString()
DataSpec	withUri(android.net.Uri uri) Returns a copy of this DataSpec with the specified Uri.

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_ALLOW_GZIP

public static final int FLAG_ALLOW_GZIP

Permits an underlying network stack to request that the server use gzip compression.

Should not typically be set if the data being requested is already compressed (e.g. most audio and video requests). May be set when requesting other data.

When a DataSource is used to request data with this flag set, and if the DataSource does make a network request, then the value returned from DataSource.open(DataSpec) will typically be C.LENGTH_UNSET. The data read from DataSource.read(byte[], int, int) will be the decompressed data.

See Also:

Constant Field Values

FLAG_ALLOW_CACHING_UNKNOWN_LENGTH

public static final int FLAG_ALLOW_CACHING_UNKNOWN_LENGTH

Permits content to be cached even if its length can not be resolved. Typically this's the case for progressive live streams and when FLAG_ALLOW_GZIP is used.

See Also:

Constant Field Values

uri

public final android.net.Uri uri

The source from which data should be read.

postBody

@Nullable
public final byte[] postBody

Body for a POST request, null otherwise.

absoluteStreamPosition

public final long absoluteStreamPosition

The absolute position of the data in the full stream.

position

public final long position

The position of the data when read from uri.

Always equal to absoluteStreamPosition unless the uri defines the location of a subset of the underlying data.

length

public final long length

The length of the data, or C.LENGTH_UNSET.

key

@Nullable
public final java.lang.String key

A key that uniquely identifies the original stream. Used for cache indexing. May be null if the DataSpec is not intended to be used in conjunction with a cache.

flags

public final int flags

Request flags. Currently FLAG_ALLOW_GZIP and FLAG_ALLOW_CACHING_UNKNOWN_LENGTH are the only supported flags.

Constructor Detail

DataSpec

public DataSpec(android.net.Uri uri)

Construct a DataSpec for the given uri and with key set to null.

Parameters:

uri - uri.

DataSpec

public DataSpec(android.net.Uri uri,
                int flags)

Construct a DataSpec for the given uri and with key set to null.

Parameters:

uri - uri.

flags - flags.

DataSpec

public DataSpec(android.net.Uri uri,
                long absoluteStreamPosition,
                long length,
                @Nullable
                java.lang.String key)

Construct a DataSpec where position equals absoluteStreamPosition.

Parameters:

uri - uri.

absoluteStreamPosition - absoluteStreamPosition, equal to position.

length - length.

key - key.

DataSpec

public DataSpec(android.net.Uri uri,
                long absoluteStreamPosition,
                long length,
                @Nullable
                java.lang.String key,
                int flags)

Construct a DataSpec where position equals absoluteStreamPosition.

Parameters:

uri - uri.

absoluteStreamPosition - absoluteStreamPosition, equal to position.

length - length.

key - key.

flags - flags.

DataSpec

public DataSpec(android.net.Uri uri,
                long absoluteStreamPosition,
                long position,
                long length,
                @Nullable
                java.lang.String key,
                int flags)

Construct a DataSpec where position may differ from absoluteStreamPosition.

Parameters:

uri - uri.

absoluteStreamPosition - absoluteStreamPosition.

position - position.

length - length.

key - key.

flags - flags.

DataSpec

public DataSpec(android.net.Uri uri,
                @Nullable
                byte[] postBody,
                long absoluteStreamPosition,
                long position,
                long length,
                @Nullable
                java.lang.String key,
                int flags)

Construct a DataSpec where position may differ from absoluteStreamPosition.

Parameters:

uri - uri.

postBody - postBody.

absoluteStreamPosition - absoluteStreamPosition.

position - position.

length - length.

key - key.

flags - flags.

Method Detail

isFlagSet

public boolean isFlagSet(int flag)

Returns whether the given flag is set.

Parameters:

flag - Flag to be checked if it is set.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

subrange

public DataSpec subrange(long offset)

Returns a DataSpec that represents a subrange of the data defined by this DataSpec. The subrange includes data from the offset up to the end of this DataSpec.

Parameters:

offset - The offset of the subrange.

Returns:

A DataSpec that represents a subrange of the data defined by this DataSpec.

subrange

public DataSpec subrange(long offset,
                         long length)

Returns a DataSpec that represents a subrange of the data defined by this DataSpec.

Parameters:

offset - The offset of the subrange.

length - The length of the subrange.

Returns:

A DataSpec that represents a subrange of the data defined by this DataSpec.

withUri

public DataSpec withUri(android.net.Uri uri)

Returns a copy of this DataSpec with the specified Uri.

Parameters:

uri - The new source Uri.

Returns:

The copied DataSpec with the specified Uri.