API概览

本文介绍 ArTalk WebSDK 提供的相关 API 接口及其各 API 接口的用法。

登录登出流程

API	描述
createInstance	创建并返回一个 TalkClient 实例。
login	用户登录 anyrtc Talk 系统。
logout	退出登录，退出后自动断开连接和销毁回调监听。

事件回调	描述
ConnectionStateChanged	SDK 与 anyrtc Talk 系统的连接状态发生了改变时触发该回调。

对讲频道相关

API	描述
createChannel	创建并返回一个 TalkChannel 实例。
join	加入频道。加入频道成功后可发起对讲等操作、收到该频道对讲语音等通知。
leave	离开频道。不再接收频道对讲语音等。
setLevel	设置用户对讲级别。注：只当前频道有效。
getLevel	获取用户对讲级别。注：只当前频道有效。
pushToTalk	申请对讲（简称上麦)。
stopPushToTalk	取消对讲（简称下麦）。
breakTalk	打断对讲。
muteAllRemoteAudio	关闭/打开所有远程用户的音频。
setPullAudioQuality	设置音频拉流质量。
setPushAudioQuality	设置音频推流质量。

事件回调	描述
UserIsTalkOn	远端用户用户上麦回调。
UserIsTalkOff	远端用户用户下麦回调。
UserIsStreamOn	频道广播开始回调。
UserIsStreamOff	频道广播结束回调。
BreakTalk	上麦被打断。

更新 Token

API	描述
renewToken	更新当前 Token。

事件回调	描述
TokenWillExpired	Token 即将过期触发该回调。
TokenDidExpired	Token 过期时触发该回调。

日志设置与版本查询

属性	描述
logFilter	设置 SDK 的日志输出等级。
VERSION	anyrtc Talk SDK 的当前版本信息。

定制方法

API	描述
setParameters	配置 SDK 提供技术预览或特别定制功能。