Webinar controller interface. More...

#include <ZoomSDKWebinarController.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- PromoteAttendee2Panelist:
	Promote the specified attendee to panelist.

(ZoomSDKError)	- DepromotePanelist2Attendee:
	Demote the specified panelist to attendee.

(ZoomSDKError)	- AllowAttendeeTalk:
	The attendee is permitted to use the audio device.

(ZoomSDKError)	- DisallowAttendeeTalk:
	Forbid the attendee to use the audio device.

(ZoomSDKError)	- AllowPanelistStartVideo
	The panelist is permitted to start the video.

(ZoomSDKError)	- DisallowPanelistStartVideo
	Forbid the panelist to start video.

(ZoomSDKWebinarMeetingStatus *_Nullable)	- getZoomSDKWebinarMeetingStatus
	Get the webinar status.

(NSArray *_Nullable)	- getAttendeeList
	Get the list of attendees in the meeting.

(ZoomSDKError)	- setPanelistChatPrivilege:
	Set the chat privilege of the panelist.

(ZoomSDKError)	- getPanelistChatPrivilege:
	Get the chat privilege of the panelist.

(ZoomSDKError)	- setAttendeeViewMode:
	Set the view mode of the attendee.

(ZoomSDKAttendeeViewMode)	- getAttendeeViewMode
	Get the view mode of the attendee.

(ZoomSDKError)	- allowWebinarEmojiReaction
	Permitted to use emoji reactions.

(ZoomSDKError)	- disallowWebinarEmojiReaction
	Forbid use of emoji reactions.

(ZoomSDKError)	- allowAttendeeRaiseHand
	The attendees can raise their hands.

(ZoomSDKError)	- disallowAttendeeRaiseHand
	Do not let the attendee to raise their hand.

(ZoomSDKError)	- allowAttendeeViewTheParticipantCount
	The attendee is permitted to view the participant count.

(ZoomSDKError)	- disallowAttendeeViewTheParticipantCount
	Forbid the attendee to view the participant count.

(int)	- getParticipantCount
	Get the participant count.

(NSString *)	- getWebinarRegistrationLegalNoticesPrompt
	Get the webinal legal notices prompt.

(ZoomSDKWebinarRegistrationExplainInfo *)	- getWebinarRegistrationLegalNoticesExplained
	Get the webinal legal notices explained.

Protected Attributes
id< ZoomSDKWebinarControllerDelegate >	_delegate

ZoomSDKWebinarMeetingStatus *	_webinarMeetingStatus

Properties
id< ZoomSDKWebinarControllerDelegate >	delegate

ZoomSDKWebinarMeetingStatus *	webinarMeetingStatus

Detailed Description

Webinar controller interface.

Definition at line 169 of file ZoomSDKWebinarController.h.

Method Documentation

◆ allowAttendeeRaiseHand

- (ZoomSDKError) allowAttendeeRaiseHand

The attendees can raise their hands.

Returns: If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.

Note: If the function succeeds, the user receives the '- (void)onAllowAttendeeRaiseHandStatusChanged:(BOOL)isAllowed' callback event. Available only for the host.

◆ AllowAttendeeTalk:

- (ZoomSDKError) AllowAttendeeTalk: (unsigned int) userId

The attendee is permitted to use the audio device.

Parameters

userId Specify the permitted user ID.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ allowAttendeeViewTheParticipantCount

- (ZoomSDKError) allowAttendeeViewTheParticipantCount

The attendee is permitted to view the participant count.

Returns: If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.

Note: If the function succeeds, the user receives the '- (void)onAllowAttendeeViewTheParticipantCountStatusChanged:(BOOL)isAllowed' callback event. Available only for the host.

◆ AllowPanelistStartVideo

- (ZoomSDKError) AllowPanelistStartVideo

The panelist is permitted to start the video.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ allowWebinarEmojiReaction

- (ZoomSDKError) allowWebinarEmojiReaction

Permitted to use emoji reactions.

Returns: If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.

Note: If the function succeeds, the user receives the '- (void)onAllowWebinarReactionStatusChanged:(BOOL)isAllowed' callback event. Available only for the host.

◆ DepromotePanelist2Attendee:

- (ZoomSDKError) DepromotePanelist2Attendee: (unsigned int) userId

Demote the specified panelist to attendee.

Parameters

userId The ID of the specified panelist.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ disallowAttendeeRaiseHand

- (ZoomSDKError) disallowAttendeeRaiseHand

Do not let the attendee to raise their hand.

Returns: If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.

Note: If the function succeeds, the user receives the '- (void)onAllowAttendeeRaiseHandStatusChanged:(BOOL)isAllowed' callback event. Available only for the host.

◆ DisallowAttendeeTalk:

- (ZoomSDKError) DisallowAttendeeTalk: (unsigned int) userId

Forbid the attendee to use the audio device.

Parameters

userId Specify the forbidden user ID.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ disallowAttendeeViewTheParticipantCount

- (ZoomSDKError) disallowAttendeeViewTheParticipantCount

Forbid the attendee to view the participant count.

Returns: If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.

