TXVodPreloadManager API 简介
点播播放器预下载接口类。
不需要创建播放器实例,预先下载视频部分内容,使用播放器时,可以加快视频启播速度,提供更好的播放体验。
接口概览
API | 描述 |
获取 TXVodPreloadManager 实例对象,单例模式。 | |
通过 URL 启动预下载。 | |
停止预下载。 |
接口详情
getInstance
获取 TXVodPreloadManager 实例对象,单例模式。
public static getInstance(context: Context): TXVodPreloadManager
startPreloadUrl
通过 URL 启动预下载。
注意:启动预下载前,请先设置好播放引擎的缓存目录
TXVodGlobalSetting.setCacheFolderPath 和缓存大小 TXVodGlobalSetting.setMaxCacheSize,这个设置是全局配置需和播放器保持一致,否则会造成播放缓存失效。public startPreloadUrl(url: string, preloadSizeMB: number, preferredResolution: number,headers: Map<string, string>, callback: ITXVodPreloadCallback): number
参数说明
参数名 | 类型 | 描述 |
url | string | 预下载的视频 URL。 |
preloadSizeMB | number | 预下载的大小,单位 MB。 |
preferredResolution | number | 期望下载的分辨率,视频宽高的乘积(width × height)。 不支持多分辨率或不需指定时,传 -1。 |
headers | Map<string, string> | 预下载 HTTP 头。 |
callback | ITXVodPreloadCallback | 预下载监听状态回调。 |
返回值
任务 ID,可用这个任务 ID 停止预下载
TXVodPreloadManager.stopPreload。如果返回 -1,表示此任务 ID 无效。
stopPreload
停止预下载。
public stopPreload(taskId: number): void
参数说明
参数名 | 类型 | 描述 |
taskId | number | 任务 ID,从 `TXVodPreloadManager.startPreloadUrl` 返回值得到。 |