Meeting SDK for macOS API 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 | |
ZoomSDKSettingTestVideoDeviceHelper * | settingVideoTestHelper |
ZoomSDKVideoLipSyncAvatarSettingContext * | lipsyncAvatarSettingContext |
Definition at line 649 of file ZoomSDKSettingService.h.
- (ZoomSDKError) disableVideoAutoFraming |
Stop video auto-framing.
- (ZoomSDKError) disableVideoJoinMeeting: | (BOOL) | disable |
Turn off the participant's video when he joins meeting.
disable | YES means that the video is turned off, otherwise not. |
- (ZoomSDKError) displayUserNameOnVideo: | (BOOL) | display |
Display/Hide username on the video window.
display | YES means showing always username on the video window, otherwise not. |
- (ZoomSDKError) enableBeautyFace: | (BOOL) | enable |
Enable/disable facial beauty effect.
enable | YES means enabled, No disabled. |
- (ZoomSDKError) enableCatchHDVideo: | (BOOL) | enable |
Enable or disable HD video.
enable | YES means enabled, NO disabled. |
- (ZoomSDKError) enableHardwareAccelerationForVideoReceive: | (BOOL) | enable |
Enable or disable hardware acceleration for video receive.
enable | YES means enabled, NO disabled. |
- (ZoomSDKError) enableHideSelfView: | (BOOL) | enable |
Enable or disable to hide the userself's view.
enable | YES indicates to enable to hide the userself's view. |
- (ZoomSDKError) enableLipSyncAvatarWhenVideoOff: | (BOOL) | enable |
Enable or disable audio-only 3d avatar when the user’s video is off.
enable | YES indicates to show audio-only 3d avatar when the user’smy video is off. |
- (ZoomSDKError) enableMirrorEffect: | (BOOL) | enable |
Set to enable/disable mirror effect.
enable | YES means enabled, No disabled. |
- (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.
enable | YES indicates to enable this feature. Otherwise disable this feature. |
- (ZoomSDKError) enableStopIncomingVideo: | (BOOL) | enable |
Enable or disable to stop incoming video.
enable | YES indicates to enable to stop incoming video. |
- (ZoomSDKError) enableTemporalDeNoise: | (BOOL) | enable |
Enable or disable de-noise.
enable | YES means enabled, NO disabled. |
- (ZoomSDKError) enableVideoAutoFraming: | (ZoomSDKAutoFramingMode) | mode | |
setting: | (ZoomSDKAutoFramingParameter *) | parameter | |
Start my video auto-framing.
mode | The auto-framing mode. |
parameter | The setting of video auto-framing. |
- (int) getBeautyFaceValue |
Get beauty face value.
- (NSArray *) getCameraList |
Get the list of camera device.
- (int) getLightAdaptionManualValue |
Get the value of the setted.
- (ZoomSDKSettingVideoLightAdaptionModel) getLightAdjustModel |
Determine if adjustion for low light.
- (ZoomSDKVideoLipSyncAvatarSettingContext *) getLipSyncAvatarSettingContext |
Get the pointer to ZoomSDKVideoLipsyncAvatarSettingContext which is used to set lip-sync avatar.
- (ZoomSDKSettingTestVideoDeviceHelper *) getSettingVideoTestHelper |
Get the object to test video device.
- (ZoomSDKAutoFramingMode) getVideoAutoFramingMode |
Get the auto-framing mode.
- (ZoomSDKAutoFramingParameter *) getVideoAutoFramingSettingWithMode: | (ZoomSDKAutoFramingMode) | mode |
Get the auto-framing parameter.
mode | The auto-framing mode. |
- (ZoomSDKError) hideNoVideoUser: | (BOOL) | hide |
Enable or disable to hide the non-video participants.
hide | YES means hiding, NO means displaying. |
- (BOOL) isBeautyFaceEnabled |
Determine if facial beauty effect is enabled.
- (BOOL) isCanDisplayUpTo49InWallView |
Determine if it is able to display up to 49 participants in video wall mode.
- (BOOL) isCaptureOriginalSize |
Query if original size of video is enabled.
- (BOOL) isCatchHDVideoOn |
Determine if HD video is enabled.
- (BOOL) isDisplayUpTo49InWallViewOn |
Determine whether to display up to 49 participants in video wall mode.
- (BOOL) isdisplayUserNameOnVideoOn |
Determine if it is enabled to display user's screen name.
- (BOOL) isHardwareAccelerationForVideoReceiveOn |
Determine whether to hardware acceleration for video receive.
- (BOOL) isHideNoVideoUser |
Determine if non-video participant is hided or not.
- (BOOL) isHideSelfViewEnabled |
Get the flag to enable/disable to hide userself's view.
- (BOOL) isLipSyncAvatarWhenVideoOffEnabled |
Get the flag to enable or disable audio-only 3d avatar when the user’s video is off.
- (BOOL) isMirrorEffectEnabled |
Determine if mirror effect is enabled.
- (BOOL) isMuteMyVideoWhenJoinMeetingOn |
Determine if the current user's video is muted when he joins meeting.
- (BOOL) isOptimizeVideoQualityEnabled |
Determine if optimizing received video quality is enabled.
- (BOOL) isOptimizeVideoQualitySupported |
Determine if optimizing received video quality is supported.
- (BOOL) isSpotlightMyVideoOn |
Determine if it is enabled to spotlight the current user's video.
- (BOOL) isStopIncomingVideoEnabled |
Get the flag to enable/disable to stop in coming video.
- (BOOL) isSupportLipSyncAvatar |
Determine whether to show audio-only avatar when the user’s video feature is supported by the meeting.
- (BOOL) isTemporalDeNoiseOn |
Determine whether to de-noise.
- (BOOL) isVideoAutoFramingEnabled |
Determine whether auto-framing is enabled.
- (ZoomSDKError) onDisplayUpTo49InWallView: | (BOOL) | enable |
Enable or disable to show the participants in Gallery View up to 49 per screen.
enable | YES indicates to show the participants in Gallery View up to 49 per screen, otherwise not. |
- (ZoomSDKError) onSpotlightMyVideoWhenISpeaker: | (BOOL) | enable |
Enable to spotlight the current user's video in the main interface when he speaks in the meeting.
enable | YES means spotlighting always the current user's video, NO not. |
- (ZoomSDKError) onVideoCaptureOriginalSizeOr16To9: | (BOOL) | originalSize |
Set to capture video ratio: original or 16:9.
originalSize | YES means original video, NO 16:9. |
- (ZoomSDKError) selectCamera: | (NSString *) | deviceID |
Select a camera.
deviceID | The ID of camera. |
- (ZoomSDKError) setBeautyFaceValue: | (int) | value |
Set beauty face value.
value | The value type is int, varies from 0 to 100. |
- (ZoomSDKError) setFaceRecognitionFailStrategy: | (ZoomSDKFaceRecognitionFailStrategy) | strategy |
Set the fail strategy of face recognition when auto-framing is enabled(mode is ZoomSDKAutoFramingMode_Face_Recognition).
strategy | The fail strategy of face recognition. For more details, see ZoomSDKFaceRecognitionFailStrategy . |
- (ZoomSDKError) setLightAdaptionModel: | (ZoomSDKSettingVideoLightAdaptionModel) | model | |
LightAdaptionManualValue: | (int) | value | |
Set the way to adjust the low light.
model | The model to be set. |
value | The value type is int, varies from 0 to 100. |
- (ZoomSDKError) setVideoAutoFramingMode: | (ZoomSDKAutoFramingMode) | mode |
Set the mode of auto-framing when auto-framing is enabled.
mode | The mode of auto-framing. For more details, see ZoomSDKAutoFramingMode . |
- (ZoomSDKError) setVideoAutoFramingRatio: | (float) | ratio |
Set the zoom in ratio of auto-framing when auto-framing is enabled.
ratio | The zoom in ratio, effective range: 0.7 < ratio < 2.1. |
|
protected |
Definition at line 652 of file ZoomSDKSettingService.h.
|
protected |
Definition at line 651 of file ZoomSDKSettingService.h.