TXVodDownloadManager

详细描述

视频下载。视频下载支持用户在有网络的条件下下载视频，随后在无网络的环境下观看。
同时播放器 SDK 提供本地加密能力，下载后的本地视频仍为加密状态，仅可通过指定播放器对视频进行解密播放，可有效防止下载后视频的非法传播，保护视频安全。

---

结构体说明

com::tencent::rtmp::downloader::TXVodDownloadManager

class com::tencent::rtmp::downloader::TXVodDownloadManager

Public 成员函数
void	setDownloadPath (String downloadPath)
void	setHeaders (Map< String, String > headers)
void	setListener (ITXVodDownloadListener listener)
TXVodDownloadMediaInfo	startDownloadUrl (String url)
TXVodDownloadMediaInfo	startDownloadUrl (String url, String userName)
TXVodDownloadMediaInfo	startDownload (final TXVodDownloadDataSource dataSource)
void	stopDownload (TXVodDownloadMediaInfo dinfo)
boolean	deleteDownloadFile (String playPath)
boolean	deleteDownloadMediaInfo (TXVodDownloadMediaInfo downloadMediaInfo)
List< TXVodDownloadMediaInfo >	getDownloadMediaInfoList ()
TXVodDownloadMediaInfo	getDownloadMediaInfo (int appId, String fileId, int qualityId)
TXVodDownloadMediaInfo	getDownloadMediaInfo (String url)
静态 Public 成员函数
static TXVodDownloadManager	getInstance ()
视频下载错误码
static final int	DOWNLOAD_SUCCESS = 0
static final int	DOWNLOAD_AUTH_FAILED = -5001
static final int	DOWNLOAD_NO_FILE = -5003
static final int	DOWNLOAD_FORMAT_ERROR = -5004
static final int	DOWNLOAD_DISCONNECT = -5005
static final int	DOWNLOAD_HLS_KEY_ERROR = -5006
static final int	DOWNLOAD_PATH_ERROR = -5007
static final int	DOWNLOAD_403FORBIDDEN = -5008

成员函数说明

deleteDownloadFile()

boolean deleteDownloadFile ( String  playPath )

inline

删除下载文件。推荐使用this#deleteDownloadMediaInfo(TXVodDownloadMediaInfo)

参数

playPath

文件路径

返回

文件正在下载将无法删除，返回false

弃用:

此接口已经废弃，不推荐使用

deleteDownloadMediaInfo()

boolean deleteDownloadMediaInfo ( TXVodDownloadMediaInfo  downloadMediaInfo )

inline

删除下载信息

参数

downloadMediaInfo

getDownloadMediaInfo() [1/2]

TXVodDownloadMediaInfo getDownloadMediaInfo ( int  appId, String  fileId, int  qualityId  )

inline

获取下载信息 调用此接口要确保之前通过TXVodDownloadDataSource(int, String, int, String, String)创建下载任务参数 业务可根据下载信息中的userName判断当前用户是否可访问该下载资源 具体参考TXVodDownloadMediaInfo#getDataSource()

参数

appId	腾讯云视频appId
fileId	腾讯云视频文件Id
qualityId	视频画质Id具体参考定义的常量值

返回

getDownloadMediaInfo() [2/2]

TXVodDownloadMediaInfo getDownloadMediaInfo ( String  url )

inline

获取下载信息,调用此接口要确保之前调用this#startDownloadUrl下载的 业务可根据下载信息中的userName判断当前用户是否可访问该下载资源

参数

url

下载链接

返回

getDownloadMediaInfoList()

List<TXVodDownloadMediaInfo> getDownloadMediaInfoList ( )

inline

获取所有用户的下载列表信息 调用此接口要确保之前通过TXVodDownloadDataSource(int, String, int, String, String)创建下载任务参数或者 调用this#startDownloadUrl下载 业务可根据下载信息中的userName获得不同用户的下载列表 具体参考TXVodDownloadMediaInfo#getDataSource()

返回

下载列表

getInstance()

static TXVodDownloadManager getInstance ( )

inlinestatic

下载管理器

返回

管理器实例

setDownloadPath()

void setDownloadPath ( String  downloadPath )

inline

设置下载根目录

弃用:

【重要】接口废弃，请使用TXPlayerGlobalSetting#setCacheFolderPath做全局配置，若已设全局配置，全局配置优先。

参数

setHeaders()

void setHeaders ( Map< String, String >  headers )

inline

设置下载Http头

参数

headers

setListener()

void setListener ( ITXVodDownloadListener  listener )

inline

设置下载回调方法。下载前必须设好

参数

listener

startDownload()

TXVodDownloadMediaInfo startDownload ( final TXVodDownloadDataSource  dataSource )

inline

以fileid方式开始下载

参数

dataSource

fileid数据，创建参数对象旧的构造函数将废弃， 推荐TXVodDownloadDataSource(int, String, int, String, String)

返回

startDownloadUrl() [1/2]

TXVodDownloadMediaInfo startDownloadUrl ( String  url )

inline

以url方式开始下载。推荐使用this#startDownloadUrl(String, String)

参数

url

下载地址

返回

弃用:

此接口已经废弃，不推荐使用

startDownloadUrl() [2/2]

TXVodDownloadMediaInfo startDownloadUrl ( String  url, String  userName  )

inline

以url方式开始下载

参数

url	下载地址，必选参数，否则下载失败
userName	账户名称, 可选参数，不传默认为"default"

返回

stopDownload()

void stopDownload ( TXVodDownloadMediaInfo  dinfo )

inline

停止下载。ITXVodDownloadListener.onDownloadStop回调时停止成功

参数

dinfo

结构体成员变量说明

DOWNLOAD_403FORBIDDEN

final int DOWNLOAD_403FORBIDDEN = -5008

static

鉴权信息不通过如签名过期等或者请求不合法

DOWNLOAD_AUTH_FAILED

final int DOWNLOAD_AUTH_FAILED = -5001

static

fileid鉴权失败

DOWNLOAD_DISCONNECT

final int DOWNLOAD_DISCONNECT = -5005

static

网络断开

DOWNLOAD_FORMAT_ERROR

final int DOWNLOAD_FORMAT_ERROR = -5004

static

格式不支持

DOWNLOAD_HLS_KEY_ERROR

final int DOWNLOAD_HLS_KEY_ERROR = -5006

static

获取HLS解密key失败

DOWNLOAD_NO_FILE

final int DOWNLOAD_NO_FILE = -5003

static

无此清晰度文件

DOWNLOAD_PATH_ERROR

final int DOWNLOAD_PATH_ERROR = -5007

static

下载目录访问失败

DOWNLOAD_SUCCESS

final int DOWNLOAD_SUCCESS = 0

static

下载成功