Flutter Download Manager
|
Overview
Flutter Download Manager is a Cross-Platform file downloader with Parallel and Batch Download support. Manage download tasks by url and be notified of status and their progress. Pause, Cancel, Queue and Resume Downloads.
This package was made as I felt like there are no download managers in flutter, specially with desktop support.
Features
- Manage download tasks by url
- Ability to notified of status and progress changes
- Partial Download Feature
- Queue Downloads
- Pause, Cancel or Resume Downloads
- Parallel File Downloads (2 or can change)
- Support Batch download
Platforms Supported
- Linux
- MacOS
- Windows
- Android
- iOS
There are a few caveats about this package:
- On desktop it saves the file in absolute or relative path.
- On mobile it saves the file in absolute or relative path, but we should ask/ensure if the app has the required permissions.
- It does not run in a background process, so when the dart application closes the manager will also shut down.
Getting Started
In your pubspec.yaml file add:
dependencies:
flutter_download_manager: any
Then, in your code import:
import 'package:flutter_download_manager/flutter_download_manager.dart';
Usage
Please refer to /example folder for a working example.
Simply Download a file
var dl = DownloadManager();
var url = "adasdad.com/asda.sdas";
dl.addDownload(url, "./test.sdas");
DownloadTask? task = dl.getDownload(url4);
task?.status.addListener(() {
print(task.status.value);
});
task?.progress.addListener(() {
print(task.progress.value);
});
await dl.whenDownloadComplete(url4);
Get Download Status
DownloadTask? task = dl.getDownload(url4);
task?.status.addListener(() {
print(task.status.value);
});
Get Download Progress
DownloadTask? task = dl.getDownload(url4);
task?.progress.addListener(() {
print(task.progress.value);
});
Await for a task to be complete
DownloadTask? task = dl.getDownload(url4);
await task.whenDownloadComplete();
Cancel a task
var dl = DownloadManager();
dl.cancelDownload(url5);
Pause a task
var dl = DownloadManager();
dl.pauseDownload(url5);
Resume a task
var dl = DownloadManager();
dl.resumeDownload(url5);
Download in Batch
var dl = DownloadManager();
var urls = <String>[];
urls.add(url2);
urls.add(url3);
urls.add(url);
dl.addDownload(url2, "./test2.ipa");
dl.addDownload(url3, "./test3.ipa");
dl.addDownload(url, "./test.ipa");
var downloadProgress = dl.getDownloadProgress(urls);
downloadProgress.addListener(() {
print(downloadProgress.value);
});
await dl.whenDownloadsComplete(urls);
var dl = DownloadManager();
var urls = <String>[];
urls.add(url2);
urls.add(url3);
urls.add(url);
dl.addBatchDownloads(urls, "./");
Cancel a Batch Download
var dl = DownloadManager();
var urls = <String>[];
urls.add(url6);
urls.add(url5);
urls.add(url);
dl.cancelDownloads(urls);
Get Batch Download Progress
var dl = DownloadManager();
var urls = <String>[];
urls.add(url2);
urls.add(url3);
var downloadProgress = dl.getDownloadProgress(urls);
downloadProgress.addListener(() {
print(downloadProgress.value);
});
Await for Batch Download to complete
var dl = DownloadManager();
var urls = <String>[];
urls.add(url2);
urls.add(url3);
urls.add(url);
await dl.whenDownloadsComplete(urls);
Future Work
[] Add in Shared Preference to survive app shutdown
DownloadStatus
enum DownloadStatus { queued, downloading, completed, failed, paused, canceled }
4 Apr 6, 2021
789 Jan 3, 2023
1 Dec 8, 2021
3 Nov 30, 2022
4 Feb 2, 2022
24 Dec 13, 2022
27 Dec 26, 2022
224 Oct 20, 2022
111 Dec 22, 2022
45 Aug 14, 2023