动态与公告

产品动态

产品近期公告

关于 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-10-20 14:18:13

Function: 直播PK相关接口，此页面中的函数仅支持直播房间类型（LIVE）。
TUIRoomEngine 3.3.0 版本开始支持。
TUILiveBattleManager
函数接口
说明
﻿requestBattle﻿
发起PK请求，该接口自 v3.3.0 版本支持。
﻿cancelBattleRequest﻿
取消PK请求，该接口自 v3.3.0 版本支持。
﻿acceptBattle﻿
接受PK请求，该接口自 v3.3.0 版本支持。
﻿rejectBattle﻿
拒绝PK请求，该接口自 v3.3.0 版本支持。
﻿exitBattle﻿
结束PK，该接口自 v3.3.0 版本支持。
﻿on﻿
定义 TUILiveBattleManagerEvents 事件
﻿off﻿
取消订阅 TUILiveBattleManagerEvents 事件
TUILiveBattleManagerEvents
事件接口
说明
﻿onBattleStarted﻿
接收到PK开始的监听事件，该接口自 v3.3.0 版本支持。
﻿onBattleEnded﻿
接收到PK结束的监听事件，该接口自 v3.3.0 版本支持。
﻿onUserJoinBattle﻿
接收到用户加入PK的监听事件，该接口自 v3.3.0 版本支持。
﻿onUserExitBattle﻿
接收到用户退出PK的监听事件，该接口自 v3.3.0 版本支持。
﻿onBattleScoreChanged﻿
接收到PK分数变化的监听事件，该接口自 v3.3.0 版本支持。
﻿onBattleRequestReceived﻿
接收PK请求的监听事件，该接口自 v3.3.0 版本支持。
﻿onBattleRequestCancelled﻿
接收PK请求取消的监听事件，该接口自 v3.3.0 版本支持。
﻿onBattleRequestTimeout﻿
接收PK请求超时的监听事件，该接口自 v3.3.0 版本支持。
﻿onBattleRequestAccept﻿
接收PK请求接受的监听事件，该接口自 v3.3.0 版本支持。
﻿onBattleRequestReject﻿
接收PK请求被拒绝的监听事件，该接口自 v3.3.0 版本支持。
类型定义
类型
说明
﻿TUIBattleConfig﻿
PK 配置参数
﻿TUIBattleInfo﻿
PK 信息
﻿TUIBattleUser﻿
PK 用户信息
枚举类型定义
枚举类型
说明
﻿TUIBattleStoppedReason﻿
PK结束原因
函数接口详情
requestBattle
发起 PK 请求
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.getLiveBattleManager();
const { battleId, result }= liveBattleManager.requestBattle({
  config: {duration: 100, needResponse: true},
  userIdList: ['userId1'],
  timeout: 10
});
参数
类型
是否必填
默认值
说明
options
Object
是
-
请求PK的参数。
options.config
﻿TUIBattleConfig﻿
是
-
发起PK的配置信息。
options.userIdList
Array<string>
是
-
请求PK的用户列表。
options.timeout
number
是
-
PK请求的超时时间。
返回值：Promise<object>
cancelBattleRequest
取消 PK 请求
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.getLiveBattleManager();
const { battleId, result }= liveBattleManager.cancelBattleRequest({
  battleId: 'battleId',
  userIdList: ['userId1']
});
参数
类型
是否必填
默认值
说明
options
Object
是
-
取消PK请求的参数。
options.battleId
string
是
-
取消请求PK的ID。
options.userIdList
Array<string>
是
-
取消PK请求的用户列表。
返回值：Promise<void>
acceptBattle
接受 PK 请求
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.getLiveBattleManager();
const { battleId, result }= liveBattleManager.acceptBattle({
  battleId: 'battleId'
});
参数
类型
是否必填
默认值
说明
options
Object
是
-
接受PK的参数。
options.battleId
string
是
-
接受PK的ID。
返回值：Promise<void>
rejectBattle
拒绝 PK 请求
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.getLiveBattleManager();
const { battleId, result }= liveBattleManager.rejectBattle({
  battleId: 'battleId'
});
参数
类型
是否必填
默认值
说明
options
Object
是
-
拒绝PK的参数。
options.battleId
string
是
-
拒绝PK的ID。
返回值：Promise<void>
exitBattle
退出 PK
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.getLiveBattleManager();
const { battleId, result }= liveBattleManager.exitBattle({
  battleId: 'battleId'
});
参数
类型
是否必填
默认值
说明
options
Object
是
-
退出PK的参数。
options.battleId
string
是
-
退出PK的ID。
返回值：Promise<void>
on
监听 TUILiveBattleManagerEvents 事件。
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.getLiveBattleManager();
const callback = (battleInfo) => {
  console.log('liveBattleManager.onBattleStarted', battleInfo);
};
liveBattleManager.on(TUILiveBattleManagerEvents.onBattleStarted, callback);
参数
类型
是否必填
默认值
说明
eventName
﻿TUILiveBattleManagerEvents﻿
是
-
事件名。
func
(...args: any[]) => void
是
-
事件处理函数。
off
取消 TUILiveBattleManagerEvents 事件监听。
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.getLiveBattleManager();
const callback = (battleInfo) => {
  console.log('liveBattleManager.onBattleStarted', battleInfo);
};
liveBattleManager.off(TUILiveBattleManagerEvents.onBattleStarted, callback);
参数
类型
是否必填
默认值
说明
eventName
TUILiveConnectionManagerEvents
是
-
事件名。
func
(...args: any[]) => void
是
-
事件处理函数。
事件接口详情
onBattleStarted
接收到PK开始的监听事件。
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.TUILiveBattleManager();
liveBattleManager.on(TUILiveBattleManagerEvents.onBattleStarted, ({ battleInfo }) => {
  console.log('liveBattleManager.onBattleStarted', battleInfo);
});
参数
类型
说明
options
Object
参数选项。
options.battleInfo 
﻿TUIBattleInfo﻿
PK信息。
onBattleEnded
接收到PK结束的监听事件。
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.TUILiveBattleManager();
liveBattleManager.on(TUILiveBattleManagerEvents.onBattleEnded, ({ battleInfo, reason }) => {
  console.log('liveBattleManager.onBattleEnded', battleInfo, reason);
});
参数
类型
说明
options
Object
参数选项。
options.battleInfo
﻿TUIBattleInfo﻿
PK的信息。
options.reason
﻿TUIBattleStoppedReason﻿
PK结束原因。
onUserJoinBattle
接收到用户加入PK的监听事件。
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.TUILiveBattleManager();
liveBattleManager.on(TUILiveBattleManagerEvents.onUserJoinBattle, ({ battleId, user }) => {
  console.log('liveBattleManager.onUserJoinBattle', battleId, user);
});
参数
类型
说明
options
Object
参数选项。
options.battleId
string
PK的ID。
options.user
﻿TUIBattleUser﻿
加入到PK的用户信息。
onUserExitBattle
接收到用户退出PK的监听事件。
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.TUILiveBattleManager();
liveBattleManager.on(TUILiveBattleManagerEvents.onUserExitBattle, ({ battleId, user }) => {
  console.log('liveBattleManager.onUserExitBattle', battleId, user);
});
参数
类型
说明
options
Object
参数选项。
options.battleId
string
PK的ID。
options.user
﻿TUIBattleUser﻿
加入到PK的用户信息。
onBattleScoreChanged
接收到PK分数变化的监听事件。
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.TUILiveBattleManager();
liveBattleManager.on(TUILiveBattleManagerEvents.onBattleScoreChanged, ({ battleId, battleUserList }) => {
  console.log('liveBattleManager.onBattleScoreChanged', battleId, battleUserList);
});
参数
类型
说明
options
Object
参数选项。
options.battleId
string
PK的ID。
options.battleUserList
Array<TUIBattleUser>
PK用户信息列表。
onBattleRequestReceived
接收PK请求的监听事件。
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.TUILiveBattleManager();
liveBattleManager.on(TUILiveBattleManagerEvents.onBattleRequestReceived, ({ battleInfo, inviter, invitee }) => {
  console.log('liveBattleManager.onBattleRequestReceived', battleInfo, inviter, invitee);
});
参数
类型
说明
options
Object
参数选项。
options.battleInfo
﻿TUIBattleInfo﻿
PK信息。
options.inviter
﻿TUIBattleUser﻿
发起PK请求的用户
options.invitee
﻿TUIBattleUser﻿
接收PK请求的用户
onBattleRequestCancelled
接收PK请求取消的监听事件。
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.TUILiveBattleManager();
liveBattleManager.on(TUILiveBattleManagerEvents.onBattleRequestCancelled, ({ battleInfo, inviter, invitee }) => {
  console.log('liveBattleManager.onBattleRequestCancelled', battleInfo, inviter, invitee);
});
参数
类型
说明
options
Object
参数选项。
options.battleInfo
﻿TUIBattleInfo﻿
PK信息。
options.inviter
﻿TUIBattleUser﻿
发起PK请求的用户
options.invitee
﻿TUIBattleUser﻿
接收PK请求的用户
onBattleRequestTimeout
接收PK请求超时的监听事件。
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.TUILiveBattleManager();
liveBattleManager.on(TUILiveBattleManagerEvents.onBattleRequestTimeout, ({ battleInfo, inviter, invitee }) => {
  console.log('liveBattleManager.onBattleRequestTimeout', battleInfo, inviter, invitee);
});
参数
类型
说明
options
Object
参数选项。
options.battleInfo
﻿TUIBattleInfo﻿
PK信息。
options.inviter
﻿TUIBattleUser﻿
发起PK请求的用户
options.invitee
﻿TUIBattleUser﻿
接收PK请求的用户
onBattleRequestAccept
接收PK请求接受的监听事件。
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.TUILiveBattleManager();
liveBattleManager.on(TUILiveBattleManagerEvents.onBattleRequestAccept, ({ battleInfo, inviter, invitee }) => {
  console.log('liveBattleManager.onBattleRequestAccept', battleInfo, inviter, invitee);
});
参数
类型
说明
options
Object
参数选项。
options.battleInfo
﻿TUIBattleInfo﻿
PK信息。
options.inviter
﻿TUIBattleUser﻿
发起PK请求的用户
options.invitee
﻿TUIBattleUser﻿
接收PK请求的用户
onBattleRequestReject
接收PK请求被拒绝的监听事件。
const roomEngine = new TUIRoomEngine();
const liveBattleManager = roomEngine.TUILiveBattleManager();
liveBattleManager.on(TUILiveBattleManagerEvents.onBattleRequestReject, ({ battleInfo, inviter, invitee }) => {
  console.log('liveBattleManager.onBattleRequestReject', battleInfo, inviter, invitee);
});
参数
类型
说明
options
Object
参数选项。
options.battleInfo
﻿TUIBattleInfo﻿
PK信息。
options.inviter
﻿TUIBattleUser﻿
发起PK请求的用户
options.invitee
﻿TUIBattleUser﻿
接收PK请求的用户
类型定义详情
TUIBattleConfig
属性
类型
说明
duration
number
PK时长。
needResponse
boolean
是否需要回应，默认为false。
extensionInfo
string
扩展信息，默认为‘’。
TUIBattleInfo
属性
类型
说明
fromUser
﻿TUIBattleUser﻿
发起PK的用户信息。
toUserList
Array<TUIBattleUser>
被邀请PK的用户列表。
extensionInfo
string
扩展信息。
battleId
string
PK的ID。
needResponse
boolean
是否需要回应
duration
number
PK时长
startTime
number
PK开始的时间戳
endTime
number
PK结束的时间戳
TUIBattleUser
属性
类型
说明
roomId
string
房间ID。
userId
string
用户ID。
userName
string
用户名称。
avatarUrl
string
用户头像URL。
score
number
PK分数
枚举定义详情
TUIBattleStoppedReason
字段
类型
说明
kStoppedByTimeOver
number
PK因时间结束而停止。
kStoppedByOtherExit
number
PK因其他用户退出而停止。

