tencent cloud

Video on Demand

動向とお知らせ
製品アップデート情報
製品紹介
製品概要
Product Features
製品の機能
製品の強み
ユースケース
ソリューション
購入ガイド
課金概要
課金方式
購入ガイドライン
請求書の照会
支払い更新の説明
支払い延滞の説明
返金説明
クイックスタート
コンソールガイド
コンソールの説明
サービスの概要
アプリケーション管理
メディア管理
リソースパック管理
License Management
プラクティスチュートリアル
メディアのアップロード
オンデマンドメディアファイルのインテリジェントコールド化方法
ビデオ処理
配信と再生
イベント通知の受信方法
オリジンサーバーのマイグレーションツール
Live Recording
カスタムオリジンサーバーback-to-originの方法
ライブストリーミングハイライトクリップを VOD に永続化するためのガイド
EdgeOne を使用して VOD コンテンツを配信する方法
開発ガイド
メディアアップロード
メディア加工処理
ビデオAI
イベント通知
ビデオ再生
メディアファイルのダウンロード
サブアプリケーションシステム
エラーコード
Player+ドキュメント
Overview
Basic Concepts
Features
Free Demo
Free Trial License
Purchase Guide
SDK Download
Licenses
Player Guide
Integration (UI Included)
Integration (No UI)
Advanced Features
API Documentation
Player Adapter
Player SDK Policy
よくあるご質問
モバイル端末再生に関するご質問
料金
ビデオのアップロード
ビデオの公開
ビデオの再生
Web側の再生
全画面表示再生
データ統計
CAM関連
メディア資産冷却に関する質問
Agreements
Service Level Agreement
VOD ポリシー
プライバシーポリシー
データ処理とセキュリティ契約
お問い合わせ
用語集

TXVodDownloadManager

PDF
フォーカスモード
フォントサイズ
最終更新日: 2025-05-30 15:02:39

TXVodDownloadManager API Introduction

On-demand video player download API class
Video download supports downloading MP4 and HLS videos, corresponds to nested HLS videos, requires specifying preferred resolution (preferredResolution).

Class Constant

Parameter Name
Type
Value
Description
TXVodDownloadManager#DOWNLOAD_SUCCESS
int
0
Download success.
TXVodDownloadManager#DOWNLOAD_AUTH_FAILED
int
-5001
File ID download authentication failure.
TXVodDownloadManager#DOWNLOAD_NO_FILE
int
-5003
File does not exist for download.
TXVodDownloadManager#DOWNLOAD_FORMAT_ERROR
int
-5004
Unsupported download format.
TXVodDownloadManager#DOWNLOAD_DISCONNECT
int
-5005
Network error.
TXVodDownloadManager#DOWNLOAD_HLS_KEY_ERROR
int
-5006
Failed to retrieve HLS decryption Key.
TXVodDownloadManager#DOWNLOAD_PATH_ERROR
int
-5007
Download directory access failure.
TXVodDownloadManager#DOWNLOAD_403FORBIDDEN
int
-5008
Signature expired or invalid request.

API Overview

API
Description
Retrieve the TXVodDownloadManager instance object in singleton mode.
Set the HTTP request header for downloading.
Set the download callback method, which must be configured before downloading.
Start the download using the URL method.
Start the download using the fileId method.
Start the download using the Drm method.
Stop downloading, stopped successfully when ITXVodDownloadListener.onDownloadStop callback is triggered.
Delete download information.
Retrieve download list information for all users, time-consuming API, do not call on the main thread.
Retrieve download information, time-consuming API, do not call on the main thread.
Retrieve download information, time-consuming API, do not call on the main thread.

API Detail

getInstance

Retrieve the TXVodDownloadManager instance object in singleton mode.
public static TXVodDownloadManager getInstance()

setHeaders

Set the HTTP request header for downloading.
public void setHeaders(Map<String, String> headers)

setListener

Set the download callback method, which must be configured before downloading.
public void setListener(ITXVodDownloadListener listener)
Parameter Description
Parameter Name
Type
Description
listener
Download listening status callback.

startDownloadUrl

Start the download using the URL method.
Set the cache directory of the playback engine before starting the download. TXPlayerGlobalSetting#setCacheFolderPath.
public TXVodDownloadMediaInfo startDownloadUrl(String url, long preferredResolution, String userName)
Parameter Description
Parameter Name
Type
Description
url
String
Download address, mandatory parameter; otherwise, the download will fail.
preferredResolution
long
Download preference resolution, multiple resolution URLs are mandatory parameters, with values being the width * height of the preferred resolution (e.g., for 720p, input 921600 = 1280*720), and -1 for single resolution.
userName
String
Account name, optional parameter; defaults to "default" if not provided.
Return Value
Video download information TXVodDownloadMediaInfo.

