tencent cloud

云点播

动态与公告
产品动态
公告
产品简介
产品概述
产品特性
产品功能
产品优势
应用场景
解决方案
专业版
云点播专业版简介
快速入门
控制台指南
开发指南
购买指南
计费概述
计费方式
购买指引
账单查询
续费说明
欠费说明
退费说明
快速入门
控制台指南
控制台介绍
服务概览
应用管理
媒体管理
资源包管理
License 管理
实时日志分析
实践教程
媒体上传
如何将点播的媒体文件进行智能降冷
媒体处理
分发播放
如何接收事件通知
如何进行源站迁移
直播录制
如何进行自定义源站回源
直播精彩剪辑固化至云点播 VOD 指引
如何使用 EdgeOne 分发云点播内容
开发指南
媒体上传
媒体加工处理
媒体 AI
事件通知
媒体分发播放
媒体加密与版权保护
播放频道
访问管理
下载媒体文件
应用体系
错误码
播放器 SDK 文档
概述
基本概念
产品功能
Demo 体验
免费测试
购买指南
SDK 下载
License 指引
播放器教程
含 UI 集成方案
无 UI 集成方案
高级功能
API 文档
第三方播放器插件
Player SDK Policy
服务端 API 文档
History
Introduction
API Category
Other APIs
Media Processing APIs
Parameter Template APIs
Task Management APIs
Media Upload APIs
Media Management APIs
Event Notification Relevant API
Media Categorization APIs
Domain Name Management APIs
Distribution APIs
AI-based Sample Management APIs
Region Management APIs
Data Statistics APIs
Carousel-Related APIs
Just In Time Transcode APIs
No longer recommended APIs
Making API Requests
AI-based image processing APIs
Task Flow APIs
Data Types
Error Codes
Video on Demand API 2024-07-18
常见问题
移动端播放问题
费用相关问题
视频上传问题
视频发布问题
视频播放问题
Web 端播放问题
全屏播放问题
数据统计问题
访问管理相关问题
媒资降冷问题
相关协议
Service Level Agreement
VOD 政策
隐私政策
数据处理和安全协议
联系我们
词汇表

TXVodDownloadManager

PDF
聚焦模式
字号
最后更新时间: 2025-05-30 14:15:34

TXDownloadError

下载错误码。
参数名
描述
0
TXDownloadSuccess
下载成功。
-5001
TXDownloadAuthFaild
fileId 鉴权失败。
-5003
TXDownloadNoFile
无此清晰度文件。
-5004
TXDownloadFormatError
格式不支持。
-5005
TXDownloadDisconnet
网络断开。
-5006
TXDownloadHlsKeyError
获取 HLS 解密 key 失败。
-5007
TXDownloadPathError
下载目录访问失败。
-5008
TXDownload403Forbidden
鉴权信息不通过,如签名过期或者请求不合法。

TXVodDownloadManager API 简介

点播播放器视频下载接口类。
视频下载支持下载 MP4 和 HLS 视频,对应嵌套 HLS 视频,需要指定偏好清晰度(preferredResolution)

接口概览

API
描述
获取 TXVodDownloadManager 实例对象,单例模式。
设置下载文件的根目录。如不存在,将自动创建。
以 URL 方式开始下载。
以 fileId 方式开始下载。
以 URL 方式开始下载,可指定偏好清晰度和账户名称。
以 Drm 方式开始下载。
停止下载,-[TXVodDownloadDelegate onDownloadStop:] 回调时停止成功。
删除下载信息。
删除下载产生的文件。
获取所有用户的下载列表信息,耗时接口,请不要在主线程调用。
获取下载信息。
获取下载信息。
加密。
headers
设置下载 HTTP 请求头。
delegate
设置下载回调代理对象,下载前必须设好。
设置是否支持私有加密模式(配置为系统播放器请设置为 NO,自研播放器设置为 YES)。默认设置为 YES。

接口详情

shareInstance

获取 TXVodDownloadManager 实例对象,单例模式。
+ (TXVodDownloadManager *)shareInstance;

setDownloadPath:

设置下载文件的根目录。此处设置的下载目录优先以+[TXPlayerGlobalSetting setCacheFolderPath:]设置为准。
- (void)setDownloadPath:(NSString *)path;

startDownload:

以腾讯云视频 fileId 方式开始下载。
- (TXVodDownloadMediaInfo *)startDownload:(TXVodDownloadDataSource *)source;
参数说明
参数名
类型
描述
source
下载资源对象。

startDownload:url:

以 URL 方式开始下载。
- (TXVodDownloadMediaInfo *)startDownload:(NSString *)username url:(NSString *)url;
参数说明
参数名
类型
描述
url
NSString
下载地址,必填。
username
NSString
账户名称,可选参数,不传默认为"default"。
返回值
视频信息和下载状态,具体见 TXVodDownloadMediaInfo

