TXVodPlayConfig API 简介
点播播放器播放配置， 需要在播放前设置。
TX_Enum_MP4EncryptionLevel（MP4加密播放等级）
值 | 参数名 | 描述 |
0 | MP4_ENCRYPTION_LEVEL_NONE | 不加密。 |
1 | MP4_ENCRYPTION_LEVEL_L1 | L1（在线加密）。 |
2 | MP4_ENCRYPTION_LEVEL_L2 | L2（本地加密）。 |
TX_Enum_PlayerType（播放器类型定义）
值 | 参数名 | 描述 |
0 | PLAYER_AVPLAYER | 系统播放器。 |
1 | PLAYER_THUMB_PLAYER | 基于 FFmpeg，支持软解，兼容性更好。 |
TX_Enum_VideoResolution（播放器偏好分辨率）
值 | 参数名 | 描述 |
720 * 1280 | VIDEO_RESOLUTION_720X1280 | 清晰度 720X1280。 |
1080 * 1920 | VIDEO_RESOLUTION_1080X1920 | 清晰度 1080X1920。 |
1440 * 2560 | VIDEO_RESOLUTION_1440X2560 | 清晰度 1440X2560。 |
2160 * 3840 | VIDEO_RESOLUTION_2160X3840 | 清晰度 2160X3840。 |
TX_Enum_MediaType（媒资类型）
值 | 参数名 | 描述 |
0 | MEDIA_TYPE_AUTO | AUTO 类型（默认值，自适应码率播放暂不支持）。 |
1 | MEDIA_TYPE_HLS_VOD | HLS 点播媒资。 |
2 | MEDIA_TYPE_HLS_LIVE | HLS 直播媒资。 |
3 | MEDIA_TYPE_FILE_VOD | MP4等通用文件点播媒资。 |
4 | MEDIA_TYPE_DASH_VOD | DASH 点播媒资。 |
TX_Enum_Video_Pixel_Format（视频帧输出类型）
值 | 参数名 | 描述 |
0 | TX_VIDEO_PIXEL_FORMAT_NONE | 无效类型。 |
1 | TX_VIDEO_PIXEL_FORMAT_VideoToolbox | VIDEO TOOL BOX，直接原视频格式输出。 |
2 | TX_VIDEO_PIXEL_FORMAT_RGBA | RGBA 格式（由于苹果不推荐用 RGBA，请使用 BGRA 格式进行替代）。 |
3 | TX_VIDEO_PIXEL_FORMAT_BGRA | BGRA 格式。 |
接口概览
API | 描述 |
设置播放器在异常场景下重连次数。 | |
播放器连接重试间隔，单位秒。最小值为3， 最大值为30。默认值为3。 | |
设置播放器连接超时时间。 | |
视频渲染对象回调的视频格式。 | |
播放停止后是否保留最后一帧画面，默认为 NO。 | |
首缓需要加载的数据时长，单位 ms, 默认值为 200ms。 | |
缓冲（缓冲数据不够引起的二次缓冲，或者 seek 引起的拖动缓冲）最大时长，单位 ms，默认值为4000ms。 | |
设置播放器类型。 | |
设置 Http header。 | |
设置是否精确 seek。默认为 YES。 | |
设置播放 MP4 是否自动旋转角度。默认为 YES。 | |
设置是否平滑切换多码率 HLS。默认为 NO。 | |
设置进度回调间隔。默认为500ms。 | |
设置播放器最大播放缓冲大小。 | |
设置预加载最大缓冲大小。 | |
设置加密 key。 | |
加密 Iv。 | |
设置播放器是否允许加载渲染后处理服务。默认为 NO。 | |
设置 HLS 最优的码流进行起播。 | |
设置 MP4 加密播放。 | |
设置播放器播放的媒资类型。 | |
设置播放器拓展参数。 | |
设置启播时优先使用的音轨。 | |
开启/关闭 URL 鉴权过期自动刷新能力。 | |
设置 URL 鉴权过期自动刷新的挂起等待时长(毫秒)。默认为 10000ms。 |
接口详情
connectRetryCount
设置播放器在异常场景下重连次数。
当 SDK 与服务器异常断开连接时，SDK 会尝试与服务器重连，通过此函数设置 SDK 重连次数，默认值为3。
@property(nonatomic, assign) int connectRetryCount;
connectRetryInterval
设置播放器在异常场景下重连间隔时长。
单位秒，最小值为3，最大值为30，默认值为3。
@property(nonatomic, assign) int connectRetryInterval;
timeout
设置播放器连接超时时间，默认值为10秒。
@property(nonatomic, assign) NSTimeInterval timeout;
videoFrameFormatType
设置视频渲染对象回调的视频格式。默认值为 TX_VIDEO_PIXEL_FORMAT_NONE。
@property(nonatomic, assign) TX_Enum_Video_Pixel_Format videoFrameFormatType;
参数说明
参数名 | 类型 | 描述 |
videoFrameFormatType | TX_Enum_Video_Pixel_Format |
keepLastFrameWhenStop
播放器 stop 后是否保留最后一帧画面，默认值为 NO。
@property(nonatomic, assign) BOOL keepLastFrameWhenStop;
firstStartPlayBufferTime
首缓需要加载的数据时长，单位 ms。默认值为200ms。
@property(nonatomic, assign) int firstStartPlayBufferTime;
参数说明
参数名 | 类型 | 描述 |
firstStartPlayBufferTime | int | 时长大小。 |
nextStartPlayBufferTime
缓冲时（缓冲数据不够引起的二次缓冲，或者 seek 引起的拖动缓冲）最少要缓存多长的数据才能结束缓冲，单位 ms。默认值为 4000ms。
@property(nonatomic, assign) int nextStartPlayBufferTime;
playerType
设置播放器类型，默认为腾讯云自研播放器。
@property(nonatomic, assign) NSInteger playerType;
参数说明
参数名 | 类型 | 描述 |
playerType | int | 播放器类型，取值有： PLAYER_AVPLAYER： iOS 系统播放器。 PLAYER_THUMB_PLAYER：腾讯云自研播放器，默认值。 |
headers
自定义配置播放器播放联网过程中携带的 Http header。
@property(nonatomic, strong) NSDictionary *headers;
参数说明
参数名 | 类型 | 描述 |
headers | NSDictionary <NSString *, NSString *> | 自定义的 Http header 内容。 |
enableAccurateSeek
设置是否精确 seek，默认 true。
@property(nonatomic, assign) BOOL enableAccurateSeek;
参数说明
参数名 | 类型 | 描述 |
enableAccurateSeek | BOOL | 是否精确 seek。 |
autoRotate
播放 MP4 文件时，若设为 YES 则根据文件中的旋转角度自动旋转。旋转角度可在 PLAY_EVT_CHANGE_ROTATION 事件中获得，默认值为 YES。
@property(nonatomic, assign) BOOL autoRotate;
参数说明
参数名 | 类型 | 描述 |
autoRotate | BOOL | 播放时旋转角度是否自动旋转。 |
smoothSwitchBitrate
设置是否平滑切换多码率 HLS，默认 NO。
@property(nonatomic, assign) BOOL smoothSwitchBitrate;
参数说明
参数名 | 类型 | 描述 |
smoothSwitchBitrate | BOOL | 是否平滑切换多码率 HLS。 |
progressInterval
设置进度回调间隔时间，单位毫秒。默认间隔为500毫秒。
@property(nonatomic, assign) NSTimeInterval progressInterval;
参数说明
参数名 | 类型 | 描述 |
progressInterval | NSTimeInterval | 间隔时间，单位毫秒。 |
maxBufferSize
最大缓存大小，单位 MB。此设置会影响 playableDuration，设置越大，提前缓存的越多。
@property(nonatomic, assign) float maxBufferSize;
参数说明
参数名 | 类型 | 描述 |
maxBufferSize | float | 播放缓冲大小。 |
maxPreloadSize
设置预加载最大缓冲大小，单位 MB。
@property(nonatomic, assign) float maxPreloadSize;
参数说明
参数名 | 类型 | 描述 |
maxPreloadSize | float | 预加载大小。 |
overlayKey
设置加密 key。
@property(nonatomic, copy) NSString *overlayKey;
overlayIv
设置加密 Iv。
@property(nonatomic, copy) NSString *overlayIv;
encryptedMp4Level
设置 MP4 加密播放。
@property(nonatomic, assign) TX_Enum_MP4EncryptionLevel encryptedMp4Level;
参数说明
参数名 | 类型 | 描述 |
encryptedMp4Level | TX_Enum_MP4EncryptionLevel |
enableRenderProcess
设置 Render 显示后处理标志位，包含超分、VR 播放等功能，使用这些功能需要设置此标志位。默认为 NO。
@property(nonatomic, assign) BOOL enableRenderProcess;
参数说明
参数名 | 类型 | 描述 |
enableRenderProcess | BOOL | 是否允许加载后渲染后处理服务。 |
preferredResolution
HLS 多 Program 时，根据设定的 preferredResolution 选最优的 Program 进行起播，preferredResolution 为宽高的乘积。配置有效值为 >=-1 的整形数，缺省为-1，播放内核理解为应使用优先级更低的信息进行配置，会从小于该值的 Program 中匹配算数距离最接近的。
优先级为 bitrateIndex > preferredBitrate > preferredResolution。
@property(nonatomic, assign) long preferredResolution;
参数说明
参数名 | 类型 | 描述 |
preferredResolution | long | 视频宽高的乘积（width * height）。 |
mediaType
设置媒资类型。若自适应码率播放，则须指定具体类型。如自适应播放 HLS 直播资源，须传入 MEDIA_TYPE_HLS_LIVE 类型。
@property(nonatomic, assign) TX_Enum_MediaType mediaType;
参数说明
参数名 | 类型 | 描述 |
mediaType | TX_Enum_MediaType |
extInfoMap
设置播放器特殊配置。
@property(nonatomic, strong) NSDictionary *extInfoMap;
参数说明
参数名 | 类型 | 描述 |
extInfoMap | NSDictionary | 拓展参数。 |
preferAudioTrack
设置启播时优先加载的音轨名称。仅播放器高级版支持。
@property(nonatomic, copy) NSString *preferAudioTrack;
参数说明
参数名 | 类型 | 描述 |
preferAudioTrack | NSString | 音轨名称。 |
enableUrlRefresh
是否开启 URL 鉴权过期自动刷新兜底能力。
说明：
开启后，当 dataproxy 收到 401/403 鉴权失败时，不再直接失败，而是挂起当前请求并抛出 VOD_PLAY_EVT_URL_DENIED(2033) 事件，等待业务侧调用 [TXVodPlayer refreshUrlQuery:] 换发新 URL。默认 NO（关闭）。
@property(nonatomic, assign) BOOL enableUrlRefresh;
参数说明
参数名 | 类型 | 描述 |
enableUrlRefresh | BOOL | YES: 开启 NO：关闭 |
urlRefreshHangMs
URL 鉴权刷新兜底挂起时长，单位毫秒。挂起期间若业务未回调 refreshUrlQuery，超时后按原鉴权失败路径处理。默认 10000ms。
@property(nonatomic, assign) int urlRefreshHangMs;
参数说明
参数名 | 类型 | 描述 |
urlRefreshHangMs | int | 挂起等待时长，单位毫秒。推荐范围 3000 ~ 15000，默认 10000。 |
