RtcWhiteboatd, 白板的核心接口更多...

#include <PanoWhiteboard.h>

类
class	Callback
	RtcWhiteboard 的回调函数，在使用 RtcWhiteboard 之前必须要设置回调以获取事件通知。更多...

Public 类型
using	EnumFileCallback = bool()(void context, const char *fileId)
	白板文件枚举回调更多...

Public 成员函数
virtual QResult	setCallback (Callback *callback)=0
	设置白板回调函数，用以接收白板事件消息

virtual QResult	setRoleType (WBRoleType type)=0
	设置白板角色类型。更多...

virtual QResult	open (void *window)=0
	开启白板并且设置显示窗口更多...

virtual QResult	close ()=0
	关闭白板更多...

virtual QResult	leave ()=0
	离开白板更多...

virtual QResult	stop ()=0
	停止白板更多...

virtual QResult	importFrom (const char *filename)=0
	导入dump文件到白板更多...

virtual QResult	exportTo (const char *filename)=0
	导出白板到文件更多...

virtual QResult	addToolboxView (void *window)=0
	增加工具栏窗口更多...

virtual QResult	removeToolboxView (void *window)=0
	移除工具栏窗口更多...

virtual const char *	getCurrentWhiteboardId ()=0
	获取当前白板Id 更多...

virtual WBToolType	getToolType ()=0
	获取工具类型更多...

virtual WBPageNumber	getCurrentPageNumber ()=0
	获取当前白板页码更多...

virtual size_t	getTotalNumberOfPages ()=0
	获取总白板页码数更多...

virtual float	getCurrentScaleFactor ()=0
	获取当前白板视图的缩放比例更多...

virtual QResult	setCurrentScaleFactor (float scale)=0
	设置当前白板视图的缩放比例更多...

virtual float	getCurrentMinScaleFactor ()=0
	获取当前白板视图的最小缩放比例更多...

virtual float	getCurrentMaxScaleFactor ()=0
	获取当前白板视图的最大缩放比例更多...

virtual QResult	scrollView (float dx, float dy)=0
	滚动白板视图更多...

virtual QResult	setBackgroundImage (const char *imageUrl)=0
	设置白板当前页背景图片更多...

virtual QResult	setBackgroundImage (const char *imageUrl, WBPageNumber pageNo)=0
	设置白板指定页背景图片更多...

virtual QResult	setBackgroundImageScalingMode (WBImageScalingMode mode)=0
	设置白板背景图缩放模式更多...

virtual QResult	setToolType (WBToolType type)=0
	设置工具类型更多...

virtual QResult	setLineWidth (int size)=0
	设置线宽更多...

virtual QResult	setFillType (WBFillType type)=0
	设置填充类型更多...

virtual QResult	setFillColor (WBColor color)=0
	设置填充颜色更多...

virtual QResult	setForegroundColor (WBColor color)=0
	设置前景颜色更多...

virtual QResult	setBackgroundColor (WBColor color)=0
	设置背景颜色更多...

virtual QResult	setFontStyle (WBFontStyle style)=0
	设置字体样式更多...

virtual QResult	setFontSize (int size)=0
	设置字体大小更多...

virtual QResult	addStamp (WBStamp stamp)=0
	添加图章资源更多...

virtual QResult	setStamp (const char *stampId)=0
	设置图章资源更多...

virtual QResult	undo ()=0
	撤消上一次操作更多...

virtual QResult	redo ()=0
	重做白板的上一次被撤销操作更多...

virtual QResult	addPage (bool autoSwitch)=0
	添加一个新页面到最后更多...

virtual QResult	insertPage (WBPageNumber pageNo, bool autoSwitch)=0
	添加一个新页面到 pageNo 之后更多...

virtual QResult	removePage (WBPageNumber pageNo)=0
	删除页 pageNo 更多...

virtual QResult	removePage (WBPageNumber pageNo, bool switchNext)=0
	删除页 pageNo 更多...

virtual QResult	gotoPage (WBPageNumber pageNo)=0
	切换到页 pageNo 更多...

virtual QResult	nextPage ()=0
	切换到下一页更多...

virtual QResult	prevPage ()=0
	切换到前一页更多...

virtual QResult	nextStep ()=0
	执行H5文件下一步更多...

virtual QResult	prevStep ()=0
	执行H5文件上一步更多...

