tencent cloud

Video on Demand

TXVodPreloadManager

PDF
フォーカスモード
フォントサイズ
最終更新日: 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.

ヘルプとサポート

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

フィードバック