App/com.lagradost.cloudstream3.utils/VideoDownloadManager

VideoDownloadManager

Types

data class CreateNotificationMetadata(val type: VideoDownloadManager.DownloadType, val bytesDownloaded: Long, val bytesTotal: Long, val hlsProgress: Long? = null, val hlsTotal: Long? = null, val bytesPerSecond: Long)

DownloadActionType

enum DownloadActionType : Enum<VideoDownloadManager.DownloadActionType>

DownloadedFileInfo

data class DownloadedFileInfo(val totalBytes: Long, val relativePath: String, val displayName: String, val extraInfo: String? = null, val basePath: String? = null)

DownloadedFileInfoResult

data class DownloadedFileInfoResult(val fileLength: Long, val totalBytes: Long, val path: Uri)

DownloadEpisodeMetadata

data class DownloadEpisodeMetadata(val id: Int, val mainName: String, val sourceApiName: String?, val poster: String?, val name: String?, val season: Int?, val episode: Int?, val type: TvType?)

DownloadInfo

data class DownloadInfo(val source: String?, val folder: String?, val ep: VideoDownloadManager.DownloadEpisodeMetadata, val links: List<ExtractorLink>)

DownloadItem

data class DownloadItem(val source: String?, val folder: String?, val ep: VideoDownloadManager.DownloadEpisodeMetadata, val links: List<ExtractorLink>)

DownloadMetaData

data class DownloadMetaData(id: Int?, var bytesDownloaded: Long = 0, var bytesWritten: Long = 0, var totalBytes: Long? = null, lastUpdatedMs: Long = 0, lastDownloadedBytes: Long = 0, createNotificationCallback: (VideoDownloadManager.CreateNotificationMetadata) -> Unit, internalType: VideoDownloadManager.DownloadType = DownloadType.IsPending, var hlsProgress: Int = 0, var hlsTotal: Int? = null, var hlsWrittenProgress: Int = 0, downloadFileInfoTemplate: VideoDownloadManager.DownloadedFileInfo? = null) : Closeable

This class handles the notifications, as well as the relevant key

DownloadQueueResumePackage

data class DownloadQueueResumePackage(val index: Int, val pkg: VideoDownloadManager.DownloadResumePackage)

DownloadResumePackage

data class DownloadResumePackage(val item: VideoDownloadManager.DownloadItem, val linkIndex: Int?)

DownloadStatus

data class DownloadStatus(val retrySame: Boolean, val tryNext: Boolean, val success: Boolean)

DownloadType

enum DownloadType : Enum<VideoDownloadManager.DownloadType>

LazyStreamDownloadData

data class LazyStreamDownloadData(url: String, headers: Map<String, String>, referer: String, chuckStartByte: LongArray, val totalLength: Long?, val downloadLength: Long?, val chuckSize: Long, val bufferSize: Int, val isResumed: Boolean)

LazyStreamDownloadResponse

data class LazyStreamDownloadResponse(val bytes: ByteArray, val startByte: Long, val endByte: Long)

bytes have the size end-start where the byte range is [start,end) note that ByteArray is a pointer and therefore cant be stored without cloning it

StreamData

data class StreamData(fileLength: Long, val file: SafeFile)

Properties

downloadDeleteEvent

val downloadDeleteEvent: Event<Int>

downloadEvent

val downloadEvent: Event<Pair<Int, VideoDownloadManager.DownloadActionType>>

downloadProgressEvent

val downloadProgressEvent: Event<Triple<Int, Long, Long>>

downloadQueue

val downloadQueue: LinkedList<VideoDownloadManager.DownloadResumePackage>

downloadStatus

val downloadStatus: HashMap<Int, VideoDownloadManager.DownloadType>

downloadStatusEvent

val downloadStatusEvent: Event<Pair<Int, VideoDownloadManager.DownloadType>>

imgDone

@get:DrawableRes

val imgDone: ERROR CLASS: Unresolved name: rddone

imgDownloading

@get:DrawableRes

val imgDownloading: ERROR CLASS: Unresolved name: rdload

imgError

@get:DrawableRes

val imgError: ERROR CLASS: Unresolved name: rderror

imgPaused

@get:DrawableRes

val imgPaused: ERROR CLASS: Unresolved name: rdpause

imgStopped

@get:DrawableRes

val imgStopped: ERROR CLASS: Unresolved name: rderror

KEY_DOWNLOAD_INFO

const val KEY_DOWNLOAD_INFO: String

KEY_RESUME_PACKAGES

