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 结束的原因 |
onBattleStarted:
onBattleStarted:
- (void)onBattleStarted: |
收到 Battle 开始的通知
参数 | 描述 |
battleInfo | Battle 信息。 |
onBattleEnded:reason:
onBattleEnded:reason:
- (void)onBattleEnded: | |
reason: |
收到 Battle 结束的通知
参数 | 描述 |
battleInfo | Battle 信息。 |
reason | Battle 结束的原因。 |
onUserJoinBattle:battleUser:
onUserJoinBattle:battleUser:
- (void)onUserJoinBattle: | (NSString*)battleId |
battleUser: |
收到用户加入 Battle 的通知
参数 | 描述 |
battleId | Battle ID。 |
battleUser | Battle 用户信息。 |
onUserExitBattle:battleUser:
onUserExitBattle:battleUser:
- (void)onUserExitBattle: | (NSString*)battleId |
battleUser: |
收到用户退出 Battle 的通知
参数 | 描述 |
battleId | Battle ID。 |
battleUser | Battle 用户信息。 |
onBattleScoreChanged:battleUserList:
onBattleScoreChanged:battleUserList:
- (void)onBattleScoreChanged: | (NSString*)battleId |
battleUserList: |
收到用户 Battle 分数更新的通知
参数 | 描述 |
battleId | Battle ID。 |
battleUserList | Battle 所有用户信息。 |
onBattleRequestReceived:inviter:invitee:
onBattleRequestReceived:inviter:invitee:
- (void)onBattleRequestReceived: | |
inviter: | |
invitee: |
被叫收到 Battle 邀请的通知
参数 | 描述 |
battleInfo | Battle 信息。 |
invitee | 收到邀请的用户信息。 |
inviter | 发起邀请的用户信息。 |
onBattleRequestCancelled:inviter:invitee:
onBattleRequestCancelled:inviter:invitee:
- (void)onBattleRequestCancelled: | |
inviter: | |
invitee: |
被叫收到 Battle 取消的通知
参数 | 描述 |
battleInfo | Battle 信息。 |
invitee | 收到邀请的用户信息。 |
inviter | 发起邀请的用户信息。 |
onBattleRequestTimeout:inviter:invitee:
onBattleRequestTimeout:inviter:invitee:
- (void)onBattleRequestTimeout: | |
inviter: | |
invitee: |
收到 Battle 处理超时的通知
参数 | 描述 |
battleInfo | Battle 信息。 |
invitee | 收到邀请的用户信息。 |
inviter | 发起邀请的用户信息。 |
onBattleRequestAccept:inviter:invitee:
onBattleRequestAccept:inviter:invitee:
- (void)onBattleRequestAccept: | |
inviter: | |
invitee: |
主叫收到被叫同意的通知
参数 | 描述 |
battleInfo | Battle 信息。 |
invitee | 收到邀请的用户信息。 |
inviter | 发起邀请的用户信息。 |
onBattleRequestReject:inviter:invitee:
onBattleRequestReject:inviter:invitee:
- (void)onBattleRequestReject: | |
inviter: | |
invitee: |
主叫收到被叫拒绝的通知
参数 | 描述 |
battleInfo | Battle 信息。 |
invitee | 收到邀请的用户信息。 |
inviter | 发起邀请的用户信息。 |
addObserver:
removeObserver:
requestBattle:userIdList:timeout:onSuccess:onError:
requestBattle:userIdList:timeout:onSuccess:onError:
- (void)requestBattle: | |
userIdList: | (NSArray<NSString *> *)userIdList |
timeout: | (NSTimeInterval)timeout |
onSuccess: | (TUIBattleRequestBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
发起 Battle 请求
参数 | 描述 |
config | Battle 配置信息。 |
timeout | 超时时间。 |
userIdList | 待邀请的用户ID列表。 |
cancelBattleRequest:userIdList:onSuccess:onError:
cancelBattleRequest:userIdList:onSuccess:onError:
- (void)cancelBattleRequest: | (NSString*)battleId |
userIdList: | (NSArray<NSString *> *)userIdList |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
取消 Battle 请求
参数 | 描述 |
battleId | Battle ID。 |
userIdList | 待取消的用户ID列表。 |
acceptBattle:onSuccess:onError:
acceptBattle:onSuccess:onError:
- (void)acceptBattle: | (NSString *)battleId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
接受 Battle 请求
参数 | 描述 |
battleId | Battle ID。 |
rejectBattle:onSuccess:onError:
rejectBattle:onSuccess:onError:
- (void)rejectBattle: | (NSString *)battleId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
拒绝 Battle 请求
参数 | 描述 |
battleId | Battle ID。 |
exitBattle:onSuccess:onError:
exitBattle:onSuccess:onError:
- (void)exitBattle: | (NSString *)battleId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
退出 Battle
参数 | 描述 |
battleId | Battle ID。 |
TUIBattleCode
TUIBattleCode
Battle 邀请状态
枚举 | 取值 | 描述 |
TUIBattleCodeUnknown | -1 | 默认状态。 |
TUIBattleCodeSuccess | 0 | Battle 请求发送成功。 |
TUIBattleCodeRoomNotExist | 1 | 被邀请的房间不存在。 |
TUIBattleCodeBattling | 2 | 被邀请的房间已在 Battle 中。 |
TUIBattleCodeBattlingOtherRoom | 3 | 被邀请的房间已与其他房间 Battle 中。 |
TUIBattleCodeRoomExit | 4 | 房间已退出。 |
TUIBattleCodeRetry | 5 | 内部错误，推荐重试一次。 |
TUIBattleStoppedReason
TUIBattleStoppedReason
Battle 结束的原因
枚举 | 取值 | 描述 |
TUIBattleStoppedReasonTimeOver | 0 | Battle 到达最大时长而超时结束 |
TUIBattleStoppedReasonOtherExit | 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 开始标记时间戳（单位：秒）。 |
