Meeting SDK for macOS API Reference
|
Meeting configuration class to control various meeting UI and behavior settings. More...
#include <ZoomSDKMeetingConfiguration.h>
Inherits NSObject.
Instance Methods | |
(ZoomSDKError) | - prefillWebinarUserName:Email: |
Prefill the user name and email info when joining webinar. | |
(ZoomSDKError) | - hideSDKButtons:ButtonType: |
Hide or show specified SDK buttons. | |
(ZoomSDKError) | - modifyVideoDSCP:AudioDSCP: |
Modify the DSCP of audio and video. | |
(void) | - reset |
Reset all properties in this class. | |
(ZoomSDKError) | - enableCloudWhiteboard: |
Enable or disable the new Zoom Whiteboard feature (different from Classic Whiteboard). This is enabled by default. | |
(ZoomSDKError) | - enableGrabShareWithoutReminder: |
Set whether to close the current sharing of another user without prompt and directly beginning a new sharing content by the closer. | |
(void) | - setHideMeetingInputUserInfoWindow: |
Set the meeting input user info dialog to hide or display. | |
(BOOL) | - isHideMeetingInputUserInfoWindow |
Get the meeting input user info dialog to hide or display. | |
Properties | |
CGDirectDisplayID | displayAppID |
The APP ID to be shared. | |
CGDirectDisplayID | monitorID |
The monitor ID to be shared. | |
NSPoint | floatVideoPoint |
The location of float video. | |
NSPoint | mainVideoPoint |
The location of main interface of meeting. | |
BOOL | shareToolBarVisible |
The visibility of toolbar when sharing. | |
BOOL | jbhWindowVisible |
The visibility of the window of waiting for the host. | |
BOOL | enableMuteOnEntry |
Attendees join the meeting with audio muted. | |
BOOL | isDirectShareDesktop |
Query whether to share screen or not. | |
BOOL | enableChime |
Play chime when user joins/leaves meeting. | |
BOOL | disablePopupWrongPasswordWindow |
Hide the prompt dialog of wrong password. | |
BOOL | autoAdjustSpeakerVolumeWhenJoinAudio |
Enable auto-adjust the speaker volume when joining meeting. | |
BOOL | autoAdjustMicVolumeWhenJoinAudio |
Enable auto-adjust the microphone volume. | |
BOOL | disableEndOtherMeetingAlert |
Disable the alert to end another ongoing meeting. | |
BOOL | hideEndOtherMeetingAlert |
Hide the alert to end another ongoing meeting. | |
BOOL | enableAutoEndOtherMeeting |
Auto end another ongoing meeting. | |
BOOL | disableInputPasswordWindow |
Disable input password window. | |
BOOL | disableDoubleClickToFullScreen |
Disable the feature to enter full screen by double click. | |
BOOL | hideThumbnailVideoWindow |
Hide the window of thumbnail video. | |
BOOL | disableRenameInMeeting |
Disable to rename in meeting. | |
BOOL | disableShareButtonClickOriginAction |
Disable ZOOM original actions of clicking share button. | |
BOOL | disableToolbarInviteButtonClickOriginAction |
Disable ZOOM original actions of clicking toolbar invite button. | |
BOOL | needPrefillWebinarJoinInfo |
Input meeting information in advance when user joins webinar. | |
BOOL | hideRegisterWebinarInfoWindow |
Hide register webinar window when join webinar. | |
BOOL | hideWebinarNameInputWindow |
Hide input name window when join webinar. | |
BOOL | disableParticipantButtonClickOriginAction |
Disable ZOOM original actions of clicking button participants. | |
BOOL | hideTelephoneInAudioWindow |
Hide the window of phone dialing in. | |
BOOL | hideCallMeInAudioWindow |
Hide the window of CALL ME. | |
BOOL | forceDisableMultiShare |
Forbid multi-participants sharing at the same time. | |
BOOL | disableCustomLiveStreamAction |
Disable custom live stream. | |
BOOL | disableFreeUserOriginAction |
Set whether to disable ZOOM original reminder action for free user. | |
BOOL | disableFreeMeetingRemainTimeNotify |
Disable the ZOOM original notification of remaining time for meeting organized by free user. | |
BOOL | hideInviteInMeetingH323CallInTab |
Hide the h323 call in tab on invite window. | |
BOOL | hideInviteInMeetingH323CallOutTab |
Hide the h323 call out tab on invite window. | |
BOOL | hideMeetingStaticBadNetWorkWaring |
Hide meeting static warning of bad network. | |
BOOL | hideMeetingStaticSystemBusyWaring |
Hide meeting static warning of system busy. | |
BOOL | hideSwitchCameraButton |
Hide switch camera button when sharing camera. | |
BOOL | disableOpenRecordFileWhenMeetingEnd |
Disable opening recording file when meeting end. | |
BOOL | hideShowKeypadButton |
Hide 'show keypad' button on meeting window. | |
BOOL | hideCopyURLButtonWhenInviteOthers |
Hide copy URL button when invite others join meeting. | |
BOOL | hideCopyInvitationButtonWhenInviteOthers |
Hide copy Invitation button when invite others join meeting. | |
BOOL | hideChatItemInMeeting |
Hide chat menu item in-meeting. | |
BOOL | hideRemoteControlItemOnMoreMenu |
Hide remote control item on more menu. | |
BOOL | hideChooseSaveRecordingFilePathWindow |
Hide choose save recording file path window. | |
BOOL | disableAudioButtonClickOriginAction |
Disable ZOOM original actions of clicking Audio button. | |
BOOL | disableAudioSettingMenuButtonClickOriginAction |
Disable audio menu item original action in-meeting. | |
BOOL | hideLoadingWindow |
Hide loading window when start meeting without login. | |
BOOL | disableBreakoutRoomsButtonClickOriginAction |
Disable ZOOM original actions of clicking button Breakout Rooms. | |
BOOL | hideMeetingInfoButtonOnVideo |
Hide meeting info button on video UI. | |
BOOL | hideInviteButtonOnHCWindow |
Hide invited button on participants window. | |
BOOL | disableToolbarLeaveButtonClickOriginAction |
Disable ZOOM original actions of clicking toolbar Leave button. | |
BOOL | disableToolbarCloseCaptionButtonClickOriginAction |
Disable ZOOM original actions of clicking toolbar CloseCaption button. | |
BOOL | hideInviteLinkOnMeetingUI |
hide invited link on meeting info window. | |
BOOL | hideCloudWhiteboardFeedbackButton |
Set the feedback button’s visibility on cloud Whiteboard. Default is displaying. | |
BOOL | hideCloudWhiteboardShareButton |
Set the share button’s visibility on cloud Whiteboard. Default is displaying. | |
BOOL | hideCloudWhiteboardAboutButton |
Set the about button’s visibility on the cloud whiteboard. Default is displaying. | |
BOOL | hideCloudWhiteboardHelperCenterButton |
Set the Helper center button's visibility on cloud whiteboard. Default is displaying. | |
BOOL | hideCloudWhiteboardOpenInBrowserButton |
Set the Open in browser button's visibility on cloud whiteboard. Default is displaying. | |
BOOL | hideConfirmStartArchiveWindow |
Set the confirm start archive dialog to hide or display. Default is displaying. | |
BOOL | hideRecoverMeetingWindow |
Enable or disable hiding the recover meeting window in Zoom UI mode. | |
Meeting configuration class to control various meeting UI and behavior settings.
Definition at line 13 of file ZoomSDKMeetingConfiguration.h.
- (ZoomSDKError) enableCloudWhiteboard: | (BOOL) | enable |
Enable or disable the new Zoom Whiteboard feature (different from Classic Whiteboard). This is enabled by default.
enable | YES means enable the cloud whiteboard feature,otherwise not. |
- (ZoomSDKError) enableGrabShareWithoutReminder: | (BOOL) | enable |
Set whether to close the current sharing of another user without prompt and directly beginning a new sharing content by the closer.
enable | YES indicates no prompt, otherwise not. |
- (ZoomSDKError) hideSDKButtons: | (BOOL) | hide | |
ButtonType: | (SDKButton) | button |
Hide or show specified SDK buttons.
hide | YES to hide the button, NO to show. |
button | The SDK button type to be hidden or shown. |
- (BOOL) isHideMeetingInputUserInfoWindow |
Get the meeting input user info dialog to hide or display.
- (ZoomSDKError) modifyVideoDSCP: | (int) | videoDSCP | |
AudioDSCP: | (int) | audioDSCP |
Modify the DSCP of audio and video.
videoDSCP | Video values in the meeting. |
audioDSCP | Audio values in the meeting. |
ZoomSDKError_Success
, otherwise failed. - (ZoomSDKError) prefillWebinarUserName: | (NSString *) | userName | |
Email: | (NSString *) |
Prefill the user name and email info when joining webinar.
userName | The user name to prefill. |
The email address to prefill. |
- (void) reset |
Reset all properties in this class.
- (void) setHideMeetingInputUserInfoWindow: | (BOOL) | hide |
Set the meeting input user info dialog to hide or display.
hide | YES means hide the dialog. Otherwise, do not hide the dialog. |
|
protected |
Definition at line 27 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 59 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 60 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 62 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 44 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 32 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 28 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 46 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 45 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 31 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 52 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 40 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 26 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 34 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 35 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 66 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 36 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 65 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 15 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 25 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 24 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 30 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 22 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 21 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 17 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 43 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 42 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 56 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 58 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 70 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 68 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 71 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 72 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 69 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 73 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 55 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 54 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 29 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 64 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 47 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 48 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 67 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 61 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 63 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 49 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 50 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 74 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 38 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 57 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 53 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 51 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 41 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 33 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 39 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 23 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 20 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 19 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 16 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 37 of file ZoomSDKMeetingConfiguration.h.
|
protected |
Definition at line 18 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Enable auto-adjust the microphone volume.
Definition at line 125 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Enable auto-adjust the speaker volume when joining meeting.
Definition at line 120 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Disable ZOOM original actions of clicking Audio button.
Definition at line 254 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Disable audio menu item original action in-meeting.
Definition at line 258 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Disable ZOOM original actions of clicking button Breakout Rooms.
Definition at line 266 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Disable custom live stream.
Definition at line 194 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Disable the feature to enter full screen by double click.
Definition at line 146 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Disable the alert to end another ongoing meeting.
Definition at line 130 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Disable the ZOOM original notification of remaining time for meeting organized by free user.
Definition at line 202 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Set whether to disable ZOOM original reminder action for free user.
Definition at line 198 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Disable input password window.
Definition at line 142 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Disable opening recording file when meeting end.
Definition at line 226 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Disable ZOOM original actions of clicking button participants.
Definition at line 178 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide the prompt dialog of wrong password.
Definition at line 115 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Disable to rename in meeting.
Definition at line 154 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Disable ZOOM original actions of clicking share button.
Definition at line 158 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Disable ZOOM original actions of clicking toolbar CloseCaption button.
Definition at line 282 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Disable ZOOM original actions of clicking toolbar invite button.
Definition at line 162 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Disable ZOOM original actions of clicking toolbar Leave button.
Definition at line 278 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
The APP ID to be shared.
Definition at line 79 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Auto end another ongoing meeting.
Definition at line 138 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Play chime when user joins/leaves meeting.
Definition at line 111 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Attendees join the meeting with audio muted.
Definition at line 103 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
The location of float video.
Definition at line 87 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Forbid multi-participants sharing at the same time.
Definition at line 190 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide the window of CALL ME.
Definition at line 186 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide chat menu item in-meeting.
Definition at line 242 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide choose save recording file path window.
Definition at line 250 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Set the about button’s visibility on the cloud whiteboard. Default is displaying.
Definition at line 298 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Set the feedback button’s visibility on cloud Whiteboard. Default is displaying.
Definition at line 290 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Set the Helper center button's visibility on cloud whiteboard. Default is displaying.
Definition at line 302 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Set the Open in browser button's visibility on cloud whiteboard. Default is displaying.
Definition at line 306 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Set the share button’s visibility on cloud Whiteboard. Default is displaying.
Definition at line 294 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Set the confirm start archive dialog to hide or display. Default is displaying.
Definition at line 310 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide copy Invitation button when invite others join meeting.
Definition at line 238 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide copy URL button when invite others join meeting.
Definition at line 234 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide the alert to end another ongoing meeting.
Definition at line 134 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide invited button on participants window.
Definition at line 274 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide the h323 call in tab on invite window.
Definition at line 206 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide the h323 call out tab on invite window.
Definition at line 210 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
hide invited link on meeting info window.
Definition at line 286 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide loading window when start meeting without login.
Definition at line 262 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide meeting info button on video UI.
Definition at line 270 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide meeting static warning of bad network.
Definition at line 214 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide meeting static warning of system busy.
Definition at line 218 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Enable or disable hiding the recover meeting window in Zoom UI mode.
Definition at line 314 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide register webinar window when join webinar.
Definition at line 170 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide remote control item on more menu.
Definition at line 246 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide 'show keypad' button on meeting window.
Definition at line 230 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide switch camera button when sharing camera.
Definition at line 222 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide the window of phone dialing in.
Definition at line 182 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide the window of thumbnail video.
Definition at line 150 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Hide input name window when join webinar.
Definition at line 174 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Query whether to share screen or not.
Definition at line 107 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
The visibility of the window of waiting for the host.
Definition at line 99 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
The location of main interface of meeting.
Definition at line 91 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
The monitor ID to be shared.
Definition at line 83 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
Input meeting information in advance when user joins webinar.
Definition at line 166 of file ZoomSDKMeetingConfiguration.h.
|
readwritenonatomicassign |
The visibility of toolbar when sharing.
Definition at line 95 of file ZoomSDKMeetingConfiguration.h.