本页主要介绍频道相关的回调事件。所有回调都是在 TalkChannel
实例上进行监听。
示例
import ArTalk from "ar-talk-sdk";
/**
* 创建 Talk 客户端实例
* @params appId: 项目的 App ID。必须是 ASCII 编码,长度为 32 个字符。(类型:string)
*/
const client = ArTalk.createInstance(appId, { enableLogUpload: false });
/**
* 创建一个 talkClient 实例
* @params channelId: 频道名称。(类型:string)
*/
const talkChannel = client.createChannel(channelId);
// 上麦被打断
talkChannel.on("BreakTalk", () => {
console.log("上麦被打断");
});
// 监听频道用户上麦
talkChannel.on("UserIsTalkOn", (channelId: string, userId: string, userData: {}, userLevel: number) => {
console.log("UserIsTalkOn", channelId, userId, userData, userLevel);
});
频道回调事件
BreakTalk
BreakTalk: () => void;
上麦被打断。
UserIsTalkOn
UserIsTalkOn: (channelId: string, userId: string, userData: {}, userLevel: number) => void;
用户上麦。
回调参数
参数 | 类型 | 描述 |
---|---|---|
channelId | string | 频道 ID。 |
userId | string | 上麦的用户 ID。 |
userData | object | 用户的自定义属性。 |
userLevel | number | 用户在频道中的对讲等级。 |
UserIsTalkOff
UserIsTalkOff: (channelId: string, userId: string, userData: {}) => void;
用户下麦。
回调参数
参数 | 类型 | 描述 |
---|---|---|
channelId | string | 频道 ID。 |
userId | string | 上麦的用户 ID。 |
userData | object | 用户的自定义属性。 |
UserIsStreamOn
UserIsStreamOn: (channelId: string, userId: string, UserData?: {}) => void;
频道广播开始。
回调参数
参数 | 类型 | 描述 |
---|---|---|
channelId | string | 频道 ID。 |
userId | string | 上麦的用户 ID。 |
userData | object | 用户的自定义属性。 |
userLevel | number | 用户在频道中的对讲等级。 |
UserIsStreamOff
UserIsStreamOff: (channelId: string, userId: string, UserData?: {}) => void;
频道广播结束。
回调参数
参数 | 类型 | 描述 |
---|---|---|
channelId | string | 频道 ID。 |
userId | string | 上麦的用户 ID。 |
userData | object | 用户的自定义属性。 |
userLevel | number | 用户在频道中的对讲等级。 |