# TTVideoEngineFinishReason ```objectivec typedef NS_ENUM( NSInteger, TTVideoEngineFinishReason ) ``` 播放结束原因。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineFinishReasonUserExited | 0 | 用户主动退出播放。 | | TTVideoEngineFinishReasonRelease | 1 | 播放器被释放。 | | TTVideoEngineFinishReasondReleaseAsync | 2 | 播放器被异步释放。 | | TTVideoEngineFinishReasonPlaybackEnded | 3 | 播放器正常播放完成。 | | TTVideoEngineFinishReasonPlaybackError | 4 | 播放器发生错误。 | | TTVideoEngineFinishReasonStatusExcp | 5 | 播放器发生异常。 | | TTVideoEngineFinishReasonReset | 6 | 播放器重置。 | # TTVideoEnginePreloaderURLItem(PreloadItem) ```objectivec @interface TTVideoEnginePreloaderURLItem (PreloadItem) ``` DirectUrl 视频源预加载 item。 ## 静态函数 | 返回 | 名称 | | --- | --- | | nullable instancetype | [urlItemWithVideoSource:preloadSize:](#TTVideoEnginePreloaderURLItem(PreloadItem)-urlitemwithvideosource-preloadsize) | ## 函数说明 ### urlItemWithVideoSource:preloadSize: ```objectivec + (nullable instancetype)urlItemWithVideoSource:(id)source preloadSize:(NSInteger)preloadSize; ``` 构造一个 DirectUrl 播放源预加载 Item 实例。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | source | id\ | DirectUrl 播放源信息 [TTVideoEngineMediaSource](#TTVideoEngineMediaSource) 。 | | preloadSize | NSInteger | 预加载数据大小，单位：byte。例如 800 * 1024 代表预加载 800k 数据。 | **返回值** 返回 DirectUrl 播放源预加载 Item 实例。 # TTVideoEngineStreamType ```objectivec typedef NS_ENUM( NSInteger, TTVideoEngineStreamType ) ``` 视频流类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineVideoStream | 0 | 视频流。 | | TTVideoEngineAudioStream | 1 | 音频流。 | # Public API ## 函数 | 返回 | 名称 | | --- | --- | | void | [TTVideoURLRefreshCompleteBlock](#ttvideourlrefreshcompleteblock) | | void | [TTVideoURLRefreshErrorBlock](#ttvideourlrefresherrorblock) | | void | [TTVideoURLRefreshCancelBlock](#ttvideourlrefreshcancelblock) | ## 函数说明 ### TTVideoURLRefreshCompleteBlock ```objectivec typedef void(^TTVideoURLRefreshCompleteBlock)(NSString *newUrl, NSString *expireTimeInMS); ``` 过期 URL 刷新完成 block。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | newUrl | NSString* | 新 URL。 | | expireTimeInMS | NSString* | 新 URL 的过期时间。精度为毫秒的 Unix 时间戳。 | ### TTVideoURLRefreshErrorBlock ```objectivec typedef void(^TTVideoURLRefreshErrorBlock)(NSError *error); ``` 过期 URL 刷新失败 block。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | error | NSError* | 失败原因。 | ### TTVideoURLRefreshCancelBlock ```objectivec typedef void(^TTVideoURLRefreshCancelBlock)(void); ``` 过期 URL 取消刷新 block。 # TTVideoEngineState ```objectivec typedef NS_ENUM( NSUInteger, TTVideoEngineState ) ``` 播放器状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineStateUnknown | 0 | 初始状态。 | | TTVideoEngineStateFetchingInfo | 1 | 使用 Vid 模式播放，正在获取播放信息。 | | TTVideoEngineStateParsingDNS | 2 | 播放器正在进行 DNS 解析。 | | TTVideoEngineStatePlayerRunning | 3 | 播放器正常播放中。 | | TTVideoEngineStateError | 4 | 播放器运行发生错误。 | # TTVideoEngineLoadState ```objectivec typedef NS_ENUM( NSUInteger, TTVideoEngineLoadState ) ``` 播放器加载状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineLoadStateUnknown | 0 | 播放器加载初始状态。 | | TTVideoEngineLoadStatePlayable | 1 | 播放器加载完成，可开始或恢复播放。 | | TTVideoEngineLoadStateStalled | 2 | 播放器发生卡顿，正在加载数据。 | | TTVideoEngineLoadStateError | 3 | 播放器加载数据错误。 | # TTVideoEngineStallAction ```objectivec typedef NS_ENUM( NSInteger, TTVideoEngineStallAction ) ``` 导致播放器发生卡顿的具体动作。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineStallActionNone | 0 | 默认值。 | | TTVideoEngineStallActionSeek | 1 | 用户 seek。 | | TTVideoEngineStallActionSwitch | 2 | 切换分辨率。 | # TTVideoEngineLoadInfo ```objectivec @interface TTVideoEngineLoadInfo: NSObject ``` 播放器字幕加载信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [firstPts](#TTVideoEngineLoadInfo-firstpts) | | NSInteger | [code](#TTVideoEngineLoadInfo-code) | | NSInteger | [loadStageCode](#TTVideoEngineLoadInfo-loadstagecode) | ## 变量说明 ### firstPts ```objectivec @property (nonatomic, assign) NSInteger firstPts; ``` 首段字幕展示时间戳。 ### code ```objectivec @property (nonatomic, assign) NSInteger code; ``` 字幕加载状态。`code` 为 `0` 表示加载成功。 ### loadStageCode ```objectivec @property (nonatomic, assign) NSInteger loadStageCode; ``` 字幕加载阶段状态码，用于字幕加载失败问题分析 # TTVideoEngineSubInfo ```objectivec @interface TTVideoEngineSubInfo: NSObject ``` 单段字幕信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [pts](#TTVideoEngineSubInfo-pts) | | NSString* | [content](#TTVideoEngineSubInfo-content) | | NSInteger | [duration](#TTVideoEngineSubInfo-duration) | ## 变量说明 ### pts ```objectivec @property (nonatomic, assign) NSInteger pts; ``` 该段字幕对应的时间戳，单位为毫秒。 ### content ```objectivec @property (nonatomic, copy) NSString *content; ``` 该段字幕的内容。 ### duration ```objectivec @property (nonatomic, assign) NSInteger duration; ``` 该段字幕持续的时间，单位为毫秒。 # TTVideoEnginePreloaderSubtitleItem ```objectivec @interface TTVideoEnginePreloaderSubtitleItem : TTVideoEnginePreloaderItem ``` Vid 播放源预加载信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [subtitleId](#TTVideoEnginePreloaderSubtitleItem-subtitleid) | | NSInteger | [priorityLevel](#TTVideoEnginePreloaderSubtitleItem-prioritylevel) | | TTVideoEngineSubDecInfoModel* | [subtitleInfoModel](#TTVideoEnginePreloaderSubtitleItem-subtitleinfomodel) | ## 静态函数 | 返回 | 名称 | | --- | --- | | instancetype | [preloaderSubtitleItem:subtitleId:](#TTVideoEnginePreloaderSubtitleItem-preloadersubtitleitem-subtitleid) | ## 变量说明 ### subtitleId ```objectivec @property (nonatomic, assign) NSInteger subtitleId; ``` 预加载字幕 id。 ### priorityLevel ```objectivec @property (nonatomic, assign) NSInteger priorityLevel; ``` 预加载优先级，默认为 `TTVideoEnginePrloadPriorityDefault`。 ### subtitleInfoModel ```objectivec @property (nonatomic, strong, nonnull) TTVideoEngineSubDecInfoModel *subtitleInfoModel; ``` 字幕源。 ## 函数说明 ### preloaderSubtitleItem:subtitleId: ```objectivec + (instancetype)preloaderSubtitleItem:(TTVideoEngineSubDecInfoModel *)subtitleInfoModel subtitleId:(NSInteger)subtitleId; ``` 创建字幕预加载任务。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | subtitleInfoModel | TTVideoEngineSubDecInfoModel* | 预加载字幕源 | | subtitleId | NSInteger | 预加载字幕源 | **返回值** 返回字幕预加载 Item 实例。 # TTVideoEngineLocalServerConfigure ```objectivec @interface TTVideoEngineLocalServerConfigure : NSObject ``` 数据加载模块配置。数据加载模块（MDL，Media Data Loader）是点播 SDK 内部的关键模块之一，为播放器提供高速、低成本、可靠的数据加载服务。点播 SDK 的预加载、文件缓存、边下边播、网络质量和成本数据监控等功能均依赖于数据模块。点播 SDK 初始化时，会默认启动数据加载模块。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [maxCacheSize](#TTVideoEngineLocalServerConfigure-maxcachesize) | | NSInteger | [preloadParallelNum](#TTVideoEngineLocalServerConfigure-preloadparallelnum) | | NSString* | [downloadDirectory](#TTVideoEngineLocalServerConfigure-downloaddirectory) | ## 变量说明 ### maxCacheSize ```objectivec @property(nonatomic, assign) NSInteger maxCacheSize; ``` 设置本地缓存最大数据量，单位为 byte。 ### preloadParallelNum ```objectivec @property(nonatomic, assign) NSInteger preloadParallelNum; ``` 设置预加载并发数，默认值为 2。 ### downloadDirectory ```objectivec @property(nonatomic, nullable, copy) NSString *downloadDirectory; ``` 设置下载文件的沙盒存储路径，如果你使用下载功能，该路径必须设置。 # TTVideoEngineLocalServerCacheInfo ```objectivec @interface TTVideoEngineLocalServerCacheInfo : NSObject ``` 数据加载模块的本地缓存配置信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int64_t | [mediaSize](#TTVideoEngineLocalServerCacheInfo-mediasize) | | NSString* | [localFilePath](#TTVideoEngineLocalServerCacheInfo-localfilepath) | ## 变量说明 ### mediaSize ```objectivec @property(nonatomic, assign) int64_t mediaSize; ``` 视频源数据大小，单位：byte。 ### localFilePath ```objectivec @property(nonatomic, copy) NSString *localFilePath; ``` 本地缓存路径。 # TTVideoEnginePlaybackState ```objectivec typedef NS_ENUM( NSInteger, TTVideoEnginePlaybackState ) ``` 播放状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEnginePlaybackStateStopped | 0 | 播放停止。 | | TTVideoEnginePlaybackStatePlaying | 1 | 播放中。 | | TTVideoEnginePlaybackStatePaused | 2 | 播放暂停。 | | TTVideoEnginePlaybackStateError | 3 | 播放错误。 | # TTVideoEngineNetworkType ```objectivec typedef NS_ENUM( NSUInteger, TTVideoEngineNetworkType ) ``` 网络类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineNetworkTypeWifi | 0 | 使用 WiFi。 | | TTVideoEngineNetworkTypeNotWifi | 1 | 使用非 WiFi。 | | TTVideoEngineNetworkTypeNone | 2 | 未知状态。 | # TTVideoEngineDownloadState ```objectivec typedef NS_ENUM( NSInteger, TTVideoEngineDownloadState ) ``` 下载状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineDownloadStateInit | 0 | 初始化。 | | TTVideoEngineDownloadStateWaiting | 1 | 等待中。 | | TTVideoEngineDownloadStateRunning | 2 | 运行中。 | | TTVideoEngineDownloadStateSuspended | 3 | 暂停。 | | TTVideoEngineDownloadStateCanceling | 4 | 正在取消。 | | TTVideoEngineDownloadStateCompleted | 5 | 完成。 | # TTVideoEngineLogFlag ```objectivec typedef NS_OPTIONS( NSInteger, TTVideoEngineLogFlag ) ``` 播放器输出日志模块。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineLogFlagNone | 0 | 不输出日志。 | | TTVideoEngineLogFlagEngine | 1 << 0 | 输出 Engine 日志。 | | TTVideoEngineLogFlagPlayer | 1 << 1 | 输出播放内核日志。 | | TTVideoEngineLogFlagMDL | 1 << 2 | 输出数据加载模块日志。 | | TTVideoEngineLogFlagDefault | TTVideoEngineLogFlagAlogEngine \|
TTVideoEngineLogFlagAlogMDL \|
TTVideoEngineLogFlagAlogPlayer \|
TTVideoEngineLogFlagAlogPlaylistCacheModule | 输出 Engine、内核、数据加载模块日志。 | # TTVideoEngineExternDNSParserDataSource ```objectivec @protocol TTVideoEngineExternDNSParserDataSource ``` 该协议描述使用外部自定义 DNS 解析 DataSource。 ## 成员函数 | 返回 | 名称 | | --- | --- | | NSString* | [hostName](#TTVideoEngineExternDNSParserDataSource-hostname) | | NSArray* | [ipList](#TTVideoEngineExternDNSParserDataSource-iplist) | | NSInteger | [ttl](#TTVideoEngineExternDNSParserDataSource-ttl) | ## 函数说明 ### hostName ```objectivec - (NSString *)hostName; ``` 解析的域名。 ### ipList ```objectivec - (NSArray *)ipList; ``` 域名解析出的 IP 列表。 ### ttl ```objectivec - (NSInteger)ttl; ``` 解析过期时间，单位：秒。 # TTVideoEngineMirrorType ```objectivec typedef NS_ENUM( NSInteger, TTVideoEngineMirrorType ) ``` 镜像模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineMirrorTypeNone | 0 | 无镜像。 | | TTVideoEngineMirrorTypeHorizontal | 1 | 水平镜像。 | | TTVideoEngineMirrorTypeVertical | 2 | 垂直镜像。 | | TTVideoEngineMirrorTypeHV | 3 | 同时开启水平镜像和垂直镜像。 | # TTVideoEngineVidSource ```objectivec @interface TTVideoEngineVidSource : NSObject ``` Vid 播放源。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [vid](#TTVideoEngineVidSource-vid) | | NSString* | [playAuthToken](#TTVideoEngineVidSource-playauthtoken) | | NSString* | [subtitleAuthToken](#TTVideoEngineVidSource-subtitleauthtoken) | | TTVideoEngineResolutionType | [resolution](#TTVideoEngineVidSource-resolution) | | TTVideoEngineEncodeType | [encodeType](#TTVideoEngineVidSource-encodetype) | | BOOL | [isDash](#TTVideoEngineVidSource-isdash) | | BOOL | [isHLS](#TTVideoEngineVidSource-ishls) | | NSDictionary* | [urlExtendParams](#TTVideoEngineVidSource-urlextendparams) | | NSDictionary\* | [customHeaders](#TTVideoEngineVidSource-customheaders) | ## 成员函数 | 返回 | 名称 | | --- | --- | | TTVideoEngineResolutionType | [preloadVideoResolution](#TTVideoEngineVidSource-preloadvideoresolution) | | TTVideoEngineSubProtocol | [preloadSubtitleModelBlock](#TTVideoEngineVidSource-preloadsubtitlemodelblock) | | instancetype | [initWithVid:playAuthToken:resolution:](#TTVideoEngineVidSource-initwithvid-playauthtoken-resolution) | | instancetype | [initWithVid:playAuthToken:resolution:encodeType:isDash:isHLS:](#TTVideoEngineVidSource-initwithvid-playauthtoken-resolution-encodetype-isdash-ishls) | ## 变量说明 ### vid ```objectivec @property (nonatomic, copy) NSString *vid; ``` （必需）设置视频 ID。 ### playAuthToken ```objectivec @property (nonatomic, copy) NSString *playAuthToken; ``` （必需）设置用于鉴权的 playAuthToken。这是由应用服务端签算并下发给客户端的，详见[客户端播放](https://www.volcengine.com/docs/4/67350)。 ### subtitleAuthToken ```objectivec @property (nonatomic, copy) NSString *subtitleAuthToken; ``` 设置用于鉴权的 subtitleAuthToken。这是由应用服务端签算并下发给客户端的。 ### resolution ```objectivec @property (nonatomic, assign) TTVideoEngineResolutionType resolution; ``` 设置视频分辨率，详见 [TTVideoEngineResolutionType](#TTVideoEngineResolutionType) 。 ### encodeType ```objectivec @property (nonatomic, assign) TTVideoEngineEncodeType encodeType; ``` 设置视频编码格式，详见 [TTVideoEngineEncodeType](#TTVideoEngineEncodeType) 。默认为 H.264。 ### isDash ```objectivec @property (nonatomic, assign) BOOL isDash; ``` 设置是否为 DASH。默认为 `NO`。 ### isHLS ```objectivec @property (nonatomic, assign) BOOL isHLS; ``` 设置是否为 HLS。默认为 `NO`。 ### urlExtendParams ```objectivec @property (nonatomic, strong, nullable) NSDictionary *urlExtendParams; ``` 设置视频播放地址扩展参数。 ### customHeaders ```objectivec @property (nonatomic, strong, nullable) NSDictionary *customHeaders; ``` 播放或预加载的自定义 headers。 ## 函数说明 ### preloadVideoResolution ```objectivec @property (nonatomic, strong, nullable) TTVideoEngineResolutionType (^preloadVideoResolution)(void); ``` 获取预加载档位，默认使用 resolution 设置的值，如果业务播放过程中切换档位，可以使用该回调同步修改预加载档位。 ### preloadSubtitleModelBlock ```objectivec @property (nonatomic, strong, nullable) id (^preloadSubtitleModelBlock)(NSArray> *subModels); ``` 获取缓存预加载 subtitle model。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | subModels | NSArray\>* | \- | ### initWithVid:playAuthToken:resolution: ```objectivec - (instancetype)initWithVid:(NSString *)vid playAuthToken:(NSString *)playAuthToken resolution:(TTVideoEngineResolutionType)resolution; ``` 初始化 Vid 播放源。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | vid | NSString* | 视频 ID。 | | playAuthToken | NSString* | （必需）视频 playAuthToken。这是由应用服务端签算并下发给客户端的，详见[客户端播放](https://www.volcengine.com/docs/4/67350)。 | | resolution | TTVideoEngineResolutionType | 视频分辨率，详见 [TTVideoEngineResolutionType](#TTVideoEngineResolutionType) 。 | **返回值** Vid 播放源实例。 Vid 播放源实例。 ### initWithVid:playAuthToken:resolution:encodeType:isDash:isHLS: ```objectivec - (instancetype)initWithVid:(NSString *)vid playAuthToken:(NSString *)playAuthToken resolution:(TTVideoEngineResolutionType)resolution encodeType:(TTVideoEngineEncodeType)encodeType isDash:(BOOL)isDash isHLS:(BOOL)isHLS; ``` 初始化 Vid 播放源。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | vid | NSString* | 视频 ID。 | | playAuthToken | NSString* | （必需）视频 playAuthToken。这是由应用服务端签算并下发给客户端的，详见[客户端播放](https://www.volcengine.com/docs/4/67350)。 | | resolution | TTVideoEngineResolutionType | 视频分辨率，详见 [TTVideoEngineResolutionType](#TTVideoEngineResolutionType) 。 | | encodeType | TTVideoEngineEncodeType | 视频编码格式，详见 [TTVideoEngineEncodeType](#TTVideoEngineEncodeType) 。默认为 H.264。 | | isDash | BOOL | 是否为 DASH。默认为 `NO`。 | | isHLS | BOOL | 是否为 HLS。默认为 `NO`。 | **返回值** Vid 播放源实例。 # TTVideoEngineResolutionType ```objectivec typedef NS_ENUM( NSUInteger, TTVideoEngineResolutionType ) ``` 视频清晰度。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineResolutionTypeSD | 0 | 标清 360P | | TTVideoEngineResolutionTypeHD | 1 | 高清 480P | | TTVideoEngineResolutionTypeFullHD | 2 | 超清 720P | | TTVideoEngineResolutionType1080P | 3 | 1080P | | TTVideoEngineResolutionType4K | 4 | 4K | | TTVideoEngineResolutionTypeAuto | 5 | 自动调节。该选项仅适用于 DASH 视频，表示根据网速动态调节清晰度。 | | TTVideoEngineResolutionTypeHD_H | 8 | 540P | | TTVideoEngineResolutionType2K | 10 | 2K | # TTVideoEnginePreloaderURLItem ```objectivec @interface TTVideoEnginePreloaderURLItem : TTVideoEnginePreloaderItem ``` DirectUrl 播放源预加载信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [key](#TTVideoEnginePreloaderURLItem-key) | | NSArray\* | [urls](#TTVideoEnginePreloaderURLItem-urls) | | NSString* | [videoId](#TTVideoEnginePreloaderURLItem-videoid) | | NSString* | [cacheFilePath](#TTVideoEnginePreloaderURLItem-cachefilepath) | | NSInteger | [preloadSize](#TTVideoEnginePreloaderURLItem-preloadsize) | | NSInteger | [priorityLevel](#TTVideoEnginePreloaderURLItem-prioritylevel) | | NSString* | [decryptionKey](#TTVideoEnginePreloaderURLItem-decryptionkey) | | BOOL | [isForceUseHLSProxy](#TTVideoEnginePreloaderURLItem-isforceusehlsproxy) | ## 变量说明 ### key ```objectivec @property (nonatomic, copy, nullable) NSString *key; ``` （必需）设置预加载任务唯一标识。建议使用 URL MD5 值作为 key。如果使用 URL MD5 值作为 key，需要注意某些 URL 可能会包含时间戳或签名等信息，在使用之前需要将这些可变部分去除，以保证使用的是不变的 URL 的 MD5 值。 ### urls ```objectivec @property (nonatomic, copy, nullable) NSArray *urls; ``` （必需）设置预加载视频源的 URL。支持主备 URL。 ### videoId ```objectivec @property (nonatomic, copy, nullable) NSString *videoId; ``` （必需）视频的唯一标识，必须与视频源一一对应。可以是您自己的视频管理系统中的视频唯一标识，也可以跟 `key` 赋值一样。 ### cacheFilePath ```objectivec @property (nonatomic, copy, nullable) NSString *cacheFilePath; ``` 指定缓存路径。SDK 有默认缓存路径，不建议您单独设置。 ### preloadSize ```objectivec @property (nonatomic, assign) NSInteger preloadSize; ``` 设置预加载数据大小，例如 800 * 1024 代表预加载 800k 数据。 ### priorityLevel ```objectivec @property (nonatomic, assign) NSInteger priorityLevel; ``` 预加载优先级，默认为 `TTVideoEnginePrloadPriorityDefault`。 ### decryptionKey ```objectivec @property (nonatomic, strong, nullable) NSString *decryptionKey; ``` 自定义私有加密密钥。用于播放加密视频。 ### isForceUseHLSProxy ```objectivec @property (nonatomic, assign) BOOL isForceUseHLSProxy; ``` 强制指定为hls源，通常情况下不建议使用。 # TTVideoEngineStrategyPreloadConfig ```objectivec @interface TTVideoEngineStrategyPreloadConfig : NSObject ``` 自定义预加载策略配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [count](#TTVideoEngineStrategyPreloadConfig-count) | | NSInteger | [size](#TTVideoEngineStrategyPreloadConfig-size) | | NSInteger | [startBufferLimit](#TTVideoEngineStrategyPreloadConfig-startbufferlimit) | | NSInteger | [stopBufferLimit](#TTVideoEngineStrategyPreloadConfig-stopbufferlimit) | ## 变量说明 ### count ```objectivec @property (nonatomic, assign) NSInteger count; ``` 设置预加载视频个数。 **注意** 建议设置 3 - 5 个，SDK 内部限制最多 10 个，设置过多可能会带来成本浪费。 ### size ```objectivec @property (nonatomic, assign) NSInteger size; ``` 设置预加载视频大小，单位为（KB）。 **注意** 短视频场景建议设置 500 - 800K。您可根据视频时长调整，确保可以加载出视频首帧。 ### startBufferLimit ```objectivec @property (nonatomic, assign) NSInteger startBufferLimit; ``` 设置预加载任务开始时机。 **注意** 播放器缓冲 buffer 大于设置时长才会开始预加载。建议设置 15 秒以上。 ### stopBufferLimit ```objectivec @property (nonatomic, assign) NSInteger stopBufferLimit; ``` 设置预加载任务停止时机。 **注意** 播放器缓冲 buffer 小于设置时长才会停止预加载，并取消当前的预加载任务。建议设置 5 秒左右。 # TTVideoEngineDataLoaderErrorType ```objectivec typedef NS_ENUM( NSUInteger, TTVideoEngineDataLoaderErrorType ) ``` 视频数据加载错误。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineDataLoaderErrorNone | 0 | 默认值。 | | TTVideoEngineDataLoaderErrorFetchVideoInfo | 1 | 获取视频信息时发生错误。 | | TTVideoEngineDataLoaderErrorStart | 2 | 启动数据加载模块时发生错误。 | | TTVideoEngineDataLoaderErrorFetchData | 3 | 下载数据时发生错误。 | | TTVideoEngineDataLoaderErrorWriteFile | 4 | 写数据时发生错误。 | # TTVideoEngineLocalServerTaskInfo ```objectivec @interface TTVideoEngineLocalServerTaskInfo : NSObject ``` 数据加载模块中的缓存任务信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [key](#TTVideoEngineLocalServerTaskInfo-key) | | NSString* | [videoId](#TTVideoEngineLocalServerTaskInfo-videoid) | | TTVideoEngineResolutionType | [resolution](#TTVideoEngineLocalServerTaskInfo-resolution) | | NSString* | [localFilePath](#TTVideoEngineLocalServerTaskInfo-localfilepath) | | int64_t | [mediaSize](#TTVideoEngineLocalServerTaskInfo-mediasize) | | int64_t | [preloadSize](#TTVideoEngineLocalServerTaskInfo-preloadsize) | | TTVideoEngineURLInfo* | [urlInfo](#TTVideoEngineLocalServerTaskInfo-urlinfo) | ## 变量说明 ### key ```objectivec @property (nonatomic, copy) NSString *key; ``` 视频源唯一标识。 ### videoId ```objectivec @property (nonatomic, nullable, copy) NSString *videoId; ``` 视频 ID。 ### resolution ```objectivec @property (nonatomic, assign) TTVideoEngineResolutionType resolution; ``` 视频源分辨率，详见 [TTVideoEngineResolutionType](#TTVideoEngineResolutionType) 。 ### localFilePath ```objectivec @property (nonatomic, nullable, copy) NSString *localFilePath; ``` 本地缓存路径。 ### mediaSize ```objectivec @property (nonatomic, assign) int64_t mediaSize; ``` 视频源大小，单位：byte。 ### preloadSize ```objectivec @property (nonatomic, assign) int64_t preloadSize; ``` 预加载数据大小，单位：byte。 ### urlInfo ```objectivec @property (nonatomic, nullable, strong) TTVideoEngineURLInfo *urlInfo; ``` 视频源 URL 信息，仅预加载 Vid 播放源时有值。 # TTVideoEngineStrategyType ```objectivec typedef NS_ENUM( NSInteger, TTVideoEngineStrategyType ) ``` 播放器策略类型。SDK 支持多种策略，可以单个开启使用，也可以组合使用。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineStrategyTypeNone | 1 << 0 | - | | TTVideoEngineStrategyTypeCommon | 1 << 1 | - | | TTVideoEngineStrategyTypePreload | 1 << 2 | - | | TTVideoEngineStrategyTypePreRender | 1 << 3 | - | # TTVideoEngineSourceType ```objectivec typedef NS_ENUM( NSInteger, TTVideoEngineSourceType ) ``` 播放源类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineSourceTypeVideoId | 0 | 使用 Vid 播放源。 | | TTVideoEngineSourceTypeDirectUrl | 1 | 使用 DirectUrl 播放源。 | | TTVideoEngineSourceTypeVideoModel | 2 | 使用 VideoModel 播放源，需要按照 VideoModel 的格式组装播放源数据。 | # TTVideoEngineSeekModeType ```objectivec typedef NS_ENUM( NSUInteger, TTVideoEngineSeekModeType ) ``` Seek 类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineSeekModeAccurateAny | 0 | 精准 Seek。 | | TTVideoEngineSeekModeInAccurateBackWard | 1 | 非精准 Seek，有助于提升起播速度。 | # TTVideoEngineAudioChannelType ```objectivec typedef NS_ENUM( NSUInteger, TTVideoEngineAudioChannelType ) ``` 音频左右声道。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineAudioChannelNormal | 0 | 默认双声道。 | | TTVideoEngineAudioChannelRightDisable | 1 | 关闭右声道。 | | TTVideoEngineAudioChannelLeftDisable | 2 | 关闭左声道。 | | TTVideoEngineAudioChannelLeftUesdForLR | 3 | 使用左声道数据播放左右声道。 | | TTVideoEngineAudioChannelRightUesdForLR | 4 | 使用右声道数据播放左右声道。 | # TTVideoEngineStallReason ```objectivec typedef NS_ENUM( NSUInteger, TTVideoEngineStallReason ) ``` 播放器卡顿原因。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineStallReasonNone | 0 | 默认值。 | | TTVideoEngineStallReasonNetwork | 1 | 播放器因为网络原因导致卡顿。 | | TTVideoEngineStallReasonDecoder | 2 | 播放器因为解码器异常导致卡顿。 | # TTVideoEngineMediaSource ```objectivec @protocol TTVideoEngineMediaSource ``` 定义播放源的接口。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [uniqueId](#TTVideoEngineMediaSource-uniqueid) | | TTVideoEngineSourceType | [sourceType](#TTVideoEngineMediaSource-sourcetype) | | BOOL | [enableFallbackRefresh](#TTVideoEngineMediaSource-enablefallbackrefresh) | | NSDictionary\* | [customHeaders](#TTVideoEngineMediaSource-customheaders) | ## 变量说明 ### uniqueId ```objectivec @property (nonatomic, readonly, strong, getter=getUniqueId) NSString *uniqueId; ``` 当前播放源的唯一标识。 - `TTVideoEngineSourceTypeVideoId` 类型和 `TTVideoEngineSourceTypeVideoModel` 类型的播放源使用 `vid` 作为唯一标识。 - `TTVideoEngineSourceTypeDirectUrl` 类型的播放源使用 `cacheKey` 作为唯一标识。 ### sourceType ```objectivec @property (nonatomic, assign) TTVideoEngineSourceType sourceType; ``` 设置播放源类型，详见 [TTVideoEngineSourceType](#TTVideoEngineSourceType) 。 ### enableFallbackRefresh ```objectivec @property (nonatomic, assign) BOOL enableFallbackRefresh; ``` 开启播放过程中播放 URL 地址过期自动刷新功能。 **注意** 开启该功能后，您需要实现 `TTVideoURLRefreshFetcher` 协议对象，并通过 `[TTVideoEngine urlRefreshFetcher]` 设置给 `TTVideoEngine` 播放器实例。 ### customHeaders ```objectivec @property (nonatomic, strong, nullable) NSDictionary *customHeaders; ``` 播放或预加载的自定义 headers。 # TTVideoEngineUserAction ```objectivec typedef NS_ENUM( NSInteger, TTVideoEngineUserAction ) ``` 用户控制播放器动作。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineUserActionInit | 0 | 初始化播放器。 | | TTVideoEngineUserActionPrepare | 1 | 调用 `prepare`。 | | TTVideoEngineUserActionPlay | 2 | 调用 `play`。 | | TTVideoEngineUserActionPause | 3 | 调用 `pause`。 | | TTVideoEngineUserActionStop | 4 | 调用 `stop`。 | | TTVideoEngineUserActionClose | 5 | 调用 `close`。 | # TTVideoEngineAudioEffectType ```objectivec typedef NS_ENUM( NSUInteger, TTVideoEngineAudioEffectType ) ``` 音频效果。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineAudioEffectRTCLoudNorm | 4 | 音量均衡。 | # TTVideoEngineSubDecInfoModel ```objectivec @interface TTVideoEngineSubDecInfoModel : NSObject ``` 所有语言的字幕数据源，遵守 [TTVideoEngineSubDecInfoProtocol](#TTVideoEngineSubDecInfoProtocol) 协议。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSMutableArray\>* | [subModels](#TTVideoEngineSubDecInfoModel-submodels) | ## 成员函数 | 返回 | 名称 | | --- | --- | | instancetype | [initWithDictionary:](#TTVideoEngineSubDecInfoModel-initwithdictionary) | | instancetype | [initWithSubModels:](#TTVideoEngineSubDecInfoModel-initwithsubmodels) | | void | [addSubModel:](#TTVideoEngineSubDecInfoModel-addsubmodel) | | NSString* | [jsonString](#TTVideoEngineSubDecInfoModel-jsonstring) | | NSInteger | [subtitleCount](#TTVideoEngineSubDecInfoModel-subtitlecount) | ## 变量说明 ### subModels ```objectivec @property (nonatomic, strong, readonly) NSMutableArray> *subModels; ``` 所有字幕源列表。 ## 函数说明 ### initWithDictionary: ```objectivec - (instancetype)initWithDictionary:(NSDictionary *_Nonnull)dict; ``` 初始化所有语言的字幕数据源。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | dict | NSDictionary* | Dictionary 格式的字幕数据源。 | **返回值** 返回字幕数据源 Model。 ### initWithSubModels: ```objectivec - (instancetype)initWithSubModels:(NSArray> *_Nonnull)models; ``` 初始化所有语言的字幕数据源。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | models | NSArray\>* | 字幕数据源 [TTVideoEngineSubModel](#TTVideoEngineSubModel) 数组。 | **返回值** 返回字幕数据源 [TTVideoEngineSubDecInfoModel](#TTVideoEngineSubDecInfoModel) 实例。 ### addSubModel: ```objectivec - (void)addSubModel:(id _Nonnull)model; ``` 增加单个语言的字幕数据源。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | model | id\ | 单个语言的字幕数据源 [TTVideoEngineSubDecInfoModel](#TTVideoEngineSubDecInfoModel) 。 | ### jsonString ```objectivec - (NSString *_Nullable)jsonString; ``` 获取字幕源 JSON String。 **返回值** 返回字幕源 JSON String。 ### subtitleCount ```objectivec - (NSInteger)subtitleCount; ``` 获取字幕源个数。 **返回值** 返回字幕源个数。 # TTVideoEnginePreloaderVidItem ```objectivec @interface TTVideoEnginePreloaderVidItem : TTVideoEnginePreloaderItem ``` Vid 播放源预加载信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [videoId](#TTVideoEnginePreloaderVidItem-videoid) | | NSString* | [playAuthToken](#TTVideoEnginePreloaderVidItem-playauthtoken) | | TTVideoEngineResolutionType | [resolution](#TTVideoEnginePreloaderVidItem-resolution) | | NSInteger | [preloadSize](#TTVideoEnginePreloaderVidItem-preloadsize) | | TTVideoEngineEncodeType | [codecType](#TTVideoEnginePreloaderVidItem-codectype) | | BOOL | [encryptionEnable](#TTVideoEnginePreloaderVidItem-encryptionenable) | | BOOL | [hlsEnable](#TTVideoEnginePreloaderVidItem-hlsenable) | | NSInteger | [priorityLevel](#TTVideoEnginePreloaderVidItem-prioritylevel) | | NSDictionary* | [urlExtendParams](#TTVideoEnginePreloaderVidItem-urlextendparams) | ## 变量说明 ### videoId ```objectivec @property (nonatomic, nullable, copy) NSString *videoId; ``` （必需）设置视频 ID。 ### playAuthToken ```objectivec @property (nonatomic, copy) NSString *playAuthToken; ``` （必需）设置视频 playAuthToken。这是由应用服务端签算并下发给客户端的，详见[客户端播放](https://www.volcengine.com/docs/4/67350)。 ### resolution ```objectivec @property (nonatomic, assign) TTVideoEngineResolutionType resolution; ``` （必需）设置预加载视频分辨率，详见 [TTVideoEngineResolutionType](#TTVideoEngineResolutionType) 。预加载视频分辨率要和播放的分辨率保持一致，这样才会命中预加载。 ### preloadSize ```objectivec @property (nonatomic, assign) NSInteger preloadSize; ``` 设置预加载数据大小，例如 800 * 1024 代表预加载 800k 数据。 ### codecType ```objectivec @property (nonatomic, assign) TTVideoEngineEncodeType codecType; ``` 设置预加载视频源的编码格式，详见 [TTVideoEngineEncodeType](#TTVideoEngineEncodeType) ，默认为 `TTVideoEngineH264`。 ### encryptionEnable ```objectivec @property (nonatomic, assign) BOOL encryptionEnable; ``` 预加载视频源是否加密。 ### hlsEnable ```objectivec @property (nonatomic, assign) BOOL hlsEnable; ``` 预加载视频源是否为 HLS。 ### priorityLevel ```objectivec @property (nonatomic, assign) NSInteger priorityLevel; ``` 预加载优先级，默认为 `TTVideoEnginePrloadPriorityDefault`。 ### urlExtendParams ```objectivec @property (nonatomic, strong, nullable) NSDictionary *urlExtendParams; ``` 设置视频播放地址扩展参数。 # TTVideoEngineRotateType ```objectivec typedef NS_ENUM( NSInteger, TTVideoEngineRotateType ) ``` 播放器旋转角度。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineRotateTypeNone | 0 | 无旋转。 | | TTVideoEngineRotateType90 | 1 | 90 度旋转。 | | TTVideoEngineRotateType180 | 2 | 180 度旋转。 | | TTVideoEngineRotateType270 | 3 | 270 度旋转。 | # TTVideoEngineUrlSource ```objectivec @interface TTVideoEngineUrlSource : NSObject ``` DirectUrl 播放源。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSArray* | [urls](#TTVideoEngineUrlSource-urls) | | NSString* | [cacheKey](#TTVideoEngineUrlSource-cachekey) | | TTVideoEngineEncodeType | [encodeType](#TTVideoEngineUrlSource-encodetype) | | NSString* | [vid](#TTVideoEngineUrlSource-vid) | | NSDictionary\* | [customHeaders](#TTVideoEngineUrlSource-customheaders) | | NSInteger | [subtitleId](#TTVideoEngineUrlSource-subtitleid) | | TTVideoEngineSubDecInfoModel* | [subtitleInfoModel](#TTVideoEngineUrlSource-subtitleinfomodel) | | BOOL | [isHDRSource](#TTVideoEngineUrlSource-ishdrsource) | | BOOL | [enableFallbackRefresh](#TTVideoEngineUrlSource-enablefallbackrefresh) | | NSString* | [format](#TTVideoEngineUrlSource-format) | | NSInteger | [bitrate](#TTVideoEngineUrlSource-bitrate) | | NSString* | [decryptionKey](#TTVideoEngineUrlSource-decryptionkey) | | NSString* | [filePath](#TTVideoEngineUrlSource-filepath) | ## 成员函数 | 返回 | 名称 | | --- | --- | | instancetype | [initWithUrl:cacheKey:](#TTVideoEngineUrlSource-initwithurl-cachekey) | | instancetype | [initWithUrls:cacheKey:](#TTVideoEngineUrlSource-initwithurls-cachekey) | | instancetype | [initWithUrls:cacheKey:videoId:encodeType:decryptionKey:filePath:isHDRSource:](#TTVideoEngineUrlSource-initwithurls-cachekey-videoid-encodetype-decryptionkey-filepath-ishdrsource) | | void | [addUrls:cacheKey:encodeType:decryptionKey:filePath:isHDRSource:](#TTVideoEngineUrlSource-addurls-cachekey-encodetype-decryptionkey-filepath-ishdrsource) | ## 变量说明 ### urls ```objectivec @property (nonatomic, strong) NSArray *urls; ``` 视频 URL。支持备用 URL。 ### cacheKey ```objectivec @property (nonatomic, copy) NSString *cacheKey; ``` 缓存 key。这是 URL 对应的唯一标识，需遵循以下规则： - 不带特殊字符，能作为文件名。 - 能和视频资源文件一一对应。 - 建议使用 URL 的 MD5 值。 ### encodeType ```objectivec @property (nonatomic, assign) TTVideoEngineEncodeType encodeType; ``` 视频编码格式，详见 [TTVideoEngineEncodeType](#TTVideoEngineEncodeType) 。 ### vid ```objectivec @property (nonatomic, copy, nullable) NSString *vid; ``` 视频 ID。 ### customHeaders ```objectivec @property (nonatomic, strong, nullable) NSDictionary *customHeaders; ``` 播放或预加载的自定义 headers。 ### subtitleId ```objectivec @property (nonatomic, assign) NSInteger subtitleId; ``` 字幕Id。 ### subtitleInfoModel ```objectivec @property (nonatomic, strong, nullable) TTVideoEngineSubDecInfoModel *subtitleInfoModel; ``` 字幕源。 ### isHDRSource ```objectivec @property (nonatomic, assign) BOOL isHDRSource; ``` 是否为 HDR。 ### enableFallbackRefresh ```objectivec @property (nonatomic, assign) BOOL enableFallbackRefresh; ``` 开启播放过程中播放 URL 地址过期自动刷新功能。 **注意** 开启该功能后，您需要实现 `TTVideoURLRefreshFetcher` 协议对象，并通过 `[TTVideoEngine urlRefreshFetcher]` 设置给 `TTVideoEngine` 播放器实例。 ### format ```objectivec @property (nonatomic, copy) NSString *format; ``` 视频封装格式，例如 mp4。 ### bitrate ```objectivec @property (nonatomic, assign) NSInteger bitrate; ``` 视频码率。 ### decryptionKey ```objectivec @property (nonatomic, strong, nullable) NSString *decryptionKey; ``` 自定义密钥。用于播放加密视频。 ### filePath ```objectivec @property (nonatomic, copy, nullable) NSString *filePath; ``` 文件路径。 ## 函数说明 ### initWithUrl:cacheKey: ```objectivec - (instancetype)initWithUrl:(NSString *)url cacheKey:(NSString *)cacheKey; ``` 初始化 DirectUrl 播放源。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | NSString* | 视频 URL。 | | cacheKey | NSString* | 缓存 key。这是 URL 对应的唯一标识，需遵循以下规则：

