ZoomSDKWebinarController Class Reference

Controller for managing webinar-specific functions. 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
	Gets the webinar status.
(NSArray *_Nullable)	- getAttendeeList
	Gets the list of attendees in the meeting.
(ZoomSDKError)	- setPanelistChatPrivilege:
	Sets the panelist's chat privilege.
(ZoomSDKError)	- getPanelistChatPrivilege:
	Gets the panelist's chat privilege.
(ZoomSDKError)	- setAttendeeViewMode:
	Sets the attendee's view mode.
(ZoomSDKAttendeeViewMode)	- getAttendeeViewMode
	Gets the attendee's view mode.
(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
	Gets the participant count.
(NSString *)	- getWebinarRegistrationLegalNoticesPrompt
	Gets the webinal legal notices prompt.
(ZoomSDKWebinarRegistrationExplainInfo *)	- getWebinarRegistrationLegalNoticesExplained
	Gets the webinal legal notices explained.

Protected Attributes
id< ZoomSDKWebinarControllerDelegate >	_delegate
ZoomSDKWebinarMeetingStatus *	_webinarMeetingStatus

Properties
id< ZoomSDKWebinarControllerDelegate >	delegate
	Sets the webinar controller delegate.
ZoomSDKWebinarMeetingStatus *	webinarMeetingStatus
	Gets the webinar meeting status.

Detailed Description

Controller for managing webinar-specific functions.

Definition at line 194 of file ZoomSDKWebinarController.h.

Method Documentation

allowAttendeeRaiseHand

- (ZoomSDKError) allowAttendeeRaiseHand

The attendees can raise their hands.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

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 returns ZoomSDKError_Success. Otherwise, this function returns an error.

allowAttendeeViewTheParticipantCount

- (ZoomSDKError) allowAttendeeViewTheParticipantCount

The attendee is permitted to view the participant count.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

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 returns ZoomSDKError_Success. Otherwise, this function returns an error.

allowWebinarEmojiReaction

- (ZoomSDKError) allowWebinarEmojiReaction

Permitted to use emoji reactions.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

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 specified's ID panelist.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

disallowAttendeeRaiseHand

- (ZoomSDKError) disallowAttendeeRaiseHand

Do not let the attendee to raise their hand.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

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 returns ZoomSDKError_Success. Otherwise, this function returns an error.

disallowAttendeeViewTheParticipantCount

- (ZoomSDKError) disallowAttendeeViewTheParticipantCount

Forbid the attendee to view the participant count.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

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 returns ZoomSDKError_Success. Otherwise, this function returns an error.

disallowWebinarEmojiReaction

- (ZoomSDKError) disallowWebinarEmojiReaction

Forbid use of emoji reactions.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

Note

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

getAttendeeList

- (NSArray *_Nullable) getAttendeeList

Gets the list of attendees in the meeting.

Returns

If the function succeeds, it returns an NSArray of attendees. Otherwise, this function fails and returns nil.

getAttendeeViewMode

- (ZoomSDKAttendeeViewMode) getAttendeeViewMode

Gets the attendee's view mode.

Returns

The attendee's view mode.

getPanelistChatPrivilege:

- (ZoomSDKError) getPanelistChatPrivilege:

(ZoomSDKPanelistChatPrivilege *)

privilege

Gets the panelist's chat privilege.

Parameters

privilege

The panelist's chat privilege. It validates only when it returns ZoomSDKError_Success.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

getParticipantCount

- (int) getParticipantCount

Gets the participant count.

Returns

The participant count of.

getWebinarRegistrationLegalNoticesExplained

- (ZoomSDKWebinarRegistrationExplainInfo *) getWebinarRegistrationLegalNoticesExplained

Gets the webinal legal notices explained.

Returns

If the function succeeds, it returns the webinal legal notices explained. Otherwise, this function fails and returns nil.

getWebinarRegistrationLegalNoticesPrompt

- (NSString *) getWebinarRegistrationLegalNoticesPrompt

Gets the webinal legal notices prompt.

Returns

If the function succeeds, it returns the webinal legal notices prompt. Otherwise, this function fails and returns nil.

getZoomSDKWebinarMeetingStatus

- (ZoomSDKWebinarMeetingStatus *_Nullable) getZoomSDKWebinarMeetingStatus

Gets the webinar status.

Returns

If the function succeeds, it returns an object of ZoomSDKWebinarMeetingStatus. Otherwise, this function fails and returns nil.

PromoteAttendee2Panelist:

- (ZoomSDKError) PromoteAttendee2Panelist:

(unsigned int)

userId

Promote the specified attendee to panelist.

Parameters

userId

The specified's ID attendee.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

setAttendeeViewMode:

- (ZoomSDKError) setAttendeeViewMode:

(ZoomSDKAttendeeViewMode)

mode

Sets the attendee's view mode.

Parameters

mode	The attendee's view mode.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

setPanelistChatPrivilege:

- (ZoomSDKError) setPanelistChatPrivilege:

(ZoomSDKPanelistChatPrivilege)

privilege

Sets the panelist's chat privilege.

Parameters

privilege

The panelist's chat privilege.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Field Documentation

_delegate

- (id<ZoomSDKWebinarControllerDelegate>) _delegate

protected

Definition at line 196 of file ZoomSDKWebinarController.h.

_webinarMeetingStatus

- (ZoomSDKWebinarMeetingStatus*) _webinarMeetingStatus

protected

Definition at line 197 of file ZoomSDKWebinarController.h.

Property Documentation

delegate

- (id<ZoomSDKWebinarControllerDelegate>) delegate

readwritenonatomicassign

Sets the webinar controller delegate.

Definition at line 203 of file ZoomSDKWebinarController.h.

webinarMeetingStatus

- (ZoomSDKWebinarMeetingStatus*) webinarMeetingStatus

readwritenonatomicretain

Gets the webinar meeting status.

Definition at line 207 of file ZoomSDKWebinarController.h.