TUILiveKit 产品动态
云直播推拉流 SDK 产品动态
CoGuestStore 和 LiveSeatStore 在 Android 应用中快速实现语音连麦功能。
CoGuestStore和LiveSeatStore支持以下几个主流的场景:applyForSeat 方法。import io.trtc.tuikit.atomicxcore.api.CompletionHandlerimport io.trtc.tuikit.atomicxcore.api.live.CoGuestStoreval liveId = "房间ID"val guestStore = CoGuestStore.create(liveId)// 用户点击“申请连麦”fun requestToConnect() {// timeout: 请求超时时间,例如 30 秒guestStore.applyForSeat(-1, 30, null, object : CompletionHandler {override fun onSuccess() {print("连麦申请已发送,等待主播处理...")}override fun onFailure(code: Int, desc: String) {print("申请发送失败: $desc")}})}
GuestListener,您可以接收到主播的处理结果。import io.trtc.tuikit.atomicxcore.api.device.DeviceStoreimport io.trtc.tuikit.atomicxcore.api.live.GuestListenerimport io.trtc.tuikit.atomicxcore.api.live.LiveUserInfo// 在您的 Activity/Fragment 初始化时添加监听fun subscribeGuestEvents() {val guestListener = object : GuestListener() {override fun onGuestApplicationResponded(isAccept: Boolean, hostUser: LiveUserInfo) {if (isAccept) {print("主播 ${hostUser.userName} 同意了你的申请,准备上麦")// 1. 打开摄像头、麦克风DeviceStore.shared().openLocalCamera(true, null)DeviceStore.shared().openLocalMicrophone(null)// 2. 在此更新 UI,例如关闭申请按钮,显示连麦中的状态} else {print("主播 ${hostUser.userName} 拒绝了你的申请")// 弹窗提示用户申请被拒绝}}}guestStore.addGuestListener(guestListener)}
disConnect 方法即可返回普通观众状态。// 用户点击“下麦”按钮fun leaveSeat() {guestStore.disconnect(object : CompletionHandler {override fun onSuccess() {print("已成功下麦")}override fun onFailure(code: Int, desc: String) {print("下麦失败: $desc")}})}
cancelApplication。// 用户在等待时,点击“取消申请”fun cancelRequest() {guestStore.cancelApplication(object : CompletionHandler {override fun onSuccess() {print("申请已取消")}override fun onFailure(code: Int, desc: String) {print("申请取消失败: $desc")}})}
HostListener,您可以在有新观众申请时立即收到通知,并给出提示。import io.trtc.tuikit.atomicxcore.api.live.CoGuestStoreimport io.trtc.tuikit.atomicxcore.api.live.HostListenerimport io.trtc.tuikit.atomicxcore.api.live.LiveUserInfoval liveId = "房间ID"val guestStore = CoGuestStore.create(liveId)// 订阅主播事件val hostListener = object : HostListener() {override fun onGuestApplicationReceived(guestUser: LiveUserInfo) {print("收到观众 ${guestUser.userName} 的连麦申请")// 在此更新 UI,例如在“申请列表”按钮上显示红点}// ... 覆盖其他需要的回调方法}guestStore.addHostListener(hostListener)
CoGuestStore 的 state 会实时维护当前的申请者列表,您可以订阅它来刷新您的 UI。import kotlinx.coroutines.CoroutineScopeimport kotlinx.coroutines.Dispatchersimport kotlinx.coroutines.launch// 订阅状态变更fun observeApplicants() {CoroutineScope(Dispatchers.Main).launch {guestStore.coGuestState.applicants.collect { applicants ->print("当前申请人数: ${applicants.size}")// 在此刷新您的“申请者列表”UI}}}
// 主播点击“同意”按钮,传入申请者的 userIDfun accept(userId: String) {guestStore.acceptApplication(userId,object : CompletionHandler {override fun onSuccess() {print("已同意 $userId 的申请,对方正在上麦")}override fun onFailure(code: Int, desc: String) {print("同意申请失败: $desc")}})}// 主播点击“拒绝”按钮fun reject(userId: String) {guestStore.rejectApplication(userId,object : CompletionHandler {override fun onSuccess() {print("已拒绝 $userId 的申请")}override fun onFailure(code: Int, desc: String) {print("拒绝申请失败: $desc")}})}
inviteToSeat 方法。// 主播选择观众并发起邀请fun invite(userId: String) {// timeout: 邀请超时时间guestStore.inviteToSeat(userId, -1, 30, null, object : CompletionHandler {override fun onSuccess() {print("已向 $userId 发出邀请,等待对方回应...")}override fun onFailure(code: Int, desc: String) {print("邀请发送失败: $desc")}})}
HostListener 监听 onHostInvitationResponded 事件。// 在 hostListener 的实现中添加override fun onHostInvitationResponded(isAccept: Boolean, guestUser: LiveUserInfo) {if (isAccept) {print("观众 ${guestUser.userName} 接受了你的邀请")} else {print("观众 ${guestUser.userName} 拒绝了你的邀请")}}
GuestListener 监听 onHostInvitationReceived 事件。// 在 guestListener 的实现中添加override fun onHostInvitationReceived(hostUser: LiveUserInfo) {print("收到主播 ${hostUser.userName} 的连麦邀请")// 在此弹出一个对话框,让用户选择“接受”或“拒绝”}
val inviterId = "发起邀请的主播ID" // 从 onHostInvitationReceived 事件中获取// 用户点击“接受”fun accept() {guestStore.acceptInvitation(inviterId, object : CompletionHandler {override fun onSuccess() {// 2. 打开麦克风DeviceStore.shared().openLocalMicrophone(null)}override fun onFailure(code: Int, desc: String) {print("接受邀请失败: $desc")}})}// 用户点击“拒绝”fun reject() {guestStore.rejectInvitation(inviterId, object : CompletionHandler {override fun onSuccess() {// ...}override fun onFailure(code: Int, desc: String) {// ...}})}
LiveSeatStore 提供,它可以与 CoGuestStore 协同工作。LiveSeatStore 提供的接口来控制自己的麦克风静音状态。muteMicrophone() 方法。这是一个无回调的单向请求。unmuteMicrophone(completion) 方法。import io.trtc.tuikit.atomicxcore.api.live.LiveSeatStoreval seatStore = LiveSeatStore.create(liveId)seatStore.muteMicrophone() //静音seatStore.unmuteMicrophone(null) //解除静音
参数 | 类型 | 描述 |
completion | CompletionHandler? | 操作完成后的回调。 |
closeRemoteMicrophone 会强制关闭对方的麦克风,并锁定对方的麦克风权限。此时,被静音的用户会收到 LiveSeatListener 中的 onLocalMicrophoneClosedByAdmin 事件,此时其本地的“打开麦克风”按钮应变为不可点击状态。openRemoteMicrophone 并非强制打开对方麦克风,而是解除对方的“锁定状态”,允许对方自行开麦。此时,被操作的用户会收到 onLocalMicrophoneOpenedByAdmin 事件,其本地的“打开麦克风”按钮应恢复为可点击状态,但用户仍处于静音中。LiveSeatStore 的 unmuteMicrophone()方法解除静音,才能让房间内其他人听到自己的声音。import io.trtc.tuikit.atomicxcore.api.CompletionHandlerimport io.trtc.tuikit.atomicxcore.api.live.DeviceControlPolicyval targetUserId = "userD"// 1. 强制静音 userD 并锁定seatStore.closeRemoteMicrophone(targetUserId, object : CompletionHandler {override fun onSuccess() {print("已将 $targetUserId 静音并锁定")}override fun onFailure(code: Int, desc: String) {print("操作失败: $desc")}})// 2. 解锁 userD 的麦克风权限(此时 userD 依然是静音状态)seatStore.openRemoteMicrophone(targetUserId, DeviceControlPolicy.UNLOCK_ONLY, object : CompletionHandler {override fun onSuccess() {print("已邀请 $targetUserId 打开麦克风(已解锁)")}override fun onFailure(code: Int, desc: String) {print("操作失败: $desc")}})
import io.trtc.tuikit.atomicxcore.api.live.DeviceControlPolicyimport io.trtc.tuikit.atomicxcore.api.live.LiveSeatListener// userD监听主播的操作val seatListener = object : LiveSeatListener() {override fun onLocalMicrophoneClosedByAdmin() {print("被主播静音了")}override fun onLocalMicrophoneOpenedByAdmin(policy: DeviceControlPolicy) {print("主播已解除静音锁定")}}seatStore.addLiveSeatEventListener(seatListener)
参数 | 类型 | 描述 |
userID | String | 被操作的用户 userID。 |
completion | CompletionHandler? | 请求完成后的回调。 |
参数 | 类型 | 描述 |
userID | String | 被操作的用户 userID。 |
completion | CompletionHandler? | 请求完成后的回调。 |
kickUserOutOfSeat 方法,强制将指定用户踢下麦位。GuestListener 中的 onKickedOffSeat 事件通知。// 假设要踢走 "userB"val targetUserId = "userB"seatStore.kickUserOutOfSeat(targetUserId, object : CompletionHandler {override fun onSuccess() {print("已将 $targetUserId 踢下麦位")}override fun onFailure(code: Int, desc: String) {print("踢人失败: $desc")}})// "userB" 在 GuestListener 中收到被踢下麦事件override fun onKickedOffSeat(seatIndex: Int, hostUser: LiveUserInfo) {// 弹toast提示}
参数 | 类型 | 描述 |
userID | String | 被踢下麦用户 userID。 |
completion | CompletionHandler? | 请求完成后的回调。 |
lockSeat 方法锁定指定索引的麦位,麦位被锁定后,观众无法通过 applyForSeat 或takeSeat 占用该麦位。unlockSeat 可以解锁麦位,解锁后该麦位可以再次被占用。// 锁定2号麦位seatStore.lockSeat(2, object : CompletionHandler {override fun onSuccess() {print("2号麦位已锁定")}override fun onFailure(code: Int, desc: String) {print("锁定失败: $desc")}})// 解锁2号麦位seatStore.unlockSeat(2, object : CompletionHandler {override fun onSuccess() {print("2号麦位已解锁")}override fun onFailure(code: Int, desc: String) {print("解锁失败: $desc")}})
参数 | 类型 | 描述 |
seatIndex | Int | 需要锁定的麦位索引。 |
completion | CompletionHandler? | 请求完成后的回调。 |
参数 | 类型 | 描述 |
seatIndex | Int | 需要解锁的麦位索引。 |
completion | CompletionHandler? | 请求完成后的回调。 |
moveUserToSeat移动麦位。userID 传入目标用户的 ID,targetIndex是目标麦位索引,policy 参数来指定如果目标麦位有人时的移动策略,详见接口参数说明。userID 必须传入用户自己的 ID,targetIndex 传入想去的新麦位索引,此时policy 参数无效,如果目标麦位有人时会报错并停止移动。import io.trtc.tuikit.atomicxcore.api.CompletionHandlerimport io.trtc.tuikit.atomicxcore.api.live.MoveSeatPolicyseatStore.moveUserToSeat("userC",newSeatIndex,MoveSeatPolicy.ABORT_WHEN_OCCUPIED,object : CompletionHandler {override fun onSuccess() {print("已成功移动到 $newSeatIndex 号麦位")}override fun onFailure(code: Int, desc: String) {print("换座失败,可能位置有人了: $desc")}})
参数 | 类型 | 描述 |
userID | String | 需要移麦的用户 userID。 |
targetIndex | Int | 目标麦位索引。 |
policy | MoveSeatPolicy? | 目标麦位有人时的移动策略枚举: abortWhenOccupied:目标麦位有人时放弃移动(默认策略)forceReplace:强制替换目标麦位上的用户,被替换的用户将会被踢下麦swapPosition:与目标麦位用户交换位置。 |
completion | CompletionHandler? | 请求完成后的回调。 |
LiveCoreView 作为核心组件来渲染主播和连麦观众的视频流。UI 的重点是处理视频画面的布局、大小,以及通过 VideoViewAdapter 在视频流上添加挂件(例如昵称、占位图)。您可以同时打开摄像头,麦克风。LiveCoreView,而是会基于 LiveSeatStore 的 state(特别是 seatList)来构建一个网格 UI(例如 RecyclerView)。UI 的重点是实时显示每个麦位 SeatInfo 的状态:是否有人、是否静音、是否被锁定 ,以及是否正在说话。您只需要打开麦克风。LiveSeatState 中的 seatList 属性,它是一个 List<SeatInfo> 数组类型的响应式数据,每当数组变化时都会通知您重新渲染麦位列表。遍历此数组,您可以:seatInfo.userInfo 来获取麦位上用户信息。seatInfo.isLocked 判断麦位是否被锁定。seatInfo.userInfo.microphoneStatus 判断麦上用户的麦克风状态。DeviceStore 管理的是物理设备,而 LiveSeatStore 管理的是麦位业务(即音频流)。DeviceStore:openLocalMicrophone:向系统请求权限并启动麦克风设备进行音频采集。这是一个“重”操作。closeLocalMicrophone:停止音频采集并释放麦克风设备。LiveSeatStore:muteMicrophone:静音。停止向远端发送本地的音频流,但麦克风设备本身仍在运行。unmuteMicrophone:解除静音。恢复向远端发送音频流。openLocalMicrophone来启动设备。unmuteMicrophone和 muteMicrophone来控制上行音频流的通断。disconnect),调用closeLocalMicrophone来释放设备。文档反馈