Interface for video settings including camera selection, video effects, beauty mode, and auto-framing. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods
(ZoomSDKSettingTestVideoDeviceHelper *_Nullable)	- getSettingVideoTestHelper
	Gets the object to test video device.
(NSArray *_Nullable)	- getCameraList
	Gets the list of camera device.
(ZoomSDKError)	- selectCamera:
	Select a camera.
(BOOL)	- isMirrorEffectEnabled
	Determines if mirror effect is enabled.
(ZoomSDKError)	- enableMirrorEffect:
	Sets to enable or disable mirror effect.
(BOOL)	- isBeautyFaceEnabled
	Determines if facial beauty effect is enabled.
(ZoomSDKError)	- enableBeautyFace:
	Enable or disable facial beauty effect.
(int)	- getBeautyFaceValue
	Gets beauty face value.
(ZoomSDKError)	- setBeautyFaceValue:
	Sets beauty face value.
(ZoomSDKError)	- disableVideoJoinMeeting:
	Turn off the participant's video when he joins meeting.
(ZoomSDKError)	- displayUserNameOnVideo:
	Display or Hide username on the video window.
(ZoomSDKError)	- enableCatchHDVideo:
	Enables or disable HD video.
(ZoomSDKError)	- onVideoCaptureOriginalSizeOr16To9:
	Sets to capture video ratio: original or 16:9.
(ZoomSDKError)	- onSpotlightMyVideoWhenISpeaker:
	Enables to spotlight the current user's video in the main interface when he speaks in the meeting.
(ZoomSDKError)	- onDisplayUpTo49InWallView:
	Enables or disable to show the participants in Gallery View up to 49 per screen.
(ZoomSDKError)	- hideNoVideoUser:
	Enables or disable to hide the non-video participants.
(BOOL)	- isHideNoVideoUser
	Determines if non-video participant is hided or not.
(BOOL)	- isCaptureOriginalSize
	Query if original size of video is enabled.
(BOOL)	- isSpotlightMyVideoOn
	Determines if spotlighting the current user's video is enabled.
(BOOL)	- isMuteMyVideoWhenJoinMeetingOn
	Determines if the current user's video is muted when he joins meeting.
(BOOL)	- isdisplayUserNameOnVideoOn
	Determines if displaying screen name of the user is enabled.
(BOOL)	- isCanDisplayUpTo49InWallView
	Determines if it is able to display up to 49 participants in video wall mode.
(BOOL)	- isDisplayUpTo49InWallViewOn
	Determines whether to display up to 49 participants in video wall mode.
(BOOL)	- isCatchHDVideoOn
	Determines if HD video is enabled.
(ZoomSDKSettingVideoLightAdaptionModel)	- getLightAdjustModel
	Determines if adjustion for low light.
(ZoomSDKError)	- setLightAdaptionModel:LightAdaptionManualValue:
	Sets the way to adjust the low light.
(int)	- getLightAdaptionManualValue
	Gets the setted's value.
(BOOL)	- isHardwareAccelerationForVideoReceiveOn
	Determines whether to hardware acceleration for video receive.
(ZoomSDKError)	- enableHardwareAccelerationForVideoReceive:
	Enables or disable hardware acceleration for video receive.
(BOOL)	- isTemporalDeNoiseOn
	Determines whether to de-noise.
(ZoomSDKError)	- enableTemporalDeNoise:
	Enables or disable de-noise.
(BOOL)	- isOptimizeVideoQualitySupported
	Determines if optimizing received video quality is supported.
(BOOL)	- isOptimizeVideoQualityEnabled
	Determines if optimizing received video quality is enabled.
(ZoomSDKError)	- enableOptimizeVideoQuality:
	Enables or disable optimizing received video quality when facing network issues for a variety of reasons. Applies to the window in focus: speaker view, pinned / spotlighted videos, gallery view with a small number of videos.
(ZoomSDKError)	- enableStopIncomingVideo:
	Enables or disable to stop incoming video.
(BOOL)	- isStopIncomingVideoEnabled
	Gets the flag to enable or disable to stop in coming video.
(ZoomSDKError)	- enableHideSelfView:
	Enables or disable to hide the userself's view.
(BOOL)	- isHideSelfViewEnabled
	Gets the flag to enable or disable to hide userself's view.
