@UnstableApi
class DashDownloader : SegmentDownloader


A downloader for DASH streams.

Example usage:

SimpleCache cache = new SimpleCache(downloadFolder, new NoOpCacheEvictor(), databaseProvider);
CacheDataSource.Factory cacheDataSourceFactory =
    new CacheDataSource.Factory()
        .setCache(cache)
        .setUpstreamDataSourceFactory(new DefaultHttpDataSource.Factory());
// Create a downloader for the first representation of the first adaptation set of the first
// period.
DashDownloader dashDownloader =
    new DashDownloader(
        new MediaItem.Builder()
            .setUri(manifestUrl)
            .setStreamKeys(Collections.singletonList(new StreamKey(0, 0, 0)))
            .build(),
        cacheDataSourceFactory);
// Perform the download.
dashDownloader.download(progressListener);
// Use the downloaded data for playback.
DashMediaSource mediaSource =
    new DashMediaSource.Factory(cacheDataSourceFactory).createMediaSource(mediaItem);

Summary

Public constructors

DashDownloader(
    mediaItem: MediaItem!,
    cacheDataSourceFactory: CacheDataSource.Factory!
)

Creates a new instance.

DashDownloader(
    mediaItem: MediaItem!,
    cacheDataSourceFactory: CacheDataSource.Factory!,
    executor: Executor!
)

Creates a new instance.

DashDownloader(
    mediaItem: MediaItem!,
    manifestParser: ParsingLoadable.Parser<DashManifest!>!,
    cacheDataSourceFactory: CacheDataSource.Factory!,
    executor: Executor!
)

This function is deprecated.

Use DashDownloader instead.

DashDownloader(
    mediaItem: MediaItem!,
    manifestParser: ParsingLoadable.Parser<DashManifest!>!,
    cacheDataSourceFactory: CacheDataSource.Factory!,
    executor: Executor!,
    maxMergedSegmentStartTimeDiffMs: Long
)

Creates a new instance.

Protected functions

(Mutable)List<SegmentDownloader.Segment!>!
getSegments(
    dataSource: DataSource!,
    manifest: DashManifest!,
    removing: Boolean
)

Returns a list of all downloadable Segments for a given manifest.

Inherited functions

From androidx.media3.exoplayer.offline.SegmentDownloader
Unit

Permanently cancels the downloading by this downloader.

Unit

Downloads the content.

T!
<T> execute(runnable: RunnableFutureTask<T!, Any!>!, removing: Boolean)

Executes the provided RunnableFutureTask.

java-static DataSpec!
M!
getManifest(dataSource: DataSource!, dataSpec: DataSpec!, removing: Boolean)

Loads and parses a manifest.

Unit

Removes the content.

Public constructors

DashDownloader

DashDownloader(
    mediaItem: MediaItem!,
    cacheDataSourceFactory: CacheDataSource.Factory!
)

Creates a new instance.

Parameters
mediaItem: MediaItem!

The MediaItem to be downloaded.

cacheDataSourceFactory: CacheDataSource.Factory!

A CacheDataSource.Factory for the cache into which the download will be written.

DashDownloader

DashDownloader(
    mediaItem: MediaItem!,
    cacheDataSourceFactory: CacheDataSource.Factory!,
    executor: Executor!
)

Creates a new instance.

Parameters
mediaItem: MediaItem!

The MediaItem to be downloaded.

cacheDataSourceFactory: CacheDataSource.Factory!

A CacheDataSource.Factory for the cache into which the download will be written.

executor: Executor!

An Executor used to make requests for the media being downloaded. Providing an Executor that uses multiple threads will speed up the download by allowing parts of it to be executed in parallel.

DashDownloader

DashDownloader(
    mediaItem: MediaItem!,
    manifestParser: ParsingLoadable.Parser<DashManifest!>!,
    cacheDataSourceFactory: CacheDataSource.Factory!,
    executor: Executor!
)

DashDownloader

DashDownloader(
    mediaItem: MediaItem!,
    manifestParser: ParsingLoadable.Parser<DashManifest!>!,
    cacheDataSourceFactory: CacheDataSource.Factory!,
    executor: Executor!,
    maxMergedSegmentStartTimeDiffMs: Long
)

Creates a new instance.

Parameters
mediaItem: MediaItem!

The MediaItem to be downloaded.

manifestParser: ParsingLoadable.Parser<DashManifest!>!

A parser for DASH manifests.

cacheDataSourceFactory: CacheDataSource.Factory!

A CacheDataSource.Factory for the cache into which the download will be written.

executor: Executor!

An Executor used to make requests for the media being downloaded. Providing an Executor that uses multiple threads will speed up the download by allowing parts of it to be executed in parallel.

maxMergedSegmentStartTimeDiffMs: Long

The maximum difference of the start time of two segments, up to which the segments (of the same URI) should be merged into a single download segment, in milliseconds.

Protected functions

getSegments

protected fun getSegments(
    dataSource: DataSource!,
    manifest: DashManifest!,
    removing: Boolean
): (Mutable)List<SegmentDownloader.Segment!>!

Returns a list of all downloadable Segments for a given manifest. Any required data should be loaded using getManifest or execute.

Parameters
dataSource: DataSource!

The DataSource through which to load any required data.

manifest: DashManifest!

The manifest containing the segments.

removing: Boolean

Whether the segments are being obtained as part of a removal. If true then a partial segment list is returned in the case that a load error prevents all segments from being listed. If false then an IOException will be thrown in this case.

Returns
(Mutable)List<SegmentDownloader.Segment!>!

The list of downloadable Segments.

Throws
java.io.IOException

Thrown if allowPartialIndex is false and an execution error occurs, or if the media is not in a form that allows for its segments to be listed.

java.lang.InterruptedException