Video SDK for iOS API Reference
•All Classes Files Functions Enumerations Enumerator Properties
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
12
13@interface ZoomVideoSDKAnnotationHelper: NSObject
14
19- (BOOL)isSenderDisableAnnotation DEPRECATED_MSG_ATTRIBUTE("use canDoAnnotation instead");
20
25- (BOOL)canDoAnnotation;
26
31- (ZoomVideoSDKError)startAnnotation;
36- (ZoomVideoSDKError)stopAnnotation;
37
43- (ZoomVideoSDKError)setToolColor:(nullable UIColor *)toolColor;
48- (nullable UIColor *)getToolColor;
49
56- (ZoomVideoSDKError)setToolType:(ZoomVideoSDKAnnotationToolType)type;
61- (ZoomVideoSDKAnnotationToolType)getToolType;
62
68- (ZoomVideoSDKError)setToolWidth:(NSUInteger)width;
73- (NSUInteger)getToolWidth;
74
79- (ZoomVideoSDKError)undo;
80
85- (ZoomVideoSDKError)redo;
86
92- (ZoomVideoSDKError)clear:(ZoomVideoSDKAnnotationClearType)type;
93@end
94
95
ZoomVideoSDKAnnotationClearType
ZoomVideoSDKAnnotationClearType
Enumerations of the type for annotation clear type.
Definition ZoomVideoSDKConstants.h:420
ZoomVideoSDKAnnotationToolType
ZoomVideoSDKAnnotationToolType
Enumerations of the type for annotation tool type.
Definition ZoomVideoSDKConstants.h:391
ZoomVideoSDKError
ZoomVideoSDKError
ZoomVideoSDKError An enumeration of error.
Definition ZoomVideoSDKConstants.h:12
-[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.