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

#include <ZoomSDKWebinarController.h>

Inherits <NSObjectNSObject>.

Instance Methods

(void) - onSelfAllowTalkNoti
 Callback of users are allowed to talk in webinar. User needs to enable the mic in the view-only mode of webinar if he wants to talk.
 
(void) - onSelfDisallowTalkNoti
 Callback of users are disallowed to talk in webinar.
 
(void) - onPromoteAttendee2PanelistResultNoti:
 Callback to promote attendee to panelist.
 
(void) - onDepromotePanelist2AttendeeResultNoti:
 Callback to demote panelist to attendee.
 
(void) - onAllowPanelistStartVideoNoti
 Callback to enable the panelist to start the video.
 
(void) - onDisAllowPanelistStartVideoNoti
 Callback to disable the panelist to start the video.
 
(void) - onAttendeeAudioStatusNoti:canTalk:isMuted:
 Panelist will receive this callback if the attendee's audio status changed.
 
(ZoomSDKError- onWebinarNeedRegisterResponse:
 During the webinar, this callback will be triggered if the user needs to register.
 
(void) - onAttendeePromoteConfirmResult:isAgree:
 Panelist will receive this callback if the attendee's audio status changed.
 
(void) - onAllowWebinarReactionStatusChanged:
 Callback for when the host enables/disables emoji reactions.
 
(void) - onAllowAttendeeRaiseHandStatusChanged:
 Callback to attendee raise hand status changed.
 
(void) - onAllowAttendeeViewTheParticipantCountStatusChanged:
 Callback to attendee view the participant count status changed.
 
(void) - onWebinarNeedInputScreenName:
 When join the webinar, this callback is triggered if the user needs to input username.
 

Detailed Description

Definition at line 93 of file ZoomSDKWebinarController.h.

Method Documentation

◆ onAllowAttendeeRaiseHandStatusChanged:

- (void) onAllowAttendeeRaiseHandStatusChanged: (BOOL) isAllowed
optionalrequired

Callback to attendee raise hand status changed.

Parameters
isAllowedIf the raise hand is allowed, the result is YES. If not, the result is NO.

◆ onAllowAttendeeViewTheParticipantCountStatusChanged:

- (void) onAllowAttendeeViewTheParticipantCountStatusChanged: (BOOL) isAllowed
optionalrequired

Callback to attendee view the participant count status changed.

Parameters
isAllowedIf attendees are allowed to view the participant count, the result is YES. Otherwise, the result is NO.

◆ onAllowPanelistStartVideoNoti

- (void) onAllowPanelistStartVideoNoti
optionalrequired

Callback to enable the panelist to start the video.

◆ onAllowWebinarReactionStatusChanged:

- (void) onAllowWebinarReactionStatusChanged: (BOOL) isAllowed
optionalrequired

Callback for when the host enables/disables emoji reactions.

Parameters
isAllowedIf the reaction is allowed, the value of isAllow is true, otherwise false.

◆ onAttendeeAudioStatusNoti:canTalk:isMuted:

- (void) onAttendeeAudioStatusNoti: (unsigned int) userid
canTalk: (BOOL) can_talk
isMuted: (BOOL) is_muted 
optionalrequired

Panelist will receive this callback if the attendee's audio status changed.

Parameters
useridThe user ID of attendee whose audio status changes.
is_mutedYES means the user is muted, otherwise not.

◆ onAttendeePromoteConfirmResult:isAgree:

- (void) onAttendeePromoteConfirmResult: (unsigned int) userid
isAgree: (BOOL) agree 
optionalrequired

Panelist will receive this callback if the attendee's audio status changed.

Parameters
useridThe user ID of attendee whose promote.
agreeYES means the user is agree join webinar as panelist.

◆ onDepromotePanelist2AttendeeResultNoti:

- (void) onDepromotePanelist2AttendeeResultNoti: (unsigned int) result
optionalrequired

Callback to demote panelist to attendee.

Parameters
resultThe result of demotion. If the promotion is successful, the result is zero(0). Otherwise it is an error code.

◆ onDisAllowPanelistStartVideoNoti

- (void) onDisAllowPanelistStartVideoNoti
optionalrequired

Callback to disable the panelist to start the video.

◆ onPromoteAttendee2PanelistResultNoti:

- (void) onPromoteAttendee2PanelistResultNoti: (unsigned int) result
optionalrequired

Callback to promote attendee to panelist.

Parameters
resultThe result of promotion. If the promotion is successful, the result is zero(0). Otherwise it is an error code.

◆ onSelfAllowTalkNoti

- (void) onSelfAllowTalkNoti
optional

Callback of users are allowed to talk in webinar. User needs to enable the mic in the view-only mode of webinar if he wants to talk.

◆ onSelfDisallowTalkNoti

- (void) onSelfDisallowTalkNoti
optionalrequired

Callback of users are disallowed to talk in webinar.

◆ onWebinarNeedInputScreenName:

- (void) onWebinarNeedInputScreenName: (ZoomSDKWebinarInputScreenNameHandler *_Nullable) handler
optionalrequired

When join the webinar, this callback is triggered if the user needs to input username.

Parameters
handlerAn object used by user to complete all the related operations.

◆ onWebinarNeedRegisterResponse:

- (ZoomSDKError) onWebinarNeedRegisterResponse: (ZoomSDKWebinarRegisterHelper *_Nullable) webinarRegisterHelper
optionalrequired

During the webinar, this callback will be triggered if the user needs to register.

Parameters
webinarRegisterHelperAn object used by user to complete all the related operations.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.