使用 UDP 通道发送自定义消息给房间内所有用户

说明

该接口可以让您借助 TRTC 的 UDP 通道，向当前房间里的其他用户广播自定义数据，以达到传输信令的目的。 房间中的其他用户可以通过 addListener 中的 onRecvCustomCmdMsg 回调接收消息。

方法名

sendCustomCmdMsg

用法

• 用法如下：

uniapp

module.sendCustomCmdMsg({
  params:{
  },
  //成功执行的函数
  success: (res) => {
    let data = res.data;
    console.log(data)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数，不管成功还是失败都会返回
  complete: (res) => {
    // console.log(res)
  }
})

uniappx

module.sendCustomCmdMsg({
  params:{
  },
  //成功执行的函数
  success: (res) => {
    const data = res.data;
    console.log(data)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数，不管成功还是失败都会返回
  // complete: (res) => {
  //   console.log(res)
  // }
} as LevenOptions)

• 参数说明

  参数名	参数类型	是否必填	默认值	参数描述
  params	Object	是	无	参数配置
  params.cmdID	Integer	否	无	消息 ID，取值范围为 [1, 10]
  params.data	String	否	无	待发送的消息，单个消息的最大长度被限制为 1KB
  params.reliable	Boolean	否	无	是否要求有序，即是否要求接收端的数据包顺序和发送端的数据包顺序一致（这会带来一定的接收延时）
  params.ordered	Boolean	否	无	是否可靠发送，可靠发送可以获得更高的发送成功率，但可靠发送比不可靠发送会带来更大的接收延迟
  success	Function	否	无	执行成功的函数
  fail	Function	否	无	执行失败的函数
  complete	Function	否	无	执行完成的函数，不管成功还是失败都会执行

  注意

  1. 发送消息到房间内所有用户（暂时不支持 Web/小程序端），每秒最多能发送30条消息（与 sendSEIMsg 共享限制）。
  2. 每个包最大为 1KB，超过则很有可能会被中间路由器或者服务器丢弃。
  3. 每个客户端每秒最多能发送总计 16KB 数据（与 sendSEIMsg 共享限制）。
  4. 请将 reliable 和 ordered 同时设置为 true 或同时设置为 false，暂不支持交叉设置。
  5. 强烈建议您将不同类型的消息设定为不同的 cmdID，这样可以在要求有序的情况下减小消息时延。
  6. 目前仅支持主播身份。

回调

• 示例

{
"data": {
  "result": true
},
"message": "",
"code": 0
}

• 回调说明：

  参数名	参数类型	参数描述
  message	String	消息提示
  data	Object	数据对象
  data.result	Boolean	true：消息已经发出；false：消息发送失败
  code	Integer	返回类型，0.成功，其他：失败