(ZoomSDKError)	- enableVideoAutoFraming:setting:
	Starts my video auto-framing.
(ZoomSDKError)	- disableVideoAutoFraming
	Stops video auto-framing.
(BOOL)	- isVideoAutoFramingEnabled
	Determines whether auto-framing is enabled.
(ZoomSDKAutoFramingMode)	- getVideoAutoFramingMode
	Gets the auto-framing mode.
(ZoomSDKAutoFramingParameter *_Nullable)	- getVideoAutoFramingSettingWithMode:
	Gets the auto-framing parameter.
(ZoomSDKError)	- setVideoAutoFramingMode:
	Sets the mode of auto-framing when auto-framing is enabled.
(ZoomSDKError)	- setVideoAutoFramingRatio:
	Sets the zoom in ratio of auto-framing when auto-framing is enabled.
(ZoomSDKError)	- setFaceRecognitionFailStrategy:
	Sets the fail strategy of face recognition when auto-framing is enabled(mode is `ZoomSDKAutoFramingMode_Face_Recognition`).
(ZoomSDKError)	- setVideoQualityPreference:
	Sets the video quality preference that automatically adjust user's video to prioritize frame rate versus resolution based on the current bandwidth available.

Protected Attributes
ZoomSDKSettingTestVideoDeviceHelper *	settingVideoTestHelper

Detailed Description

Interface for video settings including camera selection, video effects, beauty mode, and auto-framing.

Definition at line 784 of file ZoomSDKSettingService.h.

Method Documentation

◆ disableVideoAutoFraming

- (ZoomSDKError) disableVideoAutoFraming

Stops video auto-framing.

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

References disableVideoAutoFraming.

Referenced by disableVideoAutoFraming.

◆ disableVideoJoinMeeting:

- (ZoomSDKError) disableVideoJoinMeeting: (BOOL) disable

Turn off the participant's video when he joins meeting.

Parameters

disable YES if the video is turned off, NO otherwise.

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

◆ displayUserNameOnVideo:

- (ZoomSDKError) displayUserNameOnVideo: (BOOL) display

Display or Hide username on the video window.

Parameters

display YES to showing always username on the video window, NO otherwise.

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

◆ enableBeautyFace:

- (ZoomSDKError) enableBeautyFace: (BOOL) enable

Enable or disable facial beauty effect.

Parameters

enable YES if enabled, NO if disabled.

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

◆ enableCatchHDVideo:

- (ZoomSDKError) enableCatchHDVideo: (BOOL) enable

Enables or disable HD video.

Parameters

enable YES if enabled, NO if disabled.

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

◆ enableHardwareAccelerationForVideoReceive:

- (ZoomSDKError) enableHardwareAccelerationForVideoReceive: (BOOL) enable

Enables or disable hardware acceleration for video receive.

Parameters

enable YES if enabled, NO if disabled.

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

◆ enableHideSelfView:

- (ZoomSDKError) enableHideSelfView: (BOOL) enable

Enables or disable to hide the userself's view.

Parameters

enable YES indicates to enable to hide the userself's view, NO to disable.

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

◆ enableMirrorEffect:

- (ZoomSDKError) enableMirrorEffect: (BOOL) enable

Sets to enable or disable mirror effect.

Parameters

enable YES if enabled, NO if disabled.

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

◆ enableOptimizeVideoQuality:

- (ZoomSDKError) enableOptimizeVideoQuality: (BOOL) enable

Enables or disable optimizing received video quality when facing network issues for a variety of reasons. Applies to the window in focus: speaker view, pinned / spotlighted videos, gallery view with a small number of videos.

Parameters

enable YES to enable this feature, NO to disable this feature.

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

◆ enableStopIncomingVideo:

- (ZoomSDKError) enableStopIncomingVideo: (BOOL) enable

Enables or disable to stop incoming video.

Parameters

enable YES indicates to enable to stop incoming video, NO to disable.

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

◆ enableTemporalDeNoise:

- (ZoomSDKError) enableTemporalDeNoise: (BOOL) enable

Enables or disable de-noise.

Parameters

enable YES if enabled, NO if disabled.

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

◆ enableVideoAutoFraming:setting:

- (ZoomSDKError) enableVideoAutoFraming:		(ZoomSDKAutoFramingMode)	mode
setting:		(ZoomSDKAutoFramingParameter *)	parameter

