PanoRtcWhiteboard 接口类对应用程序提供了所有的白板相关方法。
更多...
#import <PanoRtcWhiteboard.h>
|
(instancetype) | + new |
| 此方法不可用。
|
|
◆ addAudioFile:
- (PanoResult) addAudioFile: |
|
(NSString *_Nonnull) |
mediaUrl |
|
添加音频媒体文件到当前白板页
- 参数
-
mediaUrl | 媒体 URL,可为本地路径或远程 URL |
- 返回
-
◆ addBackgroundImages:
- (NSString *_Nullable) addBackgroundImages: |
|
(NSArray< NSString * > *_Nonnull) |
urls |
|
◆ addDoc:
添加新的白板文件
- 参数
-
- 返回
-
- 注解
- PanoRtcWhiteboard创建时会生成白板文件ID为"default"的白板文件
◆ addDocWithExternal:
基于外部内容添加新的白板文件
- 参数
-
- 返回
-
- 注解
- PanoWhiteboard创建时会生成白板文件ID为"default"的白板文件
◆ addDocWithExtHtml:
使用外部Html添加新的白板文件
- 参数
-
- 返回
-
- 注解
- PanoWhiteboard创建时会生成白板文件ID为"default"的白板文件
◆ addH5File:download:
- (NSString *_Nullable) addH5File: |
|
(NSString *_Nonnull) |
url |
download: |
|
(NSString *_Nullable) |
downloadUrl |
|
|
| |
添加H5文件URL到当前白板文件作为背景
- 参数
-
url | 网络URL(仅支持远程URL) |
downloadUrl | H5文件的下载URL, 所有文件需要打包为zip文件 |
- 返回
-
- 注解
- PanoRtcWhiteboard创建时会生成白板文件ID为"default"的白板文件
◆ addImageFile:
- (PanoResult) addImageFile: |
|
(NSString *_Nonnull) |
imageUrl |
|
添加图片到当前白板页
- 参数
-
imageUrl | 图像 URL,可为本地路径或远程 URL |
- 返回
-
◆ addPage:
◆ addStamp:
◆ addVideoFile:
- (PanoResult) addVideoFile: |
|
(NSString *_Nonnull) |
mediaUrl |
|
添加视频媒体文件到当前白板页
- 参数
-
mediaUrl | 媒体 URL,可为本地路径或远程 URL |
- 返回
-
◆ broadcastMessage:
- (PanoResult) broadcastMessage: |
|
(NSData *_Nonnull) |
message |
|
◆ clearContents:withType:
清除白板内容
- 参数
-
curPage | YES: 只清除当前页内容;NO: 清除所有页内容 |
type | PanoWbClearType 枚举类型 |
- 返回
-
- 注解
- 此操作需要管理员角色。
◆ clearDocContents:withType:
清除指定白板文件的内容
- 参数
-
fileId | 白板文件ID |
type | PanoWbClearType 枚举类型 |
- 返回
-
- 其他: 失败
- 注解
- 只有 ADMIN 角色才可以调用
◆ clearUserContents:currentPage:withType:
清除指定用户绘制的白板内容
- 参数
-
userId | 用户ID |
curPage | YES: 只清除当前页内容;NO: 清除所有页内容 |
type | PanoWbClearType 枚举类型 |
- 返回
-
- 注解
- 如果指定用户不是当前用户,此操作需要管理员角色。
◆ close
◆ createDocWithFilePath:
- (NSString *_Nullable) createDocWithFilePath: |
|
(NSString *_Nonnull) |
filePath |
|
上传本地需转码的文件并创建新的白板文件
- 参数
-
- 返回
-
- 注解
- PanoRtcWhiteboard 创建时会生成白板文件ID为"default"的白板文件 最大文件大小取决于文档转码RESTful API
◆ createDocWithFilePath:convertParam:
上传本地需转码的文件并创建新的白板文件
- 参数
-
filePath | 本地文件路径 |
config | 转码配置 |
- 返回
-
- 注解
- PanoRtcWhiteboard 创建时会生成白板文件ID为"default"的白板文件 最大文件大小取决于文档转码RESTful API
◆ createDocWithImages:
- (NSString *_Nullable) createDocWithImages: |
|
(NSArray< NSString * > *_Nonnull) |
urls |
|
◆ deleteDoc:
- (PanoResult) deleteDoc: |
|
(NSString *_Nonnull) |
fileId |
|
删除白板文件
- 参数
-
- 返回
-
- 注解
- "default" 白板文件不能被删除
◆ enumerateFiles
- (NSMutableArray< NSString * > *_Nullable) enumerateFiles |
|
|
|
◆ exportTo:
- (PanoResult) exportTo: |
|
(NSString *_Nonnull) |
filename |
|
◆ getCurrentFileId
- (NSString *_Nullable) getCurrentFileId |
|
|
|
◆ getCurrentMaxScaleFactor
- (Float32) getCurrentMaxScaleFactor |
|
|
|
◆ getCurrentMinScaleFactor
- (Float32) getCurrentMinScaleFactor |
|
|
|
◆ getCurrentPageNumber
获取当前白板页码。
- 返回
- PanoWBPageNumber(-1):白板未打开
- Others:白板页码
◆ getCurrentScaleFactor
- (Float32) getCurrentScaleFactor |
|
|
|
◆ getCurrentWhiteboardId
- (NSString *_Nullable) getCurrentWhiteboardId |
|
|
|
◆ getFileInfo:
- (PanoWBDocInfo *_Nullable) getFileInfo: |
|
(NSString *_Nonnull) |
fileId |
|
◆ getToolType
◆ getTotalNumberOfPages
- (UInt32) getTotalNumberOfPages |
|
|
|
◆ gotoPage:
◆ importFrom:
- (PanoResult) importFrom: |
|
(NSString *_Nonnull) |
filename |
|
◆ initVision:
设置白板初始大小
- 返回
- kPanoResultOK: 成功
- Others: 失败
◆ insertPage:autoSwitch:
添加一个新页面到指定页码之后。
- 参数
-
pageNo | 指定页码。 |
autoSwitch | 自动切换到新添加的页面。 |
- 返回
-
◆ leave
◆ nextPage
◆ nextStep
◆ open:
◆ prevPage
◆ prevStep
◆ redo
◆ removePage:
◆ removePage:switchNext:
删除页 pageNo
- 参数
-
pageNo | 被删除的页码 |
switchNext | 切换到删除页的下一页. |
- 注解
- 删除页的默认行为是切换到删除页的前一页。设置switchNext为YES改为切换到删除页的下一页。
- 返回
-
◆ resetVision
重置当前页视角
- 返回
- kPanoResultOK: 成功
- Others: 失败
◆ saveDocToImages:path:
- (PanoResult) saveDocToImages: |
|
(NSString *_Nonnull) |
fileId |
path: |
|
(NSString *_Nonnull) |
outputDir |
|
|
| |
保存白板文件。每个白板页存为一张图 图像名称格式为whiteboard_[fileId]_[page number].png, 例如:whiteboard_default_1.png
- 参数
-
fileId | 白板文件ID |
outputDir | 输出路径 |
- 返回
-
◆ sendMessage:toUser:
- (PanoResult) sendMessage: |
|
(NSData *_Nonnull) |
message |
toUser: |
|
(UInt64) |
userId |
|
|
| |
发送消息给某个指定用户。
- 参数
-
message | 要发送的消息。 |
userId | 接收消息的用户。 |
- 返回
-
◆ sendToExternalHtml:message:
- (PanoResult) sendToExternalHtml: |
|
(NSString *_Nonnull) |
fileId |
message: |
|
(NSString *_Nonnull) |
msg |
|
|
| |
发送自定义消息到外部HTML页面
- 参数
-
fileId | 白板文件ID |
msg | 自定义消息 |
length | 自定义消息长度 |
- 返回
-
- 注解
- 只支持外部HTML
◆ setBackgroundColor:
◆ setBackgroundImage:
- (PanoResult) setBackgroundImage: |
|
(NSString *_Nonnull) |
imageUrl |
|
设置白板当前页背景图片。
- 参数
-
imageUrl | 图片 URL,可为本地路径或者网络链接。 |
- 返回
-
◆ setBackgroundImage:withPageNumber:
设置白板指定页背景图片
- 参数
-
imageUrl | 背景图 URL,可为本地路径或者网络链接。 |
pageNo | 白板页码。 |
- 返回
-
◆ setBackgroundImageScalingMode:
◆ setCurrentScaleFactor:
- (PanoResult) setCurrentScaleFactor: |
|
(Float32) |
scale |
|
设置当前白板视图的缩放比例
- 参数
-
scale | 缩放比例值。有效值范围 [0.1, 5.0] |
- 返回
-
◆ setDelegate:
设置白板回调对象,用以接收白板事件消息。
- 参数
-
- 返回
-
◆ setFillColor:
设置白板填充颜色。
- 参数
-
- 返回
-
- 注解
- 仅当设置填充类型为kPanoWBFillColor起效。
◆ setFillType:
◆ setFontSize:
◆ setFontStyle:
设置白板字体样式。
- 参数
-
color | PanoWBFontStyle 枚举类型。 |
- 返回
-
◆ setForegroundColor:
◆ setLineWidth:
◆ setOption:forType:
设置白板选项对象。
- 参数
-
option | 选项对象。 |
type | PanoWBOptionType 枚举类型。 |
- 返回
-
◆ setRoleType:
设置白板角色类型。
- 参数
-
type | 白板角色,PanoWBRoleType 枚举类型。 |
- 返回
-
◆ setStamp:
- (PanoResult) setStamp: |
|
(NSString *_Nonnull) |
stampId |
|
◆ setToolType:
◆ snapshot:path:
保存白板内容到图像。
- 参数
-
- 返回
-
- 注解
- 快照结果和图像文件名通过回调函数onSnapshotComplete: name:返回
◆ startFollowVision
◆ startShareVision
◆ stop
◆ stopFollowVision
◆ stopShareVision
◆ switchDoc:
- (PanoResult) switchDoc: |
|
(NSString *_Nonnull) |
fileId |
|
◆ syncVision
◆ undo
该类的文档由以下文件生成: