Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKSettingVideoController.h
Go to the documentation of this file.
1//
2// ZoomSDKSettingVideoController.h
3// ZoomSDK
4
5
6#import <Foundation/Foundation.h>
7#import <ZoomSDK/ZoomSDKErrors.h>
8NS_ASSUME_NONNULL_BEGIN
9
14@interface ZoomSDKAutoFramingParameter : NSObject
18@property (assign,nonatomic) float ratio;
23@end
24
25
30@protocol ZoomSDKSettingVideoDelegate <NSObject>
31@optional
36- (void)onCameraStatusChanged:(ZoomSDKDeviceStatus)status;
41- (void)onSelectedCameraChanged:(NSString*)deviceID;
42@end
43
49{
50 id<ZoomSDKSettingVideoDelegate> _delegate;
51}
56@property(nonatomic, assign, nullable)id<ZoomSDKSettingVideoDelegate> delegate DEPRECATED_MSG_ATTRIBUTE("This property is deprecated. Use ZoomSDKVideoSetting.delegate instead.");
57
64- (ZoomSDKError)SetVideoParentView:(NSView*)parentView VideoContainerRect:(NSRect)containerRect;
71- (ZoomSDKError)StartPreview:(NSString*)deviceID DEPRECATED_MSG_ATTRIBUTE("No longer used");
72
83@end
84
85
92@interface ZoomSDKVideoPreferenceSetting : NSObject
96@property (nonatomic, assign, readwrite) ZoomSDKVideoPreferenceMode mode;
97
102@property (nonatomic, assign, readwrite) unsigned int minimumFrameRate;
103
108@property (nonatomic, assign, readwrite) unsigned int maximumFrameRate;
109@end
110
111
116@interface ZoomSDKVideoSetting: NSObject
117{
119 id<ZoomSDKSettingVideoDelegate> _delegate;
120}
124@property(nonatomic, assign, nullable)id<ZoomSDKSettingVideoDelegate> delegate;
125
131
136- (NSArray*_Nullable)getCameraList;
137
143- (ZoomSDKError)selectCamera:(NSString*)deviceID;
144
150
156- (ZoomSDKError)enableMirrorEffect:(BOOL)enable;
157
163
169- (ZoomSDKError)enableBeautyFace:(BOOL)enable;
170
176
182- (ZoomSDKError)setBeautyFaceValue:(int)value;
188- (ZoomSDKError)disableVideoJoinMeeting:(BOOL)disable;
189
195- (ZoomSDKError)displayUserNameOnVideo:(BOOL)display;
196
202- (ZoomSDKError)enableCatchHDVideo:(BOOL)enable;
208- (ZoomSDKError)onVideoCaptureOriginalSizeOr16To9:(BOOL)originalSize;
214- (ZoomSDKError)onSpotlightMyVideoWhenISpeaker:(BOOL)enable;
220- (ZoomSDKError)onDisplayUpTo49InWallView:(BOOL)enable;
226- (ZoomSDKError)hideNoVideoUser:(BOOL)hide;
278- (ZoomSDKError)setLightAdaptionModel:(ZoomSDKSettingVideoLightAdaptionModel)model LightAdaptionManualValue:(int)value;
284
290
296- (ZoomSDKError)enableHardwareAccelerationForVideoReceive:(BOOL)enable;
297
303
309- (ZoomSDKError)enableTemporalDeNoise:(BOOL)enable;
310
316
322
328- (ZoomSDKError)enableOptimizeVideoQuality:(BOOL)enable;
329
335- (ZoomSDKError)enableStopIncomingVideo:(BOOL)enable;
336
342
348- (ZoomSDKError)enableHideSelfView:(BOOL)enable;
349
355
362- (ZoomSDKError)enableVideoAutoFraming:(ZoomSDKAutoFramingMode)mode setting:(ZoomSDKAutoFramingParameter *)parameter;
363
369
375
381
387- (ZoomSDKAutoFramingParameter *_Nullable)getVideoAutoFramingSettingWithMode:(ZoomSDKAutoFramingMode)mode;
388
394- (ZoomSDKError)setVideoAutoFramingMode:(ZoomSDKAutoFramingMode)mode;
395
401- (ZoomSDKError)setVideoAutoFramingRatio:(float)ratio;
402
408- (ZoomSDKError)setFaceRecognitionFailStrategy:(ZoomSDKFaceRecognitionFailStrategy)strategy;
409
415- (ZoomSDKError)setVideoQualityPreference:(ZoomSDKVideoPreferenceSetting*)preferenceSetting;
416@end
417NS_ASSUME_NONNULL_END
ZoomSDKFaceRecognitionFailStrategy
Enumeration of face recognition failure strategies.
ZoomSDKDeviceStatus
Enumeration of device status.
ZoomSDKVideoPreferenceMode
Enumeration of video preference modes.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKAutoFramingMode
Enumeration of auto framing modes in video.
ZoomSDKSettingVideoLightAdaptionModel
Enumeration of video light adjustment modes. For more information, please visit https://support....
Parameters for auto-framing feature in Zoom SDK.
float ratio
The zoom in ratio of auto-framing, valid range of values: 1~10(when mode is ZoomSDKAutoFramingMode_Ce...
ZoomSDKFaceRecognitionFailStrategy failStrategy
The strategy when face recognition failed.
Helper class for testing video devices.
id< ZoomSDKSettingVideoDelegate > _delegate
ZoomSDKError StopPreview()
Stops previewing user's video.
ZoomSDKError StartPreview()
Preview user's video with default camera.
id< ZoomSDKSettingVideoDelegate > delegate
Delegate to receive video device events.
Settings for video preference modes including frame rates and resolution adaptation.
ZoomSDKVideoPreferenceMode mode
Preferred video mode.
unsigned int minimumFrameRate
0 for the default value, minimumFrameRate should be less than maximumFrameRate,
unsigned int maximumFrameRate
0 for the default value, maximumFrameRate should be less and equal than 30,
Interface for video settings including camera selection, video effects, beauty mode,...
BOOL isBeautyFaceEnabled()
Determines if facial beauty effect is enabled.
BOOL isHardwareAccelerationForVideoReceiveOn()
Determines whether to hardware acceleration for video receive.
BOOL isCatchHDVideoOn()
Determines if HD video is enabled.
BOOL isVideoAutoFramingEnabled()
Determines whether auto-framing is enabled.
ZoomSDKError disableVideoAutoFraming()
Stops video auto-framing.
BOOL isCanDisplayUpTo49InWallView()
Determines if it is able to display up to 49 participants in video wall mode.
ZoomSDKSettingTestVideoDeviceHelper *_Nullable getSettingVideoTestHelper()
Gets the object to test video device.
BOOL isTemporalDeNoiseOn()
Determines whether to de-noise.
id< ZoomSDKSettingVideoDelegate > delegate
Delegate to receive video device events.
BOOL isdisplayUserNameOnVideoOn()
Determines if displaying screen name of the user is enabled.
BOOL isHideNoVideoUser()
Determines if non-video participant is hided or not.
BOOL isOptimizeVideoQualitySupported()
Determines if optimizing received video quality is supported.
BOOL isOptimizeVideoQualityEnabled()
Determines if optimizing received video quality is enabled.
ZoomSDKSettingVideoLightAdaptionModel getLightAdjustModel()
Determines if adjustion for low light.
int getBeautyFaceValue()
Gets beauty face value.
id< ZoomSDKSettingVideoDelegate > _delegate
int getLightAdaptionManualValue()
Gets the setted's value.
BOOL isCaptureOriginalSize()
Query if original size of video is enabled.
ZoomSDKSettingTestVideoDeviceHelper * settingVideoTestHelper
NSArray *_Nullable getCameraList()
Gets the list of camera device.
BOOL isDisplayUpTo49InWallViewOn()
Determines whether to display up to 49 participants in video wall mode.
BOOL isStopIncomingVideoEnabled()
Gets the flag to enable or disable to stop in coming video.
ZoomSDKAutoFramingMode getVideoAutoFramingMode()
Gets the auto-framing mode.
BOOL isHideSelfViewEnabled()
Gets the flag to enable or disable to hide userself's view.
BOOL isMuteMyVideoWhenJoinMeetingOn()
Determines if the current user's video is muted when he joins meeting.
BOOL isMirrorEffectEnabled()
Determines if mirror effect is enabled.
BOOL isSpotlightMyVideoOn()
Determines if spotlighting the current user's video is enabled.