Starts my video auto-framing.

Parameters

mode	The auto-framing mode.
parameter	The setting of video auto-framing.

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

◆ getBeautyFaceValue

- (int) getBeautyFaceValue

Gets beauty face value.

Returns: If the function succeeds, it returns an int value(0-100). Otherwise returns 0.

References getBeautyFaceValue.

Referenced by getBeautyFaceValue.

◆ getCameraList

- (NSArray *_Nullable) getCameraList

Gets the list of camera device.

Returns: If the function succeeds, it returns an array containing SDKDeviceInfo element. Otherwise, this function fails and returns nil.

References getCameraList.

Referenced by getCameraList.

◆ getLightAdaptionManualValue

- (int) getLightAdaptionManualValue

Gets the setted's value.

Returns: If the function succeeds, it returns an int value(0-100). Otherwise returns 0.

References getLightAdaptionManualValue.

Referenced by getLightAdaptionManualValue.

◆ getLightAdjustModel

- (ZoomSDKSettingVideoLightAdaptionModel) getLightAdjustModel

Determines if adjustion for low light.

Returns: The ZoomSDKSettingVideoLightAdaptionModel.

References getLightAdjustModel.

Referenced by getLightAdjustModel.

◆ getSettingVideoTestHelper

- (ZoomSDKSettingTestVideoDeviceHelper *_Nullable) getSettingVideoTestHelper

Gets the object to test video device.

Returns: If the function succeeds, it returns a ZoomSDKSettingTestVideoDeviceHelper object. Otherwise, this function fails and returns nil.

References getSettingVideoTestHelper.

Referenced by getSettingVideoTestHelper.

◆ getVideoAutoFramingMode

- (ZoomSDKAutoFramingMode) getVideoAutoFramingMode

Gets the auto-framing mode.

Returns: The auto-framing mode.

References getVideoAutoFramingMode.

Referenced by getVideoAutoFramingMode.

◆ getVideoAutoFramingSettingWithMode:

- (ZoomSDKAutoFramingParameter *_Nullable) getVideoAutoFramingSettingWithMode: (ZoomSDKAutoFramingMode) mode

Gets the auto-framing parameter.

Parameters

mode	The auto-framing mode.

Returns: If the function succeeds, it returns the auto-framing parameter. Otherwise, this function fails and returns nil.

◆ hideNoVideoUser:

- (ZoomSDKError) hideNoVideoUser: (BOOL) hide

Enables or disable to hide the non-video participants.

Parameters

hide	YES if hiding, NO if displaying.

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

◆ isBeautyFaceEnabled

- (BOOL) isBeautyFaceEnabled

Determines if facial beauty effect is enabled.

Returns: YES if enabled. Otherwise, NO.

References isBeautyFaceEnabled.

Referenced by isBeautyFaceEnabled.

◆ isCanDisplayUpTo49InWallView

- (BOOL) isCanDisplayUpTo49InWallView

Determines if it is able to display up to 49 participants in video wall mode.

Returns: YES if able. Otherwise, NO.

References isCanDisplayUpTo49InWallView.

Referenced by isCanDisplayUpTo49InWallView.

◆ isCaptureOriginalSize

- (BOOL) isCaptureOriginalSize

Query if original size of video is enabled.

Returns: YES if enabled. Otherwise, NO.

References isCaptureOriginalSize.

Referenced by isCaptureOriginalSize.

◆ isCatchHDVideoOn

- (BOOL) isCatchHDVideoOn

Determines if HD video is enabled.

Returns: YES if enabled. Otherwise, NO.

References isCatchHDVideoOn.

Referenced by isCatchHDVideoOn.

◆ isDisplayUpTo49InWallViewOn

- (BOOL) isDisplayUpTo49InWallViewOn

Determines whether to display up to 49 participants in video wall mode.

Returns: YES if enabled. Otherwise, NO.

References isDisplayUpTo49InWallViewOn.

Referenced by isDisplayUpTo49InWallViewOn.

◆ isdisplayUserNameOnVideoOn

- (BOOL) isdisplayUserNameOnVideoOn

Determines if displaying screen name of the user is enabled.

Returns: YES if enabled. Otherwise, NO.

References isdisplayUserNameOnVideoOn.

Referenced by isdisplayUserNameOnVideoOn.

◆ isHardwareAccelerationForVideoReceiveOn

