麦位管理 - NERoom 房间组件

开发者中心

NERoom 房间组件

集成开发

麦位管理

更新时间： 2023/12/21 05:58:47

NERoom 的麦位管理功能包括：上麦、下麦、抱麦、踢麦等。在语聊房、 K 歌、直播等场景中，主播和观众连麦是非常热门的玩法。通过多人实时互动，可以活跃房间氛围、激发观众参与热情，进而提升产品活跃度。

注意事项

您可以在创建房间时，设置麦位相关的初始化配置，包括麦位数量和麦位申请审批模式，具体请参见创建房间。

添加麦位事件监听

主播和观众进入房间后，调用 addSeatListener 接口，监听麦位相关的事件。

示例代码如下：

NERoomService roomService = NERoomKit.getInstance().getService(NERoomService.class);
        NERoomContext roomContext = roomService.getRoomContext(roomUuid);
        if (roomContext != null) {
            roomContext.getSeatController().addSeatListener(new NESeatEventListener() {
            
            @Override
            public void onSeatManagerAdded(List<String> managers) {

            }
            @Override
            public void onSeatManagerRemoved(List<String> managers) {
            }
            @Override
            public void onSeatRequestSubmitted(int seatIndex, String user) {
            }
            @Override
            public void onSeatRequestCancelled(int seatIndex, String user) {
            }
            @Override
            public void onSeatRequestApproved(int seatIndex, String user, String operateBy, boolean isAutoAgree) {
                
            }
            @Override
            public void onSeatRequestRejected(int seatIndex, String user, String operateBy) {
                
            }
            @Override
            public void onSeatInvitationReceived(int seatIndex, String user, String operateBy) {
                
            }
            @Override
            public void onSeatInvitationCancelled(int seatIndex, String user, String operateBy) {
            
            }
            @Override
            public void onSeatInvitationAccepted(int seatIndex,String user, boolean isAutoAgree) {
            }
            @Override
            public void onSeatInvitationRejected(int seatIndex, String user) {
            }
            @Override
            public void onSeatLeave(int seatIndex, String user) {
            }
            @Override
            public void onSeatKicked(int seatIndex, String user, String operateBy) {
            }
            @Override
            public void onSeatListChanged(List<NESeatItem> seatItems) {
            
            }
        });
        }

主播邀请观众上麦（抱麦）

API 调用时序图

实现方法

主播调用 sendSeatInvitation 接口邀请观众上麦。

参数类型描述

seatIndex Integer 麦位位置。
麦位的最大数量可以在创建房间时设置。

user String 待邀请的观众的用户 ID。
（可选）观众调用 acceptSeatInvitation 接口同意上麦邀请，或调用 rejectSeatInvitation 接口拒绝上麦邀请。
- 若在创建房间时设置了需要观众同意上麦：观众需要执行该操作。
- 若在创建房间时设置了观众自动同意上麦：观众无需执行该操作。
触发同意上麦的回调 onSeatInvitationAccepted 和麦位变更的回调 onSeatListChanged。
房间内所有成员收到 onSeatListChanged 回调后，刷新麦位展示的 UI。

参数	类型	描述
seatIndex	Integer	麦位位置。麦位的最大数量可以在创建房间时设置。
user	String	待邀请的观众的用户 ID。

示例代码

主播邀请观众上麦的示例代码如下：

String userId = "56789";
NERoomService roomService = NERoomKit.getInstance().getService(NERoomService.class);
        NERoomContext roomContext = roomService.getRoomContext(roomUuid);
        if (roomContext != null) {
            roomContext.getSeatController().sendSeatInvitation(userId,new NECallback2<Unit>() {
                @Override
                public void onSuccess(@Nullable Unit unit) {
                    super.onSuccess(unit);
                    Log.d(TAG,"success");
                }

                @Override
                public void onError(int code, @Nullable String message) {
                    super.onError(code, message);
                    Log.d(TAG,"error");
                }
            });
        }

主播邀请观众上麦时指定麦位的示例代码如下：

String userId = "56789";
int index = 2;
NERoomService roomService = NERoomKit.getInstance().getService(NERoomService.class);
        NERoomContext roomContext = roomService.getRoomContext(roomUuid);
        if (roomContext != null) {
            roomContext.getSeatController().sendSeatInvitation(index,userId,new NECallback2<Unit>() {
                @Override
                public void onSuccess(@Nullable Unit unit) {
                    super.onSuccess(unit);
                    Log.d(TAG,"success");
                }

                @Override
                public void onError(int code, @Nullable String message) {
                    super.onError(code, message);
                    Log.d(TAG,"error");
                }
            });
        }

观众申请上麦

API 调用时序

实现方法

观众 B 调用 submitSeatRequest 接口申请上麦。

参数	类型	描述
seatIndex	Integer	指定上麦后的麦位位置。该参数为可选，如果不传该参数，则自动占用当前空的麦位中的第一个。麦位的最大数量可以在创建房间时设置。

主播收到观众 B 申请上麦的回调 onSeatRequestSubmitted。
主播同意或拒绝观众 B 上麦。
- 主播调用 approveSeatRequest 接口同意观众 B 上麦。
- 主播调用 rejectSeatRequest 接口拒绝观众 B 上麦。
参数类型描述

user String 申请上麦的观众的用户 ID。
观众 B 收到主播同意上麦申请的回调 onSeatRequestApproved 或主播拒绝上麦申请的回调 onSeatRequestRejected。

参数	类型	描述
user	String	申请上麦的观众的用户 ID。

示例代码