Note: If the function succeeds, the user receives the '- (void)onAllowAttendeeViewTheParticipantCountStatusChanged:(BOOL)isAllowed' callback event. Available only for the host.

◆ DisallowPanelistStartVideo

- (ZoomSDKError) DisallowPanelistStartVideo

Forbid the panelist to start video.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ disallowWebinarEmojiReaction

- (ZoomSDKError) disallowWebinarEmojiReaction

Forbid use of emoji reactions.

Returns: If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.

Note: If the function succeeds, the user receives the '- (void)onAllowWebinarReactionStatusChanged:(BOOL)isAllowed' callback event. Available only for the host.

◆ getAttendeeList

- (NSArray *_Nullable) getAttendeeList

Get the list of attendees in the meeting.

Returns: If the function succeeds, it will return an NSArray of attendees.

◆ getAttendeeViewMode

- (ZoomSDKAttendeeViewMode) getAttendeeViewMode

Get the view mode of the attendee.

Returns: If the function succeeds, it will return the attendee's view mode. For more details, see ZoomSDKAttendeeViewMode.

◆ getPanelistChatPrivilege:

- (ZoomSDKError) getPanelistChatPrivilege: (ZoomSDKPanelistChatPrivilege *) privilege

Get the chat privilege of the panelist.

Parameters

privilege The chat privilege of the panelist. It validates only when the return value is ZoomSDKError_Success.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ getParticipantCount

- (int) getParticipantCount

Get the participant count.

Returns: The participant count of.

◆ getWebinarRegistrationLegalNoticesExplained

- (ZoomSDKWebinarRegistrationExplainInfo *) getWebinarRegistrationLegalNoticesExplained

Get the webinal legal notices explained.

Returns: If the function succeeds, it will return the webinal legal notices explained. Otherwise nil.

◆ getWebinarRegistrationLegalNoticesPrompt

- (NSString *) getWebinarRegistrationLegalNoticesPrompt

Get the webinal legal notices prompt.

Returns: If the function succeeds, it will return the webinal legal notices prompt. Otherwise nil.

◆ getZoomSDKWebinarMeetingStatus

- (ZoomSDKWebinarMeetingStatus *_Nullable) getZoomSDKWebinarMeetingStatus

Get the webinar status.

Returns: If the function succeeds, it will return an object of ZoomSDKWebinarMeetingStatus.

◆ PromoteAttendee2Panelist:

- (ZoomSDKError) PromoteAttendee2Panelist: (unsigned int) userId

Promote the specified attendee to panelist.

Parameters

userId The ID of the specified attendee.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ setAttendeeViewMode:

- (ZoomSDKError) setAttendeeViewMode: (ZoomSDKAttendeeViewMode) mode

Set the view mode of the attendee.

Parameters

mode	The view mode of the attendee. For more details see ZoomSDKAttendeeViewMode.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise the function returns an error.

◆ setPanelistChatPrivilege:

- (ZoomSDKError) setPanelistChatPrivilege: (ZoomSDKPanelistChatPrivilege) privilege

Set the chat privilege of the panelist.

Parameters

privilege The chat privilege of the panelist.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

Field Documentation

◆ _delegate

- (id<ZoomSDKWebinarControllerDelegate>) _delegate

protected

Definition at line 171 of file ZoomSDKWebinarController.h.

◆ _webinarMeetingStatus

- (ZoomSDKWebinarMeetingStatus*) _webinarMeetingStatus

protected

Definition at line 172 of file ZoomSDKWebinarController.h.

Property Documentation

◆ delegate

- (id<ZoomSDKWebinarControllerDelegate>) delegate

readwritenonatomicassign

Definition at line 174 of file ZoomSDKWebinarController.h.

◆ webinarMeetingStatus

- (ZoomSDKWebinarMeetingStatus*) webinarMeetingStatus

readwritenonatomicretain

Definition at line 175 of file ZoomSDKWebinarController.h.

Instance Methods

Protected Attributes

Properties

Detailed Description

Method Documentation

◆ allowAttendeeRaiseHand

◆ AllowAttendeeTalk:

◆ allowAttendeeViewTheParticipantCount

◆ AllowPanelistStartVideo

◆ allowWebinarEmojiReaction

◆ DepromotePanelist2Attendee:

◆ disallowAttendeeRaiseHand

◆ DisallowAttendeeTalk:

◆ disallowAttendeeViewTheParticipantCount

◆ DisallowPanelistStartVideo

◆ disallowWebinarEmojiReaction

◆ getAttendeeList

◆ getAttendeeViewMode

◆ getPanelistChatPrivilege:

◆ getParticipantCount

◆ getWebinarRegistrationLegalNoticesExplained

◆ getWebinarRegistrationLegalNoticesPrompt

◆ getZoomSDKWebinarMeetingStatus

◆ PromoteAttendee2Panelist:

◆ setAttendeeViewMode:

◆ setPanelistChatPrivilege:

Field Documentation

◆ _delegate

◆ _webinarMeetingStatus

Property Documentation

◆ delegate

◆ webinarMeetingStatus