tencent cloud

实时音视频

动态与公告
产品动态
产品近期公告
关于 TRTC Live 正式上线的公告
关于TRTC Conference 正式版上线的公告
Conference 商业化版本即将推出
关于多人音视频 Conference 开启内测公告
关于音视频通话 Call 正式版上线的公告
关于腾讯云音视频终端 SDK 播放升级及新增授权校验的公告
关于 TRTC 应用订阅套餐服务上线的相关说明
产品简介
产品概述
基本概念
产品功能
产品优势
应用场景
性能数据
购买指南
计费概述
免费时长说明
月订阅
现收现付
TRTC 逾期与暂停政策
常见问题解答
退款说明
新手指引
Demo 体验
视频通话 SDK
组件介绍
开通服务
跑通 Demo
快速接入
离线唤醒
会话聊天
云端录制
AI 降噪
界面定制
Chat 集成通话能力
更多特性
无 UI 集成
服务端 API
客户端 API
解决方案
错误码表
发布日志
常见问题
视频会议 SDK
组件介绍(TUIRoomKit)
开通服务(TUIRoomKit)
跑通 Demo(TUIRoomKit)
快速接入(TUIRoomKit)
屏幕共享(TUIRoomKit)
预定会议(TUIRoomKit)
会中呼叫(TUIRoomKit)
界面定制(TUIRoomKit)
虚拟背景(TUIRoomKit)
会议控制(TUIRoomKit)
云端录制(TUIRoomKit)
AI 降噪(TUIRoomKit)
会中聊天(TUIRoomKit)
机器人推流(TUIRoomKit)
更多特性(TUIRoomKit)
客户端 API(TUIRoomKit)
服务端 API(TUIRoomKit)
常见问题(TUIRoomKit)
错误码 (TUIRoomKit)
SDK更新日志(TUIRoomKit)
直播与语聊 SDK
Live 视频直播计费说明
组件介绍
开通服务(TUILiveKit)
跑通 Demo
无 UI 集成
UI 自定义
直播监播
视频直播
语聊房
高级功能
客户端 API
服务端 API
错误码
发布日志
常见问题
RTC Engine
开通服务
SDK 下载
API-Example
接入指引
API-参考手册
高级功能
AI 集成
概述
MCP 配置
Skills 配置
集成指南
常见问题
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
控制台指南
应用管理
套餐包管理
用量统计
监控仪表盘
开发辅助
解决方案
实时合唱
常见问题
迁移指南
计费相关
功能相关
UserSig 相关
应对防火墙限制相关
缩减安装包体积相关
Andriod 与 iOS 相关
Web 端相关
Flutter 相关
Electron 相关
TRTCCalling Web 相关
音视频质量相关
其他问题
旧版文档
RTC RoomEngine SDK(旧)
集成 TUIRoom (Web)
集成 TUIRoom (Android)
集成 TUIRoom (iOS)
集成 TUIRoom (Flutter)
集成 TUIRoom (Electron)
TUIRoom API 查询
实现云端录制与回放(旧)
监控仪表盘计费(旧)
协议与策略
安全合规认证
安全白皮书
信息安全说明
服务等级协议
苹果隐私策略:PrivacyInfo.xcprivacy
TRTC 政策
隐私协议
数据处理和安全协议
词汇表

主播 PK

PDF
聚焦模式
字号
最后更新时间: 2025-04-30 11:23:42
本文档主要介绍如何使用 RTC Room Engine SDK 实现主播 PK 功能。

前提条件

在使用 RTC RoomEngine SDK前,您需要先调用 登录 SDK,以便后续功能正常使用。

使用指引

说明:
使用 PK 功能时,请确保您已开播。

发起 PK 请求

您首先需要通过 getLiveBattleManager 接口获取 TUILiveBattleManager插件。
然后再使用 TUILiveBattleManager 插件的 requestBattle 接口实现该功能,传入三个参数:PK 配置信息、邀请 PK 的主播的用户Id和超时时长。
PK 配置信息是一个 TUIBattleConfig 的结构体,在配置时,您一般只需设置其中的 PK 持续时间 duration 即可。
以邀请用户 Id 为 100001 的主播 PK 为例:
iOS
Android
import RTCRoomEngine

let battleManager = TUIRoomEngine.sharedInstance().getLiveBattleManager()
let config = TUIBattleConfig()
config.duration = 30 // 请将其替换为您的PK持续时间,单位为秒
let userIds = ["100001"] // 请将其替换为您想与之PK的主播的用户Id
let timeout = 30 // 请将这里替换成您申请上麦的超时时间,单位秒,如果设置为 0,SDK 不会做超时检测,也不会触发超时回调

battleManager.requestBattle(config: config,
userIdList: userIds,
timeout: TimeInterval(timeout)) { battleInfo, battleResults in
// 发起 PK 请求成功, battleId:battleInfo.battleId
} onError: { code, message in
// 发起 PK 请求失败
}
TUILiveBattleManager battleManager = TUIRoomEngine.sharedInstance().getLiveBattleManager();
TUILiveBattleManager.BattleConfig config = new TUILiveBattleManager.BattleConfig();
config.duration = 30; // 请将其替换为您的PK持续时间,单位为秒
List<String> userIds = Collections.singletonList("100001"); // 请将其替换为您想与之PK的主播的用户Id
int timeout = 30; // 请将这里替换成您申请上麦的超时时间,单位秒,如果设置为 0,SDK 不会做超时检测,也不会触发超时回调


battleManager.requestBattle(config, userIds, timeout, new TUILiveBattleManager.BattleRequestCallback() {
@Override
public void onSuccess(TUILiveBattleManager.BattleInfo battleInfo, Map<String, TUILiveBattleManager.BattleCode> resultMap) {
// 发起 PK 请求成功, battleId:battleInfo.battleId
}
@Override
public void onError(TUICommonDefine.Error error, String message) {
// 发起 PK 请求失败
}
});
若您通过 addObserver 接口成为了 TUILiveBattleManager 插件的观察者,则当有人申请和您连线时,您会收到 onBattleRequestReceived 回调,您可通过 acceptBattle / rejectBattle 接口接受或拒绝该请求。
iOS
Android
func onBattleRequestReceived(battleInfo: TUIBattleInfo,
inviter: TUIBattleUser,
invitee: TUIBattleUser) {
// 接受 PK 请求
let battleManager = TUIRoomEngine.sharedInstance().getLiveBattleManager()
battleManager.acceptBattle(battleId: battleInfo.battleId) {
// 接受 PK 请求成功
} onError: { code, message in
// 接受 PK 请求失败
}

// 拒绝 PK 请求
battleManager.rejectBattle(battleId: battleInfo.battleId) {
// 拒绝 PK 请求成功
} onError: { code, message in
// 拒绝 PK 请求失败
}
}
public void onBattleRequestReceived(TUILiveBattleManager.BattleInfo battleInfo, TUILiveBattleManager.BattleUser inviter, TUILiveBattleManager.BattleUser invitee) {
// 接受 PK 请求
TUILiveBattleManager battleManager = TUIRoomEngine.sharedInstance().getLiveBattleManager();
battleManager.acceptBattle(battleInfo.battleId, new TUIRoomDefine.ActionCallback() {
@Override
public void onSuccess() {
// 接受 PK 请求成功
}
@Override
public void onError(TUICommonDefine.Error error, String message) {
// 接受 PK 请求失败
}
});

// 拒绝 PK 请求
battleManager.rejectBattle(battleInfo.battleId, new TUIRoomDefine.ActionCallback() {
@Override
public void onSuccess() {
// 拒绝 PK 请求成功
}

@Override
public void onError(TUICommonDefine.Error error, String message) {
// 拒绝 PK 请求失败
}
});
}

放弃 PK 请求

您首先需要通过 getLiveBattleManager 接口获取 TUILiveBattleManager插件。
然后再使用 TUILiveBattleManager 插件的 cancelBattleRequest 接口实现该功能,传入两个参数:发起 PK 请求成功后battleInfo的battleId 和 放弃 PK 邀请的主播用户 Id。
以放弃和用户Id为 100001 的主播 PK 请求为例:
iOS
Android
let battleManager = TUIRoomEngine.sharedInstance().getLiveBattleManager()
let battleId = "" // 请将其替换为您调用requestBattle请求PK成功后battleInfo中的battleId值
let userIds = ["100001"] // 请将其替换为您邀请PK的主播的用户Id
battleManager.cancelBattleRequest(battleId: battleId, userIdList: userIds) {
// 放弃 PK 请求成功
} onError: { code, message in
// 放弃 PK 请求失败
}
TUILiveBattleManager battleManager = TUIRoomEngine.sharedInstance().getLiveBattleManager();
String battleId = ""; // 请将其替换为您调用requestBattle请求PK成功后battleInfo中的battleId值
List<String> userIds = Collections.singletonList("100001"); // 请将其替换为您邀请PK的主播的用户Id
battleManager.cancelBattleRequest(battleId, userIds, new TUIRoomDefine.ActionCallback() {
@Override
public void onSuccess() {
// 放弃 PK 请求成功
}
@Override
public void onError(TUICommonDefine.Error error, String message) {
// 放弃 PK 请求失败
}
});

退出 PK

您首先需要通过 getLiveBattleManager 接口获取 TUILiveBattleManager插件。
然后再使用 TUILiveBattleManager 插件的 exitBattle 接口,传入参数:发起 PK 请求 成功后battleInfo的battleId ,实现退出当前正在进行的 PK。
iOS
Android
import RTCRoomEngine

let battleManager = TUIRoomEngine.sharedInstance().getLiveBattleManager()
let battleId = "" // 请将其替换为您调用requestBattle请求PK成功后battleInfo中的battleId值
battleManager.exitBattle(battleId: battleId) {
// 退出 PK 成功
} onError: { code, message in
// 退出 PK 失败
}
TUILiveBattleManager battleManager = TUIRoomEngine.sharedInstance().getLiveBattleManager();
String battleId = ""; // 请将其替换为您调用requestBattle请求PK成功后battleInfo中的battleId值
battleManager.exitBattle(battleId, new TUIRoomDefine.ActionCallback() {
@Override
public void onSuccess() {
// 退出 PK 成功
}
@Override
public void onError(TUICommonDefine.Error error, String message) {
// 退出 PK 失败
}
});

监听回调

iOS
Android
您可通过调用 addObserver 成为 TUILiveBattleManager 的观察者,监听 PK 相关的回调。
AnchorBattleController 成为观察者为例:
import RTCRoomEngine

class AnchorBattleController: NSObject, TUILiveBattleObserver {
override init() {
super.init()
TUIRoomEngine.sharedInstance().getLiveBattleManager().addObserver(self)
}
deinit {
TUIRoomEngine.sharedInstance().getLiveBattleManager().removeObserver(self)
}
// PK 开始时触发
func onBattleStarted(battleInfo: TUIBattleInfo) {
// PK 开始了, battleId:battleInfo.battleId
}
// PK 结束时触发
func onBattleEnded(battleInfo: TUIBattleInfo, reason: TUIBattleStoppedReason) {
// PK 结束了, battleId:battleInfo.battleId
}
// 有新主播加入 PK 时触发
func onUserJoinBattle(battleId: String, battleUser: TUIBattleUser) {
// battleUser.userName加入了 PK
}
// 正在 PK 的主播离开了 PK 时触发
func onUserExitBattle(battleId: String, battleUser: TUIBattleUser) {
// battleUser.userName离开了 PK
}
// PK 得分变化时触发
func onBattleScoreChanged(battleId: String, battleUserList: [TUIBattleUser]) {
// PK 得分改变了,第一个用户的比分为: battleUserList.first?.score
}
// 收到 PK 邀请时触发
func onBattleRequestReceived(battleInfo: TUIBattleInfo, inviter: TUIBattleUser, invitee: TUIBattleUser) {
// 收到了来自inviter.userName的 PK 邀请
}
// 收到 PK 邀请被取消时触发
func onBattleRequestCancelled(battleInfo: TUIBattleInfo, inviter: TUIBattleUser, invitee: TUIBattleUser) {
// 来自inviter.userName的 PK 邀请被取消了
}
// 收到 PK 邀请超时触发
func onBattleRequestTimeout(battleInfo: TUIBattleInfo, inviter: TUIBattleUser, invitee: TUIBattleUser) {
// 来自inviter.userName的 PK 邀请超时了
}
// 发出的 PK 邀请被接受时触发
func onBattleRequestAccept(battleInfo: TUIBattleInfo, inviter: TUIBattleUser, invitee: TUIBattleUser) {
// 对invitee.userName的 PK 邀请被接受了
}
// 发出的 PK 邀请被拒绝时触发
func onBattleRequestReject(battleInfo: TUIBattleInfo, inviter: TUIBattleUser, invitee: TUIBattleUser) {
// 对invitee.userName的 PK 邀请被拒绝了
}
}
您可通过调用 addObserver 成为 TUILiveBattleManager 的观察者,监听 PK 相关的回调。
AnchorBattleObserver 成为观察者为例:
class AnchorBattleObserver extends TUILiveBattleManager.Observer {
AnchorBattleObserver() {

TUIRoomEngine.sharedInstance().getLiveBattleManager().addObserver(this);
}

// PK 开始时触发
@Override
public void onBattleStarted(TUILiveBattleManager.BattleInfo battleInfo) {
// PK 开始了, battleId:battleInfo.battleId
}
// PK 结束时触发
@Override
public void onBattleEnded(TUILiveBattleManager.BattleInfo battleInfo, TUILiveBattleManager.BattleStoppedReason reason) {
// PK 结束了, battleId:battleInfo.battleId
}
// 有新主播加入 PK 时触发
@Override
public void onUserJoinBattle(String battleId, TUILiveBattleManager.BattleUser battleUser) {
// battleUser.userName加入了 PK
}
// 正在 PK 的主播离开了 PK 时触发
@Override
public void onUserExitBattle(String battleId, TUILiveBattleManager.BattleUser battleUser) {
// battleUser.userName离开了 PK
}
// PK 得分变化时触发
@Override
public void onBattleScoreChanged(String battleId, List<TUILiveBattleManager.BattleUser> battleUserList) {
// PK 得分改变了,第一个用户的比分为: battleUserList.first?.score
}
// 收到 PK 邀请时触发
@Override
public void onBattleRequestReceived(TUILiveBattleManager.BattleInfo battleInfo, TUILiveBattleManager.BattleUser inviter, TUILiveBattleManager.BattleUser invitee) {
// 收到了来自inviter.userName的 PK 邀请
}
// 收到 PK 邀请被取消时触发
@Override
public void onBattleRequestCancelled(TUILiveBattleManager.BattleInfo battleInfo, TUILiveBattleManager.BattleUser inviter, TUILiveBattleManager.BattleUser invitee) {
// 来自inviter.userName的 PK 邀请被取消了
}
// 收到 PK 邀请超时触发
@Override
public void onBattleRequestTimeout(TUILiveBattleManager.BattleInfo battleInfo, TUILiveBattleManager.BattleUser inviter, TUILiveBattleManager.BattleUser invitee) {
// 来自inviter.userName的 PK 邀请超时了
}
// 发出的 PK 邀请被接受时触发
@Override
public void onBattleRequestAccept(TUILiveBattleManager.BattleInfo battleInfo, TUILiveBattleManager.BattleUser inviter, TUILiveBattleManager.BattleUser invitee) {
// 对invitee.userName的 PK 邀请被接受了
}
// 发出的 PK 邀请被拒绝时触发
@Override
public void onBattleRequestReject(TUILiveBattleManager.BattleInfo battleInfo, TUILiveBattleManager.BattleUser inviter, TUILiveBattleManager.BattleUser invitee) {
// 对invitee.userName的 PK 邀请被拒绝了
}
}

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