TXVodDownloadManager API 简介
点播播放器视频下载接口类。
视频下载支持下载 MP4 和 HLS 视频，对应嵌套 HLS 视频，需要指定偏好清晰度（preferredResolution）。
类常量
参数名 | 类型 | 值 | 描述 |
TXVodDownloadManager.DOWNLOAD_FORMAT_ERROR | number | -5004 | 下载格式不支持。 |
TXVodDownloadManager.DOWNLOAD_DISCONNECT | number | -5005 | 网络错误。 |
TXVodDownloadManager.DOWNLOAD_PATH_ERROR | number | -5007 | 下载目录访问失败。 |
TXVodDownloadManager.DOWNLOAD_403FORBIDDEN | number | -5008 | 签名过期等或者请求不合法。 |
接口概览
API | 描述 |
获取 TXVodDownloadManager 实例对象，单例模式。 | |
设置下载 HTTP 请求头。 | |
设置下载回调方法，下载前必须设好。 | |
以 URL 方式开始下载。 | |
以 fileId 方式开始下载。 | |
停止下载，ITXVodDownloadCallback.onDownloadStop 回调时停止成功。 | |
删除下载信息。 | |
同步获取所有下载列表信息，耗时接口，建议 worker 线程中调用。 | |
通过 fileId 同步获取下载信息，耗时接口，建议 worker 线程中调用。 | |
通过 URL 同步获取下载信息，耗时接口，建议 worker 线程中调用。 |
接口详情
getInstance
获取 TXVodDownloadManager 实例对象，单例模式。
public static getInstance(context: Context): TXVodDownloadManager
setHeaders
设置下载 HTTP 请求头。
public setHeaders(headers: Map<string, string>): void
setDownloadCallback
设置下载回调方法，下载前必须设好。
public setDownloadCallback(callback: ITXVodDownloadCallback): void
参数说明
参数名 | 类型 | 描述 |
callback | ITXVodDownloadCallback | 下载监听状态回调。 |
startDownloadUrl
以 URL 方式开始下载。
注意：启动下载前，请先设置好播放引擎的缓存目录
TXVodGlobalSetting.setCacheFolderPath。public startDownloadUrl(url: string, preferredResolution?: number): TXVodDownloadMediaInfo
参数说明
参数名 | 类型 | 描述 |
url | string | 下载地址，必选参数，否则下载失败。 |
preferredResolution | number | 下载偏好清晰度，多清晰度 URL 为必选参数，值为偏好清晰度宽 × 高（如720p 传入 921600 = 1280 × 720），单清晰度不传入此参数。 |
返回值
视频下载信息 TXVodDownloadMediaInfo。
startDownloadDataSource
以腾讯云视频 fileId 方式开始下载。
public startDownloadDataSource(dataSource: TXVodDownloadDataSource): TXVodDownloadMediaInfo
参数说明
参数名 | 类型 | 描述 |
dataSource | TXVodDownloadDataSource | 下载资源对象。 |
返回值
视频下载信息 TXVodDownloadMediaInfo。
stopDownload
停止下载，ITXVodDownloadCallback.onDownloadStop 回调时停止成功。
public stopDownload(dinfo: TXVodDownloadMediaInfo): void
参数说明
参数名 | 类型 | 描述 |
dinfo | TXVodDownloadMediaInfo | 视频下载信息。 |
deleteDownloadMediaInfo
删除下载信息。不支持删除正在下载的任务。
public deleteDownloadMediaInfo(downloadMediaInfo: TXVodDownloadMediaInfo): boolean
参数说明
参数名 | 类型 | 描述 |
downloadMediaInfo | TXVodDownloadMediaInfo | 视频下载信息。 |
syncGetDownloadMediaInfoList
同步获取所有下载列表信息。耗时操作，建议 worker 线程中调用。
public syncGetDownloadMediaInfoList(): TXVodDownloadMediaInfo[]
返回值
视频下载信息列表：TXVodDownloadMediaInfo[]。
syncGetDownloadMediaInfoByFileId
通过 fileId 同步获取下载信息。耗时操作，建议 worker 线程中调用。
调用此接口要确保之前通过
TXVodDownloadDataSource 创建下载任务参数。public syncGetDownloadMediaInfoByFileId(appId: number, fileId: string, qualityId: number): TXVodDownloadMediaInfo | null
参数说明
参数名 | 类型 | 描述 |
appId | number | 腾讯云点播应用 appId。 |
fileId | string | 腾讯云点播视频 fileId。 |
qualityId | number | 视频画质 ID，具体参考 TXVodDownloadDataSource.QUALITY_XXX 常量。 |
返回值
视频下载信息 TXVodDownloadMediaInfo，不存在则返回 null。
syncGetDownloadMediaInfoByUrl
通过 URL 同步获取下载信息。耗时操作，建议 worker 线程中调用。
调用此接口要确保之前调用
startDownloadUrl 下载。public syncGetDownloadMediaInfoByUrl(url: string, preferredResolution?: number): TXVodDownloadMediaInfo | null
参数说明
参数名 | 类型 | 描述 |
url | string | 下载地址。 |
preferredResolution | number | 须与下载时传入的偏好清晰度值相同，若下载时未传入，这里不传入。 |
返回值
视频下载信息 TXVodDownloadMediaInfo，不存在则返回 null。
