ContextQMD
Back to Exoplayer

CacheDataSource (ExoPlayer library)

docs/doc/reference/com/google/android/exoplayer2/upstream/cache/CacheDataSource.html

latest23.5 KB
Original Source

Package com.google.android.exoplayer2.upstream.cache

Class CacheDataSource

  • java.lang.Object

    • com.google.android.exoplayer2.upstream.cache.CacheDataSource

  • All Implemented Interfaces:DataReader, DataSource

[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public final classCacheDataSourceextends[Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")implements[DataSource](../DataSource.html "interface in com.google.android.exoplayer2.upstream")

Deprecated. com.google.android.exoplayer2 is deprecated. Please migrate to androidx.media3 (which contains the same ExoPlayer code). See the migration guide for more details, including a script to help with the migration.

A DataSource that reads and writes a Cache. Requests are fulfilled from the cache when possible. When data is not cached it is requested from an upstream DataSource and written into the cache.

Nested Class Summary

Nested Classes | Modifier and Type | Class | Description | | --- | --- | --- | | static interface | CacheDataSource.CacheIgnoredReason | Deprecated.

Reasons the cache may be ignored. | | static interface | CacheDataSource.EventListener | Deprecated.

Listener of CacheDataSource events. | | static class | CacheDataSource.Factory | Deprecated.

DataSource.Factory for CacheDataSource instances. | | static interface | CacheDataSource.Flags | Deprecated.

Flags controlling the CacheDataSource's behavior. |

Field Summary

Fields | Modifier and Type | Field | Description | | --- | --- | --- | | static int | CACHE_IGNORED_REASON_ERROR | Deprecated.

Cache ignored due to a cache related error. | | static int | CACHE_IGNORED_REASON_UNSET_LENGTH | Deprecated.

Cache ignored due to a request with an unset length. | | static int | FLAG_BLOCK_ON_CACHE | Deprecated.

A flag indicating whether we will block reads if the cache key is locked. | | static int | FLAG_IGNORE_CACHE_FOR_UNSET_LENGTH_REQUESTS | Deprecated.

A flag indicating that the cache should be bypassed for requests whose lengths are unset. | | static int | FLAG_IGNORE_CACHE_ON_ERROR | Deprecated.

A flag indicating whether the cache is bypassed following any cache related error. |

Constructor Summary

Constructors | Constructor | Description | | --- | --- | | CacheDataSource​(Cache cache, DataSource upstreamDataSource) | Deprecated.

Constructs an instance with default DataSource and DataSink instances for reading and writing the cache. | | CacheDataSource​(Cache cache, DataSource upstreamDataSource, @com.google.android.exoplayer2.upstream.cache.CacheDataSource.Flags int flags) | Deprecated.

Constructs an instance with default DataSource and DataSink instances for reading and writing the cache. | | CacheDataSource​(Cache cache, DataSource upstreamDataSource, DataSource cacheReadDataSource, DataSink cacheWriteDataSink, @com.google.android.exoplayer2.upstream.cache.CacheDataSource.Flags int flags, CacheDataSource.EventListener eventListener) | Deprecated.

Constructs an instance with arbitrary DataSource and DataSink instances for reading and writing the cache. | | CacheDataSource​(Cache cache, DataSource upstreamDataSource, DataSource cacheReadDataSource, DataSink cacheWriteDataSink, @com.google.android.exoplayer2.upstream.cache.CacheDataSource.Flags int flags, CacheDataSource.EventListener eventListener, CacheKeyFactory cacheKeyFactory) | Deprecated.

Constructs an instance with arbitrary DataSource and DataSink instances for reading and writing the cache. |

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods | Modifier and Type | Method | Description | | --- | --- | --- | | void | addTransferListener​(TransferListener transferListener) | Deprecated.

Adds a TransferListener to listen to data transfers. | | void | close() | Deprecated.

Closes the source. | | Cache | getCache() | Deprecated.

Returns the Cache used by this instance. | | CacheKeyFactory | getCacheKeyFactory() | Deprecated.

Returns the CacheKeyFactory used by this instance. | | Map<String,​List<String>> | getResponseHeaders() | Deprecated.

When the source is open, returns the response headers associated with the last DataSource.open(com.google.android.exoplayer2.upstream.DataSpec) call. | | Uri | getUri() | Deprecated.

When the source is open, returns the Uri from which data is being read. | | long | open​(DataSpec dataSpec) | Deprecated.

Opens the source to read the specified data. | | int | read​(byte[] buffer, int offset, int length) | Deprecated.

Reads up to length bytes of data from the input. |

-

Methods inherited from class java.lang.Object

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

Field Detail

-

FLAG_BLOCK_ON_CACHE

public static final int FLAG_BLOCK_ON_CACHE

Deprecated.

A flag indicating whether we will block reads if the cache key is locked. If unset then data is read from upstream if the cache key is locked, regardless of whether the data is cached. See Also:Constant Field Values

-

FLAG_IGNORE_CACHE_ON_ERROR

public static final int FLAG_IGNORE_CACHE_ON_ERROR

Deprecated.

A flag indicating whether the cache is bypassed following any cache related error. If set then cache related exceptions may be thrown for one cycle of open, read and close calls. Subsequent cycles of these calls will then bypass the cache. See Also:Constant Field Values

-

FLAG_IGNORE_CACHE_FOR_UNSET_LENGTH_REQUESTS

public static final int FLAG_IGNORE_CACHE_FOR_UNSET_LENGTH_REQUESTS

Deprecated.

A flag indicating that the cache should be bypassed for requests whose lengths are unset. This flag is provided for legacy reasons only. See Also:Constant Field Values

-

CACHE_IGNORED_REASON_ERROR

public static final int CACHE_IGNORED_REASON_ERROR

Deprecated.

Cache ignored due to a cache related error. See Also:Constant Field Values

-

CACHE_IGNORED_REASON_UNSET_LENGTH

public static final int CACHE_IGNORED_REASON_UNSET_LENGTH

Deprecated.

Cache ignored due to a request with an unset length. See Also:Constant Field Values

Constructor Detail

-

CacheDataSource

public CacheDataSource​([Cache](Cache.html "interface in com.google.android.exoplayer2.upstream.cache")cache,
                       @Nullable[DataSource](../DataSource.html "interface in com.google.android.exoplayer2.upstream")upstreamDataSource)

Deprecated.

Constructs an instance with default DataSource and DataSink instances for reading and writing the cache. Parameters:cache - The cache.upstreamDataSource - A DataSource for reading data not in the cache. If null, reading will fail if a cache miss occurs.

-

CacheDataSource

public CacheDataSource​([Cache](Cache.html "interface in com.google.android.exoplayer2.upstream.cache")cache,
                       @Nullable[DataSource](../DataSource.html "interface in com.google.android.exoplayer2.upstream")upstreamDataSource,
                       @com.google.android.exoplayer2.upstream.cache.CacheDataSource.Flags int flags)

Deprecated.

Constructs an instance with default DataSource and DataSink instances for reading and writing the cache. Parameters:cache - The cache.upstreamDataSource - A DataSource for reading data not in the cache. If null, reading will fail if a cache miss occurs.flags - A combination of FLAG_BLOCK_ON_CACHE, FLAG_IGNORE_CACHE_ON_ERROR and FLAG_IGNORE_CACHE_FOR_UNSET_LENGTH_REQUESTS, or 0.

-

CacheDataSource

public CacheDataSource​([Cache](Cache.html "interface in com.google.android.exoplayer2.upstream.cache")cache,
                       @Nullable[DataSource](../DataSource.html "interface in com.google.android.exoplayer2.upstream")upstreamDataSource,[DataSource](../DataSource.html "interface in com.google.android.exoplayer2.upstream")cacheReadDataSource,
                       @Nullable[DataSink](../DataSink.html "interface in com.google.android.exoplayer2.upstream")cacheWriteDataSink,
                       @com.google.android.exoplayer2.upstream.cache.CacheDataSource.Flags int flags,
                       @Nullable[CacheDataSource.EventListener](CacheDataSource.EventListener.html "interface in com.google.android.exoplayer2.upstream.cache")eventListener)

Deprecated.

Constructs an instance with arbitrary DataSource and DataSink instances for reading and writing the cache. One use of this constructor is to allow data to be transformed before it is written to disk. Parameters:cache - The cache.upstreamDataSource - A DataSource for reading data not in the cache. If null, reading will fail if a cache miss occurs.cacheReadDataSource - A DataSource for reading data from the cache.cacheWriteDataSink - A DataSink for writing data to the cache. If null, cache is accessed read-only.flags - A combination of FLAG_BLOCK_ON_CACHE, FLAG_IGNORE_CACHE_ON_ERROR and FLAG_IGNORE_CACHE_FOR_UNSET_LENGTH_REQUESTS, or 0.eventListener - An optional CacheDataSource.EventListener to receive events.

-

CacheDataSource

public CacheDataSource​([Cache](Cache.html "interface in com.google.android.exoplayer2.upstream.cache")cache,
                       @Nullable[DataSource](../DataSource.html "interface in com.google.android.exoplayer2.upstream")upstreamDataSource,[DataSource](../DataSource.html "interface in com.google.android.exoplayer2.upstream")cacheReadDataSource,
                       @Nullable[DataSink](../DataSink.html "interface in com.google.android.exoplayer2.upstream")cacheWriteDataSink,
                       @com.google.android.exoplayer2.upstream.cache.CacheDataSource.Flags int flags,
                       @Nullable[CacheDataSource.EventListener](CacheDataSource.EventListener.html "interface in com.google.android.exoplayer2.upstream.cache")eventListener,
                       @Nullable[CacheKeyFactory](CacheKeyFactory.html "interface in com.google.android.exoplayer2.upstream.cache")cacheKeyFactory)

Deprecated.

Constructs an instance with arbitrary DataSource and DataSink instances for reading and writing the cache. One use of this constructor is to allow data to be transformed before it is written to disk. Parameters:cache - The cache.upstreamDataSource - A DataSource for reading data not in the cache. If null, reading will fail if a cache miss occurs.cacheReadDataSource - A DataSource for reading data from the cache.cacheWriteDataSink - A DataSink for writing data to the cache. If null, cache is accessed read-only.flags - A combination of FLAG_BLOCK_ON_CACHE, FLAG_IGNORE_CACHE_ON_ERROR and FLAG_IGNORE_CACHE_FOR_UNSET_LENGTH_REQUESTS, or 0.eventListener - An optional CacheDataSource.EventListener to receive events.cacheKeyFactory - An optional factory for cache keys.

Method Detail

-

getCache

public[Cache](Cache.html "interface in com.google.android.exoplayer2.upstream.cache")getCache()

Deprecated.

Returns the Cache used by this instance.

-

getCacheKeyFactory

public[CacheKeyFactory](CacheKeyFactory.html "interface in com.google.android.exoplayer2.upstream.cache")getCacheKeyFactory()

Deprecated.

Returns the CacheKeyFactory used by this instance.

-

addTransferListener

public void addTransferListener​([TransferListener](../TransferListener.html "interface in com.google.android.exoplayer2.upstream")transferListener)

Deprecated.

Description copied from interface: DataSource

Adds a TransferListener to listen to data transfers. This method is not thread-safe. Specified by:addTransferListener in interface DataSourceParameters:transferListener - A TransferListener.

-

open

public long open​([DataSpec](../DataSpec.html "class in com.google.android.exoplayer2.upstream")dataSpec)
          throws[IOException](https://developer.android.com/reference/java/io/IOException.html "class or interface in java.io")

Deprecated.

Description copied from interface: DataSource

Opens the source to read the specified data. If an IOException is thrown, callers must still call DataSource.close() to ensure that any partial effects of the invocation are cleaned up.

The following edge case behaviors apply:

  - If the [`requested position`](../DataSpec.html#position) is within the resource, but the [`requested length`](../DataSpec.html#length) extends beyond the end of the resource, then [`DataSource.open(com.google.android.exoplayer2.upstream.DataSpec)`](../DataSource.html#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 through [`DataReader.read(byte[], int, int)`](../DataReader.html#read(byte%5B%5D,int,int)). 
  - If the [`requested position`](../DataSpec.html#position) is equal to the length of the resource, then [`DataSource.open(com.google.android.exoplayer2.upstream.DataSpec)`](../DataSource.html#open(com.google.android.exoplayer2.upstream.DataSpec)) will succeed, and [`DataReader.read(byte[], int, int)`](../DataReader.html#read(byte%5B%5D,int,int)) will immediately return [`C.RESULT_END_OF_INPUT`](../../C.html#RESULT_END_OF_INPUT). 
  - If the [`requested position`](../DataSpec.html#position) is greater than the length of the resource, then [`DataSource.open(com.google.android.exoplayer2.upstream.DataSpec)`](../DataSource.html#open(com.google.android.exoplayer2.upstream.DataSpec)) will throw an [`IOException`](https://developer.android.com/reference/java/io/IOException.html "class or interface in java.io") for which [`DataSourceException.isCausedByPositionOutOfRange(java.io.IOException)`](../DataSourceException.html#isCausedByPositionOutOfRange(java.io.IOException)) will be `true`.

Specified by:open in interface DataSourceParameters: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: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 length)
         throws[IOException](https://developer.android.com/reference/java/io/IOException.html "class or interface in java.io")

Deprecated.

Description copied from interface: DataReader

Reads up to length 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, 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 DataReaderParameters: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 than length 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:IOException - If an error occurs reading from the input.

-

getUri

@Nullable
public[Uri](https://developer.android.com/reference/android/net/Uri.html "class or interface in android.net")getUri()

Deprecated.

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 DataSourceReturns:The Uri from which data is being read, or null if the source is not open.

-

getResponseHeaders

public[Map](https://developer.android.com/reference/java/util/Map.html "class or interface in java.util")<[String](https://developer.android.com/reference/java/lang/String.html?is-external=true "class or interface in java.lang"),​[List](https://developer.android.com/reference/java/util/List.html?is-external=true "class or interface in java.util")<[String](https://developer.android.com/reference/java/lang/String.html?is-external=true "class or interface in java.lang")>> getResponseHeaders()

Deprecated.

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.

Key look-up in the returned map is case-insensitive.

Specified by:getResponseHeaders in interface DataSource

-

close

public void close()
           throws[IOException](https://developer.android.com/reference/java/io/IOException.html "class or interface in java.io")

Deprecated.

Description copied from interface: DataSource

Closes the source. This method must be called even if the corresponding call to DataSource.open(DataSpec) threw an IOException. Specified by:close in interface DataSourceThrows:IOException - If an error occurs closing the source.