# TTVideoEngine ```objectivec @interface TTVideoEngine : NSObject ``` 播放引擎。`TTVideoEngine` 为点播 SDK 的核心对象，提供播放核心接口。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [failPlayOffline](#TTVideoEngine-failplayoffline) | | id\ | [urlRefreshFetcher](#TTVideoEngine-urlrefreshfetcher) | | CGFloat | [playbackSpeed](#TTVideoEngine-playbackspeed) | | BOOL | [muted](#TTVideoEngine-muted) | | BOOL | [radioMode](#TTVideoEngine-radiomode) | | BOOL | [hardwareDecode](#TTVideoEngine-hardwaredecode) | | BOOL | [looping](#TTVideoEngine-looping) | | UIView* | [playerView](#TTVideoEngine-playerview) | | NSTimeInterval | [currentPlaybackTime](#TTVideoEngine-currentplaybacktime) | | NSTimeInterval | [duration](#TTVideoEngine-duration) | | NSTimeInterval | [playableDuration](#TTVideoEngine-playableduration) | | NSTimeInterval | [durationWatched](#TTVideoEngine-durationwatched) | | TTVideoEngineState | [state](#TTVideoEngine-state) | | TTVideoEnginePlaybackState | [playbackState](#TTVideoEngine-playbackstate) | | TTVideoEngineLoadState | [loadState](#TTVideoEngine-loadstate) | | TTVideoEngineStallReason | [stallReason](#TTVideoEngine-stallreason) | | TTVideoEngineResolutionType | [currentResolution](#TTVideoEngine-currentresolution) | ## 静态函数 | 返回 | 名称 | | --- | --- | | void | [setLogFlag:](#TTVideoEngine-setlogflag) | | BOOL | [isSupportMetal](#TTVideoEngine-issupportmetal) | | BOOL | [isSupportH266](#TTVideoEngine-issupporth266) | ## 成员函数 | 返回 | 名称 | | --- | --- | | instancetype | [initWithOwnPlayer:](#TTVideoEngine-initwithownplayer) | | void | [setSubtitleAuthToken:](#TTVideoEngine-setsubtitleauthtoken) | | void | [setCustomHeaderValue:forKey:](#TTVideoEngine-setcustomheadervalue-forkey) | | void | [setLocalURL:](#TTVideoEngine-setlocalurl) | | void | [setBarrageMaskURL:fileHash:](#TTVideoEngine-setbarragemaskurl-filehash) | | void | [prepareToPlay](#TTVideoEngine-preparetoplay) | | void | [play](#TTVideoEngine-play) | | void | [pause](#TTVideoEngine-pause) | | void | [pause:](#TTVideoEngine-pause) | | void | [stop](#TTVideoEngine-stop) | | void | [close](#TTVideoEngine-close) | | void | [closeAysnc](#TTVideoEngine-closeaysnc) | | void | [setCurrentPlaybackTime:complete:](#TTVideoEngine-setcurrentplaybacktime-complete) | | void | [setCurrentPlaybackTime:complete:renderComplete:](#TTVideoEngine-setcurrentplaybacktime-complete-rendercomplete) | | void | [addPeriodicTimeObserverForInterval:queue:usingBlock:](#TTVideoEngine-addperiodictimeobserverforinterval-queue-usingblock) | | void | [removeTimeObserver](#TTVideoEngine-removetimeobserver) | | nullable NSArray\* | [supportedResolutionTypes](#TTVideoEngine-supportedresolutiontypes) | | nullable NSArray\* | [supportedQualityInfos](#TTVideoEngine-supportedqualityinfos) | | BOOL | [configResolution:](#TTVideoEngine-configresolution) | | void | [configResolution:completion:](#TTVideoEngine-configresolution-completion) | | void | [configResolution:withCompletion:](#TTVideoEngine-configresolution-withcompletion) | | NSInteger | [videoSizeForType:](#TTVideoEngine-videosizefortype) | | nullable CVPixelBufferRef | [copyPixelBuffer](#TTVideoEngine-copypixelbuffer) | | BOOL | [isSupportHDR](#TTVideoEngine-issupporthdr) | | BOOL | [isSupportSR](#TTVideoEngine-issupportsr) | | void | [setFFmpegProtocol:](#TTVideoEngine-setffmpegprotocol) | | void | [snapshot:](#TTVideoEngine-snapshot) | ## 变量说明 ### failPlayOffline ```objectivec @property (nonatomic, assign) BOOL failPlayOffline; ``` 设置是否支持FairPlay离线播放： - YES: 使用默认/自行初始化的contentKeySessionDelegate播放。 - NO:（默认）使用默认/自行初始化的resourceLoaderDelegate播放。 ### urlRefreshFetcher ```objectivec @property (nonatomic, nullable, weak) id urlRefreshFetcher; ``` 设置 URL 过期时请求新的播放地址的回调。 ### playbackSpeed ```objectivec @property (nonatomic, assign) CGFloat playbackSpeed; ``` 设置播放倍速，默认为 1，取值范围为 (0,3]。 ### muted ```objectivec @property (nonatomic, assign) BOOL muted; ``` 设置是否静音： - YES: 静音。 - NO:（默认）没有静音。 ### radioMode ```objectivec @property (nonatomic, assign) BOOL radioMode; ``` 设置是否开启纯音频播放模式： - YES: 开启。 - NO:（默认）关闭。 ### hardwareDecode ```objectivec @property (nonatomic, assign) BOOL hardwareDecode; ``` 设置是否开启硬件解码： - YES: 开启。 - NO: 关闭。 SDK 默认开启硬件解码。 ### looping ```objectivec @property (nonatomic, assign) BOOL looping; ``` 设置是否开启循环播放： - YES: 开启。 - NO:（默认）关闭。 ### playerView ```objectivec @property (nonatomic, strong, readonly) UIView *playerView; ``` 播放器的显示视图。 ### currentPlaybackTime ```objectivec @property (nonatomic, assign, readonly) NSTimeInterval currentPlaybackTime; ``` 当前播放时间，单位为秒。 ### duration ```objectivec @property (nonatomic, assign, readonly) NSTimeInterval duration; ``` 视频总时长，单位为秒。 ### playableDuration ```objectivec @property (nonatomic, assign, readonly) NSTimeInterval playableDuration; ``` 当前可播放时长，即缓存进度，单位为秒。 ### durationWatched ```objectivec @property (nonatomic, assign, readonly) NSTimeInterval durationWatched; ``` 已观看总时长，单位为秒。 ### state ```objectivec @property (nonatomic, assign, readonly) TTVideoEngineState state; ``` 当前播放器状态，详见 [TTVideoEngineState](803941#TTVideoEngineState) 。 ### playbackState ```objectivec @property (nonatomic, assign, readonly) TTVideoEnginePlaybackState playbackState; ``` 当前播放状态，详见 [TTVideoEnginePlaybackState](803941#TTVideoEnginePlaybackState) 。 ### loadState ```objectivec @property (nonatomic, assign, readonly) TTVideoEngineLoadState loadState; ``` 当前播放器加载状态，详见 [TTVideoEngineLoadState](803941#TTVideoEngineLoadState) 。 ### stallReason ```objectivec @property (nonatomic, assign, readonly) TTVideoEngineStallReason stallReason; ``` 播放器卡顿原因，详见 [TTVideoEngineStallReason](803941#TTVideoEngineStallReason) 。 ### currentResolution ```objectivec @property (nonatomic, assign, readonly) TTVideoEngineResolutionType currentResolution; ``` 当前视频分辨率，详见 [TTVideoEngineResolutionType](803941#TTVideoEngineResolutionType) 。 ## 函数说明 ### setLogFlag: ```objectivec + (void)setLogFlag:(TTVideoEngineLogFlag)flag; ``` 设置 SDK 输出 log 模块。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | flag | TTVideoEngineLogFlag | 输出 log 模块，详见 [TTVideoEngineLogFlag](803941#TTVideoEngineLogFlag) 。 | **注意** - 建议 debug 模式下设置为 `TTVideoEngineLogFlagDefault`，release 模式下设置为 `TTVideoEngineLogFlagNone`。 - 如果你在 debug 模式下开启了日志输出，一定要在发版本前检查是否关闭了日志输出。 ### isSupportMetal ```objectivec + (BOOL)isSupportMetal; ``` 判断当前设备是否支持 Metal 渲染。 **返回值** 是否支持 Metal 渲染： - YES: 支持。 - NO: 不支持。 ### isSupportH266 ```objectivec + (BOOL)isSupportH266; ``` 判断当前设备是否支持 H.266。 **返回值** 当前设备是否支持 H.266： - YES: 支持。 - NO: 不支持。 **注意** H.266 使用软解，相对比较耗性能，中高端以上机型支持开启 H.266。 ### initWithOwnPlayer: ```objectivec - (instancetype)initWithOwnPlayer:(BOOL)isOwnPlayer; ``` 初始化播放器实例。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | isOwnPlayer | BOOL | 是否使用自研播放器