- (BOOL) isHardwareAccelerationForVideoReceiveOn

Determines whether to hardware acceleration for video receive.

Returns: YES if enabled. Otherwise, NO.

References isHardwareAccelerationForVideoReceiveOn.

Referenced by isHardwareAccelerationForVideoReceiveOn.

◆ isHideNoVideoUser

- (BOOL) isHideNoVideoUser

Determines if non-video participant is hided or not.

Returns: YES if enabled. Otherwise, NO.

References isHideNoVideoUser.

Referenced by isHideNoVideoUser.

◆ isHideSelfViewEnabled

- (BOOL) isHideSelfViewEnabled

Gets the flag to enable or disable to hide userself's view.

Returns: YES if enabled. Otherwise, NO.

References isHideSelfViewEnabled.

Referenced by isHideSelfViewEnabled.

◆ isMirrorEffectEnabled

- (BOOL) isMirrorEffectEnabled

Determines if mirror effect is enabled.

Returns: YES if enabled. Otherwise, NO.

References isMirrorEffectEnabled.

Referenced by isMirrorEffectEnabled.

◆ isMuteMyVideoWhenJoinMeetingOn

- (BOOL) isMuteMyVideoWhenJoinMeetingOn

Determines if the current user's video is muted when he joins meeting.

Returns: YES if muted. Otherwise, NO.

References isMuteMyVideoWhenJoinMeetingOn.

Referenced by isMuteMyVideoWhenJoinMeetingOn.

◆ isOptimizeVideoQualityEnabled

- (BOOL) isOptimizeVideoQualityEnabled

Determines if optimizing received video quality is enabled.

Returns: YES if optimization is enabled. Otherwise, NO.

References isOptimizeVideoQualityEnabled.

Referenced by isOptimizeVideoQualityEnabled.

◆ isOptimizeVideoQualitySupported

- (BOOL) isOptimizeVideoQualitySupported

Determines if optimizing received video quality is supported.

Returns: YES if it is supported, Otherwise, NO.

References isOptimizeVideoQualitySupported.

Referenced by isOptimizeVideoQualitySupported.

◆ isSpotlightMyVideoOn

- (BOOL) isSpotlightMyVideoOn

Determines if spotlighting the current user's video is enabled.

Returns: YES if enabled. Otherwise, NO.

References isSpotlightMyVideoOn.

Referenced by isSpotlightMyVideoOn.

◆ isStopIncomingVideoEnabled

- (BOOL) isStopIncomingVideoEnabled

Gets the flag to enable or disable to stop in coming video.

Returns: YES if enabled. Otherwise, NO.

References isStopIncomingVideoEnabled.

Referenced by isStopIncomingVideoEnabled.

◆ isTemporalDeNoiseOn

- (BOOL) isTemporalDeNoiseOn

Determines whether to de-noise.

Returns: YES if enabled. Otherwise, NO.

References isTemporalDeNoiseOn.

Referenced by isTemporalDeNoiseOn.

◆ isVideoAutoFramingEnabled

- (BOOL) isVideoAutoFramingEnabled

Determines whether auto-framing is enabled.

Returns: YES if enabled. Otherwise, NO.

References isVideoAutoFramingEnabled.

Referenced by isVideoAutoFramingEnabled.

◆ onDisplayUpTo49InWallView:

- (ZoomSDKError) onDisplayUpTo49InWallView: (BOOL) enable

Enables or disable to show the participants in Gallery View up to 49 per screen.

Parameters

enable YES indicates to show the participants in Gallery View up to 49 per screen, NO otherwise.

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

◆ onSpotlightMyVideoWhenISpeaker:

- (ZoomSDKError) onSpotlightMyVideoWhenISpeaker: (BOOL) enable

Enables to spotlight the current user's video in the main interface when he speaks in the meeting.

Parameters

enable YES if spotlighting always the current user's video, NO otherwise.

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

◆ onVideoCaptureOriginalSizeOr16To9:

- (ZoomSDKError) onVideoCaptureOriginalSizeOr16To9: (BOOL) originalSize

Sets to capture video ratio: original or 16:9.

Parameters

originalSize YES if original video, NO 16:9.

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

◆ selectCamera:

- (ZoomSDKError) selectCamera: (NSString *) deviceID

Select a camera.

Parameters

