实现语聊房

更新时间：2024-08-02 09:55

---

本文档介绍如何在使用实时音视频产品（ZEGO Express SDK）实现基本音频通话功能的基础上，结合即时通讯产品（ZIM SDK）实现语聊房功能。

本文基于 示例代码 来介绍的如何实现语聊房功能，因此文档中的部分方法为示例代码封装方法。

前提条件

在开始之前，请确保完成以下步骤：

• 已在项目中集成 ZEGO Express SDK，详情请参考 快速开始 - 集成 SDK。
• 下载本文档附带的 示例代码。
• 在 管理控制台 中注册并创建项目，同时开通 “即时通讯” 服务。
  

预览效果

您可以通过本文档提供的 示例代码 实现以下效果：

主页	房主页面	听众页面	听众点击上麦请求	房主查看请求

房主可以单击右下角的“锁定图标”来更改房间模式。

• 自由模式：听众点击麦位后，即可成为发言人。
• 请求模式：听众点击麦位触发上麦请求后，必须等待房主同意才可成为发言人。

技术原理

如果您需要了解推流及拉流的相关接口使用，请参考 快速开始 - 实现音频通话文档。

在一个语聊房中：

• 所有听众进入房间后可以开始拉流，以播放房间中发言人的声音。
• 发言人在上麦后即可开始推流，将本地音频推送给房间内的听众。

如何管理麦位

除了实现上述逻辑外，语聊房还需要管理发言人麦位。发言人麦位管理功能通常可以使用 ZIM SDK 的 房间属性管理 特性实现。

该特性允许开发者客户端在房间中设置和同步自定义的房间属性。房间属性以键值对的方式存储在 ZEGO 服务器上，由 ZEGO 服务器解决写入冲突和其他问题，以确保数据一致性。

同时，开发者客户端对房间属性的修改会通过 ZEGO 服务器实时同步给房间中的所有其他听众。

• 每个房间最多允许设置 20 个属性，key 的长度限制为 16 字节，value 的长度限制为 1024 字节。 开发者如果需要提高属性限制上限，请联系 ZEGO 技术支持。
• 房间销毁后，设置的自定义属性也会同时销毁。

以用户 A 申请上麦为例，具体过程如下：

sequenceDiagram
    participant 用户 A
    participant sdk1 as ZIM SDK
    participant server as ZEGO 服务器
    participant sdk2 as  ZIM SDK
    participant 用户 B

    用户 A  ->> sdk1  : setRoomAttributes
    sdk1   ->> server: setRoomAttributes
    server ->> sdk2  : onRoomAttributesUpdated
    sdk2   ->> 用户 B   : onRoomAttributesUpdated

    用户 B    ->> 用户 B : 麦位变动

    Note over 用户 A, 用户 B: 聊天中

使用房间属性标志发言人麦位：

您可以使用语聊房中的麦位序号，作为房间属性的 Key，并使用 userID 作为房间属性的值，来表示房间的发言人麦位状态。

例如，如果 userID 为 “user123” 的用户位于 0 号麦位上，而 userID 为 “user456” 的用户位于 1 号麦位上，则其房间属性如下：

{
  "0":"user123", // 表示 user123 位于 0 号麦位上
  "1":"user456", // 表示 user456 位于 1 号麦位上
}

房间属性功能的设计，可以解决语聊房场景中，一些常见麦位管理问题：

功能	描述	用途
所有者	第一个设置 Key 的听众将成为该 Key 的所有者。默认情况下，只有所有者可以修改 Key。	可用于避免抢占发言人麦位时的冲突。
自动删除	在设置 Key 时，可以将 Key 配置为“所有者离开房间后自动删除”。	可用于实现“发言人离线后发言人麦位自动更新”的功能，避免由于开发者客户端断开连接导致发言人麦位混乱的问题。
强制修改	支持忽略所有者并强制修改 Key 对应的值。	可用于实现“房主强制将发言人从麦位上移除”的功能。
组合操作	可以将对不同 Key-Value 的多个操作组合成一个组合操作，避免其他用户操作相关 Key-Value 时产生冲突。	可用于实现更改发言人麦位的功能。

如何管理房间模式

在语聊房中，您可能需要支持房主修改房间模式：

• 自由模式：听众点击麦位后，即可成为发言人。
• 请求模式：听众点击麦位触发上麦请求后，必须等待房主同意才可成为发言人。