`YES`: 火山自研播放器。
`NO`: 系统播放器。

| **返回值** 调用成功后，返回播放器实例。 **注意** 强烈建议初始化时设置为 `YES` 使用火山自研播放器。如使用系统播放器，您将无法使用预加载、本地缓存等功能。 ### setSubtitleAuthToken: ```objectivec - (void)setSubtitleAuthToken:(NSString *)auth; ``` 设置字幕鉴权 token。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | auth | NSString* | 字幕鉴权 token。 | ### setCustomHeaderValue:forKey: ```objectivec - (void)setCustomHeaderValue:(NSString *)value forKey:(NSString *)key; ``` 设置播放器请求自定义 header 字段。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | value | NSString* | 键值 value。 | | key | NSString* | 键值 key。 | ### setLocalURL: ```objectivec - (void)setLocalURL:(NSString *)url; ``` 设置本地视频源。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSString* | 本地视频地址，例如 `file://xxx.xx`。 | **注意** 您可调用此方法将本地资源的地址设置给播放器。 ### setBarrageMaskURL:fileHash: ```objectivec - (void)setBarrageMaskURL:(NSString *)url fileHash:(nullable NSString *)fileHash; ``` 设置蒙版弹幕 URL。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSString* | 蒙版弹幕 URL。 | | fileHash | nullable NSString* | 文件的唯一标识，建议使用文件 hash 值或 URL MD5 值。 | ### prepareToPlay ```objectivec - (void)prepareToPlay; ``` 准备播放。 **注意** 该方法适用于预渲染策略。您设置播放源后，需要调用此方法，播放器会渲染第一帧，但不会马上播放。 ### play ```objectivec - (void)play; ``` 开始播放。 ### pause ```objectivec - (void)pause; ``` 暂停播放。 ### pause: ```objectivec - (void)pause:(BOOL)async; ``` 暂停播放。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | async | BOOL | 是否异步暂停。 | ### stop ```objectivec - (void)stop; ``` 停止播放。 ### close ```objectivec - (void)close; ``` 关闭销毁播放器。 **注意** 销毁播放器实例后，不能再调用任何方法。您可以将 `engine` 实例设置为 `nil`，防止再次调用。 ### closeAysnc ```objectivec -(void)closeAysnc; ``` 异步关闭销毁播放器。 **注意** - 此方法异步销毁播放器实例，不影响主线程。 - 异步关闭有助于避免视频上下滑动中造成 UI 卡顿。 - 销毁播放器实例后，不能再调用任何方法。您可以将 `engine` 实例设置为 `nil`，防止再次调用。 ### setCurrentPlaybackTime:complete: ```objectivec - (void)setCurrentPlaybackTime:(NSTimeInterval)currentPlaybackTime complete:(void(^)(BOOL success))finised; ``` 跳转至指定时间戳位置播放。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | currentPlaybackTime | NSTimeInterval | 指定位置。 | | finised | void(^)(BOOL success) | 跳转完成回调。 | **注意** 您可以调用此方法实现拖拽进度条到指定时间开始播放的功能。 ### setCurrentPlaybackTime:complete:renderComplete: ```objectivec - (void)setCurrentPlaybackTime:(NSTimeInterval)currentPlaybackTime complete:(void(^)(BOOL success))finised renderComplete:(void(^)(void)) renderComplete; ``` 跳转至指定时间戳位置播放。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | currentPlaybackTime | NSTimeInterval | 指定位置。 | | finised | void(^)(BOOL success) | 跳转完成回调。 | | renderComplete | void(^)(void) | 渲染完成回调。 | **注意** 您可以调用此方法实现拖拽进度条到指定时间开始播放的功能。 ### addPeriodicTimeObserverForInterval:queue:usingBlock: ```objectivec - (void)addPeriodicTimeObserverForInterval:(NSTimeInterval)interval queue:(dispatch_queue_t)queue usingBlock:(void (^)(void))block; ``` 内部封装 NSTimer 定时器，方便您在 block 回调中更新播放进度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | interval | NSTimeInterval | 回调时间间隔，单位为秒。 | | queue | dispatch_queue_t | 指定线程队列。 | | block | void(^)(void) | 回调。 | ### removeTimeObserver ```objectivec - (void)removeTimeObserver; ``` 与 `addPeriodicTimeObserverForInterval:queue:usingBlock` 配对使用。 **注意** 播放器销毁后切记一定要调用该方法，否则可能产生内存泄漏。 ### supportedResolutionTypes ```objectivec - (nullable NSArray *)supportedResolutionTypes; ``` 播放 Vid 视频源时，获取所有分辨率的值。 **返回值** 返回所有分辨率值数组。 ### supportedQualityInfos ```objectivec - (nullable NSArray *)supportedQualityInfos; ``` 播放 Vid 视频源时，获取所有分辨率的描述。 **返回值** 返回所有分辨率描述数组。 ### configResolution: ```objectivec - (BOOL)configResolution:(TTVideoEngineResolutionType)resolution; ``` 设置起播分辨率或者切换分辨率。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | resolution | TTVideoEngineResolutionType | 视频分辨率，详见 [TTVideoEngineResolutionType](803941#TTVideoEngineResolutionType) 。 | **返回值** 方法调用结果： - YES: 成功。 - NO: 失败。 **注意** 您可在播放前调用此方法预设分辨率，也可在播放中调用此方法切换分辨率。 ### configResolution:completion: ```objectivec - (void)configResolution:(TTVideoEngineResolutionType)resolution completion:(void(^)(BOOL success, TTVideoEngineResolutionType completeResolution))completion; ``` 设置起播或者切换分辨率。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | resolution | TTVideoEngineResolutionType | 视频分辨率，详见 [TTVideoEngineResolutionType](803941#TTVideoEngineResolutionType) 。 | | completion | void(^)(BOOL success, TTVideoEngineResolutionType completeResolution) | 切换分辨率完成回调。 | **返回值** 方法调用结果： - YES: 成功。 - NO: 失败。 **注意** 您可在播放前调用此方法预设分辨率，也可在播放中调用此方法切换分辨率。 ### configResolution:withCompletion: ```objectivec - (void)configResolution:(TTVideoEngineResolutionType)resolution withCompletion:(void(^)(BOOL success, NSError* __nullable err, TTVideoEngineResolutionType completeResolution))completion; ``` 设置起播或者切换分辨率。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | resolution | TTVideoEngineResolutionType | 视频分辨率，详见 [TTVideoEngineResolutionType](803941#TTVideoEngineResolutionType) 。 | | completion | void(^)(BOOL success, NSError*__nullable err, TTVideoEngineResolutionType completeResolution) | 切换分辨率完成回调，如果出现错误，回调中将携带错误信息。 | **返回值** 方法调用结果： - YES: 成功。 - NO: 失败。 **注意** 您可在播放前调用此方法预设分辨率，也可在播放中调用此方法切换分辨率。 ### videoSizeForType: ```objectivec - (NSInteger)videoSizeForType:(TTVideoEngineResolutionType)type; ``` 获取指定分辨率的视频大小，单位为 byte。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | TTVideoEngineResolutionType | 分辨率，详见 [TTVideoEngineResolutionType](803941#TTVideoEngineResolutionType) 。 | **返回值** 视频大小，单位为 byte。 ### copyPixelBuffer ```objectivec - (nullable CVPixelBufferRef)copyPixelBuffer; ``` 获取当前渲染 CVPixelBufferRef。 **返回值** 返回当前渲染 CVPixelBufferRef。 **注意** 您可以通过该方法实现自定义渲染。 ### isSupportHDR ```objectivec - (BOOL)isSupportHDR; ``` 判断当前设备是否支持 HDR 播放。 **返回值** 是否支持 HDR： - YES: 支持。 - NO: 不支持。 **注意** SDK 内部有支持 HDR 播放的设备白名单。SDK 会检查当前设备是否在白名单中，以确定当前设备是否支持 HDR 播放。 ### isSupportSR ```objectivec - (BOOL)isSupportSR; ``` 判断当前设备是否支持超分。 **返回值** 是否支持超分： - YES: 支持。 - NO: 不支持。 **注意** SDK 内部有支持超分的设备白名单。SDK 会检查当前设备是否在白名单中，以确定当前设备是否支持超分。 ### setFFmpegProtocol: ```objectivec - (void)setFFmpegProtocol:(id) obj; ``` 设置您自行实现的 `TTVideoEngineFFmpegProtocol` 协议对象，用于支持私有 FFmpeg 加密协议。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | obj | id\ | 您自行实现的 `TTVideoEngineFFmpegProtocol` 协议的对象。 | ### snapshot: ```objectivec - (void)snapshot:(void(^)(UIImage *))completion; ``` 截屏。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | completion | void(^)(UIImage*) | 截屏完成回调。 | # TTVideoEngine(EngineStrategy) ```objectivec @interface TTVideoEngine (EngineStrategy) ``` 策略相关接口。 ## 静态函数 | 返回 | 名称 | | --- | --- | | BOOL | [enableEngineStrategy:scene:](#TTVideoEngine(EngineStrategy)-enableenginestrategy-scene) | | BOOL | [enableEnginePreRenderStrategy:](#TTVideoEngine(EngineStrategy)-enableengineprerenderstrategy) | | BOOL | [enableEnginePreloadStrategy:](#TTVideoEngine(EngineStrategy)-enableenginepreloadstrategy) | | BOOL | [enableEnginePreloadStrategy:scene:](#TTVideoEngine(EngineStrategy)-enableenginepreloadstrategy-scene) | | void | [clearAllEngineStrategy](#TTVideoEngine(EngineStrategy)-clearallenginestrategy) | ## 函数说明 ### enableEngineStrategy:scene: ```objectivec + (BOOL)enableEngineStrategy:(TTVideoEngineStrategyType)strategyType scene:(NSString *)scene; ``` 开启策略。SDK 支持预加载和预渲染策略。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | strategyType | TTVideoEngineStrategyType | 策略类型，详见 [TTVideoEngineStrategyType](803941#TTVideoEngineStrategyType) 。 | | scene | NSString* | 使用场景。SDK 策略搭配场景使用，可达到不同场景最佳实践。支持以下场景：

