Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKAnnotationHelper.h
Go to the documentation of this file.
1//
2// ZoomVideoSDKAnnotationHelper.h
3// ZoomVideoSDK
4//
5// Created by Zoom Video Communications on 4/19/23.
6// Copyright © Zoom Video Communications, Inc. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10#import <ZoomVideoSDK/ZoomVideoSDKConstants.h>
11
16@interface ZoomVideoSDKAnnotationHelper: NSObject
17
23- (BOOL)isSenderDisableAnnotation DEPRECATED_MSG_ATTRIBUTE("use canDoAnnotation instead");
24
29- (BOOL)canDoAnnotation;
30
35- (ZoomVideoSDKError)startAnnotation;
40- (ZoomVideoSDKError)stopAnnotation;
41
47- (ZoomVideoSDKError)setToolColor:(nullable UIColor *)toolColor;
52- (nullable UIColor *)getToolColor;
53
60- (ZoomVideoSDKError)setToolType:(ZoomVideoSDKAnnotationToolType)type;
65- (ZoomVideoSDKAnnotationToolType)getToolType;
66
72- (ZoomVideoSDKError)setToolWidth:(NSUInteger)width;
77- (NSUInteger)getToolWidth;
78
83- (ZoomVideoSDKError)undo;
84
89- (ZoomVideoSDKError)redo;
90
96- (ZoomVideoSDKError)clear:(ZoomVideoSDKAnnotationClearType)type;
97@end
98
99
ZoomVideoSDKAnnotationClearType
ZoomVideoSDKAnnotationClearType
Enumeration of the type for clear annotation.
Definition ZoomVideoSDKConstants.h:661
ZoomVideoSDKAnnotationToolType
ZoomVideoSDKAnnotationToolType
Enumeration of the type for annotation tool. For more information, please visit https://support....
Definition ZoomVideoSDKConstants.h:609
ZoomVideoSDKError
ZoomVideoSDKError
Enumerates all errors in the VideoSDK.
Definition ZoomVideoSDKConstants.h:12
ZoomVideoSDKAnnotationHelper
Annotation helper interface for Zoom Video SDK.
Definition ZoomVideoSDKAnnotationHelper.h:17
-[ZoomVideoSDKAnnotationHelper startAnnotation]
ZoomVideoSDKError startAnnotation()
Starts annotation.
-[ZoomVideoSDKAnnotationHelper getToolColor]
nullable UIColor * getToolColor()
Gets the annotation tool color.
-[ZoomVideoSDKAnnotationHelper stopAnnotation]
ZoomVideoSDKError stopAnnotation()
Stops annotation.
-[ZoomVideoSDKAnnotationHelper redo]
ZoomVideoSDKError redo()
Redoes one annotation content step.
-[ZoomVideoSDKAnnotationHelper getToolWidth]
NSUInteger getToolWidth()
Get the annotation tool width.
-[ZoomVideoSDKAnnotationHelper isSenderDisableAnnotation]
BOOL isSenderDisableAnnotation()
Whether annotation was disabled or not by the share owner.
-[ZoomVideoSDKAnnotationHelper canDoAnnotation]
BOOL canDoAnnotation()
Whether the current user can do annotation on the share.
-[ZoomVideoSDKAnnotationHelper getToolType]
ZoomVideoSDKAnnotationToolType getToolType()
Get the annotation tool type.
-[ZoomVideoSDKAnnotationHelper undo]
ZoomVideoSDKError undo()
Undoes one annotation content step.