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{
21}
37
48
54@end
55
56
61@interface ZoomSDKWebinarRegisterHelper :NSObject
62{
64}
74- (NSURL*_Nullable)getWebinarRegisterURL;
81- (ZoomSDKError)inputEmail:(NSString*)email screenName:(NSString*)name;
86@end
87
88
99- (ZoomSDKError)inputName:(NSString*)name;
104@end
105
106
111@protocol ZoomSDKWebinarControllerDelegate <NSObject>
112@optional
125- (void)onPromoteAttendee2PanelistResultNoti:(unsigned int)result;
130- (void)onDepromotePanelist2AttendeeResultNoti:(unsigned int)result;
144- (void)onAttendeeAudioStatusNoti:(unsigned int)userid canTalk:(BOOL)can_talk isMuted:(BOOL)is_muted;
150- (ZoomSDKError)onWebinarNeedRegisterResponse:(ZoomSDKWebinarRegisterHelper*_Nullable)webinarRegisterHelper;
156- (void)onAttendeePromoteConfirmResult:(unsigned int)userid isAgree:(BOOL)agree;
157
162- (void)onAllowWebinarReactionStatusChanged:(BOOL)isAllowed;
163
168- (void)onAllowAttendeeRaiseHandStatusChanged:(BOOL)isAllowed;
169
174- (void)onAllowAttendeeViewTheParticipantCountStatusChanged:(BOOL)isAllowed;
175
180- (void)onWebinarNeedInputScreenName:(ZoomSDKWebinarInputScreenNameHandler*_Nullable)handler;
181@end
182
183
188@interface ZoomSDKWebinarController : NSObject
189{
190 id<ZoomSDKWebinarControllerDelegate> _delegate;
192}
193
197@property(nonatomic, assign, nullable)id<ZoomSDKWebinarControllerDelegate> delegate;
202
208- (ZoomSDKError)PromoteAttendee2Panelist:(unsigned int)userId;
209
215- (ZoomSDKError)DepromotePanelist2Attendee:(unsigned int)userId;
216
222- (ZoomSDKError)AllowAttendeeTalk:(unsigned int)userId;
223
229- (ZoomSDKError)DisallowAttendeeTalk:(unsigned int)userId;
230
236
242
248
253- (NSArray*_Nullable)getAttendeeList;
254
260- (ZoomSDKError)setPanelistChatPrivilege:(ZoomSDKPanelistChatPrivilege)privilege;
261
267- (ZoomSDKError)getPanelistChatPrivilege:(ZoomSDKPanelistChatPrivilege*)privilege;
268
274- (ZoomSDKError)setAttendeeViewMode:(ZoomSDKAttendeeViewMode)mode;
275
281
288
295
302
309
316
323
329
335
341
348
355
362
363@end
364NS_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.
BOOL canStartWebinar()
Check if the current user can start the webinar.
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
ZoomSDKError startWebinar()
Start the webinar broadcast.
NSArray *_Nullable getAttendeeList()
Gets the list of attendees in the meeting.
ZoomSDKError allowWebinarEmojiReaction()
Permitted to use emoji reactions.
BOOL isWebinarStarted()
Check if the webinar has already started broadcasting.
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 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 ...