管理语聊房麦位
- iOS
更新时间
了解语聊房在不同平台上的管理语聊房麦位方式,包括接入流程、关键配置和平台差异。
本文介绍如何在语聊房中进行麦位管理。麦位管理包含如下操作:
- 上麦:听众与房主连麦,连麦听众可以发言,与房主语音互动。
- 下麦:连麦听众下麦后成为普通听众,无法发言也无法与房主语音互动。
- 静音:房主不允许某个连麦听众发言。
- 锁麦:房主不允许任何用户占据该麦位。
- 换麦:连麦听众从一个麦位更换到另一个麦位。
示例项目
声网在 agora-ent-scenarios 仓库中提供麦位管理的源代码供你参考。
前提条件
实现基础功能
实现该进阶功能前,请确保你已实现基础的语聊房功能,例如登录即时通讯系统、获取房间列表、创建房间、加入房间。详见实现语聊房。
注册回调
进行麦位管理前,你需要通过声网云服务中 ChatRoomServiceImp 类的 subscribeEvent 方法注册回调事件,监听房间内的回调事件。
ChatRoomServiceImp.getSharedInstance().subscribeEvent(with: self)上麦
本节介绍如何让听众上麦并在麦位上发送音频流。上麦的方式分为房主邀请或听众主动申请。
房主邀请上麦
房主邀请上麦的流程图如下:
具体实现步骤如下:
-
房主调用
ChatRoomServiceImp类的startMicSeatInvitation方法,开始邀请听众上麦。Swift // 邀请上麦 private func inviteUser(user: VRUser?) { SVProgressHUD.show() let chat_uid: String = user?.chat_uid ?? "" ChatRoomServiceImp.getSharedInstance().startMicSeatInvitation(chatUid: chat_uid, index: idx < 0 ? nil:idx) { error, flag in SVProgressHUD.dismiss() self.view.makeToast(flag == true ? "Invitation sent!".localized() : "Invited failed!".localized()) } } -
房间内其他所有用户都通过
subscribeEvent注册的onReceiveSeatInvitation回调获取房主邀请上麦的通知。Swift // 接收到邀请通知 func onReceiveSeatInvitation(roomId: String, user: VRUser) { self.showInviteMicAlert(index: user.mic_index) } -
收到房主上麦邀请的听众会看到邀请弹窗,听众可以选择是否接受邀请:
- 调用
ChatRoomServiceImp类的acceptMicSeatInvitation方法接受邀请。 - 调用
ChatRoomServiceImp类的refuseInvite方法拒绝邀请。
Swift // 接受邀请 func agreeInvite(index: Int?) { var idx: Int? if index != -1, index != 0 { idx = index } ChatRoomServiceImp.getSharedInstance().acceptMicSeatInvitation(index: idx,completion: { error, mic in if error == nil,let mic = mic { self.rtcView.updateUser(mic) self.local_index = mic.mic_index self.rtckit.setClientRole(role: .owner) self.chatBar.refresh(event: .handsUp, state: .disable, asCreator: self.isOwner) self.chatBar.refresh(event: .mic, state: .unSelected, asCreator: self.isOwner) self.rtckit.muteLocalAudioStream(mute: mic.status != 0) self.checkEnterSeatAudioAuthorized() } else { self.view.makeToast("\(error?.localizedDescription ?? "")",point: self.toastPoint, title: nil, image: nil, completion: nil) } }) }Swift // 拒绝邀请 func refuse() { ChatRoomServiceImp.getSharedInstance().refuseInvite(chat_uid: self.roomInfo?.room?.owner?.chat_uid ?? "") { _, _ in } } - 调用
-
如果听众接受上麦邀请,那么你需要让房内其他用户都收到麦位更新的通知。
Swift // 麦位更新 func onSeatUpdated(roomId: String, mics: [VRRoomMic], from fromId: String) { self.updateMic(mics, fromId: fromId) }信息
房主邀请多个听众上麦时,如果多个听众同时点击接受上麦邀请,那么可能出现听众 A 刚上麦就被后面上麦的用户 B 踢下麦位。因此,为了避免多个听众同时主动修改麦位时造成互踢的冲突,声网推荐你在集成逻辑中控制上麦由房主决定,而不是听众决定。
听众申请上麦
听众申请上麦的流程图如下:
具体实现步骤如下:
-
听众调用
ChatRoomServiceImp类的startMicSeatApply方法向房主发送申请上麦的请求。Swift // 申请上麦 func requestSpeak(index: Int?) { ChatRoomServiceImp.getSharedInstance().startMicSeatApply(index: index) { error, flag in if error == nil { if flag { self.chatBar.refresh(event: .handsUp, state: .selected, asCreator: false) self.view.makeToast("Apply success!".localized(), point: self.toastPoint, title: nil, image: nil, completion: nil) } else { self.view.makeToast("Apply failed!".localized(), point: self.toastPoint, title: nil, image: nil, completion: nil) } } else { } } } -
(可选)如果听众希望取消上麦申请,可以调用
ChatRoomServiceImp类的cancelMicSeatApply方法。Swift // 听众取消自己的上麦申请 func cancelRequestSpeak(index: Int?) { ChatRoomServiceImp.getSharedInstance().cancelMicSeatApply(chat_uid: self.roomInfo?.room?.owner?.chat_uid ?? "") { error, flag in if error == nil { self.view.makeToast("Cancel apply success!".localized(), point: self.toastPoint, title: nil, image: nil, completion: nil) self.chatBar.refresh(event: .handsUp, state: .unSelected, asCreator: false) } else { self.view.makeToast("Cancel apply failed!".localized(), point: self.toastPoint, title: nil, image: nil, completion: nil) } } } -
房主通过
subscribeEvent注册的onReceiveSeatRequest回调获取听众申请上麦的信息更新,从而刷新上麦申请列表。Swift // 房主收到申请上麦信息 func onReceiveSeatRequest(roomId: String, applicant: VoiceRoomApply) { self.chatBar.refresh(event: .handsUp, state: .unSelected, asCreator: true) } -
房主调用
ChatRoomServiceImp类的acceptMicSeatApply方法,以同意某个听众的上麦申请。Swift // 房主同意听众上麦申请 private func agreeUserApply(user: VoiceRoomApply?) { SVProgressHUD.show() guard let user1 = user?.member else { return } ChatRoomServiceImp.getSharedInstance().acceptMicSeatApply(chatUid: user1.chat_uid ?? "", completion: { error,mic in SVProgressHUD.dismiss() if self.agreeApply != nil,let mic = mic { self.agreeApply!(mic) } self.tableView.reloadData() let warningMessage = (error == nil ? "Agree success!".localized():"Agree failed!".localized()) self.view.makeToast(warningMessage) }) } -
如果房主同意某个听众的上麦申请,那么你需要让房内其他用户都收到麦位更新的通知。
Swift // 收到同意申请上麦 func onSeatUpdated(roomId: String, mics: [VRRoomMic], from fromId: String) { self.updateMic(mics, fromId: fromId) }
切换用户角色
不管是房主邀请,还是听众主动申请,在听众成为连麦听众后,你需要调用声网实时互动 SDK 中 setClientRole 方法将其角色从听众(audience)切换成主播(broadcaster),以让连麦听众拥有发送音频流的权限。
rtcKit.setClientRole(.broadcaster)下麦
本节介绍如何让连麦听众下麦并在下麦后无法发送音频流。下麦的方式分为连麦听众主动下麦和被踢下麦。
主动下麦
连麦听众调用 ChatRoomServiceImp 类的 leaveMic 方法可以主动下麦。
// 主动下麦
func leaveMic(with index: Int) {
chatBar.refresh(event: .mic, state: .selected, asCreator: false)
ChatRoomServiceImp.getSharedInstance().leaveMic(mic_index: index) { error, mic in
if error == nil,let mic = mic {
self.rtcView.updateUser(mic)
self.rtckit.setClientRole(role: .audience)
self.local_index = nil
self.chatBar.refresh(event: .handsUp, state: .unSelected, asCreator: self.isOwner)
self.chatBar.refresh(event: .mic, state: .selected, asCreator: self.isOwner)
}
}
}被踢下麦
房主调用 ChatRoomServiceImp 类的 kickOff 方法可以将连麦听众踢下麦。
// 踢连麦听众下麦
func kickoff(with index: Int) {
ChatRoomServiceImp.getSharedInstance().kickOff(mic_index: index) { error, mic in
if error == nil,let mic = mic {
self.rtcView.updateUser(mic)
}
}
}麦位更新回调
不管是连麦听众主动下麦还是被踢下麦,在连麦听众成为普通听众后,你需要让房内其他用户都收到麦位更新的通知。
func onSeatUpdated(roomId: String, mics: [VRRoomMic], from fromId: String) {
self.updateMic(mics, fromId: fromId)
}切换用户角色
不管是连麦听众主动下麦还是被踢下麦,在连麦听众成为普通听众后,你需要调用声网实时互动 SDK 中 setClientRole 方法将其角色从主播(broadcaster)切换成听众(audience),以让其失去发送音频流的权限。
rtcKit.setClientRole(.audience)设置是否静音
听众上麦后,你可以设置麦位是否静音,以达到禁言的目的。将麦位静音意味着不允许该连麦听众发言;将麦位取消静音意味着恢复该连麦听众发言的权限。
麦位静音
你可以通过 ChatRoomServiceImp 类的 forbidMic 方法将某个麦位标记为静音。
// 禁言指定麦位
func mute(with index: Int) {
ChatRoomServiceImp.getSharedInstance().forbidMic(mic_index: index) { error, mic in
if error == nil,let mic = mic {
self.rtcView.updateUser(mic)
}
}
}麦位取消静音
你可以通过 ChatRoomServiceImp 类的 unForbidMic 方法将某个麦位标记为取消静音。
// 取消禁言指定麦位
func unMute(with index: Int) {
if let user = roomInfo?.mic_info?[index] {
if user.status == 1 && index != 0 && isOwner { return }
}
ChatRoomServiceImp.getSharedInstance().unForbidMic(mic_index: index) { error, mic in
if error == nil {
self.chatBar.refresh(event: .handsUp, state: .unSelected, asCreator: false)
if let mic = mic {
self.rtcView.updateUser(mic)
}
}
}
}麦位更新回调
将麦位静音或取消静音后,你需要让房内其他用户收到麦位更新的通知。
func onSeatUpdated(roomId: String, mics: [VRRoomMic], from fromId: String) {
self.updateMic(mics, fromId: fromId)
}停止或恢复发送音频流
标记麦位静音或取消静音后,通过声网实时互动 SDK 中 muteLocalAudioStream 方法停止发送或恢复发送麦位上的连麦听众的音频流,以达到静音或取消静音的效果。
// 参数 mute 为 true 代表静音
// 参数 mute 为 false 代表取消静音
public func muteLocalAudioStream(mute: Bool) -> Int32 {
return rtcKit.muteLocalAudioStream(mute)
}设置是否锁麦
锁麦意味着不允许任何用户占据该麦位。将某个麦位锁住后,用户无法占据该麦位。将某个麦位解锁后,麦位恢复空闲状态,用户可以占据该麦位。
锁麦
你可以调用 ChatRoomServiceImp 类的 lockMic 方法将某个麦位锁住。
// 锁麦
func lock(with index: Int) {
ChatRoomServiceImp.getSharedInstance().lockMic(mic_index: index) { error, mic in
if error == nil,let mic = mic {
self.rtcView.updateUser(mic)
}
}
}取消锁麦
你可以调用 ChatRoomServiceImp 类的 unLockMic 方法将某个麦位解锁。
// 取消锁麦
func unLock(with index: Int) {
ChatRoomServiceImp.getSharedInstance().unLockMic(mic_index: index) { error, mic in
if error == nil,let mic = mic {
self.rtcView.updateUser(mic)
}
}
}麦位更新回调
将麦位锁住或解锁后,你需要让房内其他用户收到麦位更新的通知。
func onSeatUpdated(roomId: String, mics: [VRRoomMic], from fromId: String) {
self.updateMic(mics, fromId: fromId)
}换麦
换麦指将连麦听众从当前麦位更换到另一个空闲麦位。
-
调用
ChatRoomServiceImp类的changeMic方法更换麦位。Swift func changeMic(from: Int, to: Int) { if let mic: VRRoomMic = roomInfo?.mic_info?[to] { if mic.status == 3 || mic.status == 4 { view.makeToast("Mic Closed".localized()) return } } ChatRoomServiceImp.getSharedInstance().changeMic(old_index: from, new_index: to) { error, micMap in if error == nil,let old_mic = micMap?[from],let new_mic = micMap?[to] { self.local_index = to self.roomInfo?.mic_info?[from] = old_mic self.roomInfo?.mic_info?[to] = new_mic self.rtcView.updateUser(old_mic) self.rtcView.updateUser(new_mic) guard let mic = ChatRoomServiceImp.getSharedInstance().mics.first(where: { VoiceRoomUserInfo.shared.user?.chat_uid ?? "" == $0.member?.chat_uid ?? "" }) else { return } self.micMuteManager(mic: mic) } } } -
如果换麦成功,那么此时你需要让房内其他用户收到麦位更新的通知。
Swift func onSeatUpdated(roomId: String, mics: [VRRoomMic], from fromId: String) { self.updateMic(mics, fromId: fromId) }