ZoomSDKNewBreakoutRoomController Class Reference

Controller class to manage breakout room features and permissions. More...

#include <ZoomSDKNewBreakoutRoomController.h>

Inherits NSObject.

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

Properties
id< ZoomSDKNewBreakoutRoomControllerDelegate >	delegate
	Delegate to receive breakout room controller callbacks.

Detailed Description

Controller class to manage breakout room features and permissions.

Definition at line 705 of file ZoomSDKNewBreakoutRoomController.h.

Method Documentation

getBOMeetingAdmin

- (ZoomSDKBOMeetingAdmin *_Nullable) getBOMeetingAdmin

Gets ZoomSDKBOMeetingAdmin Class object.

Returns

If the function succeeds, it returns ZoomSDKBOMeetingAdmin object. Otherwise, this function fails and returns nil.

Note

Host in master meeting or breakout meeting can get this object.

References getBOMeetingAdmin.

Referenced by getBOMeetingAdmin.

getBOMeetingAssistant

- (ZoomSDKBOMeetingAssistant *_Nullable) getBOMeetingAssistant

Gets ZoomSDKBOMeetingAssistant Class object.

Returns

If the function succeeds, it returns ZoomSDKBOMeetingAssistant object. Otherwise, this function fails and returns nil.

Note

Host in master or breakout meeting or cohost in breakmeeting can get this object.

References getBOMeetingAssistant.

Referenced by getBOMeetingAssistant.

getBOMeetingAttendee

- (ZoomSDKBOMeetingAttendee *_Nullable) getBOMeetingAttendee

Gets ZoomSDKBOMeetingAttendee Class object.

Returns

If the function succeeds, it returns ZoomSDKBOMeetingAttendee object. Otherwise, this function fails and returns nil.

Note

If you are CoHost or attendee, and are assigned to BO, you will get this object.

References getBOMeetingAttendee.

Referenced by getBOMeetingAttendee.

getBOMeetingCreator

- (ZoomSDKBOMeetingCreator *_Nullable) getBOMeetingCreator

Gets ZoomSDKBOMeetingCreator Class object.

Returns

If the function succeeds, it returns ZoomSDKBOMeetingCreator object. Otherwise, this function fails and returns nil.

Note

Only host can get this object.

References getBOMeetingCreator.

Referenced by getBOMeetingCreator.

getBOMeetingDataHelp

- (ZoomSDKBOMeetingDataHelp *_Nullable) getBOMeetingDataHelp

Gets ZoomSDKBOMeetingDataHelp Class object.

Returns

If the function succeeds, it returns ZoomSDKBOMeetingDataHelp object. Otherwise, this function fails and returns nil.

Note

Host in master or breakout meeting or cohost in breakmeeting can get this object.

References getBOMeetingDataHelp.

Referenced by getBOMeetingDataHelp.

getBOStatus

- (ZoomSDKBOStatus) getBOStatus

Gets current BO status.

Returns

The value is a enum for bo status.

References getBOStatus.

Referenced by getBOStatus.

getJoiningBOName

- (NSString *_Nullable) getJoiningBOName

Gets the BO's name 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. Otherwise, this function fails and returns nil.

References getJoiningBOName.

Referenced by getJoiningBOName.

isBOEnable

- (BOOL) isBOEnable

Determines if breakout meeting is enable.

Returns

YES if bo is enabled. Otherwise, NO.

References isBOEnable.

Referenced by isBOEnable.

isBOStart

- (BOOL) isBOStart

Determines if breakout meeting is start.

Returns

YES if bo is started. Otherwise, NO.

References isBOStart.

Referenced by isBOStart.

isBroadcastingVoiceToBO

- (BOOL) isBroadcastingVoiceToBO

Query if the host is broadcasting voice to BO.

Returns

YES if the host is broadcasting. Otherwise, NO.

References isBroadcastingVoiceToBO.

Referenced by isBroadcastingVoiceToBO.

isInBOMeeting

- (BOOL) isInBOMeeting

Determines if user is in breakout meeting.

Returns

YES if user is in bo meeting. Otherwise, NO.

References isInBOMeeting.

Referenced by isInBOMeeting.

Property Documentation

delegate

- (id<ZoomSDKNewBreakoutRoomControllerDelegate>) delegate

readwritenonatomicassign

Delegate to receive breakout room controller callbacks.

Definition at line 709 of file ZoomSDKNewBreakoutRoomController.h.