PanoRtcAnnotation 接口类对应用程序提供了所有的标注相关方法。 更多...
#import <PanoRtcAnnotation.h>
类 PanoRtcAnnotation 继承关系图:
类方法 | |
| (instancetype) | + new |
| 此方法不可用。 | |
详细描述
PanoRtcAnnotation 接口类对应用程序提供了所有的标注相关方法。
PanoRtcAnnotation 对象可以通过 PanoRtcAnnotationManager 实例获取。
函数文档
◆ clearContents
| - (PanoResult) clearContents |
清除标注内容
- 返回
- kPanoResultOK: 成功
- 其他: 失败
- 注解
- 此操作需要管理员角色。
◆ clearUserContents:
| - (PanoResult) clearUserContents: | (UInt64) | userId |
清除指定用户绘制的标注内容
- 参数
-
userId 用户ID
- 返回
- kPanoResultOK: 成功
- 其他: 失败
- 注解
- 如果指定用户不是当前用户，此操作需要管理员角色。
◆ getToolType
| - (PanoWBToolType) getToolType |
获取工具类型
- 返回
- 工具类型
◆ redo
| - (PanoResult) redo |
重做标注的上一次被撤销操作。
- 返回
- kPanoResultOK: 成功
- 其他: 失败
◆ setAspectWidth:height:
| - (PanoResult) setAspectWidth: | (UInt32) | w | |
| height: | (UInt32) | h | |
设置标注区域大小
- 参数
-
w 宽 h 高
- 返回
- kPanoResultOK: 成功
- 其他: 失败
◆ setColor:
| - (PanoResult) setColor: | (PanoWBColor *_Nonnull) | color |
◆ setDelegate:
| - (PanoResult) setDelegate: | (id< PanoRtcAnnotationDelegate > _Nullable) | delegate |
◆ setExtAnnoMode:
| - (PanoResult) setExtAnnoMode: | (PanoExternalAnnoMode) | mode |
设置外部标注模式。仅对外部标注有效。
- 参数
-
mode ExternalAnnoMode类别
- 返回
- kPanoResultOK: 成功
- 其他: 失败
◆ setFillColor:
| - (PanoResult) setFillColor: | (PanoWBColor *_Nonnull) | color |
设置填充颜色。
- 参数
-
color PanoWBColor 对象。有效值范围：[0, 1]。
- 返回
- kPanoResultOK: 成功
- 其他: 失败
- 注解
- 仅当设置填充类型为kPanoWBFillColor起效。
◆ setFillType:
| - (PanoResult) setFillType: | (PanoWBFillType) | type |
设置填充类型。
- 参数
-
type PanoWBFillType 枚举类型。
- 返回
- kPanoResultOK: 成功
- 其他: 失败
◆ setFontSize:
| - (PanoResult) setFontSize: | (UInt32) | size |
设置字体大小。
- 参数
-
size 有效值范围：[10, 96]。
- 返回
- kPanoResultOK: 成功
- 其他: 失败
◆ setFontStyle:
| - (PanoResult) setFontStyle: | (PanoWBFontStyle) | style |
设置标注字体样式。
- 参数
-
color PanoWBFontStyle 枚举类型。
- 返回
- kPanoResultOK: 成功
- 其他: 失败
◆ setLineWidth:
| - (PanoResult) setLineWidth: | (UInt32) | width |
设置标注线条宽度。
- 参数
-
width 有效值范围：[1, 20]。
- 返回
- kPanoResultOK: 成功
- 其他: 失败
◆ setOption:forType:
| - (PanoResult) setOption: | (NSObject *_Nullable) | option | |
| forType: | (PanoAnnoOptionType) | type | |
设置标注参数
- 参数
-
option 参数类别 type PanoAnnoOptionType 枚举类型。
- 返回
- kPanoResultOK: 成功
- 其他: 失败
◆ setRoleType:
| - (PanoResult) setRoleType: | (PanoWBRoleType) | type |
设置标注角色类型。
- 参数
-
type 标注角色，PanoWBRoleType 枚举类型。
- 返回
- kPanoResultOK: 成功
- 其他: 失败
◆ setScalingMode:
| - (PanoResult) setScalingMode: | (PanoVideoScalingMode) | mode |
设置标注区域缩放模式
- 参数
-
mode 缩放模式
- 返回
- kPanoResultOK: 成功
- 其他: 失败
◆ setToolType:
| - (PanoResult) setToolType: | (PanoWBToolType) | type |
设置标注工具。
- 参数
-
view PanoWBToolType 枚举类型。
- 返回
- kPanoResultOK: 成功
- 其他: 失败
◆ setVisible:
| - (PanoResult) setVisible: | (BOOL) | visible |
设置标注视图是否可见
- 参数
-
visible 是否可见
- 返回
- kPanoResultOK: 成功
- 其他: 失败
- 注解
- 标注视图默认是可见的
◆ setWindowPos:
| - (PanoResult) setWindowPos: | (CGRect) | rect |
设置标注窗口位置及大小。
- 参数
-
rect WBRect类型
- 返回
- kPanoResultOK: 成功
- 其他: 失败
◆ snapshot:
| - (PanoResult) snapshot: | (NSString *_Nonnull) | outputDir |
保存标注内容到图像。
- 参数
-
outputDir 输出路径
- 返回
- kPanoResultOK 成功
- 其他: 失败
- 注解
- 快照结果和图像文件名通过回调函数onSnapshotComplete返回
◆ startAnnotation:
| - (PanoResult) startAnnotation: | (PanoView *_Nullable) | view |
开始标注。
- 参数
-
view 客户提供的标注显示视图。
- 返回
- kPanoResultOK: 成功
- 其他: 失败
- 注解
- 开启标注前需要保证白板服务是正常的。
- 对共享标注的共享端，view参数传nil
◆ stopAnnotation
| - (PanoResult) stopAnnotation |
停止标注
- 返回
- kPanoResultOK: 成功
- 其他: 失败
◆ undo
| - (PanoResult) undo |
撤销标注上一次操作。
- 返回
- kPanoResultOK: 成功
- 其他: 失败
该类的文档由以下文件生成:
