DataSpec

const val FLAG_ALLOW_CACHE_FRAGMENTATION = 4: Int

Allows fragmentation of this request into multiple cache files, meaning a cache eviction policy will be able to evict individual fragments of the data. Depending on the cache implementation, setting this flag may also enable more concurrent access to the data (e.g. reading one fragment whilst writing another).

const val FLAG_ALLOW_GZIP = 1: Int

Allows 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 does make a network request, then the value returned from open will typically be LENGTH_UNSET. The data read from read will be the decompressed data.

const val FLAG_DONT_CACHE_IF_LENGTH_UNKNOWN = 2: Int

Prevents caching if the length cannot be resolved when the DataSource is opened.

const val FLAG_MIGHT_NOT_USE_FULL_NETWORK_SPEED = 8: Int

Indicates there are known external factors that might prevent the data from being loaded at full network speed (e.g. server throttling or unfinished live media chunks).

const val HTTP_METHOD_GET = 1: Int

HTTP GET method.

const val HTTP_METHOD_HEAD = 3: Int

HTTP HEAD method.

const val HTTP_METHOD_POST = 2: Int

HTTP POST method.

DataSpec(uri: Uri!)

Constructs an instance.

DataSpec(uri: Uri!, @DataSpec.Flags flags: Int)

Constructs an instance.

DataSpec(uri: Uri!, position: Long, length: Long)

Constructs an instance.

DataSpec(uri: Uri!, position: Long, length: Long, key: String?)

Constructs an instance.

DataSpec(
    uri: Uri!,
    position: Long,
    length: Long,
    key: String?,
    @DataSpec.Flags flags: Int
)

Constructs an instance.

DataSpec(
    uri: Uri!,
    absoluteStreamPosition: Long,
    position: Long,
    length: Long,
    key: String?,
    @DataSpec.Flags flags: Int
)

Constructs an instance where uriPositionOffset may be non-zero.

DataSpec(
    uri: Uri!,
    position: Long,
    length: Long,
    key: String?,
    @DataSpec.Flags flags: Int,
    httpRequestHeaders: (Mutable)Map<String!, String!>!
)

Constructs an instance.

DataSpec(
    uri: Uri!,
    postBody: ByteArray?,
    absoluteStreamPosition: Long,
    position: Long,
    length: Long,
    key: String?,
    @DataSpec.Flags flags: Int
)

Construct a instance where uriPositionOffset may be non-zero. The httpMethod is inferred from postBody. If postBody is non-null then httpMethod is set to HTTP_METHOD_POST. If postBody is null then httpMethod is set to HTTP_METHOD_GET.

DataSpec(
    uri: Uri!,
    @DataSpec.HttpMethod httpMethod: Int,
    httpBody: ByteArray?,
    absoluteStreamPosition: Long,
    position: Long,
    length: Long,
    key: String?,
    @DataSpec.Flags flags: Int
)

Construct a instance where uriPositionOffset may be non-zero.

DataSpec(
    uri: Uri!,
    @DataSpec.HttpMethod httpMethod: Int,
    httpBody: ByteArray?,
    absoluteStreamPosition: Long,
    position: Long,
    length: Long,
    key: String?,
    @DataSpec.Flags flags: Int,
    httpRequestHeaders: (Mutable)Map<String!, String!>!
)

Construct a instance where uriPositionOffset may be non-zero.

fun buildUpon(): DataSpec.Builder!

Returns a DataSpec.Builder initialized with the values of this instance.

fun getHttpMethodString(): String!

Returns the uppercase HTTP method name (e.g., "GET", "POST", "HEAD") corresponding to the httpMethod.

java-static fun getStringForHttpMethod(@DataSpec.HttpMethod httpMethod: Int): String!

Returns an uppercase HTTP method name (e.g., "GET", "POST", "HEAD") corresponding to the given HttpMethod.

fun isFlagSet(@DataSpec.Flags flag: Int): Boolean

Returns whether the given flag is set.

fun subrange(offset: Long): DataSpec!

Returns a data spec 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.

fun subrange(offset: Long, length: Long): DataSpec!

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

fun toString(): String!

fun withAdditionalHeaders(
    additionalHttpRequestHeaders: (Mutable)Map<String!, String!>!
): DataSpec!

Returns a copy this data spec with additional HTTP request headers. Headers in additionalHttpRequestHeaders will overwrite any headers already in the data spec that have the same keys.

fun withRequestHeaders(httpRequestHeaders: (Mutable)Map<String!, String!>!): DataSpec!

Returns a copy of this data spec with the specified HTTP request headers. Headers already in the data spec are not copied to the new instance.

fun withUri(uri: Uri!): DataSpec!

Returns a copy of this data spec with the specified Uri.

val absoluteStreamPosition: Long

The absolute position of the data in the resource.

val customData: Any?

Application specific data.

This field is intended for advanced use cases in which applications require the ability to attach custom data to DataSpec instances. The custom data should be immutable.

@DataSpec.Flags
val flags: Int

Request flags.

val httpBody: ByteArray<Byte>?

The HTTP request body, null otherwise. If the body is non-null, then httpBody.length will be non-zero.

@DataSpec.HttpMethod
val httpMethod: Int

The HTTP method to use when requesting the data. This value will be ignored by non-HTTP implementations.

val httpRequestHeaders: (Mutable)Map<String!, String!>!

Additional HTTP headers to use when requesting the data.

Note: This map is for additional headers specific to the data being requested. It does not include headers that are set directly by HttpDataSource implementations. In particular, this means the following headers are not included:

• Range: HttpDataSource implementations derive the Range header from position and length.
• Accept-Encoding: HttpDataSource implementations derive the Accept-Encoding header based on whether flags includes FLAG_ALLOW_GZIP.
• User-Agent: HttpDataSource implementations set the User-Agent header directly.
• Other headers set at the HttpDataSource layer. I.e., headers set using setRequestProperty, and using setDefaultRequestProperties.

val key: String?

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

val length: Long

The length of the data, or LENGTH_UNSET.

val position: Long

The position of the data when read from uri.

val uri: Uri!

A Uri from which data belonging to the resource can be read.

val uriPositionOffset: Long

The offset of the data located at uri within the resource.

Equal to 0 unless uri provides access to a subset of the resource. As an example, consider a resource that can be requested over the network and is 1000 bytes long. If uri points to a local file that contains just bytes [200-300], then this field will be set to 200.

This field can be ignored except for in specific circumstances where the absolute position in the resource is required in a DataSource chain. One example is when a needs to decrypt the content as it's read. In this case the absolute position in the resource is typically needed to correctly initialize the decryption algorithm.