房间模式可使用 Express SDK 的 setRoomExtraInfo 实现。“房间附加信息”与上述的“房间属性”类似，也存储在 ZEGO 服务器上，但是“房间附加信息”的使用更简单：

没有复杂的参数，只支持设置 Key-Value 字符串（Key 最大 10 字节，Value 最大 128 字节），更适合与房间绑定的简单业务操作，如房间模式、房间公告等。

您可以将任何业务字段封装成 JSON 协议，并将其设置为“房间附加信息”以实现房间模式等业务逻辑。

当房主调用 setRoomExtraInfo 方法时，房间内的用户可以通过 onRoomExtraInfoUpdate 接收到设置的房间附加信息。

sequenceDiagram
    participant 用户 A
    participant sdk1 as ZEGO Express SDK
    participant server as ZEGO 服务器
    participant sdk2 as ZEGO Express SDK
    participant 用户 B

    用户 A  ->> sdk1  : setRoomExtraInfo
    sdk1   ->> server: setRoomExtraInfo
    server ->> sdk2  : onRoomExtraInfoUpdate
    sdk2   ->> 用户 B   : onRoomExtraInfoUpdate

    用户 B    ->> 用户 B   : 房间模式已更改

    Note over 用户 A, 用户 B: 房间模式已更新

如何使用房间请求信令请求上麦

什么是房间请求信令？

基于房间请求信令实现上麦请求的过程，房间请求信令是一种管理网络中通信和连接的协议或消息。ZEGO 将所有房间请求信令功能打包到一个 SDK 中，为您提供了一个现成的实时房间请求信令 API。

如何通过 ZIM SDK 接口发送和接收房间请求消息

ZIM SDK 提供了丰富的功能来发送和接收消息，详情可参考 收发消息。此处，您需要使用可自定义的房间请求消息：ZIMCommandMessage

此部分的完整示例代码，可参考 ZIMService.java。

1. 通过调用以下方法在房间中发送房间请求信令（ZIMCommandMessage）：

   zim.sendMessage(commandMessage, mRoomID, ZIMConversationType.ROOM, config, new ZIMMessageSentCallback() {
       // ...
       @Override
       public void onMessageSent(ZIMMessage message, ZIMError errorInfo) {
           // ...
       }
   });

2. 发送后成功后，房间中的其他用户将通过 onReceiveRoomMessage 回调接收房间请求信令。您可以通过以下方式监听此回调：

   zim.setEventHandler(new ZIMEventHandler() {
       @Override
       public void onReceiveRoomMessage(ZIM zim, ArrayList<ZIMMessage> messageList, String fromRoomID) {
           super.onReceiveRoomMessage(zim, messageList, fromRoomID);
   
           // ...
       }
   });

   如何自定义业务房间请求信令

此部分的完整示例代码，可参考 ZIMService.java 和 RoomRequest.java。

房间请求信令 JSON 编码

由于简单的 String 本身难以表达复杂信息，房间请求信令可以封装在 JSON 格式中，使您更方便地编写房间请求信令的协议内容。

以最简单的房间请求信令的 JSON 格式为例：{"action_type": 0}，在这样一份 JSON 房间请求信令中，您可以使用 action_type 字段来表达不同的房间请求信令类型，例如：

• 发送请求：{"action_type": RoomRequestAction.ACTION_REQUEST}
• 取消请求：{"action_type": RoomRequestAction.ACTION_CANCEL}
• 接受请求：{"action_type": RoomRequestAction.ACTION_ACCEPT}
• 拒绝请求：{"action_type": RoomRequestAction.ACTION_REJECT}

此外，您还可以为房间请求信令扩展其他常见字段，例如 senderID，receiverID，extended_data：

public class RoomRequest {

    // ...
    public String toString() {
        JSONObject jsonObject = new JSONObject();
        try {
            jsonObject.put("action_type", actionType);
            jsonObject.put("sender_id", sender);
            jsonObject.put("receiver_id", receiver);
            jsonObject.put("extended_data", extendedData);
            jsonObject.put("request_id", requestID);
        } catch (JSONException e) {
            throw new RuntimeException(e);
        }
        return jsonObject.toString();
    }

    // ...
}

