Copyright (c) 2021 Tencent. All rights reserved.
Module: V2TXLivePremier @ TXLiteAVSDK
Function: V2TXLive 高级接口
V2TXLivePremier
V2TXLivePremier
函数列表 | 描述 |
获取 SDK 版本号 | |
设置 V2TXLivePremier 回调接口 | |
设置 Log 的配置信息 | |
设置 SDK 接入环境 | |
设置 SDK 的授权 License | |
设置 SDK socks5 代理配置 | |
开启/关闭对音频采集数据的监听回调（可读写） | |
开启/关闭对最终系统要播放出的音频数据的监听回调 | |
开启/关闭耳返音频数据的监听回调 | |
设置 userId | |
调用实验性 API 接口 |
V2TXLivePremierObserver
函数列表 | 描述 |
自定义 Log 输出回调接口 | |
setLicence 接口回调 | |
本地麦克风采集到的音频数据回调 | |
将各路待播放音频混合之后并在最终提交系统播放之前的数据回调 | |
耳返的音频数据 |
getSDKVersionStr
getSDKVersionStr
获取 SDK 版本号
setObserver:
setLogConfig:
setEnvironment:
setEnvironment:
+ (V2TXLiveCode)setEnvironment: | (const char *)env |
设置 SDK 接入环境
参数 | 描述 |
env | 目前支持 “default” 和 “GDPR” 两个参数。 default：默认环境，SDK 会在全球寻找最佳接入点进行接入。 GDPR：所有音视频数据和质量统计数据都不会经过中国大陆地区的服务器。 |
注意
如您的应用无特殊需求，请不要调用此接口进行设置。
setLicence:key:
setLicence:key:
+ (void)setLicence: | (NSString *)url |
key: | (NSString *)key |
设置 SDK 的授权 License
文档地址：https://cloud.tencent.com/document/product/454/34750。
参数 | 描述 |
key | licence的秘钥。 |
url | licence的地址。 |
setSocks5Proxy:port:username:password:config:
setSocks5Proxy:port:username:password:config:
+ (V2TXLiveCode)setSocks5Proxy: | (NSString *)host |
port: | (NSInteger)port |
username: | (NSString *)username |
password: | (NSString *)password |
config: |
设置 SDK socks5 代理配置
参数 | 描述 |
config | 配置使用 socks5 代理服务器的协议。 |
host | socks5 代理服务器的地址。 |
password | socks5 代理服务器的验证的密码。 |
port | socks5 代理服务器的端口。 |
username | socks5 代理服务器的验证的用户名。 |
enableAudioCaptureObserver:format:
enableAudioCaptureObserver:format:
+ (V2TXLiveCode)enableAudioCaptureObserver: | (BOOL)enable |
format: |
开启/关闭对音频采集数据的监听回调（可读写）
参数 | 描述 |
enable | 是否开启。 【默认值】：false。 |
format | 设置回调出的 AudioFrame 的格式。 |
注意
enableAudioPlayoutObserver:format:
enableAudioPlayoutObserver:format:
+ (V2TXLiveCode)enableAudioPlayoutObserver: | (BOOL)enable |
format: |
开启/关闭对最终系统要播放出的音频数据的监听回调
参数 | 描述 |
enable | 是否开启。 【默认值】：false。 |
format | 设置回调出的 AudioFrame 的格式。 |
enableVoiceEarMonitorObserver:
enableVoiceEarMonitorObserver:
+ (V2TXLiveCode)enableVoiceEarMonitorObserver: | (BOOL)enable |
开启/关闭耳返音频数据的监听回调
参数 | 描述 |
enable | 是否开启。 【默认值】：false。 |
setUserId:
setUserId:
+ (void)setUserId: | (NSString *)userId |
设置 userId
参数 | 描述 |
userId | 业务侧自身维护的用户/设备id。 |
callExperimentalAPI:
callExperimentalAPI:
+ (V2TXLiveCode)callExperimentalAPI: | (NSString *)jsonStr |
调用实验性 API 接口
参数 | 描述 |
jsonStr | 接口及参数描述的 JSON 字符串。 |
注意
该接口用于调用一些实验性功能。
返回值说明：
V2TXLIVE_OK: 成功。
V2TXLIVE_ERROR_INVALID_PARAMETER: 操作失败，参数非法。
onLog:log:
onLicenceLoaded:Reason:
onLicenceLoaded:Reason:
- (void)onLicenceLoaded: | (int)result |
Reason: | (NSString *)reason |
setLicence 接口回调
参数 | 描述 |
reason | 设置 licence 失败原因。 |
result | 设置 licence 结果 0 成功，负数失败。 |
onCaptureAudioFrame:
onCaptureAudioFrame:
- (void) onCaptureAudioFrame: |
本地麦克风采集到的音频数据回调
参数 | 描述 |
frame | 音频数据。 |
注意
请不要在此回调函数中做任何耗时操作，建议直接拷贝到另一线程进行处理，否则会导致各种声音问题。
此接口回调出的音频数据支持修改。
此接口回调出的音频时间帧长固定为0.02s。
由时间帧长转化为字节帧长的公式为【采样率 × 时间帧长 × 声道数 × 采样点位宽】。
以SDK默认的音频录制格式48000采样率、单声道、16采样点位宽为例，字节帧长为【48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节】。
此接口回调出的音频数据不包含背景音、音效、混响等前处理效果，延迟极低。
需要您调用 enableAudioCaptureObserver 开启回调开关。
onPlayoutAudioFrame:
onPlayoutAudioFrame:
- (void) onPlayoutAudioFrame: |
将各路待播放音频混合之后并在最终提交系统播放之前的数据回调
当您设置完音频数据自定义回调之后，SDK 内部会把各路待播放的音频混合之后的音频数据，在提交系统播放之前，以 PCM 格式的形式通过本接口回调给您。
此接口回调出的音频时间帧长固定为 0.02s，格式为 PCM 格式。
由时间帧长转化为字节帧长的公式为
采样率 × 时间帧长 × 声道数 × 采样点位宽 。 以 SDK 默认的音频录制格式 48000 采样率、单声道、16 采样点位宽为例，字节帧长为
48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 。参数 | 描述 |
frame | PCM 格式的音频数据帧。 |
注意
1. 请不要在此回调函数中做任何耗时操作，由于 SDK 每隔 20ms 就要处理一帧音频数据，如果您的处理时间超过 20ms，就会导致声音异常。
2. 此接口回调出的音频数据是可读写的，也就是说您可以在回调函数中同步修改音频数据，但请保证处理耗时。
3. 此接口回调出的是对各路待播放音频数据的混合，但其中并不包含耳返的音频数据。
onVoiceEarMonitorAudioFrame:
onVoiceEarMonitorAudioFrame:
- (void) onVoiceEarMonitorAudioFrame: |
耳返的音频数据
当您设置完音频数据自定义回调之后，SDK 内部会把耳返的音频数据在播放之前以 PCM 格式的形式通过本接口回调给您。
此接口回调出的音频时间帧长不固定，格式为 PCM 格式。
由时间帧长转化为字节帧长的公式为
采样率 × 时间帧长 × 声道数 × 采样点位宽 。 以 TRTC 默认的音频录制格式 48000 采样率、单声道、16采样点位宽为例，0.02s 的音频数据字节帧长为
48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 。参数 | 描述 |
frame | PCM 格式的音频数据帧。 |
注意
1. 请不要在此回调函数中做任何耗时操作，否则会导致声音异常。
2. 此接口回调出的音频数据是可读写的，也就是说您可以在回调函数中同步修改音频数据，但请保证处理耗时。