SDKsReact Native
发送自定义信令
在通话房间中发送自定义信令。
调用 signalingSendCustomSignal() 向通话房间发送业务自定义信令,例如举手或切换布局。customInfo 是字符串;需要传递结构化数据时,可传入 JSON 字符串。
await OpenIMSDK.signalingSendCustomSignal({
roomID,
customInfo: JSON.stringify({
type: 'hand-raised',
}),
});参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
roomID | string | 目标通话房间 ID。 |
customInfo | string | 业务自定义信令内容。 |
调用完成后,自定义信令发送请求已完成。
接收自定义信令
其他参与者发送自定义信令时触发 OnReceiveCustomSignal 事件,回调参数类型为 OnReceiveCustomSignalPayload,包含 roomID 和 customInfo。
function handleCustomSignal(payload: OnReceiveCustomSignalPayload) {
// ...
}
// 设置监听
OpenIMSDK.on(OpenIMEvent.OnReceiveCustomSignal, handleCustomSignal);
// 取消监听
OpenIMSDK.off(OpenIMEvent.OnReceiveCustomSignal, handleCustomSignal);组件销毁、退出登录或切换账号时,应取消监听。接收 customInfo 后,按业务协议解析并处理其中的数据。
这个页面有帮助吗?