public @interface RoomRequestAction {
    int ACTION_REQUEST = 0;
    int ACTION_ACCEPT = 1;
    int ACTION_REJECT = 2;
    int ACTION_CANCEL = 3;
}

房间请求信令 JSON 解码

接收房间请求信令的用户，可以解码 JSON 房间请求信令，并根据其中的字段了解和处理具体的业务逻辑，例如：

zim.setEventHandler(new ZIMEventHandler() {
    @Override
    public void onReceiveRoomMessage(ZIM zim, ArrayList<ZIMMessage> messageList, String fromRoomID) {
        super.onReceiveRoomMessage(zim, messageList, fromRoomID);

        zimRoomService.onReceiveRoomMessage(zim, messageList, fromRoomID);
    }
    // ...
})

// ...
public void onReceiveRoomMessage(ZIM zim, ArrayList<ZIMMessage> messageList, String fromRoomID) {
    try {
        for (ZIMMessage zimMessage : messageList) {
            if (zimMessage instanceof ZIMCommandMessage) {
                ZIMCommandMessage commandMessage = (ZIMCommandMessage) zimMessage;
                String message = new String(commandMessage.message, StandardCharsets.UTF_8);
                JSONObject jsonObject = new JSONObject(message);
                ZIMUserInfo currentUser = zimUserService.getCurrentUser();
                if (jsonObject.has("action_type") && currentUser != null) {
                    String sender = jsonObject.getString("sender_id");
                    String receiver = jsonObject.getString("receiver_id");
                    int actionType = jsonObject.getInt("action_type");

                    if (currentUser.userID.equals(receiver)) {
                        // ...
                    }
                }
            }
        }
    } catch (JSONException e) {
       // ...
    }
}

扩展房间请求信令

基于这种模式，当您需要进行任何业务协议扩展时，只需扩展房间请求信令的 extended_data 字段，就可以轻松实现新的业务逻辑，例如：

• 静音听众：在收到相应的房间请求信令后，可阻止用户发送弹幕消息。
• 发送虚拟礼物：在收到房间请求信令后，可显示礼物特效。
• 移除听众：在收到房间请求信令后，提示听众已被移除并退出房间。

其他扩展信息：：

通过以下内容，可进一步了解麦位请求的实现，您将能够对您的业务进行扩展。

本文档中的演示是一个纯客户端 API + ZEGOCLOUD 解决方案。如果您有自己的业务服务端，并希望进行更多的逻辑扩展，您可以使用我们的 服务端 API 来传递房间信令，并结合您服务端的房间业务逻辑，以提高您的应用的可靠性。

sequenceDiagram
    participant 用户 A
    participant appServer as 开发者服务端
    participant server as ZEGO 服务端
    participant sdk as ZIM SDK
    participant 用户 B

    用户 A  ->> appServer  : 发送麦位请求
    appServer   ->> appServer  : 处理自己的业务逻辑
    appServer   ->> server: 用户 A 的麦位请求
    server ->> sdk  : 用户 A 的麦位请求
    sdk   ->> 用户 B   : 用户 A 的麦位请求


    Note over 用户 A, 用户 B: ...

实现流程

1. 集成并使用 ZIM SDK

如果您之前没有使用过 ZIM SDK，您可以阅读以下部分：

稍后，我们将为您提供如何使用 ZIM SDK 开发语聊房功能的详细说明。

2. （必选）管理多个 SDK

在本文档描述的语聊房场景中，您需要使用 ZIM SDK 来实现发言人麦位管理功能，然后使用 Express SDK 实现语聊房功能。

为了使您的应用代码更加有条理，我们建议您通过使用以下方式来管理这些 SDK：

public class ZIMService {

    // ...

    public void initSDK(Application application, long appID, String appSign) {
        zimProxy.create(application, appID, appSign);
        // ...
    }
}

class ZIMProxy {

    private SimpleZIMEventHandler zimEventHandler;

    public void create(Application application, long appID, String appSign) {
        ZIMAppConfig zimAppConfig = new ZIMAppConfig();
        zimAppConfig.appID = appID;
        zimAppConfig.appSign = appSign;
        ZIM.create(zimAppConfig, application);

        zimEventHandler = new SimpleZIMEventHandler();
        if (getZIM() != null) {
            ZIM.getInstance().setEventHandler(zimEventHandler);
        }
    }

}

public class ExpressService {

