sendCustomCommand method
- String roomID,
- String command,
- List<
ZegoUser> toUserList
发送自定义信令。
支持版本:1.2.1 及以上。
详情描述:向已经登录相同房间的其他用户发送点对点的信令,消息可靠。
业务场景:一般用于远程控制信令或用户与用户之间的消息发送。
调用时机:调用 loginRoom
登录房间之后。
使用限制:一般在直播房间人数不超过 500 时使用。同一房间内向单个用户发送的自定义消息频率不能高于 200条/s,向多个用户发送的自定义消息不能高于 10条/s。关于此函数的使用限制,请参考 https://doc-zh.zego.im/article/7581 或联系 ZEGO 技术支持。
相关回调:可通过 onIMRecvCustomCommand 接收到房间自定义信令。
相关接口:可通过 sendBroadcastMessage 函数发送广播消息,可通过 sendBarrageMessage 函数发送弹幕消息。
隐私保护声明:请勿在此接口填写用户敏感信息,包括但不限于手机号、身份证号、护照编号、真实姓名等。
roomID
房间 ID,不得为空,最大长度为 128 字节的字符串。 注意事项: 1.房间 ID 由您自己定义。- 仅支持数字,英文字符 和 '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', ''。
- 如果需要与 Web SDK 互通,请不要使用 '%'。
command
自定义信令内容。是否必填:是。取值范围:最大长度为 1024 字节。注意事项:为保护隐私,请勿在此接口填写用户敏感信息,包括但不限于手机号、身份证号、护照编号、真实姓名等。toUserList
信令的接收者列表。是否必填:是。取值范围:用户列表或者null
。注意事项:为null
时 SDK 回向房间内所有用户发送自定义信令。- Returns 发送信令结果通知。
Implementation
Future<ZegoIMSendCustomCommandResult> sendCustomCommand(
String roomID, String command, List<ZegoUser> toUserList) async {
return await ZegoExpressImpl.instance
.sendCustomCommand(roomID, command, toUserList);
}