Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKWebinarController.h
Go to the documentation of this file.
1
5
6
7#import <Foundation/Foundation.h>
8#import <ZoomSDK/ZoomSDKErrors.h>
9
10NS_ASSUME_NONNULL_BEGIN
11
16@interface ZoomSDKWebinarMeetingStatus : NSObject
17{
22}
43- (BOOL)isSupportAttendeeTalk DEPRECATED_MSG_ATTRIBUTE("No longer used");
54
60@end
61
62
67@interface ZoomSDKWebinarRegisterHelper :NSObject
68{
70}
80- (NSURL*_Nullable)getWebinarRegisterURL;
87- (ZoomSDKError)inputEmail:(NSString*)email screenName:(NSString*)name;
92@end
93
94
105- (ZoomSDKError)inputName:(NSString*)name;
110@end
111
112
117@protocol ZoomSDKWebinarControllerDelegate <NSObject>
118@optional
131- (void)onPromoteAttendee2PanelistResultNoti:(unsigned int)result;
136- (void)onDepromotePanelist2AttendeeResultNoti:(unsigned int)result;
150- (void)onAttendeeAudioStatusNoti:(unsigned int)userid canTalk:(BOOL)can_talk isMuted:(BOOL)is_muted;
156- (ZoomSDKError)onWebinarNeedRegisterResponse:(ZoomSDKWebinarRegisterHelper*_Nullable)webinarRegisterHelper;
162- (void)onAttendeePromoteConfirmResult:(unsigned int)userid isAgree:(BOOL)agree;
163
168- (void)onAllowWebinarReactionStatusChanged:(BOOL)isAllowed;
169
174- (void)onAllowAttendeeRaiseHandStatusChanged:(BOOL)isAllowed;
175
180- (void)onAllowAttendeeViewTheParticipantCountStatusChanged:(BOOL)isAllowed;
181
186- (void)onWebinarNeedInputScreenName:(ZoomSDKWebinarInputScreenNameHandler*_Nullable)handler;
187@end
188
189
194@interface ZoomSDKWebinarController : NSObject
195{
196 id<ZoomSDKWebinarControllerDelegate> _delegate;
198}
199
203@property(nonatomic, assign, nullable)id<ZoomSDKWebinarControllerDelegate> delegate;
208
214- (ZoomSDKError)PromoteAttendee2Panelist:(unsigned int)userId;
215
221- (ZoomSDKError)DepromotePanelist2Attendee:(unsigned int)userId;
222
228- (ZoomSDKError)AllowAttendeeTalk:(unsigned int)userId;
229
235- (ZoomSDKError)DisallowAttendeeTalk:(unsigned int)userId;
236
242
248
254
259- (NSArray*_Nullable)getAttendeeList;
260
266- (ZoomSDKError)setPanelistChatPrivilege:(ZoomSDKPanelistChatPrivilege)privilege;
267
273- (ZoomSDKError)getPanelistChatPrivilege:(ZoomSDKPanelistChatPrivilege*)privilege;
274
280- (ZoomSDKError)setAttendeeViewMode:(ZoomSDKAttendeeViewMode)mode;
281
287
294
301
308
315
322
329
335
341
347@end
348NS_ASSUME_NONNULL_END
ZoomSDKPanelistChatPrivilege
Enumeration of the panelist chat privilege in webinar meeting.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKAttendeeViewMode
Enumeration of attendee view modes in a Zoom meeting. For more information, please visit https://supp...
WebinarRegisterType
Enumeration of types to register webinar.
Controller for managing webinar-specific functions.
ZoomSDKAttendeeViewMode getAttendeeViewMode()
Gets the attendee's view mode.
id< ZoomSDKWebinarControllerDelegate > _delegate
ZoomSDKWebinarMeetingStatus * webinarMeetingStatus
Gets the webinar meeting status.
int getParticipantCount()
Gets the participant count.
ZoomSDKError disallowAttendeeRaiseHand()
Do not let the attendee to raise their hand.
NSString * getWebinarRegistrationLegalNoticesPrompt()
Gets the webinal legal notices prompt.
ZoomSDKError disallowAttendeeViewTheParticipantCount()
Forbid the attendee to view the participant count.
ZoomSDKError disallowWebinarEmojiReaction()
Forbid use of emoji reactions.
id< ZoomSDKWebinarControllerDelegate > delegate
Sets the webinar controller delegate.
ZoomSDKError AllowPanelistStartVideo()
The panelist is permitted to start the video.
ZoomSDKWebinarRegistrationExplainInfo * getWebinarRegistrationLegalNoticesExplained()
Gets the webinal legal notices explained.
ZoomSDKWebinarMeetingStatus * _webinarMeetingStatus
NSArray *_Nullable getAttendeeList()
Gets the list of attendees in the meeting.
ZoomSDKError allowWebinarEmojiReaction()
Permitted to use emoji reactions.
ZoomSDKError DisallowPanelistStartVideo()
Forbid the panelist to start video.
ZoomSDKError allowAttendeeViewTheParticipantCount()
The attendee is permitted to view the participant count.
ZoomSDKWebinarMeetingStatus *_Nullable getZoomSDKWebinarMeetingStatus()
Gets the webinar status.
ZoomSDKError allowAttendeeRaiseHand()
The attendees can raise their hands.
Handler for entering screen name when joining a webinar.
ZoomSDKError cancel()
Cancels to join webinar.
Status information of the current webinar.
BOOL isWebinarEmojiReactionAllowed()
Query if emoji reactions status.
BOOL isAllowRaiseHand()
Query if attendee raise hand status.
BOOL isWebinarEmojiReactionSupported()
Determines if current webinar supports emoji reactions.
BOOL canAttendeesViewParticipantCount()
Query if attendee to view the participant count status.
BOOL isAllowAttendeeChat()
Query if attendee is allowed to chat.
BOOL isSupportAttendeeTalk()
Query if webinar supports attendee to talk.
BOOL isAllowPanellistStartVideo()
Query if panelist is allowed to start video.
Helper class for webinar registration.
NSURL *_Nullable getWebinarRegisterURL()
Gets URL of user registers webinar.
ZoomSDKError cancel()
Cancels to register webinar.
WebinarRegisterType getWebinarRegisterType()
Gets type of user registers webinar.
Holds explanatory information related to webinar registration.
void onDisAllowPanelistStartVideoNoti()
Callback to disable the panelist to start the video.
void onSelfDisallowTalkNoti()
Callback of users are disallowed to talk in webinar.
void onAllowPanelistStartVideoNoti()
Callback to enable the panelist to start the video.
void onSelfAllowTalkNoti()
Callback of users are allowed to talk in webinar. User needs to enable the mic in the view-only mode ...