Meeting SDK for Android API Reference
Loading...
Searching...
No Matches
MeetingSettingsHelper.java
Go to the documentation of this file.
1package us.zoom.sdk;
2
3
4import android.app.Activity;
5import android.media.AudioDeviceInfo;
6
7import androidx.annotation.DrawableRes;
8import androidx.core.app.NotificationCompat;
9
14public interface MeetingSettingsHelper {
15
16 public static final String ANTIBANDING_50HZ = "50hz";
17 public static final String ANTIBANDING_60HZ = "60hz";
18 public static final String ANTIBANDING_AUTO = "auto";
19 public static final String ANTIBANDING_OFF = "off";
20
26 public void setAutoConnectVoIPWhenJoinMeeting(boolean enabled);
27
34
40 public void setMuteMyMicrophoneWhenJoinMeeting(boolean enabled);
41
48
54 public void setTurnOffMyVideoWhenJoinMeeting(boolean enabled);
55
62
68 public void setKubiDeviceEnabled(boolean enabled);
69
75 public boolean isKubiDeviceEnabled();
76
82 public boolean isHideNoVideoUsersEnabled();
83
89 public void setHideNoVideoUsersEnabled(boolean enabled);
90
97
104
111
118
124 public void setGalleryVideoViewDisabled(boolean disabled);
125
132
139
145 public void setAlwaysShowMeetingToolbarEnabled(boolean enabled);
146
153
159 public void setNoVideoTileOnShareScreenEnabled(boolean enabled);
160
167
173 public void setNoLeaveMeetingButtonForHostEnabled(boolean enabled);
174
181
187 public void setNoUserJoinOrLeaveTipEnabled(boolean enabled);
188
195
202 public void setCustomizedMeetingUIEnabled(boolean enabled);
203
209 public void setConfNotificationChannelId(String channelId);
210
216 public void setClaimHostWithHostKeyActionEnabled(boolean enabled);
217
223 public void setNoInviteH323RoomCallOutEnabled(boolean enabled);
224
230 public void setNoInviteH323RoomCallInEnabled(boolean enabled);
231
237 public void setClosedCaptionHidden(boolean bHide);
238
244 public boolean isHideClosedCaption();
245
251 public void enableForceAutoStartMyVideoWhenJoinMeeting(boolean bEnable);
252
258 public void enableForceAutoStopMyVideoWhenJoinMeeting(boolean bEnable);
259
266
273 public void disableShowMeetingNotification(boolean bDisable);
274
281 public void enable720p(boolean enable);
282
288 public boolean is720PEnabled();
289
290
296 public void disableChatUI(boolean disable);
297
303 public void hideAnnotationInScreenShareToolbar(boolean hideAnnotation);
304
311
318 public void hideStopShareInScreenShareToolbar(boolean hideStopShare);
319
326
336 public void setConfNotificationPriority(int priority);
337
342 public void hiddenQA(boolean hiddenQA) ;
343
348 public void hiddenPoll(boolean hiddenPoll);
349
354 public void enableShowMyMeetingElapseTime(boolean show);
355
361
369
375 public void disableShowVideoPreviewWhenJoinMeeting(boolean disableVideoPreview);
376
382
387 public void disableLeaveMeetingWhenTaskRemoved(boolean disable);
388
393 public void enableMicOriginalInput(boolean enable);
394
401 int enableEchoCancellation(boolean enable);
402
409
416
421 public boolean isMicOriginalInputEnable();
422
428 public boolean disableConfidentialWatermark(boolean disable);
429
434 public void disableCopyMeetingUrl(boolean disable);
435
442
449
456
463
464
471
477 void enableMirrorEffect(boolean enable);
478
483 void disableClearWebKitCache(boolean disabled);
484
490
496 void enableCloudWhiteboard(boolean enable);
497
504
510
516
523
535 @Deprecated
536 void enableAutoAdjustMicVolume(boolean enable);
537
542 @Deprecated
544
550 void enableUseConnectionService(boolean enable);
551
557 void setConfNotificationCategory(String category);
558
565
570 void setActivityForShowDisclaimer(Activity activity);
571
576 void enableGrabShareWithoutReminder(boolean enable);
577
578
585
592
599
600
608 void enable5GHighBandWidth(boolean enable);
609
619
628 void forceDisableCamera(boolean disable);
629
635
649 void enableWhiteboardVideoView(boolean enable);
650
656
668 void setPresetVBImage(@DrawableRes int resId, String vbKey, boolean delete);
669
676 boolean setPreferredAudioOutputDevice(AudioDeviceInfo deviceInfo);
677
684 boolean setPreferredAudioInputDevice(AudioDeviceInfo deviceInfo);
685
696 void enableZoomDocsInCustomUI(boolean enable);
697
703
708}
Enumerations of the dimension type for meeting UI.
Enumeration of common errors of SDK.
Enumeration of available emoji reaction skin tones.
Enumerations of the dimension value.
void hideStopShareInScreenShareToolbar(boolean hideStopShare)
Hide stopshare button in screen share toolbar. for sdk screen share.
boolean isMirrorEffectEnabled()
Get the flag to enable/disable the video mirror effect.
boolean isCameraForceDisabled()
Query whether cameras in a meeting are forcibly disabled.
boolean isShowMyMeetingElapseTimeEnabled()
Query is enable show meeting elapse time.
void enableGrabShareWithoutReminder(boolean enable)
Set whether to close the current sharing of another user without prompt and directly beginning a new ...
void enableGreenBorderForShareScreen(boolean enable)
enable or disable showing the green border when screen sharing.
ReactionSkinToneType getReactionSkinTone()
Get the emoji reaction skin tone type.
void setMuteMyMicrophoneWhenJoinMeeting(boolean enabled)
Set whether to mute microphone when the current user joins the meeting.
boolean setPreferredAudioInputDevice(AudioDeviceInfo deviceInfo)
Set Prefer audio input device android.media.AudioManager#getDevices(int).
boolean isSwitchVideoLayoutAccordingToUserCountEnabled()
Query if it is able to switch video layout mode automatically between SPEAKER VIEW and GALLERY VIEW b...
boolean disableConfidentialWatermark(boolean disable)
Disable use confidential watermark.
void enableShowMyMeetingElapseTime(boolean show)
Enable show meeting elapse time.
boolean isMuteMyMicrophoneWhenJoinMeetingEnabled()
Query if the microphone is muted always when the current user joins the meeting.
void setSwitchVideoLayoutAccordingToUserCountEnabled(boolean enabled)
Set whether to enable the feature to switch video layout mode automatically between SPEAKER VIEW and ...
void enableMirrorEffect(boolean enable)
Enable or disable video mirror effect.
int enableEchoCancellation(boolean enable)
Enable echo cancellation.
void disableShowVideoPreviewWhenJoinMeeting(boolean disableVideoPreview)
Disable/Enable the video preview dialog when joining a video meeting Note: this api must be called be...
void hiddenQA(boolean hiddenQA)
Hidden question and answer feature for zoom ui.
boolean isAlwaysShowMeetingToolbarEnabled()
Query if the option ALWAYS SHOW MEETING CONTROLS is enabled.
void setReactionSkinTone(ReactionSkinToneType skinTone)
Set the emoji reaction skin tone type.
void setNoInviteH323RoomCallOutEnabled(boolean enabled)
Set whether to disable invitation from H.323 Room System.
void setAutoConnectVoIPWhenJoinMeeting(boolean enabled)
Set whether to connect VoIP automatically when the current user joins the meeting.
void disableLeaveMeetingWhenTaskRemoved(boolean disable)
Disable/Enable leave meeting when service onTaskRemoved called.
void setClaimHostWithHostKeyActionEnabled(boolean enabled)
Set if CLAIM HOST with host key in the meeting is enabled.
void enableAutoAdjustMicVolume(boolean enable)
Enable auto-adjust microphone.
MobileRTCSDKError setDimensionConfig(DimensionType type, DimensionValue value)
Set the dimension config.
boolean isNoVideoTileOnShareScreenEnabled()
Query if NO VIDEO TILE ON SHARE SCREEN is enabled.
void enableMicOriginalInput(boolean enable)
Disable/Enable mic original input.
void setConfNotificationCategory(String category)
Set the category of notification for ongoing meeting.
void setAudioFocusType(AudioFocusGainType type)
set customize audio focus gain type
void enableCloudWhiteboard(boolean enable)
Enable or disable the new Zoom Whiteboard feature (different from Classic Whiteboard)....
int getSwitchVideoLayoutUserCountThreshold()
Get the threshold for the number of users which is used to switch the video layout automatically.
void enableForceAutoStartMyVideoWhenJoinMeeting(boolean bEnable)
Set if it is able to force participants to start video when joining the meeting.
boolean isAutoConnectVoIPWhenJoinMeetingEnabled()
Query if the VoIP auto-connection is enabled when the current user joins the meeting.
boolean isDisableShowVideoPreviewWhenJoinMeeting()
To query whether the query dialog will be displayed when joining a video meeting.
boolean isKubiDeviceEnabled()
Query if Kubi device is enabled. If enable Kubi, android.permission.ACCESS_FINE_LOCATION should be de...
void setNoVideoTileOnShareScreenEnabled(boolean enabled)
Set whether to enable the options NO MEETING TILE ON SHARED SCREEN.
boolean isWhiteboardVideoViewEnabled()
Query whether the capability to show whiteboard in MobileRTCVideoView is enabled.
void setKubiDeviceEnabled(boolean enabled)
Set whether to enable Kubi device setting. If enable Kubi, android.permission.ACCESS_FINE_LOCATION sh...
boolean is720PEnabled()
Query if 720p enabled, it is only supported in device with at least 4 gold cores.
void setDisclaimerBannerUIConfig(DisclaimerBannerConfig config)
Set the disclaimer banner config.
boolean isHideClosedCaption()
Query if HIDE CLOSED CAPTION on the main video is enabled.
void setActivityForShowDisclaimer(Activity activity)
Set the activity to show the disclaimer dialog.
void setCustomizedMeetingUIEnabled(boolean enabled)
Set whether to enable the option USE CUSTOM MEETING UI. Note: The feature must be enabled in user SDK...
void setNoInviteH323RoomCallInEnabled(boolean enabled)
Set whether to disable invitation from H.323 Room System.
void disableCopyMeetingUrl(boolean disable)
Disable use copy url for long press zoom ui meeting title bar.
void setAlwaysShowMeetingToolbarEnabled(boolean enabled)
Set whether to enable the option ALWAYS SHOW MEETING CONTROLS.
void setHideShareButtonInMeetingToolbar(boolean bHide)
Set hide share button in meeting toolbar.
void disableChatUI(boolean disable)
Disable chat ui for zoom ui.
void hideAnnotationInScreenShareToolbar(boolean hideAnnotation)
Hide annotation button in screen share toolbar,for sdk screen share.
void setNoUserJoinOrLeaveTipEnabled(boolean enabled)
Set whether to enable the tips, NO USER JOINS OR LEAVES.
void hiddenPoll(boolean hiddenPoll)
Hidden poll feature for zoom ui.
void setConfNotificationPriority(int priority)
set the priority of the ongoing meeting notification
boolean isNoUserJoinOrLeaveTipEnabled()
Query if the tips, NO USER JOINS or LEAVES, is enabled.
void hideCloudWhiteboardHelperCenterButton(boolean bHide)
Set the Helper center button's visibility on cloud whiteboard. Default is displaying.
void setPresetVBImage(@DrawableRes int resId, String vbKey, boolean delete)
set the preset virtual background image. Note: this can only take effect when isCustomizedMeetingUIEn...
VideoAspectRatioType getVideoAspectRatio()
Get type of video aspect ratio.
void setNoLeaveMeetingButtonForHostEnabled(boolean enabled)
Set whether to hide leaving button on the dialog when the host leaves meeting.
boolean isSupportEchoCancellation()
Determine if the meeting supports echo cancellation.
boolean isGalleryVideoViewDisabled()
Query if DISABLE video GALLERY VIEW is enabled.
void setAnnotationSnapshotPathInAlbum(String path)
Set the path for saving annotation screenshots to the album.
void disableAutoShowSelectJoinAudioDlgWhenJoinMeeting(boolean bDisable)
Set the visibility of the dialog SELECT JOIN AUDIO when joining meeting.
void setHideNoVideoUsersEnabled(boolean enabled)
Set whether to enable the option HIDE NON-VIDEO PARTICIPANTS.
void enable720p(boolean enable)
Set to enable 720p, it is only supported in device with at least 4 gold cores Suggest : CPU Qualcomm ...
void enableUseConnectionService(boolean enable)
Determine if use connection service.
boolean isTurnOffMyVideoWhenJoinMeetingEnabled()
Query if the video is turned off when the current user joins the meeting.
void enableWhiteboardVideoView(boolean enable)
Enable the capability to show whiteboard in MobileRTCVideoView. When enable this capability,...
void enable5GHighBandWidth(boolean enable)
Whether to cancel the bandwidth limit, If YES is set, the network bandwidth is no longer limited,...
void hideCloudWhiteboardOpenInBrowserButton(boolean bHide)
Set the Open in browser button's visibility on cloud whiteboard. Default is displaying.
boolean isMicOriginalInputEnable()
Query is mic original input enable.
boolean setPreferredAudioOutputDevice(AudioDeviceInfo deviceInfo)
Set Prefer audio output device android.media.AudioManager#getDevices(int).
void setCustomizedNotificationData(CustomizedNotificationData data, InMeetingNotificationHandle handle)
Customize meeting notification style.
void enableForceAutoStopMyVideoWhenJoinMeeting(boolean bEnable)
Set if it is able to force participants to turn off video when joining the meeting.
void setVideoAspectRatio(VideoAspectRatioType aspectRatioType)
Set type of video aspect ratio.
boolean isEchoCancellationOn()
Determine if echo cancellation is enabled or not.
boolean isDisabledClearWebKitCache()
Query if the action of clear WebView's cache be disabled.
boolean isHideStopShareInScreenShareToolbar()
Query if stopshare button is hide in screen share toolbar.
void forceDisableCamera(boolean disable)
Force disable camera in meeting. When disabled, SDK will not call the camera related API....
boolean isGreenBorderEnableForShareScreen()
Query if enabling or disabling showing the green border when screen sharing.
boolean isCustomizedMeetingUIEnabled()
Query if USE CUSTOM MEETING UI is enabled.
void disableClearWebKitCache(boolean disabled)
Disable the action of clear WebView's cache.
void setSwitchVideoLayoutUserCountThreshold(int value)
Set the threshold for the number of users which is used to switch the video layout automatically.
boolean isHideAnnotationInScreenShareToolbar()
Query if annotation button is hide in screen share toolbar.
void setConfNotificationChannelId(String channelId)
Set the channel ID of notification for ongoing meeting.
void setClosedCaptionHidden(boolean bHide)
Set whether to hide the closed caption on the main video. Default value: hide.
boolean isNoLeaveMeetingButtonForHostEnabled()
Query if hide leaving button on the dialog when the host leaves meeting is enabled.
boolean isHideNoVideoUsersEnabled()
Query if the option HIDE NON-VIDEO PARTICIPANTS is enabled.
void setTurnOffMyVideoWhenJoinMeeting(boolean enabled)
Set whether to turn off the video when the current user joins the meeting.
boolean isZoomDocsEnabledInCustomUI()
Query whether zoom docs feature is enabled in custom ui.
void setHideEmojiDownloadNotification()
Set to hide notifications when downloading emoji.
boolean isAutoAdjustMicVolumeOn()
Determine if auto-adjust microphone is enabled or not.
void setGalleryVideoViewDisabled(boolean disabled)
Set whether to enable video GALLERY VIEW.
void disableShowMeetingNotification(boolean bDisable)
Set if it is disabled to SHOW MEETING NOTIFICATION. disableShowMeetingNotification(true) work only sd...
void enableZoomDocsInCustomUI(boolean enable)
Enable or disable zoom docs features in custom ui. Note: this can only take effect when isCustomizedM...