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

#import <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods

(ZoomSDKSettingTestVideoDeviceHelper *) - getSettingVideoTestHelper
 Get the object to test video device.

 
(NSArray *) - getCameraList
 Get the list of camera device.
 
(ZoomSDKError- selectCamera:
 Select a camera.
 
(BOOL) - isMirrorEffectEnabled
 Determine if mirror effect is enabled.
 
(ZoomSDKError- enableMirrorEffect:
 Set to enable/disable mirror effect.
 
(BOOL) - isBeautyFaceEnabled
 Determine if facial beauty effect is enabled.
 
(ZoomSDKError- enableBeautyFace:
 Enable/disable facial beauty effect.
 
(int) - getBeautyFaceValue
 Get beauty face value.
 
(ZoomSDKError- setBeautyFaceValue:
 Set beauty face value.
 
(ZoomSDKError- disableVideoJoinMeeting:
 Turn off the participant's video when he joins meeting.
 
(ZoomSDKError- displayUserNameOnVideo:
 Display/Hide username on the video window.
 
(ZoomSDKError- enableCatchHDVideo:
 Enable or disable HD video.
 
(ZoomSDKError- onVideoCaptureOriginalSizeOr16To9:
 Set to capture video ratio: original or 16:9.
 
(ZoomSDKError- onSpotlightMyVideoWhenISpeaker:
 Enable to spotlight the current user's video in the main interface when he speaks in the meeting.
 
(ZoomSDKError- onDisplayUpTo49InWallView:
 Enable or disable to show the participants in Gallery View up to 49 per screen.
 
(ZoomSDKError- hideNoVideoUser:
 Enable or disable to hide the non-video participants.
 
(BOOL) - isHideNoVideoUser
 Determine if non-video participant is hided or not.
 
(BOOL) - isCaptureOriginalSize
 Query if original size of video is enabled.

 
(BOOL) - isSpotlightMyVideoOn
 Determine if it is enabled to spotlight the current user's video.
 
(BOOL) - isMuteMyVideoWhenJoinMeetingOn
 Determine if the current user's video is muted when he joins meeting.
 
(BOOL) - isdisplayUserNameOnVideoOn
 Determine if it is enabled to display user's screen name.
 
(BOOL) - isCanDisplayUpTo49InWallView
 Determine if it is able to display up to 49 participants in video wall mode.
 
(BOOL) - isDisplayUpTo49InWallViewOn
 Determine whether to display up to 49 participants in video wall mode.
 
(BOOL) - isCatchHDVideoOn
 Determine if HD video is enabled.
 
(ZoomSDKSettingVideoLightAdaptionModel- getLightAdjustModel
 Determine if adjustion for low light.
 
(ZoomSDKError- setLightAdaptionModel:LightAdaptionManualValue:
 Set the way to adjust the low light.
 
(int) - getLightAdaptionManualValue
 Get the value of the setted.
 
(BOOL) - isHardwareAccelerationForVideoReceiveOn
 Determine whether to hardware acceleration for video receive.
 
(ZoomSDKError- enableHardwareAccelerationForVideoReceive:
 Enable or disable hardware acceleration for video receive.
 
(BOOL) - isTemporalDeNoiseOn
 Determine whether to de-noise.
 
(ZoomSDKError- enableTemporalDeNoise:
 Enable or disable de-noise.
 
(BOOL) - isOptimizeVideoQualitySupported
 Determine if optimizing received video quality is supported.
 
(BOOL) - isOptimizeVideoQualityEnabled
 Determine if optimizing received video quality is enabled.
 
(ZoomSDKError- enableOptimizeVideoQuality:
 Enable 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.
 
(BOOL) - isSupportLipSyncAvatar
 Determine whether to show audio-only avatar when the user’s video feature is supported by the meeting.
 
(ZoomSDKError- enableLipSyncAvatarWhenVideoOff:
 Enable or disable audio-only 3d avatar when the user’s video is off.
 
(BOOL) - isLipSyncAvatarWhenVideoOffEnabled
 Get the flag to enable or disable audio-only 3d avatar when the user’s video is off.
 
(ZoomSDKVideoLipSyncAvatarSettingContext *) - getLipSyncAvatarSettingContext
 Get the pointer to ZoomSDKVideoLipsyncAvatarSettingContext which is used to set lip-sync avatar.
 
(ZoomSDKError- enableStopIncomingVideo:
 Enable or disable to stop incoming video.
 
(BOOL) - isStopIncomingVideoEnabled
 Get the flag to enable/disable to stop in coming video.
 
(ZoomSDKError- enableHideSelfView:
 Enable or disable to hide the userself's view.
 
(BOOL) - isHideSelfViewEnabled
 Get the flag to enable/disable to hide userself's view.
 
(ZoomSDKError- enableVideoAutoFraming:setting:
 Start my video auto-framing.
 
(ZoomSDKError- disableVideoAutoFraming
 Stop video auto-framing.
 
(BOOL) - isVideoAutoFramingEnabled
 Determine whether auto-framing is enabled.
 
(ZoomSDKAutoFramingMode- getVideoAutoFramingMode
 Get the auto-framing mode.
 
(ZoomSDKAutoFramingParameter *) - getVideoAutoFramingSettingWithMode:
 Get the auto-framing parameter.
 
(ZoomSDKError- setVideoAutoFramingMode:
 Set the mode of auto-framing when auto-framing is enabled.
 
(ZoomSDKError- setVideoAutoFramingRatio:
 Set the zoom in ratio of auto-framing when auto-framing is enabled.
 
(ZoomSDKError- setFaceRecognitionFailStrategy:
 Set the fail strategy of face recognition when auto-framing is enabled(mode is ZoomSDKAutoFramingMode_Face_Recognition).
 

Protected Attributes

ZoomSDKSettingTestVideoDeviceHelpersettingVideoTestHelper
 
ZoomSDKVideoLipSyncAvatarSettingContextlipsyncAvatarSettingContext
 

Detailed Description

Definition at line 649 of file ZoomSDKSettingService.h.

Method Documentation

◆ disableVideoAutoFraming

- (ZoomSDKError) disableVideoAutoFraming

Stop video auto-framing.

Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ disableVideoJoinMeeting:

- (ZoomSDKError) disableVideoJoinMeeting: (BOOL)  disable

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

Parameters
disableYES means that the video is turned off, otherwise not.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ displayUserNameOnVideo:

- (ZoomSDKError) displayUserNameOnVideo: (BOOL)  display

Display/Hide username on the video window.

Parameters
displayYES means showing always username on the video window, otherwise not.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ enableBeautyFace:

- (ZoomSDKError) enableBeautyFace: (BOOL)  enable

Enable/disable facial beauty effect.

Parameters
enableYES means enabled, No disabled.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ enableCatchHDVideo:

- (ZoomSDKError) enableCatchHDVideo: (BOOL)  enable

Enable or disable HD video.

Parameters
enableYES means enabled, NO disabled.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ enableHardwareAccelerationForVideoReceive:

- (ZoomSDKError) enableHardwareAccelerationForVideoReceive: (BOOL)  enable

Enable or disable hardware acceleration for video receive.

Parameters
enableYES means enabled, NO disabled.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enableHideSelfView:

- (ZoomSDKError) enableHideSelfView: (BOOL)  enable

Enable or disable to hide the userself's view.

Parameters
enableYES indicates to enable to hide the userself's view.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enableLipSyncAvatarWhenVideoOff:

- (ZoomSDKError) enableLipSyncAvatarWhenVideoOff: (BOOL)  enable

Enable or disable audio-only 3d avatar when the user’s video is off.

Parameters
enableYES indicates to show audio-only 3d avatar when the user’smy video is off.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enableMirrorEffect:

- (ZoomSDKError) enableMirrorEffect: (BOOL)  enable

Set to enable/disable mirror effect.

Parameters
enableYES means enabled, No disabled.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ enableOptimizeVideoQuality:

- (ZoomSDKError) enableOptimizeVideoQuality: (BOOL)  enable

Enable 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
enableYES indicates to enable this feature. Otherwise disable this feature.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enableStopIncomingVideo:

- (ZoomSDKError) enableStopIncomingVideo: (BOOL)  enable

Enable or disable to stop incoming video.

Parameters
enableYES indicates to enable to stop incoming video.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enableTemporalDeNoise:

- (ZoomSDKError) enableTemporalDeNoise: (BOOL)  enable

Enable or disable de-noise.

Parameters
enableYES means enabled, NO disabled.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enableVideoAutoFraming:setting:

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

Start my video auto-framing.

Parameters
modeThe auto-framing mode.
parameterThe setting of video auto-framing.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ getBeautyFaceValue

- (int) getBeautyFaceValue

Get beauty face value.

Returns
If the function succeeds, it will return an int value(0-100), otherwise returns 0.

◆ getCameraList

- (NSArray *) getCameraList

Get the list of camera device.

Returns
If the function succeeds, it will return an array containing SDKDeviceInfo element.

◆ getLightAdaptionManualValue

- (int) getLightAdaptionManualValue

Get the value of the setted.

Returns
If the function succeeds, it will return an int value(0-100), otherwise returns 0.

◆ getLightAdjustModel

- (ZoomSDKSettingVideoLightAdaptionModel) getLightAdjustModel

Determine if adjustion for low light.

Returns
If the function succeeds, it will return ZoomSDKSettingVideoLightAdaptionModel.

◆ getLipSyncAvatarSettingContext

- (ZoomSDKVideoLipSyncAvatarSettingContext *) getLipSyncAvatarSettingContext

Get the pointer to ZoomSDKVideoLipsyncAvatarSettingContext which is used to set lip-sync avatar.

Returns
If the function succeeds, the return value is the pointer to ZoomSDKVideoLipsyncAvatarSettingContext.Otherwise failed, returns nil.

◆ getSettingVideoTestHelper

- (ZoomSDKSettingTestVideoDeviceHelper *) getSettingVideoTestHelper

Get the object to test video device.

Returns
If the function succeeds, it will return a ZoomSDKSettingTestVideoDeviceHelper object, otherwise failed, returns nil.

◆ getVideoAutoFramingMode

- (ZoomSDKAutoFramingMode) getVideoAutoFramingMode

Get the auto-framing mode.

Returns
If the function succeeds, it will return the auto-framing mode, otherwise not.

◆ getVideoAutoFramingSettingWithMode:

- (ZoomSDKAutoFramingParameter *) getVideoAutoFramingSettingWithMode: (ZoomSDKAutoFramingMode mode

Get the auto-framing parameter.

Parameters
modeThe auto-framing mode.
Returns
If the function succeeds, it will return the auto-framing parameter, otherwise not.

◆ hideNoVideoUser:

- (ZoomSDKError) hideNoVideoUser: (BOOL)  hide

Enable or disable to hide the non-video participants.

Parameters
hideYES means hiding, NO means displaying.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ isBeautyFaceEnabled

- (BOOL) isBeautyFaceEnabled

Determine if facial beauty effect is enabled.

Returns
YES means enabled, otherwise not.

◆ isCanDisplayUpTo49InWallView

- (BOOL) isCanDisplayUpTo49InWallView

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

Returns
YES means able, otherwise not.

◆ isCaptureOriginalSize

- (BOOL) isCaptureOriginalSize

Query if original size of video is enabled.

Returns
YES means enabled, otherwise not.

◆ isCatchHDVideoOn

- (BOOL) isCatchHDVideoOn

Determine if HD video is enabled.

Returns
YES means enabled, otherwise not.

◆ isDisplayUpTo49InWallViewOn

- (BOOL) isDisplayUpTo49InWallViewOn

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

Returns
YES means enabled, otherwise not.

◆ isdisplayUserNameOnVideoOn

- (BOOL) isdisplayUserNameOnVideoOn

Determine if it is enabled to display user's screen name.

Returns
YES means enaled, otherwise not.

◆ isHardwareAccelerationForVideoReceiveOn

- (BOOL) isHardwareAccelerationForVideoReceiveOn

Determine whether to hardware acceleration for video receive.

Returns
YES means enabled, otherwise not.

◆ isHideNoVideoUser

- (BOOL) isHideNoVideoUser

Determine if non-video participant is hided or not.

Returns
YES means enabled, otherwise not.

◆ isHideSelfViewEnabled

- (BOOL) isHideSelfViewEnabled

Get the flag to enable/disable to hide userself's view.

Returns
YES indicates enabled. NO disable.

◆ isLipSyncAvatarWhenVideoOffEnabled

- (BOOL) isLipSyncAvatarWhenVideoOffEnabled

Get the flag to enable or disable audio-only 3d avatar when the user’s video is off.

Returns
YES indicates enabled. NO disable.

◆ isMirrorEffectEnabled

- (BOOL) isMirrorEffectEnabled

Determine if mirror effect is enabled.

Returns
YES means enabled, otherwise not.

◆ isMuteMyVideoWhenJoinMeetingOn

- (BOOL) isMuteMyVideoWhenJoinMeetingOn

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

Returns
YES means muted, otherwise not.

◆ isOptimizeVideoQualityEnabled

- (BOOL) isOptimizeVideoQualityEnabled

Determine if optimizing received video quality is enabled.

Returns
YES indicates that optimization is enabled. NO means optimization is not enabled.

◆ isOptimizeVideoQualitySupported

- (BOOL) isOptimizeVideoQualitySupported

Determine if optimizing received video quality is supported.

Returns
YES indicates that it is supported, NO means that it isn’t.

◆ isSpotlightMyVideoOn

- (BOOL) isSpotlightMyVideoOn

Determine if it is enabled to spotlight the current user's video.

Returns
YES means enabled, otherwise not.

◆ isStopIncomingVideoEnabled

- (BOOL) isStopIncomingVideoEnabled

Get the flag to enable/disable to stop in coming video.

Returns
Enabled or disabled.

◆ isSupportLipSyncAvatar

- (BOOL) isSupportLipSyncAvatar

Determine whether to show audio-only avatar when the user’s video feature is supported by the meeting.

Returns
YES indicates enabled. NO not.

◆ isTemporalDeNoiseOn

- (BOOL) isTemporalDeNoiseOn

Determine whether to de-noise.

Returns
YES means enabled, otherwise not.

◆ isVideoAutoFramingEnabled

- (BOOL) isVideoAutoFramingEnabled

Determine whether auto-framing is enabled.

Returns
YES indicates enabled. NO disable.

◆ onDisplayUpTo49InWallView:

- (ZoomSDKError) onDisplayUpTo49InWallView: (BOOL)  enable

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

Parameters
enableYES indicates to show the participants in Gallery View up to 49 per screen, otherwise not.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ onSpotlightMyVideoWhenISpeaker:

- (ZoomSDKError) onSpotlightMyVideoWhenISpeaker: (BOOL)  enable

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

Parameters
enableYES means spotlighting always the current user's video, NO not.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ onVideoCaptureOriginalSizeOr16To9:

- (ZoomSDKError) onVideoCaptureOriginalSizeOr16To9: (BOOL)  originalSize

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

Parameters
originalSizeYES means original video, NO 16:9.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ selectCamera:

- (ZoomSDKError) selectCamera: (NSString *)  deviceID

Select a camera.

Parameters
deviceIDThe ID of camera.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ setBeautyFaceValue:

- (ZoomSDKError) setBeautyFaceValue: (int)  value

Set beauty face value.

Parameters
valueThe value type is int, varies from 0 to 100.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ setFaceRecognitionFailStrategy:

- (ZoomSDKError) setFaceRecognitionFailStrategy: (ZoomSDKFaceRecognitionFailStrategy strategy

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

Parameters
strategyThe fail strategy of face recognition. For more details, see ZoomSDKFaceRecognitionFailStrategy.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setLightAdaptionModel:LightAdaptionManualValue:

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

Set the way to adjust the low light.

Parameters
modelThe model to be set.
valueThe value type is int, varies from 0 to 100.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setVideoAutoFramingMode:

- (ZoomSDKError) setVideoAutoFramingMode: (ZoomSDKAutoFramingMode mode

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

Parameters
modeThe mode of auto-framing. For more details, see ZoomSDKAutoFramingMode.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setVideoAutoFramingRatio:

- (ZoomSDKError) setVideoAutoFramingRatio: (float)  ratio

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

Parameters
ratioThe zoom in ratio, effective range: 0.7 < ratio < 2.1.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

Field Documentation

◆ lipsyncAvatarSettingContext

- (ZoomSDKVideoLipSyncAvatarSettingContext*) lipsyncAvatarSettingContext
protected

Definition at line 652 of file ZoomSDKSettingService.h.

◆ settingVideoTestHelper

- (ZoomSDKSettingTestVideoDeviceHelper*) settingVideoTestHelper
protected

Definition at line 651 of file ZoomSDKSettingService.h.