typedef NS_ENUM(
    NSInteger,
    TTVideoEngineFinishReason
)

播放结束原因。

枚举值 #

@interface TTVideoEnginePreloaderURLItem (PreloadItem)

DirectUrl 视频源预加载 item。

静态函数 #

函数说明 #

urlItemWithVideoSource:preloadSize: #

+ (nullable instancetype)urlItemWithVideoSource:(id<TTVideoEngineMediaSource>)source preloadSize:(NSInteger)preloadSize;

构造一个 DirectUrl 播放源预加载 Item 实例。

传入参数

返回值

返回 DirectUrl 播放源预加载 Item 实例。

typedef NS_ENUM(
    NSInteger,
    TTVideoEngineStreamType
)

视频流类型。

枚举值 #

函数 #

函数说明 #

TTVideoURLRefreshCompleteBlock #

typedef void(^TTVideoURLRefreshCompleteBlock)(NSString *newUrl, NSString *expireTimeInMS);

过期 URL 刷新完成 block。

传入参数

TTVideoURLRefreshErrorBlock #

typedef void(^TTVideoURLRefreshErrorBlock)(NSError *error);

过期 URL 刷新失败 block。

传入参数

TTVideoURLRefreshCancelBlock #

typedef void(^TTVideoURLRefreshCancelBlock)(void);

过期 URL 取消刷新 block。

typedef NS_ENUM(
    NSUInteger,
    TTVideoEngineState
)

播放器状态。

枚举值 #

typedef NS_ENUM(
    NSUInteger,
    TTVideoEngineLoadState
)

播放器加载状态。

枚举值 #

typedef NS_ENUM(
    NSInteger,
    TTVideoEngineStallAction
)

导致播放器发生卡顿的具体动作。

枚举值 #

@interface TTVideoEngineLoadInfo: NSObject

播放器字幕加载信息。

成员变量 #

变量说明 #

firstPts #

@property (nonatomic, assign) NSInteger firstPts;

首段字幕展示时间戳。

code #

@property (nonatomic, assign) NSInteger code;

字幕加载状态。code 为 0 表示加载成功。

loadStageCode #

@property (nonatomic, assign) NSInteger loadStageCode;

字幕加载阶段状态码，用于字幕加载失败问题分析

@interface TTVideoEngineSubInfo: NSObject

单段字幕信息。

成员变量 #

变量说明 #

pts #

@property (nonatomic, assign) NSInteger pts;

该段字幕对应的时间戳，单位为毫秒。

content #

@property (nonatomic, copy) NSString *content;

该段字幕的内容。

duration #

@property (nonatomic, assign) NSInteger duration;

该段字幕持续的时间，单位为毫秒。

@interface TTVideoEnginePreloaderSubtitleItem : TTVideoEnginePreloaderItem

Vid 播放源预加载信息。

成员变量 #

静态函数 #

变量说明 #

subtitleId #

@property (nonatomic, assign) NSInteger subtitleId;

预加载字幕 id。

priorityLevel #

@property (nonatomic, assign) NSInteger priorityLevel;

预加载优先级，默认为 TTVideoEnginePrloadPriorityDefault。

subtitleInfoModel #

@property (nonatomic, strong, nonnull) TTVideoEngineSubDecInfoModel *subtitleInfoModel;

字幕源。

函数说明 #

preloaderSubtitleItem:subtitleId: #

+ (instancetype)preloaderSubtitleItem:(TTVideoEngineSubDecInfoModel *)subtitleInfoModel
                           subtitleId:(NSInteger)subtitleId;

创建字幕预加载任务。

传入参数

返回值

返回字幕预加载 Item 实例。

@interface TTVideoEngineLocalServerConfigure : NSObject

数据加载模块配置。数据加载模块（MDL，Media Data Loader）是点播 SDK 内部的关键模块之一，为播放器提供高速、低成本、可靠的数据加载服务。点播 SDK 的预加载、文件缓存、边下边播、网络质量和成本数据监控等功能均依赖于数据模块。点播 SDK 初始化时，会默认启动数据加载模块。

成员变量 #

变量说明 #

maxCacheSize #

@property(nonatomic, assign) NSInteger maxCacheSize;

设置本地缓存最大数据量，单位为 byte。

preloadParallelNum #

@property(nonatomic, assign) NSInteger preloadParallelNum;

设置预加载并发数，默认值为 2。

downloadDirectory #

@property(nonatomic, nullable, copy) NSString *downloadDirectory;

设置下载文件的沙盒存储路径，如果你使用下载功能，该路径必须设置。

@interface TTVideoEngineLocalServerCacheInfo : NSObject

数据加载模块的本地缓存配置信息。

成员变量 #

变量说明 #

mediaSize #

@property(nonatomic, assign) int64_t mediaSize;

视频源数据大小，单位：byte。

localFilePath #

@property(nonatomic,   copy) NSString *localFilePath;

本地缓存路径。

typedef NS_ENUM(
    NSInteger,
    TTVideoEnginePlaybackState
)

播放状态。

枚举值 #

typedef NS_ENUM(
    NSUInteger,
    TTVideoEngineNetworkType
)

