TUILiveBattleManager

Recent Pages

TUILiveBattleManager

最后更新时间：2024-12-20 15:06:46

Copyright (c) 2024 Tencent. All rights reserved.
Module:   TUILiveBattleManager @ TUIKitEngine
Function: 直播 Battle 相关接口
﻿
TUILiveBattleManager
TUILiveBattleManager
函数列表
描述
onBattleStarted
收到 Battle 开始的通知
onBattleEnded
收到 Battle 结束的通知
onUserJoinBattle
收到用户加入 Battle 的通知
onUserExitBattle
收到用户退出 Battle 的通知
onBattleScoreChanged
收到用户 Battle 分数更新的通知
onBattleRequestReceived
被叫收到 Battle 邀请的通知
onBattleRequestCancelled
被叫收到 Battle 取消的通知
onBattleRequestTimeout
收到 Battle 处理超时的通知
onBattleRequestAccept
主叫收到被叫同意的通知
onBattleRequestReject
主叫收到被叫拒绝的通知
addObserver
添加事件回调
removeObserver
移除事件回调
requestBattle
发起 Battle 请求
cancelBattleRequest
取消 Battle 请求
acceptBattle
接受 Battle 请求
rejectBattle
拒绝 Battle 请求
exitBattle
退出 Battle
结构体类型
函数列表
描述
BattleUser
Battle 用户信息
BattleConfig
Battle 配置
BattleInfo
Battle 信息
枚举类型
枚举类型
描述
BattleCode
Battle 邀请状态
BattleStoppedReason
Battle 结束的原因
onBattleStarted
onBattleStarted
void onBattleStarted
(﻿BattleInfo﻿ battleInfo)
收到 Battle 开始的通知参数
描述
battleInfo
Battle 信息。
onBattleEnded
onBattleEnded
void onBattleEnded
(﻿BattleInfo﻿ battleInfo
﻿
﻿BattleStoppedReason﻿ reason)
收到 Battle 结束的通知参数
描述
battleInfo
Battle 信息。
reason
Battle 结束的原因。
onUserJoinBattle
onUserJoinBattle
void onUserJoinBattle
(String battleId
﻿
﻿BattleUser﻿ battleUser)
收到用户加入 Battle 的通知参数
描述
battleId
Battle ID。
battleUser
Battle 用户信息。
onUserExitBattle
onUserExitBattle
void onUserExitBattle
(String battleId
﻿
﻿BattleUser﻿ battleUser)
收到用户退出 Battle 的通知参数
描述
battleId
Battle ID。
battleUser
Battle 用户信息。
onBattleScoreChanged
onBattleScoreChanged
void onBattleScoreChanged
(String battleId
﻿
List<﻿BattleUser﻿> battleUserList)
收到用户 Battle 分数更新的通知参数
描述
battleId
Battle ID。
battleUserList
Battle 所有用户信息。
onBattleRequestReceived
onBattleRequestReceived
void onBattleRequestReceived
(﻿BattleInfo﻿ battleInfo
﻿
﻿BattleUser﻿ inviter
﻿
﻿BattleUser﻿ invitee)
被叫收到 Battle 邀请的通知参数
描述
battleInfo
Battle 信息。
invitee
收到邀请的用户信息。
inviter
发起邀请的用户信息。
onBattleRequestCancelled
onBattleRequestCancelled
void onBattleRequestCancelled
(﻿BattleInfo﻿ battleInfo
﻿
﻿BattleUser﻿ inviter
﻿
﻿BattleUser﻿ invitee)
被叫收到 Battle 取消的通知参数
描述
battleInfo
Battle 信息。
invitee
收到邀请的用户信息。
inviter
发起邀请的用户信息。
onBattleRequestTimeout
onBattleRequestTimeout
void onBattleRequestTimeout
(﻿BattleInfo﻿ battleInfo
﻿
﻿BattleUser﻿ inviter
﻿
﻿BattleUser﻿ invitee)
收到 Battle 处理超时的通知参数
描述
battleInfo
Battle 信息。
invitee
收到邀请的用户信息。
inviter
发起邀请的用户信息。
onBattleRequestAccept
onBattleRequestAccept
void onBattleRequestAccept
(﻿BattleInfo﻿ battleInfo
﻿
﻿BattleUser﻿ inviter
﻿
﻿BattleUser﻿ invitee)
主叫收到被叫同意的通知参数
描述
battleInfo
Battle 信息。
invitee
收到邀请的用户信息。
inviter
发起邀请的用户信息。
onBattleRequestReject
onBattleRequestReject
void onBattleRequestReject
(﻿BattleInfo﻿ battleInfo
﻿
﻿BattleUser﻿ inviter
﻿
﻿BattleUser﻿ invitee)
主叫收到被叫拒绝的通知参数
描述
battleInfo
Battle 信息。
invitee
收到邀请的用户信息。
inviter
发起邀请的用户信息。
addObserver
addObserver
void addObserver
(Observer observer)
添加事件回调参数
描述
observer
监听的实例。
removeObserver
removeObserver
void removeObserver
(Observer observer)
移除事件回调参数
描述
observer
监听的实例。
requestBattle
requestBattle
void requestBattle
(﻿BattleConfig﻿ config
﻿
List<String> userIdList
﻿
int timeout
﻿
BattleRequestCallback callback)
发起 Battle 请求参数
描述
config
Battle 配置信息。
timeout
超时时间。
userIdList
待邀请的用户ID列表。
cancelBattleRequest
cancelBattleRequest
void cancelBattleRequest
(String battleId
﻿
List<String> userIdList
﻿
TUIRoomDefine.ActionCallback callback)
取消 Battle 请求参数
描述
battleId
Battle ID。
userIdList
待取消的用户ID列表。
acceptBattle
acceptBattle
void acceptBattle
(String battleId
﻿
TUIRoomDefine.ActionCallback callback)
接受 Battle 请求参数
描述
battleId
Battle ID。
rejectBattle
rejectBattle
void rejectBattle
(String battleId
﻿
TUIRoomDefine.ActionCallback callback)
拒绝 Battle 请求参数
描述
battleId
Battle ID。
exitBattle
exitBattle
void exitBattle
(String battleId
﻿
TUIRoomDefine.ActionCallback callback)
退出 Battle参数
描述
battleId
Battle ID。
TUIBattleCode
TUIBattleCode
Battle 邀请状态枚举
取值
描述
UNKNOWN
-1
默认状态。
SUCCESS
0
Battle 请求发送成功。
ROOM_NOT_EXISTS
1
被邀请的房间不存在。
BATTLING
2
被邀请的房间已在 Battle 中。
BATTLING_OTHER_ROOM
3
被邀请的房间已与其他房间 Battle 中。
ROOM_EXIT
4
房间已退出。
RETRY
5
内部错误，推荐重试一次。
TUIBattleStoppedReason
TUIBattleStoppedReason
Battle 结束的原因枚举
取值
描述
TIME_OVER
0
Battle 到达最大时长而超时结束
OTHER_EXIT
1
Battle 其余人员都已退出
TUIBattleUser
TUIBattleUser
Battle 用户信息枚举类型
描述
avatarUrl
Battle 用户头像地址。
roomId
Battle 房间 id。
score
Battle 分数。
userId
Battle 用户id。
userName
Battle 用户昵称。
TUIBattleConfig
TUIBattleConfig
Battle 配置枚举类型
描述
duration
Battle 最大时长（单位：秒）。
extensionInfo
Battle 扩展信息。
needResponse
被邀请用户是否需要回复同意/拒绝。
TUIBattleInfo
TUIBattleInfo
Battle 信息枚举类型
描述
battleId
Battle ID。
config
Battle 配置。
endTime
Battle 结束标记时间戳（单位：秒）。
inviteeList
Battle 邀请成员。
inviter
Battle 发起人。
startTime
Battle 开始标记时间戳（单位：秒）。

