TXVodPlayConfig API 简介
点播播放器播放配置, 需要在播放前设置。
接口概览
API | 描述 |
设置播放器在异常场景下重连次数。 | |
设置播放器连接超时时间。 | |
设置播放器类型。 | |
设置Http header。 | |
设置是否精确 seek。 | |
设置播放 MP4 是否自动旋转角度。 | |
设置是否平滑切换多码率 HLS。 | |
设置缓存 MP4 文件扩展名。 | |
设置进度回调间隔。 | |
设置播放器最大播放缓冲大小。 | |
设置预加载最大缓冲大小。 | |
设置播放器是否允许加载渲染后处理服务。 | |
设置 HLS最优的码流进行起播。 | |
设置 MP4 加密播放。 | |
设置播放器播放的媒资类型。 | |
设置播放器拓展参数。 | |
设置启播时优先使用的音轨。 |
接口详情
setConnectRetryCount
设置播放器在异常场景下重连次数。
当 SDK 与服务器异常断开连接时,SDK 会尝试与服务器重连,通过此函数设置 SDK 重连次数,默认值为 3。
public void setConnectRetryCount(int count)
参数说明
参数名 | 类型 | 描述 |
count | int | 播放异常场景下重连次数。 |
setTimeout
设置播放器连接超时时间,默认值为 10 秒。
public void setTimeout(int timeout)
参数说明
参数名 | 类型 | 描述 |
interval | int | 连接超时时间,单位秒, 默认值为 10 秒。 |
setCacheFolderPath
设置点播缓存目录。
注意:此接口已经废弃,请使用
TXPlayerGlobalSetting#setCacheFolderPath
做全局配置。public void setCacheFolderPath(String folderPath)
参数说明
参数名 | 类型 | 描述 |
folderPath | String | 缓存路径。 |
setMaxCacheItems
设置缓存文件个数。
注意:此接口已经废弃,请使用 TXPlayerGlobalSetting#setMaxCacheSize 做全局配置。
public void setMaxCacheItems(int maxCacheItems)
参数说明
参数名 | 类型 | 描述 |
maxCacheItems | int | 最大缓存条目。 |
setPlayerType
设置播放器类型,默认为腾讯云自研播放器。
public void setPlayerType(int playerType)
参数说明
参数名 | 类型 | 描述 |
playerType | int | 播放器类型,取值有: TXVodConstants#PLAYER_SYSTEM_MEDIA_PLAYER: Android 系统播放器。 TXVodConstants#PLAYER_THUMB_PLAYER:腾讯云自研播放器,默认值。 |
setHeaders
自定义配置播放器播放联网过程中携带的 Http header。
public void setHeaders(Map<String, String> headers)
参数说明
参数名 | 类型 | 描述 |
headers | Map<String, String> | 自定义的 Http header 内容。 |
setEnableAccurateSeek
设置是否精确 seek,默认 true。
public void setEnableAccurateSeek(boolean accurateSeek)
参数说明
参数名 | 类型 | 描述 |
accurateSeek | boolean | 是否精确 seek。 |
setAutoRotate
播放
MP4 文件时,若设为 YES 则根据文件中的旋转角度自动旋转。旋转角度可在 PLAY_EVT_CHANGE_ROTATION 事件中获得,默认值为 YES。public void setAutoRotate(boolean autoRotate)
参数说明
参数名 | 类型 | 描述 |
autoRotate | boolean | 播放时旋转角度是否自动旋转。 |
setSmoothSwitchBitrate
设置是否平滑切换多码率 HLS,默认 false。
public void setSmoothSwitchBitrate(boolean smoothSwitchBitrate)
参数说明
参数名 | 类型 | 描述 |
smoothSwitchBitrate | boolean | 是否平滑切换多码率 HLS。 |
setCacheMp4ExtName
设置缓存 mp4 文件扩展名,默认为 mp4 。
public void setCacheMp4ExtName(String cacheMp4ExtName)
参数说明
参数名 | 类型 | 描述 |
cacheMp4ExtName | boolean | 文件扩展名称。 |
setProgressInterval
设置进度回调间隔,默认为 0.5 秒回调一次。
public void setProgressInterval(int intervalMs)
参数说明
参数名 | 类型 | 描述 |
intervalMs | int | 间隔时间,单位毫秒。 |
setMaxBufferSize
设置播放器最大播放缓冲大小,单位 MB 。
public void setMaxBufferSize(float maxBufferSize)
参数说明
参数名 | 类型 | 描述 |
maxBufferSize | float | 播放缓冲大小。 |
setMaxPreloadSize
设置预加载最大缓冲大小,单位:MB。
public void setMaxPreloadSize(float maxPreloadSize)
参数说明
参数名 | 类型 | 描述 |
maxPreloadSize | float | 预加载大小。 |
setFirstStartPlayBufferTime
设置播放器首缓需要加载的数据时长,单位 ms,默认值为100ms。
注意:此接口已经废弃,请使用 #setMaxBufferSize或 #setMaxPreloadSize 设置缓冲大小。
public void setFirstStartPlayBufferTime(int milliseconds)
参数说明
参数名 | 类型 | 描述 |
milliseconds | int | 时长大小。 |
setEnableRenderProcess
设置播放器是否允许加载渲染后处理服务,默认关闭。
public void setEnableRenderProcess(boolean enableRenderProcess)
参数说明
参数名 | 类型 | 描述 |
enableRenderProcess | boolean | 是否允许加载后渲染后处理服务。 |
setPreferredResolution
播放 HLS 有多条码流时,播放器根据设定的 preferredResolution 选最优的码流进行起播, preferredResolution 是宽高的乘积(width * height),
启播前设置才有效。
public void setPreferredResolution(long preferredResolution)
参数说明
参数名 | 类型 | 描述 |
preferredResolution | long | 视频宽高的乘积(width * height)。 |
setEncryptedMp4Level
设置 MP4 加密播放,默认不加密。
public void setEncryptedMp4Level(int level)
参数说明
参数名 | 类型 | 描述 |
level | int | 设置 MP4 播放和存储加密等级,从播放器高级版12.2 版本开始支持,目前支持: TXVodConstants#MP4_ENCRYPTION_LEVEL_NONE:非加密播放,默认支持。 TXVodConstants#MP4_ENCRYPTION_LEVEL_L2:MP4 本地加密播放。 |
setMediaType
设置播放器播放的媒资类型,默认为 AUTO 类型。
public void setMediaType(int mediaType)
参数说明
参数名 | 类型 | 描述 |
mediaType | int | 设置媒资类型,默认为 AUTO 类型。可选值有: TXVodConstants#MEDIA_TYPE_AUTO,AUTO 类型(默认值,自适应码率播放暂不支持)。 TXVodConstants#MEDIA_TYPE_HLS_VOD,HLS 点播媒资。 TXVodConstants#MEDIA_TYPE_HLS_LIVE,HLS 直播媒资。 TXVodConstants#MEDIA_TYPE_FILE_VOD,MP4 等通用文件点播媒资(从 11.2 版本开始支持)。 TXVodConstants#MEDIA_TYPE_DASH_VOD,DASH 点播媒资(从 11.2 版本开始支持) |
setExtInfo
设置播放器拓展参数。
public void setExtInfo(Map<String, Object> map)
参数说明
参数名 | 类型 | 描述 |
map | Map | 拓展参数。 |
setPreferredAudioTrack
设置启播时优先使用的音轨,播放器高级版本 12.3 版本开始支持。
public void setPreferredAudioTrack(String audioTrackName)
参数说明
参数名 | 类型 | 描述 |
audioTrackName | String | 音轨名称。 |