ZoomToolSuiteAPI.Meeting.MeetingAPI

Declaration

class MeetingAPI

ObjC Types and Enums Used by This Swift API

• ZoomToolSuiteBaseResult
• ZoomToolSuiteMeetingInstance
• ZoomToolSuiteMeetingProperty
• ZoomToolSuiteMeetingStatus
• ZoomToolSuiteQueryAudioStatisticInfoResult
• ZoomToolSuiteQueryOverallStatisticInfoResult
• ZoomToolSuiteQueryShareStatisticInfoResult
• ZoomToolSuiteQueryVideoStatisticInfoResult
• ZoomToolSuiteUser

Members

changeUserName(iUserID:strUserName:completion:meetingType:)

static func changeUserName(iUserID: UInt32, strUserName: String, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

change username with userID

• Parameters:
• iUserID: userID
• strUserName: username
• completion: completionHandler
• meetingType: meeting type
• Returns: whether the API call is successful

endMeeting(completion:)

static func endMeeting(completion: @escaping (ZoomToolSuiteBaseResult) -> Void) -> Bool

end meeting

• Parameter completionHandler: completionHandler
• Returns: whether the API call is successful

getAttendeeList()

static func getAttendeeList() -> [ZoomToolSuiteUser]

get attendeeList

• Returns: attendeeList

getMeetingProperty()

static func getMeetingProperty() -> ZoomToolSuiteMeetingProperty

get meeting property

• Returns: meeting property

getMeetingStatus()

static func getMeetingStatus() -> ZoomToolSuiteMeetingStatus

get meeting status

• Returns: meeting status

getParticipantsList()

static func getParticipantsList() -> [ZoomToolSuiteUser]

get participants list

• Returns: participants list

getSpotlightedUserList()

static func getSpotlightedUserList() -> [ZoomToolSuiteUser]

get spotlighted user list

• Returns: spotlighted user list

leaveMeeting(completion:)

static func leaveMeeting(completion: @escaping (ZoomToolSuiteBaseResult) -> Void) -> Bool

leave meeting

• Parameter completionHandler: completionHandler
• Returns: whether the API call is successful

queryAudioStatisticInfo(completion:meetingType:)

static func queryAudioStatisticInfo(completion: @escaping (ZoomToolSuiteQueryAudioStatisticInfoResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

query audio statistic info

• Parameters:
• completion: callback with ZoomToolSuiteQueryAudioStatisticInfoResult
• meetingType: meeting type
• Returns: whether the API call is successful

queryOverallStatisticInfo(completion:meetingType:)

static func queryOverallStatisticInfo(completion: @escaping (ZoomToolSuiteQueryOverallStatisticInfoResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

query overall statistic info

• Parameters:
• completion: callback with ZoomToolSuiteQueryOverallStatisticInfoResult
• meetingType: meeting type
• Returns: whether the API call is successful

queryShareStatisticInfo(completion:meetingType:)

static func queryShareStatisticInfo(completion: @escaping (ZoomToolSuiteQueryShareStatisticInfoResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

query share statistic info

• Parameters:
• completion: callback with ZoomToolSuiteQueryShareStatisticInfoResult
• meetingType: meeting type
• Returns: whether the API call is successful

queryVideoStatisticInfo(completion:meetingType:)

static func queryVideoStatisticInfo(completion: @escaping (ZoomToolSuiteQueryVideoStatisticInfoResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

query video statistic info

• Parameters:
• completion: callback with ZoomToolSuiteQueryVideoStatisticInfoResult
• meetingType: meeting type
• Returns: whether the API call is successful

setMeetingTopic(_:completion:)

static func setMeetingTopic(_ topic: String, completion: @escaping (ZoomToolSuiteBaseResult) -> Void) -> Bool

set meeting topic

• Parameters:
• topic: meeting topic
• completion: completionHandler
• Returns: whether the API call is successful