Package com.jwplayer.pub.api.offline

Enum Class OfflineDownloadState

java.lang.Object

java.lang.Enum<OfflineDownloadState>

com.jwplayer.pub.api.offline.OfflineDownloadState

All Implemented Interfaces:

Serializable, Comparable<OfflineDownloadState>, Constable

public enum OfflineDownloadState
extends Enum<OfflineDownloadState>

State of an offline download, as reported by OfflineDownloadInfo.getState().

Deliberately an SDK-owned type rather than the underlying player library's state constants, so that a host's download screen does not have to depend on that library's numbering.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPLETED	Finished: every selected track was fully written to disk.
DOWNLOADING	Actively downloading.
FAILED	Stopped by an error.
PAUSED	Started but not running, because a stop reason was set on it.
QUEUED	Accepted and waiting to start, usually behind other downloads or a network requirement.
REMOVING	Being deleted.
RESTARTING	Restarting after having been stopped or having failed.

Method Summary

Modifier and Type	Method	Description
static OfflineDownloadState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OfflineDownloadState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

QUEUED

public static final OfflineDownloadState QUEUED

Accepted and waiting to start, usually behind other downloads or a network requirement.

DOWNLOADING

public static final OfflineDownloadState DOWNLOADING

Actively downloading.

PAUSED

public static final OfflineDownloadState PAUSED

Started but not running, because a stop reason was set on it. Whatever it had already written is still on disk, so it does not have to start over if it is started again.

COMPLETED

public static final OfflineDownloadState COMPLETED

Finished: every selected track was fully written to disk. Its OfflineDownloadInfo.getPlaylistItem() is the item to play it back offline - but see that method's note on what the reconstructed item does and does not carry (a host-supplied MediaDrmCallback must be re-attached).

FAILED

public static final OfflineDownloadState FAILED

Stopped by an error. OfflineDownloadInfo.getFailureReason() is non-null for this state. Partial content may remain on disk.

REMOVING

public static final OfflineDownloadState REMOVING

Being deleted. It will disappear from OfflineDownloadManager.getDownloads(android.content.Context) shortly.

RESTARTING

public static final OfflineDownloadState RESTARTING

Restarting after having been stopped or having failed.

Method Details

values

public static OfflineDownloadState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OfflineDownloadState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null