    // ...
    public void initSDK(Application application, long appID, String appSign, ZegoScenario scenario) {
        ZegoEngineConfig config = new ZegoEngineConfig();
        config.advancedConfig.put("notify_remote_device_unknown_status", "true");
        config.advancedConfig.put("notify_remote_device_init_status", "true");
        ZegoExpressEngine.setEngineConfig(config);
        engineProxy.createEngine(application, appID, appSign, scenario);
        // ...
    }
}

class ExpressEngineProxy {

    private SimpleExpressEventHandler expressEventHandler;

    public void createEngine(Application application, long appID, String appSign, ZegoScenario scenario) {
        ZegoEngineProfile profile = new ZegoEngineProfile();
        profile.appID = appID;
        profile.appSign = appSign;
        profile.scenario = scenario;
        profile.application = application;
        expressEventHandler = new SimpleExpressEventHandler();
        ZegoExpressEngine.createEngine(profile, expressEventHandler);
    }
}

public class ZIMService {
    // ...
    public void connectUser(String userID, String userName, ZIMLoggedInCallback callback) {
        ZIMUserInfo zimUserInfo = new ZIMUserInfo();
        zimUserInfo.userID = userID;
        zimUserInfo.userName = userName;
        zim.login(zimUserInfo, new ZIMLoggedInCallback() {
            @Override
            public void onLoggedIn(ZIMError errorInfo) {
                // ...
            }
        });
    }
}

public class ZEGOSDKManager {
    public ExpressService expressService = new ExpressService();
    public ZIMService zimService = new ZIMService();

    private static final class Holder {
        private static final ZEGOSDKManager INSTANCE = new ZEGOSDKManager();
    }

    public static ZEGOSDKManager getInstance() {
        return Holder.INSTANCE;
    }

    public void initSDK(Application application, long appID, String appSign,ZegoScenario scenario) {
        expressService.initSDK(application, appID, appSign,scenario);
        zimService.initSDK(application, appID, appSign);
    }
}

3. 麦位管理

听众上麦

如需让听众上麦，请调用 setRoomAttributes 并将麦位序号作为 Key，听众的 userID 作为房间附加属性的值。如果设置成功，听众会成功上麦并可以开始推流。

完整的示例代码，请参考 RoomSeatService.java，其中主要示例代码如下。

public void takeSeat(int seatIndex, ZIMRoomAttributesOperatedCallback callback) {
    ZEGOSDKUser localUser = ZEGOSDKManager.getInstance().expressService.getCurrentUser();
    if (localUser == null || isTakeSeat) {
        return;
    }
    isTakeSeat = true;
    String key = String.valueOf(seatIndex);
    String value = localUser.userID;

    ZIMRoomAttributesSetConfig config = new ZIMRoomAttributesSetConfig();
    config.isDeleteAfterOwnerLeft = true;
    config.isForce = true;
    config.isUpdateOwner = true;
    // getInstance 为示例代码封装方法 https://github.com/ZEGOCLOUD/zegocloud_sdk_demo_android/blob/master/best_practice/app/src/main/java/com/zegocloud/demo/bestpractice/internal/ZEGOCallInvitationManager.java#L72
    // setRoomAttributes 为示例代码封装方法 https://github.com/ZEGOCLOUD/zegocloud_sdk_demo_android/blob/master/best_practice/app/src/main/java/com/zegocloud/demo/bestpractice/internal/sdk/zim/ZIMProxy.java#L96
    ZEGOSDKManager.getInstance().zimService.setRoomAttributes(key, value, config,
        new ZIMRoomAttributesOperatedCallback() {
            @Override
            public void onRoomAttributesOperated(String roomID, ArrayList<String> errorKeys, ZIMError errorInfo) {
                isTakeSeat = false;
                if (callback != null) {
                    callback.onRoomAttributesOperated(roomID, errorKeys, errorInfo);
                }
            }
        });
}

发言人下麦

当发言人下麦时，可调用 deleteRoomAttributes 来删除发言人使用的麦位号，并停止推流。

完整的示例代码，请参考 RoomSeatService.java，其中主要示例代码如下。

