TUILiveBattleManager
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 其余人员都已退出 |