startDownloadUrl:resolution:userName:

以 URL 方式开始下载。
- (TXVodDownloadMediaInfo *)startDownloadUrl:(NSString *)url resolution:(long)resolution userName:(NSString *)username;
参数说明
参数名
类型
描述
url
NSString
下载地址,必填。
resolution
long
偏好清晰度,多清晰度 url 为必选参数,值为偏好清晰度宽 * 高(如720p传入921600 = 1280 * 720),单清晰度传入-1。
username
NSString
账户名称,可选参数,不传默认为"default"。
返回值
视频信息和下载状态,具体见 TXVodDownloadMediaInfo

startDownloadDrm:resolution:userName:

下载文件 DRM 视频。
- (TXVodDownloadMediaInfo *)startDownloadDrm:(TXPlayerDrmBuilder *)drmBuilder resolution:(long)resolution userName:(NSString *)username;
参数说明
参数名
类型
描述
drmBuilder
TXPlayerDrmBuilder
DRM 下载对象,参考 TXPlayerDrmBuilder
resolution
long
偏好清晰度,多清晰度 URL 为必选参数,值为偏好清晰度宽 * 高(如720p传入921600=1280*720),单清晰度传入-1。
username
NSString
账户名称,可选参数,不传默认为"default"。
返回值
视频信息和下载状态,具体见 TXVodDownloadMediaInfo

stopDownload:

停止下载,-[id<TXVodDownloadDelegate> onDownloadStop:] 回调时停止成功。
- (void)stopDownload:(TXVodDownloadMediaInfo *)media;
参数说明
参数名
类型
描述
downloadMediaInfo
视频下载信息。

deleteDownloadMediaInfo:

删除下载信息。
- (BOOL)deleteDownloadMediaInfo:(TXVodDownloadMediaInfo *)downloadMediaInfo;
参数说明
参数名
类型
描述
downloadMediaInfo
视频下载信息。
返回值
是否删除成功。YES:删除成功;NO:删除失败。文件正在下载将无法删除。

getDownloadMediaInfoList

获取所有用户的下载列表信息。
- (NSArray<TXVodDownloadMediaInfo *> *)getDownloadMediaInfoList;
返回值
视频下载信息列表:NSArray<TXVodDownloadMediaInfo>。

getDownloadMediaInfo:fileId:qualityId:userName:

获取下载信息。
调用此接口要确保之前通过 startDownload:startDownload:url:startDownloadDrm:resolution:userName:创建过下载任务参数。
- (TXVodDownloadMediaInfo *)getDownloadMediaInfo:(int)appId fileId:(NSString *)fileId qualityId:(int)qualityId userName:(NSString *)userName;
参数说明
参数名
类型
描述
appId
int
腾讯云点播应用 appId。
fileId
NSString
腾讯云点播视频 fileId。
qualityId
int
视频画质 Id , 具体参考 TXVodQuality 常量。
userName
NSString
账户名称,须与下载时传入的账户名称一致,若下载时未传入,这里传入空字符""。
返回值
视频下载信息 TXVodDownloadMediaInfo

getDownloadMediaInfo:resolution:userName:

获取下载信息。
- (TXVodDownloadMediaInfo *)getDownloadMediaInfo:(NSString *)url resolution:(long)preferredResolution userName:(NSString *)userName;
参数说明
参数名
类型
描述
url
NSString
下载地址,必选参数,否则下载失败。
preferredResolution
long
下载偏好清晰度,多清晰度 URL 为必选参数,值为偏好清晰度宽 * 高(如720p传入921600=1280*720),单清晰度传入-1。
userName
userName
账户名称,可选参数,不传默认为"default"。
返回值
视频下载信息 TXVodDownloadMediaInfo

encryptHexStringHls:

加密。

+ (NSString *)encryptHexStringHls:(NSString *)originHexStr
参数名
类型
描述
originHexStr
NSString
初始十六进制字符串。
返回值
加密串:NSString

headers

设置 http 请求头。

@property(nonatomic, strong) NSDictionary *headers;
参数名
类型
描述
headers
NSDictionary
http 请求头。

delegate

设置下载任务回调对象。

@property(nonatomic, weak) id<TXVodDownloadDelegate> delegate;
参数名
类型
描述
delegate
下载任务回调对象。

supportPrivateEncryptMode

是否支持私有加密模式(配置为系统播放器时设置为 NO,自研播放器设置为 YES)。默认为 YES。

@property(nonatomic, assign) BOOL supportPrivateEncryptMode;
参数名
类型
描述
supportPrivateEncryptMode
BOOL
是否支持私有加密模式。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