iOS/macOS(Objective-C)[v1.7.5.0]
构造函数 | 类方法 | 所有成员列表
PanoRtcWhiteboard类 参考

PanoRtcWhiteboard 接口类对应用程序提供了所有的白板相关方法。 更多...

#import <PanoRtcWhiteboard.h>

类 PanoRtcWhiteboard 继承关系图:

构造函数

(instancetype) - init
 此方法不可用。
 
(PanoResult- setDelegate:
 设置白板回调对象,用以接收白板事件消息。 更多...
 
(PanoResult- open:
 打开白板。 更多...
 
(PanoResult- close
 关闭白板。 更多...
 
(PanoResult- leave
 leave白板 更多...
 
(PanoResult- stop
 停止白板 更多...
 
(PanoResult- importFrom:
 导入dump文件到白板 更多...
 
(PanoResult- exportTo:
 导出dump文件到白板 更多...
 
(NSString *_Nullable) - getCurrentWhiteboardId
 获取当前白板Id 更多...
 
(PanoResult- setRoleType:
 设置白板角色类型。 更多...
 
(PanoResult- setToolType:
 设置白板工具。 更多...
 
(PanoWBToolType- getToolType
 获取工具类型 更多...
 
(PanoResult- setLineWidth:
 设置白板线条宽度。 更多...
 
(PanoResult- setFillType:
 设置白板填充类型。 更多...
 
(PanoResult- setFillColor:
 设置白板填充颜色。 更多...
 
(PanoResult- setForegroundColor:
 设置白板前景色。 更多...
 
(PanoResult- setBackgroundColor:
 设置白板背景色。 更多...
 
(PanoResult- setFontStyle:
 设置白板字体样式。 更多...
 
(PanoResult- setFontSize:
 设置字体大小。 更多...
 
(PanoResult- addStamp:
 添加图章资源 更多...
 
(PanoResult- setStamp:
 设置图章资源 更多...
 
(PanoResult- setBackgroundImageScalingMode:
 设置白板背景图缩放模式。 更多...
 
(PanoResult- setBackgroundImage:
 设置白板当前页背景图片。 更多...
 
(PanoResult- setBackgroundImage:withPageNumber:
 设置白板指定页背景图片 更多...
 
(PanoWBPageNumber- getCurrentPageNumber
 获取当前白板页码。 更多...
 
(UInt32) - getTotalNumberOfPages
 获取总白板页码数。 更多...
 
(PanoResult- addPage:
 添加一个新页面到最后。 更多...
 
(PanoResult- insertPage:autoSwitch:
 添加一个新页面到指定页码之后。 更多...
 
(PanoResult- removePage:
 删除指定页。 更多...
 
(PanoResult- removePage:switchNext:
 删除页 pageNo 更多...
 
(PanoResult- gotoPage:
 切换到指定页。 更多...
 
(PanoResult- nextPage
 切换到下一页。 更多...
 
(PanoResult- prevPage
 切换到前一页。 更多...
 
(PanoResult- nextStep
 执行H5文件下一步 更多...
 
(PanoResult- prevStep
 执行H5文件上一步 更多...
 
(PanoResult- addImageFile:
 添加图片到当前白板页 更多...
 
(PanoResult- addAudioFile:
 添加音频媒体文件到当前白板页 更多...
 
(PanoResult- addVideoFile:
 添加视频媒体文件到当前白板页 更多...
 
(NSString *_Nullable) - addBackgroundImages:
 添加指定数量的背景图到当前白板文件 更多...
 
(NSString *_Nullable) - addH5File:download:
 添加H5文件URL到当前白板文件作为背景 更多...
 
(NSString *_Nullable) - addDoc:
 添加新的白板文件 更多...
 
(NSString *_Nullable) - addDocWithExtHtml:
 使用外部Html添加新的白板文件 更多...
 
(NSString *_Nullable) - addDocWithExternal:
 基于外部内容添加新的白板文件 更多...
 
(NSString *_Nullable) - createDocWithImages:
 导入指定数量的背景图并创建新的白板文件 更多...
 
(NSString *_Nullable) - createDocWithFilePath:
 上传本地需转码的文件并创建新的白板文件 更多...
 
(NSString *_Nullable) - createDocWithFilePath:convertParam:
 上传本地需转码的文件并创建新的白板文件 更多...
 
(PanoResult- deleteDoc:
 删除白板文件 更多...
 
(PanoResult- switchDoc:
 切换白板文件 更多...
 
(PanoResult- saveDocToImages:path:
 保存白板文件。每个白板页存为一张图 图像名称格式为whiteboard_[fileId]_[page number].png, 例如:whiteboard_default_1.png 更多...
 
(NSMutableArray< NSString * > *_Nullable) - enumerateFiles
 枚举白板文件 更多...
 
(NSString *_Nullable) - getCurrentFileId
 获取当前白板文件ID 更多...
 
(PanoWBDocInfo *_Nullable) - getFileInfo:
 获取指定白板文件ID的白板文件信息 更多...
 
(PanoResult- sendToExternalHtml:message:
 发送自定义消息到外部HTML页面 更多...
 
(PanoResult- clearContents:withType:
 清除白板内容 更多...
 
(PanoResult- clearUserContents:currentPage:withType:
 清除指定用户绘制的白板内容 更多...
 
(PanoResult- clearDocContents:withType:
 清除指定白板文件的内容 更多...
 
(PanoResult- undo
 撤销白板上一次操作。 更多...
 
(PanoResult- redo
 重做白板的上一次被撤销操作。 更多...
 
(Float32) - getCurrentScaleFactor
 获取当前白板视图的缩放比例。 更多...
 
(PanoResult- setCurrentScaleFactor:
 设置当前白板视图的缩放比例 更多...
 
(Float32) - getCurrentMinScaleFactor
 获取当前白板视图的最小缩放比例 更多...
 
(Float32) - getCurrentMaxScaleFactor
 获取当前白板视图的最大缩放比例 更多...
 
(PanoResult- snapshot:path:
 保存白板内容到图像。 更多...
 
(PanoResult- initVision:
 设置白板初始大小 更多...
 
(PanoResult- resetVision
 重置当前页视角 更多...
 
(PanoResult- startShareVision
 开始共享视角 更多...
 
(PanoResult- stopShareVision
 停止共享视角 更多...
 
(PanoResult- startFollowVision
 开始跟随视角 更多...
 
(PanoResult- stopFollowVision
 停止跟随视角 更多...
 
(PanoResult- syncVision
 同步当前页视角 更多...
 
(PanoResult- sendMessage:toUser:
 发送消息给某个指定用户。 更多...
 
(PanoResult- broadcastMessage:
 广播消息给所有用户。 更多...
 
(PanoResult- setOption:forType:
 设置白板选项对象。 更多...
 

类方法

(instancetype) + new
 此方法不可用。
 

详细描述

PanoRtcWhiteboard 接口类对应用程序提供了所有的白板相关方法。

PanoRtcWhiteboard 对象可以通过 PanoRtcEngineKit 实例获取。

函数文档

◆ addAudioFile:

- (PanoResult) addAudioFile: (NSString *_Nonnull)  mediaUrl

添加音频媒体文件到当前白板页

参数
mediaUrl媒体 URL,可为本地路径或远程 URL
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ addBackgroundImages:

- (NSString *_Nullable) addBackgroundImages: (NSArray< NSString * > *_Nonnull)  urls

添加指定数量的背景图到当前白板文件

参数
urls背景图url数组(仅支持远程URL)
返回
  • 当前白板文件ID,如果失败返回空串
注解
PanoRtcWhiteboard 创建时会生成白板文件ID为"default"的白板文件

◆ addDoc:

- (NSString *_Nullable) addDoc: (PanoWBDocContents *)  contents

添加新的白板文件

参数
contents根据转码结果指定的白板文件内容
返回
  • 当前白板文件ID,如果失败返回nullptr
注解
PanoRtcWhiteboard创建时会生成白板文件ID为"default"的白板文件

◆ addDocWithExternal:

- (NSString *_Nullable) addDocWithExternal: (PanoWBDocExtContents *)  contents

基于外部内容添加新的白板文件

参数
contents外部白板文件内容
返回
  • 当前白板文件ID,如果失败返回nullptr
注解
PanoWhiteboard创建时会生成白板文件ID为"default"的白板文件

◆ addDocWithExtHtml:

- (NSString *_Nullable) addDocWithExtHtml: (PanoWBDocExtHtml *)  extHtml

使用外部Html添加新的白板文件

参数
contents外部Html的白板文件内容
返回
  • 当前白板文件ID,如果失败返回nullptr
注解
PanoWhiteboard创建时会生成白板文件ID为"default"的白板文件

◆ addH5File:download:

- (NSString *_Nullable) addH5File: (NSString *_Nonnull)  url
download: (NSString *_Nullable)  downloadUrl 

添加H5文件URL到当前白板文件作为背景

参数
url网络URL(仅支持远程URL)
downloadUrlH5文件的下载URL, 所有文件需要打包为zip文件
返回
  • 当前白板文件ID,如果失败返回nullptr
注解
PanoRtcWhiteboard创建时会生成白板文件ID为"default"的白板文件

◆ addImageFile:

- (PanoResult) addImageFile: (NSString *_Nonnull)  imageUrl

添加图片到当前白板页

参数
imageUrl图像 URL,可为本地路径或远程 URL
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ addPage:

- (PanoResult) addPage: (BOOL)  autoSwitch

添加一个新页面到最后。

参数
autoSwitch自动切换到新添加的页面。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ addStamp:

- (PanoResult) addStamp: (PanoWBStamp *_Nonnull)  stamp

添加图章资源

参数
stamp图章资源
返回
  • OK: 成功
  • Others: 失败

◆ addVideoFile:

- (PanoResult) addVideoFile: (NSString *_Nonnull)  mediaUrl

添加视频媒体文件到当前白板页

参数
mediaUrl媒体 URL,可为本地路径或远程 URL
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ broadcastMessage:

- (PanoResult) broadcastMessage: (NSData *_Nonnull)  message

广播消息给所有用户。

参数
message要广播的消息。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ clearContents:withType:

- (PanoResult) clearContents: (BOOL)  curPage
withType: (PanoWbClearType type 

清除白板内容

参数
curPageYES: 只清除当前页内容;NO: 清除所有页内容
typePanoWbClearType 枚举类型
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
此操作需要管理员角色。

◆ clearDocContents:withType:

- (PanoResult) clearDocContents: (NSString *_Nonnull)  fileId
withType: (PanoWbClearType type 

清除指定白板文件的内容

参数
fileId白板文件ID
typePanoWbClearType 枚举类型
返回
  • kPanoResultOK: 成功
  • 其他: 失败
    注解
    只有 ADMIN 角色才可以调用

◆ clearUserContents:currentPage:withType:

- (PanoResult) clearUserContents: (UInt64)  userId
currentPage: (BOOL)  curPage
withType: (PanoWbClearType type 

清除指定用户绘制的白板内容

参数
userId用户ID
curPageYES: 只清除当前页内容;NO: 清除所有页内容
typePanoWbClearType 枚举类型
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
如果指定用户不是当前用户,此操作需要管理员角色。

◆ close

- (PanoResult) close

关闭白板。

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ createDocWithFilePath:

- (NSString *_Nullable) createDocWithFilePath: (NSString *_Nonnull)  filePath

上传本地需转码的文件并创建新的白板文件

参数
filePath本地文件路径
返回
  • 新创建的白板文件ID,如果失败返回空串
注解
PanoRtcWhiteboard 创建时会生成白板文件ID为"default"的白板文件 最大文件大小取决于文档转码RESTful API

◆ createDocWithFilePath:convertParam:

- (NSString *_Nullable) createDocWithFilePath: (NSString *_Nonnull)  filePath
convertParam: (PanoWBConvertConfig *)  config 

上传本地需转码的文件并创建新的白板文件

参数
filePath本地文件路径
config转码配置
返回
  • 新创建的白板文件ID,如果失败返回空串
注解
PanoRtcWhiteboard 创建时会生成白板文件ID为"default"的白板文件 最大文件大小取决于文档转码RESTful API

◆ createDocWithImages:

- (NSString *_Nullable) createDocWithImages: (NSArray< NSString * > *_Nonnull)  urls

导入指定数量的背景图并创建新的白板文件

参数
urls背景图url数组(仅支持远程URL)
返回
  • 新创建的白板文件ID,如果失败返回空串
注解
PanoRtcWhiteboard 创建时会生成白板文件ID为"default"的白板文件

◆ deleteDoc:

- (PanoResult) deleteDoc: (NSString *_Nonnull)  fileId

删除白板文件

参数
fileId白板文件ID
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
"default" 白板文件不能被删除

◆ enumerateFiles

- (NSMutableArray< NSString * > *_Nullable) enumerateFiles

枚举白板文件

返回
fileId 数组

◆ exportTo:

- (PanoResult) exportTo: (NSString *_Nonnull)  filename

导出dump文件到白板

参数
filename导出文件
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ getCurrentFileId

- (NSString *_Nullable) getCurrentFileId

获取当前白板文件ID

返回
  • 当前白板文件ID, 失败则返回null

◆ getCurrentMaxScaleFactor

- (Float32) getCurrentMaxScaleFactor

获取当前白板视图的最大缩放比例

返回
缩放比例值

◆ getCurrentMinScaleFactor

- (Float32) getCurrentMinScaleFactor

获取当前白板视图的最小缩放比例

返回
缩放比例值

◆ getCurrentPageNumber

- (PanoWBPageNumber) getCurrentPageNumber

获取当前白板页码。

返回
  • PanoWBPageNumber(-1):白板未打开
  • Others:白板页码

◆ getCurrentScaleFactor

- (Float32) getCurrentScaleFactor

获取当前白板视图的缩放比例。

返回
缩放比例值。

◆ getCurrentWhiteboardId

- (NSString *_Nullable) getCurrentWhiteboardId

获取当前白板Id

返回
  • 白板Id

◆ getFileInfo:

- (PanoWBDocInfo *_Nullable) getFileInfo: (NSString *_Nonnull)  fileId

获取指定白板文件ID的白板文件信息

参数
fileId白板文件ID
返回
  • 非空:白板文件信息
  • 空:失败

◆ getToolType

- (PanoWBToolType) getToolType

获取工具类型

返回
  • 工具类型

◆ getTotalNumberOfPages

- (UInt32) getTotalNumberOfPages

获取总白板页码数。

返回
页码数

◆ gotoPage:

- (PanoResult) gotoPage: (PanoWBPageNumber pageNo

切换到指定页。

参数
pageNo指定页码。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ importFrom:

- (PanoResult) importFrom: (NSString *_Nonnull)  filename

导入dump文件到白板

参数
filename导入文件
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ initVision:

- (PanoResult) initVision: (PanoWBVisionConfig *)  config

设置白板初始大小

返回
  • kPanoResultOK: 成功
  • Others: 失败

◆ insertPage:autoSwitch:

- (PanoResult) insertPage: (PanoWBPageNumber pageNo
autoSwitch: (BOOL)  autoSwitch 

添加一个新页面到指定页码之后。

参数
pageNo指定页码。
autoSwitch自动切换到新添加的页面。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ leave

- (PanoResult) leave

leave白板

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ nextPage

- (PanoResult) nextPage

切换到下一页。

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ nextStep

- (PanoResult) nextStep

执行H5文件下一步

返回
  • OK: 成功
  • Others: 失败

◆ open:

- (PanoResult) open: (PanoView *_Nonnull)  view

打开白板。

参数
view客户提供的白板显示视图。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ prevPage

- (PanoResult) prevPage

切换到前一页。

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ prevStep

- (PanoResult) prevStep

执行H5文件上一步

返回
  • OK: 成功
  • Others: 失败

◆ redo

- (PanoResult) redo

重做白板的上一次被撤销操作。

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ removePage:

- (PanoResult) removePage: (PanoWBPageNumber pageNo

删除指定页。

参数
pageNo指定页码。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ removePage:switchNext:

- (PanoResult) removePage: (PanoWBPageNumber pageNo
switchNext: (BOOL)  switchNext 

删除页 pageNo

参数
pageNo被删除的页码
switchNext切换到删除页的下一页.
注解
删除页的默认行为是切换到删除页的前一页。设置switchNext为YES改为切换到删除页的下一页。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ resetVision

- (PanoResult) 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输出路径
返回
  • kPanoResultOK: 成功
  • 其他: 失败
  • 注解
    不支持H5文档

◆ sendMessage:toUser:

- (PanoResult) sendMessage: (NSData *_Nonnull)  message
toUser: (UInt64)  userId 

发送消息给某个指定用户。

参数
message要发送的消息。
userId接收消息的用户。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ sendToExternalHtml:message:

- (PanoResult) sendToExternalHtml: (NSString *_Nonnull)  fileId
message: (NSString *_Nonnull)  msg 

发送自定义消息到外部HTML页面

参数
fileId白板文件ID
msg自定义消息
length自定义消息长度
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
只支持外部HTML

◆ setBackgroundColor:

- (PanoResult) setBackgroundColor: (PanoWBColor *_Nonnull)  color

设置白板背景色。

参数
colorPanoWBColor 对象。有效值范围:[0, 1]。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setBackgroundImage:

- (PanoResult) setBackgroundImage: (NSString *_Nonnull)  imageUrl

设置白板当前页背景图片。

参数
imageUrl图片 URL,可为本地路径或者网络链接。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setBackgroundImage:withPageNumber:

- (PanoResult) setBackgroundImage: (NSString *_Nonnull)  imageUrl
withPageNumber: (PanoWBPageNumber pageNo 

设置白板指定页背景图片

参数
imageUrl背景图 URL,可为本地路径或者网络链接。
pageNo白板页码。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setBackgroundImageScalingMode:

- (PanoResult) setBackgroundImageScalingMode: (PanoWBImageScalingMode mode

设置白板背景图缩放模式。

参数
mode背景图缩放模式。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setCurrentScaleFactor:

- (PanoResult) setCurrentScaleFactor: (Float32)  scale

设置当前白板视图的缩放比例

参数
scale缩放比例值。有效值范围 [0.1, 5.0]
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setDelegate:

- (PanoResult) setDelegate: (id< PanoRtcWhiteboardDelegate > _Nullable)  delegate

设置白板回调对象,用以接收白板事件消息。

参数
delegatePanoRtcWhiteboardDelegate 协议对象。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setFillColor:

- (PanoResult) setFillColor: (PanoWBColor *_Nonnull)  color

设置白板填充颜色。

参数
colorPanoWBColor 对象。有效值范围:[0, 1]。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
仅当设置填充类型为kPanoWBFillColor起效。

◆ setFillType:

- (PanoResult) setFillType: (PanoWBFillType type

设置白板填充类型。

参数
typePanoWBFillType 枚举类型。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setFontSize:

- (PanoResult) setFontSize: (UInt32)  size

设置字体大小。

参数
size有效值范围:[10, 96]。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setFontStyle:

- (PanoResult) setFontStyle: (PanoWBFontStyle style

设置白板字体样式。

参数
colorPanoWBFontStyle 枚举类型。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setForegroundColor:

- (PanoResult) setForegroundColor: (PanoWBColor *_Nonnull)  color

设置白板前景色。

参数
colorPanoWBColor 对象。有效值范围:[0, 1]。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setLineWidth:

- (PanoResult) setLineWidth: (UInt32)  width

设置白板线条宽度。

参数
width有效值范围:[1, 20]。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setOption:forType:

- (PanoResult) setOption: (NSObject *_Nullable)  option
forType: (PanoWBOptionType type 

设置白板选项对象。

参数
option选项对象。
typePanoWBOptionType 枚举类型。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setRoleType:

- (PanoResult) setRoleType: (PanoWBRoleType type

设置白板角色类型。

参数
type白板角色,PanoWBRoleType 枚举类型。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ setStamp:

- (PanoResult) setStamp: (NSString *_Nonnull)  stampId

设置图章资源

参数
stampId图章资源ID
返回
  • OK: 成功
  • Others: 失败

◆ setToolType:

- (PanoResult) setToolType: (PanoWBToolType type

设置白板工具。

参数
viewPanoWBToolType 枚举类型。
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ snapshot:path:

- (PanoResult) snapshot: (PanoWBSnapshotMode mode
path: (NSString *_Nonnull)  outputDir 

保存白板内容到图像。

参数
mode快照模式
outputDir输出路径。
返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
快照结果和图像文件名通过回调函数onSnapshotComplete: name:返回

◆ startFollowVision

- (PanoResult) startFollowVision

开始跟随视角

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ startShareVision

- (PanoResult) startShareVision

开始共享视角

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ stop

- (PanoResult) stop

停止白板

返回
  • kPanoResultOK: 成功
  • 其他: 失败
注解
默认白板不能被停止

◆ stopFollowVision

- (PanoResult) stopFollowVision

停止跟随视角

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ stopShareVision

- (PanoResult) stopShareVision

停止共享视角

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ switchDoc:

- (PanoResult) switchDoc: (NSString *_Nonnull)  fileId

切换白板文件

参数
fileId白板文件ID
返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ syncVision

- (PanoResult) syncVision

同步当前页视角

返回
  • kPanoResultOK: 成功
  • 其他: 失败

◆ undo

- (PanoResult) undo

撤销白板上一次操作。

返回
  • kPanoResultOK: 成功
  • 其他: 失败

该类的文档由以下文件生成: