API Overview

anyRTC 云平台实时对讲 SDK 提供了稳定可靠、低延时、高并发的全球语音对讲云服务，帮助你快速构建实时对讲场景。

如无特别说明，本页列出的大多数对讲核心业务方法都应在调用 loginByToken 方法成功收到 ARTalkLoginErrorCode 错误码后调用。

anyRTC 对讲 SDK 提供以下功能：

• 登录登出
• 音频管理
• 加入离开频道相关
• 对讲等级
• 上麦下麦管理
• 更新token
• 日志设置与版本查询
• 定制方法

登录登出相关

SDK 与对讲服务器的连接状态是开发过程需要理解的核心概念。

方法	描述
initWithAppId	创建并初始化一个 ARTalkKit 实例。
loginByToken	登录 anyRTC 云平台对讲系统。 方法调用结果由 ARTalkLoginBlock 返回。 错误码详见 ARTalkLoginErrorCode 。
logoutWithCompletion	登出 anyRTC 云平台对讲系统。 方法调用结果由 ARTalkLogoutBlock 返回。 错误码详见 ARTalkLogoutErrorCode。
destroy	释放当前 ARTalkKit 实例使用的所有资源。

事件	描述
connectionStateChanged	SDK 与 anyRTC 云平台 对讲系统连接状态发生改变回调。

音频管理

方法	描述
setDefaultPushAudioQuality	设置默认推流音频质量。
setDefaultPullAudioQuality	设置默认拉流音频质量。
enableAudioCapture	开关音频采集模块。
enableLocalAudioRecord	开关音频录制模块。
enableLocalMicDataCallback	开关本地录音音频数据回调。
enableLocalSpeakerDataCallback	开关指定频道远程对讲音频数据回调。

事件	描述
localMicAudioData	调用 enableLocalMicDataCallback 方法后，本地录音音频数据回调。
localSpeakerAudioData	调用 enableLocalSpeakerDataCallback 方法后，本地播放其他人音频数据回调。
recordFile	调用enableLocalAudioRecord 方法后，下麦后的录制回调。

加入离开频道相关

方法	描述
createChannelWithId	创建一个 ARTalkChannel 对象。
joinWithCompletion	加入频道。
leaveWithCompletion	离开频道。
releaseChannelWithId	释放当前 ARTalkChannel 频道实例的所有资源。

对讲等级

方法	描述
setLevel	设置对讲等级。
getLevel	获取等级。

上麦下麦管理

方法	描述
setPushAudioQuality	设置推流音频质量。
setPullAudioQuality	设置拉流音频质量。
pushToTalk	上麦。
stopPushToTalk	下麦。
muteAllRemoteAudio	静音。
breakTalk	强拆。
enableAudioStream	是否打开广播

事件	描述
pushToTalkResult	开始对讲回调。
pushToTalkEnded	结束对讲回调。
userIsTalkOn	其他用户开始对讲回调。
userIsTalkOff	其他用户结束对讲回调。
userStreamOn	广播通道打开回调。
userStreamOff	广播通道关闭回调。

更新 token

方法	描述
renewToken	更新当前的对讲 Token。

事件	描述
talkKitTokenPrivilegeWillExpire	在使用 对讲过程中如果 Token 即将失效，SDK 会提前 30 秒触发该回调，提醒 app 更新 Token。
talkKitTokenDidExpire	（SDK 断线重连时触发）当前使用的 RTK Token 已超过 24 小时的签发有效期。

日志设置与版本查询

方法	描述
setLogFile	设定日志文件的默认地址。
setLogFilters	设置日志输出等级。
setLogFileSize	设置日志文件大小。
getSDKVersion	获取 anyRTC RTK SDK 的版本信息。

定制方法

方法	描述
setParameters	通过 JSON 配置 SDK 提供技术预览或特别定制功能。