public void leaveSeat(int seatIndex, ZIMRoomAttributesOperatedCallback callback) {
    //getInstance 为示例代码封装方法 https://github.com/ZEGOCLOUD/zegocloud_sdk_demo_android/blob/master/best_practice/app/src/main/java/com/zegocloud/demo/bestpractice/internal/ZEGOCallInvitationManager.java#L72
    //getCurrentUser 为示例代码封装方法 https://github.com/ZEGOCLOUD/zegocloud_sdk_demo_android/blob/dd8062399252502f3f91b46ae2147a43160f73b5/best_practice/app/src/main/java/com/zegocloud/demo/bestpractice/internal/sdk/express/ExpressService.java#L638
    ZEGOSDKUser localUser = ZEGOSDKManager.getInstance().expressService.getCurrentUser();
    if (localUser == null) {
        return;
    }
    List<String> list = Collections.singletonList(String.valueOf(seatIndex));
    //deleteRoomAttributes 为示例代码封装方法 https://github.com/ZEGOCLOUD/zegocloud_sdk_demo_android/blob/dd8062399252502f3f91b46ae2147a43160f73b5/best_practice/app/src/main/java/com/zegocloud/demo/bestpractice/internal/sdk/zim/ZIMService.java#L486
    ZEGOSDKManager.getInstance().zimService.deleteRoomAttributes(list, new ZIMRoomAttributesOperatedCallback() {
        @Override
        public void onRoomAttributesOperated(String roomID, ArrayList<String> errorKeys, ZIMError errorInfo) {
            if (callback != null) {
                callback.onRoomAttributesOperated(roomID, errorKeys, errorInfo);
            }
        }
    });
}

移除发言人

当房主需要将发言人从麦位上移除时，请调用 deleteRoomAttributes，并将 ZIMRoomAttributesDeleteConfig 的isForce字段设置为 true，强制清除相应发言人麦位的房间属性，从而将发言人从麦位上移除。

完整的示例代码，请参考 RoomSeatService.java，其中主要示例代码如下。

public void removeSpeakerFromSeat(String userID, ZIMRoomAttributesOperatedCallback callback) {
    //getInstance 为示例代码封装方法 https://github.com/ZEGOCLOUD/zegocloud_sdk_demo_android/blob/master/best_practice/app/src/main/java/com/zegocloud/demo/bestpractice/internal/ZEGOCallInvitationManager.java#L72
    //getCurrentUser 为示例代码封装方法https://github.com/ZEGOCLOUD/zegocloud_sdk_demo_android/blob/dd8062399252502f3f91b46ae2147a43160f73b5/best_practice/app/src/main/java/com/zegocloud/demo/bestpractice/internal/sdk/express/ExpressService.java#L638
    ZEGOSDKUser localUser = ZEGOSDKManager.getInstance().expressService.getCurrentUser();
    if (localUser == null) {
        return;
    }
    for (LiveAudioRoomSeat seat : seatList) {
        int seatIndex = seat.seatIndex;
        ZEGOSDKUser seatUser = seat.getUser();
        if (seatUser != null) {
            String seatUserID = seatUser.userID;
            if (Objects.equals(userID, seatUserID)) {
                leaveSeat(seatIndex, callback);
                break;
            }
        }
    }
}

更换发言人麦位

当发言人从一个麦位切换到另一个麦位时，例如，发言人 A 从 2 号麦位切换到 3 号麦位，他需要先删除与 2 号麦位对应的房间属性（离开 2 号麦位），然后将与 3 号麦位对应的房间属性的值设置为自己的 userID（占用 3 号麦位）。这个过程涉及两个步骤。考虑以下极端情况：

当发言人 A 刚刚完成第一步（删除与 2 号麦位对应的房间属性并离开 2 号麦位）时，发言人 B 先于发言人 A 占用了 3 号麦位，导致发言人 A 成功离开了 2 号麦位，但无法占用 3 号麦位。

在这种情况下，发言人 A 失去了发言人麦位，显然不符合预期。

为了处理这种情况，您需要在发言人 A 完成两步操作之前，防止其他用户对相关发言人麦位进行操作。这可以通过使用组合操作的特性来实现：

// 1. 开始组合操作。
ZIMRoomAttributesBatchOperationConfig config = new ZIMRoomAttributesBatchOperationConfig();
config.isForce = true;
config.isDeleteAfterOwnerLeft = false;
config.isUpdateOwner = false;
zim.beginRoomAttributesBatchOperation(mRoomID, config);


