多人音视频房间 SDK TUIConferenceListManager-客户端 API-文档中心-腾讯云

Copyright (c) 2024 Tencent. All rights reserved.
Module:   TUIConferenceListManager @ TUIKitEngine
Function: 会议列表相关接口，此页面中的函数仅支持会议房间类型(﻿TUIRoomTypeConference﻿)。
﻿
TUIConferenceListManager
TUIConferenceListManagerObserver
函数列表
描述
onConferenceScheduled:
会议预定回调
onConferenceWillStart:
会议即将开始回调
onConferenceCancelled:reason:operateUser:
会议取消回调
onConferenceInfoChanged:modifyFlag:
会议信息变更回调
onScheduleAttendeesChanged:leftUsers:joinedUsers:
参会人员变更回调
onConferenceStatusChanged:status:
会议状态变更回调
TUIConferenceListManager
函数列表
描述
addObserver:
添加事件回调
removeObserver:
移除事件回调
scheduleConference:onSuccess:onError:
预定会议
cancelConference:onSuccess:onError:
取消预定会议
updateConferenceInfo:modifyFlag:onSuccess:onError:
更新预定会议信息
fetchScheduledConferenceList:cursor:count:onSuccess:onError:
获取预定会议列表
fetchAttendeeList:cursor:count:onSuccess:onError:
获取预定会议邀请成员列表
addAttendeesByAdmin:userIdList:onSuccess:onError:
添加成员至邀请列表
removeAttendeesByAdmin:userIdList:onSuccess:onError:
从邀请列表移除成员
结构体类型
函数列表
描述
TUIConferenceInfo
会议信息
枚举类型
枚举类型
描述
TUIConferenceCancelReason
会议取消原因
onConferenceScheduled:
onConferenceScheduled:
- (void)onConferenceScheduled:
(﻿TUIConferenceInfo﻿ *)conferenceInfo
会议预定回调参数
描述
conferenceInfo
会议信息
onConferenceWillStart:
onConferenceWillStart:
- (void)onConferenceWillStart:
(﻿TUIConferenceInfo﻿ *)conferenceInfo
会议即将开始回调参数
描述
conferenceInfo
会议信息。
onConferenceCancelled:reason:operateUser:
onConferenceCancelled:reason:operateUser:
- (void)onConferenceCancelled:
(NSString *)roomId
reason:
(﻿TUIConferenceCancelReason﻿) reason
operateUser:
(﻿TUIUserInfo﻿ *) operateUser
会议取消回调参数
描述
operateUser
取消会议操作者信息。
reason
会议取消原因。
roomId
会议Id，即房间roomId。
onConferenceInfoChanged:modifyFlag:
onConferenceInfoChanged:modifyFlag:
- (void)onConferenceInfoChanged:
(﻿TUIConferenceInfo﻿ *)conferenceInfo
modifyFlag:
(TUIConferenceModifyFlag) modifyFlag
会议信息变更回调参数
描述
conferenceInfo
会议信息。
modifyFlag
会议信息变更标志位。
onScheduleAttendeesChanged:leftUsers:joinedUsers:
onScheduleAttendeesChanged:leftUsers:joinedUsers:
- (void)onScheduleAttendeesChanged:
(NSString *)roomId
leftUsers:
(NSArray<﻿TUIUserInfo﻿ *> *) leftUsers
joinedUsers:
(NSArray<﻿TUIUserInfo﻿ *> *) joinedUsers
参会人员变更回调参数
描述
joinedUsers
新加入成员列表。
leftUsers
离开成员列表。
roomId
会议Id，即房间roomId。
onConferenceStatusChanged:status:
onConferenceStatusChanged:status:
- (void)onConferenceStatusChanged:
(NSString *)roomId
status:
(TUIConferenceStatus) status
会议状态变更回调参数
描述
roomId
会议Id，即房间roomId。
status
会议状态枚举，详情参见：﻿TUIConferenceStatus﻿。
addObserver:
addObserver:
- (void)addObserver:
(id<﻿TUIConferenceListManagerObserver﻿>)observer
添加事件回调参数
描述
observer
监听的实例。
removeObserver:
removeObserver:
- (void)removeObserver:
(id<﻿TUIConferenceListManagerObserver﻿>)observer
移除事件回调参数
描述
observer
监听的实例。
scheduleConference:onSuccess:onError:
scheduleConference:onSuccess:onError:
- (void)scheduleConference:
(﻿TUIConferenceInfo﻿ *)conferenceInfo
onSuccess:
(TUISuccessBlock)onSuccess
onError:
(TUIErrorBlock)onError
预定会议参数
描述
conferenceInfo
预定会议信息。
cancelConference:onSuccess:onError:
cancelConference:onSuccess:onError:
- (void)cancelConference:
(NSString *)roomId
onSuccess:
(TUISuccessBlock)onSuccess
onError:
(TUIErrorBlock)onError
取消预定会议参数
描述
roomId
要取消会议的会议Id，即房间roomId。
updateConferenceInfo:modifyFlag:onSuccess:onError:
updateConferenceInfo:modifyFlag:onSuccess:onError:
- (void)updateConferenceInfo:
(﻿TUIConferenceInfo﻿ *)conferenceInfo
modifyFlag:
(TUIConferenceModifyFlag) modifyFlag
onSuccess:
(TUISuccessBlock)onSuccess
onError:
(TUIErrorBlock)onError
更新预定会议信息参数
描述
conferenceInfo
预定会议信息。
modifyFlag
更新会议信息标记位。
fetchScheduledConferenceList:cursor:count:onSuccess:onError:
fetchScheduledConferenceList:cursor:count:onSuccess:onError:
- (void)fetchScheduledConferenceList:
(TUIConferenceStatus) status
cursor:
(NSString*) cursor
count:
(NSInteger) count
onSuccess:
(TUIScheduledConferenceListResponseBlock)onSuccess
onError:
(TUIErrorBlock)onError
获取预定会议列表参数
描述
count
本次拉取数量。
cursor
分页获取索引，第一次拉取填 ""，回调成功 如果callback返回的数据中 cursor 不为""，表示需要分页，请以返回的cursor作为参数再次调用接口拉取，直至返回的cursor为""，表示数据已经全部拉取。
status
会议状态。
fetchAttendeeList:cursor:count:onSuccess:onError:
fetchAttendeeList:cursor:count:onSuccess:onError:
- (void)fetchAttendeeList:
(NSString *) roomId
cursor:
(NSString*) cursor
count:
(NSInteger) count
onSuccess:
(TUIScheduledAttendeesResponseBlock)onSuccess
onError:
(TUIErrorBlock)onError
获取预定会议邀请成员列表参数
描述
count
本次拉取数量。
cursor
分页获取索引，第一次拉取填 ""，回调成功 如果callback返回的数据中 cursor 不为""，表示需要分页，请以返回的cursor作为参数再次调用接口拉取，直至返回的cursor为""，表示数据已经全部拉取。
roomId
预定会议会议Id，即房间roomId。
addAttendeesByAdmin:userIdList:onSuccess:onError:
addAttendeesByAdmin:userIdList:onSuccess:onError:
- (void)addAttendeesByAdmin:
(NSString *)roomId
userIdList:
(NSArray<NSString *> *)userIdList
onSuccess:
(TUISuccessBlock)onSuccess
onError:
(TUIErrorBlock)onError
添加成员至邀请列表参数
描述
roomId
预定会议Id，即房间roomId。
userIdList
成员userId列表。
removeAttendeesByAdmin:userIdList:onSuccess:onError:
removeAttendeesByAdmin:userIdList:onSuccess:onError:
- (void)removeAttendeesByAdmin:
(NSString *)roomId
userIdList:
(NSArray<NSString *> *)userIdList
onSuccess:
(TUISuccessBlock)onSuccess
onError:
(TUIErrorBlock)onError
从邀请列表移除成员参数
描述
roomId
预定会议Id，即房间roomId。
userIdList
成员userId列表。
TUIConferenceCancelReason
TUIConferenceCancelReason
会议取消原因枚举
取值
描述
TUIConferenceCancelReasonCancelledByAdmin
0
房主取消
TUIConferenceCancelReasonRemovedFromAttendees
1
当前用户被移出参会人员列表
TUIConferenceInfo
TUIConferenceInfo
会议信息枚举类型
描述
basicRoomInfo
会议基础信息
reminderSecondsBeforeStart
会议开始前提醒时间（秒）
scheduleAttendees
邀请参会成员列表，可在预定会议时设置，拉取成员请使用 ﻿fetchAttendeeList﻿ 接口
scheduleEndTime
预定会议结束时间
scheduleStartTime
预定会议开始时间
status
房间状态（只读）