deviceID The ID of camera.

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

◆ setBeautyFaceValue:

- (ZoomSDKError) setBeautyFaceValue: (int) value

Sets beauty face value.

Parameters

value The value type is int, varies from 0 to 100.

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

◆ setFaceRecognitionFailStrategy:

- (ZoomSDKError) setFaceRecognitionFailStrategy: (ZoomSDKFaceRecognitionFailStrategy) strategy

Sets the fail strategy of face recognition when auto-framing is enabled(mode is ZoomSDKAutoFramingMode_Face_Recognition).

Parameters

strategy The fail strategy of face recognition.

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

◆ setLightAdaptionModel:LightAdaptionManualValue:

- (ZoomSDKError) setLightAdaptionModel:		(ZoomSDKSettingVideoLightAdaptionModel)	model
LightAdaptionManualValue:		(int)	value

Sets the way to adjust the low light.

Parameters

model	The model to be set.
value	The value type is int, varies from 0 to 100.

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

◆ setVideoAutoFramingMode:

- (ZoomSDKError) setVideoAutoFramingMode: (ZoomSDKAutoFramingMode) mode

Sets the mode of auto-framing when auto-framing is enabled.

Parameters

mode	The mode of auto-framing.

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

◆ setVideoAutoFramingRatio:

- (ZoomSDKError) setVideoAutoFramingRatio: (float) ratio

Sets the zoom in ratio of auto-framing when auto-framing is enabled.

Parameters

ratio The zoom in ratio, effective range: 0.7 < ratio < 2.1.

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

◆ setVideoQualityPreference:

- (ZoomSDKError) setVideoQualityPreference: (ZoomSDKVideoPreferenceSetting *) preferenceSetting

Sets the video quality preference that automatically adjust user's video to prioritize frame rate versus resolution based on the current bandwidth available.

Parameters

preferenceSetting An instance of ZoomSDKVideoPreferenceSetting.

Returns: If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

Field Documentation

◆ settingVideoTestHelper

- (ZoomSDKSettingTestVideoDeviceHelper*) settingVideoTestHelper

protected

Definition at line 786 of file ZoomSDKSettingService.h.

Instance Methods

Protected Attributes

Detailed Description

Method Documentation

◆ disableVideoAutoFraming

◆ disableVideoJoinMeeting:

◆ displayUserNameOnVideo:

◆ enableBeautyFace:

◆ enableCatchHDVideo:

◆ enableHardwareAccelerationForVideoReceive:

◆ enableHideSelfView:

◆ enableMirrorEffect:

◆ enableOptimizeVideoQuality:

◆ enableStopIncomingVideo:

◆ enableTemporalDeNoise:

◆ enableVideoAutoFraming:setting:

◆ getBeautyFaceValue

◆ getCameraList

◆ getLightAdaptionManualValue

◆ getLightAdjustModel

◆ getSettingVideoTestHelper

◆ getVideoAutoFramingMode

◆ getVideoAutoFramingSettingWithMode:

◆ hideNoVideoUser:

◆ isBeautyFaceEnabled

◆ isCanDisplayUpTo49InWallView

◆ isCaptureOriginalSize

◆ isCatchHDVideoOn

◆ isDisplayUpTo49InWallViewOn

◆ isdisplayUserNameOnVideoOn

◆ isHardwareAccelerationForVideoReceiveOn

◆ isHideNoVideoUser

◆ isHideSelfViewEnabled

◆ isMirrorEffectEnabled

◆ isMuteMyVideoWhenJoinMeetingOn

◆ isOptimizeVideoQualityEnabled

◆ isOptimizeVideoQualitySupported

◆ isSpotlightMyVideoOn

◆ isStopIncomingVideoEnabled

◆ isTemporalDeNoiseOn

◆ isVideoAutoFramingEnabled

◆ onDisplayUpTo49InWallView:

◆ onSpotlightMyVideoWhenISpeaker:

◆ onVideoCaptureOriginalSizeOr16To9:

◆ selectCamera:

◆ setBeautyFaceValue:

◆ setFaceRecognitionFailStrategy:

◆ setLightAdaptionModel:LightAdaptionManualValue:

◆ setVideoAutoFramingMode:

◆ setVideoAutoFramingRatio:

◆ setVideoQualityPreference:

Field Documentation

◆ settingVideoTestHelper