//观众申请上麦时不指定麦位
NERoomService roomService = NERoomKit.getInstance().getService(NERoomService.class);
        NERoomContext roomContext = roomService.getRoomContext(roomUuid);
        if (roomContext != null) {
            roomContext.getSeatController().submitSeatRequest(new NECallback2<Unit>() {
                @Override
                public void onSuccess(@Nullable Unit unit) {
                    super.onSuccess(unit);
                    Log.d(TAG,"success");
                }

                @Override
                public void onError(int code, @Nullable String message) {
                    super.onError(code, message);
                    Log.d(TAG,"error");
                }
            });
        }


//观众申请上麦时指定麦位
int seatIndex = 2;
NERoomService roomService = NERoomKit.getInstance().getService(NERoomService.class);
        NERoomContext roomContext = roomService.getRoomContext(roomUuid);
        if (roomContext != null) {
            roomContext.getSeatController().submitSeatRequest(seatIndex,new NECallback2<Unit>() {
                @Override
                public void onSuccess(@Nullable Unit unit) {
                    super.onSuccess(unit);
                    Log.d(TAG,"success");
                }

                @Override
                public void onError(int code, @Nullable String message) {
                    super.onError(code, message);
                    Log.d(TAG,"error");
                }
            });
        }

//主播同意上麦申请
String userId = "56789";
NERoomService roomService = NERoomKit.getInstance().getService(NERoomService.class);
        NERoomContext roomContext = roomService.getRoomContext(roomUuid);
        if (roomContext != null) {
            roomContext.getSeatController().approveSeatRequest(userId,new NECallback2<Unit>() {
                @Override
                public void onSuccess(@Nullable Unit unit) {
                    super.onSuccess(unit);
                    Log.d(TAG,"success");
                }

                @Override
                public void onError(int code, @Nullable String message) {
                    super.onError(code, message);
                    Log.d(TAG,"error");
                }
            });
        }


// 主播拒绝上麦申请

String userId = "56789";
NERoomService roomService = NERoomKit.getInstance().getService(NERoomService.class);
        NERoomContext roomContext = roomService.getRoomContext(roomUuid);
        if (roomContext != null) {
            roomContext.getSeatController().rejectSeatRequest(userId,new NECallback2<Unit>() {
                @Override
                public void onSuccess(@Nullable Unit unit) {
                    super.onSuccess(unit);
                    Log.d(TAG,"success");
                }

                @Override
                public void onError(int code, @Nullable String message) {
                    super.onError(code, message);
                    Log.d(TAG,"error");
                }
            });
        }

主播将观众移出麦位（踢麦）

API 调用时序

实现方法

主播调用 kickSeat 接口将观众移出麦位。

参数类型描述

user String 待移出麦位的观众的用户 ID。
房间内所有成员会收到主播将观众移出麦位的回调 onSeatKicked 和麦位变更的回调 onSeatListChanged。

参数	类型	描述
user	String	待移出麦位的观众的用户 ID。

示例代码

String userId = "56789";
NERoomService roomService = NERoomKit.getInstance().getService(NERoomService.class);
        NERoomContext roomContext = roomService.getRoomContext(roomUuid);
        if (roomContext != null) {
             roomContext.getSeatController().kickSeat(userId,new NECallback2<Unit>() {
                 @Override
                 public void onSuccess(@Nullable Unit unit) {
                     super.onSuccess(unit);
                     Log.d(TAG,"success");
                 }

                 @Override
                 public void onError(int code, @Nullable String message) {
                     super.onError(code, message);
                     Log.d(TAG,"error");
                 }
             });
        }

观众取消申请上麦

API 调用时序

实现方法

观众调用 cancelSeatRequest 接口取消申请上麦。
取消申请上麦后，主播收到观众取消上麦的回调 onSeatRequestCancelled和麦位变更的回调 onSeatListChanged。

示例代码

NERoomService roomService = NERoomKit.getInstance().getService(NERoomService.class);
        NERoomContext roomContext = roomService.getRoomContext(roomUuid);
        if (roomContext != null) {
             roomContext.getSeatController().cancelSeatRequest(new NECallback2<Unit>() {
                 @Override
                 public void onSuccess(@Nullable Unit unit) {
                     super.onSuccess(unit);
                     Log.d(TAG,"success");
                 }

                 @Override
                 public void onError(int code, @Nullable String message) {
                     super.onError(code, message);
                     Log.d(TAG,"error");
                 }
             });
        }

观众主动下麦

API 调用时序

实现方法

观众调用 leaveSeat 接口下麦。
下麦成功后，房间内所有成员收到观众成功下麦的回调 onSeatLeave和麦位变更的回调 onSeatListChanged。

示例代码

NERoomService roomService = NERoomKit.getInstance().getService(NERoomService.class);
        NERoomContext roomContext = roomService.getRoomContext(roomUuid);
        if (roomContext != null) {
             roomContext.getSeatController().leaveSeat(new NECallback2<Unit>() {
                 @Override
                 public void onSuccess(@Nullable Unit unit) {
                     super.onSuccess(unit);
                     Log.d(TAG,"success");
                 }

                 @Override
                 public void onError(int code, @Nullable String message) {
                     super.onError(code, message);
                     Log.d(TAG,"error");
                 }
             });
        }

在线咨询

微信咨询

电话咨询

此文档是否对你有帮助？

有帮助

去反馈

注意事项
添加麦位事件监听
主播邀请观众上麦（抱麦）
API 调用时序图
实现方法
示例代码
观众申请上麦
API 调用时序
实现方法
示例代码
主播将观众移出麦位（踢麦）
API 调用时序
实现方法
示例代码
观众取消申请上麦
API 调用时序
实现方法
示例代码
观众主动下麦
API 调用时序
实现方法
示例代码