Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKWallpaperController Class Reference

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods

(BOOL) - isPersonalWallpaperEnabled
 Determine if the personal wall-paper feature enabled by OP.
 
(ZoomSDKWallpaperItem *) - getCurrentPersonalWallpaperItem
 Get the current user's persional wall-paper config.
 
(NSArray< ZoomSDKWallpaperItem * > *_Nullable) - getPersonalWallpaperList
 Get the current user's persional wall-paper config list.
 
(ZoomSDKError- setPersonalWallpaper:
 Set the current user's persional wall-paper config.
 
(ZoomSDKWallpaperItem *_Nullable) - getPersonalWallpaperItemById:
 Get the persional wall-paper config by wall-paper ID.
 
(BOOL) - isMeetingWallpaperEnabled
 Determine if the meeting wall-paper feature enabled by OP.
 
(BOOL) - isMeetingWallpaperThumbsReady
 Determine if meeting wall-paper thumbnail ready.
 
(ZoomSDKWallpaperItem *_Nullable) - getCurrentMeetingWallpaperItem
 Get the meeting wall-paper config.
 
(NSArray< ZoomSDKWallpaperItem * > *_Nullable) - getMeetingWallpaperList
 Get the meeting wall-paper config list.
 
(ZoomSDKError- setMeetingWallpaper:
 Set the meeting wall-paper config.
 
(ZoomSDKWallpaperItem *) - getMeetingWallpaperById:
 Get the meeting wall-paper config by wall-paper ID.
 

Properties

id< ZoomSDKWallpaperControllerDelegatedelegate
 

Detailed Description

Definition at line 1092 of file ZoomSDKSettingService.h.

Method Documentation

◆ getCurrentMeetingWallpaperItem

- (ZoomSDKWallpaperItem *_Nullable) getCurrentMeetingWallpaperItem

Get the meeting wall-paper config.

Returns
The current used meeting wall-paper.
Warning
if select None, the wall-paper ID is empty.

◆ getCurrentPersonalWallpaperItem

- (ZoomSDKWallpaperItem *) getCurrentPersonalWallpaperItem

Get the current user's persional wall-paper config.

Returns
The current user's personal wall-paper.
Note
Only login user have this config, if select None, the wall-paper ID is empty.

◆ getMeetingWallpaperById:

- (ZoomSDKWallpaperItem *) getMeetingWallpaperById: (NSString *) wallpaperId

Get the meeting wall-paper config by wall-paper ID.

Returns
The meeting wall-paper with the wall-paper ID.

◆ getMeetingWallpaperList

- (NSArray< ZoomSDKWallpaperItem * > *_Nullable) getMeetingWallpaperList

Get the meeting wall-paper config list.

Returns
The meeting wall-paper list.

◆ getPersonalWallpaperItemById:

- (ZoomSDKWallpaperItem *_Nullable) getPersonalWallpaperItemById: (NSString *) wallpaperId

Get the persional wall-paper config by wall-paper ID.

Returns
The personal wall-paper with the wall-paper ID.
Warning
Only login user have this feature.

◆ getPersonalWallpaperList

- (NSArray< ZoomSDKWallpaperItem * > *_Nullable) getPersonalWallpaperList

Get the current user's persional wall-paper config list.

Returns
The current user's personal wall-paper list.
Note
Only login user have this config list.

◆ isMeetingWallpaperEnabled

- (BOOL) isMeetingWallpaperEnabled

Determine if the meeting wall-paper feature enabled by OP.

Returns
YES indicates the feature enabled. Otherwise NO.

◆ isMeetingWallpaperThumbsReady

- (BOOL) isMeetingWallpaperThumbsReady

Determine if meeting wall-paper thumbnail ready.

Returns
YES indicates ready. Otherwise NO.

◆ isPersonalWallpaperEnabled

- (BOOL) isPersonalWallpaperEnabled

Determine if the personal wall-paper feature enabled by OP.

Returns
YES indicates the feature enabled. Otherwise NO.

◆ setMeetingWallpaper:

- (ZoomSDKError) setMeetingWallpaper: (ZoomSDKWallpaperItem *) item

Set the meeting wall-paper config.

Parameters
itemWall-paper item need to set.
Returns
SDK error of the set opration.

◆ setPersonalWallpaper:

- (ZoomSDKError) setPersonalWallpaper: (ZoomSDKWallpaperItem *) item

Set the current user's persional wall-paper config.

Parameters
itemwall-paper item need to set.
Returns
If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.
Note
Only login user have this config list.

Property Documentation

◆ delegate

- (id<ZoomSDKWallpaperControllerDelegate>) delegate
readwritenonatomicassign

Definition at line 1093 of file ZoomSDKSettingService.h.