详细描述

腾讯云点播播放器的参数配置模块主要负责 TXVodPlayer 对应的参数设置，其中绝大多数设置项在播放开始之后再设置是无效的。

结构体说明

◆ com::tencent::rtmp::TXVodPlayConfig

class com::tencent::rtmp::TXVodPlayConfig

Public 成员函数
void	setConnectRetryCount (int count)

int	getConnectRetryCount ()

void	setConnectRetryInterval (int interval)

int	getConnectRetryInterval ()

void	setTimeout (int timeout)

int	getTimeout ()

void	setCacheFolderPath (String folderPath)

String	getCacheFolderPath ()

void	setMaxCacheItems (int maxCacheItems)

int	getMaxCacheItems ()

void	setPlayerType (int playerType)

int	getPlayerType ()

void	setHeaders (Map< String, String > headers)

Map< String, String >	getHeaders ()

void	setEnableAccurateSeek (boolean accurateSeek)

boolean	isEnableAccurateSeek ()

void	setAutoRotate (boolean autoRotate)

boolean	isAutoRotate ()

void	setSmoothSwitchBitrate (boolean smoothSwitchBitrate)

boolean	isSmoothSwitchBitrate ()

void	setCacheMp4ExtName (String cacheMp4ExtName)

String	getCacheMp4ExtName ()

void	setProgressInterval (int intervalMs)

int	getProgressInterval ()

void	setMaxBufferSize (int maxBufferSize)

int	getMaxBufferSize ()

void	setMaxPreloadSize (int maxPreloadSize)

int	getMaxPreloadSize ()

void	setFirstStartPlayBufferTime (int milliseconds)

void	setNextStartPlayBufferTime (int milliseconds)

void	setOverlayKey (String overlayKey)

String	getOverlayKey ()

void	setOverlayIv (String overlayIv)

String	getOverlayIv ()

void	setEnableRenderProcess (boolean enableRenderProcess)

boolean	isEnableRenderProcess ()

void	setPreferredResolution (long preferredResolution)

long	getPreferredResolution ()

void	setMediaType (int mediaType)

int	getMediaType ()

void	setExtInfo (Map< String, Object > map)

Map< String, Object >	getExtInfoMap ()

成员函数说明

◆ getCacheFolderPath()

String getCacheFolderPath ( )

inline

获取点播缓存目录

弃用:: 此接口已经废弃，不推荐使用

返回

◆ getCacheMp4ExtName()

String getCacheMp4ExtName ( )

inline

获取缓存mp4文件扩展名

返回: 缓存mp4文件扩展名

◆ getConnectRetryCount()

int getConnectRetryCount ( )

inline

获取播放器重连次数

返回: 播放器重连次数

◆ getConnectRetryInterval()

int getConnectRetryInterval ( )

inline

获取播放器重连间隔

返回: 播放器重连间隔

◆ getExtInfoMap()

Map<String, Object> getExtInfoMap ( )

inline

获取播放器拓展配置信息

返回: 播放器拓展配置信息

◆ getHeaders()

Map<String, String> getHeaders ( )

inline

获取自定义http headers

返回: 自定义http headers

◆ getMaxBufferSize()

int getMaxBufferSize ( )

inline

获取最大播放缓冲大小

返回: 最大播放缓冲大小

◆ getMaxCacheItems()

int getMaxCacheItems ( )

inline

获取缓存文件个数

弃用:: 此接口已经废弃，不推荐使用

返回

◆ getMaxPreloadSize()

int getMaxPreloadSize ( )

inline

获取预加载最大缓冲大小

返回: 预加载最大缓冲大小

◆ getMediaType()

int getMediaType ( )

inline

获取媒资类型

返回: 媒资类型

◆ getOverlayIv()

String getOverlayIv ( )

inline

获取HLS安全加固加解密Iv

返回: HLS安全加固加解密Iv

◆ getOverlayKey()

String getOverlayKey ( )

inline

获取HLS安全加固加解密key

返回: HLS安全加固加解密key

◆ getPlayerType()

int getPlayerType ( )

inline

获取播放器类型

弃用:: 此接口已经废弃，不推荐使用

