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

Provides access to various Zoom SDK settings modules. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods

(ZoomSDKAudioSetting *_Nullable) - getAudioSetting
 Gets the object of audio settings.
(ZoomSDKVideoSetting *_Nullable) - getVideoSetting
 Gets the object of video settings.
(ZoomSDKRecordSetting *_Nullable) - getRecordSetting
 Gets the object of meeting recording settings.
(ZoomSDKGeneralSetting *_Nullable) - getGeneralSetting
 Gets the object of general settings of SDK.
(ZoomSDKStatisticsSetting *_Nullable) - getStatisticsSetting
 Gets the object of statistic settings.
(ZoomSDKVirtualBackgroundSetting *_Nullable) - getVirtualBGSetting
 Gets the object of virtual background settings.
(ZoomSDKShareScreenSetting *_Nullable) - getShareScreenSetting
 Gets the object of share screen settings.
(ZoomSDK3DAvatarSetting *_Nullable) - get3DAvatarSettings
 Gets the object of 3D avatar.
(ZoomSDKFaceMakeupSettingContext *_Nullable) - getFaceMakeupSettings
 Gets the object of face makeup.
(void) - configToShowUrlLinksInSetting:isHide:
 Custom the url link show or hide on setting page.

Protected Attributes

ZoomSDKAudioSetting_audioSetting
ZoomSDKVideoSetting_videoSetting
ZoomSDKRecordSetting_recordSetting
ZoomSDKGeneralSetting_generalSetting
ZoomSDKStatisticsSetting_statisticsSetting
ZoomSDKVirtualBackgroundSetting_virtualBGSetting
ZoomSDKShareScreenSetting_shareScreenSetting
ZoomSDK3DAvatarSetting_avatarSetting
ZoomSDKFaceMakeupSettingContext_faceMakeupSettingContext

Detailed Description

Provides access to various Zoom SDK settings modules.

Definition at line 2208 of file ZoomSDKSettingService.h.

Method Documentation

◆ configToShowUrlLinksInSetting:isHide:

- (void) configToShowUrlLinksInSetting: (ZoomSDKSettingPageURL) settingPageUrl
isHide: (BOOL) hide 

Custom the url link show or hide on setting page.

Parameters
settingPageUrlIt is a enumeration of setting page url.
hideYES to hide, NO to show.

◆ get3DAvatarSettings

- (ZoomSDK3DAvatarSetting *_Nullable) get3DAvatarSettings

Gets the object of 3D avatar.

Returns
If the function succeeds, it returns an object of ZoomSDK3DAvatarSetting. Otherwise, this function fails and returns nil.

References get3DAvatarSettings.

Referenced by get3DAvatarSettings.

◆ getAudioSetting

- (ZoomSDKAudioSetting *_Nullable) getAudioSetting

Gets the object of audio settings.

Returns
If the function succeeds, it returns an object of ZoomSDKAudioSetting. Otherwise, this function fails and returns nil.

References getAudioSetting.

Referenced by getAudioSetting.

◆ getFaceMakeupSettings

- (ZoomSDKFaceMakeupSettingContext *_Nullable) getFaceMakeupSettings

Gets the object of face makeup.

Returns
If the function succeeds, it returns an object of ZoomSDKFaceMakeupSettingContext. Otherwise, this function fails and returns nil.

References getFaceMakeupSettings.

Referenced by getFaceMakeupSettings.

◆ getGeneralSetting

- (ZoomSDKGeneralSetting *_Nullable) getGeneralSetting

Gets the object of general settings of SDK.

Returns
If the function succeeds, it returns an object of ZoomSDKGeneralSetting. Otherwise, this function fails and returns nil.

References getGeneralSetting.

Referenced by getGeneralSetting.

◆ getRecordSetting

- (ZoomSDKRecordSetting *_Nullable) getRecordSetting

Gets the object of meeting recording settings.

Returns
If the function succeeds, it returns an object of ZoomSDKRecordSetting. Otherwise, this function fails and returns nil.

References getRecordSetting.

Referenced by getRecordSetting.

◆ getShareScreenSetting

- (ZoomSDKShareScreenSetting *_Nullable) getShareScreenSetting

Gets the object of share screen settings.

Returns
If the function succeeds, it returns an object of ZoomSDKShareScreenSetting. Otherwise, this function fails and returns nil.

References getShareScreenSetting.

Referenced by getShareScreenSetting.

◆ getStatisticsSetting

- (ZoomSDKStatisticsSetting *_Nullable) getStatisticsSetting

Gets the object of statistic settings.

Returns
If the function succeeds, it returns an object of ZoomSDKStatisticsSetting. Otherwise, this function fails and returns nil.

References getStatisticsSetting.

Referenced by getStatisticsSetting.

◆ getVideoSetting

- (ZoomSDKVideoSetting *_Nullable) getVideoSetting

Gets the object of video settings.

Returns
If the function succeeds, it returns an object of ZoomSDKVideoSetting. Otherwise, this function fails and returns nil.

References getVideoSetting.

Referenced by getVideoSetting.

◆ getVirtualBGSetting

- (ZoomSDKVirtualBackgroundSetting *_Nullable) getVirtualBGSetting

Gets the object of virtual background settings.

Returns
If the function succeeds, it returns an object of ZoomSDKVirtualBackgroundSetting. Otherwise, this function fails and returns nil.

References getVirtualBGSetting.

Referenced by getVirtualBGSetting.

Field Documentation

◆ _audioSetting

- (ZoomSDKAudioSetting*) _audioSetting
protected

Definition at line 2210 of file ZoomSDKSettingService.h.

◆ _avatarSetting

- (ZoomSDK3DAvatarSetting*) _avatarSetting
protected

Definition at line 2217 of file ZoomSDKSettingService.h.

◆ _faceMakeupSettingContext

- (ZoomSDKFaceMakeupSettingContext*) _faceMakeupSettingContext
protected

Definition at line 2218 of file ZoomSDKSettingService.h.

◆ _generalSetting

- (ZoomSDKGeneralSetting*) _generalSetting
protected

Definition at line 2213 of file ZoomSDKSettingService.h.

◆ _recordSetting

- (ZoomSDKRecordSetting*) _recordSetting
protected

Definition at line 2212 of file ZoomSDKSettingService.h.

◆ _shareScreenSetting

- (ZoomSDKShareScreenSetting*) _shareScreenSetting
protected

Definition at line 2216 of file ZoomSDKSettingService.h.

◆ _statisticsSetting

- (ZoomSDKStatisticsSetting*) _statisticsSetting
protected

Definition at line 2214 of file ZoomSDKSettingService.h.

◆ _videoSetting

- (ZoomSDKVideoSetting*) _videoSetting
protected

Definition at line 2211 of file ZoomSDKSettingService.h.

◆ _virtualBGSetting

- (ZoomSDKVirtualBackgroundSetting*) _virtualBGSetting
protected

Definition at line 2215 of file ZoomSDKSettingService.h.