virtual QResult	addImageFile (const char *imageUrl)=0
	添加图片到当前白板页更多...

virtual QResult	addAudioFile (const char *mediaUrl)=0
	添加音频媒体文件到当前白板页更多...

virtual QResult	addVideoFile (const char *mediaUrl)=0
	添加视频媒体文件到当前白板页更多...

virtual const char *	addBackgroundImages (const char **urls, size_t count)=0
	添加指定数量的背景图到当前白板文件更多...

virtual const char *	addH5File (const char url, const char downloadUrl)=0
	添加H5文件URL到当前白板文件作为背景更多...

virtual const char *	addDoc (WBDocContents contents)=0
	添加新的白板文件更多...

virtual const char *	addDoc (WBDocExtHtml contents)=0
	使用外部Html添加新的白板文件更多...

virtual const char *	addDoc (WBDocExtContents contents)=0
	基于外部内容添加新的白板文件更多...

virtual const char *	createDoc (const char **imageUrls, size_t count)=0
	导入指定数量的背景图并创建新的白板文件更多...

virtual const char *	createDoc (const char *filePath)=0
	上传本地需转码的文件并创建新的白板文件更多...

virtual const char *	createDoc (const char *filePath, WBDocConvertParam param)=0
	上传本地需转码的文件并创建新的白板文件更多...

virtual QResult	deleteDoc (const char *fileId)=0
	删除白板文件更多...

virtual QResult	switchDoc (const char *fileId)=0
	切换白板文件更多...

virtual QResult	saveDocToImages (const char fileId, const char outputDir)=0
	保存白板文件为多张图片。每个白板页存为一张图图像名称格式为whiteboard_[fileId]_[page number].png, 例如：whiteboard_default_1.png 更多...

virtual QResult	preloadDoc (WBDocContents contents)=0
	预缓存文件更多...

virtual QResult	enumerateFiles (EnumFileCallback cb, void *context)=0
	枚举白板文件更多...

virtual const char *	getCurrentFileId ()=0
	获取当前白板文件ID 更多...

virtual WBDocInfo *	getFileInfo (const char *fileId)=0
	获取指定白板文件ID的白板文件信息更多...

virtual QResult	sendMessageToExternalHtml (const char fileId, const char msg, size_t length)=0
	发送自定义消息到外部HTML页面更多...

virtual QResult	clearContents (bool curPage, WBClearType type)=0
	清除白板内容，需要 ADMIN 角色才可调用成功更多...

virtual QResult	clearUserContents (uint64_t userId, bool curPage, WBClearType type)=0
	清除指定用户白板内容更多...

virtual QResult	clearDocContents (const char *fileId, WBClearType type)=0
	清除指定白板文件的内容更多...

virtual QResult	snapshot (WBSnapshotMode mode, const char *outputDir)=0
	保存白板内容到图像。更多...

virtual QResult	refresh ()=0
	刷新白板。此接口主要用于 Windows 下用 QT 开发 UI 的用户。更多...

virtual QResult	initVision (WBVisionConfig config)=0
	设置白板初始大小更多...

virtual QResult	resetVision ()=0
	重置当前页视角更多...

virtual QResult	startShareVision ()=0
	开始共享视角更多...

virtual QResult	stopShareVision ()=0
	结束共享视角更多...

virtual QResult	startFollowVision ()=0
	开始跟随视角更多...

virtual QResult	stopFollowVision ()=0
	结束跟随视角更多...

virtual QResult	syncVision ()=0
	同步当前页视角更多...

virtual QResult	sendMessage (uint64_t userId, const char *msg, size_t size)=0
	发送消息给某个指定用户。更多...

virtual QResult	broadcastMessage (const char *msg, size_t size)=0
	广播消息给所有用户。更多...

virtual QResult	setOption (WBOption option, void *param, size_t size)=0
	设置白板参数更多...

Protected 成员函数
virtual	~RtcWhiteboard ()
	析构函数

详细描述

RtcWhiteboatd, 白板的核心接口

注解: 显示H5内容需要额外的sdk文件，请联系Pano技术支持获取。

成员类型定义说明

◆ EnumFileCallback

using RtcWhiteboard::EnumFileCallback = bool(*) (void *context, const char *fileId)

白板文件枚举回调

参数

context	用户自定义上下文
fileId	白板文件ID

返回: 成功返回true, 失败返回false

成员函数说明

◆ addAudioFile()