返回

◆ getPreferredResolution()

long getPreferredResolution ( )

inline

获取启播时优先播放的分辨率

返回

◆ getProgressInterval()

int getProgressInterval ( )

inline

获取进度回调间隔

返回: 进度回调间隔

◆ getTimeout()

int getTimeout ( )

inline

获取播放器连接超时时间

返回: 播放器连接超时时间

◆ isAutoRotate()

boolean isAutoRotate ( )

inline

旋转角度是否自动旋转

返回

◆ isEnableAccurateSeek()

boolean isEnableAccurateSeek ( )

inline

获取是否精确seek

返回: true：已开启精准seek， false：没有开启精确seek

◆ isEnableRenderProcess()

boolean isEnableRenderProcess ( )

inline

是否允许加载后渲染后处理服务

返回

◆ isSmoothSwitchBitrate()

boolean isSmoothSwitchBitrate ( )

inline

是否平滑切换多码率HLS

返回

◆ setAutoRotate()

void setAutoRotate ( boolean autoRotate )

inline

播放mp4文件时，若设为YES则根据文件中的旋转角度自动旋转。旋转角度可在PLAY_EVT_CHANGE_ROTATION事件中获得。默认YES

参数

autoRotate

◆ setCacheFolderPath()

void setCacheFolderPath ( String folderPath )

inline

设置点播缓存目录。点播MP4、HLS有效

弃用:: 【重要】接口废弃，请使用TXPlayerGlobalSetting#setCacheFolderPath做全局配置，若已设全局配置，全局配置优先。

参数

folderPath 缓存路径

◆ setCacheMp4ExtName()

void setCacheMp4ExtName ( String cacheMp4ExtName )

inline

缓存mp4文件扩展名

参数

cacheMp4ExtName 默认 "mp4"

◆ setConnectRetryCount()

void setConnectRetryCount ( int count )

inline

设置播放器重连次数.

当SDK与服务器异常断开连接时,SDK会尝试与服务器重连.通过此函数设置SDK重连次数.

参数

count SDK重连次数,最小值为 1, 最大值为 10, 默认值为 3.

◆ setConnectRetryInterval()

void setConnectRetryInterval ( int interval )

inline

设置播放器重连间隔.

当SDK与服务器异常断开连接时,SDK会尝试与服务器重连.通过此函数来设置两次重连间隔时间.

参数

interval SDK重连间隔,单位秒,最小值为 3, 最大值为 30, 默认值为 3.

◆ setEnableAccurateSeek()

void setEnableAccurateSeek ( boolean accurateSeek )

inline

设置是否精确seek，默认true

开启精确后seek，seek的时间平均多出200ms

参数

accurateSeek

◆ setEnableRenderProcess()

void setEnableRenderProcess ( boolean enableRenderProcess )

inline

是否允许加载后渲染后处理服务默认开启，开启后超分插件如果存在，默认加载

参数

enableRenderProcess

◆ setExtInfo()

void setExtInfo ( Map< String, Object > map )

inline

设置播放器拓展配置信息

参数

map 播放器拓展配置信息

◆ setFirstStartPlayBufferTime()

void setFirstStartPlayBufferTime ( int milliseconds )

inline

首缓需要加载的数据时长，单位ms，默认值为100ms

弃用:: 【重要】接口废弃，请使用this#setMaxBufferSize或this#setMaxPreloadSize设置缓冲大小

◆ setHeaders()

void setHeaders ( Map< String, String > headers )

inline

设置自定义http headers

参数

headers 自定义http headers

◆ setMaxBufferSize()

void setMaxBufferSize ( int maxBufferSize )

inline

最大播放缓冲大小，单位 MB

此设置会影响playableDuration，设置越大，提前缓存的越多

参数

maxBufferSize 播放缓冲大小

◆ setMaxCacheItems()

void setMaxCacheItems ( int maxCacheItems )

inline

设置缓存文件个数。

弃用:: 【重要】接口废弃，请使用TXPlayerGlobalSetting#setMaxCacheSize做全局配置，若已设全局配置，全局配置优先。

参数

maxCacheItems 最大缓存条目。一个条目等于100MB。

◆ setMaxPreloadSize()

void setMaxPreloadSize ( int maxPreloadSize )

inline

设置预加载最大缓冲大小，单位：MB

参数

maxPreloadSize 预加载大小

◆ setMediaType()

void setMediaType ( int mediaType )

inline

设置媒资类型, 默认为auto类型. 【重要】若自适应码率播放,暂须指定具体类型.如自适应播放hls直播资源,须传入MEDIA_TYPE_HLS_LIVE类型.

参数

mediaType 媒资类型，参数值具体参考TXVodConstants#MEDIA_TYPE_HLS_VOD

◆ setNextStartPlayBufferTime()

void setNextStartPlayBufferTime ( int milliseconds )

inline

缓冲时（缓冲数据不够引起的二次缓冲，或者seek引起的拖动缓冲）最少要缓存多长的数据才能结束缓冲，单位ms，默认值为250ms

弃用:: 此接口已经废弃，不推荐使用【重要】接口废弃，请使用this#setMaxBufferSize或this#setMaxPreloadSize设置缓冲大小

◆ setOverlayIv()

void setOverlayIv ( String overlayIv )

inline

设置HLS安全加固加解密Iv

参数

overlayIv

◆ setOverlayKey()

void setOverlayKey ( String overlayKey )

inline

设置HLS安全加固加解密key

参数

overlayKey

◆ setPlayerType()

void setPlayerType ( int playerType )

inline

设置播放器类型

弃用:: 此接口已经废弃，不推荐使用

参数

playerType

◆ setPreferredResolution()

void setPreferredResolution ( long preferredResolution )

inline

播放HLS有多条码流时，根据设定的preferredResolution选最优的码流进行起播 preferredResolution是宽高的乘积（width * height）启播前设置才有效

参数

preferredResolution

◆ setProgressInterval()

void setProgressInterval ( int intervalMs )

inline

设置进度回调间隔

若不设置，SDK默认间隔0.5秒回调一次

参数

intervalMs 间隔时间，单位毫秒

◆ setSmoothSwitchBitrate()

void setSmoothSwitchBitrate ( boolean smoothSwitchBitrate )

inline

平滑切换多码率HLS，默认false

参数

smoothSwitchBitrate 设为false时，可提高多码率地址打开速度; 设为true，在IDR对齐时可平滑切换码率

◆ setTimeout()

void setTimeout ( int timeout )

inline

设置播放器连接超时时间.

参数

timeout SD连接超时时间,单位秒, 默认值为 10.

详细描述

结构体说明

◆ com::tencent::rtmp::TXVodPlayConfig

Public 成员函数

成员函数说明

◆ getCacheFolderPath()

◆ getCacheMp4ExtName()

◆ getConnectRetryCount()

◆ getConnectRetryInterval()

◆ getExtInfoMap()

◆ getHeaders()

◆ getMaxBufferSize()

◆ getMaxCacheItems()

◆ getMaxPreloadSize()

◆ getMediaType()

◆ getOverlayIv()

◆ getOverlayKey()

◆ getPlayerType()

◆ getPreferredResolution()

◆ getProgressInterval()

◆ getTimeout()

◆ isAutoRotate()

◆ isEnableAccurateSeek()

◆ isEnableRenderProcess()

◆ isSmoothSwitchBitrate()

◆ setAutoRotate()

◆ setCacheFolderPath()

◆ setCacheMp4ExtName()

◆ setConnectRetryCount()

◆ setConnectRetryInterval()

◆ setEnableAccurateSeek()

◆ setEnableRenderProcess()

◆ setExtInfo()

◆ setFirstStartPlayBufferTime()

◆ setHeaders()

◆ setMaxBufferSize()

◆ setMaxCacheItems()

◆ setMaxPreloadSize()

◆ setMediaType()

◆ setNextStartPlayBufferTime()

◆ setOverlayIv()

◆ setOverlayKey()

◆ setPlayerType()

◆ setPreferredResolution()

◆ setProgressInterval()

◆ setSmoothSwitchBitrate()

◆ setTimeout()