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

#include <ZoomSDKNewBreakoutRoomController.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError- startBO
 Start breakout meeting. '-onStartBOResponse:' is the corresponding callback notification.
 
(ZoomSDKError- stopBO
 Stop breakout meeting. '-onStopBOResponse:' is the corresponding callback notification.
 
(ZoomSDKError- assignNewUserToRunningBO:BOID:
 Assign user to is runing breakout meeting.
 
(ZoomSDKError- switchAssignedUserToRunningBO:BOID:
 Switch Assigned user to differnt Breakout meeting(BO-A to BO-B).
 
(BOOL) - canStartBO
 Determine if the user can start breakout room.
 
(ZoomSDKError- joinBOByUserRequest:
 User request to join breakout room.
 
(ZoomSDKError- ignoreUserHelpRequest:
 Notify attendee request help result.
 
(ZoomSDKError- broadcastMessage:
 Broadcast message.
 
(ZoomSDKError- inviteBOUserReturnToMainSession:
 Host invite user return to main session, When BO is started and user is in BO.
 
(BOOL) - isBroadcastVoiceToBOSupport
 Query if the current meeting supports broadcasting host's voice to BO.
 
(BOOL) - canBroadcastVoiceToBO
 Query if the host now has the ability to broadcast voice to BO.
 
(ZoomSDKError- broadcastVoiceToBO:
 Start or stop broadcasting voice to BO.
 

Properties

id< ZoomSDKBOMeetingAdminDelegatedelegate
 

Detailed Description

Definition at line 274 of file ZoomSDKNewBreakoutRoomController.h.

Method Documentation

◆ assignNewUserToRunningBO:BOID:

- (ZoomSDKError) assignNewUserToRunningBO: (NSString *) userID
BOID: (NSString *) ID 

Assign user to is runing breakout meeting.

Parameters
userIDAssigned user ID.
IDBreakout meeting ID.
Returns
If the function succeeds,will return ZoomSDKError_Success.

◆ broadcastMessage:

- (ZoomSDKError) broadcastMessage: (NSString *) message

Broadcast message.

Parameters
messageThe broadcast context.
Returns
If the function succeeds,will return ZoomSDKError_Success.

◆ broadcastVoiceToBO:

- (ZoomSDKError) broadcastVoiceToBO: (BOOL) start

Start or stop broadcasting voice to BO.

Parameters
startYES for start and NO for stop.
Returns
If the function succeeds, will return ZoomSDKError_Success.

◆ canBroadcastVoiceToBO

- (BOOL) canBroadcastVoiceToBO

Query if the host now has the ability to broadcast voice to BO.

Returns
YES means that the host now has the ability, otherwise the host does not.

◆ canStartBO

- (BOOL) canStartBO

Determine if the user can start breakout room.

Returns
If return YES means can start breakout room,otherwise not.

◆ ignoreUserHelpRequest:

- (ZoomSDKError) ignoreUserHelpRequest: (NSString *) userID

Notify attendee request help result.

Parameters
userIDThe user id of requested help.
Returns
If the function succeeds,will return ZoomSDKError_Success.

◆ inviteBOUserReturnToMainSession:

- (ZoomSDKError) inviteBOUserReturnToMainSession: (NSString *) userID

Host invite user return to main session, When BO is started and user is in BO.

Parameters
userIDThe user id.
Returns
If the function succeeds,will return ZoomSDKError_Success.

◆ isBroadcastVoiceToBOSupport

- (BOOL) isBroadcastVoiceToBOSupport

Query if the current meeting supports broadcasting host's voice to BO.

Returns
YES means that the meeting supports this, otherwise it's not supported.

◆ joinBOByUserRequest:

- (ZoomSDKError) joinBOByUserRequest: (NSString *) requestUserID

User request to join breakout room.

Parameters
requestUserIDThe user id.
Returns
If the function succeeds,will return ZoomSDKError_Success.

◆ startBO

- (ZoomSDKError) startBO

Start breakout meeting. '-onStartBOResponse:' is the corresponding callback notification.

Returns
If the function succeeds,will return ZoomSDKError_Success.

◆ stopBO

- (ZoomSDKError) stopBO

Stop breakout meeting. '-onStopBOResponse:' is the corresponding callback notification.

Returns
If the function succeeds,will return ZoomSDKError_Success.

◆ switchAssignedUserToRunningBO:BOID:

- (ZoomSDKError) switchAssignedUserToRunningBO: (NSString *) userID
BOID: (NSString *) ID 

Switch Assigned user to differnt Breakout meeting(BO-A to BO-B).

Parameters
userIDAssigned user ID.
IDBreakout meeting ID.
Returns
If the function succeeds,will return ZoomSDKError_Success.

Property Documentation

◆ delegate

- (id<ZoomSDKBOMeetingAdminDelegate>) delegate
readwritenonatomicassign

Definition at line 276 of file ZoomSDKNewBreakoutRoomController.h.