不带特殊字符，能作为文件名。
能和视频资源文件一一对应。
建议使用 URL 的 MD5 值。

| **返回值** DirectUrl 播放源实例。 ### initWithUrls:cacheKey: ```objectivec - (instancetype)initWithUrls:(NSArray *)urls cacheKey:(NSString *)cacheKey; ``` 初始化 DirectUrl 播放源。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | urls | NSArray* | 视频 URL 列表。支持备用 URL。 | | cacheKey | NSString* | 缓存 key。这是 URL 对应的唯一标识，需遵循以下规则：

不带特殊字符，能作为文件名。
能和视频资源文件一一对应。
建议使用 URL 的 MD5 值。

| **返回值** DirectUrl 播放源实例。 ### initWithUrls:cacheKey:videoId:encodeType:decryptionKey:filePath:isHDRSource: ```objectivec - (instancetype)initWithUrls:(NSArray *)urls cacheKey:(NSString *)cacheKey videoId:(NSString * _Nullable)vid encodeType:(TTVideoEngineEncodeType)encodeType decryptionKey:(NSString * _Nullable)decryptionKey filePath:(NSString * _Nullable)filePath isHDRSource:(BOOL)isHDRSource; ``` 初始化 DirectUrl 播放源。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | urls | NSArray* | 视频 URL 列表。支持备用 URL。 | | cacheKey | NSString* | 缓存 key。这是 URL 对应的唯一标识，需遵循以下规则：