// 2. 操作 1：离开 2 号麦位
List<String> keys = Collections.singletonList(String.valueOf(3));
ZIMRoomAttributesDeleteConfig config = new ZIMRoomAttributesDeleteConfig();
zim.deleteRoomAttributes(keys, mRoomID, config, callback);

// 3. 操作 2：占用 3 号麦位
String key = String.valueOf(2);
String value = localUser.userID;
ZIMRoomAttributesSetConfig config = new ZIMRoomAttributesSetConfig();
config.isDeleteAfterOwnerLeft = true;
config.isForce = false;
HashMap<String, String> attributes = new HashMap<>();
attributes.put(key, value);
zim.setRoomAttributes(attributes, mRoomID, config, callback);


// 4. 结束组合操作。
zim.endRoomAttributesBatchOperation(mRoomID, callback);

public void switchSeat(int fromSeatIndex, int toSeatIndex, ZIMRoomAttributesBatchOperatedCallback callback) {
    AudioRoomUser localUser = ZEGOSDKManager.getInstance().expressService.getLocalUser();
    if (localUser == null) {
        return;
    }
    if (!batchOperation) {
        //beginRoomPropertiesBatchOperation 为示例代码封装方法 https://github.com/ZEGOCLOUD/zegocloud_sdk_demo_android/blob/dd8062399252502f3f91b46ae2147a43160f73b5/best_practice/app/src/main/java/com/zegocloud/demo/bestpractice/internal/sdk/zim/ZIMService.java#L472
        ZEGOSDKManager.getInstance().zimService.beginRoomPropertiesBatchOperation();
        batchOperation = true;
        tryTakeSeat(toSeatIndex, null);
        leaveSeat(fromSeatIndex, null);
        //endRoomPropertiesBatchOperation 为示例代码封装方法 https://github.com/ZEGOCLOUD/zegocloud_sdk_demo_android/blob/dd8062399252502f3f91b46ae2147a43160f73b5/best_practice/app/src/main/java/com/zegocloud/demo/bestpractice/internal/sdk/zim/ZIMService.java#L479
        ZEGOSDKManager.getInstance().zimService.endRoomPropertiesBatchOperation(
            new ZIMRoomAttributesBatchOperatedCallback() {
                @Override
                public void onRoomAttributesBatchOperated(String roomID, ZIMError errorInfo) {
                    batchOperation = false;
                    if (callback != null) {
                        callback.onRoomAttributesBatchOperated(roomID, errorInfo);
                    }
                }
            });
    }
}

房间模式

我们将房间模式定义为：自由模式和请求模式。

房主可以调用示例代码中的自定义方法 setRoomExtraInfo，在自由模式和请求模式之间切换。

其中房间附加信息（roomExtraInfo）分为以下两种模式：

• 自由模式：{"lockseat":false}
• 请求模式：{"lockseat":true}

完整的示例代码，请参考 RoomSeatService.java，其中主要示例代码如下。

public void setHostAndLockSeat() {
    JSONObject extraInfoValueJson = audioRoomExtraInfo.getExtraInfoValueJson();
    try {
        ZEGOSDKUser localUser = ZEGOSDKManager.getInstance().expressService.getCurrentUser();
        JSONObject jsonObject = new JSONObject(extraInfoValueJson.toString());
        jsonObject.put(EXTRA_INFO_VALUE_HOST, localUser.userID);
        jsonObject.put(EXTRA_INFO_VALUE_LOCK_SEAT, true);
        //setRoomExtraInfo 为示例代码封装方法 https://github.com/ZEGOCLOUD/zegocloud_sdk_demo_android/blob/dd8062399252502f3f91b46ae2147a43160f73b5/best_practice/app/src/main/java/com/zegocloud/demo/bestpractice/internal/sdk/express/ExpressService.java#L817
        ZEGOSDKManager.getInstance().expressService.setRoomExtraInfo(EXTRA_INFO_KEY, jsonObject.toString());
    } catch (JSONException e) {
        throw new RuntimeException(e);
    }
}

发送和取消上麦请求

在示例代码中，从听众的角度来看，上麦请求按钮已放置在屏幕的右下角，当点击按钮时，将执行以下操作。

1. 房间请求信令的进行 JSON 编码，其中：
   • 将action_type定义为RoomRequestAction.ACTION_REQUEST。
   • 将room_request_type添加到 extendedData 中，并将其标记为REQUEST_TAKE_SEAT。
