API

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

如无特别说明，本页列出的大多数 RTK 核心业务方法都应在调用 login 方法成功收到 onLoginSuccess 回到 后调用。

anyRTC RTK SDK 提供以下功能：

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

登录登出相关

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

方法	描述
createRtkService	创建并返回一个 IRtkService 实例。
initialize	初始化 IRtkService 实例。
login	登录 anyRTC RTK 系统。
logout	登出 anyRTC RTK 系统。
release	释放当前 IRtkService 实例使用的所有资源。

事件	描述
onLoginSuccess	登录 anyRTC RTK 系统成功回调。
onLoginFailure	登录 anyRTC RTK 系统失败回调。
onLogout	登出 anyRTC RTK 系统回调。
onConnectionStateChanged	SDK 与 anyRTC RTK 系统连接状态发生改变回调。

音频管理

方法	描述
setAudioEncodeParameter	设置音频编码属性。
setDefaultPushAudioQuality	设置默认推流音频质量。
setDefaultPullAudioQuality	设置默认拉流音频质量。
enableAudioCapture	开关音频采集模块。
enableLocalAudioRecord	开关音频录制模块。
enableLocalMicDataCallback	开关本地录音音频数据回调。
enableLocalSpeakerDataCallback	开关远程音频数据回调。
enableAiDenoise	开关 AI 降噪。
enableAudio3A	开关音频 3A 功能。

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

加入离开频道相关

方法	描述
createChannel	创建一个 IChannel 对象。
join	加入频道。
leave	离开频道。
release	释放当前 IChannel 频道实例的所有资源。

事件	描述
onJoinSuccess	成功加入频道回调。
onJoinFailure	加入频道失败回调。
onLeave	报告 leave 方法的调用结果。

对讲等级

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

上麦下麦管理

方法	描述
setPushAudioQuality	设置推流音频质量。
setPullAudioQuality	设置拉流音频质量。
pushToTalk	上麦。
stopPushToTalk	下麦。
muteAllRemoteAudio	静音。
breakTalk	强拆。

事件	描述
onPushToTalkResult	上麦结果回调。
onPushToTalkEnded	下麦结果回调。
onUserIsTalkOn	上麦人员回调。
onUserIsTalkOff	下麦人员回调。
onUserStreamOn	广播通道打开回调。
onUserStreamOff	广播通道关闭回调。

更新token

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

事件	描述
onTokenWillExpired	在使用 RTK 过程中如果 Token 即将失效，SDK 会提前 30 秒触发该回调，提醒 app 更新 Token。
onTokenExpired	（SDK 断线重连时触发）当前使用的 RTK Token 已超过 24 小时的签发有效期。
onRenewTokenResult	报告 renewToken 方法的调用结果。

日志设置与版本查询

• 日志相关操作在调用 createRtkService 方法创建并初始化 IRtkService 实例后即可进行，无需等到调用 login 方法成功。
• 版本查询操作为静态方法，可在创建并初始化 IRtkService 实例前进行。

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

定制方法

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