com.google.android.exoplayer2.offline

Class DownloadManager

java.lang.Object

com.google.android.exoplayer2.offline.DownloadManager

public final class DownloadManager
extends java.lang.Object

Manages multiple stream download and remove requests.

A download manager instance must be accessed only from the thread that created it, unless that thread does not have a Looper. In that case, it must be accessed only from the application's main thread. Registered listeners will be called on the same thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DownloadManager.Listener Listener for DownloadManager events.
static class	DownloadManager.TaskState Represents state of a task.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_SIMULTANEOUS_DOWNLOADS The default maximum number of simultaneous download tasks.
static int	DEFAULT_MIN_RETRY_COUNT The default minimum number of times a task must be retried before failing.

Constructor Summary

Constructors

Constructor and Description
DownloadManager(Cache cache, DataSource.Factory upstreamDataSourceFactory, java.io.File actionSaveFile, DownloadAction.Deserializer... deserializers) Creates a DownloadManager.
DownloadManager(DownloaderConstructorHelper constructorHelper, java.io.File actionFile, DownloadAction.Deserializer... deserializers) Constructs a DownloadManager.
DownloadManager(DownloaderConstructorHelper constructorHelper, int maxSimultaneousDownloads, int minRetryCount, java.io.File actionFile, DownloadAction.Deserializer... deserializers) Constructs a DownloadManager.

Method Summary

Modifier and Type	Method and Description
void	addListener(DownloadManager.Listener listener) Adds a DownloadManager.Listener.
DownloadManager.TaskState[]	getAllTaskStates() Returns the states of all current tasks.
int	getDownloadCount() Returns the number of download tasks.
int	getTaskCount() Returns the number of tasks.
DownloadManager.TaskState	getTaskState(int taskId) Returns the state of a task, or null if no such task exists
int	handleAction(byte[] actionData) Deserializes an action from actionData, and calls handleAction(DownloadAction).
int	handleAction(DownloadAction action) Handles the given action.
boolean	isIdle() Returns whether there are no active tasks.
boolean	isInitialized() Returns whether the manager has completed initialization.
void	release() Stops all of the tasks and releases resources.
void	removeListener(DownloadManager.Listener listener) Removes a DownloadManager.Listener.
void	startDownloads() Starts the download tasks.
void	stopDownloads() Stops all of the download tasks.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_SIMULTANEOUS_DOWNLOADS

public static final int DEFAULT_MAX_SIMULTANEOUS_DOWNLOADS

The default maximum number of simultaneous download tasks.

See Also:

Constant Field Values

DEFAULT_MIN_RETRY_COUNT

public static final int DEFAULT_MIN_RETRY_COUNT

The default minimum number of times a task must be retried before failing.

See Also:

Constant Field Values

Constructor Detail

DownloadManager

public DownloadManager(Cache cache,
                       DataSource.Factory upstreamDataSourceFactory,
                       java.io.File actionSaveFile,
                       DownloadAction.Deserializer... deserializers)

Creates a DownloadManager.

Parameters:

cache - Cache instance to be used to store downloaded data.

upstreamDataSourceFactory - A DataSource.Factory for creating data sources for downloading upstream data.

actionSaveFile - File to save active actions.

deserializers - Used to deserialize DownloadActions. If empty, DownloadAction.getDefaultDeserializers() is used instead.

DownloadManager

public DownloadManager(DownloaderConstructorHelper constructorHelper,
                       java.io.File actionFile,
                       DownloadAction.Deserializer... deserializers)

Constructs a DownloadManager.

Parameters:

constructorHelper - A DownloaderConstructorHelper to create Downloaders for downloading data.

actionFile - The file in which active actions are saved.

deserializers - Used to deserialize DownloadActions. If empty, DownloadAction.getDefaultDeserializers() is used instead.

DownloadManager

public DownloadManager(DownloaderConstructorHelper constructorHelper,
                       int maxSimultaneousDownloads,
                       int minRetryCount,
                       java.io.File actionFile,
                       DownloadAction.Deserializer... deserializers)

Constructs a DownloadManager.

Parameters:

constructorHelper - A DownloaderConstructorHelper to create Downloaders for downloading data.

maxSimultaneousDownloads - The maximum number of simultaneous download tasks.

minRetryCount - The minimum number of times a task must be retried before failing.

actionFile - The file in which active actions are saved.

deserializers - Used to deserialize DownloadActions. If empty, DownloadAction.getDefaultDeserializers() is used instead.

Method Detail

addListener

public void addListener(DownloadManager.Listener listener)

Adds a DownloadManager.Listener.

Parameters:

listener - The listener to be added.

removeListener

public void removeListener(DownloadManager.Listener listener)

Removes a DownloadManager.Listener.

Parameters:

listener - The listener to be removed.

startDownloads

public void startDownloads()

Starts the download tasks.

stopDownloads

public void stopDownloads()

Stops all of the download tasks. Call startDownloads() to restart tasks.

handleAction

public int handleAction(byte[] actionData)
                 throws java.io.IOException

Deserializes an action from actionData, and calls handleAction(DownloadAction).

Parameters:

actionData - Serialized version of the action to be executed.

Returns:

The id of the newly created task.

Throws:

java.io.IOException - If an error occurs deserializing the action.

handleAction

public int handleAction(DownloadAction action)

Handles the given action. A task is created and added to the task queue. If it's a remove action then any download tasks for the same media are immediately canceled.

Parameters:

action - The action to be executed.

Returns:

The id of the newly created task.

getTaskCount

public int getTaskCount()

Returns the number of tasks.

getDownloadCount

public int getDownloadCount()

Returns the number of download tasks.

getTaskState

@Nullable
public DownloadManager.TaskState getTaskState(int taskId)

Returns the state of a task, or null if no such task exists

getAllTaskStates

public DownloadManager.TaskState[] getAllTaskStates()

Returns the states of all current tasks.

isInitialized

public boolean isInitialized()

Returns whether the manager has completed initialization.

isIdle

public boolean isIdle()

Returns whether there are no active tasks.

release

public void release()

Stops all of the tasks and releases resources. If the action file isn't up to date, waits for the changes to be written. The manager must not be accessed after this method has been called.