tencent cloud

Video on Demand

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Product Features
Features
Strengths
Scenarios
Solutions
Professional Edition
Introduction to Video On Demand Professional Edition
Quick Start
Console Guide
Development Guide
Purchase Guide
Billing Overview
Billing Modes
Purchase Guide
Viewing Bills
Renewal
Overdue Policy
Refund Policy
Getting Started
Console Guide
Console Overview
Service Overview
Application Management
Media Management
Package Management
License Management
Real-Time Log Analysis
Practical Tutorial
Media Upload
Smart Cold Storage of VOD Media Asset Files
Video Processing
Distribution and Playback
How to Receive Event Notification
How to Migrate Files from Origin Server to VOD
Live Recording
How to Pull from Custom Origin Servers
How to Use EdgeOne to Distribute Content in VOD
Development Guide
Media Upload
Media Processing
Video AI
Event Notification
Video Playback
Media Encryption and Copyright Protection
Broadcast Channel
CAM
Media File Download
Subapplication System
Error Codes
Player SDK
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
Server APIs
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
FAQs
Mobile Playback
Fees
Video Upload
Video Publishing
Video Playback
Web Playback
Full Screen Playback
Statistics
Access Management
Cold Storage
Agreements
Service Level Agreement
VOD Policy
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary

TXVodPreloadManager

PDF
Focus Mode
Font Size
Last updated: 2025-05-30 15:07:48

Introducing the TXVodPreloadManager API

On-demand player preload API class
No need to create a player instance. Pre-download partial video content to speed up startup time when using the player, delivering a better playback experience.

API Overview

API
Description
Retrieve the TXVodPreloadManager instance object in singleton mode.
Start preloading through URL.
Start preloading through fileId or URL. Preferentially use this API.
Stop preloading.

API Detail

getInstance

Retrieve the TXVodPreloadManager instance object in singleton mode.
public static TXVodPreloadManager getInstance(Context context)

startPreload:URL

Start preloading through URL.
Before starting preloading, set the cache directory TXPlayerGlobalSetting#setCacheFolderPath and cache size TXPlayerGlobalSetting#setMaxCacheSize for the playback engine. This setting is a global configuration and must be consistent with the player; otherwise, it can lead to playback cache failure.
public int startPreload(final String url, final float preloadSizeMB, final long preferredResolution, final ITXVodPreloadListener listener)
Parameter Description
Parameter Name
Type
Description
url
String
Preloaded video URL.
preloadSizeMB
float
Preload size, unit: MB.
preferredResolution
long
Expected download resolution, the product of video width and height (width * height).
Pass -1 when multiple resolutions are not supported or no specification is required.
listener
Preloading listening status callback.
Return Value
task ID, use this task ID to stop preloading TXVodPreloadManager#stopPreload.
If the return value is -1, it means this task ID is invalid.

startPreload:TXPlayInfoParams

Start preloading, support through Tencent Cloud fileId and video URL.
If TXPlayInfoParams#getUrl is not null, preferentially start video URL preloading, at this point support calling in the mainline.
If TXPlayInfoParams#getFileId is not null, start video fileId preloading, at this point does not support calling in the mainline.
Note:
1. Preloading is a time-consuming operation. Do not call it on the main thread; calling it on the main thread will throw an illegal call exception.
2. Set the cache directory TXPlayerGlobalSetting#setCacheFolderPath and cache size TXPlayerGlobalSetting#setMaxCacheSize of the playback engine before starting preloading. This setting is a global configuration and must be consistent with the player; otherwise, it can lead to playback cache failure.
public int startPreload(final TXPlayInfoParams playInfoParams, final float preloadSizeMB, final long preferredResolution,
final ITXVodFilePreloadListener listener)
Parameter Description
Parameter Name
Type
Description
playInfoParams
TXPlayInfoParams
Download information.
Set the http request headers for preloading using TXPlayInfoParams#setHeaders, and set the preferred audio track name for preloading using TXPlayInfoParams#setPreferAudioTrack.
preloadSizeMB
float
Preload size, unit: MB.
preferredResolution
long
Expected download resolution, the product of video width and height (width * height).
Pass -1 when multiple resolutions are not supported or no specification is required.
listener
Preloading listening status callback.
Return Value
task ID, use this task ID to stop preloading TXVodPreloadManager#stopPreload.
If the return value is -1, it means this task ID is invalid.

stopPreload

Stop preloading.
public void stopPreload(int taskID)
Parameter Description
Parameter Name
Type
Description
taskID
int
task ID. The ID is obtained from the return value of TXVodPreloadManager#startPreload.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback