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 政策
隐私协议
数据处理和安全协议
词汇表

TUILiveBattleManager

PDF
聚焦模式
字号
最后更新时间: 2025-04-18 16:40:14
Copyright (c) 2024 Tencent. All rights reserved.
Module: TUILiveBattleManager @ TUIKitEngine
Function: 直播 Battle 相关接口

TUILiveBattleManager

TUILiveBattleObserver

函数列表
描述
收到 Battle 开始的通知
收到 Battle 结束的通知
收到用户加入 Battle 的通知
收到用户退出 Battle 的通知
收到用户 Battle 分数更新的通知
被叫收到 Battle 邀请的通知
被叫收到 Battle 取消的通知
收到 Battle 处理超时的通知
主叫收到被叫同意的通知
主叫收到被叫拒绝的通知

TUILiveBattleManager

函数列表
描述
添加事件回调
移除事件回调
发起 Battle 请求
取消 Battle 请求
接受 Battle 请求
拒绝 Battle 请求
退出 Battle

结构体类型

函数列表
描述
Battle 用户信息
Battle 配置
Battle 信息
Battle 请求结果

枚举类型

枚举类型
描述
Battle 邀请状态
Battle 结束的原因

onBattleStarted

收到 Battle 开始的通知
OnBattleStarted onBattleStarted = (TUIBattleInfo battleInfo) {};
参数
描述
battleInfo
Battle 信息。

onBattleEnded

收到 Battle 结束的通知
OnBattleEnded onBattleEnded = (TUIBattleInfo battleInfo, TUIBattleStoppedReason reason) {};
参数
描述
battleInfo
Battle 信息。
reason
Battle 结束的原因。

onUserJoinBattle

收到用户加入 Battle 的通知
OnUserJoinBattle onUserJoinBattle = (String battleId, TUIBattleUser battleUser) {};
参数
描述
battleId
Battle ID。
battleUser
Battle 用户信息。

onUserExitBattle

收到用户退出 Battle 的通知
OnUserExitBattle onUserExitBattle = (String battleId, TUIBattleUser battleUser) {};
参数
描述
battleId
Battle ID。
battleUser
Battle 用户信息。

onBattleScoreChanged

收到用户 Battle 分数更新的通知
OnBattleScoreChanged onBattleScoreChanged = (String battleId, List<TUIBattleUser> battleUserList) {};
参数
描述
battleId
Battle ID。
battleUserList
Battle 所有用户信息。

onBattleRequestReceived

被叫收到 Battle 邀请的通知
OnBattleRequestReceived onBattleRequestReceived =
(TUIBattleInfo battleInfo,
TUIBattleUser inviter,
TUIBattleUser invitee) {};
参数
描述
battleInfo
Battle 信息。
inviter
发起邀请的用户信息。
invitee
收到邀请的用户信息。

onBattleRequestCancelled

被叫收到 Battle 取消的通知
OnBattleRequestCancelled onBattleRequestCancelled =
(TUIBattleInfo battleInfo,
TUIBattleUser inviter,
TUIBattleUser invitee) {};
参数
描述
battleInfo
Battle 信息。
inviter
发起邀请的用户信息。
invitee
收到邀请的用户信息。

onBattleRequestTimeout

收到 Battle 处理超时的通知
OnBattleRequestTimeout onBattleRequestTimeout =
(TUIBattleInfo battleInfo,
TUIBattleUser inviter,
TUIBattleUser invitee) {};
参数
描述
battleInfo
Battle 信息。
inviter
发起邀请的用户信息。
invitee
收到邀请的用户信息。

onBattleRequestAccept

主叫收到被叫同意的通知
OnBattleRequestAccept onBattleRequestAccept =
(TUIBattleInfo battleInfo,
TUIBattleUser inviter,
TUIBattleUser invitee) {};
参数
描述
battleInfo
Battle 信息。
inviter
发起邀请的用户信息。
invitee
收到邀请的用户信息。

onBattleRequestReject

主叫收到被叫拒绝的通知
OnBattleRequestReject onBattleRequestAccept =
(TUIBattleInfo battleInfo,
TUIBattleUser inviter,
TUIBattleUser invitee) {};
参数
描述
battleInfo
Battle 信息。
inviter
发起邀请的用户信息。
invitee
收到邀请的用户信息。

addObserver

添加事件回调
void addObserver(TUILiveBattleObserver observer);
参数
描述
observer
监听的实例。

removeObserver

移除事件回调
void removeObserver(TUILiveBattleObserver observer);
参数
描述
observer
监听的实例。

requestBattle:userIdList

发起 Battle 请求
Future<TUIValueCallBack<TUIBattleRequestResult>> requestBattle
(TUIBattleConfig config,
List<String> userIdList,
int timeout);
参数
描述
config
Battle 配置信息。
userIdList
待邀请的用户 ID 列表。
timeout
超时时间。

cancelBattleRequest

取消 Battle 请求
Future<TUIActionCallback> cancelBattleRequest(String battleId, List<String> userIdList);
参数
描述
battleId
Battle ID。
userIdList
待取消的用户 ID 列表。

acceptBattle

接受 Battle 请求
Future<TUIActionCallback> acceptBattle(String battleId);
参数
描述
battleId
Battle ID。

rejectBattle

拒绝 Battle 请求
Future<TUIActionCallback> rejectBattle(String battleId);
参数
描述
battleId
Battle ID。

exitBattle

退出 Battle
Future<TUIActionCallback> exitBattle(String battleId);
参数
描述
battleId
Battle ID。

TUIBattleUser

Battle 用户信息
枚举类型
描述
roomId
Battle 房间 ID。
userId
Battle 用户 ID。
userName
Battle 用户昵称。
avatarUrl
Battle 用户头像地址。
score
Battle 分数。

TUIBattleConfig

Battle 配置
枚举类型
描述
duration
Battle 最大时长(单位:秒)。
needResponse
被邀请用户是否需要回复同意/拒绝。
extensionInfo
Battle 扩展信息。

TUIBattleInfo

Battle 信息
枚举类型
描述
battleId
Battle ID。
config
Battle 配置。
inviter
Battle 发起人。
inviteeList
Battle 邀请成员。
startTime
Battle 开始标记时间戳(单位:秒)。
endTime
Battle 结束标记时间戳(单位:秒)。

TUIBattleRequestResult

枚举类型
描述
battleInfo
Battle 信息。
requestMap
Battle 请求结果。

TUIBattleCode

Battle 邀请状态
枚举
取值
描述
unknown
-1
默认状态。
success
0
Battle 请求发送成功。
roomNotExists
1
被邀请的房间不存在。
battling
2
被邀请的房间已在 Battle 中。
battlingOtherRoom
3
被邀请的房间已与其他房间 Battle 中。
roomExit
4
房间已退出。
retry
5
内部错误,推荐重试一次。

TUIBattleStoppedReason

Battle 结束的原因
枚举
取值
描述
timeOver
0
Battle 到达最大时长而超时结束
otherExit
1
Battle 其余人员都已退出

帮助和支持

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

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

文档反馈