Vdocipher/com.vdocipher.aegis.offline/VdoDownloadManager

VdoDownloadManager

open class VdoDownloadManager

VdoDownloadManager handles enqueuing download requests and management of media downloads.

New download requests can be added which will remain in queue and downloaded serially.

Status of media downloads can be requested using filtered queries.

Download events can be listened to by registering a listener with the VdoDownloadManager instance. Make sure to unregister listener when not required to avoid memory leaks.

Types

Link copied to clipboard
interface EventListener
Callback interface for listening to download events.
Link copied to clipboard
class Query
Class used to specify filters for a query.
Link copied to clipboard
interface QueryResultListener
Callback interface for listening to query results.

Properties

Link copied to clipboard
val ERROR_CANNOT_RESUME: Int = 1002
Link copied to clipboard
val ERROR_DATABASE: Int = 1040
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val ERROR_DRM: Int = 1060
Link copied to clipboard
Link copied to clipboard
val ERROR_FILE_ERROR: Int = 1031
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val ERROR_LICENSE: Int = 1050
Link copied to clipboard
Link copied to clipboard
val ERROR_SERVER_DENIED: Int = 1011
Link copied to clipboard
val ERROR_SERVER_ERROR: Int = 1012
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val ERROR_UNKNOWN: Int = 1001
Link copied to clipboard
val PAUSED_EXPLICIT: Int = 1
Link copied to clipboard
Link copied to clipboard
val PAUSED_UNKNOWN: Int = 3
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val STATUS_FAILED: Int = 6
Link copied to clipboard
Link copied to clipboard
val STATUS_PAUSED: Int = 4
Link copied to clipboard
val STATUS_PENDING: Int = 2
Link copied to clipboard
val STATUS_REMOVING: Int = 7
Link copied to clipboard

Functions

Link copied to clipboard
open fun addEventListener(listener: VdoDownloadManager.EventListener)
Add a listener for download events.
Link copied to clipboard
open fun enqueue(@NonNull request: DownloadRequest)
Enqueue a request to be downloaded.
Link copied to clipboard
open fun enqueueV2(@NonNull downloadRequest: DownloadRequest)
Enqueue a request to be downloaded.
Link copied to clipboard
open fun getInstance(@NonNull context: Context): VdoDownloadManager
open fun getInstance(@NonNull context: Context, @Nullable downloadLocation: String): VdoDownloadManager
Get an instance of VdoDownloadManager.
Link copied to clipboard
open fun getMediaIdLastPlayedTimeMap(mediaIds: Array<String>): Map<String, Date>
Returns map of media id and last played time for given media ids.
Link copied to clipboard
open fun getSavedMediaItems(@NonNull query: VdoDownloadManager.Query, @NonNull queryResultListener: VdoDownloadManager.QueryResultListener)
Query the VdoDownloadManager about media saved for offline playback without drm license.
Link copied to clipboard
open fun pauseAllDownloads(mediaIds: Array<String>)
Link copied to clipboard
open fun query(@NonNull query: VdoDownloadManager.Query, @NonNull queryResultListener: VdoDownloadManager.QueryResultListener)
Query the VdoDownloadManager about media downloads that have been requested.
Link copied to clipboard
open fun remove(mediaIds: Array<String>)
Cancel media downloads and delete them locally.
Link copied to clipboard
open fun removeEventListener(listener: VdoDownloadManager.EventListener)
Remove a listener of download events.
Link copied to clipboard
open fun resumeAllDownloads(mediaIds: Array<String>)
Link copied to clipboard
open fun resumeDownload(mediaId: String)
Link copied to clipboard
open fun resumeDownloads(mediaIds: Array<String>)
Resume download for given media ids.
Link copied to clipboard
open fun saveOffline(@NonNull downloadRequest: DownloadRequest)
Enqueue a request to be downloaded.
Link copied to clipboard
open fun setDownloadNotificationHelper(@Nullable downloadNotificationHelper: Class<out VdoDownloadNotificationHelper>)
Change download notification look and feel.
Link copied to clipboard
open fun stopDownload(mediaId: String)
Link copied to clipboard
open fun stopDownloads(mediaIds: Array<String>)
Stop download for given media ids.