Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
<ZoomSDKNewBreakoutRoomControllerDelegate> Protocol Reference

Delegate protocol to receive new breakout room controller events and permission changes. More...

#include <ZoomSDKNewBreakoutRoomController.h>

Inherits <NSObjectNSObject>.

Instance Methods

(void) - onHasCreatorPermission:
 If the creator's permissions change, receives the callback.
 
(void) - onHasAdminPermission:
 If the admin's permissions change, receives the callback.
 
(void) - onHasAssistantPermission:
 If the assistant's permissions change, receives the callback.
 
(void) - onHasAttendeePermission:
 If the attendee's permissions change, receives the callback.
 
(void) - onHasDataHelperPermission:
 If the dataHelper's permissions change, receives the callback.
 
(void) - onLostCreatorPermission
 If lost creator's permissions change, receives the callback.
 
(void) - onLostAdminPermission
 If lost admin's permissions change, receives the callback.
 
(void) - onLostAssistantPermission
 If lost assistant's permissions change, receives the callback.
 
(void) - onLostAttendeePermission
 If lost attendee's permissions change, receives the callback.
 
(void) - onLostDataHelperPermission
 If lost dataHelper's permissions change, receives the callback.
 
(void) - onNewBroadcastMessageReceived:senderUserId:senderName:
 If host broadcast message,all attendee revieves this callback.
 
(void) - onBOMeetingStopCountDown:
 If countDown != ZoomSDKBOStopCountDown_Not, host stop BO and all users receive the event.
 
(void) - onHostInviteReturnToMainSession:handler:
 If you are in BO, host invite you return to main session, you receives the event.
 
(void) - onBOControlStatusChanged:
 When host change the BO status, all users receive the event.
 
(void) - onBOSwitchRequestReceived:newBOID:
 Whenever the host switches you to another BO while you are assigned but haven't joined the BO, you receives this event.
 
(void) - onBroadcastBOVoiceStatus:
 The status of broadcasting voice to BO has been changed.
 
(void) - onShareFromMainSession:status:shareAction:
 You receives this event when you are in a breakout room, and someone shares from the main session to the breakout room.
 

Detailed Description

Delegate protocol to receive new breakout room controller events and permission changes.

Definition at line 592 of file ZoomSDKNewBreakoutRoomController.h.

Method Documentation

◆ onBOControlStatusChanged:

- (void) onBOControlStatusChanged: (ZoomSDKBOStatus) status
optionalrequired

When host change the BO status, all users receive the event.

Parameters
statusCurrent status of BO.

◆ onBOMeetingStopCountDown:

- (void) onBOMeetingStopCountDown: (unsigned int) countDown
optionalrequired

If countDown != ZoomSDKBOStopCountDown_Not, host stop BO and all users receive the event.

Parameters
countDownThe countdown seconds.

◆ onBOSwitchRequestReceived:newBOID:

- (void) onBOSwitchRequestReceived: (NSString *) newBOName
newBOID: (NSString *_Nullable) newBOID 
optionalrequired

Whenever the host switches you to another BO while you are assigned but haven't joined the BO, you receives this event.

Parameters
newBONameThe new BO name.
newBOIDThe new BO ID. If the current user is ZoomSDKBOMeetingAttendee, then the 2nd parameter strNewBOID returns nil.

◆ onBroadcastBOVoiceStatus:

- (void) onBroadcastBOVoiceStatus: (BOOL) start
optionalrequired

The status of broadcasting voice to BO has been changed.

Parameters
startYES for start and NO for stop.

◆ onHasAdminPermission:

- (void) onHasAdminPermission: (ZoomSDKBOMeetingAdmin *_Nullable) adminObject
optionalrequired

If the admin's permissions change, receives the callback.

Parameters
adminObjectZoomSDKBOMeetingAdmin object.

◆ onHasAssistantPermission:

- (void) onHasAssistantPermission: (ZoomSDKBOMeetingAssistant *_Nullable) assistantObject
optionalrequired

If the assistant's permissions change, receives the callback.

Parameters
assistantObjectZoomSDKBOMeetingAssistant object.

◆ onHasAttendeePermission:

- (void) onHasAttendeePermission: (ZoomSDKBOMeetingAttendee *_Nullable) attendeeObject
optionalrequired

If the attendee's permissions change, receives the callback.

Parameters
attendeeObjectZoomSDKBOMeetingAttendee object.

◆ onHasCreatorPermission:

- (void) onHasCreatorPermission: (ZoomSDKBOMeetingCreator *_Nullable) creatorObject
optional

If the creator's permissions change, receives the callback.

Parameters
creatorObjectZoomSDKBOMeetingCreator class object.

◆ onHasDataHelperPermission:

- (void) onHasDataHelperPermission: (ZoomSDKBOMeetingDataHelp *_Nullable) dataHelpObject
optionalrequired

If the dataHelper's permissions change, receives the callback.

Parameters
dataHelpObjectZoomSDKBOMeetingDataHelp object.

◆ onHostInviteReturnToMainSession:handler:

- (void) onHostInviteReturnToMainSession: (NSString *) userName
handler: (ZoomSDKBOMeetingReturnToMainSessionHandler *) handler 
optionalrequired

If you are in BO, host invite you return to main session, you receives the event.

Parameters
userNameThe host name.
handlerThe ZoomSDKBOMeetingReturnToMainSessionHandler object.

◆ onLostAdminPermission

- (void) onLostAdminPermission
optionalrequired

If lost admin's permissions change, receives the callback.

◆ onLostAssistantPermission

- (void) onLostAssistantPermission
optionalrequired

If lost assistant's permissions change, receives the callback.

◆ onLostAttendeePermission

- (void) onLostAttendeePermission
optionalrequired

If lost attendee's permissions change, receives the callback.

◆ onLostCreatorPermission

- (void) onLostCreatorPermission
optionalrequired

If lost creator's permissions change, receives the callback.

◆ onLostDataHelperPermission

- (void) onLostDataHelperPermission
optionalrequired

If lost dataHelper's permissions change, receives the callback.

◆ onNewBroadcastMessageReceived:senderUserId:senderName:

- (void) onNewBroadcastMessageReceived: (NSString *) message
senderUserId: (unsigned int) userid
senderName: (NSString *) senderName 
optionalrequired

If host broadcast message,all attendee revieves this callback.

Parameters
messageThe broadcast message context.
useridThe sender message user ID.
senderNameThe sender message user name.

◆ onShareFromMainSession:status:shareAction:

- (void) onShareFromMainSession: (unsigned int) sharingID
status: (ZoomSDKShareStatus) status
shareAction: (ZoomSDKShareAction *) shareAction 
optionalrequired

You receives this event when you are in a breakout room, and someone shares from the main session to the breakout room.

Parameters
sharingIDThe sharing ID.
statusThe sharing status.
shareActionThe pointer of share action object.