不带特殊字符，能作为文件名。
能和视频资源文件一一对应。
建议使用 URL 的 MD5 值。

| | vid | NSString* | \- | | encodeType | TTVideoEngineEncodeType | 视频编码格式，详见 [TTVideoEngineEncodeType](#TTVideoEngineEncodeType) 。 | | decryptionKey | NSString* | 自定义密钥。用于播放加密视频。 | | filePath | NSString* | 视频存储路径，可与 `cacheKey` 二选一。 | | isHDRSource | BOOL | 是否为 HDR。 | **返回值** DirectUrl 播放源实例。 ### addUrls:cacheKey:encodeType:decryptionKey:filePath:isHDRSource: ```objectivec - (void)addUrls:(NSArray *)urls cacheKey:(NSString *)cacheKey encodeType:(TTVideoEngineEncodeType)encodeType decryptionKey:(NSString * _Nullable)decryptionKey filePath:(NSString * _Nullable)filePath isHDRSource:(BOOL)isHDRSource; ``` 添加 DirectUrl 播放源。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | urls | NSArray* | 视频 URL 列表。支持备用 URL。 | | cacheKey | NSString* | 缓存 key。这是 URL 对应的唯一标识，需遵循以下规则：

不带特殊字符，能作为文件名。
能和视频资源文件一一对应。
建议使用 URL 的 MD5 值。

| | encodeType | TTVideoEngineEncodeType | 视频编码格式，详见 [TTVideoEngineEncodeType](#TTVideoEngineEncodeType) 。 | | decryptionKey | NSString* | 自定义密钥。用于播放加密视频。 | | filePath | NSString* | 视频存储路径，可与 `cacheKey` 二选一。 | | isHDRSource | BOOL | 是否为 HDR 源。 | # TTVideoEngineVideoModelSourceType ```objectivec typedef NS_ENUM( NSInteger, TTVideoEngineVideoModelSourceType ) ``` 视频格式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineVideoModelSourceTypeUnkonw | 0 | 未知 | | TTVideoEngineVideoModelSourceTypeMp4 | 1 | MP4 | | TTVideoEngineVideoModelSourceTypeDash | 10 | DASH | | TTVideoEngineVideoModelSourceTypeBash | 11 | BASH | # TTVideoEnginePreloaderVideoModelItem(PreloadItem) ```objectivec @interface TTVideoEnginePreloaderVideoModelItem (PreloadItem) ``` VideoModel 视频源预加载 item。 ## 静态函数 | 返回 | 名称 | | --- | --- | | nullable instancetype | [videoModelItemWithVideoSource:preloadSize:params:](#TTVideoEnginePreloaderVideoModelItem(PreloadItem)-videomodelitemwithvideosource-preloadsize-params) | ## 函数说明 ### videoModelItemWithVideoSource:preloadSize:params: ```objectivec + (nullable instancetype)videoModelItemWithVideoSource:(id)source preloadSize:(NSInteger)preloadSize params:(nullable NSDictionary *)params; ``` 构建一个 VideoModel 播放源预加载 Item 实例。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | source | id\ | VideoModel 播放源。 | | preloadSize | NSInteger | 预加载数据大小，例如 800 * 1024 代表预加载 800k 数据。 | | params | nullable NSDictionary* | 扩展参数，您无需设置。 | **返回值** 返回 VideoModel 播放源预加载 Item 实例。 # TTVideoEngineSubModel ```objectivec @interface TTVideoEngineSubModel : NSObject ``` 单个语言的字幕数据源，遵守 [TTVideoEngineSubProtocol](#TTVideoEngineSubProtocol) 协议。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [index](#TTVideoEngineSubModel-index) | | NSString* | [language](#TTVideoEngineSubModel-language) | | NSInteger | [expireTime](#TTVideoEngineSubModel-expiretime) | | NSString* | [cacheKey](#TTVideoEngineSubModel-cachekey) | ## 成员函数 | 返回 | 名称 | | --- | --- | | instancetype | [initWithDictionary:](#TTVideoEngineSubModel-initwithdictionary) | | NSDictionary* | [toDictionary](#TTVideoEngineSubModel-todictionary) | | NSString* | [jsonString](#TTVideoEngineSubModel-jsonstring) | ## 变量说明 ### index ```objectivec @property (nonatomic, assign, readonly) NSInteger index; ``` 当前字幕 index。 ### language ```objectivec @property (nonatomic, copy, readonly) NSString *language; ``` 字幕语言，详见[字幕语言](https://www.volcengine.com/docs/4/70518#\%E5\%AD\%97\%E5\%B9\%95\%E8\%AF\%AD\%E8\%A8\%80)。 ### expireTime ```objectivec @property (nonatomic, assign, readonly) NSInteger expireTime; ``` 字幕过期时间戳。精度为毫秒的 Unix 时间戳。 ### cacheKey ```objectivec @property (nonatomic, copy, readonly) NSString *cacheKey; ``` 本地缓存唯一标识。 ## 函数说明 ### initWithDictionary: ```objectivec - (instancetype)initWithDictionary:(NSDictionary * _Nonnull)dict; ``` 初始化单个语言的字幕数据源。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | dict | NSDictionary* | 字幕数据源。 | **返回值** 返回单个语言的字幕源数据 [TTVideoEngineSubModel](#TTVideoEngineSubModel) 。 ### toDictionary ```objectivec - (NSDictionary *_Nullable)toDictionary; ``` 将字幕数据源 Model 转换为 Dictionary。 ### jsonString ```objectivec - (NSString *_Nullable)jsonString; ``` 将字幕数据源 Model 转换为 JSON String。 # TTVideoEnginePreloaderVideoModelItem ```objectivec @interface TTVideoEnginePreloaderVideoModelItem : TTVideoEnginePreloaderItem ``` VideoModel 播放源预加载信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | TTVideoEngineResolutionType | [resolution](#TTVideoEnginePreloaderVideoModelItem-resolution) | | TTVideoEngineModel* | [videoModel](#TTVideoEnginePreloaderVideoModelItem-videomodel) | | NSInteger | [preloadSize](#TTVideoEnginePreloaderVideoModelItem-preloadsize) | | NSInteger | [priorityLevel](#TTVideoEnginePreloaderVideoModelItem-prioritylevel) | ## 变量说明 ### resolution ```objectivec @property (nonatomic, assign) TTVideoEngineResolutionType resolution; ``` 设置视频源分辨率，详见 [TTVideoEngineResolutionType](#TTVideoEngineResolutionType) 。 ### videoModel ```objectivec @property (nonatomic, strong, nullable) TTVideoEngineModel *videoModel; ``` 设置视频源信息。 ### preloadSize ```objectivec @property (nonatomic, assign) NSInteger preloadSize; ``` 设置预加载数据大小，单位：byte。例如 800 * 1024 代表预加载 800k 数据。 ### priorityLevel ```objectivec @property (nonatomic, assign) NSInteger priorityLevel; ``` 预加载优先级，默认为 `TTVideoEnginePrloadPriorityDefault`。 # TTVideoEngineEncodeType ```objectivec typedef NS_ENUM( NSInteger, TTVideoEngineEncodeType ) ``` 视频编码类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineH264 | 0 | H.264 | | TTVideoEngineh265 | 3 | H.265 | # TTVideoEngineRenderEngine ```objectivec typedef NS_ENUM( NSUInteger, TTVideoEngineRenderEngine ) ``` 视频渲染方式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineRenderEngineOpenGLES | 0 | OpenGLES 渲染。 | | TTVideoEngineRenderEngineMetal | 1 | Metal 渲染。 | | TTVideoEngineRenderEngineOutput | 2 | 业务外部渲染，不使用 SDK 渲染。 | # TTVideoEnginePreloaderVidItem(PreloadItem) ```objectivec @interface TTVideoEnginePreloaderVidItem (PreloadItem) ``` VID 视频源预加载 item。 ## 静态函数 | 返回 | 名称 | | --- | --- | | nullable instancetype | [vidItemWithVideoSource:preloadSize:](#TTVideoEnginePreloaderVidItem(PreloadItem)-viditemwithvideosource-preloadsize) | ## 函数说明 ### vidItemWithVideoSource:preloadSize: ```objectivec + (nullable instancetype)vidItemWithVideoSource:(id)source preloadSize:(NSInteger)preloadSize; ``` 构建一个 Vid 播放源预加载 Item 实例。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | source | id\ | Vid 播放源。 | | preloadSize | NSInteger | 预加载数据大小，单位：byte。例如 800 * 1024 代表预加载 800k 数据。 | **返回值** 返回 Vid 播放源预加载 Item 实例。 # TTVideoEngineScalingMode ```objectivec typedef NS_ENUM( NSInteger, TTVideoEngineScalingMode ) ``` 播放器缩放模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | TTVideoEngineScalingModeNone | 0 | 无拉伸，不会变形，可能有黑边。 | | TTVideoEngineScalingModeAspectFit | 1 | 按照视频宽高等比适配画面，不会变形，可能有黑边。 | | TTVideoEngineScalingModeAspectFill | 2 | 按照视频宽高等比填充画面，不会变形，可能有画面裁剪。 | | TTVideoEngineScalingModeFill | 3 | - | # TTVideoEngineSubProtocol ```objectivec @protocol TTVideoEngineSubProtocol ``` 单个语言的字幕数据源协议。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [languageId](#TTVideoEngineSubProtocol-languageid) | | NSString* | [urlString](#TTVideoEngineSubProtocol-urlstring) | | NSString* | [format](#TTVideoEngineSubProtocol-format) | | NSInteger | [subtitleId](#TTVideoEngineSubProtocol-subtitleid) | | NSString* | [cacheKey](#TTVideoEngineSubProtocol-cachekey) | ## 成员函数 | 返回 | 名称 | | --- | --- | | NSDictionary* | [toDictionary](#TTVideoEngineSubProtocol-todictionary) | | NSString* | [jsonString](#TTVideoEngineSubProtocol-jsonstring) | ## 变量说明 ### languageId ```objectivec @property (nonatomic, assign, readonly) NSInteger languageId; ``` 字幕语言 ID。详见[字幕语言](https://www.volcengine.com/docs/4/70518#\%E5\%AD\%97\%E5\%B9\%95\%E8\%AF\%AD\%E8\%A8\%80)。 ### urlString ```objectivec @property (nonatomic, copy, readonly) NSString *urlString; ``` 字幕 URL 地址。 ### format ```objectivec @property (nonatomic, copy, readonly) NSString *format; ``` 字幕格式。 ### subtitleId ```objectivec @property (nonatomic, assign, readonly) NSInteger subtitleId; ``` 字幕 ID。 ### cacheKey ```objectivec @property (nonatomic, copy, readonly) NSString *cacheKey; ``` 本地缓存唯一标识。 ## 函数说明 ### toDictionary ```objectivec - (NSDictionary *_Nullable)toDictionary; ``` 将字幕数据源 Model 转换为 Dictionary。 ### jsonString ```objectivec - (NSString *_Nullable)jsonString; ``` 将字幕数据源 Model 转换为 JSON String。 # TTVideoEngineSubDecInfoProtocol ```objectivec @protocol TTVideoEngineSubDecInfoProtocol ``` 所有语言的字幕数据源协议。 ## 成员函数 | 返回 | 名称 | | --- | --- | | NSString* | [jsonString](#TTVideoEngineSubDecInfoProtocol-jsonstring) | | NSInteger | [subtitleCount](#TTVideoEngineSubDecInfoProtocol-subtitlecount) | ## 函数说明 ### jsonString ```objectivec - (NSString *_Nullable)jsonString; ``` 注入 JSON 格式的字幕数据源。 **返回值** 返回 JSON 格式的字幕源数据。 ### subtitleCount ```objectivec - (NSInteger)subtitleCount; ``` 获取字幕语言的个数。 **返回值** 返回字幕语言的个数。

视频点播