com.google.android.exoplayer2.offline

Class SegmentDownloader<M,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 representation key object.

All Implemented Interfaces:

Downloader

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

Base class for multi segment stream downloaders.

All of the methods are blocking. Also they are not thread safe, except getTotalSegments(), getDownloadedSegments() and getDownloadedBytes().

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.offline.Downloader

Downloader.ProgressListener

Constructor Summary

Constructors

Constructor and Description
SegmentDownloader(android.net.Uri manifestUri, DownloaderConstructorHelper constructorHelper)

Method Summary

Modifier and Type	Method and Description
void	download(Downloader.ProgressListener listener) Downloads the content for the selected representations in sync or resumes a previously stopped download.
abstract K[]	getAllRepresentationKeys() Returns keys for all representations.
long	getDownloadedBytes() Returns the total number of downloaded bytes in the representations which are selected, or C.LENGTH_UNSET if it hasn't been calculated yet.
int	getDownloadedSegments() Returns the total number of downloaded segments in the representations which are selected, or C.LENGTH_UNSET if it hasn't been calculated yet.
float	getDownloadPercentage() Returns the download percentage, or Float.NaN if it can't be calculated yet.
M	getManifest() Returns the manifest.
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, K[] keys, boolean allowIncompleteIndex) Returns a list of SegmentDownloader.Segments for given keys.
int	getTotalSegments() Returns the total number of segments in the representations which are selected, or C.LENGTH_UNSET if it hasn't been calculated yet.
void	init() Initializes the total segments, downloaded segments and downloaded bytes counters for the selected representations.
void	remove() Removes all of the downloaded data of the media.
void	selectRepresentations(K[] keys) Selects multiple representations pointed to by the keys for downloading, checking status.

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,
                         DownloaderConstructorHelper constructorHelper)

Parameters:

manifestUri - The Uri of the manifest to be downloaded.

constructorHelper - a DownloaderConstructorHelper instance.

Method Detail

getManifest

public final M getManifest()
                    throws java.io.IOException

Returns the manifest. Downloads and parses it if necessary.

Returns:

The manifest.

Throws:

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

selectRepresentations

public final void selectRepresentations(K[] keys)

Selects multiple representations pointed to by the keys for downloading, checking status. Any previous selection is cleared. If keys are null or empty, all representations are downloaded.

getAllRepresentationKeys

public abstract K[] getAllRepresentationKeys()
                                      throws java.io.IOException

Returns keys for all representations.

Throws:

java.io.IOException

See Also:

selectRepresentations(Object[])

init

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

Initializes the total segments, downloaded segments and downloaded bytes counters for the selected representations.

Specified by:

init in interface Downloader

Throws:

java.io.IOException - Thrown when there is an io error while reading from cache.

DownloadException - Thrown if the media cannot be downloaded.

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

See Also:

getTotalSegments(), getDownloadedSegments(), getDownloadedBytes()

download

public final void download(@Nullable
                           Downloader.ProgressListener listener)
                    throws java.io.IOException,
                           java.lang.InterruptedException

Downloads the content for the selected representations in sync or resumes a previously stopped download.

Specified by:

download in interface Downloader

Parameters:

listener - If not null, called during download.

Throws:

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

DownloadException - Thrown if the media cannot be downloaded.

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

getTotalSegments

public final int getTotalSegments()

Returns the total number of segments in the representations which are selected, or C.LENGTH_UNSET if it hasn't been calculated yet.

See Also:

init()

getDownloadedSegments

public final int getDownloadedSegments()

Returns the total number of downloaded segments in the representations which are selected, or C.LENGTH_UNSET if it hasn't been calculated yet.

See Also:

init()

getDownloadedBytes

public final long getDownloadedBytes()

Returns the total number of downloaded bytes in the representations which are selected, or C.LENGTH_UNSET if it hasn't been calculated yet.

Specified by:

getDownloadedBytes in interface Downloader

See Also:

init()

getDownloadPercentage

public float getDownloadPercentage()

Description copied from interface: Downloader

Returns the download percentage, or Float.NaN if it can't be calculated yet. This value can be an estimation.

Specified by:

getDownloadPercentage in interface Downloader

See Also:

Downloader.init()

remove

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

Description copied from interface: Downloader

Removes all of the downloaded data of 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,
                                                                         K[] keys,
                                                                         boolean allowIncompleteIndex)
                                                                  throws java.lang.InterruptedException,
                                                                         java.io.IOException

Returns a list of SegmentDownloader.Segments for given keys.

Parameters:

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

manifest - The manifest containing the segments.

keys - The selected representation keys.

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

A list of SegmentDownloader.Segments for given keys.

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.