网络类型。

枚举值 #

typedef NS_ENUM(
    NSInteger,
    TTVideoEngineDownloadState
)

下载状态。

枚举值 #

typedef NS_OPTIONS(
    NSInteger,
    TTVideoEngineLogFlag
)

播放器输出日志模块。

枚举值 #

@protocol TTVideoEngineExternDNSParserDataSource<NSObject>

该协议描述使用外部自定义 DNS 解析 DataSource。

成员函数 #

函数说明 #

hostName #

- (NSString *)hostName;

解析的域名。

ipList #

- (NSArray *)ipList;

域名解析出的 IP 列表。

ttl #

- (NSInteger)ttl;

解析过期时间，单位：秒。

typedef NS_ENUM(
    NSInteger,
    TTVideoEngineMirrorType
)

镜像模式。

枚举值 #

@interface TTVideoEngineVidSource : NSObject <TTVideoEngineMediaSource>

Vid 播放源。

成员变量 #

成员函数 #

变量说明 #

vid #

@property (nonatomic, copy) NSString *vid;

（必需）设置视频 ID。

playAuthToken #

@property (nonatomic, copy) NSString *playAuthToken;

（必需）设置用于鉴权的 playAuthToken。这是由应用服务端签算并下发给客户端的，详见客户端播放。

subtitleAuthToken #

@property (nonatomic, copy) NSString *subtitleAuthToken;

设置用于鉴权的 subtitleAuthToken。这是由应用服务端签算并下发给客户端的。

resolution #

@property (nonatomic, assign) TTVideoEngineResolutionType resolution;

设置视频分辨率，详见 TTVideoEngineResolutionType 。

encodeType #

@property (nonatomic, assign) TTVideoEngineEncodeType encodeType;

设置视频编码格式，详见 TTVideoEngineEncodeType 。默认为 H.264。

isDash #

@property (nonatomic, assign) BOOL isDash;

设置是否为 DASH。默认为 NO。

isHLS #

@property (nonatomic, assign) BOOL isHLS;

设置是否为 HLS。默认为 NO。

urlExtendParams #

@property (nonatomic, strong, nullable) NSDictionary *urlExtendParams;

设置视频播放地址扩展参数。

customHeaders #

@property (nonatomic, strong, nullable) NSDictionary<NSString *, NSString *> *customHeaders;

播放或预加载的自定义 headers。

函数说明 #

preloadVideoResolution #

@property (nonatomic, strong, nullable) TTVideoEngineResolutionType (^preloadVideoResolution)(void);

获取预加载档位，默认使用 resolution 设置的值，如果业务播放过程中切换档位，可以使用该回调同步修改预加载档位。

preloadSubtitleModelBlock #

@property (nonatomic, strong, nullable) id<TTVideoEngineSubProtocol> (^preloadSubtitleModelBlock)(NSArray<id<TTVideoEngineSubProtocol>> *subModels);

获取缓存预加载 subtitle model。

传入参数

initWithVid:playAuthToken:resolution: #

- (instancetype)initWithVid:(NSString *)vid
              playAuthToken:(NSString *)playAuthToken
                 resolution:(TTVideoEngineResolutionType)resolution;

初始化 Vid 播放源。

传入参数

返回值

Vid 播放源实例。
Vid 播放源实例。

initWithVid:playAuthToken:resolution:encodeType:isDash:isHLS: #

- (instancetype)initWithVid:(NSString *)vid
              playAuthToken:(NSString *)playAuthToken
                 resolution:(TTVideoEngineResolutionType)resolution
                 encodeType:(TTVideoEngineEncodeType)encodeType
                     isDash:(BOOL)isDash
                      isHLS:(BOOL)isHLS;

初始化 Vid 播放源。

传入参数

返回值

Vid 播放源实例。

typedef NS_ENUM(
    NSUInteger,
    TTVideoEngineResolutionType
)

视频清晰度。

枚举值 #

@interface TTVideoEnginePreloaderURLItem : TTVideoEnginePreloaderItem

DirectUrl 播放源预加载信息。

成员变量 #

变量说明 #

key #

@property (nonatomic, copy, nullable) NSString *key;

（必需）设置预加载任务唯一标识。建议使用 URL MD5 值作为 key。如果使用 URL MD5 值作为 key，需要注意某些 URL 可能会包含时间戳或签名等信息，在使用之前需要将这些可变部分去除，以保证使用的是不变的 URL 的 MD5 值。

urls #

@property (nonatomic, copy, nullable) NSArray<NSString *> *urls;

（必需）设置预加载视频源的 URL。支持主备 URL。

videoId #

@property (nonatomic, copy, nullable) NSString *videoId;

（必需）视频的唯一标识，必须与视频源一一对应。可以是您自己的视频管理系统中的视频唯一标识，也可以跟 key 赋值一样。

cacheFilePath #

@property (nonatomic, copy, nullable) NSString *cacheFilePath;

指定缓存路径。SDK 有默认缓存路径，不建议您单独设置。

preloadSize #

@property (nonatomic, assign) NSInteger preloadSize;

