Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKCustomizedAnnotationCtr.h
Go to the documentation of this file.
1
6#import <ZoomSDK/ZoomSDKErrors.h>
7
8NS_ASSUME_NONNULL_BEGIN
10
15typedef struct{
19 float red;
23 float green;
27 float blue;
28}Color;
29
34@protocol ZoomSDKCustomizedAnnotationDelegate <NSObject>
39- (void) onAnnotationToolChanged:(AnnotationToolType)tool;
40@end
41
42
47@interface ZoomSDKCustomizedAnnotation : NSObject
48{
50 id<ZoomSDKCustomizedAnnotationDelegate> _delegate;
51}
55@property(nonatomic, assign, nullable)id<ZoomSDKCustomizedAnnotationDelegate> delegate;
61- (ZoomSDKError)canClear:(AnnotationClearType)clearType;
67- (ZoomSDKError)clear:(AnnotationClearType)clearType;
74- (ZoomSDKError)setTool:(AnnotationToolType)toolType;
80- (ZoomSDKError)getCurrentTool:(AnnotationToolType*)toolType;
86- (ZoomSDKError)setColor:(Color)color;
92- (ZoomSDKError)getCurrentColor:(Color*)color;
98- (ZoomSDKError)setLineWidth:(long)lineWidth;
104- (ZoomSDKError)getCurrentLineWidth:(long*)lineWidth;
109- (ZoomSDKError)undo;
114- (ZoomSDKError)redo;
119- (ZoomSDKError)canSaveSnapshot;
120
127- (ZoomSDKError)saveSnapshot:(NSString*)snapShotName snapshotSaveType:(ZoomSDKAnnotationSavedType)savedType;
128@end
129
130
135@protocol ZoomSDKCustomizedAnnotationCtrlDelegate <NSObject>
140- (void)onAnnotationCleanUp:(ZoomSDKCustomizedAnnotation*)annotation;
146- (void)onAnnotationStatusChanged:(ZoomSDKShareElement*_Nullable)element Status:(AnnotationStatus)status;
147
153- (void)onAnnotationSupportPropertyChangedForCustom:(BOOL)isSupportAnnotation shareSourceID:(unsigned int)shareSourceID;
154@end
155
156
162{
163 id<ZoomSDKCustomizedAnnotationCtrlDelegate> _delegate;
164}
168@property(nonatomic, assign, nullable) id<ZoomSDKCustomizedAnnotationCtrlDelegate> delegate;
169
176- (ZoomSDKError)createCustomizedAnnotation:(ZoomSDKCustomizedAnnotation*_Nullable*_Nonnull)annotation ShareElement:(ZoomSDKShareElement*)element;
182- (ZoomSDKError)cleanCustomizedAnnotation:(ZoomSDKCustomizedAnnotation*)annotation;
183
190- (ZoomSDKError)disableViewerAnnotation:(ZoomSDKCustomizedAnnotation*)annotation disable:(BOOL)disable;
191
198- (ZoomSDKError)isViewerAnnotationLocked:(ZoomSDKCustomizedAnnotation*)annotation isLocked:(BOOL*)locked;
199
206- (ZoomSDKError)canDisableViewerAnnotation:(ZoomSDKCustomizedAnnotation*)annotation canDisabled:(BOOL*)canDisable;
207
214- (ZoomSDKError)canDoAnnotation:(ZoomSDKCustomizedAnnotation*)annotation canAnnotate:(BOOL*)canAnnotate;
215@end
216NS_ASSUME_NONNULL_END
AnnotationToolType
Type of annotation tools. For more information, please visit https://support.zoom....
AnnotationClearType
Types of clearing annotations.
AnnotationStatus
Enumeration of annotation status.
ZoomSDKAnnotationSavedType
Enumeration of file types for saving screenshots.
ZoomSDKError
Enumeration of common errors of SDK.
Controller class to create and manage customized annotations.
id< ZoomSDKCustomizedAnnotationCtrlDelegate > _delegate
Provides interfaces to operate customized annotations on shared content.
id< ZoomSDKCustomizedAnnotationDelegate > _delegate
The share element object to handle individual shared content and render view.
Represents an RGB color with float components.
float blue
Blue color component, range is 0 to 255.
float green
Green color component, range is 0 to 255.
float red
Red color component, range is 0 to 255.