const val KEY_RESUME_PACKAGES: String

pressToPauseIcon

@get:DrawableRes

val pressToPauseIcon: ERROR CLASS: Unresolved name: ic_baseline_pause_24

pressToResumeIcon

@get:DrawableRes

val pressToResumeIcon: ERROR CLASS: Unresolved name: ic_baseline_play_arrow_24

pressToStopIcon

@get:DrawableRes

val pressToStopIcon: ERROR CLASS: Unresolved name: baseline_stop_24

TAG

const val TAG: String

WORK_KEY_INFO

const val WORK_KEY_INFO: String

WORK_KEY_PACKAGE

const val WORK_KEY_PACKAGE: String

Functions

basePathToFile

fun basePathToFile(context: Context, path: String?): SafeFile?

Turns a string to an UniFile. Used for stored string paths such as settings. Should only be used to get a download path.

deleteFilesAndUpdateSettings

fun deleteFilesAndUpdateSettings(context: Context, ids: Set<Int>, scope: CoroutineScope, onComplete: (Set<Int>) -> Unit = {})

downloadCheck

suspend fun downloadCheck(context: Context, notificationCallback: (Int, Notification) -> Unit)

downloadCheckUsingWorker

fun downloadCheckUsingWorker(context: Context)

downloadEpisode

suspend fun downloadEpisode(context: Context?, source: String?, folder: String?, ep: VideoDownloadManager.DownloadEpisodeMetadata, links: List<ExtractorLink>, notificationCallback: (Int, Notification) -> Unit)

downloadEpisodeUsingWorker

fun downloadEpisodeUsingWorker(context: Context, source: String?, folder: String?, ep: VideoDownloadManager.DownloadEpisodeMetadata, links: List<ExtractorLink>)

downloadFromResume

suspend fun downloadFromResume(context: Context, pkg: VideoDownloadManager.DownloadResumePackage, notificationCallback: (Int, Notification) -> Unit, setKey: Boolean = true)

downloadFromResumeUsingWorker

fun downloadFromResumeUsingWorker(context: Context, pkg: VideoDownloadManager.DownloadResumePackage)

downloadThing

suspend fun downloadThing(context: Context, link: IDownloadableMinimum, name: String, folder: String, extension: String, tryResume: Boolean, parentId: Int?, createNotificationCallback: (VideoDownloadManager.CreateNotificationMetadata) -> Unit, parallelConnections: Int = 3, minimumSize: Long = 100): VideoDownloadManager.DownloadStatus

download a file that consist of a single stream of data

getBasePath

fun Context.getBasePath(): Pair<SafeFile?, String?>

Base path where downloaded things should be stored, changes depending on settings. Returns the file and a string to be stored for future file retrieval. UniFile.filePath is not sufficient for storage.

getDefaultDir

fun getDefaultDir(context: Context): SafeFile?

Gets the default download path as an UniFile. Vital for legacy downloads, be careful about changing anything here.

getDownloadFileInfoAndUpdateSettings

fun getDownloadFileInfoAndUpdateSettings(context: Context, id: Int): VideoDownloadManager.DownloadedFileInfoResult?

getDownloadResumePackage

fun getDownloadResumePackage(context: Context, id: Int): VideoDownloadManager.DownloadResumePackage?

getFileName

fun getFileName(context: Context, metadata: VideoDownloadManager.DownloadEpisodeMetadata): String

getFolder

fun getFolder(context: Context, relativePath: String, basePath: String?): List<Pair<String, Uri>>?

Used for getting video player subs.

getImageBitmapFromUrl

fun Context.getImageBitmapFromUrl(url: String, headers: Map<String, String>? = null): Bitmap?

sanitizeFilename

fun sanitizeFilename(name: String, removeSpaces: Boolean = false): String

setupStream

fun setupStream(context: Context, name: String, folder: String?, extension: String, tryResume: Boolean): VideoDownloadManager.StreamData

fun setupStream(baseFile: SafeFile, name: String, folder: String?, extension: String, tryResume: Boolean): VideoDownloadManager.StreamData

Sets up the appropriate file and creates a data stream from the file. Used for initializing downloads.

streamLazy

suspend fun streamLazy(url: String, headers: Map<String, String>, referer: String, startByte: Long, chuckSize: Long = (1 shl 20) * 10, bufferSize: Int = DEFAULT_BUFFER_SIZE, maximumSmallSize: Long = chuckSize * 2): VideoDownloadManager.LazyStreamDownloadData