帮助和支持

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

您也可以联系销售或提交工单以寻求帮助。

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

文档反馈

tencent cloud

实时音视频

TUILiveBattleManager

TUILiveBattleManager

TUILiveBattleManagerEvents

类型定义

枚举类型定义

函数接口详情

requestBattle

cancelBattleRequest

acceptBattle

rejectBattle

exitBattle

on

off

事件接口详情

onBattleStarted

onBattleEnded

onUserJoinBattle

onUserExitBattle

onBattleScoreChanged

onBattleRequestReceived

onBattleRequestCancelled

onBattleRequestTimeout

onBattleRequestAccept

onBattleRequestReject

类型定义详情

TUIBattleConfig

TUIBattleInfo

TUIBattleUser

枚举定义详情

TUIBattleStoppedReason

帮助和支持

函数接口	说明
requestBattle	发起PK请求，该接口自 v3.3.0 版本支持。
cancelBattleRequest	取消PK请求，该接口自 v3.3.0 版本支持。
acceptBattle	接受PK请求，该接口自 v3.3.0 版本支持。
rejectBattle	拒绝PK请求，该接口自 v3.3.0 版本支持。
exitBattle	结束PK，该接口自 v3.3.0 版本支持。
on	定义 TUILiveBattleManagerEvents 事件
off	取消订阅 TUILiveBattleManagerEvents 事件

