SDKsReact Native

发送自定义信令

在通话房间中发送自定义信令。

向通话房间发送业务自定义信令，例如举手、切换视频布局或同步业务状态。customInfo 为字符串；需要传递结构化数据时，可序列化为 JSON 字符串后传入。

await OpenIMSDK.signalingSendCustomSignal({
  roomID,
  customInfo: JSON.stringify({
    type: 'hand-raised',
  }),
});

参数说明

参数	类型	必填	含义
`roomID`	`string`	是	目标通话房间 ID。
`customInfo`	`string`	是	业务自定义信令内容。

返回结果

调用完成后，自定义信令发送请求已处理完成。

接收自定义信令

其他参与者发送自定义信令时会触发 OnReceiveCustomSignal 事件，回调参数类型为 OnReceiveCustomSignalPayload，包含 roomID 和 customInfo。客户端使用 roomID 匹配对应的通话房间后解析并处理业务数据。

function handleCustomSignal(payload: OnReceiveCustomSignalPayload) {
  // ...
}

// 设置监听
OpenIMSDK.on(OpenIMEvent.OnReceiveCustomSignal, handleCustomSignal);

// 取消监听
OpenIMSDK.off(OpenIMEvent.OnReceiveCustomSignal, handleCustomSignal);

组件销毁、退出登录或切换账号时，应取消监听。接收 customInfo 后，按业务协议解析并处理其中的数据。

这个页面有帮助吗？