tencent cloud

Video on Demand

TXVodPreloadManager

Download
포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-05-30 14:56:32

TXVodPreloadManager API Introduction

VOD player pre-download API class
No need to create a player instance. Pre-download partial video content to accelerate startup speed and provide better playback experience when using the player.

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

sharedManager

Retrieve the TXVodPreloadManager instance object in singleton mode.
+ (instancetype)sharedManager;

startPreload:preloadSize:preferredResolution:delegate:

Start preloading through URL.
Before starting preloading, set the playback engine's cache directory +[TXPlayerGlobalSetting setCacheFolderPath] and cache size.
+[TXPlayerGlobalSetting setMaxCacheSize:]. This setting is a global configuration and must be consistent with the player; otherwise, it can lead to playback cache failure.
- (int)startPreload:(NSString *)requestURL preloadSize:(float)preloadSizeMB preferredResolution:(long)preferredResolution delegate:(id<TXVodPreloadManagerDelegate>)delegate;
Parameter Description
Parameter Name
Type
Description
requestURL
NSString
Preloaded video URL.
preloadSizeMB
float
Preloaded 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.
delegate
Preloading listening status callback object.
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.

startPreloadWithModel:preloadSize:preferredResolution:delegate:

Start preloading, support through Tencent Cloud fileId and video URL.
If -[TXPlayerAuthParams url] is not empty, prioritize starting video URL preloading, and at this point, support calling in the mainline.
If -[TXPlayerAuthParams fileId] is not empty, start video fileId preloading. At this point, calling in the mainline is not supported.
Note:
1. Preloading is a time-consuming operation. Do not call it in the main thread; calling it in the main thread will throw an illegal call exception.
2. Before starting preloading, set the playback engine's cache directory +[TXPlayerGlobalSetting setCacheFolderPath:] and cache size +[TXPlayerGlobalSetting setMaxCacheSize:]. This setting is a global configuration and must be consistent with the player; otherwise, it can lead to playback cache failure.
- (int)startPreloadWithModel:(TXPlayerAuthParams *)params preloadSize:(float)preloadSizeMB preferredResolution:(long)preferredResolution delegate:(id<TXVodPreloadManagerDelegate>)delegate;
Parameter Description
Parameter Name
Type
Description

params



Download information.
Set the http request header for preloading via -[TXPlayerAuthParams headers], and set the audio track name for preloading via -[TXPlayerAuthParams preferAudioTrack].
preloadSizeMB
float
Preloaded 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.
delegate
Preloading listening status callback object.
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.
- (void)stopPreload:(int)taskID;
Parameter Description
Parameter Name
Type
Description
taskID
int
task ID. The ID is obtained from the API return value of the startPreload interface.


도움말 및 지원

문제 해결에 도움이 되었나요?

피드백