事件接口	说明
onBattleStarted	接收到PK开始的监听事件，该接口自 v3.3.0 版本支持。
onBattleEnded	接收到PK结束的监听事件，该接口自 v3.3.0 版本支持。
onUserJoinBattle	接收到用户加入PK的监听事件，该接口自 v3.3.0 版本支持。
onUserExitBattle	接收到用户退出PK的监听事件，该接口自 v3.3.0 版本支持。
onBattleScoreChanged	接收到PK分数变化的监听事件，该接口自 v3.3.0 版本支持。
onBattleRequestReceived	接收PK请求的监听事件，该接口自 v3.3.0 版本支持。
onBattleRequestCancelled	接收PK请求取消的监听事件，该接口自 v3.3.0 版本支持。
onBattleRequestTimeout	接收PK请求超时的监听事件，该接口自 v3.3.0 版本支持。
onBattleRequestAccept	接收PK请求接受的监听事件，该接口自 v3.3.0 版本支持。
onBattleRequestReject	接收PK请求被拒绝的监听事件，该接口自 v3.3.0 版本支持。

类型	说明
TUIBattleConfig	PK 配置参数
TUIBattleInfo	PK 信息
TUIBattleUser	PK 用户信息

参数	类型	是否必填	默认值	说明
options	Object	是	-	请求PK的参数。
options.config	TUIBattleConfig	是	-	发起PK的配置信息。
options.userIdList	Array<string>	是	-	请求PK的用户列表。
options.timeout	number	是	-	PK请求的超时时间。

属性	类型	说明
duration	number	PK时长。
needResponse	boolean	是否需要回应，默认为false。
extensionInfo	string	扩展信息，默认为‘’。

字段	类型	说明
kStoppedByTimeOver	number	PK因时间结束而停止。
kStoppedByOtherExit	number	PK因其他用户退出而停止。