virtual QResult RtcWhiteboard::addAudioFile ( const char * mediaUrl )

pure virtual

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

参数

mediaUrl 媒体 URL，可为本地路径或远程 URL

返回

OK: 成功
Others: 失败

◆ addBackgroundImages()

virtual const char * RtcWhiteboard::addBackgroundImages	(	const char **	urls,
		size_t	count
	)

pure virtual

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

参数

urls	背景图url数组（仅支持远程URL）
count	添加的背景图数量

返回

当前白板文件ID，如果失败返回nullptr

注解: PanoWhiteboard创建时会生成白板文件ID为"default"的白板文件

◆ addDoc() [1/3]

virtual const char * RtcWhiteboard::addDoc ( WBDocContents contents )

pure virtual

添加新的白板文件

参数

contents 根据转码结果指定的白板文件内容

返回

当前白板文件ID，如果失败返回nullptr

注解: PanoWhiteboard创建时会生成白板文件ID为"default"的白板文件

◆ addDoc() [2/3]

virtual const char * RtcWhiteboard::addDoc ( WBDocExtContents contents )

pure virtual

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

参数

contents 外部白板文件内容

返回

当前白板文件ID，如果失败返回nullptr

注解: PanoWhiteboard创建时会生成白板文件ID为"default"的白板文件

◆ addDoc() [3/3]

virtual const char * RtcWhiteboard::addDoc ( WBDocExtHtml contents )

pure virtual

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

参数

contents 外部Html的白板文件内容

返回

当前白板文件ID，如果失败返回nullptr

注解: PanoWhiteboard创建时会生成白板文件ID为"default"的白板文件

◆ addH5File()

virtual const char * RtcWhiteboard::addH5File	(	const char *	url,
		const char *	downloadUrl
	)

pure virtual

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

参数

url	网络URL（仅支持远程URL）
downloadUrl	H5文件的下载URL, 所有文件需要打包为zip文件

返回

当前白板文件ID，如果失败返回nullptr

注解: PanoWhiteboard创建时会生成白板文件ID为"default"的白板文件

◆ addImageFile()

virtual QResult RtcWhiteboard::addImageFile ( const char * imageUrl )

pure virtual

添加图片到当前白板页

参数

imageUrl 图像 URL，可为本地路径或远程 URL

返回

OK：成功
Others: 失败

◆ addPage()

virtual QResult RtcWhiteboard::addPage ( bool autoSwitch )

pure virtual

添加一个新页面到最后

参数

autoSwitch 自动切换到新添加的页面

返回

OK：成功
Others: 失败

◆ addStamp()

virtual QResult RtcWhiteboard::addStamp ( WBStamp stamp )

pure virtual

添加图章资源

参数

stamp 图章结构类型

返回

OK：成功
Others: 失败

◆ addToolboxView()

virtual QResult RtcWhiteboard::addToolboxView ( void * window )

pure virtual

增加工具栏窗口

参数

window 平台相关的窗口对象，在windows平台，该参数必须是HWND对象。

返回

OK：成功
Others: 失败

◆ addVideoFile()

virtual QResult RtcWhiteboard::addVideoFile ( const char * mediaUrl )

pure virtual

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

参数

mediaUrl 媒体 URL，可为本地路径或远程 URL

返回

OK: 成功
Others: 失败

◆ broadcastMessage()

virtual QResult RtcWhiteboard::broadcastMessage	(	const char *	msg,
		size_t	size
	)

pure virtual

广播消息给所有用户。

参数

msg	要广播的消息
size	消息大小，最大不能超过 16KB

◆ clearContents()

virtual QResult RtcWhiteboard::clearContents	(	bool	curPage,
		WBClearType	type
	)

pure virtual

清除白板内容，需要 ADMIN 角色才可调用成功

参数

curPage	true: 只清除当前页内容；false: 清除所有页内容
type	WBClearType 枚举类型

返回

OK：成功
NO_PRIVILEGE: 没有权限
Others: 失败

注解: 此接口只有 ADMIN 角色才可调用

◆ clearDocContents()

virtual QResult RtcWhiteboard::clearDocContents	(	const char *	fileId,
		WBClearType	type
	)

pure virtual

清除指定白板文件的内容

参数

fileId	白板文件ID
type	WBClearType 枚举类型

返回

OK：成功
NO_PRIVILEGE: 没有权限
Others: 失败

