实时音视频
  • iOS
  • Android
  • macOS
  • Windows
  • HarmonyOS
  • Linux : C++
  • Web
  • 小程序
  • Flutter
  • Electron
  • Unreal Engine
  • Unity3D
  • uni-app
  • React Native
  • Cocos Creator
  • 产品简介
  • 下载
  • 快速开始
    • 跑通示例源码
    • 集成 SDK
    • 实现视频通话
    • 实时音视频 SDK 与实时语音 SDK 差异
    • 场景化音视频配置
  • 通信能力
  • 房间能力
  • 音频能力
  • 视频能力
  • 直播能力
  • 其他能力
  • 最佳实践
  • 客户端 API
  • 服务端 API
  • 常见错误码
  • 常见问题
  • 文档中心
  • 实时音视频
  • 房间能力
  • 实时消息与信令

实时消息与信令

更新时间:2024-03-21 15:46

功能简介

ZEGO 提供多种文本消息的收发功能,实现发送房间内广播消息、弹幕消息、简单 IM 文字聊天、点赞、送礼物、答题等功能。

消息类型 功能描述 应用场景 发送频率限制
广播消息 向同一房间内所有用户发送文本消息,默认支持最多前 500 个加入房间的用户能收到该消息。 一般当直播房间人数小于 500 时发送该类消息。可用于简单的房间内聊天室场景。 请参考 限制说明
弹幕消息 观众在直播过程中可以发表自己的评论,并以滑动而过的字幕显示出来,增加了观众之间的互动性。 一般用于房间内有大量消息收发,且不需要保证消息可靠性的场景,例如直播弹幕。 请参考 限制说明
自定义信令 向同一房间内单个或多个用户发送消息。 一般用于远程控制信令或简单的文字消息发送。比如在线娃娃机场景中,远程控制娃娃机夹子的移动。 请参考 限制说明

前提条件

在发送实时消息前,请确保:

使用步骤

收发广播消息

  1. 发送广播消息

    调用 sendBroadcastMessage 接口向同一房间内的其他用户发送广播消息,长度不能超过 1024 字节。

    通过 ZegoIMSendBroadcastMessageCallback 回调获取消息发送结果。

    // 发送广播消息
    engine->sendBroadcastMessage("ChatRoom-1", "This is a broadcast message", [=](int errorCode, unsigned long long messageID){
        printf("send broadcast message: errorCode=%d", errorCode);
    })
  2. 接收广播消息

    实现 IZegoEventHandler 代理中的 onIMRecvBroadcastMessage 回调,当发送方成功发送广播消息后,同一房间内的其他用户通过此回调接收相关信息,包括消息内容、消息 ID、发送时间及发送方信息。

    class MyEventHandler: public IZegoEventHandler{
       /**
        * 接收房间广播消息通知
        *
        * @param roomID 房间 ID
        * @param messageList 收到的消息列表
        */
        void onIMRecvBroadcastMessage(const std::string& roomID, std::vector<ZegoBroadcastMessageInfo> messageList) override {
            printf("received broadcast message");
            // 请注意,请勿在 SDK 回调线程中调用任何 SDK 接口,需要手动切换为其他线程,否则会产生死锁
        }
    }    

收发弹幕消息

  1. 发送弹幕消息

    调用 sendBarrageMessage 接口向同一房间内的其他用户发送弹幕消息,长度不能超过 1024 字节。

    通过 ZegoIMSendBarrageMessageCallback 回调获取消息发送结果。

    // 发送弹幕消息
    engine->sendBarrageMassage("ChatRoom-1", "This is a barrage message", [=](int errorCode, std::string messageID){
        printf("send barrage message: errorCode=%d", errorCode);
    })
  2. 接收弹幕消息

    实现 IZegoEventHandler 代理中的 onIMRecvBarrageMessage 回调,当发送方成功发送弹幕消息后,同一房间内的其他用户通过此回调接收相关信息,包括消息内容、消息 ID、发送时间及发送方信息。

    class MyEventHandler: public IZegoEventHandler{
       /**
        * 接收房间弹幕消息通知
        *
        * @param roomID 房间 ID
        * @param messageList 收到的消息列表
        */
        void onIMRecvBarrageMessage(const std::string& roomID, std::vector<ZegoBarrageMessageInfo> messageList) override {
            printf("received barrage message");
            // 请注意,请勿在 SDK 回调线程中调用任何 SDK 接口,需要手动切换为其他线程,否则会产生死锁
        }
     }    

收发自定义信令

  1. 发送自定义信令

    调用 sendCustomCommand 接口向同一房间内通过 toUserList 指定的用户发送自定义信令,长度不能超过 1024 字节。

    通过 ZegoIMSendCustomCommandCallback 回调获取消息发送结果。

    // 发送自定义信令,toUserList 中指定的用户才可以通过 onIMRecvCustomCommand 收到此信令
    auto user1 = ZegoUser("userID1", "userName1");
    auto user2 = ZegoUser("userID2", "userName2");
    std::vector<ZegoUser> toUserList = {user1, user2};
    engine->sendCustomCommand("ChatRoom-1", "This is a custom command", toUserList, [=](int errorCode){
        printf("send custom command: errorCode=%d", errorCode);
    })
  2. 接收自定义信令

    实现 IZegoEventHandler 代理中的 onIMRecvCustomCommand 回调,当发送方成功发送自定义信令后,同一房间内的指定用户通过此回调接收相关信息,包括消息内容和消息发送方信息。

    class MyEventHandler: public IZegoEventHandler{
       /**
        * 接收自定义信令通知
        *
        * @param roomID 房间 ID
        * @param fromUser 信令的发送人
        * @param command 信令内容
        */
        void onIMRecvCustomCommand(const std::string& roomID, ZegoUser fromUser, const std::string& command) override {
             printf("received custom command");
             // 请注意,请勿在 SDK 回调线程中调用任何 SDK 接口,需要手动切换为其他线程,否则会产生死锁  
      }
    }
本篇目录