#import <Foundation/Foundation.h>
#import "ZMVideoSDKUserHelper.h"

NS_ASSUME_NONNULL_BEGIN

/**
 @brief Annotate helper interface.
 */
@interface ZMVideoSDKAnnotationHelper : NSObject

/**
 * @brief Whether annotation was disabled or not by the share owner.
 * @return YES indicates the annotations is disabled, otherwise NO.
 */
- (BOOL)isSenderDisableAnnotation;

/**
 * @brief Starts annotation.
 * @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
- (ZMVideoSDKErrors)startAnnotation;

/**
 * @brief Stops annotation.
 * @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
- (ZMVideoSDKErrors)stopAnnotation;

/**
 * @brief Set the annotation tool color.
 * @param toolColor The specified color
 * @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
- (ZMVideoSDKErrors)setToolColor:(NSColor* _Nonnull)toolColor;

/**
 * @brief Gets the annotation tool color.
 * @param toolColor The current tool color.
 * @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
- (ZMVideoSDKErrors)getToolColor:(NSColor* _Nullable * _Nonnull)toolColor;

/**
 * @brief Sets the annotation tool type.
 * @param toolType The specified annotation tool type. For more information, see {@link ZMVideoSDKAnnotationToolType}.
 * @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 * @warning The tool type ZMVideoSDKAnnotationToolType_Picker and ZMVideoSDKAnnotationToolType_SpotLight are not support for viewer.
 */
- (ZMVideoSDKErrors)setToolType:(ZMVideoSDKAnnotationToolType)toolType;

/**
 * @brief Gets the annotation tool type.
 * @param toolType The current tool type. For more information, see {@link ZMVideoSDKAnnotationToolType}.
 * @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
- (ZMVideoSDKErrors)getToolType:(ZMVideoSDKAnnotationToolType*)toolType;

/**
 * @brief Sets the annotation tool width.
 * @param width The specify annotation tool width.
 * @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
- (ZMVideoSDKErrors)setToolWidth:(long)width;

/**
 * @brief Gets the annotation tool width.
 * @param width The line width of annotations.
 * @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
- (ZMVideoSDKErrors)getToolWidth:(long*)width;

/**
 * @brief Undoes one annotation content step.
 * @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
- (ZMVideoSDKErrors)undo;

/**
 * @brief Redoes one annotation content step.
 * @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
- (ZMVideoSDKErrors)redo;

/**
 * @brief Clears the annotation content.
 * @param type The specified clear type.
 * @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
 */
- (ZMVideoSDKErrors)clear:(ZMVideoSDKAnnotationClearType)type;
@end

NS_ASSUME_NONNULL_END