VideoDownloader Android SDK

To use the VideoDownloader SDK, you must first add the JitPack repository to your allprojects block in build.gradle, then add the specific dependency to your app's dependencies block.

If you require M3U8 to MP4 merging capabilities, you must also include the JeffFFmpegDemo library. Alternatively, for a smaller footprint, you can use JeffM3U8Lib.

Dependencies:

• Core SDK: com.github.JeffMony:VideoDownloader:5.8.0
• FFmpeg (for M3U8 to MP4): com.github.JeffMony:JeffFFmpegDemo:1.6.0
• Lightweight M3U8 Lib: com.github.JeffMony:JeffM3U8Lib:1.2.0

// 1. Add JitPack to allprojects
allprojects {
    repositories {
	    maven { url 'https://jitpack.io' }
	}
}

// 2. Add dependencies
dependencies {
    implementation 'com.github.JeffMony:VideoDownloader:5.8.0'
    // Optional: for M3U8 to MP4 merging
    implementation 'com.github.JeffMony:JeffFFmpegDemo:1.6.0'
    // OR: for a smaller library
    // implementation 'com.github.JeffMony:JeffM3U8Lib:1.2.0'
}

Register a single global listener via VideoDownloadManager.getInstance().setGlobalDownloadListener(mListener) to receive updates for all download tasks, including progress, speed, errors, and success states.

VideoDownloadManager.getInstance().setGlobalDownloadListener(mListener);

private DownloadListener mListener = new DownloadListener() {
    @Override
    public void onDownloadDefault(VideoTaskItem item) {}
    @Override
    public void onDownloadPending(VideoTaskItem item) {}
    @Override
    public void onDownloadPrepare(VideoTaskItem item) {}
    @Override
    public void onDownloadStart(VideoTaskItem item) {}
    @Override
    public void onDownloadProgress(VideoTaskItem item) {}
    @Override
    public void onDownloadSpeed(VideoTaskItem item) {}
    @Override
    public void onDownloadPause(VideoTaskItem item) {}
    @Override
    public void onDownloadError(VideoTaskItem item) {}
    @Override
    public void onDownloadSuccess(VideoTaskItem item) {}
};

Use the VideoDownloadManager singleton to control the lifecycle of download tasks:

• Fetch tasks: Get a list of current tasks using fetchDownloadItems(IDownloadInfosCallback).
• Start: startDownload(item)
• Pause: pauseDownloadTask(item.getUrl()) or pauseDownloadTask(List<String> urlList) for multiple URLs.
• Resume: pauseDownloadTask(item.getUrl()) (Note: The documentation uses the same method name for pause and resume).
• Delete: deleteVideoTask(String videoUrl, boolean shouldDeleteSourceFile) to remove a task and optionally its source file.

// Fetch current tasks
VideoDownloadManager.getInstance().fetchDownloadItems(new IDownloadInfosCallback() {
    @Override
    public void onDownloadInfos(List<VideoTaskItem> items) {
        // Handle list of VideoTaskItem
    }
});

// Start a task
VideoDownloadManager.getInstance().startDownload(item);

// Pause a task
VideoDownloadManager.getInstance().pauseDownloadTask(item.getUrl());

// Delete a task
VideoDownloadManager.getInstance().deleteVideoTask(item.getUrl(), true);

The VideoTaskState class defines the possible states of a VideoTaskItem:

public class VideoTaskState {
    public static final int DEFAULT = 0;
    public static final int PENDING = -1;
    public static final int PREPARE = 1;
    public static final int START = 2;
    public static final int DOWNLOADING = 3;
    public static final int PROXYREADY = 4;
    public static final int SUCCESS = 5;
    public static final int ERROR = 6;
    public static final int PAUSE = 7;
    public static final int ENOSPC = 8;
}

The VideoTaskItem object contains detailed metadata about a download task. Key fields include:

• mUrl: The source video URL.
• mFinalUrl: The URL after redirects.
• mTaskState: Current status (see VideoTaskState).
• mPercent: Download percentage (0.0 to 100.0).
• mSpeed: Current download speed.
• mFilePath: The full local path to the downloaded file.
• mIsCompleted: Boolean indicating if the download finished.
• mM3U8: M3U8 structure (null if not an M3U8 video).

public class VideoTaskItem implements Cloneable {
    private String mUrl;                 // 下载视频的url
    private long mDownloadCreateTime;    // 下载创建的时间
    private int mTaskState;              // 当前任务的状态
    private String mMimeType;             // 视频url的mime type
    private String mFinalUrl;            // 30x跳转之后的url
    private int mErrorCode;              // 当前任务下载错误码
    private int mVideoType;              // 当前文件类型
    private M3U8 mM3U8;                  // M3U8结构,如果非M3U8,则为null
    private int mTotalTs;                // 当前M3U8的总分片
    private int mCurTs;                  // 当前M3U8已缓存的分片
    private float mSpeed;                // 当前下载速度
    private float mPercent;              // 当前下载百分比, 0 ~ 100
    private long mDownloadSize;          // 已下载大小
    private long mTotalSize;            // 文件总大小
    private String mFileHash;            // 文件名的md5
    private String mSaveDir;             // 保存视频文件的文件目录名
    private boolean mIsCompleted;        // 是否下载完成
    private boolean mIsInDatabase;       // 是否存到数据库中
    private long mLastUpdateTime;        // 上一次更新数据库的时间
    private String mFileName;           // 文件名
    private String mFilePath;           // 文件完整路径(包括文件名)
    private boolean mPaused;
}