设置预加载数据大小，例如 800 * 1024 代表预加载 800k 数据。

priorityLevel #

@property (nonatomic, assign) NSInteger priorityLevel;

预加载优先级，默认为 TTVideoEnginePrloadPriorityDefault。

decryptionKey #

@property (nonatomic, strong, nullable) NSString *decryptionKey;

自定义私有加密密钥。用于播放加密视频。

isForceUseHLSProxy #

@property (nonatomic, assign) BOOL isForceUseHLSProxy;

强制指定为hls源，通常情况下不建议使用。

@interface TTVideoEngineStrategyPreloadConfig : NSObject

自定义预加载策略配置。

成员变量 #

变量说明 #

count #

@property (nonatomic, assign) NSInteger count;

设置预加载视频个数。

注意

建议设置 3 - 5 个，SDK 内部限制最多 10 个，设置过多可能会带来成本浪费。

size #

@property (nonatomic, assign) NSInteger size;

设置预加载视频大小，单位为（KB）。

注意

短视频场景建议设置 500 - 800K。您可根据视频时长调整，确保可以加载出视频首帧。

startBufferLimit #

@property (nonatomic, assign) NSInteger startBufferLimit;

设置预加载任务开始时机。

注意

播放器缓冲 buffer 大于设置时长才会开始预加载。建议设置 15 秒以上。

stopBufferLimit #

@property (nonatomic, assign) NSInteger stopBufferLimit;

设置预加载任务停止时机。

注意

播放器缓冲 buffer 小于设置时长才会停止预加载，并取消当前的预加载任务。建议设置 5 秒左右。

typedef NS_ENUM(
    NSUInteger,
    TTVideoEngineDataLoaderErrorType
)

视频数据加载错误。

枚举值 #

@interface TTVideoEngineLocalServerTaskInfo : NSObject

数据加载模块中的缓存任务信息。

成员变量 #

变量说明 #

key #

@property (nonatomic,   copy) NSString *key;

视频源唯一标识。

videoId #

@property (nonatomic, nullable, copy) NSString *videoId;

视频 ID。

resolution #

@property (nonatomic, assign) TTVideoEngineResolutionType resolution;

视频源分辨率，详见 TTVideoEngineResolutionType 。

localFilePath #

@property (nonatomic, nullable, copy) NSString *localFilePath;

本地缓存路径。

mediaSize #

@property (nonatomic, assign) int64_t mediaSize;

视频源大小，单位：byte。

preloadSize #

@property (nonatomic, assign) int64_t preloadSize;

预加载数据大小，单位：byte。

urlInfo #

@property (nonatomic, nullable, strong) TTVideoEngineURLInfo *urlInfo;

视频源 URL 信息，仅预加载 Vid 播放源时有值。

typedef NS_ENUM(
    NSInteger,
    TTVideoEngineStrategyType
)

播放器策略类型。SDK 支持多种策略，可以单个开启使用，也可以组合使用。

枚举值 #

typedef NS_ENUM(
    NSInteger,
    TTVideoEngineSourceType
)

播放源类型。

枚举值 #

typedef NS_ENUM(
    NSUInteger,
    TTVideoEngineSeekModeType
)

Seek 类型。

枚举值 #

typedef NS_ENUM(
    NSUInteger,
    TTVideoEngineAudioChannelType
)

音频左右声道。

枚举值 #

typedef NS_ENUM(
    NSUInteger,
    TTVideoEngineStallReason
)

播放器卡顿原因。

枚举值 #

@protocol TTVideoEngineMediaSource <NSObject>

定义播放源的接口。

成员变量 #

变量说明 #

uniqueId #

@property (nonatomic, readonly, strong, getter=getUniqueId) NSString *uniqueId;

当前播放源的唯一标识。

• TTVideoEngineSourceTypeVideoId 类型和 TTVideoEngineSourceTypeVideoModel 类型的播放源使用 vid 作为唯一标识。

• TTVideoEngineSourceTypeDirectUrl 类型的播放源使用 cacheKey 作为唯一标识。
  

sourceType #

@property (nonatomic, assign) TTVideoEngineSourceType sourceType;

设置播放源类型，详见 TTVideoEngineSourceType 。

enableFallbackRefresh #

@property (nonatomic, assign) BOOL enableFallbackRefresh;

开启播放过程中播放 URL 地址过期自动刷新功能。

注意

开启该功能后，您需要实现 TTVideoURLRefreshFetcher 协议对象，并通过 [TTVideoEngine urlRefreshFetcher] 设置给 TTVideoEngine 播放器实例。

customHeaders #

@property (nonatomic, strong, nullable) NSDictionary<NSString *, NSString *> *customHeaders;

播放或预加载的自定义 headers。

typedef NS_ENUM(
    NSInteger,
    TTVideoEngineUserAction
)

用户控制播放器动作。

枚举值 #

typedef NS_ENUM(
    NSUInteger,
    TTVideoEngineAudioEffectType
)

音频效果。

枚举值 #

@interface TTVideoEngineSubDecInfoModel : NSObject <TTVideoEngineSubDecInfoProtocol>