com.vdocipher.aegis.offline

Class DownloadStatus

java.lang.Object

com.vdocipher.aegis.offline.DownloadStatus

public final class DownloadStatus
extends java.lang.Object

Download status information corresponding to a media download.

Field Summary

Fields

Modifier and Type	Field and Description
long	bytesDownloaded Number of bytes downloaded for this download.
int	downloadPercent Overall download progress as percentage.
long	lastModifiedTimestamp Timestamp when the download was last modified, in System.currentTimeMillis().
java.lang.String	localStorageFolder Path to a folder where all the media assets for this download will be downloaded.
MediaInfo	mediaInfo A MediaInfo object containing information about the media this DownloadStatus corresponds to.
java.lang.String	poster Path to a poster file for the download; null if poster not available yet.
int	reason More detail on status of the download.
java.lang.String	reasonDescription Optional description in addition to reason.
int	status Status of this download.
long	totalSizeBytes Total size of the download in bytes.

Constructor Summary

Constructors

Constructor and Description
DownloadStatus(MediaInfo mediaInfo, java.lang.String localStorageFolder, int status, int reason, java.lang.String reasonDescription, long lastModifiedTime, long totalSizeBytes, long bytesDownloaded, int downloadPercent, java.lang.String posterPath)

Method Summary

Modifier and Type	Method and Description
static DownloadStatus	createForCompleted(MediaInfo mediaInfo, java.lang.String localStorageFolder, long lastModifiedTime, long totalSizeBytes, long bytesDownloaded, int downloadPercent, java.lang.String posterPath)
static DownloadStatus	createForFailed(MediaInfo mediaInfo, java.lang.String localStorageFolder, int reason, java.lang.String reasonDescription, long lastModifiedTime, long totalSizeBytes, long bytesDownloaded, int downloadPercent, java.lang.String posterPath)
static DownloadStatus	createForNotFound(MediaInfo mediaInfo)
static DownloadStatus	createForPaused(MediaInfo mediaInfo, java.lang.String localStorageFolder, int reason, long lastModifiedTime, long totalSizeBytes, long bytesDownloaded, int downloadPercent, java.lang.String posterPath)
static DownloadStatus	createForPending(MediaInfo mediaInfo, java.lang.String localStorageFolder, long lastModifiedTime, long totalSizeBytes)
static DownloadStatus	createForRunning(MediaInfo mediaInfo, java.lang.String localStorageFolder, long lastModifiedTime, long totalSizeBytes, long bytesDownloaded, int downloadPercent, java.lang.String posterPath)

Methods inherited from class java.lang.Object

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

Field Detail

mediaInfo

public final MediaInfo mediaInfo

A MediaInfo object containing information about the media this DownloadStatus corresponds to.

localStorageFolder

public final java.lang.String localStorageFolder

Path to a folder where all the media assets for this download will be downloaded.

status

public final int status

Status of this download. One of VdoDownloadManager.STATUS_* constants.

reason

public final int reason

More detail on status of the download. It's meaning is dependent on the value of field status. When status is VdoDownloadManager.STATUS_FAILED or VdoDownloadManager.STATUS_PAUSED, this field describes why the download failed or paused. When status is neither VdoDownloadManager.STATUS_FAILED nor VdoDownloadManager.STATUS_PAUSED, this value is undefined.

reasonDescription

public final java.lang.String reasonDescription

Optional description in addition to reason. When not null, this is a json string which can be parsed to obtain error message, http code, etc.

totalSizeBytes

public final long totalSizeBytes

Total size of the download in bytes. Initially -1, actual value is available once the download starts.

bytesDownloaded

public final long bytesDownloaded

Number of bytes downloaded for this download.

downloadPercent

public final int downloadPercent

Overall download progress as percentage.

poster

public final java.lang.String poster

Path to a poster file for the download; null if poster not available yet.

lastModifiedTimestamp

public final long lastModifiedTimestamp

Timestamp when the download was last modified, in System.currentTimeMillis().

Constructor Detail

DownloadStatus

public DownloadStatus(MediaInfo mediaInfo,
                      java.lang.String localStorageFolder,
                      int status,
                      int reason,
                      java.lang.String reasonDescription,
                      long lastModifiedTime,
                      long totalSizeBytes,
                      long bytesDownloaded,
                      int downloadPercent,
                      java.lang.String posterPath)

Method Detail

createForNotFound

public static DownloadStatus createForNotFound(MediaInfo mediaInfo)

createForPending

public static DownloadStatus createForPending(MediaInfo mediaInfo,
                                              java.lang.String localStorageFolder,
                                              long lastModifiedTime,
                                              long totalSizeBytes)

createForRunning

public static DownloadStatus createForRunning(MediaInfo mediaInfo,
                                              java.lang.String localStorageFolder,
                                              long lastModifiedTime,
                                              long totalSizeBytes,
                                              long bytesDownloaded,
                                              int downloadPercent,
                                              java.lang.String posterPath)

createForPaused

public static DownloadStatus createForPaused(MediaInfo mediaInfo,
                                             java.lang.String localStorageFolder,
                                             int reason,
                                             long lastModifiedTime,
                                             long totalSizeBytes,
                                             long bytesDownloaded,
                                             int downloadPercent,
                                             java.lang.String posterPath)

createForFailed

public static DownloadStatus createForFailed(MediaInfo mediaInfo,
                                             java.lang.String localStorageFolder,
                                             int reason,
                                             java.lang.String reasonDescription,
                                             long lastModifiedTime,
                                             long totalSizeBytes,
                                             long bytesDownloaded,
                                             int downloadPercent,
                                             java.lang.String posterPath)

createForCompleted

public static DownloadStatus createForCompleted(MediaInfo mediaInfo,
                                                java.lang.String localStorageFolder,
                                                long lastModifiedTime,
                                                long totalSizeBytes,
                                                long bytesDownloaded,
                                                int downloadPercent,
                                                java.lang.String posterPath)