联系我们

联系我们，为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持

void onBattleRequestReceived	(BattleInfo battleInfo
	BattleUser inviter
	BattleUser invitee)

void onBattleRequestCancelled	(BattleInfo battleInfo
	BattleUser inviter
	BattleUser invitee)

void onBattleRequestTimeout	(BattleInfo battleInfo
	BattleUser inviter
	BattleUser invitee)

void onBattleRequestAccept	(BattleInfo battleInfo
	BattleUser inviter
	BattleUser invitee)

void onBattleRequestReject	(BattleInfo battleInfo
	BattleUser inviter
	BattleUser invitee)

函数列表	描述
onBattleStarted	收到 Battle 开始的通知
onBattleEnded	收到 Battle 结束的通知
onUserJoinBattle	收到用户加入 Battle 的通知
onUserExitBattle	收到用户退出 Battle 的通知
onBattleScoreChanged	收到用户 Battle 分数更新的通知
onBattleRequestReceived	被叫收到 Battle 邀请的通知
onBattleRequestCancelled	被叫收到 Battle 取消的通知
onBattleRequestTimeout	收到 Battle 处理超时的通知
onBattleRequestAccept	主叫收到被叫同意的通知
onBattleRequestReject	主叫收到被叫拒绝的通知
addObserver	添加事件回调
removeObserver	移除事件回调
requestBattle	发起 Battle 请求
cancelBattleRequest	取消 Battle 请求
acceptBattle	接受 Battle 请求
rejectBattle	拒绝 Battle 请求
exitBattle	退出 Battle

