Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKNewBreakoutRoomController Class Reference

#include <ZoomSDKNewBreakoutRoomController.h>

Inherits NSObject.

Instance Methods

(ZoomSDKBOMeetingCreator *_Nullable) - getBOMeetingCreator
 Get ZoomSDKBOMeetingCreator Class object.
 
(ZoomSDKBOMeetingAdmin *_Nullable) - getBOMeetingAdmin
 Get ZoomSDKBOMeetingAdmin Class object.
 
(ZoomSDKBOMeetingAssistant *_Nullable) - getBOMeetingAssistant
 Get ZoomSDKBOMeetingAssistant Class object.
 
(ZoomSDKBOMeetingAttendee *_Nullable) - getBOMeetingAttendee
 Get ZoomSDKBOMeetingAttendee Class object.
 
(ZoomSDKBOMeetingDataHelp *_Nullable) - getBOMeetingDataHelp
 Get ZoomSDKBOMeetingDataHelp Class object.
 
(BOOL) - isBOStart
 Determine if breakout meeting is start.
 
(BOOL) - isBOEnable
 Determine if breakout meeting is enable.
 
(BOOL) - isInBOMeeting
 Determine if user is in breakout meeting.
 
(ZoomSDKBOStatus- getBOStatus
 Get current BO status.
 
(BOOL) - isBroadcastingVoiceToBO
 Query if the host is broadcasting voice to BO.
 
(NSString *_Nullable) - getJoiningBOName
 Get the name of the BO you are going to.
 

Properties

id< ZoomSDKNewBreakoutRoomControllerDelegatedelegate
 

Detailed Description

Definition at line 625 of file ZoomSDKNewBreakoutRoomController.h.

Method Documentation

◆ getBOMeetingAdmin

- (ZoomSDKBOMeetingAdmin *_Nullable) getBOMeetingAdmin

Get ZoomSDKBOMeetingAdmin Class object.

Returns
If the function succeeds,will return ZoomSDKBOMeetingAdmin Class object.
Note
Host in master meeting or breakout meeting can get this object.

◆ getBOMeetingAssistant

- (ZoomSDKBOMeetingAssistant *_Nullable) getBOMeetingAssistant

Get ZoomSDKBOMeetingAssistant Class object.

Returns
If the function succeeds,will return ZoomSDKBOMeetingAssistant Class object.
Note
Host in master/breakout meeting or cohost in breakmeeting can get this object.

◆ getBOMeetingAttendee

- (ZoomSDKBOMeetingAttendee *_Nullable) getBOMeetingAttendee

Get ZoomSDKBOMeetingAttendee Class object.

Returns
If the function succeeds,will return ZoomSDKBOMeetingAttendee Class object.
Note
If you are CoHost/attendee, and are assigned to BO, you will get this object.

◆ getBOMeetingCreator

- (ZoomSDKBOMeetingCreator *_Nullable) getBOMeetingCreator

Get ZoomSDKBOMeetingCreator Class object.

Returns
If the function succeeds,will return ZoomSDKBOMeetingCreator Class object.
Note
Only host can get this object.

◆ getBOMeetingDataHelp

- (ZoomSDKBOMeetingDataHelp *_Nullable) getBOMeetingDataHelp

Get ZoomSDKBOMeetingDataHelp Class object.

Returns
If the function succeeds,will return ZoomSDKBOMeetingDataHelp Class object.
Note
Host in master/breakout meeting or cohost in breakmeeting can get this object.

◆ getBOStatus

- (ZoomSDKBOStatus) getBOStatus

Get current BO status.

Returns
The value is a enum for bo status.

◆ getJoiningBOName

- (NSString *_Nullable) getJoiningBOName

Get the name of the BO you are going to.

Returns
The value is join bo name which you are going to.
Note
When you enter a BO or are switched to another BO by the host, maybe you need the BO name to display on transfer UI.

◆ isBOEnable

- (BOOL) isBOEnable

Determine if breakout meeting is enable.

Returns
If the function succeeds, it will return YES, otherwise not.

◆ isBOStart

- (BOOL) isBOStart

Determine if breakout meeting is start.

Returns
If the function succeeds, it will return YES, otherwise not.

◆ isBroadcastingVoiceToBO

- (BOOL) isBroadcastingVoiceToBO

Query if the host is broadcasting voice to BO.

Returns
YES means that the host is broadcasting, otherwise it's not broadcasting.

◆ isInBOMeeting

- (BOOL) isInBOMeeting

Determine if user is in breakout meeting.

Returns
If the function succeeds, it will return YES, otherwise not.

Property Documentation

◆ delegate

- (id<ZoomSDKNewBreakoutRoomControllerDelegate>) delegate
readwritenonatomicassign

Definition at line 627 of file ZoomSDKNewBreakoutRoomController.h.