白板支持开发者在房间中，利用sdk提供的自定义事件接口与当前房间其他客户端进行广播。接收方需要提前注册自定义事件名称。所有自定义事件信息，都会在回放中一一复原。开发者在回放时，注册对应自定义事件监听，同样可以接收到当时的信息。
副作用。开发者可以使用room的dispatchMagixEvent向房间所有客户端发送消息。
/**
* 发送自定义事件
* @param name 自定义事件名称，其他客户端注册对该字段的事件监听，才能收到回调
* @param payload 发送内容，可以为任何可以被 JSON 序列化的数据。
*/
dispatchMagixEvent(name: string, payload: any): void;
通过如下代码发送自定义事件。
room.dispatchMagixEvent("SendGift", {
senderName: "ZhangJie",
receiverName: "Lili",
giftType: "Lamborghini",
imageIds: [1273, 2653, 23, 17283],
timestamp: 1541820428865,
});
该 API 为轻量级处理，不保证在高频，大量
payload数据场景情况下的稳定性。
// 自定义事件监听
/**
* 高频自定义事件监听
* @param name 自定义事件名称
* @param listener 自定义事件回调(一次性返回大量 Event)
*/
addMagixEventListener(name: string, listener: EventListener): void;
export type EventListener = (event: Event) => void;
export type Event = {
//自定义信息名称
readonly event: string;
//事件信息
readonly payload: any;
//发送者 memberId
readonly authorId: number;
readonly scope: Scope;
readonly phase: EventPhase;
};
/**
* 高频自定义事件监听
* @param name 自定义事件名称
* @param listener 自定义事件回调(一次性返回大量 Event)
* @param fireInterval 回调间隔，毫秒，强制 >= 500
*/
addMagixEventListener(name: string, listener: EventsListener, fireInterval: number): void;
export type EventsListener = (events: Event[]) => void;
function onRecevieGift(eventObject) {
console.log(eventObject.payload); // 事件 payload
}
room.addMagixEventListener("SendGift", onRecevieGift);
//当执行以下代码后
/*
room.dispatchMagixEvent("SendGift", {
senderName: "ZhangJie",
receiverName: "Lili",
giftType: "Lamborghini",
imageIds: [1273, 2653, 23, 17283],
timestamp: 1541820428865,
});
*/
//会输出输出以下内容
{
"senderName": "ZhangJie",
"receiverName": "Lili",
"giftType": "Lamborghini",
"imageIds": [1273, 2653, 23, 17283],
"timestamp": 1541820428865,
}
function onRecevieGifts(eventObjects) {
// 传递的不在是 Event，而是 Event 数组
console.log(eventObjects);
}
room.addMagixEventListener("SendGift", onRecevieGifts);
/**
* 注销自定义监听，包括高频自定义事件
* @param name 自定义事件名称
* @param listener 监听事件，如果不传，则移除该自定义事件的所有监听
*/
public removeMagixEventListener(name: string, listener?: EventListener): void;
例子。
room.removeMagixEventListener("SendGift", onRecevieGift);