HlsDownloader

Artifact: androidx.media3:media3-exoplayer-hls

Kotlin |Java

@UnstableApi
public final class HlsDownloader extends SegmentDownloader

java.lang.Object
↳	androidx.media3.exoplayer.offline.SegmentDownloader
	↳	androidx.media3.exoplayer.hls.offline.HlsDownloader

A downloader for HLS 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 variant in a multivariant playlist.
HlsDownloader hlsDownloader =
    new HlsDownloader.Factory(cacheDataSourceFactory)
           .create(new MediaItem.Builder()
            .setUri(playlistUri)
             .setStreamKeys(
                ImmutableList.of(
                   new StreamKey(HlsMultivariantPlaylist.GROUP_INDEX_VARIANT, 0)))
              .build());
// Perform the download.
hlsDownloader.download(progressListener);
// Use the downloaded data for playback.
HlsMediaSource mediaSource =
    new HlsMediaSource.Factory(cacheDataSourceFactory).createMediaSource(mediaItem);

Summary

Nested types
`public final class HlsDownloader.Factory extends SegmentDownloader.BaseFactory` A factory for `HLS downloaders`.

Public constructors
`HlsDownloader( MediaItem mediaItem, CacheDataSource.Factory cacheDataSourceFactory )` This method is deprecated. Use `create` instead.
`HlsDownloader( MediaItem mediaItem, CacheDataSource.Factory cacheDataSourceFactory, Executor executor )` This method is deprecated. Use `create` instead.

Public constructors

HlsDownloader(
    MediaItem mediaItem,
    CacheDataSource.Factory cacheDataSourceFactory
)

This method is deprecated.

Use create instead.

HlsDownloader(
    MediaItem mediaItem,
    CacheDataSource.Factory cacheDataSourceFactory,
    Executor executor
)

This method is deprecated.

Use create instead.

Protected methods
`List<SegmentDownloader.Segment>`	`getSegments( DataSource dataSource, HlsPlaylist manifest, boolean removing )` Returns a list of all downloadable `Segment`s for a given manifest.

Inherited Constants

From androidx.media3.exoplayer.offline.SegmentDownloader

static final long

DEFAULT_MAX_MERGED_SEGMENT_START_TIME_DIFF_MS = 20000

Inherited fields

From androidx.media3.exoplayer.offline.SegmentDownloader

`final long`	`durationUs`
`final long`	`startPositionUs`

Inherited methods

From androidx.media3.exoplayer.offline.SegmentDownloader

`void`	`cancel()` Permanently cancels the downloading by this downloader.
`final void`	`download(@Nullable Downloader.ProgressListener progressListener)` Downloads the content.
`final T`	`<T> execute( Supplier<RunnableFutureTask<T, @NonNull ?>> runnable, boolean removing )` Executes the provided `RunnableFutureTask`.
`static DataSpec`	`getCompressibleDataSpec(Uri uri)`
`final M`	`getManifest(DataSource dataSource, DataSpec dataSpec, boolean removing)` Loads and parses a manifest.
`final M`	`getManifest( DataSource dataSource, ParsingLoadable.Parser<M> manifestParser, DataSpec dataSpec, boolean removing )` Loads and parses a manifest with a different parser than the base parser that parsed the initial manifest.
`final void`	`remove()` Removes the content.

Public constructors

HlsDownloader

public HlsDownloader(
    MediaItem mediaItem,
    CacheDataSource.Factory cacheDataSourceFactory
)

HlsDownloader

public HlsDownloader(
    MediaItem mediaItem,
    CacheDataSource.Factory cacheDataSourceFactory,
    Executor executor
)

Protected methods

getSegments

protected List<SegmentDownloader.Segment> getSegments(
    DataSource dataSource,
    HlsPlaylist manifest,
    boolean removing
)

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.
`HlsPlaylist manifest`	The manifest containing the segments.
`boolean removing`	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
`List<SegmentDownloader.Segment>`	The list of downloadable `Segment`s.

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`

HlsDownloader

Summary

Nested types

Public constructors

Protected methods

Inherited Constants

Inherited fields

Inherited methods

Public constructors

HlsDownloader

HlsDownloader

Protected methods

getSegments