2. 调用示例代码中自定义的 sendRoomRequest 发送房间请求信令。（sendRoomRequest 简化了ZIM SDK的sendMessage 接口。）
   • 如果方法调用成功：本地端（即听众）的申请状态将切换为申请上麦，并且上麦请求按钮将切换为取消上麦。
   • 如果方法调用失败：将提示错误消息。在实际的应用开发中，您应该使用更友好的用户界面来提示上麦请求失败。

完整的示例代码，请参考 TakeSeatButton.java，其中主要示例代码如下。

@Override
protected void afterClick() {
    super.afterClick();
    // ...
    RoomRequestExtendedData extendedData = new RoomRequestExtendedData();
    extendedData.roomRequestType = RoomRequestType.REQUEST_TAKE_SEAT;
    // sendRoomRequest 为示例代码封装方法 https://github.com/ZEGOCLOUD/zegocloud_sdk_demo_android/blob/dd8062399252502f3f91b46ae2147a43160f73b5/best_practice/app/src/main/java/com/zegocloud/demo/bestpractice/internal/sdk/zim/ZIMService.java#L719
    ZEGOSDKManager.getInstance().zimService.sendRoomRequest(hostUser.userID, jsonObject.toString(),
        new RoomRequestCallback() {
            @Override
            public void onRoomRequestSend(int errorCode, String requestID) {
                if (errorCode == 0) {
                   mRequestID = requestID;
                }
            }
        });
// ... 
}

 public void sendRoomRequest(String receiverID, String extendedData, RoomRequestCallback callback) {
        if (zimProxy.getZIM() == null || currentRoom == null || currentUser == null) {
            return;
        }
        RoomRequest roomRequest = new RoomRequest();
        roomRequest.receiver = receiverID;
        roomRequest.sender = currentUser.userID;
        roomRequest.extendedData = extendedData;
        roomRequest.actionType = RoomRequestAction.ACTION_REQUEST;

        byte[] bytes = roomRequest.toString().getBytes(StandardCharsets.UTF_8);
        ZIMCommandMessage commandMessage = new ZIMCommandMessage(bytes);
        zimProxy.sendMessage(commandMessage, currentRoom.roomID, ZIMConversationType.ROOM, new ZIMMessageSendConfig(),
            new ZIMMessageSentCallback() {
                @Override
                public void onMessageAttached(ZIMMessage message) {

                }

                @Override
                public void onMessageSent(ZIMMessage message, ZIMError errorInfo) {
                    if (errorInfo.code == ZIMErrorCode.SUCCESS) {
                        roomRequest.requestID = String.valueOf(message.getMessageID());
                        roomRequestMap.put(roomRequest.requestID, roomRequest);
                    }
                //...
                }
            });
    }

public void updateUI() {
    // getRoomRequestByRequestID 为示例代码封装方法 https://github.com/ZEGOCLOUD/zegocloud_sdk_demo_android/blob/dd8062399252502f3f91b46ae2147a43160f73b5/best_practice/app/src/main/java/com/zegocloud/demo/bestpractice/internal/sdk/zim/ZIMService.java#L928
    RoomRequest roomRequest = ZEGOSDKManager.getInstance().zimService.getRoomRequestByRequestID(mRequestID);
    if (roomRequest == null) {
        setText("申请上麦");
    } else {
        setText("取消上麦");
    }
    setBackgroundResource(R.drawable.bg_cohost_btn);
    setCompoundDrawablesWithIntrinsicBounds(R.drawable.liveaudioroom_bottombar_cohost, 0, 0, 0);
}

3. 本地端（听众端）将等待房主的响应。

• 如果房主拒绝上麦请求：本地端的申请状态将切换为未申请。
• 如果房主接受上麦请求：听众将成为发言人，并可以开始推流。

接受和拒绝上麦请求

1. 在示例代码中，当房主收到一个上麦请求时，请求的听众将显示在请求列表中，房主可以在单击请求列表后，查看列表并选择接受或拒绝听众的上麦请求。
2. 房主回应后，将发送一个接受或拒绝的房间请求信令，发送房间请求信令的相关逻辑在此不再赘述。

完整的示例代码，请参考 RoomRequestListDialog.java ，其中主要示例代码如下。

常见问题解答

完成语聊房功能

恭喜您，完成上述步骤后，您已经实现了语聊房功能。