startDownloadUrl

Start the download using the URL method.
Abandoned, recommended for use: startDownloadUrl(String, long, String)
public TXVodDownloadMediaInfo startDownloadUrl(String url, String userName)

startDownloadUrl

Start the download using the URL method.
Abandoned, recommended for use: startDownloadUrl(String, long, String)
public TXVodDownloadMediaInfo startDownloadUrl(String url)

startDownload

Start the download using the Tencent Cloud Video fileId method.
public TXVodDownloadMediaInfo startDownload(final TXVodDownloadDataSource dataSource)
Parameter Description
Parameter Name
Type
Description
dataSource
Download a resource object.
Return Value
Video download information TXVodDownloadMediaInfo.

startDownloadDrm

Start the download using the Drm method.
public TXVodDownloadMediaInfo startDownloadDrm(final TXPlayerDrmBuilder drmBuilder, long preferredResolution, String userName)
Parameter Description
Parameter Name
Type
Description
drmBuilder
Construct a Drm resource.
preferredResolution
long
Download preference resolution. Multiple resolution URLs are required parameters, with values being the width * height of the preferred resolution (e.g., for 720p, input 921600 = 1280*720). For single resolution, input -1.
userName
String
Account name, optional parameter; defaults to "default" if not provided.
Return Value
Video download information TXVodDownloadMediaInfo.

stopDownload

Stop downloading, stopped successfully when ITXVodDownloadListener.onDownloadStop callback is triggered.
public void stopDownload(TXVodDownloadMediaInfo downloadMediaInfo)
Parameter Description
Parameter Name
Type
Description
downloadMediaInfo
Video download information.

deleteDownloadFile

Delete downloaded files.
Abandoned, recommended for use: deleteDownloadMediaInfo.
public boolean deleteDownloadFile(String playPath)
Parameter Description
Parameter Name
Type
Description
playPath
String
File path.

deleteDownloadMediaInfo

Delete download information.
public boolean deleteDownloadMediaInfo(TXVodDownloadMediaInfo downloadMediaInfo)
Parameter Description
Parameter Name
Type
Description
downloadMediaInfo
Video download information.

getDownloadMediaInfoList

Retrieve download list information for all users.
public List<TXVodDownloadMediaInfo> getDownloadMediaInfoList()
Return Value
Video download information list: List<TXVodDownloadMediaInfo>.

getDownloadMediaInfo

Retrieve download information.
Call this API and ensure that the download task parameters are created via TXVodDownloadDataSource(int, String, int, String, String) beforehand.
Refer to TXVodDownloadMediaInfo#getDataSource and TXVodDownloadDataSource#getUserName.
public TXVodDownloadMediaInfo getDownloadMediaInfo(int appId, String fileId, int qualityId, String userName)
Parameter Description
Parameter Name
Type
Description
appId
int
Tencent Cloud Video on Demand (VOD) application appId.
fileId
String
Tencent Cloud Video on Demand (VOD) video fileId.
qualityId
int
Video QUALITY Id, refer to the constant TXVodDownloadDataSource#QUALITY_240P.
userName
String
Account name, must match the account name passed in during download. If not passed in during download, pass in an empty string "" here.
Return Value
Video download information TXVodDownloadMediaInfo.

getDownloadMediaInfo

Retrieve download information. Call this API and ensure that the download is started by calling startDownloadUrl(String, long, String) beforehand.
public TXVodDownloadMediaInfo getDownloadMediaInfo(String url, long preferredResolution, String userName)
Parameter Description
Parameter Name
Type
Description
url
String
Download address, mandatory parameter; otherwise, the download will fail.
preferredResolution
long
Download preference resolution. Multiple resolution URLs are required parameters, with values being the width * height of the preferred resolution (e.g., for 720p, input 921600 = 1280*720). For single resolution, input -1.
userName
String
Account name, optional parameter; defaults to "default" if not provided.
Return Value
Video download information TXVodDownloadMediaInfo.

getDownloadMediaInfo

Retrieve URL download information. Abandoned, recommended for use: getDownloadMediaInfo(String, long, String).
public TXVodDownloadMediaInfo getDownloadMediaInfo(String url)

getDownloadMediaInfo

Retrieve URL download information. Abandoned, recommended for use: getDownloadMediaInfo(String, long, String).
public TXVodDownloadMediaInfo getDownloadMediaInfo(int appId, String fileId, int qualityId)

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック