LiteAVSDK
腾讯云音视频 SDK ，服务于数万家企业客户的高可用组件，致力于最大限度地节省您的研发成本。
TXLivePlayConfig

详细描述

腾讯云直播播放器的参数配置模块

结构体说明

◆ com::tencent::rtmp::TXLivePlayConfig

class com::tencent::rtmp::TXLivePlayConfig

常用设置项

void setAutoAdjustCacheTime (boolean bAuto)
 
void setCacheTime (float time)
 
void setMaxAutoAdjustCacheTime (float time)
 
void setMinAutoAdjustCacheTime (float time)
 
void setVideoBlockThreshold (int threshold)
 
void setConnectRetryCount (int count)
 
void setConnectRetryInterval (int interval)
 

专业设置项

void setEnableMessage (boolean enable)
 
void enableAEC (boolean enable)
 
void setEnableMetaData (boolean enable)
 
void setFlvSessionKey (String flvSessionKey)
 

待废弃设置项

void setEnableNearestIP (boolean enable)
 
void setRtmpChannelType (int type)
 
void setCacheFolderPath (String folderPath)
 
void setMaxCacheItems (int maxCacheItems)
 
void setHeaders (Map< String, String > headers)
 
String toString ()
 

成员函数说明

◆ enableAEC()

void enableAEC ( boolean  enable)
inline

设置回声消除

接口说明：

  • 默认值为：false。
  • 连麦时必须开启，非连麦时不要开启
参数
enabletrue：开启； false：关闭

◆ setAutoAdjustCacheTime()

void setAutoAdjustCacheTime ( boolean  bAuto)
inline

设置是否自动调整缓存时间

接口说明：

参数
bAutotrue：启用； false：关闭

◆ setCacheFolderPath()

void setCacheFolderPath ( String  folderPath)
inline

设置点播缓存目录

待废弃，如果您需要使用点播播放器，推荐您使用：TXVodPlayer

参数
folderPath缓存目录

◆ setCacheTime()

void setCacheTime ( float  time)
inline

设置播放器缓存时间

接口说明：

  • 设置播放器缓存时间，单位为秒；默认值为5秒。
  • 不建议设置过大，会影响秒开以及直播流播放的实时性。
参数
time播放器缓存时长

◆ setConnectRetryCount()

void setConnectRetryCount ( int  count)
inline

设置播放器重连次数

接口说明：

  • 默认值：3；取值范围：1 - 10。
  • 当 SDK 与服务器异常断开连接时， SDK 会尝试与服务器重连；您可通过此接口设置重连次数。
参数
countSDK 重连次数

◆ setConnectRetryInterval()

void setConnectRetryInterval ( int  interval)
inline

设置播放器重连间隔。

接口说明：

  • 默认值：3，单位为秒；取值范围：3 - 30。
  • 当 SDK 与服务器异常断开连接时， SDK 会尝试与服务器重连；您可通过此接口设置连续两次重连的时间间隔。
参数
intervalSDK 重连间隔

◆ setEnableMessage()

void setEnableMessage ( boolean  enable)
inline

开启消息通道

此接口在视频帧与消息需要高同步的情况使用，如：直播答题场景。

接口说明：

参数
enabletrue：开启；false：关闭

◆ setEnableMetaData()

void setEnableMetaData ( boolean  enable)
inline

开启 MetaData 数据回调

标准直播流都会在最开始的阶段有一个 MetaData 数据头，该数据头支持定制。 您可以通过 TXLivePushConfig 中的 setMetaData 接口设置一些自定义数据，再通过 ITXLivePlayListener 中的 onPlayEvent(TXLiteAVCode.EVT_PLAY_GET_METADATA) 消息接收到这些数据。

注意
每条音视频流中只能设置一个 MetaData 数据头，除非断网重连，否则 TXLivePlayer 的 TXLiteAVCode.EVT_PLAY_GET_METADATA 消息也只会收到一次。
参数
enabletrue: SDK 通过 TXLiteAVCode.EVT_PLAY_GET_METADATA 消息抛出视频流的 MetaData 数据 false: SDK 不抛出视频流的 MetaData 数据

◆ setEnableNearestIP()

void setEnableNearestIP ( boolean  enable)
inline

设置就近选路

待废弃，默认值：true。

只对加速拉流生效，用于指定加速拉流是否开启就近选路。

参数
enabletrue：开启；false：关闭

◆ setFlvSessionKey()

void setFlvSessionKey ( String  flvSessionKey)
inline

开启 flvSessionKey 数据回调

flv直播流的http响应头里可以返回一些自定义的头信息，比如流的sessionId等。 您可以通过 TXLivePlayConfig 中的 setFlvSessionKey 接口设置需要获取响应头信息的key，再通过 ITXLivePlayListener 中的 onPlayEvent(TXLiteAVCode.PLAY_EVT_GET_FLVSESSIONKEY) 事件接收到响应头对应字段的数据。

注意
每条音视频流中只能解析一个 flvSessionKey ，除非断网重连，否则 TXLivePlayer 的 TXLiteAVCode.PLAY_EVT_GET_FLVSESSIONKEY 事件只会收到一次。
参数
flvSessionKey: SDK 从 FLV Http 响应头中解析此 flvSessionKey 对应的值，通过 TXLiteAVCode.PLAY_EVT_GET_FLVSESSIONKEY 事件回调抛出。 "" : SDK 不解析数据，也不回调 TXLiteAVCode.PLAY_EVT_GET_FLVSESSIONKEY 事件。

◆ setHeaders()

void setHeaders ( Map< String, String >  headers)
inline

设置自定义 HTTP Headers

待废弃，用于点播视频下载；如果您需要使用点播播放器，推荐您使用：TXVodPlayer

参数
headersHTTP 头

◆ setMaxAutoAdjustCacheTime()

void setMaxAutoAdjustCacheTime ( float  time)
inline

设置最大的缓存时间

接口说明：

  • 默认值：5，单位为秒。
  • 仅在启用自动调用缓存时间接口时，有效。
参数
time播放器最大缓存时间

◆ setMaxCacheItems()

void setMaxCacheItems ( int  maxCacheItems)
inline

设置点播缓存文件个数

待废弃，如果您需要使用点播播放器，推荐您使用：TXVodPlayer

参数
maxCacheItems缓存个数

◆ setMinAutoAdjustCacheTime()

void setMinAutoAdjustCacheTime ( float  time)
inline

设置最小的缓存时间

接口说明：

  • 默认值：1，单位为秒。
  • 仅在启用自动调用缓存时间接口时，有效。
参数
time播放器最小缓存时间

◆ setRtmpChannelType()

void setRtmpChannelType ( int  type)
inline

设置 RTMP 传输通道的类型

待废弃，默认值：TXLiveConstants#RTMP_CHANNEL_TYPE_AUTO

通道类型说明：

参数
type通道类型

◆ setVideoBlockThreshold()

void setVideoBlockThreshold ( int  threshold)
inline

设置播放器视频卡顿报警阈值

接口说明：

参数
threshold播放器视频卡顿报警阈值

◆ toString()

String toString ( )
inline

结构体成员变量说明

◆ mHeaders

Map<String, String> mHeaders
protected