Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKMeetingConfiguration.h
Go to the documentation of this file.
1
5
6#import <ZoomSDK/ZoomSDKErrors.h>
7NS_ASSUME_NONNULL_BEGIN
8
13@interface ZoomSDKMeetingConfiguration :NSObject
14{
15 CGDirectDisplayID _displayAppID;
16 CGDirectDisplayID _monitorID;
75}
79@property(nonatomic, assign)CGDirectDisplayID displayAppID;
83@property(nonatomic, assign)CGDirectDisplayID monitorID;
87@property(nonatomic, assign)NSPoint floatVideoPoint;
91@property(nonatomic, assign)NSPoint mainVideoPoint;
95@property(nonatomic, assign)BOOL shareToolBarVisible;
99@property(nonatomic, assign)BOOL jbhWindowVisible;
103@property(nonatomic, assign)BOOL enableMuteOnEntry;
107@property(nonatomic, assign)BOOL isDirectShareDesktop;
111@property(nonatomic, assign)BOOL enableChime;
115@property(nonatomic, assign)BOOL disablePopupWrongPasswordWindow;
120@property(nonatomic, assign)BOOL autoAdjustSpeakerVolumeWhenJoinAudio DEPRECATED_MSG_ATTRIBUTE("No longer used");
125@property(nonatomic, assign)BOOL autoAdjustMicVolumeWhenJoinAudio DEPRECATED_MSG_ATTRIBUTE("No longer used");
130@property(nonatomic, assign)BOOL disableEndOtherMeetingAlert DEPRECATED_MSG_ATTRIBUTE("No longer used");
134@property(nonatomic, assign)BOOL hideEndOtherMeetingAlert;
138@property(nonatomic, assign)BOOL enableAutoEndOtherMeeting;
142@property(nonatomic, assign)BOOL disableInputPasswordWindow;
146@property(nonatomic, assign)BOOL disableDoubleClickToFullScreen;
150@property(nonatomic, assign)BOOL hideThumbnailVideoWindow;
154@property(nonatomic, assign)BOOL disableRenameInMeeting;
158@property(nonatomic, assign)BOOL disableShareButtonClickOriginAction;
162@property(nonatomic, assign)BOOL disableToolbarInviteButtonClickOriginAction;
166@property(nonatomic, assign)BOOL needPrefillWebinarJoinInfo;
170@property(nonatomic, assign)BOOL hideRegisterWebinarInfoWindow;
174@property(nonatomic, assign)BOOL hideWebinarNameInputWindow;
178@property(nonatomic, assign)BOOL disableParticipantButtonClickOriginAction;
182@property(nonatomic, assign)BOOL hideTelephoneInAudioWindow;
186@property(nonatomic, assign)BOOL hideCallMeInAudioWindow;
190@property(nonatomic, assign)BOOL forceDisableMultiShare;
194@property(nonatomic, assign)BOOL disableCustomLiveStreamAction;
198@property(nonatomic, assign)BOOL disableFreeUserOriginAction;
202@property(nonatomic, assign)BOOL disableFreeMeetingRemainTimeNotify;
206@property(nonatomic, assign)BOOL hideInviteInMeetingH323CallInTab;
210@property(nonatomic, assign)BOOL hideInviteInMeetingH323CallOutTab;
214@property(nonatomic, assign)BOOL hideMeetingStaticBadNetWorkWaring;
218@property(nonatomic, assign)BOOL hideMeetingStaticSystemBusyWaring;
222@property(nonatomic, assign)BOOL hideSwitchCameraButton;
226@property(nonatomic, assign)BOOL disableOpenRecordFileWhenMeetingEnd;
230@property(nonatomic, assign)BOOL hideShowKeypadButton;
234@property(nonatomic, assign)BOOL hideCopyURLButtonWhenInviteOthers;
238@property(nonatomic, assign)BOOL hideCopyInvitationButtonWhenInviteOthers;
242@property(nonatomic, assign)BOOL hideChatItemInMeeting;
246@property(nonatomic, assign)BOOL hideRemoteControlItemOnMoreMenu;
250@property(nonatomic, assign)BOOL hideChooseSaveRecordingFilePathWindow;
254@property(nonatomic, assign)BOOL disableAudioButtonClickOriginAction;
258@property(nonatomic, assign)BOOL disableAudioSettingMenuButtonClickOriginAction;
262@property(nonatomic, assign)BOOL hideLoadingWindow;
266@property(nonatomic, assign)BOOL disableBreakoutRoomsButtonClickOriginAction;
270@property(nonatomic, assign)BOOL hideMeetingInfoButtonOnVideo;
274@property(nonatomic, assign)BOOL hideInviteButtonOnHCWindow;
278@property(nonatomic, assign)BOOL disableToolbarLeaveButtonClickOriginAction;
286@property(nonatomic, assign)BOOL hideInviteLinkOnMeetingUI;
290@property(nonatomic, assign)BOOL hideCloudWhiteboardFeedbackButton;
294@property(nonatomic, assign)BOOL hideCloudWhiteboardShareButton;
298@property(nonatomic, assign)BOOL hideCloudWhiteboardAboutButton;
302@property(nonatomic, assign)BOOL hideCloudWhiteboardHelperCenterButton;
306@property(nonatomic, assign)BOOL hideCloudWhiteboardOpenInBrowserButton;
310@property(nonatomic, assign)BOOL hideConfirmStartArchiveWindow;
314@property(nonatomic, assign)BOOL hideRecoverMeetingWindow;
315
322- (ZoomSDKError)prefillWebinarUserName:(NSString*)userName Email:(NSString*)email;
323
330- (ZoomSDKError)hideSDKButtons:(BOOL)hide ButtonType:(SDKButton)button;
331
339- (ZoomSDKError)modifyVideoDSCP:(int)videoDSCP AudioDSCP:(int)audioDSCP;
340
344- (void)reset;
345
351- (ZoomSDKError)enableCloudWhiteboard:(BOOL)enable;
352
358- (ZoomSDKError)enableGrabShareWithoutReminder:(BOOL)enable;
359
364- (void)setHideMeetingInputUserInfoWindow:(BOOL)hide;
365
371@end
372NS_ASSUME_NONNULL_END
SDKButton
Enumeration of in-meeting buttons on the toolbar.
ZoomSDKError
Enumeration of common errors of SDK.
Meeting configuration class to control various meeting UI and behavior settings.
BOOL hideCloudWhiteboardShareButton
Sets the share button’s visibility on cloud Whiteboard. Default is displaying.
BOOL disableToolbarLeaveButtonClickOriginAction
Disables ZOOM original actions of clicking toolbar Leave button.
BOOL disableAudioSettingMenuButtonClickOriginAction
Disables audio menu item original action in-meeting.
BOOL hideChatItemInMeeting
Hides chat menu item in-meeting.
BOOL jbhWindowVisible
The window's visibility of waiting for the host.
BOOL hideRegisterWebinarInfoWindow
Hides register webinar window when join webinar.
BOOL hideMeetingInfoButtonOnVideo
Hides meeting info button on video UI.
BOOL hideEndOtherMeetingAlert
Hides the alert to end another ongoing meeting.
BOOL disableRenameInMeeting
Disables to rename in meeting.
BOOL disableOpenRecordFileWhenMeetingEnd
Disables opening recording file when meeting end.
BOOL hideCallMeInAudioWindow
Hides the window of CALL ME.
BOOL hideMeetingStaticSystemBusyWaring
Hides meeting static warning of system busy.
BOOL hideCopyURLButtonWhenInviteOthers
Hides copy URL button when invite others join meeting.
BOOL disableFreeUserOriginAction
Sets whether to disable ZOOM original reminder action for free user.
BOOL hideRecoverMeetingWindow
Enables or disable hiding the recover meeting window in Zoom UI mode.
BOOL hideTelephoneInAudioWindow
Hides the window of phone dialing in.
BOOL hideConfirmStartArchiveWindow
Sets the confirm start archive dialog to hide or display. Default is displaying.
BOOL disableShareButtonClickOriginAction
Disables ZOOM original actions of clicking share button.
BOOL hideRemoteControlItemOnMoreMenu
Hides remote control item on more menu.
BOOL autoAdjustMicVolumeWhenJoinAudio
Enables auto-adjust the microphone volume.
BOOL enableAutoEndOtherMeeting
Auto end another ongoing meeting.
BOOL disableBreakoutRoomsButtonClickOriginAction
Disables ZOOM original actions of clicking button breakout rooms.
BOOL disableAudioButtonClickOriginAction
Disables ZOOM original actions of clicking Audio button.
BOOL disableToolbarInviteButtonClickOriginAction
Disables ZOOM original actions of clicking toolbar invite button.
void reset()
Resets all properties in this class.
BOOL isDirectShareDesktop
Query whether to share screen or not.
BOOL hideSwitchCameraButton
Hides switch camera button when sharing camera.
BOOL hideLoadingWindow
Hides loading window when start meeting without login.
BOOL disableCustomLiveStreamAction
Disables custom live stream.
BOOL hideInviteInMeetingH323CallInTab
Hides the h323 call in tab on invite window.
BOOL needPrefillWebinarJoinInfo
Input meeting information in advance when user joins webinar.
NSPoint floatVideoPoint
The location of float video.
BOOL hideCloudWhiteboardFeedbackButton
Sets the feedback button’s visibility on cloud Whiteboard. Default is displaying.
BOOL disablePopupWrongPasswordWindow
Hides the prompt dialog of wrong password.
BOOL shareToolBarVisible
The visibility of toolbar when sharing.
BOOL hideMeetingStaticBadNetWorkWaring
Hides meeting static warning of bad network.
BOOL hideInviteLinkOnMeetingUI
Hide invited link on meeting info window.
BOOL disableToolbarCloseCaptionButtonClickOriginAction
Disables ZOOM original actions of clicking toolbar CloseCaption button.
BOOL hideCloudWhiteboardAboutButton
Sets the about button’s visibility on the cloud whiteboard. Default is displaying.
BOOL disableFreeMeetingRemainTimeNotify
Disables the ZOOM original notification of remaining time for meeting organized by free user.
BOOL hideInviteInMeetingH323CallOutTab
Hides the h323 call out tab on invite window.
BOOL isHideMeetingInputUserInfoWindow()
Gets the meeting input user info dialog to hide or display.
BOOL hideThumbnailVideoWindow
Hides the window of thumbnail video.
BOOL enableChime
Play chime when user joins or leaves meeting.
BOOL hideChooseSaveRecordingFilePathWindow
Hides choose save recording file path window.
BOOL hideInviteButtonOnHCWindow
Hides invited button on participants window.
CGDirectDisplayID monitorID
The monitor ID to be shared.
BOOL forceDisableMultiShare
Forbid multi-participants sharing at the same time.
BOOL disableInputPasswordWindow
Disables input password window.
BOOL disableParticipantButtonClickOriginAction
Disables ZOOM original actions of clicking button participants.
BOOL hideShowKeypadButton
Hides 'show keypad' button on meeting window.
BOOL autoAdjustSpeakerVolumeWhenJoinAudio
Enables auto-adjust the speaker volume when joining meeting.
CGDirectDisplayID displayAppID
The APP ID to be shared.
BOOL hideCopyInvitationButtonWhenInviteOthers
Hides copy Invitation button when invite others join meeting.
NSPoint mainVideoPoint
The location of main interface of meeting.
BOOL enableMuteOnEntry
Attendees join the meeting with audio muted.
BOOL hideCloudWhiteboardOpenInBrowserButton
Sets the Open in browser button's visibility on cloud whiteboard. Default is displaying.
BOOL hideCloudWhiteboardHelperCenterButton
Sets the Helper center button's visibility on cloud whiteboard. Default is displaying.
BOOL disableEndOtherMeetingAlert
Disables the alert to end another ongoing meeting.
BOOL disableDoubleClickToFullScreen
Disables the feature to enter full screen by double click.
BOOL hideWebinarNameInputWindow
Hides input name window when join webinar.