函数列表	描述
onConferenceScheduled:	会议预定回调
onConferenceWillStart:	会议即将开始回调
onConferenceCancelled:reason:operateUser:	会议取消回调
onConferenceInfoChanged:modifyFlag:	会议信息变更回调
onScheduleAttendeesChanged:leftUsers:joinedUsers:	参会人员变更回调
onConferenceStatusChanged:status:	会议状态变更回调

函数列表	描述
addObserver:	添加事件回调
removeObserver:	移除事件回调
scheduleConference:onSuccess:onError:	预定会议
cancelConference:onSuccess:onError:	取消预定会议
updateConferenceInfo:modifyFlag:onSuccess:onError:	更新预定会议信息
fetchScheduledConferenceList:cursor:count:onSuccess:onError:	获取预定会议列表
fetchAttendeeList:cursor:count:onSuccess:onError:	获取预定会议邀请成员列表
addAttendeesByAdmin:userIdList:onSuccess:onError:	添加成员至邀请列表
removeAttendeesByAdmin:userIdList:onSuccess:onError:	从邀请列表移除成员

枚举类型	描述
TUIConferenceCancelReason	会议取消原因

- (void)onConferenceCancelled:	(NSString *)roomId
reason:	(TUIConferenceCancelReason) reason
operateUser:	(TUIUserInfo *) operateUser