注解: 只有 ADMIN 角色才可以调用

◆ clearUserContents()

virtual QResult RtcWhiteboard::clearUserContents	(	uint64_t	userId,
		bool	curPage,
		WBClearType	type
	)

pure virtual

清除指定用户白板内容

参数

userId	用户ID
curPage	true: 只清除当前页内容；false: 清除所有页内容
type	WBClearType 枚举类型

返回

OK：成功
NO_PRIVILEGE: 没有权限
Others: 失败

注解: 只有 ADMIN 角色才可以清除非本地用户的内容

◆ close()

virtual QResult RtcWhiteboard::close ( )

pure virtual

关闭白板

返回

OK：成功
Others: 失败

◆ createDoc() [1/3]

virtual const char * RtcWhiteboard::createDoc	(	const char **	imageUrls,
		size_t	count
	)

pure virtual

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

参数

imageUrls	背景图url数组（仅支持远程URL）
count	导入的背景图数量

返回

新创建的白板文件ID，如果失败返回nullptr

注解: PanoWhiteboard 创建时会生成白板文件ID为"default"的白板文件

◆ createDoc() [2/3]

virtual const char * RtcWhiteboard::createDoc ( const char * filePath )

pure virtual

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

参数

filePath 本地文件路径

返回

新创建的白板文件ID，如果失败返回nullptr

注解: PanoWhiteboard 创建时会生成白板文件ID为"default"的白板文件最大文件大小取决于文档转码RESTful API

◆ createDoc() [3/3]

virtual const char * RtcWhiteboard::createDoc	(	const char *	filePath,
		WBDocConvertParam	param
	)

pure virtual

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

参数

filePath	本地文件路径
param	转码参数

返回

新创建的白板文件ID，如果失败返回nullptr

注解: PanoWhiteboard 创建时会生成白板文件ID为"default"的白板文件转码类型为H5时，仅支持后缀为.ppt, .pptx的文件最大文件大小取决于文档转码RESTful API

◆ deleteDoc()

virtual QResult RtcWhiteboard::deleteDoc ( const char * fileId )

pure virtual

删除白板文件

参数

fileId 白板文件ID

返回

OK：成功
Others: 失败

注解: "default" 白板文件不能被删除

◆ enumerateFiles()

virtual QResult RtcWhiteboard::enumerateFiles	(	EnumFileCallback	cb,
		void *	context
	)

pure virtual

枚举白板文件

参数

cb	回调函数
context	用户自定义上下文，在回调函数中返回给用户

◆ exportTo()

virtual QResult RtcWhiteboard::exportTo ( const char * filename )

pure virtual

导出白板到文件

参数

filename 导出文件

返回

OK：成功
Others: 失败

◆ getCurrentFileId()

virtual const char * RtcWhiteboard::getCurrentFileId ( )

pure virtual

获取当前白板文件ID

返回

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

◆ getCurrentMaxScaleFactor()

virtual float RtcWhiteboard::getCurrentMaxScaleFactor ( )

pure virtual

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

返回: 缩放比例值

◆ getCurrentMinScaleFactor()

virtual float RtcWhiteboard::getCurrentMinScaleFactor ( )

pure virtual

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

返回: 缩放比例值

◆ getCurrentPageNumber()

virtual WBPageNumber RtcWhiteboard::getCurrentPageNumber ( )

pure virtual

获取当前白板页码

返回

kInvalidPageNumber：白板未打开
Others: 白板页码

◆ getCurrentScaleFactor()

virtual float RtcWhiteboard::getCurrentScaleFactor ( )

pure virtual

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

返回: 缩放比例值

◆ getCurrentWhiteboardId()

virtual const char * RtcWhiteboard::getCurrentWhiteboardId ( )

pure virtual

获取当前白板Id

返回

白板Id

◆ getFileInfo()

virtual WBDocInfo * RtcWhiteboard::getFileInfo ( const char * fileId )

pure virtual

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

参数

fileId 白板文件ID

返回

非空指针：白板文件信息指针
空指针：失败

◆ getToolType()

virtual WBToolType RtcWhiteboard::getToolType ( )

pure virtual

获取工具类型

返回

工具类型

◆ getTotalNumberOfPages()

virtual size_t RtcWhiteboard::getTotalNumberOfPages ( )

pure virtual

获取总白板页码数

返回: 页码数

