Mac SDK
Instance Methods | Protected Attributes | List of all members
ZoomSDKVideoSetting Class Reference
Inheritance diagram for ZoomSDKVideoSetting:

Instance Methods

(ZoomSDKSettingTestVideoDeviceHelper *) - getSettingVideoTestHelper
 Get the object to test video device.
More...
 
(NSArray *) - getCameraList
 Get the list of camera device. More...
 
(ZoomSDKError) - selectCamera:
 Select a camera. More...
 
(BOOL) - isMirrorEffectEnabled
 Determine if mirror effect is enabled. More...
 
(ZoomSDKError) - enableMirrorEffect:
 Set to enable/disable mirror effect. More...
 
(BOOL) - isBeautyFaceEnabled
 Determine if facial beauty effect is enabled. More...
 
(ZoomSDKError) - enableBeautyFace:
 Enable/disable facial beauty effect. More...
 
(int) - getBeautyFaceValue
 Get beauty face value. More...
 
(ZoomSDKError) - setBeautyFaceValue:
 Set beauty face value. More...
 
(ZoomSDKError) - disableVideoJoinMeeting:
 Turn off the participant's video when he joins meeting. More...
 
(ZoomSDKError) - displayUserNameOnVideo:
 Display/Hide username on the video window. More...
 
(ZoomSDKError) - enableCatchHDVideo:
 Enable or disable HD video. More...
 
(ZoomSDKError) - onVideoCaptureOriginalSizeOr16To9:
 Set to capture video ratio: original or 16:9. More...
 
(ZoomSDKError) - onSpotlightMyVideoWhenISpeaker:
 Enable to spotlight the current user's video in the main interface when he speaks in the meeting. More...
 
(ZoomSDKError) - onDisplayUpTo49InWallView:
 Enable or disable to show the participants in Gallery View up to 49 per screen. More...
 
(ZoomSDKError) - hideNoVideoUser:
 Enable or disable to hide the non-video participants. More...
 
(BOOL) - isHideNoVideoUser
 Determine if non-video participant is hided or not. More...
 
(BOOL) - isCaptureOriginalSize
 Query if original size of video is enabled.
More...
 
(BOOL) - isSpotlightMyVideoOn
 Determine if it is enabled to spotlight the current user's video. More...
 
(BOOL) - isMuteMyVideoWhenJoinMeetingOn
 Determine if the current user's video is muted when he joins meeting. More...
 
(BOOL) - isdisplayUserNameOnVideoOn
 Determine if it is enabled to display user's screen name. More...
 
(BOOL) - isCanDisplayUpTo49InWallView
 Determine if it is able to display up to 49 participants in video wall mode. More...
 
(BOOL) - isDisplayUpTo49InWallViewOn
 Determine whether to display up to 49 participants in video wall mode. More...
 
(BOOL) - isCatchHDVideoOn
 Determine if HD video is enabled. More...
 
(ZoomSDKSettingVideoLightAdaptionModel) - getLightAdjustModel:
 Determine if adjustion for low light. More...
 
(ZoomSDKError) - setLightAdaptionModel:LightAdaptionManualValue:
 Set the way to adjust the low light. More...
 
(int) - getLightAdaptionManualValue:
 Get the value of the setted. More...
 
(BOOL) - isHardwareAccelerationForVideoReceiveOn:
 Determine whether to hardware acceleration for video receive. More...
 
(ZoomSDKError) - enableHardwareAccelerationForVideoReceive:
 Enable or disable hardware acceleration for video receive. More...
 
(BOOL) - isTemporalDeNoiseOn:
 Determine whether to de-noise. More...
 
(ZoomSDKError) - enableTemporalDeNoise:
 Enable or disable de-noise. More...
 

Protected Attributes

ZoomSDKSettingTestVideoDeviceHelpersettingVideoTestHelper
 

Method Documentation

◆ 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.

◆ 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.

◆ 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.

◆ 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: (BOOL *)  isDisabled

Get the value of the setted.

Parameters
isDisabledYES means only can used setted value,can't modify.
Returns
If the function succeeds, it will return an int value(0-255), otherwise returns 0.

◆ getLightAdjustModel:

- (ZoomSDKSettingVideoLightAdaptionModel) getLightAdjustModel: (BOOL *)  isDisabled

Determine if adjustion for low light.

Parameters
isDisabledYES means only can used config value,can't modify.
Returns
If the function succeeds, it will return ZoomSDKSettingVideoLightAdaptionModel.

◆ 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.

◆ 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: (BOOL *)  isDisabled

Determine whether to hardware acceleration for video receive.

Parameters
isDisabledYES means only can used config value,can't modify.
Returns
YES means enabled, otherwise not.

◆ isHideNoVideoUser

- (BOOL) isHideNoVideoUser

Determine if non-video participant is hided or not.

Returns
YES means enabled, otherwise not.

◆ 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.

◆ isSpotlightMyVideoOn

- (BOOL) isSpotlightMyVideoOn

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

Returns
YES means enabled, otherwise not.

◆ isTemporalDeNoiseOn:

- (BOOL) isTemporalDeNoiseOn: (BOOL *)  isDisabled

Determine whether to de-noise.

Parameters
isDisabledYES means only can used config value,can't modify.
Returns
YES means enabled, otherwise not.

◆ 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.

◆ 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 255.
Returns
If the function succeeds, it will return ZoomSDKError_success, otherwise not.

The documentation for this class was generated from the following file: