Stay organized with collections Save and categorize content based on your preferences.

SsDownloader

@UnstableApi
class SsDownloader : SegmentDownloader


A downloader for SmoothStreaming 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 track of the first stream element.
SsDownloader ssDownloader =
    new SsDownloader(
        new MediaItem.Builder()
            .setUri(manifestUri)
            .setStreamKeys(Collections.singletonList(new StreamKey(0, 0)))
            .build(),
        cacheDataSourceFactory);
// Perform the download.
ssDownloader.download(progressListener);
// Use the downloaded data for playback.
SsMediaSource mediaSource =
    new SsMediaSource.Factory(cacheDataSourceFactory).createMediaSource(mediaItem);

Summary

Public constructors

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

Creates an instance.

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

Creates an instance.

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

Creates a new instance.

Protected functions

(Mutable)List<SegmentDownloader.Segment!>!
getSegments(
    dataSource: DataSource!,
    manifest: SsManifest!,
    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

SsDownloader

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

Creates an 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.

SsDownloader

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

Creates an 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.

SsDownloader

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

Creates a new instance.

Parameters
mediaItem: MediaItem!

The MediaItem to be downloaded.

manifestParser: ParsingLoadable.Parser<SsManifest!>!

A parser for SmoothStreaming 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.

Protected functions

getSegments

protected fun getSegments(
    dataSource: DataSource!,
    manifest: SsManifest!,
    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: SsManifest!

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: 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.