TXLiveBase

详细描述

腾讯云基础功能类

---

结构体说明

TXLiveBaseDelegate-p

protocol TXLiveBaseDelegate-p

构造函数
(void)	- onLog:LogLevel:WhichModule:
(void)	- onUpdateNetworkTime:message:
(void)	- onLicenceLoaded:Reason:

函数文档

onLicenceLoaded:Reason:()

- (void) onLicenceLoaded: (int)  result Reason: (NSString *)  reason

optional

setLicenceURL 接口回调, result = 0 成功，负数失败。 @discussion 需在调用 setLicenceURL 前设置 delegate

onLog:LogLevel:WhichModule:()

- (void) onLog: (NSString *)  log LogLevel: (int)  level WhichModule: (NSString *)  module

optional

Log回调　 @discussion 1.实现TXLiveBaseDelegate，建议在一个比较早的初始化类中如AppDelegate 2.在初始化中设置此回调，eg：[TXLiveBase sharedInstance].delegate = self; 3.level类型参见TX_Enum_Type_LogLevel 4.module值暂无具体意义，目前为固定值TXLiteAVSDK

onUpdateNetworkTime:message:()

- (void) onUpdateNetworkTime: (int)  errCode message: (NSString *)  errMsg

optional

NTP 校时回调，调用 TXLiveBase updateNetworkTime 后会触发

参数

errCode

0：表示校时成功且偏差在30ms以内，1：表示校时成功但偏差可能在 30ms 以上，-1：表示校时失败

TXLiveBase

class TXLiveBase

类方法
(instancetype)	+ sharedInstance
(int)	+ setGlobalEnv:
(void)	+ setLogLevel:
(void)	+ setConsoleEnabled:
(void)	+ setAppVersion:
(void)	+ setAudioSessionDelegate:
(NSString *)	+ getSDKVersionStr
(NSString *)	+ getPituSDKVersion
(void)	+ setAppID:
(void)	+ setLicenceURL:key:
(void)	+ setUserId:
(NSString *)	+ getLicenceInfo
(void)	+ setExternalDecoderFactory:
(NSInteger)	+ updateNetworkTime
(NSInteger)	+ getNetworkTimestamp
属性
id< TXLiveBaseDelegate >	delegate

函数文档

getLicenceInfo()

+ (NSString *) getLicenceInfo

获取 Licence 信息

返回

Licence 信息

getNetworkTimestamp()

+ (NSInteger) getNetworkTimestamp

获取 NTP 时间戳（毫秒），请在收到 onUpdateNetworkTime 回调后使用

返回

NTP 时间戳（毫秒），若返回 0：未启动 NTP 校时或校时失败，请重启校时

getPituSDKVersion()

+ (NSString *) getPituSDKVersion

获取 pitu 版本信息

返回

pitu 版本信息

getSDKVersionStr()

+ (NSString *) getSDKVersionStr

获取 SDK 版本信息

返回

SDK 版本信息

setAppID:()

+ (void) setAppID:

(NSString *)

appID

设置 appID，云控使用

setAppVersion:()

+ (void) setAppVersion:

(NSString *)

verNum

setAudioSessionDelegate:()

+ (void) setAudioSessionDelegate:

(nullable id< TXLiveAudioSessionDelegate >)

delegate

setConsoleEnabled:()

+ (void) setConsoleEnabled:

(BOOL)

enabled

启用或禁用控制台日志打印

参数

enabled

指定是否启用

setExternalDecoderFactory:()

+ (void) setExternalDecoderFactory:

(id)

decoderFactory

设置 HEVC 外部解码器工厂实例

setGlobalEnv:()

+ (int) setGlobalEnv:

(const char *)

env_config

设置 liteav SDK 接入的环境。 腾讯云在全球各地区部署的环境，按照各地区政策法规要求，需要接入不同地区接入点。

参数

env_config

需要接入的环境，SDK 默认接入的环境是：默认正式环境。

返回

0：成功；其他：错误

注意

目标市场为中国大陆的客户请不要调用此接口，如果目标市场为海外用户，请通过技术支持联系我们，了解 env_config 的配置方法，以确保 App 遵守 GDPR 标准。

setLicenceURL:key:()

+ (void) setLicenceURL:		(NSString *)	url
key:		(NSString *)	key

设置 sdk 的 Licence 下载 url 和 key

setLogLevel:()

+ (void) setLogLevel:

(TX_Enum_Type_LogLevel)

level

设置 log 输出级别

参数

level

参见 LOGLEVEL

setUserId:()

+ (void) setUserId:

(NSString *)

userId

设置 userId，用于数据上报

sharedInstance()

+ (instancetype) sharedInstance

updateNetworkTime()

+ (NSInteger) updateNetworkTime

启动 NTP 校时服务

返回

0：启动成功；< 0：启动失败

属性说明

delegate

- (id<TXLiveBaseDelegate>) delegate

readwritenonatomicweak

通过这个delegate将全部log回调给SDK使用者，由SDK使用者来决定log如何处理

枚举类型说明

TX_Enum_Type_LogLevel

enum TX_Enum_Type_LogLevel : NSInteger

枚举值
LOGLEVEL_VERBOSE	输出所有级别的log
LOGLEVEL_DEBUG	输出 DEBUG，INFO，WARNING，ERROR 和 FATAL 级别的log
LOGLEVEL_INFO	输出 INFO，WARNING，ERROR 和 FATAL 级别的log
LOGLEVEL_WARN	只输出WARNING，ERROR 和 FATAL 级别的log
LOGLEVEL_ERROR	只输出ERROR 和 FATAL 级别的log
LOGLEVEL_FATAL	只输出 FATAL 级别的log
LOGLEVEL_NULL	不输出任何sdk log