◆ gotoPage()

virtual QResult RtcWhiteboard::gotoPage ( WBPageNumber pageNo )

pure virtual

切换到页 pageNo

参数

pageNo 页码

返回

OK：成功
Others: 失败

◆ importFrom()

virtual QResult RtcWhiteboard::importFrom ( const char * filename )

pure virtual

导入dump文件到白板

参数

filename 导入文件

返回

OK：成功
Others: 失败

◆ initVision()

virtual QResult RtcWhiteboard::initVision ( WBVisionConfig config )

pure virtual

设置白板初始大小

返回

OK：成功
Others: 失败

◆ insertPage()

virtual QResult RtcWhiteboard::insertPage	(	WBPageNumber	pageNo,
		bool	autoSwitch
	)

pure virtual

添加一个新页面到 pageNo 之后

参数

pageNo	页码
autoSwitch	自动切换到新添加的页面

返回

OK：成功
Others: 失败

◆ leave()

virtual QResult RtcWhiteboard::leave ( )

pure virtual

离开白板

返回

OK：成功
Others: 失败

◆ nextPage()

virtual QResult RtcWhiteboard::nextPage ( )

pure virtual

切换到下一页

返回

OK：成功
Others: 失败

◆ nextStep()

virtual QResult RtcWhiteboard::nextStep ( )

pure virtual

执行H5文件下一步

返回

OK：成功
Others: 失败

◆ open()

virtual QResult RtcWhiteboard::open ( void * window )

pure virtual

开启白板并且设置显示窗口

参数

window 平台相关的窗口对象，在windows平台，该参数必须是HWND对象。

返回

OK：成功
Others: 失败

注解: 开启白板前需要保证白板服务是正常的。

◆ preloadDoc()

virtual QResult RtcWhiteboard::preloadDoc ( WBDocContents contents )

pure virtual

预缓存文件

参数

contents 根据转码结果指定的白板文件内容

返回

OK：成功
Others: 失败

◆ prevPage()

virtual QResult RtcWhiteboard::prevPage ( )

pure virtual

切换到前一页

返回

OK：成功
Others: 失败

◆ prevStep()

virtual QResult RtcWhiteboard::prevStep ( )

pure virtual

执行H5文件上一步

返回

OK：成功
Others: 失败

◆ redo()

virtual QResult RtcWhiteboard::redo ( )

pure virtual

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

返回

OK：成功
Others: 失败

◆ refresh()

virtual QResult RtcWhiteboard::refresh ( )

pure virtual

刷新白板。此接口主要用于 Windows 下用 QT 开发 UI 的用户。

返回

OK：成功
Others: 失败

注解: 用 QT 开发 UI 的用户，需在 paintEvent 里调用此接口来刷新白板内容，例如： void WhiteboardWindow::paintEvent(QPaintEvent *event) { QMainWindow::paintEvent(event); whiteboard->refresh(); }

◆ removePage() [1/2]

virtual QResult RtcWhiteboard::removePage ( WBPageNumber pageNo )

pure virtual

删除页 pageNo

参数

pageNo 被删除的页码

返回

OK：成功
Others: 失败

◆ removePage() [2/2]

virtual QResult RtcWhiteboard::removePage	(	WBPageNumber	pageNo,
		bool	switchNext
	)

pure virtual

删除页 pageNo

参数

pageNo	被删除的页码
switchNext	切换到删除页的下一页.

注解: 删除页的默认行为是切换到删除页的前一页。设置switchNext为true改为切换到删除页的下一页。

返回

OK：成功
Others: 失败

◆ removeToolboxView()

virtual QResult RtcWhiteboard::removeToolboxView ( void * window )

pure virtual

移除工具栏窗口

参数

window 平台相关的窗口对象，在windows平台，该参数必须是HWND对象。

返回

OK：成功
Others: 失败

◆ resetVision()

virtual QResult RtcWhiteboard::resetVision ( )

pure virtual

重置当前页视角

返回

OK: 成功
Others: 失败

◆ saveDocToImages()

virtual QResult RtcWhiteboard::saveDocToImages	(	const char *	fileId,
		const char *	outputDir
	)

pure virtual

保存白板文件为多张图片。每个白板页存为一张图图像名称格式为whiteboard_[fileId]_[page number].png, 例如：whiteboard_default_1.png

参数

fileId	白板文件ID
outputDir	输出路径

返回

