Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKSettingGeneralController.h
Go to the documentation of this file.
1//
2// ZoomSDKSettingGeneralController.h
3// ZoomSDK
4//
5
6#import <Foundation/Foundation.h>
7#import <ZoomSDK/ZoomSDKErrors.h>
8NS_ASSUME_NONNULL_BEGIN
9
14@interface ZoomSDKWallpaperItem : NSObject
18@property (copy, nonatomic, readonly, nullable) NSString *wallpaperId;
22@property (copy, nonatomic, readonly, nullable) NSString *title;
26@property (copy, nonatomic, readonly, nullable) NSString *thumbnailPath;
30@property (copy, nonatomic, readonly, nullable) NSString *path;
34@property (assign, nonatomic, readwrite) int transparency;
38@property (assign, nonatomic, readwrite) ZoomSDKWallpaperLayoutMode layoutMode;
39@end
40
45@protocol ZoomSDKWallpaperControllerDelegate <NSObject>
50- (void)onPersonalWallpaperChanged:(ZoomSDKWallpaperItem * _Nullable)item;
56- (void)onPersonalWallpaperImageDownloadStatus:(ZoomSDKWallpaperSettingStatus)status wallpaper:(NSString *)wallpaperId;
61- (void)onMeetingWallpaperChanged:(ZoomSDKWallpaperItem * _Nullable)item;
67- (void)onMeetingWallpaperImageDownloadStatus:(ZoomSDKWallpaperSettingStatus)status wallpaper:(NSString *)wallpaperId;
68@end
69
70
75@interface ZoomSDKWallpaperController : NSObject
79@property(nonatomic, assign, nullable)id<ZoomSDKWallpaperControllerDelegate> delegate;
80
104- (ZoomSDKError)setPersonalWallpaper:(ZoomSDKWallpaperItem *)item;
110- (ZoomSDKWallpaperItem * _Nullable)getPersonalWallpaperItemById:(NSString *)wallpaperId;
137- (ZoomSDKError)setMeetingWallpaper:(ZoomSDKWallpaperItem *)item;
142- (ZoomSDKWallpaperItem *)getMeetingWallpaperById:(NSString *)wallpaperId;
143@end
144
149@interface ZoomSDKGeneralSetting: NSObject
156- (ZoomSDKError)enableMeetingSetting:(BOOL)enable SettingCmd:(MeetingSettingCmd)cmd;
162- (ZoomSDKError)setCustomInviteURL:(NSString*)inviteURL;
163
170- (ZoomSDKError)setCustomFeedbackURL:(NSString*)feedbackURL DEPRECATED_MSG_ATTRIBUTE("No longer used");
171
177- (void)hideSettingComponent:(SettingComponent)component hide:(BOOL)hide;
178
184- (ZoomSDKError)setCustomURL:(SDKURLType)urlType urlString:(NSString*)urlString;
185
191
197- (ZoomSDKError)enableToShowMeetingTime:(BOOL)enable;
198
204
210- (ZoomSDKError)setCopyMeetingInviteURL:(BOOL)enable;
216
222- (ZoomSDKError)setConfirmLeavingMeeting:(BOOL)enable;
223
229- (ZoomSDKError)setUIAppearance:(ZoomSDKUIAppearance)appearance;
230
236
242
248- (ZoomSDKError)setUITheme:(ZoomSDKUITheme)theme;
249
255
261- (ZoomSDKError)setMuteVideoAndAudioWhenLockScreen:(BOOL)enable;
262
268
274- (ZoomSDKError)setReactionSkinTone:(ZoomSDKEmojiReactionSkinTone)skinTone;
275
281
287- (ZoomSDKError)hideAutoCopyInviteLinkCheckBox:(BOOL)hide;
294- (ZoomSDKError)enableMuteOnEntry:(BOOL)bEnable allowUnmuteBySelf:(BOOL)allow;
300@end
301
302
303NS_ASSUME_NONNULL_END
ZoomSDKUIAppearance
Enumeration of UI appearance modes.
ZoomSDKEmojiReactionSkinTone
Enumeration of available emoji reaction skin tones.
ZoomSDKWallpaperSettingStatus
Enumeration of the wallpaper setting status.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKUITheme
Enumeration of available UI themes.
ZoomSDKWallpaperLayoutMode
Enumeration of wallpaper layout modes.
MeetingSettingCmd
Enumeration of Meeting settings.
SDKURLType
Enumeration of the virtual background URL types.
SettingComponent
Enumerate of the various components in the settings UI.
General settings interface for controlling meeting behaviors and UI customizations.
BOOL isMutedVideoAndAudioWhenLockScreen()
Determines if mute video and aodio when lock screen.
ZoomSDKEmojiReactionSkinTone getReactionSkinTone()
Gets the reaction's skintone.
ZoomSDKUIAppearance getUIAppearance()
Gets the UI appearance type.
ZoomSDKWallpaperController * getWallpaperController()
Gets the object of set wallpaper controller.
BOOL isEnableCopyInviteURL()
Determines if can copy invite url after start meeting.
BOOL isShowLockMeetingTime()
Gets the current status of show meeting time.
BOOL isSupportSetUITheme()
Determines if support set ui theme.
BOOL isEnableConfirmLeavingMeeting()
Determines if can comfire when leaving meeting.
ZoomSDKUITheme getUITheme()
Query the theme of ui.
Controller for managing wallpapers.
NSArray< ZoomSDKWallpaperItem * > *_Nullable getPersonalWallpaperList()
Gets the current user's persional wall-paper config list.
BOOL isMeetingWallpaperEnabled()
Determines if the meeting wall-paper feature enabled by OP.
ZoomSDKWallpaperItem *_Nullable getCurrentMeetingWallpaperItem()
Gets the meeting wall-paper config.
BOOL isPersonalWallpaperEnabled()
Determines if the personal wall-paper feature enabled by OP.
id< ZoomSDKWallpaperControllerDelegate > delegate
Delegate object for handling wallpaper events.
BOOL isMeetingWallpaperThumbsReady()
Determines if meeting wall-paper thumbnail ready.
NSArray< ZoomSDKWallpaperItem * > *_Nullable getMeetingWallpaperList()
Gets the meeting wall-paper config list.
ZoomSDKWallpaperItem * getCurrentPersonalWallpaperItem()
Gets the current user's persional wall-paper config.
Represents a wallpaper item.
ZoomSDKWallpaperLayoutMode layoutMode
Layout mode of the wall-paper.
int transparency
0 ~ 255, -1 means no transparency. Only possible in Meeting wall-paper.
NSString * thumbnailPath
Thumbnail path.
NSString * path
Full image path.
NSString * wallpaperId
Wall-paper ID.