ZoomSDKWallpaperController Class Reference

Controller for managing wallpapers. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

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

Properties
id< ZoomSDKWallpaperControllerDelegate >	delegate
	Delegate object for handling wallpaper events.

Detailed Description

Controller for managing wallpapers.

Definition at line 1334 of file ZoomSDKSettingService.h.

Method Documentation

getCurrentMeetingWallpaperItem

- (ZoomSDKWallpaperItem *_Nullable) getCurrentMeetingWallpaperItem

Gets the meeting wall-paper config.

Returns

If the function succeeds, it returns the current used meeting wall-paper. Otherwise, this function fails and returns nil.

Warning

if select None, the wall-paper ID is empty.

getCurrentPersonalWallpaperItem

- (ZoomSDKWallpaperItem *) getCurrentPersonalWallpaperItem

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

Returns

If the function succeeds, it returns the current user's personal wall-paper. Otherwise, this function fails and returns nil.

Note

Only login user have this config, if select None, the wall-paper ID is empty.

getMeetingWallpaperById:

- (ZoomSDKWallpaperItem *) getMeetingWallpaperById:

(NSString *)

wallpaperId

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

Returns

If the function succeeds, it returns the meeting wall-paper with the wall-paper ID. Otherwise, this function fails and returns nil.

getMeetingWallpaperList

- (NSArray< ZoomSDKWallpaperItem * > *_Nullable) getMeetingWallpaperList

Gets the meeting wall-paper config list.

Returns

If the function succeeds, it returns the meeting wall-paper list. Otherwise, this function fails and returns nil.

getPersonalWallpaperItemById:

- (ZoomSDKWallpaperItem *_Nullable) getPersonalWallpaperItemById:

(NSString *)

wallpaperId

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

Returns

If the function succeeds, it returns the personal wall-paper with the wall-paper ID. Otherwise, this function fails and returns nil.

Warning

Only login user have this feature.

getPersonalWallpaperList

- (NSArray< ZoomSDKWallpaperItem * > *_Nullable) getPersonalWallpaperList

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

Returns

If the function succeeds, it returns the current user's personal wall-paper list. Otherwise, this function fails and returns nil.

Note

Only login user have this config list.

isMeetingWallpaperEnabled

- (BOOL) isMeetingWallpaperEnabled

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

Returns

YES if the feature enabled. Otherwise, NO.

isMeetingWallpaperThumbsReady

- (BOOL) isMeetingWallpaperThumbsReady

Determines if meeting wall-paper thumbnail ready.

Returns

YES if ready. Otherwise, NO.

isPersonalWallpaperEnabled

- (BOOL) isPersonalWallpaperEnabled

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

Returns

YES if the feature enabled. Otherwise, NO.

setMeetingWallpaper:

- (ZoomSDKError) setMeetingWallpaper:

(ZoomSDKWallpaperItem *)

item

Sets the meeting wall-paper config.

Parameters

item	Wall-paper item need to set.

Returns

SDK error of the set opration. Otherwise, this function returns an error.

setPersonalWallpaper:

- (ZoomSDKError) setPersonalWallpaper:

(ZoomSDKWallpaperItem *)

item

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

Parameters

item	Wall-paper item need to set.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

Note

Only login user have this config list.

Property Documentation

delegate

- (id<ZoomSDKWallpaperControllerDelegate>) delegate

readwritenonatomicassign

Delegate object for handling wallpaper events.

Definition at line 1338 of file ZoomSDKSettingService.h.