OK：成功
Others: 失败

注解: 不支持H5文档

◆ scrollView()

virtual QResult RtcWhiteboard::scrollView	(	float	dx,
		float	dy
	)

pure virtual

滚动白板视图

参数

dx	水平方向滚动距离
dy	垂直方向滚动距离

返回

OK：成功
Others: 失败

◆ sendMessage()

virtual QResult RtcWhiteboard::sendMessage	(	uint64_t	userId,
		const char *	msg,
		size_t	size
	)

pure virtual

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

参数

userId	消息接收者用户 ID。
msg	要发送的消息
size	消息大小，最大不能超过 16KB

◆ sendMessageToExternalHtml()

virtual QResult RtcWhiteboard::sendMessageToExternalHtml	(	const char *	fileId,
		const char *	msg,
		size_t	length
	)

pure virtual

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

参数

fileId	白板文件ID
msg	自定义消息
length	自定义消息长度

返回

OK: 成功
Others: 失败

注解: 只支持外部HTML

◆ setBackgroundColor()

virtual QResult RtcWhiteboard::setBackgroundColor ( WBColor color )

pure virtual

设置背景颜色

参数

color 颜色。有效值范围：[0, 1]。

返回

OK：成功
Others: 失败

◆ setBackgroundImage() [1/2]

virtual QResult RtcWhiteboard::setBackgroundImage ( const char * imageUrl )

pure virtual

设置白板当前页背景图片

参数

imageUrl 背景图 URL，可为本地路径或远程 URL

返回

OK：成功
Others: 失败

◆ setBackgroundImage() [2/2]

virtual QResult RtcWhiteboard::setBackgroundImage	(	const char *	imageUrl,
		WBPageNumber	pageNo
	)

pure virtual

设置白板指定页背景图片

参数

imageUrl	背景图 URL，可为本地路径或远程 URL
pageNo	白板页码

返回

OK：成功
Others: 失败

◆ setBackgroundImageScalingMode()

virtual QResult RtcWhiteboard::setBackgroundImageScalingMode ( WBImageScalingMode mode )

pure virtual

设置白板背景图缩放模式

参数

mode 背景图缩放模式

返回

OK：成功
Others: 失败

◆ setCurrentScaleFactor()

virtual QResult RtcWhiteboard::setCurrentScaleFactor ( float scale )

pure virtual

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

参数

scale 缩放比例值。有效值范围 [0.1, 5.0]

返回

OK：成功
Others: 失败

◆ setFillColor()

virtual QResult RtcWhiteboard::setFillColor ( WBColor color )

pure virtual

设置填充颜色

参数

color 颜色。有效值范围：[0, 1]。

返回

OK：成功
Others: 失败

注解: 填充类型为WbFileType::COLOR时，此设置方能起效。

◆ setFillType()

virtual QResult RtcWhiteboard::setFillType ( WBFillType type )

pure virtual

设置填充类型

参数

type 填充类型

返回

OK：成功
Others: 失败

◆ setFontSize()

virtual QResult RtcWhiteboard::setFontSize ( int size )

pure virtual

设置字体大小

参数

size 字体大小

返回

OK：成功
Others: 失败

◆ setFontStyle()

virtual QResult RtcWhiteboard::setFontStyle ( WBFontStyle style )

pure virtual

设置字体样式

参数

style 字体样式

返回

OK：成功
Others: 失败

◆ setForegroundColor()

virtual QResult RtcWhiteboard::setForegroundColor ( WBColor color )

pure virtual

设置前景颜色

参数

color 颜色。有效值范围：[0, 1]。

返回

OK：成功
Others: 失败

◆ setLineWidth()

virtual QResult RtcWhiteboard::setLineWidth ( int size )

pure virtual

设置线宽

参数

size	线宽。有效值范围 [1, 20]

返回

OK：成功
Others: 失败

◆ setOption()

virtual QResult RtcWhiteboard::setOption	(	WBOption	option,
		void *	param,
		size_t	size
	)

pure virtual

设置白板参数

参数

option	参数类别
param	参数, 参数的定义需遵循不同的option所定义的参数结构
size	参数的大小

返回

OK: 成功
其他: 失败

◆ setRoleType()

virtual QResult RtcWhiteboard::setRoleType ( WBRoleType type )

pure virtual

设置白板角色类型。

参数

type 白板角色。

◆ setStamp()

virtual QResult RtcWhiteboard::setStamp ( const char * stampId )

pure virtual

设置图章资源

参数

stampId 图章资源ID

返回

OK：成功
Others: 失败

◆ setToolType()

virtual QResult RtcWhiteboard::setToolType ( WBToolType type )

pure virtual

设置工具类型

参数

type 工具类型

返回

OK：成功
Others: 失败

◆ snapshot()

virtual QResult RtcWhiteboard::snapshot	(	WBSnapshotMode	mode,
		const char *	outputDir
	)

pure virtual

保存白板内容到图像。

参数

mode	快照模式
outputDir	输出路径

返回

OK：成功
Others: 失败

注解: 快照结果和图像文件名通过回调函数onSnapshotComplete返回

◆ startFollowVision()

virtual QResult RtcWhiteboard::startFollowVision ( )

pure virtual

开始跟随视角

返回

OK：成功
Others: 失败

◆ startShareVision()

virtual QResult RtcWhiteboard::startShareVision ( )

pure virtual

开始共享视角

返回

OK：成功
Others: 失败

◆ stop()

virtual QResult RtcWhiteboard::stop ( )

pure virtual

停止白板

返回

OK：成功
Others: 失败

注解: 默认白板不能被停止

◆ stopFollowVision()

virtual QResult RtcWhiteboard::stopFollowVision ( )

pure virtual

结束跟随视角

返回

OK：成功
Others: 失败

◆ stopShareVision()

virtual QResult RtcWhiteboard::stopShareVision ( )

pure virtual

结束共享视角

返回

OK：成功
Others: 失败

◆ switchDoc()

virtual QResult RtcWhiteboard::switchDoc ( const char * fileId )

pure virtual

切换白板文件

参数

fileId 白板文件ID

返回

OK：成功
Others: 失败

◆ syncVision()

virtual QResult RtcWhiteboard::syncVision ( )

pure virtual

同步当前页视角

返回

OK: 成功
Others: 失败

◆ undo()

virtual QResult RtcWhiteboard::undo ( )

pure virtual

撤消上一次操作

返回

OK：成功
Others: 失败

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

PanoWhiteboard.h

类

Public 类型

Public 成员函数

Protected 成员函数

详细描述

成员类型定义说明

◆ EnumFileCallback

成员函数说明

◆ addAudioFile()

◆ addBackgroundImages()

◆ addDoc() [1/3]

◆ addDoc() [2/3]

◆ addDoc() [3/3]

◆ addH5File()

◆ addImageFile()

◆ addPage()

◆ addStamp()

◆ addToolboxView()

◆ addVideoFile()

◆ broadcastMessage()

◆ clearContents()

◆ clearDocContents()

◆ clearUserContents()

◆ close()

◆ createDoc() [1/3]

◆ createDoc() [2/3]

◆ createDoc() [3/3]

◆ deleteDoc()

◆ enumerateFiles()

◆ exportTo()

◆ getCurrentFileId()

◆ getCurrentMaxScaleFactor()

◆ getCurrentMinScaleFactor()

◆ getCurrentPageNumber()

◆ getCurrentScaleFactor()

◆ getCurrentWhiteboardId()

◆ getFileInfo()

◆ getToolType()

◆ getTotalNumberOfPages()

◆ gotoPage()

◆ importFrom()

◆ initVision()

◆ insertPage()

◆ leave()

◆ nextPage()

◆ nextStep()

◆ open()

◆ preloadDoc()

◆ prevPage()

◆ prevStep()

◆ redo()

◆ refresh()

◆ removePage() [1/2]

◆ removePage() [2/2]

◆ removeToolboxView()

◆ resetVision()

◆ saveDocToImages()

◆ scrollView()

◆ sendMessage()

◆ sendMessageToExternalHtml()

◆ setBackgroundColor()

◆ setBackgroundImage() [1/2]

◆ setBackgroundImage() [2/2]

◆ setBackgroundImageScalingMode()

◆ setCurrentScaleFactor()

◆ setFillColor()

◆ setFillType()

◆ setFontSize()

◆ setFontStyle()

◆ setForegroundColor()

◆ setLineWidth()

◆ setOption()

◆ setRoleType()

◆ setStamp()

◆ setToolType()

◆ snapshot()

◆ startFollowVision()

◆ startShareVision()

◆ stop()

◆ stopFollowVision()