QttAudio iOS API 参考文档 编辑文档

QttAudio依靠全球部署的服务器提供基于网络的语音通话功能，提供可以灵活搭配的 API 组合，为移动端到移动端提供质量可靠的实时音频通信。

核心方法

方法 描述
GetEngineInstance 获取QttChannelEngine单例对象。
Destroy 释放QttChannelEngine实例
changeRole 改变角色，改变的结果在回调通知
muteLocalAudio 取消或恢复发布本地音频流
muteRemoteAudio 取消或恢复订阅指定远端用户的音频流
join 进入频道，进入成功还是失败的结果在回调通知
leave 退出频道

核心事件

事件 描述
onJoinSuccess 自己进入频道成功回调
onReJoinSuccess 自己重新加入频道成功回调
onJoinFail 自己进入频道失败回调
onLeave 自己退出频道回调
onOtherJoin 别人进入频道回调
onOtherLeave 别人退出频道回调
onRoleStatusChanged 用户角色切换回调
onConnectionBreak 网络打断回调
onConnectionLost 网络失去连接回调

音频管理

方法 描述
setAudioConfig 设置音频编码配置
muteLocalAudio 取消或恢复发布本地音频流
muteRemoteAudio 取消或恢复订阅指定远端用户的音频流
muteAllRemoteAudio 静音频道所有成员
setDefaultMuteAllRemoteAudio 设置是否默认接收远端用户音频流
adjustRecordingVolume 调节mic采集音量
adjustPlaybackVolume 调节总的播放音量
adjustUserPlaybackVolume 调节频道内用户说话的音量

视频管理

方法 描述
enableVideo 启用视频模块
disableVideo 关闭视频模块
setVideoEncoderConfiguration 设置视频编码配置
setupLocalVideo 初始化本地视图
setupRemoteVideo 初始化远端用户视图
setLocalRenderMode 更新本地视图显示模式
setRemoteRenderMode 更新远端视图显示模式
startPreview 开启视频预览
stopPreview 停止视频预览
enableLocalVideo 开关本地视频采集
muteLocalVideoStream 停止/恢复发送本地视频流
muteRemoteVideoStream 停止/恢复接收指定视频流
muteAllRemoteVideoStreams 停止/恢复接收所有视频流
事件 描述
onUserMuteVideo 远端用户停止/恢复发送视频流回调
onUserEnableLocalVideo 远端用户开/关本地视频采集回调
onUserEnableVideo 远端用户开/关视频模块回调

视频前处理及后处理

方法 描述
setBeautyEffectOptions 设置美颜效果选项

音乐文件播放管理

方法 描述
startSoundMixing 播放音乐文件
stopSoundMixing 停止播放音乐文件
pauseSoundMixing 暂停播放音乐文件
resumeSoundMixing 恢复播放音乐文件
getSoundMixingDuration 获取音乐文件总时长
getSoundMixingCurrentPosition 获取音乐文件的播放进度
setSoundMixingPosition 设置音乐文件的播放位置
setSoundMixingPitch 调整播放的音乐文件的音调
adjustSoundMixingVolume 调节音乐文件播放音量
adjustSoundMixingPublishVolume 调节音乐文件远端播放音量
adjustSoundMixingPlayoutVolume 调节音乐文件本地播放音量
getSoundMixingPlayoutVolume 获取音乐文件的本地播放音量
getSoundMixingPublishVolume 获取音乐文件的远端播放音量
事件 描述
onSoundStateChanged 音乐文件播放状态发生改变回调

音效文件播放管理

方法 描述
playEffect 开始播放音效文件
stopEffect 停止播放音效文件
stopAllEffects 停止播放所有音效文件
pauseEffect 暂停播放音效文件
pauseAllEffects 暂停播放所有音效文件
resumeEffect 恢复播放音效文件
resumeAllEffects 恢复播放所有音效文件
setEffectsVolume 设置音效文件的播放音量
setVolumeOfEffect 设置指定音效文件的音量
getEffectsVolume 获取播放音效文件音量
事件 描述
onEffectFinished 音效文件播放完毕回调

音量提示

方法 描述
setVolumeDetection 开启（关闭）音量检测
事件 描述
onTalkingVolumeIndication 音量提示回调

语音播放路由

方法 描述
setSpeakerOn 开启（关闭）扬声器
isSpeakerOn 获得扬声器启用状态
事件 描述
onAudioRouteChanged 语音路由变更回调

耳返控制

方法 描述
enableInEarMonitoring 开启/关闭耳返
setInEarMonitoringVolume 设置耳返音量

音频源数据

方法 描述
setRecordDataObserver 设置原始音频采集数据监听器
setPlaybackDataObserver 设置原始音频播放数据监听器

自定义音频采集和播放

方法 描述
setExternalRecorder 开启或关闭外部音频采集
pushExternalRecordFrame 推送外部音频数据
setExternalPlayer 开启或关闭外部音频渲染
事件 描述
onData 数据回调

自定义视频采集和渲染

方法 描述
registerVideoFrameObserver 设置自定义视频采集
事件 描述
onCaptureVideoFrame 获取本地采集的视频数据
onRenderVideoFrame 获取接收到的远端视频数据

视频自定义采集

方法 描述
setExternalVideoSource 配置外部视频源
pushExternalVideoFrame 推送外部视频帧

音频录制

方法 描述
startRecord 频道内录音
stopRecord 停止录音

摄像头控制

方法 描述
setCameraCapturerConfiguration 设置摄像头采集配置
switchCamera 切换前置/后置摄像头
isCameraZoomSupported 检测设备是否支持摄像头缩放功能
isCameraTorchSupported 检查设备是否支持打开闪光灯
isCameraFocusPositionInPreviewSupported 检测设备是否支持手动对焦功能
isCameraExposurePositionSupported 检测设备是否支持手动曝光功能
isCameraAutoFocusFaceModeSupported 检测设备是否支持人脸对焦功能
setCameraZoomFactor 检测设备是否支持手动对焦功能
setCameraFocusPositionInPreview 设置手动对焦位置，并触发对焦
setCameraExposurePosition 设置手动曝光位置
setCameraTorchOn 设置是否打开闪光灯
setCameraAutoFocusFaceModeEnabled 设置是否开启人脸对焦功能

数据统计事件

事件 描述
onNetworkStats 当前通话网络统计回调

其他方法

方法 描述
SetLogFile 设置日志文件
SetLogLevel 设置日志输出等级
GetError 如果GetEngineInstance返回null，调用该接口获取出错信息
GetSdkVersion 获取SDK版本号

其他事件

事件 描述
onError 运行过程中的错误信息回调
onWarning 运行过程中的警告信息回调
野狗新手？
立即注册，为你提供安全可靠的实时通信云服务。
免费注册
没找到需要的文档？
你可以提交工单反馈 或 阅读常见问题
客服工单常见问题