CacheDataSource.Factory

Factory()

fun createDataSource(): CacheDataSource!

Creates a DataSource instance.

fun createDataSourceForDownloading(): CacheDataSource!

Returns an instance suitable for downloading content. The created instance is equivalent to one that would be created by createDataSource, except:

• The FLAG_BLOCK_ON_CACHE is always set.
• The task priority is overridden to be PRIORITY_DOWNLOAD.

fun createDataSourceForRemovingDownload(): CacheDataSource!

Returns an instance suitable for reading cached content as part of removing a download. The created instance is equivalent to one that would be created by createDataSource, except:

• The upstream is overridden to be null, since when removing content we don't want to request anything that's not already cached.
• The FLAG_BLOCK_ON_CACHE is always set.
• The task priority is overridden to be PRIORITY_DOWNLOAD.

@CanIgnoreReturnValue
fun setCacheReadDataSourceFactory(
    cacheReadDataSourceFactory: DataSource.Factory!
): CacheDataSource.Factory!

Sets the DataSource.Factory for DataSources for reading from the cache.

The default is a FileDataSource.Factory in its default configuration.

@CanIgnoreReturnValue
fun setCacheWriteDataSinkFactory(
    cacheWriteDataSinkFactory: DataSink.Factory?
): CacheDataSource.Factory!

Sets the DataSink.Factory for generating DataSinks for writing data to the cache. Passing null causes the cache to be read-only.

The default is a CacheDataSink.Factory in its default configuration.

@CanIgnoreReturnValue
fun setEventListener(eventListener: CacheDataSource.EventListener?): CacheDataSource.Factory!

Sets the {link EventListener} to which events are delivered.

The default is null.

@CanIgnoreReturnValue
fun setFlags(@CacheDataSource.Flags flags: Int): CacheDataSource.Factory!

Sets the CacheDataSource.Flags.

The default is 0.

@CanIgnoreReturnValue
fun setUpstreamDataSourceFactory(
    upstreamDataSourceFactory: DataSource.Factory?
): CacheDataSource.Factory!

Sets the DataSource.Factory for upstream DataSources, which are used to read data in the case of a cache miss.

The default is null, and so this method must be called before the factory is used in order for data to be read from upstream in the case of a cache miss.

@CanIgnoreReturnValue
fun setUpstreamPriority(upstreamPriority: Int): CacheDataSource.Factory!

Sets the priority to use when requesting data from upstream. The priority is only used if a PriorityTaskManager is set by calling setUpstreamPriorityTaskManager.

The default is PRIORITY_PLAYBACK.

@MonotonicNonNull
var cache: @MonotonicNonNull Cache!

var cacheKeyFactory: CacheKeyFactory!

var upstreamPriorityTaskManager: PriorityTaskManager?