API概览

最近更新时间:2023-02-21 10:39:53

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

登录登出流程

API描述
createInstance创建并返回一个 TalkClient 实例。
login用户登录 anyrtc Talk 系统。
logout退出登录,退出后自动断开连接和销毁回调监听。
事件回调描述
ConnectionStateChangedSDK 与 anyrtc Talk 系统的连接状态发生了改变时触发该回调。

对讲频道相关

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

更新 Token

API描述
renewToken更新当前 Token。
事件回调描述
TokenWillExpiredToken 即将过期触发该回调。
TokenDidExpiredToken 过期时触发该回调。

日志设置与版本查询

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

定制方法

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