`TTVEngineStrategySceneSmallVideo`: 短视频场景，类似抖音的 Feed 页。
`TTVEngineStrategySceneShortVideo`: 中视频场景，类似西瓜的 Feed 页。

| **返回值** 预渲染策略是否开启成功： - YES: 是。 - NO: 否。 **注意** - 建议在进入页面后开启策略。 - 关于预加载和预渲染策略的具体使用方法，详见 [iOS 短视频场景](https://www.volcengine.com/docs/4/101200)。 ### enableEnginePreRenderStrategy: ```objectivec + (BOOL)enableEnginePreRenderStrategy:(NSString *)scene; ``` 开启预渲染策略。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | scene | NSString* | 使用场景。SDK 策略搭配场景使用，可达到不同场景最佳实践。支持以下场景：

`TTVEngineStrategySceneSmallVideo`: 短视频场景，类似抖音的 Feed 页。
`TTVEngineStrategySceneShortVideo`: 中视频场景，类似西瓜的 Feed 页。

| **返回值** 预渲染策略是否开启成功： - YES: 是。 - NO: 否。 ### enableEnginePreloadStrategy: ```objectivec + (BOOL)enableEnginePreloadStrategy:(NSString *)scene; ``` 开启预加载策略。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | scene | NSString* | 使用场景。SDK 策略搭配场景使用，可达到不同场景最佳实践。支持以下场景：

`TTVEngineStrategySceneSmallVideo`: 短视频场景，类似抖音的 Feed 页。
`TTVEngineStrategySceneShortVideo`: 中视频场景，类似西瓜的 Feed 页。

| **返回值** 预加载策略是否开启成功： - YES: 是。 - NO: 否。 ### enableEnginePreloadStrategy:scene: ```objectivec + (BOOL)enableEnginePreloadStrategy:(TTVideoEngineStrategyPreloadConfig *)preloadConfig scene:(NSString *)scene; ``` 开启预加载策略并自定义预加载策略配置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | preloadConfig | TTVideoEngineStrategyPreloadConfig* | 预加载策略配置，详见 [TTVideoEngineStrategyPreloadConfig](803941#TTVideoEngineStrategyType)。 | | scene | NSString* | 使用场景。SDK 策略搭配场景使用，可达到不同场景最佳实践。支持以下场景：

`TTVEngineStrategySceneSmallVideo`: 短视频场景，类似抖音的 Feed 页。
`TTVEngineStrategySceneShortVideo`: 中视频场景，类似西瓜的 Feed 页。

| **返回值** 预加载策略是否开启成功： - YES: 是。 - NO: 否。 ### clearAllEngineStrategy ```objectivec + (void)clearAllEngineStrategy; ``` 清除所有策略，释放资源。 **注意** 在退出当前页面或切换到其他页面时调用此方法。 # TTVideoEngine(EngineStrategySource) ```objectivec @interface TTVideoEngine (EngineStrategySource) ``` 预加载和预渲染策略相关接口 ## 静态函数 | 返回 | 名称 | | --- | --- | | void | [setStrategyVideoSources:](#TTVideoEngine(EngineStrategySource)-setstrategyvideosources) | | void | [addStrategyVideoSources:](#TTVideoEngine(EngineStrategySource)-addstrategyvideosources) | ## 函数说明 ### setStrategyVideoSources: ```objectivec + (void)setStrategyVideoSources:(NSArray> *)videoSources; ``` 设置当前页面播放源列表。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoSources | NSArray\>* | 播放源，详见 [TTVideoEngineMediaSource](803941#TTVideoEngineMediaSource) 。 | **注意** - 该方法用于预加载或预渲染策略。 - 调用该方法会重置当前的播放源列表，用于首次设置播放源或在刷新页面以显示新数据时使用。 ### addStrategyVideoSources: ```objectivec + (void)addStrategyVideoSources:(NSArray> *)videoSources; ``` 添加播放源数据到当前播放源列表。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoSources | NSArray\>* | 播放源，详见 [TTVideoEngineMediaSource](803941#TTVideoEngineMediaSource) 。 | **注意** - 该方法用于预加载或预渲染策略。 - 该方法适用于加载更多数据的业务场景。 # TTVideoEngine(EngineStrategyPreRender) ```objectivec @interface TTVideoEngine (EngineStrategyPreRender) ``` 预渲染相关方法。 ## 静态函数 | 返回 | 名称 | | --- | --- | | void | [setPreRenderVideoEngineDelegate:](#TTVideoEngine(EngineStrategyPreRender)-setprerendervideoenginedelegate) | | TTVideoEngine | [getPreRenderVideoEngineWithVideoSource:](#TTVideoEngine(EngineStrategyPreRender)-getprerendervideoenginewithvideosource) | | UIView* | [getPreRenderFinishedPlayerViewWithVideoSource:](#TTVideoEngine(EngineStrategyPreRender)-getprerenderfinishedplayerviewwithvideosource) | | TTVideoEngine | [getPreRenderFinishedVideoEngineWithVideoSource:](#TTVideoEngine(EngineStrategyPreRender)-getprerenderfinishedvideoenginewithvideosource) | ## 函数说明 ### setPreRenderVideoEngineDelegate: ```objectivec + (void)setPreRenderVideoEngineDelegate:(id)delegate; ``` 设置预渲染策略的代理。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | delegate | id\ | 预渲染策略的代理对象，详见 [TTVideoEnginePreRenderDelegate](518261#TTVideoEnginePreRenderDelegate) 。 | ### getPreRenderVideoEngineWithVideoSource: ```objectivec + (TTVideoEngine * _Nullable)getPreRenderVideoEngineWithVideoSource:(id)source; ``` 通过播放源获取预渲染 `TTVideoEngine` 对象。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | source | id\ | 播放源，详见 [TTVideoEngineMediaSource](803941#TTVideoEngineMediaSource) 。 | **返回值** 返回预渲染 `TTVideoEngine` 对象实例。 ### getPreRenderFinishedPlayerViewWithVideoSource: ```objectivec + (UIView * _Nullable)getPreRenderFinishedPlayerViewWithVideoSource:(id)source; ``` 通过播放源获取预渲染 `TTVideoEngine` 对象播放器视图。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | source | id\ | 播放源，详见 [TTVideoEngineMediaSource](803941#TTVideoEngineMediaSource) 。 | **返回值** 返回预渲染 `TTVideoEngine` 对象播放器视图。 **注意** 您通过 `TTVideoEngine` 对象播放器视图是否为 `nil` 判断预渲染是否完成。 ### getPreRenderFinishedVideoEngineWithVideoSource: ```objectivec + (TTVideoEngine * _Nullable)getPreRenderFinishedVideoEngineWithVideoSource:(id)source; ``` 通过播放源获取预渲染 `TTVideoEngine` 对象。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | source | id\ | 播放源，详见 [TTVideoEngineMediaSource](803941#TTVideoEngineMediaSource) 。 | **返回值** 返回预渲染 `TTVideoEngine` 对象。 **注意** 您可通过 `TTVideoEngine` 对象是否为 `nil` 判断预渲染是否完成。 # TTVideoEngine(EngineStrategyPreload) ```objectivec @interface TTVideoEngine (EngineStrategyPreload) ``` 自定义预加载相关接口。 ## 静态函数 | 返回 | 名称 | | --- | --- | | void | [startEnginePreloadStrategyWithIndex:](#TTVideoEngine(EngineStrategyPreload)-startenginepreloadstrategywithindex) | ## 函数说明 ### startEnginePreloadStrategyWithIndex: ```objectivec + (void)startEnginePreloadStrategyWithIndex:(NSInteger)startIndex; ``` 开始执行预加载策略。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | startIndex | NSInteger | 预加载开始位置。 | # TTVideoEngine(DebugTool) ```objectivec @interface TTVideoEngine (DebugTool) ``` Debug 工具相关接口，方便您在开发期间查看播放信息和版本信息。 ## 静态函数 | 返回 | 名称 | | --- | --- | | BOOL | [debugToolIsShowing](#TTVideoEngine(DebugTool)-debugtoolisshowing) | | void | [showDebugTool:](#TTVideoEngine(DebugTool)-showdebugtool) | | void | [showDebugTool:inRect:](#TTVideoEngine(DebugTool)-showdebugtool-inrect) | | void | [refreshCurrentVideoEngine:](#TTVideoEngine(DebugTool)-refreshcurrentvideoengine) | | void | [removeDebugTool](#TTVideoEngine(DebugTool)-removedebugtool) | ## 函数说明 ### debugToolIsShowing ```objectivec + (BOOL)debugToolIsShowing; ``` 确认 Debug 工具是否正在显示中。 ### showDebugTool: ```objectivec + (void)showDebugTool:(UIView *)containerView; ``` 添加 Debug 工具。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | containerView | UIView* | 用于展示 Debug 工具的 `containerView`。 | **注意** - 调用该方法后，播放器内部会把当前正在播放的 `TTVideoEngine` 实例自动添加到 Debug 工具中，不需要您再频繁地设置 `TTVideoEngine` 实例。 - 该方法适合短视频（例如抖音）、中视频（例如西瓜）等需要频繁切换播放的场景。 ### showDebugTool:inRect: ```objectivec + (void)showDebugTool:(UIView *)containerView inRect:(CGRect)rect; ``` 添加 Debug 工具。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | containerView | UIView* | 用于展示 Debug 工具的 `containerView`。 | | rect | CGRect | 设置 debug view 在 container view 中的展示区域。 | **注意** - 调用该方法后，播放器内部会把当前正在播放的 `TTVideoEngine` 实例自动添加到 Debug 工具中，不需要您再频繁地设置 `TTVideoEngine` 实例。 - 该方法适合短视频（例如抖音）、中视频（例如西瓜）等需要频繁切换播放的场景。 ### refreshCurrentVideoEngine: ```objectivec + (void)refreshCurrentVideoEngine:(TTVideoEngine *)videoEngine; ``` 刷新当前 Debug 工具关联的 `TTVideoEngine` 实例。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoEngine | TTVideoEngine* | `videoEngine` 对象。 | **注意** 默认情况下，SDK 内部会自动关联正在播放 `TTVideoEngine` 实例。 ### removeDebugTool ```objectivec + (void)removeDebugTool; ``` 移除 Debug 工具。 # TTVideoEngine(Preload) ```objectivec @interface TTVideoEngine (Preload) ``` 自定义预加载和本地播放缓存相关接口。 ## 静态函数 | 返回 | 名称 | | --- | --- | | TTVideoEngineLocalServerConfigure | [ls_localServerConfigure](#TTVideoEngine(Preload)-ls_localserverconfigure) | | void | [ls_setCustomDNSParser:](#TTVideoEngine(Preload)-ls_setcustomdnsparser) | | void | [ls_addTaskWithURLItem:](#TTVideoEngine(Preload)-ls_addtaskwithurlitem) | | void | [ls_addTaskWithVidItem:](#TTVideoEngine(Preload)-ls_addtaskwithviditem) | | void | [ls_cancelTaskByKey:](#TTVideoEngine(Preload)-ls_canceltaskbykey) | | void | [ls_cancelTaskByVideoId:](#TTVideoEngine(Preload)-ls_canceltaskbyvideoid) | | void | [ls_cancelAllTasks](#TTVideoEngine(Preload)-ls_cancelalltasks) | | void | [ls_cancelAllIdlePreloadTasks](#TTVideoEngine(Preload)-ls_cancelallidlepreloadtasks) | | void | [ls_clearAllCaches](#TTVideoEngine(Preload)-ls_clearallcaches) | | void | [ls_clearAllCaches:](#TTVideoEngine(Preload)-ls_clearallcaches) | | void | [ls_removeFileCacheByKey:](#TTVideoEngine(Preload)-ls_removefilecachebykey) | | void | [ls_removeFileCacheByKey:andTaskType:](#TTVideoEngine(Preload)-ls_removefilecachebykey-andtasktype) | | int64_t | [ls_getAllCacheSize](#TTVideoEngine(Preload)-ls_getallcachesize) | | void | [ls_getAllCacheSizeWithCompletion:](#TTVideoEngine(Preload)-ls_getallcachesizewithcompletion) | | int64_t | [ls_getCacheSizeByKey:](#TTVideoEngine(Preload)-ls_getcachesizebykey) | | void | [ls_getCacheSizeByKey:result:](#TTVideoEngine(Preload)-ls_getcachesizebykey-result) | | TTVideoEngineLocalServerCacheInfo | [ls_getCacheFileInfoByKey:](#TTVideoEngine(Preload)-ls_getcachefileinfobykey) | ## 函数说明 ### ls_localServerConfigure ```objectivec + (TTVideoEngineLocalServerConfigure *)ls_localServerConfigure; ``` 数据加载模块配置，详见 [TTVideoEngineLocalServerConfigure](803941#TTVideoEngineLocalServerConfigure) 。 ### ls_setCustomDNSParser: ```objectivec + (void)ls_setCustomDNSParser:(nonnull id)parser; ``` 设置自定义 DNS 解析对象。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | parser | id | 实现 `` 协议的解析实例。 | **注意** 使用自定义 DNS 解析，务必在 `[TTSDKManager startWithConfiguration:configuration]` 前调用。 ### ls_addTaskWithURLItem: ```objectivec + (void)ls_addTaskWithURLItem:(TTVideoEnginePreloaderURLItem *)urlItem; ``` 添加 DirectUrl 播放源预加载任务。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | urlItem | TTVideoEnginePreloaderURLItem* | DirectUrl 播放源预加载任务。 | ### ls_addTaskWithVidItem: ```objectivec + (void)ls_addTaskWithVidItem:(TTVideoEnginePreloaderVidItem *)vidItem; ``` 添加 Vid 播放源预加载任务。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | vidItem | TTVideoEnginePreloaderVidItem* | DirectUrl 播放源预加载任务。 | ### ls_cancelTaskByKey: ```objectivec + (void)ls_cancelTaskByKey:(NSString *)key; ``` 根据缓存 key 取消预加载任务。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 缓存 key，即 DirectUrl 播放源预加载任务的唯一标识。 | ### ls_cancelTaskByVideoId: ```objectivec + (void)ls_cancelTaskByVideoId:(NSString *)vid; ``` 根据视频 ID 取消预加载任务。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | vid | NSString* | 视频 ID。 | ### ls_cancelAllTasks ```objectivec + (void)ls_cancelAllTasks; ``` 取消所有预加载任务。 ### ls_cancelAllIdlePreloadTasks ```objectivec + (void)ls_cancelAllIdlePreloadTasks; ``` 取消所有空闲预加载任务。 ### ls_clearAllCaches ```objectivec + (void)ls_clearAllCaches; ``` 删除所有数据加载模块的缓存数据。 **注意** 为优化实际播放体验，调用该方法并不会删除所有缓存数据，而是会按照 Least Recently Used (LRU) 算法保留最近播放的 10 条左右数据。 ### ls_clearAllCaches: ```objectivec + (void)ls_clearAllCaches:(BOOL)force; ``` 删除所有数据加载模块的缓存数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | force | BOOL | 是否强制删除所有数据加载模块缓存数据。

YES: 删除所有缓存数据。
NO: 同调用 `ls_clearAllCaches` 方法一致，不全部删除所有缓存数据，而是会按照 Least Recently Used (LRU) 算法保留最近播放的 10 条左右数据，从而优化实际播放体验。

| ### ls_removeFileCacheByKey: ```objectivec + (void)ls_removeFileCacheByKey:(NSString *)key; ``` 根据缓存 key 删除数据加载模块的缓存数据。优先删除下载目录下的数据，若下载目录下没有数据，则删除缓存目录下的数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 数据加载模块中缓存数据的唯一标识。 | ### ls_removeFileCacheByKey:andTaskType: ```objectivec + (void)ls_removeFileCacheByKey:(NSString *)key andTaskType:(MDLTaskType)taskType; ``` 根据缓存 key 和任务类型删除数据加载模块的缓存数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 数据加载模块中缓存数据的唯一标识。 | | taskType | MDLTaskType | 任务类型：

`MDLTaskTypePlay = 1`: 仅删除**在线播放**时产生的缓存文件。
`MDLTaskTypePreload = 2`: 仅删除**预加载**任务产生的缓存文件。
`MDLTaskTypeDownload = 3`: 仅删除**离线下载**的完整视频文件。
`MDLTaskTypePreconnect = 4`: 内部使用，业务通常无需关心。

| ### ls_getAllCacheSize ```objectivec + (int64_t)ls_getAllCacheSize; ``` 获取数据加载模块缓存数据总大小，单位：byte。 **返回值** 数据加载模块缓存数据总大小。 ### ls_getAllCacheSizeWithCompletion: ```objectivec + (void)ls_getAllCacheSizeWithCompletion:(void(^)(int64_t cacheSize))block; ``` 异步获取数据加载模块缓存数据总大小，单位：byte。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | block | void(^)(int64_t cacheSize) | 异步回调。 | ### ls_getCacheSizeByKey: ```objectivec + (int64_t)ls_getCacheSizeByKey:(NSString *)key; ``` 根据缓存 key 获取缓存数据的大小。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 数据加载模块中缓存数据的唯一标识。 | **返回值** 返回缓存数据的大小，单位：byte。 ### ls_getCacheSizeByKey:result: ```objectivec + (void)ls_getCacheSizeByKey:(NSString *)key result:(void(^)(int64_t size))result; ``` 根据缓存 key 异步获取缓存数据的大小，单位：byte。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 数据加载模块中缓存数据的唯一标识。 | | result | void(^)(int64_t size) | 异步回调。 | ### ls_getCacheFileInfoByKey: ```objectivec + (nullable TTVideoEngineLocalServerCacheInfo *)ls_getCacheFileInfoByKey:(NSString *)key; ``` 根据缓存 key 获取缓存数据详细信息，详见 [TTVideoEngineLocalServerCacheInfo](803941#TTVideoEngineLocalServerCacheInfo) 。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | NSString* | 数据加载模块中缓存数据唯一标识。 | # TTVideoEngine(PlaySouce) ```objectivec @interface TTVideoEngine (PlaySouce) ``` 播放源相关接口。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [setVideoEngineVideoSource:](#TTVideoEngine(PlaySouce)-setvideoenginevideosource) | | NSString* | [getVideoEngineStrategyUniqueId](#TTVideoEngine(PlaySouce)-getvideoenginestrategyuniqueid) | ## 函数说明 ### setVideoEngineVideoSource: ```objectivec - (void)setVideoEngineVideoSource:(id)source; ``` 设置播放源。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | source | id\ | 播放源，支持以下类型：

如果使用 Vid 视频源，可设为 [TTVideoEngineVidSource](803941#TTVideoEngineVidSource) 。
如果使用 DirectUrl 视频源，可设为 [TTVideoEngineUrlSource](803941#TTVideoEngineUrlSource) 。

| ### getVideoEngineStrategyUniqueId ```objectivec - (NSString *)getVideoEngineStrategyUniqueId; ``` 获取当前 `TTVideoEngine` 对象唯一标识。 **返回值** 返回当前 `TTVideoEngine` 对象唯一标识，即 `TTVideoEngineMediaSource` 对象的 `uniqueId` 属性。 # TTVideoEngine(SubTitle) ```objectivec @interface TTVideoEngine(SubTitle) ``` 字幕相关方法 ## 成员函数 | 返回 | 名称 | | --- | --- | | NSArray* | [subtitleIDs](#TTVideoEngine(SubTitle)-subtitleids) | | TTVideoEngineSubModel | [subtitleDescriptions](#TTVideoEngine(SubTitle)-subtitledescriptions) | | NSDictionary* | [requestedSubtitleInfo](#TTVideoEngine(SubTitle)-requestedsubtitleinfo) | | NSArray* | [subtitleInfos](#TTVideoEngine(SubTitle)-subtitleinfos) | | BOOL | [hasEmbeddedSubtitle](#TTVideoEngine(SubTitle)-hasembeddedsubtitle) | | void | [switchNewSubtitleModel:](#TTVideoEngine(SubTitle)-switchnewsubtitlemodel) | | void | [addNewSubtitleModel:](#TTVideoEngine(SubTitle)-addnewsubtitlemodel) | | TTVideoEngineSubInfo | [getSubtitleInfo:](#TTVideoEngine(SubTitle)-getsubtitleinfo) | ## 函数说明 ### subtitleIDs ```objectivec - (NSArray * _Nullable)subtitleIDs; ``` 获取支持的字幕 ID 列表。 **返回值** 返回支持的字幕 ID 列表。 ### subtitleDescriptions ```objectivec - (NSArray *)subtitleDescriptions; ``` 获取支持的多种语言字幕信息列表。 **返回值** 返回 [TTVideoEngineSubModel](803941#TTVideoEngineSubModel) 列表。 ### requestedSubtitleInfo ```objectivec - (NSDictionary * _Nullable)requestedSubtitleInfo DEPRECATED_MSG_ATTRIBUTE("use TTVideoEngineSubtitleDelegate videoEngine:onSubtitleInfoRequestFinish:error:"); ``` 获取 Vid 请求字幕详细信息。 **返回值** 返回 Vid 请求字幕详细信息。 ### subtitleInfos ```objectivec - (NSArray * _Nullable)subtitleInfos; ``` 获取所有 Vid 请求字幕源详细信息。 **返回值** 返回所有 Vid 请求字幕源详细信息。 ### hasEmbeddedSubtitle ```objectivec - (BOOL)hasEmbeddedSubtitle; ``` 判断当前视频源是否已内嵌字幕。 **返回值** 是否内嵌字幕： - YES: 是。 - NO: 否。 ### switchNewSubtitleModel: ```objectivec - (void)switchNewSubtitleModel:(id)subModel; ``` 添加并切换到一个新增语言的字幕。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | subModel | id\ | 单个语言的字幕数据源信息 [TTVideoEngineSubProtocol](803941#TTVideoEngineSubProtocol) 。 | ### addNewSubtitleModel: ```objectivec - (void)addNewSubtitleModel:(id)subModel; ``` 添加一个新增语言的字幕。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | subModel | id\ | 单个语言的字幕数据源信息 [TTVideoEngineSubProtocol](803941#TTVideoEngineSubProtocol) 。 | ### getSubtitleInfo: ```objectivec - (TTVideoEngineSubInfo *)getSubtitleInfo:(NSInteger)queryTime; ``` 获取指定播放时间的字幕信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | queryTime | NSInteger | 指定的播放时间。 | **返回值** 返回指定播放时间的字幕信息 [TTVideoEngineSubInfo](803941#TTVideoEngineSubInfo) 。 # TTVideoEngineDownloader ```objectivec @interface TTVideoEngineDownloader : NSObject ``` 下载任务管理器。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSUInteger | [maxDownloadOperationCount](#TTVideoEngineDownloader-maxdownloadoperationcount) | | int64_t | [limitFreeDiskSize](#TTVideoEngineDownloader-limitfreedisksize) | | id\ | [delegate](#TTVideoEngineDownloader-delegate) | ## 静态函数 | 返回 | 名称 | | --- | --- | | instancetype | [shareLoader](#TTVideoEngineDownloader-shareloader) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [getAllTasksWithCompletionHandler:](#TTVideoEngineDownloader-getalltaskswithcompletionhandler) | | NSInteger | [downloadSize](#TTVideoEngineDownloader-downloadsize) | | void | [suspendAllTasks](#TTVideoEngineDownloader-suspendalltasks) | | void | [resumeAllTasks](#TTVideoEngineDownloader-resumealltasks) | | void | [removeAllTasks](#TTVideoEngineDownloader-removealltasks) | | TTVideoEngineDownloadTask | [synchronizeDownloadTaskStatus:](#TTVideoEngineDownloader-synchronizedownloadtaskstatus) | | TTVideoEngineDownloadURLTask | [urlTask:key:videoId:](#TTVideoEngineDownloader-urltask-key-videoid) | | TTVideoEngineDownloadVidTask | [vidTask:playAuthToken:resolution:](#TTVideoEngineDownloader-vidtask-playauthtoken-resolution) | | TTVideoEngineDownloadVidTask | [vidTask:playAuthToken:resolution:codec:](#TTVideoEngineDownloader-vidtask-playauthtoken-resolution-codec) | ## 变量说明 ### maxDownloadOperationCount ```objectivec @property (nonatomic, assign) NSUInteger maxDownloadOperationCount; ``` 设置最大并发数。默认值为 1。 ### limitFreeDiskSize ```objectivec @property (nonatomic, assign) int64_t limitFreeDiskSize; ``` 设置磁盘缓存剩余空间限制。单位为 bytes，默认值为 1024 * 1024 * 1024 * 1，表示 1 GB。如果剩余空间少于所设值，SDK 会报 `TTVideoEngineErrorNotEnoughDiskSpace` 错误。 ### delegate ```objectivec @property (nonatomic, weak) id delegate; ``` 设置下载相关回调 [TTVideoEngineDownloaderDelegate](518261#TTVideoEngineDownloaderDelegate) 。 ## 函数说明 ### shareLoader ```objectivec + (instancetype)shareLoader; ``` 单例方法。 ### getAllTasksWithCompletionHandler: ```objectivec - (void)getAllTasksWithCompletionHandler:(void (^)(NSArray<__kindof TTVideoEngineDownloadTask *> * _Nonnull))completionHandler; ``` 获取所有下载任务。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | completionHandler | void(^)(NSArray<__kindof TTVideoEngineDownloadTask*>* ) | Block 回调。 | ### downloadSize ```objectivec - (NSInteger)downloadSize; ``` 获取所有下载任务的总大小，单位为 byte。 **返回值** 返回所有下载任务的总大小。 **注意** - 此方法必须在 `getAllTasksWithCompletionHandler` 的 block 回调中调用。 - 播放 HLS 视频时，当前值可能不准。如果要获取下载进度，建议直接通过 `TTVideoEngineDownloadTask.progress` 属性获取。 ### suspendAllTasks ```objectivec - (void)suspendAllTasks; ``` 暂停所有下载任务。 **注意** 此方法必须在 `getAllTasksWithCompletionHandler` 的 block 回调中调用。 ### resumeAllTasks ```objectivec - (void)resumeAllTasks; ``` 恢复所有下载任务。 **注意** 此方法必须在 `getAllTasksWithCompletionHandler` 的 block 回调中调用。 ### removeAllTasks ```objectivec - (void)removeAllTasks; ``` 删除所有下载任务。 **注意** 此方法必须在 `getAllTasksWithCompletionHandler` 的 block 回调中调用。 ### synchronizeDownloadTaskStatus: ```objectivec - (TTVideoEngineDownloadTask *)synchronizeDownloadTaskStatus:(TTVideoEngineDownloadTask *)downloadTask; ``` 特殊情况下同步下载任务状态。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | downloadTask | TTVideoEngineDownloadTask* | \- | **注意** 此方法必须在 `getAllTasksWithCompletionHandler` 的 block 回调中调用。 ### urlTask:key:videoId: ```objectivec - (nullable TTVideoEngineDownloadURLTask *)urlTask:(NSArray *)urls key:(NSString *)key videoId:(nullable NSString *)videoId; ``` 创建 DirectUrl 播放源下载任务。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | urls | NSArray* | DirectUrl 播放源下载任务，支持主备 URL。 | | key | NSString* | DirectUrl 播放源下载任务唯一标识 cache key。 | | videoId | nullable NSString* | 视频 ID，选填。 | **返回值** 返回 [TTVideoEngineDownloadURLTask](#TTVideoEngineDownloadURLTask) 实例。 ### vidTask:playAuthToken:resolution: ```objectivec - (nullable TTVideoEngineDownloadVidTask *)vidTask:(NSString *)videoId playAuthToken:(NSString *)token resolution:(TTVideoEngineResolutionType)resolution; ``` 创建 Vid 播放源下载任务。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoId | NSString* | 视频 ID。 | | token | NSString* | 视频播放密钥。 | | resolution | TTVideoEngineResolutionType | 视频分辨率，详见 [TTVideoEngineResolutionType](803941#TTVideoEngineResolutionType) 。 | **返回值** 返回 [TTVideoEngineDownloadVidTask](#TTVideoEngineDownloadVidTask) 实例。 ### vidTask:playAuthToken:resolution:codec: ```objectivec - (nullable TTVideoEngineDownloadVidTask *)vidTask:(NSString *)videoId playAuthToken:(NSString *)token resolution:(TTVideoEngineResolutionType)resolution codec:(TTVideoEngineEncodeType)codecType; ``` 创建 Vid 播放源下载任务。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | videoId | NSString* | 视频 ID。 | | token | NSString* | 视频播放密钥。 | | resolution | TTVideoEngineResolutionType | 视频分辨率，详见 [TTVideoEngineResolutionType](803941#TTVideoEngineResolutionType) 。 | | codecType | TTVideoEngineEncodeType | 编码类型，详见 [TTVideoEngineEncodeType](803941#TTVideoEngineEncodeType) 。 | **返回值** 返回 [TTVideoEngineDownloadVidTask](#TTVideoEngineDownloadVidTask) 实例。 # TTVideoEngineDownloadTask ```objectivec @interface TTVideoEngineDownloadTask : NSObject ``` 下载相关方法。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [taskDescription](#TTVideoEngineDownloadTask-taskdescription) | | int64_t | [countOfBytesReceived](#TTVideoEngineDownloadTask-countofbytesreceived) | | int64_t | [countOfBytesExpectedToReceive](#TTVideoEngineDownloadTask-countofbytesexpectedtoreceive) | | double | [progress](#TTVideoEngineDownloadTask-progress) | | TTVideoEngineDownloadState | [state](#TTVideoEngineDownloadTask-state) | | NSError* | [error](#TTVideoEngineDownloadTask-error) | | NSString* | [availableLocalFilePath](#TTVideoEngineDownloadTask-availablelocalfilepath) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [invalidateAndCancel](#TTVideoEngineDownloadTask-invalidateandcancel) | | void | [suspend](#TTVideoEngineDownloadTask-suspend) | | void | [suspendWithTryNext:](#TTVideoEngineDownloadTask-suspendwithtrynext) | | void | [resume](#TTVideoEngineDownloadTask-resume) | ## 变量说明 ### taskDescription ```objectivec @property (nullable, copy) NSString *taskDescription; ``` 设置下载任务描述。 ### countOfBytesReceived ```objectivec @property (readonly) int64_t countOfBytesReceived; ``` 当前已下载字节数。 ### countOfBytesExpectedToReceive ```objectivec @property (readonly) int64_t countOfBytesExpectedToReceive; ``` 视频总字节数。注意，播放 HLS 视频时，当前值可能不准。如果要获取下载进度，建议直接通过 `TTVideoEngineDownloadTask.progress` 属性获取。 ### progress ```objectivec @property (nonatomic, readonly) double progress; ``` 当前下载进度。 ### state ```objectivec @property (readonly) TTVideoEngineDownloadState state; ``` 获取当前下载状态，详见 [TTVideoEngineDownloadState](803941#TTVideoEngineDownloadState) 。 ### error ```objectivec @property (nullable, readonly, copy) NSError *error; ``` 下载错误信息，包含错误码和错误描述。 ### availableLocalFilePath ```objectivec @property (nullable, readonly, copy) NSString *availableLocalFilePath; ``` 获取下载文件存储路径。 ## 函数说明 ### invalidateAndCancel ```objectivec - (void)invalidateAndCancel; ``` 删除单个下载任务。 **注意** 此方法可在子线程调用。 ### suspend ```objectivec - (void)suspend; ``` 暂停单个下载任务。 **注意** 此方法需在主线程调用。 ### suspendWithTryNext: ```objectivec - (void)suspendWithTryNext:(BOOL)tryNext; ``` 暂停单个下载任务，并指定是否自动开始下一个等待中的任务。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | tryNext | BOOL | \- | **注意** 此方法需在主线程调用。 ### resume ```objectivec - (void)resume; ``` 开始或恢复单个下载任务。 # TTVideoEngineDownloadURLTask ```objectivec @interface TTVideoEngineDownloadURLTask : TTVideoEngineDownloadTask ``` DirectUrl 播放源下载任务。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [key](#TTVideoEngineDownloadURLTask-key) | | NSString* | [videoId](#TTVideoEngineDownloadURLTask-videoid) | | BOOL | [isHlsStandardEncrypt](#TTVideoEngineDownloadURLTask-ishlsstandardencrypt) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [updateUrls:](#TTVideoEngineDownloadURLTask-updateurls) | ## 变量说明 ### key ```objectivec @property (nonatomic, copy, readonly) NSString *key; ``` 缓存 key，需和视频源一一对应。建议使用 URL 的 MD5 作为缓存 key。 ### videoId ```objectivec @property (nonatomic, copy, readonly, nullable) NSString *videoId; ``` 视频 ID。视频的唯一标识，必须与视频源一一对应。 ### isHlsStandardEncrypt ```objectivec @property (nonatomic, assign) BOOL isHlsStandardEncrypt; ``` 是否HLS标准加密视频。 ## 函数说明 ### updateUrls: ```objectivec - (void)updateUrls:(NSArray *)urls; ``` 更新 URL 列表。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | urls | NSArray* | \- | # TTVideoEngineDownloadVidTask ```objectivec @interface TTVideoEngineDownloadVidTask : TTVideoEngineDownloadTask ``` Video ID 视频源下载任务。 ## 成员变量 | 类型 | 名称 | | --- | --- | | TTVideoEngineResolutionType | [resolution](#TTVideoEngineDownloadVidTask-resolution) | | TTVideoEngineEncodeType | [codecType](#TTVideoEngineDownloadVidTask-codectype) | | BOOL | [h265Enable](#TTVideoEngineDownloadVidTask-h265enable) | | BOOL | [baseDashEnable](#TTVideoEngineDownloadVidTask-basedashenable) | | BOOL | [httpsEnable](#TTVideoEngineDownloadVidTask-httpsenable) | | NSDictionary\* | [resolutionMap](#TTVideoEngineDownloadVidTask-resolutionmap) | | TTVideoEngineResolutionType | [currentResolution](#TTVideoEngineDownloadVidTask-currentresolution) | | TTVideoEngineModel* | [videoModel](#TTVideoEngineDownloadVidTask-videomodel) | | NSDictionary* | [urlExtendParams](#TTVideoEngineDownloadVidTask-urlextendparams) | ## 变量说明 ### resolution ```objectivec @property (nonatomic, assign, readonly) TTVideoEngineResolutionType resolution; ``` 视频分辨率，详见 [TTVideoEngineResolutionType](803941#TTVideoEngineResolutionType) 。 ### codecType ```objectivec @property (nonatomic, assign, readonly) TTVideoEngineEncodeType codecType; ``` 编码类型，详见 [TTVideoEngineEncodeType](803941#TTVideoEngineEncodeType) 。 ### h265Enable ```objectivec @property (nonatomic, assign, readonly) BOOL h265Enable; ``` 是否开启 H.265： - YES: 开启。 - NO: 关闭。 ### baseDashEnable ```objectivec @property (nonatomic, assign, readonly) BOOL baseDashEnable; ``` 是否开启 DASH： - YES: 开启。 - NO: 关闭。 ### httpsEnable ```objectivec @property (nonatomic, assign, readonly) BOOL httpsEnable; ``` 是否开启 HTTPS： - YES: 开启。 - NO: 关闭。 ### resolutionMap ```objectivec @property (nonatomic, strong, nullable) NSDictionary *resolutionMap; ``` 视频清晰度 map。 ### currentResolution ```objectivec @property (nonatomic, assign, readonly) TTVideoEngineResolutionType currentResolution; ``` 下载任务对应视频源清晰度。 ### videoModel ```objectivec @property (nonatomic, strong, nullable, readonly) TTVideoEngineModel *videoModel; ``` 下载任务的具体视频信息。 ### urlExtendParams ```objectivec @property (nonatomic, strong, nullable) NSDictionary *urlExtendParams; ``` 设置视频下载地址扩展参数。 # TTVideoEnginePreloaderSubtitleVidItem ```objectivec @interface TTVideoEnginePreloaderSubtitleVidItem : TTVideoEnginePreloaderVidItem ``` ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [subtitleAuthToken](#TTVideoEnginePreloaderSubtitleVidItem-subtitleauthtoken) | ## 成员函数 | 返回 | 名称 | | --- | --- | | TTVideoEngineSubProtocol | [preloadSubtitleModelBlock](#TTVideoEnginePreloaderSubtitleVidItem-preloadsubtitlemodelblock) | ## 变量说明 ### subtitleAuthToken ```objectivec @property (nonatomic, copy) NSString *subtitleAuthToken; ``` 字幕token。 ## 函数说明 ### preloadSubtitleModelBlock ```objectivec @property (nonatomic, strong, nullable) id (^preloadSubtitleModelBlock)(NSArray> *subModels); ``` 获取缓存预加载 subtitle model。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | subModels | NSArray\>* | \- | # TTVideoEnginePreloaderItem ```objectivec @interface TTVideoEnginePreloaderItem : NSObject ``` ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [setCustomHeaderValue:forKey:](#TTVideoEnginePreloaderItem-setcustomheadervalue-forkey) | ## 函数说明 ### setCustomHeaderValue:forKey: ```objectivec - (void)setCustomHeaderValue:(NSString *)value forKey:(NSString *)key; ``` 自定义请求 header。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | value | NSString* | \- | | key | NSString* | \- | # TTVideoEnginePreloaderSubtitleVidItem(PreloadItem) ```objectivec @interface TTVideoEnginePreloaderSubtitleVidItem (PreloadItem) ``` ## 静态函数 | 返回 | 名称 | | --- | --- | | nullable instancetype | [subtitleVidItemWithVideoSource:](#TTVideoEnginePreloaderSubtitleVidItem(PreloadItem)-subtitleviditemwithvideosource) | ## 函数说明 ### subtitleVidItemWithVideoSource: ```objectivec + (nullable instancetype)subtitleVidItemWithVideoSource:(id)source; ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | source | id\ | \- | # TTVideoEngineHLSProxyDelegate ```objectivec @protocol TTVideoEngineHLSProxyDelegate ``` 开启 HLSProxy 相关回调。 # TTVideoEngine() ```objectivec @interface TTVideoEngine() ``` 播放器引擎。 ## 成员变量 | 类型 | 名称 | | --- | --- | | id\ | [subtitleDelegate](#TTVideoEngine()-subtitledelegate) | | id\ | [subDecInfoModel](#TTVideoEngine()-subdecinfomodel) | ## 静态函数 | 返回 | 名称 | | --- | --- | | NSString* | [getEngineUniqueId](#TTVideoEngine()-getengineuniqueid) | | NSString* | [getEngineUniqueKek](#TTVideoEngine()-getengineuniquekek) | ## 成员函数 | 返回 | 名称 | | --- | --- | | NSString* | [getPlayerSessionId](#TTVideoEngine()-getplayersessionid) | ## 变量说明 ### subtitleDelegate ```objectivec @property (nonatomic, weak, nullable) id subtitleDelegate; ``` 设置字幕相关回调，详见 [TTVideoEngineSubtitleDelegate](518261#TTVideoEngineSubtitleDelegate) 。 ### subDecInfoModel ```objectivec @property (nonatomic, weak) id subDecInfoModel; ``` 设置字幕数据源，详见 [TTVideoEngineSubDecInfoProtocol](803941#TTVideoEngineSubDecInfoProtocol) 。 ## 函数说明 ### getEngineUniqueId ```objectivec + (NSString *)getEngineUniqueId; ``` 获取设备唯一标识。 **返回值** 设备唯一标识。 **注意** App 重新安装后，设备唯一标识会改变。 ### getEngineUniqueKek ```objectivec + (NSString *)getEngineUniqueKek; ``` 获取设备唯一的升级版私有化加密的Kek密钥。 **返回值** Kek密钥。 ### getPlayerSessionId ```objectivec - (NSString *)getPlayerSessionId; ``` 获取播放生命周期播放器唯一标识。 **返回值** 播放器生命周期唯一标识。

视频点播