函数列表	描述
BattleUser	Battle 用户信息
BattleConfig	Battle 配置
BattleInfo	Battle 信息

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

void onBattleEnded	(BattleInfo battleInfo
	BattleStoppedReason reason)

参数	描述
battleInfo	Battle 信息。
reason	Battle 结束的原因。

参数	描述
battleId	Battle ID。
battleUser	Battle 用户信息。

void onBattleScoreChanged	(String battleId
	List<BattleUser> battleUserList)

void requestBattle	(BattleConfig config
	List<String> userIdList
	int timeout
	BattleRequestCallback callback)

参数	描述
config	Battle 配置信息。
timeout	超时时间。
userIdList	待邀请的用户ID列表。

void cancelBattleRequest	(String battleId
	List<String> userIdList
	TUIRoomDefine.ActionCallback callback)

void acceptBattle	(String battleId
	TUIRoomDefine.ActionCallback callback)

void rejectBattle	(String battleId
	TUIRoomDefine.ActionCallback callback)

void exitBattle	(String battleId
	TUIRoomDefine.ActionCallback callback)

枚举	取值	描述
UNKNOWN	-1	默认状态。
SUCCESS	0	Battle 请求发送成功。
ROOM_NOT_EXISTS	1	被邀请的房间不存在。
BATTLING	2	被邀请的房间已在 Battle 中。
BATTLING_OTHER_ROOM	3	被邀请的房间已与其他房间 Battle 中。
ROOM_EXIT	4	房间已退出。
RETRY	5	内部错误，推荐重试一次。

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

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

tencent cloud

注册

登录

Recent Pages

TUILiveBattleManager

TUILiveBattleManager

结构体类型

枚举类型

onBattleStarted

收到 Battle 开始的通知

onBattleEnded

收到 Battle 结束的通知

onUserJoinBattle

收到用户加入 Battle 的通知

onUserExitBattle

收到用户退出 Battle 的通知

onBattleScoreChanged

收到用户 Battle 分数更新的通知

onBattleRequestReceived

被叫收到 Battle 邀请的通知

onBattleRequestCancelled

被叫收到 Battle 取消的通知

onBattleRequestTimeout

收到 Battle 处理超时的通知

onBattleRequestAccept

主叫收到被叫同意的通知

onBattleRequestReject

主叫收到被叫拒绝的通知

addObserver

添加事件回调

removeObserver

移除事件回调

requestBattle

发起 Battle 请求

cancelBattleRequest

取消 Battle 请求

acceptBattle

接受 Battle 请求

rejectBattle

拒绝 Battle 请求

exitBattle

退出 Battle

TUIBattleCode

Battle 邀请状态

TUIBattleStoppedReason

Battle 结束的原因

TUIBattleUser

Battle 用户信息

TUIBattleConfig

Battle 配置

TUIBattleInfo

Battle 信息

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

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