com.google.android.exoplayer2.offline

Class SegmentDownloader<M extends FilterableManifest<M,K>,K>

java.lang.Object

com.google.android.exoplayer2.offline.SegmentDownloader<M,K>

Type Parameters:

M - The type of the manifest object.

K - The type of the streams key object.

All Implemented Interfaces:

Downloader

public abstract class SegmentDownloader<M extends FilterableManifest<M,K>,K>
extends java.lang.Object
implements Downloader

Base class for multi segment stream downloaders.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SegmentDownloader.Segment Smallest unit of content to be downloaded.

Constructor Summary

Constructors

Constructor and Description
SegmentDownloader(android.net.Uri manifestUri, java.util.List<K> streamKeys, DownloaderConstructorHelper constructorHelper)

Method Summary

Modifier and Type	Method and Description
void	cancel() Interrupts any current download operation and prevents future operations from running.
void	download() Downloads the selected streams in the media.
long	getDownloadedBytes() Returns the total number of downloaded bytes.
float	getDownloadPercentage() Returns the estimated download percentage, or C.PERCENTAGE_UNSET if no estimate is available.
protected abstract M	getManifest(DataSource dataSource, android.net.Uri uri) Loads and parses the manifest.
protected abstract java.util.List<SegmentDownloader.Segment>	getSegments(DataSource dataSource, M manifest, boolean allowIncompleteList) Returns a list of all downloadable SegmentDownloader.Segments for a given manifest.
void	remove() Removes the media.

Methods inherited from class java.lang.Object

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

Constructor Detail

SegmentDownloader

public SegmentDownloader(android.net.Uri manifestUri,
                         java.util.List<K> streamKeys,
                         DownloaderConstructorHelper constructorHelper)

Parameters:

manifestUri - The Uri of the manifest to be downloaded.

streamKeys - Keys defining which streams in the manifest should be selected for download. If empty, all streams are downloaded.

constructorHelper - A DownloaderConstructorHelper instance.

Method Detail

download

public final void download()
                    throws java.io.IOException,
                           java.lang.InterruptedException

Downloads the selected streams in the media. If multiple streams are selected, they are downloaded in sync with one another.

Specified by:

download in interface Downloader

Throws:

java.io.IOException - Thrown when there is an error downloading.

java.lang.InterruptedException - If the thread has been interrupted.

cancel

public void cancel()

Description copied from interface: Downloader

Interrupts any current download operation and prevents future operations from running.

Specified by:

cancel in interface Downloader

getDownloadedBytes

public final long getDownloadedBytes()

Description copied from interface: Downloader

Returns the total number of downloaded bytes.

Specified by:

getDownloadedBytes in interface Downloader

getDownloadPercentage

public final float getDownloadPercentage()

Description copied from interface: Downloader

Returns the estimated download percentage, or C.PERCENTAGE_UNSET if no estimate is available.

Specified by:

getDownloadPercentage in interface Downloader

remove

public final void remove()
                  throws java.lang.InterruptedException

Description copied from interface: Downloader

Removes the media.

Specified by:

remove in interface Downloader

Throws:

java.lang.InterruptedException - Thrown if the thread was interrupted.

getManifest

protected abstract M getManifest(DataSource dataSource,
                                 android.net.Uri uri)
                          throws java.io.IOException

Loads and parses the manifest.

Parameters:

dataSource - The DataSource through which to load.

uri - The manifest uri.

Returns:

The manifest.

Throws:

java.io.IOException - If an error occurs reading data.

getSegments

protected abstract java.util.List<SegmentDownloader.Segment> getSegments(DataSource dataSource,
                                                                         M manifest,
                                                                         boolean allowIncompleteList)
                                                                  throws java.lang.InterruptedException,
                                                                         java.io.IOException

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

Parameters:

dataSource - The DataSource through which to load any required data.

manifest - The manifest containing the segments.

allowIncompleteList - Whether to continue in the case that a load error prevents all segments from being listed. If true then a partial segment list will be returned. If false an IOException will be thrown.

Returns:

The list of downloadable SegmentDownloader.Segments.

Throws:

java.lang.InterruptedException - Thrown if the thread was interrupted.

java.io.IOException - Thrown if allowPartialIndex is false and a load error occurs, or if the media is not in a form that allows for its segments to be listed.