参数	描述
operateUser	取消会议操作者信息。
reason	会议取消原因。
roomId	会议Id，即房间roomId。

- (void)onConferenceInfoChanged:	(TUIConferenceInfo *)conferenceInfo
modifyFlag:	(TUIConferenceModifyFlag) modifyFlag

参数	描述
conferenceInfo	会议信息。
modifyFlag	会议信息变更标志位。

- (void)onScheduleAttendeesChanged:	(NSString *)roomId
leftUsers:	(NSArray<TUIUserInfo > ) leftUsers
joinedUsers:	(NSArray<TUIUserInfo > ) joinedUsers

参数	描述
joinedUsers	新加入成员列表。
leftUsers	离开成员列表。
roomId	会议Id，即房间roomId。

- (void)onConferenceStatusChanged:	(NSString *)roomId
status:	(TUIConferenceStatus) status

- (void)scheduleConference:	(TUIConferenceInfo *)conferenceInfo
onSuccess:	(TUISuccessBlock)onSuccess
onError:	(TUIErrorBlock)onError

- (void)cancelConference:	(NSString *)roomId
onSuccess:	(TUISuccessBlock)onSuccess
onError:	(TUIErrorBlock)onError

- (void)updateConferenceInfo:	(TUIConferenceInfo *)conferenceInfo
modifyFlag:	(TUIConferenceModifyFlag) modifyFlag
onSuccess:	(TUISuccessBlock)onSuccess
onError:	(TUIErrorBlock)onError

- (void)fetchScheduledConferenceList:	(TUIConferenceStatus) status
cursor:	(NSString*) cursor
count:	(NSInteger) count
onSuccess:	(TUIScheduledConferenceListResponseBlock)onSuccess
onError:	(TUIErrorBlock)onError

参数	描述
count	本次拉取数量。
cursor	分页获取索引，第一次拉取填 ""，回调成功如果callback返回的数据中 cursor 不为""，表示需要分页，请以返回的cursor作为参数再次调用接口拉取，直至返回的cursor为""，表示数据已经全部拉取。
status	会议状态。

- (void)fetchAttendeeList:	(NSString *) roomId
cursor:	(NSString*) cursor
count:	(NSInteger) count
onSuccess:	(TUIScheduledAttendeesResponseBlock)onSuccess
onError:	(TUIErrorBlock)onError

- (void)addAttendeesByAdmin:	(NSString *)roomId
userIdList:	(NSArray<NSString > )userIdList
onSuccess:	(TUISuccessBlock)onSuccess
onError:	(TUIErrorBlock)onError

- (void)removeAttendeesByAdmin:	(NSString *)roomId
userIdList:	(NSArray<NSString > )userIdList
onSuccess:	(TUISuccessBlock)onSuccess
onError:	(TUIErrorBlock)onError

枚举	取值	描述
TUIConferenceCancelReasonCancelledByAdmin	0	房主取消
TUIConferenceCancelReasonRemovedFromAttendees	1	当前用户被移出参会人员列表

枚举类型	描述
basicRoomInfo	会议基础信息
reminderSecondsBeforeStart	会议开始前提醒时间（秒）
scheduleAttendees	邀请参会成员列表，可在预定会议时设置，拉取成员请使用 fetchAttendeeList 接口
scheduleEndTime	预定会议结束时间
scheduleStartTime	预定会议开始时间
status	房间状态（只读）

TUIConferenceListManager

本页目录：

TUIConferenceListManagerObserver

TUIConferenceListManager

结构体类型

枚举类型

onConferenceScheduled:

会议预定回调

onConferenceWillStart:

会议即将开始回调

onConferenceCancelled:reason:operateUser:

会议取消回调

onConferenceInfoChanged:modifyFlag:

会议信息变更回调

onScheduleAttendeesChanged:leftUsers:joinedUsers:

参会人员变更回调

onConferenceStatusChanged:status:

会议状态变更回调

addObserver:

添加事件回调

removeObserver:

移除事件回调

scheduleConference:onSuccess:onError:

预定会议

cancelConference:onSuccess:onError:

取消预定会议

updateConferenceInfo:modifyFlag:onSuccess:onError:

更新预定会议信息

fetchScheduledConferenceList:cursor:count:onSuccess:onError:

获取预定会议列表

fetchAttendeeList:cursor:count:onSuccess:onError:

获取预定会议邀请成员列表

addAttendeesByAdmin:userIdList:onSuccess:onError:

添加成员至邀请列表

removeAttendeesByAdmin:userIdList:onSuccess:onError:

从邀请列表移除成员

TUIConferenceCancelReason

会议取消原因

TUIConferenceInfo

会议信息